Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
<meta name="keywords" content="advanced billing for whmcs, advanced billing  configuration, advanced billing  management, advanced billing  installation, advanced billing  guide, modulesgarden advanced billing, advanced billing  wiki, advanced billing  tutorial, advanced billing  tips, whmcs billing module wiki, advanced billing  common problems, about advanced billing, advanced billing  documentation, advanced billing  faq, advanced billing  help"></meta>
+
<meta name="keywords" content="time tracking center for whmcs, time tracking center configuration, whmcs time tracking center management, whmcs time tracking center installation, whmcs time tracking center common problems, about whmcs time tracking center, whmcs time tracking center documentation, whmcs time tracking center faq, whmcs time tracking center help, whmcs time tracking center guide, whmcs time tracking center wiki, whmcs time tracking center tutorial, whmcs time tracking center tips, whmcs time tracking center wiki"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Advanced Billing For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Time Tracking Center For WHMCS Module."></meta>
  
=About [http://www.modulesgarden.com/products/whmcs/advanced_billing/features Advanced Billing For WHMCS]=
+
=About [http://www.modulesgarden.com/products/whmcs/time_tracking_center/features Time Tracking Center For WHMCS]=
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''Advanced Billing For WHMCS''' allows you to set up additional billing options for your products like bandwidth or CPU usage, basing on actual server resource usage.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Time Tracking Center For WHMCS''' will let you add various tasks, track their development basing on the time spent on their execution and charge your customers accordingly.<br />
In other words, the module will let you charge customers on the grounds of the resources used by them. It offers also hourly billing, ticket billing, credit billing and recurring billing.<br />
+
The module enables your clients to order and monitor products with a chosen amount of hours that can be spent on performance of your services.<br />
The module will also automatically generate invoices on the basis of the data gathered by the synchronization. It is integrated with many modules including cPanel and SolusVM.
+
Additionally, you can offer your customers prepaid hours and incidents as well as manage tasks connected to specific support tickets.
 
|}
 
|}
<!--Comment-->
+
<!-- comment made here -->
*'''Core Features:'''
+
*'''Addon Module Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Hourly Billing For Any WHMCS Module
+
|style="padding: 10px 0px 0px 30px;"|✔ Add/Edit/Remove Support Clients
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Ticket Billing
+
|style="padding: 0px 0px 0px 30px;"|✔ Add/Edit/Remove Tasks
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Billing Per Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Add/Edit/Remove Predefined Tasks
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Manage Extensions And Configure Them Per Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Add/Edit/Remove Time Entries - Time Spent On Task
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Current List Of Billable Items For Next Invoices
+
|style="padding: 0px 0px 0px 30px;"|✔ Create/Edit Tasks Connected To Specific Tickets
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Resources Usage History Of Any Item
+
|style="padding: 0px 0px 0px 30px;"|✔ View List Of Billable Time Entries
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Manage Awaiting Invoices And Convert Them To Invoices
+
|style="padding: 0px 0px 0px 30px;"|✔ Generate Invoices Automatically Or Manually
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Invoices Creation To Cron Queue
 
|}
 
|}
*''''Recurring Billing' Extension Features:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Bill On Account Terminate
+
|style="padding: 0px 0px 0px 30px;"|✔ Define And Bill For Mileages Travelled
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Bill When Invoice Is Generated For Hosting
+
|style="padding: 0px 0px 0px 30px;"|✔ Set Predefined Prices
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Bill Each X Day Of Month
+
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Notifications - New Task/New Time Entry
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Bill Each X Days
+
|style="padding: 0px 0px 0px 30px;"|✔ Generate And View Fully Configurable Reports About Your Clients And Admins
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Automatically Generate An Invoice
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose From Two Types Of Configurable Permissions - Full Privileges And Operator Privileges
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Invoice Payment Due Date
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
 
|}
 
|}
 +
*'''Provisioning Module Features:'''
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Automatically Apply Credits
+
|style="padding: 10px 0px 0px 30px;"|✔ Create Support Client Accounts Upon Module Activation
 
|}
 
|}
*''''Credit Billing' Extension Features:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Generate Invoice Each X Days
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Defined Number Of Prepaid Hours To Your Clients Automatically
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Minimal Amount Of Credit To Charge
+
|style="padding: 0px 0px 10px 30px;"|✔ Supports One Time & Recurring Payment Types
 
|}
 
|}
 +
*'''Task Configuration:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Send Email When Client's Credit Balance Falls Below Defined Credit Amount
+
|style="padding: 10px 0px 0px 30px;"|✔ Support Client
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Automatically Suspend Account When Client Is Out Of Credits
+
|style="padding: 0px 0px 0px 30px;"|✔ Task Name
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Invoice Payment Due Date
+
|style="padding: 0px 0px 0px 30px;"|✔ Predefined Incidents
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ List Summary Credit Billing Charges Of Any Hosting
+
|style="padding: 0px 0px 0px 30px;"|✔ Predefined/Custom Charge Per Hour
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Refund Credit Payment To Client
+
|style="padding: 0px 0px 0px 30px;"|✔ Charge Per Mileage
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Automatically Refill Client's Credit Balance Using Their Credit Card
+
|style="padding: 0px 0px 0px 30px;"|✔ Mileage Type - Billable / Visible For Client And Administrators / Visible For Administrators Only
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Client Can Enable/Disable Auto Refilling And Define A Single Refill Amount
+
|style="padding: 0px 0px 0px 30px;"|✔ Task Status
 
|}
 
|}
*''''Resource Usage' Extension Features:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Define Period For Counted Resource Usage
+
|style="padding: 0px 0px 10px 30px;"|✔ Description
 
|}
 
|}
 +
*'''Available Cron Job Behavior Settings:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define Resource Usage Counting Precision
+
|style="padding: 10px 0px 0px 30px;"|✔ Generate Invoices For Queued Time Entries Only
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Show History Of Resource Usage
+
|style="padding: 0px 0px 0px 30px;"|✔ Generate Invoices For All Time Entries From Previous Week
 
|}
 
|}
*'''Supported Modules:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/autoscaling/features Autoscaling] - Standalone Extension - Automatically Adjust And Upgrade/Downgrade The Products Of Your Clients According To The Server Resource Usage
+
|style="padding: 0px 0px 10px 30px;"|✔ Generate Invoices For All Time Entries From Previous Month
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ cPanel & [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended] Integration: Hourly, Bandwidth, Storage, Databases, Addon Domains, Subdomains, Parked Domains, Domain Forwarders, FTP Accounts, Installed Applications, Email Accounts
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Currencies Support
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Parallels Plesk Panel & [http://www.modulesgarden.com/products/whmcs/parallels_plesk_panel_extended/features Parallels Plesk Panel Extended] Integration: Hourly, Subdomains, Disk Space, Email Boxes, Sites, Redirects, Mail Groups, Autoresponders, Mailing Lists, Users, Databases, Webapps, Traffic
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ DirectAdmin & [http://www.modulesgarden.com/products/whmcs/directadmin_extended/features DirectAdmin Extended] Integration: Hourly, Bandwidth, Storage, Subdomains, Domain Pointers, FTP Accounts, MySQL Databases, Virtual Domains, Mailing Lists, POP Accounts, Email Forwarders, Email Autoresponders
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 Up To V5.3.14
 
|}
 
|}
 +
 +
=Installation and Configuration=
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/parallels_cloud_server/features Parallels Cloud Server] Integration: Templates, CPU Usage, Memory, Bandwidth IN, Bandwidth OUT, Disk Used, Backups Usage
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Time Tracking Center For WHMCS.''' <br />
 +
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ SolusVM & [http://www.modulesgarden.com/products/whmcs/solusvm_extended_vps/features SolusVM Extended VPS] Integration: Hourly, Disk Usage, Memory Usage (except KVM virtualization), Bandwidth Used
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Time Tracking Center For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|[http://www.modulesgarden.com/products/whmcs/solusvm_extended_cloud/features SolusVM Extended Cloud] Integration: Available Disk Size, Disk Usage, Available Bandwidth, Available Memory, Cores, IP Addresses, Disk Usage, Memory Usage (except KVM virtualization), Bandwidth Used
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/proxmox_vps/features Proxmox VPS] Integration: Hourly, Disk Usage, Bandwidth IN, Bandwidth OUT, Memory Usage, Backups Usage, CPU Number, CPU Usage
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
 +
Files in your WHMCS directory should look like this.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|[http://www.modulesgarden.com/products/whmcs/proxmox_cloud/features Proxmox Cloud] Integration: Disk Usage, Disk Size, Bandwidth IN, Bandwidth OUT, Memory Usage, Memory Size, Backups, CPU Number, CPU Usage
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_2.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/openstack_vps/features OpenStack VPS] Integration: Hourly, VCPU Cores, Memory Usage, CPU Utilization, Incoming Bandwidth, Outgoing Bandwidth, Disk Root Used, Disk I/O Read, Disk I/O Write, Floating IP, Fixed IP, Backups Number
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Time Tracking Center for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/addons/TimeTrackingCenter/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|[http://www.modulesgarden.com/products/whmcs/rackspace_email/features Rackspace Email] & [http://www.modulesgarden.com/products/whmcs/rackspace_email_extended/features Rackspace Email Extended] Integration: Hourly, Mailbox Storage, Mailboxes, Sync Licenses, Blackberry Licenses, Exchange Storage, Exchange Mailboxes
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_3.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ [http://www.modulesgarden.com/products/whmcs/zimbra_email/features Zimbra Email] Integration: Hourly, Mailboxes, Aliases, Storage
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
 +
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area'' → 'My Products' ''.  
 
|}
 
|}
*'''General Info:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Count Usage Of All Accounts Assigned To Reseller - cPanel, [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended], DirectAdmin & [http://www.modulesgarden.com/products/whmcs/directadmin_extended/features DirectAdmin Extended]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_4.png]]
 
|}
 
|}
 +
 +
==Configuration Of Addon==
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|'''Multi-Language Support'''
+
|style="padding: 10px 0px 15px 15px;"|'''5. Now you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Time Tracking Center' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_5.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module and set up basic configuration.'''<br />
 +
To do so, click on '' 'Configure' '' button.<br />
 +
Afterwards, define whether to allow billing for mileage and define to whom emails should be sent by defining their type (System/Account/Support).<br />
 +
Assign permissions to admin roles in your system, you can grant '' 'Full Privileges' '' and '' 'Operator Privileges' ''.<br />
 +
'' 'Full Privileges' ''(1) grants access to all tabs of Time Tracking Center addon.<br />
 +
'' 'Operator Privileges' ''(1) grants access for the admin roles to tabs chosen in the '' 'Operator Access Control' ''.<br />
 +
'' 'Operator Access Control' ''(2) defines tabs to which operator should have access to.<br />
 +
Afterwards, tick '' 'Access Control' ''(3) near required admin role groups and press '' 'Save Changes' ''.
 
|}
 
|}
 
=Installation=
 
 
{|
 
{|
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to successfully install and manage Advanced Billing For WHMCS.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_6.png]]
We will guide you step by step through the whole installation and configuration process.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Advanced Billing For WHMCS.'''
+
|style="padding: 0px 0px 15px 15px;"|'''7. Additionally, here you can set up invoice description format and predefined price per hour.<br />
 +
You can use variables listed under a help sign to define invoice description, each invoice description allows different set of variables.<br />
 +
More about setting up predefined price per hour in [[Time_Tracking_Center_For_WHMCS#Predefined_Price_And_Prepaid_Hours|Predefined Price And Prepaid Hours]] section.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_6_1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Time Tracking Center For WHMCS!'''<br />
Files in your WHMCS directory should look like this.
+
You can access your module in '' 'Addons' '' → '' 'Time Tracking Center' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_7.png]]
 
|}
 
|}
 +
 +
=Management=
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''3. Now you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Time Tracking Center For WHMCS.'''<br />
Log in to your WHMCS admin area. Click '' 'Setup' '' then choose '' 'Addon Modules' '' .<br />
+
Our module allows you to easily add and track progress of tasks ordered by your clients while your staff are able to easily report time spent on each of them.<br />
Afterwards find '' 'Advanced Billing' '' and press '' 'Activate' '' button.
+
Additionally, you can manually bill your clients for time already spent on their tasks or use cron job to do it automatically.<br />
 +
Owing to integration code, you can even display current status of tasks assigned to clients at their client area, as well as show them the amount of prepaid hours & incidents they own.
 
|}
 
|}
 +
==Predefined Price And Prepaid Hours==
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_5.png]]
+
|style="padding: 10px 0px 30px 15px;"|You can easily set up predefined price per hour using client custom fields.<br />
 +
Afterwards, you can sell those hours to your clients using provisioning module.
 
|}
 
|}
 +
===Setting Up Custom Field===
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''4. In the next step you need to permit access to the module.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|First of all, set up client custom field visible only from the admin area.<br />
To do so, click on '' 'Configure' '', choose desired admin roles and press '' 'Save Changes' ''.
+
To do so, proceed to '' 'Setup' '' → '' 'Custom Client Fields' ''. Fill in its name, choose '' 'Text Box' '' field type.<br />
 +
Additionally, you can ensure that only numerical values will be placed there.<br />
 +
Copy regular expression shown below into validation field as presented on the following screen.<br />
 +
^[0-9]*$
 +
Now, mark '' 'Admin Only' '' checkbox and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_8.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''5. Now, proceed to [[#Extensions|Extensions]] section to find more about configuring license.
+
|style="padding: 0px 0px 15px 15px;"|You can set up prepaid incidents the same way.<br />
 +
The only difference is placing '' 'incident' '' into '' 'Select Options' '' field.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|'''6. The last step is setting up a cron job, you can find it in your WHMCS → '' 'Addons' '' → '' 'Advanced Billing' '' as shown on the following screen.'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_9.png]]
 
|}
 
|}
 +
 +
===Predefined Price===
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_7.png]]
+
|style="padding: 10px 0px 15px 15px;"|As soon as you create a custom client field, proceed to '' 'Setup' '' → '' 'Addon Modules' '' and press '' 'Configure' '' next to '' 'Time Tracking Center' ''.<br />
 +
Afterwards, fill in predefined price per hour for previously created custom field and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|'''Well done, you have just successfully installed Advanced Billing For WHMCS! '''
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_10.png]]
 
|}
 
|}
  
=Configuration and Management=
+
===Prepaid Hours & Incidents===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Now let's learn more about module's functionalities. We will present you the possibilities of our product on cPanel Extended For WHMCS example.<br />
+
|style="padding: 10px 0px 15px 15px;"|Owing to our module, you can even offer prepaid hours and incidents to your clients as a product in your system.<br />
Please note that billing features are different in each module but the core functionality of Advanced Billing is the same for each.<br />
+
To set up the first product, proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.<br />
First, choose your module from '' 'Enable Advanced Billing for' '' dropdown menu as it is shown on the following screen.<br />
+
Press '' 'Create a New Group' '' to create a new product group or use existing one instead.
For presentation purposes we have chosen '' 'cPanel Premium' '' with cPanel Extended module.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_8.png]]  
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_10_1.png]]
 
|}
 
|}
==Core==
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|Our module core has been redesigned to allow collecting the records and invoices' management.<br />
+
|style="padding: 0px 0px 20px 15px;"|Fill in product group name and press '' 'Save Changes'''.
All other features are handled by extensions, which can be easily enabled/disabled, and are configured per product.
+
 
|}
 
|}
===Configuration===
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|Core configuration consists of 2 tabs.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_10_2.png]]
You can access resource usage pricing from any tab.
+
 
|}
 
|}
====General Settings Tab====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Here you can find information about the module used by your product. If the module is not supported, '' 'Basic Module' '' mode will be used instead.<br />
+
|style="padding: 0px 0px 20px 15px;"|Now, create a new product, press '' 'Create a New Product' '' to proceed.
'' 'Basic Module' '' enables you to bill your client for hourly usage of the product only.<br />
+
In this tab you can also enable/disable Advanced Billing for product.<br />
+
To disable it, simply unmark '' 'Enable' '' checkbox and press '' 'Save Changes' '' button, as shown on the following screen.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_11.png]]
 
|}
 
|}
====Module Settings Tab====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|''This tab is visible only for cPanel/cPanel Extended modules.''<br />
+
|style="padding: 0px 0px 20px 15px;"|Fill in product name, choose previously created group and press '' 'Continue' ''.
Here you can set Application Manager (Softaculous/Installatron) and cPanel theme. '' 'x3' '' is a theme's default value.<br />
+
To use different theme simply enter its name as shown on the screen below.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_12.png]]
 
|}
 
|}
====Used Resource Pricing====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In the bottom part of the screen you can set up billing for specific server resource usage like e.g. bandwidth.<br />
+
|style="padding: 0px 0px 20px 15px;"|Uncheck '' 'Require Domain' '' checkbox and proceed to '' 'Pricing' '' tab.
*'''Free Limit''' - is used to set amount of usage records for which customer won't be charged.<br />
+
In our example, customer won't be charged for 1GB (1024MB) bandwidth.<br />
+
*'''Price''' - defines how much your client will have to pay for specific resource. Note that we provide two types of charging: units per hour and units used since last cron run.<br />
+
For example, user pays for subdomain quantity each hour, but when traffic is generated, bandwidth used since the last cron run will have to be paid once only.<br />
+
*'''Displayed Unit''' - category defines how record usage will be displayed. It does not affect free limit and pricing, they are calculated in basic unit.<br />
+
If you select '' 'GB' '', free limit will be still 1024 MB, and price will be MB/hr, '''not''' GB/hr.<br />
+
*'''Status''' - allows you to enable/disable billing for this resource.<br />
+
To proceed, choose your usage records, units, status, set up the prices and free limits. Afterwards, press '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_12_1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|As you could notice on the screen below, '' 'Configure' '' column has been added.<br />
+
|style="padding: 0px 0px 15px 15px;"|Choose payment type, enable wanted billing cycles and fill in price for each of them.<br />
It allows you to set up different free limits and pricing depending on resource origin.<br />
+
Now, go to '' 'Module Settings' '' tab.
Currently only Parallels Cloud Server submodule supports this feature.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_13_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_12_2.png]]
 
|}
 
|}
===Items===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|To view counted usage, go to '' 'Items' '' tab.<br />
+
|style="padding: 0px 0px 15px 15px;"|Choose a '' 'TimeTrackingPrepaid' '' module from '' 'Module Name' '' dropdown menu.<br />
Each cron run will create an item for each customer, if it does not exist at the moment, and add new records to existing ones.<br />
+
Afterwards, fill in the amount of prepaid hours and incidents this product will grant to clients and press '' 'Save Changes' ''.<br />
In that way you can see current server resources usage from the last billing period.<br />
+
''Note 1: Afterwards, prepaid hours can be used to pay for tasks, using the same prepaid hour type.''<br />
Automatic generation of invoices is basing precisely on previously created items.<br />
+
''Note 2: Prepaid incidents can be used to offer one time support services.''<br />
To view more details click on '' 'Show usage records' '' as shown on the following screen.<br />
+
''Incidents are removed from the client account during the creation of a task using those incident.''
You can also easily remove billing for specific hosting. To do so, press '' 'x' '' in '' 'Delete' '' column.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_14.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_13.png]]
 
|}
 
|}
 +
 +
==Addon==
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"| After pressing 'Show usage records', you can learn some detailed information on Bandwidth, Storage, Domains and many others.
+
|style="padding: 10px 0px 30px 15px;"|Addon is the main part of time tracking process. It is here where all the tasks and time entries are made.<br />
 +
Additionally, from here you can create tasks ordered by your clients, track time spent on them and bill your clients accordingly.
 
|}
 
|}
 +
===Support Clients===
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_15.png]]
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Support Clients' '' tab you are able to view the list of clients who bought prepaid hours of work or for whom accounts were created by your staff.<br />
 +
''Note: New accounts are automatically created for clients who bought Time Tracking Center For WHMCS provisioning product.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|In order to view the price for a specific element of the record, simply hover your mouse over it. <br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_14.png]]
The following screen shows the situation after running cron only 2 times. Note that the first record is always empty as its task is to initialize billing for the account.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_16.png]]
+
|style="padding: 0px 0px 20px 15px;"|Let's create an account for client Kate Cole, press '' 'Add Support Client' '' to proceed.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|In addition to the above information you can check when each cron was run.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_15.png]]
You can also order creation of invoice for product through pressing '' 'Bill On Demand' ''.<br />
+
''Note: Bill on demand feature is not available for credit billing.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_17.png]]
+
|style="padding: 0px 0px 15px 15px;"|Select a desired client from '' 'WHMCS Client' '' dropdown menu and fill in the name under which she will be visible in the addon.<br />
 +
Additionally, you can add a note to this client.<br />
 +
Press '' 'Add Support Client' '' to confirm and save this account.
 
|}
 
|}
===Awaiting Invoices===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Here you can check your awaiting invoices. Invoices can be generated automatically and manually.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_16.png]]
On the screen below you can see a previously generated invoice for our cPanel Extended account.<br />
+
To view detailed information about particular invoice press '' 'Show' '' button.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_20.png]]
+
|style="padding: 0px 0px 20px 15px;"|Using buttons marked on the following screen you can easily remove and edit support clients' accounts.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|This is the place where you can verify and modify awaiting invoices. It's advised to check whether invoices are correct to avoid any risk.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_17.png]]
You already know that you can set up automatic invoice generation in configuration section. Now let's generate an invoice for your customer manually.<br />
+
|}
For this purpose simply click on '' 'Generate Invoice' ''.
+
 
 +
===Tasks===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|All tasks for which your clients can be billed are stored in '' 'Tasks' '' tab.<br />
 +
Press '' 'Add New Task' '' to create a new task.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_18.png]]
 
|}
 
|}
 +
====New Task====
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|After changing product's package, invoice is automatically generated for an old package.
+
|style="padding: 10px 0px 15px 15px;"|Start by selecting one of the support clients and fill in task name.<br />
 +
Afterwards, define payment for each hour spent on this task by selecting from '' 'Charge From Prepaid Hours' '' or filling in price into '' 'Hourly Rate' ''.
 
|}
 
|}
===Settings===
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|Under '' 'Settings' '' tab you can find pages such as logs and integration code.
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_19.png]]
 
|}
 
|}
====Logs====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In '' 'Logs' '' you will find information about the module activity. You can view informative logs, error logs and critical logs.<br />
+
|style="padding: 0px 0px 15px 15px;"|You can also set up pricing for mileage.<br />
Choose .log file from a dropdown menu and press '' 'Show' '' as presented on the screen below.<br />
+
You can choose from three types of mileages:<br />
To remove a log simply press '' 'Delete' '' instead of '' 'Show' '' button.<br />
+
*Billable - client will have to pay for mileages<br />
New log files are created every day to help you find information you are looking for.
+
*Reference - client will be able to see only mileages done, no payment required<br />
 +
*Internal - only administrators will be able to see mileages reported by your staff
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_20.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|On the following screen you can see how '' 'infolog-YYYY-MM-DD.log' '' can look like.
+
|style="padding: 0px 0px 20px 15px;"|Now, choose the task's status, fill in description of the task and press '' 'Add Task' ''.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_19.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_21.png]]
 
|}
 
|}
  
====Integration Code====
+
===Work Sheet===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'' 'Integration Code' '' page contains codes required to integrate Advanced Billing For WHMCS with your client area.<br />
+
|style="padding: 10px 0px 20px 15px;"|In '' 'Work Sheet' '' your staff members are able to report hours spent on existing tasks or create a new task by choosing them from predefined tasks.
The first of them allows usage records and autoscaling related features to be displayed in the client area.<br />
+
It is required for '' 'Autoscale' '' and '' 'Client Area Usage Records' '' extensions.<br />
+
Placing the second one results in displaying prices on the order form.<br />
+
'''Important: Edition of clientareaproductdetails.tpl for classic and portal templates goes a bit differently than shown on the screen below.'''<br />
+
In this case place required code after this line:
+
<nowiki><div align="center">{$moduleclientarea}</div></nowiki>
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_23.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Usage records in the client area. Note that disabled usage records will not be displayed.<br />
+
|style="padding: 0px 0px 15px 15px;"|Let's create a new entry for the previously created task.<br />
''Note: To display usage records in the client area, you need to enable '' 'Usage Records' '' extension.''
+
Each time you enter '' 'Work Sheet' '' tab, a form to create the new entry will be already open.<br />
 +
Start by selecting a support client and a task. As soon as you choose the client, the tasks concerning them will be listed.<br />
 +
Afterwards, fill in amount of hours spent, mileages travelled and description.<br />
 +
Create entry through pressing '' 'Submit' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_24.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Pricing on the order form. Note that disabled usage records will not be displayed.
+
|style="padding: 0px 0px 15px 15px;"|Below you can find the list of tasks from current day.<br />
 +
In order to display tasks from other day, select it in the calendar as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_25.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|All time entries can be afterwards modified and removed through using buttons marked on the following screen.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_26.png]]
 
|}
 
|}
  
==Extensions==
+
===Billing===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In this section we will describe each extension step by step.<br />
+
|style="padding: 10px 0px 15px 15px;"|Finally, it is time to show you the place where you can generate invoices for time spent on your clients' tasks.<br />
'''Important:''' Only three of them are included in Advanced Billing For WHMCS product, the rest can be obtained separately.<br />
+
As you can see, here you can find billing per each time entry with detailed information about each of them.<br />
Default extensions included into Advanced Bulling For WHMCS are '' 'Recurring Billing' '', '' 'Usage Records' '' and '' 'Credit Billing' ''.<br />
+
You can find specific ones through using filters marked on the following screen.<br />
Each extension is configured per product, therefore you can use different sets of extensions according to your needs.<br />
+
Filters allow you to display time entries from specified time period as well as display only those assigned to selected support client.
To start using an extension, you need to activate it firstly, proceed to '' 'Settings' '' → '' 'Extensions' '' page.<br />
+
Afterwards, press '' 'Activate' '' next to the extension you wish to use, new options will appear in Advanced Billing For WHMCS.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_50.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_27.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|If you skip steps 3-4 of the installation instruction, you have to configure the license for each of the 3 base extensions.<br />
+
|style="padding: 0px 0px 15px 15px;"|Let's generate invoice for client Kate Cole from all time entries created this week.<br />
Note that each of them uses Advanced Billing license key.<br />
+
Start by filling in correct time period and choose Kate Cole from '' 'Support Client' '' dropdown menu.<br />
Press '' 'Configure' '', paste your license and confirm changes.
+
Now, press '' 'Refresh Filters' '' and choose '' '100' '' from '' 'Records per page' '' dropdown menu.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_50_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_28.png]]
 
|}
 
|}
===[http://www.modulesgarden.com/products/whmcs/autoscaling/features Autoscaling (Sold Separately)]===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|The main functionality of Autoscale For WHMCS extension is automatic upgrade/downgrade of a product according to its usage.<br />
+
|style="padding: 0px 0px 15px 15px;"|As you can see only desired time entries are displayed.<br />
For more information about Autoscale For WHMCS, visit its [http://www.docs.modulesgarden.com/Autoscaling_For_WHMCS Wiki].
+
Mark checkbox as shown on the following screen to mark them all at once.<br />
 +
Now, press '' 'Invoice Now' '' to generate invoice for selected time entries.<br />
 +
You can also press '' 'Add to Queue' '' which will add selected entries to cron queue.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_51.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_29.png]]
 
|}
 
|}
 
===Credit Billing===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'' 'Credit Billing' '' extension allows you to charge for a product from client credit balance.
+
|style="padding: 0px 0px 15px 15px;"|Generated invoice records contain information in format defined at the module configuration.<br />
*'''Enable Credit Billing''' - this option enables/disables credit billing for this module (if credit billing is enabled, standard billing will be turned off).<br />
+
''Note: Prices inside of the addon are displayed basing on default WHMCS currency.''<br />
*'''Create Invoices Each''' - this option defines how often invoice will be generated for this product (if nothing entered here, it will be 30 days).<br />
+
''Invoices are converted to currencies used by your clients basing on conversion rates defined in your WHMCS system.''
*'''Minimum Credit''' - minimum amount that will be charged from client account credit balance.<br />
+
*'''Low Credit Notify''' - if this value is higher than credits on client account, email to your client about low credit amount will be sent.<br />
+
*'''Email Interval''' - defines how often low credit notification email will be sent.<br />
+
*'''Autosuspend''' - when credit balance reaches 0, product ordered by client is automatically suspended and invoice with lacking amount is generated.<br />
+
*'''Due Date''' - the number of days that your customers will have, to pay the invoice.<br />
+
*'''Autorefill''' - if enabled, client's credit balance will be refilled from his credit card each time it became empty.<br />
+
*'''Gateway''' - gateway used to charge client's credit card.<br />
+
*'''Minimum Amount''' - minimum amount to charge from client's CC.<br />
+
*'''Maximum Amount''' - maximum amount to charge from client's CC.<br />
+
'''Note: Clients can define if they wish to use autorefill functionality as well as choose amount to refill in a single run.''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_52.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_30.png]]
 
|}
 
|}
 +
 +
===Report===
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|When '' 'Autosuspend' '' is marked and your client's credit balance reach 0, the client's product will be suspended. Additionally, invoice with lacking payment will be generated.<br />
+
|style="padding: 10px 0px 15px 15px;"|You can easily generate reports on work done for your clients.<br />
If it is unmarked and credit balance reaches 0, the client's product will not be suspended and invoice will be generated according to number of days set in '' 'Create Invoices Each' '' field.
+
Proceed to '' 'Report' '' tab to do so.<br />
 +
Now, fill in report name, date range and select a client for which you wish to generate the report.<br />
 +
Confirm through pressing '' 'Generate PDF Report' ''.
 
|}
 
|}
====User Credits====
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|All information related to credit payment for hosting can be found in '' 'User Credit' '' tab. As you can see, there are two columns with credits.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_31.png]]
The first one, '' 'Internal Credit' '' contains credits which were not used for payment, but are reserved for it. It was created to increase accuracy of credit billing.<br />
+
The second column, '' 'Already Paid For Hosting' '' contains summary credit payment for hosting.<br />
+
You can order refund of any hosting through pressing '' 'Refund' '' button next to it. Client will receive sum of '' 'Internal Credit' '' and '' 'Already Paid For Hosting' '' rounded down to 0.01.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_53.png]]
+
|style="padding: 0px 0px 20px 15px;"|On the following screen you can see the report for client Test Tester.
 
|}
 
|}
 
===Recurring Billing===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|This extension allows you to set up recurring billing for product.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_32.png]]
 +
|}
  
*'''Enable Recurring Billing''' - check to enable this billing type.<br />
+
===Cron===
*'''Bill on Terminate''' - when account connected with your module is terminated, invoice for account will be generated.<br />
+
{|
*'''Bill Type''' - enables you to choose how to bill your client.<br />
+
|style="padding: 10px 0px 15px 15px;"|In the cron tab you can define the behaviour of cron, find path to cron, view all queued entries and manually invoice them.<br />
**'''Bill on Invoice Generate''' - customer will receive an invoice at the same time as the invoice for their hosting account.<br />
+
To alter cron behaviour, choose desired option from '' 'Cron Billing Action' '' as shown on the following screen.<br />
**'''Bill On Specific Day''' - will generate invoices each month on the day specified in the '''Billing Type Value'''.<br />
+
''Note 1: If there are at least two time entries bounded to the same client, one summary invoice for that client will be created.''<br />
**'''Bill Each X Days''' - as its name suggests, it generates invoice each X days where X is a number specified in '''Billing Type Value''' field.<br />
+
''Note 2: In order to apply tax to such an invoice, mark '' 'Billable Items' '' at your tax rule.''
*'''Due Date''' - the number of days in which your customers will have to pay the invoice.<br />
+
*'''Autogenerate Invoice''' - an important feature which if enabled, automatically sends previously generated invoices directly to your customers.<br />
+
*'''Auto Apply Credits''' - automatically applies any available credits when invoice is created, works only if '' 'Autogenerate Invoice' '' is enabled.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_54.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_33.png]]
 
|}
 
|}
===Usage Records===
+
===Logs===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|This extension displays usage records and usage records history in the client area products page.<br />
+
|style="padding: 10px 0px 15px 15px;"|'' 'Logs' '' tab contains the logs of all actions made inside of Time Tracking Center For WHMCS.<br />
To use it, besides enabling in, you need to place an integration code.<br />
+
There are two columns similar to each other, '' 'Data' '' and '' 'Old Data' ''.<br />
This extension is configured per product, proceed to the product configuration in Advanced Billing.<br />
+
In '' 'Data' '' column you can find details, these are the data from the time after ordering logged action.<br />
As you can see, new tab is available here.
+
While '' 'Old Data' '' contains data from the time before ordering logged action.
*'''Enable''' - enables usage records being displayed for that product in the client area.
+
*'''Display Summary From''' - defines period from which usage records will be counted.
+
*'''Usage Records Precision''' - defines precision of usage records
+
*'''Show Usage Records''' - displays history of usage records.
+
*'''Usage Records Per Page''' - defines how many usage records should be displayed per page.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_55.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_34.png]]
 
|}
 
|}
 +
===Integration Code===
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|On the following screen you can see a sample of usage records and usage records history in the client area.
+
|style="padding: 10px 0px 20px 15px;"|Follow integration code, shown on the following screen, to display tasks and prepaid hours in your client area.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_56.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_34_1.png]]
 
|}
 
|}
 
+
===Predefined Tasks===
==Hourly Billing==
+
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Hourly billing allows you to charge your customers for each hour of use of the product (hourly billing calculations are basing on product '' 'Registration Date' '').<br />
+
|style="padding: 10px 0px 15px 15px;"|On '' 'Predefined Tasks' '' page you are able to set up predefined tasks.<br />
You can enable hourly billing for any product type.<br />
+
Those tasks can be used to instantly create new tasks during creation of work sheet entry.<br />
Regardless of whether it is a server, web hosting account or other, customer will be billed for each hour of using the product.
+
Press '' 'Add New Predefined Task' '' to proceed.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_29.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_34_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now, fill in predefined task name, price per hour, price per mileage and description.<br />
 +
Additionally, choose prepaid hours (optional), mileage type and initial status of the task.<br />
 +
Press '' 'Add Predefined Task' '' to save it.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_34_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You can manage the predefined tasks the same way you manage regular tasks.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_34_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|On the following screen you can see how the predefined tasks look in the new work entry form.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_34_5.png]]
 +
|}
 +
==Support Integration==
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Owing to integration with support department, your staff members can easily make a task assigned to the ticket.
 
|}
 
|}
 
==Ticket Billing==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Ticket billing works exactly as it sounds. When enabled, it bills your customers for each opened ticket.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_34_6.png]]
As in the case of hourly billing, you can enable ticket billing for any product type.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_30.png]]
+
|style="padding: 0px 0px 15px 15px;"|Ticket tasks are created in the same manner as the regular tasks.<br />
 +
As you can see on the screen below the only difference is a direct link to the ticket.
 
|}
 
|}
==Sample Configuration==
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|In this section we will show you two samples of configuration of Advanced Billing.
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_34_7.png]]
 
|}
 
|}
===Two Weeks Billing===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In order to set up generating invoice for resource usage each 2 weeks, follow this steps:<br />
+
|style="padding: 0px 0px 15px 15px;"|As soon as you get back to the ticket, you will notice that '' 'Create Task' '' button changed into '' 'Edit Task' ''.<br />
1. Go to '' 'Addons' '' '' 'Advanced Billing' '' and select your product from '' 'Enable Advanced Billing for:' ''.
+
This means that a previously created task is assigned to the ticket.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_31.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_34_8.png]]
 
|}
 
|}
 +
==Client Area==
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|2. Go to '' 'Recurring Billing' '', mark '' 'Enable' '' and '' 'Bill on Terminate' '' checkboxes.<br />
+
|style="padding: 10px 0px 20px 15px;"|In the client area your clients can view all unused prepaid hours and incidents.
Additionally, choose '' 'Bill Every X Days' '' from '' 'Billing Type' '' dropdown menu and enter '' '14' '' into the '' 'Billing Type Value' '' textbox.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_32.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_35.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|3. Scroll down and enter your pricing settings.<br />
+
|style="padding: 0px 0px 20px 15px;"|Additionally, they can see all tasks concerning them with basic information like current status, hours spent on it and hourly billing rate.
Afterwards, press '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_33.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:TTC_36.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|You have just successfully configured billing!<br />
+
|style="padding: 0px 0px 15px 15px;"|As you can see, your client can order provisioning module with additional hours by pressing '' 'Buy Additional Hours' ''.<br />
You should see something like on screen below in your Advanced Billing main page.
+
By default, it will move your clients to the order form of the first provisioning module using Time Tracking Center For WHMCS.<br />
 +
To change it, edit the file located in '' 'your_whmcs/templates/default/ttc_homepage.tpl' '' and replace '' '{$ttc.prepaidproductid}' '' with a desired product ID.<br />
 +
''Note: If you are not using a default template, copy '' 'ttc_homepage.tpl' '' from '' 'your_whmcs/templates/default/' '' to your template folder.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_34.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:TTC_37.png]]
 
|}
 
|}
  
===20$ Billing===
+
==Sample Workflow==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|To bill your client as often as possible follow these steps:<br />
+
|style="padding: 10px 0px 15px 15px;"|Let's  take a look at a sample workflow, starting from setting up prepaid hours through ordering a task to invoice generation.<br />
1.Go to '' 'Addons' '' → '' 'Advanced Billing' '' and select your product from '' 'Enable Advanced Billing for:' ''.
+
If any part of this workflow seems unclear to you, please make sure you have read carefully the rest of this documentation firstly.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_35.png]]
+
|style="padding: 0px 0px 20px 15px;"|1. Configure client custom field '' 'Development Hours' '' with '' 'Admin Only' '' checkbox marked.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|2. Go to '' 'Credit Billing' '' and mark '' 'Enable' '' and '' 'Enable Credit Pay' '' checkboxes.<br />
+
|style="padding: 0px 0px 20px 15px;"|2. Proceed to the Time Tracking Center  For WHMCS addon configuration and set up 40 USD/h for '' 'Development Hours' ''.
Afterwards, enter '' '1' '' into '' 'Create Invoices Each'' ', ' ''20' '' into '' 'Minimum Credit' '' and '' '50' '' into '' 'Low Credit Notify' ''.<br />
+
With these settings your client will be billed from credit balance as soon as the payment for resource usage reach 20$.<br />
+
They will also receive an email if their credit balance falls below 50$.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_36.png]]
+
|style="padding: 0px 0px 15px 15px;"|3. Prepare Time Tracking Center For WHMCS provisioning product set up with recurring payment type and name it '' '10 Development Hours' ''.<br />
 +
Fill in 10 into '' 'Development Hours' '' field at '' 'Module Settings' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|3. Scroll down and enter your pricing settings, afterwards, press '' 'Save Changes' ''.
+
|style="padding: 0px 0px 15px 15px;"|4. Your client Tim Black ordered '' '10 Development Hours' '' product from your client area. <br />
 +
As soon as the product was activated, he received 10 prepaid development hours.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:AB2_37.png]]
+
|style="padding: 0px 0px 15px 15px;"|5. Afterwards, he requested development work inside of his website.<br />
 +
You went to '' 'Addons' '' → '' 'Time Tracking Center' '' → '' 'Tasks' '' and created a new task for this client concerning his request.<br />
 +
The task was named '' 'Development Work' ''.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|You have just successfully configured billing!<br />
+
|style="padding: 0px 0px 15px 15px;"|6. You have spent on this task 2 hours on the 16th, July and instructed your staff member John Smith to take it over.<br />
In your Advanced Billing '' 'Configuration' '' tab you should see something similar to the following screen.
+
Of course you have added time entry at the '' 'Work Sheet' '' tab reporting to your client that you have spent 2 hours on the 16th, July.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:AB2_38.png]]
+
|style="padding: 0px 0px 15px 15px;"|7. In next days John Smith reported three time entries:<br />
 +
*6 hours spent on 17th, July<br />
 +
*8 hours spent on 18th, July<br />
 +
*2 hours and 30 minutes spent on 21st, July<br />
 +
'' 'Note: In order to report for example 2 hours and 30 minutes fill in 2.50 into '' 'Hours' '' field at the time entry.''
 
|}
 
|}
 
==How To Update==
 
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|In order to upgrade, simply copy the files, any additional operation will be made automatically.
+
|style="padding: 0px 0px 15px 15px;"|8. John finished '' 'Development Work' '' task on 21th, July.<br />
 +
You had set up '' 'Operator Privileges' '' for John Smith, therefore he could not close the task by himself.<br />
 +
He told you that task was closed, therefore you edited the task and changed its status to '' 'Closed' ''.
 
|}
 
|}
 
=Tips=
 
 
{|
 
{|
|style="padding: 10px 0px 5px 15px;"|'''1. Deactivation of the module removes products' configuration, usage records and awaiting invoices.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|9. Now, you have decided to bill your client for the task. <br />
In order to update the module, simply follow instruction in '' 'How To Update' '' .
+
To do so, you have gone to '' 'Billing' '' tab and chosen '' 'Tim Black' '' from support client filter.<br />
 +
Additionally, you set up time period filter to be wider than 16th - 21st, July. <br />
 +
4 time entries were shown, so you have marked them all and pressed '' 'Invoice Now' '' at the bottom of the page.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 15px;"|2. '' 'Installed Applications' '' usage record supports both Softaculous and Installatron.
+
|style="padding: 0px 0px 15px 15px;"|10. Marked time entries were summarized, 18 and an half were spent on the Tim Black's task.<br />
 +
The task is using '' 'Development Hours' '' prepaid hours and Tim has 10 prepaid hours of this type.<br />
 +
Therefore, he still has to pay for 8 and a half an hour of development work.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 15px;"|3. You can set up as many products as you want.
+
|style="padding: 0px 0px 15px 15px;"|11. Invoice is generated with 4 items, one per each time entry.<br />
 +
*2 hours on 16.07 - no payment required (8 prepaid hours left)
 +
*6 hours on 17.07 - no payment required (2 prepaid hours left)
 +
*8 hours on 18.07 - payment for 6 hours required (0 prepaid hours left)
 +
*2 hours 30 minutes spent on 21.07 - full payment required
 +
Invoice on 340$ will be generated for Tim Black.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|4. If your client uses currency that is not WHMCS base currency (for example, WHMCS base currency is €, while client uses $):
+
|style="padding: 0px 0px 30px 15px;"|This is only sample and simple workflow of our module.<br />
An invoice for such client will be generated in the chosen currency, while usage record and calculation in Advanced Billing will use base currency.
+
Therefore it shows only a little part of Time Tracking Center For WHMCS possibilities.
 
|}
 
|}
  
=Common Problems=
+
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 5px 15px;"|1. When you see an error message as shown on the screen below, that means your '' 'cron' '' directory privileges are insufficient.<br />
+
|style="padding: 10px 0px 10px 15px;"|1. Prepaid hours can be afterwards used to pay for task using the same prepaid hour type.
To fix this, allow <strong>Read</strong> permissions to directory. In most cases chmod 755 solves the problem.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 25px;"|[[File:AB2_39.png]]
+
|style="padding: 0px 0px 10px 15px;"|2. If you are manually generating invoice from at least two time entries bounded to the same client, one summary invoice for that client will be created.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 15px;"|2. When you have problems with connection, check whether your SELinux or firewall does not block ports.
+
|style="padding: 0px 0px 10px 15px;"|3. Cron generates one invoice per support client. Of course invoice will not be generated if no time entries exist for invoiced client.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 15px;"|3. You are unable to find specified line in clientareaproductdetails.tpl.<br />
+
|style="padding: 0px 0px 30px 15px;"|4. In order to apply tax to such invoice, make sure you marked '' 'Billable Items' '' at your tax rule.
''Cause 1:'' You are using Classic or Portal template.<br />
+
|}
''Solution 1:'' In this case place required code after this line:
+
 
<nowiki><div align="center">{$moduleclientarea}</div></nowiki><br />
+
=Common Problems=
''Cause 2:'' You are using heavily customized template.<br />
+
{|
''Solution 2:''  Create a ticket and one of our specialists will help you set up the module.
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Revision as of 12:04, 27 January 2016

Contents

About Time Tracking Center For WHMCS

Time Tracking Center For WHMCS will let you add various tasks, track their development basing on the time spent on their execution and charge your customers accordingly.

The module enables your clients to order and monitor products with a chosen amount of hours that can be spent on performance of your services.
Additionally, you can offer your customers prepaid hours and incidents as well as manage tasks connected to specific support tickets.

  • Addon Module Features:
✔ Add/Edit/Remove Support Clients
✔ Add/Edit/Remove Tasks
✔ Add/Edit/Remove Predefined Tasks
✔ Add/Edit/Remove Time Entries - Time Spent On Task
✔ Create/Edit Tasks Connected To Specific Tickets
✔ View List Of Billable Time Entries
✔ Generate Invoices Automatically Or Manually
✔ Add Invoices Creation To Cron Queue
✔ Define And Bill For Mileages Travelled
✔ Set Predefined Prices
✔ Send Email Notifications - New Task/New Time Entry
✔ Generate And View Fully Configurable Reports About Your Clients And Admins
✔ Choose From Two Types Of Configurable Permissions - Full Privileges And Operator Privileges
✔ View Logs
  • Provisioning Module Features:
✔ Create Support Client Accounts Upon Module Activation
✔ Add Defined Number Of Prepaid Hours To Your Clients Automatically
✔ Supports One Time & Recurring Payment Types
  • Task Configuration:
✔ Support Client
✔ Task Name
✔ Predefined Incidents
✔ Predefined/Custom Charge Per Hour
✔ Charge Per Mileage
✔ Mileage Type - Billable / Visible For Client And Administrators / Visible For Administrators Only
✔ Task Status
✔ Description
  • Available Cron Job Behavior Settings:
✔ Generate Invoices For Queued Time Entries Only
✔ Generate Invoices For All Time Entries From Previous Week
✔ Generate Invoices For All Time Entries From Previous Month
  • General Info:
✔ Multi-Currencies Support
✔ Multi-Language Support
✔ Supports WHMCS V5 Up To V5.3.14

Installation and Configuration

This tutorial will show you how to successfully install and configure Time Tracking Center For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to your client area and download Time Tracking Center For WHMCS.
TTC 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

TTC 2.png
3. When you install Time Tracking Center for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/TimeTrackingCenter/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

TTC 3.png
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products' .

TTC 4.png

Configuration Of Addon

5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' 'Addon Modules' . Afterwards, find 'Time Tracking Center' and press 'Activate' button.

File:TTC 5.png
6. In the next step you need to permit access to this module and set up basic configuration.

To do so, click on 'Configure' button.
Afterwards, define whether to allow billing for mileage and define to whom emails should be sent by defining their type (System/Account/Support).
Assign permissions to admin roles in your system, you can grant 'Full Privileges' and 'Operator Privileges' .
'Full Privileges' (1) grants access to all tabs of Time Tracking Center addon.
'Operator Privileges' (1) grants access for the admin roles to tabs chosen in the 'Operator Access Control' .
'Operator Access Control' (2) defines tabs to which operator should have access to.
Afterwards, tick 'Access Control' (3) near required admin role groups and press 'Save Changes' .

File:TTC 6.png
7. Additionally, here you can set up invoice description format and predefined price per hour.

You can use variables listed under a help sign to define invoice description, each invoice description allows different set of variables.
More about setting up predefined price per hour in Predefined Price And Prepaid Hours section.

File:TTC 6 1.png
8. You have just successfully installed Time Tracking Center For WHMCS!

You can access your module in 'Addons' 'Time Tracking Center' .

File:TTC 7.png

Management

In this section we will show you how to properly set up and use Time Tracking Center For WHMCS.

Our module allows you to easily add and track progress of tasks ordered by your clients while your staff are able to easily report time spent on each of them.
Additionally, you can manually bill your clients for time already spent on their tasks or use cron job to do it automatically.
Owing to integration code, you can even display current status of tasks assigned to clients at their client area, as well as show them the amount of prepaid hours & incidents they own.

Predefined Price And Prepaid Hours

You can easily set up predefined price per hour using client custom fields.

Afterwards, you can sell those hours to your clients using provisioning module.

Setting Up Custom Field

First of all, set up client custom field visible only from the admin area.

To do so, proceed to 'Setup' 'Custom Client Fields' . Fill in its name, choose 'Text Box' field type.
Additionally, you can ensure that only numerical values will be placed there.
Copy regular expression shown below into validation field as presented on the following screen.

^[0-9]*$

Now, mark 'Admin Only' checkbox and press 'Save Changes' .

File:TTC 8.png
You can set up prepaid incidents the same way.

The only difference is placing 'incident' into 'Select Options' field.

File:TTC 9.png

Predefined Price

As soon as you create a custom client field, proceed to 'Setup' 'Addon Modules' and press 'Configure' next to 'Time Tracking Center' .

Afterwards, fill in predefined price per hour for previously created custom field and press 'Save Changes' .

File:TTC 10.png

Prepaid Hours & Incidents

Owing to our module, you can even offer prepaid hours and incidents to your clients as a product in your system.

To set up the first product, proceed to 'Setup' 'Products/Services' 'Products/Services' .
Press 'Create a New Group' to create a new product group or use existing one instead.

File:TTC 10 1.png
Fill in product group name and press 'Save Changes'.
File:TTC 10 2.png
Now, create a new product, press 'Create a New Product' to proceed.
File:TTC 11.png
Fill in product name, choose previously created group and press 'Continue' .
File:TTC 12.png
Uncheck 'Require Domain' checkbox and proceed to 'Pricing' tab.
File:TTC 12 1.png
Choose payment type, enable wanted billing cycles and fill in price for each of them.

Now, go to 'Module Settings' tab.

File:TTC 12 2.png
Choose a 'TimeTrackingPrepaid' module from 'Module Name' dropdown menu.

Afterwards, fill in the amount of prepaid hours and incidents this product will grant to clients and press 'Save Changes' .
Note 1: Afterwards, prepaid hours can be used to pay for tasks, using the same prepaid hour type.
Note 2: Prepaid incidents can be used to offer one time support services.
Incidents are removed from the client account during the creation of a task using those incident.

File:TTC 13.png

Addon

Addon is the main part of time tracking process. It is here where all the tasks and time entries are made.

Additionally, from here you can create tasks ordered by your clients, track time spent on them and bill your clients accordingly.

Support Clients

In 'Support Clients' tab you are able to view the list of clients who bought prepaid hours of work or for whom accounts were created by your staff.

Note: New accounts are automatically created for clients who bought Time Tracking Center For WHMCS provisioning product.

File:TTC 14.png
Let's create an account for client Kate Cole, press 'Add Support Client' to proceed.
File:TTC 15.png
Select a desired client from 'WHMCS Client' dropdown menu and fill in the name under which she will be visible in the addon.

Additionally, you can add a note to this client.
Press 'Add Support Client' to confirm and save this account.

File:TTC 16.png
Using buttons marked on the following screen you can easily remove and edit support clients' accounts.
File:TTC 17.png

Tasks

All tasks for which your clients can be billed are stored in 'Tasks' tab.

Press 'Add New Task' to create a new task.

File:TTC 18.png

New Task

Start by selecting one of the support clients and fill in task name.

Afterwards, define payment for each hour spent on this task by selecting from 'Charge From Prepaid Hours' or filling in price into 'Hourly Rate' .

File:TTC 19.png
You can also set up pricing for mileage.

You can choose from three types of mileages:

  • Billable - client will have to pay for mileages
  • Reference - client will be able to see only mileages done, no payment required
  • Internal - only administrators will be able to see mileages reported by your staff
File:TTC 20.png
Now, choose the task's status, fill in description of the task and press 'Add Task' .
File:TTC 21.png

Work Sheet

In 'Work Sheet' your staff members are able to report hours spent on existing tasks or create a new task by choosing them from predefined tasks.
File:TTC 23.png
Let's create a new entry for the previously created task.

Each time you enter 'Work Sheet' tab, a form to create the new entry will be already open.
Start by selecting a support client and a task. As soon as you choose the client, the tasks concerning them will be listed.
Afterwards, fill in amount of hours spent, mileages travelled and description.
Create entry through pressing 'Submit' .

File:TTC 24.png
Below you can find the list of tasks from current day.

In order to display tasks from other day, select it in the calendar as shown on the following screen.

File:TTC 25.png
All time entries can be afterwards modified and removed through using buttons marked on the following screen.
File:TTC 26.png

Billing

Finally, it is time to show you the place where you can generate invoices for time spent on your clients' tasks.

As you can see, here you can find billing per each time entry with detailed information about each of them.
You can find specific ones through using filters marked on the following screen.
Filters allow you to display time entries from specified time period as well as display only those assigned to selected support client.

File:TTC 27.png
Let's generate invoice for client Kate Cole from all time entries created this week.

Start by filling in correct time period and choose Kate Cole from 'Support Client' dropdown menu.
Now, press 'Refresh Filters' and choose '100' from 'Records per page' dropdown menu.

File:TTC 28.png
As you can see only desired time entries are displayed.

Mark checkbox as shown on the following screen to mark them all at once.
Now, press 'Invoice Now' to generate invoice for selected time entries.
You can also press 'Add to Queue' which will add selected entries to cron queue.

File:TTC 29.png
Generated invoice records contain information in format defined at the module configuration.

Note: Prices inside of the addon are displayed basing on default WHMCS currency.
Invoices are converted to currencies used by your clients basing on conversion rates defined in your WHMCS system.

File:TTC 30.png

Report

You can easily generate reports on work done for your clients.

Proceed to 'Report' tab to do so.
Now, fill in report name, date range and select a client for which you wish to generate the report.
Confirm through pressing 'Generate PDF Report' .

File:TTC 31.png
On the following screen you can see the report for client Test Tester.
File:TTC 32.png

Cron

In the cron tab you can define the behaviour of cron, find path to cron, view all queued entries and manually invoice them.

To alter cron behaviour, choose desired option from 'Cron Billing Action' as shown on the following screen.
Note 1: If there are at least two time entries bounded to the same client, one summary invoice for that client will be created.
Note 2: In order to apply tax to such an invoice, mark 'Billable Items' at your tax rule.

File:TTC 33.png

Logs

'Logs' tab contains the logs of all actions made inside of Time Tracking Center For WHMCS.

There are two columns similar to each other, 'Data' and 'Old Data' .
In 'Data' column you can find details, these are the data from the time after ordering logged action.
While 'Old Data' contains data from the time before ordering logged action.

File:TTC 34.png

Integration Code

Follow integration code, shown on the following screen, to display tasks and prepaid hours in your client area.
File:TTC 34 1.png

Predefined Tasks

On 'Predefined Tasks' page you are able to set up predefined tasks.

Those tasks can be used to instantly create new tasks during creation of work sheet entry.
Press 'Add New Predefined Task' to proceed.

File:TTC 34 2.png
Now, fill in predefined task name, price per hour, price per mileage and description.

Additionally, choose prepaid hours (optional), mileage type and initial status of the task.
Press 'Add Predefined Task' to save it.

File:TTC 34 3.png
You can manage the predefined tasks the same way you manage regular tasks.
File:TTC 34 4.png
On the following screen you can see how the predefined tasks look in the new work entry form.
File:TTC 34 5.png

Support Integration

Owing to integration with support department, your staff members can easily make a task assigned to the ticket.
File:TTC 34 6.png
Ticket tasks are created in the same manner as the regular tasks.

As you can see on the screen below the only difference is a direct link to the ticket.

File:TTC 34 7.png
As soon as you get back to the ticket, you will notice that 'Create Task' button changed into 'Edit Task' .

This means that a previously created task is assigned to the ticket.

File:TTC 34 8.png

Client Area

In the client area your clients can view all unused prepaid hours and incidents.
File:TTC 35.png
Additionally, they can see all tasks concerning them with basic information like current status, hours spent on it and hourly billing rate.
File:TTC 36.png
As you can see, your client can order provisioning module with additional hours by pressing 'Buy Additional Hours' .

By default, it will move your clients to the order form of the first provisioning module using Time Tracking Center For WHMCS.
To change it, edit the file located in 'your_whmcs/templates/default/ttc_homepage.tpl' and replace '{$ttc.prepaidproductid}' with a desired product ID.
Note: If you are not using a default template, copy 'ttc_homepage.tpl' from 'your_whmcs/templates/default/' to your template folder.

File:TTC 37.png

Sample Workflow

Let's take a look at a sample workflow, starting from setting up prepaid hours through ordering a task to invoice generation.

If any part of this workflow seems unclear to you, please make sure you have read carefully the rest of this documentation firstly.

1. Configure client custom field 'Development Hours' with 'Admin Only' checkbox marked.
2. Proceed to the Time Tracking Center For WHMCS addon configuration and set up 40 USD/h for 'Development Hours' .
3. Prepare Time Tracking Center For WHMCS provisioning product set up with recurring payment type and name it '10 Development Hours' .

Fill in 10 into 'Development Hours' field at 'Module Settings' .

4. Your client Tim Black ordered '10 Development Hours' product from your client area.

As soon as the product was activated, he received 10 prepaid development hours.

5. Afterwards, he requested development work inside of his website.

You went to 'Addons' 'Time Tracking Center' 'Tasks' and created a new task for this client concerning his request.
The task was named 'Development Work' .

6. You have spent on this task 2 hours on the 16th, July and instructed your staff member John Smith to take it over.

Of course you have added time entry at the 'Work Sheet' tab reporting to your client that you have spent 2 hours on the 16th, July.

7. In next days John Smith reported three time entries:
  • 6 hours spent on 17th, July
  • 8 hours spent on 18th, July
  • 2 hours and 30 minutes spent on 21st, July

'Note: In order to report for example 2 hours and 30 minutes fill in 2.50 into 'Hours' field at the time entry.

8. John finished 'Development Work' task on 21th, July.

You had set up 'Operator Privileges' for John Smith, therefore he could not close the task by himself.
He told you that task was closed, therefore you edited the task and changed its status to 'Closed' .

9. Now, you have decided to bill your client for the task.

To do so, you have gone to 'Billing' tab and chosen 'Tim Black' from support client filter.
Additionally, you set up time period filter to be wider than 16th - 21st, July.
4 time entries were shown, so you have marked them all and pressed 'Invoice Now' at the bottom of the page.

10. Marked time entries were summarized, 18 and an half were spent on the Tim Black's task.

The task is using 'Development Hours' prepaid hours and Tim has 10 prepaid hours of this type.
Therefore, he still has to pay for 8 and a half an hour of development work.

11. Invoice is generated with 4 items, one per each time entry.
  • 2 hours on 16.07 - no payment required (8 prepaid hours left)
  • 6 hours on 17.07 - no payment required (2 prepaid hours left)
  • 8 hours on 18.07 - payment for 6 hours required (0 prepaid hours left)
  • 2 hours 30 minutes spent on 21.07 - full payment required

Invoice on 340$ will be generated for Tim Black.

This is only sample and simple workflow of our module.

Therefore it shows only a little part of Time Tracking Center For WHMCS possibilities.

Tips

1. Prepaid hours can be afterwards used to pay for task using the same prepaid hour type.
2. If you are manually generating invoice from at least two time entries bounded to the same client, one summary invoice for that client will be created.
3. Cron generates one invoice per support client. Of course invoice will not be generated if no time entries exist for invoiced client.
4. In order to apply tax to such invoice, make sure you marked 'Billable Items' at your tax rule.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community