Healthcare nemsms. Installationsvejledning. Offentligt. Installation af nemsms

Transkript

1 Healthcare nemsms Installationsvejledning Side 1 af 16

2 Revision Dato Udarbejdet af Kontrolleret af Godkendt af Beskrivelse 0.1/ Henrik Bach Initial version (udkast) Henrik Bach Udarbejdelse af endelig version Henrik Bach Do Henrik Bach Lars Vilstrup Kontrolleret Pedersen Henrik Bach Opdaterede Oracle ODP.NET install Henrik Bach Opdateret mht. implementation ift. kravspecifikation version Henrik Bach Rettelser og præciseringer i diverse afsnit Henrik Bach Oprettet nyt afsnit om Service AJ Strømlining AJ Rettelse af tilgængelighed AJ Versionscheck AJ Forskellige rettelser efter 1. installation. Afsnit 2.8 om config fil flyttet til dette dokument fra Konfigurationsdokumentet Side 2 af 16

3 Indhold Indhold... 3 Indledning Forudsætninger Software og certifikater Hardware Installation NET Framework 3.5 Redistributable Package Oracle Data Provider til.net (ODP.NET) Oracle NLS_LANG konfiguration Oracle TNS konfiguration Installation af NemSMS applikationen Udpakning Installation af en instans Installation på Win 2008 server Installation på 64 bit server Afinstallation af NemSMS applikationen Kendte fejl efter endt (af-)installation Servicebruger Læserettigheder til virksomhedscertifikat nemsms*.config filen Versionscheck Konfiguration nemsms installations- og konfigurationsdokumenter: Healthcare nemsms. Installationsvejledning Healthcare nemsms. Konfiguration Healthcare nemsms. Konfiguration i e-boks administrationsportal Side 3 af 16

4 Indledning KMD NemSMS service er en Windows NT Service applikation. Denne vejledning beskriver, hvordan man installerer NemSMS servicen på en applikations-server. NemSMS servicen (i dette dokument også kendt som NemSMS) kører med tre tidsmæssige uafhængige tråde: Service 1, Service 2 og Service 3. Service 1 sørger periodisk (typisk 1 gang i timen) for at aflæse Care s database og danne beskeder til afsendelse i en kø, som service 2 periodisk (typisk hvert 5. minut) aflæser og afsender. Ved hvert forsøg på afsendelse af en besked vedligeholder Service 2 en besked-status i tabellen. Service 3 vedligeholder tabellen nemsms_clients, som anvendes af CARE-klienten ved manuel afsendelse af SMS er. Tabellen indeholder en fuldstændig fortegnelse over borgere i kommunen, som har tilmeldt sig Care-nemSMS i kommunen i E- boks. Tilmeldte borgere hentes i form af en komplet-liste. Ved kørsel af komplette lister, skal man være opmærksom på, at det typisk, for en kommune med borgere, som er tilmeldt e-boks NemSMS kommunikation, kan tage ca. 2 timer, før NemSMS_Clients tabellen er opdateret (det tager, for Service 3, i gennemsnit 0,21 sekund at behandle en borger). Side 4 af 16

5 1. Forudsætninger Dette afsnit beskriver, hvilke forudsætninger NemSMS kræver af software, certifikater og hardware. 1.1 Software og certifikater NemSMS forudsætter at Windows Server 2003 eller 2008 er installeret. NemSMS kræver, at Microsoft.NET 3.5+ er installeret. Installations-programmet vil opdatere miljøet, hvis dette ikke er tilfældet. NemSMS kræver, at Oracle Data Provider for.net (ODP.NET) installeret. NemSMS kræver adgang til en CARE-database fra version Ved kommunens underskrivelse af tilslutnings-aftalen med e-boks og oprettelse af afsendersystem til Care nemsms, skal der benyttes et virksomhedscertifikat (VO- CES) med en tilhørende privat-nøgle, som bruges til kommunikationen mellem e- boks og NemSMS. Dette certifikat skal NemSMS-servicens bruger-konto have læserettighed til. 1.2 Hardware KMD Healthcare NemSMS er en NT service, der afvikles med faste intervaller (typisk 5 min 1 time). Modulet er ikke ressourcekrævende og kan dele hardware med andre services. nemsms kræver 100Mb RAM plads. nemsms kræver 100Mb diskplads. Side 5 af 16

6 2. Installation I dette afsnit beskrives, hvordan NemSMS og andet krævet software installeres og eventuelt konfigureres. Det anbefales efter endt installation og før konfiguration af NemSMS, at man opdaterer operativsystemet og det krævede software med de seneste opdateringer fra de respektive leverandører. 2.1.NET Framework 3.5 Redistributable Package Microsoft.NET Framework 3.5 Redistributable Package kan hentes fra adressen: Alternativt kan den installeres fra serverens Server Manager. Endvidere skal PATH environment variablen indeholde stien til den seneste InstallUtil.exe som findes i en folder under: "C:\Windows\Microsoft.NET\Framework". F.eks. v Oracle Data Provider til.net (ODP.NET) Oracle Data Provider (ODP.NET) er nødvendig for at.net-baserede applikationer kan kommunikere med en Oracle-database. ODP.NET installerer bl.a. en Oracle 11- klient på maskinen. Hvis filen "C:\oracle\product\11.2.0\client_1\odp.net\bin\2.x\Oracle.DataAccess.dll" ikke findes anbefales det, at man følger nedenstående installationsvejledning. Link til ODP.NET 32bit 11.2 udgaver: html Skærmbilleder fra installationsprocessen (for ODP 10.2) er vist nedenfor. Obs, der skal installeres Side 6 af 16

7 Klik "Next". Vælg "Oracle Data Access Components xx" (som er default) og klik "Next". Side 7 af 16

8 Vælg et navn for Oracle-Home og en installations-sti. Giv ODP.NET sit eget Oracle Home. Hvis der allerede eksisterer et Oracle10-home på serveren, så benyt et andet navn, fx Oracle10net. Klik "Next". Vælg Oracle Data Provider for.net 1.x og.net 2.0. Klik "Next". Side 8 af 16

9 Klik "Install". Installationen kører... Side 9 af 16

10 Installationen er færdig. Klik "Exit" Oracle NLS_LANG konfiguration Det er vigtigt at den installerede Oracle Provider ODP.NET anvender den rigtige sprogkonfiguration. Konkret skal man sørge for at Oracle-parameteren NLS_LANG er sat til DA- NISH_DENMARK.WE8ISO8859P1. Oracle anviser forskellige måder man kan indstille denne Oracle-Parameter på. F.eks. kan man sætte den direkte i registry på maskinen: Gå ind i Registry (kommandoen REGEDIT fra en Windows kommando prompt) og vælg HKEY_LOCAL_MACHINE -> SOFTWARE -> ORACLE. Find alle de steder (også underfoldere) hvor parameteren NLS_LANG forekommer og kontroller at værdien er sat til DANISH_DENMARK.WE8ISO8859P Oracle TNS konfiguration For at applikationen kan finde den Oracle-database, der skal hentes og gemmes data fra, skal der defineres et såkaldt TNS-navn for database-forbindelsen. Dette skal angives i filen tnsnames.ora der ligger i underfolderen..\network\admin\ i den folder man har valgt at installere ODP.NET softwaren i. Dette bør konfigureres af en database-administrator eller en person med kendskab til konfiguration af TNS-navne og beskrives derfor ikke yderligere her. Det vigtige her, er at det valgte TNS-navn for databaseforbindelsen angives i konfigurationsfilen som beskrevet senere i denne vejledning. 2.3 Installation af NemSMS applikationen Side 10 af 16

11 2.3.1 Udpakning Applikationen leveres i en msi-fil, som installeres ved enten at dobbelt-klikke på msi-filen eller på den medfølgende setup.exe. Applikationen er installeret, under: <Program Files>\KMD\NemSMS_CARE_X.X.X\Setup (hvor X.X.X er versionsnummeret). Da applikationen er i stand til at køre en eller flere kopier (instanser) af Windows Servicen, kan man vælge at installere disse med det medfølgende install.bat program, som findes i Setup-folderen Installation af en instans En instans installeres ved at kalde install.bat <navn>.. f.eks. install.bat DRIFT Instansen af servicen findes nu i folderen: <Program Files>\KMD\NemSMS_CARE_X.X.X\<navn> og ses i Service Management konsollen som: KMD_NemSMS_CARE_X.X.X-<navn>. Der vil optræde fejl ved installation på en Windows 2008 server. De ekstra installationsskridt på 2008 behandles nedenfor. 2.4 Installation på Win 2008 server Servicen bliver ikke nødvendigvis installeret af install.bat, der ikke kan få fat i InstallUtil. (Kopier evt. InstallUtil til nemsms Setup folderen på forhånd). Instansen af Windows servicen installeres i stedet således: 1. Kør install.bat (som beskrevet i 2.3.2) 2. Gå til: C:\Windows\Microsoft.NET\Framework\v installutil /name="kmd_nemsms_til_care xx" "C:\Program Files (x86)\kmd\kmd NemSMS til CARE \xx\KMD_NemSMS_til_CARE xx.exe" (hvor den første parameter (KMD_NemSMS_til_CARE xx) er Service navnet. Den anden parameter er komplet path til exe filen). Tilsvarende ved fjernelse: 1. Gå til: C:\Windows\Microsoft.NET\Framework\v installutil /u /name="kmd_nemsms_til_care xx" "C:\Program Files (x86)\kmd\kmd NemSMS til CARE \xx\KMD_NemSMS_til_CARE xx.exe" Installation på 64 bit server Win 2008 skal tvinges til at køre servicen i 32bit, da den ellers ikke kan få fat i Oracle.DataAccess. Der skal vendes en bit i service koden (EXE filen) for at tvinge Windows til at køre servicen som 32 bit. Det gøres således: Side 11 af 16

12 1. Download "Windows SDK for and.net Framework 3.5" fra: 2. Installer kun.net development tools 3. Gå til: C:\Program Files\Microsoft SDKs\Windows\v6.1\Bin i en command prompt 4. corflags /32bit+ "C:\Program Files (x86)\kmd\kmd NemSMS til CARE \dev\KMD_NemSMS_til_CARE dev.exe" (hvor parameteren er path til service exe filen). 2.5 Afinstallation af NemSMS applikationen Er der flere kopiere af applikationen, skal disse afinstalleres ved at kalde: uninstall.bat <navn> Afinstalleres på en Windows 2008 server kræves et yderligere skridt. Se afsnit 2.4 ovenfor. Ønsker man at afinstallere en specifik version af applikationen gøres dette på normalvis, enten ved at gå ind i Add/Remove Programs i Windows kontrolpanelet eller Program Features og afinstallere applikationen eller du kalder den specifikke msi-fil/setup.exe, som du oprindeligt installerede applikationen med Kendte fejl efter endt (af-)installation NemSMS servicen FINDES I SERVICE MANAGEMENT CONSOLE EFTER AFINSTALLATION Beskrivelse: I service management konsollen forekommer den afinstallerede KMD_NemSMS_CARE_X.X.X [-<navn>]. Procedure: Kør sc delete KMD_NemSMS_CARE_X.X.X[-<navn>] fra en kommandprompt og genstart serveren (fjerner instansen fuldstændigt fra operativsystemet). 2.6 Servicebruger Der bør oprettes speciel bruger (hvis en sådan ikke findes i forvejen) til at køre SMS Windows NT Servicen, da der kræves rettigheder til kommunikation med e- Boks. I Windows administrationspanelet under Services opsættes servicen til at anvende denne servicebruger i stedet for standardbruger. 2.7 Læserettigheder til virksomhedscertifikat nemsms anvender et virksomhedscertifikat til at identificere sig overfor eboks. Hvis et sådan certifikat ikke forefindes, skal det anskaffes. Det skal gemmes i en base64 encoded udgave, som kommunen derefter skal uploade til eboks. (Processen er beskrevet i dokumentet Konfiguration af nemsms i eboks administrationsportalen). Den bruger som NemSMS servicen benytter skal tildeles læserettigheder på certifikatet. Det gøres direkte fra certificates snap-in: a) Højreklik på Certifikatet -> All Tasks -> Manage Private Keys Side 12 af 16

13 b) Tilføj Read til den brugerkonto, som servicen er konfigureret til at køre med. 2.8 nemsms*.config filen config filen ligger i samme folder som NT servicens EXE fil. Den rummer information om servicens adgang til Care databasen og adgang til e-boks. Den kan f.eks. have dette indhold: <?xml version="1.0" encoding="utf-8"?> <configuration> <appsettings> <!-- "DataSource" (Oracle-databasen) --> <add key="datasource" value="xxxx_otb.kd4" <!-- Integrationstestmiljø --> <add key="dkal.service.rest.basehost" value=" <add key="dkal.service.webservice.url" value=" <add key="dkal.service.test.web.certificate.storename" value="my" <add key="dkal.service.test.web.certificate.storelocation" value="localmachine" <add key="dkal.service.test.web.certificate.findtype" value="findbyserialnumber" <add key="dkal.service.test.web.certificate.findvalue" value="459c9023" <!-- Produktionsmiljø --> <!-- <add key="dkal.service.rest.basehost" value=" <add key="dkal.service.webservice.url" value=" <add key="dkal.service.test.web.certificate.storename" value="my" <add key="dkal.service.test.web.certificate.storelocation" value="localmachine" <add key="dkal.service.test.web.certificate.findtype" value="findbythumbprint" <add key="dkal.service.test.web.certificate.findvalue" value="65dafed0ba7edcea e3c2bfd910619ab" --> <!-- Delete key="servicename", unless in file App.config --> <add key="servicename" value="kmd_nemsms_til_care_ " <add key="loglevel" value="1" </appsettings> </configuration> DataSource indeholder navnet på den aktuelle database og svarer til en indgang i Oracles tnsnames.ora filen. Dernæst følger 2 blokke (á hver 6 nøgler), hvoraf kun den ene er aktiv. Den ene blok holder værdierne til e-boks testmiljøet. Den anden blok (udkommenteret ovenfor) holder værdierne til e-boks produktion. Side 13 af 16

14 Når en service sættes op til produktion, udkommenteres test nøglerne, og udkommentering fjernes omkring produktions nøglerne. dkal.service.rest.basehost peger på e-boks REST-snitflade og dkal.service.webservice.url peger på e-boks SOAP-snitflade. For begge gælder der, at de oplyses af e-boks, når man har indgået en tilslutningsaftale. I test- /integrationsfasen peger disse på et testmiljø, mens det i produktions-fasen peger på produktionsmiljøet hos e-boks. dkal.service.test.certificate.* parametrene definerer hvordan det benyttede VOCES certifikat tilgås på maskinen, hvor NemSMS servicen er installeret. Fra REST-SOAP_Services_-_Referenceimplemtation_1.0.pdf er følgende beskrivelse af ovenstående parametre (certifikat underforstås et klient-certifikat med tilhørende private nøgle): dkal.service.test.web.certificate.storename Angiver hvilket certificate store applikationen skal lede efter certifikatet i. Mulige værdier er: AddressBook (other people) AuthRoot (third-party root certification authorities) CertificateAuthority (intermediate certification authorities) Disallowed (revoked certificates) My (personal) Root (trusted root certification authorities) TrustedPeople TrustedPublisher Typisk installeres certifikatet under Personal, så værdien af denne indstilling skal som oftest være My. dkal.service.test.web.certificate.storelocation Angiver om applikationen skal lede efter certifikatet under brugerkontoen eller computeren. Mulige værdier er: CurrentUser LocalMachine Certifikatet bør installeres under LocalMachine. dkal.service.test.web.certificate.findtype Angiver typen af søgning applikationen foretager for at finde certifikatet. Mulige værdier er: FindByThumbprint FindBySubjectName FindBySubjectDistinguishedName FindByIssuerName FindByIssuerDistinguishedName FindBySerialNumber FindByTimeValid FindByTimeNotYetValid FindByTimeExpired Side 14 af 16

15 FindByTemplateName FindByApplicationPolicy FindByCertificatePolicy FindByExtension FindByKeyUsage FindBySubjectKeyIdentifier Beskrivelse af de forskellige søgetyper kan findes på Typisk benyttes FindByThumbprint eller FindBySerialNumber. dkal.service.test.web.certificate.findvalue angiver værdien i certifikatet. For værdien FindByThumbprint vælges værdien fra certifikatets Thumbprint. tilsvarende for SerialNumber. Værdien indsættes uden blanktegn mellem talgrupper. ServiceName indeholder navnet på servicen. Det indsættes som application_name, når der skrives til Windows Application event-loggen. LogLevel definerer log-omfanget: 0: Kun start og stop af servicen registreres 1: Desuden registreres hver gang en af de 3 services (Care-ekstrakt, afsendelse af SMS, opdatering af tilmeldingsliste) kaldes (DEFAULT) 2: Hvert request registreres 3: Hvert trin i afviklingen registreres 4: XML modtaget fra e-boks registreres også Der registreres log-entries i Windows Application event-loggen og i Care snitflade loggen. De højere loglevels registrerer kun til Care loggen, der kan ses fra Care modulet. For yderligere information om kommunikationen med e-boks er det muligt at monitorere http trafikken. Det gøres ved at indsætte følgende i config filen: <configuration> <system.diagnostics> <sources> <source name="system.net" tracemode="includehex" maxdatasize="1024"> <listeners> <add name="system.net" </listeners> </source> <source name="system.net.sockets"> <listeners> <add name="system.net" </listeners> </source> <source name="system.net.cache"> <listeners> <add name="system.net" </listeners> </source> </sources> <switches> Side 15 af 16

16 <add name="system.net" value="verbose" <add name="system.net.sockets" value="verbose" <add name="system.net.cache" value="verbose" </switches> <sharedlisteners> <add name="system.net" type="system.diagnostics.textwritertracelistener" initializedata="c:\temp\network.log" </sharedlisteners> <trace autoflush="true" </system.diagnostics> <appsettings> Konsekvensen er, at http trafikken registreres i filen c:\temp\network.log Det bør ikke gøres i produktion (for længere tid), da det er store datamængder der registreres. 2.9 Versionscheck I installationskataloget ligger filen set_version.sql Den skal køres for at sikre at databasen har den rigtige nemsms version registreret. Når NT servicen startes, sammenligner den først sin egen version med den versionsbetegnelse der findes i CARE_SYS tabellen (nøglen REQ_NEMSMS_VER). Disse 2 versioner skal være identiske. I modsat fald vil servicen ikke køre; der lægges en linie herom i INTF_LOG tabellen og i NT Event loggen. 3. Konfiguration Fortsæt nu med konfigurationen af e-boks. Se dokumentet: Konfiguration af Healthcare nemsms i e-boks Derrnæst kan du foretage selve opsætningen af nemsms i Care. Se dokumentet: Konfiguration af Healthcare nemsms Side 16 af 16