CRM SYSTÉM KORMORÁN PŘÍRUČKA ADMINISTRÁTORA
Obsah 1 Administrace systému 3 1.1 Uživatelské účty.................................. 3 1.2 Přístupová práva................................. 3 1.3 Moduly....................................... 3 1.4 Skupiny atributů................................. 4 1.5 Atributy...................................... 4 1.6 Hodnoty atributů................................. 4 2 Instalace systému 5 2.1 Instalace serverů................................. 5 2.2 Instalace aplikace................................. 5 2.3 Vytvoření databáze a připojení do databáze.................. 5 3 Typické úlohy 7 3.1 Přidání nového typu záznamů......................... 7 2
Kapitola 1 Administrace systému Pokud přihlášený uživatel patří do skupiny administrátorů, jako poslední položka v menu se mu zobrazí odkaz uživatel. Po kliknutí na tuto položku změní položky menu na Uživatelé, Práva, Moduly, Skupiny, Atributy, Hodnoty, které uživateli umožní spravovat instalaci systému. 1.1 Uživatelské účty V modulu Uživatelé lze provést zřízení nového účtu pro přístup do systému. Login a heslo slouží jako přihlašovací údaje, pod nimiž se uživatel přihlašuje do systému. Jako login i heslo musí být uveden řetězec znaků maximální délky 20. Skupiny slouží jako seznam skupin, do nichž uživatel patří. Názvy skupin musí být odděleny čárkou a mezerou. Standardně používané skupiny v systému jsou users pro obyčejné uživatele a admin pro administrátory. Jako jméno může být uvedeno např. příjmení uživatele, popř. název oddělení či pozice, pokud se jedná o účet pro určité oddělení ve firmě či pozici. 1.2 Přístupová práva Přístupová práva slouží pro definici přístupových práv pro jednotlivé moduly či konkrétní záznamy a skupiny uživatelů či konkrétní uživatele. Jako modul musí být uvedeno jméno modulu, k němuž se má přístupové právo vztahovat. Jako atribut může být uden název atributu, k němuž se má přístupové právo vztahovat. Není-li uveden, přístupové právo se vztahuje na všechny záznamy daného modulu. Podmínka pomáhá specifikovat, na které záznamy se má právo vztahovat tím, že definuje hodnoty, které může mít záznam na uvedeném atributu. Rozlišují se tři úrovně přístupu. Dále musí být vyplněn atribut Skupina, nebo Uživatel. Tyto atributy specifikují, pro které skupiny uživatelů nebo uživatele se dané právo vztahuje. 1.3 Moduly Moduly slouží pro vytváření a správu typů záznamů, které mají být v systému přístupné. Zkratka definuje jméno modulu v databázi a může proto obsahovat pouze znaky a-z a A-Z bez diakritiky. Název slouží jako název modulu. Název pro menu jako název modulu, který se bude zobrazovat v menu. Měl by být proto nejlépe jednoslovný. Pozice určuje pořadí v jakém se má zobrazovat odkaz na modul v menu. Zatržítko Admin menu určuje, má-li být odkaz na modul zobrazován v menu pro obyčejného uživatele nebo administrátora. 3
1.4. SKUPINY ATRIBUTŮ KAPITOLA 1. ADMINISTRACE SYSTÉMU 1.4 Skupiny atributů Skupiny atributů slouží ve formulářích ke zlepšení orientace a zpřehlednění. Vytvářejí pojmenovanou skupinu atributů. Název definuje pojmenování skupiny a zobrazuje se tučně a kapitálkami nad danou skupinou. Modul určuje jméno modulu, ke kterému skupina patří. Pozice slouží k určení pozice skupiny ve formuláři. První pozice je v levém sloupci nahoře, druhá je v pravém sloupci nahoře, třetí opět v levém sloupci pod první atd. 1.5 Atributy Atributy jsou vlastnosti jednotlivých položek v modulu. Např. jméno a příjmení u osoby či název u firmy. Zobrazují se jako jednotlivé položky v editačním formuláři. Název určuje pojmenování atributu, které se bude zobrazovat ve formulářích, přehledech, filtrech atd. Typ určuje typ atributu. Modul je jméno modulu, ke kterému se atribut vztahuje. Atribut je název atributu pro databázi a nesmí tedy obsahovat znaky s diakritikou. Implicitní je hodnota, která bude předvyplněna u daného atributu při zakládání nového záznamu. Např. u www adresy by zde mohlo být http://. U atributů typu datum zde může být přirozené číslo, které označuje počet hodin a přidává se k aktuálnímu času. U atributů typu vazba 1:N odkazujících na uživatele zde může být řetězec user, který označuje aktuálně přihlášeného uživatele. Je-li zaškrtnuto políčko Povinný, bude při vyplňování formuláře vždy vyžadováno zadání hodnoty atributu. Je-li zaškrtnuto políčko Fokus, skočí kurzor při zobrazení formuláře do políčka odpovídajícího danému atributu. Skupina označuje skupinu atributů, do které atribut patří. Pořadí určuje implicitní pořadí atributu v přehledu záznamů, tj. na kterém místě se daný atribut zobrazí uživateli v přehledu záznamů při prvním přihlášení do systému. Setřídění určuje, má-li být atribut setříděn. Hodnoty ve skupině Odkazy slouží pro případ, že atribut má být vazbou do jiného modulu. Odkaz na modul slouží pro určení jména modulu, na který atribut odkazuje. Odkaz na atribut slouží pro určení jména atributu, z něhož se mají zobrazovat hodnoty při vybírání vazebních položek. Asociativní tab. slouží v případě, že jde o vazbu M:N, pro definici jména tabulky, která se má použít pro ukládání vztahů. 1.6 Hodnoty atributů Hodnoty atributů slouží pro definici položek pro atributy typu výběr z více možností. Atribut je odkaz na atribut, ke kterému se hodnota vztahuje. Hodnota je přirozené číslo, které se ukládá v databázi do sloupce odpovídající danému atributu. Název je jméno hodnoty, které se zobrazuje ve formulářích, přehledech atd. 4
Kapitola 2 Instalace systému Instalace systému lze snadno provést podle následujícího postupu. Kompletní instalace zabere zkušenému administrátorovi jen pár hodin. Pokud je již nainstalován aplikační i databázový server, instalace může trvat pouze několik desítek minut. 2.1 Instalace serverů Aplikační server Systém vyžaduje aplikační server Sun Java System Application Server Platform Edition 9. Instalační program serveru lze stáhnout z adresy java.sun.com v balíku Java EE 5 SDK (doporučeno) společně s Java SE 5 Update 6, která je potřebná pro instalaci a spuštění aplikačního serveru. Druhou možností je stáhnout Java SE 5 Update 6 a Sun Java System Application Server Platform Edition 9 odděleně a nainstalovat je postupně. Doména musí být nainstalována na portu 8282 (na tomto portu totiž očekává webový modul modul s webovými službami). HTTPS se doporučuje nainstalovat na port 8383. O úspěšné instalaci serveru a domény se lze přesvědčit přihlášením do administrativního webového rozhraní serveru, které se nachází na portu, který byl zvolen. Databázový server Pokud na serveru není nainstalován žádný databázový server, lze stáhnout např. instalační program databáze MySQL 5 z adresy www.mysql.com (doporučeno). Jiný databázový server není momentálně podporován. O úspěšné instalaci databázového serveru se lze přesvědčit přihlášením na jeho příkazovou řádku. 2.2 Instalace aplikace Nahrání modulu pro vytvoření databáze ze souboru KormoranInfo.war, webového modulu ze souboru KormoranWebModule.war a modulu s webovými službami ze souboru KormoranWSModule.war lze provést přes administrativní webové rozhraní serveru v menu Applications, Web Applications nebo překopírováním těchto souborů přímo do autodeploy adresáře domény serveru. 2.3 Vytvoření databáze a připojení do databáze JDBC ovladač Aby server mohl komunikovat s databází, je potřeba nahrát JDBC ovladač zvolené databáze do adresáře lib serveru. MySQL JDBC olvladač lze stáhnout na adrese dev.mysql.com. 5
2.3. VYTVOŘENÍ DATABÁZE A PŘIPOJENÍ DO DATABÁZE KAPITOLA 2. INSTALACE SYSTÉMU Connection pool Vytvoření connection pool např. přes administrativní webové rozhraní serveru v menu Resources, JDBC, Connection Pools s následujícími parametry: Name Resource Type Datasource Classname KormoranPool javax.sql.datasource com.mysql.jdbc.jdbc2.optional.mysqlconnectionpooldatasource Následuje výčet vlastností pro kategorii Properties: URL User Password characterencoding jdbc:mysql://localhost:3306/ root heslo UTF-8 O úspěšném nastavení connection poolu se lze přesvědčit stisknutím tlačítka Ping v zobrazení poolu. JDBC Resource Vytvoření JDBC Resource např. přes administrativní webové rozhraní serveru v menu Resources, JDBC, JDBC Resources s následujícími parametry: JNDI Name Pool Name jdbc/kormoranpool KormoranPool Vytvoření databáze Pro vytvoření schématu databáze slouží modul KormoranInfo. Aplikaci spustíme např. z přehledu aplikací v administrativním rozhraní, pokud se nám nechce adresu vypisovat do prohlížeče ručně. Vybereme vhodný název pro firemní účet a vytvoříme databázi. Do databáze je vložen uživatel s loginem admin a heslem adminadmin, aby bylo možné se do systému poprvé přihlásit. Tento účet je z bezpečnostních důvodu doporučeno při prvním přihlášení odstranit násl. způsobem: Nejprve vytvoříme nový administrátorský účet, odhásíme se z aplikace, přihlásíme se pod novým účtem a původní účet smažeme. Automatická kontrola připojení k databázi Pro případ, že chceme, aby sever prováděl automatickou kontrolu a obnovení připojení k databázi. Vhodné především u MySQL, protože MySQL přeruší neaktivní spojení již po několika hodinách. V nastavení pool změníme vlastnost URL na hodnotu jdbc:mysql://localhost:3306/fid, kde fid je název, který jsme dříve vybrali pro firemní účet a přidáme: Connection Validation Validation Method Table Name Required table connectionvalidation 6
Kapitola 3 Typické úlohy 3.1 Přidání nového typu záznamů Pokud se firma rozhodne přidat nový typ záznamů, administrátor v systému vytvoří záznam pro nový modul. Dále vytvoří skupiny atributů, které se budou vyskytovat ve formuláři daného modulu. Pak vytvoří atributy, které se mají v daném modulu evidovat, definuje především jejich jména, názvy, typy, mají-li být povinné, který má být aktivní při zobrazení formuláře. Nakonec ještě musí vytvořit nová přístupová práva pro daný modul, jinak se nikomu nebudou záznamy nového modulu zobrazovat. Po opětovném přihlášení do systému, mohou uživatelé začít využívat modul pro vkládání editaci a mazání záznamů nového typu. 7