Versions Compared

Key

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


Panel
titleDescription

This function creates a new roster. Users may be added to the roster through the Gateway or the Roster Management component.

Panel
titleClient Permission Restrictions

Permission Type: Alarm Management

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.

Panel
titleSyntax

system.alarm.createRoster(name, description)

  • Parameters

String name - The name for the new roster.

String description - An A description for the new roster. Required, but can be blank.

  • Returns

Nothing

  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
titleCode In Action - Creating a New Roster
# This example creates a new roster
name = 'MyRoster'
description = 'A roster created by scripting'
system.alarm.createRoster(name, description) 
Panel
titleKeywords

system alarm createRoster, alarm.createRoster