Versions Compared

Key

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


New_in
Version8.0.8



Scripting_function



Panel
titleDescription

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


Panel
titleSyntax

system.roster.createRoster(name, description)

  • Parameters

String name - The name of the roster to create.

String description - The description for the roster. May be None, but the parameter is mandatory.

  • Returns

none

  • Scope

Gateway, Perspective Session



Panel
titleCode Examples


Code Block
languagepy
titleCode 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)




Panel
titleKeywords

system roster createRoster, roster.createRoster