Repository.XFRACAS.ImportXFRACASXML: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(34 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXml Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Uploads an import byte array for processing and returns the system ID
== Method Syntax ==
{{APIName|Public Function '''ImportXFRACASXML'''(}}
{{APIPrefix|ByVal}}
{{APIName|entityID }}
{{APIPrefix|As Integer}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|ImportType}}
{{APIPrefix|As}}
{{APIName|[[XFRACASImportType]],}}
{{APIPrefix|ByVal}}
{{APIName|byteData }}
{{APIPrefix|As Byte()}}
{{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 byte array to the XFRACAS import queue. Returns an '''Integer''' that represents the record ID of the byte array.</onlyinclude>
{{APIComment|The type of XFRACAS Import to utilize.}}


'''byteData'''
{{APIComment|The byte array 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.}}


== Usage Example ==
'''.XFRACAS.ImportXfracasXml'''(''entityID'', ''importType'', ''byteData'', ''fileTitle'', ''fileDescription'')
{{APIComment|Code Block}}


'{{APIComment|Declare a new repository connection class.}}
===Parameters===
{{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}
'{{APIComment|Connect to the desired Synthesis repository.}}
{{APIPrefix|Dim}}Success{{APIPrefix|As Boolean}}={{APIPrefix|False}}
Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")
'{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
{{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As}} [[NameIdPair Class|NameIdPair]]
ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()
'{{APIComment|Search the Entities for the desired Entity name, to find the Entity ID}}
{{APIPrefix|Dim}} DesiredEntityID {{APIPrefix|As Integer}}
        For Each Entity {{APIPrefix|As}} NameIdPair In ListOfXFRACASEntities()
            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.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.[[Repository.ImportXFRACASXML|ImportXFRACASXML]](DesiredEntityID, XFRACASImportType.Incident, byteArray, "XMLFileTitle", "XMLFileDescription")


''entityID''


=== Reformatted Usage Example ===
:Required. Integer. The ID number of the XFRACAS entity to import the data into.  
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As [[New Repository]]


{{APIComment|Connect to the desired Synthesis repository.}}
''importType''
        Dim Success As Boolean = False
        Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")


{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
:Required. The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant.
        Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]]
        ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()


{{APIComment|Search the Entities for the desired Entity name, to find the Entity ID}}
''byteData''
        Dim DesiredEntityID As Integer
        For Each Entity As NameIdPair In ListOfXFRACASEntities()
            If Entity.Name = "DesiredEntityName"
              DesiredEntityID = Entity.ID
              Exit For
            End If
        Next


{{APIComment|Define an serializable XML Object.}}
:Required. Byte. The byte array of the XML to import.
        Dim xmlObject As Object = Nothing
        'populate the xmlObject with values to import


{{APIComment|Define the byte array.}}
''fileTitle''
        Dim byteArray As Byte() = Nothing


{{APIComment|Serialize the xmlObject into the byteArray.}}
:Required. String. The file title of the XML file byte array to import.
        Dim SerializeSuccess As Boolean
        SerializeSuccess = MyRepository.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.}}
''fileDescription''
        Dim ImportXMLSystemID As Integer
 
        ImportXMLSystemID = MyRepository.ImportXFRACASXML(DesiredEntityID, XFRACASImportType.Incident, byteArray, "XMLFileTitle", "XMLFileDescription")
: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|'Define a serializable XML object, and then populate it with values to import.}}
  {{APIPrefix|Dim}} xmlObject {{APIPrefix|As Object}} = {{APIPrefix|Nothing}}
  {{APIComment|...}}
{{APIComment|'Define the byte array, and then serialize the object to the byte array.}}
  {{APIPrefix|Dim}} byteArray {{APIPrefix|As}} Byte() = {{APIPrefix|Nothing}}
  MyRepository.XFRACAS.SerializeXMLObjectToByteArray(byteArray, xmlObject)
   
{{APIComment|'Import the XML byte array into XFRACAS entity ID# 10.}}
  {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
  ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, {{APIString|"XMLFileTitle"}}, {{APIString|"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"