# Platform Development Studio - Developer’s Guide

# Document Roadmap

The following sections describe the audience for, and organization of, this document:

- Document Scope and Audience
- Guide to This Document
- Terminology
- Related Documentation

## Document Scope and Audience

This document describes the Oracle Communications Services Gatekeeper Platform Development Studio, a framework for creating and testing new extension Communication Services. The intended audience of this document consists of system integrators and field engineers who need to extend the out-of-the-box functionality of Oracle Communications Services Gatekeeper.

## Guide to This Document

The document contains the following chapters:

Document Roadmap: This chapter

Overview of the Platform Development Studio: A high level description of the capabilities of the PDS

Using the Eclipse Wizard: Setting up the Eclipse Wizard to generate extension projects

Description of a Generated Project: The elements of a generated Communication Service project.

Communication Service Example: A description of the example Communication Service provided with the Platform Development Studio.

Service Enabler Example with SIP plug-in: A description of a Service Facade that uses the SIP Servlet Container.

Container Services: Accessing Oracle Communications Services Gatekeeper’s Core functionality

Communication Service Description: A component by component description of a Communication Service

Annotations, EDRs, Alarms, and CDRs: Creating EDRs, CDRs, and Alarms

Making Communication Services Manageable: Rendering extension Communication Services manageable by the Oracle Communications Services Gatekeeper Administration Console or other management tools

Service Interceptors: An overview of service interceptors, a description of the standard out of the box ones, and of developing custom versions

Custom Service Level Agreements: An overview of custom SLAs and a description of developing custom SLA enforcement logic

Subscriber-centric Policy: Creating a policy mechanism based on individual subscriber preferences and permissions

Creating an EDR Listener and Generating SNMP MIBs: Using and integrating external EDR listeners and generating SNMP MIBs

Converting Traffic Paths and Plug-ins to Communication Services: Converting extensions built on previous versions of Oracle Communications Services Gatekeeper

Policy: Using and extending Policy mechanisms in Communication Services

Callable Policy Web Service: Integrating using the Callable Policy Web Service

Checklist: A checklist for creating extensions.

## Terminology

The following terms and acronyms are used in this document:

- Account—A registered application or service provider. An account belongs to an account group, which is tied to a common SLA
- Account group—Multiple registered service providers or services which share a common SLA
- Administrative User—Someone who has privileges on the Oracle Communications Services Gatekeeper management tool. This person has an administrative user name and password
- Alarm—The result of an unexpected event in the system, often requiring corrective action
- API—Application Programming Interface
- Application—A TCP/IP based, telecom-enabled program accessed from either a telephony terminal or a computer
- Application-facing Interface—The Application Services Provider facing interface
- Application Service Provider—An organization offering application services to end users through a telephony network
- AS—Application Server
- Application Instance—An Application Service Provider from the perspective of internal Oracle Communications Services Gatekeeper administration. An Application Instance has a user name and password
- CBC—Content Based Charging
- End User—The ultimate consumer of the services that an application provides. An end user can be the same as the network subscriber, as in the case of a prepaid service or they can be a non-subscriber, as in the case of an automated mail-ordering application where the subscriber is the mail-order company and the end user is a customer to this company
- Enterprise Operator —See Service Provider
- Event—A trackable, expected occurrence in the system, of interest to the operator
- HA —High Availability
- HTML—Hypertext Markup Language
- IP—Internet Protocol
- JDBC—Java Database Connectivity, the Java API for database access
- Location Uncertainty Shape—A geometric shape surrounding a base point specified in terms of latitude and longitude. It is used in terminal location
- MAP—Mobile Application Part
- Mated Pair—Two physically distributed installations of Oracle Communications Services Gatekeeper nodes sharing a subset of data allowing for high availability between the nodes
- MM7—A multimedia messaging protocol specified by 3GPP
- MPP—Mobile Positioning Protocol
- Network Plug-in—The Oracle Communications Services Gatekeeper module that implements the interface to a network node or OSA/Parlay SCS through a specific protocol
- NS—Network Simulator
- OAM —Operation, Administration, and Maintenance
- Operator—The party that manages the Oracle Communications Services Gatekeeper. Usually the network operator
- OSA—Open Service Access
- PAP—Push Access Protocol
- Plug-in—See Network Plug-in
- Plug-in Manager—The Oracle Communications Services Gatekeeper module charged with routing an application-initiated request to the appropriate network plug-in
- Policy Engine—The Oracle Communications Services Gatekeeper module charged with evaluating whether a particular request is acceptable under the rules
- Quotas—Access rule based on an aggregated number of invocations. See also Rates
- Rates—Access rule based on allowable invocations per time period. See also Quotas
- Rules—The customizable set of criteria - based on SLAs and operator-desired additions - according to which requests are evaluated
- SCF—Service Capability Function or Service Control Function, in the OSA/Parlay sense.
- SCS—Service Capability Server, in the OSA/Parlay sense. Oracle Communications Services Gatekeeper can interact with these on its network-facing interface
- Service Capability—Support for a specific kind of traffic within Oracle Communications Services Gatekeeper. Defined in terms of Communication Services
- Service Provider—See Application Service Provider
- SIP—Session Initiation Protocol
- SLA—Service Level Agreement
- SMPP—Short Message Peer-to-Peer Protocol
- SMS—Short Message Service
- SMSC—Short Message Service Centre
- SNMP—Simple Network Management Protocol
- SOAP—Simple Object Access Protocol
- SPA—Service Provider APIs
- SS7—Signalling System 7
- Subscriber—A person or organization that signs up for access to an application. The subscriber is charged for the application service usage. See End User
- SQL—Structured Query Language
- TCP—Transmission Control Protocol
- Communication Service—offers a service to an application
- USSD—Unstructured Supplementary Service Data
- VAS—Value Added Service
- VLAN—Virtual Local Area Network
- VPN—Virtual Private Network
- Oracle Communications Services Gatekeeper Container—The container hosting communication services.
- WSDL —Web Services Definition Language
- XML—Extended Markup Language

## Related Documentation

This developer’s guide is part of a set of documentation for Oracle Communications Services Gatekeeper itself. These documents include:

- System Administrator’s Guide
- Concepts and Architectural Overview
- Integration Guidelines for Partner Relationship Management
- SDK User Guide
- Managing Accounts and SLAs
- Statement of Compliance and Protocol Mapping
- Application Development Guide
- Communications Service Reference
- Handling Alarms
- Licensing
- Installation Guide
- RESTful Application Development Guide