Požadavek do-force-import
Účel a dopady
Naplánuje force-import fxd dokumentů (import velkých dat s vynuceným pozastavením serveru) jako úlohu cronu. Požadavek jen zaeviduje úlohu a vrací se okamžitě; skutečný import proběhne asynchronně při běhu úlohy.
Dostupnost, kontext, oprávnění apod.
- Vyžaduje aktivovanou vlastnost uživatele
p_fimport(interně rolir_fimport) nebop_admin(r_admin). - Nastavit
repeat/failsafena cokoli jiného nežnone/prázdné vyžaduje navícr_repeatnebor_admin. - Podléhá standardnímu transakčnímu zpracování obálky
<request>.
XML požadavek (syntax + popis)
<request>
<do-force-import
validity="{string}"
repeat="{string}"
failsafe="{string}"
sched-from-end="{bool}"
when-off="{bool}"
run-as="{number}"
by-action="{bool}"
db-log="{bool}"
folder="{string}"
test="{bool}"
delete="{bool}"
keep-temp="{bool}"
/>
</request>
Parametry a pravidla (atributy, potomci)
Plánovací atributy (validity, repeat, failsafe, sched-from-end, when-off, run-as, by-action, db-log) mají stejný význam jako u do-export – viz sdílený typ do-task.
Vlastní atributy:
folder- Podsložka pro import - Volitelná podsložka, v níž se hledají soubory k force-importu; zároveň slouží jako název úlohy. (typ:string; nepovinný)test- Zkušební běh bez uložení. (typ:bool; nepovinný; výchozí:false) – v dosavadní dokumentaci zcela chyběl.delete- Výmaz souborů po importu. (typ:bool; nepovinný; výchozí:false)keep-temp- Ponechat dočasné soubory po běhu. (typ:bool; nepovinný; výchozí:false) – v dosavadní dokumentaci zcela chyběl.
Odebráno: atribut self uváděný dosavadní dokumentací se vůbec nečte.
Požadavek nemá žádné potomky.
Příklady požadavku
(Zatím bez ověřeného příkladu.)
Zpracování a vedlejší účinky
Skutečný force-import (čtení souborů, zápis do databáze, případný výmaz) proběhne až při běhu úlohy (asynchronně), ne v okamžiku přijetí požadavku.
XML odpověď (syntax + popis)
<response>
<do-force-import
status="ok|error"
id="{number}"
next-run="{string}"
detail="{string}"
/>
</response>
Kořenový element odpovědi má vždy stejný název jako uzel požadavku – popis obsahu viz sdílený typ do-task-result (v době revize bez next-run).
Příklady odpovědi
(Zatím bez ověřeného příkladu.)
Chyby a reakce
status="error" detail="Nemate patricna opravneni"– volající nemár_fimportanir_admin.status="error" detail="Systemova chyba pri vkladani pozadavku"– jednotná chyba pro ostatní případy selhání založení úlohy.status="skip" detail="Transakce byla preskocena"/status="error" detail="Transakce byla odvolana"– transakční přeskočení/odvolání obálky.