Zeebe JobWorker binding spec

Zeebe JobWorker binding spec

Detailed documentation on the Zeebe JobWorker binding component

Component format

To setup Zeebe JobWorker binding create a component of type bindings.zeebe.jobworker. See this guide on how to create and apply a binding configuration.

See this for Zeebe JobWorker documentation.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
spec:
  type: bindings.zeebe.jobworker
  version: v1
  metadata:
  - name: gatewayAddr
    value: <host>:<port>
  - name: gatewayKeepAlive
    value: 45s
  - name: usePlainTextConnection
    value: true
  - name: caCertificatePath
    value: /path/to/ca-cert
  - name: workerName
    value: products-worker
  - name: workerTimeout
    value: 5m
  - name: requestTimeout
    value: 15s
  - name: jobType
    value: fetch-products
  - name: maxJobsActive
    value: 32
  - name: concurrency
    value: 4
  - name: pollInterval
    value: 100ms
  - name: pollThreshold
    value: 0.3
  - name: fetchVariables
    value: productId, productName, productKey
  - name: autocomplete
    value: true

Spec metadata fields

Field	Required	Binding support	Details	Example
gatewayAddr	Y	Input	Zeebe gateway address	`localhost:26500`
gatewayKeepAlive	N	Input	Sets how often keep alive messages should be sent to the gateway. Defaults to 45 seconds	`45s`
usePlainTextConnection	N	Input	Whether to use a plain text connection or not	`true,false`
caCertificatePath	N	Input	The path to the CA cert	`/path/to/ca-cert`
workerName	N	Input	The name of the worker activating the jobs, mostly used for logging purposes	`products-worker`
workerTimeout	N	Input	A job returned after this call will not be activated by another call until the timeout has been reached; defaults to 5 minutes	`5m`
requestTimeout	N	Input	The request will be completed when at least one job is activated or after the requestTimeout. If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated. Defaults to 10 seconds	`30s`
jobType	Y	Input	the job type, as defined in the BPMN process (e.g. `<zeebe:taskDefinition type=”fetch-products” />`)	`fetch-products`
maxJobsActive	N	Input	Set the maximum number of jobs which will be activated for this worker at the same time. Defaults to 32	`32`
concurrency	N	Input	The maximum number of concurrent spawned goroutines to complete jobs. Defaults to 4	`4`
pollInterval	N	Input	Set the maximal interval between polling for new jobs. Defaults to 100 milliseconds	`100ms`
pollThreshold	N	Input	Set the threshold of buffered activated jobs before polling for new jobs, i.e. threshold * maxJobsActive. Defaults to 0.3	`0.3`
fetchVariables	N	Input	A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned	`productId, productName, productKey`
autocomplete	N	Input	Indicates if a job should be autocompleted or not. If not set, all jobs will be auto-completed by default. Disable it if the worker should manually complete or fail the job with either a business error or an incident	`true,false`

Binding support

This component supports input binding interfaces.

Input binding

Variables

The Zeebe process engine handles the process state as also process variables which can be passed on process instantiation or which can be updated or created during process execution. These variables can be passed to a registered job worker by defining the variable names as comma-separated list in the fetchVariables metadata field. The process engine will then pass these variables with its current values to the job worker implementation.

If the binding will register three variables productId, productName and productKey then the worker will be called with the following JSON body:

{
  "productId": "some-product-id",
  "productName": "some-product-name",
  "productKey": "some-product-key"
}

Note: if the fetchVariables metadata field will not be passed, all process variables will be passed to the worker.

Headers

The Zeebe process engine has the ability to pass custom task headers to a job worker. These headers can be defined for every service task. Task headers will be passed by the binding as metadata (HTTP headers) to the job worker.

The binding will also pass the following job related variables as metadata. The values will be passed as string. The table contains also the original data type so that it can be converted back to the equivalent data type in the used programming language for the worker.

Metadata	Data type	Description
X-Zeebe-Job-Key	int64	The key, a unique identifier for the job
X-Zeebe-Job-Type	string	The type of the job (should match what was requested)
X-Zeebe-Process-Instance-Key	int64	The job’s process instance key
X-Zeebe-Bpmn-Process-Id	string	The bpmn process ID of the job process definition
X-Zeebe-Process-Definition-Version	int32	The version of the job process definition
X-Zeebe-Process-Definition-Key	int64	The key of the job process definition
X-Zeebe-Element-Id	string	The associated task element ID
X-Zeebe-Element-Instance-Key	int64	The unique key identifying the associated task, unique within the scope of the process instance
X-Zeebe-Worker	string	The name of the worker which activated this job
X-Zeebe-Retries	int32	The amount of retries left to this job (should always be positive)
X-Zeebe-Deadline	int64	When the job can be activated again, sent as a UNIX epoch timestamp

Last modified July 27, 2022: Add Zeebe autocomplete flag (#2673) (1501480b)

Zeebe JobWorker