Repository.XFRACAS.ProcessXfracasImports: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:
{{APIComment|Code Block}}
{{APIComment|Code Block}}


{{APIComment|Declare a new repository connection class.}}<br>
'{{APIComment|Declare a new repository connection class.}}<br>
{{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}<br>
{{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}<br>
{{APIComment|Connect to the Synthesis repository.}}<br>
'{{APIComment|Connect to the Synthesis repository.}}<br>
{{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}<br>
{{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}<br>
Success = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath")<br>
Success = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath")<br>
{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}<br>
'{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}<br>
{{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As [[NameIdPair Class|NameIdPair]]}}<br>
{{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As [[NameIdPair Class|NameIdPair]]}}<br>
ListOfXFRACASEntities = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()<br>
ListOfXFRACASEntities = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()<br>
{{APIComment|Import the XML file into the entity desired.  In this example, the first entity is used.}}<br>
'{{APIComment|Import the XML file into the entity desired.  In this example, the first entity is used.}}<br>
{{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}<br>
{{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}<br>
ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, [[XFRACASImportType]].Incident, "XMLFileName", "XMLFileDescription")<br>
ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, [[XFRACASImportType]].Incident, "XMLFileName", "XMLFileDescription")<br>
{{APIComment|Process the imported file.}}<br>
'{{APIComment|Process the imported file.}}<br>
MyRepository.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]()<br>
MyRepository.[[Repository.ProcessXfracasImports|ProcessXfracasImports]]()<br>



Revision as of 22:42, 18 October 2013


Immediately processes imported files.

Method Syntax

ProcessXfracasImports()
Immediately processes imported files.

Usage Example

Code Block

' 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.GetAllXFRACASEntities()
' Import the XML file into the entity desired. In this example, the first entity is used.
Dim ImportXMLSystemID As Integer
ImportXMLSystemID = MyRepository.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription")
' Process the imported file.
MyRepository.ProcessXfracasImports()


Reformatted 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.GetAllXFRACASEntities()

Import the XML file into the entity desired. In this example, the first entity is used.

       Dim ImportXMLSystemID As Integer
       ImportXMLSystemID = MyRepository.ImportXFRACASXMLFile(ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription")

Process the imported file.

       MyRepository.ProcessXFracasImports()