Description user functionalities iotroam
A user with IoT devices, for example a teacher, student or researcher, has the ability to use the self-service portal to:
- Personal IoT devices to add, modify and delete. These are personal devices, such as smartwatches. The administrator can also determine that users will not have this ability;
- Add, modify and delete IoT devices to a group, but only in groups for which the user has permissions. For example, a student can add a lab device for his/her practicum or a robot for the time period he/she will experiment with it;
- View all IoT devices and their details within the group(s) to which the user has permissions;
- If a user is assigned the role of group owner, they can invite others to join the group. The group owner can manage the users of the group and also make another user owner.
Login to the self-service portal
Go to https://www.iotroam.nl.
Click on 'Login'.
You will now be taken to the SURFconext login page for iotroam. Select your institution and log in with your institution account.
You are now logged in to the iotroam portal and will see the screen below.
On the left side at the top is Personal. Depending on your institution's policy, you can add a number of personal devices here. Below that are the groups to which you have been granted permissions. These permissions are set by your IT department.
By clicking on the arrow in the light blue bar, you will see your personal devices or the devices in the corresponding group.
Add personal device
Click on Personal on the left side. Then click on blue +-sign with 'Add device' below it. You will now see the screen below.
Enter a description of the device.
Find the MAC address of the device and enter it under 'MAC'. The MAC address is often found on a sticker on the device and has the following syntax XX-XX-XX-XX-XX-XX-XX, where the X can have a value from 1 to 9 or A to F (hexadecimal).
The device location and expiration date are optional to enter. 14 and 7 days prior to the expiration date, the user will receive an e-mail with an opportunity to enter a new expiration date. Of course, the user can also let it expire.
The 'Password' field contains a randomly selected and unique WiFi key. Clicking on the green eye shows the password.
Click on 'Create' to register the device.
Now the device can be connected to the WiFi network by choosing the SSID 'iotroam' and entering the iotroam password as the WiFi key or WiFi password.
A user who is a member of one or more groups will see the names of the corresponding group or groups on the left side under 'Personal'. If a group is not listed but is needed, contact the institution's IT helpdesk.
Click on the name of a group and then the arrow in the light blue bar to see a list of the registered devices in that group. Click on the a device to view its details.
Add a device in a group
Click on the name of the group to which the device is to be added. Then click on the large +-symbol with "Add device" below it or in the device overview in the light blue bar on the + next to "Devices". Then go through the same steps as for a personal device.
Add devices in a group with CSV import
To add multiple devices in a group, it is possible to import them via a CSV file. An example of the CSV file can be downloaded in the portal. Click on the group where the devices should be added to. Click on the sentence 'Drag a CSV file here to import devices' in the lower right corner.
You will now see the screen below. From there, click on 'Preview CSV file' to download the preview.
When the CSV file is ready, it can be selected via 'Browse...'. After that, click on the Continue button. The list of devices is now displayed and a check is done for the correctness of the data, such as duplicate MAC addresses and whether a MAC address has the right number of characters and right characters (hexadecimal).
- MAC address and password are required in the CSV file, description and location are not. Description is recommended, though. If you do not want to fill a field, leave it blank and put the comma down before the next field, unless it is the last field;
- The password in the CSV file you have to generate and fill in yourself. You can choose this yourself. The reason behind this is that it takes a lot of time to find the password generated by iotroam in the iotroam portal for all imported devices afterwards. By choosing this yourself with CSV import, it is immediately known what it is with which device. You can optionally use a password generator.
A user can be granted the rights of group owner. These rights can be granted by the institution's IT department or by another group owner. A group owner can invite users to join the group through a link or QR code. A group owner can also manage group members: delete or make them group owners. All members in a group have the same rights to add, modify or delete devices in the group.
When a user selects the group they are a group owner of, the screen below appears. The Users button is the difference from regular group members.
Create group invite
The group owner creates an invite within the group and can then distribute it via a QR code or a link. The first step is to click on the Users button. The screen with the current group members is displayed.
Then click Manage invites. The overview of active group invites is displayed.
Click on Add. The screen below is displayed.
Enter a name.
Usage limit is optional. This is the maximum number of times the invite can be used.
Expiry date is optional. After this expiration date, the invite will no longer work.
Click on Add to create the group invite. It appears in the overview of group invites.
Sending group invites
Start from the group invite overview screen. Click on the invite you want to send. The details of the invite are displayed as shown in the following screen.
Clicking on the icon to the right of the Group invite link will copy the link to the clipboard. It can then be pasted into a medium of your choice, such as an e-mail or messaging app.
It is also possible to generate a QR code. To do so, click on the QR Code button at the bottom right. The QR code for the corresponding invite will appear.
The QR code can be downloaded as an image (.png) by clicking on the Download button. It can then be distributed or inserted in a presentation, for example. Alternatively, you can copy the image by hovering your cursor over the QR code, clicking the right mouse button and selecting 'Save image as...'.
Managing group invites
Start in the group invite overview screen and click on the invite to be managed. The details of the invite are displayed, as shown in the screen below.
A group invite can be deleted by clicking the Delete button.
Details of the invite can be changed by clicking the Edit button. A similar screen is then displayed as when creating an invite.
Managing group members
A group owner has the ability to manage active group members. That is, remove them from the group or make them group owners.
Select the respective group on the left side and click on the Users button in the middle of the screen. Now the screen is displayed with all members of the group, as shown below.
A group owner removes a member from the group by clicking the Remove button. This does not remove a user from iotroam as a user, only from the group. Removing a user from iotroam can be done by the IT department.
A group owner makes a member group owner by checking the Owner checkbox behind the name of the member. Unchecking this box removes the rights of a group owner.
Extend a device
When the expiration date of a device is approaching, the owner, in case of a personal device, or the group members, in case of a device in a group, will receive an email with the notification that the device will expire soon 14 days and 7 days prior to expiration. The default expiration time for personal devices and groups is determined by the institution's iotroam administrator. This may be a different time for each group. If a device expires in iotroam, it will not be able to connect to the network after that date. Your institutions helpdesk can activate a device when it expired unintended.
Go through the following steps to renew a device.
Log into the iotroam portal and go to the device to be extended.
Click on the Edit button.
Choose a new expiry date for the device and click Save.
Delete a device
If you want to delete a device from iotroam, follow these steps.
Log in to the iotroam portal and click on the device you wish to delete. Click Edit and then click the Delete button. The device is now deleted.
This works the same for personal and group devices.
If a device was accidentally deleted, contact your institutions helpdesk. They can arrange for the device to be restored.
As a user you have the option to choose your language. To do this, click on the little flag next to your name in the top right corner of the screen. Choose the desired language. By default, the language setting of the browser is chosen.