How to set up and use calendar widgets

What are calendar widgets?

Calendar widgets is a widget type designed for end users to get a visual overview of schedules for their site or tenancy. Schedules can be either profile or trigger schedules, also known as scheduled events.

Users can see an overview of schedules for the month, week or day in either a standard or list format for the day. If a user has the correct permissions, they can also add new schedules or edit the existing displayed schedules from the widget as well.

Profile schedules will be displayed as coloured areas on the calendar. Scheduled events will be shown as lines on the calendar as they do not have a start and end time, only a start time. There is also a red indicator on the calendar which shows the current time.

How to set up calendar widgets

First you will need a panel on a dashboard. If you aren't sure how to do this, check out our FAQ on dashboards first. Make sure your panel is a widget type and then select Calendar from the widget type dropdown in the sidebar.

Set up widget targets

You will see a basic calendar with nothing on it if you have no targets set. In the table below you will need to set up the targets that are relevant for the user that will be using the widget. The accepted target types are:

• Site
  • This will display all control schedules on the site that have no tenancy set on them such as common area schedules.
• Tenancy
  • This will display all control schedules on the site with the given tenancy set.
• Profile
  • This will display all control schedules for the given profile, regardless of the tenancy.
• Trigger
  • This will display all trigger schedules (scheduled events) for the given trigger. Note that this is the only way to display trigger schedules on the calendar as they are not included in site or tenancy targets.

Calendar settings

There are a couple of settings that can be configured for the calendar that are in the widget section of the sidebar. The first one is the default calendar view which will go straight to the specified view when the calendar is loaded on a dashboard. You can set it to go to month view by default if you prefer a broader overview for your use case or event set it up to default to day view if you prefer to check the calendar on mobile etc.

The other option is the slot duration which refers to the left side of the week and day views on the calendar where the time is displayed. A slot is the space between two lines in these views and setting dictates how long each gap represents as a time value. By default each gap is a 30 minute interval but this can be changed to 15 minutes or 1 hour slots.

This can be useful when the calendar is either too big or too small for the screen it is most commonly displayed on. If it is too big you can increase the slot duration to 1 hour which will shrink it slightly and vice versa for if it is too small (i.e. stretches too much) on the screen then you can make it a 15 minute duration instead to make the calendar fit a bit more smug on the screen.

Setting schedule colours

Profile and trigger colours have their very own section in the sidebar. There are default colour palettes used for the schedules based on your theme, but if you prefer to have your own custom colours then you can set them in the sidebar. These colours will be reflected across all views on the calendar.

This must be done after your targets are set as the colours are set per profile and trigger. You can select a profile or trigger to set up the colours for. You can select a solid, striped, gradient or preset colour type for the background which will display the relevant colour inputs for the type. The preset colour types are just the colours we use by default in case you want to re-use them yourself. You can also set the text colour here to go with the background colour.

Using calendar widgets

Editing a schedule

Users can click on a profile schedule or scheduled event on the calendar to show information about it. If they have the relevant permissions to edit the selected schedule, then the fields will be editable. After making changes and saving them, the calendar will reload with the updated schedule values.

Adding a new schedule

At the top of the calendar, there will be a new button. If the user has relevant permissions, clicking this will bring up a dialog screen which will begin the process of adding a new profile or trigger schedule if applicable.

If no profiles or triggers are able to be added, then the relevant buttons will be greyed out and not clickable.

You will have to select the profile and tenancy or schedule event to make the new schedule for in the next screen. The last screen will be the same as the edit schedule popup. After all of the relevant changes have been made and the screen is saved, the calendar will reload and the new schedule will be visible.

Filtering the displayed schedules

At the top of the calendar, to the right of the add button is a filter menu. Clicking this will display all of the schedules for the calendar. By default, they are all visible. As you uncheck the schedules from this menu, they will be hidden from the calendar. This is a great way to focus context onto one or more schedules in particular if you are just trying to focus on them.