v5.1.0

Version Number

5.1.0-1038

New Features

• SCMOD-13868: Updated worker-framework version to pull in new worker-store-http module from worker-framework

Known Issues

• None

Release Artifacts

Maven

• com.github.cafdataprocessing:worker-document-utility:5.1.0-1038 (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-document-testing:5.1.0-1038 (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-document:5.1.0-1038 (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-document-shared:5.1.0-1038 (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-document-validator:5.1.0-1038 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,pom.sha1,[pom](https://oss.sonatype.org/content/groups/publ...

v5.0.0

Version Number

5.0.0-924

Breaking Changes

• SCMOD-12730: Updated to the latest Worker Framework version, which includes the following breaking changes to support pause task functionality.

  • The statusCheckUrl used by the workers to check the status of a task now points to the status endpoint instead of the isActive endpoint.
  • Instead of returning true or false, the statusCheckUrl will now return one of Active, Cancelled, Completed, Failed,
    Paused, or Waiting.
  • When a worker receives a task, it will now check if the task has been paused using the statusCheckUrl.
  • 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).

• SCMOD-12319: The worker-document archetype has been deprecated.

Known Issues

• None

Release Artifacts

Maven

• com.github.cafdataprocessing:worker-document-utility:5.0.0-924 (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-document-testing:5.0.0-924 (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-document:5.0.0-924 (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-document-shared:5.0.0-924 (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-document-validator:5.0.0-924 (jar.md5,jar.sha1,jar,[javadoc.jar.md5](https://oss.sonatype.org/content/groups/public/com/github/cafdataprocessing/worker-document-validator/5.0.0-924/worke...

v4.5.0

Version Number

4.5.0-820

New Features

• SCMOD-10362: GraalVM JavaScript support
  The Document Worker Framework has been enhanced to support using the GraalVM JavaScript engine. In previous versions of the framework Nashorn was the only JavaScript engine supported. For backwards compatibility reasons it remains the default JavaScript engine, but note that it has been deprecated (see JEP372), so it may not be supported by all future versions of Java.
• SCMOD-11069: Archetype updated to openSUSE Leap 15.2.
• Worker-framework upgraded to 4.0.0
  Configuration files can now be supplied as resources in addition to external files.
  Lyra client replaced with RabbitMQ Java client.

Bug Fixes

• SCMOD-11144: json-schema-core upgraded to 1.2.14
  Resolves a security vulnerability.

Known Issues

• None

Release Artifacts

Maven

• com.github.cafdataprocessing:worker-document-archetype:4.5.0-820 (jar.md5,jar.sha1,jar,pom.md5,pom.sha1,pom,sources.jar.md5,sources.jar.sha1,sources.jar)
• com.github.cafdataprocessing:worker-document-utility:4.5.0-820 (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-document-testing:4.5.0-820 (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-document:4.5.0-820 (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-document-shared:4.5.0-820 (jar.md5,jar.sha1,jar,javadoc.jar.md5,javadoc.jar.sha1,javadoc.jar,pom.md5,[pom.sha1](https://oss.sonatype.org/content/groups/public/com/github/cafdataprocessing/worker-document-shared/4.5.0-820/worker-document...

v4.4.0

Version Number

4.4.0-707

New Features

• SCMOD-8829: Worker Framework update
  Updated to use version 3.4.0 of the internal worker framework.

Inherited from Worker Framework

• SCMOD-9780: Java 11 support
• SCMOD-8463: Confirm health checks before starting
• SCMOD-9102: New filesystem health check
• SCMOD-4887: Poison message recording

Bug Fixes

• None

Known Issues

• None

v4.3.0

Version Number

4.3.0-593

New Features

• Upgraded the Worker Framework to v3.3.0.

Bug Fixes

• SCMOD-8127: Improved resiliency against RabbitMQ connection being dropped
  The new version of the worker framework includes a fix for an issue which could cause workers to get into a state whereby they stopped taking in new work, but continued to report as healthy. Previously the issue could happen if the connection to RabbitMQ was interrupted.

Known Issues

• None

v4.2.0

Version Number

4.2.0-461

New Features

• SCMOD-6157: Define document message schema
• SCMOD-3816: Documentation for the javascript events handlers that was added in v4.0.0.
• SCMOD-7711: Updated to expose worker name and version from the application component.

Known Issues

• None

v4.1.0

Version Number

4.1.0-292

New Features

• SCMOD-4898: WorkerFramework does not produce tracking update messages if the trackProgressMessages property is set to false, default of this property is true.

Known Issues

• None

v4.0.0

Version Number

4.0.0-200

New Features

• SCMOD-3092: Scripting support
  The Document Worker Framework has been enhanced to support using JavaScript to customize documents. Multiple scripts can be supplied with a document task and the event handlers that they contain will be raised at the appropriate time. See SCMOD-3092 for the complete list of the event handlers added.

  The customization scripts can also be used to stop documents in a compound document from being passed to the worker's processDocument() method. By default each document in a compound document is passed to the processDocument() method individually, and the customization script support adds a degree of control to this behavior. It can be used to cause only a subset of the constituent documents to be processed by the worker.

  Note that if you try to send a document task that includes customization scripts to a worker that was built using a previous version of the framework that it will be rejected.

• New method for field value retrieval
  A new openInputStream method has been added to the FieldValue interface to provide a consistent means to access the data in the field value, regardless of whether the data is available in place, or whether it needs to be retrieved from the remote data store.

Bug Fixes

• CAF-3255: Corrected batch document counting
  Previously the currentSize method did not include subdocuments, even when the flag to process them separately was turned on. Also subdocuments were not taken into account when checking the maximum batch size.

Breaking Changes

• SCMOD-4072: Updated to use the latest released version of Dropwizard
  Previously this project consumed version 0.8.4 of dropwizard, this update has increased this version to 1.3.5.

Known Issues

• None

v3.3.0

Version Number

3.3.0-126

New Features

Bug Fixes

• Use latest worker-framework version for testing fix.
  Update to latest worker-framework to pull in a change to the worker-testing validation to not fail a test when a value to compare is not a syntactically valid regular expression.

Known Issues

v3.2.0

Version Number

3.2.0-100

New Features

• Added support for openSUSE based containers
  Workers built on this version of the framework will use the updated container startup scripts which support TLS with openSUSE base images.

• CAF-3584: Testing expectation enhancement
  An additional property has been added to the Document Worker testing module to allow specifying additional information to be set on a test expectation.

Known Issues

• None