# Integration Guidelines for Partner Relationship Management

# About This Document

This document describes the Oracle Communications Service Gatekeeper’s Partner Relationship Management module, including a detailed description of the Partner Relationship Management interfaces exposed for integrating Oracle Communications Services Gatekeeper service provider account management with operator PRM systems, both internal and customer-facing.

This document covers the following topics:

- About This Document This chapter.
- Introduction An overview of the Partner Relationship Management system, including a deployment example.
- The Partner Management Model The Partner Relationship Management model.
- The Interfaces An overview of the PRM interfaces.
- Common PRM Use Scenarios Common use case scenarios and workflows.
- Service Provider Login A detailed description of the Service Provider Login Web Service.
- Service Provider Service A detailed description of the Service Provider Service Web Service.
- Service Provider CDR Utility A detailed description of the Service Provider CDR Utility Web Service.
- Service Provider Statistics Utility A detailed description of the Service Provider Statistics Web Service.
- Operator Login A detailed description of the Operator Login Web Service.
- Operator Service A detailed description of the Operator Service Web Service.
- Operator CDR Utility A detailed description of the Operator CDR Utility Service.
- Operator Statistics Utility A detailed description of the Operator Statistics Utility Service.
- Operator Alarm Utility A detailed description of the Operator Alarm Utility Web Service.

This document is intended mainly for application developers who are interested in building CRM/PRM applications to manage Service Providers and Applications that are or will be using the traffic interfaces exposed by the Oracle Communications Services Gatekeeper. It assumes a familiarity with Oracle Communications Services Gatekeeper.

You can print a copy of this document from a Web browser, one file at a time, by using the FilePrint option on your Web browser.

A PDF version of this document is available on the WebLogic Network Gatekeeper documentation Home page on the e-docs Web site (and also on the documentation CD). You can open the PDF in Adobe Acrobat Reader and print the entire document (or a portion of it) in book format. To access the PDFs, open the WebLogic Network Gatekeeper documentation Home page, click the PDF files button and select the document you want to print.

If you do not have the Adobe Acrobat Reader, you can get it for free from the Adobe Web site at http://www.adobe.com/.

The following Oracle Communications Services Gatekeeper documents contain information that is relevant to using the Partner Relationship Management interfaces:

- System Administrator’s Guide
- Concepts and Architectural Overview
- Installation Guide
- SDK User Guide
- Managing Accounts and SLAs
- Statement of Compliance and Protocol Mapping
- Application Development Guide
- Communications Service Reference
- Handling Alarms
- Licensing
- Platform Development Studio - Developer’s Guide

The following documentation conventions are used throughout this document.

Convention | Item
--- | ---
boldface text | Indicates terms defined in the glossary.
Ctrl+Tab | Indicates that you must press two or more keys simultaneously.
italics | Indicates emphasis or book titles.
`monospace text` | Indicates code samples, commands and their options, data structures and their members, data types, directories, and file names and their extensions. Monospace text also indicates text that you must enter from the keyboard. Examples: `#include <iostream.h> void main ( ) the pointer psz` `chmod u+w *` `\tux\data\ap` `.doc` `tux.doc` `BITMAP` `float`
`monospace boldface text` | Identifies significant words in code. Example: `void` `commit``( )`
`monospace italic text` | Identifies variables in code. Example: `String` `expire`
UPPERCASE TEXT | Indicates device names, environment variables, and logical operators. Examples: LPT1 SIGNON OR
`{ }` | Indicates a set of choices in a syntax line. The braces themselves should never be typed.
`[ ]` | Indicates optional items in a syntax line. The brackets themselves should never be typed. Example: `buildobjclient [-v] [-o name ] [-f` `file-list``]... [-l` `file-list``]...`
`|` | Separates mutually exclusive choices in a syntax line. The symbol itself should never be typed.
`...` | Indicates one of the following in a command line: That an argument can be repeated several times in a command line That the statement omits additional optional arguments That you can enter additional parameters, values, or other information The ellipsis itself should never be typed. Example: `buildobjclient [-v] [-o name ] [-f` `file-list``]... [-l` `file-list``]...`
`. . .` | Indicates the omission of items from a code example or from a syntax line. The vertical ellipsis itself should never be typed.