12/10/2016 51676 

­ Using FactoryTalk Alarm and Event Functions in CPR9

(/app/answers/detail/a_id/51676/related/1#)

Using FactoryTalk Alarm and Event Functions in CPR9

Problem
Using FactoryTalk Alarm and Event Functions in CPR9

Answer
You can use FactoryTalk alarm and event functions to retrieve information about a group of FactoryTalk alarms
that have similar names, or an individual alarm. They are available wherever expressions are supported in a
FactoryTalk View SE application.

Using a large number of alarm functions can affect the performance of the system, therefore it is recommended
that the total number of unique function calls accessed in displays on the individual View SE client should be no
more than 500. Re­using the identical alarm function call does not affect performance.

The format for using these functions is:

<FactoryTalk alarm and event function>("alarm name")
where alarm name is an absolute or relative path to one or more alarms.

Absolute path format
The format for the absolute path to an alarm is:

"/<AreaPath>::<AlarmName>"
i.e., "/AreaPath::AlarmNameSyntax"

where

AreaPath ­ includes the application and area path, but not the application name.

AlarmName ­ specifies a single alarm name, or uses the wildcard characters ? and * (question mark and
asterisk) to specify multiple alarms.

https://rockwellautomation.custhelp.com/app/answers/detail/a_id/51676/related/1 1/5
12/10/2016 51676 ­ Using FactoryTalk Alarm and Event Functions in CPR9

Examples

"/Area1/SubArea1::[ControlLogix]Program:LineProgram.MixingTank1" ­ which specifies a single alarm

"/Area1/SubArea1::[ControlLogix]Program:LineProgram.MixingTank*" ­ which specifies all the alarms that begin
with MixingTank, and are in the specified area and subarea.

Relative path format
The format for the relative path is

"[::]<AlarmName>"
i.e., "::AlarmNameSyntax" or "AlarmNameSyntax'.

where

AlarmName ­ specifies a single alarm name, or uses the wildcard characters ? and * (question mark and
asterisk) to specify multiple alarms that are contained in the same area as the display.

Examples

"[ControlLogix12]Program:Line1Program.MixingTank1" ­ which specifies a single alarm

"[ControlLogix12]Program:Line1Program.MixingTank1*" ­ which specifies all alarms that begin with MixingTank

"*" ­ specifies all the alarms that are contained in the same area as the display

Tips

· AreaPath parameter represents a defined area under the application where the alarm is defined. It must
begin with the forward slash character and does not contain the application name.

· Only the AlarmName parameter is used in the relative path format and the colons (::) preceding the alarm
name are optional, unless there is a colon (:) in the tag name. In that case, double colons (::) must
precede the alarm name.

· The AlarmName parameter supports the replacement of tag placeholders used in graphic displays. For
example, in "/Area1/SubArea1::[ControlLogix]Program:Line1Program.#1_TempAlarm" the placeholder
#1 would be replaced by the parameter #1 that is passed to the display.

· If the expression function cannot replace all the placeholders in an alarm name, nothing will be returned by
the expression function, and an error message will be logged to FactoryTalk Diagnostics.

https://rockwellautomation.custhelp.com/app/answers/detail/a_id/51676/related/1 2/5
12/10/2016 51676 ­ Using FactoryTalk Alarm and Event Functions in CPR9

· The information returned by the FactoryTalk alarm and event functions does not include alarms that are
suppressed.

· Click the Alarms button to open the Alarm Source Browser to browse for areas and alarm sources within
the areas to be used with the alarm and event functions.

· For complete information about using FactoryTalk alarms and events see the FactoryTalk Alarms and
Events help, or see the FactoryTalk Alarms and Events Quick Start Guide for an example that uses
alarm expressions to animate the color of a box when the state of an alarm changes. To open the quick
start guide, in FactoryTalk View Studio click Help, point to Online Books and then click FactoryTalk
alarms and Events Quick Start Guide.

There are these FactoryTalk alarm and event functions:

This FactoryTalk alarm and event returns this value:
function

AE_HighSeverityAcked(AlarmName) an integer from 1 to 1000
representing the highest
severity value associated with
the specified alarms, whose
states are In Alarm and
Acknowledged. If 0 is returned
it means none of the specified
alarms were both In Alarm and
Acknowledged.

AE_HighSeverityUnacked(AlarmName) an integer from 1 to 1000
representing the highest
severity value associated with
the specified alarms, whose
states are In Alarm and
Unacknowledged. If 0 is
returned it means none of the
specified alarms were both In
Alarm and Unacknowledged.

AE_InAlmAckedCount(AlarmName) a long integer from 0 to the
number of FactoryTalk alarms
that are In Alarm and
Acknowledged.

https://rockwellautomation.custhelp.com/app/answers/detail/a_id/51676/related/1 3/5
12/10/2016 51676 ­ Using FactoryTalk Alarm and Event Functions in CPR9

AE_InAlmUnackedCount(AlarmName) a long integer from 0 to the
number of FactoryTalk alarms
that are In Alarm and
Unacknowledged

AE_NormalUnackedCount(AlarmName) a long integer from 0 to the
number of FactoryTalk alarms
that are Normal and
Unacknowledged.

DISCLAIMER
This knowledge base web site is intended to provide general technical information on a particular subject or
subjects and is not an exhaustive treatment of such subjects. Accordingly, the information in this web site is not
intended to constitute application, design, software or other professional engineering advice or services. Before
making any decision or taking any action, which might affect your equipment, you should consult a qualified
professional advisor.

ROCKWELL AUTOMATION DOES NOT WARRANT THE COMPLETENESS, TIMELINESS OR ACCURACY OF
ANY OF THE DATA CONTAINED IN THIS WEB SITE AND MAY MAKE CHANGES THERETO AT ANY TIME IN
ITS SOLE DISCRETION WITHOUT NOTICE. FURTHER, ALL INFORMATION CONVEYED HEREBY IS
PROVIDED TO USERS "AS IS." IN NO EVENT SHALL ROCKWELL BE LIABLE FOR ANY DAMAGES OF ANY
KIND INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS PROFIT OR DAMAGE, EVEN
IF ROCKWELL AUTOMATION HAVE BEEN ADVISED ON THE POSSIBILITY OF SUCH DAMAGES.

ROCKWELL AUTOMATION DISCLAIMS ALL WARRANTIES WHETHER EXPRESSED OR IMPLIED IN
RESPECT OF THE INFORMATION (INCLUDING SOFTWARE) PROVIDED HEREBY, INCLUDING THE IMPLIED
WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, AND NON­
INFRINGEMENT. Note that certain jurisdictions do not countenance the exclusion of implied warranties; thus,
this disclaimer may not apply to you.

This page is best viewed in Internet Explorer 10, Firefox 31, Chrome 37, Safari 6 or newer.


Top (/app/answers/detail/a_id/51676/related/1#top)

https://rockwellautomation.custhelp.com/app/answers/detail/a_id/51676/related/1 4/5
12/10/2016 51676 ­ Using FactoryTalk Alarm and Event Functions in CPR9

New Site Feedback

      
(http://www.rockwellautomation.com/global/blog/overview.page)
(https://www.facebook.com/ROKAutomation)
(https://plus.google.com/+RockwellautomationInc)
(https://www.linkedin.com/company/rockwell­
(http://www.slideshare.net/RockwellAutomation)
(http://twitter.com/ROKAutomation)
(http://www.youtube.com/rokautomation)
automation)


Top (/app/answers/detail/a_id/51676/related/1#top)

https://rockwellautomation.custhelp.com/app/answers/detail/a_id/51676/related/1 5/5