Configuring the Events App

Overview

The Events app enables the creation of a central repository for managing system-wide events, such as non-working days, in a streamlined and efficient manner.

Configuring the Events Modules

Before configuring the Events App, you will need to create a number of modules to contain the list of events categorised by types. Follow these steps:

1. Navigate to Site Configuration → Site Configuration → Modules.

2. Click Create Module.

3. Set the Type to Module.

4. Specify a Name for the module (e.g., Non-Working Days).

5. Select a Template (e.g., Without Media Settings and Audit Fields).

6. Click OK to confirm the module creation.

An additional module is required to store event types. Follow these steps:

7. Click Create Module.

8. Set the Type to Module.

9. Specify a Name for the module (e.g., Non-Working Day Type).

10. Select a Template (e.g., Without Media Settings and Audit Fields).

11. Click OK to confirm the module creation.

You will now need to create a number of fields within each module. Let's start with the Event Type module.

12. Navigate to Site Configuration → {Module} → Field Definition.

13. Click New Field.

14. Enter a Field Name.

15. Ensure the Field Type dropdown is set to Text Field.

16. Click OK to create the field.

The Event Type module can now be updated with specific options (e.g., Weekends, Bank Holidays, etc.). Now, let's configure the Events module, starting with creating a link between the Events and Events Type module:

17. Navigate to Site Configuration → {Module} → Field Definition.

18. Click New Field.

19. Enter a Field Name (e.g. Event Type).

20. Select Module from the Field Content dropdown.

21. In the Field Type dropdown, select Selectbox.

22. Locate the Module field and select the Events Type module previously created

23. Within the Module Field dropdown, select the Text Field previously created to define each type.

24. Click OK to create the field.

Next you will need to create a new field to define the start date. Follow the below steps:

Note: Currently we do not support field types date-time, week-year, month year types.

25. Click New Field.

26. Enter a Field Name (e.g. Start Date).

27. In the Field Content dropdown, select Date.

28. Locate the Skeleton field, and define the specific date format option.

29. Click OK to create the field.

Next you will need to create a new field to define the end date. Follow the below steps:

Note: Currently we do not support field types date-time, week-year, month year types.

25. Click New Field.

26. Enter a Field Name (e.g. End Date).

27. In the Field Content dropdown, select Date.

28. Locate the Skeleton field, and define the specific date format option.

29. Click OK to create the field.

Consider adding a module link field to a Module containing a list of countries to enable event classification. This step is optional. Lastly navigate to the Events module and populate it with a list of relevant events.

Configuring the Events App

To enable the Events App, follow these steps:

1. Navigate to Configuration → Apps Library from the sidebar.

2. Locate the Events App and click the card.

3. The app Name will be pre-filled with ‘Events’. Adjust to your requirements.

4. Click Events option in the side navigation

5. In the Module dropdown, select the Events module previously created.

6. Depending on your configuration we will automatically complete the remaining fields. If nothing is populated then select the Start Date, End Date and Events Type fields.

7. In the Event Type - Non Working Days dropdown, select each Event Type that classifies a non working day

8. Click Create to confirm settings.