Creating notifications
You can access the Notification Center
from Space Management, Dashboards, Designer, and Visualizer. The Notification
Center and the Notification form is the same across each
module of Birst. This information and steps can be used across each module.
-
Select Notifications from Space
Management or click the Notifications
icon in Dashboards, Designer, or Visualizer to navigate to the Notification
Center.
The Notification Center lists the existing notifications for that space that were created in Space Management, Designer, and Visualizer.
- Click + Create New Notification to create a new notification.
-
Specify this information for the new notification:
- Notification Name
- This displays as the name in your Notification Center. It is not visible in the sent email. Click the Edit icon to specify the Notification name.
- From
- The contact address to send the notification from.
- To
- Depending on your account settings, you can select User, Email, or Report
Driven.
- User
- Add the Birst user accounts in the space you would like to send the notification to. If Infor Document Management is enabled for your space, the users will receive en email stating a new attachment is available in IDM. You can use the Add Users field to search for and add users.
- Enter the email addresses you would like to send the notification to. When sending this email to multiple addressees, separate emails with a semicolon and no spaces. For example, MyBoss@myCo.com;Me@myCo.com.
- Report Driven
- The recipients of a scheduled Designer report can be determined by the result set of a report. Use the Search Reports field to find the report containing the recipients. A report for report-driven distribution must contain a table and no chart, where the logical name of the first column in the report is Email and contains the email addresses of the recipients (multiple values need to be separated by a semicolon). The logical name of the column must be "Email". It's not sufficient to rename the column in the report.
- Subject
- This is the email subject line.
- Message
- This is the email body. Add variables using the V{variable_name} syntax.
- Repeats
- Select the frequency to send the email. You can select Hourly, Daily, Weekly, Monthly.
- Every
- Note: This option only displays if the Repeats is Hourly.Select the hourly frequency to schedule the notification.
- On
- Note: This option only displays if the Repeats is Weekly.Set the weekly cadence to schedule the notification. You select a day of the week or multiple days of the week for your weekly cadence.
- Starting at
- Specify the time and time zone for when to send this email.
- Starts On/Ends On
- A start and/or end date for the notification. These fields are
empty by default. You can specify both a start and end date or just one
date. If you select a weekly cadence, you must specify a start date. If
there is a start date specified but no end date, Birst runs from the start
date until the user manually changes the schedule or disables the
notification. If there is an end date but no start date, the notification
runs on the cadence you specified until the end date is met. Note: You are restricted from setting the start date as today's date. It must be tomorrow's date or later.
- Set schedule based on a Workflow trigger
- Set this to attach the notification to a workflow trigger you already configured for this space. See Setting notification schedule based on a Workflow trigger
- Set schedule based on conditions
- Set this to run the notification on a schedule and check if a condition is met and only then is the notification sent. See Condition-based alert notifications for information on setting this for your notification.
- Report
- Note: This section varies depending on which module you are using the Notification Center.Select the report, dashboard, designer report, or visualizer report to apply this notification to.You can use the Search Reports field to search for the report you want to attach. You can also click the Folder icon to open the Report Catalog.Note: Not all report types are available to add to your notification depending on what module you are using.
Notifications can be created with the filters that are applied to a given report. Filters can use repository variables to dynamically display data for your notifications. For example, you might use a repository variable for yesterday's date to show the finalized sales numbers for the previous day. If you select a report that has applied filters, you can click the Filter icon to view those filters. You can only use the Filter icon if a filter exists on the report.
- Include details
- Set this to include details in the notification such as Collection Name, Dashlet Name, Timestamp, and Filters.
- Receive enhanced notification details via email
- If enabled, the notification creator(s) receive detailed information on the status of each instance of this specific notification.
- Limit failure alerts to only creator
- If enabled, only the creator of the notification receives an alert if the notification fails.
- Attachment Format
- Select the format type for the report. Note: The available attachment formats are based on where you are creating the notification from, such as Space Management or Designer.
- Attachment Name
- The name of the attached document.
- File Compression
- Select either Zip or Gzip to attach the document as a compressed file.
- Trigger Report
- You can specify a trigger report that controls whether or not the email with the content report is sent to the distribution list. This trigger report must contain a table only and no chart. Email messages with the content report are sent to the recipients only if the trigger report returns a result set. For example, you could set up a trigger report to return results only if a certain measure falls below a threshold value.
- Click Save. The notification is now listed in the Notification Center.