Transact

  1. Home
  2. Transact
  3. System Configuration
  4. Logging
  5. License Logging

License Logging

Applies to: Ephesoft Transact 2020.1.03 and above

Introduction

Transact automatically logs license information to provide an at-a-glance view of current server licensing and configured feature flags. The following is an overview of the information logged, and at what time:

  • All license information (including ID Extraction license expiration date, if applicable) is logged each time the Transact server is started, as well as daily according to a cron job. Refer to Configuring Warning Logs below for more information.
  • A warning will be logged when you use 90% of your allotted images. You can configure this threshold in the dcma-core.properties file. Refer to Configuring Warning Logs below for more information.
  • A warning will be logged daily starting 30 days prior to the Transact license expiration date.

Logging Process

Once a day at the scheduled time, as well as each time the Transact server is started, the license status is checked and written to the dcma-monitor.log file.

  • If the license is near expiring (< 30 days), it is also written to the dcma-all.log file at a warning level.
  • If the license is expired, it is also written to the dcma-all.log file at the error level.

Logging Properties

The following table outlines the key license properties logged in the dcma-monitor.log upon startup.

Property Description
Days_Until_Expiring Number of days until License_expiry_date.
Transact_Monitoring_Code Name of code indicating the current state of the license. Refer to Transact License Monitoring Codes for details.
Transact_Monitoring_Code_Value Numeric code indicating the current state of the license. Refer to Transact License Monitoring Codes for details.
License_expiry_date Date when the license expires.
Image_Count_Consumed Number of images processed by Transact since the license was installed.
Remaining_Number_Of_Images Remaining number of images that Transact can process given the current license.
IDE_Image_Count_Consumed Number of images processed using the ID Extraction plugin since the license was installed.
ID_Extraction_Remaining_Number_Of_Images Remaining number of images that you can process with the ID Extraction plugin given the current license.

Configuring Warning Logs

This section describes how to configure certain aspects of the license logging. Both properties listed below are configurable in the dcma-core.properties file, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-core.

Note: For Transact Cloud customers, contact Ephesoft Support at tickets@ephesoft.com to make any changes to properties files.

Property Description
license.near.expiring.percentage The remaining number of images warning threshold. By default, this is set to 90%. This means that once 90% of the image count limit set in your Transact license is used, a warning will be logged in the dcma-monitor.log.

Note: This property should be formatted as a decimal. For example, 90% is “.90”.

license.monitor.cronjob.expression The schedule of when to check the license status. By default, this cron job is set to 1:00 AM (0 0 1 ? * *).

For more information on configuring cron jobs, refer to Cron Job Expressions.

 

Was this article helpful to you? Yes No