KEPLIN Docs

Essentiële begrippen

De vijf begrippen die alles in Keplin dragen — apps, schermen, gegevensmodel, versies en publicatie — en de twee populaties gebruikers.

Voordat u ook maar één knop aanraakt, loont het om een handvol ideeën vast te leggen. Al het andere op het platform — elk menu, elk paneel, elke beslissing die u gaat nemen — rust op deze begrippen. Deze pagina definieert ze één keer, rustig; de volgende hoofdstukken gaan ervan uit dat u ze kent.

De werkruimte van de app Klantenbeheer: de boom van de app links en het tabblad Overzicht geopend rechts.
De werkruimte van de app Klantenbeheer: de boom van de app links en het tabblad Overzicht geopend rechts.

De app — de eenheid van alles

Een app is een complete, op zichzelf staande applicatie: haar schermen, gegevensmodel, API's, scripts, rapporten, instellingen en gebruikers leven samen en reizen samen. Elke app heeft:

Eigenschap Wat het is
Naam Hoe de app in de lijst en in de werkruimte verschijnt. Bijv.: Klantenbeheer.
Slug De korte vorm van de naam, automatisch afgeleid, die in de adressen terechtkomt. Bijv.: gestao-clientes.
Icoon Het symbool van de app in de zijbalk en in de lijst.
Beschrijving Een vrije zin, zichtbaar in de kop van de boom van de app.

Op zichzelf staan heeft twee praktische gevolgen:

  • Een app kan worden geëxporteerd als een .keplinapp-bestand en in een andere installatie worden geïmporteerd — ze neemt alles mee.
  • Een app verwijderen verwijdert haar wereld (ontwerp, gegevens, bestanden) zonder de andere apps of de externe databases waarmee ze verbonden was aan te raken.

Nota

De lijst met apps die u in de zijbalk ziet, is niet voor iedereen dezelfde: elk account ziet alleen de apps waartoe het toegang heeft. Daarbuiten verschijnt de app niet in de lijst en opent ze ook niet via een link.

Schermen — de pagina's van de applicatie

Een scherm is een pagina van de gebouwde app, ontworpen in een visuele editor: u sleept widgets (tabellen, formulieren, grafieken, kalenders, …) naar een canvas, koppelt ze aan gegevens en bepaalt wat er bij elke klik gebeurt. Elk scherm heeft een route — het pad in het adres van de app — en kan parameters ontvangen (bijvoorbeeld het nummer van de klant die op een fiche getoond moet worden).

Drie soorten scherm verdienen een eigen naam:

  • Gewone schermen — die u vrij aanmaakt en ordent in de boom.
  • Systeemschermen — die bestaan in elke app vanaf de eerste seconde: Login, Wachtwoord herstellen en Registratie. U bewerkt hun uiterlijk in dezelfde editor, maar de route en de toegang liggen vast.
  • Openbare schermen — geserveerd zonder aangemelde sessie, voor pagina's die iedereen mag zien. Zij kunnen alleen gegevens lezen van API's die als openbaar zijn gemarkeerd.

De lijm tussen schermen is de Navigatie: het menu van de app (bovenbalk of zijbalk), met items, submenu's en snelkoppelingen, ontworpen in zijn eigen editor.

Het gegevensmodel

Het gegevensmodel is de kaart van de entiteiten van de app — tabellen, velden, relaties en enums — gebouwd op de datasources (de databases waarmee de app verbinding maakt). U importeert de tabellen die ertoe doen naar het model, geeft ze weergavenamen, en vanaf dat moment spreekt de rest van het platform de taal van het model: de tabel-API's genereren er complete bewerkingen uit, de schermen kiezen velden op hun weergavenaam, de enums voeden de keuzelijsten.

Het essentiële punt: het model beschrijft, het dupliceert niet. De gegevens blijven in de databases wonen; het model is de laag die ze bruikbaar maakt voor de schermen en de API's zonder dezelfde logica twee keer te schrijven.

Versies — werken zonder angst

Elke app heeft versies, en de eerste heet altijd main. Een versie is een volledige kopie van het ontwerp en van de gegevens van de app op dat moment — versie «2.0» aanmaken vanaf main geeft u een vertakking waarin u alles kunt veranderen zonder aan te raken wat in gebruik is.

Het menu Versies van de app: de markering op de werkversie, de andere versies en de acties per rij.
Het menu Versies van de app: de markering op de werkversie, de andere versies en de acties per rij.

Wat u moet onthouden:

  • De werkversie is van u. Iedereen kiest zelf in welke versie hij werkt; van versie wisselen verandert de versie van niemand anders.
  • Versies delen geen gegevens. Een nieuwe versie wordt geboren met de gegevens gekopieerd van de bron; vanaf dat moment gaat elke versie haar eigen weg.
  • Elke versie heeft geschiedenis. Alles wat u opslaat wordt vastgelegd, met twee manieren om terug te gaan: De app naar deze toestand terugzetten (alles keert terug naar één moment) en Deze wijziging terugdraaien (maakt één specifieke opslagactie ongedaan). Geen van beide herschrijft de geschiedenis — ongedaan maken is altijd een nieuwe stap in het register.
  • U kunt elementen tussen versies overbrengen — een afgewerkt scherm in «2.0» kan naar main worden gehaald zonder de rest mee te nemen.

Publicatie — welke versie elk adres serveert

Publiceren is geen knop van «online zetten» — het is een koppeling: elk adres (host) serveert ÉÉN versie van de app. In de sectie Publicatie van de instellingen van de app koppelt u een host (bijv.: crm.bedrijf.com) aan een versie; wie dat adres bezoekt, ziet die versie, en alleen die.

De sectie Publicatie, in Instellingen ▸ Algemeen — elke host serveert één versie van de app.
De sectie Publicatie, in Instellingen ▸ Algemeen — elke host serveert één versie van de app.

Zolang u geen enkele host publiceert, antwoordt de app toch — op het interne adres /app/<slug> (bijv.: /app/gestao-clientes), met de werkversie. Dat is de natuurlijke plek om tijdens het bouwen te experimenteren.

Dica

Dit model geeft u gratis omgevingen: main gepubliceerd op het productieadres, «2.0» op een testadres, en uw werkversie op /app/<slug> — drie publieken, drie versies, dezelfde app.

Twee populaties gebruikers

Er zijn twee manieren om in Keplin aanwezig te zijn, met gescheiden accounts en gescheiden deuren:

Wie bouwt Wie gebruikt
Komt binnen via De aanmeldpagina van het platform Het adres van de gepubliceerde app (of /app/<slug>)
Ziet De werkruimte: boom, editors, versies De schermen van de gebouwde app — en verder niets
Account beheerd in Gebruikers (globaal menu, beheerders) Gebruikers van de app, in de instellingen van elke app
Profielen admin (alles, in alle apps) en developer (alleen de toegewezen apps) Die u vastlegt in de Rechten van de app

Het systeemscherm Login van de gepubliceerde app Klantenbeheer — de voordeur van wie haar gebruikt.
Het systeemscherm Login van de gepubliceerde app Klantenbeheer — de voordeur van wie haar gebruikt.

De gebruikers van de app weten niet eens dat Keplin bestaat: het aanmelden, de registratie en het wachtwoordherstel die zij zien, zijn de systeemschermen van de app, met het thema en de taal van de app. Die scheiding komt overal terug — en daarom reizen de instellingen van elke app (thema, vertalingen, accounts, rechten) met haar mee wanneer u haar exporteert.

Nota

In deze documentatie verwijst «gebruiker» zonder verdere aanduiding naar wie bouwt. Wanneer we het hebben over wie de gebouwde app gebruikt, zeggen we altijd gebruikers van de app.