9.6.2. Defining External Applications Directly in EKM

Engineering Knowledge Manager

Administration Guide | Chapter 9: Defining EKM Servers, Queues, and External Applications | 9.6. Defining External Applications |

9.6.1. Predefined External Applications |  | 9.6.3. Defining External Applications Using XML
Prev |  | Next

### 9.6.2. Defining External Applications Directly in EKM

This section presents information on how to define external applications directly in EKM. See Defining External Applications Using XML if you want to define an application using XML.

#### 9.6.2.1. Creating a New External Application

To create a new application directly in EKM:

1. Go to the Administration/Servers/Master and select the queue with which you want to associate the external application.

2. Select (New) > External Application. This will open the New External Application dialog box, shown below.

   Figure 9.2: Creating a New External Application

3. Enter the Application key, Application name, Execution path, 0 or more Command line parameters, 0 or more Environment variables and optional Job submission options. Click the Add buttons to add more parameters or environment variables. Environment variables are specified as a name and value. Click the Remove buttons to remove parameters or environment variables.

   Important:

   - It is highly recommended that you specify a different Application key and Application name in each external application file that you define. (Do not use the same key or label in more than one file.) This ensures that applications are uniquely identified when they are displayed in a list, and ensures that the correct execution path is used.

   - In Windows clusters, any parameter that contains a space (for example, a file path) should be enclosed in double quotation marks “” to ensure that it is treated as a single parameter. Otherwise, the job may fail.

   Application key

     A string that identifies the application. For example, when you execute a batch task in a process, custom application or analysis project, the Application key name that you specify here is used to execute the application.

   Application name

     The name that will be used to identify the application in the interface (for example, in the job wizard, in the Job Details view, or the Edit Batch Node dialog box).

   Execution path

     The full path to the application executable on your local file system.

   Command line parameters

     Parameters that can be added to the command that will be run.

   Environment variables

     Variables that can be added and will be defined when the command is run. These variables only exist while the command is executing.

   Job submission options

     Settings relating to the batch submission system. Leave this blank if you do not have any options to specify.

4. When you have finished defining your new external application, click Create & Close to create the application and exit the dialog box, or Create & New to continue to create more applications.

The application will be automatically saved as an XML file with the file extension .app.xml in the queue’s folder, with the name that is specified for the `Application key`. In our example, the application file myAppKey.app.xml is saved as: `/Administration/Servers/Master/Local/myAppKey.app.xml`

#### 9.6.2.2. Editing an External Application Definition

To edit an existing application definition using a dialog:

1. Select the queue with which the application is associated. Queues are located in the /Administration/Servers/Master folder.

2. Right-click and select Edit > External Application from the context menu. This will open the Edit External Application dialog box.

3. Make any changes to the Application key, Application name, Execution path, Command line parameters, Environment variables and Job submission options and then click OK to save your changes.

Important: In Windows clusters, any parameter that contains a space (for example, a file path) should be enclosed in double quotation marks “” to ensure that it is treated as a single parameter. Otherwise, the job may fail.

#### 9.6.2.3. Editing an External Application Using XML

You can edit the definition of an external application by editing the content of the XML file. You can do this directly within EKM.

1. Select the queue with which the application is associated. Queues are located in the /Administration/Servers/Master folder.

2. Right-click and select Edit > Content from the context menu. This will open the Edit Content dialog box.

   Figure 9.3: Edit Content Dialog Box

3. Make the desired changes to the file content, and then click OK to save your changes.

If you want, you can also download the file first, modify it in an XML or text editor, and then upload the file and overwrite the existing application definition with the modified one.

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.