CM4D System Requirements

Topic ContentsTopic Contents
    1. Notes on Server Memory
    2. CM4D Servers
      1. CM4D Database Server
      2. CM4D Application Server
      3. Web Server
      4. ATS License Server
      5. CM4D File Server
    3. CM4D Clients
      1. CM4D Workstation
      2. Web Client
    4. Firewall Port Reference
      1. Hardware Reference
      2. Software Reference

    Disclaimer: ATS will stop providing support to a customer for a Windows Operating System when Microsoft stops supporting the version.

    This document lists the hardware and software requirements and recommendations for the basic configurations of CM4D v25 or higher. These specifications outlined here are intended to be a generic guide to use as a starting point in the planning of your ATS CM4D implementation.

    Windows System Updates should be kept up to date to ensure the computer has any critical Root Certificate updates that might be required by digitally signed software.

    Notes on Server Memory

    The CM4D Automation Server package arrives pre-configured with a single DataSmith Batch process and two CM4D worker processes for CM4D Scheduler. In addition, the CM4D Web application requires its own dedicated CM4D worker processes. The number of CM4D Web worker processes should be based on the number of users who are simultaneously generating reports on demand.

    Utilizing current Virtualization technology, you could monitor peak memory demand over time to better tune available memory to prevent page swapping. Most Virtualization technology also makes used of shared or balloon memory, which allows the host to dynamically adjust available memory based on load demand.

    For information from Microsoft on Memory Limits for Windows Releases, visit: http://msdn.microsoft.com/en-us/library/windows/desktop/aa366778(v=vs.85).aspx

    CM4D Servers

    The following software and hardware requirements must be met for the Server that will be running a CM4D Server installation. Server types required to run CM4D include:

    Some CM4D configurations may combine one or more Server types on the same machine. In this case the specifications for all Server role requirements must be met by the server that is running everything.

    Typical use: Large networks with one or more servers hosting centralized databases and running the Site Automation services for multiple CM4D Clients.

    CM4D Database Server

    The Database Server hosts the Database Management System (i.e., SQL Server) for the CM4D databases. The DBMS can be local to the CM4D installation or on a centralized server within the network.

    All installations of ATS CM4D rely on an external database to store the quality data.

    Operating System
    CPU

    Specifications may change in proportion to the CM4D Server load. ATS recommends Virtualized Server environments whenever possible.

    RAM
    HDD

    Disk sizing requirements can vary based on amount of CM4D data and files stored on a system. Servers should allow for long term growth. Your actual sizing will be based on the volume of measurement data you plan to store and analyze with CM4D.

    SSDs are always recommended for the best performance.

    Database Management System
    1. SQL Server Instance Feature (required for the Results Database):
      1. Full-Text and Semantic Extractions for Search (see here for instructions)
    Firewall Settings

    CM4D Application Server

    The Application Server typically includes the CM4D Server desktop applications and automation services.

    Operating System
    CPU

    Specifications may change in proportion to the CM4D Server load. ATS recommends Virtualized Server environments whenever possible.

    The number of threads should correlate to the number of worker processes you intend to have running on a single machine. A large number of processes without sufficient threads can bottleneck your entire system.

    RAM
    HDD
    Network

     

    Firewall Settings
    Third Party Software
    Prerequisites

    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.

    Web Server

    The Web Server hosts the following web applications: CM4D Peruse, CM4D Upload Portal or CM4D Web. It may also host the administrative tool, ATS Security and Configuration Manager and its supporting plugins (such as ATS Licensing Server and CM4D Configuration).

    Operating System
    CPU

    CPU specifications may change in proportion to the CM4D Server load. ATS recommends Virtualized Server environments whenever possible.

    RAM
    HDD
    Network
    Windows Features

    CM4D Web only:

    Firewall Settings

    ATS License Server

    ATS CM4D v25 and higher requires ATS Licensing Server 4.0. or higher. This is a plugin application that must be installed on the same machine as ATS Security and Configuration Manager.

    Operating System
    CPU
    RAM
    HDD
    Database Management System

    An external DBMS is only required if you are not using the built-in Firebird database for license storage.

    Default Port(s)

    CM4D File Server

    The ATS CM4D applications require a shared location to store and access related files such as:

    These files are used or produced by CM4D Server, CM4DWeb, and any CM4D Clients. For example, if an End User running a CM4D Client does not have access to the file share storing the *.4DC files, they will not be able to view or edit the report templates.

    If that CM4D report template includes any part models, the user will also need to have at least read access to the folder where the image file is stored.

    Since CM4D is Windows based, this location is represented as a normal Microsoft Windows SMB File Share. For most CM4D Customers, the SMB share used for CM4D files usually resides directly on the CM4D Automation server or on another preexisting SMB file server (such as existing file shares used by used by Quality Department).

    Operating System
    CPU

    Specifications may change in proportion to the CM4D Server load. ATS recommends Virtualized Server environments whenever possible.

    RAM
    HDD

    Disk sizing requirements can vary based on amount of CM4D data and files stored on a system. Your actual sizing will be based on the volume of measurement data you plan to store and analyze with CM4D.

    SSDs are always recommended for the best performance.

    Network
    Firewall Settings

    CM4D Clients

    The following software and hardware requirements must be met for the machine that will be running a CM4D Client installation. There are two primary ways the Client version of CM4D might be implemented:

    CM4D Client - Installed on a machine that connects to a centralized database and utilizes components from an Application Server or other shared network resources used by CM4D.

    CM4D Workstation - This is a standalone instance of CM4D

    CM4D Workstation

    This section includes the requirements for CM4D Clients that will have the CM4D installation, ATS Licensing, and database on the same machine.

    Typical use: This configuration is usually the Node-locked CM4D Classic Developer and DataSmith licenses and is used by report template developers and DataSmith translator developers.

    Other use: CM4D Interactive or CM4D Workcell systems.

    Hardware
    Operating System
    CPU
    RAM
    HDD

    Disk sizing requirements can vary based on amount of CM4D data and files stored on a system. Your actual sizing will be based on the volume of measurement data you plan to store and analyze with CM4D.

    SSDs are always recommended for the best performance.

    Video GPU

    A discrete GPU is preferred.

    CM4D and DataSmith dialogs require a minimum screen resolution of 1280x1024. For wide screens, a minimum resolution of 1920x1080 is recommended.

    Database Management System

    CM4D Clients can support a local SQL installation. However, ATS recommends a centralized SQL Instance whenever possible. See here for Database Server requirements.

    1. SQL Server Instance Feature (required for the Results Database):
      1. Full-Text and Semantic Extractions for Search (see here for instructions)
    Licensing
    Prerequisites

     

    Web Client

    A Web Client refers to a user connecting remotely (via web browser or mobile device) to CM4D Peruse, CM4D Upload Portal or CM4D Web applications hosted on a Web Server. This configuration does not require any installed ATS software products.

    Typical use: Multiple users throughout the network, those with limited knowledge of CM4D, but need on-demand access to reports.

    Hardware
    Operating System
    Software
    Third Part Software

    Firewall Port Reference

    This port is used by the ATS Configuration Manager web application and corresponding Windows service. The web address used by clients to connect to the web application includes the port number.
    This port is used by CM4D to communicate between the ATS Licensing Server and clients. When the client PC runs a CM4D application, it sends a request to the application server (where the ATS Licensing Server is installed) to check if there is an available license in the database via ATS Licensing Manager on TCP port 8001. If any available license exists, the application server sends the information back to the client to run related application. If TCP 8001 is not open, clients will not be able to run any CM4D application in their local environment.
    This port is used by CM4D clients to communicate with the Licensing plugin in the ATS Configuration Manager.
    This port is used by the ATS Security Manager web application and corresponding Windows service.
    This port is used by the CM4D API service, which supports the web applications CM4D Peruse and Upload Portal and their associated Windows services.
    This port is used by web server to run the CM4D Peruse web application and corresponding Windows service. The web address used by clients to connect to the web application includes the port number.
    This port is used by the Peruse API service, which supports the Peruse web application and corresponding Windows service. This service runs behind the scenes on the host server and is not visible to connecting clients.
    This port is used by web server to run the CM4D Upload Portal web application and corresponding Windows service. The web address used by clients to connect to the web application includes the port number.
    This port is used by CM4D to reach the Scheduler Manager Services (which is running on the application server) from client PCs. Clients that have privileges for Scheduler Manager can control scheduled reports and alarms to print PDFs or trigger alarm conditions on report templates. In addition, there are two services on the application server (ATS CM4D Scheduler and ATS CM4D Launcher) that are running for scheduled report processing. If TCP 36057 is not open, a client will not able to reach the Scheduler Manager to configure or manage unless Scheduler Manager is located on the local server.
    This port is used by CM4D to open CM4DWeb on the client PC via the Internet browser (i.e. Internet Explorer). In CM4DWeb, clients are able to see all published and managed reports and print a PDFs to save to their local environment. A client can subscribe to any reports to get an alarm email according to related reports event configurations. If TCP 80 (http:80) is not open, clients will not able to open CM4DWeb to print PDFs or set alarm notifications (EventSmith).
    This port is used by the DataSmith Batch Proxy service, which supports the CM4D Upload Portal web application and corresponding Windows service. This service runs behind the scenes on the host server and is not visible to connecting clients.
    This port is used by the DataSmith Translator service, which supports the CM4D Upload Portal web application and corresponding Windows service. This service runs behind the scenes on the host server and is not visible to connecting clients.
    This is the default port for Windows for File Sharing. In computer networking, Server Message Block (SMB), one version of which was also known as Common Internet File System (CIFS), operates as an application-layer network protocol mainly used for providing shared access to files, printers, and serial ports and miscellaneous communications between nodes on a network. CM4D needs a shared folder on the network to store all CM4D managed report templates, translators, Inboxes, etc. Clients should be able to reach this shared folder to modify and manage report templates and translators. DataSmith Batch Manager is using this shared folder to locate defined Inbox folders and to process automatically data files via DataSmith. If TCP 445 is not open, clients cannot work on any CM4D Files or update any DataSmithBatch Settings.
    HOOPS Communicator is third-party software that is the Stream Cache Server application that streams 3D model data to the HOOPS Web Viewer integrated in CM4D Peruse for client-side rendering.
    This is the default port for Microsoft SQL Server database management system (MSSQL) server. As CM4D uses MS SQL Server to locate CM4D Site, CM4D and Results databases, this port must be open for clients to access data via CM4D applications and services.
    [Optional] Install a third-party virus scanner for scanning uploaded data files in CM4D Upload Portal.

    Hardware Reference

    Software Reference

     

    Can we improve this topic?