5 Managing Media Servers

This chapter describes how you can manage media servers supported by the runtime domains raised in Oracle Communications Evolved Communications Application Server (OCECAS).

About Media Servers

OCECAS does not deliver a media server. However, it organizes the media servers you install and configure and provide into groups. You set up the media resources by configuring the media server for your platform and configuring the announcement resources by specifying the correct paths to the resources.

OCECAS uses the JSR 309 Media Control Server API Standard to communicate with media resource servers. The JSR 309 specification is available from the Java Community Process website:

https://jcp.org/en/jsr/detail?id=309

How are Media and Server Resources Used

Media resources and the associated media server resources are used when call sessions support the use of media.

Service designers create the necessary announcements in the media format supported by the media server. You can store media files in the following formats:

  • .m4a

  • .mpg

  • .mp3

  • .wav

For more information, see "Working with Media Resources and Servers" in Evolved Communications Server Operator's Guide.

The announcement resources are grouped service data objects. For example, the music to play while the caller is on hold, or the announcement that tells the callee the session has ended could be stored under Play. These resources are associated with mediaserver_name /MediaServer/Production/VoLTE, where mediaserver_name is the name of the media server.

When included in a control flow, the Start Playing Media activity requires a service designer to specify the media server and the media resources to play. And if the service designer includes the Play Completed selection filter for the Wait for Event activity in the control flow, the software references the media server and the media resources specified for the Start Playing Media activity.

To support the use of the media resources, service designers configure various attributes such as the media server, the language and how long the resource must play. They can select to play the media at the initiating endpoint, destination endpoint, event source, or the conference endpoint. For example, selecting the initiating endpoint results in the announcement being played to the caller who started the session.

At runtime, the request sent to the media server is constructed from the selected endpoint, chosen language of the user, and the configuration of the selected media resource. The media file name specified for the user's language (locale) is sent in the request to the media server, which uses the file name to construct the announcement played to the user.

About the Supported Media Servers

OCECAS supports the use of the following JSR 309 compliant media servers:

  • Dialogic:

    Dialogic enables service providers and application developers to elevate the performance of media-rich communications across the most advanced networks.

  • Radisys:

    Radisys WebConnect is a software library that implements a JSR309 compliant interface and enables Java developers to provide real-time, multimedia processing capabilities for communication services. In the runtime environment, JSR-309 media processing requests are converted to IMS-based SIP and media server markup language commands.

If you plan to use Dialogic or Radisys media servers, configure the OCECAS to support the media server so that OCECAS can communicate with that server and play the required announcements to the parties in a call session.

Configuring OCECAS to Support Media Servers

To configure OCECAS to support your media servers, complete the following tasks for each of the runtime domains in your OCECAS installation:

  1. Install the appropriate JSR 309 software for your media server. See "Installing the JSR 309 Software for Media Servers".

  2. Customize the domain-wide server parameters to include the media server. See "Customizing the Media Server Parameters".

  3. Update the properties files used to set up configuration for JSR 309. See "Updating the JSR 309 Properties File for Runtime Domains".

  4. Deploy the Dialogic or Radisys SIP application to the engine tier cluster. See "Deploying the Driver Activator Application to the Engine Tier Cluster".

Installing the JSR 309 Software for Media Servers

Install one or both of the following software in each of the OCECAS runtime domains:

Note:

OCECAS supports these two media servers only.

Important:

Do not modify the setDomainEnv.sh script referred to by the media server installation instructions, even if the media server installation instructions asks you to do so.

Make changes to the setUserOverides.sh script as a customizing step. See "Customizing the Media Server Parameters" for more information.

Installing the Dialogic JSR 309 Connector Software

Install the Dialogic JSR 309 Connector software in each of the OCECAS runtime domains.

To install the Dialogic JSR 309 Connector software:

  1. Download the Dialogic Power Media XNMS JSR 309 Connector software onto your platform from the following location:

    http://www.dialogic.com.

  2. Install Dialogic XMS JSR 309 Connector software according to the instructions in the following user guide:

    http://www.dialogic.com/webhelp/XMS/2.4/XMS_JSR309InstallConfigOCCAS.pdf.

Installing the Radisys WebConnect JSR 309 Adapter Software

Install the Radisys Web Connect JSR 309 Adapter software in each of the OCECAS runtime domains.

Note:

A valid customer login is necessary to obtain and install this software.

To install the Radisys Web Connect JSR 309 Adapter software:

  1. Download the Radisys Web Connect JSR 309 Adapter software onto your platform from:

    http://www.radisys.com.

  2. Install Radisys Web Connect JSR 309 Adapter software. For more information, contact Radisys:

    http://www.radisys.com/support-portal

Customizing the Media Server Parameters

The bin directory for each runtime domain contains a file called setUserOverrides.sh that contains startup parameters that apply to all servers in the domain.

For each of the OCECAS runtime domains, modify the setUserOverrides.sh file to include the required media server.

To do so:

  1. Go to the following location:

    Ocecas_home/user_projects/domains/domain/bin

    where Ocecas_home is the directory in which the OCECAS software is installed. And domain is one of the following:

    • For the testing domain: scf_testing_domain

    • For the staging domain: scf_staging_domain

    • For the production domain: scf_production_domain

  2. Open the setUserOverrides.sh file in a text editor.

  3. Add the following statements.

    For:

    • Dialogic media server:

      #Dialogic additions
      DLG_PROPERTY_FILE="${DOMAIN_HOME}/config/dlgc_JSR309.properties"
      export DLG_PROPERTY_FILE
      echo "DLG_PROPERTY_FILE=${DLG_PROPERTY_FILE}"
      
    • Radisys media server:

      #Radisys additions
      RSYS_PROPERTY_FILE=${DOMAIN_HOME}/config/rsys-connector.properties
      export RSYS_PROPERTY_FILE
      echo "RSYS_PROPERTY_FILE=${RSYS_PROPERTY_FILE}"
      
  4. Save the file.

Updating the JSR 309 Properties File for Runtime Domains

For each of the OCECAS runtime domains, update the JSR 309 properties as appropriate. For:

Updating the JSR 309 Connector Properties Files for Dialogic Media Servers

The dlgc_JSR309.properties file stores the IP address and port of SipServlet container running the JSR 309 Connector, as well as the Dialogic Power Media XMS IP address and port.

Note:

You need to update the dlgc_JSR309.properties file for each of the runtime domains.

The dlgc_JSR309.properties file is located under the DlgcJSR309/properties folder of the JSR 309 Connector distribution package you downloaded.

To update the JSR 309 Connector properties for Dialogic media servers for a runtime domain:

  1. Go to the DlgcJSR309/properties folder at the location where you downloaded JSR 309 Connector distribution package. Locate the dlgc_JSR309.properties file.

  2. Copy dlgc_JSR309.properties and paste it in the following location:

    Ocecas_home/user_projects/domains/domain/config

    where Ocecas_home is the directory in which the OCECAS software is installed. And domain is one of the following:

    • For the testing domain: scf_testing_domain

    • For the staging domain: scf_staging_domain

    • For the production domain: scf_production_domain

  3. In the domain/config directory, open the dlgc_JSR309.properties file in a text editor.

  4. Set the connector's IP address. For example

    # Connector's address information 
    connector.sip.address=xxx.xxx.xxx.xxx
    connector.sip.port=5080
    

    where, xxx.xxx.xxx.xxx is the IP address of the OCECAS runtime domain which listens on the given port.

  5. Set the media server address. For example:

    #Media Server
    mediaserver.msType=XMS
    mediaserver.1.sip.address=xxx.xxx.xxx.xxx
    mediaserver.1.sip.port=5060
    

    where, xxx.xxx.xxx.xxx is the IP address of the media server.

  6. Save the dlgc_JSR309.properties file in the domain/config directory.

  7. Restart the managed servers in the OCECAS runtime domain.

Updating the WebConnect JAVA configuration File for Radisys Media Servers

The rsys-connector.properties WebConnect JAVA configuration file contains the Uniform Resource Identifier (URI) used in the From header in outgoing SIP requests, as well as the Radisys server IP address and port.

Note:

You need to update the rsys-connector.properties file for each of the runtime domains.

The rsys-connector.properties file is located in the config directory at the location where you downloaded the WebConnect JAVA software for Radisys media resource function.

To update the rsys-connector.properties WebConnect JAVA configuration file for Radisys media servers:

  1. Go to the config folder at the location where you downloaded the WebConnect JAVA software package. Locate the rsys-connector.properties file.

  2. Copy rsys-connector.properties file and paste it into the following location:

    Ocecas_home/user_projects/domains/domain/config

    where Ocecas_home is the directory in which the OCECAS software is installed. And domain is one of the following:

    • For the testing domain: scf_testing_domain

    • For the staging domain: scf_staging_domain

    • For the production domain: scf_production_domain

  3. In the domain/config directory, open the rsys-connector.properties file in a text editor.

  4. Set the FromURI value. For example:

    # URI of the WebConnect Java used in the SIP From Header
    FromURI=rsysconnector@xxx.xxx.xxx.xxx:5060
    

    where, xxx.xxx.xxx.xxx is Uniform Resource Identifier (URI) of the WebConnect JAVA used in the From header in outgoing SIP requests.

  5. Set the media server address. For example:

    #Media Server
    mediaserver.count=1
    mediaserver.1.sip.address=xxx.xxx.xxx.xxx
    mediaserver.1.sip.port=5060
    

    where, xxx.xxx.xxx.xxx is the local IP address for the OCECAS runtime domain.

    For information about the media server parameters of the rsys-connector.properties file, see the Installation and User Guide for WebConnect JAVA for Radisys Media Resource Function available at:

    http://www.radisys.com/support/get-support/media-server/

  6. Save the rsys-connector.properties file in the domain/config directory.

  7. Restart the engine1 server after installing the driver software.

Deploying the Driver Activator Application to the Engine Tier Cluster

You need to deploy the appropriate (Dialogic or Radisys) driver activator application in each of the runtime domains.

To deploy the appropriate driver activator application in a runtime domain:

  1. Access the Weblogic Administrator Console for the runtime domain.

  2. If you have not already done so, in the Change Center of the Administration Console, click Lock & Edit.

  3. In the left pane of the Administration Console, click Deployments.

  4. In the right pane, click Install.

  5. Select the correct path for the files:

    Ocecas_home/wlserver/csp/platform/applications,

    where Ocecas_home is where you installed OCECAS.

  6. Select the appropriate WAR file. For

    • Dialogic:

      The oracle.occas.csp.deployable.media.dialogic.war file.

    • Radisys:

      The oracle.occas.csp.deployable.media.radisys.war file.

  7. When you have selected the appropriate .war file, click Next.

  8. For the Choose Targeting Style option, select Install this deployment as an application.

    Click Next.

  9. For the Available targets for <selected driver activator> option, select BEA_ENGINE_TIER_CLUST.

    Click Next.

  10. Modify the optional settings as your require.

    Click Finish.

    For more information about deploying SIP applications, see the discussion on deploying a Web application at

    https://docs.oracle.com/middleware/1213/wls/WLACH/taskhelp/web_applications/DeployWebApplications.html

Managing and Troubleshooting Media Servers

If you encounter an issue with the following:

  • Media service announcements: Check the server console log. OCECAS places the driver output in this location

    Ocecas_home/user_projects/domains/domain/servers/logs/engine_name.log

    where:

    • Ocecas_home is the directory in which the OCECAS software is installed.

    • domain is scf_testing_domain, scf_staging_domain, or scf_production_domain, as appropriate.

    • engine_name is engine1 or engine2 as appropriate.

  • Media servers: Check the appropriate user guide for the media server.