Upgrade Server Components

---

Information

R14 is designed for new installations, if you have migrated your Sage Endpoint (from V6.5 to V12 for instance) it is recommended to stay on the same version of EDM, but for compatibility reasons this isn't always possible.

Some example scenarios may include:

Our customer had V6.5 Patch 30 of Sage X3 using EDM R10 and have moved to Sage X3 V11
The lookups have stopped working

Our customer had V7 Patch 5 of Sage X3 using EDM R11.1 and have moved to Sage X3 V11
Our documents have stopped delivering

Our customer had PU8 Patch 5 of Sage X3 using EDM R12 and have moved to Sage X3 V12
PIA won't accept documents

If you do have a requirement for R14, before you perform your Sage upgrade, you are advised to complete the below Upgrade Requirements Form.

A V1 professional services engagement is required to assist in the process, it will give the Project Management team all the necessary details about your environment who will then advise accordingly.

Upgrade Requirements Form (*.docm)

When completed, click here and send it as an attachment to our Sage Professional Services team.

You will be contacted asap on the next course of action.

---

Upgrading from R13.3

The previous version of EDM for Sage X3 was R13.3 and that shares many of the components as R14, so the procedure is relatively straight forward, but as above, it is strongly recommended to arrange a V1 Professional Services engagement.

If any files have had bespoke changes / enhancements made since the baseline R13.3 was implemented, they will be lost unless manually merged back in to the R14 files you are about to upgrade too.

Follow this procedure very carefully, Customers / Partners who perform an upgrade themselves do so at their own risk.

Assumptions:

• R13.3 is installed to C:\V1
• All day to day users are logged out of both V1 and Sage X3

---

Download R14

Click here to download R14 and un-compress to a temporary location (for the purposes of this procedure, we will assume C:\EDMR14, change to fit your location)

---

EDD

If the customer just has EDD (i.e. no EDM or PIA):

Procedure:

1. Go to services.msc and stop the following services in this order:

• V1SmartMail (where installed)
• All EDM* services
• All EDD* services
• DbLogin (this must be stopped last)

2. Take a copy of the C:\EDMR14\DbLogin\DbLoginServer.exe
3. Replace the one in C:\V1\DbLogin (you are advised to take a backup first, i.e. DbLoginServer.exe.R13)
6. Take a backup of C:\V1\EDDOUTBOUNDMANAGEMENT\EDDOUTBOUNDMANAGEMENT.def (rename it so EDDOUTBOUNDMANAGEMENT.def.R13.3 for instance)
7. Take a copy of the C:\EDMR14\EDDOUTBOUNDMANAGEMENT\EDDOUTBOUNDMANAGEMENT.def
8. Copy it to C:\V1\EDDOUTBOUNDMANAGEMENT\EDDOUTBOUNDMANAGEMENT
9. Edit it and set the following values / variables to align with your environment / requirements (you can take most settings from you backup):

• MODE
• ALERT
• USERSTOINFORM
• ATTACHFAILDOCS
• MAXATTACHMENTSIZE
• CLEANUPROCESSED
• AGECHECK
• DIRTOCLEANUP
• V1_DIR
• DBARCHIVESERVER
• MAIL

10. Take a backup of C:\V1\EDMPRINTMANAGEMENT\Print_Pickup.def (rename it so Print_Pickup.def.R13.3 for instance)
11. Take a copy of the C:\EDMR14\EDMPRINTMANAGEMENT\Print_Pickup.def
12. Copy it to C:\V1\EDMPRINTMANAGEMENT\
13. Edit it and set the following values / variables to align with your environment / requirements (you can take most settings from you backup):

• #USES
• EMAILITDEPTONFAILURE
• Mail

14. Restart all services in reverse order they were stopped, DbLogin must start first.

As an optional step, using the Implement EDD section as a guide, you can add to your existing Crystal Report(s) the extra tags now supported as per the customer requirements

NOTE: If no additional tags are required, no further is action required.

This completes the high level upgrade procedure for EDD. Your system is now the equivalent of a fresh install of R14, but upgraded from an existing R13.3 installation with existing data.

---

EDM

If the customer has EDM (which will include EDD but no PIA) complete the EDD procedure and in addition:

Procedure:

1. Go to services.msc and stop the following services in this order:

• ArchJson
• V1NodeIntegrationServer
• V1HTTPServer
• V1WebPortal
• V1SmartMail
• All DbArchive* services
• All EDM* services
• DbLogin (this must be stopped last)

2. Navigate to Control Panel > Programs and Features > Un-Install the V1Webportal (this module has been deprecated as a seperate installation, it now forms part of the V1NodeIntegrationServer)
3. Open a cmd prompt as administrator and issue the following command:

sc delete V1WebPortal

4. Using Windows File Explorer, navigate to the C:\EDMR14\SmartSuite directory
5. Run the ArchJsonSetup.MSi, agreeing to the defaults
6. Run the HTTPServerInstaller.MSi, agreeing to the defaults
7. Run the NISSetup.Msi, click Next when promoted for a name and set the port to 5002. Click Next and Install. (this will take several minutes, this is normal)
8. Run the SmartMailInstaller.MSi, agreeing to the defaults
9. Restart all services in reverse order they were stopped, DbLogin must start first.
10. Open the SQL Management Console
11. Connect to the same instance as used by the setup program
12. You should see the DbArchive database, create a new database at the same level called V1Documents
13. In your web browser of choice, browse to http://MYSERVER123:5002
14. Login as administrator / administrator
15. Change the url from http://MYSERVER123:5002/portal to http://MYSERVER123:5002/config and press enter (this is a back door to the config and not exposed for general use)
16. Click Configure integration server
17. Scroll down to the section V1 document server
18. Enter the JDBC connection string to connect to the SQL server where the V1Documents database was created, an example would be:

jdbc:sqlserver://MYSQLSERVER\MYSQLINSTANCE;Database=V1Documents

Change the text in red as applicable to your actual environment.

19. Enter the Database connection user
20. Enter the Database connection password
21. Click Test JDBC connection, where successful, you will see a green tick
22. Click OK
23. Again, change the url from http://MYSERVER123:5002/portal to http://MYSERVER123:5002/config and press enter
24. Click Configure integration server
25. Scroll down until you see 'Other configuration' and click 'Import user from DBLogin'
26. Scroll to the bottom and click OK
27. Go to User Management > Manage Users, you should now see all your existing DbLogin users
28. Click the pencil for each one and un-tick 'must change password' or they will be forced to when they come to login
29. Take a copy of the C:\EDMR14\DbArchive\Defs\*.def files
30. Paste them into the C:\V1\DbArchive\ directory (you are advised to take backups of those it replaces to accomodate merging any bespoke changes)
31. Edit the files therein and change the #USES path to align with the actual installation path
32. Take a backup of C:\V1\EDMIMPORT\EDMIMPORT.def (rename it so EDMIMPORT.def.R13.3 for instance)
33. Take a copy of the C:\EDMR14\EDMIMPORT\EDMIMPORT.def
34. Paste it to C:\V1\EDMIMPORT\ replacing the existing one (take a backup where needed.)
35. Edit it and set the following values / variables to align with your environment / requirements (you can take most settings from you backup):

• #USES
• Mail

36. Login in to the Sage front screen as an ADMIN user and select the X3 reference Endpoint
37. Click on Development then on > Utilities > Patches > Patch Integration
38. Ensure Client is selected as a destination type
39. Ensure to TICK Patch integration and UNTICK Deferred validation
40. Remove the X3 reference Endpoint from the grid
41. Keep all Endpoints currently patched for R13.3, remove all others
42. Click OK
43. Where prompted, browse to X3EDM_0140000_60_000.dat in the C:\EDMR14\PATCH\EDM\PROD_ENDPOINT dir, click OK

This completes the high level upgrade procedure for EDM. Your system is now the equivalent of a fresh install of R14, but upgraded from an existing R13.3 installation with existing data.

---

PIA

1. Go to services.msc and stop the following services in this order:

• V1NodeIntegrationServer
• All DbCapture* services
• DbLogin (this must be stopped last)

If the customer has PIA (which will include EDD and EDM) complete the EDD, EDM procedures and in addition:

2. Take a copy of the C:\EDMR14\DbCapture\Defs\*.def files
3. Paste them into the C:\V1\DbCapture\defs directory (you are advised to take backups of those it replaces to accomodate merging any bespoke changes)
4. For each, edit and set the following values / variables to align with your environment / requirements (you can take most settings from you backup):

• #USES

5. Take a copy of the C:\EDMR14\DbCapture\Defs\Includes\*.def files
6. Paste them into the C:\V1\DbCapture\defs\includes directory (you are advised to take backups of those it replaces to accomodate merging any bespoke changes)
7. For each, edit and set the following values / variables to align with your environment / requirements (you can take most settings from you backup):

• #USES

8. Run DbCapBackground.MSi pointing the path to the same as the current location
9. Run DbCapComms.MSi pointing the path to the same as the current location, e.g. C:\V1\DbCapture\DbCapComms (NOTE: No spaces)
10. Run DbCapExport.MSi pointing the path to the same as the current location
11. Run DbCapOCRServer.MSi pointing the path to the same as the current location
12. Using Windows File Explorer, navigate to the C:\V1Home\DbCapture\DbCapOCRServer directory
13. Using your text editor of choice, edit rhe DbCapOCRServer.exe.config
14. Find the key="IntegrationServerUrl" value="http://localhost:6181" value and set the port to 5002, save the file.
15. Run DbCapUtil.MSi pointing the path to the same as the current location
16. Run msoledbsql_64 / 32.MSi (depending on the architecture of your server 64 / 32 bit respectively)

NOTE: If you are un-sure, open a cmd prompt and enter:

wmic os get osarchitecture

NOTE: After installing the MSi's a restart may be required

17. Restart all services in reverse order they were stopped, DbLogin must start first.
18. Login in to the Sage front screen as an ADMIN user and select the X3 reference Endpoint
19. Click on Development then on > Utilities > Patches > Patch Integration
20. Ensure Client is selected as a destination type
21. Ensure to TICK Patch integration and UNTICK Deferred validation
22. Remove the X3 reference Endpoint from the grid
23. Keep all Endpoints currently patched for R13.3, remove all others
24. Click OK
25. Where prompted, browse to the C:\EDMR14\PATCH\PIA\PROD_ENDPOINT dir and select the patch, click OK

This completes the high level upgrade procedure for PIA. Your system is now the equivalent of a fresh install of R14, but upgraded from an existing R13.3 installation with existing data.

---

Registry Validation

A manual step, but best practice.

1. Open regedit
2. Go to th following key: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Version One\DbLogin
3. Ensure the port of the NISServerURL is 5002 and it includes /api, so an example would be: http://localhost:5002/api

You will now have a functional system, but where you have bespoke additions to PIA for DbCapture that you wish to migrate to PIA for SmartExtract, they must be added to the associated validate / accept / onhold / delete dbform definition files linked to the SmartExtract Extract Events.