Room Usage Test

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing, and video conferencing. Zoom Rooms can be used for room-only attendees, or remote attendees joining from another room, from their desktop, or from their mobile device. Once the Zoom room is setup, it is important to monitor the room for usage as it consumes license charges.

This test monitors the rooms and comes up with key statistics like number of meetings being hosted, number of participants etc. These numbers provide a clear picture to administrators how much the room is used. If the room is not used adequately, administrators may recommend releasing the license.

Target of the test : Zoom

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each room in the monitored Zoom account.

Configurable parameters for the test
Parameters	Description
Test period	How often should the test be executed, the default value is 12 hrs.
Host	The host for which the test is to be configured. By default, this is Zoom.us.
Client ID	When configuring the Zoom API, you should have created an API client with OAuth authentication. Each client app is assigned with a Client ID which you need to copy from client app configuration wizard and save down. Zoom API requires Client ID and Secret Token when calling REST APIs. To know more about how to create Client ID and Secret Token, refer to Setting up Zoom API
Client Secret	Secret Token is generated along with Client ID during API configuration. Each client app is assigned with a Client ID which you need to copy from client app configuration wizard. Zoom API requires Client ID and Secret Token when calling REST APIs. To know more about how to create Client ID and Client Secret, refer to Setting up Zoom API
Authorization Code	Authorization Code acts as an access token which tells Zoom on subsequent requests that current client has already been authorized. The Authorization Code is sent to client as string along with redirect URL once the client request has been authorized. In this text box, you need to specify the authorization code that you obtained during API configuration. For more details, refer to Setting up Zoom API
Redirect URL	In the authorization flow, the Zoom API request is first passed on to Zoom Auth Server. Once the authorization is successful, the client request is redirected back to URL provided by user in Redirect URL along with authorization code. Client can now hit the API with given authorization code to pull metrics.
API URL	Zoom offers globally accessible URL for Zoom REST APIs. To enable the eG agent to connect Zoom REST APIs and pull out metrics, this test should be configured with the accessible URL against this parameter. The default value of this parameter is https://api.zoom.us/v2/. Before using the APIs, first you need to create an API client, set up the authentication and authorization details as elaborated in topic Setting up Zoom API.
Show N DD	By default, this parameter is set to 50. This indicates that, by default, the detailed diagnosis of this test will display the details of only 50 events. If you wish this test to report details of all events, then specify "all" against this parameter.
Proxy Host and Port	If the eG agent need to communicates with Zoom via a proxy, then, you also need to configure the eG agent on the connector with the proxy server details. This will enable the eG agent to connect to the Zoom without a glitch, and pull metrics. To facilitate this communication. do the following: Specify the IP address/fully-qualified host name of the proxy server, against PROXY HOST. Specify the port at which the Proxy server listens for requests from the eG agent, against PROXY PORT. By default, both these parameters are set to none, indicating that the eG agent does not communicate with the Zoom via a proxy.
Proxy User Name and Password	Specify the Proxy username and password if proxy server is being used to connect with Zoom.
Confirm Password	Confirm the password by typing it in Confirm password box.
DD Frequency	Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time the test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD Frequency.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Meetings	Indicates the total number of meetings being held in this room during the last measurement period.	Number	Total number of meetings is a good indicator of how much the rooms are being used. It is very important measure for administrators to know.
Meeting Minutes	Indicates the total number of meeting minute during a given time period.	Milliseconds	Meeting minutes provide even granular view of meetings, with this administrators come to know how much of each room is used.
Participants	Indicates the total number of participants in various meeting over a given duration.	Percentage	If the number of participants is smaller in each of the meeting ut the number of meetings is higher, it might not justify the usage of rooms. Rooms are ideal for having large number of participants coming and going from the meetings.
Average Participants	Indicates the average number of participants in each meeting.	Percentage	Average number of participant provide better insight across the meetings.
Meetings minutes Percentage	Indicates the total percentage of meeting minute during a given time period.	Percentage	If the room occupancy percentage is very high, it might mean the room is used more optimally.
Used	Indicates the percentage utilization of meeting time.	Percentage	If the room occupancy percentage is very high, it might mean the room is used more optimally.