6.5. Configuration Object: Inherit Variables

About this task

(All action types)

Configuration: Variables.

Runtime examples: Variables.

Configuration: Variables

Variables can be entered at any level in the Navigation hierarchy and a selected node can inherit variables from parent nodes.


A	Inherit Variables
B	Variables

Inherit Variables

A selected node can inherit the variables entered for parent nodes in the navigation hierarchy.

Select one of the following in the Inherit variables field in the Configuration Editor right pane for the selected node.


Yes	Inherits variables from parent nodes in the navigation path up through the node that does not allow variables to be inherited.
No	The selected node will not inherit variables from parent nodes. Note: Since the root node has no parents, select No for that node. (Yes is meaningless.)
Default	No

Variables

A node can include variables whose values can be used for that node and inherited by child nodes.

Procedure

Select Variables in the left pane for the selected node.
Do one of the following.
- Click Edit>Add on the Navigation Configuration Editor menu bar.
- Right-click Variables; select Add on the Popup menu.
- Right-click the right pane; select Add or Insert on the Popup menu.
An Add dialog box opens.

Enter the following.


Field	Description
Name	Unique name
Value	A variable value.
Type	A variable is a string type.

Note: :

If you have assigned a value to a selected screen and that value is different from the value in the Navigation Editor, the following will occur based on your configuration.


The Screen	The value assigned at the:
Does not inherit values	Screen level will display.
Does inherit values	Navigation Configuration Editor level will display.

If a child screen can inherit variables from the parent, all of the variable values that are listed in the Navigation Configuration Editor will be applied to all of the same variables on the screen. It is important to make sure that variables that should not be inherited are not listed with variables that should be inherited.

Tip: If the value on the screen must be unique, it is safer to make the variable name unique to that screen. That way there will never be a chance that the value will be inherited.

Runtime: Variables

Configuration: Variables example
Runtime: Variables example

Configuration: Required Variables Example

A project includes one screen to monitor Warehouse activity.

Four Navigation menu nodes will use the same Warehouse.cim screen in an Overlay action.

A WAREHOUSE: EAST node includes the following string variables.


Variable	Value	Type
HORIZONTAL	HORIZONTALE	Point
VERTICAL	VERTICALE	Point
WAREHOUSE	"WAREHOUSE: EAST"	String

Important: Point values are treated as strings.

Three additional nodes include the same variables; the values are different, as follows.


Node	HORIZONTAL	VERTICAL	WAREHOUSE
WAREHOUSE: NORTH	HORIZONTALN	VERTICALN	"WAREHOUSE: NORTH"
WAREHOUSE: SOUTH	HORIZONTALS	VERTICALS	"WAREHOUSE: SOUTH"
WAREHOUSE: WEST	HORIZONTALW	VERTICALW	"WAREHOUSE: WEST"

The WAREHOUSE CimEdit screen includes the same three variables.

Runtime: Variables Example

As each node is selected during runtime, the variable values for that node are passed to the one CimView screen that is used for each node (Warehouse.cim).

Values are passed to the screen for two of the nodes, as follows.

WAREHOUSE: EAST


A	An operator selects WAREHOUSE: EAST on the Navigation tree.
B	The variable values, for the WAREHOUSE: EAST node, are passed to the Warehouse.cim screen.
	Variable	Runtime Value
	WAREHOUSE	WAREHOUSE: EAST
	VERTICALE	0
	HORIZONTALE	238

WAREHOUSE: NORTH


A	An operator selects WAREHOUSE: NORTH on the Navigation tree.
B	The variable values, for the WAREHOUSE: NORTH node, are passed to the Warehouse.cim screen.
	Variable	Runtime Value
	WAREHOUSE	WAREHOUSE: NORTH
	VERTICALN	0
	HORIZONTALN	0