Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

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 permissions restrictions


Panel
titleSyntax

system.alarm.listPipelines([projectName])

  • Parameters

StringprojectName - 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

Panel
titleCode Examples
Code Block
languagepy
titleCode 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 Block
languagepy
titleCode 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	
Panel
titleKeywords

system alarm listPipelines, alarm.listPipelines