You can create a template of data quality reports on the Report Template Management page. Data Quality can periodically generate and send data quality reports based on the template.

Create a report template

  1. Log on to the DataWorks console.
  2. In the left-side navigation pane, click Workspaces.
  3. Select the region of the workspace, and click Data Analytics.
  4. On the DataStudio page that appears, click Icon in the upper-left corner and choose All Products > Data Quality.
  5. On the page that appears, choose Configuration > Report Template Management in the left-side navigation pane.
  6. On the Report Template Management page that appears, click Create Report Template.
  7. On the Create Report Template page that appears, set required parameters.
    Create a report template
    Section Parameter Descripton
    Basic settings Name The name of the report template.
    Sending Cycle The interval at which reports are sent. Valid values: Every Day, Every Week, Every Month, and Do Not Send.

    If you set Sending Cycle to Every Week or Every Month, you also need to specify the specific day on which reports are sent.

    Timespan The time range that you specify to collect data to generate reports, which equals the number of days that have elapsed before the current day. DataWorks generates reports based on the data of those days. The maximum value of this parameter is 30.
    Statistics of Rule Configuration

    The Statistics of Rule Configuration section displays metrics about rule configurations for tables and topics. You can select metrics based on your needs.

    Offline data The metrics about rule configurations for tables in the workspace. The metrics include Table count, Partition expression count, Count of rule on offline data, and Rule coverage on tables. The Rule coverage on tables metric indicates the ratio of tables for which quality monitoring rules are configured.
    Realtime data The metrics about rule configurations for topics in the workspace. The metrics include 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, and Count of customized rule. The Rule coverage on topic metric indicates the ratio of topics for which quality monitoring rules are configured.
    Statistics of Rule Execution

    The Statistics of Rule Execution section displays metrics about rule running for tables and topics. You can select metrics based on your needs. Quality reports display the selected metrics in charts.

    Offline data The metrics about rule running for tables in the workspace. The metrics are classified into the following types: About rules, About partitions, and About tables.
    Realtime data The metrics about rule running for topics in the workspace. The metrics are classified into the following types: About messages, About alarms, and About cut-offs.
    Manage Subscriptions Subscription Method The method used to notify report subscribers of new reports. Currently, DataWorks notifies report subscribers of new reports by email.
    Recipients The recipient of report notifications. You can add multiple recipients.
    Actions The operations that you can perform on the subscription. You can click Modify or Delete in the Actions column of a subscription to modify or delete the subscription.
    Add Subscription The button that allows you to add a subscription.
  8. Click Save in the upper-right corner. A template of data quality reports is generated.
    You can also perform the following operations:
    • Click Preview in the upper-right corner to view the display format of reports generated based on this template.
      Note If report subscribers view reports through email notifications, they can only view the reports in tables. If they view reports on the Data Quality page, they can view reports in tables or charts.
    • Click Cancel in the upper right corner. When the Are you sure you want to cancel the operation? message appears, click OK to cancel the creation of the report template.

Manage an existing report template

After you save a created report template, the Report Template Management page appears, where you can view the details about the report template. You can also perform the following operations on the report template:
  • Click Edit in the Actions column. On the Edit Report Template page that appears, you can modify the report template.
  • Click Delete in the Actions column. When the Are you sure you want to delete the report template? message appears, you can click OK to delete the report template.
  • Click View Report in the Actions column. On the page that appears, you can set Query Range and click Search to search for reports generated based on the report template.
  • Add, modify, and delete subscriptions to reports generated based on the report template.
    • Add a subscription.
      1. Click Manage Subscriptions in the Actions column.
      2. In the Subscriptions dialog box that appears, click Add Subscription.
      3. Select the desired recipient in the Recipient column and click Save in the Actions column.
      4. Click OK.
    • Modify a subscription.
      1. Click Manage Subscriptions in the Actions column.
      2. In the Subscriptions dialog box that appears, find the target subscription and click Modify in the Actions column.
      3. Select the desired recipient in the Recipient column and click Save in the Actions column.
      4. Click OK.
    • Delete a subscription.
      1. Click Manage Subscriptions in the Actions column.
      2. In the Subscriptions dialog box that appears, find the target subscription and click Delete in the Actions column.
      3. Click OK.