OpenCart 3 + Journal3

The OpL Insights extension does everything for OpenCart 3: it adds the script to the storefront, sends products, carts and orders, and creates the store's sites in OpL Insights when you click Connect. Nothing needs to be added to your theme.

Before you start

• OpenCart 3.0.x with vQmod, with or without Journal3.
• The connection code you received with your OpL Insights account.
• The store reachable over https from the internet. OpL Insights checks the store before it creates its sites.

Install

1. Copy the contents of the extension's upload/ folder over the store's root.
2. In OpenCart admin, go to Extensions > Modules > OpL Insights and click Install, then Edit.
3. Refresh the theme cache: Dashboard > gear icon > Theme. OpenCart 3 caches templates, so new settings don't appear until you do.

To upgrade, copy upload/ again and refresh the theme cache. Settings are kept.

Connect the store

Add the connection code to the store's admin/config.php. It is read from there and never saved in the database.

define('OPL_INSIGHTS_ENROL', '<connection code>');
define('OPL_INSIGHTS_URL', 'https://insights.opl-web.com/');
// optional: a prefix and group for the new sites, e.g. "ACME - Main store"
define('OPL_INSIGHTS_PREFIX', 'ACME');
define('OPL_INSIGHTS_GROUP', 'ACME');

Then open the extension and click Connect to OpL Insights. OpL Insights checks that the store really answers on its address, then creates:

• a storefront site with e-commerce and site search turned on;
• an admin site that records OpenCart admin sessions for support, which store staff don't see;
• a view-only login for the store, used when someone opens Insights from OpenCart admin.

Connecting again, for example after reinstalling the extension, keeps the same sites.

Store addresses

If customers reach the store on more than the address OpenCart admin runs on (a live domain while you connect from the master node, for example), list them under Store addresses, one per line. The first one becomes the main address.

https://www.example.co.za
https://example.co.za
https://master.example.co.za

Only the address the admin connects from is verified. An address already used by another store in OpL Insights is skipped and named in the result. www. and non-www aren't added for you: list both if both are used.

Time zone and currency

Choose where the store's customers are under Time zone: reports, "today" and visit times follow it. Currency is the one revenue is shown in. Leave either on Leave as in OpL Insights to keep what is set there.

Keeping OpL Insights in step

• Read from OpL Insights copies the addresses, time zone and currency OpL Insights has now into the fields on the page.
• Update OpL Insights when I save: tick it before Save to make OpL Insights match the page. Addresses not listed are removed; a time zone change re-processes the last 30 days of reports.
• Without the tick, Save only stores the settings in the store.

Identify customers

Under Customer identification choose what is sent as the user ID for signed-in customers: the customer ID, e-mail, e-mail and ID, a one-way hash, or nothing. Choose e-mail to see who each recording belongs to. The change applies to new visits.

Check it works

Open the storefront in a private window, sign in as a test customer and add something to the cart. In OpenCart admin, open Insights from the menu: the visit shows in the figures at the top within a few minutes, and the recording under Session recordings.