Dialogue Cloud

On Premises

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.

Note

An additional AnywhereNow WebAgent for Voice or for Omnichannel license is required.

Note

A CRM connector license specific to each data source (Database or CRM backend platform) is required.

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.

Request CRM Service for Dialogue Cloud

For customers

Request the Crm Service for SQL to be enabled (for specific UCC's) via your regular AnywhereNow contact or Partner.

For partners

  1. Navigate to the Partner Portal

  2. Request the "Integrated with SQL" when selecting WebAgent > Webagent For Voice Communication / Webagent for Omnichannel Communication.

    This can be done during:

    1. Create UCC, see: Create - Contact Center (UCC)

    2. Edit UCC, see: View (and edit) - Contact Centers (UCC's)

Validate Endpoint

Note

Required settings fields will be automatically added in your SharePoint lists after requesting this feature through Partner Portal. Some of these settings, like ConnectionString, will need to be completed ASAP with your valid credentials.

  1. Open the UCC Config page on SharePoint

  2. Open the Plugin Settings list

  3. Validate 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

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

Validate WebAgentService URL

Note

Required settings fields will be automatically added in your SharePoint lists after requesting this feature through Partner Portal. Some of these settings, like ConnectionString, will need to be completed ASAP with your valid credentials.

  1. Open the UCC Config page on SharePoint
  2. Open the Plugin Settings list
  3. Validate 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.

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

Configure PluginSettings

Warning

This CRM service depends on settings which need to be identical if used across multiple UCC's within a service, meaning the values should be identical across all UCC configurations using it. We call these primary settings. A primary setting is defined by the first UCC to publish its settings during startup of the service. This may not always be the same UCC if multiple UCC's share this service! If values differ across multiple UCC's this will lead to unpredictable behavior after a service restart. It is extremely important to keep the values consistent/identical and valid.

Note

Required settings fields will be automatically added in your SharePoint lists after requesting this feature through Partner Portal. Some of these settings, like ConnectionString, will need to be completed ASAP with your valid credentials.

  1. Open the UCC Config page on SharePoint

  2. Open the Plugin Settings list

  3. Configure 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

You can use any table you want by changing the Query settings. If you do want to use our defaults, follow these steps to create the tables:

  1. Open Microsoft SQL Server Management Studio (SSMS) (Download SQL Server Management Studio (SSMS))

    or

    Azure Data Studio (Download and install Azure Data Studio - Azure Data Studio)

  2. Connect to Server / Instance where the SQL Database is located.

  3. Navigate to the SQL Database

  4. Right Click Database

  5. Select New Query

  6. Paste the following SQL code:

    Copy
    SQL
    IF OBJECT_ID(N'dbo.Case', N'U') IS NULL

    CREATE TABLE [dbo].[Case](

    [Id] [nvarchar](max) NOT NULL,

    [ContactId] [nvarchar](max) NOT NULL,

    [Description] [nvarchar](max) NULL

    ) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]

    GO

     

    IF OBJECT_ID(N'dbo.[Contact]', N'U') IS NULL

    CREATE TABLE [dbo].[Contact](

    [Id] [nvarchar](max) NOT NULL,

    [Firstname] [nvarchar](max) NULL,

    [Lastname] [nvarchar](max) NULL,

    [Skill] [nvarchar](max) NULL,

    [Birthdate] [datetime] NULL,

    [Location] [nvarchar](max) NULL,

    [PhoneNumber] [nvarchar](max) NULL,

    [Email] [nvarchar](max) NULL

    ) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]

    GO

  7. Execute the Query (F5 or Run)

  8. Validate the outcome. By checking the Messages tab you can see if query was executed successfully.