TIF 2022.1.0 Release Information

04 March 2022

1. IMPORTANT: Changes to Job and Payload Cleansers & Default Service History Settings

This release contains changes to job/payload cleansers. The release also introduces default service history settings. Please read the below chapters to understand what is changed and what actions are required.

In summary:

  • Default service history settings are introduced as of this release. This allows to enforce default history settings for services that are not configured via Admin UI. The default setting for keeping job and payload data is 20 days. Please also read the next chapter to learn how to change it.

  • Scheduled maintenance tasks are moved from ${TIF_ROOT}/modules/enovia/etc/timetable.xml to ${TIF_ROOT}/modules/enovia/etc/module.properties. The cleansers are disabled by default. Make sure you first configure suitable default history settings before enabling the cleansers.

1.1. IMPORTANT: Default Service History Settings

As of this release, the TIF job cleanser keeps jobs for 20 days by default. This is applied if the TIF job cleanser is enabled, but you have not configured specific service history settings via Admin UI. The default value of 20 days can be changed with the properties that are described below.

It is now possible to configure default service history settings in ${TIF_ROOT}/modules/enovia/etc/module.custom.properties. The defaults are applied if you have not configured specific settings via Admin UI.

For example:

#
# Specifies how many days jobs are kept in the TIF DB. By default jobs are kept 20 days.
#
defaultServiceSetting.jobKeepDays=20
#
# Specifies whether payloads are persisted by TIF. Default is true.
#
defaultServiceSetting.storePayload=true

1.2. IMPORTANT: Changes to Job and Payload Cleansers

The scheduled maintentance tasks tif-job-cleanser and tif-payload-cleanser are moved from ${TIF_ROOT}/modules/enovia/etc/timetable.xml to ${TIF_ROOT}/modules/enovia/etc/module.properties.

Any existing cleanser task definitions in the timetable.xml are ignored, and executing a cleanser from the timetable.xml context produces an error message to the TIF log. In case you have job and/or payload cleanser task definitions in the timetable.xml, the following actions needs to be taken:

  • Remove the task group maintenance and its task definitions in the timetable.xml.

  • If you have specified some customized arguments for the cleansers, reconfigure those in ${TIF_ROOT}/modules/enovia/etc/module.custom.properties.

A job cleanser example:

# Enables the task execution.
jobCleanser.enabled = true
# Cron schedule for the task
jobCleanser.execute = 0 15 2 * * ?
#
# To limit the cleanser TIF DB queries
jobCleanser.deleteLimit = 10000
jobCleanser.maxIterations = 5
jobCleanser.deleteUnresolved = true

A payload cleanser example:

# Enables the task execution.
payloadCleanser.enabled = true
# Cron schedule for the task
payloadCleanser.execute = 0 15 2 * * ?
#
# To limit the cleanser TIF DB queries
payloadCleanser.deleteLimit = 10000
payloadCleanser.maxIterations = 5

1.3. Job and Payload Cleanser & deleteLimit Property

The scheduled maintenance tasks "tif-job-cleanser" and "tif-payload-cleanser" now expect the property jobCleanser.deleteLimit and payloadCleanser.deleteLimit to be defined within range [1, N]. If an invalid value is defined, default value is applied instead. See the defaults in modules/enovia/etc/module.properties.

Previously deleteLimit also accepted value 0 to indicate no limit. Now this is not possible, but the limit must be explicit to avoid too heavy database queries.

2. Fixed Bugs

Below is the list of fixed bugs as of this release.

Issue No Description

856

Send mail with authentication fails

858

Payload cleanser scheduled task ignores argument values that are less than defaults

859

ORA-01795 error when using combination of Oracle and ElasticSearch

860

Fix issue with changed return value from ElasticSearch causing a null pointer exception

861

File modifier examples not accessible in the documentation

862

Address warning with date_histogram in ElasticSearch as of version 7.2

871

Select date range with manual input throws error

873

Pagination error in Admin UI when using MS SQL Server 2008 or newer

875

File modifier fails with field of type "IncludePicture"

876

Scheduled job without a parent group does not start when using external database

877

Job resend action does not forward job to original server instance

878

Tracked change in Word document blocks batch job

882

HTTPS client throws an SSL exception if keystore contains multiple certificates