Install CRM Service for Topdesk

Note Additional CRM connector license required.

Introduction

The Topdesk CRM Service is used to retrieve relevant information about the caller (inbound)\ Callee (outbound) during a conversation handled by the UCC. The CRM Service retrieves contact info regarding the caller and the related relevant cases from the Topdesk rest services. Normally the CRM Service wil be used in combination with the the Web Agent. The Topdesk Crm Service currently supports 2 Topdesk rest API versions.

 

Dependencies

  • The TopDesk CRM Service package

    Note: This CRM Service was tested against Topdesk version: TOPdesk 11.01.023 (SAAS) and Topdesk API version: 3.3.0

  • Valid Topdesk credentials to access the Topdesk Api for data retrieval.

  • The Crm Service will be hosted in IIS (Microsoft Windows Server)

 

Requirements

  • UCC 8.1.0.41554 or higher

  • ListsPlugin 2.0.0 (Dlls in package are still numbered as 1.0.0)

  • .Net 4.7.1 (C# 7.0 Compliant) or higher

  • .Net Core 2.1 or higher (Be aware that Core 2.2 and higher 2.x versions are already end of life, but 2.1 isn't. Update to 3.x if you want to go higher then 2.1)

 

Start with Installation

Follow the instructions below to install the CRM Service for TopDesk.

 

Deploy package

  1. Unzip the Anywhere365 CRM Service for TopDesk package

  2. Edit the properties.ps1

    1. Domain = Domain of the install account

    2. UserName = Username of the install account

  3. Run InstallCrmService.ps1 in PowerShell as administrator

 

More than one CRM Service - use the CRM Service variable

Used in file: properties.ps1

$crmservice = "CrmService"

The variable $crmservice allows you to change the name under which the CRM Service will be installed in IIS, as well as it’s folder name in wwwroot.

If you need to have more than one CRM Service on a server or want to make clear which CRM Service is installed you can alter this value to suit your needs. All CRM Services fall under the applicationpool CrmApplicationPool.

 

Add PluginSettings

  1. Open the UCC Config page on SharePoint

  2. Open the Plugin Settings list

  3. Add the following mandatory setting

    Setting

    Description

    Value

    Scope

    TopDeskUrl

    Url to the Topdesk environment. Necessary to connect to the Topdesk rest services.

    ...

    CrmService

    Username

    Username of the Service Account used to access the Topdesk API.

    ...

    CrmService

    ApplicationPassword

    Password of the Service Account used to access the Topdesk API.

    Note: Encrypt with the A365 password tool.

    ...

    CrmService

 

Add Endpoint

  1. Open the UCC Config page on SharePoint

  2. Open the Plugin Settings list

  3. Add CRMService settings endpoint to the ListsEndpoints item with scope ListsPlugin

    Note: Add to the existing item and separate with "Enter".

    Setting

    Value

    Scope

    ListsEndpoints

    http://FQDNFDQN stands for Fully Qualified Domain Name and specifies the exact location in the tree hierarchy of the Domain Name System (DNS). An example for [hostname].[domain].[top level domain] is [www].[microsoft].[com]/webagentservice/api/v1/settings

    http://FQDN/CRMService/api/v1/settings

    Note: The CrmService name could be different if a custom name was provided so could be http://localhost/CrmService or http://localhost/CrmServiceTopDesk

    ListsPlugin

 

Add WebAgentService URL

  1. Open the UCC Config page on SharePoint

  2. Open the Plugin Settings list

  3. Add the following mandatory setting

    Setting

    Value

    Scope

    CrmServiceUrl

    https://fqdn/CrmService

    Note: URL needs to be accessible from the WebAgent API service to the CRM Service.

    Note: The CrmService name could be different if a custom name was provided so could be http://localhost/CrmService or http://localhost/CrmServiceTopDesk

    WebAgentService