INSTALAČNÍ MANUÁL RANIT

Transkript

1 INSTALAČNÍ MANUÁL RANIT verze Copyright 2012 VIAVIS a.s.

2 DEKLARACE O AUTORSKÝCH PRÁVECH (c) by VIAVIS a.s. Tento dokument je autorské dílo a je chráněn autorským zákonem a mezinárodními právními úmluvami. Žádná jeho část, ani jako celek, nesmí být kopírován a jakkoli šířen bez výslovného souhlasu VIAVIS a.s. Kontakt: VIAVIS a.s. Obránců Míru 237/35 Ostrava - Vítkovice Česká republika Tel: Fax: viavis@viavis.cz URL: http: URL: http: Databáze HSQL pro běhové prostředí RANIT: Autorské právo (c) , HSQL Development Group Všechna práva vyhrazena. Software HSQL je poskytován nabyvateli licence jak stojí a leží a jakékoli výslovně nebo předpokládané záruky včetně, ale nejen, předpokládaných obchodních záruk a záruky vhodnosti pro jakýkoli účel jsou popřeny společností HSQL Development Group, HSQLDB.ORG, ani přispěvatelé nebudou v žádném případě odpovědni za jakékoli přímé, nepřímé, náhodné, zvláštní, příkladné nebo vyplývající škody (včetně, ale nejen, škod vzniklých narušením dodávek zboží nebo služeb; ztrátou použitelnosti, dat nebo zisků; nebo přerušením obchodní činnosti) jakkoli způsobené na základě jakékoliv teorie o zodpovědnosti, ať už plynoucí z jiného smluvního vztahu, určité zodpovědnosti nebo přečinu (včetně nedbalosti) a jakékoli způsobu použití tohoto software, i v případě, že držitel práv byl upozorněn na možnost takových škod. 2 Instalační manuál RANIT

3 Obsah DEKLARACE O AUTORSKÝCH PRÁVECH... 2 Obsah Požadavky na provoz Instalace běhového prostředí Prostředí MS Windows Instalace běhového prostředí v OS Linux Instalace pomocí správce balíčků Instalace ze stránek Instalace pomocí RPM balíčkovacího systému Instalace RANIT Instalace RANIT v prostředí MS Windows Instalace RANIT v prostředí *NIX Rozbalení instalačního balíku RANIT Instalace RANIT Spuštění RANIT Spuštění v prostředí MS Windows Spuštění v prostředí *NIX Struktura adresářů Nastavení databázového připojení v RANIT Odinstalování RANIT Platforma MS Windows Platforma *NIX Instalační manuál RANIT

4 4. Instalace serverové instance Tipy a problémy Seznam zkratek Instalační manuál RANIT

5 1. Požadavky na provoz SW RANIT se skládá ze dvou hlavních částí, vlastního programu SW RANIT (dále jen RANIT) a databáze. Pro obsluhu databáze je využit databázový engine HSQLDB ( RANIT lze provozovat na operačních systémech, pro které je dostupné prostředí pro běh Java aplikací Java Runtime Environment (dále jen JRE) společnosti ORACLE minimálně verze ( Pokud je RANIT provozován v multiuživatelském režimu (vysvětlení viz kapitola 2), je nutno, aby JRE bylo nainstalováno jak na PC, kde poběží RANIT, tak i na počítači, kde bude provozována databáze (více kapitola 4 instalace serverové instance). Pro provoz databáze pak postačuje JRE verze 1.6. Operační systém musí mít v proměnné PATH nastavenu cestu k adresáři %JAVA_HOME%\bin, aby bylo možno spouštět Java programy bez nutnosti používat plnou cestu k adresáři s nainstalovaným JRE. V rámci jednoho PC je možno mít nainstalováno libovolné množství instancí RANITu, přičemž každý z nich může pro svůj provoz využívat jinou databázi (nastavení databáze viz kapitola 4). Každý RANIT musí být samozřejmě nainstalován v jiném adresáři. Přehled podporovaných operačních systémů: operační systémy rodiny Microsoft Windows konkrétně: o o o o MS Windows XP, MS Windows Vista/7, MS Windows 2003 Server, MS Windows 2008 Server, operační systémy GNU/Linux jádra 2.6.x a vyšší, další systémy: o Mac OS X, o FreeBSD. 5 Instalační manuál RANIT

6 Testování probíhá primárně na platformě MS Windows a GNU/Linux. Serverová část (využívaná pro provoz v multiuživatelském prostředí) je testována a podporována primárně na platformě MS Windows (více v kapitole 4). 6 Instalační manuál RANIT

7 2. Instalace běhového prostředí 2.1. Prostředí MS Windows Součástí instalačního balíku je instalace běhového prostředí. Na stránkách produktu ( je možné nalézt video tutoriál, který názorně provádí celým procesem instalace. Je ale samozřejmě možné využívat již nainstalované běhové prostředí popř. si jej stáhnout ze stránek Instalace běhového prostředí v OS Linux Instalace pomocí správce balíčků Na stránkách produktu ( je možné nalézt video tutoriál, který demonstruje celý proces instalace. Většina distribucí Linuxu je vybavena správcem balíčků, který umožňuje instalovat nejen části operačního systému, ale i další programy (většinou se jedná o programy, které jsou volně k distribuci). Proti instalaci Javy ze stránek má použití těchto správců balíčků následující výhody a nevýhody: instalace je jednodušší, součástí instalace je i nastavení proměnných PATH pro spouštění aplikací a proměnných jako je JAVA_HOME, programy lze snadněji odinstalovat, většinou je podporováno více verzí Javy (např. verze 1.6 a někdy i další), to vytváří problémy při výběru, která verze se má kdy použít. Většina distribucí obsahuje také program, který umožňuje správci vybrat, která distribuce je správná, někdy je distribuce JDK rozdělena do samostatných částí, zvlášť je balíček pro JRE, zvlášť pro JDK, zvlášť pro zdrojové kódy JDK, zvlášť pro ukázkové aplikace atd. - uživatel si musí umět vybrat správný balíček, 7 Instalační manuál RANIT

8 tyto distribuce většinou mají určité zpoždění proti poslední uvolněné verzi od ORACLE. Doporučujeme používat pro instalaci správce balíčků, a to JRE od společnosti ORACLE (nutná je alespoň verze 1.6.0, na vyšších verzích z hlediska používání této verze RANIT příliš nezáleží), distribuce od jiných výrobců nemusí aplikaci plně podporovat, tj. před instalací nejdříve odstraňte již nainstalované verze Javy (např. gcc-java či verze 1.6.x od Oracle či od BlackDown). Pokud to nejde (např. z důvodů závislostí), tak je potřeba věnovat pozornost nastavení tak, aby uživatelé měli k dispozici verzi (ve většině distribucí existuje nástroj, který umí přepínat uživatelské prostředí na různé verze javy - např. update-javaalternatives v Ubuntu, update-alternatives v SuSE) Příklad instalace v prostředí SuSE Linux Součástí distribuce je Java 1.6.0_x, která je však rozdělena do více balíčků. Pro používání RANIT stačí instalace balíčku java- 1_6_0-sun (což je pouze JRE). Při instalaci se automaticky nastaví proměnné: JAVA _BI NDI R=/ usr /l ib/ jvm/ jav a/b in JAVA _HO ME= /us r/l ib /jv m/ja va JAVA _RO OT= /us r/l ib /jv m/ja va JDK_ HOM E=/ usr /li b/ jvm /jav a JRE_ HOM E=/ usr /li b/ jvm /jav a/j re Do adresáře /usr/bin se doinstalují odkazy (symlinks) pro programy java, javac, javadoc a další. SuSE podporuje instalaci více verzí Javy (např gcc-java) a přepínání mezi nimi pomocí nástroje update-alternatives. Pro přepnutí stačí následující: upda te-alt ern ati ve s --con fig ja va upda te-alt ern ati ve s --con fig jr e_s un Případně je možno upravit priority ve /var/lib/rpm/alternatives a použít volbu --auto místo --confi g. Zvolenou verzi javy lze zkontrolovat volbou 8 Instalační manuál RANIT

9 --displ ay pro uvedené skupiny, případně podle toho, kam ukazují symbolické odkazy v /etc/alternatives Instalace ze stránek Stažení Na stránkách jsou k disposici dva typy instalačních balíčků. Balíček RPM a samorozbalovací binární balíček. Pro použití RPM balíčku je nutné, aby systém, na který má se mi instalovat, byl vybaven správcem RPM balíčků Instalace ze samorozbalovacího binárního balíčku Je třeba spustit terminál a přepnout se do adresáře, kam má být JRE nainstalováno a tam zkopírovat stažený soubor. Pro stažený soubor je nutné nastavit atribut povolující spuštění pomocí příkazu: chmo d a +x jre -6u <v ers ion> -li nux -i5 86. bi n Nastavení atributů si lze ověřit pomocí příkazu: ls l Instalace se spouští příkazem: 9 Instalační manuál RANIT

10 ./jr e-6 u<v ers ion > - lin ux-i 586.bi n JRE bude nainstalován do aktuálního adresáře Instalace pomocí RPM balíčkovacího systému Opět je nutno spustit terminál a přepnout se do adresáře, kam má být JRE nainstalováno a zkopírovat tam stažený soubor. Instalace RPM balíčku se spouští následujícím příkazem: rpm -iv jr e-6 u<v er sio n> -l inu x -i 586.rp m JRE bude nainstalován do aktuálního adresáře. 10 Instalační manuál RANIT

11 3. Instalace RANIT 3.1. Instalace RANIT v prostředí MS Windows RANIT je distribuován jako jednoduchý instalátor, který uživatele provede celým postupem instalace. Na stránkách produktu ( je možné nalézt video tutoriál, který také názorně provádí celým procesem instalace. Instalace se spouští pomocí souboru setup.exe (součást instalačního balíku). Pro pokračování instalace je třeba stisknout tlačítko Ano. Následně je možné zvolit jazyk instalace. Podporované jsou dvě jazykové mutace čeština a angličtina. 11 Instalační manuál RANIT

12 Volba preferovaného jazyka se provádí stiskem tlačítka OK. Během instalace je uživatel několikrát vyzván k potvrzení instalace a k vyjádření souhlasu s licenčními podmínkami pro užívání RANIT. V následující tabulce jsou obsaženy licenční podmínky týkající se používání RANIT. 12 Instalační manuál RANIT

13 Souhlas s těmito podmínkami je právní akt, v tomto okamžiku dochází k uzavření licenční smlouvy mezi uživatelem RANIT a poskytovatelem licence, tento souhlas je vyjádřen výběrem možnosti Souhlasím s podmínkami licenční smlouvy. Pro pokračování instalace je třeba stisknout tlačítko Další. 13 Instalační manuál RANIT

14 V dalším dialogovém okně se objeví tabulka, která informuje o umístění instalovaného programu. Cesta je přednastavena na C:\Ranit\. Tuto cestu lze samozřejmě libovolně upravit, na systémech MS Windows 7, MS Windows VISTA a MS Windows 2008 Server se nedoporučuje toto umístění měnit na C:\Program Files, a to z důvodu možného konfliktu s uživatelskými oprávněními. Pokračuje se opět přes tlačítko Další. 14 Instalační manuál RANIT

15 Následuje volba komponenty systému k instalaci (tj. databáze, program, obě komponenty). Následně bude nabídnuta možnost tvorby zástupců a programových skupin. 15 Instalační manuál RANIT

16 Poznámka: u jednotlivých verzí se liší množství nabízených zástupců. Po konečné kontrole parametrů instalace bude instalace provedena a dokončena. Je-li vše v pořádku, dokončení bude provedeno po stisku tlačítka Instalovat. 16 Instalační manuál RANIT

17 Nyní bude provedena instalace všech požadovaných komponent. Poznámka: pokud není přítomno běhové prostředí JAVA minimálně ve verzi 1.6, nabídne instalátor jeho instalaci. Pokud vše proběhlo v pořádku, zobrazí se potvrzující obrazovka umožňující přímé spuštění RANIT. 17 Instalační manuál RANIT

18 Při prvním spuštění je možné, že uživatel bude vyzván k inicializaci a upgrade databáze. Při těchto dvou krocích se volí Ano. Po provedení inicializace se zobrazí potvrzující dialogové okno. 18 Instalační manuál RANIT

19 Tímto je dokončena instalace RANIT a je možné se přihlásit pomocí získaných oprávnění Instalace RANIT v prostředí *NIX Rozbalení instalačního balíku RANIT Na stránkách produktu ( je možné nalézt video tutoriál, který provádí celým procesem instalace. Instalační balík RANIT je distribuován ve formátu tar.gz. Pro rozbalení RANIT je třeba spustit terminál a přepnout se do adresáře, kam má být RANIT umístěn. Zde se zkopíruje distribuční archiv a použijte následující příkaz pro rozbalení instalátoru: tar -xv vzf ra nit _i nst alat or. tar.gz Instalace RANIT Instalaci lze spustit z terminálu zadáním příkazu: 19 Instalační manuál RANIT

20 java j ar ran it_ in sta lato r.j ar nebo pomocí spouštěcího skriptu install.sh (tomuto je ale třeba nejdříve nastavit atribut executable pomocí příkazu chmod + x inst all.sh ). Nejdříve je možné zvolit jazyk instalace. Podporované jsou dvě jazykové mutace čeština a angličtina. Během instalace je uživatel několikrát vyzván k potvrzení instalace a k vyjádření souhlasu s licenčními podmínkami pro užívání RANIT. 20 Instalační manuál RANIT

21 V následující tabulce jsou obsaženy licenční podmínky týkající se používání RANIT. Souhlas s podmínkami je vyjádřena zvolením možnosti Souhlasím s licenčními podmínkami, pokračování v instalaci se provede stiskem volby Další. 21 Instalační manuál RANIT

22 Následně je možné zvolit komponenty systému k instalaci (tj. databáze, aplikace, obě komponenty). Dále se objeví tabulka, která informuje o umístění instalovaného programu. Cesta je přednastavena na <domovský adresář>/ranit. Tuto cestu je možné samozřejmě libovolně upravit. 22 Instalační manuál RANIT

23 Nyní bude provedena instalace všech požadovaných komponent RANIT, po jejím ukončení se volí tlačítko Další. Pokud vše proběhlo v pořádku, zobrazí se potvrzující obrazovka. Pro dokončení instalace uživatel stiskne tlačítko Hotovo. 23 Instalační manuál RANIT

24 3.3. Spuštění RANIT Spuštění v prostředí MS Windows Po instalaci dojde k vytvoření zástupců, pomocí kterých je možné RANIT jednoduše spustit, zástupci jsou umístěni v hlavní nabídce, popř. na ploše. Poznámka: záleží na volbách vybraných během instalace a verzi operačního systému, viz výše. RANIT lze spustit i pomocí dávkového souboru v adresáři, kde je RANIT nainstalován. Tento spouštěcí soubor se jmenuje runra.bat Spuštění v prostředí *NIX RANIT je možno spustit pomocí skriptu v adresáři, kde je nainstalován. Tento skript se jmenuje runra.sh (konkrétně tedy <umístění instalace>/run/runra.sh) a je mu nejprve nutné nastavit atribut executable, který povolí jeho spuštění, příkazem chmod +x run RA.sh ). Při prvním spuštění je možné, že RANIT zobrazí výzvu k inicializaci a upgrade databáze. Při těchto dvou krocích se volí Ano. 24 Instalační manuál RANIT

25 Po provedení inicializace se zobrazí potvrzující dialogové okno. Tímto je dokončena instalace RANIT a je možné přihlášení uživatele pomocí získaných oprávnění Struktura adresářů Struktura jednotlivých podadresářů po instalaci RANIT je následující: data adresář s datovými a konfiguračními soubory RANITu, podrobnosti o jednotlivých souborech, viz dokumentace HSQLDB. Zálohování databáze se provádí provedením zálohy celého adresáře data. Poznámka: tento adresář se nachází v závislosti na režimu provozu RANITu buď přímo na klientském PC (lokální režim), nebo na serveru (síťový režim). lib adresář s javovskými archívy klienta RANITu (ra.jar) a databáze (hsqldb.jar) a navazujícími knihovnami. bin adresář obsahující spouštěcí soubor pro RANIT (runra.bat, resp. runra.sh). Dále viz kapitola 3.3. JRE 1.6 adresář obsahující běhové prostředí. 25 Instalační manuál RANIT

26 3.5. Nastavení databázového připojení v RANIT Definice databáze, která bude použita jako zdroj dat pro RANIT, se provádí přímo v menu Nastavení, položka Databáze. V dialogovém okně si uživatel vybere, zda se chce připojit k lokální nebo síťové databázi, a to pomocí pomocníka pro připojení nebo pole vyplní sám s názvem adresáře databáze, jakožto místo připojení databáze. Formát adresy se pro oba režimy provozu RANIT liší. Lokální verze adresa je cesta k datovým souborům databáze (adresář data). Cestu lze zadávat absolutně, relativně nebo ji lze nechat na aplikaci, která při použití průvodce připojení (po stisku tlačítka Najít) cestu vloží sama. Příklad:../data/risk_analys nebo: /home/user/ranit/data/risk_analys. Síťová verze - adresa je rozdělena do dvou položek. První položkou je databázový server, kam se vloží název nebo IP adresa databázového serveru. Druhou položkou je port databáze, kde je specifikován port na kterém server naslouchá (standartně 13306). Příklad: databázový server: localhost a port databáze: RANIT si pamatuje vždy poslední nastavené spojení. V případě provozu více RANITů na jednom PC, si každý z nich pamatuje své poslední nastavení Odinstalování RANIT Platforma MS Windows Odinstalaci lze spustit pomocí souboru unins.exe (resp. uninst000.exe), který je v adresáři s instalací. 26 Instalační manuál RANIT

27 Platforma *NIX Odinstalaci lze spustit buď pomocí příkazu: java -j ar <ins tal ace _ra nit >/ Uni nsta lle r/u nin sta ll er. jar Nebo pomocí zástupců v hlavní nabídce a na ploše (za předpokladu, že tyto byly během instalace požadovány k vytvoření a díky kompatibilnímu X serveru byly tyto vytvořeny). 27 Instalační manuál RANIT

28 4. Instalace serverové instance Pro instalaci databázového engine v prostředí serveru pro nasazení RANIT v multiuživatelském prostředí je k dispozici samostatný instalátor (instalační balík) RANIT HSQLDB SERVER MS Windows distribution. Podporovaným prostředím je platforma MS Windows, je ale možné provozovat jej stejně jako klientskou aplikaci i pod systémy rodiny *NIX. Služba HSQLDB pro instalaci na serveru a připojení uživatelů k databázi RANITu zajišťuje databázový stroj, který umožňuje operace nad tabulkami jak v paměti tak přímo na disku. Tato služba obsahuje ovladač JDBC a dobře podporuje standardy SQL-92, SQL-99, a SQL:2003. Instalace se spouští pomocí souboru ranit-server-setup.exe (součást instalačního balíku): Nejdříve se objeví uvítací obrazovka. Pokračuje se tlačítkem Ano. 28 Instalační manuál RANIT

29 Následně je možné zvolit jazyk instalace. Podporované jazykové mutace jsou čeština a angličtina. Během instalace je uživatel několikrát vyzván k potvrzení instalace a k vyjádření souhlasu s podmínkami jednotlivých programů. 29 Instalační manuál RANIT

30 V následující tabulce jsou obsaženy licenční podmínky týkající se používání RANIT. Souhlas s podmínkami je vyjádřena zvolením možnosti Souhlasím s podmínkami licenční smlouvy, pokračování v instalaci se provede stiskem volby Další. 30 Instalační manuál RANIT

31 Přednastavená cesta instalace je C:\Program Files\Ranit HSQLDB Server\. Tuto cestu lze samozřejmě libovolně upravit. Na systémech MS Windows 7, MS Windows VISTA a MS Windows 2008 Server může dojít ke konfliktu oprávnění. Poté se pokračuje přes tlačítko Další. 31 Instalační manuál RANIT

32 Následuje volba komponent systému k instalaci (tj. databáze, serverová aplikace, obě komponenty). 32 Instalační manuál RANIT

33 Poté je možné provést kontrolu parametrů instalace. Je-li vše v pořádku, pokračuje se tlačítkem Instalovat. Nyní budou nainstalovány všechny požadované komponenty. Poznámka: pokud není přítomno běhové prostředí JAVA minimálně ve verzi 1.6, nabídne instalátor jeho instalaci. 33 Instalační manuál RANIT

34 Před ukončení instalace se zobrazí informace o chodu RANIT a jeho doporučeném provozování. Pokud vše proběhlo v pořádku, zobrazí se potvrzující obrazovka umožňující zaregistrování databázového serveru jako službu (více dále). 34 Instalační manuál RANIT

35 Po instalaci nebo na jejím konci je možné (doporučeno) provést registraci HSQLDB, jako služby. To se provede spuštěním dávkového příkazu umístěného v cestě <instalace hsqldb>\bin souborem InstallApp-NT.bat. Poznámka: odregistrování služby je možné dávkou v souboru UninstallApp-NT.bat. Pro kontrolu správné instalace služby, je možné tuto zkontrolovat v nabídce Ovládací panely->nástroje pro správu- >služby. Služba se jmenuje Hsqldb (port 13306) a defaultně je tedy spuštěna na portu (viz následující dva obrázky). 35 Instalační manuál RANIT

36 Pro pouhé spuštění databázového stroje je možné použít dávkový soubor hsqldb_start.bat, viz následující obrázek: 36 Instalační manuál RANIT

37 Databáze, využívaná systémem je uložena v adresáři <instalace hsqldb>\data. V případě, že takovýto adresář daná distribuce serveru neobsahuje, znamená to, že nebyla distribuována spolu s databázovým systémem. V takovém případě je nutné takový adresář vytvořit a nahrát do něho databázové soubory. Poznámka: logovací soubory databázového systému jsou poté umístěny v adresáři <instalace hsqldb>\log. 37 Instalační manuál RANIT

38 5. Tipy a problémy Problém: Při pokusu o spuštění RANITu, se objeví černé okno, zase zmizí, ale RANIT se nespustí. Není nainstalováno JRE. Problém: Při pokusu o spuštění RANITu, se objeví hlášení: javaw není názvem vnitřního ani vnějšího příkazu, spustitelného programu nebo dávkového souboru. Není nainstalováno JRE, případně JRE nainstalováno je, ale cesta k němu není přidána do proměnné PATH v OS. Problém: Při pokusu o spuštění RANITu, se objeví hlášení. cannot find main class Je nainstalována nižší verze JRE než je požadováno Problém: Při pokusu o spuštění RANITu se objeví okno s výzvou pro zadání adresy pro připojení k databázi Na zadané URL adrese pro připojení k databázi se nenachází platná databáze RANITu. Zkontrolujte platnost cesty k datovým souborům, případně v případě síťového režimu zda databázový server běží. Dotaz: Jak v lokálním režimu RANITu postupovat při práci s více projekty pro různé subjekty, kdy je nutno data držet v oddělených databázích, aby bylo možno později odevzdat zákazníkovi jen jeho data? Jsou dvě možnosti. První možnost spočívá v tom, že se nainstaluje jen jeden klient, pro každého zákazníka se vytvoří jen samostatný nový datový adresář, do kterého se zkopírují výchozí datové soubory. Při práci nad databází konkrétního zákazníka je pak vždy nutno změnit i databázové připojení k jemu odpovídajícímu datovému zdroji (adresáři) (viz bod 3.3). Druhá možnost je pravděpodobně uživatelsky příjemnější a spočívá v tom, že se pro každého zákazníka nainstaluje vždy nová instance klienta RANIT (a tím i výchozí DB). Každá instance si pamatuje vlastní nastavení databáze, takže není nutno nic přenastavovat. 38 Instalační manuál RANIT

39 6. Seznam zkratek JRE - Běhové prostředí Java Runtime Environment, vyžadované pro běh RANIT JDK - Java Development Kit, balík obsahující JRE a vývojové nástroje pro vývoj aplikací v jazyce JAVA DB - Databáze OS - Operační Systém 39 Instalační manuál RANIT