Tip These steps may also be followed if you are upgrading a standalone Client system, in which case just ignore the references to the CM4D Scheduler, DataSmith Batch and EventSmith.
In this topic: Hide
This guide contains the basic steps for upgrading a CM4D Server from v23 up to v24 and generating Results for your existing databases. 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 Server here.
Tip
These
steps may also be followed if you are upgrading a standalone Client system,
in which case just ignore the references to the CM4D Scheduler, DataSmith
Batch and EventSmith.
Contact your ATS sales representative or ATS support for assistance.
1. Obtain v24 CM4D Licenses.
2. Obtain the v24 CM4D Server installer.
3. 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. CM4DLauncher.settings - for content comparison only
d. CM4DScheduler.settings - for content comparison only
e. DataSmithBatch.Settings - file can be copied to v24
f. ATSLicensingServer.Client.dll.config - for content comparison only
g. Site DB - for backup only
h. CM4D DB(s) - for backup 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 are the CM4D.4ds and DataSmithBatch.Settings files.
4. Uninstall CM4D v23.x. If you are running an older version, see here for migration guides to get up to v23.
5. Uninstall CM4D Printer (if installed with v23.6).
6. Delete the CM4D installation folder and all remaining files/folders.
7. Uninstall eDoc PDF Printer (optional). Complete this step only if you have eDoc PDF Printer and want to switch over to the ATS CM4D Printer (embedded with v24 installer).
8. 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.
9. Run the CM4D Server installer (see here for Clients).
a. Run the CM4D Server 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. This user does not have to exist at this time but when you do create it be sure to use the same information.
f. Enter EventSmith SMTP information.
g. Enter EventSmith Site Database connection information.
h. Enter the name of the ATS Licensing Server.
10. Upgrade v23 Databases. Update the latest v23 databases (23a-23d) to v24 (24c-24b).
Notice
Check
your current schema versions (Programmability>Stored
Procedures) for the Site (dbo.SiteSchemaVersion)
and CM4D (dbo.SchemaVersion)
databases . If you are not currently at the latest Site Schema 23d and
CM4D Schema 23a, you must run any interim v23 update scripts before running
the v24 update scripts.
a. Update your Site Database:
i. From the database dropdown, select your v23 CM4D Site database.
ii. Go to the install folder (.\CM4D\Database Scripts\SQL Server) and open "UpdateSite24a.sql".
iii. Click Execute.
iv. Execute the "UpdateSite24b.sql" script.
v. Next, execute the "Site Indexes.sql" and "Site Grant.sql" scripts.
b. Update your CM4D Database(s):
i. From the database dropdown, select a v23 CM4D database.
ii. Go to the install folder (.\CM4D\Database Scripts\SQL Server) and open "Update24a.sql".
iii. Click Execute.
iv. Execute the "Update24b.sql" script.
v. Execute the "Update24c.sql" script.
vi. Next, execute the "Indexes.sql" and "Grant.sql" scripts.
vii. If you have more than one CM4D database, execute all of scripts on each of those databases in the same order listed above.
11. 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).
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.
12. Restore CM4D configuration settings. Compare the files 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!
a. DataSmithBatch.Settings. Confirm or set the default settings file location.
i. Run DataSmithBatch Manager as Administrator.
ii. In the top left of the interface, find the Batch Processor Settings section. If this is incorrect, complete the following:
(1) Click the ellipses following the File Path.
(2) Browse to the existing DataSmith Batch settings file.
(3) Select the folder and click OK.
iii. Click Make Default.
iv. Click Save & Exit.
13. Configure CM4D Printer. If you have eDoc installed, you may choose to skip this step.
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.
14. Configure Results Database Connection. This is a REQUIRED step. Until you complete this step you will not be able to run any other CM4D applications (besides DbConnect and Site Manager).
a. Run Site Manager.
a. Go to the Results DataSource tab and enter the required information.
Notice
The
Results database object may not exist at the time of initial configuration
if this is a brand new installation (Test Connection will FAIL - this
is ok). The information still needs to be entered here since it will be
used by DbMigrator to create the database object when the tool is run.
b. If Enable Results Datasource is not checked, select the box to turn on the Results database.
c. Enter the required database information.
i. Server Name - Enter the name of the database server. If using a named instance include the instance name with the server.
ii. Database Name - Enter the name of the Results Database.
iii. Windows Authentication - Select one of the two available methods of authentication for connecting to the databases:
(1) Windows Authentication - Set the dropdown to 'True'.
(2) SQL Authentication - Set the dropdown to 'False'.
(a) DataBase UserName - Enter the user name of the SQL user login; must have the 'dbowner' privilege level in SSMS. This is the login used by DbMigrator to create/modify the Results database in SQL Server.
(b) Password - Enter the password for the SQL user.
(c) Confirm Password - Re-enter the SQL user password.
iv. Click Test Connection.
(1) If successful, click OK and continue to the next step.
(2) If the connection fails on an existing Results database, check your settings and then test again.
(3) If the connection fails in a new installation (before Results db is created), this is ok and you can continue to the next step.
d. Click Save.
15. Create Results Database.
a. Browse to the CM4D install folder and go to the DbMigrator folder.
b. Edit the ATS.CM4D.Conestoga.DbMigrator.exe.config file.
c. Set the following information:
i. fiscalStartMonth - Set the month of the start of your fiscal year. Enter a value of 1-12. The default setting is "1" (January).
ii. fiscalStartDay - Set the day of the month as the start of your fiscal year. Enter a value of 1-31. The default setting is "1" (first day of the month). Must be a valid day for the set month.
d. Run ATS.CM4D.Conestoga.DbMigrator.exe.
e. When prompted, hit Y to continue.
f. Wait for the process to complete.
g. When it is finished running, the Command Prompt will read ''Successful migration. Press any key to exit application".
16. Test Results DataSource Connection.
a. Go back to Site Manager.
b. Go to the Results Datasource tab.
i. Click Test Connection.
ii. Click OK to acknowledge the success message.
c. Click Save. Leave Site Manager running.
17. 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 the topic CM4D Services 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.
18. Synchronize CM4D Databases with the Results Database. This is a REQUIRED step. Until the synchronization export is complete, you will not be able to access the database. See here for a more detailed description of the outlined steps listed below.
a. Go back to Site Manager.
b. Go to the Managed DataSources tab.
i. Select a database.
ii. Click Export to Results Database.
(1) Click OK to acknowledge the caution message: "This will export the entire database! This may be a very long operation, and will render the datasource unusable until export is complete. Continue?".
(2) Look at the Export Job Count field, located under the Export to Results Database button. As long as the Results services are running, this Count will begin to decrease as the export jobs are processed. Until this count is zero the synchronization is not complete.
iii. Once the Export Job Count is zero, export all remaining CM4D Databases to the Results database.
Tip
You
can close Site Manager it and reopen it while the export is still running;
the synchronization will not be effected.
19. Create Results Rules.
a. Run CM4D Classic.
b. Create a new document and connect to your Site database. You may load a Routine into the query if you want to be able to see your data, but this is not required to be saved in the document.
c. Create a new DataSet.
d. Open the DataSet Properties.
i. Enter a DataSet Label. This label is the name of the Results Rule; must not include any special characters (*, ?, &, #) that are reserved by SQL Server.
Tip
It
is recommended to make the label somewhat descriptive of the type of results
the rule is configured to generate. For example, "Normal", "XYZ"
or "Toleranced". This will make it easier to recognize which
rule(s) to assign to Samples in DataUtility.
ii. Click Sift Rules.
(1) Select the Feature Types and Characteristics that you want to use for this rule. Only feature and characteristic types selected here will be used to generate results for your data.
(2) Click OK.
iii. Go to the Data Source tab.
(1) Leave the Query set to Active.
(2) Select All Features.
(3) Select All Samples.
iv. Click OK.
e. Optionally, Create a new DataSet for each Results Rule definition. A sample can have multiple Results Rules assigned at once. Assigning rules is the next step in the upgrade.
f. Save the document as "CM4D Result Rules Interface.4dc".
20. Assign Results Rules to Samples.
a. Search for Routines.
b. Right-click a Routine and select Keep Selected Row(s). This will narrow your search to a single Routine.
c. Go to the Sample Search tab and click Search.
d. Add the Column "Results Rules" to the grid.
e. Next, select a series of Samples.
f. Right-click in the Results Rules field and select Edit Results Rules.
g. From the Results Rules dialog, enable the check box for at least one of the available rules (there may only be one).
h. Click OK and Commit Changes.
i. Repeat this step for all Samples for all Routines have at least one Results Rule assigned.
21. Start Other CM4D 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 the topic CM4D Services 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 (if not already running)
ii. Results Launcher (if not already running)
iii. Results Loader (if not already running)
iv. Scheduler Service
v. Scheduler Launcher
vi. DataSmith Batch
c. For Server installations that also use EventSmith, start the following:
i. DataConnect
ii. EventSmith SMTP
This completes your v23 to v24 Server upgrade.
Optional next steps may include:
· Export any remaining CM4D databases that have not yet been synchronized with the Results database.
· Create additional Results Rules in the CM4D Results Rules Interface document by adding new DataSets for each additional Results Rule; save the document.
· Assign a Results Rule to any remaining Samples not set in step 12.
· Assign additional Results Rules to Samples.