CM4D Installations
Installer Requirements
For the CM4D installation to be successful:
- The system must meet or exceed the minimum System Requirements.
- The logged on user during installation MUST have local administrative rights on the PC.
- The Print Spooler service must be running.
- The computer must have normal system updates installed.
See also, General CM4D System Troubleshooting.
CM4D Client Installation
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.
There are two different configurations in which the same Client install of ATS CM4D is used:
- Server Client - A local CM4D installation that connects to a network Server for access to the CM4D Site database and ATS Licensing. This configuration is typically used for machines on the plant floor running CM4D Interactive or Workcell, connecting to the central server for its database and license. This could also be used for a CM4D Scheduler Client that is utilized by the server to automatically generate reports.
- Workstation - A self-contained instance of the Client install that has ATS CM4D, ATS Licensing, and the CM4D database all on the same machine. Generally, this is used by organizations that do not have the Site Automation package or does not use CM4D widely throughout a large network to need shared databases. This configuration typically used by CM4D Classic report template developers and DataSmith translator developers using Node-locked CM4D Classic Developer and DataSmith licenses.
See the topic Install CM4D Clients for more information.
Windows Redistributables
Depending on your configuration, the following redistributables packages may be required in order to use CM4D Server on the Windows operating system:
- .NET Framework 4.7.2
- Visual C++ Redistributable for Visual Studio 2012 Update 4 x64 - 11.0.61030 or higher
- Microsoft Visual C++ 2015-2019 Redistributable (x64) - 14.25 or higher
CM4D Configuration (CM4D API) Installation
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. 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 or visit ATS-HELP for the full documentation.
See the topic Install CM4D API Service for more information.
Windows Redistributables
Depending on your configuration, the following redistributables packages may be required in order to install the CM4D API service on a Windows operating system:
- 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
CM4D EventSmith Services Installation
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:
- ATS CM4D EventSmith Mailer - Processes the email notifications via the SMTP mail server for CM4D Scheduler Event jobs. This service is dependent on the EventSmith Processor.
- ATS CM4D EventSmith Processor - Processes the events generated by CM4D Scheduler.
See the topic EventSmith Services for more information.
CM4D Results Services Installation
The Results services are the central mechanism that transfers data from CM4D into the Results database.
- Results Sender - Processes the data events from CM4D, extracts the data from the databases and sends the data to Results Loader. In the case of a modified CAD image, a message is sent to the StreamCacheSmith service. This service requires a connection to the CM4D Site database and the Transport/Persistence database(s).
- Results Loader - Updates the Results database with minimum database locks. This service requires a connection to the CM4D Results database and the Transport/Persistence database(s).
- StreamCacheSmith - Converts 3D CAD images into the HOOPS streaming format used over the web by CM4D Peruse. The stream cache images are stored in the CM4D Site database and streamed to clients as-needed for rendering on the client-side HOOPS Viewer. This service requires a connection to the CM4D Results database and the Transport/Persistence database(s) and must be installed on the same machine as the HOOPS Communicator Server. Images transferred to the Results database cannot contain User Variables in the Image Path.
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.
CM4D Server Installation
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, Web), 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.
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.
Windows Redistributables
Depending on your configuration, the following redistributables packages may be required in order to use CM4D Server on the Windows operating system:
- .NET Framework 4.7.2
- Visual C++ Redistributable for Visual Studio 2012 Update 4 x64 - 11.0.61030 or higher
- Microsoft Visual C++ 2015-2019 Redistributable (x64) - 14.25 or higher
CM4D Upload Portal Installations
The CM4D Upload Portal requires the following:
- CM4D API - Can be installed on any machine that has access to ATS Security and Configuration Manager and has access to the CM4D databases.
- CM4D Configuration Plugin - Must be installed on the same machine as the ATS Security and Configuration Manager.
- CM4D Server - Can be installed on the same machine or a different server, provided this machine includes an installation of the DataSmith Batch Proxy service.
- CM4D Upload Portal - Can be installed on any machine that has access to ATS Security and Configuration Manager.
- DataSmith Batch Proxy - Must be installed on each machine that has a DataSmith Batch service, which is part of the CM4D Server installation.
- DataSmith Translator - Can be installed on any machine that has access to ATS Security and Configuration Manager.
See the topic Install CM4D Upload Portal for more information.
Windows Redistributables
Depending on your configuration, the following redistributables packages may be required in order to install CM4D Upload Portal or its supporting services on a Windows operating system:
- Microsoft .NET Core Hosting Bundle Runtime 3.1.10
- Microsoft Visual C++ 2017 Redistributable (x64) - 14.16.27012
CM4D Web Installation
The CM4D Web installer includes CM4D Web only. All other ATS CM4D applications, including the Scheduler and EventSmith services required by CM4D Web, must be installed using the standard CM4D Server installer. This can be on the same server, or on a different server.
- Web Client - Web clients do not require any installation of either CM4D or CM4D Web, as CM4D Web can be accessed via any web browser by any user with network access and the required privileges. This is typically used by multiple users throughout the network, with little knowledge of how to use CM4D, but need on-demand access to reports without installing CM4D on every computer.
See the CM4D Web help documentation for more information.
Docker Installations
Some of the ATS CM4D services support Windows or Linux Docker deployments.
See the topic Docker Installations for more information.
Silent Installation
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?