Repository.XFRACAS.ImportXFRACASXMLFile

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


Member of: SynthesisAPI10.Repository


Uploads an XFRACAS XML import file for processing. Returns an Integer that represents the import file's system ID.

All XML files must first be in the XFRACAS XML format before they can be successfully imported. To view the XFRACAS formats, see the XFRACAS9/10 Import Business Logic (PDF) document.

Syntax

.XFRACAS.ImportXFRACASXMLFile(entityID, importType, fileName, 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)

fileName

String. The file path of the XML file to import. (Required)

fileDescription

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


Example

This example assumes that an XFRACAS XML file called "XMLDATA.xml" exists in the C: drive. The file is assumed to contain XFRACAS incidents. Also, the repository is assumed to be connected to an XFRACAS with existing entities.

VB.NET

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

 'Import the XML file into the XFRACAS entity with ID# 10. 
 Dim ImportXMLSystemID As Integer
 ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLFile(10, XFRACASImportType.Incident, "C:\XMLData.xml", "XMLFileDescription")