CSV Import entit, které se mají vymazat
CSV Import entit, které se mají vymazat
Dokument popisuje konfiguraci pro import entit, které se mají odstranit. Obecné nastavení pro import a export je zde.
Zkopírovat odkaz na sekciPříklad konfigurace
1 <trashEntities>2 <trashEntity>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 <oldUrl>45 <title>name</title>46 <alternativeTitle/>47 <columnValueDelimiter/>48 <defaultValue/>49 <exportPriority>0</exportPriority>50 <ignoredValues/>51 <importPriority>0</importPriority>52 <lang>cs</lang>53 <mode/>54 <required>true</required>55 </oldUrl>56 </columns>57 <columnValueDelimiter/>58 <createEntityIfMissing/>59 <defaultStatus/>60 <defaultVisibility/>61 <encoding/>62 <entityType/>63 <exportFilter/>64 <exportPageSize/>65 <fileNamePrefix/>66 <mode/>67 <normalizeCode/>68 <pivotProperty/>69 <trashFilter/>70 <trashMode/>71 </trashEntity>72</trashEntities>
Zkopírovat odkaz na sekciPopis
Zkopírovat odkaz na sekcitrashEntities/trashEntity
Konfigurace importu pro hromadný výmaz entit.
| 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/oldUrl | Historické url entity. | List: columns/oldUrl | - | - |
| 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. |
| - | PRIVATE |
| 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 | - | - |
| entityType | Určuje typ entity k výmazu. |
| - | - |
| 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_ONLY |
| 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 |
| trashFilter | Filter, kterým lze omezit rozsah pro výmaz entit. Význam má pouze v případě, že výmaz probíhá v režimu | String | - | - |
| trashMode | Určuje způsob, jakým budou položky vymazány. |
| - | TRASH_MISSING |
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/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 |