Lekce 5 - Objekty systému ObjectGears - Model

V minulé lekci, Vytvoření modelu Easytask - část 1., jsme si vytvořili základ modelu EasyTask. Model obsahoval role, několik tříd a jejich sloupce.

Objekty ObjectGears - Modely

Systém ObjectGears používá pro konfiguraci více než 100 různých objektů. Nejvyšším z nich je objekt Model, který si nyní popíšeme.

Definice Modelu

Model je nejvyšší jednotka pro logické oddělení funkcionality do samostatných "bloků". V podstatě jde o ekvivalent "aplikace". ObjectGears umožňuje funkcionalitu rozdělit do modelů a ty spravovat samostatně. Můžeme tak mít model EasyTask, model pro incidenty, model pro správu projektů nebo budov...

Pokud známe relační databáze, pak jistě víme, že všechny tabulky jsou na stejné úrovni. A pokud jich máme v aplikaci hodně, pak je to hóóóódně dlouhý seznam. V ObjectGears můžeme mít vytvořeno několik aplikací a ty mezi sebou nemusí mít žádnou spojitost. Tyto „aplikace“ tak jednoduše rozdělíme do modelů a všechny objekty, které model používá, uvidíme odděleně.

Až tedy budeme vyvíjet nový modul, pak v seznamu tříd, upozornění, skriptů... uvidíme jen objekty patřící do aktuálně vyvíjeného modelu. Toto uspořádání má několik výhod:

• Nebudou nás rušit/plést cizí objekty.
• Omylem nezměníme objekt z jiného modelu.
• Ve více modelech můžeme mít objekty stejných názvů.
• Můžeme jeden model vyexportovat a naimportovat pod jiným názvem modelu. Vše v modelu pak zůstane stejné.
• Různí lidé mohou mít práva jen do modelů, které spravují.

Přehled modelů

Na seznam modelů se dostaneme pomocí levého menu Správa / Modely / Modely. Zobrazí se nám seznam všech vytvořených modelů. U každého modelu vidíme jeho id, kód, název a IT a business vlastníky. Posledním údajem je informace, zda je model povolený:

Kliknutím na ID modelu si zobrazíme jeho detail. Dole na toolbaru je tlačítko Nový pro vytvoření nového modelu. A tlačítko Obnovit pro aktualizaci seznamu modelů.

Vedle ID modelu je ikonka pro zobrazení kontextového menu. Pomocí tohoto menu lze rychle přejít na objekty modelu. Tyto objekty si popíšeme jindy.

Vytvoření modelu

Pro vytvoření nového modelu klikneme na tlačítko Nový v seznamu modelu. Zobrazí se nám nová prázdná stránka pro definici nového modelu.:

Záložka "Základní vlastnosti"

Níže si popíšeme význam jednotlivých polí:

• Kód – kód modelu – tato informace se nezobrazuje uživateli, ale používá se ve skriptech. Kód je vhodné později již neměnit.
• Jméno – jméno modelu – zobrazuje se v menu, drobečkové navigaci, odkazech... Jméno je lokalizované (můžete mít různé názvy pro různé jazykové verze) a kdykoli ho můžete bez obav změnit.
• Povoleno – příznak zda je model povolen.
• Business Vlastník – business vlastník je osoba, která odpovídá za rozvoj modelu z hlediska businessu. Určuje, co v modelu bude, ale nemusí to být osoba, která tyto požadavky přímo implementuje.
• IT vlastník – tato osoba nerozhoduje o obsahu modelu, ale stará se o implementaci požadavků business vlastníka. Těchto uživatelů může být více.
• Poznámka – poznámka slouží ke shrnutí základních informací o modelu pro IT vlastníky. Nikde se nezobrazuje.
• Téma – nastavení barevného tématu pro konkrétní model. Ve výchozí instalaci jsou dostupná jen dvě témata – Black a Terracota. Další témata je možné si stáhnout jako samostatné instalační balíčky.

Uživatelé mají přístup jen do povolených modelů. Zrušením příznaku Povoleno okamžitě celý model deaktivujeme.

Sekce "Auditní informace"

Tato sekce obsahuje informace o tom, kdo a kdy model vytvořil a naposledy změnil. Tyto informace se plní automaticky:

Záložka "Obrázky"

Velký obrázek – obrázek se zobrazuje v levém menu:

Pro nový model nastavíme kód, název a model povolíme. Pak najejedeme na tlačítko Uložit a klikneme na volbu Uložit a zůstat. Model se uloží do databáze a zobrazí se nám další záložky.

Záložka "Role a zobrazení"

V horní části vybíráme role dostupné v modelu. Tlačítkem Přidat vybranou roli k modelu přidáme. V pravé části pak vidíme seznam rolí a zda jsou povoleny či nikoliv. Po přidání rolí nezapomeneme kliknout dole na tlačítko Uložit, aby se změny zapsaly do databáze. Kliknutím na Ano/Ne u každé role lze velmi rychle danou roli v celém modelu zakázat/povolit. Někdy může být role vypsána kurzívou, to znamená, že je zakázána přímo daná role v celém systému. Kliknutím na její název se dostaneme k definici role a tam ji lze opětovně zapnout/vypnout.

Toto vypínání role či použití role u modelu je užitečné, pokud chceme určitou funkcionalitu v modelu dočasně zakázat, aniž bychom museli uživatelům odebírat role.

Záložka "Role a zobrazení" vypadá takto:

V druhé části záložky je možné třídu modelu povolit jinému modelu. Obecně platí, že jednotlivé modely na třídy jiných modelů nevidí, ale někdy je užitečné určitou třídu jinému modelu povolit. Pokud budeme mít model s číselníky (země, města, banky, pobočky), pak je pravděpodobně budeme chtít sdílet i pro jiné modely. Zde jen vybereme danou třídu a model, který má třídu vidět, nastavíme příznak Povoleno a klikneme na tlačítko Přidat:

Záložka "Doplňující nastavení"

Zde můžeme nastavit, co se má zobrazit, pokud se v drobečkové navigaci (ze stránky Datas.aspx nebo DataDetail.aspx některé třídy modelu) klikne na název modelu. Můžeme zobrazit třídu, dotaz nebo stránku s webparty.

Záložka "Uživatelská dokumentace"

Na každé stránce máme vpravo nahoře ikonku s otazníkem. Ta nás kontextově navede na dokumentaci systému ObjectGears. Avšak uživatele v našich modelech bude spíše zajímat naše dokumentace k danému modelu. Na této záložce tak můžeme přidat přímo soubory s dokumentací (Word, PDF, Excel, txt...) nebo vložit název a URL na webovou stránku, kde je dokumentace popsána. Vložit můžeme více souborů/odkazů.

Po uložení modelu se na toolbaru zobrazilo několik dalších tlačítek:

• Nový – zobrazí novou stránku pro zadání nového modelu
• Uložit – uloží aktuální model a zobrazí se seznam modelů
• Uložit a zůstat – uloží aktuální model a zobrazí se opět aktuální model
• Smazat – smaže model (nesmí obsahovat třídy a dotazy)
• Dokumentace – zobrazí stránku pro zadání dokumentace k modelu
• Zobrazit dokumentaci – zobrazí celkovou dokumentaci k modelu
• Kontrola – provede kontrolu modelu a zobrazí tipy na zlepšení
• Info – zobrazí stránku s přehledem modelu – tuto stránku vidí normální uživatel. Pokud je na modelu nastaven Typ výchozí stránky, pak dojde k přesměrování dle tohoto nastavení.
• Model – obsahuje menu s odkazy pro přechod na různé objekty modelu
• Třídy – zobrazí seznam tříd v modelu
• Dotazy – zobrazí seznam dotazů v modelu
• Parametry – zobrazí seznam parametrů v modelu
• Archiv – zobrazí archiv změn pro aktuální model

Toolbar vypadá takto:

Smazání modelu

Před smazáním modelu smažeme všechny jeho třídy a dotazy. Ostatní objekty v modelu se pak smažou automaticky s vlastním modelem.

Přístupová oprávnění

Pro práci s modelem se rozlišují dvě přístupová oprávnění.

• Administrátor – může s modely provádět cokoliv. Vytvářet, prohlížet, měnit a mazat. Nastavuje IT vlastníky modelu.
• IT vlastník – (definuje se na modelech) – prohlíží a mění jen ty modely, u kterých je nastaven jako IT vlastník. Nemůže u modelu měnit nastavené IT vlastníky. Také nemůže model smazat.

Informace ke kódům

U většiny objektů v systému ObjectGears se zadává i kód objektu. Tento kód se pak používá ve skriptech jako identifikátor daného objektu. Ve skriptech je možnost vyhledat objekty podle jejich ID, ale toto ID je závislé na konkrétní instanci a takovýto skript pak není přenositelný na jinou instanci (vývojová → testovací → akceptační → provozní). Pokud vytvoříme objekt (např. model) ve vývojovém prostředí, pak tentýž model na provozním prostředí bude mít jiné ID. Systém totiž přiděluje ID automaticky, zatímco kódy přidělujeme my.

Níže je příklad kódu v jazyce C# pro vyhledání modelu podle ID a kódu:

// příklad vyhledání modelu dle ID
var model = OG.Model.GetById(100);
// příklad vyhledání modelu dle kódu
var model = OG.Model.GetByCode('easytask');

Vyhledání modelu podle ID z příkladu nespustíme na jiné instanci, protože model bude mít pravděpodobně jiné ID. Zatímco vyhledání podle kódu spustíme na libovolné instanci.

Lokalizace

U některých polí je vpravo ikonka pro lokalizaci:

Kliknutí na ní se zobrazí formulář pro zadání hodnoty v různých jazycích:

Pokud máme ve firmě mezinárodní kolektiv, pak můžeme nastavit všechny názvy a popisy ve více jazycích. Každý uživatel pak uvidí název ve svém zvoleném jazyce.

Jazyky, které ve firmě používáme, si můžeme povolit na stránce Správa / Lokalizace / Jazyky. Ve sloupci Lokalizovat metadata stačí kliknout na text NE a ten se změní na ANO, čímž jsme aktivovali daný jazyk pro lokalizace. Kliknutím na ikonu Jméno u modelu se pak daný jazyk zobrazí v zobrazeném okně.

Tak to je k modelům vše.

V další lekci, Objekty systému ObjectGears - Třídy a Dotazy, si popíšeme objekty Třída a Dotaz, které slouží pro ukládání a zobrazování dat v systému ObjectGears.