workbench-PropertySheet

The property sheet views display all of the user visible properties of the selected component. You can change any properties that you have permissions to change. The property sheet views apply to a component of a running station or a component in a bog file. To see properties of components in a PropertySheet, expand each component.

There are two types of Property Sheet views:
  • Property Sheet view

    An HTML5 property sheet view, shown here, which provides functionality such as interactive field editors and action commands, graphical web gauge display for points, and slot sheet details. Property changes that you make in this view are saved automatically.

  • AX Property Sheet view

    The default property sheet view for the Niagara 4 releases.

    In the AX Property Sheet view, if you want to enter a URL, copy the value and paste it into the property sheet. When you change any property, its symbol will become red until you click Save.

AX Property Sheet Menus

The Workbench main menu functions are available. If you right-click any component in the AX Property Sheet, you can choose from the following:

ItemDescription
Views
Opens the views for the selected component
Actions
Provide one or more actions to perform on the component.
New
Creates a standard item, such as a folder, text block, NumericWritable, etc.
Edit Tags
Opens the Edit Tags window, permitting you to add or remove tags on a component.
Make Template
Creates a template from the selected root component, collects all associated Px and graphic files, and invokes the Template view, allowing you to configure the template for deployment.
Cut
Copies to clipboard and after pasting the copy, deletes the cut item.
Copy
Copies the selected item to clipboard where it remains.
Paste
Pastes the copied item from the clipboard into the current cursor location.
Duplicate
Makes a copy in the same location as the selected item.
Delete
Removes the selected item.
Find
Opens the Component Finder window so you can search for a component.
Link Mark
Sets up a selected component in your popup menu, making it temporarily available for linking-from or linking-to other points.
Link From
Links to a selected component from another component that has been marked, using Link Mark from the popup menu.
Link To
Links from a selected component to another component that has been marked, using Link Mark from the popup menu.
Relation Mark
Sets up a selected component in your popup menu, making it temporarily available for relating-from or relating-to other points.
Relate From
Adds a relation from a selected component to another component that has been marked using Relation Mark from the popup menu.
Relate To
Adds a relation to a selected component from another component that has been marked using Relation Mark from the popup menu.
Rename
Opens the Rename window for changing the slot name of the selected component as it appears in the ORD. You can only rename one component at a time.
Set Display Name
Creates a display name for the selected component as it appears in a Nav tree, Wire Sheet, and Property Sheet views.
Reorder
Opens the Reorder Points window, which provides the following commands for reordering points within the selected parent component:

Move Up moves the item higher in the list.

Move Down moves the item lower in the list.

Sort by Name sorts the list by name.

Sort by Type sorts the list by type of component.

Reset returns the list to its default setting.

Composite
Opens the Composite Editor window, which manages the visible slots.
Export
Exports a selected component in the oBix .xml format.
Config Flags
Assigns or removed a permissions flag on a component. This is available on properties in the AX Property Sheet view. Right-click a property to open the Config Flags window.

Property Sheet Toolbar

The Workbench toolbar contains navigation and editing buttons.

IconDescription
BackHyperlinks back to last displayed URL.
ForwardHyperlinks forward to the URL selected by the Back command.
Up LevelJumps to the parent of current page.
Side BarsDisplays the Side Bars list.
Recent OrdsDisplays a recent ORDs list.
HomeJumps to the home URL (Workbench splash screen).
RefreshRefreshes the current page.
Refresh TabsRefreshes all open tabs.
Session InfoProvides information on the current connection.
OpenDisplays the Open list.
Save( Ctrl + S)Saves the changes to the current component.
Save BogSaves changes to the bog file.
Bog File ProtectionEnters, changes, or adds a bog file passphrase.
ExportExports the current view or object.
Cut (Ctrl + X)Cuts the selected item and places it on the clipboard.
Copy (Ctrl + C)Copies the selected item and places it on the clipboard.
Paste (Ctrl + V)Pastes the items on the clipboard into the current location.
Duplicate (Ctrl + D)Copies and pastes to duplicate the item.
DeleteDeletes the current selection.
Undo (Ctrl + Z)Reverses the previous command/action.
Redo (Ctrl + Alt + Z)Restores a command/action after the Undo command removed it.

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

To build the projection for a BQL request instead of typing it, 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.

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

To build the Qualifier for a BQL request, type the request in the QualifierBuilder of the Bql Builder. The text you type immediately appears in the BQL statement at the top.

Edit Facets

Edit Facets allows for the viewing and editing of facets. To change facets, use the button to the right of the facets. It opens the Edit Facets window.

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

Add

Add adds a Key and Type.

Remove

Remove deletes facets.

Enum Range window

To view or set the range of values for a Enum, use the button. It opens the Enum Range window.

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

Click the Use Enum Type in Range (module:name) to use the Enumeration that you entered. 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 click Modify. ClickOK to complete the procedure.