Test (Demo) Mode

Here you will set up your Administrate WordPress Plugin to retrieve data from our demo database. This will show that the Administrate WordPress Plugin is working, before switching it to Live Mode, which retrieves data from your instance of Administrate.

1. In your WordPress Admin panel, navigate to the Plugins Menu
2. Click Add a New Plugin and upload the Administrate Plugin (zip file) from your local machine
3. Activate the plugin
4. When successful, the Administrate Plugin will be displayed in your list of plugins with a new Menu Option to configure the Plugin Settings (top left of screen)
5. Click Administrate in the WordPress Panel and select the API tab. We recommend leaving the service mode as ‘Demo’ to use our demo database for testing.

Live Mode

Once you’ve got Course and Event information pulling from our Demo Mode, follow the instructions below to switch the Administrate WordPress Plugin to Live Mode, which will pull data from your own Administrate database.

1. Click Administrate in the WordPress panel and select the API tab.
2. Change the Service Mode to Live to connect to your database.
3. Set the Domain to your Administrate instance URL without the preceding https. For example, if your Administrate address is https://trainingcompany.administrateapp.com , then your Domain would be trainingcompany.administrateapp.com
4. Enter your Administrate API Email Address that you created from Administrate Setup - Create an API User.
5. Enter your Administrate API Password that you created from Administrate Setup - Create an API User.
6. Set the Cache Time: this is how often you want your website to refresh the data from Administrate. We recommend using at least a 15 minute cache time to improve performance.

Congratulations! You’ve now connected your website to Administrate!

Course Menu

You can display your Course Categories in your website’s menu.

1. Create a page in WordPress that will be your main course listing page.
2. If your theme is not using a custom menu on your website, create new custom menu under “Appearance” ... “Menus.”
3. Add whatever pages you wish to your menu, including the page you created as your course listing page.
4. Go the “Courses” tab in the Administrate plugin.
5. Select the page you created in the “Course Information Page” drop-down.
6. Select what type of submenu you’d like to display in the “Course Submenu” drop-down. Warning: Only choose the “All Courses” option if you offer 10 or less courses, otherwise you may experience slow page load times.
7. Scroll down to the bottom of the page and click the “Save Changes” button.
8. Your custom menu on your website will now automatically display a submenu of the type you selected. When a user clicks on a link in the submenu, he/she will be taken to the appropriate course / category information page. Please contact your theme developer for support if your custom menu is not automatically displayed.

Event Registration Page

You can allow your customers to register for your upcoming Events.

1. Create a page in WordPress that will be your event registration page.
2. Go the “Registration” tab in the Administrate plugin.
3. Select the page you created in the “Event Registration Page” drop-down.
4. Scroll down to the bottom of the page and click the “Save Changes” button.
5. The event registration page will now allow users to register for your upcoming events.

Event Registration Menu

You can display your upcoming Events in your website’s menu.

1. Create a page in WordPress that will be your event registration page.
2. If your theme is not using a custom menu on your website, create new custom menu under “Appearance” ... “Menus.”
3. Add whatever pages you wish to your menu, including the page you created as your event registration page.
4. Go the “Registration” tab in the Administrate plugin.
5. Select the page you created in the “Event Registration Page” drop-down.
6. Check the checkbox below the drop-down labelled “Automatically show events under event registration page in menu.”
7. Scroll down to the bottom of the page and click the “Save Changes” button.
8. Your custom menu on your website will now automatically display a submenu. When a user clicks on a link in the submenu, he/she will be taken to the appropriate event registration page. Please contact your theme developer for support if your custom menu is not automatically displayed.

Category List

The Category List widget will automatically display on the page you designate as your “Course Information Page” on the “Courses” tab.

If you wish to display a list of your course categories elsewhere, use the shortcode:

[administrate_category_list show_subcategories="true|false"]

Note: You must define a “Course Information Page” on the “Courses” tab so that the links in the Category List widget will point to the right place.

Subcategory List

The Subcategory List widget will automatically display on the page you designate as your “Course Information Page” on the “Courses” tab.

If you wish to display a list of your course subcategories elsewhere, use the shortcode:

[administrate_subcategory_list category="category ID"]

Note: You must define a “Course Information Page” on the “Courses” tab so that the links in the Subcategory List widget will point to the right place.

Category

The Category widget will automatically display on the page you designate as your “Course Information Page” on the “Courses” tab.

If you wish to display a single category elsewhere, use the shortcode:

[administrate_category category="category ID" show_codes="true|false"]

Note: You must define a “Course Information Page” on the “Courses” tab so that the links in the Category widget will point to the right place. The show_codes attribute indicates whether course names should include their course codes.

Subcategory

The Subcategory widget will automatically display on the page you designate as your “Course Information Page” on the “Courses” tab.

If you wish to display a single subcategory elsewhere, use the shortcode:

[administrate_subcategory subcategory="category ID" show_codes="true|false"]

Note: You must define a “Course Information Page” on the “Courses” tab so that the links in the Subcategory widget will point to the right place. The show_codes attribute indicates whether course names should include their course codes.

Course List

The Course List widget will automatically display on the page you designate as your “Course Information Page” on the “Courses” tab.

If you wish to display a list of your courses elsewhere, use the shortcode:

[administrate_course_list category="category ID" subcategory="subcategory ID" show_codes="true|false"]

Note: You must define a “Course Information Page” on the “Courses” tab so that the links in the Course List widget will point to the right place. You must specify either the category or subcategory attribute. The show_codes attribute indicates whether course names should include their course codes.

Course

The Course widget will automatically display on the page you designate as your “Course Information Page” on the “Courses” tab.

If you wish to display a single category elsewhere, use the shortcode:

[administrate_course course="course ID" show_code="true|false"]

Note: You must define an “Event Registration Page” on the “Registration” tab so that the links in the Category widget will point to the right place.

Event List

If you wish to display a list of your upcoming events, use the shortcode:

[administrate_event_list show_dates="true|false" show_codes="true|false" num_months="1...12" category="category ID" course="course code" location="location name" group_by="none|course|category|location" group_title_pre="text to prepend" group_title_post="text to append"]

Note: You must define an “Event Registration Page” on the “Registration” tab so that the links in the Event List widget will point to the right place.

You may use the following attributes:

• show_dates indicates whether to show the event date(s).
• show_codes indicates whether to show the course code in front of the course title.
• num_months indicates how many months in the future to show.
• category limits the events to the specified category ID.
• course limits the events to the specified course code.
• location limits the events to the specified location name.
• group_by groups the events by the specified method and adds a title to each group.
• group_title_pre prepends the specified string to the beginning of all group titles.
• group_title_post appends the specified string to the end of all group titles.
• registration_deadline_timezone is the timezone to be used when displaying the registration deadline, which is defined in UTC in the application. Accepts either an ISO string (‘Europe/London’, ‘America/Los_Angeles’), or an offset in hours (+1, -3, +5.5).

Event Slider

This displays 4 Events at a time within a sliding table.

[administrate_event_slider]

Note: You must define an “Event Registration Page” on the “Registration” tab so that the links in the Event List widget will point to the right place.

You may use the following attributes:

• show_dates indicates whether to show the event date(s).
• show_codes indicates whether to show the course code in front of the course title.
• registration_deadline_timezone is the timezone to be used when displaying the registration deadline, which is defined in UTC in the application. Accepts either an ISO string (‘Europe/London’, ‘America/Los_Angeles’), or an offset in hours (+1, -3, +5.5).

Event Table

The Event Table widget will automatically display on the page you designate as your “Course Information Page” on the “Courses” tab.

If you wish to display an event table elsewhere, use the shortcode:

[administrate_event_table show_prices="true|false" num_months="1-12" course="course code" show_categories="true|false" show_names="true|false" show_codes="true|false"]

Note: You must define an “Event Registration Page” on the “Registration” tab so that the links in the Event Table widget will point to the right place.

You may use the following attributes:

• show_prices indicates whether or not to show the event prices in the table.
• num_months indicates how many months in the future to show by default. Note that users will be able to change the view from 1-12 months.
• course limits the events to the course code specified.
• show_categories indicates whether or not to allow the user to filter events by course category.
• show_names indicates whether or not to show the course names in the table.
• show_codes indicates whether or not to show the course codes in the table.
• registration_deadline_timezone is the timezone to be used when displaying the registration deadline, which is defined in UTC in the application. Accepts either an ISO string (‘Europe/London’, ‘America/Los_Angeles’), or an offset in hours (+1, -3, +5.5).

Learning Path List

This displays a list of Learning Paths which can be purchased by clicking Register Now , or view further information by clicking on its name.

NOTE: You must be using the new sales opportunities system to accept orders for this to work. You can turn this on or off in the ‘Registration’ tab of the administration menu.

[administrate_learning_track_list]

You may use the following attributes:

• group_size: Number of learning paths to show per page. (default: show all)
• no_learning_tracks: Message to show when there are no learning paths available. (default: no message)
• currency: Currency in which learning paths will be sold. Paths will show regardless, but can only be booked if a price exists in the application for this currency. (default: GBP)

Update Your Administrate Plugin Settings

On the WordPress Administrate plugin 'Registration' tab, ensure the "Accept payment by credit card (Requires 3rd-party payment processor)" option is selected, and that the "Payment Processor" is set to PayPal.

Configure PayPal to Turn on Auto Return

Make sure you have set “Auto Return” to “ON” within your PayPal account. Navigate to “Profile” > “My Selling Preferences”. And click “update” on the “Website Preferences” line, which may be found within the “Selling Online” section. Set auto-return to On and the return URL to your web site address. Remember to click “Save” at the bottom of the page to make these change permanent.

Enter Your PayPal Credentials

To find the API details log in to PayPal and select “Profile” > “My Selling Preferences” from the top menu. Click “update” on the “API Access” line, which may be found within the “Selling Online” section. Select option 2 “View API Signature” to generate (or show if you have previously generated) your API credentials.

If you’ve not generated your API credentials before, select “Request API signature” and click “Agree and Submit” to generate your credentials. Copy and paste each of these from PayPal into the relevant section at the bottom of the WordPress plugin control panel:

1. API Username
2. API Password
3. Signature

Important Note: PayPal recently dropped support for testing using the Sandbox mode. This option will be removed in a future version.

Update Your Administrate Plugin Settings

On the WordPress Administrate plugin settings page change allowable payment types to allow payment by credit card and ensure the online payment processor is set to SagePay.

Add Your Website IP Address to SagePay

You’ll need the public IP address of your website. If you’re unsure of this, you’ll be able to find this out from your web host. Then, follow the instructions here to add the IP address to SagePay:

Adding an IP Address to your account.

Update Your Administrate Plugin Settings

On the WordPress plugin settings page, in the Registration tab, ensure that “Accept payment by credit card” is checked and that the online payment processor is set to Stripe.

Enter Stripe Credentials

You’ll then need to provide the following Stripe user credentials:

1. Stripe Secret Key,
2. Stripe Public Key.

From Stripe:

• Where do I find my API keys?
• What’s the difference between the secret key and the publishable key?

Update Your Administrate Plugin Settings

On the WordPress plugin settings page, in the Registration tab, ensure that “Accept payment by credit card” is checked and that the online payment processor is set to WPM.

Enter WPM Details

You’ll then need to provide the following WPM user details:

1. Payment Pathway URL
2. Pathway ID
3. Client ID
4. Shared Key
5. Department ID

These will be provided by WPM.

I made and saved changes in my Administrate WordPress Plugin, why aren’t they reflected on my website?

You should purge your current cached copy of the website and rebuild it, as well as do a hard refresh your browser. To do this, go to the API tab of the Administrate WordPress Plugin and in the section titled, ‘Cache Actions’, click on each of the buttons in order (allowing for each to be actioned before clicking on the next one):

• Purge Cache
• Build Cache
• Refresh URLs

Then, in your browser, force a refresh of the cache. This is different from the standard reload icon or standard F5 (on a PC) shortcut. The actual command may vary between browsers and platforms, but typically on a PC this is CTRL-F5 or CMD-R on a Mac.

If you are having issues getting your price to populate, please review our pricing documentation to ensure it has been set up properly: Pricing.

How do I check which version of Wordpress I am using?

To check the version of Wordpress you are currently using, access your Wordpress Admin page and select “Dashboard → Updates” in the left-hand side menu. You should see your version (or a request to update your version) on that page.

What payment providers do you support?

We currently support:

• PayPal
• SagePay
• Stripe

We have plans to support other providers on a case by case basis.

How do I change the look and feel of the plugin screens?

You can use CSS to change the look and feel of the plugin from within your WordPress theme. CSS will allow you to radically reposition elements, change colours, fonts, etc., and these changes will be saved within your WordPress theme so upgrades to the plugin won’t destroy your visual customisations. We recommend checking the plugin pages after each upgrade just to be sure we haven’t added anything that you may now need to style.

Can I reword anything on the generated pages?

The wording of error messages can be controlled from the WordPress Administrate plugin settings page. If you want to reword the content of the templates within the 4-stage checkout process, please create your own custom template designs as detailed above.

I’m an Enterprise User with multiple Companies, how do I display Events from a single Company only?

You can filter the individual widgets by Course Category and/or Location , assuming each Course Category is owned by a Company . For example, to insert a table of Events related to Courses of 2 categories only:

[administrate_course_list category="54,55" show_codes="false"]

In this example, the category IDs are 54 and 55. To identify the category IDs, please check the ‘Reference’ tab of Administrate WordPress Plugin.

Can I hide the ‘Powered By Administrate’ footer on the checkout screen because it doesn’t match my website?

You can hide the ‘Powered by Administrate’ footer by simply inserting the following HTML code into the same page as the Administrate Plugin.

<style type="text/css">
        .administrate-footer {
                display: none !important;
        }
</style>

My WordPress site is not working properly and I have other WordPress plugins installed, could they be conflicting?

It is possible. In such situations, we advise that you disable all the other WordPress plugins, and reenable them one by one, checking your site after each change (using these steps) to whittle down which plugin is causing the issue.

Known Plugins that Conflict with the Administrate Plugin:

• WP Super Cache ver 1.6.4 - A potential conflict with the booking process that may persist customer data during bookings. To resolve this you can configure WP Super Cache to exclude the /bookings/ pages - see example below:
  

If you come across any plugins that you know cause an issue with the Administrate WordPress Plugin, please let us know.