Managing Dimension Tasks and Instances¶

In Metric Management, when a dimension table configured with Sync from Data Catalog or Sync from Database synchronization method is published, a dimension task will be created, and a task instance will be generated every time the dimension table is synchronized.

Note

After a dimension table is unpublished, the corresponding dimension tasks will also be deleted automatically.

Prerequisites¶

Before you start, ensure the following:

The current account has been assigned a menu group including Task Operation. If not assigned, contact the application administrator.
The dimension table has been configured with Sync from Data Catalog or Sync from Database synchronization method, and the dimension configuration has been published.

Dimension Tasks¶

Viewing the Dimension Task List¶

Select Task Operation in the left navigation bar, which goes to the Dimension Task tab by default.
Pull down the drop-down box on the upper left corner of the page to switch between Periodical and Manual to view the list of dimension tasks under different synchronization types.

Pre-Running a Dimension Task¶

You can pre-run a dimension task in advance to verify the accuracy of the data synchronized to the dimension table.

Select Task Operation in the left navigation bar, which goes to the Dimension Task tab by default.
Select Periodical or Manual from the drop-down box in the upper left corner of the page, and then select Pre-Run at the end of the target dimension task row.
After selecting the time for pre-running the dimension task in the pop-up window, select OK.

After pre-running the dimension task, you can select View Instances view_instances_icon at the end of this dimension task row to view instance information and logs.

Starting a Dimension Task¶

Metric Management only supports starting the periodical dimension tasks.

After pre-running a dimension task for periodical synchronization successfully, you can start the dimension task to the synchronize data from the data source according to the set effective time and generate dimension task instances. For more information about periodical synchronization, see Syncing from Data Catalog > Synchronization or Syncing from Database > Synchronization.

Select Task Operation in the left navigation bar, which goes to the Dimension Task tab by default.
Select Periodical from the drop-down box in the upper left corner, and then select Start at the end of the target dimension task row.

After the dimension task is started, Running is displayed in Status. You can select View Instances view_instances_icon at the end of this dimension task row to view instance information and logs.

Stopping a Dimension Task¶

You can stop a dimension task if you need to modify the configuration information in the dimension table for which a synchronization method has been configured，or if you determine the dimension task instance is abnormal. The dimension task can be restarted after the modified information is published or the problem is resolved.

Select Task Operation in the left navigation bar, which goes to the Dimension Task tab by default.
Select Periodical from the drop-down box in the upper left corner, and then select Stop at the end of the target dimension task row.

If a dimension task instance is running when you select Stop, that instance can still run until the end. But after that, on the set effective date of the periodical synchronization, the dimension task is no longer triggered automatically.

Configuring an Alarm for a Dimension Task¶

You can monitor the status of the synchronization dimension task by configuring an alarm for it. If the synchronization task runs abnormally, the corresponding user is notified by e-mail.

Select Task Operation in the left navigation bar, which goes to the Dimension Task tab by default.
Pull down the drop-down box in the upper left corner of the page to switch between Periodical and Manual.
Select Configure Alarm at the end of the target dimension task row in the current list, and enter the following information in the pop-up window:
- Notification Method: The alarm is sent by E-mail by default.
- Recipient: Select one or more user accounts under the current OU as the recipient(s).
- Notification Configuration: Select an application created or obtained under the current OU as the push application. You can configure the push application using Notification Management > Quota. For more information about quota management, see Quota Management.
Click OK to complete the alarm configuration.

Dimension Task Instances¶

Viewing Dimension Task Instances¶

Select Task Operation in the left navigation bar, which goes to the Dimension Task tab by default.
Pull down the drop-down box on the upper left corner of the page to switch between Periodical and Manual.
In the current dimension task list, select View Instances at the end of the target dimension task row to go to the instance list page.
After filtering the time range in the upper left corner of the page, you can view information about task instances in the list.

Downloading Running Logs¶

Select Task Operation in the left navigation bar, which goes to the Dimension Task tab by default.
Pull down the drop-down box on the upper left corner of the page to switch between Periodical and Manual.
In the dimension task list, select View Instances at the end of the target dimension task row to go to the instance list page.
In the current time range, select Download Log at the end of the task instance line to download the instance running logs.

Restarting a Task Instance¶

Select Task Operation in the left navigation bar, which goes to the Dimension Task tab by default.
Pull down the drop-down box on the upper left corner of the page to switch between Periodical and Manual.
In the dimension task list, select View Instances at the end of the target dimension task row to go to the instance list page.
In the current time range, select Restart at the end of the row for the task instance that failed to run to resynchronize the data under this instance.