Jitsy Installationsanvisning Document title Installationsanvisning Document responsible Document author Gustav Wilhelmsson Document name Jitsy - Installationsanvisning.doc Version 3 Ref. no. Created 16 September 2008 Last saved 25 October 2011 Box 576, SE-581 07 Linköping, phone +46 (0)13 37 37 00, fax +46 (0)13 37 37 90, www.idainfront.se
Innehåll 1 Introduktion... 1 1.1 Översikt... 1 1.2 Referenser... 1 1.3 Revisionshistoria... 1 2 Installationsförfarande... 2 2.1 Översikt... 2 2.2 Förberedelser... 2 2.2.1 Java... 2 2.2.2 Oracle databas... 2 2.2.3 iipax Communication... 3 2.2.4 Diabas... 3 2.3 Packa upp Jitsy... 3 2.4 Konfiguration... 3 2.4.1 Konfigurationsparameterar i application.config... 3 2.4.2 Iipax Configuration Tool... 3 2.5 Databas import... 4 2.6 Automatisk installation vid uppstart... 4 2.6.1 Registerobjekt... 4 2.6.2 Dokumentmallar... 5 2.7 Manuella installationssteg... 6 3 Uppgradering av Jitsy... 7
Installationsanvisning 1 Introduktion 1.1 Översikt Jitsy bygger på iipax, en produkt för dokument- och ärendehantering. Detta dokument ämnar att beskriva hur man går tillväga för att installera och driftsätta Jitsy. Övriga dokument finns nämnda i referenslistan nedan. 1.2 Referenser [JAVA] http://java.sun.com [BROKERADM] iiipax Broker System Administration Guide [DIABAS] Diabas API SDK Användarmanual [JITSYADM] Jitsy System Administration Guide [JITSYDRIFT] Jitsy Drift och förvaltning [CASEADM] iipax Case System Administration Guide [IITOOL] iitool User Manual 1.3 Revisionshistoria Version Datum Anmärkning Utfört av 0.1 08-08-20 Dokumentet skapat Gustav Wilhelmsson 0.2 08-09-11 Tagit bort att Oracle Application Server behöver installeras separat, Oracle Application Server följer automatiskt med vid installation av Jitsy. Gustav Wilhelmsson Ida Infront Ab 1
2 Installationsförfarande Driftsättning av Jitsy sker i ett par steg med såväl automatiska som manuella aktiviteter. Nedan beskrivs vilka steg och vilken konfiguration som administratören måste göra. 2.1 Översikt Vid installation av Jitsy kan förfarandet delas upp i följande steg: 1. Förberedelser 2. Databas import 3. Extern installation 4. Konfiguration 5. Automatisk installation vid uppstart 6. Manuella installationssteg Varje steg beskrivs i sin helhet nedan. Som avslutning finns avsnittet Uppgradering av Jitsy, som behandlar tillvägagångssättet när man uppgraderar en befintlig Jitsy-installation. 2.2 Förberedelser För att kunna installera och köra Jitsy på en dator krävs vissa förberedande delmoment som tas upp nedan. 2.2.1 Java Jitsy kräver att Java Development Kit (JDK) version 1.5 är installerat på datorn. Java finns att hämta från [JAVA] tillsammans med installationshänvisningar. Se till att systemvariablerna DISPLAY och JAVA_HOME är satta vid installation i Unix och att sökvägen till java-katalogen är med i PATH vid Windows-installation. I Windows görs detta genom att gå in på Environment Variables under tabben Advanced i System Properties. I Unix används kommandot export JAVA_HOME=<path>. Sökvägen till JDK måste även vara korrekt i Jitsys konfigurationsfil user.vars. 2.2.2 Oracle databas Bitsy installeras på Oracle Database 10g. Detta beskrivs mer ingående i [CASEADM]. Rättigheterna som krävs för schemat finns dock även beskrivna här: GRANT ALTER SESSION TO <Case User>; GRANT CREATE SESSION TO <Case User>; GRANT CREATE SEQUENCE TO <Case User>; GRANT CREATE TABLE TO <Case User>; GRANT CREATE VIEW TO <Case User>; GRANT CREATE TRIGGER TO <Case User>; GRANT QUERY REWRITE TO <Case User>; GRANT SELECT ANY TABLE TO <Case User>; 2 Installationsanvisning
Installationsanvisning GRANT SELECT ON "SYS"."DBA_PENDING_TRANSACTIONS" TO <Case User>; GRANT "CONNECT" TO <Case User>; 2.2.3 iipax Communication För att hantera inkommande mail och inkommande filer via skanning används iipax Communication, installationshänvisning finns tillgängligt i [BROKERADM]. 2.2.4 Diabas In en driftsmiljö hämtar och skriver Jitsy information till diarieföringssystemet Diabas från Sirius IT. Diabas installeras och konfigureras enligt [DIABAS]. För att Jitsy ska arbeta mot Diabas krävs att Konfigurationsparametern Diabas available har värdet true. 2.3 Packa upp Jitsy Skapa upp en installationsmapp för Jitsy (hädanefter benämnd som <APP_ROOT>) och kopiera filen jitsy-<version>.zip. Rekommendationen är att installationsmappen får namnet jitsy-<version>. Packa upp filen genom att i den nyss skapade mappen köra kommandot unzip jitsy-<version>.zip Den mappstruktur som skapats beskrivs ingående i [CASEADM]. 2.4 Konfiguration 2.4.1 Konfigurationsparameterar i application.config Filen application.config i mappen <APP_ROOT>/config används för att styra olika konfigurerbara parametrar i Jitsy. Konfigurationen kan göras on-the-fly, det vill säga ändringar i filen slår igenom inom någon minut utan att man behöver starta om systemet. För ett system i aktiv drift görs ändringarna direkt i filen application.config, men man måste då vara medveten om att då konfigurationsverktyget (se Fel! Hittar inte referenskälla.) används nästa gång så kommer eventuella ändringar i application.config att försvinna. Vid nyinstallation och för att ändringen ska slå igenom även efter en omkonfiguration så ska denna göras i filen application.config.inst (se Fel! Hittar inte referenskälla. för förklaring). För de parameterar som hämtar sitt värde från konfigurationsverktyget ($<parameternamn> i inst-filen) görs eventuella ändringar genom att köra detta program och ändra värdet därigenom. 2.4.2 Iipax Configuration Tool Kör kommandot <APP_ROOT>/install/bin/configure. Detta startar ett grafiskt gränssnitt för konfigurationsverktyget. Genom att använda flaggan textmode körs programmet utan grafiskt gränssnitt, medan flaggan unattended kör automatisk konfiguration där alla värden hämtas från filen user.vars. Ida Infront Ab 3
Konfigurationsverktyget letar upp alla inst-filer (*.inst) under <APP_ROOT> och genererar motsvarande konfigurationsfiler utan ändelsen inst (exempelvis genereras application.config utifrån application.config.inst). För en lista över de värden som kan styras via konfigurationsverktyget se [JITSYDRIFT]. Observera att de portar som används av Jitsy måste vara unika. Detta är extra viktigt att tänka på om flera iipax-installationer körs på samma server. De parametrar som inte finns i tabellen ovan finns beskrivna i [CASEADM], men behöver normalt inte ändras i Jitsy. Ändringar i konfigurationsverktyget sparas genom att man klickar på knappen Ok. Förutom att generera konfigurationsfiler utifrån inst-filerna, lagras alla värden i filen <APP_ROOT>/install/etc/user.vars. Omvänt kan man även sätta standardvärden till kopfigurationsverktyget genom att ändra direkt i user.vars där alla konfigurationsparameterar räknas upp som värdepar (variabel=värde). 2.5 Databas import Logga in på databasservern och öppna en koppling mot den databasinstans som angivits genom konfigurationsverktyget. Logga in på databasen som angiven databasanvändare i Oracle SQL Developer. Filerna för att skapa upp databasstrukturen finns i mappen <APP_ROOT>/install/etc. Importera i tur och ordning filerna application.sql, jitsyreg_partition.sql, custom_tables.sql och web_tables.sql. 2.6 Automatisk installation vid uppstart Jitsy startas genom att köra iipax run eller iipax start under <APP_ROOT>/bin. Då Jitsy startas för första gången skapas automatiskt objekt- och dokumenttyper upp. 2.6.1 Registerobjekt Registren för olika utbildningsområden, frågeställningar, ärendetyper, lärosäten och samrådande avdelningar importeras automatiskt. Vilka värden som lagras i registret styrs via filen <APP_ROOT>/etc/jitsy/register.xml. Genom att ändra och lägga till värden på registerobjekten innan första uppstart påverkas registrets innehåll. Strukturen i register.xml är enkel och har som mål att på ett tydligt sätt spegla registret. Exempel: <register> <folder displayname="utbildningsområden"> <displayname>utbildningsområde</displayname> <folder displayname="frågeställningar"> <displayname>frågeställning</displayname> <folder displayname="ärendetyper"> <displayname>ärendetyp</displayname> 4 Installationsanvisning
Installationsanvisning <folder displayname="lärosäten"> <folder displayname="universitet"> <displayname>universitet</displayname> <folder displayname="högskolor"> <displayname>högskola</displayname> <folder displayname="enskilda utbildningsanordnare"> <displayname>enskild utbildningssamordnare</displayname> <folder displayname="enskilda utbildningsanordnare med enbart examensrätt för psykoterapeututbildning"> <displayname>enskild utbildningssamordnare</displayname> <folder displayname="avdelningar"> <displayname>samrådande avdelning</displayname> </register> Ovan visas ett exempel på hur strukturen ser ut i register.xml. Den högsta nivån är registerroten, med denna specificeras vilka kategorier och objekt som lagras i registret. Det är viktigt att xml-filen endast har en rotnod. Nästa nivå heter folder och motsvarar en kategori. De kategorier som stöds av Jitsy är utbildningsområden, frågeställningar, ärendetyper och lärosäten. Namnet på kategorin styrs genom attributet displayname. Observera att fler kategorier kan läggas till så att dess objekt skapas upp i registret, dock kommer inte dessa att kunna användas i Jitsy (till exempel som alternativ på ärendeinformationsfliken utan en programuppdatering). Av registerkategorierna är det endast lärosäten som har extra underkategorier. Dessa är universitet, högskolor, enskilda utbildningssamordnare och enskilda utbildningssamordnare med enbart examensrätt för psykoterapeututbildning. 2.6.2 Dokumentmallar Installation och konfiguration av dokumentmallar styrs via <APP_ROOT>/etc/jitsy/templates.xml. Exempel: <?xml version = '1.0' encoding = 'ISO-8859-1'?> <templates> <folder displayname="dossierxx"> <documenttemplate displayname="mallnamn"> <objecttype>document_template</objecttype> <filename>fil.doc</filename> <templatedossier>xx</templatedossier> Ida Infront Ab 5
<destinationpath>dokumentmapp</destinationpath> <documenttype>document</documenttype> </documenttemplate> </templates> Ovan visas ett exempel på hur strukturen ser ut i templates.xml. Den högsta nivån är templates-roten, med denna specificeras vilka mappstruktur och vilka dokumentmallar som ska lagras. Det är viktigt att xml-filen endast har en rotnod. Nästa nivå heter folder och motsvarar en mapp. Under mapparna finns sedan dokumentmallar, beskrivna av documenttemplate. En dokumentmall kan vara av typen document_template (vanlig mall) och note_document_template (mall för tjänsteanteckningar). Den fil som anges under filename ska finnas under <APP_ROOT>/etc/jitsy/templates. Parametern templatedossier bestämmer vilken dossier som dokumentmallen gäller för, destinationpath berättar var i dokumentträdet som filer ska hamna som använder mallen och slutligen documenttype bestämmer vilken typ som en fil som använder mallen ska få (t.ex. document, document_comment, document_decision). 2.7 Manuella installationssteg För att kunna arbeta i Jitsy måste först några manuella steg ske. Konfigurationsfiler för Jitsys objektmodell, processkarta med mera ligger under mappen <APP_ROOT>/etc/jitsy. Börja med att köra kommandot iitool under <APP_ROOT>/bin. Skapa upp Jitsys processkarta genom att köra kommandot mkchart../etc/jitsy/jitsyprocessconfig.xml. 6 Installationsanvisning
Installationsanvisning 3 Uppgradering av Jitsy För att uppgradera Jitsy till en ny version kan göras på två sätt. Börja med att avsluta Jitsy genom att köra kommandot iipax stop (för service startat med iipax start) eller genom tangentbordskommandot Ctrl+C (om Jitsy startats med kommandot iipax run). Skapa en ny mapp jitsy-<version> (hädanefter benämnd som <NEW_APP_ROOT>) på samma nivå som Jitsys installationsmapp och kopiera alla filer från den ursprungliga installationsmappen till den nya. Det enklaste är att uppgradera jitsy är om man har tillgång till en ear-fil. Denna kopieras i så fall till den mapp som angivits i konfigurationen som Jitsy location (vanligtvis <NEW_APP_ROOT>/deploy). Om man instället har en zip-fil med den nya versionen packas denna upp under <NEW_APP_ROOT> som beskrivs under 2.3. Var uppmärksam på att filen <NEW_APP_ROOT>/install/etc/user.vars kan komma att ersättas av motsvarande fil från zip-filen. Om detta inträffar kopieras filen < APP_ROOT>/install/etc/user.vars tillbaka. Kör efter detta iipax Configuration Tool (se 2.4.2). Ändra värdena på Application location, Jitsy location och Jitsy version så att de pekar på <NEW_APP_ROOT> och så att versionsnumret stämmer överens med den nya version. Avsluta med att bekräfta ändringarna genom att klicka Ok. Om några databasförändringar har gjorts måste dessa importeras (se 2.5). Observera att detta normalt sett inte görs genom att importera hela databasstrukturen, eftersom den redan existerar, utan genom att köra en speciell patch-fil för att skapa upp just de databastabeller som saknas eller för att uppdatera befintliga tabeller på rätt sätt. Denna databas-patch levereras normalt sett separat tillsammans med ear/zip-filen. Vid oklarheter kontakta Ida Infront. Ida Infront Ab 7