Difference between revisions of "Repository.XFRACAS.ImportXFRACASXMLString"

From ReliaWiki
Jump to navigation Jump to search
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
+
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Uploads an import file bytestream for processing and returns the system ID
 
== Method Syntax ==
 
{{APIName|Public Function '''ImportXFRACASXMLString'''(}}
 
{{APIPrefix|ByVal}}
 
{{APIName|entityID }}
 
{{APIPrefix|As Integer}}
 
{{APIName|,}}
 
{{APIPrefix|ByVal}}
 
{{APIName|ImportType}}
 
{{APIPrefix|As}}
 
{{APIName|[[XFRACASImportType]],}}
 
{{APIPrefix|ByVal}}
 
{{APIName|xmlString }}
 
{{APIPrefix|As String}}
 
{{APIName|,}}
 
{{APIPrefix|ByVal }}
 
{{APIName|fileTitle }}
 
{{APIPrefix|As String}}
 
{{APIName|,}}
 
{{APIPrefix|ByVal }}
 
{{APIName|fileDescription }}
 
{{APIPrefix|As String}}
 
{{APIName|)}}
 
{{APIPrefix|As Integer}}<br>
 
{{APIComment|Uploads an import file bytestream for processing and returns the system ID of the uploaded}}
 
  
== Parameters ==
 
'''entityID'''
 
{{APIComment|The ID of the entity to import into.}}
 
  
'''ImportType'''
+
<onlyinclude>Uploads the XML string to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>
{{APIComment|The type of XFRACAS Import to utilize.}}
 
  
'''xmlString'''
 
{{APIComment|The string consisting of the XML to import.}}
 
  
'''fileTitle'''
+
{{Template:API_XFRACASNote}}
{{APIComment|The file title of the XML file byte array to import.}}
 
  
'''fileDescription'''
+
== Syntax ==
{{APIComment|A description of the XML to import.}}
+
'''.XFRACAS.ImportXfracasXmlString'''(''entityID'', ''importType'', ''xmlString'', ''fileTitle'', ''fileDescription'')
  
== Usage Example ==
+
===Parameters===
 +
''entityID''
  
{{APIComment| Code Block}}
+
:Required. Integer. The ID number of the XFRACAS entity to import the data into.
        '{{APIComment|Declare a new repository connection class.}}
 
        {{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}<br>
 
        '{{APIComment|Connect to the desired Synthesis repository.}}
 
        {{APIPrefix|Dim}}Success{{APIPrefix|As Boolean}}={{APIPrefix|False}}
 
        Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")<br>
 
        '{{APIComment|Set the Desired Entity ID to import into.}}
 
        {{APIPrefix|Dim}} DesiredEntityID {{APIPrefix|As Integer}}
 
        DesiredEntityID = '{{APIComment|Set the entity ID}}<br>
 
        '{{APIComment|Define an XML string}}
 
        {{APIPrefix|Dim}}xmlString{{APIPrefix|As String}}={{APIPrefix|Nothing}}
 
        '{{APIComment|populate the xmlString with the XML text}}<br>
 
        '{{APIComment|Import the XML byte array into the entity desired.  In this example, we assume the XML string type describes an Incident.}}
 
        {{APIPrefix|Dim}}ImportXMLSystemID{{APIPrefix|As Integer}}
 
        ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLString|ImportXFRACASXMLString]](DesiredEntityID, [[XFRACASImportType]].Incident, xmlString, "XMLFileTitle", "XMLFileDescription")
 
  
 +
''importType''
  
=Reformatted Usage Example=
+
:Required. The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant.
{{APIComment|Declare a new repository connection class.}}
 
        Private WithEvents MyRepository As [[New Repository]]
 
  
{{APIComment|Connect to the desired Synthesis repository.}}
+
''xmlString''
        Dim Success As Boolean = False
 
        Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")
 
  
{{APIComment|Set the Desired Entity ID to import into.}}
+
:Required. String. The string consisting of the XML to import.
        Dim DesiredEntityID As Integer
 
        DesiredEntityID = '{{APIComment|Set the entity ID}}
 
  
{{APIComment|Define an XML string.}}
+
''fileTitle''
        Dim xmlString As String = Nothing
 
        'populate the xmlString with the XML text
 
  
{{APIComment|Import the XML byte array into the entity desiredIn this example, we assume the XML string type describes an Incident.}}
+
:Required. String. The file title of the XML file byte array to import.
        Dim ImportXMLSystemID As Integer
+
 
        ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLString|ImportXFRACASXMLString]](DesiredEntityID, [[XFRACASImportType]].Incident, xmlString, "XMLFileTitle", "XMLFileDescription")
+
''fileDescription''
 +
 
 +
:Required. String. A description of the XML data to import.
 +
 
 +
 
 +
== Example ==
 +
 
 +
'''VB.NET'''
 +
 +
{{APIComment|'Connect to a Synthesis enterprise repository.}}
 +
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 +
  MyRepository.ConnectToSQLRepository({{APIString|"MyServer"}}, {{APIString|"MyDatabase"}})
 +
 
 +
{{APIComment|'Define an XML string and populate it with the XML text.}}
 +
  {{APIPrefix|Dim}} xmlString {{APIPrefix|As String}} = {{APIPrefix|Nothing}}
 +
  {{APIComment|...}}
 +
 +
 +
  {{APIComment|'Import the XML string into XFRACAS entity ID# 1.}}
 +
  {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
 +
  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")