Calendars

A calendar is an entity type that allows the developer to display the app's data in a calendar-like view. A calendar view can combine filters, one or more event layers, and predefined durations that control how the time axis is displayed.

Calendar views are useful when users need to understand data by date or time, such as activities, appointments, reservations, tasks, or any other records that have a start and end date.

How to use

In order to create or edit calendars, open the Develop app, click the main menu and select Calendar views. In the page that opens, click the Add button, or select an existing calendar and click the Edit button.

After the calendar is configured, add it to a menu so users can open it from the application navigation.

Designer

Fields in the sidebar:

Entity diagram:

CALENDAR tab

The Calendar tab defines the main calendar settings: the internal identifier, the user-facing title, the visible time range, and the default interaction behavior.

1. Name - The internal identifier of the calendar configuration. It is used by the application to identify the calendar view.
2. Title - The title displayed to users in the interface.
3. Has resources - Enables resource-based calendar views. This is intended for calendars that display events grouped by resources, such as employees, rooms, tables, equipment, or similar schedulable items.
4. Hide default durations - Hides the standard duration views. When enabled, the calendar does not show the default views such as Month, Week, Day, or Agenda; only the custom views configured in the Duration tab remain visible.
5. Min time - The first time displayed in day and week views. For example, 08:00 displays the calendar starting from 08:00.
6. Title - The title of the input field displayed to the user.
7. Argument name - The name of the argument used by the filter.
8. Input type - The input type displayed to the user.
9. Catalog - The catalog used by list-based input types.
10. Operator - The filter operator.
11. Property name - The property on which the operator is applied.
12. Default value - The initial default value.
13. UUID - The unique identifier of the filter row in the database.

Tab entity diagram:

LAYERS tab

Fields in the layers table:

The Layers tab configures the calendar data source. A layer defines which records become events, how those events are displayed, and what happens when the user opens or interacts with an event.

Layer details

1. Name - The internal name of the layer. It is used in configurations.
2. Description - A description for administrators or developers.
3. Color - The default color of events from this layer.
4. Calendar view - The calendar where the layer is displayed. For example, calendarActivities.
5. Detail property - An additional property from the fetched entity that can be used as event detail text.

Event

1. Event ID property - The property that contains the unique event identifier.
2. Event detail property - The property that contains the representative event text shown to users.
3. Start date property - The property that contains the event start date and time.
4. End date property - The property that contains the event end date and time.

Resource

Resource fields are used when the calendar displays events grouped by resources.

1. Resource ID property - The property that links the event to a specific resource.
2. Resource text property - The property displayed as the resource label, such as an employee name, room name, table, or equipment name.
3. Resource color property - The property used to color events associated with the resource.

Actions

1. Edit view - The edit view opened when the user clicks an event.
2. Workflow - The workflow that can be executed for event interactions such as click, create, move, or edit, depending on the application configuration.
3. UUID - The unique identifier of the layer configuration row in the database.

Tab entity diagram:

DURATION tab

Fields in the durations table:

The Duration tab defines the custom calendar views available to users. A duration controls how much time is visible, how the time axis is divided, and which header rows are displayed.

1. Text - The label displayed to users for this calendar view. Examples: Month, 6 months, Year.
2. Duration - The amount of time covered by the view.
3. Duration type - The unit used by Duration. Examples: months, years.
4. Slot format row 1 - The first row displayed in the time-axis header. Each configured row becomes a separate level in the header.
5. Slot format row 2 - The second row displayed in the time-axis header.
6. Slot format row 3 - The third row displayed in the time-axis header.
7. Slot duration - The size of each time cell in the timeline. For example, slot duration 1 with slot duration type days means that each slot represents one day.
8. Slot duration type - The unit used by Slot duration. Example: days.
9. Is selected - Marks the duration as the initial selected view when the calendar opens.

Common slot format values:

Duration examples:

Tab entity diagram: