Yleiskuvaus
Osoitepalvelu on tarkoitettu OPH:n virkailijoille. Palvelussa on käyttöliittymä, jonka avulla työntekijä voi hakea yhteystietoja eri hakukriteereillä ja tarvittaessa lähettää haetulle joukolle massasähköpostin.
Virkailija tarvitsee tunnukset Opintopolkuun ja seuraavat käyttöoikeudet: Osoitepalvelu ja Viestinvälityspalvelu - raportointi
Osoitepalvelu hakee tietoja seuraavista palveluista:
- Organisaatiopalvelusta
- koulutustoimijat
- oppilaitokset
- varhaiskasvatuksen toimija (ei perhepäivähoitajia tai ryhmäperhepäivähoitajia)
- varhaiskasvatuksen toimipaikat (ei perhepäivähoitajia tai ryhmäperhepäivähoitajia)
- organisaatioiden tunnistetiedot (OID, oppilaitostunnus ja Y-tunnus)
- sijaintikunta
- koulutustoimijan yritysmuoto
- Organisaatiotietojen hakuehdot
- organisaatiotyyppi, oppilaitostyypit, organisaation kieli, vuosiluokat (perusopetus), koulutuksen järjestäjät joilla on ammatillisen koulutuksen järjestämislupa
- rajausehtolistaukseen maakunnat ja kunnat
- Opetus- ja kulttuuri ministeriön Oiva palvelu
- koulutuksen järjestäjät joilla on ammatillisen koulutuksen järjestämislupa ja niiden yhteystiedot Organisaatiopalvelusta.
- Käyttäjähallintapalvelu
- Virkailijakäyttäjien yhteystiedot
- Käyttöoikeusryhmät rajausehtolistaukseen
- Integraatiot
- Opintopolun Viestintäpalveluun (massasähköpostin lähetys)
- OKMn Oiva-palveluun (ammatillisen koulutuksen järjestämisluvat)
- Käyttöoikeuspalveluun (virkailijat oppilaitoksissa)
- Koodistopalveluun (koodistot)
Hakuja varten tarvittavat rajapinnat on kuvattu Swaggerillä (ks. sivun alaosa).
Arkkitehtuuri
Osoitepalvelu koostuu kahdesta moduulista: käyttöliittymästä (osoitepalvelu-ui) ja palvelin-osasta (osoitekoostepalvelu).
Näiden lisäksi integraatiotesteille on oma Maven-moduulinsa (itest), jonka kääntö ja suoritus voidaan aktivoida erillään sovelluksen Bamboo-käännöstä. Osoitekoostepalvelu-moduulin yksikkötestit ja itest-moduuli käyttävät yhteistä test-common Maven-moduulia.
Sisäiset integraatiot
Järjestelmä hakee tietonsa Organisaatio-, Käyttäjähallinta-, ja Koodistopalveluista. Sähköpostiviestien lähettämistä varten käytetään Viestintäpalvelua
Audit-lokitus on toteutettu auditlogger-palvelua käyttäen.
Teknologiat
Osoitepalvelussa käytettävät kirjastot ja sovelluskehykset:
| Nimi | Kuvaus | Käyttö palvelussa | Linkki |
|---|---|---|---|
| Apache Camel | EIP | Organisaatio-, käyttäjäpalvelun, ja Koodistopalveluun kohdistuvien pyyntöjen reititys. | http://camel.apache.org/ |
| Jackson | Kirjasto JSON-muotoisen informaation käsittelyyn. | https://github.com/FasterXML/jackson/ | |
| Spring | Yleinen sovelluskehys Java-ohjelmien tekemiseen. | http://www.springsource.org/ | |
| AngularJS | AngularJS on Googlen ylläpitämä avoimen lähdekoodin JavaScript-viitekehys. | http://angularjs.org/ | |
| Ehcache | Ehcache on avoimen lähdekoodin cache-viitekehys, jolla pyritään muun muassa muistinvaraisten kätköjen avulla vähentämään tietojen hakuja ulkoisista palveluista | Hakutulosten lyhytaikainen väliaikaisvarasto, jolla mm. Excel-esitys voidaan ladata tehokkaasti hakulistauksen esittämisen jälkeen. | http://ehcache.org/ |
Rajapinnat
Swagger-dokumentaatio:
QA: https://virkailija.testiopintopolku.fi/osoitekoostepalvelu/swagger/
Tuotanto: https://virkailija.opintopolku.fi/osoitekoostepalvelu/swagger/
Lokit
Audit-lokimerkinnät: https://logcollection.prod.oph.ware.fi/#/dashboard/elasticsearch/Demo