Avaya Experience Portal (AEP) 7

This guide explains how to configure Capacity Private Cloud ASR and TTS as speech servers for Avaya Aura Experience Portal (AAEP) 7.0. Experience Portal reaches the platform's speech services over MRCP, and because AAEP has no native Capacity Private Cloud engine type, the ASR and TTS are registered under AAEP's generic Nuance engine type. The work has three parts: point the Media Server at the AAEP host, add the ASR and TTS speech servers in the AAEP management console, and reference them from your application.

Choose the right protocol for your AAEP version. Avaya changed session-handling behavior between AAEP 7.0.0 and 7.0.1. From 7.0.1 onward, sessions can no longer be maintained over MRCP v1, so AAEP 7.0.1 and 7.0.2 require MRCP v2 for complete, reliable communication with the platform's ASR and TTS. AAEP 7.0.0 uses the default MRCP v1. Use the section that matches your version — the MRCP v2 settings are first, and the 7.0.0 (MRCP v1) settings are at the end of this page.

Prerequisites

  • An installed and licensed Avaya Aura Experience Portal 7.0.x server.
  • A working Capacity Private Cloud installation, with ASR and TTS installed and verified independently before integrating with AAEP.
  • Network reachability from the AAEP host to the speech host on the MRCP port (TCP 5060 for MRCP v2, or 554 for MRCP v1 over RTSP).

For installing the speech services, see Installing the Media Server.

A note on testing. The platform's ASR and TTS cannot be tested directly from the Orchestration Designer Application Simulator. Deploy applications built in Orchestration Designer to AAEP and test them there.

Configure the Speech Platform

Only two changes to the default Media Server configuration are required. Both are made in the Media Server configuration file:

mrcp-api/docker/lumenvox/media_server.conf
  1. Set mrcp_server_ip to the IP address of the host running the platform. This must be an address that the AAEP host can reach and route traffic to. For help with firewall configuration, contact Technical Support.
  2. Change compatibility_mode from its default of 0 to 1.

Configure AAEP 7.0.1 and 7.0.2 (MRCP v2)

In the AAEP management console, add the ASR and TTS as speech servers under System Configuration > Speech Servers. The settings below highlight the values that deviate from AAEP's defaults — set these carefully.

ASR Speech Server

  • Enabled: Yes
  • Engine Type: Nuance
  • Network Address: <IP of the host running the platform>
  • Base Port: 5060
  • Total Number of Licensed ASR Resources: <number of licenses installed>
  • New Connection per Session: Yes
  • Languages: en-US
  • Ping Interval: 15
  • Response Timeout: 4
  • Protocol: MRCP V2
  • Transport Protocol: TCP
  • Listener Port: 5060

AAEP Change ASR Server page showing Engine Type Nuance, Base Port 5060, MRCP V2 over TCP, and en-US selected

Figure 1: Sample ASR configuration on the AAEP Speech Servers page (7.0.1/7.0.2, MRCP V2).

TTS Speech Server

  • Enabled: Yes
  • Engine Type: Nuance
  • Network Address: <IP of the host running the platform>
  • Base Port: 5060
  • Total Number of Licensed TTS Resources: <number of licenses installed>
  • New Connection per Session: Yes
  • Languages: en-US
  • Ping Interval: 15
  • Response Timeout: 4
  • Protocol: MRCP V2
  • Transport Protocol: TCP
  • Listener Port: 5060

AAEP Change TTS Server page showing Engine Type Nuance, Base Port 5060, MRCP V2 over TCP, and a selected en-US voice

Figure 2: Sample TTS configuration on the AAEP Speech Servers page (7.0.1/7.0.2, MRCP V2).

Configure the Application

These steps apply to any version of AAEP and are unaffected by the 7.0.1 behavior change. When configuring an application to use the platform's ASR and TTS:

  1. Because the Engine Type was set to Nuance, the ASR and TTS appear as Nuance in the Speech Servers drop-down lists on the application's configuration page. Select them there.
  2. Under Speech Parameters, set Speech Complete Timeout to a non-zero value — 800 ms is recommended (the default is 0). Leave the remaining speech parameters blank to use their defaults.

AAEP Change Application page with the ASR and TTS Speech Servers both showing Nuance in the drop-downs

Figure 3: Assigning the configured ASR and TTS servers to an application. Both appear as "Nuance" in the Speech Servers drop-downs.

AAEP application Speech Parameters with Speech Complete Timeout set to 800 milliseconds and all other fields blank

Figure 4: Application Speech Parameters. Speech Complete Timeout is set to 800 ms; all other parameters are left at their defaults.

Configure AAEP 7.0.0 (MRCP v1)

Use these settings only for AAEP 7.0.0. For 7.0.1 and 7.0.2, use the MRCP v2 settings earlier on this page. MRCP v1 uses RTSP on base port 554, and the speech resource is addressed by an RTSP URL rather than a listener port.

ASR Speech Server (7.0.0)

  • Enabled: Yes
  • Engine Type: Nuance
  • Network Address: <IP of the host running the platform>
  • Base Port: 554
  • Total Number of Licensed ASR Resources: <number of licenses installed>
  • New Connection per Session: Yes
  • Languages: en-US
  • Ping Interval: 15
  • Response Timeout: 4
  • Protocol: MRCP V1
  • RTSP URL: <ip>/media/speechrecognizer

AAEP 7.0.0 Change ASR Server page showing MRCP V1, Base Port 554, and the RTSP URL ending in /media/speechrecognizer

Figure 5: Sample ASR configuration for AAEP 7.0.0 (MRCP V1, RTSP, Base Port 554).

TTS Speech Server (7.0.0)

  • Enabled: Yes
  • Engine Type: Nuance
  • Network Address: <IP of the host running the platform>
  • Base Port: 554
  • Total Number of Licensed TTS Resources: <number of licenses installed>
  • New Connection per Session: Yes
  • Languages: en-US
  • Ping Interval: 15
  • Response Timeout: 4
  • Protocol: MRCP V1
  • RTSP URL: <ip>/media/speechsynthesizer

AAEP 7.0.0 Change TTS Server page showing MRCP V1, Base Port 554, and the RTSP URL for the synthesizer resource

Figure 6: Sample TTS configuration for AAEP 7.0.0 (MRCP V1, RTSP, Base Port 554).

Related Articles

Was this article helpful?