Difference between revisions of "Repository.XFRACAS.ImportXFRACASXMLString"

From ReliaWiki
Jump to navigation Jump to search
Line 8: Line 8:
 
:''entityID'': The ID of the entity to import into.
 
:''entityID'': The ID of the entity to import into.
  
:''ImportType'': The type of XFRACAS Import to utilize.
+
:''ImportType'': The type of XFRACAS Import to utilize, specified as [[XFRACASImportType]].
  
 
:''xmlString'': The string consisting of the XML to import.
 
:''xmlString'': The string consisting of the XML to import.

Revision as of 20:47, 27 February 2014


Uploads an import file bytestream for processing and returns the system ID

Syntax

  • ImportXFRACASXMLString( entityID As Integer, ImportType As XFRACASImportType , xmlString As String, fileTitle As String, fileDescription As String)As Integer

Parameters

entityID: The ID of the entity to import into.
ImportType: The type of XFRACAS Import to utilize, specified as XFRACASImportType.
xmlString: The string consisting of the XML to import.
fileTitle: The file title of the XML file byte array to import.
fileDescription: A description of the XML to import.

Usage Example

Code Block

       ' Declare a new repository connection class. 
       Private WithEvents MyRepository As New Repository
' Connect to the desired Synthesis repository. DimSuccessAs Boolean=False Success = MyRepository.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")
' Set the Desired Entity ID to import into. Dim DesiredEntityID As Integer DesiredEntityID = ' Set the entity ID
' Define an XML string DimxmlStringAs String=Nothing ' populate the xmlString with the XML text
' Import the XML byte array into the entity desired. In this example, we assume the XML string type describes an Incident. DimImportXMLSystemIDAs Integer ImportXMLSystemID = MyRepository.ImportXFRACASXMLString(DesiredEntityID, XFRACASImportType.Incident, xmlString, "XMLFileTitle", "XMLFileDescription")


Reformatted Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the desired Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")

Set the Desired Entity ID to import into.

       Dim DesiredEntityID As Integer
       DesiredEntityID = ' Set the entity ID 

Define an XML string.

       Dim xmlString As String = Nothing
       'populate the xmlString with the XML text

Import the XML byte array into the entity desired. In this example, we assume the XML string type describes an Incident.

       Dim ImportXMLSystemID As Integer
       ImportXMLSystemID = MyRepository.ImportXFRACASXMLString(DesiredEntityID, XFRACASImportType.Incident, xmlString, "XMLFileTitle", "XMLFileDescription")