About One-Touch Join
Pexip Infinity's One-Touch Join (OTJ) feature integrates support for existing "click to join" videoconferencing endpoint workflows into your Pexip Infinity deployment. With One-Touch Join, when users schedule a meeting in Microsoft Outlook or Google Calendar and include in the meeting invitation a room that contains a supported endpoint (such as Cisco's One Button to Push - OBTP), the endpoint will display a button just before the meeting is scheduled to begin. Participants can then simply walk into the room and select the button, and the endpoint will automatically dial in to the meeting.
One-Touch Join is available as an optional licensed feature within the Pexip Infinity platform.
In most cases, One-Touch Join will be implemented as a feature within a wider Pexip Infinity deployment. However, in some situations you may wish to implement a separate Pexip Infinity deployment purely for One-Touch Join, for example if you are a Pexip Service customer wishing to use One-Touch Join, or you are a large enterprise wishing to separate the resources used for your One-Touch Join deployment. For more information, see Deploying a dedicated One-Touch Join platform.
In this topic:
- Supported G Suite editions
- Supported Exchange environments
- Supported endpoints
- Supported number of endpoints and Conferencing Nodes
- Supported meeting types
- Pexip Infinity server requirements
- Enabling One-Touch Join
- Process overview
- Frequency and limitations on calendar requests
- Locations, Conferencing Nodes and One-Touch Join
- Network architecture and firewalls
- Permitting the service account to access calendars
Pexip One-Touch Join is supported in the following G Suite environments:
- G Suite Basic
- G Suite Business
- G Suite Enterprise
Pexip One-Touch Join is supported in the following Microsoft Exchange environments:
- Office 365
- Exchange 2013 (with the latest updates)
- Exchange 2016 (with the latest updates)
- Exchange 2019 (with the latest updates)
Meetings scheduled in all Outlook clients are supported. Note that different third-party Outlook add-ins for different Outlook versions may format the join details for some meeting types slightly differently.
Pexip Infinity One-Touch Join is supported on Cisco VTC endpoints that support Cisco One Button to Push (OBTP) and are running either TC or CE* software.
- Cisco Webex Room series (Room, Room Kit)*
- Cisco C series (C20, C40, C60, C90)
- Cisco DX series (DX70, DX80)
- Cisco EX series (EX60, EX90)
- Cisco MX series (MX200, MX300, MX700, MX800)
- Cisco SX series VTC systems (SX10, SX20, SX80)
* Endpoints registered to WebEx cloud must be using Webex Edge for Devices.
This release of Pexip One-Touch Join can be used to join the following types of meetings:
Pexip Infinity meetings (i.e. those scheduled using the VMR Scheduling for Exchange feature)
Pexip service meetings (i.e. those scheduled using the plugin available to Pexip service users)
Google Hangouts Meet (for G Suite integrations only)
- Microsoft Teams
Skype for Business
The One-Touch Join feature will support up to 4,000 room resource calendars and associated endpoints. This applies to One-Touch Join both when integrated with a Pexip Infinity deployment (i.e. when running on Conferencing Nodes alongside other Pexip Infinity services), and as a deployment dedicated to One-Touch Join.
For integrated deployments of up to 170 room resource calendars and associated endpoints, a single Conferencing Node per location should suffice (although you may wish to include one or more additional Conferencing Nodes for redundancy). For large or busy deployments, you may need to add additional Conferencing Nodes per location — we recommend that you consult your Pexip authorized support representative for advice on your particular deployment.
These recommendations apply to deployments with one or two OTJ Integrations. For deployments with multiple One-Touch Join Integrations (for example, when implemented by service providers with multiple customers) we recommend a dedicated One-Touch Join deployment.
For dedicated deployments of all sizes (i.e. up to the supported 4,000 room resource calendars and associated endpoints), we recommend one Conferencing Node for every 1,000 endpoints in a location (although you may wish to include one or more additional Conferencing Nodes for redundancy).
For information on the hardware requirements for OTJ, see Pexip Infinity server requirements.
In most cases you will be enabling One-Touch Join within a new or existing Pexip Infinity deployment, and the service can be run alongside other Pexip Infinity services on each Conferencing Node. Enabling One-Touch Join within most Pexip Infinity deployments (up to 170 endpoints — see Supported number of endpoints and Conferencing Nodes) will not significantly increase the processing requirements of the Management Node or Conferencing Nodes, therefore our standard Server design guidelines still apply. However, if your deployment is expected to be particularly large or busy, we recommend that you consult your Pexip authorized support representative for advice.
For dedicated One-Touch Join deployments, see Minimum hardware requirements.
In both cases, we recommend that each Conferencing Node runs on a different VM host and uses different storage.
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.
All Conferencing Nodes are capable of running One-Touch Join, although the service will only come into active operation on a node when the location it is in is associated with a One-Touch Join Endpoint Group.
Enabling the Pexip One-Touch Join service within your Pexip Infinity deployment involves the following two steps, described in separate topics:
- Depending on which calendar/email service is used in your environment, do one of the following:
- Configuring Pexip Infinity for One-Touch Join
For a guide for end users, see Scheduling and joining meetings using One-Touch Join.
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.
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.
The flow of information is shown in the following diagram (using G Suite as the calendar/email service):
- 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 logs into the endpoint that is associated with the room resource, using the endpoint's API, and updates it with the meeting information.
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 abutton; participants in the room simply click the button and the endpoint will dial in to the meeting.
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 and update endpoints 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.)
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 nodes will actively handle One-Touch Join; the One-Touch Join service on the remainder will remain inactive unless one of the first five nodes becomes unavailable.
Each room resource has one Conferencing Node which will be its primary node, and another that is its secondary node. The primary and secondary nodes both connect to Exchange or G Suite to get the meetings for that room resource. This is done so that should the primary node become unavailable, the secondary node will become the primary node for that room resource and the transition will be smooth because the secondary node already knows about the meeting rooms it is now responsible for.
When maintenance mode is enabled on a Conferencing Node, or the node goes offline, it will no longer act as the primary node for its room resources. Each of the remaining Conferencing Nodes in that location will be aware that the original node is no longer available, and will become primary node for any of the room resources for which it was the secondary node, thus reallocating the node's room resources between them. 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.
Each Conferencing Node used for One-Touch Join requires a persistent connection to either G Suite or the Microsoft Exchange server (direct access is required; web proxies are not currently supported), and must be able to sign in to it as the service account.
Each Conferencing Node must be able to access the One-Touch Join endpoints within its location, via the endpoints' APIs.
If you are using OAuth, the Management Node and each Conferencing Node must also be able to reach the OAuth token endpoint.
You must therefore ensure the following access is enabled from each Conferencing Node to:
- G Suite or Exchange server: 443/TCP
- each OTJ endpoint in the same location: 443/TCP for HTTPS (otherwise 80/TCP for HTTP)
If you are using OAuth, you must also enable access from the Management Node and each Conferencing Node to:
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.
The diagram below summarizes the connectivity required between the components of Pexip One-Touch Join, using Microsoft Exchange as an example.
The use of Exchange impersonation is common in business applications that work with mail, when a single account needs to access many accounts.
The Pexip Infinity One-Touch Join feature requires that the service account is configured to use impersonation to
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.
When integrating with G Suite, the One-Touch Join service account must be able to read the calendars of each room resource. This is achieved by 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.