Editační formulář

Příručka ve formátu PDF

1. Seznam záložek v dialogu nastavení editačního formuláře

• Obecné – Nastavení obecných vlastností
• Ostatní – Nastavení primárního klíče, zámků, sledování změn a javascriptu
• Nápověda – Nastavení textu plovoucí nápovědy a seskupování ovládacích prvků
• Práva na editaci – Nastavení práv
• Práva podřízených objektů – Nastavení práv podřízených ovládacích prvků
• Administrace – Nastavení ostatních vlastností

1.1. Záložka „Obecné“

1.1.1. Název

• Název editačního formuláře určuje ideálně v jednotném čísle vyjádřené pojmenování jednoho databázového záznamu, který je uložen v databázové tabulce přidružené k formuláři.
• Název editačního formuláře se zobrazuje v titulku záložky webového prohlížeče.

1.1.2. Slovník

• Slovník zobrazuje seznam názvů aplikačních skupin, aplikací, kategorií, nahlížecích stránek, editačních formulářů a ovládacích prvků použitých napříč celou aplikací.
• Vyhledávání ve slovníku slouží k navržení správného názvu editačního formuláře a k udržení konzistence názvosloví v celé aplikaci.

1.1.3. Možnosti

• Tab Obecné + Ostatní
  • Zaškrtnutí tohoto pole určuje, zda mají být při vytvoření nového editačního formuláře vytvořeny také ovládací prvky záložek „Tab“ a „Ostatní“.
• Sledování změn + Watcher
  • Zaškrtnutí tohoto pole určuje, zda mají být při vytvoření nového editačního formuláře vytvořeny také ovládací prvky pro sledování změn:
    • Ovládací prvek „History“
    • Ovládací prvek „Watcher“
      • Zadáno kým
      • Zadáno kdy
      • Změněno kým
      • Změněno kdy

1.2. Záložka „Ostatní“

1.2.1. Primární klíč

• Primární klíč určuje datový typ primárního klíče – databázového sloupce "id", který je součástí každé databázové tabulky v NET Geniu.
• Datový typ primárního klíče může být kdykoliv změněn z Integeru na Long, zpětná změna z Long na Integer však není možná.
• Před změnou primárního klíče na Long je důležité zajistit správnou funkcionalitu externích funkcí, služeb nebo ostatních aplikací, které s databázovou tabulkou pracují. Především jde o objekty DataSaver nebo DataSaverSynchro, které musí být změněny na DataSaver2 a DataSaverSynchro2.

1.2.2. Zamykání záznamů

• Databázové záznamy otevřené v editačním formuláři mohou být nastaveny tak, aby je v jednu chvíli mohl editovat pouze jeden uživatel.
• Uživatel, který databázový záznam otevře jako první, záznam automaticky zamyká. Během práce v editačním formuláři se zámek automaticky prodlužuje, dokud uživatel editační formulář neopustí. Při opuštění editačního formuláře se zámek ihned automaticky uvolní.
• Zamykání záznamů se definuje v nastavení editačního formuláře zadáním časového intervalu v minutách, během kterého má být zámek aktivní. Délka časového intervalu hraje roli pouze při technických problémech uživatele, díky kterým nemůže docházet k automatickému prodlužování zámku během celé doby práce uživatele s daným databázovým záznamem v editačním formuláři. Typicky jde o otevření jiné záložky webového prohlížeče, zavření aktuální záložky křížkem, spuštění jiné aplikace na mobilním telefonu, nebo o výpadky internetu. V případě technických problémů tedy dojde k automatickému uvolnění zámku až po uplynutí zvoleného časového intervalu od posledního automatického prodloužení zámku. Délka časového intervalu tedy určuje dobu, po kterou bude zámek aktivní i v případě výpadku spojení mezi klientem a serverem.
• Zamčené záznamy mají v nahlížecí tabulce místo ikony lupy, která slouží k otevření databázového záznamu, ikonu zámku. Ikona zámku obsahuje tooltip s informací, kdo záznam uzamknul, a do kdy je zámek aktivní. I tak je však možné databázový záznam pomocí ikony zámku otevřít, ostatním uživatelům se editační formulář se zamčeným záznamem zobrazuje pouze ke čtení bez možnosti editace.

1.2.3. Možnosti

• Protokolovat otevírání záznamů
  • Zaškrtnutí tohoto pole určuje, zda má být každé otevření databázového záznamu v editačním formuláři zaznamenáno do historie sledování změn.
• Zakázat protokolování historie záznamů
  • Zaškrtnutí tohoto pole určuje, zda má být zakázáno protokolování historie databázových záznamů.
  • Úplné, nebo třeba jen dočasné vypnutí protokolování, se doporučuje před hromadnou úpravou nebo mazáním databázových záznamů, kdy každá změna nebo smazání databázového záznamu vytvoří jeden záznam v historii sledování změn.
• Zakázat JavaScript
  • Zaškrtnutí tohoto pole určuje, zda má být zakázáno spouštění javascriptových událostí ovládacích prvků, a zároveň generování obsahu ovládacích prvků JavaScript.
  • Této možnosti se využívá v situacích, kdy dojde k zacyklení editačního formuláře nevhodným javascriptem. V některých případech dokonce není možné nastavení editačního formuláře otevřít běžným způsobem, a je nutné k tomu použít reporty. Detailní popis reportů je uveden v samostatné příručce Reporty.

1.3. Záložka „Nápověda“

1.3.1. Šířka plovoucí nápovědy

• Šířka plovoucí nápovědy určuje šířku boxu s nápovědou k editačnímu formuláři umístěného v pravém horním rohu formuláře. Tento box se zobrazuje nezávisle na vertikálním skrolování v editačním formuláři.
• Součástí plovoucího boxu je také obsah všech ovládacích prvků „RichText“ a „HTML“ se zaškrtnutým polem „Plovoucí nápověda v editačním formuláři“. Tento obsah je umístěný za nápovědu editačního formuláře v pořadí, které mají tyto ovládací prvky v editačním formuláři.
• Není-li šířka vyplněna, použije se výchozí šířka plovoucího boxu 200 pixelů.

1.3.2. Možnosti

• Automatické seskupování nápovědy přichycených ovládacích prvků
  • Je-li zaškrtnuto „Automatické seskupování nápovědy přichycených ovládacích prvků“, bude ve sloupci s nápovědou jednotlivých ovládacích prvků editačního formuláře automaticky vygenerován odrážkový seznam všech ovládacích prvků s nápovědou umístěných ve stejné řádce, s možností rozkliknout položku odrážkového seznamu a zobrazit text nápovědy.
  • Není-li zaškrtnuto „Automatické seskupování nápovědy přichycených ovládacích prvků“, nápovědy ovládacích prvků umístěných nalevo od přichycených ovládacích prvků se nezobrazují.
  • Seskupování nápověď se používá u ovládacích prvků, které mají zaškrtnuté pole „Přichytit k předchozímu ovládacímu prvku“.

1.3.3. Nápověda

• Nápověda je text zobrazovaný v pravém horním rohu editačního formuláře uvnitř plovoucího boxu.
• Součástí plovoucího boxu je také obsah všech ovládacích prvků „RichText“ a „HTML“ se zaškrtnutým polem „Plovoucí nápověda v editačním formuláři“. Tento obsah je umístěný za nápovědu editačního formuláře v pořadí, které mají tyto ovládací prvky v editačním formuláři.

1.3.4. Poznámky

• Poznámky slouží pro zadání libovolného textu určeného pro správce aplikace.
• Do poznámek se umísťuje volání serverových funkcí, které řídí chování editačního formuláře:
  • DISABLEAUTOFILL()
  • DISABLEPAGETOOLS()
  • LOWRESOLUTION()
• Do poznámek se umísťuje definice databázového pohledu, je-li editační formulář nastaven pro čtení dat z databázového pohledu.

1.4. Záložka „Práva na editaci“

1.4.1. Spoluvlastníci záznamů

• Spoluvlastníci záznamů definují seznam uživatelských skupin a uživatelů, kteří rozšiřují vlastnictví databázových záznamů. Vedle vlastníka záznamu, tedy uživatele, který databázový záznam vytvořil, rozšiřují vlastnictví o další uživatele, kteří se automaticky stávají spoluvlastníky všech záznamů v dané databázové tabulce. Detailní popis spoluvlastnictví záznamů je uveden v samostatné příručce Příručka administrátora.

1.4.2. Práva na editaci – možnosti

• Vlastník nebo spoluvlastník záznamu – databázové záznamy v editačním formuláři může editovat pouze vlastník nebo spoluvlastník záznamu.
• Pouze spoluvlastník záznamu – databázové záznamy v editačním formuláři může editovat pouze spoluvlastník záznamu.

1.5. Záložka „Práva podřízených objektů“

• Práva definují seznam uživatelských skupin a uživatelů, kteří mají oprávnění na zobrazení ovládacích prvků v editačním formuláři, a na zobrazování hodnot těchto ovládacích prvků všude jinde v aplikaci.
• Vlastností editačního formuláře je pouze nastavení spoluvlastníků záznamů, práva na vstup do editačního formuláře má kdokoliv. Je jen na nastavení práv jednotlivých ovládacích prvků formuláře, co vše se danému uživateli v editačním formuláři zobrazí.

1.5.1. Možnosti

• Nahradit práva ve všech podřízených objektech – Zaškrtnutí tohoto pole určuje, zda má být při uložení editačního formuláře přepsáno nastavení práv ve všech podřízených ovládacích prvcích na stejná oprávnění, jako jsou nastavena v samotném editačním formuláři.
• Přidat zvolená práva všem podřízeným objektům – Zaškrtnutí tohoto pole určuje, zda mají být při uložení editačního formuláře přidány všechny zvolené aplikační skupiny a uživatelé všem podřízeným ovládacím prvkům.
• Odebrat práva zvolená všem podřízeným objektům – Zaškrtnutí tohoto pole určuje, zda mají být při uložení editačního formuláře odebrány všechny zvolené aplikační skupiny a uživatelé všem podřízeným ovládacím prvkům.

1.6. Záložka „Administrace“

1.6.1. Umístění

• Výběr aplikace, ve které je editační formulář umístěn.
• Rozbalovací seznam obsahuje všechny aplikace.
• Editační formuláře umístěné v systémové aplikaci „Nastavení“ nesmí být nikam jinam přesunuty, ani smazány.

1.6.2. Identifikátor

• Identifikátor určuje název databázové tabulky v databázi, do které se ukládají samotná uživatelská data vyplňovaná uživatelem v editačním formuláři.
• Identifikátor je odvozen od názvu editačního formuláře. Začíná prefixem „ng_“, a dále obsahuje alfanumerické znaky použité v názvu editačního formuláře (systémové editační formuláře „ng_“ neobsahují). Při změně názvu editačního formuláře je k dispozici tlačítko „Opravit“, které slouží k opravě identifikátoru, a tedy i přejmenování databázové tabulky v databázi. Pro přehlednost a eliminaci případných nedorozumění se doporučuje udržovat identifikátor v souladu s názvem editačního formuláře. Pokud do databáze přistupují i externí aplikace a například čtou nebo zapisují data do databázové tabulky tohoto editačního formuláře, je nutné změnu identifikátoru naplánovat až na vhodnou dobu.
• Pro automatickou opravu identifikátorů všech databázových ovládacích prvků editačního formuláře je k dispozici tlačítko „Opravit vše“.
• Data z databázové tabulky číst/zapisovat pomocí In-Memory tabulky
• Pouze pro SQL Server
  • In-Memory tabulky jsou databázové tabulky umístěné v operační paměti, které se hodí pro časté zapisování dat – především pro vytváření nových záznamů (INSERT) nebo aktualizaci stávajících (UPDATE).
  • In-Memory tabulky se nehodí pro řešení potíží s rychlostí zpracování databázových dotazů během čtení dat (SELECT). Řešením těchto potíží je vždy správné nastavení indexů.
  • Zaškrtnutí tohoto pole určuje, zda má být pro čtení a zápis dat použita databázová tabulka se stejným identifikátorem jako má editační formulář, jen se slovem „_memory“ na konci názvu.
  • In-Memory tabulky se musí vytvářet ručně. K tomuto účelu je možné využít příkaz „CREATE ng_kniha_memory“ z rozbalovacího seznamu umístěného pod zaškrtávacím polem. Tento příkaz zobrazí databázový dotaz na vytvoření nové In-Memory tabulky se stejnou strukturou jako má editační formulář, a databázovou tabulku se pokusí rovnou vytvořit.
  • In-Memory tabulky neumožňují dodatečnou změnu databázové struktury. Nejdříve je nutné smazat starou tabulku, a následně vytvořit novou s aktualizovanou strukturou. K tomuto účelu je možné využít příkaz „DROP ng_kniha_memory“ z rozbalovacího seznamu umístěného pod zaškrtávacím polem. Tento příkaz zobrazí databázový dotaz na smazání In-Memory tabulky, a databázovou tabulku se pokusí rovnou smazat.
  • Před smazáním In-Memory tabulek je důležité zazálohovat data uložená v těchto tabulkách, a tato data následně obnovit. K tomuto účelu je možné využít příkaz „EXPORT DATA FROM ng_kniha_memory TO 'Backup\ng_kniha_memory.xml'“ z rozbalovacího seznamu umístěného pod zaškrtávacím polem, a následně „IMPORT DATA TO ng_kniha_memory FROM 'Backup\ng_kniha_memory.xml'“ nebo „IMPORT DATA TO ng_kniha_memory FROM ng_kniha“.
• Data z databázové tabulky číst pomocí pohledu
  • Zaškrtnutí tohoto pole určuje, zda má být pro čtení dat použitý databázový pohled se stejným identifikátorem jako má editační formulář, jen se slovem „_view“ na konci názvu. Zápis dat do pohledů není možný, proto je doporučeno v těchto editačních formulářích skrýt tlačítko „Uložit“. Při pokusu o uložení dat do pohledu dojde k chybě.
  • Pohledy se musí vytvářet ručně. K tomuto účelu je možné využít příkaz „CREATE ng_kniha_view“ z rozbalovacího seznamu umístěného pod zaškrtávacím polem.
    • Tento příkaz zobrazí databázový dotaz na vytvoření nového pohledu se stejnou strukturou jako má editační formulář, a databázový pohled se pokusí rovnou vytvořit.
    • Pohled vytvořený tímto příkazem má stejnou strukturu jako editační formulář, a proto je nutné jeho definici (CREATE VIEW) dodatečně upravit.
    • Výslednou definici je vhodné uložit do poznámky editačního formuláře, kde si ho NET Genium při příštím spuštění příkazu „CREATE ng_kniha_view“ vyhledá, a spustí ho v tomto znění.
  • Pohledy neumožňují dodatečnou změnu databázové struktury. Nejdříve je nutné smazat starý pohled, a následně vytvořit nový s aktualizovanou strukturou. K tomuto účelu je možné využít příkaz „DROP ng_kniha_view“ z rozbalovacího seznamu umístěného pod zaškrtávacím polem. Tento příkaz zobrazí databázový dotaz na smazání pohledu, a databázový pohled se pokusí rovnou smazat.

1.6.3. Příkazy

• CREATE REPORT FROM ng_kniha – Vytvoření reportu délky stringů uložených v editačním formuláři
• CREATE ng_kniha_memory – Vytvoření In-Memory tabulky
• IMPORT DATA TO ng_kniha_memory FROM 'Backup\ng_kniha_memory.xml' – Import dat do In-Memory tabulky z XML souboru umístěného v adresáři „Backup“
• IMPORT DATA TO ng_kniha_memory FROM ng_kniha – Import dat do In-Memory tabulky z hlavní databázové tabulky editačního formuláře
• EXPORT DATA FROM ng_kniha_memory TO 'Backup\ng_kniha_memory.xml' – Export dat z In-Memory tabulky do XML souboru umístěného v adresáři „Backup“
• DROP ng_kniha_memory – Smazání In-Memory tabulky
• CREATE ng_kniha_view – Vytvoření pohledu
• DROP ng_kniha_view – Smazání pohledu
• TRUNCATE TABLE ng_kniha + ng_kniha_history – Smazání všech dat v databázové tabulce včetně záznamů historie, a nastavení čítače primárního klíče na počáteční hodnotu 1
• TRUNCATE TABLE ng_kniha_history – Smazání všech záznamů historie, a nastavení čítače primárního klíče na počáteční hodnotu 1
• RECREATE TABLE ng_kniha + ng_kniha_history – Zazálohování dat a opětovné vytvoření databázových tabulek včetně následného importu dat

1.6.4. Index 1

• Nastavení indexu na databázový sloupec „pid“ nebo sdruženého indexu na databázový sloupec „pform“ spolu se sloupcem „pid“.

1.6.5. Index 2

• Nastavení indexu na libovolný seznam databázových sloupců editačního formuláře.
• Do textového pole umístěného pod zaškrtávací položkou je možné definovat názvy (identifikátory) všech sloupců, které mají být ve sdruženém indexu – mají být součástí klíče indexu.

1.6.6. Smazat historii starší než

• Nastavení počtu měsíců, během kterých je nutné uchovávat historii databázových záznamů tohoto editačního formuláře.
• Není-li počet měsíců vyplněn, použije se výchozí nastavení 6 měsíců.
• Záznamy historie starší, než takto nastavené časové období je možné jednorázově smazat pomocí:
  • Tlačítka „Smazat historii“ umístěného napravo vedle textového pole.
  • Menší ikony pro smazání historie záznamů z reportů. Detailní popis reportů je uveden v samostatné příručce Příručka administrátora.
  • Serverové funkce „DELETEHISTORY“.

1.6.7. C#/JavaScript

• Pomocí tlačítka „C#/JavaScript“ se zobrazí textový report s příkladem v C# pro uložení záznamu do databázové tabulky přidružené k tomuto editačnímu formuláři.
• Součástí reportu je seznam všech databázových ovládacích prvků v editačním formuláři.

1.6.8. Statistika

• Statistika zobrazuje agregovanou informaci o využívání editačního formuláře napříč celou aplikací.
• Pomocí tlačítka „Statistika“ se zobrazí detailní report všech míst, kde je editační formulář použitý nebo referencovaný, včetně možnosti otevření nastavení takového místa či ovládacího prvku.
• Před každým smazáním editačního formuláře se doporučuje důkladně projít statistku editačního prvku, a eliminovat případná nedorozumění.
• Před každým smazáním editačního formuláře se automaticky spustí vyhodnocení statistiky. Pokud je editační formulář někde v aplikaci používán nebo referencován, je nutné smazání editačního formuláře znovu potvrdit.

1.6.9. Logování

• Pomocí tlačítka „Logování“ se zobrazí detailní report se záznamy zobrazení editačního formuláře a údaji o
  • datumu a času zobrazení editačního formuláře,
  • uživateli, který editačního formuláře zobrazil,
  • času zpracování editačního formuláře v milisekundách a
  • informací, zda jde o první načtení editačního formuláře, nebo o jeho aktualizaci (postback).

• Minimální zobrazovaný čas zpracování editačního formuláře je ve výchozím nastavení stanoven na 0 milisekund, zobrazují se tedy všechny záznamy zobrazení editačních formulářů včetně těch, jejichž zpracování trvalo 0 milisekund. Tento minimální čas je možné zvýšit nebo snížit změnou parametru „mintime“ v URL reportu.
• Počet záznamů je ve výchozím nastavení omezen na 100 záznamů. Tento počet je možné ručně zvýšit nebo snížit změnou parametru „maxrows“ v URL reportu.

1.6.10. Historie

• Pomocí tlačítka „Historie“ se zobrazí detailní report s jednotlivými záznamy sledování změn.

2. Nastavení synchronizace

2.1. Seznam serverů, se kterými se synchronizují data

2.2. Odkaz na nastavení nového serveru

2.3. Nastavení serveru

2.3.1. Název

• Název vzdáleného serveru, resp. NET Genia.

2.3.2. URL

• Internetová adresa vzdáleného NET Genia (možno použít SSL komunikaci přes protokol „https“).

2.3.3. Heslo pro synchronizaci

• Heslo pro synchronizaci nastavené na vzdáleném NET Geniu v nastavení NET Genia.

2.3.4. Intranet URL

• Intranetová adresa vzdáleného NET Genia, na jehož záznamy budou uživatelé směrováni z e-mailových zpráv rozesílaných skriptem.

2.3.5. Jazyk

• Jazyk, ve kterém budou vytvořeny odkazy v e-mailových zprávách, směrující uživatele na záznamy do NET Genia.

2.3.6. Možnosti

• TLS 1.2
  • Zaškrtnutí tohoto pole určuje, zda bude na starších serverech pro komunikaci se vzdáleným NET Geniem prostřednictvím webových služeb používán protokol TLS 1.2.
  • Na serverech s operačním systémem Windows 2012 a vyšších je automaticky zvolen protokol TLS 1.2 bez nutnosti zaškrtnout toto pole.
• Ignorovat chyby SSL
  • Zaškrtnutí tohoto pole určuje, zda budou při komunikaci se vzdáleným NET Geniem přes protokol „https“ ignorovány chyby v SSL certifikátech.
• Proxy Server
  • Zaškrtnutí tohoto pole určuje, zda bude pro komunikaci se vzdáleným NET Geniem používán Proxy Server.
• Proxy URL
  • Adresa Proxy Serveru.
• Přihlašovací jméno
  • Přihlašovací jméno pro komunikaci s Proxy Serverem.
• Heslo
  • Heslo pro komunikaci s Proxy Serverem.

2.4. Odkaz na nastavení nové synchronizace

2.5. Nastavení synchronizace

2.5.1. Server

• Název serveru, se kterým budou synchronizována data z databázové tabulky aktuálně otevřeného editačního formuláře.

2.5.2. Editační formulář

• Editační formulář ve vzdáleném NET Geniu, se kterým budou synchronizována data z databázové tabulky aktuálně otevřeného editačního formuláře.

2.5.3. Podmínka synchronizace

• Podmínka, která omezuje rozsah synchronizovaných dat pouze na určitou množinu.

2.5.4. Sloupce

• Nastavení sloupců určuje, jaký sloupec (nalevo) vzdáleného editačního formuláře bude synchronizován, a s jakým sloupcem (napravo) v aktuálně otevřeném editačním formuláři.
• Každý sloupec může obsahovat podmínku, pouze při jejímž splnění bude hodnota sloupce synchronizována.

2.6. Jednorázová synchronizace všech dat