Skip to main content
Version: 8.1

system.user.addCompositeSchedule

This function is used in Python Scripting.

Description

Allows two schedules to be combined into a composite schedule.

Client Permission Restrictions

Permission Type: User 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.

Syntax

system.user.addCompositeSchedule(name, scheduleOne, scheduleTwo, [description])

Parameters

TypeParameterDescription
StringnameThe name of the new composite schedule.
StringscheduleOneThe first schedule to combine.
StringscheduleTwoThe second schedule to combine.
StringdescriptionDescription of the new combined schedule. [optional]

Returns

UIResponse - A UIResponse object with lists of warnings, errors, and info about the success or failure of the add.

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Example #1
# Assuming you already have two schedules configured, named "A Shift" and "B Shift",
# you could create a composite schedule with the following.
system.user.addCompositeSchedule("A and B Shift", "A Shift", "B Shift", "Both A and B combined")