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 or a dashboard. This can be accomplished either from Edit mode, or from View mode.
In the Email Detail tab, enter the following details:
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
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 Include Image as options, choose one of these:
For visuals that have parameterized fields on their shelves, in the Parameters you can chose one of these:
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.
Click Create Threshold.
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:
https://ip_address/arc/apps/builder/trigger_id
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.
Under Trigger, select one of the options:
For the triggering Value, adjust the logical operand (one of
<
, >
, ≤
, ≥
,
or =
) and the number.
We used the expression ≥ 1000
.
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.
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:
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.
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.
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.
<<app_id>>
<<app_name>>
<<app_url>>
<<start_time>>
<<params>>
<<run_time>>
<<next_run_time>>
<<run_interval>>
<<run_interval_cron>>
<<trigger_fullconditional>>
Conditional, as <<trigger_threshold>>
Threshold, as <<trigger_conditional>>
Data When Triggered, as
<<trigger_data_value>>
Change in Data When Triggered, as
<<trigger_difference>>
When Trigger Assessed, as
<<triggered_time>>
Trigger ID, as <<trigger_id>>
<<trigger_name>>
Email Limit, as
<<minimum_time_interval>>
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.
In the Jobs interface, click the Scheduled Jobs tab, and notice that the job you just created is in the list.
Note some of the actions that you can perform directly on the job:
Click Details to see the properties of the email.
Click Run Now to test the job, or run it off-schedule.
Click Pause to temporarily stop scheduled emails without removing them from the system.
To re-start scheduled jobs, toggle back by clicking Resume.