Need help in using our Plugin?
Thank you for purchasing Ultimate General Data Protection Regulation (Ultimate GDPR) Plugin! We’re very pleased that you have chosen our plugin to extend your website. We’re doing our best not to disappoint you! Before you get started, please check out these documentation pages.
All of our items comes with free support. Free support is limited to questions regarding the plugin features or problems. We provide premium support for code customisation or third-party plugins.
Note
Our support hours: 10:00 AM – 6:00 PM UTC +1 on Monday to Friday.
For issues and concerns, you can reach us through these support methods:
E-mail – support@createit.pl
Help Desk – Click here to go to our support website. Just click on the Submit Ticket button and follow instructions to create a ticket.
Forum – Comment/Post on the product you have issues/queries in ThemeForest or CodeCanyon websites.
Before You Post in a Forum
We urge you to follow the steps below, before you post a new topic on the forum, to speed up your request. It’s in everyone’s interest and will benefit in making the entire forum more efficient:
- Step 1 – Always check the Documentation and the Knowledgebase Section. Most questions are already answered in those areas.
- Step 2 – If your question hasn’t been brought up on the forum, please post a new topic. Always be as specific as possible. Creating a topic requires entering the live URL to your home page or page that shows the issue in question. It also has bars for WP and FTP login info, which aren’t required, however, providing us with your login information can save a lot of time for both of us. Login credentials are securely stored and accessible only by our support staff.
- Step 3 – We usually answer questions in 24 hours on working days. However, if you don’t get any answer within 72 hours bump up your question or send us an e-mail.
For all support methods, you will receive confirmations and replies on your queries through e-mail or by tracking your ticket which you will also get through e-mail. To track your ticket, please click here.
Once we reply to your query, each ticket will be open for 7 days without a reply from you. On the 6th day without a reply, an e-mail will be sent to notify you of the ticket’s inactivity. To make the ticket active again, you simply need to reply or follow the steps in the e-mail. If you won’t make the ticket active within 7 days, on the 8th day the ticket will automatically be closed.
In the plugin package you can find 3 main files:
- ct-ultimate-gdpr.css
- ct-ultimate-gdpr.js
- init.js
From version 1.5 of the plugin, the package contains also 14 different language versions of the init.js files which can be used instead of the default version of the file.
- init_CZ.js
- init_DE.js
- init_ES.js
- init_FR.js
- init_HR.js
- init_HU.js
- init_IT.js
- init_NL.js
- init_NO.js
- init_PL.js
- init_PT.js
- init_RO.js
- init_RU.js
- init_SK.js
For installing your GDPR plugin:
Copy the ct-ultimate-gdpr.css file from Demo>assets>css of the package and paste it on the assets > css folder of your site.
After that, Copy ct-utimate-gdpr.js and init.js file from Demo>assets>js of the package and paste it on the assets > js folder of your site.
It should look like this:
To activate plugin on the page, you must attach ct-ultimate-gdpr.css, ct-ultimate-gdpr.js and init.js files. Other dependencies (style files too) files are attached by plugin.
Once you have copied the 3 files, open the HTML file of your site. (Open the HTML file with a compiler)
In the HTML file, add these lines at the first files just after <head> tag.
<script type="text/javascript" src="assets/js/ct-ultimate-gdpr.js"></script>
<script type="text/javascript" src="assets/js/init.js"></script>
<link href="assets/css/jquery-ui.min.css">
It should look like this:
In init file, you are initializing plugin and where you can change plugin options.
When plugin is added to the page, it starts to block all cookies until user accepts cookies. Group cookies from the group chosen will be accepted, all other cookies will be blocked.
Cookies Management have 2 modes to choose from: Simple Mode or Group Mode
- Simple Mode - In this mode, all cookies are allowed after cookies consent is accepted.
- Group Mode - In this mode, there are configurable groups of cookies that the admin can set what cookies are in the group. The site users can choose which group of cookies he wants to allow to gather data.
Popup Style - To change how the popup is styled, you can change it in: _dev > assets > js > init.js
Box Skin - To change skin of the popup, you can change it in: _dev > assets > js > init.js
Gear Icon - To change the color and position of the gear icon, you can change it in: _dev > assets > js > init.js
- cookies_groups_design - Here you can select skin for cookies group select.
- assets_path - With this option you can define absolute path to assets.
parent_container - append this plugin to this parent container element.
always_show - When this option is set to ‘true’, the popup will always show even when consent is given.
gear_display - When this option is set to ‘true’, this option will show the gear icon for the cookie settings.
popup_text - Text description inside the popup.
popup_title - Title for popup.
accept_button_text - Text for the accept button.
read_button_text - Text for the read more button.
read_more_link - URL for where link redirects to.
advenced_button_text - Text for the cookie settings button.
grouped_popup - When this option is set to ‘true’, Group Mode is activated.
default_group - This will be the default active group selected when the cookie consent is given.
content_before_slider - Text at the top of the cookie settings. HTML is allowed.
accepted_text - Text for the title of the cookie descriptions in the left side of the cookie settings.
declined_text - Text for the title of the cookie descriptions in the right side of the cookie settings.
save_btn - Text inside the button to save/close the cookie settings.
prevent_cookies_on_document_write - Prevent cookies on document write when there is no agreement for cookies.
check_country - Check if the IP of the user is from EU countries and only show the cookie consent in these countries.
cookies_expire_time - Set number of days cookie is saved. 0 if you want cookies destroyed when browser is closed, or unlimited for forever.
cookies_path - Set custom path. / for global, your_path for custom path, or current for current path.
countries_prefixes - Abbreviation of the EU countries that the cookie consent is shown.
reset_link_selector -
Note
Whitelist cookies are cookies that are allowed even if you choose to Block all cookies in the site.
|
first_party_cookies_whitelist - List of first party cookies that will be allowed.
First party cookies are cookies generated by your site.
third_party_cookies_whitelist - List of third party cookies that will be allowed.
Third party cookies generated from the third party’s site is allowed despite the group choice.
To add the third party cookies in the whitelist, add the sites script.
Example:
third_party_cookies_whitelist: ['https://maps.googleapis.com*','https://www.youtube.com'],Example for Invisible recaptcha:
third_party_cookies_whitelist: ['https://www.google.com/recaptcha*','https://www.gstatic.com/recaptcha*'],
name - Name for the group.
enable - Set to true/false, disable/enable this group.
icon - Class for icon from font awesome collection.
list - Array list of text for the options for this group.
blocked_url - Array of scripts’ URLs for the cookies that you want to unblock. It’s for 3rd party cookies, this is an array with list of scripts links. When user accept for this group, all cookies created with scripts from this list will be created.
Note
Sample format on adding the scripts:
local_cookies_names - Array of local cookies names to be unblocked. It’s for 1st party cookies ONLY but it works similarly as url list. When user will choose this group cookies from this list will be allowed on the site.
Note
Cookies must be added to groups to be able to accept and allow cookies. The cookie groups uses a slider to choose which group/s you would like to allow in the site. The cookies in the group that is in the slider’s border are allowed in the site.
|
An example is Google Analytics Tracking in group 3:
When the user wants to allow Google Analytics Tracking, user should choose the 3rd group or above for it to be allowed.
- check_country - Set to true/false, to activate/deactivate the geolocation of the plugin.
- countries_prefixes - The array for the countries that the plugin is set to work.
Note
If Geolocation is activated, the plugin will only work for people that are connecting from the countries that are set in the array.
|
prevent_forms_send - When this option is set to ‘true’, forms will get a checkbox with information that need to be checked before it can send the form.
prevent_forms_text - Text that will be written beside the checkbox.
prevent_forms_exclude - Array of classes and id, Forms that are added in the array are excluded to have this checkbox.
on - Set to true/false, to activate/deactivate the cookie config.
parametr - The parameter to add in the URL to access cookie config modal.
- dependencies - Array of dependencies that will be included on the page by GDPR plugin.
- debug - Set to true/false, to activate/deactivate debug mode.
When this option is activated, plugin comes into debug mode which means that in console we can see:
- 1st party cookie names (local cookies)
- 3rd party cookies urls
- blocked urls
To use the Cookie Scanner you need to add the License Number for the plugin.
To add License Number you need to activate the Cookie Config in init.js file.
To run config mode, go to the init.js file and set config mode to true.
Once you activated config mode, go to your site and add the parameter in the URL for you to see the cookie config modal.
You will see the area where you can add the license number.
Note
For now, anonymous scan is still active and cookie scanner will work without adding a license key.
|
To run config mode, go to the init.js file and set config mode to true.
Set a parameter to access the config modal, example is ‘?configure123456’.
Once you activated config mode, go to your site and add the parameter in the URL for you to see the cookie config modal:
Note
You will be ask for your License number if not set already.
|
You can configure the cookies that are accepted and not here.
Step 1) Main cookies options:
Here you can edit, add or delete the cookies that are set in a cookie group.
Step 2) Style options:
- Here you can customize the look of the cookie popup, gear icon, location of the popup or the gear, and customize the button.
Step 3) Content options:
- Here you can add/edit the contents in cookie popup, cookie settings, and cookie modal.
- You can also limit the countries that can use this feature.
Step 4) Configuration options:
- Here you can activate/deactivate the option to add a checkbox for confirmation in forms that sends user information, add/edit the forms where checkbox for form confirmation is needed, and the text to display as confirmation information.
- Add/delete dependencies.
- Set the string parameter used to access config modal.
- Activate/deactivate debug mode.
When you finished configuring, You well see the code that needs to be added in your init.js with the configurations that are made.
Copy the code then go to init.js file. Highlight all codes in init.js then paste the code to replace the old code with the new code w/ configurations.
To know what URLs of scripts that makes cookies, Page Administrator should enable debug mode. You can enable debug in the init.js file.
|
Go to the page with open developer console. You will see urls of scripts that makes cookies:
|
You should categorize this information into groups in plugin settings. Once you are done turn off debug mode.
|
ct_$('html').ultimateGDPR({
popup_style: {
position: 'top-right', // bottom-left, bottom-right, bottom-panel, top-left, top-right, top-panel
distance: '20px', // distance betwen popup and window border
box_style: 'classic', // classic, modern
box_shape: 'rounded', // rounded, squared
background_color: '#fff584', // color in hex
text_color: '#542d04', // color in hex
button_shape: 'rounded', // squared, rounded
button_color: '#e1e1e1', // color in hex
button_size: 'normal', // normal, large
box_skin: 'skin-dark-theme', // skin-default-theme, skin-dark-theme, skin-light-theme
gear_icon_position: 'bottom-left', // top-left, top-center, top-right, center-left, center-right, bottom-left, bottom-center, bottom-right
gear_icon_color: '#ff7e27', //color in hex
},
popup_options: {
parent_container: 'body', // append plugin html to this element selector
always_show: true, // true, false, when true popup is displayed always even when consent is given
gear_display: true, // true, false when true displays icon with cookie settings
popup_title: 'Cookies Information', // title for popup
popup_text: 'To make this site work properly, we sometimes place small data files called cookies on your device. Most big websites do this too.', // text for popup
accept_button_text: 'Accept', // string, text for accept button
read_button_text: 'Read More', // string, text for read more button
read_more_link: '', // string, link to the Read More page
advenced_button_text: 'Change Settings', // string, text for advenced button
grouped_popup: true, // true, false, when true cookies are grouped
default_group: 'group_2', // string: name, select group that will be selected by default
content_before_slider: '<h2>Privacy settings</h2><div class="ct-ultimate-gdpr-cookie-modal-desc"><p>Decide which cookies you want to allow.</p><p>You can change these settings at any time. However, this can result in some functions no longer being available. For information on deleting the cookies, please consult your browser’s help function.</p> <span>Learn more about the cookies we use.</span></div><h3>With the slider, you can enable or disable different types of cookies:</h3>',
// string: this content will be displayed before cookies slider, html tags alowed
accepted_text: 'This website will:',
declined_text: "This website won't:",
save_btn: 'Save & Close', // string, text for modal close btn
prevent_cookies_on_document_write: true, // prevent cookies on document write when there is no agreement for cookies
check_country: false,
cookies_expire_time: 30, // set number of days, you can use 0 for session only or 'unlimited'
cookies_path: '/', // sets custom path use / for global, '/your_path' for custom path or 'current' for current path
countries_prefixes: ['AT', 'BE', 'BG', 'HR', 'CY', 'CZ', 'DK', 'EE', 'FI', 'FR', 'DE', 'GR', 'HU', 'IE', 'IT', 'LV', 'LT', 'LU', 'MT', 'NL', 'PL', 'PT', 'RO', 'SK', 'SI', 'ES', 'SE', 'GB'],
reset_link_selector: '.ct-uGdpr-reset',
first_party_cookies_whitelist: [],
third_party_cookies_whitelist: [],
cookies_groups_design: 'skin-1', // skin-1, skin-2, skin-3
assets_path : '/assets', // absolute path to directory with assets
cookies_groups: {
group_1: {
name: 'Essential', // string: name
enable: true, // true, false, you can disable this group by using false
icon: 'fas fa-check', // string icon class from font-awesome see -> http://fontawesome.io
list: ['Remember your cookie permission setting', 'Allow session cookies', 'Gather information you input into a contact forms, newsletter and other forms across all pages', 'Keep track of what you input in shopping cart', 'Authenticate that you are logged into your user account', 'Remember language version you selected'], // array list of options
blocked_url: ['http://get.exitintel.com/load.js?exitintelAccount=371'], // array list of url blocked scripts
local_cookies_name: [], // array, list of local cookies names
},
group_2: {
name: 'Functionality', // string: name
enable: true, // true, false, you can disable this group by using false
icon: 'fas fa-cog', // string icon class from font-awesome see -> http://fontawesome.io
list: ['Remember social media settings', 'Remember selected region and country',],
blocked_url: [], // array list of url blocked scripts
local_cookies_name: [], // array, list of local cookies names
},
group_3: {
name: 'Analytics', // string: name
enable: true, // true, false, you can disable this group by using false
icon: 'fas fa-chart-bar', // string icon class from font-awesome see -> http://fontawesome.io
list: ['Keep track of your visited pages and interaction taken', 'Keep track about your location and region based on your IP number', 'Keep track on the time spent on each page', 'Increase the data quality of the statistics functions'],
blocked_url: [], // array list of url blocked scripts
local_cookies_name: [], // array, list of local cookies names
},
group_4: {
name: 'Advertising', // string: name
enable: true, // true, false, you can disable this group by using false
icon: 'fas fa-exchange-alt', // string icon class from font-awesome see -> http://fontawesome.io
list: ['Use information for tailored advertising with third parties', 'Allow you to connect to social sites', 'Identify device you are using', 'Gather personally identifiable information such as name and location'],
blocked_url: [], // array list of url blocked scripts
local_cookies_name: [], // array, list of local cookies names
},
},
},
forms: {
prevent_forms_send: true, // true, false, when enabled forms get checkbox with info that need to be checked for form send
prevent_forms_text: 'I consent to the storage of my data according to the Privacy Policy', // string: information for checkbox info
prevent_forms_exclude: [], // array of selectors (classes, id), this forms will be excluded from prevent
},
configure_mode: {
on: true,
parametr: '?configure123456',
dependencies: ['https://stackpath.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css', 'assets/css/ct-ultimate-gdpr.min.css', 'https://use.fontawesome.com/releases/v5.0.13/css/all.css'],
debug: false, // bool: true false, debug mode on/off (showing all 3rd party cookies urls, blockes urls names of all local cookies and names of blocked local cookies )
}
});
Icons are displayed using the Font Awesome library, which in our script is loaded from external server.
When testing the Demo without internet access, icons won’t load because there is no connection to the server of this library.
To avoid problems for local testing, you can add the CDN script to your local directory. To do that:
First, remove the array item in the init.js for the fontawesome cdn.
Go to fontawesome.com then download the free package for fontawesome.
Extract the file, then go into web-fonts-with-css folder. Copy the content and folder of this folder and paste into the asset path:
Paste the content in assets > css
Paste folder in assets folder
Attach css file in the html file with the proper path.
Save the changes.