For the CM4D installation to be successful:
See also, General CM4D System Troubleshooting.
The CM4D Client Installation includes the core CM4D products without the automation services. This type of installation is typically installed on a non-server machine and licensed as either a Concurrent or Named License. The Client installer is used for either a standalone workstation or a server client system that will connect to a database or automation server on the network. It includes the core CM4D products - Classic (also Interactive and Workcell), DataSmith, DataUtility, DbConnect, and SiteManager.
Windows Prerequisite Installer RedistributablesWindows Prerequisite Installer Redistributables
Downloading and installing these prerequisites 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 not present or require updates are downloaded automatically when needed during installation.
There are two different configurations in which the same Client install of ATS CM4D is used:
See the topic Install CM4D Clients for more information.
The CM4D API service is installed with the CM4D Configuration installer. The CM4D Configuration install process requires a user with administrative access to ATS Security and Configuration Manager.
Windows Prerequisite Installer RedistributablesWindows Prerequisite Installer Redistributables
Downloading and installing these prerequisites 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 not present or require updates are downloaded automatically when needed during installation.
During the installation you need to log in to ATS Security and Configuration Manager and add the Web API URL to the CM4D Plugin. Once the installation is complete, additional security roles are available.
See here for a brief guide to installing ATS Security and Configuration Manager for CM4D, or visit ATS-HELP for the full documentation.
See the topic Install CM4D API Service for more information.
EventSmith is the alarm notification system that processes any events generated by CM4D Scheduler. EventSmith uses two Windows services to process events from reports and send out event notifications from CM4D:
See the topic EventSmith Services for more information.
The Results services are the central mechanism that transfers data from CM4D into the Results database.
These services are installed using the ATS CM4D Results Services installer, which provides deployment flexibility to add service instances in larger organizations.
See the topic Results Transport for technical details on how these services can be distributed and monitored for optimal performance.
The Results services are typically installed on the same machine as CM4D Server, but the Results services are a separate installer from CM4D Server to allow one or more of the services to be distributed to additional servers. To support scalability for larger organizations the services can run on a single computer or multiple computers, and multiple instances of each service can be added and distributed throughout your network. The Results services can be deployed as Windows services (default install option) or as docker images.
Only ONE instance of each of the three Results Services is supported per server.
The Results Loader service can work without any connection to the Site database (e.g. in the cloud connected via a RabbitMQ queue). The connection is entered during the installation of the service.
See the topic Install CM4D Results Services for more information.
The CM4D Server Installation includes the core CM4D products, automation, scheduled reporting, alarm notification, web reporting, and database user privileges. This type of installation is installed on a network Server and licensed with a Named Server License. The Server installer is used for network application servers that host the services, applications, and/or databases that will be accessed from Client machines throughout the network. It includes the core CM4D products, Database Utilities and the services: DataSmith Batch, CM4D Scheduler and EventSmith. The Server installation is also used in conjunction with the CM4D Results Services and the CM4D web application installations (Peruse, Upload Portal), but these can be installed on a different server. The CM4D Server install is typically used by large networks running Automation services, with multiple Clients connecting to the server for database access, document storage, and ATS licensing.
Windows Prerequisite Installer RedistributablesWindows Prerequisite Installer Redistributables
Downloading and installing these prerequisites 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 not present or require updates are downloaded automatically when needed during installation.
CM4D Server Installations require a Named (Node Locked) Server license to run the CM4D Scheduler, CM4D Launcher and DataSmith Batch services. This license is requested automatically on the ATS Licensing Server when any of those services attempt to start for the first time.
See the topic Install CM4D Server for more information.
The CM4D Upload Portal requires the following:
Windows Prerequisite RedistributablesWindows Prerequisite Redistributables
Downloading and installing these prerequisites 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 not present or require updates are downloaded automatically when needed during installation.
See the topic Install CM4D Upload Portal for more information.
Some of the ATS CM4D services support Windows or Linux Docker deployments.
See the topic Docker Installations for more information.
CM4D v24 or higher can be installed/uninstalled without the installer user interface via command line, referred to as a 'silent' or 'quiet' installation.
See the topic Silent Installation for more information.
Can we improve this topic?