Configuring Signal-Related Data Groups

The BSAP EIE offers the ability to add data groups on an ad hoc basis to a device instance without configuring them first in the device template file. This functionality is handled through the "Configurable Data Group" (cfgBSAP) data group. Any number of device-level data groups can be added. This task is simplified if you have loaded one or more ACCOL Load Files into the device. Otherwise, the edit mode will be limited.

Three signal-related data group types can be configured using the "Configurable Data Group" (cfgBSAP) data group.

• List — used to process a predefined list of signals and can be configured with the ACCOL load file on the device. Identified by dgStruct="List", and requires either a dgStructNum or one or more dgStructNum_ord<Ord> attributes to be present.
• Search — enables signal retrieval based on filter criteria. Available only for EGM 3530 and Teleflow models. Identified by dgStruct="Search". See Configuring Search Data Groups.
• Signal — a list of signals from the device. A signal represents a data element along with its fields (listed in columns). Identified by dgStruct="Signal".

For more information about these and other data groups, see Data Groups.

See the following subsections below for more information:

• Signal Column Definition
• Signal Column Attributes
• Columns XML
• Column Names
• Signal Item Definition
• Signal Item Attributes
• Data Group XML Element Formats

To Configure a Signal-Related Configurable Data Group

1. Using CygNet Explorer, in the DDS pane, open the remote device to which you want to add a "Configurable Data Group".
2. In the remote device Properties editor, select the Data Group page and click Add.
3. Select Configurable Data Group from the list and click OK.
4. In the Data Group Properties dialog box, configure the data group’s description, facility, etc.
5. Click Configure. The Configurable Data Group Definition dialog box displayed is the first screen of a wizard that steps through the process of defining the data group.

Click the thumbnail to see a Configurable Data Group Definition

6. Configure the following general properties for the data group, then click Continue. For List data group types, be sure to define the source of the list (from the ACCOL file) in the Ordinal-Structure Number field.

Property	Description
Type	The field pre-populates with the cfgBSAP data group.
Nice name	The field pre-populates with Configurable Data Group and cannot be changed.
Ordinal	Ordinal pre-populates based on the sequence in which the data group is being added.
Bsap type	The data group type.
Ordinal-Structure number	For List data group types, defines the source of the list in the Ordinal-Structure Number field.
I/O abilities	Check to enable the data group read/write options: Can receive — Read-only Can send — Write-only Can receive and Can send — Read/write (check both ) Can UCC send — Data group can be sent as part of a UIS command. Can UCC receive — Data group can be received as part of a UIS command.
UDC processing	Default UDC — the name of the UDC category used by default when mapping UDCs to data group elements. Default is "~UDCALL". UDC follows facility — when selected, the UDC mapping follows the facility assigned to the data group.
Security	Default security level — The security level for the data group. Level 4 is the default.

7. The Signal Column Definition dialog box provides a method to add columns to the data group (see Columns).

1. Use the < and > navigation buttons to move items (Ctrl+Click to select multiple) between the Available columns and Selected columns lists. Use the Up and Down buttons to reorder the list.
2. Define attributes for an individual column by double-clicking the column name in the Selected columns list. The Signal Column Attributes dialog box opens.
3. To define attributes for a group of columns, use the Setup default attributes button, define the attributes, and click OK. Then select the desired column names in the Selected columns list, click Apply default attributes, and click Yes to apply.
4. To add a derived column, select a column name to reference, click Add ref col, enter a name in the New Column Name field and click OK. Attributes can be configured for derived columns as usual.
5. Click Continue.

8. Use the Signal Item Definition dialog box to select the signals (items) to include in the data group. All available signal names are included in this list.

1. Use the < and > navigation buttons to move individual items (Ctrl+Click to select multiple) between the Available items and Defined items lists. To select all items, click the << or >> navigation buttons. Use the Up and Down buttons to reorder the list.
2. Define attributes for an individual item by double-clicking the item name in the Defined items list. A dialog box opens, which provides configuration options for Signal Item Attributes. These attributes are defined in data elements. After defining the attributes, click OK in the dialog box.
3. To define attributes for a group of items, use the Setup default attributes button, define the attributes, and click OK. Then select the desired items in the Defined items list, click Apply default attributes, and click Yes to apply.
4. To add an item that references another item’s column value (see Format 2 in Data Group Element Formats), select the item to reference, click Add column item, select the Column Id to reference, then click OK. Attributes can be configured for the added item as usual.
5. To add items based on columns, select the item, and click Add items based on columns.

9. Click OK in the Signal Item Definition dialog box to finish the data definition. After creating the definition, the Modify Configurable Data Group dialog box is used to access the individual screens of the wizard. This includes an XML view button that shows an XML representation of the data group as currently defined in the device template file format. Changes can be made directly to the XML file.
10. Click Finished to save the data group.

Modify Device Specific Data Group Dialog Box

Signal Column Definition

The Signal Column Definition dialog box defines the columns of data to be included in List, Search, and Signal data group types. The order in which they are listed in the Selected columns field are the order in which they are displayed, left to right, in the data group's View Data dialog box.

If you want to map a UDC for a value, you must add the Value column to the selected list. By default, a UDC is mapped to the Value column. You can map to other columns by using a Column Item. Refer to the Signal Item Definition section for more information on adding column items.

Click the thumbnail to see the Signal Column Definition Dialog Box

Property	Description
Available columns	The data elements available for display. The list is derived from the BSAP protocol. Whether or not an item has a value may be dependent upon the configuration of the device.
Selected columns	The data elements that have been selected for display.
Setup default attributes	Provides a method to define default display attributes for columns in the Signal Column Attributes dialog box.
Apply default attributes	Applies the default attributes defined in the Signal Column Attributes dialog box to all selected columns. Note: Default attributes take precedence over attributes defined for a particular column. As such, you should edit/apply the default attributes for all columns before configuring attributes for an individual column.
Add ref col	Allows the creation of additional columns that derive their value from one of the underlying columns (Format 2 in Data Group Elements). Valid characters (maximum of 10 characters) are A-Z, 0-9, dash (-), and underscore (_). Cannot contain spaces and must start with an alpha character.

Signal Column Attributes

The Signal Column Attribute dialog box defines attributes specific to the selected column. Additionally, you can define and apply default display attributes to selected columns.

Signal Column Attributes Dialog Box

Attribute	Description
Column name	The field pre-populates with the name of the column and cannot be edited.
Column description	The field pre-populates with the description of the column and cannot be edited.
Column label	A label for the column in the data group's View Data dialog box. If blank, the Column name is used.
Reference column Id	The name of the source column if the column is a reference column. Although not enforced, it is expected that derived columns refer to either the Value column or one of the bit columns (ME, CE, AE, or OKData). If the data group supports write operations, it is required that one of the derived columns be write-enabled.
Auto-add data rows	When you add a signal it will auto-add that column as a separate DEID using the column-row syntax.
Display attributes
Hidden	If set, the column is hidden in the data group's View Data dialog box by default. You can toggle display of the column using the Show all option.
Enum value mapping on	If set, the displayed value (Val) will be converted to a string enumeration using the true/false values derived from the SLog column. To enable this feature, the SLog column must be included in the column list. Applies only to Logical, ME, CE, AE, and OKData columns.
No automatic column fill-in	By default, columns specified in the columns section, but not mapped to a particular row and column, are retrieved, displayed, and updated, but are not available for point mapping and cannot be used in an update UIS command. Setting this option suppresses this behavior.
No display	If set, blocks display of the column in the data group's View Data dialog box. This attribute is commonly used for columns that serve as metadata only, such as SDesc and SLog.
No send	If set, blocks updates for a given column. The only columns to which this applies are Val, and the Inhibit/Enable and Quality bit fields (ME, CE, AE, and OKData). Cannot be used to enable updates for any other column.

Columns XML

A column represents a field to retrieve and display for all signals in a data group. Column specifications are placed before the dgElements element in the device template file.

<DataGroup ... <Columns> <ColumnName [attributes] /> ... </Columns> <dgElements ...

Column Names

The table below lists the columns that can be added to a signal-related data group.

Column name	Column description	Description
deid	Data Group Element	Identifies the data in the row. Column must be present for proper operation of signal dialog boxes. If not explicitly specified, it will be added automatically as the first column. It may be moved to a different position relative to the other columns if it is explicitly specified. It may not be marked as "Hidden" or "No Display".
desc	Template Description	This column creates space in the column list for a data element ID (DEID) description. If an individual DEID does not have a description and the description column is specified, the column will be filled in from the description returned from the RTU.
Type	Type	Type and Inhibit byte
Val	Value	Value
Units	Units	Units/logical text
Addr	MSD Address	MSD address
Name	Name	Signal name
AAlmStat	Analog Alarm Status	Analog alarm status
LAlmStat	Logical Alarm Status	Logical alarm status
SDesc	Signal Description	Descriptor text
SLog	Logical ON/OFF text	Logical ON/OFF text. The display text ("on/off," "true/false," etc.) for logical bits as defined per data item — usually set to "No Display" or "Hidden". See the Enum value mapping on attribute.
Prot	Protection	Protection byte
AAlmPri	Analog Alarm Priority	Analog alarm priority
LAlmPri	Logical Alarm Priority	Logical alarm priority
Base	BaseName	Base name
Ext	Extension	Extension
Attr	Attribute	Attribute
LaAddr	Low Alarm MSD Address	Low alarm deadband MSD address
HaAddr	High Alarm MSD Address	High alarm deadband MSD address
Ver	MSD Version	MSD version number
LalAddr	Low Alarm Limit Address	Low alarm limit MSD address
HalAddr	High Alarm Limit Address	High alarm limit MSD address
XLalAddr	Extreme Low Alarm Limit Address	Extreme low alarm limit MSD address
XHalAddr	Extreme High Alarm Limit Address	Extreme high alarm limit MSD address
SigErr	Signal Error	Signal error
LARptState	Logical Alarm Report State	Logical alarm report state
LAAckState	Logical Alarm Ack State	Logical alarm Ack state
LAState	Logical Alarm State	Logical alarm state
LATimeOk	Logical Alarm Time State	Logical alarm time state
AALRptState	Analog Low Alarm Report State	Analog low alarm report state
AALAckState	Analog Low Alarm Ack State	Analog low alarm Ack state
AALState	Analog Low Alarm State	Analog low alarm state
AAHRptState	Analog High Alarm Report State	Analog high alarm report state
AAHackState	Analog High Alarm Ack State	Analog high alarm Ack state
AAHState	Analog High Alarm State	Analog high alarm state
AAXLRptState	Analog ExLow Alarm Report State	Analog ExLow alarm report state
AAXLAckState	Analog ExLow Alarm Ack State	Analog ExLow alarm Ack state
AAXLState	Analog ExLow Alarm State	Analog ExLow alarm state
AAXHRptState	Analog ExHigh Alarm Report State	Analog ExHigh alarm report state
AAXHAckState	Analog ExHigh Alarm Ack State	Analog ExHigh alarm Ack state
AXHState	Analog ExHigh Alarm State	Analog ExHigh alarm state
LAType	Logical Alarm Type	Logical alarm type
LAPri	Logical Alarm Priority	Logical alarm priority
AALPri	Analog Low Alarm Priority	Analog low alarm priority
AAHPri	Analog High Alarm Priority	Analog high alarm priority
AAXLPri	Analog ExLow Alarm Priority	Analog ExLow alarm priority
AAXHPri	Analog ExHigh Alarm Priority	Analog ExHigh alarm priority
Columns added to Breakout Bits from the Type and Inhibit byte
DataType	Data Type	Breakout bits from Type 00 = logical 10 = analog 11 = string
AlrmSig	Alarm Signal	Alarm Signal/Not Alarm Signal
DynSig	Dynamic Signal	Dynamic Signal/Constant Signal
ME	Manual Enabled	Manual Inhibit/Enable
CE	Control Enabled	Control Inhibit/Enable
AE	Alarm Enabled	Alarm Inhibit/Enable
OKData	Data Quality	Data Quality bit

Signal Item Definition

The Signal Item Definition dialog box defines the data group elements for the "Configurable Data Group" (cfgBSAP) data group. You can select any items from the ACCOL file for the data group’s type and structure(s). For example, if the data group represents a specific list, you can add any of the elements from that list. If the data group represents three lists, you can add any element from any of the three lists.

The elements are listed top to bottom in the data group's View Data dialog box in the order in which they are listed in the Defined items field of the Signal Item Definition dialog box.

Click the thumbnail to see the Signal Item Definition Dialog Box

Property	Description
Available items	Items available in the ACCOL file for the type and structure(s) defined for the data group. Type and structure are defined in the Data Group Properties dialog box.
Defined items	The data group elements that have been selected for display.
Setup default attributes	Opens a dialog box that provides a method to define default display attributes for the data elements.
Apply default attributes	Applies the defined default attributes to all selected items. Note: Default attributes take precedence over attributes defined for a particular element. As such, you should edit/apply the default attributes for all elements before configuring attributes for an individual element.
Add column item	Allows the creation of an additional column item for mapping. By default, only the value can be mapped.
Add items based on columns	Used to map UDCs for point processing.

Signal Item Attributes

For each selected element, you can define attributes specific to that element by double-clicking it and configuring the options described below. You can also define and apply default display attributes to selected elements. The Source, Signal name, Row, and Column fields cannot be edited.

Signal Item Attributes Dialog Box

Attribute	Description
Data element ID	The data element ID. Valid characters (maximum of 10 characters) are A-Z, 0-9, dash (-), and underscore (_). Cannot contain spaces and must start with an alpha character.
Item description	Description of the element.
Display attributes
Hidden	If set, the column is hidden in the data group's View Data dialog box by default. You can toggle display of the column using the Show all option.
Enum value mapping	If set, the displayed value (Val) will be converted to a string enumeration using the true/false values derived from the SLog column. To enable this feature, the SLog column must be included in the column list. Applies only to Logical, ME, CE, AE, and OKData columns.
No send	If set, blocks updates for a given column. The only columns to which this applies are Value (Val), and the Inhibit/Enable and Quality bit fields (ME, CE, AE, and OKData). Cannot be used to enable updates for other columns.
No send row	Allows write operations to be blocked on a per row basis.

Data Group XML Element Formats

Data items can be defined in one of two formats.

Format 1:

<deid desc=description src=source />

Format 1 is used for typical data items, where source is replaced with the source specifier for the data item. For List type data groups, this is the numerical ordinal number of the item in the list. For Signal type data groups, this is either the fully qualified signal name or the MSD address of the signal. Any UDC mapping for a data item in this format will point to its Value (Val) column by default.

Format 2:

<deid desc=description row=row col=col />

Format 2 is designed to point to a specific column of a data item defined in Format 1. Here, row is replaced with the name (DEID) of the row, and col is replaced with the name of the column. This format allows UDC mapping to data item attributes other than the value column.

The following true/false attributes can be added to a data item, and when used at the Data Group Element level will override the corresponding elements at the column level:

• Enum value mapping on
• No send
• Hidden
• No Send Row