Help -- Caption Expression Window

Caption Expression Window

This window can be accessed from two different locations. If 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. When accessed from the Measure Item Properties window, you can adjust the caption expression for the selected measure item.

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.

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.