The Cookie-Consent widget adds a floating dialog to the web site with configurable text which displays a disclaimer regarding cookie and privacy policies. The widget should be dropped on any page / template that should display the dialog. When a user visits the web site they will be prompted with the dialog, and upon accepting an entry is kept storing various information including IP, the date of consent, and the site name for which the consent was given. This feature relies on the DTS service to store the entries.
Note: An incremental or full publish is required in order for the widget to be styled properly on the live site. This publishes the necessary CSS and JavaScript files to the web site. In addition, the cookie-consent entries are saved every 5 minutes by default to improve performance. See the 'Configuration (DTS)' section for more information.
Widget Configuration Properties (Layout Tab)
Position of the dialog on the screen – Display the dialog on the top of the website or the bottom.
Text to use for privacy policy link text – If a privacy-policy page is selected under the Content tab properties for the widget, then the link text can be changed for this field.
Text to use for cookie policy link text – If a cookie-policy page is selected under the Content tab properties for the widget, then the link text can be changed for this field.
Text to use for 'aria-label' attribute. E.g 'cookie consent' – If present, an 'aria-label' attribute will be applied to the widget with the specified text.
Text to use for the 'role' attribute. E.g 'dialog' – If present, a 'role' attribute will be applied to the widget with the specified text.
Hide cookie consent dialog in preview mode – If selected, the dialog will not display in preview mode.
Widget Editor (Content Tab)
A default text is provided for the cookie-consent widget text area, however this can be configured.
___
Cookie Disclaimer (Required) - The text to be used as the disclaimer for the cookie-consent dialog on the site.
___
Privacy Policy Page (Optional) - Creates a link to a privacy policy page.
___
Cookie Policy Page (Optional) - Creates a link to a cookie policy page.
Cookie Consent Dashboard Gadget
The Cookie-Consent Dashboard gadget provides a way of viewing the total number of cookie consent entries per site. It also provides a way to export entries for all sites and for individual sites. This can be done
by clicking the 'Export All Cookie Consent Entries' button on the gadget. Once clicking on a site's entry, the entries can be exported for that specific site only.
In addition, consent entries can be removed for all sites by clicking the 'Advanced' button on the main window of the gadget.
Note: The Cookie Consent gadget is available for site administrators only.
Configuration (DTS)
The Cookie-Consent widget gets updated every 5 minutes as a default. The time delay is implemented for performance reasons to prevent a large amount of site traffic from overloading the widget. The time delay can be configured to run at desired increments:
- Navigate to <DTS_Root> --> Deployment --> Server --> conf --> perc
- Rename perc-metadata-services.properties.sample to perc-metadata-services.properties
The following property configures the delay when updating the widget. The time property is set in seconds.
Note: this time property is shared with the Most Read Blog Posts widget for performance reasons.
- blogpost.scheduler.interval: determines the time delay between updates / saves
The DTS will need to be restarted after making these updates.
Once configured, to verify the service is running, the following URL can be accessed:
http://your_site.com/perc-metadata-services/metadata/visits/status
If successful, the URL will return "Running," otherwise it will return an error page.