Skip to main content

Typ save-file

Uzel specifikující vlastnosti uložení souboru.

Jde o uzel obsahující text TYP HODNOTY: string;

  <save-file
   path="{string}"
   name="{string}"
   codepage="acp|utf8|utf16|{#no}"
   file-type="txt|xml|pdf|base64|hex"
   content-prefix="{string}"
   not-replace="{boolean}"
   pdf-source="text|xml"
   title="{string}"
   jsdelay="{string}"
   attach="{boolean}"
   zip="{boolean}"
   zipped-file="{string}"
   >
   <{element} ... > ... </{element}>?
    |
   <{fxd-doc-type} dkey="{key}">...</{fxd-doc-type}> *
    |
   {string}
  </save-file>

Atributy​

  • path - podsložka - Volitelná podsložka nebo odkaz na virtuální složku, relativní cesta ke složce cílového souboru (bez jeho názvu); nenpovinná a není-li uvedena, použije se přednastavené uložiště.(typ: string)

  • name - Název ukládaného, tedy cílového souboru v konvenci .; Při vobě attach se ze jména používá pouze přípona. - popis neuveden(typ: string) TYP HODNOTY: string;

  • codepage - Určuje výstupní kódovou stránku pro ukládání obsahu do souboru;(typ: string) TYP HODNOTY: string; Možnosti obsahu: » acp ~ výchozí hodnota - ActualCodePage - využití nastavení defaultní kódové stránky serveru, soubor je ukládán v aktuálním kódování; » utf8 ~ obsah souboru bude uložen v kódování UTF-8; neplatí pro hex a base64 kódování; » utf16 ~ obsah souboru bude uložen v kódování UTF-16; neplatí pro hex a base64 kódování; » \{#no\} ~ uložení v kódování určeném číslem kódové stránky;

  • file-type - Typ souboru - Typ ukládaného souboru. Určuje způsob nakládání s daty, zejména převod escape sekvencí, ale také nabízí převod HTML obsahu do PDF souboru nastavením typu na hodnotu pdf; výchozí hodnotou při neuvedení je text.(typ: string) TYP HODNOTY: string; Možnosti obsahu: » txt ~ Výchozí hodnota při neuvedení. Indikuje textový obsah určený k běžnému uložení do textového souboru. » xml ~ Indikuje parsovaný xml obsah (nikoli serializovaný do textu s využitím escape seqvencí) určený k uložení do XML souboru. » pdf ~ Toto nastavení říká, že se jedná o HTML určené ke konverzi do PDF (výchozí txt) » base64 ~ Obsah uzlu je kódovaný v base64 sekvenci tisknutelných znaků a při uložení dojde k dekódování do původní, většinou binární struktury. » hex ~ Obsah uzlu je kódovaný v hexadecimálním kódu tisknutelných znaků a při uložení dojde k dekódování do původní, většinou binární struktury.

  • content-prefix - Předřadit - Obsah atributu je vložen před samotná ukládaná data (na jejich začátek), může obsahovat například parsovací instrukce pro XML (tedy <?xml version='1.0' encoding='utf-8'?>) nebo názvy sloupců pro CSV, je-li to třeba apod.(typ: string) TYP HODNOTY: string;

  • not-replace - Udává, zda má soubor v případě existence původního tento nahradit, u volby attach je bezpředmětné. - popis neuveden(typ: boolean) TYP HODNOTY: boolean;

  • pdf-source - Zdroj pdf - Určuje, zda je zdrojem pro PDF text nebo XML; výchozí je text, který je tak při převodu na PDF chápán jako kompletní HTML stránka; Jako výchozí při neuvedení je použita volba text.(typ: string) TYP HODNOTY: string; (možnosti obsahu: text | xml)

  • title - Cílový název - Využíváno pouze při převodu na pdf a obsahuje titulek, tedy název cílového souboru(typ: string) TYP HODNOTY: string;

  • jsdelay - Čekání před převodem - Využíváno pouze při převodu na pdf, určuje, jak dlouho před převodem čekat na provedení JavaScriptu uvnitř HTML.(typ: string) TYP HODNOTY: string;

  • attach - Jako přílohu - Speciální možnost, která nahrazuje atribut path a je-li uvedena hodnota true, pak je soubor uložen mezi soubory čekající na přiložení k dokumentu; odpověď pak obsahuje i finální umístění v atributu path (vč. přiděleného jména souboru) a stačí, aby tentýž uživatel, který soubor dal uložit tuto vrácenou cestu použil v některém požadavku save-document, aby byl soubor použit jako příloha takto uloženého dokumentu (přípustné pouze pro uzel <save-files> a <save-file>, nikoli <file>).(typ: boolean) TYP HODNOTY: boolean;

  • zip - Zazipovat - Určuje, zda se jedná o ZIP archiv (soubor), mění další chovaní požadavku - aktivuje komprimaci seznamu ukládaných souborů do jediného výsledného ZIP souboru (ukládá se vždy jen do jednoho zip archívu); při nepoužítí této volby (nebo obsahuje-li false) jsou ukládány samostatné soubory (přípustné pouze pro uzel <save-files> a <save-file>, nikoli <file>);(typ: boolean) TYP HODNOTY: boolean;

  • zipped-file - Jméno zipu - Speciální možnost, která nahrazuje atribut path a je-li uvedena hodnota true, pak je soubor uložen mezi soubory čekající na přiložení k dokumentu; odpověď pak obsahuje i finální umístění v atributu path (vč. přiděleného jména souboru) a stačí, aby tentýž uživatel, který soubor dal uložit tuto vrácenou cestu použil v některém požadavku save-document, aby byl soubor použit jako příloha takto uloženého dokumentu;(typ: string) TYP HODNOTY: string;

Potomci​

Typ save-file umožňuje uvést jeden volitelný element: Kmenový uzel - Kmenový uzel XML obsahu ukládaného do souboru. a nebo umožňuje vložit jeden uzel nebo více uzlů flexideo dokument struktury. Uzel může obsahovat prostý text, pokud neobsahuje XML uzly. Uzel má povolen prázdný obsah.