DataWorks allows you to create, deploy, and use data quality wrappers based on your needs.


  1. Create a data quality wrapper.
    1. Log on to the DataWorks console.
    2. In the left-side navigation pane, click Workspaces.
    3. In the top navigation bar, select the region where the target workspace resides. Find the target workspace and click Data Analytics in the Actions column.
    4. On the DataStudio page, click Node Config in the top navigation bar. The Node Plugin list tab appears by default.
    5. In the left-side navigation pane, click Data quality plug-in list.
    6. On the Wrappers tab, click Create in the upper-right corner.
  2. Configure the wrapper in the wizard that appears. In the Settings step, set relevant parameters.
    Settings step
    Parameter Description
    Name The name of the data quality wrapper.
    Note The name must start with a letter, and can contain letters, underscores (_), and digits.
    Owner The owner of the wrapper. Select an owner from the drop-down list.
    Engine/data source type The compute engine or connection type to be used by the wrapper. You must first select Computing Engine or Data source and then select a compute engine or a connection type from the drop-down list.
    Check mode The check mode of the wrapper. Set this parameter to Off-line check.
    Resource File The resource file that defines the functionality of the wrapper. You can use one of the following methods to specify a resource file: Upload a local file and Use an OSS object.

    Click Select File. In the Select File dialog box, select a method, complete corresponding configurations, and then click OK.

    Class Name The full path of the class for implementing the wrapper.
    Parameter Example The parameters that are designed based on the specified resource file.
    Version The version of the wrapper. In this example, select Create Version 1. When you are editing or rolling back a version, select Overwrite Version.
    Description The description of the wrapper.
  3. Click Save and then Next.
  4. In the Deploy in Development Environment step, confirm the configurations and click Deploy in Development Environment.
    Wait until a message appears indicating that the wrapper has been deployed to the development environment. Click Next. The Test in Development Environment step appears.
  5. Test the wrapper in the development environment.
    1. In the Test in Development Environment step, set relevant parameters on the left.
      Parameter Description
      Sampling method The method to be used for data sampling.
      Storage Engine/data source The compute engine or data store where the data to be sampled resides.
      Table GUID The globally unique identifier (GUID) of the table where the data to be sampled resides. Example: database.table.
      Partition name The name of the partition where the data to be sampled resides.
      Field name The name of the field to be sampled.
      Filter condition The filter condition. Enter the condition that is specified by the WHERE clause. Do not enter the WHERE keyword.
      Custom SQL A custom SQL statement.
    2. Click Test.
    3. Confirm the test result and select the Test Passed check box.
    4. Click Next.
  6. In the Deploy in Production Environment step, click Deploy to production environment. The real-time deployment progress appears.
  7. Wait until the deployment is completed. Click Complete. The Node Plugin list tab appears.
    The information about the wrapper you created appears on this tab. You can perform the following operations on the wrapper:
    • Click Settings to configure the wrapper. After you click Settings, you are navigated to a step in the configuration wizard of the wrapper. Which step you are navigated to depends on existing configurations of the wrapper.
    • Click View Versions to view the version information about the wrapper. After you click View Versions, the View Versions dialog box appears. You can perform the following operations on each version:
      • View: View the basic information about the current version.
      • Roll Back: Roll back the wrapper from the current version to the previous version. After you click this button, the Roll Back dialog box appears. Click OK.
      • Download: Download the resource file of the current version.
    • Click Delete to delete the wrapper. After you click Delete, the Delete Wrapper message appears. Click OK.