# System Administrator’s Guide

# Managing and Configuring Multimedia Messaging Communication Services

The following section describes configuration and maintenance attributes and operations for the communication services that expose Parlay X 2.1 Multimedia Messaging Web Services interfaces. The sections also provide a workflow for the configuration:

- Parlay X 2.1 MultiMedia Messaging/MM7

- Properties for Parlay X 2.1 MultiMedia Messaging/MM7
- Configuration Workflow for Parlay X 2.1 MultiMedia Messaging/MM7
- Provisioning Workflow for Parlay X 2.1 MultiMedia Messaging/MM7
- Reference: Attributes and Operations for Parlay X 2.1 MultiMedia Messaging/MM7

## Parlay X 2.1 MultiMedia Messaging/MM7

This section contains a description of the configuration attributes and operations available for Parlay X 2.1 MultiMedia Messaging/MM7 network protocol plug-in instances.

To see a | Refer to
--- | ---
Detailed list of necessary for managing and configuring a plug-in instance | Properties for Parlay X 2.1 MultiMedia Messaging/MM7
Configuration workflow | Configuration Workflow for Parlay X 2.1 MultiMedia Messaging/MM7
List of operations and attributes related to management and provisioning | Provisioning Workflow for Parlay X 2.1 MultiMedia Messaging/MM7
Reference of management attributes and operations | Reference: Attributes and Operations for Parlay X 2.1 MultiMedia Messaging/MM7

### Properties for Parlay X 2.1 MultiMedia Messaging/MM7

Property | Description
--- | ---
Managed object in Administration Console | <domain name>OCSG<server name>Communication Services<plug-in instance ID>
MBean | Domain=com.bea.wlcp.wlng Name=wlng_nt InstanceName is same as plug-in instance ID Type=om.bea.wlcp.wlng.plugin.multimediamessaging.mm7.management.MessagingManagementMBean
Network protocol plug-in service ID | Plugin_px21_multimedia_messaging_mm7
Network protocol plug-in instance ID | The ID is given when the plug-in instance is created, see Managing and Configuring the Plug-in Manager.
Supported Address Scheme | tel mailto short
North interfaces | com.bea.wlcp.wlng.px21.plugin.MessageNotificationManagerPlugin com.bea.wlcp.wlng.px21.plugin.ReceiveMessagePlugin com.bea.wlcp.wlng.px21.plugin.SendMessagePlugin com.bea.wlcp.wlng.px21.callback.MessageNotificationCallback
Service type | MultimediaMessaging
Exposes to the service communication layer a Java representation of: | Parlay X 3.0 Part 5: Multimedia Messaging
Interfaces with the network nodes using: | MM7
Deployment artifacts NT EAR wlng_nt_multimedia_messaging_px21.ear | Plugin_px21_multimedia_messaging_mm7.jar, px21_multimedia_messaging_service.jar, multimedia_messaging_mm7_rel5mm712.war, and multimedia_messaging_mm7_rel5mm715.war
AT EAR: Normal wlng_at_multimedia_messaging_px21.ear | px21_multimedia_messaging_callback.jar, px21_multimedia_messaging.war, and rest_multimedia_messaging.war
AT EAR: SOAP Only wlng_at_multimedia_messaging_px21_soap.ear | px21_multimedia_messaging_callback.jar and px21_multimedia_messaging.war

### Configuration Workflow for Parlay X 2.1 MultiMedia Messaging/MM7

Below is an outline for configuring the plug-in using the Oracle Communications Services Gatekeeper Management Console:

1. Create one or more instances of the plug-in service: see Managing and Configuring the Plug-in Manager. Use the plug-in service ID as detailed in Properties for Parlay X 2.1 MultiMedia Messaging/MM7.
2. Using the Management Console or an MBean browser, select the MBean for the plug-in instance. The MBean display name is the same as the plug-in instance ID given when the plug-in instance was created.
3. Configure the behavior of the plug-in instance:

- Attribute: HTTPBasicAuthentication: if using HTTP basic authentication also define:

- Attribute: HTTPBasicAuthenticationUsername
- Attribute: HTTPBasicAuthenticationPassword

- Attribute: DefaultPriority
- Attribute: MM7Version
- Attribute: Mm7relayserverAddress
- Attribute: VaspId
- Attribute: VasId
- Attribute: RequestDeliveryReportFlag
- Attribute: XSDVersion

4. Specify heartbeat behavior, see Configuring Heartbeats.
5. Set up the routing rules to the plug-in instance: see Configuring the Plug-in Manager. Use the plug-in instance ID and address schemes detailed in Properties for Parlay X 2.1 MultiMedia Messaging/MM7.
6. Provide the administrator of the MM7 server with the URL to which the MM7 server should deliver mobile-originated messages and delivery reports. The default URL is
   `http://<IP Address of NT server>:<port>/<server>:<port>/<context-root>/<Plug-in instance ID>`

If using the REL-5-MM7-1-2 XSD, default `<context-root>` is `mmm-mm7`

If using the REL-5-MM7-1-5 XSD,`<context-root>` is `mmm-mm7-rel5mm7-1-5`

7. If desired, create and load a node SLA, see:

Defining Global Node and Service Provider Group Node SLAs

Managing Application SLAs

Continue with the provisioning of service provider accounts and application accounts.

### Provisioning Workflow for Parlay X 2.1 MultiMedia Messaging/MM7

1. To register offline notifications, that is, to specify that mobile originated messages should not result in notifications to an application, but instead be stored in Oracle Communications Services Gatekeeper for polling, use Operation: enableReceiveMms. Use the following operations to manage the offline registrations:

- Operation: listOfflineNotificationInfo
- Operation: getOfflineNotificationInfo
- Operation: removeOfflineNotificationInfo

2. To register online notifications, that is, to manage registrations for mobile originated messages on behalf of an application, use: Operation: startMessageNotification. Use the following operations to manage the online registrations:

- Operation: listOnlineNotificationInfo
- Operation: getOnlineNotificationInfo
- Operation: removeOnlineNotificationInfo

### Reference: Attributes and Operations for Parlay X 2.1 MultiMedia Messaging/MM7

Managed object: Communication Services-><plug-in instance ID>

MBean: com.bea.wlcp.wlng.plugin.multimediamessaging.mm7.management.MessagingManagementMBean

Below is a list of attributes and operations for configuration and maintenance:

- Attribute: HTTPBasicAuthentication
- Attribute: HTTPBasicAuthenticationUsername
- Attribute: HTTPBasicAuthenticationPassword
- Attribute: DefaultPriority
- Attribute: Mm7relayserverAddress
- Attribute: MM7Version
- Attribute: RequestDeliveryReportFlag
- Attribute: VaspId
- Attribute: VasId
- Attribute: XSDVersion
- Operation: enableReceiveMms
- Operation: getOfflineNotificationInfo
- Operation: getOnlineNotificationInfo
- Operation: listOfflineNotificationInfo
- Operation: listOnlineNotificationInfo
- Operation: removeOfflineNotificationInfo
- Operation: removeOnlineNotificationInfo
- Operation: startMessageNotification

### Attribute: HTTPBasicAuthentication

Scope: Cluster

Unit: n/a

Format: Boolean

Specifies if HTTP basic authentication shall be used for authentication with the MM7 server.

Set to `true` if HTTP basic authentication shall be used, otherwise `false`.

If `true`, Attribute: HTTPBasicAuthenticationUsername and Attribute: HTTPBasicAuthenticationPassword must be specified.

### Attribute: HTTPBasicAuthenticationUsername

Scope: Cluster

Unit: n/a

Format: String

The username to use for HTTP basic authentication towards the MM7 server.

### Attribute: HTTPBasicAuthenticationPassword

Scope: Cluster

Unit: n/a

Format: String

The password to use for HTTP basic authentication towards the MM7 server.

### Attribute: DefaultPriority

Scope: Cluster

Unit: n/a

Format: String

Specifies the default priority for sent MMSes. Enter one the following:

- normal
- high
- low

### Attribute: MM7Version

Scope: Cluster

Unit: n/a

Format: String

Specifies the version of the MM7 protocol to be used. Applicable versions are:

- 5.3.0

### Attribute: Mm7relayserverAddress

Scope: Cluster

Unit: n/a

Format: String

Specifies the address to the MM7 Relay Server. The address is an HTTP URL.

### Attribute: VaspId

Scope: Cluster

Unit: n/a

Format: String

Specifies the VASP (Value Added Service Provider) ID to be used for the plug-in instance when connecting to the MMSC.

### Attribute: VasId

Scope: Cluster

Unit: n/a

Format: String

Specifies the VAS (Value Added Service) ID to be used for the plug-in instance when connecting to the MMSC.

### Attribute: RequestDeliveryReportFlag

Scope: Cluster

Unit: n/a

Format: Integer

Specifies how the plug-in instance requests and handles delivery reports for sent messages. Enter one of the following:

- 0: Delivery notifications are not processed, which means that no polling functionality is available to the applications using the communication service.
- 1: Delivery notifications are processed if the application provided a receiptRequest in the SendMessage requests or the application provided a tunnelled parameter with ID `com.bea.wlcp.wlng.plugin.multimediamessaging.RequestDeliveryReportFlag` with the value `true` in the SOAP header of the SendMessage request.
- 2: Delivery notifications are always processed.

### Attribute: XSDVersion

Scope: Server

Unit: n/a

Format: String [REL-5-MM7-1-0, REL-5-MM7-1-2, REL-5-MM7-1-5]

The MM7 xsd version that should be used for requests towards the MMSC.

Enter one of the following:

- REL-5-MM7-1-0 to use an altered version of the REL-5-MM7-1-0.xsd. The altered version allows use of delivery notifications when the MMC-S requires this version of the xsd. This is a requirement when connecting to, among others, Comverse MMSCs.
- REL-5-MM7-1-2, to use REL-5-MM7-1-2.xsd.
- REL-5-MM7-1-5, to use REL-5-MM7-1-5.xsd

### Operation: enableReceiveMms

Scope: Cluster

Adds an offline notification for applications that will poll for mobile originated messages. Mobile originated messages matching this notification will not result in a callback to an application. Instead the application has to use the correlator returned by this method and poll for new messages.

Returns the correlator uniquely identifying the new notification.

Signature:

    enableReceiveMms(shortcode: String, critieria: String, appInstanceID: String)

Table 24-1 enableReceiveMms
enableReceiveMms |
--- | ---
Parameter | Description
shortcode | The destination address or service activation number of the Multmedia message. Prefixed with the URI, for example `tel:`
critieria | The first word in the text in the subject field of the MMS to match. Exact matches only.
appInstanceID | The application instance ID associated with the notification.

### Operation: getOfflineNotificationInfo

Scope: Cluster

Displays information about a notification registered offline, see Operation: enableReceiveMms.

Signature:

    getOfflineNotificationInfo(correlator: String)

Table 24-2 getOfflineNotificationInfo
getOfflineNotificationInfo |
--- | ---
Parameter | Description
correlator | Correlator identifying the notification.

### Operation: getOnlineNotificationInfo

Scope: Cluster

Displays information about a notification registered by an application or via Operation: startMessageNotification.

Signature:

    getOnlineNotificationInfo(correlator: String)

Table 24-3 getOfflineNotificationInfo
getOfflineNotificationInfo |
--- | ---
Parameter | Description
correlator | Correlator identifying the notification.

### Operation: listOfflineNotificationInfo

Scope: Cluster

Displays a list of all notifications registered offline using Operation: enableReceiveMms.

Signature:

    listOfflineNotificationInfo()

Table 24-4 listOfflineNotificationInfo
listOfflineNotificationInfo |
--- | ---
Parameter | Description
- | -

### Operation: listOnlineNotificationInfo

Scope: Cluster

Displays a list of all notifications registered online by the application, or via Operation: startMessageNotification

Signature:

    listOnlineNotificationInfo()

Table 24-5 listOnlineNotificationInfo
listOnlineNotificationInfo |
--- | ---
Parameter | Description
- | -

### Operation: removeOfflineNotificationInfo

Scope: Cluster

Removes a notification registered offline using Operation: enableReceiveMms.

Signature:

    removeOfflineNotificationInfo(Registration Identifier: String)

Table 24-6 removeOfflineNotificationInfo
removeOfflineNotificationInfo |
--- | ---
Parameter | Description
Registration Identifier | ID of the notification.

### Operation: removeOnlineNotificationInfo

Scope: Cluster

Removes a notification registered by an application or on behalf of an application via Operation: startMessageNotification.

Signature:

    removeOnlineNotificationInfo(Registration Identifier: String)

Table 24-7 removeOnlineNotificationInfo
removeOnlineNotificationInfo |
--- | ---
Parameter | Description
Correlator | ID of the notification.

### Operation: startMessageNotification

Scope: Cluster

Creates an online notification on behalf of an application. Produces the same results as if an application registered for notifications using the method`startMessageNotification` in Parlay X 2.1 Multimedia Messaging interface MessageNotificationManager.

This operation can be used, for example, if the application is not allowed to register for notifications by restrictions defined in its SLA. Returns a correlator that uniquely identifies the notification.

Signature:

    startMessageNotification(endpoint: String, shortcode: String, critieria: String, appInstanceID: String)

Table 24-8 startMessageNotification
startMessageNotification |
--- | ---
Parameter | Description
endpoint | Notification endpoint implemented by the application. This endpoint implements the Parlay X 2.1 Multimedia Messaging interface MessageNotification. Format: URL.
shortcode | Destination address for the MMS. Must have the suffix “tel:”, for example tel:1234
criteria | The first word in the text in the subject field of the MMS to match. Exact matches only.
appInstanceID | ID of application instance for the application.