Email Trigger

Including this trigger will provide an email notification for the step immediately following.  If no parameters are added, the following behavior will result:

  • if the step immediately following this trigger is a transition step, the trigger will send an email to the owner (either a single user or a group of users) of that transition step.
  • if there is not a transition step following the trigger execution step, the trigger will notify the owner of the workflow, because a system step or absence of a next step will not provide email information to the trigger.

Implementation

Declaration

Usage

Parameters (Optional)

Although not required, four optional parameters may be used, which will change the default behavior described above:

Email Address Parameter

This is an optional parameter inside the email trigger that allows you to specify non-system email addresses to be notified.

To specify who should receive notifications, the following parameter should be added to the email trigger with the list of emails comma delimited:

Inside the email trigger it will look like this:

Recipient Users Parameter

This is an optional parameter inside the email trigger that allows you to specify system users to be notified.

To specify who should receive notifications, the following parameter should be added to the email trigger with the list of emails comma delimited:

Recipient Groups Parameter

This is an optional parameter inside the email trigger that allows you to specify system groups to be notified.

To specify who should receive notifications, the following parameter should be added to the email trigger with the list of emails comma delimited:

Mode Parameter

This parameter determines when a notification should be sent. If the value is "notify", then the user will receive a notification when a workflow has been assigned to him/her. If the value is "completed", then the user will receive a notification when the workflow has been completed. If the mode is not specified, the default is "notify".

Adding a Workflow Trigger

The Cascade Server workflow builder utilizes centrally managed triggers.  For a trigger to be available in a workflow created by the Workflow Builder, the trigger must first be defined and assigned a name in the system-wide trigger base.  Defining triggers in this way allows the Java files that contain each trigger’s functionality to be referenced later in the workflow definition.

If a new custom trigger has been written or Cascade Server has been upgraded without including the default database, the new triggers will need to be added before they become available in the Workflow Builder.

To add a workflow trigger:

  1. In the Administration area, select ‘Workflow Definitions’.
  2. Click ‘Manage Workflow Triggers’.
  3. All currently available triggers in the default database are shown, along with the ‘Add a Trigger’ field.
  4. Type in the name of the new trigger and click ‘Submit’.
  5. The new trigger will now appear on the list of available triggers and will be available for use within the Workflow Builder.

manage workflow triggers

Adding a trigger using this interface ensures that the triggers will be defined in all workflows created using the Workflow Builder.  For workflows created without the Workflow Builder, triggers must be defined individually for each workflow.