Repository.XFRACAS.ImportXFRACASXMLString: Difference between revisions
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
Line 3: | Line 3: | ||
<onlyinclude>Uploads an XML string to XFRACAS | <onlyinclude>Uploads an XML string to XFRACAS's import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude> | ||
{{Template:API_XFRACASNote}} | |||
== Syntax == | == Syntax == | ||
Line 35: | Line 33: | ||
== Example == | == Example == | ||
This example assumes that the repository has connections to existing XFRACAS entities. | This example assumes that the enterprise repository has connections to existing XFRACAS entities. | ||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|'Add code to connect to | {{APIComment|'Add code to connect to an enterprise Synthesis repository.}} | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
{{APIComment|...}} | {{APIComment|...}} | ||
Line 51: | Line 49: | ||
{{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}} | {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}} | ||
ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlString(1, XFRACASImportType.Incident, xmlString, {{APIString|"XMLFileTitle"}}, {{APIString|"XMLFileDescription"}}) | ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlString(1, XFRACASImportType.Incident, xmlString, {{APIString|"XMLFileTitle"}}, {{APIString|"XMLFileDescription"}}) | ||
Revision as of 18:41, 9 November 2015
Member of: SynthesisAPI9.Repository
Uploads an XML string to XFRACAS's import queue. Returns an Integer that represents the import file's record ID.
Remarks: The XML file will be processed at the next scheduled import, or you can choose to process immediately all items in the import queue by using the ProcessXfracasImports method.
For the XML file to be imported successfully, you must have the "Manage Import" admin permission in the XFRACAS entity where you are uploading the file, and the XML file must be in the correct XFRACAS XML format. The XFRACAS 11 Import Business Logic (PDF) document provides a complete description of the XFRACAS format.
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 enterprise repository has connections to existing XFRACAS entities.
VB.NET 'Add code to connect to an enterprise 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")