Reference Guide - Install CM4D Peruse
Click here to see this page in full context
  1. Home >>
  2. Technical >>
  3. Installation >>
  4. Quick Reference Guides >>
  5. Reference Guide - Install CM4D Peruse

Reference Guide - Install CM4D Peruse

The CM4D Peruse installation process requires the following:

Internet connection

ATS Security and Configuration Manager with Admin roles

CM4D Configuration plugin with CM4D Admin roles

This guide contains the general steps for installing the ATS CM4D Peruse web application.

  1. Run the CM4D Peruse installer executable (as Administrator).
  2. Prerequisites - If required, follow the prompts to install the required redistributables.
  3. License Agreement - Accept the terms of the license agreement.
  4. Installation Folder - Set the installation folder for Peruse. The default path is C:\Program Files (x86)\Applied Tech Systems\ATS CM4D Peruse\. To change the install folder, click Browse and select the new folder.
  5. CM4D Site Database - Provide the connection information for the CM4D Site Database. The user entered here must have access to the database.
    1. Server name - The machine name of the server hosting the CM4D databases. If you are using a Named Instance of SQL Server, the server name must include the instance name (e.g., servername\instancename).
    2. User name - Enter the user name for the credentials which will be used to connect Peruse to the CM4D Site database. This user is for SQL Authentication and must be a valid login with sufficient permissions to access the database.
    3. Password - Enter the password for the user credentials provided above.
    4. Database - Enter the name of the CM4D Site database, or click the ellipses to load a list of available databases. If databases are available, click the dropdown and select the Site database.
    5. Test SQL Connection - Click to check that the information entered is valid before continuing on with the installation.
  6. Server & Ports - Configure the SSL certificate, server name and ports for Peruse.
    1. SSL Certificate - Select a trusted root certificate from the dropdown menu.
    2. Server name - The machine name of the server hosting Peruse. The Server Name must match the Subject Alternative Name (SAN) or Common Name (CN) value for the selected SSL Certificate.
    3. Port (Peruse) - The default port for Peruse is 4000. To change the port, enter a new port number.
    4. Port (Peruse API) - The default port for the Peruse API is 2000. To change the port, enter a new port number.
  7. ATS Licensing Server - Provide the configuration information for the ATS Licensing Server, including the port. Enter the full endpoint URL for the ATS Licensing plugin Web URL, including the port (https://servername.domain.local:44335/).
  8. Security Manager and CM4D API Endpoints - Provide the configuration information for the Security Manager endpoint and the Application ID for Peruse. This step requires that you have access to the Security plugin in ATS Configuration Manager and sufficient privileges to create or modify an Application.
    1. Security Manager Endpoint - Enter the endpoint URL for the ATS Security Manager, including the port (https://servername:5000/). The default address may be provided for you, but confirm that it has the correct connection type and port number.
    2. CM4D API Location - Enter the endpoint URL for the server running the CM4D API service, including the port (https://servername:5200/). If the endpoint is incorrect or unreachable (e.g., CM4D API service is stopped), a warning is returned. You must correct the URL before the installation can continue.
    3. Test Security Manager Endpoint - Click to check the connection information entered can connect successfully. If any of the entered information is incorrect, the test will show the connection failed and you must correct it before you can continue with the installation.
  9. HOOPS Communicator Server - Configure the SSL certificate, server name, ports and certificate files for the HOOPS Communicator server. The HOOPS Communicator server requires a third party trusted certificate and key files to authenticate connections and secure data transfers.
    1. HOOPS Hostname - The machine name of the server hosting HOOPS Communicator. If you are using a domain, be sure to enter the FQDN in this field.
    2. Port (HOOPS Communicator) - The default port for HOOPS is 11182. To change the port, enter a new port number.
    3. Path to certificate file (pfx/pem) - Browse to the HOOPS certificate file.
    4. Path to key file - Browse to and select the HOOPS key file.
    5. StreamCacheSmith export folder path: The path to the folder used by StreamCacheSmith to store 3D model files for CM4D Peruse that are exported from CM4D. The StreamCacheSmith service creates any necessary subfolders in this root location. HOOPS Communicator references this directory to load 3D Models in CM4D Peruse.

      If you installed the CM4D Results Services before installing Peruse, make sure to set the StreamCacheSmith Export Folder Path to the same location as defined during the StreamCacheSmith Service installation. If unsure of the defined path, check the appsettings.json file for StreamCacheSmith.

  10. Finish the installation.

Can we improve this topic?