Calendar events search page

The calendar events search page allows users to search for calendar event assets on a specified date or date range or search query. For example, if a user searches for the date August 14, 2020 the calendar events search page returns all events occurring on that date.

You can create a simple search page that searches a specified date, as in the example above. You can create more complex setups searching a specified date range combined with query terms searching the calendar events' description.

You can sort results by their current instance date using by using the instance_start_datetime keyword value on the Asset sorting screen’s Sorting by asset keyword value settings. These settings are similar to those for an Asset listing page. Read the Asset sorting screen documentation for more information about this feature.

Additional dependant assets

When you create a calendar events search page, several assets are automatically created beneath it, as highlighted in the figure to the right. You can use these assets to define the layout of the calendar events search page.

Default format

This bodycopy is used to define the information to be shown for each calendar event in the list of results. Initial search page layout: this bodycopy is used to define the calendar event search page’s initial layout when the user first visits the page.

Results page layout

This bodycopy is used to define the layout if results are found from the search that is being performed.

No results page layout

This bodycopy is used to define the layout if no results are found from the search that is being performed.

The default format bodycopy is similar to the one that is created under the Asset listing page. Read the Asset listing documentation for more information on this asset type.

Search fields screen

The Search fields screen allows you to add the fields used on the search page to perform the search. Read the Asset listing documentation for more information on the field styles and restrict results date range sections.

Date filter and search field grouping logic

In the Logical grouping field, you can select to either:

Match on both the date filter and search field settings

The calendar event must match the settings configured in both these sections to be displayed in the results of the calendar event search page.

Match on either the date filter or search field settings

The calendar event is only required to match one of the settings configured.

These settings include specific logical grouping for both the events date filter and search field configurations. This grouping determines how the queries entered into the filters and fields that have been created will match on the calendar event search page.

For more information, refer to the Events date filter and Search field configuration sections below.

Events date filter configuration

This section allows you to set date query fields for the calendar event search page.

Logical grouping

This field allows you to specify the search logic of the date fields configured in this section.

You can select to either:

Match on all fields

The event must match all the date field queries before it is displayed in the Calendar event search page results.

Match on at least one field

The calendar event is only required to match on at least one of the search field queries entered by the user.

This setting is similar to how the search page asset handles logic grouping for its field configuration. For more information, refer to the search page chapter in the search manual.

Allow empty searches?

This field allows you to specify whether or not a user can perform an empty or wildcard search on the calendar event search page’s configured date fields.

In other words, if the option is enabled and the use user performs a search without specifying a date, all possible calendar event assets will be returned. By default, this field is set to No.

Events filter fields

These settings allow you to add and configure the date fields for the calendar event search page. By default, no fields will be listed.

To add a new date field:

  1. Enter the name of the field in the New events date filter field

  2. Click Save

    The date field will be added to the events filter fields section, as shown in the figure below.

    The events date filter list
  3. Select the filter type for the date field in the Select filter type list

    The options available are as follows:

    Single date

    This option allows a user to search a specific date, for example, 01 Jan 2012. Selecting the include date picker check-box will provide users with a calendar pop-up on the date field, allowing them to select a date without manual input.

    Date range

    This option allows a user to search a specific date range, for example, between 01 Jan 2012 and 01 Feb 2012. Selecting the include date picker check-box will provide users with a calendar pop-up on the date field, allowing them to select a date without manual input.

    Fuzzy drop-down

    This option allows a user to select a pre-defined (or 'fuzzy') date value from a specified drop-down list. You can configure the date values that will appear in the drop-down list by selecting them in the field provided.

    The values available are as follows:

    Label Value

    Today

    today

    Tomorrow

    tomorrow

    Yesterday

    yesterday

    This weekend

    this_weekend

    Next weekend

    next_weekend

    Previous weekend

    previous_weekend

    This week

    this_week

    Next week

    next_week

    Previous week

    previous_week

    This fortnight

    this_fortnight

    Next fortnight

    next_fortnight

    Previous fortnight

    previous_fortnight

    This month

    this_month

    Next month

    next_month

    Previous month

    previous_month

    This year

    this_year

    Next year

    next_year

    Previous year

    previous_year

    Upcoming events

    upcoming_events

    Anytime

    anytime

    This/next/previous month and year selections all refer to the calendar month and year. Meaning that if Previous month was selected, and today was the 5th of March, it would list events between the 1st of Feb and 28th of Feb during the same year.

    Fuzzy check-boxes

    This option allows a user to select a pre-defined (or 'fuzzy') date value from a specified check-box list. You can configure the date values that will appear in the check-box list by selecting them in the field provided. The values available are the same as those listed in the fuzzy drop-down field information above.

You can only select one filter type for each date field in the Events filter fields settings. Selecting a new filter type in the select filter type list will change the filter type for that date field.

To delete a date field from the Calendar event search page:

  1. Select the corresponding delete check-box

  2. Click Save

You can configure a stored default search on the Details screen of the calendar events search page. When configuring this option, use the following values for the different filter types:

  • Single date filter: [DATE]

  • Date range filter: [FROM_DATE],[TO_DATE]

  • Fuzzy dropdown filter: [FUZZY_TYPE]

  • Fuzzy checkbox filter: [FUZZY_TYPE1],[FUZZY_TYPE2],[FUZZY_TYPE3], …​

All date values should be in yyyy-mm-dd format. Fuzzy date values can be found in the Fuzzy drop-down field information.

Search field configuration

This section allows you to set up search query fields for the calendar event search page.

The Allow empty searches?, search fields and exclude fields settings in this section are similar to those available on the Search fields screen of a search page. Read the Setting up the search manager documentation for more information on these fields.

Logical grouping

This field allows you to specify the search logic of the fields that have been configured in this section. You can select to either:

Match on all fields

The event must match all the queries entered to be displayed.

Match on at least one field

The calendar event is only required to match on at least one of the search field queries entered by the user.

This function is similar to how the search page asset handles logic grouping for its field configuration. For more information, refer to the search page chapter in the search manual.

© 2015- Squiz Pty Ltd