workbench-PropertySheet

 The Property Sheet shows all the user visible Properties of the Component. This view also lets you change any Properties that you have authority to change. It can be used on a Component of a running Station or a Component in a Bog File.

In order to see Properties of Components in the PropertySheet, press the + sign to expand the Component.

When you want to enter a URL, you can Copy the Component or URL and Paste it into the PropertySheet using the Paste shortcut Ctrl-V.

When a Property has been changed, its symbol will become red until you press  Save.

PropertySheet Menus

The Workbench main menu functions are available. If you Right-click any Component in the PropertySheet, you can choose from the following:

  • Views - show the view menu for the Component.

  • Actions - Perform any of the Actions on the Component.

  •  Cut Ctrl-X

  •  Copy Ctrl-C

  •  Paste Ctrl-V

  •  Duplicate Ctrl-D

  •  Delete Delete

  •  Rename

  •  Reorder

  •  Config Flags

PropertySheet Toolbar

The Workbench toolbar contains navigation and editing buttons as described in About the toolbar.

Config Flags

 Configure Flags on a component. This is available on Properties. Right-click a Property to view the Config Flags Dialog.

Links

 Links provide the mechanism to dynamically attach Components. They allow you to attach an output Property of one Component to an input Property of another Component. The links are visible in the Property Sheet of the Component. Links show whether they are direct or indirect and their source Property.

In order to view the Properties of the link, Left-click the + plus sign on the Component to expand it.

Each link shows the following:

  • Link Type and source

  • Source Ref - This is the linked Component.

  • Source Slot Name - This is the linked Component's property.

  • Target Slot Name - This is the current Component's property.

  • Enabled - This shows whether the link is currently enabled.

See for more information on creating links.

OrdChooser

In order to select an Ord instead of typing it, you can use one of the Ord editors. They include:

Once you have selected an editor, you can use the button to the right of the selection box. It will present the selected editor.

workbench:FileOrdChooser

In order to select a file Ord instead of typing it, you can use the FileOrdChooser.

You can select FileSpaces, Bookmarks and directories and files. In addition toolbar functions are provided including:

Back

 Back moves back to the previous view.

Uplevel

 Uplevel moves up one level in tree.

Home

 Home moves up one level in tree.

New Folder

 New Folder creates a new Directory.

ListView

ListView allows you to use the list view.

DetailsView

DetailsView allows you to use the details view.

Bookmarks

You can press the  Bookmarks button to add the selection to Bookmarks.

Show/Hide Preview

 Show/Hide Preview toggles whether the preview pane is visible.

workbench:DirectoryOrdChooser

In order to select a Directory Ord instead of typing it, you can use the DirectoryOrdChooser.

You can select FileSpaces, Bookmarks and directories. In addition toolbar functions are provided including:

New Folder

 New Folder creates a new Directory.

Bookmarks

You can press the  Bookmarks button to add the selection to Bookmarks.

workbench:HistoryOrdChooser

In order to select a reference Ord instead of typing it, you can use the HistoryOrdChooser.

You can select items from the tree by type slot or Handle.

workbench:RefChooser

In order to select a reference Ord instead of typing it, you can use the RefChooser.

You can select items from the tree by type slot or Handle.

workbench:BqlQueryBuilder

In order to select a BQL query instead of typing it, you can use the BqlQueryBuilder.

BQL is one Scheme used to Query in the Niagara Framework. An Ord is made up of one or more Queries. A Query includes a Scheme and a body. The bql Scheme has a body with one of the following formats:

  • BQL expression
  • Select projection FROM extent Where predicate

You can create the Ord Qualifier, Select, FROM and Where portions of a Query.

Ord Qualifier

In the left window, you can select an Ord to use as the qualifier. It will immediately be placed in the BQL statement at the top when you select it.

If you select the history Scheme, your options will vary from those shown here.

workbench:ProjectionBuilder

In order to build the projection for a BQL request instead of typing it, you can use the ProjectionBuilder in Bql Builder. You can select an item from the center window to use with the select statement. Press the  right arrow to add each one to the projection.

Bql Expressions"

An expression can be one of the following:

  • field like displayName

  • x.y.z

  • any method that returns non-void and takes zero parameters

After you build the BQL statement, you can remove the "Select" to provide a BQL expression instead of a Select statement.

workbench:ExtentBuilder

An extent can be one or more of the following:

  • "*" all available from the target

  • all property slots

  • all methods that return non-void and take zero parameters

In order to build the Extent for a BQL request instead of typing it, you can use the ExtentBuilder in Bql Builder. You can select the Restrict Type and choose the module and item to use with the FROM clause. It will immediately appear in the BQL statement at the top.

This also changes the items that are available in the projection.

If you choose a history Scheme, the ExtendBuilder will provide different selections. The extent for a History typically can be one of the following:

  • "from /demo/Float" where demo is the station name

  • "from !Float" where "!" signifies the current station

workbench:QualifierBuilder

In order to build the Qualifier for a BQL request, you can type it in the QualifierBuilder in Bql Builder. As you type, it will immediately appear in the BQL statement at the top.

Edit Facets

Edit Facets allows viewing and editing of facets. In order to change facets, you use the button to the right of the facets. It will present the Edit Facets dialog box.

From here you can Add, Remove or select the Enum Range Dialog.

Add

Add allows you to add a Key and Type.

Remove

Remove allows you to remove facets.

Enum Range Dialog

In order to view or set the range of values for a Enum, you can use the . It will present the Enum Range Dialog:

You can enter one of the standard Enumerations in the field under the Use Enum Type in Range (module:name).

Press Use Enum Type in Range (module:name) to use the Enumeration that you entered. In order to enter or change an Enumeration, enter the Ordinal in the field above the Add button. Next enter the new value for the Tag and press Modify. Press OK to complete the dialog.