logoBack to home screen

ADx 2.1.220 (25/02/2020) Patch Release Notes

This is a patch release to ADx 2.1, introducing retry logic for ADx Content Representation jobs. This logic is configurable via the new runtime properties, which you will find in your installation settings file. Minor WebReader improvements are provided as well.

For information about the 2.1 release, please read ADx 2.1 Release Notes if you haven't done so already.

Installation

You can install this release from the provided package. Follow Installation Instructions if you're installing from scratch.

Updating Conversion and ADx

For information on how to update previously installed Conversion and ADx, see the following:

Retry Mechanism for Document Representation Jobs

ADx Jobs fall into one of the below categories:

  • Content representation jobs - ran whenever a content is uploaded or updated. Retry mechanism on these jobs is a new feature.
  • Conversion jobs - ran whenever a content is converted. Retry mechanism on this feature is not new but still mentioned to add context.

Content Representation

Content representation jobs resulting from uploading or updating documents in ADx are now checked by the new retry mechanism. Essentially, any ADx Content Representation Job will be retried after it remains in the following state for too long:

  • enqueued
  • pending
  • running
  • waiting

By default, ADx checks for stale jobs every 30 minutes. Jobs are retried up to 5 times after remaining stale for at least 10 minutes from start or the previous retry. A job is considered stale when it doesnt't update the Last Updated Time property before the time runs out (10 minutes unless configured otherwise). You can override these values in the installation settings file - see Configuration Changes below.

Conversion

The above feature does not apply to conversion jobs (conversion to image, to pdf or any other conversion service available in ADx). Conversion has its own retry mechanism with the following default settings:

  • Checks for stale jobs executed every 10 minutes
  • Maximum inactivity period of 30 minutes before a retry
  • 3 maximum retries

How do I Check Jobs?

All jobs are reported in repository Cache Area. Jobs triggered by creating or updating contents are reported with the DOCUMENT_REPRESENTATION Job Type:

Conversion jobs have the Job Type set depending on the executed service:

  • TO_PDF
  • TO_IMAGE
  • MERGE
  • MERGE_TEMPLATES
  • EXTRACT_TEXT
  • WATERMARK_PDF

You will also find the Last Updated Time property in jobs. This property is used to calculate the inactivity period for a job.

Configuration Changes

New runtime properties related to the ADx job retry mechanism were introduced and can be found in the installation settings file in this package. You can use these properties to override the default configuration of the mechanism by editing the following part of the configuration file:

  ##############################################################################
  # Conversion Retry Settings
  # This mechanism periodically checks for stale ADx jobs and revives them.
  # (The settings below are for now global settings, which means they can't be
  #  configured on repository level via the administration UI yet.)
  ##############################################################################
  # The interval between checks for stale ADx Content representation jobs.
  # Allowed units: year (y), month (m), day (d), hour (h), minute (min), second (s)
  #ADX_DEFAULT_JOB_REVIVE_WORKER_CHECK_INTERVAL: "30 min"
  # Maximum inactivity period of a stale job before a retry.
  # Allowed units: year (y), month (m), day (d), hour (h), minute (min), second (s)
  #ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_INACTIVITY_BEFORE_RETRY: "10 min"
  # The maximum number of retries for a single job. If this number is reached,
  # there will be no further retries and the problem has to be analyzed and fixed manually.
  #ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_TRIES: "5"

Note that overriding these properties is 100% optional and the retry mechanism for document representation jobs will still work using the default values.

New Runtime Properties

The following runtime properties were added in this release:

PropertyDescriptionDefault Value
ADX_DEFAULT_JOB_REVIVE_WORKER_CHECK_INTERVALDefines how often stale ADx jobs are looked for. Supported time units are: y (year), m (month), d (day), h (hour), min (minute), s (second).30 min
ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_INACTIVITY_BEFORE_RETRYJobs with status enqueued, pending, running, waiting are retried after the time set in this parameter passes. Supported time units are: y (year), m (month), d (day), h (hour), min (minute), s (second).10 min
ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_TRIESDefines how many times an incomplete job can be retried.5

Changed Runtime Properties

None.

Removed Runtime Properties

None.