# System Administrator’s Guide

# Managing and configuring Shortcode mappings

The following section describes how to configure shortcode mappings for incoming messages to Oracle Communications Services Gatekeeper.

- Configuration and Management
- Reference: Attributes and Operations for ShortCodeMapper

## Introduction

The Shortcode Mapper is shared between the following plug-ins:

- Parlay X 2.1 Short Messaging/SMPP
- Parlay X 2.1 Multimedia Messaging/MM7

The Shortcode mapper maps network-triggered messages (mobile originated) with a given destination address, the original destination address, to another destination address, the translated destination address.

The original destination address can be expressed as a pattern, that is, a regular expression, which means that a range, or set, of original destination addresses can be translated to one single translated destination address.

This is useful when having applications that are triggered by a range of phone numbers, for example, a range of phone numbers like 2345600 through 2345699.Using the functionality available in the Parlay X 2.1 Short Messaging interface the application would have to call `startSmsNotification` 100 times, while setting up a short code translation mapping where the original destination addresses are expressed as 23456?? and the translated destination address is set to 1234 means that only a single call to `startSmsNotification` using the address 1234 is required.

## Configuration and Management

All configuration and management is performed in the managed object ShortCodeMapper.

The ShortCodeMapper OAM functionality is shared between the plug-ins: they reuse the same MBean. Rendering however is per plug-in (one instance is displayed per plug-in). It appears slightly differently depending how to the MBean is accessed:

- Using the Administration Console, one instance of the MBean is displayed in connection with the plug-in it is used by, so the management attributes for the ShortCodeMapper module are reached from the service:

- Plugin_px21_multimedia_messaging_mm7-ShortCodeMapper
- Plugin_px21_short_messaging_smppShortCodeMapper

- In an MBean browser, such as JConsole, one instance of the MBean is displayed using the the same ObjectName (at the same hierarchical level) as the plug-in it is used by.

Note: | You need to configure ShortCodeMapper attributes for all of the above mentioned plug-ins that are going to use this functionary. Only the attributes for the related plug-in are displayed in the OAM.

### Management operations

Management of shortcodes includes:

Operation: addShortCodeMapping

Operation: listShortCodeMappings

Operation: removeShortCodeMapping

## Reference: Attributes and Operations for ShortCodeMapper

Managed object: ShortCodeMapper

MBean: com.bea.wlcp.wlng.shortcode.management.ShortCodeMapperMBean

Below is a list of operations for configuration:

- Operation: addShortCodeMapping
- Operation: listShortCodeMappings
- Operation: removeShortCodeMapping

### Operation: addShortCodeMapping

Scope: Cluster

Translates the destination address of a network-triggered message to a translated destination address. The translated destination address is used when matching the message with notification registrations. This makes it possible for an application to register for a notification from a single shortcode and receive messages sent to a range of short codes (original destination addresses).

Note: | Short code translation takes place before mapping a mobile originated message to registered application notifications. If two or more short code translations match an original destination number the best match, the most specific, is chosen.

An identifier for the short code translation is returned.

Signature:

    addShortCodeMapping(orig_dest_pattern: String, trans_dest_addr: String)

Table 35-1 addShortCodeMapping
addShortCodeMapping
Parameter | Description
--- | ---
orig_dest_pattern | Pattern that is matched against the original destination address as of a message received from the network. The pattern should be specified as a regular expression: ^6
trans_dest_addr | The resulting translated address. Addresses must be specified with the prefix “tel:”.

### Operation: listShortCodeMappings

Scope: Cluster

Displays a list of shortcode mappings.

Signature:

    listShortCodeMappings()

Table 35-2 listShortCodeMappings
listShortCodeMappings
Parameter | Description
--- | ---
- | -

### Operation: removeShortCodeMapping

Scope: Cluster

Removes a previously added shortcode mapping. Both fields must match.

Signature:

    removeShortCodeMapping(OriginalDestination: String, MappedDestination: String)

Table 35-3 removeShortCodeMapping
removeShortCodeMapping
Parameter | Description
--- | ---
OriginalDestination | Registered original destination pattern.
MappedDestination | Registered translated destination address.