XML Feeds
Tato kapitola popisuje konfiguraci feedů
Konfigurační soubor se standardně nachází v adresáři /config/module-edeeshop/features/interface/xml-feed.xml.
Příklad konfigurace
<xmlFeed> <alternativeImgGallery/> <alternativeImgVariant/> <defaultCategoryKey/> <disableShipping/> <exportShippingBlackList/> <feedTypes> <feedType> <code/> <interval/> </feedType> </feedTypes> <ignoredPricePolicies/> <imgDefault/> <imgGallery/> <imgVariant/> <productFeedPageSize/> <snippetProductQuery/> <storage/> <templatePath/> <feeds> <feed> <region/> <code>google</code> <type>PRODUCTS</type> <alternativeImgGallery>galerie</alternativeImgGallery> <alternativeImgVariant>eshop-product-detail</alternativeImgVariant> <categoryPathSeparator>></categoryPathSeparator> <exportFileName>googlec43vwp</exportFileName> <externalCategorySource>google</externalCategorySource> <imgDefault>/img/eshop/placeholder/eshop-product-detail.jpg</imgDefault> <imgGallery>hlavni-motiv</imgGallery> <imgVariant>eshop-product-detail</imgVariant> <multiplyPriceByPackage/> <profile>heurekaProfile</profile> <salePrice/> <shouldSkipItem/> <snippetTemplate>feed-product-google.ftl</snippetTemplate> <template>feed-google.ftl</template> </feed> </feeds> <profiles> <profile> <code/> <converters> <converter> <code>shippingType</code> <values> <values> <POST_OFFICE_TO_HAND>CESKA_POSTA</POST_OFFICE_TO_HAND> <POST_OFFICE_TO_POST_OFFICE>CESKA_POSTA_NAPOSTU_DEPOTAPI</POST_OFFICE_TO_POST_OFFICE><DPD>DPD</DPD><DHL>DHL</DHL> </values></values> </converter> </converters> </profile> </profiles> <catalogSpecific> <catalogCode/> <alternativeImgGallery/> <alternativeImgVariant/> <defaultCategoryKey/> <disableShipping/> <exportShippingBlackList/> <ignoredPricePolicies/> <imgDefault/> <imgGallery/> <imgVariant/> <productFeedPageSize/> <snippetProductQuery/> <storage/> <templatePath/> <feeds> <feed> <region/> <code>google</code> <type>PRODUCTS</type> <alternativeImgGallery>galerie</alternativeImgGallery> <alternativeImgVariant>eshop-product-detail</alternativeImgVariant> <categoryPathSeparator>></categoryPathSeparator> <exportFileName>googlec43vwp</exportFileName> <externalCategorySource>google</externalCategorySource> <imgDefault>/img/eshop/placeholder/eshop-product-detail.jpg</imgDefault> <imgGallery>hlavni-motiv</imgGallery> <imgVariant>eshop-product-detail</imgVariant> <multiplyPriceByPackage/> <profile>heurekaProfile</profile> <salePrice/> <shouldSkipItem/> <snippetTemplate>feed-product-google.ftl</snippetTemplate> <template>feed-google.ftl</template> </feed> </feeds> </catalogSpecific></xmlFeed>
Popis
xmlFeed
Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| alternativeImgGallery | Použitý kód galerie pro načtení alternativních obrázků pro feed | String |
|
|
| alternativeImgVariant | Kód alternativní varianty pro načtení obrázku z galerie FeedFeatureConfig#getAlternativeImgGallery() | String |
|
|
| defaultCategoryKey | Kód kategorie, pokud žádná kategorie pro produkt neexistuje | String |
|
|
| disableShipping | Zrušení načítání doprav pro konkrétní produkt po vložení do košíku. | Boolean |
|
|
| exportShippingBlackList | Ignorované dopravy při zpracování feedů | List: String |
|
|
| feedTypes/feedType | Typy exportních feedů, pokud není použitá použije výchozí Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde. |
|
| |
| ignoredPricePolicies | Ignorované cenové politiky při vkládání produktu do košíku / načítání doprav pro produkt | List: String |
|
|
| imgDefault | Relativní URL, která je použita v metodě: | String |
|
|
| imgGallery | Použitý kód galerie pro načtení hlavního obrázku pro feed | String |
|
|
| imgVariant | Kód varianty pro načtení obrázku z galerie FeedFeatureConfig#getImgGallery() ()} | String |
|
|
| productFeedPageSize | Velikost stránky produktů pro zpracování při generování snippetů. | Integer |
|
|
| snippetProductQuery | Metoda načte query pro produkty při zpracování snippetů |
|
| |
| storage | Storage, která je použita pro uložený vygenerovaných feedů | String |
|
|
| templatePath | Konfigurační cesta ke složce, která obsahuje freemarker šablony pro zpracování feedu.
Dostupné konvence pro zapsání cesty ke složce jsou bežně používané v používané v EdeeCMS Složka obsahuje šablony, které jsou projektově specifické. Pokud neobsahuje šablonu daného feedu dle specifikace | String |
|
|
| feeds/feed | Seznam konfigurovaných feedů pro všechny katalogy, nebo specifikovaný katalog | List: feeds/feed |
|
|
| profiles/profile | Seznam feed profilů zaregistrovaných pomocí konfigurace. Aplikace obsahuje již předpřipravené profily, které je možné přetížit či vytvořit nové. Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde. | List: profiles/profile |
|
|
| catalogSpecific | Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde. |
|
|
feedTypes/feedType
Typy exportních feedů, pokud není použitá použije výchozí
Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| code | String |
|
| |
| interval | String |
|
|
feeds/feed
Seznam konfigurovaných feedů pro všechny katalogy, nebo specifikovaný katalog
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| region | Region feedu, ve kterém bude konkrétní feed zpracován. Region určuje například měnu. | String |
|
|
| code | Kód feedu | String |
|
|
| type | Typ feedu. Možné hodnoty:
| String |
|
|
| alternativeImgGallery | Použitý kód galerie pro načtení alternativních obrázků pro feed | String |
|
|
| alternativeImgVariant | Kód alternativní varianty pro načtení obrázku z galerie FeedConfiguration#getAlternativeImgGallery() | String |
|
|
| categoryPathSeparator | Separátor, který je použit při skládání řetězce kategorií | String |
|
|
| exportFileName | Název souboru pro uložení feedu do storage FeedFeatureConfig#getStorage() | String |
|
|
| externalCategorySource | Klíč pro mapování EdeeShop kategorií na externí kategorie dle feedu Dostupné hodnoty:
| String |
|
|
| imgDefault | Relativní URL, která je použita v metodě: | String |
|
|
| imgGallery | Použitý kód galerie pro načtení hlavního obrázku pro feed | String |
|
|
| imgVariant | Kód varianty pro načtení obrázku z galerie FeedConfiguration#getImgGallery() | String |
|
|
| multiplyPriceByPackage | Vlastnost, která určuje, zda má být cena vypočtena dle počtu kusů. | boolean |
|
|
| profile | Kód profilu, který bude použitý při generování snippetu | String |
|
|
| salePrice | Vlastnost, která určuje zda má být vypočtena dvojí cena pro produkt. | boolean |
|
|
| shouldSkipItem | Výraz (SPeL), který definuje, jestli má být produkt pro feed přeskočen. Pro přeskočení produktu existují dvě možné cesty
Dostupné parametry ve SPeLu jsou: | String |
|
|
| snippetTemplate | Šablona, která bude při zpracování snippetu použita Existující šablony v aplikaci:
| String |
|
|
| template | Šablona, která bude při zpracování feedu použita. Při zpracování feedu dochází k načtení již vytvořených snippetů z databáze. Existujicí šablony v aplikaci:
| String |
|
|
profiles/profile
Seznam feed profilů zaregistrovaných pomocí konfigurace. Aplikace obsahuje již předpřipravené profily, které je možné přetížit či vytvořit nové.
Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| code | Unikátní identifikátor profilu katalogu. | String |
|
|
| converters/converter | Konvertery profilu Zdroje hodnot: | List: converters/converter |
|
|
converters/converter
Konvertery profilu
Zdroje hodnot:
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| code | String |
|
| |
| values |
|
