Skip to content

Calendar

The Element type Calendar offers you the possibility to create a calendar on the dashboard to directly show events from a dataset table to your user. You can also define icons and colors for your events dynamically and statically.

Configuring a Calendar

To configure a calendar, follow these steps:

  1. Click on the search icon in the top-right corner .
  2. Search for Business Portals - Dataset List and open the page.
  3. Select the dataset you want to configure the element for.
  4. On the newly opened dataset page, execute the action Dashboard Groups.
  5. Create a new line or select an existing one. For more info about how to set up a dashboard, follow this documentation.
  6. To assign the element the calendar type, select it via the Element View Style field.
  7. To assign a dataset, select one via the Dataset Table Code field. If there are none visible, refer to this documentation on how to set up dataset tables.
  8. There is a fact box called Web Content on the page. If it's not visible, click on the info icon in the top-right corner.
  9. Execute the Edit action of the fact box.
  10. Here you can define all properties of your calendar.
  11. To show a working calendar on your dashboard, you need to at least configure the Date and Title fields.

Tip

The Calendar always starts in the Month view, except when it is disabled.

Metadata for Calendar Events

The fields Date field, Title field, Description field, and Location field allow you to choose table fields from your dataset table to display data from.

  • The Date field defines from which field the date will be used to be displayed in the calendar.
  • The Title field defines the title of the event that will be shown.
  • The Description field defines the description or subtitle that the event will include.
  • The Location field will fill in the location information if available.

If you want an iCal download, you can configure the same fields with the iCal prefix in the calendar settings.

Calendar Views

In the Calendar Views section, you can define which actions are shown in the footer or header of the calendar. The available view options include:

  • Show Header: Enables or disables the calendar's header.
  • Today View: Displays a button to jump to today's date.
  • Day View: Allows switching to a daily calendar view.
  • Weekly View: Enables the weekly calendar view.
  • Month View: Displays events in a monthly format.
  • Show All: Displays all available views.

Note

Calendar Footer Options are similar to the header options, you can configure which views appear in the footer of the calendar.

Calendar Styles

You can customize the appearance of calendar events using the following settings:

  • Appointment Background (Specific): Assigns a specific background color to appointments via an table field.
  • General Appointment Background: Sets a default background color for all appointments.
  • Appointment Icon (Specific): Allows defining a unique icon for specific appointments via an table field.
  • General Appointment Icon: Sets a default icon for all appointments.

iCal Settings

If you want to enable iCal downloads, you can configure the following fields:

  • iCal Active: Toggles iCal support.
  • Caption for iCal: Sets a label for iCal downloads.
  • iCal-Date Field: Defines the date field used in iCal.
  • iCal-Title Field: Defines the event title in iCal.
  • iCal-Description Field: Defines the event description in iCal.
  • iCal-Location Field: Sets the location information for iCal events.

See Also