Repository.XFRACAS.ImportXFRACASXML: Difference between revisions

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


[[Synthesis API Reference|Synthesis API]] allows the programmer to import XML files into XFRACAS. The page contains the logic of that importation. All XML files must first be in the XFRACAS format before they can be successfully imported. To view XFRACAS formats, refer to the [[XFRACAS XML Import Documentation]].


<onlyinclude>Uploads the XML byte array to the XFRACAS import queue. Returns an '''Integer''' that represents the record ID of the byte array.</onlyinclude>


This is different from importing XML files directly into XFRACAS. If the programmer wishes to import files directly into XFRACAS instead of using Synthesis API, they should view the [[XFRACAS XML Import Documentation]] for the steps of that importation.


The ImportXFRACASXML method uploads an import byte array for processing and returns the system ID.
{{Template:API_XFRACASNote}}


== Syntax ==
== Syntax ==
*ImportXFRACASXML( entityID {{APIPrefix|As Integer}}, ImportType {{APIPrefix|As}} [[XFRACASImportType]] , byteData {{APIPrefix|As Byte()}}, fileTitle {{APIPrefix|As String}}, fileDescription {{APIPrefix|As String}}) {{APIPrefix|As Integer}}


Parameters:
'''.XFRACAS.ImportXfracasXml'''(''entityID'', ''importType'', ''byteData'', ''fileTitle'', ''fileDescription'')
:''entityID'':The ID of the entity to import into.


:''ImportType'': The type of XFRACAS Import to utilize, specified as [[XFRACASImportType]].
===Parameters===


:''byteData'': The byte array of the XML to import.
''entityID''


:''fileTitle'': The file title of the XML file byte array to import.
:Required. Integer. The ID number of the XFRACAS entity to import the data into.  


:''fileDescription'': A description of the XML to import.
''importType''


== Usage Example ==
:Required. The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant.
{{APIComment|Code Block}}


  '{{APIComment|Declare a new repository connection class.}}
''byteData''
{{APIPrefix|Private WithEvents MyRepository As New [[Repository Class|Repository]]}}
 
:Required. Byte. The byte array 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 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|Connect to the desired Synthesis repository.}}
  {{APIComment|'Define a serializable XML object, and then populate it with values to import.}}
{{APIPrefix|Dim}}Success{{APIPrefix|As Boolean}}={{APIPrefix|False}}
  {{APIPrefix|Dim}} xmlObject {{APIPrefix|As Object}} = {{APIPrefix|Nothing}}
Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")
  {{APIComment|...}}
   
   
  '{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
  {{APIComment|'Define the byte array, and then serialize the object to the byte array.}}
{{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As}} [[NameIdPair Class|NameIdPair]]
  {{APIPrefix|Dim}} byteArray {{APIPrefix|As}} Byte() = {{APIPrefix|Nothing}}
ListOfXFRACASEntities = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
  MyRepository.XFRACAS.SerializeXMLObjectToByteArray(byteArray, xmlObject)
   
   
  '{{APIComment|Search the Entities for the desired Entity name, to find the Entity ID}}
  {{APIComment|'Import the XML byte array into XFRACAS entity ID# 10.}}
{{APIPrefix|Dim}} DesiredEntityID {{APIPrefix|As Integer}}
  {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
        For Each Entity {{APIPrefix|As}} NameIdPair In ListOfXFRACASEntities()
  ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, {{APIString|"XMLFileTitle"}}, {{APIString|"XMLFileDescription"}})
            If Entity.Name = "DesiredEntityName"
              DesiredEntityID = Entity.ID
              Exit For
            End If
        Next
'{{APIComment|Define an serializable XML Object.}}
{{APIPrefix|Dim}} xmlObject {{APIPrefix|As Object}} = {{APIPrefix|Nothing}}
'{{APIComment|populate the xmlObject with values to import}}
'{{APIComment|Define the byte array.}}
{{APIPrefix|Dim}}byteArray {{APIPrefix|As}} Byte() = {{APIPrefix|Nothing}}
'{{APIComment|Serialize the xmlObject into the byteArray.}}
{{APIPrefix|Dim}} SerializeSuccess {{APIPrefix|As Boolean}}
  SerializeSuccess = MyRepository.XFRACAS.[[Repository.SerializeXMLObjectToByteArray|SerializeXMLObjectToByteArray]](byteArray, xmlObject)
'{{APIComment|Import the XML byte array into the entity desired.  In this example, we assume the XML object type describes an Incident.}}
{{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
ImportXMLSystemID = MyRepository.XFRACAS.[[Repository.ImportXFRACASXML|ImportXFRACASXML]](DesiredEntityID, [[XFRACASImportType]].Incident, byteArray, "XMLFileTitle", "XMLFileDescription")

Latest revision as of 17:00, 12 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Uploads the XML byte array to the XFRACAS import queue. Returns an Integer that represents the record ID of the byte array.


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.ImportXfracasXml(entityID, importType, byteData, 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.

byteData

Required. Byte. The byte array 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 to import.


Example

VB.NET

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

 'Define a serializable XML object, and then populate it with values to import. 
  Dim xmlObject As Object = Nothing
  ... 

 'Define the byte array, and then serialize the object to the byte array. 
  Dim byteArray As Byte() = Nothing
  MyRepository.XFRACAS.SerializeXMLObjectToByteArray(byteArray, xmlObject)

 'Import the XML byte array into XFRACAS entity ID# 10. 
  Dim ImportXMLSystemID As Integer
  ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, "XMLFileTitle", "XMLFileDescription")
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.XFRACAS.ImportXFRACASXML&oldid=64499"