Skip to main content

Požadavek do-export

Zadání exportu fxd dokumentů.

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

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

  <request>
   <do-export
    validity="{string}"
    repeat="{string}"
    sched-from-end="{boolean}"
    when-off="{boolean}"
    failsafe="{string}"
    sched-from-end="{boolean}"
    doc-type="{string}"
    rel-folder="{string}"
    file-ext="{string}"
    file-caption="{string}"
    extend-caption="true|false|file|date|time"
    file-type="xml|text"
    >
    <sql-query ... /> ?
    <xsl:stylesheet ... /> ?
   </do-export>
  </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 exportní složky dle nastavení serveru(typ: string) TYP HODNOTY: string;

  • file-ext - Přípona - Přípona exportovaného souboru.(typ: string) TYP HODNOTY: string;

  • file-caption - Název - Základ názvu souboru doplněný o příponu a příp. i číslování.(typ: string) TYP HODNOTY: string;

  • extend-caption - Číslování - Určuje způsob číslování souborů: true - nepřerušená vzestupná řada, file - o jedna vyšší číslo než je nejvyšši číslo již existujícího souboru, date - k názvu souboru přidá datum, time - k názvu souboru přidá datum a čas.(typ: string) TYP HODNOTY: string; (možnosti obsahu: true | false | file | date | time)

  • file-type - Jeden z exportních typů xml|text (jde o typ xsl transformace). (možnosti obsahu: xml | text)

Potomci​

Odpověď​

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

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

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

  <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-export[@status='error'] (odkaz na popis detailu: @detail).

Uzel sql-query​

Popis uzlu sql-query, který je potomkem uzlu do-export je umístěn v popisu typových uzlů.

Bližší popis viz. sql-query v popisu typu do-task.

Uzel xsl:stylesheet​

Exportní šablona aplikovaná na sql-query-result.

  <xsl:stylesheet>
   <{element} ... > ... </{element}>*
  </xsl:stylesheet>

Prvek xsl:stylesheet se nachází ve jmenném prostoru http://www.w3.org/1999/XSL/Transform.

Atributy​

Uzel xsl:stylesheet nabízí možnost uvést libovoný atribut.

Potomci​

Uzel xsl:stylesheet umožňuje uvést nepovinný, ale opakovatelný element - Tělo exportní šablony