Valppaan asennus- ja käyttöohje

Transkriptio

1 Versio Päiväys Muokkaaja Kuvaus Tuukka Laakso Korjattu versio 0.1 Antti Kettunen Alustava versio

2 Sisällysluettelo 1 Johdanto Valppaan asennus Valppaan kääntäminen Valmiiksi käännetty asennus Tietokannan konfigurointi JDBC Quartz Valppaan konfigurointi Valppaan Web-käyttöliittymän asennus Kääntäminen Asennus Valppaan käynnistys ja käyttö Valppaan hallintatyökalut Web käyttöliittymä Komentorivikäyttöliittymä

3 1 Johdanto Valpas ja siihen liitetyt hallintatyökalut muodostavat järjestelmän, jonka tarkoitus on ilmoitinlaitteiden tarkkailu TETRA-verkon yli. Valpas on oma palvelimensa ja se tarjoaa RMI-rajapinnat hallintatyökaluille. Hälyttimien tietojen ja tarkkailun tilan tallentamiseen Valpas käyttää tietokantaa. Valppaan ensisijainen hallintatyökalu on sen web-käyttöliittymä. Lisäksi Valpasta voidaan myös hallita käyttäen vastaavaa komentorivityökalua. Valppaan kokoonpano määritellään kokonaan asetustiedostoissa, joilla sen toimintaa voidaan muuttaa ja laajentaa tarvittaessa. Tässä dokumentissa on esitetty vain Valppaan käynnistäminen puuttumatta rakenteellisiin muutoksiin ja laajennettavuuteen. 3

4 2 Valppaan asennus 2.1 Valppaan kääntäminen Valppaan kääntäminen vaatii oikeat kehitysympäristön asetukset. JDK 5.0:n ja Apache Ant:n tulee olla oikein asennettu. Valppaan saa käännettyä valpas-moduulin juurihakemistosta komennolla: ant package-all Skripti kääntää Valppaan juurihakemiston alla olevaan deploy/valpas -hakemistoon, jonka sisältö vastaa valmiiksi käännettyä asennusta. 2.2 Valmiiksi käännetty asennus Pura valpas.zip -tiedoston sisältö sopivaan hakemistoon. Hakemistorakenteen tulisi näyttää seuraavalta: valpas - config konfiguraatiotiedostot - defs komponettien määritykset - lib kirjastot - plugin hakemisto plugin-komponentteja varten - valpas valpas.jar - quartz Quartzin tarvitsemat taulut 4

5 2.3 Tietokannan konfigurointi JDBC Valpas on testattu käyttäen PostgreSQL:n versiota ja konfigurointiohje olettaa, että käytössä on kyseinen kanta tai sen uudempi versio. Valpas toimii todennäköisesti ongelmitta myös muilla kannoilla, mutta tätä ei voida taata eikä tässä dokumentissa puututa niiden konfiguroimiseen. Valpas käyttää kannan saantiin JDBC:tä, jonka konfiguraatiot löytyvät hakemistosta config/jdbc.properties. JDBC:n ja käytettävän kannan dokumentaatiosta löytyy tarkempia ohjeita, mutta esimerkkinä PostgreSQL-konfiguraatio, joka käyttää osoitteessa localhost:5432 olevaa valpas-test -nimistä kantaa. jdbc.driverclassname org.postgresql.driver jdbc.url jdbc:postgresql://localhost:5432/valpas-test jdbc.username valpas-test jdbc.password valpast Quartz Lisäksi Valpas tarvitsee kantaan määritykset Quartz-skedulointikomponentille. Valppaan mukana tulee SQL-skripti, joka on PostgreSQL 7.x kanssa yhteensopiva. Quartzin omilta sivuilta ( löytyy SQL-skriptit taulujen alustamiseen PostgreSQL:n uudemmille versioille sekä muille kannoille. Skriptin voi ajaa esim. käyttäen komentoriviltä psql-työkalua. Skripti löytyy hakemistosta deploy/quartz. Valpas alustaa muut taulunsa automaattisesti. 5

6 2.4 Valppaan konfigurointi Valppaan konfigurointiin käytetään config -hakemiston alla olevia properties -tiedostoja. Näistä lähinnä config.properties:ssa oleviin asetuksiin tarvitsee koskea tavallisessa käytössä. Valpas tarvitsee viestien välitykseen EPA-järjestelmää, joka tarjoaa Web Service rajapinnat viestien välitykseen TETRA-verkossa. Valppaalla on oma numeronsa TETRA-verkossa samoin kuin muilla verkon päätelaitteilla. Lisäksi Valpas tarvitsee tunnukset EPA:n käyttämiseen. EPA tarjoaa kaksi Web Service rajapintaa, jotka molemmat tarvitaan viestien välitykseen. Rajapinnoille täytyy määrittää osoitteet ja nimiavaruudet. Esimerkkinä tavallinen konfiguraatio: # Aika, jossa EPA:lta täytyy tulla välitystiedot lähetettyyn viestiin, jotta # voidaan todeta linjan olevan kunnossa. linecheckacktime # Osoite johon Valppaalle lähetetyt viesti saapuvat. valpasaddress # Aikaväli, jolla Valpas noutaa sille lähetettyjä viestejä EPA:lta. messagereceiveinterval 1000 # EPA:n käyttäjätunnus ipsubscriberidentifier inda5 # EPA:n salasana epapassword inda5pwd # EPA:n tarvitsemat WS- osoitteet ja nimiavaruudet epasessionurl epadataurl epasessionnamespace epadatanamespace 6

7 3 Valppaan Web-käyttöliittymän asennus 3.1 Kääntäminen Käyttöliittymän kääntäminen vaatii oikeat kehitysympäristön asetukset. JDK 5.0:n ja Apache Ant:n tulee olla oikein asennettu. Käyttöliittymän saa käännettyä valpas-ui -moduulin juurihakemistosta komennolla: ant package-all Web-sovellus löytyy kääntämisen jälkeen deploy -hakemistosta. 3.2 Asennus Sovellus on pakattu tavalliseen war-pakettiin, joka täytyy ladata johonkin sovelluspalvelimeen. Esimerkiksi Tomcatiin sovelluksen saa asennettua sijoittamalla war-paketin hakemiston webapps alle ja käynnistämällä palvelimen. Sovelluspalvelimien oletusasennus toimii yleensä osoitteessa ja Valppaan web-käyttöliittymä löytyy tällöin osoitteesta Sovelluspalvelimien omissa dokumentaatioissa on tarkempaa tietoa palvelinkohtaisista asetuksista. 7

8 4 Valppaan käynnistys ja käyttö Valpas käynnistyy komentoriviltä seuraavilla komennolla: start_valpas.sh (Unix) start_valpas.bat (Windows) Windowsissa käynnistysskripti toimii myös normaalisti esim. resurssienhallinnan kautta. Jos EPA ei ole suoraan saatavilla vaan tarvitaan välityspalvelinta voi käynnistysskripteille antaa parametrina välityspalvelimen osoitteen ja portin. Esim. Windowsissa komennolla: start_valpas.bat proxyhost=localhost proxyport=8081 Jos asetukset ovat kunnossa, niin Valppaan konsolin tulosteen tulisi näyttää seuraavalta: Using proxy host: Using proxy port: 8082 Initializing Valpas.. Init succeeded. Valpas up and running. Press enter to exit.. Esimerkissä on käytetty välityspalvelinta. Valppaan palvelinprosessi ei itsessään tarjoa mitään käyttöliittymää Valppaan toiminnan ohjaamiseen vaan tähän tarvitaan jokin erillisistä työkaluista. Nämä työkalut on kuvattu seuraavassa kappaleessa 8

9 5 Valppaan hallintatyökalut 5.1 Web käyttöliittymä Web-käyttöliittymän mukana on online-ohje, jossa kerrotaan tarkemmin mitä käyttöliittymällä voi tehdä. Ohjeet löytyvät Web-käyttöliittymästä ohje-linkin takaa. 5.2 Komentorivikäyttöliittymä Komentorivikäyttöliittymä on tarkoitettu lähinnä testaamiseen ja se tarjoaa hieman laajemman toiminnallisuuden kuin web-käyttöliittymä. Komentorivikäyttöliittymän saa käynnistettyä Valppaan asennushakemistosta ajamalla skriptin admin.sh admin.bat (Unix) (Windows) Komentorivikäyttöliittymä toimii komentopohjaisesti ja myös sen mukana tulee suppeat online-ohjeet mahdollisista toiminnoista. Käynnistyttyään onnistuneesti komentorivikäyttöliittymän tuloste näyttää seuraavalta: Input command, type "help" for help. 9