¶ Portaal
¶ Functionele inrichting
¶ Inleiding
Het JOIN Portaal maakt het mogelijk om diverse stakeholders via het Portaal informatie uit JOIN te laten halen en informatie in JOIN vast te leggen. Hiervoor wordt gebruik gemaakt van een 5-tal componenten.
- Connect configuratie
Inrichting van connect entiteiten. - JOIN configuratie
Inrichting van de portaalgebruikers, configuratie collecties, vertalingen. - Portaal applicatie configuratie
JSON Script dat de verbinding legt tussen de software en de (functionele) configuratie. - Portaal css
Visuele weergave Portaal. - Portaal software
Software componenten.
Schematische weergave werking Portaal
Functionaliteiten Portaal
Raadplegen van registraties in JOIN en downloaden bestanden.
Wijzigen van registraties in JOIN en uploaden bestanden.
Aanmaken van registraties in JOIN en uploaden bestanden.
Mogelijkheden om informatie tekstueel, bestanden of linkjes beschikbaar te stellen.
¶ Samenvatting
Het Portaal is een schil over JOIN heen. In het Portaal zelf wordt geen informatie opgeslagen.
Om het Portaal te laten werken zijn de volgende onderdelen in de Admin en JOIN noodzakelijk:
Connectsysteem
Connectentiteiten
Collectie met Portaalgebruikers
Documentcollectie met vertalingen
Dossiercollectie met portaaltabs
Dossiercollectie met portaalvelden
In de Portaaltab collectie worden de collecties geregistreerd die zichtbaar moeten worden op het Portaal.
In de Portaalvelden collectie worden de velden geregistreerd die in een collectie op het Portaal getoond moeten worden. De Portaalvelden registraties zijn altijd gekoppeld aan een Portaaltab.
Per Portaaltype is er een andere set van collecties die getoond kan worden. Een Portaalgebruiker is gekoppeld aan een Portaaltype. Het uitgangspunt is dat de Portaalgebruiker enkel registraties op het Portaal ziet waar de Portaalgebruiker aan gekoppeld is.
¶ Portaalgebruikers
Een Portaalgebruiker is in principe geen gebruiker van JOIN. Er is geen koppeling met de Active Directory. De inloggegevens worden in JOIN opgeslagen in een collectie. Wat eventueel kan is dat de collectie gevuld (kopieerslag) wordt vanuit de gebruikerstabel.
Omdat voor verschillende stakeholders verschillende informatie beschikbaar moet zijn en verschillende rechten kunnen hebben moet er voor elke soort stakeholder een Portaaltype gedefinieerd worden. Een Portaaltype bepaalt welke collecties zichtbaar zijn.
¶ Basis benodigdheden
¶ Connectsysteem
Voor elk portaaltype is er een connectsysteem nodig.
¶ Entiteitsdefinities
PortalUser
In deze entiteit wordt geregeld in welke collectie de Portaal gebruikers worden geregistreerd. Per portaaltype moet er een entiteit worden geconfigureerd.
Translations
In deze entiteit wordt de verwijzing naar de collectie met vertalingen, titels en omschrijvingen vastgelegd. Deze entiteit werkt voor alle portaaltypen en hoeft maar 1x geconfigureerd te worden.
Tabs (PortaalBoek)
Deze entiteit regelt de collecties en de eigenschappen van de collecties die gebruikt moeten worden op het Portaal. Deze entiteit werkt voor alle portaaltypen en hoeft maar 1x geconfigureerd te worden.
Velden (PortaalBoekVelden)
Deze entiteit regelt de velden en de eigenschappen van de velden die gebruikt moeten worden op het Portaal. Deze entiteit werkt voor alle portaaltypen en hoeft maar 1x geconfigureerd te worden.
¶ Collecties
Portaalgebruiker
Voor de Portaalgebruikers dient er een collectie actief te zijn, waarbij de entiteitvelden worden gebruikt in het profiel. Dit kan een adrescollectie of een custom item type zijn.
Portaalgebruikersnaam: Dit is de gebruikersnaam voor de portaalgebruiker. Dit kan een vrije tekst zijn of een e-mail adres.
Portaal toegang: Indien aangevinkt kan de portaalgebruiker inloggen in het portaal.
Portaaltype: Leesbare versie van de portaaltype code
Portaaltype code: Letters zonder “Portaal_”, dus “ST” voor Student en “IS” voor internationale medewerker.
PW: Wachtwoord veld met het gecodeerde wachtwoord. Zie paragraaf wachtwoord voor meer uitleg.
Portaaltaal: Nederlands of Engels. Met deze taal start het Portaal na inloggen.
Portaaltabs
Om de portaaltabs te configureren is er een dossiercollectie nodig. Deze dossiercollectie wordt gekoppeld aan de connect entiteit. De velden tbv de titels en de hulpteksten worden toegelicht in de paragraaf hulpteksten.
Connect systeem: Bij welk connectsysteem hoort deze tab. bv Portaal_ST
Connect naam: Naam van de connect entiteit
Connect type: Keuze uit DOCUMENT of FOLDER. Verschil zit in het wel of niet bestanden kunnen tonen/uploaden
Volgorde: Dit is de volgorde van de weergave van de tabs in het scherm op het Portaal van links naar rechts.
JOIN type: Keuze uit de verschillende itemtypes. Bv ADDRESS of STUDENT
Bestandskey: Code die gebruikt wordt om aan te geven of er een bestand ge-upload mag worden en zo ja, onder welke voorwaarden. Zie paragraaf bestanden.
Portaaltype: Code van het Portaaltype. bv “ST”
Itemkey: Item key van de collectie die moet worden weergegeven.
Documenten opslaan: in Connectnaam van de documentcollectie waarin een documentregistratie wordt gemaakt indien vanuit deze collectie op de knop “Document toevoegen” wordt geklikt.
Mag aanmaken: Indien aangevinkt mag de Portaalgebruiker een nieuwe registratie aanmaken.
Mag bijwerken: Indien aangevinkt mag de Portaalgebruiker een registratie bijwerken / aanpassen.
Mag verwijderen: Indien aangevinkt mag de Portaalgebruiker een registratie verwijderen.
Alles tonen: Indien aangevinkt worden alle registratie aan alle gebruikers getoond ongeacht of de portaalgebruiker gekoppeld is aan de registratie. Dit wordt gebruikt voor handleidingen of instructies.
Toon in gerelateerd: Indien aangevinkt worden de registraties getoond als gerelateerde (gekoppelde) items bij andere registraties op het Portaal. Bv een dossierregistratie toont gekoppelde documentregistraties.
Filter toegestaan: Indien aangevinkt wordt de filterbalk in de lijstweergave getoond.
Homepagina: Indien aangevinkt wordt de collectie als homepagina getoond en niet bij de bovenste tabs.
Verborgen in menu: Indien aangevinkt wordt de collectie niet getoond als tab. Dit wordt gebruikt als documentregistraties alleen getoond moeten worden als gerelateerde items.
Toon gerelateerde: Indien aangevinkt worden de gerelateerde items getoond. Bv een dossierregistratie toont gekoppelde documentregistraties.
Toon direct eerste regel: Indien aangevinkt wordt er 1 registratie (detailweergave) getoond en geen lijstweergave. Bv bij persoonlijke gegevens.
Zaakdocumenten: Indien de collectie een zaakdocumenten collectie betreft dient dat hier aangevinkt te worden. Deze vink zorgt ervoor dat de zaakdocumenten getoond worden.
PortaalVelden
Om de portaalvelden te configureren is er een dossiercollectie nodig. Deze dossiercollectie wordt gekoppeld aan de dossierregistratie van de Portaaltab. De velden tbv de titels en de hulpteksten worden toegelicht in de paragraaf hulpteksten.
PortaalTab: Koppeling met de dossierregistratie van de connect entiteit
Connect naam: Naam van het veld in de connect entiteit
JOIN naam: Veldnaam uit het profiel
Type: Keuze uit Bolean (vinkveld), DateTime (datum veld), Double numeriek (numeriek veld), Integer numeriek (numeriek veld), Large string (groot tekstveld dat met slepen groter of kleiner te maken is, String (normaal tekst veld)
Detail volgorde : Veld volgorde in het detailscherm. Indien leeg wordt het volgordeveld niet getoond in het detailscherm.
Lijst volgorde: Veld volgorde in de lijstweergave. Indien leeg wordt het veld niet getoond in de lijstweergave.
Lengte: Lengte van de inhoud het veld
Verplicht: Indien aangevinkt mag bij NIEUW of BEWERKEN van de registratie in het Portaal het veld niet leeg zijn.
Mag aanmaken: Indien aangevinkt wordt het veld getoond bij een nieuwe registratie.
Mag bewerken: Indien aangevinkt mag het veld aangepast worden bij het bijwerken / aanpassen van een registratie.
Formaat: Weergave / formaat van het veld. bv dd-MM-yyyy of “Ja”;;”Nee”
Breedte: Breedte van het veld in de lijstweergave.
Streep tussen velden: Keuze uit “a”= Streep na veld of “b” = streep voor veld.
Validatie: Code of regel tbv de validatie van het veld.
Validatie foutmelding: Code tbv de getoonde foutmelding van de validatie. De code verwijst naar de vertalingen. Bv “email_error”
Vertalingen
Om de vertalingen (translations) te configureren is er een documentcollectie nodig. De vertalingen staan ook in de portaal applicatie configuratie. Indien er in de documentcollectie een registratie is met dezelfde code wordt de portaal configuratie applicatie overruled door de documentregistratie. Tenzij de documentregistratie leeg is. In dat geval wordt de waarde in de portaal applicatie configuratie gebruikt.
¶ Hulpteksten
Tabs
De teksten zoals ingevuld in onderstaande velden gelden voor Nederlands (NL) en Engels (EN). In de tekstvelden kan html codering gebruikt worden om de toelichting leesbaarder te maken. Let op er is een restrictie van 250 karakters (incl html codering). Indien er meer toelichting noodzakelijk is dan de 250 karakters kan dit opgenomen worden in de portaal applicatie configuratie.
-
Naam
Titel zoals deze in het bovenste lint wordt weergegeven
-
Omschrijving
Toelichting die wordt weergegeven in het scherm overzichtsweergave.
-
Omschrijving lezen
Toelichting die wordt weergegeven in het scherm van de detailweergave. Let op in onderstaande schermprint is geen toelichtende tekst opgenomen.
-
Omschrijving bewerken
Toelichting die wordt weergegeven nadat op de knop BEWERKEN is geklikt. Let op in onderstaande schermprint is geen toelichtende tekst opgenomen.
-
Beschrijving aanmaken
Toelichting die wordt weergegeven nadat op de knop NIEUW is geklikt.
