ChargingContractActivateOp (SAP CC 2020 Java APIs (Core Library))

java.lang.Object
- com.highdeal.admin.hci.ChargingContractActivateOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable
```
public class ChargingContractActivateOp
extends java.lang.Object
implements MessageOperation
```
This mass operation allows you to trigger the Activation process on all the charging contracts (Concept: provider contracts) to compute the periodic and one-off fees; It contains a reference date used to compute the periodic and one-off fees and to update the contracts.
Business Context and Use

You implement this service operation in your SAP system landscape to prepare your invoicing and billing operations. Each rater instance of the SAP CC Core Server system charges all the recurring events until a reference date (see toDate). The SAP CC system processes all the charge activation objects included in the contract items of the provider contracts.

Implementation in Your Client Application

Stoping the Running Activation

To stop this service operation, you implement and invoke the Stop Charging Contract Activation operation.

You can stop before the activation process by sending the Stop Charging Contract Activation operation at any time. In this case the current activation process is interrupted by the SAP CC system. The system returns a Stop Activation operation result with a status STOPPED_STATUS. It may return this response whereas some rate instances of the SAP CC system are still processing and smoothly ending the current work.

Note

The stop activation operation informs all the rater instances that they have to terminate the activation after their current charging contract activations and this in an asynchronous ways. It means that the stop operation returns even if the rater instances are always finishing their current activations. If a new activation operation is executed immediately after the stop activation operation there is a remote possibility of receiving an ActivationException with the reason 'activationProcessAlreadyRunning'.

Recommendation

Since version 3.0 of SAP Convergent Charging, SAP SE recommends the new technical interface Web Services that is dedicated to the new data model of master data. You can implement the operations of the Business Process Management process component. See the Activate charging contracts in bulk operation. A service operation is also available for subscriptions in case of mixed data.

Example

The SAP CC Admin+ user interface implements this operation: Refer to this user interface and the start_contract_activation and stop_contract_activation commands.

Performance Handling

A maximum throughput (see maxThroughput) can be set to control the CPU resources used by each rater instance of the SAP CC system to perform the activation process to preserve performance level for the usage charging services. The unit represents the number of contracts activated per second for each rater instance:
- Value 0 (default value): no limitation is applied
- Positive value: the maximum number of contracts activated per second by each rater instance in the SAP CC system; take into account the number of instances in the system.
- Negative value: will be ignored and the throughput will be set to 0
Error Handling

If some attributes are missing then an Activate Exception is thrown by the connected SAP CC system.
Operation Result

At the end of the processing, the connected SAP CC system returns a ActivateAllResult that contains an execution status and the total count of activated charging contracts.
Additional Information

Consult the SAP CC Application Help about the master data related to the end customers of a service provider:
- Subscriber accounts
  - Prepaid accounts
  - External (postpaid) accounts
- Provider contracts
See Also:

ActivateAllResult, StopChargingContractActivationOp, HttpMessageSenderFactory

Operation Failure Exceptions
- ActivateException
- ServerFailureException
XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
```
<xs:element name="chargingContractActivate">
   <xs:complexType>
     <xs:attribute name="maxThroughput" type="xs:integer" default="0"/>
     <xs:attribute name="toDate" type="xs:dateTime" use="required"/>
   </xs:complexType>
 </xs:element>
```
Operation Availability
You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:
Edition Final Target Instances
rater updater guider bulkLoader taxer dispatcher
charge No No No No No Yes

Edition	Final Target Instances
rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	No	No	No	No	Yes

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String OPERATION_NAME
The XML tag name of this service operation: "chargingContractActivate"

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`OPERATION_NAME` The XML tag name of this service operation: "chargingContractActivate"

Constructor Summary

Constructors
Constructor and Description

ChargingContractActivateOp()
Constructs an empty ActivateAll operation.

Constructors
Constructor and Description
`ChargingContractActivateOp()` Constructs an empty ActivateAll operation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCharacterData(java.lang.String cData)` Adds character data to the content element.
`void`	`addChild(java.lang.String tagName, XMLMarshallable child)` Adds a child to the object, the `child` representing the marshallable object which must be added to the element.
`int`	`getMaxThroughput()` Returns the maximum throughput (maximum number of contracts activated per second by each rater instance in the SAP CC system).
`java.lang.String`	`getName()` Returns the name of this service operation: "chargingContractActivate".
`java.util.Date`	`getToDate()` Gets the activation reference date (see 'to date') for this business operation.
`void`	`marshal(XMLOutputter output)` Gives an XML representation of this object, including its children.
`void`	`setAttributes(XMLAttributes atts)` Sets the attributes of the XML representation of the element being processed.
`void`	`setMaxThroughput(int val)` Sets the maximum throughput.
`void`	`setToDate(java.util.Date toDate)` Sets the activation reference date (see 'to date') for this business operation.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OPERATION_NAME
```
public static final java.lang.String OPERATION_NAME
```
    The XML tag name of this service operation: "chargingContractActivate"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ChargingContractActivateOp
```
public ChargingContractActivateOp()
```
    Constructs an empty ActivateAll operation.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of this service operation: "chargingContractActivate".
    
    Specified by:
    
    getName in interface MessageOperation
    
    Returns:
    
    OPERATION_NAME
  - getToDate
```
public java.util.Date getToDate()
```
    Gets the activation reference date (see 'to date') for this business operation.
    
    Returns:
    
    The reference date for the activation
  - setToDate
```
public void setToDate(java.util.Date toDate)
```
    Sets the activation reference date (see 'to date') for this business operation.
    
    Parameters:
    
    toDate - The reference date for the activation
  - getMaxThroughput
```
public int getMaxThroughput()
```
    Returns the maximum throughput (maximum number of contracts activated per second by each rater instance in the SAP CC system).
    
    Returns:
    
    The maximum throughput (contracts per second)
  - setMaxThroughput
```
public void setMaxThroughput(int val)
```
    Sets the maximum throughput. A negative value is considered like 0 (no limitation).
    
    Parameters:
    
    val - The value of the maximum throughput allowed
  - setAttributes
```
public void setAttributes(XMLAttributes atts)
```
    Description copied from interface: XMLMarshallable
    
    Sets the attributes of the XML representation of the element being processed.
    
    Specified by:
    
    setAttributes in interface XMLMarshallable
    
    Parameters:
    
    atts - The XML attributes of the current element
  - addCharacterData
```
public void addCharacterData(java.lang.String cData)
```
    Description copied from interface: XMLMarshallable
    
    Adds character data to the content element.
    
    Specified by:
    
    addCharacterData in interface XMLMarshallable
    
    Parameters:
    
    cData - The character data to be added
  - addChild
```
public void addChild(java.lang.String tagName,
                     XMLMarshallable child)
```
    Description copied from interface: XMLMarshallable
    
    Adds a child to the object, the child representing the marshallable object which must be added to the element.
    
    Specified by:
    
    addChild in interface XMLMarshallable
    
    Parameters:
    
    tagName - The name of tag for the child
    
    child - The child to be added
  - marshal
```
public void marshal(XMLOutputter output)
```
    Description copied from interface: XMLMarshallable
    
    Gives an XML representation of this object, including its children.
    
    Specified by:
    
    marshal in interface XMLMarshallable
    
    Parameters:
    
    output - The XML output to marshal the object into

Class ChargingContractActivateOp

Business Context and Use

Implementation in Your Client Application

Stoping the Running Activation

Performance Handling

Error Handling

Operation Result

Additional Information

Operation Failure Exceptions

XML API for HCI

Operation Availability

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPERATION_NAME

Constructor Detail

ChargingContractActivateOp

Method Detail

getName

getToDate

setToDate

getMaxThroughput

setMaxThroughput

setAttributes

addCharacterData

addChild

marshal