Tjänstespecifikation T12

Transkript

1 Tjänstespecifikation T12 Ladok på webb Ändringshistorik Revision Datum Av Kommentar Granskare Godkännare Savn Skapat dokumentet Jnbm Uppdaterat ang. dbtabeller Jnbm Uppdaterat ang. dbtabeller Lhn Tybm Uppdaterat för engelskt intyg Savn Förtydligat ändring av texter Lhn Lagt till att inställningen program inte är utvecklad Lhn Klargjort att ECTS-betyg visas i ECTS-varianten. Lagt till att

2 modulen programantagningar är utvecklad (utskick ). Detta innefattar också inställningen Program Jnfm Lagt till metod för att hämta uppgifter om sparade intyg Jnfm Ändrat så att PDF dokumentet returneras i en byte array Mlbd Ändrade felmeddelandenahteringen Anders Bergström Lagt till info om signering av intyg Johan Forssell Lagt till i SecureCertificateVO Anders Bergström Flyttat Kontrollera intyg och Se skapade intyg till T Magnus Uddstål Lagt till uppgift om hur man konfigurerar storlek på loggan Anders Bergström, Lars Hansson Johan Forsman Bengt Hellström Projekt T-816, tillägg:: Specificering av tillgodoräknat prov, specificering av utländsk betygsskala i tillgodoräknade kurser, ECTS-uppgifter kan tas ut samtidigt med övriga uppg. Översyn av noter. Nya inställningar: NotKonvert, SpecTillgodoProv, Tillgodo Förtydligande kring logotyp. Lagt till uppgift om betygsfördelning Mats Ronnling Lagt till utbildningssamarbeten.

3 LPW (1) Innehållsförteckning 1 INLEDNING SYFTE BESKRIVNING MÅLGRUPP DELFUNKTION Skapa intyg TABELLER SKAPA INTYG BESKRIVNING Inställningar KRAVLISTA EXPONERADE METODER INDATA UTDATA Tjänstespecifika felmeddelanden... 1

4 LPW (1) 1 Inledning 1.1 Syfte Med hjälp av denna tjänst kan målgruppen studenter ta ut ett intyg på webben som senare kan kontrolleras av t.ex. en potentiell arbetsgivare. 1.2 Beskrivning Tjänsten gör det möjligt för studenten att ta ut intyg över sina studieresultat i PDF-format. När studenten väljer att hämta intyget läses detta per automatik upp i studentens dator. (Det måste finnas ett program som klarar av att läsa PDF-format installerad på datorn, t ex Acrobat Reader.) 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. Det ska vara möjligt för studenten att: o Läsa intyget på skärm o Göra en utskrift på skrivare o Spara intyget på sin dator 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 elektroniskt sigill en unik kod som placeras längst ned på intyget kan potentiella målgrupper läsa upp samma intyg som studenten tidigare sparat i T28s deltjänst Kontrollera intyg. En annan möjlighet att garantera intygets äkthet är att signera intyget. Äktheten hos ett signerat intyg kan sedan verifieras med T28s deltjänst Verifiera intyg. 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. 1.3 Målgrupp Målgruppen för dokumentet är Utvecklare av tjänster som skall använda sig av LPW samt Driftcentraler. 1.4 Delfunktion Tjänsten består av en delfunktion, skapa intyg Skapa intyg Skapa intyg används av studenten för att skapa ett giltigt intyg i pdf-format. 1.5 Tabeller Se dokument Tabellsäkerhet.

5 LPW (1) 2 Skapa intyg 2.1 Beskrivning Tjänsten genererar ett resultatintyg i PDF-format Inställningar Användarinställningar Dessa inställningar kan användaren eller portalen sätta i indata till tjänsten. Inställning Typ Kommentar Prio SparaPdf Logotyp Boolsk Sann = systemet sparar PDF-filen på servern. Detta innebär att högskolan väljer att implementera LPW:s lösning för kontroll av intygets äkthet. Boolsk Sann = logotyp skrivs ut på intyget Falsk = högskolans namn skrivs ut på intyget istället LogoPlacering Sträng Horisontell placering av logotypen, möjliga värden är LEFT, RIGHT,CENTER Ects Boolsk Sann = poäng och betyg enligt ECTS-systemet skrivs ut. SprakEng Boolsk Sann = intyget skrivs ut på engelska Godkkurs Boolsk Sann = endast avslutade kurser skrivs ut 1 Godkprov Boolsk Sann = godkända prov i alla kurser skrivs ut 1 Program Boolsk Sann = uppgift om programantagning skrivs ut och då skrivs också utbildningssamarbeten ut, om sådana finns. Examina Boolsk Sann = examensuppgifter skrivs ut 2 Kurskoder Boolsk Sann = kurskoder skrivs ut 2 Noter Boolsk Sann = noter över betygsskalor skrivs ut 2 Projektarbete Boolsk Sann = titel skrivs ut för projektarbete/uppsats 2 NotKonvert Boolsk Sann = Not för konverterad högskolepoäng visas T-816 (28-4-1) Tillgodo Boolsk Sann = Tillgodoräknade kurser visas T-816 (28-4-1) SpecTillgodop rov betygsfordelni ng Boolsk Sann = Specificering för tillgodoräknade prov visas T-816 (28-4-1) Boolsk Sann = Betygsfördelning visas 2 STUT-T-119( )

6 LPW (1) Alla inställningar har utvecklats. Språkinställningar Ändringar för de texter som finns på olika de språken görs i tjänstens jar. Tillvägagångsättet är enligt följande: 1. Ta ut någon av PdfMessages_XX.properties filerna ur jaren. 2. Gör de ändringar som önskas i filen. 3. Lägg tillbaka PdfMessages_XX.properties filen i jaren. 4. Starta om Applikationsserver. Filen heter PdfMessages_sv.properties för svenska och PdfMessages_en.properties för engelska. Systeminställningar Dessa inställningar sätts centralt i en fil på applikationsservern och gäller för alla intyg som tas ut via webbtjänsten på högskolan. Denna fil heter certificates.properties och ska ligga i applikationsserverns startkatalog. Inställning Typ Kommentar Prio 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 String Den webbadress där potentiell mottagare kan kontrollera intygets äkthet. Läggs in i footern på intyget om intyget sparas på servern. SOKVAG String Definierar sökvägen till den plats där LPW ska spara intyget. SVE_LOGOTYPE String Sökvägen till svenska loggan som kan visas på intyget. Ska vara en gif-bild. Non interlaced. SVE_LOGOTYPE_WIDTH String Den bredd på bilden i pixlar man vill ha. SVE_LOGOTYPE_HEIGHT String Den höjd på bilden i pixlar man vill ha.

7 LPW (1) Inställning Typ Kommentar Prio ENG_LOGOTYPE String Sökvägen till engelska loggan som kan visas på intyget. Ska vara en gif-bild. Non interlaced. ENG_LOGOTYPE_WIDTH String Den bredd på bilden i pixlar man vill ha. ENG_LOGOTYPE_HEIGHT String Den höjd på bilden i pixlar man vill ha. Keystore String Sökväg till keystore som ska användas för signering. Sätts inte om ingen signering ska användas. Alias String Alias för signeringsnyckel i keystore. Keystorepwd String Lösenord för keystore Keypwd String Lösenord för signeringsnyckel. Keystoreplugin String 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. 2.2 Kravlista Krav nr Beskrivning 1 Visa personuppgifter 2 Visa programuppgifter 2 3 Visa examensuppgifter 1 4 Visa resultat på hel kurs 5 Visa resultat på prov 5.1 Visa titel på projektarbete Specificering av tillgodoräknat prov 6 Visa resultat på del av kurs/individuell kurs 7 Visa tillgodoräknade hela kurser Prio T-816 (28-4-1)

8 LPW (1) Krav nr Beskrivning 7.1 Visa allt om tillgodoräknade kurser, inkl specificering av utl bskala 8 Visa godkänd ej poängsatt praktik 9 Visa total poängsumma 1 Visa betygsskalor 11 Visa högskola 12 Checksumma 13 Visa intyget i engelsk variant 14 Visa variant med ECTSbetyg och ECTS-poäng 15 Generera signerad pdf Prio 1 T-816 (28-4-1) T-816 (28-4-1) Alla krav är utvecklade. 2.3 Exponerade metoder SecureCertificateVO getcertificate(uservo uvo, SecureCertificateVO svo) 2.4 Indata Studentens personnummer anges i PersonVO i UserVO. Värdeobjekt Data Format Kontr. Kommentar UserVO Uvo UserVO Se dokumentet Generell indata SecureCertificateV O - storepdf boolean Ska intyget sparas på servern? logotype boolean Ska loggan visas på intyget? godkprov boolean Ska alla godkända prov visas?

9 LPW (1) kurskoder boolean Ska alla kurs och provkoder visas? godkkurs boolean Ska endast godkända kurser visas? noter boolean Ska noter och betygsskalor visas? projektarbete boolean Ska projektarbeten visas? logoplacering String Var skall loggan placeras, LEFT, CENTER, RIGHT sprakeng boolean Skall intyget skrivas ut på engelska? ects boolean Skall intyget skrivas ut enligt ECTS? utbildningsniva boolean Ska utbildningsnivån visas? examen boolean Ska examen visas? programantagn ing boolean Ska programantagningar och utbildningssamarbeten visas? notkonvert boolean Ska not för konverterade högskolepoäng visas? spectillgodopro v boolean Ska specificering av tillgodoräknade prov visas? tillgodo boolean Ska tillgodoräknade kurser visas? Betygsfordelnin g Boolean Ska betygsfördelning visas 2.5 Utdata Värdeobjekt Data Format Kommentar SecureCertificat evo bytearray byte[] PDF dokumentet valid boolean Om denna är falsk finns det felmeddelanden i messages messages Message[] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata

10 LPW (1) och Messge Tjänstespecifika felmeddelanden Konstant Nivå Kommentar Logmeddelande securecertificate.fileexception Error Filfel har uppstått Ett fel uppstod när certifikatet skulle sparas. securecertificate.imageexception Error Logotypen kan inte hittas securecertificate.quotafilled Info Studenten har fyllt sin quota och får inte skriva ut fler intyg. Ett fel uppstod när logotypen skulle infogas i certifikatet. Det är inte tillåtet att spara fler intyg. För generella felmeddelanden se dokumentet Message Övrig information Tjänsten använder sig av systempreferensen BETFORD och delas med nouveaufunktionen UT2. Tjänsten kollar alltså mot rutin UT2 i tabellen SYSTPREF.