Configuration - DJDE Input Filter - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

DJDE Input Filter

Platform
OnBase
Product
DJDE Input Filter
Release
Foundation 22.1
License
Standard
Essential
Premier
  1. In the Configuration module, select Import | DJDE Input Filter Processor. The DJDE Processor Configuration dialog box is displayed.
  2. Select a process format from the DJDE Processing Format list and click Document Fields. The Processor Field Definition for: [process format] dialog box is displayed.
  3. Select the Document Type to be configured. Until a Document Type is selected, all configuration options will remain disabled.
    Only Document Types assigned to the DJDE process format will be available for configuration.
    CAUTION:

    Fields are associated with the Document Type itself, not the DJDE process format. If you have already defined fields for a Document Type and then add that Document Type to a new DJDE process format, you will see those same field definitions. Any modifications to the fields will affect every DJDE process format that includes the Document Type, not just the current configuration. Any Document Type configurations in DJDE will remain even when a process format containing them is deleted.

  4. To set the configuration options (i.e., the location of the Identification String, Keyword Type and their locations, etc.) for each Document Type manually, continue to step 5.
  5. To copy the configuration options from a previously-configured Document Type, complete the following steps:
    1. Select the Document Type from which the configuration options are to be copied from the Document Type list.
    2. Click Copy Fields. The Field Configuration Copy Selection dialog box is displayed.
    3. Select the Document Type(s) to which the configuration options are to be copied from the Copy Field Configuration To Documents list. To select all Documents in the list, click Select All.
    4. Click Save.
      In order for Keyword Type configuration information to be copied, the Keyword Types must be shared between the two Document Types. A notification is displayed if, after copying the configuration options, unconfigured Keyword Types remain on the destination Document Type.
      Note:

      If the any of the Document Types that you selected to receive configuration options have already been configured for the DJDE process, a warning message is displayed asking if you would like to continue. If you elect to continue, the previous configuration options are overwritten.

  6. For every Document Type identified for processing, an Identification (ID) String must be defined. It is used by DJDE to identify each page of the document.
    An ID String is a string of text that appears in the same location on every page of the document, for the selected Document Type. An exclamation point (!) can be used to precede an ID string to exclude a page from a specific Document Type.
    If configuring more than one Document Type, each Document Type's ID String must be unique. The parameters for the ID String are described in the table below.

    ID String Parameter

    Description

    Identify document with existence of any ID Strings

    Select this option to configure your DJDE process to search the data file for any configured ID Strings to determine the correct Document Type for a page of data.

    If this option is not selected, the DJDE process will search the data file for all configured ID Strings. Any pages that do not contain all configured ID Strings will be stored in the SYS Unidentified Items Document Type.

    String

    The alphanumeric characters that are displayed in the DJDE data file and indicate a new page of the document. A space character can be used in the ID String field. ID Strings are case-sensitive.

    Note:

    Document ID Strings are limited to 51 characters.

    Line

    The line on which the ID String begins (referenced from the top of the page)

    Col

    The number of the column in which the ID String begins (referenced from the left side of the file)

    1. In the Identification Strings section, type the ID String text in the String field.
      Note:

      It is recommended to use the document's Form Name when configuring a Document Type's ID String. If a document does not have a Form Name, another ID will need to be used.

      Note:

      Document ID Strings are limited to 51 characters.

    2. Enter the Line and Col values of the ID String.
      Tip:

      If a file contains Document Types that contain Multi-Instance Keyword Type Groups, there are certain considerations for ensuring a successful process of the DJDE data. See your system administrator for additional information.

  7. Click Add to save the ID String settings to the Document Type configuration.
    Note:

    Remove deletes the highlighted ID String from the configuration.

  8. Configure Keyword Types for each Document Type. For the first Keyword Type, enter the location of the value. If your value does not appear in the same place on every page, but another text string does (and is always in the same place relative to the Keyword Value), enter the value of the label, or TAG. Step 9 provides additional information regarding the TAG type.
    CAUTION:

    When configuring the Document Fields for your DJDE process format, you should ignore line and forms feeds (if visible) when viewing your sample import file in a text editor, such as Notepad.

    Keyword Parameter

    Description

    Line

    Identifies the number of the line in which the value begins. (This number is referenced from the top of the document.

    Note:

    The maximum height of a document is 160. The Line value plus the Height value cannot exceed 160.

    Col

    Identifies the number of the column in which the value begins. (This number is referenced from the left side of the document.)

    Height

    Identifies the number of rows the value spans. A Height of 1 is the default, indicating that the value will only be found on the line specified. This feature can be used to pick up multiple customer names or address lines from a document.

    Note:

    The maximum height of a document is 160. The Line value plus the Height value cannot exceed 160.

    Note:

    If the Document Type will contain Multi-Instance Keyword Type Groups, the Height for each Keyword must be set to 1. See your system administrator for additional information regarding Multi-Instance Keyword Type Groups and DJDE.

    Width

    Identifies the number of characters that the Keyword Value could span, starting with the Column value as 1. Make the Width as many characters as necessary to accommodate all possible Keyword Values of this Keyword Type.

    Note:

    The Width must have a value of 1 or greater.

  9. Using Implied Continuation, Keyword Values help determine the start of a new document. From the drop-down list select a Type to configure the Keyword Value one of the following ways:
    • If the Keyword Values appear in a fixed location on every page of the document, configure Keyword Values using the KEYWORD option.

    • If the Keyword Values do not appear in the same location on every page, but another label (that is always in the same place relative to the Keyword Value) does, configure Keyword Values using the TAG option.

    • Use the CONTENT TAG or CONTENT KEYWORD options if the document has the same value for one Keyword Type, and you want the document to break to a new document on the Keyword Type. If you do not want the document to break, override the Implied Continuation using a Continuation String or Continuation Number.

    • Use the PAGE-BASED KEYWORD option to perform the same function as the KEYWORD option, with the exception that a page number is specified from which to obtain the Keyword Value.

      Note:

      Use this option only to pull specific Keyword Values from certain pages. If you need to pull Keyword Values from all pages in a document, override the Implied Continuation using a Continuation String or Continuation Number. See your system administrator for more information about Implied Continuation.

    • Use the PAGE-BASED TAG option to perform the same function as the TAG option, with the exception that a page number is specified from which to obtain the Keyword Value.

    Note:

    See the table beginning on 15 for details on the above Keyword Type definition options for DJDE.

  10. If you selected the TAG or CONTENT TAG option, select the Keyword Type and settings you just added, and click TAG to display the Tag Field Definition dialog box.
    For all other Types, continue to step 13
  11. Enter the text string for the Tag, as well as where to find the actual Keyword Value, relative to the tag.
    • The Tag String will be the string used to identify the location of the Keyword Value.

    • The Tag String is case sensitive.

    • Include any characters that are necessary to associate the word, including a comma or colon.

    • When finished, click Save & Close.

      Note:

      Tag strings are limited to 50 characters.

  12. Enter the Keyword Information of where the Keyword Value will be found in relation to the tag string.
    • Line indicates the number of lines horizontally away from the end of the configured tag string.

    • Column indicates the number of columns vertically away from the end of the configured tag string, where the first column (space) after the tag string represents “0”.

    • Width indicates the number of characters wide the Keyword Value will be.

    Note:

    Anything to the left of the tag string will have a negative column number and anything above the tag string will have a negative line number. If the search region is configured to extend past the margins of the page, the Keyword Value will not be detected and an error message is displayed in the Verification Report.

    Note:

    Defining the entire page as the search region will slow down the process.

  13. From the Keyword Type drop-down list, select the Keyword Type that corresponds to the value.
  14. If this is a masked Keyword Type, select Validate mask to have OnBase perform validation for this Keyword Value. See the System Administration documentation for information on Masked Keywords.
    Note:

    When this option is selected, imported Keyword Values that do not match the configured mask will not be added to the imported document.

  15. For any Type that is a Currency or Date Keyword Type, format the Keyword Value so that it matches the DJDE file. Select the Keyword Type field and click Format. The Date Format dialog box or Currency Format dialog box is displayed.
    • Select appropriate values and click Save to save and close.

    • See Currency Formatting Options and Date Formatting for additional information.

    • See the table below for Negative Indicators – Allowed Symbol Placements

    Negative Indicators – Allowed Symbol Placements

     

    Indicator After Number

    Symbol Inside Indicator

    Add Space for Symbol

    Symbol After Number

       

    Parenthesis

    Minus Sign

    X

    X

    X

    X

    X

     

    X

    X

    X

    X

     

    X

    X

       

    X

    X

     

    X

     
     

    X

    X

     
       

    X

    X

    X

     

    X

     
  16. For any Type that is Page-Based, format the value to indicate the page on which to look.
    1. Select the Keyword Type field and click Format.
    2. The Page-based Keyword Configuration dialog box is displayed. In the Page Number field, type the page number on which to find the value.
      (If the Keyword selected was both Page-Based Type and a Currency or Date Data Type, the Currency or Date Format dialog box will include the Page Number field.)
    3. Click Save to save format changes and exit the formatting dialog box.
  17. You can elect to strip characters from the Keyword Value found in the string if it has excess characters that you don't want in the Keyword Value on the document.
    Select an item from the Keywords, and click Process to display the Process Field dialog box. Character stripping options are as follows:
    • Keep All Characters -(default) retain all characters of the Keyword Value string for the Keyword Value on the document

    • Strip Spaces- remove all spaces from the Keyword Value string

    • Strip Character- remove a certain character from the Keyword Value string. Enter the character in the text field.

    • Strip...Chars from Beginning or Strip...Chars from End - remove characters from the beginning or end of the Keyword Value string. Enter the number of characters you want to drop in the text field.

  18. When all parameters are defined, click Add to save the settings to the Document Type configuration of the DJDE Processor. (Remove deletes the highlighted Keyword Type from the configuration.) The item is added to the Keywords list.
    Note:

    If your Location and Range settings (Line, Column, Height, Width) are all the default setting (1), you must click inside the field of at least one of the settings in order to enable the Add button.

  19. Repeat for all remaining values that need to be captured as Keyword Values. Each Keyword Type can use a different Type for capturing Keyword Values. You must have at least one Keyword Type that is not CONTENT TAG or CONTENT KEYWORD in order to be able to separate documents based upon Implied Continuation.
  20. Click Save & Close to save settings and close the Process Field dialog box.
  21. When all Document Types have been configured, click Close to save the settings and close the Processor Field Definition for: [process format] dialog box.