This article will guide you through upgrading the Field2Base Enterprise Dispatch Module (EDM) software.
Upgrade the Required Components (as needed)
1. The EDM 6.2 does require .NET Framework Version 4.5 whereas previous versions only required version 4.0.
|Note||Most PCs already have .NET Framework Version 4.5 (or newer) installed so this first component is only required if it does not.|
2. If you are currently using an EDM version prior to 1.3, the following components need to be installed:
|Note||If version 1.3 or newer of the EDM is installed, you do not need to install the SQL Server Compact Edition component as it is already installed.|
Backup Existing Database Files
The latest upgrade process requires that the database files be manually backed up and copied over to ensure the EDM history is not reset when the new version is installed.
To avoid resetting the history, the core files to its operation in the EDM Program Files folder should be copied to another folder (like the Desktop or My Documents). These files will be copied back into the folder later in the process.
|Note||If you have setup the EDM with the E-Mail Alerts option, then you will need to perform this backup because the E-Mail Alerts option will get reset once the upgrade is completed. The only file required for the E-Mail Alerts option to backup is the F2BDispatcherService.exe.config file.|
1. The EDM service should be stopped. The service can be stopped by using the EDM Admin Utility > Services section > click Stop.
2. Copy the following items into a backup folder location (like on the Desktop or in My Documents):
- Dispatcher.sdf and Log.sdf Files
- Jobs subfolder
3. If it’s not already part of a regular backup, we recommended making copies of the Forms, Jobs, and the Logs subfolders in the EDM Program Files folder before applying this upgrade.
Record EDM Windows Service Account Settings
If your EDM generates files out on a network share, then the EDM’s Windows Service may have a different Account Log On setting than the default System account.
You can determine this by opening up Windows Services > opening the F2BDispatcherService Properties > Log On tab and checking to see if the This account option is enabled. If it is, you will need to record what account it is and make sure you know the password is before starting the upgrade.
When the upgrade is completed, you will need to re-apply this Windows Service Account Log On setting for the F2BDispatcherService.
Install the Correct Edition of the EDM
As a reminder, the Server Edition is intended to be run on servers and will only install the EDM service and the Administrator utility.
The Designer Edition is intended to be run on Desktop PCs and will install all utilities and the EDM service.
1. Download and extract the appropriate Installation Files.
2. Once it is downloaded, run the selected EXE.
3. Click Next.
4. Click Next.
5. Click Install. The status of the EDM installation will be shown for a few moments.
6. Click Finish.
Apply EDM Windows Service Account Settings
If you had a different Account Log On setting for the EDM Windows Services, then you will need to re-apply this setting before starting the EDM Service once more.
Go to Windows Services > open the F2BDispatcherService Properties > select the Log On tab > change it to the This account option and enter the correct credentials for the User Account recorded before the upgrade.
Restore Existing Database Files
It is now time to copy the backed-up folders and files (i.e. Dispatcher.sdf, Log.sdf, etc.) back to the EDM Program Files folder from the Backup folder created earlier.
When prompted to overwrite the existing files, click Yes and overwrite the files. The EDM is now ready to resume processing PreFills where it left off.
|Note||If you need to enable the E-Mail Alerts option from your previous install, then you will also need to copy the F2BDataIntegrationService.exe.config file back into the DIM Program Files folder.|
Anti-Virus Software Exclusion Reminder
Since you already have the EDM installed on your PC, Field2Base just wanted to put out a reminder that we recommend you take the precautionary step to exclude the EDM application from your Anti-Virus scanning and any other security software that may alter the installation.
The reason we recommend the exclusion is that Field2Base protects the code of our software using a process called obfuscation (which essentially encrypts the code) and unfortunately in this day and age, malware creators will often use a similar method to make their viruses harder to combat. Anti-Virus and Security Companies will flag the same obfuscation profile of our software and it results in our software being incorrectly identified as a security threat.
Since there are so many different Anti-Virus scanners and security software out there, we cannot provide the exact steps on how to exclude the software, but from our experience, it is typically found in the Settings for the software. You will then need to exclude the following folder depending on the Operating System (OS) version:
- 32 Bit OS: C:\Program Files\F2B Enterprise Dispatch Module
- 64 Bit OS: C:\Program Files (x86)\F2B Enterprise Dispatch Module
Service Network Access
Starting with version 6.2, the EDM Service now uses the standard HTTPS Port of 443 to submit PreFills to our cloud. New EDM Projects created in the EDM Project Manager will use this port by default.
If you want to upgrade your existing EDM Projects to use the updated port, you can manually upgrade the EDM Project in Notepad; if you need assistance with making such an update, please contact Technical Support for assistance.
If you do not want to upgrade your existing EDM Project to use this port, please just remember to keep the previously setup HTTP (2001) and HTTPS (2443) Ports open to allow the EDM to continue to function correctly.