Command line Cluster Editor utility (ClusterEditor.exe)
The command-line Cluster Editor utility (
ClusterEditor.exe) reads the server configuration file and updates the UNICOM Intelligence 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 can be used instead of the
Command line Cluster Editor utility (ClusterEditor.exe).
ClusterEditor.exe parameters
<site preparation file>
The site preparation file (DataCollectionSitePrep.ini) is a required input. The file contains configuration information for each cluster server. For each server, it contains the server name, and UNICOM Intelligence information, including the server role (Web, Interview, Accessories, and so on), port and protocol information. It also includes supported options such as Phone or CAPI synchronization support (if applicable).
-attach <server name>
Adds the server to a cluster, after which the server is a member of the cluster.
-prepare <server configuration file>
Takes the server configuration file as input, updates the site preparation file , and creates a response file (for silent installation). The setting is used for servers where UNICOM Intelligence software is not installed.
This option is similar to the Prepare Server option in the Cluster Editor Utility user interface.
-detach <server name>
Removes the server from the cluster.
-delete <server name>
Removes the server from the cluster and from the site preparation file.
-verbose
When specified, detailed information is displayed.
-help | -? | -h
Displays utility help information.
Input
The site preparation file (DataCollectionSitePrep.ini) is a required input.
Output
The cluster editor outputs an updated site preparation file, and creates a response file for silent installation (with the -prepare parameter).
Command line 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 software. You can skip to the Method 2: Adding a prepared Data Collection server to a cluster section if the server is already in a prepared state (prepared with the Cluster Editor utility and UNICOM Intelligence is installed).
1 Manually prepare the server configuration file. For example:
<Server name="ServerName" status="Configured">
<Roles>
<Role name="RoleName">
<Property name="Port" value="80" />
<Property name="Protocol" value="HTTP" />
<Property name="Instances" value="1" />
<!--PhoneInterviews only configured with Accessories role-->
<Property name="PhoneInterviews" value="TRUE" />
<!--RemoteAdministration only configured with Accessories role-->
<Property name="RemoteAdministration" value="TRUE" />
</Role>
</Roles>
</Server>
Server configuration XML attributes
status
The server status must be set as Configured.
Role name
The following roles are available:
AccessoriesServer
InterviewServer
WebServer
SurveyTabulationServer
SurveyReporterServer
AuthorServer
Port
The value must be a positive integer 1 - 65535.
Protocol
The value must be HTTP or HTTPS.
Instance
The value must be a positive integer 1 - 64.
PhoneInterviews
The value must be TRUE or FALSE. This attribute is ignored for Roles other than AccessoriesServer.
RemoteAdministration
The value must be TRUE or FALSE. This attribute is ignored for Roles other than AccessoriesServer.
Using ClusterEditor.exe
1 Run ClusterEditor.exe on a separate, single computer cluster to update the site preparation file (in accordance with the server configuration file from the previous step). This step effectively prepares the server. The silent response file<ServerName>.iss files is created in the same path as the site preparation file. For example:
ClusterEditor.exe <site preparation file> [-prepare <server configuration file>]
2 If a DPM login is required, the utility tries to login to DPM withLoginUsingWindowsAccount() and LoginAsTrustedWindowsAccount(). If both login attempts fail, the utility prompts the user to input an appropriate DPM user name and password.
3 Run the UNICOM Intelligence installer on the new server (in normal or silent mode).
4 Run the ClusterEditor.exe utility on the separate, single computer cluster to detach the new server:
ClusterEditor.exe <site preparation file> [-detach <server name>]
5 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 to a cluster
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.
Note 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 the ServerConfig.exe utility 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.
Note A silent installation creates encrypted passwords.
2 Add the server with the Cluster Editor utility.
Run the ClusterEditor.exe utility on the cluster's Primary DPM server. The purpose is to add the new server to the cluster according to the defined server configuration in the site preparation file. For example:
ClusterEditor.exe <site preparation file> [-attach <server name>]
See