Create the ATHOC-GV-KEYS attribute XML configuration

This section describes how to create the key user ATHOC-GV-KEYS attribute configuration.

American Signal CompuLert™ .cfg file

On the American Signal CompuLert™ standalone computer, browse to

C:\WINAPPS\ASC2\Data

and open the appropriate .cfg file with Notepad.

The following example has bold text to show the important sections:

Customer X Electronic Control Configuration - rev 6.00 03/04/13
PORTS
"C:\", "COM1:2400,N,8,2", 31, 0
"", 0, 1,1,1,1,1,1,1,1,1
SWITCHES
"01", "MDY", 0, 0, 0, 0, 0 0
Map1 Rep Cen Mon Cyc RePoll MetDly Multipoll
COMMANDS
At Dly Description Command (10) - Command Delay
1, 7, "Auto Poll w/Report ", 682,
2, "Auto Reset Status ", 67
3, 2, "Auto Sil-Test w/Rep ", 66
4, 2, " ", 0
5, 2, "Auto Weekly Test ", 33
6, 2, "Auto Reveille/Colors", 34
7, 2, "Auto Retreat/Anthem ", 35
8, 2, "Auto Taps ", 36
9, 2, "Auto Call to Arms ", 53
10, 2, " ", 0
11, 2, " ", 0
12, 2, " ", 0
13, 2, " ", 0
14, 2, " ", 0
15, 2, " ", 0
16, 2, " ", 0
17, 2, " ", 0
18, 2, " ", 0
19, 2, " ", 0
20, 2, " ", 0
21, 2, " ", 0
22, 2, " ", 0
23, 2, " ", 0
24, 2, " ", 0
25, 2, " ", 0
26, 2, " - - Abort - - ", 61
27, 7, "USTAT Auto Re-Poll ", 54
28, 5, "Auto Weather Data ", 70
 1, "AL FF FF FF Alert "
2, "AT FF FF FF Attack "
3, "HI FF FF FF Hi\Lo "
4, "HO FF FF FF Air-Horn
5, "FI FF FF FF Fire "
6, "GR FF FF FF Growl "
7, "HA FF FF FF Hazard "
8, "CH FF FF FF Chime "
9, "SC FF FF FF Scream "
10, "WA FF FF FF Wail "
11, "XA FF FF FF Pgm-A "
12, "XB FF FF FF Pgm-B "
13, "XC FF FF FF Pgm-C "
14, "XD FF FF FF Pgm-D "
15, "XE FF FF FF Pgm-E "16, "XF FF FF FF Pgm-F "
17, "PA FF FF FF Live PA "
 18, "SI FF FF FF Test "
19, "RO FF FF FF Rotate "
20, "SH FF FF FF Seek Home"
21, "ST FF FF FF Strobe "
22, "AR FF FF FF Arm "
23, "ME 01 FF FF Message "
24, "CS FF FF FF Slo-Cancel"
25, "RS FF FF FF Reset Status"
26, "PO FF FF FF Poll "
 27, "RE FF FF FF Re-Sync "
28, "RB FF FF FF Remote-Rst"
29, "WP 00 FF FF Write-Pgm "
30, "RP 00 FF FF Macro-Central"
31, "DM F0 FF FF Dump-Mem "
 32, "CA FF FF FF Cancel "
33, "ME 01 FF FF Weekly Test"
34, "ME 02 FF FF Reveille/Colors"
35, "ME 03 FF FF Retreat/National Anthem"
36, "ME 04 FF FF Taps
37, "ME 05 FF FF Lightning Warning"
38, "ME 06 FF FF Lightning Warning Terminated"
39, "ME 07 FF FF Heat Advisory"
40, "ME 08 FF FF Tornado Warning"
41, "ME 09 FF FF All Clear"
42, "ME 0A FF FF Hurricane Condition Five"
43, "ME 0B FF FF Hurricane Condition Four"
44, "ME 0C FF FF Hurricane Condition Three"
45, "ME 0D FF FF Hurricane Condition Two"
46, "ME 0E FF FF Hurricane Condition One"
47, "ME 0F FF FF Tornado Exercise"
48, "ME 10 FF FF All Clear Exercise"
49, "ME 11 FF FF Alarm Yellow Exercise"
50, "ME 12 FF FF Alarm Red Mopp 4 Exercise"
51, "ME 13 FF FF Alarm Red Ground Attack MOPP 2 Exercise"
52, "ME 14 FF FF Alarm Red Ground Attack MOPP 4 Exercise"
53, "ME 15 FF FF Call to Arms"
54, "PO FF FF FF USTAT Poll"
55, "CA FF FF FF -Test Mark"
56, "M1 Cancel (M1)"
57, "M2 ?? "
58, "M3 ?? "
59, "M4 ?? "
60, "M5 ?? "
61, "M6 ?? "
62, "M7 ?? "
63, "M8 ?? "
64, "M9 ?? "
65, "M10 ?? "
66, "M11 Silent Test w/Report (M16)"
67, "M12 Reset Status (M17)"
68, "M13 Poll w/Report (M18)"
69, "M14 Test Poll (M19)"
70, "WE Request Weather Data"
71, "LI Show Last Weather"
72, "PR Remove Weather Boxes"
73, "PR Print Weather Data"
74, "DIS Pending Trouble Report"
75, "UR Trouble Report by Date"
76, "SS Silent Test Report"
77, "SS Daily Poll Status Report"
78, "SS Siren Activation Report"
79, "SS AC Test Report"
80, "SS DC Test Report"
MENUS
0, 0, 32, Cancel
0, 1, 55, ------
0, 2, 37, Lightning Warning
0, 3, 38, Lightning Warning Terminated
0, 4, 39, Heat Advisory
0, 5, 40, Tornado Warning
0, 6, 41, All Clear
0, 7, 55, ------
0, 8, 34, Reveille/Colors
0, 9, 35, Retreat/National Anthem
0,10, 36, Taps
0,11, 53, Call to Arms
0,12, 55, ------
0,13, 42, Hurricane Condition Five
0,14, 43, Hurricane Condition Four
0,15, 44, Hurricane Condition Three
0,16, 45, Hurricane Condition Two
0,17, 46, Hurricane Condition One
0,18, 55, ------
0,19, 47, Tornado Exercise
0,20, 48, All Clear Exercise
0,21, 55, ------
0,22, 49, Alarm Yellow Exercise
0,23, 50, Alarm Red Mopp 4 Exercise
0,24, 51, Alarm Red ground Attack Exercise
0,25, 52, Alarm Black Exercise
0,26, 55, -----
0,27, 33, Weekly Test
0,28, 55, ------
0,29, 17, Live PA
2, 0, 32, Cancel
2, 1, 55, ------
2, 2, 26, Poll
2, 3, 67, Reset Status
2, 4, 18, Silent Test
2, 5, 55, ----------
2, 6, 68, Poll w/Report
2, 7, 55, ----------
2, 8, 66, Silent Test w/Report
3, 8, 55, ----------
3, 9, 75, Trouble Report
0,99, 99, End of List
MACROS
Cancel
56, 1,32, 0, "???"
Silent Test w/Report
66, 1,67, 0, "???"
66, 2,18,16, "???"
66, 3,69, 0, "???"
66, 4,18,16, "%%%"
66, 5,55, 0, "%%%"
66, 6,26, 0, "%%%"
66, 7,76, 0, "???"
Reset Status
67, 1,25, 0, "???"
67, 2,25, 0, "???"
Poll w/Report
68, 1,26, 0, "???"
68, 2,26, 0, "%%%"
68, 3,77, 0, "???"
Poll After Run
69, 1,55, 0, "???"
69, 2,26, 0, "???"
69, 3,55, 0, "%%%"
69, 4,26, 0, "%%%"
99
REPEATERS
163.4625Hz(Tx) 163.4625MHz(Rx) None=PL
0
=====================================================================-
===========|Last Response| Poll | Activate | System Test |Low
Sir |-------------|-------|--------------------|--------------|Comm
Door AC
Loc | Time Date |OK Fail| OK Pwr Par Loc Com | OK Pwr Par |Batt
Open Fai============================================================================xxx 12:34:56 03-23 x x x x x x x x x x xx x24 28 33 36 40 44 48 54 58 63 67 71 ------|---------|---------|---------|---------|---------|-------xxxx-|---------|
MSG pos err
Text
1, 24, 0," RF-OK"
2, 77, 2," AC_Fail"
3, 67, 5," Low_Comm_Batt"
4, 71, 2," Door_Open"
5, 0, 0," Sync_Error"
6, 0, 0,""
7, 33, 0," Activate_OK"
8, 33, 0," Activate_No_Rotate"
9, 36, 5," Activate_No_Power"
10, 40, 2," Activate_Partial"
11, 54, 0," Test_OK"
12, 54, 0," Test_No_Rotate"
13, 58, 5," Test_No_Power"
14, 0, 0," RTU_Restart"
15, 28, 5," No_Response_from_Poll"
16, 63, 2," Test_Partial"
17, 0, 0," Low_Main_Batt"
18, 0, 0," AC_Disable"
19, 48, 5," Activate_Comm"
20, 44, 5," Activate_Local"
4, 3, 2,14, 5,-4,-2,-1, 0, 0, 0, 0, 0, 0, 0, 0 ' (-Bit)(+Msg)
(+200inv)6, 7, 8, 9,20,11,12,13, 6,10,10, 9,20,16,16,13,15,19 ' Run StatusXlate
0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0 ' Cen/Aux/Sgn
bits
STATUS BOX
Byte BitText Fail Text
0, 0, "-------------------"
6, 0, " Siren Status of ", "Fail", "Unknown"
0, 0, "-------------------"
7, 0, " Poll Date:", "Not Polled", "Date:"
1, 8, " RF Comm:", "OK ", "Sync Err ", ""
1, 64, " Comm Bat:", "OK ", "Low ", ""
1,128, " Doors:", "Closed", "Open ", ""
1, 32, " AC Power:", "OK ", "Fail ", ""
4, 0, " Amps:", "OK ", "", ""
3, 0, " Siren:", "IDLE ", "", ""
5, 3, "Act Status:", "-none-", "", ""
0, 94, "---------------------", "Rep", "CEN-"
6, 0, " Repeater Status - ", "Fail", "Unknown"
0, 0, "---------------------"
7, 0, " Date/Time:", "Never Polled", ""
1, 8, " Feedback:", "OK ", "Sync Err "
1, 64, " Battery:", "OK ", "Low "
1, 32, " Mains:", "OK ", "Fail "
2, 16, " Output:", "OK ", "Fault "
2,204, " Repeater:", "Active", "Disabled "
0, 98, "---------------------", "Cen", "CEN-"
6, 0, " Central Status - ", "Fail", "Unknown"
0, 0, "---------------------"
7, 0, " Date/Time:", "Never Polled", ""
1, 8, " Feedback:", "OK ", "Sync Err "
1, 64, " Battery:", "OK ", "Low "
1, 32, " Mains:", "OK ", "Fail "
2, 2, " J103-4:", "OK ", "Error "
2, 4, " J103-5:", "OK ", "Error "
2, 8, " J103-6:", "OK ", "Error "
2, 16, " J103-7:", "OK ", "Error "
0, 99, "---------------------"TRANSLATE 0123456789ABCDT* 0123456789ABCDE* 0123456789ABCDR* NO
ANALOG #siren, #Ch , 1'st Ch siren
0, 5, 9, "AAA"

The definition for each attribute is as follows:

Attribute name	Description
Id	Corresponds to the address of the key within the Giant Voice system. This addressing scheme varies by Giant Voice vendor.
messgaeIdRef	References the <message> object to be displayed as a warning in the Targeting screen in the Management System during the publishing cycle.
targetingRule	Used to establish correct targeting behavior for the key. Possible values are: TargetingNotAllowed TargetingAllowed TargetingRequired
name	The name of the Giant Voice key that is displayed in the publishing flow.
description	The description of the Giant Voice key that is displayed in the publishing flow. If there are more than 5 keys, this will not be displayed.

Id numbers do not need to be sequential. Changing the order in the XML,changes the order in which Id numbers are listed in the publishing flow but has no effect on the command number being sent to the RTUs.

In American Signal Giant Voice, the id addressing consists of 5 pipe-separated (|)hexadecimal bytes. The first byte corresponds to the hexadecimal equivalent of the decimal number(minus 1) shown in the yellow highlighted section above where id = DHC(command10-1). The highest RTU command number that can be addressed this way is Cancel, #32 in the list or 1FH.

Example 1:
Alert (AL) is #1 in the list and converts to

00; (1-1)=010=00H

Example 2:
Cancel (CA) is #32 in the list and converts to

1F; (32-1)=3110=1FH

Id #17 (hexadecimal #10), Public Address, is skipped as Public Address functions are handled as an RTU function through the All Poles, Pole, and Zone target user device address instead of through a function key.

The second and subsequent bytes correspond to various attributes of the key.

Example: Message number or times for a tone to cycle.

Command numbers above #32 (1FH), shown in the blue highlighted section, need to have some additional handling before they can be added to the Key Id list.

Example:
Command 33 calls on function ME with a hex specifier of 01 for message #1 for the recording, “Weekly Test”:

35, "ME 03 FF FF Retreat/National Anthem"

In the following example,“ME” occurs within the lower-range of functions:

23, "ME 01 FF FF Message"

The base message function is 2310=16H. The translation of function 3310 into function 2310 is:

23, "ME 03 FF FF Retreat/National Anthem"

Which translates into: Id =

“16:03:FF:FF:FF”

For American Signal Giant Voice Keys, the messageIdRef parameter is always MSGTARGETING-REQUIRED and the targetingRule parameter is always TargetingRequired.

The key name and description parameters cannot contain spaces or any of the following characters:

' ! $ % ^ ( ) = { } , ; : ? " < > |

This sample XML shows how the basic functions from the .cfg file above are listed for use in the Key user and maps to the .cfg file shown above. You can copy the content below into Notepad and modify it to match your Function Keys.

<giantVoiceSetting>
<messages>
<message id = "MSG-TARGETING-NOT-ALLOWED">The Giant Voice Key you
have selected on the previous page does not allow 
additional selection of Giant Voice poles or zones. You may still 
target users for other devices, but Giant Voice targeting will be ignored.
</message>
<message id = "MSG-TARGETING-ALLOWED">The Giant Voice Key you have selected on the previous page already has Giant Voice poles and zones targeted, but you can override them by targeting different zones in the Targeting area just below. 
</message>
<message id = "MSG-TARGETING-REQUIRED">The Giant Voice Key you have selected on the previous page does not have any targeting information built-in, and will require you to target at least one Giant Voice pole or zone below.</message>
</messages>
<keys>
<key
id = "1F|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>CANCEL</name>
<description>CANCEL</description>
</key>
<key
id = "11|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>SILENT TEST</name>
 <description>SILENT TEST</description>
 </key>
<key
id = "16|05|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>LIGHTNING WARNING MESSAGE</name>
<description>LIGHTNING WARNING MESSAGE</description>
</key>
</key>
<key
id = "16|06|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>LIGHTNING WARNING TERMINATED MESSAGE</name>
<description>LIGHTNING WARNING TERMINATED MESSAGE</description>
</key>
<key
id = "16|07|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>HEAT ADVISORY MESSAGE</name>
<description>HEAT ADVISORY MESSAGE</description>
</key>
<key
id = "16|08|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>TORNADO WARNING MESSAGE</name>
<description>TORNADO WARNING MESSAGE</description>
</key>
<key
id = "16|09|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>ALL CLEAR MESSAGE</name>
<description>ALL CLEAR MESSAGE</description>
</key>
<key
id = "16|02|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingNotAllowed">
<name>REVEILLE - COLORS BUGLE</name>
<description>REVEILLE - COLORS BUGLE</description>
></key>
<key
id = "16|03|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
25
Chapter 5: VPS Component Configuration (.85)
targetingRule = "TargetingRequired">
<name>RETREAT BUGLE - NATIONAL ANTHEM</name>
<description>RETREAT BUGLE - NATIONAL ANTHEM</description>
</key>
<key
id = "16|04|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>TAPS BUGLE</name>
<description>TAPS BUGLE</description>
</key>
<key
id = "16|15|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>CALL TO ARMS BUGLE</name>
<description>CALL TO ARMS BUGLE</description>
</key>
<key
id = "16|0A|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>HURRICANE CONDITION FIVE</name>
<description>HURRICANE CONDITION FIVE</description>
</key>
<key
id = "16|0B|FF|FF|FF"
messageIdRef = "MSG-TARGETING-NOT-ALLOWED"
targetingRule = "TargetingRequired">
<name>HURRICANE CONDITION FOUR</name>
<description>HURRICANE CONDITION FOUR</description>
</key>
><key
id = "16|0C|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>HURRICANE CONDITION THREE</name>
<description>HURRICANE CONDITION THREE</description>
</key>
<key
id = "16|0D|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>HURRICANE CONDITION TWO</name>
<description>HURRICANE CONDITION TWO</description>
</key>
<key
id = "16|0E|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>HURRICANE CONDITION ONE</name>
<description>HURRICANE CONDITION ONE</description>
</key>
<key
id = "16|0F|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>EXERCISE TORNADO MESSAGE</name>
<description>EXERCISE TORNADO MESSAGE</description>
</key>
<key
id = "16|10|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>EXERCISE ALL CLEAR MESSAGE</name>
<description>EXERCISE ALL CLEAR MESSAGE</description>
</key>
<key
id = "16|11|FF|FF|FF"
>messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>EXERCISE ALARM YELLOW MESSAGE</name>
<description>EXERCISE ALARM YELLOW MESSAGE</description>
</key>
<key
id = "16|12|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>EXERCISE ALARM RED MOPP 4 MESSAGE</name>
<description>EXERCISE ALARM RED MOPP 4 MESSAGE</description>
</key>
<key
id = "16|13|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>EXERCISE ALARM RED GROUND ATTACK MOPP 2 MESSAGE</name>
<description>EXERCISE ALARM RED GROUND ATTACK MOPP 2 MESSAGE</-
description>
</key>
<key
id = "16|14|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>EXERCISE ALARM RED GROUND ATTACK MOPP 4 MESSAGE</name>
<description>EXERCISE ALARM RED GROUND ATTACK MOPP 4 MESSAGE</-
description>
</key>
<key
id = "16|01|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>WEEKLY TEST MESSAGE</name>
<description>WEEKLY TEST MESSAGE</description>
</key>
<key
id = "00|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>ALERT TONE 3 MINUTES</name>
<description>ALERT TONE</description>
</key>
<key
id = "01|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>ATTACK TONE 3 MINUTES</name>
<description>ATTACK TONE 3 MINUTES</description>
</key>
<key
id = "02|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>HI-LO TONE 3 MINUTES</name>
<description>HI-LO TONE</description>
</key>
<key
id = "03|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>AIR HORN TONE 3 MINUTES</name>
<description>AIR HORN TONE</description>
</key>
<key
id = "04|07|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>FIRE TONE 3 MINUTES</name>
<description>FIRE TONE</description>
</key>
<key
id = "06|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>HAZARD TONE 3 MINUTES</name>
<description>HAZARD TONE</description>
</key>
<key
id = "07|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>CHIME TONE 10 SECONDS</name>
<description>CHIME TONE</description>
</key>
<key
id = "08|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>SCREAM TONE 3 MINUTES</name>
<description>SCREAM TONE</description>
</key>
<key
id = "09|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>WHOOP TONE 3 MINUTES</name>
<description>WHOOP TONE</description>
</key>
<key
id = "17|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>SLOW CANCEL</name>
<description>SLOW CANCEL</description>
</key>
<key
id = "18|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>RESET STATUS</name>
<description>RESET STATUS</description>
</key>
<key
id = "1B|FF|FF|FF|FF"
messageIdRef = "MSG-TARGETING-REQUIRED"
targetingRule = "TargetingRequired">
<name>REBOOT</name>
<description>REBOOT</description>
</key>
</keys>
</giantVoiceSetting>

Macros

For more information about how to set up a file in the IIM and the key attributes, see Configure the SirenCommandMap.txt file.

Section:

Create a mass device key endpoint