This chapter describes the Oracle Communications Services Gatekeeper Parlay X 2.1 Call Notification/Session Initiation Protocol (SIP) communication service in detail.
The Parlay X 2.1 Call Notification/SIP communication service exposes the Parlay X 2.1 Call Notification application interfaces.
The communication service connects to a SIP-IMS network using Oracle Converged Application Server. Converged Application Server is collocated with Services Gatekeeper in the network tier. The SIP servlet running on Converged Application Serve acts as both as a SIP User Agent and a SIP Proxy. Depending on which Parlay X operation and state of the call, the SIP servlet acts either as a proxy or as the calling party.
For the exact version of the standards that the Parlay X 2.1 Call Notification communication service supports for the application-facing interfaces and the network protocols, see Services Gatekeeper Statement of Compliance.
Using this communication service, an application can:
Set up and tear down notifications on call events for a specified combination of caller and callee.
Receive additional notifications on call events related to the notification in question.
Affect a call during call setup.
This communication service is not used to set up new calls. It is used only to reroute or terminate calls that are already in progress.
For an application to receive notifications about call setup attempts from the network, it must register its interest in these notifications by setting up a subscription in Services Gatekeeper. A subscription, or a notification, is defined by a set of addresses and a set of criteria. The criteria define the events in which the application is interested. The addresses may be translated by some mechanism in the telecom network prior to reaching Services Gatekeeper.
Two types of notifications exist:
An application can register to be notified about the following events as the call between the caller and the callee is set up:
Callee is busy.
Callee is not reachable.
Callee does not answer.
Call is in progress.
Call setup in progress.
In addition to monitoring the state of call setup, an application can also choose to make certain changes to the call under certain conditions. An application can:
Intercept a call setup attempt between the caller and the callee and reroute the call (to a C-party) without making an attempt to connect with the callee (B-party). An example might be a general technical support number that is routed to the appropriate call center based on time of day.
In addition, if one of the monitored events occurs (busy, not reachable, does not answer), an application can:
Let further processing of the call be handled by the network.
End the call.
Reroute the call to another callee (C-party).
Requests (registration for notifications) using the Call Notification communication service flow only in one direction: from the application to Services Gatekeeper.
The communication service manages only the signalling aspect of a call. The media or audio channel is managed by the underlying telecom network. Only parties residing on the same network can be controlled unless:
The network plug-in connects to a media gateway controller.
One of the participants is connected to a signalling gateway so that, from a signalling point of view, all parties reside on the same network.
Information about the SOAP-based interface for the Parlay X 2.1 Call Notification communication service is located in Services Gatekeeper Application Developer's Guide.
The RESTful Service Call Notification interfaces provide RESTful access to the same functionality as the SOAP-based interfaces. The internal representations are identical, and for the purposes of creating service level agreements (SLAs), reading charging detail records (CDRs), and so on, they are the same.
For information about the RESTful Call Notification interface, see the discussion about the Call Notification interface in Services Gatekeeper Application Developer's Guide.
The Parlay X 2.1 Call Notification/SIP communication service generates event data records (EDRs), CDRs, alarms, and statistics to assist system administrators and developers in monitoring the service.
See "Events, Alarms, and Charging" for general information.
Table 6-1 lists IDs of the EDRs created by the Parlay X 2.1 Call Notification/SIP communication service. This list does not include EDRs created when exceptions are thrown.
Table 6-1 EDRs Generated by Parlay X 2.1 Call Notification/SIP
| EDR ID | Method Called |
|---|---|
|
3000 |
startCallNotification |
|
3001 |
stopCallNotification |
|
3002 |
startCallDirectionNotification |
|
3003 |
stopCallDirectionNotification |
|
8014 |
notifyBusy |
|
8015 |
notifyCalledNumber |
|
8016 |
notifyNoAnswer |
|
8017 |
notifyNotReachable |
|
8018 |
handleBusy |
|
8019 |
handleCalledNumber |
|
8020 |
handleNoAnswer |
|
8021 |
handleNotReachable |
Call Notification/SIP - specific CDRs are generated under the following conditions:
After a notifyBusy, notifyCalledNumber, notifyNoAnswer, notifyAnswer, or notifyNotReachable is sent from the network.
After a handleBusy, handleCalledNumber, handleNoAnswer, or handleNotReachable is called.
Table 6-2 maps methods invoked from either the application or the network to the transaction types collected by the Services Gatekeeper statistics counters.
Table 6-2 Methods and Transaction Types for Parlay X 2.1 Call Notification/SIP
| Method | Transaction Type |
|---|---|
|
notifyBusy |
TRANSACTION_TYPE_CALL_CONTROL_NETWORK_INITIATED |
|
notifyNotReachable |
TRANSACTION_TYPE_CALL_CONTROL_NETWORK_INITIATED |
|
notifyNoAnswer |
TRANSACTION_TYPE_CALL_CONTROL_NETWORK_INITIATED |
|
notifyCalledNumber |
TRANSACTION_TYPE_CALL_CONTROL_NETWORK_INITIATED |
|
handleBusy |
TRANSACTION_TYPE_CALL_CONTROL_NETWORK_INITIATED |
|
handleNotReachable |
TRANSACTION_TYPE_CALL_CONTROL_NETWORK_INITIATED |
|
handleNoAnswer |
TRANSACTION_TYPE_CALL_CONTROL_NETWORK_INITIATED |
|
handleCalledNumber |
TRANSACTION_TYPE_CALL_CONTROL_NETWORK_INITIATED |
This section describes the properties and workflow the Parlay X 2.1 Call Notification/SIP plug-in instance.
Parlay X 2.1 Call Notification/SIP uses two parts for SIP connectivity: a part that executes as a network protocol plug-in instance in the Services Gatekeeper container and a part that executes as a SIP application in the SIP Server container. The two parts execute in different containers and must be configured in both.
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 6-3 lists the technical specifications for the communication service.
Table 6-3 Properties for Parlay X 2.1 Call Notification/SIP
| Property | Description |
|---|---|
|
Managed object in Administration Console |
To access the managed object, select domain_name, then OCSG, then server_name, then Communication Services, and then Plugin_px21_call_notification_sip in that order. |
|
MBean |
Domain=com.bea.wlcp.wlng Name=wlng_nt InstanceName=Plugin_px21_call_notification_sip Type=com.bea.wlcp.wlng.plugin.callnotification.sip.management.CallNotificationMBean Documentation: See the CallNotificationMBean class in the ”All Classes” section of Services Gatekeeper OAM Java API Reference. |
|
Network protocol plug-in service ID |
Plugin_px21_call_notification_sip |
|
Supported Address Scheme |
sip |
|
Application-facing interfaces |
com.bea.wlcp.wlng.px21.plugin.CallNotificationManagerPlugin com.bea.wlcp.wlng.px21.plugin.CallDirectionManagerPlugin com.bea.wlcp.wlng.px21.callback.CallNotificationCallback |
|
Service type |
CallNotification |
|
Exposes to the service communication layer a Java representation of: |
Parlay X 2.1 Part 3: Call Notification |
|
Interfaces with the network nodes using: |
SIP: Session Initiation Protocol, RFC 3261 |
|
Deployment artifacts: NT EAR wlng_nt_call_notification_px21.ear |
px21_call_notification_service.jar, plugin_px21_call_notification_sip.jar, and px21_call_notification_sip.war |
|
Deployment artifacts: AT EAR: Normal wlng_at_call_notification_px21.ear |
px21_call_notification.war, px21_call_notification_callback.jar, and rest_call_notification.war |
|
Deployment artifacts: AT EAR: SOAP Only wlng_at_call_notification_px21_soap.ear |
px21_call_notification.war and px21_call_notification_callback.jar |
Following is an outline for configuring the plug-in using the Administration Console or an MBean browser.
Set up the routing rules to the plug-in instance. See the discussion about configuring and managing the plug-in manager in Services Gatekeeper System Administrator's Guide. Use the plug-in instance ID and address schemes listed in the "Properties for Parlay X 2.1 Call Notification/SIP" section.
If desired, create and load a node SLA. For details see the discussion on defining global node and service provider group node SLAs and managing SLAs in Services Gatekeeper Accounts and SLAs Guide.
Provision the service provider accounts and application accounts. For information, see Services Gatekeeper Portal Developer's Guide.
For a description of the fields and methods of the CallNotificationMBean class, see the ”All Classes” section of Services Gatekeeper OAM Java API Reference.