149. Upgrading from EzeScan 4.3 to EzeScan 5.0

** Please read through this entire document completely and review its content before you start any upgrade process.

Deprecated Features

Unsupported Features on 64-bit

1. Advantages of Migrating to EzeScan 5.0

EzeScan 5.0 is completely re-written using the latest cutting edge technology - up to 20% faster for some customers when compared against EzeScan 4.3.

• Added 64-bit support for larger memory allocations when dealing with large images

• Thumbnails rewritten to asynchronously load and allow configurable count and layout

• Page operations are now much faster due to batch management changes

• Added authentication and numerous management features to EzeScan Server web admin

• Advanced Line Item detection, Aggregate functions and multi instance synchronisation added to LINES

• Smart Discovery Engine optimisations and multi instance synchronisation features added to DISCOVERY module

• On top of the existing connectors EzeScan 5.0 supports the following new integration connectors:

  • Blackbaud Payments

  • Leap

  • Lexis Nexis Affinity

  • Link4 PEPPOL

  • Net Documents

  • Practice Evolve

  • Prime Ecosystem

  • Business Craft V2

  • Objective WebTalk+

  • Objective Nexus

  • Email Link Extractor

  • StrataMax

• EzeScan 5.0 is available in a 32 bit version or a 64 bit version.

2. Choosing between the 64 bit or 32 bit version of EzeScan 5.0?

a. The version of Microsoft Windows installed on the PC will determine if the 64 bit of EzeScan 5,0 can be used. Why?

1. The 32 bit version of Windows can only support 32 bit EzeScan. 32 bit Windows can only allocate up to 2GB of RAM to the 32 bit EzeScan process. Scanning large colour A4 documents of 500+ pages may fail when scanning in Colour at 300 dpi.

2. Whereas the 64 Bit version of Windows can support 32 bit or 64 bit EzeScan.

3. 64 bit Microsoft Windows restricts a 32 Bit EzeScan process to using 2GB of RAM. Therefore, scanning large colour A4 documents of 500+ pages may fail when scanning in Colour at 300 dpi.

4. 64 bit Microsoft Windows allows a 64 bit EzeScan process to utilise nore than 2GB of RAM. Therefore, scanning large colour A4 documents of up to 1000 pages usually works okay when scanning in Colour at 300 dpi.

b. If you are scanning with a TWAIN compliant scanner, you must check if the scanner properly supports 32 bit or 64 bit TWAIN drivers.

1. If the scanner only supports using the 32 bit TWAIN driver you must install the 32 bit version of EzeScan.

2. If the scanner only supports using the 64 bit TWAIN driver you must install the 64 bit version of EzeScan.

3. If the scanner supports 32 bit and 64 bit TWAIN driver, make sure you use the 32 bit TWAIN driver with 32 bit version of EzeScan, and the 64bit TWAIN driver with the 64 bit version of EzeScan

4. Old scanner models tend to only support 32 bit TWAIN driver, whilst new model almost always support a 64 bit TWAIN driver.

c. If you are using EzeScan with integration connectors to import files from an integrated system, browse folders on an integrated system, or output files to an integrated system (e.g. document management system or a financial system) you need to ask our support team if the connector you are using is using a REST Web service API or an COM API. Why?

1. Newer REST web service integration connectors use HTTPS and therefore have no restrictions with regards to 32 bit or 64 bit. HTTPS works okay with 32 Bit and 64 bit version of EzeScan REST based based connectors.

2. Older legacy integration connectors using COM API’s are usually built to just work with either 32 bit or 64 bit. The use of a legacy based 32 bit COM API may force you to use only 32 bit EzeScan,

d. So whilst, many of our customers can take advantage of choosing EzeScan 5.0 64 bit with its faster processing speed and its ability to handle larger sized A4 colour documents, there are some customers who will need to choose to use EzeScan 32 bit because they are stuck on a 32 bit version of windows, or stuck using an older scanner which only has 32 bit TWAIN driver support, or stuck using an old integration connector that used a 32 bit COM API.

e. If you still still need help to decide whether you should upgrade to the 64 bit or 32 bit versions of EzeScan 5.0 please contact our support team.

2. Upgrade Process

Before the upgrade

Wherever possible, you should consider performing the upgrade first on a test system, and once you have successfully completed that process and everything is working as it should be, then plan the upgrade of your production system.

💾 Installation

.Net Framework 4.8 is required to install EzeScan 5.0 (the install will fail if this dependency is missing)

32-bit Installation

1. Backup your existing configuration (there are some settings migrations that cannot be undone).

2. To create a backup, start EzeScan Desktop, then use the Admin menu Setting Backup → Export option.

3. Select an import folder to place the backup into (e.g. C:\ProgramData(x86)\Outback Imaging\EzeScan\Backups\24OCT2022

4. Choose ‘Backup Entire EzeScan configuration' from the 'Selected settings to export’ list.

5. Press Export.

6. A message is displayed saying ‘Backup Completed Successfully’ and the export settings form is then closed.

7. Proceed to the Performing the upgrade 32-Bit installation instructions below

 64-bit Installation

1. Backup your existing configuration (there are some settings migrations that cannot be undone).

2. To create a backup, start EzeScan Desktop, then use the Admin menu Setting Backup → Export option.

3. Select an import folder to place the backup into (e.g. C:\ProgramData\Outback Imaging\EzeScan\Backups\24OCT2022)

4. Choose the ‘Backup Entire EzeScan configuration' option from the 'Selected settinsg to export’ list.

5. Press Export.

6. A message is displayed saying ‘Backup Completed’ and the export settings form is then closed.

7. Proceed to the Performing the upgrade 64-Bit installation instructions below

Performing the upgrade

.Net Framework 4.8 is required to install EzeScan 5.0 (the install will fail if this dependency is missing)

32-bit Installation

1. Download and run the (x86) installer from https://www.ezescan.com.au/downloads/software-downloads/ezescan-installers

2. By default the 32 bit application will be installed in C:\Program Files (x86)\Outback Imaging\EzeScan and the desktop shortcut will be labelled EzeScan

 64-bit Installation

1. Download and run the (x64) installer from https://www.ezescan.com.au/downloads/software-downloads/ezescan-installers

2. By default the 64 bit application will be installed in C:\Program Files\Outback Imaging\EzeScan and the desktop shortcut will be labelled EzeScan

After the upgrade

Go through all your Jobs and Routes and thoroughly test each one to make sure that they still work as expected.

Common post upgrade issues that will need attention

1. Every Job, KFI, Upload and Route should be tested one at a time to ensure that they still work.

2. There are some items that the EzeScan Backup/Restore process will not transfer from the old PC to the new PC. These will need to be found and fixed. Common issues are listed below.

3. When using OAuth authentication methods, the OAuth tokens for the integration connectors will need to be refreshed before the connectors will work properly.

4. Any ODBC connections referenced by EzeScan that existed on the old EzeScan version, will need to be reviewed/updated.. The 32 bit version of EzeScan uses 32 bit ODBC drivers, whereas the 64 bit version of EzeScan uses 64 bit ODBC drivers.

5. Add ODBC data sources to 64-bit ODBC data source manager if migrating to 64-bit.

6. Service credentials needed to run EzeScan Server instances will need to be re-entered into the Windows Services, Service Properties, Logon tab.

7. TWAIN scanner drivers may need to be reinstalled, to match the version of EzeScan 5.0 being deployed.

8. Reconfigure lookups to use Sqlite if migrating to 64-bit. Access DB engine is known to crash when running in 64-bit process and no fix is available.