CMS XML specification - Revision history

Russ horton: /* Transforms */

2020-11-23T14:25:37Z

Transforms

← Older revision		Revision as of 14:25, 23 November 2020
Line 14:		Line 14:
	Transforms like this are currently done with our eCommerce integrations: CommerveV3, Magento, and Volusion, for example. When importing a file from one of those sources, the [http://wiki.newhavensoftware.com/index.php/ECMS_Module#Generic_File_Based CMS plug-in] for that store calls a .dll to transform the file on the fly into our spec and then the file is imported. This process is transparent to the user. Something similar is possible using a .xslt transform in conjunction with our generic plug-in.		Transforms like this are currently done with our eCommerce integrations: CommerveV3, Magento, and Volusion, for example. When importing a file from one of those sources, the [http://wiki.newhavensoftware.com/index.php/ECMS_Module#Generic_File_Based CMS plug-in] for that store calls a .dll to transform the file on the fly into our spec and then the file is imported. This process is transparent to the user. Something similar is possible using a .xslt transform in conjunction with our generic plug-in.

	Another solution is to use a tool called [http://www.altova.com/mapforce.html MapForce] that can be purchased (not from us) and used by our clients if they wish to write/execute their own transforms. This includes converting not only from other XML formats but also from ASCII, spreadsheets, etc~~. NewHaven Software can also offer Mapforce setup and mapping services as a professional service~~.		Another solution is to use a tool called [http://www.altova.com/mapforce.html MapForce] that can be purchased (not from us) and used by our clients if they wish to write/execute their own transforms. This includes converting not only from other XML formats but also from ASCII, spreadsheets, etc.

	Your first choice, however, should be to work with the company providing your data and establish if they can do the transform on their side.		Your first choice, however, should be to work with the company providing your data and establish if they can do the transform on their side.

Russ horton: /* Credit Card Processing */

2019-11-25T20:00:11Z

Credit Card Processing

← Older revision		Revision as of 20:00, 25 November 2019
Line 114:		Line 114:

	==Credit Card Processing==		==Credit Card Processing==
	Our XML supports importing unapproved, approved or even captured credit cards. We strongly discourage capturing credit cards outside of CMS however ~~(approving is OK)~~. On import CMS can adjust the payment amount to match the new amount of the order if the order total needs to be adjusted down due to items on backorder, for example. It can also account for small variations in tax amounts (as can happen if your site cannot calc tax the same way CMS can.)		Our XML supports importing unapproved, approved or even captured credit cards. We strongly discourage capturing credit cards outside of CMS, however. On import, CMS can adjust the payment amount to match the new amount of the order if the order total needs to be adjusted down due to items on backorder, for example. It can also account for small variations in tax amounts (as can happen if your site cannot calc tax the same way CMS can.)

	If you'll be authorizing on your site and capturing in CMS (recommended) you'll need to use the same payment gateway and merchant account on both sides. You'll also need to pass additional data fields like a transaction_id to ensure CMS is able to capture the payment. Contact us for more details specific to your processor (Authorize.net, MPS/Vantiv, TransFirst).		If you'll be authorizing on your site and capturing in CMS (recommended) you'll need to use the same payment gateway and merchant account on both sides. You'll also need to pass additional data fields like a transaction_id to ensure CMS is able to capture the payment. Contact us for more details specific to your processor (Authorize.net, MPS/Vantiv, TransFirst).

Russ horton: /* Tech Tips */

2018-12-17T18:27:36Z

Tech Tips

← Older revision		Revision as of 18:27, 17 December 2018
Line 53:		Line 53:
	*Inventory for imported orders is allocated at the time of validating.		*Inventory for imported orders is allocated at the time of validating.
	*CMS order numbers are assigned to imported orders at the time of saving the validated order, not when imported. CMS will retain the order number generated by your site (or source of the order) in a field called Reference Order ID which can be searched on, printed, exported with orders, or even passed through some shipping integrations to appear on shipping labels.		*CMS order numbers are assigned to imported orders at the time of saving the validated order, not when imported. CMS will retain the order number generated by your site (or source of the order) in a field called Reference Order ID which can be searched on, printed, exported with orders, or even passed through some shipping integrations to appear on shipping labels.
	*Catalog requests do not require nor can they be ~~validated~~. They are automatically processed.		*Catalog requests do not require nor can they be manually verified. They are automatically processed.
	*Catalog requests and orders both require unique identification numbers (ID and Reforderid respectively)		*Catalog requests and orders both require unique identification numbers (ID and Reforderid respectively)

Russ horton: /* Encryption */

2017-01-13T18:17:53Z

Encryption

← Older revision		Revision as of 18:17, 13 January 2017
Line 107:		Line 107:

	==Encryption==		==Encryption==
	CMS does not currently support a method of field or file level encryption with XML. You may consider using PGP as a solution for encryption and then decrypt just before importing into CMS~~. We expect to add support for encryption options in the future~~.		CMS does not currently support a method of field or file level encryption with XML. You may consider using PGP as a solution for encryption and then decrypt just before importing into CMS.

	When using our [http://wiki.newhavensoftware.com/index.php/ECMS_Module eCMS Module] to connect to your web site's web service or an FTP location, CMS can enforce the use of secure connections (TLS) for orders that contain credit card data. This method ensures that a file with unencrypted card data never resides on your machine/network. The order data goes straight into the database and is encrypted before it is written to the table.		When using our [http://wiki.newhavensoftware.com/index.php/ECMS_Module eCMS Module] to connect to your web site's web service or an FTP location, CMS can enforce the use of secure connections (TLS) for orders that contain credit card data. This method ensures that a file with unencrypted card data never resides on your machine/network. The order data goes straight into the database (never saved as a file) and is encrypted before it is written to the table.

			CMS is a PA-DSS validated application (2010 - present, v7 - 10.x) and you can rest assured that the credit card data will be managed in a PCI compliant manner once imported into CMS.

	==Credit Card Processing==		==Credit Card Processing==

Russ horton: /* Credit Card Processing */

2017-01-13T18:13:58Z

Credit Card Processing

← Older revision		Revision as of 18:13, 13 January 2017
Line 112:		Line 112:

	==Credit Card Processing==		==Credit Card Processing==
	Our XML supports importing unapproved, approved or even captured credit cards. We strongly discourage capturing credit cards outside of CMS however. CMS can adjust the payment amount to match the new amount of the order if the order total needs to be adjusted down due to items on ~~back order~~, for example. If you'll be ~~authoring~~ on your site and capturing in CMS (recommended) you'll need to use the same payment gateway and merchant account on both ~~side~~. You'll also need to pass additional data fields like a transaction_id to ensure CMS is able to capture the payment. Contact us for more details.		Our XML supports importing unapproved, approved or even captured credit cards. We strongly discourage capturing credit cards outside of CMS however (approving is OK). On import CMS can adjust the payment amount to match the new amount of the order if the order total needs to be adjusted down due to items on backorder, for example. It can also account for small variations in tax amounts (as can happen if your site cannot calc tax the same way CMS can.)

			If you'll be authorizing on your site and capturing in CMS (recommended) you'll need to use the same payment gateway and merchant account on both sides. You'll also need to pass additional data fields like a transaction_id to ensure CMS is able to capture the payment. Contact us for more details specific to your processor (Authorize.net, MPS/Vantiv, TransFirst).

	Also, make sure your expiration dates are in the proper format of YYYY-MM. Improper formatting of the expiration date is probably the most common error we see.		Also, make sure your expiration dates are in the proper format of YYYY-MM. Improper formatting of the expiration date is probably the most common error we see.

Russ horton: /* Data Provider */

2017-01-13T18:08:44Z

Data Provider

← Older revision		Revision as of 18:08, 13 January 2017
Line 119:		Line 119:
	===Data Provider===		===Data Provider===
	#We can provide a sample xml file with orders that reflect a number of common product and order scenarios. You should discuss specific needs with the client to see which scenarios you should prepare for (e.g. multiple recipient orders, catalog requests, future shipping orders, credit card payments, etc.)		#We can provide a sample xml file with orders that reflect a number of common product and order scenarios. You should discuss specific needs with the client to see which scenarios you should prepare for (e.g. multiple recipient orders, catalog requests, future shipping orders, credit card payments, etc.)
	#As stated above, please ensure your XML validates against the provided XSD. CMS is tolerant of nodes and elements in the wrong ~~order~~, which would normally raise errors when validating, but best to get those right just the same.		#As stated above, please ensure your XML validates against the provided XSD. CMS is tolerant of nodes and elements in the wrong sequence, which would normally raise errors when validating, but best to get those right just the same.

	===Client===		===Client===

Russ horton: /* Testing */

2017-01-13T18:08:14Z

Testing

← Older revision		Revision as of 18:08, 13 January 2017
Line 117:		Line 117:

	==Testing==		==Testing==
	We can assist ~~the end user~~ with setting up a test database to facilitate testing of imports before ~~it is~~ used in production. When testing, you should both be testing for the success of the import ~~and checking to make sure~~ all data ~~required~~ is being ~~passed. Please ensure that your XML will validate properly before engaging~~ the ~~merchant for testing (see above).~~		===Data Provider===
			#We can provide a sample xml file with orders that reflect a number of common product and order scenarios. You should discuss specific needs with the client to see which scenarios you should prepare for (e.g. multiple recipient orders, catalog requests, future shipping orders, credit card payments, etc.)
			#As stated above, please ensure your XML validates against the provided XSD. CMS is tolerant of nodes and elements in the wrong order, which would normally raise errors when validating, but best to get those right just the same.

			===Client===
			We can assist you with setting up a test database to facilitate testing of imports before they are used in production. When testing, you should both be testing for:
			*the success of the import (no errors)
			*ensure all required data is being received in the right places


	[[Category:Published]]		[[Category:Published]]

Russ horton: /* Encryption */

2017-01-13T17:43:28Z

Encryption

← Older revision		Revision as of 17:43, 13 January 2017
Line 109:		Line 109:
	CMS does not currently support a method of field or file level encryption with XML. You may consider using PGP as a solution for encryption and then decrypt just before importing into CMS. We expect to add support for encryption options in the future.		CMS does not currently support a method of field or file level encryption with XML. You may consider using PGP as a solution for encryption and then decrypt just before importing into CMS. We expect to add support for encryption options in the future.

	When using our [http://wiki.newhavensoftware.com/index.php/ECMS_Module eCMS Module] to connect to your web site's web service or an FTP location, CMS can enforce the use of secure connections for orders that contain credit card data. This method ensures that a file with unencrypted card data never resides on your machine/network. The order data goes straight into the database and is encrypted before it is written to the table.		When using our [http://wiki.newhavensoftware.com/index.php/ECMS_Module eCMS Module] to connect to your web site's web service or an FTP location, CMS can enforce the use of secure connections (TLS) for orders that contain credit card data. This method ensures that a file with unencrypted card data never resides on your machine/network. The order data goes straight into the database and is encrypted before it is written to the table.

	==Credit Card Processing==		==Credit Card Processing==

Russ horton: /* Validating Your XML */

2017-01-13T17:41:47Z

Validating Your XML

← Older revision		Revision as of 17:41, 13 January 2017
Line 39:		Line 39:

	==Validating Your XML==		==Validating Your XML==
	Before submitting your XML for testing, please validate it against our ~~provided~~ CMSXML.xsd. If you do not have your own tool for doing so, there are [http://www.xmlvalidation.com/index.php free online tools] available that allow you to load your file and our XSD to show you where there are problems with the structure of the file.		Before submitting your XML for testing, please validate it against our CMSXML.xsd (provided on request with NDA). If you do not have your own tool for doing so, there are [http://www.xmlvalidation.com/index.php free online tools] available that allow you to load your file and our XSD to show you where there are problems with the structure of the file.

	=Merchant Data Requirements=		=Merchant Data Requirements=

Russ horton: /* Transforms */

2017-01-13T17:34:42Z

Transforms

← Older revision		Revision as of 17:34, 13 January 2017
Line 10:		Line 10:

	==Transforms==		==Transforms==
	It is unlikely CMS will support other ~~XML~~ specifications in the future. Instead, whenever we need to import from a source that cannot provide XML in our format, we would instead put that data through a transform process to convert it from their native format into CMS's expected format.		It is unlikely CMS will support other specifications/formats in the future. Instead, whenever we need to import from a source that cannot provide XML in our format, we would instead put that data through a transform process to convert it from their native format into CMS's expected XML format.

	~~Currently~~ this ~~process is~~ done with our ~~support for~~ CommerveV3 and ~~Magento~~, for example. When importing a file from one of those sources, the [http://wiki.newhavensoftware.com/index.php/ECMS_Module#Generic_File_Based CMS plug-in] for that store calls a .dll to transform the file on the fly into our spec and then the file is imported. This process is transparent to the user. Something similar is possible using a .xslt transform in conjunction with our generic plug-in.		Transforms like this are currently done with our eCommerce integrations: CommerveV3, Magento, and Volusion, for example. When importing a file from one of those sources, the [http://wiki.newhavensoftware.com/index.php/ECMS_Module#Generic_File_Based CMS plug-in] for that store calls a .dll to transform the file on the fly into our spec and then the file is imported. This process is transparent to the user. Something similar is possible using a .xslt transform in conjunction with our generic plug-in.

	Another solution is to use a tool called [http://www.altova.com/mapforce.html MapForce] that can be purchased (not from us) and used by our ~~customers~~ if they wish to write/execute their own transforms. This includes converting not only from other XML formats but also from ASCII, spreadsheets, etc. NewHaven Software can also offer Mapforce setup and mapping services as a professional service.		Another solution is to use a tool called [http://www.altova.com/mapforce.html MapForce] that can be purchased (not from us) and used by our clients if they wish to write/execute their own transforms. This includes converting not only from other XML formats but also from ASCII, spreadsheets, etc. NewHaven Software can also offer Mapforce setup and mapping services as a professional service.

			Your first choice, however, should be to work with the company providing your data and establish if they can do the transform on their side.

	=XML Standards=		=XML Standards=