Help Center
How can we help? 👋

Zermelo rooster app guide

Step-by-step guide on how to setup your Zermelo app

With the Zermelo rooster app you can automatically show the schedule of your school on your displays, including schedule changes.

What is Zermelo?

Zermelo is a Dutch company that provides schools with different software tools for organizing data, for instance schedule management.

Creating a Zermelo rooster app

  1. Go to ‘Apps > App store’ or ‘Content > New > App’ and search for the Zermelo rooster app;
  1. Click on the app to start creating a new app. You will see the following screen:
    1. Notion image
  1. Enter an app name, this can be anything you can recognize it by later;
  1. Enter your Zermelo details
    1. Zermelo endpoint: this is usually https://<schoolname>.zportal.nl. This is also where you manage Zermelo data.
    2. Zermelo API access token: within the Zermelo portal, you can create API tokens. An API token allows software to interact with other software. It allows Lumicast to keep your Zermelo data on the display synced.
    3. Roosterproject: after entering your endpoint and API access token, your rooster projects will appear in the options. Select the project you want to show.
  1. Finish the app by clicking ‘Create app

How to find out what my Zermelo endpoint is?

We recommend contacting one of the persons in your organisation who regularly works with Zermelo. They will know the URL they use to login, and this generally is the same endpoint you need to fill in here.

⚠️
Make sure to include https:// in the endpoint, otherwise the app won’t be able to load the data.

How to get a Zermelo API access token?

Zermelo has the official documentation of how to create an API access token with the correct rights. See the following:

Running the Zermelo app in a cluster of displays

The Zermelo app supports cluster mode. This allows you to distribute the scheduled appointments accross several displays, in order to show the schedule more clearly.

All configuration options

Setting
Explanation
Required
App name
A recognizable (descriptive) name for you, which will show in your content library.
Yes
Zermelo endpoint
The URL (including https://) where your Zermelo portal is hosted.
Yes
Zermelo API access token
An API token that you created within your Zermelo portal environment. Read the section above to find out how to get it.
Yes
Roosterproject
Choose the Zermelo roosterproject to show appointments and/or announcements from. Options will become available once you have configured the appropriate endpoint and access token.
Yes
Sorting
Decide how the lessons are sorted. Default sorting is by start time of the lesson. Alternative option is sorting by group name, so members of the group can easily see their upcoming lessons.
Yes
Only show changes
Select this field if you only want to show appointments that have changed. In Dutch: “Roosterwijzigingen”.
No
Seconds per page
If there are too many appointments to fit on a page, the app will cycle through the pages. How long should one page be on the display?
Yes
Start of appointment must be within x hours
If you want to limit the amount of appointments showing on your displays, you can tell the app to only show appointments that are within the next amount of hours.
Yes
Hide appointment after start
When the start time of the appointment has passed, hide the appointment. Enabled by default, because the assumption is that this information is no longer necessary.
No
Hide appointment x minutes after its start time
When you enabled the option to hide appointments after their start time, you can give an amount of minutes that the appointment will still be shown, e.g. in case people arrive late.
Yes
Excluded subjects
Filter out subjects that should not be showing, comma separated. Example: opv,vv,bi
No
Branches
If your roosterprojects contains multiple branches, this option allows you to further filter the data. Not sure what branches (vestigingscodes) are? Look below.
No
Enable cluster mode
If you have multiple displays next to eachother, you can show a different page on each display, so they are easy to read and all visible at once. Read about setting up clustermode.
No
Appointments per page
How many appointments are show on one page? This is especially useful when you enable cluster mode.
No
Cycle through pages on last display
If you enabled clustermode, this option becomes available. Imagine you have 5 displays for displaying Zermelo information. At one point, there could be 10 pages of information. If you enable this option, the last display will cycle through pages 5-10.
No
Total displays using the app
In clustermode, if you enable the last display to cycle between pages, this setting lets the app know which display is the last one.
No
Hide header
No
Layout
Choose between list or grid layout
Yes
Background color
Yes
Background image
No
Darken background image
Make background image darker, so text is more readable
Yes
Font size
Change the default font size so you can optimize the layout for your devices.
No
Table padding
Change the default padding (space around the text) of table cells so you can optimize the layout for your devices.
No
Show outdated data notice after X minutes
By default, after 5 minutes of no new data, the app will show a notice at the bottom of the screen saying the data might be outdated (could be due to no internet connection). This option allows you to change that time period.
No
Room (regex) filter
Only show certain rooms (”lokalen”) by using a regex filter
No

Advanced: display index option

The display index option can be used if you want to display multiple Zermelo apps on one display in clustermode. The reason for this is because one display can only have one display index. With this option, you can for instance create 3 duplicate Zermelo apps with just a different ‘display index’.

Advanced: Room (regex) filter

With this advanced option, you can filter the data so only certain rooms appear on your display. Some schools have 1 Zermelo roosterproject for multiple physical branches, but do not have this branch distinction in their Zermelo environment. This is a good usecase for this filter option. Let’s say you have two branches: ABC and DEF. Your rooms might look like: abc010, abc011 and def010, def011. If you want to show only one of these, simply add “abc” or “def” in this field to show them only. If you are having trouble to filter properly, please send an email to team@lumicast.com and we will try to help.

Branches (vestigingen) in Zermelo portal

With the branches option you can filter the data per branch. In your Zermelo portal (zportal), navigate to:

Notion image

You can find the branches as “Vestigingen” in Zermelo: Beheer > Portal-inrichting > Vestigingen. Then look at “Vestigingscode”.

 
Did this answer your question?
😞
😐
🤩