Adding dataset alerts
This section shows you how to configure dataset alerts.
Steps
- Sign in to Collibra Data Quality & Observability.
- On the left sidebar navigation, click Alerts, then select Alert Builder. The Alert Builder page opens.
- Search for your dataset, or select one from either the App Frequent Runs: section below the search bar or from the App Recent Runs list. The dataset you selected displays. You can now view, create, and edit alerts for this dataset.
- In the upper right corner, click Add Alert +. The Add Alert dialogue appears.
- From the Add Alert dialogue, select an option and then click Next.
Depending on the option you select, the Condition Alert, Job Status Alert, or Rule Status Alert modal appears. - Enter the required information for the option you select.
- Condition Alert
- Job Status Alert
- Rule Status Alert
- score < 75
- daysWithoutData > 1
- rc = 0
- Rule name
- Rule condition
- Total number of points to deduct from the quality score when breaking
- Percentage of records that are breaking
- Number of breaking records
- Assignment Status
- Job Completion
- Select this option to generate an alert when a job run completes for the selected dataset.
- Job Failure
- Select this option to generate an alert when a job run fails.
- Breaking
- Select this option to generate an alert when a rule is breaking.
- Exception
- Select this option to generate an alert when a rule is throwing an exception.
- Passing
- Select this option to generate an alert when a rule is passing.
-
Click Save.
A condition alert generates an alert when the user-defined condition is satisfied during a dataset run.
Option | Description |
---|---|
Alert Name | The name of the alert for the selected dataset. |
Dataset | The name of the dataset. This field cannot be edited. |
Condition |
The user-defined condition that triggers an alert to send when its criteria are met during a dataset run. You can specify conditions such as: |
Batch | Select the checkbox option to create a batch alert to multiple recipients. When this option is enabled, the Batch Name field appears and the Alert Recipient field locks automatically. |
Batch Name
|
Enter a batch name to send the alert to multiple recipients. To search for an existing batch name, enter its characters into the Batch Name field to populate a dropdown list containing all available matches. Note This option is only available when the Batch option is enabled. |
Add Rule Details |
Enter the name of your rule in the Condition field to include the following details of your rule in the email: Note Add Rule Details is unavailable by default. When you enter the name of a rule in the Condition field, this option becomes available. |
Email Batch Trigger | Select the checkbox option to create a batch alert to multiple recipients. When this option is enabled, the Batch Name field appears and the Alert Recipient field locks automatically. |
Batch Name
|
Enter a batch name to send the alert to multiple recipients. To search for an existing batch name, enter its characters into the Batch Name field to populate a dropdown list containing all available matches. Note This option is only available when the Batch option is enabled. |
Alert Recipient |
The email address where alerts will send. You can specify either a single recipient or multiple. Note When you specify multiple email addresses, ensure that you also fill out the Batch Name field. Multiple recipients are specified by comma (,) and/or semicolon (;) delimiters. The accepted formats for email are "[email protected]" OR "[email protected],[email protected]" OR "[email protected];[email protected]". Tip When the batch option is enabled, the Alert Recipient field locks automatically. You can click the to the right of the Alert Recipient field to unlock it and edit the alert recipients. |
Custom Msg | A custom message relevant to the alert. |
A job status alert generates an alert when a job run completes.
Option | Description |
---|---|
Alert Name | The name of the alert for the selected dataset. |
Dataset | The name of the dataset. This field cannot be edited. |
Job Alert Status |
|
Batch | Select the checkbox option to create a batch alert to multiple recipients. When this option is enabled, the Batch Name field appears and the Alert Recipient field locks automatically. |
Batch Name
|
Enter a batch name to send the alert to multiple recipients. To search for an existing batch name, enter its characters into the Batch Name field to populate a dropdown list containing all available matches. Note This option is only available when the Batch option is enabled. |
Alert Recipient |
The email address where alerts will send. You can specify either a single recipient or multiple. Note When you specify multiple email addresses, ensure that you also fill out the Batch Name field. Multiple recipients are specified by comma (,) and/or semicolon (;) delimiters. The accepted formats for email are "[email protected]" OR "[email protected],[email protected]" OR "[email protected];[email protected]". Tip When the batch option is enabled, the Alert Recipient field locks automatically. You can click the to the right of the Alert Recipient field to unlock it and edit the alert recipients. |
Custom Msg | A custom message relevant to the alert. |
A rule status alert generates an alert when a rule is breaking, passing, and/or has an exception.
Option | Description |
---|---|
Alert Name |
The name of the alert for the selected dataset. Important If the name of your alert already exists, the new alert will replace the existing one. |
Dataset | The name of the dataset. This field cannot be edited. |
Rule Status Triggers |
You can select one or more of the following options: |
Email Batch Trigger | Select the checkbox option to create a batch alert to multiple recipients. When this option is enabled, the Batch Name field appears and the Alert Recipient field locks automatically. |
Batch Name
|
Enter a batch name to send the alert to multiple recipients. To search for an existing batch name, enter its characters into the Batch Name field to populate a dropdown list containing all available matches. Note This option is only available when the Batch option is enabled. |
Alert Recipient |
The email address where alerts will send. You can specify either a single recipient or multiple. Note When you specify multiple email addresses, ensure that you also fill out the Batch Name field. Multiple recipients are specified by comma (,) and/or semicolon (;) delimiters. The accepted formats for email are "[email protected]" OR "[email protected],[email protected]" OR "[email protected];[email protected]". Tip When the batch option is enabled, the Alert Recipient field locks automatically. You can click the to the right of the Alert Recipient field to unlock it and edit the alert recipients. |
Custom Msg | A custom message relevant to the alert. |