Defining Form Actions

Form actions provide a no-code method to:

  • change a record's business status
  • generate a report
  • run a server side script
  • run a business decision matrix
  • call a formula.

Once defined, form actions can be triggered on-demand, for example by form buttons (see Form Actions Buttons for details).

How to create a form action

  1. On the configuration page of the form driven flow, click the Actions tab. Two grids will be shown: one is Form Actions and the other is Action Group.
  2. At the top of the Form Actions section, click the Insert button.
  3. In the Form Action window:
    1. Enter a name for the form action.
    2. Click the Plus () sign next to the execute label to add a command.
    3. Click the labels in the command to select the desired operands such as change business status from status/ generate digital document/ call custom processor/ call business matrix/ call a formula with mapping. Then, select the status/ the document/ the processor/ the matrix.
    4. Go back to step b. if you wish to add additional commands. To remove commands from the list, click the button.
    5. Click the Save button at the bottom right corner of the page.

Available form action commands

Command Description Operands Examples
Change Business Status from Status Changes the record's workflow status based on the entity's attached business workflow. For details, see the Business Workflows Processor documentation.
  • Initial status
  • Final status
Change the status from Draft to Active
Generate Digital Document Generates a predefined report. For details, see Analytics. Report name. Generate a contract or an agreement
Call Custom Processor Runs a predefined on-demand server automation script. For details, see Creating On-demand Server Automation Scripts. Server automation script name. Call the E-sign processor
Call Business Matrix Runs a predefined business decision matrix. For details, see the Business Decisions Processor documentation. Business decision matrix name. Call the eligibility matrix.
Call Formula with data mapping Runs a predefined formula for calculation of input data. See Calling the Business Formulas. Business Formulas Call the formula for calculating the policy of an insurance.

Alternatively, it is possible to trigger an action from the actual step of a digital journey.

Calling a Custom Processor (endpoint)

To call an endpoint configured earlier, select the call a custom processor and select the endpoint. As a prerequisite, associate a server-side script with the endpoint that has a bool output structure type.

When the endpoint has no output structure type, then no output mapping form will be displayed.

If the Output structure type is “Entity“, then a subtitle will be displayed: Result type: Entity of type “Entity name“.

If the Output structure type is “Custom“, then a subtitle will be displayed: Result type: Object.

If the Output structure type is “Boolean“, then a subtitle will be displayed: Result type: Boolean.

If Output parameter type is “Collection”, then a subtitle will be displayed: Mapping of output type “Collection” is not supported, and on server side no output mapping will occur.

The same endpoint can be displayed in the UI Designer.

How to add an action to a specific step in a Digital Journey

  1. Open the main menu and click on the Digital Journey menu item. Open Form Driven Flows.
  2. Select the flow you wish to work on. Click the ''Steps'' tab. Select the step you wish to modifiy.
  3. Inside the step, click on Flow Control tab.
  4. In the Actions to be performed section, select the action you wish to have in that particular step. The available actions are those configured earlier from the Available form action commands table.
  5. Click the ''Save and Reload'' button.
  6. Optionally, if you have selected the Generate contract action, go to the UI tab and add the button for this action and the file attribute created in the Data Model of the entity. For more information, see Digital Documents Processor
  7. Click the ''Save and Reload'' button.