Kategorie

Seznam obsahových bloků.

Aby byly obsahové bloky pro tento typ entit povoleny, musí být definován alespoň jeden obsahový blok.

Pokud již existuje schéma v evitaDB, zapnutí této feature vyžaduje FULL reindexaci evitaDB.

Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.

blockConfig

-

-

Konfigurace providerů poskytující data publikovaných entit pro fulltext indexaci dané sekce (FulltextSectionConfig#getProviders()).

List: fulltextConfig/providers/provider

-

-

Seznam konfigurací fulltext sekcí. Na základě této konfigurace se následně vytvářejí sekce, které se registrují do fulltext modulu. Také se automaticky zaregistrují providery, poskytující data o publikovaných entitách pro potřeby fulltextu.

V případě, že je seznam prázdný, tak se entita nebude indexovat, tedy nebude vyhledatelná přes fulltext.

Více o konfiguraci fulltextu zde.

List: fulltextConfig/sections/section

-

-

Konfigurace médií pro daný typ entity.

Konfigurace se po inicializaci registruje do mediaGalleryFeature, odkud s ním nadále tato feature pracuje.

mediaConfig

-

-

Konfigurace štítků.

Jedná se o seznam, který primárně obsahuje systémové id kategorie štítků. V rámci entity je pak možné pracovat se štítky, které jsou zařazeny do těchto kategorií (pozor nejedná se o kategorie produktů, ale kategorie štítků).

Konfigurace dále obsahuje informaci, zda se tyto štítky mají publikovat nebo zda se mají zobrazit ve filtru produktů na FE.

tagConfig

-

-

Pravidla pro generování URL pro entity e-shopu, které mají na FE svůj vlastní detail, tedy produkty, kategorie, značky, skupiny.

Pravidla se aplikují v pořadí, ve kterém jsou definována. Url se vygeneruje pro první pravidlo, pro které je splněna podmínka a zároveň se podaří vygenerovat url.

Pokud nejsou definována žádná pravidla, tak se použije výchozí pravidlo, které obsahuje tyto 3 vzory:

• normalize(edeeShopEntity.name),
• normalize(edeeShopEntity.catalogNumber),
• edeeShopEntity.code.

Tedy nejprve se URL generuje z názvu. Pokud se to nepodaří, tak se url generuje z katalogového čísla. Poslední pokus je generování URL z kódu. Standardně se však url vygeneruje vždy z názvu.

urlConfig

-

-

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

-

-

Konfigurace vytváření fulltext indexu

builder

✔

-

Query ovlivňující načtení kategorií, které má provider poskytnout k indexaci.

Pokud je null, pak se použije výchozí query, která vrací všechny kategorie. Resp. všechny kategorie, které jsou k dispozici v daném katalogu pro anonymního uživatele.

CategoryQuery

-

-

Identifikace provideru pro fulltext modul. Identifikátor musí být unikátní napříč všemi providery ve všech katalozích.

Dle této hodnoty se mapují providery definované v rámci sekcí v atributu providers (viz SectionConfig#getProviders()).

String

✔

-

Seznam výrazů (SpEL), které vrací hodnoty, které se pro danou entitu zapíší do data. Výraz je definován hodnot pro klíč Tyto data jsou uložena u výsledků fulltext pro následné použití (více viz dokumentace fulltext modulu).

Ve výrazu lze přistupovat přímo k publikované entitě.

Příklady výrazu:

• 'productType' - textová hodnota pro klíč productType pod kterým bude hodnota uložena v datech.
• subType.name -
• catalogNumber -

Ve výchozím nastavení se do data ukládá id entity, pod klíčem id. Pro produkty pak dále typ produktu, kód master produktu a kód pod kterým se mají seskupovat varianty.

dataList/data

-

-

Výchozí boost dokumentů.

Výpočet boost lze projektově ovlivnit pomocí vlastní implementace com.fg.cps.eshop.catalog.cps.fulltext.service.FulltextResourceBoostResolver. Tuto implementaci následně stačí registrovat do aplikačního kontextu.

float

-

10000.0

Kód galerie, která se použije při získávání url obrázku, které se exportuje pro každý produkt v sitemap.

String

-

-

Seznam výrazů (SpEL), které vrací hodnoty, které se pro danou entitu indexují. Podle těch hodnot fulltext vyhledává entity.

Ve výrazu lze přistupovat přímo k publikované entitě.

Příklady výrazu:

• name - zaindexuje název entity v aktuální jazyce (jazyce regionu, pro který se generuje index)
• code
• descriptionShort
• catalogNumber
• getLocalizedTextByCode("fulltextKeywords") - zaindexuje hodnotu z lokalizovaného textu s kódem fulltextKeywords

String

-

-

Seznam výrazů (SpEL), které vrací hodnoty, které se pro danou entitu indexují jako promoKeywords (více viz dokumentace fulltext modulu).

Ve výrazu lze přistupovat přímo k publikované entitě.

Příklady výrazu:

• code
• descriptionShort
• getLocalizedTextByCode("fulltextKeywords") - zaindexuje hodnotu z lokalizovaného textu s kódem fulltextKeywords

Výchozí hodnota je "getLocalizedTextByCode("fulltextKeywords")".

String

-

[getLocalizedTextByCode("fulltextKeywords")]

Fulltext ve výchozím nastavení vyhledává podle názvu dokumentů, v případě e-shopu např. podle názvu produktů. Toto chování je možné vypnout pomocí tohoto atributu, kdy pro vypnutí nastavte hodnotu na false.

Boolean

-

-

Seznam výrazů (SpEL), které vrací hodnoty, které se pro danou entitu zapíší do variables. Podle nich lze následně výsledky fulltextu filtrovat (více viz dokumentace fulltext modulu).

Ve výrazu lze přistupovat přímo k publikované entitě.

Příklady výrazu:

• productType.name - do variables se zapíše typ produktu,
• hasTag("checkTag") ? "checkTag" : null

String

-

-

kód varianty obrázku, která se použije při získávání url obrázku, které se exportuje pro každý produkt v sitemap

String

-

-

Výraz (SpEL), který vrací název data, tedy klíč pod kterým bude hodnota z výrazu dataValue uložena v datech.

String

-

-

Výraz (SpEL), který vrací hodnotu data, která se uloží pod klíčem dataName.

String

-

-

Analyzer fulltext modulu, pokud není uvedeno, tak se použije analyzer dle jazyku aktuálního regionu nebo katalogu.

Konkrétně:

• pro en universal
• pro de universal
• pro sk universal
• pro pl universal
• pro všechny ostatní czech-fg

Seznam podporovaných analyzátorů je uveden v zde.

Pokud je potřeba specifikovat analyzátor pro jednotlivá pole dokumentu, použijte #fieldAnalyzers.

String

-

-

Definice analyzátorů pro jednotlivá pole fulltext dokumentu.

Pokud není definováno, použije se analyzátor uvedený v #analyzer.

List: fieldAnalyzers/fieldAnalyzer

-

-

Identifikátor sekce v rámci katalogu a regionu. Musí být unikátní. Povinná hodnota. Typickým příkladem hodnoty je: products,categories.

Pozn.: Název sekce (=identifikátor) se generuje podle klíče: catalog_region_fragment, kde catalog, region a fragment jsou nahrazeny odpovídajícími hodnotami.

String

-

-

Seznam poskytovatelů (přesněji jich FulltextResourceProvider#getType()) dat pro danou sekci. Poskytovatelé jsou vyhledávány v aplikaci a musí implementovat com.fg.fulltext.provider.FulltextResourceProvider.

Povinná položka.

String

-

-

Seznam regionů, pro které se má sekce generovat. Pokud není uvedeno, generují se sekce pro všechny regiony v rámci daného katalogu.

regions/region

-

-

ID sitemap. Více zde: https://edee.dev/cs/git/fulltext/sections/sitemap-generating/microsites.md

String

-

-

Název analyzátoru, který se má použít pro dané pole.

Povolené názvy analyzátorů jsou ty, které jsou definovány v com.fg.fulltext.core.index.IndexFactory#analyzerConstructorsMap, standardně např.: czech-edee-summon, czech-edee, czech-fg-summon, universal, apod.

Seznam podporovaných analyzátorů je uveden v zde.

String

✔

-

Název pole fulltext dokumentu, ke kterému se analyzátor přiřazuje.

Seznam povolených názvů polí je uveden v com.fg.fulltext.core.document.DocumentFieldConstant, standardně např.: title nebo content.

String

✔

-

Kód země (ISO 3166 - 2 znaky).

Povinná hodnota.

String

-

-

Měna regionu ( ISO 4217 - 3 znaky).

Povinná hodnota.

currency

-

-

Kód jazyka (ISO 639 - 2 znaky).

Povinná hodnota.

locale

-

-