Description
Activity that is used to get keyword values from a document in OnBase by its document ID. It returns the name of every keyword type and all its values. It supports loose keyword types and keyword type groups but skips all 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.
Input
- Document ID:ID of the document to retrieve the keywords from.
Output
- Keywords: Keyword names and their values stored in dictionary format. Does not include Multi-Instance Keywords.
- Keywords Table: Keyword names and their values stored in a DataTable format including Multi-Instance Keyword Groups.
Tips and Tricks
- The output of this activity (the
Keywords property) is structured as Dictionary<String, String[]> where the
dictionary keys are the names of the keyword type and the dictionary values are
arrays of the keyword values. Examples how to use the output are:
- If you like to iterate through all keyword names and their values you might want to use the For each Key Value Pair activity. You can then either iterate through all elements of the array (KeyValuePair.Value) using the For each Loop activity or get the first entry using the VB expression KeyValuePair.Value.First
- Get the values of a specific keyword type by the keyword type name by writing the name in round parentheses behind the variable you used for the Keywords property. For example, MyKeywords("KEYWORDNAME") Again, you can then either iterate through all elements of the array using the For each Loop activity or get the first entry using the VB expression MyKeywords("KEYWORDNAME").First