CM4D Configuration Plugin Overview
About CM4D Configuration
After the installation of the required application(s), log in to the Security Manager and open the CM4D Configuration Home card.
The CM4D module card may not appear on the ATS CM4D Configuration home page if your user login has not been granted the rights to administrate this module. If you know your login has been assigned a role with rights to CM4D, try logging off and then back in to refresh the application.
CM4D Configuration - Plugin + CM4D API
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 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 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.
The following topics are related to installing CM4D Configuration:
The following topics are related to configuring the CM4D plugin:
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 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.
The following topics are related to installing CM4D Peruse:
The following topics are related to configuring CM4D Peruse:
Peruse Annotation Templates Configuration
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.
A complete installation setup of CM4D Upload Portal includes three separate installers to allow for custom deployments of the services:
- CM4D Upload Portal - Includes the CM4D Configuration module, Upload Portal service and CM4D API service.
- DataSmith Batch Proxy Agent - A service that connects a DataSmith Batch service to the Upload Portal application.
- DataSmith Translator - A service that opens the DataSmith translator assigned to a Batch job and processes the data file.
The following topics are related to installing the CM4D Upload Portal:
Install DataSmith Batch Proxy Agent
The following topics are related to configuring CM4D Upload Portal in ATS Security and Configuration Manager.
Configuration - Service Endpoints
Reference Guides
Reference Guide - Install ATS Security Manager (for CM4D)
Reference Guide - Install CM4D Config Plugin and API
Reference Guide - Install CM4D Peruse
Reference Guide - Install CM4D Upload Portal
Download Guides
Can we improve this topic? Click Send Feedback in the upper right of the screen to share your comments!