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

Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata

The following feature is new in Ignition version 8.0.8
Click here to check out the other new features
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

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

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

  • No labels