Repository.XFRACAS.ImportXFRACASXMLFile: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) m (→Parameters) |
Kate Racaza (talk | contribs) mNo edit summary |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb | {{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlFile Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | ||
<onlyinclude>Uploads | <onlyinclude>Uploads the XML file to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude> | ||
{{Template:API_XFRACASNote}} | |||
== Syntax == | == Syntax == | ||
'''.XFRACAS. | '''.XFRACAS.ImportXfracasXmlFile'''(''entityID'', ''importType'', ''fileName'', ''fileDescription'') | ||
===Parameters=== | ===Parameters=== | ||
| Line 28: | Line 29: | ||
== Example == | == Example == | ||
This example assumes that an | This example assumes that an XML file called "XMLDATA.xml" exists in the C: drive. | ||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|' | {{APIComment|'Connect to a Synthesis enterprise repository.}} | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
MyRepository.ConnectToSQLRepository({{APIString|"MyServer"}}, {{APIString|"MyDatabase"}}) | |||
{{APIComment|'Import the XML file into | {{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
 |
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")