Enabling OTJ on Cisco endpoints

As part of the installation and deployment of One-Touch Join across your organization, you must install the OTJ macro on each endpoint to be used. For more information about One-Touch Join, or supported endpoints and conferences, go to About One-Touch Join.

This topic describes how to create and download the OTJ macro, and install and uninstall it on a Cisco endpoint.

Prerequisites

Before you begin, ensure that you have:

Configuring and downloading the macro

  1. In PCC, go to Management and Settings > Video systems.
  2. Search for and select the name of the video system that you want to enable OTJ on.

    For a user to view their own OTJ Endpoint settings, their EUL must be twinned with an Endpoint Subscription. Twinning allows a EUL and an Endpoint Subscription to share the same SIP URI. This has to be set up by Pexip or a partner on https://portal.pexip.com.

  3. From the bottom of the page expand the One-Touch Join (OTJ) section and from the Endpoint type drop-down, select Cisco:

  4. To add an Associated mailbox, select Edit. Search for and select the relevant mailbox and select Save.
  5. In the API Secrets section, select Create new secret. (You don't need to copy this for now.)
  6. In the Cisco macro section, select Enable macro. Check and if necessary change the following default settings:

    Version

    By default, the latest available version of the OTJ macro is used to create the macro files for installation on the endpoint. However, you can elect to use a previous version.

    When a new version of the macro is released by Pexip, to update your endpoints with this version, return to this page and re-generate the macro ZIP file using the OTJ macro latest option.

    Display meeting notifications Choose whether or not to display notifications and the Join button on the endpoint in advance of the meeting's scheduled start time. If notifications are disabled here, the meeting still appears in the Scheduled Meetings list on the endpoint and still shows a Join meeting option before it is due to start.
    Notify before meeting start

    Select the amount of time before the meeting's scheduled start time that a notification will appear on the endpoint.

    The notification will include a Join option; users can select this to join the meeting immediately, or they can select Remind me... to receive another reminder at the meeting's scheduled start time.

       

    For more information on the notification flow, see Scheduling and joining meetings using One-Touch Join.

    Show join button before meeting start

    Select the amount of time before the meeting's scheduled start time that a Join button will appear in the endpoint's Scheduled Meetings list.

       

  7. Select Save changes. Your macro file is now configured.
  8. Select Download macro.zip and extract the files (otj-macro.js and otj-macro-settings.js) for use in the next section, Installing the OTJ macro on the endpoint.

Keeping the API secret secure

The endpoint communicates using the unique API secret. If the secret is compromised at any point, meetings and information in your organization are vulnerable to compromise. If you think the secret has been compromised, you can revoke the secret at any time. This will prevent OTJ from working on the video system. To ensure that OTJ continues to work, you must:

  1. Create a new secret.
  2. Download the updated macro.zip file.
  3. Revoke the old secret.
  4. Follow the steps in Installing the OTJ macro on the endpoint to upload the new macro files to the endpoint.

Installing the OTJ macro on the endpoint

The following instructions explain how to install the OTJ macro manually on a single endpoint.

Before you begin, extract the otj-macro and otj-macro-settings files from the OTJ macro ZIP file that you downloaded from the Pexip Control Center in the previous section, Configuring and downloading the macro.

  1. From your browser, log into the web interface of your Cisco endpoint.
  2. Go to Macro Editor:

  3. Select Enable Macros. This prompt only appears if you have never used a macro before.
  4. In the Macro Editor, select Import from file.
  5. Upload the otj-macro-settings.js file that you downloaded earlier.
  6. From the left panel, select the Save to video system icon:

  7. Select Import from file again, and upload the otj-macro.js file that you downloaded earlier.
  8. Select the Save to video system icon.
  9. From the left panel, for both macros, toggle the macro switch from off to on:

  10. Refresh the web page.

With immediate effect, the touch panel of the endpoint displays the Scheduled Meetings button and a Join Meeting option in notifications and meetings when they are due to begin.

Removing the OTJ macro

If you no longer wish an endpoint to offer the One-Touch Join feature, you must delete the OTJ macros from the endpoint and the endpoint's UI panel.

To do this:

  1. From your browser, log into the web interface of your Cisco endpoint.
  2. Go to Macro Editor:

  3. From the list of macros on the left, select the tool icon next to otj-macro and then select Delete:

  4. Repeat the step above to delete otj-macro-settings.
  5. Return to the home page and select UI Extensions Editor:

  6. From the left panel, select the Scheduled Meetings extension and then on the right, scroll down and select Delete panel:

  7. From the top right, select the menu icon and then Export to video system:

The Scheduled Meetings button disappears from the touch panel of the endpoint.

Troubleshooting

If you need to troubleshoot the OTJ macro at any point, you can download logs from the web interface in

System Maintenance > Issues and Diagnostics > Systems logs > Download logs...

One-Touch Join macro change log

Macro version Release date Description
v1.1.3 23 Oct 2024 Resolved an issue with v1.1.2 of the OTJ macro that meant it was not compatible with devices registered to Webex Cloud that were running RoomOS v9.x or earlier.
v1.1.2 07 Aug 2024 Removal of the deprecated CommonJS module and general improvements.
v1.1 07 Nov 2022 Macro text is now displayed in Danish, French Canadian, French, German, Italian, Japanese, or Polish if the endpoint is configured to use that language.
v1.0 04 Oct 2022 Initial release