Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


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 MANUAL VERSIONS

Ignition 8
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

This function returns a mapping of roster names to a list of usernames contained in the roster.

Client Permission Restrictions

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

Syntax

system.alarm.getRosters()

  • Parameters

None

  • Returns

PyDict - A dictionary that maps roster names to a List of usernames in the roster. The List of usernames may be empty if no users have been added to the roster.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code In Action
# This script will get all the rosters and list the users in them.
rosters = system.alarm.getRosters()
for key, values in rosters.iteritems():
	# key is the roster name, values is a dict of usernames
	print 'Roster', key, 'contains these users:'
	for value in values:
		print '  ', value
Output
Roster Admins contains these users:
   admin
Roster Supervisors contains these users:
   asmith
   jdoe


Keywords

system alarm getRosters, alarm.getRosters 

  • No labels