Install CRM Service for SQL

The CRM Customer Relationship Management, or CRM, is (usually) a software-based, data management method to deal with interactions with customers and potential customers. Service for SQL is used to retrieve relevant information about the caller (for both inbound and outbound) during a conversation handled by the UCC A Unified Contact Center, or UCC, is a queue of interactions (voice, email, IM, etc.) that are handled by Agents. Each UCC has its own settings, IVR menus and Agents. Agents can belong to one or several UCCs and can have multiple skills (competencies). A UCC can be visualized as a contact center “micro service”. Customers can utilize one UCC (e.g. a global helpdesk), a few UCC’s (e.g. for each department or regional office) or hundreds of UCC’s (e.g. for each bed at a hospital). They are interconnected and can all be managed from one central location.. The CRM Service retrieves contact info regarding the caller and if applicable the related relevant cases. The CRM Service will be used in combination with the AnywhereNow WebAgent.

Dependencies

• A SQL Server environment

• A SQL database

• A SQL user with the necessary permissions to connect to the database and select data

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

Deploy package

1. Unzip the CRM Service package from the Bundle Package

2. Edit the properties.ps1

   • Domain = Domain of the install account

   • UserName = Username of the install account

3. Run InstallCrmService.ps1 in PowerShell as administrator

(Optional) 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.

Configure Plugin

Deploy plugin

1. Unzip the SQL package

2. Paste the SQL folder inside the Plugin folder of the CRM Service:

   Copy

   Default path

   C:\inetpub\wwwroot\CrmService\Plugins

Activate plugin

1. Open the CrmConfiguration.yaml

   Copy

   Default path

   C:\inetpub\wwwroot\CrmService\CrmConfiguration.yaml

2. Change the description to:

   Copy

   CrmConfiguration.yaml

   # Plugin
   description: SQL

3. Change the useSharePoint to:

   Copy

   CrmConfiguration.yaml

   # Use SharePoint to get configuration
   useSharePoint: true

Add Endpoint

1. Open the UCC Config page on SharePoint

2. Open the Plugin Settings list

3. Add CRMService settings endpoint to ListsPlugin ListsEndpoints

Setting	Value	Scope
ListsEndpoints	http://FQDN FDQN 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/CrmServiceSQL/api/v1/settings Note The CrmService name could be different if a custom name was provided during install so could be http://fqdn/CrmService or http://fqdn/CrmServiceSQL. We advice to always install this service as http://fqdn/CrmServiceSQL Warning Make sure to leave the fqdn to this service configured as a ".local" URL, especially when using multiple UCC services in the same region. If this is not done, the UCC cannot reach the right webserver internally leading to undesired or non-functional WebAgent behavior.	ListsPlugin

Add WebAgentService URL

1. Open the UCC Config page on SharePoint
2. Open the Plugin Settings list
3. Add the following setting:

Setting	Value	Scope
CrmServiceUrl	http://fqdn/CrmServiceSQL Note URL (Value) needs to be accessible from the WebAgentService to this CRM Service. If on the same server this can be http and a .local address. Note The CrmService name may be different if a custom name was provided or if multiple CrmServices are configured. The URL values http://fqdn/CrmService or http://fqdn/CrmServiceSQL may therefore be different. We advice to always install this service as http://fqdn/CrmServiceSQL Warning Make sure to leave the fqdn to this service configured as a ".local" URL, especially when using multiple UCC services in the same region. If this is not done, the UCC cannot reach the right webserver internally leading to undesired or non-functional WebAgent behavior.	WebAgentService

Add PluginSettings

1. Open the UCC Config page on SharePoint

2. Open the Plugin Settings list

3. Add the following Mandatory settings

   Setting	Value	Scope
   ConnectionString	Encrypted ConnectionString to make contact with the SQL database Copy Example connectionstring before encryption Server=tcp:<server>.database.windows.net,1433;Initial Catalog=<database-name>;User ID=<username>;Password=<password> Note Encrypt entire ConnectionString with the AnywhereNow password tool.	CrmService
   BaseContactQuery	Mandatory query used for the retrieval of contacts: Copy Query Select Top (100) {0} From Contact Where {1} Note Each query must contain a row, rownum, limit or fetch first <num> rows. In other words SELECT * search is not allowed (nor advised or good practice).	CrmService
   BaseLeadsQuery	Mandatory query used for the retrieval of contacts (or leads if they are separate entities): Copy Query Select Top (100) {0} From Contact Where {1} Note Each query must contain a row, rownum, limit or fetch first <num> rows. In other words SELECT * search is not allowed (nor advised or good practice).	CrmService

For additional or optional configuration parameters see Additional configuration CRM Service for SQL Server