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:

  1. Go to System.
  2. Select Notifications.
  3. Click Create new notification.
  4. Enter a descriptive name that's unique to this Space.
  5. (Optional) enter a description.

By default, all notifications are Enabled, meaning they will become 'active' as soon as you save changes.

Notification types

Each type refers to an action that Data Studio will perform once the notification is triggered:

  1. Send email - sends an email to one or more recipients with details of the event(s).
  2. Run one or more published Workflows - submits the specified Workflows for immediate execution.
  3. Run one or more Schedules - submits the specified Schedules for immediate execution.

Send email

  1. Enter the Recipient(s) email address. When using multiple addresses, separate them with a space, comma or semicolon.
  2. 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 (if it's not there, ensure that the Workflow has been published first). To run more than one, click Add Workflow.
Click Parameters to configure Workflow parameters. You can either assign a value manually or tick Use event data to select an event and its data as the parameter value, then 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. 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.

Events

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 for the Notification to be triggered.

To add an events:

  1. Click Add event.
  2. Select the required event.
  3. (Optional) enter the filter criteria (see below).
  4. 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).

  1. Select Trigger if expired if you want the notification to be triggered when some events haven't been run yet, but the time period has expired.

To create multi-event notifications, repeat the steps above to add more events.

Event filters

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:

  1. Select the required event and click Filter.
  2. Click Add filter.
  3. Select the property you wish to filter on. The list of available properties will vary depending on the event.
  4. Select either is equal to or is not equal to.
  5. 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.

  1. To add more criteria to the filter, click Add filter and repeat steps 2-5.
  2. Click Apply to save changes.

Event parameters

An event can have parameters attached to it. You can use event parameters within a notification:

  • as part an event filter
  • within the email subject or body when using an email notification
  • as a Workflow parameter when using the notification to run a Workflow

An event parameter can be populate in a Fire event step if the custom event assigned to the step contain a parameter.

Event parameters provide a facility for users to enter values into parameters according to their own needs, rather than using constant values. For example, specific Dataset batch metadata could be included as a parameter on the Fire event step of a Workflow in order to notify users about the number of records processed, or the number and type of errors detected.

To add event parameter(s):

  1. Go to System.
  2. Select Custom events.
  3. Choose a required event, click Options and select Edit details.
  4. Press + in the Parameters table.

To populate the event parameter:

  1. Create/edit a Workflow.
  2. Add a Fire event step if it doesn't exist.

  1. On the Fire event step, select the Custom event containing the defined parameter.
  2. Click the Parameter dropdown. You can type in a value manually, select Special characters or select First column value.

To use the parameter for filtering an event:

  1. Go to System.
  2. Select Notifications.
  3. Create/edit a notification.
  4. Choose the Custom event from the Events dropdown.
  5. Click the Filter button.
  6. Choose the parameter name in the Filters dropdown and assign the operation is equal to or is not equal to, as required.

To use parameters in an e-mail notification:

  1. Go to System.
  2. Select Notifications.
  3. Create/edit a notification.
  4. Select the Custom event containing the event parameter
  5. In the Notification type dropdown select Send email.
  6. In the Email subject/Email content, type @ followed by the Event parameter name (e.g. @MY_PARAMETER).

To use parameters for Workflow notifications:

  1. Go to System.
  2. Select Notifications.
  3. Create/edit a notification.
  4. Select the Custom event containing the event parameter
  5. In the Notification type dropdown select Run one or more published Workflows.
  6. In the Workflow(s) dropdown choose one with Workflow parameters.
  7. Click Parameters assign in the Workflow parameter
  8. Check Use event data and select the corresponding event parameter.