Skip to main content
Version: 8.1

system.roster.createRoster

This function is used in Python Scripting.

Description

Creates a roster with the given name and description, if it does not already exist.

This function was designed to run in the Gateway and in Perspective sessions. If creating rosters from Vision clients, use system.alarm.createRoster instead

Syntax

system.roster.createRoster(name, description)

Parameters

TypeParameterDescription
StringnameThe name of the roster to create.
StringdescriptionThe description for the roster. May be None, but the parameter is mandatory.

Returns

Nothing

Scope

Gateway, Perspective Session

Code Examples

Code Snippet
# Create an empty roster with a description.
system.roster.createRoster("rosterEast", "East plant user roster")


# Create an empty roster roster without a description.
system.roster.createRoster("rosterWest", None)

Keywords

system roster createRoster, roster.createRoster