Repository.XFRACAS.ImportXFRACASXMLString: Difference between revisions

Revision as of 23:53, 19 August 2015

Member of: SynthesisAPI10.Repository

Uploads an import file byte stream for processing. Returns an Integer that represents the system ID.

Syntax

.XFRACAS.ImportXFRACASXMLString(entityID, importType, xmlString, fileTitle, fileDescription)

Parameters

entityID

Integer. The ID number of the XFRACAS entity to import the data into. (Required)

importType

The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any XFRACASImportType constant. (Required)

xmlString

String. The string consisting of the XML to import.

fileTitle

String. The file title of the XML file byte array to import.

fileDescription

String. A description of the XML data to import. (Required)

Example

This example assumes that the repository is connected to an XFRACAS with existing entities.

VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 'Define an XML string and populate it with the XML text. 
 Dim xmlString As String = Nothing
  ... 


 'Import the XML byte array into the first available XFRACAS entity. 
 'The following code assumes that the XML string type describes XFRACAS incidents. 
 DimImportXMLSystemIDAs Integer
 ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLString(1, XFRACASImportType.Incident, xmlString, "XMLFileTitle", "XMLFileDescription")

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
-Uploads an import file bytestream for processing and returns the system ID
+<onlyinclude>Uploads an import file byte stream for processing. Returns an '''Integer''' that represents the system ID.</onlyinclude>
 == Syntax ==
-*ImportXFRACASXMLString( entityID {{APIPrefix|As Integer}}, ImportType {{APIPrefix|As}} [[XFRACASImportType]] , xmlString {{APIPrefix|As String}}, fileTitle {{APIPrefix|As String}}, fileDescription {{APIPrefix|As String}}){{APIPrefix|As Integer}}
+ '''.XFRACAS.ImportXFRACASXMLString'''(''entityID'', ''importType'', ''xmlString'', ''fileTitle'', ''fileDescription'')
+===Parameters===
+''entityID''
+:Integer. The ID number of the XFRACAS entity to import the data into. (Required)
+''importType''
+:The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant. (Required)
+''xmlString''
+:String. The string consisting of the XML to import.
-Parameters
+''fileTitle''
-:''entityID'': The ID of the entity to import into.
-:''ImportType'': The type of XFRACAS Import to utilize, specified as [[XFRACASImportType]].
+:String. The file title of the XML file byte array to import.
-:''xmlString'': The string consisting of the XML to import.
+''fileDescription''
-:''fileTitle'': The file title of the XML file byte array to import.
+: String. A description of the XML data to import. (Required)
-:''fileDescription'': A description of the XML to import.
-== Usage Example ==
+== Example ==
+This example assumes that the repository is connected to an XFRACAS with existing entities.
-        '{{APIComment|Declare a new repository connection class.}}
+ '''VB.NET'''
-        {{APIPrefix|Private WithEvents MyRepository As New [[Repository Class|Repository]]}}<br>
-        '{{APIComment|Connect to the desired Synthesis repository.}}
+ {{APIComment|'Add code to connect to a Synthesis repository.}}
-        {{APIPrefix|Dim}}Success{{APIPrefix|As Boolean}}={{APIPrefix|False}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
-        Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")<br>
+  {{APIComment|...}}
-        '{{APIComment|Set the Desired Entity ID to import into.}}
-        {{APIPrefix|Dim}} DesiredEntityID {{APIPrefix|As Integer}}
+ {{APIComment|'Define an XML string and populate it with the XML text.}}
-        DesiredEntityID = '{{APIComment|Set the entity ID}}<br>
+  {{APIPrefix|Dim}} xmlString {{APIPrefix|As String}} = {{APIPrefix|Nothing}}
-        '{{APIComment|Define an XML string}}
+  {{APIComment|...}}
-        {{APIPrefix|Dim}}xmlString{{APIPrefix|As String}}={{APIPrefix|Nothing}}
-        '{{APIComment|populate the xmlString with the XML text}}<br>
-        '{{APIComment|Import the XML byte array into the entity desired.  In this example, we assume the XML string type describes an Incident.}}
+ {{APIComment|'Import the XML byte array into the first available XFRACAS entity.}}
-        {{APIPrefix|Dim}}ImportXMLSystemID{{APIPrefix|As Integer}}
+  {{APIComment|'The following code assumes that the XML string type describes XFRACAS incidents.}}
-        ImportXMLSystemID = MyRepository.XFRACAS.[[Repository.ImportXFRACASXMLString|ImportXFRACASXMLString]](DesiredEntityID, [[XFRACASImportType]].Incident, xmlString, "XMLFileTitle", "XMLFileDescription")
+  {{APIPrefix|Dim}}ImportXMLSystemID{{APIPrefix|As Integer}}
+  ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLString(1, XFRACASImportType.Incident, xmlString, {{APIString|"XMLFileTitle"}}, {{APIString|"XMLFileDescription"}})

Repository.XFRACAS.ImportXFRACASXMLString: Difference between revisions

Revision as of 23:53, 19 August 2015

Syntax

Parameters

Example

Navigation menu

Search