Install Semantic Enhancement Service

Note: Before installing, see Requirements for software prerequisites and required technical specifications for Semaphore.

To install Semantic Enhancement Service:

1. On the target server, run the following installer program executable as an administrator:

   Copy

   Semaphore-<version>-SES-setup.exe
   

2. The License Agreement window appears. Make sure that you read and understand the license agreement. To continue with the installation, select the I accept the agreement; then, click Next.

3. In the Select Destination Location window, specify the location to install the Semantic Enhancement Service server. Then click Next.

4. In the Select Data Directory window, specify the directory in which the SES Server should store data files. The data directory is used to write SES indexes. The size of indexes is relational to the size of the model; however, they can vary in size from tens of megabytes up to gigabytes, for the very largest models. Make sure that the location you specify has enough storage to accommodate your model size. Click Next to proceed.

5. The SES server configuration window opens. Specify the port on which the SES Server listens. Note that the specified port must be free. Typically, the default value is fine. Click Next to proceed.

   Note: Be aware that the Zookeeper port needs to be kept open to allow it to be accessed from the Publisher machine. Similarly, the Solr port needs to be open to allow it to be accessed from any machine might need to use it.

6. In the SES installation configuration window, choose whether the SES server will be part of a cluster of SES machines. Your choice affects how the server identifies itself to the Zookeeper instance. In most scenarios, you should select Standalone SES server. Click Next to proceed.

7. In the SES service configuration window, choose if you want to install the SES server as a Windows service or if you prefer to manually start and stop the server. We recommend that you install the server as a Windows service in most scenarios. If you install the service as a Windows service, the name of the service will be SEM-SES-SA. Click Next to proceed.

   Note: If you want to use the built-in Solr instance, but do not wish to install it as a service, there are start and stop scripts provided in the bin directory of the SES installation.

8. In the Select License Directory window, specify the following location (the default) to store the Semaphore licence key; then, click Next:

   Copy

   C:\\Program Files\\SmartLogic
   

   Important: When moving the license key file to the specified location, you should rename the license key file from <environment_name>-Env-Licence-<expiry_date>.txt to licence.

9. In the Licence window, choose one of the following; then, click Next.

   • Copy your licence key into the field.

   • Click Browse and navigate to your licence file

10. Click Install to begin the installation.

Comply with your Licence

To comply with your current Semantic Enhancement Server licence, configure the Semantic Enhancement Server service to use only the number of cores permitted by your licence. To do this:

To do this, perform the following steps:

1. Navigate to and open the following file in a text editor:

   Copy

   <ses_install_dir>\\solr\\bin\\solr.cmd
   

   For example, C:\Program Files\Smartlogic\SES\solr\bin\solr.cmd.

2. Search for the following command. You can typically find it around line 1304.

   Copy

   START /B \"Solr-%SOLR_PORT%\" /D \"%SOLR_SERVER_DIR%\" \^
   ``` ​
   

3. In the command, add the /AFFINITY <mask> parameter after START /B.

   where <mask> identifies which CPU cores to use and is the hexadecimal value of a bitmask where each bit represents a CPU core. For example:​

   CPU 0: 0x1 (0001)​

   CPU 1: 0x2 (0010)​

   CPU 2: 0x4 (0100)​

   CPU 3: 0x8 (1000)​

   If you want to use more than one core, create the bitmask and find the hexadecimal representation for the mask to correspond to the CPUs to use. For example, for two cores (using CPU 0 and CPU 1) it would be as follows: ​

   CPU 0 and 1: 0x3 (0011)​

   This would result in the following line being used:​

   Copy

   START /B /AFFINITY 0x3 \"Solr-%SOLR_PORT%\" /D \"%SOLR_SERVER_DIR%\" \^
   

4. After saving your changes to the file, restart the SES Windows service for the updated settings to take effect.​ See Starting and stopping services in "Plan your semaphore installation" for more information.

Next steps

Install Semaphore Studio