Time And Task Manager For WHMCS
Line 1: | Line 1: | ||
− | |||
− | |||
{{DISPLAYTITLE:Time & Task Manager For WHMCS}} | {{DISPLAYTITLE:Time & Task Manager For WHMCS}} | ||
<meta name="keywords" content="time and task manager for whmcs, time and task manager configuration, whmcs time and task manager management, whmcs time and task manager installation, whmcs time and task manager common problems, about whmcs time and task manager, whmcs time and task manager documentation, whmcs time and task manager faq, whmcs time and task manager help, whmcs time and task manager guide, whmcs time and task manager wiki, whmcs time and task manager tutorial, whmcs time and task manager tips, whmcs time and task manager wiki"></meta> | <meta name="keywords" content="time and task manager for whmcs, time and task manager configuration, whmcs time and task manager management, whmcs time and task manager installation, whmcs time and task manager common problems, about whmcs time and task manager, whmcs time and task manager documentation, whmcs time and task manager faq, whmcs time and task manager help, whmcs time and task manager guide, whmcs time and task manager wiki, whmcs time and task manager tutorial, whmcs time and task manager tips, whmcs time and task manager wiki"></meta> | ||
Line 8: | Line 6: | ||
{| | {| | ||
|style="padding: 10px 0px 10px 0px;"|'''Time & Task Manager 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/> | |style="padding: 10px 0px 10px 0px;"|'''Time & Task Manager 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/> | ||
− | The module enables your clients to order and monitor products with a chosen | + | The module enables your clients to order and monitor products with a chosen number of hours that can be spent on performance of your services.<br/> |
Additionally, you can offer your customers prepaid hours and incidents as well as manage tasks connected to specific support tickets. | Additionally, you can offer your customers prepaid hours and incidents as well as manage tasks connected to specific support tickets. | ||
|} | |} | ||
Line 26: | Line 24: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Create/Edit Tasks Connected To Specific Tickets | + | |style="padding: 0px 0px 0px 30px;"|✔ Create/Edit Custom Tasks Connected To Specific Tickets |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Create/Edit Tasks With Default Rates, Status And Urgency From Tickets | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Define Billable Time Entries | ||
|} | |} | ||
{| | {| | ||
Line 35: | Line 39: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Add | + | |style="padding: 0px 0px 0px 30px;"|✔ Add Invoice Creation To Cron Queue |
|} | |} | ||
{| | {| | ||
Line 50: | Line 54: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Generate And View Fully Configurable Reports | + | |style="padding: 0px 0px 0px 30px;"|✔ Generate And View Fully Configurable Reports On Your Clients And Administrators |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Choose | + | |style="padding: 0px 0px 0px 30px;"|✔ Choose The Type Of Configurable Permissions - Full Privileges And Operator Privileges |
|} | |} | ||
{| | {| | ||
Line 67: | Line 71: | ||
{| | {| | ||
|style="padding: 0px 0px 10px 30px;"|✔ Supports One Time & Recurring Payment Types | |style="padding: 0px 0px 10px 30px;"|✔ Supports One Time & Recurring Payment Types | ||
+ | |} | ||
+ | *'''Client Area Features:''' | ||
+ | {| | ||
+ | |style="padding: 10px 0px 0px 30px;"|✔ View Lists Of Opened And Closed Tasks | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ View Current Task Status, Worked Hours And Hourly Rate | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ View Purchased Prepaid Hours | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ View Balance Of Available Or Exceeded Hours | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Buy Additional Hours | ||
|} | |} | ||
*'''Task Configuration:''' | *'''Task Configuration:''' | ||
Line 97: | Line 117: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Description |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Time Entries | ||
|} | |} | ||
*'''Available Cron Job Behavior Settings:''' | *'''Available Cron Job Behavior Settings:''' | ||
Line 107: | Line 130: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Generate Invoices For All Time Entries From Previous Month |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Generate Zero Invoices For Prepaid Entrie | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Enable Auto Credit Application On Invoice Generation | ||
|} | |} | ||
*'''General Info:''' | *'''General Info:''' | ||
Line 170: | Line 199: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br /> | |style="padding: 10px 0px 15px 15px;"|'''6. 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 & Task Manager' '' and press '' 'Activate' '' button. | + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Time & Task Manager' '' and press the '' 'Activate' '' button. |
|} | |} | ||
{| | {| | ||
Line 177: | Line 206: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module and set up basic configuration.'''<br/> | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module and set up basic configuration.'''<br/> | ||
− | To do so, click on '' 'Configure' '' | + | To do so, click on '' 'Configure' ''.<br/> |
− | Afterwards, | + | Afterwards, choose whether to allow billing for mileage and decide to whom emails should be sent by defining their type ''(System/Account/Support/None).''<br/><br/> |
− | + | You can also set default settings for a task time entry created [https://www.docs.modulesgarden.com/Time_And_Task_Manager_For_WHMCS#Support_Integration directly from ticket] - these are ''the hourly rate, mileage rate, status, urgency, and the extra hourly rate''.<br/> | |
+ | This way your support operator will need neither to have access to the module nor to create a task with custom settings and rates. | ||
+ | <br/><br/> | ||
+ | Next, assign permissions to admin roles in your system, you can grant '' 'Full Privileges' '' and '' 'Operator Privileges'. ''<br/> | ||
'' 'Full Privileges' ''(1) grant access to all tabs of Time & Task Manager addon.<br/> | '' 'Full Privileges' ''(1) grant access to all tabs of Time & Task Manager addon.<br/> | ||
− | '' 'Operator Privileges' ''(1) grant access for the admin roles to tabs chosen in the '' 'Operator Access Control'. ''<br/> | + | '' 'Operator Privileges' ''(1) grant access for the admin roles to the tabs chosen in the '' 'Operator Access Control'. ''<br/> |
'' 'Operator Access Control' ''(2) defines tabs to which operator should have access to.<br/> | '' 'Operator Access Control' ''(2) defines tabs to which operator should have access to.<br/> | ||
Afterwards, give '' 'Access Control' ''(3) to required admin role groups and press '' 'Save Changes'. '' | Afterwards, give '' 'Access Control' ''(3) to required admin role groups and press '' 'Save Changes'. '' | ||
Line 190: | Line 222: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''8. Additionally, here you can set up invoice description format and predefined price per hour.<br /> | |style="padding: 0px 0px 15px 15px;"|'''8. Additionally, here you can set up invoice description format and predefined price per hour.<br /> | ||
− | You can use variables listed under | + | You can use variables listed under the help sign to define invoice description, each invoice description allows different set of variables. |
|} | |} | ||
{| | {| | ||
Line 211: | Line 243: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|More about setting up predefined price per hour in [[Time_And_Task_Manager_For_WHMCS#Predefined_Price_And_Prepaid_Hours|Predefined Price And Prepaid Hours]] section. | + | |style="padding: 0px 0px 20px 15px;"|More about setting up predefined price per hour can be found in the [[Time_And_Task_Manager_For_WHMCS#Predefined_Price_And_Prepaid_Hours|Predefined Price And Prepaid Hours]] section. |
|} | |} | ||
{| | {| | ||
Line 224: | Line 256: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px;"|'''Remember to clear ''templates_c'' folder when migrating to Time & Task Manager 1.3.0 version!''' | + | |style="padding: 0px 0px 30px 15px;"|'''Remember to clear ''templates_c'' folder when migrating to Time & Task Manager 1.3.0 version or a newer one!''' |
|} | |} | ||
Line 230: | Line 262: | ||
{| | {| | ||
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Time & Task Manager For WHMCS.'''<br/> | |style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Time & Task Manager For WHMCS.'''<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/> | + | Our module allows you to easily add and track progress of the tasks ordered by your clients while your staff members are able to easily report time spent on each of them.<br/> |
− | Additionally, you can manually bill your clients for time already spent on their tasks or use cron job to do it automatically.<br/> | + | Additionally, you can manually bill your clients for the 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 in their client area, as well as show them the amount of prepaid hours & incidents they own. | Owing to integration code, you can even display current status of tasks assigned to clients in their client area, as well as show them the amount of prepaid hours & incidents they own. | ||
|} | |} | ||
==Predefined Price And Prepaid Hours== | ==Predefined Price And Prepaid Hours== | ||
{| | {| | ||
− | |style="padding: 10px 0px 30px 15px;"|You can easily set up predefined price per hour using | + | |style="padding: 10px 0px 30px 15px;"|You can easily set up predefined price per hour using Custom Client Fields.<br/> |
Afterwards, you can sell those hours to your clients using provisioning module. | Afterwards, you can sell those hours to your clients using provisioning module. | ||
|} | |} | ||
===Setting Up Custom Field=== | ===Setting Up Custom Field=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|First of all, set up | + | |style="padding: 10px 0px 15px 15px;"|First of all, set up Custom Client Fields visible only from the admin area.<br/> |
− | To do so, proceed to '' 'Setup' → 'Custom Client Fields'. '' Fill in its name, choose '' 'Text Box' '' | + | To do so, proceed to '' 'Setup' → 'Custom Client Fields'. '' Fill in its name, choose '' 'Text Box' ''as your '' 'Field Type' ''.<br/> |
Additionally, you can ensure that only numerical values will be placed there.<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. | + | Copy the regular expression shown below into the validation field as presented on the following screen. |
^[0-9]*$ | ^[0-9]*$ | ||
− | Now, mark '' 'Admin Only' '' checkbox and press '' 'Save Changes'. '' | + | Now, mark the '' 'Admin Only' '' checkbox and press '' 'Save Changes'. '' |
|} | |} | ||
{| | {| | ||
Line 253: | Line 285: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|You can set up prepaid incidents the same way.<br/> | |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. | + | The only difference is placing '' 'incident' '' into the '' 'Select Options' '' field. |
|} | |} | ||
{| | {| | ||
Line 261: | Line 293: | ||
===Predefined Price=== | ===Predefined Price=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"| | + | |style="padding: 10px 0px 15px 15px;"|Once you have created a custom client field, proceed to '' 'Setup' '' → '' 'Addon Modules' '' and press '' 'Configure' '' next to '' 'Time & Task Manager'. ''<br/> |
− | Afterwards, fill in predefined price per hour for previously created custom field and press '' 'Save Changes'. '' | + | Afterwards, fill in a predefined price per hour for the previously created custom field and press '' 'Save Changes'. '' |
|} | |} | ||
{| | {| | ||
Line 271: | Line 303: | ||
{| | {| | ||
|style="padding: 0px 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/> | |style="padding: 0px 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/> | ||
− | To set up | + | To set up your first product, proceed to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'. ''<br/> |
Press '' 'Create a New Group' '' to create a new product group or use existing one instead. | Press '' 'Create a New Group' '' to create a new product group or use existing one instead. | ||
|} | |} | ||
Line 278: | Line 310: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Fill in product group name and press '' 'Save Changes'. '' | + | |style="padding: 0px 0px 20px 15px;"|Fill in a product group name and press '' 'Save Changes'. '' |
|} | |} | ||
{| | {| | ||
Line 290: | Line 322: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Fill in product name, choose previously created group and press '' 'Continue'. '' | + | |style="padding: 0px 0px 20px 15px;"|Fill in a product name, choose the previously created group and press '' 'Continue'. '' |
|} | |} | ||
{| | {| | ||
Line 296: | Line 328: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Uncheck '' 'Require Domain' '' checkbox and proceed to '' 'Pricing' '' tab. | + | |style="padding: 0px 0px 20px 15px;"|Uncheck the '' 'Require Domain' '' checkbox and proceed to the '' 'Pricing' '' tab. |
|} | |} | ||
{| | {| | ||
Line 302: | Line 334: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Choose payment type, enable wanted billing cycles and fill in price for each of them.<br/> | + | |style="padding: 0px 0px 15px 15px;"|Choose a payment type, enable wanted billing cycles and fill in a price for each of them.<br/> |
− | Now, go to '' 'Module Settings' '' tab. | + | Now, go to the '' 'Module Settings' '' tab. |
|} | |} | ||
{| | {| | ||
Line 309: | Line 341: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Choose | + | |style="padding: 0px 0px 15px 15px;"|Choose the '' 'TimeTrackingPrepaid' '' module from the '' 'Module Name' '' dropdown menu.<br/> |
Afterwards, fill in the amount of prepaid hours and incidents this product will grant to clients and press '' 'Save Changes'. ''<br/> | Afterwards, fill in the amount of prepaid hours and incidents this product will grant to clients and press '' 'Save Changes'. ''<br/> | ||
− | If you select option '' 'Delete Hours On Renew' '' - unused hours from a past billing period will be deleted.<br/>In other words, if a client does not use all the purchased hours they are '''not''' added to the hours purchased from the renewed period, their number is reset.<br/><br/> | + | If you select option '' 'Delete Hours On Renew' '' - unused hours from a past billing period will be deleted.<br/>In other words, if a client does not use all the purchased hours they are '''not''' added to the hours purchased from the renewed period, their number is reset instead.<br/><br/> |
− | ''Note 1: Prepaid hours can be used to pay for tasks | + | ''Note 1: Prepaid hours can be used to pay for the tasks using the same prepaid hour type.''<br/> |
''Note 2: Prepaid incidents can be used to offer one time support services.''<br/> | ''Note 2: Prepaid incidents can be used to offer one time support services.''<br/> | ||
− | ''Incidents are removed from the client account | + | ''Once a task using Incidents is created, they are removed from the client's account.'' |
|} | |} | ||
{| | {| | ||
Line 322: | Line 354: | ||
==Addon== | ==Addon== | ||
{| | {| | ||
− | |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/> | + | |style="padding: 10px 0px 30px 15px;"|Addon is the main part of the 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. | + | Additionally, from here you can create the tasks ordered by your clients, track the time spent on them and bill your clients accordingly. |
|} | |} | ||
===Support Clients=== | ===Support Clients=== | ||
{| | {| | ||
− | |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/> | + | |style="padding: 10px 0px 15px 15px;"|In the '' '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.''--> | <!--''Note: New accounts are automatically created for clients who bought Time Tracking Center For WHMCS provisioning product.''--> | ||
|} | |} | ||
Line 340: | Line 372: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Select a desired client from '' 'WHMCS Client' '' dropdown menu and fill in the name under which the client will be visible in the addon.<br/> | + | |style="padding: 0px 0px 15px 15px;"|Select a desired client from the '' 'WHMCS Client' '' dropdown menu and fill in the name under which the client will be visible in the addon.<br/> |
Additionally, you can add a note to this client.<br/> | Additionally, you can add a note to this client.<br/> | ||
Select status '' 'Active' '' or '' 'Inactive' '' and press '' 'Add Support Client' '' to confirm and save this account. | Select status '' 'Active' '' or '' 'Inactive' '' and press '' 'Add Support Client' '' to confirm and save this account. | ||
Line 348: | Line 380: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|By using the buttons marked on the following screen you can easily remove and edit support clients' accounts. |
|} | |} | ||
{| | {| | ||
Line 356: | Line 388: | ||
===Tasks=== | ===Tasks=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|All tasks for which your clients can be billed are stored in '' 'Tasks' '' tab.<br/> | + | |style="padding: 10px 0px 15px 15px;"|All tasks for which your clients can be billed are stored in the '' 'Tasks' '' tab.<br/> |
Press '' 'Add New Task' '' to create a new task. | Press '' 'Add New Task' '' to create a new task. | ||
|} | |} | ||
Line 364: | Line 396: | ||
====New Task==== | ====New Task==== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Start by selecting one of the support clients and fill in task name.<br/> | + | |style="padding: 10px 0px 15px 15px;"|Start by selecting one of the support clients and fill in a 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'. '' Here you can also set up<br/>'' 'Extra Hourly Rate' '' to have a wider choice when charging clients. | + | Afterwards, define a payment for each hour spent on this task by selecting from '' 'Charge From Prepaid Hours' '' or filling in price into '' 'Hourly Rate'. '' Here you can also set up an<br/>'' 'Extra Hourly Rate' '' to have a wider choice when charging clients. Then you may select special prices to charge for some extra services, these provided in shorter time <br/>or for any other reason you might have. |
|} | |} | ||
{| | {| | ||
Line 381: | Line 413: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Now, choose the task's status and urgency level, fill in description of the task | + | |style="padding: 0px 0px 20px 15px;"|Now, choose the task's status and urgency level, fill in the description of the task.<br />In addition, you can also add time entires, or do it later from the '' 'Work Sheet' '' tab view. <br /> |
+ | Press '' 'Add Task' '' when ready. | ||
|} | |} | ||
{| | {| | ||
Line 389: | Line 422: | ||
===Work Sheet=== | ===Work Sheet=== | ||
{| | {| | ||
− | |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 | + | |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 one from the predefined tasks. |
|} | |} | ||
{| | {| | ||
Line 396: | Line 429: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Let's create a new entry for the previously created task.<br/> | |style="padding: 0px 0px 15px 15px;"|Let's create a new entry for the previously created task.<br/> | ||
− | Each time you enter '' 'Work Sheet' '' tab, a form to create a new entry will be already open.<br/> | + | Each time you enter the '' 'Work Sheet' '' tab, a form to create a 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/> | 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 the number of hours spent, mileages traveled and description.<br/> | + | Afterwards, fill in the number of hours spent, mileages traveled and a description.<br/> |
− | Create entry through pressing '' 'Submit New Time Entry'. '' | + | Billable entries can be added to queue so they will be shown on the customer's invoices. <br/> |
+ | Otherwise, they will not be included until the administrator accepts them from the entries list or by manually changing their '' 'Billable' '' status to '' 'Yes' ''.<br/> | ||
+ | Create an entry through pressing '' 'Submit New Time Entry'. '' | ||
|} | |} | ||
{| | {| | ||
Line 405: | Line 440: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Below you can find the list of tasks | + | |style="padding: 0px 0px 15px 15px;"|Below you can find the list of tasks for the current day.<br/> |
In order to display tasks from the other day, select it in the calendar as shown on the following screen. | In order to display tasks from the other day, select it in the calendar as shown on the following screen. | ||
|} | |} | ||
Line 412: | Line 447: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|All time entries can be afterwards modified | + | |style="padding: 0px 0px 20px 15px;"|All time entries can be afterwards modified, removed and rejected through using buttons marked on the following screen. |
|} | |} | ||
{| | {| | ||
Line 420: | Line 455: | ||
===Billing=== | ===Billing=== | ||
{| | {| | ||
− | |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/> | + | |style="padding: 10px 0px 15px 15px;"|Finally, it is time to show you the place where you can generate invoices for the time spent on your clients' tasks.<br/> |
− | As you can see, here you can find billing | + | As you can see, here you can find billing for a single time entry with detailed information about each of them.<br/> |
− | You can find specific ones through using filters marked on the following screen.<br/> | + | You can find specific ones through using the filters marked on the following screen.<br/> |
− | Filters allow you to display time entries from specified time period as well as display only those assigned to selected support client. | + | Filters allow you to display the time entries from specified time period as well as display only those assigned to a selected support client. |
|} | |} | ||
{| | {| | ||
Line 429: | Line 464: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Let's generate invoice for client Kate Cole from | + | |style="padding: 0px 0px 15px 15px;"|Let's generate invoice for client Kate Cole from the time entries created this week.<br/> |
− | Start by filling in correct time period and choose Kate Cole from '' 'Support Client' '' dropdown menu and press '' 'Refresh Filters'. '' | + | Start by filling in the correct time period and choose Kate Cole from the '' 'Support Client' '' dropdown menu and press '' 'Refresh Filters'. '' |
|} | |} | ||
{| | {| | ||
Line 436: | Line 471: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|As you can see only desired time entries are displayed.<br/> | + | |style="padding: 0px 0px 15px 15px;"|As you can see, only the desired time entries are displayed.<br/> |
− | Mark checkbox as shown on the following screen to mark them all at once.<br/> | + | If you wish to display entries that are not schedulded cron jobs, tick the '' 'Only Not Queued' '' box.<br/> |
− | Now, press '' 'Invoice Now' '' to generate invoice for selected time entries.<br/> | + | Mark the checkbox as shown on the following screen to mark them all at once.<br/> |
− | You can also press '' 'Add to Queue' '' which will add selected entries to cron queue. | + | Now, press '' 'Invoice Now' '' to generate invoice for the selected time entries.<br/> |
+ | You can also press '' 'Add to Queue' '' which will add the selected entries to the cron queue. | ||
|} | |} | ||
{| | {| | ||
Line 445: | Line 481: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Generated invoice records contain information in format defined at the module configuration.<br /> | + | |style="padding: 0px 0px 15px 15px;"|Generated invoice records contain information in the format defined at the module configuration.<br /> |
− | ''Note: Prices inside of the addon are displayed basing on default WHMCS currency.''<br/> | + | ''Note: Prices inside of the addon are displayed basing on the default WHMCS currency.''<br/> |
''Invoices are converted to currencies used by your clients basing on conversion rates defined in your WHMCS system.'' | ''Invoices are converted to currencies used by your clients basing on conversion rates defined in your WHMCS system.'' | ||
|} | |} | ||
Line 455: | Line 491: | ||
===Reports=== | ===Reports=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|You can easily generate reports | + | |style="padding: 10px 0px 15px 15px;"|You can easily generate reports of the work done for your clients.<br/> |
− | Proceed to '' 'Reports' '' tab to do so.<br/> | + | Proceed to the '' 'Reports' '' tab to do so.<br/> |
− | Now, fill in report name, date range and select | + | Now, fill in a report name, date range and select the client you wish to generate the report for.<br/> |
− | Select order of tasks: by date or according to task order.<br/> | + | Select the order of tasks: by date or according to task order.<br/> |
+ | Next choose the elements you want to be displayed in the report.<br/> | ||
Confirm through pressing '' 'Generate PDF Report'. '' | Confirm through pressing '' 'Generate PDF Report'. '' | ||
|} | |} | ||
Line 470: | Line 507: | ||
|style="padding: 0px 0px 30px 25px;"|[[File:TTC2_35.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:TTC2_35.png]] | ||
|} | |} | ||
+ | |||
===Cron=== | ===Cron=== | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|In the cron tab you can define the behavior of cron, find path to cron, view all queued entries and manually invoice them.<br/> | |style="padding: 10px 0px 15px 15px;"|In the cron tab you can define the behavior of cron, find path to cron, view all queued entries and manually invoice them.<br/> | ||
− | 1. To alter cron behavior, choose desired option from '' 'Cron Billing Action' '' as shown on the following screen.<br/> | + | 1. To alter cron behavior, choose the desired option from '' 'Cron Billing Action' '' as shown on the following screen.<br/> |
− | ''Note 1: If there are at least two time entries bounded to the same client, | + | ''Note 1: If there are at least two time entries bounded to the same client, a single summary invoice for that client will be created.''<br/> |
''Note 2: In order to apply tax to such an invoice, mark '' 'Billable Items' '' at your tax rule.''<br/> | ''Note 2: In order to apply tax to such an invoice, mark '' 'Billable Items' '' at your tax rule.''<br/> | ||
− | 2. It is possible to enable '' 'Auto Credit Applying On Invoice Generation' '' option | + | 2. It is possible to enable the '' 'Auto Credit Applying On Invoice Generation' '' option for invoices created by the module, regardless of the WHMCS settings.<br/> |
− | 3. Enable '' 'Zero Invoices For Prepaid Entries' '' option to generate an invoice with 0.00 total that will serve as confirmation of prepaid hours utilization. | + | 3. Enable the '' 'Zero Invoices For Prepaid Entries' '' option to generate an invoice with 0.00 total that will serve as the confirmation of prepaid hours utilization. |
|} | |} | ||
{| | {| | ||
Line 485: | Line 523: | ||
===Logs=== | ===Logs=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|'' 'Logs' '' tab contains the logs of all actions made inside of Time & Task Manager For WHMCS.<br/> | + | |style="padding: 10px 0px 15px 15px;"|The '' 'Logs' '' tab contains the logs of all the actions made inside of Time & Task Manager For WHMCS.<br/> |
There are two columns similar to each other, '' 'Data' '' and '' 'Old Data'. ''<br/> | There are two columns similar to each other, '' 'Data' '' and '' 'Old Data'. ''<br/> | ||
− | In '' 'Data' '' column you can find details | + | In '' 'Data' '' column you can find details referring to the time after ordering logged action.<br/> |
− | While '' 'Old Data' '' contains data from the time before ordering logged action if there were such. | + | While '' 'Old Data' '' contains the data from the time before ordering logged action if there were such. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:TTC2_37.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:TTC2_37.png]] | ||
|} | |} | ||
+ | |||
===Integration Code=== | ===Integration Code=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|Follow integration code, shown | + | |style="padding: 10px 0px 20px 15px;"|Follow the integration code, shown below, to display tasks and prepaid hours in your client area. |
|} | |} | ||
{| | {| | ||
Line 501: | Line 540: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Here you can also select a product from the list of your available that will be by default added to a cart if client decides to purchase some additional hours.<br/> | + | |style="padding: 0px 0px 20px 15px;"|Here you can also select a product from the list of your available ones that will be by default added to a cart if a client decides to purchase some additional hours.<br/> |
Read more about this option [http://www.docs.modulesgarden.com/Time_And_Task_Manager_For_WHMCS#Client_Area here]. | Read more about this option [http://www.docs.modulesgarden.com/Time_And_Task_Manager_For_WHMCS#Client_Area here]. | ||
|} | |} | ||
Line 508: | Line 547: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|If all the integration codes have been inserted correctly, this is how Client Area home page should look like.<br/> On the screen below you can see a list of open and closed tasks and | + | |style="padding: 0px 0px 20px 15px;"|If all the integration codes have been inserted correctly, this is how Client Area home page should look like.<br/> On the screen below you can see a list of open and closed tasks and the button to purchase additional hours. |
|} | |} | ||
{| | {| | ||
Line 516: | Line 555: | ||
===Predefined Tasks=== | ===Predefined Tasks=== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|On '' 'Predefined Tasks' '' page you are able to set up predefined tasks.<br/> | + | |style="padding: 10px 0px 15px 15px;"|On the '' 'Predefined Tasks' '' page you are able to set up predefined tasks.<br/> |
− | Those tasks can be used to instantly create new tasks during creation of work sheet entry.<br/> | + | Those tasks can be used to instantly create new tasks during creation of a work sheet entry.<br/> |
Press '' 'Add New Predefined Task' '' to proceed. | Press '' 'Add New Predefined Task' '' to proceed. | ||
|} | |} | ||
Line 524: | Line 563: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Now, fill in predefined task name, hourly rate and extra hourly rate, price per mileage and description.<br/> | + | |style="padding: 0px 0px 15px 15px;"|Now, fill in a predefined task name, hourly rate and an extra hourly rate, price per mileage and a description.<br/> |
− | Additionally, choose prepaid hours (optional), mileage type and initial status of the task.<br/> | + | Additionally, choose prepaid hours (optional), mileage type and the initial status of the task.<br/> |
Press '' 'Add Predefined Task' '' to save it. | Press '' 'Add Predefined Task' '' to save it. | ||
|} | |} | ||
Line 532: | Line 571: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|You can manage the predefined tasks the same way you manage regular tasks. | + | |style="padding: 0px 0px 20px 15px;"|You can manage the predefined tasks the same way you manage the regular tasks. |
|} | |} | ||
{| | {| | ||
Line 538: | Line 577: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|On the following screen you can see how the predefined tasks look in | + | |style="padding: 0px 0px 20px 15px;"|On the following screen you can see how the predefined tasks look in a new work entry form. |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 30px 25px;"|[[File:TTC2_42.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:TTC2_42.png]] | ||
|} | |} | ||
+ | |||
==Support Integration== | ==Support Integration== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|Owing to integration with support department, your staff members can easily create task that will be assigned to a ticket. | + | |style="padding: 10px 0px 20px 15px;"|Owing to the integration with support department, your staff members can easily create a task that will be assigned to a ticket. |
|} | |} | ||
{| | {| | ||
Line 552: | Line 592: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Ticket tasks are created in the same manner as the regular tasks.<br/> | |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 | + | As you can see on the screen below the only difference is the direct link to the ticket. |
|} | |} | ||
{| | {| | ||
Line 558: | Line 598: | ||
|} | |} | ||
{| | {| | ||
− | |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/> | + | |style="padding: 0px 0px 15px 15px;"|As soon as you get back to the ticket, you will notice that the '' 'Create Task' '' button has changed into '' 'Edit Task'. ''<br/> |
− | There | + | There are also options to '' 'Start Counter' '' (if it was not started automatically) , '' 'Show Report' '' and '' 'Add Time Entries' ''.<br/> |
− | This means that a previously created task is assigned to | + | This means that a previously created task is assigned to a ticket. |
|} | |} | ||
{| | {| | ||
Line 566: | Line 606: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|At this point you may also start the counter and begin counting hours spent on solving | + | |style="padding: 0px 0px 20px 15px;"|At this point you may also start the counter and begin counting hours spent on solving a given ticket. |
|} | |} | ||
{| | {| | ||
Line 572: | Line 612: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Control the time while solving | + | |style="padding: 0px 0px 20px 15px;"|Control the time while solving a ticket, when you are done press '' 'Add Response' '' and the timer will stop. |
|} | |} | ||
{| | {| | ||
Line 590: | Line 630: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:TTC2_45_5.png]] |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|The '' 'Add Time Entries' '' button allows the operator to add a new time entry directly from a given task. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:TTC2_45_6.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|Note that the entries created in this way will be settled at the default rates set in part 7 of the [https://www.docs.modulesgarden.com/Time_And_Task_Manager_For_WHMCS#Configuration_Of_Addon addon configuration]. <br/> | ||
+ | In this way, the support operator may still add entries, but without the possibility of modifying the rates or even access to the Time And Task Manager addon. <br/> | ||
+ | Moreover, these entries will also have the '' 'Billable' '' status set to '' 'No' '' by default, so they will be billed on the customer's invoice only after the administrator's approval. | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 25px;"|[[File:TTC2_45_7.png]] | ||
|} | |} | ||
==Client Area== | ==Client Area== | ||
{| | {| | ||
− | |style="padding: 10px 0px | + | |style="padding: 10px 0px 15px 15px;"|In the client area your clients can view all the unused prepaid hours and incidents.<br/> |
+ | In the top right-hand corner of the tab there is also a current balance of either available or exceeded hours. | ||
|} | |} | ||
{| | {| | ||
Line 601: | Line 656: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Additionally, they can see | + | |style="padding: 0px 0px 20px 15px;"|Additionally, they can see the tasks concerning them with basic information like a current status, hours spent on it and an hourly billing rate. |
|} | |} | ||
{| | {| | ||
Line 615: | Line 670: | ||
|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/> | |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/> | ||
By default, it will move your clients to the order form of the provisioning module selected in the Time & Task Manager For WHMCS addon.<br/> | By default, it will move your clients to the order form of the provisioning module selected in the Time & Task Manager For WHMCS addon.<br/> | ||
− | To change it move to '' [http://www.docs.modulesgarden.com/Time_And_Task_Manager_For_WHMCS#Integration_Code Integration Code]'' section. | + | To change it move to the '' [http://www.docs.modulesgarden.com/Time_And_Task_Manager_For_WHMCS#Integration_Code Integration Code]'' section. |
|} | |} | ||
{| | {| | ||
Line 693: | Line 748: | ||
|} | |} | ||
{| | {| | ||
− | |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. If you are manually generating an invoice from at least two time entries bounded to the same client, one summary invoice for that client will be created. |
|} | |} | ||
{| | {| |
Revision as of 17:08, 22 November 2017
Contents |
About Time & Task Manager For WHMCS
Time & Task Manager 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 number of hours that can be spent on performance of your services. |
- 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 Custom Tasks Connected To Specific Tickets |
✔ Create/Edit Tasks With Default Rates, Status And Urgency From Tickets |
✔ Define Billable Time Entries |
✔ View List Of Billable Time Entries |
✔ Generate Invoices Automatically Or Manually |
✔ Add Invoice Creation To Cron Queue |
✔ Bill For Time Spent On Solving Tickets |
✔ Define And Bill For Mileages Traveled |
✔ Set Predefined Prices |
✔ Send Email Notifications - New Task/New Time Entry |
✔ Generate And View Fully Configurable Reports On Your Clients And Administrators |
✔ Choose The Type 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 |
- Client Area Features:
✔ View Lists Of Opened And Closed Tasks |
✔ View Current Task Status, Worked Hours And Hourly Rate |
✔ View Purchased Prepaid Hours |
✔ View Balance Of Available Or Exceeded Hours |
✔ Buy Additional Hours |
- Task Configuration:
✔ Support Client |
✔ Task Name |
✔ Predefined Incidents |
✔ Predefined/Custom Charge Per Hour |
✔ Custom Charge Per Extra Hour |
✔ Charge Per Mileage |
✔ Mileage Type - Billable / Visible For Client And Administrators / Visible For Administrators Only |
✔ Task Status |
✔ Task Urgency |
✔ Description |
✔ Time Entries |
- 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 |
✔ Generate Zero Invoices For Prepaid Entrie |
✔ Enable Auto Credit Application On Invoice Generation |
- General Info:
✔ Multi-Currency Support |
✔ Multi-Language Support |
✔ Supports PHP 5.4 Up To PHP 7 |
✔ Supports WHMCS Templates Five and Six |
✔ Supports WHMCS V6 and V7 |
Installation and Configuration
This tutorial will show you how to successfully install and configure Time & Task Manager 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 the module. |
![]() |
2. In the downloaded file you will find two packages that support different PHP versions. As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6. It does not apply to open source versions. Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'. |
![]() |
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory. The content of PHP version files should look like this. |
![]() |
4. When you install Time & Task Manager For WHMCS for the first time you have to rename 'license_RENAME.php' file. File is located in 'modules/addons/TimeTaskManager/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
![]() |
5. 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'. |
![]() |
Configuration Of Addon
6. 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 & Task Manager' and press the 'Activate' button. |
![]() |
7. In the next step you need to permit access to this module and set up basic configuration. To do so, click on 'Configure' . |
![]() |
8. Additionally, here you can set up invoice description format and predefined price per hour. You can use variables listed under the help sign to define invoice description, each invoice description allows different set of variables. |
Invoice Description Format: {$admin_name} |
More about setting up predefined price per hour can be found in the Predefined Price And Prepaid Hours section. |
![]() |
9. You have just successfully installed Time & Task Manager For WHMCS! You can access your module in 'Addons' → 'Time & Task Manager'. |
![]() |
Remember to clear templates_c folder when migrating to Time & Task Manager 1.3.0 version or a newer one! |
Management
In this section we will show you how to properly set up and use Time & Task Manager For WHMCS. Our module allows you to easily add and track progress of the tasks ordered by your clients while your staff members are able to easily report time spent on each of them. |
Predefined Price And Prepaid Hours
You can easily set up predefined price per hour using Custom Client Fields. Afterwards, you can sell those hours to your clients using provisioning module. |
Setting Up Custom Field
First of all, set up Custom Client Fields visible only from the admin area. To do so, proceed to 'Setup' → 'Custom Client Fields'. Fill in its name, choose 'Text Box' as your 'Field Type' . ^[0-9]*$ Now, mark the 'Admin Only' checkbox and press 'Save Changes'. |
![]() |
You can set up prepaid incidents the same way. The only difference is placing 'incident' into the 'Select Options' field. |
![]() |
Predefined Price
Once you have created a custom client field, proceed to 'Setup' → 'Addon Modules' and press 'Configure' next to 'Time & Task Manager'. Afterwards, fill in a predefined price per hour for the previously created custom field and press 'Save Changes'. |
![]() |
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 your first product, proceed to 'Setup' → 'Products/Services' → 'Products/Services'. |
![]() |
Fill in a product group name and press 'Save Changes'. |
![]() |
Now, create a new product, press 'Create a New Product' to proceed. |
![]() |
Fill in a product name, choose the previously created group and press 'Continue'. |
![]() |
Uncheck the 'Require Domain' checkbox and proceed to the 'Pricing' tab. |
![]() |
Choose a payment type, enable wanted billing cycles and fill in a price for each of them. Now, go to the 'Module Settings' tab. |
![]() |
Choose the 'TimeTrackingPrepaid' module from the 'Module Name' dropdown menu. Afterwards, fill in the amount of prepaid hours and incidents this product will grant to clients and press 'Save Changes'. |
![]() |
Addon
Addon is the main part of the time tracking process. It is here where all the tasks and time entries are made. Additionally, from here you can create the tasks ordered by your clients, track the time spent on them and bill your clients accordingly. |
Support Clients
In the '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. |
![]() |
Let's create an account for client Kate Cole, press 'Add Support Client' to proceed. |
![]() |
Select a desired client from the 'WHMCS Client' dropdown menu and fill in the name under which the client will be visible in the addon. Additionally, you can add a note to this client. |
![]() |
By using the buttons marked on the following screen you can easily remove and edit support clients' accounts. |
![]() |
Tasks
All tasks for which your clients can be billed are stored in the 'Tasks' tab. Press 'Add New Task' to create a new task. |
![]() |
New Task
Start by selecting one of the support clients and fill in a task name. Afterwards, define a payment for each hour spent on this task by selecting from 'Charge From Prepaid Hours' or filling in price into 'Hourly Rate'. Here you can also set up an |
![]() |
You can also set up pricing for mileage. You can choose from three types of mileages:
|
![]() |
Now, choose the task's status and urgency level, fill in the description of the task. In addition, you can also add time entires, or do it later from the 'Work Sheet' tab view. Press 'Add Task' when ready. |
![]() |
Work Sheet
In 'Work Sheet' your staff members are able to report hours spent on existing tasks or create a new task by choosing one from the predefined tasks. |
![]() |
Let's create a new entry for the previously created task. Each time you enter the 'Work Sheet' tab, a form to create a new entry will be already open. |
![]() |
Below you can find the list of tasks for the current day. In order to display tasks from the other day, select it in the calendar as shown on the following screen. |
![]() |
All time entries can be afterwards modified, removed and rejected through using buttons marked on the following screen. |
![]() |
Billing
Finally, it is time to show you the place where you can generate invoices for the time spent on your clients' tasks. As you can see, here you can find billing for a single time entry with detailed information about each of them. |
![]() |
Let's generate invoice for client Kate Cole from the time entries created this week. Start by filling in the correct time period and choose Kate Cole from the 'Support Client' dropdown menu and press 'Refresh Filters'. |
![]() |
As you can see, only the desired time entries are displayed. If you wish to display entries that are not schedulded cron jobs, tick the 'Only Not Queued' box. |
![]() |
Generated invoice records contain information in the format defined at the module configuration. Note: Prices inside of the addon are displayed basing on the default WHMCS currency. |
![]() |
Reports
You can easily generate reports of the work done for your clients. Proceed to the 'Reports' tab to do so. |
![]() |
On the following screen you can see the report for client Test Tester. |
![]() |
Cron
In the cron tab you can define the behavior of cron, find path to cron, view all queued entries and manually invoice them. 1. To alter cron behavior, choose the desired option from 'Cron Billing Action' as shown on the following screen. |
![]() |
Logs
The 'Logs' tab contains the logs of all the actions made inside of Time & Task Manager For WHMCS. There are two columns similar to each other, 'Data' and 'Old Data'. |
![]() |
Integration Code
Follow the integration code, shown below, to display tasks and prepaid hours in your client area. |
![]() |
Here you can also select a product from the list of your available ones that will be by default added to a cart if a client decides to purchase some additional hours. Read more about this option here. |
![]() |
If all the integration codes have been inserted correctly, this is how Client Area home page should look like. On the screen below you can see a list of open and closed tasks and the button to purchase additional hours. |
![]() |
Predefined Tasks
On the 'Predefined Tasks' page you are able to set up predefined tasks. Those tasks can be used to instantly create new tasks during creation of a work sheet entry. |
![]() |
Now, fill in a predefined task name, hourly rate and an extra hourly rate, price per mileage and a description. Additionally, choose prepaid hours (optional), mileage type and the initial status of the task. |
![]() |
You can manage the predefined tasks the same way you manage the regular tasks. |
![]() |
On the following screen you can see how the predefined tasks look in a new work entry form. |
![]() |
Support Integration
Owing to the integration with support department, your staff members can easily create a task that will be assigned to a ticket. |
![]() |
Ticket tasks are created in the same manner as the regular tasks. As you can see on the screen below the only difference is the direct link to the ticket. |
![]() |
As soon as you get back to the ticket, you will notice that the 'Create Task' button has changed into 'Edit Task'. There are also options to 'Start Counter' (if it was not started automatically) , 'Show Report' and 'Add Time Entries' . |
![]() |
At this point you may also start the counter and begin counting hours spent on solving a given ticket. |
![]() |
Control the time while solving a ticket, when you are done press 'Add Response' and the timer will stop. |
![]() |
Select whether you want to bill the client for the time spent on solving the ticket, choose rate (normal or extra if set up). |
![]() |
You may also preview this task report from this point. |
![]() |
![]() |
The 'Add Time Entries' button allows the operator to add a new time entry directly from a given task. |
![]() |
Note that the entries created in this way will be settled at the default rates set in part 7 of the addon configuration. In this way, the support operator may still add entries, but without the possibility of modifying the rates or even access to the Time And Task Manager addon. |
![]() |
Client Area
In the client area your clients can view all the unused prepaid hours and incidents. In the top right-hand corner of the tab there is also a current balance of either available or exceeded hours. |
![]() |
Additionally, they can see the tasks concerning them with basic information like a current status, hours spent on it and an hourly billing rate. |
![]() |
Underneath, there is also a list of all closed task with the same details on each one of them. |
![]() |
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 provisioning module selected in the Time & Task Manager For WHMCS addon. |
![]() |
![]() |
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 & Task Manager For WHMCS addon configuration and set up 40 USD/h for 'Development Hours'. |
3. Prepare Time & Task Manager For WHMCS provisioning product set up with recurring payment type and name it '10 Development Hours'. Fill in 10 into 'Development Hours' field in '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 & Task Manager' → 'Tasks' and created a new task for this client concerning his request. |
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:
'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. |
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. |
10. Marked time entries were summarized, 18 and a 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. |
11. Invoice is generated with 4 items, one per each time entry.
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 & Task Manager 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 an 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. |
5. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process. |
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |
2. Make sure you have pricing set up in every used in your system currency, otherwise problems may occur. |
3. If you have problems with updating the module to a newer version, please follow the standard Modules Update guide. |