Repository.XFRACAS.ProcessXfracasImports: Difference between revisions

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


  '{{APIComment|Declare a new repository connection class.}}
  '{{APIComment|Declare a new repository connection class.}}
  {{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}
  {{APIPrefix|Private WithEvents MyRepository As New [[Repository Class|Repository]]}}
  '{{APIComment|Connect to the Synthesis repository.}}
  '{{APIComment|Connect to the Synthesis repository.}}
  {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}
  {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}
Line 27: Line 27:
=== Reformatted Usage Example ===
=== Reformatted Usage Example ===
{{APIComment|Declare a new repository connection class.}}
{{APIComment|Declare a new repository connection class.}}
         Private WithEvents MyRepository As [[New Repository]]
         Private WithEvents MyRepository As New [[Repository Class|Repository]]


{{APIComment|Connect to the Synthesis repository.}}
{{APIComment|Connect to the Synthesis repository.}}

Revision as of 17:15, 15 May 2014


Immediately processes imported files.

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

Syntax

  • ProcessXfracasImports()

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()