Interested in getting early access? Let us know!
An agreement is a contract between stakeholders that stipulates the expected and agreed-upon state of data quality in a data source.
Use SodaCL checks to define the state of “good quality” for data in this data source, then identify and get approval from stakeholders in your organization. Define whom Soda Cloud will notify when a check in this Agreement fails, then set a schedule to regularly execute the Soda Checks to uphold the tenets of the agreement.
- You have created a Soda Cloud account.
- You, or an Admin on your Soda Cloud account, has added a new datasource in your Soda Cloud account.
- (Optional) An Admin on your Soda Cloud account has integrated with Slack to enable Soda Cloud to send Slack notifications to your team. If you do not use Slack, Soda Cloud can send notifications via email.
For a new agreement, you define several details including which data to check, what checks to execute during a scan, and whom to notify when bad data triggers an alert.
In Soda Cloud, navigate to the Agreements dashboard, then click New Agreement. Follow the guided steps to complete the new agreement. Use the sections below for insight into the values to enter in the fields and editing panels in the guided steps. .
|Field or Label||Guidance|
|Agreement Label||Provide a name for your agreement.|
|Data Source||Select the data source to which your agreement applies. See Create a data source.|
Use SodaCL to define the checks that Soda Cloud executes on a regular schedule to uphold the tenets of this agreement. If any of these checks fail during a regularly-scheduled scan, Soda Cloud notifies the stakeholders you specify in the Notifications section.
For help writing your first checks, consider following the Quick start for SodaCL.
Add Stakeholders to this Agreement who have an interest in maintaining or using the good-quality data in this data source.
Soda Cloud sends emails to request review and approval from all stakeholders, but does not prevent Soda Cloud from running scans and executing checks in the agreement if not all stakeholders have approved the agreement.
By default, Soda Cloud includes an out-of-the-box email notification to all the agreement’s stakeholders when a check in your agreement fails. You can remove or adjust this notification, or use the search bar to add more. Access Scan output to learn more about pass, warn, and fail check results.
If you have integrated your Soda Cloud account with Slack, use the search field to type a channel name to add the channel as a notification recipient. Alternatively, use the field to enter names of individual teammates with whom you collaborate in Soda Cloud.
Note that Soda Cloud does not send an email or Slack notification when a scan fails because of an error, only when checks pass, warn, or fail. Refer to Scan output for details.
After you have set up a new agreement, Soda Cloud sends approval requests to the stakeholders you identified in step 3. When stakeholders approve or reject your agreement, Soda Cloud sends you an email notification.
Regardless of the approval status of the agreement, however, Soda Cloud begins running scans of your data according to the scan schedule you set. Soda Cloud sends notifications after each scan according to the settings you defined in step 4.
(Optional) You can create a new scan definition if you wish to run a scan to execute the checks in this agreement more or less frequently, or a different time of day, relative to the default scan definition for the data source.
To review existing scan definitions, navigate to your avatar > Scans & Data > Scan Definitions tab.
- Navigate to the Agreements dashboard, then click the stacked dots at the right of the agreement you wish to edit and select Edit Agreement.
- Navigate the tabs to locate the details you wish to change.
- When you Save, Soda Cloud sends new approval request emails to all the agreement’s stakeholders. The next scheduled scan applies your changes, regardless of stakeholder approval status.
- Complete the Quick start for SodaCL to learn how to write a few simple checks for data quality.
- Learn more about creating and tracking Soda Cloud Incidents.
- Need help? Join the Soda community on Slack.
Was this documentation helpful?
What could we do to improve this page?
Last modified on 10-Aug-22