Change the Operational Status of a Charging Contract

Service Operation (WS)

Definition

To change the operational status of a charging contract

Technical Data

Software Product and Version	SAP Convergent Charging 2022
Technical Details	chargingContractOperationalStatusChange
Namespace	http://operationalstatus.ws.highdeal.com/
Proxy Instance in SAP CC System	Updater
Service Operation Version	0
User Operation Auditing	Yes
Audit Domain	CUSTOMER
Application Area	IS-CC
Direction	inbound
Mode	synchronous
Idempotency	true

Business Context and Use

This service operation enables you to change the operational status of a charging contract.

Note

Linked charging contracts do not have their own operational status, they inherit from the status of their parent contract. As a consequence, you cannot change the operational status of a linked contract.

This operation is used in order to:

Avoid any modification of a charging contract being moved from one SAP CC system to another
Prevent SAP CC charging processes like charging or activation from running on the charging contract
Permanently deactivate a charging contract

Related Service Operations

Customer data import: This operation enables you to import customer data in an SAP CC destination system. The operational status of the charging contracts that have been imported is set to 'locked' by default. Use the chargingContractStatusChange operation to set the operational status of the contracts to 'active':
- in the SAP CC destination system, when the contracts are ready to be used
- in the SAP CC source system if the import in the SAP CC destination system failed
Customer data export: This operation enables you to export customer data from an SAP CC source system. Use the chargingContractStatusChange operation to set the contracts:
- To 'locked' before exporting them
- To 'closed' once you are sure that the contracts were correctly moved and are in use in the destination system

Features

The available operational statuses are:

Active: The charging contract is fully operational.
Locked: The charging contract is temporarily locked. SAP CC processes related to the charging contract are not available.
Closed: The charging contract is not operational any longer: it is deactivated.

See the process component operational status management for a detailed description of the values of the operational status.

Notes

You cannot change:

The operational status of a contract directly from 'active' to 'closed'. You have to set it to 'locked' first.
An operational status set to 'closed'. This status is final and cannot be changed any longer.
The operational status of a contract which is locked for recharging. Wait for the end of the recharging session before modifying the operational status of the charging contract.

Authorizations

To know the role that is expected in the user profile of the SAP CC user specified in your request messages, refer to the SAP CC Security Guide .

Error Handling

The SAP CC system may return an error classified into a category and an error stack detailing the issue and its cause.

Categories and Treatments to Implement

Consider the following error categories to design and implement the appropriate behavior of your connected application or system:

Error Category	Description	Error Handling
Already Exists	The data has to be created but another data already exists in the connected SAP CC system with the same type and the same identifier.	Not applicable for this service operation
Does Not Exist	The data to be modified or deleted does not exist in the connected SAP CC system.	Applicable for this service operation: Next follows a non-exhaustive list of errors related to the Does Not Exist category: The contract does not exist
Invalid	The request or the data is invalid.	Applicable for this service operation: Next follows a non-exhaustive list of errors related to the Invalid category: The identifier of the parent contract is missing The operational status of the contract cannot be modified because the contract is a linked contract The operational status of the contract is missing
Incompatible Configuration	The configuration of the connected SAP CC system is not compatible with the data specified in the operation request and the scope of the request. Creating or correcting the prerequisite configuration data (master data, business data) has to be done in the SAP CC system with the Core Tool user interface or within your connected application or system.	Not applicable for this service operation
Prerequisite Missing	Another data mandatory for the operation is not available or is not compatible with the data specified in the operation request. Create a prerequisite for the data.	Not applicable for this service operation
Illegal State	The operation request is valid but was rejected because of the current state of the data in the connected SAP CC system which prevents the execution of the request. The current state of the complete system can be also the origin of the error.	Applicable for this service operation: The request will not succeed without a required manual correction or change in the SAP CC system. You implement error logging and manual retry mechanisms. Next follows a non-exhaustive list of errors related to the Illegal State category: The operational status of the parent contract cannot be changed because it is already closed The contract cannot be closed because its operational status is active The operational status of the contract cannot be changed because it is used for a rerating or a recharging session
Temporary Illegal State	The valid request was rejected because of the temporary illegal state of the data in the connected SAP CC system. The data state may automatically change without any further notification. This is a subcategory of the Illegal State category. The state of a data is temporary illegal but the operation request can be sent again after a waiting period. The current state of the complete system can be also the origin of the error.	Not applicable for this service operation

Note

This list of errors is not exhaustive: consider the technical details of the operation response.

Troubleshooting

Refer to the SAP CC Error Code Reference for more information about a returned error code and the corrective actions necessary for troubleshooting your implementation project.

Message Types

Consult the structures of the message types related to this service operation :

Prerequisites

Check that no charging session or spending status monitoring is ongoing before setting the operational status of a contract to 'locked' or 'closed'. Otherwise, the sessions are automatically discarded and purged.

Integration

There is no specific integration information.

Constraints and Integrity Conditions

There is no specific constraint.

Notes on SAP CC Implementation

You must have installed and configured the SAP CC Core Server system.

Configuration

Consult the SAP CC Configuration and Implementation Guide to know the necessary configuration or Customizing of the SAP CC system.

Before implementing SAP Convergent Charging in your SAP system landscape, you must configure the systems and the data (master data, business data).