Konfigurationsvejledning til NemSMS - careconsult.dk · Web viewKør programmet FindPrivateKey.exe (uden argumenter for at se, hvilken syntaks der skal bruges for at finde det gemte

TilKommunens IT-Driftsleverandør

DokumenttypeInstallationsvejledning

DatoApril 2011

NEMSMSSERVICEINSTALLATIONS-VEJLEDNINGHRIB100022

RambøllHannemanns Allé 53DK-2300 København ST +45 5161 1000F +45 5161 1001www.ramboll-informatik.com

NEMSMSSERVICEHRIB100022

Revision 0.11Dato 2011-02-01Udarbejdet af HRIBKontrolleret af LLPGodkendt af [Navn]Beskrivelse [Text][Valgfri 1] Installations- og konfigurationsvejledning til CARE

NemSMSService for driftsleverandøren

Revision Dato Udarbejdet af Kontrolleret af Godkendt af Beskrivelse

0.1/.2 2010-10-01 Henrik Bach Initial version (udkast)0.3- 2010-10-04 Henrik Bach Udarbejdelse af endelig version0.8 2010-10-06 Henrik Bach Do.0.9 2010-10-13 Henrik Bach Lars Vilstrup

PedersenKontrolleret

.10 2010-10-14 Henrik Bach Opdaterede Oracle ODP.NET install.

.11 2011-01-03 Henrik Bach Opdateret mht. implementation ift. kravspecifikation version 0.7.

.12 2011-02-01 Henrik Bach Rettelser og præciseringer i diverse afsnit.

.13 2011-04-13 Henrik Bach Oprettet nyt afsnit om Service 3.

Ref. [xxxxx]Document ID HRIB100022Version

HRIB100022

INDHOLD

1. Indledning 12. Forudsætninger 12.1 Software og certifikater 12.2 Hardware 13. Installation 23.1 .NET Framework 3.5 Redistributable Package 23.2 Oracle Data Provider til .NET (ODP.NET) 23.2.1 Oracle ”NLS_LANG” konfiguration 63.2.2 Oracle TNS konfiguration 63.3 Afinstallation af NemSMS applikationen 63.3.1 Kendte fejl efter endt (af-)installation 73.3.1.1 NemSMS servicen FINDES I SERVICE MANAGEMENT CONSOLE

EFTER AFINSTALLATION 73.4 Installation af NemSMS applikationen 73.4.1 Udpakning 73.4.2 Installation af en instans 73.5 programmet FindPrivateKey 74. Konfiguration 84.1 Fælles parametre som deles mellem trådene i NemSMS

Servicen 84.2 Parametre for Service 1 104.3 Parametre for Service 2 104.4 Parametre for Service 3 11

Error: Reference source not found

4-1

1. INDLEDNINGRambøll NemSMS service er en Windows Service applikation, som kører autonomt i operativsystemet uden en brugeres involvering.

Denne vejledning beskriver, hvordan man installere NemSMS service på en applikations-server og konfigurerer de enkelte parametre i NemSMS servicens konfigurations-database og -fil.

NemSMS service (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 for at aflæse Care’s database og danne beskeder til afsendelse i en kø (NemSMS_Requests), som service 2 periodisk aflæser og afsender. Ved hvert forsøg af afsendelse af en besked vedligeholder Service 2 en besked-status i tabellen.

Service 3 vedligeholder tabellen NemSMS_Clients, som læses af CARE-klienten. Denne tabel indeholder, borgere, som servicen har hentet og behandlet fra e-boks NeMSMS afsendersystem. Tilmeldte borgere hentes i form af en ændrings- eller komplet-liste. Er det første gang NemSMS servicen sættes i drift eller er tabellen ude af trit med e-boks' afsendersystem anbefales det at hente en komplet-liste (ændres indefra administrations-portalen for afsendersystemet) og sætte konfigurationsnøglen Service3CleanupInDays til værdien 0 (nul). Når servicen (evt. efter genstart) er afviklet (CARE-klienten: Systemadm. > Snitflader > NemSMS > Log) kan man vælge at hente ændringslister. Vælger man i stedet for at fortsætte med komplette-lister, sættes Service3CleanupInDays til en værdi, som er større eller lig med værdien for Service3TimerInterval.

Ved kørsel af komplette lister, skal man være opmærksom på, at det typisk, for en kommune med 30.000 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).

2. FORUDSÆTNINGERDette afsnit beskriver, hvilke forudsætning NemSMS kræver af software, certifikater og hardware.

2.1 Software og certifikater

NemSMS forudsætter at Windows Server 2003 er installeret.

NemSMS kræver, at Microsoft .NET 3.5+ er installeret. Installations-programmet vil opdatere miljøet, hvis dette ikke er tilfældet. Se afsnit 3.1, hvis installations-programmet ikke har kunnet installere .NET 3.5.

NemSMS kræver, at Oracle Data Provider for .NET (ODP.NET) installeret. Se afsnit 3.2.

NemSMS kræver adgang til en CARE-database fra version 11.2. Se afsnit 4.1.


4-2

Ved underskrivelsen af tilslutnings-aftalen med e-boks, skal der benyttes et virksomhedscertifikat (VOCES) 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æse-rettighed til. Se afsnit 3.5, hvorledes dette gøres.

2.2 Hardware

Rambøll Informatik anbefaler, at der dedikeres en server specifikt til NemSMS, hvorpå der ikke kører andre krævende applikationer. De vigtigste parametre ved valg af server er: RAM, CPU og driftssikkerhed. Harddisk-plads er af mindre betydning.


4-3

3. INSTALLATIONI 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.

3.1 .NET Framework 3.5 Redistributable Package

Microsoft .NET Framework 3.5 Redistributable Package kan hentes fra adressen: http://msdn.microsoft.com/en-us/library/cc160716.aspx.

Endvidere skal PATH environment variablen indeholde stien til den seneste InstallUtil.exe som findes i en folder under: "C:\Windows\Microsoft.NET\Framework".

3.2 Oracle Data Provider til .NET (ODP.NET)

Data Provideren (ODP.NET) er nødvendig for at .NET-baserede applikationer kan kommunikere med en Oracle-database. ODP.NET installerer bl.a. en Oracle 10-klient på maskinen. Det er vigtigt, at der ikke kører andre Oracle-afhængige applikationer på applikations-server, da Oracle 10-klienten er meget hårdhændet overfor ældre drivere.

Hvis filen "C:\oracle\product\10.2.0\client_1\odp.net\bin\2.x\Oracle.DataAccess.dll" ikke findes anbefales det, at man følger nedenstående installationsvejledning.

Følg installationsvejledningen fra Oracles hjemmeside for at installere ODP.NET:http://www.oracle.com/technology/software/tech/windows/odpnet/install10202.html

Download filen ODAC1020221.exe fra følgende URL: http://www.oracle.com/technology/software/tech/windows/odpnet/utilsoft.htmlLink til filen ses under afsnittet ”Oracle 10g Release 2 ODAC”. Filen fylder 206 MB.Filen er gratis at hente, men Oracle kræver, at man opretter en brugerkonto (hvilket også er gratis og går hurtigt).

Kør filen ODAC1020221.exe for at udpakke installationsfilerne.

Kør installations-programmet ved at køre filen ”setup.exe” i underfolderen ”\Install”

Skærmbilleder fra installationsprocessen er vist nedenfor.


http://www.oracle.com/technology/software/tech/windows/odpnet/utilsoft.html

http://www.oracle.com/technology/software/tech/windows/odpnet/install10202.html

http://msdn.microsoft.com/en-us/library/cc160716.aspx

4-4

Klik "Next".

Vælg "Oracle Data Access Components 10.2.02 xx" (som er default)og klik "Next".


4-5

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".


4-6

Klik "Install".

Installationen kører .......


4-7

Installationen er færdig.Klik "Exit".

3.2.1 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 ”DANISH_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) 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.WE8ISO8859P1”.

3.2.2 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.

3.3 Afinstallation af NemSMS applikationen

Ønsker man at afinstallere en specifik version af applikationen gøres dette på normalvis, enten ved at gå ind i Add/Remove Programs eller Program Features og afinstallere applikationen eller du kalder den specifikke msi-fil/setup.exe, som du oprindeligt installerede applikationen med.

Er der flere kopiere af applikationen, skal disse afinstalleres ved at kalde:

uninstall.bat <navn>


4-8

3.3.1 Kendte fejl efter endt (af-)installation

3.3.1.1 NemSMS servicen FINDES I SERVICE MANAGEMENT CONSOLE EFTER AFINSTALLATION

Beskrivelse: I service management konsollen forekommer den afinstallerede Ramboll_NemSMS_til_CARE-9.12.0[-<navn>].

Procedure: Kør ”sc delete Ramboll_NemSMS_til_CARE-9.12.0[-<navn>]” fra en kommand-prompt og genstart serveren (fjerner instansen fuldstændigt fra operativsystemet).

3.4 Installation af NemSMS applikationen

3.4.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>\ Rambøll Informatik\Rambøll NemSMS til 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.

Konfigurationen af installationen og en eller instanser foregår på samme måde.

3.4.2 Installation af en instans

En instans installeres ved at kalde

install.bat <navn>

Instansen af servicen findes nu i folderen ”<Program Files>\ Rambøll Informatik\Rambøll NemSMS til CARE - X.X.X\<navn>” og ses i Service Management konsollen som: Ramboll_NemSMS_til_CARE-9.12.0-<navn>.

3.5 programmet FindPrivateKey

Der skal tildeles læserettigheder på virksomhedscertifikatet for den bruger som NemSMS benytter.

Dette gøres med programmet FindPrivateKey.exe, der er inkluderet i installationen og ligger i dennes applikationsfolder.

Start en command-prompt som Administrator.

Skift til den folder hvor NemSMS er installeret.

Kør programmet FindPrivateKey.exe (uden argumenter for at se, hvilken syntaks der skal bruges for at finde det gemte VOCES).

Når programmet kaldes ser nu en liste over de certifikater der ligger i certificate store. Her vist for ”Certificates (Local Computer) \ Personal \ Certificates:


4-9

Vælg virksomhedscertifikatet som du vil tildele læserettigheder til.Klik ”Ok”.

Man ser nu et skærmbillede hvor man kan tildele rettigheder til brugerne på serveren.

Hvis man f.eks. anvender brugeren NETWORK SERVICE til NemSMS, skal man sikre sig at denne bruger har både ”Read og ”Read & Execute” rettigheder.

4. KONFIGURATIONI dette afsnit beskrives, hvordan NemSMS Servicen konfigureres.

Applikationen konfigureres ved at ændre på parametrene i konfigurations-databasen og/eller -filen: NemSMS*.config.

Servicen vil først søge i konfigurations-databasen efter parametrene. Hvis disse ikke er fundet, vil den søge i konfigurations-filen.

Konfigurations-parametrene i databasen ses og ændres i CARE-klienten: Systemadm. > Snitflader > NemSMS > Opsætning.

4.1 Fælles parametre som deles mellem trådene i NemSMS Servicen

Dette afsnit beskriver parametre som deles mellem trådene i NemSMS Servicen.

DataSource (skal kun være i filen) indeholder navnet på den aktuelle database.

dkal.service.rest.basehost skal pege på e-boks’ REST-snitflade og dkal.service.webservice.url skal pege på e-boks’ SOAP-snitflade. For begge gælder der,


4-10

at de oplyses af e-boks, når man har indgået en tilslutningsaftale. I test-/integrationsfasen peger disse på et miljø, mens det i produktions-fasen peger på et andet miljø hos e-boks.

dkal.service.test.certificate.* parametrene drejer sig om, hvor henne og hvordan, det ved tilslutningsaftalens indgåelse udleverede/benyttet 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 FindByTemplateName FindByApplicationPolicy FindByCertificatePolicy FindByExtension FindByKeyUsage FindBySubjectKeyIdentifier

Beskrivelse af de forskellige søgetyper kan findes på http://msdn.microsoft.com/en-us/library/system.security.cryptography.x509certificates.x509findtype.aspx. Typisk benyttes ”FindByThumbprint”.


4-11

dkal.service.test.web.certificate.findvalue angiver værdien i certifikatet. For værdien FindByThumbprint vælges værdien fra Thumbprint.

Alle parametre med foranstillet dkal.* skal kun være i konfigurations-filen.

ServiceId beskriver hvilket e-boks afsendersystem denne NemSMS Windows service repræsenterer.

4.2 Parametre for Service 1

Dette afsnit beskriver parametre, som er specifik for Service 1.

Det skal bemærkes at Service 1 ikke danner straks-meddelelser til køen, men kun meddelelser, som afsendes som beskrevet for Service 2.

Service1TimerInterval sætter perioden for start af en kørsel. Typisk startes servicen med en times mellemrum.

*Service1HoursBefore beskriver, hvornår en besked tidligst kan dannes fra databasen for aktiviteter (Activities), besøg baseret på henvendelser (Visitator), forebyggende besøg (Preventive) og ydelser (Aids).

*Service1LatestMinutesBefore beskriver, hvornår en besked senest kan dannes fra databasen.

*ExtraConditionsNemSMSRequest gør det muligt at tilføje ekstra-søgekriterier ved udsøgningen i databasen. For aktiviteter drejer det sig om (alias som skal bruges er i parentes): activity_client (acc), activity_session (acs), activity_group (acg), activity_type (act) og batch (b). Søge-kriteriet er sql-baseret og der skal være key-word’et “and” mellem hvert kriterium bortset foran det første, f.eks.:

acs.act_type_no = acg.act_type_no AND acs.group_no = acg.group_no

For henvendelser drejer det sig om: request_visit (rv), batch (b) og client (c). For forebyggende besøg drejer det sig om: prev_visit (pv), batch (b) og client (c). For ydelser drejer det sig om: v_aid_time_list_actual (vatla) og batch (b).

*ContentTypeID skal indeholde indsholdstype-identifikatoren for at afsende beskeder af denne type.

*Template kan indeholde en tekst, som foranstilles al anden tekst i beskeden.


Dette afsnit beskriver parametre, som er specifik for Service 2. Service 2 køre op mod e-boks' afsendersystem.

Service2TimerInterval sætter perioden for start af en kørsel. Typisk startes servicen hvert femte minut, da der kan lægges beskeder ind i køen uden om Service 1 (f.eks. straks-meddelelser fra Care-klienten), foruden, at der er mulighed for nedbrud af kommunikationen mellem Service 2 og e-boks.

Service2LatestMinutesBefore beskriver, hvornår en besked senest skal sendes fra køen. Typisk ønsker man ikke at sende beskeden, hvis der er mindre end 20. minutter før meddelelsens afsendelsestidspunkt.


4-12

Service2DaytimeHourStart beskriver, hvornår servicen skal starte med at afsende meddelelser, som ikke er straks-meddelelser.

Service2DaytimeHourEnd beskriver, hvornår servicen skal stoppe med at afsende meddelelser, som ikke er straks-meddelelser.

Så, straks-meddelelser udsendes uanset ovenstående to værdier.


Dette afsnit beskriver parametre, som er specifik for Service 3. Service 3 køre op mod e-boks' afsendersystem.

Service3TimerInterval sætter perioden for start af en kørsel. Typisk startes servicen hver femte dag, som er det interval e-boks laver komplette lister til. Køres der med ændringslister kan intervallet sættes ned til en dag.

Service3TimerIntervalUnit sætter enheden for ovenstående periode for start af en kørsel.

Service3CleanUpInDays sørger for ved hver kørsel (gælder kun for komplette lister) at slette rækker i NemSMS_Clients-tabellen ældre end kørsels-tidspunktet for Service 3 + værdien.

Henter servicen komplette-lister, sættes Service3CleanupInDays til en værdi, som er større eller lig med værdien for Service3TimerInterval i dage. Ved afhentning af ændringslister ses der bort fra denne værdi.

Service3ListType er reserveret til evt. senere brug og aflæses derfor ikke. Service 3 finder automatisk ud af, hvilken type liste (ændrings- eller komplet-liste) den henter fra afsendersystemet.


Documents

Konfigurationsvejledning til NemSMS - careconsult.dk · Web viewKør programmet FindPrivateKey.exe (uden argumenter for at se, hvilken syntaks der skal bruges for at finde det gemte