Deploy User Defined Directive

This article lays out steps to deploy a user defined directive via UI and REST API. Deploying UDD involves two steps.

1. Uploading the artifact JAR file containing the logic for the directive

2. Updating the artifact properties (if any) from the artifact json file.

Deploy via REST

The example builds example-directive to be deployed via REST API.

Deploying JAR

curl 'http://localhost:11011/api/v3/namespaces/default/artifacts/simple-udds' \
  -X 'POST'   -H 'Artifact-Version: 1.2.0-SNAPSHOT' \
  -H 'Artifact-Extends: system:wrangler-transform[4.0.0,5.0.0)/system:wrangler-service[4.0.0,5.0.0)' \
  -H 'Artifact-Plugins: ' \
  -H 'Content-Type: application/octet-stream' \
  --compressed \
  --data-binary "@<path-to-example-directive>/example-directive/target/simple-udds-1.2.0-SNAPSHOT.jar"

Deploying Properties

Once the JAR file uploaded successfully now we can update the properties of the artifact via the properties API call.

curl 'http://localhost:11011/api/v3/namespaces/default/artifacts/simple-udds/versions/1.2.0-SNAPSHOT/properties' \
  -X 'PUT' \
  -d@example-directive-properties.json

{
  "properties": {},
  "parents": [
    "system:wrangler-transform[4.0.0,5.0.0)",
    "system:wrangler-service[4.0.0,5.0.0)"
  ]
}

In this specific case the example-directive-properties.json will be {}

Deploy via UI

Deploying the user-defined directive via UI is straightforward.

1. Navigate to UI with the Green “+” button.

   

2. Click on the Upload button under the Directive section

3. Upload the jar and the json files built as part of the directive. In my screenshot I have built example-directive and have uploaded the jar and json from the target directory.

   

4. Once the custom user-defined directive is uploaded it can now be used from the power mode in Dataprep from the CLI mode. In this case the example-directive introduces a text-length directive