Configuring endpoints to support One-Touch Join

This topic describes how to configure each of the supported endpoint types — Cisco OBTP (either when on the same network as the One-Touch Join Conferencing Nodes, or when on a different network), or Poly OTD — so they can be used with Pexip Infinity One-Touch Join.

Prerequisites

We recommend that you have already completed the steps in Configuring Pexip Infinity for One-Touch Join. In particular, you will need some of the information that you previously entered when Adding One-Touch Join endpoints to Pexip Infinity, to complete the configuration on each endpoint.

Configuring Cisco OBTP endpoints for OTJ

For endpoints on the same network as the OTJ Conferencing Node, we recommend you configure the endpoint to allow the node to connect directly to it, as per the instructions in Configuring OBTP endpoints on the same network.

For endpoints on a different network to the OTJ Conferencing Node, these endpoints must be registered to Webex Cloud, and OTJ must be configured to connect to the endpoint via Webex Cloud. For full instructions, see Configuring Cisco Webex Cloud registered endpoints.

For Cisco OBTP endpoints to obtain OTJ meeting information, the Conferencing Node associated with the endpoint uses the endpoint's API to push the information out to the endpoint.

The endpoint must have an account set up with a role of either Admin or User that can be used by OTJ to access the endpoint's API.

For endpoints registered to Cisco Webex Cloud to obtain OTJ meeting information, the Conferencing Node connects to the Webex Cloud, which then uses the endpoint's API to push the meeting information to the endpoint. To enable this, you must set up a Webex integration for use by OTJ, and then configure OTJ with details of the integration.

Prerequisites

Webex Cloud registered endpoints must be:

  • registered to either Webex or Webex Edge for Devices
  • running one of the following software versions:
    • CE (9.14 or later)
    • TC (any version supported by Webex Cloud)
    • RoomOS
  • have Cloud Calendar disabled
  • be running in Room mode (not Personal mode).

Creating a Webex Integration

In this step, you create a new Webex integration to use for OTJ.

  1. Go to https://developer.webex.com/my-apps/new/integration and sign in with your account.
  2. Configure the following fields as follows (all other fields can be configured as appropriate for your environment):

    • Redirect URI(s): this should point to the IP address or FQDN of your Management Node, and be in the format https://<Management Node_address>/admin/platform/mjxintegration/oauth_redirect/

      The OAuth Redirect URI is the page on the Pexip Infinity Administrator interface the administrator is sent to, after they have successfully signed in to the Webex Integration. Because it is a page on the Management Node, this URI is internal to your deployment and only needs to be accessible from the administrator's web browser; you do not need to make it externally accessible.

    • Scopes: select spark:xapi_commands

  3. Select Add Integration.

    Your integration is created.

  4. Take note of the Client ID and Client Secret (which will be generated for you after the integration has been created) and the Redirect URI (which you entered in step 2 above). These will be required when you are Enabling a One-Touch Join profile to use Webex Cloud.

Enabling a One-Touch Join profile to use Webex Cloud

  1. On the Management Node, go to One-Touch Join > OTJ Profiles and either select an existing profile, or create a new profile.
  2. In the Cisco Webex Endpoint Config Options section, select Enable Webex Cloud and in the fields that then appear, enter the Client ID, Client Secret and Redirect URI from the previous steps.

  3. Select Save.

    You are taken back to the main OTJ Profiles page.

  4. Select the profile you have just edited/created, and at the bottom of the page select Authorize Webex Cloud API access.

  5. From the Authorize Login to Webex Integration page, select Authorize:

  6. Sign in to Webex, and accept the permissions being requested.

    You are redirected back to the Management Node.

  7. You may be asked to sign in to the Management Node again. If so, you must sign in to the Management Node (using your Management Node credentials) to complete the authorization process.

When complete, you see the message Successful sign in to Webex Cloud.

Adding a Webex endpoint

  1. On the Management Node, go to One-Touch Join > OTJ Endpoints and select Add OTJ Endpoint.
  2. Select an Endpoint type of Webex Cloud registered.

  3. Enter the Webex Device ID.

    You can find the IDs for all devices in your Webex deployment by going to https://developer.webex.com/docs/api/v1/devices/list-devices and from the right-hand panel selecting Run.

  4. Enter the Room resource email associated with this endpoint.

Disabling the calendar

  1. Sign in to https://admin.webex.com/
  2. From the panel on the left, select Workspaces.

  3. Ensure that for each workspace containing an endpoint to be used for OTJ, the Calendar column shows Not configured.

    • If a calendar is listed, select Actions > Edit Calendar and from the Calendar drop-down menu select Off:

In order for Poly OTD endpoints to obtain One-Touch Join meeting information, each One-Touch Join Conferencing Node emulates a Microsoft Exchange server. The Poly endpoint then connects to the Conferencing Node and registers to the calendaring service on the node in order to pull meeting information, as shown in the diagram below.

Note that this emulation of an Exchange calendaring service on the Conferencing Node is purely to provide the Poly endpoint with its meeting information. It is completely separate to the process by which the Conferencing Node initially obtains the meeting information from the calendar/email service being used for One-Touch Join — which can be either Exchange or Google Workspace.

It is important that you do not set up your Poly endpoints until after you have completed the steps to add the endpoint details to Pexip Infinity.

Enabling the client API

To use Poly endpoints with One-Touch Join, you must ensure that the Client API is enabled on Pexip Infinity, via the global setting Enable support for Pexip Infinity Connect clients and Client API.

If you are deploying One-Touch Join as a dedicated stand-alone platform that includes Poly endpoints, you must still enable the client API. However, for added security you can disable some or all call protocols (i.e. SIP, SIP UDP, H.323, WebRTC and RTMP). For more information, see Enabling and disabling SIP, H.323, WebRTC and RTMP.

DNS records

If you have a One-Touch Join deployment that includes Poly endpoints in a location with more than one Conferencing Node, you should spread the Poly endpoint registrations across all nodes in the location to maximize performance and provide redundancy. To achieve this, we recommend that all Poly endpoints in a location register to a single FQDN which uses round-robin DNS to resolve to each Conferencing Node in turn. This requires you to set up appropriate DNS records for all Conferencing Nodes in the location, and ensure that your DNS server is configured to round-robin between these records.

For more information and examples, see Enabling Poly/Polycom endpoints to register to One-Touch Join.

Poly authentication

In normal Pexip Infinity usage Poly endpoints authenticate to One-Touch Join using digest authentication, with the exception of HDX endpoints which require NTLMv2.

When Pexip Infinity has been deployed in a secure mode of operation (and therefore FIPS compliance has been enabled), NTLMv2 and digest authentication are disabled and basic authentication is used. As a result, when in this mode:

  • HDX endpoints are not supported
  • Trio endpoints must be configured to allow basic authentication.

Deployments with a load balancer

If there is a load balancer between the Poly endpoints and the One-Touch Join Conferencing Node, the load balancer should be configured to set the X-Forwarded-For header. This preserves the endpoint's IP address in communications, allowing requests and subsequent responses to be directed to the correct endpoint.

One-Touch Join supports Poly RealPresence Group Series endpoints running v5.0.0 or later.

To configure a Poly RealPresence Group Series for One-Touch Join, use the following settings (which can be found on the endpoint under Admin settings > Servers > Calendering service):

Field Poly configuration Matching Infinity configuration Additional info
Email The email address of the room resource configured in Exchange or Google Workspace that is associated with this endpoint. This must be the same as the Room resource email configured on Pexip Infinity for this endpoint.  
Domain Leave blank.   This is the Exchange domain, and is not required for One-Touch Join.

User Name

Password

The username and password the endpoint will use when connecting and authenticating to the calendaring service on the Conferencing Node, to obtain meeting information.

This must be the same as the Poly Calendaring Username and Password configured on Pexip Infinity for this endpoint.

These fields are case-sensitive.

Each Poly endpoint must have a unique User Name.
Auto Discover Using Do not select this button.   Auto Discovery is not supported. Instead, you should manually configure the Microsoft Exchange Server settings.
Microsoft Exchange Server
  • If you have a single Conferencing Node in this location, enter the IP Address or FQDN of the node (in the format 192.168.0.0 or host.example.com).
  • If you have multiple Conferencing Nodes in this location, you should use DNS round robin; therefore this will be the FQDN of the DNS record for this location (in the format host.example.com).

In both cases, the location is the Pexip Infinity location associated with the Endpoint Group to which this endpoint belongs.

    
Secure Connection Protocol Select Automatic.    
Meeting Reminder Time in Minutes Optional   Can still be used in conjunction with One-Touch Join.
Play Reminder Tone When Not in a Call Optional   Can still be used in conjunction with One-Touch Join.
Show Information for Meetings Set to Private Optional  

Enable private meetings must be enabled on the One-Touch Join Profile associated with this endpoint in order for this setting to apply.

If Enable private meetings has been disabled on the One-Touch Join Profile, this setting will have no effect.

To confirm that the Poly RealPresence Group Series endpoint has registered successfully with the calendaring service:

  1. On the endpoint, go to Admin Settings > Servers > Calendaring Service.
  2. Confirm that the Registration Status is showing as Registered.

When configuring Poly Trio series endpoints for One-Touch Join, you should use a Generic base profile unless your deployment specifically requires you to use a Skype for Business base profile. Configuration instructions for each are given below.

Configuring Poly Trio using a generic base profile

  1. Open the endpoint's web UI at https://<ipaddress>, select Admin, and log in using the admin password.
  2. From Simple Setup > Base Profile select Generic and then select Save.

  3. Edit the config file as follows (this can be done via Utilities > Import & Export Configuration):

    • add the following:

      feature.contactPhotoIntegration.enabled="0"

    • if the Trio is running software version 5.9.1.11135 or later and Pexip Infinity has been deployed in a secure mode of operation (and therefore FIPS compliance has been enabled), you must allow the Trio to use basic authentication by adding:
      feature.exchange.allowBasicAuth="1"

  4. From Settings > Applications, configure the Poly trio as follows:

    Field Poly configuration Matching Infinity configuration Additional info
    Exchange Applications
    Exchange Calendar Select Enable.    
    Auto Discover Using Select Disable.   Auto Discover is not supported. Instead, you should manually configure the Exchange Server URL settings.
    Exchange Server URL

    Enter https://<address>/EWS/Exchange.asmx

    For <address>:

    • If you have a single Conferencing Node in this location, enter the IP Address or FQDN of the node (in the format 192.168.0.0 or host.example.com).
    • If you have multiple Conferencing Nodes in this location, you should use DNS round robin; therefore this will be the FQDN of the DNS record for this location (in the format host.example.com).

    In both cases, the location is the Pexip Infinity location associated with the Endpoint Group to which this endpoint belongs.

    		   Note that the URL is case-sensitive; in particular, ensure that EWS and Exchange are capitalized as shown.
    Exchange Sign-In *
    Exchange Email Leave blank.    
    Domain Leave blank.   This is the Exchange domain, and is not required for One-Touch Join.

    User

    Password

    The username and password the endpoint will use when connecting and authenticating to the calendaring service on the Conferencing Node, to obtain meeting information.

    This must be the same as the Poly Calendaring Username and Password configured on Pexip Infinity for this endpoint.

    These fields are case-sensitive.

    Each Poly endpoint must have a unique User name.
    * Available for endpoints running version 5.9.2.7727 or later. For earlier versions, you must have physical access to the endpoint's touch screen; use this to log in using the User and Password credentials as described above.

To confirm that the Poly Trio endpoint has registered successfully with the calendaring service:

  1. On the endpoint, go to Diagnostics > Exchange status.
  2. Confirm that Exchange Calendar is showing as Synchronized.

Configuring Poly Trio using Skype for Business base profile

You should only use the Skype for Business base profile if specifically required in your deployment (for example, if you wish to place PSTN calls via Skype for Business server); otherwise use the generic base profile.

When the Trio is configured as described below, it will still register with the calendaring service on the Conferencing Node to obtain meeting information, but it will also register with Skype for Business and use that to place outbound calls.

  1. Open the endpoint's web UI at https://<ipaddress>, select Admin, and log in using the admin password.
  2. From Simple Setup > Base Profile select Skype for Business and then select Save.
  3. Edit the config file (this can be done via Utilities > Import & Export Configuration) by adding:

    feature.exchangeVoiceMail.enabled="0"

    exchange.showSeparateAuth="1"

    feature.exchangeContacts.enabled="0"

  4. From Settings > Skype for Business SignIn, configure the Poly trio as follows:

    Field Poly configuration Matching Infinity configuration Additional info
    Skype for Business
    Use User Credentials Select Enable.    
    Authentication Type Select User Credentials.    
    Sign-in Address The endpoint's Skype for Business address.    
    Domain The endpoint's Skype for Business domain.    

    User

    Password

    		 The name and password the endpoint will use to authenticate with Skype for Business.    
    Microsoft Exchange Server Configuration
    Exchange Email The email address of the room resource that is associated with this endpoint. This must be the same as the Exchange target mailbox configured on the endpoint, and Room resource email configured on Pexip Infinity for this endpoint.  
    Exchange Domain Leave blank.    

    Exchange User

    Exchange Password

    The username and password the endpoint will use when connecting and authenticating to the calendaring service on the Conferencing Node, to obtain meeting information.

    This must be the same as the Poly Calendaring Username and Password configured on Pexip Infinity for this endpoint.

    These fields are case-sensitive.

    Each Poly endpoint must have a unique User name.
    Exchange Target Mailbox The email address of the room resource that is associated with this endpoint. This must be the same as the Exchange Email configured on the endpoint, and Room resource email configured on Pexip Infinity for this endpoint.  

  5. From Settings > Applications, configure the Poly trio as follows:

    Field Poly configuration Matching Infinity configuration Additional info
    Exchange Applications
    Exchange Calendar Select Enable.    
    Auto Discover Select Disable.   Auto Discover is not supported. Instead, you should manually configure the Exchange Server URL settings.
    Exchange Server URL

    Enter https://<address>/EWS/Exchange.asmx

    For <address>:

    • If you have a single Conferencing Node in this location, enter the IP Address or FQDN of the node (in the format 192.168.0.0 or host.example.com).
    • If you have multiple Conferencing Nodes in this location, you should use DNS round robin; therefore this will be the FQDN of the DNS record for this location (in the format host.example.com).

    In both cases, the location is the Pexip Infinity location associated with the Endpoint Group to which this endpoint belongs.

    		   Note that the URL is case-sensitive; in particular, ensure that EWS and Exchange are capitalised as shown.

    To confirm that the Poly Trio endpoint has registered successfully with the calendaring service:

    1. On the endpoint, go to Diagnostics > Exchange status.
    2. Confirm that Exchange Calendar is showing as Synchronized.

To configure the Poly HDX for One-Touch Join, go to the endpoint's IP address.

From Admin Settings > Global Services > Calendaring Service, enter the following:

Field Poly configuration Matching Infinity configuration Additional info
Enable Calendaring Service Select this option.    
Microsoft Exchange Server Address
  • If you have a single Conferencing Node in this location, enter the IP Address or FQDN of the node (in the format 192.168.0.0 or host.example.com).
  • If you have multiple Conferencing Nodes in this location, you should use DNS round robin; therefore this will be the FQDN of the DNS record for this location (in the format host.example.com).

In both cases, the location is the Pexip Infinity location associated with the Endpoint Group to which this endpoint belongs.

    
Domain Leave blank.   This is the Exchange domain, and is not required for One-Touch Join.
User Name The username the endpoint will use when connecting and authenticating to the calendaring service on the Conferencing Node, to obtain meeting information. This must be the same as the Poly Calendaring Username configured on Pexip Infinity for this endpoint.

This field is case-sensitive.

Each Poly endpoint must have a unique User Name.
Password Select this option. The New Password and Confirm Password fields will appear.    
New Password
Confirm Password		 The password the endpoint will use when connecting and authenticating to the calendaring service on the Conferencing Node, to obtain meeting information. This must be the same as the Poly Calendaring password configured on Pexip Infinity for this endpoint. This field is case-sensitive.
Mailbox

For Exchange integrations: the email address of the room resource configured in Exchange that is associated with this endpoint.

For Google Workspace integrations: the User Name entered above.

 For Exchange integrations, this must be the same as the Room resource email configured on Pexip Infinity for this endpoint.  

Reminder Time in Minutes

 Optional  

Can still be used in conjunction with One-Touch Join.

Play Reminder Tone

 Optional  

Can still be used in conjunction with One-Touch Join.

Show Private Meeting Information

Optional  

Enable private meetings must be enabled on the One-Touch Join Profile associated with this endpoint in order for this setting to apply.

If Enable private meetings has been disabled on the One-Touch Join Profile, this setting will have no effect.

To confirm that the Poly HDX endpoint has registered successfully with the calendaring service:

  1. On the endpoint, go to Admin Settings > Global Services > Calendaring Service.
  2. Confirm that there is a green tick next to Enable Calendaring Service.

To configure the Poly Studio or Poly G7500 for One-Touch Join, go to the endpoint's IP address and sign in to the endpoint if required.

From Servers > Calendaring Service, enter the following:

Field

Poly configuration

Matching Infinity configuration

Additional info
Enable Calendaring Service Select this option.    
Email

The email address of the room resource configured in Exchange or Google Workspace that is associated with this endpoint.

 This must be the same as the Room resource email configured on Pexip Infinity for this endpoint.  

Domain

Leave blank.

  

This is the Exchange domain, and is not required for One-Touch Join.

User Name

Password

The username and password the endpoint will use when connecting and authenticating to the calendaring service on the Conferencing Node, to obtain meeting information.

This must be the same as the Poly Calendaring Username and Password configured on Pexip Infinity for this endpoint.

These fields are case-sensitive.

Each Poly endpoint must have a unique User Name.
Microsoft Exchange Server
  • If you have a single Conferencing Node in this location, enter the IP Address or FQDN of the node (in the format 192.168.0.0 or host.example.com).
  • If you have multiple Conferencing Nodes in this location, you should use DNS round robin; therefore this will be the FQDN of the DNS record for this location (in the format host.example.com).

In both cases, the location is the Pexip Infinity location associated with the Endpoint Group to which this endpoint belongs.

 

 

Meeting Reminder Time in Minutes

 Optional  

Can still be used in conjunction with One-Touch Join.

Play Reminder Tone When Not in a Call

 Optional  

Can still be used in conjunction with One-Touch Join.

Show Information for Meetings set to Private

 Optional  

Enable private meetings must be enabled on the One-Touch Join Profile associated with this endpoint in order for this setting to apply.

If Enable private meetings has been disabled on the One-Touch Join Profile, this setting will have no effect.

To confirm that the Poly Studio / Poly G7500 endpoint has registered successfully with the calendaring service:

  1. On the endpoint, go to Servers > Calendaring Service.
  2. Confirm that the Registration Status is showing as Registered.

To configure the Poly Debut for One-Touch Join, from Server Settings > Calendar, enter the following:

Field

Poly configuration

Matching Infinity configuration

Additional info
Enable Calendar Select Enable.    
Microsoft Exchange Server
  • If you have a single Conferencing Node in this location, enter the IP Address or FQDN of the node (in the format 192.168.0.0 or host.example.com).
  • If you have multiple Conferencing Nodes in this location, you should use DNS round robin; therefore this will be the FQDN of the DNS record for this location (in the format host.example.com).

In both cases, the location is the Pexip Infinity location associated with the Endpoint Group to which this endpoint belongs.

 

 

Domain

Leave blank.

  

This is the Exchange domain, and is not required for One-Touch Join.

User Name

Password

The username and password the endpoint will use when connecting and authenticating to the calendaring service on the Conferencing Node, to obtain meeting information.

This must be the same as the Poly Calendaring Username and Password configured on Pexip Infinity for this endpoint.

These fields are case-sensitive.

Each Poly endpoint must have a unique User Name.

To confirm that the Poly Debut endpoint has registered successfully with the calendaring service:

  1. On the endpoint, go to the Device Status page.
  2. In the Calendar row of the table, check that the Status is showing as Registered.