Support Guide

Drupal Plugin

    TABLE OF CONTENTS

  1. • Installing the Drupal Plugin
  2. • Activating the Plugin
  3. • Enabling the Shortcode
  4. • Generating the Shortcode
  5. • Configurable Options
  6. • Advanced Options
  7. • Extending the Shortcode
Where do I access this in Checkfront?
The WordPress booking portal tool is accessible via the main menu bar at:
Manage >Add-ons >Website Integrations > Drupal

 

Using the Drupal Plugin with Checkfront

Checkfront has created a plugin for Drupal which enables you to generate a shortcode, paste it into your webpage and publish a booking portal for your customers to reserve their items. Once configured, the plugin will take care of the complicated code required to display the portal. All you need to do is add the shortcode to your page and we’ll take care of the rest. If you’d like to alter the way the booking portal appears or behaves, you can do that by adding arguments to the shortcode. This guide will show you just how to do that. 


 

Installing the Drupal Plugin

Unlike our Droplet integration method, the Drupal based booking portal requires the installation of a plugin. It’s a little more complicated than the WordPress plugin, but if you follow this guide closely, you’ll be up and running in no time! Both the Droplet and Drupal integration methods yield exactly the same results, but by installing the Drupal plugin, you avoid a complicated mass of code and are able to make changes to your website URL without needing to edit any code on your webpage.

If you’ve used Drupal before, you’re probably familiar with the process of finding plugins and installing them on your server. If not, don’t panic! Follow this guide and we’ll show you exactly what needs to be done.
 

Search for and Install the Plugin

The first step is to locate the Checkfront plugin within Drupal. Navigate to your Drupal dashboard.

 

Drupal-Dashboard

 

1) Click on the Modules menu in the main navigation bar (see image above).
2) Click on the Contributed Modules link.
 

 

Contributed-Modules

  

3) Enter Checkfront in the search field and press the Search button.

  

Drupal Search

 

 
4) When the results appear, look for the one labelled Checkfront Online Booking System. The title will be hyperlinked, so click on it.
 

 

Checkfront Drupal

 

 
5) You will now be presented with some information on the Checkfront booking plugin. Under the section labelled Downloads, click on tar.gz file to download it to your computer.
 

 

Download Drupal

 

 
6) Next, return to the Modules page and click on the + Install New Module link.
 

 

Install-Module

 

 
7) Click on the Choose File button and locate/select the file you just downloaded to your computer. Then, click Install.
 

 

Drupal Choose File

 
 


 

Activating the Plugin

Now that the installation is complete, it’s time to activate the plugin.

1) Go to the Modules page and scroll to the very bottom. Here, you should see a section labelled E-Commerce. Check the box to enable the Checkfront plugin you just installed and click Save Configuration.

 

Enable Drupal

 

2) You’ll now see a Configure link appear to the right of the plugin. Click on this.

 

Configure Drupal

 

On the next screen, look for a box labelled Setup. In here, is a field to enter your Checkfront Host URL. This is the URL by which you access your Checkfront admin area and was chosen by you when you first created your account. It is most likely [BusinessName].checkfront.com. In our example, we will use demo.checkfront.com.

1) Enter the Checkfront Host URL.
2) Click Save Configuration.

 

Drupal Host URL

 

If everything went according to plan, you should now see a confirmation message at the top of the screen.

 

Drupal Confirmed

 

Quick Tip:
Pay close attention to your Checkfront Host URL. Depending on where you are located, your URL may not end with .com. It may, for instance, end with .co.uk. Entering this incorrectly is a common mistake, so double check before entering it in the field, just to make sure!

 
 


 

Enabling the Shortcode

Before we can generate the Checkfront shortcode and add it to our web page, we first need to enable the shortcode for use in the system.

Notice the Quick Start guide near the top of the Checkfront module page. So far, we have completed the first two steps. Now, click on the Text Format link in step three.

 

Drupal Text Format

 

Click on the Configure link next to the Full HTML option.

 

Full HTML Configure

 

Select the Checkfront Booking Shortcode option and scroll to the bottom of the page to click on the Save Configuration button.

 

Check Shortcode

 

The shortcode is now activated and ready for use.
 
 


 

Generating the Shortcode

The next step is to generate the shortcode which will be added to your Drupal web page. If you have any experience with the Checkfront Droplet, you will recognise that the process involved now is more or less the same. Once you’ve generated the code, however, you will be presented with one basic line of code. The more complicated code is handled by the plugin you just installed.

Now, if you like, you can simply go ahead and add the shortcode [checkfront] to your web page. When published, this will show the booking portal as configured in your Checkfront backend.

You can however, manipulate the shortcode to create a more refined look for the portal. If you are experienced with shortcodes, you can scroll down this page to see the arguments which can be added to produce certain results. If you’re not sure about that, though, the Shortcode Generator is the way to go.

Shortcode Generator

Just below the Setup box, where you entered the Host URL, is another box labelled Getting Started. Click on the Shortcode Generator button.

 

Drupal Generate

 

Alternatively, you can access the same Shortcode Generator through your Checkfront backend.

To do this, go to Manage > Add-ons > Website Integrations. Hover your mouse over the Drupal tile and click SETUP.

 

Drupal-Tile

 

This will bring you directly to the Drupal Shortcode Generator.

 

Drupal Shortcode Generator

 

You’ll notice at the bottom of the wizard, just above the Generate Code button, there’s a link to Show more options. These are slightly more advanced features and we’ll look at those a bit further down the page.

For now though, let’s take a look at the basic set of configurable options available.
 
 


 

Configurable Options

Options

Tabs As Categories

By default, the item categories you have created in your account will be displayed in a drop-down menu.

 

Category Drop-Down

 

If you check the Tabs As Categories option, however, they will instead be displayed in the booking portal as individual tabs, which can be clicked on to view their content.

 

Tabs As Categories

 

Hide Search & Calendar

The search field and calendar can be useful for finding just the right item to book.

 

Search Calendar

 

Sometimes, though, you may wish to display a more basic booking form on your website. In this case, you can choose to hide the search box and calendar from view.

 

No Search Calendar

 

Display

If you are placing the shortcode onto a web page which is aimed at a specific item or items, you can use the Display option to select which ones are to be included on the page.

 

Display

 

Uncheck the box labelled All Items & Categories to reveal the individual items. Select the ones you like by checking each one in turn. All other items will be filtered from the booking portal you are creating.

Discount Code

If you have a discount code you would like to be automatically included in the booking portal, you may select it from this drop-down list.

 

Discount Option

 

All prices shown to the customer will now reflect the discount you have chosen.

Font Colour

This is a pretty self-explanatory option! If you wish the text in the booking portal to be a different colour, simply choose one from the colour picker.

 

Font Colour

 

You can enter a specific hex colour value in the field provided if required.

Font Family

If your website uses a specific standard font family, such as Arial or Tahoma, you can enter it here. Once published, the booking portal will take on the same format.

Date

If required, you can fast forward the booking portal to a specific date. By default, the system will show the current date unless you have a cutoff rule set. This option enables the customer to land on a set date at some point in the future.

 

Droplet Date

 

Click on the field to open the calendar and select your date. You can use the small black arrows to advance the months back and forth.

And that’s it for the basic options. At this point you can click the Generate Code button and paste the results into your webpage. Before you do that though, you may wish to have a quick look at the advanced options to further refine the look and feel of your booking portal.
 
 


 

Advanced Options

Background Colour

Just like the font colour above, you can also select a colour for the background of your booking portal.

 

Background Colour

 

In most cases, white will be just fine, but if you feel the urge…

End Date

Same as the start date above, but you can also add a specific end date if you only wish to show availability between a set period of time.

Tracking ID

A tracking ID is simply a code which can be added to the booking portal for future reference. The ID code will show on your invoices so you know where the booking came from specifically. This is great for tracking advertising campaigns and things like that. Check out this support document for more information.

Language

If you’d like to display the booking portal in a specific language, choose it from the list of available options.
 
 


 

Generate the Shortcode

That’s it now! You should have selected all the options from above that make the most sense in terms of your requirements. It’s now time to generate the shortcode for your website.

Click on the Generate Code button and copy the resulting shortcode to your clipboard.

 

Generate WordPress Code

 

Once you’ve pasted the shortcode into your web page, publish it and check out your results.

Where To Place the Shortcode

With the shortcode pasted to your clipboard, head back over to Drupal and locate/create the page/post in which you wish to embed the booking portal. Place the shortcode wherever you would like the portal to appear. This may be before, after or somewhere within your page content.

 

Drupal Place

 

Make sure you select Full HTML from the Text Format field.

Shortcode With Arguments

Adding some of the arguments from the list lower down this page will control how the booking portal appears and the information it contains. Below is an example of what this shortcode might look like:

 

Drupal Arguments

 
 


 

Extending the Shortcode

Following, is a list of arguments that can be added to the basic [checkfront] shortcode to change the look and behaviour of your booking portal.
 

Inventory

Show specific items: [checkfront item_id=”3,8,37″]

Show specific categories:[checkfront category_id=”2,3″]

Limit upcoming events to specific category: [checkfront filter_category_id=”3″]
 

Options

Tabs as categories: [checkfront options=tabs]

Hide search and calendar: [checkfront options=hidesearch]

Together, they would look like this: [checkfront options=tabs,hidesearch]
 

Discount Code

Include an automatic discount code: [checkfront discount_code=”insert_code”]
 

Style

Font colour: [checkfront style=”color: #000000″]

Font family: [checkfront style=”font-family: arial”]

Background colour: [checkfront style=”background-color: #873333″]

Together, they would look like this:

[checkfront style=”color: #000000; background-color: #873333; font-family: arial”]
 

Date

Fast forward to specific date: [checkfront date=”20141224″]

Add an end date: [checkfront end_date=”20140131″
 

Tracking ID

Tracking ID: [checkfront tid=”promo-page”]

See campaign tracking for more information on using tracking ids.