Install Email Dialogue Provider

Preparation

Install the prerequisites

 

Server Requirements

The following features are installed on the UCC Server:

  • HTTP Activation Feature installed. (.Net Framework 4.5 > WCF Services > HTTP Activation)

 

(Optional) Outlook Rule Manager

You can use the rule manager of Outlook to put the emails in the correct mail folders. For example based on the subject, sender or body put the message in the correct mail folder, this mail folder is connect to a specific Skill in the Email Dialogue Provider.


Installing the Email Dialogue Provider services (UCC server)

Warning Before you begin. Make sure that the name for the inbox sub folder, the Skill and the SharePoint Library are all equal per flow. For example you might want to use FrontOffice. Then the values must be as follows.

• Inbox sub folder name = FrontOffice

• Skill name = FrontOffice

• SharePoint list = FrontOffice

This will install the EmailDialogue services.

  1. Unpack the EmailDialogue zip file

  2. Browse to the extract folder and edit properties.ps1

    1. Set the domain name of the service account e.g. $domain = “WSP”
    2. Set the account name of the service account e.g. $serviceAccountName = “account name”
    3. Set the account password of the service account e.g. $serviceAccountPassword = "secret"

      Note Use the Password Tool in the install directory to encrypt the password.

    4. (optional) Set 1 or more endpoints e.g.

      Note Endpoints are used to send to offer the Emails to the Agents.

      Existing Chat Endpoint can be used.

    5. $endpoints = sipThe Session Initiation Protocol (SIP) is a protocol to make multimedia communication (audio, video and other data communication) possible and it is also used for Voice over IP (VoIP). SIP has similarities with other Internet protocols such as HTTP and SMTP.:endpoint1@domain.com;sip:endpoint2@domain.com
  3. Save the properties file

  4. Open PowerShell as administrator

  5. Browse to the extract folder and run InstallEmailDialogue.ps1

  6. If there are endpoints set the installer will display all Trusted Application’s in the Trusted Application Pool. Select the Application by pressing enter the number and confirm e.g. 1

  7. Installation completed

 

Email Dialogue Provider SharePoint Template

Install SharePoint Template On-Premise

Install Template

  1. Open SharePoint 2010 / 2013 Management Shell as “Administrator”

  2. Browse to the extract folder /SharePointTemplate

  3. Start “ed_install.ps1”

  4. Specify the installer mode. Type “I’, “install’ or leave blank and confirm with ENTER.

  5. Specify if you want to list site collection or enter site collection URL. Type “L”, “list” or leave blank for site collection listing. Type “U” or “url” for URL entry. Confirm with ENTER.

    1. List site collections

      1. A numbered list of site collections is presented. Fill in the number of the site collection on which the installation should take place and confirm with ENTER. If you want to perform an installation on multiple site collections you can enter more numbers separated by a semicolon (e.g. 1;2)

    2. Enter site collection URL

      1. Type in the URL of the site collection and confirm with ENTER.

  6. The installation starts

  7. The installation is finished.

 

Create Subsite with SharePoint Template

Note Subsite can be in the UCC site or in the Site Collection

  1. Go to the Site where you want to create a subsite
  2. Go to "Site Contents"
  3. Select "New Subsite"
  4. Fill in the Title and URL Name
  5. Select the "EmailDialogue Template"
  6. Select "Create"

Tip If your Email (chat) Skill / Exchange sub-folder is different than "FrontOffice", you need to create a new folder Learn More.

 

Install SharePoint Template Online

  1. Go to EmailDialogue folder.
  2. Open the folder EmailDialogueSPOnlineInstall
  3. Run the file emaildialogue-online_install.ps1 in PowerShell as Administrator.
  4. Enter Site URL: the URL of your online SharePoint.
    For example: “https://wspnl.sharepoint.com/sites/uccs/ucc_support”
  5. Enter your username
  6. Enter your password
  7. You will get this:
    1. Select operation mode (install/add, default: install)
    2. Type install, i, or leave blank:
  8. Leave blank and press Enter.
  9. New site title: enter the name for the sub-site, for example: “Emails“.
  10. New site URL: here you will enter the name for the relative sub-site URL of your new site title “emails“.

    Note The result with these examples will be: https://wspnl.sharepoint.com/sites/uccs/ucc_support/emails”

  11. Do you want to proceed? (yes/no)
  12. Chose Y.
  13. Done.

Tip If your Email (chat) Skill / Exchange sub-folder is different than "FrontOffice", you need to create a new folder Learn More.

 

(Optional) Add list to SharePoint Template Online

  1. Go to EmailDialogue folder.
  2. Open the folder EmailDialogueSPOnlineInstall
  3. Run the file emaildialogue-online_install.ps1 in PowerShell as Administrator.
  4. Enter Site URL: the URL of your online SharePoint.
    For example: “https://wspnl.sharepoint.com/sites/uccs/ucc_support”
  5. Enter your username
  6. Enter your password
  7. You will get this:
    1. Select operation mode (install/add, default: install)
    2. Type Add, or a
  8. New library name: enter the name of new Email Skill.
  9. Do you want to proceed? (yes/no)
  10. Chose Y.
  11. Done.

 

Email Dialogue Provider Extension Window

Note If you already have the Extension Window for a back office integration, you can use the same one.

Install Extension window

Learn More

 

Configure Extension Window

  1. Sign in on the Anywhere365 Server
  2. Navigate to C:\inetpub\wwwroot\CRMCasesExtension
  3. Open Web.config
  4. Add

<add key="EmailDownloadServiceURI" value="http://[domain.com]/EmailDownloadService/EmailDownloadService.svc" />

<add key="ShowEmailOnAccepted" value="false" />

<add key="PartOfHyperLink" value="" />

 

Add Email tab to Extension Window

  1. Sign in on the Anywhere365 Server
  2. Navigate to C:\inetpub\wwwroot\CRMCasesExtension\Clientbin
  3. Copy the "EmailTab.dll" from the install directory to this folder
  4. Navigate to C:\inetpub\wwwroot\CRMCasesExtension\
  5. Open Web.config
  6. Add ";EmailTab.dll" to the Tabs key

 

Install Certificate on client

To fully use all functionality a certificate must be installed on the user(s) client. The certificate can be found in the install package.

  1. Copy the certificate to the client
  2. Open the certificate
  3. Select Install Certificate
  4. Select Current User and click Next
  5. Select Place all certificates in the following store
  6. Browse to Trusted Publishers
  7. Click Next


Exchange mailbox

Add sub folder(s) to the inbox folder of the configured email account e.g. FrontOffice (Use the same name as used for the Chat Skill and SharePoint list name)


Configure UCC

  1. Browse to the UCC settings site
  2. Go to “Settings” list and configure the following:
    1. UseCRM = true

    2. EmailRouterEnabled = true

    3. EmailRouterId = name of your choosing for the email router e.g. EmailProvider

    4. EmailRouterCewId = ID of the extension window. This ID is configured in the reg file that was installed earlier on the client. ID is including the curly brackets. e.g. {683B0E00-AFE5-4277-BB53-E747883AC1BC}

    5. EmailRouterInputEndpoint = MSMQ queue for incoming email router messages e.g. msmq://uccsend_queue@localhost

    6. EmailRouterResponseEndpoint = MSMQ queue for outgoing email router messages e.g. msmq://uccreceive_queue@localhost

    7. MaxChatAcceptTimeout = The number of seconds the Agent is offered an email to accept. After this the next Agent will be contacted. Recommended minimal time 30.

  3. Go to “Skills’ list and add a Chat Skill e.g. FrontOffice
  4. Go to “EndPoints” list and add an endpoint:
    1. Title = SIP address of the endpoint e.g. sip:frontoffice@domain.com

    2. Modality = chat

    3. Skill = skill to use for endpoint e.g. FrontOffice

      Endpoint names can be set per UCC and must match the value in the configuration file.

  5. Configure Agents that will use the added Chat Skill

Note UCC must be restarted after adding a new endpoint.


Configuring the services

  1. Browse to the installation folder C:\ProgramFiles\UCC\EmailDialogue\ and edit appSettings1.config

    1. ExchangeUrl
      1. Url of the exchange server e.g. https://outlook.office365.com/EWS/Exchange.asmx
    2. ExchangeVersion
      1. Version of the exchange server. Supported values are: 2010, 2013
    3. EmailAddress
      1. Email address to retrieve emails from e.g. user@domain.com
    4. EmailUser
      1. The user for the inbox. Is in UPNIn Windows Active Directory, a User Principal Name (UPN) is the name of a system user in an email address format. A UPN (for example: john.doe@domain.com) consists of the user name (logon name), separator (the @ symbol), and domain name (UPN suffix). format for cloud based and domain\user format for on-premise exchange
    5. EmailPassword
      1. Password of the email account. You must encrypt the password using the Wsp.Anywhere365.EmailDialogue.PWTool located in the install package.

        Note Make password encrypted, with "Wsp.Anywhere365.EmailDialogue.PWTool". Plain text will not be accepted.

    6. EmailQuantityToRetrieve
      1. Amount of emails to retrieve at once e.g. 5
    7. SharePointUrl
      1. URL of the SharePoint site where emails will be stored e.g. http://sharepoint.com/sites/uccmail/uccmailtemplate
    8. (Pre 5.0) SharePointRelativeUrl
      1. Server relative Url of the SharePoint site where emails will be stored e.g. /sites/uccmail
    9. SharePointProcessLibraries
      1. SharePoint library’s where the emails that are converted to PDF will be stored e.g. FrontOffice, Backoffice.
        These are equal to the sub folder(s) from the mailbox and the names of the Skills in the UCC settings site, as well as the names of the libraries on the SharePoint email page.

        Note This can be multiple folders from the same mailbox. (comma separated)

        Note You can make more folder with you own naming, make sure you select the Office Template when creating a new library

    10. SharePointDropoffLibrary
      1. SharePoint library where the emails will be stored that failed to convert to PDF e.g. Dropoff
    11. SharePointArchiveLibrary
      1. SharePoint library where the emails (PDF’s) will be stored after they are handled e.g. Archive
    12. NetWorkDomain
      1. Domain name of the account that will connect with SharePoint e.g. WSP

        Note For SharePoint Online leave empty.

    13. NetworkUser
      1. User name of the account that will connect with SharePoint e.g. account name

        Note For SharePoint Online use UPN email address.

    14. NetworkPassword
      1. Password of the account that will connect with SharePoint. You must encrypt the password using Wsp.Anywhere365.EmailDialogue.PWTool located in the install package. 6

        Note Make password encrypted, with "Wsp.Anywhere365.EmailDialogue.PWToollocated". Plain text will not be accepted.

    15. DocumentHandlerChannel
      1. MSMQ queue that will be used to send messages within the EmailDialogue services e.g. msmq://document_queue@localhost
    16. UccReceiveEndpoint
      1. MSMQ queue that will be used to receive messages from the UCC e.g. msmq://uccreceive_queue@localhost
        This value is equal to the value set on SharePoint. The service will attempt to create this queue in the message queueing system.
    17. UccSendEndpoint
      1. MSMQ queue that will be used to send messages to the UCC e.g. msmq://uccsend_queue@localhost
        This value is equal to the value set on SharePoint. The service will attempt to create this queue in the message queueing system.
    18. UseCrm
      1. Indicate if the service needs to use a CRMCRM stands for Customer Relationship Management and is a method/technology for managing contacts of customers. CRM helps to offer each customer an individual value proposition based on its wishes. In addition, CRM makes it visible which customers represent higher value for the organization and therefore might be served in a different way. connection e.g. false
    19. CrmUrl
      1. The URL of the CRM environment e.g. user.crm4.dynamics.com
    20. CrmConnectionString
      1. Connectionstring to connect to the CRM environment e.g. Url=https://user.crm4.dynamics.com/;Username=user@user.onmicrosoft.com;Password=6dxvxHYehiRyzfqcIlI96Q==
      2. You must encrypt the password using Wsp.Anywhere365.EmailDialogue.PWTool located in the install package.
    21. EmailDialogProcessorTimerStartTime
      1. Timer settings for the retrieval of emails e.g. 10000
    22. EmailDialogProcessorTimerPeriod
      1. Timer settings for the retrieval of emails e.g. 20000
    23. EmailChatSubscriptions
      1. Sip addresses that the service will use to hunt agents and where the name field is the name that is used for the Chat Skill, the inbox folder and the SharePoint library.

      2. Sip=sip:frontoffice@domain.com#Name=FrontOffice#Order=1,
      3. Sip=sip:backoffice@domain.com#Name=BackOfficeOffice#Order=2"
  2. Save the settings file.

Set Elevated Trust Setting on Agent Client

  1. Run the following reg key on the clients of the Agent

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\Software\Microsoft\Silverlight\]

"AllowElevatedTrustAppsInBrowser"=dword:00000001

[HKEY_LOCAL_MACHINE\Software\Wow6432Node\Microsoft\Silverlight\]

"AllowElevatedTrustAppsInBrowser"=dword:00000001

 

Restart the UCC Server

Starting the services

  1. Open Services and locate the Anywhere365 EmailDialogue Provider service and the Anywhere365 EmailDialogue WorkManager service.

  2. Right-click on a service and select Start

  3. Repeat Step 2 for the second service.