Skip to main content
Version: 8.1

system.user.addSchedule

This function is used in Python Scripting.

Description

Adds a 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.addSchedule(schedule)

Parameters

TypeParameterDescription
ScheduleModelscheduleThe schedule to add. Can be a BasicScheduleModel or CompositeScheduleModel object (or any other class that extends AbstractScheduleModel).

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
# This example tries to add the schedule NewSchedule based on an existing schedule MySchedule, and prints the results of the action.

# This function prints the response received.
def printResponse(responseList):
if len(responseList) > 0:
for response in responseList:
print "", response
else:
print " None"

# The main function.
mySchedule = system.user.getSchedule("Always")
if mySchedule != None and mySchedule.getType() == "basic schedule":
mySchedule.setObserveHolidays(False)
mySchedule.setName("NewSchedule")
response = system.user.addSchedule(mySchedule)
warnings = response.getWarns()
print "Warnings are:"
printResponse(warnings)

errors = response.getErrors()
print "Errors are:"
printResponse(errors)

infos = response.getInfos()
print "Infos are:"
printResponse(infos)
"""The example above outputs the following:
Warnings are:
None
Errors are:
None
Infos are:
New schedule "NewSchedule" added.
"""