Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions

Revision as of 23:27, 19 August 2015

Member of: SynthesisAPI10.Repository

Uploads an XFRACAS XML import file for processing. Returns an Integer that represents the import file's system ID.

All XML files must first be in the XFRACAS XML format before they can be successfully imported. To view the XFRACAS formats, see the XFRACAS9/10 Import Business Logic (PDF) document.

Syntax

.XFRACAS.ImportXFRACASXMLFile(entityID, importType, fileName, fileDescription)

Parameters

entityID

Integer. The ID number of the XFRACAS entity to import the data into. (Required)

importType

The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any XFRACASImportType constant. (Required)

fileName

String. The file path of the XML file to import. (Required)

fileDescription

String. A description of the XML data to import. (Required)

Example

This example assumes that an XFRACAS XML file called "XMLDATA.xml" exists in the C: drive. The file is assumed to contain XFRACAS incidents. Also, the repository is assumed to be connected to an XFRACAS with existing entities.

VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 'Import the XML file into the XFRACAS entity with ID# 10. 
 Dim ImportXMLSystemID As Integer
 ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLFile(10, XFRACASImportType.Incident, "C:\XMLData.xml", "XMLFileDescription")

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|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|XFRACAS XML Import Documentation]].
+<onlyinclude>Uploads an XFRACAS XML import file for processing. Returns an '''Integer''' that represents the import file's system ID. </onlyinclude>
+All XML files must first be in the XFRACAS XML format before they can be successfully imported. To view the XFRACAS formats, see the [http://www.synthesisplatform.net/XFRACAS/en/XML_XFRACAS9_and_10.pdf XFRACAS9/10 Import Business Logic] (PDF) document.
 == Syntax ==
-*ImportXFRACASXMLFile( entityID {{APIPrefix|As Integer}}, ImportType {{APIPrefix|As}} [[XFRACASImportType]] , fileName {{APIPrefix|As String}}, fileDescription {{APIPrefix|As String}}) {{APIPrefix|As Integer}}
+ '''.XFRACAS.ImportXFRACASXMLFile'''(''entityID'', ''importType'', ''fileName'', ''fileDescription'')
+===Parameters===
+''entityID''
+: Integer. The ID number of the XFRACAS entity to import the data into. (Required)
+''importType''
+:The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant. (Required)
+''fileName''
+: String. The file path of the XML file to import. (Required)
-Parameters
+''fileDescription''
-:''entityID'': The ID of the entity to import into.
-:''ImportType'': The type of XFRACAS Import to utilize, specified as [[XFRACASImportType]].
+: String. A description of the XML data to import. (Required)
-:''fileName'': The file path of the XML file to import.
-:''fileDescription'': A description of the XML to import.
+== Example ==
+This example assumes that an XFRACAS XML file called "XMLDATA.xml" exists in the C: drive. The file is assumed to contain XFRACAS incidents. Also, the repository is assumed to be connected to an XFRACAS with existing entities.
-== Usage Example ==
+  '''VB.NET'''
-  '{{APIComment|Declare a new repository connection class.}}
-  {{APIPrefix|Private WithEvents MyRepository As New [[Repository Class|Repository]]}}
+  {{APIComment|'Add code to connect to a Synthesis repository.}}
-  '{{APIComment|Connect to the Synthesis repository.}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
- {{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}
+  {{APIComment|...}}
- Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")
- '{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
+  {{APIComment|'Import the XML file into the XFRACAS entity with ID# 10.}}
-  {{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As}} [[NameIdPair Class|NameIdPair]]
+  {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
-  ListOfXFRACASEntities = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
+  ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLFile(10, XFRACASImportType.Incident, {{APIString|"C:\XMLData.xml"}}, {{APIString|"XMLFileDescription"}})
- '{{APIComment|Import the XML file into the entity desired.  In this example, the first entity is used.}}
- {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
- ImportXMLSystemID = MyRepository.XFRACAS.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, [[XFRACASImportType]].Incident, "XMLFileName", "XMLFileDescription")

Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions

Revision as of 23:27, 19 August 2015

Syntax

Parameters

Example

Navigation menu

Search