Install WebAgent Service

The WebAgent Service is used for communication between the WebAgent FrontEnd and Dialogue Cloud components. This installation is not the installation of the WebAgent FrontEnd itself which is globally hosted and managed by AnywhereNow.

Prerequisites

Licensing prerequisites

A valid WebAgent license is required.

Your subscription may already include the required entitlements. Contact your AnywhereNow representative if you are unsure whether your subscription includes these features.

Configuration prerequisites

  • EventForwarder Plugin installed and configured for WebAgent, see: Installing Event Forwarder Plugin

  • ApiPlugin installed and configured, see: Install API plugin

  • DC2023.03 or lower: CallControls Plugin installed and configured, see: Install Call Controls plugin

    Important

    Please note that as of DC2023.04 or higher, the CallControls Plugin is no longer needed as a separate plugin as its features have been integrated into the ApiPlugin. You may safely remove any associated settings or configurations related to this plugin. Dialogue Cloud will remove the settings if a upgrade has been requested through the .

  • ListsPlugin installed and configured, Install Lists plugin

Installation

Validate Plugin Settings

Note

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

  1. Open the Config page on SharePoint

  2. Open the Plugin Settings list

  3. Validate the following settings:

Note

For DC2025.02a and higher, CallPropertyServiceUrl is no longer required. For Dialogue Cloud Neo (Unify), TimelineServiceUrl is also no longer required because history data is provided by the platform. Customers on earlier supported bundles still require the applicable settings.

Setting Value Scope
AttendantServiceUrl

http(s):///attendantservice

Note

URL needs to be accessible from the WebAgent API service to the Attendant Service.

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
DashboardServiceUrl

http(s)://fqdn/dashboardservice

Note

URL needs to be accessible from the WebAgent API service to the Dashboard Service.

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
Uri

http(s)://fqdn/webagentservice

Note

URL needs to be accessible from the UCC Service to the WebAgent API service.

Warning

It is important to configure this setting to one main regional URL when using multiple services in the same region. If this is not done, you may experience unexpected behavior.

WebAgentService
Setting Value Scope
AttendantServiceUrl

http(s)://fqdn/attendantservice

Note

URL needs to be accessible from the WebAgent API service to the Attendant Service.

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
DashboardServiceUrl

http(s)://fqdn/dashboardservice

Note

URL needs to be accessible from the WebAgent API service to the Dashboard Service.

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
CallPropertyServiceUrl

http(s)://fqdn/CallPropertyService

Note

URL needs to be accessible from the WebAgent API service to the Call Property Service. This setting is no longer required for DC2025.02a and higher.

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
TimelineServiceUrl

http(s)://fqdn/UniversalTimelineService

Note

URL needs to be accessible from the WebAgent API service to the Universal Timeline Service. For Dialogue Cloud Neo (Unify), this setting is not required in DC2025.02a and higher.

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
Uri

http(s)://fqdn/webagentservice

Note

URL needs to be accessible from the UCC Service to the WebAgent API service.

Warning

It is important to configure this setting to one main regional URL when using multiple services in the same region. If this is not done, you may experience unexpected behavior.

WebAgentService

For the Dialogue Manager related settings, see: Install Dialogue Manager

Setting Value Scope
AttendantServiceUrl

http(s)://fqdn/attendantservice

Note

URL needs to be accessible from the WebAgent API service to the Attendant Service.

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
DashboardServiceUrl

http(s)://fqdn/dashboardservice

Note

URL needs to be accessible from the WebAgent API service to the Dashboard Service.

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
CallPropertyServiceUrl

http(s)://fqdn/CallPropertyService

Note

URL needs to be accessible from the WebAgent API service to the Call Property Service. This setting is no longer required for DC2025.02a and higher.

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
TimelineServiceUrl

http(s)://fqdn/UniversalTimelineService

Note

URL needs to be accessible from the WebAgent API service to the Universal Timeline Service. For Dialogue Cloud Neo (Unify), this setting is not required in DC2025.02a and higher.

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
Uri

http(s)://fqdn/webagentservice

Note

URL needs to be accessible from the UCC Service to the WebAgent API service.

Warning

It is important to configure this setting to one main regional URL when using multiple services in the same region. If this is not done, you may experience unexpected behavior.

WebAgentService
RequeueEnabled

TRUE/FALSE (Default = TRUE)

Note

Introduced in Bundle DC2024.02

WebAgentService