How the settings page works

Open Orders › Order sources and click the Settings tab. The Settings tab, opened on the Overview. shows the page.

• Sections. The list on the left opens a section: Overview, then Detection, Consent and Attribution under Tracking, Referrer rules, Excluded sites and Test a link under Sources, Orders under Display, Data and upkeep under Data, and Help.
• One Save per section. Save stores the fields of its own section only. The confirmation, or what is wrong with a value, appears inside the section. Referrer rules and Excluded sites add and delete their entries with buttons of their own; Overview, Test a link and Help have nothing to save.
• Help on every field. The info button next to a label opens a short text under the field: what the setting does, what changes when you change it, and its value after installation.
• The status line above the sections sums up the state of the module (The four getting-started steps).
• The buttons at the top take you to Test a link, to the Dashboard and to the Help section; Modules, at the top left, takes you back to the Module Manager. Help reminds you how the module works, explains its words, lists what is good to know and gives the address of support. When this guide ships with the module, Help links to it too: in the language of your back office when that translation is included, otherwise in English.

With several shops, a section is saved for the shop chosen in PrestaShop’s shop selector (Several shops).

Detection: how a visit is noticed

1. How visits are detected: three ways to record a visit.
2. The info button. It opens the help text of the field, here under the three choices.
3. Save stores the section.

Consent: when recording may start

1. When recording starts: at once, or after consent.
2. For your cookie banner: what your banner has to do. The box appears when the second choice is selected.
3. Copy puts a call on the clipboard, to paste into your banner’s settings.

With the second choice, the module has to learn the visitor’s answer from your banner. There are three ways:

• Google Consent Mode. Nothing to do: the module reads it, and recording starts when analytics_storage is granted.
• Any other banner. Let it call pchOrderSource.grantConsent() when the visitor accepts, and pchOrderSource.revokeConsent() when they withdraw. Most banners have a field for a script to run on acceptance.
• A banner that knows the answer before the page loads can set window.pchOrderSourceConsent = 'granted'.

The JavaScript calls for a cookie banner has the details for the person who sets up your banner.

Attribution: the window and your own visits

1. Attribution window, in days.
2. Test IP addresses, one per line.
3. Add my address, followed by the address you are working from: adds it to the list.

A value that cannot be right is refused with a message that says how to fix it, for example: “192.0.2 is not an IP address. Write one address per line, for example 192.0.2.10.”

Referrer rules: a source of your choice for a site

Without a rule, a site that links to your shop is recorded under its own domain, with the medium referral. A rule replaces that with the source, medium and campaign you choose. You only need rules for partner sites, comparison sites or your own other websites: search engines and social networks are recognised without one.

1. Your rules: Domain, Source, Medium and Campaign.
2. Delete removes a rule.
3. Add a rule: the form that adds a rule, with its button Add rule.

1. Open Settings › Referrer rules.
2. Under Add a rule, enter the Domain of the site, without https:// and without a page: partner-blog.example.
3. Enter the Source and the Medium the visits should get, for example partner-blog and affiliate. Campaign is optional.
4. Click Add rule. The rule appears in the table and applies to the visits that arrive from now on.

• A rule also covers the subdomains of its domain: www.partner-blog.example, shop.partner-blog.example.
• A rule without a medium gets referral.
• A second rule for the same domain replaces the first.
• A link with UTM parameters, or an ad click, still decides first: a rule only applies when the link itself says nothing.
• Visits already recorded keep the source they got.

Excluded sites: pages a customer only comes back from

A customer who pays on another site returns to your shop from that site. If it counted as a source, your orders would seem to come from the payment page. Excluded sites never count as where a visitor came from.

1. The sites you excluded, each with Delete.
2. Add a site: the form that adds a site, with its button Add site.
3. Always excluded: under Your shop your shop’s own domains, under Payment providers the payment providers the module knows. This list cannot be changed.

The module already excludes the domains of your own shops and these payment providers, with their subdomains: paypal.com, stripe.com, klarna.com, adyen.com, mollie.com, payu.com, payu.ro, netopia-payments.com, mobilpay.ro, euplatesc.ro, revolut.com and sofort.com.

Add a site when you see it among your sources and it is only a step of your checkout, for example the payment page of your bank: enter its domain under Add a site and click Add site. A missing bank rarely matters, because the page a payment returns to is never treated as an arrival.

Test a link: see the source before you publish

You build campaign links by hand, and a typing mistake only shows when orders arrive under the wrong source. Test a link shows at once how a link will be recorded. It stores nothing and does not open the link.

1. Link to your shop: the link as you will publish it.
2. The page it is clicked on (optional): where the link will stand, when that matters.
3. Test shows the result.
4. The source, medium, campaign and landing page the visit would get.
5. Decided by: the rule that gave the visit its source.

1. Open Settings › Test a link, or click Test a link at the top of the settings.
2. Paste the link into Link to your shop. It must lead to your own shop.
3. If you want to know how a link without parameters is recorded, also enter the page it will be clicked on, for example the address of a partner’s article.
4. Click Test and read the result under This visit would be recorded as.

If the result is not what you expect, check the spelling of utm_source and utm_medium in the link first. A link that does not lead to your shop is refused, with the address it has to start with. Building campaign links shows three complete examples.

Orders: where the source is shown

1. The switches for PrestaShop’s list of orders and its order page.
2. The switches for the columns of the module’s Orders tab.
3. Revenue on the dashboard: without or with tax.

Data and upkeep: how long visits are kept

1. Keep visits for, in days.
2. Housekeeping: the last run, and Run now.
3. Maintenance address, with Copy. The picture shows a made-up address: yours holds a secret.
4. Keep data when uninstalling.
5. Log decisions.

↑