WHMCS Documentation - User contributions [en]

Project Management

2021-07-11T13:11:27Z

DanR: /* Settings */

==Introduction==

The Official Project Management addon for WHMCS is a tool designed to help you organise jobs & tasks, allowing you to tie Support Tickets & Invoices with To-Do Items to create Projects. The aim is to connect everything together via a single interface, avoiding unecessary & time consuming duplication to third party systems, and allowing staff to privately communicate and track internal discussions, share files, and track (as well as optionally bill) for time spent on individual tasks.

To find out more, please visit [https://www.whmcs.com/project-management/ www.whmcs.com/project-management]

__TOC__

==Installation & Setup==

The Project Management Add-on is supplied with WHMCS by default.

To activate the addon, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules''' and hit the ''Activate'' button.

<div class="docs-alert-info">You will need to purchase the Project Management add-on for your WHMCS license if you have not already done so. [http://www.whmcs.com/addons/project-management/ Learn more]</div>

Following activation of the module, assign yourself permissions to access it and then you can navigate to the add-on by going to Addons > Project Management.

===Settings===

*'''Access Control''' - These checkboxes allow you to define which role groups you want to allow to access and use the project management system
*'''Master Admin Users''' - This series of checkboxes is where you define who you want to be able to access and configure the Project Management Addon settings within the module itself - this includes settings such as project statuses and access permissions

==Upgrading==

To apply a manual update to the Project Management Addon, download the update from our website, unzip the files and upload them to the root WHMCS directory - the files are provided within the appropriate sub-directories to ensure correct upload.

Upon your first visit to the Project Management Addon within your WHMCS admin area the new update will be detected and any required database updates will be automatically applied.

==Getting Started==

To access the Project Management addon, simply navigate to '''Addons > Project Management'''

You will then be presented with the Project Management Overview. This page lists all projects by default, in ascending order of due date, so those due first will appear at the top, listing the title, staff member the project is assigned to, status, creation & due dates, number of days left or overdue, and the last updated date for the project.

From this page you can also review the most recent 10 activity log entries displayed to the right of the page, and search for projects which we'll look at in more detail later on.

Everything within the Project Management system starts out with a project. Tasks, Tickets, Invoices, Attachments & Messages, all must belong to a project. So let's get started with creating a project...

===Creating Your First Project===

#Click the '''Create New Project''' button (found at the top left of every Project Management Page)
#A dialog window will then slide into view, where you will find fields for entering the title of the project, the creation date, due date, staff assignee (if any) and associated ticket number (again optional)
#Once you are done, click '''Create'''
#You will now be taken to the Project overview screen, and congratulations, you just created your first project!

You can also create a project directly from within a support ticket, using the "Create New Project" button that will appear at the top of the ticket if no projects are currently assigned to it.

==The Project Management Screen==

This is the main page where you'll spend most of your time - the project management screen - the page that let's you view everything relating to your project. There's no tabs or pages here, everything is on a single page, at your finger tips, right where you need it.

[[File:Projectmanagementview.png|800px]]

At the very top we have the project title, click the pencil edit icon to change the project title. Next to it are the '''Project Command buttons'''; Start Timer, Add Comment, Upload File, Send Email and Watching buttons. Use the green [[#Tracking_Time|Start Timer]] button when you start working on a project, whilst the ''Add Comment'' button records a private staff-only note. ''Upload File'' and ''Send Email'' allow you to perform those two actions respectively. Switch the ''Watching'' button to the On position to receive email notifications of changes to the project, switch it to Off to stop receiving these emails.

Next we have the '''Info Bar'''. This contains all the project details - the creation date, staff member it's assigned to, associated client, due date, total time worked and status. Probably the most important statistic is ''due date''; when it's Green there are 1 or more days to go until it's due, but the days left turn Red when there's only 1 day left, or it is overdue.

Below that are the '''Project Tabs''', giving you access to Tasks, Messages, Time Tracking, Tickets, Billing/Invoices, Files and the Project Log.

The Project Log provides a full history of each and every action carried out on that project, the date/time it was done, and the admin user who performed it.

===Editing Projects===

To edit projects, providing you have the required permissions, you'll see an Edit button located towards the top right of the screen. Upon clicking that, the previous display values will be transformed into input fields allowing you to update and make changes, and the edit button will be replaced with Save and Cancel buttons that you can use to save your changes, or abort. If saving, a success message will appear briefly to confirm success.

The Associated Client field features an intelligent search feature, so you can search for a client to assign to by entering any part of their name, company or email address, and simply select the desired result from the list of matches that get displayed.

===Changing Status===

To change the status of a project, simply change the dropdown value located to the right of the info bar at any time. Selection changes for this are automatically saved, so there's no save or submit required. A success message will appear briefly to confirm success.

===Project Tasks===

Tasks can be created using the "New Task" input field. Simply enter the task and press Enter key, or click the Add button to create it. Upon pressing enter, the task will be added and the input field reset to empty to allow you to quickly and easily add multiple tasks in one go.
Once a task is completed it can be marked '''complete''' by ticking the checkbox next to the task name.

====Tracking Time====

To track the time spent on tasks, staff members click the green ''Track Time'' button on the project page when they start working on it. This creates a time log entry with their username, and the start time. The button will then change to an orange ''End Timer'' button, click this button when finished working on the project.

This time entry can then be assigned to a task via the '''Time Tracking''' tab. Click the ''Edit'' pencil icon and select the relevant task from the modal which appears.

The total time is calculated on a per task basis, and for the project as a whole (total project time is displayed on the Info Bar).

====Editing Tasks====

If you have permissions, you can also edit tasks, which allows you to edit both the task title, and any time logged entries recorded for it, allowing to edit both the staff member and the start or end times for the task.

===Task Templates===
Task Templates are a predefined list of tasks that can be added to a project via the push of a button. This feature offers the ability to store a list of commonly used tasks as a single template so that they can be added to additional projects on an as needed basis.

When viewing a Project, the Task Templates menu can be found on the right-hand side of the page. There you will see two buttons: Save Task List, and Import Tasks.

====Save Task List====
This option allows you to save all of the tasks associated with the current Project into a single task list. Upon clicking the button, a modal will appear with a prompt to enter a name for the new task list, and clicking Save will see the new list created.

====Import Tasks====
This option allows you to import tasks from an existing Task List. Upon clicking the button, a modal will appear with a search field that allows you to search for a list via the Project ID, Title, or Task Template Name. After locating the task list you can then select which tasks you would like to import, and click on the Import button to add them to the current project.

====Manage Tasks====
Task Templates can be managed via the Settings > Task Templates section of the Project Management Addon. There you are able to review any existing templates, and delete them if required.

===Associated Tickets===

Assocating tickets to a project is simply a case of entering the Ticket Number into the input field and clicking Add. WHMCS will verify that the ticket number is valid, and that it isn't already assigned to the project, and if so will associate it to it.

A single ticket can be assigned to multiple projects, and a single project can have multiple tickets assigned to it.

'''Note:''' If a project is not yet associated to a client, then if a ticket belonging to a registered client is assigned, that client will automatically be associated with the project as well.

===Associated Invoices===

Invoices associated with projects allow you to view their status from within the project itself.

Invoices do not have to be assigned manually, they are automatically detected in one of 3 ways:

#By containing a line item which includes the phrase "Ticket #xxxxxx" followed by any ticket number associated with the invoice as above
#By containing a line item which includes the phrase "Project #XXX" followed by the Project ID number being viewed
#Or by having been generated directly from the Project view itself, using either the '''Quick Invoice''' or '''Bill for Task Time Entries''' feature

Therefore to de-associate an invoice from a project the line item description would need to have the ticket or project reference it contains removed.

===Staff Messageboard===

The staff messageboard is a way for staff members to communicate between each other in a centralised system that all staff can access and see. Each message posted includes a date/time stamp, and can if needed include file attachments also. It works in much the same way as the ticket system, except this is for private staff communication only and is not visible to clients.

===Attachments===

The attachments section allows you to upload files to the project without posting a message.

All attachments, both uploaded here and as attachments in messages posted on the staff messageboard, are stored under the attachments directory, in a folder structure of /projects/xxx/ where xxx is the Project ID number, so projects can be easily accessed by FTP if needed, and cleaned up.

==Searching For & Locating Projects==

Accessible on the main navigation bar from every page within the Project Management Addon is the filter shortcuts. These allow you to filter the projects list in the following ways:

*'''Incomplete''' - View all incomplete projects
*'''My Incomplete''' - View the incomplete projects that are just assigned to you
*'''View All''' - View all projects, including completed ones
*'''Assigned To Me''' - View all projects assigned to you, including completed ones
*'''Due Within 7 Days''' - View all projects due within the week (or overdue)
*'''Closed''' - View just the completed projects

There is also a search field located at the top right of the project management nav bar on every page. This allows you to search by Project Title, or Associated Ticket Numbers.

If only 1 match is found for the search term entered you will be taken straight into the project view for the matching item, otherwise you will be displayed a list of results to choose from.

There are 2 more ways of accessing projects, from tickets and clients.

#When viewing '''any tickets associated''' with a project, you will automatically be displayed the associated projects information within the support ticket itself, showing the title, due date and status of the project(s) relating to it
#And also from the '''client summary page''', a new link will appear under the "Other Actions" menu, labelled "View Projects" allowing you to jump to the projects listing overview, filtered for all projects belonging to just that client.

==Homepage Widget==

The addon also includes a homepage widget, which you can activate for your admin role group in the normal way in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Admin Users''' or, prior to WHMCS 8.0, '''Setup > Administrator Roles'''. The widget allows you to see an overview of projects, including title, due date, days left & status, as well as recent activity, with just your assigned projects displayed by default.

==Reports==

The Reports menu item found in the top right menu bar allows you to access the reports for the project management system. The reports available currently allow you to review projects, time, and amounts invoiced, with options to filter by date range, and per staff member for analysis of work performed.

==Settings==

The settings area is where the Project Management specific options can be configured, as well as the internal access permissions for Project Management related actions.

*'''Default Hourly Rate''' - This is where you define the standard hourly rate you charge, to be used in automatic time based billing calculations, but the rate can always be overriden on a per case basis when generating invoices for time based logs
*'''Project Statuses''' - This field allows you to customise the available statuses for projects, by entering a comma separated list of values.
*'''Completed Statuses''' - This is where you define which statuses will be treated as completed - ie. not incomplete or awaiting work - by default this is the Abandoned and Completed project statuses
*'''Client Area Access''' - [[File:Pma_clientarea_overview.png|thumb]]This displays an area to clients where they can view the status and details of their projects. There are granular options controlling which areas clients can see/use. Once configured, the client area can be accessed via /index.php?m=project_management
[[File:Pma_clientarea_projectview.png|800px]]

===Permissions===

The project management permissions allow you to fine tune and control exactly what you want your different levels of staff to be able to access or do, on a per administrator role basis. A range of permisions are available to configure, allowing add, edit and delete rights to be assigned individually.

==API==
A range of API commands are available for the addon to facilitate project management from remote systems. At the time of writing they are:

*[https://developers.whmcs.com/api-reference/addprojectmessage/ AddProjectMessage]
*[https://developers.whmcs.com/api-reference/addprojecttask/ AddProjectTask]
*[https://developers.whmcs.com/api-reference/createproject/ CreateProject]
*[https://developers.whmcs.com/api-reference/deleteprojecttask/ DeleteProjectTask]
*[https://developers.whmcs.com/api-reference/endtasktimer/ EndTaskTimer]
*[https://developers.whmcs.com/api-reference/getproject/ GetProject]
*[https://developers.whmcs.com/api-reference/getprojects/ GetProjects]
*[https://developers.whmcs.com/api-reference/starttasktimer/ StartTaskTimer]
*[https://developers.whmcs.com/api-reference/updateproject UpdateProject]
*[https://developers.whmcs.com/api-reference/updateprojecttask UpdateProjectTask]

A full and current list is published at https://developers.whmcs.com/api/api-index/

==Uninstalling==
To uninstall the module and completely remove all associated data (projects, logs, tasks, task templates and attachments) please follow the steps for [[Addon_Modules_Management#Removing_An_Addon|Removing An Addon]].

File:Pma clientarea projectview.png

2021-07-11T13:00:17Z

DanR:

File:Pma clientarea overview.png

2021-07-11T12:59:18Z

DanR:

Security/Ban Control

2021-06-01T14:52:44Z

DanR: /* Managing Banned IPs */

==Banning IP Addresses==
With WHMCS, it is possible to ban an IP address from accessing your entire WHMCS system.

===Managing Banned IPs===

To view all the banned IP addresses in your system, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Banned IPs'''. You will then see the banned IP addresses, the reason for that ban, and the date and time at which the ban expires. You can delete IP addresses that have been banned in error from the ban list using the red delete icon to the right of the line.

===Adding a New Banned IP===

To add a new banned IP address, click the '''Add''' tab near the top of the page. The add options will appear. You can enter the IP address you want to ban, the reason for banning it, and the date and time at which the ban should expire. Then, click the Add Banned IP button to ban the IP address. The change will take effect immediately.

The last two blocks accept wildcards to enable you to block IP address ranges (for example, 189.123.789.* or 189.123.*.*).

===Searching Banned IPs===

To search for a banned IP address, click the Filter tab near the top of the page. You can then filter the list of banned IP addresses, by IP address or reason, to locate specific IPs you wish to un-ban.

==Banning Email Domains==

With WHMCS, you can ban email domains from signing up. This is useful if you want to block customers from signing up using free email accounts.

To enable this feature, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Banned Emails'''. You will then see a list of all the currently banned email domains and the number of times a customer has attempted to sign up using them.

To add a new banned email domain, click the Add tab at the top of the page and then enter the email domain you wish to ban. For example, "hotmail.com".

==Auto Ban Control==

By default, WHMCS blocks any user IP addresses that attempt to log in to the admin area with a valid username and incorrect password three or more times. The length of this ban, by default, is 15 minutes. This helps to prevent hackers from endlessly trying different password combinations in order to gain access to your admin area. You can alter the length of this ban by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security tab > Failed Admin Login Ban Time'''.

To '''disable IP banning''' for failed admin logins, set this value to 0. The system will never attempt to ban IP addresses and the user will be able to continue to attempt to log in endlessly. For this reason, we recommend a minimum value of at least 1.

Security/Ban Control

2021-06-01T14:52:18Z

DanR: /* Banning Email Domains */

==Banning IP Addresses==
With WHMCS, it is possible to ban an IP address from accessing your entire WHMCS system.

===Managing Banned IPs===

To view all the banned IP addresses in your system, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Other > Manage Banned IPs'''. You will then see the banned IP addresses, the reason for that ban, and the date and time at which the ban expires. You can delete IP addresses that have been banned in error from the ban list using the red delete icon to the right of the line.

===Adding a New Banned IP===

To add a new banned IP address, click the '''Add''' tab near the top of the page. The add options will appear. You can enter the IP address you want to ban, the reason for banning it, and the date and time at which the ban should expire. Then, click the Add Banned IP button to ban the IP address. The change will take effect immediately.

The last two blocks accept wildcards to enable you to block IP address ranges (for example, 189.123.789.* or 189.123.*.*).

===Searching Banned IPs===

To search for a banned IP address, click the Filter tab near the top of the page. You can then filter the list of banned IP addresses, by IP address or reason, to locate specific IPs you wish to un-ban.

==Banning Email Domains==

With WHMCS, you can ban email domains from signing up. This is useful if you want to block customers from signing up using free email accounts.

To enable this feature, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Banned Emails'''. You will then see a list of all the currently banned email domains and the number of times a customer has attempted to sign up using them.

To add a new banned email domain, click the Add tab at the top of the page and then enter the email domain you wish to ban. For example, "hotmail.com".

==Auto Ban Control==

By default, WHMCS blocks any user IP addresses that attempt to log in to the admin area with a valid username and incorrect password three or more times. The length of this ban, by default, is 15 minutes. This helps to prevent hackers from endlessly trying different password combinations in order to gain access to your admin area. You can alter the length of this ban by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security tab > Failed Admin Login Ban Time'''.

To '''disable IP banning''' for failed admin logins, set this value to 0. The system will never attempt to ban IP addresses and the user will be able to continue to attempt to log in endlessly. For this reason, we recommend a minimum value of at least 1.

OpenSRS

2021-06-01T13:26:28Z

DanR: /* Troubleshooting */

{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| regns = yes
| getepp = yes
| domainsync = yes
}}

==Activation==
To activate and begin using the OpenSRS registrar module, follow the steps below:

# Login to your WHMCS Admin Area
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
# Locate OpenSRS in the list
# Click the '''Activate''' button
# Enter your OpenSRS API credentials
# Click Save Changes to complete the process

<div class="docs-alert-warning">Before you can begin using the OpenSRS API with your account you must authorize your server IP for access to your account. See below for steps to do this.</div>

===IP Registration===
* OpenSRS's API is IP restricted.
* Therefore to use the OpenSRS API, you must first access the OpenSRS Reseller Web Interface using your OpenSRS username and password, and then access the “Add IPs for Script/API Access” link.
* The IP address that needs to be set up is the one that your WHMCS instance will be seen as from the world wide web.

===Additional Registrar Module Files Requirement===
OpenSRS requires some third party classes such as PEAR in order to work and it’s likely that the module will fail to operate entirely without these files. The files can be obtained using the following link and need to be unzipped and the contents uploaded into the /modules/registrars/opensrs/ folder.

http://www.whmcs.com/members/dl.php?type=d&id=29

Finally, domain pricing needs to be configured within WHMCS. Please see the [[Domains Management]] page for additional help on doing that.

===Private Key Generation===
To generate your private key, login to the OpenSRS Reseller Web Interface using your OpenSRS username and password and access the “Generate New Private Key” link.

===Configuring your OpenSRS Reseller Account===
Before using OpenSRS for domain registrations your OpenSRS reseller account should be configured and funded for use.

Please refer to “Setting your account defaults” and “Payments” (funding your account) sections in the “Reseller's Guide to Domain Name Registration and Management” available in the documentation section of our OpenSRS.com website (http://opensrs.com/resources).

The “Reseller's Guide to Domain Name Registration and Management” is a very important resource for managing and troubleshooting domain registrations, as is the Reseller Web Interface we provide you with your OpenSRS reseller account.

==Automatic Registration==
WHMCS allows you to setup automatic domain registration on a per extension basis enabling you to use different registrars for different TLDs to give you the flexibility to offer more extensions and always get the best value.
To enable automatic registration, please refer to [[Domain Pricing|Configuring Automatic Registration]]

==Automatic Domain Synchronization==
The OpenSRS module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.
To enable this functionality, you need to ensure you have the '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains'''. Ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.

==Troubleshooting==
'''Blank Response or Connection Error Message'''<br>
This is commonly caused by the port numbers that the OpenSRS API operates on being blocked by your server's firewall. The ports used in communication to the API are <tt>55443</tt> and <tt>55000</tt> so need to be opened for outbound connections.

'''Partially Loaded Page (Blank or Lost Formatting)'''<br>
The OpenSRS module requires some additional files in order to work. Please refer to the [[OpenSRS#Requirements|Requirements]] section above for more info.

'''Domain Already Renewed'''<br>
Seeing this error when attempting to renew a domain is caused by an invalid or incorrect Expiry Date value under the client's Domains tab. Correcting this value will enable the domain to be renewed.

'''Order xxxxxxx is not a pending, declined or cancelled order and cannot be processed'''<br>
The domain name will still be registered, but changing the "Process Immediately" setting in your OpenSRS account to "Off" will stop this error occurring.

{{modules}}

Servers

2021-06-01T13:08:48Z

DanR: /* Creating a Group */

==Adding a New Server==
<html><a href="http://www.youtube.com/watch?v=7Mg6OMqJxps&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature.</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>

===Adding a Server===

WHMCS provides a Server Setup Wizard to allow for quick and easy implementation of new servers.

To use this:

#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Servers'''.
#Click '''Add New Server'''.
#Input your required module, hostname or IP address, username, and password. Also enter your '''API Token''' if you have one.
#Click '''Test Connection'''. This will ensure that WHMCS can successfully connect to this server. After testing, the servers configuration page will appear.
*Add more information according to your requirements. For more information, see [[#Manually_Adding_a_New_Server|Manually Adding a New Server]].

[[File:ServerSetup.png|500px|center]]

===Manually Adding a New Server===

You can add new servers using our older method by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Servers''' and selecting '''Add New Server'''. On this, page, click the "Click Here" link to load the previous experience.

All fields are optional, but you should at least enter a name and IP address for each server you add. You can configure:

*Name — Enter a unique name to identify this server.
*Hostname — Enter the primary domain of the server. The system uses this to link to the server with certain modules.
*IP Address — Enter the primary IP address of the server. The system uses this to connect to the server.
*Assigned IP Addresses — Enter the other IP addresses for the server here. The system uses them in conjunction with Utilities > [[Domain_Resolver_Checker|Domain Resolver]] to check which domains in WHMCS are pointing to your server.
*Monthly Cost — Optionally enter the monthly server cost. The system uses this in reports to calculate profit.
*Datacenter/NOC — Optionally, enter the datacenter for the server. The system only uses this to help you keep records of where servers are.
*Maximum No. of Accounts — Enter the maximum number of accounts to add to the server. The system uses this to find the server's use percentage and determine when the default server is full. Once the selected server is full the default is updated so accounts can be provisioned on the next server with available space.
*Primary/Secondary/Tertiary/Quaternary Nameservers — Enter the nameservers for this server (for example, <tt>ns1.yourdomain.com</tt> and <tt>ns2.yourdomain.com</tt>). The system uses them in the welcome email and when registering domains.
*Primary/Secondary/Tertiary/Quaternary Nameserver IPs — Enter the IP addresses for each of the nameservers. The system may use this in emails.
*Server Type, Username, Access Hash and Password — Enter the root or reseller login details for your server. For cPanel & WHM servers, you can also enter a username and access hash.
* If you use the cPanel, DirectAdmin, or Plesk modules, click '''Test Connection''' to test the details you enter on this page. This ensures that the connection and login details are valid before saving.
*Server Status URL — Enter the URL for the status folder. See the Status Monitoring section below.

If this is the only server for the selected module, click on the name and ensure it results in an asterisk (*) next to it. This ensures it is the default. The system will use it when any other non-specific configuration (server groups) doesn't apply.

===Syncing Accounts to WHMCS===

After adding a new server, it's possible that you already have some accounts on your server that you want to import in to WHMCS.

In WHMCS 7.8, we introduced a new Server Sync Tool, which allows for quick and easy imports from any server that supports it.

==Status Monitoring==

<html><a href="http://www.youtube.com/watch?v=0w7YcalU078&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature.</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>

Status monitoring allows you to view the load and uptime for each of your Linux-based servers from within the WHMCS client or admin area.

To enable this, you must upload the status folder in the WHMCS zip file download to each of your servers. Then, enter the URL to that folder in the server setup '''Server Status URL''' field. You can also leave the field blank, which disables monitoring for that server.

WHMCS disables PHP Info output by default for security reasons. To enable it, uncomment the line <tt>#phpinfo();</tt> (remove the #) within the <tt>index.php</tt> file.

===Customising the Ports===
The ports that the server status page checks can be customised by editing the <tt>/templates/*your active template*/serverstatus.tpl</tt> template file. You will need to modify two parts of the template:

Near line 44:

<source lang="php">
<th class="text-center">HTTP</th>
<th class="text-center">FTP</th>
<th class="text-center">POP3</th>
</source>

These are the column headings. You can change them to describe the ports you will be monitoring.

Near line 73:

<source lang="php">
checkPort({$num}, 80);
checkPort({$num}, 21);
checkPort({$num}, 110);
</source>

Change the numbers (80, 21, and 110 by default) to change, add, or remove ports to check.

==Deleting a Server==

To delete a server, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' and click the red X icon on the same row as the server you wish to delete. If the deletion succeeds, a message will appear confirming whether you want to delete it. Click OK to remove it.

You cannot delete a server with assigned accounts. This includes terminated and cancelled accounts.

==Status==
Status is not the same as Status Monitoring, above. Servers can have one of two statuses: enabled and disabled, denoted by a green check or grey X respectively. During normal operations, a server would be active. However, if you will no longer use an old server and disconnect it, change the status to disabled.

Disabling a server removes it from the daily usage statistics update (which could fail if a disconnected server was active) and moves it to the bottom of all server menus.

To change the status of a server, navigate to Setup > Servers and click the status icon to toggle to the other status. For example, click the green checkmark icon on an active server to deactivate it.

==Server Groups==

Server groups allow you to configure servers into sets in which you can assign products automatically, based on your requirements and provisioning settings. For example, you may want shared accounts on certain servers and resellers on others, with accounts being distributed evenly between all the servers you have. Server groups make this possible.

===Creating a Group===

To create a group:

#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers''' .
#Click '''Create New Group''' under the '''Options''' heading.
#Enter a name for your group.
#Choose whether to assign new orders to the least-full server ''(based on the percentage of accounts available within the '''Maximum No. of Account''' value)'' '''or''' fill the default server until it reaches the limit for accounts, and then move to the next server.
#Select the servers you want to assign to this group in the box on the left.
#Click '''Add''' to move them to the box on the right, which contains the servers for this group.<br />'''NOTE:''' If you only assign one server to a group, select the ''Add to the least full server'' fill type.
#Click '''Save Changes''' to complete the process.

===Assigning Products to a Group===

To assign a product to a group:
#Find the product in the '''Products & Services''' configuration area.
#Click the edit icon for it.
#Click the '''Module Settings''' tab.
#Use the '''Server Group''' menu to select the server group. By default, this is None, which assigns the product to the default server for that module.

===Editing/Deleting a Group===

You will see the same interface and options when you edit a group as when you create one.
*You can add or remove servers from a group at any time.
*You can set the maximum number of accounts to assign to a server when editing the setup of the individual server.

System Utilities

2021-05-30T12:46:05Z

DanR:

==Link Tracking==

The link or ad tracker tool allows you to track your advertising campaigns. You can set up the various links you want to use and then, instead of linking directly, you use the tracking link WHMCS gives you. It then tracks the number of clickthroughs you get and, ultimately, conversions, using a cookie and providing an easy way to analyse how successful different promotions and links are.

How does it all work? When the click passes through WHMCS the system increments the count by one, but also sets a cookie on the user's computer to say they used that link. The system only stores the latest link they used, so a conversion never counts more than once. The cookie lasts for three months, so if a user then places an order with that cookie still present on their computer, the conversion count for that link increases.

===How to add a tracked URL===

To do this:

#Begin by going to '''Utilities > Link Tracking'''.
#Click "Add a New Link".
#Enter a name to identify the link and the URL to forward the user to.
#Click Add Link. The system will add the link for tracking.

===How to get the URL to use for tracking===

To do this:

#After adding the URL for tracking, click the edit icon next to it.
#The Link/URL field on the edit page will show the link you need to use (for example, http://demo.whmcs.com/link.php?id=1)
#Link to that URL from wherever you run the promotion.

===How to monitor the links===

To check on your links, go to '''Utilities > Link Tracking'''. WHMCS lists the links you've set up for tracking, the number of clicks each has had, and the number of conversions (orders).

==Calendar==

[[File:calendar.png|thumb|The Calendar]]

The calendar lists all pending, active and suspended products, addons, domains, and to-do items on the dates they are due. When you use this in conjunction with our [http://www.whmcs.com/addons/project-management/ Project Management Addon] it will also display the due date of projects. It allows you to easily see, at a glance, upcoming payments, domain expiration, and projects for each date.

You can also add your own events and tasks to the calendar. These can be either one time events or regular recurring events (for example, server payments or admin tasks) and can span multiple days. To add an event, click the date you want to add it on and fill in the popup. To edit an event, click on it on the scheduled day and a popup will appear to allow adjustments.

<div class="docs-alert-info">
<span class="title">Timezones</span><br />
When entering a start/finish time use the '''UTC''' timezone. The calendar will then convert this to your WHMCS installations' timezone for display purposes.
</div>

If the calendar becomes busy, you can use the Show/Hide filters to reduce the amount of displayed data. Detailed weekly and daily listings are available by clicking the appropriate button in the top right corner of the calendar.

A [[Widgets|widget]], available on the admin homepage, displays today's events, and allows you to see the scheduled events for any day in the current month and even add new events directly from the admin summary.

==To-Do List==

The to do list allows you to add tasks that need to be finished, the dates they are due for completion, and the assigned admin. To-Do Items can also have an unlimited length description for storing additional information about the task. Access the To-Do list via '''Utilities > To-Do List'''. The admin homepage widget displays due items.

Enable or disable automated domain-related To-Do entry creation in the [[Domains_Tab|General Settings]].

==Activity Logs==

WHMCS logs all activity, admin logins, gateway communications, sent and received email communications, and domain lookups. This allows you to monitor and track all the activity taking place inside your WHMCS system. You can find the logs in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' in the left-side menu (or in the '''Utilities''' menu in WHMCS 7.x and earlier). They include:

* [[Activity_Logs|Activity Log]]
* Admin Log
* Module Log
* Email Message Log
* Ticket Mail Import Log
* WHOIS Lookup History Log

<div class="docs-alert-warning"><p><strong>Note:</strong> The '''Email Message Log''' will log all emails that WHMCS sends to clients, with the exception of the "Automated Password Reset", "Client Email Address Verification", and "Password Reset Validation" emails.</p></div>

Over time, log records in your WHMCS System will accumulate. As the number of records grows, so will your database, and you may begin noticing a reduction in performance. If these start affecting performance, WHMCS allows you to empty them at any time. To empty your logs, perform the following actions:

# Log in to your WHMCS Admin Area.
# Navigate to '''Utilities > System Cleanup'''. You will see options to empty the Gateway, and WHOIS Lookup logs.
# Click the '''Go''' button next to the log you would like to empty. A confirmation message will then appear, confirming that the system emptied the log.

Additionally, from the same Cleanup Operations page, you can prune the Client Activity Logs so that the system only maintains entries after a specified date. To do this, enter in your desired date, and click on the Delete button. Again, a confirmation message will then appear to confirm that the system pruned the log.

==Database Backups==

WHMCS stores its data in your database, so is very important. It is therefore recommended that you take regular backups of it. There are two built-in solutions for automated database backups using the daily cron. One is email and the other is an FTP backup to a remote server. You can find configuration instructions on the [[Backups|Backups Page]].

==System Cleanup==
With constant daily operations, the log files in WHMCS can become quite large. The Cleanup Operations page allows you to prune logs to reduce the size of the database and reduce disk space. You can find this at '''Utilities > System > System Cleanup'''.

<div class="docs-alert-warning">
<span class="title">Note:</span><br />
Only delete information you're certain is no longer necessary (for example, for audit purposes). WHMCS Technical Support may be unable to assist in some matters if you have removed the relevant logs.
</div>

===Empty Gateway Log===
This clears out the '''Billing > Gateway Log''' communication between you and your payment gateways. It does not affect transactions and invoices.

===Empty Whois Lookup Log===
Clears out the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > WHOIS Lookup Log''' ('''Utilities > Logs > WHOIS Lookup Log''' in WHMCS 7.x and earlier) of the domains that clients have checked.

===Empty Ticket Mail Import Log===
This clears out the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' ('''Utilities > Logs > Ticket Mail Import Log''' in WHMCS 7.x and earlier) of the record of emails you piped into the WHMCS ticket system. It does not affect tickets themselves.

===Empty Template Cache===
WHMCS caches templates into static files to reduce the loading time of each page. In order for template changes to take effect, it is necessary to clear the cached files.

In order to do this, remove all existing files from the templates_c folder, which you can do quickly and easily using this option. Make sure the <tt>/templates_c</tt> directory is writeable so that WHMCS is able to delete the cache files and generate new ones.

===Prune Client Activity Logs===
Select a date to remove any client entries in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) before that date. Non-client-related entries will remain.

===Prune Saved Emails===
Select a date to remove any emails in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' ('''Utilities > Logs > Ticket Mail Import Log''' in WHMCS 7.x and earlier) before that date.

=== Prune Old Attachments===
Select a date to remove any support ticket attachments from closed tickets which are also older than the date selected. The system will also delete them from the /attachments directory.

==PHP Info==
The '''PHP Info''' page outputs a variety of information about the current configuration of PHP and the server. This includes information such as PHP options and extensions, the PHP version, server information, and <tt>php.ini</tt> configuration settings currently in use for the WHMCS Admin Area.

These details come directly from the <tt>phpinfo()</tt> PHP function and are not edited or changed by WHMCS.

==Troubleshooting System Utilities==
===Database Backup Fails/Timesout===
The most common reason for database backups to fail is simply that it has grown too large and the PHP process takes too long or uses too much memory and is killed before it can complete the backup process.

You can find further details on this in the [[Backups#Limitations|Backups Limitations]] section.

===System Cleanup page fails to load===
If the System Cleanup page fails to load entirely, this can be caused by a missing or unreadable 'attachments' directory.

You should ensure the attachments directory path configured in Storage Settings exists and is readable. It is also important to ensure the attachments directory path is absolute and not relative to avoid timeout issues on the System Cleanup page.

You can find further details on changing the Storage Settings path in our [[Moving_Storage_Locations]] guide.

Email Sending Issues

2021-05-18T15:27:54Z

DanR:

Sometimes, the system may not send mail using the expected methods. The problem is usually a misconfiguration.

==Emails Not Sending==

===General Emails===

If the system isn't sending general emails, such as client sign-up or order confirmations, take the following steps to ensure a correct setup.

First, check these points:

#Check whether you have disabled the email template in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Email Templates'''.
#Check whether custom action hooks that could prevent email from sending exist in the <tt>/includes/hooks</tt> and <tt>/modules/addons</tt> directories.
#Check whether you can send the emails manually.

If the above steps don't resolve the issue:

#Check whether any email appears at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Email Message Log''' ('''Utilities > Logs > Email Message Log''' in WHMCS 7.x and earlier).
#Check whether an error occurs at the time of email sending under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > [[Activity_Logs|Activity Log]]''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier).

'''No Error in Activity Log:'''<br/>

If a message exists in the '''Email Message Log''' and there are no errors in the '''Activity Log''', the message likely left WHMCS without any errors from your mail server. Therefore, the problem is one of email delivery and not a WHMCS software issue. Contact your mail server administrator to investigate.

There are many '''Email Templates''' that the '''Email Message Log''' doesn't record, in order to protect the sensitive data they contain. These are:

* Automated Password Reset.
* Client Email Address Verification.
* Password Reset Validation.

In addition to this, there a number of '''Email Templates''' that the system won't CC or BCC at the template level. These are:

* Password Reset Validation.
* Password Reset Confirmation.
* Automated Password Reset.

===Product Welcome Email===

Problems with the sending of the welcome emails are typically due to an issue with account creation. For more information, see [[Auto Setup Issues]].

===Support Ticket Notifications===

If the system isn't sending support ticket notification emails to your staff (for example, new support tickets or new client replies) take the following steps to ensure it is set up properly:

First, check these points:

#Check whether you have selected the '''Enable Ticket Notifications''' options under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Manage Admins > Administrator Users > Edit'''.
#Check whether you have selected the '''Support Emails''' option under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Manage Admins > Administrator Roles > Edit'''.
#Check whether the admin ticket notification emails are disabled under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Email Templates'''.

If the above steps don't resolve the issue:

#Check whether you have selected the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Support > Disable Reply Email Logging''' option. After deselecting it, attempt to replicate the issue.
#Check whether there's an error at the time of email sending under '''System Settings (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier).

'''No Error in Activity Log:'''

If there is no error in the '''Activity Log''' at the time of email sending, this indicates that the email left WHMCS without any errors from your mail server. Therefore, the problem is one of email delivery and not a WHMCS software issue. Contact your mail server administrator to investigate.

==Emails Flagged as Spam==

There are multiple reasons why systems may deliver emails from a WHMCS installation to a spam folder or reject them. Usually, this is due to the server configuration. WHMCS email templates should not trigger any standard spam rules.

First, check these points:

* Check whether you can use SMTP rather than PHP mail under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Mail'''. Many email providers block PHP mailer scripts as "unverified mail".

* Verify that the email address you are sending "from" actually exists on your server, and whether it can send and receive mail normally.

* Check your mail server's IP address to verify it is not in any blacklists at http://mxtoolbox.com.

* Contact your web hosting or mail server provider for investigation into your IP reputation. They will be able to contact other email providers on your behalf.

* If you suspect that the wording of an email may be triggering a filter, try customizing you email templates so they do not match every other WHMCS installation's emails.

* Verify that your domain has an accurate and strict SPF record setup, as well as a correct PTR record.

==Troubleshooting==

Sometimes, the error output in the '''Activity Log''' when sending of emails via SMTP fails can lack verbosity. Alternatively, the underlying cause may be different from the message that the system ultimately displays. Adding the following line to the <tt>configuration.php</tt> file will output a lot of debugging information when you send mail manually. This requires that the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Mail > Mail Type''' is '''SMTP''':

<source lang="php">$smtp_debug = true;</source>

After sending an email manually, the system will display the interaction between your server and the email server, for debugging purposes. After this process, be sure to revert the change to the <tt>configuration.php</tt> file.

===Common Errors===

The following are errors which may commonly appear in the activity log when attempting to send an email, resulting in email sending failure.

====Could not connect to SMTP host====

There are several possible reasons for this error:

# The SMTP settings in the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Mail''' tab are incorrect. Check with your system administrator to verify that you have entered the correct SMTP host, port, username, and password, and that you have selected the appropriate SSL type for use with your mail server.
#The mail server is blocking connections from your WHMCS installation's server.
#Your WHMCS installation's server is blocking outgoing connections to the mail server.
#The system is using an inappropriate SMTP port and the '''SSL Type''' option is selected. For example, selecting TLS and the port number 256 would cause this error. For a list of the most common port assignments, see '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > [http://docs.whmcs.com/Mail_Tab#SMTP_Port Mail > SMTP Port]'''.
#The mail server is advertising that TLS connections are available, but when a secure connection is attempted it fails due to a certificate validation error. The appropriate solution would be to ensure that you have installed a validated certificate on the mail server. As a workaround, you can set the '''SMTPAutoTLS''' setting to ''false'' in ''/vendor/phpmailer/phpmailer/class.phpmailer.php''. For more information, see [https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting#opportunistic-tls the PHPMailer troubleshooting documentation].

====Message body empty====

A "Message Body Empty" error indicates that a syntax error occurred, preventing the email from sending. Review '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) at the time of sending for entries beginning "Smarty Error". This will provide more information on the invalid syntax, which you will need to correct before attempting to send the email again.

====The following recipients failed====

This error is often due to a misaddressed email. Check the following locations to ensure a valid email address:

*The client's '''Profile''' tab.
*The client's '''Contacts''' tab.
*'''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Mail > BCC Messages''' text box.
*'''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Email Templates > Edit > Copy To''' text box.
*All administrator users under '''System Settings (<i class="fa fa-wrench" aria-hidden="true"></i>) > Manage Admins > Administrator Users.

Check for blank spaces or punctuation before or after an email address in all the above locations.

====Email Send Aborted By Hook====

An "Email Send Aborted By Hook" error indicates that a custom hook has prevented the email from sending.

Take the following actions to begin troubleshooting this error:

* Enable the [[Other_Tab#Hooks_Debug_Mode|Hooks Debug Mode]] option.
* Replicate the error again.
* Disable the Hooks Debug Mode option.
* Review the [[Activity_Logs|Activity Log]].
* Locate the "Email Send Aborted By Hook" error in the log.

After locating the error look over the adjacent entries for a series of three lines that look similar to the following:

<source>
Hooks Debug: Hook File Loaded: /path/to/the/hook_file.php
Hooks Debug: Hook Defined for Point: EmailPreSend - Priority: 1 - Function Name: (anonymous function)
Hooks Debug: Attempting to load hook file: /path/to/the/hook_file.php
</source>

The file in the "Hook File Loaded" and "Attempting to load hook file" entries is the hook responsible for the "Email Send Aborted By Hook" error.

Contact the developer of that hook file for more information.

====Email sending aborted.====

An "Email sending aborted." error indicates that an unknown issue has prevented the email from sending.

This error commonly occurs when there is a configuration issue with the file paths in the [[Storage_Settings|Storage Settings]] section of the installation.

To remedy this, ensure that you have updated the storage locations. For more information, see the [[Moving_Storage_Locations|Moving Storage Locations]] guide.

====Email sending aborted by configuration====

In WHMCS 8.1, this error indicates that you have set '''Disable Email Sending''' to '''ON''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' in the '''Mail''' tab. The system creates a log entry each time that you enable or disable this setting. For more information, see [[Disabling Outgoing Mail]].

We recommend that you only enable this setting when you are testing updates or customizations on a development installation or while troubleshooting.

{{troubleshooting}}

==Emails Flagged as Spam==

There are multiple reasons why systems may deliver emails from a WHMCS installation to a spam folder or reject them. Usually, this is due to the server configuration. WHMCS email templates should not trigger any standard spam rules.

First, check these points:

* If you use '''PHP Mail''', check whether you can use a different '''Mail Provider''' under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Mail'''. Many email providers block PHP mailer scripts as "unverified mail".

* Verify that the email address you are sending <tt>from</tt> actually exists on your server, and whether it can send and receive mail normally.

* Check your mail server's IP address to verify that it's not in any blacklists at [http://mxtoolbox.com the mxtoolbox website].

* Contact your web hosting or mail server provider for investigation into your IP reputation. They will be able to contact other email providers on your behalf.

* If you suspect that the wording of an email may be triggering a filter, try customizing you email templates so they do not match every other WHMCS installation's emails.

* Verify that your domain has an accurate and strict SPF record setup, as well as a correct PTR record.

==Troubleshooting==

Sometimes, the '''Activity Log''' error output lacks verbosity when sending emails via SMTP fails. Alternatively, the underlying cause may be different from the message that the system ultimately displays.

===For version 8.0 and later===
In WHMCS v8.0+ follow these steps if your Mail Provider is SMTP:
# Navigate to '''Configuration > System Settings > General Setting > Mail Tab''' and click the '''Configure Mail Provider''' button
# Tick the ''SMTP Debug'' checkbox
# Click Test Configuration
# View the debugging output in the '''Configuration > System Logs'''.

===For version 7.x and earlier===
In WHMCS 7 and earlier, adding the following line to the <tt>configuration.php</tt> file will output a large amount of debugging information when you send mail manually. This requires that '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Mail > Mail Type''' is ''SMTP'':

<source lang="php">$smtp_debug = true;</source>

After sending an email manually, the system will display the interaction between your server and the email server, for debugging purposes. After this process, be sure to revert the change to the <tt>configuration.php</tt> file.

Crons

2021-05-17T16:34:16Z

DanR: /* Legacy Cron File Locations */

<div class="docs-alert-info">Need to troubleshoot the cron? Checkout our [https://help.whmcs.com/m/automation/l/683269-advanced-cron-troubleshooting| Advanced Cron Troubleshooting Guide.]</div>

Cron tasks must be created to automate tasks within WHMCS.

Cron is the name given to a system daemon used to execute tasks (in the background) at designated times. WHMCS has a number of files that are required to be run on a periodic basis in this way. All these files are located in the ''crons'' directory.

==Setting up the Cron Tasks==

===System Cron===

The system cron automates tasks within WHMCS. It should be configured as follows:

<table class="table table-bordered">
<tr><th>Version</th><th>System Cron Frequency</th></tr>
<tr><td>WHMCS 6.3.x and earlier</td><td>Once per day</td></tr>
<tr><td>WHMCS 7.0 and later</td><td>Every 5 minutes, or as frequently as your web hosting provider allows (minimum once per hour)</td></tr>
</table>

'''Sample Cron Command'''
<source lang="cli">
*/5 * * * * php -q /home/username/crons/cron.php
</source>

You can find a copy&paste ready command with the path specific for your setup by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' or, prior to WHMCS 8.0, '''Setup > Automation Settings''' within your WHMCS installation and copying the command from the "Cron Command" field using the copy button on the field.

[[File:ConfigAutoCronCommand.png]]

<div class="docs-alert-success">Most web hosting control panels provide a simple user interface for creating cron jobs. We have guides and documentation for most popular control panels [[Cron Configuration|available here]].</div>

===Domain Sync Cron===
<div class="docs-alert-warning"><i class="fa fa-question-circle"></i> This cron is only required in 7.5 and earlier. It should be removed in 7.6 and above</div>

This cron task monitors for incoming domain transfers and synchronises expiry date changes made directly at a registrar. We recommend running this no more frequently than once every couple of days. More information is available at [[Domains_Tab#Domain_Sync_Enabled]] and [[Domain Synchronisation]]

'''Sample Cron Command'''
<source lang="cli">
0 3 */2 * * php -q /home/username/crons/domainsync.php
</source>

The above example will run every 2 days at 3am.

===POP Email Import Cron===

This cron task is only required if you wish to import emails to the support queue via the POP3 protocol (we recommend using [[Email Piping]] wherever possible). If required, this should be configured to run every 5 minutes.

'''Sample Cron Command'''
<source lang="cli">
*/5 * * * * php -q /home/username/crons/pop.php
</source>

The above example will run the POP3 email import task every 5 minutes.

===Change of Daily Cron Hour===

The desired time of day for the daily automated actions to be executed can be changed via the "Time of Day" setting detailed in our [[Automation_Settings]] documentation.

WHMCS uses the PHP "now()" timestamp when the cron.php script is run to determine the current time. The calculation as to whether it is currently the "Time of Day" hour is based upon the value output by the PHP configuration applied the cron.php execution.

We recommend executing the cron every 5 minutes. WHMCS will never perform a particular task more frequently than [[Crons#Task_Options_for_skip_.26_do Crons - Task Options for skip|documented here]]. Hence the cron.php file can be triggered every 5 minutes without any duplication occurring.

If you do want to execute cron.php only at the hour specified in the "Time of Day" setting, ensure the timezone WHMCS is operating under matches that of the server's command line. More information on this can be found in the [[Changing_Timezone]] documentation.

<div class="docs-alert-warning">The cron must execute the cron.php file within the hour set in the automation settings of WHMCS otherwise the daily automated tasks won't be performed.</div>

==Secure The Crons Directory==

The crons folder may be moved to any place above or below the docroot.

<div class="docs-alert-warning">We recommend moving it to a non-public directory above your web root to prevent web based access.</div>

More information on moving the crons folder can be found in the [[Custom Crons Directory|Custom Crons Directory article]].

==System Cron==

The system cron (''crons/cron.php'') automates tasks within WHMCS. This script can be executed with a number of optional values. This allows very specific control of the tasks performed and the output generated by the script. For most installations, a simple entry that invokes the System Cron script (''crons/cron.php'') is all that is needed.

===Input===

The system cron script has the following argument input structure:

<source lang="cli">
cron.php [<command> [options]]
</source>

The script also provides backwards capability for input options available prior to WHMCS v7.1:

<source lang="cli">
cron.php [legacy_option_flags]
</source>

Mixing of legacy option flags with the new argument options is not supported and will not work.

===Commands===

The cron.php command line script has 3 essential commands:

* '''all''' - attempt to perform all due automation tasks. If no input is provided, this command is assumed.
* '''skip''' - perform all tasks, just like the '''all''' command, but exclude those specified in the input
* '''do''' - only perform, unconditionally, the task(s) specified in the input options

There are two supporting commands:

* '''help''' - provides usage help & options for the command specified
* '''list''' - list all possible commands

===Options===

Each command has its own set of options which can be view with the ''help <command>'' input syntax

====Additional Options====

* -F, --force
** Force the execution of tasks, regardless of "due" or "in progress" state
* -v, -vv, -vvv
** Verbosity of command line output
* --email-report=[1|0]
** Force send a digest report of work performed during execution. During the normal "daily" run, this is set to an implicit value of "1". In all other cases, the implicit value is "0"
* -V, --version
** Output the WHMCS version and exits
* --no-ansi
** Strip any non-printing command line markup (used for color output)
* -h, --help
** Print help for a command; same as the '''help''' command itself

===Output===

The System Cron will not generate any success console output by default. Use the verbosity options if you require progressive completion information while attending the manual execution of System Cron invocation.

The System Cron will, by default, generate a Digest Email Report when performing the "Daily" group of tasks. This report can be forcibly generated for any particular invocation with the ''--email-report=1'' report. The Digest Email Report will only contain information related to that execution and will not contain aggregate information from prior executions. Please visit the [[Automation Status]] page in your Admin area to get an overview of daily aggregated work.

===Tasks===

All routines of system cron (''cron.php'') are tasks. Most tasks are daily, and should only be run once a day. Some tasks benefit from running multiple times a day, such as ticket escalations or checking for WHMCS Updates. Other tasks should only run once a month, such as calculating overage usage and generating the respective invoices.

====Task Options for '''skip''' and '''do'''====

<div id="Option_Flags" style="visibility: hidden"></div>
When performing a '''skip''' or '''do''' command, you can itemize which tasks are excluded or included respectively.
Below is a table that itemizes these task options, as well as their normal frequency.

{| class="table"
|-
! scope="col" style="width:30%"| Option
! scope="col" style="width:20%"| Legacy Option
! scope="col" style="width:40%"| Description
! scope="col" style="width:10%"| Frequency
|-
| --CurrencyUpdateExchangeRates
| updaterates
| Update Currency Exchange Rates
| Daily
|-
| --CurrencyUpdateProductPricing
| updatepricing
| Update Product Prices for Current Rates
| Daily
|-
| --CreateInvoices
| invoices
| Generate Invoices
| Daily
|-
| --AddLateFees
| latefees
| Apply Late Fees
| Daily
|-
| --ProcessCreditCardPayments
| ccprocessing
| Process Credit Card Charges
| Daily
|-
| --InvoiceReminders
| invoicereminders
| Generate daily reminders for unpaid and overdue invoice
| Daily
|-
| --DomainRenewalNotices
| domainrenewalnotices
| Processing Domain Renewal Notices
| Daily
|-
| --DomainStatusSync
| n/a
| Processing Domain Status Syncing for Active domains. Batches of 50. Known as DomainExpirySync in v7.7 and earlier
| As soon as every hour
|-
| --DomainTransferSync
| n/a
| Processing Domain Transfer Syncing for Pending Transfer domains
| As soon as every hour
|-
| --CancellationRequests
| cancelrequests
| Process Cancellation Requests
| Daily
|-
| --AutoSuspensions
| suspensions
| Processing Overdue Suspensions
| Daily
|-
| --AutoTerminations
| terminations
| Process Overdue Terminations
| Daily
|-
| --FixedTermTerminations
| fixedtermterminations
| Process Fixed Term Terminations
| Daily
|-
| --CloseInactiveTickets
| closetickets
| Auto Close Inactive Tickets
| Daily
|-
| --AutoPruneTicketAttachments
| n/a
| Auto Remove Inactive Ticket Attachments. Batches of 1000
| Hourly
|-
| --AffiliateCommissions
| affcommissions
| Process Delayed Affiliate Commissions
| Daily
|-
| --AffiliateReports
| affreports
| Send Monthly Affiliate Reports
| Monthly
|-
| --EmailMarketer
| emailmarketing
| Process Email Marketer Rules
| Daily
|-
| --CreditCardExpiryNotices
| ccexpirynotices
| Sending Credit Card Expiry Reminders
| Monthly
|-
| --SslSync
| n/a
| Check validity of SSL Certificates on services and domains. Batches of 100. v7.7+
| Daily
|-
| --UpdateServerUsage
| usagestats
| Updating Disk & Bandwidth Usage Stats
| Daily
|-
| --OverageBilling
| overagesbilling
| Process Overage Billing Charges and Generate Invoices
| Monthly
|-
| --AutoClientStatusSync
| clientstatussync
| Synchronise Client Status
| Daily
|-
| --UpdateDomainExpiryStatus
| n/a
| Update Domain Expiry Status for domains with a past Expiry Date
| Daily
|-
| --TicketEscalations
| escalations
| Process and escalate tickets per any Escalation Rules
| As soon as every 3 minutes
|-
| --CheckForWhmcsUpdate
| n/a
| Check for WHMCS Software Updates
| As soon as every 8 hours
|-
| --DatabaseBackup
| backups
| Create a database backup and deliver via FTP or email
| Daily
|-
| --DataRetentionPruning
| n/a
| Process data retention pruning operation. v7.5+
| Daily
|-
| --ServerUsageCount
| n/a
| Auto Update Server Usage Count. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. v7.8+
| Hourly
|-
| --ServerRemoteMetaData
| n/a
| Auto Update Server Meta Data. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. v7.8+
| Hourly
|-
| --TenantUsageMetrics
| n/a
| Auto Update Service Usage Data. Displayed when viewing Service within Client Area. v7.9+
| Twice-daily
|-
| --EmailCampaigns
| n/a
| Update the status of Email Campaigns and schedule emails. Batches of 25
| As soon as every 5 minutes
|-
| --ProcessEmailQueue
| n/a
| Process scheduled emails within Email Campaigns. Batches of 25
| As soon as every 5 minutes
|-
|}

====Types====

There are two types of tasks:
* '''Application''': Advances state of client data, such as orders, billing, and provisioning
* '''System''': Provides software related functionality, such as generating backups or performing database normalization.
** The "DatabaseBackup" task is the only task option of the '''System''' type which can be included/excluded from execution. All other '''System''' type task options will be performed explicitly as required by WHMCS and thus do not have option flags.

====Tasks & --force Option====

The "--force" option does exactly that...it will force execute ''any'' application tasks (respective of the command ['''all''', '''skip''', '''do''']) regardless if the task is suppose to run once a day, a month, or at a time other than now.

* The '''all''' command with the "--force" flag will execute all application tasks, as if each one were due exactly now.
* The '''skip''' command with the "--force" will first exclude the specified tasks (i.e., the ones provided as task option flags) and then operate on all other tasks as if each were due exactly now, similar to the '''all''' command.
* The '''do''' command is designed to only run the tasks specified (i.e., the ones provided as task option flags) and to run them immediately, thus the "--force" option is always implied and is not a valid option.
* The "--force" option has no effect on '''System''' type tasks (except "DatabaseBackup")
* The "--force" option has no effect on whether the Daily Digest Email Report is sent, that is controlled via the --email-report option.

====Advanced Task Scheduling====

In some environments or use-cases, having fine-grained control of one or more tasks is important. This is possible through a combination of multiple '''do''' and '''skip''' crontab entries.
Tasks performed as part of a '''do''' command will not have their internal scheduling tracking modified. This is to ensure the integrity of a normal invocation of the System Cron.
If you want a particular task to only execute on a particular schedule, create a '''do''' command for that task and alter your main System Cron invocation to '''skip''' that task (all other non-itemized tasks will be performed on the WHMCS schedule in this '''skip''').
Likewise, if you never wish to have a particular task executed, alter your System Cron entry to be a '''skip''' command with the option for that particular task.

===Hook Points===

The System Cron has six hook events:

* PreCronJob
** Fires only during the daily cron run
** Is invoked before any tasks are executed
** Registered hooks receive no parameter arguments
* PreAutomationTask
** Is invoked before each Application task
** Registered hooks receive one parameter argument:
*** The task object that is about to be executed, which adheres to WHMCS\Scheduling\Task\TaskInterface
*** The return value of this hook is not inspected. However, if an exception is thrown, the task will not be executed, be marked as incomplete, and iteration to the next task will commence
* PostAutomationTask
** Is invoked after each Application task
** Registered hooks receive two parameter arguments:
*** The task object that was just executed, which adheres to WHMCS\Scheduling\Task\TaskInterface
*** The boolean state if the task executed without throwing an Exception
*** The return value of this hook is not inspected. Any Exception thrown will be discarded
* DailyCronJobEmail
** Fires during the daily cron run or when --email-report=1 is specified
** Is invoked after all Application tasks are executed, immediate prior to the DailyCronJob hook
** If a registered hook returns true, the digest email report will not be sent
** Registered hooks receive no parameter arguments
* DailyCronJob
** Fires only during the daily cron run
** Is invoked after all Application tasks are executed, immediate proceeding the DailyCronJobEmail hook
** Register hooks receive no parameter arguments
* AfterCronJob
** Fires each time cron is invoked
** Is invoked after all Application & System tasks are executed, just prior to script termination
** Registered hooks receive no parameter arguments

===Example Crontab Entries===

Below are examples that demonstrate the flexibility of the System Cron input options and how you could craft your crontab entry. For most WHMCS installation, you should just have one entry (Ex. 1).
If you wish to disable certain tasks entirely, consider looking at the related functionality's documentation first to understand how your may be able optimize your WHMCS settings from the administration area and potential avoid unnecessary crontab entries.

Ex 1. Standard System Cron entry:

<source lang="cli">
*/5 * * * * php -q /path/to/cron.php
</source>

Ex 2. Explicit entry to perform all scheduled task if they are due (will behave the same as Ex. 1):

<source lang="cli">
*/5 * * * * php -q /path/to/cron.php all
</source>

Ex 3. Always skip sending domain renewal notices, but perform all other tasks as normal if they are due:

<source lang="cli">
*/5 * * * * php -q /path/to/cron.php skip --DomainRenewalNotices
</source>

Ex 4. Always skip ticket escalations and auto suspensions. Process ticket escalations Monday-Friday during business hours, at the top of the hour, and auto suspension Monday-Friday at the start of business:

<source lang="cli">
*/5 * * * * php -q /path/to/cron.php skip --TicketEscalations --AutoSuspensions
0 9,10,11,12,13,14,15,16 * * 1-5 php -q /path/to/cron.php do --TicketEscalations
0 9 * * 1-5 php -q /path/to/cron.php do --AutoSuspensions
</source>

Ex 5. In some hosting environments, direct crontab entries are not permitted. The System Cron can be invoked through an HTTP request (provided the script is accessible within the docroot)
The follow demonstrates performing all tasks except DomainRenewalNotices and TicketEscalations

<source lang="cli">
GET http://www.yourdomain.com/admin/cron.php?command=skip&options=DomainRenewalNotices,TicketEscalations
</source>

==Legacy Cron File Locations==

Prior to WHMCS version 6, the automated task files were located across various directories. From WHMCS version 6 onwards all cron files are now located in the '''crons''' directory by default.

To aide in the transition process to their new locations, version 6.0 of WHMCS includes proxy files in the old locations that will allow all existing configured cron and piping commands to continue operating without any changes post-upgrade to 6.0.

However, we encourage you to update your cron and piping commands to use the new locations prior to updating to Version 8.0.

The old locations are deprecated as of Version 6.0, and the proxy functionality is removed as of version 8.0. The proxy files and their proxy locations are:

* <tt>/admin/cron.php</tt>
* <tt>/pipe/pipe.php</tt>
* <tt>/pipe/pop.php</tt>

<div class="docs-alert-info">If you do not require these proxy files, you can safely remove them from your installation.</div>

==Troubleshooting==
If you do not receive the daily cron digest email, see a warning on the System Health Status overview page, or on the Automation Status page then this indicates the cron not running. Troubleshooting and resolving this is a matter of priority, as the daily automation tasks are an integral part of WHMCS.

The most common issues and how to resolve them can be found on the [[Cron Job Issues]] page.

Detailed steps on how to debug the cron execution can be found in our [https://help.whmcs.com/m/automation/l/683269-advanced-cron-troubleshooting| Advanced Cron Troubleshooting] Guide.

Further useful troubleshooting documentation can be found [https://help.whmcs.com/m/automation/c/195647 here.]

Cron Configuration

2021-05-17T16:33:13Z

DanR: /* Setting Up Cron Jobs */

Cron tasks must be created to automate tasks within WHMCS.

Cron is the name given to a system daemon used to execute tasks (in the background) at designated times. WHMCS has a number of files that are required to be run on a periodic basis in this way. All these files are located in the crons directory.

A single cron named the '''System Cron''' automates all core functions of the system including invoicing, reminders, suspensions and other daily automation tasks.

In WHMCS 6.3.x and earlier, the system cron should be configured to run no more than '''once per day'''. In WHMCS 7.0 and later, the system cron should be configured to run every 5 minutes, or as frequently as your web hosting provider will allow.

==Setting Up Cron Jobs==
The tutorials & screenshots below demonstrate how to configure the WHMCS cron on the most common hosting control panels.

The system will attempt to determine the PHP path to use for your cron command. Prior to WHMCS 8.0, this can be seen at '''Setup > Automation Settings'''. For WHMCS 8.0 and above, please visit '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' and click on the first badge.

[[File:Cron-configuration-badge.png|border]]

===cPanel===

<html><a href="https://www.youtube.com/watch?v=caZWco1R2kk&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>

Click on the '''Cron Job''' icon in cPanel, select the ''Once Per Five Minutes'' option from the Common Settings dropdown menu. Then paste the cron command into the Command field.

[[File:cPCron.png|border]]

Alternatively click the Advanced (Unix Style) button and use the following:

{| class="wikitable" border="1" style="text-align:center"
|+cPanel Cron
! Option
!
! Minute
! Hour
! Day
! Month
! Weekday
!
! Command
|-
| a)
|
| */5
| *
| *
| *
| *
|
| php -q /path/to/home/public_html/whmcspath/crons/cron.php
|-
| b)
|
| */5
| *
| *
| *
| *
|
| wget -O <nowiki>http://www.yourdomain.com/whmcspath/crons/cron.php</nowiki> >/dev/null
|-
| c)
|
| */5
| *
| *
| *
| *
|
| GET <nowiki>http://www.yourdomain.com/whmcspath/crons/cron.php</nowiki>
|}

===Direct Admin===

The command for Direct Admin is generally the same as cPanel, however, you need to reference the full path to the php binary.

This can be /usr/bin/php, /usr/bin/home/php or /usr/local/bin/php but this is dependent on the server setup and you should check with your Server Administrator for the full path to the php binary.

An example command to run is:
{| class="wikitable" border="1" style="text-align:center"
!Command
|-
| /usr/bin/php -q /home/demo_user/domains/testdomain.com/public_html/whmcspath/crons/cron.php
|-
| /usr/local/bin/php -q /home/demo_user/domains/testdomain.com/public_html/whmcspath/crons/cron.php
|-
| wget -O /dev/null <nowiki>http://domain.tld/path/to/cron.php</nowiki>
|-
| GET <nowiki>http://www.yourdomain.com/whmcspath/crons/cron.php</nowiki>
|}

[[File:DACron.png|border]]

===DotNetPanel===

Navigate to the hosting space in which WHMCS is installed and click '''Scheduled Tasks''' from the Hosting Space Menu, then click ''Add Scheduled Task''.

From the Task Type dropdown menu select the ''Check Web Site Availability'' option and enter the URL of the cron.php file into the ''URL'' field.
Use the ''Schedule'' options to run this task Daily and finally ensure it's active and running.

[[Image:Wsp_cron_config.png]]

===Windows Server===

Depending on your server setup, you can run the cron directly from the php executable. If this is not possible, you would need to use the server browser to run the cron

An example command to run is:
{| class="wikitable" border="1" style="text-align:center"
!Command
|-
|C:\php\php.exe -q "C:\inetpub\wwwroot\whmcs7\admin\cron.php"
|-
|"c:\program files\internet explorer\iexplore.php" "<nowiki>http://www.yourdomain.com/whmcspath/cron.php</nowiki>"
|}

You should then set the task to run at a certain time every day. The time is up to you.

[[Image:windows_cron.jpg]]

===Plesk===

Navigate to the Domain where WHMCS is hosted, and click on the Schedule Tasks option in the top-right menu.

From the Schedule Tasks page, perform the following actions:

# Click on the Add Task button
# Set "Task type" to the "Run PHP script" option
# Input the path to your cron.php script into the "Script path" field
# Select PHP 5.6 or later for the "Use PHP version" option
# Select the "Cron style" option from the "Run" drop-down menu
# Input "*/5 * * * *" into the "Cron style" field
# Click on the "OK" button

{| class="wikitable" border="1" style="text-align:center"
!Example "Script path" for Linux
|-
| /path/to/whmcs/crons/cron.php
|}
[[File:PleskLinCron.png|border]]

{| class="wikitable" border="1" style="text-align:center"
!Example "Script path" for Windows
|-
| /path/to/whmcs/crons/cron.php
|}
[[File:PleskWinCron.png|border]]

===Helm===

[[Image:helm3cron.jpg]]

===InterWorx===

[[Image:interworx.jpg]]

===Linux with no control panel===

Use the command to open the crontab editor:

<tt>$ crontab -e </tt>

On a new line enter:

<tt>*/5 * * * * php -q /path/to/home/public_html/whmcspath/crons/cron.php</tt>

Type <tt>:wq</tt> and press the Enter key to save the changes to the crontab and close the editor.

Domain Categories

2021-05-17T16:31:18Z

DanR: /* How do I customise the domain categories? */

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.10 and above.</div>

==What are domain categories?==

Domain Categories are used in the client area to group domain TLDs into categories such as "Popular", "Shopping", or "Real Estate" and makes it easier for clients to navigate and find their ideal domain extension.

==How do I customise the domain categories?==

The domain categories shipped with WHMCS by default can be found in <tt>/resources/domains/dist.categories.json</tt>. This file should '''not''' be edited.

To add or edit domain category definitions, begin by creating a custom categories.json file located at <tt>/resources/domains/categories.json</tt>.

Inside it, define the domain categories you wish to use. This file will remain in place when updating WHMCS.

TLDs can appear in multiple categories; for example, a UK-based company might include .UK and .CO.UK TLDs in the "Popular" category as well as a "Local Geographic" category.

===Adding a TLD/Category===

Inside your custom <tt>/resources/domains/categories.json</tt> file, add a section that resembles this example:

<source lang="yaml">

{
"Awesome Domains": [
".whmcs",
".whmcstest"
]
}

</source>

This example adds a domain category called "Awesome Domains" with the ".whmcs" and ".whmcstest" domain TLDs.

A domain category definition is simply the category name, with an array of the domain TLDs which should be included in that category.

===Removing a TLD from a default TLD Category===

Inside your custom <tt>/resources/domains/categories.json</tt> file, add a section that resembles this example:

<source lang="yaml">

{
"REMOVE": {
"Popular" : [
".com", ".net"
]
},

</source>

This example removes the .com and .net TLD from showing in the default Popular category.

Clients:Summary Tab

2021-05-06T14:30:29Z

DanR: /* Due Date Changes Prorata Calculation */

{{Client Management}}

The Summary tab is first displayed when viewing a client's Profile. It's accessed via the '''Clients > View/Search Clients''' page. It contains an overview of the client's details, some quick billing and service statistics, quick links to many common management actions as well as a list of all their services, domains and addons. This page describes each option available under the Summary tab.
[[File:client_summary.png|thumb|Client Summary Tab]]

==Summary Actions==

The very first thing in the top-left corner of the page is the client's unique ID number and their name. To the right of this are the summary actions, these allow for quick management of billing-related settings. By clicking the red "No" or green "Yes" text you can instantly toggle the status of the available options:

*Exempt From Tax - If Yes the client will not be charged tax even if they meet a tax rule
*Auto CC Processing - If Yes the client's credit card stored in WHMCS will automatically be charged on invoice due dates
*Send Overdue Reminders - If Yes the client will receive overdue reminder emails when their invoices become overdue.
* Apply Late Fees - If Yes the client will be charged a late fee when their invoices become overdue. Late fees must be activated and configured in [[Invoice_Tab#Late_Fee_Type|General Settings]] and [[Automation_Settings#Add_Late_Fee_Days|Automation Settings]]

==Clients Information==

This section displays the client's contact information; name, address and phone number. In addition there are the following links:

===Reset & Send Password===

Clicking this link will instantly generate a new client area password for the client and email it to them.

Clients can also request a password reset themselves by clicking the the '''Forgotten Password''' link on the login form to begin the reset process:

*After entering their email address, if a security question answer is specified they will be prompted to provide the answer, then an email is sent containing a confirmation link to ensure they are actually the one who requested the reset. The reset link is valid for 2 hours from the time of request
**If no security question answer is set, the email will be sent immediately upon entering a valid email address.
*When they click the link in the email, clients will be taken to the password reset validation page where a new password can be specified. They can then login immediately using the new password. If the client didn't request the reset they are advised to simply ignore the email and not click the link.

===Login as Owner===

View the client area exactly as the account's owner would see it. You can also perform actions on their behalf, like placing orders or opening tickets. When you finish, click '''Return to Admin Area''' in the top-right corner.

<div class="docs-alert-warning">
<span class="title">WHMCS 7.10 and earlier</span><br />
Prior to WHMCS 8.0, this was '''Login as Client'''.
</div>

==Contacts/Sub-Accounts==

If a client has created Contacts or Sub-Accounts, they will be listed here. Click the contact's name to edit the record. This is explained in more detail on the [[Clients:Contacts_Tab|Contact Tab]] page.

===Add Contact===

Click here to create a new contact or sub-account for this client.

==Pay Methods==

Displays an overview of the client's current registered Pay Methods within WHMCS.

===Adding a Pay Method===

You can add a new Pay Method by selecting "Add Credit Card" or "Add Bank Account". These links will only be available when an appropriate module has been activated.

===Viewing Full Card Number===

For Pay Methods where the client Credit Card number is stored locally (Local Encryption):

Click the respective Pay Method to open details about it.
Next to the masked credit card number, click the Padlock icon.
Finally, enter your Credit Card Encryption hash (Found in configuration.php) to reveal the full number.
For Tokenisation gateways, viewing the full card number is not possible as the details are not stored in WHMCS. The respective token and last 4 digits of the card number are however available for view.

===Removing Card Details===

Click the respective Pay Method you wish to delete. A modal will appear displaying details about this Pay Method. Click the red "Delete" button to remove these details from the Client Account and WHMCS.

==Invoices/Billing==

In this section quick invoice and billing statistics are displayed; the number of invoices in each status along with the total value of each in brackets. The Total Income statistic shows the total of all transactions paid by the client, whilst the Credit Balance shows the current amount of credit available to the client to spend.

===Create Invoice===

This link creates a [[Invoicing#Creating_Custom_Invoices|custom invoice]]. Clicking the link immediately creates an empty invoice to which line items can be added as desired. This link will not trigger the sending of an email to the client.

===Create Add Funds Invoice===

You can create invoices in this way to allow a client to deposit funds to their account, or to charge a specific amount from a clients credit card. A popup will appear allowing the amount of credit to be specified. [[Add_Funds|More Information]].

===Generate Due Invoices===

Click here to generate any invoices due for the client's services, billable items, domains or addons. Useful if one of the aforementioned items has been modified and a new invoices needs to be generated without the need to run the entire automation cron job. A popup will appear asking whether you wish to send the invoice notification email.

===Add Billable Item===

This link will take you directly to the Add Billable Item interface. Read more about [[Billable_Items|Billable Items here]].

===Manage Credits===

Displays a popup displaying the client's credit history; how credits were earned and spent. Credit can also be manually added and removed using the appropriate buttons. You also have the option to delete entries if you wish and they will then be deducted from the credit balance.

Read more about [[Transactions#Managing_Credit|Managing Credit]] here.

==Create New Quote==

This link will take you directly to the Quote creation interface. Read more about [[Quotes|Quotes here]].

==Other Information==

In this section, miscellaneous information is displayed; the client's status, their client group, signup date, length of time since signup and the IP address, hostname + time of their last login.

==Products/Services==

In this section the numbers all the services, domains quotes, support tickets and affiliate signups for this client are displayed. The active service count is displayed first, with the total - including services in suspended, terminated and cancelled statuses - in brackets.

===View Orders===

Click this link to see a list of all orders placed by this client. Read more about [[Order_Management|Order Management]] here.

===Add New Order===

This link will take you to the admin order form. This allows orders to be placed on behalf of the client, and for products and promotional codes to be used in combinations not possible on the public order form.

==Files==

The files section in a client's summary allows you to upload files specific to that customer.

* This can be used for documents, agreements or other downloads specific to the individual
* Files can be set as Admin Only to only be viewed by admins, otherwise they show on the Client Area Homepage for the client to be able to download
* Files are uploaded to the /attachments directory and can be added and managed from the Client Summary page in the admin area

==Recent Emails==

Displayed here are the last five emails sent to the client by WHMCS. A longer email history can be viewed under the Emails tab.

==Other Actions==

Within this section are a number of miscellaneous links which perform a variety of tasks.

===View Account Statement===

Provides a statement of account for this client accounts between a date range. Displays Type (add funds, transaction, invoice), date, description, credits, debits and a running balance

===Open New Support Ticket===

This link enables you to open a support ticket under the client's account. Useful for initiating correspondence with the client and keeping a full record of the conversation.

===View all Support Tickets===

Click here to see see a list of all support tickets assigned to the client in the departments to which your administrator account is assigned. If the client had tickets in departments of which you are not a member, they would not be displayed here.

===Activate as Affiliate===

If enabled clients can join the affiliate program from within the client area. Staff members can also add the client to the affiliate program by clicking this link.

===View Affiliate Details===

Once the client has been activated as an affiliate, the 'View Affiliate Details' link will be displayed in its place. Click it to see the client's referrals, commissions pending and paid, as well as your payments to them. Read more about [[Affiliates|Affiliates here]].

==Merge Client Accounts==

Merging clients combines 2 separate client accounts in WHMCS into one. This merges everything relating to the 2 separate entities into one including but not limited to products, invoices, transactions, tickets, etc...
[[File:Merge clients.png|thumb|Merge Clients Popup]]
#Begin by locating the first of the clients you want to merge
#Click the '''Merge Client Accounts''' link on the Client Summary page
#In the popup that appears, you will be asked to enter the Client ID. If you don't know the client's ID the Search field can be used to search by name, company or email address. Click the client's name and the ID will be filled in.
#After specifying the second client, you can choose which profile you want to keep, so either merge into the first client, or second client - this determines which profile data is kept - ie. name, email address, etc...
#Once happy, click the submit button to complete the process

===Close Clients Account===

Closing a client's account will prevent them from being able to login to the client area. This link will also change the status of unpaid invoices to cancelled, and all services to cancelled. It will not run any module termination functions.

===Delete Clients Account===

To remove a client, click this link. If you also want to remove any associated users that aren't associated with other client accounts, check the checkbox. Then, confirm the deletion. The client will be removed and you will be returned to the '''Clients''' list.

Deleting a client removes everything related to that client from the WHMCS database, with the exception of transactions. This is because transactions are considered income that isn't being refunded when the client is removed. If you want to also remove the client's transactions, do this in the '''Transactions''' tab before you delete the client.

==Send Email==

Use this dropdown to send any 'General' type email templates to clients, or select the "New Message" option to compose a new email from scratch. Product and Domain type emails can be sent using the dedicated dropdowns under the corresponding tabs.

==Admin Notes==

Here staff can enter private notes about the client to be displayed to whoever views this Summary tab. Separate notes sections are available available under the Products/Services , Domains and Notes tab.

==Filtering Products==
[[File:filtering_products.png|thumb|Product Filtering]]
There may be situations where it's desirable to filter the client's product/services list to only display items in certain statuses. For example if a client has lots of old cancelled services you may wish to only display the active, pending and fraud products (hiding the cancelled ones).

To achieve this click the '''Status Filter''' button under the Admin Notes section within the client's Summary tab. A prompt will appear allowing you to select which statuses should be displayed.

The button will turn green so you can tell at-a-glance when the filter is applied.

'''Note:''' The filter selected here will apply across all clients and will be remembered until the web browser is closed.

==Services, Addon, Domains, Quotes==

The Services, Addons, Domains and Quotes lists will often take up the majority of the client's Summary tab. They provide a comprehensive list of all the client's services with you alongside key information for each (such as price, signup date, status and next due date).

The lists are ordered based upon the item's ID number. Click the ID number of the Edit icon to see the full details of the item from where you can make changes.

The Current Quotes section displays quotes with a Valid Until Date up to and included today's date. When this is passed they can be viewed under the [[Clients:Quotes_Tab|Quotes tab]]

==Mass Updating Services/Addons/Domains==

[[File:Bulk_actions_panel.png|thumb|Mass Update Panel]]
The mass update options enable you to make changes to more than one of a given clients products, add-ons and domains at a time. This is useful for making bulk changes to a clients products and services.

Supported fields you can change in a mass update include:
* Status
* Payment Method
* Override Auto-Suspend
* Pricing
* Billing Cycle
* Next Due Date

You can also perform all the core module commands - Create, Suspend, Unsuspend, Terminate, Change Package and Change Password.

To use the feature, follow the steps below:

# Tick the checkboxes next to the Products/Services, Addons and/or Domains you want to update,
# Scroll to the Bulk Actions panel located at the bottom of the Client Summary page
# Click the Advanced Options link to reveal all the options
# Make your changes and selections (leaving blank any fields you don't wish to change)
# Click '''Apply''' to complete the changes

===Due Date Changes Prorata Calculation===

When making a change to the '''Next Due Date''' of products and services, you also have the option to bill for the days between the current next due date and the target next due date you set. This is useful for synchronising multiple different products to a single common due date each billing cycle.

To do this, follow the steps below:

# Tick the checkboxes next to the '''Products/Services''', '''Addons''' and/or '''Domains''' you want to update.
# Scroll to the '''Bulk Actions''' panel located at the bottom of the '''Client Summary''' page.
# Click the '''Advanced Options''' link to reveal the additional options.
# Enter the desired '''Next Due Date'''.
# Tick the '''Create Prorata Invoice''' checkbox.
# Click '''Apply''' to complete the changes.

The page will reload with confirmation of the changes and that an invoice has been generated.

<div class="docs-alert-info"><span class="title">Note:</span><br> An invoice will only be generated if the differences for all products result in an amount being due. If the total differences result in a credit then no invoice will be generated and no credit will be issued. If you wish to add a credit for the difference, we have details on [[Credit/Prefunding#Adding_Credit_to_a_Client|adding a credit manually here.]] </div>

==Invoice Selected Items==

There may be times where a client asks for you to invoice them for the next renewal date early. To do this in WHMCS,

#Begin by navigating to the '''Clients Summary''' page for the client you want to invoice
#Now tick the boxes of the '''Products/Services/Addons''' and/or '''Domains''' you want to generate an invoice for
#To complete, click the '''Invoice Selected Items''' button to create the invoice(s) for them
#Multiple invoices may be created if the due dates and payment methods differ as invoicing rules are obeyed as normal

'''Note:''' You won't be able to generate another invoice if an invoice has already been made for the next due date.

'''Note:''' If the Separate Invoices option is enabled in the client's Profile or Client Group, when selecting multiple items here with the same Next Due Date, it will not apply and all possible items will be invoiced together. If you need to split them up, you can edit the resulting invoices and use the Split Invoice function.

==Delete Selected Items==

This button can be used to delete multiple items en-mass. Tick the checkboxes next to the services, domains, addons or quotes you wish to remove from WHMCS and click the Delete Selected Items button.

This will remove the record form WHMCS, but will not trigger any module commands (ie. a hosting account associated with a service will stay on the server).

Common Promotions

2021-05-06T14:26:11Z

DanR: /* Notes */

__TOC__

This page contains some of the promotions commonly used in the hosting industry and how to achieve them in WHMCS.

==Free Domain Name==

You are able to offer free domains with your packages when purchased with certain payment terms - for example you might want to offer a free domain when a package is purchased annually:

#Begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
#Next, click the edit icon next to the product or service that you want to offer a free domain with
#Now select the Free Domain tab from the tabs at the top of the page
#Tick the box labelled Free Domain to offer a free domain with this package
#Then select the payment terms (or billing cycles) that you want to offer the free domain with - press Ctrl when clicking the options to select more than one
#Now you need to select which TLDs the free domain offer applies to. This allows you to exclude high priced TLDs such as .tv Again, use Ctrl when clicking the options to select more than one
#Now click the Save Changes button

That's it! Your package will now not charge the user for the domain when ordered with the billing cycle specified, this will be reflected on the checkout page.

===Notes===
* The Free Domain promo relies on the '''Next Due Date''' and the '''Payment Gateway''' of the product and domain name being the same. Therefore it is important this is maintained. If the next due dates were changed, the domain would be renewed automatically at no cost to the client. For this reason we recommend disabling the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings > Domain Sync Settings > Sync Next Due Date''' or, prior to WHMCS 8.0, '''Setup > Automation Settings > Domain Sync Settings > Sync Next Due Date''' option.
* Free domains are registered for 1 year at a time. If a biennial or triennial product is ordered, the domain will renew automatically after the first and/or second year as appropriate.
* If a client cancels the hosting package then the domain name will automatically revert to your regular pricing.
* Domain renewal reminder emails aren't sent for domains with a 0.00 price to avoid confusion.
* Please ensure that the number of days box for the '''Domain Settings''' setting located under the '''Advanced Settings''' link at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings > Invoice Generation > Advanced Settings''' or, prior to WHMCS 8.0, '''Setup > Automation Settings > Invoice Generation > Advanced Settings''' is left blank.
* Please ensure the '''Separate Invoices''' option on the client's Profile tab is unticked.

==Free Trial==

[[Products_and_Services#Pricing_Tab|Free Trial functionality]] is built into WHMCS which will automatically terminate an account x days after ordering and send an email to the client:

#Edit a product at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
#Click '''Pricing'''.
#Enter the length of your free trial in the '''Auto Terminate/Fixed Term''' field (in days)
#Select the email to be sent to clients when their free trial period ends and the account is terminated using the '''Termination Email''' dropdown<div class="docs-alert-success">A new Product-type email template can be created via Setup > Email Templates which will appear in the list</div>

This logic can then be used in conjunction with a promo code to offer customers their first month free whilst still taking their payment details for your security checks:

#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Promotions''' or, prior to WHMCS 8.0, '''Setup > Payments > Promotions'''.
#Click "Add New"
#Enter the promotion code "freetrial"
#Change the value to 100.00
#Select Monthly from the drop down menu
#Set the remaining settings as you would any regular promotion (maximum uses, expiry date, applicable packages)
#Click the Create Promotion button

Now you can either have your customers enter the promotion code "freetrial" or use one of the following links to apply the free trial automatically:

http://example.com/whmcs/cart.php?promocode=freetrial

<div class="docs-alert-info">If you do not wish to collect a client's payment details for a free trial, set the ''Payment Type'' value to "Free" under the product's [[Products_and_Services#Pricing_Tab|Pricing tab]] instead.</div>

Clients:Summary Tab

2021-05-06T14:07:02Z

DanR: /* Due Date Changes Prorata Calculation */

{{Client Management}}

The Summary tab is first displayed when viewing a client's Profile. It's accessed via the '''Clients > View/Search Clients''' page. It contains an overview of the client's details, some quick billing and service statistics, quick links to many common management actions as well as a list of all their services, domains and addons. This page describes each option available under the Summary tab.
[[File:client_summary.png|thumb|Client Summary Tab]]

==Summary Actions==

The very first thing in the top-left corner of the page is the client's unique ID number and their name. To the right of this are the summary actions, these allow for quick management of billing-related settings. By clicking the red "No" or green "Yes" text you can instantly toggle the status of the available options:

*Exempt From Tax - If Yes the client will not be charged tax even if they meet a tax rule
*Auto CC Processing - If Yes the client's credit card stored in WHMCS will automatically be charged on invoice due dates
*Send Overdue Reminders - If Yes the client will receive overdue reminder emails when their invoices become overdue.
* Apply Late Fees - If Yes the client will be charged a late fee when their invoices become overdue. Late fees must be activated and configured in [[Invoice_Tab#Late_Fee_Type|General Settings]] and [[Automation_Settings#Add_Late_Fee_Days|Automation Settings]]

==Clients Information==

This section displays the client's contact information; name, address and phone number. In addition there are the following links:

===Reset & Send Password===

Clicking this link will instantly generate a new client area password for the client and email it to them.

Clients can also request a password reset themselves by clicking the the '''Forgotten Password''' link on the login form to begin the reset process:

*After entering their email address, if a security question answer is specified they will be prompted to provide the answer, then an email is sent containing a confirmation link to ensure they are actually the one who requested the reset. The reset link is valid for 2 hours from the time of request
**If no security question answer is set, the email will be sent immediately upon entering a valid email address.
*When they click the link in the email, clients will be taken to the password reset validation page where a new password can be specified. They can then login immediately using the new password. If the client didn't request the reset they are advised to simply ignore the email and not click the link.

===Login as Owner===

View the client area exactly as the account's owner would see it. You can also perform actions on their behalf, like placing orders or opening tickets. When you finish, click '''Return to Admin Area''' in the top-right corner.

<div class="docs-alert-warning">
<span class="title">WHMCS 7.10 and earlier</span><br />
Prior to WHMCS 8.0, this was '''Login as Client'''.
</div>

==Contacts/Sub-Accounts==

If a client has created Contacts or Sub-Accounts, they will be listed here. Click the contact's name to edit the record. This is explained in more detail on the [[Clients:Contacts_Tab|Contact Tab]] page.

===Add Contact===

Click here to create a new contact or sub-account for this client.

==Pay Methods==

Displays an overview of the client's current registered Pay Methods within WHMCS.

===Adding a Pay Method===

You can add a new Pay Method by selecting "Add Credit Card" or "Add Bank Account". These links will only be available when an appropriate module has been activated.

===Viewing Full Card Number===

For Pay Methods where the client Credit Card number is stored locally (Local Encryption):

Click the respective Pay Method to open details about it.
Next to the masked credit card number, click the Padlock icon.
Finally, enter your Credit Card Encryption hash (Found in configuration.php) to reveal the full number.
For Tokenisation gateways, viewing the full card number is not possible as the details are not stored in WHMCS. The respective token and last 4 digits of the card number are however available for view.

===Removing Card Details===

Click the respective Pay Method you wish to delete. A modal will appear displaying details about this Pay Method. Click the red "Delete" button to remove these details from the Client Account and WHMCS.

==Invoices/Billing==

In this section quick invoice and billing statistics are displayed; the number of invoices in each status along with the total value of each in brackets. The Total Income statistic shows the total of all transactions paid by the client, whilst the Credit Balance shows the current amount of credit available to the client to spend.

===Create Invoice===

This link creates a [[Invoicing#Creating_Custom_Invoices|custom invoice]]. Clicking the link immediately creates an empty invoice to which line items can be added as desired. This link will not trigger the sending of an email to the client.

===Create Add Funds Invoice===

You can create invoices in this way to allow a client to deposit funds to their account, or to charge a specific amount from a clients credit card. A popup will appear allowing the amount of credit to be specified. [[Add_Funds|More Information]].

===Generate Due Invoices===

Click here to generate any invoices due for the client's services, billable items, domains or addons. Useful if one of the aforementioned items has been modified and a new invoices needs to be generated without the need to run the entire automation cron job. A popup will appear asking whether you wish to send the invoice notification email.

===Add Billable Item===

This link will take you directly to the Add Billable Item interface. Read more about [[Billable_Items|Billable Items here]].

===Manage Credits===

Displays a popup displaying the client's credit history; how credits were earned and spent. Credit can also be manually added and removed using the appropriate buttons. You also have the option to delete entries if you wish and they will then be deducted from the credit balance.

Read more about [[Transactions#Managing_Credit|Managing Credit]] here.

==Create New Quote==

This link will take you directly to the Quote creation interface. Read more about [[Quotes|Quotes here]].

==Other Information==

In this section, miscellaneous information is displayed; the client's status, their client group, signup date, length of time since signup and the IP address, hostname + time of their last login.

==Products/Services==

In this section the numbers all the services, domains quotes, support tickets and affiliate signups for this client are displayed. The active service count is displayed first, with the total - including services in suspended, terminated and cancelled statuses - in brackets.

===View Orders===

Click this link to see a list of all orders placed by this client. Read more about [[Order_Management|Order Management]] here.

===Add New Order===

This link will take you to the admin order form. This allows orders to be placed on behalf of the client, and for products and promotional codes to be used in combinations not possible on the public order form.

==Files==

The files section in a client's summary allows you to upload files specific to that customer.

* This can be used for documents, agreements or other downloads specific to the individual
* Files can be set as Admin Only to only be viewed by admins, otherwise they show on the Client Area Homepage for the client to be able to download
* Files are uploaded to the /attachments directory and can be added and managed from the Client Summary page in the admin area

==Recent Emails==

Displayed here are the last five emails sent to the client by WHMCS. A longer email history can be viewed under the Emails tab.

==Other Actions==

Within this section are a number of miscellaneous links which perform a variety of tasks.

===View Account Statement===

Provides a statement of account for this client accounts between a date range. Displays Type (add funds, transaction, invoice), date, description, credits, debits and a running balance

===Open New Support Ticket===

This link enables you to open a support ticket under the client's account. Useful for initiating correspondence with the client and keeping a full record of the conversation.

===View all Support Tickets===

Click here to see see a list of all support tickets assigned to the client in the departments to which your administrator account is assigned. If the client had tickets in departments of which you are not a member, they would not be displayed here.

===Activate as Affiliate===

If enabled clients can join the affiliate program from within the client area. Staff members can also add the client to the affiliate program by clicking this link.

===View Affiliate Details===

Once the client has been activated as an affiliate, the 'View Affiliate Details' link will be displayed in its place. Click it to see the client's referrals, commissions pending and paid, as well as your payments to them. Read more about [[Affiliates|Affiliates here]].

==Merge Client Accounts==

Merging clients combines 2 separate client accounts in WHMCS into one. This merges everything relating to the 2 separate entities into one including but not limited to products, invoices, transactions, tickets, etc...
[[File:Merge clients.png|thumb|Merge Clients Popup]]
#Begin by locating the first of the clients you want to merge
#Click the '''Merge Client Accounts''' link on the Client Summary page
#In the popup that appears, you will be asked to enter the Client ID. If you don't know the client's ID the Search field can be used to search by name, company or email address. Click the client's name and the ID will be filled in.
#After specifying the second client, you can choose which profile you want to keep, so either merge into the first client, or second client - this determines which profile data is kept - ie. name, email address, etc...
#Once happy, click the submit button to complete the process

===Close Clients Account===

Closing a client's account will prevent them from being able to login to the client area. This link will also change the status of unpaid invoices to cancelled, and all services to cancelled. It will not run any module termination functions.

===Delete Clients Account===

To remove a client, click this link. If you also want to remove any associated users that aren't associated with other client accounts, check the checkbox. Then, confirm the deletion. The client will be removed and you will be returned to the '''Clients''' list.

Deleting a client removes everything related to that client from the WHMCS database, with the exception of transactions. This is because transactions are considered income that isn't being refunded when the client is removed. If you want to also remove the client's transactions, do this in the '''Transactions''' tab before you delete the client.

==Send Email==

Use this dropdown to send any 'General' type email templates to clients, or select the "New Message" option to compose a new email from scratch. Product and Domain type emails can be sent using the dedicated dropdowns under the corresponding tabs.

==Admin Notes==

Here staff can enter private notes about the client to be displayed to whoever views this Summary tab. Separate notes sections are available available under the Products/Services , Domains and Notes tab.

==Filtering Products==
[[File:filtering_products.png|thumb|Product Filtering]]
There may be situations where it's desirable to filter the client's product/services list to only display items in certain statuses. For example if a client has lots of old cancelled services you may wish to only display the active, pending and fraud products (hiding the cancelled ones).

To achieve this click the '''Status Filter''' button under the Admin Notes section within the client's Summary tab. A prompt will appear allowing you to select which statuses should be displayed.

The button will turn green so you can tell at-a-glance when the filter is applied.

'''Note:''' The filter selected here will apply across all clients and will be remembered until the web browser is closed.

==Services, Addon, Domains, Quotes==

The Services, Addons, Domains and Quotes lists will often take up the majority of the client's Summary tab. They provide a comprehensive list of all the client's services with you alongside key information for each (such as price, signup date, status and next due date).

The lists are ordered based upon the item's ID number. Click the ID number of the Edit icon to see the full details of the item from where you can make changes.

The Current Quotes section displays quotes with a Valid Until Date up to and included today's date. When this is passed they can be viewed under the [[Clients:Quotes_Tab|Quotes tab]]

==Mass Updating Services/Addons/Domains==

[[File:Bulk_actions_panel.png|thumb|Mass Update Panel]]
The mass update options enable you to make changes to more than one of a given clients products, add-ons and domains at a time. This is useful for making bulk changes to a clients products and services.

Supported fields you can change in a mass update include:
* Status
* Payment Method
* Override Auto-Suspend
* Pricing
* Billing Cycle
* Next Due Date

You can also perform all the core module commands - Create, Suspend, Unsuspend, Terminate, Change Package and Change Password.

To use the feature, follow the steps below:

# Tick the checkboxes next to the Products/Services, Addons and/or Domains you want to update,
# Scroll to the Bulk Actions panel located at the bottom of the Client Summary page
# Click the Advanced Options link to reveal all the options
# Make your changes and selections (leaving blank any fields you don't wish to change)
# Click '''Apply''' to complete the changes

===Due Date Changes Prorata Calculation===

When making a change to the '''Next Due Date''' of products and services, you also have the option to bill for the days between the current next due date and the target next due date you set. This is useful for synchronising multiple different products to a single common due date each billing cycle.

To do this, follow the steps below:

# Tick the checkboxes next to the '''Products/Services''', '''Addons''' and/or '''Domains''' you want to update.
# Scroll to the '''Bulk Actions''' panel located at the bottom of the '''Client Summary''' page.
# Click the '''Advanced Options''' link to reveal the additional options.
# Enter the desired '''Next Due Date'''.
# Tick the "Create Prorata Invoice" checkbox.
# Click '''Apply''' to complete the changes.

The page will reload with confirmation of the changes and that an invoice has been generated.

<div class="docs-alert-info"><span class="title">Note:</span><br> An invoice will only be generated if the differences for all products result in an amount being due. If the total differences result in a credit then no invoice will be generated and no credit will be issued. If you wish to add a credit for the difference, we have details on [[Credit/Prefunding#Adding_Credit_to_a_Client|adding a credit manually here.]] </div>

==Invoice Selected Items==

There may be times where a client asks for you to invoice them for the next renewal date early. To do this in WHMCS,

#Begin by navigating to the '''Clients Summary''' page for the client you want to invoice
#Now tick the boxes of the '''Products/Services/Addons''' and/or '''Domains''' you want to generate an invoice for
#To complete, click the '''Invoice Selected Items''' button to create the invoice(s) for them
#Multiple invoices may be created if the due dates and payment methods differ as invoicing rules are obeyed as normal

'''Note:''' You won't be able to generate another invoice if an invoice has already been made for the next due date.

'''Note:''' If the Separate Invoices option is enabled in the client's Profile or Client Group, when selecting multiple items here with the same Next Due Date, it will not apply and all possible items will be invoiced together. If you need to split them up, you can edit the resulting invoices and use the Split Invoice function.

==Delete Selected Items==

This button can be used to delete multiple items en-mass. Tick the checkboxes next to the services, domains, addons or quotes you wish to remove from WHMCS and click the Delete Selected Items button.

This will remove the record form WHMCS, but will not trigger any module commands (ie. a hosting account associated with a service will stay on the server).

Common Promotions

2021-05-06T13:58:55Z

DanR: /* Notes */

__TOC__

This page contains some of the promotions commonly used in the hosting industry and how to achieve them in WHMCS.

==Free Domain Name==

You are able to offer free domains with your packages when purchased with certain payment terms - for example you might want to offer a free domain when a package is purchased annually:

#Begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
#Next, click the edit icon next to the product or service that you want to offer a free domain with
#Now select the Free Domain tab from the tabs at the top of the page
#Tick the box labelled Free Domain to offer a free domain with this package
#Then select the payment terms (or billing cycles) that you want to offer the free domain with - press Ctrl when clicking the options to select more than one
#Now you need to select which TLDs the free domain offer applies to. This allows you to exclude high priced TLDs such as .tv Again, use Ctrl when clicking the options to select more than one
#Now click the Save Changes button

That's it! Your package will now not charge the user for the domain when ordered with the billing cycle specified, this will be reflected on the checkout page.

===Notes===
* The Free Domain promo relies on the Next Due Date and the Payment Gateway of the product and domain name being the same, therefore it is important this is maintained. If the Next Due Dates were changed the domain would be renewed automatically at no cost to the client, for this reason we recommend disabling the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings > Domain Sync Settings > Sync Next Due Date''' or, prior to WHMCS 8.0, '''Setup > Automation Settings > Domain Sync Settings > Sync Next Due Date''' option.
* Free domains are registered for 1 year at a time. If a biennial or triennial product is ordered the domain will renew automatically after the first and/or second year as appropriate.
* If a client cancels the hosting package then the domain name will automatically revert to your regular pricing.
* Domain renew reminder emails aren't sent for domains with a 0.00 price to avoid confusion.
* Please ensure that the number of days box for the '''Domain Settings''' setting located under the '''Advanced Settings''' link at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings > Invoice Generation > Advanced Settings''' or, prior to WHMCS 8.0, '''Setup > Automation Settings > Invoice Generation > Advanced Settings''' is left blank.
* Please ensure the '''Separate Invoices''' option on the client's Profile tab is unticked.

==Free Trial==

[[Products_and_Services#Pricing_Tab|Free Trial functionality]] is built into WHMCS which will automatically terminate an account x days after ordering and send an email to the client:

#Edit a product at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
#Click '''Pricing'''.
#Enter the length of your free trial in the '''Auto Terminate/Fixed Term''' field (in days)
#Select the email to be sent to clients when their free trial period ends and the account is terminated using the '''Termination Email''' dropdown<div class="docs-alert-success">A new Product-type email template can be created via Setup > Email Templates which will appear in the list</div>

This logic can then be used in conjunction with a promo code to offer customers their first month free whilst still taking their payment details for your security checks:

#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Promotions''' or, prior to WHMCS 8.0, '''Setup > Payments > Promotions'''.
#Click "Add New"
#Enter the promotion code "freetrial"
#Change the value to 100.00
#Select Monthly from the drop down menu
#Set the remaining settings as you would any regular promotion (maximum uses, expiry date, applicable packages)
#Click the Create Promotion button

Now you can either have your customers enter the promotion code "freetrial" or use one of the following links to apply the free trial automatically:

http://example.com/whmcs/cart.php?promocode=freetrial

<div class="docs-alert-info">If you do not wish to collect a client's payment details for a free trial, set the ''Payment Type'' value to "Free" under the product's [[Products_and_Services#Pricing_Tab|Pricing tab]] instead.</div>

Client Email Verification

2021-05-04T16:47:05Z

DanR: /* Why enable it? */

'''Email Verification''' checks to ensure that the email address a client registers with is valid and their own.

When you enable this, upon creation of a new client account or change of email address, the system sends an email is to the email address, asking the user to confirm that they intended to register or make the change to the email address.

The validation link they receive is valid for 24 hours. If it expires, the client can request a new verification email by logging in to the client area.

==Why enable it?==

Enabling '''Email Verification''' helps to protect against signing up using incorrectly-typed and unauthorized email addresses. It can also act as part of order review and fraud screening procedures.

<div class="docs-alert-info">
<span class="title">Note</span><br />
To help reduce the number of emails new clients are sent after signing up, the client will not receive the separate ''Welcome'' email when '''Email Verification''' is enabled.
</div>

==Enabling Email Verification==

To enable '''Email Verification''', navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > [[Configuration#General_Settings|Security]]''' or, prior to WHMCS 8.0, '''Setup > General Settings > Security'''. Check the '''Email Verification''' checkbox and save the changes.

[[File:Enable_email_verification.png|center|850x250px|Enable email verification in general settings]]

<div class="docs-alert-info">
<span class="title">Note</span><br />
Enabling '''Email Verification''' will not send an email verification request to any existing clients automatically. Their accounts will display as unverified and continue to operate unaffected.
</div>

==Default Behaviour==

When you enable this, the client will receive an email verification notice when the following events occur:

* A new user registration.
* A change of email address for an existing account.

Clients access is not restricted to the client area, services, or support resources prior to email verification completion. This is to allow the client to access the services and support resources they have paid for.

After the client follows the link in the verification email, the client must log in to the client area to complete the verification process. Once they successfully authenticate, a success message will display on the next page.

In the admin area, the email verification banner will no longer display and a ''Verified'' badge will display.

[[File:email-verified-ca.png|800px|Verified email in client profile view]]

==Resending the Verification Email==

If a client has not verified their email address, they will see the option to resend the verification email in the banner notice in the client area. Admins also have this ability from the admin client summary page.

Clicking the '''Resend Verification Email''' button sends an email with a link that is valid for 60 minutes. If the recipient follows the link after the 60 minute window or multiple times (which invalidates the previous link) then an error will display upon attempting to verify using an older link. The user will have the option to request a new email verification.

<div class="docs-alert-info">
Prior to 8.0, the email verification link was valid for 24 hours.
</div>

==Client Area User Interface==

When you enable this, any client who has not completed the email verification process will see a banner reminding them to take action when they log in. This banner appears on all pages of the client area.

No functionality is limited in the client area for clients with an unverified email address.

[[File:Verify-email-link-ca.png|center|850px|Email verification banner on client side]]

==Admin Area User Interface==

When you enable this, any client who has not completed the email verification process will see a banner at the top of their client summary page and when viewing orders they submitted (pictured below).

[[File:Client_profile_verification_banner.png|400x150px|Client profile verification banner]]
[[File:Manage_orders_verification_banner.png|400x150px|Manage orders client verification status]]

An option to resend the verification email is also available from both pages. Clicking this will invalidate any previous verification links.

A badge will also display alongside the client's email address throughout the admin area, denoting whether the client's email address is verified.

[[File:Unverified_badge.png|right|400x250px|Unverified email badge]]
[[File:Verified_badge.png|400x250px|Verified email badge]]

Email Piping: Google Apps

2021-05-04T12:25:00Z

DanR: /* Configuration */

This article covers how to go about configuring the support ticket system to enable importing of new tickets and replies from e-mail accounts hosted with GSuite (formerly known as Google Apps).

Before beginning, we recommend having WHMCS set up and working properly on your web server so as to avoid any unexpected issues.

==Configuration==

Follow these steps: <br>
1. Create a GSuite account at https://gsuite.google.com/ <br>
2. Verify the domain where WHMCS is installed with GSuite and complete their setup process. <br>
3. Log in to the Admin Console at https://gsuite.google.com/ and create appropriate email accounts that will be using the WHMCS ticketing system and receiving tickets and replies.<br>
<div class="docs-alert-success">A separate email account should be created for each support department.</div>

<div class="docs-alert-info">
Starting with version 8.1 WHMCS can use OAuth to authenticate with your GSuite account. For details on how to do this please check our [https://help.whmcs.com/m/support_tools/l/1328652-setting-up-pop3-importing-with-oauth-via-google Setting Up POP3 Importing with OAuth via Google] guide.
</div>

4. For all accounts that will be receiving tickets, be sure to enable POP3 and IMAP in GMail's webmail interface: [https://support.google.com/a/answer/9003945 Enable IMAP] [https://support.google.com/mail/answer/7104828 Enable POP3]

<div class="docs-alert-info">Enable '''Enable POP for mail that arrives from now on'''. Otherwise, POP will be enabled for all emails in the inbox (even older emails that may not need to be imported) and will cause all of them to be imported by WHMCS.</div>

5. Please ensure that Imap-SSL/Pop3-SSL is in the PHP installation on the server. Such a change (if needed) will usually require the hosting provider or system administrator to do this. The reason for enabling this is because GSuite services will only accept secured connections.
6. Under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments''' or, prior to WHMCS 8.0, '''Setup > Support > Support Departments'''. in WHMCS, create at least one department and configure the email account assigned to it like so:
'''hostname:''' pop.gmail.com
'''port:''' 995
'''user:''' youremail@yourdomain.com
'''pwd:''' yourpassw0rd

7. Create a cron job to trigger the <tt>/crons/pop.php</tt> file every 5 minutes. We have guides on creating cron job in most web hosting control panels here: https://docs.whmcs.com/Cron_Configuration

Once this is done, any new emails to the support email addresses should be imported. If they are not, please follow the troubleshooting steps below to determine the cause and correct it as needed.

==Troubleshooting==
If e-mails are not being imported from GSuite as expected, there are some steps that can be taken to debug and correct this.

The first step is to check the ticket import logs in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' or, prior to WHMCS 8.0, '''Utilities > Ticket Mail Import Log''' in the WHMCS admin area. Look for any entries for the e-mails in question. If there are no applicable entries present, it usually indicates that the pop.php cron job isn't set up or is unable to successfully import the e-mails due to one or more of the below reasons:

* Verify that Pop3 and IMAP is enabled for the applicable Gsuite inbox as described in the Configuration section above and that the /crons/pop.php cron job has been created and is running every 5 minutes.
* If the cron job is running, view the output that it is creating (depending on the server, the cron job to email its results to an email address) and see if an error is being generated.
* If that command succeeds and no other firewall restrictions are in place, then the connection is unobstructed on your server side.

For more specific troubleshooting of the above, please refer to our help articles at [https://help.whmcs.com/m/support_tools/l/679784-troubleshooting-email-piping-problems Troubleshooting Email Piping Problems] and [https://help.whmcs.com/m/support_tools/l/679785-troubleshooting-email-piping-problems-advanced Troubleshooting Email Piping Problems Advanced]
===Connection refused===
* Check that the server's firewall isn't blocking traffic to google.
* To make absolutely sure that the server's firewall is not blocking your connection attempts, run this telnet command from the server using SSH: '''telnet gmail-pop.l.google.com 995'''
===Too many login failures===
* Double-check the username and password entered on the Support Department configuration are correct. You can find these at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments''' or, prior to WHMCS 8.0, '''Setup > Support > Support Departments'''.
* Adjust the Gmail account settings to allow [https://support.google.com/accounts/answer/6010255?hl=en-GB less secure apps]. This allows external applications such as WHMCS to authenticate to the account via username and password.
* Check the Recent Activity page in Gmail to see whether the login attempt was blocked at their end: [https://support.google.com/accounts/answer/6063333?hl=en ‘Suspicious sign in prevented’ email].

===Can not authenticate to POP3 server===
Refer to the troubleshooting steps for [[#Too many login failures]]
===Password command failed===
Refer to the troubleshooting steps for [[#Too many login failures]]

If there are any issues after verifying the suggested troubleshooting steps above, it will be necessary to contact Google or visit their discussion forums for GSuite. It is possible they may be blocking your server from accessing their mail servers.

===Email imported multiple times===
This situation occurrs if a single mailbox is shared between multiple WHMCS support departments. To resolve this please configure a separate email account for each department.

==Workaround for those without SSL==

In some cases, it may be necessary to work around your server not properly handling SSL for POP3. To do so, create another POP3 e-mail account at a different domain name outside GSuite (that does not require SSL to pick up via POP3), and then have your GSuite e-mail forward to that e-mail address. Then in WHMCS, use POP3 to pick up the e-mail at the POP3 account that does not require SSL. The user will never notice since they send all e-mails to your GSuite address, and receive e-mails "from" your Google Apps address (or whatever address you have assigned in WHMCS for that support department).

Automation Settings

2021-05-04T12:23:10Z

DanR: /* Invoice Generation */

The '''Automation Settings''' allow you to configure all of WHMCS's automated processes. This includes suspensions, unsuspensions, terminations, how far in advance the system generates invoices, and when the system sends overdue notices. It's the one central place that controls everything that the daily automation tasks do.

To trigger the daily automation tasks, you must configure a [[Crons|Cron Job]] at a recommended frequency of every 5 minutes. This is usually part of the initial installation of WHMCS.

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=Yk3-Ud0jITc&list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb&index=5&t=0s|Watch Video Tutorial]]

==Scheduling==

===Time of Day===
[[File:Time of Day.png|thumb|Time of Day]]
This setting allows you to select the hour in which you'd like WHMCS to perform all daily automation tasks. To function properly, this setting depends on configuring your cron job to run at least once every hour. We recommend setting it to run every 5 minutes to allow other system processes, such as checking for updates, to take place.

==Automatic Module Functions==
[[File:Automatic Module Functions.png|thumb|Automatic Module Functions]]
These settings pertain to your customer’s products or services and how the system handles non-payment.

===Enable Suspension===
Selecting this option will enable automatic suspensions when payments for products or services are overdue. The setting below (Suspend Days) controls the amount of time between your customer becoming overdue and when the system suspends them.

===Suspend Days===
If you enabled Enable Suspension, this configures the amount of time between a customer's product or service becoming overdue and the system suspending them.

===Enable Unsuspension===
When you enable this setting, services that the system suspended due to "Overdue on Payment" will automatically become unsuspended when they pay the unpaid invoice for the item. However, if you suspended products or services manually, and assigned a custom reason for suspension, then an automatic reactivation will not occur. For example, you may have manually suspended an item with a reason of "Broken Terms of Service" or "Awaiting ID Verification".

===Enable Termination===
Enable this option to terminate the client's service (remove it from the server) according to the setting below (Termination Days).

===Termination Days===
If you selected Enable Termination, this determines the number of days between a product or service becoming overdue and the system terminating that product or service.

==Billing Settings==
[[File:Billing Settings.png|thumb|Billing Settings]]
Use these settings to determine how the system generates invoices and sends payment reminders to your customers. Setting the Unpaid and Overdue Reminder settings to <tt>0</tt> will prevent the system from sending the related emails.

===Invoice Generation===
This is the number of days before the system will generate due date invoices. For example, if this setting is <tt>7</tt>, the system will generate an invoice seven days before the due date for products, services, addons, and domains. The number of days should be an integer of <tt>0</tt> or more.

====Per Billing Cycle Settings====
By clicking '''Advanced Settings''', you can specify a different invoice generation setting for each billing cycle. For example, you may want the system to generate invoices for monthly services seven days in advance and generate invoices for annual services 14 days in advance.

====Domain Invoice Generation====
This optional setting allows you to specify how far in advance to generate domain renewal invoices. You can use this if you want to give a longer time between invoice generation and the due date for domain invoices. This is particularly useful when you don't accept payments online and more time might be necessary to avoid domain expiration.

Leave this setting blank if you want the system to generate all invoices at the same time.

===Payment Reminder Emails===
If you enable this, the system will remind your customers by email in advance of an unpaid invoice's due date. It does this using the ''Invoice Unpaid Reminder'' setting (below). This setting does not apply to Overdue Reminders.

===Invoice Unpaid Reminder===
The system sends this email before the due date if the invoice remains unpaid, to remind a customer that the invoice will be due soon.

=== Overdue Reminders===
If a customer hasn't paid an invoice in a certain number of days after the due date, the system will email the customer with a reminder.

===Add Late Fee Days===
If a customer hasn't paid an invoice that is this number of days overdue, your customer will be charged late fees (according to your choices in General Settings).

===Overage Billing Charges===
Use this to determine how to bill clients for overage (if you enabled this). The first setting will calculate the bandwidth overage costs on the last day of each month and create an invoice that is due immediately. This will create a separate invoice.<br />
The second setting will still calculate the overage change on the last day of the month, but it will not create a separate invoice. Instead, the system will add it to the client's next invoice.

===Change Invoice Status===
Part of the [[Payment_Reversals|Payment Reversals]] feature. Set Invoice to Collections Status. WHMCS uses the collections status for invoices to denote invoices that are bad debts. You can use this to track invoices that have received payment disputes or chargebacks.

===Change Due Dates===
Part of the [[Payment_Reversals|Payment Reversals]] feature. This reverts Next Due Date Increments for the products and services in an invoice. The system considers them as due again, and, in cases where the date is in the past, overdue, which will trigger an automated suspension until repayment is made.

==Credit Card Charging Settings==
[[File:Credit Card Charging Settings.png|thumb|Credit Card Charging Settings]]
Use these settings to determine how to charge your customer's cards when you use a merchant gateway to handle credit card payments.

===Process Days Before Due===
This specifies the number of days before the due date that you wish to capture. For example, setting this to <tt>1</tt> would attempt to charge the card for the first time one day before the invoice due date.

=== Attempt Only Once===
By default, the system will attempt to capture payment for unpaid invoices daily until it succeeds. When you enable this option, WHMCS will only attempt to charge the customer’s card once. If it fails, it will not try again until the client or an admin makes a manual payment attempt.

===Retry Every Week For===
If a credit card is declined and you have enabled this setting, WHMCS will attempt the card once a week for this number of weeks. For example, if you set this to <tt>2</tt>, the system would attempt to charge the card two additional times. Set this to <tt>0</tt> to disable this, causing the system to attempt to change the card every day.

===CC Expiry Notices Date===
This is the day of the month on which the system will send reminder emails to active clients with cards that expire by the end of the month, asking them to update their records. On the 1st of the month, WHMCS will remove any credit cards with an expiration date before that day's date.

We recommend a low value, such as <tt>1</tt>, to give clients as much notice as possible to update their card details. For example:

'''Scenario'''<br/>
Card Expiry Date: March 2020<br/>
CC Expiry Noticed Date: 1

'''Timeline of Events'''<br/>
Reminder email sent: 1st March 2020<br/>
Card removed from WHMCS: 1st April 2020

===Do Not Remove CC on Expiry===
When you enable this option, the client's credit card information will remain on file after its expiration date. When you disable this, the system will remove the credit card details using the setting you specified for CC Expiry Notices Date.

==Currency Auto Update Settings==
[[File:Currency Auto Update Settings.png|thumb|Currency Auto Update Settings]]
Use these settings for the multi-currency system.

===Exchange Rates===
When you enable this setting, WHMCS will connect with the European Central Bank and obtain the latest exchange rates. This will ensure your currency conversion functions are always using an accurate rate. For more information, see the list of [[Currencies#Auto_Updating_Rates |supported currencies]].

===Product Prices===
When you enable this setting, the system will automatically update your prices according to the exchange rates. For example, if you have a product that costs $1 in your default base currency (USD) and the exchange rate is 0.6 for a second currency (GBP), the product’s price would automatically update to £0.6. Tomorrow, if the exchange rate changed to 0.7, a $1 product would change to £0.7.

==Domain Reminder Settings==
[[File:Domain Reminder Settings.png|thumb|Domain Reminder Settings]]
These settings determine when and how many emails the system sends to your customers to remind them to renew their domain names. You can send a maximum of five reminders. If you set any field to <tt>0</tt> it will disable that email.

You can configure WHMCS to send Domain Renewal Notices before and after a domain has expired.

For more information on this functionality, see the [[Domain Renewal Notices]] documentation.

==Domain Sync Settings==
[[File:Domain Sync Settings.png|thumb|Domain Sync Settings]]
===Domain Sync Enabled===
Enable this setting for the [[Domain_Synchronisation|domain date and status synchronisation function]].

===Sync Next Due Date===
Use this setting to choose whether to sync the Next Due Date to the Expiry Date, and, if you wish, how many days in advance of it.

===Domain Sync Notify Only===
If you enable this, the domain sync script won't make any changes. It will only notify admins of the changes it would have made. This is useful for debugging.

===Domain Expiry Sync Frequency===
A value of <tt>0</tt> will check the domain expiration dates every four hours. Use this setting to set a different frequency. The lowest frequency setting, <tt>1</tt>, will check every hour.

===Pending Transfer Sync Frequency===
A value of <tt>0</tt> will check the domains in Pending Transfer status every four hours. Use this setting to set a different frequency. The lowest frequency setting, <tt>1</tt>, will check every hour.

==Support Ticket Settings==
[[File:Support Ticket Settings.png|thumb|Support Ticket Settings]]
===Close Inactive Tickets===
After this amount of time has passed, the system will close any tickets that meet both of the following criteria:

* The ticket's status is either answered or customer reply.
* There have been no new replies from staff or the customer.

The system will also send an email to the customer.

Tickets in on hold and in progress status are exempt from auto-closure. Closure takes place when the daily cron job runs.

<div class="docs-alert-info">You must configure Ticket Statuses to "Auto-Close" for this setting to take effect. You can learn more about Ticket Statuses and the Auto-Close functionality in our [https://docs.whmcs.com/Support_Ticket_Statuses#Status_Options Status Options documentation].</div>

===Prune Ticket Attachments===
When this setting is enabled, ticket attachments will be automatically deleted after the selected amount of time of inactivity following the closure of a ticket. This can be set between 1 and 24 months.

For more information on this functionality, see the [[Ticket Attachment Pruning]] documentation.

==Data Retention Settings==
[[File:Data Retention Settings.png|thumb|Data Retention Settings]]
{{:Data_Retention_Policy_Automation}}

For more information, see the [[Data_Retention_Policy_Automation|Data Retention Policy Automation page]].

==Miscellaneous==
[[File:Miscellaneous.png|thumb|Miscellaneous]]
===Cancellation Requests===
When you enable the [[Other_Tab#Show_Cancellation_Link|Show Cancellation Link]] option, enabling this setting will automatically terminate the client’s package on the termination date.

===Update Usage Statistics===
Enabling this option will display disk and bandwidth usage statistics from the hosting control panel (if it is supported) inside the WHMCS admin and client areas. It will update them on a daily basis.

===Client Status Update===
The following applies to the client status dropdown found in the client account Profile tab. WHMCS automatically sets clients with no active products or services to Inactive status. This helps you to distinguish and filter clients effectively. However, you can stop WHMCS from doing this by changing this setting. More information on this feature is available in [[Clients:Profile_Tab#Changing_a_Clients_Status|Client Management]].

'''Disabled''' — The system won't change the status of a client automatically.

'''Change client status based on active/inactive products''' — If a client has no active or suspended products or services, the system will automatically set their account to Inactive status the next time that the cron job runs.

'''Change client status based on active/inactive products and not logged in for longer than 3 months''' — In addition to the above option, the system will only set a client's account to inactive when their last login date was over 3 months ago.

===Automatically Delete Inactive Clients===

This setting allows you to configure client records to be automatically deleted after a given number of months with no invoice or transaction history. This setting defaults to off.

To enable this, you must select the radio option for removing clients automatically and specify a number of months that is greater than 0.

When you enable it, the system performs the Data Retention Pruning task daily and will remove clients that meet the following conditions:

* Are in a status of [[Automation_Settings#Client_Status_Update|Inactive or Closed]].
* Have no invoices that have been marked paid within the given number of months you specify.
* Have no transactions that have been entered or applied within the given number of months you specify.
* Is an affiliate with a balance greater than 0 or has made a referral within the specified retention period.

<div class="docs-alert-warning">'''Important Note:''' It is the presence of paid invoices or transactions within the given timeframe that defines client records which are kept. Enabling this feature with clients in an Inactive or Closed status, that have no invoice or transaction history, will result in those clients being deleted immediately.</div>

The client status can be changed automatically by the system. This is controlled by '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings > [[Automation_Settings#Client_Status_Update|Client Status Update''']].</onlyinclude>

Configuring Sign-In using Twitter

2021-05-04T12:20:10Z

DanR: /* Configuring Sign-In with Twitter */

This article is part of the [[Sign-In Integrations]] feature.

==Purpose==

Enabling the Twitter Sign In Integration enables visitors and customers to register, sign in and connect their Twitter accounts with your WHMCS installation for faster sign-up and automatic sign-in.

[[File:Signinintegrationslogin.png]]

==Configuring Sign-In with Twitter==

<html><a href="https://vimeo.com/231458433" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>

There are 2 steps required to set up Sign-In with Twitter:

# [[Configuring_Sign-In_using_Twitter#Create a Twitter App and Retrieve API Credentials|Create a Twitter App and Retrieve API Credentials]]
# [[Configuring_Sign-In_using_Twitter#Activate Twitter Sign In within WHMCS|Activate Twitter Sign In within WHMCS]]

===Create a Twitter App and Retrieve API Credentials===

Twitter Sign In Integration requires a Twitter App and API Credential Set. You can create this using your existing Twitter account. Users will only see the App Name you define and not see anything relating to the account you use to create the project.

<div class="docs-alert-warning">Be aware that the Twitter account under which you create the app cannot be changed without requiring users to re-authenticate and re-link their accounts, so it is important to set the app up under an account that you will always have access to.</div>

1. Visit https://developer.twitter.com/en/portal/dashboard <br>
2. If not logged in, log in to your Twitter account <br>
3. Click the '''Create Project''' button <br>
4. Select a project name. This can be anything such as "WHMCS Login"<br>
5. Select an app name. This can be anything such as "WHMCS Client Area Login"<br>

[[File:Screenshot-3.png|thumb]]

6. You will now be presented with your API keys. You should take note of the '''API Key''' and '''API secret key'''<br>
7. Go to app settings and scroll down and click '''Edit''' on Authentication Settings section<br>
8. Enable '''3-legged OAuth'''<br>
9. Enter your WHMCS Client area URL for the callback URLs and Website URL and click '''Save'''<br>

You must also enter a valid URL in the Callback URL fields. The URL you enter here is not used, but the valid URL of the callback file must be defined to enable WHMCS to utilize callbacks.

Because there are three possible callback URLs depending upon the '''Friendly URLs''' feature settings, we suggest adding all three:

* http://demo.whmcs.com/whmcs/index.php
* http://demo.whmcs.com/whmcs/index.php/auth/provider/twitter_oauth/callback
* http:///demo.whmcs.com/whmcs/auth/provider/twitter_oauth/callback

Replace <i><nowiki>http://demo.whmcs.com/whmcs/</nowiki></i> with the actual URL of your WHMCS installation

<div class="docs-alert-warning">Ensure that the '''WHMCS System URL''' in WHMCS, Twitter "Website" and Twitter "Callback URLs" either all contain www subdomain or not, or matching subdomain. Failing to do so will result in an Invalid Details error when trying to activate the Twitter sign-in integration in WHMCS. </div>

You can now proceed to Activate Twitter Sign In within WHMCS.

===Activate Twitter Sign In within WHMCS===

# Log in to the WHMCS Admin Area
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Sign-In Integration''' or, prior to WHMCS 8.0, '''Setup > Sign-In Integrations'''.
# Select '''Activate''' under the Twitter heading
# Enter your Twitter '''API Key''' in to the '''ConsumerKey''' field and the '''API Secret''' into the '''ConsumerSecret''' field
# Click '''Save & Activate'''

WHMCS will attempt to validate and test the details you have entered. If the API Key and Secret are valid and successfully authenticate with the Twitter API, the values will be saved and the modal will close.

Congratulations! Twitter Sign In is now enabled.

==Troubleshooting==

For troubleshooting help, please refer to [[Troubleshooting Sign-In using Twitter]]

Domain Transfers

2021-04-27T16:17:27Z

DanR: /* Outgoing Domain Transfers */

==Overview==

* WHMCS allows your customers to transfer domains to and away from you via a varied array of registrar modules. To see if your registrar module supports Domain Transfers, you can visit the [[Domain_Registrars|Domain Registrars]] page and then review the Supported Features chart.
* A domain transfer is the process of moving a domain from one registrar to another. Once a domain transfer has been performed, the registrar the domain was transferred to will handle all information pertaining the domain and its management.
* To initiate a transfer, an order must be placed for it. Customers can place an order for a Domain Transfer via the Client Area by navigating to '''Store > Transfer Domains to Us'''. Alternatively, administrators can place an order for a Domain Transfer via the Admin Area by navigating to '''Orders > Add New Order'''.

==Incoming Domain Transfers==

[[File:Domain-transfer.png]]

* If the "Allow clients to transfer a domain to you" option is enabled in the Admin Area at Setup > General Settings > Domains tab, then your customers will see the "Transfer in a Domain" option in the Shopping Cart.
* Customers can choose to transfer in any domains with TLDs that have pricing configured in the Admin Area at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Pricing''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Pricing'''.

<div class="docs-alert-warning">
Please note that a domain transfer will be billed and performed for the shortest configured period.
</div>

* Once the order has been completed and paid WHMCS will initiate the transfer process, and the "Domain Transfer Initiated" email notification will be sent to the customer.

==Outgoing Domain Transfers==

* To initiate a transfer away from WHMCS customer's will first want to ensure that their domain name is unlocked, and they will need to get their EPP code.
* If the registrar module offers the ability, WHMCS can lock or unlock the domain name for them. Customers that want to unlock their domain name can do so via the Client Area by navigating to '''Domains > My Domains''', clicking on the domain, and then clicking on '''Registrar Lock'''.
* The EPP code is basically a password for a domain name. It is a security measure, ensuring that only the domain name owner can transfer a domain name.
* Customers can retrieve the EPP code needed to transfer their domain to a new registrar via the Client Area as well. This can be done by navigating to navigating to '''Domains > My Domains''', clicking on the domain, and then clicking on '''Get EPP Code'''.
* Administrators can retrieve the EPP code from the Admin Area if needed. This can be done by navigating to the domain's page, and then clicking on the '''Get EPP Code''' button.
* Domain names that have not yet been successfully transferred from another registrar will have the "Pending Transfer" status.

==Transfer Automation==

* With the Domain Syncronisation feature WHMCS is able to identify when a domain transfer has been completed or failed. It will ensure that the Next Due Date, Expiry Date, and Status values are updated for domains on the installation.
* Most Registrar Modules support the Domain Syncronisation functionality, however not all do. To see if your desired registrar module supports this feature you'll want to click on the module on the [[Domain_Registrars|Domain Registrars]] page and then review the Supported Features chart.
* Once the domain transfer from another registrar has completed, WHMCS will send the "Domain Transfer Completed" email notification to the customer, and the domain will be set to the "Active" status.
* If a domain transfer from another registrar fails, then WHMCS will send the "Domain Transfer Failed" email notification to the customer to let them know and advise as how to proceed.
* The following registrar modules will automatically set the domain's status to "Transferred Away" once the transfer to another registrar has been completed. This will prevent WHMCS from generating renewal invoices for the transferred domain:
**[[Enom]]
**[[ResellerClub]]
**[[HexoNet]]

File:Screenshot-3.png

2021-04-25T15:27:40Z

DanR:

How To Guides

2021-04-21T14:23:30Z

DanR: /* Convert invoice amounts into a different currency */

This page contains step-by-step instructions for certain common scenarios that may occur while running a business. There are more tips, tricks and howto's [http://forum.whmcs.com/forumdisplay.php?29-Tips-Tricks-amp-Howto-s in our forum].

==Regenerate Historical Invoices==
When switching from a manual billing system or software for which an import script is not available, you may want to have a record of past invoices that you issued before you started using WHMCS.

Once you have added the client and their service, navigate to the client's Products/Services tab and set the '''Next Due Date''' back to the date you want the first historical invoice to be due via their Products/Services tab and Save Changes. For example, if the client has an invoice every month starting in June, 2011, set it to 28/06/2011.

Click the '''Generate Due Invoices''' button from the summary page to create last year's invoice. When the system prompts you, select "No" so that the client doesn't receive a notification email.

Next, navigate to the Invoices tab, click the invoice, and then click the Add Payment tab to record the payment details per [[Transactions]]. Uncheck the "Send Email" option so the client doesn't receive a notification email.

This will cause the Next Due Date to increment forward one billing cycle, so in our example it will now be 28/06/2012. Click the "Generate Due Invoices" again and the system will create the June 2011 invoice.

Repeat this until the Next Due Date is showing the date the client's next payment is due.

==Update Domain Pricing==
[[File:change.png|thumb|Bulk Price Updater]]Occasionally, it may be necessary to update the price of existing domain names or products in your system (for example, in line with wholesale price increases). There may also be times where it is desirable to increase the price of specific domain addons (for example, if you wish to start charging for ID Protection after previously offering it for free). You can achieve this with the [[Bulk Pricing Updater Addon]] and these instructions:

*Begin by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
*Locate and Activate the '''Bulk Pricing Updater''' addon (it may already be active, in which case you can skip this step).
*Ensure that you have access to the module by scrolling down the page following activation and ensuring your admin role group (usually Full Administator) has the checkbox checked in the Access Control permissions for it.
*Navigate to '''Addons > Bulk Pricing Updater''' to actually access the addon module.
*Set your criteria and perform the pricing update. To do this:
**'''Step 1''' — Choose the type of item you wish to make a pricing update to, which in this case is Domains.
**'''Step 2''' — Specify the criteria for identifying the items you wish to change the pricing on by checking the corresponding TLD checkboxes.
***Select the statuses you want to apply the change to. We recommend only Pending, Pending Transfer, and Active statuses. Expired and Cancelled domains won't receive invoices again.
***Select the Registration Period you want to apply the change to (for example, one or two years). You will need to run an update for each pricing term you offer.
***If you only wish to change the price of domains with specific addons active, check the relevant Domain Addons checkboxes. This is useful for adjusting the price of the individual addons (for example, to increase the price of ID Protection, select the ID Protection checkbox).
***The currency and current price are optional. If you run multiple currencies then you would need to do a separate update request for each currency, and if you have certain clients on older or special pricing, you can use the current price field to restrict a change to only users with a specific current price, thus allowing you to keep the users on different pricing.
***The system will prompt you to provide either a New Price to assign matching items to, or an amount to Increase Existing Prices By. You should only ever specify one or the other of these (never both).
**'''Step 3''' — Review — This step provides a summary of your criteria and the change that will be made and asks you to confirm everything is correct. Once you proceed, you can't undo the action, so be sure to check the proposed changes and criteria.
**'''Step 4''' — Perform Update — The system will perform the update and the addon will tell you the number of items that the system adjusted. Upon completion of an update, if you find it didn't apply to as many items as you had expected, you can go back and refine your criteria further.

==Change Tax Rate==
Sometimes, governments change the sales tax rates. This is significant, since you must also update your rates accordingly.

For the purposes of this example the UK sales tax, VAT, is increasing from 17.5% to 20% on 4th January.

This means that at midnight on Monday, 3rd January, or at the latest before the cron job run on the 4th for generating new invoices, you will want to update the tax rules in your WHMCS installation so that new orders and invoices use the higher rate. This is possible through the WHMCS admin interface under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration''' or, prior to WHMCS 8.0, '''Setup > Payments > Tax Configuration''':

*Delete the original tax rule by clicking the corresponding red delete icon.
*Create a new tax rule with exactly the same country and state but enter the new tax rate.

Any invoices that the system generates after this change will use the new tax rate, but any existing invoices will keep the old tax rate.

If you have '''multiple separate rules''' this method can be time-consuming, so you can do this in bulk by running an SQL update query on your WHMCS database via a tool such as phpMyAdmin:

<source lang="php">UPDATE tbltax SET taxrate=20 WHERE taxrate=17.5;</source>

This won't affect existing invoices, and it will keep the 17.5% tax rates they had when the system generated them. This will just mean that for any invoices that the system generates after the change, use the new higher 20% tax rate.

If you also wish to update existing but unpaid invoices from before the 4th but due on or after it, then you can use this query to do that:

<source lang="php">UPDATE tblinvoices SET taxrate=20,tax=subtotal*0.2,total=subtotal+tax-credit WHERE status='Unpaid'
AND taxrate=17.5 AND duedate>='2011-01-04'; </source>

==Migrate Payment Gateways==
Sometimes, you may want to stop using one payment gateway and switch to another. This is a general guide to the process:

#Enable the new payment gateway module under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''. Configure it per our [[Payment_Gateways|documentation]].
#Deactivate the old module by clicking '''Deactivate''' on the Payment Gateways page.
#The system will prompt you to choose the payment gateway you wish to reassign all existing services and invoices to. Select the new payment gateway. For more information, see [[Payment_Gateways#Deactivating_Gateway_Modules|Deactivating Gateway Modules]].
#Depending upon the type of payment gateway module you're switching to, there may be a third step:
##If you are switching between merchant gateways or third party gateway modules, there is no third step and you are finished.
##If you are switching to a merchant gateway for the first time, the client will need to log in and enter their card details to the "My Details" page in the client area. The system will charge the card when the next invoice is due.
##If you are switching between tokenisation modules, the client will need to log in and pay their first invoice manually, which will store their card details on your processor's servers. The system will attempt subsequent payments automatically. Regrettably, there isn't a way for the migration to be done without client's intervention because the system requires their CVV number for the first payment.
##If you are switching from a merchant gateway to a tokenization gateway, typically clients will need to manually pay their next invoice via the client area. If you store card details or a token for the client, you may wish to delete them via the "Credit Card Information" link on each client's summary page beforehand. There are some exceptions, though, and some payment gateways have card number migration paths:<br/>- [[Stripe#Migrating_to_Stripe|Stripe]]
##If you are switching from a merchant or tokenization gateway to a third party gateway, clients will need to manually pay their next invoice via the client area. If you store card details or a token for the client, you may wish to delete them via the "Credit Card Information" link on each client's summary page beforehand.

==Advanced Billing Scenarios==
<html><a href="https://www.youtube.com/watch?v=glZv8iZU0mU&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>

The above video tutorial shows and explains how to handle two advanced billing scenarios:
#Change a billing cycle from annual to monthly, with the added complication that the system has already generated an annual renewal invoice.
#Consolidate the renewal date of several services onto the same day on a single invoice in the future, even if the client has already renewed some services this month.

==Switching Domain Registrars==

Domain prices change frequently. If one finds a chosen registrar's price is no longer competitive, it may be desirable to transfer existing domains to a different registrar without the client's knowledge. WHMCS can make the process easier, saving the need to log in to both provider's control panels:

# Navigate to '''Clients > Domain Registrations''' and select the domain in question.
# Uncheck the '''Registrar Lock''' checkbox and click Save Changes.
# Click the '''Modify Contact Details''' button.
# Change the registrant email address to your own and click Save Changes.
# Return to the client's Domains tab and click the '''Get EPP Code''' button.
# Note the onscreen EPP Code.
# Select the new domain registrar from the Registrar dropdown menu.
# Click the '''Transfer''' Module Command button.

You should see a confirmation message stating the transfer initiated successfully. It is likely that the client's Domains tab will display an error message from the new registrar, but this will disappear once the transfer process is complete.

<div class="docs-alert-info">
<span class="title">Note</span><br />
Once the transfer process is complete, be sure to use the Modify Contact Details button to change the registrant email address back to the client's own address.
</div>

==Convert invoice amounts into a different currency==
It is possible that not every gateway you use will accept all the currencies you offer on your site. Many gateway modules support a '''Convert To For Processing''' option so WHMCS can transparently convert the payment amount into a different currency before sending the client to the payment gateway.

For example: Gateway A only operates in USD, but you have configured multi-currency in WHMCS, offering prices in USD, GBP and EUR. When a client places an order for 10GBP and chooses to pay via Gateway A, the system will automatically convert the amount to 15USD before the payment processes. The client is able to make payment via Gateway A where they otherwise would not be able to do so.

To configure this feature:
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways > Manage Existing Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways > Manage Existing Gateways'''.
# Under the payment gateway in question, locate the '''Convert to For Processing''' setting.
# From the menu, select your desired currency.
# Click '''Save Changes'''.

To continue the example from above, one would choose the USD currency from the Gateway A section.
The system will send all payments to this gateway in the chosen currency, regardless of which currency the client selected on the order form.

<div class="docs-alert-info">
<span class="title">Note</span><br />
The Convert to For Processing option will appear once you configure a second currency.
</div>

<div class="docs-alert-info">
<span class="title">Note</span><br />
The system performs the currency conversion using the '''Base Conversion Rate''' in your WHMCS installation at the time of payment.
</div>

==Credit a client for money received==
When you receive money from a client, you should record it in WHMCS as a transaction. But if the payment is not for a specific invoice or the client has accidentally overpaid, the client's credit balance should be increased accordingly. Adding credits via the "Manage Credits" popup would not appear on the transaction record as they are not transactions.

To credit a client and create a transaction:

* Navigate to '''Billing > Transactions List > Add Transaction''' tab.
* Enter the details of the credit.
* Check the '''Credit''' checkbox.
* Click Add Transaction.

This will ensure your accounting records are accurate and the Account Statement report is balanced.

==Cancel and regenerate invoice==
Sometimes, you may wish to cancel an unpaid invoice and later need to regenerate an invoice covering the same time period for the service.

To cancel the original invoice:

* Navigate to Billing > Invoices.
* Click on the invoice in question.
* Click the "Marked Cancelled" button.

To regenerate the invoice for the same period:

* Navigate to Clients > Products/Services.
* Click on the service.
* Move the Next Due Date forward by one day. This will ensure the "next invoice date" value in the database resets to match the next due date when using [[Invoice_Tab#Continuous_Invoice_Generation|Continuous Invoicing]].

* Click Save Changes.
* Navigate to the Client Summary page.
* Click "Generate Due Invoices".

==Skip an invoice==
Occasionally you may wish to skip an invoice, giving the customer the invoiced period at no charge, but resume charging on the next due date.

If an unpaid invoice already exists:

* Navigate to Billing > Invoices.
* Click the invoice in question.
* Click the "Mark Cancelled" button.

You can now set the Next Due Date for when charging should resume:

* Navigate to the service that you wish to extend at no charge.
* Set the the Next Due Date.
* Click "Save Changes".

The system will create the next invoice on the new Next Due Date without charging for the period between the old next due date and the new next due date.

Module Class Autoloading

2021-03-09T20:29:52Z

DanR: Replaced content with "This page has moved to https://developers.whmcs.com/modules/module-class-autoloading/"

This page has moved to https://developers.whmcs.com/modules/module-class-autoloading/

System Utilities

2021-03-09T15:38:25Z

DanR: /* Prune Old Attachments */

==Link Tracking==

The link or ad tracker tool allows you to track your advertising campaigns. You can set up the various links you want to use and then, instead of linking directly, you use the tracking link WHMCS gives you. It then tracks the number of clickthroughs you get and, ultimately, conversions, using a cookie and providing an easy way to analyse how successful different promotions and links are.

How does it all work? When the click passes through WHMCS the system increments the count by one, but also sets a cookie on the user's computer to say they used that link. The system only stores the latest link they used, so a conversion never counts more than once. The cookie lasts for three months, so if a user then places an order with that cookie still present on their computer, the conversion count for that link increases.

===How to add a tracked URL===

To do this:

#Begin by going to '''Utilities > Link Tracking'''.
#Click "Add a New Link".
#Enter a name to identify the link and the URL to forward the user to.
#Click Add Link. The system will add the link for tracking.

===How to get the URL to use for tracking===

To do this:

#After adding the URL for tracking, click the edit icon next to it.
#The Link/URL field on the edit page will show the link you need to use (for example, http://demo.whmcs.com/link.php?id=1)
#Link to that URL from wherever you run the promotion.

===How to monitor the links===

To check on your links, go to '''Utilities > Link Tracking'''. WHMCS lists the links you've set up for tracking, the number of clicks each has had, and the number of conversions (orders).

==Calendar==

[[File:calendar.png|thumb|The Calendar]]

The calendar lists all pending, active and suspended products, addons, domains, and to-do items on the dates they are due. When you use this in conjunction with our [http://www.whmcs.com/addons/project-management/ Project Management Addon] it will also display the due date of projects. It allows you to easily see, at a glance, upcoming payments, domain expiration, and projects for each date.

You can also add your own events and tasks to the calendar. These can be either one time events or regular recurring events (for example, server payments or admin tasks) and can span multiple days. To add an event, click the date you want to add it on and fill in the popup. To edit an event, click on it on the scheduled day and a popup will appear to allow adjustments.

<div class="docs-alert-info">
<span class="title">Timezones</span><br />
When entering a start/finish time use the '''UTC''' timezone. The calendar will then convert this to your WHMCS installations' timezone for display purposes.
</div>

If the calendar becomes busy, you can use the Show/Hide filters to reduce the amount of displayed data. Detailed weekly and daily listings are available by clicking the appropriate button in the top right corner of the calendar.

A [[Widgets|widget]], available on the admin homepage, displays today's events, and allows you to see the scheduled events for any day in the current month and even add new events directly from the admin summary.

==To-Do List==

The to do list allows you to add tasks that need to be finished, the dates they are due for completion, and the assigned admin. To-Do Items can also have an unlimited length description for storing additional information about the task. Access the To-Do list via '''Utilities > To-Do List'''. The admin homepage widget displays due items.

Enable or disable automated domain-related To-Do entry creation in the [[Domains_Tab|General Settings]].

==Activity Logs==

WHMCS logs all activity, admin logins, gateway communications, sent and received email communications, and domain lookups. This allows you to monitor and track all the activity taking place inside your WHMCS system. You can find the logs in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' in the left-side menu (or in the '''Utilities''' menu in WHMCS 7.x and earlier). They include:

* [[Activity_Logs|Activity Log]]
* Admin Log
* Module Log
* Email Message Log
* Ticket Mail Import Log
* WHOIS Lookup History Log

<div class="docs-alert-warning"><p><strong>Note:</strong> The '''Email Message Log''' will log all emails that WHMCS sends to clients, with the exception of the "Automated Password Reset", "Client Email Address Verification", and "Password Reset Validation" emails.</p></div>

Over time, log records in your WHMCS System will accumulate. As the number of records grows, so will your database, and you may begin noticing a reduction in performance. If these start affecting performance, WHMCS allows you to empty them at any time. To empty your logs, perform the following actions:

# Log in to your WHMCS Admin Area.
# Navigate to '''Utilities > System Cleanup'''. You will see options to empty the Gateway, and WHOIS Lookup logs.
# Click the '''Go''' button next to the log you would like to empty. A confirmation message will then appear, confirming that the system emptied the log.

Additionally, from the same Cleanup Operations page, you can prune the Client Activity Logs so that the system only maintains entries after a specified date. To do this, enter in your desired date, and click on the Delete button. Again, a confirmation message will then appear to confirm that the system pruned the log.

==Database Backups==

WHMCS stores its data in your database, so is very important. It is therefore recommended that you take regular backups of it. There are two built-in solutions for automated database backups using the daily cron. One is email and the other is an FTP backup to a remote server. You can find configuration instructions on the [[Backups|Backups Page]].

==System Cleanup==
With constant daily operations, the log files in WHMCS can become quite large. The Cleanup Operations page allows you to prune logs to reduce the size of the database and reduce disk space. You can find this at '''Utilities > System > System Cleanup'''.

<div class="docs-alert-warning">
<span class="title">Note:</span><br />
Only delete information you're certain is no longer necessary (for example, for audit purposes). WHMCS Technical Support may be unable to assist in some matters if you have removed the relevant logs.
</div>

===Empty Gateway Log===
This clears out the '''Billing > Gateway Log''' communication between you and your payment gateways. It does not affect transactions and invoices.

===Empty Whois Lookup Log===
Clears out the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > WHOIS Lookup Log''' ('''Utilities > Logs > WHOIS Lookup Log''' in WHMCS 7.x and earlier) of the domains that clients have checked.

===Empty Ticket Mail Import Log===
This clears out the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Ticket Mail Import Log''' ('''Utilities > Logs > Ticket Mail Import Log''' in WHMCS 7.x and earlier) of the record of emails you piped into the WHMCS ticket system. It does not affect tickets themselves.

===Empty Template Cache===
WHMCS caches templates into static files to reduce the loading time of each page. In order for template changes to take effect, it is necessary to clear the cached files.

In order to do this, remove all existing files from the templates_c folder, which you can do quickly and easily using this option. Make sure the <tt>/templates_c</tt> directory is writeable so that WHMCS is able to delete the cache files and generate new ones.

===Prune Client Activity Logs===
Select a date to remove any client entries in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) before that date. Non-client-related entries will remain.

===Prune Saved Emails===
Select a date to remove any emails in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs > Email Message Log''' ('''Utilities > Logs > Email Message Log''' in WHMCS 7.x and earlier) before that date.

=== Prune Old Attachments===
Select a date to remove any support ticket attachments from closed tickets which are also older than the date selected. The system will also delete them from the /attachments directory.

==Troubleshooting System Utilities==
===Database Backup Fails/Timesout===
The most common reason for database backups to fail is simply that it has grown too large and the PHP process takes too long or uses too much memory and is killed before it can complete the backup process.

You can find further details on this in the [[Backups#Limitations|Backups Limitations]] section.

===System Cleanup page fails to load===
If the System Cleanup page fails to load entirely, this can be caused by a missing or unreadable 'attachments' directory.

You should ensure the attachments directory path configured in Storage Settings exists and is readable. It is also important to ensure the attachments directory path is absolute and not relative to avoid timeout issues on the System Cleanup page.

You can find further details on changing the Storage Settings path in our [[Moving_Storage_Locations]] guide.

Activity Logs

2021-03-09T15:21:12Z

DanR: /* Limiting/Clearing Logs */

<div class="docs-alert-info">
<span class="title">WHMCS 7.x and earlier</span><br />
In WHMCS 7.x and earlier, you can find this at '''Utilities > Activity Log'''.
</div>

The activity log in WHMCS records events that occur to allow for tracking who and what initiated various actions and to allow for troubleshooting any errors or problems that occur.

For example, if automatic setup ever fails for any reason, the activity log will hold the error message response that came back from the module to allow you to find out why. Similarly, if you have any problems with the cron job, the activity log will show you what tasks the cron job is performing and allow you to see at exactly which point or item it is failing.

For more information about WHMCS log files, see [[System_Utilities#Activity_Logs|System Utilities]].

==Reviewing Activity Logs==

There are two types of log entries: client logs and system logs. Client logs are events and actions relating to a specific client, and you can view them from the '''Log''' tab within a client's profile. You can access the full system log, which includes both client and system log entries, via '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs'''.

Each action or event records the date and time the action occured, a description indicating what happened, the currently-logged-in admin user who invoked the action ('''System''' for non-admin-initiated actions) and the IP address of the user who caused it (for example, the admin's, client's, or system's IP address).

In both locations, you can filter the log entries for entries on a specific date, for a specific username or IP address, or containing certain keywords. This allows you to narrow the log down quickly and easily for the specific action or event you are looking for.

==Limiting/Clearing Logs==

The system automatically purges system log entries when the daily cron tasks execute and when you load the Activity Log page.

System log entries are limited based on your settings in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Limit Activity Log'''.

The system keeps client log entries indefinitely, so the logs can easily reach many thousands. This shouldn't affect the performance of your system, but if you do want to trim client history logs, you can delete all entries before a certain date in '''Utilities > System Cleanup'''.

Licensing

2021-03-09T14:33:10Z

DanR: /* Changing the License Key WHMCS uses */

==Moving WHMCS==
When you move your WHMCS system, if the domain, IP address, or directory you use it in is changing, you must update your license. The method to use depends on the license you have:

===1. You purchased your license directly from us===

If you purchased your license from us directly, you can reissue your license from [http://whmcs.com/members|our client area] without any manual intervention from us. To do this, log in, go to Services > My Licenses, select your license key, and click '''Reissue''' under the Management Actions tab. Then, visit your WHMCS installation in the new location. The system will save the new valid access details.

===2. You obtain your license from your web host===

If you received your license from your hosting provider, you can't reissue your license from our client area. This is because the domain and IP address cannot change. Contact your hosting provider to have them update the license for use at the new location. If you are moving to a different hosting provider, you cannot move your license key with you and you will require a new license key for use at the new location.

To move WHMCS:

* Disable or remove the WHMCS cron jobs from the old server. This prevents automation from running and making changes.
* Create a backup of your database [[Maintenance#Backing_up_your_WHMCS_Database|following these instructions]].
* Make sure the new server meets the [[System_Requirements|system requirements]].
* Transfer the files to the new server.
* [[Maintenance#Restoring_a_Database_Backup|Restore the database]] via phpMyAdmin on the new server and make any changes to the database settings in <tt>configuration.php</tt>.
* Reissue your license using the steps above.
* Log in to your WHMCS admin area and update the system URLs in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
* Check whether the system properly modified your cron jobs, payment gateway callbacks, and email forwarders.
* Update your [[Further Security Steps#Secure_the_Writeable_Directories|custom directory locations]].
* Update your [[Moving_Storage_Locations|storage locations]].
* Delete the WHMCS files from the old location.

<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Transfer Services:</b> Have our team transfer your WHMCS installation.</small></em><span class="button">Services</span></a></html>

==Changing the License Key WHMCS uses==

To change the license key your WHMCS system uses, log in to the admin area and go to '''Help (<i class="fa fa-question-circle" aria-hidden="true"></i>) > License Information''' or, prior to WHMCS 8.0, '''Help > Change License Key'''. Enter your new license key and admin login details to verify the change.

If you are unable to login due to an invalid license error, you can click the '''Click here to enter a new license key.''' link to the Change License Key page and provide a valid license key.

==Is licensing dependant on whmcs.com being online?==

No. WHMCS uses a local key licensing system with periodic remote verification checks. Once every seven days, your WHMCS system will contact our server to ensure it is being run in the correct location and that the license is still valid. Whether your WHMCS system is online is not dependant on our server being online during the time the local key is valid.

If our licensing server is unavailable on the day of your next verification check, the system will allow up to three days to make a connection. If, after this time, the system still can't verify your license with our licensing server, your WHMCS Admin Area will become inactive until WHMCS can contact our server again.

Your WHMCS Client Area will always remain online, even if you have an invalid or expired license, to ensure your clients have uninterrupted access.

==Common Errors==

<div class="docs-alert-info">
For information on troubleshooting common licensing errors, see [[License Troubleshooting]].
</div>

Editing Client Area Menus

2021-03-09T14:29:15Z

DanR: /* Add a special offer image and link to the top of the topmost sidebar */

WHMCS version 6 introduces a programmatic way to interact with the client area navigation and sidebars through hooks and modules.

<div class="docs-alert-warning"><strong>In a hurry?</strong> We have made available two guides containing copy & paste ready code samples for common customisations performed to the dynamic navigation and sidebar menus.
* [[Client Area Navigation Menus Cheatsheet]]
* [[Client Area Sidebars Cheatsheet]]
</div>

=Menu structure=

The client area's navigation and sidebars are defined in a tree structure of [http://docs.whmcs.com/classes/classes/WHMCS.View.Menu.Item.html menu item objects]. Each menu item has one parent item and can have many child items. The only menu item with no parent an invisible root item that is not displayed on the page.

==Navigation bars==

Navigation bars consist of the invisible menu root with children representing every item displayed in the navigation bar. Each of these items may have their own child items. These child items are rendered as that navigation bar item's dropdown menu.

* ''Navigation bar root Item''
** navigation item
** navigation item
*** dropdown item
** navigation item
*** dropdown item
*** dropdown item
*** dropdown item
** navigation item

Navigation bars are displayed on every page in the client area, but their contents may change if a client is logged in or not. For instance, the navigation bar may show login and password recovery links if a user isn't logged in.

==Sidebars==

Like the navigation bar, the sidebars in WHMCS begin with an invisible menu root, but each child represents an individual panel in the side bar. Each panel item is rendered as an item within the panel in the WHMCS client area.

* ''Sidebar root Item''
** panel
*** panel item
*** panel item
*** panel item
** panel
*** panel item
*** panel item
** panel
*** panel item
*** panel item
*** panel item

Sidebars help provide context for the data displayed on the page. Different pages in the client area may have different sidebar items. For example, a page to view an account may contain sidebar links to view that client’s open tickets or unpaid invoices.

=Menu layout=

==Desktop mode==

[[Image:Desktop mode.png|thumb|The WHMCS 6.0 client area layout in desktop mode]] There are two navigation bars in WHMCS’ client area. The primary navigation bar contains the bulk of the menu and floats to the left of the secondary navigation bar. The secondary navigation bar contains user-specific items and changes if a client is logged in to WHMCS. When a client is not logged in then the secondary navigation contains a login link, and when a client is logged in then the secondary menu contains links to the client’s account.

Likewise there are two sidebars on every client area page. The primary sidebar is displayed above the secondary side bar on the left side of the page. Sidebar content varies per page, though the primary sidebar typically displays information directly relevant to the page content while the secondary sidebar usually contains more general links.

<div style="clear: both"></div>

==Responsive mode==

[[Image:Responsive mode.png|thumb|The WHMCS 6.0 client area layout in responsive mode]] Responsive mode is activated when WHMCS’ client area is viewed on a smaller screen device such as a phone or tablet. WHMCS rearranges the page layout in responsive mode for best display on mobile devices.

In responsive mode the primary and secondary navigation bars are displayed above the primary sidebar, followed by the page’s content with the secondary sidebar displayed at the bottom of the page.

<div style="clear: both"></div>

=Menu items=

Menu items are modeled in code by the [https://docs.whmcs.com/classes/7.6/WHMCS/View/Menu/Item.html <tt>\WHMCS\View\Menu\Item</tt>] class. These objects contain all of the information needed to render that menu item within a template, including their parent and child menu item relationships. Menu items can have the following aspects:

* A single parent item
* Multiple optional child items
* A name used to internally refer to the menu item
* A label to display when the item is rendered to the page. If no label is defined, then WHMCS render's the menu item's name
* A URI to link to when the user clicks or taps on a menu item
* An optional icon displayed to the left of the label. WHMCS has access to both the [http://getbootstrap.com/components/#glyphicons Glyphicons] and [http://fortawesome.github.io/Font-Awesome/ Font Awesome] libraries.
* An optional badge displayed to the right of the label, usually used for contextual information, such as the number of tickets in a status next to that statuses' name
* The order that a menu item is displayed in its parent's list of children.

=Menu item arrangement=

==Navigation bars==

[[Image:Navbar item.png|thumb|A client area navigation bar item represented as menu item properties.]] This diagram represents an individual menu item in the navigation bars. All of the menu item’s children are rendered as dropdown menu items. All menu items are rendered with icons to the left of a link to the menu item’s URI followed by the menu item’s badge.

<div style="clear: both"></div>

==Sidebars==

[[Image:Sidebar panel.png|thumb|A client area sidebar panel represented as menu item properties.]] This diagram represents an individual menu item in the sidebars. Unlike the navigation bars this menu item renders a panel in the side bar. Items in the panel rendered by the menu item’s children. Note how body and footer HTML content are also rendered around sidebar panel items. All menu items are rendered with icons to the left of a link to the menu item’s URI followed by the menu item’s badge.

<div style="clear: both"></div>

=Interacting with menus=

==Hooks==

WHMCS 6.0 introduces a number of hooks to allow menu interaction before they’re sent to the template renderer. Use WHMCS’ <tt>add_hook()</tt> function to call custom code when WHMCS reaches these hook points during page generation.

* '''ClientAreaPrimaryNavbar'''
** Called prior to rendering navigation bars.
** Passes the primary navigation bar object to the hook function.
* '''ClientAreaSecondaryNavbar'''
** Called prior to rendering navigation bars.
** Passes the secondary navigation bar object to the hook function.
* '''ClientAreaNavbars'''
** Called prior to rendering navigation bars.
** Passes no parameters to the hook function.
* '''ClientAreaPrimarySidebar'''
** Called prior to rendering sidebars.
** Passes the primary side bar object to the hook function.
* '''ClientAreaSecondarySidebar'''
** Called prior to rendering sidebars.
** Passes the secondary side bar object to the hook function.
* '''ClientAreaSidebars'''
** Called prior to rendering sidebars.
** Passes no parameters to the hook function

==Direct Access==

WHMCS allows direct manipulation of menu objects outside the hooks system for modules and other custom code that don’t use the hooks system. The built-in <tt>Menu</tt> class is an alias to an object repository that can retrieve all of WHMCS’ menu objects. Please note that if the menu isn’t generated by the page yet then an empty menu structure may exist that is overwritten by normal page generation. WHMCS recommends using the hooks system to interact with menus.

The <tt>Menu</tt> class has four static methods to retrieve menus:

* ''Item'' '''Menu::primaryNavbar()'''
** Retrieve the primary navigation bar.
* ''Item'' '''Menu::secondaryNavbar()'''
** Retrieve the secondary navigation bar.
* ''Item'' '''Menu::primarySidebar()'''
** Retrieve the primary sidebar.
* ''Item'' '''Menu::secondarySidebar()'''
** Retrieve the secondary sidebar.

WHMCS employs a number of pre-built sidebars in its built-in pages. These side bars are available to hook and module developers through the <tt>Menu::PrimarySidebar()</tt> and <tt>Menu::SecondarySidebar()</tt> methods. Call either of these methods with the name of the sidebar as the first parameter to retrieve the pre-built sidebar. WHMCS will build the side bar if it isn't already defined. See the table below for the currently defined pre-built sidebars and which pages they are used on.

==Context==

WHMCS’ menus, especially the sidebars, render information specific to the page in the client area that’s being accessed by the user. For instance, client information is passed to '''Account > My Account''' or, prior to WHMCS 8.0, '''My Account'''. Ticket information is passed to the “view ticket page”. This data is passed to menu item objects as context. Context can be any PHP object or data type. The <tt>Menu</tt> class has two static methods for setting and retrieving context items:

* ''void'' '''Menu::addContext(string $key, mixed $value)'''
** Add $value to the menu context at the key $key, overriding existing values.
* ''mixed|null'' '''Menu::context(string $key)'''
** Retrieve the menu context at $key or null if no context exists at the key.

{| class="wikitable"
|+ Pre-set sidebars used per page
|-
! Sidebar name
! Pages used on
! Context
|-
! affiliateView
|
* <tt>affiliates.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
|-
! announcementList
|
* <tt>announcements.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
* ''[[collection]] of [https://github.com/briannesbitt/Carbon \Carbon\Carbon]'': '''monthsWithAnnouncements'''
** The past ten months in which announcements have been published.
|-
! clientAddFunds
|
* <tt>clientarea.php?action=addfunds</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
|-
! clientRegistration
| <tt>register.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
* ''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/User/Client/SecurityQuestion.html \WHMCS\User\Client\SecurityQuestion]'': '''securityQuestions'''
** The configured system security questions.
|-
! clientQuoteList
|
* <tt>clientarea.php?action=quotes</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
|-
! clientView
|
* <tt>clientarea.php</tt>
* <tt>clientarea.php?action=addcontact</tt>
* <tt>clientarea.php?action=changepw</tt>
* <tt>clientarea.php?action=contacts</tt>
* <tt>index.php?rp=/account/paymentmethods</tt>
* <tt>clientarea.php?action=details</tt>
* <tt>clientarea.php?action=emails</tt>
* <tt>clientarea.php?action=security</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
|-
! rowspan="2" | domainList
|
* <tt>clientarea.php?action=domains</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
|-
| colspan="2" | If the <tt>q</tt> request variable is defined, then the client's associated domain counts in the primary sidebar are filtered to those domains whose names contain <tt>q</tt>'s value.
|-
! domainView
| style="white-space:nowrap" |
* <tt>clientarea.php?action=domaincontacts</tt>
* <tt>clientarea.php?action=domaindetails</tt>
* <tt>clientarea.php?action=domaindns</tt>
* <tt>clientarea.php?action=domainemailforwarding</tt>
* <tt>clientarea.php?action=domaingetepp</tt>
* <tt>clientarea.php?action=domainregisterns</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/Domain/Domain.html \WHMCS\Domain\Domain]'': '''domain'''
** The domain that the client is viewing on the page.
|-
! rowspan="2" | downloadList
|
* <tt>dl.php</tt>
* <tt>downloads.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
* ''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/Download/Download.html \WHMCS\Download\Download]'': '''topFiveDownloads'''
** The five most downloaded files that are not hidden or in a hidden download category, ordered by number of downloads in descending order.
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/Download/Category.html \WHMCS\Download\Category]'': '''downloadCategory'''
** The download category the user is currently viewing.
|-
| colspan="2" | The ''topFiveDownloads'' and 'downloadCategory'' contexts are only passed to <tt>download.php</tt>.
|-
! invoiceList
|
* <tt>clientarea.php?action=invoices</tt>
* <tt>clientarea.php?action=masspay</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
|-
! networkIssueList
| <tt>serverstatus.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
* ''array'': '''networkIssueStatusCounts'''
** A key/value pair of network issue statuses and the number of network issues with each status.
|-
! rowspan="2" | orderFormView
| <tt>cart.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
* ''[[collection]] of [http://docs.whmcs.com/classes/7.1/WHMCS/Product/Group.html \WHMCS\Product\Group]'': '''productGroups'''
** A WHMCS installation's configured product groups.
* ''int'': '''productGroupId'''
** The current ''gid'' GET parameter value.
* ''bool'': '''domainRegistrationEnabled'''
** Whether or not WHMCS is configured to register domains.
* ''bool'': '''domainTransferEnabled'''
** Whether or not WHMCS is configured to transfer domains.
* ''bool'': '''domainRenewalEnabled'''
** Whether or not WHMCS is configured to renew domains.
* ''string'': '''domain'''
** When configuring domain options, the name of the domain in the shopping cart.
* ''string'': '''currency'''
** The user's configured currency, or the system currency if no user is logged in. Eg: "USD", "GBP".
|-
| colspan="2" | Only the secondary sidebar is supported on <tt>cart.php</tt>.
|-
! rowspan="2" | serviceList
|
* <tt>clientarea.php?action=hosting</tt>
* <tt>clientarea.php?action=products</tt>
* <tt>clientarea.php?action=services</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
|-
| colspan="2" | If the <tt>q</tt> request variable is defined, then the client's associated service counts in the primary sidebar are filtered to those services whose domain names contain <tt>q</tt>'s value.
|-
! serviceUpgrade
|
* <tt>upgrade.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/Service/Service.html \WHMCS\Service\Service]'': '''service'''
** The service currently being upgraded.
|-
! serviceView
|
* <tt>clientarea.php?action=cancel</tt>
* <tt>clientarea.php?action=productdetails</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/Service/Service.html \WHMCS\Service\Service]'': '''service'''
** The service that the client is viewing on the page.
|-
! sslCertificateOrderView
|
* <tt>configuressl.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/Service/Service.html \WHMCS\Service\Service]|null'': '''service'''
** The service object representing the SSL certificate being ordered
* ''string'': '''orderStatus'''
** The current status of the SSL certificate order
* ''array'': '''displayData'''
** A key/value pair of additional SSL certificate data that is displayed on the page on step two of the order process
* ''int'': '''step'''
** The current step of the order process
|-
! rowspan="2" | support
| ''various''
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
|-
| colspan="2" | The support secondary sidebar is displayed when a contact does not have permission to perform an action in the client area.
|-
! supportKnowledgeBase
|
* <tt>knowledgebase.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in
* ''array'': '''knowledgeBaseTags'''
** An array of knowledge base tags and the number of articles with each tag.
|-
! rowspan="2" | ticketFeedback
|
* <tt>viewticket.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
|-
| colspan="2" | Only used on viewticket.php when a user is entering feedback for a recently closed ticket.
|-
! ticketList
|
* <tt>supporttickets.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
* ''array'': '''ticketStatusCounts'''
** A key/value pair of ticket statuses with the number of tickets in that status.
|-
! ticketSubmit
|
* <tt>submitticket.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
|-
! ticketView
|
* <tt>viewticket.php</tt>
|
* ''[http://docs.whmcs.com/classes/7.1/WHMCS/User/Client.html \WHMCS\User\Client]|null'': '''client'''
** The client currently logged in, or <tt>null</tt> if no client is logged in.
* ''int'': '''ticketId'''
** The id number of the ticket the user is viewing.
|-
|}

=Examples=

==Add a social media panel to the end of the sidebar==

[[Image:Custom social media sidebar panel.png|thumb|The Client Area supports a secondary sidebar with a custom social media panel highlighted.]]

You may want to better connect with your clients by using social media. The menu hooks in WHMCS 6.0 and later allow you to insert links to your company’s Facebook, Twitter, and other social media profiles directly into the interface. We recommend putting them at the end of the secondary sidebar so they’re rendered last and won’t interrupt your users’ experience.

This example uses the <tt>ClientAreaSecondarySidebar</tt> hook and the menu item’s <tt>addChild()</tt>and <tt>moveToBack()</tt> methods. To add panel with links to the sidebar you will need to create a panel at the end of the sidebar, retrieve the new panel, and add social media links to the panel. The Font Awesome library already has icons for all of these services.

To do this:

# Create the <tt>includes/hooks/socialMediaPanel.php</tt> file in your WHMCS installation.
# Enter the code below.
# Save the file.
# Reload your WHMCS installation’s Client Area.

WHMCS automatically loads all hooks the <tt>includes/hooks</tt> directory. The <tt>SecondarySidebar</tt> hook is registered with <tt>add_hook()</tt> and is consequently loaded every time WHMCS renders the secondary sidebar on page load.

<div style="clear: both"></div>

<syntaxhighlight lang="php">
<?php

use WHMCS\View\Menu\Item as MenuItem;

// Add social media links to the end of all secondary sidebars.
add_hook('ClientAreaSecondarySidebar', 1, function (MenuItem $secondarySidebar)
{
// Add a panel to the end of the secondary sidebar for social media links.
// Declare it with the name "social-media" so we can easily retrieve it
// later.
$secondarySidebar->addChild('social-media', array(
'label' => 'Social Media',
'uri' => '#',
'icon' => 'fas fa-thumbs-up',
));

// Retrieve the panel we just created.
$socialMediaPanel = $secondarySidebar->getChild('social-media');

// Move the panel to the end of the sorting order so it's always displayed
// as the last panel in the sidebar.
$socialMediaPanel->moveToBack();

// Add a Facebook link to the panel.
$socialMediaPanel->addChild('facebook-link', array(
'uri' => 'https://facebook.com/our-great-company',
'label' => 'Like us on Facebook!',
'order' => 1,
'icon' => 'fab fa-facebook-f fa-fw',
));

// Add a Twitter link to the panel after the Facebook link.
$socialMediaPanel->addChild('twitter-link', array(
'uri' => 'https://twitter.com/ourgreatcompany',
'label' => 'Follow us on Twitter!',
'order' => 2,
'icon' => 'fab fa-twitter fa-fw',
));
});
</syntaxhighlight>

==Add a special offer image and link to the top of the topmost sidebar==

[[Image:Custom panel body html highlighted.png|thumb|The WHMCS 6 client area announcements sidebar panel with a custom special offer highlighted.]] Your web host is doing amazing and to celebrate is offering a discount to all users. The marketing folks want a small image and message in the top of the first sidebar panel on every page that links to a page with the special offer.

This example uses the '''ClientAreaPrimarySidebar''' hook and the menu item’s <tt>getFirstChild()</tt> and <tt>setBodyHtml()</tt> methods. To add panel with links to the sidebar we must:

# Get the first panel from the primary sidebar.
# Set the panel’s body HTML.

Create the <tt>includes/hooks/specialOfferInSidebar.php</tt> file in your WHMCS installation and enter the code below. As with the previous example the new file and hook within the file is run on page load and adds the image and link to the topmost panel in the primary sidebar, no matter which page the client is accessing.

<div style="clear: both"></div>

<syntaxhighlight lang="php">
<?php
use WHMCS\View\Menu\Item as MenuItem;

add_hook('ClientAreaPrimarySidebar', 1, function (MenuItem $primarySidebar)
{
// The HTML for the link to the the special offer.
$specialOfferHtml = <<<EOT
<a href="//myawesomecompany.com/special-offer/">
<img src="/assets/img/catdeals.png" alt="Click here for amazing deals!">
Kitten says <strong><em>thanks</em></strong> for making us the best web host!
</a>
EOT;

if($primarySidebar->count() > 0)
{

// Add a link to the special to the first panel's body HTML. It will render
// above the panel's menu item list.
$firstSidebar = $primarySidebar->getFirstChild();

$firstSidebar->setBodyHtml($specialOfferHtml);

}
});

</syntaxhighlight>

==Move the “Contact Us” link to the secondary navigation bar and add more contact options==

[[Image:Custom navbar menu highlighted.png|thumb|The WHMCS 6 client area navbars with the Contact Us link moved to the secondary navbar with a custom dropdown menu.]] The graphic designer feels that our awesome hosting company’s WHMCS installation will more closely match the main site if the “Contact Us” link is moved to the right hand side of the installation’s navigation bars before the “Account” link. They also want a dropdown under the link with links specifically to email the sales team, call us, and provide a map to the company via Google Maps.

This example requires manipulating more than one menu bar. To do that we’ll use the '''ClientAreaNavbars''' hook and the <tt>Menu</tt> class to retrieve the primary and secondary navigation bars. We’ll use the menu item’s <tt>getChild()</tt>, <tt>removeChild()</tt>, <tt>addChild()</tt>, and <tt>moveToFront()</tt> methods and the static <tt>Menu::primaryNavbar()</tt> and <tt>Menu::secondaryNavbar()</tt> methods. Here’s what we’ll do:

# Save the “Contact Us” link from the primary navigation bar.
# Remove the “Contact Us” link from the primary navigation bar.
# Add an email link child to the “Contact Us” link.
# Add a phone link child to the “Contact Us” link.
# Add a map link child to the “Contact Us” link.
# Add the “Contact Us” link to the secondary navigation bar then move it to the beginning of the menu.

Create the <tt>includes/hooks/moveContactUsLink.php</tt> file in your WHMCS installation and enter the code below. As with the other examples this hook file is picked up on page load and rearranges the navigation bars with the appropriate dropdown items.

<div style="clear: both"></div>

<syntaxhighlight lang="php">
<?php

add_hook('ClientAreaNavbars', 1, function ()
{
// Get the current navigation bars.
$primaryNavbar = Menu::primaryNavbar();
$secondaryNavbar = Menu::secondaryNavbar();

if (!is_null($primaryNavbar->getChild('Contact Us'))){

// Save the "Contact Us" link and remove it from the primary navigation bar.
$contactUsLink = $primaryNavbar->getChild('Contact Us');
$primaryNavbar->removeChild('Contact Us');

// Add the email sales link to the link's drop-down menu.
$contactUsLink->addChild('email-sales', array(
'label' => 'Email our sales team',
'uri' => 'sales@my-awesome-company.com',
'order' => 1,
'icon' => 'far fa-gem',
));

// Add the call us link to the link's drop-down menu.
$contactUsLink->addChild('call-us', array(
'label' => 'Call us',
'uri' => 'tel:+18005551212',
'order' => 2,
'icon' => 'fas fa-mobile-alt',
));

// Add the map to the company to the link's drop-down menu.
$contactUsLink->addChild('map', array(
'label' => '123 Main St. AnyTown, TX 11223, USA',
'uri' => 'https:\/\/maps.google.com/maps/place/some-map-data',
'order' => 3,
'icon' => 'fas fa-map-marker-alt',
));

// Add the link and its drop-down children to the secondary navigation bar.
$secondaryNavbar->addChild($contactUsLink);

// Make sure the contact us link appears as the first item in the
// secondary navigation bar.
$contactUsLink->moveToFront();
}});
</syntaxhighlight>

==Add support hours and a custom message to the sidebar on the submit ticket page==

[[Image:Custom support hours panel.png|thumb|The WHMCS 6 submit ticket page in responsive mode with support hours and a custom message in the primary sidebar.]] Your business has really taken off, and it's finally time to hire someone to help answer support tickets and sales inquiries. The new hire can't work 24 hours a day, 7 days a week, so it's time to implement official support hours. Your UX people feel that it's best to notify your users of these support hours on the submit ticket page, but only the submit ticket page. They'd like the hours at the top of the primary sidebar, so they're in plain view for the users. They'd also love it if we could notify the users that they can expect a reply from us soon or if they have to wait until the next business day.

Since the powers that be want this to appear at the top of the sidebars we'll manipulate the primary sidebar via the '''ClientAreaPrimarySidebar''' hook. We’ll use the menu item’s <tt>addChild()</tt>, <tt>moveToFront()</tt>, and <tt>setBodyHtml()</tt> methods to add the new panel. The special message to the user addresses the logged in user by first name. Every sidebar has a "client" context available which contains the record of the client that is logged in or ''null'' if no client is logged in. The <tt>Menu::context()</tt> method will retrieve the client record for us. If the client is logged in then we'll use the client object's <tt>firstName</tt> property to address the user by name. Version 6.0 uses the very helpful [https://github.com/briannesbitt/Carbon Carbon date library] internally. Carbon is available to third party developers, so we'll use it to determine if support is currently open. Here’s what we’ll do:

# Determine if the user is visiting <tt>submitticket.php</tt>.
# Add a "Support Hours" panel to the primary sidebar and move it to the front so it displays at the top.
# Create child items in the support hours panel saying when support is open and closed.
# Determine if support is currently open.
# If there is a user logged in then determine their first name.
# Assign the support hours' panel body HTML to a special message depending on the logged in user's first name and whether support is currently open.

Create the <tt>includes/hooks/addSupportHours.php</tt> file in your WHMCS installation and enter the code below. As with the other examples this hook file is picked up on page load and adds the custom panel and message to the primary sidebar before the submit ticket page renders.

<div style="clear: both"></div>

<syntaxhighlight lang="php">
<?php

use Carbon\Carbon;
use WHMCS\View\Menu\Item as MenuItem;

// Add a helpful support hours notice to the top of the sidebar on the submit
// ticket page.
if (App::getCurrentFilename() == 'submitticket') {
add_hook('ClientAreaPrimarySidebar', 1, function (MenuItem $primarySidebar)
{
// Create the support hours panel and make sure it's the first one
// displayed.
/** @var MenuItem $supportHours */
$supportHours = $primarySidebar->addChild('Support Hours');
$supportHours->moveToFront();

// Add hours to the panel.
$supportHours->addChild(
'<strong>Open</strong> 08:00-17:00 M-F',
array(
'icon' => 'far fa-smile',
'order' => 1,
)
);
$supportHours->addChild(
'<strong>Closed</strong> Weekends',
array(
'icon' => 'far fa-frown',
'order' => 2,
)
);

// Add a custom notice to the support hours panel with the logged in
// client's first name and a different message depending on whether
// support is open.
/** @var \WHMCS\User\Client $client */
$client = Menu::context('client');
$greeting = is_null($client)
? ''
: ", <strong>{$client->firstName}</strong>";

$now = Carbon::now();
$supportIsOpen = $now->isWeekday()
&& $now->hour >= 8
&& $now->hour <= 17;

$supportHours->setBodyHtml(
$supportIsOpen
? "Hi{$greeting}! We're open and will respond to your ticket soon!"
: "Don't worry{$greeting}! We will respond on the next business day. Sit tight!"
);
});
}
</syntaxhighlight>

Migration Guide

2021-03-09T14:25:55Z

DanR: /* Adding Domains */

We understand that the majority of companies already have a billing system in place to manage their hosting clients and worry about the difficulties of switching to a new billing system. With that in mind, we provide the following guides and automation scripts in order to make importing easy.

<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Migration Services:</b> Contact our team to discuss our migration services.</small></em><span class="button">Services</span></a></html>

==ImportAssist==

[[File:import_assist_banner_2.png|link=https://marketplace.whmcs.com/product/46]]

When performing a migration from another billing system or WHMCS installation, we recommend using our ImportAssist addon, which supports importing data from multiple billing systems. At this time, this supports the following systems:

* WHMCS Version 6.2.x, 6.3.x, 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x, 7.5.x, 7.6.x, 7.7.x
* Blesta Version 2.x, 3.x
* ClientExec Version 5.3+
* HostBill 2016 Version

For detailed information on obtaining and using ImportAssist, see [[ImportAssist]].

==Server Sync Tool==

<div class="docs-alert-info">This section refers to a new feature in WHMCS 7.8. To import services from a cPanel & WHM server when using WHMCS 7.7 and older, see the cPanel & WHM Import section below.</div>

In WHMCS 7.8, we've introduced a new Server Sync Tool that can compare and sync details from cPanel, Plesk and DirectAdmin servers. This is particularly useful for performing an initial import when first starting with WHMCS, but you can also use it for other purposes, such as identifying and importing missing domains, syncing usernames and package information, and terminating inactive domains.

For detailed information on how it works and how to use it, see [[Server_Sync_Tool|Server Sync Tool]].

==cPanel & WHM Import Script==

When using WHMCS 7.7 or older, you can access the WHM Import Tool using the Utilities menu. This will allow you to import all the domains from your existing cPanel & WHM servers. For more information and steps, see [[CPanel/WHM_Import|CPanel/WHM Import]].

==Manual Entry==

We understand that the ImportAssist addon and Server Sync Tool may not always meet your needs for adding clients and their items (for example, when you need to add a client manually and there is no associated hosting account or domain registrar for their items). In these circumstances, it is possible to add clients and their items manually via the admin area using the instructions below.

===Adding Clients===

To manually import your clients, use the following steps for each client:

#Go to Clients > Add New Client.
#Fill out the client details. You must provide, at least, the first and last names, email address, and password.
#Optionally, deselect the checkbox to send a New Account Information Message.
#Click Add Client.

You have now finished adding your client. However, the system will not automatically notify your client that you added them. You can now add the applicable items to their account in the section below.

===Adding Services===

Once you have added the clients, you can proceed to add their services (such as hosting accounts). Perform the following steps for each client:

#On the Client Summary page, click "Add New Order" in the "Actions" panel.
#The system will preselect the client. Fill out the rest of the form, beginning with choosing the payment gateway you want their future invoices to use.
# Choose the applicable product or service and the billing cycle.
# If the service has an associated domain name, enter it in the textbox. If you also control the domain name registration, select "Register" on the domain section below and choose any addons the user has for their domain.
#Deselect the boxes for ''Order Confirmation'' and ''Generate Invoice''. This will ensure that the system doesn't email the client about the order you are adding.
#Select Active from the Order Status menu. Then, click Submit to add the order to WHMCS.
The system will display the order details page, which will summarise the details of the order you added.

As the final step, go into the service details and set the correct next due date. To do this from the order details page, click on the link in the "Item" column of the items ordered. This will take you to the service details page. From there, you can edit the next due payment date. For hosting accounts, select the correct server and enter the username for the account to allow WHMCS to perform suspensions and terminations.

===Adding Domains===

To add a domain without a product:

#On the Client Summary page, click the '''Add New Order''' link in the '''Actions''' panel. The system will preselect the client.
# Now you need to fill out the rest of the form, beginning with choosing the payment gateway for future invoices to use by default.
#Select '''Active''' from the '''Order Status''' menu.
#Deselect the checkboxes for sending an order confirmation and generating an invoice. This will ensure that the client is not emailed about the order you are adding and no invoice is raised.
#Select '''Registration''' for the domain registration type. The domain fields will then be shown.
#Enter the domain in the '''Domain''' field.
#Choose the number of years you want to invoice the client for at the time of renewal.
#Select any addons that the user has for their domain such as DNS Management.
#Now, click '''Submit''' to add the order to WHMCS. The system will display the order details page, which will summarise the details of the order you added.

Finally, now the domain is added into WHMCS you should ensure the next due date, expiry date, and the domains registrar is set correctly.

To do this from the order details page, click the '''Domain''' link in the "Item" column. This will take you to the domain details page. You can now select the domain registrar, set the correct next due and expiry dates, and then click '''Save Changes'''.

Cancellation Requests

2021-02-23T17:41:46Z

DanR:

Cancellation Requests enable your clients to let you know when they no longer wish to continue their service and can ensure services are automatically terminated when no longer required.

===Enabling Cancellation Requests===
In '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' under "Miscellaneous" there is an option for "Cancellation Requests". Once enabled accounts will automatically be terminated when the Cancellation Request becomes due.

===Show Cancellation Link===
When you enable the '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Other Tab > [[Other_Tab#Show_Cancellation_Link|Show Cancellation Link]]''' option a link will be shown in the client area so your clients can place a Cancellation Request automatically.

Customers can request cancellation from the product details page. The Cancellation Request will actioned then appear in '''Clients > Cancellation Requests''' along with an email notification and will be processed automatically when the cron runs. For more information [[Products_Management#Cancelling_a_Product.2FService|refer to this page]].

Once a Cancellation Request is placed and/or the termination date is set, WHMCS will automatically terminate the client's package on the termination date.

===Invoices after Cancellation===
When enabled, any unpaid invoices for a service will be cancelled automatically when a client submits a cancellation request. If the service renewal has been invoiced with other items only the cancelled item will be removed from the invoice. Any discounts or group discounts that apply to the cancelled service will be removed as well.

===Manual Cancellation===
If the Cancellation Request setting is '''not''' enabled then at this point you must navigate to the cancellation requests page, click through to the service page and click the '''Terminate''' module command button to remove the account from the server. The cancellation request is then moved from the ''Open Requests'' page to ''Completed Requests''.

===Automated Cancellation===
If the Cancellation Request setting '''is''' enabled the cancellation request will be actioned when the daily automation cron runs on the appropriate day. For example if the ''Immediate'' option was selected it will be terminated on the next cron run; if ''End of Billing Period'' was selected it will be terminated when the cron runs on the service's Next Due Date.

===Voiding Cancellation Requests===
If a Cancellation Request has been submitted by your client and they later change their mind, it is quick and easy to void their cancellation request. Simply navigate to '''Clients > Cancellation Requests''', locate the cancellation you wish to remove, and then click the red X next to the request to remove it. This will stop the cancellation from processing automatically. You'll need to make sure to mark any invoices that were cancelled as "Unpaid" to prevent billing errors.

===Admin Scheduled Cancellations===
As an admin user, you can schedule the termination of a product at the end of the currently active period by going to the Products/Services tab, ticking the '''Auto-Terminate End of Cycle''' option and optionally entering a reason/note for it. Any unpaid invoices for the product will be cancelled and will suppress any further renewal invoices from generating for this product and terminate it when the next due date is reached.
The "Cancellation Requests" setting in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' or, prior to WHMCS 8.0, '''Setup > Automation Settings''' must also be enabled.

===Admin Immediate Cancellation===
If you want to cancel or terminate a product or service immediately then you simply need to locate the item you wish to cancel and from the Products/Services page and click the '''Terminate''' button if the product is linked to a module. If it is not linked to a module, you should manually change the dropdown status from Active to '''Cancelled'''. Once you've done this, no further invoices will generate for the item.

Licensing

2021-01-28T13:18:18Z

DanR: /* Changing the License Key WHMCS uses */

==Moving WHMCS==
When you move your WHMCS system, if the domain, IP address, or directory you use it in is changing, you must update your license. The method to use depends on the license you have:

===1. You purchased your license directly from us===

If you purchased your license from us directly, you can reissue your license from [http://whmcs.com/members|our client area] without any manual intervention from us. To do this, log in, go to Services > My Licenses, select your license key, and click '''Reissue''' under the Management Actions tab. Then, visit your WHMCS installation in the new location. The system will save the new valid access details.

===2. You obtain your license from your web host===

If you received your license from your hosting provider, you can't reissue your license from our client area. This is because the domain and IP address cannot change. Contact your hosting provider to have them update the license for use at the new location. If you are moving to a different hosting provider, you cannot move your license key with you and you will require a new license key for use at the new location.

To move WHMCS:

* Disable or remove the WHMCS cron jobs from the old server. This prevents automation from running and making changes.
* Create a backup of your database [[Maintenance#Backing_up_your_WHMCS_Database|following these instructions]].
* Make sure the new server meets the [[System_Requirements|system requirements]].
* Transfer the files to the new server.
* [[Maintenance#Restoring_a_Database_Backup|Restore the database]] via phpMyAdmin on the new server and make any changes to the database settings in <tt>configuration.php</tt>.
* Reissue your license using the steps above.
* Log in to your WHMCS admin area and update the system URLs in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
* Check whether the system properly modified your cron jobs, payment gateway callbacks, and email forwarders.
* Update your [[Further Security Steps#Secure_the_Writeable_Directories|custom directory locations]].
* Update your [[Moving_Storage_Locations|storage locations]].
* Delete the WHMCS files from the old location.

<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Transfer Services:</b> Have our team transfer your WHMCS installation.</small></em><span class="button">Services</span></a></html>

==Changing the License Key WHMCS uses==

To change the license key your WHMCS system uses, log in to the admin area and go to '''Help (<i class="fa fa-question-circle" aria-hidden="true"></i>) > License Information''' or, prior to WHMCS 8.0, '''Help > Change License Key'''. Enter your new license key and admin login details to verify the change. If can't log in due to a license invalid error, use the link to the change license page from the license error page.

==Is licensing dependant on whmcs.com being online?==

No. WHMCS uses a local key licensing system with periodic remote verification checks. Once every seven days, your WHMCS system will contact our server to ensure it is being run in the correct location and that the license is still valid. Whether your WHMCS system is online is not dependant on our server being online during the time the local key is valid.

If our licensing server is unavailable on the day of your next verification check, the system will allow up to three days to make a connection. If, after this time, the system still can't verify your license with our licensing server, your WHMCS Admin Area will become inactive until WHMCS can contact our server again.

Your WHMCS Client Area will always remain online, even if you have an invalid or expired license, to ensure your clients have uninterrupted access.

==Common Errors==

<div class="docs-alert-info">
For information on troubleshooting common licensing errors, see [[License Troubleshooting]].
</div>

Products and Services

2021-01-26T13:31:08Z

DanR: /* Details */

Configure products via '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.

For basic instructions for creating your first product group and product, see [[Setting Up Your First Product]].

<html><a href="https://www.youtube.com/watch?v=sUpr2dHOUrg" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>
<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Configuration Service:</b> Have our team configure WHMCS for you.</small></em><span class="button">Services</span></a></html>

==Product Groups==
Product groups organize products on the order form. Each group has a separate page, so you can split products into categories or across several pages for ease of display. For example, you may wish to list your shared hosting plans separately from reseller plans. Clients can switch between groups on the order form or you can link to them directly (see [[#Links Tab| Links]] below).

To create a product group:

#Click '''Create a New Group'''.
#Enter a '''Product Group Name'''. This will display on the order form.
#Use the '''URL''' that WHMCS generated from the group name, or enter your desired '''URL'''.
#Enter a '''Product Group Headline''' and '''Product Group Tagline'''.
#If you want to use a different template from the default for this group, select an '''Order Form Template'''. Normally, all product groups use the system default order form template in '''General Settings'''.
#Check the '''Available Payment Gateways''' to offer on the checkout page for products in this group.
#Check '''Hidden''' to hide the group on the order form.
#Click '''Save Changes'''.

To edit the group at a later date, click the corresponding edit icon in the '''Products/Services''' list.

To customize display sorting, see [[Products_and_Services#Sorting|Sorting]].

==Products==
To create a new product:
#Click '''Create a New Product'''.
#Choose a '''Product Type'''.
#Choose the '''Product Group''' that you just selected.
#Enter a '''Product Name'''.
#Select a '''Module'''. For example, for hosting plans hosted on a Plesk server, select ''Plesk''.
#Toggle '''Create as Hidden''' to hide or show the product on the client-side order form.
#Click '''Continue''' and then configure the tabs on the page that appears. For more on these tabs, see the sections below.
#After you configure the additional tabs, click '''Save Changes'''.

To edit the product at a later date, click the corresponding edit icon in the '''Products/Services''' list.

To customise display sorting, see [[Products_and_Services#Sorting|Sorting]].

===Details===
'''Details''' contains general information about a product, including its name and product group:

* '''Product Type''', '''Product Group''' and '''Product Name''' — See the [[#Products|Products]] section above.
* '''Product Description''' — The detailed information that relates to this product on the order form.
** The system maintains line breaks when you format a description.
** When using HTML, we recommend avoiding new lines unless you want them to appear in the end result.
** When the <tt>key: value</tt> format is used in the description the [[Standard_Order_Form_Templates#Feature_Highlights|Feature Highlights]] styling will be applied.
* '''Welcome Email''' — The email template to send when activating the product. You can create custom email templates to use on different products. For more information, see [[Email Templates]].
* '''Require Domain''' — The domain registration option on ordering. You should always enable this for hosting and disable it for other products that don't require a domain name.
* '''Stock Control''' — The available quantity of an item (for example, servers) or a limited special-offer product. Check this to enable the limit, and then enter the remaining quantity. WHMCS will stop orders when it reaches zero.
* '''Apply Tax''' — Whether to apply tax rules to this product. For more information, see [[Tax Configuration|Tax/VAT Rules]].
* '''Featured''' — Display a product more prominently on some supported order forms.
* '''Hidden''' — Whether to show the product on the order form. Customers will still be able to order this using the direct order links.
* '''Retired''' — Whether to hide the product from admin area menus, like the product menu in the client's profile.

===Pricing===
'''Pricing''' lets you specify the prices and duration of the product.

[[File:Price grid.png|thumb|Price Grid]]

*'''Payment Types''' — Select '''Free''', '''One Time''', or '''Recurring'''. If you select '''One Time''' or '''Recurring''', the pricing grid will appear. Enable each billing cycle by checking '''Enable'''.
**For '''One Time''' products, enable '''One Time/Monthly''' and enter your prices into that column.
**For '''Recurring''' products, check '''Enable''' for the billing cycles that you want to offer with the product.
**For '''Setup Fee''' in each column, enter any setup fees for a given billing cycle. For example, you may charge setup fees on monthly cycles and offer free setup for yearly cycles.
*'''Allow Multiple Quantities''' — Select whether clients can order multiples of this product on the checkout page. The product cannot require additional configuration (like product custom fields or configurable options).
** ''No'' — Disables the option to specify a quantity for this product.
** ''Yes - Multiple Services'' — Each unit represents its own individual service instance. For example, specifying a quantity of 10 will create 10 service records upon ordering, each with its own price (Recurring Amount).
** ''Yes - Scaling Service'' — Each service instance allows a quantity to be defined. For example, specifying a quantity of 10 will create one service, with the service price (Recurring Amount) multiplied by the numbers of units specified.
*'''Recurring Cycles Limit''' — For '''Recurring''' payment types, the default value (<tt>0</tt>) will invoice indefinitely until cancelled. However, by entering a value in this field, you can limit the number of times this product will invoice the client. For example, entering <tt>5</tt> on a monthly product would keep the system from generating an invoice in the 6th month after ordering.
*'''Auto Terminate/Fixed Term''' — You can set up products that automatically terminate after a set number of days from the service's registration date.
**To enable this, enter the number of days to wait before terminating and choose an email template to send to the client when the termination occurs (for example, an up-selling email to promote your paid products in the case of a trial, or confirmation of payment completing for installment payments). Set '''Auto Terminate/Fixed Term''' to 0 to disable this feature.
**Entering a number in this field terminate the product when the cron job runs that many days after the product registration date.
**Use this to offer free trial products for a certain period of time or time-limited products that should only recur for a certain number of cycles before stopping.
*'''Termination Email''' — If you entered an '''Auto Terminate/Fixed Term''' value, select an email to send to the client at product termination.
<div class="docs-alert-info">
<span class="title">Note:</span><br />
'''Termination Email''' only includes custom product-type email templates. For more information on creating a custom email template, see [http://docs.whmcs.com/Email_Templates Email Templates].
</div>
*'''Prorata Billing''' — This allows you to bill products on a specific day of the month and charge a prorata amount at the initial time of order. If you check this, the system will charge all clients on one specific day each month. Otherwise, the product will use the default anniversary billing system (for example, Jun 15–Jul 15). Changes to this setting apply to new orders only.
<div class="docs-alert-info">
<span class="title">Note:</span><br />
Prorata billing is not compatible with the free domain logic or having domain renewal invoices that the system generates further in advance than other products.
</div>
*'''Prorata Date''' — The specific billing date for all sales of the product. If you set this to <tt>1</tt>, the system will charge all clients on the 1st of each month.
*'''Charge Next Month''' — After this day of the month, the system will also charge a client for the next month in their initial payment when signing up on a monthly billing cycle.
**If you don't enable this, if you have set the prorata date to 1, and a client signs up on the 30th of the month, they would only pay a small amount.
**If you enable this, they would pay the prorated amount plus the next month in advance.
**To prorate a product but not to enable this feature, set '''Prorata Date''' to a normal value and '''Charge Next Month''' to <tt>32</tt>.

===Module Settings===

This tab specifies which server type the product will use and how WHMCS will behave when someone orders this product.

*From '''Module Name''', select the type of server you're using. If a product has no specific module to link to, set it to ''[[Auto_Release|Autorelease]]'' to simulate activation and send a welcome email.
*Select your desired options. The options you will see depend on your module. For more information about each module, see the [[Server_Modules|Provisioning Modules]] section.
*Select one of the four automation settings for product activation:
**'''Automatically setup the product as soon as an order is placed''' — Set it up instantly. Usually, you would use this for free products.
**'''Automatically setup the product as soon as the first payment is received''' — Perform the setup as soon as the customer pays for the order.
**'''Automatically setup the product when you manually accept a pending order''' — Perform the setup only when an admin has manually reviewed and accepted the order.
**'''Do not automatically setup this product''' — Never auto-set-up the product. Admins can still initiate manually from the product details page under a clients profile.

====Metric Billing====
[[File:Usage-billing-module-settings-metric-config.png|thumb|]]

<div class="docs-alert-info">
<span class="title">Metric Billing</span><br />
'''Metric Billing''' displays in '''Module Settings''' when you select a module that supports this feature (WHMCS version 7.9 and above).
</div>

To enable a metric for billing or display purposes, set the toggle to '''On'''. If you enable a metric, it will appear within the client's product details view of the client area. An admin will always see all metrics, enabled or disabled, within the admin area when viewing a service for a product that reports metrics.

To configure pricing for a metric, click '''Configure Pricing''' for that metric.

For usage and configuration instructions, see [[Usage Billing]].

===Custom Fields===

From this tab you can create custom fields for this product. This allows you to collect additional order form information that you need to supply the product.

*Field types consist of text boxes, menus, checkboxes, link or URL fields, and password fields. Text in password fields appears as asterisks (<tt>****</tt>).
*You can set fields as admin-only for private data, required or optional on the order form, displayed on the order form, displayed in the client area, or displayed on invoices (such as VAT numbers).

For more information, see [[Custom_Fields|Custom Fields]].

===Configurable Options===

Use this tab to select the configurable options to associate with the product. You can display them on the order form or in the client area. '''Configurable Options''' are options that alter the price of the product.

For more information, see [[Addons_and_Configurable_Options|Addons and Configurable Options]].

===Upgrades===

This tab allows you to specify whether the client can upgrade or downgrade from this product to another. WHMCS can fully automate upgrades and downgrades for many of the modules.

*Select the products that the product can be upgraded or downgraded to.
*Use <tt>Ctrl+Click</tt> to select multiple products.
*Check '''Configurable Options''' to enable upgrading configurable options, if there are any on the product.
*Select an '''Upgrade Email''' template to use when a client upgrades to this product. You will first need to create a new product email template under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Email Templates'''.

For more information about how WHMCS calculates and processes upgrades and downgrades, see [[Automated_Upgrades_and_Downgrades|Automated Upgrades and Downgrades]].

===Free Domain===
Use this tab to configure the offer of a free domain with a product. WHMCS lets you offer free domains with your packages when customers purchase them with certain payment terms. For example, you might want to offer a free domain when someone purchases a package annually.

*For '''Free Domain''', choose whether and how to offer a free domain.
*Select one or more '''Free Domain Payment Terms''' to set the billing cycles that are required for a product to receive a free domain.
*Select one or more '''Free Domain TLDs''' to set which TLDs can be used for a free domain.

For more information on how to configure this, see [[Domains_Configuration#Offering_Free_Domain_Registration_with_Selected_Packages|Offering Free Domain Registration]].

===Other===
The penultimate tab contains miscellaneous settings such as product affiliate rates, product downloads, and overage billing.

*'''Custom Affiliate Payout''' — The custom payout rate for this specific product if it's using the built-in affiliate system. This setting overrides or disables the system default commission rate.
*'''Affiliate Pay Amount''' — The percentage or amount paid for a purchase of this product, depending on your choice for the setting above.
*'''One Time Payout''' — Check this to pay only a one-time commission.
*'''Subdomain Options''' — Enter a domain in the format ".yourdomain.com" if you want to offer a free subdomain option for the domain at signup. You can offer more than one by entering a comma separated list (for example, ".yourdomain.com,.yourdomain.net").
*'''Associated Downloads''' — The files to automatically release to the customer when the product is activated.
**Click '''Add Category''' to create a new category of downloads.
**Click '''Quick Upload''' to upload a new file.
**See [[Product Downloads Distribution]] for more information.
*'''Overages Billing''' — Enables billing for the product based on disk and bandwidth usage for the month. Refer to [[Disk Space and Bandwidth Overage Billing]] for more information.
*'''Soft Limits''' — Enter the soft limits for '''Disk Usage''' and '''Bandwidth'''.
*'''Overage Costs''' — Enter the overage costs for '''Disk Usage''' and '''Bandwidth'''.

===Links tab===
This tab contains the URLs to link to for this product.

*Each URL will add the product to the shopping cart and jump straight to the configuration step.
*There are many more possible variations. For more information, see [[Linking to WHMCS]].

==Sorting==

Groups and products are sortable using the crosshair icon on the appropriate row. This is on the left for groups and the right for products.

[[File:Drag_and_drop_sorting.png|center|850x250px]]

After moving, a success message will appear on the top right of the page to confirm that the system saved the sort order. It is not possible to move products between groups using the drag-and-drop method.

==Feature Highlights==

'''Feature Highlights''' allow you to define features and their values for products in a way that WHMCS can interpret for comparison-based display.

The system supports '''Feature Highlights''' for most order form templates. For more information, see [[Standard_Order_Form_Templates#Templates|Standard Order Form Templates]].

Domain Categories

2021-01-20T10:50:28Z

DanR: /* Sample whois.json Override File */

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.10 and above.</div>

==What are domain categories?==

Domain Categories are used in the client area to group domain TLDs into categories such as "Popular", "Shopping", or "Real Estate" and makes it easier for clients to navigate and find their ideal domain extension.

==How do I customise the domain categories?==

The domain categories shipped with WHMCS by default can be found in ''/resources/domains/dist.categories.json''. This file should '''not''' be edited.

To add or edit domain category definitions, begin by creating a custom categories.json file located at ''/resources/domains/categories.json''

Inside it, define the domain categories you wish to use. This file will remain in place when updating WHMCS.

TLDs can appear in multiple categories, for example, a UK-based company might include .UK and .CO.UK TLDs in the "Popular" category as well as a "Local Geographic" category.

Below is a sample custom categories.json file defining the domain category "Awesome Domains" with the ".whmcs" and ".whmcstest" domain TLDs.

===Sample categories.json Override File===
<source lang="yaml">

{
"Awesome Domains": [
".whmcs",
".whmcstest"
]
}

</source>

A domain category definition is simply the category name, with an array of the domain TLDs which should be included in that category.

Products and Services

2021-01-19T15:54:36Z

DanR: /* Details */

Configure products via '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.

For basic instructions for creating your first product group and product, see [[Setting Up Your First Product]].

<html><a href="https://www.youtube.com/watch?v=sUpr2dHOUrg" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>
<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Configuration Service:</b> Have our team configure WHMCS for you.</small></em><span class="button">Services</span></a></html>

==Product Groups==
Product groups organize products on the order form. Each group has a separate page, so you can split products into categories or across several pages for ease of display. For example, you may wish to list your shared hosting plans separately from reseller plans. Clients can switch between groups on the order form or you can link to them directly (see [[#Links Tab| Links]] below).

To create a product group:

#Click '''Create a New Group'''.
#Enter a '''Product Group Name'''. This will display on the order form.
#Use the '''URL''' that WHMCS generated from the group name, or enter your desired '''URL'''.
#Enter a '''Product Group Headline''' and '''Product Group Tagline'''.
#If you want to use a different template from the default for this group, select an '''Order Form Template'''. Normally, all product groups use the system default order form template in '''General Settings'''.
#Check the '''Available Payment Gateways''' to offer on the checkout page for products in this group.
#Check '''Hidden''' to hide the group on the order form.
#Click '''Save Changes'''.

To edit the group at a later date, click the corresponding edit icon in the '''Products/Services''' list.

To customize display sorting, see [[Products_and_Services#Sorting|Sorting]].

==Products==
To create a new product:
#Click '''Create a New Product'''.
#Choose a '''Product Type'''.
#Choose the '''Product Group''' that you just selected.
#Enter a '''Product Name'''.
#Select a '''Module'''. For example, for hosting plans hosted on a Plesk server, select ''Plesk''.
#Toggle '''Create as Hidden''' to hide or show the product on the client-side order form.
#Click '''Continue''' and then configure the tabs on the page that appears. For more on these tabs, see the sections below.
#After you configure the additional tabs, click '''Save Changes'''.

To edit the product at a later date, click the corresponding edit icon in the '''Products/Services''' list.

To customise display sorting, see [[Products_and_Services#Sorting|Sorting]].

===Details===
'''Details''' contains general information about a product, including its name and product group:

* '''Product Type''', '''Product Group''' and '''Product Name''' — See the [[#Products|Products]] section above.
* '''Product Description''' — The detailed information that relates to this product on the order form.
** The system maintains line breaks when you format a description.
** When using HTML, we recommend avoiding new lines unless you want them to appear in the end result.
** When using "key: value" format is used in description the [[Standard_Order_Form_Templates#Feature_Highlights|Feature Highlights]] styling will be applied.
* '''Welcome Email''' — The email template to send when activating the product. You can create custom email templates to use on different products. For more information, see [[Email Templates]].
* '''Require Domain''' — The domain registration option on ordering. You should always enable this for hosting and disable it for other products that don't require a domain name.
* '''Stock Control''' — The available quantity of an item (for example, servers) or a limited special-offer product. Check this to enable the limit, and then enter the remaining quantity. WHMCS will stop orders when it reaches zero.
* '''Apply Tax''' — Whether to apply tax rules to this product. For more information, see [[Tax Configuration|Tax/VAT Rules]].
* '''Featured''' — Display a product more prominently on some supported order forms.
* '''Hidden''' — Whether to show the product on the order form. Customers will still be able to order this using the direct order links.
* '''Retired''' — Whether to hide the product from admin area menus, like the product menu in the client's profile.

===Pricing===
'''Pricing''' lets you specify the prices and duration of the product.

[[File:Price grid.png|thumb|Price Grid]]

*'''Payment Types''' — Select '''Free''', '''One Time''', or '''Recurring'''. If you select '''One Time''' or '''Recurring''', the pricing grid will appear. Enable each billing cycle by checking '''Enable'''.
**For '''One Time''' products, enable '''One Time/Monthly''' and enter your prices into that column.
**For '''Recurring''' products, check '''Enable''' for the billing cycles that you want to offer with the product.
**For '''Setup Fee''' in each column, enter any setup fees for a given billing cycle. For example, you may charge setup fees on monthly cycles and offer free setup for yearly cycles.
*'''Allow Multiple Quantities''' — Select whether clients can order multiples of this product on the checkout page. The product cannot require additional configuration (like product custom fields or configurable options).
** ''No'' — Disables the option to specify a quantity for this product.
** ''Yes - Multiple Services'' — Each unit represents its own individual service instance. For example, specifying a quantity of 10 will create 10 service records upon ordering, each with its own price.
** ''Yes - Scaling Service'' — Each service instance allows a quantity to be defined. For example, specifying a quantity of 10 will create one service, with the service price multiplied by the numbers of units specified.
*'''Recurring Cycles Limit''' — For '''Recurring''' payment types, the default value (<tt>0</tt>) will invoice indefinitely until cancelled. However, by entering a value in this field, you can limit the number of times this product will invoice the client. For example, entering <tt>5</tt> on a monthly product would keep the system from generating an invoice in the 6th month after ordering.
*'''Auto Terminate/Fixed Term''' — You can set up products that automatically terminate after a set number of days from the service's registration date.
**To enable this, enter the number of days to wait before terminating and choose an email template to send to the client when the termination occurs (for example, an up-selling email to promote your paid products in the case of a trial, or confirmation of payment completing for installment payments). Set '''Auto Terminate/Fixed Term''' to 0 to disable this feature.
**Entering a number in this field terminate the product when the cron job runs that many days after the product registration date.
**Use this to offer free trial products for a certain period of time or time-limited products that should only recur for a certain number of cycles before stopping.
*'''Termination Email''' — If you entered an '''Auto Terminate/Fixed Term''' value, select an email to send to the client at product termination.
<div class="docs-alert-info">
<span class="title">Note:</span><br />
'''Termination Email''' only includes custom product-type email templates. For more information on creating a custom email template, see [http://docs.whmcs.com/Email_Templates Email Templates].
</div>
*'''Prorata Billing''' — This allows you to bill products on a specific day of the month and charge a prorata amount at the initial time of order. If you check this, the system will charge all clients on one specific day each month. Otherwise, the product will use the default anniversary billing system (for example, Jun 15–Jul 15). Changes to this setting apply to new orders only.
<div class="docs-alert-info">
<span class="title">Note:</span><br />
Prorata billing is not compatible with the free domain logic or having domain renewal invoices that the system generates further in advance than other products.
</div>
*'''Prorata Date''' — The specific billing date for all sales of the product. If you set this to <tt>1</tt>, the system will charge all clients on the 1st of each month.
*'''Charge Next Month''' — After this day of the month, the system will also charge a client for the next month in their initial payment when signing up on a monthly billing cycle.
**If you don't enable this, if you have set the prorata date to 1, and a client signs up on the 30th of the month, they would only pay a small amount.
**If you enable this, they would pay the prorated amount plus the next month in advance.
**To prorate a product but not to enable this feature, set '''Prorata Date''' to a normal value and '''Charge Next Month''' to <tt>32</tt>.

===Module Settings===

This tab specifies which server type the product will use and how WHMCS will behave when someone orders this product.

*From '''Module Name''', select the type of server you're using. If a product has no specific module to link to, set it to ''[[Auto_Release|Autorelease]]'' to simulate activation and send a welcome email.
*Select your desired options. The options you will see depend on your module. For more information about each module, see the [[Server_Modules|Provisioning Modules]] section.
*Select one of the four automation settings for product activation:
**'''Automatically setup the product as soon as an order is placed''' — Set it up instantly. Usually, you would use this for free products.
**'''Automatically setup the product as soon as the first payment is received''' — Perform the setup as soon as the customer pays for the order.
**'''Automatically setup the product when you manually accept a pending order''' — Perform the setup only when an admin has manually reviewed and accepted the order.
**'''Do not automatically setup this product''' — Never auto-set-up the product. Admins can still initiate manually from the product details page under a clients profile.

====Metric Billing====
[[File:Usage-billing-module-settings-metric-config.png|thumb|]]

<div class="docs-alert-info">
<span class="title">Metric Billing</span><br />
'''Metric Billing''' displays in '''Module Settings''' when you select a module that supports this feature (WHMCS version 7.9 and above).
</div>

To enable a metric for billing or display purposes, set the toggle to '''On'''. If you enable a metric, it will appear within the client's product details view of the client area. An admin will always see all metrics, enabled or disabled, within the admin area when viewing a service for a product that reports metrics.

To configure pricing for a metric, click '''Configure Pricing''' for that metric.

For usage and configuration instructions, see [[Usage Billing]].

===Custom Fields===

From this tab you can create custom fields for this product. This allows you to collect additional order form information that you need to supply the product.

*Field types consist of text boxes, menus, checkboxes, link or URL fields, and password fields. Text in password fields appears as asterisks (<tt>****</tt>).
*You can set fields as admin-only for private data, required or optional on the order form, displayed on the order form, displayed in the client area, or displayed on invoices (such as VAT numbers).

For more information, see [[Custom_Fields|Custom Fields]].

===Configurable Options===

Use this tab to select the configurable options to associate with the product. You can display them on the order form or in the client area. '''Configurable Options''' are options that alter the price of the product.

For more information, see [[Addons_and_Configurable_Options|Addons and Configurable Options]].

===Upgrades===

This tab allows you to specify whether the client can upgrade or downgrade from this product to another. WHMCS can fully automate upgrades and downgrades for many of the modules.

*Select the products that the product can be upgraded or downgraded to.
*Use <tt>Ctrl+Click</tt> to select multiple products.
*Check '''Configurable Options''' to enable upgrading configurable options, if there are any on the product.
*Select an '''Upgrade Email''' template to use when a client upgrades to this product. You will first need to create a new product email template under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Email Templates'''.

For more information about how WHMCS calculates and processes upgrades and downgrades, see [[Automated_Upgrades_and_Downgrades|Automated Upgrades and Downgrades]].

===Free Domain===
Use this tab to configure the offer of a free domain with a product. WHMCS lets you offer free domains with your packages when customers purchase them with certain payment terms. For example, you might want to offer a free domain when someone purchases a package annually.

*For '''Free Domain''', choose whether and how to offer a free domain.
*Select one or more '''Free Domain Payment Terms''' to set the billing cycles that are required for a product to receive a free domain.
*Select one or more '''Free Domain TLDs''' to set which TLDs can be used for a free domain.

For more information on how to configure this, see [[Domains_Configuration#Offering_Free_Domain_Registration_with_Selected_Packages|Offering Free Domain Registration]].

===Other===
The penultimate tab contains miscellaneous settings such as product affiliate rates, product downloads, and overage billing.

*'''Custom Affiliate Payout''' — The custom payout rate for this specific product if it's using the built-in affiliate system. This setting overrides or disables the system default commission rate.
*'''Affiliate Pay Amount''' — The percentage or amount paid for a purchase of this product, depending on your choice for the setting above.
*'''One Time Payout''' — Check this to pay only a one-time commission.
*'''Subdomain Options''' — Enter a domain in the format ".yourdomain.com" if you want to offer a free subdomain option for the domain at signup. You can offer more than one by entering a comma separated list (for example, ".yourdomain.com,.yourdomain.net").
*'''Associated Downloads''' — The files to automatically release to the customer when the product is activated.
**Click '''Add Category''' to create a new category of downloads.
**Click '''Quick Upload''' to upload a new file.
**See [[Product Downloads Distribution]] for more information.
*'''Overages Billing''' — Enables billing for the product based on disk and bandwidth usage for the month. Refer to [[Disk Space and Bandwidth Overage Billing]] for more information.
*'''Soft Limits''' — Enter the soft limits for '''Disk Usage''' and '''Bandwidth'''.
*'''Overage Costs''' — Enter the overage costs for '''Disk Usage''' and '''Bandwidth'''.

===Links tab===
This tab contains the URLs to link to for this product.

*Each URL will add the product to the shopping cart and jump straight to the configuration step.
*There are many more possible variations. For more information, see [[Linking to WHMCS]].

==Sorting==

Groups and products are sortable using the crosshair icon on the appropriate row. This is on the left for groups and the right for products.

[[File:Drag_and_drop_sorting.png|center|850x250px]]

After moving, a success message will appear on the top right of the page to confirm that the system saved the sort order. It is not possible to move products between groups using the drag-and-drop method.

==Feature Highlights==

'''Feature Highlights''' allow you to define features and their values for products in a way that WHMCS can interpret for comparison-based display.

The system supports '''Feature Highlights''' for most order form templates. For more information, see [[Standard_Order_Form_Templates#Templates|Standard Order Form Templates]].

Friendly URLs

2021-01-15T15:28:25Z

DanR: /* WHMCS Rules */

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.2 and above</div>

Many functions and pages of WHMCS can be accessed through search engine friendly (SEF) URLs. The capability of WHMCS to process such URIs is heavily dependent on the webserver environment. WHMCS will perform an initial inspection of the environment and automatically configure the most optimal settings for your environment.

There are several settings that will affect the WHMCS's behavior regarding SEF. They are located at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > General''' or, prior to WHMCS 8.0, '''Setup > General Settings > General'''.

=Simple Mode Selection=

Directly in the General Tab, next the the Friendly URLs label are two controls that can simplify the SEF mode that WHMCS will use.

[[File:friendly_uri_setting.png|700px]]

==URI Path Mode==
The URI path mode is used by WHMCS when constructing URIs, URLs, or relative paths in rendered output (ie. links on pages).

There are three possible modes:
* '''Fully Friendly Rewrite''' - This option will generate highly systematic URLs, which are excellent for search engines and visitors alike. The are completely decoupled from the file system. This mode is only valid in environments that support Apache Mod_Rewrite behavior.
** Example: ''<nowiki>http://awesome.host/knowledgebase</nowiki>''

* '''Friendly index.php''' - This option will generate systematic URLs but is coupled to the filesystem. It is a good option for search engines and visitors if your environment does not support Apache Mod_Rewrite. This mode is only valid in environments that support Apache AcceptPathInfo behavior.
** Example: ''<nowiki>http://awesome.host/index.php/knowledgebase</nowiki>''

* '''Basic URLs''' - This option will generate URLs which are ubiquitously supported in all web environments. Most search engine technologies are capable of moderate to advanced indexing when analyzing these types of URLs. However some internet users find these URLs unattractive and cumbersome.
** Example: ''<nowiki>http://awesome.host/index.php?rp=/knowledgebase</nowiki>''

You can quickly change the URI path mode via the dynamic dropdown which lists all possible URI path mode options. Your current mode setting will appear with a white background at the top of dynamic dropdown selection, as well as in the options list within a right-angle bracket denoting the selection.

[[File:Friendly_Url_Simple_Mode_Select.png|280px]]

The best option detected by WHMCS for your current environment will have a green background within options list. All other options will have a blue background. You may select and override the system's best detected suggestion at any time to facilitate the optimal experience for you WHMCS. One such scenario would be if you WHMCS is running on a web server other than Apache, where URL rewrites are controlled at a server-level and cannot be accurately observed by applications. Another scenario might be if a customization prepares link paths relative to the current link path and not as absolute path to WHMCS or the website.

When you select an option from the dynamic dropdown it will be saved automatically. The current selection denotation will be updated as well as the status label. If the selection is the same as what was detected as the best option, the status label will be green and read "System-Detected", otherwise it will be blue and read "Manual-Override".

==Recheck Environment==
The recheck button, represented with a circular arrow icon, will perform an environment detection and immediately update your Friendly URLs settings to the optimal configuration. If the Auto-Managed Rewrite setting is not enabled, and the system detects that modifications to your rewrite file (.htaccess) may occur during the optimization routine, you will be a prompted to enable it before any changes are applied.

=Advanced Settings=
To the right of the URI Mode Selection and Recheck Button the is an Advanced Setting link which provides you more options and information so that you may manually optimizing your environment and WHMCS settings for Friendly URLs.

==Path Mode==
The Path Mode management tab of Advanced Settings allows you to manually override the system-detected URI Path Mode and shows which modes are known to be support by your environment.

[[File:UriPathModeMgmt.png|550px]]

The settings provided here perform the same result as the Simple Mode Selection but with more explicit control. Notably, you may enable the manual override option while selecting a URI Path Mode that is the same as the system detected value.

Setting are automatically saved on change.

==Rewrite File==
The Rewrite File management tab of Advanced Settings allows you to manually select how WHMCS should control the rewrite file (.htaccess) as well as a copy of the WHMCS rewrite rules. Rewrite rules are used to alter inbound HTTP requests so that the application can effectively process Friendly URLs

[[File:UriMgmtRewriteRuleTab.png|550px]]

===Rewrite File Management===
====Initial Evaluation====
Upon installation (or upgrade to v7.2), WHMCS will perform an evaluation of your current environment. This evaluation will inspect the following:

A. Does the current environment support Apache Mod_Rewrite?

B. Is there an .htaccess file within the WHMCS root directory?

C. If there is an .htaccess file, are the contents identical to the suggested ruleset provided in htaccess.txt of previous WHMCS releases?

D. If there is an .htaccess file, and it is not identical to previous releases' ruleset suggestions, do the contents contain the WHMCS comment marks indicating WHMCS has leveraged this file in the past?

After the evaluation, one of the following will occur:

* If the current environment is not supported (not A), then Auto-Managed Rewrite is disabled and and no further action will be taken.

* If the environment is supported (A) and a .htaccess file does exist (not B), Auto-Managed Rewrite will be enabled and a fresh .htaccess file will be created with the latest WHMCS rewrite ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is an .htaccess file (B), only if the contents are solely WHMCS content (C) or the WHMCS ruleset has been managed by WHMCS automation along with your own custom rules (D) will Auto-Managed Rewrite be enabled. The current .htaccess file will be updated to the current WHMCS ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is a .htaccess file (B), but it is not solely WHMCS content or there is no indication that WHMCS can manage its rules along side your custom rules (neither C or D), then Auto-Managed Rewrite is disabled and no further action will be taken.

====Manual Management====
At any time you may enable or disable Auto-Managed Rewrite. When this option is enabled, any new rules issued as part of a WHMCS update will be applied to the .htaccess file of the WHMCS root directory during the update process. Your Auto-Managed Rewrite toggle selection is immediately saved on change.

Manually enabling Auto-Managed Rewrite will not automatically reevaluate or synchronize the WHMCS ruleset. Likewise, disabling Auto-Managed Rewrite will not inspect or alter the contents of .htaccess.

When the Advanced Setting dialog is opened, if the current contents of .htaccess are not in-sync with the WHMCS ruleset, you will have a Synchronize option. This option is provided regardless of the Auto-Managed Rewrite setting. To synchronize the ruleset, simply click the Synchronize button that is below the Auto-Managed Rewrite toggle. Synchronization will occur immediately when this button is clicked.

When rules are applied to .htaccess, they are placed between comment markers that clearly indicate the beginning and end of the WHMCS ruleset. If you require custom rulesets for other destinations within the WHMCS root directory, make sure that you place them before or after these comment markers.
<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  Compatibility with other rules in .htaccess will need to be determined and adjusted by your system administrative staff. WHMCS cannot automatically detect compatibility with other rules. Furthermore, WHMCS Technical Support can only provided limited suggestions based on what WHMCS required to function as designed.
</div>

===WHMCS Rules===
A copy of the WHMCS ruleset for your current version of WHMCS is displayed for your inspection and application. Some web environments provide alternative mechanisms for performing URI rewrites on inbound HTTP requests. Your system administrative staff should be able to update your alternative web environment based on this information to fully utilize the Friendly URLs feature of WHMCS.

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> These .htaccess rules apply to WHMCS version 7.2 and above.</div>
<pre>
### BEGIN - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
<IfModule mod_rewrite.c>
RewriteEngine on

# RewriteBase is set to "/" so rules do not need updating if the
# installation directory is relocated. It is imperative that
# there is also a RewriteCond rule later that can effectively get
# the actual value by comparison against the request URI.
#
# If there are _any_ other RewriteBase directives in this file,
# the last entry will take precedence!
RewriteBase /

# Redirect directories to an address with slash
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^(.+[^/])$ $1/ [R]

# Send all remaining (routable paths) through index.php
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# Determine and use the actual base
RewriteCond $0#%{REQUEST_URI} ([^#]*)#(.*)\1$
RewriteRule ^.*$ %2index.php [QSA,L]
</IfModule>
### END - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
</pre>

Friendly URLs

2021-01-15T15:28:03Z

DanR: /* WHMCS Rules */

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.2 and above</div>

Many functions and pages of WHMCS can be accessed through search engine friendly (SEF) URLs. The capability of WHMCS to process such URIs is heavily dependent on the webserver environment. WHMCS will perform an initial inspection of the environment and automatically configure the most optimal settings for your environment.

There are several settings that will affect the WHMCS's behavior regarding SEF. They are located at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > General''' or, prior to WHMCS 8.0, '''Setup > General Settings > General'''.

=Simple Mode Selection=

Directly in the General Tab, next the the Friendly URLs label are two controls that can simplify the SEF mode that WHMCS will use.

[[File:friendly_uri_setting.png|700px]]

==URI Path Mode==
The URI path mode is used by WHMCS when constructing URIs, URLs, or relative paths in rendered output (ie. links on pages).

There are three possible modes:
* '''Fully Friendly Rewrite''' - This option will generate highly systematic URLs, which are excellent for search engines and visitors alike. The are completely decoupled from the file system. This mode is only valid in environments that support Apache Mod_Rewrite behavior.
** Example: ''<nowiki>http://awesome.host/knowledgebase</nowiki>''

* '''Friendly index.php''' - This option will generate systematic URLs but is coupled to the filesystem. It is a good option for search engines and visitors if your environment does not support Apache Mod_Rewrite. This mode is only valid in environments that support Apache AcceptPathInfo behavior.
** Example: ''<nowiki>http://awesome.host/index.php/knowledgebase</nowiki>''

* '''Basic URLs''' - This option will generate URLs which are ubiquitously supported in all web environments. Most search engine technologies are capable of moderate to advanced indexing when analyzing these types of URLs. However some internet users find these URLs unattractive and cumbersome.
** Example: ''<nowiki>http://awesome.host/index.php?rp=/knowledgebase</nowiki>''

You can quickly change the URI path mode via the dynamic dropdown which lists all possible URI path mode options. Your current mode setting will appear with a white background at the top of dynamic dropdown selection, as well as in the options list within a right-angle bracket denoting the selection.

[[File:Friendly_Url_Simple_Mode_Select.png|280px]]

The best option detected by WHMCS for your current environment will have a green background within options list. All other options will have a blue background. You may select and override the system's best detected suggestion at any time to facilitate the optimal experience for you WHMCS. One such scenario would be if you WHMCS is running on a web server other than Apache, where URL rewrites are controlled at a server-level and cannot be accurately observed by applications. Another scenario might be if a customization prepares link paths relative to the current link path and not as absolute path to WHMCS or the website.

When you select an option from the dynamic dropdown it will be saved automatically. The current selection denotation will be updated as well as the status label. If the selection is the same as what was detected as the best option, the status label will be green and read "System-Detected", otherwise it will be blue and read "Manual-Override".

==Recheck Environment==
The recheck button, represented with a circular arrow icon, will perform an environment detection and immediately update your Friendly URLs settings to the optimal configuration. If the Auto-Managed Rewrite setting is not enabled, and the system detects that modifications to your rewrite file (.htaccess) may occur during the optimization routine, you will be a prompted to enable it before any changes are applied.

=Advanced Settings=
To the right of the URI Mode Selection and Recheck Button the is an Advanced Setting link which provides you more options and information so that you may manually optimizing your environment and WHMCS settings for Friendly URLs.

==Path Mode==
The Path Mode management tab of Advanced Settings allows you to manually override the system-detected URI Path Mode and shows which modes are known to be support by your environment.

[[File:UriPathModeMgmt.png|550px]]

The settings provided here perform the same result as the Simple Mode Selection but with more explicit control. Notably, you may enable the manual override option while selecting a URI Path Mode that is the same as the system detected value.

Setting are automatically saved on change.

==Rewrite File==
The Rewrite File management tab of Advanced Settings allows you to manually select how WHMCS should control the rewrite file (.htaccess) as well as a copy of the WHMCS rewrite rules. Rewrite rules are used to alter inbound HTTP requests so that the application can effectively process Friendly URLs

[[File:UriMgmtRewriteRuleTab.png|550px]]

===Rewrite File Management===
====Initial Evaluation====
Upon installation (or upgrade to v7.2), WHMCS will perform an evaluation of your current environment. This evaluation will inspect the following:

A. Does the current environment support Apache Mod_Rewrite?

B. Is there an .htaccess file within the WHMCS root directory?

C. If there is an .htaccess file, are the contents identical to the suggested ruleset provided in htaccess.txt of previous WHMCS releases?

D. If there is an .htaccess file, and it is not identical to previous releases' ruleset suggestions, do the contents contain the WHMCS comment marks indicating WHMCS has leveraged this file in the past?

After the evaluation, one of the following will occur:

* If the current environment is not supported (not A), then Auto-Managed Rewrite is disabled and and no further action will be taken.

* If the environment is supported (A) and a .htaccess file does exist (not B), Auto-Managed Rewrite will be enabled and a fresh .htaccess file will be created with the latest WHMCS rewrite ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is an .htaccess file (B), only if the contents are solely WHMCS content (C) or the WHMCS ruleset has been managed by WHMCS automation along with your own custom rules (D) will Auto-Managed Rewrite be enabled. The current .htaccess file will be updated to the current WHMCS ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is a .htaccess file (B), but it is not solely WHMCS content or there is no indication that WHMCS can manage its rules along side your custom rules (neither C or D), then Auto-Managed Rewrite is disabled and no further action will be taken.

====Manual Management====
At any time you may enable or disable Auto-Managed Rewrite. When this option is enabled, any new rules issued as part of a WHMCS update will be applied to the .htaccess file of the WHMCS root directory during the update process. Your Auto-Managed Rewrite toggle selection is immediately saved on change.

Manually enabling Auto-Managed Rewrite will not automatically reevaluate or synchronize the WHMCS ruleset. Likewise, disabling Auto-Managed Rewrite will not inspect or alter the contents of .htaccess.

When the Advanced Setting dialog is opened, if the current contents of .htaccess are not in-sync with the WHMCS ruleset, you will have a Synchronize option. This option is provided regardless of the Auto-Managed Rewrite setting. To synchronize the ruleset, simply click the Synchronize button that is below the Auto-Managed Rewrite toggle. Synchronization will occur immediately when this button is clicked.

When rules are applied to .htaccess, they are placed between comment markers that clearly indicate the beginning and end of the WHMCS ruleset. If you require custom rulesets for other destinations within the WHMCS root directory, make sure that you place them before or after these comment markers.
<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  Compatibility with other rules in .htaccess will need to be determined and adjusted by your system administrative staff. WHMCS cannot automatically detect compatibility with other rules. Furthermore, WHMCS Technical Support can only provided limited suggestions based on what WHMCS required to function as designed.
</div>

===WHMCS Rules===
A copy of the WHMCS ruleset for your current version of WHMCS is displayed for your inspection and application. Some web environments provide alternative mechanisms for performing URI rewrites on inbound HTTP requests. Your system administrative staff should be able to update your alternative web environment based on this information to fully utilize the Friendly URLs feature of WHMCS.

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> These .htaccess rules apply to WHMCS version 7.2 and above.</div>
<div class="source-cli">
### BEGIN - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
<IfModule mod_rewrite.c>
RewriteEngine on

# RewriteBase is set to "/" so rules do not need updating if the
# installation directory is relocated. It is imperative that
# there is also a RewriteCond rule later that can effectively get
# the actual value by comparison against the request URI.
#
# If there are _any_ other RewriteBase directives in this file,
# the last entry will take precedence!
RewriteBase /

# Redirect directories to an address with slash
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^(.+[^/])$ $1/ [R]

# Send all remaining (routable paths) through index.php
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# Determine and use the actual base
RewriteCond $0#%{REQUEST_URI} ([^#]*)#(.*)\1$
RewriteRule ^.*$ %2index.php [QSA,L]
</IfModule>
### END - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
</div>

Friendly URLs

2021-01-15T15:25:48Z

DanR: /* WHMCS Rules */

Friendly URLs

2021-01-11T19:13:56Z

DanR:

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.2 and above</div>

Many functions and pages of WHMCS can be accessed through search engine friendly (SEF) URLs. The capability of WHMCS to process such URIs is heavily dependent on the webserver environment. WHMCS will perform an initial inspection of the environment and automatically configure the most optimal settings for your environment.

There are several settings that will affect the WHMCS's behavior regarding SEF. They are located at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > General''' or, prior to WHMCS 8.0, '''Setup > General Settings > General'''.

=Simple Mode Selection=

Directly in the General Tab, next the the Friendly URLs label are two controls that can simplify the SEF mode that WHMCS will use.

[[File:friendly_uri_setting.png|700px]]

==URI Path Mode==
The URI path mode is used by WHMCS when constructing URIs, URLs, or relative paths in rendered output (ie. links on pages).

There are three possible modes:
* '''Fully Friendly Rewrite''' - This option will generate highly systematic URLs, which are excellent for search engines and visitors alike. The are completely decoupled from the file system. This mode is only valid in environments that support Apache Mod_Rewrite behavior.
** Example: ''<nowiki>http://awesome.host/knowledgebase</nowiki>''

* '''Friendly index.php''' - This option will generate systematic URLs but is coupled to the filesystem. It is a good option for search engines and visitors if your environment does not support Apache Mod_Rewrite. This mode is only valid in environments that support Apache AcceptPathInfo behavior.
** Example: ''<nowiki>http://awesome.host/index.php/knowledgebase</nowiki>''

* '''Basic URLs''' - This option will generate URLs which are ubiquitously supported in all web environments. Most search engine technologies are capable of moderate to advanced indexing when analyzing these types of URLs. However some internet users find these URLs unattractive and cumbersome.
** Example: ''<nowiki>http://awesome.host/index.php?rp=/knowledgebase</nowiki>''

You can quickly change the URI path mode via the dynamic dropdown which lists all possible URI path mode options. Your current mode setting will appear with a white background at the top of dynamic dropdown selection, as well as in the options list within a right-angle bracket denoting the selection.

[[File:Friendly_Url_Simple_Mode_Select.png|280px]]

The best option detected by WHMCS for your current environment will have a green background within options list. All other options will have a blue background. You may select and override the system's best detected suggestion at any time to facilitate the optimal experience for you WHMCS. One such scenario would be if you WHMCS is running on a web server other than Apache, where URL rewrites are controlled at a server-level and cannot be accurately observed by applications. Another scenario might be if a customization prepares link paths relative to the current link path and not as absolute path to WHMCS or the website.

When you select an option from the dynamic dropdown it will be saved automatically. The current selection denotation will be updated as well as the status label. If the selection is the same as what was detected as the best option, the status label will be green and read "System-Detected", otherwise it will be blue and read "Manual-Override".

==Recheck Environment==
The recheck button, represented with a circular arrow icon, will perform an environment detection and immediately update your Friendly URLs settings to the optimal configuration. If the Auto-Managed Rewrite setting is not enabled, and the system detects that modifications to your rewrite file (.htaccess) may occur during the optimization routine, you will be a prompted to enable it before any changes are applied.

=Advanced Settings=
To the right of the URI Mode Selection and Recheck Button the is an Advanced Setting link which provides you more options and information so that you may manually optimizing your environment and WHMCS settings for Friendly URLs.

==Path Mode==
The Path Mode management tab of Advanced Settings allows you to manually override the system-detected URI Path Mode and shows which modes are known to be support by your environment.

[[File:UriPathModeMgmt.png|550px]]

The settings provided here perform the same result as the Simple Mode Selection but with more explicit control. Notably, you may enable the manual override option while selecting a URI Path Mode that is the same as the system detected value.

Setting are automatically saved on change.

==Rewrite File==
The Rewrite File management tab of Advanced Settings allows you to manually select how WHMCS should control the rewrite file (.htaccess) as well as a copy of the WHMCS rewrite rules. Rewrite rules are used to alter inbound HTTP requests so that the application can effectively process Friendly URLs

[[File:UriMgmtRewriteRuleTab.png|550px]]

===Rewrite File Management===
====Initial Evaluation====
Upon installation (or upgrade to v7.2), WHMCS will perform an evaluation of your current environment. This evaluation will inspect the following:

A. Does the current environment support Apache Mod_Rewrite?

B. Is there an .htaccess file within the WHMCS root directory?

C. If there is an .htaccess file, are the contents identical to the suggested ruleset provided in htaccess.txt of previous WHMCS releases?

D. If there is an .htaccess file, and it is not identical to previous releases' ruleset suggestions, do the contents contain the WHMCS comment marks indicating WHMCS has leveraged this file in the past?

After the evaluation, one of the following will occur:

* If the current environment is not supported (not A), then Auto-Managed Rewrite is disabled and and no further action will be taken.

* If the environment is supported (A) and a .htaccess file does exist (not B), Auto-Managed Rewrite will be enabled and a fresh .htaccess file will be created with the latest WHMCS rewrite ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is an .htaccess file (B), only if the contents are solely WHMCS content (C) or the WHMCS ruleset has been managed by WHMCS automation along with your own custom rules (D) will Auto-Managed Rewrite be enabled. The current .htaccess file will be updated to the current WHMCS ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is a .htaccess file (B), but it is not solely WHMCS content or there is no indication that WHMCS can manage its rules along side your custom rules (neither C or D), then Auto-Managed Rewrite is disabled and no further action will be taken.

====Manual Management====
At any time you may enable or disable Auto-Managed Rewrite. When this option is enabled, any new rules issued as part of a WHMCS update will be applied to the .htaccess file of the WHMCS root directory during the update process. Your Auto-Managed Rewrite toggle selection is immediately saved on change.

Manually enabling Auto-Managed Rewrite will not automatically reevaluate or synchronize the WHMCS ruleset. Likewise, disabling Auto-Managed Rewrite will not inspect or alter the contents of .htaccess.

When the Advanced Setting dialog is opened, if the current contents of .htaccess are not in-sync with the WHMCS ruleset, you will have a Synchronize option. This option is provided regardless of the Auto-Managed Rewrite setting. To synchronize the ruleset, simply click the Synchronize button that is below the Auto-Managed Rewrite toggle. Synchronization will occur immediately when this button is clicked.

When rules are applied to .htaccess, they are placed between comment markers that clearly indicate the beginning and end of the WHMCS ruleset. If you require custom rulesets for other destinations within the WHMCS root directory, make sure that you place them before or after these comment markers.
<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  Compatibility with other rules in .htaccess will need to be determined and adjusted by your system administrative staff. WHMCS cannot automatically detect compatibility with other rules. Furthermore, WHMCS Technical Support can only provided limited suggestions based on what WHMCS required to function as designed.
</div>

===WHMCS Rules===
A copy of the WHMCS ruleset for your current version of WHMCS is displayed for your inspection and application. Some web environments provide alternative mechanisms for performing URI rewrites on inbound HTTP requests. Your system administrative staff should be able to update your alternative web environment based on this information to fully utilize the Friendly URLs feature of WHMCS.

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> These .htaccess rules apply to WHMCS version 7.2 and above</div>
<pre>
### BEGIN - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
<IfModule mod_rewrite.c>
RewriteEngine on

# RewriteBase is set to "/" so rules do not need updating if the
# installation directory is relocated. It is imperative that
# there is also a RewriteCond rule later that can effectively get
# the actual value by comparison against the request URI.
#
# If there are _any_ other RewriteBase directives in this file,
# the last entry will take precedence!
RewriteBase /

# Redirect directories to an address with slash
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^(.+[^/])$ $1/ [R]

# Send all remaining (routable paths) through index.php
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# Determine and use the actual base
RewriteCond $0#%{REQUEST_URI} ([^#]*)#(.*)\1$
RewriteRule ^.*$ %2index.php [QSA,L]
</IfModule>
### END - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
</pre>

Friendly URLs

2021-01-11T19:13:15Z

DanR:

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.2 and above</div>

Many functions and pages of WHMCS can be accessed through search engine friendly (SEF) URLs. The capability of WHMCS to process such URIs is heavily dependent on the webserver environment. WHMCS will perform an initial inspection of the environment and automatically configure the most optimal settings for your environment.

There are several settings that will affect the WHMCS's behavior regarding SEF. They are located at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > General''' or, prior to WHMCS 8.0, '''Setup > General Settings > General'''.

=Simple Mode Selection=

Directly in the General Tab, next the the Friendly URLs label are two controls that can simplify the SEF mode that WHMCS will use.

[[File:friendly_uri_setting.png|700px]]

==URI Path Mode==
The URI path mode is used by WHMCS when constructing URIs, URLs, or relative paths in rendered output (ie. links on pages).

There are three possible modes:
* '''Fully Friendly Rewrite''' - This option will generate highly systematic URLs, which are excellent for search engines and visitors alike. The are completely decoupled from the file system. This mode is only valid in environments that support Apache Mod_Rewrite behavior.
** Example: ''<nowiki>http://awesome.host/knowledgebase</nowiki>''

* '''Friendly index.php''' - This option will generate systematic URLs but is coupled to the filesystem. It is a good option for search engines and visitors if your environment does not support Apache Mod_Rewrite. This mode is only valid in environments that support Apache AcceptPathInfo behavior.
** Example: ''<nowiki>http://awesome.host/index.php/knowledgebase</nowiki>''

* '''Basic URLs''' - This option will generate URLs which are ubiquitously supported in all web environments. Most search engine technologies are capable of moderate to advanced indexing when analyzing these types of URLs. However some internet users find these URLs unattractive and cumbersome.
** Example: ''<nowiki>http://awesome.host/index.php?rp=/knowledgebase</nowiki>''

You can quickly change the URI path mode via the dynamic dropdown which lists all possible URI path mode options. Your current mode setting will appear with a white background at the top of dynamic dropdown selection, as well as in the options list within a right-angle bracket denoting the selection.

[[File:Friendly_Url_Simple_Mode_Select.png|280px]]

The best option detected by WHMCS for your current environment will have a green background within options list. All other options will have a blue background. You may select and override the system's best detected suggestion at any time to facilitate the optimal experience for you WHMCS. One such scenario would be if you WHMCS is running on a web server other than Apache, where URL rewrites are controlled at a server-level and cannot be accurately observed by applications. Another scenario might be if a customization prepares link paths relative to the current link path and not as absolute path to WHMCS or the website.

When you select an option from the dynamic dropdown it will be saved automatically. The current selection denotation will be updated as well as the status label. If the selection is the same as what was detected as the best option, the status label will be green and read "System-Detected", otherwise it will be blue and read "Manual-Override".

==Recheck Environment==
The recheck button, represented with a circular arrow icon, will perform an environment detection and immediately update your Friendly URLs settings to the optimal configuration. If the Auto-Managed Rewrite setting is not enabled, and the system detects that modifications to your rewrite file (.htaccess) may occur during the optimization routine, you will be a prompted to enable it before any changes are applied.

=Advanced Settings=
To the right of the URI Mode Selection and Recheck Button the is an Advanced Setting link which provides you more options and information so that you may manually optimizing your environment and WHMCS settings for Friendly URLs.

==Path Mode==
The Path Mode management tab of Advanced Settings allows you to manually override the system-detected URI Path Mode and shows which modes are known to be support by your environment.

[[File:UriPathModeMgmt.png|550px]]

The settings provided here perform the same result as the Simple Mode Selection but with more explicit control. Notably, you may enable the manual override option while selecting a URI Path Mode that is the same as the system detected value.

Setting are automatically saved on change.

==Rewrite File==
The Rewrite File management tab of Advanced Settings allows you to manually select how WHMCS should control the rewrite file (.htaccess) as well as a copy of the WHMCS rewrite rules. Rewrite rules are used to alter inbound HTTP requests so that the application can effectively process Friendly URLs

[[File:UriMgmtRewriteRuleTab.png|550px]]

===Rewrite File Management===
====Initial Evaluation====
Upon installation (or upgrade to v7.2), WHMCS will perform an evaluation of your current environment. This evaluation will inspect the following:

A. Does the current environment support Apache Mod_Rewrite?

B. Is there an .htaccess file within the WHMCS root directory?

C. If there is an .htaccess file, are the contents identical to the suggested ruleset provided in htaccess.txt of previous WHMCS releases?

D. If there is an .htaccess file, and it is not identical to previous releases' ruleset suggestions, do the contents contain the WHMCS comment marks indicating WHMCS has leveraged this file in the past?

After the evaluation, one of the following will occur:

* If the current environment is not supported (not A), then Auto-Managed Rewrite is disabled and and no further action will be taken.

* If the environment is supported (A) and a .htaccess file does exist (not B), Auto-Managed Rewrite will be enabled and a fresh .htaccess file will be created with the latest WHMCS rewrite ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is an .htaccess file (B), only if the contents are solely WHMCS content (C) or the WHMCS ruleset has been managed by WHMCS automation along with your own custom rules (D) will Auto-Managed Rewrite be enabled. The current .htaccess file will be updated to the current WHMCS ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is a .htaccess file (B), but it is not solely WHMCS content or there is no indication that WHMCS can manage its rules along side your custom rules (neither C or D), then Auto-Managed Rewrite is disabled and no further action will be taken.

====Manual Management====
At any time you may enable or disable Auto-Managed Rewrite. When this option is enabled, any new rules issued as part of a WHMCS update will be applied to the .htaccess file of the WHMCS root directory during the update process. Your Auto-Managed Rewrite toggle selection is immediately saved on change.

Manually enabling Auto-Managed Rewrite will not automatically reevaluate or synchronize the WHMCS ruleset. Likewise, disabling Auto-Managed Rewrite will not inspect or alter the contents of .htaccess.

When the Advanced Setting dialog is opened, if the current contents of .htaccess are not in-sync with the WHMCS ruleset, you will have a Synchronize option. This option is provided regardless of the Auto-Managed Rewrite setting. To synchronize the ruleset, simply click the Synchronize button that is below the Auto-Managed Rewrite toggle. Synchronization will occur immediately when this button is clicked.

When rules are applied to .htaccess, they are placed between comment markers that clearly indicate the beginning and end of the WHMCS ruleset. If you require custom rulesets for other destinations within the WHMCS root directory, make sure that you place them before or after these comment markers.
<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  Compatibility with other rules in .htaccess will need to be determined and adjusted by your system administrative staff. WHMCS cannot automatically detect compatibility with other rules. Furthermore, WHMCS Technical Support can only provided limited suggestions based on what WHMCS required to function as designed.
</div>

===WHMCS Rules===
A copy of the WHMCS ruleset for your current version of WHMCS is displayed for your inspection and application. Some web environments provide alternative mechanisms for performing URI rewrites on inbound HTTP requests. Your system administrative staff should be able to update your alternative web environment based on this information to fully utilize the Friendly URLs feature of WHMCS.

<i class="fa fa-question-circle"></i> These .htaccess rules apply to WHMCS version 7.2 and above</div>
<pre>
### BEGIN - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
<IfModule mod_rewrite.c>
RewriteEngine on

# RewriteBase is set to "/" so rules do not need updating if the
# installation directory is relocated. It is imperative that
# there is also a RewriteCond rule later that can effectively get
# the actual value by comparison against the request URI.
#
# If there are _any_ other RewriteBase directives in this file,
# the last entry will take precedence!
RewriteBase /

# Redirect directories to an address with slash
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^(.+[^/])$ $1/ [R]

# Send all remaining (routable paths) through index.php
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# Determine and use the actual base
RewriteCond $0#%{REQUEST_URI} ([^#]*)#(.*)\1$
RewriteRule ^.*$ %2index.php [QSA,L]
</IfModule>
### END - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
</pre>

Friendly URLs

2021-01-11T18:13:44Z

DanR: /* WHMCS Rules */

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.2 and above</div>

Many functions and pages of WHMCS can be accessed through search engine friendly (SEF) URLs. The capability of WHMCS to process such URIs is heavily dependent on the webserver environment. WHMCS will perform an initial inspection of the environment and automatically configure the most optimal settings for your environment.

There are several settings that will affect the WHMCS's behavior regarding SEF. They are located at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > General''' or, prior to WHMCS 8.0, '''Setup > General Settings > General'''.

=Simple Mode Selection=

Directly in the General Tab, next the the Friendly URLs label are two controls that can simplify the SEF mode that WHMCS will use.

[[File:friendly_uri_setting.png|700px]]

==URI Path Mode==
The URI path mode is used by WHMCS when constructing URIs, URLs, or relative paths in rendered output (ie. links on pages).

There are three possible modes:
* '''Fully Friendly Rewrite''' - This option will generate highly systematic URLs, which are excellent for search engines and visitors alike. The are completely decoupled from the file system. This mode is only valid in environments that support Apache Mod_Rewrite behavior.
** Example: ''<nowiki>http://awesome.host/knowledgebase</nowiki>''

* '''Friendly index.php''' - This option will generate systematic URLs but is coupled to the filesystem. It is a good option for search engines and visitors if your environment does not support Apache Mod_Rewrite. This mode is only valid in environments that support Apache AcceptPathInfo behavior.
** Example: ''<nowiki>http://awesome.host/index.php/knowledgebase</nowiki>''

* '''Basic URLs''' - This option will generate URLs which are ubiquitously supported in all web environments. Most search engine technologies are capable of moderate to advanced indexing when analyzing these types of URLs. However some internet users find these URLs unattractive and cumbersome.
** Example: ''<nowiki>http://awesome.host/index.php?rp=/knowledgebase</nowiki>''

You can quickly change the URI path mode via the dynamic dropdown which lists all possible URI path mode options. Your current mode setting will appear with a white background at the top of dynamic dropdown selection, as well as in the options list within a right-angle bracket denoting the selection.

[[File:Friendly_Url_Simple_Mode_Select.png|280px]]

The best option detected by WHMCS for your current environment will have a green background within options list. All other options will have a blue background. You may select and override the system's best detected suggestion at any time to facilitate the optimal experience for you WHMCS. One such scenario would be if you WHMCS is running on a web server other than Apache, where URL rewrites are controlled at a server-level and cannot be accurately observed by applications. Another scenario might be if a customization prepares link paths relative to the current link path and not as absolute path to WHMCS or the website.

When you select an option from the dynamic dropdown it will be saved automatically. The current selection denotation will be updated as well as the status label. If the selection is the same as what was detected as the best option, the status label will be green and read "System-Detected", otherwise it will be blue and read "Manual-Override".

==Recheck Environment==
The recheck button, represented with a circular arrow icon, will perform an environment detection and immediately update your Friendly URLs settings to the optimal configuration. If the Auto-Managed Rewrite setting is not enabled, and the system detects that modifications to your rewrite file (.htaccess) may occur during the optimization routine, you will be a prompted to enable it before any changes are applied.

=Advanced Settings=
To the right of the URI Mode Selection and Recheck Button the is an Advanced Setting link which provides you more options and information so that you may manually optimizing your environment and WHMCS settings for Friendly URLs.

==Path Mode==
The Path Mode management tab of Advanced Settings allows you to manually override the system-detected URI Path Mode and shows which modes are known to be support by your environment.

[[File:UriPathModeMgmt.png|550px]]

The settings provided here perform the same result as the Simple Mode Selection but with more explicit control. Notably, you may enable the manual override option while selecting a URI Path Mode that is the same as the system detected value.

Setting are automatically saved on change.

==Rewrite File==
The Rewrite File management tab of Advanced Settings allows you to manually select how WHMCS should control the rewrite file (.htaccess) as well as a copy of the WHMCS rewrite rules. Rewrite rules are used to alter inbound HTTP requests so that the application can effectively process Friendly URLs

[[File:UriMgmtRewriteRuleTab.png|550px]]

===Rewrite File Management===
====Initial Evaluation====
Upon installation (or upgrade to v7.2), WHMCS will perform an evaluation of your current environment. This evaluation will inspect the following:

A. Does the current environment support Apache Mod_Rewrite?

B. Is there an .htaccess file within the WHMCS root directory?

C. If there is an .htaccess file, are the contents identical to the suggested ruleset provided in htaccess.txt of previous WHMCS releases?

D. If there is an .htaccess file, and it is not identical to previous releases' ruleset suggestions, do the contents contain the WHMCS comment marks indicating WHMCS has leveraged this file in the past?

After the evaluation, one of the following will occur:

* If the current environment is not supported (not A), then Auto-Managed Rewrite is disabled and and no further action will be taken.

* If the environment is supported (A) and a .htaccess file does exist (not B), Auto-Managed Rewrite will be enabled and a fresh .htaccess file will be created with the latest WHMCS rewrite ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is an .htaccess file (B), only if the contents are solely WHMCS content (C) or the WHMCS ruleset has been managed by WHMCS automation along with your own custom rules (D) will Auto-Managed Rewrite be enabled. The current .htaccess file will be updated to the current WHMCS ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is a .htaccess file (B), but it is not solely WHMCS content or there is no indication that WHMCS can manage its rules along side your custom rules (neither C or D), then Auto-Managed Rewrite is disabled and no further action will be taken.

====Manual Management====
At any time you may enable or disable Auto-Managed Rewrite. When this option is enabled, any new rules issued as part of a WHMCS update will be applied to the .htaccess file of the WHMCS root directory during the update process. Your Auto-Managed Rewrite toggle selection is immediately saved on change.

Manually enabling Auto-Managed Rewrite will not automatically reevaluate or synchronize the WHMCS ruleset. Likewise, disabling Auto-Managed Rewrite will not inspect or alter the contents of .htaccess.

When the Advanced Setting dialog is opened, if the current contents of .htaccess are not in-sync with the WHMCS ruleset, you will have a Synchronize option. This option is provided regardless of the Auto-Managed Rewrite setting. To synchronize the ruleset, simply click the Synchronize button that is below the Auto-Managed Rewrite toggle. Synchronization will occur immediately when this button is clicked.

When rules are applied to .htaccess, they are placed between comment markers that clearly indicate the beginning and end of the WHMCS ruleset. If you require custom rulesets for other destinations within the WHMCS root directory, make sure that you place them before or after these comment markers.
<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>  Compatibility with other rules in .htaccess will need to be determined and adjusted by your system administrative staff. WHMCS cannot automatically detect compatibility with other rules. Furthermore, WHMCS Technical Support can only provided limited suggestions based on what WHMCS required to function as designed.
</div>

===WHMCS Rules===
A copy of the WHMCS ruleset for your current version of WHMCS is displayed for your inspection and application. Some web environments provide alternative mechanisms for performing URI rewrites on inbound HTTP requests. Your system administrative staff should be able to update your alternative web environment based on this information to fully utilize the Friendly URLs feature of WHMCS.

<pre>
### BEGIN - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
<IfModule mod_rewrite.c>
RewriteEngine on

# RewriteBase is set to "/" so rules do not need updating if the
# installation directory is relocated. It is imperative that
# there is also a RewriteCond rule later that can effectively get
# the actual value by comparison against the request URI.
#
# If there are _any_ other RewriteBase directives in this file,
# the last entry will take precedence!
RewriteBase /

# Redirect directories to an address with slash
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^(.+[^/])$ $1/ [R]

# Send all remaining (routable paths) through index.php
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# Determine and use the actual base
RewriteCond $0#%{REQUEST_URI} ([^#]*)#(.*)\1$
RewriteRule ^.*$ %2index.php [QSA,L]
</IfModule>
### END - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###
</pre>

System Health Status

2021-01-11T18:06:09Z

DanR: /* The Checks */

The '''System Health Status''' page provides an overview of the WHMCS installation and system environment status. This can be found under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Health'''

It will highlight any potential configuration or security related issues that may need your attention.

It also allows you to check if any updates are available for your currently installed WHMCS version, as well as providing quick and easy access to the Changelog and Release Notes for it.

==The Checks==

[[File:SystemHealthStatusPage.png|thumb|System Health Status Page]]An overview of the checks performed and the purpose of each is provided below.

'''System Cron Tasks'''

Checks that the system cron has run to completion within the last 24 hours. If this reports a failure, it indicates that either the cron is not running (invalid cron command, file permissions, cron folder path, etc.) or that the cron is failing to complete successfully.

If this check reports a problem, you should begin by checking your cron command configuration and the activity log within WHMCS. Further helpful documentation regarding this check can be found [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#system_cron_tasks here]

For further assistance, please contact our support team.

'''Cron PHP Version Mismatch'''

Many server configurations utilize a separate php.ini file in the command line or cron engine than the web server uses. This can sometimes cause issues when different configurations are used in two places.

This warning identifies if automation tasks are being executed under different PHP versions to that being used to visit the admin area via a browser.

Please [https://help.whmcs.com/m/automation/l/969680-identifying-the-php-ini-used-for-in-command-line-cron-engine review this guide] for step-by-step instructions to resolve this situation on a stock cPanel server.

Otherwise contact your server admin/hosting provider for assistance.

<div class="docs-alert-info">
The result of this check are cached so the warning may not disappear immediately after making the necessary changes to resolve the issue and will only update after the Daily Cron tasks have been executed.
</div>

'''Insecure Permissions Check'''

Ensures that key files and directories have appropriate permissions. Will alert you to ownership mismatches and/or permission levels that are higher than required for day-to-day operation of the system.

Please see this [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#permissions_check help guide] for more information.

'''Required PHP Extensions'''

Checks for any PHP extensions required by WHMCS to operate and will alert you to any that are missing. Should any be reported as missing, you should recompile PHP with the missing extensions included, as detailed [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#required_php_extensions here]

'''Recommended PHP Extensions'''

Checks for the presence of recommended PHP extensions. While not strictly required, this will alert you to any extensions which are not available in your environment that are either required by certain addons/modules or that can help provide improved performance. Detailed in our help guide [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#recommended_php_extensions here] we recommend recompiling PHP with the missing extensions listed.

'''Required PHP Functions'''

Checks for any PHP functions that are required for WHMCS to operate and will alert you to any that are disabled. If you see any functions reported here, you should check for the presence of them in the ''php.ini'' configuration file '''disable_functions''' setting and remove them.

'''PHP Memory Limit'''

Checks the memory limit setting in your PHP environment and will alert you when it is too low. Will alert you by way of a failure level alert when below the minimum required value and a warning level alert when above the minimum but below the recommended value. For more details on the required memory limit, please refer to the [[System Requirements]] page.

'''Error Reporting'''

Alerts you if error reporting is enabled in your environment. While useful for development and debugging situations, in production, we strongly recommend having error reporting disabled for security reasons.

'''PHP Error Levels'''

Alerts you if the error reporting level is set to a very high level. We recommend only logging certain error types, as detailed [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#display_errors here]

'''PHP Version'''

Checks your PHP Version. Will alert you if your current PHP version has reached End of Life and is no longer supported by the PHP Group.

'''Customising Default Paths'''

Checks for the existance of custom directory paths. You can customise some of the default directory paths in WHMCS to make it more difficult for malicious users to find them. This check will alert you if any directories that support customisation have not been customised. Please see [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#custom_templates this] helpful documentation about this.

'''Using Default Templates'''

Alerts you if any template settings are set to a template of a default name which could be an indication of customisations having been made to a default template. This can result in customisations being lost at the time of the next upgrade. Please see [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#custom_templates this] helpful documentation about this.

'''Installed cURL Version'''

Checks the installed curl version and alerts you if your version is known to have any vulnerabilities. More information available [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#curl_tls_openssl_version_warnings here]

'''SSL Support in cURL'''

Checks to ensure that the curl library present in the PHP environment has SSL support which is required for normal WHMCS operation and many of the modules which come with WHMCS.

'''PHP Session Support'''

Alerts you to any issues with the PHP Session configuration in your PHP environment, please see both [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#the_php_session_save_path_is_not_writeable this] documentation and [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#the_php_session_save_path_is_not_writeable this] for more information.

'''Secure TLS Support in cURL'''

Checks to ensure that the curl library present in the PHP environment supports secure TLS versions (TLS v1.1 and v1.2). With many payment vendors phasing out legacy SSL/TLS protocols in accordance with PCI DSS recommendations, this check will help to stay up to date with newer standards.

Stripe ACH

2021-01-11T17:58:41Z

DanR: /* Getting Started */

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a Payment Gateway Module in version 7.9 and above.</div>
__TOC__
{{gateways
| type = token
| recurring = yes
| onetime = yes
| refunds = yes
| deletecc = yes
}}

==Getting Started==

To activate and configure the Stripe ACH module for use, follow the steps below.

<div class="docs-alert-info">Plaid and Stripe have partnered in order to offer frictionless money transfers without the need to ever handle an account or routing number. Using Plaid allows you to instantly authenticate a customer's account and automatically generate a Stripe bank account token. The WHMCS Stripe ACH integration requires Plaid. If you do not have a Plaid account, you can sign up at https://dashboard.plaid.com/signup</div>
<div class="docs-alert-warning">
<span class="title">Activate ACH at Stripe</span><br />
Before payments can be processed via Stripe ACH, it is necessary to activate ACH capabilities on your Stripe account. This guide demonstrates the process: https://plaid.com/docs/stripe/#step1
</div>

# Begin by logging into the [https://dashboard.plaid.com/team/integrations Plaid control panel] and navigate to ''Team Settings > Integrations''
# Click ''Enable'' next to the Stripe integration and follow the on-screen instructions through to completion
# Once Plaid and Stripe are successfully linked, login to your WHMCS Administration Area
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
# Select the All Payment Gateways tab
# Locate '''Stripe ACH''' and click to activate it
# Stripe ACH uses API keys for authentication. Upon activation, you will be asked to enter the Secret and Publishable API Keys. If you currently have the [[Stripe]] gateway configured you can check the box for "Use Stripe Configuration" to use the same API keys as the existing [[Stripe]] gateway without needing to enter them again.
#* These can be found inside the Stripe portal at https://dashboard.stripe.com/account/apikeys [[File:Stripe ach gateway.png|thumb|Stripe ACH Configuration in WHMCS]]
# Do not enter a value for the Webhook Secret Key, it will be generated automatically.
# Stripe ACH uses Plaid to validate bank information entered by clients. You will need to enter your Plaid Client ID, Public Key and Secret
#* These can be found inside the Plaid portal at https://dashboard.plaid.com/account/keys
<div class="docs-alert-info">When using newer Plaid accounts, 'link_tokens' are provided instead of 'public_key', you will need to contact Plaid support and request public_key is enabled on your Plaid account if you are also using a version of WHMCS prior to 8.1.0.
<br />
When using WHMCS 8.1.0+ no changes are required to the Plaid account.</div>

# Customise the Display Name as desired
# Customise the Statement Descriptor if desired (maximum of 22 characters)
# Click '''Save Changes''' to complete the setup process.

Stripe ACH is now active and ready for use.

<div class="docs-alert-info">'''Transaction Fees:''' Stripe returns transaction fees in the default currency of the Stripe account. If you have a different default currency in WHMCS, you must ensure you have configured the currency of your Stripe account in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, ''Setup > Payments > Currencies'' along with a valid exchange rate to allow WHMCS to be able to convert the fee into your other currencies.</div>

===Webhook Secret Key===

The Stripe ACH module requires a valid Webhook and Secret Key in order for payments to be recognised and automatically applied to invoices.

Should the Secret Key for the Webhook be modified at Stripe, this must be updated within the WHMCS Stripe ACH module configuration:

* Login to your Stipe account, navigate to '''Developers > Webhooks page'''
* Click on the webhook for the ''stripe_ach.php'' URL (there should only be one)
*In the Signing Secret section click '''Click to reveal'''
*Copy the secret and login to the WHMCS Admin Area
*Navigate to the '''Manage Existing Gateways''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
*Paste the value into the '''Stripe ACH WebHook Endpoint Secret''' field.
*Click Save Changes

Subsequent payment notifications will be passed to WHMCS successfully once again.

==Payment Workflow==

# Automated recurring and on-demand billing is supported.
# ACH Payments can take up to 5 days to process. The invoice will be placed in Payment Pending until the payment has cleared.
# When making a payment, customers are able to select to use a previously stored bank account or enter a new one.
# Customers never leave your WHMCS installation during checkout or adding/removing a new bank account.
# Personal bank information is submitted directly to Stripe/Plaid and is never stored in your local WHMCS installation.
# The Stripe API is used for refunds and obtaining transaction information.

==Troubleshooting==
===error===
A simple message '''error''' when attempting to make payment indicates invalid credentials or incomplete Plaid configuration. To resolve it, please check the following points:

1. The Plaid Client Id, Public Key and Secret combination is being rejected.

Ensure the API Keys have been correctly copied from your [https://dashboard.plaid.com/account/keys|Plaid account] into WHMCS in the '''Manage Existing Gateways''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.

Please review the [[#Getting Started]] steps above to ensure all the configuration has been fully completed.

2. The Sandbox/Development Secret is being used in a live move or vice versa.
Plaid issues individual Secrets for use with the Sandbox, Developer and Live environments. Ensure that the Plaid Secret entered correctly corresponds to the Plaid Environment setting.

To use Plaid in production mode to process real payments:
* Login to your [https://dashboard.plaid.com/account/keys Plaid account], navigate to ''Team Settings > Keys''
* Copy the Production Secret
* In the WHMCS Admin, navigate to the '''Manage Existing Gateways''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
* Use the ''Plaid Environment'' dropdown to select the '''Production''' option
* Paste it into the Plaid Secret field
* Click Save Changes
Please review the [[#Getting Started]] steps above to ensure all the configuration has been fully completed.

3. The Stripe integration is not enabled in your Plaid account.
To use Stripe ACH, Plaid must be linked to your Stripe account.

Follow these steps to activate the Stripe integration with your Plaid account: https://plaid.com/docs/stripe/#step1
Please review the [[#Getting Started]] steps above to ensure all the configuration has been fully completed.

Support Departments

2021-01-11T17:53:52Z

DanR: /* Creating Departments */

==Departments==

Support departments help you categorize tickets. The first step in the user ticket submission process is to choose a department. You can assign different staff to different departments with different people handling the different areas. Sales, Support, and Billing are common departments. For more information about the Support Ticket system, see [[Support Tickets]].

==Creating Departments==

To set up departments:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments''' ('''Setup > Support > Support Departments''' prior to WHMCS 8.0) and click '''Add New Department'''.
# Enter a '''Department Name''' and '''Description''' to display to users. The system will use the email address to send notifications relating to the ticket to users. Make this unique for each department.
# For '''Assigned Admin Users''', check the boxes for each admin who will have access to the tickets in this department.
# For '''Clients Only''', specify whether it's a clients-only department, which requires you to log in. For example, Sales would be a public department while you might set Support to clients-only.
# For '''Pipe Replies Only''', select whether to require users to log in to the Client Area to open new tickets. Attempts to open new tickets via email will fail, but users can still respond to tickets via email.
# For '''No Autoresponder''', check the box to prevent sending an autoresponder email when a new ticket opens
# For '''Feedback Request''', check the box to send an email request for a user to provide feedback for their support ticket experience. You can review the results of the feedback emails via the '''Ticket Feedback Scores''' and '''Ticket Feedback Comments''' reports.
# For '''Hidden''', check the box to hide the department. Users can only access hidden departments via a direct link.
# If you want to poll your mailserver using mail importing, enter the appropriate information at the bottom of the form. For more information, see [[Email Importing]] and [https://help.whmcs.com/m/support_tools/l/1328652-setting-up-pop3-importing-with-oauth-via-google Setting Up POP3 Importing with OAuth via Google].
# Click '''Add New Department'''.

<div class="docs-alert-warning">
<span class="title">Re-using email addresses</span><br/>
Using the same POP3 details on multiple support departments is not recommended and will likely cause duplicate tickets to be imported.
</div>

==Custom Fields==

After you create a department, you can create [[custom fields]] to display during ticket submission. Click '''Edit''' next to the department and go to the '''Custom Fields''' tab.

==Email Piping and Importing==

You can automatically send user emails into the ticket system as tickets and ticket replies. To do this, you will need to either pipe or import the email into WHMCS (email piping and email importing).

* For more information about email piping, see [[Email Piping]].
* For more information about email importing, see [[Email Importing]].

System Health Status

2020-12-30T20:50:01Z

DanR:

The '''System Health Status''' page provides an overview of the WHMCS installation and system environment status. This can be found under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Health'''

It will highlight any potential configuration or security related issues that may need your attention.

It also allows you to check if any updates are available for your currently installed WHMCS version, as well as providing quick and easy access to the Changelog and Release Notes for it.

==The Checks==

[[File:SystemHealthStatusPage.png|thumb|System Health Status Page]]An overview of the checks performed and the purpose of each is provided below.

'''System Cron Tasks'''

Checks that the system cron has run to completion within the last 24 hours. If this reports a failure, it indicates that either the cron is not running (invalid cron command, file permissions, cron folder path, etc.) or that the cron is failing to complete successfully.

If this check reports a problem, you should begin by checking your cron command configuration and the activity log within WHMCS. Further helpful documentation regarding this check can be found [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#system_cron_tasks here]

For further assistance, please contact our support team.

'''Cron PHP Version Mismatch'''

Many server configurations utilize a separate php.ini file in the command line or cron engine than the web server uses. This can sometimes cause issues when different configurations are used in two places.

This warning identifies if automation tasks are being executed under different PHP versions to that being used to visit the admin area via a browser.

Please [https://help.whmcs.com/m/automation/l/969680-identifying-the-php-ini-used-for-in-command-line-cron-engine review this guide] for step-by-step instructions to resolve this situation on a stock cPanel server.

Otherwise contact your server admin/hosting provider for assistance.

'''Insecure Permissions Check'''

Ensures that key files and directories have appropriate permissions. Will alert you to ownership mismatches and/or permission levels that are higher than required for day-to-day operation of the system.

Please see this [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#permissions_check help guide] for more information.

'''Required PHP Extensions'''

Checks for any PHP extensions required by WHMCS to operate and will alert you to any that are missing. Should any be reported as missing, you should recompile PHP with the missing extensions included, as detailed [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#required_php_extensions here]

'''Recommended PHP Extensions'''

Checks for the presence of recommended PHP extensions. While not strictly required, this will alert you to any extensions which are not available in your environment that are either required by certain addons/modules or that can help provide improved performance. Detailed in our help guide [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#recommended_php_extensions here] we recommend recompiling PHP with the missing extensions listed.

'''Required PHP Functions'''

Checks for any PHP functions that are required for WHMCS to operate and will alert you to any that are disabled. If you see any functions reported here, you should check for the presence of them in the ''php.ini'' configuration file '''disable_functions''' setting and remove them.

'''PHP Memory Limit'''

Checks the memory limit setting in your PHP environment and will alert you when it is too low. Will alert you by way of a failure level alert when below the minimum required value and a warning level alert when above the minimum but below the recommended value. For more details on the required memory limit, please refer to the [[System Requirements]] page.

'''Error Reporting'''

Alerts you if error reporting is enabled in your environment. While useful for development and debugging situations, in production, we strongly recommend having error reporting disabled for security reasons.

'''PHP Error Levels'''

Alerts you if the error reporting level is set to a very high level. We recommend only logging certain error types, as detailed [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#display_errors here]

'''PHP Version'''

Checks your PHP Version. Will alert you if your current PHP version has reached End of Life and is no longer supported by the PHP Group.

'''Customising Default Paths'''

Checks for the existance of custom directory paths. You can customise some of the default directory paths in WHMCS to make it more difficult for malicious users to find them. This check will alert you if any directories that support customisation have not been customised. Please see [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#custom_templates this] helpful documentation about this.

'''Using Default Templates'''

Alerts you if any template settings are set to a template of a default name which could be an indication of customisations having been made to a default template. This can result in customisations being lost at the time of the next upgrade. Please see [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#custom_templates this] helpful documentation about this.

'''Installed cURL Version'''

Checks the installed curl version and alerts you if your version is known to have any vulnerabilities. More information available [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#curl_tls_openssl_version_warnings here]

'''SSL Support in cURL'''

Checks to ensure that the curl library present in the PHP environment has SSL support which is required for normal WHMCS operation and many of the modules which come with WHMCS.

'''PHP Session Support'''

Alerts you to any issues with the PHP Session configuration in your PHP environment, please see both [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#the_php_session_save_path_is_not_writeable this] documentation and [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#the_php_session_save_path_is_not_writeable this] for more information.

'''Secure TLS Support in cURL'''

Checks to ensure that the curl library present in the PHP environment supports secure TLS versions (TLS v1.1 and v1.2). With many payment vendors phasing out legacy SSL/TLS protocols in accordance with PCI DSS recommendations, this check will help to stay up to date with newer standards.

File:SystemHealthStatusPage.png

2020-12-30T20:46:45Z

DanR:

Server Sync Tool

2020-12-30T19:35:45Z

DanR: /* Choosing items to be Imported/Synced */

==Introduction==

The server sync tool can be used to syncronise records within WHMCS with a remote web server or module.

It allows you to easily identify and resolve discrepancies in the following contexts:

* Accounts that exist on the remote system (typically a web server) but that do not exist within WHMCS
* Service records that are active within WHMCS but that do not exist on the remote system
* Service records that exist within WHMCS but have differing info to the remote system

The sync tool has a 3 step process, first analysing accounts and providing you with an informative report that highlights any discrepancies, and giving you the opportunity to review and either resolve discrepancies manually, or have the tool automatically correct them for you.

<div class="docs-alert-info">This tool has replaced the ''cPanel/WHM Import'' tool that could previously be found under the Utilities menu prior to WHMCS 7.8</div>

==Performing a Sync==

To perform a sync, follow the steps below.

# Begin by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
# Click the ''Sync Accounts'' button for the server you wish to analyse. Note that this button will only appear for servers assigned to modules that support the Sync functionality. At the time of writing this includes: cPanel, Plesk and DirectAdmin modules.
# WHMCS will make an API call to the remote web server to fetch an up-to-date list of account records. This may take a few seconds.
# Upon completion, an analysis summary report will be displayed to you that looks something like the following.

[[File:Server_sync_analyse.png|frame|800px]]

From here you can review the discrepancies between the service records within WHMCS and the records on the remote system.

The report UI is broken up into two columns. On the left is the data retrieved from the remote system, and on the right are the service record matches found within WHMCS. Any differences will be highlighted in red. Exact matches will be highlighted in green.

The ID column within the WHMCS service record area of the UI provides a link to the manage service screen for those records. This can be used to jump to a service within WHMCS and make quick manual edits.

===Choosing items to be Imported/Synced===

The Import/Sync checkbox on the far right of the review table can be checked in order to have a service automatically updated by the Sync Tool. There are 3 possible scenarios:

# '''Partial Match''' - Service record exists in WHMCS but there are some discrepancies in data - checking the Import/Sync checkbox for a service like this will result in the service being modified to match the information returned from the remote system. This can include updating any of the following: domain, primary IP, username, product, status and/or creation date.
# '''Missing within WHMCS''' - This occurs when an account exists on the remote system, but no matching service record can be found within WHMCS. Select the Import/Sync option for a record like this will result in a new service record being created. WHMCS will attempt to use an existing product if a match is found, otherwise it will create a new product also.
# '''Missing on Remote System''' - This occurs when a service record exists within WHMCS but not on the remote system.
'''''To Terminate the Service in WHMCS:''''' Selecting the Import/Sync option for a record like this will cause the service to be set to Terminated within WHMCS.

'''''To Create the Service on the Server:''''' Go to the Service, ensure the details are set correctly and click the Create button to provision it again.

<div class="docs-alert-warning">Auto-imported services will be created under an existing client with a matching email address, or a newly created client where no existing match exists. Since most web server control panels do not track end customer details, we can usually import only an email address and other details must be populated manually. In cases where even an email address is not available, a placeholder email address of {domain}@example.com will be used for the client in WHMCS.</div>

Once you have made your selections of the accounts you wish to import/sync, click Continue. This will take you to a Review step.

===Reviewing Import/Sync Items===

After selecting the records you wish to sync on the Analyse step, you will be presented with a Review step as pictured below.

[[File:Server_sync_review.png|frame|800px]]

The review summary will be broken up into the 3 categories described above, making clear what actions are about to be performed for each of the records you selected.

If you want to make any changes, hit the Back button located to the bottom left of the review screen. Once you are happy, hit the Continue button to execute the Sync process.

Upon completion, you will be presented with a summary of the sync process. Further details indicating what records have been updated or changes will be available in the activity log. Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' or, prior to WHMCS 8.0, '''Utilities > System > Activity Log''' to review it.

Marketgoo via WHMCS MarketConnect

2020-12-29T18:16:29Z

DanR:

{{MarketConnect}}
WHMCS MarketConnect allows you to resell marketgoo SEO services.

==Supported Actions==

* Automated provisioning of new Marketgoo accounts
* Single sign-on into the marketgoo SEO Dashboard from Client and Admin Areas
* Upsells/Promotions within the client area
* Automated Cancellation

==Setup and Configuration==

To activate and begin reselling marketgoo via WHMCS MarketConnect, simply navigate to Setup > MarketConnect within your WHMCS admin area and click the Activate button under the marketgoo product offering.

==marketgoo Automation==

When ordering marketgoo as a stand alone service or as an add-on to a Hosting or Reseller Account, WHMCS and MarketConnect fully automates the marketgoo provisioning process. This will start the marketgoo analysis process for the provided domain.

==Admin Management Actions==

For any marketgoo order, an Admin user is able to perform the following actions from the service management page:

* '''Login to the marketgoo Dashboard''' - Clicking this button will perform single sign-on into the marketgoo dashboard for the given website.

Single Sign-On to the marketgoo dashboard can also be accessed via the MarketConnect management page in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > MarketConnect > marketgoo > Manage''' or, prior to WHMCS 8.0, '''Setup > MarketConnect > marketgoo > Manage'''

[[File:MarketgooServiceManagement.png]]

==Client Management Actions==

When logged into the Client Area, if a customer has an active marketgoo service, they will be provided with a link to Single Sign-On into the marketgoo Dashboard from where they can manage and use the marketgoo service.

==Client Area Promotions==

MarketConnect supports showing marketgoo promotions on the client area homepage, shopping cart and when managing a web hosting product that does not have a marketgoo service attached to it.

For more information, please refer to [[MarketConnect_Promotions_and_Upsells|MarketConnect Promotions and Upsells]].

== Further Reading ==
For further help and information, please refer to our marketgoo Knowledgebase @ https://marketplace.whmcs.com/help/connect/kb/marketgoo

CodeGuard via WHMCS MarketConnect

2020-12-29T18:16:14Z

DanR:

{{MarketConnect}}
WHMCS MarketConnect allows you to resell CodeGuard Cloud Website Backup.

==Supported Actions==

* Automated Provisioning of CodeGuard Services
* Single Sign-On into CodeGuard Dashboard from Client and Admin Areas
* Upsells and Promotions within the Client Area
* Automated Cancellation

==Setup and Configuration==

To activate and begin reselling CodeGuard via WHMCS MarketConnect, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[MarketConnect]]''' or, prior to WHMCS 8.0, '''Setup > MarketConnect''' within your WHMCS admin area. Click the '''Activate''' button under CodeGuard.

==CodeGuard Automation==

When ordering CodeGuard as an addon to a Hosting or Reseller Account, WHMCS and MarketConnect fully automate the CodeGuard provisioning process. This includes automated provisioning of SFTP/FTP access credentials where possible.

===SFTP/FTP Access===

The CodeGuard service uses SFTP access to automatically back up your website.

For all CodeGuard plans, the system provisions dedicated SFTP accounts for cPanel hosting accounts and supplies them to CodeGuard automatically. If the SFTP account creation fails, or, when tested, is unavailable, or when using DirectAdmin hosting accounts, the system creates and supplies a dedicated FTP account. For Plesk servers, the system uses the primary account login details.

If the system can't provision SFTP or FTP access successfully, the welcome email for the customer contains instructions for the user detailing how to create their website backup manually within their CodeGuard account.

==Admin Management Actions==

For any CodeGuard order, an Admin user is able to perform the following actions from the service management page:

* '''Login to CodeGuard Control Panel''' — Clicking this button will perform single sign-on into the CodeGuard dashboard for the given website.

You can also access Single Sign-On to the CodeGuard dashboard via the MarketConnect management page in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[MarketConnect]] > CodeGuard > Manage''' or, prior to WHMCS 8.0, '''Setup > MarketConnect > CodeGuard > Manage'''.

==Client Management Actions==

When logged in to the Client Area, if a customer has an active CodeGuard service, they will receive a link to access and manage their backups that will perform Single Sign-On and take them directly to the CodeGuard Control Panel.

==Client Area Promotions==

MarketConnect supports showing CodeGuard promotions in the client area homepage, sidebar, shopping cart and when managing a web hosting product that does not have a CodeGuard service attached to it.

SiteLock VPN via MarketConnect

2020-12-29T18:15:57Z

DanR:

{{MarketConnect}}
<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.9 and above</div>

WHMCS MarketConnect allows you to resell SiteLock VPN.

==Supported Actions==

* Automated Provisioning of new SiteLock VPN Accounts
* Single Sign-On into the SiteLock Management Dashboard from Client and Admin Areas
* Upsells/Promotions within the client area
* Automated Cancellation

==Setup and Configuration==

To activate and begin reselling SiteLock VPN via WHMCS MarketConnect, simply navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > MarketConnect''' or, prior to WHMCS 8.0, '''Setup > MarketConnect''' within your WHMCS admin area. Click the '''Activate''' button under the SiteLock VPN product offering.

==SiteLock VPN Automation==

When ordering SiteLock VPN, WHMCS and MarketConnect fully automates the VPN account setup process.

==Admin Management Actions==

For any SiteLock VPN order, an Admin user is able to perform the following actions:

* '''Login to SiteLock VPN Control Panel''' - Clicking this button will perform single sign-on into the SiteLock Dashboard.

[[File:Sitelock-vpn-admin-management-panel.png]]

==Client Management Actions==

When logged into the Client Area, if a customer has an active SiteLock VPN service, they will be provided with a panel allowing them to login to the SiteLock Dashboard to manage their VPN service. The SiteLock Dashboard allows for configuration and reset of their VPN access credentials, as well as downloading of the VPN clients.

The SiteLock VPN panel is pictured below.

[[File:sitelock-vpn-clientarea-manage.png]]

==Client Area Promotions==

MarketConnect supports showing a SiteLock VPN promotion (pictured below) on the client area homepage to users who do not currently have the SiteLock VPN service.

[[File:sitelock-vpn-clientarea-promo.png]]

SiteLock via WHMCS MarketConnect

2020-12-29T18:15:33Z

DanR:

{{MarketConnect}}
<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.5 and above</div>

WHMCS MarketConnect allows you to resell SiteLock Website Security services.

==Supported Actions==

* Automated Provisioning of SiteLock services
* Single Sign-On into SiteLock Dashboard from Client and Admin Areas
* Upsells/Promotions within the client area
* Automated Cancellation

==Setup and Configuration==

To activate and begin reselling SiteLock via WHMCS MarketConnect, simply navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > MarketConnect''' or, prior to WHMCS 8.0, ''Setup > MarketConnect'' within your WHMCS admin area and click the '''Activate''' button under the SiteLock product offering.

==SiteLock Automation==

When ordering SiteLock as an add-on to a Hosting or Reseller Account, WHMCS and MarketConnect fully automates the SiteLock provisioning process. This includes automated provisioning of FTP access credentials and DNS records where required.

===FTP Access===

The SiteLock service utilises FTP access to automatically fix infected websites.

For SiteLock plans that offer the auto-fixing service, a dedicated FTP account will be provisioned for cPanel and DirectAdmin hosting accounts and supplied to SiteLock automatically. For Plesk servers the primary account login details are used.

If FTP access is unable to be automatically provisioned successfully, the welcome email sent to the customer contains instructions for the user detailing how to set FTP credentials manually.

===DNS Records===

For the WAF and CDN services offered with some SiteLock plans, there are DNS record changes that have to be performed to utilise the service.

For cPanel, DirectAdmin and Plesk hosting accounts, WHMCS will attempt to do this automatically on the server.

If the automatic provisioning fails, or an external DNS service is being used, the record changes will need to be performed manually. The SiteLock Welcome Email sent to the customer following activation of the service contains instructions that detail the changes needed.

==Admin Management Actions==

For any SiteLock order, an Admin user is able to perform the following actions from the service management page as shown below:

[[File:Sitelock-marketconnect-service.png]]

* '''Login to SiteLock Control Panel''' - Clicking this button will perform single sign-on into the SiteLock dashboard for the given website.
* '''Update FTP Access Credentials''' - Allows you to update the FTP access credentials for the given website. This only appears for SiteLock services and addons that require FTP. To use this, update the custom field values for FTP access, click '''Save Changes''', and then click this button to submit the new FTP details to SiteLock.

Single Sign-On to the SiteLock dashboard can also be accessed via the MarketConnect management page in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > MarketConnect > SiteLock > Manage''' or, prior to WHMCS 8.0, ''Setup > MarketConnect > SiteLock > Manage''

==Client Management Actions==

When logged into the Client Area, if a customer has an active SiteLock service, they will be provided with a link to Single Sign-On into the SiteLock Dashboard from where they can manage and use the SiteLock service.

==Client Area Promotions==

MarketConnect supports showing SiteLock promotions on the client area homepage, shopping cart and when managing a web hosting product that does not have a SiteLock service attached to it.

For more information, please refer to [[MarketConnect Promotions and Upsells]].

==Further Reading==

For further help and information, please refer to our SiteLock Knowledgebase @ https://marketplace.whmcs.com/help/connect/kb/sitelock_website_security