SAP CC 1.0 - API Reference - July 2009

The SAP CC API Reference online documentation is intended for programmers that need to implement services provided by SAP Convergent Charging.

See:
Description

Packages

com.highdeal.admin.hci	Provides the administration JAVA / XML APIs.
com.highdeal.calendar.hci	Provides the JAVA / XML APIs related to calendar and specifically to public holidays.
com.highdeal.catalog.hci	Provides API for Price'n Rate cataloging feature.
com.highdeal.chrono.hci	Provides classes for managing chronology.
com.highdeal.cnd.message	Provides classes for managing application messages.
com.highdeal.currency	Provides classes for currency and money representation.
com.highdeal.filter.hci	Provides some common classes (filters and modification models) for supporting search and bulk modification APIs.
com.highdeal.guiding.common
com.highdeal.hci	Provides support for all JAVA / XML APIs.
com.highdeal.hci.http	Provides classes for calling API through HTTP.
com.highdeal.notification	Provides the Notification Framework.
com.highdeal.pnr.hci	Provides the Price'nRate JAVA / XML APIs.
com.highdeal.pnr.tif	Defines the Transaction Integration Framework (TIF).
com.highdeal.tax.hci	Provides Tax Framework JAVA / XML APIs.
com.highdeal.udr.hci	Provides data models for user defined records.

The SAP CC API Reference online documentation is intended for programmers that need to implement services provided by SAP Convergent Charging.

This overview is an introduction how to program with SAP CC. Some tutorials, examples and use cases are provided. It lists the SAP CC services to implement in your applications and presents the necessary APIs (data model, Java classes...).

The ways used to communicate with SAP CC Core Server are to send messages written in XML via the HTTP protocol for configuration (including provisioning) and to send messages (for rating and charging requests) via a TCP/IP protocol to speed up the exchanges.

Services of SAP Convergent Charging

According to your needs and to your architecture, SAP Convergent Charging can provide you with several services for your business.

SAP CC Services	Stateful	Stateless	SAP CC API	Communication Protocol
Provisioning Services	Offer catalog Subscriber account Subscription Access	Charge catalog	Java API, XML API	XML/HTTP
Global Rating and Charging Services	Guiding Rating and charging Prerating/postrating Activation Inverse rating Session-based rating Note: the batch rating service is provide by the BART component. Please consult the SAP CC BART API Reference.	Rating Prerating/postrating	Java API	TCP/IP
Administration Services	Shutdown process Monitoring process Configuration process Patch process		Java API, XML API	XML/HTTP

IMPORTANT NOTE: Before to implement one of these services provided by SAP CC, please consult carefully the Technical Reference Guide for details about the corresponding business processes. All the known limitations are explained to avoid any wrong implementation.

Implementations of the Services

There are 2 sets of APIs to communicate with the Core Server of SAP Convergent Charging. You can use the:

• Java APIs - message are constructed with Java and exchanged via HTTP or TCP according to the requested service of SAP CC.
• XML APIs - messages are exchanged via HTTP, your client application has to prepare the request and parse the responses.

Java APIs

The main Java classes are:

Service	Java Class
	Stateful	Stateless
Communication	com.highdeal.hci.MessageOperation
Provisioning	Business Model (mostly done via the GUIs): com.highdeal.pnr.hci.CreateProductOp com.highdeal.pnr.hci.CreateOfferOp com.highdeal.pnr.hci.CreateSubscriberAccountOp Commercial: com.highdeal.pnr.hci.CreateSubscriptionOp Technical: com.highdeal.pnr.hci.CreateAccessOp
		com.highdeal.pnr.hci.ChargeModel
Global Rating	com.highdeal.cnd.message.StatefulServiceClient
		com.highdeal.cnd.message.StatelessServiceClient
Administration	com.highdeal.admin.hci

XML APIs

It is possible to implement some services by using the SAP Convergent Charging XML APIs. This online document includes all the necessary XML fragments of the APIs (data models and operations). An XSD schema is also provided.

Tips:

• To have example in XML about a particular operation, you can set the Desktop Tool in verbose mode: the tool prints on the system console all the operations sent to the data updating instance and their results in XML. Please consult the Troubleshooting Guide.
• To have example in XML about a particular business object represented by a tree in the Desktop Tool (ex.: product, charge Component, Offer and subscription), use the copy/paste feature.
  For example if you need an XML example of a particular subscription, create the expected subscription in the Desktop Tool. Then select the subscription node and execute the action "Edit > Copy" (of the menu bar). This action copies the Subscription in XML in the system clipboard. Finally open a simple text editor or an XML editor and execute its paste action.

API Specification

Exceptions

Each API is specified in this online document. For each operation, the list of exceptions that can be thrown is provided:

• java.lang.Exception
• java.lang.RuntimeException
• com.highdeal.pnr.hci.StatelessContextSerializationException
• com.highdeal.pnr.tif.TransactionProcessorFailureException (implements java.io.Serializable)
• com.highdeal.hci.UnknownTagException

Main Data Models

Because the data models implement the interface com.highdeal.hci.XMLMarshallable, they defined themselves how to be serialized in or materialized from an XML format.

Provisioning: First Class Objects

Provisioning: Second Class Objects

Global Rating:

Administration:

Product	com.highdeal.pnr.hci.ProductModel
ChargeComponentModel	com.highdeal.pnr.hci.AccessModel
TranslationTable	com.highdeal.pnr.hci.TranslationTableModel
Offer	com.highdeal.pnr.hci.OfferModel
Subscription	com.highdeal.pnr.hci.SubscriptionModel
Access	com.highdeal.pnr.hci.AccessModel
ChargeableItemDescription (product)	com.highdeal.pnr.hci.ChargeableItemDescriptionModel
ChargeCondition (offer)	com.highdeal.pnr.hci.ChargeConditionModel
OfferCondition (offer)	com.highdeal.pnr.hci.OfferConditionModel
ChargeActivation (subscription)	com.highdeal.pnr.hci.ChargeActivationModel
Parameter (offer)	com.highdeal.pnr.hci.ParameterModel
CounterDescriptionModel (offer)	com.highdeal.pnr.hci.CounterDescriptionModel
Note: To work with a second class object, it is necessary to use its corresponding first class object that has creation, modification, research and deletion APIs.
n/a	n/a
AdminParameterModel	com.highdeal.admin.hci.AdminParameterModel
InstanceMap	ccom.highdeal.admin.hci.InstanceMap
StatusModel	com.highdeal.admin.hci.StatusModel

Warnings

Deprecated APIs

Please consult the list of deprecated classes, methods and other items.

Limitations

The known limitations are described in this documentation and in the Technical Reference Guide and in all the product documents regarding to the type of users.

Search APIs

The Search APIs are not designed to be used to implement reporting features. They easily can initiate a large amount of data manipulations that can dramatically decrease the performance of the SAP Convergent Charging core servers or can cause system crashes due to memory leak: the memory management is very sensible with Java 1.5.

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see:

• SAP CC Technical Reference Guide
• SAP CC BART API Reference
• SAP CC Database Structure Reference

Other related documents can help you:

• SAP CC Administration and Maintenance Guide (Operations)
• SAP CC Parameter Reference
• SAP CC Concept Guide

Copyrights and Disclaimer

(c) Copyright 2009 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.

All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

Disclaimer

Some components of this product are based on Java. Any code change in these components may cause unpredictable and severe malfunctions and is therefore expressively prohibited, as is any decompilation of these components.

See Also:

com.highdeal.hci.MessageOperation, ProductModel, OfferModel, SubscriberAccountModel, SubscriptionModel, AccessModel, StatefulServiceClient, StatelessServiceClient, com.highdeal.admin.hci