1.5 - Configuration Print

The following instructions are for wbTeamPro v1.7.6 and Below.
All configuration for v2 and Higher can be found from
within the WHMCS Administration Panel.

Understanding Config.php

Note: If you are installing wbTeamPro for the first time you will need to install your wbTeamPro License Key by following the instructions in section 1.4 - License Key.

* BACKUP YOUR CONFIG.PHP FILE BEFORE EDITING *

All global settings for the wbTeamPro system are (currently) located in the config.php file found within the administration addons folder:

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

The wbTeamPro configuration is an array of values represented as key pairs seperated by a comma as in the example:

  $_addons_wbteampro_cfg = array(
    'key' => 'value' ,
    'key2' => 'value'
  );

When editing the value for a configuration key you must make sure to leave any trailing commas ( , ) or else the configuration file will fail to load.

Configuration Options (keys)

1. license_key - (string) this is the license key for your wbTeamPro installation.
2. admin_super_roles - (array) this is a list of the IDs of administrator roles that have super admin access to the system
3. admin_valid_roles - (array) this is a list of the IDs of administrator roles that can access to the system
4. max_action_depth - (integer) this value is the maximum depth that an action tree can grow
5. project_link_target - (string: _blank, _parent, _top, _self) this value will be used to determine whether clicking on a project link opens a new window or loads in the same window
6. client_link_target - (string: _blank, _parent, _top, _self) this value will be used to determine whether clicking on a client link opens a new window or loads in the same window
7. ticket_link_target - (string: _blank, _parent, _top, _self) this value will be used to determine whether clicking on a ticket link opens a new window or loads in the same window
8. admin_display_name - (boolean: true, false) this determines whether administrator names will be displayed as a fullname "John Smith" or the username "jsmith"
9. page_listing_limit - (integer) this is the total number of records that is displayed per-page when viewing a list of records
10. keepalive_timeout - (integer / boolean false) this value represents the number of seconds that the keepalive feature will wait between pings to the your server. To disable this feature use the boolean value false.
11. project -> adjust_date - (boolean: true, false) when enabled this feature causes the start & end dates for a project to automatically adjust to encompass the start & end dates set for the project actions. The project date will expand to include new actions with a date exceeding the project date range, but will not contract if the action is adjusted or removed.
12. project -> project_type - (array) this is a customizable list of the available "Project Type" values that will be displayed when editing a project
13. project -> project_status - (array) this is a customizable list of the available "Project Status" values that will be displayed when editing a project
14. action -> adjust_date - (boolean: true, false) when enabled this feature causes the start & end dates for a action to automatically adjust to encompass the start & end dates set for the actions sub-actions. The action date will expand to include new sub-actions with a date exceeding the project date range, but will not contract if a sub-action is adjusted or removed.
15. action -> finish_offset - (integer) this is the default finish date offset (in seconds) that is used when creating a new action
16. action -> action_type - (array) this is a customizable list of the available "Action Type" values that will be displayed when editing a action
17. action -> action_status - (array) this is a customizable list of the available "Action Status" values that will be displayed when editing a action
18. format -> projectDate .. filePostDate - (string: php date) the date format values are passed to the php date function, reference: http://php.net/manual/en/function.date.php
19. format -> adminName .. contactName - (string: mysql) this mysql sub-query can be modified to change the format of display names in the system - this advanced feature should not be modified without MySQL experience
20. plugins -> xxx -> email_bcc - (string) the BCC value can be a comma seperated list of email addresses that will receive copies of all Email Notifications
21. plugins -> system.cleanup -> offset_days - (integer) the number of days before an action finish date that the Action Expiring alert will be sent