Repository.XFRACAS.ImportXFRACASXMLString: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}




Line 10: Line 10:


== Syntax ==
== Syntax ==
  '''.XFRACAS.ImportXFRACASXMLString'''(''entityID'', ''importType'', ''xmlString'', ''fileTitle'', ''fileDescription'')
  '''.XFRACAS.ImportXfracasXmlString'''(''entityID'', ''importType'', ''xmlString'', ''fileTitle'', ''fileDescription'')


===Parameters===
===Parameters===
Line 50: Line 50:
  {{APIComment|'Import the XML string into XFRACAS entity ID# 1.}}
  {{APIComment|'Import the XML string into XFRACAS entity ID# 1.}}
   {{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"}})
   
   
  {{APIComment|'Process the imported file.}}
  {{APIComment|'Process the imported file.}}
   MyRepository.XFRACAS.ProcessXfracasImports()
   MyRepository.XFRACAS.ProcessXfracasImports()

Revision as of 18:34, 27 October 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Uploads an XML string 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 use the 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.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 repository has connections to existing XFRACAS entities.

VB.NET

 'Add code to connect to a 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")

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