Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.
This page explains how you can use the Magnolia GDPR features to manage your cookies on your website.
Under GDPR, you must inform visitors that your website is using cookies, and, if your cookies store personal data, ask visitors to consent to their data being collected.
This is an overview of how to handle cookies:
- Let the website visitor know that your website is using cookies.
- Ask the website visitor to grant permission for the cookies to be used and store the website visitor's decision. The website visitor can accept or reject cookies. See managing consent for cookies.
- Configure your cookies in the Cookies app according to your cookie consent decision strategy.
- Before setting a cookie, Magnolia checks the Cookies app for the value of the cookie consent decision and the configuration of the cookie to decide if the cookie may be set. See Understanding whether a cookie is set or not.
- We recommend you inform your website visitors about what cookies you are using and about the purpose of the used cookies.
Magnolia helps you to implement cookies in compliance with GDPR. It nonetheless remains the responsibility of the website owner to manage cookies properly. Features explained on this page are provided by the Magnolia Privacy module.
Inform the website visitor
You must inform website visitors that you are using cookies.
Types of cookie in Magnolia
Cookies set on the server-side
To set a cookie on the server-side, Magnolia uses the CookieManager, which always checks the website visitor's cookie consent decision before the cookie is set.
Cookies set on the client-side - Marketing tags
By using the Marketing Tags app to manage the code snippets for these third-party services and defining a cookie in the Cookies app and linking it to the marketing tags item, you control whether the third-party cookie is set based on the website visitor's cookie consent decision.
Managing consent for cookies
When using the Magnolia GDPR cookie features, Magnolia cookies and even third-party cookies managed via Marketing Tags app are never set unless the website visitor has given their consent.
Visitor consent for cookie usage must therefore be collected and stored. In Magnolia, the consent itself is stored in a cookie named
The stored value, if there is one, is used to decide whether other cookies are set or not.
Variations of the cookie consent interaction
The simplest cookie consent interaction strategy is to offers visitors the choice between accepting or rejecting cookies. More complex strategies can be implemented depending on your requirements.
Basic "accept or reject" consent
In this strategy, you inform visitors that cookies exist on your website and ask them to accept.
In this case, you store a simple value such as
OK as value of the cookie.
Consent for different groups of cookies
In this strategy, you give the website visitor the possibility to give consent for different groups of cookies:
In this case, you store cookie values such as the following based on which options the user consent to:
You can set the
Alternatively you also can use the Magnolia CookieManager to add the cookie on the server side.
For more information, see GDPR API - Managing cookies.
Configuring cookies to set cookies depending on visitor consent
The Privacy module comes with the Cookies app. Make sure you add a cookie definition for all your cookies.
Configuring a cookie
Go to Tools > Cookies. To add a new cookie, click Add cookie. New nodes can only be added to the root node (no nested cookies). The properties
id (cookie's unique ID) and
cookieName (cookie's name as seen in the browser) are mandatory.
Go to Tools > Cookies.
To add a new cookie, click Add cookie. New nodes can only be added to the root node (no nested cookies). The properties
You must set the properties
cookieName which are mandatory.
You may want to set a specific value for the
requiredConsentRegexp property. The value of the
requiredConsentRegexp property is interpreted as a regular expression. The default value is
See Cookie properties for all possible properties.
Understanding when cookies are set
Every cookie definition has the
requiredConsentRegexp property. If this property is not set explicitly, its default value
.+ is used.
The value of the
requiredConsentRegexp is interpreted as a regular expression.
Cookies are set when the regular expression matches the value stored in the
If you use the default value
.+ for the
requiredConsentRegexp property in a cookie definition, the cookie will be added by the cookie manager if the
cookieConsent_status cookie has any value.
If you use
.* as value for the
requiredConsentRegexp property in a cookie definition, the cookie will always be added by the cookie manager - even if the
cookieConsent_status cookie is not set.
|Cookie is set|
*) Remember that no value defaults to
Example: Configuring a server-side set cookie
Add a cookie definition to the Cookies app.
Example: Adding a marketing tag cookie and linking it to the Marketing Tags app
You usually set third-party cookies using a code snippet managed in the Marketing Tags app. To control whether this kind of cookie is set, you must add a cookie definition to the Cookies app and link it to the marketing tag.
If you do not link a cookie definition to a marketing tag, the marketing tag is always set following the marketing tag definition only without checking cookie consent.
Marketing tag cookie definition
name of the cookie definition are arbitrary and do not have to match the name of the cookie which is set by the marketing tag, just make sure the node name is descriptive and unique.
Linking a cookie to a marketing tag
- Go to Tools > Marketing Tags. Choose the marketing tag you want to link to a cookie:
- Edit the marketing tag. Go to the Cookies tab and click add:
- Select the cookie and click Save.