DataWorks:Use extensions

Step 1: Go to the Extensions page in Open Platform

On the Extensions page, you can view the registered extensions.

1. Go to the Open Platform page.

   Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose More > Open Platform. The Developer Backend tab appears.

2. View the details of the extension.

   In the left-side navigation pane of the page that appears, click Extensions. The Extensions page appears. Find the extension that you want to publish and click Details in the Actions column to view the details of the extension.

Step 2: Test the extension

After an extension is registered, it is in the Testing state by default. Extensions in the Testing state can take effect in the following scenarios without the need to be published.

• Tenant-level extension point events

  The owner of an extension can enable the extension in Management Center. The extension takes effect only for the operations that are performed by the extension owner. For more information, see Step 2: Enable an extension in this topic.

  For example, an extension that is used to check data download operations is in the Testing state. After the owner of the extension enables the extension in Management Center, the extension can be triggered to check a data download operation that is performed by the owner and suspend the operation until the extension returns the processing result to DataWorks.

• Workspace-level extension point events

  Extensions that are used to check workspace-level extension point events take effect only in the workspaces that are specified when you register the extensions. For information about how to view the test workspace for an extension, see View the details of the extension in this topic.

Before you publish the extension that you want to use to check specific extension point events, you must enable and test the extension in the test workspace. The test consists of the following phases: DataWorks sends event messages, the extension receives and processes event messages, and the extension returns the processing result to DataWorks.

Step 3: Publish the extension

If the extension works as expected after the test, go to the details page of the extension by performing the operations in Step 1. On the Extensions page, click Submit in the Actions column of the extension to submit the extension to DataWorks for review. After the extension passes the review, choose More > Publish in the Actions column to publish the extension.

Step 4: Manage the status of the extension

On the Extensions page in Open Platform, you can find an extension and click Details, Modify, Submit, Publish, Disable, or Delete in the Actions column to perform the related operation on the extension. The Status column displays the status of the extension.

• Testing: By default, extensions that are registered but not published and extensions that are unpublished are in the Testing state. Extensions in the Testing state can be enabled only for the test workspaces.

• Reviewing: After you click Submit for an extension in the Testing state, the extension enters the Reviewing state. The status of the extension that is approved by DataWorks Open Platform changes to Approved. The extension can be published only if the extension is approved. If the extension fails the review, the status of the extension changes to Approval Failed.

• Published: After you click Publish in the Actions column, the status of the extension changes to Published. After the extension is published, the extension can be used in all workspaces to which the extension is applicable. The workspace administrator can view and enable the extension on the Management Center page of each workspace.

• Disabled: To disable an extension, click Disable in the Actions column. After you disable an extension, the extension becomes invalid and the related events are no longer checked or blocked in the workspaces.

• Expired: The status of an extension changes to Expired after DataWorks Enterprise Edition expires. Extensions in the Expired state become invalid and are similar to extensions in the Disabled state.

Step 1: Go to the Extension page in Management Center

1. Go to the Management Center page.

   Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose More > Management Center. On the page that appears, select the desired workspace from the drop-down list and click Go to Management Center.

2. View the extensions that you can enable.

   In the left-side navigation pane of the SettingCenter page, click Extension in the Tenant Settings section. On the Extension page, you can view the extensions that you can enable.

Step 2: Enable an extension

The check scope of an extension varies based on the level of the extension.

• Alibaba Cloud accounts, RAM users to which the AliyunDataWorksFullAccess policy is attached, and tenant administrators can enable extensions that are used to check tenant-level extension point events. After an extension is enabled, the extension can be used to suspend the operations that are performed in all workspaces until the extension returns the processing result to DataWorks.

• Workspace administrators can enable extensions that are used to check workspace-level extension point events. This type of extension can be enabled only after the workspace for which the extension takes effect is specified. After the extension is enabled, the extension can be used to suspend the operations that are performed in the workspace until the extension returns the processing result to DataWorks.