CSV Import a export kategorií
CSV Import a export kategorií
Dokument popisuje konfiguraci pro import a export kategorií. Obecné nastavení pro import a export je zde.
Zkopírovat odkaz na sekciPříklad konfigurace
1 <categories>2 <category>3 <systemName>singleImport</systemName>4 <columns>5 <entityCode>6 <title>name</title>7 <alternativeTitle/>8 <columnValueDelimiter/>9 <defaultValue/>10 <exportPriority>0</exportPriority>11 <ignoredValues/>12 <importPriority>0</importPriority>13 <mode/>14 <required>true</required>15 </entityCode>16 <property>17 <title>name</title>18 <aliasOverrideCode/>19 <alternativeTitle/>20 <columnValueDelimiter/>21 <defaultValue/>22 <exportPriority>0</exportPriority>23 <ignoredValues/>24 <importPriority>0</importPriority>25 <mode/>26 <propertyName/>27 <required>true</required>28 <targetEntity/>29 </property>30 <localization>31 <title>name</title>32 <alternativeTitle/>33 <columnValueDelimiter/>34 <defaultValue/>35 <exportPriority>0</exportPriority>36 <ignoredValues/>37 <importPriority>0</importPriority>38 <lang>cs</lang>39 <mode/>40 <propertyName/>41 <required>true</required>42 <targetEntity/>43 </localization>44 <gallery>45 <title>name</title>46 <alternativeTitle/>47 <columnValueDelimiter/>48 <defaultValue/>49 <exportPriority>0</exportPriority>50 <galleryCode/>51 <galleryTitle/>52 <ignoredValues/>53 <importPriority>0</importPriority>54 <mode/>55 <priorityTitle/>56 <required>true</required>57 <targetEntity/>58 </gallery>59 <oldUrl>60 <title>name</title>61 <alternativeTitle/>62 <columnValueDelimiter/>63 <defaultValue/>64 <exportPriority>0</exportPriority>65 <ignoredValues/>66 <importPriority>0</importPriority>67 <lang>cs</lang>68 <mode/>69 <required>true</required>70 </oldUrl>71 <parentCategory>72 <title>name</title>73 <alternativeTitle/>74 <columnValueDelimiter/>75 <defaultValue/>76 <exportPriority>0</exportPriority>77 <ignoredValues/>78 <importPriority>0</importPriority>79 <mode/>80 <required>true</required>81 </parentCategory>82 <tag>83 <title>name</title>84 <positiveValues/>85 <tag/>86 <alternativeTitle/>87 <columnValueDelimiter/>88 <defaultValue/>89 <exportPriority>0</exportPriority>90 <ignoredValues/>91 <importPriority>0</importPriority>92 <mode/>93 <queryExtension/>94 <required>true</required>95 </tag>96 </columns>97 <columnValueDelimiter/>98 <createEntityIfMissing/>99 <defaultStatus/>100 <defaultVisibility/>101 <encoding/>102 <exportFilter/>103 <exportPageSize/>104 <fileNamePrefix/>105 <mode/>106 <normalizeCode/>107 <pivotProperty/>108 </category>109</categories>
Zkopírovat odkaz na sekciPopis
Zkopírovat odkaz na sekcicategories/category
Konfigurace importu a exportu kategorií.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| systemName | Unikátní systémový název definice importu/exportu. Název se zobrazuje v AR. | String | ✔ | - |
| columns/entityCode | Definice sloupce, který jednoznačně identifikuje entitu. Povinná hodnota. | ✔ | - | |
| columns/property | Vlastnosti entity (entita musí implementovat MetadataContainerProvider) | List: columns/property | - | - |
| columns/localization | Lokalizované vlastnosti entity. | List: columns/localization | - | - |
| columns/gallery | Media gallerie přiřazené k entitě | List: columns/gallery | - | - |
| columns/oldUrl | Historické url entity. | List: columns/oldUrl | - | - |
| columns/parentCategory | Kód nadřazené kategorie | - | - | |
| columns/tag | Štítky přiřazené k entitě. Štítky lze importovat dvěmi způsoby:
| List: columns/tag | - | - |
| columnValueDelimiter | Oddělovač hodnot v rámci jednoho sloupce. | String | - | \| |
| createEntityIfMissing | Pokud je hodnota true a entita nebyla podle entityCode nalezena, tak se vytvoří nová. | boolean | - | true |
| defaultStatus | Výchozí při nové entity. |
| - | ACTIVE |
| defaultVisibility | Výchozí viditelnost pro nově založené entity. |
Entity is not browsable, searchable, but is still accessible on direct url (detail page).
Entity is browsable, searchable and accessible on direct url (detail page). | - | VISIBLE |
| encoding | Kódování CSV souboru. Pokud není definováno, bere se globální nastavení 'csvIO/encoding'. | String | - | - |
| exportFilter | Filter, kterým lze omezit rozsah dat pro export. | String | - | - |
| exportPageSize | Velikost dávky při exportu dat. | int | - | 100 |
| fileNamePrefix | Slouží jako prefix pro název souboru s exportem dat. Název dále obsahuje aktuální čas ve formátu yyyyMMddHHmmss a příponu .csv. Pokud není definován, použije se systemName hodnota. | String | - | - |
| mode | Určuje, zda se formát používá pro import, export nebo obojí. |
| - | IMPORT_EXPORT |
| normalizeCode | Přepínač normalizace kódu. Pokud je true (default), tak kód z importního souboru projde normalizací. Pokud je false, tak kód se nenormalizuje, ale pouze se validuje. | boolean | - | true |
| pivotProperty | Property entity, podle které se bude mapovat importní data. Standardně bývá kód, ale může být například i název pokud je název v rámci dané entity unikátní. | String | - | code |
Zkopírovat odkaz na sekcicolumns/entityCode
Definice sloupce, který jednoznačně identifikuje entitu. Povinná hodnota.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| title | Název sloupce v importu nebo exportu. | String | ✔ | - |
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle title je prázdná), je možné použít hodnotu z jiných sloupců. Jiné sloupce jsou určeny tímto atributem, kde jako oddělovač pro jednotlivé sloupce je |. | String | - | - |
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát Tedy v rámci jednoho sloupce je možné použít více hodnot, které se oddělují tímto oddělovačem. | String | - | - |
| defaultValue | Pokud je importovaná hodnota prázdná, tak se doplní tato výchozí hodnota. | String | - | - |
| exportPriority | Určuje pořadí sloupců v exportu. | int | - | 0 |
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String | - | - |
| importPriority | Určuje prioritu zpracování importu atributů. | int | - | 0 |
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
| - | IMPORT_EXPORT |
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota true a importní soubor obsahuje daný sloupec, tak je nutné, aby sloupec obsahoval hodnotu. Jinak import entity selže. | boolean | - | false |
Zkopírovat odkaz na sekcicolumns/property
Vlastnosti entity (entita musí implementovat MetadataContainerProvider)
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| title | Název sloupce v importu nebo exportu. | String | ✔ | - |
| aliasOverrideCode | Kód property z pohledu dědění alias-produktů. Nepovinná hodnota, pokud není uvedeno, tak je použita hodnota | String | - | - |
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle title je prázdná), je možné použít hodnotu z jiných sloupců. Jiné sloupce jsou určeny tímto atributem, kde jako oddělovač pro jednotlivé sloupce je |. | String | - | - |
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát Tedy v rámci jednoho sloupce je možné použít více hodnot, které se oddělují tímto oddělovačem. | String | - | - |
| defaultValue | Pokud je importovaná hodnota prázdná, tak se doplní tato výchozí hodnota. | String | - | - |
| exportPriority | Určuje pořadí sloupců v exportu. | int | - | 0 |
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String | - | - |
| importPriority | Určuje prioritu zpracování v rámci importu. | int | - | 1000 |
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
| - | IMPORT_EXPORT |
| propertyName | Název vlastnosti, která má bý importována/exportována. | String | ✔ | - |
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota true a importní soubor obsahuje daný sloupec, tak je nutné, aby sloupec obsahoval hodnotu. Jinak import entity selže. | boolean | - | false |
| targetEntity | Cílová entita, do které se má hodnota nastavit. Pokud je hodnota rovna , tak se vlastnost uloží k master produktu (nastavení má smysl pouze pro varianty). V opačném případě se uloží do aktuálně importované entity. | String | - | - |
Zkopírovat odkaz na sekcicolumns/localization
Lokalizované vlastnosti entity.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| title | Název sloupce v importu nebo exportu. | String | ✔ | - |
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle title je prázdná), je možné použít hodnotu z jiných sloupců. Jiné sloupce jsou určeny tímto atributem, kde jako oddělovač pro jednotlivé sloupce je |. | String | - | - |
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát Tedy v rámci jednoho sloupce je možné použít více hodnot, které se oddělují tímto oddělovačem. | String | - | - |
| defaultValue | Pokud je importovaná hodnota prázdná, tak se doplní tato výchozí hodnota. | String | - | - |
| exportPriority | Určuje pořadí sloupců v exportu. | int | - | 0 |
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String | - | - |
| importPriority | Určuje prioritu zpracování importu atributů. | int | - | 1000 |
| lang | Jazyk lokalizace | String | ✔ | - |
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
| - | IMPORT_EXPORT |
| propertyName | Název vlastnosti, která má bý importována/exportována. | String | - | name |
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota true a importní soubor obsahuje daný sloupec, tak je nutné, aby sloupec obsahoval hodnotu. Jinak import entity selže. | boolean | - | false |
| targetEntity | Cílová entita, do které se má vlastnost nastavit. Pokud je hodnota rovna rovna , tak se vlastnost uloží k master produktu (nastavení má smysl pouze pro varianty). V opačném případě se uloží do aktuálně importované entity. | String | - | - |
Zkopírovat odkaz na sekcicolumns/gallery
Media gallerie přiřazené k entitě
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| title | Název sloupce v importu nebo exportu. | String | ✔ | - |
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle title je prázdná), je možné použít hodnotu z jiných sloupců. Jiné sloupce jsou určeny tímto atributem, kde jako oddělovač pro jednotlivé sloupce je |. | String | - | - |
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát Tedy v rámci jednoho sloupce je možné použít více hodnot, které se oddělují tímto oddělovačem. | String | - | - |
| defaultValue | Pokud je importovaná hodnota prázdná, tak se doplní tato výchozí hodnota. | String | - | - |
| exportPriority | Určuje pořadí sloupců v exportu. | int | - | 0 |
| galleryCode | Kód galerie v rámci konfigurace | String | - | - |
| galleryTitle | Název sloupečku s textem k obrázku - to co se vyplňuje tady | String | - | - |
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String | - | - |
| importPriority | Určuje prioritu zpracování importu atributů. | int | - | 0 |
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
| - | IMPORT_EXPORT |
| priorityTitle | Název sloupečku, ve kterém je určena priorita zobrazení daného media. Pokud není uvedeno je jako default 0; | String | - | - |
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota true a importní soubor obsahuje daný sloupec, tak je nutné, aby sloupec obsahoval hodnotu. Jinak import entity selže. | boolean | - | false |
| targetEntity | Cílová entita, do které se má galerie importovat. Pokud je hodnota rovna rovna , tak se mediaGallery uloží k master produktu (nastavení má smysl pouze pro varianty). V opačném případě se uloží do aktuálně importované entity. | String | - | - |
Zkopírovat odkaz na sekcicolumns/oldUrl
Historické url entity.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| title | Název sloupce v importu nebo exportu. | String | ✔ | - |
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle title je prázdná), je možné použít hodnotu z jiných sloupců. Jiné sloupce jsou určeny tímto atributem, kde jako oddělovač pro jednotlivé sloupce je |. | String | - | - |
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát Tedy v rámci jednoho sloupce je možné použít více hodnot, které se oddělují tímto oddělovačem. | String | - | - |
| defaultValue | Pokud je importovaná hodnota prázdná, tak se doplní tato výchozí hodnota. | String | - | - |
| exportPriority | Určuje pořadí sloupců v exportu. | int | - | 0 |
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String | - | - |
| importPriority | Určuje prioritu zpracování importu atributů. | int | - | 0 |
| lang | Jazyk, ke kterému se url vztahuje. | String | ✔ | - |
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
| - | IMPORT_EXPORT |
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota true a importní soubor obsahuje daný sloupec, tak je nutné, aby sloupec obsahoval hodnotu. Jinak import entity selže. | boolean | - | false |
Zkopírovat odkaz na sekcicolumns/parentCategory
Kód nadřazené kategorie
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| title | Název sloupce v importu nebo exportu. | String | ✔ | - |
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle title je prázdná), je možné použít hodnotu z jiných sloupců. Jiné sloupce jsou určeny tímto atributem, kde jako oddělovač pro jednotlivé sloupce je |. | String | - | - |
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát Tedy v rámci jednoho sloupce je možné použít více hodnot, které se oddělují tímto oddělovačem. | String | - | - |
| defaultValue | Pokud je importovaná hodnota prázdná, tak se doplní tato výchozí hodnota. | String | - | - |
| exportPriority | Určuje pořadí sloupců v exportu. | int | - | 0 |
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String | - | - |
| importPriority | Určuje prioritu zpracování importu atributů. | int | - | 0 |
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
| - | IMPORT_EXPORT |
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota true a importní soubor obsahuje daný sloupec, tak je nutné, aby sloupec obsahoval hodnotu. Jinak import entity selže. | boolean | - | false |
Zkopírovat odkaz na sekcicolumns/tag
Štítky přiřazené k entitě.
Štítky lze importovat dvěmi způsoby:
- Sloupec reprezentuje jeden štítek (viz tag) a hodnoty v jednotlivých řádcích udávají, zda daný produkt má/nemá přiřazen štítek.
Výčet hodnot, které přiřadí štítek k entitě je definován v positiveValues. Ostatní hodnoty nebo prázdná hodnota, znamená, že štítek přiřazen není. Příklad:
1 kod produktu; novinka201;ano302;ne
- Sloupec obsahuje výčet všech štítků přiřazených k produktu. Pokud je hodnota prázdná, jsou všechny štítky odebrány. Pokud některý ze štítku není definován, je zobrazena příslušná chybová hláška. Příklad:
csv
1 kod produktu; štítky201;novinka|akce|doprava zdarma302;
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| title | Název sloupce v importu nebo exportu. | String | ✔ | - |
| positiveValues | Hodnoty, které určují, že štítek má být přidělen k entitě. | String | - | - |
| tag | Pokud je hodnota vyplněna, tak hodnota určuje štítek (přesněji Tag#getSystemId()), který se k entitě přidělí pokud je hodnota importu odpovídá nějaké hodnotě z . Příklad: xml 1 <tag>2 <title>Novinky</title><!-- název štítku -->3 <tag>novinka</tag><!-- systemId štítku -->4 <positiveValues><!-- hodnoty, které určují, že štítek má být přidělen k entitě -->5 <value>ano</value>6 <value>Ano</value>7 </positiveValues>8</tag> | String | - | - |
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle title je prázdná), je možné použít hodnotu z jiných sloupců. Jiné sloupce jsou určeny tímto atributem, kde jako oddělovač pro jednotlivé sloupce je |. | String | - | - |
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát Tedy v rámci jednoho sloupce je možné použít více hodnot, které se oddělují tímto oddělovačem. | String | - | - |
| defaultValue | Pokud je importovaná hodnota prázdná, tak se doplní tato výchozí hodnota. | String | - | - |
| exportPriority | Určuje pořadí sloupců v exportu. | int | - | 0 |
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String | - | - |
| importPriority | Určuje prioritu zpracování importu atributů. | int | - | 0 |
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
| - | IMPORT_EXPORT |
| queryExtension | String | - | - | |
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota true a importní soubor obsahuje daný sloupec, tak je nutné, aby sloupec obsahoval hodnotu. Jinak import entity selže. | boolean | - | false |