- potřebné oprávnění pro editaci dokumentů = DOCUMENT_MODULE
- Po vytvoření se dokument zobrazí v agendě vybrané kontextem [1.1 a 2.1].
¶ Skrývání/Zobrazování dokumentů na detailu agendy z kontextu
-
Na základě Role – pole Povoleno pro role [1.2]
- VIDITELNÝ PRO VŠECHNY - necháme pole prázdné.
- VIDITELNÝ pro specifickou/é skupinu/y lidí – vyplníme role lidí, kteří mají dokument vidět.
- NEVIDITELNÝ pro všechny – vytvoříme speciální roli čistě pro skrývání dokumentů, kterou nebude mít nikdo přiřazenou. -
Na základě Typů dokumentů
- Aktuálně (k 13.5.2025) je možné filtrovat dokumenty na detailu Účetního dokladu podle Typu účetního dokladu, resp. jeho Typů dokumentů.- Dokument se zobrazí, pokud existuje alespoň 1 shodný Typ (nemusí se shodovat všechny).
- Využití: např. pro faktury budeme zobrazovat jiné dokumenty, než pro dobropisy atp.
V rámci kontextu Objednávka (agenda Prodejní objednávky) máme vytvořené 2 Dokumenty. Dokument s ID 4 je dodaný parametrizací, což poznáme podle upozornění [1.5] a vyplněného kódu [1.4]. Parametrizační dokumenty neupravujeme, ale pro provedení změny zkopírujeme jejich obsah a vytvoříme nový dokument. Nový dokument zobrazíme pouze požadovaným rolím [2.2] (nebo všem) a naopak parametrizační doument, který byl dosud zobrazován všem [1.2], nastavením rolí skryjeme, takže se nebude zobrazovat na detailu vybrané agendy.
U parametrizačních dokumentů upravujeme pouze pole, která se při aktualizaci systému nepřepíší. Jedná se o Povoleno pro role, Počet, Váha řazení, Šablona e-mailu a Skript po odeslání.
Pokud existuje alespoň jeden dokument s kontextem aktuální agendy, který nám není skrytý, zobrazí se na detailu karta Dokumenty [3.1]. Dokumenty s vyšší Váhou řazení [2.3] se zobrazí dříve [3.2]. Parametrizační dokumenty jsou podbarveny modře [3.3]. V závislosti na zvolené šabloně se nám zobrazí příslušné možnosti generování/vyplnění dokumentu a jeho stažení [3.4]/zobrazení [3.5]. Každý dokument lze navíc odeslat e-mailem [3.6].
Dokument je tvořen šablonou a do ní doplněnými daty.
- Šablonu dokumentu můžeme:
1. Vložit – na výběr máme z několika formátů.
2. Vytvořit
¶ Tvorba šablony
- šablony děláme v HTML a CSS, kód zapisujeme do karty Nastavení HTML šablony
Pro snazší tvorbu šablon použijte funkci náhledu kliknutím na ikonu oka .
V rámci šablony rozlišujeme hlavičku, tělo a patičku. Hlavička a patička se automaticky opakují na každé stránce vygenerovaného dokumentu v záhlaví, respektive v zápatí. Tělo představuje hlavní a zároveň povinnou část dokumentu (pokud šablonu nevkládáme souborem).
Doporučujeme zachovávat vzhled hlavičky a patičky šablony napříč dokumenty. Za tímto účelem jsme pro vás vytvořily fragmenty.
Pozor, nezaměňujte hlavičku, tělo a patičku šablony s HTML tagy
<head>,<body>a<footer>. Jednotlivé části šablony NEJSOU EKVIVALENTY tagů a v rámci každé části zapisujeme potřebné tagy zvlášť.
- Pro promítnutí dat do HTML používáme Mustache NEBO Jexl. Mustache je výchozí volbou, pro použití Jexlu zaškrtneme zatržítko Jexl [2.5].
- Data získáváme třemi způsoby (v rámci jednoho dokumentu můžeme kombinovat všechny způsoby):
- SQL dotazem,
- předpřipravenými zástupkami,
- Jexlem v rámci šablony – na základě zástupky
entityzískáváme další potřebná data dle pravidel Jexlu.
¶ Formátování
- Jak naformátovat jexl?
- Mustache: Text formátujeme pomocí funkcí, a to tak, že se požadovaný text vloží do sekce Mustache s názvem dané funkce, tedy například výsledkem {{#formatNumber}}1234567{{/formatNumber}} by bylo 1 234 567.
| Název funkce | Originál | Výsledek | Komentář |
|---|---|---|---|
| formatNumber | 1234567.7891 | 1 234 567,7891 | pokud není žádné číslo, nezobrazí se nic |
| formatNumberOrZero | jako formatNumber, ale pokud není žádné číslo, zobrazí se nula | ||
| formatCurrency | 1234567.7891 | 1 234 567,79 | pokud není žádné číslo, nezobrazí se nic |
| 1234567 | 1 234 567 | ||
| formatCurrencyOrZero | jako formatCurrency, ale pokud není žádné číslo, zobrazí se nula | ||
| formatCurrencyDecimal | 1234567.7891 | 1 234 567,79 | pokud není žádné číslo, nezobrazí se nic |
| 1234567 | 1 234 567,00 | ||
| formatCurrencyDecimalOrZero | jako formatCurrencyDecimal, ale pokud není žádné číslo, zobrazí se 0,00 | ||
| formatDate | 1999-05-04 | 04.05.1999 | |
| formatMonth | 1999-05-04 | 05/1999 | |
| convertMarkdownToHtml | ## Nadpis2 | <h2>Nadpis2</h2> |
pro správné konvertování obrázků je třeba do html hlavičky vložit <base href="{{#queryString}}{{/queryString}}">, eventuelně obrázkům nastavit absolutní cestu |
| queryString | {{#queryString}}nejaky text{{/queryString}} | https://my-company-name.factorify.cloudnejaky text |
|
| storagePath | {{#storagePath}}nejaky text{{/storagePath}} | https://my-company-name.factorify.cloud/nejaky text |
|
| encodeFileToBase64 | {{#encodeFileToBase64}}adresa obrázku{{/encodeFileToBase64}} | Pro zobrazení obrázku: <img src="{{#encodeFileToBase64}}adresa obrázku{{/encodeFileToBase64}}"> |
¶ HTML Zástupky
- Slouží k rychlému přístupu k vybraným frekventovaně používaným datům.
- Zápis zástupky upravíme v závislosti na zvoleném způsobu zobrazení:
- Mustache ->
{{currentUser}} - Jexl ->
${currentUser}
- Mustache ->
| Zástupka | Popis | Použití / Odvozené zástupky* | |
|---|---|---|---|
currentUser |
entita aktuálně přihlášeného uživatele | jméno člověka: currentUser.lastnameFirstname |
y |
today |
dnešní datum | ||
myCompany |
entita mé Společnosti dle aktuálně zvolené účetní jednotky | myCompany.www, myCompany.name... |
|
myBillingAddress |
entita mé doručovací Adresy | myBillingAddress.name, myBillingAddress.addressLine, myBillingAddress.zip... |
|
myBillingAddressForAccountingUnit |
entita Adresy nastavené na Účetní jednotce | stejné jako pro myBillingAddress | |
logoUrl |
url malého loga společnosti, které je nahráno na Účetní jednotce; použito v parametrizovaných dokumentech | Mustache: <img src="{{#encodeFileToBase64}}{{logoUrl}}{{/encodeFileToBase64}}"> Jexl: <img src="${files.encodeFileToBase64(logoUrl)}"> |
|
mediumLogoUrl |
url středního loga společnosti, které je nahráno na Účetní jednotce | viz logoUrl | |
companyColor |
barva společnosti nastavená na Účetní jednotce | ||
companyFileNumberText |
hodnota pole Zápis v obchodním rejstříku na Účetní jednotce | ||
title |
název dokumentu | ||
id |
id entity, ze které se tiskne dokument | ||
entity |
entita, ze které se tiskne dokument; při použití Jexlu na základě této zástupky většinou získáváme všechna potřebná data | specifické dle entity | |
accountingUnit |
entita aktuální účetní jednotky | accountingUnit.name, accountingUnit.address, accountingUnit.company, accountingUnit.accountingJournalStartingDate, accountingUnit.isDefault ... |
*Pro zjištění, jaká pole existují u zástupek pro entity, se použije zástupka pro celou entitu (například myCompany), tak se zobrazí všechna pole i s hodnotami a následně je možné vybrat požadovaná pole.
Entita často obsahuje další vnořené entity - jejich data také můžeme zobrazit: např.
accountingUnit.address.typezobrazí typ adresy.
¶ Získávání dat SQL dotazem
- Dotaz (nebo-li query) píšeme v PSQL a výsledek je ve formátu JSON.
Na konci dotazu nepíšeme středník!
-
Rozlišujeme 2 druhy parametrů:
- Doplněné – pod polem pro dotaz přidáme do Parametrů dotazu nový parametr, jehož kód následně použijeme v dotazu a při generování dokumentu doplníme jeho hodnotu.
- Předdefinované (query zástupky) – zadáváme do dotazu ve formátu
:nazevParametru; zástupky často vyžadují přidání Parametrů dotazu s předem definovanými kódy (viz sloupec Podmínka).
Parametr (zástupka) Poskytnutá data Podmínka Poznámka :accountingUnitIdID aktuální účetní jednotky x :balanceSheetList<QueryAccountingStatementRow>***parametry dotazu s kódy startDateaendDate, nepovinněcostCenterId,projectId:balanceSheetValidationList<AccountDocumentBalance>=[{"accountNumber", "kind", "ignoreInStatements", "amount", "initialAmount"}]***parametry dotazu s kódy startDateaendDate, nepovinněcostCenterId,projectId:batchBomBatchBillOfMaterial={"batchId", "carrierId", "goodsId", "goodsCode", "goodsName", "quantity", "parts"}**parametr dotazu s kódem batchId:batchOrderBatchOrder={"orderId", "salesOrderId"}**parametr dotazu s kódem batchId:batchTreeList<BatchNode>***parametr dotazu s kódem batchId:economicResultAccountMonthBalance**parametry dotazu s kódy startDate,endDate, nepovinněcostCenterId,projectId,currencyaaccountIds:employerResponsibilityInsuranceMap<ID osoby, částka>**parametry dotazu s kódy yearamonth:idID aktuální entity pro účely testování/náhledu doplníme i jako parametr dotazu při generování z detailu se doplní automaticky :incomeStatementList<QueryAccountingStatementRow>***parametry dotazu s kódy startDate,endDate, nepovinněcostCenterId,projectId:paymentQrinformace o platbě pro účely testování/náhledu je třeba doplnit parametr dotazu s kódem idfunguje pro Účetní doklad, který není typu dobropis, má vyplněný bankovní účet a ten má IBAN; zobrazení QR kódu v Jexlu: <img src="${queryService.queryString() + '/barcode?code=' + paymentQrAlias + '&type=QRCODE&height=200&width=200'}"/>zobrazení QR kódu v Mustache:<img src="{{#queryString}}/barcode?code={{paymentQrAlias}}&type=QRCODE&height=200&width=200{{/queryString}}">:remainingHolidayDaysList<RemainingHoliday>=[{"persond", "days"}]***parametry dotazu s kódy yearamonth:supervisorStagesList<StageSupervisor>=[{"id", "stageGroupId", "name", "type", "batchNoteEditable", "batches", "tasks"}]***x :trialBalanceList<AccountMoveGroup>***parametry dotazu s kódy startDateaendDate, nepovinněcostCenterId,projectIdsynthetic,currencyaaccountIds:userIdID aktuálně přihlášeného uživatele x :vatReportObject**pro účely testování/náhledu je třeba doplnit parametr dotazu s kódem idpro kontext Hlášení DPH **zobrazením objektu se nám ukážou dostupná data (soupis klíčů a hodnot), převedením na JSON ( :batchBom::JSON AS example) k nim pak můžeme přistupovat pomocí dot notation:
objekt.klic; napříkladexample.carrierId***jedná se JSON pole (více JSON objektů), podobně jako u JSON objektu ho můžeme zobrazit, abychom viděli dostupná data, abychom k nim mohli přistupovat, musíme nejdříve získat jednotlivé JSON objekty
¶ HTML fragmenty dokumentů
Pro unifikaci stylů, záhlaví a zápatí dokumentu používáme HTML fragmenty dokumentů, které vytváříme ve stejnojmenné agendě.
Fragmenty tvoříme, pokud mají využití alespoň ve dvouch dokumentech (na dvou místech).
-
Pro použití fragmentu v dokumentu používáme specifický zápis: {{#kód-fragmentu#}}, tedy např.: {{#head#}}.
-
Podle obsahu se fragment vloží do html hlavičky (
<head>) - pokud se jedná např. o styly - nebo do těla (<body>) - když obsahuje html kód. -
Aktuálně máme připravenou sadu 3 základních zástupek, respektive jejich variant pro Mustache či Jexl:
- {{#head#}} - styly - univerzální pro Mustache i jexl
- Vkládáme do tagu
<head>do všech částí šablony.
- Vkládáme do tagu
- {{#header#}} / {{#jexl-header#}} -> obsahuje HTML kód hlavičky; vkládáme do tagu
<body>Hlavičky HTML šablony - {{#footer#}} / {{#jexl-footer#}} -> obsahuje HTML kód patičky; vkládáme do tagu
<body>Patičky HTML šablony
- {{#head#}} - styly - univerzální pro Mustache i jexl
-
Pokud je ve fragmentu použita zástupka, ale požadujeme jinou hodnotu (typicky pro zástupku
title), přepíšeme tuto hodnotu použitím dané zástupky jakožto aliasu v SQL dotazu, eventuelně můžeme hodnotu přepsat v Jexlu.
Fragment a dokument musí zobrazovat data stejným způsobem (Mustache NEBO Jexl)!
Příklad Hlavičky HTML šablony vytvořené za použití HTML fragmentů:
Kód
<!DOCTYPE html> <html lang="cs"> <head>{{#head#}}</head> <body>{{#jexl-header#}}</body> </html>Výsledek
¶ Okraje stránky, stránkování, fonty a další
¶ Rozvržení PDF stránky
Výchozím formátem je americký standard Letter. Pro nastavení A4 je třeba zapsat výšku a šířku stránky (297mm a 210mm).
V případě, že vyplníme i hlavičku (patičku), je pravděpodobné, že se bude překrývat s tělem. V tom případě je třeba nastavit i vrchní (spodní) okraj stránky. Pro boční okraje používáme standardně 10mm.
¶ Stránkování
Pro zobrazení stránek (a dalších parametrů) se používají třídy - ty fungují pouze v rámci HTML hlavičky a HTML patičky šablony.
Dostupné třídy: pageNumber, totalPages, date, title, url
např.:
<span class="pageNumber"></span>/<span class="totalPages"></span>¶ Hlavička a patička
V hlavičce ani patičce nesmí být použit žádný odkaz!
Styly HTML hlavičky a HTML patičky se můžou vzájemně přepisovat. Pokud tedy např. v patičce nepoužijeme žádné styly, i tak se tam promítnou ty z hlavičky.
V případě, že v hlavičce i patičce chcete použít stejné styly, vkládejte je prosím do obou polí pro zachování funkčnosti při případné změně PDF generátoru.
Řešení (pokud nechceme, aby se styly v hlavičce a patičce vzájemně ovlivňovaly):
- Zápis stylů inline.
- Styly cílené přímo na tagy specifické pro hlavičku (header) nebo pro patičku (footer). - Za předpokladu, že tyto tagy využívám - např.
header .title { font-weight: bold; }. Případně zvolit specifické názvy tříd, např.footer-title. - Pokud je záměr specificky zaměřené styly používat napříč fragmenty a dokumenty, může být řešením vytvoření nového fragmentu, který bude obsahovat styly popsané v bodu 2.
¶ Fonty
Dostupné fonty
- Arial
- Caladea
- Carlito
- Courier New
- DejaVu Math TeX Gyre
- DejaVu Sans
- DejaVu Sans
- DejaVu Sans Condensed
- DejaVu Sans Light
- DejaVu Sans Mono
- DejaVu Serif
- DejaVu Serif
- DejaVu Serif Condensed
- FontAwesome
- League Spartan
- Liberation Mono
- Liberation Sans
- Liberation Serif
- Noto Color Emoji
- Noto Kufi Arabic
- Noto Looped Lao
- Noto Looped Lao Bold
- Noto Looped Lao Regular
- Noto Looped Thai
- Noto Looped Thai Bold
- Noto Looped Thai Regular
- Noto Mono
- Noto Music
- Noto Naskh Arabic
- Noto Nastaliq Urdu
- Noto Rashi Hebrew
- Noto Sans
- Noto Sans Adlam
- Noto Sans Adlam Unjoined
- Noto Sans AnatoHiero
- Noto Sans Anatolian Hieroglyphs
- Noto Sans Arabic
- Noto Sans Armenian
- Noto Sans Avestan
- Noto Sans Balinese
- Noto Sans Bamum
- Noto Sans Bassa Vah
- Noto Sans Batak
- Noto Sans Bengali
- Noto Sans Bhaiksuki
- Noto Sans Brahmi
- Noto Sans Buginese
- Noto Sans Buhid
- Noto Sans CanAborig
- Noto Sans Canadian Aboriginal
- Noto Sans Carian
- Noto Sans CaucAlban
- Noto Sans Caucasian Albanian
- Noto Sans Chakma
- Noto Sans Cham
- Noto Sans Cherokee
- Noto Sans CJK HK
- Noto Sans CJK JP
- Noto Sans CJK KR
- Noto Sans CJK SC
- Noto Sans CJK TC
- Noto Sans Coptic
- Noto Sans Cuneiform
- Noto Sans Cypriot
- Noto Sans Deseret
- Noto Sans Devanagari
- Noto Sans Display
- Noto Sans Duployan
- Noto Sans EgyptHiero
- Noto Sans Egyptian Hieroglyphs
- Noto Sans Elbasan
- Noto Sans Elymaic
- Noto Sans Ethiopic
- Noto Sans Georgian
- Noto Sans Glagolitic
- Noto Sans Gothic
- Noto Sans Grantha
- Noto Sans Gujarati
- Noto Sans Gunjala Gondi
- Noto Sans Gurmukhi
- Noto Sans Hanifi Rohingya
- Noto Sans Hanunoo
- Noto Sans Hatran
- Noto Sans Hebrew
- Noto Sans ImpAramaic
- Noto Sans Imperial Aramaic
- Noto Sans Indic Siyaq Numbers
- Noto Sans Inscriptional Pahlavi
- Noto Sans Inscriptional Parthian
- Noto Sans InsPahlavi
- Noto Sans InsParthi
- Noto Sans Javanese
- Noto Sans Kaithi
- Noto Sans Kannada
- Noto Sans Kayah Li
- Noto Sans Kharoshthi
- Noto Sans Khmer
- Noto Sans Khojki
- Noto Sans Khudawadi
- Noto Sans Lao
- Noto Sans Lepcha
- Noto Sans Limbu
- Noto Sans Linear A
- Noto Sans Linear B
- Noto Sans Lisu
- Noto Sans Lycian
- Noto Sans Lydian
- Noto Sans Mahajani
- Noto Sans Malayalam
- Noto Sans Mandaic
- Noto Sans Manichaean
- Noto Sans Marchen
- Noto Sans Masaram Gondi
- Noto Sans Math
- Noto Sans Mayan Numerals
- Noto Sans Medefaidrin
- Noto Sans Meetei Mayek
- Noto Sans Mende Kikakui
- Noto Sans Meroitic
- Noto Sans Miao
- Noto Sans Modi
- Noto Sans Mongolian
- Noto Sans Mono
- Noto Sans Mono CJK HK
- Noto Sans Mono CJK JP
- Noto Sans Mono CJK KR
- Noto Sans Mono CJK SC
- Noto Sans Mono CJK TC
- Noto Sans Mro
- Noto Sans Multani
- Noto Sans Myanmar
- Noto Sans Nabataean
- Noto Sans Newa
- Noto Sans New Tai Lue
- Noto Sans NKo
- Noto Sans Nushu
- Noto Sans Ogham
- Noto Sans Ol Chiki
- Noto Sans OldHung
- Noto Sans Old Hungarian
- Noto Sans Old Italic
- Noto Sans OldNorArab
- Noto Sans Old North Arabian
- Noto Sans Old Permic
- Noto Sans Old Persian
- Noto Sans Old Sogdian
- Noto Sans OldSouArab
- Noto Sans Old South Arabian
- Noto Sans Old Turkic
- Noto Sans Oriya
- Noto Sans Osage
- Noto Sans Osmanya
- Noto Sans Pahawh Hmong
- Noto Sans Palmyrene
- Noto Sans Pau Cin Hau
- Noto Sans PhagsPa
- Noto Sans Phoenician
- Noto Sans Psalter Pahlavi
- Noto Sans PsaPahlavi
- Noto Sans Rejang
- Noto Sans Runic
- Noto Sans Samaritan
- Noto Sans Saurashtra
- Noto Sans Sharada
- Noto Sans Shavian
- Noto Sans Siddham
- Noto Sans SignWrit
- Noto Sans SignWriting
- Noto Sans Sinhala
- Noto Sans Sogdian
- Noto Sans Sora Sompeng
- Noto Sans Soyombo
- Noto Sans Sundanese
- Noto Sans Syloti Nagri
- Noto Sans Symbols
- Noto Sans Symbols2
- Noto Sans Syriac
- Noto Sans Tagalog
- Noto Sans Tagbanwa
- Noto Sans Tai Le
- Noto Sans Tai Tham
- Noto Sans Tai Viet
- Noto Sans Takri
- Noto Sans Tamil
- Noto Sans Tamil Supplement
- Noto Sans Telugu
- Noto Sans Thaana
- Noto Sans Thai
- Noto Sans Tifinagh
- Noto Sans Tifinagh Adrar
- Noto Sans Tifinagh Agraw Imazighen
- Noto Sans Tifinagh Ahaggar
- Noto Sans Tifinagh Air
- Noto Sans Tifinagh APT
- Noto Sans Tifinagh Azawagh
- Noto Sans Tifinagh Ghat
- Noto Sans Tifinagh Hawad
- Noto Sans Tifinagh Rhissa Ixa
- Noto Sans Tifinagh SIL
- Noto Sans Tifinagh Tawellemmet
- Noto Sans Tirhuta
- Noto Sans Ugaritic
- Noto Sans Vai
- Noto Sans Wancho
- Noto Sans Warang Citi
- Noto Sans Yi
- Noto Sans Zanabazar
- Noto Sans Zanabazar Square
- Noto Serif
- Noto Serif Ahom
- Noto Serif Armenian
- Noto Serif Balinese
- Noto Serif Bengali
- Noto Serif CJK HK
- Noto Serif CJK JP
- Noto Serif CJK KR
- Noto Serif CJK SC
- Noto Serif CJK TC
- Noto Serif Devanagari
- Noto Serif Display
- Noto Serif Dogra
- Noto Serif Ethiopic
- Noto Serif Georgian
- Noto Serif Grantha
- Noto Serif Gujarati
- Noto Serif Gurmukhi
- Noto Serif Hebrew
- Noto Serif Hmong Nyiakeng
- Noto Serif Kannada
- Noto Serif Khmer
- Noto Serif Khojki
- Noto Serif Lao
- Noto Serif Malayalam
- Noto Serif Myanmar
- Noto Serif Sinhala
- Noto Serif Tamil
- Noto Serif Tamil Slanted
- Noto Serif Tangut
- Noto Serif Telugu
- Noto Serif Thai
- Noto Serif Tibetan
- Noto Serif Yezidi
- Noto Traditional Nushu
- Open Sans
- Open Sans
- Open Sans Light
- OpenSymbol
- Unifont