Käsitteet

 

KäsiteSelite
PalveluPalvelu ovat joukko kiinteästi yhteenkuuluvia toimintoja ja ovat mahdollisimman autonomisia. Palvelut koostuvat moduulesta.
ModuuliJoukko yhteenkuuluvia toimintoja, mutta joita ei ole järkevää erottaa omiksi palveluiksi. Moduuli koostuu komponenteista.
KomponenttiPalvelualustaan tai käyttöliittymäkerrokseen asennettavia asennuspaketteja(jar tai war). Huomaa että komponentti käsite esiintyy myös http://wiki.osgi.org/wiki/Declarative_Services

Nimeäminen

Projektin nimi sisäisesti: studentregistry

Maven konfiguraatoissa käytettävä groupId: com.eduix.studentregistry

Pakkausten nimi: com.eduix.studentregistry.<moduulin nimi>

Domain pakkauksen nimi: com.eduix.studentregistry.<moduulin nimi>.domain

Service pakkauksen nimi: com.eduix.studentregistry.<moduulin nimi>.service

Katso myös tarkempi tekninen kuvaus rajapintojen toteutuksesta.

1. Henkilötietopalvelu

Henkilötietopalvelu koostuu kahdesta osasta, "matalan tason" identiteettipalvelusta ja opiskelijoiden henkilötietojen hallintapalvelusta.

1.1 Identiteetit

identity-registry-management

Palvelukerroksen komponentit: identity-registry-management-api, identity-registry-management-impl, identity-registry-management-client

 

RajapintaKäyttötapaus
IdentityRegistryService
  • A006C henkilön tiedot
  • A006E opiskelijoiden hakutoiminto
  • uuden henkilön luominen
IdentityRegistryServiceRestUlospäin näkyvä rest rajapinta IdentityRegistry-rajapinnasta

1.2 Opiskelijan henkilötiedot

student-registry-management

Palvelukerroksen komponentit: identity-registry-management-api, identity-registry-management-impl, identity-registry-management-client

 

RajapintaKäyttötapaus
StudentRegistryService 
StudentRegistryServiceRest 
StudentRegistryStudentServiceRestRajapinta jonka kautta opiskelija voi muokata henkilötietojaan (käytännössä vain osaa henkilötiedoistaan)

student-registry-student

Palvelukerroksen komponentit: identity-registry-student-impl, identity-registry-student-client

RajapintaKäyttötapaus
StudentRegistryServiceD005a, henkilö ylläpitää omia tietojaan järjestelmässä
StudentRegistryServiceRestUlospäin näkyvä rest rajapinta StudentRegistry-rajapinnasta

2. Opiskelijapalvelu

Opiskelijapalvelu on varsin suuri palvelu, joten se jakautuu pienempiin moduuleihin.

Tämä taso on kokoava, ja käsittää perusrekisterin keskeisimmät toiminnot.

2.1 Moduulit

study-management

Moduuli study-management käsittää ylläpidon puolen opiskelijapalveluiden rajapinnoista, nimenomaan opintoihin liittyvän osuuden. Näihin palveluihin ei ole suoraa pääsyä opiskelijapuolelta.

RajapintaKäyttötapaus
SemesterEnrollmentServiceLäsnäolojen/lukukausi-ilmoittautumisten hallinta
SemesterEnrollmentServiceRestYlläpitopuolen läsnäolojen hallinta
StudyAccomplishmentServiceOpintosuoritusten hallinta
StudyAccomplishmentServiceRest

Ylläpitopuolen opintosuoritusten hallinta

  • C001 opettaja arvioi opinnon
  • C005 opettaja ottaa opiskelijan suoritusotteen
StudyEnrollmentServiceYlläpidon
  • C003a opettaja hallitsee toteutukselle ilmoittautumisia
  • C003b opettaja poistaa opiskelijan toteutukselta
StudyEnrollmentServiceRest 

study-entitlement-management

Tämä moduuli käsittää opiskeluoikeuden hallinnan ylläpitäjän näkökulmasta.

RajapintaKäyttötapaus
StudentGroupServiceRyhmien hallinta
StudentGroupServiceRestRyhmien hallinnan REST-rajapinta
StudyEntitlementServiceOpiskeluoikeuksien hallinta
StudyEntitlementServiceRestOpiskeluoikeuksien hallinnan REST-rajapinta
StudyEntitlementStudentServiceRestOpiskelijan näkökulmasta tehty opiskeluoikeusrajapinta

study-student

Moduulin avulla julkaistaan opiskelijalle näkyvät toiminnot. Tämä mahdollistaa sen että moduuleja voidaan ajaa omalla palvelimella. Mikäli esimerkiksi integraatioihin tai henkilökunnan toimintoihin tehdään muutoksia, ne eivät näy opiskelijan palveluihin. Lisäksi jako parantaa tietoturvaa/tietosuojaa koska opiskelijalla ei ole mitään mahdollisuutta päästä käsiksi muihin rajapintoihin/toimintoihin.

Tämä moduuli keskittyy opintoihin.

RajapintaKäyttötapaus
SemesterEnrollmentStudentServiceRest
  • D001. opiskelija ilmoittautuu läsnäolevaksi
StudyAccomplishmentStudentServiceRest

Opiskelijan versio opintosuoritusten hallinnasta

  • D0004 Opiskelija selaa opintohistoriaansa, voi myös hakea eri ehdoilla
StudyEnrollmentStudentServiceRest
  • D002a, opiskelija ilmoittautuu toteutukselle
  • Opiskelija peruuttaa ilmoittautumisen

  • D002b Opiskelija ilmoittaa pienryhmätoiveen
  • D002c. tiedot ilmoittautumisen yhteydessä, mutta myös listaus omista ilmoittautumisista
  • D003 ilmoittautuminen tenttiin
  • listaus tenteistä, joiden toteutuksille opiskelija on ilmoittautunut
  • listaus toteutuksista ja tenteistä joille opiskelija on ilmoittautunut

study-entitlement-student

Tämä moduuli tarjoaa opiskelijaperspektiivin opinto-oikeuksiin.

RajapintaKäyttötapaus
StudyEntitlementStudentServiceRestOpiskelijan näkökulmasta tehty opiskeluoikeusrajapinta

3. Koodisto- ja konfiguraatiopalvelu

Palvelukerroksen komponentit: configuration-api, configuration-impl, configuration-client

RajapintaKäyttötapaus
ConfigurationCodes

B002, pääkäyttäjä hallinnoi koodistoja

B002h

ConfigurationCodesRestUlospäin näkyvä rest rajapinta ConfigurationCodes-rajapinnasta
CodeProviderKoodistojen apurajapinta, käytännössä Pepistä haetut koodistot tarjotaan "proxyttavan" providerin läpi; mahdollistaa muun koodistolähteen käyttämisen
SemesterProviderLukukausien apurajapinta, katso ylempi kommentti.

4. Raportointipavelu

Nimi: reporting-service

4.1 Moduulit

report

Palvelukerroksen komponentit: report-student-api, report-student-impl, report-student-client

RajapintaKäyttötapaus
ReportStudentOpiskelijan raportit
ReportStudentRest 

report-management

Palvelukerroksen komponentit: report-api, report-impl, report-client

RajapintaKäyttötapaus
Report

Opettajan raportit

ReportRest 
ReportTemplate

Raporttipohjien hallinta

ReportTemplateRest 

5. Lokipalvelu

Nimi: log

5.1 Moduulit

log

Palvelukerroksen komponentit: log-api, log-impl, log-client

RajapintaKäyttötapaus
Log
  • tapahtumien tallennus auditointia varten
  • integraatioajojen seuranta
LogRestREST-rajapinta lokien selaamista varten (ei itsessään lokien kirjoittamista, lokitus tapahtuu aina palvelukerroksessa)

 

  • käyttöliittymät lokien katseluun

5. Integraatio-palvelu

Nimi: integration-service

5.1 Moduulit

data-transfer

  • rajapinnat "karkea rakeisia"
  • Varsinaiset integraatio sijaitsevat muualla, eli integraatiomoduulin vastuulla huolehtia ettei tätä rajapintaa kuormiteta liikaa.

Palvelukerroksen komponentit: data-transfer-api, data-transfer-impl, data-transfer-client

RajapintaKäyttötapaus
DataTransferRest

virta-datan tuonti järjestelmään. Ei tarvetta sisäiselle rajapinnalle

väestörekisteri integraatio, henkilön tietojen päivitys väestörekisteristä

Hakijoiden tuonti KSHJ-palvelusta

6. Muut moduulit

data-import

Sisältö:

  • integraatio joka hakee virta-skeeman mukaiset viestit ja välittää ne data-transfer moduulin rajapinnoille. Käytetään vain kehityksen aikana sekä käyttöönotossa.

indexing-service

Palvelu joka keskustelee toisten palveluiden kanssa indeksoidakseen niiden dataa ElasticSearch-indeksiin. Indeksointi palvelee kehittyneitä hakutoimintoja, sekä mahdollisesti raportointitoimintoja.

permission-service

Palvelu johon tallennetaan

RajapintaKäyttötapaus
PermissionServiceKäyttöoikeuksien hallinta
PermissionServiceRest

Käyttöoikeuksien hallinnan käyttöliittymää palveleva REST-rajapinta

Voidaan käyttää myös käyttöoikeuksien tarkistamiseen, jotta käyttöliittymässä ei tarvitse näyttää linkkejä tai painikkeita toimintoihin joihin ei ole oikeuksia.

system-info

Diagnoositietoa järjestelmästä tarjoava palvelu.

RajapintaKäyttötapaus
SystemInfoTarjoaa moduulien versiotietoja, ei nimenomaista käyttötapausta
SystemInfoRestREST-rajapinta versiotiedoille
  • No labels
You must log in to comment.