DataWorks:Manage and use extensions

Step 1: Go to the Extensions page

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

1. Log on to the DataWorks console. In the target region, click More > Open Platform in the left-side navigation pane. Click Go to Open Platform to open the Developer Backend page.

2. View extension details.

   On the Developer Backend page, click Extensions to go to the Extensions page. Find the extension you want to publish and click Details in the Actions column to view its configuration.

Step 2: Test the extension

After an extension is registered, it enters the Testing state by default. In this state, the extension can be tested in specific scenarios without being published.

• Tenant-level extension events

  The extension's owner can enable it in Administration. In the Testing state, the extension applies only to operations performed by the owner. For more information, see Step 2: Enable the extension.

  For example, consider an extension in the Testing state that is designed to validate data download requests. After the owner enables it in Administration, when the owner attempts to download data, the extension intercepts the operation and pauses it until a validation result is returned.

• Workspace-level extension events

  If an extension point event is at the workspace level, the extension takes effect in the workspace specified during registration. To find the specified test workspace, see View extension details.

Before you publish the extension, enable the extension in the test workspace based on the event type it handles, and test the complete workflow including DataWorks sending messages, the extension receiving messages, and performing message review and callback.

Step 3: Publish the extension

After the extension passes testing, follow Step 1 to go to the extension details page on Open Platform, and click Submit in the Actions column to submit the extension for review by the DataWorks platform. After the review is approved, click Publish in the Actions column to publish the extension.

Step 4: Manage extension status

In the Open Platform, navigate to Developer Backend > Extensions. In the Actions column of the extension list, you can view Details, Modify, Submit, Publish, Disable, and Delete an extension. The Status column displays the current status of the extension:

• Testing: A newly registered extension is in the Testing state by default. A published extension that is taken offline also changes to the Testing state. An extension in the Testing state can only be used in the test workspace.

• Pending Approval: After you click Submit for an extension in the Testing state, its status changes to Pending Approval. If the review is approved, the status changes to Approved, and the extension can then be published. If the review fails, the status changes to Review Failed.

• Published: After you click Publish in the Actions column, the extension status changes to Published. After publication, all applicable workspaces can use the extension. Workspace administrators can view and enable it on the workspace configuration page.

• Disabled: After you click Disable in the Actions column, the extension status changes to Disabled. In this state, the extension is inactive, and triggered event workflows in workspaces that have enabled this extension will pass through directly without any checks or blocking.

• Expired: When your DataWorks Enterprise Edition subscription expires, the extension status changes to Expired. An extension in this state is inactive, similar to the Disabled state.

Step 1: Go to the Extensions page in Administration

1. Log on to the DataWorks console. In the target region, click More > Management Center in the left-side navigation pane. Select a workspace from the drop-down list and click Go to Management Center.

2. View extensions that can be enabled.

   In Administration, click Extensions in the left-side navigation pane to go to the Extensions page. This page displays extensions that can be enabled.

Step 2: Enable the extension

Extensions at different levels apply to different scopes after being enabled:

• Tenant-level extensions can only be enabled by Alibaba Cloud accounts, RAM users with the AliyunDataWorksFullAccess permission, or tenant administrators. After a tenant-level extension is enabled, all operations on the corresponding extension point across all workspaces are blocked until the extension returns a validation result.

• Workspace-level extensions can only be enabled by workspace administrators. To enable a workspace-level extension, you must specify the workspaces in which the extension takes effect. After the extension is enabled, all operations on the corresponding extension point in the specified workspaces are blocked until the extension returns a validation result.