Difference between revisions of "Repository.XFRACAS.ImportXFRACASXMLString"

From ReliaWiki
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb|9|.[[Repository Class|Repository]]}}
+
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
  
  
 +
<onlyinclude>Uploads the XML string to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>
  
<onlyinclude>Uploads an XML string to XFRACAS for processing. Returns an '''Integer''' that represents the import file's system ID. </onlyinclude>
 
  
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 [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.
+
{{Template:API_XFRACASNote}}
 
 
Once the XML file has been uploaded for processing, use the [[Repository.XFRACAS.ProcessXfracasImports|ProcessXfracasImports]] method to process the XML file.
 
  
 
== Syntax ==
 
== Syntax ==
Line 35: Line 33:
  
 
== Example ==
 
== Example ==
This example assumes that the repository has connections to existing XFRACAS entities.
 
  
 
  '''VB.NET'''
 
  '''VB.NET'''
 
   
 
   
  {{APIComment|'Add code to connect to a 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|'Define an XML string and populate it with the XML text.}}
 
  {{APIComment|'Define an XML string and populate it with the XML text.}}
 
   {{APIPrefix|Dim}} xmlString {{APIPrefix|As String}} = {{APIPrefix|Nothing}}
 
   {{APIPrefix|Dim}} xmlString {{APIPrefix|As String}} = {{APIPrefix|Nothing}}
Line 51: Line 48:
 
   {{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.}}
 
  MyRepository.XFRACAS.ProcessXfracasImports()
 

Latest revision as of 17:00, 12 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Uploads the XML string 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.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

VB.NET

 'Connect to a Synthesis enterprise repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToSQLRepository("MyServer", "MyDatabase")
 
 '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")