Configure the BitLabels​.xml and aaBitLabelsSchema​.xsd files

The Bit Labels information is defined in the BitLabels.xml file and validated by using aaBitLabelsSchema.xsd file. These files are not available by default.

BitLabels.xml

The BitLabels.xml file defines the labels of each supported Bit Labels. For example, the Bit Labels "Standard".

To define a Bit Labels, we need a Name and a Type. For example: <Labels Name="Standard" Type="Default">.

1. Name: The name specified here is listed in the Bit Labels dropdown combo.
   The bit labels Name must contain at least one letter. Valid characters are alphanumeric and special characters ($, #, _). The maximum length of the bit labels name is 32.

2. Type: ‘Default’ or the ‘Name’ of the Label.

Each XML can contain multiple <Labels>. Each <Labels> consists one or more <Label>. Each label has the Name and Range info. For example:

<Labels Name="Standard" Type="Default">

<Label Name="B31" Range="0X80000000"/>

<Label Name="B30" Range="0X40000000"/>

<Label Name="B29" Range="0X20000000"/>

Each <Label> will have two fields:

3. Name: The label name and bit labels name are case insensitive and the maximum length of the label name is 4. In the Bit Pattern Selector dialog, when the ‘Standard’ Bit Labels is selected, the label name "B31" is displayed on the first top left corner.

4. Range: Is an Integer in hexadecimal format specifying which bit will be applied to the Name. The Range has 32 bits and can have only one bit set to '1'. All the other bits should be '0'. There is exception on the label "CRIT" and label "PRI" of the Label "ALMSTA".

For example:

In the Label ‘Standard’, the bit "B31" is assigned to "0x80000000". Converting the hexadecimal number to a binary, it will be "1000 0000 0000 0000 0000 0000 0000 0000". That means the label "B31" is the highest bit.

<Label Name="B31" Range="0x80000000"/>

In the Label ‘Standard’, the bit "B5" in assigned to "0x20". Converting the hexadecimal number to a binary, it is "0000 0000 0000 0000 0000 0000 0010 0000". Since the lead twenty-six digits are zeros, we can ignore these zeros in the Range value.

<Label Name="B5" Range="0x20"/>

The following rules will be applied when validating the bit labels XML and displaying the Bit Pattern Selector Dialog:

• The label name and bit labels name must contain at least one letter. Valid characters are alphanumeric and special characters ($, #, _).
  <Label Name="B31" Range="0x80000000"/>

• Label name must be unique for each label type. One label name cannot be used more than one places in a label type.

• Bit Label name can start with "," to reserve the label space. For example: <Label Name=",PNT2" Range="0x4000"/>.

• Two different label names cannot point to the same bit, although a bit can have multiple labels. The labels can be assigned in a Name and separated by comma ','. It can have comma separated values up to 4 groups. For example, the bit "0x2000000" in the Label "ALMSTA", The entry in the BitLabels.xml will be <Label Name="HHA,TARG" Range="0x2000000"/> and in the Bit Pattern Selector dialog, it will be displayed like:

  

• Bit Pattern Selector supports label name alias. For example, the selector will apply all the label of label type "ALMOPT" for the label name selection "INHSTA" if the following labels type is defined in the xml:
  <Labels Name="ALMOPT" Type="ALMOPT" SameAs="INHSTA"/>

• If no label name is defined for the bit, the corresponding bit configuration will be disabled in the selector dialog. The label from the Standard Bit Labels will be associated to the bit.

• Each label name except "CRIT" and "PRI" only can specify one bit in the range. For more information, see CRIT and PRI in the Label ALMSTA.

aaBitLabelsSchema.xsd

The aaBitLabelsSchema.xsd contains the schema to validate the BitLabels.xml file. The Bit Labels drop down list will be disabled if:

• The XML and XSD files are not available in the <installpath>\ArchestrA\Bin location.

• The XML is not well formed

• An invalid label is detected when loading the BitLabels.xml; In this case a warning message will be logged and the default Standard label type will be used.

If the Bit Labels is disabled, the "Standard" bit labels will be applied to each bit in the Bit Pattern Selector dialog.

Unassigned bit

If a bit is not assigned to a label, the bit will be greyed out in the Bit Pattern Selector dialog.

For example, the "B15" to "B8" are greyed out in the Label "ALMSTA".

A greyed-out bit cannot be changed and the bit value will be displayed as "X" (Ignore).