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.
| Article Extra | Standard Setting | Description |
|---|---|---|
| Form to gather data | Book a birth/death/marriage etc | These forms are used to book appointments. Registrars has standard forms for each of the appointment types. Pick the form that corresponds to this appointment |
| Comms Template Manager application | Registrars | This application holds all of the templates used in emails etc |
| Template to use | Birth/death/marriage etc | Pick the template for this appointment type |
| Look-aheads | Yes | This setting allows the booking forms to find the next x number of available time slots. The number returned is set in the End Point for this appointment type |
| Processing | Yes | Once an appointment of this type has been booked, a registrar clicking on the booking from the calendar will start the check-in/assign/start/conclude process. If "No" clicking on an appointment allows the user to view the details and cancel it |
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.
| Property | Type | Description |
|---|---|---|
| registrarGroup | String | The site user group registrar users belong to |
| systemRegistrar | String | The system registrar user, used for registrar related workflow actions |
| notAttendedTimer | Integer (seconds) | The time after the start of the appointment it should be marked as not attended |
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.
| Property | Type | Description |
|---|---|---|
| appointmentLength | Integer (minutes) | The base appointment length |
| durationPerBaby | Integer (minutes) | Only used in birth registrations and re-registrations. The appointmentLength property should be set as 0 and a duration per baby entered instead |
| translatorDelay | Integer (minutes) | The amount of time to add onto the appointment if an interpreter is present |
| upcomingAppointmentsToGet | Integer | The number of future appointments to load on the booking forms |
| maxDaysKPI | Integer (days) | The target number of days to offer an appointment within |
| slotType | String | The name of the appointment |
| slotBookingId | Integer (article ID) | The article ID (using the Slot Booking template) this type can be booked onto |
| slotTypeId | Integer (article ID) | The article ID (using the Slot Type template) for this slot type |
| minDaysSince | Integer (days) | The number of days since the birth/death and earliest the appointment can be booked |
| maxDaysSince | Integer (days) | The maximum number of days since the birth/death and the appointment offer |
| contactNumber | String | A contact number for this appointment type (used on the notification emails) |
| enableSMS | Boolean | If true, and templates have been set up for SMS messages (create, cancel and reminder), bookers will have the option to receive SMS messages when they make their booking |
| paymentOptions | Object | The properties in this object will vary by appointment type |
| paymentOptions.paymentEnabled | Boolean | set false to disable payment on the booking forms |
| paymentOptions.baseCost | Integer | The base cost |
| paymentOptions.appointmentCost | Integer | The cost of the appointment |
| paymentOptions.postage | Integer | The postage cost |
| paymentOptions.costPerCertificate | Integer | The certificate cost |
| paymentOptions.firstCertificateCost | Integer | The certificate cost |
| paymentOptions.secondCertificateCost | Integer | The certificate cost |
| paymentOptions.localCostPerCertificate | Integer | The certificate cost |
{
"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.
| Role | Groups | Notes |
|---|---|---|
| Registrar | SLOTBOOKINGUSER, SLOTBOOKINGREGISTRAR | Both are groups are named candidates in process models so must match and cannot be edited. The group names are also added to the main Registrars and Bookings configuration End Points These users are able to create and manage bookings directly from the registrars calendars |
| Customer Service Agents | CSA_GENERAL | Set in the main Registrars configuration End Point These users get ready only access to the calendars and can search for appointments |
| Members of the public | CITIZEN or SLOTBOOKINGUSER | The booking process can be started by the anonymous user, users in a group called SLOTBOOKINGUSER, or users in a group called CITIZENS |
Share this page
