CygNet Studio > Using CygNet Studio Tools and Controls > Facility Navigation Bar Tool > Configuring the Facility Navigation Bar Tool

Facility Navigation Bar Tool – Configuring the Facility Navigation Bar Tool

Note: You can change configuration settings for this tool in Run mode. However, these settings usually only persist for the current runtime session. When you close the CygNet Studio screen on which the tool resides, the tool settings may revert to those originally configured in Edit mode. To learn how to override this behavior, see RuntimeCfgAutoPersist.

This topic provides a basic workflow for configuring the Facility Navigation Bar Tool. The way that you configure the tool and your actual data determine exactly how the tool will look and work. While ActiveX properties are required to configure a functional tool, many standard properties are available.

You can use the Facility Navigation Bar Tool to set the [Facility] property of TheView for a templated screen. This allows the selected facility to determine the source of the data displayed on TheView. Set the [AutoRestart] property of the Facility Navigation Bar Tool to 1 - Yes. [AutoRestart] will then restart TheView and set its [Facility] property to match the facility selected in the Facility Navigation Bar Tool.

You can also use the Facility Navigation Bar Tool with a Group Grid Tool. The Facility Navigation Bar Tool then sets the Facility ID for each row in a grid based on a selected attribute. In this case, set [AutoRestart] to 0 - No, since clicking on a row in the Group Grid Tool will set the [Facility] property of TheView.

This topic includes the following sections:

To Configure the Facility Navigation Bar Tool

  1. Using CygNet Studio in Edit mode, click the Facility Navigation Bar Tool icon on the Standard Tools palette, then click on the TheView.
  2. Right-click on the Facility Navigation Bar Tool you added to open its Property Sheet.
  3. Click on the ActiveX tab, then click the button next to (OCXProperties) to display the CygNet Facility Navigation Bar Control Properties dialog box.
  4. If the General page is not displayed, click the General tab in the CygNet Facility Navigation Bar Control Properties dialog box to display the following:

Facility Navigation Bar Control Properties - General tab

  1. Click on the button next to the SiteService field and select a Facility Service (FAC).
  2. Optional: If you want to pre-filter facilities before the facility data is returned to the Facility Navigation Bar Tool, click the button next to the Initial Filter field and go to the Configuring the Initial Filter topic for more information.
  3. If you want to display the target facilities in the Facility Navigation Bar Tool, select Show Target. Target facilities will appear in the last drop-down level.
  4. Note: You usually select Show Target when using the Facility Navigation Bar Tool with a templated screen. If the Facility Navigation Bar is being used with a Group Grid Tool, you do not usually select Show Target.

  5. If you want the drop-down levels to have labels in Run mode, select Visible.
  6. If you want to be able to display facilities that do not have a value for a particular attribute, select Show <Not Specified>. If you select Show <Not Specified>, the Not Specified option appears for the drop-down levels and facilities can be displayed when no attribute value is specified.
  7. If you want to be able to list all facilities that have a particular attribute value, select Show <All>. If you select Show <All>, the All option appears for the drop-down levels and a child level can display all facilities that have the specified attribute value. Otherwise, only facilities with attribute values filtered by parent levels are displayed.
  8. If you want to define attributes unique to the Initial Filter, click Define Filter Attributes. For more information, see Configuring the Initial Filter.
  9. When you finish configuring properties using the General page, click the Levels tab to begin configuring drop-down levels to suit your needs. For details, see Configuring the Drop-Down Levels.
  10. When you finish configuring the Facility Navigation Bar Tool, click Apply and OK. Open the Facility Navigation Bar Tool in Run mode to verify that it is working as expected.

General Page Properties

The following table describes General page properties:

Property Description

SiteService

[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service.

If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.

Initial Filter

Initial Filter defines a subset of facilities. If you are defining multiple levels, the Initial Filter is level 0, the leftmost drop-down level in the Facility Navigation Bar Tool. Additional filtering will begin with the level 0 filter.

Creating an Initial Filter is an optional process. To learn about setting up this additional filter, see To Configure an Initial Filter in the Configuring the Initial Filter topic.

Levels

Select Show Target to display the target level, which is the rightmost level in the Facility Navigation Bar Tool.

Labels

Select Visible to display labels for levels, as specified by the Labels options on the Levels page.

Allow Blank Values

If Allow Blank Values is selected, the Not Specified option appears for the level and facilities can be displayed if no attribute value is specified.

Allow All Values

If Allow All Values is selected, the All option appears for the level and all attribute values available in the child level are displayed. Otherwise, only attribute values filtered by a parent level are displayed.

Define Filter Attributes

Click Define Filter Attributes to define attributes for the Initial Filter.

To learn about setting up this additional filter, see To Define Filter Attributes in the Configuring the Initial Filter topic

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.