# SDK User Guide

# Using the Oracle Communications Services Gatekeeper SDK

The following sections describe how to use the Oracle Communications Services Gatekeeper SDK:

- Start the Oracle Communications Services Gatekeeper Simulator
- Add a new map
- Open a map
- Create user credentials for an application
- Remove a mobile phone/terminal
- Set the location of a mobile phone
- Send an MMS
- Open an MMS
- Send an SMS
- Open an SMS or PAP message
- Register an off-line notification for SMS
- Register an off-line notification for MMS

## Start the Oracle Communications Services Gatekeeper Simulator

To start the Oracle Communications Services Gatekeeper Simulator from the Windows Start Menu:

Choose Oracle Communications Services Gatekeeper SDK, and then Start Oracle Communications Services Gatekeeper SDK.

To start the Oracle Communications Services Gatekeeper Simulator from the command line, enter:

- $BEA_HOME`\wlserver_10.3\samples\domains\sdk\bin\startWebLogic` (Windows)
- $BEA_Home`/wlserver_10.3/samples/domains/sdk//bin/startWebLogic.sh` (UNIX)

where $BEA_HOME is the name of the directory in which you installed the Oracle Communications Services Gatekeeper SDK.

The Oracle Communications Services Gatekeeper SDK Simulator GUI is displayed.

The WebLogic Server Administration console can be used to configure the Oracle Communications Services Gatekeeper SDK simulator and runtime environment. Use a supported web browser to go to `http://<server>:<port>/console` where the `<server>` and port correspond to your Oracle Communications Services Gatekeeper installation. Default values are `localhost` and `7001`.

## Add a new map

Starting in the Oracle Communications Services Gatekeeper Simulator window:

1. In the Actions menu, choose Add Map...

This opens the Add Map dialogue box.

2. In the Map name field, enter a description of the map.
3. In the Map URL field, enter the URL to the map, or choose a map located on the file system by clicking Browse and selecting a file.

Supported map formats are GIF, JPEG, and BMP. The URL can be HTTP or File, for example http://some-map-hosting-company/london.jpg.

4. In the Upper left corner coordinates group:

In the Latitude field, enter the latitude of the upper left coordinate of the map. North of the equator is a positive value between 0 and 90. South of the equator is a value between 0 and -90.

In the Longitude field, enter the longitude of the upper left coordinate of the map. West of the Greenwich zero meridian is a negative value between 0 and -180. East of the Greenwich zero meridian is a positive value between 0 and 180.

5. In the Lower right corner coordinates group:

In the Latitude field, enter the latitude of the lower right coordinate of the map. North of the equator is a positive value between 0 and 90. South of the equator is a negative value between 0 and -90.

In the Longitude field, enter the longitude of the lower right coordinate of the map. West of the Greenwich zero meridian is a negative value between 0 and -180. East of the Greenwich zero meridian is a positive value between 0 and 180.

6. Click OK.

Now the map and its meta information is stored under the name <Map name>.map in the directory `$DOMAIN_HOME\servers\<Servername>\maps`. This file can be transferred to any other Oracle Communications Services Gatekeeper Simulator.

## Open a map

Starting in the Oracle Communications Services Gatekeeper Simulator window:

1. In the Actions menu, choose Open Map...

This opens the Open map dialogue box.

2. From the Map name drop down list, choose a map to display.

A preview of the map, together with data on the coordinates of the map, is displayed.

3. Click OK.

This opens the map in the simulator GUI. Repeat this procedure for every map you want to display.

## Create user credentials for an application

Starting in the Oracle Communications Services Gatekeeper Simulator window:

1. In the Actions menu, choose Create User...

This opens the Create User dialogue box.

2. In the Application Instance Id field, enter the user name the application should use when establishing a session (login). Must be unique.
3. In the Service Provider Id field, enter the service provider account ID for the application.
4. In the Application Id field, enter the application account ID for the application.
5. In the Password field, enter the password the application should use when establishing a session (login). The password must be at least 8 characters long.
6. Click OK.

The user credentials are now registered and applications can use these to login.

## Remove a mobile phone/terminal

Starting in the <Map name> window:

1. Right click on the telephone to be removed.
2. From the displayed menu, choose Remove.

The telephone is removed.

## Set the location of a mobile phone

Starting in the <Map name> window:

1. Click and hold the cursor on the telephone icon using the left mouse button.
2. Drag the telephone on the map.

The terminal's coordinates are displayed as it is moved.

## Send an MMS

This procedure is used for sending Multimedia Messages to an application. Sending messages from one terminal in the Gatekeeper to another is not supported.

Starting in the <Map name> window:

1. Right click on the icon of the telephone from which you wish to send the MMS.

A menu is displayed.

2. From the menu, choose Send multimedia message....

The Send multimedia message dialogue box is opened.

3. In the To field, enter the service number to which you wish to send the MMS.
4. Click Add content.

In the Message group, a row is opened for editing.

5. In the Type column, choose the type of content from the selection list.
6. In the URL column, enter the URL pointing to the content you wish to add to the message, or choose a file located on the file system by clicking Browse and selecting a file.
7. Repeat the above steps for each part of the MMS.
8. To remove any content, select the row containing the part and click Remove content
9. Click Send.

The MMS is sent.

## Open an MMS

When an MMS arrives at a phone, an envelope symbol appears beside the telephone icon. Follow the instructions below to open the MMS.

Starting in the <Map name> window:

1. Right click on the telephone that has received a new MMS.

A menu is displayed.

2. From the menu, choose Read multimedia message....

The Read multimedia message dialogue box is opened.

In the left pane, a reference to the new message is displayed. Select the message reference and the content of the MMS is displayed in the right pane.

## Send an SMS

This procedure is used for sending Short Messages to an application. Sending messages from one terminal in the Gatekeeper to another is not supported.

Starting in the <Map name> window:

1. Right click on the icon of the telephone from which you wish to send the SMS.

A menu is displayed.

2. From the menu, choose Send message....

The Send message dialogue box is opened.

3. In the To field, enter the service number to send the SMS to.
4. In the Message field, enter the text to send.
5. Click Send.

The SMS is sent.

## Open an SMS or PAP message

When an SMS or PAP message arrives at a phone, an envelope symbol appears beside the telephone. Follow the instructions below to open the SMS or PAP message.

Starting in the <Map name> window:

1. Right click on the telephone that has received a new SMS or PAP message.

A menu is displayed.

2. From the menu, choose Read message....

The Read message dialogue box is opened.

In the From field, the mailbox ID is displayed.

In the Message field, the message is displayed.

## Register an off-line notification for SMS

When sending Short Messages from a terminal in the Oracle Communications Services Gatekeeper Simulator, the message is sent to a service activation number. This registers an offline notification for applications that poll for mobile originated short messages. Mobile originating Short Messages sent to the service activation number that match a given criteria do not result in a notification callback to an application. Instead the message is stored in Oracle Communications Services Gatekeeper Simulator.

Starting in the Oracle Communications Services Gatekeeper Simulator window:

1. In the Actions menu, choose SMS Notifications...

This opens the SMS Notifications dialogue box.

2. Click Add Notification.
3. In the Activation Number field, enter the service activation number. In the Criteria field, enter a text to match against to determine if the application should receive the notification. This text is matched against the first word in the message. Leave empty to match all messages.
4. Click OK.

The notification is displayed with a registration identifier. The notification can be removed by selecting the notification and then clicking Remove Notification.

## Register an off-line notification for MMS

When sending Multimedia Messages from a terminal in the Oracle Communications Services Gatekeeper Simulator, the message is sent to a service activation number. This procedure registers an offline notification for applications that poll for mobile originated multimedia messages. Mobile originating Multimedia Messages sent to the service activation number do not result in a notification callback to an application. Instead the message is stored in Oracle Communications Services Gatekeeper Simulator.

Starting in the Oracle Communications Services Gatekeeper Simulator window:

1. In the Actions menu, choose Enable Received MMS...

This opens the Enable Receive MMS dialogue box.

2. In the Activation Number field, enter the service activation number.
3. Click OK.

The notification is displayed with a registration identifier. The notification can be removed by selecting the notification and then clicking Remove Notification.

## Define session lifetime

When an application establishes a session with Oracle Communications Services Gatekeeper, the session has a lifetime (session ticket lifetime).The default lifetime can be changed.

Starting in the Oracle Communications Services Gatekeeper Simulator window:

1. In the Actions menu, choose Session Lifetime...

This opens the Session Lifetime dialogue box.

2. Enter the default lifetime, given in minutes.
3. Click OK.