Install CM4D API Service

CM4D API is a Windows service which connects to the CM4D Configuration plugin and supports the web applications CM4D Peruse and Upload Portal and their associated Windows services. If you are using either CM4D Peruse or CM4D Upload Portal, you must install the CM4D API service.

This service requires the CM4D Plugin for ATS Configuration Manager. If you have not already uploaded the plugin, see here for details. The plugin may be installed before or after the CM4D API service is installed.

Before Installation

Prepare ATS Security and Configuration Manager.
		Install the ATS Security and Configuration Manager.
		Log in to ATS Security and Configuration Manager as a user with Administrator privileges.
		Install ATS Licensing Server plugin (only needed if not already running v4.0+).
Download ATS CM4D installers.
		ATS CM4D Configuration
Download and Install Prerequisites. This is only required if you plan to run the installer on a machine that does not have an internet connection. With an internet connection, any prerequisites are downloaded automatically when needed during installation.
		SQL Server ODBC Driver 17.6 x64 - 17.6.1.1 or higher
		Microsoft Visual C++ 2015-2019 Redistributable (x64) - 14.26.287 or higher
		Microsoft Visual C++ 2015-2019 Redistributable (x86) - 14.26.287 or higher

Run the Installer

1. Run the CM4D Configuration install executable (as Administrator).
2. Prerequisites - If required, follow the prompts to install the required redistributables.
   
3. Click Next.
4. Agree to the terms and conditions and click Next.

Features and Installation Folder

5. The default options provided installs the CM4D API Service to C:\Program Files\Applied Tech Systems\ATS CM4D Configuration\. Most installations will use the defaults provided, but you can modify the install folder if needed.
   1. Features: ATS CM4D API Services - Installs the CM4D API service. This machine must be able to connect to ATS Security and Configuration Manager.
      
   2. Installation Folder: To change the installation folder, go to the Installation Folder tab and either enter a folder path or browse to a folder.
      
6. Click Next.

Configuration Database

7. Enter the connection information for the CM4D Configuration database. New databases are created entirely by the installer, including the database object, tables and procedures. If you have an existing database from a previous version, you can select that database from the menu.
   
   1. Server - Enter the database server name, or leave the default (local) if installing on the local machine. The default (local) is automatically resolved to the computer name in the installed configuration files.
   2. Trusted Connection - Enter the user credentials to access the database management system. This user must have a sufficient privilege level to create and modify databases.
      1. To use the current Windows user account, leave the Trusted Connection box checked.
      2. To use a SQL login, uncheck the Trusted Connection box and enter the SQL user and password.
   3. Database - Set the database for the CM4D Configuration.
      1. To allow a new database to be created by the installer, enter a unique name.
      2. To choose an existing database, click the ellipses button and select a database from the dropdown menu. Note that this is not the same as the ATS Security Configuration Manager database.
   4. Test SQL Connection - Click to confirm that the selected user can connect to the database server.
      1. If the connection is successful, continue.
      2. If the connect fails, correct the user login and retest.
         
8. Click Next.

CM4D API Database Access

9. Enter the user credentials that will be used by the CM4D API service to access the CM4D Config database. This user must have a sufficient privilege level to create and modify databases.
   
   1. Username - Enter a username for the SQL login account.
   2. Password - Enter a password for the SQL login account.
10. Click Next.

CM4D API Endpoint

11. Provide the endpoint details for the CM4D API service.
    
    1. SSL Certificate - Select a trusted certificate. The Certificates' Common Name must match the Server Name.
    2. Server Name - Enter the Server Name of the machine hosting the CM4D API service.
    3. Port (CM4D API) - The default port for the CM4D API is 5200. To change the port, enter a new port number.
12. Click Next.

Security Manager Connection

13. Provide the Security Manager endpoint and Application ID for the CM4D Configuration plugin.
    
    1. Security Manager Endpoint - Enter the endpoint URL for the ATS Security Manager, including the port (https://servername:5000/).
    2. CM4D Configuration Application ID - The Application ID must be generated by adding as a new Application in the ATS Security and Configuration Manager. Hide InstructionsShow instructions

       Go to ATS Security Manager and log in with a user that has Admin access.

       1. On the Security card, click Open.
          
       2. On the Applications card, click Add Application.
       3. Enter the information about the new application.
          1. Name - Enter a name for the application, such as 'CM4D Config' or 'CM4D API'.
          2. Description (optional) - Enter a description for the application that can be seen in the Applications grid card.
          3. Access Rights URL - Enter the address endpoint for the CM4D API, including the server name and port (https://servername:5200/) entered in the previous install window.
             
       4. Click Save. If the application was added successfully, the new row of the Applications grid should have the Status 'Created'.
       5. Click on the grid row of the new application to open the Application properties.
       6. In the Access ID field, copy the string.
       7. Go back to the installation window.
       8. Paste the Application ID from the Application properties in the Application ID field of the installer window.
    3. Test Security Manager Endpoint - Click to confirm you can connect to the endpoint. If the server name or port are incorrect, the test will show the connection failed.
14. Click Next.

ATS Licensing Server

15. Enter the Licensing Server URL.
    
16. Click Next.

Finish Installation

17. Click Install.
18. Click Finish.

Post-Installation

Once the install is finished, go to ATS Configuration Manager. If you have not already done so, upload the CM4D Configuration Plugin and add the CM4D API URL as the Web API property of the Plugin. Add the Roles from the new Application to users requiring access to the CM4D Configuration plugin.

Install CM4D Plugin

CM4D User Roles

Can we improve this topic?