One-Touch Join process and deployment overview
This topic gives an overview of the process used by One-Touch Join to extract calendar information and provide it to endpoints, along with information on general deployment and network considerations.
In this topic:
The general process from setting up One-Touch Join through to having the endpoint display a Join button at the start of a meeting is as follows:
Administrator configures OTJ
- The administrator configures their G Suite, Exchange on-premises or Office 365 deployment to support Pexip Infinity One-Touch Join, and ensures that each physical meeting room that contains an endpoint to be used for One-Touch Join has an associated email address.
- The administrator then configures One-Touch Join on the Pexip Infinity Management Node. This configuration is automatically replicated to the One-Touch Join service that runs on each Conferencing Node in the Pexip Infinity deployment.
- Finally, the administrator configures their endpoints to support One-Touch Join.
End user sends invitation
When an end user wants to use a One-Touch Join room for a meeting, they create a meeting invitation in their usual way, using their usual client, ensuring that the room resource is added to the invitation.
Generally, rooms are added to a meeting invitation as a room resource, but One-Touch Join will also work if the room resource's email address is included in the list of invitees, or as a location.
OTJ provides endpoint with meeting information
- Each meeting room resource has one Conferencing Node which will be its primary node. Periodically, One-Touch Join on the Conferencing Node connects to G Suite or Microsoft Exchange and uses the configured service account details to impersonate each room resource for which it is the primary node. For each room resource, One-Touch Join finds all meetings to which the room has been invited. By default, it does this for all meetings with a scheduled start time from one day in the past up to seven days in the future, but this range is configurable.
- One-Touch Join parses the meeting invitation (in accordance with the relevant meeting processing rule) to obtain information about the meeting, which it uses to generate the alias that the endpoint will dial in order to join the meeting.
One-Touch Join then provides the meeting information to the endpoint that is associated with the room resource:
- for Cisco endpoints, One-Touch Join pushes the meeting information to the endpoint
- for Poly endpoints, the endpoint registers to the OTJ calendaring service on the Conferencing Node and periodically requests updated meeting information from the Conferencing Node.
More than one endpoint can be associated with a single room resource; in this case, all the endpoints will receive the same meeting information.
- When the meeting is about to start, the endpoint will display a button; participants in the room simply click the button and the endpoint will dial in to the meeting.
The flow of information between the calendar/email service, One-Touch Join and the endpoint is shown in the following diagram (using G Suite and a Cisco endpoint as the example):
The length of time taken for a meeting booked via Exchange or Google calendar to appear on the corresponding room endpoint depends on a number of factors, but is largely due to the number of endpoints in your deployment.
In general, for deployments of around 170 endpoints or fewer, the One-Touch Join service will poll room resource calendars with a maximum frequency of every 30 seconds. (It does not poll any more frequently than this to avoid impacting the performance of Conferencing Nodes.) Cisco endpoints will be updated after each poll; Poly endpoints will generally connect to the Conferencing Node to get updates every minute, but this will depend on the Poly configuration.
As you add more endpoints, One-Touch Join will reduce the frequency of requests correspondingly. For a deployment of 4,000 endpoints (the maximum supported number), endpoints will be updated around every 12 minutes. This is because both Microsoft Exchange and Google limit the number of API requests that can be made to their calendar services in a 24-hour period. It is possible to change the 24-hour quota to increase the frequency of endpoint updates in larger deployments, but note that doing so may impact the performance of the Conferencing Nodes, so you may need to consider deploying a dedicated One-Touch Join platform. We recommend you discuss larger deployments with your Pexip authorized support representative first.
- For G Suite deployments, you can change the 24-hour quota by Requesting an increase to API limits and then increasing the Maximum G Suite API requests, but this is a paid-for service.
- For Exchange deployments, you can change the 24-hour quota by increasing the Find Items Request Quota.
All Conferencing Nodes in your deployment are capable of running One-Touch Join. However, the service will be in active operation on only those nodes that belong to a location that has been associated with a OTJ Endpoint Group (and when that Endpoint Group has been associated with an OTJ profile).
Within each such location, a maximum of five Conferencing Nodes will actively read room resource calendars and process meeting information. Responsibility for each room resource is spread across these nodes in order to balance the workload and provide redundancy. Should one node become unavailable (for example, if it is put into maintenance mode or loses connectivity), the other nodes will take over responsibility for its room resources.
However, if there are one or more Poly endpoints in the location, the One-Touch Join service on all nodes within the location will handle requests from Poly endpoints. Therefore round-robin DNS records are required for all nodes in a location that has Poly endpoints.
Note that if you put all Conferencing Nodes in a One-Touch Join location into maintenance mode, then none of the endpoints in the associated Endpoint Group will receive any updates (overflow locations are not used by One-Touch Join).
You can use existing system locations for One-Touch Join, in which case up to five Conferencing Nodes in that location will be actively operating One-Touch Join in addition to their core functions. Alternatively, you can set up system locations that will be used specifically for One-Touch Join. These can be in the same physical locations as your existing Conferencing Nodes, but their resources will be dedicated to One-Touch Join.
As with other Pexip Infinity services, the One-Touch Join service will continue to function if the Management Node goes offline, although you will not be able to make any changes to the configuration of the service during this time.
For deployments using OAuth, the Management Node periodically refreshes OAuth tokens on behalf of Conferencing Nodes, so eventually (after some weeks) these nodes may become unable to authenticate with Exchange / G Suite.
Each Conferencing Node used for One-Touch Join requires a persistent connection to either G Suite or the Microsoft Exchange server (either directly or via a web proxy), and must be able to sign in to it as the service account.
If you are using OAuth for Exchange, or a G Suite integration, each Conferencing Node must be able to reach the OAuth token endpoint, either directly or via a web proxy.
Each Conferencing Node must be able to access the Cisco One-Touch Join endpoints within its location (using the endpoints' APIs), either directly or via a web proxy.
Poly endpoints must be able to connect directly to the Conferencing Nodes in their location.
As with all Pexip Infinity deployments, the Management Node must be able to contact each Conferencing Node.
In addition, if your One-Touch Join deployment is using OAuth (within either an Exchange O365 integration, or a G Suite integration with domain user authorization), the Management Node will send requests to the OAuth token endpoint. These requests will be sent either directly or via the web proxy (if one has been configured for the Management Node).
The following table lists the ports/protocols required for communication between the components of Pexip One-Touch Join:
|Source address||Source port||Destination address||Dest. port||Protocol|
|Management Node||55000–65535||Web proxy (if configured for the Management Node)||8080
OAuth token endpoint (for O365 or G Suite integrations)
|Conferencing Node||55000–65535||Web proxy (if configured for the system location to which the Conferencing Node belongs)||8080
|Conferencing Node||55000–65535||G Suite (for G Suite Integrations)
|Conferencing Node||55000–65535||Exchange Server (for Exchange on-premises or O365 integrations)
|Conferencing Node||55000–65535||Exchange Server (only required if the O365 Autodiscover URL lookup has otherwise failed)
OAuth token endpoint (for O365 or G Suite integrations)
|Conferencing Node||55000–65535||Cisco endpoint API
|Poly endpoint||<any>||Conferencing Node||443||TCP (HTTPS)|
Note also that the ephemeral port range (55000–65535) is subject to change.
The diagram below summarizes the connectivity required between the components of Pexip One-Touch Join, using Microsoft Exchange as an example.
Note in most cases, and particularly for a dedicated One-Touch Join deployment, all Conferencing Nodes should remain within the internal network, and not in the DMZ.
For Exchange integrations, the One-Touch Join service account must be able to impersonate the calendar of each OTJ room resource (or a user's personal calendar, if you wish to Use OTJ with personal endpoints and calendars). This is achieved by adding the email address to a specific OTJ Distribution Group, and giving the service account application impersonation rights to that group. For instructions on how to do this, see Configuring Application Impersonation on the service account (for Exchange on-premises) or Configuring Application Impersonation on the service account (for Office 365).
The use of Exchange impersonation is common in business applications that work with mail, when a single account needs to access many accounts.
The following information from Microsoft provides further background on the use of impersonation in Exchange:
- https://docs.microsoft.com/en-us/exchange/client-developer/exchange-web-services/impersonation-and-ews-in-exchange for guidelines on when to use impersonation in your Exchange service applications.
- https://blogs.msdn.microsoft.com/exchangedev/2009/06/15/exchange-impersonation-vs-delegate-access/ for information on the differences between impersonation and delegate access.
For G Suite integrations, the One-Touch Join service account (or the authentication user, if using 3-legged OAuth) must be able to access the calendar of each room resource. This is achieved by sharing the room resource's calendar (or the user's personal calendar, if you wish to Use OTJ with personal endpoints and calendars) with the service account. For instructions on how to do this, see Sharing individual calendars with the service account.
Note that the Google calendar API limits the number of calendars that can be shared within a 24 hour period to 750 (for more information, see https://support.google.com/a/answer/2905486?hl=en). This means that if you have more than 750 room resources that you wish to use for One-Touch Join, they will need to be set up over a period of days.
Some users in your enterprise may have their own personal endpoints on their desk or in their office, which they want to integrate with their personal calendars so that they can simply use the "Join" button to connect to any video meetings that appear in their calendar.
To achieve this, you use the user's own email address as the room resource email address when configuring One-Touch Join. However, you must also ensure that the service account being used for One-Touch Join can access the user's calendar, as described in Permitting the service account to access calendars.