Configure Internal Calendars
When your calendar data originates from within Deepser, you can configure an internal calendar to read information directly from one or more areas of the platform. This page explains how to create an internal calendar and define its data sources and filters.
Calendar Fields
When you create a new internal calendar, configure the following fields:
| Field | Definition |
|---|---|
| Name | The name of the calendar. This name will be displayed on the Deepser menu on the right. |
| Position | Using this field, you can decide the calendar position in the right menu. |
| Description | Descriptive field |
| Icon | Icon related to the type of calendar you configure |
| Enabled Groups | With this field, you can add visibility to a specific group. |
| Status | Using this field, you can enable or disable the calendar. If the calendar is disabled, it will not be displayed in the menu. |
| Sources | With this field, you can configure the data source for your calendar and set filters too. |
Source Configuration
The configuration of the source of an internal calendar is divided into two sections: one for configuring the data collection and how to display data on the calendar, and another for configuring filters to apply to the main collection.
Below is an example:
Using the "1" button, you can add a new data source. Once configured, it will be displayed as the main element of the source field (in this case, the element called "Worklog" identified by the number 2).
Using the "3" button, you can add a new filter on the previously configured collection ("2"). Once the filter is configured, it will appear as a sub-item of the main collection "4".
Edit and delete buttons are available for both the data collection "2" and the related filters "4".
The data source addition screen, accessible by clicking the "1" button, will consist of the following fields:
| Field | Definition |
|---|---|
| Name | With this field, you can give a name to the data collection used. |
| Code | You can assign a code to the data collection. The code can then be used in the scripting area. |
| start_date_field | This field indicates the field name used to identify the start date of a calendar event according to the collection used. |
| end_date_field | This field indicates the field name used to identify the end date of a calendar event according to the collection used. |
| Status | Field to enable or disable the data source used. |
| collection_code | In this scripting area, you define the collection you intend to use and how to manage it. |
| drop_code | In this scripting area, you define what happens when an event is dragged and dropped on the calendar. You can set the fields that represent start and end date on the collection with the new start or end date where the event was dropped. |
| event_name | In this scripting area, you use JavaScript code to define how an event is displayed within the calendar. |
| tooltip_code | In this scripting area, you use JavaScript code to define the tooltip displayed on calendar events, and optionally configure predefined actions. |
| color_code | In this scripting area, you use JavaScript code to define different event colors based on conditions (e.g., based on event status). |
| drop_js_code | In this scripting area, you use JavaScript code to define what happens after an event is dropped. For example, you can set a modal or an alert to warn the user that the date will change, or trigger a page reload after the event is dropped. |
The screen for adding a filter to a collection, accessible by clicking the "3" button, will consist of the following fields:
| Field | Definition |
|---|---|
| Name | With this field, you can give a name to the filter used. |
| Code | You can assign a code to the filter. The code can then be used in the scripting area. |
| Status | Field to enable or disable the configured filter. |
| html_element | In this scripting area, you use PHP code to define the display and management of the filters applicable to the calendar. |
| collection_code | In this scripting area, you use PHP code to define how filters are applied to the reference collection. |
Related Articles
- Calendar Configuration Example -- Step-by-step Worklog Calendar example
- Calendar Usage -- Access and use configured calendars
- External Calendar Configuration -- Connect to Google or Outlook calendars