Threshold-based Email

Arcadia Enterprise enables you to set up email notifications when a specified triggering condition occurs.

Follow these steps to define triggering conditions and triggered emails for a visual, a sheet, or a dashboard. This can be accomplished either from Edit mode, or from View mode.

  1. See the initial steps described in Emailing Dashboards, Sheets, and Visuals.
  2. In the Email Visual/Email Current Sheet/Email Dashboard modal, select the option Email based on threshold.
  3. In the Email Detail tab, enter the following details:

    • In the To text box, enter the valid email addresses of the primary recipients of the message.
    • In the CC text box, enter the valid emails of other recipients.
    • The value of the From field is configured on the Site Settings interface; see Enabling and Customizing Email Settings.
    • In the Subject text box, you can change the title of the email.

      Note that by default, the subject is the prefix specified when enabling email site-wide, as described in Enabling and Customizing Email Settings, and the title of the visual or dashboard. You can also enhance the subject by Adding Job Parameters to Threshold Emails.

      We used the following text in the subject:

      [ArcadiaData] <<trigger_name>>: Flight Connections Flow Reports
    • Under Email Template, leave Default Email Template.

      To see how the template looks, click Preview Email Template.

      Note that users with administrative privileges can create and manage email templates; see Managing Email Templates.

    • Enter the text of the email in the Message field. Additionally, you can embed job parameters in the message body, as described in Adding Job Parameters to Threshold Emails.

      We used the following text in the message body:

      Trigger <<trigger_id>>: <<trigger_name>> surpassed 
      <<trigger_threshold>> on <<triggered_time>>.
      The new value is <<trigger_data_value>>.
    • For Attach options, choose one of these:

    • For visuals that have parameterized fields on their shelves, in the Page Parameters you can chose one of these:

      • Include page parameters (default)
      • Do not include page parameters, which includes default picklist parameters.
    Triggered email detail
  4. In the Set Threshold tab, perform the following actions to create a threshold definition and a new table visual that specifies the trigger values.

    Alternatively, instead of defining a new threshold (steps 4.b through 4.e), use an existing table visual to specify threshold values, and add the ID of the that visual to the Visual ID field.

    1. Under Job Name, enter the name of the new trigger. We are using Threshold on Georgia Flights.
    2. Click Create Threshold.

      setting a threshold
    3. This creates a new table visual based on all the fields of the dataset. The table visual is called Trigger: Threshold on Georgia Flights.

      Arcadia Enterprise opens this visual in a new tab of your browser. Note that the ID for the new visual appears in the URL address (in our case, it is 2148), and has the following form:

    4. Make changes to the visual so that the field that contains the triggering measurements is the first field on the Measures shelf, and sort/filter results to ensure that the triggering measurement is in the first row. Save the new table visual.

      setting a threshold
    5. Back on the Email Visual/Email Dashboard modal, in the Set Threshold tab, notice that the Visual ID field holds the ID of the new trigger table visual. In our case, it is 2148.
    6. Under Trigger, select one of the options:

      • Threshold met: triggers an email when the first measure of the first row in the trigger visual satisfies the conditional expression
      • Value changed since last assessment: triggers an email when the change in the first measure after the last assessment satisfies the conditional expression

      For the triggering Value, adjust the logical operand (one of <, >, , , or =) and the number.

      We used the expression ≥ 1000.

    7. For Assess Trigger, select an existing schedule interval, such as Hourly (default), Daily, Every Weekday, Weekly, Monthly, Quarterly, or any existing custom schedule.

      Users with administrative privileges can also Create New Schedule. See Specifying Custom Intervals for Threshold Emails.

    8. The Send Email Limit gives you the option of sending only the first email in circumstances when a triggering event occurs multiple times within the specified time interval.

      In this example, we selected Once a day. This means that if the trigger satisfies the conditional expression, it may not be sent if an earlier one was sent in the preceding 24 hours.

      The options are:

      • When trigger occurs, which does not suppress any emails
      • Once a half hour (default)
      • Once an hour
      • Once a day
      • Once a week
      • Every 2 weeks
      • Once a month
    completed threshold setting
  5. Click Save.
  6. The system notifies the user that the trigger was created successfully.
  7. To verify that everything is correct, see Checking Threshold Email Jobs.

Specifying Custom Intervals for Threshold Emails

Availability Note.

This feature is available only to users with administrative privileges.

The Interval Name field contains a date/time picker that enables users to set a valid interval specification by selecting the interval (hour, day, week, month, or year), and then specifying the rest of the date/time elements at progressively higher granularity. For example, if the initial selection is for day, the rest of the sequence specifies hour and minute.

Note that it is possible to select multiple values for day, hour, and minute parameters.

setting a custom interval for scheduled emails

Notice that the when you navigate to the Jobs interface and click the Manage Schedule Intervals tab, the new interval appears there, and can be edited or deleted, just like other schedule intervals.

new schedule appears in the Jobs interface

Adding Job Parameters to Threshold Emails

Click the Show Job Parameters link. With your cursor in either the Subject of Message field, select the relevant parameters, and Arcadia Enterprise automatically adds them to body of that field.

The job parameters include Current Username, Visual ID/Dashboard ID, Visual Name/Dashboard Name, Visual Link/Dashboard Link, Relative Link, Job Start Time, Page Parameters, Total Job Run Time (as of time emailed), Next Run Time, Interval Name, Interval Cron, Full Trigger Conditional, Conditional, Threshold, Data When Triggered, When Trigger Assessed, Trigger ID, Trigger Name, and Email Limit.

adding parameters to message

Checking Threshold Email Jobs

To check that this threshold-triggered email is prepared correctly, see the following steps. You should also review a more detailed description of the Scheduled Jobs interface.

  1. Open the (administration) menu in top navigation, and select Job Status.
  2. In the Jobs interface, click the Scheduled Jobs tab, and notice that the job you just created is in the list.

    threshold job successfully setup, on list

    Note some of the actions that you can perform directly on the job:

    1. Click Details to see the properties of the email.

      details of scheduled email job
    2. Click Run Now to test the job, or run it off-schedule.

    3. Click Pause to temporarily stop scheduled emails without removing them from the system.

    4. To re-start scheduled jobs, toggle back by clicking Resume.