The procedure of creating a wrapper includes four steps: specify settings for a wrapper, deploy the wrapper in the development environment, test the wrapper in the development environment, and deploy the wrapper in the production environment.

Specify settings for a wrapper

  1. Go to the Wrappers page, click Create in the upper-right corner.
  2. Specify the parameters on the Settings page.
    Parameter Description
    Name A wrapper name must start with a letter and can only contain letters, numbers, and underscores (_).
    Owner You can select an owner from the workspace members. You are not allowed to edit wrappers owned by other members even if you are an administrator. Only the workspace owner can edit the wrappers of other members.
    Resource Type Two types are supported: JAR and Archive. Archive indicates the ZIP file format.
    Resource File You can either upload a local file or enter the path of a file stored in an OSS bucket.
    Note The size of a local file can be up to 50 MB, and the size of a file that is stored in an OSS bucket can be up to 200 MB.
    Class Name Enter the full path of the class in user wrapper implementation.
    Parameter Example Design parameters based on the package you upload.
    Version Select Create Version if you are creating a new version. Select Overwrite Version if you are editing and rolling back a version.
    Description Enter a description for the wrapper version.
  3. Click Save and then click Next.
    Note The settings are updated to the database after you click Save.
    • If you only modify basic settings of a wrapper without changing the resource file, the modification takes immediate effect after you click Save.
    • If you change the resource file, the change only applies after deployment.

Deploy the wrapper in the development environment

After you specify the parameters on the Settings page and click Next, the information on the Deploy in Development Environment page is updated accordingly. You can identify the changes by checking the file name and MD5 checksum.

Click Deploy in Development Environment. You can view the deployment progress in real time. After the wrapper is deployed, click Next.

Test the wrapper in the development environment

Specify arguments for testing, and click Test to send the arguments to the wrapper. This step is to validate deployment and logic of the wrapper. You can also locally test the wrapper before upload it for deployment.

After the test, review the output logs in the Test Results section on the right to determine whether the test is passed. If the test is passed, select Test Passed and click Next.

Deploy the wrapper in the production environment

After you click Deploy in Production Environment, the wrapper is deployed in the production environment. You can view the deployment progress in real time.

Note The wrapper to be deployed in the production environment must be the latest version that has been deployed in the development environment and have passed the test. Otherwise, a message appears, indicating that the deployment in the production environment fails.

Click Complete. You can view and edit your wrappers on the Wrappers tab.