Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
     Glossary
   eZ Publish 4.x / legacy

 
eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
November
FIXME
12th 2015

eZ announces the availability of 5.4.5, a maintenance release available for all users of eZ Publish Platform 5.4.

Info
titleInstalling the RC

To be able to get access to the beta you will have to change stability flag on affected/added packages (Solr and Recommendation are optional new packages, ezfind depends if you're using it):

Code Block
composer require --no-update "ezsystems/ezpublish-kernel:5.4.5-rc1 as 5.4.5"
composer require --no-update "ezsystems/ezpublish-legacy:5.4.5-rc1 as 5.4.5"
composer require --no-update "ezsystems/ezflow-ls-extension:5.3.8-rc1 as 5.3.8"
 
# optional
composer require --no-update "ezsystems/ezfind-ls:5.4.5-rc1 as 5.4.5"
composer require --no-update "ezsystems/ezplatform-solr-search-engine:~1.0.0@rc"
composer require --no-update "ezsystems/recommendation-bundle:~1.0.0@beta"
After this has been done follow

 In addition to 18 bug fixes, it adds two packages that are part of the upcoming eZ Platform release: Solr as a repository search engine, and a revamped Recommendation engine integration.

Follow the 5.4.x Update Instructions to apply this update to your platforms

, including the following items:
  • edit ezpublish/EzPublishKernel.php, and add eZ\Bundle\EzPublishLegacySearchEngineBundle\EzPublishLegacySearchEngineBundle to the list of enabled bundles, right before EzPublishLegacyBundle.
  • if you have installed ezsystems/ezplatform-solr-search-engine, add EzSystems\EzPlatformSolrSearchEngineBundle\EzSystemsEzPlatformSolrSearchEngineBundle at the end of the $bundles array in the registerBundles() method.
  • if you have installed ezsystems/recommendation-bundle, add EzSystems\RecommendationBundle\EzSystemsRecommendationBundle at the end of the $bundles array in the registerBundles() method.
    Warning

    Every package manually updated in the root composer.json must be added the update line specified in the 5.4.x update instructions. Add ezsystems/ezflow-ls-extension to the line. If the optional packages must be installed, add them as well: ezsystems/ezplatform-solr-search-engine recommendation-bundle ezsystems/ezfind-ls.

    If they are omitted, composer will fail with a dependencies error.

     

    After executing `composer update`, further actions are needed for Solr Search Engine Bundle, and Recommendation Bundle in order to correctly install them.

     

    .

     

    Note
    titleBackwards compatible break

    As part of eZ Platform forward compatibility efforts done on 5.4 during 2015, this release backported an API BC break on eZ\Publish\API\Repository\Values\Content\Query->limit property where default value is changed from undefined (unlimited) to 25, to fix unpredictable search results with Solr (and Elastic Search). Make sure to check your Content and Location queries to specify a limit when you expect more than 25 items to get consistent behavior across versions.

    As usual this is documented in doc/bc folder, in this case in kernel package: vendor/ezsystems/ezpublish-kernel/doc/bc/changes-5.4.md

     

    Highlights: New Features

    This maintenance release introduces two a new eZ Platform features to 5.4.x: Solr Search Engine Bundle and Recommendations Bundle, besides package: support for Solr as a Repository search engine. Besides this there are several maintenance issues fixed as listed below both coming from support issues and pull requests from community.

    $bundles

    Improved Search engine powered by Solr

     

    New in 5.4.5, and part of the upcoming eZ Platform release this fall, is support for running API Search queries (Content, ContentInfo and Location) on top of Solr instead of SQL based search engine (specifically "Legacy" search /storage engine). As Search is essentially powering all Search and Querying ("fetch") operations in Platform stack (aka 5.x/Symfony stack), this specifically means you can expect much more stable performance from your searches and your system*, and much better possibility to scale out for your search query needs using Solr SolrCloud.

     

    '* See 5.x Architecture diagram for further information about how persistence load operations are cached by Persistence Cache, and Search queries now are delegated to Solr, meaning database is less affected by system load to mainly deal with content updates.


    Further reading: Installation documentation for Solr Search Engine Bundle, developer info and source code in our Solr Search Engine Bundle ezplatform-solr-search-engine repository, and further resources on Apache Solr .

    Improved Recommendations integration

    A new Recommendation Bundle has been made, completely changing how the service is done. Recommendations are now served directly from the Recommendations service, avoiding cache and load problems on your server that was a problem with the previous ezreco extension. Tracking has similarly been improved to track directly to Recommendations service, and aligns with how tracking is done with other solutions like Google Analytics.

    This first iteration of Recommendation Bundle focuses on personal content recommendations with tracking of user traffic, tracking of user actions like shopping behaviour is possible using our Recommendations Service API.

    Limitation: Recommendation Bundle currently requires Symfony 2.6 or greater so is limited to eZ Publish Platform 5.4.3+ and eZ Platform/Studio 15.07+. We plan to reduce this requirement to Symfony 2.3 so the bundle can be used with any version of eZ Publish Platform 5.1+.

    Further reading: Documentation on our Recommendation Service, developer documentation and source code in our Recommendation Bundle repository.

    Image Removed

     

    Package Details

    Resolving known configuration issues

    Known for both Solr and Recommendation:

    If you still have problems, pop into our Slack channel at https://ezcommunity.slack.com/messages/ezplatform-use/ to discuss.

    Anchor
    packages
    packages
    Package updates

    Here are the ezsystems packages that have received an update as part of this release:

    packageversionprior version
    ezsystems/ezpublish-kernel5.4.5 5.4.4.3
    ezsystems/ezpublish-legacy5.4.55.4.4
    ezsystems/ezplatformezflow-solrls-search-engineextension15.03.0
    Status
    subtletrue
    colourGreen
    titleNew
    ezsystems/recommendation-bundle85.3.7
    ezsystems/ezplatform-solr-search-engine1.0.0
    Status
    subtletrue
    colourGreen
    titleNew

    Anchor
    updates
    updates
    Updates and fixes in this release

    JIRA
    servereZ Systems JIRA tracker
    columnskey,summary,type,created,updated
    maximumIssues1000
    jqlQueryproject=EZP AND fixVersion in ( "5.4.5" ) ORDER BY issuetype DESC, key ASC
    serverId841cf523-cc54-30bc-bc5d-89e63192498a