Zermelo

In GoBright View it's possible to retrieve information from Zermelo to show changes within the schedule. These changes are displayed and can be filtered according to your needs. There are a few requirements that need to be set up.

Requirements

  • The name of the organization within Zermelo
  • A Zermelo admin account
  • An Api token
  • One or more codes of the location(s)

Create the API token

The first thing we require is the name of the organization within Zermelo. This is the same name within the URL you use to login to Zermelo:

https://[Schoolname].zportal.nl

Login to Zermelo with an admin account and note down the Schoolname within the URL, we'll be needing that later. Follow these steps within Zermelo to create a new API token:

  • Create a new user 'GoBrightView' within Zermelo
  • This user needs to have read permissions on all schedules that are displayed within GoBright View
  • Go to Beheer > Admin-paneel > API Tokens
  • Create a new API token by pressing Toevoegen
  • Assign the token to the created user

Note down the API token.

Get the code from the location(s)

The Zermelo widget will only show information from one specific location. It's possible to add multiple widgets with different locations, but for each location, a code is required. This code can be found underneath locations within Zermelo or by following the steps below:

  • https://[Schoolname].zportal.nl/static/swagger/ 
  • Copy the created API token to the access_token field on the top right
  • Press the reload button
  • Scroll down to branches select it and press the try it out button
    mceclip0.png
  • When done correctly there should be a list with all the names of locations and their codes displayed below:
{ "response": { "status": 200, "message": "", "details": "", "eventId": 0, "startRow": 0, "endRow": 4, "totalRows": 4, "data": [ { "code": "a", "name": "Apeldoorn", "somCode": "01rl00" }, { "code": "u", "name": "Uddel", "somCode": "01rl02" },

Note down the fields next to code this is the information we'll need within the widget.

Within GoBright View

Fill in the Api Token, Schoolname, and location code in the Zermelo widget. This should display all the changes based on the current location.

mceclip1.png

Timetable

To show only the current changes we'll need to add in the times that the lessons take place. The time here represents the end time of the lessons. These times are mandatory for the widget to function correctly.

mceclip3.png 

Filter options

There are three fields that allow filtering options class, rooms, and teachers. To use these a single item can be entered to filter on that specific item. For example, if V5E is entered within the class field it will only show classes with V5E in the name. There are more advanced filtering options that we'll describe below:

mceclip2.png

^ = Starts with characters after this sign
$ = Ends with characters before this sign
| = Separation character between each item
(?!) = Everything which is not equal to these characters

Some examples to clarify these:

Filter Explanation
^r2 Filter on rooms that starts with ‘r2’ (this is case sensitive)
^r2|^r3 Filter on rooms that starts with ‘r2’ and ‘r3’
4A$ Filter on classes that ends with ‘4A’
a4b1|a4b2|a4b3 Filter on classes ‘a4b1’, ‘a4b2’ and ‘a4b3’
(?!a4b1) Filter on everything except class 'a4b1'
(?!a4b1)|(?!a4b2)|(?!a4b3) Filter on everything except classes ‘a4b1’, ‘a4b2’ and ‘a4b3’
^(?!a4b) Filter on everything except classes that starts with ‘a4b


Other options

There are a couple of other options that are used to sort the information by specific types or dates and/or change the order of the columns. Also, colors can be applied to the different types of rows and text.

0 out of 0 found this helpful