Yleiskuvaus
Osoitepalvelu on tarkoitettu OPH:n työntekijöille osoitetietojen hakemista varten. Palvelussa on käyttöliittymä, jonka avulla työntekijä voi hakea osoitetietoja eri hakukriteereillä. Hakukriteerit voi myös tallentaa haluamalleen nimelle myöhempää tarvetta varten.
Osoitepalvelu hakee tietoja seuraavista palveluista:
- Osoitepalvelun tekninen dokumentaatio
- Organisaatioiden (esim. koulutuksen järjestäjät, oppilaitokset, toimipisteet) yhteystiedot.
- Erityisesti huomioitavaa, varhaiskasvatuksen järjestäjien tiedot siirtyvät Organisaatiopalvelusta Vardaan. Vardasta siirtyy varhaiskasvatuksen toimipaikat Organisaatiopalveluun. Varhaiskasvatuksen järjestäjien ja toimipaikkojen tiedot ovat Osoitepalvelussa poimittavissa OPHn virkailijoille. Avoimen rajapinnan kautta tietoja ei ole mahdollista saada.
- Käyttäjähallintapalvelu
- Virkailijakäyttäjien yhteystiedot
- Käyttöoikeusryhmät rajausehtolistaukseen
- Koulutustarjontapalvelu
- Osoitteita voi hakea koulutustarjontaan tallennetun koulutuksen perusteella
- Osoitepalvelun tekninen dokumentaatio
- Rajausehtolistaukset: oppilaitostyypit, organisaation kielet, opetuskielet, vuosiluokat, koulutuksen järjestäjät
- Rajausehtolistaukseen koulutusalat, opintoalat, tutkintotyypit sekä näiden väliset suhteet
- Rajausehtolistaukseen maakunnat ja kunnat sekä näiden suhteet
- Osoitteisiin täydennettävät lokalisoidut postitoimipaikat postinumeron perusteella
Osoitepalvelu noutaa Organisaatiopalvelun (kello 03:00) tiedot kerran yössä omaan väliaikaismuistiinsa, jona toimii MongoDB-kanta. Koodistopalvelusta tiedot noudetaan tarvittaessa ja niitä säilytetään väliaikaismuistissa MongoDB-tietokannassa korkeintaan vuorokausi.
Hakuja varten tarvittavat rajapinnat on kuvattu Swaggerillä (ks. sivun alaosa).
Lisäksi sähköpostin lähetystä varten Osoitepalvelu on integroitu Viestintäpalveluun jolla voi lähettää massasähköpostia.
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-, Koulutustarjontapalvelusta ja Koodistopalveluista. Sähköpostiviestien lähettämistä varten käytetään Viestintäpalvelua
Audit-lokitus on toteutettu auditlogger-palvelua käyttäen.
Teknologiat
Osoitepalvelu käyttää MongoDB-kantaa tiedon tallennukseen ja sitä ajetaan Apache Tomcat -sovelluspalvelimella.
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/ | |
| MongoDB | NoSQL-tietokanta | Tallennettujen hakujen tallentaminen, Organisaatiotiopalvelun tietojen tallennus ja haku sekä Koodistopalvelun tietojen välikaisvarasto | http://www.mongodb.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