Description
Activity that is used to remove a keyword value from a document in OnBase. 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.
Input
- Document ID: ID of the document to be modified in OnBase
- Keyword Type name: Name of the keyword type in OnBase
- Value: Current value of the keyword that will be removed
Output
- Success: Indication whether the operation was successful
- Values: Value of the Keyword Type Name after executing the activity.
Tips and Tricks
- In case the Keyword Type name is not found the activity throws an exception. If the Value is not found though the activity returns False in the Success property and no exception is thrown. This is because we are assuming that your wish is to remove the value and if it is not there your wish is already fulfilled. In case it makes a difference for your workflow if the keyword value was not there before running the Remove Keyword activity check the Success property in your workflow. An easy way to throw an exception on your own would be using the Is True assertion activity.
- 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, using an OnBase client.