DataWorks allows you to create, deploy, and use data quality wrappers to satisfy diversified needs for data quality.


  1. Create a data quality wrapper.
    1. Log on to the DataWorks console.
    2. In the left-side navigation pane, click Workspaces.
    3. After you select the region where the required workspace resides, find the workspace and click Data Analytics.
    4. Click Node Config in the upper-right corner. The Node Plugin list page appears.
    5. In the left-side navigation pane, click Data quality plug-in list.
    6. On the Data quality plug-in list page, click Create in the upper-right corner.
  2. In the Settings step, set the parameters as required.
    Parameter Description
    Name The name of the data quality wrapper.
    Note The wrapper 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 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 Set the value to Off-line check.
    Resource File You can upload a file or use an Object Storage Service (OSS) object to specify a resource file.

    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 that is used to implement the data quality wrapper.
    Parameter Example The parameters that are designed based on the specified resource file.
    Version When you create a wrapper, select Create Version. 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. The real-time deployment progress appears.
  5. Wait until the deployment is completed and click Next.
  6. Click Next. In the Deploy in Development Environment step, confirm the configurations and click Deploy in Development Environment.
    Wait until the message The wrapper is deployed in the development environment appears. Click Next. The Test in Development Environment step appears.
  7. Test the wrapper in the development environment.
    1. In the Test in Development Environment step, set the 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. Example: database.table.
      Partition name The name of the partition.
      Field name The name of the field.
      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 results and select Test Passed.
    4. Click Next.
  8. In the Deploy in Production Environment step, click Deploy in Production Environment. The real-time deployment progress appears.
  9. Click Complete. The Wrappers page appears.
    The created wrapper appears on this page. You can configure the wrapper, view the version information about the wrapper, or delete the wrapper.
    • Click Settings. You are navigated to a step in the configuration wizard of the wrapper. The step you are navigated to appears based on the existing configurations of the wrapper.
    • Click View Versions. In the View Versions dialog box, you can view, roll back, or download each version. Then, click OK.
      • Click View. In the Settings step, view the basic information about the current version.
      • Click Roll Back. In the Roll Back message, click OK. The wrapper is rolled back to the previous version.
      • Click Download to download the resource file of the current version.
    • Click Delete. In the Delete Wrapper message, click OK.