K2 SmartAction Synonyms
Synonyms are used to when the user may enter a similar word to one which has been designated as an Action. Synonyms apply equally for actionsStandard or actionsConfigured. A synonym does not have to be similar to the action word in any way. The synonym is mapped to the action and the K2 server responds to the synonym as if it were an action.
The following factors must be considered when deciding which synonyms to designate as synonym values:
- The best practice is to use single words. However, if it is necessary to use a phrase or clause as a synonym value or action value, all individual words within the phrase or clause must be separated by underscores. For example, approve_this_item would be recognized by SmartActions as a single word. However, approve this item is a true multi-word phrase and would not be supported.
- Synonym and action values may be capitals or lower-case, as SmartActions is not case-sensitive.
Duplicate synonyms are not allowed -- synonyms must be unique for each action. If the same synonym is shared by more than one action, the K2 server logs an exception.
Synonyms Configuration
<action value="decline">
<synonym value="declined" />
<synonym value="reject" />
<synonym value="rejected" />
</action>
Reserved Words
It is strongly recommended that the following words are not used as synonym values or action values. Since these words are utilized as system actions, their use as synonym values or action values may result in unexpected behavior:
- Help
- Redirect
- Delegate
- Sleep