Map Properties to XML Data

Open a sample XML file containing indexing information. You will use the content of this XML to map values contained in the XML to DocLink Document Types, Top-level Folders and Properties:

  1. From the Administration tab, click on the Import Manager tile.  The Import Manager Configuration window opens.
  2. Select Custom XML from the list on the left.
  3. Open existing input sources or select Add. The Properties window allows the Administrator to map values found in the XML file to DocLink properties.

General

On the General Tab enter the following information:

Input Source

  1. Name – The uniquely identifying name of the image queue.
  2. Description – A brief explanation of the purpose of the queue. If there are items of note you will see references to these conditions displayed in this field.
  3. Active (checkbox) - Toggles the input source on/off.

Location

  1. Input Folder – The UNC path used to identify the drop location the DocLink Import Service will monitor for new xml files to process.
  2. Archive Folder – The UNC path to the location where an archive copy of the XML files will be stored. This folder will contain copies of the XML file, TIFFs and corresponding log.

    Tip: make the Archive folder a subfolder of the Input Folder.

  3. Server Instance - The name of the server where the Import Service used for this source is located. DocLink can support many instance of this service.

Service Parameters

  1. Source xml contains a document type definition (DTD) - Should be checked if a DTD is set to be followed along with the XML file being consumed.
  2. Ignore missing image files (multi-page TIFF only) – Will ignore additional subsequent pages if they do not accompany the XML and first page for import.
  3. Processing Delay (minutes) - enter the number of minutes to wait before processing files. This is especially useful if there are a large number of images in a batch. Delaying the processing will ensure all files are readily available for import into DocLink.
  4. In the Poll Rate field, enter the frequency (in seconds) the DocLink Import Service should check for new files to process.
  5. In the Retry Days field, enter the number of days the Import Service should try to process a file while using the currently selected poll rate interval.
  6. In the Archive Days field, enter the number of days-worth of documents you wish to retain in the Archive directory.

 

Transformation

DocLink Import Schema Transformation

  1. Stylesheet - Enter the path to the XSLT stylesheet that will be used to transform the original XML document into one that matches the DocLink XML schema prior to processing. This path must be a UNC path.
  2. Click the Test Transformation button to validate the sample XML document with the XSLT stylesheet.
    1. Enter the path to your sample XML file.
    2. The Transformation Test Dialog will display.
    3. This window show the contents of the original XML (upper right), XSL stylesheet (upper left) and a sampling of the new XML file after the style sheet is applied (bottom). If Errors or Warnings are present reconfigure your XSL style sheet, using an XML editor.

XML to Image Conversion

  1. The Template input box is used in conjunction with SQL® Server Reporting Services (SSRS). A report template, created with Microsoft® Report Builder, can be chosen from the ellipsis button. The template will merge with the XML data to produce a TIFF or PDF.

    If SSRS is configured, use the Launch Report Builder... button to create/manage reports.

    See the topic titled SSRS Settings in System > System Settings for additional information

  2. For Image Format, select the file type to be created in DocLink.

 

Property Mappings

From this screen the Administrator can add, edit or delete field mappings.

Each field mapping will contain the following information:

XML Property = field value in the XML file

Description = optional field

DocLink Property = property in DocLink mapped to this field value

  1. If you click the drop-down arrow next to XML Property field, you will see a list of all properties contained in the XML that you can map to DocLink properties (if you do not see a list, click the XML button on this drop-down to search for your sample. Highlight one property and click the Select button to populate the XML Property field.

    This drop-down only populates if there is a valid .xsl file entered on the Transformation tab, and a valid .xml sample for the .xsl file selected.

  2. Click the down-arrow next to the DocLink Property drop-down to see a complete list of DocLink master properties. Select one.
  3. Click the Add button again, and repeat steps above until all properties in your XML are mapped.
  4. Click the Remove button to delete a property mapping.

 

Document Type Mappings

This configuration window tab the Administrator to map transaction types to DocLink document types. From this screen the Administrator can add, edit or delete document type mappings.

Each document type mapping will contain the following information:

XML Document Type = document value in the XML file

Description = optional field, can be used to display the Element and Attribute

DocLink Document Type = document type in DocLink mapped to this field value

  1. If you click the drop-down arrow next to XML Document Type field, you will see a list of all document types contained in the XML that you can map to DocLink document types (if you do not see a list, click the XML button on this drop-down to search for your sample. Highlight one document type and click the Select button to populate the XML Document Type field.

    This drop-down only populates if there is a valid .xsl file entered on the Transformation tab, and a valid .xml sample for the .xsl file selected.

  2. Click the down-arrow next to the DocLink Document Type drop-down to see a complete list of DocLink document types. Select one.
  3. Click the Add button again, and repeat steps above until all document types in your XML are mapped.
  4. Click the Remove button to delete a mapping.

 

Company Mappings

This configuration tab allows the Administrator to map companies in the XML to DocLink top-level folders. From this window the Administrator can add, edit or delete company mappings.

Each company mapping will contain the following information:

XML Company = company value in the XML file

Description = optional field, can be used to display the Element and Attribute

DocLink Company = top-level folder in DocLink mapped to this field value

  1. If you click the drop-down arrow next to XML Company field, you will see a list of all items contained in the XML that you can map to DocLink companies (if you do not see a list, click the XML button on this drop-down to search for your sample. Highlight one company and click the Select button to populate the XML Company field.

    This drop-down only populates if there is a valid .xsl file entered on the Transformation tab, and a valid .xml sample for the .xsl file selected.

  2. Click the down-arrow next to the DocLink Company drop-down to see a complete list of DocLink companies. Select one.
  3. Click the Add button again, and repeat steps above until all companies in your XML are mapped.
  4. Click the Remove button to delete a mapping.

When all tabs have been configured, click OK to save the changes and exit the Input Source Properties window. Enabled XML configurations will display green on the Integration Configuration screen.

  • To activate an input source, right-click on it and select Activate from the context menu.
  • To deactivate an input source, right-click on it and select Deactivate from the context menu.

Close the Integration Configuration window.

 

Test Configuration

  1. Stop the Import Service.
  2. Copy some tiffs and sample XML to the source folder.
  3. Start the Import Service.
  4. If the files disappear from the source folder, the Import Service has processed the files successfully.
  5. Browse to the Archive directory and you should see your sample files.
  6. Browse to the Completed folder in the Administrator and confirm the documents were imported and indexed properly.