Report templates define the metrics, delivery schedule, and recipients for automated data quality reports. Data Quality generates and sends reports on schedule based on the template.
Prerequisites
Before you begin, ensure that you have:
-
DataWorks Enterprise Edition or a higher edition activated
Create a report template
-
Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Governance > Data Quality. Select the desired workspace from the drop-down list and click Go to Data Quality.
-
In the left-side navigation pane, choose Quality Analysis > Quality Report.
-
Click Create Report Template.
-
On the Create Report Template page, configure the following parameters.
Name
Enter a name for the report template.
Sending Cycle
Select how often to send reports:
-
Every Day — Reports are sent at 11:05 every day by default.
-
Every Week — You must select the specific day of the week to send.
-
Every Month — You must select the specific day of the month to send.
-
Do Not Send — Save the template without scheduling delivery.
Timespan
The number of days before the current day to include in the report. The maximum value is 30.
Statistics of Rule Configuration
Select the metrics to include in the report. Metrics are grouped by data type:
-
Offline data: Table count, Partition expression count, Count of rule on offline data, Rule coverage on tables (the ratio of tables configured with data quality monitoring rules to all tables in the workspace).
-
Realtime data: Topic count, Count of rule on realtime data, Count of rule on cut off data, Rule coverage on topic, Count of rule on delayed data, Count of customized rule.
Statistics of Rule Execution
Select the execution metrics to display as charts in the report:
-
Offline data: About rules, About partitions, About tables.
-
Realtime data: About messages, About alarms, About cut-offs.
Subscriptions
Parameter Description Notification Method DataWorks sends report notifications to subscribers by email. Recipient The recipient of report notifications. You can add multiple recipients. Actions You can modify or delete subscriptions that you have added. Click Add Subscription, select the required recipient, and click Save.
-
-
Click Save in the upper-right corner. After saving, you can:
-
Click Preview to check the report layout. Recipients who view the report by email see it in table format only; recipients who view it on the Data Quality page can see it in table or chart format.
-
Click Cancel, then click OK in the Confirm dialog to discard the template.
-
Manage report templates
After creating a template, the Report Template Management page lists all templates. From this page you can:
| Action | Steps |
|---|---|
| Edit | Click Edit next to a template to open the Edit Report Template page and modify the configuration. |
| Delete | Click Delete next to a template, then click OK in the confirmation dialog. |
| View reports | Click View Report, set the Query Range, and view the generated reports. |
Manage subscriptions
From the Report Template Management page, click Manage Subscriptions next to a template to open the Subscriptions dialog box.
Add a subscription
-
Click Add Subscription.
-
Select the required recipient and click Save.
-
Click OK.
Modify a subscription
-
Find the subscription and click Modify.
-
Select the required recipient and click Save.
-
Click OK.
Delete a subscription
-
Find the subscription and click Delete.