Issue

Some PDFs cannot be extracted using EText mode. When EText is enabled in the batch class, Ephesoft Transact uses Recostar’s EText .rsp file to OCR any documents for extraction. EText mode will fail if the headers and labels inside the PDF are not editable or cannot be copied to notepad.

Solution

Note: These changes are made at the batch class level. You will need to repeat the following steps for each batch class with which you want to use EText mode.

1. Go to [Ephesoft_Directory]\SharedFolders\[your_batch_class]\fixed-form-extraction.
2. Open the FPR_EText.rsp file.
3. Find the XML tag that ends with </ImageSequence2Operator>.
4. Add the following after the XML tag:

<LayoutOperator FindTextBlocks=”true” Name=”LayoutOperator”/>

5. Change the ProcessingMode option from ExtractfromEText to VoteOCRAndEText.

Figure 1. Processing Mode

6. Save and close the file.

The post KB00010300: EText Limitations appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 4.x and above

This page provides instructions on how to migrate your Ephesoft SharedFolders location to a different path, either Network or Local.

Update Property Files

1. application.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\

 Line 28: plugin_upload_folder_path=\\\\NEW_UNC_PATH\\SharedFolders/plugin-upload-folder

2. dcma-batch.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-batch\

 Line 1: batch.base_folder=\\\\NEW_UNC_PATH\\SharedFolders
 Line 2: batch.local_folder=\\\\NEW_UNC_PATH\\SharedFolders/ephesoft-system-folder
 Line 4: batch.export_folder=\\\\NEW_UNC_PATH\\SharedFolders/final-drop-folder
 Line 17: batch.export_import_folder=\\\\NEW_UNC_PATH\\SharedFolders/export-batch-folder
 Line 24: batch.test_folder=\\\\NEW_UNC_PATH\\SharedFolders/ephesoft-test-data

3. dcma-db.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-data-access\

 Line 17: upgradePatch.folder=\\\\NEW_UNC_PATH\\SharedFolders/database-update

4. dcma-backup-service.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-util\

 Line 1: backup.local_folder=\\\\NEW_UNC_PATH\\SharedFolders/ephesoft-system-folder
 Line 8: backup.report_folder=\\\\NEW_UNC_PATH\\SharedFolders/report-data

5. dcma-workflows.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-workflows\

 Line 15: newWorkflows.basePath=\\\\NEW_UNC_PATH\\SharedFolders/workflows

6. etl-variables.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-reporting\

 Line 1: reportdata.path=\\\\NEW_UNC_PATH\\SharedFolders/report-data

7. server.xml, located at [Ephesoft_Directory]\JavaAppServer\conf\

 Line 156: <Context path="/dcma-batches" docBase="\\\\NEW_UNC_PATH\\SharedFolders" debug="10" privileged="false"/>

8. Analysis_Grid.Document_Correction_Analysis_Grid.lgx, located at [Ephesoft_Directory]\EphesoftReports\_Definitions\_Reports\

 Line 23: SavedAnalysisGridFolder="\\\\NEW_UNC_PATH\\SharedFolders\SavedAnalysisGrid"

 Line 65: DashboardSaveFile="\\\\NEW_UNC_PATH\\SharedFolders\SavedDashboards\Dashboard_User_@Session.userName~.xml"

9. Analysis_Grid.Field_Correction_Analysis_Grid.lgx, located at [Ephesoft_Directory]\EphesoftReports\_Definitions\_Reports\

 Line 23: SavedAnalysisGridFolder="\\\\NEW_UNC_PATH\\SharedFolders\SavedAnalysisGrid"

 Line 62: DashboardSaveFile="\\\\NEW_UNC_PATH\\SharedFolders\SavedDashboards\Dashboard_User_@Session.userName~.xml"

10. Dashboard.Dashboard.lgx, located at [Ephesoft_Directory]\EphesoftReports\_Definitions\_Reports\

 Line 19: SaveFile="\\\\NEW_UNC_PATH\\SharedFolders\SavedDashboards\Dashboard_User_@Session.userName~.xml"

11. Dashboard.serverStatus.lgx, located at [Ephesoft_Directory]\EphesoftReports\_Definitions\_Reports\

 Line 140: XMLFile="\\\\NEW_UNC_PATH\\SharedFolders\SavedDashboards\Dashboard_User_@Session.userName~.xml" />

Update the Ephesoft Application Database

Update all batch classes listed in the “batch_class” Table. Use a similar SQL Statement as the one below to update each batch class record:

 UPDATE batch_class SET unc_folder = Replace(unc_folder, '\\\\OLD_UNC_PATH\\SharedFolders', '\\\\NEW_UNC_PATH\\SharedFolders')WHERE  local_folder LIKE '%SharedFolders%';

Note: You will need to update each record.

Update the batch_instance table with the New SharedFolders Location.

Use similar SQL Statements to the ones below to update each Batch Instance record:

 UPDATE batch_instance SET local_folder='\\\\NEW_UNC_PATH\\SharedFolders\\ephesoft-system-folder';
 UPDATE batch_instance SET unc_subfolder = Replace(unc_subfolder, '\\\\OLD_UNC_PATH\\SharedFolders', '\\\\NEW_UNC_PATH\\SharedFolders' WHERE  local_folder LIKE '%SharedFolders%');

Note: We have to run this query for all the UNC subfolders present inside the UNC folder. If you do not update this table, you must make sure that all batch instances are in the FINISHED or DELETED State.

Update Windows Registry Information

Update HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Temp\Ephesoft Windows registry information with the new SharedFolders location. This will ensure future upgrades will be performed correctly.

Additional Configurations

Depending on your database application, you may also need to update the default DB property files, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-data-access. This includes either the MSSQL or MYSQL folder.

1. MSSQL: dcma-db.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-data-access\MSSQL\

 Line 16: upgradePatch.folder=\\\\NEW_UNC_PATH\\SharedFolders/database-update

2. MYSQL: dcma-db.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-data-access\MYSQL\

 Line 26: upgradePatch.folder=\\\\NEW_UNC_PATH\\SharedFolders/database-update

3. MYSQL: post-schema.sql, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-data-access\MYSQL\

 Line 150: update batch_class set unc_folder='\\\\NEW_UNC_PATH\\SharedFolders\\mailroom-import' where batch_class_name='MailroomAutomationTemplate';
 Line 151: update batch_class set unc_folder='\\\\NEW_UNC_PATH\\SharedFolders\\searchablepdf-import' where batch_class_name='SearchablePDFTemplate';
 Line 152: update batch_class set unc_folder='\\\\NEW_UNC_PATH\\SharedFolders\\grid-computing-import' where batch_class_name='GridComputingTemplate';
 Line 156: update batch_class_plugin_config set batch_class_plugin_config.plugin_config_value='\\\\NEW_UNC_PATH\\SharedFolders\\final-drop-folder' 
 Line 164: update batch_class_plugin_config set batch_class_plugin_config.plugin_config_value='\\\\NEW_UNC_PATH\\SharedFolders\\csv-export-folder' 
 Line 172: update batch_class_plugin_config set batch_class_plugin_config.plugin_config_value='\\\\NEW_UNC_PATH\\SharedFolders\\ibm-cm-export-folder' 
 Line 180: update batch_class_plugin_config set batch_class_plugin_config.plugin_config_value='\\\\NEW_UNC_PATH\\SharedFolders\\export-script.properties' 
 Line 188: update batch_class_plugin_config set batch_class_plugin_config.plugin_config_value='\\\\NEW_UNC_PATH\\SharedFolders\\tabbed-pdf-export-folder' 
 Line 196: update batch_class_plugin_config set batch_class_plugin_config.plugin_config_value='\\\\NEW_UNC_PATH\\SharedFolders\\NSI-export-folder' 

For a local disk, you can use something like “C:\\Folder\\Path”

Note: Mapped network drives will not work with Ephesoft. For drive letter format, only local disks are supported.

You may also need to update the following settings and files:

4. EphesoftTransact.exe, located at [Ephesoft_Directory]\JavaAppServer\bin
   1. Right-click EphesoftTransact.exe and select Run as administrator.
   2. Select the Java tab
   3. In the Java Options field, update the “-Dshared.folders” parameter.

Figure 1. Ephesoft Transact Properties

5. startup.bat, located at [Ephesoft_Directory]\JavaAppServer\bin.
   1. Open startup.bat using an editor.
   2. Locate and update the SHARED_FOLDERS entry to point to the new SharedFolders path.

Figure 2. startup.bat 

6. applicationContext.xml, located at [Ephesoft_Directory]\Application.
   1. Open applicationContext.xml using an editor.
   2. Locate and update the import resource parameter.

Figure 3. applicationContext.xml

Restart Batches

After you’ve completed the above updates, restart your batch instances from the first module.

The post Migrating the Ephesoft SharedFolders Location appeared first on Ephesoft Docs.

Applies to: All versions of Ephesoft Transact

Issue

When Ephesoft Transact is configured for Single Sign-On (SSO), the Swagger UI is not available. The following entry is logged in the catalina.log file when attempting to access the Swagger UI:

WARN  org.apache.catalina.authenticator.FormAuthenticator- No login page was defined for FORM authentication in context [/dcma]

The post Known Issue: Swagger UI Not Working with SSO appeared first on Ephesoft Docs.

Applies to: All versions of Ephesoft Transact

Issue

Clicking any restart batch option without selecting a batch instance causes the first batch in the list to restart. Instead, an error should state that no batch is selected.

The post Known Issue: Unexpected Behavior with Restart Batch appeared first on Ephesoft Docs.

Applies to: All versions of Ephesoft Transact

Issue

Calling the saveMobileUpload API gives the error “Image Count Allowed Reached”, even when the batch instance is created successfully.

This does not affect the functionality of the API.

The post Known Issue: Error Incorrectly Logged with saveMobileUpload API appeared first on Ephesoft Docs.

Issue

OCR results may be incorrect or missing data for non-EText operations.

Root Cause

This issue may occur because of an incorrect entry in the associated RSP file for the batch class. The default occurrence of this issue is in the FPR.rsp file, but this file name may vary depending on your configuration.

You may find FindTextBlocks=”true” in the associated RSP file, which may be the cause of the loss of quality. Try configuring FindTextBlocks=”false” to understand if that is the root cause of the issue. 

Solution

Test if manually setting FindTextBlocks=“false” in the associated RSP file for the batch class resolves the issue.

1. Open the FPR.rsp file, located at [Ephesoft_Directory]\SharedFolders\<your batch class>\fixed-form-extraction.
2. Locate the following XML tag:

<LayoutOperator FindTextBlocks=”true” Name=”LayoutOperator”/>

3. Set “FindTextBlocks” as “false”.

<LayoutOperator FindTextBlocks=”false” Name=”LayoutOperator”/>

4. Save and close the file.

The post Poor OCR Results in HOCR.xml appeared first on Ephesoft Docs.

Applies to: All Linux versions of Ephesoft Transact

This page provides instructions for how to install checkinstall on RedHat Enterprise Linux (RHEL). Checkinstall files are included in the installation zip file from Ephesoft, however Transact does not install checkinstall by default.

If you find an error while installing Ephesoft where it was unable to install ImageMagick or Ghostscript. Check the /var/log/install-ephesoft.log. Scroll up above the Ephesoft ASCII graphics and if you see a mention of the install unable to find checkinstall, you will need to follow the instructions below in order to install checkinstall.

Prerequisites

• You must be the root user.
• All required packages must be installed prior to following the instructions listed here. If you need to install the required packages, enter the following command:

sudo yum install unzip rpmdevtools gcc*

Instructions

1. Download the Ephesoft installer zip file.
2. Unzip the Ephesoft installer to its own directory.

unzip <zip file name>.zip -d Ephesoft

3. Change directory to the Ephesoft install directory.

cd Ephesoft

4. In that directory, you will see a tar.gz file which contains all of the files that will be installed. Extract the checkinstall files from that tar.gz.

tar -xvf ./<tar file name>.tar.gz Ephesoft/Dependencies/checkinstall.tar.gz

5. Change directory to the newly created Dependencies directory.

cd ./Ephesoft/Dependencies

6. Decompress the checkinstall.tar.gz file.

tar xzvf ./checkinstall.tar.gz

7. Change the directory to the newly installed checkinstall directory.

cd checkinstall

8. Prepare the source code for installation.

make

9. Compile and install checkinstall.

make install

10. Verify the installation path of checkinstall is at /usr/local/sbin.

which checkinstall

11. Verify that /usr/local/sbin is in the path for the root user.

echo $PATH

12. If the $PATH return does not include /usr/local/sbin, you will need to add it to the path temporarily.

export PATH=$PATH:/usr/local/sbin

13. Now that you have installed checkinstall, you will have to tell Ephesoft that it is already installed. Start the installation, you may receive an error and close the application.
14. Once that happens, open the file /etc/Ephesoft/ephesoft.conf and change the value in it for checkinstall from 0 to 1.
15. Save the file and start the installation over.

Troubleshooting

1. If you receive the following error when running the “make” command in step 8, then you have not installed gcc first:

[root@localhost checkinstall]# make
for file in locale/checkinstall-*.po ; do \
case ${file} in \
locale/checkinstall-template.po) ;; \
*) \
out='echo $file | sed -s 's/po/mo/'' ; \
msgfmt -o ${out} ${file} ; \
if [ $? != 0 ] ; then \
exit 1 ; \
fi ; \
;; \
esac ; \
done
make -C installwatch
make[1]: Entering directory /path/to/folder/checkinstall/installwatch'
./create-localdecls
Checking truncate argument type... off_t
Checking readlinkat result type... ssize_t
Checking libc version... ./create-localdecls: line 47: gcc: command not found
ldd: ./libctest: No such file or directory
rm: cannot remove 'libctest': No such file or directory
gcc -Wall -c -D_GNU_SOURCE -DPIC -fPIC -D_REENTRANT -DVERSION=\"0.7.0beta7\" installwatch.c
make[1]: gcc: Command not found
make[1]: *** [installwatch.0] Error 127
make[1]: Leaving directory '/path/to/folder/checkinstall/installwatch'
make: *** [1ll] Error 2

2. If you receive the following error when running the “make” command, you will have to modify the /checkinstall/installwatch/installwatch.c file at the lines mentioned in the fix below and then start at step 8 again.

installwatch.c:2942: error: conflicting types for 'readlink'
/usr/include/unistd.h:828: note: previous declaration of 'readlink' was here
installwatch.c:3080: error: conflicting types for 'scandir'
/usr/include/dirent.h:252: note: previous declaration of 'scandir' was here
installwatch.c:3692: error: conflicting types for 'scandir64'
/usr/include/dirent.h:275: note: previous declaration of 'scandir64' was here

Note: When you edit the installwatch.c file, there will be an “if-then” statement for a static int on each item listed. You want them to match, which is what we are doing here.

Make the following changes to the ./checkinstall/installwatch/installwatch.c file:

1. 1. At line 110, change the “static int” to match the previous “static int”:

Original:

static int (*true_scandir)( const char *,struct dirent ***,
int (*)(const struct dirent *),
int (*)(const void *,const void *));

Edited:

static int (*true_scandir)( const char *,struct dirent ***,
int (*)(const struct dirent *),
int (*)(const struct dirent **,const struct dirent **));

1. 2. At line 138, change the “static int” to match the previous “static int”:

Original:

static int (*true_scandir64)( const char *,struct dirent64 ***,
int (*)(const struct dirent64 *),
int (*)(const void *,const void *));

Edited:

static int (*true_scandir64)( const char *,struct dirent64 ***,
int (*)(const struct dirent64 *),
int (*)(const struct dirent64 **,const struct dirent64 **));

1. 3. At line 2959, change:

Original:

#if (GLIBC_MINOR <= 4)

Edited:

#if (0)

1. 4. At line 3103, change the “static int” to match the previous “static int”:

Original:

int scandir( const char *dir,struct dirent ***namelist,
int (*select)(const struct dirent *),
int (*compar)(const void *,const void *) ) {

Edited:

int scandir( const char *dir,struct dirent ***namelist,
int (*select)(const struct dirent *),
int (*compar)(const struct dirent **,const struct dirent **) ) {[/code]
at line 3719, change the static int to match the previous static int:

Original:

int scandir64( const char *dir,struct dirent64 ***namelist,
int (*select)(const struct dirent64 *),
int (*compar)(const void *,const void *) ) {

Edited:

int scandir64( const char *dir,struct dirent64 ***namelist,
int (*select)(const struct dirent64 *),
int (*compar)(const struct dirent64 **,const struct dirent64 **) ) {

The post How to Install Checkinstall on RHEL appeared first on Ephesoft Docs.

The following steps describe how to disable the IPv6 network protocol on Windows.

You may need to temporarily disable IPv6 in a multi-server environment of Ephesoft Transact if any of the following fails:

• Heartbeat monitoring
• Failover (nodes picking up batches)
• Licensing

Instructions

Perform the following steps to disable the IPv6 network protocol on this server. This control is available in the Windows network settings.

1. Go to Control Panel > Network and Internet > Ethernet.
2. From the Ethernet screen, click Change adapter options. A new screen displays one or more networks.

Figure 1. Network Connections Example

3. Right-click the network on which to disable the IPv6 and click Properties from the pop-up menu.

Figure 2. Click Properties to Change IPv6 Settings

The Ethernet Properties screen displays.

Figure 3. Ethernet Properties Settings

4. Clear the Internet Protocol Version 6 (TCP/IPv6) check box.

Figure 4. Disable the Internet Protocol Version 6 (TCP/IPv6) Setting

5. Click OK to save changes. The system returns you to the Ethernet page.
6. Close the Windows Control Panel.

The post How to Disable the IPv6 Network Protocol appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2019.1 and above

Issue

When adding a new plugin to a module in Transact, you may receive a message that this plugin has a dependency on the Cloud HyperExtender plugin.

“Selected plugin has dependencies on the highlighted plugin(s). Would you like to add them as well?”

Figure 1. Plugin Addition Message

This message appears in error. The Cloud HyperExtender plugin is not a dependency for any other plugins. Unless you plan to use the Cloud HyperExtender, click No when you see this message.

The post Known Issue: CHE Plugin Incorrectly Marked as Dependent appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2020.1.03 and above

This page describes how to configure exchange email proxy server integrations with Email Import. By default, proxy configurations are disabled for email import.

Edit Properties File

Email import properties are controlled in the mail-import.properties file, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-mail-import.

1. Stop Ephesoft Transact.
2. Open the mail-import.properties file.

Figure 1. Open Properties File

3. Locate the following lines:

#Is proxy configuration required for exchange server?
#false: Mail should NOT use proxy for exchange server (Default)
#true: Mail should use proxy for exchange server
dcma.mail.import.is_proxy_required=false
#proxy server ip-address
dcma.mail.import.proxy_host=127.0.0.1
#proxy server port
dcma.mail.import.proxy_port=80
#Does proxy require authentication?
dcma.mail.import.proxy_credential_required=false
#Proxy server username
dcma.mail.import.proxy_server_username=ephesoft
#Proxy server password
dcma.mail.import.proxy_server_password=ephesoft
#Proxy server domain
dcma.mail.import.proxy_server_domain=ephesoft

4. Configure the above properties with your proxy server details.

Note: Ensure the dcma.mail.import.is_proxy_required property is set to true to enable proxy configurations.

5. Save and close the file.
6. Start Ephesoft Transact.

The post How to Enable a Proxy Server with Email Import appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2020.1.03 and above

Issue

After upgrading from 2020.1.02 to 2020.1.03, the following error may be logged each time you pick up a batch, or when a batch finishes processing:

/dcma/ws/activity/pickup/notification access cannot be granted. com.ephesoft.dcma.authorization.exception.AuthorizationException: None of the rules granted access for the incoming request

Root Cause

This issue occurs due to a missing entry in the web.xml file.

Solution

To resolve this issue, manually add the missing entry in the web.xml file.

1. Open the web.xml file, located at [Ephesoft_Directory]\Application\WEB-INF.
2. Locate the following lines:

<context-param>
<param-name>InternalWebServices</param-name>
<param-value>batchInstanceIdentifier/,propertiesChangedEvent/,batchIdentifier/,verifyEphesoftLicense/,verifyAdvanceReportingSwitch/,notifyServerForService/,logs/,path/,paths/,remoteBatchInstanceIdentifier/,propertiesChangedEvent/,previousRemoteBatchInstanceIdentifier/,targetBatchInstanceIdentifier/,checkUserExistence/,signUp/,changePassword/,modifyPassword/</param-value>
</context-param>

3. Add “,activity/” before the closing </param-value> tag.

<param-value>batchInstanceIdentifier/,propertiesChangedEvent/,batchIdentifier/,verifyEphesoftLicense/,verifyAdvanceReportingSwitch/,notifyServerForService/,logs/,path/,paths/,remoteBatchInstanceIdentifier/,propertiesChangedEvent/,previousRemoteBatchInstanceIdentifier/,targetBatchInstanceIdentifier/,checkUserExistence/,signUp/,changePassword/,modifyPassword/,activity/</param-value>

4. Save and close the file.
5. Restart Ephesoft Transact.

The post Error Logged when Picking up Batches After Upgrade to 2020.1.03 appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2020.1.02 and below

Issue

Batches may take a long time to pass through the Folder Import module when IMPORT_MULTIPAGE_FILES is set to group4 processing while using ImageMagick 7.0.10.x.

This issue only applies to Ephesoft Transact 2020.1.02 and below, and was resolved with 2020.1.03.

Root Cause

A setting in the IMPORT_MULTIPAGE_FILES plugin is case sensitive.

Solution

1. From the Batch Class Management screen, select your batch class and click Open.
2. Go to Modules > Folder Import > IMPORT_MULTIPAGE_FILES.
3. Change the IM Convert Input Image Parameters from “-limit area 100mb” to “-limit area 100MB”.

Figure 1. IMPORT_MULTIPAGE_FILES Plugin Properties

4. Click Apply.

The post Long Processing Times During Folder Import appeared first on Ephesoft Docs.

Issue

Processing a batch on an imported batch class that has CMIS export configured results in failures at CMIS export.

Root Cause

CMIS mapping files are missing from the cmis-plugin-mapping folder after importing a batch class. This occurs whether or not the exported batch class had CMIS export configured.

Workaround

To resolve this issue, you will need to manually copy the CMIS mapping files from the original batch class to the imported batch class. Perform the following steps:

1. Open the original batch class ZIP file. This is the ZIP file that is created when you export a batch class.
2. Copy the contents of the cmis-plugin-mapping folder, located at [Ephesoft_Directory]\SharedFolders\<your batch class>. This includes the following files:
   • Aspects-mapping.properties
   • DLF-Attribute-mapping.properties
3. Paste the mapping files in the cmis-plugin-mapping folder of the imported batch class.
4. Restart Ephesoft Transact.

The post CMIS Export Failing on Imported Batch Class appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2020.1.03 and above

Issue

If you use custom scripts or other automated processes to retrieve logs through the web server service, you may experience issues due to security enhancements introduced in 2020.1.03.

Root Cause

In 2020.1.03 and above, you must now log in before accessing log files within the Application folder. This includes files such as the dcma-all.log and log4j.xml.

Ephesoft restricted access to these logs as a security enhancement, however, if required by your business process, you can revert this change.

How to Revert the Changes

1. Open the web.xml file, located at [Ephesoft_Directory]\Application\WEB-INF.
2. Locate the following 12 lines:

<security-constraint>
  <web-resource-collection>
    <web-resource-name>Restrict Logging</web-resource-name>
    <url-pattern>/logs/*</url-pattern>
    <url-pattern>/log4j.xml</url-pattern>
    <http-method>GET</http-method>
    <http-method>POST</http-method>
  </web-resource-collection>
  <auth-constraint>
    <role-name>*</role-name>
  </auth-constraint>
</security-constraint>

3. Remove the above lines.
4. Save and close the web.xml file.
5. Restart Ephesoft Transact.

The post Issue Accessing Application Logs appeared first on Ephesoft Docs.

This page lists the command-line options for all applications included in Ephesoft Transact.

Jump to:

• RecoStar Commands
  • HOCR
  • TIFF to PDF Conversion
  • PDF to TIFF Conversion
  • Extraction
• Ghostscript Commands
  • PDF to TIFF Conversion
  • PDF Optimization
• ImageMagick Commands
  • TIFF to TIFF Conversion
  • TIFF to PNG Conversion
  • Colored TIFF to PDF Conversion
  • Non-colored TIFF to PDF Conversion
  • PDF to TIFF Conversion
• Tesseract HOCR Command
• ZXing Command to Extract Barcode Value
• LibreOffice Convert-to Command

RecoStar Commands

HOCR

RecostarPlugin.exe “<rsbatch_file_path>” “<FPR.rsp_file_path>” bd <OCR_core_from_license> “<recostar_license_file_path>” _HOCR.xml <ocrConfidenceSwitch> <deskewSwitch> <encryptionKey> RECOSTAR_HOCR

Example (with no encryption key):

RecostarPlugin.exe “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI25\FileList.rsbatch” “F:\Ephesoft31\SharedFolders\BC5\fixed-form-extraction\Fpr.rsp” bd 4 “F:\\Ephesoft31\\Application/native/RecostarPlugin/bin\RSO2-NET.707″ _HOCR.xml ON OFF OFF RECOSTAR_HOCR

Example (with encryption key):

RecostarPlugin.exe “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI26\FileList.rsbatch” “F:\Ephesoft31\SharedFolders\BC5\fixed-form-extraction\Fpr.rsp” bd 8 “F:\\Ephesoft31\\Application/native/RecostarPlugin/bin\RSO2-NET.707” _HOCR.xml ON OFF f97beb0a4808f0cd0ce1a8fa7d9b686e RECOSTAR_HOCR

TIFF to PDF Conversion

RecostarPlugin.exe “<TifToPDF_rsbatch_file_path>” “<FPR_pdf.rsp_file_path>” pdf <OCR_core_from_license> “<recostar_license_file_path>” “<output_pdf_file_path>” <ocrConfidenceSwitch> <deskewSwitch> <encryptionKey> RECOSTAR_HOCR

Example:

RecostarPlugin.exe “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI24\TifToPdf.rsbatchDOC2” “F:\Ephesoft31\SharedFolders\BC5\fixed-form-extraction\FPR_Pdf.rsp” pdf 4 “F:\\Ephesoft31\\Application/native/RecostarPlugin/bin\RSO2-NET.707” “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI24\tempfile_BI24_documentDOC2.pdf” OFF OFF OFF RECOSTAR_HOCR

PDF to TIFF Conversion

SaveImage.exe “<pdf_file_path>” <compressionRatio> <path_of_output_folder> <Resolution (optional)>

Example:

SaveImage.exe "F:\Ephesoft\SharedFolders\sample-batches\multiPagePdf\multipage-pdf.pdf" 50 true "F:\Ephesoft\SharedFolders\sample-batches\multiPagePdf" -Rdpi=300

SaveImage.exe "F:\Ephesoft\SharedFolders\sample-batches\multiPagePdf\multipage-pdf.pdf" 50 true "F:\Ephesoft\SharedFolders\sample-batches\multiPagePdf"

Extraction

RecostarPlugin.exe “<rsbatch_file_path>” “<extraction_rsp_file_path>” xml <OCR_core_from_license> “<recostar_license_file_path>” ++++ <ocrConfidenceSwitch> <deskewSwitch> <encryptionKey> RECOSTAR_HOCR

Example:

RecostarPlugin.exe “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI2A\aaaa.rsp.rsbatch” “F:\Ephesoft31\SharedFolders\BC4\fixed-form-extraction\aaaa.rsp” xml 4 “F:\\Ephesoft31\\Application/native/RecostarPlugin/bin\RSO2-NET.707” ++++ OFF OFF OFF RECOSTAR_HOCR

Ghostscript Commands

PDF to TIFF Conversion

gswin64c.exe -dNOPAUSE -r300 -sDEVICE=tiffscaled24 -sCompression=lzw -dBATCH -sOutputFile=”<output_tiff_filename>-%04d.tif” “<input_pdf_file_path>”

Example:

gswin64c.exe -dNOPAUSE -r300 -sDEVICE=tiffscaled24 -sCompression=lzw -dBATCH -sOutputFile=”F:\Ephesoft31\SharedFolders\mailroom-import-copy1\multipage-pdf-pdf-1407824575554\multipage-pdf-%04d.tif” “F:\Ephesoft31\SharedFolders\mailroom-import-copy1\multipage-pdf-pdf-1407824575554\multipage-pdf.pdf”

PDF Optimization

gswin64c.exe -q -dNODISPLAY -P- -dSAFER -dDELAYSAFER — pdfopt.ps “<input_pdf_file_path>” “<output_pdf_file_path>”

Example:

gswin64c.exe -q -dNODISPLAY -P- -dSAFER -dDELAYSAFER — pdfopt.ps “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI25\tempfile_BI25_documentDOC1.pdf” “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI25\BI25_documentDOC1.pdf”

ImageMagick Commands

Convert.exe <conversion_param> “<input_file_path>” “<output_file_path>”

TIFF to TIFF Conversion

Example:

Convert.exe -limit area 100mb “F:\Ephesoft31\SharedFolders\mailroom-import-copy2\us-invoice\US-Invoice.tif” -compress LZW “F:\Ephesoft31\SharedFolders\mailroom-import-copy2\us-invoice\US-Invoice-%04d.tif”

TIFF to PNG Conversion

Example:

Convert.exe “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI23\BI23_0.tif” -colorspace gray -alpha off “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI23\BI23_PG0.png”

Example:

Convert.exe “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI23\BI23_0.tif” -colorspace rgb -thumbnail 200×150 “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI23\BI23_PG0_displayThumb.png”

Colored TIFF to PDF Conversion

Example:

Convert.exe test.tif -quality 100.0 -compress LZW out.pdf

Non-colored TIFF to PDF Conversion

Example:

Convert.exe test.tif -quality 100.0 -monochrome -compress LZW out.pdf

PDF to TIFF Conversion

Example:

Convert.exe -limit area 100mb “F:\Ephesoft31\SharedFolders\BC4\test-classification\multipage-pdf.pdf” -compress LZW “F:\Ephesoft31\SharedFolders\BC4\test-classification\multipage-pdf-%04d.tif”

Note: To use ImageMagick to convert from PDF to TIFF, you will need to copy the gs32bit files to the gs directory path. Alternatively, this path can be overridden in <Ephesoft_Directory>\Dependencies\ImageMagick\delegates.xml by replacing the following parameter with the complete gs.exe path:

@PSDelegate@

Tesseract HOCR Command

TesseractConsole.exe “<input_TIFF_file_path>” “<output_html_file_path_without_.html_extension>” “-l eng” +”<hocr.txt_file_path>”

Example:

TesseractConsole.exe ”F:\\Ephesoft31\\Application/native/Tesseract-OCR\TesseractConsole.exe” “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI29\BI29_5.tif” “F:\Ephesoft31\SharedFolders\ephesoft-system-folder\BI29\BI29_PG5” “-l eng” +”F:\\Ephesoft31\\Application/native/Tesseract-OCR\hocr.txt”

ZXing Command to Extract Barcode Value

Note: ZXing is only applicable to PNG files, and will not work with TIFF files.

java -cp zxing-1.6.0.jar;.; com.google.zxing.client.j2se.CommandLineRunner <png_file_path>

Example:

java -cp zxing-1.6.0.jar;.; com.google.zxing.client.j2se.CommandLineRunner a.png

Figure 1. Command Line Example

LibreOffice Convert-to Command

Example:

C:\Ephesoft\Dependencies\libreoffice\App\libreoffice\program\soffice.exe -invisible -accept=socket,host=localhost,port=8100;urp; –convert-to pdf C:\Users\Administrator\Downloads\test.txt

The post Command-line Options for Ephesoft Tools appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2019.2 and below
Resolved in: Ephesoft Transact 2020.1

Issue

When importing documents as new batches in Transact, certain Spanish characters may not display correctly. In particular, accents above letters may be converted to an incorrect character.

Root Cause

This issue occurs due to missing UTF-8 file encoding.

Solution

To resolve this issue, perform the following steps.

1. Go to [Ephesoft_Directory]\JavaAppServer\bin.
2. Right-click EphesoftTransact.exe and select Run as Administrator.

Figure 1. Run EphesoftTransact.exe as Administrator

3. Select the Java tab.

Figure 2. Java Properties

4. In the Java Options field, add the following line at the end:

-Dfile.encoding=UTF-8

Figure 3. Java Options

5. Click Apply and then OK.
6. Restart Ephesoft Transact.

The post KB00019437: Spanish Characters Not Displaying Correctly appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2020.1.02 and above

Issue

When attempting to upload new files, or edit or delete existing files from Folder Management, the following error will appear: “Upload of # file(s)/folder(s) failed.”

Additionally, the following error may be logged in the dcma-all log:

ERROR http-nio-8080-exec-7 com.ephesoft.gxt.foldermanager.server.UploadDownloadFilesServlet - 406File upload is not allowed in this folder, due to security measures.

This issue does not occur when attempting the same from File Explorer.

Root Cause

Starting in 2020.1.02, Ephesoft has introduced new security measures for uploading files using Folder Management. By default, this action is disabled.

Solution

To enable file upload and editing from Folder Management, perform the following steps:

1. Open the dcma-core.properties file in an editing program. This file is located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-core.

Figure 1. Open dcma-core.properties File

2. Set the following properties to “false”:

security.enabled.file.upload.download

security.enabled.scripts.folders

Figure 2. Security Flags

Note: The security.enabled.file.upload.download property determines whether the security layer for file transfer is enabled or disabled. By default, this is set to “true”. When set to false, the security checks are disabled.

The security.enabled scripts.folders property determines whether the security checks for the application-script and the Scripts folders are enabled or disabled. By default, this is set to “true”. When set to false, security checks are disabled for these folders.

3. Save and close the dcma-core.properties file.
4. Restart Ephesoft Transact.

The post KB00020735: Cannot Upload or Rename Files in Folder Management appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2020.1 and above

Issue

After upgrading from 2020.1 to 2020.1.02, if Ephesoft is configured to use HTTPS/SSL, you may experience problems accessing the Transact UI. Additionally, no relevant errors are present in the log files.

Root Cause

This issue may occur when using double backslashes (\\) in your cert path in the server.xml.

Solution

To resolve this issue, perform the following steps:

1. Open the server.xml file in an editing program, such as Notepad++. This is located at [Ephesoft_Directory]\JavaAppServer\conf.

3. Open the backup server.xml file taken before upgrading to 2020.1.02. By default, this is located at [Ephesoft_Directory]\Back-up-full20.20.1.0\JavaAppServer\conf.
4. Find the location of your certs file in the current server.xml, and compare it to your backup file.

For example, in the current server.xml, you may see a path like:

keystoreFile="C:\Ephesoft\certs\yourkey.jks

However, in your backup server.xml, you should see the correct working path:

keystoreFile="C:\\Ephesoft\\certs\\yourkey.jks

5. Update your current server.xml to reflect the correct path from the backup server.xml.
6. Restart Ephesoft Transact.

The post KB00019780: Problem Accessing UI After Upgrading from 2020.1 to 2020.1.02 appeared first on Ephesoft Docs.

Applies to: Ephesoft Transact 2019.2 and below

Issue

Prior to Ephesoft Transact 2020.1, the cron expression year values are set to 2020 by default. Upon entering the 2021 calendar year, these installations along with any modifications that are hardcoded to a specific year in the past would be at risk of startup failure with the following error:

ERROR localhost-startStop-1 org.springframework.web.context.ContextLoader - Context initialization failed
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.scheduling.quartz.SchedulerFactoryBean#10' defined in class path resource [META-INF/dcma-folder-monitor/applicationContext.xml]: Invocation of init method failed; nested exception is org.quartz.SchedulerException: Based on configured schedule, the given trigger 'DEFAULT.cronTrigger_folderMonitorServiceDaemon' will never fire.

Cron expressions must be valid for the current time period. Any cron year set previous to the current year would fail to evaluate properly.

The three optional features controlled by cron expressions affected by this are:

• foldermonitor.re_add_watch.cronjob.expression
• dcma.alwayson.cronjob.expression
• log_rotation_cronjob_expression

Transact 2020.1 and above has cron expression year values correctly set to 2099 by default to indicate these options as being disabled. No issues should occur for these versions moving into 2021.

Solution

If you have a use case that requires the usage of any of these three features, and you are seeing this issue, check that the cron settings are set appropriately so that the feature is enabled and working across multiple years. An asterisk (*) is used to accomplish this for the year value in the cron expression.

Incorrect cron example that will fail once 2022 is reached: 0 0/1 * ? * * 2021
Correct cron example: 0 0/1 * ? * * *

Otherwise, if you don’t know if you require these features and would like to keep these in the default disabled state, follow the steps below.

The following CRON files will need to be updated to resolve the issue. These changes need to be applied to all Transact servers regardless of the operating system, including single server installations and multi-server clustered installations.

1. Go to [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF.
2. Open the application.properties file in a text editor, such as Notepad++.
3. Locate the following line:

javaappserver_log_rotation_cronjob_expression =0 */5 * ? * * 2020

4. Change the above line to the following:

javaappserver_log_rotation_cronjob_expression =0 */5 * ? * * 2099

5. Save and close the application.properties file.
6. Open the folder-monitor.properties file, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-folder-monitor.
7. Locate the following line:

foldermonitor.re_add_watch.cronjob.expression=0 0 0 * * ? 2020

8. Change the above line to the following:

foldermonitor.re_add_watch.cronjob.expression=0 0 0 * * ? 2099

9. Save and close the folder-monitor.properties file.
10. Open the dcma-workflow.properties file, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-workflows.
11. Locate the following line:

dcma.alwayson.cronjob.expression=0 0/1 * ? * * 2020

12. Change the above line to the following:

dcma.alwayson.cronjob.expression=0 0/1 * ? * * 2099

13. Save and close the dcma-workflow.properties file.
14. Restart Ephesoft Transact.

The post KB00020939: org.quartz.SchedulerException Logging Error/Startup Issues During Annual Roll Over of New Year 2021+ appeared first on Ephesoft Docs.

Applies to: 2020.1.02

Issue

When importing a batch class, the string added to the Index Field Value Separator option under the VALIDATE_DOCUMENT plugin is ignored. Instead of the defined string, spaces separate the values.

Figure 1. VALIDATE_DOCUMENT Plugin

The post Known Issue: Index Field Value Separator in Validate_Document Not Working appeared first on Ephesoft Docs.