Preface
Otherwise, the WordPress site will certainly display error messages and will no longer be accessible.
In addition, the Borlabs Cookie settings may be lost if the instructions are not followed exactly.
Pre-installed presets (Cookies / Content Blockers) are no longer available. Presets are no longer selected when adding a cookie, but via packages from the Borlabs Cookie 3.0 library.
The scanner in Borlabs Cookie 3.0 can determine which packages from the library your website requires. The suggested packages of the "Compatibility Patch" type should always be installed.
When using the Legacy Importer, the required packages are automatically determined and installed. You can find more information on this in the "Upgrade Options" section.
Once the data has been imported, a report on the import history is sent to the administrator email address (Settings > General > Administrator Email Address).
Data, Settings and Backward Compatibility
Design, Settings and Texts
All settings and texts from the areas "Settings", "Cookie Box" and "Content Blocker: General Settings" and "Content Blocker: Appearance Settings" are adopted if available in Borlabs Cookie 3.0.
The following settings are no longer available in Borlabs Cookie 3.0:
- jQuery Handle: jQuery is no longer used.
- Integration [JavaScript | HTML]: Integration takes place exclusively via JavaScript, as this guarantees the highest performance and compatibility.
- Button [Button | Link]: The option to display buttons as links is no longer permitted due to legal changes and has therefore been removed.
- Ignore Pre-selected Status: No longer needed.
Cookie Groups / Service Groups
All Cookie Groups are fully imported. In Borlabs Cookie 3.0, "Cookie Groups" are now called "Service Groups".
Cookies / Services
All Cookies will be imported, but the import may be incomplete because some information is missing in Borlabs Cookie Legacy. In Borlabs Cookie 3.0, "Cookies" are now called "Services".
Complete Import
The following Services will be replaced by Services from the packages of the Borlabs Cookie 3.0 Library. All texts, opt-in, opt-out and fallback codes will be overwritten by the information from the Service package and can be kept up to date in the future by updating the packages in the library. Settings, such as tracking IDs (e.g. from Google Analytics), will be adopted.
| Name | ID | New ID |
|---|---|---|
| Bing Ads | bing-ads | |
| Facebook Pixel | facebook-pixel | meta-pixel-package |
| Google Ads | google-ads | |
| Google AdSense | google-adsense | |
| Google Analytics | google-analytics | |
| Google Tag Manager | google-tag-manager | |
| Google Tag Manager - Consent | google-tag-manager-consent | google-tag-manager |
| Hotjar | hotjar | |
| HubSpot | hubspot | |
| Matomo | matomo | |
| Matomo Tag Manager | matomo-tag-manager | |
| Polylang | polylang | |
| Tidio | tidio | |
| TikTok Pixel | tikto-pixel | tiktok-pixel |
| Userlike | userlike | |
| WooCommerce | woocommerce | |
| WPML | wpml |
No Import
The following Services will not be imported:
| ID | Reason |
|---|---|
| borlabs-cookie | The standard information from Borlabs Cookie 3.0 is used. |
| ezoic | Consent is given via the IAB TCF in Borlabs Cookie 3.0. |
| ezoic-marketing | Consent is given via the IAB TCF in Borlabs Cookie 3.0. |
| ezoic-preferences | Consent is given via the IAB TCF in Borlabs Cookie 3.0. |
| ezoic-statistics | Consent is given via the IAB TCF in Borlabs Cookie 3.0. |
| Automatically created by the Content Blocker package from the library. | |
| googlemaps | Automatically created by the Content Blocker package from the library. |
| Automatically created by the Content Blocker package from the library. | |
| openstreetmap | Automatically created by the Content Blocker package from the library. |
| Automatically created by the Content Blocker package from the library. | |
| vimeo | Automatically created by the Content Blocker package from the library. |
| youtube | Automatically created by the Content Blocker package from the library. |
Incomplete Import
All Services whose ID is not listed under "Complete Import" or "No Import" will be imported, but without complete information. This missing information must be added manually afterwards.
The required Provider is automatically created, but it does not contain all the necessary information because it is not available in Borlabs Cookie Legacy.
Cookie information is partially imported and then needs to be reviewed and corrected.
Content Blocker
Content Blockers are only partially imported. The HTML and CSS of the "Preview Blocked Content" will be replaced by the default settings of Borlabs Cookie 3.0.
The required Provider is automatically created, but it does not contain all the necessary information because it is not available in Borlabs Cookie Legacy.
Script Blocker
All Script Blockers are fully imported.
Backward Compatibility
JavaScript API
The library for backward compatibility for the old JavaScript API is widely available and is automatically activated when using the Legacy Importer. However, it is recommended that you switch to the new JavaScript API to avoid additional JavaScript and thus minimize the impact on PageSpeed scores and similar metrics.
PHP API
Backward compatibility with the old PHP API is not available. We recommend using WP-CLI for automations.
Preparation and Process
When upgrading from version 2.3 to 3.2, the entire directory structure of Borlabs Cookie is exchanged.
It is therefore essential that the updates are carried out in the correct order. Otherwise, there will definitely be a loss of data from the Borlabs Cookie Settings and the WordPress website will display error messages.
- Create a backup. We recommend using the free WP Staging plugin https://de.wordpress.org/plugins/wp-staging/ to create a backup.
- Update Borlabs Cookie to version 2.3.
- Upgrade automatically or manually.
- Automatic upgrade: See the "Automatic Upgrade" section.
- Manual Upgrade: See the "Manual Upgrade" section.
- Do the follow-up.
The updates to version 2.2.68 and from 2.2.68 to 2.3 must only be carried out via the plugin management, as shown in the screenshot.
You are also not allowed to replace files via SFTP/FTP.
Upgrade Options
As soon as Borlabs Cookie 2.3 is installed, the upgrade to Borlabs Cookie 3.2 can be carried out. There are two options, which are explained in more detail below.
Automatic Upgrade
With the automatic upgrade, the update to Borlabs Cookie 3.2 and the import are carried out automatically as soon as version 3.2 is available.
To activate the automatic upgrade, select the "Upgrade to Borlabs Cookie 3.0" option in the dashboard.
As soon as the automatic upgrade is complete, the import will be carried out. An import report will then be sent.
Manual Upgrade
Preparation
The manual upgrade requires the installation of version 2.3. Then check in the Borlabs Cookie Dashboard under "System Status" to see if all the checks are successful.
Upgrade
After that, you can upload the.zip file of Borlabs Cookie 3.2 via the WordPress plugin manager. To do that, go to Plugins > Add New Plugin > Upload Plugin in the menu on the left.
Confirm that you want to overwrite the existing installation.
This process may take some time and must be waited for. As soon as the message "Plugin updated successfully" appears, click on the WordPress Dashboard entry in the left menu. Only then can you use the Borlabs Cookie menu again.
Import
After the WordPress Dashboard has been accessed, the Borlabs Cookie Dashboard can be accessed.
Borlabs Cookie is initially disabled and a message appears asking you to activate the license key. This message can be ignored because the Borlabs Cookie legacy data is imported in the next step, which also applies the license key.
Click on System > Legacy Importer and go to the "Import Legacy Data" section to import the data from Borlabs Cookie Legacy (2.3).
This process can be carried out at any time and overwrites existing entries with identical IDs with the data from Borlabs Cookie Legacy.
All data is imported from Borlabs Cookie Legacy; it is not possible to select individual components, such as only the design.
Before importing, you can use the "Import Data Preview" to see which data will be transferred and for which entries the ID will be changed.
If a Shortcode with an old ID (Legacy ID) was used, the ID must be changed to the new one (New ID) accordingly. Otherwise, the default Content Blocker will be used.
The "Load library for backward compatibility" option is enabled after each import. Notices appear in the browser console when a function of the old JavaScript API is used, including the corresponding new JavaScript function.
We recommend customizing your code and using the new JavaScript API functions. After that, the option "Load library for backward compatibility" can be disabled.
Import Report
After the import is complete, an import report is sent by email to the administrator email address (Settings > General > Administrator Email Address).
The report contains an overview of the imported components as well as information for further follow-up.
Follow-up
When importing custom Content Blockers and Services (formerly Cookies), the required Provider is automatically created. However, this provider does not contain all the necessary information, as this is not available in Borlabs Cookie Legacy, and must therefore be added later.
You can find the Providers under Consent Management > Providers.
The IDs of the automatically created providers begin with "ic-".
After clicking on the edit icon, the Address, Description and Privacy URL fields need to be added.
Under Consent Management > Services, custom Services must also be checked and missing information added if necessary.
The Services that are custom are indicated in the import report. In particular, the information on service, HTML & JavaScript and Cookies should be checked for accuracy.
The upgrade to Borlabs Cookie 3.2 is complete.
Please be sure to watch our videos on Borlabs Cookie 3.0, as a number of things have changed compared to Borlabs Cookie 2.0: https://borlabs.io/kbtopic/videos/.