Author: DavidK Date: 2010-02-28 16:16:20 +0100 (Sun, 28 Feb 2010) New Revision: 1941 Added: others/dokumentace/technicalGuide/analysis/img/kategorie_panely_web.cdr others/dokumentace/technicalGuide/analysis/img/kategorie_panely_web.png others/dokumentace/technicalGuide/analysis/img/uc/ Modified: others/dokumentace/technicalGuide/analysis/4serverFunctional.tex Log: analysis updated Modified: others/dokumentace/technicalGuide/analysis/4serverFunctional.tex =================================================================== --- others/dokumentace/technicalGuide/analysis/4serverFunctional.tex 2010-02-28 14:21:24 UTC (rev 1940) +++ others/dokumentace/technicalGuide/analysis/4serverFunctional.tex 2010-02-28 15:16:20 UTC (rev 1941) @@ -5,7 +5,8 @@ %%%%%%%%%%%%%%%%%%%%%%%%% %% Pojmy %%%%%%%%%%%%%%%%%%%%%%%%% -\section{Používané pojmy pro webový server} + +\section{Používané pojmy pro analýzu webového serveru} Obecné pojmy platné v rámci celého řešení jsou umístěny v kapitole \ref{terms}. Následuje definice dalších pojmů používaných pro webovou pro webovou aplikaci: @@ -27,6 +28,8 @@ kiosky všech společností a spravovat uživatelské účty v celém systému (narozdíl od uživatele s oprávněním \textbf{Správce}). Stejně jako \textbf{Správce} nemůže ani \textbf{Hlavní správce} zasahovat do plánování a souvisejících činností. \end{description} + +[TODO -tady je to ztrouchnivělé] Následuje seznam funkcionalit systému, jejichž vykonávání je závislé na oprávnění přihlášeného uživatele. \begin{itemize} \item{Správa uživatelských účtů} \ref{user_account_managing} @@ -45,6 +48,63 @@ Pojmem \textbf{vlastní společnost uživatele} se myslí společnost, ke které uživatel patří. + +\subsection{Povolený typ plánování pro společnost} +[TODO] + +\subsection{Povolený typ plánování pro pozici rozvržení} +[TODO] + +\subsection{Typ souboru} +[TODO]Typ souboru dokumentu + +\textbf{Dokument} + +\subsection{Kategorie, Definice kategorie, Instance kategorie, panely} \label{analysis_terms.web.category} + Definice \textbf{Kategorie} a \textbf{Panelů} je popsána v kapitole v \textit{kapitole \ref{terms_kiosk}}.\\ + Pro práci s kategoriemi a panely ve webovém rozhraní systému Elvys je nutné tyto definice upřesnit. + \begin{description} + \item[Rozvržení obrazovky, Layout] Rozvržení obrazovky (nebo také Layout) definuje povolené rozmístění dokumentů na obrazvoce kiosku. + \item[Kategorie, Definice kategorie] Tyto pojmy jsou ekvivalentní a definují logickou strukturu, která sestává z rozvržení obrazovky a + pojmenování. Kategorii lze poté přiřadit více kioskům (kiosky můžou mít více přiřazených kategorií) a definuje (strukturou a názvem) + logickou oblast, na které bude možné vytvářet plánování. + + Jméno kategorie může být například \textit{Domky} a rozvržení takové, které umožní mít na obrazovce celkem 10 PDF dokumentů + rozdělených do dvou řad. + \item[Instance kategorie] Instancí kategorie je myšleno existující přiřazení kategorie některému kiosku. Na danou instanci kategorie + je možné plánovat data (definici povolených typů a rozmístění těchto dat na obrazovce kiosku definuje \textbf{Definice kategorie}). + Existující instance kategorie může být v systému sdílena více kiosky. Plánování dat na kategorii na jednom kiosku se tedy projeví + i na ostatních kioscích, které obsahují tutéž sdílenou Instanci kategorie. + \item[Panel] Každá \textbf{Instance kategorie} sestává z jednoho či více panelů, které odpovídají 1:1 obrazovkám kiosku. + Panel je určen k plánování zobrazitelných dat, rozvržení pozic a povolené typy plánování jsou dány \textbf{Definicí kategorie} instance, + do níž panel patří. Panely patří právě jedné \textbf{Instanci kategorie}, není možno je sdílet. + \item[Plánování] Plánování zobrazitelných dat je vždy vztaženo pro zvolený \textbf{Kiosek}, + některou z jemu přiřazených \textbf{Instancí kategorie}, \textbf{Panel} a \textbf{Pozici}. + \end{description} + + Na \textit{obrázku \ref{img.analysis_kategorie_panely}} je uveden příklad dvou vytvořených kategoríí nesoucích jméno a rozvržení + (pro názornost oznaženy A a B) a jejich přiřazení ke kioskům.\\ + \textit{Kategorie A} je přiřazena \textit{Kiosku 1} a \textit{Kiosku 2} + a bylo použito stejné \textit{Instance kategorie}. Na obou kioscích je tedy zobrazený obsah této kategorie(s názvem \textit{xxxxxxxxx}) stejný a obsahuje 2 panely s daty.\\ + \textit{Kategorie B} je přiřazena \textit{Kiosku 2}, \textit{Kiosku 3} a \textit{Kiosku 4}. Obrazovky kiosků 2 a 3 zobrazují pro kategorii s názvem \textit{yyyyyyyyyy} stejný obsah, + zatímco kiosek 4 ukazuje data jiná (daná kategorie na kiosku má i jiný počet \textbf{panelů}). + + + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.5]{img/kategorie_panely_web} + \caption[Schematický nákres přiřazení kategorií kioskům]{\small \textbf{Schematický nákres přiřazení kategorií kioskům}} + \label{img.analysis_kategorie_panely} + \end{center} + \end{figure} + +\subsection{Nahrávání dokumentu, upload dokumentu} +Uploadem dokumentu na server se myslí použití komponenty určené k nahrávání souborů na server. + +\subsection{Rozlišení obrazovky, poměr stran} +Rozlišení a poměr stran obrazovky se používá při vytváření rozvržení obrazovky a rozlišení je také definováno pro obrazovku +každého kiosku. + \subsection{Statistiky} Grafické i textové zobrazení zvětšení dokumentů na kioscích ve zvoleném časovém období v minulosti. @@ -52,126 +112,378 @@ Grafické i textové zobrazení událostí vystavení dokumentů na kioscích ve zvoleném časovém období v minulosti. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 1 Společnosti +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Společnosti}\label{analysis_company_management} + \subsection{Správa společností} + Jak již bylo zmíněno, systém ELVYS může být využíván více společnostmi. + Systému Elvys bude tedy umožňovat správu společností (\textit{viz obr. \ref{img.uc_company1}}). + Všechny akce spojené se správou společností bude moci provádět pouze uživatel s oprávněním \textbf{Hlavní správce}. + + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/1company} + \caption[Use Case diagram správy společností]{\small \textbf{Use Case diagram správy společností}} + \label{img.uc_company1} + \end{center} + \end{figure} + + \subsubsection{Zobrazení seznamu společností} + Zobrazí seznam společností v přehledné tabulce, umožní vyhledávání, řazení, odkazy na další funkčnosti. + \subsubsection{Vytvoření společnosti} + Systém zobrazí uživateli formulář pro vytvoření nové společnosti. + \subsubsection{Úprava společnosti} + Systém zobrazí uživateli formulář pro úpravu existující společnosti. + \subsubsection{Smazání společnosti} + Systém umožní uživateli smazat společnost. Před smazáním společnosti bude po uživateli požadováno potvrzení, zda opravdu + chce smazat danou společnost. + + \subsection{Správa povolených typů plánování společnosti} + Každá společnost v systému bude mít povoleny určité typy plánování. Uživatelé dané společnosti potom budou moci + plánovat pouze takové data, jejichž typy mají povoleny. Povolenými typy plánování bude také omezeno nahrávání dat na server + (více viz \textit{kapitola \ref{analysis_file_management}}). + + Akce související s nastavováním povolených typů plánování jsou znázorněny na \textit{obrázku \ref{img.uc_company2}}. + Tyto akce může provádět pouze uživatel s oprávněním \textbf{Hlavní správce}. + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/1company2} + \caption[Use Case diagram povolených typů plánování]{\small \textbf{Use Case diagram povolených typů plánování}} + \label{img.uc_company2} + \end{center} + \end{figure} + + \subsubsection{Přidání povoleného typu plánování} + Systém umožní uživateli přidat pro zvolenou společnost právo používat daný typ plánování. + Tato změna se dotkne těch pozic rozvržení, na nichž bylo před přidáním možno plánovat jakékoliv data. + Po přidání bude na tyto pozice možno plánovat vše, co předtím a navíc i nový typ plánování. + Před provedením akce bude uživateli zobrazeno, kolika pozic se tato akce dotkne. + + \subsubsection{Odebrání povoleného typu plánování} + Systém umožní uživateli odebrat pro zvolenou společnost právo používat daný typ plánování. + Touto akcí ztratí společnost právo plánovat daný typ plánování, tak budou všechna existující + plánování daného typu dokumentu pro danou společnost ze systému odstraněny.\\ + Navíc pokud po odebrání typu plánování nebude ve společnosti existovat jiný typ plánování + využívající stejný typ dokumentu, budou pro daný typ dokumenu a pro danou společnost + ze systému smazány existující dokumenty. + + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Uživatelé +%% 2 Uživatelé %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Správa uživatelských účtů}\label{user_account_managing} -Systém umožňuje oprávněnému uživateli spravovat uživatelské účty. +\section{Uživatelé}\label{user_account_managing} +Systém Elvys bude umožňovat autorizovaným uživatelům spravovat uživatelské účty. +\textit{Obrázek \ref{img.uc_user}} zobrazuje akce uživatele související se správou uživatelských účtů. -Uživatel s oprávněním \textbf{běžný uživatel} nemůže žádným způsobem zasahovat do správy uživatelských účtů. + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/2user} + \caption[Use Case diagram správy uživatelských účtů]{\small \textbf{Use Case diagram správy uživatelských účtů}} + \label{img.uc_user} + \end{center} + \end{figure} -Uživatel s oprávněním \textbf{manažer} může vytvářet, upravovat a mazat uživatelské účty s -oprávněním \textbf{běžný uživatel} patřící do stejné společnosti, do které patří daný uživatel. + \subsubsection{Zobrazení seznamu uživatelů} + K zobrazení seznamu uživatelů bude autorizován uživatel s jakýmkoliv typem uživatelské role. \\ + Uživatelé s rolemi \textbf{Správce}, \textbf{Manažer}, \textbf{Uživatel} uvidí v + tomto seznamu pouze uživatele patřící do stejné společnosti. \\ + Uživatelé s rolemi \textbf{Hlavní správce} uvidí v tomto seznamu uživatele všech společností. + \subsubsection{Vytvoření uživatele} + Přidá do systému nového uživatele. Právo provádět tuto akci budou mít pouze uživatelé s uživatelskými rolemi + \textbf{Správce} a \textbf{Hlavní správce}.\\ + Uživatel s oprávněním \textbf{Správce} bude moci vytvářet uživatele pouze v rámci společnosti, do které patří a + jím vytvoření uživatelé budou moci mít buď roli \textbf{Uživatel} nebo \textbf{Manažer}. \\ + Uživatel s oprávněním \textbf{Hlavní správce} bude moci vytvářet uživatele v rámci celého systému, tzn. jím + vytvoření uživatelé budou moci náležet jakékoliv společnosti v systému. Bude moci vytvářet uživatele s oprávněními + \textbf{Správce}, \textbf{Manažer} a \textbf{Uživatel}. + \textbf{Úprava osobního profilu} + Každý uživatel systému (bez ohledu na oprávnění) bude moci měnit své osobní údaje. Za osobní údaje se považuje + jméno, kontakt, heslo. + \subsubsection{Editace uživatele} + V systému Elvys budou moci autorizovaní uživatelé upravovat uživatelské účty ostatních uživatelů. Potřebná + uživatelská oprávnění k provádění této akce budou stejná jako v případě vytváření uživatele.\\ + Uživatel s oprávněním \textbf{Správce} bude moci upravovat pouze uživatelské účty v rámci vlastní společnosti.\\ + Uživatel s oprávněním \textbf{Hlavní správce} bude moci upravovat uživatelské účty patřící do všech společností. + Nebude však moci změnit společnost, ke které upravovaný uživatel patří. + + \subsubsection{Smazání uživatele} + Oprávněný uživatel systému bude mít možnost mazat uživatelské účty jiných uživatelů. Před smazáním jakéhokoliv uživatelského účtu + bude uživatel provádějící akci nucen akci potvrdit. Až potom dojde ke smazání uživatele. Uživatelé oprávnění k provádění + této akce jsou \textbf{Správce} a \textbf{Hlavní správce}, tedy stejně jako u akcí vytvoření uživatele a smazání uživatele.\\ + Uživatel s oprávněním \textbf{Správce} bude moci mazat uživatele patřící do vlastní společnosti mající oprávnění + \textbf{Manažer} a \textbf{Uživatel}. \\ + Uživatel s oprávněním \textbf{Hlavní Správce} bude moci mazat uživatele patřící do jakékoliv společnosti mající uživatelská oprávnění + \textbf{Správce}, \textbf{Manažer}, \textbf{Uživatel}. + + Vliv smazání uživatele na další části systému: Smazání uživatele ze systému nevyvolá smazání ani úpravu souborů, + rozvržení, plánování ani dalších entit v systému, které uživatel vytvořil či nějak změnil. + + \subsubsection{Zaslání dočasného hesla při ztrátě přihlašovacích údajů} + [TODO - JM] -Uživatel s oprávněním \textbf{administrátor} může vytvářet, upravovat a mazat jakékoli uživatelské účty v kterékoli společnosti. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 3 Soubory +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Soubory} +Systém bude umožňovat uschovávat dokumenty (tj. soubory různých podporovaných typů), které budou používány k plánování na kiosek. +Úložiště souborů budou oddělena podle společností tak, aby uživatelé měli přístup pouze k dokumentům patřícím do vlastní společnosti. +Akce související se správou dokumentů jsou znázorněny na obrázku \textit{obrázku \ref{img.uc_file}}. \\ +Uživatelé autorizovaní pro nahrávání dokumentů do systému a práci s nimi mají role \textbf{Manažer} a \textbf{Uživatel}. Uživatelé s jinými +rolemi pracovat se soubory nemohou. -\section{Správa společností} -Uživatel systému s oprávněním \textbf{administrátor} bude mít možnost vytvářet a upravovat společnosti v systému. + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/3file} + \caption[Use Case diagram správy dokumentů]{\small \textbf{Use Case diagram správy dokumentů}} + \label{img.uc_file} + \end{center} + \end{figure} + + \subsubsection{Nahrávání souborů na server (upload)} + Nahrávání souborů bude probíhat přes webové rozhraní systému. Možné formáty nahrávaných dokumentů budou dány + povolenými typy plánování, které může daná společnost aktuálně používat.\\ + Uživatel bude moci pro nahrávaný souboru zadat textovou poznámku sloužící pro zdokumentování obsahu souboru \footnote{( + tato poznámka bude viditelná pouze ve webovém rozhraní systému Elvys a nezasáhne do zobrazení naplánovaných dokumentů na kiosku}\\ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Soubory -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Správa souborů na serveru} -Systém bude obsahovat sklad PDF dokumentů a videa, který bude sloužit jako zdroj souborů při plánování na kiosek. -Soubory ve skladu jsou viditelné pouze uživatelům patřícím do stejné společnosti, jako uživatel, který soubor do systému nahrával. - -\subsubsection{Nahrávání souborů na server} -Nahrávání souborů bude probíhat přes webové rozhraní systému. -Uživatel bude moci pro nahrávaný souboru zadat textový popis a přiřadit štítky sloužící pro lepší orientaci mezi dokumenty (viz níže). -\subsubsection{Vyhledávání souborů podle štítků}\label{server_document_labels} -Při práci se seznamem souborů (např. při správě dokumentů či při vytváření plánování obsahu kiosku) bude moci uživatel přehledně filtrovat soubory podle štítků. -Postup: \\ -Při práci se seznamem souborů zvolí uživatel štítky, které ho zajímají. \\ -Systém najde všechny soubory, které mají přiřazeny všechny dané štítky (tj. i ty, které mají přiřazeny další štítky) a zobrazí je uživateli. + \subsubsection{Zobrazení seznamu souborů} + Systém nabídne uživateli přehledně zobrazený seznam dokumentů. V seznamu budou uvedeny pouze dokumenty, pro něž exituje + typ plánování, jenž má daná společnost aktuálně povoleno používat. Seznam bude použit nejenom při správě dokumentů, ale také + při zadávání plánování (viz \textit{kapitola \ref{analysis_planning}}) a uživatel s tímto seznamem bude přicházet často do styku. + Musí proto být co nejvíce uživatelsky příjemný a umožňovat rychlé nalezení dokumentu, který uživatel hledá.\\ + V seznamu se bude dát vyhledávat podle jména dokumentu, + poznámky dokumentu a uživatele který dokument do systému nahrál. \\ + Bude možno jednoduchým způsobem filtrovat záznamu v tabulce podle zvoleného typu.\\ + Seznam souborů bude také umožňovat řazení podle datumu a času nahrání souborů do systému.\\ + Systém také umožní zobrazení jednoduchého přehledu existujících plánování pro vybraný dokument. -\subsubsection{Mazání souborů} -Systém umožní uživateli smazat libovolný soubor patřící jeho společnosti. -Pokud uživatel zvolí k smazání soubor, pro nějž existuje plánování na některém kiosku zasahující do budoucnosti, systém zobrazí uživateli varování. Uživatel se rozhodne, zda pokračovat. -Při mazání souboru ze systému dojde k úpravě existujících plánování daného dokumentu na kioscích: -\begin{itemize} - \item{plánování celé v minulosti: } Plánování zůstane v systému kvůli podpoře reportů. - \item{plánování celé v budoucnosti: } Plánování se smaže, v systému není potřebné. - \item{plánování částečně zasahující do budoucnosti: } Plánování bude zkráceno, tj. bude zachováno jen plánování do aktuálního data. -\end{itemize} + \subsubsection{Mazání souborů} + Systém umožní uživateli smazat libovolný soubor patřící jeho společnosti. + Pokud uživatel zvolí k smazání soubor, pro nějž existuje plánování na některém kiosku zasahující do budoucnosti, + systém zobrazí uživateli varování ztráty plánování. Uživatel se rozhodne, zda pokračovat.\\ + Pokud neexistuje budoucí plánování mazaného dokumentu, systém zobrazí uživateli dotaz, zda chce opravdu pokračovat.\\ + + Vliv smazání souboru na další části systému: + \begin{itemize} + \item Dojde ke smazání všech existujících plánování daného dokumentu. + \item Nedojde k žádnému ovlivnění statistik plánování, soubor v nich bude i nadále uváděn. + \end{itemize} -\subsubsection{Počítání stránek pdf dokumentů} -PDF dokumenty budou po nahrání validovány - bude jim spočítán počet stránek a zaznamenán do systému pro využití při plánování. -PDF dokument, u kterého se nepodaří spočítat počet stránek nebude do systému přijat a systém oznámí uživateli chybu. - %%%%%%%%%%%%%%%%%%%%%%%%%% -%% Kiosky +%% 4 Layouty %%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Správa kiosků} -Systém umožňuje vytvářet, konfigurovat a mazat kiosky uživatelům s oprávněním \textbf{administrátor}. Ostatní uživatelé tyto zásahy provádět nemohou. -\subsubsection{Vytváření/Editace kiosku} -Uživatel s oprávněním \textbf{administrátor} bude oprávněn vytvářet v systému kiosky patřící k určitým společnostem a kiosky také upravovat. -\subsubsection{Mazání kiosku} +\section{Rozvržení obrazovky} +Systém umožní uživateli spravovat rozvržení obrazovky. Rozvržení obrazovky definují rozmístění a povolený obsah plánování +na jednu obrazovku kiosku. Akce uživatele související se správou rozvržení obrazovky jsou zobrazeny na \textit{obrázku \ref{img.uc_layout}}. -\section{Nastavení kiosků} -\subsubsection{Aktivace/deaktivace kiosku} -Kiosek může být ve dvou stavech - aktivní a neaktivní. Pokud je kiosek v systému z nějakého důvodu deaktivován, tak reálný kiosek nezobrazuje žádná data. Zobrazí pouze hlášení, že je dočasně deaktivován. -Uživatel s oprávněním \textbf{manažer} bude moci v systému kiosek patřící do stejné společnosti aktivovat a deaktivovat. + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/4layout} + \caption[Use Case diagram správy rozvržení obrazovky]{\small \textbf{Use Case diagram správy rozvržení obrazovky}} + \label{img.uc_layout} + \end{center} + \end{figure} - -%\section{Noční režim kiosku} -%[TODO] -rozmyslet -%Noční režim kiosku je úspornější mód kiosku, po jehož dobu -%Uživatel bude moci kiosek nastavit pro chod v nočním režimu pomocí specifikace času začátku a konce tohoto režimu. -%\subsubsection{Nastavení rozvržení } + + [TODO dopsat role] + [TODO projít] + + Uživatel systému s oprávněním \textbf{běžný uživatel} nebo \textbf{manažer} bude moci spravovat v systému rozvržení obrazovky pro vlastní společnost. + \subsubsection{Zobrazení seznamu rozvržení} + Systém zobrazí uživateli v přehledné formě seznam rozvržení obrazovky. V tomto seznamu jsou pouze data dané společnosti. + Uživatel nad tímto seznamem poté může vykonávat další operace. + \subsubsection{Vytvoření nového rozvržení obrazovky} + Pro vytvoření nového rozvržení obrazovky spustí systém uživateli nástroj \textit{LayoutDesigner} (více v kapitolách \ref{layoutdesigner_communication} a \ref{layoutdesigner_specification}) + \subsubsection{Editace rozvržení obrazovky} + Uživatel zvolí ze seznamu rozvržení obrazovky, které si přeje editovat. Systém uživateli umožní editovat zvolené rozvržení obrazovky pomocí nástroje \textit{LayoutDesigner} (více v kapitolách \ref{layoutdesigner_communication} a \ref{layoutdesigner_specification}) + \subsubsection{Smazání starého rozvržení obrazovky} + Uživatel zvolí ze seznamu rozvržení obrazovky, které si přeje smazat. Systém zkontroluje, zda některý kiosek neobsahuje kategorii s tímto rozvržením obrazovky. + Pokud ne, rozvržení může být ze systému odstraněno. Pokud ano, systém nejenom odstraní dané rozvržení ze systému, ale také deaktivuje kiosky, u kterých se rozvržení používá. -%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Screenshoty -%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Zobrazení snímku obrazovky kiosku\label{server_screenshot}} -Kiosek periodicky odesílá systému aktuální snímek obrazovky a tento snímek si bude moci uživatel v systému prohlédnout. %%%%%%%%%%%%%%%%%%%%%%%%%% -%% Layouty +%% 5 Kategorie %%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Správa rozvržení obrazovky} -Uživatel systému s oprávněním \textbf{běžný uživatel} nebo \textbf{manažer} bude moci spravovat v systému rozvržení obrazovky pro vlastní společnost. -\subsubsection{Zobrazení seznamu rozvržení} -Systém zobrazí uživateli v přehledné formě seznam rozvržení obrazovky. V tomto seznamu jsou pouze data dané společnosti. -Uživatel nad tímto seznamem poté může vykonávat další operace. -\subsubsection{Vytvoření nového rozvržení obrazovky} -Pro vytvoření nového rozvržení obrazovky spustí systém uživateli nástroj \textit{LayoutDesigner} (více v kapitolách \ref{layoutdesigner_communication} a \ref{layoutdesigner_specification}) -\subsubsection{Editace rozvržení obrazovky} -Uživatel zvolí ze seznamu rozvržení obrazovky, které si přeje editovat. Systém uživateli umožní editovat zvolené rozvržení obrazovky pomocí nástroje \textit{LayoutDesigner} (více v kapitolách \ref{layoutdesigner_communication} a \ref{layoutdesigner_specification}) -\subsubsection{Smazání starého rozvržení obrazovky} -Uživatel zvolí ze seznamu rozvržení obrazovky, které si přeje smazat. Systém zkontroluje, zda některý kiosek neobsahuje kategorii s tímto rozvržením obrazovky. -Pokud ne, rozvržení může být ze systému odstraněno. Pokud ano, systém nejenom odstraní dané rozvržení ze systému, ale také deaktivuje kiosky, u kterých se rozvržení používá. -TODO +\section{Kategorie} +Tato kapitola popisuje kategorie, instance kategorií, jejich přiřazování kiosků, panely instancí kategorií a další. +Pro správné pochopení této kapitoly je nutné nejdříve si přečíst \textit{kapitolu \ref{analysis_terms.web.category}}. +Operace popisované v této kapitole může provádět uživatel s oprávněním \textbf{Uživatel} nebo \textbf{Manažer}. Uživatelé s jinými +uživatelskými rolemi nejsou oprávněni tyto akce provádět. + + \subsection{Správa kategorií} + Systém umožní uživateli spravovat kategorie plánování. Rozvržení obrazovky definují rozmístění a povolený obsah plánování + na jednu obrazovku kiosku. Akce uživatele související se správou rozvržení obrazovky jsou zobrazeny na \textit{obrázku \ref{img.uc_layout}}. + + + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/5category} + \caption[Use Case diagram správy kategorií]{\small \textbf{Use Case diagram správy kategorií}} + \label{img.uc_category} + \end{center} + \end{figure} + + + + \subsubsection{Vytvoření kategorie} + Systém umožní uživateli při plánování pro kiosek vytvářet kategorie pro umístění panelů. Při vytváření kategorie uvede + uživatel její jméno, které musí být unikátní v rámci všech kategorií. + + \subsubsection{Zobrazení seznamu kategorií} + [TODO napsat] + \subsubsection{Úprava kategorie} + [TODO napsat] + \subsubsection{Nastavení rozvržení kategorie} + [TODO napsat] + \subsubsection{Smazání kategorie} + [TODO napsat] + + Vliv smazání kategorie na další části systému: + \begin{itemize} + \item[a] + \item[a] + \item[a] + \item[a] + \end{itemize} + + + + \subsection{Použití kategorií} + Systém umožňuje provádět s kategoriemi vytvořenými v systému další akce. + \textit{Obrázek \ref{img.uc_category2}} zachycuje tyto akce. + + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/5category2} + \caption[Use Case diagram použití kategorií]{\small \textbf{Use Case diagram použití kategorií}} + \label{img.uc_category2} + \end{center} + \end{figure} + + \subsubsection{Přiřazení kategorie plánování kiosku} + Systém umožní uživateli přiřadit kiosku kategorii plánování, která ještě na kiosku přiřazena není. Při přiřazování + kategorie bude uživatel dotázán, zda se má kiosku přiřadit nová instance kategorie, nebo některá z již existujících. + Více informací níže. + \subsubsection{Odebrání kategorie plánování kiosku} + Systém umožní odebrání kategorie z daného kiosku. Tím se kategorie znepřístupní pro plánování a nebude nadále + zobrazena na kiosku. + + Vliv odebrání kategorie na další části systému:\\ + Pokud byla instance odebírané kategorie sdílena mezi další kiosky, nedojde v systému k žádné další akci.\\ + Pokud nebyla instance odebírané kategorie sdílena mezi další kiosky: + \begin{itemize} + \item Systém smaže všechna plánování vztažená ke kterémukoliv panelu dané instance. + \item Systém zanechá beze změny všechny statické údaje o v minulosti uskutečněných plánováních. + \end{itemize} + + \subsubsection{Změna pořadí přiřazených kategoríí(Instancí kategorií) na kioscích} + Instance kategorií přiřazené na kiosku budou očíslovány podle času jejich přiřazení. V tomto pořadí budou kategorie + zobrazovány na obrazovce kiosku. Pořadí instancí kategorií může být uživatelem jednoduše změněno. + \subsubsection{Sdílení kategorií mezi kiosky} + [TODO - pouzit neco ze sekce o planovani] + + + \subsection{Správa panelů na instancích kategorií} + \textbf{Panel} v systému odpovídá jedné reálné obrazovce na kiosku. Každý panel je svázán právě s jednou instancí kategorie, + panely nemohou být (narozdíl od celých instancí kategorií) sdíleny, ani nijak vyměňovány mezi instancemi kategorií. \\ + Panely jsou v rámci instance kategorie očíslovány, jejich pořadová čísla se nemohou měnit. + Na kiosku budou zobrazeny pouze panely, které budou obsahovat v daném časovém okamžiku zobrazení nějaké plánování. + Očíslování panelů dané kategorie zobrazené na kiosku nemusí být tedy vždy konzistentní s očíslováním panelů ve webovém systému. + Na \textit{obrázku \ref{img.uc_category3}} jsou uvedeny akce související se správou panelů. + + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/5category3} + \caption[Use Case diagram správy panelů na instancích kategorií]{\small \textbf{Use Case diagram správy panelů na instancích kategorií}} + \label{img.uc_category2} + \end{center} + \end{figure} + + \subsubsection{Zobrazení více panelů} + Uživatel může v systému zvolit, kolik panelů zvolené instanci kategorie uvidí. Maximální počet zobrazených panelů + pro danou instanci kategorie není omezen. Počet zobrazených panelů na obrazovce kiosku pro danou kategorii je ovšen + dán pouze tím, zda daný panel obsahuje plánování či nikoliv. Počet zobrazených panelů ve webovém rozhraní tedy nemá + za následek zvýšení počtu zobrazených panelů na kiosku. + + \subsubsection{Automatické skrývání koncových panelů} + Systém bude podporovat automatické skrývání prázdných panelů. Uživatel si při plánování zvolí, kolik panelů bude vidět. Nicméně na kiosku se zobrazí pouze prvních X panelů, které v dané chvíli obsahují nějaké plánování. + + + %%%%%%%%%%%%%%%%%%%%%%%%%% -%% Plánování +%% 6 Kiosky %%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Kiosky} +Systém umožňí autorizovaným uživatelům spravovat kiosky. Akce související s kiosky v systému Elvys jsou +na \textit{obrázku \ref{img.uc_elvys}}. + + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/6elvys} + \caption[Use Case diagram správy kiosků]{\small \textbf{Use Case diagram správy kiosků}} + \label{img.uc_elvys} + \end{center} + \end{figure} + -\section{Správa kategorií a panelů} -\subsubsection{Vytvoření kategorie} -Systém umožní uživateli při plánování pro kiosek vytvářet kategorie pro umístění panelů. Při vytváření kategorie uvede uživatel její jméno, které musí být unikátní v rámci všech kategorií. -\subsubsection{Přejmenování kategorie} -Kategorie bude moci být přejmenována čímž dojde k přejmenování všech panelů, které kategorie obsahuje. -\subsubsection{Odebrání kategorie} -Systém umožní odebrání kategorie z daného kiosku. Tím se kategorie znepřístupní pro plánování a nebude nadále zobrazena na kiosku. -\subsubsection{Opětovné přidání kategorie} -Uživatel bude mít možnost odebranou kategorii danému kiosku opět přidat. Tím se zpřístupní plánování dat pro tuto kategorii a zároveň se tato kategorie zobrazí na obrazovce kiosku. + \subsubsection{Zobrazení seznamu kiosku} + Systém umožní uživatelům zobrazi seznam kiosků v přehledné formě.\\ + Uživatel s oprávněním \textbf{Hlavní správce} uvidí v seznamu kiosky všech spolenčností.\\ + Uživatel s oprávněním \textbf{Manažer} nebo \textbf{Uživatel} uvidí v seznamu pouze kiosky vlastní společnosti. + + + \subsubsection{Vytváření kiosku} + Uživatel s oprávněním \textbf{Hlavní správce} bude moci v systému vytvářet nové kiosky. Při vytváření zadá, do které + společnosti bude nově vytvářený kiosek patřit, název kiosku, adresu umístění a rozlišeni obrazovky kiosku. + Uživatelé s jinými uživatelskými účty nemají právo vytvářet v systému kiosek. + + \subsubsection{Úprava kiosku} + Uživatel s oprávněním \textbf{Hlavní správce} bude moci také upravovat existující kiosek. Bude moci změnit všechny parametry + zadané při jeho vytváření až na společnost, které daný kiosek patří. + + \subsubsection{Mazání kiosku} + Uživatel s oprávněním \textbf{Hlavní správce} bude moci mazat kiosky patřící kterékoliv společnosti. + + Vliv smazání kiosku na další části systému: + \begin{itemize} + \item Dojde k odebrání všech kategorií z kiosku. Pokud pro některé přiřazení kategorie existovalo + plánování a toto přiřazení kategorie nebylo sdíleno mezi více kiosky, dojde ke smazání veškerého plánování na přiřazené kategorii. + (více viz \textit{kapitola \ref{analysis_category_assign}}) [TODO DK] + \item Nedojde ke smazání statistik souvisejících s daným kioskem [TODO JM] + \end{itemize} -\subsubsection{Přidávání panelů} -Uživatel může ve zvolené kategorii přidávat panely. Tyto panely patří právě do zvolené kategorie a jsou podle ní automaticky pojmenovány. -\subsubsection{Skrývání panelů} -Systém bude podporovat skrývání prázdných panelů. Uživatel si při plánování zvolí, kolik panelů bude vidět. Nicméně na kiosku se zobrazí pouze prvních X panelů, které v dané chvíli obsahují nějaké plánování. -\subsubsection{Odebírání panelů} -Odebírání panelů nebude možné, pouze skrývání. + \subsubsection{Aktivace/deaktivace kiosku} + Kiosek může být ve dvou stavech - aktivní a neaktivní. Aktivaci a deaktivaci kiosku může provádět pouze uživatel s oprávněním + \textbf{Hlavní správce}. Pokud je kiosek v systému z nějakého důvodu deaktivován, přestane na obrazovce dočasně zobrazovat naplánovaná data. + \section{Zobrazení snímku obrazovky kiosku\label{server_screenshot}} + Systém bude uchovávat aktuální snímky obrazovky všech kiosků. Uživatel si může tento snímek obrazovky přes webové rozhraní systému prohlédnout. + Tato funkcialita je dostupná uživatelům s rolemi \textbf{Hlavní správce}, \textbf{Manažer} a \textbf{Uživatel}. + +%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 7 Plánování +%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Plánovací obrazovka} +Na \textit{obrázku \ref{img.uc_planning}} +[TODO projít, doplnit] + + \begin{figure}[ht] + \begin{center} + \includegraphics[scale=0.7]{img/uc/7planning} + \caption[Use Case diagram plánování]{\small \textbf{Use Case diagram plánování}} + \label{img.uc_planning} + \end{center} + \end{figure} + \subsubsection{Volba kategorie a panelu} Před započetím plánování uživatel zvolí kategorii, se kterou bude v plánování pracovat a poté panel z dané kategorie, na který bude data plánovat. \subsubsection{Plánovací obrazovka, rozvržení obrazovky, časové okno} @@ -215,6 +527,8 @@ %%%%%%%%%%%%%%%%%%%%%%%%%% \section{Statistiky} +[TODO JM od DK chybi ti tu popsana autorizaci + uvidim ve statistikach odstranene kiosky a dokumenty?] +[TODO JM chybi mi tu UC diagram aby to bylo konzistentni se zbytkem analyzy] Systém umožní uživateli sledovat zobrazování jednotlivých dokumentů na kiosku. Uživatel bude mít k dispozici celkem 3 zobrazení, na každé bude zobrazen počet návštěv (tj. událost zvětšení dokumentu uživatelem na kiosku) @@ -328,8 +642,9 @@ %%%%%%%%%%%%%%%%%%%%%%%%%% %% Reporty %%%%%%%%%%%%%%%%%%%%%%%%%% - \section{Reporty} +[TODO JM od DK chybi ti tu popsana autorizace + uvidim v reportech (jak ve filtru, tak ve vysledku) odstranene kiosky a dokumenty?] +[TODO JM chybi mi tu UC diagram aby to bylo konzistentni se zbytkem analyzy] Systém umožní uživateli zobrazit přehled vyvěšení dokumentů na kioscích. Uživatel provede zobrazení reportů pomocí úvodního filtru, ve kterém si vybere dokumenty, kiosky a zvolí časové období, ve kterém jej vyvěšení dokumentů zajímá. Added: others/dokumentace/technicalGuide/analysis/img/kategorie_panely_web.cdr =================================================================== (Binary files differ) Property changes on: others/dokumentace/technicalGuide/analysis/img/kategorie_panely_web.cdr ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: others/dokumentace/technicalGuide/analysis/img/kategorie_panely_web.png =================================================================== (Binary files differ) Property changes on: others/dokumentace/technicalGuide/analysis/img/kategorie_panely_web.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream