Selection of the appropriate 'default' Display Mask for data collected/uploaded for Metrics and Reports is initially determined by Metric Insights by analyzing the content of the input data elements rather than requiring you to specify a mask explicitly for every numeric data element.
The default Display Mask for your numeric fields is based on its analysis of various initial settings. This process prevents your being required to choose a mask for each new element. You can change the defaulted Display Mask at anytime from the element's Editor by choosing another mask, either by using the Override Display Mask option on the Metric Editor or in the Format column on the Report Editor, both explained below.
1. General Formatting Rules
In the process that formats numeric Data Columns, default Display Mask values are set as follows:
The following rules are applied to the display of information in a Report, both in its Tables and in the Data Point Mouse-over Display of the Report Viewer as well as axis labels. NOTE: Similar logic is applied to a Metric's Measurement Value:
- If you have set an explicit Display Mask for the column/value, it is utilized.
- If not, the maximum value in result set for a specific column determines the mask: If the minimum value is > 1,000,000, numbers are divided by 1,000,000 and the result is displayed followed by the Millions_display_suffix value stored in your config file (shows as “M” in the template)
The rules that are used to determine the precision of Measurement Value displays on Metric charting are determined the maximum value for the column unless that value is 0, in which case the average column value is used:
- Show any number > 10 but =< 100 with a maximum of 1 decimal point; e.g., 10.23 and 10.21 are shown up rounded as 10.2
- Show any number => 100 without any precision; e.g., Instead of '$123.45K', always show '$123K' since having precision in decimal points when the base number is > 100 is not very meaningful and forces the font to be smaller than it needs to be.
- Show numbers < 10 with at least 1 decimal point of precision (i.e., 8 instead of 8.2). If 2 decimal points can be included, show with decimal points. If it is not possible to display with at least 1 decimal point precision and meet minimum font size requirements, numbers are not displayed above the chart at all (for any bars in the chart). For values less than 10, dispalying at least one decimal point of precision is preferred.
- Display numbers < 5 with at least 2 decimal points of precision; e.g., 3.22. If this can not be done while meeting minimum font size requirements, numbers are not displayed above any bars in the chart.
- If a value is expressed as Millions, show precision only on integer values
- The 'METRIC_DEFAULT_THOUSANDS_DELIMITED' config setting is used as the default for displaying thousands
The table below shows how Integer and Decimal values are displayed:
1.1. Measure Editor Setting
The default currency mask is determined:
- If it is new (first time seen), set based on Show values as Currency setting of the element’s Measure of setting in the Measure Editor
- By analyzing the column’s name: If it exists in other elements, the Prefix is set based on the most common setting
1.2. Display Mask Drop-down List Organization
At the top of the drop-down list are those masks that are applicable based on the Measure Editor's Show Values as Currency (Step 1.1) setting; that is, those that are most likely to be used appear above the line and the less applicable masks are below it:
- If this option is set to 'yes', currency-related display masks are placed above the line with the non-currency masks below it
- If this option is set to 'no', non-currency display masks are shown above the line with the currency-related masks underneath it
- If an element typically contains larger values, choose a mask that aggregates data by thousands or millions in order to enhance readability of a value's display on a tile and in the Full Chart view.
- You can override the default value by choosing another mask, either using the Override Display Mask on the Metric Editor or in the Display Mask column on the Report Editor (both shown in subsequent steps)
2. Metric Editor
1. The Display Format Mask rules are applied the same way for both 'Integer' and 'Decimal' values of a data point. If in the settings in the Metric Editor > Data Collection tab the Data Values field is set to 'Decimal', there are no decimal places shown on either Chart axes or Data Point Mouse-over Display if the following conditions are met:
- There is no Override Display Mask set for the Metric
- The 'Measure' and the 'Dimension' both call for currency
2. In the Metric Editor > Charting tab, you can select an Override Display Mask and choose both a Display Format that includes a currency Prefix
NOTE: If the size of the values collected could make the decimals insignificant, the default mask will not contain decimals
3. Report Editor
The following settings can be specified in the Report Editor > Data Collection tab:
- In the Report Columns grid if you do not change the system-set Format, 'Default' is displayed in this column. Click the corresponding row of the Format column to open a drop-down list allowing you to select any available Display Mask (as shown in the 'units' row).
- You may indicate whether the value in this column should have a currency symbol by checking the box in the Currency? column and selecting any Display Format in the Format columN. NOTE: If you clear the checkbox in the Currency? column, the setting in the Format column automatically automatically becomes 'Default'.
4. Dimension Editor
- On Dimensioned Reports and Metrics, local currency is determined using the Currency Prefix value set for every Dimension Value
- Currency for each Dimension Value can be determined only if in Dimension Editor > Advanced tab, the Include individual currency prefix option is set to 'yes'; otherwise Currency Prefix column is not shown in the grid
NOTE: For more details on setting currency prefixes, see: Set a Currency Prefix for a Dimension Value
4.1. Dimension Data Collections
For Dimensions with Dimension Values that are not entered manually or loaded from csv file, a fetch hint is provided as shown above:
- If an additional column is provided in result set, it is populated with the specified Currency Symbol
- If no symbol is specified for the Dimension Value, the config file entry is used. See Default Name/Description Values for Elements.
- You can modify the populated value when editing a Dimension Value and if so, your setting is changed subsequent to Dimension data collection
- If the returned Result Set has an explicitly specified Currency Symbol that is different from what has been previously entered, it replaces the current entry
- If the fetch does not have a column for the Currency Symbol or returns the existing symbol or no symbol, no change is made in the Dimension Value's Currency Prefix setting