Documentation:CTLT Events System/Installation and Development Guide

From UBC Wiki

Installation and Setup

Installation

Event Espresso requires installation and activation of the following plugins:

  • Event Espresso - the main plugin. To provide full functionality, CTLT has added custom code to "includes/event-management/update_event.php", "includes/event-management/edit_event.php", "includes/event-management/insert_event.php", "includes/admin-reports/event_list_attendees.php", "includes/admin-reports/add_new_attendee.php", and "includes/process-registrations/add_attendees_to_db.php".
  • Espresso Ticketing - allows event managers to track who has attended events.
  • Espresso Social - allows social media integration with events.
  • Espresso Permissions Basic - creates Event Espresso-specific user roles, like Event Managers
  • Espresso Permission Pro - creates more Event Espresso-specific user roles and permissions, including geography-based permissions. To provide full functionality, CTLT has added custom code to "espresso-permissions-pro.php".
  • Espresso Members - allows the use of persistent WordPress user data for event registration
  • Espresso Calendar - allows events to be displayed
  • CTLT Espresso Controls - allows you to produce reports that span events and categories (available at https://github.com/ubc/ctlt-espresso-controls/)

Additionally, Event Espresso requires the files at https://github.com/ubc/em-ctlt/ to be placed inside a folder named "espresso" in the "uploads" folder. Also included in this file are documentation for CTLT code added to Event Espresso if the original changes are ever updated, lost, or overwritten.

To install Event Espresso:

  1. Navigate to Dashbord > Plugins.
  2. Activate the plugins listed above, if they are available on your site. All plugins are required for Event Espresso to work smoothly.

You'll see two new options on the menu bar on the left: Event Reports and Event Espresso. Event Reports provides reporting tools. Event Espresso provides event management.

Setup and Initial Customization

Event Espresso requires some customization before it can be used effectively. This customization will directly affect how users experience the site.

To initially set up Event Espresso:

  1. Navigate to Dashboard > Event Espresso > General Settings.
  2. Fill in the fields of the "Organization" section. This will autopopulate fields in emails sent out by Event Espresso.
  3. Fill in the "Default Registration Confirmation Email" of the "Email Settings" section. This email is sent out by default to everyone who registers for any event.
    Customized confirmation emails are discussed later.
  4. Change the "Skip Confirmation Page during Registration Process?" field of the "Optional Event Settings" section to "Yes." This will allow users to skip a step when registering.
  5. Change the "Use the Venue Manager?" field of the "Optional Event Settings" section to "Yes." This will allow you to select venues automatically.

Leave all other fields as they are.