Cobrowse.io Docs
  • Getting started
  • SDK Installation
    • Web
    • iOS
    • Android
    • React Native
    • Flutter
    • .NET Mobile
    • macOS
    • Windows
  • SDK Features
    • Account config
    • Identify your devices
    • Use 6-digit codes
    • Redact sensitive data
    • Viewing PDFs
    • Universal Cobrowse
    • Customize the interface
      • Active session controls
      • 6-digit code screen
      • User consent dialog
      • Remote control consent dialog
      • Full device consent dialog
      • Localization / translation
    • Initiate sessions with push
    • Listening for events
    • Full device capabilities
      • Full device screen sharing
      • Full device remote control
      • Managing full device mode
    • Advanced configuration
      • Starting and stopping the SDK
      • Declaring capabilities
      • Intercepting mobile SDK network requests
      • Web
        • IFrames support
        • IE 11 polyfills
        • Cross-domain session support
        • Ignore Views
      • iOS
        • Alternate render method
        • Custom touch handling
      • Android
        • Backporting TLS to older Android versions
  • Agent-side integrations
    • Agent-side overview
    • Platform integrations
      • Zendesk
      • Salesforce
        • Migrating from legacy to v2
        • Salesforce (Legacy)
      • Genesys
        • Genesys Cloud
        • Engage Workspace Web Edition (WWE)
        • Engage Workspace Desktop Edition (WDE)
      • Intercom
      • Freshworks
      • Talkdesk
      • NICE
    • Custom integrations
    • Agent SDK
      • API Reference
      • Sample code snippets
    • Authentication (JWTs)
      • JWT Policies
    • Authentication (SAML 2.0)
    • IFrame embeds
  • Enterprise self-hosting
    • Self-hosting overview
    • Docker Compose
    • Helm chart
      • Image Pull Secret
      • Environment Variables
      • Optional recording components
      • Pod Annotations
    • AWS terraform
      • AWS metrics configuration
    • Azure terraform
      • Azure metrics configuration
    • GCP terraform
      • GCP metrics configuration
    • Sizing guidelines
    • Running your instance
      • Adding a superuser
      • Limiting account creation
      • Limiting magic link recipients
      • Configuring SMTP
      • Managing your deployment
    • Monitoring your instance
      • Available metrics
      • Self-Hosted Prometheus
    • Advanced configuration
      • Air gap configuration
      • Pin web SDK version
      • L7 firewall configuration
      • Docker proxy configuration
    • Troubleshooting
Powered by GitBook
On this page
  • Installation
  • 1. Install plugin
  • 2. Add required config
  • 3. Start Workspace Desktop Edition
  • Configuring SSO
  • Troubleshooting
  • Why is the COBROWSE tab always blank?
  • How do I debug the COBROWSE tab?

Was this helpful?

  1. Agent-side integrations
  2. Platform integrations
  3. Genesys

Engage Workspace Desktop Edition (WDE)

Plugin version v1.x

PreviousEngage Workspace Web Edition (WWE)NextIntercom

Last updated 8 months ago

Was this helpful?

Installation

Supported WDE versions: 8.5.147.05+.

installed on your WDE instances.

1. Install plugin

Add the plugin and dependencies to your Workspace Desktop Edition installation:

  • Genesyslab.Desktop.Modules.CobrowseIO.dll

  • Genesyslab.Desktop.Modules.CobrowseIO.module-config

These files should be added adjacent to your other Module .dll files, in the same directory as InteractionWorkspace.exe. This executable is most commonly found atC:\Program Files (x86)\GCTI\Workspace Desktop Edition.

Cobrowse can provide these files to you upon request, free of charge, in order to conduct a proof-of-concept (PoC) or other technical evaluation.

2. Add required config

The configuration values can be added via Genesys GAX, Genesys Administrator, or directly in a InteractionWorkspace.exe.config file adjacent to your InteractionWorkspace.exe

When using Genesys GAX, please navigate to Environment/Applications -> WorkspaceDesktop -> Application Options -> interaction-workspace and add the following fields there.

Field

Type

Value

cobrowse.api required

string

eg. https://cobrowse.yourcompany.com default is https://cobrowse.io

cobrowse.license required

string

your license key

cobrowse.debug optional

string

true / false default is false

cobrowse.initialUrl optional

string

Override initial Url the plugin tab will load

cobrowse.proxyServer optional

(Supported in v1.4+)

string

URL to proxy WebView traffic through

cobrowse.proxyBypassList optional

(Supported in v1.4+)

string

Semi-colon-separated list of hosts.

3. Start Workspace Desktop Edition

You should now see the COBROWSE tab within your Workspace Desktop Edition when interacting with an end-user, such as on a phone call, or via a live chat.

Configuring SSO

Take note of your <PROVIDER_ID>. It should a string of 6 characters after the /login/saml/ path seen in the login page URL.

Update cobrowse.initialUrl to the URL below, replacing <DOMAIN> with the domain of the Cobrowse instance, often cobrowse.io, <PROVIDER_ID> with the 6 characters that you took note of in the previous step and <YOUR_LICENSE_KEY> with the license key for your account.

https://<DOMAIN>/api/1/saml/auth?provider=<PROVIDER_ID>&redirectTo=%2Fapps%2Fgenesys%2Findex.html%3Fenv%3Dwde%26interactionId%3D%24Interaction.Id%24%26license%3D<YOUR_LICENSE_KEY>

Now when opening the COBROWSE tab from within WDE you should be taken to your SSO provider allowing you to sign in and be authenticated within WDE.

Troubleshooting

Why is the COBROWSE tab always blank?

How do I debug the COBROWSE tab?

Please enable the optional setting cobrowse.debug = true as described above.

This will provide additional logging from the COBROWSE tab to the Genesys Workspace Desktop Edition logs.

The plugin will also activate remote debugging of the web app on port 9222. Open MS Edge, go to edge://inspect/#devices and the plugin will appear there:

See for more detail.

If you wish to sign into Cobrowse from within WDE using SSO you must first follow our documentation to .

With SAML configured, visit the page of your Cobrowse dashboard and look to the login page URL seen within the SAML Config section. It should look something like https://<DOMAIN>/login/saml/<PROVIDER_ID>.

Please verify if your version of Genesys Workspace Desktop Edition is 8.5.147.05+. If you are running an earlier version, or if you are running a supported version which still faces this issue, please contact us at .

WebView2
setup SAML
integration settings
hello@cobrowse.io
--proxy-bypass-list
Screenshot of GAX configuration for interaction-workspace