K2 SmartAction Synonyms

Synonyms are used to cater for scenarios where the respondent 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 will respond to the synonym as if it were an action.

The following factors must be considered when deciding which synonyms to designate as synonym values:

• 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 case-insensitive.

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 will register an exception.

<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 and/or action values. Since these words are also utilized as system actions under certain conditions, their use as synonym values and/or action values may result in unexpected behavior:

• Help
• Redirect
• Delegate
• Sleep

For information on SmartAction message customizations, see the topic K2 SmartActions Message Customizations.