Chapter 9: Defining EKM Servers, Queues, and External Applications

Engineering Knowledge Manager

Administration Guide |

8.3.1. How Job Data Files are Handled in EKM and RSM |  | 9.1. Adding EKM Servers
Prev |  | Next

## Chapter 9: Defining EKM Servers, Queues, and External Applications

The /Administration/Servers page contains a built-in job submission server named `Master`, and is also the page where you would add a cache server if using one.

The built-in `Master` server contains the installed Data Extraction Queue named `EKM Server`, and may contain any number of job submission queues. A job submission queue can be batch or interactive. For more information about queues, see Types of Queues.

Each queue contains application definition files (`*.app.xml` files) that will launch external applications from EKM.

EKM launches external applications for a variety of tasks, including:

- Extracting metadata, images and reports from supported simulation files

- Executing batch processes in a job, process, or custom application

This chapter describes how to create and define servers, queues, and external applications in EKM. However, it does not explain how to modify process-related configuration settings in the ekm.xml file that may be required for your system. These are listed below.

- `localProcess`: Specifies settings for applications that are run locally on the EKM server.

- `remoteProcess`: Specifies settings for applications that are run remotely through ANSYS Remote Solve Manager (RSM), or through EnginFrame. This is required only if you want to configure EKM to use RSM for remote execution, or if you want to provide users with the ability to run interactive jobs from EKM.

- `customRetentionSetting`: Specifies the retention policy for a `Job` object.

- `scheduledTasks`: Specifies settings for the `batchJobMonitor` task.

For details on these settings, see Specifying General Server Settings

Specific usages of external applications are covered in detail in other chapters in this Administration Guide and in the User’s Guide. Refer to Defining Process Templates in EKM Studio in the User’s Guide for using external applications in process templates and batch processes.

The high-level steps required to configure EKM for launching external applications are listed below.

- Specify the process-related configuration settings in the ekm.xml file (see Specifying General Server Settings).

- For batch jobs, install and configure RSM as explained in Integrating EKM with Remote Solve Manager (RSM).

- For interactive jobs, install and configure EnginFrame as explained in Installing and Configuring EnginFrame in the EKM Installation Guide.

- Create batch job submission queues in EKM that correspond to RSM queues, and interactive job submission queues that correspond to queues defined in the ekm.xml file. This is done automatically at startup. See Synchronizing Job Submission Queues.

- Set permissions on queues to control which users may submit jobs to them (see Editing Permissions).

- Define applications in the desired queue as explained in Defining External Applications.

This chapter presents information on how to set up EKM servers, queues, and external applications. Topics include:

- Adding EKM Servers
- Defining EKM Cache Servers
- Types of Queues
- Managing Queues
- Creating and Editing Cluster Configurations in EKM
- Defining External Applications
- Running Interactive Jobs in EKM

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.