PBEvents Quick Start Guide

PBEvents is supplied as a single Joomla! package containing both an administrator component and a content plugin. The one installation will install both extensions.

Step 1 - Initial Installation

To install, log into your Joomla! administration console and go to Extensions -> Extension Manager. From the Extension Manager choose Upload Package File and select the newly downloaded package file. Click the Upload & Install button.

Once installation has finished click on the Manage link in the menu bar to enable the included content plugin. If you don't enable this plugin the booking form will not be generated in the articles.

You will know that the plugin is activated when the red circle next to its name has become green.

Step 2 - Some Basic Configuration

Most of the configuration is done based on each event. There are some items that need to be configured for the whole system though. Go to your Joomla! administration panel and open the newly installed purple-beanie-events option in the Components menu.

This brings you to the main PBEvents management screens. The first thing we're going to do is to configure the details for the notification emails. Notification emails can be sent based on:

  • a successful user registration for an event.
  • a failed user registration for an event.

These emails will include the details of the event and the details the user entered.

Click on configuration and edit the subjects and emails as required. Note the |*email*| and |*user*| tokens. These need to remain in the email as they are used by PBEvents as place holders for event and user information.

Step 3 - Creating Your First Event

With configuration out of the way you are now ready to create your first event. Click on the List all Events tab in the sub menu bar and then click New on the top right. This brings you to the Create Event screen.

The left hand side of the Create Events screen will allow you to define information about the event. This includes the following information.

  • Event Name - how this event will be known in the List all Events interface. This is not presently displayed to the user.
  • Event Description - a brief description of the even to appear in the List all Events interface. This is not presently displayed to the user.
  • Start - The starting date of the event in the format YYY-mm-dd HH:mm:ss for example 2012-05-30 19:00:00 is the 30th May 2012 at 7pm. A date time selector will appear to help select this.
  • End - The ending date of the event in the format YYY-mm-dd HH:mm:ss for example 2012-05-30 19:00:00 is the 30th May 2012 at 7pm. A date time selector will appear to help select this.
  • Max People - The maximum number of people that can book for this event. Once this is exceeded a message will display indicating that registrations have been disabled. Entering 0 for this means an unlimited number of people can RSVP.
  • Success URL - A page the user user will be redirected to after a successful registration for the event. This can be the same page or another page with information about the event, reminders, and any conditions or special notices.
  • Failure URL - A page the user will be redirected to after an unsuccessful registration for the event. This can be the same page or another page letting them know their registration was unsuccessful and whether someone will contact them or not.

The right hand side of the Create Events screen allows the administrator to define:

  • fields for the booking form.
  • what notifications are sent and what address they will be sent to.

The fields defined using this screen will be used when displaying the booking form to the user.

The following information must be supplied for each field.

  • Label - the label that will be displayed for the field. This should be something that makes sense and is human readable. This can contain letters, numbers, spaces, dashes, hyphens, and underscores. This cannot contain quotations.
  • Merge Var - this is the variable by which the field will be referenced in the database. This can only contain letters, numbers, and underscores. This cannot contain symbols. This variable name must be unique.
  • Required - this indicates whether the field is required. This is used by the Javascript in the front end to prevent incomplete bookings and to display prompts when fields are not completed.
  • Field Type - this provides a drop down box of available field types that can be chosen. Currently supported field types are:
    • text field
    • textarea
    • checkboxes
    • radio buttons
    • select box
  • Values - where a checkbox, radio button, or select box, is chosen as the field type it is necessary to provide values. These are supplied as a string separated by a '|'. For example a select box with gender may be have values defined as Male|Female.
  • Is Email - a check box that indicates whether the entered field is an email address or not. This will be validated in the front end to ensure an suitable email address is entered.

The panel below the fields interface is where notifications are configured. Notifications will alert the administrator or nominated contact of a successful or failed registration. Notifications are defined on a per event basis. This means different people can get notifications for different events.

By default no notifications are sent. Registrations can be accessed from the back end, however if you want to get notification of new, or failed, registrations make sure you complete these settings.

Step 4 - Adding Your Event to Your Article

With the creation of your event and configuration done its now time to make your event visible so that people can register. After all what good is an event that no-one attends.

To get your events to display on the front end edit an article or create a new article. In the article place any of the content and information of the event that you wish the user to see. Then place the plugin tag where you would like your event form to be registered. The plugin tag takes the format {pbevents=1} where 1 is the id of the event you created previously.

From the front end this will display the form using the fields you have defined.

When fields don't meet the required validation rules they will be filled with yellow and bordered in red. Invalid data in fields will also prevent the form from being submitted.

Step 5 - Watch the Registrations Roll In

Once a user submits a registration, or has problems submitting a registration, depending on your Notification Settings you will receive an email.

In the email the |*event*| and the |*user*| tags are replaced by the relevant content. If the event submission failed the email will also include any database error messages that were reported.

To check the progress of event registrations you can go to your Joomla! back end and select the purple-beanie-events component from the Components menu. Click on List all Events to display a listing of all the events in the database and on the event row, click on the number under the attendees column.

This will bring up a list of all the users registered for a specific event and their captured data. If you wish to delete a user mark the check box beside them and click the delete button on the top right. At present it is not possible to edit a user record.

Credits & Thanks

As always a thank you for the user of other GPL libraries and tools incorporated into this product.

  • Famfamfam - for some of the icons used in the administration interface
  • Arian Stolwijk - for the awesome MooTools date time picker