› Integration › Import settings › Example: Import XML files

Example: Import XML files

This example illustrates how to configure the XML import for standard Kofax XML format files. Once configured, you can place these files in a folder and import data in TotalAgility.

Use the example XML file that has a referenced multi-page TIFF file, map the XML file fields to the TotalAgility fields and allow the files to be imported even if there is a mismatch in the configured TotalAgility fields with the XML files fields.

Example XML file 

<ImportSession>
    <Batches>
        <Batch BatchClassName="Institutional" Processed="0">
            <BatchFields>
                <BatchField Name="InputSource" Value="XmlImport"/> 
            </BatchFields>
            <Folders>
                <Folder FolderClassName="Institutional_Folder">  
                    <Folders>
                        <Folder FolderClassName="Inst_WorkItem"> 
                        <IndexFields>
                            <IndexField Name="AccountNumbers" Value="888888777"/>
                            <IndexField Name="AdvisorCodes" Value="333"/>
                            <IndexField Name="AdvisorTier" Value="gth"/>
                            <IndexField Name="EntityName" Value="HYJUI"/>
                            <IndexField Name="FirmName" Value="TDA"/>
                            <IndexField Name="FirstName" Value="Joseph"/>
                            <IndexField Name="LastName" Value="Test"/>
                            <IndexField Name="TIN" Value="1122112212"/>
                            <IndexField Name="ServiceTeam" Value="Global"/>
                            </IndexFields>
                            <Documents>                    
                                <Document FormTypeName="Institutional_CG|Institutional_DT">
                                    <IndexFields>
                                        <IndexField Name="FormName" Value="IRA Application2"/>
                                        <IndexField Name="FormNumber" Value="Tran_2_Env_Page_1.tif"/>
                                        <IndexField Name="WorkSubType" Value="wst"/>
                                        <IndexField Name="WorkType" Value="wt1"/>
                                        <IndexField Name="Amount" Value="55"/>
                                    </IndexFields>
                                    <Pages>
                                        <Page ImportFileName="Tran_2_Env_Page_1.tif"/>
                                    </Pages>
                                </Document>
                            </Documents>
                        </Folder>
                    </Folders>
                </Folder>
            </Folders>
        </Batch>
    </Batches>
</ImportSession>

Following is the description of various XML tags which are used in the above XML. You can copy the example Kofax XML format file in a text editor and save it in the XML format. 

<Batch BatchClassName="Institutional">

If the batch class name is available in the XML, it overrides the setting in the import configuration. If the batch class name is not specified in Kofax XML, then the process configured in the import source is used to identify the batch class name.

Optionally, you can create a process with the same name as the BatchClassName name. 

<BatchField Name="InputSource" Value="XmlImport"/>
These are process initialization variables in TotalAgility. 
<Folder FolderClassName="Institutional_Folder">
 This is the process's folder initialization variable. 
<Folder FolderClassName="Institutional_Folder"> 
<IndexFields> 
<IndexField Name="AccountNumbers" Value="888888777"/>
This is mapped to the Folder fields in TotalAgility. Folder name, subfolder name and folder fields are derived from this. 
<Pages> 
<Page ImportFileName="Tran_2_Env_Page_1.tif"/> 
</Pages>
Each page tag can be either converted into to a page or document. 
<Documents>
 <Document FormTypeName="Institutional_CG|Institutional_DT">
 <IndexFields>
 <IndexField Name="FormName" Value="IRA Application2"/>
This is mapped to the extraction group, document types, document fields and classification groups. Document type names, document field names and classification group names are derived from this.

In TotalAgility Designer, perform the following steps to configure TotalAgility for importing the XML file:

  1. Configuration in Capture: Configure the required capture-related items.

  2. Configuration in Import settings: Create an import source.