Dialogue Cloud

Install CRM Service for SharePoint

Note Additional CRM connector license required.

Introduction

Below in instructions to install the CRM Service for SharePoint.

This service can be additional configured by added optional settings, Learn More

 

Dependencies

  • The SharePoint Crm Service package

  • A SharePoint Online Environment.

  • SharePoint connected App (Only necessary if the 'Client Id' and 'Client Secret' settings are used for authentication instead of 'User Name' and 'Password') Check this for more details 4.3.2. SharePoint Online Authentication

  • The Crm Service will be hosted in IIS

 

Installation

Add PluginSettings

  1. Open the UCC Config page on SharePoint

  2. Open the Plugin Settings list

  3. Add the following settings

    Setting

    Value

    Scope

    ApplicationHost

    SharePoint application URL.

    CrmService

    IsOnlineEnvironment

    Value should be True for SharePoint Online environment, and should be False for SharePoint on-premises environment.

    CrmService

    UserName

    See chapter SharePoint Authentication

    CrmService

    Password

    See chapter SharePoint Authentication

    Note: Encrypt with the A365 password tool.

    CrmService

    ClientId

    See chapter SharePoint Authentication

    Note: Encrypt with the A365 password tool.

    CrmService

    ClientSecret

    See chapter SharePoint Authentication

    Note: Encrypt with the A365 password tool.

    CrmService

    SiteName

    SharePoint lists contain site name. This is for initial validation.

    CrmService

    ContactListName

    Contact list name. Ex: Contacts

    CrmService

    BaseContactQuery

    Copy
    XML
    <View>
       <Query>
          <Where />
       </Query>
       <ViewFields />
       <RowLimit>100</RowLimit>
    </View>

    Note: RowLimit is mandatory.

    CrmService

 

SharePoint Authentication

There are two ways to access the SharePoint Online environment. Below are the two ways. But SharePoint on-premises environment only supports Using Login Credentials option.

  • Using Login Credentials

    • If the login credentials are used, only the "UserName" and "Password" fields are mandatory credentials.

    • It is mandatory to encrypt the password value and store the encrypted value in the Password field in PluginSettings.

    • Anywhere365 allows encryption using the A365.PWTool.exe.

    • The used user account should have "Edit" rights. The configured user account should have enough rights to add and modify the Contacts and Cases lists. If the user account does not have enough rights, it will be logged in the Crm Service log.

    • "ClientId" and "ClientSecret" parameters are optional.

  • App-Only Access

    • If this option is selected, then the Crm Service will need a SharePoint APP to access the SharePoint environment.

    • Please refer the given link to create the APP: Grant access using SharePoint App-Only

    • Both "ClientID" and "ClientSecret" value should be encrypted using the password tool (A365.PWTool.exe).

    • The app should be given full rights to access the SharePoint lists.

      For more information please refer: https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/add-in-permissions-in-sharepoint

      Copy
      XML
      <AppPermissionRequests AllowAppOnlyPolicy="true">
      <AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web/list" Right="FullControl"/> </AppPermissionRequests>
    • "UserName" and "Password" parameters are optional.

 

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://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]/CrmService

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

    WebAgentService