Install CM4D Server

Topic Contents [Hide]Topic Contents [Show]
  1. Prepare for Installation
  2. Configure Server (Pre-Installation)
    1. CM4D Service User
    2. SQL Authentication User
    3. Start Print Spooler
    4. License CM4D
  3. Install CM4D Server
    1. Prerequisites
    2. CM4D Setup
    3. Select Installation Folder
    4. Installation Type
    5. Licensing Server Setup
    6. Ready to Install
  4. Post-Installation Configuration
    1. CM4D Database Connection
    2. Site Manager Configuration
    3. Create CM4D Databases
    4. Confirm Database Connections
    5. Firewall Settings
    6. Set SQL User Mapping
    7. Configure DataSmith Batch
    8. Configure EventSmith SMTP
    9. Configure a Print Driver
    10. Start Services

This guide contains the detailed steps to installing and configuring a CM4D Server from start to finish. These steps may also be followed if you are installing a standalone Client system, in which case skip the parts that reference the CM4D Services.

For the CM4D Client Installation guide, see the topic Install CM4D Clients.

This installation includes the following steps:

  1. Server Setup - Users for Services and Database connections, SSL Certificates, ATS software (Security & Configuration, Licensing).
  2. CM4D Server Installation - Run the CM4D Server installer.
  3. CM4D Configuration - Database creation/connection, User permissions, DataSmith Batch setup, EventSmith setup, configure print driver, start CM4D services.
  4. Server Configuration - Firewall ports, SQL user access, ServiceControl Manager install/configuration.

Prepare for Installation

Gathering the following downloads and information is helpful before running the installer.

Contact your ATS sales representative or ATS Support if you have questions or need assistance.

Access ATS Security and Configuration Manager.

 

Download and/or install the ATS Security and Configuration Manager.

 

Download and/or install ATS Licensing Server plugin (only needed if you are not already running Licensing v4.0+).

 

Log in to ATS Security and Configuration Manager as a user with Administrator access to Security and Licensing plugins.

Download installers/files referenced in this guide.

 

ATS CM4D Server installer.

  CM4D Licenses for the version you will be installing, if needed.

Download and Install Prerequisites. This is only required if you plan to run the installer on a machine without an internet connection. With an internet connection, any prerequisites not present or require updates are downloaded automatically when needed during installation.

  Visual C++ Redistributable for Visual Studio 2012 Update 4 x64 - 11.0.61030
  Microsoft Visual C++ 2015-2019 Redistributable (x64) - 14.25.28508 or higher
  SQL Server OLE DB Driver 18 x64 - 18.2.2.0 or higher
  .NET Framework 4.7.2

Optional information that is useful to have on hand during the installation and setup process.

  CM4D Service User - user name and password; can be new or existing Windows user
  SQL Server User (if using SQL Authentication) - user name and password; can be new or existing SQL login
  ATS Licensing Server - machine name and port
  Database Server - machine name and port
  CM4D Scheduler Server - machine name and port
  CM4D Web Server - machine name and port
  CM4D Users - Windows and/or Domain user names and CM4D privilege levels

Configure Server (Pre-Installation)

See also, Application Server Configuration.

CM4D Service User

Create a CM4D Service User:

  1. Go to Computer Management > System Tools > Local Users and Groups > Users.
  2. Right-click in the Users window and select New User.
  3. In the New User dialog:
    1. Enter a User name (for example, cm4dervice).
    2. Enter the Full name (for example, CM4D Service).
    3. Enter a Description (optional).
    4. Enter a strong Password and Confirm Password.
    5. Uncheck 'User must change password at next logon'.
    6. Check User cannot change password.
    7. Check Password never expires.
    8. Click Create.
    9. Click Close.
  4. Right-click on the user you just created and select Properties.
  5. Select the Member Of tab.
  6. Click Add.
    1. Enter the object name for your administrators group (typically, Administrators) and click Check Names.
    2. If the correct account is found, click OK.
  7. Close Computer Management.

SQL Authentication User

Create a SQL Authentication User in SSMS (as needed; Windows Authentication can be used):

  1. Create a new Login (e.g., cm4duser).
  2. Select SQL Server authentication.
  3. Enter a secure Password.
  4. Confirm password.
  5. Clear the Enforce password expiration check box.
  6. For the Default database, select your new Site database (or CM4D database if you are not using a Site).

Start Print Spooler

Check Windows Services to ensure Print Spooler is running. If the service is not running, start the service before installing CM4D.

License CM4D

Run ATS Licensing Server and import the license files that corresponds to the version you are installing.

Install CM4D Server

  1. Run the CM4D Server install executable (as Administrator).
  2. Click Next.

Prerequisites

The first part of the installation will check to see if the machine has the required supporting software redistributables. If your machine already has the required versions of the files installed the installer will detect it and move on to the next steps without reinstalling the existing files.

  1. Click Next.
    1. Install .NET Framework:
      1. Agree to the terms and conditions, then click Install.
      2. Click Finish.
      3. When prompted to reboot, select an option.
        1. Restart Now - the machine will reboot; on restart, the CM4D installation will continue where it left off before the restart.
        2. Restart Later - the CM4D installation will continue; make sure to reboot the system once the CM4D installation is completed.
    2. Install Microsoft Visual C++ 2012 Redistributable:
      1. Agree to the terms and conditions, then click Install.
      2. Click Close.
    3. Install Microsoft Visual C++ 2015 Redistributable:
      1. Agree to the terms and conditions, then click Install.
      2. Click Close.

CM4D Setup

Once the prerequisites are installed, continue to the CM4D portion of the installation.

  1. Click Next.

Select Installation Folder

  1. The default installation folder is C:\Program Files\Applied Tech Systems\CM4D\.
    1. To change the install folder, click Browse.
    2. Select the new folder and click Select Folder.
  2. Click Next.

Installation Type

To complete the CM4D installation, choose an Installation Type. See the sections below for instructions on each install type.

Option A: Quick Install

This option is a fast option for installing CM4D without any setup or configuration.

See here for information on the settings that must be done manually after the installation is completed using this method.

  1. Select Quick Install.
  2. Click Next.

Following the installation, manually configure CM4D services user login settings.

See the topic Quick Install - Manual Configuration for information on the settings that must be done manually after the installation is completed using this method.

Option B: Configure and Install

This option allows you to enter information used to configure CM4D during the installation so you do not have to manually set up or configure the information in multiple places. Follow the steps and enter information when prompted.

You may leave any of the fields blank, but remember any missing information must be entered manually afterwards. See here for more information.

  1. Select Configure and Install and click Next.
    1. Fill in the information for the user that you want to run your CM4D services. If you leave this blank, the default local user will be set and you will need to manually set the logon user for each service individually post-installation.
      1. Use Default User - Local System Account, no user input required.
      2. Local User - Windows User Account; requires username and password.
      3. Domain User - Domain User Account, requires domain name, username and password.
    2. Enter the user credentials.
      1. Domain - Enter the Domain name (if using a Domain User).
      2. CM4D services user - Enter the name of the user.
      3. CM4D services user pass - Enter the password for the user.
    3. Click Check User. This will confirm that the user information entered is valid for this machine. If the user name or password entered is not valid, you can still continue to the next step. However, the services will install with the Default User set as the logon user.

The Check User button functions as a Windows login attempt. Too many check attempts with an Invalid User or Password may lock the user account.

  1. Click Next.

Licensing Server Setup

  1. Enter the name of the server running the ATS Security Manager (with Licensing plugin). You can either leave the default "localhost" if you have Licensing Server running on the same machine, or configure this in the ATSLicensingServer.Client.dll.config file in the CM4D install folder once the installation is completed.
  2. Click Next.

Ready to Install

  1. Click Install.
  2. Once the installer completes, click Finish.

Post-Installation Configuration

Once the CM4D installer is done and the server has been rebooted, the following tasks may be completed to finish setting up CM4D on the application server.

If you chose the Quick Install method during installation, refer to the topic Quick Install - Manual Configuration before continuing this configuration.

CM4D Database Connection

Enter the connection information for the CM4D Site Database.

  1. Run DbConnect (as Administrator).
    1. Connection Type - Change the dropdown to "Site Connection".
    2. 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'.
        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.
    3. Server Name - Enter the name of the database server. If using a Named Instance, include this in the server name.
    4. Database Name - Enter the name of the CM4D Site database.
  2. Click Apply.
  3. Click Test Connection.
    1. If successful, click OK and continue to the next step.
    2. If the connection fails on an existing database, check your settings and then test again.
    3. If the connection fails in a new installation (before the db is created with Database Utilities), this is acceptable; continue to the next step.
  4. Click OK to exit DbConnect.

Once you have configured Site database connection, copy the CM4D.4ds file from your server to each Client system.

Site Manager Configuration

Set User Database Access and Privileges:

  1. Run SiteManager. The first time you log in, use the following credentials:
    1. Username: cm4dsingle
    2. Password: cm4dsingle
  2. On the Sites tab, create a New Site and enter in the information you want to enter about this Site database.
  3. Go to the Managed DataSources tab and create a new Data Source.
    1. Label - Enter a label; this does not have to match the actual database name.
    2. Site - If you are using multiple Sites, select one from the dropdown to assign this Managed DataSource to that Site.
    3. 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'.
    4. DataBase UserName - Enter the user name of the SQL user login.
    5. Password - Enter the password for the SQL user.
    6. Confirm Password - Re-enter the SQL user password.
    7. Server Name - Enter the name of the database server. If using a Named Instance, include this in the server name.
    8. Database Name - Enter the name of the CM4D database.
      1. Click Test DataSource Connection.
        1. If successful, click OK and continue to the next step.
        2. If the connection fails on an existing database, check your settings and then test again.
        3. If the connection fails in a new installation (before the db is created with Database Utilities), this is acceptable; continue to the next step.
    9. Click Save.
  4. Go to the Users tab.
    1. Create a new user.
      1. User Name - Enter the users' Windows ID as the user name (for example, cm4duser or jsmith).
      2. Full Name - Enter the user name as you want it displayed.
      3. Password - Enter a password. This is not the Windows password for the user; can be any password.
      4. Confirm Password - Enter the password again.
      5. E-Mail Address - Enter an email address for the users that will receive EventSmith notifications.
      6. Must Change Password - Only set this to Yes if you want a user to log into Site Manager to set their own password.
    2. Create any additional users.
    3. Change the password for the cm4dsingle user to something other than the default password.
    4. Click Save.
  5. Go to the Groups tab and create a new Group.
    1. Group Name - Enter a name for the group, such as Admin, that is descriptive of the purpose or scope.
    2. Users - Assign users to the group; click on the Users row 'click to change user list ->' and then click the ellipses button.
      1. Available Users - Click to select one or more user names to add to the group.
      2. Selected Users - Highlight users in the Available Users window, then click the left pointing arrow to add the users to the Selected Users list.
      3. Click OK.
    3. Access Privileges - Select the check boxes for each Site and CM4D databases you want to grant access to the group.
    4. Data Privileges - Select the check boxes for the privileges you want to assign to the group. See here for descriptions of the user privileges.
  6. Go to the Results DataSource tab and enter the required information. No Results Db yet? No Results Db yet? The Results database object may not exist at this point if this is a brand new installation (Test Connection will FAIL - this is OK). The information still needs to be entered here and tested because it will be used by the Results Database Utility to create the database object when the tool is run.
    1. Server Name - Enter the name of the database server. If using a named instance include the instance name with the server.
    2. Database Name - Enter the name of the Results Database.
    3. 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'.
    4. 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 Results Database Utility to create/modify the Results database in SQL Server.
    5. Password - Enter the password for the SQL user.
    6. Confirm Password - Re-enter the SQL user password.
    7. Click Test Connection.
      1. If successful, click OK and continue to the next step.
      2. If the connection fails on an existing database, check your settings and then test again.
      3. If the connection fails in a new installation (before the db is created with Database Utilities), this is acceptable; continue to the next step.
    8. Click Save.
  7. Go to Settings > EventSmith SMTP Settings menu and configure the following:
    1. SMTP Host - The server address of the SMTP mail server.
    2. Port - The port number used to connect to the SMTP mail server. It must match the SMTP port used on your mail server.
    3. Enable SSL - Check this option only if the mail server requires SSL.
    4. Username - The username that will be used to log in to Authenticate on the mail server. For anonymous relay, leave this empty.
    5. Password - The password for the Authentication user name. For anonymous relay, leave this empty. The password is encrypted in the database.
    6. From Address - The email address from which the event notifications are sent. If this is left empty, EventSmith will attempt to obtain an address from the Site database based on the user running the service. If neither exist, the service will not start. If you are using Authentication, the from address should match the account used to log in to the SMTP server or it will likely fail to send any email.
    7. Click OK.
  8. Click Save & Exit.

Create CM4D Databases

CM4D requires a few SQL databases to be created and configured for the CM4D software to access. This can be done manually by running the database scripts individually in SSMS or using the CM4D Database Utilities provided in the CM4D install folder.

If the task you selected did not work, the authentication user may have insufficient database privileges. Check the authentication user credentials or try executing the Database Utility using 'Run as administrator'.

See the topic Database Utilities for details.

Site Database

Create new CM4D Site Database:

  1. Go to the CM4D install folder (.\CM4D\Database Utilities\Site Database Utility) and run ATS.CM4D.SiteDbMigrator.exe.
  2. Follow the prompts in the console window to create or update the Site database.
  3. Once the operation is complete, the command window closes automatically.
CM4D Database(s)

Create a new CM4D Database:

  1. Go to the CM4D install folder (.\CM4D\Database Utilities\Datasource Database Utility) and run ATS.CM4D.DatasourceUtility.Migrator.exe.
  2. Follow the prompts in the console window to create or update a CM4D database.
  3. Once the operation is complete, the command window closes automatically.
CM4D Results Database

If you are planning to use the Results Database, you must also install the CM4D Results Services with a separate installer. See the topic Install CM4D Results Services for instructions.

Run Results Database Utility:

  1. Go to the CM4D install folder (.\CM4D\Database Utilities\Results Database Utility) and run ATS.CM4D.ResultsDatabaseUtility.Migrator.exe.
  2. Follow the prompts in the console window to create or update the Results database.
  3. Once the operation is complete, the command window closes automatically.
  4. Wait for the process to complete.
  5. When it is finished running, the Command Prompt will read ''Successful migration. Press any key to exit application".

If you created the Results database object before running the Results Database Utility, there are some settings that must be set manually in SQL server. See here for more information.

Confirm Database Connections

If you configured DbConnect and SiteManager before the databases were created with the Database Utilities, go back to SiteManager and Test Connection for all CM4D Managed DataSources and the Results Database.

Firewall Settings

Configure Windows Firewall Rules:

  1. Open the following Firewall ports:
    1. TCP 36057 - Client PCs need access to the automation server running Scheduler services to be able to manage Scheduler jobs via Scheduler Manager.
    2. TCP 8001 - Client PCs need access to the ATS Licensing Server to retrieve CM4D licenses.
    3. TCP 80 - Web clients need access to the server hosting CM4D Web.
    4. TCP 1433 - Database servers must allow access to any clients connecting to CM4D databases.

Set SQL User Mapping

Modify the SQL Authentication User (created in SSMS during the Pre-installation steps):

  1. Select User Mapping.
    1. Check the boxes next to your CM4D Site database, CM4D database(s) and Results database.
    2. For each of the databases, set the Database role membership to 'public' and 'db_owner'.
  2. Click OK.

Configure DataSmith Batch

Create a Batch settings file (this file must exist before the DataSmith Batch service can start):

  1. Browse to the folder where CM4D is installed. By default, this is C:/Program Files/Applied Tech Systems/CM4D.
  2. Right click on DataSmithBatchManager.exe and select Run as administrator.
    1. In the top left of the interface, find the Batch Processor Settings section.
      1. Click the ellipses following the File Path.
      2. Browse to a network folder that is accessible to Batch Users.
      3. Select the folder and click OK.
    2. Click Make Default.
  3. Click New to create a job.
  4. Click Save & Exit.

Configure EventSmith SMTP

  1. Edit the file ATS.CM4D.DataConnect.Host.exe.config.
    1. Set the DataConnect service host information:
      1. <add baseAddress="net.tcp://server98:8523/CM4DDB_Service"/>
        1. Service Server - Enter the name of the server that is hosting the DataConnect service.
        2. Service Port - Enter the port number used by the DataConnect host server to connect to the EventSmith host server (it must be the same as the port set in the EventSmith config).
    2. Save the config file.
  2. Edit the file ATS.CM4D.EventSmith.SMTP.exe.config.
    1. Set the EventSmith service host information:
      1. <endpoint address="net.tcp://server98:8523/CM4DDB_Service" binding="netTcpBinding" bindingConfiguration="NetTcpBinding_ICM4DDB" contract="CM4DDB_ServiceRef.ICM4DDB" name="NetTcpBinding_ICM4DDB">
        1. Service Host - Enter the name of the server that is hosting the DataConnect service.
        2. Service Port - Enter the port number used by the EventSmith SMTP client server to connect to the DataConnect host server (it must be the same as the port set in the DataConnect config).
    2. Optional - Set the Queue options:
      1. QueueRefreshSeconds - The time in seconds when the EventSmith queue is checked for entries. The default value is 10; this must be a number between 10 and 86400
      2. QueueRetrievalSize - The number of EventSmith queue entries picked up each time the queue is refreshed. The default value is 2.
    3. Optional - Set the Console, Event or File logging levels:
      1. level - Enter a logging level (OFF, ERROR, INFO, DEBUG).
    4. Save the config file.

Configure a Print Driver

Install and/or Configure one of the two available printer options, either ATS CM4D Printer or eDoc PDF Printer.

Option A - ATS CM4D Printer

Configure CM4D Printer:

  1. Browse to the CM4D install folder (.\Applied Tech Systems\CM4D).
  2. Edit the Cm4d.ini file (requires READ/WRITE Administrator privileges).
  3. In the [default] section find the parameter "PDFPRINTDRIVER".
    1. Set the value to "ATS CM4D Printer".
    2. Comment out (#) the other print driver options or delete the unused lines entirely.
  4. Save and close the Cm4d.ini file.
Option B - eDoc PDF Printer

This option requires a third-party installer and license.

Install eDoc PDF Printer:

  1. Run the eDocPrinter PDF Pro installer (as Admin). See here for version requirements.

For eDoc installation instructions, refer to the Iteksoft website.

Configure eDoc Printer:

  1. Once the installation has completed successfully, run the eDoc PropAdm Tool.
    1. Open Start > eDocPrinter PDF Pro > PropAdm Tool
    2. Click Show Property Pages.
      1. Select the Destination tab.
      2. In the Save As section:
        1. For Mode, select Prompt Saveas Dialog.
        2. For When File Exists, select Replace Directly.
        3. Uncheck Display SaveAs dialog after print job spooled.
      3. In the Action section:
        1. Uncheck Enable Doing Post Action or Launching Viewer after PDF Generation.
        2. Select Process PDF asynchronously.
      4. Click OK.
      5. Change the HKEY_LOCAL_MACHINE dropdown to "Destination".
      6. Click the Set FlagProhibitHKCU button.
    3. Click OK to close the PropAdm dialog.
  2. Browse to the CM4D install folder (.\Applied Tech Systems\CM4D).
    1. Edit the Cm4d.ini file (requires READ/WRITE Administrator privileges).
      1. In the [default] section find the parameter "PDFPRINTDRIVER".
      2. Set the value to "eDocPrinter".
      3. Comment out (#) the other print driver options or delete the unused lines entirely.
    2. Save and close the Cm4d.ini file.

Start Services

Start the CM4D Services. If you entered the service user credentials during the installation, you can just skip right to starting all of the CM4D Services. If you are not sure, check the Scheduler *.settings files to confirm.

  1. Open Control Panel > Administrative Tools > Services.
  2. Start one of the CM4D services.
  3. For 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.
    1. Right-click on the 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.
    2. Click OK on informative message ‘The account … has been granted the Log On As A Service right.’
    3. Try to start the services again.

Start any remaining CM4D Services (in this order). You may choose to start these services at a later time if you have additional configuration to do for Scheduler or Batch Jobs.

If you are starting the Scheduler or Batch services for the first time, the services will request an Enterprise license from the ATS Licensing Server. You must open ATS Licensing Server Manager in ATS Security and Configuration Manager and approve the license request. Once it is approved, you can retry the Service start.

See also: 

Install CM4D Results Services

Install CM4D Clients

CM4D Web Installation and Configuration

Results Transport

Can we improve this topic?