flexideo

Požadavek do-import

Zadání importu fxd dokumentů.

Uzel obsahující požadavek na plán úlohy.

Základní typ(y) uzlu(ů): do-task;

syntax 
<request>
<do-import
validity="{string}"
repeat="{string}"
sched-from-end="{boolean}"
when-off="{boolean}"
failsafe="{string}"
sched-from-end="{boolean}"
doc-type="{string}"
rel-folder="{string}"
file-mask="{string}"
file-type="xml|csv"
tran="{number}"
attached-data="{boolean}"
>
<column ... /> *
<data ... /> ?
</do-import>
</request>

Atributy

validity - Určuje platnost úlohy. Spec. povinná syntaxe: [once]|today|still|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}] (typ: string) TYP HODNOTY: string;

repeat - Určuje případné opakování úlohy. Spec. povinná syntaxe: [none]|hourly|daily|weekly|monthly|yearly|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}][;each-nn-(minutes|hours|days|weeks|months)[[-xx]...]][;at-{#hh:mm}] (typ: string) TYP HODNOTY: string;

sched-from-end - Říká, zda je interval opakování úlohy počítán od jejího ukončení. Umožňuje přesnější návaznost.(typ: boolean) TYP HODNOTY: boolean;

when-off - Zapíná ošetření při vypnutí. Je-li úloha zadána s when-off=true a vyjde-li její provedení na dobu, kdy je server mimo provoz, dojde ke spuštění úlohy po obnovení činnosti serveru.(typ: boolean) TYP HODNOTY: boolean;

failsafe - Určuje případné opakování úlohy vyskytne-li se při jejím provádění chyba. Syntaxe shodná s nastavením repeat: [none]|hourly|daily|weekly|monthly|yearly|from-{#YYYY-MM-DD}[;to-{#YYYY-MM-DD}][;each-nn-(minutes|hours|days|weeks|months)[[-xx]...]][;at-{#hh:mm}] (typ: string) TYP HODNOTY: string;

sched-from-end - Časování od konce úlohy.(typ: boolean) TYP HODNOTY: boolean;

doc-type - typ dokumentu - Typový název dokumentu definovaného v XDS.(typ: string)

rel-folder - Volitelná podsložka importní složky dle nastavení serveru(typ: string) TYP HODNOTY: string;

file-mask - Souborová maska - Např. *.csv - dle této masky server vyhledává soubory k importu v importní složce či podsložce.(typ: string) TYP HODNOTY: string;

file-type - Jeden z importních typů xml|csv(typ: string) TYP HODNOTY: string; (možnosti obsahu: xml | csv)

tran - Jeden z typů transakčnosti určený číslicí 1 | 2 | 3 (1 - řádek, tj. bez transakčnosti, 2 - soubor = transakce (doporučeno), 3 - všechny soubory = 1 transakce).(typ: number) TYP HODNOTY: number;

attached-data - Data v požadavku - Nastavení určuje, zda se importuje ze souboru (false) nebo se importují data přiložená k požadavku (true) - tzv. row-import.(typ: boolean) TYP HODNOTY: boolean;


Potomci


Uzel column

Popisuje sloupec, který má být importován a to v odpovídajícím pořadí řazení sloupců v datech.

syntax 
<column
xds-id="{number}"
/>

Atributy

xds-id - Jedinečný identifikátor segmentu informační struktury v její definici.(typ: number)


Potomci

Uzel column neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.


Uzel data

Uzel s daty, pokud jde o row-import, kdy jsou data obsažena v požadavku.

syntax 
<data>
<row ... /> *
</data>

Atributy

Uzel data neobsahuje žádné atributy.


Potomci

Uzel reprezentující jeden řádek z importované tabulky dat.

syntax 
<row/>

Atributy

Uzel row nabízí možnost uvést libovoný atribut.


Potomci

Uzel row neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.


Odpověď

Uzel s informací o naplánované úloze.

Základní typ(y) uzlu(ů): do-task-result;

Struktura odpovědi na požadavek do-import vrácená v obálce response:

syntax 
<response>
<do-task-result
status="ok|error"
detail="{string}"
id="{number}"
/>
</response>

Popis obsahu elementu do-task-result viz. popis typu do-task-result.

Výraz pro identifikaci chyb v odpovědi serveru: do-import[@status='error'] (odkaz na popis detailu: @detail).

Požadavek do-importPožadavek do-exportPožadavek do-force-importPožadavek do-requestPožadavek do-actionPožadavek job-listPožadavek undo