All Products
Search
Document Center

DataWorks:Create and manage report templates

Last Updated:Aug 16, 2023

You can dynamically configure report templates on the Report Template Management page. Data Quality can generate and send reports based on a report template as scheduled.

Prerequisites

DataWorks Enterprise Edition or a more advanced edition is activated so that you can use the report template management feature.

Create a report template

  1. Log on to the DataWorks console. In the left-side navigation pane, choose Data Governance > Security Center. On the page that appears, click Go to Security Center.

  2. In the left-side navigation pane, choose Configuration > Report Template Management.

  3. Click Create Report Template.

  4. On the Create Report Template page, configure the parameters.

    Section

    Parameter

    Description

    Basic Settings

    Name

    The name of the report template.

    Sending Cycle

    Valid values: Every Day, Every Week, Every Month, and Do Not Send.

    If you select Every Week or Every Month, you must specify the specific day.

    Timespan

    The number of days that have elapsed before the current day. The maximum value of this parameter is 30.

    Statistics of Rule Configuration

    You can select metrics based on your business requirements.

    Offline data

    Offline monitoring coverage indicates the ratio of tables that are configured with data quality monitoring rules to all tables in a workspace. The metrics include Table count, Partition expression count, Count of rule on offline data, and Rule coverage on tables.

    Statistics of Rule Execution

    You can select metrics based on your business requirements. Quality reports display the selected metrics in charts.

    Offline data

    The metrics are classified into the following types: About rules, About partitions, and About tables.

    Subscriptions

    Notification Method

    DataWorks sends report notifications to subscribers by using emails.

    Recipient

    The recipient of report notifications. You can add multiple recipients.

    Actions

    You can modify or delete subscriptions that you have added.

    Add Subscription

    Click Add Subscription and configure a subscription.

  5. 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 the report template.

      Note

      If report subscribers view reports in emails, they can view the reports only in tables. If report subscribers view reports on the Data Quality page, they can view the reports in tables or charts.

    • Click Cancel in the upper-right corner. In the Confirm message, click OK to cancel the creation of the report template.

Manage a report template

After a report template is created, the Report Template Management page appears. On this page, you can view the details of the report template. You can also perform the following operations:

  • Find the required report template and click Edit. On the Edit Report Template page, modify the report template.

  • Find the required report template and click Delete. In the Confirm message, click OK to delete the report template.

  • Find the required report template and click View Report. Set the Query Range parameter and view related reports.

  • Add, modify, and delete subscriptions.

    • Add a subscription.

      1. Find the required report template and click Manage Subscriptions.

      2. In the Subscriptions dialog box, click Add Subscription.

      3. Select the required recipient and click Save.

      4. Click OK.

    • Modify a subscription.

      1. Find the required report template and click Manage Subscriptions.

      2. In the Subscriptions dialog box, find the required subscription and click Modify.

      3. Select the required recipient and click Save.

      4. Click OK.

    • Delete a subscription.

      1. Find the required report template and click Manage Subscriptions.

      2. In the Subscriptions dialog box, find the required subscription and click Delete.