Wrapping Calendar Components

Booker25 comes with a number of calendar components that can be included in your Lightning solutions. One way to include them is through the Lightning App Builder, through drag & drop. Doing so is fast and easy, but only lets you control certain attributes of the component. If you want more control over the calendars, you can consider wrapping them in your own custom components. This article explains how.

B25:multiCalendarWrapper

Property	Expected Value	Description
calendarId*	The Name of a Calendar record.	This sets the configuration based on the linked Calendar record.
view	The Unique Identifier of a View record.	This sets the currently displayed view. Make sure to choose a View record that is linked to the Calendar record, otherwise this property will be ignored.
startDate	A date string in almost any kind of format.	This sets the start date of the currently displayed view.
prototypeReservation	An object that represents a Reservation record.	Allows you to prepopulate fields on new reservations being created on the calendar, even if that field is not displayed on the reservation form. Note: you can include junctions (such as ReservationContacts) or service reservations in the prototype.
maxHeight	An integer.	The maximum pixel height that the calendar will stretch to. If the content is larger, a scroll bar will be shown.
hiddenDimensionFilters	A list of filter objects.	Sets filters on the dimension records shown in the calendar. These filters are not visible to users. See Passing Hidden Filters below.
hiddenReservationFilters	A list of filter objects.	Sets filters on the reservation records shown in the calendar. These filters are not visible to users. See Passing Hidden Filters below.
filterIdentifierPrefix	A string.	Any calendars with the same filterIdentifierPrefix will share saved filters. By default the name of the calendar record is used. This allows you to share filters between calendars or have separate filters for the same calendar.
unfilteredDimensionIds	A list of record ids.	Allows you to limit the dimension records that are displayed on the calendar. Any additional filters will never allow records outside of this list to be displayed.
isReadOnly	Boolean	When this property is set to `true`, the calendar does not allow the users to create or modify reservations. It will only display the reservations that are in the system.
availabilityFilteringEnabled	Boolean	When enabled all dimension records that are fully unavailable in the current view will be hidden.
mdaContext	MDAContext	Context for filtering MDavailabilities.

\* This property is required.

Code Sample

Below is a basic aura component that can be included on a Lightning Record page. This component shows a week view starting at a specific date, and sets the Staff lookup to a the staff record this component is placed on.

When copying this sample, keep a few things in mind:

If you want to display a different calendar, make sure to pass an existing calendar name to calendarId
Make sure that the referenced calendar is of record type Multi Resource Calendar
Make sure that the string passed to view is the unique identifier of a view that is linked to the selected calendar

Component

<aura:component implements="flexipage:availableForRecordHome,force:hasRecordId">
    <aura:handler name="init" value="{!this}" action="{!c.doInit}"/>
    <aura:attribute name="recordId" type="String" />
    <aura:attribute
        name="myPrototypeReservation"
        type="B25__Reservation__c"
    />
    <B25:multiCalendarWrapper
        calendarId="Resources"
        view="week"
        startDate="2020-12-31"
        prototypeReservation="{!v.myPrototypeReservation}"
    >
    </B25:multiCalendarWrapper>
</aura:component>

Controller

({
	doInit : function(component, event, helper) {
        component.set("v.myPrototypeReservation", {
            sobjectType: 'B25__Reservation__c',
            B25__Staff__c: component.get('v.recordId')
        });
	}
})

B25:singleCalendarWrapper

Property	Expected Value	Description
calendarId*	The Name of a Calendar record.	This sets the configuration based on the linked Calendar record.
recordId*	The id of a dimension record.	This sets the dimension record for this calendar.
view	The Unique Identifier of a View record.	This sets the currently displayed view. Make sure to choose a View record that is linked to the Calendar record, otherwise this property will be ignored.
startDate	A date string in almost any kind of format.	This sets the start date of the currently displayed view.
prototypeReservation	An object that represents a Reservation record.	This can be used to prepopulate fields on new reservations being created on the calendar, even if that field is not displayed on the reservation form. Note: you can include junctions (such as ReservationContacts) or service reservations in the prototype.
maxHeight	An integer.	The height of the calendar in pixels. The single calendar does not automatically resize based on the height of the content of the calendar like the multi calendar does.
hiddenReservationFilters	A list of filter objects.	Sets filters on the reservation records shown in the calendar. These filters are not visible to users. See Passing Hidden Filters below.
filterIdentifierPrefix	A string.	Any calendars with the same filterIdentifierPrefix will share saved filters. By default the name of the calendar record is used. This allows you to share filters between calendars or have separate filters for the same calendar.
isReadOnly	Boolean	When this property is set to `true`, the calendar does not allow the users to create, modify or delete reservations. It will only display the reservations and allow the user to navigate the calendars.

\* This property is required.

Code Sample

Below is a basic aura component that can be included on a Lightning page. This component shows a week view starting at a specific date, and sets the Staff lookup to a specific record.

When copying this sample, keep a few things in mind:

If you want to display a different calendar, make sure to pass an existing calendar name to calendarId
Make sure that the referenced calendar is of record type Single Resource Calendar
Make sure that the string passed to view is the unique identifier of a view that is linked to the selected calendar
If you want to prepopulate the Staff lookup like the code sample does, make sure to replace the Staff record id (a0h1j000001H4SkAAK) with an id of an actual Staff record that exists in your org.

<aura:component implements="flexipage:availableForAllPageTypes" access="global">
    <aura:attribute
        name="myPrototypeReservation"
        type="B25__Reservation__c"
        default="{'sobjectType':'B25__Reservation__c', 'B25__Staff__c':'a0h1j000001H4SkAAK'}"
    />
    <B25:singleCalendarWrapper
        calendarId="SingleResourceCalendar"
        recordId="a0h1j000001H3SkAAK"
        view="week"
        startDate="2020-12-31"
        prototypeReservation="{!v.myPrototypeReservation}"
    >
    </B25:singleCalendarWrapper>
</aura:component>

B25:contextAwareMultiCalendarWrapper

The contextAwareMultiCalendarWrapper allows you to display a calendar on a recordpage you put the calendar on. You can then instruct the calendar to either:

Load the record it is on as a dimension by providing recordId.
Load a record in a lookupfield as a dimension by providing recordLookupToDimension
Load a related list of the record as dimension sObject by providing dimensionRecordLookupInfo

This components saves you, in some cases, to create your own logic around the B25:multiCalendarWrapper to fetch the right data to show.

Property	Expected Value	Description
calendarId*	The Name of a Calendar record.	This sets the configuration based on the linked Calendar record.
recordId*	The id of a dimension record.	This sets the record of the page that the calendar thinks it is displayed on.
objectApiName*	The sObject API name for the recordId	This sets the sObjectType of the page that the calendar thinks it is displayed on
view	The Unique Identifier of a View record.	This sets the currently displayed view. Make sure to choose a View record that is linked to the Calendar record, otherwise this property will be ignored.
startDate	A date string in almost any kind of format.	This sets the start date of the currently displayed view.
prototypeReservation	An object that represents a Reservation record.	This can be used to prepopulate fields on new reservations being created on the calendar, even if that field is not displayed on the reservation form. Note: you can include junctions (such as ReservationContacts) or service reservations in the prototype.
maxHeight	An integer.	The maximum pixel height that the calendar will stretch to. If the content is larger, a scroll bar will be shown.
hiddenReservationFilters	A list of filter objects.	Sets filters on the reservation records shown in the calendar. These filters are not visible to users. See Passing Hidden Filters below.
hiddenDimensionFilters	A list of filter objects.	Sets filters on the dimension records shown in the calendar. These filters are not visible to users. See Passing Hidden Filters below.
filterIdentifierPrefix	A string.	Any calendars with the same filterIdentifierPrefix will share saved filters. By default the name of the calendar record is used. This allows you to share filters between calendars or have separate filters for the same calendar.
mdaFilteringEnabled	Boolean	Will hide any sObjects that are not available because of availabilities. If you use multi dimensional availabilities it will use the record passed through recordId as the context for the multi dimensional availabilities.
isReadOnly	Boolean	When this property is set to `true`, the calendar does not allow the users to create, modify or delete reservations. It will only display the reservations and allow the user to navigate the calendars.
recordLookupToDimension	String	The api name of the field on the record specified by recordId that contains the Id of the record that should be used as dimension record.
dimensionRecordLookupInfo	String	The api name of the related list sObject + the lookup on the related sObject to the primary sObject. For example on Resource type you could provide B25__Resource__c.B25__Resource_Type__c

\* This property is required.

Code Sample

Below is a basic aura component that can be included on a Lightning page. This component shows a week view starting at a specific date, and sets the Staff lookup to a specific record.

When copying this sample, keep a few things in mind:

If you want to display a different calendar, make sure to pass an existing calendar name to calendarId
Make sure that the string passed to view is the unique identifier of a view that is linked to the selected calendar
If you want to pre-populate the Staff lookup like the code sample does, make sure to replace the Staff record id (a0h1j000001H4SkAAK) with an id of an actual Staff record that exists in your org.

<aura:component implements="flexipage:availableForAllPageTypes" access="global">
    <aura:attribute
        name="myPrototypeReservation"
        type="B25__Reservation__c"
        default="{'sobjectType':'B25__Reservation__c', 'B25__Staff__c':'a0h1j000001H4SkAAK'}"
    />
    <B25:contextAwareMultiCalendarWrapper
        calendarId="ResourceCalendar"
        recordId="a0h1j000001H3SkAAK"
        objectApiName="B25__Resource__c"
        view="week"
        startDate="2020-12-31"
        prototypeReservation="{!v.myPrototypeReservation}"
    >
    </B25:contextAwareMultiCalendarWrapper>
</aura:component>

Passing Hidden Filters

You can pass a list of filter objects to the properties hiddenReservationFilters (available on both single and multi calendars) and hiddenDimensionFilters (available only on multi calendars). These properties control which records are visible on the calendar. Because they are hidden, the user can’t change them and they will always apply.

Each item in the list is expected to have the following properties:

Property	Description
fieldName	The API name of the field being filtered.
operator	The operator being applied. Valid values are: '=', '!=', '>', '<', '<=', '>='.
value	The value being compared against.
displayedValue	(Optional) The value being displayed to the user. This is useful for lookups, where the passed value is a record id, but you might want to display the record name to the user instead.

<aura:component implements="flexipage:availableForAllPageTypes" access="global">
    <aura:attribute
        name="myFilters"
        type="Object[]"
        default="[{'fieldName':'Name', 'operator':'=', 'value':'Nice'}]"
    />
    <B25:multiCalendarWrapper
        calendarId="Resources"
        view="week"
        startDate="2020-12-31"
        hiddenDimensionFilters="{!v.myFilters}"
    >
    </B25:multiCalendarWrapper>
</aura:component>

Filter Groupings

Filters can be grouped by using a logicalOperator, allowing you to do AND and OR statements in the grouping. For Example:

{
  type: 1,
  logicalOperator: 'OR',
  subFilters: [
    { 'fieldName': 'Name', 'operator': '=', 'value': 'Awesome'},
    { 'fieldName': 'Name', 'operator': '=', 'value': 'Nice'}    
  ]
}

The following properties are required

Property	Description
type	Indicates that it is a grouping, all belonging in the same logicalOperator
logicalOperator	Either AND or OR. Indicating if the filters should both be true (AND) or one of them should be true (OR)
subFilters	A list of hiddenFilters as described in the passing hidden filters section above.

The example below is more complex, it shows resources that are marked Active AND that have a name Awesome OR Nice.

/* calendar.cmp */
<aura:component implements="flexipage:availableForAllPageTypes" access="global">
    <aura:handler name="init" value="{!this}" action="{!c.doInit}" />
    <aura:attribute
        name="myFilters"
        type="Object[]"
    />
    
    <B25:multiCalendarWrapper
        calendarId="Resources"
        view="week"
        startDate="2020-12-31"
        hiddenDimensionFilters="{!v.myFilters}"
    >
    </B25:multiCalendarWrapper>
</aura:component>

/* calendarController.js */
({
  doInit: function (cmp, event, helper) {
    var recordId = cmp.get('v.recordId');
    cmp.set('v.myFilters', [
        { 'fieldName': 'B25__Is_Active__c', 'operator': '=', 'value': 'true'},
        {
            type: 1,
            logicalOperator: 'OR',
            subFilters: [
                { 'fieldName': 'Name', 'operator': '=', 'value': 'Awesome'},
                { 'fieldName': 'Name', 'operator': '=', 'value': 'Nice'}       
            ]
        }
    ]);
  }
})

MDAContext

Property	Expected Value	Description
enabled	Boolean	If the MDA filtering is enabled
context	Map<String, List<Id>>	A Map of The availability lookups on the Availability record to a list of ids. Availabilities will only be included if the lookup specified matches any of the provided ids.
subtreeContext	Map<String, List<Id>>	Works in the same way as the normal context however will not be take into account if the availability is an unavailability

On this page