BRM API
API Overview
CAGBU Enablement Team
Introduction
1. BRM Technical Architecture overview
2. BRM APIs Overview
• Portal Communication Module (PCM) API (Context, FMs, Base Opcodes)
• Adapters (WSM, JCA, BC REST, BRM RSM)
3. PDC API Overview
2 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
Oracle Communications Billing and Revenue Management
Technical Architecture
BRM REST SM BC REST Fmwk WSM SOAP JCA PCM
PDC SOAP Pricing BRM Server
Design Connection Manager
PDC RSM Center
DM DM DM DM DM DM DM
Oracle AQ Vertex Fusa Ldap Invoice IFW BRM
Billing Database
Care
Elastic Charging Engine
Business
Operations
Center Elastic charging servers
Persistence
Database
HTTP/2 Diameter RADIUS
Gateway Gateway Gateway
Convergent Charging Controller Offline Mediation Controller
3 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
Introduction
1. BRM Technical Architecture overview
2. BRM APIs Overview
• Portal Communication Module (PCM) API (Context, FMs, Base Opcodes)
• Adapters (WSM, JCA, BC REST, BRM RSM)
3. PDC API Overview
4 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
BRM APIs Overview
Adapters Connection Child CM
Manager processes
C/C++
Standard BC REST Framework
(CM parent handle
BRM application
BRM RSM (TMF) process)
Client connections
or CM ip@
WSM SOAP
PCM API
CM port
Custom
Java
BRM JCA/J2EE
FMs
Client Customer FM
Activity FM
Application Billing & Rating FM
Perl
request Policy FM & Custom FM
…
CMs provide an interface between clients and the rest of the system
All client application connect to the BRM system through a Connection Manager (CM)
Data sent by the application is processed first by the FMs that are included in the CM
5 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
Understanding the “Portal Communication Module” (PCM) API
Overview
• PCM API is the native API of BRM
Connection Manager
• All access to the data in the BRM database is through the PCM API (CM parent process)
CM ip@
• The API consists of three classes of functions: CM port
• Context management: FM Opcodes
control communication channels to the database Customer FM
PCM API
Activity FM
Billing & Rating FM
• Basic object manipulation: Policy FM and Custom FM
create, search for, delete, and modify objects in the database …
Base Opcodes
• FM object manipulation: Context Management
implement business policies and processes Opcodes
• Support extensibility (BRM SDK), samples in C/C++; Java; Perl
BRM Developer's Guide
6 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
BRM APIs Overview
Adapters
• BRM is delivered with standard adapters:
Adapters
• JCA Resource Adapter (JCA/J2EE)
C/C++
• Web Service Manager (WSM SOAP) BC REST Framework
• Billing Care REST Framework (BC REST)
PCM API
BRM RSM (TMF)
REST Service Manager (TMF Open API aligned)
Java
• BRM REST Services Manager (BRM RSM) API
WSM SOAP
Perl
JCA/J2EE
7 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
BRM APIs Adapters
Billing Care REST Framework
The BC REST API supports the following tasks:
Adapters
• Accounts • Notes
BC REST Framework
• Adjustments • Payment Methods
• Allocations • Payments
• Batch Payments • Profiles BRM RSM (TMF)
• Bill Units • Refunds
• Bills • Services
WSM SOAP
• Collections • Sharing
• Deferred Action • Status Update
• Disputes • Subscriptions JCA/J2EE
• Items • Write Offs
8 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
BRM APIs Adapters
Billing Care REST Framework
The REST framework includes several modules used to perform billing and customer care transactions
with BRM. Each module consists of four tiers, each with its own set of responsibilities:
• The Resource tier manages RESTful
client requests and responses Billing Care REST Framework
• The Module tier coordinates WebLogic Server
transformation of RESTful operations
and payload into BRM native formats REST FRAMEWORK
Application Deployed BC
Deployed BC App
• The Worker tier contains methods REST Customization
PCM API
for converting data between request BRM
Resource
Billing Care and BRM formats (Ex: Account Resource) CM
Or REST
Module
• The PCM tier manages the Client
(Ex: PCMAccountModule)
connections between Billing Care (Postman…)
and the BRM Connection Manager Worker
(Ex: AccountWorker)
Support extensibility (BC REST SDK) PCM
Extending and Creating Billing Care REST Resources
9 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
BRM APIs Adapters
BRM REST Service Manager
The BRM REST Services Manager API supports the following TMF APIs: Adapters
• TMF 666: Account Management API • TMF 654: Prepay Balance BC REST Framework
Retrieves billing cycle specifications (bill Management API
units and bill unit infos in BRM). Retrieves bucket, accumulated,
disputed, and adjusted balances. BRM RSM (TMF)
Also, creates adjusted and disputed
• TMF 635: Usage Management API balances.
Retrieves usage information.
WSM SOAP
• TMF 678: Customer Bill
• TMF 676: Payment Management API Management API
Creates payments, retrieves payment Retrieves customer bills (customer
information, and allocates payments to invoices in BRM). JCA/J2EE
a bill. Creates refunds and retrieves
refund information.
10 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
BRM APIs Adapters
BRM REST Service Manager (RSM)
The BRM REST Services Manager API is an optional component to be installed (Documentation)
Use OAuth 2.0 access tokens to authenticate requests from clients
Support extensibility (BRM RSM SDK) with the following customizations:
• General extension: Adding request query parameters, adding attributes to the request payload, and extending the attributes that are
returned in the response
• Manipulating workflow (Custom opcode)
BRM RSM API supports the following tasks: Helidon Container
Application
• Account Management REST
PCM API
• Customer Bill Management request BRM RSM
BRM
• Payment Management CM
Or REST BRM RSM Extension
• Prepay Balance Management Client
• Usage Management (Postman…)
REST Services Manager API for BRM
11 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
BRM APIs Adapters
Web Service Manager (WSM)
• Web Services Manager Documentation Adapters
• Optional module to be installed
• BRM WSM enables BRM opcodes to be exposed through Web services BC REST Framework
• Use the Apache Axis framework to support SOAP Web services and is
packaged as an integration pack.
BRM RSM (TMF)
Web Service Manager WSM SOAP
SOAP
Application Application Server
PCM API
request (WebLogic/TomCat)
BRM JCA/J2EE
CM
Or SOAP Deployed WSM App
Client
(Postman…)
12 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
BRM APIs Adapters
JCA/J2EE
• To connect J2EE-compliant applications to BRM by using JCA Resource Adapter Adapters
• Deployed on a J2EE-compliant application server (ex WebLogic)
• This enables any J2EE-compliant application to integrate with the BRM BC REST Framework
BRM RSM (TMF)
BRM JCA Adapter
Application Server WSM SOAP
J2EE Application FRAMEWORK
PCM API
compliant Validation and BRM
Application Transformation: CM JCA/J2EE
XML / BRM Flist
request
JCA Resource Adapter
BRM JCA Resource Adapter
Documentation
13 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
Introduction
1. BRM Technical Architecture overview
2. BRM APIs Overview
• Portal Communication Module (PCM) API (Context, FMs, Base Opcodes)
• Adapters (WSM, JCA, BC REST, BRM RSM)
3. PDC API Overview
14 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
Pricing Design Center (PDC) APIs Overview
Master Pricing Design BRM
Catalog PDC RSM Center Server (CM)
(TMF 620 (TMF 620 Client + listener) (PDC)
Server)
Weblogic Server
Web Service
WS Client PDC DB BRM DB
(SOAP)
PDC Import /
EJB T3
Export Utility
PDC REST Services Manager Integration Guide
15 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
Pricing Design Center (PDC) APIs Overview
PDC REST Service Manager (RSM)
PDC RSM allows integration of a Master Product Catalog (Like DX4C Launch) with PDC and then have all the rating
and billing performed by BRM (PDC RSM is a TMF620 client and is not subject to TMF620 CTK)
The Product Catalog Master publishes the product offering objects to registered billing-spoke systems using
TMF620 Notification. Then, PDC REST Services Manager synchronizes this data and then transforms it to charge
offers, discount offers, bundles, and packages in the PDC-BRM system.
1 2 3 4 5
Product Manager DX4C Launch PDC REST Services
Upon design PDC pushes
designs Project and publishes Project to Manager transforms
approval, Product pricing/billing attributes
Product Offerings and Fabric. Fabric routes Product Offerings and
Manager submits to BRM/ECE for testing
their pricing/billing publish Project to their pricing/billing
Project Publish in and/or commercial
attributes in DX4C registered billing spoke attributes and provisions
DX4C Launch consumption
Launch (PDC/BRM) PDC
16 Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
Pricing Design Center (PDC) APIs Overview
DX4C Launch/Fabric TMF620 Message Flow 3 POST Oracle TMF620
notification event, contains
hrefs
Product Catalog launch-publish 5 TMF620 GET(s) of Product
PDC RSM Offering data (using hrefs
Master (Launch)
Fabric Routing
Fabric Routing
from notification event)
2 3 Publish Event
REST
projectPublishEvent POST Oracle
Server
(Listener)
Service
9
success/failure info
4
Product Offering Integration Service
1 5 Product
Product Catalog
API (TMF620) Launch Catalog
Service
6 Launch Mapper PDC
PDC / BRM/ECE
PDC T3
7 T3
PDC
Service Client Server
launch-publish
8
Fabric Routing
10 Fabric Routing 9
Publish Tracker Publishing Notification Publish Ack OAuth2 protected endpoints;
Acknowledgement Client Service OAuth2 servers and flows not
shown
17 Copyright © 2020, Oracle and/or its affiliates | Confidential: Internal
18
Copyright © 2021, Oracle and/or its affiliates | Confidential: Restricted
