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.
Login dialog
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 enter the appropriate user name and password information. You can change the login user by selecting File > Login.
Viewing cluster details
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.
Name
The non-modifiable field provides the site name (provided from DPM).
Site preparation file
The field provides options for specifying a location for the site preparation file (DataCollectionSitePrep.ini). The utility pre-populates the field by reading the SiteInstallationDir registry value from:
HKEY_LOCAL_MACHINE\Software\SPSS\DimensionNet\InstallOptions
If the registry value does not exist, you can manually enter the site preparation file path or click Browse to navigate to the site preparation file location.
To print the contents of the site preparation file, click File > Print.
Servers
Lists information for all cluster servers, including server name, roles, port number, and SSL setting.
See
See also
ClusterEditorUI.exe scenarios
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.
Method 1: Adding an unprepared UNICOM Intelligence server to a cluster
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. If the server is already in a prepared state (prepared with the Cluster Editor utility and UNICOM Intelligence is installed), go to
Method 2: Adding a prepared UNICOM Intelligence server .
The method uses a separate, single computer cluster for configuration purposes. To add a server without overwriting customized DPM settings, see
Adding a server, when UNICOM Intelligence is not pre‑installed, directly to the target cluster .
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.
Name: Enter an appropriate server name. The utility does not verify the server name.
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:
▪Accessories Server
▪Phone Interviews
▪Remote Administration
▪Web Server
▪Interview Server
▪Survey Tabulation Server
▪Survey Reporter Server
▪Author Server
Use secure socket layer: When selected, the new server uses secure socket layer (SSL) when it establishes connections.
Port number: Defines a specific port number for the new server. The port number must be an integer 1 - 65535. The default value is 80.
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 <ServerName>.iss file is also created as a convenience and is used to support UNICOM Intelligence silent installations. When a silent installation is selected as the UNICOM Intelligence installation method for the prepared server, the file's various 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
A silent installation creates encrypted passwords.
3 When changes are made on the server form, the Save and Cancel controls are enabled (only when the server status is Configured).
4 Close the Cluster Editor UI.
5 Run the UNICOM Intelligence installer on the selected server.
6 Open the Cluster Editor UI, and then click File > Refresh. Click 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, refer to the following section for instructions on adding a prepared server.
Method 2: Adding a prepared UNICOM Intelligence 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.
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:
ServerConfig.exe <site preparation file>
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.
A silent installation creates encrypted passwords.
2 Run ClusterEditorUI.exe, click the server, and then click Attach Server to add the server to the cluster.
See
See also
Removing a server from a cluster
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.
1 In the Cluster Editor UI, select the server.
2 Click one of the following:
Detach Server: Removes the server from the cluster.
Delete Server: Removes the server from the cluster, and removes the server information from the site preparation file.
3 Click Yes.
See also
Server processes
The following list outlines the server process steps (prepare, install, reconfigure, attach, detach, and delete) when you work with UNICOM Intelligence cluster servers.
Adding an unprepared UNICOM Intelligence server (physical or virtual): Prepare step (from a separate, single computer cluster)
User interface action
Click Prepare Server.
The new server is added to the left pane cluster tree as a new server (identified with the
Configured icon
, and a blank configuration form displays in the right pane.
Command line equivalent
Precondition: NewServer.config file is manually created.
ClusterEditor.exe \\SiteInstallDir\DataCollectionSitePrep.ini -prepare \\SiteInstallDir\NewServer.config
Operation
1 System updates the cluster configuration file DataCollectionSitePrep .ini; the new server status is set as Configured.
2 System creates silent response files (<ServerName>.iss) for silent installation.
Fill in the configuration details, and then click Save.
Adding an unprepared UNICOM Intelligence server (physical or virtual): Install step 1
User interface action
See the UNICOM Intelligence Installation Guide for more information.
Command line equivalent
If the cluster was ever installed within a normal node, the passwords must be manually input (instead of NOT_SET) for the service user, anonymous user, and DPMAdmin:
See the silent installation instructions in the UNICOM Intelligence Installation Guide for more information.
Operation
1 The UNICOM Intelligence installer installs software with configured roles and settings.
2 The UNICOM Intelligence installer updates the server status to Installed in the DataCollectionSitePrep .ini file.
Adding an unprepared UNICOM Intelligence server (physical or virtual): Install step 2
User interface action
Starting the Cluster Editor in this state displays the server in an installed status (identified with the
Installed icon
). Select the new server and click
Detach Server.
Command line equivalent
ClusterEditor.exe \\SiteInstallDir\DataCollectionSitePrep.ini -detach NewServerName
Operation
1 System removes the server from the cluster.
2 System sets the server status as Detached in the DataCollectionSitePrep.ini file.
Adding a prepared UNICOM Intelligence server (physical or virtual): Reconfigure step (from the target cluster, if required)
User interface action
None (must use command line)
Command line equivalent
ServerConfig.exe \\SiteInstallDir\DataCollectionSitePrep.ini
Operation
1 System updates the new server to match the cluster.
2 System adds the new server information in DataCollectionSitePrep .ini; the server status is Detached.
Adding a prepared UNICOM Intelligence server (physical or virtual): Attach step
User interface action
1 Select File > Refresh in the Cluster Editor utility.
The server displays with the
Detached 
or
Installed icon.
2 Click Attach Server.
Command line equivalent
ClusterEditor.exe \\SiteInstallDir\DataCollectionSitePrep.ini -attach NewServerName
Operation
1 System adds the server to the cluster.
2 System updates the server status to Attached inDataCollectionSitePrep .ini.
Server included in cluster: Delete step
Click Delete Server.
The server is removed from the cluster tree.
Command line equivalent
ClusterEditor.exe \\SiteInstallDir\DataCollectionSitePrep.ini -delete NewServerName
Operation
1 System removes the server from the cluster.
2 The server information is removed from DataCollectionSitePrep .ini.
See also