Description
Activity that is used to add a keyword value to a document in OnBase. Supports loose keyword values or keyword type groups but not multi-instance keyword type groups. Use this activity inside the OnBase Scope activity.
Properties
Analyst
- Description: Optional text for documentation purposes.
Common
-
Continue On Error: Continues the execution of the workflow even if an error occurs during the execution of the activity.
-
Delay Before: Delay time in milliseconds before the activity is executed. The default value is 250 milliseconds.
-
Delay After: Delay time in milliseconds after executing of the activity. The default value is 250 milliseconds.
-
Disable Log: Disables the logging functionality for this activity.
-
Disable Protocol: Disables the protocol functionality for this activity.
-
Exclude from Global Delay: Excludes this activity from the Global Delay functionality.
-
Timeout: Duration in milliseconds in which the activity tries to execute.
- Continue On Error: Continues the execution of the workflow even if an error occurs during the execution of the activity.
- Delay Before: Delay time in milliseconds before the activity is executed. The default value is 250 milliseconds.
- Delay After: Delay time in milliseconds after executing of the activity. The default value is 250 milliseconds.
- Timeout: Duration in milliseconds in which the activity tries to execute.
- Exclude from Global Delay: Excludes this activity from Global Delay functionality.
Input
- Document ID: ID of the document to be modified in OnBase.
- Keyword Type name: Name of the keyword type in OnBase.
- Value: Value of the keyword to add.
Output
- Success: Indication of whether the operation was successful.
- Values: Value of the Keyword Type Name after executing the activity.
Tips and Tricks
- For loose keyword types and single-instance keyword type groups OnBase allows only unique values for each keyword type. If you are trying to add a value that is already associated with the keyword type, you are modifying, the activity does not change the document keywords and returns False in the Success property.
- Keep in mind that OnBase might change the values you are providing slightly (for example, it upper-cases everything) because of this we are returning the actual values after the execution in the optional Values property.
- This activity performs multiple API requests in the background. The activity locks the keywords of the document during operation. In case the document is already locked the activity throws an exception. If something goes wrong during execution the activity tries to unlock the keywords but, in some cases, (for example, connectivity problems) the unlock request cannot reach the Server: in this case the keywords need to be unlocked manually, for example by using an OnBase client.