Internal Calendar Configuration
If the source of the data is internal to Deepser. So in this case it will be necessary to define the starting collection by reading the information directly from one or more areas of Deepser.
Specifically, if you create a new internal calendar, you will be asked for the following information:
Field | Definition |
name | It’s 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 the visibility to a specific group. |
status | Using this field, you can enable or disable the calendar. If the calendar is disabled, cannot be displayed in the menu. |
Sources | With this particular 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 2 sections.
A section for configuring the data collection and how to display data on the calendar and a section for configuring filters to be applied to the main collection.
Below is an example:
Using the “1” button it is possible to proceed with the addition of a new data source, which once configured will be displayed as the main element of the source field (In this the element called “Worklog” identified by the number 2).
Using the “3” button it is possible to proceed to 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”.
There will also be edit and delete buttons for both the data collection “2” and the related filters “4”.
The data source addition screen, which can be viewed following the addition click on 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 | Through this field, it is possible to give a code to the data collection used. The code can then be used on the scripting area side. |
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 | Through this scripting area, it will be possible to define the collection you intend to use and how to manage it. |
drop_code | Through this scripting area, it is defined what will happen to the event when it 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 of the calendar, where the event was dropped. |
event_name | Through this scripting area, it will be possible to define through JavaScript code, the way an event is displayed within the calendar. |
tooltip_code | Through this scripting area, it will be possible to define via JavaScript code, the tooltip that can be displayed on calendar events, and possibly configure predefined actions. |
color_code | Through this scripting area, it will be possible to define through JavaScript code, a different coloring of the events based on conditions (e.g. Based on event status). |
drop_js_code | Through this scripting area, using JavaScript code, you can define what will happen after the event is dropped. On this area for example, you can set a modal or an alert interaction to warn the user that the date will change based on where the event was dropped, or as well you can set a page reload after the event is dropped. |
The screen for adding a filter to a collection, which can be viewed following the click to add 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 | Through this field, it is possible to give a code to the filter used. The code can then be used on the scripting area side. |
status | Field to enable or disable the configured filter. |
html_element | Through this scripting area, it will be possible to define through PHP code, the mode of display and management of the filters applicable to the calendar. |
collection_code | Through this scripting area, it will be possible to define through PHP code how to apply filters to the reference collection. |
