v1.3.0 Cookie Notice (MndCookieNotice) - EN

DateChanges made
15.06.2018

Documentation Update version 1.2.0

  • new: opt-in/opt-out feature for google analytics and facebook pixel
  • new: privacy-settings for visitors with opt-in/opt-out functionality
  • new: provided opt-out html link for integration in privacy policy
19.06.2018

Documentation Update version 1.3.0

  • 2 different display options for cookie notice
  • new config option "version" - increase this number to force display of notice to users




Note: this software is provided "as is" without any legal gurantee. We are not liable for any legal conformity. Please consult legal support to confirm correct usage for your application scenario.

Description

Cookie notice

This Shopware Plugin can provide a notice to shop visitors about the usage of cookies (e.g. GDPR or privacy compliance, etc.). It provides also privacy-settings for visitors, so they can manually opt-in or opt-out of Google Analytics and Facebook Pixel (only in combination with our Plugin "Facebook Pixel for Shopware", version 1.1.3 +). Texts, colors and positioning of the cookie notice can easily configured in the plugin settings.

Privacy settings

Since version 1.2.0 you can enable the privacy-settings dialog. It enables visitors to anonymously configure their opt-in / opt-out preferences. Via the plugin configuration you can define the default behavior of the trackings. Opt-In tracking is disabled for new visitors per default. Opt-Out: tracking is enabled for new visitors per default.

The Google Analytics opt-out feature should be work with any Google Analytics integration. Please test the function for your implementation, though.

Currently, pirvacy settings of Facebook Pixel works only with our Shopware Plugin "Facebook Pixel for Shopware" (available at Shopware Plugin-Store). The feature is enabled if you configure the Facebook Pixel plugin accordingly.

The plugin now provides a javacript function for opt-out of Google Analytics which you can call in e.g. a html link anywhere on the shop site. E.g. you can add a link in your privacy policy to directly opt-out.

Our Plugin "Facebook Pixel for Shopware" provides a similar feature for the Facebook Pixel Tracking.


Screenshots

  • Cookie Notice (choose if top or down):


template 1: text, links and button middle

template 2: text and links left, button right


  • Screenshots of privacy settings in shop frontend:

example 1: Google Analytics is activated by default, the can deactivate the tracking with a button click.


example 2: user has deactivated the Google Analytics Tracking for his browser.

 


Learn more about this feature in the Chapter for privacy settings.


General Features

  • display regarding cookie usage
    • 2 different layouts
  • several cofigurations
    • Display: notice yes/no
    • Position: top/bottom
    • Fixed: yes/no
    • Text size
    • Background and text color
    • Background transparency
    • Background and text color button
    • Padding
    • Cookie expiration
    • Möglichkeit den Hinweis über die Auswahl "Version" erneut anzeigen zu lassen.
    • Sub-Shop compatible
    • multilingualism (snippets)11
    • Link to privacy statement
      • Display link yes/no
      • Link
      • Link text
      • Link color
  • privacy settings
    • input possibility for Google Analytics UA ID (also more then one, divided through "comma") 
    • display Google Analytics Opt-In/Opt-Out function
      • Google Analytics Opt-In: activate or deactivate Tracking by default
    • display Facebook-Pixel (in combination with Plugin "Facebook Pixel for Shopware")
  • Execute custom javascript code with button click

Installation


Installation at shop

Just install with the plugin manager and customize the configuration options for your needs.

Make sure you clear the Shopware Cache (Frontend and HTTP-Proxy) after the installation.


More information about the plugin installation process in Shopware:

Plugin-Installation: http://en.community.shopware.com/_detail_1638.html?_ga=1.130307917.395169831.1467200155
Plugin-Manager: http://en.community.shopware.com/_detail_1858.html?_ga=1.130307917.395169831.1467200155


Plugin configuration


To enable the Google Analytics Opt-In/Opt-Out features, you need to add your Analytics Property ID (UA-XXXXXX-XX) in the plugin configuration. You can add multiple IDs by separating them with comma.


Config Option "Notice-Version"

By increasing the config option "notice version" you can force the disply of the notice to your visitors. The accepted version is part of the accept-cookie of the visitor. If the display has a higher version than the user, the notice is displayed to the visitor.

Privacy Settings

When activating the setting "Link to privacy statement", the link to open the privacy settings will be appended to the cookie notice text for visitors.


You can add a link to open the privacy settings for the visitors anywhere in the shop content by adding a link, like so:

<a href="javascript:mndCookieNotice.mndOpenPrivacySettings();">Privatsphäre-Einstellungen</a>


display frontend/backend: 
  • possibility 1: Google Analytics is activated, the user has the chance to deactivate the tracking.

    


  • possibility 2: Changing the settings at backend to Opt-In function, the user have to activate the tracking.

       



Integration links for Google Analytics Opt-In/Opt-Out, for example in your privacy police:

<a href="javascript:mndCookieNotice.mndGAOptOut();“ onclick=„alert('Google Analytics deaktiviert.');“>Google Analytics deaktivieren</a>

<a href="javascript:mndCookieNotice.mndGAOptIn();“ onclick=„alert('Google Analytics aktiviert.');“>Google Analytics aktivieren</a>


Execute additional Javascript-Code

You can enter custom javascript-code in the plugin settings an enabl. This code is run when the user clicks on the 'accept' button (or whatever you label it). Make sure you test your code before you enable this feature.


We recommend placing only dedicated function calls in this field. Complex javascript code is best provided via an javascript include in the template and called via this field. This makes debugging far more easier.

e.g.


functionCall1();
functionCall2();
functionCall3();



Text configuration

In order to change the text of notice and button please navigate to the snippet management at Configuration → Snippets.
Search for "MndCookie" and you'll find the relevant snippets:

Select the snippet you want to change and click on the button "Edit selected snippets" from the menu above. You can also use HTML for advanced formatting.


Please note that you'll probably need to clear the Shopware cache again and eventualy the template have to be new compilated, in order to see the changes in the frontend.


Placed Cookies

Cookie nameZweckKommentar
​mnd-ga-opted-inGoogle Analytics Opt-In​valid for 100 years
ga-disable-UA-XXXXXXX-XXGoogle Analytics Opt-Outvalid for 100 years.
Will be stored for each Google Analtyics Property ID configured.


You can find more information about our plugin "Facebook Pixel for Shopware" on its documentation page here: v1.x.x Facebook Pixel (MndFacebookPixel) -EN

Integration into the privacy settings is provided from version 1.1.3


Deinstallation

Uninstall via the plugin manager.

Set cookies won't be removed from the users browser.