There are a number of installations related to CM4D, both desktop and web applications. Depending on your organization, you may need to complete one or more of the following installations:
- CM4D Server/Client - The core of the CM4D product, these desktop applications are installed on an application server or on a local system connected to a central database on a larger network. Uses a collection of centralized SQL databases, including a Site, one or more CM4D Managed Datasources and an optional Results database (required for CM4D Peruse).
- CM4D Peruse - The 3D reporting and analysis web application for CM4D, connected to the CM4D Results database (populated by CM4D Server applications).
- CM4D Upload Portal - A simple web application that allows users or suppliers to remotely submit data files to be processed into the CM4D database. Utilizes the CM4D Server DataSmith Batch service to process data.
- CM4D API Service - 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.
Additionally, the CM4D Peruse and CM4D Upload Portal web applications rely on the following ATS software:
- Security and Configuration Manager - The web application which contains various ATS plugins designed to configure and manage a number of ATS products (such as ATS Security and ATS Licensing). You must have ATS Security and Configuration Manager installed and configured prior to installing the CM4D Configuration plugin, CM4D Peruse or CM4D Upload Portal applications and services.
- ATS Licensing Plugin - A plugin for ATS Security and Configuration Manager which administrates the licenses for ATS software applications, including ATS CM4D (both desktop and web applications). Application servers and other CM4D systems can then connect to the Licensing Server, either locally or over a Network.
- ATS CM4D Configuration Plugin - A plugin for ATS Security and Configuration Manager which administrates the configuration and settings for the web applications CM4D Peruse and CM4D Upload Portal. This plugin is installed by uploading the plugin package (ATS.CM4DPlugin.zip) in ATS Security and Configuration Manager.
Components managed by the CM4D Configuration plugin have requirements that must be met when determining where a specific application and/or service should be installed.
ATS Security and Configuration Manager
ATS Security and Configuration Manager is the web application which contains various ATS plugins designed to configure and manage a number of ATS products (such as ATS Security and ATS Licensing). You must have ATS Security and Configuration Manager installed and configured prior to installing the CM4D Configuration plugin, CM4D Peruse or CM4D Upload Portal applications and services.
Reference Guide - Install ATS Security Manager (for CM4D)
CM4D API
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. The CM4D API service is installed with the CM4D Configuration installer.
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.
- 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
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.
Install CM4D API Service
CM4D Configuration Plugin
CM4D Configuration is a plugin for ATS Security and Configuration Manager which administrates the configuration and settings for several CM4D applications and/or services, including databases, Peruse/Upload Portal configuration, DataSmith Batch jobs and EventSmith subscriptions. This plugin is installed by uploading the plugin package (ATS.CM4DPlugin.zip) in ATS Security and Configuration Manager.
CM4D Configuration Plugin Overview
Install CM4D Plugin
CM4D EventSmith V2
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 and requires valid SMTP settings.
- ATS CM4D EventSmith Processor - Processes the events generated by CM4D Scheduler.
Install EventSmith (V2)
EventSmith Services
CM4D Peruse
CM4D Peruse is the web application for CM4D that allows quality engineers to view and analyse data in an interactive 3D viewer. The 3D viewer is augmented with various reporting controls, such as grids and charts and provides statistical analysis for basic shop floor SPC. The database is populated with Results generated by the ATS CM4D Server applications.
The CM4D Peruse server requires the following applications/services:
- Peruse Application with Peruse Services - The CM4D Peruse service must be able to access the CM4D API service.
- HOOPS Communication Server - Installed with CM4D Peruse, HOOPS Communicator is the third-party software facilitating the streaming of 3D model data from CM4D to the HOOPS Web Viewer integrated in CM4D Peruse for client-side rendering.
See the topic HOOPS Communicator Server for more details.
The following additional applications/services are required (on the same computer or other network server) for support or configuration of the CM4D Peruse server installation:
- ATS Security and Configuration Manager – Based on OAuth2; requires the necessary access control. Local user credentials are supported but Security Manager can also use external login providers like Azure Active Directory Services. Logins can also be secured via captcha. Minimum version required: ATS Security 1.10+.
- ATS Licensing Plugin (v4.0+)
- CM4D Configuration Plugin
- CM4D API Service - The Peruse installer is dependent on a specific version of the CM4D API. Therefore during the installation when you enter the location of the CM4D API, it checks the version of the API to confirm it is compatible. The CM4D API service is installed using the CM4D Configuration installer.
- CM4D Site and Results Databases - Peruse relies on a connection to the CM4D Site and Results databases.
- Results Services – Peruse requires these services to populate the Results database with data from the CM4D databases.
D
See also:
CM4D Peruse Installer
HOOPS Communicator Server
SSL Certificates
Install CM4D Peruse
CM4D Server or Client
The CM4D Server installation includes the core CM4D desktop applications, automation services, scheduled reporting services, alarm notification services and user management. This type of installation is installed on a network Application Server and licensed with a Named Network License. The server installation may also used in conjunction with additional CM4D Clients, CM4D Peruse and/or CM4D Upload Portal.
Install CM4D Server
The CM4D Client installation includes the core CM4D desktop applications without any of the services. This type of installation is typically installed on a non-server machine and licensed as either a Concurrent or Named License.
Install CM4D Clients
CM4D Upload Portal
CM4D Upload Portal is the web application which allows users in your group or external suppliers to submit raw data files for processing into a CM4D database. It uses multiple services to run the application and communicate with the CM4D Configuration and DataSmith services.
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 Agent service.
- CM4D Upload Portal - Can be installed on any machine that has access to ATS Security and Configuration Manager.
- DataSmith Batch Proxy Agent - 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.
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.
- Microsoft .NET Core Hosting Bundle Runtime 3.1.10
- Microsoft Visual C++ 2017 Redistributable (x64) - 14.16.27012
Upload Portal must be installed on the same machine as ATS Security and Configuration Manager.
Install CM4D Upload Portal
Install DataSmith Batch Proxy Agent
Install DataSmith Translator
CM4D Upload Portal Deployments