Skip to main content
Version: 8.3 Beta 🚧

system.user.editSchedule

This function is used in Python Scripting.

Description​

Allows a schedule to be edited.

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.editSchedule(scheduleName, schedule)

Parameters​

TypeParameterDescription
StringscheduleNameThe name of the schedule to edit. Name is case-sensitive.
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 edit. The contents of the lists are accessible from the getter methods.

  • getWarns() - Returns a list of warning messages that were encountered during the edit.
  • getErrors() - Returns a list of error messages that were encountered during the edit.
  • getInfos() - Returns a list of "info" messages that were encountered during the edit.

These messages represent normal logging events that occurred during the edit, and can be useful when trying to visualize the events that lead up to a failure.

Scope​

Gateway, Vision Client, Perspective Session

Code Examples​

Example #1
# 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."""