User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


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

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Will return a list of the available Alarm Notification Pipelines in a project. The order pipelines are lists is not guaranteed, due to how HashMaps in Java work.

The legacy behavior of this function (7.9 and prior) did not have any parameters, and it would always check all projects for pipelines. Upon upgrade to version 8.#+, alarm pipelines were migrated to a project named "alarm-pipelines". See the Upgrade Guide for more details.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.alarm.listPipelines([projectName])

  • Parameters

String projectName - The project to check alarm pipelines for. If omitted, will look for a project named "alarm-pipelines". [optional]

  • Returns

List[String] - A list of pipeline names. The list will be empty if no pipelines exist. Unsaved name changes will not be reflected in the list.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code In Action - Listing the Alarm Pipelines in a Project
# This script will print a list of all alarm pipeline names in the current project.
project = system.util.getProjectName()
pipelines = system.alarm.listPipelines(project)
for pipeline in pipelines:
	print pipeline
Code In Action - Listing all Alarm Pipelines in all Projects
# This script will retrieve all pipelines across all projects
projects = system.project.getProjectNames()

for p in projects:
	print "Project %s has the following alarm pipelines:" % p	
	pipelines = system.alarm.listPipelines(p)
	
	for i in pipelines:
		print "- %s" % i	
Keywords

system alarm listPipelines, alarm.listPipelines