Ephesoft Transact Property Files Reference Guide

Introduction

This document lists and describes the Ephesoft Transact properties files, to include the path in which each property file is located, with links to additional information.

For additional information about Ephesoft Transact folders, refer to the following resources:

Properties Files in Ephesoft Transact

Application.properties (Transact properties)

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

This file contains many configuration settings for Ephesoft application-level properties. Examples include custom reports settings, user interface display settings, user access and more. The following article has additional information:

Application.properties

application.properties (log monitoring)

Folder: C:\Ephesoft\Application\monitoring-tool\config

This file is used to configure the Log Monitoring Tool by setting the appropriate properties. The following articles have additional information about this properties file and the Log Monitoring Tool:

aspects-mapping.properties

Folder: SharedFolders\<BC Id>\cmis-plugin-mapping

This file contains aspect mapping for the documents to be uploaded to CMIS export repository.

Multiple Attribute Fields — The CMIS Export plugin includes multi-attribute property support. This enables the user to configure CMIS export to populate Multiple/Repeating values into external repositories.

Ephesoft Transact 4.5.0.0 and later releases process batches and export values to the fields with the Multiple property set to True on the CMIS side. Ephesoft Transact only supports multiple value configuration for DLF-Attribute- mapping (document-level field mapping).

The following articles have additional information:

cas-config.properties

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

This file contains settings that define the CAS server and service host which are used to ensure proper communication between the CAS server and Ephesoft Transact. The following article has additional information:

CAS-Based SSO Framework

catalina.properties

Folder: C:\Ephesoft\JavaAppServer\conf

This is 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 some tunable performance properties. This file does not support the bootstrap loader or system loader, both of which are handled by the Java Virtual Machine (JVM). The following article from another source has additional information:

catalina.properties File Overview

db-export-mapping.properties

Folder: C:\Ephesoft\Dependencies\SharedFolderChanges

This sample file is used in each batch class to save the data of document-level fields for a batch instance to the database. The following articles have additional information:

Ephesoft Transact 2019.2

Ephesoft Transact 2019.1

Ephesoft Transact 4.5.0.0

db-export-mapping.properties (DB Export Plugin Mapping)

Folder: SharedFolders\<BC Id>\db-export-plugin-mapping

This file is used for saving the data of document-level fields for a batch instance to the database. The following article has additional information about DB export mapping:

DB Export Mapping Sample

dcma-backup-service.properties

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

This file defines settings that apply when the batch xml backup file needs to be taken, whether after the execution of every plugin, or after the execution of every module.

The following articles have additional information:

dcma-batch.properties

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

This file contains configuration settings for batch processing and details. The following articles have additional information:

dcma-box-plugin.properties

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

This file contains configuration settings related to the Box Export plugin. The following articles have additional information:

dcma-cmis.properties

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

This file contains configuration settings related to the CMIS export plugin.

The following articles have additional information:

dcma-cmis-import.properties

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

This file contains configuration settings related to importing files from CMIS. The following articles have additional information:

dcma-core.properties

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

This file contains configuration settings to manage the thread pool. The following article has additional information:

B0171512 Long running batches and duplicate RecostarPlugin processes

dcma-db.properties (Database)

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

This file contains configuration settings for database information. The following article has additional information:

Confirm Ephesoft and Report Database Settings with Heidi SQL

dcma-db.properties (MariaDB)

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

This file contains configuration settings for the MariaDB database. This file should not be modified in most cases. The following articles have additional information about MariaDB configuration:

dcma-db.properties (MS SQL)

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

This file contains configuration settings for the Microsoft SQL Server database. This file should not be modified in most cases. The following articles have additional information about SQL Server configuration:

dcma-db.properties (Oracle)

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

This file contains configuration settings for the Oracle database. This file should not be modified in most cases. The following articles have additional information about Oracle configuration:

dcma-docushare-export.properties

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

This file contains configuration settings for the Docushare export module. The following articles have additional information:

dcma-encryption.properties

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

This file contains configuration settings for using encryption in Ephesoft. The following articles have additional information about encryption on Ephesoft Transact:

dcma-export.properties

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

This file contains configuration settings for batch export. The following articles have additional information:

dcma-export-webservices.properties

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

This file contains configuration settings for EXPORT_TO_WEB_SERVICE plugin. The following articles have additional information:

Ephesoft Transact 2019.2

Ephesoft Transact 2019.1

Ephesoft Transact 4.5.0.0

dcma-ftp.properties

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

This file contains configuration settings that define the FTP connection for transferring and retrieving files from an FTP server. The following articles have additional information:

dcma-ibm-cm.properties

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

This file contains configuration settings to export Batch XML in IBM content management schema format. The following articles have additional information about IBM export:

dcma-import-folder.properties

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

This file contains configuration settings related to folder import. The following articles have additional information:

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

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

This file contains configuration settings for the key value learning plugin. The following articles have additional information:

dcma-key-regex.properties

Folder:  SharedFolders\<BC Id>\key-value-learning (Regex)

This file 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 minimum length set in the value expression. The following article has additional information:

Key Value Learning Plugin

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

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

This file contains configuration settings for the key value learning plugin. The following article has additional information:

Key Value Learning Plugin

dcma-key-value-location.properties

Folder: SharedFolders\<BC Id>\key-value-learning (Key location lookup)

This file determines the location in which to look for the key that corresponds to the value fetched in key value learning. The following article has additional information about key value learning:

Key Value Learning Plugin

dcma-nsi-export.properties

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

This file contains configuration settings for exporting a zipped file for a batch xml file in a format acceptable by the NSI content management system (CMS). The following article has additional information about using the NSI export plugin:

NSI Export Plugin

dcma-paragraph-extraction.properties

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

This file contains configuration settings related to paragraph extraction plugin. The following articles have additional information:

dcma-reporting.properties

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

This file contains information related to reporting. The following articles have additional information:

dcma-scripting-plugin.properties

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

This file contains configuration settings for application-level scripts. The following articles have additional information:

Ephesoft Transact 2019.2

Ephesoft Transact 2019.1

Ephesoft Transact 4.5.0.0

dcma-sharepoint-export.properties

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

This file contains configuration settings for the Sharepoint export plugin. The following article has additional information:

Ephesoft Transact 2019.2

Ephesoft Transact 2019.1

Ephesoft Transact 4.5.0.0

dcma-tabbed-pdf.properties

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

This file contains configuration settings for the Tabbed PDF plugin. The following articles have additional information about the Tabbed PDF plugin:

Ephesoft Transact 2019.2

Ephesoft Transact 2019.1

Ephesoft Transact 4.5.0.0

dcma-tablefinder.properties

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

This file contains configuration settings for the Table Extraction plugin. The following article has additional information about this plugin:

Ephesoft Transact 2019.2

Ephesoft Transact 2019.1

dcma-tempfolder-cleanup.properties

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

This file contains configuration settings to free the disc space consumed by the temporary folders within the Shared Folder of the Ephesoft installation directory. This folder may accumulate files that are created over time and need to be purged on a periodic basis. The following article has additional information about configuring this file for cleanup functions:

dcma-twain-scanner.properties

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

This file contains configuration settings for Twain driver-related properties. The following articles have additional information about the Web Scanner or Twain driver settings:

  • Web Scanner (Ephesoft Transact 2019.2, with additional articles)
  • Web Scanner (Ephesoft Transact 2019.1, with additional articles)
  • Web Scanner (Ephesoft Transact 4.5.0.0, with additional articles)

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

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

This file contains configuration settings for the key value learning plugin. The following articles have additional information:

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

Folder: SharedFolders\<BC Id>\key-value-learning

This file contains regular expressions for values that are used in key value learning to find matching value expressions. The following articles have additional information about using this properties file and rule creation:

dcma-webscanner.properties

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

This file contains configuration settings related to the Ephesoft Web Scanner. The following articles have additional information about the Web Scanner:

  • Web Scanner (Ephesoft Transact 2019.2, with additional articles)
  • Web Scanner (Ephesoft Transact 2019.1, with additional articles)
  • Web Scanner (Ephesoft Transact 4.5.0.0, with additional articles)

dcma-workflows.properties

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

This file contains configuration settings for the Transact application workflow. The following articles have additional information:

details.properties

Folder: C:\Ephesoft\Dependencies\licensing

This file is used to gather details on a specific machine to allow for licensing. The following articles have additional information:

dictionary_mappings.properties

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

This file contains mappings of the dictionary name, dictionary file and display values used in machine learning extraction. The following article has additional information:

Custom Dictionary Support

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

Folder: SharedFolders\<BC Id>\cmis-plugin-mapping

This file contains document properties mapping for the documents to be uploaded to the CMIS repository. The following articles have additional information:

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

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

This is the properties file for export to the HPII Filenet plugin. The following articles have additional information:

etl-variables.properties

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

This file contains configuration settings for connecting to the report database. By default, it is configured to point to the report database created by Ephesoft. The following articles have additional information:

export-script.properties

Folder: SharedFolders\property

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. The following articles have additional information:

Ephesoft Transact 2019.2

Ephesoft Transact 2019.1

Ephesoft Transact 4.5.0.0

filebound-mapping.properties

Folder: SharedFolders\<BC Id>\filebound-plugin-mapping

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. The following article has additional information:

folder-monitor.properties

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

This file contains configuration settings for folder monitoring, to include settings that govern the creation of new batch instances. This includes updates to the batch instance database table. The following articles have additional information:

format-conversion.properties

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

This file contains configuration settings for format conversion functions in Ephesoft Transact. The following articles have additional information:

fuzzy-db.properties

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

This file contains configurations related to fuzzy DB functionality. The following articles have additional information:

heart-beat.properties

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

This file contains configuration settings that provide the interval to check whether the servers registered in the database are still active. The following article has additional information:

Failover Mechanism

imagemagick.properties

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

This file contains configuration settings that define the image conversion process. The following article has additional information:

ImageMagick Processing Parameters

key_exclusion_list.properties (Key Value Learning plugin)

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

This file contains configuration settings for key value learning plugin. The following article has additional information:

Key Value Learning Plugin

key_exclusion_list.properties (Regex for exclusion)

Folder: SharedFolders\<BC Id>\key-value-learning

This file contains a list of regular expressions which are to be excluded for the key in key value learning. The following article has additional information:

Key Value Learning Plugin

license-client.properties

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

This file stores the license server details for every client in the Ephesoft Transact deployment. The following article has additional information:

License-client.properties in Batch Class Operations

logging.properties

Folder: C:\Ephesoft\JavaAppServer\conf

This file is used to get logging out of web app by creating a logger. The following article has additional information:

Changing log locations in Linux

mail-import.properties

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

This file contains configuration settings for email import. The following article has additional information:

notice.properties

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

This file contains configuration settings related to notice display and verification.

open-office.properties

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

This file contains properties related to LibreOffice.

regex_mappings.properties

Folder: SharedFolders\<BC Id>\machine-learning-dictionaries\knowledge-base\regex

This file contains mapping of regex name and regex value used in machine learning extraction. The following article has additional information:

tesseract-reader.properties

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

This file contains properties related to the Tesseract OCR engine plugin. The following article has additional information about this plugin:

Tesseract HOCR Plugin

user.properties

Folder: C:\Ephesoft\Dependencies\licensing

This file holds user-specific licensing details. The following articles have additional information about licensing Ephesoft Transact:

user-connectivity.properties

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

This file contains configuration settings for users and group information. Use this file for configuration for LDAP, AD and Tomcat in this file. The following articles have additional information:

workers.properties

Folder: C:\Ephesoft\Apache24\conf

This properties file configures load balancing with Apache. The following articles have additional information:

XssFilter.properties

Folder: C:\Ephesoft\EphesoftReports\WEB-INF

This file contains filters which are applied to optional URL patterns. If the URL contains the pattern, then the filter characters that follow it are applied.