Quick Reference Guide: Install CM4D Upload Portal

This guide contains the general steps for installing and configuring CM4D Upload Portal.

The CM4D Upload Portal is installed in three parts:

1. CM4D Upload Portal - CM4D Configuration (ATS Configuration Manager plugin), CM4D Upload Portal service and CM4D Upload Portal API Service (see here for detailed steps)
2. DataSmith Batch Proxy - DataSmith Batch Proxy Service (see here for detailed steps)
3. DataSmith Translator - DataSmith Translator Service (see here for detailed steps)

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 key required to connect the Upload Portal and CM4D API services to the ATS Configuration manager.

Prepare for Installation

1. Access ATS Security and Configuration Manager.
		Download and/or install the 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.
		Log in to ATS Configuration Manager as a user with Administrator privileges.
2. Download ATS installers.
		CM4D Upload Portal
		ATS CM4D DataSmith Batch Proxy
		ATS CM4D DataSmith Translator
		ATS Licensing Server (only needed if not already running v4.0+). For more information on ATS Licensing, visit ATS-HELP for the full ATS Licensing Server documentation.
3. Download and install the required .NET Core. 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, the prerequisite is downloaded during installation.
		Microsoft .NET Core Hosting Bundle Runtime 3.1.10

Run Installers

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.

Install CM4D Configuration and/or CM4D Upload Portal

1. Run the CM4D Upload Portal install executable (as Administrator).
2. Click Next.
3. Agree to the terms and conditions, then click Next.
4. The default options are to install both the Upload Portal application/services and CM4D configuration, 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 the features installed, uncheck the options. Leave both checked if you are installing the CM4D Configuration and Upload Portal on the same system.
   2. To change the installation folder, go to the tab and either enter a folder path or browse to a folder.
5. 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. Click Next.
6. Provide the database login credentials and service endpoint details.
   1. Credentials - Enter the database connection information. This user must have a sufficient privilege level to create and modify databases.
      1. Enter a username for the SQL login account.
      2. Enter a password for the SQL login account.
   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.
7. 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 (http://servername:4200/).
   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. Browse to the ATS Security Manager URL (http://servername:4200/) 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 (http://servername:4600/) entered in the previous install window.
         4. Click Save.
      5. Click on the grid row of the new application to open the Application properties.
      6. In the Access ID field, copy the string ().
   3. Go back to the Upload Portal installation window.
   4. Paste the Application ID from the Application properties in the Upload Portal Application ID field of the installer window.
8. Click Next.
9. 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 (http://servername:4200/).
   2. CM4D API Endpoint - Enter the endpoint URL for the CM4D Upload Portal API, including the port (http://servername:5200/).
10. Click Next.
11. Enter the ATS Licensing Server URL.
12. Click Next.
13. Click Install.
14. When prompted about restarting the Configuration Manager service, click OK.
15. Click Finish.

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. Click Next.
3. Agree to the terms and conditions, then click Next.
4. The default installation folder is C:\Program Files (x86)\Applied Tech Systems\ATS CM4D Datasmith Batch Proxy\.
   1. To change the install folder, click Browse.
   2. Select the new folder and click Select Folder.
5. Click Next.
6. Enter the server name, port and Security Manager endpoint.
   1. Server Name - Enter the Server Name of the machine hosting the CM4D Upload Portal.
   2. 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.
   3. Security Manager Endpoint - Enter the endpoint URL for the ATS Security manager, including the port (http://servername:4200/).
7. Click Next.
8. Click Install.
9. Click Finish.

Install DataSmith Translator

1. Run the DataSmith Translator install executable (as Administrator).
2. Click Next.
3. Agree to the terms and conditions, then click Next.
4. The default installation folder is C:\Program Files (x86)\Applied Tech Systems\ATS CM4D Datasmith Translator\.
   1. To change the install folder, click Browse.
   2. Select the new folder and click Select Folder.
5. Click Next.
6. Enter the server name and port.
   1. Server Name - Enter the Server Name of the machine hosting the CM4D Upload Portal.
   2. Port (DataSmith Translator) - The default port for the DataSmith Translator is 4500. To change the port, enter a new port number.
7. Click Next.
8. Click Install.
9. Click Finish.

Once the three services are successfully installed, complete the configuration of the CM4D Upload Portal in the ATS Security and Configuration Manager.

Can we improve this topic?