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

Reference Guide - Install CM4D Upload Portal

Topic Contents [Hide]Topic Contents [Show]
  1. Install CM4D Upload Portal
  2. Install DataSmith Batch Proxy
  3. Install DataSmith Translator

This guide contains the general steps for installing and configuring CM4D Upload Portal. To allow for distributed services, CM4D Upload Portal is installed in three parts:

  1. CM4D Upload Portal - CM4D Upload Portal web application, CM4D Upload Portal service and CM4D Upload Portal API Service
  2. DataSmith Batch Proxy - DataSmith Batch Proxy Service
  3. DataSmith Translator - DataSmith Translator Service

The CM4D Upload Portal installation process requires a user with administrative access to ATS Security and Configuration Manager. This is so you can obtain the ID string required to connect the Upload Portal to the ATS Configuration manager.

Install CM4D Upload Portal

  1. Run the CM4D Upload Portal install executable (as Administrator).
  2. Agree to the terms and conditions.
  3. Select Features and Install Folder. The default options are to install the Upload Portal application and services and to install the Upload Portal to C:\Program Files (x86)\Applied Tech Systems\ATS Upload Portal\. Most installations will use the defaults provided, but you can modify how it is installed.
  4. Enter the database information. This database is created entirely by the installer, including the database object, tables and procedures.
    1. Server - Enter the database server name, or leave the default (local) if installing on the local machine. The default (local) is automatically resolved to the computer name in the installed configuration files.
    2. Trusted Connection - Enter the user credentials to access the database management system. This user must have a sufficient privilege level to create and modify databases.
      1. To use the current Windows user account, leave the Trusted Connection box checked.
      2. To use a SQL login, uncheck the Trusted Connection box.
    3. Database - Set the database for the CM4D Upload Portal, DataSmith Translator and DataSmith Batch Proxy services.
      1. To allow a new database to be created by the installer, enter a unique name.
      2. To choose an existing database, click the ellipses button and select a database from the dropdown menu.
    4. Test SQL Connection - Click to confirm that the selected user can connect to the database server.
      1. If the connection is successful, continue.
      2. If the connect fails, correct the user login and retest.
  5. Enter the database connection information. This user must have a sufficient privilege level to create and modify databases.
    1. Username - Enter a username for the SQL login account.
    2. Password - Enter a password for the SQL login account.
  6. Provide the service endpoint details.
    1. Server Name - Enter the Server Name of the machine hosting the CM4D Upload Portal.
    2. Port (Upload Portal) - The default port for the CM4D Upload Portal is 4600. To change the port, enter a new port number.
    3. Port (Upload Portal API) - The default port for the CM4D Upload Portal API is 5200. To change the port, enter a new port number.
    4. SSL Certificate - Select a certificate.
  7. Confirm Security Manager and Application ID. Provide the Security Manager endpoint and the Application ID for the Upload Portal.
    1. Security Manager Endpoint - Enter the endpoint URL for the ATS Security Manager, including the port (https://servername:5000/).
    2. Upload Portal Application ID - The Upload Portal Application ID must be generated by adding the CM4D Upload Portal as a new Application in the ATS Security and Configuration Manager.
      1. Go to ATS Security Manager and log in with a user with Admin access.
      2. On the Security card, click Open.
      3. On the Applications card, click Add Application.
      4. Enter the information about the new application.
        1. Name - Enter a name for the application, such as 'CM4D' or 'Upload Portal'.
        2. Description (optional) - Enter a description for the application that can be seen in the Applications grid card.
        3. Access Rights URL - Enter the address endpoint for the CM4D Upload Portal, including the server name and port (https://servername:4600/) entered in the previous install window.
      5. Click Save.
      6. Click on the grid row of the new application to open the Application properties.
      7. In the Access ID field, copy the string.
      8. Go back to the Upload Portal installation window.
      9. Paste the Application ID from the Application properties in the Upload Portal Application ID field of the installer window.
    3. Test Security Manager Endpoint - Click to confirm you can connect to the endpoint. If the server name or port are incorrect, the test will show the connection failed.
  8. Confirm Security Manager and CM4D API endpoints. The default endpoints are provided based information provided in previous installation steps.
    1. Security Manager Endpoint - Enter the endpoint URL for the ATS Security Manager, including the port (https://servername:5000/).
    2. CM4D API Endpoint - Enter the endpoint URL for the CM4D Upload Portal API, including the port (https://servername:5200/).
  9. Enter the ATS Licensing Server URL.
  10. Finish the installation. If prompted about restarting the Configuration Manager service, click OK.

The Upload Portal web page is launched automatically in the default browser. You must install DataSmith Batch Proxy and DataSmith Translator, and then configure ATS Security and Configuration Manager before the Upload Portal can be used.

Install DataSmith Batch Proxy

  1. Run the DataSmith Batch Proxy install executable (as Administrator).
  2. Agree to the terms and conditions.
  3. Select the Install Folder. The default installation folder is C:\Program Files (x86)\Applied Tech Systems\ATS CM4D Datasmith Batch Proxy\.
  4. Set the Server Information. Enter the server name, port and Security Manager endpoint.
    1. SSL Certificate - Select a certificate.
    2. Server Name - Enter the Server Name of the machine hosting the CM4D Upload Portal.
    3. Port (DataSmith Batch Proxy API) - The default port for the DataSmith Batch Proxy API is 3200. To change the port, enter a new port number.
    4. Security Manager Endpoint - Enter the endpoint URL for the ATS Security manager, including the port (https://servername:5000/).
  5. Finish the installation.

Install DataSmith Translator

  1. Run the DataSmith Translator install executable (as Administrator).
  2. Agree to the terms and conditions.
  3. Select the Install Folder. The default installation folder is C:\Program Files (x86)\Applied Tech Systems\ATS CM4D Datasmith Translator\.
  4. Provide the service endpoint details.
    1. SSL Certificate - Select a certificate.
    2. Server Name - Enter the Server Name of the machine hosting the CM4D Upload Portal.
    3. Port (DataSmith Translator) - The default port for the DataSmith Translator is 4500. To change the port, enter a new port number.
  5. Finish the installation.

Can we improve this topic?