Tjänstespecifikation T04

Transkript

1 Tjänstespecifikation T04 Skriv ut Adresslista, lista Ladok på webb Version: Beteckning: LPW Ändringshistorik Revision Datum Av Kommentar Granskare Godkännare Jnbm Första utkast Lhn Uppdaterad inför leverans Lhn Kompletterad inför leverans Lhn Rättat flödesbeskrivning

2 Lhn Mindre justeringar Lhn Lagt till information om vilka tabeller utsökningarna grundar sig på Tehn Ändrat felmeddelandehanteringen från ErrorObject till Message Tehn Uppdaterat tjänstespecifika meddelanden Anders Bergström LPWSD-565 Lagt till kurstillfällen för kurser inom program med terminsregistrering. - -

3 Johan Bergström LPW (17) Innehållsförteckning 0 INLEDNING SYFTE MÅLGRUPP DELFUNKTIONER Flödesbeskrivning TABELLER VISA KURSER (FÖR ANGIVEN INSTITUTION OCH TERMIN) BESKRIVNING KRAVLISTA EXPONERADE METODER INDATA Kontroller UTDATA Tjänstespecifika felmeddelanden VISA KURSTILLFÄLLEN FÖR ANGIVEN KURSKOD OCH TERMIN BESKRIVNING KRAVLISTA EXPONERADE METODER INDATA Kontroller UTDATA Tjänstespecifika felmeddelanden SÖK REGISTRERADE DELTAGARE PÅ KURS BESKRIVNING KRAVLISTA EXPONERADE METODER INDATA Kontroller UTDATA Tjänstespecifika felmeddelanden... 17

4 Johan Bergström LPW (17) 1 Inledning 1.1 Syfte Tjänsten syftar till att ta fram uppgifter, t ex Namn, Adress, E-postadress för deltagarna i en kurs. Målgruppen för tjänsten är Institutionspersonal och Lärare. Tjänsten motsvarar användningsfall Ta ut namn/adresslistor/e-postadresser (lista/fil) över deltagare i kurser och Skicka e-post till grupp studenter. 1.2 Målgrupp Målgruppen för dokumentet är Utvecklare av tjänster som skall använda sig av LPW samt Driftcentraler. De värdeobjekt som refereras till finns mer detaljerat beskrivna i javadoc. 1.3 Delfunktioner Tjänsten består av följande deltjänster: Krav Nr Beskrivning Målgrupp Prio 1. Visa kurser Lärare/institutionspersonal 0 2. Visa kurstillfällen Lärare/institutionspersonal 0 3. Söka deltagare på kurs Lärare/institutionspersonal 0 Huvudtjänsten tar fram registrerade studenter enligt angivna begränsningar och presenterar deras personuppgifter. Hjälptjänster (som portalen kan välja att koppla till tjänsten) tar i flera försteg fram kurstillfällen för en viss kurs och en viss termin. Uppgifterna om kurstillfället/kurstillfällena används sedan av systemet som begränsning för att söka fram registrerade personer. Portalen kan även hoppa över förstegen och låta användaren direkt ange indata, kurskod och termin är dock obligatoriska uppgifter. Det finns inga möjligheter att söka på anmälningskod och starttermin. Funktionen fungerar även som underlag för att generera e-postlistan Flödesbeskrivning Exempel på hur flödet kan se ut i funktionen: 1. Användaren anger institution och termin. 2. Portalen skickar in institutionskod och termin i systemet. 3. Systemet tar fram alla kurser som ges på institutionen denna termin. 4. Portalen presenterar en kurslista (och termin).

5 Johan Bergström LPW (17) 5. Användaren väljer en kurs i listan. 6. Portalen skickar in uppgifter om aktuell kurskod och termin. 7. Systemet söker fram kurstillfällena som finns för denna kurskod och skickar ut uppgifterna. 8. Portalen presenterar kurstillfällena i en lista. 9. Användaren väljer ett (eller flera) av kurstillfällena i listan. 10. Portalen skickar in sökinformationen till systemet (uppgifter om kurstillfällena och ifall omregistrerade ska sökas ut). 11. Systemet söker fram registrerade personer enligt gjorda begränsningar. Med hjälp av framsökt personnummerlista tar systemet vidare fram personuppgifter om de aktuella studenterna. 12. Portalen tar emot uppgifterna och presenterar dem. Här kan tänkas att portalen väljer att visa uppgifter beroende på val som användaren gjort i gränsytan (t ex med kryssrutor). Alternativt flöde: 5. Användaren börjar med att ange termin och kurskod. Flödet fortsätter fr o m punkt 6. Alternativt flöde 9. Användaren anger begränsningar för framsökningen av registrerade studenter, dock minst kurskod och termin. Flödet fortsätter fr o m punkt Tabeller Se dokumentet Tabellsäkerhet.

6 Johan Bergström LPW (17) 2 Visa kurser (för angiven institution och termin) 2.1 Beskrivning Delfunktionen skall ses som en stödtjänst för att sedermera underlätta utsökning av adresslista. Möjliga begränsningar för utsökningen är institution (obligatorisk) och termin (kontrolleras om det finns kurstillfällen aktuell termin). Kurser hämtas från tabellen KURS. Begränsning på institution sker genom att kontrollera kolumnen INST i tabellen KURS. Begränsning på termin innebär att systemet kontrollerar om kursen/kurstillfället ges på terminen. Kontroll i KTILL2 (ffg-kurstillfälle), KTFORT2 (fo-kurstillfälle), PROGPLK (kursplaner, terminsregistreringskurser) och KTILLP (forsättningsterminer, terminsregistreringskurser). Finns ingen post i någon av dessa tabeller sorteras kursen bort. 2.2 Kravlista Krav Nr Beskrivning Tabell Prio 1. Visa kurser (för angiven institution och termin) 2.3 Exponerade metoder KURS KTILL2 KTFORT2 KTILLP PROGPLK Den metod som används för att hämta kurser är getkurs(uservo uvo,adrlistvo avo) 2.4 Indata Värdeobjekt Data Format Kontroll Kommentar UserVO 0 Se dokumentet Generell indata AdrListVO[] Institution C(4) 1, 2 Termin C(3) 1

7 Johan Bergström LPW (17) Kontroller 1. Formatkontroller av institutionskod och termin 2. Obligatorisk uppgift 2.5 Utdata Värdeobjekt Data Format Kontroll Kommentar AdrListVO KursInfoVO KursInfo VO[] En lista med kurser valid Boolsk Om denna är falsk finns det felmeddelanden i messages messages Message[ ] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc KursInfoVO[] Kurskod C(6) Benämning C(58) Eng Benämning C(58) Institution C(4) Poäng C(6) Nedlagd C(1) Tjänstespecifika felmeddelanden Tjänsten saknar tjänstespecifika meddelanden men generella felmeddelanden förekommer från validering och authenticering. Se Message.doc för att information om de generella felmeddelandena.

8 Johan Bergström LPW (17) 3 Visa kurstillfällen för angiven kurskod och termin 3.1 Beskrivning Delfunktionen returnerar kurstillfällen för angiven kurskod och termin, resultatet ligger till grund för att hämta information om adresslista för ett eller flera kurstillfällen. Kurskod och termin är obligatoriska begränsningar för sökning. Kurstillfällena hämtas från KTILL2 (ffg) och KTFORT2 (fo). Klartext för orten hämtas från ORT. Kurstillfällen för kurser inom program med terminsregistrering hämtas från KTILLP och PROGPLK. 3.2 Kravlista Krav Nr Beskrivning Tabell Prio 1. Visa kurstillfällen för angiven kurskod och termin KTILL2 KTFORT2 ORT Exponerade metoder Den metod som används för att hämta kurstillfällen är getkurstf(uservo uvo,adrlistvo avo). 3.4 Indata Värdeobjekt Data Format Kontroll Kommentar UserVO uvo Se dokumentet Generell indata AdrListVO Kurskod C(6) 1, 2 Termin C(3) 1, Kontroller 1. Formatkontroll av kurskod och termin 2. Obligatorisk uppgift

9 Johan Bergström LPW (17) 3.5 Utdata Om KursInfoVO i indata är null så returneras information om kursen som angetts. Om KursInfoVO är skild från null så returneras det som skickats in. Värdeobjekt Data Format Kontroll Kommentar AdrListVO KursTfVO KursTfV O[] KursInfoVO valid messages KursInfo VO[] Message[ ] - Innehåller en lista med kurstillfällen - Innehåller information om kursen Om denna är falsk finns det felmeddelanden i messages Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc KursTfVO[] KursTFtyp C(4) FFG/FOR T Kurskod C(6) - Starttermin C(3) Kurstakt C(3) - Kurstid C(3) - Undform C(3) - Kursomgång C(1) - - Visar om kurstillfället är för förstagångsregistrerade eller fortsättningsregistrerade - Kurstyp C(3) - Om kurstyp saknas innehåller denna parameter _ Termordning C(2) - Poäng C(5) - Anmkod C(5) - Kalendertermin C(3) Startvecka C(6) - -

10 Johan Bergström LPW (17) Slutvecka C(6) - Ortskod C(5) - Ortsbenamn C(20) - KursTFTermreg VO[] typ C(4) FFG/FOR T Kurskod C(6) - Starttermin C(3) program C(5) - programinriktn ing termordninngk urs - Visar om kurstillfället är för förstagångsregistrerade eller fortsättningsregistrerade - C(4) - C(2) - Poang C(5) - Kalendertermin C(3) - KursInfoVO[] Kurskod C(6) Benämning C(58) Eng Benämning C(58) Institution C(4) Poäng C(6) Nedlagd C(1) Tjänstespecifika felmeddelanden Tjänsten saknar tjänstespecifika meddelanden men generella felmeddelanden förekommer från validering och authenticering. Se Message.doc för att information om de generella felmeddelandena.

11 Johan Bergström LPW (17) 4 Sök registrerade deltagare på kurs 4.1 Beskrivning Detta är slutsteget i adresslistan. Returnerar en mängd med personvärdeobjekt. Möjlighet finns även, genom att specificera det i anropet, att få ut listan. För detta ändamål finns två parametrar, List och No List, i formatet string array. I dessa returneras hittade e- postadresser samt de personer som inte finns med i e-postlistan. Det finns två olika sätt att söka efter deltagare: med hjälp av ett eller flera kurstillfällen eller fri sökning. Söka med hjälp av kurstillfällen: Systemet söker ut de studenter som deltar i kurstillfällena som skickas in till tjänsten. Om typ är FFG söker systemet efter förstagångsregistrerade i FFGKURS, om typ är FO söker systemet efter fortsättningsregistrerade i FORTKURS. Varje kurstillfälle i indatan innebär en ny sökning i databasen. Om exempelvis två FFG-kurstillfällen utgör indata kommer systemet att göra två sökningar i FFGKURS. Eventuella dubletter sorteras bort. Detta är den enda typen av sökning som kan göras för kurstillfällen på kurser på program med terminsregistrering. Systemet hämtar alla omregisteringar på kursen i OMKURS om så önskas. Fri sökning Portalen anger vilka registreringstyper som systemet ska söka efter: FFG, FO och/eller OM. Sökningen kan begränsas på kurstakt, kurstid, undform, ort, omgång, terminsordning och finansieringsform (kurstyp). Kurskod och termin måste alltid anges. Systemet gör en sökning i FFGKURS, FORTKURS och/eller OMKURS. OBS! Ibland saknas koppling mellan finansieringsform (kurstyp) angiven i kurstillfället (KTILL2/KTFORT2) och den finansieringsform som finns i registreringen (FFGKURS) (programmets finansieringsform som ligger sparad i registreringen istället.) Om finansieringsform är satt i indatan finns alltså en risk att systemet inte hittar studenter som faktiskt läser på kurstillfället. 4.2 Kravlista Krav Nr Beskrivning Tabell Prio 1. Sök deltagare på kurs FFGKURS FORTKURS OMKURS 0

12 Johan Bergström LPW (17) Krav Nr Beskrivning Tabell Prio 1.1 Begränsa på kurs (kurstakt, kurstid, undform, ort, kursomg, finform, termordn) FFGKURS FORTKURS 1.2 Begränsa på grupp i kurs Begränsa på program (program, inriktning, fart, undform, ort, finform, kull) 1.4 Begränsa på grupp i program Visa vilken typ av registrering personen har FFGKURS FORTKURS OMKURS 0 3. Visa namn NAMN 0 4. Visa adresser ADRESS 0 5. Visa telekomuppgifter TELEKOM 0 6. Visa e-postlista TELEKOM Visa personer som inte är upptagna i e-postlistan 1 Alla krav utom 1.2, 1.3 och 1.4 är utvecklade. 4.3 Exponerade metoder getadrlista(uservo uvo,adrlistvo avo) 4.4 Indata I sista steget utgörs indata av dels de boolska parametrarna , ffg, fo och om, dels av kurstillfällesvärdeobjektet KursTfVO. Anropet till tjänsten kan göras på två olika sätt.

13 Johan Bergström LPW (17) Antingen skickas en lista med kurstillfällesobjekt in till tjänsten (där parametern typ är satt i KursTfVO). Denna information hämtas i det tidigare försteget. I detta läge kan portalen/användaren även sätta parametrarna om (innebär att även omregistrerade söks ut) och (paketerad e-postlista) i AdrListVO. Om portalen inte vill söka m h a flera kurstillfällen räcker det om ett kurstillfällesobjekt skickas in till tjänsten. I KursTfVO sätts alla värden för utsökningen (ej typ!). I detta fall avgör de boolska parametrarna ffg, fo och om i AdrListVO vilka typer av registreringar som systemet ska söka efter. Även här kan paketerad e-postlista fås m h a parametern . Om KursInfoVO i indata är null så returneras information om kursen som angetts. Om KursInfoVO är skild från null så returneras det som skickats in. Värdeobjekt Data Format Kontroll Kommentar UserVO uvo Se dokumentet Generell indata AdrListVO KursTFVO[] - Innehåller listan med kurstillfällen Boolsk Om sätts till sann fyller tjänsten parametrarna list och no list FFG FO Boolsk Boolsk OM Boolsk Systemet söker efter omregistrerade om sann KursTfVO[] Typ C(3) FFG/FO Kurskod C(6) 1, 2 Starttermin C(3) Kurstakt C(3) 1 Kurstid C(3) 1 Undform C(3) 1 Kursomgång C(1) 1 1, 4 Visar om kurstillfället är för förstagångsregistrerade eller fortsättningsregistrerade 1, 3 Om typ är FFG måste startermin vara satt

14 Johan Bergström LPW (17) KursTFTermreg VO[] Kurstyp C(3) 1 Om denna är satt till _ innebär det att kurstyp ska saknas Termordning C(2) Kalendertermin C(3) Ortskod C(5) typ C(4) FFG/FOR T Kurskod C(6) 1,2 Starttermin C(3) program C(5) 1.2 programinriktn ing termordninngk urs 1, 3 Om typ är FO måste kalendertermin vara satt 1,2,4 Visar om kurstillfället är för förstagångsregistrerade eller fortsättningsregistrerade 1 C(4) 1,2 C(2) 1,2 Poang C(5) - Kalendertermin C(3) 1, Kontroller 1. Formatkontroll (om något angivits) 2. Obligatorisk uppgift 3. Startermin eller kalendertermin är obligatorisk uppgift 4. Obligatorisk uppgift om systemet ska söka m h a flera kurstillfällesvärdeobjekt

15 Johan Bergström LPW (17) 4.5 Utdata Värdeobjekt Data Format Kontroll Kommentar AdrListVO KursInfoVO[] - Innehåller information om kursen AdrListEntVO[ ] - Varje post visar person- och kontaktuppgifter om respektive student List String[] En e-postlista No List String[] En lista med de personer som inte finns i e-postlistan FFG FO OM Boolsk Boolsk Boolsk Boolsk valid Boolsk Om denna är falsk finns det felmeddelanden i messages messages Message[ ] Se tjänstespecifika felmeddelanden, samt dokumenten Generell indata och Message.doc AdrlistEntVO[] Regtyp C(3) FFG/FO/ OM PersonVO[] - Visar vilken typ av registrering personen i fråga har PersonVO[] Personnummer C(10) Efternamn Förnamn Datum ev gallring gjorts C(25) C(25) C(10) ÅÅ-MM- DD

16 Johan Bergström LPW (17) Folkbokföringsa dress (adrtyp 4) Gatadress c/o-adress Postnummer Ortnamn Landsnamn C(40) C(25) C(12) C(35) C(20) Tidsbegränsad adress (adrtyp 2) TGatadress Tc/o-adress TPostnummer TOrtnamn TLandsnamn Giltig fr o m Giltig t o m C(40) C(25) C(12) C(35) C(20) C(10) ÅÅÅÅ- MM-DD C(10) ÅÅÅÅ- MM-DD Telefonnummer KOMTYP= TEL E-postadress KOMTYP= SMS-nummer KOMTYP= SMS C(70) C(70) C(70) KursInfoVO[] Kurskod C(6) Benämning C(58) Eng Benämning C(58)

17 Johan Bergström LPW (17) Institution Poäng Nedlagd C(4) C(6) C(1) Tjänstespecifika felmeddelanden Tjänsten saknar tjänstespecifika meddelanden men generella felmeddelanden förekommer från validering och authenticering. Se Message.doc för att information om de generella felmeddelandena. Nivå Nyckel logmeddelande till portalutvecklarna INFO adresslista.containsinvalidssn Felaktigt personnummer, {0} Kommentar Studenter med felaktigt personnummer visas inte i listan, istället sätts INFO meddelande.