Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Allows a schedule to be added.

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

 AbstractScheduleModel schedule - The schedule to add.

  • Returns

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

  • Scope

All

Code Examples
Code Snippet
# 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)

Output
Warnings are:
 None
Errors are:
 None
Infos are:
 New schedule "NewSchedule" added.

 

  • No labels