General

Profile

Visual Intelligence Shopware Plug-in Manual

Shopware version supported: from 5.3.7 and higher

This manual shows you step by step on how to install and use the plug-in in your online shop.
Please test the installation and the configuration of the plugin on a test system before
installing it in your live shop.

Plugin purpose

The plug-in Visual Intelligence from Mediaopt supports the integration of the Visual-Product-Recommendation (VPR)

In your online shop and provides image synchronisation for Visual-Product-Search (VPS) too. 

VPR is a cross-selling campaign on your product page, which generates recommended products based on their visual similarity to the source product.

 VPS allows your customer to search not only by text but to find products based on images or the input of the camera on their (mobile) device.  

Plugin Installation 

Before you start with the installation process, backup your database and your online shop.
If you have concerns about installing the plugin, let this job be done by a professional, or feel free
to contact us for help.
Please, follow this instruction carefully for an undisturbed use.

The official Visual Intelligence Shopware plug-in is provided by Mediaopt. If you are a customer of our service please ask

support@mediaopt.de for the latest plug-in version. If you are interested to test the plug-in,

use the contact on the following link: https://www.mediaopt.de/visual-product-recommendation

If you received the plug-in in a zip-file, go to your Shopware backend and Configuration > Plugin Manager > Installed.

Click on the "Upload plugin" button, choose the zip-file and start the installation. 

In the future, it will be possible to download the plug-in in the Shopware online shop backend or the Shopware store too.   

 

Plugin Activation

Activate the plugin in Configuration > Plugin Manager > Installed > Click on the pencil image to the
right of the plugin name >
 Activate plugin button. Fill in your credentials and security data, choose
your configuration and save the plugin settings.

 

Plugin Configuration

Available configuration

  • Enable in this subshop: [Yes/No] - You may enable/disable the plugin for each of your subshops individually.
  • API Key: [string] - Type in your API-User. Check your last Mediaopt infomail.
  • Your API Password: ​[string] - Type in your API-Password. Check your last Mediaopt infomail.
  • Environment: [one of the options] - Choose Productive for shop deployment, change to Stage for testing mode. 
  • Enable article auto indexing: [Yes/No] - If this option is enabled, the plug-in will re-index an article each time it is updated.
  • Username for the Basic Auth(htaccess): - Give in HTACCESS username if you have Basic Auth enabled. The advanced setting, usually only for test environments. 
  • Password for the Basic Auth(htaccess): - Give in HTACCESS password if you have Basic Auth enabled. The advanced setting, usually only for test environments. 
  • Article image to Index: ​[one of the options] - Choose which images you would like to index. More information on this
    point follows below.
  • Log level: ​[one of the options] - Choose Debug for a test installation, change to Error on a live site.
  • Log rotation days: ​​[integer] - How many days to keep logs.

Indexing of images

According to data security concerns, all images of products, which are sent to be indexed, will not be stored on our services.

Our AI system analysis the image and stores just the resulting description.

In order to have a better image analysis result, it is important to send well-prepared images. The photo
should contain an isolated product, in best case without containing any complex background or other
objects or persons.
Pick "first and second" in the Article image to Index configuration option if you have a good overview
photo of your product on the first and second image, but have a close look/documentation/use case image
on the third one.

 

First Article Image Second Article Image  Third Article Image

Good

Good

Bad 

(Use case with many forefront objects)

                                                                                        

Category synchronisation:

To receive Visual Product Recommendation in your online shop you need to synchronize your product images

with our Visual Intelligence system first. Please select the product categories in your online shop backend to collect

the product, which should be analysed and get Visual Product Recommendations.  

Items -> Categories -> "Category" -> Visually Similar Products -> Mark for synchronization.

There are three options for the image indexing:

1. Indexing through cronjobs.

Configuration -> Basic settings -> System -> Cronjobs -> Visually Similar Product -> Edit -> Active [check]

2. Execution of a command in the Shopware console.

You could run the following command in the terminal: bin/console mopt_visual_recommendation: synchronize

To make a forced synchronization, use --force (shortcut -f) option bin/console mopt_visual_recommendation:synchronize --force

3. Indexing through the "Content" menu entry.

Content -> Visually similar products -> Start synchronisation (Alternative: Start force synchronization)

If any category was unmarked or if the catalog tree was changed, please, use the force synchronization. In any other cases click on the "Start synchronization".

 

Result

If everything is done right, the tab with "Visually Similar Products" will appear in your online shop frontend product page.

Below is just one example of the possible implementation of the plug-in and its results.

  

Frontend-Tracking

Under settings it is possible to switch the tracking of frontend events off and on.

As default etracker, a german based company, will be used. Please make sure to add this information to your data privacy statement. Please see the example text and make sure that it satisfies the law of your country. 

Tracking privacy statement and right of withdrawal
<b>etracker</b><br>
<br>
Der Anbieter dieser Website verwendet Dienste der etracker GmbH aus Hamburg, Deutschland (<a href="https://www.etracker.com&quot;&gt;www.etracker.com&lt;/a&gt;) zur Analyse von Nutzungsdaten. Wenn Besucher uns die explizite Einwilligung erteilen, werden dabei Cookies eingesetzt, die eine statistische Analyse der Nutzung dieser Website durch ihre Besucher sowie die Anzeige nutzungsbezogener Inhalte oder Werbung ermöglichen. Cookies sind kleine Textdateien, die vom Internet Browser auf dem Endgerät des Nutzers gespeichert werden. etracker Cookies enthalten keine Informationen, die eine Identifikation eines Nutzers ermöglichen.<br>
<br>
Die mit etracker erzeugten Daten werden im Auftrag des Anbieters dieser Website von etracker ausschließlich in Deutschland verarbeitet und gespeichert und unterliegen damit den strengen deutschen und europäischen Datenschutzgesetzen und -standards. etracker wurde diesbezüglich unabhängig geprüft, zertifiziert und mit dem Datenschutz-Gütesiegel <a href="https://www.eprivacy.eu/kunden/vergebene-siegel/firma/etracker-gmbh/&quot;&gt;ePrivacyseal&lt;/a> ausgezeichnet.<br>
<br>
Die Datenverarbeitung erfolgt auf der Rechtsgrundlage des Art. 6 Abs .1 lit a (Einwilligung) der EU-Datenschutzgrundverordnung (EU-DSGVO) zur Optimierung unseres Online-Angebotes und unseres Webauftritts. Da uns die Privatsphäre unserer Besucher besonders wichtig ist, wird die IP-Adresse bei etracker frühestmöglich anonymisiert und Anmelde- oder Gerätekennungen bei etracker zu einem eindeutigen, aber nicht einer Person zugeordneten Schlüssel umgewandelt. Eine andere Verwendung, Zusammenführung mit anderen Daten oder eine Weitergabe an Dritte erfolgt durch etracker nicht.<br>
<br>
Sie können einer erteilten Einwilligung jederzeit widersprechen. Ihr Widerspruch hat für Sie keine nachteiligen Folgen.<br>
<br>
<a href="#" data-tld="yourdomain.com" id="et-opt-out"></a> <br>
<br>
Weitere Informationen zum Datenschutz bei etracker finden Sie <a href="https://www.etracker.com/datenschutz/&quot;&gt;hier&lt;/a&gt;.

The following events and options will be tracked:

DESCRIPTION myCategory myObject myAction myType area (auto) pagename (domain)
view-Product product productID view detail    
load-Vi-VPR-ProductPage VI-VPR | defaultPR   load detail    
view-Vi-VPR-ProductPage VI-VPR | defaultPR   view detail    
view-Vi-VPR-Product-ProductPage VI-VPR-Product | defaultPR-Product productID view detail    
click-Vi-VPR-Product-ProductPage VI-VPR-Product | defaultPR-Product productID click detail    
view-Vi-VPR-ListPage VI-VPR | defaultPR   view list    
             
view-Vi-VPR-Product-ListPage VI-VPR-Product | defaultPR-Product productID view list    
click-Vi-VPR-Product-ListPage VI-VPR-Product | defaultPR-Product productID click list    
addToBasket-ProductPage product productID addToBasket detail    
addToBasket-ListPage product productID addToBasket list    
addToBasket-VI-VPR-ProductPage VI-VPR-Product | defaultPR-Product productID addToBasket detail    
addToBasket-VI-VPR-ListPage VI-VPR-Product | defaultPR-Product productID addToBasket list    
order-Product product productID order thankyou    
             

Furthermore we are using campaigns on similar products:

Description Campaign name Campaign medium Campaign partner Campaign type Campaign origin
click on VI-VPR-Product VI VPR mediaopt recommendation ListPage | ProductPage

Mapping of the campaign parameter to tracking services:

Tracking service Campaign name Campaign medium Campaign partner Campaign type Campaign origin
e tracker etcc_cmp etcc_med etcc_par etcc_ctv et_cmp_se
           

 

Preventing and Enabling Cookies

When enabling the frontend tracking you may prevent setting of cookies with an extra option.
If you choose to disable them and have a cookie message you may put the classname mo_js-enableTrackingCookie onto that element to have an explicit opt in of setting cookies for the tracking.