XML mapping

This topic describes the use of sample files installed along with KC Plug-In to clarify the use of XML mapping. You can find the sample files in the Samples\DemoMapping directory of the installation ISO.

Consider the traditional Kofax order example of a "Northwest Products" company. This company has been receiving order forms from their customers per fax for years. Now, however, they decided to save costs and intend to allow their customers to send structured XML order data instead of faxes.

Prerequisite: You can write the XSL transformation file manually or can generate it using any XML mapping visual tool, such as, Altova MapForce. Still, XSLT expertise is required to perform XML mapping.

In this chapter, we provide examples how to achieve this goal by the means of simple and generic XML mapping. For the sake of simplicity, we chose only a subset of order data.


sample order form

Each incoming order should create a new Kofax Capture batch of class KfxSampleXmlmappingBatch with one document with form type KfxSampleXmlMappingForm where:

  • Received XML data structure is always imported.

  • Optionally, TIF images sent along with the structured XML data should be also imported.

The selected order data are to be mapped to the batch fields / index fields in the following way.

Input data fields

Map to

Batch fields

Document tables

Document index fields

Purchase Order No.

PONumber

Ship To First Name

ShipTo

FirstName

Ship To Last Name

LastName

Quantity

Articles

Quantity

Item #

ItemNr

Description

Description

Unit Price

UnitPrice

Amount

Amount

Subtotal

Subtotal

Sales Tax

SalesTax

Shipping

Shipping

Total

Total

You can look at the KfxSampleXmlMappingBatch (also included in the samples folder) to see how these fields are defined in a batch class.

This is the desired outcome.


desired result of xml mapping

The following procedures provide an overview of configuration tasks needed to set up the mapping. Refer to configuration section of KC Plug-In Help for a more detailed description of configuration steps.