Action template

This template can be used as the basis for implementing a standard FTM action.

It is made up of :
  • A_Template.subflow (see Figure 1)
  • A_Template.esql.
To use the template, copy both files into your implementation project and rename them to:
  • A_action.subflow
  • A_action.esql
where action represents the name of your action.

You might choose to locate them in a broker schema (subfolder) within your implementation project. Edit A_action.esql to give an appropriate name to the ESQL module. In the database or compute nodes (Action Impl), update the Statement or ESQL Module property to reference the new action ESQL module implementation.

At run time, actions are located in a message flow by a Route to Label, so you also must edit the BeginAction node property of the msgflow file to change the label from FSMAction to A_action, as shown in Figure 1.

A_Template.esql is a template for the ESQL for the database node Action Impl. Its well-defined structure makes it easier to follow and use:
  • Broker schema declaration
  • Copyright block1
  • Template name/version1
  • Mapper documentation block1
  • Module scope variables:
    • Constants
    • Pseudo Constants
    • Variables
  • Pseudo constants initialization procedure1
  • Action Main function:
    • Pseudo Constants Init
    • Action Begin
    • Action Loop
    • Action End
  • Action procedures and functions1
Figure 1. A_Template.subflow
A_Template.msgflow
1 These blocks are described in General structure of ESQL in templates.