| Oracle® Communications Services Gatekeeper Communication Service Guide Release 5.1 E37526-01 |
|
|
PDF · Mobi · ePub |
| Oracle® Communications Services Gatekeeper Communication Service Guide Release 5.1 E37526-01 |
|
|
PDF · Mobi · ePub |
This chapter describes the Parlay X 3.0 Audio Call/Parlay 3.3 User Interaction and MultiParty Call Control communication service in detail.
The Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC communication service exposes the Parlay X 3.0 Audio Call set of application interfaces.
The communication service acts as an Open Services Architecture (OSA) Parlay application to an internal Services Gatekeeper OSA/Parlay Gateway. It uses this gateway to access the Call User Interaction and MultiParty Call Control SCSs. For information about the gateway, see "Managing OSA/Parlay Gateway Connections using Parlay_Access" in Oracle Communications Services Gatekeeper System Administrator's Guide.
For the exact version of the standards that the communication service supports for the application-facing interfaces and the network protocols, see the appendix on standards and specifications in Oracle Communications Services Gatekeeper Concepts Guide.
Using the Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC communication service, an application can:
Play audio to one or more call participants in an existing call session set up by the communication service.
Find out if the audio is currently being played or has not yet started to play.
Explicitly end playing of the audio.
Collect digits from call participants in response to an audio message that has been played to them and, in conjunction with the Parlay X 3.0 Call Notification/MPCC communication service, return the information to the application.
Interrupt an ongoing interaction, such as on-hold music.
The Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC communication service can be used by applications to play audio messages to one or more call participants in an existing call. The existing call is identified by the Call Session Identifier returned to the application at the time the call session is set up. If desired, applications can receive digits collected from those participants in response to the audio message using a notification set up using the communication service.
The audio message content to be played must be defined in a binary format such as WAV stored at a URL available to the network and rendered by an audio player. Services Gatekeeper does not actually render the message. This is the responsibility of equipment that must be present on the target telecom network, such as Interactive Voice Response (IVR) systems.
For information about the SOAP-based interface for the Parlay X 3.0 Audio Call communication service, see the discussion of Parlay X 3.0 Interfaces in Oracle Communications Services Gatekeeper Application Developer's Guide.
The Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC communication service generates Event Data Records (EDRs), Charging Data Records (CDRs), alarms, and statistics to assist system administrators and developers in monitoring the service.
For general information, see Appendix A, "Events, Alarms, and Charging."
Table 15-1 lists the IDs of the EDRs created by the Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC communication service. This does not include EDRs created when exceptions are thrown.
Table 15-1 Event Types Generated by Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC
| EDR ID | Method Called |
|---|---|
|
11100 |
playAudioMessage |
|
11101 |
getMessageStatus |
|
11102 |
endMessage |
|
11103 |
startPlayAndCollectInteraction |
|
11104 |
stopMediaInteraction |
|
11105 |
sendInfoRes |
|
11106 |
SendInfoErr |
|
11107 |
sendInfoAndCollectRes |
|
11108 |
SendInfoAndCollectErr |
|
11109 |
attachMediaRes |
|
111010 |
attachMediaErr |
|
111011 |
detachMediaRes |
|
111012 |
detachMediaErr |
|
111013 |
abortActionRes |
|
111014 |
abortActionErr |
Audio Call/Parlay 3.3 UI-MPCC-specific CDRs are generated under the following conditions:
When sendInfoRes is sent from the network to Services Gatekeeper, indicating that the audio message has completed playing, if this is not the result of an explicit request to stop from the application.
When sendInfoAndCollectRes is sent from the network to Services Gatekeeper, indicating that the audio message has completed playing and the call participant's response has been collected in the form of digits.
Table 15-2 maps methods invoked from either the application or the network to the transaction types collected by the Services Gatekeeper statistics counters.
This section lists the parameters that can be tunneled or defined in the <requestContext> element of an SLA.
Specifies how many times an audio announcement is played to a call participant.
This setting overrides the value set in the OAM RepeatIndicator attribute.
Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.
String with a non-negative integer value
A value of zero (0) indicates either that the announcement will be repeated until the call or call leg is released, either by an application or the network, or that the announcement will be ended by an application.
A positive value specifies the exact number of times that the announcements will be played.
This section describes the properties and workflow for the Parlay X 3.0 Audio Call/Parlay MultiParty Call Control and Call User Interaction plug-in instance.
Most of the configuration is done in the Open Services Architecture (OSA) Access module, but with configuration parameters for Parlay MultiParty Call Control. See "Managing OSA/Parlay Gateway Connections using Parlay_Access" in Oracle Communications Services Gatekeeper System Administrator's Guide.
This plug-in service is requires Orbacus, which is not installed by default. For information about installing Orbacus, see Oracle Communications Services Gatekeeper Installation Guide.
This plug-in service does not support multiple instantiation using the Plug-in Manager. There is a one-to-one mapping between plug-in service and plug-in instance. The plug-in instance is created when the plug-in service is started.
Table 15-3 lists the technical specifications for the communication service.
Table 15-3 Properties for Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC
| Property | Description |
|---|---|
|
Managed object in Administration Console |
domain_name > OCSG > server_name > Communication Services > Plugin_px30_audio_call_parlay_mpcc_cui |
|
MBean |
Domain=com.bea.wlcp.wlng Name=wlng_nt InstanceName=Plugin_px30_audio_call_parlay_sip Type=com.bea.wlcp.wlng.plugin.ac.parlay.management.AudioCallManagementMBean |
|
Network protocol plug-in service ID |
Plugin_px30_audio_call_parlay_mpcc_cui |
|
Network protocol plug-in instance ID |
Plugin_px30_audio_call_parlay_mpcc_cui |
|
Supported Address Scheme |
tel |
|
Application-facing interfaces |
com.bea.wlcp.wlng.px30.plugin.AudioCallPlayMediaPlugin com.bea.wlcp.wlng.px30.plugin.AudioCallCaptureMediaPlugin |
|
Service type |
AudioCall |
|
Exposes to the service communication layer a Java representation of: |
Parlay X 3.0 Part 11: Audio Call |
|
Interfaces with the network nodes using: |
Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control SCF; Subpart 7: MultiParty Call Control Service Open Service Access (OSA); Application Programming Interface (API); Part 5: User Interaction SCF |
|
Deployment artifacts |
osa_access.jar, Plugin_px30_audio_call_parlay_mpcc_cui.jar, and px30_audio_call_service.jar, packaged in wlng_nt_audio_call_px30.ear px30_audio_call.war, packaged in wlng_at_audio_call_px30.ear |
Following is an outline for configuring the plug-in using the Administration Console or an MBean browser.
Select the MBean listed in the "Properties for Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC" section.
Configure the behavior of the plug-in instance using the MBean attributes. See "Reference: Attributes for Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC" for a list of the attributes and their settings.
Obtain the following information from your OSA Gateway administrator and configure the MultiParty Call Control part of the protocol translator (Parlay_Access service) accordingly:
OSA/Parlay SCS type to be used in the lookup (service discovery) phase when requesting the MultiParty Call Control service (OSA/Parlay SCS) from the OSA/Parlay Gateway. Typically this is P_MULTI_PARTY_CALL_CONTROL.
OSA/Parlay service properties to be used in the look up (service discovery) phase. This information is used to request a service (OSA/Parlay SCS) from the OSA/Parlay Gateway. These properties are specific to the OSA Gateway implementation.
Authentication type used by the OSA/Parlay Framework.
Encryption method used for the connection with the OSA Gateway.
The signing algorithm used when signing the service level agreement with the OSA/Parlay Framework.
Set up the OSA Client and the OSA Client Mappings for the MultiParty Call Control part of the plug-in instance. For information on how to do this, see "Creating an OSA client" and "Mapping the OSA client to an OSA Gateway and an OSA/Parlay SCS" in "Managing OSA/Parlay Gateway Connections using Parlay_Access" in Oracle Communications Services Gatekeeper System Administrator's Guide.
Gather the following information from your OSA Gateway administrator and configure the Call User Interaction part of the protocol translator (OSA Access service) accordingly:
OSA/Parlay SCS type to be used in the lookup (service discovery) phase when requesting the Generic User interaction service (OSA/Parlay SCS) from the OSA/Parlay Gateway. Typically this is P_USER_INTERACTION.
OSA/Parlay service properties to be used in the lookup (service discovery) phase when requesting a service (OSA/Parlay SCS) from the OSA/Parlay Gateway. This depends on the OSA Gateway implementation.
Authentication type used by the OSA/Parlay Framework.
Encryption method used for the connection with the OSA Gateway.
Signing algorithm used when signing the service level agreement with the OSA/Parlay Framework.
Set up the OSA Client and the OSA Client Mappings for the Generic User Interaction part of the plug-in instance. For information on how to do this, see "Creating an OSA client" and "Mapping the OSA client to an OSA Gateway and an OSA/Parlay SCS" in "Managing OSA/Parlay Gateway Connections using Parlay_Access" in Oracle Communications Services Gatekeeper System Administrator's Guide.
If required, create and load a node SLA. For details see “Defining Global Node and Service Provider Group Node SLAs” and “Managing SLAs” in the Oracle Communications Services Gatekeeper Accounts and SLAs Guide.
It is not necessary to set up routing rules to the plug-in instance.
This section lists the attributes for configuration and maintenance.
Scope: Cluster
Unit: Not applicable
Format: Boolean
Specifies whether charging is allowed.
true if an application is allowed to specify charging information when playing a message (Parlay X operation playAudioMessage).
false if not.
Scope: Cluster
Unit: Seconds
The inter-character timeout when collecting user input. Also known as the value for the inter-character timeout timer.
This value corresponds to the TpUICollectCriteria.InterCharTimeOut parameter in sendInfoAndCollectReq requests to the Generic User Interaction SCS.
Scope: Cluster
Unit: Seconds
The start timeout period for collecting user input. Specifies how much time is allowed for the user to enter the first character.
The value corresponds to the TpUICollectCriteria.StartTimeout parameter in sendInfoAndCollectReq requests to the Generic User Interaction SCS.
Scope: Server
Unit: Not applicable
Format: String
The digit to be used for ending collection of data of various lengths from a call participant.
The value corresponds to the TpUICollectCriteria.EndSequence parameter in sendInfoAndCollectReq requests to the Generic User Interaction SCS.
Scope: Cluster
Unit: Not applicable
Format: String according to valid language strings as defined in ISO 639.
The language of the message to be played for the call participant.
Scope: Server
Unit: Not applicable
Format: Positive integer
The maximum number of digits that can be collected from the call participant.
The value corresponds to the TpUICollectCriteria.MaxLength parameter in sendInfoAndCollectReq requests to the Generic User Interaction SCS.
Valid range is 1–65535.
Scope: Server
Unit: Not applicable
Format: Positive integer
The minimum number of digits that can be collected from the call participant.
The value corresponds to the TpUICollectCriteria.MinLength parameter in sendInfoAndCollectReq requests to the Generic User Interaction SCS.
Valid range is 1–65535.
Scope: Cluster
Unit: Not applicable
Format: Integer
The number of times a message should be played to the call participant.
The value corresponds to the repeatIndicator parameter in sendInfoReq requests to the Generic User Interaction SCS.
Scope: Cluster
Unit: Not applicable
Format: Integer [1,2,4]
Specifies whether a response is required from the Generic User Interaction SCS, and what, if any, action the service should take.
The value corresponds to the responseRequested parameter in sendInfoReq requests to the Generic User Interaction SCS.
The valid values are:
1 for P_UI_RESPONSE_REQUIRED
2 for P_UI_LAST_ANNOUNCEMENT_IN_A_ROW
4 for P_UI_FINAL_REQUEST
Scope: Cluster
Unit: Seconds
Format: Integer
The time interval for which status information is retained after a message is played or an error occurs.
Scope: Server
Unit: Seconds
Format: Integer
The time interval to wait for call sessions to end before terminating. Used for performing a graceful shutdown.
|
 Copyright © 2011, 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
