flexideo

Požadavek do-action

Spouštění flexideo akcí

Server umožňuje spouštět transformační akce nastavené jako služby pomocí soap rozhraní odloženě nebo opakovatelně. Pro tyto účely existuje možnost spustit úlohu požadavkem do-action.

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

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

syntax 
<request>
<do-action
validity="{string}"
repeat="{string}"
sched-from-end="{boolean}"
when-off="{boolean}"
failsafe="{string}"
sched-from-end="{boolean}"
name="{string}"
call-type="{string}"
>
<{element} ... > ... </{element}>?
</do-action>
</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;

name - Typový název - Název akce, která má být spouštěna.(typ: string)

call-type - Typ volání akce(typ: string) TYP HODNOTY: string;


Potomci

Požadavek do-action umožňuje uvést jeden volitelný element: SOAP obálka - Uzel Envelope xmlns='http://schemas.xmlsoap.org/soap/envelope/'


Poznámka k request

Význam jednotlivých typů volání viz. technický popis akcí voláných přes rozhraní soap.


Odpověď

Odpovědí na požadavek do-action není logicky zpráva o provedení akce, ale pouze zpráva o nastavení úlohy a předání celočíselného id této úlohy přidělené serverem.

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

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

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

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

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

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


Další info

Obsah uzlu je možné chápat jako jako postovou část soapu, get část by pak zase bylo možné poskládat dle syntaxe:

https://{flexideo}/soap/{@call-type}/{@name}

V rámci volání akcí mohou existovat tři typy volání:

service

table

form

Popis interního protokolu akcí pro vložení do těla zprávy najdete v popisu schematu run-action.

Totéž co umožňuje do-action provádět odloženě a nebo opakovaně umožňuje požadavek action provádět okamžitě bez odkládání se stejnou strukturou požadavku.

Aby uživatel mohl tento požadavek používat, musí mít ve vlastnostech uživatele aktivováno oprávnění p_doaction nebo p_admin.

Viz. též příklad do-action.

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