Migrating the Ephesoft SharedFolders Location

October 28, 2020
|In Configuration, System
|By Breanna Fitzgerald

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
  1. 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
  1. 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
  1. 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
  1. dcma-workflows.properties, located at [Ephesoft_Directory]\Application\WEB-INF\classes\META-INF\dcma-workflows\
 Line 15: newWorkflows.basePath=\\\\NEW_UNC_PATH\\SharedFolders/workflows
  1. 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
  1. server.xml, located at [Ephesoft_Directory]\JavaAppServer\conf\
 Line 156: <Context path="/dcma-batches" docBase="\\\\NEW_UNC_PATH\\SharedFolders" debug="10" privileged="false"/>
  1. 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"
  1. 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"
  1. Dashboard.Dashboard.lgx, located at [Ephesoft_Directory]\EphesoftReports\_Definitions\_Reports\
 Line 19: SaveFile="\\\\NEW_UNC_PATH\\SharedFolders\SavedDashboards\Dashboard_User_@Session.userName~.xml"
  1. 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
  1. 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
  1. 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:

  1. 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

  1. 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 

  1. 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.