Repository.XFRACAS.ImportXFRACASXML

Member of: SynthesisAPI9.Repository

Imports an XML byte array into a desired XFRACAS entity. Returns an Integer that represents the system ID of the byte array.

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.ImportXfracasXml(entityID, importType, byteData, 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.

byteData

Required. Byte. The byte array 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 to import.

Example

This example assumes that the repository has connections to existing XFRACAS entities.

VB.NET

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

 'Define a serializable XML object, and then populate it with values to import. 
  Dim xmlObject As Object = Nothing
  ... 

 'Define the byte array, and then serialize the object to the byte array. 
  Dim byteArray As Byte() = Nothing
  MyRepository.XFRACAS.SerializeXMLObjectToByteArray(byteArray, xmlObject)

 'Import the XML byte array into XFRACAS entity ID# 10. 
  Dim ImportXMLSystemID As Integer
  ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, "XMLFileTitle", "XMLFileDescription")

 'Process the imported file. 
  MyRepository.XFRACAS.ProcessXfracasImports()