Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits/style, syntax
Scripting_function


Panel
titleDescription

Allows a schedule to be edited.

Panel
titleClient 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.

Panel
titleSyntax

system.user.editSchedule(scheduleName, schedule)

  • Parameters

String scheduleName - The name of the schedule to edit. Name is case-sensitive.

 ScheduleModel schedule - The 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 edit.

  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet - Editing Schedule
# This example tries to edit the 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.
oldScheduleName = "MySchedule"
mySchedule = system.user.getSchedule(oldScheduleName)
if mySchedule != None and mySchedule.getType() == "basic schedule":
	mySchedule.setObserveHolidays(False)
	mySchedule.setName("MyEditedSchedule")
	mySchedule.setDescription("A modified description")
	response = system.user.editSchedule(oldScheduleName, 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)
else:
	print "Basic schedule", oldScheduleName, "not found."
"""The example above outputs the following:Warnings are:
None
Errors are:
None
Infos are:
Schedule "MyEditedSchedule" updated."""
Panel
titleKeywords

system user editSchedule, user.editSchedule