Seekom VenueRez Front Booking Screens

Once the option is enabled inside your iBex account, a new menu item called Venues Website Booking Templates will be available.

Please forward this information on to your Web Developer or someone with knowledge with JavaScript and HTML.  We recommend to create a new staff user in iBex for your website designer. Click here for more details. 

Structure

The Seekom VenueRez Front Bookings Screens (VFBS) is designed to be linked to from your website or embedded inside an iFrame onto your website. 

Customisation is limited to the options and custom CSS provided on the screen. For greater control over the screen, see the Advanced Install below.

Browser Support

• Chrome
• Firefox
• Safari 10+
• Edge
• IE 11 / Safari 9 (supported for now, but may be dropped later)

IE 10 and below are not supported.

Authorised Websites

You must tell iBex what website you will be running the VFBS on. If there are multiple versions (such as a private development website and a live production website) add each of them to iBex.

Any websites not listed here that install your Venues FBS will not load correctly.

Template Configurations

Select which property you wish to create a front booking screen for from the Property drop down list  

 This will then load the Configure Template section

Configure Template

A range of select boxes will now appear

Theme: Switch between either light or dark text (depending on the shade of your website)

Home Page Icon: To override the default image on the first screen you can add in a URL to your chosen home image

Show Agent Login: Yes means the login link will appear on the booking screen, No means the link will be hidden

Show Deposit: Select Yes if you want the deposit to show in the booking summary, No means it will be hidden

Default Capacity: The number entered here will be pre populated on the front booking screen, customers are able to override and put in another number if required

Default Start Time / End Time: The min / max times which will appear on the front booking screen time selectors

In order for your custom fields to appear on the front booking screen they will need to be mapped here

Example on the 'Catering Required' field select the custom field you have previously set up from the dropdown box

1. Pick which Custom Field the extra features are mapped against.

Note: Custom Fields are not required, but are needed to collect extra information. If you want to collect any of the following (Catering Required, Room Layout, Site Inspection Required or Accommodation Required etc) you must have the Custom Fields option enabled. Contact us to set these up.

Custom CSS allows you to hide fields, change the background colour, login text size etc

Remember to

Advanced

In the Advanced section you are able to add in your own room layout icons by adding in the images URL

Below this is all the possible labels that can be changed.

Amend to whatever you need your new labels to be and this will be displayed on the front booking screen

Once you are happy with your changes select the 'Save Changes' button

Install Code

You will now be able to create your venue front booking screen by the Popup URL, Button or iFrame Code.

Generating VFBS Code

Themes & Styles

The fonts and colours are inherited from your website's styles. CSS can be applied on your own website to adjust almost anything inside the VFBS.

If you want to have more fine grained control on initialising your VFBS, you can use the Advanced Install option.

All you have to do is copy the whole code inside and paste it betwwen your pagestag.

Save and publish your website, and the VFBS should be running. If it does not load, open up your browser's console and check for any warning or error messages.

Advanced Setup

window.iBexVenueFBS is exposed to interact and control the VFBS. Actions made before the script is loaded will be delayed until after it has loaded.

Set Options

iBexVenuFbs.push(['options', {
// Options can be set here
}]);

The set options call will override all set options in the VFBS. It should only set set once, at the initial load.

Available options can be found in the table below. 

Boot

iBexVenueFbs.push(['boot', 'ibex-app']);

Boot is run once, to start the VFBS. If you want to prevent the VFBS from loading until a button is pushed, you can use this script to do it.

Options List

Option	Required	Type	Default Value	Description
client	Yes	String		The ID of the account. This is required in the initlisation script.
key	Yes	String		A unique key for this particular VFBS. This is required in the initlisation script and is generated on the template page.
propertyId	Yes	Integer		The ID of the Venue property account. It is required.
countryId	Yes	Integer		The ID of the Country the property belongs to. It is provided by the template page.
accommodationCustomFieldId	No	Integer		The ID of the iBex Custom Field that holds the flag whether this booking requires accommodation or not
siteInspectionCustomFieldId	No	Integer		The ID of the iBex Custom Field that holds the flag whether this booking requires a site inspection or not
cateringCustomFieldId	No	Integer		The ID of the iBex Custom Field that holds the flag whether this booking requires catering or not
layoutCustomFieldId	No	Integer		The ID of the iBex Custom Field that holds the layout that the customer has selected
onTheDayContactName	No	Integer		The ID of the iBex Custom Field that holds the name of the contact on the day
onTheDayContactNumber	No	Integer		The ID of the iBex Custom Field that holds the name of the contact on the day's number
functionName	No	Integer		The ID of the iBex Custom Field that holds the function name
agentId	No	String		The iBex agent ID which the rooms/rates should be read from.
showAgentLogin	No	Boolean	False	If true, agents will be able to log into the VFBS and book under their own rooms/rates
startTime	No	String	'07:00'	The default time bookings will start from
endTime	No	String	'17:00'	The default time bookings will end at
zeroCostExtraText	No	String	'Free'	The text shown to customers when an extra has a $0 price
holdButtonText	No	String	'Hold'	The label on the "Hold" button.
bookButtonText	No	String	'Book + Confirm'	The label on the "Book" button
capacityLabel	No	String	'People'	The label identifying people/capacity
eventStartLabel	No	String	'Event Start'	The label for when the event will start
eventEndLabel	No	String	'Event End'	The label for when the event will end
capacityValue	No	Integer	10	The default number of people shown in the selectors
base-theme	No	String	'dark'	Either 'dark' or 'light'. Controls some basic colouring whether the VFBS is a dark background or a light background.
bookConfirmCallback	No	Function		Provide a function that is called whenever a booking is completed. Can be used for custom analytics tracking
homePageImg	No	String	Default Image	The url/path to the image that will be used as the homepage background image
onRequestMode	No	Boolean	false	If true, this will mean that all 'hold' bookings will be treated as 'On Request'. This means that the booking will be on 'hold' but will not take availability.
onRequestButton	No	String Path	'On Request'	The button text when 'onRequestMode' is set to true
homePageBannerText	No	String	'Tailored Solutions for Your Events'	Text found on the Banner on the homepage
homePageTitle	No	String	'Select Event'	This will be used in breadcrumbs; Title of the homepage
bookPageTitle	No	String	'Select Package'	This will be label in breadcrumbs for booking page
detailsPageTitle	No	String	'Book and Hold'	This will be the label in breadcrumbs for the bookier detail page
homePageSubmit	No	String	'FIND VENUES'	This is the label used in the homepage submit button
bookPageSearchButton	No	String	'Search'	The label for the 'Search' button on booking page
addCateringButton	No	String	'Add'	The label for the button to add catering
removeCateringButton	No	String	'Remove'	The label for the button to remove catering
addCateringButtonMobile	No	String	'Add Catering'	The label used for the button to add catering in mobile (cannot just use 'Add' since there is no context for the layout in mobile)
removeCateringButtonMobile	No	String	'Remove Catering'	The label used for the button to remove catering in mobile (cannot just use 'Remove' since there is no context for the layout in mobile)
extrasButton	No	String	'View Extras'	The label used in button to view extras
agentLoginLink	No	String	'Corporate Sign In'	The text used for the link to login as agent/company
agentLogoutLink	No	String	'Logout'	The text used for the link to logout logged in user
roomCost	No	String	'Room Cost'	The text used to label Room Cost in booking page
total	No	String	'Total'	The text used to label the total to be paid when room is booked
extras	No	String	'Extras'	The text used to label the total of the extras that was chosen in extras modal
catering	No	String	'Catering'	The text used to label 'Catering'
deposit	No	String	'Deposit'	The text used to label Deposit needed to be payed when booking the chosen room
breadcrumbBack	No	String	'Back'	The label for the back button on the breadcrumbs on top of page
loginBanner	No	String	'Corporate Sign In'	The text in the header found when login modal is opened
formAgent	No	String	'Agent ID'	The placeholder for the agent login field
verifyButton	No	String	'Verify'	The label on the button to verify agent
usernameText	No	String	'Username'	The placeholder for the username field when logging (only for agents using username and password as part of login)
passwordText	No	String	'Password'	The placeholder for the password field when logging (only for agents using username and password as part of login)
credentialsButton	No	String	'Submit'	The label used for the submit button when username and password is used
codeText	No	String	'Code'	The placeholder for the code field when logging (only for agents using code as part of login)
codeButton	No	String	'Submit'	The label used for the submit button when only code is used
siteInspection	No	String	'Site Inspection Required?'	The label used for the 'Site Inspection' field
accomodationRequired	No	String	'Accommodation Required?'	The label used for the 'Accommodation Required' field
aboutUs	No	String	'How did you hear about us?'	The label used for the field that asks how you heard about us
bookDetailsHeader	No	String	'Booker Details'	The label used for header in Booking Form
formName	No	String	'Name'	The placeholder for 'Name' field
formEmail	No	String	'Email'	The placeholder for 'Email' field
formPhone	No	String	'Phone Number'	The placeholder for 'Phone' field
formComment	No	String	'Comment'	The placeholder for 'Comment' field
formAddress	No	String	'Address'	The placeholder for 'Address' field
formTown	No	String	'Suburb/Town'	The placeholder for 'Town' field
formCity	No	String	'City/Region/State'	The placeholder for 'City' field
formZip	No	String	'Post/Zip Code'	The placeholder for 'Zip Code' field
formOnTheDayContact	No	String	'On the day contact name'	The placeholder for the 'On the day contact name' field
formOnTheDayPhone	No	String	'On the day contact phone number'	The placeholder for the 'On the day contact phone number' field
formFunctionName	No	String	'Function Name'	The placeholder for the 'Function Name' field
formArrivalTime	No	String	'Arrival Time'	The placeholder for the 'Arrival Time' field

Booking Confirmation Callback

The bookConfirmCallback setting can be given a callback function that will be execute when a booking is completed. It can be used to integrate with different tracking tools, such as Google Analytics.