Repository.XFRACAS.ImportXFRACASXMLString: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
Line 2: | Line 2: | ||
<onlyinclude>Uploads an | |||
<onlyinclude>Uploads an XML string to XFRACAS for processing. Returns an '''Integer''' that represents the import file's system ID. </onlyinclude> | |||
You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must use the XFRACAS format in order to be successfully imported. The [http://www.synthesisplatform.net/XFRACAS/en/XML_XFRACAS9_and_10.pdf XFRACAS9/10 Import Business Logic] (PDF) document provides a complete description of the format. | |||
Once the XML file has been uploaded for processing, use the [[Repository.XFRACAS.ProcessXfracasImports|ProcessXfracasImports]] method to process the XML file. | |||
== Syntax == | == Syntax == | ||
Line 30: | Line 35: | ||
== Example == | == Example == | ||
This example assumes that the repository | This example assumes that the repository has connections to existing XFRACAS entities. | ||
'''VB.NET''' | '''VB.NET''' | ||
Line 39: | Line 44: | ||
{{APIComment|'Define an XML string and populate it with the XML text.}} | {{APIComment|'Define an XML string and populate it with the XML text.}} | ||
{{APIPrefix|Dim}} xmlString {{APIPrefix|As String}} = {{APIPrefix|Nothing}} | |||
{{APIComment|...}} | {{APIComment|...}} | ||
{{APIComment|'Import the XML | {{APIComment|'Import the XML string into XFRACAS entity ID# 1.}} | ||
{{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}} | |||
ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLString(1, XFRACASImportType.Incident, xmlString, {{APIString|"XMLFileTitle"}}, {{APIString|"XMLFileDescription"}}) | |||
{{APIComment|'Process the imported file.}} | |||
MyRepository.XFRACAS.ProcessXfracasImports() |
Revision as of 23:36, 26 October 2015
Member of: SynthesisAPI10.Repository
Uploads an XML string to XFRACAS for processing. Returns an Integer that represents the import file's system ID.
You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must use the XFRACAS format in order to be successfully imported. The XFRACAS9/10 Import Business Logic (PDF) document provides a complete description of the format.
Once the XML file has been uploaded for processing, use the ProcessXfracasImports method to process the XML file.
Syntax
.XFRACAS.ImportXFRACASXMLString(entityID, importType, xmlString, fileTitle, fileDescription)
Parameters
entityID
- Required. Integer. The ID number of the XFRACAS entity to import the data into.
importType
- Required. The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any XFRACASImportType constant.
xmlString
- Required. String. The string consisting of the XML to import.
fileTitle
- Required. String. The file title of the XML file byte array to import.
fileDescription
- Required. String. A description of the XML data to import.
Example
This example assumes that the repository has connections to existing XFRACAS 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 string into XFRACAS entity ID# 1. Dim ImportXMLSystemID As Integer ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLString(1, XFRACASImportType.Incident, xmlString, "XMLFileTitle", "XMLFileDescription") 'Process the imported file. MyRepository.XFRACAS.ProcessXfracasImports()