Chapter 14: Units: Defining and Configuring Using XML

Engineering Knowledge Manager

Administration Guide |

13.9. EKM REST API |  | 14.1. Schema Definition for Units
Prev |  | Next

## Chapter 14: Units: Defining and Configuring Using XML

EKM enables you to assign units to properties when you are defining a custom type. Units for built-in types, however, are stored in a consistent system within the database and cannot be changed internally. You can however, add units for built-in types that will display property values in the units that are defined. Note that this only affects the presentation of property values in the user interface and not the actual values that are stored.

The following terms are used for describing unit functionality in EKM:

- `quantity`: This refers to a physical quantity that can be measured in various units. For example, length is a quantity that can be measured in various units such as `m`, `f`, and so on.

- `unit`: This refers to the unit of measurement of a physical quantity. For example, `m` and `ft` are units for the quantity length.

- `unit system`: This refers to a consistent set of units for measuring various quantities. For example, `SI`, `British`, and so on.

Units are defined for a particular workspace in the `Units.xml` file in the `/Administration/Configuration` folder. This chapter describes the `Units.xml` file and explains how you can add units, quantities, and unit systems that are displayed in the user interface. Changes to this file can be made only in restricted configuration mode. Refer to Restricted Configuration for details on how you can start and end the restricted configuration mode.

You can use the units and quantities defined in the `Units.xml` file to define properties of type `Double` in custom types described in Defining Properties Using XML. You can assign a `quantity` and a `unit` for each `Double` property. If you assign a `quantity` and not a `unit`, then the property value will be shown in the preferred unit system that is defined for the user in their preferences. Refer to the Setting User Profiles and Preferences chapter in the EKM User's Guide for details.

The overall process for defining a unit XML file and configuring it for a workspace is as follows:

- Download the unit definition file (`Units.xml`) and add a unit, quantity or unit system using the schema definition for units and an XML editor.

- Start restricted workspace configuration mode if it has not already been started. See Starting Restricted Configuration.

- Upload the unit file using the (Upload) > Files/Archives Using the Browser method to the `/Administration/Configuration` folder.

- Accept the workspace configuration. See Accepting the Configuration.

The remainder of this chapter presents information on how to define new units in EKM using XML. Topics include:

- Schema Definition for Units
- Adding a New Unit
- Adding a New Quantity
- Adding a New Unit System

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.