AX2194

Using email notifications with triggers

File groups support optional email notification addresses that can be used to send targeted Scheduler notifications based on the file group's plan code table, rather than using the standard Scheduler notification addresses.

NOTE: Currently, these file group notification addresses are only for use with triggers. The Scheduler job will only be able to resolve the {NotificationAddress} variable if the job was executed in response to a file group trigger.

To define file group-specific notification addresses, you can use one or both of the following options:

  • Default address: You can specify a default notification address for the file group.
  • Address column: You can set up a column in the plan code table to define email addresses for each individual plan code in the file group.

If you use both options, then the default address will only be used if the column entry is blank for a particular plan code.

Defining file group notification addresses

File group notification addresses are defined in the file group properties:

  1. On the Axiom tab, in the Administration group, click Manage > File Groups.

    The Axiom Explorer dialog opens, with the focus on the File Groups folder.

  2. Navigate to the file group that you want to edit, then right-click the file group and select Edit File Group.

  3. In the Edit File Group dialog, on the File Group tab, complete the following settings, and then click OK.

    Item Description
    Default Notification Address

    The default notification email address for the file group. Separate multiple addresses with semicolons.

    The default notification address is used if no Notification Address Column is specified, or if a column is specified but a plan code does not have an assigned value in the column.
    Notification Address Column

    The column in the plan code table that contains an email notification address for each plan code. You can select from any non-key string column in the plan code table.

    Within the column, if you want to specify multiple email addresses for a plan code, separate the addresses with semicolons.

    If this column is left blank for a plan code, then the default notification address is used (if defined).

The email addresses are now available to be used within Scheduler jobs that are set up for use with file group triggers.

Using file group notification addresses in Scheduler jobs

To use the file group notification addresses in a Scheduler job, use the system variable {NotificationAddress}. For example, you could set the To address of the job notification settings to {NotificationAddress}.

When the file group trigger queue is evaluated, the plan codes that triggered the event are grouped by notification address, so that there will be one Scheduler job for each unique notification address. This allows for the plan code-specific notifications held in the Notification Address Column (if used).

Example

Twenty plan codes are added to the trigger queue as a result of a Process Plan Files utility:

  • If the notification address settings are not used, or if only the default address is used, then all twenty plan codes are evaluated as a single group. For each Scheduler job that matches the trigger event, one instance of that job is added to the Scheduler queue. All twenty codes will be considered for the evaluation of variables in that Scheduler job.

  • If a table column is used for the notification address settings, and the twenty plan codes are associated with five unique email addresses, then the twenty codes are grouped into five different groups. For each Scheduler job that matches the trigger event, five instances of that job are added to the Scheduler queue. In each job, only the codes associated with that unique email address will be considered for the evaluation of variables in that Scheduler job.

If the file group trigger is being used to perform an action on a second, dependent file group, keep in mind that the notifications are based on the original "triggering" file group, not on the file group where the triggered action is being performed. For example, if file group A triggers a Process Plan Files task for file group B, the originating plan codes and therefore the corresponding notification addresses are obtained from file group A, not file group B.