New Virbela dashboard report and API to track private volume attendance
We have introduced a new report and API that allows customers to track attendance more granularly. The existing attendance report and API returns information about users who have joined a given scene. However, the private volume report and API will return information about users who entered a given private volume.
| ℹ |
The term “private volume” often refers to any space providing privacy from the main space. Often, these are remarked by a blue border and an audible alert when a user enters and exits. For example, the offices, boardrooms, and end caps are private volumes in the workspace scene. This report and API work with private volumes and their corresponding public volume. In other words, users can use this report to track who was in the main hallway of the workspace scene or the auditorium when private volumes are toggled off. |
Getting the private volume ID
For customers to use this report, they need to understand the private volume ID(s) of the space(s) they are interested in.
At the moment, there is only one way to find this ID. Users must enter the private volume they are interested in and enter /roominfo in the chat.
| ℹ | Any user, from member on up, can use the |
The /roominfo command will return information about the private volume in the chat. Users should take note of any information that precedes the “voice IP” information - this contains the private volume information. This ID may or may not start with “PR-”. In the example below, the private volume ID is PR-2114767535--NewCampus.
| ℹ |
Users can write down the private volume ID, copy the chat using the right mouse key, and then paste it into a document. Private volume IDs stay consistent, so once you copy it down, it will remain the same in the future. However, private volume IDs do differ among like scenes. For example, a boardroom in the workspace scene will have a different ID from other boardrooms in that same workspace scene and a different ID from other boardrooms in other workspace scenes. |
Using the dashboard report
Once the user has the private volume ID, they can access the “private space” report in the Virbela dashboard → analytics → private volume.
The user can set the start time and duration in hours (see the section below for details on the logic). They can search for a given private volume (entering the ID) or search across all private volumes within the campus.
The report will then return entries for every time a user was in the private volume for that time range.
Users can export this report into a CSV file.
Private room API
We are also introducing a new API to accompany this report. Please review this article for more details.
Logic for date ranges
The private volume report aggregates user data, making it difficult to know when a user was in a room.
Consider this scenario - user JDoe visits PR-2114767535--NewCampus during these times on 01 January:
Enters the private volume at 8:00 AM and leaves at 9:00 AM; the user talks for 30 minutes
Returns to the private volume at 10:00 AM and leaves at 11:00 AM; the user talks for 20 minutes
Returns to the private volume at 1:00 PM and leaves at 2:00 PM; the user talks for 10 minutes
The report will return the following:
Display Name |
Join Time |
Leave Time |
Attendance Time (min) |
Talk Time (min) |
|
|---|---|---|---|---|---|
JDoe |
01 January 20XX 8:00 AM |
01 January 20XX 9:00 AM |
60 |
30 |
|
JDoe |
01 January 20XX 10:00 AM |
01 January 20XX 11:00 AM |
60 |
20 |
|
JDoe |
01 January 20XX 1:00 PM |
01 January 20XX 2:00 PM |
60 |
10 |
| ℹ |
The data range will return any users in the private volume during the indicated time frame. In other words, consider the following users (a different scenario than above): User A joined the private volume at 2:00 PM and left the private volume at 4:00 PM User B joined the private volume at 2:45 PM and left the private volume at 3:15 PM User C joined the private volume at 2:00 PM and left the private volume at 3:00 PM User D joined the private volume at 3:00 PM and left the private volume at 4:00 PM User E joined the private volume at 1:00 PM and left the private volume at 1:30 PM User F joined the private volume at 4:30 PM and left the private volume at 5:00 PM If the Start Time = 2:30 PM and the Duration = 1 hour, then the response will show Users A, B, C, and D as they all were in the private volume for some during the indicated time frame. Users E and F will not appear in the response. |
Minor stories and bug fixes
Ensure the hands-down feature works consistently
Users will sometimes report issues with the hands-down feature. This is now resolved.
Private space administrators are invited as their private space role, not their campus role
Private spaces have their unique roles. While most private space users are campus members, they may have enhanced privileges in the private space. For example, a user can be a member of a campus but an administrator of a private space.
We resolved an issue where private space administrators were granted their campus role in the private space instead of their private space role. In other words, when an owner invited an administrator, the system would recognize them as a private space member instead. This is resolved.
| 🗎 | Private space administrators are still invited as members of the campus. They will have administrator rights only in the specific private space. |