Configuration and Users

Core Configuration

Room Bookings uses the Slot Booking framework. All of the configuration set in the Core Slot Bookings Settings also needs to be set up.

Room Booking End Point

The Room Booking configuration is held in the config.[environment].RoomBooking.getConfig end point.

Payment Configuration

The payment provider configuration in the end point is divided into three distinct sections. The first holds the configuration for your payment providers, the second adds building or room specific settings, and the third maps providers to buildings or rooms. This allows different buildings to use different settings and providers.

Providers

The supported providers are:

• Adelante (multi-item)
• Capita SCP (single item)
• PayPal

Each provider's settings are held in a dedicated object (ie one per provider). This example shows Capita configuration:

const capitaSCPConfig = {
    provider: PaymentProviders.CAPITA_SCP,
    scpId: '12345678',
    siteId: '123',
    HMAC: 'abc<--->xyz',
    HMACKeyId: '456',
    wsUrl: 'https://subdomain.e-paycapita.com/scp/scpws/'
};

Building or Room Specific Settings

Once the base provider settings have been defined, building and room specific settings can be added. 

The name of each configuration must have the format building+articleID+configName where the article ID is the ID of the building (see Buildings and Floors) or room+articleID+configName if you want to set up configuration by room.

This example shows two buildings (articles 3130 and 3040), both of which use the same underlying Capita configuration, but have their own fund codes and reference numbers:

const building3130capitaSCPConfig = Object.assign({}, capitaSCPConfig);
const building3040capitaSCPConfig = Object.assign({}, capitaSCPConfig);

building3130capitaSCPConfig.fundCode = "81";
building3130capitaSCPConfig.custRef1 = "MS - 590600204510000";

building3040capitaSCPConfig.fundCode = "81";
building3040capitaSCPConfig.custRef1 = "DH - 590600204510000";

Building to Provider Mapping

Once the configuration objects have been built up, they are then mapped to buildings.

The names of these objects must have the format building+articleID:

const paymentConfig = {
    building3130: building3130capitaSCPConfig,
    building3040: building3040capitaSCPConfig
};

Enabling Payments

Finally three top level settings enable your provider configuration:

paymentProviders: [PaymentProviders.CAPITAFS, PaymentProviders.PAYPALV2, PaymentProviders.CAPITA_SCP, PaymentProviders.ADELANTEV5, PaymentProviders.ADELANTEV6],
paymentProviderLevel: "Building",
paymentConfig: paymentConfig

When a payment form is displayed on the site, the form first looks for paymentProvderLevel, then adds the ID of the building or room that's being booked to look up the relevant payment provider and its configuration.

Metadata

There are five sets of metadata used by Room Bookings.

Users

Room Bookings defines users in the following broad categories.

Bookers

These are users who can book the room. When you create a room you can set the user groups who will be able to book it.

Administrators

These users are responsible for approving bookings and can also cancel and amend bookings. When you create a room you can set the administrator user group.

Room Managers

These users have the ability to update the room details and archive the room. They don't have access to the bookings in the room.

When you create a room you can pick the manager group from a drop-down list. The items in the drop-down are mappings to website user groups. Mappings are used so that the groups and users responsible for a room can be updated and the room doesn't become the responsibility of a single user.

Creating Room Manager Group Mappings

The drop-down list on the create a room form is populated by mappings set up in iCM using the "Room Bookings - Manage Groups" form shortcut.

The shortcut displays existing mappings, which can be edited:

When you create a new mapping you are prompted to enter a name (which will appear in the form drop-down) and pick site user groups who will be able to manage the room: