CSV Import a export značek
Dokument popisuje konfiguraci pro import a export značek. Obecné nastavení pro import a export je zde.
Příklad konfigurace
<brands> <brand> <systemName>singleImport</systemName> <columns> <entityCode> <title>name</title> <alternativeTitle/> <columnValueDelimiter/> <defaultValue/> <exportPriority>0</exportPriority> <ignoredValues/> <importPriority>0</importPriority> <mode/> <required>true</required> </entityCode> <property> <title>name</title> <aliasOverrideCode/> <alternativeTitle/> <columnValueDelimiter/> <defaultValue/> <exportPriority>0</exportPriority> <ignoredValues/> <importPriority>0</importPriority> <mode/> <propertyName/> <required>true</required> <targetEntity/> </property> <localization> <title>name</title> <alternativeTitle/> <columnValueDelimiter/> <defaultValue/> <exportPriority>0</exportPriority> <ignoredValues/> <importPriority>0</importPriority> <lang>cs</lang> <mode/> <propertyName/> <required>true</required> <targetEntity/> </localization> <gallery> <title>name</title> <alternativeTitle/> <columnValueDelimiter/> <defaultValue/> <exportPriority>0</exportPriority> <galleryCode/> <galleryTitle/> <ignoredValues/> <importPriority>0</importPriority> <mode/> <priorityTitle/> <required>true</required> <targetEntity/> </gallery> <oldUrl> <title>name</title> <alternativeTitle/> <columnValueDelimiter/> <defaultValue/> <exportPriority>0</exportPriority> <ignoredValues/> <importPriority>0</importPriority> <lang>cs</lang> <mode/> <required>true</required> </oldUrl> <tag> <title>name</title> <positiveValues/> <tag/> <alternativeTitle/> <columnValueDelimiter/> <defaultValue/> <exportPriority>0</exportPriority> <ignoredValues/> <importPriority>0</importPriority> <mode/> <queryExtension/> <required>true</required> </tag> </columns> <columnValueDelimiter/> <createEntityIfMissing/> <defaultStatus/> <defaultVisibility/> <encoding/> <exportFilter/> <exportPageSize/> <fileNamePrefix/> <mode/> <normalizeCode/> <pivotProperty/> </brand></brands>
Popis
brands/brand
Konfigurace importu a exportu značek.
| 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/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 | boolean |
|
|
| defaultStatus | Výchozí com.fg.cps.eshop.catalogEntity.model.EdeeShopEntity#setStatus(CatalogEntityStatus) status při nové entity. |
|
|
|
| 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). |
|
|
| 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 |
|
|
| fileNamePrefix | Slouží jako prefix pro název souboru s exportem dat. Název dále obsahuje aktuální čas ve formátu Pokud není definován, použije se | String |
|
|
| mode | Určuje, zda se formát používá pro import, export nebo obojí. |
|
|
|
| normalizeCode | Přepínač normalizace kódu. Pokud je | boolean |
|
|
| 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 |
|
|
columns/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 | String |
|
|
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát ImportEntityDefinition#getColumnValueDelimiter() 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 |
|
|
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String |
|
|
| importPriority | Určuje prioritu zpracování importu atributů. | int |
|
|
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
|
|
|
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota | boolean |
|
|
columns/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 BaseEntityProperty#getPropertyName() | String |
|
|
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle | String |
|
|
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát ImportEntityDefinition#getColumnValueDelimiter() 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 |
|
|
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String |
|
|
| importPriority | Určuje prioritu zpracování v rámci importu. | int |
|
|
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
|
|
|
| propertyName | Název vlastnosti, která má bý importována/exportována. | String |
|
|
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota | boolean |
|
|
| targetEntity | Cílová entita, do které se má hodnota nastavit. Pokud je hodnota rovna com.fg.cps.eshop.importExport.business.processor.editor.BasePropertyEditor#TARGET_ENTITY_MASTER_PRODUCT, 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 |
|
|
columns/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 | String |
|
|
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát ImportEntityDefinition#getColumnValueDelimiter() 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 |
|
|
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String |
|
|
| importPriority | Určuje prioritu zpracování importu atributů. | int |
|
|
| lang | Jazyk lokalizace | String |
|
|
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
|
|
|
| propertyName | Název vlastnosti, která má bý importována/exportována. | String |
|
|
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota | boolean |
|
|
| targetEntity | Cílová entita, do které se má vlastnost nastavit. Pokud je hodnota rovna rovna com.fg.cps.eshop.importExport.business.processor.editor.BasePropertyEditor#TARGET_ENTITY_MASTER_PRODUCT, 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 |
|
|
columns/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 | String |
|
|
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát ImportEntityDefinition#getColumnValueDelimiter() 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 |
|
|
| galleryCode | Kód galerie v rámci konfigurace com.fg.cps.eshop.mediaGallery.MediaGalleryFeature | 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 |
|
|
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
|
|
|
| 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 | boolean |
|
|
| targetEntity | Cílová entita, do které se má galerie importovat. Pokud je hodnota rovna rovna com.fg.cps.eshop.importExport.business.processor.editor.BasePropertyEditor#TARGET_ENTITY_MASTER_PRODUCT, 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 |
|
|
columns/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 | String |
|
|
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát ImportEntityDefinition#getColumnValueDelimiter() 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 |
|
|
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String |
|
|
| importPriority | Určuje prioritu zpracování importu atributů. | int |
|
|
| 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. |
|
|
|
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota | boolean |
|
|
columns/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 vpositiveValues. Ostatní hodnoty nebo prázdná hodnota, znamená, že štítek přiřazen není. Příklad:kódkod produktu; novinka01;ano02;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
kod produktu; štítky01;novinka|akce|doprava zdarma02;
| 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 Příklad: xml | String |
|
|
| alternativeTitle | Název/Názvy pro alternativní sloupec. V případě, že je standardní hodnota prázdná (tzv. hodnota ve sloupci dle | String |
|
|
| columnValueDelimiter | Oddělovač hodnot pro tento sloupec. Pokud není definován použije se delimiter definovaný pro celý formát ImportEntityDefinition#getColumnValueDelimiter() 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 |
|
|
| ignoredValues | Seznam hodnot, které se mají při importu ignorovat. | String |
|
|
| importPriority | Určuje prioritu zpracování importu atributů. | int |
|
|
| mode | Režim určující, zda je možné provádět import, export nebo obojího. |
|
|
|
| queryExtension | String |
|
| |
| required | Určuje, že je hodnota povinná. Tedy pokud je hodnota | boolean |
|
|
