Customer Data Export

Service Operation (WS)

Definition

To export customer data

Technical Data

Software Product and Version SAP Convergent Charging 5.0
Technical Details customerDataExport
Namespace http://customerdata.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 exports some customer data stored in SAP Convergent Charging. This operation is used in the following contexts:

  • Move or copy customer data from one SAP CC system to another. It is used in conjunction with the import operation to export customer data before importing it in another SAP CC system.
  • Extract customer data for archiving or external processing purposes.

Related Service Operations

  • Customer data import: This operation enables you to import customer data. The customer data resulting from the customerDataExport operation can be used as input in the import operation.
  • Operational status change: This operation enables to update the status of the contracts that have been exported with the customerDataExport operation. If the contracts are imported into another system, their operational status in the source system can be set to locked, meaning that the contracts cannot be used in the source system any longer.

Features

This operation is used to export the following customer data:

  • A subscriber account including:
    • The related accounts (both prepaid and external)
    • The subscriber mapping tables
    • The subscriber range tables
    • The charging contracts
  • Charging contracts including:
    • The linked charging contracts
    • The subscriber mapping tables
    • The subscriber range tables
    • The charging contract states
    • The allowances

To export customer data, this operation requires one of the following arguments:

  • One subscriber account identifier
  • One or several charging contract identifiers

If you call this operation with a subscriber account identifier, all the accounts, the subscriber tables, and the charging contracts related to this subscriber account are exported. If you call this operation with a charging contract identifier, all the linked contracts, subscriber tables, allowances, and contract states related to this charging contract are exported. You cannot call this operation with both a subscriber account identifier and a charging contract identifier.

Note

You cannot export a linked charging contract without its parent contract. If you call the customerDataExport operation with the identifier of a linked charging contract, the operation is rejected.

Operational Status of the Charging Contracts to Be Exported

It is possible to change the operational status of all the exported charging contracts in the source SAP CC system by providing this status with the parameter chargingContractOperationalStatusChangedTo in the operation request. If this parameter is not provided in the request, the status of the exported contracts remains the same. For instance, you may want to set the operational status of the contracts to be exported to 'locked' in the source system so that they cannot be used any longer while moving contracts.

The operation changes the status of the contracts before exporting them.

Note

Note that the operational status of the contracts is not exported.

The behavior of this operation when specifying the parameter chargingContractOperationalStatusChangedTo is similar to the behavior of the chargingContractOperationalStatusChange operation:

  • You cannot set contracts whose operational status is 'active' in the source system, to 'closed'.
  • You cannot change an operational status set to 'closed'.

Caution

If you set the operational status of the contracts exported from the SAP CC source system to 'closed', you will not be able to use them any longer in this system. Make sure you do not need these contracts. If you move contracts from one system to another, we recommend that you set the exported contracts to 'locked' first and that you set them to 'closed' later when you are sure that the contracts were successfully moved.

Warning

If the contracts to be exported are still used in recharging sessions, and if you set the parameter chargingContractOperationalStatusChangedTo in the customerDataExport operation, the operation is rejected. You are not allowed to change the status of a contract being used in a recharging session. However, you are allowed to export this contract.
If the exports fail because of the chargingContractOperationalStatusChangedTo parameter, change the operational status of your contracts with the operationalStatusChange operation before exporting them.

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 subscriber account to export does not exist in the SAP CC system
  • The parent charging contract to export does not exist in the SAP CC system

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:

  • Neither the subscriber account ID or the parent charging contract ID is provided in the request
  • You cannot provide both a subscriber account ID and parent charging contract IDs in the export
  • The parent charging contract ID is duplicated in the export request
  • The rootChargingContractId refers to a linked charging contract in the SAP CC system
  • The contracts to be exported do not belong to the same subscriber account

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.

Not applicable for this service operation

Temporary Illegal State The valid request was rejected because of the temporarilly 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 Illegal State category. The state of a data is temporarilly 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 ( SAP Site ) 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

There is no prerequisite.

Integration

In case of contract transfer in an integrated scenario with SAP ERP and SAP CRM, you only have to export charging contracts and subscriber tables. Subscriber accounts are created in the destination system by SAP ERP without using SAP CC Web Services.

Constraints and Integrity Conditions

  • If you call this operation with a subscriber account identifier, the subscriber account with this identifier must exist in the source SAP CC system.
  • If you call this operation with a charging contract identifier, the charging contract with this identifier must exist in the source SAP CC system.
  • If you call this operation with several charging contract identifiers, all the charging contracts to be exported must belong to the same subscriber account.

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).