Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL USER MANUAL VERSIONS

Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Employees

Sign In

Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Returns a list of the current shelved alarm paths. A "path" may be either a source path, or a display path.

Client Permission Restrictions

This scripting function has no Client Permission or Perspective Session restrictions..

Syntax

system.alarm.getShelvedPaths()

  • Parameters

Nothing

  • Returns

List - A list of ShelvedPath objects. ShelvedPath objects can be examined with getExpiration, getHitCount, getPath, getShelveTime, getUser, and isExpired.

  • Scope

Gateway, Vision Client, Perspective Session

Examples
Code Snippet - Getting Paths for All Shelved Alarms
# The following code prints a list of the shelved alarms paths and prints them to the console.
paths = system.alarm.getShelvedPaths()
for p in paths:
   print "Path: %s, Shelved by: %s, expires: %s, is expired? %s" % (p.getPath(), p.getUser(), p.getExpiration(), p.isExpired()) 
Keywords

system alarm getShelvedPaths, alarm.getShelvedPaths

  • No labels