Configure monitoring report templates

更新时间:
复制 MD 格式

On the Report Template Management page, you can configure report templates. Data Quality then generates and sends reports periodically based on these templates.

Prerequisites

The report template management feature is available only in DataWorks Enterprise Edition or later.

Create a report template

  1. 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. On the page that appears, select the desired workspace from the drop-down list and click Go to Data Quality.

  2. In the left-side navigation pane, choose Quality Analysis > Quality Reports.

  3. Click Create Report Template.

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

    Section

    Parameter

    Description

    Basic Settings

    Name

    Enter a name for the report template.

    Sending Cycle

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

    • If you select Every Day, reports are sent at 11:05 each day by default.

    • If you select Every Week or Every Month, you must specify a time.

    Data Scope

    Specify the number of days of historical data (up to 30) to include in the report.

    Rule Configuration Details

    Select the metrics you want to include in the report.

    Offline

    Includes table count, partition expression count, offline quality rule count, and monitoring coverage.

    Note

    Monitoring coverage is the percentage of tables in a workspace that are covered by configured quality rules.

    Real-time

    Includes topic count, realtime quality rule count, cut-off rule count, monitoring coverage, delay rule count, and custom rule count.

    Rule Execution Details

    Select the metrics to view. These metrics are displayed as charts in the report.

    Offline

    Includes Rule Chart, Partition Chart, and Table Chart.

    Real-time

    Includes Message Chart, Alert Chart, and Cut-off Chart.

    Manage Subscriptions

    Notification Method

    You can configure email notifications for the subscription.

    Alert Contact

    Select the notification recipients. You can add multiple recipients.

    Actions

    You can Edit or Delete existing subscriptions.

    Add Subscription

    Click Add Subscription to configure a new subscription.

  5. After configuring the template, click Save in the upper-right corner to create it.

    You can also perform the following operations:

    • Click Preview in the upper-right corner to preview the report.

      Note

      Email reports are tabular only. On the Data Quality page, reports can be viewed as either tables or charts.

    • Click Cancel in the upper-right corner. In the Confirm dialog box, click Confirm to confirm the cancellation.

Manage report templates

After you create a report template, you return to the Report page. From here, you can view template details or perform the following operations:

  • To modify a report template, click Edit next to it. This opens the Edit Report Template page.

  • Click Delete next to the report template. In the Confirm dialog box, click Confirm to confirm the deletion.

  • Click View Report next to a template to open its report, where you can then adjust the Query Range.

  • Add, modify, or delete a subscription:

    • Add a subscription

      1. Click Manage Subscriptions next to the report template.

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

      3. Select a Alert Contact and click Save.

      4. Click Confirm.

    • Modify a subscription

      1. Click Manage Subscriptions next to the report template.

      2. In the Manage Subscriptions dialog box, find the subscription to modify and click Edit in the Actions column.

      3. Select a new Alert Contact and click Save.

      4. Click Confirm.

    • Delete a subscription

      1. Click Manage Subscriptions next to the report template.

      2. In the Manage Subscriptions dialog box, find the subscription to remove and click Delete in the Actions column.