ClusterEditorUI.exe utility

The Cluster Editor utility (ClusterEditorUI.exe) reads the server configuration file and updates the UNICOM Intelligence server cluster (mostly DPM settings) with new server information. The utility also updates the new server with required cluster information, including updating the Projects directory with required files. The utility serves the same function as the Command line Cluster Editor utility (ClusterEditor.exe), except that it is offered as a desktop application that provides a simple user interface. The ClusterEditorUI.exe must be run on the cluster's Primary DPM server. When run on a non-Primary DPM server, the Prepare Server, Attach Server, Detach Server, and Delete Server menu options are disabled.

The Login dialog displays after you start the utility. By default, the Login using Windows account option is checked. The utility first tries to login to DPM with LoginUsingWindowsAccount(). If the login fails, the utility tries to login to DPM with LoginAsTrustedWindowsAccount(). If both login attempts fail, the utility displays the failed login information.

If you prefer to login to DPM with specific login credentials, you must disable the Login using Windows account option, and then enter the appropriate user name and password information. You can change the login user by selecting File > Login.

Cluster details are available when you select the main cluster in the Cluster Editor utility. Cluster details are defined in the site preparation file and provide specific cluster information such as the server names, role, port, and whether SSL is enabled for each server.

The non-modifiable field provides the site name (provided from DPM).

The field provides options for specifying a location for the site preparation file (DataCollectionSitePrep.ini). The utility populates the field by reading the SiteInstallationDir registry value from:

If the registry value does not exist, you can manually enter the site preparation file path or click Browse to go to the site preparation file location.

You can print the contents of the site preparation file by selecting File > Print.

Lists information for all cluster servers, including server name, roles, port number, and SSL setting.

ClusterEditorUI.exe scenarios

Cluster Editor utilities

There are two methods for adding a server to a cluster:

▪Method 1: Adding an unprepared UNICOM Intelligence server to a cluster. This method prepares and attaches a server where UNICOM Intelligence software was not previously installed.

▪Method 2: Adding a prepared UNICOM Intelligence server to a cluster. This method entails attaching a prepared, but unused, UNICOM Intelligence server to the cluster. The new server already has the UNICOM Intelligence software installed. This new server can be created by copying an existing virtual machine with the software preinstalled.

In this scenario, the server is not yet installed or assigned a role. The Cluster Editor utility must be used to update the site preparation file before you install the UNICOM Intelligence Server software. You can go to Method 2: Adding a prepared UNICOM Intelligence server if the server is already in a prepared state (prepared with the Cluster Editor utility and UNICOM Intelligence is installed).

The method uses a separate, single computer cluster for configuration purposes. Alternately, see Adding a server, when UNICOM Intelligence is not preinstalled, directly to the target cluster for instructions on adding a server without overwriting customized DPM settings.

1 Open the Cluster Editor UI from the server you want to prepare, and click Prepare Server. The right pane displays options for defining the new server, such as roles, connection settings, and performance settings.

Select the roles this server will perform within the cluster: Select the appropriate cluster roles for the new server. You must select at least one role. The following roles are provided:

Virtual directories (for Accessories, Survey Tabulation, Survey Reporter Server, and Author Server): Defines the number of virtual directories to create for each server type (Accessories, Survey Tabulation, Survey Reporter, and Author). The minimum value is 1; the maximum value is 64.

Session engines (for Interviewer Server): Defines the number of session engines when the Interviewer Server role is selected for the server. Select the appropriate number of session engines for the server. The minimum value is 1; the maximum value is 64.

Web services (for Web Server): Defines the number of web services when the Web Server role is selected for the server. Select the appropriate number of web services for the server. The minimum value is 1; the maximum value is 64.

2 Click Save to save the new server's settings. The new server's status is set to Configured, which means the server's configuration information is saved to the site preparation file.

A <server_name>.iss file is also created as a convenience; it supports UNICOM Intelligence silent installations. When a silent installation is selected as the UNICOM Intelligence installation method for the prepared server, the file’s password settings must be manually updated. For example:

[{1EA0104A-75FE-4546-9D16-D71C22D6D590}-dlgUserAdmin-0]UserPassword=NOT_SETResult=1
[{1EA0104A-75FE-4546-9D16-D71C22D6D590}-DlgAskAnonUser-0]AnonymousUserPassword= NOT_SETResult=1
[{1EA0104A-75FE-4546-9D16-D71C22D6D590}-DlgAskDPMAdmin-0]DpmAdminPassword= NOT_SETEnableIWA=FALSE
Result=1

6 Open the Cluster Editor UI, and then click File > Refresh; select the server node, and then click Detach Server to detach the server from the separate, single computer cluster.

7 Now that the server is in a prepared state, see Method 2: Adding a prepared UNICOM Intelligence server for instructions on adding a prepared server.

This scenario assumes that the server is prepared in accordance with the steps outlined in the previous section. Before proceeding, you must ensure that the Cluster Editor utility was used to prepare the server and that the UNICOM Intelligence software is installed on the virtual or physical server.

A new server can be a copied from a virtual machine image, however the virtual machine image must be configured with a unique name before it can be added to the cluster.

1 Configure the server with the Server Configuration utility (ServerConfig.exe). This step is required if the new server is added to a different target cluster for which it was originally configured.

Run ServerConfig.exe on the new virtual machine image or physical computer. The purpose is to collect information about which UNICOM Intelligence products and roles are installed on the image/computer, and to update the image/computer configuration to match the destination server cluster. For example:

If the UNICOM Intelligence software was installed on the virtual machine image with a different service user (or as an anonymous user other than the normal cluster users) and the site preparation file does not contain the encrypted password for the users, the user is prompted to enter the service user and anonymous user passwords.

2 After you use ServerConfig.exe to update the site preparation file on the server, run ClusterEditorUI.exe, select the server from the tree view, and then click Attach Server to add the server to the cluster.

Removing a server from a cluster

ClusterEditorUI.exe utility

The Cluster Editor UI can also be used to remove existing cluster servers.

You cannot remove servers that are part of a minimum cluster set. The minimum cluster set is defined as a server that is one of the last accessories, interview, or web servers. A server can be removed if it is the last Survey Tabulation, Survey Reporter, or Author server.