Configuring the Online Store in Compliance with the Cookie Policy

Problem

How do I configure the Online Store in compliance with the GDPR Cookie Policy?

Solution

This topic describes your Online Store configuration in compliance with the European legislation in relation to cookies, if the GDPR application is enabled in your system: when a customer accesses the Online Store, the customer must be explicitly asked for permission to allow usage of cookies. Also, there must be a detailed description for each cookie in the Cookie Policy. Your Privacy Policy must state that a customer accepts the Cookie Policy by accepting your Privacy Policy.

Information about cookies is displayed on the Cookie Banner. Some functional cookies are required for the Online Store to work properly. Therefore, when a customer places an order, it means that the customer allows cookies even if they declined them on the Cookie Banner.

Note: If you add statistics or advertising cookies, you need to extend the solution with third-party services.

Online Store Templates

The table below represents the templates that are used to implement this solution:

Template Description
cookie_policy.tpl This template contains the Cookie Policy.
cookie_warning.tpl This template contains the Cookie Banner.
overall_wrapper.tpl This template is used to include the Cookie Banner.
overall_footer.tpl This template is used to include the Cookie Banner.
index.tpl This template includes the setting of the 'JSEnabled=true' cookie.
c2u_disabled_jscript.tpl This template includes the setting of the 'JSEnabled=true' cookie.
header_mainNav_struct.tpl This template includes the Cookie Policy menu element.
header_mainNav.tpl This template includes the Cookie Policy menu element.

For information on Online Store templates, refer to Online Store Layout Templates and Standard Layout Templates.

Note:
Add the Cookie Banner to the overall_wrapper.tpl or overall_footer.tpl template, depending on which template is used.

If the overall_wrapper.tpl or overall_footer.tpl template is customized, ensure that the code that calls cookie_warning.tpl is included in overall_wrapper.tpl or overall_footer.tpl.

If the Cookie Banner is not required or a third-party solution is implemented, including of cookie_warning.tpl to overall_wrapper.tpl or overall_footer.tpl template may not be required.

 

The following actions must be completed to customize the Online Store templates:

  • To customize the Cookie Banner text and button labels, update locale keys at Billing > Online Store > More > Languages and synchronize the Online Store after applying changes.
  • To customize the Cookie Banner layout, update the cookie_warning.tpl template at Billing > Online Store > Layout Templates and synchronize the Online Store after applying changes.
  • To customize the Cookie Policy text, update the cookie_policy.tpl template at Billing > Online Store > Layout Templates and synchronize the Online Store after applying changes.

Extending the Solution with Third-party Services

If you are going to use statistics or advertising cookies, you need to extend the current solution. For example, you can use a third-party library with the respective changes in the Online Store:

  • Statistics or advertising cookies must be controlled by the third-party library.
  • Cookies placed by the Online Store PHP code must be controlled by templatestore/src/Service/Session/Session.php.
  • Functional cookies must be checked by the isCookiesAllowed() method. Update this method according to the new names and values of cookies that allow or disallow placing these functional cookies.
  • Statistics cookies that can be placed by the back end must use the isStatisticsCookiesAllowed() method that actually calls the isCookiesAllowed() method. To separate functional and statistic cookies, change the isStatisticsCookiesAllowed() implementation accordingly.