Kofax XML format

To populate Kofax Capture fields with document or folder fields of an XML file, Kofax Capture must have the correct document or folder type. Once the target document type is identified, Kofax Capture can acquire the list of the fields defined in the document or folder type and populate their values. The following table specifies how the XML field values are mapped to Kofax Capture fields.

XML	Kofax Capture
Batch	Batch name The availability of batch class name field in the XML overrides the setting in the Connection configuration. If the batch class name is not specified in the Kofax XML, then the destination configured for the connection is used.
BatchClassName	The name of the batch class to create the batch. This is a mandatory field.
BatchField	Batch fields
Document	Capture document
ExpectedBatchTotal	Batch totals
Folder	Capture folder
FolderClassName	Folder type
FormTypeName	Document separation and form identification Kofax XML provides the document separation and form identification in the document’s FormTypeName attribute. Example: FormTypeName="FormType". The selection of form type is determined by the batch class. If the form type is not specified in the Kofax XML, then the document type is selected from the batch class.
ImportFileName	Specify the name/path of the page to import into Kofax Capture.
IndexField	The index fields are meta data fields in documents or folders of a batch class. These are key value pairs and their value is either static or populated at run time.
Page	Page specifies the file to import into Kofax Capture.
RelativeImageFilePath	Path to import external files referenced in XML. The files specified in Page elements are imported from the path. One of the following scenarios are used identify the complete path: If this field contains full path, the files from this path are imported. If this field is blank, the location of the XML file is used for importing the files. If this field contains a relative path, the location of the XML file is used as the base path.
Table	Table fields
TableRow	Document table columns

All exceptional conditions are controlled as specified below:

An XML with empty form/document type is imported as an unclassified document.
An XML with invalid form/document type can be imported as unclassified or can be rejected.
If the Document or Folder fields are not defined in Kofax Capture, the XML file can be imported or rejected.
If there is a mismatch in the Document or Folder field type, the XML file can be imported or rejected.
If the Folder type is not available in the XML file, the XML file can be imported as unclassified or rejected.
If a file referenced in the XML file to be imported is not available at the specified path in the XML file, the XML file is rejected.
All files which are not referenced in the XML file for folder/document level processing are imported as unclassified documents.

<?xml version="1.0" encoding="UTF-8"?>
<ImportSession xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<Batches>
		<Batch BatchClassName="KfxSampleXmlMappingBatch" RelativeImageFilePath="C:\temp\">
			<BatchFields>
				<BatchField Value="42367" Name="PONumber"/>
			</BatchFields>
			<Documents>
				<Document FormTypeName="KfxSampleXmlMappingForm">
					<IndexFields>
						<IndexField Value="32.95" Name="Subtotal"/>
						<IndexField Value="2.55" Name="SalesTax"/>
						<IndexField Value="5.00" Name="Shipping"/>
						<IndexField Value="40.50" Name="Total"/>
					</IndexFields>
					<Tables>
						<Table Name="Articles">
							<TableRows>
								<TableRow>
									<IndexFields>
										<IndexField Value="1" Name="Quantity"/>
										<IndexField Value="638" Name="ItemNr"/>
										<IndexField Value="LANG STERLING PIE SERVER" Name="Description"/>
										<IndexField Value="32.95" Name="UnitPrice"/>
										<IndexField Value="32.95" Name="Amount"/>
									</IndexFields>
								</TableRow>
							</TableRows>
						</Table>
						<Table Name="ShipTo">
							<TableRows>
								<TableRow>
									<IndexFields>
										<IndexField Value="Martin" Name="FirstName"/>
										<IndexField Value="Janeway" Name="LastName"/>
									</IndexFields>
								</TableRow>
							</TableRows>
						</Table>
					</Tables>
					<Pages>
						<Page ImportFileName="page002.tif"/>
                        <Page ImportFileName="C:\page002.tif"/>
					</Pages>
				</Document>
			</Documents>
            <Pages>
                <Page ImportFileName="subfolder\page002.tif"/>
                <Page ImportFileName="subfolder\page003.tif"/>
            </Pages>
		</Batch>
	</Batches>
</ImportSession>

<?xml version="1.0" encoding="UTF-8"?>
<ImportSession xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <Batches>
		<Batch BatchClassName="CaptureEnabled_Folder">
			<BatchFields>
				<BatchField Name="From" Value="42367"/>
			</BatchFields>
			<Folders>
				<Folder FolderClassName="Root Folder">
					<IndexFields>
						<IndexField Name="Name1" Value="Sasha"/>	
					</IndexFields>	
				<Documents>
				  <Document FormTypeName="KfxSampleXmlMappingForm">
					<IndexFields>
						<IndexField Name="Subtotal" Value="32"/>
					</IndexFields>
            <Tables>
              <Table Name="Articles">
                <TableRows>
                  <TableRow>
                    <IndexFields>
                      <IndexField Name="Quantity" Value="1"/>
                      <IndexField Name="ItemNr" Value="638"/>
                      <IndexField Name="Description" Value="LANG STERLING PIE SERVER"/>
                      <IndexField Name="UnitPrice" Value="32.95"/>
                      <IndexField Name="Amount" Value="32.95"/>
                    </IndexFields>
                  </TableRow>
                </TableRows>
              </Table>
              <Table Name="ShipTo">
                <TableRows>
                  <TableRow>
                    <IndexFields>
                      <IndexField Name="FirstName" Value="Martin"/>
                      <IndexField Name="LastName" Value="Janeway"/>
                    </IndexFields>
                  </TableRow>
                  <TableRow>
                    <IndexFields>
                      <IndexField Name="FirstName" Value="Loose"/>
                      <IndexField Name="LastName" Value="Way"/>
                    </IndexFields>
                  </TableRow>
                </TableRows>
              </Table>
            </Tables>
					<Pages>
						<Page ImportFileName="DriversLicense2.tif"/>
						<Page ImportFileName="DriversLicense22.tif"/>
					</Pages>
				</Document>
          <Document FormTypeName="FormType">            
            <Pages>
              <Page ImportFileName="DriversLicense2.tif"/>
              <Page ImportFileName="DriversLicense22.tif"/>
            </Pages>
          </Document>
			</Documents>
        </Folder>
      </Folders>
		</Batch>
	</Batches>
</ImportSession>

Kofax XML format

Search results

Search tips