Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) No edit summary |
John Leavitt (talk | contribs) No edit summary |
||
| Line 43: | Line 43: | ||
'{{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.GetAllXFRACASEntities() | ListOfXFRACASEntities = MyRepository.[[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}} | ||
| Line 58: | Line 58: | ||
{{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.}} | ||
Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]] | Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]] | ||
ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities() | ListOfXFRACASEntities = MyRepository.[[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.}} | ||
Dim ImportXMLSystemID As Integer | Dim ImportXMLSystemID As Integer | ||
ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription") | ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, XFRACASImportType.Incident, "XMLFileName", "XMLFileDescription") | ||
Revision as of 22:33, 18 October 2013
Uploads an import file for processing and returns the system ID
Method Syntax
ImportXFRACASXMLFile(
ByVal
entityID
As Integer
,
ByVal
ImportType
As
XFRACASImportType,
ByVal
fileName
As String
,
ByVal
fileDescription
As String
)
As Integer
Uploads an import file for processing and returns the system ID of the uploaded
Parameters
entityID The ID of the entity to import into.
ImportType The type of XFRACAS Import to utilize.
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.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")
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.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")
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")