Utvitsy Drift och förvaltning

Transkript

1 Utvitsy Drift och förvaltning Document title Document responsible Document author Gustav Wilhelmsson Document name Utvitsy - Drift och förvaltning.doc Version 1 Ref. no. Created 1 September 2009 Last saved 25 October 2011 Box 576, SE Linköping, phone +46 (0) , fax +46 (0) ,

2

3 Innehåll 1 Introduktion Översikt Referenser Revisionshistoria Start och stop Konfiguration Iipax Configure Tool Variabelsubstitution Systemkonfiguration i application.config Konfiguration av informationsmodell Loggning Administration Administration av register Administration av användare Administration av behörigheter och rättigheter Arbetsytan Rolladministration Roller i Utvitsy Produktionsmiljö vs testmiljö Rutiner för backup... 14

4 1 Introduktion 1.1 Översikt Detta dokument beskriver driftinstruktioner och rutiner för Utvitsy och riktar sig till administratören av Utvitsy. 1.2 Referenser [CASESA] iipax Case System Administration Guide [UTVITSYINST] Utvitsy Installationshänvisning.doc [JAVALOG] Java Logging [DIABASAPI] Diabas API diabas-ws-user-manual.doc [BROKERSA] iipax Broker System Administration Guide.doc 1.3 Revisionshistoria Version Datum Anmärkning Utfört av Dokumentet skapat Gustav Wilhelmsson Ida Infront Ab 1

5 2 Start och stop Utvitsy startas med kommandoradsscriptet iipax som finns tillgängligt under <APP_ROOT>/bin. Hur iipax startas finns beskrivet mer ingående i [CASESA]. När man startar upp systemet ska man vara inloggad som applikationsanvändaren och inte som root på maskinen. iipax run iipax startar i prompten. iipax start iipax startar som en tjänst iipax stop används för att stoppa iipax då det startats med iipax start Ida Infront Ab 2

6 3 Konfiguration 3.1 Iipax Configure Tool Med iipax följer ett konfigurationsverktyg. Vid installation av iipax och ändring av dess konfiguration används detta verktyg. Verktyget ligger under <APP_ROOT>/install/bin. Figure 1 iipax Configuration Tool Varje rad som visas i configure hämtas från och sparas i <APP_ROOT>/install/etc/user.vars. Om det av någon anledningen inte går att köra configure, t ex fönsterhanterare saknas i Unix-miljö, då går det lika bra att göra ändringar i user.vars följt av att köra $ configure unattended Ida Infront Ab 3

7 Tabell 1. Konfigurationsparametrar Application host name Application location Application server port Application server port, https Application server port, jms Application server port, ormi Iipax forms url Database host name Database name Database port Database user name Database user password Namnet på den server där Utvitsy ska installeras. Default: thalia.hsv.se Installationskatalogen för Utvitsy, <APP_ROOT>. Default: /appl/iipax/utvitsy-1.0 Den port på servern som används för att kommunicera med Utvitsy ( Default: 8002 Den port på servern som används för säker kommunikation. Default: 8443 Den port på servern som används för kommunikation. Default: 9133 Port på servern som används av iipax Desktop Integration. Default: 6013 Den sökväg som används för lärosätets registrering via iipax Forms. Default: sessioninitializer?processname=hsvprototyp Process Namnet på den server som Utvitsys databas finns installerad på. Default: clotho.hsv.se Namnet på Utvitsys databas. Default: examutvi Den port hos database servern som lyssnar på JDBC kommunikation. Default: 1521 Namnet på Utvitsys databasanvändare. Default: utvitsy Lösenordet för Utvitsys databasanvändare. Exempel: secret Ida Infront Ab 4

8 Diabas available Diabas diary Diabas url Diabas user Diabas passwd Installation mode Java location Utvitsy context root Utvitsy location Utvitsy version iitool default user name Anger att diarieföringsprogrammet Diabas används för att synkronisera, läsa och skriva ärendeinformation. Denna ska alltid ha värdet true i produktionsmiljö. Värdet false används endast vid lokal testning där man saknar koppling till Diabas. Default: true Definierar vilket diarium som ska användas vid kommunikation med Diabas. Default: diaora Anger sökvägen som Diabas service kommunicerar via. Default: DiaService Den användare som Utvitsy använder sig av vid kommunikation med Diabas. Default: utvitsy Lösenord för Diabasanvändaren. Exempel: secret Anger installationsläge, används för att styra gränssnittet i Utvitsy. Exempel: test ger ljusgul bakgrundsfärg för att påvisa att Utvitsy-installationen är en testmiljö. Anger sökvägen till installationskatalogen för Java, <JAVA_HOME>. Default: /user/java Anger mappning för vilken rot som Utvitsy ska använda. Exempel: Värdet utvitsy innebär med övriga standardparametrar att adressen används för att kommunicera med Utvitsy. Anger den sökväg där Utvitsy körbara kod finns. Då Utvitsy startas letar programmet efter filen utvitsy-<version>.ear i denna mapp och packar upp den. Default: /appl/iipax/utvitsy-1.0/deploy Aktuell version av Utvitsy-installationen, <version> Default: 1.0 Användare för automatinloggning via iitool. Default: iipaxadm Ida Infront Ab 5

9 iitool default user password Ldap host name Lösenord för standardanvändaren i iitool. Default: iipax123 Anger vilken LDAP-server som används för att hämta användarinformation. Default: ldap.hsv.se 3.2 Variabelsubstitution Alla konfigurationsfiler i Utvitsy med suffix.inst kommer att generera en motsvarande fil utan.inst där variablerna som är av formen $<Variabel> kommer att substitueras med motsvarande variabel i user.vars (som visas när configure körs). T ex application.config.inst genererar en application.config där alla värden substitueras. Därför är det viktigt att genomföra ändringar i konfigurationsfilernas.inst fil och därefter köra configure, för att konfigurationen ska bli konsistent. Om konfigurationen enbart ändras i t ex application.config och man i ett senare tillfälle kör configure, då kommer ändringen att försvinna! 3.3 Systemkonfiguration i application.config Under <APP_ROOT>/config hittas application.config som är systemkonfigurationen för Utvitsy. När iipax Configuration Tool körs uppdateras application.config genom s.k. variabelsubstution som beskrivs i 3.2 ovan. De konfigurationsparametrar som inte finns i configure kan ändras direkt i application.config. Denna konfiguration läses in direkt så fort något ändring sparas. Om ändringar görs, glöm då inte att även ändra i application.config.inst! I application.config hittas standard iipax-konfiguration men också Utvitsy-specifik konfiguration: 3.4 Konfiguration av informationsmodell Med Utvitsy följer en default-konfiguration av informationsmodellen. Med informationsmodell menas den objektmodell som används, dvs ärendeobjekt med attribut, underobjekt, stödobjekt, processmodell och behörighetskonfiguration. En stor del av denna konfiguration sköts genom automatisk installation, se [UTVITSYINST] Informationsmodellen har sin konfiguration i fem olika xml-filer UtvitsyCaseConfig.xml Innehåller konfiguration av ärenden och dess underobjekt UtvitsyProcessConfig.xml Innehåller konfiguration av processen som ärenden följer UtvitsyRegisterConfig.xml Innehåller konfiguration av registerobjekt UtvitsyCaseRegister.xml Innehåller importdata för registerstrukturen UtvitsyBasicSecurityConfig.xml Innehåller behörighetskonfiguration UtvitsySecurityConfig.xml Innehåller behörighetskonfiguration Ida Infront Ab 6

10 Dessa filer ligger under <APPROOT>/etc/utvitsy. Det finns möjlighet att lägga till, ta bort och ändra Utvitsys informationsmodell. Av dessa filer installeras UtvitsyCaseConfig.xml, UtvitsyRegisterConfig.xml, UtvitsyBasicSecurityConfig.xml och UtvitsySecurityConfig.xml automatiskt. För att importera Utvitsys processkarta används iitool under <APP_ROOT>/bin. iitool$ mkchart../etc/utvitsy/utvitsyprocessconfig.xml Ida Infront Ab 7

11 4 Loggning I Utvitsy används standard Java Logging. Mer information om Java Logging finns i [JAVALOG]. Inställningar för loggning finns i <APP_ROOT>/config/logging.properties. I grundkonfigurationen hamnar loggfilen i <APP_ROOT>/log/iipax.log. Den roteras på 10 filer (0 9) och varje fil får bli 10 Mb stora. För att ändra på loggnivå, t ex öka loggnivå till debug-nivå på hela Utvitsy-lagret, så läggs en rad till se.hsv.utvitsy.level = FINEST Den talar om att hela paketet se.hsv.utvitsy ska logga på FINEST nivå. Normal loggnivå är INFO. Spårningslogg loggas på FINER. För att ny loggkonfiguration ska slå igenom så måste Utvitsy startas om. Det finns dock ett undantag från denna regel. Om loggnivån för en enskild klass ändras, t ex se.hsv.utvitsy.caseservice.caseserviceimpl = FINEST, behöver Utvitsy inte startas om. Se kapitel 3 hur Utvitsy startas om. Ida Infront Ab 8

12 5 Administration 5.1 Administration av register För att administrera Utvitsys register används iipax Permission Console. Denna startas via Gå sedan in på register-arbetsytan. Registerkategorierna visas här som mappar och genom att klicka på registerobjektet kan man ta bort och ändra namn på dessa. iipax Register innehåller fyra kataloger på rotnivån Aktuella utvärderingar, HSV Listor, Kontaktlistor och Lärosäten. Aktuella utvärderingar HSV Listor Kontaktlistor Lärosäten Innehåller som namnet antyder alla registrerade pågående utvärderingar. Nya utvärderingar skapas genom funktionen Registrera aktuella utvärderingar i Inkorgen. Innehåller stödlistor som används i registreringsgränssnittet, registerarbetsytan och i ärendehanteringssystemet självt. Här finns bland annat giltiga utbildningskategorier, utbildningsnivåer, betygsnivåer etc. För att skapa nya stödlistor används strukturmappar och listelement. I denna katalog lagras gemensamma och personliga kontakter, som kan användas när handläggaren skickar mail från Utvitsy. Katalogen innehåller en mapp Alla som innehåller gemensamma kontaktlistor och sedan en mapp per handläggare, som innehåller de privata kontaktlistorna. För att skapa en ny privat kontaktlista, skapas först en katalog av typen Mapp med användarnamnet som visningsnamn, i denna skapas sedan objekt av typen Kontaktlista. För att undvika problem, bör kontaktlistans namn inte innehålla svenska tecken (eller för den delen andra specialtecken än _ ) eller mellanslag. I denna katalog lagras på första nivån alla lärosäten som finns registrerade hos Högskoleverket. Under ett lärosäte finns sedan en eller flera kategorier och en kontaktmapp. Kontaktmappen innehåller alla användare/kontakter som är kopplade till lärosätet. Dessa kommer även att användas då lärosätets användare loggar in i registreringsgränssnittet för att lämna in uppgifter kring olika utbildningar. Under kategorin finns sedan olika mappar som visar vilka utbildningar med huvudområde, samt vilka yrkesutbildningar som finns vid ett lärosäte i den ovanliggande kategorin. Om man fortsätter ner under ett huvudområde/yrkesexamina finns en mapp för att specificera vilket år som registreringen gäller och under det finns sedan de uppgifter som lärosätet lämnat in; examensarbeten, personal och studenter m.m. Här finns även ett objekt av typen basfakta, som innehåller de nyckeltal som räknats ut ifrån lärosätets registrerade uppgifter. För att lägga till ett nytt objekt i registret högerklickar man på mappen som man vill skapa objektet i eller markerar den och väljer funktionen Skapa. Beroende på var i registret som objektet ska skapas, så finns olika alternativ vad gäller objekttyp. För att ta bort ett objekt högerklickar man på registerobjektet och väljer alternativet Ta bort. Ida Infront Ab 9

13 Figure 2 iipax Permission Console - Registerarbetsytan 5.2 Administration av användare Användare administreras direkt i ldap-katalogen. Förutom vanliga användare ska vissa fördefinierade användare finnas. iipaxadm För administration av iipax och Utvitsy, samt för iipax Case, iitool, objectbasetool iipaxsystem Intern användare i Utvitsy anonymous Anonoym användare som används för att installera Utvitsy oc4jadmin Intern användare för Oracle Application Server För Utvitsy-användare finns tre grupper, iipaxuser, Utvitsyhandläggare och Utvitsybeslutsfattare. Alla användare ska ingå i iipaxuser. Handläggare och registratorer ska ingå i Utvitsyhandläggare. De fält som är specifika för en Utvitsy-användare i ldap-katalogen är diabasid Id som ska användas vid uppdatering av diabas, t ex CU för Cecilia Ulfsdotter 5.3 Administration av behörigheter och rättigheter Administration av behörigheter och rättigheter styrs av rolladministrationsytan som finns i iipax Permission Console. Denna startas via Klicka på länken case och logga in som iipaxadm. Ida Infront Ab 10

14 5.3.1 Arbetsytan Rolladministration För att koppla en resurs eller en användare till en roll, väljs rollen i listan till vänster, sedan väljer man en resurs eller användare i den högra delen och klickar avslutningsvis på knappen Koppla till roll. Då man kopplar en resurs får man även välja rättigheter genom att klicka i vilken behörighet rollen ska ha. På samma sätt kan man ta bort resursåtkomst eller användare från en roll genom att expandera rollen på den vänstra sidan, välja en resurs och klicka Ta bort koppling. Genom att klicka ändra rättigheter då en resurs är markerad kan man vidare ändra den behörighet som rollen har till en viss resurs. Figure 3 iipax Permission Console - Rolladministration Roller i Utvitsy De roller som finns för Utvitsy är Administrator, Super User, Registrator, Handläggare, Läsbehörighet och caseadm. Administrator har till uppgift att administrera Utvitsys register och användarbehörigheter. Super User har tillgång till Utvitsys Super User arbetsyta och kan därigenom backa ärenden från expediering till handläggningsnoden och ta bort ärenden med skyddad identitet. Super user kan även avböja kvalitetsgranskning, avreservera ärenden, byta handläggare och återlämna ärenden till gemensamma ärendelistan för en andra handläggare. Registratorn har till uppgift att registrera nya ärenden i Diabas för att sedan skanna in dokument och därigenom skapa upp ärenden i Utvitsy. Registratorn har även hand om att skapa upp nya ärenden inkomna från webben. Vid felsituationer har registratorn även möjlighet att skapa upp ärenden via Utvitsys inkorg. En handläggare har liksom registratorn möjlighet att skapa upp ärenden via Utvitsys inkorg. De kan som rollen antyder handlägga ärenden, handläggaren har rätt att arbeta med samtliga ärenden i Utvitsy. Rollen Läsbehörighet har endast möjlighet att använda sökarbetsytan och kan enbart se avslutade ärenden som inte har skyddad identitet. Denna grupp är tänkt att användas för gäster, t.ex. journalister som besöker Högskoleverket. Ida Infront Ab 11

15 Rollen caseadm har behörighet att administrera samtliga delar av Utvitsy och har således rätt att skapa ärenden, utföra Super User aktiviteter och administrera registret. Figure 4 Koppla till roll Ida Infront Ab 12

16 6 Produktionsmiljö vs testmiljö Det är ingen principiell skillnad på en installation av Utvitsy i produktionsmiljö och testmiljö, inte heller på en utvecklingsmiljö. Genom att konfigurera Installation mode kan man få olika utseende i test och driftsmiljö. I testläge har Utvitsy en svagt gul bakgrundsfärg. En annan konfigurationsparameter som är intressant i detta hänseende är Diabas available. Framför allt i en utvecklingsmiljö är det inte säkert att en koppling till Diabas finns tillgänglig. Genom att sätta parametern till värdet false kan man avaktivera så att Utvitsy inte skriver och läser ärendeinformation från Diabas. Det som skiljer mellan miljöerna är val av databasschema och databasserver separat installation av Utvitsy separat installation av iipax Broker separat installation av Diabas API SDK Gemensamt för alla miljöer är Användarkatalog (ldap-katalog) Mailserver Scanner Diabas API SDK finns installerad i två uppsättningar, en för driftmiljön och en för testmiljön. Det är dock möjligt att låta både produktionsmiljön och driftmiljön dela på en diabas API-installation. Se [DIABASAPI] för mer information. Iipax Broker kan användas gemensamt för produktion och testmiljö, men det går även bra att använda en separat installation för respektive miljö. Ida Infront Ab 13

17 7 Rutiner för backup Utvitsys backuprutiner bör följa Högskoleverkets övriga rutiner för backuphantering. Backup av Utvitsy sker enligt standard backuphantering av databasen. Likaså sker återställning enligt standard för databasen. Förslagsvis tas backup av databasen varje natt. Ida Infront Ab 14