---
title: "JOHDANTO"
slug: "johdanto-21"
updated: 2024-02-15T09:16:36Z
published: 2024-02-15T09:16:36Z
canonical: "support.keypro.fi/johdanto-21"
excludeFromSearch: true
excludeFromExternalSearch: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.keypro.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# JOHDANTO

Tässä käyttöohjeessa kuvataan selainpohjaisen **KeyAqua**-ohjelmiston toiminnot. Ohjelmisto on tarkoitettu **vesi- ja viemäriverkon dokumentointiin ja hallintaan**. Ohjelmistolla ylläpidetään ajantasaista tietoa verkon kohteista, asiakkaista sekä kunnossapitotiedoista. Tuotettua verkkomallia voidaan hyödyntää verkon ylläpidossa, suunnittelussa ja saneerauksessa.

Käyttöohje etenee yleisten työkalujen ja painikkeiden esittelyn kautta yksittäisten lomakkeiden käytön ohjeistukseen. Lomakkeilla luodaan ja muutetaan verkon kohteiden tietoja kaikilla lomakkeilla yhtenäisesti toimivilla lomakepainikkeilla. Ennen yksittäisen lomakkeen ohjeistukseen tutustumista kannattaa lukea luku [LOMAKKEIDEN YLEISET TOIMINNOT](/docs/johdanto-21#_LOMAKKEIDEN_YLEISET_TOIMINNOT). Kyseisessä kappaleessa painikkeiden toiminta esitellään yksityiskohtaisesti. Painikkeiden oletetaan myöhemmin olevan käyttäjän hallussa lomakkeiden käytön ohjeistuksessa.

Käyttöohjeen luvussa [SISÄÄNKIRJAUTUMINEN JA OHJEET](/docs/johdanto-21#_SIS%C3%84%C3%84NKIRJAUTUMINEN_JA_OHJEET) kuvataan järjestelmään sisään ja ulos kirjautuminen, salasanan vaihto ja käyttöohjeen aktivoiminen istunnon aikana.

Luku [KARTTANÄKYMÄ](/docs/johdanto-21#_KARTTAN%C3%84KYM%C3%84) käsittelee **karttanäkymän perustoimintoihin** liittyviä työkaluja. Luvussa esitellään mm. taustakarttojen ja kohdetasojen valinta, koordinaattiosion käyttäminen, osoitteen hakeminen ja tulostustoiminnot.

Kaikille lomakkeille **yhteiset painikkeet ja toiminnallisuus** esitellään kohdassa [LOMAKKEIDEN YLEISET TOIMINNOT](/docs/johdanto-21#_LOMAKKEIDEN_YLEISET_TOIMINNOT). Luku on tarkoitettu käyttäjille, jotka eivät ole aiemmin käyttäneet Keypron selainohjelmistoja. Esitellyt työkalut liittyvät kohteiden ominaisuus- ja sijaintitietojen tarkasteluun ja päivittämiseen, ja ne ovat yhteneväisiä muiden Keypron selainohjelmistojen kanssa.

[PUTKITYÖKALUT](/docs/johdanto-21#_PUTKITY%C3%96KALUT) ja [VARUSTEET](/docs/johdanto-21#_VARUSTEET)-luvuissa käsitellään **putkityökalu- sekä viemäri- ja vesijohtovarustelomakkeiden** käyttöä. Käyttäjän oletetaan hallitsevan lomakepainikkeiden toiminnan. Lomakkeita käytetään yhtenevällä tavalla, joten käyttäjän ei välttämättä tarvitse tutustua jokaisen lomakkeen toimintaan erikseen. Muista lomakkeista poikkeavat toiminnot on kuitenkin esitelty lomakekohtaisesti.

Luvun [KUNNOSSAPITO- JA RAPORTOINTITYÖKALUT](/docs/johdanto-21#_KUNNOSSAPITO-_JA_RAPORTOINTITY%C3%96KALU) ohjeistus on tarkoitettu kaikille käyttäjille. Luvussa oletetaan käyttäjän hallitsevan lomakepainikkeiden toiminnan. Esiteltävät lomakkeet liittyvät laitteen kunnon ja vesijohtoverkon vuodon raportointiin sekä laatuvalituksiin. Lisäksi esitellään vuotoalueiden luonti.

Kappaleessa [ASIAKAS / KÄYTTÖPAIKKA](/docs/johdanto-21#_ASIAKAS_/_K%C3%84YTT%C3%96PAIKKA) esitellään Asiakas- ja Käyttöpaikka-lomakkeiden käyttö. Lukua suositellaan kaikille käyttäjille, sillä lomakkeissa on muista lomakkeista poikkeavia toimintoja. Luvussa käsitellään **asiakastietojen, sopimusten ja käyttöpaikkojen** ominaisuustietojen käsittely ja niiden liittäminen toisiinsa.

Käyttöohjeen kappaleet [KEYDH – KAUKOLÄMPÖVERKON TYÖKALUT](/docs/johdanto-21#_KEYDH_%E2%80%93_KAUKOL%C3%84MP%C3%96VERKON) ja [KEYGAS - KAASUVERKON TYÖKALUT](/docs/johdanto-21#_KEYGAS_-_KAASUVERKON) käsittelevät kaukolämpöverkon ja kaasuverkon kohteita. Käyttäjän oletetaan hallitsevan yleisten lomakepainikkeiden toiminnot. Muista lomakkeista poikkeavat toiminnot on esitelty lomakekohtaisesti.

[MUUT TYÖKALUT](/docs/johdanto-21#_MUUT_TY%C3%96KALUT) -kappaleessa tarkastellaan työkaluja, jotka liittyvät verkon **kohteiden tarkasteluun ja kunnossapitoon** sekä tehtyjen **kartoitusten hallintaan**. Lukuun sisältyy myös kappaleet tekstiviestipalvelusta ja häiriötiedottamisesta. Luku on tarkoitettu kaikille käyttäjille, vaikkakin osa toiminnoista on erikseen tilattavia.

Kappaleessa [ASIAKASTIETOJEN PÄIVITYSSIVUSTO (Erikseen tilattava toiminto)](/docs/johdanto-21#_ASIAKASTIETOJEN_P%C3%84IVITYSSIVUSTO_(Er) on esitelty sivuston toimintaa, jossa asiakkaat ja asukkaat itse päivittävät omia yhteystietojaan häiriöviestintää varten.

[SANASTO](/docs/johdanto-21#_SANASTO_1)-kappaleessa käydään läpi KeyAquassa esiintyvää sanastoa. Luku esittelee sananselityksiä, ja sieltä voikin tarkistaa, jos jonkin sanan merkitys on jäänyt epäselväksi.

## Ohjelmiston esittely

Ohjelmisto toimii Internet-selaimella eikä vaadi muita ohjelmistoasennuksia käyttäjän työasemalle tai mobiililaitteelle. Käsiteltävä verkkoaineisto sijaitsee **verkossa olevassa tietokannassa**, josta verkon tiedot selaimelle välitetään.

**KeyAqua-ohjelmisto on tarkoitettu:**

- Vesi- ja viemäriverkon komponenttien hallintaan ja dokumentointiin (sijainti- ja ominaisuustiedot).
- Verkon kohteiden välisten kytkentöjen dokumentointiin ja hallintaan.
- Työnkulun mukaiseen kohteiden vianhallintaan.
- Ennalta ehkäisevän kunnossapidon, dokumentoinnin, analysoinnin ja raportoinnin välineeksi.
- Asiakastiedottamisen välineeksi häiriötilanteissa.
- Työnohjauksen välineeksi.

Verkkoaineistoa käsitellään **erityyppisille verkon kohteille tarkoitetuilla lomakkeilla**. **Käyttöoikeuksista** riippuu, mitkä toiminnot ovat näkyvissä eli millaisia asioita käyttäjä voi tehdä. Jos esimerkiksi halutaan katsella palopostin tietoja, avataan Paloposti-lomake. Jos luodaan järjestelmään uusi viemäriputki, tehdään se Viemäriputki-lomakkeen kautta. Lomakkeilla siis tarkastellaan, luodaan ja päivitetään sekä ominaisuustietoa että sijaintitietoa.

Verkon kohteisiin voidaan liittää erilaista **kunto- ja ylläpitotietoa** (tapahtumia). Näitä ovat esimerkiksi **vuotoraportit**, **kuntotarkastusraportit** ja **laatuvalitukset**. Kun tapahtuma ja siihen liittyvä verkon kohde ovat linkitettyinä toisiinsa, voidaan tapahtumalomakkeen kautta tarkastella myös siihen liitettyä verkon kohdetta. Samoin voidaan verkon kohteesta tarkastella sen ominaisuustietojen lisäksi kohteeseen liittyviä tapahtumia.

Verkon kohteisiin liittyvän tiedon ylläpitoon tarkoitetut lomakkeet on jaoteltu **putkityökaluihin**, **viemärivarusteisiin** ja **vesijohtovarusteisiin**. Näiden lisäksi lomakkeita on erilaisten tapahtumien laatimista varten sekä käyttöpaikka- ja asiakastietojen ylläpitoa varten. Liitteessä 1 on esitetty lomakejaottelu yksityiskohtaisesti. Lisäksi liitteessä on esitetty minkä tyyppisiin verkon kohteisiin tapahtumat liittyvät.

## Käyttöliittymä

Käyttöliittymä voidaan jakaa eri osioihin. Näytön yläreunassa sijaitsee **työkalupalkki**, josta avataan kohteiden tarkasteluun ja muokkaamiseen käytettävät lomakkeet. Palkissa sijaitsee lisäksi muita työkaluja, joita käytetään esimerkiksi osoitehakuun ja kartoitustiedostojen lukuun.

![Kuva, joka sisältää kohteen kartta Kuvaus luotu automaattisesti](https://cdn.document360.io/672fb328-110d-4b2d-9d5f-f1e71883bb64/Images/Documentation/johdanto-image-32135f3u.png)

Käyttöliittymä koostuu työkalupalkista, karttanäkymästä ja koordinaattiosiosta. Suurimman osan näytöstä käsittää **karttanäkymä**, joka sisältää myös vapaasti liikuteltavan **Karttatyökalut**-palkin, jonka yhtenä osana on Aineisto-tasovalintatyökalu. **Karttatyökaluilla** voidaan esimerkiksi lähentää ja loitontaa karttanäkymää, mitata etäisyyksiä sekä tulostaa haluttu näkymä.

Näytön alaosassa on **koordinaattiosio**, joka näyttää koordinaattiarvoja. Koordinaattiosiossa voidaan määritellä kohteiden ns. Aktiivi Z-asetus, jolloin kohteet saavat tämän arvon oletuksena Z-koordinaatiksi. Koordinaattiosion avulla on myös mahdollista siirtyä haluttuun koordinaattipisteeseen koordinaatit syöttämällä. Alaosan **ohjepalkkiin** ilmestyvät myös **ohjeet** eri painikkeita ja työkaluja käytettäessä.

**Huomaa!** Jos käyttöliittymän reunuksessa esitetään erillinen huomioväri, et todennäköisesti käytä sovelluksen tuotantoversiota.

## Selain- ja laitteistovaatimukset

Käytät KeyAqua-sovellusta internetselaimessasi, joten minimi- ja suosituslaitteisto riippuvat vahvasti käyttämästäsi selaimesta:

1. **Selain:** Microsoft Edge tai Google Chrome viimeisimmät päivitykset varustettuina. Firefox on myös tuettuna, mutta vaatii mahdollisimman nopean prosessorin (i7, i9). Selaimessa pitää myös sallia evästeet.
2. **Käyttöjärjestelmä:** Selaimen vaatimusten mukainen. Keypro Oy testaa järjestelmän toimintoja Windows-pohjaisilla laitteilla. Linux Ubuntu 18 tai uudempaa suositellaan.
3. **Prosessori:** Vähintään Intel Core i3. Suositellaan Intel Core i5 tai i7 (tai jotain vastaavaa AMD:ltä).
4. **Näyttö:** Minimi 1366x768 pisteen resoluutio, suositus 1920x1080 pistettä
5. **Keskusmuisti:** Minimi 8 gigatavua, suositus 16 gigatavua huomioiden selaimen asettamat vaatimukset.

## Käyttäjäroolit

Käyttäjillä on järjestelmässä rooli, jolle määritellyistä **käyttöoikeuksista** riippuu, mitkä toiminnot ovat näkyvissä eli millaisia asioita käyttäjä voi ohjelmassa tehdä. **Katselija** voi tarkastella sekä kohteiden ominaisuus- että sijaintitietoja, muttei voi muuttaa tai lisätä kohteita järjestelmään. Kyseisiin toimintoihin tarkoitetut painikkeet eivät katselijalla ole edes näkyvillä. Jos käyttäjällä on **oikeus tehdä muutoksia** sijainti- tai ominaisuustietoihin, ovat kyseiset painikkeet näkyvillä. **Pääkäyttäjä** voi lisäksi esimerkiksi muuttaa oletusarvoja. Työkaluvalikoima toimintoineen muokkautuu määriteltyjen käyttäjäoikeuksien perusteella.

Järjestelmään on mahdollista määritellä myös ns. **aluekohtaisia käyttäjäoikeuksia**, jolloin käyttäjällä on oikeus nähdä ja käsitellä vain tietyn alueen sisällä olevia kohteita. Rajauksia voidaan tehdä myös esim. kohteiden omistajatiedon perusteella.