https://github.com/flowable/flowable-external-client-js
https://github.com/flowable/flowable-external-client-js
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/flowable/flowable-external-client-js
- Owner: flowable
- License: apache-2.0
- Created: 2023-10-31T14:50:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T16:50:16.000Z (about 1 year ago)
- Last Synced: 2025-10-06T07:53:41.155Z (4 months ago)
- Language: TypeScript
- Size: 80.1 KB
- Stars: 2
- Watchers: 7
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flowable External Worker Library for Javascript
[](https://www.npmjs.com/package/@flowable-oss/external-worker-client)
[](https://github.com/flowable/flowable-external-client-js/blob/main/LICENSE)
An _External Worker Task_ in BPMN or CMMN is a task where the custom logic of that task is executed externally to Flowable, i.e. on another server.
When the process or case engine arrives at such a task, it will create an **external job**, which is exposed over the REST API.
Through this REST API, the job can be acquired and locked.
Once locked, the custom logic is responsible for signalling over REST that the work is done and the process or case can continue.
This project makes implementing such custom logic in Javascript or Typescript easy by not having the worry about the low-level details of the REST API and focus on the actual custom business logic.
Integrations for other languages are available, too.
## Authentication
The library allows to either authenticate with basic authentication with the parameter `auth` requiring `username` and `password`.
To use a personal access token you can specify the parameter `auth` and add `token` as a parameter.
Alternatively, `customizeAxios` can be used to directly customize the REST client.
## Installation
To install the external worker library, execute the following command:
```
npm install @flowable-oss/external-worker-client
```
## Sample
### Flowable Trial
The usage with Flowable Trial is simpler, since everything is pre-configured.
However, it's required to either use the user credentials or to pre-configure a personal access token.
```javascript
import {ExternalWorkerAcquireJobResponse, ExternalWorkerClient, WorkerResultBuilder} from "@flowable-oss/external-worker-client";
const externalWorkerClient = new ExternalWorkerClient({
auth: {
token: ''
}
});
const subscription = externalWorkerClient.subscribe({
topic: "myTopic",
numberOfTasks: 1,
callbackHandler(job: ExternalWorkerAcquireJobResponse, workResultBuilder: WorkerResultBuilder) {
console.log(`Execute job: ${job.id}`);
return workResultBuilder.success();
}
});
```
### Local
The following is an example how you can connect to a Flowable instance running at `http://host.docker.internal:8090` and process all messages retrieved on the topic `myTopic`:
```typescript
import {ExternalWorkerAcquireJobResponse, ExternalWorkerClient, WorkerResultBuilder} from "@flowable-oss/external-worker-client";
const externalWorkerClient = new ExternalWorkerClient({
flowableHost: 'http://host.docker.internal:8090',
auth: {
username: 'admin',
password: 'test'
}
});
const subscription = externalWorkerClient.subscribe({
topic: "myTopic",
numberOfTasks: 1,
callbackHandler(job: ExternalWorkerAcquireJobResponse, workResultBuilder: WorkerResultBuilder) {
console.log(`Execute job: ${job.id}`);
return workResultBuilder.success();
}
});
```