The IAP/MQ calendar object is addressed using the cal object type identifier.  An object of this type is known as a calendar.  Each calendar object contains the definition of one or more dates. When any of these dates, which can include repeating patterns and wildcards, match the current date, the calendar is considered active. Otherwise it is considered inactive.

For example, one calendar object could be used to define the days of school holidays in the current and the next calendar year. Exception schedules, defined within the schedule object type, can reference a calendar. Multiple schedule objects can reference a shared, calendar.

The calendar object supports all valid IAP/MQ object handles. A descriptive handle such as “school-holidays” is recommended.

Calendar Actions

The calendar object supports two actions: 

• create
• delete

The create action accepts a calendar configuration object with its arguments. The calendar configuration object can also be written directly with requests made in the IAP/MQ request channel. These requests can write the entire configuration object or parts of it. Items within the configuration object can be addressed directly in IAP/MQ, allowing you to change individual properties within a calendar object without writing the entire object.

The delete action requires no arguments. The delete action does not determine or resolve dependencies. For example, assume schedule S references calendar C. You can delete C without an error, but this triggers a re-evaluation of the schedules. Evaluating S does not trigger a warning ("C is not defined") as it would if C had not yet been defined. S's exception that references C will never activate until S is updated or C is created again.

The calendar object outputs a status object in the IAP/MQ feedback channel, which reports state and the optional error property.

Calendar Status Object

The calendar status object is published in the IAP/MQ feedback channel at the sts endpoint.

For example:  

Calendar Status Object Properties

Calendar Configuration Object

The calendar configuration object is published in the IAP/MQ feedback channel at the cfg endpoint. It can also be written to the same endpoint in the IAP/MQ request channel, or directly addressed to items within the configuration object, allowing you to change individual properties within an object without writing the entire object.

For example:  

Calendar Configuration Object Properties

Calendar Configuration Object Example: Holidays

The following calendar configuration object defines holidays. The listing is incomplete for brevity.