Find answers to your technical questions and learn how to use our products
Search suggestions:
Find answers to your technical questions and learn how to use our products
Search suggestions:
Use this page to view an existing application.
This page contains the following sections:
Field |
Description |
|---|---|
Zone |
The name of the zone where the application is configured.
Note:
This field is displayed only when zones are configured in the system. |
Name |
The name used to identify this application on the Experience Portal system. |
Enable |
Whether this application is available for use by the Experience Portal system. |
Type |
The options are:
|
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:
|
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:
|
Requested |
The minimum or maximum number of the Reserved SIP Calls for the application. |
Field |
Description |
|---|---|
Type |
The options are:
|
CCXML URL |
The HTTP path to the root document of the Call Control eXtensible Markup Language (CCXML) speech application. |
CCXML(BNMS) |
The HTTP path to the root document of the Call Control eXtensible Markup Language (CCXML) Basic Network Media Services (BNMS) speech application. |
VoiceXML URL |
The HTTP path to the root document of the VoiceXML speech application. |
SMS URL |
The HTTP path to the root document of the SMS application. |
Email URL |
The HTTP path to the root document of the email application. |
HTML |
The HTTP path to the root document of the HTML application. The Internal URL is the URL that the EPM should use to directly connect with the Orchestration Designer Application servers. The External URL is the URL that the EPM should return as the location for an external browser to access the same 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.
Note:
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 |
If mutual certificate authentication between the EPM/MPP and the application is enabled. |
Basic Authentication |
If user name and password authentication between the EPM/MPP and the application is enabled. If the Basic Authentication option is enabled, Avaya Experience Portal displays:
|
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. |
Notification URL |
The URL of the SMS or Email notification. |
Field |
Description |
|---|---|
ASR |
If this application uses Automatic Speech Recognition (ASR) resources, this field lets you select the ASR engine type that will be used. |
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 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.
Note:
If a speech application is configured to use more languages than are configured for any single ASR server, Experience Portal sends a |
Selected Languages |
All language(s) that you select in the Languages pane appear in this pane. |
Resources |
If an ASR speech server is selected, this field displays how the application acquires the ASR speech resource. The options are:
|
TTS |
If this application uses Text-to-Speech (TTS) resources, this field lets you select the TTS engine type that will be used. |
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.
Note:
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. |
Field or Button |
Description |
|---|---|
Type |
The options are:
Note:
The rest of the fields in this section are displayed only if the Inbound option is selected. |
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 an SMS application, this field displays the short codes/long numbers or short code expressions of the application. If you have selected an Email application, this field displays the user name or user name expression of the application. |
Additional Launch Parameters |
The additional launch parameters configured for the Inbound SMS or Email applications. |
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. 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. |
Sensitivity Level |
How loud an utterance must be for the ASR engine to start speech recognition. This value is mapped to whatever scale the ASR engine uses to compute the sensitivity level for speech recognition. |
Speed vs. Accuracy |
The balance between speed of recognition and accuracy of recognition. This value is mapped to whatever scale the ASR engine uses to compute the balance between speed and accuracy of recognition. |
N Best List Length |
The maximum number of recognition results that the ASR engine can return. |
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. |
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. |
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. 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. |
Speech Incomplete Timeout |
The number of milliseconds of silence following user speech after which a recognizer finalizes a result. 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. |
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. 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:
Then the application will accept the utterance from the MPP because the expression 60 + 20 > 45 + 30 evaluates as True. |
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. 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. 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. |
Session XML |
The drop-down list provides options to select None or Custom. Select one of the following options:
|
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. |
Credentials |
The authentication credentials for communicating with a Google Dialogflow Engine. Upload the credentials as a JSON file as defined by the Google Dialogflow Engine. This field is displayed only when you select Dialogflow in the ASR Engine Types field. For more information on the authentication credentials, refer to the 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. |
TTS section |
|
Prosody Volume |
The default value for the loudness of the synthesized speech output. |
Prosody Rate |
Experience Portal uses this value to fine tune the default TTS speaking rate relative to the server default. |
Vendor Parameters |
Any vendor-specific or platform-specific parameters that the TTS server requires to function correctly with this speech application. |
Session XML |
The drop-down list provides options to select None or Custom. Select one of the following options:
|
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:
|
VAD Type |
The Voice Activity Detection algorithm type. The options are:
Note:
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.
Note:
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.
Note:
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.
Note:
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.
Note:
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.
Note:
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.
Note:
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
Note:
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.
Note:
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.
Note:
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.
Note:
This field is displayed only when you select Inqa as the VAD Type. |
If these fields are not displayed, click the group heading to expand the group.
Field |
Description |
|---|---|
|
Transcription section
Note:
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 |
Whether Experience Portal creates a transcription log for each call handled by the application. |
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 |
Whether Experience Portal creates a performance trace log for each call handled by the application that has an associated transcription log. |
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:
|
Prompt Data |
Determines the information Avaya Experience Portal saves in the application's transcription log when a prompt event occurs. The options are:
|
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:
|
Speech Data |
Determines the information Experience Portal saves in the application's transcription log when a speech event occurs. The options are:
|
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. |
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. |
Orchestration Designer Application Tracing section |
|
Runtime Traces |
The options are:
|
Show XML Output |
The options are:
|
Show XML Root |
Determines if the root document, which is always inline, is displayed for every node or only once. The options are:
|
Application Traces |
The trace statements that the application adds through Orchestration Designer. The options are:
|
Soap Traces |
Enables the WSOP to print the soap request and soap response to the console. The options are:
|
Local Report Log |
The options are:
|
Show Exception Stack Trace |
The options are:
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:
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
Note:
This section is displayed only when you select SMS or Email application. |
|
SMS Message |
The privacy options displayed for SMS Message are:
|
Email Messages |
The privacy options displayed for Email Messages are:
|
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:
|
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:
Note:
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. |
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.
Note:
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 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. |
Sync FROM and PAI Headers |
If a caller A calls into an application or agent and the application or 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 or agent phone number. The options are:
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. |
CCXML Event Handler |
The CCXML event handler to use for this application. |
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:
Transfers & Outbound Calls: The options are:
|
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:
|
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. |
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. |
Fax Detection Enabled |
Whether this application should detect whether the inbound number is a fax machine. The options are:
|
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 the support for the video server is enabled or disabled.
The options are:
|
Video Screen Format |
The selected video screen format.
The options are:
|
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. 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. |