Configuring the catalog export
Note
This topic is for administrators and developers with administration access rights in Shopware.
This topic describes how to configure the catalog export, when using Shopware as e-commerce platform with Optimizely Campaign. You can transfer promotional texts and product images, and use this data in your newsletters. See Content interface paragraph.
How it works
The integration reads a feed created in Shopware and transmits feed data to Optimizely Campaign. You can use filters in Shopware to exclude product categories. The integration exports the catalog to a CSV file , and automatically transfers the catalog to the Optimizely server via a secure SFTP connection at specific time intervals.
Prerequisites
You need an SSH key pair and an SFTP user account to set up a secure connection. To create a key pair, see:
When you have created the key pair, do the following to request a user account:
- Contact customer support, providing the name of the CSV file with your product catalog.
- Email your public key (the file with the .pub extension) to customer support.
- Send your key fingerprint in a separate email to customer support.
Note
For security reasons, always send your public key and key fingerprint in two separate emails.
When your account is configured, you will receive your user account information by email, and you can start the configuration.
Configuration steps
- Configure the feed for the catalog that is to be exported.
- Configure your Shopware integration for catalog export.
- Configure and activate the cron jobEpiserver Campaign Product Export in Shopware to automate daily catalog exports.
kymR-configuring-the-catalog-export.mdxStep 1. Configuring your feed for catalog export
The Shopware integration includes a standard feed that you can copy and customize (recommended).
Do the following to configure a feed:
- Log in to the back end of Shopware with administrator rights.
- Go to Marketing > Item export.
- In the list, find the entry optivo broadmail and click Edit item feed .
- In the Format tab, in the Encoding drop-down list, select UTF-8.
Note
Entries in the Header and Body tabs were created by the Shopware integration at the time of installation and are required for the product data exchange with the content interface. Do not change the entries in the Header tab. You can change the Body tab as needed in steps 5 and 6.
- Optional: In the Body tab, adjust the sending time by changing the number of days (10 by default).
Note
Do not change the variables and the filters used (such as |escape).
- Optional: In the Body tab, change the shipping service provider and the shipping method.
Note
Deutsche Post Standard is the default shipping service provider and shipping method.
Note
Do not change the variables and the filters used (such as |escape).
- To exclude product categories from being transferred to Optimizely Campaign in the catalog export, open the Blocked categories tab and select the corresponding check box.
- Click Save and Close.
- Find the optivo broadmail feed and right-click the file name in the File name column. In the context menu of your browser, select the option Copy link location.
- Copy the Feed URL to your clipboard, or save the URL in a text document.
kymR-configuring-the-catalog-export.mdxStep 2. Configuring Shopware integration for catalog export
- In Shopware, go to Configuration > Plugin Manager.
- On the left side of the menu bar, click Installed.
- Find the Shopware integration for Episerver Campaign in the Plugin Manager, and click Open .
- In the Configuration area, insert the data below:
- Product export. Select Yes.
- Export Name. Enter the file name for your catalog export.
- Product export link. Enter the URL of the feed for your catalog export.
- SFTP Username. Enter the user name for your Optimizely server account.
- SFTP keyfile password. Enter the password for your private SSH key.
- SFTP Private Keyfile. Enter your private SSH key.
- Click Save.
kymR-configuring-the-catalog-export.mdxStep 3. Configuring and activating the Cron job
To automate daily catalog exports, you must configure and activate the Cron job Episerver Campaign Product Export in Shopware.
- In Shopware, go to Configuration > Basic settings.
- Go to System > Cronjobs.
- In the list, find the Cron job Episerver Campaign Product Export and click Edit .
- Select Active.
- In the Interval drop-down list, select a time interval, such as 1 day.
- Click Save.
- To activate the Cron job and start the automatic schedule, invoke the URL. Typically, this is something like: http://<your store URL>/backend/cron.
Note
When the URL is invoked, you can find the job in the list of running Cron jobs under the Processing Episerver Campaign Product Export (if the execution is scheduled).