KEPLIN Docs

Keskeiset käsitteet

Viisi käsitettä, joiden varassa Keplinissä lepää kaikki — sovellukset, näytöt, tietomalli, versiot ja julkaisu — sekä kaksi eri käyttäjäväkeä.

Ennen kuin kosket yhteenkään painikkeeseen, kannattaa naulata puolisen tusinaa ajatusta. Kaikki muu alustalla — jokainen valikko, jokainen paneeli, jokainen päätös, jonka tulet tekemään — lepää näiden käsitteiden varassa. Tämä sivu määrittelee ne kerran, rauhassa; seuraavat luvut olettavat, että tunnet ne.

Asiakashallinta-sovelluksen työtila: sovelluksen puu vasemmalla ja Yleiskatsaus-välilehti auki oikealla.
Asiakashallinta-sovelluksen työtila: sovelluksen puu vasemmalla ja Yleiskatsaus-välilehti auki oikealla.

Sovellus — kaiken perusyksikkö

Sovellus on kokonainen ja itsenäinen ohjelmisto: sen näytöt, tietomalli, API:t, skriptit, raportit, asetukset ja käyttäjät elävät yhdessä ja matkustavat yhdessä. Jokaisella sovelluksella on:

Ominaisuus Mikä se on
Nimi Miten sovellus näkyy listassa ja työtilassa. Esim. Asiakashallinta.
Slug Nimen lyhyt muoto, joka johdetaan automaattisesti ja joka tulee osoitteisiin. Esim. gestao-clientes.
Kuvake Sovelluksen tunnus sivupalkissa ja listassa.
Kuvaus Vapaa lause, joka näkyy sovelluspuun ylätunnisteessa.

Itsenäisyydellä on kaksi käytännön seurausta:

  • Sovelluksen voi viedä .keplinapp-tiedostona ja tuoda toiseen asennukseen — se ottaa kaiken mukaansa.
  • Sovelluksen poistaminen poistaa sen koko maailman (suunnitelman, datan, tiedostot) koskematta muihin sovelluksiin tai niihin ulkoisiin tietokantoihin, joihin se oli yhteydessä.

Nota

Sivupalkissa näkyvä sovelluslista ei ole kaikilla sama: kukin tili näkee vain ne sovellukset, joihin sillä on pääsy. Muut sovellukset eivät näy listassa eivätkä aukea linkistä.

Näytöt — sovelluksen sivut

Näyttö on rakennetun sovelluksen sivu, joka suunnitellaan visuaalisessa editorissa: vedät widgetejä (tauluja, lomakkeita, kaavioita, kalentereita, …) canvasille, sidot ne dataan ja määrität, mitä kustakin napsautuksesta seuraa. Jokaisella näytöllä on reitti — polku sovelluksen osoitteessa — ja se voi ottaa vastaan parametreja (esimerkiksi asiakkaan numeron, joka tiedoissa näytetään).

Kolme näyttötyyppiä ansaitsee oman nimensä:

  • Tavalliset näytöt — ne, jotka luot ja järjestät vapaasti puuhun.
  • Järjestelmänäytöt — ne ovat jokaisessa sovelluksessa ensimmäisestä sekunnista lähtien: Login, Salasanan palautus ja Rekisteröityminen. Muokkaat niiden ulkoasua samassa editorissa, mutta reitti ja pääsy ovat kiinteitä.
  • Julkiset näytöt — tarjoillaan ilman kirjautumista, sivuille, jotka kuka tahansa saa nähdä. Ne pystyvät lukemaan dataa vain niistä API:sta, jotka on merkitty julkisiksi.

Näytöt liimaa yhteen Navigointi: sovelluksen valikko (ylä- tai sivupalkki), jossa on kohteita, alavalikoita ja pikakuvakkeita ja jolla on oma editorinsa.

Tietomalli

Tietomalli on kartta sovelluksen entiteeteistä — taulut, kentät, suhteet ja enumit — ja se rakentuu tietolähteiden päälle (ne ovat tietokannat, joihin sovellus on yhteydessä). Tuot malliin ne taulut, joilla on merkitystä, annat niille selkonimet, ja siitä eteenpäin alustan muut osat puhuvat mallin kieltä: taulu-API:t muodostavat siitä valmiit operaatiot, näytöt valitsevat kentät selkonimen perusteella ja enumit syöttävät valintalistoja.

Olennainen kohta: malli kuvaa, se ei kahdenna. Data elää edelleen tietokannoissa; malli on se kerros, joka tekee siitä näyttöjen ja API:en käytettävää ilman, että samaa logiikkaa kirjoitetaan kahdesti.

Versiot — työskentelyä ilman pelkoa

Jokaisella sovelluksella on versioita, ja ensimmäisen nimi on aina main. Versio on täydellinen kopio sovelluksen suunnitelmasta ja datasta sillä hetkellä — kun luot version ”2.0” mainista, saat haaran, jossa voit koskea kaikkeen koskematta siihen, mikä on käytössä.

Sovelluksen Versiot-valikko: merkki työversiossa, muut versiot ja kunkin rivin toiminnot.
Sovelluksen Versiot-valikko: merkki työversiossa, muut versiot ja kunkin rivin toiminnot.

Tästä kannattaa muistaa:

  • Työversio on sinun. Jokainen valitsee itse, missä versiossa työskentelee; version vaihtaminen ei muuta kenenkään muun versiota.
  • Versiot eivät jaa dataa. Uusi versio syntyy niin, että data kopioidaan lähteestä; siitä eteenpäin kumpikin elää omaa elämäänsä.
  • Jokaisella versiolla on historia. Kaikki tallennukset kirjataan, ja taaksepäin pääsee kahdella tavalla: Palauta sovellus tähän tilaan (palauttaa kaiken tiettyyn hetkeen) ja Peru tämä muutos (kumoaa yhden tietyn tallennuksen). Kumpikaan ei kirjoita historiaa uudelleen — kumoaminen on aina uusi askel kirjanpidossa.
  • Voit tuoda elementtejä versiosta toiseen — ”2.0”-versiossa valmiiksi saadun näytön voi tuoda mainiin ilman muuta ympäriltä.

Julkaisu — mikä versio palvelee mitäkin osoitetta

Julkaiseminen ei ole ”pistä ilmoille” -painike — se on liitos: kukin osoite (host) palvelee YHTÄ sovelluksen versiota. Sovelluksen asetusten osiossa Julkaisu liität hostin (esim. crm.yritys.fi) yhteen versioon; se, joka käy tuossa osoitteessa, näkee sen version eikä mitään muuta.

Julkaisu-osio kohdassa Asetukset ▸ Yleistä — kukin host palvelee yhtä sovelluksen versiota.
Julkaisu-osio kohdassa Asetukset ▸ Yleistä — kukin host palvelee yhtä sovelluksen versiota.

Niin kauan kuin et ole julkaissut yhtään hostia, sovellus vastaa silti — sisäisessä osoitteessa /app/<slug> (esim. /app/gestao-clientes), ja siellä on työversio. Se on luonteva paikka kokeilla rakentamisen aikana.

Dica

Tämä malli antaa sinulle ympäristöt ilmaiseksi: main julkaistuna tuotanto-osoitteeseen, ”2.0” testiosoitteeseen ja oma työversiosi osoitteessa /app/<slug> — kolme yleisöä, kolme versiota, sama sovellus.

Kaksi eri käyttäjäväkeä

Keplinissä voi olla kahdella tavalla, erillisillä tileillä ja erillisistä ovista:

Rakentaja Käyttäjä
Kirjautuu Alustan kirjautumissivun kautta Julkaistun sovelluksen osoitteesta (tai /app/<slug>)
Näkee Työtilan: puun, editorit, versiot Rakennetun sovelluksen näytöt — eikä mitään muuta
Tiliä hallitaan Kohdassa Käyttäjät (yleinen valikko, ylläpitäjät) Kohdassa Sovelluksen käyttäjät, kunkin sovelluksen asetuksissa
Roolit admin (kaikki, kaikissa sovelluksissa) ja developer (vain määritetyt sovellukset) Ne, jotka määrittelet sovelluksen kohdassa Käyttöoikeudet

Julkaistun Asiakashallinta-sovelluksen järjestelmänäyttö Login — sen käyttäjien ovi sisään.
Julkaistun Asiakashallinta-sovelluksen järjestelmänäyttö Login — sen käyttäjien ovi sisään.

Sovelluksen käyttäjät eivät edes tiedä, että Keplin on olemassa: kirjautuminen, rekisteröityminen ja salasanan palautus, jotka he näkevät, ovat sovelluksen järjestelmänäyttöjä, sovelluksen teemalla ja kielellä. Tämä jako toistuu kaikessa — ja juuri siksi kunkin sovelluksen asetukset (teema, käännökset, tilit, käyttöoikeudet) matkustavat sen mukana, kun viet sen ulos.

Nota

Tässä dokumentaatiossa ”käyttäjä” ilman tarkennusta tarkoittaa rakentajaa. Kun puhumme niistä, jotka käyttävät rakennettua sovellusta, sanomme aina sovelluksen käyttäjät.