Installation

Installation of wbTimelog 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 database before starting the installation process.

Disclaimer: Before First Run

wbTimelog will automatically insert or update database tables upon first run after installation and when upgrades are made to the system. NO CHANGES are made to any of the original WHMCS Database Table structures.

wbTimelog integrates with database tables from the WHMCS system to create relationships with Administrators, Clients, Invoices, and Support Tickets. All wbTimelog data is stored in database tables starting with the prefix "tbladdon_wbclientstimelog" 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.

Uploading wbTimelog

  1. Extract the contents of the wbTimelog package to your Local Disk
  2. Upload the contents of the "installation" folder into the root WHMCS folder.

The "installation" folder will include the following files:

 /wbtimelog.php
 /modules/addons/wbDatabase.php
 /modules/addons/wbtimelog/*.*
 /modules/reports/wbTimelog_Monthly.php
 /modules/servers/wbtimelog/*.*
 /templates/default/header.tpl-example
 /templates/default/wbtimelog.tpl
 /templates/six/wbtimelog.tpl

Add the Time Log menu link to the Client Header (WHMCS v5 Only)

  1. Identify which client portal template folder for your active template:

    /templates/{my-template-folder}/
    
  2. Verify that you have a file labeled wbtimelog.tpl in your template folder. If not, copy the file from /templates/default/wbtimelog.tpl into your template folder.

  3. Backup your existing header.tpl file by creating a copy with the name header.tpl-backup.

  4. Open your header.tpl file find the following two lines (perform a keyword search for wbTimeLog).

    {* wbTimeLog Customization *}
    <ul><li><a href="wbtimelog.php" title="{$LANG.wbtimelogtab}">{$LANG.wbtimelogtab}</a></li></ul>
    
  5. Copy the two lines and paste them into the same location of your existing header.tpl file.

Clear your Template Cache

After making changes to your template files you will need to clear the template cache, otherwise changes may not be visible which can be mistaken for an error. To clear your template cache, open the Utilities > System > System Cleanup page from the WHMCS administration. From the System Cleanup page, select the "Empty Template Cache" option to clear your template cache. Once cleared, any new changes will be visible.

Activate your wbTimeLog addon

  1. From the WHMCS Administration, open the page: Setup > Addon Modules
  2. Click on the Activate link for the wbTimeLog module.
  3. Once Activated, press the "Configuration" button, scroll to the bottom of the settings list and select the Administrator Roles that should have access to wbTimeLog.
  4. Press Save Changes

Refer to the Configuration section for details on the available configuration options in wbTimeLog.