Please Note: This guide is only applicable to Online Appointment Booking v2. If you have acquired PPS Online Booking since October 2016 or have received an upgrade since this time then you will likely be on v3 and can find the relevant guide here.If you're not sure which version you are running then contact our support team via support@rushcliff.com
This guide is intended for use by web developers.
If you are not experienced with web design/development and do not intend to employ the services of a professional web development service we do offer a pre-made Holding Page which can be linked to your existing website for no extra charge. See an example of our holding page here: Holding Page
You can locate your own pre-made Holding Page by navigating to the clinic section of your Online Booking admin module. The holding page url will be "https://rushcliff.com/ob/" followed by whatever is entered under Short Link
In order to integrate Online Booking into a website two elements must be included, the first is two script tags and the second is the Online Booking div tag.
Below is an example of the script tags to be included.
The first <SCRIPT> tag contains the various configuration options available – the only required setting here is the container – this must match the ID of the DIV container included in the <BODY>.
The source file utilised in the second <SCRIPT> tag is the token file for this particular domain – this contains the full settings for the system, etc. Without the correct token file, the system will not load. You will need to replace it with the token file for the site in which you are integrating the Online Booking app.
The token file can be found within the Online Booking Admin Module within PPS, for more information on the Online Booking Admin Module please see the guide: Using the PPS Online Booking Admin Module
Below is an example of the Online Booking div with an ID to match the container defined in the first script tag.
Setting Custom Configurations
It is possible to configure many elements of the online booking system by creating a user configuration object
Here's what an example of a user configuration object might look like:
The explanation of these settings, as well as any other ones, is given further down in the document.
The object name being created here MUST be 'OB_conf' in order to be recognised by the system.
The user can specify their settings in a Javascript object with the name of "OB_conf", and these will normally be added to the settings the token had stored. If there is an overlap, however (i.e. setting with the same name present both in the token and the user OB_conf object), the token's setting will overwrite the user-specified setting. This is done so that the user cannot overwrite and system-critical settings.
The following settings are set via the Online Booking Admin Module, but can be overridden via the configuration object:
The following settings can be specified via the configuration object only:
Pre-configured Slot Criteria
It is possible to bypass the Location/Appttype/Practitioner selection stage and go straight to the calendar to see a list of retrieved appointments.
This can be done by specifying certain parameters in the preconfigured_slot_criteria Javascript object, like in the following example:
The table below shows the setting name for each that can be pre-configured along with a description of the setting.
Note: The actual name of the item being pre-configured must be used here rather than the display name.
Setting Custom Labels
It is possible to customise the vast majority of labels within the Online Booking System.
The full list of customisable labels and their default status is below.
