Virkailijan työpöytä

Virkailijan työpöytä ("virkailijan sähköinen työpöytä", "VST") on React/Scala-sovellus, jossa kentän virkailijat ja OPH:n työntekijät voivat katsella ja julkaista tiedotteita sekä tapahtumia.

Käyttöliittymän dokumentaatio löytyy docs-kansiosta.

Paikallinen kehitysympäristö

Vaatimukset

• Node.js & npm
• Scala sbt
• Git
• paikallinen konfiguraatiotiedosto common.properties

Asenna käyttöliittymän kehitystä varten selaimellesi React Developer Tools -lisäosa (esim. Chromelle).

Konfiguraatiotiedosto

Rakentaminen

Ensimmäisellä kerralla:

• npm install ja npm run build juuressa
• Tee common.properties.template -tiedoston pohjalta jonnekin tiedosto oph-properties/common.properties ja syötä sinne sopivat arvot. Tai voit kopioida tiedoston pohjaksi palvelinympäristön palvelimelta.

Jatkossa:

• Käynnistä fi.vm.sade.vst.Main -luokka, ja laita JVM:n ajoparametriksi VST:n oph-configuration sisältämän hakemisto käyttäjän kotihakemistoksi, esim -Duser.home=/home/thrantal/oph-confs/virkailijan-tyopoyta-hahtuva
• toisessa terminaalissa/välilehdellä npm run start-dev
• avaa selaimessa URL localhost:{määritelty portti}/virkailijan-tyopoyta

Käyttöliittymä rakennetaan target/scala-2.11/classes/ui-kansioon, jota Webpack vahtii. Muutokset ui-kansion tiedostoihin käynnistävät käyttöliittymän rakentamisen.

Ajettavan jarrin tuottaminen mvn clean install Frontin minifioitu versio `npm run dist'

Swagger-dokumentaatio osoitteessa http://localhost:8081/virkailijan-tyopoyta/swagger

Internet Explorer

Sovellus vaatii IE:llä toimiakseen fetch- ja Babel-polyfillit.

Luokalla, QA:lla ja tuotantoympäristöissä ne tulevat virkailijan raamien kautta, mutta paikallisesti IE:llä testatessa ne täytyy tuoda index.jsx:ään:

import 'whatwg-fetch'
import 'babel-polyfill'

Kyseistä muutosta ei saa viedä version hallintaan konfliktien välttämiseksi.

Sovelluksen komponentit

Authentication - Käyttäjän autentikointi ja käyttäjän perustietojen haku

Migration - Tietokantamigraatiot

Repository - Tietokantahaut

Routes - Reititys

Scheduler - Ajastetut tehtävät: Koostesähköpostien lähetys ja työpöytään liitettyjen käyttöoikeusryhmien päivitys

Server - Webbiserveri

Service - Palvelukerros: Käyttäjään, julkaisuihin ja sähköposteihin liittyvät operaatiot

Integraatiot ulkoisiin järjestelmiin

CAS

• Käyttäjän autentikointi ja autentikoidut kutsut muihin järjestelmiin

Käyttöoikeuspalvelu

• Autentikoidun käyttäjän tietojen haku
• Työpöytään liitettyjen käyttöoikeusryhmien haku
• Käyttäjän käyttöoikeusryhmien haku
• Käyttöoikeusryhmien jäsenten haku sähköpostin lähetystä varten

Oppijanumerorekisteri

• Käyttäjän kutsumanimen haku (tiedotteen laatijan nimikirjaimet)
• Käyttäjien yhteystietojen haku sähköposteihin

Viestinvälityspalvelu

• Sähköpostien lähetys