WHMCS Documentation - User contributions [en]

Version 5.2 Release Notes

2013-11-25T10:54:06Z

Kim: /* Version 5.2.13 */

==Release Information==

===Version 5.2.0===
*Release Type: Beta (For Testing)
*Release Date: 1st February 2013

===Version 5.2.1===
*Release Type: Stable
*Release Date: 12th March 2013

===Version 5.2.2===
*Release Type: Stable
*Release Date: 14th March 2013

===Version 5.2.3===
*Release Type: Stable
*Release Date: 28th March 2013

===Version 5.2.4===
*Release Type: Stable
*Release Date: 23rd April 2013

===Version 5.2.5===
*Release Type: Security
*Release Date: 16th May 2013

===Version 5.2.6===
*Release Type: Targeted Release
*Release Date: 23rd July 2013

===Version 5.2.7===
*Release Type: Maintenance Release
*Release Date: 26th July 2013

===Version 5.2.8===
*Release Type: Security
*Release Date: 3rd October 2013

===Version 5.2.9===
*Release Type: Security
*Release Date: 18th October 2013

===Version 5.2.10===
*Release Type: Security
*Release Date: 20th October 2013

===Version 5.2.11===
*<strike>Release Type: Security</strike> (Packaging error resulted in the release of 5.2.12)
*<strike>Release Date: 25th October 2013</strike>

===Version 5.2.12===
*Release Type: Security
*Release Date: 25th October 2013

===Version 5.2.13===
*Release Type: Security
*Release Date: 21st November 2013

==Changelog==

http://docs.whmcs.com/Changelog:WHMCS_V5.2

==Upgrade Steps==

The same usual steps for upgrading WHMCS apply to Version 5.2. They are:

#Begin by taking a backup of your database using a tool such as phpMyAdmin
#Now download the latest WHMCS version either from our client area (http://wiki.whmcs.com/Upgrading#Downloading_the_Latest_Version) or from your web host license provider
#Next, unzip the contents of the WHMCS zip file download to a folder on your computer
#Now if you have customised your WHMCS admin folder name, you should rename the admin folder in the new files to match
#Upload the new files to your existing installation folder replacing any existing folders & files
#Visit the admin area as you normally would to login and you should then see the upgrade script
#Accept the license agreement
#If you are prompted for any database information *STOP*, this indicates the configuration.php file is missing and so a new install is being attempted - you need to restore the configuration.php before continuing.
#Tick to confirm once you have backed up your database, and then click the upgrade button
#Once the updates finish, delete the install folder from your server

These steps can be used to upgrade from any version of WHMCS from V3.3 & later.

'''Remember: After upgrading, your browser may still display cached versions of the previous files. So if you get any display issues or inconsistencies, always try clearing your cache first, both in your browser, and the WHMCS templates cache (templates_c folder files)'''

==Template Changes==

===Version 5.2.13===

'''Blend Admin Template'''
*clientssummary.tpl
*footer.tpl
*head.js
*header.tpl
*sidebar.tpl

'''Original Admin Template'''
*clientssummary.tpl
*header.tpl
*sidebar.tpl

'''V4 Admin Template'''
*clientssummary.tpl
*head.js
*header.tpl
*sidebar.tpl

===Version 5.2.12===

'''No Template Changes'''

===Version 5.2.11===

'''No Template Changes'''

===Version 5.2.10===

'''No Template Changes'''

===Version 5.2.9===

'''No Template Changes'''

===Version 5.2.8===

'''No Template Changes'''

===Version 5.2.7===

'''No Template Changes'''

===Version 5.2.6===

'''No Template Changes'''

===Version 5.2.5===

'''No Template Changes'''

===Version 5.2.4===

'''Default Template Only'''

*clientareaproductdetails.tpl
*clientareacancelrequest.tpl
*clientareadomaindetails.tpl
*clientareadomains.tpl
*clientareainvoices.tpl
*clientareaproductdetails.tpl
*clientareaproducts.tpl
*clientareaquotes.tpl
*clientarearecordslimit.tpl
*clientareasecurity.tpl
*knowledgebasecat.tpl
*login.tpl
*logintwofa.tpl
*logout.tpl
*supportticketslist.tpl
*css/whmcs.css

'''Modern Order Form Template'''

*configureproductdomain.tpl
*viewcart.tpl

'''Slider Order Form Template'''

*configureproductdomain.tpl

'''Vertical Steps Order Form Template'''

*complete.tpl
*style.css

===Version 5.2.3===

'''All Templates (Classic, Default & Portal)'''
*3dsecure.tpl
*affiliatesignup.tpl
*clientareasecurity.tpl
*logintwofa.tpl
*ticketfeedback.tpl

'''Default Template Only'''
*bulkdomaintransfer.tpl
*clientareadomaindetails.tpl
*clientareahome.tpl
*header.tpl - added enomnewtlds link.
*homepage.tpl

'''Order Form Templates'''
*None

===Version 5.2.2===

'''No Template Changes'''

===Version 5.2.1===

'''/classic/'''
'''affiliates.tpl'''
* Line 32 - Change of colspan from 6 to 5
'''clientareachangesq.tpl'''
* Removed File. Replaced with new functionality.
'''clientareacreditcard.tpl'''
* Line 42 - Change of variable for expiry date from $years to $expiryyears
* Lines 46->53 - Change Start Date from text input to dropdown
* Line 56 - Add CVV input box to allow validation on remote storage
'''clientareadetails.tpl'''
* Line 45->47 - New Lines for email out opt
'''clientareadomaincontactinfo.tpl'''
* Line 21 - New Line for successful change
'''clientareadomains.tpl'''
* Line 32 - removed hard coded "Go" and changed to language string
'''creditcard.tpl'''
* Line 73 - Change of variable for expiry date from $years to $expiryyears
* Lines 78->84 - Change Start Date from text input to dropdown
'''header.tpl'''
* Line 31 - Added check of conditional links to show domains option
* Line 36 - Added check of conditional links to show affiliates option
'''pwresetvalidation.tpl'''
* Complete rewrite '''Required Change'''
'''supportticketssubmit-stepone.tpl'''
* Complete rewrite to handle no departments

'''clientareasecurity.tpl'''
'''ticketfeedback.tpl'''
'''unsubscribe.tpl'''
* New Files for new features

'''/default/'''
'''affiliates.tpl'''
* Line 89 - Change of colspan from 6 to 5
'''bulkdomainchecker.tpl'''
'''bulkdomaintransfer.tpl'''
* Line 48 - Class change on table
'''clientareachangesq.tpl'''
* Removed File. Replaced with new functionality.
'''clientareacreditcard.tpl'''
* Line 104 - Change of variable for expiry date from $years to $expiryyears
* Line 111 - Change Start Date from text input to dropdown
* Lines 122->129 - Add CVV input box to allow validation on remote storage
'''clientareadetails.tpl'''
* Lines 139->146 - New Lines for email out opt
'''clientareadomaincontactinfo.tpl'''
* Lines 22->27 - New Line for successful change
'''clientareahome.tpl'''
* Line 40 - Added strip_tags to announcements to stop format bleeding
* Line 59, 67->69 - Change of variables to use condlinks
'''clientareaproductdetails.tpl'''
* Line 201 - Change hard coded text to language variable
* Line 227 - Change colspan from 3 to 4
'''clientareaquotes.tpl'''
* Line 26 - Added "View Quote" link to view quote inline rather than download
'''clientregister.tpl'''
* Line 2 - Removed pwstrength.js include as no longer required
'''creditcard.tpl'''
* Line 33 - Added new class to form
* Lines 158->164 - Changed start date dropdown to use new variables
* Line 167 - Change of variable for expiry date from $years to $expiryyears
* Line 180 - Removed start date code as moved up the file
'''downloads.tpl'''
* Line 34 - Changed hard coded language strings to variables
'''downloadscat.tpl'''
* Line 38 - Changed hard coded language strings to variables
'''header.tpl'''
* Lines 57->69 - Variable changes to use condlinks
* Lines 99->101 - New affiliate condlink addition
'''homepage.tpl'''
* Line 1,21 - Variable changes to use condlinks
'''knowledgebase.tpl'''
* Line 7,8 - Changed hard coded language strings to variables
'''knowledgebasecat.tpl'''
* Line 10 - new if statement around hidden catid variable
* Line 12,13 - Changed hard coded language strings to variables
'''pwresetvalidation.tpl'''
Complete rewrite *Required Change*
'''supportticketslist.tpl'''
* Line 6 - Variable name change from "q" to "searchterm"
'''supportticketsubmit-stepone.tpl'''
* Lines 16->19 - foreachelse added to handle no departments

'''clientareasecurity.tpl'''
'''ticketfeedback.tpl'''
'''unsubscribe.tpl'''
'''viewquote.tpl'''
* New Files for new features
* viewquote.tpl may be in some installs already

'''/css/'''
'''quote.css'''
* New File

'''/portal/'''
'''affiliates.tpl'''
* Line 72 - Change of colspan from 6 to 5
'''clientareachangesq.tpl'''
* Removed File. Replaced with new functionality.
'''clientareacreditcard.tpl'''
* Line 45 - Change of variable for expiry date from $years to $expiryyears
* Lines 49->54 - Change Start Date from text input to dropdown
* Line 57 - Add CVV input box to allow validation on remote storage
'''clientareadetails.tpl'''
* Lines 88->93 - New Lines for email out opt
'''clientareadomaincontactinfo.tpl'''
* Lines 18->21 - New Lines for successful change
'''clientareadomains.tpl'''
* Line 51 - Changed hard coded language strings to variables
'''creditcard.tpl'''
* Line 110 - Change of variable for expiry date from $years to $expiryyears
* Lines 118->124 - Changed start date dropdown to use new variables
'''header.tpl'''
* Line 27,32 - Variable changes to use condlinks
'''pwresetvalidation.tpl'''
Complete rewrite *Required Change*
'''supportticketsubmit-stepone.tpl'''
Complete rewrite to handle no departments
'''viewquote.tpl'''
* Line 40,46 - Update link used if TOS used

'''clientareasecurity.tpl'''
'''ticketfeedback.tpl'''
'''unsubscribe.tpl'''
* New Files for new features

'''/orderforms/ajaxcart/'''
'''adddomain.tpl'''
* Line 22 - Moved availablilty form further down
* Lines 45->80 - availablilty form moved including code to show domain configuration where not showing originally
'''configuredomains.tpl'''
* Lines 13->15 - Onclick function added to addons checkboxes
'''viewcart.tpl'''
* Line 89 - Change of variable for expiry date from $years to $expiryyears
* Lines 93->98 - Change Start Date from text input to dropdown
* Line 110 - Added code to change value of button when clicked to deter multiple clicks

'''/orderforms/boxes/'''
'''adddomain.tpl'''
* Line 9 - Changed hard coded language strings to variables
'''viewcart.tpl'''
* Line 269 - Change of variable for expiry date from $years to $expiryyears
* Lines 273->278 - Change Start Date from text input to dropdown

'''/orderforms/cart/'''
'''adddomain.tpl'''
* Line 11 - Changed hard coded language strings to variables
'''viewcart.tpl'''
* Line 290 - Change of variable for expiry date from $years to $expiryyears
* Lines 294->299 - Change Start Date from text input to dropdown

'''/orderforms/comparison/'''
'''viewcart.tpl'''
* Line 239 - Change of variable for expiry date from $years to $expiryyears
* Lines 243->248 - Change Start Date from text input to dropdown

'''/orderforms/modern/'''
'''/orderforms/slider/'''
'''addons.tpl'''
* Line 4 - removed incorrect css line
'''viewcart.tpl'''
* Line 243 - Change of variable for expiry date from $years to $expiryyears
* Lines 248->255 - Change Start Date from text input to dropdown

'''/orderforms/verticalsteps/'''
'''adddomain.tpl'''
* Line 31 - Changed hard coded language strings to variables
'''viewcart.tpl'''
* Line 287 - Change of variable for expiry date from $years to $expiryyears
* Lines 292->299 - Change Start Date from text input to dropdown

'''/orderforms/web20cart/'''
'''adddomain.tpl'''
* Line 24 - Changed hard coded language strings to variables
'''login.tpl'''
* Line 29 - Changed input from text to password
'''viewcart.tpl'''
* Line 562 - Change of variable for expiry date from $years to $expiryyears
* Lines 569->574 - Change Start Date from text input to dropdown

==Release Notes==

*'''Display Problems/Browser Cache''' - Always clear your browser cache, or perform a hard refresh after upgrading, most display related issues are purely due to seeing an old version of the CSS
*The '''Add Transaction''' permission is now required in order to apply payment to an invoice - previously access to Manage Invoices was also sufficient
*The '''dbconnect.php''' file has been removed as of WHMCS V5.2 and so any custom files will require updating to include "init.php" and only "init.php", the current separate "functions.php" include will be handled automatically
*In the viewinvoice.tpl template file the variable {$subscriptionid} has been changed to {$subscrid}
*The '''ResellerClub''' domain registrar module now uses the API Key authentication method, replacing the account password. If using this module you will need to enter your API Key under Setup > Products/Services > Domain Registrars. Detailed instructions can be found on the [[ResellerClub]] page.

Order Form Templates

2013-10-06T09:57:02Z

Kim:

WHMCS comes with many built in templates as standard. More information on these can be found @ '''[[Standard Order Form Templates]]''' However, you can also customise and create your own cart templates and the process is explained below.

An explanation of the purpose of each template file is provided below:

*products.tpl - Lists product categories and products
*adddomain.tpl - First step for domain registration only orders
*addons.tpl - Lists the addons a user can order for their existing packages when logged in
*domainrenewals.tpl - Lists domains in the clients account and allows for renewals to be ordered in advance
*configureproductdomain.tpl - Domain selection for domains attached to a product
*domainoptions.tpl - Used by some templates to display domain availability check results
*configureproduct.tpl - Configure the product before adding to the cart eg. billing cycle, configurable options, custom fields
*configuredomains.tpl - Choose domain addons, complete custom field requirements & custom nameservers
*ordersummary.tpl - Used to display cart contents and product total summaries during order process
*viewcart.tpl - Showing cart contents & checkout process
*login.tpl - Used for login for existing users
*complete.tpl - This page is showed at the end of the checkout process

==Creating a Custom Template==

If you want to customise anything in the WHMCS templates, the first step we always recommend is to create your own template folder. You should never edit the default templates directly. So to do this, simply perform the following steps:

#Duplicate one of the standard folders in the /templates/orderforms/ folder (cart, web20cart, modern, slider etc.) and rename it to a custom name
#The directory name should be all one word and consist of just lowercase letters and numbers.
#Now make your customisations and changes as desired (see section below for more details on this)
#Once complete, upload your new templates folder to the templates directory of WHMCS on your server
#You can preview your new template by specifying it using an url "on the fly" such as www.yourdomain.com/whmcs/?carttpl=xxxxx where xxxxx is the name of your new template. See [[Linking to WHMCS]] for more info on this.
#Once you're happy with it and ready to show the world, you can set it live by going to '''Setup > General Settings''' and on the Ordering tab of the general settings choosing your new custom template name from the Template's dropdown menu

Whichever template is selected here is referred to throughout the documentation as the '''active template folder'''.

==Third Party Order Conversion/Affiliate Tracking==

When checkout is completed and the customer makes payment for their order, they get returned to the order completed page. This page is controlled by the complete.tpl template file in your active order template folder. So if you want to use a third party order conversion tracking or affiliate system and need to execute javascript after checkout, then you will need to insert code into this file.

This file contains an {if $ispaid}{/if} section as below so you can put code either inside those tags so that it only runs once an order has been paid for, or outside them so it runs regardless of payment status.

{if $ispaid}
Enter any HTML code which needs to be displayed once a user has
completed the checkout of their order here - for example
conversion tracking and affiliate tracking scripts
{/if}

You can use variables including {$orderid} {$ordernumber} and {$amount} where necessary to fill in order details.

==Remove Fields From Order Form==

By default most of the client's profile fields are required on the order form, it is possible via the '''Setup > General Settings > Other tab > [[Other_Tab#Optional_Client_Profile_Fields|Optional Client Profile Fields]]''' option to make certain fields optional. If you want to remove one of the default fields on your order form entirerly, you can change the field type to hidden and supply a default value of NA. The following example shows to to hide the Address 2 field from the viewcart.tpl page:

Find:

<input type="text" name="address2" style="width:80%;" value="{$clientsdetails.address2}" />

Replace with:

<input type="hidden" name="address2" style="width:80%;" value="NA" />

Installing WHMCS

2013-09-06T09:58:04Z

Kim: /* Installing WHMCS */

==Downloading WHMCS==

To download WHMCS, login to our client area at [http://www.whmcs.com/members/clientarea.php www.whmcs.com/members] and then do the following:

#Click the My Licenses & Services link under the Services menu
#Select one of your active license keys to view the details
#Choose the latest stable version to download from the downloads tab on this page

==Installing Ioncube==

WHMCS is encrypted using Ioncube to protect the source code. These days most servers/webhosts have Ioncube support compiled into the PHP build by default so you don't normally need to do anything extra for it. However if you find you do need to install Ioncube on your server, then you can find out how to do this in our [[Ioncube Installation Tutorial]]

==Installing WHMCS==

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=7gANkXcOBoc|Watch Video Tutorial]]

Installing WHMCS is very simple. The following steps will guide you through the process:

#Unzip the contents of the zip file to a folder on your computer
#Rename the file configuration.php.new to configuration.php
#Upload the entire whmcs folder to your website - if you experience problems, try uploading in binary mode
#Next you can rename the folder to whatever you like (billing, clients, etc...)
#Now visit the installation script at http://www.yourdomain.com/whmcs/install/install.php to run the installer process - if you get an Ioncube related error message, see the installation Ioncube steps above
#Follow the instructions on screen to install which will involve setting file permissions as listed below, entering your license key and setting up your primary admin account
#When complete, delete the install folder from your web server and CHMOD the configuration.php file back to 644.

Required file & folders permissions (unless your php is suPHP or PHPSuExec):

/configuration.php CHMOD 644 Writeable
/attachments CHMOD 777 Writeable
/downloads CHMOD 777 Writeable
/templates_c CHMOD 777 Writeable

==Post Installation Suggested Steps==

After installation is completed, we recommend that you go through and configure your new WHMCS system in the following order:

#Login to the Admin Area and configure your General Settings (Setup > [[Configuration|General Settings]])
#Setup your Payment Gateways (Setup > [[Payment Gateways]])
#Setup your Products & Services (Setup > [[Products and Services]])
#Configure your Domain Pricing (Setup > [[Domains_Configuration|Domain Pricing]])
#Setup your Support Ticket Departments (Setup > [[Support_Center|Support Departments]])
#Setup email piping so you can manage tickets using the WHMCS Support Desk - for full instructions on this please see the [[Email Piping]] article
#Ensure the WHMCS Cron Job is setup and configure automated tasks (Setup > [[Automation Settings]])
#Place some test orders on your website to check everything works as expected

[[File:Videotutorial.png‎|center|link=https://www.whmcs.com/get-support/video-tutorials/|Watch Video Tutorial]]
For further guidance, you can watch video tutorials we have prepared for the above tasks @ [https://www.whmcs.com/get-support/video-tutorials/ www.whmcs.com/get-support/video-tutorials/]

Installing WHMCS

2013-09-06T09:57:42Z

Kim: /* Installing WHMCS */

==Downloading WHMCS==

To download WHMCS, login to our client area at [http://www.whmcs.com/members/clientarea.php www.whmcs.com/members] and then do the following:

#Click the My Licenses & Services link under the Services menu
#Select one of your active license keys to view the details
#Choose the latest stable version to download from the downloads tab on this page

==Installing Ioncube==

WHMCS is encrypted using Ioncube to protect the source code. These days most servers/webhosts have Ioncube support compiled into the PHP build by default so you don't normally need to do anything extra for it. However if you find you do need to install Ioncube on your server, then you can find out how to do this in our [[Ioncube Installation Tutorial]]

==Installing WHMCS==

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=7gANkXcOBoc|Watch Video Tutorial]]

Installing WHMCS is very simple. The following steps will guide you through the process:

#Unzip the contents of the zip file to a folder on your computer
#Rename the file configuration.php.new to configuration.php
#Upload the entire whmcs folder to your website - if you experience problems, try uploading in binary mode
#Next you can rename the folder to whatever you like (billing, clients, etc...)
#Now visit the installation script at http://www.yourdomain.com/whmcs/install/install.php to run the installer process - if you get an Ioncube related error message, see the installation Ioncube steps above
#Follow the instructions on screen to install which will involve setting file permissions as listed below, entering your license key and setting up your primary admin account
#When complete, delete the install folder from your web server and CHMOD the configuration.php file back to 644.

Required file & folders permissions (unless your php is suPHP or PHPSuExec):

/configuration.php CHMOD 644 Writeable
/attachments CHMOD 777 Writeable
/downloads CHMOD 777 Writeable
/templates_c CHMOD 777 Writeable

This is a whmcs test

==Post Installation Suggested Steps==

After installation is completed, we recommend that you go through and configure your new WHMCS system in the following order:

#Login to the Admin Area and configure your General Settings (Setup > [[Configuration|General Settings]])
#Setup your Payment Gateways (Setup > [[Payment Gateways]])
#Setup your Products & Services (Setup > [[Products and Services]])
#Configure your Domain Pricing (Setup > [[Domains_Configuration|Domain Pricing]])
#Setup your Support Ticket Departments (Setup > [[Support_Center|Support Departments]])
#Setup email piping so you can manage tickets using the WHMCS Support Desk - for full instructions on this please see the [[Email Piping]] article
#Ensure the WHMCS Cron Job is setup and configure automated tasks (Setup > [[Automation Settings]])
#Place some test orders on your website to check everything works as expected

[[File:Videotutorial.png‎|center|link=https://www.whmcs.com/get-support/video-tutorials/|Watch Video Tutorial]]
For further guidance, you can watch video tutorials we have prepared for the above tasks @ [https://www.whmcs.com/get-support/video-tutorials/ www.whmcs.com/get-support/video-tutorials/]

Language Files

2013-09-05T09:40:32Z

Kim: /* Default Languages */

WHMCS supports numerous languages, in both in the client and admin areas. To enable this, all text used throughout the system is stored within language files.

Language files are stored in the '''/lang/''' sub-folders of both the client and admin directories.

__TOC__
==Default Languages==

WHMCS includes 20 client area translations by default. These are:

'''Arabic, Catalan, Croatian, Czech, Danish, Dutch, English, Farsi, French, German, Hungarian, Italian, Norwegian, Brazilian & Native Portuguese, Russian, Spanish, Swedish, Turkish & Ukranian'''

And for the admin area there are 6 translations included:

'''Czech, English, French, Portuguese, Russian & Spanish'''

We rely on the dedication and generosity of our users for contributing translations, as we find real life translations are a much higher quality compared with using automated translation systems as some softwares do. So if you have any suggestions for improvements, or a new language file you are willing to contribute, please get in touch.

==Adding a New Language==

If a language you operate in is not available as standard, then you can create your own translation. Here's how:

#Begin by opening an existing language file
#Save this file with a new name - the name you want to be shown in the language selection dropdown menu in WHMCS - the name should only consist of a-z0-9 characters and end with the extension ".php"
#Once the file has been created, you can then begin going through and translating the lines within it
#An example line is as follows - you should only change the part in bold:

$_LANG['accountinfo'] = "'''Account Information'''";

''Be careful not to delete any of the quotation marks (") around the text strings or the semi-colons on the ends of each line (;). Also should you want to use a quote character (") within your translated text, you must escape it - for example: \" The language files are written in PHP syntax so valid PHP code must be maintained.''

==Overriding Language Strings==

Should you want to customise any of the default language file strings, we recommend using the overrides system. Overrides as the name suggests are a way of overriding language file text values without making changes to the core language files themselves. This has the benefit of meaning that when it comes to upgrades, you don't have any risk of overwriting and losing your customisations.

If this is your first time overriding language strings you will need to begin by creating a subfolder named '''overrides''' within the /lang/ directory (overrides are supported for both client and admin area languages).

#To start overriding language strings, begin by creating an empty file in the overrides folder matching the name of the default language file you want to override
#Next copy and paste any language strings from the default file into the override file that you want to customise
#Now edit the translations within the override file in exactly the same way as demonstrated above.

An example '''/lang/overrides/english.php''' file:

<?php
$_LANG['globalsystemname'] = "Support System";
$_LANG['headertext'] = "Welcome to our members area.";
?>

Upgrading

2013-08-02T10:48:14Z

Kim: /* Performing an Upgrade */

We aim to make upgrading WHMCS as simple as possible. Below we hope to provide everything you might need in order to successfully and confidently update your WHMCS installation.

==Upgrade Service==

We offer a professional upgrade service where our staff will upgrade your WHMCS installation for you. Please refer to http://www.whmcs.com/services/upgrade-service/ for more information and to order that.

==Manually Upgrading==

If you choose to upgrade yourself, please follow the instructions below and in the release notes for the specific version to ensure a successful upgrade.

You can upgrade from '''any''' WHMCS version from 3.2 onwards to the latest. You '''do not''' need to do each incremental release between your current version & the latest in order to upgrade. Simply download the full release package for the latest version as described below and then follow the upgrade instructions linked to in the included '''README.txt''' file.

===Downloading the Latest Version===

#Begin by logging in to the client area @ http://www.whmcs.com/members/clientarea.php or obtain the latest version from your web host if you received your key from them
#Navigate to '''Services > Licenses & Services'''
#Select one of your active license keys and click '''View Details'''
#Now select the '''Downloads''' tab
#The latest stable release can then be downloaded using the large green "Download Now" button

===Performing an Upgrade===

The steps needed to upgrade WHMCS can vary from version to version and so full steps, including any template changes required for each version are included in the Release Notes below. However, the general process for upgrading always remains the same:

#Begin by taking a full backup of your WHMCS system - both files and database using a tool such as phpMyAdmin
#If you have customized any language files please create a new folder within the /lang folder naming it 'overrides'. Move your existing language files here
#If you have customized the standard template files please ensure that you have renamed the folder to avoid your customizations being overwritten
#Now download the latest WHMCS version either from our client area ([[Upgrading#Downloading_the_Latest_Version]]) or from the provider of your license
#Next, unzip the contents of the WHMCS zip file download to a folder on your computer
#Now if you have customised your WHMCS admin folder name, you should rename the admin folder in the new files to match
#Upload the new files to your existing installation folder replacing any existing folders & files
#Visit the admin area as you normally would to login and you should then be automatically redirected to the upgrade script. If this is not shown automatically, please manually visit /install/install.php to invoke the upgrade process.
#Accept the license agreement
#If you are prompted for any database information *STOP*, this indicates the configuration.php file is missing and so a new install is being attempted - you need to restore the configuration.php before continuing
#Tick to confirm you have backed up your database and click the upgrade button to complete
#Once the updates finish, delete the install folder from your server
#Now proceed to update your custom templates with any new or changed files in the version you've upgraded to. These are listed in the ''Template Changes'' section of our Release Notes (see below).
#Finally clear your browser cache or perform a hard refresh (Ctrl + F5) and delete the contents of the template cache directory (usually called ''templates_c'') to ensure you see the new templates.

==Release Notes==

{{:Release Notes}}

Upgrading

2013-08-02T10:47:28Z

Kim: /* Performing an Upgrade */

We aim to make upgrading WHMCS as simple as possible. Below we hope to provide everything you might need in order to successfully and confidently update your WHMCS installation.

==Upgrade Service==

We offer a professional upgrade service where our staff will upgrade your WHMCS installation for you. Please refer to http://www.whmcs.com/services/upgrade-service/ for more information and to order that.

==Manually Upgrading==

If you choose to upgrade yourself, please follow the instructions below and in the release notes for the specific version to ensure a successful upgrade.

You can upgrade from '''any''' WHMCS version from 3.2 onwards to the latest. You '''do not''' need to do each incremental release between your current version & the latest in order to upgrade. Simply download the full release package for the latest version as described below and then follow the upgrade instructions linked to in the included '''README.txt''' file.

===Downloading the Latest Version===

#Begin by logging in to the client area @ http://www.whmcs.com/members/clientarea.php or obtain the latest version from your web host if you received your key from them
#Navigate to '''Services > Licenses & Services'''
#Select one of your active license keys and click '''View Details'''
#Now select the '''Downloads''' tab
#The latest stable release can then be downloaded using the large green "Download Now" button

===Performing an Upgrade===

The steps needed to upgrade WHMCS can vary from version to version and so full steps, including any template changes required for each version are included in the Release Notes below. However, the general process for upgrading always remains the same:

#Begin by taking a full backup of your WHMCS system - both files and database using a tool such as phpMyAdmin
#Now download the latest WHMCS version either from our client area ([[Upgrading#Downloading_the_Latest_Version]]) or from the provider of your license
#Next, unzip the contents of the WHMCS zip file download to a folder on your computer
#Now if you have customised your WHMCS admin folder name, you should rename the admin folder in the new files to match
#If you have customized any language files please create a new folder within the /lang folder naming it 'overrides'. Move your existing language files here
#If you have customized the standard template files please ensure that you have renamed the folder to avoid your customizations being overwritten
#Upload the new files to your existing installation folder replacing any existing folders & files
#Visit the admin area as you normally would to login and you should then be automatically redirected to the upgrade script. If this is not shown automatically, please manually visit /install/install.php to invoke the upgrade process.
#Accept the license agreement
#If you are prompted for any database information *STOP*, this indicates the configuration.php file is missing and so a new install is being attempted - you need to restore the configuration.php before continuing
#Tick to confirm you have backed up your database and click the upgrade button to complete
#Once the updates finish, delete the install folder from your server
#Now proceed to update your custom templates with any new or changed files in the version you've upgraded to. These are listed in the ''Template Changes'' section of our Release Notes (see below).
#Finally clear your browser cache or perform a hard refresh (Ctrl + F5) and delete the contents of the template cache directory (usually called ''templates_c'') to ensure you see the new templates.

==Release Notes==

{{:Release Notes}}

Language Files

2013-04-15T11:24:49Z

Kim: /* Default Languages */

WHMCS supports numerous languages, in both in the client and admin areas. To enable this, all text used throughout the system is stored within language files.

Language files are stored in the '''/lang/''' sub-folders of both the client and admin directories.

__TOC__
==Default Languages==

WHMCS includes 13 client area translations by default. These are:

'''Arabic, Catalan, Croatian, Czech, Danish, Dutch, English, Farsi, French, German, Hungarian, Italian, Norwegian, Brazilian & Native Portuguese, Russian, Spanish, Swedish, Turkish & Ukranian'''

And for the admin area there are 4 translations included:

'''Czech, English, French, Portuguese, Russian & Spanish'''

We rely on the dedication and generosity of our users for contributing translations, as we find real life translations are a much higher quality compared with using automated translation systems as some softwares do. So if you have any suggestions for improvements, or a new language file you are willing to contribute, please get in touch.

==Adding a New Language==

If a language you operate in is not available as standard, then you can create your own translation. Here's how:

#Begin by opening an existing language file
#Save this file with a new name - the name you want to be shown in the language selection dropdown menu in WHMCS - the name should only consist of a-z0-9 characters and end with the extension ".php"
#Once the file has been created, you can then begin going through and translating the lines within it
#An example line is as follows - you should only change the part in bold:

$_LANG['accountinfo'] = "'''Account Information'''";

''Be careful not to delete any of the quotation marks (") around the text strings or the semi-colons on the ends of each line (;). Also should you want to use a quote character (") within your translated text, you must escape it - for example: \" The language files are written in PHP syntax so valid PHP code must be maintained.''

==Overriding Language Strings==

Should you want to customise any of the default language file strings, we recommend using the overrides system. Overrides as the name suggests are a way of overriding language file text values without making changes to the core language files themselves. This has the benefit of meaning that when it comes to upgrades, you don't have any risk of overwriting and losing your customisations.

If this is your first time overriding language strings you will need to begin by creating a subfolder named '''overrides''' within the /lang/ directory (overrides are supported for both client and admin area languages).

#To start overriding language strings, begin by creating an empty file in the overrides folder matching the name of the default language file you want to override
#Next copy and paste any language strings from the default file into the override file that you want to customise
#Now edit the translations within the override file in exactly the same way as demonstrated above.

An example '''/lang/overrides/english.php''' file:

<?php
$_LANG['globalsystemname'] = "Support System";
$_LANG['headertext'] = "Welcome to our members area.";
?>

Configuration

2013-04-07T08:54:36Z

Kim: /* General Settings */

==General Settings==
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=Sl3N_DJXPjE|Watch Video Tutorial]]

The General Settings page is where you change the vast majority of WHMCS general settings. Below is a description of each tab of the general config to aid in finding what you need. Click the names for an explanation of each available option.

*[[General_Tab|General]] - this is where basic settings such as your company name, address, domain and template are configured
*[[Localisation_Tab|Localisation]] - from here you can configure date, country and language settings.
*[[Ordering_Tab|Ordering]] - for configuring TOS URL, where the user is taken to at the end of the order process and other order specific settings
*[[Domains_Tab|Domains]] - this is where you configure domain registration options and pricing for domain addons
*[[Mail_Tab|Mail]] - where you can choose the method used to send mail and set sending preferences and the default signature
*[[Support_Tab|Support]] - allowing you to customise the order ticket replies are displayed and the allowed attachment types
*[[Invoice_Tab|Invoices]] - from here you can set all invoicing/payment related settings
*[[Credit_Tab|Credit]] - this is where you enable/disable the credit funding feature in the client area and set limits
*[[Affiliate_Tab|Affiliates]] - this is where the affiliate system settings are configured such as required payout level, bonus deposit and default commission percentage
*[[Security_Tab|Security]] - tweak the script security settings including password strength and credit card storage
*[[Social_Networking|Social]] - configure your WHMCS to allow social networking interactions
*[[Other_Tab|Other]] - this tab contains all the miscellaneous options which don't fit under other headings

Configuration

2013-04-07T08:53:12Z

Kim:

==General Settings==
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=Sl3N_DJXPjE|Watch Video Tutorial]]

The General Settings page is where you change the vast majority of WHMCS general settings. Below is a description of each tab of the general config to aid in finding what you need. Click the names for an explanation of each available option.

*[[General_Tab|General]] - this is where basic settings such as your company name, address, domain and template are configured
*[[Localisation_Tab|Localisation]] - from here you can configure country and language settings. For advice on how to setup currencies please view http://docs.whmcs.com/Currencies
*[[Ordering_Tab|Ordering]] - for configuring TOS URL, where the user is taken to at the end of the order process and other order specific settings
*[[Domains_Tab|Domains]] - this is where you configure domain registration options and pricing for domain addons
*[[Mail_Tab|Mail]] - where you can choose the method used to send mail and set sending preferences and the default signature
*[[Support_Tab|Support]] - allowing you to customise the order ticket replies are displayed and the allowed attachment types
*[[Invoice_Tab|Invoices]] - from here you can set all invoicing/payment related settings
*[[Credit_Tab|Credit]] - this is where you enable/disable the credit funding feature in the client area and set limits
*[[Affiliate_Tab|Affiliates]] - this is where the affiliate system settings are configured such as required payout level, bonus deposit and default commission percentage
*[[Security_Tab|Security]] - tweak the script security settings including password strength and credit card storage
*[[Social_Networking|Social]] - configure your WHMCS to allow social networking interactions
*[[Other_Tab|Other]] - this tab contains all the miscellaneous options which don't fit under other headings

Configuration

2013-04-07T08:52:51Z

Kim: /* General Settings */

==General Settings==
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=Sl3N_DJXPjE|Watch Video Tutorial]]

The General Settings page is where you change the vast majority of WHMCS general settings. Below is a description of each tab of the general config to aid in finding what you need. Click the names for an explanation of each available option.

*[[General_Tab|General]] - this is where basic settings such as your company name, address, domain and template are configured
*[[Localisation_Tab|Localisation]] - from here you can configure country and language settings. For advise on how to setup currencies please view http://docs.whmcs.com/Currencies
*[[Ordering_Tab|Ordering]] - for configuring TOS URL, where the user is taken to at the end of the order process and other order specific settings
*[[Domains_Tab|Domains]] - this is where you configure domain registration options and pricing for domain addons
*[[Mail_Tab|Mail]] - where you can choose the method used to send mail and set sending preferences and the default signature
*[[Support_Tab|Support]] - allowing you to customise the order ticket replies are displayed and the allowed attachment types
*[[Invoice_Tab|Invoices]] - from here you can set all invoicing/payment related settings
*[[Credit_Tab|Credit]] - this is where you enable/disable the credit funding feature in the client area and set limits
*[[Affiliate_Tab|Affiliates]] - this is where the affiliate system settings are configured such as required payout level, bonus deposit and default commission percentage
*[[Security_Tab|Security]] - tweak the script security settings including password strength and credit card storage
*[[Social_Networking|Social]] - configure your WHMCS to allow social networking interactions
*[[Other_Tab|Other]] - this tab contains all the miscellaneous options which don't fit under other headings

Ahsay Backups

2013-03-27T16:28:07Z

Kim: /* Supported Operations */

Ahsay Backup Software is a backup solution for users of all sizes, that can backup virtual machines, database servers, email servers, file servers, desktops and notebooks. Ahsay is the solution of choice by a large number of service providers for reselling and providing backup services to their customers.

The module we have in WHMCS is designed to enable the offering of Ahsay backup accounts in an automated way. With support for fully automated setup and management, utilising all the options available in the Ahsay API.

==Supported Operations==

*Create Accounts
*Suspend Accounts
*Unsuspend/Reactivate
*Terminate Accounts
*Account Upgrades/Downgrades
*Password Changes/Resets
*Trial Accounts

==Purchase==

The Ahsay Backups module is available for $100 can be purchased from: https://www.whmcs.com/members/cart.php?a=add&pid=164

==Setup Instructions==

Following purchasing the Ahsay Backup module via the link above, you will be able to download the module from our client area. Once you have it, upload it to the folder '''/modules/servers/ahsaybackups/''' and then configure it as follows.

#Begin by logging into your WHMCS admin area and then go to '''Setup > Products/Services > Servers'''
#Now create a new server, giving it a name, entering the IP address of your Ahsay server in the IP Address field, choosing "Ahsaybackups" in the Module dropdown and entering your Ahsay username & password in the respective fields
#Once that's done, now move to '''Setup > Products/Services'''
#Click the '''Create New Product''' link, and then configure the name, description, pricing and other settings as desired
#Then switch to the '''Module Settings''' tab, choose '''Ahsaybackups''' in the Module dropdown and then the page will reload with the options for Ahsay Products
#From here, you can then set the Product Type, Client Type, Quota, Bandwidth, etc... as desired
#Once done, save your changes and the product is then ready to be tested

==Configurable Options==

The following keywords can be used for configurable options in order to allow users to customise and choose the products you offer for Ahsay using optional items during the order process.

*'''Quota'''
*'''Bandwidth'''
*'''EnableMSSQL'''
*'''EnableMSExchange'''
*'''EnableOracle'''
*'''EnableLotusNotes'''
*'''EnableLotusDomino'''
*'''EnableMySQL'''
*'''EnableInFileDelta'''
*'''EnableShadowCopy'''
*'''EnableExchangeMailbox'''
*'''ExchangeMailboxQuota'''
*'''EnableCDP'''
*'''EnableShadowProtectBareMetal'''
*'''EnableWinServer2008BareMetal'''

Version 5.1 Release Notes

2013-03-26T11:48:14Z

Kim: /* Upgrade Steps */

==Release Information==

===Version 5.1.0===
*Release Type: Beta (For Testing)
*Release Date: 11th May 2012

===Version 5.1.1===
*Release Type: Release Candidate (For Testing)
*Release Date: 15th June 2012

===Version 5.1.2===
*Release Type: Stable Release
*Release Date: 6th July 2012

==Changelog==

A full overview of the new features and functionality added in WHMCS Version 5.1 will be released when the stable version becomes available. In the meantime, please review our recent preview blog posts to see more details about some of the new functionality: http://blog.whmcs.com/

==Upgrade Steps==

Upgrading WHMCS is easy. To upgrade to V5.0, simply follow the steps below:

#Begin by taking a backup of your database using a tool such as phpMyAdmin
#Now download the latest WHMCS version either from our client area (http://wiki.whmcs.com/Upgrading#Downloading_the_Latest_Version) or from your web host license provider
#Next, unzip the contents of the WHMCS zip file download to a folder on your computer
#Now if you have customised your WHMCS admin folder name, you should rename the admin folder in the new files to match
#Upload the new files to your existing installation folder replacing any existing folders & files
#Visit the admin area as you normally would to login and you should then be automatically redirected to the upgrade script. If this is not shown automatically, please manually visit /install/install.php to invoke the upgrade process.
#Accept the license agreement
#If you are prompted for any database information *STOP*, this indicates the configuration.php file is missing and so a new install is being attempted - you need to restore the configuration.php before continuing.
#Tick to confirm once you have backed up your database, and then click the upgrade button
#Once the updates finish, delete the install folder from your server

These steps can be used to upgrade from any version of WHMCS from V3.3 & later.

'''Remember: After upgrading, your browser may still display cached versions of the previous files. So if you get any display issues or inconsistencies, always try clearing your cache first, both in your browser, and the WHMCS templates cache (templates_c folder files)'''

The upgrade is now completed. The only thing left to do is update your custom templates if you have any with the new and changed template files for the new version. See below for details.

==Template Changes==

The following template changes have been made to system templates:

*3dsecure.tpl - New method of form submission - not a required update
*affiliates.tpl - Removed billing cycle column
*clientareacreditcard.tpl - Added preserving of card type/expiry date selections on validation failure
*clientareadetails.tpl - Update/fix to default payment method dropdown menu
*clientareadomains.tpl - Added new domain addons tab
*clientregister.tpl - Added currency selection dropdown for multi-currency support in registrations
*creditcard.tpl - Added preserving of card type/expiry date selections on validation failure
*forwardpage.tpl - New method of form submission - not a required update
*networkissues.tpl - Added RSS Feed link for network issues
*serverstatus.tpl - Ajaxified server status port checking

In order form templates the following changes were made:

*products.tpl (modern & slider) - Fix for bundled products ordering
*viewcart.tpl (all templates) - Update to preserve card expiry date selections on validation failure
*main.js (modern & slider) - Fix for showing domain configuration step after product add

==New Language File Lines==

If you are using a custom language file, then the new language file lines introduced in Version 5.1 can be found below the "# Version 5.1" line in each language file.

During the beta we will be reaching out to our known translators to convert new lines into the other languages. However if you are able to help in contributing even just some of the new lines translated, then it would be much appreciated.

==Release Notes==

*'''Display Problems/Browser Cache''' - Always clear your browser cache, or perform a hard refresh after upgrading, most display related issues are purely due to seeing an old version of the CSS
*'''New Domain Registrar Sync Cron''' - Until now, each registrar has had it's own sync file. But as of V5.1, the individual sync files are replaced by a single cron file (/crons/domainsync.php) which needs to be configured to run periodically - we recommend every 4 hours. All previous sync cron commands should be deleted/disabled.
*'''Naming Conversion Change''' - Template directory and module names must be all one word and contain only a-z 0-9 characters, no spaces, punctuations or symbols - this is due to a new security measure. For example a template called ''my_company'' should be renamed ''mycompany''.
*'''JSON Requirement''' - JSON is a new requirement, please ensure it is compiled in your server's PHP configuration. This is standard on most PHP configurations so no action should be necessary for the majority.

Support Tickets

2013-01-31T10:07:46Z

Kim: /* Allowed File Attachments */

The support ticket system is a fully featured ticket desk that allows you to handle all communication with your clients. Featuring threaded discussions, private notes, ticket flagging, varying priority levels, auto inactive ticket closing and much much more... Admins can be assigned on a per department basis so they have access only to the area they are meant to be dealing with.

==Departments==

Departments are the categories for tickets. The first step in the user ticket submission process is to choose their department. Different staff can be assigned to different departments so you can have the different areas handled by different people if required. Common departments are '''Sales, Support, Billing''' etc...

*To setup departments, go to '''Setup > Support Departments''' and click Add New Department.
*When creating a department you can enter a name and description to display to users. The email address will be used to send notifications relating to the ticket to clients.
* The Clients Only option defines if it's a clients only department thereby requiring a login to submit there - for example Sales would be a public department while Support might be set to clients only.
* The Pipe Replies Only option requires clients to login to the client area to open new tickets, attempts to open new tickets via email will not be successful. Tickets can still be responded to via email.
*You can also setup if no auto responder email should be sent when a new ticket is opened and whether it's hidden or visible; hidden departments can only be accessed via a direct link.
*After creating a department, you need to assign yourself and other staff to it as appropriate in '''Setup > Administrators''' by editing the staff profile before you will be able to access that department in Support > Support Tickets
*In order to have '''emails from users automatically import''' into the ticket system as tickets, you need to configure [[Email Piping]].

Once a department has been created it is possible to create [[Custom Fields]] to be asked for during ticket submission. Click the Edit icon next to the department and then the Custom Fields tab.

==The Ticket List==
[[File:Ticket list.png|thumb|The support ticket list]]
When a client submits a support ticket the appropriate members of staff assigned to that department will receive a New Support Ticket Opened email. To view the ticket navigate to '''Support > Support Tickets''' and the ticket list is displayed.

This page displays all tickets that are in status '''Awaiting Reply''' by default. The ticket order can be changed by clicking the table headings. To view only those tickets with a certain status, department or to search click the Search/Filter tab. The most commonly used status lists can accessed directly from the Support menu in the main admin navigation bar.

The Auto Refresh feature reloads the ticket list automatically at frequencies ranging from every 1 minute to 15 minutes. This is configured via the Auto Refresh tab.

There are several bulk tools on this page; Close and Delete are self-explanatory. Merge will merge two tickets together, the newer ticket is merged into the older ticket. Block Sender & Delete not only deletes the ticket but also adds the sender's email to the Banned Emails list.

A ticket starts life in the 'Open' status. This indicates a new ticket where the client has not yet received a reply from a member of staff. Once you've replied the status automatically changes to 'Answered'. The status can also be changed manually from the view ticket screen, using the dropdown menu next to the ticket subject - a change in selection here is saved immediately using ajax without any need for a page reload. Custom statuses can also be created to help with management of tickets, please refer to the [[Support Ticket Statuses]] section for more info on this.

==Replying to a Ticket==
[[File:Ticket reply.png|thumb|The support ticket reply page]]
To open a ticket and view the contents of it, from where you can submit a reply, simply click the subject in the ticket list. You will then be taken to the ticket view page. The clients' messages & staff replies will all be displayed to you here, along with any private admin notes. The order of ticket message can be changed in the [[Support_Tab#Ticket_Reply_List_Order|General Settings]].

The most common task when viewing a ticket is making a reply, and so this tab is open by default when entering a ticket, providing a large text area for a reply to be entered into. If a Support Ticket Signature is configured in your admin profile, it will be pre-populated into this field.

Support ticket replies allow you to use both predefined replies, and insert links to KB articles automatically to make replying to common questions simple.

===Merge Fields===

Support ticket replies support 3 automatic data merge fields - [FIRSTNAME] [NAME] and [EMAIL]. These are most commonly used in Predefined Replies (discussed later on) but can also be used in the custom messages you right if it's easier to insert the merge field syntax rather than the actual value itself.

===Quoting a Reply===

To include a copy of a previous reply in your message, you can click the corresponding speech bubble icon next to the reply you want to quote and it will be automatically inserted to the message box using indentation to indicate it's quoted text.

===File Attachments===

Attachments can be sent with a reply, and these will be automatically attached to the notification email sent to the client as well as being downloadable from the client area at any time. To attach a file, click the Browse button and select the file on your computer, the file will be uploaded to the attachments directory. Clicking the Add More link allows multiple files to be attached with a single reply.

===Billing a Client===

It's also possible to create a [[Billable Items|billable item]] for a client upon replying to a ticket. This allows you to generate invoices, or log time spent on a ticket, in 1 single step for ultra convenience and time saving. Simply fill in the description, amount and invoice action in the '''Add Billing Entry''' section and it will be actioned when the reply is submitted.

===Post Reply Action===

The Post Reply dropdown menu allows for the selection of the action to be taken upon clicking the Add Response button for example changing the ticket status and remaining in the ticket view or returning to the main ticket list.

===Editing/Deleting a Reply===

Client & staff ticket replies can be edited by clicking the '''Edit''' button next to a message.

To delete a message from a ticket, simply click the red delete icon located to the top right of the message.
Deleting the '''first message''' in a ticket will delete the entire ticket.

===Predefined Ticket Replies===

Predefined ticket replies are useful if you get asked the same questions repeatedly via support tickets. With a predefined reply, this can be loaded into the reply box when replying to a users ticket and modified as required to answer the users question.

====Adding a Predefined Reply====

To setup a predefined reply, go to '''Support > Predefined Replies'''. You will need to configure categories and predefined replies in the same way as [[Support_Center#Knowledgebase|knowledgebase articles]].

As mentioned previously, you can have predefined replies automatically customised to a user using the merge fields [FIRSTNAME] [NAME] and/or [EMAIL] anywhere within the message.

====Using a Predefined Reply====

To use a predefined ticket reply when replying to a users ticket click the "Insert Predefined Ticket Reply" link located immediately below the text area for entering your reply. A popup window will appear allowing you to select the reply you want to use and it will then be loaded into the reply message box once selected. The search field can also be used to find replies by title to save having to search through each category. You can then edit the reply as required to customise it to the user and then click Reply button as normal.

Finally once the reply has been composed click the '''Add Response''' button to record the reply against the ticket. The client will be sent a notification email containing a copy of the message.

==Admin Notes==

The '''Add Note''' tab allows private staff-only messages to be recorded against a ticket. Clicking the tab provides a new text area into which the note can be typed, which upon submission will add the note and display it to all other admins viewing the ticket along with the staff member's name and date/time of adding. Customers do not get any notification of notes being added, and cannot see them.

==Custom Fields==

Support departments can have custom fields setup on a per department basis should a department have specific needs. And so if any have been setup they will be displayed on the '''[[Custom Fields]]''' tab within the ticket.

==Options==

The options tab allows the attributes of the ticket to be modified. The department, subject, status and priority can all be changed.

Sometimes it may be useful for additional people to receive copies of the email messages in this ticket, to achieve that enter their email addresses in the '''CC Recepients''' field. Multiple recipients can be entered in a comma separated list eg. jeff@example.com,bob@example.com

To change the client a ticket is assigned to adjust the '''Client ID''' value. If the client's name, company or email address is known start typing this into the field, an ajax list of the search results will appear. Click the appropriate client from the list to automatically fill in their Client ID.

Two tickets can be merged together into one, the messages from both tickets will be arranged chronologically. In the '''Merge Ticket''' field enter the Ticket ID of the ticket to be combined, the newer ticket is merged into the older ticket.

Flagging a ticket to another admin is useful if you want to bring the ticket to the attention of another staff member. Flagged tickets appear highlighted and emboldened to the staff member they are flagged to.

==Log==

The ticket log displays an audit trail of all the actions applied to this ticket such as department changes, tickets flaggings, adding of notes, changes of ownership and status changes.

==Opening a New Ticket==
[[File:Open ticket.png|thumb|The open support ticket page]]
Staff can open support tickets from within the administration area by navigating to '''Support > Open New Ticket'''. On the following page enter the details of the recipient, if they are not a client fill their name in the "To" field and the "Email Address" field. If they are a client use the Client Search field to search by name, company and email addresses, clicking the client's name will automatically fill in the recipient's details.

If the client has contacts or sub-accounts configured an additional dropdown menu will be displayed named "Contacts". If you wish the ticket message to be emailed to the sub-account/contacts select their name from the menu, leave this dropdown at "None" for it to be delivered to the master account.

==Automated Knowledgebase Article Suggestions==
[[File:Kb suggestion.png|thumb|Suggesting Knowledgebase Articles]]
As a user enters a message for submission as a support ticket, WHMCS can lookup and display relevant articles that match keywords in the submission text and display them to the user in an attempt to answer a clients question without them needing to ever submit the ticket. This is designed to help reduce common support questions. To turn this feature on or off, go to '''Setup > General Settings > Support tab > Knowledgebase Suggestions'''

There needs to be at least 5 articles with 30 words in each before the suggestions start working as it uses MySQL full text searching for likeness matches.

==Ticket Rating==

Ticket rating allows your customers to rate the responses they get to tickets and this then allows you to monitor how pleased your customers are with the support they receive from your staff. To enable the ticket rating feature, go to Config > General Settings > Support and tick the box for "Support Ticket Rating"

When enabled, each reply in the client area will show a row of stars for the user to choose from in rating the response. They range from 1 Poor to 5 Excellent. Rating a reply is optional so not every reply will get a rating. Those that do will be shown when viewing the ticket in the admin area and there are also 3 reports in the Reporting section that allow you to monitor the ratings, they are:

*Staff Ticket Ratings Graph - Showing the average ticket rating for each staff member
*Ticket Rating Totals Graph - Showing the number of replies rated at each of the 5 statuses
*Ticket Ratings Reviewer - Allowing you to filter and view replies with specific ratings within a given date range

==Auto Closing==

*This feature allows you to have support tickets automatically closed after a certain time of inactivity has passed.
*To set the length of time of inactivity before closure, go to '''Setup > Automation Settings > Support Ticket Settings > Close Inactive Tickets''' and enter the time in hours (for example 48 = 2 days)
*Tickets set to '''On Hold''' or '''In Progress''' are not closed automatically, only those set to Open or Answered
*When closing the ticket, the email template '''Support Ticket Auto Close Notification''' is sent to the user. You can customise that email in '''Setup > Email Templates''' as normal

==Automated Escalations==
The status, department and priority of a ticket can be changed automatically after a set time. For more information refer to the [[Support_Ticket_Escalations|Support Ticket Escalations]] page.

==Allowed File Attachments==

Support tickets and replies allow a file to be uploaded along with them for if the user needs to send you something or if you need to send the user something.

The list of allowed file types is configured by going to '''Setup > General Settings > Support tab'''. By default, the allowed file types are .jpg, .gif, .jpeg, and .png (ie. image files). It is not possible to allow the user to upload PHP files due to the security risks this creates. You can add new allowed file types to the list such as .pdf, .zip, etc... Just add them into the allowed extensions field separating each allowed ending with a comma.

NOTE: The file upload restrictions do not apply to admin users and an admin user can attach any type of file to a ticket.

If enabled under '''Setup > General Settings > Support tab''' thumbnail previews of any image attachments will be displayed beneath the ticket message itself:

[[File:Ticketthumbs.jpg]]

Support Center

2013-01-31T10:06:19Z

Kim: /* Downloads */

WHMCS includes a fully featured helpdesk for your clients. This includes announcements, downloads, a knowledgebase and a ticketing system.

==Announcements==

The announcements system, along with showing announcements on the WHMCS homepage, will also output announcements into an XML RSS Feed for use in readers and on other websites.

* To create an announcement navigate to '''Support > Announcements''' and click Add New Announcement.
* Enter the date, title and announcement itself into the appropriate fields.
* If the announcement should be available publicly tick the Published? checkbox. In this way an article can be drafted, saved and published at a later date.
* If you operate in multiple languages click the language beneath the main text area to reveal an additional text area into which the article can be translated.
* Finally click Save Changes

To edit an existing announcement simply click the edit icon next to it.

==Downloads==

You can add downloads to the site for your users, this could be anything from product user manuals, relevant software utilities or even the actual products being sold. They can either be hosted locally or remotely.

* The first step is to create a category to contain downloads, navigate to '''Support > Downloads''' and click the Add Category tab
* Enter a name and description to be displayed to clients. Tick the Hide checkbox to make this category invisible, it will be available only via direct links. Click Add Category.
* Now click the Add Download tab to enter the file type, title and description of the file.
* In the Upload File section select the location of the file. If the file is large it's recommend to upload via FTP and select the Manual FTP Upload to Downloads Folder option, for smaller files the Upload File can make the process easier.
* '''Manual FTP Upload to Downloads Folder''' - For remotely hosted files simply enter the full URL to the files starting with http:// in the Enter Filename field, for files uploaded via FTP to the /downloads directory it should just be the filename.
* '''Upload File''' - Click the Browse button and locate the file on your computer, it will be uploaded to the /downloads dir.
* Downloads can be either public or private and if private, only users who are logged in will have access to them. You can also specify certain products which can be downloaded only once the associated package is purchased: [[Product Downloads Distribution]]
* Finally click Add Download.

To edit an existing download simply click the category name and then the download name.

==Knowledgebase==

The knowledgebase allows you to create a collection of commonly asked questions and their answers. You can group these into categories and set them to be either visible or private (admin only). The client area offers the user the choice of browsing through the articles in your KB or searching based on keywords they enter.

* The first step is to create a category to contain articles, navigate to '''Support > Knowledgebase''' and click the Add Category tab
* Enter a name and description to be displayed to clients. Tick the Hide checkbox to make this category invisible, it will be available only via direct links. Click Add Category.
* Now click the Add Article tab and enter the title of the first article and click Add Article to be taken to the editing page.
* The Category field displays which categories this article belongs to, a single article can be assigned to multiple categories by ctrl + clicking.
* The views and votes statistics can be changed here, it displays how many people have viewed this article and how many rated it helpful.
* Ticking the Private checkbox will mean this article is not visible to visitors so clients must be logged in to read it.
* The Display Order enables the default alphanumeric display order (1,2,3,a,b,c...) to be overridden with a custom one. An article with a display order value or 0 would be displayed at the top of the category, 1 beneath that, 2 beneath that and so on.
* Enter the contents of your article in the large text area.
* If you operate in multiple languages click the language beneath the main text area to reveal an additional text area into which the article can be translated.
* Finally click Save Changes

To edit an existing article simply click the category name and then the article name.

==Support Tickets==

The support ticket system is a fully featured ticket desk that allows you to handle all communication with your clients. Featuring threaded discussions, private notes, ticket flagging, varying priority levels, auto inactive ticket closing and much much more... We have a full page dedicated to the [[Support Tickets|Support Ticket System]] here.

==Network Issues==

The network issues area is designed to be a dedicated area for you to make announcements to customers about current and scheduled/planned service affecting issues, separate from your main news and announcements feed. For example, this can be used to notify clients about current or planned server outages, software updates, planned maintenance, and other things like that.

For details please visit the [[Network Issues]] page

==Search Engine Friendly URLS==

Search Engine Friendly URLs are where a URL which once was "/knowledgebase.php?action=view&id=1" becomes "/knowledgebase/1/How_do_I_access_my_control_panel.html". You can enable these for the announcements, downloads and knowledgebase sections of the WHMCS client area.

#To enable SEF URLs, first check and ensure you have mod_rewrite installed on your server
#Next go to '''Setup > General Settings > Support''' and tick the box for "KB SEO Friendly URLs"
#Finally, you must also rename the file named htaccess.txt to .htaccess in your root WHMCS directory

The above steps apply to Apache. For IIS environments, you must make sure IIS has URL rewrite installed (http://learn.iis.net/page.aspx/460/using-the-url-rewrite-module/), and then you can setup the rewrite rules as follows:

#Open IIS Manager
#Browse to the site you want to add rule to
#In the right pane double-click and select urlrewrite
#On right side inbound rules select import rules
#Cut and paste the rules from the htaccess.txt file in the root directory of WHMCS into rewrite rules field
#Finally click Apply to complete the process

===Notes===
Only Latin characters (a-z, 0-9) in the title are currently supported in the Search Engine Friendly URLs. Any unsupported characters will be converted into a dash (-).

File:CashuIntegration.png

2013-01-15T10:32:02Z

Kim: uploaded a new version of "File:CashuIntegration.png"

Update to the CashU image.

File:CashuIntegration.png

2013-01-15T10:30:59Z

Kim: uploaded a new version of "File:CashuIntegration.png"

Update to the CashU image.

CashU

2013-01-15T10:29:34Z

Kim:

{{gateways
| onetime = yes
}}

To configure the CashU module in WHMCS, begin by activating it in '''Setup > Payment Gateways'''

You will then be asked to enter your Merchant ID and the Encryption Keyword.

You can find the Encryption Keyword inside your CashU account by going to My Account > Payment Security.

This is where you also need to set the return url, which must be set to:

http://www.yourdomain.com/modules/gateways/callback/cashu.php

The Notification URL should be left blank.

[[File:CashuIntegration.png]]

{{modules}}

File:CashuIntegration.png

2013-01-15T10:29:15Z

Kim: Update to the CashU image.

Update to the CashU image.

Project Management

2013-01-09T16:30:20Z

Kim: /* Installation */

==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 [http://www.whmcs.com/project-management www.whmcs.com/project-management]

__TOC__
==Installation==

The Project Manage Addon requires '''WHMCS V5.0''' or later to function.

Following purchasing the Project Management addon at the link above, you will need to activate this within your main WHMCS installation as it comes as standard with the WHMCS files or if you have had to download it, you can install it as follows:

#Begin by unzipping the files
#Included in the zip file you will find 2 folders, one named "project_management" and a second named "reports"
#The first folder needs to be uploaded to the '''/modules/addons/''' directory of your WHMCS installation
#And the files from the reports folder need to go in the '''/modules/reports/''' directory to add to the existing core reports
#Once uploaded, you then need to navigate to '''Setup > Addon Modules''' within your WHMCS Admin Area to activate and configure the module
#Upon activation, you will find just 2 main settings for the Project Management module, the "Master Admin Users" and "Access Control". Additional settings relating to the project management are provided within the addon itself.

*'''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 statuses and access permissions

Once you're done configuring the access rights, click Save to complete the process

==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 Incomplete 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]]

So at the very top we have the project title, and days left until the 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.

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.

Then below that we have 2 columns, in the left column we have the Project Tasks, Associated Tickets, Associated Invoices and Attachments blocks. And on the right we have the Staff Messageboard area where messages can be posted & viewed.

And finally below all of that, we have the Activity Log, providing a full listing 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.

====Tracking Time====

To track the time spent on tasks, staff members simply click the "Track Time" button next to a task when they start working on it. This creates a time log entry with their username, and the start time. The row showing their name and start time will show an End Timer link until the timed entry is completed, which they just need to click when they stop working on the task.

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.

===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 '''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. Colors can also be defined by using the format "Status|#HEXCODE" for example "Pending|#cc0000,Completed|#336699,etc..."
*'''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

===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 on 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.

==Upgrading==

===Version 1.0 to 1.1===

Performing an upgrade of the Project Management Addon is simply a case of downloading the latest version from our client area and then uploading the files to your installation in place of the existing ones. The download package consists of 2 folders, a "project_management" folder which belongs in /modules/addons/ and a "reports" folder which belongs in /modules. There is no install or upgrade script necessary, the first time you access the addon all necessary DB upgrades will be performed automatically.

The latest project management release can be obtained from our client area by navigating to '''Services > My Licenses & Services''', and either selecting the Project Management Addon, or the WHMCS license key it is assigned to, and the Project Management download will then be available to download from the "'''Downloads'''" tab on the following page.

'''Required Bug Fix'''

A bug exists in the WHMCS V5.0 release that causes client area addon modules requiring client authentication to loop indefinitely to the client login screen, even after a successful login. So if you intend to use the new project management client area functionality, you need to apply the patch for this which is just a single file replacement for the root WHMCS directory, and that can be downloaded here: http://www.whmcs.com/members/dl.php?type=d&id=123

'''New Settings'''

After upgrading, you can configure the Client Area Options from the "Settings" tab of the addon. For client area access to be allowed, you need to tick the '''Enable''' box and configure what areas you want to allow your clients access to view/use. Once configured, the client area can be accessed via '''/index.php?m=project_management'''

Uninstall WHMCS

2013-01-03T10:13:06Z

Kim:

There are times when a user has the need to remove WHMCS from their system.

This can be achieved by following 5 small steps:

#Take a backup of the database and configuration.php file. You may need these at a later date should you want to start using WHMCS again.
#Remove all the related files and folders of WHMCS from your server. Below you will find a list of relevant folders/files to remove should you be unsure.
#Remove the database tables relating to your WHMCS information.
#Ensure all Cron Jobs have been cancelled.
#Ensure all email piping is disabled.

===Folders===

*Admin folder
*Attachments folder
*Crons folder
*Downloads folder
*Feeds folder
*Images folder
*Includes folder
*Lang folder
*Modules folder
*Pipe folder
*Status folder
*Templates folder
*Templates_c folder

===Files===

*aff.php
*affiliates.php
*announcements.php
*announcementsrss.php
*banned.php
*cart.php
*clientarea.php
*configuressl.php
*contact.php
*creditcard.php
*dbconnect.php
*dl.php
*dologin.php
*domainchecker.php
*downloads.php
*index.php
*knowledgebase.php
*link.php
*login.php
*logout.php
*networkissues.php
*networkissuesrss.php
*pwreset.php
*register.php
*serverstatus.php
*submitticket.php
*supporttickets.php
*upgrade.php
*viewemail.php
*viewinvoice.php
*viewquote.php
*viewticket.php
*whois.php

Uninstall WHMCS

2013-01-03T10:11:51Z

Kim: /* Files */

There are times when a user has the need to remove WHMCS from their system.

This can be achieved by following 5 small steps:

#'''Take a backup of the database and configuration.php file. You may need these at a later date should you want to start using WHMCS again.'''
#'''Remove all the related files and folders of WHMCS from your server. Below you will find a list of relevant folders/files to remove should you be unsure.'''
#'''Remove the database tables relating to your WHMCS information.'''
#'''Ensure all Cron Jobs have been cancelled.'''
#'''Ensure all email piping is disabled.'''

===Folders===

*Admin folder
*Attachments folder
*Crons folder
*Downloads folder
*Feeds folder
*Images folder
*Includes folder
*Lang folder
*Modules folder
*Pipe folder
*Status folder
*Templates folder
*Templates_c folder

===Files===

*aff.php
*affiliates.php
*announcements.php
*announcementsrss.php
*banned.php
*cart.php
*clientarea.php
*configuressl.php
*contact.php
*creditcard.php
*dbconnect.php
*dl.php
*dologin.php
*domainchecker.php
*downloads.php
*index.php
*knowledgebase.php
*link.php
*login.php
*logout.php
*networkissues.php
*networkissuesrss.php
*pwreset.php
*register.php
*serverstatus.php
*submitticket.php
*supporttickets.php
*upgrade.php
*viewemail.php
*viewinvoice.php
*viewquote.php
*viewticket.php
*whois.php

Uninstall WHMCS

2013-01-03T10:11:42Z

Kim: /* Folders */

There are times when a user has the need to remove WHMCS from their system.

This can be achieved by following 5 small steps:

#'''Take a backup of the database and configuration.php file. You may need these at a later date should you want to start using WHMCS again.'''
#'''Remove all the related files and folders of WHMCS from your server. Below you will find a list of relevant folders/files to remove should you be unsure.'''
#'''Remove the database tables relating to your WHMCS information.'''
#'''Ensure all Cron Jobs have been cancelled.'''
#'''Ensure all email piping is disabled.'''

===Folders===

*Admin folder
*Attachments folder
*Crons folder
*Downloads folder
*Feeds folder
*Images folder
*Includes folder
*Lang folder
*Modules folder
*Pipe folder
*Status folder
*Templates folder
*Templates_c folder

==Files==

*aff.php
*affiliates.php
*announcements.php
*announcementsrss.php
*banned.php
*cart.php
*clientarea.php
*configuressl.php
*contact.php
*creditcard.php
*dbconnect.php
*dl.php
*dologin.php
*domainchecker.php
*downloads.php
*index.php
*knowledgebase.php
*link.php
*login.php
*logout.php
*networkissues.php
*networkissuesrss.php
*pwreset.php
*register.php
*serverstatus.php
*submitticket.php
*supporttickets.php
*upgrade.php
*viewemail.php
*viewinvoice.php
*viewquote.php
*viewticket.php
*whois.php

Uninstall WHMCS

2013-01-03T10:10:51Z

Kim:

There are times when a user has the need to remove WHMCS from their system.

This can be achieved by following 5 small steps:

#'''Take a backup of the database and configuration.php file. You may need these at a later date should you want to start using WHMCS again.'''
#'''Remove all the related files and folders of WHMCS from your server. Below you will find a list of relevant folders/files to remove should you be unsure.'''
#'''Remove the database tables relating to your WHMCS information.'''
#'''Ensure all Cron Jobs have been cancelled.'''
#'''Ensure all email piping is disabled.'''

==Folders==

*Admin folder
*Attachments folder
*Crons folder
*Downloads folder
*Feeds folder
*Images folder
*Includes folder
*Lang folder
*Modules folder
*Pipe folder
*Status folder
*Templates folder
*Templates_c folder

==Files==

*aff.php
*affiliates.php
*announcements.php
*announcementsrss.php
*banned.php
*cart.php
*clientarea.php
*configuressl.php
*contact.php
*creditcard.php
*dbconnect.php
*dl.php
*dologin.php
*domainchecker.php
*downloads.php
*index.php
*knowledgebase.php
*link.php
*login.php
*logout.php
*networkissues.php
*networkissuesrss.php
*pwreset.php
*register.php
*serverstatus.php
*submitticket.php
*supporttickets.php
*upgrade.php
*viewemail.php
*viewinvoice.php
*viewquote.php
*viewticket.php
*whois.php

Uninstall WHMCS

2013-01-03T10:10:07Z

Kim:

There are times when a user has the need to remove WHMCS from their system.

This can be achieved by following 5 small steps:

#'''Take a backup of the database and configuration.php file. You may need these at a later date should you want to start using WHMCS again.'''
#'''Remove all the related files and folders of WHMCS from your server. Below you will find a list of relevant folders/files to remove should you be unsure.'''
#'''Remove the database tables relating to your WHMCS information.'''
#'''Ensure all Cron Jobs have been cancelled.'''
#'''Ensure all email piping is disabled.'''

Admin folder
Attachments folder
Crons folder
Downloads folder
Feeds folder
Images folder
Includes folder
Lang folder
Modules folder
Pipe folder
Status folder
Templates folder
Templates_c folder

aff.php
affiliates.php
announcements.php
announcementsrss.php
banned.php
cart.php
clientarea.php
configuressl.php
contact.php
creditcard.php
dbconnect.php
dl.php
dologin.php
domainchecker.php
downloads.php
index.php
knowledgebase.php
link.php
login.php
logout.php
networkissues.php
networkissuesrss.php
pwreset.php
register.php
serverstatus.php
submitticket.php
supporttickets.php
upgrade.php
viewemail.php
viewinvoice.php
viewquote.php
viewticket.php
whois.php

Uninstall WHMCS

2013-01-03T10:08:32Z

Kim:

There are times when a user has the need to remove WHMCS from their system.

This can be achieved by following 5 small steps:

#'''Take a backup of the database and configuration.php file. You may need these at a later date should you want to start using WHMCS again.'''
#'''Remove all the related files and folders of WHMCS from your server. Below you will find a list of relevant folders/files to remove should you be unsure.'''
#'''Remove the database tables relating to your WHMCS information.'''
#'''Ensure all Cron Jobs have been cancelled.'''
#'''Ensure all email piping is disabled.'''

*Admin folder
*Attachments folder
*Crons folder
*Downloads folder
*Feeds folder
*Images folder
*Includes folder
*Lang folder
*Modules folder
*Pipe folder
*Status folder
*Templates folder
*Templates_c folder

*aff.php
*affiliates.php
*announcements.php
*announcementsrss.php
*banned.php
*cart.php
*clientarea.php
*configuressl.php
*contact.php
*creditcard.php
*dbconnect.php
*dl.php
*dologin.php
*domainchecker.php
*downloads.php
*index.php
*knowledgebase.php
*link.php
*login.php
*logout.php
*networkissues.php
*networkissuesrss.php
*pwreset.php
*register.php
*serverstatus.php
*submitticket.php
*supporttickets.php
*upgrade.php
*viewemail.php
*viewinvoice.php
*viewquote.php
*viewticket.php
*whois.php

Uninstall WHMCS

2013-01-03T09:58:45Z

Kim:

Uninstall WHMCS

2013-01-03T09:56:36Z

Kim: Created page with 'There are times when a user has the need to remove WHMCS from their system. This can be achieved by following 4 small steps: #'''Take a backup of the database and configuration…'

There are times when a user has the need to remove WHMCS from their system.

This can be achieved by following 4 small steps:

#'''Take a backup of the database and configuration.php file. You may need these at a later date should you want to start using WHMCS again.'''
#'''Remove all the related files and folders of WHMCS from your server.'''
#'''Remove the database tables relating to your WHMCS information.'''
#'''Ensure all Cron Jobs have been cancelled.'''

Version 5.1 Release Notes

2012-12-19T09:39:23Z

Kim: /* Upgrade Steps */

==Release Information==

===Version 5.1.0===
*Release Type: Beta (For Testing)
*Release Date: 11th May 2012

===Version 5.1.1===
*Release Type: Release Candidate (For Testing)
*Release Date: 15th June 2012

===Version 5.1.2===
*Release Type: Stable Release
*Release Date: 6th July 2012

==Changelog==

A full overview of the new features and functionality added in WHMCS Version 5.1 will be released when the stable version becomes available. In the meantime, please review our recent preview blog posts to see more details about some of the new functionality: http://blog.whmcs.com/

==Upgrade Steps==

Upgrading WHMCS is easy. To upgrade to V5.0, simply follow the steps below:

#Begin by taking a backup of your database using a tool such as phpMyAdmin
#Now download the latest WHMCS version either from our client area (http://wiki.whmcs.com/Upgrading#Downloading_the_Latest_Version) or from your web host license provider
#Next, unzip the contents of the WHMCS zip file download to a folder on your computer
#Now if you have customised your WHMCS admin folder name, you should rename the admin folder in the new files to match
#Upload the new files to your existing installation folder replacing any existing folders & files
#Visit the admin area as you normally would to login and you should then see the upgrade script
#Accept the license agreement
#If you are prompted for any database information *STOP*, this indicates the configuration.php file is missing and so a new install is being attempted - you need to restore the configuration.php before continuing.
#Tick to confirm once you have backed up your database, and then click the upgrade button
#Once the updates finish, delete the install folder from your server

These steps can be used to upgrade from any version of WHMCS from V3.3 & later.

'''Remember: After upgrading, your browser may still display cached versions of the previous files. So if you get any display issues or inconsistencies, always try clearing your cache first, both in your browser, and the WHMCS templates cache (templates_c folder files)'''

The upgrade is now completed. The only thing left to do is update your custom templates if you have any with the new and changed template files for the new version. See below for details.

==Template Changes==

The following template changes have been made to system templates:

*3dsecure.tpl - New method of form submission - not a required update
*affiliates.tpl - Removed billing cycle column
*clientareacreditcard.tpl - Added preserving of card type/expiry date selections on validation failure
*clientareadetails.tpl - Update/fix to default payment method dropdown menu
*clientareadomains.tpl - Added new domain addons tab
*clientregister.tpl - Added currency selection dropdown for multi-currency support in registrations
*creditcard.tpl - Added preserving of card type/expiry date selections on validation failure
*forwardpage.tpl - New method of form submission - not a required update
*networkissues.tpl - Added RSS Feed link for network issues
*serverstatus.tpl - Ajaxified server status port checking

In order form templates the following changes were made:

*products.tpl (modern & slider) - Fix for bundled products ordering
*viewcart.tpl (all templates) - Update to preserve card expiry date selections on validation failure
*main.js (modern & slider) - Fix for showing domain configuration step after product add

==New Language File Lines==

If you are using a custom language file, then the new language file lines introduced in Version 5.1 can be found below the "# Version 5.1" line in each language file.

During the beta we will be reaching out to our known translators to convert new lines into the other languages. However if you are able to help in contributing even just some of the new lines translated, then it would be much appreciated.

==Release Notes==

*'''Display Problems/Browser Cache''' - Always clear your browser cache, or perform a hard refresh after upgrading, most display related issues are purely due to seeing an old version of the CSS
*'''New Domain Registrar Sync Cron''' - Until now, each registrar has had it's own sync file. But as of V5.1, the individual sync files are replaced by a single cron file (/crons/domainsync.php) which needs to be configured to run periodically - we recommend every 4 hours. All previous sync cron commands should be deleted/disabled.
*'''Naming Conversion Change''' - Template directory and module names must be all one word and contain only a-z 0-9 characters, no spaces, punctuations or symbols - this is due to a new security measure. For example a template called ''my_company'' should be renamed ''mycompany''.
*'''JSON Requirement''' - JSON is a new requirement, please ensure it is compiled in your server's PHP configuration. This is standard on most PHP configurations so no action should be necessary for the majority.

Template:Modules

2012-11-28T10:16:25Z

Kim:

<includeonly><div style="width:95%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;padding:10px;margin-right:auto;margin-left:auto;">
'''Server Modules''' 
[[CPanel/WHM|cPanel/WHM]] - [[DirectAdmin]] - [[Plesk]] - [[Helm 3]] - [[Helm 4]] - [[Ensim]] - [[InterWorx]] - [[WebsitePanel]] 
[[Lxadmin]] - [[Virtualmin Pro]] - [[XPanel]] - [[HyperVM]] - [[FluidVM]] - [[SolusVM]] - [[Cloudmin]] - [[WHMSonic]] 
[[CentovaCast]] - [[SCPanel]] - [[MediaCP]] - [[GameCP]] - [[TCAdmin]] - [[Reseller Central]] - [[Auto Release]] 
 
'''Registrar Modules''' 
[[Enom]] - [[ResellerClub]] - [[Nominet]] - [[OpenSRS]] - [[ResellOne]] - [[OnlineNIC]] - [[PlanetDomain]] 
[[TPP Wholesale|TPP Wholesale]] - [[TPPInternet]] - [[RegisterFly]] - [[Stargate]] - [[Namecheap]] - [[NetEarthOne]] - [[Bizcn]] - [[InternetBS]] 
[[12Register]] - [[Registercom]] - [[DotDNS]] - [[WebNIC]] - [[Dot.TK]] - [[HexoNet]] - [[Realtime Register]] 
[[RRPProxy]] - [[ResellerCamp]] - [[TransIP]] - [[Heart Internet]] - [[IPMirror]] - [[NetRegistry]] - [[OVH]] 
[[Email]] 
 
'''Fraud Modules''' 
[[MaxMind]] - [[VariLogiX FraudCall]] - [[Telesign]] 
 
'''Gateway Modules''' 
[[2CheckOut]] - [[ACHDirect]] - [[Amazon Simple Pay]] - [[AsiaPay]] - [[Authorize.net]] - [[Bank Transfer]] - [[BidPay]] 
[[BluePay]] - [[Boleto]] - [[CamTech]] - [[CashU]] - [[CC Avenue]] - [[ChronoPay]] - [[Cyberbit]] 
[[Direct Debit]] - [[EEECurrency]] - [[E-Gold]] - [[EMatters]] - [[E-Path]] - [[EProcessingNetwork|eProcessingNetwork]] - [[EWAY|eWAY]] - [[EWAY_Tokens|eWAY Tokens]] 
[[EWAY_UK|eWAY UK]] - [[F2B]] - [[FastHosts]] - [[Finansbank]] - [[Garantibank]] - [[Gate2Shop]] - [[GoCardless]] 
[[Google CheckOut]] - [[IMSP]] - [[Inpay]] - [[InternetSecure]] - [[IP.Pay]] - [[Kuveytturk]] - [[Liberty Reserve]] 
[[LinkPoint]] - [[Mail In Payment]] - [[Merchant Partners]] - [[Merchant Warrior]] - [[Mollieideal]] - [[Moneris]] - [[Monerisvault]] 
[[Moneybookers]] - [[iDEAL|My iDEAL]] - [[Navigate]] - [[Netbilling]] - [[Netregistrypay]] - [[Nochex]] - [[NTPNow]] 
[[OfflineCC|Offline Credit Card]] - [[OpenECHO]] - [[Optimal Payments]] - [[Pagamento]] - [[PagSeguro]] - [[Payflow Pro]] - [[Pay Junction]] 
[[Paymate_AU_and_NZ]] - [[Payment Express]] - [[Paymex]] - [[Paypal]] - [[PayPal_Express_Checkout]] - [[PayPal Payments Pro]] 
[[PayPoint|PayPoint.net (SecPay)]] - [[Payson]] - [[Payza]] - [[Planetauthorize]] - [[SagePay]] - [[ProtX_VSP_Form]] - [[PSIGate]] 
[[Quantum_Gateway]] - [[Quantum_Vault]] - [[SagePay]] - [[SecPay]] - [[SecurePay]] - [[SecurePay_AU]] 
[[StormPay]] - [[TrustCommerce]] - [[USA ePay]] - [[WorldPay]] - [[WorldPay_Invisible]]

</div></includeonly><noinclude>
Add <nowiki>{{modules}}</nowiki> for a footer to your module pages, produces:
{{modules}}
</noinclude>

EWAY Tokens

2012-11-28T10:15:25Z

Kim:

{{gateways
| type = token
| recurring = yes
| refunds = yes
| 3dsecure = yes
| updatecc = yes
| deletecc = yes

}}

The eWAY Tokens module allows you to process credit cards via eWAY without ever storing the full card details locally in your WHMCS installs database. Card details are still entered on your site for a seamless checkout process, and thus you do still need to be PCI Compliant, but your risks are greatly reduced by not storing the cards locally.

For more information, visit http://eway.com.au/developers/api/token.html

==Installation==

To install the eWAY Tokens module, begin by downloading it here: http://www.whmcs.com/members/dl.php?type=d&id=134 and then upload it to the '''/modules/gateways/''' folder of your WHMCS installation

==Configuration==

Once installed, begin by activating the module from the list of available gateways in '''Setup > Payment Gateways'' and then configure as follows:

#Enter a Display Name of your choice for end users to see (eg. Credit Card)
#Enter your eWAY Customer ID, Username & Password
#Ensure that "Disable Credit Card Storage" is '''un'''ticked in '''Setup > General Settings > Security''' - when using a token module it is not needed

Note: eWAY operates a separate system for dev/sandbox testing and so you will need to register @ http://eway.com.au/developers/sandbox.html in order to use the demo mode.

{{modules}}

EWAYUK

2012-11-28T10:14:15Z

Kim: Redirected page to EWAY UK

#REDIRECT [[EWAY_UK]]

EWAY UK

2012-11-28T10:13:45Z

Kim: Created page with '{{gateways | onetime = yes }} {{modules}}'

EWAY

2012-11-28T10:11:46Z

Kim:

{{gateways
| type = cc
| onetime = yes
| recurring = yes
| refund =yes
| 3dsecure = yes
}}

{{modules}}

EWAY Tokens

2012-11-28T10:11:07Z

Kim:

{{gateways
| type = token
| recurring = yes
| refunds = yes
| 3dsecure = yes
| updatecc = yes
| deletecc = yes

}}

The eWay Tokens module allows you to process credit cards via eWay without ever storing the full card details locally in your WHMCS installs database. Card details are still entered on your site for a seamless checkout process, and thus you do still need to be PCI Compliant, but your risks are greatly reduced by not storing the cards locally.

For more information, visit http://eway.com.au/developers/api/token.html

==Installation==

To install the eWay Tokens module, begin by downloading it here: http://www.whmcs.com/members/dl.php?type=d&id=134 and then upload it to the '''/modules/gateways/''' folder of your WHMCS installation

==Configuration==

Once installed, begin by activating the module from the list of available gateways in '''Setup > Payment Gateways'' and then configure as follows:

#Enter a Display Name of your choice for end users to see (eg. Credit Card)
#Enter your eWay Customer ID, Username & Password
#Ensure that "Disable Credit Card Storage" is '''un'''ticked in '''Setup > General Settings > Security''' - when using a token module it is not needed

Note: eWay operates a separate system for dev/sandbox testing and so you will need to register @ http://eway.com.au/developers/sandbox.html in order to use the demo mode.

{{modules}}

EWayUK

2012-11-28T09:58:49Z

Kim: Redirected page to EWAYUK

#REDIRECT [[EWAYUK]]

EWay Tokens

2012-11-28T09:58:30Z

Kim: Redirected page to EWAY Tokens

#REDIRECT [[EWAY_Tokens]]

EWay

2012-11-28T09:57:41Z

Kim: Redirected page to EWAY

#REDIRECT [[EWAY]]

EWay

2012-11-28T09:55:32Z

Kim: Redirected page to New Page Name

#REDIRECT [[New Page Name]]

Template:Modules

2012-11-28T09:42:04Z

Kim:

<includeonly><div style="width:95%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;padding:10px;margin-right:auto;margin-left:auto;">
'''Server Modules''' 
[[CPanel/WHM|cPanel/WHM]] - [[DirectAdmin]] - [[Plesk]] - [[Helm 3]] - [[Helm 4]] - [[Ensim]] - [[InterWorx]] - [[WebsitePanel]] 
[[Lxadmin]] - [[Virtualmin Pro]] - [[XPanel]] - [[HyperVM]] - [[FluidVM]] - [[SolusVM]] - [[Cloudmin]] - [[WHMSonic]] 
[[CentovaCast]] - [[SCPanel]] - [[MediaCP]] - [[GameCP]] - [[TCAdmin]] - [[Reseller Central]] - [[Auto Release]] 
 
'''Registrar Modules''' 
[[Enom]] - [[ResellerClub]] - [[Nominet]] - [[OpenSRS]] - [[ResellOne]] - [[OnlineNIC]] - [[PlanetDomain]] 
[[TPP Wholesale|TPP Wholesale]] - [[TPPInternet]] - [[RegisterFly]] - [[Stargate]] - [[Namecheap]] - [[NetEarthOne]] - [[Bizcn]] - [[InternetBS]] 
[[12Register]] - [[Registercom]] - [[DotDNS]] - [[WebNIC]] - [[Dot.TK]] - [[HexoNet]] - [[Realtime Register]] 
[[RRPProxy]] - [[ResellerCamp]] - [[TransIP]] - [[Heart Internet]] - [[IPMirror]] - [[NetRegistry]] - [[OVH]] 
[[Email]] 
 
'''Fraud Modules''' 
[[MaxMind]] - [[VariLogiX FraudCall]] - [[Telesign]] 
 
'''Gateway Modules''' 
[[2CheckOut]] - [[ACHDirect]] - [[Amazon Simple Pay]] - [[AsiaPay]] - [[Authorize.net]] - [[Bank Transfer]] - [[BidPay]] 
[[BluePay]] - [[Boleto]] - [[CamTech]] - [[CashU]] - [[CC Avenue]] - [[ChronoPay]] - [[Cyberbit]] 
[[Direct Debit]] - [[EEECurrency]] - [[E-Gold]] - [[EMatters]] - [[E-Path]] - [[EProcessingNetwork|eProcessingNetwork]] - [[EWAY|eWAY]] - [[EWAY_Tokens|eWAY Tokens]] 
[[EWAYUK|eWAYUK]] - [[F2B]] - [[FastHosts]] - [[Finansbank]] - [[Garantibank]] - [[Gate2Shop]] - [[GoCardless]] 
[[Google CheckOut]] - [[IMSP]] - [[Inpay]] - [[InternetSecure]] - [[IP.Pay]] - [[Kuveytturk]] - [[Liberty Reserve]] 
[[LinkPoint]] - [[Mail In Payment]] - [[Merchant Partners]] - [[Merchant Warrior]] - [[Mollieideal]] - [[Moneris]] - [[Monerisvault]] 
[[Moneybookers]] - [[iDEAL|My iDEAL]] - [[Navigate]] - [[Netbilling]] - [[Netregistrypay]] - [[Nochex]] - [[NTPNow]] 
[[OfflineCC|Offline Credit Card]] - [[OpenECHO]] - [[Optimal Payments]] - [[Pagamento]] - [[PagSeguro]] - [[Payflow Pro]] - [[Pay Junction]] 
[[Paymate_AU_and_NZ]] - [[Payment Express]] - [[Paymex]] - [[Paypal]] - [[PayPal_Express_Checkout]] - [[PayPal Payments Pro]] 
[[PayPoint|PayPoint.net (SecPay)]] - [[Payson]] - [[Payza]] - [[Planetauthorize]] - [[SagePay]] - [[ProtX_VSP_Form]] - [[PSIGate]] 
[[Quantum_Gateway]] - [[Quantum_Vault]] - [[SagePay]] - [[SecPay]] - [[SecurePay]] - [[SecurePay_AU]] 
[[StormPay]] - [[TrustCommerce]] - [[USA ePay]] - [[WorldPay]] - [[WorldPay_Invisible]]

</div></includeonly><noinclude>
Add <nowiki>{{modules}}</nowiki> for a footer to your module pages, produces:
{{modules}}
</noinclude>

Template:Modules

2012-11-28T09:41:44Z

Kim:

<includeonly><div style="width:95%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;padding:10px;margin-right:auto;margin-left:auto;">
'''Server Modules''' 
[[CPanel/WHM|cPanel/WHM]] - [[DirectAdmin]] - [[Plesk]] - [[Helm 3]] - [[Helm 4]] - [[Ensim]] - [[InterWorx]] - [[WebsitePanel]] 
[[Lxadmin]] - [[Virtualmin Pro]] - [[XPanel]] - [[HyperVM]] - [[FluidVM]] - [[SolusVM]] - [[Cloudmin]] - [[WHMSonic]] 
[[CentovaCast]] - [[SCPanel]] - [[MediaCP]] - [[GameCP]] - [[TCAdmin]] - [[Reseller Central]] - [[Auto Release]] 
 
'''Registrar Modules''' 
[[Enom]] - [[ResellerClub]] - [[Nominet]] - [[OpenSRS]] - [[ResellOne]] - [[OnlineNIC]] - [[PlanetDomain]] 
[[TPP Wholesale|TPP Wholesale]] - [[TPPInternet]] - [[RegisterFly]] - [[Stargate]] - [[Namecheap]] - [[NetEarthOne]] - [[Bizcn]] - [[InternetBS]] 
[[12Register]] - [[Registercom]] - [[DotDNS]] - [[WebNIC]] - [[Dot.TK]] - [[HexoNet]] - [[Realtime Register]] 
[[RRPProxy]] - [[ResellerCamp]] - [[TransIP]] - [[Heart Internet]] - [[IPMirror]] - [[NetRegistry]] - [[OVH]] 
[[Email]] 
 
'''Fraud Modules''' 
[[MaxMind]] - [[VariLogiX FraudCall]] - [[Telesign]] 
 
'''Gateway Modules''' 
[[2CheckOut]] - [[ACHDirect]] - [[Amazon Simple Pay]] - [[AsiaPay]] - [[Authorize.net]] - [[Bank Transfer]] - [[BidPay]] 
[[BluePay]] - [[Boleto]] - [[CamTech]] - [[CashU]] - [[CC Avenue]] - [[ChronoPay]] - [[Cyberbit]] 
[[Direct Debit]] - [[EEECurrency]] - [[E-Gold]] - [[EMatters]] - [[E-Path]] - [[EProcessingNetwork|eProcessingNetwork]] - [[EWAY|eWAY]] - [[EWAY_Tokens|eWAY Tokens]] 
[[EWayUK|eWAYUK]] - [[F2B]] - [[FastHosts]] - [[Finansbank]] - [[Garantibank]] - [[Gate2Shop]] - [[GoCardless]] 
[[Google CheckOut]] - [[IMSP]] - [[Inpay]] - [[InternetSecure]] - [[IP.Pay]] - [[Kuveytturk]] - [[Liberty Reserve]] 
[[LinkPoint]] - [[Mail In Payment]] - [[Merchant Partners]] - [[Merchant Warrior]] - [[Mollieideal]] - [[Moneris]] - [[Monerisvault]] 
[[Moneybookers]] - [[iDEAL|My iDEAL]] - [[Navigate]] - [[Netbilling]] - [[Netregistrypay]] - [[Nochex]] - [[NTPNow]] 
[[OfflineCC|Offline Credit Card]] - [[OpenECHO]] - [[Optimal Payments]] - [[Pagamento]] - [[PagSeguro]] - [[Payflow Pro]] - [[Pay Junction]] 
[[Paymate_AU_and_NZ]] - [[Payment Express]] - [[Paymex]] - [[Paypal]] - [[PayPal_Express_Checkout]] - [[PayPal Payments Pro]] 
[[PayPoint|PayPoint.net (SecPay)]] - [[Payson]] - [[Payza]] - [[Planetauthorize]] - [[SagePay]] - [[ProtX_VSP_Form]] - [[PSIGate]] 
[[Quantum_Gateway]] - [[Quantum_Vault]] - [[SagePay]] - [[SecPay]] - [[SecurePay]] - [[SecurePay_AU]] 
[[StormPay]] - [[TrustCommerce]] - [[USA ePay]] - [[WorldPay]] - [[WorldPay_Invisible]]

</div></includeonly><noinclude>
Add <nowiki>{{modules}}</nowiki> for a footer to your module pages, produces:
{{modules}}
</noinclude>

EWAYUK

2012-11-28T09:41:10Z

Kim: Created page with '{{gateways | onetime = yes }} {{modules}}'

EWAY Tokens

2012-11-28T09:41:08Z

Kim: Created page with '{{gateways | type = token | recurring = yes | refunds = yes | updatecc = yes | deletecc = yes }} The eWay Tokens module allows you to process credit cards via eWay without ever…'

{{gateways
| type = token
| recurring = yes
| refunds = yes
| updatecc = yes
| deletecc = yes

}}

The eWay Tokens module allows you to process credit cards via eWay without ever storing the full card details locally in your WHMCS installs database. Card details are still entered on your site for a seamless checkout process, and thus you do still need to be PCI Compliant, but your risks are greatly reduced by not storing the cards locally.

For more information, visit http://eway.com.au/developers/api/token.html

==Installation==

To install the eWay Tokens module, begin by downloading it here: http://www.whmcs.com/members/dl.php?type=d&id=134 and then upload it to the '''/modules/gateways/''' folder of your WHMCS installation

==Configuration==

Once installed, begin by activating the module from the list of available gateways in '''Setup > Payment Gateways'' and then configure as follows:

#Enter a Display Name of your choice for end users to see (eg. Credit Card)
#Enter your eWay Customer ID, Username & Password
#Ensure that "Disable Credit Card Storage" is '''un'''ticked in '''Setup > General Settings > Security''' - when using a token module it is not needed

Note: eWay operates a separate system for dev/sandbox testing and so you will need to register @ http://eway.com.au/developers/sandbox.html in order to use the demo mode.

{{modules}}

Template:Modules

2012-11-28T09:37:55Z

Kim:

<includeonly><div style="width:95%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;padding:10px;margin-right:auto;margin-left:auto;">
'''Server Modules''' 
[[CPanel/WHM|cPanel/WHM]] - [[DirectAdmin]] - [[Plesk]] - [[Helm 3]] - [[Helm 4]] - [[Ensim]] - [[InterWorx]] - [[WebsitePanel]] 
[[Lxadmin]] - [[Virtualmin Pro]] - [[XPanel]] - [[HyperVM]] - [[FluidVM]] - [[SolusVM]] - [[Cloudmin]] - [[WHMSonic]] 
[[CentovaCast]] - [[SCPanel]] - [[MediaCP]] - [[GameCP]] - [[TCAdmin]] - [[Reseller Central]] - [[Auto Release]] 
 
'''Registrar Modules''' 
[[Enom]] - [[ResellerClub]] - [[Nominet]] - [[OpenSRS]] - [[ResellOne]] - [[OnlineNIC]] - [[PlanetDomain]] 
[[TPP Wholesale|TPP Wholesale]] - [[TPPInternet]] - [[RegisterFly]] - [[Stargate]] - [[Namecheap]] - [[NetEarthOne]] - [[Bizcn]] - [[InternetBS]] 
[[12Register]] - [[Registercom]] - [[DotDNS]] - [[WebNIC]] - [[Dot.TK]] - [[HexoNet]] - [[Realtime Register]] 
[[RRPProxy]] - [[ResellerCamp]] - [[TransIP]] - [[Heart Internet]] - [[IPMirror]] - [[NetRegistry]] - [[OVH]] 
[[Email]] 
 
'''Fraud Modules''' 
[[MaxMind]] - [[VariLogiX FraudCall]] - [[Telesign]] 
 
'''Gateway Modules''' 
[[2CheckOut]] - [[ACHDirect]] - [[Amazon Simple Pay]] - [[AsiaPay]] - [[Authorize.net]] - [[Bank Transfer]] - [[BidPay]] 
[[BluePay]] - [[Boleto]] - [[CamTech]] - [[CashU]] - [[CC Avenue]] - [[ChronoPay]] - [[Cyberbit]] 
[[Direct Debit]] - [[EEECurrency]] - [[E-Gold]] - [[EMatters]] - [[E-Path]] - [[EProcessingNetwork|eProcessingNetwork]] - [[EWAY|eWAY]] - [[EWay_Tokens|eWAY Tokens]] 
[[EWayUK|eWAYUK]] - [[F2B]] - [[FastHosts]] - [[Finansbank]] - [[Garantibank]] - [[Gate2Shop]] - [[GoCardless]] 
[[Google CheckOut]] - [[IMSP]] - [[Inpay]] - [[InternetSecure]] - [[IP.Pay]] - [[Kuveytturk]] - [[Liberty Reserve]] 
[[LinkPoint]] - [[Mail In Payment]] - [[Merchant Partners]] - [[Merchant Warrior]] - [[Mollieideal]] - [[Moneris]] - [[Monerisvault]] 
[[Moneybookers]] - [[iDEAL|My iDEAL]] - [[Navigate]] - [[Netbilling]] - [[Netregistrypay]] - [[Nochex]] - [[NTPNow]] 
[[OfflineCC|Offline Credit Card]] - [[OpenECHO]] - [[Optimal Payments]] - [[Pagamento]] - [[PagSeguro]] - [[Payflow Pro]] - [[Pay Junction]] 
[[Paymate_AU_and_NZ]] - [[Payment Express]] - [[Paymex]] - [[Paypal]] - [[PayPal_Express_Checkout]] - [[PayPal Payments Pro]] 
[[PayPoint|PayPoint.net (SecPay)]] - [[Payson]] - [[Payza]] - [[Planetauthorize]] - [[SagePay]] - [[ProtX_VSP_Form]] - [[PSIGate]] 
[[Quantum_Gateway]] - [[Quantum_Vault]] - [[SagePay]] - [[SecPay]] - [[SecurePay]] - [[SecurePay_AU]] 
[[StormPay]] - [[TrustCommerce]] - [[USA ePay]] - [[WorldPay]] - [[WorldPay_Invisible]]

</div></includeonly><noinclude>
Add <nowiki>{{modules}}</nowiki> for a footer to your module pages, produces:
{{modules}}
</noinclude>

EWAY

2012-11-28T09:37:35Z

Kim: Created page with '{{gateways | type = cc | onetime = yes | recurring = yes | refund =yes }} {{modules}}'

{{gateways
| type = cc
| onetime = yes
| recurring = yes
| refund =yes
}}

{{modules}}

Template:Modules

2012-11-28T09:36:31Z

Kim:

<includeonly><div style="width:95%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;padding:10px;margin-right:auto;margin-left:auto;">
'''Server Modules''' 
[[CPanel/WHM|cPanel/WHM]] - [[DirectAdmin]] - [[Plesk]] - [[Helm 3]] - [[Helm 4]] - [[Ensim]] - [[InterWorx]] - [[WebsitePanel]] 
[[Lxadmin]] - [[Virtualmin Pro]] - [[XPanel]] - [[HyperVM]] - [[FluidVM]] - [[SolusVM]] - [[Cloudmin]] - [[WHMSonic]] 
[[CentovaCast]] - [[SCPanel]] - [[MediaCP]] - [[GameCP]] - [[TCAdmin]] - [[Reseller Central]] - [[Auto Release]] 
 
'''Registrar Modules''' 
[[Enom]] - [[ResellerClub]] - [[Nominet]] - [[OpenSRS]] - [[ResellOne]] - [[OnlineNIC]] - [[PlanetDomain]] 
[[TPP Wholesale|TPP Wholesale]] - [[TPPInternet]] - [[RegisterFly]] - [[Stargate]] - [[Namecheap]] - [[NetEarthOne]] - [[Bizcn]] - [[InternetBS]] 
[[12Register]] - [[Registercom]] - [[DotDNS]] - [[WebNIC]] - [[Dot.TK]] - [[HexoNet]] - [[Realtime Register]] 
[[RRPProxy]] - [[ResellerCamp]] - [[TransIP]] - [[Heart Internet]] - [[IPMirror]] - [[NetRegistry]] - [[OVH]] 
[[Email]] 
 
'''Fraud Modules''' 
[[MaxMind]] - [[VariLogiX FraudCall]] - [[Telesign]] 
 
'''Gateway Modules''' 
[[2CheckOut]] - [[ACHDirect]] - [[Amazon Simple Pay]] - [[AsiaPay]] - [[Authorize.net]] - [[Bank Transfer]] - [[BidPay]] 
[[BluePay]] - [[Boleto]] - [[CamTech]] - [[CashU]] - [[CC Avenue]] - [[ChronoPay]] - [[Cyberbit]] 
[[Direct Debit]] - [[EEECurrency]] - [[E-Gold]] - [[EMatters]] - [[E-Path]] - [[EProcessingNetwork|eProcessingNetwork]] - [[EWay|eWAY]] - [[EWay_Tokens|eWAY Tokens]] 
[[EWayUK|eWAYUK]] - [[F2B]] - [[FastHosts]] - [[Finansbank]] - [[Garantibank]] - [[Gate2Shop]] - [[GoCardless]] 
[[Google CheckOut]] - [[IMSP]] - [[Inpay]] - [[InternetSecure]] - [[IP.Pay]] - [[Kuveytturk]] - [[Liberty Reserve]] 
[[LinkPoint]] - [[Mail In Payment]] - [[Merchant Partners]] - [[Merchant Warrior]] - [[Mollieideal]] - [[Moneris]] - [[Monerisvault]] 
[[Moneybookers]] - [[iDEAL|My iDEAL]] - [[Navigate]] - [[Netbilling]] - [[Netregistrypay]] - [[Nochex]] - [[NTPNow]] 
[[OfflineCC|Offline Credit Card]] - [[OpenECHO]] - [[Optimal Payments]] - [[Pagamento]] - [[PagSeguro]] - [[Payflow Pro]] - [[Pay Junction]] 
[[Paymate_AU_and_NZ]] - [[Payment Express]] - [[Paymex]] - [[Paypal]] - [[PayPal_Express_Checkout]] - [[PayPal Payments Pro]] 
[[PayPoint|PayPoint.net (SecPay)]] - [[Payson]] - [[Payza]] - [[Planetauthorize]] - [[SagePay]] - [[ProtX_VSP_Form]] - [[PSIGate]] 
[[Quantum_Gateway]] - [[Quantum_Vault]] - [[SagePay]] - [[SecPay]] - [[SecurePay]] - [[SecurePay_AU]] 
[[StormPay]] - [[TrustCommerce]] - [[USA ePay]] - [[WorldPay]] - [[WorldPay_Invisible]]

</div></includeonly><noinclude>
Add <nowiki>{{modules}}</nowiki> for a footer to your module pages, produces:
{{modules}}
</noinclude>

Template:Modules

2012-11-28T09:35:48Z

Kim:

<includeonly><div style="width:95%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;padding:10px;margin-right:auto;margin-left:auto;">
'''Server Modules''' 
[[CPanel/WHM|cPanel/WHM]] - [[DirectAdmin]] - [[Plesk]] - [[Helm 3]] - [[Helm 4]] - [[Ensim]] - [[InterWorx]] - [[WebsitePanel]] 
[[Lxadmin]] - [[Virtualmin Pro]] - [[XPanel]] - [[HyperVM]] - [[FluidVM]] - [[SolusVM]] - [[Cloudmin]] - [[WHMSonic]] 
[[CentovaCast]] - [[SCPanel]] - [[MediaCP]] - [[GameCP]] - [[TCAdmin]] - [[Reseller Central]] - [[Auto Release]] 
 
'''Registrar Modules''' 
[[Enom]] - [[ResellerClub]] - [[Nominet]] - [[OpenSRS]] - [[ResellOne]] - [[OnlineNIC]] - [[PlanetDomain]] 
[[TPP Wholesale|TPP Wholesale]] - [[TPPInternet]] - [[RegisterFly]] - [[Stargate]] - [[Namecheap]] - [[NetEarthOne]] - [[Bizcn]] - [[InternetBS]] 
[[12Register]] - [[Registercom]] - [[DotDNS]] - [[WebNIC]] - [[Dot.TK]] - [[HexoNet]] - [[Realtime Register]] 
[[RRPProxy]] - [[ResellerCamp]] - [[TransIP]] - [[Heart Internet]] - [[IPMirror]] - [[NetRegistry]] - [[OVH]] 
[[Email]] 
 
'''Fraud Modules''' 
[[MaxMind]] - [[VariLogiX FraudCall]] - [[Telesign]] 
 
'''Gateway Modules''' 
[[2CheckOut]] - [[ACHDirect]] - [[Amazon Simple Pay]] - [[AsiaPay]] - [[Authorize.net]] - [[Bank Transfer]] - [[BidPay]] 
[[BluePay]] - [[Boleto]] - [[CamTech]] - [[CashU]] - [[CC Avenue]] - [[ChronoPay]] - [[Cyberbit]] 
[[Direct Debit]] - [[EEECurrency]] - [[E-Gold]] - [[EMatters]] - [[E-Path]] - [[EProcessingNetwork|eProcessingNetwork]] - [[EWay|eWAY]] - [[EWay_Tokens|e Tokens]] 
[[EWayUK|eWayUK]] - [[F2B]] - [[FastHosts]] - [[Finansbank]] - [[Garantibank]] - [[Gate2Shop]] - [[GoCardless]] 
[[Google CheckOut]] - [[IMSP]] - [[Inpay]] - [[InternetSecure]] - [[IP.Pay]] - [[Kuveytturk]] - [[Liberty Reserve]] 
[[LinkPoint]] - [[Mail In Payment]] - [[Merchant Partners]] - [[Merchant Warrior]] - [[Mollieideal]] - [[Moneris]] - [[Monerisvault]] 
[[Moneybookers]] - [[iDEAL|My iDEAL]] - [[Navigate]] - [[Netbilling]] - [[Netregistrypay]] - [[Nochex]] - [[NTPNow]] 
[[OfflineCC|Offline Credit Card]] - [[OpenECHO]] - [[Optimal Payments]] - [[Pagamento]] - [[PagSeguro]] - [[Payflow Pro]] - [[Pay Junction]] 
[[Paymate_AU_and_NZ]] - [[Payment Express]] - [[Paymex]] - [[Paypal]] - [[PayPal_Express_Checkout]] - [[PayPal Payments Pro]] 
[[PayPoint|PayPoint.net (SecPay)]] - [[Payson]] - [[Payza]] - [[Planetauthorize]] - [[SagePay]] - [[ProtX_VSP_Form]] - [[PSIGate]] 
[[Quantum_Gateway]] - [[Quantum_Vault]] - [[SagePay]] - [[SecPay]] - [[SecurePay]] - [[SecurePay_AU]] 
[[StormPay]] - [[TrustCommerce]] - [[USA ePay]] - [[WorldPay]] - [[WorldPay_Invisible]]

</div></includeonly><noinclude>
Add <nowiki>{{modules}}</nowiki> for a footer to your module pages, produces:
{{modules}}
</noinclude>

Template:Modules

2012-11-28T09:35:18Z

Kim:

<includeonly><div style="width:95%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;padding:10px;margin-right:auto;margin-left:auto;">
'''Server Modules''' 
[[CPanel/WHM|cPanel/WHM]] - [[DirectAdmin]] - [[Plesk]] - [[Helm 3]] - [[Helm 4]] - [[Ensim]] - [[InterWorx]] - [[WebsitePanel]] 
[[Lxadmin]] - [[Virtualmin Pro]] - [[XPanel]] - [[HyperVM]] - [[FluidVM]] - [[SolusVM]] - [[Cloudmin]] - [[WHMSonic]] 
[[CentovaCast]] - [[SCPanel]] - [[MediaCP]] - [[GameCP]] - [[TCAdmin]] - [[Reseller Central]] - [[Auto Release]] 
 
'''Registrar Modules''' 
[[Enom]] - [[ResellerClub]] - [[Nominet]] - [[OpenSRS]] - [[ResellOne]] - [[OnlineNIC]] - [[PlanetDomain]] 
[[TPP Wholesale|TPP Wholesale]] - [[TPPInternet]] - [[RegisterFly]] - [[Stargate]] - [[Namecheap]] - [[NetEarthOne]] - [[Bizcn]] - [[InternetBS]] 
[[12Register]] - [[Registercom]] - [[DotDNS]] - [[WebNIC]] - [[Dot.TK]] - [[HexoNet]] - [[Realtime Register]] 
[[RRPProxy]] - [[ResellerCamp]] - [[TransIP]] - [[Heart Internet]] - [[IPMirror]] - [[NetRegistry]] - [[OVH]] 
[[Email]] 
 
'''Fraud Modules''' 
[[MaxMind]] - [[VariLogiX FraudCall]] - [[Telesign]] 
 
'''Gateway Modules''' 
[[2CheckOut]] - [[ACHDirect]] - [[Amazon Simple Pay]] - [[AsiaPay]] - [[Authorize.net]] - [[Bank Transfer]] - [[BidPay]] 
[[BluePay]] - [[Boleto]] - [[CamTech]] - [[CashU]] - [[CC Avenue]] - [[ChronoPay]] - [[Cyberbit]] 
[[Direct Debit]] - [[EEECurrency]] - [[E-Gold]] - [[EMatters]] - [[E-Path]] - [[EProcessingNetwork|eProcessingNetwork]] - [[EWay|eWAY]] - [[EWay_Tokens|eWay Tokens]] 
[[EWayUK|eWayUK]] - [[F2B]] - [[FastHosts]] - [[Finansbank]] - [[Garantibank]] - [[Gate2Shop]] - [[GoCardless]] 
[[Google CheckOut]] - [[IMSP]] - [[Inpay]] - [[InternetSecure]] - [[IP.Pay]] - [[Kuveytturk]] - [[Liberty Reserve]] 
[[LinkPoint]] - [[Mail In Payment]] - [[Merchant Partners]] - [[Merchant Warrior]] - [[Mollieideal]] - [[Moneris]] - [[Monerisvault]] 
[[Moneybookers]] - [[iDEAL|My iDEAL]] - [[Navigate]] - [[Netbilling]] - [[Netregistrypay]] - [[Nochex]] - [[NTPNow]] 
[[OfflineCC|Offline Credit Card]] - [[OpenECHO]] - [[Optimal Payments]] - [[Pagamento]] - [[PagSeguro]] - [[Payflow Pro]] - [[Pay Junction]] 
[[Paymate_AU_and_NZ]] - [[Payment Express]] - [[Paymex]] - [[Paypal]] - [[PayPal_Express_Checkout]] - [[PayPal Payments Pro]] 
[[PayPoint|PayPoint.net (SecPay)]] - [[Payson]] - [[Payza]] - [[Planetauthorize]] - [[SagePay]] - [[ProtX_VSP_Form]] - [[PSIGate]] 
[[Quantum_Gateway]] - [[Quantum_Vault]] - [[SagePay]] - [[SecPay]] - [[SecurePay]] - [[SecurePay_AU]] 
[[StormPay]] - [[TrustCommerce]] - [[USA ePay]] - [[WorldPay]] - [[WorldPay_Invisible]]

</div></includeonly><noinclude>
Add <nowiki>{{modules}}</nowiki> for a footer to your module pages, produces:
{{modules}}
</noinclude>

Server Modules

2012-11-23T09:30:05Z

Kim:

The following provisioning modules are supported.

<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="48%" valign="top">

==Hosting Control Panels==
*[[cPanel/WHM]]
*[[DirectAdmin]]
*[[Plesk]]
*[[Helm 3]]
*[[Helm 4]]
*[[Ensim]]
*[[InterWorx]]
*[[DotNetPanel|DotNetPanel / WebsitePanel]]
*[[Lxadmin]]
*[[Virtualmin Pro]]
*[[XPanel]]

==Shoutcast Panels==
*[[WHMSonic]]
*[[CentovaCast]]
*[[SCPanel]]
*[[CastControl]]

== Backup ==

*[[Ahsay Addon Module]]
*[[BackupAgent]]

</td><td width="4%"></td><td width="48%" valign="top">

==VPS==
*[[FluidVM]]
*[[SolusVM]]
*[[Cloudmin]]
*[[Virtualizor]]
*[[VPS.Net]]
*[[HyperVM]]

==SSL Certificates==
*[[Enom SSL Certificates]]
*[[ResellerClub SSL|ResellerClub SSL Certificates]]
*[[GlobalSign SSL|GlobalSign SSL Certificates]]
*[[GlobalSign OneClickSSL]]

==Gaming Panels==
*[[GameCP]]
*[[TCAdmin]]

==Other==
*[[Heart Internet]]
*[[Reseller Central]]
*[[Auto Release]]

</td></tr></table>

__NOTOC__

KashFlow Accounting

2012-11-21T17:01:20Z

Kim: Setup > Admin Modules to Setup > Addon Modules

KashFlow is an accounting system primarily for UK small businesses but with customers worldwide and this addon module for WHMCS automates the entry of paid invoices into the KashFlow system.

Once installed & configured, the sync process runs as part of the daily cron and creates clients, invoices & transactions in KashFlow to mirror the invoice and transaction records in your WHMCS system.

==Additional Requirement==
The KashFlow API requires SOAP is compiled into your server's PHP build. To check if you have this, inside your WHMCS admin area navigate to '''Utilities > System > PHP Info''' & if you see no mention of SOAP then you will need to recompile.

==Installation==

Installation can be completed in 4 simple steps:

#Begin by downloading the latest version from http://www.whmcs.com/members/communityaddons.php?action=viewmod&id=125
#Now unzip the files to a folder on your computer
#Next upload the "kashflow" folder from the zip file to the '''/modules/addons/''' directory of WHMCS on your server
#To complete the process, navigate to '''Setup > Addon Modules''' within the WHMCS Admin Area and then click the Activate link next to the new KashFlow module

==Configuration==

#To configure the module, begin by going to '''Setup > Addon Modules'''
#Here you will first be asked to enter your KashFlow Username & Password. Once you have done this click '''Save Changes'''
#The API login will then be tested and if there's a problem with the username and/or password you entered an error will be displayed on screen. You need to ensure you have enabled API Access inside your KashFlow account and added your Server IP to the allowed IPs list with them too prior to this.
#If the login was ok, you will see a new selection of fields appear for each of your active payment gateways in WHMCS
#This is where you need to choose the corresponding KashFlow payment method and bank account that transactions for each of the gateways in your WHMCS system should be assigned to when syncing (for more information on this refer to KashFlow's documentation)
#Once you've done that for each payment gateway you have in use, simply save the changes and you're now all set - the first KashFlow syncronisation will run as part of the next daily cron job execution

==The Syncing Process==

*The sync process will run as part of the daily cron whilever the Enable box is checked - to disable again simply untick the box
*Should any errors occur when sending data to KashFlow, they will be recorded in the Activity Log under the Utilities menu so you should review it periodically to check for any errors
*The first few runs will attempt to sync all existing customers & paid invoices and so may take longer than normal