camunda-external-task-client-js

camunda-external-task-client

Implement your BPMN Service Task in NodeJS.

This package is an ECMAScript module (ESM) and provides no CommonJS exports.

NodeJS >= v18 is required

Installing

npm install -s camunda-external-task-client-js

Or:

yarn add camunda-external-task-client-js

Usage

• Make sure to have Camunda running.
• Create a simple process model with an External Service Task and define the topic as 'topicName'.
• Deploy the process to the Camunda Platform engine.
• In your NodeJS script:

import { Client, logger } from "camunda-external-task-client-js";

// configuration for the Client:
//  - 'baseUrl': url to the Process Engine
//  - 'logger': utility to automatically log important events
const config = { baseUrl: "http://localhost:8080/engine-rest", use: logger };

// create a Client instance with custom configuration
const client = new Client(config);

// susbscribe to the topic: 'creditScoreChecker'
client.subscribe("creditScoreChecker", async function({ task, taskService }) {
  // Put your business logic
  // complete the task
  await taskService.complete(task);
});

Note: Although the examples used in this documentation use async await for handling asynchronous calls, you can also use Promises to achieve the same results.

About External Tasks

External Tasks are service tasks whose execution differs particularly from the execution of other service tasks (e.g. Human Tasks). The execution works in a way that units of work are polled from the engine before being completed.

camunda-external-task-client.js allows you to create easily such client in NodeJS.

Features

Fetch and Lock

Done through polling.

Complete

// Susbscribe to the topic: 'topicName'
client.subscribe("topicName", async function({ task, taskService }) {
  // Put your business logic
  // Complete the task
  await taskService.complete(task);
});

Handle Failure

// Susbscribe to the topic: 'topicName'
client.subscribe("topicName", async function({ task, taskService }) {
  // Put your business logic
  // Handle a Failure
  await taskService.handleFailure(task, {
    errorMessage: "some failure message",
    errorDetails: "some details",
    retries: 1,
    retryTimeout: 1000
  });

});

Handle BPMN Error

// Susbscribe to the topic: 'topicName'
client.subscribe("topicName", async function({ task, taskService }) {
  // Put your business logic

  // Create some variables
  const variables = new Variables().set('date', new Date());

  // Handle a BPMN Failure
  await taskService.handleBpmnError(task, "BPMNError_Code", "Error message", variables);
});

Extend Lock

// Susbscribe to the topic: 'topicName'
client.subscribe("topicName", async function({ task, taskService }) {
  // Put your business logic
  // Extend the lock time
  await taskService.extendLock(task, 5000);
});

Unlock

// Susbscribe to the topic: 'topicName'
client.subscribe("topicName", async function({ task, taskService }) {
  // Put your business logic
  // Unlock the task
  await taskService.unlock(task);
});

Lock

// Susbscribe to the topic: 'topicName'
client.subscribe("topicName", async function({ task, taskService }) {
  // Task is locked by default
  // Put your business logic, unlock the task or let the lock expire

  // Lock a task again
  await taskService.lock(task, 5000);
});

Exchange Process & Local Task Variables

import { Variables } from "camunda-external-task-client-js";

client.subscribe("topicName", async function({ task, taskService }) {
  // get the process variable 'score'
  const score = task.variables.get("score");

  // set a process variable 'winning'
  const processVariables = new Variables();
  processVariables.set("winning", score > 5);

  // set a local variable 'winningDate'
  const localVariables = new Variables();
  localVariables.set("winningDate", new Date());

  // complete the task
  await taskService.complete(task, processVariables, localVariables);
});

API

• Client
  • new Client(options)
  • client.start()
  • client.subscribe(topic, [options], handler)
  • client.stop()
  • Client Events)
  • About the Handler Function
• Variables
  • new Variables(options)
  • variables.get(variableName)
  • variables.getTyped(variableName)
  • variables.getAll()
  • variables.getAllTyped()
  • variables.set(variableName)
  • variables.setTyped(variableName)
  • variables.setAll(values)
  • variables.setAllTyped(typedValues)
  • About JSON & Date Variables
• File
  • new File(options)
  • file.load()
  • File Properties
• BasicAuthInterceptor
  • new BasicAuthInterceptor(options)
• KeycloakAuthInterceptor
  • new KeycloakAuthInterceptor(options)
• logger
  • logger.success(text)
  • logger.error(text)

Contributing

Have a look at our contribution guide for how to contribute to this repository.

Help and support

• Documentation
• Forum
• Stackoverflow

License

The source files in this repository are made available under the Apache License Version 2.0.