Difference between revisions of "Repository.XFRACAS.ImportXFRACASXMLString"

From ReliaWiki
Jump to navigation Jump to search
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
+
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
  
  
<onlyinclude>Uploads an import file byte stream for processing. Returns an '''Integer''' that represents the system ID.</onlyinclude>
+
<onlyinclude>Uploads the XML string to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>
 +
 
 +
 
 +
{{Template:API_XFRACASNote}}
  
 
== Syntax ==
 
== Syntax ==
  '''.XFRACAS.ImportXFRACASXMLString'''(''entityID'', ''importType'', ''xmlString'', ''fileTitle'', ''fileDescription'')
+
  '''.XFRACAS.ImportXfracasXmlString'''(''entityID'', ''importType'', ''xmlString'', ''fileTitle'', ''fileDescription'')
  
 
===Parameters===
 
===Parameters===
 
''entityID''
 
''entityID''
  
:Integer. The ID number of the XFRACAS entity to import the data into. (Required)
+
:Required. Integer. The ID number of the XFRACAS entity to import the data into.
  
 
''importType''
 
''importType''
  
:The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant. (Required)
+
:Required. The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant.
  
 
''xmlString''
 
''xmlString''
  
:String. The string consisting of the XML to import.
+
:Required. String. The string consisting of the XML to import.
  
 
''fileTitle''
 
''fileTitle''
  
:String. The file title of the XML file byte array to import.
+
:Required. String. The file title of the XML file byte array to import.
  
 
''fileDescription''
 
''fileDescription''
  
: String. A description of the XML data to import. (Required)
+
:Required. String. A description of the XML data to import.
  
  
 
== Example ==
 
== Example ==
This example assumes that the repository is connected to an XFRACAS with existing 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}}
 
   {{APIComment|...}}
 
   {{APIComment|...}}
 
   
 
   
 
   
 
   
  {{APIComment|'Import the XML byte array into the first available XFRACAS entity.}}
+
  {{APIComment|'Import the XML string into XFRACAS entity ID# 1.}}
{{APIComment|'The following code assumes that the XML string type describes XFRACAS incidents.}}
+
  {{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"}})
 

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")