Dynamics 365 Configuration #
The following configuration is required within Dynamics to add ~.UcClient.~ support.
- Add the Channel Integration Framework to the Dynamics 365 instance
- Add ~.UcClient.~ as a Channel Provider
To perform each of the configuration steps below, you will need to be logged into the Dynamics instance with administrative permissions.
info
~.UcClient.~ will currently only will only work with Version 1.0 applications, not Version 2.0 (Omnichannel for Customer Service, Customer Service Workspace)
1. Add the Channel Integration Framework to the Dynamics 365 instance #
Before ~.UcClient.~ can be added as a channel provider within Dynamics, the Channel Integration Framework must first be installed.
To add the framework to your Dynamics 365 instance, follow the instructions below on the Microsoft website:
2. Add ~.UcClient.~ as a Channel Provider #
~.UcClient.~ now needs to be added as a channel provider. To do this, open the app launcher by clicking on the current application in the title bar to the right of the Dynamics icon, then select 'Channel Integration Framework'.'
info
If the Channel Integration Framework is not available, check it was installed correctly in stage 1 and that you have permission to view it.
Click on the 'New +' button and enter the details for the ~.UcClient.~, using the table below as guidance.
tip
If the 'New +' button does not appear in the Ribbon this may be caused by a delay in the Dynamics Ribbon regeneration process after the Channel Integration Framework was installed. Check the troubleshooting documentation for more information.
Property | Value |
---|---|
Name | A full name to describe the channel being added |
Label | This label will be visible to users as the title on the ~.UcClient.~ widget |
Channel URL | https://clients.na.xarios.cloud/dynamics/index.html |
Enable Outbound Communications | This setting must be enabled to allow full operation of ~.UcClient.~ |
Channel Order | Default to 0. If there is more that one channel added they must be ordered as required |
API Version | 1.0 |
Trusted Domain | https://clients.na.xarios.cloud/dynamics |
Custom Parameters | If required, populate the Brand ID property with the account id of an Enterprise or Reseller account to apply default branding before a user has logged in. e.g. { "BrandId" : "00000000-0000-0000-0000-000000000000" } |
Select Unified Interface Apps for the Channel
Select all of the unified interface apps which the ~.UcClient.~ client should be available in. If no apps are selected, the ~.UcClient.~ client will not be visible to anyone.
warning
The ~.UcClient.~ for Dynamics 365 works with Unified Interface applications only
Select the Roles for the Channel
Select the user roles which will be able to use the ~.UcClient.~ client.
tip
If you do not assign any role, the channel provider is shown to all users assigned for the Dynamics 365 Unified Interface App.
To review the Microsoft documentation for adding a channel provider, follow the link below: