system.user.addHoliday

This function is used in Python Scripting.

Description

Allows a holiday to be added.

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.addHoliday(holiday)

Parameters

Type	Parameter	Description
HolidayModel	holiday	The holiday to add, as a HolidayModel object.

Returns

UIResponse - A UIResponse object with lists of warning, 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

Example #1

# This example adds a holiday.
def printResponse(responseList):
    if len(responseList) > 0:
        for response in responseList:
            print "", response
    else:
        print " None"
 
from com.inductiveautomation.ignition.common.user.schedule import HolidayModel
from java.util import Date
holidayName = "Groundhog Day"
d = Date(2016 - 1900, 2, 2)         # java dates start in 1900
repeatAnnually = False
myHoliday = HolidayModel(holidayName, d, repeatAnnually)
response = system.user.addHoliday(myHoliday)
     
warnings = response.getWarns()
print "Warnings are:"
printResponse(warnings)
      
errors = response.getErrors()
print "Errors are:"
printResponse(errors)
      
infos = response.getInfos()
print "Infos are:"
printResponse(infos)
 
"""The example above outputs the following:
Warnings are:
 None
Errors are:
 None
Infos are:
 New holiday "Groundhog Day" added.
"""