Tjänstespecifikation T27

Transkript

1 Tjänstespecifikation T27 Ladok på webb Ändringshistorik Datum Av Kommentar Granskare Godkännare Lars Hansson Första version Johan Forsman Lagt till uppgifter om felmeddelande hantering Therese Hermansson Lagt till fler systeminställningar Anders Bergström Åtgärd 16423: Uppdaterat felmeddelanden Johan Forssell Nytt fält i NationalCertificateVO Anders Bergström Flyttat deltjänsterna Kontrollera intyg och Se tehn tehn

2 skapade intyg till T Magnus Uddstål Lagt till uppgift om hur man konfigurerar storlek på loggan Anders Bergström, Lars Hansson Anders Bergström Bengt Hellström Projekt T-8106: 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: visanotkonvert, visaspectillgodoprov Bytt PROTITEL till PROTITE2 Lagt till uppgifter om betygsfördelnings Mats Ronnling Lagt till uppgifter om programantagningar och utbildningssamarbeten Bengt Hellström Lagt till uppgifter om genomförd praktik Anders Bergström Tillgodoräknanden grundade på forskarstudier (INBYTFO) Tord Ekberg Lagt till Nationell logo till Nationellt intyg David Andersson Antal dagar default i betygsfördelningspreferensen är ändrad till 720 från 730 och därmed likställd med UT Sara Asplund Förklaring kring antal dagar och betygsfördelning.

3 LPW (16) Innehållsförteckning 1 INLEDNING SYFTE BESKRIVNING Deltjänster Flödesbeskrivning Systemdiagram BEHÖRIGHETSANALYS TABELLER SOM ANVÄNDS I TJÄNSTEN DELTJÄNST 1: NATIONELLT RESULTATINTYG I PDF-FORMAT SYFTE BESKRIVNING Inställningar Systeminställningar...Fel! Bokmärket är inte definierat Användarinställningar...Fel! Bokmärket är inte definierat. 2.3 KRAVLISTA EXPONERADE METODER INDATA UTDATA MEDDELANDEHANTERING Tjänstespecifika meddelanden Övrig information... 16

4 LPW (16) 1 Inledning 1.1 Syfte Syftet med dokumentet är att beskriva funktionaliteten i tjänsten Nationellt resultatintyg. 1.2 Beskrivning Tjänsten gör det möjligt för studenten att ta ut intyg över sina studieresultat från högskolor som är anslutna till PING-nätverket. För detta krävs att både den lokala och de externa högskolorna har en lokal installation av PING (det nya ramverket skrivet i Java). Vidare krävs även en lokal installation av LPW samt att högskolan bygger ett gränssnitt mot tjänsten. LPW ansvarar för innehållet och utseendet på intyget. Studenten/portalen kan påverka innehållet genom att sätta parametrar i indata till tjänsten. För att läsa det genererade PDF-intyget krävs Acrobat Reader version 4.0 eller senare. Studenten kan läsa intyget på skärmen, spara det på sin dator och göra en pappersutskrift. Dokumentskyddet i PDF-filen ställs in så det inte går att kopiera eller ändra innehållet. Genom att använda PDF säkerställs att intyget ser likadant ut på skärmen som på skrivare. Högskolan kan liksom i övriga intygstjänster välja att implementera Ladok på webbs lösning för att garantera intygets äkthet. Detta innebär att PDF-filen sparas på den egna högskolans server 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 Deltjänster Krav Deltjänst Målgrupp Status Nr 1 Nationellt resultatintyg i PDF-format Studenter Tjänsten omfattar en deltjänst som genereras intyget i PDF-format. Denna tjänst ska användas av studenter Flödesbeskrivning Normalflöde i tjänsten: 1. Användaren väljer tjänsten i portalen 2. Portalen anropar LPW-deltjänsten Visa intygsinformation med personnummer

5 LPW (16) 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 nationellt resultatintyg 6. Portalen anropar LPW-deltjänsten Nationellt resultatintyg i PDF-format och skickar med studentens personnummer 7. LPW kontrollerar att studenten får generera intyget, tar bort gamla intyg, anropar PING (som hämtar lokala och externa resultatuppgifter), sammanställer informationen, sparar filen på servern och skickar 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

6 LPW (16) Systemdiagram Lokal DB PING (extern) PING (lokal) Hämta lokala res.uppg Extern DB Portal Webbtjänst SOAP LPW Hämta nationellt intyg SOAP RMI Hämta alla res.uppg Hämta lokala res.uppg RMI PING (extern) Hämta lokala res.uppg Extern DB PING (extern) Hämta lokala res.uppg Extern DB 1.3 Behörighetsanalys Studenten kan bara ta ut uppgifter om sig själv och tjänsten kräver inga externa behörighetskontroller. 1.4 Tabeller som används i tjänsten Se dokumentet tabellsäkerhet.doc.

7 LPW (16) 2 Deltjänst 1: Nationellt resultatintyg i PDF-format 2.1 Syfte Deltjänsten hämtar studentens resultatuppgifter och sammanställer det till ett intyg i PDF-format. 2.2 Beskrivning Studenten/Portalen ställer in hur intyget ska se ut och klickar på knappen Generera intyg. LPW-deltjä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. LPW anropar sedan en metod i den lokala PING-applikationen Hämta intygsuppgifter från alla högskolor. Denna anropar i sin tur tjänsten Hämta lokala intygsuppgifter på alla högskolor (inklusive den egna) som ingår i PING-nätverket. Intygsuppgifterna hämtas ur de lokala databaserna och skickas tillbaka till LPW. Därefter sammanställer LPW-tjänsten uppgifterna till en PDF-fil som sparas på en plats på servern, vilken specificerats i inställningsfilen. Information om intygets generering sparas i tabellen LPWINTYG i databasen. LPW-deltjänsten skickar ut PDF-filen till portalen. Nu kan studenten läsa upp intyget på sin dator Systeminställningar Dessa inställningar sätts centralt i en fil på applikationsservern (certificate.properties)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 SOKVAG Sträng Den webbadress där potentiell mottagare kan kontrollera intygets äkthet. Läggs in i footern på intyget om intyget sparas på servern. Sträng Definierar sökvägen till den plats där LPW ska spara intyget.

8 LPW (16) Inställning Typ Kommentar INTERNATIONAL_ LOGOTYPE INTERNATIONAL _LOGOTYPE_WIDT H INTERNATIONAL _LOGOTYPE_HEIG HT SVE_LOGOTYPE SVE_LOGOTYPE_W IDTH SVE_LOGOTYPE_H EIGHT ENG_LOGOTYPE ENG_LOGOTYPE_ WIDTH ENG_LOGOTYPE_H EIGHT Sträng Sökvägen till den logotyp som som ska användas för Nationella intyg Sträng Den bredd på bilden i pixlar man vill ha. Sträng Den höjd på bilden i pixlar man vill ha. Sträng Sökvägen till den logotyp som som ska användas för intyg på svenska Sträng Den bredd på bilden i pixlar man vill ha. Sträng Den höjd på bilden i pixlar man vill ha. Sträng Sökvägen till den logotyp som som ska användas för intyg på svenska Sträng Den bredd på bilden i pixlar man vill ha. Sträng Den höjd på bilden i pixlar man vill ha. Dessutom krävs en inställning i context.properties som talar om adressen till den pingserver som LPW skall använda sig av för att hämta uppgifterna Inställning Typ Kommentar PING_URL Sträng Talar om adressen till pingservern som skall kontaktas för att få Användarinställningar Dessa inställningar kan användaren eller portalen sätta i indata till tjänsten. Inställning Typ Kommentar Status SparaPdf Boolsk Sann = systemet sparar PDF-filen på

9 LPW (16) Inställning Typ Kommentar Status visalogotyp LogoPlacering servern. Detta innebär att högskolan väljer att implementera LPW:s lösning för kontroll av intygets äkthet. Boolsk Avgör om logotyp skall visas på intyget. Eftersom ingen nationell logotyp finns framtagen för tjänsten, rekommenderar vi att denna sätts till false i portalen Sträng Ej implementerad visaects SprakEng visagodkkurs visagodkprov visaprogram visaexamen visaprojektarbete visapraktik visatillgodo Boolsk Sann = poäng och betyg enligt ECTSsystemet skrivs ut. Boolsk Sann = intyget skrivs ut på engelska Boolsk Sann = endast avslutade kurser skrivs ut Boolsk Sann = godkända prov i alla kurser skrivs ut Boolsk Sann = ej avbrutna program/programinriktningar, samt utbildningssamarbeten skrivs ut Boolsk Sann = examensuppgifter skrivs ut Boolsk Sann = titel skrivs ut för projektarbete/uppsats Boolsk Ej implementerad Boolsk Sann = Tillgodoräknanden skrivs ut visanotkonvert Boolsk Sann = Not om konvertering skrivs ut Lev 4/10 08 visaspectillgodoprov Boolsk Sann = Specifikation för tillgodoräknade prov skrivs ut. Lev 4/10 08 visabetygsfordelning Boolsk Sann = betygsfördelning visas Lev 9/9-10 antaldagar String Kommentar till inställningar: Det finns i dagsläget ingen logotyp framtagen för det nationella intyget. Tills vidare skriver tjänsten ut en rubrik i textform istället. Inställning för noter saknas. Systemet skriver alltid ut noter på intyget.

10 LPW (16) Inställning för om koder ska visas saknas (exempelvis för kurser och prov). Systemet visar aldrig koder. Hur styrningar fungerar i kombination: visagodkkurs är sann och visagodkprov är sann Godkända prov i avslutande kurser visas. Ej avslutade kurser och godkända prov i ej avslutade kurser visas inte. visagodkkurs är falsk och visagodkprov är falsk Godkända prov i avslutade kurser visas inte. Godkända prov i ej avslutade kurser visas. visagodkprov är falsk och visaprojektarbete är sann Endast godkända prov med projektarbete visas, gäller både i avslutade kurser och ej avslutade kurser. visabetygsfördelning och AntalDagar AntalDagar är relevant då betygsfördelning ska visas och är en systempreferens som sätts i rutin UT20 och heter BETFORD. AntalDagar är i standardläget satt till 720 dagar. Om betygsfördelning ska visas används datumet personen har i GODKKURS, därefter kontrolleras om det finns något godkänt resultat tidigare än AntalDagar. Alltså i standardläget om någon har ett godkänt resultat 720 dagar eller tidigare på denna kurs. Om detta krav inte uppfylls visas ingen betygsfördelning för kursen. Om betygsfördelning ska visas enligt ovan regler tas därefter alla godkända resultat som har samma eller tidigare betygsdatum (datum i GODKKURS) med i beräkningen av fördelningen. Notera här att de som har ett senare datum i GODKKURS inte kommer användas som underlag i beräkning av betygsfördelningen. 2.3 Kravlista Krav Nr Beskrivning Tabell Kontroll Prio Status 1 Visa namn (kontrollerar också att studenten får köra tjänsten) 2 Kontrollera att studenten får generera fler intyg 3 Koppling mot lokala Ladok-databaser via PING NAMN IGALLRAD LPWINTYG Inställningsfil Fil med högskolor 0 Lev 9/ Lev 9/ Lev 9/2-06

11 LPW (16) Krav Nr Beskrivning Tabell Kontroll Prio Status 4 Kontrollera personnummer* NAMN IGALLRAD GALLRAD 0 Lev 9/ Visa högskolans namn* EGENHSK 0 Lev 9/ Visa programantagningar* ANTLIN AVBRLIN LINJE ANTINR LINJEINR AVBRINR 7 Visa examensuppgifter* EXAMEN EXAMBEN EXAMINR AGRPSCB 8 Visa resultat på hel kurs* GODKKURS KURS 9 Visa resultat på prov* GODKPROV PROV 2 Lev 9/ Lev 9/ Lev 9/ Lev 9/ Visa titel på projektarbete* PROTITE2 1 Lev 9/ Visa specificering av tillgodoräknat prov* 10 Visa resultat på del av kurs/individuell kurs* 11 Visa tillgodoräknade hela kurser* GODKPROV GODKPRTG ALLAHSK UTLHSK LAND UBINDRG UBINDBG KURS PROV UTBYTE KURS INBYTEGH INBYTANN ALLAHSK LAND UTLHSK Lev 10/ Ej implementerat 1 Lev 9/2 06

12 LPW (16) Krav Nr Beskrivning Tabell Kontroll Prio Status 12 Visa godkänd ej poängsatt praktik* Visa genomförd praktik KURS GODKKURS PERSATKN INBYTFO PRAKTHEL PRAKTLIN PRAKTIK PRAKTTYP PRAKTORG 2 Lev 10/4 08 Lev 9/ Visa forskarstudier* 2 Ej implementerat 14 Visa övrig utbildning* 2 Ej implementerat 15 Visa summeringar* 0 Lev 9/ Visa betygsskalor* BETSKALA 0 Lev 9/ Hämta logotyp Inställningsfil 0 Ej implementerat 18 Generera kontrollnummer 0 Lev 9/ Visa intyg på svenska Inställningsfil 0 20 Visa intyg på engelska Inställningsfil 1 Lev 9/ Visa intyg på svenska enligt ECTS-systemet 22 Visa intyg på engelska enligt ECTS-systemet Inställningsfil 2 Lev 9/2 06 Lev 10/4 08 Inställningsfil 2 Lev 9/2 06 Lev 10/ Spara intyg på servern Inställningsfil 0 Lev 9/ Spara information om att intyget har genererats 25 Rensa bort intyg som inte längre är giltiga LPWINTYG 0 Lev 9/2-06 LPWINTYG Bef intyg 0 Lev 9/2-06

13 LPW (16) * Är uppgifter som hämtas via PING Kommentar till kravlistan: Uppgifterna visas som det vanliga resultatintyget Krav 1 Kontrollera om studenten får generera fler intyg Om antal giltiga intyg i tabellen LPWINTYG är lika med eller fler än ANTAL i inställningsfilen avbryts vidare bearbetningar och felmeddelande. Krav 2 Visa namn Om systemet inte hittar personen i lokala databasen eller om personen är avliden alt. individuellt gallrad avbryts vidare bearbetningar och felmeddelande. Inga uppgifter visas. Krav 4 Kontrollera personnummer Om studenten saknas i NAMN på en högskola visas aldrig högskolan i utskriften. Är studenten avliden eller individuellt gallrad på en högskola avbryts vidare bearbetningar och felmeddelande. Inga uppgifter visas från någon högskola. Krav 16 Visa betygsskalor Noter för betygsskalor visas alltid i utskriften. Krav Formatering till PDF-fil Följande dokumentskydd sätts på filen:

14 LPW (16) 2.4 Exponerade metoder NationalCertificateVO getnationalcertificate(uservo uvo, NationalCertificateVO rcvo) 2.5 Indata UserVO.PersonVO Parameter Format Kontroll Kommentar pnr C(10) Se dokument för generell in- och utdata NationalCertificateVO Parameter Format Kontroll Kommentar sparapdf Boolean - True, om dokumentet skall sparas (krävs för att kunna använda efterkontrollen). sprakeng Boolean - True, om intyget skall vara på engelska visaects Boolean - True, om betyg och poäng ska visas enligt ECTSsystemet visagodkkurs Boolean - True, om endast godkända kurser ska visas visagodkprov Boolean - Ture, om alla godkända prov ska visas visaprogram Boolean - True, om programantagningar och utbildningssamarbeten ska visas visaexamen Boolean - True, om uppgifter om examen skall visas visaprojektarbete Boolean - True, om titel för projektarbete ska visas visapraktik Boolean - Ej implementerat visalogotyp Boolean True, om logotyp skall skrivas ut i intyget. Vi rekommenderar att denna sätts till false då nationell logotyp saknas. visanotkonvert Boolean - True om konverteringsnot ska visas visaspectillgodopro v Boolean - True om specificering av tillgodoräknade prov ska visas. logoplacering String Right, left, center visatillgodo Boolean - True, om tillgodoräknade kurser ska visas visautbildningsniva Boolean - True, om utbildningsnivån visas? visabetygsfordelning Boolean True Betygsfördelning visas

15 LPW (16) antaldagar String Resultat måste finnas längre tillbaka i tiden än antalet angivna dagar. 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 meddelanden 2.7 Meddelandehantering Det kan förekomma generella felmeddelanden från t ex validering och autenticering, nedan anges de tjänstespecifika felmeddelandenycklarna och loggmeddelandena till portalutvecklarna. Generella meddelanden finns beskrivna i dokumentet Message Tjänstespecifika meddelanden Meddelanden på nivå ERROR Key Value Orsak nationalcertificate.studentmissing Personnummer Studenten saknas i på lokala högskolan. Alternativt är studenten markerats som avliden i någon av högskolorna eller är individuellt gallrad. nationalcertificate.outofquota Studenten har fyllt sin quota för antal sparade dokument. Fel som kommer från andra högskolor sätts som INFO meddelanden om de inte är stoppande.

16 LPW (16) Kända meddelanden som kan komma från högskolorna Key nationalcertificate.hsk.not.found nationalcertificate.examen.not.found nationalcertificate.godkkurs.not.found nationalcertificate.notgodkkurs.not.found nationalcertificate.tillgodo.not.found nationalcertificate.betskala.not.found nationalcertificate.student.is.gallrad nationalcertificate.student.not.found request.unknown destination.unreachable server.error Orsak Information om högskola kunde inte läsas Information om examen kunde inte läsas. Information om godkända kurser kunde inte läsas. Information om noter till godkända kurser kunde inte läsas Information om tillgodoräknade kurser kunde inte läsas Information om betygskalor kunde inte läsas Studenten är gallrad Studenten finns inte vid den här högskolan. Mottagaren har ingen tjänst (service) för den här typen av begäran (request). Högskolan är inte kontaktbar. Pingservern gick inte att kontakta Övrig information Notera att systempreferensen delas med Nouveau d.v.s. Rutin UT20 används även för denna tjänst.