Install on Windows

Data Management can be installed on a single Site Server, one or more Execution Servers (or Workers), and multiple clients. In most Microsoft Windows installations, the Site Server, one of the Execution Servers, and one client can be co-located. Windows Server Core can host a Site Server and/or Execution Server; for details, see installing on Windows Server Core.

Prerequisites

Because the Data Management architecture has several networked services that can cooperate across multiple servers, installing Data Management requires some planning.

1. Be sure you have administrator-level permissions for the computers that will host the Data Management installation. Site and Execution services require access to network resources.

2. Determine your security requirements:

   • Simple security mode: The entire Data Management system—browsing, projects, automations, and web services—runs under the Data Management service logon. Simple security is suitable for environments in which all users have the same OS privileges, or in which Data Management services are run separately on each user’s desktop or VM. In simple security mode, Data Management enforces permissions on its repository objects on a per-user basis.

   • Advanced security mode:  Each Data Management user maps to an OS user, and has the same access privileges as he or she would have when logged on directly to the OS. When advanced security is enabled, you may optionally define the Administrator user as a specific OS user, authenticated using OS security by validating that user with the password entered in the OS logon dialog. 

3. Determine the service logon for the Data Management system. During installation you will be prompted to specify a user account to determine which file and database resources are accessible by the servers and their projects. Generally, you should specify an explicit username and password that has permission to access all of the network and database resources that any Data Management user will want. If the services use explicit logons for all database access and don't need to access network drives, they can use the Local System logon account feature instead.

4. Choose a computer to host the Data Management Site Server, which will control licensing, coordinate Execution Servers, enable Data Management client design sessions, host the WebService Proxy service, and maintain the repository of settings, projects, macros, data, users, groups, schedules, and logs.

5. For a multi-host configuration, choose the set of computers that will host the cluster of Data Management Execution Servers for the site. One of these Execution Servers can be hosted by the same computer as the Data Management Site Server.

You may choose a multi-host installation for two reasons:

• To separate the functions of the Site Server from the Execution services.

• To enable simple clustering of Execution services, which supports load-balancing.

In both cases, you will have one host (or VM) that is running the Site service, and one or more worker hosts (or VMs) running the Execution service without the Site service. The Execution Servers on these worker hosts must share the same core security settings as the Site Server on these properties:

• use_ssl

• validate_ssl_cert

• enable_advanced_security

• administrator_os_user

 These settings are defined in the Data Management configuration file CoreCfg.properties.

To install the software on the Data Management server(s)

1. Download the installers for Data Management and any desired modules (such as CASS, DPV, LacsLink, or Geocoder).

2. Run the Data Management installer and accept the license agreement. When prompted to Select the type of installation to perform:

Enterprise installation

1. Run the Data Management installer on the computer that will host your Site Server, Execution Server and client, and accept the license agreement.

2. When prompted to Select the type of installation to perform, select Enterprise.

3. If you are upgrading from Data Management version 8, you can optionally select Migrate my version 8 repository to import projects and some settings from the previous version.

Note that Advanced Security and custom JVM settings are not automatically migrated. If you have these configured in your version 8 installation, you may need to configure the enable_advanced_security, jvm_memory_mb, and jvm_options properties manually in the file CoreCfg.properties.

4. Specify the Data Management installation location. If this location has less than 10 GB of space available or is not writable by applications, select Use an alternate data location and specify a Data folder that is large and writable. This is especially useful for reference data sets such as address quality and geocoder databases.

5. Specify the Site Server configuration:

   • If any ports in the range 20420-20426 are already in use, select Override the base port for Data Management Servers and specify an available base port. (To review a list of active connections, press the Windows logo key + R and then type cmd. Enter netstat -a -n at the command line.)

   • Optionally, select Enable Advanced Security. Advanced security mode maps each Data Management user to an OS logon, applying the access privileges that the OS user has when logged on directly to the OS.

   • If you select Enable Advanced Security, you may optionally select Map the Administrator logon to an Active Directory user and enter the OS logon of the Administrator user.

   • Specify the Execution Server name and Execution Server network address, or accept the default values.

6. Specify the service logon that will run the Data Management services:  

   • Select Specify user account, and then enter credentials for an OS Username and Password (if required). This account should have access to all network resources and databases that Data Management will use. If it is a domain user account, it must be of the form DomainName\UserName.

   • If you do not specify a user account, Data Management will run as LOCAL SYSTEM. Access to network files and resources may be restricted. We do not recommend using LOCAL SYSTEM to run the Data Management services.

7. Review your selected installation options, and then select Install to continue. When installation is complete, select Finish, and then install any additional modules (CASS, DPV, LacsLink, Geocoder).

Single-host installation with encryption

When you install Data Management and choose the Enterprise installation, all services run on a single host. The first time that the Site service starts after installation or upgrade, it generates encryption keys in the crypto_keys folder in the Data Management installation location. This process is automatic.

The system administrator should copy this folder to a secure backup location. Loss of these keys will render all stored “secrets” inaccessible.

Repository installation

1. Run the Data Management installer on the computer that will host your Site Server, and accept the license agreement.

2. When prompted to Select the type of installation to perform, select Repository.

3. If you are upgrading from Data Management version 8, you can optionally select Migrate my version 8 repository to import projects and some settings from the previous version.

Note that Advanced Security and custom JVM settings are not automatically migrated. If you have these configured in your version 8 installation, you may need to configure the enable_advanced_security, jvm_memory_mb, and jvm_options properties manually in the file CoreCfg.properties.

4. Specify the Data Management installation location. If this location has less than 10 GB of space available or is not writable by applications, select Use an alternate data location and specify a Data folder that is large and writable. This is especially useful for reference data sets such as address quality and geocoder databases.

5. Specify the Site Server configuration:

   • If any ports in the range 20420-20426 are already in use, select Override the base port for Data Management Servers and specify an available base port. (To review a list of active connections, press the Windows logo key + R and then type cmd. Enter netstat -a -n at the command line.)

   • Optionally, select Enable Advanced Security. Advanced security mode maps each Data Management user to an OS logon, applying the access privileges that the OS user has when logged on directly to the OS.

   • If you select Enable Advanced Security, you may optionally select Map the Administrator logon to an Active Directory user and enter the OS logon of the Administrator user.

6. Specify the service logon that will run the Data Management services:  

   • Select Specify user account, and then enter credentials for an OS Username and Password (if required). This account should have access to all network resources and databases that Data Management will use. If it is a domain user account, it must be of the form DomainName\UserName.

   • If you do not specify a user account, Data Management will run as LOCAL SYSTEM. Access to network files and resources may be restricted. We do not recommend using LOCAL SYSTEM to run the Data Management services.

7. Review your selected installation options, and then select Install to continue. When installation is complete, select Finish, and then install any additional modules (CASS, DPV, LacsLink, Geocoder).

8. Perform Worker and Client installations to complete a multi-host installation.

Worker installation

1. Run the Data Management installer on the computer that will host your Execution Server, and accept the license agreement.

2. When prompted to Select the type of installation to perform, select Worker.

3. Specify the Data Management installation location. If this location has less than 10 GB of space available or is not writable by applications, select Use an alternate data location and specify a Data folder that is large and writable. 

4. Specify the Execution Server configuration:

   • Specify the Execution Server name and Execution Server network address, or accept the default values.

   • Optionally, specify the Site Server address and base port.

   • Optionally, specify the folder containing the Data Management Cryptographic keys, located at the Site Server host’s Data Management installation location. If you do not specify this folder now, you will need to configure the crypto keys manually after installation.

5. Specify the service logon that will run the Data Management services:  

   • Select Specify user account, and then enter credentials for an OS Username and Password (if required). This account should have access to all network resources and databases that Data Management will use. If it is a domain user account, it must be of the form DomainName\UserName.

   • If you do not specify a user account, Data Management will run as LOCAL SYSTEM. Access to network files and resources may be restricted. We do not recommend using LOCAL SYSTEM to run the Data Management services.

6. Review your selected installation options, and then select Install to continue. When installation is complete, select Finish, and then install any additional modules (CASS, DPV, LacsLink, Geocoder).

7. Check that the Data Management configuration file CoreCfg.properties (located in the Data Management installation folder) has the same core security settings as the Site Server for the following properties:

   • use_ssl

   • validate_ssl_cert

   • enable_advanced_security

   • administrator_os_user

If necessary, stop the Execution service, edit the CoreCfg.properties file using a text editor, and then restart the Execution service.

Multi-host installation with encryption

The first time that the Data Management Site service starts after installation or upgrade, it generates encryption keys in the crypto_keys folder in the Data Management installation location. In a multi-host Data Management installation, computers hosting Execution Servers require access to these keys. During a Worker installation, you may specify this location, automatically copying these keys to the Execution Server. If you do not specify the location of these keys during installation, you can configure them manually later.

To perform a multi-host installation with encryption

1. Install Data Management on the host running the Site service.

2. Install Data Management on one or more worker hosts.

3. Stop the Execution and WSP services on the worker hosts.

4. Copy the crypto_keys folder from the Site Server host’s Data Management installation location to the equivalent folder on each worker host.

5. Set permissions on the copied folders as follows:

   • All files and folders are owned by the user running the Data Management services.

   • All keystore files are readable by everyone, but writable only by the user running the Data Management services.

   • All password files are readable and writable only by the user running the Data Management services.

6. Restart the Execution and WSP services on the worker hosts.

Client installation

1. Download the Data Management installer.

2. Run the Data Management installer on the workstation computer. When prompted to Select the type of installation to perform, choose Client.

3. Choose the folder in which to install the software.

4. When installation is complete, select Finish.

Do not install additional modules (CASS, DPV, LacsLink, Geocoder) on client computers.

Install on Windows Server Core

Windows Server Core does not have a traditional desktop interface. Instead, Server Core is designed to be managed remotely through the command line, PowerShell, or a GUI tool like RSAT or Windows Admin Center).

All of the Data Management installers can be run in "quiet" or unattended mode. This includes the Enterprise (Server and Client) installer, and its modules (CASS, SERP, EWS, Geocoder, Loqate). While the Data Management Client can be installed, it cannot be run on Windows Server Core, as Server Core lacks a GUI.

To install the software on Windows Server Core

1. Download the installers for Data Management and any desired modules (CASS, SERP, EWS, Geocoder, Loqate).

2. From the command line or equivalent, run the installer(s) and pass the argument:

--mode unattended

To suppress the display of user interface elements or feedback, include the argument:

--unattendedmodeui none

You can provide additional installation options and arguments to the installer on the command line, or using an options file (a .properties file containing all of the parameters to configure).

3. Monitor installation progress by tailing the installer log, located in C:\ProgramData\Redpoint\DM\Logs. Identify the most recent log, and tail it with the following command:

Get-Content C:\ProgramData\Redpoint\DM\Logs\<logfile> -Tail 15 -Wait

A successful Data Management install will include the following near the end of the log:

Writing install profile

A successful module install will include the following near the end of the log:

Installing update module: <module and date>

To uninstall the software on Windows Server Core

•  From the command line or equivalent, run the uninstaller(s) and pass the argument:

--mode unattended

Unattended installation options

To view supported parameters, options and arguments, run the installer on the command line with the --help option.