Upgrade and Compatibility Guide

The Easy Edit Suite is currently compatible for MySource Matrix versions 3.28.2 to 3.28.9 and Squiz Matrix versions 4.0.0 and higher. Due to major changes introduced in the releases of the Easy Edit Suite, it is important that you have the correct version for your system. This chapter will explain how to identify your current version of the Easy Edit Suite and explains any upgrade procedures that may be required.

Bookmarks to the headings on this page:

  1. Identifying Your EES Version Number
  2. EES Releases and Matrix Compatibility
  3. Upgrading to EES Phase 1 and Phase 2
  4. Upgrading to EES Phase 3
  5. Upgrading to EES Phase 4 (Edit+ Compatible)

Identifying Your Easy Edit Suite Version Number

As of build 1081 of the Easy Edit Suite, you are now able to identify the version that you are running by loading Edit Mode and viewing the bottom left corner of the web browser, as shown in the figure below.

The Easy Edit Suite build information in Edit Mode
The Easy Edit Suite build information in the Edit Mode interface

As shown in the figure, the build information will be displayed in the following format:

EES Build XXXX where XXXX is the version number of the Easy Edit Suite. 
If you have Edit+ enabled you will see a '+' character appended to the build number.

 

For versions 832 and 833 of the Easy Edit Suite, you can find the version number in the version.txt file, located in the ees install directory.

Tip: You can locate the version.txt file of your Easy Edit Suite install by inputting the following web path in your browser: <my_site>/__data/ees/version.txt.

There is no version information available on builds prior to 832. If you do not have a version.txt file in your ees install directory and your system does not contain the Asset Finder and Creation Wizard functions, you are most likely on a Phase 1 build (435 or 477).

Easy Edit Suite Releases and Squiz Matrix Compatibility

The follow tables summarise the releases of the Easy Edit Suite and which versions of Squiz Matrix they are compatible with.

Easy Edit Suite Phase 1

Release Date Build / Release Notes Squiz Matrix Compatibility
19 May 2010 435 3.28.0 to 3.28.2 
29 Jun 2010 477 [Download] 3.28.0 to 3.28.2
08 Sep 2010 681 3.28.3 to 3.28.9


Easy Edit Suite Phase 2 

Release Date Build / Release Notes Squiz Matrix Compatibility
09 Dec 2010 771 4.0.1 to 4.4.0 
11 Jan 2011 793 4.0.1 to 4.4.0 
15 Feb 2011 818 4.0.1 to 4.4.0 
31 Mar 2011 832 [Download] 4.0.1 to 4.4.0 
31 Mar 2011 833 [Download] 3.28.3 to 3.28.9 


Easy Edit Suite Phase 3

Release Date Build / Release Notes Squiz Matrix Compatibility
05 Sep 2011 1081 4.4.1 to 4.6.5 / 4.8.1
14 Sep 2011 1085 4.4.1 to 4.6.5 / 4.8.1
22 Sep 2011 1087 4.4.1 to 4.6.5 / 4.8.1
14 Oct 2011 1089 4.4.1 to 4.6.5 / 4.8.1
10 Nov 2011 1102 4.4.1 to 4.6.5 / 4.8.1
24 Jan 2011 1141 4.4.1 to 4.6.5 / 4.8.1
20 Feb 2012 1141-1 4.4.1 to 4.6.5 / 4.8.1
14 Mar 2012 1141-2 4.4.1 to 4.6.5 / 4.8.1
23 April 2012 1141-3 [Download] 4.4.1 to 4.6.5 / 4.8.1


Easy Edit Suite Phase 4 (Edit+ Compatible)

Release Date Build / Release Notes Squiz Matrix Compatibility
15 May 2012 1645 [Download] 4.6.6+ / 4.8.2+

 

Tip: The current latest release of the Easy Edit Suite is available for download from the Squiz Matrix site.

For version information on both the Easy Edit Suite and Squiz Matrix, refer to the Squiz Matrix Release Schedule.

Upgrading to EES Phase 1 and Phase 2

Please note that this process is applicable for Squiz Matrix versions 3.38.0 to 4.4.0 and assumes that the Easy Edit Suite has been previously installed correctly and is in use.

When upgrading the Easy Edit Suite to any Phase 1 or Phase 2 release (builds 447 to 833):

  1. Replace the existing ees folder within the public data directory with the new ees folder from the appropriate compatible compressed package.
  2. Ensure users have cleared the their browser cache.

Upgrading to EES Phase 3

Please note that this process is applicable for Squiz Matrix versions 4.4.1 to 4.6.5 / 4.8.1 and assumes that the Phase 2 release of the Easy Edit Suite has been previously installed correctly and is in use.

When upgrading the Easy Edit Suite to any Phase 3 release (builds 1081 or higher):

  1. Replace the existing ees folder within the public data directory with the new ees folder from the appropriate compatible compressed package.
  2. On the Details screen of the Javascript API asset used by Easy Edit Suite:
    1. Enable the Use Enhanced JS API option.
    2. Enable the Allow Batching Requests option.
    3. Enable the Get Lineage function.
  3. In the Easy Edit Suite's configuration file:
    1. Replace the content of the existing configuration file with the template found at <easy_edit_system_root>/Examples/EasyEditConfigSample.js.
    2. Update the JS API -> key configuration option with the API Key of the Javascript API. This key is obtained on the details screen of your Easy Edit Suite Javascript API.
  4. On the Design asset used by the Easy Edit Suite:
    1. Edit the Parse File of the Design asset to include the EES Styles and Scripts nested Standard Page. The content of this Standard Page will contain the Easy Edit Suite code, along with any other custom CSS styles and JavaScript code.

      Please note that this step is optional.

      For more information, refer to the Installation Guide chapter in this manual.
    2. Locate and delete the eesSiteURL JavaScript variable. This variable has been replaced with a new configuration option in the Easy Edit Suites configuration file.
    3. Replace the string: 
      /__data/ees/Libs/jquery/jquery-1.4.2.min.js
      with the following:
      /__data/ees/Libs/jquery/jquery-1.6.2.min.js
    4. Add the following to the bottom of the existing jQuery plugins: 
      <script type="text/javascript" src="/__data/ees/Libs/jquery/jquery.ba-bbq.min.js"></script>
  5. Ensure users have cleared the their browser cache.

Upgrading to EES Phase 4 (Edit+ Compatible)

Please note that this process is applicable for Squiz Matrix versions 4.6.6+ / 4.8.2+ and assumes that the Phase 3 release of the Easy Edit Suite has been previously installed correctly and is in use.

When upgrading the Easy Edit Suite to any Phase 4 release (builds 1645 or higher):

  1. Replace the existing ees folder within the public data directory with the new ees folder from the appropriate compatible compressed package.
  2. On the Details screen of the Javascript API asset used by Easy Edit Suite enable all functions listed under 'Core', 'Linking', 'Permissions', 'Workflow', 'Traversing', and 'Metadata'.
  3. In the Easy Edit Suite's configuration file:
    1. Replace the content of the existing configuration file with the template found at <easy_edit_system_root>/Examples/EasyEditConfigSample.js .
    2. Update the JS API -> key configuration option with the API Key of the Javascript API. This key is obtained on the details screen of your Easy Edit Suite Javascript API.
  4. Follow the EES Installation Guide to ensure that Design file references to EES code are using latest exit design and nested page HTML templates.
  5. Ensure users have cleared the their browser cache.

PreviousNext