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.
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. 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.
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 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.
CM4D Configuration Overview
CM4D Configuration Home
Install CM4D Plugin
CM4D Peruse
The CM4D Peruse installation includes the Peruse web application and its supporting Windows services, plus the HOOPS Communication server.
Peruse is installed as a self-contained application. The Peruse installer includes:
- Configuration of Peruse with SSL Certificates
- Configuration of Security Manager Endpoint URL and CM4D API Endpoint
- Licensing Server location for obtaining application license information
- Configuration of HOOPS server with path to certificate files
- Test Database Connection (with TLS 1.0 and TLS 1.1 disabled)
CM4D Peruse requires:
- CM4D Site Database (with one or more CM4D Managed Datasources)
- CM4D Results Database
- ATS Security and Configuration Manager
- ATS Licensing (plugin)
- 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.
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.
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.
See also:
CM4D Upload Portal
CM4D Upload Portal is the web application which allows users in your group or external suppliers to submit data files for processing into a CM4D database. It uses two services, Upload Portal and CM4D API, to run the application and communicate with the CM4D Configuration and DataSmith services. The CM4D API is installed with the CM4D Configuration plugin.
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.
Upload Portal must be installed on the same machine as ATS Security and Configuration Manager.
Install CM4D Upload Portal
Install DataSmith Batch Proxy
Install DataSmith Translator
CM4D Upload Portal Deployments