Business Context and Use
These Web Services are dedicated to the integration with a CRM such as SAP CRM or with an invoicing system
such as SAP ERP. Use them if you want to manage data stored in SAP CC Core Database or if you want
to perform actions such as charging and refilling from a CRM.
A prerequisite for the integration is to define the pricing logics and the charging and refilling rules in
SAP Convergent Charging. The standard integration of SAP Convergent Charging with a CRM can be split into three
stages:
- The definition of the catalog: in the CRM, you combine the charge plans and the refill plans defined in
SAP Convergent Charging to set up your catalog.
- The customer provisioning in Convergent Charging from the CRM with their accounts which can be prepaid
or external. Notice that external accounts are links to postpaid accounts managed by the invoicing system. SAP
Convergent Charging has only references to the postpaid accounts.
- The provisioning of pricing and charging information in contracts stored in SAP Convergent Charging from the CRM.
Provided Services
The Web Services provide the following process componnents for your implementation project:
Master Data Management
Business Processing
Restricted Services
These services are provided to be used by other SAP applications. They are not aimed to be used in an implementation project.
Pricing Simulation
Technical Details
Technical details are included in this documentation for all the service operations.
They describe the structure and the content for each message types. The formats of all the elements of the messages are detailed.
This information is based on the Web Services Description Language (WSDL) and the associated XML Schema Definition (XSD) provided by SAP CC.
Endpoints
SAP CC provides several endpoints for accessing the Web Services. They are defined by a URI that includes a network address of the SAP CC system
associated with a SOAP binding. The network address is the HTTP or HTTPS address of a particular instance of the SAP CC system. A port number is dedicated to
these communications. The SOAP binding is the technical name of the process component (Web service). The URI is case sensitive.
Format:
http://<INSTANCE_HOST>:<INSTANCE_WS_PORT_NB>/<WS_TECH_NAME> https://<INSTANCE_HOST>:<INSTANCE_WS_PORT_NB>/<WS_TECH_NAME>
Where:
<INSTANCE_HOST> is the network address (DNS name or the IP address) of the host machine of the active Updater instance of the SAP CC Core Server system <INSTANCE_WS_PORT_NB> is the port number dedicated to the Web Services communications for the target instance <WS_TECH_NAME> is the technical name of the Web service (process component)
Examples
https://<UPDATER_INSTANCE_HOST_IP>:9080/cataloghttps://<UPDATER_INSTANCE_HOST_IP>:9080/suacProvisioning
WSDL
Web Services Description Language (WSDL) is available from the updater instance(s) of a running SAP CC Core Server system.
A WSDL is provided for each process component. It refers some XSD fragments necessary for your development tools.
During the implementation phase, you can access online to the relevant WSDL by using the URL of the needed process component(s):
- http://<UPDATER_INSTANCE_HOST>:<PORT_NB>/<WS_TECH_NAME>?wsdl
- https://<UPDATER_INSTANCE_HOST>:<PORT_NB>/<WS_TECH_NAME>?wsdl
Where:
- <UPDATER_INSTANCE_HOST> is the DNS name or the IP address of the host machine of the active Updater instance of the SAP CC Core Server
- <PORT_NB> is the port number dedicated to the Web Services communications on this host
- <WS_TECH_NAME> is the technical name of the Web Service (process component)
Idempotent Web Service Operations
SAP CC provides some idempotent or safe operations via the Web Services.
Idempotency management means that the same repeated invocation of safe web services has no unintended effects on the service state.
SAP CC 3.0 only supports message resubmission detection. SAP CC 3.0 does not support response caching.
In other words if a request is detected as resubmitted to SAP CC 3.0 then a resubmission detection response is sent back (in this case the original operation response is not available).
The idempotency capability of SAP CC 3.0 is based on the Web Service Addressing (WS-A) MessageID SOAP header.
The WS-A MessageID header is the unique identifier of a SOAP message.
A SOAP message having a MessageID header can be sent to SAP CC several times without any problem. The behavior of a safe web service is the following:
- While the invocations fail whichever the reason (authentication, prerequisite missing, ...), next
invocations will be processed again.
- As soon as one invocation is successfully processed, the next invocations will be successful but not
processed again.
Example of safe invocation
Here is an extract of safe SOAP message enabling safe invocation:
<soapenv:Envelope xmlns:sch="http://schema.catalog.ws.highdeal.com/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsse:Security soapenv:mustUnderstand="1"
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-3" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>mylogin</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">********</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
<wsa:MessageID>uuid:c623a504-7d63-46d8-b9bf-eed05299043b</wsa:MessageID>
</soapenv:Header>
<soapenv:Body>
<sch:mappingTableCreateRequest>
<id>myMappingTable</id>
<mappingTableClassId>myMappingTableClass</mappingTableClassId>
</sch:mappingTableCreateRequest>
</soapenv:Body>
</soapenv:Envelope>
Business Object Models
SAP CC Web Services specify data models of business objects necessary to the service operations.
These models relate to the master data (subscriber accounts, ...) and transaction data (chargeable items) managed by SAP Convergent Charging.
Functional and technical details (see Data Type) are available from each process component.
Notes
-
A unique specification of an object may be reused in many request and response operations.
The technical details facilitate the understanding of the service operations and do not reflect this sharing.
You must interpret some annotations. For example the Web Services specify a model
for a subscriber account that is used by several request operations and response operations.
-
The same master data can have several specifications. For example the Web Services specify two models
for a provider contract:
charging contract
and charging contract state.
Service Operation Processing
SAP CC Web Services provide two particular modes for bulk processing: The bundle and mass modes.
The bundle or mass operation groups multiple single operations for processing by the connected SAP CC system.
All the single operations are the same type. The single operations are sequentially executed.
Note
The idempotency is applied to the bundle operation and mass operation. It does not apply to each single operation
included in the bundle or mass operation message.
You implement the operations in bundle mode or in mass mode according to your business requirements and context.
Bundle Mode (All or None)
The bundle operation groups multiple single operations for processing.
All single operations are successfully performed or none:
The processing stops at the first failed single operation and the modifications done by the previous single operations are cancelled in the SAP CC system.
The overall bundle result includes a list of successful single results.
In case of business error, the overall result is failed and includes a list of successful but not applied single results and one failed operation.
In case of system error, a SOAP fault is replied. No change applies.
The required implementation of the error handling is facilitated: Your application must send again the same request once the issue has been fixed.
Each time an error occurs, you must restart from the beginning.
Mass Mode
The mass operation groups multiple single operations for processing.
Most of the single operations are successfully performed whatever the failure of certain single operations:
The processing is never stopped (except for a system failure)
and the modifications done by the previous single operations remain in the SAP CC system.
The overall mass result includes a list of successful or erroneous single results.
- In case of some business errors, the overall result is successful and includes a complete list of successful or erroneous single results and the count of errors.
- If all the single operations fail, then the mass operation fails.
In case of system error, a SOAP fault is replied. No change applies.
The required implementation of the error handling is intelligent: Your application must be able to take into account the successful and the failed
single operations to only send again the relevant single operations later on. All the business errors are immediately listed in the mass result.
Examples
- Create or change subscriber accounts in mass mode
- Create or change charging contracts in mass mode
Security
Consult the SAP CC Security Guide to
get information on communication security and user rights to perform the service operations
described in this documentation. Consult the SAP CC Configuration Guide to set up the technical
settings of the SAP CC system related to the management of secured communications and secured user policy.
Note
You need an SAP CC user for each pricing catalog you want to work with from SAP Convergent Charging.
These technical users must be granted with the adequate roles set in SAP CC.
Each technical user must be associated to a unique pricing catalog owned by a service provider.
Configuration
Consult the SAP CC Configuration Guide to set up the technical
settings of the SAP CC system for the Web Services and to get some recommendations on the implementation activities.
Related Documentation
For more information, see the related product documentation of SAP Convergent Charging in SAP Help Portal.
Document Version: SAP CC 3.0 SP17 (and Later Versions)
SAP
DOCUMENTATION