MODERNISERINGSSTYRELSEN ØSLDV WINDOWS SERVICE DOKUMENTATION, INSTALLATION OG KONFIGURERING AF ØSLDV/RAY WINDOWSSERVICE

Transkript

1 Indhold Ændringshistorik... 2 Formål... 2 Om programmet... 2 Systemkrav... 2 Installation... 3 Event Log... 5 Installationsprogrammets skærmbillede... 6 Konfigurering af xml-opsætningsfil... 7 Beskrivelse af entitterne i FetchesXMLFile.xml... 9 Nulstilling af sidst hentet dato

2 Ændringshistorik Dato Beskrivelse Indsat billede i dokumentation vedrørende installationens skærmbillede Opdateret dokument med Indlæs eksisterende konfigurationsfil funktionalitet Opdateret screenshot i afsnittet Installationsprogrammets skærmbillede Opdateret i forbindelse med frigivelse af version 1.3 Formål Formålet med dette dokument er at give en systemansvarlig et dokument som beskriver hvordan ØSLDV RAY Windows service til indberetning af data til Moderniseringsstyrelsen Lokale Data Vare Hus (ØSLDV) skal sættes op lokalt. Om programmet Programmet ØSLDV RAY Windows service er en applikation som sættes op på en Windows server (se under systemkrav for krav til systemer.) Programmet importerer rejseafregningsdata fra RejsUd til Moderniseringsstyrelsen Lokale Data Vare Hus (ØS LDV) Importering af data sker ved at ØSLDV RAY Windows Service kontakter en webserver hos Moderniseringsstyrelsen via Secure Socket Layer (SSL) HTTPS port 443. Programmet kører som en Windows Service under Windows Network Service account. Programmet importerer data 1 gang i døgnet. Dette kan dog ændres (Se under konfiguration) Programmet installeres under Windows standard programbibliotek (Program Files/Programmer) Programmet kan fjernes igen via Windows kontrol panel og funktionen Tilføj Fjern programmer/add Remove Programs. Systemkrav Microsoft Windows Server 2003 eller nyere Microsoft.NET Framework 3.5 Microsoft SQL Server 2005 SP3 Yderligere systemkrav følger vejledningen til ØSLDV som forefindes på mb fri plads på disk 2

3 Installation Pakken indeholdende opsætning og applikation hentes på Moderniseringsstyrelsens hjemmeside. Udpak ZIP filen. RejsUD_Installer_1_3.zip Du vil nu have en folder der hedder RejsUD_Installer_1_3. Naviger ned i folderen RejsUD_Installer_1_3 Følgende filer vil være at se (Figur 1) Klik på Setup.exe (Setup.exe skal startes af Windows brugeren Administrator. Eks højreklik på filen og vælg "Run as administrator" ) Nu starter installationsprogrammet af Windows Servicen der henter data fra RAY s centrale database til en eller flere lokale databaser. I installationsprogrammet skal du konfigurere Windows Servicen til din organisation. Se mere om dette på næste side. Hvis servicen allerede er installeret på den computer hvorpå installationsprogrammet afvikles, kan programmet benyttes til at konfigurere servicen. Programmet vil i dette tilfælde indlæse den eksisterende konfiguration, og videre konfigurering er så muligt. Du bør være klar med oplysninger om din databaseserver samt det brugernavn og kodeord du har modtaget fra MODST. Brugernavnet er nummeret på din institution. Kombinationen brugernavn og kodeord fungerer som login til RAYs centrale webservice. 3

4 1. Indtast adressen til MODST Webservice Eks. (Figur) 2. Tag stilling til om login oplysningerne til databasen er korrekte. Eks. Windows Security eller SQL server login skal benyttes (se. pkt. 7 under Installationsprogrammets skærmbillede) 3. Vælg eller indtast jeres SQL Server som indeholder dataset Eks. SERVER2\SQL24 4. Vælg den database som ligger på den SQL server du har valgt 5. Indtast institutionens EAN-nummer (Institutionsnummer) 6. Indtast kodeord (Password) 7. VIGTIGT! Afprøv forbindelsen til database og webservice ved at klikke på se under mulige fejlkilder hvis der fremkommer fejlinformation. 8. Klik på knappen og din database tilføjes til listen. 9. Gentag proceduren fra pkt. 3 hvis der er flere institutioner på samme server farm. 10. Hvis dette er en førstegangsinstallation(servicen er ikke installeret endnu) vil der være en knap nederst i skærmbilledet. Ved at klikke på denne installerer installationprogrammet Windows Servicen under Windows (x86) %ProgramFiles%. Eks. C:\Program Files (x86)\osldv\osldv.raywindowsservice\ Hvis dette ikke er en førstegangsinstallation(programmet er installeret på computeren i forvejen) vil der være en nederst i skærmbilledet. Ved at klikke på denne opdateres den eksisterende service med den ændrede konfiguration. Der vil i dette tilfælde ikke foregå nogen installation Som standard opsættes webservicen til at hente data (HentDataDelta) kl en gang i døgnet. Første gang der hentes data for institutionen, hentes samtlige data. Derefter hentes kun de data der er ændret siden sidste gang data blev hentet. 4

5 Såfremt webservicen opsættes med flere institutioner på samme server, bør man ændre tidspunktet for hvornår at data hentes, således at dataene ikke hentes på samme tidspunkt. Rettelsen foretages xmlopsætningsfilen, se under afsnittet Konfigurering af xml-opsætningsfil. For manuelt at sikre at servicen er installeret se under windows service i kontrolpanel. I listen over Windows Services fremkommer. Er denne service ikke fremkommet skal du sikre dig at du har gennemført alle trin. Uddybning af installationsskærmbilledet finder du under afsnittet Installationsprogrammets Skærmbillede. Mulige fejlkilder i ovenstående trin Database servernavn er forkert Windows integrated security er slået fra, og der skal benyttes SQL server login Du som bruger har ikke rettigheder til at tilgå databasen. Dit login til webservice er forkert, du får et dialog boks med "Forkert login til webservice" Dit login til databasen er forkert, du får en dialog boks med "Forkert login til database" Event Log Webservicen skriver til Event loggen hver gang der sker en hændelse. Event loggen er tilgængelig via Windows EventLog under Windows Logs Application. Hvis data ikke kommer frem eller der opstår problemer med at tilgå webservices eller databaser, vil dette fremgå af Windows Event Log. Der sker fx hændelser til Event loggen i følgende tilfælde: når webservicen, hvert 10 minut døgnet rundt, forespørger om der skal hentes data når der hentes data der skrives institutionsnummer og hvilke tabeller der hentes data til information om installationen eventuelle fejl I Event Loggen har applikationen navnet OSLDV Service. 5

6 Installationsprogrammets skærmbillede Installationen af Windows Servicen har ét konfigurationsskærmbillede: 1. Adressen på den centrale webservice hvorfra data skal hentes 2. Navnet på den SQL-server hvor data skal flyttes til 3. Navnet på den database hvor data skal flyttes til. Her kan enten vælges en eksisterende database i dropdownlisten (efter tryk på Opdater ), eller indtaste navnet på en ny. Hvis der indtastes navnet på en ny database, skal felterne i (6) indtastes og herefter trykkes på Opret database (12) 4. Institutionsnummeret 5. Institutionens password til RejsUd 6

7 6. Oplysninger i denne boks benyttes kun hvis der oprettes en database gennem denne wizard. Som udgangspunkt vil servicens opdatering af data i databasen altid benytte servicekontoen Network Service 7. Brug integrated security ved oprettelse af database 8. SQL-brugernavn til brug ved oprettelse af database (kun tilgængelig når (7) er slået fra) 9. SQL-password til brug ved oprettelse af database (kun tilgængelig når (7) er slået fra) 10. Giver read/write rettigheder til servicen Network Service på denne database. Det er denne konto der som standard benyttes af servicen til at indsætte data i databasen 11. Test af databaseforbindelse og webserviceforbindelse, herunder bekræftelse af password 12. Opretter den indtastede database (3) på SQL-serveren 13. Tilføjer den indtastede institution til listen (14) 14. Liste over de institutioner der er tilføjet til installationen 15. Fjern den valgte institution fra listen 16. Denne knap kan have to tekster a. Installer: Start installationen af servicen med de valgte settings. Denne knap vil være synlig hvis servicen ikke allerede er installeret på computeren b. Gem: Gemmer settings til den allerede installerede service Hvis der efter installation ønskes en yderligere opsætning af systemet, herunder tilføjelse af institutioner/jobs, kan dette gøres gennem en XML-konfigurationsfil (se næste afsnit) eller ved at køre programmet igen. Konfigurering af xml-opsætningsfil Filen FetchesXMLFile.xml er fra Moderniseringsstyrelsen side opsat med standard konfiguration. Efter installationsprogrammet er kørt og du har konfigureret Windows Servicens opsætning, bliver XML filen ændret og tilpasset de oplysninger du har givet. Skulle der på et givent tidspunkt opstå problemer, eller du får nyt kodeord, kan rettelser foretages i denne XML fil. Filen findes under installationsbiblioteket hvor du installerede Webservicen. Eks. C:\Program Files (x86)\osldv\osldv.raywindowsservice\ FetchesXMLFile.xml. Efter en ændring af xml-filen skal servicen (OSLDV Service) genstartes for at ændringerne effektueres. Efter installation oprettes automatisk en xml-konfigurationsfil i installationsbiblioteket med navnet FetchesXMLFile.xml. Det er her alle hent-kommandoerne er defineret. En definition består af et institutionsnummer, info om hvilken database der skal hentes data til, info om hvornår jobbet skal køre samt hvilke data der skal hentes. Det er muligt at have flere jobs med samme institutionsnummer, hvis man f.eks. ønsker at hente information om samme institution til flere forskellige databaser. Herunder ses et eksempel på et job. De enkelte felters funktion er forklaret: 7

8 <Fetch> <!--The institution number--> <Institutionsnummer> </Institutionsnummer> <!--The RAY password of the institution--> <Password>PASSWORD01</Password> <!--The SQL-server that hosts the database--> <DatabaseServer>local</DatabaseServer> <!--The name of the database, data should be fetched to--> <DatabaseNavn>osldv01</DatabaseNavn> <!--Only used with FetchOperation is "HentDataInterval". The start month in the interval--> <StartMonth>200901</StartMonth> <!--Only used with FetchOperation is "HentDataInterval". The end month in the interval--> <EndMonth>200912</EndMonth> <!--The status of the fetch: Done Running NotRun --> <FetchStatus>NotRun</FetchStatus> <!--The type of operation: TestForbindelse HentDataFuld HentDataDelta HentDataInterval --> <FetchOperation>HentDataDelta</FetchOperation> <!--How often the operation is run: once daily weekly monthly --> <FetchFrequency>daily</FetchFrequency> <!--Used in "weekly": monday, tuesday wednesday thursday friday saturday sunday --> <FetchWeekday>monday</FetchWeekday> <!--Used in every operation except "once". The time the task is to be executed--> <StartTime>21:00</StartTime> <!--The elements to be syncronized. Every element in this block should be either true or false. The elements corresponds to a table in the database. Only elements set to true in this block will be fetched--> <FetchHentliste> 8

9 <Accountcharts>true</Accountcharts> <Cardtypes>true</Cardtypes> <Companyunits>true</Companyunits> <Countrycodes>true</Countrycodes> <Currencycodes>true</Currencycodes> <Documentheader>true</Documentheader> <Documentrow>true</Documentrow> <Documenttypes>true</Documenttypes> <Driveevents>true</Driveevents> <Employeedata>true</Employeedata> <Expensegroups>true</Expensegroups> <Expensetypes>true</Expensetypes> <Methofpayments>true</Methofpayments> <Objectgroups>true</Objectgroups> <Objectvalues>true</Objectvalues> <Postingentries>true</Postingentries> <Taxbases>true</Taxbases> <Traveldays>true</Traveldays> <Travelpurpose>true</Travelpurpose> <Travelrules>true</Travelrules> <Traveltargets>true</Traveltargets> <Vehicletypes>true</Vehicletypes> </FetchHentliste> <!--Not used currently--> <FetchDay> T00:00:00</FetchDay> <!--only used in "monthly" frequency for the day of the month--> <MonthDay>20</MonthDay> </Fetch> Beskrivelse af entitterne i FetchesXMLFile.xml Felt Institutionsnummer Password DatabaseServer DatabaseNavn FetchOperation Beskrivelse Institutionens unikke nummer Password til RAY-webservice. Udleveres af MODST Navnet på den server hvor den lokale database ligger Navnet på den database der skal hentes data til Operation. Denne kan antage værdierne: TestForbindelse Tester forbindelsen til MODST s centrale webservice. Der overføres ikke data i denne operation HentDataFuld Henter al data for den aktuelle organisation til den lokale database HentDataDelta Henter data for den aktuelle organisation til den lokale database. Der hentes kun de data der er ændret eller tilføjet siden sidste HentDataFuld eller HentDataDelta operation HentDataInterval Henter data for den aktuelle organisation til den lokale database. Der hentes kun de data der er ændret eller tilføjet inden for et bestemt interval (StartMonth til 9

10 Felt FetchFrequency Beskrivelse EndMonth) Moderniseringsstyrelsen anbefaler at man udelukkende anvender HentDataDelta. Frekvens af operationen. Denne kan antage værdierne: once Operationen udføres kun en enkelt gang daily Operationen udføres hver dag weekly Operationen udføres én gang om ugen monthly Operationen udføres én gang om måneden StartMonth, EndMonth FetchStatus FetchWeekday StartTime FetchHentliste MonthDay Moderniseringsstyrelsen anbefaler at man anvender daily. Benyttes kun når FetchOperation er HentDataInterval. Bestemmer hvilket interval der skal hentes data for Den aktuelle status af operationen. Denne kan have værdierne: Done Running NotRun Benyttes kun når FetchFrequency er weekly. Bestemmer hvilken ugedag operationen skal afvikles på. Kan antage værdierne: monday tuesday wednesday thursday friday saturday Sunday Benyttes når FetchFrequency er daily, weekly eller monthly. Bestemmer hvornår på dagen operationen skal udføres. Er opsat med kl. 21 som default. Såfremt xml-filen indeholder flere institutioner, anbefaler Moderniseringsstyrelsen af der ikke hentes på samme tidspunkt til alle institutioner. Bestemmer hvilke data der skal overføres. Under dette element er child-elementer der hver repræsenterer en tabel i databasen. Hvert af disse elementer kan antage værdien true eller false. Det er kun rækker fra de tabeller der har værdien true der overføres under operationen Moderniseringsstyrelsen anbefaler at der hentes data til alle tabeller. Benyttes når frekvensen er monthly. Bestemmer den dag på måneden operationen skal afvikles 10

11 Nulstilling af sidst hentet dato Windows servicen gemmer altid en dato for hvornår den sidst succesfulde overførsel er fundet sted. Hvis det bliver nødvendigt at nulstille denne dato, gøres det ved at slette folderen OSLDV som ligger under servicebrugerens indstillinger. Alt efter windows version kan dette være C:\Windows\ServiceProfiles\NetworkService\AppData\Local\OSLDV. Bemærk! Dette bør kun udføres i samarbejde med Moderniseringsstyrelsen. Vejledning afsluttet. 11