Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:
To view XFRACAS formats refer to the XFRACAS [[XFRACAS XML Import Documentation|XML Import Documentation]] business logic contents.
To view XFRACAS formats refer to the XFRACAS [[XFRACAS XML Import Documentation|XML Import Documentation]] business logic contents.


== Method Syntax ==
== Syntax ==
{{APIName|'''ImportXFRACASXMLFile'''(}}
*ImportXFRACASXMLFile( entityID {{APIPrefix|As Integer}}, ImportType {{APIPrefix|As}} [[XFRACASImportType]], fileName {{APIPrefix|As String}}, fileDescription {{APIPrefix|As String}}) {{APIPrefix|As Integer}}
{{APIPrefix|ByVal}}
{{APIName|entityID }}
{{APIPrefix|As Integer}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|ImportType}}
{{APIPrefix|As}}
{{APIName|[[XFRACASImportType]],}}
{{APIPrefix|ByVal}}
{{APIName|fileName }}
{{APIPrefix|As String}}
{{APIName|,}}
{{APIPrefix|ByVal }}
{{APIName|fileDescription }}
{{APIPrefix|As String}}
{{APIName|)}}
{{APIPrefix|As Integer}}<br>
{{APIComment|Uploads an import file for processing and returns the system ID of the uploaded}}


== Parameters ==
Parameters
'''entityID'''
:''entityID'': The ID of the entity to import into.
{{APIComment|The ID of the entity to import into.}}


'''ImportType'''
:''ImportType'': The type of XFRACAS Import to utilize.
{{APIComment|The type of XFRACAS Import to utilize.}}


'''fileName'''
:''fileName'': The file path of the XML file to import.
{{APIComment|The file path of the XML file to import.}}


'''fileDescription'''
:''fileDescription'': A description of the XML to import.
{{APIComment|A description of the XML to import.}}


== Usage Example ==
== Usage Example ==

Revision as of 20:38, 27 February 2014
SynAPI.png
Main Page
Repository

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.
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")
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.XFRACAS.ImportXFRACASXMLFile&oldid=51650"