Difference between revisions of "Version 4.5 Release Notes"

From WHMCS Documentation

(Created page with '==Release Information== ===Version 4.5.0=== *Release Type: Beta (For Testing) *Release Date: 13th April 2011 ==Provisional Changelog== A provisional changelog of what you can …')
 
Line 5: Line 5:
 
*Release Date: 13th April 2011
 
*Release Date: 13th April 2011
  
==Provisional Changelog==
+
===Version 4.5.1===
 +
*Release Type: Stable Release
 +
*Release Date: 18th May 2011
  
A provisional changelog of what you can expect to see in Version 4.5 is available @ http://www.whmcs.com/members/dl.php?type=d&id=74
+
==Changelog==
 +
 
 +
A changelog showcasing the new features and enhancements in WHMCS V4.5 can be found @ http://www.whmcs.com/members/dl.php?type=d&id=76
  
 
==Upgrade Steps==
 
==Upgrade Steps==
  
To upgrade your current WHMCS installation to V4.5, simply follow the usual upgrade instructions below.
+
To upgrade your current WHMCS installation to Version 4.5, simply follow the steps below.  These same steps can be used to upgrade from any Version V3.3 or later.
  
 
#Begin by taking a backup of your database using a tool such as phpMyAdmin
 
#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 the provider of your license
 
#Now download the latest WHMCS version either from our client area (http://wiki.whmcs.com/Upgrading#Downloading_the_Latest_Version) or from the provider of your license
 
#Next, unzip the contents of the latest WHMCS zip file download to a folder on your computer
 
#Next, unzip the contents of the latest WHMCS zip file download to a folder on your computer
#Now remove the /images/logo.jpg file to avoid overwriting your customised logo
+
#Now remove the /images/logo.jpg file to avoid overwriting your customised logo image
#Upload the files to your existing installation folder overwriting any existing files
+
#Next 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 overwriting any existing files
 
#Visit the admin area as you normally would to login and you should then see the upgrade script
 
#Visit the admin area as you normally would to login and you should then see the upgrade script
 
#Accept the license agreement
 
#Accept the license agreement
#Confirm you have backed up your database and click the upgrade button
+
#Tick to confirm you have backed up your database and click the upgrade button
 
#Once the updates finish, delete the install folder from your server
 
#Once the updates finish, delete the install folder from your server
  
The upgrade is now completed. The only thing left to do is apply the new and changed template files to your custom template folders.
+
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==
 
==Template Changes==
Line 32: Line 37:
 
*'''clientareacontacts.tpl''' (added state dropdown chooser)
 
*'''clientareacontacts.tpl''' (added state dropdown chooser)
 
*'''clientareadetails.tpl''' (added state dropdown chooser)
 
*'''clientareadetails.tpl''' (added state dropdown chooser)
 +
*'''clientareadomaincontactinfo.tpl''' (added error reporting on whois update failure)
 
*'''clientareaquotes.tpl''' (new client area quote listing page)
 
*'''clientareaquotes.tpl''' (new client area quote listing page)
 
*'''clientregister.tpl''' (added state dropdown chooser)
 
*'''clientregister.tpl''' (added state dropdown chooser)
Line 38: Line 44:
 
*'''creditcard.tpl''' (added state dropdown chooser)
 
*'''creditcard.tpl''' (added state dropdown chooser)
 
*'''header.tpl''' (added link to new clientarea.php?action=quotes page - optional update)
 
*'''header.tpl''' (added link to new clientarea.php?action=quotes page - optional update)
 +
*'''invoicepdf.tpl''' (new custom fields show on invoices feature)
 
*'''quotepdf.tpl''' (added multi-language support - optional update)
 
*'''quotepdf.tpl''' (added multi-language support - optional update)
 
*'''upgradesummary.tpl''' (added promotion code support to upgrade process)
 
*'''upgradesummary.tpl''' (added promotion code support to upgrade process)
 +
*'''viewinvoice.tpl''' (for new custom fields output & payment pending review status for 2co recurring)
 +
 +
The V4.5 update includes a number of new order templates. No existing template changes are needed, but to take advantage of the state dropdown chooser during checkout you will need to add the line below to the top of the viewcart.tpl template file in any active order templates.
  
The V4.5 update includes a number of new order templates. No existing template changes are needed, but to take advantage of the state dropdown chooser during checkout you will need to add a new line to the viewcart.tpl template files of any active templates.
+
<script type="text/javascript" src="includes/jscript/statesdropdown.js"></script>
  
 
There are a couple of admin area template file changes also as follows:
 
There are a couple of admin area template file changes also as follows:
Line 47: Line 57:
 
*'''clientsummary.tpl''' (added new summary page hook point for HTML output)
 
*'''clientsummary.tpl''' (added new summary page hook point for HTML output)
 
*'''viewticket.tpl''' (added predefined reply quick search)
 
*'''viewticket.tpl''' (added predefined reply quick search)
 +
 +
Along with the entirely new admin template '''Blend''' which can be uploaded via the folder /admin/templates/blend/
  
 
==New Language File Lines==
 
==New Language File Lines==
  
 
The new language file lines for Version 4.5 can be found below the "# Version 4.5" line in each language file.
 
The new language file lines for Version 4.5 can be found below the "# Version 4.5" line in each language file.
 +
 +
==Release Notes==
 +
 +
*If you '''use the 2CheckOut module''', you will need to reconfigure and setup the 2CheckOut INS service after upgrading to V4.5. Please refer to the [[2CheckOut]] page for more details
 +
 +
*The upgrade by default will enable 2 new settings '''Grouping of Similar Line Items''' and '''Cancellation Requests automated Invoice Cancelling'''.  If you do not want these enabled then you will need to disable them in '''Setup > General Settings > Invoices'''
 +
 +
==Documentation Links==
 +
 +
*[[Standard Order Form Templates]] - A showcase of the default order templates and functionality
 +
*[[Ordering Tab#Signup Anniversary Prorata|Signup Anniversary Prorata]]

Revision as of 14:40, 18 May 2011

Release Information

Version 4.5.0

  • Release Type: Beta (For Testing)
  • Release Date: 13th April 2011

Version 4.5.1

  • Release Type: Stable Release
  • Release Date: 18th May 2011

Changelog

A changelog showcasing the new features and enhancements in WHMCS V4.5 can be found @ http://www.whmcs.com/members/dl.php?type=d&id=76

Upgrade Steps

To upgrade your current WHMCS installation to Version 4.5, simply follow the steps below. These same steps can be used to upgrade from any Version V3.3 or later.

  1. Begin by taking a backup of your database using a tool such as phpMyAdmin
  2. Now download the latest WHMCS version either from our client area (http://wiki.whmcs.com/Upgrading#Downloading_the_Latest_Version) or from the provider of your license
  3. Next, unzip the contents of the latest WHMCS zip file download to a folder on your computer
  4. Now remove the /images/logo.jpg file to avoid overwriting your customised logo image
  5. Next if you have customised your WHMCS admin folder name, you should rename the admin folder in the new files to match
  6. Upload the new files to your existing installation folder overwriting any existing files
  7. Visit the admin area as you normally would to login and you should then see the upgrade script
  8. Accept the license agreement
  9. Tick to confirm you have backed up your database and click the upgrade button
  10. Once the updates finish, delete the install folder from your server

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

Below is a list of all the client area template files have changed between V4.4 and V4.5. A description of the change is provided to help with merging changes.

  • clientareaaddcontact.tpl (added state dropdown chooser)
  • clientareacontacts.tpl (added state dropdown chooser)
  • clientareadetails.tpl (added state dropdown chooser)
  • clientareadomaincontactinfo.tpl (added error reporting on whois update failure)
  • clientareaquotes.tpl (new client area quote listing page)
  • clientregister.tpl (added state dropdown chooser)
  • configuressl-complete.tpl (updates to support more flexible SSL configurations)
  • configuressl-stepone.tpl (updates to support more flexible SSL configurations)
  • creditcard.tpl (added state dropdown chooser)
  • header.tpl (added link to new clientarea.php?action=quotes page - optional update)
  • invoicepdf.tpl (new custom fields show on invoices feature)
  • quotepdf.tpl (added multi-language support - optional update)
  • upgradesummary.tpl (added promotion code support to upgrade process)
  • viewinvoice.tpl (for new custom fields output & payment pending review status for 2co recurring)

The V4.5 update includes a number of new order templates. No existing template changes are needed, but to take advantage of the state dropdown chooser during checkout you will need to add the line below to the top of the viewcart.tpl template file in any active order templates.

<script type="text/javascript" src="includes/jscript/statesdropdown.js"></script>

There are a couple of admin area template file changes also as follows:

  • clientsummary.tpl (added new summary page hook point for HTML output)
  • viewticket.tpl (added predefined reply quick search)

Along with the entirely new admin template Blend which can be uploaded via the folder /admin/templates/blend/

New Language File Lines

The new language file lines for Version 4.5 can be found below the "# Version 4.5" line in each language file.

Release Notes

  • If you use the 2CheckOut module, you will need to reconfigure and setup the 2CheckOut INS service after upgrading to V4.5. Please refer to the 2CheckOut page for more details
  • The upgrade by default will enable 2 new settings Grouping of Similar Line Items and Cancellation Requests automated Invoice Cancelling. If you do not want these enabled then you will need to disable them in Setup > General Settings > Invoices

Documentation Links