Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlFile Method}}{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlFile Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<onlyinclude>Uploads an XML file to XFRACAS for processing. Returns an '''Integer''' that represents the import file's system ID. </onlyinclude>
<onlyinclude>Uploads the XML file to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>


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 [http://www.synthesisplatform.net/XFRACAS/en/XML_XFRACAS9_and_10.pdf 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 [[Repository.XFRACAS.ProcessXfracasImports|ProcessXfracasImports]] method to process the XML file.
{{Template:API_XFRACASNote}}


== Syntax ==
== Syntax ==
Line 30: Line 29:


== Example ==
== 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.
This example assumes that an XML file called "XMLDATA.xml" exists in the C: drive.


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIComment|'Add code to connect to the Synthesis repository.}}
  {{APIComment|'Connect to a Synthesis enterprise repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToSQLRepository({{APIString|"MyServer"}}, {{APIString|"MyDatabase"}})
   
   
  {{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}}
   {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
   ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlFile(10, XFRACASImportType.Incident, {{APIString|"C:\XMLData.xml"}}, {{APIString|"XMLFileDescription"}})
   ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlFile(10, XFRACASImportType.Incident, {{APIString|"C:\XMLData.xml"}}, {{APIString|"XMLFileDescription"}})
{{APIComment|'Process the imported file.}}
  MyRepository.XFRACAS.ProcessXfracasImports()

Latest revision as of 17:00, 12 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Uploads the XML file to the XFRACAS import queue. Returns an Integer that represents the import file's record ID.


Remarks: The XML file will be processed at the next scheduled import, or you can choose to process immediately all items in the import queue by using the ProcessXfracasImports method.

For the XML file to be imported successfully, you must have the "Manage Import" admin permission in the XFRACAS entity where you are uploading the file, and the XML file must be in the correct XFRACAS XML format. The XFRACAS 11 Import Business Logic (PDF) document provides a complete description of the XFRACAS format.

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 an XML file called "XMLDATA.xml" exists in the C: drive.

VB.NET

 'Connect to a Synthesis enterprise repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToSQLRepository("MyServer", "MyDatabase")

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