Code Keyword Type Configuration - Exception Reports - English - Foundation 22.1 - OnBase

In some cases, you may want to run a single Exception Report based on a base Document Type that has different related Document Types, depending on how the base document is used. For example, a general loan application could be used as the base document, but the related documents will differ depending on if the loan applied for is a car loan or a mortgage.

You could configure a separate Advanced Exception Report for each loan type, but then you wouldn't have a single report that covers all loans in the application process. To accomplish this and filter the related documents to match only those that are specifically related to how the base document is being used, Advanced Exception Reports allows for the configuration of code Keyword Types. The value of the selected code Keyword Type is used to include only the specific subset of related documents configured. Those related documents must still contain the Keywords Types to Match on the related Document Types in order to be consider a match.

Note:

Multi-Instance Keyword Type Groups cannot be used with the Exceptions Reports module.

To configure code Keyword Types:

Select Advanced Exception Reports from the Printing menu in the Configuration module. The Advanced Exception Reports dialog box is displayed.
Select the Advanced Report to configure code Keywords for in the Report Name list and click Settings. The Advanced Exception Reports Configuration dialog box is displayed.

Note:
If the Advanced Exception Report is not already configured, see Standard Configuration before continuing. The code Keyword Type is used to locate a subset of related documents within all the related Document Types configured for the report.
Select a code Keyword Type from the Code Keyword Type drop-down list. The value of this Keyword Type is used to determine the subset of related documents to use for the report.
For example, if a different set of related documents is required for a home loan than an auto loan, then the code Keyword Type Loan Type is selected. The related documents subset is triggered based on whether the value of the Loan Type Keyword Type is Car or Mortgage on the base document.
Select Report on single keyword matches per Keyword Type to produce a report only for documents associated with the value of the first instance of the code Keyword Type on the base document. If this option is not selected, the report locates related documents associated with each of the values for multiple instances of the code Keyword Type on the base document.

Note:
This option is not available unless a Code Keyword Type is configured for the report.

In other words, if the base document has two values for the Loan Type Keyword Type, selecting the Report on single keyword matches per Keyword Type option returns results based only on the value of the first instance of the code Keyword Type. If this option is deselected, related documents associated with each of the Loan Type values are included, as long as each value is configured to include related documents.

For example, if the Loan Type Keyword Type is used on the base document to collect Car, Mortgage, Low-Interest, or ARM as values, if you add two Loan Type Keywords to the base document (Low-Interest and Car) and select Report on single keyword matches per Keyword Type, only the first instance of the Loan Type Keyword is used as the code Keyword value. In this example, if Low-Interest is first, the related documents subset based on Car as the code Keyword value is not triggered. However, if Report on single keyword matches per Keyword Type is deselected, then the subset of documents is triggered for related documents that contain either Low-Interest or Car as values of the Loan Type Keyword Type, as long as each value is configured to include related documents.
Click the Code Settings button. The Related Document Types for Code Keyword Values dialog box is displayed.

The Code Keyword Values for... section displays the values configured for the code Keyword Type selected. These values are connected to different sets of related documents. As long as the base and related documents all contain the same Keywords Types to Match value, they are matched as related (the value of the code Keyword Type is only used to determine the subset of related documents to search within for matches).

In the image above, Mortgage is a code Keyword value for the Loan Type Keyword Type that triggers related mortgage documents for the Exception Report, and Auto is the code Keyword value that triggers related car loan documents.
To create a new code Keyword value, in the field beneath the Code Keyword Values for... list, enter a value for the code Keyword. The code Keyword value can have a maximum of 250 characters. The value entered must be the exact value of the code Keyword Type on the base document.

Note:
If the Keyword Type that contains the code Keyword value is used multiple times on the base document and the Report on single keyword matches per Keyword Type option is selected, only the value of the first instance of the code Keyword Type on the base document is used to determine the subset of related documents.
Select the Document Type to search for related documents from the drop-down list below the Related Document Type list.

This list is populated with all of the Document Types added to the report during standard configuration (see Standard Configuration). The code Keyword Type is used to locate a subset of related documents within all the related Document Types configured for the report.

In the data entry fields adjacent to the Related Document Type drop-down list you can define the following options for that Document Type:

Option	Description
Wait Days	Specifies the number of days, after the base document is entered into the system, until the search for related documents is initiated.
Tickler Days	The number of days following the Document Date of the secondary document, after which the secondary document is no longer considered a match in an exception report. In other words, the Tickler Days value establishes an “expiration date” for secondary documents. This is most useful when secondary documents have to be renewed periodically. Without a Tickler Days value, the secondary document would be considered a match, even though it could be an expired version of the document. For example, if the Tickler Days is set to 5 and the secondary document date is 12/21/2007, the expiration date of that document (set by the Tickler Days value, and after which it will be considered missing) is 12/26/2007. If the report is run on 12/27/2007, the secondary document will be reported as missing. It will not be reported as missing between 12/21/2007 (secondary Document Date) and 12/26/2007 (expiration date set by the Tickler Days value) because the renewal period of the document had been defined as valid within this range.
# Present	Specifies the total number of related documents of the specific type that must be in the system to be considered a match.

Option

Description

Wait Days

Specifies the number of days, after the base document is entered into the system, until the search for related documents is initiated.

Tickler Days

The number of days following the Document Date of the secondary document, after which the secondary document is no longer considered a match in an exception report. In other words, the Tickler Days value establishes an “expiration date” for secondary documents. This is most useful when secondary documents have to be renewed periodically. Without a Tickler Days value, the secondary document would be considered a match, even though it could be an expired version of the document.

For example, if the Tickler Days is set to 5 and the secondary document date is 12/21/2007, the expiration date of that document (set by the Tickler Days value, and after which it will be considered missing) is 12/26/2007.

If the report is run on 12/27/2007, the secondary document will be reported as missing. It will not be reported as missing between 12/21/2007 (secondary Document Date) and 12/26/2007 (expiration date set by the Tickler Days value) because the renewal period of the document had been defined as valid within this range.

# Present

Specifies the total number of related documents of the specific type that must be in the system to be considered a match.

Click Add to create the code Keyword value and relate it to the selected Document Type.

Note:
As long as the base and related documents all contain the same Keywords Types to Match value, they are matched as related. In other words, the value of the code Keyword Type is only used to determine the subset of related documents to search for matches.
Multiple Document Types can be related to the same Code Keyword value. To add another Document Type, select the code Keyword value to use then select the additional Document Type from the drop-down list, configure the adjacent fields, and click Add.

Click Clear to clear the values currently selected or entered.

To remove a related Document Type, select it in the Related Document Type list and click Remove.
When finished, click Close.
Click Apply on the Advanced Exception Reports Configuration dialog box.
Click Close on the Advanced Exception Reports dialog box.