Reference Guide - Install CM4D Server v25.1
Click here to see this page in full context
  1. Home >>
  2. CM4D >>
  3. Installation and Configuration >>
  4. Quick Reference Guides >>
  5. Reference Guide - Install CM4D Server

Reference Guide - Install CM4D Server v25.1

Topic ContentsTopic Contents
  1. Prepare for Installation
  2.  Configure Server (Pre-Installation)
  3. Install CM4D Server
  4. Configure Server (Post-Installation)

This guide contains the basic steps for installing and configuring a CM4D Server from start to finish. This topic is intended for Application Servers that will host the CM4D Services and are part of a larger setup that includes client systems which will connect to a centralized database. These steps may also be followed if you are installing a standalone Client system, in which case skip the parts that reference CM4D Scheduler, DataSmith Batch and EventSmith.

This installation will involve 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 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)

  1. CM4D Service User. Create a CM4D Service User (e.g., cm4dservice) that is a Windows user Administrator to run the CM4d Services.
  2. SQL Authentication User. Create a SQL Authentication User in SSMS  to access the databases.
  3. Start Print Spooler. Check Windows Services to ensure the Print Spooler service is running. If the service is not running, start the service before executing the CM4D installer.
  4. License CM4D. Run ATS Licensing Server and import the license files that corresponds to the version you are installing.
  5. Configure Certificates (Optional). Using certificates is only required if your SQL Server instance uses a certificate. If SQL Server does not use a certificate, this section can be skipped. If CM4D is running on a different machine than SQL Server, the SQL Server certificate must also be placed into Trusted Root Certificates on the CM4D Server.

All SQL Server Names across CM4D must use fully qualified domain names (e.g. ATSVMCM4Dxxx.ats-global.local) and must match the "CN=" value of certificate.

Install CM4D Server

  1. Run the CM4D Server installer executable (as Administrator).
  2. Install the Prerequisites (restart the machine if prompted; on restart, installer will resume automatically).
  3. Set the Installation folder.
  4. Select the Installation Type 'Configure and Install'.
  5. 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.
  6. Enter the name of the ATS Licensing Server.
  7. Finish the installation and restart the computer.

Configure Server (Post-Installation)

If you plan on using the Database Utilities to create/update the CM4D databases, consider configuring DB Connect and Site Manager before running the database tools to provide the required connection information to the utilities. For other connection options, refer to the topic Database Utilities.

  1. Create/Upgrade CM4D Databases. The CM4D install folder includes two folders for creating and updating the CM4D databases: (1) Database Utilities - Run as a Command Prompt; each tool applies all required scripts automatically. Choose one of these methods when creating the CM4D Site, CM4D Datasources and Results Database or (2) Database Scripts - Run manually in SSMS, individually and in the correct order.
    1. Create a new CM4D Site Database (or upgrade from a previous version/schema).
    2. Create a one or more CM4D Databases, as needed (or upgrade from a previous version/schema).
  2. CM4D Database Connection. Configure the Site Connection in DbConnect. Once you have successfully connected to the Site database, copy the CM4D.4ds file from your server to each Client system.
    1. Run DbConnect (as Administrator).
    2. Set the Connection Type as Site Connection.
    3. Select either Windows Authentication or SQL Authentication.
    4. Server Name - Enter the name of the database server. If using a Named Instance, include this in the server name.
    5. Enter the Database Name of the CM4D Site database.
    6. Apply the changes and Test Connection.
  3. Site Manager Configuration. Configure the CM4D Datasources and user access/privileges in Site Manager. The first time you log in, use cm4dsingle as the login credentials (username and password).
    1. Sites - Create a New Site and enter in the information you want to enter about this Site database.
    2. Managed DataSources - Create a new Data Source.
    3. Users - Create the CM4D users, including the CM4D Service user entered during the installation. Change the password for the cm4dsingle user to something other than the default password.
    4. Groups - Create Groups, assign users, database access and privileges.
    5. Results DataSource - Enable the database and enter the required connection information. 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. Click Test Connection. If the connection fails in a new installation (before Results db is created), this is OK.
    6. Open the menu Settings > EventSmith SMTP Settings. Configure the Host/Port, From Address and the optional SSL settings.
    7. Save the changes.
  4. Create the Results Database. If you created the Results database object before running the Results Database Utility, the SQL feature Full-Text and Semantic Extractions for Search must be set manually in SQL server.
    1. Go to the CM4D install folder and run .\Database Utilities\Results DatabaseUtility\ATS.CM4D.ResultsDatabaseUtility.Migrator.exe.
    2. When prompted, hit Y to continue.
    3. Wait for the process to complete.
    4. When it is finished running, the Command Prompt will read ''Successful migration. Press any key to exit application".
  5. Open the Firewall Ports used by CM4D.
    1. TCP 36057 for Scheduler services and Scheduler Manager.
    2. TCP 8001 for ATS Licensing Server.
    3. TCP 80 for CM4D Web.
    4. TCP 1433 for CM4D database access (SQL Server).
  6. Set SQL User Mapping. Modify the SQL Authentication User (created in SSMS during the Pre-installation steps):
    1. Select User Mapping for the 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'.
  7. Configure DataSmith Batch. Create a Batch settings file (this file must exist before the DataSmith Batch service can start):
    1. Run DataSmithBatchManager.exe (as Administrator).
    2. Set the File Path and click Make Default.
    3. Create a new job and Save.
  8. Configure EventSmith SMTP. 
    1. Edit the file ATS.CM4D.DataConnect.Host.exe.config and set the DataConnect service host information: <add baseAddress="net.tcp://server98:8523/CM4DDB_Service"/>
    2. Edit the file ATS.CM4D.EventSmith.SMTP.exe.config and set the EventSmith service host information: <endpoint address="net.tcp://server98:8523/CM4DDB_Service"
  9. Configure a Print Driver. Install and/or Configure one of the two available printer options.
    1. ATS CM4D Printer.
      1. Edit the Cm4d.ini file in the CM4D install folder (.\Applied Tech Systems\CM4D).
      2. Set the parameter PDFPRINTDRIVER="ATS CM4D Printer".
    2. eDoc PDF Printer.  This option requires a third-party installer and license, which may be obtained through ATS.
      1. Install eDoc PDF Printer.
      2. Configure eDoc Printer.
        1. Run the eDoc PropAdm Tool.
        2. From the Show Property Pages, select the Destination tab.
        3. Set Mode to Prompt Saveas Dialog.
        4. Set When File Exists to Replace Directly.
        5. Uncheck Display SaveAs dialog after print job spooled.
        6. Uncheck Enable Doing Post Action or Launching Viewer after PDF Generation.
        7. Select Process PDF asynchronously.
        8. Change the HKEY_LOCAL_MACHINE dropdown to "Destination".
        9. Click the Set FlagProhibitHKCU button.
      3. Edit the Cm4d.ini file in the CM4D install folder (.\Applied Tech Systems\CM4D).
        1. Set the parameter PDFPRINTDRIVER="eDocPrinter".
  10. Start the CM4D Services.
    1. If you entered the service user credentials during the installation, start all the CM4D Services.

      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.

    2. 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.
      1. Open the Properties of one of the CM4D services and set the Log on to the CM4D service user account.
      2. Set the login and start any remaining CM4D Services.

Continue from here by setting up Scheduler jobs, Batch jobs, Results Rules and creating CM4D templates.

Additional setup tasks may include:

Install CM4D Clients

Install CM4D Results Services

Install CM4D Web

For information about installing the web applications CM4D Peruse or CM4D Upload Portal, see the CM4D Configuration Manager help documentation on ATS-HELP.com.

Can we improve this topic?