Configuring and activating feed
This guide will help you to get your feed up and running by configuring and activating it.
Configuration
Select countries
Select the shops for which feeds should be generated in the Panel:
- Go to
Add-Ons > Masterfeed Add-On > Feeds > Feed Configuration
- Select the respective shop countries.
- Click SAVE.
For each selected country, one feed file is created. Only for some preconfigured feeds to supported 3rd party partner integrations the feeds are provided as multi country files.
Set include and exclude rules
Include and exclude rules allow you to define criteria for adding or removing specific data from your feed. In this section, you'll learn how to configure these rules.
Include and exclude products to feed
Products can be included or excluded base on categories, product IDs and attribute. As an example:
- Go to
Add-Ons > Masterfeed Add-On > Feeds > Feed Configuration
- In the include criteria for products, enter a category to include.
- Click SAVE.
To define rules base on attributes, select a attribute grou from the dropdown list to narrow down the inclusion and exclusion rules.
Include and exclude categories from feed
If you selected Category as data type, you can include and exclude categories by name. As an example:
- Go to
Add-Ons > Masterfeed Add-On > Feeds > Feed Configuration
- In the exclude criteria for categories, search for a category you want to exclude.
- Click SAVE.
Set feed scheduler
The Masterfeed Add-On scheduler allows you to define the runtime of your feed base on pre-determined intervals.
When setting up the scheduler with the Add-On, you can choose between two main types: Full Feeds and Delta Feeds. Understanding the difference is key to optimizing data transfer and ensuring efficiency.
- A full feed considers the entire dataset each time it runs.
- A delta feed only considers changes made to the dataset since the last update. This could include new entries, updates to existing data, or deletions.
Set the interval in which the feed should be generated.
- Go to
Add-Ons > Masterfeed Add-On > Feeds > Feed Configuration
- In the Masterfeed Scheduler, select the interval from dropdown.
- Click SAVE.
For some preconfigured feeds to supported 3rd party partner integrations the Add-On offers additional scheduling options and features such as immediate availability updates or more frequent intervals to sync new products.
Pick the file format
In this section, you are able to pick in which format the feed file should be generated. The masterfeed Add-On currently supports the generation of XML and CSV files.
Select the file format
- Go to
Add-Ons > Masterfeed Add-On > Feeds > Feed Configuration
- In the section Feed file, select CSV or XML.
- For a CSV file, select a separator from the dropdown options.
For a XML file, define the header. - Click SAVE.
For some preconfigured feeds have direct integrations to supported 3rd party partner solutions. For such feeds the file format is not configurable.
Choose an access option
In this section, you are able to define how you want to be provided with the feed files. The Masterfeed Add-On currently supports the following options to access the file:
Option | Description |
---|---|
SCAYLE S3 | Feed files are provided on an AWS S3 bucked provisioned by SCAYLE |
YOUR OWN SFTP | Feed files are transferred to an SFTP server of your choice |
SCAYLE SFTP | Feed files are provided on an SFTP server provisioned by SCAYLE |
SCAYLE API | Feed files are provided via an API exposed by the Add-On |
YOUR OWN S3 | planned |
Configure SFTP as an access option
- Go to
Add-Ons > Masterfeed Add-On > Feeds > Feed Configuration
- In the section Feed access, select YOUR OWN SFTP from the dropdown options.
- Enter the Host, Username and Password to access the SFTP
- Click SAVE.
For some preconfigured feeds have direct integrations to supported 3rd party partner solutions. For such feeds the file format is not configurable.
Access feed files via SCAYLE API
To download a feed:
GET https://{{tenant-space}}-masterfeed.addon.scayle.cloud/api/mfapp/download/feedId/shopId
To list all feed files:
GET https://{{tenant-space}}-masterfeed.addon.scayle.cloud/api/mfapp/feed-country-files/feedId
The API is OAuth protected by default. You can create a token in the Settings page or disable the protection to access the API.
Define the feed fields
In this section, you are able to define the fields your feed should contain. Depending on the selected data type of your feed, you can select from a set of System Fields and Attribute Groups to map data from SCAYLE to a corresponding field in your feed.
Beside a one-to-one mapping you can also apply advanced extraction and transformation logic to define your feed fields. Please study our documentation on Advanced field mappings to understand more about the field mapping options.
Define mapping for feed fields
- Go to
Add-Ons > Masterfeed Add-On > Feeds > Feed Configuration > Field Mapping
- Click on Add Field.
- In the column SCAYLE, select e.g. Name from the dropdown options.
- In the column Feed, enter Product Name
- Click SAVE.
Remove a mapping row
- Select the Trash icon at the right end of the mapping row.
Manage feed state
Before your feed will run you have to activate the feed. The Masterfeed Add-On features the following states of a feed.
- Draft - Use this state to for work in progress feed configuration.
- Active - Use this state to enable the generation on the feed.
- Inactive - Use this state to pause the feed generation.
Activate feed
- Go to
Add-Ons > Masterfeed Add-On > Feeds > Feed Configuration
- In the top of the configuration page, Click on Save As.
- Select
Active
from the dropdown options. - Click SAVE.