Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 5: | Line 5: | ||
You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must be in XFRACAS XML 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 XFRACAS XML format. | You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must be in XFRACAS XML 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 XFRACAS XML 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 28: | Line 30: | ||
== Example == | == Example == | ||
This example assumes that the repository has | This example assumes that the repository has connections to existing XFRACAS entities. An XML file called "XMLDATA.xml" is assumed to exist in the C: drive. | ||
'''VBA''' | |||
{{APIComment|'Add code to connect to the Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Import the XML file into XFRACAS entity ID# 10.}} | |||
{{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}} | |||
ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLFile(10, XFRACASImportType.Incident, {{APIString|"C:\XMLData.xml"}}, {{APIString|"XMLFileDescription"}}) | |||
{{APIComment|'Process the imported file.}} | |||
{{APIPrefix|Call}} MyRepository.XFRACAS.ProcessXfracasImports() | |||
'''VB.NET''' | '''VB.NET''' | ||
| Line 37: | Line 52: | ||
{{APIComment|'Import the XML file into XFRACAS entity ID# 10.}} | {{APIComment|'Import the XML file into XFRACAS entity ID# 10.}} | ||
{{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}} | |||
ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLFile(10, XFRACASImportType.Incident, {{APIString|"C:\XMLData.xml"}}, {{APIString|"XMLFileDescription"}}) | |||
{{APIComment|'Process the imported file.}} | |||
MyRepository.XFRACAS.ProcessXfracasImports() | |||
Revision as of 22:10, 26 October 2015
 |
Member of: SynthesisAPI10.Repository
Uploads an XML file 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 be in XFRACAS XML format in order to be successfully imported. The XFRACAS9/10 Import Business Logic (PDF) document provides a complete description of the XFRACAS XML format.
Once the XML file has been uploaded for processing, use the ProcessXfracasImports method to process the XML file.
Syntax
.XFRACAS.ImportXFRACASXMLFile(entityID, importType, fileName, fileDescription)
Parameters
entityID
- Required. Integer. The ID number of the XFRACAS entity to import the data into.
importType
- Required. The XFRACAS element (e.g., incident, problem, etc.) to import. Can be any XFRACASImportType constant.
fileName
- Required. String. The file path of the XML file 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. An XML file called "XMLDATA.xml" is assumed to exist in the C: drive.
VBA 'Add code to connect to the Synthesis repository. Dim MyRepository As New Repository ... 'Import the XML file into XFRACAS entity ID# 10. Dim ImportXMLSystemID As Integer ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLFile(10, XFRACASImportType.Incident, "C:\XMLData.xml", "XMLFileDescription") 'Process the imported file. Call MyRepository.XFRACAS.ProcessXfracasImports()
VB.NET 'Add code to connect to the Synthesis repository. Dim MyRepository As New Repository ... 'Import the XML file into XFRACAS entity ID# 10. Dim ImportXMLSystemID As Integer ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLFile(10, XFRACASImportType.Incident, "C:\XMLData.xml", "XMLFileDescription") 'Process the imported file. MyRepository.XFRACAS.ProcessXfracasImports()