Print

Add Application page field descriptions

Use this page to add a new application to the system.

This page contains the:

General settings section

Field Description
Start With Existing application names.

By selecting an existing application name, all the configuration values of the existing application are populated in the Add application page. You can edit the values for the new application.

noteNote:

The configurable application variables for the new application are retrieved from the application URL that is configured for the new application, and are not copied from the selected application.
Zone The name of the zone where you want to add the application.
noteNote:

This field is displayed only if zones are configured in the system.
Organization The name of the organization associated with the application you want to add.
noteNote:

This field is displayed only if organization level access is enabled in the Experience Portal and you have logged in as a user not assigned to any organization.
Name The name used to identify this application on the Experience Portal system.
noteNote:

Once you save the application, this name cannot be changed.

If you are using a Nuance server, the maximum length of this field is 32 characters.
Enable Whether this application is available for use by the Experience Portal system.

The default is Yes, which means the application is available.
Type The type of Multipurpose Internet Mail Extensions (MIME) encoding used by this application.

The options are:

  • VoiceXML: If selected, Experience Portal displays VoiceXML URL and related fields.

  • CCXML: If selected, Experience Portal displays CCXML URL and related fields.

  • CCXML/VoiceXML: If selected, Experience Portal displays VoiceXML URL, CCXML URL, and the related fields.

  • Avaya Breeze™ SMS: If selected, Experience Portal displays the Continue button.

    noteNote:

    Sending an SMS to this type of application causes the EPM to send an event with Message as the Event Family and INCOMING_SMS as the Event Type to the Breeze system that is specified on the Data Storage Settings page. This type of incoming event causes any workflow that is configured on the Breeze system to start. For details, refer to the Avaya Breeze® platform and Avaya Engagement Designer documentation.

  • CCXML(BNMS): If selected, Experience Portal displays the related fields.

    noteNote:

    CCXML(BNMS) type is for RFC 4240 (Support for Network Announcements in SIP). Where, BNMS implies Basic Network Media Services for SIP.

  • SMS: If selected, Experience Portal displays the Continue button. Click Continue to view the SMS related fields.

  • Email: If selected, Experience Portal displays the Continue button. Click Continue to view the email related fields.

  • HTML If selected, Experience Portal displays the Continue button. Click Continue to view the HTML related fields.

noteNote:

Additional type options may be available if you have installed managed application on Experience Portal. For more information on managed application type, see the documentation delivered with the managed application.
Message Type The system displays this field if you have selected either SMS or Email application. Each SMS or email application can have the following message types:

  • Regular - Application for handling regular messages.

  • Delivery - Application for handling delivery messages.

  • Regular and Delivery - Application for handling regular messages and delivery receipts.
Reserved SIP Calls The option to reserve SIP ports for an application. This option is not available for SMS and email applications. The options are:

  • None: No SIP ports are reserved for the application, and a call is answered only if there are free SIP ports available.

  • Minimum: The application supports the minimum number of simultaneous calls. Once the minimum number, which you specify in the Requested field is reached and a new call arrives, the call is answered only if there are free SIP ports available.

  • Maximum: The application supports the specified number of simultaneous calls. Once the maximum number, which you specify in the Requested field is reached and a new call arrives, the call is rejected even if there are free SIP ports available.
Requested The minimum or maximum number of the Reserved SIP Calls requested for the application.

This field is enabled only when you select the Minimum or Maximum option in the Reserved SIP Calls field.

URI group

Field Description
Type The options are:

  • Single: The only application server that handles the calls.

  • Fail Over: Allows you to add two URLs to handle a fail over:

    • URL 1: The primary application that handles the calls

    • URL 2: The application that handles the calls upon the failure of the primary application.

  • Load Balance: Allows you to add two URLs for load balancing purpose. The URLs are also used for failover. For instance, if URL 2 fails, URL1 handles all calls.
CCXML URL The HTTP path to the root document of the Call Control eXtensible Markup Language (CCXML) speech application.

The URL must be in the format[http:|https:]//domain.name/subdirectory/startDocument where

  • [http:|https:] indicates whether the URI uses normal or secure HTTP protocol.

    noteNote:

    You must specify a URL that begins with https: if you want Experience Portal to use a secure connection between the MPP and the application server.

  • domain.name is the fully qualified domain name or the IP address of the server on which the application resides. You can use a relative path for your domain name or a fully qualified domain name.

  • subdirectory is an optional subdirectory or series of subdirectories on the application server.

  • startDocument is the first page that the CCXML-compliant speech application should load. The extension on this document will typically be ccxml, htm, html, jsp, or xml.

    For example, vpmenu.html or vpmenu.jsp?gtype=vxml-srgs-avaya-ibm.
VoiceXML URL The HTTP path to the root document of the VoiceXML speech application.

The URL must be in the format[http:|https:]//domain.name/subdirectory/startDocument where

  • [http:|https:] indicates whether the URI uses normal or secure HTTP protocol.

    noteNote:

    You must specify a URL that begins with https: if you want Experience Portal to use a secure connection between the MPP and the application server.

  • domain.name is the fully qualified domain name or the IP address of the server on which the application resides. You can use a relative path for your domain name or a fully qualified domain name.

  • subdirectory is an optional subdirectory or series of subdirectories on the application server.

  • startDocument is the first page that the VoiceXML-compliant speech application should load. The extension on this document will typically be htm, html, jsp, vxml, or xml.

    For example, vpmenu.html or vpmenu.jsp?gtype=vxml-srgs-avaya-ibm.
SMS URL The HTTP path to the root document of the SMS application.

The URL must be in the format[http:|https:]//domain.name/subdirectory/startDocument where

  • [http:|https:] indicates whether the URI uses normal or secure HTTP protocol.

    noteNote:

    You must specify a URL that begins with https: if you want Experience Portal to use a secure connection between the MPP and the application server.

  • domain.name is the fully qualified domain name or the IP address of the server on which the application resides. You can use a relative path for your domain name or a fully qualified domain name.

  • subdirectory is an optional subdirectory or series of subdirectories on the application server.

  • startDocument is the first page that the application should load.
Email URL The HTTP path to the root document of the Email application.

The URL must be in the format[http:|https:]//domain.name/subdirectory/startDocument where

  • [http:|https:] indicates whether the URI uses normal or secure HTTP protocol.

    noteNote:

    You must specify a URL that begins with https: if you want Experience Portal to use a secure connection between the MPP and the application server.

  • domain.name is the fully qualified domain name or the IP address of the server on which the application resides. You can use a relative path for your domain name or a fully qualified domain name.

  • subdirectory is an optional subdirectory or series of subdirectories on the application server.

  • startDocument is the first page that the application should load.
HTML The HTTP path to the root document of the HTML application.

The URL must be in the format[http:|https:]//domain.name/subdirectory/startDocument where

  • [http:|https:] indicates whether the URI uses normal or secure HTTP protocol.

    noteNote:

    You must specify a URL that begins with https: if you want Experience Portal to use a secure connection between the MPP and the application server.

  • domain.name is the fully qualified domain name or the IP address of the server on which the application resides. You can use a relative path for your domain name or a fully qualified domain name.

  • subdirectory is an optional subdirectory or series of subdirectories on the application server.

  • startDocument is the first page that the application should load.

There are two types of HTML URLs:

  • Internal URL: Enter the URL that an EPM should use to directly connect with the OD Application servers.

    This URL should utilize the https (Secure HTTP) scheme and include the virtual IP address maintained by the load balancers (or a hostname that resolves as such).

  • External URL: Enter the URL that an EPM should return as the location for an external browser to access the same application.

    This URL should also use the https (Secure HTTP) scheme and include an IP address or hostname that resolves to the reverse proxy. The path for this URL should match a configuration in the reverse proxy that maps to the load balancer configuration for the application.
Verify Instructs Experience Portal to open the associated root document in a new browser window.

If the document cannot be found, the new browser window displays a file not found error.

noteNote:

Verify is not displayed if the URL(s) contains a secure HTTP protocol (https:), and the Mutual Certificate Authentication field is set to Yes.
Mutual Certificate Authentication Enables mutual certificate authentication between the EPM/MPP and the application.
importantImportant:

Do not enable this option if your application uses external grammars stored on the application server. The speech servers do not support mutual certificate authentication and therefore will not fetch the grammar from the application server.

If you select this option ensure that:

  • The application server is configured to support mutual configuration and the MPP certificate is installed on the application server.

  • The application certificate is installed on the MPP. Experience Portal allows you to add and view the application certificate from the Security>Certificates>Trusted Certificates page in EPM.

  • The URLs use secure HTTP protocol (https).

Basic Authentication
Enables user name and password authentication between the EPM/MPP and the application. Ensure that the application server is configured to support basic configuration. If you select the Basic Authentication option, Experience Portal displays:
importantImportant:

Do not enable this option if your application uses external grammars stored on the application server and uses a Nuance speech server, as Nuance does not support basic authentication.

  • User name field: The name used to authenticate the MPP and the application.

    noteNote:

    The user name must not contain the : character.

  • Password field: The password used to authenticate the MPP and the application.

noteNote:

You can select both Mutual Certificate Authentication and Basic Authentication options.
Notification Enabled A notification-type message displays the delivery status of an email or an SMS message.

This field must be enabled for Orchestration Designer applications that are written to accept a notification-type message.

The system displays this field if you select either SMS or Email type from the General Settings section.

If you select Single or Load Balance: If Notification is enabled, Notification URL field is displayed. If Notification is not enabled, Notification URL field is not displayed.

If you select Fail Over : If Notification is enabled, Notification URL1 and Notification URL2 fields are displayed. If Notification is not enabled, Notification URL fields are not displayed.
Notification URL Enter the URL of the SMS or Email notification.

ASR Speech Servers group

Field Description
Engine Types If this application uses Automatic Speech Recognition (ASR) resources, this field lets you select the ASR engine type that will be used.

The options are:

  • No ASR: This application does not use ASR resources.

  • The engine type associated with the ASR server to use for this application. The available engine types depend on the ASR servers on the Experience Portal system.

    For VoiceXML, CCXML, or VoiceXML/CCXML applications, you can select multiple ASR speech servers.

Select an individual entry in this list by clicking on it, or use Ctrl+Click and Shift+Click to select multiple entries.

Then, click to move the selected engine types to the Selected Engine Types field. To move the languages back from the Selected Engine Types field to the Engine Types field, click .

If you select an engine type, Experience Portal displays the following fields which are specific to an ASR speech server engine type:

  • Languages

  • Selected Languages

  • Resources

  • N Best List Length

  • Speech Complete Timeout

  • Speech Incomplete Timeout

  • Vendor Parameters
Selected Engine Types The ASR engine types that you select in the Engine Types pane appear in this pane.
Default Engine
When multiple speech servers are added in the Selected Engine Types for an application, the Default Engine option becomes available. The Default Engine drop-down contains all engine values that have been added in the Selected Engine Types list. If the com.avaya.asr.vendor property is not specified in VXML/CCXML Application and multiple engines are selected:

  • The selected Default Engine Type serves as a fallback.

  • If Default Engine Type is not selected, the first configured engine will be selected from the Selected Engine Types list.

This ensures that at least one engine is always selected, thereby helping to prevent errors and allowing grammars to load correctly for smooth recognition without manual intervention.
Languages Displays all the languages that application servers can use on this system.

Select an individual entry in this list by clicking on it, or use Ctrl+Click and Shift+Click to select multiple entries.

Then, click to move the selected languages to the Selected Languages field. To move the languages back from the Selected Languages field to the Languages field, click .

This list is prepopulated with the list of the languages that were available for the designated ASR engine type when Experience Portal was released. It is maintained in a special file on the Experience Portal system and is not automatically updated. You must verify that the languages you select here are actually installed and available on the target ASR server.

You can add more languages to this list by clicking Configuration>Speech Servers from the EPM menu and selecting Customize in the ASR tab.

noteNote:

If a speech application is configured to use more languages than are configured for any single ASR server, Experience Portal sends a No ASR Resource exception to the application. What happens then depends on the event handler that the application uses.
Selected Languages All languages that you select in the Languages pane appear in this pane.
Resources If an ASR speech server is selected, this field lets you select how the application acquires the ASR speech resource.

The options are:

  • Acquire on call start and retain: Acquires the ASR speech resource at the beginning of the call and retains the resource till the end of the call.

  • Acquire on first use and retain: Acquires the ASR speech resource on the first use of the speech request and retains the resource till the end of the call.

  • Acquire and release as needed: Acquires the ASR speech resource when needed and releases the resource immediately after the dialogue is completed.

    noteNote:

    Before selecting the Acquire and release as needed option, check the license agreement with the speech vendor whether it is okay to release an acquired ASR speech resource before disconnecting the call.
N Best List Length The maximum number of recognition results that the ASR engine can return.

  • For Nuance, enter a number from 1 to 100.

  • For Loquendo, enter a number from 1 to 10.

noteNote:

If you are using Orchestration Designer, see the N-Best input form field description in your Orchestration Designer documentation.
Speech Complete Timeout The number of milliseconds of silence required following user speech before the speech recognizer either accepts it and returns a result or reject it and returns a No Match event.
Enter an integer in this field.

  • For Nuance, enter a value in the range 0 to 65535.

  • For Loquendo, enter a value in the range 300 to 10000.

This value is used when the recognizer currently has a complete match of an active grammar, and specifies how long it should wait for more input declaring a match. By contrast, the incomplete timeout is used when the speech is an incomplete match to an active grammar.

tipTip:

Take care when setting this property. If you set the number too high, it can slow down system response time, even for successful recognitions. If you set the number too low, it can lead to an utterance being cut off prematurely. Reasonable values for this property are usually in the range of 5000 to 15000 milliseconds.
Speech Incomplete Timeout The number of milliseconds of silence following user speech after which a recognizer finalizes a result.
Enter an integer in this field.

  • For Nuance, enter a value in the range 0 to 65535.

  • For Loquendo, enter a value in the range 300 to 10000.

The incomplete timeout applies when the speech prior to the silence is an incomplete match of all active grammars. In this case, once the timeout is triggered, the speech recognizer rejects the partial result and returns a No Match event.

tipTip:

Take care when setting this property. If you set the number too high, it can slow down system response time, even for successful recognitions. If you set the number too low, it can lead to an utterance being cut off prematurely. This property is usually set lower than the Speech Complete Timeout but high enough to allow for callers to pause mid-utterance.

noteNote:

If you are using Orchestration Designer, see the Timeout Incomplete field description in your Orchestration Designer documentation.
Project ID The Google Dialogflow BOT Project ID.

This field is displayed only when you select Dialogflow in the ASR Engine Types field.
Location The region for the Google Dialogflow BOT.

The system will default to using the Global region if you do not specify any value in this field.

This field is displayed only when you select Dialogflow in the ASR Engine Types field.
VAD Parameters The Voice Activity Detection (VAD) parameters.

This field is displayed only when you select Dialogflow or Naunce DLGaaS in the ASR Engine Types field.
Vendor Parameters Any vendor-specific or platform-specific parameters that the ASR server requires to function correctly with this speech application.
noteNote:

Contact your speech server provider for details on vendor parameters.

These parameters must be in the general form parameter=value. You can include as many parameters as you want. Use semi-colons (; ) to separate multiple entries.

For example, for Nuance DLGaaS, you may need to specify: ep.ThresholdSnr=12;Rec.PPR=1
Credentials The authentication credentials for communicating with a Google Speech Engine or Google Dialogflow Engine.

The options are:

  • Custom: Using this option the administrator can upload the credentials as a JSON file as defined by the Google Speech Engine or Google Dialogflow Engine.

  • None: Using this option the administrator can delete any existing uploaded credentials file.

The Credentials field is displayed only when you select either Google Speech or Dialogflow in the ASR Engine Types field.

For more information on the authentication credentials, refer to the Google Speech engine or Google Dialogflow Engine documentation.
Client ID The client authentication credentials ID for communicating with a Nuance DLGaaS engine.

This field is displayed only when you select Nuance DLGaaS in the ASR Engine Type field.

For more information on the client authentication credentials, see the Nuance DLGaaS documentation.
Client Secret The client authentication credentials secret for communicating with a Nuance DLGaaS engine.

This field is displayed only when you select Nuance DLGaaS in the ASR Engine Type field.

For more information on the client authentication credentials, see the Nuance DLGaaS documentation.

VAD Parameters group

Field Description
VAD Mode The Voice Activity Detection mode.

VAD Mode determines whether local VAD, the VAD of the cloud speech provider, or a combination of both VADs are used.

The VAD mode values are the following:

  • <None> - AEP local VAD is enabled and uses the default GMM VAD or the system-wide VAD type specified in mppconfig.xml.

  • Disabled - AEP local VAD is disabled and the audio stream is sent immediately to the cloud provider.

  • Enabled - AEP local VAD is enabled and uses the selected VAD type algorithm to detect speech energy. Once speech energy is detected, AEP sends the audio stream to the cloud provider.

  • Hybrid - AEP local VAD is enabled for the initial response in every call but is disabled for all other utterances for the rest of the call. Therefore, the local VAD is used first, and then the cloud provider VAD is used for the rest of the call.
VAD Type The Voice Activity Detection algorithm type.

The options are:

  • GMM

  • Inqa

noteNote:

This field is displayed only when you set the VAD Mode to Enabled or Hybrid.
Starting Minimum Energy Minimum energy threshold required for frame analysis during the barge-in phase of speech input.

Enter a value in the range 0 to 16,383. The default value is 2048.

noteNote:

This field is displayed only when you select GMM as the VAD Type.
Starting Minimum Energy Scale Power of two scale factor for the minimum energy threshold during the barge-in phase of speech input.

Enter a value in the range 0 to 32. The default value is 6.

noteNote:

This field is displayed only when you select GMM as the VAD Type.
Starting Minimum Energy Frames Minimum number of consecutive frames with speech energy required to trigger the VAD during the barge-in phase of speech input.

Enter a value in the range 1 to 100. The default value is 3.

noteNote:

This field is displayed only when you select GMM as the VAD Type.
Interim Minimum Energy Minimum energy threshold required for frame analysis after interruptible prompts are finished playing.

Enter a value in the range 0 to 16,383. The default value is 2048.

noteNote:

This field is displayed only when you select GMM as the VAD Type.
Interim Minimum Energy Scale Power of two scale factor for the minimum energy threshold after interruptible prompts are finished playing.

Enter a value in the range 0 to 32. The default value is 6.

noteNote:

This field is displayed only when you select GMM as the VAD Type.
Interim Minimum Energy Frames Minimum number of consecutive frames with speech energy required to trigger the VAD after interruptible prompts are finished playing.

Enter a value in the range 1 to 100. The default value is 3.

noteNote:

This field is displayed only when you select GMM as the VAD Type.
Starting Noise Floor Minimum value for adaptive energy threshold during the barge-in phase of speech input.

Enter a value in the range 0 to 100. The default value is 22.0

noteNote:

This field is displayed only when you select Inqa as the VAD Type.
Starting Noise Offset Offset value, relative to the adaptive energy threshold, required for frame analysis during the barge-in phase of speech input.

Enter a value in the range 0 to 100. The default value is 1.0.

noteNote:

This field is displayed only when you select Inqa as the VAD Type.
Interim Noise Floor Minimum value for adaptive energy threshold after interruptible prompts are finished playing.

Enter a value in the range 0 to 100. The default value is 22.0.

noteNote:

This field is displayed only when you select Inqa as the VAD Type.
Interim Noise Offset Offset value, relative to the adaptive energy threshold, required for frame analysis after interruptible prompts are finished playing.

Enter a value in the range 0 to 100. The default value is 1.0.

noteNote:

This field is displayed only when you select Inqa as the VAD Type.

TTS Speech Servers group

Field Description
TTS If this application uses Text-to-Speech (TTS) resources, this field lets you select the TTS engine type that will be used.

The options are:

  • No TTS: This application does not use TTS resources

  • The engine type associated with the TTS server to use for this application. The available options depend on the TTS servers on the Experience Portal system.

    If you select an engine type, Experience Portal displays the Voices field.
Voices If a TTS engine is selected, this field displays the voices configured for the TTS servers of that engine type on the Experience Portal system.

Select one or more default voices for this application. Your selections must match exactly the TTS voice defined in the speech application.

Use Ctrl+Click and Shift+Click to make more than one selection from this list. The first selected voice becomes the default for this application.

Then, click to move the selected voices to the Selected Voices field. To move the voices back from the Selected Voices field to the Voices field, click .

noteNote:

You can switch languages within a single speech application, provided all the required languages are configured on the same TTS server. If a speech application is configured to use more language/voice combinations than are configured for any single TTS server, Experience Portal sends a No TTS Resource exception to the application. What happens then depends on the event handler that the application uses.
Selected Voices Displays the selected voices that the TTS server is configured to use.

Application Launch group

noteNote:

Experience Portal uses the information you enter in this group to make a master list of all telephone numbers and Universal Resource Indicators (URIs) that are mapped to specific applications. It then takes the number or URI dialed by the caller as input and determines which speech application is assigned to handle that number.

If you do not map any phone numbers or URIs to an application, then that application automatically handles any calls that come from numbers or URIs that are not otherwise mapped. However, you can only have one such application on the system. If you attempt to configure a second application without a DNIS or URI, the system generates an error.

Field or Button Description
Application Launch type The options are:

  • Inbound: This application handles inbound calls/messages from a URI or one or more specified telephone numbers.

  • Inbound Default: This application handles all inbound calls/messages made to a number that is not associated with any other application.

  • Outbound: This application handles outbound calls/messages.

noteNote:

The rest of the fields in this section are displayed only when you select the Inbound option.
Application Launch parameters for Email Application When defining Inbound Email applications, you can configure the launch parameters for the applications. The launch parameters allow you to assign multiple applications to a common incoming number or incoming email address. When a message arrives, the system checks if the message matches the options specified in the launch parameters. If the parameters match, the application receives the message, subject to the application launch order.

The options are:

  • User Name: You can enter the user name that is specified in the Incoming Mail section of the Email Connection page in EPM. For this application, the system considers only those message that arrive on the configured email connection.

  • User Name Expression: The pattern must be a standard regular expression that must return true when applied against the user name that is specified in the Incoming Mail section of the Email Connection page in EPM. For example, for a pattern of eptest(1|2), incoming emails from the email connection with user name such as “eptest1” or “eptest2” can launch the application.

noteNote:

  • If User Name or User Name Expression is not configured, all incoming emails can launch the application, subject to the optional Additional Launch parameters.

  • If the User Name or User Name Expression is configured and the incoming email does not come from the associated email connection, the application is not launched.

  • If User Name, User Name Expression, and the Additional Launch parameters are configured, the application is only launched if both criteria match.

Additional Launch Parameters:

  • Component: You can select the following options:

    • To

    • Cc

    • Subject

    • Header

  • Algorithm: You can select the following options:

    • Starts With: The selected component, for example the subject, must start with the specified pattern.

    • Starts With (and Remove): The selected component must start with the specified pattern and the pattern is removed before the message is given to the application.

    • Substring Match: The pattern might occur anywhere within the component.

    • Full String Match: The pattern and component must match exactly with no extra characters in either one.

    • Regular Expression: The pattern must be a standard regular expression that must return true when applied against the component. For example, a pattern of “b[ae]t” would mean that the component, for example the subject, must contain exactly bat or bet before the message is given to the application.

  • Pattern: The text that you enter for the selected algorithm.

To add multiple launch parameters, click Add.

To remove a launch parameter, click Remove.
Number type for Voice Application The options are:

  • Number: Instructs Experience Portal to associate the application with a single telephone number.

  • Number Range: Instructs Experience Portal to associate the application with a sequential range of telephone numbers.

  • URI: Instructs Experience Portal to associate the application with a single URI.
    noteNote:

    The URI field is displayed only for VoiceXML and CCXML Applications.

  • Expression: Instructs Experience Portal to associate the application with a valid Short Code Expression.

    noteNote:

    The Expression field is displayed only for SMS and Email Applications.
Called Number The definition of this field depends on the selected number type.

  • Number: The Called Number field is the telephone number you want to associate with this application.

  • Number Range: The Called Number field is the lowest telephone number in the range you want to associate with this application.

  • URI: The Called Number field is not available.

You can enter from 1 to 15 digits. Do not include spaces or special characters such as (, ), or -.
To Enter the highest telephone number in the range you want to associate with the application.

If you selected Number Range as the number type, this field is displayed. If you selected any other number type, this field is not available.
Called URI Enter the URI you want to associate with the application.

If you selected URI as the number type, this field is displayed. If you have selected any other number type, this field is not available.

You can use any valid regular expression such as the following:

  • Character classes: Distinguishes kinds of characters, for example, distinguishing between letters and digits. Characters such as: \d, \D, \w, \W, \s, \S, \t, \r, \n, \v, \f, [\b], \0, \cX, \xhh, \uhhhh, \u{hhhh} or \u{hhhhh}, \p{UnicodeProperty}, \P{UnicodeProperty}, \.

    For more information on Character classes, see Character classes.

  • Assertions: Indicates the beginnings and endings of lines and words, and other patterns indicating in some way that a match is possible. Characters such as ^, $, \b, \B, x(?=y), x(?!y), (?<=y)x, (?<!y)x.

    For more information on Assertions, see Assertions.

  • Groups and ranges: Indicates groups and ranges of expression characters. Characters such as: x|y, [xyz][a-c], [^xyz][^a-c], (x), \n, \k<Name>, (?<Name>x), (?:x).

    For more information on Groups and ranges, see Groups and ranges.

  • Quantifiers: Indicates numbers of characters or expressions to match. Characters such as: x*, x+, x?, x{n}, x{n,}, x{n,m}, x*?, x+?, x??, x{n}?, x{n,}?, x{n,m}?.

    For more information on Quantifiers, see Quantifiers.

noteNote:

Do not enter leading sip: or sips: in this field. Experience Portal strips these characters from the URI that is received on SIP INVITE before comparing with the values that are entered in this field.
Add Associates the number, range of numbers, or URI with the application.

After you click Add, the specified number, range of numbers, or URI appears in the display text box.
Number type for SMS Application When defining the Inbound SMS applications, you must configure the short codes for these applications.

The options are:

  • Number: Instructs Experience Portal to associate the application with a single Short Code/Long Number.

  • Number Range: Instructs Experience Portal to associate the application with a sequential range of Short Code/Long Numbers.

  • Short Code Expression: Instructs Experience Portal to associate the application with a Short Code/Long Number Expression.
Short Code/Long Number
The definition of this field depends on the selected number type. If the number type is:

  • Number: Instructs Experience Portal to associate the application with a single Short Code/Long Number.

  • Number Range: Instructs Experience Portal to associate the application with a sequential range of Short Code/Long Numbers.

You can enter from 1 to 15 digits. Do not include spaces or special characters, for example: (, ), or -.
Short Code Expression If you select the number type Expression, associate this Short Code Expression with the application.

You can use any valid regular expression such as the following:

  • ? to represent a single character

  • * to represent multiple characters

If you select any other number type, this field is not available.
Display text box If you have selected VoiceXML or CCXML Application, this field displays all the DNIS numbers and URIs that are mapped to the speech application.

If you have selected SMS Application, this field displays the short codes of the application.

Select an individual entry in this list by clicking on it, or use Ctrl+Click and Shift+Click to select multiple entries.
Remove Removes the association between the selected entries in the display text box and the application.
Additional Launch Parameters for SMS Application When defining Inbound SMS applications, you can configure the launch parameters for the applications. The launch parameters allow you to assign multiple applications to a common incoming number or incoming email address. When a message arrives, the system checks if the message matches the options specified in the launch parameters. If the parameters match, the application receives the message, subject to the application launch order.

The options are:

  • Algorithm: You can select the following options:

    • None: No algorithm is selected for the message.

    • Starts With: The message must start with the specified pattern.

    • Starts With (and Remove): The message must start with the specified pattern and the pattern is removed before the message is given to the application.

    • Substring Match: The pattern might occur anywhere within the component.

    • Full String Match: The pattern and component must match exactly with no extra characters in either one.

    • Regular Expression: The pattern must be a standard regular expression that must return true when applied against the component. For example, a pattern of “b[ae]t” would mean that the message must contain exactly bat or bet before the message is given to the application.

  • Pattern: The text that you enter for the selected algorithm.

To add multiple launch parameters, click Add.

To remove a launch parameter, click Remove.
SIP Header Source Use the SIP Header Source field to select the source of the launch number for SIP inbound calls.

The options are:

  • To: By selecting this option, the user section of the To header of the incoming INVITE is used to find the application.

  • Request: By selecting this option, the user section of the Request-URI header of the incoming INVITE is used to find the application.

  • Any: By selecting this option, the MPP decides which header from the incoming INVITE is used to find the application. By default, the Any option is selected.

Speech Parameters group

When determining what value to use for each of the following settings, Experience Portal looks at the following sources:

noteNote:

If these fields are not displayed, click the group heading to expand the group.

Field Description
ASR section
Confidence Threshold The confidence level below which the ASR engine will reject the input from the caller.

Enter a number from 0.0 to 1.0.

This value is mapped to whatever scale the ASR engine uses to compute the confidence level. In the case of ASR engines that use MRCP, this value is mapped in a linear fashion to the range 0 to 100.

noteNote:

If you are using Orchestration Designer, see the Confidence field description in your Orchestration Designer documentation.
Sensitivity Level How loud an utterance must be for the ASR engine to start speech recognition.

Enter a number from 0.0 to 1.0. The higher the sensitivity level, the lower the input volume required to start speech recognition.

This value is mapped to whatever scale the ASR engine uses to compute the sensitivity level for speech recognition.

noteNote:

If you are using Orchestration Designer, refer to the Nodes and Palette Options chapter in the Orchestration Designer Developer's Guide for more information on the Sensitivity field description.
Speed vs. Accuracy The balance between speed of recognition and accuracy of recognition.

Enter a number from 0.0 to 1.0.

While using ASR servers with MRCP, if you want to:

  • Decrease the time it takes to recognize an utterance at the expense of recognition accuracy, enter a higher number in this field.

  • Increase the likelihood that an utterance is correctly recognized at the expense of recognition speed, enter a lower number in this field.

This value is mapped to whatever scale the ASR engine uses to compute the balance between speed and accuracy of recognition.

noteNote:

If you are using Orchestration Designer, see the Speed vs. Accuracy field description in your Orchestration Designer documentation.
No Input Timeout The number of milliseconds the system waits for a caller to respond after the prompt is finished playing and before the system throws a No Input event.

For Nuance and Loquendo, enter an integer value in the range 0 to 65535.

noteNote:

If you are using Orchestration Designer, see the Timeout field on the Prompt main tab in your Orchestration Designer documentation.
Recognition Timeout The number of milliseconds the system allows the caller to continue speaking before the system ends the recognition attempt and throws a maxspeechtimeout event.

For Nuance and Loquendo, enter an integer value in the range 0 to 65535.

noteNote:

This field corresponds to the Maximum Speech field in your VoiceXML application. For more information, see your Orchestration Designer documentation.
Maximum Grammar Cache Age The maximum length of time that an utterance can be in the cache before the application considers it to be stale and forces the MPP to download the utterance again.

Enter a whole number of seconds in this field.

When determining whether an utterance is stale or not, the application adds this time together with the value specified in the Maximum Grammar Staleness field and compares that to the age of the utterance plus the value in the Minimum Grammar Freshness Time field.

The maximum grammar cache age plus the maximum grammar staleness time must be greater than or equal to the age of the utterance plus the minimum grammar freshness time.

For example, if the:

  • Maximum grammar cache age is 60

  • Maximum grammar staleness is 20

  • Current utterance has been cached for 45 seconds.

  • Minimum grammar freshness time is 30

Then the application will accept the utterance from the MPP because the expression 60 + 20 > 45 + 30 evaluates as True.

noteNote:

For the purposes of this calculation, if the maximum grammar staleness field is blank, that is the same as setting it to infinity. In that case, the application will always accept the cached utterance from the MPP because the maximum grammar cache age plus infinity will always be greater than the utterance age plus the minimum grammar freshness time.
Minimum Grammar Freshness Time The minimum length of time beyond an utterance’s current age for which the utterance must remain fresh to be accepted by the application.

Enter a whole number of seconds in this field.

The application adds this value to the current age of the utterance and compares the result to the value in the Maximum Grammar Cache Age field plus the value in the Maximum Grammar Staleness field, as described above.
Maximum Grammar Staleness The maximum amount of time beyond the normal expiration time of an utterance that the application server will accept.

Enter a whole number of seconds in this field, or leave it blank to instruct the application to always use a cached response of any age.

The application adds this value to the value in the Maximum Grammar Cache Age field and compares it to the current age of the utterance plus the value in the Minimum Grammar Freshness Time field, as described in the Maximum Grammar Cache Age field.
Remote Utterance URL The destination for remote utterance is based on the option you select here.

The options are:

  • Yes: This option will store the utterance only on the Speech server and Session Detail Records will be populated with the URL to the utterance. If you use Nuance for recording utterances then you must select Yes.

  • No: This option will store the utterance on the MPP and Session Detail Records will be populated with the URL to the utterance.

The default is No.
Session XML The drop-down list provides options to select None or Custom.

Select one of the following options:

  • Selecting the Custom options allows the administrator to upload a Session XML file.

  • Selecting the None option allows the administrator to delete any existing uploaded session XML file.

TTS section
Prosody Volume The default value for the loudness of the synthesized speech output.

Specify one of the following values from the drop-down list or enter a value in the text field.

  • <NONE>

  • default

  • silent

  • x-soft

  • soft

  • medium

  • loud

  • x-loud

noteNote:

The text field is enabled only when you select None in the drop-down list.

The text field is not displayed if you select Loquendo in the TTS field.

Enter a number from 0 to 100, where zero (0) represents no audible output and 100 represents full volume

noteNote:
You can set the Prosody Volume to 50 to ensure that:

  • The TTS resource is properly initialized for the request.

  • All prompts from different speech server with different default volume settings, that include prerecord prompts, are played at the same volume.

Prosody Rate Experience Portal uses this value to fine tune the default TTS speaking rate relative to the server default.

Specify one of the following values from the drop-down list or enter a value in the text field.

  • <NONE>

  • default

  • x-slow

  • slow

  • medium

  • fast

  • x-fast

noteNote:

The text field is enabled only when you select None in the drop-down list.

The text field is not displayed if you select Loquendo in the TTS field.

For Nuance and Loquendo servers, enter a number from 1 to 100.
Vendor Parameters Any vendor-specific or platform-specific parameters that the TTS server requires to function correctly with this speech application.
noteNote:

Contact your speech server provider for details on vendor parameters.

These parameters must be in the general form parameter=value. You can include as many parameters as you want. Use semi-colons (; ) to separate multiple entries.

For example, to specify that a Nuance RealSpeak server should use the custom dictionary called mydictionary.dct on a Linux RealSpeak server, you would enter:ssftrs_dict_enable=file:///opt/ttsdict/mydictionary.dct. For more information, see Administering Avaya Experience Portal .
Session XML The drop-down list provides options to select None or Custom.

Select one of the following options:

  • Selecting the Custom options allows the administrator to upload a Session XML file.

  • Selecting the None option allows the administrator to delete any existing uploaded session XML file.

Reporting Parameters group

noteNote:

If these fields are not displayed, click the group heading to expand the group.

Field Description
Transcription section
noteNote:

The Change Transcription Privacy feature controls the DTMF Data, Prompt Data, TTS Data , and Speech Data fields on the applications web page. The Transcription fields are enabled when a user logs in with the Privacy Manager role. The Transcription fields are disabled when a user does not have the Privacy Manager role. To assign the Privacy Manager role, you can create a new user account by navigating to the User Management > Users page and adding a new user. You can assign the Privacy Manager role to this new account. When you sign in with the Privacy Manager user role, the Transcription fields are enabled.
Transcription Enabled The options are:

  • Yes: Experience Portal creates a transcription log for each call handled by the application. If you select this option, the rest of the fields in this group become available.

  • No: Experience Portal does not save any transcription or performance data.
Transcription Sample Rate The percentage of times that this application will generate a transcription log when it runs.

For example, if this field is set to 25%, then the application will generate a transcription log once out of every four times it runs.

You can use this field to reduce application logging if your Experience Portal system is running under a heavy load.
Performance Trace The options are:

  • Yes: Experience Portal creates a performance trace log for each call handled by the application that has an associated transcription log.

    noteNote:

    This information can be viewed on the Session Details page, which is accessible from the Session Detail Report page.

  • No: Experience Portal does not save performance trace data.
DTMF Data Determines the information Experience Portal saves in the application's transcription log when a Dual-tone multi-frequency (DTMF) event occurs.

The options are:

  • Discard: Experience Portal saves only the DTMF event.

  • Save: Experience Portal saves the DTMF event and its associated data.

noteNote:

Only users with the Privacy Manager role are allowed to change this field.
Prompt Data Determines the information Experience Portal saves in the application's transcription log when a prompt event occurs.

The options are:

  • Discard: Experience Portal saves only the prompt event.

  • Save: Experience Portal saves the prompt event and its associated data.

noteNote:

Only users with the Privacy Manager role are allowed to change this field.
TTS Data Determines the information Experience Portal saves in the application's transcription log when a Text-to-Speech (TTS) event occurs.

The options are:

  • Discard: Experience Portal saves only the TTS event.

  • Save: Experience Portal saves the TTS event and the first few characters of the TTS data.

noteNote:

Only users with the Privacy Manager role are allowed to change this field.
Speech Data Determines the information Experience Portal saves in the application's transcription log when a speech event occurs.

The options are:

  • Discard: Experience Portal saves only the speech event with no result.

  • Text Only: Experience Portal saves the speech event with the result in text format.

  • Text and Speech: Experience Portal saves the speech event along with a link to the URL that contains the associated WAV file.

    The system stores each recording as a separate audio file on the MPP. Therefore, if you select this option for a very active application, you could end up with a large number of WAV files in a single directory. This could lead to performance issues over time.

noteNote:

Only users with the Privacy Manager role are allowed to change this field.
Intent Sample Rate The percentage of times that the application generates intent reporting data when it runs.

For example, if this field is set to 25%, then the application generates intent reporting data once out of every four times it runs.

You can use this field to cut down on application logging if your Experience Portal system is running under a heavy load.
Orchestration Designer Application Logging section
Minimum Level Determines what messages will be sent by this application through the Application Logging web service. You can view this information in the Application Summary or Application Detail report.

The options are:

  • None: Experience Portal ignores all application messages. If this option is selected, this application will not appear in any application reports.

  • Fatal: Experience Portal saves fatal level messages.

  • Error: Experience Portal saves fatal and error level messages.

  • Warning: Experience Portal saves fatal, error, and warning level messages.

  • Info: Experience Portal saves all messages sent by this application.
Call Flow Data Sample Rate The percentage of times that this application will generate call flow data when it runs.

For example, if this field is set to 25%, then the application will generate crumbs once out of every four times it runs.

You can use this field to cut down on application logging if your Experience Portal system is running under a heavy load.
Orchestration Designer Application Tracing section
Runtime Traces The options are:

  • Yes: Tracing in the runtime is enabled.

  • No: Tracing in the runtime is disabled.

The default value is No.
Show XML Output The options are:

  • Yes: The VXML or TextXML output is displayed.

  • No: The VXML or TextXML output is not displayed.

The default value is No.
Show XML Root Determines if the root document, which is always inline, is displayed for every node or only once.

The options are:

  • Once

  • Always

The default value is Once.
Application Traces The trace statements that the application adds through Orchestration Designer.

The options are:

  • Yes: Application Traces option is enabled.

  • No: Application Traces options is disabled

The default value is No.
Soap Traces Enables the WSOP to print the soap request and soap response to the console.

The options are:

  • Yes: Soap Traces option is enabled.

  • No: Soap Traces option is disabled.

The default value is No.
Local Report Log The options are:

  • Yes: Writes a copy of the log to the report.log locally.

  • No: Does not write a copy of the log to the report.log locally.

The default value is No.
Show Exception Stack Trace The options are:

  • Yes: Shows the stack trace for the exceptions that are recorded.

  • No: Does not show the stack trace for the exceptions that are recorded. The default value is No.

The default value is No. The system records the exceptions in the EPM reports. To view the exceptions in the report, run the Application Detail report.
Web Services Traces The options are:

  • Yes: Enables the tracing of the web services calls for the application.

  • No: Does not enable the tracing of the web services calls for the application.

The default value is No. Traces of the web service operation call is logged in the trace.log file in the application‘s log directory on the application server.
Privacy section
noteNote:

This section is displayed only when you select SMS or Email application.
SMS Message The privacy options displayed for SMS Message are:

  • Discard: Discards the SMS messages.

  • Save: Saves the first n characters of the SMS message, where n is the number specified in the field Number of characters to save.
Email Messages The privacy options displayed for Email Messages are:

  • Discard: Discards the email messages.

  • Subject: Saves the first n characters of the subject of the email messages, where n is the number specified in the field Number of characters to save.

  • Body: Saves the first n characters of the body of the email messages, where n is the number specified in the field Number of characters to save.

Advanced Parameters group

noteNote:

If these fields are not displayed, click the group heading to expand the group.

Field Description
Support Remote DTMF Processing Whether the ASR server or the MPP server performs Dual-tone multi-frequency (DTMF) processing.

The options are:

  • Yes: The ASR server performs DTMF processing.

  • No: The MPP server performs DTMF processing.
DTMF Type Ahead Enabled Whether the application supports DTMF type ahead.

DTMF type ahead feature allows a user to provide DTMF input when the prompt is being presented and thereby skip the prompt.

The options are:

  • Yes: The application supports DTMF type ahead.

  • No: The application does not support DTMF type ahead.

noteNote:

This field is enabled only when the Support Remote DTMF Processing field is set to No.
Converse-On Whether the application is invoked by an Avaya Call Center system using the converse-on vector command.

The converse-on vector command makes it possible for the Call Center vector program to call and access a speech application on the Experience Portal system. When it does so, the vector program on the Call Center server makes it possible to send data in the form of DTMF tones. This option tells Experience Portal to listen for these DTMF tones before starting the VoiceXML application.

noteNote:

At run time, the MPP writes the DTMF digit data to the session variable session.telephone.converse_on_data. VoiceXML applications can access this data from that variable. In the case of Orchestration Designer applications, the system writes this data to the vpconverseondata field of the session variable. For more information, see the Orchestration Designer documentation.
Network Media Service Whether this application uses the “voice dialog” Network Media Service for passing the application starting URI as part of the SIP invitation.
noteNote:

For more information, see RFC 4240 at http://www.rfc-archive.org/getrfc.php?rfc=4240.
Early Media Whether the administrator has enabled early media for the application.

Experience Portal applications interact with callers before the incoming call is answered. For application types that include voice such as VoiceXML, CCXML, or VoiceXML/CCXML, the administrator can enable or disable early media on the EPM web interface. Early Media informs the CCXML applications that the application is to be launched before the call is answered. The default CCXML application will launch the application without accepting the call when this flag is set.

The options are:

  • Yes: Enables early media for the application

  • No: Disables early media for the application

The default is No.
Sync FROM and PAI Headers If a caller A calls into an application/agent and the application/agent needs to place an outbound call for call transfer, then on the deskphone caller ID, the system displays as if the call is originating from caller A instead of displaying the application/agent phone number.

The options are:

  • Yes: Display the call originating instead of the application/agent phone number.

  • No: Displays the application/agent phone number.

The default is No.
Dialog URL Pattern A regular expression used to verify the starting URI form the SIP invitation. This is a security parameter used to verity the URI is “trusted.” If it is blank, then any URI will be accepted.
VoiceXML Event Handler The VoiceXML event handler to use for this application.

The options are:

  • <Default>: This application uses the default VoiceXML error handler defined for the Experience Portal system.

  • An error handler name: This application uses a specific error handler instead of the system default. This drop-down lists all VoiceXML error handlers that have been uploaded through the Add VoiceXML Event Handler page.
CCXML Event Handler The CCXML event handler to use for this application.

The options are:

  • <Default>: This application uses the default CCXML error handler defined for the Experience Portal system.

  • An error handler name: This application uses a specific error handler instead of the system default. This drop-down lists all CCXML error handlers that have been uploaded through the Add CCXML Event Handler page.
Generate UCID The Universal Call Identifier (UCID) is an Avaya-proprietary call identifier used to help correlate call records between different systems.

Inbound Calls:

If the Avaya Communication Manager (CM) passes a UCID to Experience Portal, Experience Portal always uses that UCID regardless of the setting in this field. If, however, CM does not pass a UCID, the Experience Portal MPP server can generate one for the call.

The options are:

  • Yes: If the CM does not pass a UCID to Experience Portal, the MPP server generates a UCID.

  • No: The MPP does not generate a UCID.

Transfers & Outbound Calls:

The options are:

  • Yes: For blind and supervised transfers using the <redirect> CCXML tag, the MPP uses the same UCID as the call being transferred. For Bridge and Outcalls , MPP will generate a new UCID.

  • No: The MPP does not generate a UCID.
Operation Mode The SIP header for each call can contain User-to-User Interface (UUI) information that the switch can either pass on as a single block or attempt to parse so that the information can be acted on. This field determines how Experience Portal treats the UUI data.

The options are:

  • Service Provider: Experience Portal passes the UUI data as a single block to the application without making any attempt to interpret data.

    If you select this option, the application must handle the UUI data on its own.

  • Shared UUI: Experience Portal takes the UUI data and parses it into an array of IDs and their corresponding values. It then passes the application both the fully encoded UUI data and the parsed array with only the values still encoded.

    If you select this option, the UUI data must conform to the Avaya UUI specifications described in User-to-User Interface (UUI) data passed in SIP headers.
Transport UCID in Shared Mode If Operation Mode is set to Shared UUI and Generate UCID is set to Yes, this field determines whether Experience Portal encodes the Experience Portal-generated UCID and adds it to the UUI data for all outbound calls.

The default is No, which means that a UCID is only passed as part of the UUI information if that UCID was passed to Experience Portal by the application.
Maximum UUI Length The maximum length of the UUI data that can be passed in the SIP header. If this length is exceeded and Experience Portal generated a UCID for the call, the UCID is removed from the UUI data. If the result still exceeds this value, or if the UCID was passed to Experience Portal by the application, Experience Portal does not send any UUI data. Instead, it leaves the entire field blank because it has no way to determine what can be left out.

Enter an integer between 0 and 2,048, where 0 indicates that Experience Portal should not check the length of the UUI data. The default is 128.
Fax Detection Enabled Whether this application should detect whether the inbound number is a fax machine.

The options are:

  • Yes: The application should attempt to identify whether the caller is a fax machine and route any fax machine calls to the telephone number specified in Fax Phone Number.

  • No: The application should not attempt to identify whether the caller is a fax machine.

The default is No.
Fax Phone Number If Fax Detection Enable is set to Yes, this is the telephone number or URI to which fax machines calls should be routed.
Video Enabled Whether to enable or disable the support for the video server.
The options are:

  • Yes: Enables the video server for a particular application.

  • No: Disables the video server for a particular application.
Video Screen Format Select the video screen format.
The options are:

  • CIF: Common Intermediate Format. The screen resolution for CIF is 352x288 pixels.

  • QCIF: Quarter CIF. The screen resolution for QCIF is 176x144 pixels.

  • SQCIF: Sub-Quarter CIF. The screen resolution for SQCIF is 128x96 pixels.
Video Minimum Picture Interval Video Minimum Picture Interval (MPI) is the time interval used to define the frame rate. MPI uses the CIF, QCIF, and SQCIF formats.

Enter a value in the range 1 to 32. The default is 2.

For CIF, QCIF and SQCIF, if the value is zero, the screen format is disabled otherwise the frame rate is defined by (29.97/MPI). For example: for value 1 = 30 FPS, for 2 = 15 FPS, and so on.
Comments on this document?
August 2025
© 2022-2025, Avaya LLC All Rights Reserved.