A Notification is a trigger that can be 'fired' when a particular system or custom Event occurs in Data Studio (e.g. a Workflow has completed).
To create a Notification:
- Go to System.
- Select Notifications.
- Click Create new notification.
- Enter a descriptive name that's unique to this Space.
- (Optional) enter a description.
By default, all Notifications are Enabled, meaning they will become 'active' as soon as you save changes.
Each type refers to an action that Aperture Data Studio will perform once the Notification is triggered:
- Send email - sends an email to one or more recipients with details of the Event(s).
- Run one or more published Workflows - submits the specified Workflows for immediate execution.
- Run one or more Schedules - submits the specified Schedules for immediate execution.
- Enter the Recipient(s) email address. When using multiple addresses, separate them with a space, comma or semicolon.
- Enter the Email subject and Email content. If you type the @ symbol, you will be presented with a list of available data items for the selected Event(s). These will be replaced by the actual data from the Event when the email is sent.
If the Notification contains multiple Events, and the Trigger if expired option has been selected, the email could be sent when not all the Events have been fired. In this case, some data items may not be available and will be replaced with <No data available> when the email is sent.
Administrators can configure the SMTP server settings by going to Settings > Communication > SMTP properties.
Run one or more published Workflows
- Select a Workflow from the list of available Workflows. If it's not in the list, it most likely has not been published.
- To run multiple Workflows, click Add Workflow and select another one.
- Click Parameters to configure re-configurable Workflow parameters. You can either assign a value or tick Use event data to select an Event and its data as the parameter value.
- Click Apply to save changes.
All the Workflows will be run in parallel. If you want them to run in a specific sequence, you can either add them to a Schedule and execute that first or create additional Notifications to trigger a Workflow once another one is completed.
Run one or more Schedules
Select a Schedule from the list of available Schedules. To run more than one, click Add Schedule.
All the Schedules will be run parallel, but the Workflows within the Schedule will be run in sequence.
A Notification is triggered when one or more Events occur that match the specified filter criteria. For example, if you want to trigger a Notification when data is loaded to a specific Dataset (called 'Customers'), you'd select the Dataset loaded Event and add a filter to restrict the event to the 'Customers' Dataset.
When more than one Event is defined, all of them have to be run within a specified period of time or the Notification to be triggered.
To add Events:
- Click Add Event.
- Select the required Event.
- (Optional) enter the filter criteria (see below).
- Enter a Time period. This has to be a number greater than zero that represents the number of minutes in which all events must be run (i.e. each time one of the Events is fired, the time period is reset to zero).
- Select Trigger if expired if you want the Notification to be triggered when some Events have not been run yet, but the time period has expired.
To create multi-event Notifications, repeat the steps above to add more Events.
To specify which Events should be triggered when a Notification is created, you can add one or more filters.
To add a filter to an existing Event:
- Click Filter next to the relevant Event.
- Click Add filter.
- Select the property you wish to filter on. The list of available properties will vary depending on the Event.
- Choose 'is equal to' or 'is not equal to'.
- Specify the value. Depending on the filter property, this can be a text field for you to enter a value, or a drop-down list of restricted values.
- To add more criteria to the filter, click Add filter and complete steps 3-5.
- Click Apply to save changes.