Versions Compared

Key

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


Panel
titleDescription

Allows two schedules to be combined into a composite schedule.

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.addCompositeSchedule(name, scheduleOne, scheduleTwo, [description])

  • Parameters

string name - The name of the new composite schedule.

string scheduleOne - The first schedule to combine.

string scheduleTwo - The second schedule to combine.

string description - Description of the new combined schedule. [Optional.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

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet - Creating a Composite Schedule
# 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")

Panel
titleKeywords

system user addCompositeSchedule, user.addCompositeSchedule