11.4.1. Service Names

Engineering Knowledge Manager

Installation Guide | Chapter 11: Starting the EKM Server and Launching the Web Client | 11.4. Registering and Running EKM as a Service |

11.4. Registering and Running EKM as a Service |  | 11.4.2. Running EKM as a Service
Prev |  | Next

### 11.4.1. Service Names

Service names on both Windows and Linux must be unique. This is an important consideration when setting up multiple EKM servers, or multiple instances of an EKM cluster component (such as cluster nodes) on the same server host. This section outlines the service names used by components on Windows and Linux, and provides guidance for registering multiple EKM components as services on the same server host.

#### 11.4.1.1. Windows

Windows services have a display name and a key name. Both the display name and key name for a service must be unique on the server host on which the service is installed.

EKM components are pre-configured with customized service names that incorporate the cluster name and/or node name, such that the service names of each cluster component are unique.

Important: In most cases, there is no need to change any of the service names. However, if you need to change the name of a service, the instructions in this section will explain how to do so.

This section outlines how to create unique service names for different EKM services, based on how the EKM server is set up. Each entry includes the name of an EKM service, example service display + key names, and the list of files to edit in order to change the service names.

Service: Cluster Node

- Service Key Name: EKM182_<CLUSTERNAME>_<NODENAME> for example, EKM182_EKMSERVER_NODE1

- Service Display Name: ANSYS EKM Release 18.2 <CLUSTERNAME> <NODENAME> for example, ANSYS EKM Release 18.2 EKMSERVER NODE1

- Files: `JBOSS_HOME/domain/configuration/wrapper.conf`

Service: Cluster Database Server

- Service Key Name: EKMDB182_<CLUSTERNAME> for example, EKMDB182_EKMSERVER

- Service Display Name: ANSYS EKM Database Release 18.2 <CLUSTERNAME> for example, ANSYS EKM Release 18.2 Database EKMSERVER

- Files: `EKMDB_ROOT/bin/ekm_env.cmd`

KEY:

<CLUSTERNAME>: The EKM cluster name.

<NODENAME>: The node name (node ID) of the cluster node.

##### Renaming a Service:

If you need to rename a service, consult the list above to determine which files need to be edited, and follow the steps to rename the service.

Cluster Node:

1. If the service is running, stop the service.

2. If the service is registered, un-register the service using the service un-registration script:

   `EKM_NODE_ROOT182/bin/unregister_ekm_service.cmd`

3. Edit `JBOSS_HOME/domain/configuration/wrapper.conf` and modify the service key and display names, as well as the service description (shown in bold) according to the guidelines provided above:

       wrapper.ntservice.name=EKM182_EKMSERVER_NODE1
       wrapper.ntservice.displayname=ANSYS EKM Release 18.2 EKMSERVER NODE1
       wrapper.ntservice.description=ANSYS EKM Server Release 18.2 EKMSERVER NODE1
       # wrapper.ntservice.dependency.1=EKMDB182_EKMSERVER

   Note: If you are configuring a cluster node that uses the default MySQL database server, `wrapper.conf` defines an optional dependency on the EKM database service. Service dependencies can be used to configure a service to depend on one or more other services on the same server host. This is useful for a single-node EKM server, where the cluster database server and cluster node are installed on the same server host. The service key name of the EKM database service is provided as the value of `wrapper.ntservice.dependency.1`. This value must match the service key name of the EKM database service associated with this EKM server. The service dependency must be uncommented to enable it.

4. Register the service using its service registration script:

   `EKM_NODE_ROOT182/bin/register_ekm_service.cmd`

Cluster Database Server:

Note: All cluster nodes must be stopped before renaming the cluster database service.

1. If the service is running, stop the service.

2. If the service is registered, un-register the service using the service un-registration script:

   `EKMDB_ROOT/bin/unregister_ekmdb_service.cmd`

3. Edit the control script: `EKMDB_ROOT/bin/ekm_env.cmd`

   Find the line that reads:

       rem EKM Windows Service Names

   Below this line will be service key and display names (shown in bold) for the cluster database server. Edit these according to the guidelines provided above:

       rem EKM Windows Service Names
       set EKMDB_SERVICE_KEY_NAME=EKMDB182_EKMSERVER
       set EKMDB_SERVICE_DISPLAY_NAME=ANSYS EKM Database Release 18.2 EKMSERVER

4. Register the service using the service registration script:

   `EKMDB_ROOT/bin/register_ekmdb_service.cmd`

#### 11.4.1.2. Linux

Linux service names must be unique. In Linux, service names are defined by `init` scripts, which are registered with and executed by the `init` subsystem. Linux services take their name from the name of the `init` script.

An example `init` script is provided at the following location of each EKM server or cluster component:

- EKM cluster nodes: `EKM_NODE_ROOT182/bin/init.d`

- EKM cluster database server: `EKMDB_ROOT/bin/init.d`

This script can be modified to match the configuration of each cluster component. Instructions for adapting the script are provided later in this section.

Note:

- The `init` script provided with EKM follows the LSB model for `init` scripts, though it is not verified for compliance with the LSB standard.

- Dependencies between services can be defined by setting properties within `init` scripts. A discussion of this is beyond the scope of this guide.

This section outlines how to create unique service names for different EKM services, based on how EKM is set up. Each entry includes the name of an EKM component, an example service name, and instructions for creating/adapting an `init` script for this service.

Service: Cluster Node

- Service Name: ekm182_<CLUSTERNAME>_<NODENAME> for example, ekm182_EKMSERVER_NODE1

- Init Script: `ekm182`

Service: Cluster Database Server

- Service Name: ekmdb182_<CLUSTERNAME> for example, ekmdb182_EKMSERVER

- Init Script: `ekmdb182`

KEY:

<CLUSTERNAME>: The EKM cluster name.

<NODENAME>: The node name (node ID) of the cluster node.

##### Renaming a Service:

To rename a service, follow these steps (example: rename `ekm182` service to `ekm182_EKMSERVER_NODE1`):

1. If the service is already registered, stop the service (if necessary), and unregister it:

   `/etc/init.d/ekm182 stop`

   `/sbin/chkconfig -–del ekm182`

2. Rename the service:

   1. Rename the `init` script to the new service name:

      `mv /etc/init.d/ekm182 /etc/init.d/ekm182_EKMSERVER_NODE1`

   2. Edit the `init` script and change the value of the “Provides” tag in the service header to the new service name:

      Old:

          # Provides:          ANSYS EKM Release 18.2

      New:

          # Provides:          ANSYS EKM Release 18.2 EKMSERVER_NODE1

3. Register the service:

   `/sbin/chkconfig -–add ekm182_EKMSERVER_NODE1`

Contains proprietary and confidential information of ANSYS, Inc. and its subsidiaries and affiliates.

Prev | Up / Contents | Next

Release 18.2 - © ANSYS, Inc. All rights reserved.