Creating Keyword Type Maps - WorkView - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Premier

WorkView
Platform
OnBase
Product
WorkView
Release
Foundation 24.1
License
Premier

A Keyword Type Map can consist of multiple mappings. Each mapping must either map an attribute to a Keyword Type or map a static value to a keyword type. Keyword Type mappings can be used for filters, form correlations, Document Type correlations, and dynamic folders.

Keyword Type maps can be accessed by clicking the Keyword Type Maps button in the WorkView ribbon.

Keyword Type maps can associate an attribute to a keyword type in the OnBase system. When a Keyword Type map is configured for a Document Type within WorkView, the Keyword Type value within the Keyword Type that is mapped to an attribute will automatically populate the associated attribute when an object is created from an open document within the OnBase client. In addition they decide what documents are included in a dynamic folder within an object.

CAUTION:

Ensure that the character lengths and data types match between the Keyword Types and attributes you are mapping to each other.

Note:

Multiple keyword types can be mapped to multiple attributes for a single document type.

Note:

The ~ and % characters are reserved for use with macros. Using them in a string that does not include a macro may produce unexpected results.

Example: A document in the FI-Invoices Document Type has the value John Adams for the Customer Name Keyword Type. The Customer Name Keyword Type is associated with the Name attribute in the Customer class in WorkView. The FI-Invoices Document Type is associated with the Customer class. When an object is created from the open document, the John Adams value automatically populates the Name attribute for the newly created object.

Keyword Type maps can also be used to configure static values for Keyword Types used in filters. Also, macros can be entered for static values to automatically generate appropriate values. Operators can be used to specify if the filter results should show objects with attribute values that are equal to, greater than, less than, less than or equal, greater than or equal, or not equal to the specified static value.

To create a Keyword Type map:

  1. From the WorkView ribbon, click Keyword Type Maps. The Keyword Type Maps dialog box is displayed.
  2. Select the Class in which you want to configure a Keyword Type Map from the drop-down list.
  3. Click Add. The Keyword Type Map Configuration dialog box is displayed.
  4. Enter a Name for the mapping.
  5. Configure the Left value. You can choose an Attribute or a Keyword to map to the Right value.
    Note:

    When configuring a Keyword Type Mapping for an external class, only the Class Name system attribute is available. All other system attributes that are not specific to the class will be unavailable. Calculated attributes are also not available for selection.

  6. Select an Operator that you want to use to compare the Left value to the Right value. If you are not using = or <>, see Using More Than and Lesser Than Operators in Keyword Type Maps for more information on configuration requirements.
  7. Select the Right value. You can select a Keyword or you can select Constant and specify a static value or macro.

    If you select Keyword, you will also be able to select one of the following document properties: >>Author Name, >>Document Date, >>Document Handle, >>Document Name, or >>Document Type. The document properties are described in detail in the OnBase Client documentation.

    Note:

    Keyword Type mappings should not include blank values. Blank values will be ignored during mapping.

  8. Click Add.
    Note:

    Only one instance of an attribute, a Keyword Type, and an operator combination can be mapped.

  9. Add all the mappings you want to associate with this Keyword Type Map. You can use the up and down buttons on the right to arrange the values in a specific sequence. Sequencing is important when you have multiple instances of a Keyword Type and you want specific instances to be mapped to specific attributes.
  10. When you are done configuring mappings, click OK.

You can modify a Keyword Type Map by selecting it and clicking Modify.

You can delete a Keyword Type Map by selecting it and clicking Delete. A message stating Are you sure you want to delete this keyword type map? is displayed. Click Yes to confirm the deletion.

Note:

You cannot delete a Keyword Type Map if the Keyword Type Map is referenced within a WorkView configuration. References must be removed before the Keyword Type Map can be deleted.