Property files

Transact uses property files to manage settings. These files are listed below with their location, a description, and links to additional information, where applicable. Folder locations are relative to the Transact installation folder.

application.properties

Folder: \Application\WEB-INF\classes\META-INF

Description: Contains many Transact application-level properties, including custom reports settings, user interface display settings, and user access.

For more information, see application.properties.

application.properties

Folder: \Application\monitoring-tool\config

Description: Configures the Log Monitoring Tool with the available properties. The Log Monitoring Tool was deprecated in Ephesoft Transact 2019.1.

aspects-mapping.properties

Folder:\SharedFolders\<Batch_Class_ID>\cmis-plugin-mapping

Description: Contains aspect mapping for the documents to be uploaded to the CMIS export repository.

The CMIS Export plugin includes support for multiple attribute fields. You can configure CMIS export to populate repeating values into external repositories.

Transact can process batches and export values to the fields with the Multiple property set to True on the CMIS side. Transact only supports multiple value configuration in the [xref] DLF-Attribute-mapping.properties file (document-level field mapping).

For more information, see these topics:

cas-config.properties

Folder: \Application\WEB-INF\classes\META-INF\CAS-config

Description: Contains settings that define the CAS server and service host, which are used to ensure proper communication between the CAS server and Ephesoft Transact.

For more information, see CAS-based SSO Framework.

catalina.properties

Folder: \JavaAppServer\conf

Description: A regular Java properties file that contains configuration settings for loaders that support Tomcat. This file sets some important class loader paths, security package lists, and performance properties. This file does not support the bootstrap loader or system loader, both of which are handled by the Java Virtual Machine (JVM).

db-export-mapping.properties (DB Export plugin mapping)

Folder: \SharedFolders\<Batch_Class_ID>\db-export-plugin-mapping

Description: This file is used for saving the data of document-level fields for a batch instance to the database.

For more information, see "DB Export plugin" in Ephesoft Transact Administrator's Help.

A sample version of this file is available at \Dependencies\SharedFolderChanges.

dcma-backup-service.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-util

Description: This file defines settings that apply when the batch.xml file needs to be backed up, whether after the execution of every plugin or after the execution of every module.

For more information, see these topics:

dcma-batch.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-batch

Description: Contains configuration settings for batch processing and various batch folder locations.

For more information, see "Batch Instance Progress Bars" in Ephesoft Transact Administrator's Help.

dcma-box-plugin.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-box-plugin

Description: Contains API configuration settings related to the Box Export plugin.

For more information, see "Box Export plugin" in Ephesoft Transact Administrator's Help.

dcma-cmis.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-cmis

Description: Contains configuration settings related to the CMIS export plugin, such as the CMIS date format, security mode, and mapping for various URLs.

For more information, see these topics:

dcma-cmis-import.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-cmis-import

Description: Contains the cron expression which controls how often Transact will check the CMIS server for new files. The default value is every 15 minutes (0 0/15 * ? * *).

For more information, see CMIS Import in Ephesoft Transact Administrator's Help.

dcma-core.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-core

Description: Contains configuration settings to manage the thread pool size.

dcma-db.properties (database)

Folder: \Application\WEB-INF\classes\META-INF\dcma-data-access

Description: Contains settings for database information, including patch management, configuring maximum database connections, and max pool size.

dcma-db.properties (MariaDB)

Folder: \Application\WEB-INF\classes\META-INF\dcma-data-access\MariaDB

Description: Contains configuration settings for the MariaDB database. This file should not be modified in most cases.

For more information, see Maximum MariaDB Connections.

dcma-db.properties (Microsoft SQL)

Folder: \Application\WEB-INF\classes\META-INF\dcma-data-access\MSSQL

Description: Contains configuration settings for the Microsoft SQL Server database. This file should not be modified in most cases.

For more information, see Connection Manager.

dcma-db.properties (Oracle)

Folder: \Application\WEB-INF\classes\META-INF\dcma-data-access\Oracle

Description: Contains configuration settings for the Oracle database. This file should not be modified in most cases.

For more information, see Connect an Oracle database to Transact.

dcma-docushare-export.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-docushare-export

Description: Contains configuration settings for the Docushare export module.

For more information, see "Docushare Export plugin" in Ephesoft Transact Administrator's Help.

dcma-encryption.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-encryption

Description: This file contains configuration settings for using encryption in Transact.

For more information, see Encrypt passwords in Transact files.

dcma-export.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-export

Description: Contains configuration settings for batch export.

For more information, see "Copy Batch XML plugin" in Ephesoft Transact Administrator's Help.

dcma-export-webservices.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-export-webservices

Description: Contains the connection timeout setting (in milliseconds) for the Export to Web Service plugin. By default, this is set to 2000ms (2 sec).

For more information, see these topics:

  • "Export to Web Service plugin" in Ephesoft Transact Administrator's Help

  • "Transact Web Services API" in Ephesoft Transact Developer's Guide

  • "Web Service definitions and code samples" in Ephesoft Transact Developer's Guide

dcma-ftp.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-ftp

Description: This file contains configuration settings that define the File Transfer Protocol (FTP) connection for transferring and retrieving files from an FTP server.

dcma-ibm-cm.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-ibm-cm

Description: Contains configuration settings to export Batch XML in the IBM content management schema format.

For more information, see "IBM CM plugin" in Ephesoft Transact Administrator's Help.

dcma-import-folder.properties

Folder:\Application\WEB-INF\classes\META-INF\dcma-import-folder

Description: Contains configuration settings related to folder import, such as characters that should be ignored in imported file names, and which HTML conversion tool should be used.

For more information, see "Import Batch Folder plugin" in Ephesoft Transact Administrator's Help.

dcma-key-regex.properties (Key-Value Learning plugin)

Folder: \Application\WEB-INF\classes\META-INF\dcma-key-value-learning

Description: Contains a list of regular expressions configured for the key-value learning plugin.

For more information, see "Key-Value Learning plugin" in Ephesoft Transact Administrator's Help.

dcma-key-regex.properties (Key-Value Learning regex)

Folder: \SharedFolders\<Batch_Class_ID>\key-value-learning

Description: Contains regular expressions for keys in key-value learning. If there is no match there, it will take the first word that is more than x characters long, where x is the minimum length set in the value expression.

For more information, see "Key-Value Learning plugin" in Ephesoft Transact Administrator's Help.

dcma-key-value-location.properties (Key-Value Learning plugin)

Folder: \Application\WEB-INF\classes\META-INF\dcma-key-value-learning

Description: Contains configuration settings for the key-value learning plugin.

For more information, see "Key-Value Learning plugin" in Ephesoft Transact Administrator's Help.

dcma-key-value-location.properties

Folder: \SharedFolders\<Batch_Class_ID>\key-value-learning

Description: Determines the location in which to look for the key that corresponds to the value fetched in key-value learning.

For more information, see "Key-Value Learning plugin" in Ephesoft Transact Administrator's Help.

dcma-nsi-export.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-nsi-export

Description: Contains configuration settings for exporting a zipped file for a batch.xml file in a format acceptable by the NSI content management system (CMS).

dcma-paragraph-extraction.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-paragraph-extraction

Description: Contains configuration settings related to the paragraph extraction plugin.

For more information, see "Paragraph extraction" in Ephesoft Transact Administrator's Help.

dcma-reporting.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-reporting

Description: Contains configuration settings related to reporting, such as the schedule for archiving report data.

For more information, see "Reporting" in Ephesoft Transact Administrator's Help.

dcma-scripting-plugin.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-scripting-plugin

Description: Contains configuration settings for application-level scripts, such as when a script should be executed.

For more information, see the following:

  • "Application level script" in Ephesoft Transact Developer's Guide

  • "Scripting plugin" in Ephesoft Transact Administrator's Help.

dcma-sharepoint-export.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-sharepoint-export

Description: Contains configuration settings for the SharePoint 365 Export plugin, such as how many times it will attempt to export, and the interval time between attempts.

For more information, see "Support of export to SharePoint 2013 and 2016" in Ephesoft Transact Administrator's Help.

dcma-tabbed-pdf.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-tabbed-pdf

Description: Contains configuration settings for the Tabbed PDF plugin, specifically for Ghostscript.

For more information, see the following:

  • "Tabbed PDF plugin" in Ephesoft Transact Administrator's Help

  • "Tabbed PDF plugin and Order Doc Types" in Ephesoft Transact Administrator's Help

dcma-tablefinder.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-table-finder

Description: Contains configuration settings for the Table Extraction plugin, such as invalid characters for table rules, or setting the fuzzy match threshold.

For more information, see the following:

  • " Table Extraction plugin" in Ephesoft Transact Administrator's Help

  • "Configure table extraction" in Ephesoft Transact Administrator's Help

dcma-tempfolder-cleanup.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-tempfolder-cleanup

Description: Contains configuration settings to free the disc space consumed by the temporary folders within the Transact SharedFolders folder. This folder may accumulate files that are created over time and need to be purged on a periodic basis.

For more information, see Transact temporary folder automatic cleanup.

dcma-telemetry.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-telemetry

Description: Contains configuration settings related to the automatic capture and upload of consumption-based license data.

For more information, see dcma-telemetry.properties.

dcma-twain-scanner.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-twain-scanner

Description: This file contains configuration settings for Twain driver-related properties.

For more information, see "Web Scanner" in Ephesoft Transact Administrator's Help.

dcma-value-regex.properties (Key-Value Learning plugin)

Folder: \Application\WEB-INF\classes\META-INF\dcma-key-value-learning

Description: Contains regular expressions that can be used for value pattern generation during key-value learning.

For more information, see "Key Value Learning plugin" in Ephesoft Transact Administrator's Help.

dcma-value-regex.properties (matching values in Key-Value Learning)

Folder: \SharedFolders\<Batch_Class_ID>\key-value-learning

Description: Contains regular expressions for values that are used in key value learning to find matching value expressions for a particular batch class.

For more information, see "Key Value Learning plugin" in Ephesoft Transact Administrator's Help.

dcma-webscanner.properties

Folder: \Application\WEB-INF\classes\META-INF\gwt-web-scanner

Description: Contains configuration settings related to the Transact Web Scanner, such as the automatic refresh time for the active scanning session.

For more information, see "Web Scanner" in Ephesoft Transact Administrator's Help.

dcma-workflow.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-workflows

Description: Contains configuration settings for the Transact application workflow.

For more information, see Pickup service.

details.properties

Folder: \Dependencies\licensing

Description: Gathers details on a specific machine to allow for licensing.

For more information, see "Licensing requirements" in Ephesoft Transact Installation Guide.

dictionary_mappings.properties

Folder: \SharedFolders\<Batch_Class_ID>\machine-learning-dictionaries\knowledge-base\dictionaries

Description: Contains mappings of the dictionary name, dictionary file, and display values used in machine learning extraction.

For more information, see "Machine Learning Custom Dictionary support" in Ephesoft Transact Administrator's Help.

DLF-Attribute-mapping.properties (Document property mappings)

Folder: \SharedFolders\<Batch_Class_ID>\cmis-plugin-mapping

Description: Contains document properties mapping for the documents to be uploaded to the CMIS repository.

For more information, see [xref] CMIS Export Plugin.

DLF-Attribute-mapping.properties (Export property files for Filenet)

Folder: \SharedFolders\<Batch_Class_ID>\export-to-HPII-filenet-plugin-mapping

Description: Contains properties for configuring export to the HPII Filenet plugin.

For more information, see "CMIS Export plugin" in Ephesoft Transact Administrator's Help.

etl-variables.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-reporting

Description: Contains configuration settings for connecting to the report database. By default, it is configured to point to the report database created by Transact.

For more information, see "Reporting" in Ephesoft Transact Administrator's Help.

export-script.properties

Folder: \SharedFolders\property

Description: This file is used to manage the order of bookmarks from the Tabbed PDF plugin, based on the order or priority of document types cited in this file.

For more information, see the following:

  • "Tabbed PDF plugin" in Ephesoft Transact Administrator's Help

  • " Tabbed PDF plugin and Order Doc types" in Ephesoft Transact Administrator's Help

filebound-mapping.properties

Folder: \SharedFolders\<Batch_Class_ID>\filebound-plugin-mapping

Description: This file is not used. The FileBound Export plugin has been soft-deleted from the database. It is used for exporting files to the repository.

folder-monitor.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-folder-monitor

Description: Contains configuration settings for folder monitoring, including settings that govern the creation of new batch instances. This includes updates to the batch instance database table. The folder-monitor.properties file also contains the pdf.xfa.process.static.content property. This property enables or disables the processing of PDF XFA files for static content only.

For more information, see Folder Monitoring Is Not Responsive.

format-conversion.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-format-conversion

Description: Contains configuration settings for format conversion functions in Transact.

For more information, see "Format conversion" in Ephesoft Transact Administrator's Help.

fuzzy-db.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-fuzzydb

Description: Contains configurations related to fuzzy DB functionality.

For more information, see "Fuzzy DB extraction" in Ephesoft Transact Administrator's Help.

heart-beat.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-heart-beat

Description: Contains configuration settings that provide the interval to check whether the servers registered in the database are still active.

For more information, see "Failover service and configuration tables" in Ephesoft Transact Installation Guide.

imagemagick.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-imagemagick

Description: Contains configuration settings that define the image conversion process.

For more information, see Understanding ImageMagick Compression Parameters.

key_exclusion_list.properties (Key-Value Learning plugin)

Folder: \Application\WEB-INF\classes\META-INF\dcma-key-value-learning

Description: Contains configuration settings for key value learning plugin.

For more information, see "Key Value Learning plugin" in Ephesoft Transact Administrator's Help.

key_exclusion_list.properties (Regex for exclusion)

Folder: \SharedFolders\<Batch_Class_ID>\key-value-learning

Description: Contains a list of regular expressions which are to be excluded for the key in the key value learning.

For more information, see "Key Value Learning plugin" in Ephesoft Transact Administrator's Help.

license-client.properties

Folder: \Application\WEB-INF\classes\META-INF\ephesoft-license-client

Description: Stores the license server details for every client in the Ephesoft Transact deployment.

logging.properties

Folder: \JavaAppServer\conf

Description: Gets logging out of web app by creating a logger.

For more information, see Logging.

mail-import.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-mail-import

Description: Contains configuration settings for email import.

For more information, see Mail-Import.properties.

notice.properties

Folder: \Application\WEB-INF\classes\META-INF

Description: Contains configuration settings related to notice display and verification.

open-office.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-open-office

Description: Contains properties related to LibreOffice.

regex_mappings.properties

Folder: C:\SharedFolders\<Batch_Class_ID>\machine-learning-dictionaries\knowledge-base\regex

Description: Contains mapping of regex name and regex value used in machine learning extraction.

For more information, see "Machine Learning Custom Dictionary support" in Ephesoft Transact Administrator's Help.

tesseract-reader.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-tesseract

Description: Contains properties related to the Tesseract HOCR plugin.

For more information, see "Tesseract HOCR plugin" in Ephesoft Transact Administrator's Help.

user.properties

Folder: \Dependencies\licensing

Description: Contains user-specific licensing details

For more information, see "Licensing requirements" in Ephesoft Transact Installation Guide.

user-connectivity.properties

Folder: \Application\WEB-INF\classes\META-INF\dcma-user-connectivity

Description: This file contains configuration settings for users and group information. Use this file to configure Transact for LDAP, AD, or Tomcat.

For more information, see the following:

workers.properties

Folder: \Apache24\conf

Description: Contains configuration settings to enable load balancing with Apache.

For more information, see the following:

XssFilter.properties

Folder: \EphesoftReports\WEB-INF

Description: Contains filters that are applied to optional URL patterns. If the URL contains the pattern, then the filter characters that follow it are applied.