The following section describes configuration and maintenance attributes and operations for the communication services that expose Parlay X 3.0 and Parlay X 2.1 Third Party Call Web Services interfaces. The sections also provide a workflow for the configuration. There are three plug-in services related to Third Party Call:
This section contains a description of the configuration attributes and operations available for the Parlay X 3.0 Third Party Call/OSA MultiParty Call Control network protocol plug-in instance.
Move on to provisioning of service provider accounts and application accounts.
The following operations are related to management:
This plug-in service does not support multiple instantiation using the Plug-in Manager. There is a one to one mapping between the plug-in service and the plug-in instance. The plug-in instance is created when the plug-in service is started.
Below is a list of attributes and operations for configuration and maintenance:
Indicates current configuration for the method getInfoReq operation in IpMultiPartyCall interface. The information includes:
Us Operation: configCallGetInfoReq to change these settings.
Specifies if the parameter callingParticipantName
in the method makeCallSession
defined in the Parlay X 3.0 Third Party Call interface shall be used as the original address or not.
If callingParticipantName
is required, it must be in the form of a string which can be translated to a URI, for example tel:123456
.
Indicates current configuration for the method getInfoReq operation in IpCallLeg interface. The information includes:
Use Operation: configLegGetInfoReq to change these settings.
Specifies if a call which duration exceeds the maximum value shall be terminated or not
Indicates if multimedia is supported
Specifies whether charging is allowed.
Specifies the length of time information about a call is stored after the call is terminated.
Specifies if an end user, that is, a call participant, is allowed to change the media used in the call.
true
if an end user is alllowed to change media for an existing call session. In order for a end user to change the media type for a given call session, this attribute must be true and the application must have allowed it when the call session was established (operation makeCallSession
) and Attribute: MultiMediaSupported must be True.False
if not.Specifies the maximum number of participants in a call.
Configures the parameters in the getInfoReq operation in the interface IpMultiPartyCall.
configCallGetInfoReq(Supported: Boolean, PCallInfoTimes: Boolean, PCallInfoReleaseCause: Boolean)
Configures the parameters in the getInfoReq operation in the interface IpCallLeg.
configLegGetInfoReq(Supported : Boolean, PCallLegInfoTimes : Boolean, PCallLegInfoReleaseCause : Boolean, PCallLegInfoAppInfo : Boolean)
Displays a list of IDs for all call legs in a call session.
getCallLegs(CallSessionId: String)
Displays information about a call session. This includes:
callSessionId
: the ID of the call session. callStatus
: the current status of the call. The status is one of :Established
, during call duration.Terminated
, when the call has terminated but informnation is still present in the internal storage, see Attribute: StatusRetentionTime.Expired
, when the call is terminated and information is no longer available. originalAddress
: the originator (a-party) of the call.appInstGrpId
: the application instance ID associated with the application that created the call session.callRef
: the CORBA reference to the call object in the Parlay Gateway (IpMultiPartyCall).srcPlugin
: the type of plug-in instance that initiated the call. The type is one of:getCallSessionInfo(CallSessionId: String)
Displays information about a call leg in a call session.
id:
the CORBA reference to the call leg object in the Parlay Gateway (IpCallLeg).callSessionId
: the ID of the call session. callParticipantIdentifier
: the URI identifying the terminal associated with the call leg.callParticipantStatus
: the status of the call participant. The status is one of:callParticipantStartTime
: the time when the call participant was connected to the the call.callParticipantEndTime
: the time when the call participant was disconnected from the call.callParticipantDuration
: the duration of the call for the participant. Given in seconds.callPariticipantTerminationCause
: the cause of the participant leaving the call. One of:appInstGrpId
: the application instance associated with the application that created the call session.callRef
: the CORBA reference to the call object in the Parlay Gateway (IpMultiPartyCall).srcPlugin
: the type of plug-in instance that initiated the call. The type is one of:getCallLegSessionInfo(CallLegSessionId: String)
Displays a list of IDs for ongoing call sessions. These are the Parlay X 3.0 callSessionIDs
.
listCallSessionIds()
Displays the number of ongoing call sessions for this plug-in instance.
countPendingCallSession()
This section contains a description of the configurations attributes and operations available for Parlay X 2.1 Third Party Call/INAP plug-in instance.
This plug-in instance uses the TietoEnator SS7 stack to connect to the network.
When configuring the SS7 connectivity, the settings in the management interface for the plug-in instance must be correlated with a sub-set of the settings in the following Stack-in-a-Box configuration files, see Configuration files and dependencies.
Configuration and management of other parts of Stack-in-a-Box are outside the scope of this descriptio.Refer to the TietoEnator SS7 product documentation.
Note: | When any of these attributes are changed, the INAP API configuration file is overwritten and the plug-in service must be restarted. |
Move on to the provisioning of service provider accounts and application accounts.
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.
Below is a list of attributes and operations for configuration and maintenance:
Format: int [0-16383] or [0-16777215], depending on standard used.
Specifies the local SCCP Signaling Point Code (SPC) served by the local SS7 stack, that is, the SS7 network address for the plug-in instance. Used as the originating SPC by the plug-in instance.
Must be correlated with the property SCCP Local SPC in the back-end configuration file for the SS7 stack.
Specifies the local SCCP Sub System Number, to which the plug-in instance will bind itself.
Must be correlated with the property SCCP Local SSN in the back-end configuration file for the SS7 stack.
Format: int [0-16383] or [0-16777215], depending on standard used.
Specifies the remote SCCP Signaling Point Code (SPC). Used in the destination address.
Must be correlated with the property SCCP Remote SPC in the back-end configuration file for the SS7 stack.
Specifies the remote SCCP Signaling Sub System Number (SPC). Used in the destination address.
Must be correlated with the property SCCP Remote SSN in the back-end configuration file for the SS7 stack.
Specifies the timeout value for the T(SCF) timer, used for supervising call establishment. It specifies how long the plug-in instance should wait for a response from an SCP after sending a request. If the time-out value is exceeded the TCAP dialogue is aborted.
Specifies the time-out value for an INAP noAnswer event. The time-out value is used towards the signaling network in INAP DpSpecificCriteria when arming the noAnswer event.
Specifies the SCCP priority indicator. 0 is the lowest priority and 3 is the highest priority.
Specifies the SCCP quality of service indicator.
Specifies the user ID used by the INAP plug-in when connecting to the SS7 stack. Must be defined in the common parts configuration file, see Common parts configuration file.
Specifies the host name or IP address of the SS7 stack. Separate the host names or IP addresses with a comma (,) if the stack is running in HA mode.Also if you are using HA mode, use this attribute to define the port number to use: for example 192.168.0.19:99, and do not use Attribute: Ss7PortNumber to specify the port number.
Specifies the port number to use in connecting to the stack.
Specifies the stack bind timeout value.
There are a set of dependencies and settings that must be correlated between the configuration files and the configuration settings in the plug-in instance. The following files have touch-points:
Plugin_px21_third_party_call_inap.properties
): see INAP API configuration file.(itu_ss7.cfg
): see Back-end configuration file.cp.cnf
): see Common parts configuration file.The specific settings are explained in the sections describing the settings in the management interface for the plug-in instance and the description of the files. Figure 17-1below presents an overview of the dependencies.
The INAP API configuration file is a configuration file for the TietoEnator JAIN INAP API library used by the plug-in instance.
This file provides the API with information on where to connect, how to bind to the stack, and values for some parameters that are not exposed in the API. If any of the properties are not set, default values are used.
The properties that are related to the interface between the plug-in instance and the stack are described in Table 17-9. See the documentation for the stack for a full description of all settings.
The file is located on the file system of the host where the plug-in instance is running; in default installations this is in the domain home directory of Network Gatekeeper. The file is created and updated when an attribute is updated using the MBean for the Parlay x 2.1 Third Party Call/INAP plug-in. The plug-in service needs to be restarted for the changes to effect.
The file is named Plugin_px21_third_party_call_inap.properties
and it is located in $DOMAIN_HOME.
Any changes to the MBean attributes causes the file to be overwritten, and hence any modifications to it are lost.
The common parts module ID used by the plug-in instance. See Common parts configuration file.
The numeric identifier of the ID shall be used, not the ID itself (as used in the common parts configuration file).
|
|||
The host name or IP-address of the host running the SS7 back-end, that is, the address to which the SS7_BASE module ID is bound in the common parts configuration file. See Common parts configuration file.
|
|||
Must correspond to the MSGHBRATE and MSGHBLOST properties defined in the common parts configuration file. See Common parts configuration file.
|
local-ssn: 254
priority: 0
quality-of-service: 0
trace-level: 0
inap-user-id: 40
ss7host: 192.168.20.1,192.168.20.2
port-number: 7001
bind-timeout: 5000
The SS7 Common parts configuration file is a configuration file specifying the interprocess communication for the SS7 stack, including users of the stack. The plug-in instance acts as user of the stack via the INAP API. The dependencies to the plug-in instance and the stack is described in Table 17-9. All other settings are related to the stack itself: see the documentation for the stack for a description of these settings.
The file is located on the file system of the host running the back-end part of the SS7 stack. In default installations this is in /opt/ss7/ss7_ITU/etc/cp.cnf
.
MP OwnerID shall correspond to inap-user-id specified in Attribute: InapUserId
The IP-address (or host name) with TCP port number must correspond to the host where the plug-in instance is deployed. |
|
Must correspond to Attribute: LocalSpc.
|
|
Must correspond to heartbeat-interval in INAP API configuration file
|
The back-end configuration file contains the configuration of the SS7 back-end stack layers. Each stack layer has a dedicated section in this file, and it is where, for example, SS7 network routing and protocol timers are configured. The dependencies between the plug-in instance and the stack are described in Table 17-9. All other settings are related to the stack itself: see the documentation for the stack for a description of these settings.
The file is located on the file system of the host running the back-end part of the SS7 stack, in default installations this is in /opt/ss7/ss7_ITU/etc/ss7_itu.cnf
Must correspond to Attribute: InapBindTimeout given in Plugin_third_party_call_inap.
|
|
Must correspond to Attribute: LocalSpc given in Plugin_third_party_call_inap.
|
|
Must correspond to Attribute: LocalSsn given in Plugin_third_party_call_inap.
|
|
Must correspond to Attribute: RemoteSpc given in Plugin_third_party_call_inap.
|
|
Must correspond to Attribute: RemoteSsn given in Plugin_third_party_call_inap.
|
This section contains a description of the configuration attributes and operations available for the Parlay X 2.1 Third Party Call/SIP protocol translation module.
Parlay X 2.1 Third Party Call/SIP uses two parts for SIP connectivity, a part that executes a a network protocol plug-in instance in Network Gatekeeper container, and a part that executes as a SIP application in the SIP Server container.
Move on to the provisioning of service provider accounts and application accounts.
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.
Below is a list of attributes for configuration and maintenance:
Specifies whether charging is allowed. That is, if the charging parameter can be present in a request from an application.
Specifies the WebLogic SIP Server JNDI URL. This was configured when WebLogic SIP Server was installed.
WebLogic SIP Server naming service contains the host name (or IP address) and the port number identifying wlss.jndi.uri
.
Note: | This is not the same as the Network Gatekeeper naming service. |
Specifies the WebLogic SIP Server JNDI access username for the SIP application part of the SIP integration for ThirdParty Call. This is a regular WebLogic SIP Server user.
Specifies the password associated with Attribute: SIPNodeUsername.
Specifies the length of time to retain status information about the call after it has been terminated.