Repository.XFRACAS.ImportXFRACASXMLFile

From ReliaWiki
Revision as of 23:37, 26 October 2015 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
APIWiki.png


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 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.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.

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()