15.12. Tracking Cluster Usage Through a Cluster Job Name

Engineering Knowledge Manager

Administration Guide | Chapter 15: Miscellaneous Tasks |

15.11. Customizing the Heading on the EKM Title Bar |  | Chapter 16: Backing Up and Restoring EKM
Prev |  | Next

## 15.12. Tracking Cluster Usage Through a Cluster Job Name

If your organization needs to track job submissions from EKM to HPC clusters (for billing purposes, for example), you can add a custom field to the job submission wizard which enables users to enter a cluster job name when creating a job. The cluster job name could be an identifier such as an account name. For example, if usage is billed by department, account names could be department codes. The cluster job name is then reported in the RSM Job Log, which ties the EKM job to that account and creates a traceable piece of data.

1. Shut down the EKM server. Refer to the chapter on Starting and Connecting to EKM in the Installation Guide for details.

2. In the ekm.xml file, which is located in the `EKM_HOME/conf` folder, add the following setting to the `<remoteProcess>` section:

       <enableClusterJobNameSpecification>true
       </enableClusterJobNameSpecification>

   This will display an edit box in the job submission wizard labelled Cluster job name. If you want to customize the label, complete steps 3,4 and 5.

3. To customize the label, go to `EKM_HOME/bundles/en` (or other language folder if using a different locale). If not already present, create a text file named custom.properties.

4. In a text editor, add the following entry to the custom.properties file, replacing `custom label` with the label that you would like to be displayed for the custom field in the job submission wizard:

       jobManagement.startBatchJob.clusterJobName=custom label:

   For example, if you want the label to say Account name, you would enter:

       jobManagement.startBatchJob.clusterJobName=Account name:

5. Save the custom.properties file.

6. Restart the EKM server. The custom field will be displayed on the first screen of the job submission wizard when users submit batch jobs:

When the job is submitted, an `RSM_HPC_JOBNAME` entry is added to the RSM job log. It displays the value that the user entered in the custom field when creating the job. For example, if the user entered `DEPT_ENG` in the Account name field, the following would be displayed in the RSM job log:

Note: If a user applies a tag to a job, the Cluster job name specified in the tag will automatically populate the cluster job name field you have created. For more information see Setting Up a Batch Job.

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.