See: Description
| Package | Description |
|---|---|
| com.highdeal.bart.admin.hci | |
| com.highdeal.bart.event | |
| com.highdeal.bart.hci |
This
Java package provides you with the Java APIs necessary for the implementation of business services that
require the HTTP Communication Interface (HCI) technical interface of SAP Convergent Charging. |
| com.highdeal.bart.iec | |
| com.highdeal.bart.iec.hci | |
| com.highdeal.bart.message |
This
Java package provides you with the Java APIs necessary for the implementation of business services that require communications via the Message TCP technical interface. |
| com.highdeal.hci |
The SAP CC 5.0 Java/XML API Reference (BART Library) documentation is intended for programmers that need to implement offline acquisition and charging services provided by BART (Batch Acquisition and Rating and Toolset), a software component of SAP Convergent Charging (SAP CC) software product. The necessary Java libraries are included in a Software Development Kit (BART SDK).
Caution
Make sure you have the latest version of this documentation extracted from the SDK.
This document includes the specifications of the following API sets:
Important Note
Consider the following Java packages for more information about the development of your Java-based client application:
SAP Convergent Charging provides you with the following technical interfaces to communicate with the SAP CC BART Server system:
| Technical Interface of SAP CC | Description | SAP CC API Technology | Communication Protocol | Public Access Point to the SAP CC System |
|---|---|---|---|---|
| Message TCP | Offline CDR Acquisition | Java API | TCP/IP (High speed interface) | Instance of the SAP CC BART Server system (Default port: 2009) |
| HTTP Communication Interface (HCI) | Offline acquisition of CDRs, CDR management, offline charging session management | Java API, XML API
Note Consult the SAP CC Java/XML API Reference (Core Library) for more information about HCI communication and message handling. |
XML/HTTPS, XML/HTTP | Instance of the SAP CC BART Server system (Default port: 9009) |
Notes
SAP CC BART Server handles CDRs as primary objects through 3 major processes:
Note
During the acquisition process and the charging process, the CDRs are stored in the BART Database. The consolidation process is mandatory to batch charge CDRs.
Recommendation
Consult carefully the Application Help documentation about the business processes before you implement one of the business services provided by SAP CC BART. All the known limitations are explained to avoid any wrong implementation.
During the planning and preparation steps of the implementation phase of your project, you will have to:
Important Note
Before implementing one of these functional service(s) provided by SAP CC BART, consult carefully the Application Help documentation for details about the corresponding business processes. All the known limitations are explained to avoid any wrong implementation. Check all the prerequisites. Take into account all the constraints that are relevant for your business. Size your landscape according to your business requirements and rules provided for SAP Convergent Charging.
SAP CC BART manages mass data information related to the usage of a customer service (service consumption). The SAP CC BART system converts the Consumption Detail Records into Chargeable Items and triggers their batch charging.
Consult first the CDR data model. You must implement the conversion of your consumption data collected from network equipments to this format handled by BART Server.
To take into account the possible errors you need to develop the management of the Java exceptions thrown by the distant SAP CC BART Server system or by the Java libraries of SAP CC BART related to this Javadoc. Each exception is precised with a reason message or a reason code for more information.
The complete list of exceptions that can be thrown is detailed in this documentation.
An XML API is provided by SAP CC to implement the HCI technical interface if you do not want to use the Java API. It is possible to implement some services of SAP CC BART by using this XML API.
This API is specified with an XML Schema Description (XSD). This documentation includes all the necessary XML fragments of the APIs (both data models and operations). This XSD is also available in the BART SDK of SAP CC as a file that you can import in your development tools.
Tips: XML Examples
The known limitations are described in this documentation and in the SAP CC Application Help documentation and in all the product documents regarding to the type of users.
Consult the SAP CC Security Guide documentation to get information on communication security and user rights to perform the service operations described in this documentation. Consult the SAP CC Configuration Guide documentation to set up the technical settings of the SAP CC system related to the management of secured communications and secured user policy.
Consult the SAP CC Configuration Guide documentation to set up the technical settings of the SAP CC system for the technical interfaces (HCI, Message TCP) and for the business settings.
You can access online to the Java API References of SAP Convergent Charging 5.0 on SAP Help Portal at: https://help.sap.com/cc >> SAP CC 5.0 >> Development Information.
Recommendation
Use always the more up-to-date version of this documentation. It is available in the following software unit of SAP CC: Software Development Kit (SDK) for the SAP CC BART Server. You can download all the SDKs from SAP Software Download Center (SWDC): Initial version or maintenance versions.
Before developing, refer to the SAP CC Implementation and Configuration Guide for more information about the Customizing activities. Your development relates to a step of the implementation project.
Refer to the SAP CC Security Guide for more information about the technical interfaces and about the implementation of secure communications and services.
Refer to the SAP CC Application Help for more information about the business services and processes.
Other Java API References (for integration with other SAP CC systems)
Other documents can help you:
(c) Copyright 2017 SAP SE or an SAP affiliate company. 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 SE or an SAP affiliate company. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE 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 SE 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.
This documentation may describe use cases that are not authorized for all customers in all regions. Please refer to your license agreement and comply with any territorial or use restrictions that apply.
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.
com.highdeal.bart.hci.CDRModel
