Technical documentation - Favourites function
- Mattias Löfstrand
- Ruud de Bruijckere
This article describes how to configure favourites preview.
This configuration is available in version 5.1 and later.
Overview
The Favourites function allows users to store favourites for quick access and to create lists which can be used for eg recurring orders. Favourites can be accessed on a presentation and in toolbar.
On the Favourites page it is possible to manage the lists and add parts to order.
Configuration
Favourites function is turned on in profile.config.
<!-- Save favourites in Signifikant server database -->
<FavouriteProvider>
<AssertFavouriteProvider/>
</FavouriteProvider>
<!-- Configure favourites function -->
<FavouriteManager>
<FavouriteManager presentation-identifier-selector="Identity">
<!-- Header image on favourites page -->
<HeaderImage>Download_header.jpg</HeaderImage>
<!-- Sharing favourite lists turned on or off, default is on. -->
<ShareFavouritesEnabled>false</ShareFavouritesEnabled>
<!-- If new lists will be shared by default or not. Default is shared (true). -->
<ShareOwnFavouritesByDefault>false</ShareOwnFavouritesByDefault>
<FavouriteCartSettings>
<Line>
<Presentation template="order-cart"/>
<Name tag="h4"/>
</Line>
</FavouriteCartSettings>
</FavouriteManager>
</FavouriteManager>Please note that the presentation is identified by the “Identity” in the configuration above. This means that presentations must have an identity to be visible in the Favourites list(s). You can also use “PersistentIdentity” as identifier.
Define where to show favourites in presentation settings.
<Presentation id="start" template="index" class="start view">
<!-- Display favourites in bodyfooter and place it in the group "history-favourite" as no 2 -->
<!-- This will make favourites display side by side with order history preview. -->
<FavouritesPreview display="bodyfooter" display-count="3" order="1000" group="history-favourite" group-order="2"/>
</Presentation>
Options | Usage | Values |
|---|---|---|
display-count | Max number of items to show | An integer |
group | If preview is to be placed in a group | A string |
group-order | Order within the group | An integer |
Setting in 5.3
In version 5.3, also check web config page for function Favourites.