Tjänstespecifikation T25

Transkript

1 Tjänstespecifikation T25 Ladok på webb Ändringshistorik Av Kommentar Granskare Godkännare Lars Hansson Johan Forsman Inför leverans Anders Bergström Åtgärd 16423: Uppdaterat felmeddelanden Anders Bergström Lagt till info om signering av intyg Anders Bergström Flyttat deltjänsterna Kontrollera intyg och Se skapade intyg till T28. tehn

2 Magnus Uddstål Lagt till uppgift om hur man konfigurerar storlek på loggan Johan Forsman Förtydligande kring logotyp Anders Bergström Lagt till utbildningssamarbeten, T Bengt Hellström Utökat RegistrationCertificateVO med nytt attribut showstudiebreak

3 Innehållsförteckning Dokument (14) 1 INLEDNING SYFTE MÅLGRUPP BESKRIVNING Deltjänster Flödesbeskrivning Flödesdiagram BEHÖRIGHETSANALYS ÖVRIG DOKUMENTATION DELTJÄNST 1: REGISTRERINGSINTYG I PDF-FORMAT SYFTE BESKRIVNING Inställningar Systeminställningar Användarinställningar KRAVLISTA EXPONERADE METODER INDATA Kontroll UTDATA MEDDELANDEHANTERING Tjänstespecifika meddelanden... 14

4 Dokument (14) 1 Inledning 1.1 Syfte Syftet med dokumentet är att beskriva hur LPW-tjänsten Verifierbart registreringsintyg fungerar. Tjänsten möjliggör för studenter att ta ut intyg över egna registreringar via webben. Intygets äkthet kan i efterhand verifieras i en kontrolltjänst. 1.2 Målgrupp Dokumentet vänder sig till högskoleportaler som är intresserade av att använda tjänsten. 1.3 Beskrivning Tjänsten gör det möjligt för studenten att ta ut intyg över sina registreringar i PDF-format. När studenten väljer att hämta intyget läses detta upp i studentens dator. För att det ska fungera måste Acrobat Reader version 4.0 (7.0 om intyget signeras) och framåt finnas installerad på datorn. Ladok på webb ansvarar för hur intyget sätts ihop och visas, d v s utseendet är låst förutom vissa inställningsmöjligheter. Studenten kan läsa intyget på skärmen, spara det på sin dator och göra en pappersutskrift. Högskolan kan välja att implementera Ladok på webbs lösning för att garantera intygets äkthet. Detta innebär att PDF-filen sparas på servern innan den skickas ut till portalen (på en plats som specificerats i en inställningsfil). Med hjälp av ett kontrollnummer en unik kod som placeras längst ned på intyget kan andra målgrupper läsa upp samma intyg som studenten tidigare genererat och på så sätt verifiera innehållets äkthet. Detta görs med deltjänsten Kontrollera intyg i T28. En annan möjlighet att garantera intygets äkthet är att signera intyget. Äktheten hos ett signerat intyg kan sedan verifieras med deltjänsten Verifiera intyg i T28. Genom att använda PDF säkerställer vi att intyget ser likadant ut på skärmen som på skrivare. Dessutom blir intyget svårare att ändra Deltjänster Krav Deltjänst Målgrupp Status Nr 1 Registreringsintyg i PDF-format Studenter Lev 9/6-05 I den första deltjänsten genereras intyget i PDF-format av studenten.

5 1.3.2 Flödesbeskrivning Normalflöde i tjänsten: 1. Användaren väljer tjänsten i portalen Dokument (14) 2. Portalen anropar LPW-deltjänsten Visa intygsinformation med personnummer 3. LPW hämtar information om antal sparade giltiga intyg som studenten har samt hur många som får sparas på servern 4. Portalen visar en webbsida med inställningsmöjligheter för intyget samt en varning att studenten bara kan generera fem intyg till innan kvoten är fylld 5. Studenten ställer in hur intyget ska se ut och klickar på knappen Generera registreringsintyg 6. Portalen anropar LPW-deltjänsten Hämta registreringsintyg och skickar med studentens personnummer 7. LPW hämtar studentens registreringar, sammanställer uppgifterna till en PDF-fil, sparar filen på servern, signerar intyget och skickat ut intyget till portalen 8. Portalen meddelar att genereringen gått bra och frågar om studenten vill se intyget. 9. Studenten klickar på länken Visa intyget och intyget visas i Acrobat Reader 10. Studenten läser intyget, sparar det på sin pc, skriver ut intyget och lämnar det till en mottagare. 11. Mottagaren går in på webbadressen som står längst ned på intyget 12. Portalen visar en webbsida där intyget kan verifieras 13. Mottagaren matar in personnummer och kontrollnummer som framgår av intyget 14. Portalen anropar T28s deltjänst Kontrollera intyg 15. LPW hämtar samma intyg som tidigare sparats på servern 16. Portalen visar intyget för mottagaren på skärmen i Acrobat Reader 17. Mottagaren kontrollerar att uppgifterna i pappersintyget stämmer med intyget på skärmen Flödesdiagram Exempel på hur portalen kan använda deltjänsterna som ingår i tjänsten.

6 Dokument (14)

7 1.4 Behörighetsanalys Studenten kan bara ta ut uppgifter om sig själv. Tjänsten kräver inga externa behörighetskontroller. 1.5 Övrig dokumentation Tabellsäkerhet.doc Dokument (14) Innehåller de tabeller som tjänsten använder samt vilka rättigheter som måste sättas på respektive tabell för att tjänsten ska fungera. Finns på webben. JavaDoc Beskriver mer ingående de värdeobjekt som refereras till i in- och utdataavsnitten. Finns i leveransen. Åtgärdssystemet Här finns åtgärder rapporterade om tjänsten. Det kan vara kvarvarande krav, buggar och önskemål. Finns på webben.

8 Dokument (14) 2 Deltjänst 1: Registreringsintyg i PDF-format 2.1 Syfte Deltjänsten hämtar studentens registreringsuppgifter och sammanställer det till ett intyg i PDFformat. 2.2 Beskrivning Studenten ställer in hur intyget ska se ut och klickar på knappen Generera intyg. LPWdeltjänsten anropas med studentens personnummer. LPW börjar med att kontrollera om studenten får generera fler intyg (kontrolleras mot inställningsfil och tabell där uppgift om tidigare genereringar ligger sparade). Får studenten inte det avbryts vidare bearbetningar och felmeddelande. Därefter kontrollerar systemet om studenten har intyg som inte längre är giltiga och rensar bort dem om så är fallet. Sedan hämtas de uppgifter som behövs för intyget: högskola, programantagningar, registreringar, logotyp m m. Systemet sammanställer uppgifterna till ett PDF-dokument och signeras om signering är konfigurerad. PDF-filen sparas på en plats på servern som specificerats i inställningsfilen. Information om intygets generering sparas i tabellen LPWINTYG och LPWINTIN i databasen. LPW-deltjänsten skickar ut PDF-filen till portalen. Nu kan studenten läsa upp intyget på sin dator Inställningar Systeminställningar Dessa inställningar sätts centralt i en fil på applikationsservern och gäller för alla PDF-intyg som tas ut via LPW på högskolan. Inställning Typ Kommentar LIVSLANGD Int Talar om hur länge intyget är giltigt (och ska ligga kvar på servern). Anges i dagar. ANTAL Int Talar om hur många intyg en student får spara på servern (inom tidsgränsen). WWWADRESS Sträng Den webbadress där potentiell mottagare kan kontrollera intygets äkthet. Läggs in i footern på intyget om intyget sparas på

9 Inställning Typ Kommentar SOKVAG servern. Sträng Definierar sökvägen till den plats där LPW ska spara intyget. Dokument (14) SVE_LOGOTYPE String Sökvägen till svenska loggan som kan visas på intyget. Ska vara en gif-bild. Non interlaced. SVE_LOGOTYPE_W IDTH SVE_LOGOTYPE_H EIGHT String String Den bredd på bilden i pixlar man vill ha. Den höjd på bilden i pixlar man vill ha. ENG_LOGOTYPE String Sökvägen till engelska loggan som kan visas på intyget. Ska vara en gif-bild. Non interlaced. ENG_LOGOTYPE_ WIDTH ENG_LOGOTYPE_H EIGHT keystore alias keystorepwd keypwd keystoreplugin String String Den bredd på bilden i pixlar man vill ha. Den höjd på bilden i pixlar man vill ha. Sträng Sökväg till keystore som ska användas för signering. Sätts inte om ingen signering ska användas. Sträng Alias för signeringsnyckel i keystore. Sträng Lösenord för keystore Sträng Lösenord för signeringsnyckel. Sträng Klassnamn för signeringsplugin. Höjd och bredd på logotypen skall sättas för att man skall få en skarp bild. Det är rekommenderat att man använder en större bild och skalar ner den genom att ange en mindre höjd och bredd Användarinställningar Dessa inställningar kan användaren eller portalen sätta i indata till tjänsten. Se avsnittet indata.

10 2.3 Kravlista Krav Nr Dokument (14) Beskrivning Tabell Kontroll Prio Status 1. Kontrollera om studenten får generera fler intyg LPWINTYG Inställningsfil 0 Lev 9/ Hämta namn NAMN 0 Lev 9/ Hämta högskola EGENHSK 0 Lev 9/ Hämta programantagningar 5. Hämta terminsregistreringar 5.1 Hämta avvikande terminstider ANTLIN LINJE AVBRLIN ANTINR AVBRINR LINJEINR FFGLIN OMREGLIN LINJE LINJEINR 6. Hämta kursregistreringar FFGKURS FORTKURS OMKURS KURS 6.1 Hämta avbrutna kurser INREGFFG INREGFO INREGOM KURS 6.2 Hämta poäng som läses på terminen 6.3 Hämta avvikande terminstider 0 Lev 9/ Lev 9/6-05 TERMTIDP 2 Lev 9/6-05 FFGLIN OMREGLIN PROGPLH LINJE KTILLP KURS KTILL2 KTFORT2 SYSTPREF LOKKURS TERMTID 0 Lev 9/ Lev 9/ Lev 9/ Lev 9/ Hämta utbytesstudier UBUTREG 1 Lev 9/6-05

11 Krav Nr Dokument (14) Beskrivning Tabell Kontroll Prio Status utomlands (utresande) 8. Hämta utbytesstudier här (inresande) 9. Hämta datumintervall för terminer som ingår i intyget UBUTSTUD UTLHSK LAND UPROGRAM UBINSTUD UBINDRG KURS PROV UTLHSK LAND UPROGRAM 1 Lev 9/6-05 TERMIN 0 Lev 9/6 05. Ett underkrav återstår: Se åtgärd 10. Hämta logotyp Inställningsfil 0 Lev 9/ Generera kontrollnummer 0 Lev 9/ Formatera intyget till en PDF-fil i svensk version 13. Formatera intyget till en PDF-fil i engelsk version Inställningsfil 0 Lev 9/6 05 Inställningsfil 0 Lev 9/ Spara intyget på servern Inställningsfil 0 Lev 9/ Spara information om att intyget har genererats 16. Rensa bort intyg som inte längre är giltiga LPWINTYG 0 Lev 9/6 05 LPWINTYG Bef intyg 0 Lev 9/ Generera signerad pdf Inställningsfil 0 Lev 7/ Utbildningssamarbete SAMUTB SAMTILLF SAMPERS SAMHSK 19. Studieuppehåll UPPHLIN 0 Lev 9/2 12 Kommentar till kravlistan: Krav 1 Kontrollera om studenten får generera fler intyg

12 Dokument (14) Om antal giltiga intyg i tabellen LPWINTYG är lika med eller fler än ANTAL i inställningsfilen avbryts vidare bearbetningar och felmeddelande. Krav 2 Namn Hittas inte studenten i NAMN eller om avliden = J avbryts vidare bearbetningar och felmeddelande. Krav 6.2 Poäng som läses på terminen Kräver att det finns ett kurstillfälle upplagt i KTILL2, KTFORT2 eller KTILLP som går att koppla till kursregistreringen. Om högskolan inte vill visa kurser inom program med terminsregistrering (och tillhörande poäng som läses på terminen) sätts inställningen showcoursesemesterregistration till falsk. Då kommer systemet istället att visa ett hårdkodat 20 Poäng till höger om terminsregistreringen. Krav 6.3 Avvikande terminstider för kurser Hämtas bara om systemet inte hittat start- och slutvecka för kurstillfället. Den avvikande terminstiden gäller för kursen inte kurstillfället, och visas på samma sätt som veckoperioden för kurstillfället. Krav Formatering till PDF-fil Följande dokumentskydd sätts på filen: Krav 17 Generera signerad pdf Om inställnigarna för signering är satta i inställningsfilen så kommer intyget att signeras. Om intyget av någon anledning inte gick att signera blir det stop och felmeddelande lämnas.

13 2.4 Exponerade metoder Dokument (14) RegistrationCertificateVO getregistrationcertificate(uservo uvo, RegistrationCertificateVO rcvo) 2.5 Indata UserVO.PersonVO Parameter Format Kontroll Kommentar pnr C(10) Se dokument för generell in- och utdata RegistrationCertificateVO Parameter Format Kontroll Kommentar savepdf Boolean - True, om dokumentet skall sparas (krävs för att kunna använda efterkontrollen). languageeng Boolean - True, om intyget skall vara på engelska showfromsemester Boolean 1, 2 Första termin i dokumentet showuntilsemester Boolean 1, 2 Sista termin i dokumentet showlogotype Boolean - True, om logotypen skall visas False, visas högskolans namn istället logotypeplace String 1, 3 Logotypens horisontella placering. showcoursesemest erregistration Boolean - True, om kurser inom program med terminsregistrering skall visas. showexchange Boolean - True, om utbytesstudier skall visas. showomreg Boolean - True, om omregistrering på kurs skall visas showprogramadmi ssion Boolean - True, om programantagningar skall visas, även utbildningssamarbeten visas showstudiebreak Boolean - True om studieuppehåll ska visas showprogramdirec tiondrop Boolean - True, om avbrott på inriktningar skall visas Kontroll 1. Obligatorisk uppgift 2. Terminerna skall vara på formen V## eller H##, till exempel V89 eller H97 3. Tillåtna värden är LEFT, CENTER och RIGHT.

14 Dokument (14) 2.6 Utdata RegistrationCertificateVO Parameter Format Tabell Kolumn Kommentar pdffile Byte[] - - PDF-dokumentet valid Boolean - - Om denna är falsk finns meddelanden med nivå ERROR eller FATAL i Message messages Message[] - - Se tjänstespecifika felmeddelanden. 2.7 Meddelandehantering Det kan förekomma generella felmeddelanden från t ex validering, autenticering signering, nedan anges de tjänstespecifika felmeddelandenycklarna och loggmeddelandena till portalutvecklarna Tjänstespecifika meddelanden registrationcertificate.getregistrationcertificate.outofquota = Intyget kan inte tas ut. Kvoten för hur många giltiga intyg pnr {0} får spara är fylld. registrationcertificate.getregistrationcertificate.studentmissing = Intyget kan inte tas ut. Personnummer {0} hittades inte i registret. registrationcertificate.getregistrationcertificate.missinglogo = Intyget kan inte tas ut. Logotypen hittades inte. registrationcertificate.getregistrationcertificate.invalidsemesters = Fr.o.mtermin är större än t.o.m-termin