1.3.2 - Installation v1 Series Print

** The following instructions are for v1.0.0 through v1.7.6 Only **
For a list of all versions click here.

Installation of wbTeamPro will require FTP access to your WHMCS file structure and a general knowledge of file editing and permissions. It is strongly advised that you perform a complete backup of your WHMCS files and MySQL data before starting the installation process.

During installation you will be required to either modify or overwrite some of the existing WHMCS administration template files. The template files included with the installation package will be marked with a "-example" extension. These example templates can be used to overwrite the existing template files if your current template files are original.

Downloading wbTeamPro

1. Login to your account
2. Click the "My Services" link
3. Select your Active wbTeamPro License and View Details
4. Download the Latest Version from the Downloads List
5. Make Note / Copy your License Key to be used during configuration

Disclaimer: Before First Run

Starting with version 1.7.0 wbTeamPro will automatically insert or update database tables upon first run after installation.

NO CHANGES are made to any of the original WHMCS Database Table structures.

wbTeamPro integrates with database tables from the WHMCS system to create relationships with Administrators, Clients, and Support Tickets.  wbTeamPro Email Notifications are generated using Email Templates stored in the WHMCS Email Templates database table (tblemailtemplates).  With the exception of the email templates, all wbTeamPro data is stored in database tables starting with the prefix "tbladdon_wbteampro_" and can be removed without affecting the WHMCS system.

Backup Your Installation

Before making changes to your WHMCS installation, always remember to make a complete backup of the MySQL Database and WHMCS Installation files.  If you are unable to make a backup, please contact your hosting provider and ask for assistance.

Upgrading Previous Installations

To upgrade a previous version of wbTeamPro simply overwrite existing installation files with the new files provided.

1. Rename your wbTeamPro config.php file:
   

   /{whmcs}/admin/AddOns/_wbteampro_/config.php

   rename to
   

   /{whmcs}/admin/AddOns/_wbteampro_/config.php-MMDDYY

2. Follow the instructions for "Uploading wbTeamPro"

Uploading wbTeamPro

1. Backup your existing WHMCS system Files & MySQL Database
2. Extract the contents of the wbTeamPro package to your Local Disk
3. Upload the contents of the "installation" folder to your WHMCS installation root.
   
   *ADMIN FOLDER* If you have changed the "admin" folder of your WHMCS,
   you will need to rename the "admin" folder of the installation before uploading.
   
   The Installation should include the following files:
   

   /{whmcs}/configuration-addons.php
   /{whmcs}/wbteampro.php
   /{whmcs}/AddOns/_wbteampro_/{package_files}
   /{whmcs}/templates/{template}/wbteampro.tpl
   /{whmcs}/templates/{template}/header.tpl-example
   /{whmcs}/admin/wbteampro.php
   /{whmcs}/admin/AddOns/whmcs_dbh.php
   /{whmcs}/admin/AddOns/_wbteampro_/{package_files}
   /{whmcs}/admin/templates/{template}/header.tpl-example
   /{whmcs}/admin/templates/{template}/menu.tpl-example
   /{whmcs}/admin/templates/{template}/sidebar.tpl-example
   

Update WHMCS Templates

The following instructions are for a standard WHMCS installation using the "portal" client template, and the "v4" administrator template.  If you are not using the default templates, then the following changes should be applied to your active templates.  The wbTeamPro installation comes with the following template examples:

/{whmcs}/templates/classic
/{whmcs}/templates/default
/{whmcs}/templates/portal
/{whmcs}/admin/templates/blend
/{whmcs}/admin/templates/original
/{whmcs}/admin/templates/simple
/{whmcs}/admin/templates/v4

NOTE: You will need to make the following changes to all templates that are used.

You have TWO Options for merging the required changes:

1. Option A - OVERWRITE the files if they are original
   
   
   1. Rename existing template files, add a "-backup" to the filename.
      

      /{whmcs}/templates/{template}/header.tpl-backup
      /{whmcs}/admin/templates/{template}/header.tpl-backup
      /{whmcs}/admin/templates/{template}/menu.tpl-backup
      /{whmcs}/admin/templates/{template}/sidebar.tpl-backup

   2. Rename the example file, removing the "-example"
      

      /{whmcs}/templates/{template}/header.tpl-example
      /{whmcs}/admin/templates/{template}/header.tpl-example
      /{whmcs}/admin/templates/{template}/menu.tpl-example
      /{whmcs}/admin/templates/{template}/sidebar.tpl-example

      
      
2. Option B - EDIT the files if they are already customized
   
   
   1. /{whmcs}/templates/{template}/header.tpl (CLIENT SIDE)
      Edit the header.tpl-example file provided, find the "wbTeamPro Customization" lines and move them into your client template.
      
      
   2. /{whmcs}/admin/templates/{template}/header.tpl (ADMIN SIDE)
      Edit the header.tpl-example file provided, find the "wbTeamPro Customization" lines and move them into your client template.
      
      
   3. /{whmcs}/admin/templates/{template}/menu.tpl (ADMIN SIDE)
      Edit the menu.tpl-example file provided, find the "wbTeamPro Customization" lines and move them into your client template.
      
      
   4. /{whmcs}/admin/templates/{template}/sidebar.tpl (ADMIN SIDE)
      Edit the sidebar.tpl-example file provided, find the "wbTeamPro Customization" lines and move them into your client template.

Assigning File Permissions

The ".project_files" folder will require write permissions for attachment storage (unless php is running as suPHP or PHPSuExec):

CHMOD 777 Writeable
/{whmcs}/admin/AddOns/_wbteampro_/.project_files

Include AddOn to Configuration File

1. Open the "configuration.php" file found in your WHMCS folder.
   

   /{whmcs}/configuration.php 

2. Add the following code at the end of the file and save.
   

   if( file_exists(dirname(__FILE__).'/configuration-addons.php') )
     include(dirname(__FILE__).'/configuration-addons.php');

Configuration of wbTeamPro

1. Time Zone
   Once your files and SQL has been installed you will first need to update the Time Zone setting found in the file:
   

   /{whmcs}/configuration-addons.php

   To find your correct Time Zone you will need to visit the PHP documentation page found here:
   

   http://www.php.net/manual/en/timezones.php 

2. License Activation
   Your license has already been generated upon the purchase of your copy of wbTeamPro but needs to be applied to your installation. To retrieve and apply your license key please follow section 1.4 - License Key.
   
   
3. Additional wbTeamPro Settings
   Your copy of wbTeamPro has several configuration values that may be modified. The learn more about customizing wbTeamPro please view section 1.5 - Configuration.

Clear your Template Cache

After making changes to your templates you will need to clear the template cache files, otherwise your changes will not be visible which can be mistaken as an error.

WHMCS provides a tool for clearing your template cache.  From the top menu, visit the Utilities > System Cleanup page and select the "Emtpy Template Cache" option.  Remember to perform this step after each template change you make during the installation.

Un-Installing wbTeamPro

To un-install wbTeamPro you will need to reverse the above listed installation steps and remove the tables that have been added into the database.

1. Remove Template Changes
2. Remove Installation Files
3. Remove Database Tables (tables with the prefix "tbladdon_wbteampro_")