On Premises

Install CRM Service for AFAS

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 AFAS 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

Follow the instructions below to install the CRM Service for AFAS Profit.

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 AfasProfit package

  2. Paste the AfasProfit 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: AfasProfit
  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

Note

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

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/CrmServiceAfasProfit/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/CrmServiceAfasProfit. We advice to always install this service as http://fqdn/CrmServiceAfasProfit

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/CrmServiceAfasProfit

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/CrmServiceAfasProfit may therefore be different. We advice to always install this service as http://fqdn/CrmServiceAfasProfit

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

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.

The Afas Profit CRM Service uses two lists in SharePoint for its configuration: PluginSettings and PluginAttributes. Only 3 PluginSettings are mandatory to enable the CrmService with its default configuration:

  1. Open the UCC Config page on SharePoint

  2. Open the Plugin Settings list

  3. Add the following settings

Setting Value Scope
Token

Afas uses security tokens to retrieve information from Afas rest services. The Afas services only used to retrieve data are called Get Connectors. The token is used to validate the request. The token has to be encrypted with the A365 password tool.

(e.g. <token><version>1</version><data>D563AE2A016846549376192A1B70F968E85967B84A095DBCBA33748C1DE29CB2</data></token>)

CrmService
ConnectorRestServiceBaseUrl

The Afas Online environment to which the A365 CRM Service has to connect to retrieve data.

(e.g. https://<Orgnumber>.rest.afas.online/Profitrestservices/connectors)

For more information see: Endpoints van Profit Connectoren (SOAP/XML en REST/JSON)

Note

Each Afas environment had a specific url used for the rest endpoints.The OrgNumber field between brackets is a place holder for the real organization number of the company using Afas. If for instance the organization number is 12345, the url becomes: https:/12345.rest.afas.online/Profitrestservices/

CrmService
Insite

Url of Afas Insite. Insite is the web application used to access Afas.

(e.g. https://12345.afasinsite.nl/)

CrmService

This service can be additional configured by added optional settings, see Additional configuration for the Plugin Attributes defaults and base query settings.