Keyword Actions - Keyword Update - English - Foundation 22.1 - OnBase - external

Keyword Update

Platform
OnBase
Product
Keyword Update
Release
Foundation 22.1
License

There are five Keyword Actions that can be used to configure a Keyword Update process.

Action

Description

Add Keyword

The Keyword Value in the index file is added to the retrieved document(s). If configuring a Keyword Update - Doc Type process, the Keyword Types of any Keyword Values being added must be assigned to the Document Type(s) of the document(s) being updated.

Delete Keyword (All)

All Keyword Value instances of the specified Keyword Type will be deleted on all documents in the result set, even if the Keyword Value on a document does not match the Keyword Value in the index file.

Note:

Processes configured in previous releases will retain their original settings (i.e., an existing Keyword Update - Doc Type process will default to Delete Keyword [All], while an existing Keyword Update - Global process will default to Delete Keyword [Matching]).

Delete Keyword (Matching)

The Keyword Value will be deleted on all document(s) in the result set whose Keyword Value matches the Keyword Value in the index file.

Note:

Processes configured in previous releases will retain their original settings (i.e., an existing Keyword Update - Doc Type process will default to Delete Keyword [All], while an existing Keyword Update - Global process will default to Delete Keyword [Matching]).

Replace Keyword

The Keyword Value on the retrieved document is replaced with the Keyword Value in the index file. The Replace Keyword option is only supported when the document contains a single value of the Keyword Type.

Note:

During processing, existing Date Keyword Values on documents remain unchanged when blank Date Keyword Values exist in the Keyword Update index file.

Search Keyword

The Keyword Value in the index file is used to search the database and return a result set of documents to be updated.

When a Keyword Update process is run, all Search Keyword Actions are processed first (regardless of their order in the Field Order Configuration). The Search Keyword Actions will be connected by a logical AND operator, so if you search for an Account Number of “12345” and a Customer Name of “Smith”, a result set of documents will be returned that contain an Account Number of “12345” AND a Customer Name of “Smith”. All further Keyword Actions defined in the Field Order Configuration will be performed on this result set of documents.