Správa datového slovníku

Datový slovník popisuje, jakou strukturu (atributy) budou mít položky, které tvoří webovou prezentaci. Při instalaci jNP je datový slovník inicializován výchozím nastavením, které je vhodné pro typickou prezentaci. Datový slovník můžete upravovat dle potřeb vaší prezentace, zejména vytvářet vlastní specifické typy položek, či přidávat atributy k existujícím typům položek.

Nastavení datového slovníku

Administrace datového slovníku je k dispozici v menu Obsah > Datový slovník.

Typy položek

Hlavním obsahem slovníku je definice typů položek. V záložce Typy je seznam deklarovaných typů položek. V seznamu lze nastavovat pořadí, přidávat, odebírat či upravovat typy. Typ položky lze upravit pomocí dialogu, s následujícími záložkami.

Vlastnosti položky

Vlastnosti položky určují zejména, jak je typ položky prezentován v jNP. Jedná se o název a popis, volitelně lokalizovatelný do více jazyků, viz lokalizace slovníku. K typu je možné připojit ikonu (ve velikosti 16 a 32 pixelů), která se pak zobrazuje v administraci. Připojit lze i další obrázek blíže neurčené velikosti, který lze pak využít ve speciálních administracích (například v "galerii modulů" pro vložení do stránky).

Vlastní atributy

V této záložce je seznam atributů deklarovaných přímo v aktuálním typu položky. Atributy v seznamu lze řadit, přidávat a odebírat. Při přidání atributu, nebo úpravě stávajícího atributu, se zobrazí editor atributu s následujícími záložkami.

Vlastnosti atributu

ID atributu a zobrazený název. Atribut lze označit jako vyhledatelný, lze tedy použít pro filtrování nebo řazení v databázových dotazech. Pokud je atribut povinný, uživatel musí zadat jeho hodnotu, jinak editor položky nelze uložit.

Typ atributu

Definuje datový typ atributu. K dispozici jsou následující možnosti.

Data

Lze vybrat konkrétní jednoduchý datový typ (například String, Integer, BigDecimal, Datum), komplexní datový typ (například BinaryStream, BookItems) případně speciální nebo aplikačně definovaný typ (OpeningHours, PollStructure).

Reference

Atribut je typu reference na položku. Volitelně lze specifikovat omezení na typ položky.

Typ (položky)

Atribut je typu typ položky. Používá se ve speciálních případech, například u dotazového datového zdroje na omezení typu položek které zdroj vrací. Volitelně lze specifikovat omezení na typ položky.

Výčet

Atribut je typu výčet (číselník), definovaný ve slovníku, viz administrace výčtů.

Výše uvedený seznam definuje hodnotu atributu, v případě že atribut je jednoduchý. Pomocí nastavení Typ kolekce lze atribut označit jako seznamový, uživatel pak může zadat několik hodnot daného typu.

Skupiny (atributů)

Umožňuje rozdělit atributy do tzv. skupin atributů. Tyto skupiny ovlivňují chování atributů v editoru položek, případně jim přidělují speciální význam. Viz též administrace skupin atributů.

Hinty

Umožňuje nastavit hodnoty tzv. editor hintů, které ovlivňují způsob editace tohoto atributu. Více viz online dokumentace.

Příznaky

Přiřazuje k atributu množinu příznaků, které mohou dále ovlivňovat chování atributu. Viz například vícejazyčné atributy.

ACL

Dovolí přiřadit k atributu množinu rolí, které jsou vyžadovány pro zobrazení a editaci atributu. Pokud množina není nastavena, atribut se zobrazuje všem uživatelům.

XML

Zobrazí deskriptor atributu v XML formátu.

Všechny atributy

Tato záložka zobrazuje všechny atributy položky, včetně atributů zděděných z nadřazených položek. Atributy zobrazené tučně jsou vlastní atributy, lze je upravovat stejným způsobem, jako v záložce Vlastní atributy. Atributy zobrazené kurzívou jsou zděděny z nadřazené položky tak jak jsou, beze změny. Atributy zobrazené normálním písmem, jsou zděděné atributy, u nichž byla změněna některá vlastnost, viz dále.

U zděděných atributů lze změnit některé vlastnosti, pomocí editoru Vlastnosti předefinovaného atributu. Jmenovitě lze změnit:

• Vlastnosti - tedy zobrazené krátké a dlouhé jméno (tedy přejmenovat atribut), vlastnost zda je atribut povinný
• Skupiny - změnit přiřazení atributu do skupin. Nastavení je užitečné například pro skrytí atributu v podtypu - úplné odstranění zděděného atributu není možné
• Příznaky
• Hinty - lze změnit způsob editace atributu v editoru položky

Seznamové vlastnosti (skupiny, příznaky, hinty) se chovají jako jedna hodnota. Nelze tedy nastavit, aby se některé položky seznamu dědily, a jiné byly změněny. Pokud potřebujeme například přidat, odebrat, nebo změnit některý editor hint, musíme všechny ostatní zděděné editor hinty zopakovat.

Ve výchozím nastavení se atributy řadí podle jednoduchého algoritmu:

1. do seznamu atributů se nejprve přidají zděděné atributy, v pořadí nadřazených položek (s odstraněním případných duplicit vzniklých vícenásobnou dědičností)
2. na konec seznamu se přidají vlastní atributy, podle jejich pořadí

V záložce všech atributů lze toto výchozí pořadí změnit. Jakmile je výchozí nastavení pořadí změněno, pořadí vlastních i zděděných atributů už na pořadí atributů tohoto typu položky nemá vliv.

Nadřazené položky

V této záložce je definováno, z jakých typů položek tento typ položky dědí atributy. Počet nadřazených položek není omezen - položka může dědit z žádného, jednoho, nebo více typů položek.

Pokud je typ položky určen k přímému vytváření instancí, měla by dědit alespoň z typu Položka, odkud zdědí základní systémové atributy (rodičovská složka, jméno, titulek apod). Pokud je typ položky doplňkový, tedy určený k dodatečnému přidání k položce nebo typu položky (například Položka s ovladačem, Dětské odkazy), měl by být označen příkazem supplement. Pokud je typ položky abstraktní, tedy slouží k definování podtypů, nikoli přímému vytváření instancí, měl by být označen příznakem abstract.

Příznaky

Pomocí záložky lze k typu položky přiřadit množinu příznaků, které ovlivňují chování položek příslušného typu v editoru. Viz např. příznaky abstract a supplement.

Zobrazovače

V záložce zobrazovače lze definovat, jak se položka tohoto typu bude zobrazovat v administraci v různých kontextech, definovaných typem zobrazovače. Viz též administrace zobrazovačů.

Atributy

Záložka atributy zobrazuje přehled všech atributů všech položek. Atributy je možné upravovat. Pro přidání nebo smazání atributu je třeba použít záložku Vlastní atributy v editoru typu položky.

Pomocné struktury

Následující nastavení slovníku slouží pro podporu definice typů položek a jejich atributů.

Výčty

V této záložce lze definovat vlastní číselníky, které je pak možné používat jako typ atributu.

Skupiny atributů

Záložka umožňuje definovat skupiny atributů, do kterých pak lze přiřazovat atributy v záložce Skupiny editoru atributů. Skupiny atributů lze vytvářet libovolně, následující skupiny využívá editor položek jNP:

• wizardInput (Nový asset) - atributy v této skupině jsou zobrazeny v dialogu pro vytvoření položky
• skupiny s příznakem editor - tyto skupiny definují skupiny atributů, které se zobrazí v editoru atributů; skupině lze přiřadit v záložce ACL specifické role, uživatelé bez této role skupinu ani jí přiřazené atributy neuvidí; atribut by měl být přiřazen max do jedné skupiny, pokud není přiřazen do žádné skupiny, nelze atribut upravovat v editoru atributů; ve výchozím nastavení slovníku existují skupiny Základní atributy a Rozšířené atributy s příznakem editor.
• search (Rozšířené vyhledávání) - zobrazují se v dialogu rozšířeného vyhledávání, atributy musí být zároveň označeny jako vyhledatelné

Zobrazovače

Záložka definuje typy tzv. zobrazovačů. Zobrazovač je TFS šablona, která definuje vzhled položky určitého typu v určitém kontextu, který určuje právě typ zobrazovače. Šablony lze přiřazovat typu položky pro daný typ zobrazovače v editoru typu položky, v záložce Zobrazovače.

V současné administraci, jsou rozlišovány následující grafické kontexty, resp. typy zobrazovačů.

XML

V záložce XML lze zobrazit reprezentaci slovníku v XML formátu. Tato reprezentace je editovatelná. To je užitečné na komplexní změny slovníku, které nejsou podporované jednotlivými editory, například přenášení atributů mezi typy položek.

Navíc každý editor (například editor položky, atributu, výčtu) má vlastní záložku XML, kde je XML reprezentace editovaného objektu. I v této záložce je XML kód editovatelný.

Lokalizace slovníku

Zobrazované texty ve slovníku lze uvádět v libovolném množství jazyků. Jazyky se nastavují pomocí elementu <languages> v XML záložce. První jazyk je hlavní, a použije se v případě, že pro aktuální jazyk není k dispozici překlad. Ve výchozím nastavení slovníku jsou k dispozici překlady pro jazyky čeština a angličtina, kde čeština je hlavní jazyk.

Slovník v projektech

Probíhá-li práce ve více projektech, změna slovníku je aplikována pouze na aktuální projekt. Projekty tedy mohou mít různou strukturu dat. To je vhodné v případech, kdy je třeba připravit změnu webové prezentace, která zahrnuje i změnu struktury dat, a potvrdit a publikovat změnu dat i struktury do hlavního projektu najednou. Více viz Slučování projektů.

Nepodporované změny slovníku

Změny v datovém slovníku existující prezentace mohou poškodit existující instance položek, kterých se změny dotknou. Obecně platí, že není podporována změna, která pro existující instanci položky odstraní atribut z definice jejích typů, nebo změní typ atributu nekompatibilním způsobem. Takovou instanci položky pak nelze načíst, jeví se, jako by neexistovala. Následující operace mohou způsobit problém, měli byste se jim tedy vyhnout.

Smazání typu položky

Pokud opravdu potřebujete smazat typ položky, přesvědčte se, že neexistují žádné instance tohoto typu, ani v sezeních a projektech, a případné smazání bylo vypublikováno na všechny uzly distribuované architektury. Pak je bezpečné typ odstranit.

Odstranění atributu z typu položky

A to buď explicitně, nebo nepřímo změnou hierarchie typů. Instance položek, které obsahují hodnotu tohoto atributu, nepůjdou načíst. Doporučujeme, pokud je to možné, se této operaci raději vyhnout, pouze atribut skrýt (odstranit ho ze skupin atributů).

Změna typu atributu

Pokud změna vede na změnu interní reprezentace dat, opět položky, které mají nastavenou hodnotu atributu, nepůjdou načíst. Dovolené jsou změny například String<>HTML, Integer->BigDecimal apod. Změna String<>Integer však způsobí problém. Opět doporučujeme neprovádět, raději založte jiný atribut s jiným identifikátorem, původní atribut skryjte, a proveďte migraci dat skriptem.

Odstranění položky výčtu

Assety, odkazující na smazanou položku výčtu, nepůjdou načíst. Doporučuje se položku výčtu místo smazání označit jako smazanou, a volitelně označit stávající položku výčtu, která má sloužit jako náhrada smazané položky.