Integrate Flex with Glance Cobrowse

To integrate the Glance Cobrowse Component with Flex, you need the following:

• Twilio Account and Flex Project

• Glance Account that has the Flex domain added to the allowlist.
  To add the Flex domain to the allowlist:

  • Log in to your Glance Account.
  • Go to Settings > Cobrowse Settings > CRM and Chat Integration.
  • Enter flex.twilio.com to the domain and select Add.

• Site that is configured with the Glance Cobrowse script tag.
  Ensure that you:

  • Set data-presence to api.
  • Set data-cookiedomain to the URL for your website domain.

Example of the Glance Cobrowse script tag:

1
<script id="glance-cobrowse" type="text/javascript"
2
  src="https://[cdnname].glancecdn.net/cobrowse/CobrowseJS.ashx?group=[groupid]&site=[production|staging]"
3
  data-groupid="[groupid]"
4
  data-site="[production|staging]"
5
  data-inputevents='{...}'
6
  data-termsurl="[terms and conditions url]"
7
  data-cookiedomain="[session cookie domain]"
8
  data-cookietype="[normal|ls|dual|secure]"
9
  charset="UTF-8"
10
  data-presence="api">
11
</script>

To integrate the Glance Cobrowse Component with Flex, you must:

1. Set up authentication.
2. Install the Glance Cobrowse Component from NPM.
3. Add the Glance Cobrowse Component to the Flex interface.
4. Install Flex WebChat and add Glance.
5. (Optional) Enable Glance Agent Video.

In order to connect to Glance from Flex, you need to set up authentication. Glance uses the same user ID from the identity provider to call a Twilio Function to authenticate into Glance.

• You have configured SSO with an identity provider (such as Okta) for Flex.
• You have a Glance Admin account.
• If you are setting up Glance Cobrowse for multiple agents, each agent has a Glance Account.
• You have set the Partner User ID (PUID) field in Glance to match the user ID in your identity provider. To set your user ID:

  • Log in to your Glance account.

  • Go to Portal > Edit Users.

  • For Parter UID, enter the user ID from your identity provider.

    Expand image

  • Select Update User.

To set up authentication:

1. From the Twilio Console > Functions > Services, select Create Service.

2. Enter a Service Name then select Next.
   For example: yourcompanyname-glance. Note: Remember this Service Name to use it later when adding the Glance Cobrowse Component to Flex.

3. Select Add+ > Add Function.
   A new field appears.

4. Remove the default name /path_1 and input getloginkey. Click enter to generate the function.

5. Click the drop-down next to Protected to set the visibility to Public.

6. In the text editor on the right, paste the code below then select Save.

   Copy code block

   1
   const TokenValidator = require('twilio-flex-token-validator').functionValidator;
   2
   
   3
   exports.handler = TokenValidator(function(context, event, callback) {
   4
      const response = new Twilio.Response();
   5
   
   6
      response.appendHeader('Access-Control-Allow-Origin', '*');
   7
      response.appendHeader('Access-Control-Allow-Methods', 'GET', 'POST');
   8
      response.appendHeader('Access-Control-Allow-Headers', 'Content-Type');
   9
      response.appendHeader('Content-Type', 'application/json');
   10
   
   11
      try {
   12
          const version = 1;
   13
          const expires = (Math.round((new Date()).valueOf() / 1000)) + parseInt(context.GLANCE_EXPIRATION, 10);
   14
          const keystring = context.GLANCE_GROUP_ID + event.partneruserid + version + expires;
   15
          const CryptoJS = require('crypto-js');
   16
          const hmac = CryptoJS.HmacSHA256(keystring, context.GLANCE_API_KEY);
   17
          const hmacb64 = hmac.toString(CryptoJS.enc.Base64)
   18
          const loginkey = "$" + version + "$" + expires + "$" + hmacb64.substr(0, 43).replace(/\+/g, '-').replace(/\//g, '_');
   19
   
   20
          response.setBody({
   21
              'loginKey': loginkey,
   22
              'groupId': context.GLANCE_GROUP_ID,
   23
              'expiration': expires,
   24
              'apiKey': context.GLANCE_API_KEY
   25
          });
   26
   
   27
          response.setStatusCode(200);
   28
          callback(null, response);
   29
      } catch(error) {
   30
          response.setStatusCode(404);
   31
          callback(null, response);
   32
      }
   33
   
   34
   });

7. In Settings > Environment Variables, add the following Environment Variables:

   • Add GLANCE_API_KEY and set the value to your Glance API Key. To find your Glance API Key, log in to your Glance account. Go to Settings > API Key.
   • Add GLANCE_EXPIRATION and set the value to a length of time (in seconds) when you want the session to expire. We recommend 3600
   • Add GLANCE_GROUP_ID and set the value to the Glance group ID for your company. Note: The Glance group ID is a unique ID assigned to your company by Glance. You can find this in the Glance portal in the top-right corner of every page.

8. In Settings > Dependencies, add the following dependencies without a version number:

   • twilio-flex-token-validator
   • crypto-js

9. Select Deploy All.

You must add the Glance Cobrowse Component to either an existing or a new Flex Plugin. In your terminal, run:

npm install @glance-networks/twilio-flex-component

If you are using Yarn, run the following instead:

yarn add @glance-networks/twilio-flex-component

For more information, see the ReadMe.

After installing the Glance Cobrowse Component, choose where you want the button to display inside Flex. Learn how to customize Flex UI Components.

Import the component inside your Flex project. In glanceplugin.js (note: the name of the plugin is autocreated when you make the file) or .jtx file, add the following to the first line:

import {TwilioFlexGlance} from @glance-networks/twilio-flex-component

Example of the Glance Cobrowse Component inside the task canvas header:

1
flex.TaskCanvasHeader.Content.add(
2
   <TwilioFlexGlance
3
      key={[yourkey]}
4
      groupid={[yourgroupid]}
5
      authurl={[yourauthurl]}
6
      authtoken={flex.Manager.getInstance().user.token}
7
      openlocation={'tab|window|flex'}
8
      presence={true}
9
      glancebaseurl={'beta|staging|production'}
10
      puid={flex.Manager.getInstance().user.identity}
11
      debugmode={true|false}
12
   />, {options}
13
);

Example of the Glance Component inside the CRM Container:

Note: If you are opening sessions inside the iframe, you must use the CRM Container. You should not use this option if you need this panel for other content, as it will fill the contents of the entire panel with the Glance Cobrowse session.

1
flex.CRMContainer.Content.replace(
2
   <TwilioFlexGlance
3
      key={[yourkey]}
4
      groupid={[yourgroupid]}
5
      authurl={[yourauthurl]}
6
      authtoken={flex.Manager.getInstance().user.token}
7
      openlocation={'tab|window|flex'}
8
      presence={true}
9
      glancebaseurl={'beta|staging|production'}
10
      puid={flex.Manager.getInstance().user.identity}
11
      debugmode={true|false}
12
   />, {options}
13
);

Important: In the cases above, AgentDesktopView.Panel2 is open or closed depending on how you set the default properties.

The following table describes the properties inside the component:

You must consume Flex WebChat from the CDN. Glance does not have a NPM package, which is necessary if deploying in a React application.

1. Install Flex WebChat.

2. The following code example contains Flex WebChat and Glance Presence functionality. Update the code with your Account SID and Flex Flow SID:

   Copy code block

   1
   <script>
   2
     const appConfig = \{
   3
       accountSid: "[YOUR_TWILIO_ACCOUNT_SID]",
   4
       flexFlowSid: "[YOUR_FLEX_FLOW_SID]",
   5
       context: \{
   6
         friendlyName: "[YOUR_FIRENDLY_NAME]",
   7
       \},
   8
       startEngagementOnInit: true
   9
     \};
   10
     let sessionid = undefined;
   11
   
   12
    Twilio.FlexWebChat.createWebChat(appConfig)
   13
       .then(webchat => \{
   14
           const \{ manager \} = webchat;
   15
   
   16
           Twilio.FlexWebChat.Actions.on("afterSendMessage", () => \{
   17
             const {channelSid} = manager.store.getState().flex.session;
   18
             if (!sessionid || sessionid !== channelSid) \{
   19
              manager
   20
               .chatClient.getChannelBySid(channelSid)
   21
               .then(channel => \{
   22
                let visitor = new GLANCE.Presence.Visitor(\{
   23
                 groupid: document.getElementById("glance-cobrowse").getAttribute("data-groupid"),
   24
                 visitorid: channel.sid
   25
                \});
   26
                visitor.onerror = function (e) \{
   27
                 console.log("presence error:", e);
   28
                \};
   29
                visitor.presence(\{
   30
                 onsuccess: function () \{
   31
                  console.log("presence success");
   32
                 \}
   33
                \});
   34
                visitor.onsignal = function (msg) \{
   35
                 console.log("received signal:", msg);
   36
                \};
   37
                visitor.connect();
   38
   
   39
               \});
   40
              sessionid = channelSid;
   41
             \}
   42
            \});
   43
   
   44
            webchat.init();
   45
   
   46
           \});
   47
   </script>

3. Set up a Flow for Flex WebChat:

   • From the Twilio Console > Studio > Manage Flows, select Webchat Flow.

   • In the Widget Library > Flow Control, select and drag Set Variables onto the canvas. Click the widget to edit.

   • Click the plus sign on the right side of Variables.

   • For Key, input glance_visitor_id.

   • For Value, input {{trigger.message.ChannelSid}}.

   • Save the variable.

   • Save the widget.

   • Wire the widget to the Incoming Message Trigger.

   • In the Widget Library > Connect Other Products, select and drag Send to Flex onto the canvas. Click the widget to edit.

   • For Workflow, select Assign to Anyone.

   • For Channel, select Programmable Chat.

   • For Attributes, input {"name": "{{trigger.message.ChannelAttributes.from}}", "channelType": "{{trigger.message.ChannelAttributes.channel_type}}", "channelSid": "{{trigger.message.ChannelSid}}", "glance_visitor_id": "{{flow.variables.glance_visitor_id}}"}

   • Save the widget.

   • Wire the widget to the Set Variable Widget that you just created.

   • Select Publish.

     Expand image

You may want to move the location of the Glance Cobrowse button on your website so that it does not interfere with Flex WebChat.

1. Log in to your Glance Account.

2. Go to Settings > Button Customization and add the following CSS under the Custom CSS section:

   Copy code block

   1
   #glance_cobrowse_btn{
   2
      left: 20px !important;
   3
      right: auto !important;
   4
   }

Personalizing a Glance Cobrowse session with Glance Video lets your agents build trust, confidence, and credibility with customers. You can enable either one-way agent video, or multi-way video where the customer will be prompted to optionally share their video during the session.

1. Log in to your Glance account.

2. From Settings, select one of the following options depending on the video experience you want:

   • Add one-way video during screenshare or cobrowse sessions
   • Add multi-participant video during cobrowse sessions

Once enabled, Glance Video starts with the Glance Cobrowse session. To pause Glance Video, click the Video button in the agent viewer.