The configuration and state of any DashBoard Connect device is represented by a set of parameters. Device parameter data can be edited to change device settings. These parameters appear in the DashBoard Device View as various components and can be dragged into your CustomPanel.
You can also define new local parameters for your CustomPanel, and reference them in scripts. If you want to share these parameters with other CustomPanels or pass information to other Ross products such as XPression, you must create an XML data file and associate it with your CustomPanel.
When you create a CustomPanel, you can opt to automatically create an XML data file to store data for parameters you create in PanelBuilder. Alternatively, you can create a blank self-contained data source panel. For more information about creating a new CustomPanel, see Creating a CustomPanel.
Data sources contain parameter data which can be displayed and/or manipulated in a CustomPanel. A data source can be an XML data file, an openGear configuration file (.ogd), or a device.
Underlying every CustomPanel is a hierarchy of component elements, each of which can be associated with only one data source. Data source scope cascades. If no data source is specified for a given element in the hierarchy it inherits its data source association from its parent element. To view the element hierarchy, enter Edit Mode, double-click an element, and look at the component hierarchy tree in the top left portion of the Edit Component window.
When you associate a CustomPanel with a data source, the parameter library of the data source is inherited by the CustomPanel. If you had components on a CustomPanel before associating the panel with a data source, those original components will now have access to the same data source library as any new ones you add. You can this library to further customize your CustomPanel using OGP tags.
Note: If you do not need to pass information to other CustomPanels or applications such as XPression, and only need status summary information from other openGear devices, you do not need to associate a data source with your CustomPanel.
You can create and modify parameters in the Add/Edit Parameter window. The Add/Edit Parameter window appears when you click the Parameters button on the Edit Mode toolbar.
Figure 1.32 - The Add/Edit Parameter Dialog
The Add/Edit Parameter dialog provides the following information:
1.List of Parameters
Provides a list of parameters, arranged according to the menu structure and assigned OID tags, currently available for the selected CustomPanel component. Parameters can be created by any of the following:
•an associated data source
•tools in the Edit Mode toolbar
•a component dragged from a device in the Tree View of DashBoard
You can select a parameter from the list to display its information in the window and to edit its properties. You can also edit the menu structure.
2.Parameter Information
This area enables you to quickly view and/or modify the properties of a selected parameter.
You can create new parameters using the Add/Edit Parameter dialog. Once saved, the parameters are available to be referenced in scripts and when creating data-backed objects in the CustomPanel.
You can also edit the parameter menu structure. The parameter menu structure only applies to panels that have an external XML data source, and not to panels that have a self-contained data source.
To define a new parameter
1.On the Edit Mode toolbar, click the Parameters button.
The Add/Edit Parameter dialog appears.
2.Click Add New.
3.In the Name box, type a unique name for the parameter. The parameter will be identified in other dialogs using this name, so ensure to create a descriptive name.
4.In the OID box, type an object ID. Each parameter must be identified by a unique object identifier.
Tip: A unique two-byte hexadecimal OID is automatically provided when the Add New button is selected. You can accept this OID or change it. OIDs do not have to be hexadecimal values. They are string data.
5.In the Menu(s) list, select the menu you want the parameter to appear under.
6.Use the Precision field to define the number of digits following the decimal point displayed for printed numbers. It applies mainly to floating point (float) numbers.
7.Specify the storage type for the parameter value using the Type menu. Choose from the following:
•String — Specifies that the parameter value is an alpha-numeric series of characters (can be text or a mix of text and numbers).
•String Array — Specifies that the parameter can contain multiple string values.
•Integer — Specifies that the parameter value is a number without decimal places. Select 16 or 32 bit.
•Integer Array — Specifies that the parameter can contain multiple integer values. Select 16 or 32 bit.
•Float — Specifies that the parameter value is a floating-point number (uses decimals) or a number with an exponent.
•Float Array — Specifies that the parameter can contain multiple float values.
8.Specify additional limitations on the parameter values using the Constraint menu. Note that the available options depends on what you selected in step 7. Choose from the following:
•Unconstrained — Select this option when using a string type. No limitations are applied to the parameter value. For example, a text field parameter where a user can type any word or mix of letters and numbers.
•Range Constraint — Select this option when using an integer or float type. Use this option to stipulate a range of numbers that the user can select from (e.g. minimum and maximum values). For example, use to stipulate a range from 1-10.
•Choice Constraint — Select this option when using a string type to provide a specific list of options to the user.
•Alarm Table — select this to set constraint values for alarm states.
•String Choice (for table widget only) — Select this option when using a string type to provide a specific list of strings from which the user chooses.
•String Key/Value Constraint — Select this option when using a string type to provide a specific list of options to the user. Each option (Name) is associated with a key (Value). The constraint choices are stored as key/value pairs.
9.If you did not select Unconstrained, use the Constraint Value area to define the valid set of values for the parameter:
•For choice constraints, including string choice, do the following once for each valid value:
›In the Value column, click [insert value], type a valid value, and then press Enter.
›In the Name column, type a name for the value.
The name is associated with the parameter value, and appears on labels, etc.
Note: The Name column is available only if the parameter is a numeric type, or the constraint type is String Key/Value Constraint.
•For range constraints:
›In the Minimum box, type the lowest valid value.
›In the Maximum box, type the highest valid value.
›In the Step Size column, type the step size.
For example, if valid values must be evenly divisible by 10, type 10.
›If you plan to use a touch wheel in your panel, select the Loop check box.
•For alarm table constraints, do the following once for each valid value:
›In the Bit box, type the bit value for the constraint value. For example, you may have two options; 1 and 0. You would have one row for each bit state.
The bit must be unique for each constraint value.
›In the Severity box, select a severity level.
›In the String box, type the alarm message you want associated with this constraint value.
10.Specify the graphical display hint for the parameter using the Widget Hint menu. Choose from the following:
•Default — Displays the parameter as defined according the data source.
•Read-only text — Displays the parameter as a status text field that cannot be altered by the user. A border and background is automatically applied to the field.
•Label — Displays the parameter as a text field without a border or background.
•Text Entry — Displays the parameter as a single line text field that is editable by the user. The user must enter one of the values defined using the Constraint Value field.
•Multi-Line Text Entry — Displays the parameter as a text field with more than one line. The user must enter one of the values defined using the Constraint Value field.
•HTML Content — Displays the parameter as a field that requires the user to input HTML data.
•Editable Dropdown List — Displays the parameter as a menu that the user clicks to display an expanded list of values to choose from. These values are determined by the Constraint Value field.
•Alarm-Style Colored Dot — Displays the parameter as a status indicator, similar to an LED, that updates based on conditions defined in the Constraint Value field.
11.In the Initial Value area, specify the initial value for the parameter. If the parameter is an array, you can specify multiple values.
12.Click Commit Changes to save your new parameter.
13.Click Done to exit the dialog.
To edit the parameter menu structure
1.On the Edit Mode toolbar, click the Parameters button.
The Add/Edit Parameter dialog appears.
2.Click Edit Menu Structure.
The Add/Edit Menus dialog appears.
3.In the list on the left, click the folder under which you want the new menu to appear (Status or Config).
4.In the Menu Name box, type a name for the menu.
5.Click Insert Menu.
6.If you want to delete a menu, click it in the list on the left, and then click Delete Menu.
7.When you are satisfied with the menu structure, click Save Menu.
8.Click Done.
Associating a Data Source with a CustomPanel
You can associate a specific data source, such as an openGear card or other DashBoard Connect devices, or a saved configuration file (*.ogd) with a CustomPanel. Doing so enables you to use that data source as a library of parameters which you can then manipulate. Additional tools in the CustomPanel’s Edit Mode toolbar enable you to quickly select components based on a specific device. Which components are available depends on the specific device you have selected. For example, the components of an UDC-8625A-B differ from those of an XPression™ Real-time Motion Graphics System. We highly recommended you become familiar with the device(s) before using this PanelBuilder feature.
Associating a Data File with a CustomPanel
Associating a saved configuration file (*.ogd) enables you to use the parameters saved in that file as a type of library for the CustomPanel. Once you have successfully associated a data file to the CustomPanel, the Edit Mode toolbar automatically updates to display the new tool options. You can also use a data file as a base for creating an interface in DashBoard that auto-populates fields in a Ross XPression system, or to familiarize yourself with PanelBuilder features without directly impacting a device.
To associate a data file with a CustomPanel
1.Select from the Edit Mode toolbar.
2.Double-click the CustomPanel area. The border displays the Edit Component: <abs> dialog when the mouse button is released.
3.Select the Abs Attributes tab.
4.In the Device Control area, select the openGear check box.
5.Click configure to display the Select Device for Context dialog.
6.Click Select a file.
7.Click Browse... to display the Select Device Data Source dialog.
8.Navigate to the required *.ogd file.
9.Click Select Device Data Source to close the dialog and update the File field.
10.Click OK.
11.Click Apply Changes or Apply and Close.