Install CM4D Upload Portal
Click here to see this page in full context
  1. Home >>
  2. Installations >>
  3. Upload Portal Installation >>
  4. Install CM4D Upload Portal

Install CM4D Upload Portal

Hide Topic ContentsShow Topic Contents
  1. Prepare for Installation
  2. Run the CM4D Upload Portal Installer
    1. Features and Installation Folder
    2. Upload Portal Database
    3. Database Access
    4. Upload Portal Endpoints
    5. Security Manager Connection
    6. CM4D API Endpoint
    7. ATS Licensing Endpoint
    8. Finish Installation

This topic details the steps for installing CM4D Upload Portal and its supporting services.

This installation process requires a user with administrative access to ATS Security and Configuration Manager. Before the Upload Portal can be installed, you must have ATS Configuration Manager and ATS Security set up, and have Admin privileges in ATS Security and Configuration Manager.

See here for a brief installation guide or visit ATS-HELP for the full ATS Security and Configuration Manager documentation.

Prepare for Installation

Access ATS Security and Configuration Manager. Additionally, the Licensing and CM4D Configuration plugins are required.sd
 

Download and/or install the ATS Security and Configuration Manager.
 

Download and/or install ATS Licensing Server plugin (only needed if not already running v4.0+).
  Download and/or install the ATS CM4D Configuration plugin.
 

Log in to ATS Security and Configuration Manager as a user with Administrator privileges.
Download ATS CM4D installers.
  ATS CM4D Upload Portal
  ATS CM4D DataSmith Batch Proxy
  ATS CM4D DataSmith Translator
Download and Install Prerequisites. This 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 are downloaded automatically when needed during installation.
 

Microsoft .NET Core Hosting Bundle Runtime 3.1.10 
 

Microsoft Visual C++ 2017 Redistributable (x64) - 14.16.27012

Run the CM4D Upload Portal Installer

  1. which is the correct port, 4600 or 5200? or can it be either?
  1. Run the CM4D Upload Portal install executable (as Administrator).
  2. Prerequisites - If required, follow the prompts to install the required redistributables.
  3. Click Next.
  4. Agree to the terms and conditions, then click Next.

Features and Installation 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. 

  1. To change which features to install, uncheck the unwanted options: ATS Upload Portal and API Services - Installs the CM4D Upload Portal applications and its supporting services. This machine must be able to connect to ATS Security and Configuration Manager.
  2. To change the installation folder, go to the tab and either enter a folder path or browse to a folder.
     
  3. Click Next.

Upload Portal Database

  1. 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.
  2. Click Next.

Database Access

  1. 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.
  2. Click Next.

Upload Portal Endpoints

  1. Provide the service endpoint details.
    1. Type - Select the security type, either http or https.
    2. Server Name - Enter the Server Name of the machine hosting the CM4D Upload Portal.
    3. Port (Upload Portal) - The default port for the CM4D Upload Portal is 4600. To change the port, enter a new port number.
    4. Port (Upload Portal API) - The default port for the CM4D Upload Portal API is 5200. To change the port, enter a new port number.
    5. SSL Certificate (https only) - Select a certificate.
  2. Click Next.

Security Manager Connection

  1. Provide the Security Manager endpoint and 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. Hide InstructionsShow instructions
      1. Go to ATS Security Manager and log in with a user with Admin access. On the Security card, click Open.
      2. On the Applications card, click Add Application.
      3. 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.
      4. Click Save. If the application was added successfully, the new row of the Applications grid should have the Status 'Created'. Click on the grid row of the new application to open the Application properties. In the Access ID field, copy the string ().
      5. Go back to the Upload Portal installation window. 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.
  2. Click Next.

CM4D API Endpoint

  1. 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/).
  2. Click Next.

ATS Licensing Endpoint

  1. Enter the ATS Licensing Server URL.
  2. Click Next.

Finish Installation

  1. Click Install.
  2. If prompted about restarting the Configuration Manager service, click OK.
  3. Click Finish.

The Upload Portal web page is launched automatically in the default browser. You must complete the configuration in the ATS Security and Configuration Manager before the Upload Portal can be used.

Related Tasks:

Install DataSmith Batch Proxy

Install DataSmith Translator

CM4D User Roles

 

Can we improve this topic?