Pre-Payment Plugin
Pre-payment plugins add an additional step to the booking process in between selecting tickets and paying.
These plugin forms are used to collect additional information from the person making the booking. Examples include address, the names of attendees, vehicle registration details, dietary requirements or company information.
Examples
You can download some ready to go plugins from the Bookings section of the Community Library.
Design Your Form
This blueprint form (ZIP, 4KB) will get you started. Download and the zip, then import the blueprint form into your forms designer. Right-click on the blueprint and choose "Create a form using". Give your form a new name and description, and on the Properties tab, change the location where it will be saved. You can read more about blueprints in Form Blueprints, Snippets and Smart Snippets.
You'll see the form design already has some fields on it. The hidden fields should be left at the top of the first page. The Action - Save to iCM and Workflow - Complete Task fields should be placed at the end of the final page of your form. Other than that, you are free to add whichever fields and as many pages as you need to your form.
This simple one page form collects vehicle details:
Adding Plugins to the Bookings Configuration
The name of your plugin form needs to be added to the plugins section of the Bookings Configuration.
Near the end of the configuration, you'll find a block of code for plugins. This will need to be duplicated for each of your plugins. You can leave values as empty strings if your plugin doesn't use them.
config.plugins.push({
"name": "Car details",
"code": "CarDetails",
"prePaymentForm": "CARDETAILSFORM",
"postPaymentWorkflow": "",
"postPaymentWorkflowVars": [],
"bookingManagementForm": "",
"eventManagementForm": "",
"occurrenceCreationEP": "",
"cancelledBookingEP": ""
})
| Property | Type | Description |
|---|---|---|
| name | String, required | The name of the plugin. This text will be displayed to the event organiser in a drop-down field as they schedule occurrences |
| code | String, required | The value of this property is not important, but it must be unique for each plugin |
| prePaymentForm | String, optional | The name of a form that should be displayed to the user prior to payment |
| postPaymentWorkflow | String, optional | The name of a workflow that should be started once payment has been taken |
| postPaymentWorkflowVars | Array (of strings), optional | An array of variable names that will be passed from the main booking workflow to the postPaymentWorkflow |
| bookingManagementForm | String, optional | The name of a form that can be used by a user from the booking overview page |
| eventManagementForm | String, optional | The name of a form that can be used by an event administrator from the event overview page |
| occurrenceCreationEP | String, optional | The full namespace of an end point to call when events using this plugin are scheduled |
| cancelledBookingEP | String, optional | The full namespace of an end point to call when event bookings using this plugin are cancelled |
Adding a Plugin to an Event
Once a plugin has been added to the configuration, it can be picked from the event scheduling form:
Plugin Data in the Event Manifest
If you build your plugin using the blueprint above, which includes a database save action form field (the object label matches the booking business key), the plugin data is available in the Event Manifest.
The plugin data is visible when you view the details of each booking. It's displayed using the read only view of the plugin form:
All of the plugin data is also available in the manifest CSV.
