Situational Awareness Projects > Customize a Project > Use Navigational Genies on Content Pages

Use Navigational Genies on Content Pages

The SA_Include project contains a set of navigational Genies that you can use to direct an operator through a production process that spans multiple graphics pages. The Genies indicate the direction of a link, and include a label that describes the consecutive location. Clicking on the Genie at runtime will take you directly to the linked page (except where a Static Link Genie has been used).

The following navigational Genies are included in the "sa_navigation" library:

ClosedLink Left/Right

The left and right navigational Genies can be used to link pages that are a part of a linear process.

The link is defined using the path to a menu item in the project’s Navigation menu. For example, "Plant1.Area1.MyPage".

You can also specify that a left/right Genie links to a location that is on a different "console". This means the destination page is part of a process that is not usually monitored by the current client. For example, a link in a production area of a plant may point to a destination in the warehouse. The operator will be able to view the page, but will have restricted access to it.

To indicate that a link points to a different console, the Genie will appear with a gray background.

You can also use a left/right Genie as a control link. This allows you to associate a piece of equipment with the Genie; the Genie will only appear when their associated object is in context.

The navigational Genies will display a purple drop-shadow when configured as a control link.

Note: Control Links can be enabled or disabled by selecting Options | Show/Hide Control Links on the Header Bar.

ClosedLink Up/Down

The up and down navigational Genies can be used to link to pages that are on a different level of a project's menu.

The link is defined using the path to a menu item in the project’s navigation menu. For example, an up Genie could point to "Plant1", and a down Genie "Plant1.Area1.MyPage".

ClosedStatic Links

The static link Genies function primarily as a label; they are not designed to provide a direct link to a destination.

You can also specify that a static link identifies a location that is on a different console.

To add a navigational Genie to a page:

  1. Open a page in Graphics Builder.
  2. Click the Paste Genie button in the objects toolbox.

    3. Or, select Paste Genie from the Edit menu.

  3. In the Paste Genie dialog, select the Library "sa_navigation".
  4. Select one of the following from the Genie list and click OK.

    5. The Genie is pasted onto the graphics page. A dialog will open, prompting you to configure the properties of the Genie. For a description of the properties, see below.

  5. Click Save.
ClosedLink Left & Link Right

Field

Description

Menu Item

The path to the linked item in the project's Menu Configuration. This is specified using the following notation:

<Level1>.<Level2>.<Level3>.<Level4>.<Level5>.<Level6>

For example, "Plant1.Area1.MyPage"

The menu item needs to be included under the "Navigation" menu (defined in the Page field). As "Navigation" is assumed as the top level of the path, there is no need to enter it at the start of the menu item path.

Tooltip

An optional description of the Genie that appears when the mouse points at it.

Use for 4K Page?

Determines if the Genie will appear on a page that displays within a UHD4K workspace.

TRUE = The Genie will appear in a UHD4K workspace.

FALSE = The Genie will not appear in a UHD4K workspace.

Links to another console?

Enables a Genie to link to a destination is on a different console, which is a destination that is not usually monitored by the current client.

TRUE = The link is on a different console.

FALSE = The link is not on a different console.

If set to TRUE, the Genie will display a gray background.

Use as Control Link?

Determines if the Genie will function as a control link.

TRUE = The Genie will use a control link.

FALSE = The Genie will not use a control link.

If set to TRUE, the Genie will display a purple drop-shadow.

Control Signal Equipment

The piece of equipment that is associated with the left/right Genie. The Genie will only appear when their associated object is selected.

Controlled Equipment

The piece of equipment that the Control Link points to. When you click on the Genie, the page associated with the piece of equipment will display.

ClosedLink Up & Link Down

Field

Description

Menu Item

The path to the linked item in the project's Menu Configuration. This is specified using the following notation:

<Level1>.<Level2>.<Level3>.<Level4>.<Level5>.<Level6>

For example, "Plant1.Area1.MyPage"

The menu item needs to be included under the "Navigation" menu (defined in the Page field). As "Navigation" is assumed as the top level of the path, there is no need to enter it at the start of the menu item path.

Tooltip

An optional description of the Genie that appears when the mouse points at it.

Use for 4K Page?

Determines if the Genie will appear on a page that displays within a UHD_4K workspace.

TRUE = The Genie will appear in a UHD4K workspace.

FALSE = The Genie will not appear in a UHD4K workspace.

ClosedStatic Link Left & Static Link Right

Field

Description

Label

The label that will appear on the Genie.

Tooltip

An optional description of the Genie that appears when the mouse points at it.

Use for 4K Page?

Determines if the Genie will appear on a page that displays within a UHD_4K workspace.

TRUE = The Genie will appear in a UHD4K workspace.

FALSE = The Genie will not appear in a UHD4K workspace.

Links to another console?

Enables a Genie to link to a destination is on a different console, which is a destination that is not usually monitored by the current client.

TRUE = The link is on a different console.

FALSE = The link is not on a different console.

If set to TRUE, the Genie will display a gray background.

See Also

Prepare the Navigation Menu

Published June 2018