Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 23: Line 23:
  '{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
  '{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
  {{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As}} [[NameIdPair Class|NameIdPair]]
  {{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As}} [[NameIdPair Class|NameIdPair]]
  ListOfXFRACASEntities = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
  ListOfXFRACASEntities = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
  '{{APIComment|Import the XML file into the entity desired.  In this example, the first entity is used.}}
  '{{APIComment|Import the XML file into the entity desired.  In this example, the first entity is used.}}
  {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
  {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
  ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, [[XFRACASImportType]].Incident, "XMLFileName", "XMLFileDescription")
  ImportXMLSystemID = MyRepository.XFRACAS.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, [[XFRACASImportType]].Incident, "XMLFileName", "XMLFileDescription")
 
=== Reformatted Usage Example ===
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New [[Repository Class|Repository]]
 
{{APIComment|Connect to the Synthesis repository.}}
        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.}}
        Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]]
        ListOfXFRACASEntities = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
 
{{APIComment|Import the XML file into the entity desired.  In this example, the first entity is used.}}
        Dim ImportXMLSystemID As Integer
        ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, [[XFRACASImportType]].Incident, "XMLFileName", "XMLFileDescription")

Revision as of 15:55, 27 May 2015


This function uploads an import file for processing and returns the system ID. To view XFRACAS formats refer to the XFRACAS XML Import Documentation business logic contents.

Syntax

  • ImportXFRACASXMLFile( entityID As Integer, ImportType As XFRACASImportType , fileName As String, fileDescription As String) As Integer

Parameters

entityID: The ID of the entity to import into.
ImportType: The type of XFRACAS Import to utilize, specified as XFRACASImportType.
fileName: The file path of the XML file to import.
fileDescription: A description of the XML to import.

Usage Example

' Declare a new repository connection class. 
Private WithEvents MyRepository As New Repository
' Connect to the Synthesis repository. 
Dim Success As Boolean = False
Success = MyRepository.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")
' Get the list of XFRACAS Entities in the current project in the connected repository. 
Dim ListOfXFRACASEntities() As NameIdPair
ListOfXFRACASEntities = MyRepository.XFRACAS.GetAllXFRACASEntities()
' Import the XML file into the entity desired.  In this example, the first entity is used. 
Dim ImportXMLSystemID As Integer
ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription")