system.user.addCompositeSchedule
This function is used in Python Scripting.
Description​
Allows two schedules to be combined into a composite 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.addCompositeSchedule(name, scheduleOne, scheduleTwo, [description])
Parameters​
| Type | Parameter | Description |
|---|---|---|
| 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] |
Returns​
UIResponse - A UIResponse object with lists of warnings, errors, and info about the success or failure of the add. The contents of the lists are accessible from the getter methods.
getWarns()- Returns a list of warning messages that were encountered during the add.getErrors()- Returns a list of error messages that were encountered during the add.getInfos()- Returns a list of "info" messages that were encountered during the add.
These messages represent normal logging events that occurred during the add, and can be useful when trying to visualize the events that lead up to a failure.
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
# 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")