You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

The following feature is new in Ignition version 8.0.11
Click here to check out the other new features
This function is used in Python Scripting.


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.


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.]

  • 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

Code Examples
Code 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")


system user addCompositeSchedule, user.addCompositeSchedule

  • No labels