Cisco Finesse

Introduction

Cisco Finesse is a next-generation agent and supervisor desktop designed to provide a collaborative experience for the various communities that interact with your customer service organization. It helps improve the customer experience while offering a user-centric design to enhance customer care representative satisfaction as well.

Cisco Finesse provides:

  • A browser-based administration console and a browser-based desktop for agents and supervisors; no client-side installations required.

  • A single, customizable "cockpit", or interface, that gives customer care providers quick and easy access to multiple assets and information sources.

  • REST APIs that simplify the development and integration of value-added applications and minimize the need for detailed desktop development expertise.

Finesse configuration changes are permitted on only the primary server. Access to Finesse administration console on the secondary server is read-only.

When you attempt to save the changes in Finesse administration console on the secondary node, you receive a message that administration on the secondary node is read-only.

Cisco Finesse Administration Console

Getting Started

This chapter describes the interfaces that you use to configure, administer, and maintain Cisco Finesse and describes how to access them.

Administration Tools

Cisco Finesse Administration Console

The Cisco Finesse administration console is a web-based interface used to configure system settings in Cisco Finesse. The administration console contains tabs to click and access the various administration features. The tab names and the associated tasks are:

  • Settings: IP Phone Agent Settings.

  • Call Variables Layout: Manage the call and ECC variables that appear on the agent desktop call control gadget, team performance gadget, and call popover.

  • Desktop Layout: Make changes to the default desktop layout for agents and supervisors.

  • Phone Books: Add, edit, or delete phone books or phone book contacts.

  • Reasons: Add, edit, or delete Not Ready reason codes, Sign Out reason codes, or Wrap-Up reasons (Reason Codes are disabled for Packaged CCE deployments).

  • Team Resources: Assign desktop layouts, phone books, reason codes, and wrap-up reasons to specific teams.

  • Workflows: Create and manage workflows and workflow actions.

The features you configure in the administration console are case-sensitive. For example, you can create two workflows named WORKFLOW and workflow; or two phone books named BOOK and book.

Response Caching

To reflect the changes made to system settings in Finesse desktop, the administrator must clear server cache using the CLI utils webproxy cache clear rest. Ensure that the agent browser is refreshed for the system settings changes to take effect.

For more information of REST API Response Caching, see Cisco Finesse Web Services Developer Guide at https://developer.cisco.com/docs/finesse/#!rest-api-dev-guide.

Sign In to Cisco Finesse Administration Console

You can access the Cisco Finesse administration console only through HTTPS.

When you sign in to Cisco Finesse, always use the fully qualified domain name (FQDN) of the Cisco Finesse server in the URL.

Procedure

Step 1

Direct your browser to https://<FQDN>:8445/cfadmin, where FQDN is the fully qualified domain name of your primary Finesse server.

Step 2

The first time when you access the administration console using HTTPS, you are prompted to trust the self-signed certificate provided with Finesse. The following table describes the steps for each supported browser.

Note 

If you are using HTTPS but have installed a CA Certificate, you can skip this step. For more information about installing a CA Certificate, see Cisco Finesse Installation and Upgrade Guide at https://www.cisco.com/c/en/us/support/customer-collaboration/finesse/products-installation-guides-list.html.

Option Description

Internet Explorer:

  1. A page appears that states this site is untrusted.

  2. Click More information > Go on to the webpage.

Microsoft Edge:

  1. A page appears that states this site is untrusted.

  2. Click Details and click Go on to the webpage.

Firefox:

  1. A page appears that states this connection is untrusted.

  2. Click I Understand the Risks, and then click Add Exception.

  3. In the Add Security Exception dialog box, ensure that the check box isPermanently store this exception checked.

  4. Click Confirm Security Exception.

Chrome:

  1. A page appears that states this connection is not private.

  2. Click Advanced > Proceed to <Hostname> (unsafe)

Step 3

On the Sign In page, in the ID field, enter the Application User ID that was used during the installation.

Step 4

In the Password field, enter the Application User password that was used during the installation.

Step 5

Click Sign In.

A successful sign-in launches an interface with defined administration gadgets and a Sign Out link.



Note

After 30 minutes of inactivity, Cisco Finesse automatically signs you out of the administration console and you must sign in again.


Sign In Using IPv6

If you sign in to the Finesse Administration Console using an IPv6-only client, include the HTTPS port in the sign in URL in Step 1 of the preceding procedure.

https://<FQDN>:8445/cfadmin

The remaining steps of the sign in procedure remain the same for IPv6.

If you sign in to the Finesse Administration Console using an IPv6-only client, include HTTPS port in the sign in URL in Step 1 of the preceding procedure.

  • For HTTPS access, enter:

    https://<FQDN>:8445/cfadmin

The remaining steps of the sign in procedure remain the same for IPv6.

Account Locked after Five Failed Sign in Attempts

If an administrator tries to sign in to the Finesse administrator console (or diagnostic portal) with the wrong password five times consecutively, Finesse blocks access to that user account for 30 minutes. For security reasons, Finesse does not alert the user that their account is locked. They must wait 30 minutes and try again.

Similarly, if agents or supervisors sign in to the desktop five times consecutively with the wrong password, Finesse blocks access to that user account. However, in this case, the lockout period is 5 minutes. This restriction also applies when agents and supervisors sign in using the mobile agent or Finesse IP Phone Agent (IPPA).


Note

When an agent or supervisor account is locked, subsequent attempts to sign in, even with correct credentials, reset the lockout period to 5 minutes again. For example, if a locked user tries to sign in again after only 4 minutes, the lockout period is reset and the user must wait another 5 minutes. This reset does not apply to the administrator account.


To view if a user account is locked, enter the file get activelog desktop recurs compress CLI command.

Extract the zipped output and search the catalina.out logs (/opt/cisco/desktop/finesse/logs/catalina.out) for the following message referring to the locked username:

An attempt was made to authenticate the locked user "<username>"
Cisco Unified Operating System Administration

This interface is web-based and is used to perform the following system administration functions:

  • Show: View information on cluster nodes, hardware status, network configuration, installed software, system status, and IP preferences.

  • Settings: Display and change IP settings, network time protocol (NTP) settings, SMTP settings, time, and version.

  • Security: Manage certificates and set up and manage IPSec policies.

  • Software Upgrades: Perform and upgrade or revert to a previous version.

  • Services: Use the Ping and Remote Support features.

Sign In to Cisco Unified Operating System Administration
Procedure

Step 1

Direct your browser to https://FQDN:8443/cmplatform, where FQDN is the fully-qualified domain name of your server.

Step 2

Sign in with the username and password for the Administrator User account.

Note 

After you sign in, you can access other Unified Communications Solutions tools from the Navigation drop-down list.


Certificate Management

Finesse provides a self-signed certificate that use or provide a CA certificate. You can obtain a CA certificate from a third-party vendor or produce one internal to your organization.

Finesse does not support wildcard certificates. After you upload a root certificate signed by a certificate authority (CA), the self-signed certificates are overwritten.

If you use the Finesse self-signed certificate, agents must accept the security certificates the first time they sign in to the desktop. If you use a CA certificate, you can accept it for the browser on each client or deploy a root certificate using group policies.


Note

If there is a mismatch between the server hostname and the certificate hostname, a certificate address mismatch warning message is displayed in IE. The certificate must be regenerated so that the hostname matches the server hostname before importing to Finesse. If there is a valid reason for the mismatch, uncheck the Warn about certificate address mismatch checkbox from Tools > Internet Options > Advanced > Security to allow the certificate to be accepted.


Obtain and Upload CA Certificate

Note

This procedure only applies if you are using HTTPS and is optional. If you are using HTTPS, you can choose to either obtain and upload a CA certificate or use the self-signed certificate provided with Finesse.


To eliminate browser security warnings each time you sign in, obtain an application and root certificate signed by a CA. Use the Certificate Management utility from Cisco Unified Operating System Administration.

To open Cisco Unified Operating System Administration in your browser, enter:

https://hostname of primary UCCX server/cmplatform

Sign in using the username and password for the Application User account created during Finesse installation.


Note

You can find detailed explanations in the Security topics of the Cisco Unified Operating System Administration Online Help.


Procedure

Step 1

Generate a CSR.

  1. Click Security > Certificate Management > Generate CSR.

  2. From the Certificate Name drop-down list, choose tomcat and click Generate CSR.

Step 2

Download the CSR.

  1. Select Security > Certificate Management > Download CSR.

  2. From the Certificate Name drop-down list, choose tomcat and click Generate CSR.

Step 3

Generate and download a CSR for the secondary Unified CCX server.

To open Cisco Unified Operating System Administration for the secondary server in your browser, enter:

https://hostname of secondary UCCX server/cmplatform

Step 4

Use the CSRs to obtain the CA root certificate, intermediate certificate, and signed application certificate from the Certificate Authority.

Note 

To set up the certificate chain, you must upload the certificates in the order described in the following steps.

Step 5

When you receive the certificates, click Security > Certificate Management > Upload Certificate.

Step 6

Upload the root certificate.

  1. From the Certificate Purpose drop-down list, select tomcat-trust.

  2. In the Upload File field, click Browse and browse to the root certificate file.

  3. Click Upload File.

Step 7

Upload the intermediate certificate.

  1. From the Certificate Purpose drop-down list, choose tomcat-trust.

  2. In the Upload File field, click Browse and browse to the intermediate certificate file.

  3. Click Upload File.

Step 8

Upload the application certificate.

  1. From the Certificate Purpose drop-down list, choose tomcat.

  2. In the Upload File field, click Browse and browse to the application certificate file.

  3. Click Upload File.

Step 9

Restart both the Unified CCX nodes in the cluster.


Client-Side Certificate Acceptance

There are procedures that agents must perform to accept certificates the first time they sign in. The procedure type depends on the method you choose to manage certificates and the browser used by the agents.

Deploy Root Certificate for Internet Explorer

In environments where group policies are enforced via the Active Directory domain, the root certificate can be added automatically to each user's Internet Explorer. Adding the certificate automatically simplifies user configuration requirements.


Note

To avoid certificate warnings, each user must use the FQDN of the Finesse server to access the desktop.


Procedure

Step 1

On the Windows domain controller, navigate to Administrative Tools > Group Policy Management.

Note 

Users who have strict Group Policy defined on the Finesse Agent Desktop have to disable Cross Document Messaging from Group Policy Management to ensure proper functioning of Finesse on Internet Explorer 11.

Step 2

Right-click Default Domain Policy and select Edit.

Step 3

In the Group Policy Management Console, click Computer Configuration > Policies > Window Settings > Security Settings > Public Key Policies.

Step 4

Right-click Trusted Root Certification Authorities and select Import.

Step 5

Import the ca_name.cer file.

Step 6

Go to Computer Configuration > Policies > Windows Settings > Security Settings > Public Key Policies > Certificate Services Client - Auto-Enrollment.

Step 7

From the Configuration Model list, select Enabled.

Step 8

Sign in as a user on a computer that is part of the domain and open Internet Explorer.

Step 9

If the user does not have the certificate, run the command gpupdate.exe /target:computer /force on the user's computer.


Set Up CA Certificate for Internet Explorer and Edge Browsers

After obtaining and uploading the CA certificates, the certificate must be automatically installed via group policy or all the users must accept the certificate.

In environments where users do not log in directly to a domain or where group policies are not utilized, every Internet Explorer user in the system must perform the following steps one time to accept the certificate:

Procedure

Step 1

In Windows Explorer, double-click the ca_name.cer file and then click Open.

Note 

Here the ca_name is the name of your certificate.

Step 2

In the Certificate Import Wizard, select Current User.

Step 3

Click Install Certificate > Next > Place all certificates in the following store.

Step 4

Click Browse and choose Trusted Root Certification Authorities.

Step 5

Click OK > Next > Finish.

Step 6

Click Yes on the install a certificate from a CA prompt.

Step 7

To verify that the certificate was installed, from the browser menu on IE, choose Tools > Internet Options.

Step 8

In the Content tab, click Certificates.

Step 9

In the Trusted Root Certification Authorities tab, ensure that the new certificate appears in the list.

Step 10

Restart the browser for the certificate installation to take effect.

Note 

If you are using Internet Explorer 11, you may receive a prompt to accept the certificate even if it is signed by a private CA.


Set Up CA Certificate for Firefox Browser

Every Firefox user in the system must perform the following steps once to accept the certificate:


Note

To avoid certificate warnings, each user must use the FQDN of the Unified CCX server to access the desktop.


Procedure

Step 1

From the Firefox browser menu, choose Options.

Step 2

Go to Privacy and Security tab.

Step 3

Under Certificates section, click View Certificates.

Step 4

Select Authorities.

Step 5

Click Import and browse to the ca_name.cer file.

Note 

Here the ca_name is the name of your certificate.

Step 6

Check the Validate Identical Certificates check box.

Step 7

Restart the browser for the certificate to install.


Set Up CA Certificate for Chrome Browser
Procedure

Step 1

In the browser, go to Settings.

Step 2

In the Chrome browser, select Advanced Settings > Privacy and Security, click Manage Certificates.

Step 3

Click Trusted Root Certification Authorities tab.

Step 4

Click Import and browse to the ca_name.cer file.

In the Trusted Root Certification Authorities tab, ensure that the new certificate appears in the list.
Step 5

Restart the browser for the certificate to install.


Trust Self-Signed Certificate

Trust the self-signed certificate provided by Finesse to eliminate browser warnings each time you sign in to the administration console or agent desktop.

If you have uploaded a CA certificate, you can skip this procedure.

Procedure

In your browser, enter the URL for the administration console (https://FQDN of primary server:portnumber/cfadmin) or the agent desktop (https://FQDN of primary server).

Option Description

If you use Internet Explorer:

  1. A page appears that states there is a problem with the website's security certificate. Click Continue to this website (not recommended). The sign in page for the administration console (or agent desktop) appears with a certificate error in the address bar if the browser.

  2. Click Certificate Error > View Certificates to open the Certificate dialog box.

  3. In the Certificate dialog box, click Install Certificate to open the Certificate Import Wizard.

  4. Click Next.

  5. Choose Place all certificates in the following store and click Browse.

  6. Choose Trusted Root Certification Authorities and click OK.

  7. Click Next > Finish

  8. If a Security Warning dialog box appears asking if you want to install the certificate, click Yes.

  9. In the Successful Certificate Import dialog box, click OK.

  10. Enter your credentials and click Sign In.

If you use Firefox:

  1. A page appears that states this connection is untrusted.

  2. Click I Understand the Risks Add Exception.

  3. In the Add Security Exception dialog box, ensure the Permanently store this exception check box is checked.

  4. Click Confirm Security Exception.

    The page that states this connection is untrusted automatically closes and the administration console (or agent desktop) loads.

  5. Enter your credentials and click Sign In.

  6. For the agent desktop only, an error appears that states Finesse cannot connect to the Cisco Finesse Notification Service and prompts you to add a security exception for the certificates issued by the Finesse server.

    Click OK.


Add Certificate for HTTPS Gadget

Add a certificate for a secure HTTP (HTTPS) gadget to load the gadget on the Finesse desktop and successfully perform HTTPS requests to the Finesse server.

This process allows HTTPS communication between the Finesse gadget container and the third-party gadget site for loading the gadget and performing any API calls the gadget makes to the third-party server.


Note

A gadget that loads using HTTPS may still use HTTP communication between that gadget and the application server where it resides. If all traffic must be secure, the gadget developer must ensure that HTTPS is used to make API calls to the application server.


The certificate must be signed with a common name. The gadget URL in the desktop layout must use the same name (whether it uses an IP address or an FQDN) as the name with which the certificate is signed. If the certificate name and the name in the gadget URL don’t match, the connection isn’t trusted, and the gadget doesn’t load.

To find the certificate name, enter the gadget URL in your browser. Click the lock icon in the address bar and then click View Details. Look for the common name field.

The Finesse host must be able to resolve this name using the DNS host entered during the installation. To verify that Finesse can resolve the name, run the CLI utils network ping <hostname> command.

Procedure

Step 1

Download the certificate from the third-party host running a Cisco-provided solution.

Step 2

Upload the certificate to the designated Finesse system.

  1. Sign in to Cisco Unified Operating System Administration on the primary Unified CCX node (https://FQDN/cmplatform, where FQDN is the fully qualified domain name of the Unified CCX node).

  2. Click Security > Certificate Management.

  3. Click Upload Certificate/Certificate Chain.

  4. From the Certificate Name drop-down list, select tomcat-trust.

  5. Click Browse and navigate to the tomcat.pem file that you downloaded in the previous step.

  6. Click Upload File.

Step 3

Restart Cisco Tomcat on the primary Unified CCX node.

Step 4

Restart Cisco Finesse Tomcat on the primary Unified CCX node.

Step 5

After synchronization is complete, restart Cisco Tomcat on the secondary Unified CCX node.

Step 6

Restart Cisco Finesse Tomcat on the secondary Unified CCX node.


Add Certificate for Multi-session Chat and Email

Add the Customer Collaboration Platform certificate to the Unified CCX servers to allow communication between Customer Collaboration Platform and Finesse. After you complete this procedure, agents must accept certificates in the Finesse desktop before they can use this gadget.

If Customer Collaboration Platform is deployed with private certificates, agents cannot join chat rooms or reply to email messages until they accept the Customer Collaboration Platform certificates. If the Manage Chat and Email gadget is deployed on the Manage Chat and Email tab of the Finesse desktop, agents may not realize that they need to accept the certificates. Have agents check the tab where the gadget appears when they sign in to Finesse to make sure that certificates are all accepted and the gadget loads correctly.

The steps to add a certificate for the Manage Chat and Email gadget are the same as the steps outlined in the procedure Add Certificate for HTTPS Gadget.


Note

The procedure to add a certificate for an HTTPS gadget refers to the third-party gadget host. To add a certificate for chat and email, perform the applicable steps on the Customer Collaboration Platform server.


Manage System Settings


Note

For information about Finesse IP Phone Agent Settings, see Manage Finesse IP Phone Agent.


Desktop Chat Server Settings

Desktop Chat is an XMPP browser based chat, which is powered by Cisco Instant Messaging and Presence (IM&P) service. It provides presence and chat capabilities within the Unified CM platform. For more details, see Configuration and Administration of the IM and Presence Service at https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-installation-and-configuration-guides-list.html.

Desktop Chat connects to Cisco IM&P servers over port 5280 from the browser hosting the agent desktop. IM&P server visibility and port accessibility needs to be ensured if clients intend to use this feature. The Desktop Chat gadget configures the IM&P host BOSH URL’s used by the desktop to communicate with the IM&P server over BOSH HTTP.

IM&P has a clustered design, where users are distributed across multiple nodes in the cluster. The Desktop Chat initially discovers the IM&P nodes that a user has configured, caches this information and communicates with the actual server for subsequent login, until the browser cache is cleared. To spread the initial discovery load, it is advisable to configure the nodes in a round robin fashion if the deployment has more than one Finesse cluster. For example, if there are 5 IM&P nodes configure Finesse cluster A with node 1 & 2, Finesse cluster B with nodes 3 & 4, and so on.

Node availability should be considered while configuring the IM&P URL. The secondary node will be available for discovery in scenarios where the first node is not reachable. The secondary node will be connected for discovery only if the primary node is unreachable.

For the URL to be configured, refer Cisco Unified Presence Administration service, in System, Service Parameters. Choose the required IM&P server, select Cisco XCP Web Connection Manager. The URL binding path is listed against the field HTTP Binding Path. The full URL to be configured in Finesse is https://<hostname>:5280/URL-binding-path.

Use the Desktop Chat Server Settings to configure chat settings for the Finesse desktop. The following table describes the fields on the Desktop Chat Server Settings gadget.

Field

Explanation

Primary Chat Server

Enter the IM&P primary server URL of Desktop Chat.

Secondary Chat Server

Enter the IM&P secondary server URL of Desktop Chat.

Actions on the Desktop Chat Server gadget:
  • Save: Saves your configuration changes

  • Revert: Retrieves the most recently saved server settings


Important

For Desktop Chat to work without any issues, ensure the following services are running on IM&P:

  • Cisco Presence Engine

  • Cisco XCP Text Conference Manager

  • Cisco XCP Web Connection Manager

  • Cisco XCP Connection Manager

  • Cisco XCP Directory Service

  • Cisco XCP Authentication Service

  • Cisco XCP File Transfer Manager



Note

Desktop Chat requires the Cisco IM and Presence certificates to be trusted. To start the Desktop Chat without experiencing an exception, you must add the certificate to the browser trust store, or configure IM and Presence with CA-signed certificate, or push self-signed certificate through group policies in supported browsers. For more information on accepting certificates, see the Accept Security Certificates section, in the Common Tasks chapter of Cisco Finesse Agent and Supervisor Desktop User Guide for Cisco Unified Contact Center Express at https://www.cisco.com/c/en/us/support/customer-collaboration/unified-contact-center-express/products-user-guide-list.html.

For more information on adding certificates to the browser trust store, see Certificate Management.



Note

Desktop Chat is not supported with the unrestricted versions of IM&P.


Configure Desktop Chat Server Settings
Procedure

Step 1

Sign in to the administration console with the Application User credentials.

Step 2

In the Desktop Chat Server Settings area, enter the IM&P primary and secondary server URL of the Desktop Chat.

Step 3

Click Save.

Note 

Desktop Chat requires Cisco Unified Presence 12.5 and higher versions.


Cloud Connect Server Settings

Cloud Connect is a component that hosts services that allow customers to use cloud capabilities such as Cisco Webex Experience Management. The administrator can configure the Cloud Connect server settings in the Finesse administration console to contact the Cisco cloud services.

For more information, see the Cisco Webex Experience Management Survey section in Cisco Unified Contact Center Express Features Guide at https://www.cisco.com/c/en/us/support/customer-collaboration/unified-contact-center-express/products-feature-guides-list.html.

The following table describes the fields on the Cloud Connect server settings gadget:

Field

Explanation

Username

(mandatory) The Cloud Connect administrator username required to sign in to Cloud Connect.

Password

(mandatory) The Cloud Connect administrator password required to sign in to Cloud Connect.

Publisher Address

(mandatory) The hostname of the Cloud Connect publisher.

Subscriber Address

(optional) The hostname of the Cloud Connect subscriber.

Actions on the Cloud Connect Server Settings gadget:

  • Save: Saves your configuration changes.

  • Revert: Retrieves the most recently saved Cloud Connect server settings.

Configure Cloud Connect Server Settings
Procedure

Step 1

Sign in to the administration console on the primary UCCX server using the URL: https://FQDN of Unified CCX server:8445/cfadmin.

Step 2

Select Settings > Cloud Connect Server Settings.

Step 3

Enter the Username, Password, and Publisher Address of the Cloud Connect server.

(optional) Enter the Subscriber Address for multinode deployment.

Step 4

Click Save.


Keyboard Shortcuts

Keyboard shortcuts provide an alternate way to perform a specific action on the Finesse agent and supervisor desktop. For more information, see Access Keyboard Shortcuts section in the Cisco Finesse Agent and Supervisor Desktop User Guide.

Keyboard Shortcut Conflicts

Keyboard shortcut conflicts occur if multiple gadgets use the same keyboard shortcut. This causes a particular key combination to be disabled until the conflict is resolved.

Keyboard shortcut conflicts at the page level can be resolved only by modifying the keyboard shortcuts at the gadget level. To modify the keyboard shortcuts at the gadget level, contact developer support services.

Keyboard shortcut conflict can occur in the following scenarios:

Conflict Scenario

Resolution

Conflicts can occur between keyboard shortcuts at the page level and gadget level.

This conflict cannot be resolved by the Finesse administrator.

Conflicts can occur when two gadgets have the same keyboard shortcut, and both are in the same tab.

Move one of the gadgets to another tab.

Conflicts can occur when there are multiple instances of the same gadget and focus is on the active tab*.

Move one of the gadgets to another tab.

* - Active tab refers to the tab that is currently being used.

The administrator can use the CLI command to disable the keyboard shortcuts for the Finesse agent and supervisor desktop. For more information on CLI commands, see Desktop Properties.


Note

  • After deploying the third-party gadgets, the administrator must sign in as an agent and a supervisor to check if there are any keyboard shortcut conflicts and resolve them.

  • The third-party gadget providers can use the keyboard shortcuts JavaScript library as a guideline to provide a consistent desktop user experience.


Manage Call Variables Layouts

Call Variables Layouts

You can use the Call Variables Layouts gadget to define how call variables appear on the Finesse agent desktop. You can configure up to 200 unique Call Variables Layouts (one default and 199 custom layouts). As part of this functionality:

  • Each layout has a name (required) and description (optional).

  • You can change the name and description of the default Call Variables Layout.

  • You cannot delete the default Call Variables Layout.

  • Finesse appends (Default) to the name of the default Call Variables Layout.

  • To display a custom Call Variables Layout, in the Unified CCX routing script, set the user.layout ECC variable to the name of a configured Call Variables Layout. In this case, if no custom layouts match the user.layout value (or no custom layouts are configured), Finesse displays the default layout.

  • Finesse retains the custom layout as specified by the user.Layout ECC variable on CTI server failover. During PG failover, Finesse changes the active call layout to the default layout while retaining the call variables and time indicators.

Call Variables

Each Call Variables Layout supports one variable in the header of the call control gadget and up to a total of 20 variables in two columns below the header (up to 10 in each column). You can use call variables, Extended Call Context (ECC) variables, or the following Outbound Option ECC variables:

  • BACampaign

  • BAAccountNumber

  • BAResponse

  • BAStatus

  • BADialedListID

  • BATimeZone

  • BABuddyName

Columns can be empty.

The administrator can include the following additional fields in the Call Variables Layout. These variables appear as a drop-down list in the call variable gadget which the admin can assign to a layout.

  • queueNumber

  • queueName

  • callKeyCallId

  • callKeyPrefix

  • callKeySequenceNum

  • wrapUpReason


Note

The callKeyPrefix indicates the day when the call was routed.

The callKeyCallId indicates the unique number for the call routed on that day.

To uniquely locate the call in Unified CCE database records, concatenate the two variables callKeyPrefix and callKeyCallId.


To enable Outbound Option data to appear in Cisco Finesse, the administrator must edit the Default Layout to include some or all Outbound Option variables.

Edit Call Variables

Administrator can set call variables (callVariable1 to callVariable10) values and ECC variable values as editable. Amongst BA (campaign-based outbound calls) variables, only BAResponse can be edited. The agent and the supervisor can edit the call variable values during an active call or in the wrap-up state.


Note

  • Cisco Finesse refers to the ECC variable length from the AWDB and this length is validated while you edit the ECC variable. Cisco Finesse server takes about 15 minutes to update these changes from AWDB. Agents must sign in again for the ECC variable configuration changes to reflect in the Cisco Finesse desktop.

  • Call variables edit operation updates the values of the variables within the particular call. All entities listening to dialog events receive the updated call variables through the Cisco Finesse notifications. If any CTI clients are connected to the same Agent PG, they also receive notifications of the changed call data though CTI call events. However, application scripts or databases that are used to populate the call variables are not directly affected by this edit.



Note

Call variables edit operation updates the values of the variables within the particular call. All entities listening to dialog events receive the updated call variables through the Cisco Finesse notifications. If any CTI clients are connected to the same Agent PG, they also receive notifications of the changed call data though CTI call events. However, application scripts or databases that are used to populate the call variables are not directly affected by this edit.


Configure Call Variables Layouts

Procedure

Step 1

From the Manage Call Variables Layouts gadget:

  • Click New to create a new Call Variables Layout.

  • Choose a layout from the list and click Edit to modify an existing Call Variables Layout (or click Delete to remove it).
Step 2

Under Create New Layout (or under Edit <layout name> when editing an existing layout):

  • Enter a name for the Call Variables Layout (maximum 40 characters).

  • Enter a description of the Call Variables Layout (maximum 128 characters).

Step 3

Under Call Header Layout:

  • Enter the display name that you want to appear in the header of the Call Control gadget on the Finesse desktop. For example, Customer Name (maximum 50 characters).

  • From the drop-down list, choose the call variable or Outbound Option ECC variable that you want to appear in the header. For example, callVariable3 (maximum 32 characters).

Step 4

In the Call Body Left-Hand Layout and Call Body Right-Hand Layout areas:

  1. Click Add Row to add a new row (or click the "X" to delete a row).

  2. For each row:

    • Enter the display name that you want to appear on the desktop. For example, Customer Name (maximum 50 characters).

    • Enter the corresponding call variable or Outbound Option ECC variable from the drop-down list (maximum 32 characters).

Step 5

Select up to five call variables using the check box. The selected call variables are displayed in agent call popover and supervisor active call details.

Note 

If you do not select any call variables, the first two call variables from the Call Body Left-Hand layout area will be displayed in the agent call popover and supervisor active call details. If there are no call variables in the Left-hand layout area, then the call variables in the Right-Hand Layout will be selected.

Step 6

Turn on the toggle switch to enable the edit option for a specific call variable. By default, this option is turned off.

Note 
  • Call variable (callVariable1 to callVariable10) values are editable.

  • ECC variable values are editable.

  • Amongst BA variables (campaign-based outbound calls), only BAResponse value is editable.

Step 7

Click Save to save the changes, or Cancel to discard the changes.

Note 

When you modify the Call Variables Layout of the agent desktop, the changes you make take effect after three seconds. However, agents or supervisors who are signed in when the changes are made must sign out and sign back in to see those changes reflected on their desktops.

Step 8

To view the latest configured Call Variables Layout, click Refresh from the Manage Call Variables Layouts gadget.


Add ECC Variables to Call Variables Layout

Procedure

Step 1

In the header or the row where you want the ECC variable to appear, from the Variable drop-down list, choose Custom.

Step 2

In the Custom/ECC Variable Name field, enter the name of the ECC variable you want to appear on the agent desktop.

Step 3

Click Set.

The ECC variable now appears in the Variable drop-down list for selection.


Assign Call Variables Layouts

Procedure

Step 1

In Cisco Unified CCX Editor, open the script for which you want to assign ECC call variables.

Step 2

Select Expanded Call Variables from Settings.

Step 3

Click New Variable icon.

Step 4

Create a variable with "user" as prefix.

For example: userSSN

Step 5

In Set Enterprise Call Info step of the script, add or modify the Expanded Call Variables.


Manipulate Call Variables Layouts with a Workflow

You can manipulate the call variables layout that an agent sees when a call is answered by using a workflow. To do so, configure an HTTP Request workflow action and set the value of the ECC variable user. Layout to the name of the custom layout to display.

For information about how and when workflows are executed, see Workflows and Workflow Actions.

For more details, see the section, "Adding an HTTP Request Workflow Action" in the white paper Cisco Finesse: How to Create a Screen-Pop Workflow.

Manage Desktop Layout

You can define the layout of the Finesse desktop on the Desktop Layout tab.


Important

Requirements, such as processor speed and RAM, for clients that access the Finesse desktop can vary. Desktops that receive events for more than one agent (such as agent and supervisor desktops running Live Data reports that contain information about other agents and skill groups) require more processing power than desktops that receive events for a single agent.

Factors that determine how much power is required for the client include, but are not limited to, the following:

  • Contact center traffic

  • Additional integrated gadgets in the desktop (such as Live Data reports or third-party gadgets)

  • Other applications that run on the client and share resources with the Finesse desktop


Gadgets and Components

Gadgets

Cisco Finesse is an OpenSocial gadget, which is an XML document that defines metadata for an OpenSocial Gadget container. The gadgets are applications that are placed within the Cisco Finesse desktop. This helps administrator to provide access to the contact center agents for all the applications that is required to service calls inside a single application.

Cisco Finesse comes with default gadgets such as, the team performance gadget, call control gadget, and call popover. JavaScript library is available for any customers with specific requirements that are not available out of the box.

Gadgets are listed in the desktop layout using the <gadget> tag.


Note

Finesse Desktop is tested to perform well with an average of 20 gadgets per Desktop (across all tabs), over a sign in period of 8 minutes for 2000 users (agents and supervisors). When you increase the total number of gadgets that are configured on the Desktop, the CPU consumption marginally increases during users sign in. When all the configured gadgets are enabled for all the users, it impacts the Finesse server. Higher number of gadgets will also need more browser memory and network bandwidth.

If considerably larger number of gadgets are configured or if more users sign in (more than the tested number of users) in a short time frame, you must monitor the CPU consumption and network bandwidth during users sign in and ensure that the end-point devices have enough memory.

Failover uses optimization to sign in the users quickly and is not considered the same as a new browser sign in.


Third-party gadgets are hosted on the Cisco Finesse server using the 3rdpartygadget web application or on an external web server. Gadgets can make REST requests to services hosted on external servers using the Cisco Finesse JavaScript Library API. To avoid browser cross-origin issues, REST requests are proxied through the backend Shindig web application. Third-party gadgets must implement their own authentication mechanisms for third-party REST services.

For more information about gadgets, see https://developer.cisco.com/docs/finesse/.

Components

Components are simple scripts that are loaded into the desktop directly at predefined positions as directed by the layout, without an enclosing frame and its document.

Components are introduced in the desktop to overcome a few rendering limitations and performance considerations inherent to gadgets.

The <component> tag lists the components in the desktop layout. Currently, the layout validations prevent creating custom components. Hence, default components are allowed in the desktop layouts. The default desktop functionalities are currently registered as components to provide flexibility and to reduce the load on the server.

Finesse Desktop Layout XML

The Finesse Layout XML defines the layout of the Finesse desktop, and the gadgets and components displayed on the desktop.

Use the Manage Desktop Layout gadget to upload an XML layout file to define the layout of the Finesse desktop for agents and supervisors.

Actions on the Manage Desktop Layout gadget are as follows.

  • Edit the code using any of the following editors:

    • Text Editor

    • XML Editor

  • View Default Layout - Displays the Cisco Finesse default layout.

  • Restore Default Layout - Restores the Cisco Finesse desktop to the default layout.

  • Save - Saves your configuration changes.

  • Revert - Retrieves and applies the most recently saved desktop layout.

Default Layout XML

The Finesse default desktop layout XML for Unified CCX contains optional tabs and gadgets for Web Chat and Email, Advanced Supervisor Capabilities, and notes that describe how to modify the layout for your deployment type.

Remove the comments from the optional gadgets and tabs that you want to appear on the Finesse desktop.

Remove any gadgets or tabs that you do not want to use.

The Manage Desktop Layout supports the following types of editors:
  • Text Editor—A plain text editor. It is the default editor. You can use the Expand All option to see all the code details and Search text box to refine your search results.

  • XML Editor—An XML editor.


    Note

    • You cannot add or edit comments (<!-- and -->) in the XML Editor.

    • In this document, all the examples that are related to desktop layout are applicable for text editor.


Both the editors support the following features:

  • Expand and collapse option

  • Syntax highlights and color code for the visual indication

  • Auto-complete suggestions and hints for valid elements in the tags

Following are the updates available in the default layout XML in Unified CCX 12.5(1) release:

  • Sample configurations for customizing desktop properties are added to the default layout (Desktop Layout) and team-specific layout (Team Resources > Desktop Layout).

    For upgraded layouts, sample configurations for customizing desktop properties do not appear by default. The administrator must copy the XML from the View Default Layout and add to the respective custom layouts.

  • Horizontal Header is available in the layout configuration and the Header can be customised.

  • Title and Logo of Finesse desktop can be customised.

  • Desktop Chat, TeamMessage, Dialer, Agent Identity, and Non-Voice State Control are added as part of the header component.

  • Vertical tabs in Finesse desktop are moved to collapsable left navigation bar for which the icons can be customised.

  • Support for inbuilt java script components has been added.

  • The ID attribute (optional) is the ID of the HTML DOM element used to display the gadget or component. The ID should start with an alphabet and can contain alpha numeric characters along with hyphen(-) and underscore(_).It can be set through the Finesse Administrative portal and has to be unique across components and gadgets.

  • The managedBy attribute (optional) for Live Data gadgets defines the gadgets which manage these Live Data gadgets. The value of managedBy attribute for Live Data gadgets is team-performance. This means that the rendering of the gadget is managed by the Team Performance gadget. These gadgets are not rendered by default, but will be rendered when the options Show State History and Show Call History are selected in the Team Performance gadget.

    For upgraded layouts, the managedBy attribute will be introduced, and will have the value of the ID of the Team Performance gadget in the same tab. If there are multiple instances of Team Performance gadgets and Live Data gadget pairs, they will be associated in that order. If the ID of the Team Performance gadget is changed, the value of the managedBy attribute should also be updated to reflect the same ID for the Live Data gadgets. Otherwise, the Team Performance gadget instance will not show its respective Live Data gadgets.

  • The Hidden attribute (optional) is used to support headless gadgets. When an attribute is set to "hidden=true", then the gadget is loaded by the container, but will not be displayed. The default value set for the attribute is "false".

  • The maxRow attribute (optional) is used to adjust the height of the Team Performance gadget. If there are multiple instances of the Team Performance gadget, each instance height can be set by using this attribute. By default the maxRow attribute value is set to 10 rows.

  • Agents can view Recent Call History and Recent State History gadgets in the My History tab.

  • Supervisors can view Recent Call History and Recent State History gadgets in the My History tab.


Important

After a system upgrade, the old desktop layout is retained. If you had a modified desktop layout before upgrade, perform the following steps to ensure you obtain the latest changes:

  • Sign in to the Finesse administration console and click the Desktop Layout tab.

  • Copy the desktop layout to a text file.

  • On the Manage Desktop Layout gadget, click Restore Default Layout.

  • Click Save.

  • Using the text file of the desktop layout that you saved before the upgrade as a reference, modify the layout to include the changes that you made to the previous layout.

  • Click Save to save your changes.


If any changes are made to the component IDs or URLs in the default XML layout, the following features may not work as expected.


Note

The components can be rearranged in any order to show on the Finesse desktop.


Feature

Component ID

URL

Title and Logo

cd-logo

<url>/desktop/scripts/js/logo.js</url>

Voice State control

agent-voice-state

<url>/desktop/scripts/js/agentvoicestate.component.js</url>

Non-voice state control

nonvoice-state-menu

<url>/desktop/scripts/js/nonvoice-state-menu.component.js</url>

Team Message

broadcastmessagepopover

<url>/desktop/scripts/js/teammessage.component.js</url>

Desktop Chat

chat

<url>/desktop/scripts/js/chat.component.js</url>

Dialer

make-new-call-component

<url>/desktop/scripts/js/makenewcall.component.js</url>

Agent identity

identity-component

<url>/desktop/scripts/js/identity-component.js</url>

Update Default Desktop Layout

When you modify the layout of the Finesse desktop, the changes you make take effect on the desktop after 3 seconds. However, agents who are signed in when the changes are made must sign out and sign in again to see those changes reflect on the desktop.


Note

The call control gadget is only supported at the page level. You must ensure that the call control gadget (<gadget>/desktop/scripts/js/callcontrol.js</gadget>) is placed within the <page></page> tag for it to work correctly. Don't place this gadget within a <tab></tab> tag.

The version tag of Desktop Layout XML can’t be edited.

For the changes to take effect, refresh the page, or sign out and sign in again into Cisco Finesse.


Procedure

Step 1

Click Desktop Layout.

Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Make changes to the XML as required.

Example:

If you want to add a new tab called Reports, add the following XML within the tabs tags under the <role>Agent</role> tag:

<tab>
   <id>reports</id>
   <icon>Reports</icon>
   <label>Reports</label>
</tab>

If you want to add this tab to the supervisor desktop, add the XML within the tabs tags under the <role>Supervisor</role> tag.

To add a gadget to a tab, add the XML for the gadget within the gadgets tag for that tab.


<gadgets>
<gadget>https://<ipAddress>/gadgets/<gadgetname>.xml</gadget>
</gadgets>

Replace <ipAddress> with the IP address of the server where the gadget resides.

If you want to add multiple columns to a tab on the Finesse desktop, add the gadgets for each column within the columns tags for that tab. You can have up to four columns on a tab.

<tabs>
    <tab>
        <id>home</id>
        <icon>home</icon>
        <label>finesse.container.tabs.agent.homeLabel</label>
        <columns>
            <column>
                <gadgets>
                    <gadget>/desktop/scripts/js/queueStatistics.js</gadget>
                </gadgets>
            </column>
        </columns>
    </tab>
    <tab>
        <id>myHistory</id>
        <icon>history</icon>
        <label>finesse.container.tabs.agent.myHistoryLabel</label>
        <columns>
            <column>
                <!-- The following gadgets are used for viewing the call history 
and state history of an agent. -->
            </column>
        </columns>
    </tab>
    
Step 4

Click Save.

Finesse validates the XML file to ensure that it’s valid XML syntax and conforms to the Finesse schema.

Step 5

After you save your changes, if you want to revert to the last saved desktop layout, click Revert. If you want to revert to the default desktop layout, click Restore Default Layout.

Note 

During upgrade, any changes made to the Cisco Finesse Default Layout won’t be updated. Click on Restore Default Layout to get the latest changes.


The Finesse default XML layout is as follows:


<finesseLayout xmlns="http://www.cisco.com/vtg/finesse">
    <!--  DO NOT EDIT. The version number for the layout XML. -->
    <version>1250.03</version>
    <configs>
        <!-- The Title for the application which can be customized. -->
        <config key="title" value="Cisco Finesse"/>
        <!-- The following entries are examples of changing defaults for desktop properties.
        To change any property, uncomment the respective line and set the appropriate value.
        For more details on the properties that can be customized, refer to the Cisco Finesse Administration Guide.
        Note: The customized properties can only be set in the configs section and are not role-specific. -->
        <!-- <config key="enableDragDropAndResizeGadget" value="false"/> -->
        <!-- <config key="wrapUpCountDown" value="true"/> -->
        <!-- <config key="desktopChatAttachmentEnabled" value="true"/> -->
        <!-- <config key="forceWrapUp" value="true"/> -->
        <!-- Possible Values: supervisor_only, conference_controller_and_supervisor, all -->
        <!-- <config key="enableDropParticipantFor" value="supervisor_only"/> -->
        <!-- Possible Values: agents, all -->
        <!-- <config key="dropParticipant" value="agents"/> -->
        <!-- The logo file for the application -->
        <!-- For detailed instructions on using custom icons for logos and tabs,
        please refer to the section "Customize Title and Logo in the Header"
        in the Finesse Administration Guide. -->
        <!-- <config key="logo" value="/3rdpartygadget/files/cisco_finext_logo.png"/>  -->
    </configs>
    <header>
        <!--  Please ensure that at least one gadget/component is present within every headercolumn tag -->
		<leftAlignedColumns>
			<headercolumn width="300px">
				<component id="cd-logo">
					<url>/desktop/scripts/js/logo.js</url>
				</component>
			</headercolumn>
			<headercolumn width="230px">
				<component id="agent-voice-state">
					<url>/desktop/scripts/js/agentvoicestate.component.js</url>
				</component>
			</headercolumn>
			<headercolumn width="251px">
				<component id="nonvoice-state-menu">
					<url>/desktop/scripts/js/nonvoice-state-menu.component.js</url>
				</component>
			</headercolumn>

		</leftAlignedColumns>
		<rightAlignedColumns>
			<headercolumn width="50px">
                <component id="broadcastmessagepopover">
                    <url>/desktop/scripts/js/teammessage.component.js</url>
                </component>
            </headercolumn>
			<headercolumn width="50px">
                <component id="chat">
                    <url>/desktop/scripts/js/chat.component.js</url>
                </component>
            </headercolumn>
			<headercolumn width="50px">
				<component id="make-new-call-component">
					<url>/desktop/scripts/js/makenewcall.component.js</url>
				</component>
			</headercolumn>
			<headercolumn width="72px">
				<component id="identity-component">
					<url>/desktop/scripts/js/identity-component.js</url>
				</component>
			</headercolumn>
		</rightAlignedColumns>
	</header>
    <layout>
        <role>Agent</role>
        <page>
            <gadget>/desktop/scripts/js/callcontrol.js</gadget>

            <!-- The following gadget is for WXM Customer Experience Journey. 
            If WXM is onboarded successfully with all configurations, then replace the url 
            with the actual url obtained by exporting the Cisco Finesse gadget from WXM -->
            <!-- <gadget>/3rdpartygadget/files/CXService/CiscoCXJourneyGadget.xml</gadget> -->
        </page>
        <tabs>
            <tab>
                <id>home</id>
                <icon>home</icon>
                <label>finesse.container.tabs.agent.homeLabel</label>
                <columns>
                    <column>
                        <gadgets>
                            <!-- The following gadget is for recording and displaying Call Transcripts. 
                            If Voicea is onboarded successfully and all configuration done correctly then uncomment this gadget-->
                            <!-- <gadget>/3rdpartygadget/files/calltranscript/CallTranscriptGadget.xml</gadget> -->

                            <!-- The following gadget is for WXM Customer Experience Analytics. 
                            If WXM is onboarded successfully with all configurations, then replace the url 
                            with the actual url obtained by exporting the Cisco Finesse gadget from WXM -->
                            <!-- <gadget>/3rdpartygadget/files/CXService/CiscoCXAnalyticsGadget.xml</gadget> -->

                            <gadget>/desktop/scripts/js/queueStatistics.js</gadget>
							
                            <!--
                The following Gadgets are for LiveData.
                If you wish to show LiveData Reports, then do the following:
                    1) Uncomment each Gadget you wish to show.
                    2) Replace all instances of "my-cuic-server.com" with the Fully Qualified Domain Name of your Intelligence Center Server.
                    3) [OPTIONAL] Adjust the height of the gadget by changing the "gadgetHeight" parameter.
                IMPORTANT NOTES:
                    - In order for these Gadgets to work, you must have performed all documented pre-requisite steps.
                    - Do *NOT* change the viewId (unless you have built a custom report and know what you are doing).
                    - The "teamName" will be automatically replaced with the Team Name of the User logged into Finesse (for Team-specific layouts).
-->
                            <!-- HTTPS Version of LiveData Gadgets -->
                            <!-- TEAM STATUS REPORTS: 1. Agent Default view (default), 2. Agent Skill Group Default view -->
                            <!-- <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=310&amp;
                           viewId_1=99E6C8E210000141000000D80A0006C4&amp;filterId_1=agent.id=CL%20teamName&amp;viewId_2=9AB7848B10000141000001C50A0006C4&amp;
                           filterId_2=agent.id=CL%20teamName</gadget> -->
                            <!-- QUEUE STATUS REPORTS: 1. Skill Group Default view (default), 2. Skill Group Utilization view, 3. Precision Queue Default view, 4. Precision Queue Utilization view -->
                            <!-- <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=310&amp;
                         viewId_1=B7371BE210000144000002870A0007C5&amp;filterId_1=skillGroup.id=CL%20teamName&amp;
                         viewId_2=9E760C8B1000014B0000005A0A0006C4&amp;filterId_2=skillGroup.id=CL%20teamName&amp;
                         viewId_3=B71A630C10000144000002480A0007C5&amp;filterId_3=precisionQueue.id=CL%20teamName&amp;
                         viewId_4=286B86F01000014C000005330A0006C4&amp;filterId_4=precisionQueue.id=CL%20teamName</gadget> -->
                        </gadgets>
                    </column>
                </columns>
            </tab>
            <tab>
                <id>myStatistics</id>
                <icon>column-chart</icon>
                <label>finesse.container.tabs.agent.myStatisticsLabel</label>
                <columns>
                    <column>
                        <gadgets>
                            <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=150&amp;
                             viewId=0B8D11317ED54A80B64F3AE28C5139E5&amp;filterId=agentStats.id=CL%20teamName</gadget>
                        </gadgets>
                    </column>
                </columns>
            </tab>
            <tab>
                <id>myHistory</id>
                <icon>history</icon>
                <label>finesse.container.tabs.agent.myHistoryLabel</label>
                <columns>
                    <column>
                        <!-- The following gadgets are used for viewing the call history and state history of an agent. -->
                        <gadgets>
                            <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=280&amp;
                            viewId=5FA44C6F930C4A64A6775B21A17EED6A&amp;filterId=agentTaskLog.id=CL%20teamName</gadget>
                            <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=280&amp;
                            viewId=56BC5CCE8C37467EA4D4EFA8371258BC&amp;filterId=agentStateLog.id=CL%20teamName</gadget>
                        </gadgets>
                    </column>
                </columns>
            </tab>
            <!--
The following Gadgets are for LiveData.
If you wish to show More LiveData Reports, then do the following:
    1) Uncomment each Gadget you wish to show.
    2) Replace all instances of "my-cuic-server.com" with the Fully Qualified Domain Name of your Intelligence Center Server.
    3) [OPTIONAL] Adjust the height of the gadget by changing the "gadgetHeight" parameter.
IMPORTANT NOTES:
    - In order for these Gadgets to work, you must have performed all documented pre-requisite steps.
    - Do *NOT* change the viewId (unless you have built a custom report and know what you are doing).
    - The "teamName" will be automatically replaced with the Team Name of the User logged into Finesse (for Team-specific layouts).
-->
            <!-- If you are showing the "More Live Data Reports" tab, then also uncomment this section.
            <tab>
                <id>moreLiveDataReports</id>
                <icon>reports-more</icon>
                <label>finesse.container.tabs.agent.moreLiveDataReportsLabel</label>
                <gadgets>
-->
            <!-- HTTPS Version of LiveData Gadgets -->
            <!-- AGENT REPORTS: 1. Agent Default view (default) -->
            <!-- <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=310&amp;
            viewId_1=99E6C8E210000141000000D80A0006C4&amp;filterId_1=agent.id=CL%20teamName</gadget>-->
            <!-- AGENT SKILL GROUP REPORTS: 1. Agent Skill Group Default view (default) -->
            <!-- <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=310&amp;
            viewId_1=9AB7848B10000141000001C50A0006C4&amp;filterId_1=agent.id=CL%20teamName</gadget>-->
            <!-- QUEUE STATUS SKILL GROUP REPORTS: 1. Skill Group Default view (default), 2. Skill Group Utilization view -->
            <!-- <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=310&amp;
            viewId_1=B7371BE210000144000002870A0007C5&amp;filterId_1=skillGroup.id=CL%20teamName&amp;
             viewId_2=9E760C8B1000014B0000005A0A0006C4&amp;filterId_2=skillGroup.id=CL%20teamName</gadget>-->
            <!-- QUEUE STATUS PRECISION QUEUE REPORTS: 1. Precision Queue Default view (default), 2. Precision Queue Utilization view -->
            <!-- <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=310&amp;
           viewId_1=B71A630C10000144000002480A0007C5&amp;filterId_1=precisionQueue.id=CL%20teamName&amp;
           viewId_2=286B86F01000014C000005330A0006C4&amp;filterId_2=precisionQueue.id=CL%20teamName</gadget>-->
            <!-- If you are showing the "more reports" tab, then uncomment this section too.
                </gadgets>
            </tab>
            -->
        </tabs>
    </layout>
    <layout>
        <role>Supervisor</role>
        <page>
            <gadget>/desktop/scripts/js/callcontrol.js</gadget>

            <!-- The following gadget is for WXM Customer Experience Journey. 
            If WXM is onboarded successfully with all configurations, then replace the url 
            with the actual url obtained by exporting the Cisco Finesse gadget from WXM -->
            <!-- <gadget>/3rdpartygadget/files/CXService/CiscoCXJourneyGadget.xml</gadget> -->
        </page>
        <tabs>
            <tab>
                <id>home</id>
                <icon>home</icon>
                <label>finesse.container.tabs.supervisor.homeLabel</label>
                <columns>
                    <column>
                        <gadgets>
                           <!-- The following gadget is for recording and displaying Call Transcripts. 
                            If Voicea is onboarded successfully and all configuration done correctly then uncomment this gadget-->
                            <!-- <gadget>/3rdpartygadget/files/calltranscript/CallTranscriptGadget.xml</gadget> -->

                            <!-- The following gadget is for WXM Customer Experience Analytics. 
                            If WXM is onboarded successfully with all configurations, then replace the url 
                            with the actual url obtained by exporting the Cisco Finesse gadget from WXM -->
                            <!-- <gadget>/3rdpartygadget/files/CXService/CiscoCXAnalyticsGadget.xml</gadget> -->

                            <gadget id="team-performance">/desktop/scripts/js/teamPerformance.js</gadget>
                            <!-- The following gadgets are used for viewing the call history and state history of an agent selected in the Team Performance Gadget. -->
                            <!-- The following gadgets are managed(loaded and displayed) by the team performance gadget (associated with id "team-performance").
                                 This association is done using the mapping of managedBy attribute of the managed gadgets, to the id of managing gadget.
                                 If the id for team performance gadget is changed, the values for the associated managedBy attribute
                                 for the managed gadgets, also need to be updated with the new id.
                                 These managed gadgets are not displayed by default, but would be displayed when the option 
                                 "view history" is selected, for an agent, in the team performance gadget.
                                 Note: As managed gadgets are not displayed by default, placing managed gadgets alone on
                                 separate columns of their own, would display blank space in that area.
                                 For more details on managed gadgets and managedBy attribute, please refer to Finesse Administration Guide. 
                            -->
                            <gadget managedBy="team-performance">https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=275&amp;
                            viewId=630CB4C96B0045D9BFF295A49A0BA45E&amp;filterId=agentTaskLog.id=AgentEvent:Id&amp;type=dynamic&amp;maxRows=20</gadget>
                            <gadget managedBy="team-performance">https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=275&amp;
                            viewId=56BC5CCE8C37467EA4D4EFA8371258BC&amp;filterId=agentStateLog.id=AgentEvent:Id&amp;type=dynamic&amp;maxRows=20</gadget>
                        </gadgets>
                    </column>
                </columns>
            </tab>
            <tab>
                <id>myHistory</id>
                <icon>history</icon>
                <label>finesse.container.tabs.agent.myHistoryLabel</label>
                <columns>
                    <column>
                        <!-- The following gadgets are used for viewing the call history and state history of a logged in supervisor. -->
                        <gadgets>
                            <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=280&amp;
                            viewId=5FA44C6F930C4A64A6775B21A17EED6A&amp;filterId=agentTaskLog.id=CL%20teamName</gadget>
                            <gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=280&amp;
                            viewId=56BC5CCE8C37467EA4D4EFA8371258BC&amp;filterId=agentStateLog.id=CL%20teamName</gadget>
                        </gadgets>
                    </column>
                </columns>
            </tab>
            <tab>
                <id>teamData</id>
                <icon>team-data</icon>
                <label>finesse.container.tabs.supervisor.teamDataLabel</label>
                <columns>
                    <column>
                        <!-- The following gadget is used by the supervisor to view an agent's queue interval details. -->
                        <gadgets>
                        	<gadget>https://my-cuic-server.com:8444/cuic/gadget/LiveData/LiveDataGadget.jsp?gadgetHeight=310&amp;
                             viewId=0B8D11317ED54A80B64F3AE28C5139E5&amp;filterId=agentStats.id=CL%20teamName</gadget>
                            <gadget>https://my-cuic-server.com:8444/cuic/gadget/Historical/HistoricalGadget.jsp?viewId=BD9A8B7DBE714E7EB758A9D472F0E7DC&amp;
                           linkType=htmlType&amp;viewType=Grid&amp;refreshRate=900&amp;@start_date=RELDATE%20THISWEEK&amp;
                          @end_date=RELDATE%20THISWEEK&amp;@agent_list=CL%20~teams~&amp;gadgetHeight=360</gadget>
                        </gadgets>
                    </column>
                </columns>
            </tab>
            <tab>
                <id>queueData</id>
                <icon>storage</icon>
                <label>finesse.container.tabs.supervisor.queueDataLabel</label>
                <columns>
                    <column>
                        <gadgets>
                            <gadget>/desktop/scripts/js/queueStatistics.js</gadget>
                        </gadgets>
                    </column>
                </columns>
            </tab>

        </tabs>
    </layout>
</finesseLayout>

Drag-and-Drop and Resize Gadget or Component

The administrator can configure the drag-and-drop and resize gadget or component features for agents and supervisors to customize their Finesse desktop.

  • The drag-and-drop feature allows agents and supervisors to drag (and drop) the gadget or the component to the required position on the desktop layout.

  • The resize feature allows the agents and supervisors to shrink or expand the gadget or the component to a custom size on the desktop layout.


Note

By default, the drag-and-drop and resize features are disabled. The administrator must set the enableDragDropAndResizeGadget desktop property value as true to enable these features.


The administrator can customize the desktop property value of these features through the desktop layout:

  • Default layout (Desktop Layout)—In the Text Editor, remove the comment (<!—and -->) from the enableDragDropAndResizeGadget code snippet and enter the value as true to add these features to the desktop layout. For more information, see Customize Desktop Properties.

    The following is the sample code snippet, as displayed in the default Desktop Layout.

    <!-- <config key="enableDragDropAndResizeGadget" value="false"/> -->
  • Team-specific layouts (Manage Team Resources > Desktop Layout)—Select a specific team and then in the Text Editor, remove the comment (<!—and -->) from the enableDragDropAndResizeGadget code snippet and enter the value as true to add these features to the team desktop layout. For more information, see Customize Desktop Properties at Team Level.

    The following is the sample code snippet, as displayed in the team Desktop Layout.

    <!-- <config key="enableDragDropAndResizeGadget" value="false"/> -->

Note

  • For upgraded layouts, the sample configuration for customizing desktop property (enableDragDropAndResizeGadget) doesn’t appear by default in the Desktop Layout. Administrators must copy the XML from the View Default Layout and add to the respective custom layouts.

  • For new layouts, the sample configuration for customizing desktop property (enableDragDropAndResizeGadget) appears by default in the Desktop Layout.

  • The administrator can also use the CLI and set the utils finesse set_propertydesktop enableDragDropAndResizeGadget to true to enable these features. For more information see Desktop Properties.

  • If the property value is defined in the team-specific desktop layout (Manage Team Resources > Desktop Layout), the team-specific desktop layout takes precedence over the property value defined in the Desktop Layout and CLI.

  • These features aren’t applicable for gadgets that don’t have a defined title. For more information, see the Gadget Limitations section in the Cisco Finesse Web Services Developer Guide at https://developer.cisco.com/docs/finesse/#!rest-api-dev-guide.


Customize Desktop Properties

You can customize the Finesse desktop properties.

Procedure

Step 1

Click Desktop Layout.

Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Enter the desktop property name in the config key tag.

Step 4

Enter the possible value of the desktop property in the value tag.

The following are the sample desktop property entries, as displayed in the default Desktop Layout. To change these desktop property entries in Text Editor, remove the comment (<!-- and -->) and set appropriate values.

Note 

If the property value is defined in the Desktop Layout, then the Desktop Layout value takes precedence over the property value defined using the CLI. For more information on Finesse CLIs, see Desktop Properties.

The following table lists the supported desktop properties:

Config Key

Value

Default Value

enableDragDropAndResizeGadget

true|false

false

enableShortCutKeys

true|false

true

forceWrapUp

true|false

true

wrapUpCountDown

true|false

true

showWrapUpTimer

true|false

true

desktopChatAttachmentEnabled

true|false

true

desktopChatMaxAttachmentSize

Range: 1—10 (MB)

5

desktopChatUnsupportedFileTypes

Unsupported file formats include comma-separated valid file extensions. For example: .exe, .sh

.exe, .msi, .sh, .bat

showAgentHistoryGadgets

true|false

true

showActiveCallDetails

(for Supervisor Only)

true|false

true

pendingDTMFThresholdCount

Range: 1—20

20

dtmfRequestTimeoutInMs

Range: 1000—200000 (1 to 200 seconds)

5000 (5 seconds)

enableDropParticipantFor

supervisor_only|conference_controller_

and_supervisor|all

supervisor_only

dropParticipant

agents|all

agents

Note 
  • To enable the following Finesse desktop properties in Cisco Finesse, install Cisco Finesse Release 12.5(1) ES1 COP or higher.

    • pendingDTMFThresholdCount

    • dtmfRequestTimeoutInMs

  • To enable the following Finesse desktop properties in Cisco Finesse, install Cisco Finesse Release 12.5(1) ES4 COP or higher.

    • enableDropParticipantFor

    • dropParticipant

For more information on Finesse desktop properties, see Desktop Properties.

Step 5

Click Save.

The change takes effect when the agent or supervisor refreshes the Finesse desktop or sign out and sign in again.

Note 

If you clear the Override System Default check box and click Save. The changes are overwritten, and the editing pane reverts to the default desktop layout XML.


Horizontal Header

The Horizontal Header on the Finesse desktop has the following components from left to right. All these components can be removed and replaced with custom gadgets as required.

  • Logo: Default is Cisco logo. Can be customized.

  • Product Name: Default is Cisco Finesse. Can be customized.

  • Agent State for Voice: Displays agent state for voice call.

  • Agent State for Digital Channels: Displays agent state for digital channels.

  • Dialer Component: Agent can make a new call.

  • Identity Component: Displays agent name and signout functionality with reason codes.


Note

The sum of widths set for all gadgets and components in the header (inside right aligned columns and left aligned colums) should not exceed the total header width. If it exceeds the header width, some of the gadgets/components will not be visible.


Customize Title and Logo in the Header

You can customize the title and logo displayed on the Finesse desktop:
Procedure

Step 1

Click Desktop Layout.

Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Enter the product name in the config value tag with title key.

Step 4

Upload the logo file just like any third-party gadget.

For more information, see section Upload Third-Party Gadgets in Cisco Finesse Admin Guide.
Step 5

Enter the URL of the logo file in the config value tag with logo key.

Example:
<configs>
        <!-- The Title for the application which can be customised.-->
<config value="product.full-name" Key="title"/>
     <!-- The logo file for the application-->
     <!--<config key="logo" value="/3rdpartygadgets/<some_sample_image>"/-->
</configs>

The customized logo and product name is displayed on the Finesse desktop.

Note

The file size that can be uploaded for the logo must be kept within 40 pixels. The file types supported are .svg, .png, .gif, and .jpeg/jpg.


alternateHosts Configuration

The <gadget> element in the Finesse Layout XML provides an attribute to specify alternate hosts from which the gadget can be loaded. This allows the Cisco Finesse desktop to load the gadget using a different host if the primary server is unavailable.

The alternateHosts attribute contains a comma-separated list of FQDNs that will be used if the primary-host-FQDN is unavailable.

<gadget alternateHosts="host1,host2,host3,...">
         https://<primary-host-FQDN>/<gadget-URL> 
    </gadget>

The alternateHosts attribute is only applicable for gadgets with an absolute URL. That is URLs containing the FQDN of a host, an optional port, and the complete URL path to the gadget. For example: <gadget alternateHosts="host1,host2">https://primary host/relative_path</gadget>

If loading the gadget from the primary-host fails, the Cisco Finesse container attempts to load the gadget from the alternate hosts in the order specified in the alternateHosts attribute.

The Cisco Finesse desktop may fail to load the gadget even if some of the hosts are reachable. In such cases, refresh the Cisco Finesse desktop.

When the gadget is specified with a relative URL, for example: <gadget >/3rdpartygadgets/relative_path</gadget>, the alternateHosts attribute does not apply and is ignored by the Cisco Finesse desktop.


Note

If the host serving the gadget fails after the Cisco Finesse desktop was successfully loaded, the desktop must be refreshed in order to load the gadget from an alternate host. The gadget does not implement its own failover mechanism.


Headless Gadget Configuration

Headless gadgets are gadgets which do not need a display space, but can be loaded and run like a background task in the browser. The Hidden attribute (optional) is used to support headless gadgets in the layout XML. When an attribute is set to "hidden=true", then the gadget is loaded by the container, but will not be displayed. The default value set for the attribute is "false".

Customize Icons in Left Navigation Bar

You can add icons (both custom and inbuilt) to the collapsible left navigation bar of the Finesse desktop:
Procedure

Step 1

Click Desktop Layout.

Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Enter name of the gadget or component in the id tag.

Step 4

Enter the value of the icon in the icon tag.

Step 5

Upload the icon file just like any third-party gadget.

For more information, see section Upload Third-Party Gadgets in Cisco Finesse Admin Guide.

Note 

When adding a custom icon, provide the path in the icon tag and if you are adding an inbuilt icon, provide the icon value in the icon tag

Example:
Note 

The file size that can be uploaded in the left navigation bar as custom icons is 25 pixels by 25 pixels. The maximum width of the tab title in the left navigation bar must be 80 pixels or less. The file types supported are .svg, .png, .gif, and .jpeg/jpg.


Customize Icons for Gadgets

As part of the Cisco Finesse container, various standard icons are available. Use the following procedure to customize the icons for the gadgets hosted in Finesse desktop.

Procedure

Step 1

Click Desktop Layout.

Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Enter the value of the icon in the icon tag. Get the icon name from the List of Icons. The icon name is located on the right of the icon image. For example, search.

Note 

Icon name is case sensitive. Enter the icon name exactly as displayed in the List of Icons.

Example

An example of the desktop layout using the Search and Close-Keyboard icons.

<tab>
    <id>home</id>
    <icon>search</icon>
    <label>finesse.container.tabs.agent.homeLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>/desktop/scripts/js/queueStatistics.js</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
<tab>
    <id>sample</id>
    <icon>close-keyboard</icon>
    <label>finesse.container.tabs.agent.homeLabel2</label>
    <columns>
        <column>
            <gadgets>
                <gadget>/desktop/scripts/js/samplequeue.js</gadget>
            </gadgets>
        </column>
    </columns>
</tab>

List of Icons

The following are the icons for Actions.

The following are the icons for Audio.

The following are the icons for Camera.

The following are the icons for Chat.

The following are the icons for Collaboration.

The following are the icons for Contacts.

The following are the icons for Content.

The following are the icons for Editor.

The following are the icons for Email.

The following are the icons for Hardware.

The following are the icons for Media.

The following are the icons for Navigation.

The following are the icons for Network.

The following are the icons for Notifications and Alerts.

The following are the icons for Phone.

The following are the icons for Sources.

The following are the icons for Settings.

The following are the icons for Video Controls.

The following are the icons for Miscellaneous Icons.

For more information on customizing the visual experience, see Visual Design Kit at https://developer.cisco.com/docs/finesse/#!visual-design-guide.

XML Schema Definition

You must ensure that the XML uploaded conforms to the XML schema definition for Finesse. The XML schema definition for Finesse is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.cisco.com/vtg/finesse" targetNamespace="http://www.cisco.com/vtg/finesse" elementFormDefault="qualified">
   <!-- definition of version element -->
   <xs:element name="version">
      <xs:simpleType>
         <xs:restriction base="xs:double">
            <xs:pattern value="[0-9\.]+" />
         </xs:restriction>
      </xs:simpleType>
   </xs:element>
   <!--  The below elements are for common desktop header and configs -->
   <!--  Copied from: https://github5.cisco.com/ccbu-shared/common-desktop/blob/master/java/layout-manager/src/main/resources/layoutSchema.xsd -->
   <!--  If the common-desktop XSD changes, this too needs to be updated -->
   <!--  Only difference is that, column has been renamed to headercolumn, since column is alredy there in finesse desktop layout -->
   <xs:complexType name="configs">
      <xs:sequence>
         <xs:element name="config" type="config" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="config">
      <xs:attribute name="key">
         <xs:simpleType>
            <xs:restriction base="xs:string">
               <xs:pattern value="[a-zA-Z]*" />
            </xs:restriction>
         </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="value" type="xs:string" />
   </xs:complexType>
   <xs:complexType name="header">
      <xs:choice>
         <xs:sequence>
            <xs:element name="leftAlignedColumns" type="listOfColumns" minOccurs="1" maxOccurs="1" />
            <xs:element name="rightAlignedColumns" type="listOfColumns" minOccurs="0" maxOccurs="1" />
         </xs:sequence>
         <xs:sequence>
            <xs:element name="rightAlignedColumns" type="listOfColumns" minOccurs="1" maxOccurs="1" />
         </xs:sequence>
      </xs:choice>
   </xs:complexType>
   <xs:complexType name="component">
      <xs:sequence>
         <xs:element name="url" type="xs:string" minOccurs="1" maxOccurs="1" />
         <xs:element name="stylesheet" type="xs:string" minOccurs="0" maxOccurs="1" />
      </xs:sequence>
      <xs:attribute name="id" use="required">
         <xs:simpleType>
            <xs:restriction base="xs:string">
               <xs:pattern value=".+" />
            </xs:restriction>
         </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="order">
         <xs:simpleType>
            <xs:restriction base="xs:string">
               <xs:pattern value="[0-9]{0,10}" />
            </xs:restriction>
         </xs:simpleType>
      </xs:attribute>
   </xs:complexType>
   <xs:complexType name="listOfColumns">
      <xs:sequence>
         <xs:element name="headercolumn" type="headercolumn" minOccurs="1" maxOccurs="unbounded" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="headercolumn">
      <xs:choice minOccurs="0" maxOccurs="1">
         <xs:element ref="gadget" />
         <xs:element name="component" type="component" />
      </xs:choice>
      <xs:attribute name="width">
         <xs:simpleType>
            <xs:restriction base="xs:string">
               <xs:pattern value="[0-9]+(px|%)" />
            </xs:restriction>
         </xs:simpleType>
      </xs:attribute>
   </xs:complexType>
   <!--  The above elements are for common desktop header and configs -->
   <!-- definition of role type -->
   <xs:simpleType name="role">
      <xs:restriction base="xs:string">
         <xs:enumeration value="Agent" />
         <xs:enumeration value="Supervisor" />
         <xs:enumeration value="Admin" />
      </xs:restriction>
   </xs:simpleType>
   <!-- definition of simple elements -->
   <xs:element name="id">
      <xs:simpleType>
         <xs:restriction base="xs:string">
            <xs:pattern value="[a-zA-Z]([-_:\.a-zA-Z0-9])*" />
         </xs:restriction>
      </xs:simpleType>
   </xs:element>
   <xs:element name="label">
      <xs:simpleType>
         <xs:restriction base="xs:string">
            <xs:minLength value="1" />
            <xs:pattern value="[^\r\n]+" />
            <!-- This regex restricts the label string from carriage returns or newline characters -->
         </xs:restriction>
      </xs:simpleType>
   </xs:element>
   <xs:element name="icon" type="xs:anyURI" />
   <xs:element name="gadget">
      <xs:complexType>
         <xs:simpleContent>
            <xs:extension base="restrictWhiteSpaces">
               <!-- <xs:attribute name="staticMessage" type="xs:string"/> -->
               <xs:attribute name="id">
                  <xs:simpleType>
                     <xs:restriction base="xs:string">
                        <xs:pattern value="[a-zA-Z]([-_a-zA-Z0-9])*" />
                     </xs:restriction>
                  </xs:simpleType>
               </xs:attribute>
               <xs:attribute name="alternateHosts" type="xs:string" />
               <xs:attribute name="managedBy" type="xs:string" />
               <xs:attribute name="hidden" type="xs:boolean" />
            </xs:extension>
         </xs:simpleContent>
      </xs:complexType>
   </xs:element>
   <xs:element name="role" type="role" />
   <xs:element name="gadgets">
      <!-- Grouping of a set of gadgets -->
      <xs:complexType>
         <xs:sequence minOccurs="0" maxOccurs="unbounded">
            <!-- No limit to number of gadget URIs for now -->
            <xs:element ref="gadget" />
            <!-- URI of the gadget xml -->
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:simpleType name="restrictWhiteSpaces">
      <xs:restriction base="xs:anyURI">
         <xs:minLength value="1" />
         <xs:pattern value="\S+" />
         <!-- This regex restricts anyURI from containing whitespace within -->
      </xs:restriction>
   </xs:simpleType>
   <xs:element name="column">
      <!-- Grouping of a set of gadgets within a column -->
      <xs:complexType>
         <xs:sequence minOccurs="0" maxOccurs="unbounded">
            <!-- No limit to number of gadget URIs for now -->
            <xs:element ref="gadgets" />
            <!-- URI of the gadget xml -->
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:element name="columns">
      <!-- Grouping of a set of columns -->
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="column" minOccurs="0" maxOccurs="unbounded" />
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:element name="page">
      <!-- Grouping of a set of persistent gadgets -->
      <xs:complexType>
         <xs:sequence minOccurs="0" maxOccurs="unbounded">
            <!-- No limit to number of gadget URIs for now -->
            <xs:element ref="gadget" />
            <!-- URI of the gadget xml -->
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:element name="tab">
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="id" />
            <!-- Id of the tab selector in the desktop -->
            <xs:element ref="icon" minOccurs="0" maxOccurs="1" />
            <xs:element ref="label" />
            <!-- Label of the tab selector -->
            <xs:choice>
               <xs:element ref="gadgets" minOccurs="0" maxOccurs="1" />
               <xs:element ref="columns" minOccurs="0" maxOccurs="1" />
            </xs:choice>
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:element name="tabs">
      <!-- Grouping of tabs -->
      <xs:complexType>
         <xs:sequence maxOccurs="unbounded">
            <!-- No limit to number of tabs for now -->
            <xs:element ref="tab" />
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:element name="layout">
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="role" />
            <!-- Type of the role -->
            <xs:element ref="page" />
            <!-- List of page gadgets -->
            <xs:element ref="tabs" />
            <!-- Grouping of tabs for this particular role -->
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:element name="finesseLayout">
      <!-- Layout of the desktop -->
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="version" />
            <xs:element name="configs" type="configs" minOccurs="0" maxOccurs="1" />
            <xs:element name="header" type="header" minOccurs="1" maxOccurs="1" />
            <xs:sequence maxOccurs="3">
               <!-- only support 3 roles for now -->
               <xs:element ref="layout" />
            </xs:sequence>
         </xs:sequence>
      </xs:complexType>
   </xs:element>
</xs:schema>

Add Webchat and Email to Finesse

The Cisco Finesse default layout XML contains commented XML code for Web Chat and Email gadgets available for the Finesse desktop. Each gadget or tab is surrounded by comment characters (<!-- and -->) and comments that describe what the tab or gadget is for and how to add it to the desktop.


Note

The Chat and Email Control gadget is only supported at the page level. You must ensure that the Chat and Email Control gadget (<gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>) is placed within the <page></page> tag. Placing this gadget within a <tab></tab> tag is not supported.


The procedure that you follow depends on your deployment. The following table describes when to use each procedure.

Procedure

When to use

Add Web Chat and Email to the default desktop layout.

Follow this procedure if you want to add Web Chat and Email to the Finesse desktop after a fresh installation or after an upgrade if you have not customized the default desktop layout.

Add Web Chat and Email to a custom desktop layout.

Follow this procedure if you want to add Web Chat and Email and have customized the desktop layout.

Add Web Chat and Email to a team layout.

Follow this procedure if you want to add Web Chat and Email to the desktop only for specific teams.


Note

After you add the Web Chat and Email gadgets, sign in to the Finesse desktop and make sure they appear the way you want. Agents who are signed in to Finesse when you change the desktop layout must sign out and sign back in to see the change on their desktops.


Add Web Chat and Email to the Default Desktop Layout

Note

If you upgraded from a previous release but do not have a custom desktop layout, click Restore Default Layout on the Manage Desktop Layout gadget and then follow the steps in this procedure.


Procedure

Step 1

In the Finesse administration console, click the Desktop Layout tab.

Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

To add the Chat and Email Control gadget to the agent desktop, look for the following under the <role>Agent</role> tag and within the <page></page> tag:

<gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>
Step 4

Remove the comments and comment characters (<!-- and -->) that surround the gadget, leaving only the gadget (<gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>).

Step 5

To add the Manage Chat and Email tab and gadget to the agent desktop, look for the following within the <tabs></tabs> tag:

<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.agent.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=590</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 6

Remove the comments and comment characters (<!-- and -->) that surround the tab.

Step 7

Replace my-CCP-server in the gadget URL with the fully-qualified domain name (FQDN) of your Customer Collaboration Platform server.

Step 8

Optionally, change the height of the Manage Chat and Email gadget.

Example:

The height specified in the gadget URL is 590 pixels. If you want to change the height, change the gadgetHeight parameter in the URL to the desired value. For example if you want the gadget height to be 600 pixels, change the code as follows:

<gadget>https://my-CCP-server/multisession/ui/gadgets/
         multisession-reply-gadget.xml?gadgetHeight=600</gadget>

The default and minimum height of the Manage Chat and Email gadget is 590 pixels. If you do not specify a value for the gadgetHeight parameter or if you specify a value that is less than 590, the gadget defaults to 590 pixels.

Note 

An agent can be configured to handle up to five chat contacts and five email contacts at a time. If the agent has the maximum number of contacts on the desktop, not all contacts are visible. If your agents are configured to handle the maximum number of contacts, you must increase the height of this gadget to a minimum of 570 pixels to ensure there is enough space for all of the contacts to appear.

Step 9

To add the Chat and Email Control gadget to the supervisor desktop, look for the following under the <role>Supervisor</role> tag and within the <page></page> tag:

<gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>
Step 10

Remove the comments and comment characters (<!-- and -->), leaving only the gadget (<gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>).

Step 11

To add the Live Data report for Agent Chat Statistics to the supervisor desktop, look for the following:

<gadget>https://localhost:8444/cuic/gadget/LiveData/
 LiveDataGadget.xml?gadgetHeight=310&
 viewId=F2F1FC17100001440000014E0A4E5D48&
 filterId=ChatAgentStats.agentId=CL</gadget>
Step 12

Remove the comments and comment characters (<!-- and -->), leaving only the gadget.

Step 13

To add the Live Data report for Chat Queue Statistics to the supervisor desktop, look for the following:

<gadget>https://localhost:8444/cuic/gadget/LiveData/
 LiveDataGadget.xml?gadgetHeight=310&
 viewId=E42ED788100001440000007B0A4E5CA1&
 filterId=ChatQueueStatistics.queueName=CL</gadget>
Step 14

Remove the comments and comment characters (<!-- and -->), leaving only the gadget.

Step 15

To add the Manage Chat and Email tab and gadget to the supervisor desktop, look for the following within the <tabs></tabs> tag:

<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.supervisor.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=590</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 16

Remove the comments and comment characters (<!-- and -->) that surround the tab.

Step 17

Replace my-CCP-server in the gadget URL with the fully-qualified domain name (FQDN) of your Customer Collaboration Platform server.

Step 18

Optionally, change the height of the Manage Chat and Email gadget.

Step 19

Click Save.


Add Webchat and Email to a Custom Desktop Layout
Procedure

Step 1

In the Finesse administration console, click the Desktop Layout tab.

Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Copy the XML code for the Chat and Email Control gadget for the agent desktop.

<gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>
Step 4

To add the gadget to the agent desktop, paste the code within the <page></page> tags under the Call Control gadget as follows:

<role>Agent</role>
<page>
   <gadget>/desktop/gadgets/CallControl.xml</gadget>
   <gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>
</page>
Step 5

To add the gadget to the supervisor desktop, paste the code within the <page></page> tags under the Call Control gadget as follows:

<role>Supervisor</role>
<page>
   <gadget>/desktop/gadgets/CallControl.xml</gadget>
   <gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>
</page>
Step 6

Copy the code for the agent Manage Chat and Email tab and gadget from the default layout XML.

<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.agent.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=430</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 7

Paste the code within the <tabs></tabs> tag for the agent role after the Manage Call tab:

<tab>
    <id>manageCall</id>
    <label>finesse.container.tabs.agent.manageCallLabel</label>
</tab>
<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.agent.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=430</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 8

Replace my-social-miner-server with the FQDN of your Customer Collaboration Platform server.

Step 9

Optionally, change the height of the Manage Chat and Email gadget.

Example:

The height specified in the gadget URL is 430 pixels. If you want to change the height, change the gadgetHeight parameter in the URL to the desired value. For example if you want the gadget height to be 600 pixels, change the code as follows:

<gadget>https://my-CCP-server/multisession/ui/gadgets/
         multisession-reply-gadget.xml?gadgetHeight=600</gadget>

The default and minimum height of the Manage Chat and Email gadget is 430 pixels. If you do not specify a value for the gadgetHeight parameter or if you specify a value that is less than 430, the gadget defaults to 430 pixels.

Note 

An agent can be configured to handle up to five chat contacts and five email contacts at a time. If the agent has the maximum number of contacts on the desktop, not all contacts are visible. If your agents are configured to handle the maximum number of contacts, you must increase the height of this gadget to a minimum of 570 pixels to ensure there is enough space for all of the contacts to appear.

Step 10

Copy the code for the Live Data gadgets for Agent Chat Statistics and Chat Queue Statistics from the default layout XML.

<gadget>https://localhost:8444/cuic/gadget/LiveData/
 LiveDataGadget.xml?gadgetHeight=310&
 viewId=F2F1FC17100001440000014E0A4E5D48&
 filterId=ChatAgentStats.agentId=CL</gadget>
<gadget>https://localhost:8444/cuic/gadget/LiveData/
 LiveDataGadget.xml?gadgetHeight=310&
 viewId=E42ED788100001440000007B0A4E5CA1&
 filterId=ChatQueueStatistics.queueName=CL</gadget>
Step 11

Paste the code for these gadgets within the <gadgets></gadgets> tags for the tabs on which you want them to appear.

Step 12

Copy the code for the supervisor Manage Chat and Email tab and gadget from the default layout XML.

<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.supervisor.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=430</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 13

Paste the code within the <tabs></tabs> tag for the supervisor role after the Manage Call tab:

<tab>
    <id>manageCall</id>
    <label>finesse.container.tabs.supervisor.manageCallLabel</label>
</tab>
<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.supervisor.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=430</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 14

Replace my-social-miner-server with the FQDN of your Customer Collaboration Platform server.

Step 15

Optionally, change the height of the gadget.

Step 16

Click Save.


Add Web Chat and Email to a Team Layout
Procedure

Step 1

In the Finesse administration console, click the Desktop Layout tab.

Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Copy the XML code for the Chat and Email Control gadget for the agent desktop and paste it into a text file.

<gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>
Step 4

Copy the code for the agent Manage Chat and Email tab and gadget and paste it into your text file.

<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.agent.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=430</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 5

Copy the code for the Live Data gadgets for Agent Chat Statistics and Chat Queue Statistics and paste it into your text file.

<gadget>https://localhost:8444/cuic/gadget/LiveData/
 LiveDataGadget.xml?gadgetHeight=310&
 viewId=F2F1FC17100001440000014E0A4E5D48&
 filterId=ChatAgentStats.agentId=CL</gadget>
<gadget>https://localhost:8444/cuic/gadget/LiveData/
 LiveDataGadget.xml?gadgetHeight=310&
 viewId=E42ED788100001440000007B0A4E5CA1&
 filterId=ChatQueueStatistics.queueName=CL</gadget>
Step 6

Copy the code for the supervisor Manage Chat and Email tab and gadget and paste it into your text file.

<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.supervisor.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=430</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 7

Click the Team Resources tab.

Step 8

Select the team from the list of teams for which you want to add Web Chat and Email.

Step 9

Check the Override System Default check box.

Step 10

In the Resources for <team name> area, click the Desktop Layout tab.

Step 11

Select from the following editors:

  • Text Editor
  • XML Editor
Step 12

To add the Chat and Email Control gadget to the agent desktop, copy the code for the gadget from your text file and paste it within the <page></page> tags under the Call Control gadget as follows:

<role>Agent</role>
<page>
   <gadget>/desktop/gadgets/CallControl.xml</gadget>
   <gadget>https://localhost/uccx-nvcontrol/gadgets/NonVoiceControl.xml</gadget>
</page>
Step 13

To add the gadget to the supervisor desktop, paste the code within the <page></page> tags under the Call Control gadget as follows:

Step 14

To add the Manage Chat and Email tab and gadget to the agent desktop, copy the code from your text file and paste it within the <tabs></tabs> tag for the agent role after the Manage Call tab:

<tab>
    <id>manageCall</id>
    <label>finesse.container.tabs.agent.manageCallLabel</label>
</tab>
<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.agent.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=430</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 15

Replace my-social-miner-server with the FQDN of your Customer Collaboration Platform server.

Step 16

Optionally, change the height of the Manage Chat and Email gadget.

Example:

The height specified in the gadget URL is 430 pixels. If you want to change the height, change the gadgetHeight parameter in the URL to the desired value. For example if you want the gadget height to be 600 pixels, change the code as follows:

<gadget>https://my-CCP-server/multisession/ui/gadgets/
         multisession-reply-gadget.xml?gadgetHeight=600</gadget>

The default and minimum height of the Manage Chat and Email gadget is 430 pixels. If you do not specify a value for the gadgetHeight parameter or if you specify a value that is less than 430, the gadget defaults to 430 pixels.

Note 

An agent can be configured to handle up to five chat contacts and five email contacts at a time. If the agent has the maximum number of contacts on the desktop, not all contacts are visible. If your agents are configured to handle the maximum number of contacts, you must increase the height of this gadget to a minimum of 570 pixels to ensure there is enough space for all of the contacts to appear.

Step 17

To add the Live Data gadgets for Web Chat and Email to the supervisor desktop:

  1. Copy the code for the Agent Chat Statistics Live Data gadget from your text file and paste it within the <gadgets></gadgets> tags for the tab on which you want it to appear.

  2. Copy the code for the Chat Queue Statistics Live Data gadget from your text file and paste it within the <gadgets></gadgets> tags for the tab on which you want it to appear.

Step 18

To add the Manage Chat and Email tab gadget to the supervisor desktop, copy the code from your text file and paste it within the <tabs></tabs> tag for the supervisor role after the Manage Call tab:

<tab>
    <id>manageCall</id>
    <label>finesse.container.tabs.supervisor.manageCallLabel</label>
</tab>
<tab>
    <id>manageNonVoiceMedia</id>
    <label>finesse.container.tabs.supervisor.manageNonVoiceMediaLabel</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://my-CCP-server/multisession/ui/gadgets/
                 multisession-reply-gadget.xml?gadgetHeight=430</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Step 19

Replace my-social-miner-server with the FQDN of your Customer Collaboration Platform server.

Step 20

Optionally, change the height of the gadget.

Step 21

Click Save.


Enable Advanced Supervisor Capabilities in Finesse

The Cisco Finesse default layout XML contains commented XML code of Advanced Supervisor Capabilities gadget for the Finesse desktop. Each gadget or tab is surrounded by comment characters (<!-- and -->) and comments that describe what the tab or gadget is for and how to add it to the desktop.


Note

The Advanced Supervisor Capability is designed for only supervisors.


The procedure that you must follow to enable the gadget depends on your deployment. The following table describes when to use each procedure.

Procedure

When to use

Enable Advanced Supervisor Capabilities for Default Desktop Layout

Follow this procedure if you want to enable Advanced Supervisor Capabilities in the Finesse desktop after a fresh installation or after an upgrade if you have not customized the default desktop layout.

Add Advanced Supervisor Capabilities in Custom Desktop Layout

Follow this procedure if you want to add Advanced Supervisor Capabilities and have customized the desktop layout.

Add Advanced Supervisor Capabilities to a team layout.

Follow this procedure if you want to add Advanced Supervisor Capabilities to the desktop for specific teams.


Note

After you enable the Advanced Supervisor Capabilities gadget, sign in to the Finesse desktop as a supervisor and ensure that they appear the way you want. When you change the desktop layout, supervisors who are signed in to Finesse must sign out and sign in again to see the change on their desktops.


Enable Advanced Supervisor Capabilities in Default Desktop Layout

If you upgraded from a previous release but do not have a custom desktop layout, click Restore Default Layout on the Manage Desktop Layout gadget and then follow the steps in this procedure.


Note

Perform this task only once at the beginning of Default Desktop Layout modification. If you do it later, the previous changes will be lost.


Procedure

Step 1

In the Finesse administration console, click the Desktop Layout in the left pane.

Manage Desktop Layout page is displayed with Desktop Layout XML.
Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

To enable Advanced Supervisor Capabilities gadget in the supervisor desktop, look for the following under the <role>Supervisor</role> tag:

<id>ASCGadget</id>
Step 4

Remove the comments and comment characters (<!-- and -->) that surround the gadget, leaving only the gadget <gadget>https://localhost/ascgadget/gadgets/ascgadget.xml</gadget>.

Step 5

Click Save.


Add Advanced Supervisor Capabilities in Custom Desktop Layout
Procedure

Step 1

In the Finesse administration console, click the Desktop Layout in the left pane.

Manage Desktop Layout page is displayed with Desktop Layout XML.
Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Copy the XML code of Advanced Supervisor Capabilities gadget.

<gadget>https://localhost/ascgadget/gadgets/ascgadget.xml</gadget>
Step 4

In the Desktop Layout XML, look for the <role>Supervisor</role> tag.

Step 5

Paste the copied code within the <tab> </tab> tags in the Desktop Layout XML, below the WebChat and Email gadget as follows:


<tab>
    <id>ASCGadget</id>
    <icon>admin</icon>
    <label>finesse.container.tabs.supervisor.advancedcapabilities</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://localhost/ascgadget/gadgets/ascgadget.xml</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Note 

Ensure that the gadget is available only for supervisors.

Step 6

Click Save.


Add Advanced Supervisor Capabilities in Team Layout
Procedure

Step 1

In the Finesse administration console, click the Desktop Layout in the left pane.

Manage Desktop Layout page is displayed with Desktop Layout XML.
Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Copy the XML code of Advanced Supervisor Capabilities gadget.

<gadget>https://localhost/ascgadget/gadgets/ascgadget.xml</gadget>
Step 4

Click the Team Resources in the left pane.

Step 5

Select the team from the list of teams for which you want to add Advanced Supervisor Capabilities.

Step 6

Check the Override System Default check box.

Step 7

In the Resources for <team name> area, click the Desktop Layout tab.

Step 8

Select from the following editors:

  • Text Editor
  • XML Editor
Step 9

In the XML, look for the <role>Supervisor</role> tag.

Step 10

Paste the copied code within the <tab> </tab> tags in the XML, below the WeChat and Email gadget as follows:


<tab>
    <id>ASCGadget</id>
    <icon>admin</icon>
    <label>finesse.container.tabs.supervisor.advancedcapabilities</label>
    <columns>
        <column>
            <gadgets>
                <gadget>https://localhost/ascgadget/gadgets/ascgadget.xml</gadget>
            </gadgets>
        </column>
    </columns>
</tab>
Note 

Ensure that the gadget is available only for supervisors.

Step 11

Click Save.


Add Team Message in Custom Desktop Layout

Procedure

Step 1

In the Finesse administration console, click the Desktop Layout in the left pane.

Manage Desktop Layout page is displayed with Desktop Layout XML.
Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Copy the XML code where component id="broadcastmessagepopover".

<component id="broadcastmessagepopover">
            <url>/desktop/scripts/js/teammessage.component.js</url>
        </component>
Step 4

Click the Team Resources in the left pane.

Step 5

Check the Override System Default check box.

Step 6

In the Resources for <team name> area, click the Desktop Layout tab.

Step 7

Select from the following editors:

  • Text Editor
  • XML Editor
Step 8

In the XML, look for the </headercolumn> tag in the XML.

Step 9

Paste the copied code below the </headercolumn> tag as follows:


<headercolumn width="50px">
    <component id="broadcastmessagepopover">
        <url>/desktop/scripts/js/teammessage.component.js</url>
    </component>
</headercolumn>
Step 10

Click Save.


Add Desktop Chat in Custom Desktop Layout

Procedure

Step 1

In the Finesse administration console, click the Desktop Layout in the left pane.

Manage Desktop Layout page is displayed with Desktop Layout XML.
Step 2

Select from the following editors:

  • Text Editor
  • XML Editor
Step 3

Copy the XML code where component id="chat".

<component id="chat">
            <url>/desktop/scripts/js/chat.component.js</url>
        </component>
Step 4

Click the Team Resources in the left pane.

Step 5

Check the Override System Default check box.

Step 6

In the Resources for <team name> area, click the Desktop Layout tab.

Step 7

Select from the following editors:

  • Text Editor
  • XML Editor
Step 8

In the XML, look for the </headercolumn> tag in the XML.

Step 9

Paste the copied code below the </headercolumn> tag as follows:


<headercolumn width="50px">
    <component id="chat">
        <url>/desktop/scripts/js/chat.component.js</url>
    </component>
</headercolumn>
Step 10

Click Save.


Live Data Gadgets

Cisco Finesse for Unified CCX supports Live Data gadgets. Live Data gadgets display information about the current state of the contact center. The gadgets receive data from the real-time data source at frequent intervals and display reports in grid format only.

Cisco Unified Intelligence Center provides Live Data real-time reports that you can add to the Cisco Finesse agent and supervisor desktop.

This feature provides the following access:

  • Agents can access the Live Data agent reports.

  • Supervisors can access the Live Data supervisor reports.

Gadgets URLs for Reports

The following table displays gadgets URLs for reports.

Users

Reports

Report View

Is the Report Available in Default Layout ?

Tab

Gadget URLs

Agent

Agent CSQ Statistics Report

Agent CSQ Statistics Report

Yes

Home

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=76D964AD10000140000000830A4E5E6F
&filterId=AgentCSQStats.csqName
=CL&compositeFilterId
=AgentCSQStats.AgentIds.agentId
=loginId</gadget>

Agent

Agent State Log Report

Agent State Log Report

Yes

My Statistics

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=420&viewId
=5D411E8A10000140000000230A4E5E6B
&filterId=AgentStateDetailStats.agentID
=loginId</gadget>

Agent

Agent Statistics Report

Agent Statistics Report

Yes

My Statistics

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=150&viewId
=67D4371110000140000001080A4E5E6B
&filterId=ResourceIAQStats.resourceId
=loginId</gadget>

Agent

Agent Team Summary Report

Agent Team Summary Report

Yes

Home

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=5C626F9C10000140000000600A4E5B33
&filterId=ResourceIAQStats.
resourceId=CL</gadget>

Supervisor

Agent Outbound Team Summary Report

Report since midnight

No

Team Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=FD919FB9100001440000005D0A4E5B29
&filterId=ResourceIAQStats.
resourceId=CL</gadget>

Supervisor

Agent Outbound Team Summary Report

Short and long term average

No

Team Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=FD919FB510000144000000470A4E5B29
&filterId=ResourceIAQStats.
resourceId=CL</gadget>

Supervisor

Chat Agent Statistics Report

Chat Agent Statistics Report

No

Team Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=120&viewId
=F2F1FC17100001440000014E0A4E5D48
&filterId=ChatAgentStats.
agentId=CL</gadget>

Supervisor

Chat CSQ Summary Report

Chat CSQ Summary Report

No

Queue Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=120&viewId
=E42ED788100001440000007B0A4E5CA1
&filterId=ChatQueueStatistics.
queueName=CL</gadget>

Supervisor

Email Agent Statistics Report

Email Agent Statistics Report

No

Team Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=BCC5767B1000014F000000580A4D3FA7
&filterId=EmailAgentStats.
agentId=CL</gadget>

Supervisor

Email CSQ Summary Report

Email CSQ Summary Report

No

Queue Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=13970B4E100001500000021C0A4D3FA7
&filterId=EmailQueueStatistics.
queueName=CL</gadget>

Supervisor

Team State Report

Team State Report

No

—

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=5C90012F10000140000000830A4E5B33
&filterId=ResourceIAQStats.
resourceId=CL</gadget>

Supervisor

Team Summary Report

Report since midnight

Yes

Team Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=728283C210000140000000530A4E5B33
&filterId=ResourceIAQStats.
resourceId=CL</gadget>

Supervisor

Team Summary Report

Short and long term average

Yes

Team Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=7291DCB410000140000000890A4E5B33
&filterId=ResourceIAQStats.
resourceId=CL</gadget>

Supervisor

Voice CSQ Agent Detail Report

Voice CSQ Agent Detail Report

Yes

Queue Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=9A7A14CE10000140000000ED0A4E5E6B
&filterId=VoiceCSQDetailsStats.
agentId=CL&compositeFilterId
=VoiceCSQDetailsStats.AgentVoiceCSQNames.
agentVoiceCSQName=CL</gadget>

Supervisor

Voice CSQ Summary

Snapshot

Yes

Queue Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=C8E2DB1610000140000000A60A4E5E6B
&filterId=VoiceIAQStats.
esdName=CL</gadget> 

Supervisor

Voice CSQ Summary

Short and long term average

Yes

Queue Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=C8EE241910000140000000C30A4E5E6B
&filterId=VoiceIAQStats.
esdName=CL</gadget>

Supervisor

Voice CSQ Summary

Report since midnight

No

Queue Data

<gadget>https://localhost:8444/cuic
/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=310&viewId
=C8EF510810000140000000EB0A4E5E6B
&filterId=VoiceIAQStats.
esdName=CL</gadget>
Gadgets Customization

You can use optional query parameter to adjust height of the gadgets.

Query Parameter
<gadget>https://localhost:8444/cuic/gadget/LiveData/LiveDataGadget.xml?
gadgetHeight=200&viewId=5C626F9C10000140000000600A4E5B33&filterId=ResourceIAQStats.resourceId=CL</gadget>
Add Live Data Gadgets to Desktop Layout

The Cisco Finesse default layout XML contains commented XML code for the Live Data gadgets available for Cisco Finesse desktop. Perform the following steps to add Live Data gadgets to desktop layout:

Procedure

Step 1

Sign in to Cisco Finesse administration console.

Cisco Finesse home page appears.
Step 2

Click the Desktop Layout tab.

Step 3

Select from the following editors:

  • Text Editor
  • XML Editor
Step 4

Copy the gadget URL for the report you want to add from Live Data Gadgets.

Example:
To add the Agent Report, copy the following:
<gadget>https://localhost:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight
=150&viewId=67D4371110000140000001080A4E5E6B&filterId=ResourceIAQStats.resourceId=loginId</gadget>
Step 5

Paste the gadget URL within the tab tags where you want it to appear.

Example:
To add the report to the home tab of the agent desktop:
<finesseLayout xmlns="http://www.cisco.com/vtg/finesse">
	<layout>
		<role>Agent</role>
		<page>
			<gadget>/desktop/gadgets/CallControl.xml</gadget>
		</page>
		<tabs>
			<tab>
				<id>home</id>
				<label>finesse.container.tabs.agent.homeLabel</label>
				<gadgets>
					<gadget>https://localhost:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight
      =310&viewId=76D964AD10000140000000830A4E5E6F&filterId=AgentCSQStats.csqName
      =CL&compositeFilterId=AgentCSQStats.AgentIds.agentId=loginId</gadget>
					<gadget>https://localhost:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight
      =310&viewId=5C626F9C10000140000000600A4E5B33&filterId
      =ResourceIAQStats.resourceId=CL</gadget>
				 </gadgets>
    <gadget>https://localhost:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight
     =150&viewId=67D4371110000140000001080A4E5E6B&filterId=ResourceIAQStats.resourceId
     =loginId</gadget>
			</tab>
			<tab>
				<id>myStatistics</id>
				<label>finesse.container.tabs.agent.myStatisticsLabel</label>
				<gadgets>
					<gadget>https://localhost:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight
    =600&viewId=5D411E8A10000140000000230A4E5E6B&filterId=AgentStateDetailStats.agentID
    =loginId</gadget>
				</gadgets>
			</tab>
			<tab>
				<id>manageCall</id>
				<label>finesse.container.tabs.agent.manageCallLabel</label>
			</tab>
		</tabs>
	</layout>
	<layout>
		<role>Supervisor</role>
		<page>
			<gadget>/desktop/gadgets/CallControl.xml</gadget>
		</page>
Step 6

Click Save. Cisco Finesse validates the XML file to ensure that it is valid XML syntax and conforms to the Cisco Finesse schema.

Step 7

To verify, log in to Cisco Finesse agent desktop as agent/Cisco Finesse supervisor desktop as supervisor and check the reports.


Add Customized Live Data Gadgets to Desktop Layout

This procedure explains how to create gadget URLs for customized Live Data reports, which are copied from stock reports, and add them to desktop layout.


Note

The new gadget renders the report only when the appropriate permission on that report is given in Cisco Unified Intelligence Center.
Procedure

Step 1

Copy the gadget URL of the stock report that you want to customize from Live Data Gadgets and paste it in a text editor.

Example:

Consider the URL shown here as the gadget URL. Copy and paste it in a text editor. The underlined ID is the value of viewID.

<gadget>https://localhost:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight=310
&viewId=5C626F9C10000140000000600A4E5B33&filterId=ResourceIAQStats.resourceId=CL</gadget>
Step 2

In Cisco Unified Intelligence Center, in the Edit view of the customized report, select the view for which you want to create the gadget URL and then click Links.

The HTML Link field displays the permalink of the customized report.
Step 3

Copy the permalink of the customized report from the HTML Link field and paste it in a text editor, then copy the viewID value from this link.

Example:

Copy the underlined viewID value from the permalink of the customized report.

https://<Server Name>:8444/cuic/permalink/PermalinkViewer.htmx?
viewId=5C90012F10000140000000830A4E5B33&linkType=htmlType&viewType=Grid
Step 4

Replace the viewID value in the gadget URL with the viewID value from the permalink of the customized report.

Example:

The customized gadget URL appears as shown here after replacing the viewID value with the viewID value of the customized report.


<gadget>https://localhost:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight=310
&viewId=5C90012F10000140000000830A4E5B33&filterId=ResourceIAQStats.resourceId=CL</gadget>
Step 5

Add the customized gadget URL to Desktop Layout in the Finesse administration console and save.

Step 6

Log in to Finesse desktop and check the report.


Configure Live Data Reports with Multiple Views

Cisco Finesse allows you to display multiple Live Data reports or views on a single gadget. Supervisors can select the desired view to display from a drop-down list on the gadget toolbar, which lists up to five report views in Report Name - View Name format.

This procedure describes how to add multiple Live Data views to the Finesse desktop layout using the viewId_n and filterId_n keys. You can specify up to five report views to appear in your gadget. The first view among the five is the default view. There is no defined order for how the remaining views are displayed.

Finesse still supports the display of a single gadget using a single viewId. However, if you specify the single viewId along with multiple viewId_n keys, the multiple views are used and the single viewId is ignored.


Note

To make sure the modified gadget renders in the Finesse desktop, you must give the appropriate permission for that report in Unified Intelligence Center.


Procedure

Step 1

For each report or view that you want to include in the gadget, obtain the associated viewId from the permalink for the view:

  1. In Unified Intelligence Center, in Edit view of the report, select the desired view then click Links.

    The HTML Link field displays the permalink of the customized report.

  2. Copy the permalink of the customized report from the HTML Link field, and paste it in a text editor, and then copy the viewID value from the permalink and save it.

    Example:

    Copy the viewId, which is underlined in this example, from the permalink for the report.

    
    https://<Server Name>:8444/cuic/permalink/PermalinkViewer.htmx?
    viewId=5C90012F10000140000000830A4E5B33&linkType=htmlType&viewType=Grid
    
    
Step 2

From the Finesse default layout XML, copy the gadget URL for one of the Live Data reports and paste it into a text editor.

Example:

Copy the URL for the Agent Skill Group for HTTPS from the default layout XML and paste it into a text editor:


<gadget>https://my-cuic-server:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight=310&
viewId_1=9AB7848B10000141000001C50A0006C4&filterId_1=agent.id=CL%20teamName</gadget>

Step 3

To update the URL to refer to a different report view, populate the viewId_1 value (after the equal sign) with the desired viewId obtained in step 1.

Example:

The following shows the URL updated with the example viewId copied from step 1.


<gadget>https://my-cuic-server:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight=310&
viewId_1=5C90012F10000140000000830A4E5B33&filterId_1=agent.id=CL%20teamName</gadget>
Step 4

For each additional view you want to include:

  1. At the end of the URL, copy and paste the viewId_1 and agentId_1 strings with a leading ampersand.

    Example:
    
    <gadget>https://my-cuic-server:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight=310&
    viewId_1=5C90012F10000140000000830A4E5B33&filterId_1=agent.id=CL%20teamName&
    viewId_1=5C90012F10000140000000830A4E5B33&filterId_1=agent.id=CL%20teamName</gadget>
    
  2. Update the copied viewId_1 and filterId_1 in the URL to the next available integer (in this example, viewId_2 and filterId_2).

    Example:
    
    <gadget>https://my-cuic-server:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight=310&
    viewId_1=5C90012F10000140000000830A4E5B33&filterId_1=agent.id=CL%20teamName&
    viewId_2=5C90012F10000140000000830A4E5B33&filterId_2=agent.id=CL%20teamName</gadget>
    
  3. Populate the copied viewId value (after the equal sign) with the value defined in the permalink for the desired report (in this example, 99E6C8E210000141000000D80A0006C4).

    Example:
    
    <gadget>https://my-cuic-server:8444/cuic/gadget/LiveData/LiveDataGadget.xml?gadgetHeight=310&
    viewId_1=5C90012F10000140000000830A4E5B33&filterId_1=agent.id=CL%20teamName&
    viewId_2=99E6C8E210000141000000D80A0006C4&filterId_2=agent.id=CL%20teamName</gadget>
    
  4. Make sure that the filterId value matches the type required by the report type, as follows:

    • Agent Reports: filterId_N=agent.id=CL%20teamName

    • Agent Skill Group Reports: filterId_N=agent.id=CL%20teamName

    • Skill Group Reports: filterId_N=skillGroup.id=CL%20teamName

    • Precision Queue Reports: filterId_N=precisionQueue.id=CL%20teamName

Step 5

Replace my-cuic-server with the FQDN of your Cisco Unified Intelligence Center Server.

Step 6

Add the customized gadget URL to the desktop layout XML in the Manage Desktop Layout gadget and click Save.


Manage Phone Books

On the Phone Books tab of the Cisco Finesse administration console, you can create and manage global and team phone books and phone book contacts. Global phone books are available to all agents; team phone books are available to agents in that specific team.

Phone Books and Contacts

Finesse supports the following number of phone books:

  • 10 global phone books

  • 300 team phone books

The system supports a total of 50,000 contacts. The total number of contacts per agent across all phone books is limited to 6000.

Use the Manage Phone Books gadget to view, add, edit, or delete phone books and phone book contacts. Click the Name or Assign To headers to sort the phone books in ascending or descending order. Click the last Name, First Name, Number, or Note headers to sort the contacts in ascending or descending order.

The following table describes the fields on the Manage Phone Books gadget:

Field

Explanation

Name

The name of the phone book. It must be unique, and can be a maximum of 64 alphanumeric characters.

Assign To

Indicates if the phone book is global (All Users) or team (Teams).

Last Name

The last name of a contact. The last name can be a maximum of 128 characters. This field is optional.

First Name

The first name of a contact. The first name can be a maximum of 128 characters. This field is optional.

Number

The phone number for the contact. The phone number can be 1-32 characters long and cannot be blank.

Note

Optional text that describes the contact. The note can be a maximum of 128 characters.

Actions on the Manage Phone Books gadget:

  • New: Add a new phone book or contact

  • Edit: Edit an existing phone book or contact

  • Delete: Delete a phone book or contact

  • Refresh: Reload the list of phone books or contacts from the server

  • Import: Import a list of contacts to the phone book

  • Export: Export a list of contacts from the phone book

Add Phone Book

Procedure

Step 1

In the Manage Phone Books gadget, click New.

Step 2

In the Name field, enter a name for the phone book.

Note 

Phone book names can be a maximum of 64 characters.

Step 3

From the Assign To drop-down, select All Users if the phone book is global or Teams if the phone book is available to specified teams.

Step 4

Click Save.


Edit Phone Book

Procedure

Step 1

In the Manage Phone Books gadget, select the phone book you want to edit.

Step 2

Click Edit.

Step 3

In the Name field, enter the new name for the phone book. If you want to change who can access the phone book, in the Assign To drop-down, choose All Users or Teams.

Step 4

Click Save.

If you change the Assign To field from Teams to All Users, click Yes to confirm the change.


Delete Phone Book

Procedure

Step 1

In the Manage Phone Books gadget, select the phone book that you want to delete.

Step 2

Click Delete.

Step 3

Click Yes to confirm the deletion of the selected phone book.


Import Contacts

The Import function allows you to replace all the contacts in a phone book with a new list of contacts, or to populate a new phone book with contacts.

The import list must be in the specified comma separated values (CSV) format, and can contain a maximum of 6000 contacts. Import lists that contain more than 6000 contacts are rejected with an error message.

The CSV file contains the fields described in the following table:

Field

Max Length

Can Be Blank?

Permitted Characters

First Name

128

Yes

Alphanumeric characters

Note 

The CSV file that contains the contacts to import must use Latin encoding.

Last Name

128

Yes

Phone Number

32

No

Notes

128

Yes

The following is an example of a phone book CSV file:

"First Name","Last Name","Phone Number","Notes"
"Amanda","Cohen","6511234",""
"Nicholas","Knight","612-555-1228","Sales"
"Natalie","Lambert","952-555-9876","Benefits"
"Joseph","Stonetree","651-555-7612","Manager"

A phone book CSV file must conform to this format and include the headers in the first line. During import, the file is scanned for illegal characters. If any are found, they are replaced with question marks.


Note

Exported CSV files always show each field enclosed in double quotes to ensure that any commas or double quotes that are part of the actual filed data are not mistaken for field delimiters. If your data does not include these characters, you can omit the double quotes in files you prepare for importing.


Procedure

Step 1

In the Manage Phone Books gadget, select the phone book into which you want to import a list of contacts.

Step 2

Click Import.

Step 3

Click Browse and navigate to the location of the CSV file containing the contacts you want to import.

Note 

The CSV file must use Latin encoding.

Step 4

Click OK.


Export Contacts

The Export function allows you to extract a list of contacts from an existing phone book. The exported list is saved in CSV format.

Procedure

Step 1

In the Manage Phone Books gadget, select the phone book that contains the contacts you want to export.

Step 2

Click Export.

Step 3

Click Open to open the CSV file in Excel, or click the Save drop-down list and choose Save, Save as, or Save and open.

Step 4

A message appears that gives you the option to view the downloaded file, open the folder into which the download was saved, view the Internet Explorer View Downloads window, or dismiss the message without viewing the file.

Step 5

A message appears that gives you the option to view the downloaded file, open the folder into which the download was saved, view the Internet Explorer View Downloads window, or dismiss the message without viewing the file.


Add Contact

Procedure

Step 1

In the Manage Phone Books gadget, select the phone book to which you want to add a contact.

The List of Contacts for <phone book name> area appears.

Step 2

Click New.

Step 3

Complete the fields. The First Name, Last Name, and Note fields are optional and have a maximum length of 128 characters. The Number field is required and has a maximum length of 32 characters.

Step 4

Click Save.


Edit Contact

Procedure

Step 1

In the Manage Phone Books gadget, select the phone book that contains the contact you want to edit.

The List of Contacts for <phone book name> area appears.

Step 2

Select the contact you want to edit.

Step 3

Click Edit.

Step 4

Edit the fields that you want to change. The First Name, Last Name, and Note fields are optional and have a maximum of 128 characters. The Number field is required and has a maximum of 32 characters.

Step 5

Click Save.


Delete Contact

Procedure

Step 1

In the Manage Phone Books gadget, select the phone book that contains the contact you want to delete.

The List of Contacts for <phone book name> area appears.

Step 2

Select the contact that you want to delete.

Step 3

Click Delete.

Step 4

Click Yes to confirm the deletion of the selected contact.


Manage Reasons

The Reasons tab on the Cisco Finesse administration console allows you to view, add, edit, and delete Not Ready reason codes, Sign Out reason codes, and Wrap-Up reasons.


Note

Certain reason codes are reserved and cannot be used.

For Unified CCX systems, these reserved reason codes are as follows: 0, 22, and 33.


Not Ready Reason Codes

Not Ready reason codes represent reasons that agents can select when they change their state to Not Ready.

Use the Manage Reason Codes (Not Ready) gadget to view, add, edit, or delete Not Ready reason codes.

  1. Click the Reason Label or Reason Code headers to sort the Not Ready reason codes by label or reason code in ascending or descending order.

  2. Click the Type header to sort and display system or custom reason codes.

  3. Click the Global header to sort reason codes by whether they are global (Yes) or not (No).

Not Ready reason codes can be global (visible to all agents) or team (visible only to agents on specified teams).


Note

Finesse supports a total of 200 Not Ready reason codes. This includes a maximum of 100 global Not Ready reason codes, and 100 team Not Ready reason codes. The team reason codes can be mapped to any team, and the same reason code can be mapped to multiple teams.


The following table describes the fields on the Manage Reason Codes (Not Ready) gadget:

Field

Explanation

Reason Label

The label for the Not Ready reason code.

The label has a maximum length of 40 characters and should be unique for each Not Ready reason code. Alphanumeric and special characters are supported.

Type

The type of reason code (System or Custom).

The column is default and can be sorted to display both System reason codes and Custom reason codes.

Reason Code

A code for the Not Ready reason.

The value of the code must be between 1 and 999 and must be unique.

Global?

Yes/No. Indicates if the reason code is available globally to all agents (Yes) or to specific teams of agents (No).

Actions on the Manage Reason Codes (Not Ready) gadget:

  • New: Add a new Not Ready reason code

  • Edit: Edit an existing Not Ready reason code

  • Delete: Delete a Not Ready reason code

  • Refresh: Reload the list of Not Ready reason codes from the server


Note

When you add, edit, or delete a Not Ready reason code, the changes you make take effect on the Finesse desktop after three seconds. However, agents who are signed in when the changes are made must sign out and sign back in to see those changes reflected on their desktops.


When an agent signs in to the Finesse desktop, the agent state is set to Not Ready. The agent can then choose to go to Ready status or choose from one of the configured Not Ready reason codes from the agent state drop-down list.

If an agent wants to change from Ready to Not Ready status, that agent can choose the appropriate Not Ready reason code from the list of configured codes.

An agent who is on a call can select a state to be applied when the call is complete. For example, if an agent wants to be in Not Ready state when the call ends, that agent can choose Not Ready from the drop-down list while still on the call. The Finesse desktop shows the agent in Talking state and a pending state of Not Ready.

Pending state changes appear on the desktop while the agent's state is Talking (for example, on hold, in a consult call, conference, or silent monitor call).


Note

During a PG or CTI server failover, the pending state of an agent is not retained.


Add Not Ready Reason Code
Procedure

Step 1

In the Manage Reason Codes (Not Ready) gadget, click New.

Step 2

In the Reason Label box, enter a label for the reason code.

Note 

Not Ready reason code labels are limited to 40 characters.

Step 3

In the Reason Code box, an auto populated reason code is displayed. If you choose not to save the prepopulated reason code, you can enter your own reason code.

Note 

The code must be between 1 and 999 and must be unique.

Ensure there are no leading or trailing spaces.

Step 4

If the reason code is global, select the Global? check box. If the reason code is specific to a team, clear the Global? check box.

Note 

By default, the Global? check box is selected.

Step 5

Click Save.

Note 

The Finesse server removes leading or trailing spaces before saving the Reason Label in the database.


Edit Not Ready Reason Code
Procedure

Step 1

In the Manage Reason Codes (Not Ready) gadget, select the reason code that you want to edit.

Step 2

Click Edit.

Step 3

If you want to change the label for the Not Ready reason code, in the Reason Label field, enter a new label for the reason code. If you want to change the code, in the Reason Code field, enter the new code. If you want to change who has access to the code, select or clear the Global? check box.

Step 4

Click Save.


Delete Not Ready Reason Code

Note

An error may occur if an agent selects a Not Ready reason code after it has been deleted. Agents who are signed in when you make changes to Not Ready reason codes must sign out and sign back in to see those changes reflected on their desktops.


Procedure

Step 1

In the Manage Reason Codes (Not Ready) gadget, select the Not Ready reason code that you want to delete.

Step 2

Click Delete.

Step 3

Click Yes to confirm the deletion of the selected reason code.


Sign Out Reason Codes

Sign Out reason codes represent reasons that agents can select when they sign out of the Finesse desktop.

Use the Manage Reason Codes (Sign Out) gadget to view, add, edit, or delete Sign Out reason codes. Click the Reason Label or Reason Code headers to sort the Sign Out reason codes by label or by reason code, in ascending or descending order. Click the Type header to sort and display system or custom reason codes. Click the Global header to sort the reason codes by whether they are global (Yes) or not (No).

Sign Out reason codes can be global (visible to all agents) or team (visible only to agents on specified teams).


Note

Finesse supports 200 Sign Out reason codes. These include 100 global Sign Out reason codes, and 100 Sign Out team reason codes. The team reason codes can be mapped to any team, and the same reason code can be mapped to multiple teams.


The following table describes the fields on the Manage Reason Codes (Sign Out) gadget:

Field

Explanation

Reason Label

The label for the Sign Out reason code.

The label has a maximum length of 40 characters and should be unique for each Sign Out reason code. Alphanumeric and special characters are supported.

Type

The type of reason code (System or Custom).

The column is default and can be sorted to display both System reason codes and Custom reason codes.

Reason Code

A code for the Sign Out reason.

The code must be between 1 and 999 and must be unique.

Global?

Yes/No. Indicates if the reason code is available globally to all agents (Yes) or to specific teams of agents (No).

Actions on the Manage Reason Codes (Sign Out) gadget:

  • New: Add a new Sign Out reason code

  • Edit: Edit an existing Sign Out reason code

  • Delete: Delete a Sign Out reason code

  • Refresh: Reload the list of Sign Out reason codes from the server


Note

When you add, edit, or delete a Sign Out reason code, the changes you make take effect on the Finesse desktop after three seconds. However, agents who are signed in when the changes are made must sign out and sign in again to see those changes reflected on their desktops.


When an agent clicks Sign Out on the desktop, any configured Sign Out codes appear in a drop-down list. The agent can select the code that represents why that agent is signing out.

Add Sign Out Reason Code
Procedure

Step 1

In the Manage Reason Codes (Sign Out) gadget, click New.

Step 2

In the Reason Label box, enter a label for the reason code.

Note 

Sign Out reason code labels are limited to 40 characters.

Step 3

In the Reason Code box, an auto populated reason code is displayed. If you choose not to save the prepopulated reason, you can enter your own reason code.

Note 

The code must be between 1 and 999 and must be unique.

Ensure there are no leading or trailing spaces.

Step 4

If the reason code is global, select the Global? check box. If the reason code is specific to a team, clear the Global? check box.

Note 

By default, the Global? check box is selected.

Step 5

Click Save.


Edit Sign Out Reason Code
Procedure

Step 1

In the Manage Reason Codes (Sign Out) gadget, select the reason code that you want to edit.

Step 2

Click Edit.

Step 3

If you want to change the label of the Sign Out reason code, in the Reason Label field, enter a new label for the reason code. If you want to change the code, in the Reason Code field, enter the new code. If you want to change who has access to the code, select or clear the Global? check box.

Step 4

Click Save.


Delete Sign Out Reason Code

Note

An error may occur if an agent selects a Sign Out reason code after it has been deleted. Agents who are signed in when you make changes to Sign Out reason codes must sign out and sign back in to see those changes reflected on their desktops.


Procedure

Step 1

In the Manage Reason Codes (Sign Out) gadget, select the Sign Out reason code that you want to delete.

Step 2

Click Delete.

Step 3

Click Yes to confirm the deletion of the selected Sign Out reason code.


Predefined System Reason Codes

For Not Ready system reason codes and Sign Out system reason codes, only the reason code label can be edited and saved. The Global attribute and system code cannot be modified. In case the system reason code label is modified and you wish to revert to the default label, refer to the following list of predefined system reason codes:

System Reason Code

Reason Label

Reason Label Description

32767

Logged Out - Device Conflict

The system issues this reason code when an agent is already logged in to one device (computer or phone) and then tries to re-login to a second device.

32765

Logged Out - System Disconnect

The system issues this reason code when a Cisco Finesse IP Phone Agent or Cisco Finesse desktop crashes due to any reason or if the connection is disrupted.

32764

Logged Out - System Standby

The system issues this reason code when the active server becomes the standby server and the agent loses connection to the Unified CCX Platform.

32763

Not Ready - Call Not Answered

The system issues this reason code when the agent fails to answer a Unified CCX call within the specified timeout period.

32762

Not Ready - Offhook

The system issues this reason code when the agent goes off the hook to place a call. If the agent remembers to do this task the corresponding agent-triggered reason code is displayed. If the agent does not remember to do this task, the system issues this reason code.

32761

Not Ready - Non ACD Busy

The system issues this reason code when the agent is logged on to the Cisco Finesse desktop or Cisco Finesse IP phone and then receives a call that is not queued on the Unified CCX Platform.

32760

Not Ready - Log On

The system issues this reason code when an agent logs in and is automatically placed in the Not Ready state.

32759

Not Ready - Phone Failure

The system issues this reason code if the agent’s phone crashes and that agent is placed in the unavailable state.

32758

Not Ready - Wrap Up Timer Expiry

The system issues this reason code when an agent’s state is changed from WORK to Not Ready. This change occurs if the WORK state for that agent’s CSQ is associated with an expired wrap-up timer.

32757

Not Ready - CUCM Failover

The system issues this reason code when the Unified CM fails over and the agent is moved to the Not Ready state.

32756

Not Ready - Phone Working

The system issues this reason code when the agent’s phone comes up after it has been through a Phone Down state.

32755

Not Ready - Call Ended

The system issues this reason code when an agent is moved to the Not Ready state after handling a Unified CCX call. This situation occurs in one of two cases:

  1. If an agent (Agent 1) is in the Not Ready state and gets a consult Unified CCX call from another agent (Agent 2). In this case, after handling the call, Agent 1 moves back to the Not Ready state.

  2. If an agent’s Automatic Available option is disabled and this agent gets a Unified CCX call, then this agent goes to the Not Ready state after handling the call.

32749

Not Ready - Call Cancel

The system issues this reason code when an agent’s state is changed from TALKING to Not Ready because of the Cancel feature. The feature is triggered during an ICD consult call between two agents. When the consulting agent presses the Cancel softkey on the phone, the consulted agent is no longer associated with an ICD call and their state changes to Not Ready. This feature is only available on some newer phone models.

32754

Not Ready - Restricted Device

The system issues this reason code if the agent device is flagged as a restricted device by the Unified CM Administrator.

32753

Not Ready - Restricted Line

The system issues this reason code if the agent’s phone line is flagged as a restricted device by the Unified CM Administrator.

32752

Not Ready - Cancel Reservation Preview Call

The system issues this reason code when an agent receives a preview outbound call and decides to cancel the reservation by pressing "Decline" button on Cisco Finesse desktop.

32751

Not Ready - Skip Preview Call

The system issues this reason code when an agent receives a preview outbound call and skips the call.

32748

Log Out - Agent Deleted

Agent is logged out from Unified CCX as the agent is deleted from Unified Communications Manager. This event is triggered when Unified CCX synchronizes the agent information with Unified Communications Manager.

32750

Not Ready - Extension Modified

The system issues this reason code when an agent is logged out from CCX because the agent’s IPCC extension was changed in Unified Communications Manager.

32742

Not Ready - Non ACD Offhook

Agent's state is changed from Ready state to Not Ready state when the monitored Non ICD lines are used for Incoming or Outgoing calls.

32741

Logged Out - Extension Conflict

The system issues this reason code when an agent logs in to Cisco Finesse using an extension number that has already been used by another agent to log in, the first agent is logged out forcibly with this reason code.

32740

Logout - System Initiated Relogin

The system logs out the agent from one session when the agent tries to log in with the same credentials in another session.

33

Not Ready - Supervisor Initiated

The system issues this reason code when the Supervisor changes an agent’s state to Not Ready state.

22

Logged Out - Supervisor Initiated

The system issues this reason code when the Supervisor changes an agent’s state to log out.

255

Logged Out - Connection Failure

The system issues this reason code when the agent is forcibly logged out when there is a connection failure between the Cisco Finesse Desktop and the Cisco Finesse Server.

Manage Reason Code Conflicts During Upgrade

System Reason Codes are auto-generated reason codes that may conflict with custom reason codes when upgrading from an older version to Cisco Finesse 11.6(1). If there is a reason code conflict then the following message appears when you sign in to the administration console:

Custom reason codes conflict with system reason codes. Resolve to avoid reporting inconsistency.


Note

Clear your browser cache to ensure that you are allowed to view and resolve system reason code conflicts.


All conflicting reason codes are highlighted. To edit, select each conflicting reason code and click Edit. The Edit Reason Code area appears. Select the reason code from the available options listed or enter any other code you wish. The code must be unique to the particular category (Not Ready or Sign Out).

Once resolved, the reason code gets sorted based on the reason code number and placed in the table accordingly.

Wrap-Up Reasons

Wrap-Up reasons represent the reasons that agents can apply to calls. A Wrap-Up reason indicates why a customer called the contact center. For example, you may have one Wrap-Up reason for sales calls and another for support calls.

You can configure Wrap-Up reasons to be available globally to all agents or only to specific teams.

Use the Manage Wrap-Up Reasons gadget to view, add, edit, or delete Wrap-Up reasons. Click the Reason Label header to sort the Wrap-Up reasons in ascending or descending order.


Note

Cisco Finesse supports a maximum of 100 global and 1500 team Wrap-Up reasons. No more than 100 Wrap-Up reasons can be assigned to any one team.


Cisco Finesse supports the wrap-up functionality for all types of inbound and outbound calls.


Note

The showWrapUpTimer property can be used to show or hide timer in wrap-up state.

If showWrapUpTimer is set to true then timer is displayed.

If showWrapUpTimer is set to false then timer is hidden.



Note

Wrap-Up timer is configurable. By default wrapUpCountDown property is set to true. The timer counts down by default when the agent is in wrap-up state. For more information, see Desktop Properties.

For Example, if you set the timer to 30 seconds, by default the timer starts from 30 and ends at zero.

The default behavior can be changed by setting the wrapUpCountDown property to false.

If an agent is configured for wrap-up and selects a pending state during a call, when the call finishes that agent goes into the pending state selected during the call.


The following table describes the fields on the Manage Wrap-Up Reasons gadget:

Field

Explanation

Reason Label

The label for the Wrap-Up reason.

This label must be unique for each Wrap-Up reason and has a maximum length of 39 bytes (which equals 39 US English characters). Both alphanumeric and special characters are supported.

Global?

Yes/No. Indicates if the Wrap-Up reason is available globally to all agents (Yes) or to specific teams of agents (No).

Actions on the Manage Wrap-Up Reasons gadget:

  • New: Add a new Wrap-Up reason

  • Edit: Edit an existing Wrap-Up reason

  • Delete: Delete a Wrap-Up reason

  • Refresh: Reload the list of Wrap-Up reasons from the server


Note

When you add, edit, or delete a Wrap-Up reason, the changes you make take effect on the agent or supervisor desktop after three seconds. However, agents who are signed in when the changes are made must sign out and sign in again to see those changes reflected on their desktops.


Add Wrap-Up Reason
Procedure

Step 1

In the Manage Wrap-Up Reasons gadget, click New.

Step 2

In the Reason Label field, add a label for the Wrap-Up reason.

Note 

Wrap-Up reason labels are limited to 39 bytes.

Step 3

If the Wrap-Up reason is global, select the Global? check box. If the Wrap-Up reason is specific to a team, clear the Global? check box.

Note 

By default, the Global? check box is selected.

Step 4

Click Save.


Edit Wrap-Up Reason
Procedure

Step 1

In the Manage Wrap-Up Reasons gadget, select the Wrap-Up reason that you want to edit.

Step 2

Click Edit.

The Edit Wrap-Up Reason area appears.

Step 3

In the Wrap-Up Reason Label field, enter the new label for the Wrap-Up reason. If you want to change who has access to the Wrap-Up reason, select or clear the Global? check box.

Step 4

Click Save.


Delete Wrap-Up Reason
Procedure

Step 1

In the Manage Wrap-Up Reasons gadget, select the Wrap-Up reason that you want to delete.

Step 2

Click Delete.

A question appears asking you to confirm that you want to delete the selected Wrap-Up reason.

Step 3

Click Yes to confirm the deletion of the selected Wrap-Up reason.


Force Wrap-Up Reason

For voice channel-If the Force Wrap-Up reason is configured, agents must select a Wrap-Up reason before changing the state after the call ends. The agent cannot change the state until the Wrap-up reason is applied. The Wrap-Up reason can be selected during the call or after the call ends.

For digital channels-If the Force Wrap-Up reason is configured, agents must select a Wrap-Up reason before transfering or ending an interaction.


Note

The Force Wrap-Up reason is disabled by default. Use the CLI commands to enable and disable this feature. For more information, see Desktop Properties in Cisco Finesse Administration Guide.


Manage Team Resources

You can assign phone books, reason codes, wrap-up reasons, custom desktop layouts, and workflows to teams on the Team Resources tab of the administration console.

Team Resources

Use the Manage Team Resources gadget on the Team Resources tab to assign and unassign phone books, reasons, custom desktop layouts, and workflows to teams. Click the Name or ID header to sort the teams in ascending or descending order.

The Manage Team Resources gadget contains six tabs, each enabling you to assign or unassign resources to a team. The tabs are defined in the following table:

Tab Name

Description

Desktop Layout

Use this tab to customize the desktop layout for the team. The default layout is defined in the Manage Desktop Layout gadget. You can define one custom layout for the team.

Phone Books

Use this tab to assign and unassign phone books to the team. Only phone books that are defined in the Manage Phone Books gadget as available to teams are available for assignment.

Reason Codes (Not Ready)

Use this tab to assign and unassign Not Ready reason codes to the team. Only Not Ready reason codes that are defined in the Manage Reason Codes (Not Ready) gadget as available to teams (not global) are available for assignment.

Reason Codes (Sign Out)

Use this tab to assign and unassign Sign Out reason codes to the team. Only Sign Out reason codes that are defined in the Manage Reason Codes (Sign Out) gadget as available to teams (not global) are available for assignment.

Wrap-Up Reasons

Use this tab to assign and unassign Wrap-Up reasons to the team. Only Wrap-Up reasons that are defined in the Manage Wrap-Up Reasons gadget as available to teams (not global) are available for assignment.

Workflows

Use this tab to assign and unassign workflows to the team. Only workflows that are defined in the Manage Workflows gadget are available for assignment.

Actions on the Manage Team Resources Gadget
  • Add: Assign a phone book, reason, or workflow to the team

  • Save: Save the phone book, reason, desktop layout assignment, or workflow to the team

  • Revert: Cancel any changes made before they are saved

  • Refresh: Refresh the list of teams


    Note

    If you select a team and then click Refresh, the team is deselected and the Resources area for that team disappears. The list of teams is refreshed and you must select a team again.


Add or Delete a Team When Database is Not Accessible

If you add or delete a team when Finesse cannot access the Finesse database, those changes do not appear in the Finesse administration console unless you restart Cisco Finesse Tomcat or the Cisco Unified CCX Engine.

Assign Phone Books and Reasons to Team

Procedure

Step 1

In the Manage Team Resources gadget, select a team.

Step 2

Click the tab for the resource you want to assign for the selected team.

Step 3

Click Add.

Step 4

Select one or more resources from the list to assign them to the team.

Resources you assign are highlighted in blue in the Add <resources> popup and added to the List of <resources> area.

Step 5

When you finish assigning resources, click Save.

Note 

You can make changes on all resource tabs and then save them at the same time. If there is an error on one resource tab but not others, the changes on the tabs with no errors are saved while the changes on the tab with errors are not saved.


Unassign Phone Books and Reasons from Team

Procedure

Step 1

In the Manage Team Resources gadget, select a team.

Step 2

Click the tab for the resource you want to unassign from the selected team.

Step 3

Click the red X next to the resource you want to unassign.

Step 4

Click Save.


Assign Custom Desktop Layout to Team

Procedure

Step 1

In the Manage Team Resources gadget, select a team.

Step 2

Click Desktop Layout.

The Desktop Layout XML area appears. The area contains the default desktop layout XML.

Step 3

Select the Override System Default check box.

The XML becomes editable.

Step 4

Select from the following editors:

  • Text Editor
  • XML Editor

For more information, see Default Layout XML.

Step 5

Edit the XML.

Step 6

Click Save.

The custom desktop layout replaces the default desktop layout for the team after 10 seconds. If a supervisor or agent is signed in when the change is saved, the change does not take effect on their desktop until the supervisor or agent signs out and signs in again.

Note 

If you clear the Override System Default check box, any changes you made to the XML are lost and the XML in the editing pane reverts to the default desktop layout XML.



Note

If the Supervisor is managing single / multiple teams, the custom layout of the team for which the supervisor is a resource/agent is displayed. However, if the supervisor is not the resource/agent of a team, the layout of the default team is displayed.


Customize Desktop Properties at Team Level

You can customize the Finesse desktop properties for a specific team.

Procedure

Step 1

In the Manage Team Resources gadget, select a team.

Step 2

Click Desktop Layout.

Step 3

Select the Override System Default check box.

Step 4

Select from the following editors:

  • Text Editor
  • XML Editor
Step 5

Enter the desktop property name in the config key tag.

Step 6

Enter the possible value of the desktop property in the value tag.

The following are the sample desktop property entries, as displayed in the default Desktop Layout. To change these desktop property entries in Text Editor, remove the comment (<!-- and -->) and set appropriate values.

Note 

If the property value is defined in the team-specific desktop layout (Manage Team Resources > Desktop Layout), then the team-specific desktop layout takes precedence over the property value defined in the Desktop Layout and CLI.

For more information on customizing desktop properties at Desktop Layout, see Customize Desktop Properties.

For more information on Finesse CLIs, see Desktop Properties.

The following table lists the desktop properties that support team-level updates:

Config Key

Value

Default Value

enableDragDropAndResizeGadget

true|false

false

enableShortCutKeys

true|false

true

forceWrapUp

true|false

true

wrapUpCountDown

true|false

true

showWrapUpTimer

true|false

true

desktopChatAttachmentEnabled

true|false

true

desktopChatMaxAttachmentSize

Range: 1—10 (MB)

5

desktopChatUnsupportedFileTypes

Unsupported file formats include comma-separated valid file extensions. For example: .exe, .sh

.exe, .msi, .sh, .bat

showAgentHistoryGadgets

true|false

true

showActiveCallDetails

(for Supervisor Only)

true|false

true

pendingDTMFThresholdCount

Range: 1—20

20

dtmfRequestTimeoutInMs

Range: 1000—200000 (1 to 200 seconds)

5000 (5 seconds)

enableDropParticipantFor

supervisor_only|conference_controller_

and_supervisor|all

supervisor_only

dropParticipant

agents|all

agents

Note 
  • To enable the following Finesse desktop properties in Cisco Finesse, install Cisco Finesse Release 12.5(1) ES1 COP or higher.

    • pendingDTMFThresholdCount

    • dtmfRequestTimeoutInMs

  • To enable the following Finesse desktop properties in Cisco Finesse, install Cisco Finesse Release 12.5(1) ES4 COP or higher.

    • enableDropParticipantFor

    • dropParticipant

For more information on Finesse desktop properties, see Desktop Properties.

Step 7

Click Save.

The change takes effect when the agent or supervisor refreshes the Finesse desktop or sign out and sign in again.

Note 

If you clear the Override System Default check box and click Save. The changes are overwritten, and the editing pane reverts to the default desktop layout XML.


Assign Workflows to Team

Procedure

Step 1

In the Manage Team Resources gadget, select a team.

Step 2

Click the Workflows tab.

Step 3

Click Add.

Step 4

Select one or more workflows from the list to assign them to the team.

Workflows you assign are highlighted in blue in the Add Workflows popup and added to the List of Workflows area.

Step 5

Workflows are executed in the order they are listed. Use the up and down arrows to move a selected workflow to the desired position in the list.

Step 6

When you has finished assigning workflows, click Save.

Note 

You can make changes on all resource tabs and then save them at the same time. If there is an error on one resource tab but not on others, the changes on the tabs with no errors are saved while the changes on the tab with errors are not saved.


Unassign Workflows from Team

Procedure

Step 1

In the Manage Team Resources gadget, select a team.

Step 2

Click the Workflows tab.

Step 3

Click the red X next to the workflow to unassign.

Step 4

Click Save.


Manage Workflows

On the Workflows tab of the Cisco Finesse administration console, you can create and manage workflows and workflow actions.

Workflows and Workflow Actions

You can use workflows to automate common repetitive agent tasks. A workflow has a unique name and a helpful description. Use the Manage Workflows and Manage Workflow Actions gadgets to view, add, edit, or delete workflows and workflow actions.

All workflows are team-level workflows. You cannot create a global workflow. If you need a global workflow, create a team workflow and assign it to all teams.

Cisco Finesse supports the following number of workflows and workflow actions:

  • 100 workflows per Cisco Finesse system

  • 100 actions per Cisco Finesse system

  • 20 workflows per team

  • Five conditions per workflow

  • Five actions per workflow

  • Five variables per action

  • For Voice - Call variables, Outbound Option variables, queue details, wrap-up reasons, agent details, or team details.

  • For Email - Queue name and email attributes like From, To, Cc, Bcc, or Subject.

  • For Chat - Queue name, chat type, or system defined customer details as available from the web chat form.

Click the column headers to sort workflows and workflow actions in ascending or descending order.

The following table describes the fields on the Manage Workflows gadget:

The following table describes the fields on the Manage Workflow Actions gadget:

Field

Explanation

Name

The name of the workflow action must be unique and can have a maximum length of 64 characters.

Type

The type of workflow. Possible values are Browser Pop and HTTP Request.

Actions on the Manage Workflows and Manage Workflow Actions gadgets:

  • New: Add a new workflow or workflow action

  • Edit: Edit a workflow or workflow action

  • Delete: Delete a workflow or workflow action

  • Refresh: Reload the list of workflows or workflow actions from the server.

You can configure workflow actions to be handled by the Cisco Finesse desktop or in a third-party gadget. A third-party gadget can be designed to handle the action differently than Cisco Finesse does.

Each workflow must contain only one trigger. Triggers are based on Cisco Finesse dialog events.


Note

You can configure the trigger only after you select the media.
  • Voice dialog events include the following:

    • When a Call arrives

    • When a Call is answered

    • When a Call ends

    • When making a Call


      Note

      The call variable workflow responds as expected only when you add both the conditions Is not equal and Is not empty.


    • While previewing an Outbound Option call.

The workflow engine uses the following simple logic to determine whether to execute a workflow:


Note

The workflow logic and examples are similar for all media.


  • Its trigger set and conditions are evaluated against each dialog event received.

  • The workflow engine processes workflow events for the first call that matches any configured workflow's trigger set and conditions. No other workflows run until this call has ended. If the agent accepts a second call while still on the first call, workflows do not run on the second call even after the first call has ended.

  • After a workflow for a particular trigger type (for example, Call Arrives) executes, it never triggers again for the same dialog ID.

The workflow engine caches workflows for an agent when the agent signs in. Workflows do not change for the agent until the agent signs out and signs in again or refreshes the browser.


Note

Whenever the browser is refreshed, the workflows that trigger the following events run:

  • when a call arrives

  • when a call is answered

  • when making a call

When an agent refreshes the browser, the workflow engine considers the call as newly arrived or newly made. If an HTTP request action is part of the workflow, the HTTP request is sent when the agent refreshes the browser. Applications that receive the HTTP requests must account for this scenario.


An example of a workflow is a Call Arrival event that triggers an action that collects information from the dialog event (for example, the ANI or customer information) and displays a web page containing customer information.

You can filter trigger events by the value of the data that comes in the event. You can configure a workflow to execute if any of the conditions are met or if all the conditions are met.

Individual conditions comprise of the following:

  • A piece of event data to be examined. For example, DNIS or call variables.

  • A comparison between the event data and the values entered (for example contains, is equal to, is not equal to, begins with, ends with, is empty, is not empty, and is in list).

When the trigger and its conditions are satisfied, a list of actions assigned to the workflow are executed. The actions are executed in the listed order.

Workflows run only for agents and supervisors who are Cisco Finesse users. The Workflow Engine is a JavaScript library that runs client-side on a per-user basis within the Cisco Finesse desktop application. The desktop retrieves the workflows that are to be executed for a user from the server when the user signs in or when the browser is refreshed.


Note

Changes made to a workflow or its actions while a user is signed in are not automatically pushed to that user.


It is possible to set workflows, conditions, and actions that are contradictory so that a workflow or action cannot function. Workflows are not validated.

If multiple workflows are configured for a team, the Workflow Engine evaluates them in the configured order. The Workflow Engine ignores workflows with no actions. When the Workflow Engine finds a workflow with a matching trigger for an event and the workflow conditions evaluate to true, that workflow is used, and the subsequent workflows in the list are not evaluated. Workflows with no conditions evaluate to true if the event matches the workflow trigger. All workflows are enabled by default. Only one workflow for a specific user can run at a time.

The Workflow Engine retrieves dialog-based variables that are used in workflow conditions from the dialog that triggered the workflow. If a variable is not found in the dialog, it's value is considered to be empty.

The Workflow Engine executes the actions that are associated with the matched workflow in the order in which they are listed. The Workflow Engine executes actions in a workflow even if the previously executed action fails. Failed actions are logged.

The Cisco Finesse server controls the calls that are displayed to the Cisco Finesse user. If the user has multiple calls, the workflow applies only to the first call that matches a trigger. If the first call displayed does not match any triggers but the second call does match a trigger, the Workflow Engine evaluates and processes the triggers for the second call.

A call is considered to be the first displayed call if it is the only call on the Cisco Finesse desktop when it appears. If two calls on a phone are merged (as they are in a conference call), then the first displayed call flag value of the surviving call is used.

If a user has a call and the user refreshes the browser, the Workflow Engine evaluates the call as it is. If the dialog data (call variable values) change, the data may not match the trigger and conditions of the original workflow. The data may match a different workflow or no workflows at all.

If a user has multiple calls and the user refreshes the browser, the Workflow Engine treats the first dialog received from the Cisco Finesse server as the first displayed call. This call may not be the same call that was first displayed before the refreshing the browser. Dialogs received for any other call are ignored because they are not considered as first displayed calls. After refreshing the browser, if dialogs for more than one call are received before the Workflow Engine is loaded, none of the dialogs are evaluated because they are not considered as first displayed calls.

Workflows that are run for both Cisco Finesse agents and supervisors. The team to which the supervisor belongs (as distinguished from the team that the supervisor manages) determines which workflows run for the supervisor. Put the supervisors in their own team to keep agent workflows from being run for them.

Workflow Triggers and Outbound Calls

Note

When you create a workflow specifically for Outbound Option calls, add a condition of BAStatus is not empty (except for the Workflow Trigger 'When a call arrives' as BAStatus will be empty at that point of time). This condition ensures that the workflow can distinguish Outbound Option calls from agent-initiated outbound calls.


The following table illustrates when workflows trigger in outbound call scenarios:

Workflow Trigger

Direct Preview Outbound Call

Preview Outbound Call

Progressive/Predictive Outbound Call

While previewing a call

When the agent previews the call (before accepting or rejecting it)

When the agent previews the call (before accepting or rejecting it)

Does not trigger

When a call arrives

Does not trigger

When the agent accepts the call

When the call arrives on the agent desktop

When a call is answered

When the customer answers the call and during failover

When the customer answers the call and during failover

When the customer answers the call

When a call is made

When the customer call is initiated

When the customer call is initiated

When the customer call is initiated, and during failover

When a call ends

When the customer call ends