Help -- Caption Expression Window For Measure Items

Caption Expression Window For Measure Items

The Caption Expression window for controlling captions of measure items varies in its look depending on your purpose for using it and where it was accessed from. Click the description below that pertains to your use of the window.

Setting up a caption for a regular measure item in your view.
Setting up a caption for a calculated measure item in your view.
Setting up the default caption format for any type of measure item. This default format is controlled by administrators in the Application Settings window.

Captions For Regular Measure Items

Here’s an example of the Caption Expression window when you are working with a regular measure item. Descriptions of the key parts of the window follow this image.

Variables – You can click these variables to use them in your expression.

Regular Measure Item with Time Range – Valid variables when Time Range = “Yes.”

Variable Name	Description
Name	Resolves to the name of the measure item.
Category	Resolves to the category of the selected measure for the measure item.
Measure	Resolves to the name of the selected measure for the measure item.
From Period Short Desc	Resolves to the Stratum.Planner ViewSetItem short description associated with the From Period of the Measure Item. If the From Period uses a based time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
From Period Long Desc	Resolves to the Stratum.Planner ViewSetItem long description associated with the From Period of the Measure Item. If the From Period uses a based time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
From Year YY	Resolves to the last 2 positions of “Year” from the ViewSetItem in Stratum.Planner associated with the From Year of the Measure Item. If the From Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
From Year YYYY	Resolves to the “Year” from the ViewSetItem in Stratum.Planner associated with the From Year of the Measure Item. If the From Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
From Year Long Desc	Resolves to the Long Description from the Year ViewSetItem in Stratum.Planner associated with the From Year of the Measure Item. If the From Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Period Short Desc	Resolves to the Stratum.Planner ViewSetItem short description associated with the To Period of the Measure Item. If the To Period uses a based time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Period Long Desc	Resolves to the Stratum.Planner ViewSetItem long description associated with the To Period of the Measure Item. If the To Period uses a based time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Year YY	Resolves to the last 2 positions of “Year” from the ViewSetItem in Stratum.Planner associated with the To Year of the Measure Item. If the To Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Year YYYY	Resolves to the “Year” from the ViewSetItem in Stratum.Planner associated with the To Year of the Measure Item. If the To Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Year Long Desc	Resolves to the Long Description from the Year ViewSetItem in Stratum.Planner associated with the To Year of the Measure Item. If the To Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
Conditional Format Name	Resolves to the name of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.
Conditional Format Description	Resolves to the description of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.

Regular Measure Item without Time Range – Valid variables when Time Range = “No.”

Name	The name of the measure item.
Category	The category of the selected measure for the measure item.
Measure	The name of the selected measure for the measure item.
Conditional Format Name	Resolves to the name of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.
Conditional Format Description	Resolves to the description of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.

Expression – Define or modify the expression by clicking on a variable. The selected variable will display under the Expression on the right side of the window. Also, you can manually enter static text in the Expression portion of the window. The Enter key inserts a new line within the caption. This gives you more control over how the caption will display.

Caption – Displays the evaluated caption so you can verify what the caption will look like. This area is updated when Evaluate is clicked.

Evaluate – The caption will display under the Caption area once Evaluate is clicked. You can review the caption before accepting it.

OK / Cancel – Click OK to apply the caption you’ve set up or click Cancel to discard the caption expression.

Help – Click Help to access tips for working with this window.

Captions For Calculated Measure Items

Here’s an example of the Caption Expression window when you are working with a calculated measure item. Descriptions of the key parts of the window follow this image.

Variables – You can click these variables to use them in your expression. Valid variables for calculated and distinct calculated measure items are listed below.

Name	The name of the measure item.
Conditional Format Name	Resolves to the name of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.
Conditional Format Description	Resolves to the description of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.

Measure Items – This folder displays all other measure items that exist in the view, regular or calculated. Any variables for one of those measure items can be used to build the caption for the calculated measure item. Example variables available for measure items are the Caption, Name, Category, Measure, Conditional Format Name and Description, and time properties if the measure item has time ranges.

Caption – Displays the evaluated caption so you can verify what the caption will look like. This area is updated when Evaluate is clicked.

Evaluate – The caption will display under the Caption area once Evaluate is clicked. You can review the caption before accepting it.

OK / Cancel – Click OK to apply the caption you’ve set up or click Cancel to discard the caption expression.

Help – Click Help to access tips for working with this window.

Default Caption Formats

If the Caption Expression window is accessed from the Application window, you can set the default caption expressions that Stratum.Viewer will apply whenever a user adds a new measure item to a view. Defaults can be specified for regular measure items (those with ranges and those without time ranges) and calculated measure items.

Variables – You can click these variables to use them in your expression.

Regular Measure Item with Time Range – Valid variables when Time Range = “Yes.”

Variable Name	Description
Name	Resolves to the name of the measure item.
Category	Resolves to the category of the selected measure for the measure item.
Measure	Resolves to the name of the selected measure for the measure item.
From Period Short Desc	Resolves to the Stratum.Planner ViewSetItem short description associated with the From Period of the Measure Item. If the From Period uses a based time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
From Period Long Desc	Resolves to the Stratum.Planner ViewSetItem long description associated with the From Period of the Measure Item. If the From Period uses a based time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
From Year YY	Resolves to the last 2 positions of “Year” from the ViewSetItem in Stratum.Planner associated with the From Year of the Measure Item. If the From Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
From Year YYYY	Resolves to the “Year” from the ViewSetItem in Stratum.Planner associated with the From Year of the Measure Item. If the From Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
From Year Long Desc	Resolves to the Long Description from the Year ViewSetItem in Stratum.Planner associated with the From Year of the Measure Item. If the From Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Period Short Desc	Resolves to the Stratum.Planner ViewSetItem short description associated with the To Period of the Measure Item. If the To Period uses a based time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Period Long Desc	Resolves to the Stratum.Planner ViewSetItem long description associated with the To Period of the Measure Item. If the To Period uses a based time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Year YY	Resolves to the last 2 positions of “Year” from the ViewSetItem in Stratum.Planner associated with the To Year of the Measure Item. If the To Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Year YYYY	Resolves to the “Year” from the ViewSetItem in Stratum.Planner associated with the To Year of the Measure Item. If the To Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
To Year Long Desc	Resolves to the Long Description from the Year ViewSetItem in Stratum.Planner associated with the To Year of the Measure Item. If the To Year uses a based hierarchy, the corresponding absolute time hierarchy, then resolves to the ViewSetItem of the associated absolute time hierarchy.
Conditional Format Name	Resolves to the name of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.
Conditional Format Description	Resolves to the description of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.

Regular Measure Item without Time Range – Valid variables when Time Range = “No.”

Name	The name of the measure item.
Category	The category of the selected measure for the measure item.
Measure	The name of the selected measure for the measure item.
Conditional Format Name	Resolves to the name of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.
Conditional Format Description	Resolves to the description of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.

Calculated Measure Item – Valid variable for calculated and distinct calculated measure items.

Name	The name of the measure item.
Conditional Format Name	Resolves to the name of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.
Conditional Format Description	Resolves to the description of a condition format that has been applied to the measure item. If this variable is used and no conditional format has been applied, a blank space holder will display in the resolved expression for the measure item.

Caption – Displays the evaluated caption so you can verify what the caption will look like. This area is updated when Evaluate is clicked.

Evaluate – The caption will display under the Caption area once Evaluate is clicked. You can review the caption before accepting it.

OK / Cancel – Click OK to apply the default caption format you’ve set up or click Cancel to discard the caption expression.

Help – Click Help to access tips for working with this window.