Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
 
(27 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlFile Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Uploads an import file for processing and returns the system ID
== Method Syntax ==
{{APIName|'''ImportXFRACASXMLFile'''(}}
{{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 ==
'''entityID'''
{{APIComment|The ID of the entity to import into.}}


'''ImportType'''
<onlyinclude>Uploads the XML file to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>
{{APIComment|The type of XFRACAS Import to utilize.}}


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


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


== Usage Example ==
== Syntax ==
  '{{APIComment|Declare a new repository connection class.}}
  '''.XFRACAS.ImportXfracasXmlFile'''(''entityID'', ''importType'', ''fileName'', ''fileDescription'')
{{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}
'{{APIComment|Connect to the Synthesis repository.}}
{{APIPrefix|Dim}} Success {{APIPrefix|As Boolean}} = {{APIPrefix|False}}
Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")
'{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
{{APIPrefix|Dim}} ListOfXFRACASEntities() {{APIPrefix|As}} [[NameIdPair Class|NameIdPair]]
ListOfXFRACASEntities = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
'{{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.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, [[XFRACASImportType.Incident]], "XMLFileName", "XMLFileDescription")


=== Reformatted Usage Example ===
===Parameters===
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As [[New Repository]]


{{APIComment|Connect to the Synthesis repository.}}
''entityID''
        Dim Success As Boolean = False
        Success = MyRepository.[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]("SQLServerPath", "SQLDatabaseName")


{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
:Required. Integer. The ID number of the XFRACAS entity to import the data into.  
        Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]]
        ListOfXFRACASEntities = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()


{{APIComment|Import the XML file into the entity desired.  In this example, the first entity is used.}}
''importType''
        Dim ImportXMLSystemID As Integer
 
        ImportXMLSystemID = MyRepository.[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]](ListOfXFRACASEntities(0).ID, [[XFRACASImportType]].Incident, "XMLFileName", "XMLFileDescription")
:Required. The XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant.
 
''fileName''
 
:Required.  String. The file path of the XML file to import.
 
''fileDescription''
 
:Required. String. A description of the XML data to import.
 
== Example ==
This example assumes that an XML file called "XMLDATA.xml" exists in the C: drive.
 
'''VB.NET'''
{{APIComment|'Connect to a Synthesis enterprise repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToSQLRepository({{APIString|"MyServer"}}, {{APIString|"MyDatabase"}})
{{APIComment|'Import the XML file into XFRACAS entity ID# 10.}}
  {{APIPrefix|Dim}} ImportXMLSystemID {{APIPrefix|As Integer}}
  ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlFile(10, XFRACASImportType.Incident, {{APIString|"C:\XMLData.xml"}}, {{APIString|"XMLFileDescription"}})

Latest revision as of 17:00, 12 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Uploads the XML file to the XFRACAS import queue. Returns an Integer that represents the import file's record ID.


Remarks: The XML file will be processed at the next scheduled import, or you can choose to process immediately all items in the import queue by using the ProcessXfracasImports method.

For the XML file to be imported successfully, you must have the "Manage Import" admin permission in the XFRACAS entity where you are uploading the file, and the XML file must be in the correct XFRACAS XML format. The XFRACAS 11 Import Business Logic (PDF) document provides a complete description of the XFRACAS format.

Syntax

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

Parameters

entityID

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

importType

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

fileName

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

fileDescription

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

Example

This example assumes that an XML file called "XMLDATA.xml" exists in the C: drive. 

VB.NET

 'Connect to a Synthesis enterprise repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToSQLRepository("MyServer", "MyDatabase")

 'Import the XML file into XFRACAS entity ID# 10. 
  Dim ImportXMLSystemID As Integer
  ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlFile(10, XFRACASImportType.Incident, "C:\XMLData.xml", "XMLFileDescription")
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.XFRACAS.ImportXFRACASXMLFile&oldid=64498"