Skip to main content
Skip table of contents

Deployment Guide

Deployment Prerequisite

 Before the start of this guide, please make sure that the Agent Desk Application is deployed. You can go ahead and deploy the EFCX following the steps.

CTI Installation and Configuration

Before the phone communication channel between customer service agents and external customers can be used, Customer Service Management and Openframe plugins must be activated and configured.

Before you begin, Please make sure you have a CRM administrator role.

Procedure

  1. Activate the Customer Service plugin (com.sn_customerservice).

  2. Activate the Openframe plugin (com.sn_openframe).

  3. Create an OpenFrame Configuration or use the default CTI configuration by enabling the Default field.

*plugins are installed by default when deploying the application from the marketplace.

Update PhoneLog fields

  1. Search Tables and click on Tables option under system definition.

image-20240930-103748.png
  1. Search Phone Log table and click on Phone Log from the list.

  2. Change the application scope and update to Openframe as shown in image.

image-20240930-104029.png
  1. Click on New button to add the extra fields needed to run the EFCX Servicenow connector.

  2. You have to add fields for Account.

Name of fields

Value

Type

Reference

Column label

Account

Column name

u_account (will fetch automatically)

Applications

Openframe

Reference Specification

Reference = Account (customer_account)

  1. Click on Submit button on the top right.

image-20240930-105125.png
  1. Now fields for Conversation Type

Name of fields

Value

Type

String

Column label

Conversation Type

Column name

u_conversation_type (will fetch automatically)

Applications

Openframe

Max Length

250

image-20240930-104305.png
  1. Click on Submit button on the top right.

While adding fields, ensure that your application scope is Openframe and your column names start with u_account and u_conversation_type.

Change the Phone Log Fields Label

  1. Search the Phone Log table and click on "Phone Log" from the list.

  2. Then, select the columns Recording URL, Call ID and Call Type to change the label.

  3. First, update the label of Recording URL to “Additional Information” then Call ID to “Conversation ID” and then update Call Type to “Conversation Direction”.

image-20240930-113538.png

While adding or updating the fields value/label the Application scope must be Openframe

Design the Phone Log Table

  1. Search Phone Log table and click on Phone Log from the list.

  2. Click on Form Builder from the related links on bottom of the page.

image-20241008-053302.png
  1. Now click on Edit in orignal scope.

  2. Now drag and drop the following fields:

Fields Name
  1. Conversation ID

  2. Start Time

  3. Conversation Direction

  4. Contact

  5. Account

  6. End Time

  7. Phone Number

  8. Task

  9. Duration

  10. Conversation Type

  11. Additional Information

  12. Agent

  1. Now click on Save.

Install EFCX Servicenow Connector

  1. Download the package of EFCX ServiceNow Connector.

  2. Login to servicenow CRM with admin role.

  3. Search and go to Retrieved updates sets options.

image-20240930-102336.png
  1. And click on Import Update Set from XML option.

  2. Select the downloaded package from your device.

  3. Once it is imported, click on the package and choose Preview update set button.

image-20240930-102845.png
  1. After that click on Commit Update Set button and your package will be installed in your servicenow.

Create an OpenFrame configuration

This configuration specifies the OpenFrame window settings as well as the URL to be launched within OpenFrame.

Before you begin

Role required: admin

As part of the OpenFrame configuration, users with the admin role can select one or more user groups. Access to the configuration is limited to the users who have the open-frame user role and that belong to the selected groups.

OpenFrame user roles

The OpenFrame window is available to agents who belong to one of the user groups specified in the OpenFrame configuration and with any of the following roles:

  1. sn_openframe_user ( This is a minimum role that is required)

  2. sn_customerservice_agent

  3. sn_customerservice.consumer_agent admin (This is only required for the installation and configuration not required for the agents)

  4. x_expe4_snowefcxv_cti.CTI_Role (Mandatory Role required)

Adding the OPEN Frame Configurations

  1. Click on All >>Openframe >> select configurations & then ‘New

    openframe.jpg
    image-20240930-110059.png

  2. *Show presence indicator when checked Only the agent can see the phone icon.

When the above roles are provided no user group should be selected or the above-mentioned roles must be part of some user group when selected.\

  1. URL = x_expe4_snowefcxv_cti and then click on Submit.

  2. When clicked on the phone icon in the top window the integration will look like

Agent Login.png
  1. If we open the EFCX application from All >> Agent workspace then it will look like this

Agent Workspace Login.png

Add configurations

  1. Search Studio and click on the Studio under the System Applications.

  2. Now search your application name “servicenowefcxvoice” and select the application.

  3. Go to GetConfigData file under script include.

  4. In the Entities field configData.entities provide the priority for searching Contact, Account in your application like “contact,account”, all values need to be in small letters.

  5. In the noMatchEntity field configData.noMatchEntity provide new entity you want to create when there is no matching number in CRM like "Account".

  6. In the Destination_Number field configData.Destination_Number provide the configured dialed number for queue in order to make calls like “1333“.

For the "Destination Number" field, you need to provide the "Service Identifier" that you have configured for the Voice channel in Unified Admin of EFCX. If the voice channel is not configured, you can follow this guide.

  1. In the iframeUrl configData.IframeURL field provide the deployed EFCX URL (https://<fqdn>/unified-agent/).

image-20240930-110924.png
  1. Now click on Update.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.