v5.3.0

Version Number

5.3.0-1100

New Features

• 359648: Added support for a new leaner message format
  The Worker Framework previously defined the task-specific part of its message (which is the vast majority of the message) as a byte array. As messages are normally passed in JSON, this was serialized as a base64 encoded string, which added~33% to the size of the task data. Given that the task-specific part of the message is itself normally JSON, the Worker Framework has now been updated to embed this directly and avoid the overhead. This significantly reduces the message size.

• 397426: Format of logging has been changed to include the UTC Date alongside UTC Time

Known Issues

• None

Release Artifacts

Maven

• com.github.cafdataprocessing:worker-workflow-container:5.3.0-1100 (pom.md5,pom.sha1,pom)
• com.github.cafdataprocessing:worker-workflow-aggregator:5.3.0-1100 (pom.md5,pom.sha1,pom)
• com.github.cafdataprocessing:worker-workflow:5.3.0-1100 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)
• com.github.cafdataprocessing:worker-workflow-testing:5.3.0-1100 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)

Docker

• cafdataprocessing/worker-workflow:5.3.0 (Static Tag)
• cafdataprocessing/worker-workflow:5.3 (Dynamic Tag)
• cafdataprocessing/worker-workflow:5 (Dynamic Tag)
• cafdataprocessing/worker-workflow:latest (Dynamic Tag)

v5.2.0

Version Number

5.2.0-1021

New Features

• SCMOD-14252: Added support for resolving workflow argument values which use multivalue fields. When looking up argument values from
  the settings-service, the multiple values of a field are all passed with equal priority.
• SCMOD-6849: Added support for forcing a refresh of the Settings Service cache. See the README.md for details.

Bug fixes

• SCMOD-14805: Settings Service cache fixed.

Known Issues

• None

Release Artifacts

Maven

• com.github.cafdataprocessing:worker-workflow-container:5.2.0-1021 (pom.md5,pom.sha1,pom)
• com.github.cafdataprocessing:worker-workflow-aggregator:5.2.0-1021 (pom.md5,pom.sha1,pom)
• com.github.cafdataprocessing:worker-workflow:5.2.0-1021 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)
• com.github.cafdataprocessing:worker-workflow-testing:5.2.0-1021 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)

Docker

• cafdataprocessing/worker-workflow:5.2.0 (Static Tag)
• cafdataprocessing/worker-workflow:5.2 (Dynamic Tag)
• cafdataprocessing/worker-workflow:5 (Dynamic Tag)
• cafdataprocessing/worker-workflow:latest (Dynamic Tag)

v5.1.0

Version Number

5.1.0-904

New Features

• SCMOD-12730: Added pause task support.
  • When a worker receives a task, it will now check if the task has been paused.
  • If the task has been paused, and the CAF_WORKER_PAUSED_QUEUE environment variable is set, the worker will publish the task to the
    CAF_WORKER_PAUSED_QUEUE instead of processing it.
  • If the task has been paused, and the CAF_WORKER_PAUSED_QUEUE environment variable is NOT set, the worker process the task as
    normal (as if the task was not paused).

Known Issues

• None

Release Artifacts

Maven

• com.github.cafdataprocessing:worker-workflow-container:5.1.0-904 (pom.md5,pom.sha1,pom)
• com.github.cafdataprocessing:worker-workflow-aggregator:5.1.0-904 (pom.md5,pom.sha1,pom)
• com.github.cafdataprocessing:worker-workflow:5.1.0-904 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)
• com.github.cafdataprocessing:worker-workflow-testing:5.1.0-904 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)

Docker

• cafdataprocessing/worker-workflow:5.1.0 (Static Tag)
• cafdataprocessing/worker-workflow:5.1 (Dynamic Tag)
• cafdataprocessing/worker-workflow:5 (Dynamic Tag)
• cafdataprocessing/worker-workflow:latest (Dynamic Tag)

v5.0.0

Version Number

5.0.0-816

New Features

• SCMOD-10362: GraalVM JavaScript engine added
  The worker has been enhanced to support Graal.js scripts in Workflows. This allows ECMAScript 2020 features
  to be included in customization scripts. Existing Nashorn scripts continue to be supported.

Bug Fixes

• SCMOD-9981: Fix for index out of bounds exception when the CAF_WORKFLOW_ACTION field was missing
• SCMOD-10917: Fix for some script errors not being recorded in the index when there were errors in multiple actions

Known Issues

• None

Breaking Changes

• Due to moving to Graal.js all conditionFunction elements in Workflows must be updated so that the function is named
  condition and be Graal.js compatible.
• Any context.js scripts must be Graal.js compatible.
• The thisScriptObject field exposed by workflow-control.js is no longer an object. It is now a string containing
  the addFailures function definition. Consumers must be updated to eval() this string into their context in order to
  access the function.
• All downstream Workers must be upgraded to Worker-Document framework 4.5.0 to support executing Graal.js scripts.

Release Artifacts

Maven

• com.github.cafdataprocessing:worker-workflow-container:5.0.0-816 (pom.md5,pom.sha1,pom)
• com.github.cafdataprocessing:worker-workflow-aggregator:5.0.0-816 (pom.md5,pom.sha1,pom)
• com.github.cafdataprocessing:worker-workflow:5.0.0-816 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)
• com.github.cafdataprocessing:worker-workflow-testing:5.0.0-816 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)

Docker

• cafdataprocessing/worker-workflow:5.0.0 (Static Tag)
• cafdataprocessing/worker-workflow:5.0 (Dynamic Tag)
• cafdataprocessing/worker-workflow:5 (Dynamic Tag)
• cafdataprocessing/worker-workflow:latest (Dynamic Tag)

v4.3.0

Version Number

4.3.0-703

New Features

• SCMOD-9780: Updated image to use Java 11
• SCMOD-10427: Only handle failures for non-final actions.
  The workflow control script now only marks unhandled errors as handled when they happen in an action that is not the last action in the chain.

Known Issues

• None

v4.2.0

Version Number

4.2.0-585

New Features

• SCMOD-7588: Added CORRELATION_ID to the FAILURES field.
• SCMOD-8157: Removed CAF_WORKFLOW_SETTINGS from customdata.
• SCMOD-8183: Exposed function to add failures.
• SCMOD-8520: Updated to use security hardened base image
• SCMOD-8363: Updated to map failures to proper levels

Known Issues

• None

v4.1.0

Version Number

4.1.0-472

New Features

• SCMOD-7587: Log tenant and correlation ids
  The workflow worker, and the workflow control script, have been updated to add the tenant ID and the correlation ID to the MDC logging data. This means log messages generated by the workflow worker, and subsequent workers in the workflow, will contain a tenant ID and correlation ID, provided the workers have been updated to the use CAF Logging.

Bug Fixes

• None

Known Issues

• None

v4.0.0

Version Number

4.0.0-466

Breaking Changes

• SCMOD-6784 - Workflow and settings js files are no longer supported as workflows are now defined using yaml.

New Features

• SCMOD-6857 - Update to read queue names from configuration.
  More details can be found here.
• SCMOD-6932 - Enrichment & Ingestion workflows wont adjust Bulk Indexer failure queue and this is handled by adding terminateOnFailure flag on each required worker
• SCMOD-7133 - Reading the workflow name from root document
• SCMOD-7132 - Error handling on the workflow has been improved
• SCMOD-6931 - Worker Versions recorded as objects in a field
• SCMOD-7711 - The Name and Version of the workflow used, is retrieved from application object

Bug Fixes

• SCMOD-7698 - Fixed poison message handling

Known Issues

• None

v3.0.0

Version Number

3.0.0-335

Breaking Changes

• SCMOD-5747 - The workflow worker does not use the processing-service and the
  workflow-admin anymore. Workflows are loaded from files saved on disk (look at the worker-workflow README for more info).

New Features

• SCMOD-5739 - The Data Processing Service and Policy were replaced with Settings Service.

Known Issues

• None

v2.0.0

Version Number

2.0.0-250

New Features

• SCMOD-5144: Workflow Id no longer required
  Workflow Id can now be substituted for the name of the workflow to use.
• SCMOD-4898: Discard superfluous tracking messages.
  The CAF_WORKER_DISABLE_ZERO_PROGRESS_REPORTING environment variable can be set to true to cause zero-progress tracking messages not to be sent.

Known Issues

Breaking Changes

• SCMOD-5326: Source parameter to workflow updated
  Source parameter in workflow can now be either a string on an object under different circumstances, this is discussed and examples shown in documentation. TenantData Source is no longer supported and workflow produced now takes custom workflow configuration settings that are supplied to the script on the customdata for the document being processed.