This guide contains the basic steps for upgrading a CM4D Client from v23 up to v24. This is a major version upgrade and should be done as a complete uninstall and then reinstall.
For new installations, refer to the Quick Reference Guide - Install CM4D Client here.
Tip
This
topic is intended for upgrading Clients that are part of a larger setup
that includes at least one CM4D Server installation that would be upgraded
before any client systems. If you are upgrading a standalone
Client system, you may want to use the CM4D Server Upgrade Guide
here, as it includes additional
steps that you may need to complete in a standalone environment.
Contact your ATS sales representative or ATS support for assistance.
1. Obtain the v24 CM4D Client installer.
2. Perform a backup of all of your CM4D install/configuration files and databases.
a. CM4D.4ds - file can be copied to v24
b. Cm4d.ini - for content comparison only
c. ATSLicensingServer.Client.dll.config - for content comparison only
Notice
Do
not directly restore configuration/settings files from v23 as there may
be changes or updates that you need in the new files installed with CM4D
v24. It would be best to compare these files directly to the files created
by the installer and only take the information you need. Keep the previous
files only as a backup and a reference for connection/configuration information.
The only exceptions is the CM4D.4ds.
3. Uninstall CM4D v23.x. If you are running an older version, see here for migration guides to get up to v23.
4. Uninstall CM4D Printer (if installed with v23.6).
5. Delete the CM4D installation folder and all remaining files/folders.
6. Reboot your computer.
Notice
Before
starting the CM4D installer, the 'Print Spooler' Windows service must
be running. If the service is not running, the installation will fail.
7. Run the CM4D Client installer (see here for Servers).
a. Run the CM4D Client installer executable (Run as Admin).
b. Install the Prerequisites (restart the machine if prompted; on restart, installer will resume automatically).
c. Set the Installation folder.
d. Select the Installation Type 'Configure and Install'.
e. Enter Services user information.
f. Enter the name of the ATS Licensing Server.
8. Connect to the CM4D Site Database. If you have an existing v23 CM4D.4DS file, you can copy it from your backup folder (archived in step 1) to the v24 install folder. If you do not have a 4DS file, run DbConnect (as Administrator). If you are using an Unmanaged Database, see here for connection instructions.
a. Run DbConnect (as Administrator).
b. Connection Type - Change the dropdown to "Site Connection".
c. Windows Authentication - Select one of the two available methods of authentication for connecting to the databases:
i. Windows Authentication - Set the dropdown to 'True'.
ii. SQL Authentication - Set the dropdown to 'False'.
(1) Database User ID - Enter the user name of the SQL user login.
(2) Database Password - Enter the password for the SQL user.
(3) Confirm Password - Re-enter the SQL user password.
d. Server Name - Enter the name of the database server. If using a Named Instance, include this in the server name.
e. Database Name - Enter the name of the CM4D Site database.
f. Click Apply.
g. Click Test Connection.
i. If successful, click OK and continue to the next step.
ii. If the connection fails, check all of your settings and then test again.
h. Click OK to exit DbConnect.
9. Restore CM4D configuration settings. Compare the Cm4d.ini file archived in step 1 of this upgrade to configure the new v24 files as needed. DO NOT REPLACE the new v24 files with the old files saved from v23!
10. Configure CM4D Printer.
a. Browse to the CM4D install folder (.\Applied Tech Systems\CM4D).
b. Edit the Cm4d.ini file (requires READ/WRITE Administrator privileges).
i. In the [default] section find the parameter "PDFPRINTDRIVER".
ii. Set the value to "ATS CM4D Printer".
iii. Comment out (#) the other print driver options or delete the unused lines entirely.
c. Save and close the Cm4d.ini file.
11. Start Results Services. If you did not configure service logon user during the CM4D installation, edit the properties of each service and set the Logon User. See here for more information on each of the services.
a. Open Control Panel > Administrative Tools > Services.
b. Start the following services (in this order):
i. Results Service
ii. Results Launcher
iii. Results Loader
c. On new installations, the services may not start. If you are using a service user account that has never been granted the Log On As A Service rights, complete the following steps on one service.
i. Right-click on the Results Service and select Properties.
(1) Go to the Log On tab.
(2) In the Log on as section, select This account.
(3) Enter the User credentials for the user account that will run the CM4D service.
(4) Click OK.
ii. Click OK on informative message ‘The account … has been granted the Log On As A Service right.’
iii. Start the 2 remaining Results services.
This completes your v23 to v24 Client upgrade.