boxalino/rtux-integration-shopware

Boxalino Real Time User Experience (RTUX) Integration

3.4.2 2024-08-22 12:56 UTC

Requires

• php: ^7.2 || ~8.1
• boxalino/data-integration-shopware6: ~3.4.0 || ~3.5.0
• boxalino/rtux-api-php: ~3.3.35
• boxalino/rtux-shopware: ~3.4.12

MIT

• Boxalino AG

README

Introduction

This repository is provided as guidelines (tutorials) on how to integrate Boxalino Winning Interractions in Shopware6. The integration is managed by the client. Boxalino can provide further documentation and assistance upon request.

Included functionalities (with samples of templates):

1. Search As you Type (Autocomplete Flyout) integration - Server Side
2. Search As you Type (Autocomplete Flyout) integration - Ajax (faster alternative to Server Side)
3. Search result page with facets (refinement filters), pagination and sorting
4. PDP product recommendations (via subscriber event)
5. Category Product-listing results (a.k.a. Navigation) with facets (refinement filters), pagination and sorting
6. CMS element (e.g.: products or blog post) for any Layout Integration (with Boxalino Narrative block)
7. Dynamic router (ex: for brand pages or landing pages)

**If you are new to using Boxalino in a Shopware environment, please have first a look at our introduction documentation here

The repository is being updated with new guidelines & scenario. Check the wiki page for instructions https://github.com/boxalino/rtux-integration-shopware/wiki

We value your feedback and we welcome the community`s pull/merge-requests. Thank you.

Integration

Boxalino provides several repositories you will need. This one plays the role of the initial environment you will extend with your team. You also need the data integration layer and the framework layer. The data layer repository manages the export of your data to Boxalino. The framework layout is the generic and standard Shopware6 code on which your integration plugin will depend and which is maintained by Boxalino.

While the other repositories (data layer and framework layer) will be maintained by Boxalino, this repository will not, as it is your integration environment in which you will work and use what you need and extend what you want. Therefore, as this repository is provided as a guideline (tutorial), you will need to integrate it (which means replicate it) in a repository/plugin maintainted&developed by the client`s team. For this reason, this repository is generally not subject to Boxalino maintenance on client setup.

This repository can also be deployed for checking out Boxalino features (as a demo). By requiring this repository, it will also install other dependencies. Please review the composer.json and follow-up with other dependencies deployments guidelines.

In order to create your own integration layer All At Once - please check the wiki on Initial Setup (All-At-Once).

In order to create your own integration layer - please start in the wiki.

In order to deploy it for local demo (without Boxalino assistance or a need to maintain the code in a client setup), check the Setup steps bellow.

Setup

ONLY FOLLOW THESE STEPS IF YOU ARE DEPLOYING A LOCAL DEMO, OTHERWISE, GO TO THE wiki.

1. Follow the integration steps for the data integration layer and the framework layer:

   • composer require boxalino/rtux-shopware
   • composer require boxalino/data-integration-shopware6
   • ./bin/console plugin:refresh
   • ./bin/console plugin:install --activate --clearCache BoxalinoDataIntegration BoxalinoRealTimeUserExperience

2. Add the plugin to your project via composer (it will install dependencies rtux-api-php, rtux-shopware, exporter-shopware6) composer require boxalino/rtux-integration-shopware

3. Activate the plugin per Shopware use ./bin/console plugin:refresh ./bin/console plugin:install --activate --clearCache BoxalinoRealTimeUserExperienceIntegration

4. Due to the JS files in the plugin (for listing & filters), a theme compilation might be required: ./psh.phar storefront:build or ./bin/build-storefront.sh

5. Due to the JS files in the dependency plugin (tracker, Shopware6 CMS blocks, etc), a theme compilation might be required: ./psh.phar administration:build or ./bin/build-administration.sh

6. Log in administration panel (/admin) and set the configurations for the framework layer and expporter. admin#/sw/plugin/settings/BoxalinoRealTimeUserExperience admin#/sw/plugin/settings/BoxalinoDataIntegration

7. In order to kick off your account, a full export is required. More information available https://github.com/boxalino/exporter-shopware6 For this, please set the exporter configuration per Sales Channel and disable the plugin where it is not in use. The Headless channel must have the plugin disabled. ./bin/console boxalino:exporter:run full

8. Import the content of the complete-guidelines JSONs in Boxalino Intelligence Admin; test, save & publish.

   • Layout Blocks (Boxalino Intelligence Admin >> Marketing >> Layout Blocks)
   • Template Resources (Boxalino Intelligence Admin >> Advanced >> Template Resources)
   • Narratives (Boxalino Intelligence Admin >> Marketing >> Narratives)
   • Facets (Boxalino Intelligence Admin >> Merchandising >> Facets )

9. Search, autocomplete, cross-sellings will work automatically. In order to have navigation active, read the #About section in the cms-navigation documentation. In order to add sliders on home-page/other segments, read the #About section in the cms-slider documentation. More information on the CMS element is available in the Confluence Page https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/354877485/CMS+Element+for+Shopping+Experiences

Documentation

Shopware 6 Integration Introduction More documentation is available on each dependency repository wiki page.

Shopware 6 CMS Element Configurations & Practices available as well in the Confluence page.

Contact us!

If you have any question, just contact us at [e-mail]