Cheat Sheet

Modified on Tue, 12 Nov at 3:29 PM

<onenter>: This is the first state when a step is entered. The user interface is not available in this state, as a result, you cannot use UI-related actions. However, if you want to initialize parameters to use them for UI mapping, then this is the correct state to do so.
<onresume>: The second state after <onenter>. In this state, the UI is available and you can modify the loaded layout with the UI update actions.
<onpause> and <onleave>: These states occur whenever you leave the current step or the whole component by using the step_transition or finish_workflow actions. Since the transitions are not interruptible, you cannot use rules here that use these actions. In theonpause state, the resources of the step still exist in onleave, they do not.
<onevent>: This is probably the most important state. Rules defined in this state will be checked every time an event gets processed. All the rules related to interactions with the user are defined in this state.

command: The command of this event, e.g., “NEXT”. The command may, for example, correspond to an ID in the layout or workflow description of your component. Example: #{event:command} == ‘CANCEL’
device.modality: The source of the event. This field can be accessed using a short notation
The expression #{event(SPEECH):command==’NEXT’ is equivalent to the expression #{event:device.modality} == ‘SPEECH’ && #{event:command} == ‘NEXT’. The modality depends on the event emitter. Example: #{event:device.modality} == ‘MENU_SELECTION’
payload: The structure/ fields of the payload, are dependent on the action/handler that triggers the event. Example: #{event:payload.amount}
payload.error: Contains an error message if there is one. Example: #{event:payload.error}