Plugin Documentation

Detailed documentation about all features and settings of Appointment Booking Calendar.

How it works?

From the dashboard/configuration area the process is as follows:

  1. Insert data fields into the form
  2. Configure the calendar time-slots, availability, prices, form processing, emails and PayPal settings if needed
  3. Publish the form from a post or page (go to edit posts/pages or to the widgets area).

From the end user (visitor) point of view, the process is as follows:

The website's visitor will reach to the form where the first step will be to select the date and after clicking the date a floating dialog will be displayed for selecting the time slots available for the clicked date.

After selecting the date and filling the other form fields (phone, name, email and open comments field) the visitor will click "continue".

If the PayPal payment was enabled, the customer will be automatically redirected to PayPal to make the payment and confirm the booking. After completed the PayPal payment the booking will become automatically confirmed, the time slot selected will become unavailable and two emails will be sent: a notification email to your email address and a confirmation/thank you email to the customer that completed the payment.

If the PayPal wasn't enabled, the customer will be redirected to a "thank you" page and the notification/confirmation emails will be sent immediately.

You will be able to check the booking details from the WordPress administration area (Appointment Booking Calendar Settings) by clicking on the selected time slot and also into the bookings list with options to export the bookings to CSV/Excel files and to iCal files.

Installation

To install the WordPress plugin follow these steps:

  1. Download the plugin to your computer.
  2. Go to the plugins section in WordPress
  3. If has been installed installed another version of the plugin, deactivate it, and then press the corresponding "Delete" button.
  4. Press the "Add New" button at top of section.
  5. Press the "Upload Plugin" button, and select the zipped file downloaded in the first step.
  6. Finally, install and activate the plugin.

Inserting the form on Page

  1. Configure the settings at the administration menu >> Settings >> Appointment Booking Calendar.
  2. To insert a form into some pages or posts, uses the icon that will appear when editing contents:

    Insert Form

  3. After doing that, the tag [CPABC_APPOINTMENT_CALENDAR calendar="1"] will be inserted into your content. The "id" is optional, if not specified the first form will be used. When you preview the content in the public website that tag will be replaced by the reservation form:

    Form

Managing Forms

After going to the WordPress administration menu >> Settings >> Appointment Booking Calendar you will see the list of forms/calendars like in the following image:

Forms List

For each form you will see the following options:

  • ID: Identification number of the calendar/form, useful when publishing an specific calendar or form.
  • Calendar Name: Some name to identify the calendar/form.
  • Owner: WordPress user that can edit the calendar. An user with "Editor Access Level" will see/manage only its own calendars.
  • Published: Specify if the calendar can be published.
  • iCal Link: Link for the feed in iCal format. Use this link to export the reservations to another calendar that supports this iCal: OutLook, Google Calendar, etc...
  • Update: Update the specified name, owner and public status for the calendar.
  • Manage Settings: Go to the main settings area for the calendar.
  • Bookings List: Printable list of bookings.
  • Clone: Duplicate a calendar with its settings.
  • Delete: Delete the calendar and all its bookings and settings.
  • Shortcode: An alternative way for publishing the calendar.
Defining the available time-slots

To define the available time slots go to the "WordPress administration menu >> Settings >> Appointment Booking Calendar >> Manage Settings" and you will see a calendar area like this one:

booking calendar slots

The first step is to un-check the non-working days, for example Sunday and Saturday.

The second step (important!) is to click on each weekday tab and add the time slots available for each day. Each time slot has a defined capacity (number of bookings it will accept), you can indicate that in this step. There are options to add many time slots in one single step.

There is also a "Restricted Dates" tab that allows disabling specific days, for example holidays and a "Special Dates" tab for overwriting the available time-slots for specific dates.

Finally you can click a date and manually add appointments or check the appointments made into the selected date. Time slots with at least one appointment added will be shown strike-out. Click a time slot to see/edit/delete its appointments. To delete an appointment click the button "clear" and then "submit".

Below the calendar there are several configuration settings that are explained in the section below.

Check the submissions

Press the "Bookings / Contacts" button, corresponding to the calendar/form. The messages screen displays the list of submissions, and a filtering section to reduce the submissions by form, a time interval, or a text in the data

From the messages screen it is possible remove a submission, or submissions group, change its status to paid/unpaid and also export all submissions to a CSV file

Export the submissions to a CSV File

For exporting the submitted information to a CSV file, press the "Bookings / Contacts" button corresponding to the calendar/form, and press the "Export to CSV" button, select the location where will be saved the CSV and that's all. The first row of CSV file allows identify each of fields, the text used to identify the field will be the short label, defined in the field, or the label in case that the short label is not defined.

Blocking / Unblocking a Specific Date

You can block a slot by clicking on the date (in the settings area), click the time-slot and enter the block reason.

You can also restrict a whole day using the "Restricted dates" tab.

Another alternative is to overwrite the available slots for specific days using the "Special Dates" tab.

The Form Builder

Enable the form builder in the "troubleshoot area" located below the list of calendars and after that a visual form builder will appear on each calendar settings page to visually add/modify fields and set the validation rules.

The Form Builder lets you to add/edit/remove fields into the form and also to specify the validation rules for your form (required fields, email fields, etc...).

Form Builder

Form title and predefined designs

The "Form Settings" tab allows define the form's title and description, as the placement of labels respect the fields (at top, at left, aligned to the right). In the "Form Settings" tab is possible to decide the form's design. The plugin includes multiple predefined designs.

Form Settings Tab

The following field types are currently available(*):
  • Single Line Text: Classic text input.
  • Number: This field can validate if only digits or a valid number was entered.
  • Slider: Numeric field whose value is modified sliding a handle.
  • Currency: A classic input field for currency values, that allows separator for thousands, and currency symbols.
  • Hidden: A hidden field.
  • Email: This field validates that the email address has a valid format.
  • Date/Time: Date-picker. Can be setup also to show also a selectable year and month, for example for birth date fields, and time fields.
  • Checkboxes: Classic checkboxes, select one or more on a group.
  • Multiple Choice: Radio buttons, select one of many.
  • Dropdown: Classic select / dropdown field.
  • Upload File: For uploading files.
  • Password: A field that shows * instead the typed letters. You can also add a confirm password validation.
  • Phone field: Supports international formats line ###-###-#####. The format is configurable.
  • Comment area: It's a comment to introduce to a section of the form or give instructions to the user.
  • Summary: Displays a summary of form fields with the values entered.
  • Section Break: It's a line for separating areas group of fields
  • Page Break: Useful for creating multi-page forms. The "page break" marks the start of a new page in the form builder
  • Instruct. Text: Text field to display instructions for users.
  • HTML Content: Field for general purpose, to include HTML tags in the form.
  • Media: Allows insert images, audios or videos.
  • Button: Insert a button in the form.

* Note: Some of the field types are available only in the Developer and Platinum versions of the plugin.

Container Fields

The form builder includes some container controls. The container controls allow to insert another controls in them:

  • Fieldset Container: Allows insert a fieldset control in the form, with a legend.
  • Div Container: Inserts a container very useful for grouping related controls, and not modifies the appearance of the form.
DataSource Fields

In addition to the above, the following fields are available only in the Developer and Platinum versions of plugin:

  • Line Text DS: An input field that gets its default values from one of following datasources - Database, Posts information, Taxonomies information or Users information.
  • Number DS: An input field that gets its default values from one of following datasources - Database, Posts information, Taxonomies information or Users information.
  • Email DS: An input field for Email address that gets its default values from one of following datasources - Database or Users information.
  • Text Area DS: A text area field that gets its default values from one of following datasources - Database, Posts information.
  • Checkboxes DS: Checkboxes for selecting one or more options into the same field that gets its options from one of following datasources - Database, CSV, Posts information, Taxonomies information or Users information.
  • Radio Btns DS: Radiobuttons for selecting one option between the options available for the field that gets its options from one of following datasources - Database, CSV, Posts information, Taxonomies information or Users information.
  • Drop-down DS: A select / drop down list for selecting one of the values listed that gets its options from one of following datasources - Database, CSV, Posts information, Taxonomies information or Users information.
  • Hidden DS: A hidden field that gets its value from one of following datasources - Database, Posts information, Taxonomies information, or Users information.
Editing the field settings in the Form Builder

Field Settings

When you click a field already added, you can edit its details and validation rules. The following properties are useful:

  • Field Label: Label for the field in the public form and into the email.
  • Field tag for the message: In addition to the general <%INFO%> tag, you can use this tag to show the field value into a specific tag of the email.
  • Specific settings: The settings depends of the field type, for example the format of the phone number, the date format, etc...
  • Validation rule: The validation rules depends of the field type, example: required, only digits, valid email, valid number, etc...
  • Predefined value: Pre-filled value for the field, if any.
  • Instructions for user: This text will appear in a smaller form below the field. It's useful for giving instructions to the user.
  • Add CSS layout keywords: Customize the look & feel. If used, this field must contain the name of the CSS class and not the styles rules directly.
Other features in the form builder:
  • Equal fields validation: Use it for example to confirm if the email or password typed in two different fields are the same. This is valid for "Single Line Text", "Password" and "Email" fields.
  • Dependent fields: Use this feature for show/hide fields (any field type) based in the selection made on other fields (checkboxes, radiobuttons or select/drop-down fields).
For DataSource controls (only available in the Developer and Platinum versions of plugin)

This is a step by step about the use of datasource controls

  1. Insert in the form the control with access to external datasources (these controls are represented with the DS at the end of its names)
  2. Select the control in the form, and pays attention to the "Define Datasource" section.

    There are different datasources: Database, CSV file, Post Type, Taxonomy, and User Data.

    • Database, allows populate the field with the data stored in database.
    • CSV, allows populate the field with the data stored in a CSV file (Datasource available only in fields with multiple entries: DropDown DS, Checkbox DS, Radio Button DS).
    • Post Type, allows populate the field with the information associated to a specific post type (like the products names in a Woocommerce, etc.)
    • Taxonomy, allows populate the field with the information of taxonomies.
    • And finally the User Data, with the data of users in WordPress.

    Note: Depending of control selected will be available all available datasources, or not.

So, suppose we want populate the field with the data stored in a database table.

  1. Select Database, from the list of datasources.
  2. If the database is different that used by WordPress, will be required enter the Host's address, the authentication data to connect to the database (username and password), and the name of database(a host can include multiple databases). There is a button for testing the database connection.

    Note: If the database is the same used by WordPress, leave empty the fields above.

Now its time to define the query to database

  1. Enter the name of table's column, that store the control's values. If you are using the Drop-down DS control, it has multiple options; each option of drop-down list includes a value and text; in this option you determine the column in the table that includes the values of options.
  2. Enter the column's name that stores the control's texts. Similar to the previous step, but in this case the column stores the texts of the options (in case of checkbox or radio buttons, this column contain the label of options)
  3. Type the table name, a database can include multiple tables, you should identify the table you are using.
  4. Type a condition if required. If you want filtering the values to display in the control, type the condition in this attribute. For example, suppose you want load the data of posts that are public, the condition in this case would be: post_status='publish', where post_status is the name of column, and publish is the value for filtering.
  5. The "Order by" is used to order the query results by the values in columns, and not by the order that data were stored in database. For example, suppose you want populate the control with the users names of WordPress, and you want order the results alphabetically, in this case the "order by" would be: display_name ASC, where display_name is the column's name, and will be ordered in ascending way.
  6. Limit, enter an integer number to reduce the number of query results.

If your query is very complex, and you prefer create it manually; selects the option "Custom Query", but in this case you should type all the query. Pay attention because you should use alias in the "SELECT" clause, to indicate the colum used to get the values, and the column used to get the texts. For example, a hypothetical query:

SELECT column1 AS value, column2 AS text FROM tablename WHERE column3 > 5 ORDER BY column2 ASC LIMIT 5

The use of database as datasource, allows filtering the information to populate the fields with the values on other fields in the form, or javascript variable. The use of variables are only accepted in the "Condition" section ("WHERE" clause), and requires the format: <%varname%>. For example, to get the title of a post, filtering by its ID, if the id is defined through the fieldname3 field, the "Condition" attribute of the query would be: ID=<%fieldname3%>

How to use CSV files as datasource?

The CSV files can be used as data sources for fields with multiple choices (DropDown DS, Radio Btns DS, Checkboxes DS). The initial steps are similar to the previous section, but selecting the "CSV" option as data-source instead of selecting "Database".

A comma-separated values (CSV) file stores tabular data (numbers and text) in plain text. Each line of the file is a data record. Each record consists of one or more fields, separated by commas. The use of the comma as a field separator is the source of the name for this file format.

For CSV files, the plugin includes the attributes:

Select CSV file: file field to select the CSV file.

Use headline: tick the checkbox if the first line of CSV file is a headline to identify the data in the next records.

Delimiter: enter the delimiter symbol used as the field separator on each record.

Press the "Import CSV" button to import the records into the form. This action will feed the lists "Select column for texts" and "Select column for values", that are used for selecting which fields will be used texts and values of the choices in the DS field.

Create dependencies between fields

Some fields, like radio groups, checkboxes and drop-down menu, allow dependencies in function to the option selected.

For example, suppose your form includes a radio-group control with multiple choices: - House, - Car, - Electrodomestics, and each of them, uses different attributes. The house requires fields for address, number of rooms, etc; the car requires a field for trademark, model, etc. and finally the electrodomestics, will need type of electrodomestic,and more. So, if you want display the fields, depending of choice selected:

  1. Select the radio group fied in the form editor.
  2. Press the "Show dependencies" link, in the choices area.
  3. and select the field to display if the choice is selected. If you need associate multiple fields to the choice, press the plus button and select the new fields.

Settings area of the forms

For each calendar/form you will be able to edit the following settings:

full calendar settings
* Click image to see full screenshot.

Each setting means:

  • Public Calendar Settings:
    • Calendar language: The calendar language. Currently supports Czech, German, Dutch, English, French, Italian, Japanese, Portuguese, Russian, Spanish, Slovak, Swedish, and Turkish.
    • Calendar visual theme: Select one of the pre-built CSS themes for the public calendar.
    • Date format: The date format mm/dd/yyyy or dd/mm/yyyy.
    • Calendar pages: The number of calendar months to be shown at the same time
    • Military time: Sets am/pm or military time.
    • Start weekday: The start weekday of the week. Default is Sunday.
    • Minimum available date: You may want some time to review the booking, so you can set the minimum selectable date as a fixed date (Ex: 2012-10-25) or as a relative date like "today" or "today + 3 days".
    • Maximum available date: Similar to the previous field, in this case for selecting the maximum selectable date.
    • Open calendar in this initial month/year: This can be used to display the calendar initially in a specified month.
    • Minimum slots to be selected: This is the minimum number of slots that the customer must select in the booking form
    • Maximum slots to be selected: This is the maximum number of slots that the customer can select in the booking form..
    • Close floating panel after selecting a time-slot?: Default: "Yes". Set to "No" in the case the user have to select various slots in the same date. The price should be set for each total number of slots below (request cost setting).
  • Form Builder:
    • Appears only in the pro version if enabled. It displays a visual form builder for customizing the form.
  • Validation Texts:
    • Appears only if the Form Builder is enabled. Contains the validation texts for the fields.
  • PayPal Payment Configuration:
    • Enable PayPal Payments: Allows to enable/disable the PayPal payment option.
    • PayPal email: The email of the PayPal that will receive the payments.
    • Request cost: Payment amount requested to confirm a booking.
    • PayPal product name: The name that will appear to the customer at PayPal.
    • Currency: The currency, example: USD, EUR, GBP, etc...
    • URL to return after successful payment: After the PayPal payment the user may go back to a page into your website (usually a "thank you" page). Paste here the complete address of that page. This URL will be used as the "thank you" page even if the PayPal payment is disabled, be sure to specify it.
    • URL to return after an incomplete or cancelled payment: After a canceled/incomplete PayPal payment the user may go back to a page into your website, usually a page with more instructions or requesting feedback. Paste here the complete address of that page.
    • PayPal language: The language that will be used for the PayPal payment. It's any PayPal supported language.
    • Discount Codes: This section lets you to define discount codes. A 100% discount means that the payment isn't required. The discount codes can have an expiration time.
  • Notification Settings to Administrators:
    • Notification "from" email: The email used as from in the notifications.
    • Send notification to email: The email address where the notification will be sent to (ex: your email address).
    • Email subject notification to admin: Subject of the notification email that you will receive.
    • Email Format: Indicates if the email will be sent as plain text or HTML formatted.
    • Email notification to admin: Content of the notification email that you will receive. Keep the tag %INFORMATION% that will be replaced automatically by the booking information.
  • Email Copy to User/ Auto-reply:
    • Email subject confirmation to user: Subject of the thank you/confirmation email sent to the user (customer) after completing the payment.
    • Email Format: Indicates if the email will be sent as plain text or HTML formatted.
    • Email confirmation to user: Content of the thank you/confirmation email sent to the user (customer) after completing the payment. Keep the tag %INFORMATION% that will be replaced automatically by the booking information.
  • Captcha Verification:
    • Use Captcha Verification?: Indicate if the captcha anti-spam protection will be used.
    • Other various settings: There are multiple fields in this section that let you to define how the captcha image will look, including size, colors, base font, etc...
  • Reminder Settings:
    • Use this area to activate the reminder settings, customize the content of the reminder email and indicate how many hours before the appointment it should be sent.
  • Custom Settings:
    • Options: This special section, if some data is entered, generates a drop-down select list with items where each item can have a different price, ex: for multiple different services each one with its own price. This is an optional field that appears only if some option is specified. There is a sample format beside the field that you can copy & paste.

Special tags in the notification emails

In addition to the possibility of editing the email contents you can use the following tags (commercial versions):

  • %ITEMNUMBER%: Request ID
  • %CALENDAR%: Calendar related to the appointment.
  • %DATE%: Selected date for the appointment.
  • %TIME%: Selected time for the appointment.
  • %ALLDATES%: All the selected dates-times (if there is more than ona selected time-slot) in the booking.
  • %COUPONCODE%: Coupon code entered, if any.
  • %payment_type%: For the selected payment option (PayPal or Pay Later).
  • %txnid%: PayPal transaction ID.
  • %SERVICES%: For the additional services / custom settings field.
  • %PRICE%: Price, cost of the booking, if any.
  • %QUANTITY%, %ADULTS%, %JUNIORS%: Selected values if the quantity fields have been enabled (Pro and Developer versions).
  • %EMAIL%, %PHONE%, %COMMENTS%, %NAME%: Data entered on each field if the Form Builder is disabled.
  • %email%, %subject%, %message%, %fieldname1%, %fieldname2%, ...: Data entered on each field if the Form Builder is enabled.


Payment Integration

To enable a specific payment method you should enable the related add-on (PayPal and Stripe are built-in, no addon required for these).

The following sections explain the different payment gateway integrations available in the plugin.

PayPal Standard Payments Integration add-on

PayPal Standard is built-in into the plugin, for more details about setting up PayPal Standard check the documentation of the settings area of the form.

Stripe Payments

The Stripe Payments addon provides a way to accept all major cards from customers around the world on web. This addon requires SSL on your website to be able to carry the transaction in a secure way. Credit card data is entered directly in the website without navigating to an external page.

Stripe is a special add-on built-in the Platinum version of the plugin. To activate it select the option "Optional PayPal or Stripe.com" into the settings field "Enable Paypal Payments?".

You will need the following into to setup it:

  • Stripe.com Publishable Key: Publishable Key you will find into your Stripe account.
  • Stripe.com Secret Key: Secret Key you will find into your Stripe account.

When enabled, after clicking the booking form submit button, a Stripe floating panel will be displayed to ask for the credit card data and process the transaction and after that the form submission will continue as usual keeping the customer all the time into your website.

Skrill Payments

The Skrill Payments addon provides a secure interface for accepting payments through a secure page. You can accept cards, more than 20 local payment methods and over 80 direct bank transfer connections with a single integration. Form more information go to https://www.skrill.com/en/merchants/

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "Skrill Payment Integration", and press the "Activate/Deactivate addons" button.

In the settings area the following information is needed to activate and link the Skrill account to the form:

Enable Skrill Payments?: Select "Yes" to enable the Skrill Payments Integration.

Skrill Email?: Email linked to the Skrill merchant account, this will be the account that will receive the payments.

Receipt URL: User will return here after a successful payment.

Cancel URL: User will return here if payment fails.

Currency: Currency code for the received payment. example: USD, EUR, CAD, GBP ....

When enabled, the customer will be redirected to the Skrill hosted payment form payment form after the submission. The process will be similar to the way PayPal Standard works.

Authorize.Net Server Integration Method (www.authorize.net) add-on

The Authorize.net Server Server Integration Method (Authorize.net SIM) is a hosted payment processing solution that handles all of the steps in processing a transaction, including:

  • Collecting customer payment information through a secure, hosted form
  • Generating a receipt to the customer
  • Securely transmitting to the payment processing networks for settlement
  • Funding of proceeds to the merchant's bank account
  • Securely storing cardholder information

Authorize.net SIM is an ideal integration solution because merchants are not required to collect, transmit, or store sensitive cardholder information to process transactions. Additionally, Authorize.net SIM does not require merchants to purchase and install a SSL or TLS digital certificate, reducing the complexity of securely handling and storing cardholder information, simplifying compliance with the Payment Card Industry (PCI) Data Security Standard. For more information go to www.authorize.net

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "Authorize.net Server Integration Method", and press the "Activate/Deactivate addons" button

In the settings area the following information is needed to activate and link the Authorize.net Server Integration Method account to the form:

Enable Authorize.net SIM?: Select "Yes" to enable the Authorize.net Server Integration Method payment.

Mode: Change the mode between "test" for testing purposes and "production" for accepting real payments.

API Username: Change this value with API Username received from Authorize.net.

API Key: Change this value with API Key received from Authorize.net.

Receipt URL: User will return here after a successfull payment. Important!: You must also configure the receipt link URL in the Merchant Interface.

Cancel URL: User will return here if payment fails.

In addition to the above required setting fields there are other fields to link the form fields to the Authorize.net payment form, like for example the client name, address, phone, email, ... These fields are optional. To link the fields you can indicate the ID of the field on the form that contains the related info. Sample values: fieldname1, fieldname2, ..

When enabled, the customer will be redirected to the Authorize.net Server Integration Method payment form after the submision. The process will be similar to the way PayPal Standard works.

TargetPay (iDeal) add-on

The TargetPay addon provides integration with iDeal, the most popular Dutch payment method. The integration is made via TargetPay: https://www.targetpay.com/info/ideal?setlang=en

With TargetPay you can set up iDEAL payments for your website easily. Acting as a "Payment Service Provider" it aggregates payments for a large number of webstores. The iDEAL platform combines the online banking systems of 10 of the largest Dutch banks (ABN AMRO, ASN Bank, Bunq, ING, Knab, Rabobank, RegioBank, SNS Bank, Triodos Bank and van Lanschot) into one payment method.

After the consumer selects the iDEAL payment method the consumer's bank is selected. The actual payment then takes place in the bank's trusted online banking environment for which security is guaranteed by the bank. Through iDEAL buyer and seller are guaranteed a transparent transaction without hidden fees or other unpleasant surprises.

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "iDeal TargetPay", and press the "Activate/Deactivate Addons" button.

In the settings area the following information is needed to activate and link the iDeal-TargetPay account to the form:

Enable iDeal-TargetPay?: Select "Yes" to enable the iDeal-TargetPay payment option for the form.

RTLO Subaccount ID: Change this value with the account ID received from iDeal-TargetPay.

If payment fails return to this page: Return page if the payment fails or is cancelled before completing it.

Payments Mode: Change the mode between "test" for testing purposes and "production" for accepting real payments.

When enabled, the customer will be redirected to the iDeal-TargetPay payment form after the submision. The process will be similar to the way PayPal Standard works.

Mollie (iDeal)

The Mollie addon provides integration with iDeal, the most popular Dutch payment method. The integration is made via Mollie: www.mollie.com.

You're easily connected to iDEAL through Mollie without the dreaded technical and administrative hassle. The iDEAL platform combines the online banking systems of 10 of the largest Dutch banks (ABN AMRO, ASN Bank, Bunq, ING, Knab, Rabobank, RegioBank, SNS Bank, Triodos Bank and van Lanschot) into one payment method.

After the consumer selects the iDEAL payment method the consumer's bank is selected. The actual payment then takes place in the bank's trusted online banking environment - for which security is guaranteed by the bank. Through iDEAL buyer and seller are guaranteed a transparent transaction without hidden fees or other unpleasant surprises.

Mollie iDeal Add-on

In the settings area the following information is needed to activate and link the Mollie - iDeal account to the form:

  • Enable iDeal-Mollie?: Select "Yes" to enable the Mollie - iDeal addon. This selection will disable automatically the PayPal Standard option.
  • Mollie API Key: The API Username provided by Mollie for your account, it may be the test key or the production key.
  • If payment fails return to this page: If the payment fails the customer is redirected to the page indicated in this field.

When enabled, the customer will be redirected to the Mollie - iDeal payment form after the submision. The process will be similar to the way PayPal Standard works.

RedSys (Servired, Sermepa, TPV for most banks in Spain)

The RedSys / Servired / Sermepa addon provides a secure interface for accepting credit card payments through most banks in Spain (Sabadell, Banco Popular, BBVA, Santander, Bankia, Caixa, Bankinter, etc...). You can read more about RedSys at www.redsys.es.

RedSys Add-on

In the settings area the following information is needed to activate and link the RedSys account to the form:

  • Enable TPV: Select "Yes" to enable the RedSys TPV. This selection will disable automatically the PayPal Standard option.
  • CÓDIGO COMERCIO: The API Username provided by RedSys or your bank.
  • CLAVE SECRETA: The API Password provided by RedSys or your bank.
  • Mode: Select "Sandbox" for testing purposes and "Production" for charging real payments.

When enabled, the customer will be redirected to the RedSys payment form after the submision. The process will be similar to the way PayPal Standard works.

SagePay add-on

The SagePay addon provides a secure interface for accepting payments through SagePay. You can read more about SagePay at www.sagepay.co.uk.

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "SagePay", and press the "Update" button...

In the settings area the following information is needed to activate and link the SagePay account to the form:

Enable SagePay?: Select "Yes" to enable the SagePay payment gateway.
Vendor ID: The Vendor ID provided by SagePay.
SagePay Encrypt Password: The SagePay Encrypt Password provided by PayTM.
Mode: Select "Sandbox" for testing purposes and "Production" for charging real payments.

When enabled, the customer will be redirected to the SagePay payment form after the submision. The process will be similar to the way PayPal Standard works.

Sage Payment add-on

The SagePayments addon provides a secure interface for accepting payments through a secure SSL checkout system for both bankcard and virtual check transactions. All authorized and approved transactions will be delivered into your current bankcard and/or virtual check batches viewable within the Virtual Terminal for order processing and settlement. You can read more about Sage Payment Solutions at http://www.sage.com/us/sage-payment-solutions/accept-payments. The integration implemented in this addon is for Sage Payment Solutions >> Shopping ExpressPay

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", "SagePayments Payment Gateway", and press the "Update" button.

In the settings area the following information is needed to activate and link the Sage Payment Solutions >> Shopping ExpressPay account to the form:

Enable SagePayments?: Select "Yes" to enable the SagePayments TPV.

Merchant ID (M_id): Change this value with M_id received from SagePayments.

In addition to the mentioned two required setting field there are other fields to link the form fields to the Sage Payment Solutions payment form, like for example the client name, address, phone, email, tax and shipping cost. These fields are optionals and to link the fields you can indicate the ID of the field on the form that contains the related info. Sample values: fieldname1, fieldname2, ...

When enabled, the customer will be redirected to the Sage Payment Solutions payment form after the submision. The process will be similar to the way PayPal Standard works.



Square (squareup.com) Payments add-on

The Square Payments addon provides a way to accept all major cards from customers around the world on web. This addon requires SSL on your website to be able to carry the transaction in a secure way. Credit card data is entered directly in the website without navigating to an external page.

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "Square", and press the "Activate/Deactivate add-ons" button...

In the settings area the following information is needed to activate and link the Square account to the form:

  • Enable Square?: Select "Yes" to enable the Square Payments Integration.
  • Squareup.com Application ID: The Squareup.com Application ID you will find into your Square application.
  • Squareup.com Access Token: The Squareup.com Access Token you will find into your Square application.
  • Squareup.com Application Secret: The Squareup.com Application Secret you will find into your Square application.
  • Squareup.com Location ID: The Squareup.com Location ID you will find into your Square application.
  • Currency: The currency code, example: USD
  • Mode: Select "production" or "sandbox/test".

Add-Ons

The list of add-ons available in the plugin, appear in the "Add-ons area" of settings page of the plugin. For enabling the add-ons, simply should tick the corresponding checkboxes, and press the "Activate/Deactivate Addons" button.

Add-ons

iCal Export

The iCal Export option provides a way to automatically export bookings to external calendars supporting iCal, like for example Google Calendar, Outlook Calendar, iCloud/Apple calendars, etc...

No need to enable add-ons for this feature, the iCal export link is built-in in all versions of the plugin. The link for the feed in iCal format is located in the list of calendars (administration menu >> Settings >> Appointment Booking Calendar).

To get the iCal feed URL right click the "iCal" link on the calendar list and click "Copy Link Address" or "Copy Link Location" (depending of the browser you are using).

The FAQ contains info about automatically exporting to Google Calendar: https://abc.dwbooster.com/faq#q300.

iCal Automatic Import add-on

The iCal Automatic Import addon provides a way to automatically import bookings from external calendars supporting iCal, like for example Google Calendar, Outlook Calendar, iCloud/Apple calendars, etc...

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "iCal Automatic Import", and press the "Activate/Deactivate addons" button.

In the settings area the following information is needed to activate and link the iCal calendar:

Enable iCal import for this calendars?: Select "Yes" to enable the iCal automatic import.

iCal URL: URL of the remove iCal file to be imported. Unless you know what you are doing it should start with http:// or https://

The iCal file will be automatically imported every one hour and each time the plugin settings are saved.



Signature add-on

Signature Add-on

The add-on converts the form fields selected in "Signature" fields, allowing the users to sign with the mouse or directly in the touchscreens.

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "Signature", and press the "Update" button.

Signature Add-on

From the form's settings, selects the fields to convert in Signature fields. It is possible convert multiple fields in the form in signature fields.

Signature settings:

Color: the color code for signatures. For example: #000000

Line thickness: an integer number defining the line thickness of the signature.

Show guideline: checkbox to include or not a guideline in the signature fields.

Guideline color: the color code for guideline. For example: #000000



MailChimp add-on

MailChimp Logo

The add-on creates new members in the MailChimp service with the information collected by the forms in the website: www.mailchimp.com.

MailChimp is an online email marketing solution to manage subscribers, send emails, and track results.

* MailChimp is a third party service not related to our company. MailChimp may charge for their service.

MailChimp Subscribers

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "MailChimp", and press the "Update" button...

After activating the MailChimp add-on, the form settings will include a new section to create the correspondence between the signup form associated to a list in MailChimp, and the form fields in the form created with the "Appointment Booking Calendar" plugin.

MailChimp Settings

  1. Enter the API Key.
  2. Press the "Get Lists" button. The action generates a list with all "Lists" associated to the MailChimp account.
  3. Select the list and press the "Get Fields and Groups" button. The action displays multiple input fields, for connecting the fields in the form with the fields in the signup form of to the list, and the interests groups defined in MailChimp, that are displayed in the public form too to be selected by the users.

Twilio SMS add-on

The Twilio SMS add-on provides integration with the Twilio SMS service. This way the booking and reminder notifications can be sent as a SMS text message to the phone of the person making the booking.

In the settings area the following information is needed to activate and link the Twilio account to the form:

  • Enable TwilioSMS: Select "Yes" to enable the SMS text message feature for the booking form.
  • Twilio AccountSid: The AccountSid provided by Twilio for your account.
  • Twilio AuthToken: The AuthToken provided by Twilio for your account.
  • ID of the field that contains the phone number: The ID of the field (in the form builder) where the customers making the booking will enter their phone numbers. Click the field in the form builder to see its ID. Example: fieldname1, fieldname2, .... put only the ID without tags.
  • Phone number used as "from": The phone number that will be used as "from" for the SMS messages. Must be a valid Twilio number that you've purchased.

Note that the SMS messages are limited to 160 characters.



Clickatell add-on

The Clickatell service allows sending messages (SMS) to mobile phones around the world.

The add-on integrates the forms with the Clickatell service for sending notification messages (SMS) after submit the forms and as part of the reminders.

Clickatell

* Clickatell is a third party service not related to our company. Clickatell may charge for their service.

To activate the add-on, simply visit the plugin page through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "Clickatell", and press the "Activate/Deactivate addons" button...

After activating the Clickatell add-on, a new section section will be available in the form's settings for entering the required data.

Add-on settings

The add-on settings are:

Clickatell enabled: for enabling/disabling the integration with the form.

Account API Key: enter the Account API Key provided by Clickatell.

To Phone Number: enter the phone numbers (separated by comma symbols) where to send the SMS (enter a valid phone number including the country code).

Message: enter SMS content (it is possible to use the same special tags than in the notification emails).

For sending a SMS to the phone number entered through the form

To Phone fields: enter the names of phone fields inserted in the form (fieldname#, separated by comma symbols).

Message: enter SMS content (it is possible to use the same special tags than in the notification emails).

WooCommerce add-on

The Platinum version of the plugin includes the WooCommerce add-on, to integrate the forms created by the "Appointment Booking Calendar" with the WooCommerce products. The add-on inserts an additional metabox in the WooCommerce products, with two settings fields:

  • Enter the ID of the form: Allows select the form that will be associated to the product.
  • Calculate the product price through the form: Allows calculate the price of the products through the form.
  • Minimum price allowed: The minimum price applied to a product.
  • Activate the summary: Allows customize the fields included in the cart page of WooCommerce.
  • Summary title: Enter the summary title.
  • Summary: Define the summary, are accepted all special tags supported by the notification emails and the thank you page.

Note: If you want calculate the price of products through the form, will be required that you select the field of the price in the attribute: "Request cost" in the form's settings.

WooCommerce Add-on

SalesForce add-on

The add-on allows create new leads in the SalesForce account with the data submitted by the forms.

To create new leads in SalesForce with the data submitted by a form, be sure that the SalesForce account has enabled the Web-to-lead option, and then go to the form's settings:

  • Enter the OID (Organization ID)
  • For debugging the lead creation, tick the "Enabling debug" option, and enter the email address where receive the information. For production, untick the debugging option.
  • Press the "Add attribute" button, select the Lead attribute, and enter a fixed text, or the name of the field in the form (fieldname#)

Note: The Add-on includes the list of predefined attributes of Leads, but it is possible to enter custom attributes too.

SalesForce Add-on

WebHook add-on

The add-on allows posting the submitted information by the forms to WebHooks URLs. With the WebHook add-on it is possible integrate the forms created by the plugin with services like Zapier. The Zapier connects services as important and popular as Zoho CRM, Dropbox, Mailchimp, Evernote, Google Drive, Facebook, Twitter, and more than 300 services(Zapier apps)

Use this add-on is as simple as entering the WebHooks URLs, through the WebHook section in the forms settings. To associate a form with multiple WebHooks, simply press the "Add new url" button, to add a new input field.

Note: About Zapier service, select Webhook as the Trigger app, and "Catch Hook" as the trigger for this app.

WebHook Add-on

reCAPTCHA add-on

The add-on allows to protect the forms using the Google reCAPTCHA instead of the captcha distributed with the plugin. reCAPTCHA is more visual and intuitive than the traditional captcha, with just a single click the users confirm they are not a robot.

reCAPTCHA (its official name is No CAPTCHA reCAPTCHA) as they define themselves:

reCAPTCHA is a free service that protects your website from spam and abuse. reCAPTCHA uses an advanced risk analysis engine and adaptive CAPTCHAs to keep automated software from engaging in abusive activities on your site. It does this while letting your valid users pass through with ease.

reCAPTCHA offers more than just spam protection. Every time our CAPTCHAs are solved, that human effort helps digitize text, annotate images, and build machine learning datasets. This in turn helps preserve books, improve maps, and solve hard AI problems.

To use reCAPTCHA in your forms, activate the add-on in the the settings page of the plugin, through the menu option: "Settings/Appointment Booking Calendar", tick the checkbox: "reCAPTCHA", and press the "Update" button.

The activation of reCAPTCHA displays a new section for entering the site key, and the secret key, two keys provided by Google reCAPTCHA to protect the website, and validate the forms submissions respectively.

reCAPTCHA Add-on

Zoom Meetings Integration add-on

The add-on offers integration with the service Zoom. Zoom is a Video Conferencing, Web Conferencing, Webinars, Screen Sharing service.

This add-on automatically creates a Zoom meeting for the booked time and allows to send the meeting invitation info into the notifications emails.

To activate the add-on, simply visit the plugin page through the menu option: "Appointment Booking Calendar", below the list of calendars, tick the checkbox: "Zoom Meetings Integration", and press the "Activate/Deactivate addons" button.

After activated go to the calendar/booking form settings and select "Yes" in the settings field "Enable Zoom integration for this booking form" (located almost at the bottom o the settings page).

You will need the Zoom JWT API Key and API Secret. To register your app, visit the Zoom App Marketplace and click on the Develop option in the dropdown on the top-right corner and select Build App. A page with various app types will be displayed. Select JWT as the app type and click on Create.

The following additional tags can be used in the emails:

%zoom%: The invitation link to the generated zoom meeting.
%zoom_id%: The zoom meeting ID.
%zoom_password%: The zoom meeting password.



Appointment Limits add-on - Limit the number of appointments per user

The Appointment Limits addon, available in the Platinum version of the plugin, provides a way to limit the max number of appointments that an user can book in a day, a week and/or a month. For example each user can be allowed to post max 1 appointment per day, max 2 appointments per week and max 5 appointment per month.

The addon settings allow to indicate the max number of daily, weekly and monthly appointments per user. The user restriction can be applied using the user email address or the user WordPress account in the case all your bookings are made by logged in users.

The first step to get this feature enabled is to activate the addon "Limit the number of appointments per user". The list of add-ons available in the plugin, appear in the "Add-ons area" of settings page of the plugin. For enabling the add-ons, simply should tick the corresponding checkboxes, and press the "Activate/Deactivate Addons" button.

With the addon enabled go to the bottom of the calendar settings page and set the limits for the related calendar, first put the option "Enable appointments limits for this calendar" to "Yes" and then you will see a list of options for the limits (daily, weekly and monthly limits with verification per user email or per website registered user).



Summary Display add-on - Provides a shortcode to display a summary in the "thank you" page.

The Summary Display add-on, available in the Platinum version of the plugin, provides a shortcode to display a summary in the "thank you" page.

The add-on settings allow to setup the content and data that will be displayed as part of the summary.

The first step to get this feature enabled is to activate the addon "Summary Display" in the list of add-ons at the bottom of the page that contains the list of calendars.

With the add-on activated enter to the calendar settings (bottom of the settings page) to edit the content/tags you want to use in the summary. To display the summary into a page put the following shortcode on the page, usually into the "thank you" page where the customer is redirected after the booking:

[CPABC_DISPLAY_SUMMARY calendar="1"]

You can use the same tags available for the emails to customize the summary content.

Troubleshoot Area & General Settings

Throubleshoot Area

The "Troubleshoot Area & General Settings" section, allows correct some possible issues, or conflicts with third party plugins, and define the general settings.

  • Form rendering: Select to use a basic HTML form or the advanced form builder.
  • Script load method: Changes the script load method if the form doesn't appear in the public website.
  • Character encoding: Updates the charset, if you are getting problems displaying special/non-latin characters. After updated you need to edit the special characters again.
  • iCal time-zone difference vs server time: Update if needed to match the desired time-zone used for exporting the iCal file. Difference is calculated using the server time as reference.
  • iCal time-slot size in minutes: Update if needed to have a specific duration for the time-slots in the exported iCal file.


Double-Opt-In E-mail Validation

The Platinum version of the Appointment Booking Calendar supports double opt-in e-mail validation. The double opt-in process includes two steps. In step 1, a potential customer fills out and submits your online booking form. In step 2, they'll receive a confirmation email and click a link to verify their email, changing the status of the booking to "confirmed".

The double opt-in e-mail validation is useful to comply the European General Data Protection Regulation (GDPR).

The double opt-in e-mail validation can be activated under the Troubleshoot Area & General Settings located at the bottom of the page that contains the list of calendars:

Double-Opt-In E-mail Validation

The following are the involved settings fields:

  • - Enable Double-Opt-In E-mail Validation?: Enable/disable the feature. If enabled bookings are only then confirmed once a confirmation link contained in automated e-mail has been clicked.

  • - Return address for a successfull validation link: The customer is redirected to the page indicated into this field after a successful validation.

  • - Return address for a expired validation link:: The customer is redirected to the page indicated into this field after a failed validation (example: expired or incorrect link).

  • - Link Expiration: The Validation link - if not used - will expire the indicated number of hours before the appointment date.

IMPORTANT!: The tag %VALIDATION% must be included into the email content to place the validation link into it. The tag will be replaced with the email validation link.

When this feature is enabled a new column will named "Verified?" will appear in the bookings list. The values on this new column indicates if the booking has been confirmed (verified) using the validation link.

Printing a Form

For printing only the form, but not the rest of page, please, follows the steps below:

  1. Inserts a "HTML Content" field in the form, and enter as its content the piece of code:
    <SCRIPT>
    function printForm(){
    	var w = window.open(null, 'Print_Page', 'scrollbars=yes');
    	jQuery('#fbuilder input').each(function () {
    		var e = jQuery(this);
    		e.text(e.val()).attr('value', e.val());
    		if (e.hasClass('large'))
    			e.css('width', '100%');
    		if (typeof e.prop('checked') != 'undefined')
    			e.attr('CHECKED', e.prop('checked'));
    	});
    	var html = jQuery('#fbuilder').html();
    	jQuery('#fbuilder TEXTAREA').each(function () {
    		var e = jQuery(this).parent().html();
    		html = html.replace(e, jQuery(this).val());
    	});
    	jQuery('#fbuilder SELECT').each(function () {
    		var e = jQuery(this).parent().html();
    		html = html.replace(e, jQuery(this).find('option:selected')[0].text);
    	});
    	w.document.write(html);
    	w.document.close();
    	w.print();
    }
    </SCRIPT>
    
  2. Inserts a button field in the form and call the function defined previously from its onclick event:
    printForm();