Inleiding

TDM5 biedt de mogelijkheid om externe gegevensbronnen toe te voegen. Met deze gegevensbronnen biedt TDM5 de mogelijkheid om realtime-informatie in uw presentatie weer te geven. In deze handleiding wordt uitgelegd hoe u een Zermelo-gegevensbron kunt instellen.

Vereisten

Als u een Zermelo-gegevensbron wilt instellen, moet u aan de volgende vereisten voldoen:

- Beheerdersrechten hebben voor uw TDM5-omgeving

- De URL voor de Zermelo-API hebben. Dit is meestal iets zoals https://myschool.zportal.nl/api

- Een API-token van een Zermelo-partner met leestoegang tot de eindpunten appointments en branchesofschools (zie het hoofdstuk “De partner configureren in Zermelo”)

De partner configureren in Zermelo

TDM5 leest het rooster uit het Zermelo Portal via de Zermelo-API. Voordat de gegevensbron in TDM5 kan worden toegevoegd, moet de applicatiebeheerder van de school in het Zermelo Portal een partner voor TDM Signage aanmaken, een API-token voor deze partner genereren en de partner leestoegang geven tot de vereiste eindpunten. De onderstaande stappen volgen het Zermelo-supportartikel “Partners koppelen” (Beheer > Partners). Het Zermelo Portal is in het Nederlands; de namen van menu’s en knoppen worden daarom in het Nederlands weergegeven.

Opmerking: standaard heeft een nieuwe partner geen toegang tot enig veld.
Geef alleen toegang tot de velden die in dit hoofdstuk worden vermeld, zodat er geen leerlinggegevens of andere persoonsgegevens met de signage-schermen worden gedeeld.

Log in op het Zermelo Portal (https://<school>.zportal.nl) met een account met de rol applicatiebeheerder.
Maak de partner aan.
Ga naar Beheer > Partners > Partners en klik op Toevoegen.
Vul een naam in (bijvoorbeeld “TDM Signage”) en een opmerking waarin wordt beschreven waarvoor de verbinding wordt gebruikt (bijvoorbeeld “Roosterwijzigingen weergeven op de digitale signage-schermen”).

Selecteer de contactpersoon van de school, vul het e-mailadres van de partner in en selecteer eventueel de roosterprojecten waartoe de partner toegang mag hebben. Klik op 'Toevoegen'.
Maak het API-token aan. Ga naar Beheer > Partners > API-tokens en klik op Toevoegen.
Selecteer bij 'Gebruiker' de partner die in de vorige stap is aangemaakt, kies de maximale geldigheidsduur (wanneer het token verloopt, moet er een nieuw token worden aangemaakt en ingevoerd in TDM5), vul een opmerking in en klik op Toevoegen.
Er wordt nu een autorisatiecode weergegeven. Deze code wordt slechts één keer weergegeven, dus bewaar deze veilig. Deze code is het Token dat nodig is bij het toevoegen van de Zermelo-verbinding in TDM5 (stap 7 van het volgende hoofdstuk).
Geef toegang tot de eindpunten. Ga naar Beheer > Partners > Toegang en klik op Toevoegen. Selecteer de partner bij Partner en selecteer het Endpoint. Kies per veld Geen toegang of Lezen. Vink onder Extra filters de filters aan die de partner mag gebruiken. Klik op Toevoegen om op te slaan (of op Bijwerken wanneer u een bestaande toegang bewerkt).

Herhaal dit voor elk hieronder vermelde eindpunt. De kolom 'Filterbaar' is alleen informatief en kan niet worden gewijzigd.
Endpoint “appointments (Afspraakversies)” en vink ’Toon afgeraden Velden / extra filters’ aan.
Stel de volgende velden in op 'Lezen':
Branch
branchOfSchool
changeDescription
end
endTimeSlot
endTimeSlotName
groups, id
locations
remark
start
startTimeSlot
startTimeSlotName
subjects
teachers
valid

Laat alle andere velden op ‘Geen toegang’ staan. Vink onder Extra filters changed en modifiedSince aan (fields en schoolInSchoolYear zijn altijd toegestaan) en laat includeHidden uitgevinkt.

Zermelo toont de waarschuwing “De selectie bevat niet-ondersteunde toegang voor 2 velden”. Dit is verwacht: deze velden worden door TDM5 gebruikt, maar Zermelo garandeert hun stabiliteit niet. De onderstaande schermafbeeldingen tonen de volledige lijst met velden (van boven naar beneden gescrold).
Endpoint “branchesofschools (Vestigingen in project)”.
Stel de velden branch, id en schoolInSchoolYear in op 'Lezen'.
Onder Extra filters zijn de filtervelden standaard toegestaan.
De partner heeft nu alle rechten die TDM5 nodig heeft. Geef de Zermelo-URL (https://<school>.zportal.nl/api) en het token uit stap 4 door aan de persoon die TDM5 instelt en ga verder met het volgende hoofdstuk.

Een Zermelo-gegevensbron instellen

Log in op uw TDM5-omgeving met een beheerdersaccount.
Selecteer “Interactions”.
Selecteer de menuoptie “Data sources”
Selecteer ‘Zermelo’ en klik rechts op de knop “Create new” om een nieuwe gegevensbron aan te maken.
Vul een naam in voor uw Zermelo-gegevensbron en klik op “Add”.
Vouw op de nieuwe pagina het menu Connection uit. Als u al een Zermelo-verbinding hebt, selecteert u de verbinding door erop te klikken.
Vul vervolgens uw Zermelo-URL en uw Token in. Klik daarna op “Add” om de verbinding op te slaan.
Als de opgegeven gegevens correct zijn, wordt de verbinding nu toegevoegd en krijgt deze de status Valid.
Vouw vervolgens het instellingenmenu uit en selecteer de school en vestiging die u voor deze gegevensbron wilt gebruiken. U kunt voor elke school een nieuwe gegevensbron aanmaken, waarbij de hierboven gemaakte verbinding opnieuw kan worden gebruikt.

U kunt ook kiezen of u alle gewijzigde afspraken wilt zien, of alleen de afspraken die naar een nieuwe locatie zijn gewijzigd (dus geen annuleringen, enzovoort).
Klik ten slotte bovenaan op de knop “Save” om uw gegevensbron op te slaan.

U hebt nu succesvol een Zermelo-gegevensbron aangemaakt die in uw content kan worden gebruikt.
Als u uw Zermelo-gegevens op een pagina wilt weergeven, gaat u naar het menu Pages.
Maak vervolgens een nieuwe pagina aan door op de knop “Add new page” te klikken, een naam voor uw pagina in te voeren en ten slotte op “Add” te klikken.
Als u de tijd van de afspraken uit uw feed wilt toevoegen, selecteert u het datum- en tijdselement in de elementenlijst. Sleep vervolgens een vierkant op het canvas naar de plek waar u het element wilt plaatsen.
Selecteer vervolgens aan de rechterkant de vervolgkeuzelijst in het veld Data source, selecteer uw gegevensbron en selecteer de start- of eindtijd.
Als u een van de andere tekstvelden wilt toevoegen, selecteert u het Text-element in de elementenlijst en sleept u dit naar het canvas.
Selecteer vervolgens aan de rechterkant in de teksteigenschappen het vervolgkeuzemenu naast Content, selecteer uw gegevensbron en het veld dat u wilt toevoegen. Bijvoorbeeld Subject.
Het element toont nu de gegevens en het onderwerp van de eerste les in de lijst. Als u informatie voor de volgende records wilt weergeven, kunt u op dezelfde manier een ander element toevoegen en onder de geselecteerde gegevensbronwaarde een startrijnummer van 2 of hoger toevoegen.