Repository.XFRACAS.ImportXFRACASXMLString - Revision history

Kate Racaza at 17:00, 12 August 2016

2016-08-12T17:00:56Z

← Older revision		Revision as of 17:00, 12 August 2016
Line 2:		Line 2:


			<onlyinclude>Uploads the XML string to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>

	~~<onlyinclude>Uploads the XML string to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>~~

	{{Template:API_XFRACASNote}}		{{Template:API_XFRACASNote}}

Kate Racaza at 16:44, 10 March 2016

2016-03-10T16:44:00Z

← Older revision		Revision as of 16:44, 10 March 2016
Line 33:		Line 33:

	== Example ==		== Example ==
	~~This example assumes that the enterprise repository has connections to existing XFRACAS entities.~~

	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'~~Add code~~ to ~~connect to an~~ Synthesis enterprise repository.}}		{{APIComment\|'Connect to a Synthesis enterprise repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|~~...~~}}		MyRepository.ConnectToSQLRepository({{APIString\|"MyServer"}}, {{APIString\|"MyDatabase"}})

	{{APIComment\|'Define an XML string and populate it with the XML text.}}		{{APIComment\|'Define an XML string and populate it with the XML text.}}
	{{APIPrefix\|Dim}} xmlString {{APIPrefix\|As String}} = {{APIPrefix\|Nothing}}		{{APIPrefix\|Dim}} xmlString {{APIPrefix\|As String}} = {{APIPrefix\|Nothing}}

Kate Racaza at 22:32, 13 November 2015

2015-11-13T22:32:55Z

← Older revision		Revision as of 22:32, 13 November 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}		{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}

Kate Racaza: /* Example */

2015-11-09T18:52:51Z

Example

← Older revision		Revision as of 18:52, 9 November 2015
Line 37:		Line 37:
	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'Add code to connect to an enterprise ~~Synthesis~~ repository.}}		{{APIComment\|'Add code to connect to an Synthesis enterprise repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIComment\|...}}		{{APIComment\|...}}

Kate Racaza at 18:45, 9 November 2015

2015-11-09T18:45:34Z

← Older revision		Revision as of 18:45, 9 November 2015
Line 3:		Line 3:


	<onlyinclude>Uploads an XML string to XFRACAS's import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>		<onlyinclude>Uploads the XML string to the XFRACAS import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>

	{{Template:API_XFRACASNote}}		{{Template:API_XFRACASNote}}

Kate Racaza at 18:41, 9 November 2015

2015-11-09T18:41:20Z

← Older revision		Revision as of 18:41, 9 November 2015
Line 3:		Line 3:


	<onlyinclude>Uploads an XML string to XFRACAS ~~for processing~~. Returns an '''Integer''' that represents the import file's ~~system~~ ID. </onlyinclude>		<onlyinclude>Uploads an XML string to XFRACAS's import queue. Returns an '''Integer''' that represents the import file's record ID. </onlyinclude>

	~~You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must use the XFRACAS format in order to be successfully imported. The [http~~:~~//www.synthesisplatform.net/XFRACAS/en/XML_XFRACAS9_and_10.pdf XFRACAS9/10 Import Business Logic] (PDF) document provides a complete description of the format.~~		{{Template:API_XFRACASNote}}

	~~Once the XML file has been uploaded for processing, use the [[Repository.XFRACAS.ProcessXfracasImports\|ProcessXfracasImports]] method to process the XML file.~~

	== Syntax ==		== Syntax ==
Line 35:		Line 33:

	== Example ==		== Example ==
	This example assumes that the repository has connections to existing XFRACAS entities.		This example assumes that the enterprise repository has connections to existing XFRACAS entities.

	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'Add code to connect to a Synthesis repository.}}		{{APIComment\|'Add code to connect to an enterprise Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIComment\|...}}		{{APIComment\|...}}
Line 51:		Line 49:
	{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlString(1, XFRACASImportType.Incident, xmlString, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})		ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlString(1, XFRACASImportType.Incident, xmlString, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

	~~{{APIComment\|'Process the imported file.}}~~
	~~MyRepository.XFRACAS.ProcessXfracasImports()~~

Kate Racaza at 19:58, 28 October 2015

2015-10-28T19:58:17Z

← Older revision		Revision as of 19:58, 28 October 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}		{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}

Kate Racaza at 18:34, 27 October 2015

2015-10-27T18:34:12Z

← Older revision		Revision as of 18:34, 27 October 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}		{{DISPLAYTITLE:Repository.XFRACAS.ImportXfracasXmlString Method}}{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}


Line 10:		Line 10:

	== Syntax ==		== Syntax ==
	'''.XFRACAS.~~ImportXFRACASXMLString~~'''(''entityID'', ''importType'', ''xmlString'', ''fileTitle'', ''fileDescription'')		'''.XFRACAS.ImportXfracasXmlString'''(''entityID'', ''importType'', ''xmlString'', ''fileTitle'', ''fileDescription'')

	===Parameters===		===Parameters===
Line 50:		Line 50:
	{{APIComment\|'Import the XML string into XFRACAS entity ID# 1.}}		{{APIComment\|'Import the XML string into XFRACAS entity ID# 1.}}
	{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	ImportXMLSystemID = MyRepository.XFRACAS.~~ImportXFRACASXMLString~~(1, XFRACASImportType.Incident, xmlString, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})		ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXmlString(1, XFRACASImportType.Incident, xmlString, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

	{{APIComment\|'Process the imported file.}}		{{APIComment\|'Process the imported file.}}
	MyRepository.XFRACAS.ProcessXfracasImports()		MyRepository.XFRACAS.ProcessXfracasImports()

Kate Racaza at 23:36, 26 October 2015

2015-10-26T23:36:22Z

← Older revision		Revision as of 23:36, 26 October 2015
Line 2:		Line 2:


	<onlyinclude>Uploads an ~~import file byte stream~~ for processing. Returns an '''Integer''' that represents the system ID.</onlyinclude>
			<onlyinclude>Uploads an XML string to XFRACAS for processing. Returns an '''Integer''' that represents the import file's system ID. </onlyinclude>

			You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must use the XFRACAS format in order to be successfully imported. The [http://www.synthesisplatform.net/XFRACAS/en/XML_XFRACAS9_and_10.pdf XFRACAS9/10 Import Business Logic] (PDF) document provides a complete description of the format.

			Once the XML file has been uploaded for processing, use the [[Repository.XFRACAS.ProcessXfracasImports\|ProcessXfracasImports]] method to process the XML file.

	== Syntax ==		== Syntax ==
Line 30:		Line 35:

	== Example ==		== Example ==
	This example assumes that the repository ~~is connected~~ to an XFRACAS ~~with existing~~ entities.		This example assumes that the repository has connections to existing XFRACAS entities.

	'''VB.NET'''		'''VB.NET'''
Line 39:		Line 44:

	{{APIComment\|'Define an XML string and populate it with the XML text.}}		{{APIComment\|'Define an XML string and populate it with the XML text.}}
	{{APIPrefix\|Dim}} xmlString {{APIPrefix\|As String}} = {{APIPrefix\|Nothing}}		{{APIPrefix\|Dim}} xmlString {{APIPrefix\|As String}} = {{APIPrefix\|Nothing}}
	{{APIComment\|...}}		{{APIComment\|...}}


	{{APIComment\|'Import the XML ~~byte array~~ into ~~the first available~~ XFRACAS entity.}}		{{APIComment\|'Import the XML string into XFRACAS entity ID# 1.}}
	~~{{APIComment\|'The following code assumes that the XML string type describes XFRACAS incidents.}}~~		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	{{APIPrefix\|Dim}}ImportXMLSystemID{{APIPrefix\|As Integer}}		ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLString(1, XFRACASImportType.Incident, xmlString, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})
	ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLString(1, XFRACASImportType.Incident, xmlString, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})
			{{APIComment\|'Process the imported file.}}
			MyRepository.XFRACAS.ProcessXfracasImports()

Kate Racaza at 16:29, 25 August 2015

2015-08-25T16:29:16Z

← Older revision		Revision as of 16:29, 25 August 2015
Line 10:		Line 10:
	''entityID''		''entityID''

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

	''importType''		''importType''

	:The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration\|XFRACASImportType]] constant. ~~(Required)~~		:Required. The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration\|XFRACASImportType]] constant.

	''xmlString''		''xmlString''

	:String. The string consisting of the XML to import.		:Required. String. The string consisting of the XML to import.

	''fileTitle''		''fileTitle''

	:String. The file title of the XML file byte array to import.		:Required. String. The file title of the XML file byte array to import.

	''fileDescription''		''fileDescription''

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

← Older revision		Revision as of 16:44, 10 March 2016
Line 33:		Line 33:

	== Example ==		== Example ==
	~~This example assumes that the enterprise repository has connections to existing XFRACAS entities.~~

	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'~~Add code~~ to ~~connect to an~~ Synthesis enterprise repository.}}		{{APIComment\|'Connect to a Synthesis enterprise repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|~~...~~}}		MyRepository.ConnectToSQLRepository({{APIString\|"MyServer"}}, {{APIString\|"MyDatabase"}})

	{{APIComment\|'Define an XML string and populate it with the XML text.}}		{{APIComment\|'Define an XML string and populate it with the XML text.}}
	{{APIPrefix\|Dim}} xmlString {{APIPrefix\|As String}} = {{APIPrefix\|Nothing}}		{{APIPrefix\|Dim}} xmlString {{APIPrefix\|As String}} = {{APIPrefix\|Nothing}}