Configuration

Registrars configuration is split between the core Slot Booking configuration, the main Registrars configuration (including KPIs) and configuration for each appointment type.

Articles

For a full description of the article extras, see the Slot Booking documentation. The following settings should be used for Registrars.

Slot Types

The Slot Type template describes the appointments that can be booked. Create an article for each appointment type.

Slot Book Calendars

The Slot Book template provides the calendars for individual registrars. Create an article for each calendar you need. In the article extras the "Create Appointment Form" and "View Appointment Form" should use the registrars specific versions. All other options can be set as needed, following the main Slot Booking documentation.

Slot Booking Calendar Overview

This is the article that groups registrar (Slot Book) calendars into the main registrars calendar interface. You'd normally have a single article, secured to the SLOTBOOKINGREGISTRAR user group.

Relate all of your registrar calendars (article using the Slot Book template) to this article. The "Create Appointment Form" and "View Appointment Form" article extras should use the registrars specific versions.

End Points

Configuration is split between the core booking engine, registrars, and individual appointment types.

Bookings

The following are set in the config.<environment>.BookAndPay.getConfig End Point.

let registrars = {};
registrars.registrarGroup = "SLOTBOOKINGREGISTRAR";
registrars.systemRegistrar = "REGISTRAR";
registrars.notAttendedTimer = 600;

Registrars

The config.environment.Registrars.getConfig End Point holds the main configuration for Registrars and the values used for reporting and performance. The End Point itself is fully documented.

Appointments

Each appointment type has its own configuration, holding broadly similar settings. These are found in the config.<environment>.Registrars End Point group, for example config.dev.Registrars.BirthRegistration.getConfig.

{
    "appointmentLength": 15,
    "durationPerBaby": 15,
    "translatorDelay": 15,
    "upcomingAppointmentsToGet": 5,
    "maxDaysKPI": 5,
    "slotType": "Registration of Birth",
    "slotBookingId": 1440,
    "slotTypeId": 2071,
    "minDaysSince": 0,
    "maxDaysSince": 42,
    "contactNumber": "01234 567 890",
    "enableSMS": true,
    "paymentOptions": {
        "paymentEnabled": true,
        "baseCost": 0,
        "appointmentCost": 10,
        "postage": 0
    }
}

Users

Registrars defines the following user roles. Users must be created in the relevant groups. Where these groups are configured is also described in the table below.