Calendar - Configuring¶
Events¶
Custom calendar events are created, edited and deleted directly in the calendar. They are stored in the maintenance database alongside maintenance data.
When creating or editing an event, a color can be selected from a fixed set of options: ENERGY, POWER, SYSTEM, SAFETY, SECURITY, HVAC, WATER, HOLIDAY, HOLIDAYEVE and DEFAULT. These colors are defined in the CalendarColors theme in Themes.kdat.
HOLIDAY and HOLIDAYEVE carry meaning beyond appearance. See Holidays and Holiday Eves.
Editing an event:
In Week or Day view, click an existing event to open the Add/Edit Calendar Event popup. All fields can be updated. Click Save to apply the changes.
Deleting an event:
Open the event and click Remove. This removes the event permanently.
Maintenance Events¶
Maintenance deadlines from the Maintenance module are automatically shown in the calendar. They are not edited as calendar events. Changes are made to the maintenance task, either in Maint. - List or through Open editing in the calendar.
Each maintenance event is displayed on the day of its deadline. The color is set automatically based on the task's current status and cannot be chosen manually. These colors are defined in the MaintenanceColors theme in Themes.kdat and are separate from the colors used for custom calendar events.
In Week or Day view, clicking a maintenance event opens a popup showing the object, status, deadline and maintenance type. In Month view, a click on an event opens the Day view for that date instead. On WideQuick® Web, a click in Week view also opens the Day view, and the popup is opened from there. Click Open editing to open the task's edit popup directly over the calendar. Saving there updates the calendar.
| Status | Color |
|---|---|
| Planned | Yellow |
| Missed | Dark red |
| Stopped | Gray |
| Reminder | Muted olive |
Reminders¶
A reminder event can appear in the calendar a set number of days before a maintenance deadline. The reminder appears as a separate entry with the color Reminder, distinct from the deadline event itself.
Reminders are enabled by default for tasks created without a template. Tasks created from a template use that template's reminder setting, which defaults to off. The default reminder offset is 3 days. See Extending for how to change these settings.
Holidays and Holiday Eves¶
A day is marked as a holiday by creating an ordinary calendar event on it and choosing the colour HOLIDAY. A holiday eve is marked the same way with HOLIDAYEVE. A whole imported calendar can also be marked, with Change category in Edit calendars. See Managing Imported Calendars.
The event is snapped to whole days when it is saved, because a day either is a holiday or is not. A start and end time entered on the grid is widened to cover the days the event touches.
The two are kept apart deliberately. A holiday eve is usually a shortened working day rather than a closed one, so a plant often needs a different schedule for it than for the holiday itself.
Multi-day holidays work as expected. An event spanning several days marks every day it covers, not only the day it starts on.
Handing the classification to the control system¶
The calendar publishes today's classification to two internal variables in the Data Store:
| Variable | Meaning |
|---|---|
isHoliday |
True when today is covered by a HOLIDAY event. |
isHolidayEve |
True when today is covered by a HOLIDAYEVE event. |
Both are plain boolean variables and can be connected to an output the same way as any other value, so the control system can read the day type and run its own schedules accordingly. The classification is a property of the day, so one pair of variables serves every schedule rather than each time channel carrying its own copy.
The variables are written at startup and refreshed by the hourly poll and by Sync. Marking a day ahead of time therefore needs no further action, but marking today only takes effect at the next poll, or at once with Sync.
The calendar classifies the day, the control system decides what to do
The hand-off reports only which day type applies today. Which outputs change, and when, stays with the control system's own schedule logic.
Importing a Calendar¶
Import opens the Import calendar dialog, which adds events from a local .ics file. Click Select file... to pick a file from disk, then Import file.
Each imported file becomes a subscription. Every event it contributed is tagged with it, so an import can be recoloured or removed as a unit without affecting events created directly in the calendar or events from another file.
An import is rejected if its name or its path matches one that already exists. The comparison ignores surrounding whitespace and a trailing slash.
Import is available only on the server. On remote and web clients Import is disabled and marked Not available on remote systems, so that a remote client cannot reach the server's files.
An imported file is read once
A file is read at import and is not re-checked afterwards. Editing or replacing the .ics file on disk does not update the calendar. Importing the same file again is rejected as a duplicate, so remove the import in Edit calendars first, then import the file again. The new import starts with the default name, colour and filter setting.
A database carried over from a build that had the plugin can still hold subscriptions of those types. They are skipped during a sync and a note is written to the log. Their events remain in the calendar until the subscription is removed.
Managing Imported Calendars¶
Edit opens Edit calendars, which lists every import with its name and type. Select one to Rename it, Remove it, or pick a colour from the combo box and click Change category. Removing an import deletes its events from the calendar. Events created directly in the calendar are not affected.
Imports are created with the DEFAULT colour.
Changing an import to HOLIDAY or HOLIDAYEVE asks for confirmation, then marks every event of the import as a holiday or holiday eve and converts the events to whole days. The conversion is permanent. Changing the category back removes the marking, but the events stay whole-day.
Sync redraws the calendar and refreshes isHoliday and isHolidayEve at once. It does not re-read imported files.
Choosing Which Calendars Are Shown¶
Filter opens Calendar filter, which controls which imports are drawn in the calendar. The setting applies to all clients rather than to one user. Events created directly in the calendar are always shown and are not affected by the filter.
Tick the calendars to show and click Apply.
Exporting a Calendar¶
Export opens Export calendar. Tick which calendars to include, then click Generate to write an .ics file, and optionally Send by e-mail to send it as an attachment. Send by e-mail is available only after Generate, and only when SMTP is configured.
Own/internal events is listed alongside the imports, so the events created directly in the calendar can be included or left out independently. Holiday and holiday eve events are part of that group, but the export does not keep them marked. Imported into another installation, the events get the DEFAULT colour and mark no days until the import is changed to HOLIDAY or HOLIDAYEVE with Change category. That marks every event of the import the same way, so holidays and holiday eves only arrive correctly marked when they travel in separate files.
The calendar is also exported automatically every night at 03:00 to Export/WideQuickCalendar.ics, with every calendar included. Generate writes to the same file, so a selection made in Export calendar is replaced by the full calendar at the next nightly export.
Next Steps¶
- Extending — reminder configuration, the holiday variables and the subscription table





