Online Help | Desktop App

E-mail Notification

Updated in 2022.1

An E-mail Notification operation tells the workflow engine to send an email notification and specifies its details. You configure such workflow operations using the E-mail Notification window.

To configure an E-mail Notification operation:

  1. Click Select and either choose an E-mail Notification from the list of existing notifications for the object class or create a new one by clicking New and then select it.

  2. Under Attach, select options for attaching files to the notification:

    • Files attached to this object - adds all the files that the current action or trigger attaches to the object.

      Not available for Scheduled Task Email Notifications

      NOTE: This option does not add the attachments that the object already had before launching the workflow action or trigger. To add those "old" attachments, use the Other files option below and specify the current object (%[DBF ID]%) as the script result.

    • Files attached using this control - adds the files that the user attaches on the current action's Action Form using the specified Attachment Area control.

      Not available for Scheduled Task Email Notifications

      TIP: This option is useful when the notification is to be generated by an interactive action, such as a Create Action, Step Action, or SSP Service Action.

    • Other files - you can specify a custom SQL expression or script for attaching any files existing in the database. A SQL expression or script must return the IDs of attachments or IDs of objects/activities containing attachments.

  3. Under Parameters, view the list of parameter values that are passed to the E-Mail Notification:

    • Default parameter values will display <Default> in red color.

    • Parameter values that have to be assigned will display <Double click to assign value> in red color.

    IMPORTANT: You cannot invoke an E-mail Notification with missing parameter values. If a parameter value is missing, you must assign it.

  4. For each parameter that has no value assigned and for parameters with default values you want to change, you must assign a value as follows:

    • Quickly assign one of predefined values:

      • Right-click the parameter row and select a value from the pop-up list, which contains the following items:

        • <Empty> - the placeholder for passing the empty value as the parameter value.

        • When the E-mail Notification is executed from an Action, choose a virtual field from the Action Form. The list displays the virtual fields of the same data type as the target parameter.

        • When the E-mail Notification is executed from a Function, choose a Function parameter. The list contains parameters of the same data type as the target parameter.

    • If the pop-up list does not contain the value that you need, double-click the parameter row and set its value in the Assign Parameter window.

  5. Keep the Enable operation check box selected to enable the operation. Otherwise, the operation will be disabled.

  6. Click OK.