> For the complete documentation index, see [llms.txt](https://help.justperform.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.justperform.com/process-definition/modelling/sheets/metrics/metric-details.md).

# Metric Details

Metric Details displays information of the metric configuration such as Name, Data Type, Metric Type and Summary Method. These details are common to all metrics type. Additional details will be displayed depending on the metric type, like, summary, parent and formula metric will have Layout and metric section to display fields and metrics included in the metric calculation logic, validations for input data is unique to input metric type.

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FQeuEiDMsyV5gDaEcVFmN%2Fimage.png?alt=media&amp;token=aab0f16e-4e78-427c-b981-54a46a978ad5" alt=""><figcaption><p>Metric Details</p></figcaption></figure>

## **Metric Name**

Name of the Metric, can contain alphabets, numbers and special characters excluding single quotes and dot. Name cannot start number or special character. Within a sheet, name should be unique.

## **Data Type**&#x20;

The system allows users to choose the data type for metrics from a dropdown menu with the following options:

1. **Number:** Represents a numerical value with two decimal places.
2. **Percentage:** Represents a percentage value.
3. **Integer:** Represents a whole number without decimal places.
4. **Currency:** Represents a number specifically used for accounting purposes (money).
5. **Date:** Represents a date value.
6. **Text:** Represents alphanumeric text.
7. **Boolean:** Represents a binary value with options for 'Y' (Yes), 'N' (No), or Blank.
8. **List (Selection):** A text metric with data validation in the form of a dropdown list. The system displays all available fields within the system. The dropdown list is populated from the master data of the respective field.
9. Document: The metric type allows upload of files
10. Data Status: Data status metric enables creation of Data protection rules that can be applied to specific metric or functional area. The metric is used to display current status from the allowed values of status.
11. Fields: Fields member can be as a dropdown selection to input field member as data. The allowed values here can be controlled from the Allowed members section of the metric.

Users have the flexibility to change the data type between similar data formats:

* Between Number, Percentage, Integer, and Currency.
* Between Text, Boolean, and List (Selection).
* &#x20;Date metrics cannot be changed

## **Metric Type**

Metric type is a dropdown selection with four options available. The Metrics can be of types:

### **Input**

Used for inputting data into the system. Data will be input directly by users or selection is made from dropdown.

### **Formula**

This metric contains a formula as defined by the user and displays the computed value based on the formula. Data will be calculated by specific logic

The supported formula list includes:

<table><thead><tr><th width="148">Function</th><th width="550">Description</th></tr></thead><tbody><tr><td>+</td><td>Adding Values</td></tr><tr><td>-</td><td>Minus</td></tr><tr><td>*</td><td>Multiply</td></tr><tr><td>/</td><td>Divide</td></tr><tr><td>ABS</td><td>Returns the absolute (nonnegative) value of a number</td></tr><tr><td>ACOS</td><td>Returns the principal value of the arccosine of a number. The angle is returned in radians.</td></tr><tr><td>ASIN</td><td>Returns the principal value of the arcsine of a number. The angle is returned in radians.</td></tr><tr><td>ATAN</td><td>Returns the principal value of the arctangent of a number. The angle is returned in radians.</td></tr><tr><td>CEILING</td><td>Rounds a number to the nearest integer or to the nearest multiple of significance</td></tr><tr><td>CHAR</td><td>Return character represented by a given number</td></tr><tr><td>COS</td><td>Returns the cosine of a number. The angle is returned in radians.</td></tr><tr><td>COT</td><td>Returns the cotangent of an angle, specified in radians</td></tr><tr><td>FLOOR</td><td>Rounds a number down to the nearest multiple of the second parameter</td></tr><tr><td>IF</td><td>Returns one of two values, depending on a condition</td></tr><tr><td>LEFT</td><td>Returns a selected number of text characters from the left</td></tr><tr><td>LOG</td><td>Returns the logarithm of a number to a specified base</td></tr><tr><td>LOWER</td><td>Converts text to lowercase</td></tr><tr><td>MID</td><td>Returns a specific number of characters from a text string, starting at a specified position</td></tr><tr><td>MIN</td><td>Returns the minimum value in a set of numbers</td></tr><tr><td>MOD</td><td>Returns the remainder when one number is divided by another number</td></tr><tr><td>NOW</td><td>Returns the serial number of the current date and time</td></tr><tr><td>PI</td><td>Returns the approximate value of pi</td></tr><tr><td>POWER</td><td>Returns the result of a number raised to the power of another number</td></tr><tr><td>RADIANS</td><td>Converts degrees to radians</td></tr><tr><td>REPLACE</td><td>Replaces characters within text</td></tr><tr><td>RIGHT</td><td>Returns the rightmost characters from a text value</td></tr><tr><td>SIGN</td><td>Returns the sign of a number</td></tr><tr><td>SIN</td><td>Returns the sine of an angle specified in radians</td></tr><tr><td>SQRT</td><td>Returns a positive square root of a number</td></tr><tr><td>SUM</td><td>Sums (adds) the set of numbers, including all numbers in a range</td></tr><tr><td>TAN</td><td>Returns the tangent of a number in radians</td></tr><tr><td>TRIM</td><td>Removes spaces from text; replaces all internal multiple spaces with a single space</td></tr></tbody></table>

### **Parent**

Parent metric is the used to establish hierarchy between metrics, similar to that of fields. This allows to created multi layered logics using metrics. Parent metric can only be an aggregation of metrics within the sheet including input, formula, linked metrics and other parent metric in the same sheet. The signage for each metric can be assigned as + or + from the metric section of metric details.

### **Summary**

Summary metric is similar to Formula metric, difference being, formula metric applied calculation logic to leaf members only and simply summarizes the values for non leaf members according to the summary type. Summary method does it differently by apply the same calculation logic to all members irrespective of their position in field hierarchy.&#x20;

### Linked

Linked metrics are metric imported to target sheet from the source sheet. This avoids redundancy and enables reuse of related metrics. The source and target sheets can contain different fields. The linked metric name can be given in target sheet, however the metric type, data type and summary method can only be updated in source sheet. It can only be read in target sheet. Linked metric are displayed as SheetName.Metric name in metrics section of the sheet and the metric list. The option to enable input to linked metric can be updated in target sheet using the **Allow Input** option in metric details.

### **Summary Method**

Users can select options from a dropdown menu, including:

* Sum: Calculates the total sum of metric values.
* None: No summary method applied.
* Average: Computes the average of metric values.
* Min: Identifies the minimum value among metric values.
* Max: Identifies the maximum value among metric values.
* Ratio: Allows users to define a ratio for metrics.

### Data Protection Rule

This section will how if any Data Protection rule is applied to the metric.

### Linked Field

If any fields are linked to the metric, it is displayed in this section.

### Trace

When a metric side panel is opened, a new button labeled <img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FGj570otPsskaxNCcyYfL%2Flist-tree.jpg?alt=media&amp;token=5c073d8c-35ec-4484-84fe-2ea9adc5f21a" alt="" data-size="line"> **Trace** will appear in the top-right corner of the Metric Details section. Clicking this button opens a popup containing two reports:

**Dependents**: Displays all metrics where the current metric is being used. This includes usage as an input metric, within the Add parameters of another input metric, inside the Add - Alias parameters of another input metric, or as a Journal Header Metric (Status/List type only) when used as a filter in another input metric from Journal.

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FcQYjkVGXHL7bjRWy6wK3%2Fimage.png?alt=media&amp;token=74a7fe08-2bbc-43fa-8324-413b8528be7e" alt=""><figcaption><p>Dependents</p></figcaption></figure>

**Precedents**: Shows all metrics referenced in the formula of the current metric. Only Formula, Parent, Summary, or Linked metrics can have Precedents.

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FfNLSPH8B41jdKt4jDm3m%2Fimage.png?alt=media&amp;token=d5f0dfc1-b517-43aa-ba16-e0cd5666baf4" alt=""><figcaption></figcaption></figure>

Users can view details such as the sheet name, metric name, data type, formula, and associated fields for each dependent or precedent. An option is also available to open the metric details in a new browser tab for easier navigation.

## Additional Metric details by Metric Type

### **Input**&#x20;

Input metric has four types of details depending on the data type used. The basic input types like Number, Integer, Percentage, Currency etc will have Validation, List will have Allowed Values, Data status will have Allowed values as well as Data Status setting and field will have a slightly different Validation section.

{% tabs %}
{% tab title="Validations" %}

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FOiuPI0Oj7mNaWA8IuWkm%2Fimage.png?alt=media&amp;token=ee3d98c4-62f4-4410-945e-c6ff3900d186" alt=""><figcaption><p>Input Metric Validation</p></figcaption></figure>

This is used to restrict input values within a range, this is done by comparing the input to selected Comparer Type and only those values qualifying the comparer range are allowed. The Comparer Type are : No Validation, Greater than, Less than, Between, Not between, Equal to, Not Equal to, Less than or Equal to, Greater than or Equal to. Validation type will changes according to the metric type. Validation also allows to show custom message to the user when value violates the validation rule.&#x20;
{% endtab %}

{% tab title="List" %}

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FOylyRfOZhJL9NOnXnEuB%2Fimage.png?alt=media&amp;token=64024af9-99fd-4155-9fac-1ab3f3e8f8dc" alt=""><figcaption></figcaption></figure>

The metric detail in List will include an  Allowed Values section that displays all the allowed values and option to create more, delete existing and change their order of appearance.
{% endtab %}

{% tab title="Data Status" %}

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2Fk8TrTuzcxeTmg88vWwtK%2Fimage.png?alt=media&amp;token=0afac808-01c0-42cc-8964-13a91e71b473" alt=""><figcaption></figcaption></figure>

**Allowed Value :** This list displays all the allowed values for Data Status. Any one of these could be set as Default status

**Driver :** Driver is a mandatory field selection based on which the Teams in data protection rule will be based.

**Data Protection Rule :** Specific rules can be created for individual data status member and assigned permission based on the same.

**Rule Description :** This the name of the rule

**Rules :** The rule follows the format Status allows edits by Team, here Status is the allowed value and Team is the user group.

**Applies to :** The rule can be applied to specific metric or an entire functional area

**Restrict Status Change :** This option allows creation of Data Status change from one allowed value to another by specified Team.
{% endtab %}

{% tab title="Field" %}

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FKT5o4rWPOCWyCnWbweEs%2Fimage.png?alt=media&amp;token=c0da91e5-fe9c-431d-8b6f-ab9511d19ff9" alt=""><figcaption></figcaption></figure>

Allowed member can be selected from Validation section, where **Allowed member** is a selection dropdown, **where** is a Property in the field and **Equals To** is a member of the property.
{% endtab %}
{% endtabs %}

### Parent

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2Fz5fNpQPJfpT2yb2oUsIz%2Fimage.png?alt=media&amp;token=d4dfc9f2-7af6-4178-9f26-7ac68a58dd4e" alt=""><figcaption></figcaption></figure>

1. **Layout :** The parent metric contains a layout section where row display the fields included in the metric.&#x20;
2. **Metrics :** Below  layout is the metric section where metrics that are used as input to the current parent metric are displayed in order. Each of these metric needs to be assigned signage based on the parent metric logic. Order of the metric can be modified.

### Formula and Summary

Some additional functionalities are available to the formula and summary metric, as below :&#x20;

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FuKSBTd09zkXXbTLGcXXj%2Fimage.png?alt=media&amp;token=fef484a1-04ff-4a2e-81c5-d461597b6a98" alt=""><figcaption></figcaption></figure>

1. Applies to: To restrict Formula calculation for specific member value. Here user can select fields and member combination to restrict the calculation to specific values.&#x20;
2. Layout: To update Layout required for Calculation using Preference. For each field, we can select member relation from the dropdown.&#x20;
3. Metrics (Input Metrics): To add Input for Calculation. We can import one or more metrics from same and different sheets into a formula metric, each imported metric will appear in the Metrics sections.

## Metric Functions

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2F8GeJlQxxQ7HHAwoipFGL%2Fimage.png?alt=media&amp;token=b8112f17-3dc3-4ba6-8b5c-711b75864794" alt=""><figcaption><p>Metric Functions</p></figcaption></figure>

These function define how input data is treated, they include:

* Sum (Only for Number/Percentage/Integer/Currency) - Get total of source data base on matching condition.
* Max (Only for Number/Percentage/Integer/Currency) - Get maximum value of source data base on matching condition.
* Min (Only for Number/Percentage/Integer/Currency) - Get minimum value of source data base on matching condition.
* Get (Only for Text/Boolean/List(Selection)/Date) - Get exact value of text base on matching condition.
* Lookup (For all Data Type) - Similar to Sum for Number . However Input Metric will act as secondary where data is only derived if data exists in primary metric for same members for fields.&#x20;

On clicking the <img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2F9FGyoLWXLF26vLE28ajv%2Fellipsis.jpg?alt=media&amp;token=459a0bf2-9e87-4276-a92e-5a178761e7f9" alt="" data-size="line"> beside the metric, following operations can be performed on the metric:

<img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2F2oodmFSvBcx7J9eYic0t%2Fsquare-arrow-up.jpg?alt=media&amp;token=c68b4be6-6b41-498a-898f-e2a2b3a0e9b8" alt="" data-size="line"> Move Up : Move metric up in order

<img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FgT3LZyIdBYXFhq1Mw3hd%2Fsquare-arrow-down.jpg?alt=media&amp;token=1b293a57-1684-478d-bf15-3c9017e28369" alt="" data-size="line"> Move Down : Move metric down in order

<img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FRKNs6SwfNaVW9NVQJfXC%2Ftrash.svg?alt=media&amp;token=7997e98c-4f57-4b1a-bc7f-79f25e392363" alt="" data-size="line">Delete : Delete metric&#x20;

## Metric Parameters

Parameters are an additional functionality applicable to linked, formula and summary metric type. The purpose of parameters is to enable and configure field matching when importing metrics with different dimensions. Parameters can also be used to filter values for specific field members, thus imply more control on data. Metric parameters functions can be applied to fields in metrics section.

<figure><img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FfGP6c1JGrfHR9elry4FZ%2Fimage.png?alt=media&amp;token=badcbeac-af85-41b3-9ca5-ccfafd3105bb" alt=""><figcaption></figcaption></figure>

The parameter types and functionality include :&#x20;

**Filter :** Field under Filter will be excluded from matching condition. Hence ,data will be imported only for the filter member selected. This is applicable to Linked, Formula and Summary metric.

**Set :** Field member under set will apply to all field members in current field. Example, if Time is Set to Jan 24 for the input metric, it will apply to all time periods in the output metric, meaning the data from source metric where Time is Jan 24 will now be copied to all Time periods in the current sheet. This is applicable to formula metric only.

**Assign :** If field exist in Output metric but not exist in Input metric, system will automatically populate Assign Function for the same field to member Unassigned. User can always provide additional **Assign** for any field if required. Select member to which user want to apply the value to and refresh. Same value will be applied to all selected members. If there is no Assigned function for field exist in output but not exist in input, system will default assign to member # - Unassigned. User can also Assign member for field exist in both input and output. In this case, value will be total up data base on Filter then assign same value to all target member. This is applicable to Linked, Formula and Summary metric. This is applicable to formula metric only.

**Add :** Add helps generate information/combination of specific field from existing data of other input metric(s). This function is useful in case where you want to do allocation of data from higher level of detail to lower one. Input Metric will need to **Add** detail of specific fields from Driver Metric.

## Custom Metric Data Format

Custom metric data formal will apply to metric by metric data type. This gives user the option to change the data format for metric for each snippet.&#x20;

Additional custom format options available by metric type along with the Standard format are :

| Format               | Metric Type                           |
| -------------------- | ------------------------------------- |
| Shorten (K/M/B)      | Number, Currency and Integer          |
| Custom Decimal Place | Number, Currency, Integer, Percentage |

**Shorten :** This format displays shortened numbers for better readability. For Example, 1,000 becomes **1K,** 1,000,000 becomes **1M,** 1,000,000,000 becomes **1B**

**Custom Decimal Place :** This allows creation of number of places after the decimal.&#x20;

Custom formats can be updated for metrics in sheet / report details by clicking the <img src="https://3809087323-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCZazP0PcAHFLGdNy23%2Fuploads%2FxpkZxAcxLYTn18dWh52e%2Fpen-to-square.jpg?alt=media&amp;token=3121a9c3-5deb-4c39-b146-299040c65355" alt="" data-size="line"> beside Metrics.