Description
The NiCE CXone (integrated) handover provider bridges Cognigy and NiCE CXone, enabling end users to connect with human agents in a NiCE CXone contact center. NiCE CXone (integrated) is for Cognigy installations that are deployed as part of the NiCE CXone platform. Both systems share the same infrastructure, so the handover provider handles authentication and channel configuration automatically.Prerequisites
- Access to NiCE CXone.
- Your Cognigy installation is integrated with NiCE CXone environment. If your Cognigy installation isn’t integrated with NiCE CXone at the platform level, use the NiCE CXone (non-integrated) handover provider instead.
Restrictions
- The Transfer node isn’t supported.
- If your NiCE CXone Studio script is configured to send a message to the user after a handover is initiated, the Repeat handover acceptance message setting in the Handover to Human Agent node won’t work. The message sent by the Studio script is treated as a human agent response, which prevents the Handover acceptance message from repeating.
- Configuring the estimated wait time logic isn’t supported on the Cognigy side for the NiCE CXone integration. Instead, add an Estimated Wait Time action to your NiCE CXone Studio script.
- After importing a NiCE CXone (integrated) handover provider from a package or Snapshot:
- In NiCE CXone, update the Studio script if you customized it.
- Reconfigure on the NiCE CXone side because this configuration isn’t included in the import.
Configuration on the Cognigy side
1. Create a handover provider
1. Create a handover provider
- Go to Deploy > Handover Providers and click + Create handover provider.
- In the Create handover provider dialog, select NiCE CXone and click Create handover provider. The handover provider editor opens.
- In the handover provider editor, enter a unique Name for the handover provider. This name is used as a name for the channel in NiCE CXone.
- Click Save changes.
- Your NiCE CXone handover provider is on its way or Your NiCE CXone handover provider is syncing: no action needed. Wait for the process to complete.
- We couldn’t set up your NiCE CXone handover provider: review the prerequisites and try again. If the issue persists, contact Cognigy technical support.
- Your NiCE CXone handover provider is ready: you can continue the setup on the NiCE CXone side.
Cognigy\Handover from Cognigy <cognigy-handover-providerId>, for example, Cognigy\Handover from Cognigy 6a462ef9109c0c66eb873918. Use this ID to identify the script that maps to the handover provider you created. The ID is also shown in the read-only Studio script name field on the Handover provider editor page, where you can copy it.2. Add a handover to human agent node
2. Add a handover to human agent node
- In the flow editor, add a Handover to Human Agent node.
- From the Handover provider list, select the NiCE CXone provider that you created.
- Configure the generic handover behavior, such as accepted messages or cancellation handling, as needed.
- (Optional) Configure additional settings:
- Send transcript as first message — allow NiCE CXone to receive the conversation transcript as the first message when the handover begins. This setting is turned on by default.
- Display agent details — display the human agent’s name and avatar from NiCE CXone in the chat for the end user. This setting is turned off by default.
- Custom attributes — add custom attributes, which allow you to send additional data to NiCE CXone. When sending custom attributes from Cognigy to NiCE CXone, you can enter them in two ways:
- Display custom attributes in the View Details section in the Agent Workspace.
- Fetch custom attributes with the CC Custom Fields card.
No NiCE CXone-specific fields are required in the node. Routing to the correct queue or human agent team is configured on the NiCE CXone side.
Configuration on the handover provider side
1. Configure handover permissions
1. Configure handover permissions
- In NiCE CXone, click the Applications app selector in the upper-left corner.
- In the left-side CXone Mpower Hubs menu, go to Omnichannel Routing > ACD > Roles.
- Select the role assigned to your account, for example, Administrator.
- In Assigned Channels, select the channel with the same name as the NiCE CXone handover provider you created in Cognigy.
-
Click Update Role Permissions and assign either all permissions or the minimum scope:
Send RepliesAssign / Reassign ConversationsReassign Conversations
2. Create a skill
2. Create a skill
To ensure that conversations are automatically assigned to human agents, create a skill and assign it to the channel and human agent.
- In NiCE CXone, click the Applications app selector in the upper-left corner.
- In the left-side CXone Mpower Hubs menu, go to Omnichannel Routing > ACD > ACD Skills.
- Click Create New > Single Skill.
- Configure the following fields:
- Media Type — select Digital.
- Skill Name — enter a name for your skill.
- Inbound/Outbound — select Inbound.
- Campaign — select any existing campaign.
- Click Create. After creating the skill, assign it to the channel:
- In the left-side CXone Mpower Hubs menu, go to Omnichannel Routing > ACD > Digital > Points of Contact Digital.
- Find the channel with the same name as your Cognigy handover provider. Click Edit, go to the Skills tab, and select the created skill from the Select default skill list.
- Verify the skill is assigned to a human agent:
- In the left-side CXone Mpower Hubs menu, go to Omnichannel Routing > ACD > ACD Users.
- Select the user from the list, and check the Skills tab to ensure the required skill is assigned.
3. Review the studio script
3. Review the studio script
- Click the Applications app selector in the upper-left corner. In the left-side CXone Mpower Hubs menu, go to Omnichannel Routing > Studio.
- Open the Cognigy folder. Inside, locate the script named Cognigy\Handover from Cognigy
<cognigy-handover-providerId>, where<cognigy-handover-providerId>is the ID of the handover provider in Cognigy. Don’t rename the folder because Cognigy references the script by its original name when deleting the provider.
ESCALATE and END ESCALATION actions because Cognigy uses them to start and end handovers.The ONRELEASE action notifies Cognigy that the human agent has closed the conversation. Cognigy then triggers the On resolve options setting configured in the Handover to Human Agent node.4. Test the handover
4. Test the handover
Use a Cognigy Webchat v3 Endpoint for quick testing.
- In Cognigy, go to the Webchat v3 Endpoint settings. Open Demo Webchat and trigger the handover.
- In NiCE CXone, click the Applications app selector in the upper-left corner.
- In the left-side CXone Mpower Hubs menu, go to Omnichannel Routing > Agent.
- In the Agent window, select your preferred option for how you want to connect. For example, select Set Phone Number, enter a phone number, and click Launch.
- With the correct skill assigned, the conversation appears in the agent’s queue. Otherwise, you can select Search in the left-side menu and find the recent conversation that was created.
- Verify that the conversation appears in NiCE CXone. Confirm that it can be picked up by a human agent.
- Send a reply from NiCE CXone and verify that it appears in the Demo Webchat.
Configure matching custom fields and attributes
You can use custom fields in NiCE CXone and custom attributes in Cognigy to:- Display end-user data in the chat details.
- Fetch end-user data using the CC Custom Fields card.
- In the NiCE CXone platform, click the Applications selector in the upper-left corner and select ACD.
- In the navigation menu, select Custom Fields.
- On the Custom Fields page, click + Create custom fields for Case in the Case Custom Fields section.
- On the Edit custom field page, configure the following:
- Ident — enter the JSON key value you set in the Custom attributes field in the Handover to Human Agent node, for example,
customerType. - Label — enter the field name displayed in the chat, for example,
Customer Type. - Type — select the type that matches the data type of the value sent from Cognigy. For example, select Text, E-mail, or Drop down list. For more information, refer to the NiCE CXone documentation.
- Is visible in post detail — activate this if you want the custom field and its value to be displayed in the contact details after the handover.
- Is editable — activate this if you want agents to be able to edit or override the value sent by Cognigy.
- Ident — enter the JSON key value you set in the Custom attributes field in the Handover to Human Agent node, for example,
- Click Save.
-
Custom attributes in the Handover to Human Agent node:
JSON Object
-
In the custom field:
- Ident —
customerType - Label —
Customer Type
- Ident —
- Clicking View Details in the Agent Workspace. You’ll see the Customer Type field with the
premiumvalue. - Using a CC Custom Fields card in the Studio script to fetch the
customerTypevalue.
Additional configuration
Configure attachments
Configure attachments
When using a Webchat v3 or WhatsApp Endpoint with the NiCE CXone handover provider, end users can send and receive file attachments during a handover session.End users can upload, share, and receive the following file types:
To activate attachment uploads, configure File Storage in the Webchat v3 or WhatsApp Endpoint settings.