### Using field codes Use field codes to insert live data into: The message on an alarm action Text displayed on the Alarms page > View tab Alarm information archived to a text file when an alarm is deleted You can customize the setup of each of these items by appending field codes. For example, to have the message in an alarm action include the device that generated the alarm, append the Device field code to the action's message.
Click for details below Formatting field codes Field codes
#### Formatting field codes You can type a formatting command after a field code to format the field code in one of the following 3 ways: Format a number field code (Example: ##.##) Format a date/time field code (Example: MM/dd/yyyy hh:mm:ss) Left, right, or center align a field code and set the field width A formatting command must have the following syntax: Use the table below to determine the format_type and style for a formatting command.
| format_type | style | Example
To format a number | N | The actual formatting, such as ##.##. The basic format uses the pound sign (#) to represent a number. For more information, search the Internet for "customizing number formats with java". | To always truncate a setpoint value to two digits to the right of the decimal, the field code is: $setpoint_value%N:##.##$ For example, 78.9935 becomes 78.99.
To format date/time | D | The actual formatting, such as MM/dd/yyyy hh:mm:ss. For more information, search the Internet for "customizing date time formats with java". | To show the date and time when an alarm is generated in a format like 03/15/2004 10:50:43, the field code is: $generation_time%D:MM/dd/yyyy hh:mm:ss$
To set alignment and field width | L for left align R for right align C for center align | Indicate the field width by number of characters. | To left align the name of the device that generated the alarm and set the field width to 15 characters, the field code is: $device%L:15$
Using multiple formatting commands You can type multiple formatting commands for a field code. For example, you can format a number and then set the alignment and field width. The syntax for multiple formatting commands is: $fieldcode%format_type1:style%format_type2:style$ EXAMPLE To format the alarm date and time, center it and set the field at 20 characters, the field code is: $generation_time%D:MM/dd/yyyy hh:mm:ss%C:20$ NOTE You must enter the date/time or number formatting command before the alignment/field width command.
#### Field codes
Field Code Name | Field Code | Description
--- | --- | ---
Acknowledge Operator | $acknowledge_operator$ | The operator who acknowledged the alarm. EXAMPLE John Doe
Acknowledge Time | $acknowledge_time$ | The time when the operator acknowledged the alarm. EXAMPLE Nov 12, 2012 6:46:31 PM
Alarm Category | $alarm_category$ | The alarm category that the alarm is assigned to. EXAMPLE HVAC Critical
Alarm Priority | $alarm_priority$ | The priority number associated with the alarm's priority (Off-Normal, Fault, or Normal) on the controller's Driver > Notification Class page.
Alarm Template | $alarm_template$ | The alarm template that the alarm is assigned to. EXAMPLE Universal
Alarm Type | $alarm_type$ | The alarm type of the alarm source. EXAMPLE CHANGE OF STATE
Alert Text | $alerttext$ | For a converted SuperVision® system if the option Create a single alarm template... was selected during upgrade. Retrieves alarm message text from cmnet_alert_text.properties. To use this field code: 1. Select the Alert Text field code. 2. After $alerttext, type one of the following: `:normalshort` `:normallong` `:alarmshort` `:alarmlong` For example, $alerttext:alarmlong$
Character | $c$ | A single ASCII character. Often used for form feeds and other printer escape sequences. EXAMPLE $C:65$ displays A
Command Value | $command_value$ | The commanded value from the alarm source. Valid only for alarm type COMMAND FAILURE. EXAMPLE 3
Control Program | $equipment$ | The display name of the equipment where the alarm came from. EXAMPLE Chiller
Controller | $device$ | The display name of the device where the alarm came from. EXAMPLE SE6104
Dead Band | $deadband$ | The deadband value from the alarm source. Valid only for alarm type OUT-OF-RANGE. EXAMPLE 5
Deletion Operator | $deletion_operator$ | The operator who deleted the alarm. EXAMPLE John Doe
Deletion Time | $deletion_time$ | The time the alarm was deleted. EXAMPLE Nov 12, 2012 6:46:31 PM
Error Limit | $error_limit$ | The error limit, from the alarm source. Valid only for alarm type FLOATING LIMIT. EXAMPLE 90
Event Values | $event_values$ | Returns a string of alarm values associated with the alarm.
Exceeded Limit | $exceeded_limit$ | The exceeded limit value from the alarm source. Valid only for alarm type OUT-OF-RANGE. EXAMPLE 90
Exceeding Value | $exceeding_value$ | The exceeding value from the alarm source. Valid only for alarm type OUT-OF-RANGE. EXAMPLE 91
Fault | $fault$ | The status of the fault condition from the alarm source. EXAMPLE True or false
Field Message | $field_message$ | Text generated in the alarm by the controller.
Feedback Value | $feedback_value$ | The feedback value from the alarm source. Valid only for alarm type COMMAND FAILURE. EXAMPLE 10
From State | $from_state$ | The previous state of the alarm source. EXAMPLES NORMAL, FAULT, OFF NORMAL, HIGH LIMIT, LOW LIMIT
Generation Operator | $generation_operator$ | The operator who forced the alarm to return to normal. EXAMPLE John Doe
Generation Time | $generation_time$ | The time in the controller when the alarm was generated. EXAMPLE Nov 12, 2012 6:35:18 PM
In Alarm | $in_alarm$ | The in alarm status from the alarm source. EXAMPLE True or false
Incident Closed Time | $incident_closed_time$ | The time the alarm's entire incident group closed. EXAMPLE Nov 12, 2012 6:46:31 PM
Latched Data Value (Analog) | $latched_data_analog:x$ | "x" ranges from 1 to 10. Returns a numerical value. Use for legacy systems.
Latched Data Value (Digital) | $latched_data_digital:x$ | "x" ranges from 1 to 10. Returns On or Off. Use for legacy systems.
Location Path | $location_path$ | Displays the path display names from root to source. EXAMPLE Building B / Basement / VAV AHU B / SSP_STOP The number of levels in the path is based on the System Settings field Levels displayed in paths. To override this setting, enter the field code as $location_path:#$, substituting # with the number of path levels you want to show. For example, $location_path:5$ will show 5 levels.
Long Message | $long_message$ | The formatted alarm long text displayed by double-clicking the alarm on the Alarms page.
Message Details | $message_details$ | The message details displayed on the Alarms page View tab.
Message Prefix | $message_prefix$ | The message prefix displayed on the Alarms page View tab.
Message Text | $message_text$ | The message text displayed on the Alarms page View tab.
New State | $new_state$ | The status of new state from the alarm source. Valid only for alarm type CHANGE OF STATE. EXAMPLE Alarm, Fault
New Value | $new_value$ | The new value from the alarm source. Valid only for alarm type CHANGE OF VALUE. EXAMPLE 70
Notification Class | $notification_class$ | The notification class assigned denotes how the received alarm was generated. For example, if set to 1, the alarm would typically be sent to WebCTRL by Automated Logic® controllers.
Object ID | $object_ID$ | Object ID of the alarm source. EXAMPLE 5:26
Out of Service | $out_of_service$ | The status of 'out of service' from the alarm source. EXAMPLE True or false
Overridden | $overridden$ | The status of 'overridden' from the alarm source. EXAMPLE True or false
Program ID | $program_id$ | The address of the control program that generated the alarm. BACnet program address format: device ID, program number EXAMPLE 2423101,1 SuperVision program address format: site, gateway, controller, fb EXAMPLE 1, 2, 13, 5
Receive Time | $receive_time$ | The time at the workstation when the alarm was received. EXAMPLE Nov 12, 2012 6:46:31 PM
Recipient Device ID | $device_id$ | The device ID of the device where the alarm came from. EXAMPLE 8:2423101
Record Type | $record_type$ | The type of alarm. EXAMPLE BACnet, Supervision®, System
Reference Path | $reference_path$ | Path to alarm source. Available in all alarm actions. EXAMPLE #e_b_vav_ahu_b/ssp_stop
Reference Value | $reference_value$ | The 'reference value' from the alarm source. Valid only for alarm type FLOATING LIMIT. EXAMPLE 83
Referenced Bitstring | $referenced_bitstring$ | The value of the 'referenced bitstring' value from the alarm source. Valid only for alarm type CHANGE OF BITSTRING. EXAMPLE 1011011101101
RTN Time | $RTN_time$ | The time when the alarm returned to normal. EXAMPLE Nov 12, 2012 6:46:31 PM
Setpoint Value | $setpoint_value$ | The 'setpoint value' from the alarm source. Valid only for alarm type FLOATING LIMIT. EXAMPLE 72
Short Message | $short_message$ | The formatted alarm short text.
Site | $site$ | The display name of the site the alarm came from. EXAMPLE Kennesaw
Source | $source$ | The display name of the alarm source microblock that generated the alarm. EXAMPLE SAT_HI
Source description | $source:description$ | The Description field of the alarm source microblock that generated the alarm. EXAMPLE High Cooling Supply Air Temp
Source Path | $source:<path>$ | Substitute <path> with the path to the value you want to display. See Defining WebCTRL® paths. Example to add text value: $source:~equipment.display-name$ Example to add a numeric value: $source:/trees/geographic/rd_facility/ zone_1/lstat/present_value$ NOTES You can use Global Modify to get the path. For legacy systems, use the latched data field codes.
System Directory | $system_dir$ | The system folder name. EXAMPLE c:\WebCTRLx.x\webroot\ world_corporation
To State | $to_state$ | The current state of the alarm source. EXAMPLES NORMAL, FAULT, OFF NORMAL, HIGH LIMIT, LOW LIMIT