Add a Private Genesys Cloud Embeddable Framework integration

Note: This article applies to the private deployment of Genesys Cloud Embeddable Framework. For more information, see Deployment options.

Prerequisites

To use a private deployment of the integration, add one or more Private Genesys Cloud Embeddable Framework integrations to your Genesys Cloud organization. You can add up to five implementations of the integration. If you add more than one Private Genesys Cloud Embeddable Framework integration, when users log in or clear their cache, the integration prompts them to select which implementation of the integration to use.

Important: If the Restrict Genesys Cloud Embedding setting is enabled in your Genesys Cloud organization, you must add the parent domain to Allow Embeddable Domain(s). Otherwise your implementation of the Genesys Cloud Embeddable Framework will fail to embed. For more information, see Manage Genesys Cloud embedding with the Genesys Cloud embedded clients.
  1. Add an integration.
    1. In Genesys Cloud, click Admin.
    2. Under Integrations, click Integrations.

      A list of all integrations that you have installed appears.

    3. At the upper right, click Integrations.

      A list of available integrations appears.

    4. Search for Private Genesys Cloud Embeddable Framework and click Install.
  2. Configure the integration.
    1. Click the Configuration tab. 
    2. framework.js File: Click Browse and upload a framework.js file.
      Note: You can upload a new framework.js to replace an existing file at any time. Due to caching, users must refresh their client to see the effect of the new file. Any changes to the integration may take several minutes to appear.

    3. Group Filtering: Click Select Groups.

      Users have access to the integration as members of the group that you select. For more information about groups and adding members, see About setting up groups (admins).

    4. Click Save.
  3. Activate the integration.
    1. Under the integration that you just added, click the Status toggle to change it from Inactive to Active.

      A Change Status dialog box appears.

    2. Click Yes.

The integration is now active. You can edit, deactivate, or delete an installed integration. For more information, see Edit, deactivate, or delete an integration.

For more information about the integration, see About Genesys Cloud Embeddable Framework.