Single Server Installation and Configuration

Installing the Single Server places the server on one machine and supports fixed load balancing and single-queue capacity. Resources that are installed include a shared location or file system, and system services used for job processing and prioritization. Please note that a PostgreSQL database is required.

The Clarify Single Server installation comes with an executable file from Cleo. You'll find an Install Wizard that will help you step by step, and once you're done, you'll have the following resources created:

• Installation directory: The Clarify_6_Server directory holds the utilities, start-up and uninstall executables, database components, and other resources needed by the Clarify Server.
• Server workspace directory: The Clarify_6_Runtime_WorkspaceServerdirectory holds database components and other resources used by the server.
• Desktop icons (optional). Shortcuts to start and uninstall the server.

Note: Please avoid running virus protection software on the directories mentioned above. It's best to turn it off if it's currently active.

Pre-Install Requirements

1. A permanent license must be applied after initial server start-up.
2. The Clarify Server installation executable must be run as an administrator (or user under an Administrator Group). For Linux: it must be run as root and from the terminal.
3. A Domain User should be used to run and manage the Clarify Server. For Linux: A Domain User is required and will be prompted for in the install process. The user must already exist prior to installation.
4. Users must have their own PostgreSQL database available to a Clarify server. Please refer to the Guidelines for using your PostgreSQL Database with Clarify for more details.  
5. The installation directory should be shared among related environments. For Linux: the permissions of the install and share will be handled by the install, and will not have to be explicitly set.
6. Turn off firewall(s) or open ports. See Port Setting configuration for more details.

Installing the Single Server

Please review the minimum system requirements. Note that the specifics of your implementation may require more resources than outlined here. Consult your Customer Account Manager or Technical Support for more information.

Before You Begin

To install and begin using the Clarify Single Server, please have access to the following:

• Executable file (provided by Cleo)
• Domain user
• License (needed post-installation)
• Single Server Installation procedures (Review before install)
• PostgreSQL Database (not part of server install process)

Installation Procedures

The steps below follow an Install Wizard that guides you through the process.

1. Launch the install: Locate the executable file. This must be run as an Administrator. (For Linux, must launch as root.)
2. Introduction: Read all instructions and recommendations.
3. License Agreement: Read the License Agreement. Click the I accept the terms of the License Agreement radio button to enable the Next button.
4. Choose Server Installation Type: Select Single Server from the radio button options, and click Install.
5. Choose a destination folder for the installation: This should be a common installation directory with sharing enabled.
6. Choose the Server Artifact Location (Server Workspace): This directory holds database components and other resources used by the server.
   Note for Linux users: At this point in the install process, a panel appears prompting for the domain user (Enter name for object ownership). The user to be entered here must already exist and be accessible by the install machine.
7. Enter the database information being used by your server installation. Some info may pre-populate.
   
   -Database Hostname or IP Address 
   -Database Name
   -Database Port
   -Database User
   -Database Password
    
   Please refer to the Guidelines for using your PostgreSQL Database with Clarify for more details.  
    
8. Memory Allocation: Either accept the proposed values for the Server Memory Value, or modify as desired. As noted, the format is ####m, where #### is your memory allocation and m represents megabytes.
    
9. SMTP Server: If intending to use Clarify to generate email, you must provide the SMTP Server IP address and port. Otherwise, these settings may be left blank. Should you decide to configure this setting later; you can do so from within the Admin Console perspective’s Settings view. This view provides an administrative area to configure settings for different objects, logs, email servers, and other cross-functional applications. This view can be found on the Admin Console perspective.
10. Choose Shortcut folder: Both the All Users Desktop and Start Menu checkboxes are checked by default – modify if necessary. (This does not exist for Linux)
11. Pre-Installation Summary: Review all selections. If a choice must be changed, click Previous (as many times as necessary) to return to the appropriate earlier step, modify the selection, and then click Next (as many times as necessary) until you return here.
12. Installing...:While the product installs, banners appear describing different features and functionality.
13. Install Complete: Click Done to complete the process.

Starting the Single Server

Use ClarifyServer_Standard (executable or shell script) to start a Single Server. This is located in the server installation directory.

Start a Single Server with a service (Windows)

Instead of manually starting a server, you can install a service that automatically starts the server on a Windows OS. The Single Server must be installed and working properly before taking the steps below.

Steps:

From a Command Prompt, right-click and Run as Administrator.

Assuming that the server has been installed to the default server location, type the following into the command window:

cd C:\Cleo\Clarify_6_Server\utils\service\Windows

Run the InstallService.bat by typing the following in the command window:

InstallService.bat ClarifyServer_Standard workspace

Check the Service Install logs within the service/logs directory.

The following logs are created: InstallServiceErr-<Node Name>.log, and InstallServiceOut-<Node Name>.log.

From the Windows Task Manager, click the Services tab and locate the service (Clarify_Standard_Service).

Right-click the service and start it. Rebooting the machine also starts the service, if set to Automatic.

Results:

• From the Windows Task Manager/Services tab, Clarify_Standard_Service should be started.
• From the Windows Task Manager/Processes tab, the ClarifyServer_Standard.exe should be started.

The Single Server is now running via a Windows service.

To uninstall the Service

1. Use Windows Task Manager to stop the service (Clarify_Standard_Service).
2. From a Command Prompt, right-click and Run as Administrator.
3. Assuming that the server has been installed to the default server location, type the following into the command window:
   cd C:\Cleo\Clarify_4_Server\utils\service\Windows
4. Run the UninstallService.bat by typing the following in the command window:
   UninstallService.bat ClarifyServer_Standard workspace.
5. Verify that the service has uninstalled from the Task Manager. You can also check the logs within the service/logs directory.

Start a Single Server with a service (Linux)

Instead of manually starting a server, you can install a service that automatically starts the server on a Linux OS. Read the steps below to learn how to:

• Install the service (as root)
• Verify that the installation was successful
• Start the service (as the domain user specified during installation)
• Verify that the service has started

Note: The Single Server must be installed and working properly before taking the steps described below.

As root:

Open a terminal from within <install>/utils/service/Linux.

Type and enter the following command:

sh clarify_service_install.sh <user> <install_path> <node_name>

As a result, the command:

• Creates the service with the name: clarifyservice_standard
• Copies the service to the /etc/rc.d/init.d directory (with the node name appended to its name).
• Populates the supplied values into the script.
• Installs the service.

Do not attempt to start the service at this point.

To verify the service has been successfully installed, type in the command:

chkconfig --list.

You should see clarifyservice_standard.service in the list.

Log out of root and use the command:

sudo service <service name> stop

This ensures that you are starting the server from a clean stop status.

To start the service, you have two options:

• Reboot the system.
• Use sudo service <service name> start to manually start the service.
   

To verify the service has successfully started type in the command:

systemctl –t service

You should see clarifyservice_standard.service as loaded, active, and running.

To uninstall the Service

Run these commands as root or sudo:

systemctl stop <servicename>
systemctl disable <servicename>
rm /etc/systemd/system/<servicename>

Adjust the number of Concurrent Processes (workers) for a Single Server

The Clarify Single Server ships with a default amount of concurrent processes (5); however, the amount specified by your licensing will most likely differ. In order to prevent errors and lower processing ability, these processes must be adjusted. This step should take place once you have completed the server installation and licensing.

To do this, we need to edit the node.properties file. This can be found in Clarify_6_Runtime_Workspace\nodes\workspace

Once open, edit the ebi.akka.numWorkers=5 property to reflect your actual number.
 

After saving and closing the file, you must restart the server.