Repository.XFRACAS.ImportXFRACASXML - Revision history

Kate Racaza at 17:00, 12 August 2016

2016-08-12T17:00:26Z

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

	<onlyinclude>Uploads the XML byte array to the XFRACAS import queue. Returns an '''Integer''' that represents the record ID of the byte array.</onlyinclude>		<onlyinclude>Uploads the XML byte array to the XFRACAS import queue. Returns an '''Integer''' that represents the record ID of the byte array.</onlyinclude>


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

Kate Racaza at 16:42, 10 March 2016

2016-03-10T16:42:08Z

← Older revision		Revision as of 16:42, 10 March 2016
Line 34:		Line 34:

	== 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 the~~ 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 a serializable XML object, and then populate it with values to import.}}		{{APIComment\|'Define a serializable XML object, and then populate it with values to import.}}

Kate Racaza at 22:33, 13 November 2015

2015-11-13T22:33:16Z

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

Kate Racaza at 18:46, 9 November 2015

2015-11-09T18:46:26Z

← Older revision		Revision as of 18:46, 9 November 2015
Line 2:		Line 2:


	<onlyinclude>~~Imports an~~ XML byte array ~~into~~ XFRACAS's import queue. Returns an '''Integer''' that represents the record ID of the byte array.</onlyinclude>		<onlyinclude>Uploads the XML byte array to the XFRACAS import queue. Returns an '''Integer''' that represents the record ID of the byte array.</onlyinclude>

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

Kate Racaza at 18:43, 9 November 2015

2015-11-09T18:43:16Z

← Older revision		Revision as of 18:43, 9 November 2015
Line 2:		Line 2:


	<onlyinclude>Imports an XML byte array into ~~a desired~~ XFRACAS ~~entity~~. Returns an '''Integer''' that represents the ~~system~~ ID of the byte array.</onlyinclude>		<onlyinclude>Imports an XML byte array into XFRACAS's import queue. Returns an '''Integer''' that represents the record ID of the byte array.</onlyinclude>

	~~You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must be in 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 55:		Line 53:
	{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})		ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

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

Kate Racaza at 15:14, 5 November 2015

2015-11-05T15:14:06Z

← Older revision		Revision as of 15:14, 5 November 2015
Line 36:		Line 36:

	== 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 the Synthesis repository.}}		{{APIComment\|'Add code to connect to the Synthesis enterprise repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIComment\|...}}		{{APIComment\|...}}

Kate Racaza at 19:57, 28 October 2015

2015-10-28T19:57:56Z

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

Kate Racaza at 18:26, 27 October 2015

2015-10-27T18:26:47Z

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


Line 10:		Line 10:
	== Syntax ==		== Syntax ==

	'''.XFRACAS.~~ImportXFRACASXML~~'''(''entityID'', ''importType'', ''byteData'', ''fileTitle'', ''fileDescription'')		'''.XFRACAS.ImportXfracasXml'''(''entityID'', ''importType'', ''byteData'', ''fileTitle'', ''fileDescription'')

	===Parameters===		===Parameters===
Line 54:		Line 54:
	{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}		{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}
	{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	ImportXMLSystemID = MyRepository.XFRACAS.~~ImportXFRACASXML~~(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})		ImportXMLSystemID = MyRepository.XFRACAS.ImportXfracasXml(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

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

Kate Racaza at 23:47, 26 October 2015

2015-10-26T23:47:15Z

← Older revision		Revision as of 23:47, 26 October 2015
Line 4:		Line 4:
	<onlyinclude>Imports an XML byte array into a desired XFRACAS entity. Returns an '''Integer''' that represents the system ID of the byte array.</onlyinclude>		<onlyinclude>Imports an XML byte array into a desired XFRACAS entity. Returns an '''Integer''' that represents the system ID of the byte array.</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.		You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must be in 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 34:		Line 36:

	== Example ==		== Example ==
			This example assumes that the 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 the Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIComment\|...}}		{{APIComment\|...}}

	~~{{APIComment\|'Get a list of XFRACAS entities in the current project in the connected repository.}}~~
	~~{{APIPrefix\|Dim}} ListOfXFRACASEntities() {{APIPrefix\|As}} NameIdPair~~
	~~ListOfXFRACASEntities = MyRepository.XFRACAS.GetAllXFRACASEntities()~~

	~~{{APIComment\|'Search the entities list for the desired entity name, to find the Entity ID}}~~
	~~{{APIPrefix\|Dim}} DesiredEntityID {{APIPrefix\|As Integer}}~~
	~~For Each Entity {{APIPrefix\|As}} NameIdPair In ListOfXFRACASEntities()~~
	~~If Entity.Name = {{APIString\|"DesiredEntityName"}}~~
	~~DesiredEntityID = Entity.ID~~
	~~Exit For~~
	~~End If~~
	~~Next~~

	{{APIComment\|'Define a serializable XML object, and then populate it with values to import.}}		{{APIComment\|'Define a serializable XML object, and then populate it with values to import.}}
	{{APIPrefix\|Dim}} xmlObject {{APIPrefix\|As Object}} = {{APIPrefix\|Nothing}}		{{APIPrefix\|Dim}} xmlObject {{APIPrefix\|As Object}} = {{APIPrefix\|Nothing}}
	{{APIComment\|...}}		{{APIComment\|...}}

			{{APIComment\|'Define the byte array, and then serialize the object to the byte array.}}
			{{APIPrefix\|Dim}} byteArray {{APIPrefix\|As}} Byte() = {{APIPrefix\|Nothing}}
			MyRepository.XFRACAS.SerializeXMLObjectToByteArray(byteArray, xmlObject)

	{{APIComment\|'~~Define the byte array, and then serialize the object to~~ the byte array.}}		{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}
	{{APIPrefix\|Dim}} ~~byteArray~~ {{APIPrefix\|As}} ~~Byte()~~ = ~~{{APIPrefix\|Nothing}}~~		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	MyRepository.XFRACAS.~~SerializeXMLObjectToByteArray~~(byteArray, ~~xmlObject~~)		ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXML(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

	{{APIComment\|'~~Import~~ the ~~XML byte array into the desired XFRACAS entity. In this example, we assume that the XML object type describes an Incident~~.}}		{{APIComment\|'Process the imported file.}}
	~~{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}~~		MyRepository.XFRACAS.ProcessXfracasImports()
	~~ImportXMLSystemID =~~ MyRepository.XFRACAS.~~[[Repository.ImportXFRACASXML\|ImportXFRACASXML]]~~(~~DesiredEntityID, [[XFRACASImportType]].Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}}~~)

Kate Racaza at 16:26, 25 August 2015

2015-08-25T16:26:46Z

← Older revision		Revision as of 16:26, 25 August 2015
Line 14:		Line 14:
	''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.

	''byteData''		''byteData''

	:Byte(). The byte array of the XML to import. ~~(Required)~~		:Required. Byte. The byte array of the XML to import.

	''fileTitle''		''fileTitle''

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

	''fileDescription''		''fileDescription''

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

← Older revision		Revision as of 23:47, 26 October 2015
Line 4:		Line 4:
	<onlyinclude>Imports an XML byte array into a desired XFRACAS entity. Returns an '''Integer''' that represents the system ID of the byte array.</onlyinclude>		<onlyinclude>Imports an XML byte array into a desired XFRACAS entity. Returns an '''Integer''' that represents the system ID of the byte array.</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.		You must have admin privileges in the XFRACAS entity in order to import data into it. In addition, the XML file must be in 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 34:		Line 36:

	== Example ==		== Example ==
			This example assumes that the 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 the Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIComment\|...}}		{{APIComment\|...}}

	~~{{APIComment\|'Get a list of XFRACAS entities in the current project in the connected repository.}}~~
	~~{{APIPrefix\|Dim}} ListOfXFRACASEntities() {{APIPrefix\|As}} NameIdPair~~
	~~ListOfXFRACASEntities = MyRepository.XFRACAS.GetAllXFRACASEntities()~~

	~~{{APIComment\|'Search the entities list for the desired entity name, to find the Entity ID}}~~
	~~{{APIPrefix\|Dim}} DesiredEntityID {{APIPrefix\|As Integer}}~~
	~~For Each Entity {{APIPrefix\|As}} NameIdPair In ListOfXFRACASEntities()~~
	~~If Entity.Name = {{APIString\|"DesiredEntityName"}}~~
	~~DesiredEntityID = Entity.ID~~
	~~Exit For~~
	~~End If~~
	~~Next~~

	{{APIComment\|'Define a serializable XML object, and then populate it with values to import.}}		{{APIComment\|'Define a serializable XML object, and then populate it with values to import.}}
	{{APIPrefix\|Dim}} xmlObject {{APIPrefix\|As Object}} = {{APIPrefix\|Nothing}}		{{APIPrefix\|Dim}} xmlObject {{APIPrefix\|As Object}} = {{APIPrefix\|Nothing}}
	{{APIComment\|...}}		{{APIComment\|...}}

			{{APIComment\|'Define the byte array, and then serialize the object to the byte array.}}
			{{APIPrefix\|Dim}} byteArray {{APIPrefix\|As}} Byte() = {{APIPrefix\|Nothing}}
			MyRepository.XFRACAS.SerializeXMLObjectToByteArray(byteArray, xmlObject)

	{{APIComment\|'~~Define the byte array, and then serialize the object to~~ the byte array.}}		{{APIComment\|'Import the XML byte array into XFRACAS entity ID# 10.}}
	{{APIPrefix\|Dim}} ~~byteArray~~ {{APIPrefix\|As}} ~~Byte()~~ = ~~{{APIPrefix\|Nothing}}~~		{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}
	MyRepository.XFRACAS.~~SerializeXMLObjectToByteArray~~(byteArray, ~~xmlObject~~)		ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXML(10, XFRACASImportType.Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}})

	{{APIComment\|'~~Import~~ the ~~XML byte array into the desired XFRACAS entity. In this example, we assume that the XML object type describes an Incident~~.}}		{{APIComment\|'Process the imported file.}}
	~~{{APIPrefix\|Dim}} ImportXMLSystemID {{APIPrefix\|As Integer}}~~		MyRepository.XFRACAS.ProcessXfracasImports()
	~~ImportXMLSystemID =~~ MyRepository.XFRACAS.~~[[Repository.ImportXFRACASXML\|ImportXFRACASXML]]~~(~~DesiredEntityID, [[XFRACASImportType]].Incident, byteArray, {{APIString\|"XMLFileTitle"}}, {{APIString\|"XMLFileDescription"}}~~)