TypoScript setup

| Data type: array | Default: mandatory |

Holds the group configurations. A group contains several tracking objects.

By default, it only contains the 'mandatory' group, which includes the CookieConsent settings cookie. See a full TypoScript Configuration example.

| Data type: array | Default: mandatory |

A single group. The group's key (name) should not contain spaces and non-ASCII characters.

It will be saved in the settings cookie and can be checked with JavaScript: hasConsented('‹group-key›')

| Data type: boolean | Default: 0 (not set) |

If enabled (1), the group's consent checkbox will be already checked when the popup opens.

The default group 'mandatory' has this set to 1.

| Data type: boolean | Default: 0 (not set) |

If enabled (1), the group's consent checkbox will be disabled (cannot be changed).

The default group 'mandatory' has this set to 1.

| Data type: array with numeric indices |

Holds a list of tracking object keys (numbered).

Example:

trackingObjects {
  0 = CookieConsent
  1 = fe_typo_user
}

| Data type: boolean | Default: 0 (not set) |

If set to 1, this group respects to the "Do-not-track" setting of your browser.

| Data type: boolean | Default: 0 (not set) |

If set to 1 and the "Do-not-track" setting of your browser is enabled, an additional message about that is shown inside the group.

| Data type: array |

This array holds the tracking object configurations.

The Cookieman extension already provides several preconfigured tracking objects in the folder ./Configuration/TypoScript/TrackingObjects/ (link to the Github repository).

The default group 'mandatory' only contains the tracking object CookieConsent settings cookie.

| Data type: array | Example: fe_typo_user |

A single tracking object configuration.

Example:

plugin.tx_cookieman.settings.trackingObjects {
    // 'Matomo' is the ‹tracking-object-key›:
    Matomo {
        // injected code, if consent is given:
        inject = TEXT
        inject {
            insertData = 1
            value (
                <script data-what="Matomo" src="/{path : EXT:cookieman/Resources/Public/Js/Injects/example-inject.js}?{date : U}"></script>
            )
        }

        show {
            // set cookies, if consent is given:
            _pk_id {
                duration = 13
                durationUnit = months
                type = cookie_http+html
                provider = Matomo
            }

            // etc.
        }
    }
}

| Data type: data-type-html-code / data-type-cobject | Example: <script src="/path/to/tracking-code.js"></script> |

Each HTML tag in here will be appended to the page when the respective group is consented. This can be <script>, <img> or anything else.

You can either use inline script or link to an external file (useful if a HTTP header Content-Security-Policy is set).

If you need a local path from your _assets directory, let TYPO3 build it. We currently recommend using TEXT with insertData = 1 and the getText {path : EXT:…}. The preceding root path (/) is necessary for it to work on subpages. We recommend adding ?{date : U} to add a cache-busting parameter. See the example above.

It has shortcomings (namely the missing base and missing cache busting ?parameter. See https://forge.typo3.org/issues/99203#change-507069).

For v13 we can use the {asset : ...}` getText function (https://review.typo3.org/c/Packages/TYPO3.CMS/+/77018).

| Data type: array |

The actual rows of the table, each representing one "tracking item" (usually a cookie).

| Data type: array | Example: _pk_id |

A single "tracking item" (e.g. the name of a cookie). A cookie that matches this name will be removed when consent for the group in which this tracking object is included is revoked. (see also trackingObjects.‹tracking-object-key›.show.‹tracking-item-key›.htmlCookieRemovalPattern)

| Data type: data-type-positive-integer | Example: 12 |

The lifetime of the tracking object (only the "number" part).

| Data type: data-type-string | Example: months |

The lifetime of the tracking object (only the "unit" part).

| Data type: data-type-string | Example: cookie_http+html |

The type of tracking.

Possible (default) keywords:

• cookie_http+html: an HTML (=HTTP+HTML) cookie, which is also readable from JavaScript. This is the only type that can be removed after consent has been revoked.
• cookie_http: an HTTP cookie
• pixel: a tracking pixel

| Data type: data-type-string | Example: Google |

The provider of the cookie or tracking object.

| Data type: data-type-string | Example: ^_gat(?:_UA-d+-d+)?$ |

You can (optionally) set a regex pattern for cookie names here. It will be used during cookie removal. If would remove all matched cookies when consent for the group in which this tracking object is included is revoked. If this is empty, the tracking object key is used for deletion (see trackingObjects.‹tracking-object-key›).