After an extension is developed and deployed, you can test the extension on the Extensions tab in the DataWorks console. If the extension passes the test, you can publish the extension. Then, workspace administrators can enable the extension for workspaces as needed. This topic describes how to test, publish, and enable an extension.

Prerequisites

  • The message subscription feature is enabled, a custom extension is registered, and the information that is required to develop the extension is obtained. For more information, see Make preparations.
  • An extension is developed and deployed. For more information, see Develop and deploy a custom extension.

Background information

When you register an extension, you specify a test workspace for the extension. After the extension is developed and deployed, you can enable and test the extension in the specified workspace. If the extension passes the test, you can publish the extension. Then, workspace administrators can enable the extension for workspaces as needed.
  1. For more information about how to test an extension, see Test an extension.
  2. For more information about how to publish an extension, see Publish and manage an extension.
  3. For more information about how to enable an extension, see Enable an extension.

Test an extension

  1. View the test workspace.
    Log on to the DataWorks console. In the left-side navigation pane, click Open Platform. On the Open Platform page, click the Extensions tab. Find the extension that you want to test and click Details in the Actions column to view the test workspace. Workspace for testing
  2. Go to the Configuration page of the test workspace.
    1. Log on to the DataWorks console. In the left-side navigation pane, click Workspaces.
    2. On the Workspaces page, find the test workspace and click Workspace Settings in the Actions column. In the Workspace Settings panel, click More in the lower-left corner to go to the Configuration page.
  3. Enable the extension.
    In the left-side navigation pane, click Extension configuration. On the Extension configuration page, find the extension that you want to test and turn on the switch in the Enable column. In the Grant Permissions to Extension dialog box, select the check box and click Confirm. Enable the extension
  4. Test the extension.
    In the test workspace, trigger a subscribed event to test whether the extension performs and generates a check result as expected.
    For example, if the extension applies to node commitment events, you can commit a node on the DataStudio page of the test workspace to test whether the extension is triggered to check the event. File commitmentFor more information about the check processes for different types of extension point events, see Trigger event checking during data development.

Publish and manage an extension

After an extension passes the test, you can publish the extension. Then, workspace administrators can enable the extension for workspaces as needed.

On the Extensions tab of the DataWorks open platform, you can click Publish in the Actions column to publish an extension that has been tested and approved by the DataWorks open platform. PublishOn the Extensions tab, you can also view the extension status, check extension details, and disable or delete an extension. Before an extension is published, you can edit the extension as needed.
An extension can be in one of the following states:
  • 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.
  • Approving: After you click Commit, the extension is in the Approving state. The status of the extension that is approved by the DataWorks open platform is changed to Approved. The extension can be published only if the extension is approved. If the extension failed to be approved, the state 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 administrator can view and enable the extension on the workspace configuration page.
  • Disabled: To disable an extension, click Disabled in the Actions column. After an extension is disabled, the extension becomes invalid. In this case, related events are not checked or blocked in the workspaces for which the extension is enabled.
  • Expired: The state of an extension changes to Expired after the DataWorks Enterprise Edition expires. Extensions in the Expired state become invalid and are similar to extensions in the Disabled state.

Enable an extension

After an extension is published, a workspace administrator can determine whether to enable the extension for a specific workspace based on the extension details that can be obtained by checking the Extensions tab and consulting the person in charge of the extension. After the extension is enabled for the workspace, DataStudio events of the types that are specified in the registration information are managed by the extension. To enable an extension, perform the following steps:

  1. Go to the Configuration page of the workspace for which you want to enable the extension.
    1. Log on to the DataWorks console. In the left-side navigation pane, click Workspaces.
    2. On the Workspaces page, find the workspace for which you want to enable the extension and click Workspace Settings in the Actions column. In the Workspace Settings panel, click More in the lower-left corner to go to the Configuration page.
  2. Enable the extension.
    In the left-side navigation pane, click Extension configuration. On the Extension configuration page, find the extension that you want to enable for the workspace and turn on the switch in the Enable column. In the Grant Permissions to Extension dialog box, select the check box and click Confirm. Enable the extension
    Note If you need to configure options for your extension, you can click Settings before you enable the extension.