Repository.XFRACAS.ProcessXfracasImports: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 8: Line 8:


== Usage Example ==
== Usage Example ==
{{APIComment|Code Block}}
  '{{APIComment|Declare a new repository connection class.}}
  '{{APIComment|Declare a new repository connection class.}}
  {{APIPrefix|Private WithEvents MyRepository As New [[Repository Class|Repository]]}}
  {{APIPrefix|Private WithEvents MyRepository As New [[Repository Class|Repository]]}}
Line 17: Line 15:
  '{{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")
  '{{APIComment|Process the imported file.}}
  '{{APIComment|Process the imported file.}}
  MyRepository.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]()
  MyRepository.XFRACAS.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]()
 
 
=== 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.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath")
 
{{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")
 
{{APIComment|Process the imported file.}}
        MyRepository.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]()

Revision as of 16:04, 27 May 2015


Immediately processes imported files.

For information on the business logic of XFRACAS XML Import click here: XFRACAS XML Import Documentation

Syntax

  • ProcessXfracasImports()

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.ConnectToRepository("RepositoryFileNamePath")
' 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")
' Process the imported file. 
MyRepository.XFRACAS.ProcessXfracasImports()