Field Order - XML Index Document Import Processor - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

XML Index Document Import Processor
Platform
OnBase
Product
XML Index Document Import Processor
Release
Foundation 23.1
License
Standard
Essential
Premier

To configure the field order for your XML Index DIP process using Absolute Paths, follow these steps:

  1. In the Configuration module, select Import | XML Index Document Import Processor . The XML Index Document Import Configuration window is displayed.
  2. Select a processing format.
  3. Click Field Order. The Import Processor Configuration window is displayed.
  4. Select a Document Type.
  5. Click Field Configuration. The Field Configuration window is displayed.
  6. Examine the XML Import Index File to identify the tags used. Select a Keyword Type in the drop-down list, then enter its XML path in the text field. See the following XML Import Index File for an example.
    In this XML Import Index File, the name of the vendor is displayed in the Vendor tag. To configure the Vendor Name Keyword Type to use this tag, select the Vendor Name Keyword Type and enter the path to the value. The path to the value is based on the structure of the file - starting from the top of the file, the path includes each XML “layer” preceding the tag. In the example file above, the path to Vendor would be entered as:
    This tells the XML Index Document Import Processor that the Vendor tag can be found under the NewDoc node, which is found under the root node APInvRun.
    Note:

    Field paths are case sensitive.

    Note:

    It is not necessary to list the Keyword Tag more than once if multiple Keyword Values may be assigned for the same Keyword Type.

  7. Click Add to move the tag to the Keywords list.
  8. Add mandatory and optional Default Keyword Types.
    The following notes explain some details about these Default Keyword Types:

    • Depending on your XML Import Index File, you must add either the Default Keyword Type >>Full Path or a combination of >>File Path and >>File Name.

    • An Absolute Path must be supplied for a >>File Path Default Keyword Type.

    • The >>Full Path and >>File Path Default Keyword Types are not available when configuring an In Place XML Index DIP process. The >>File Name Default Keyword Type may be used instead.

    • When using an XML Index DIP process to import E-Forms, only the >>Document Type or >>Document Type Number Keyword Type is needed. The >>Full Path, >>File Path, and >>File Name Keyword Types are not required.

    • If you have any of the following Default Keyword Types in the order sequence of the Field Order Configuration, you must put them in the sequence before the >>FullPath or >>FileName Default Keyword Types, otherwise the process will use the default values of those Default Keyword Types. (e.g., Offset =0, Disk Group Number = the Default Disk Group).

      • >>Disk Group Number
      • >>File Type
      • >>File Path
      • >>Number of Pages
      • >>Offset
      • >>Size

    • If the File Type (file format) is not specified in the XML Import Index File, the XML Index DIP process will default to the file format configured for the Document Type.

    • For text files, the Default Keyword Type >>Number of Pages is used to designate the number of pages that are in one text file. If more than one text file is imported as part of one document, only the first page will be viewable, even though multiple pages will show in the Properties dialog box.

    • If the XML Import Index File contains more than one Document Type, both the XML Import Index File and Field Configuration must contain the Default Keyword Type >>Document Type or >>Document Type Number.

    • To make a Keyword Type required, check the box next to the field tag box. When the tag is added, an X will appear in the Required column.

    Note:

    See Default Keyword Types Used in XML Index DIP Processes for more information.

  9. Every XML Import Index File must contain a tag that identifies the beginning of each document. Type the name of this tag in the field tag input field in the bottom of the Field Configuration dialog box. Select from the drop-down list the Default Keyword Type to which you want to map the tag. Click Add to move the tag to the Keywords list.

    • >>Begin Document, Exclusive:

      Identifies a text string as one that designates the beginning of a document. This text string will be mapped to a System Keyword Type. The System Keyword Type is not a Keyword Type that stores Keyword Values by which the document can be searched. An example of a >>Begin Document, Exclusive tag is <NewDocument> in the XML Import Index File illustration on 6.

    • >>Begin Document, Inclusive:

      Uses a tag that is also mapped to a Keyword Type as the item that designates the beginning of a document. This is useful if your XML Import Index File does not contain a text string whose purpose is to mark the beginning of a document.

      1. If you selected >>Begin Document, Inclusive in step 9, and you also want that tag to map to a Keyword Type that is searchable in the system, make a total of two field tags for that item:

        • one as the item that designates the beginning of a document

        • one as the Keyword Type to which it will be mapped

          XML Index DIP does not allow duplicate field tags, so when you enter the two tags, you must vary the path name. To do this, you must enter the Begin Document, Inclusive tag without any attributes. When configuring the field value, use the path to the tag with the attribute included. In the following example, the field tag

          /APInvRun/NewDoc marks the beginning of the document and

          /APInvRun/NewDoc/@date maps the tag to the Date Keyword Type.

  10. If any of the Keyword Types to which you are mapping tags have a data type of Date or Currency, select the defined field tag and click Format to define the format. See Keyword Configuration for details.
  11. Repeat steps 6 – 11 for all additional Document Types in the XML Index DIP process.