========================================
Release notes - eXo Platform ${org.exoplatform.platform.version}
========================================
 
 
Date: ${build.date}
Version: ${org.exoplatform.platform.version}
 
 
I.    MAIN CHANGES
II.   STARTUP INSTRUCTIONS
III.  UPGRADE NOTES
IV.  REMOVED APPS
V.   KNOWN ISSUES
 
 
 
================
I. MAIN CHANGES
================
 
 
Main changes since Platform 4.0.5:
* Bug fixes
* Localization of application name in Space menu
* Custom validator of page node name
* Performance improvement of Suggestion application
* Platform runs inside IFrame
* Upgrade Juzu to version 0.6.2
* New translations in 3 languages (Czech, Ukrainian, Lithuanian)
 
 
=========================
II. STARTUP INSTRUCTIONS
=========================
 
 
The file README.txt contains information on how to start the product.
 
 
===================
III. UPGRADE NOTES
===================
 
 
The upgrade procedure is only guaranteed and tested to be transparent from the previous maintenance version (x.y.z from x.y.z-1). So, we recommend to apply upgrade procedures for all versions between your current and the target one.
However, if you still insist on skipping versions, we strongly advise to read all upgrade notes of the versions you are skipping to see if your project is impacted by any previous upgrade procedure.
 
If you want to migrate to Platform 4.0.6 from Platform 3.5.x or previous versions, please contact eXo Support.


---------------------------------------------
Upgrading from Platform 4.0.5 to 4.0.6
---------------------------------------------
 
* Prepare bundle:
** If eXo Platform is connected to a populated organizational data source, Organization Integration Service must be activated so that the data are synchronized. Please refer to chapter 6 in Administrator Guide for the detail.
 
** The following upgrade plugin must be activated in the $PLATFORM-4.0-TOMCAT_HOME/gatein/conf/configuration.properties (Tomcat bundle) or $PLATFORM-4.0-JBOSS_HOME/standalone/configuration/gatein/configuration.properties (Jboss bundle) file:

# ECMS-6020: Update WCM Search Result template
# PLF-5806: Update AccessibleBanner template in WAI extension 
commons.upgrade.WCMTemplateUpgradePlugin.enable=true

# PLF-5834: Update dialog template of Announcement
commons.upgrade.NodeTypeTemplateUpgradePlugin.enable=true    

# PLF-5820: Update gadgets
commons.upgrade.Upgrade-Gadgets.enable=true

# Remove public read permission from ProductInfo node
commons.upgrade.UpgradeProductInfoNodePlugin.enable=true
 
# ECMS-4199: Update translation link for websites using Sample Accessible Website Template (a.k.a WAI)
# only necessary when *WAI extension* was installed in the old server
commons.upgrade.WaiportalTranslationsUpgradePlugin.enable=true

* Start server. The upgrade will be run automatically
* Stop server and deactivate the above upgrade configurations:
 
commons.upgrade.WCMTemplateUpgradePlugin.enable=false
commons.upgrade.NodeTypeTemplateUpgradePlugin.enable=false
commons.upgrade.Upgrade-Gadgets.enable=false
commons.upgrade.UpgradeProductInfoNodePlugin.enable=false
commons.upgrade.WaiportalTranslationsUpgradePlugin.enable=false

* Restart the server. The upgrade process is done.

Description of new upgrade plugin
***********************************
* WaiportalTranslationsUpgradePlugin: This plugin is introduced by ECMS-4199 to update the translation links on sites using Sample Accessible Website Template (a.k.a WAI).
* UpgradeProductInfoNodePlugin: This plugin is to remove public access to the node containing product information.


---------------------------------------------
Upgrading from Platform 4.0.4 to 4.0.5
---------------------------------------------
 
* Prepare bundle:
** If eXo Platform is connected to a populated organizational data source, Organization Integration Service must be activated so that the data are synchronized. Please refer to chapter 6 in Administrator Guide for the detail.
 
** The following upgrade plugin must be activated in the $PLATFORM-4.0-TOMCAT_HOME/gatein/conf/configuration.properties (Tomcat bundle) or $PLATFORM-4.0-JBOSS_HOME/standalone/configuration/gatein/configuration.properties (Jboss bundle) file:
 
# ECMS-5800: Change the properties exo:script and exo:scriptLabel in built-in ECMS action node types
commons.upgrade.ActionTypeUpgradePlugin.enable=true
 
# ECMS-5778: Update ECM Action Scripts
commons.upgrade.ScriptUpgradePlugin.enable=true
 
# ECMS-5812, ECMS-5934, ECMS-5994
commons.upgrade.SiteExplorerTemplateUpgradePlugin.enable=true
commons.upgrade.WCMTemplateUpgradePlugin.enable=true
 
# ECMS-5779: Upgrade templates to view/edit metadata
commons.upgrade.MetadataTemplateUpgradePlugin.enable=true
# comment the following line with data created from Platform 4.0.
unchanged-metadata-templates=rma:transferable, rma:accessionable, rma:vitalRecord, rma:cutoffable, rma:holdable, rma:record, rma:destroyable
 
# WIKI-706: Remove Wiki Sandbox pages (*only necessary* for the data created from Platform 3.5)
commons.upgrade.RemoveSandboxPageUpgradePlugin.enable=true
 
# PLF-5650: Remove public read permission from exo:LoginHistoryHome node
commons.upgrade.UpgradeExoLoginHistoryHome.enable=true
 
* Start server. The upgrade will be run automatically
* Stop server and deactivate the above upgrade configurations:
 
commons.upgrade.ActionTypeUpgradePlugin.enable=false
commons.upgrade.ScriptUpgradePlugin.enable=false
commons.upgrade.SiteExplorerTemplateUpgradePlugin.enable=false
commons.upgrade.WCMTemplateUpgradePlugin.enable=false
commons.upgrade.MetadataTemplateUpgradePlugin.enable=false
#unchanged-metadata-templates=rma:transferable, rma:accessionable, rma:vitalRecord, rma:cutoffable, rma:holdable, rma:record, rma:destroyable
commons.upgrade.RemoveSandboxPageUpgradePlugin.enable=false
commons.upgrade.UpgradeExoLoginHistoryHome.enable=false
 
* Restart the server. The upgrade process is done.
 
Description of Plugins introduced in Platform 4.0.5
*****************************************************
* ActionTypeUpgradePlugin: This plugin is introduced by ECMS-5800 to change the properties exo:script and exo:scriptLabel in built-in ECMS action node types. It allows user to change the values of these properties.
* MetadataTemplateUpgradePlugin: This plugin is introduced by ECMS-5779 to update the templates to view/edit metadata.
* RemoveSandboxPageUpgradePlugin: This plugin is introduced by WIKI-706. It deletes all Wiki Sandbox pages generated in Platform 3.5.
* UpgradeExoLoginHistoryHome: This plugin is introduced by PLF-5650 to remove public read permission from exo:LoginHistoryHome node.
 

---------------------------------------------------------
Upgrading from Platform 4.0.3 to 4.0.4
---------------------------------------------------------
 
* Prepare bundle:
** If eXo Platform is connected to a populated organizational data source, Organization Integration Service must be activated so that the data are synchronized. Please refer to chapter 6 in Administrator Guide for the detail.

** The following upgrade plugin must be activated in the $PLATFORM-4.0-TOMCAT_HOME/gatein/conf/configuration.properties (Tomcat bundle) or $PLATFORM-4.0-JBOSS_HOME/standalone/configuration/gatein/configuration.properties (Jboss bundle) file:
 
# ECMS-5635
commons.upgrade.SiteExplorerTemplateUpgradePlugin.enable=true
# PLF-5104 (only if acme extension is deployed)
commons.upgrade.NodeTypeTemplateUpgradePlugin.enable=true

** Remove the index folder for collaboration workspace (which is located at data/jcr/index/collaboration_portal). This step is mandatory because of the new indexing configuration for ECMS and WIKI contents.
   Indexing might take time and memory depending on your data size.
   In case of huge data, you need to either (1) increase heap size (-Xmx in JAVA_OPTS) or (2) reduce JCR Jboss cache size (gatein.jcr.cache.size inside configuration.properties) so that the indexing can finish without Out of Memory error.
* Start server. The upgrade and re-indexation will be run automatically.  
* Stop server.
** Deactivate the above upgrade configuration:
   commons.upgrade.SiteExplorerTemplateUpgradePlugin.enable=false
   commons.upgrade.NodeTypeTemplateUpgradePlugin.enable=false
** Reset the value of heap size or JCR Jboss cache size if you changed them for indexing purpose.
* Restart the server. The upgrade process is done.

 
---------------------------------------------------------
Upgrading from Platform 4.0.2 to 4.0.3
---------------------------------------------------------
 
* Prepare bundle:
If eXo Platform is connected to a populated organizational data source, Organization Integration Service must be activated so that the data are synchronized. Please refer to chapter 6 in Administrator Guide for the detail.
 
Before the first startup, the following upgrade plugins must be activated in the $PLATFORM-4.0-TOMCAT_HOME/gatein/conf/configuration.properties (Tomcat bundle) or $PLATFORM-4.0-JBOSS_HOME/standalone/configuration/gatein/configuration.properties (Jboss bundle) file:
 
# ECMS-5428
commons.upgrade.ActivitiesUpgradePlugin.enable=true
# PLF-5398
commons.upgrade.WCMTemplateUpgradePlugin.enable=true
# FORUM-576 (only if there are spaces created on Platform 3.5)
commons.upgrade.ForumServiceUpdaterPlugin.enable=true
 
* Start server. The upgrade will be run automatically
* Stop server and deactivate the above upgrade configurations:
 
commons.upgrade.ActivitiesUpgradePlugin.enable=false
commons.upgrade.WCMTemplateUpgradePlugin.enable=false
commons.upgrade.ForumServiceUpdaterPlugin.enable=false
 
* Restart the server. The upgrade process is done.
 

 
Description of Plugins introduced in Platform 4.0.3
*****************************************************
* ForumServiceUpdaterPlugin: This plugin is introduced by FORUM-576 to add mixin mix:forumCategory and set the property exo:includedSpace for spaces created in PLF 3.5. This allows user to select the expected Forum when creating a Topic or a Poll from Quick Creation Menu.
 
 
---------------------------------------------------------
Upgrading from Platform 4.0.1 to 4.0.2
---------------------------------------------------------
 
* Prepare bundle:
If eXo Platform is connected to a populated organizational data source, Organization Integration Service must be activated so that the data are synchronized. Please refer to chapter 6 in Administrator Guide for the detail.
 
Before the first startup, the following upgrade plugins must be activated in the $PLATFORM-4.0-TOMCAT_HOME/gatein/conf/configuration.properties (Tomcat bundle) or $PLATFORM-4.0-JBOSS_HOME/standalone/configuration/gatein/configuration.properties (Jboss bundle) file:
 
# ECMS-5391
commons.upgrade.SiteExplorerTemplateUpgradePlugin.enable=true
# ECMS-5456
commons.upgrade.WCMTemplateUpgradePlugin.enable=true
# ECMS-5358
commons.upgrade.WebcontentChildUpgradePlugin.enable=true
# SOC-3430
commons.upgrade.ModelOverriderUpdaterPlugin.enable=true
commons.upgrade.UserActivityStreamUpdaterPlugin.enable=true
commons.upgrade.SpaceActivityStreamUpdaterPlugin.enable=true
 
* Start server. The upgrade will be run automatically
* Stop server and deactivate the above upgrade configurations:
 
commons.upgrade.SiteExplorerTemplateUpgradePlugin.enable=false
commons.upgrade.WCMTemplateUpgradePlugin.enable=false
commons.upgrade.WebcontentChildUpgradePlugin.enable=false
commons.upgrade.ModelOverriderUpdaterPlugin.enable=false
commons.upgrade.UserActivityStreamUpdaterPlugin.enable=false
commons.upgrade.SpaceActivityStreamUpdaterPlugin.enable=false
 
* Restart the server. The upgrade process is done.
 
 
Description of Plugins introduced in Platform 4.0.2
*****************************************************
* WebcontentChildUpgradePlugin: This plugin is introduced by ECMS-5358 to add mixin exo:webContentChild to children of exo:webcontent. This allows to improve the speed of document search.
* UserActivityStreamUpdaterPlugin, SpaceActivityStreamUpdaterPlugin: These plugins are introduced by SOC-3430 to upgrade legacy Activities to the new data structure
 
 
---------------------------------------------------------
Upgrading from Platform 4.0.0 to 4.0.1
---------------------------------------------------------
 
 
* Prepare bundle:
If eXo Platform is connected to a populated organizational data source, Organization Integration Service must be activated so that the data are synchronized. Please refer to chapter 6 in Administrator Guide for the detail.
 
Before the first startup, the following code must be added into the $PLATFORM-4.0-TOMCAT_HOME/gatein/conf/configuration.properties (Tomcat bundle) or $PLATFORM-4.0-JBOSS_HOME/standalone/configuration/gatein/configuration.properties (Jboss bundle) file:
 
commons.upgrade.Upgrade-PortalData.enable=true
 
* Start server. The upgrade will be run automatically
* Stop server and deactivate the above upgrade configuration:
 commons.upgrade.Upgrade-PortalData.enable=false
 
* Restart the server. The upgrade process is done.
 
 
 
=================
IV. REMOVED APPS
=================
 
 
The following apps were deprecated (*) in Platform 3.5 and have been removed in Platform 4.0.0:
 
* PCV / PCLV
* Category Navigation
* Form Builder
* Newsletter / Newsletter Manager
* Workflow Controller / Workflow Administration
* RSS Reader
* Mail / Address Book
* Chat / Chat Bar
 
For alternatives, check the free add-ons available on eXo Add-ons : https://github.com/exo-addons
 
(*) Deprecation means that  no enhancements are planned and the app is usually removed in the next GA version.  
eXo will continue to support the app for customers running the product version where it was deprecated. For existing customers that use a deprecated app willing to upgrade to a version where it is removed, eXo may offer on a case by case basis an extra maintenance contract if requested.
 
 
 
=================
V.  KNOWN ISSUES
=================
* PLF-5000 Exception when start Platform on Vista
* FORUM-560 [IE10] FCKEditor's actions do not work
* FORUM-754 [IE11] FCKEditor doesn't appear

