AE_Unshelve

Unshelves one or more alarms that were previously shelved.
Syntax
AE_Unshelve
<alarm_source>
[/P]
where
<alarm_source>
can be one of the following depending on the alarm source type:
  • To specify the alarm source by alarm ID, it's an absolute path to one or more alarms.
    You can also click the
    Browse
    button to select alarms.
  • To specify the alarm source by alarm object name, it's the alarm summary or alarm banner name from the same display. This command will run for any selected alarms on the alarm summary or alarm banner object.
    You must manually enter the alarm object name.
[/P]
opens a dialog box that lets you enter a comment when the command is run.
Remarks
This command is run on the
FactoryTalk View SE
Client or
FactoryTalk View Studio
that issued it. It is ignored when it is issued from an HMI Server.
If you want this command to run for the selected alarms on the Alarm and Event Banner object, you must select the
Maintain selection when focus is lost
check box on the
General
tab of the
Alarm and Event Banner Properties
dialog box.
Use the following general syntax guidelines when using the Alarm and Event commands:
  • Separate multiple alarms with a semicolon (;), for example,
    "/Area1:FTAEServer::Alarm1;/Area1:FTAEServer::Alarm2"
    .
  • Use the wildcard asterisk character (*) to specify all alarms that are in the same location such as an alarm group, an area, or a Tag Alarm and Event server, for example,
    "/Area1:FTAEServer::*"
    .
  • By default, the alarm path includes the alarm group or alarm server when browsing alarms. Starting from FactoryTalk Alarms and Events version 6.31, it's possible to omit the alarm server from the path if only one alarm server exists within the area. Starting from FactoryTalk Alarms and Events version 6.60, it's possible to omit the alarm group from the path.
Example
AE_Unshelve "/Data_Area:FTLinx_Server::*;/Tag_Area:FTAETag_Server::*" /P
or
AE_Unshelve "/Data_Area::*;/Tag_Area::*" /P
Unshelves
all the alarms of
FTLinx_Server
under the
Data_Area
area and all the alarms of
FTAETag_Server
under the
Tag_Area
area
.
If only one alarm server exists within an area, the server can be omitted from the path, as shown in the second example.
AE_Unshelve "/Tag_Area:FTAETag_Server:Group1.SubGroup1::*" /P
or
AE_Unshelve "/Tag_Area:FTAETag_Server::*" /P
Unshelves
all the alarms in
Group1
's
SubGroup1
of
FTAETag_Server
under the
Tag_Area
area
.
The alarm group can be omitted from the path, as shown in the second example.
AE_Unshelve %AlarmEventSummary1% /P
Unshelves all the selected alarms on the
AlarmEventSummary1
object.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal