5.1.2. Running ANSYS EKM Server Product Installation

Engineering Knowledge Manager

Installation Guide | Chapter 5: Installing an EKM Server | 5.1. Installing a New EKM Server |

5.1.1. Installation Requirements |  | 5.2. Running a Silent Installation
Prev |  | Next

### 5.1.2. Running ANSYS EKM Server Product Installation

Important:

- The ANSYS EKM Server product installation must be executed by the EKM server account in order to ensure that the EKM server account has correct access permissions to all files created during installation.

- On Windows, EKM does not support mapped drives when run as a Windows service. If you will be running EKM as a Windows service, all paths provided in the Setup wizard must be UNC paths or paths to local file systems.

- You must install ANSYS Workbench and any other desired components before installing the EKM Server.

An information icon appears next to various settings throughout the ANSYS EKM Server product installation. Hovering over this icon displays a tooltip that provides information about that setting.

To install an EKM server, follow these instructions:

1. Save all data and close all Windows applications before continuing.

2. Execute the ANSYS EKM Server product installation:

   - On Windows systems, run setupEKMSVR.exe in the product installation directory.

   - On Linux systems, run INSTALL.EKMSVR in the product installation directory.

3. Read the terms of the license agreement, and if you agree, select I Agree. You must agree to the terms to continue with the installation.

4. On the Prerequisites screen, review the machine prerequisites and perform the necessary prerequisite operations. Once all of the prerequisites are fulfilled, check the Prerequisites fulfilled box and continue to the next screen.

5. On the Cluster Node Settings screen, specify whether the node that you are defining is the Primary node or a Non-Primary node in the EKM cluster.

   - If you are defining the Primary node, specify the following settings:

     EKM cluster name: The name of the EKM cluster to which the cluster node belongs. The default is `ekmserver`.
     EKM cluster node ID: The node ID for the node in the EKM cluster. The default is `node1`.
     JBoss port offset: The JBoss port offset for the EKM server. The default value is 0. For more information, see Appendix D: Resolving Network Port Conflicts.

   - If you are defining a Non-Primary node, specify the following settings:

     EKM cluster node ID: The node ID for the node in the EKM cluster. The default is `node1`.
     EKM cluster primary node IP address: The IP address of the primary cluster node of the EKM cluster.
     JBoss port offset: The JBoss port offset for the EKM server. The default value is 0. For more information, see Appendix D: Resolving Network Port Conflicts.

6. On the Database Server Type screen, select one of the following:

   - Set up the default database server: MySQL: Use the MySQL database server that is bundled with EKM.

   - Use an existing database server: Use a database server that is already set up for EKM. Select either MySQL or Oracle in the drop-down list to specify the existing database server type.

7. Specify the Database Server Settings:

   - If using the default MySQL database server:

     EKM database directory: The base directory for the cluster database server installation (The default is `C:\ekm\mysql-5.5.41`).
     Port number: The port number that will be used to connect to the cluster database server (the default is `3306`).
     Password: The password that will be used to connect to the cluster database server.

   - If using an existing database server:

     Host name: The name of the host where the cluster database server is running (the default is `localhost`).
     Port number: The port number that will be used to connect to the cluster database server (the default is `3306` for MySQL and `1521` for Oracle).
     User name: The user name that will be used to connect to the database server (for example, `root`).
     Password: The password that will be used to connect to the cluster database server.
     Database name: The name of the database created for EKM (for example, `ekm`).
     (Oracle only) JDBC database driver location: The location of the Java Database Connectivity (JDBC) driver that you downloaded from the database software vendor site. See Download the JDBC Driver for the Cluster Database Server.

     Note: If the JDBC driver consists of more than one file, you must provide the location of all of the JDBC driver files. These should be entered as a comma-separated list containing the full path and filename of each JDBC driver file. You can multi-select JDBC driver files in the file selector by clicking the Browse button, and then holding down the CTRL key while selecting multiple files.

8. On the Setup Directories screen, specify the following settings:

   - Base directory for the EKM server: The directory where EKM and the server environment will be set up (for example, `\\server\share\ekm`). The base directory cannot contain spaces. This directory must be a located on a file share on the cluster file server. This directory will be accessed by all EKM cluster nodes.

   - Base directory for the cluster node: The directory where the cluster node will be set up (for example, `C:\ekm\node1`). The base directory cannot contain spaces.

   - Shared path for the EKM data directory: The internal storage directory for files stored in the EKM repository (for example, `\\server\share\ekm\datastore`). This directory must be a located on a file share on the cluster file server. This directory will be accessed by all EKM cluster nodes.

   - EKM job data directory: The directory where EKM job data is staged. This directory must exist prior to installation. To avoid file transfers, set this to the shared cluster staging directory, which is the directory in which job input files are placed by client applications like EKM when a job is submitted to RSM (see File Handling in the RSM User's Guide). This directory must be visible to all cluster nodes. For information about how to specify this directory, see the `jobSourceRootPath` setting in the Administration Guide. This directory must be located on a file share on the cluster file server. This directory will be accessed by all EKM cluster nodes.

   - EKM cluster visible directories: Top-level paths that are visible to all compute cluster nodes. Only locations within these paths will be allowed as working directories for jobs.

     You do not need to include the EKM job data directory here, as EKM automatically considers it to be visible.

     You only need to specify this setting if:

     - You are using a relative path for a Linux installation.

     - Users will be submitting jobs to EKM from Workbench, Workbench and RSM are installed on different machines, and each uses a different path to refer to the same physical job directory. In this case, you will also need to add a `pathMappings` setting to the ekm.xml file once EKM is installed.

   - EKM temp directory: The directory used by EKM to store temporary files. It must be writable by the EKM server account.

   - ANSYS licensing directory: The directory where ANSYS licensing is installed.

9. On the EKM Server Account Settings screen, specify the following settings:

   - Windows Domain (for example, `mycompany.com`) (Windows only): The Windows domain of the EKM server account. To use a local user account that does not belong to a domain, leave the field blank.

   - Name (for example, `johndoe`) (Windows only): The user name for the EKM server account. The user account is either an Active Directory user account, or a local user account.

   - Designated root user. The Root User is the primary administrator for an EKM workspace, and is the only user who can perform restricted workspace configuration. The user specified in this setting will be the default Root User for all workspaces defined in EKM. When a workspace is initialized, a user account will be automatically created for this user. To specify the Root User, enter that user’s EKM user name. Note that this user must have a valid OS or LDAP account to be able to log into EKM. For more information on how EKM user names are determined, see How User Logins Work.

     Note that you can change the Root User later by editing the `defaultRootUser` setting in the ekm.xml file. See Specifying General Server Settings in the Administration Guide for details.

   - Session timeout (in minutes): The amount of idle time before the EKM server will automatically log you out. Default is 30 minutes.

   - Host name of the SMTP (mail) server (for example, `smtp.mycompany.com`): The host name of the SMTP mail server that EKM will use to send email.

   - RSM Windows Domain: Specify this setting if jobs will be submitted to a Windows cluster submit host. This is the Windows domain name that will be prepended to the user name of all EKM users when batch jobs are submitted to RSM. For more information, see the `rsmWindowsDomain` (Windows only) setting in the Administration Guide.

10. Continue to the next screen to begin installing files.

11. Once the installation is complete, specify whether or not you wish to participate in the installation survey by enabling or disabling the Launch survey upon exiting check box. Click Exit.

ANSYS EKM Server product installation generates a log file named `install.log` in the cluster node base directory that records details about the setup process, including any errors that were encountered.

Repeat the ANSYS EKM Server product installation to install additional cluster nodes, as required.

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.