com.highdeal.admin.hci

Class ActivateAllOp

java.lang.Object

com.highdeal.admin.hci.ActivateAllOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class ActivateAllOp
extends Object
implements MessageOperation

This mass operation allows triggering the Activation process on all the subscriptions in master data stored in SAP CC; It contains a reference date used to compute the periodic and one-off fees and to update all these subscriptions. This operation has no effect with the provider contracts stored in the back-end database system. Consider the Charging Contract Activate operation.

Implementation in Your Client Application

You must use this operation to prepare your invoicing and billing operations. Each rater instance of the SAP CC system will charge all the recurring events required till the specified toDate for all the charge activations of the subscriptions.

Stoping the running activation

This Activate All operation can be stopped by calling the Stop Activation operation. In this case the current activation request is interrupted and returned with an Activate All Result message with an overall execution status set to STOPPED_STATUS.

The stop activation operation informs all the rater instances that they have to terminate the activation after their current subscription activations and this in a asynchronous way. 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 ActivateException with the reason activationProcessAlreadyRunning.

Recommendation

Since version 3.0 of SAP Convergent Charging, SAP SE recommends the new technical interface (Web Services). You can implement the operations of the Business Process Management process component. See the Activate subscriptions in bulk operation.

Performance Handling

In addition a maxThroughput can be provided to control the resources used by each rater instance of the SAP CC system to perform the activation to preserve performance level for the usage charging. The unit represents the number of subscriptions activated per second for each rater instance. 0, the default value means that no limitation is applied. A negative value will be ignored and the throughput will be set to 0.

Error Handling

If some attributes are missing then a ActivateException is thrown by the connected SAP CC system.

See Also:

ActivateAllResult, ChargingContractActivateOp, HttpMessageSenderFactory

Operation Result

ActivateAllResult

Operation Failure Exceptions

• ActivateException
• ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="activateAll">
   <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

Audit Domain

This operation is audited as part of the audit domain ADMINISTRATION

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME The XML tag name of this service operation: "activateAll"

Constructor Summary

Constructors

Constructor and Description
ActivateAllOp() Constructs an empty ActivateAll Operation.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(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 max throughput (max number of subscription activated per second into each rater instance).
String	getName() The name of this operation is "activateAll"
Date	getToDate() Gets the to date for this activateAll 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(Date toDate) Sets the to date for this activateAll operation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

The XML tag name of this service operation: "activateAll"

See Also:

Constant Field Values

Constructor Detail

ActivateAllOp

public ActivateAllOp()

Constructs an empty ActivateAll Operation.

Method Detail

getName

public String getName()

The name of this operation is "activateAll"

Specified by:

getName in interface MessageOperation

Returns:

"activateAll"

getToDate

public Date getToDate()

Gets the to date for this activateAll operation.

Returns:

The to date for this activateAll operation

setToDate

public void setToDate(Date toDate)

Sets the to date for this activateAll operation.

Parameters:

toDate - The to date for this activateAll operation

getMaxThroughput

public int getMaxThroughput()

Returns the max throughput (max number of subscription activated per second into each rater instance).

Returns:

The max throughput

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 maxThroughput

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(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(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