start_purge_allowances (SAP CC 4.1 Admin+)

start_purge_allowances

Definition

To purge expired allowances which have exceeded the retention period

Command Usage

Syntax

start_purge_allowances <REF_DATE> <MAX_THROUGHPUT>

Command Arguments

Name	Description
`<REF_DATE>`	The reference date of the purge operation (ISO 8601 date format: yyyy-MM-dd), used to determine the list of expired allowances
`<MAX_THROUGHPUT>`	The maximum throughput that the purge operation can consider, which corresponds to the number of provider contracts per second visited by each rater instance of the SAP CC system; Format: 0 or a number between 1 and 1000.

Detailed Information

The start_purge_allowances command gives the possibility to purge data related to expired allowances in provider contracts, which means allowances whose validity end date (shifted by the retention period) is anterior or equals to the reference date of the purge operation.

Notes

The start_purge_allowances command concerns all the provider contracts which use allowances
The start_purge_allowances command returns to the command prompt only when all the allowances of all the provider contracts have been checked by the connected SAP CC system
To tune performances of the operation regarding your system solicitation, a maximum throughput must be specified. This throughput represents the maximum number of charging contracts per second that can be visited by the Raters in charge of purging the allowances. The maximum throughput must be greater than or equal to 0. The value 0 means that the throughput is not limited.
A dedicated indicator named ALLOWANCES_PURGE_LAST_TRIGGER contains the reference date of the last manual execution of the operation, for information purpose

Authorization

You must have a specific role in your SAP CC user profile. Refer to the SAP CC Security Guide for more information about the necessary authorizations.

Messages

Code	Message	Action
invalidToDate	Error: The date "{date}" must be in the ISO 8601 date format (yyyy-MM-dd).
invalidMaxThroughput	Error: The maximum throughput must be a number defined between 0 and 1000: ''{argument}''.
purgeAllowancesStarted	The allowance purge operation is started at ''{date}''
purgeAllowancesStopped	The allowance purge operation is stopped at ''{date}''
server.unavailable	Error: The instance of the SAP CC system is unavailable: {exception}.
purgeAllowances.status	Status
purgeAllowances.performed_status	Performed
purgeAllowances.incomplete_status	Incomplete: The stop operation request cannot be transmitted to all the rater instances of the SAP CC system.
purgeAllowances.stopped_status	Stopped by the SAP CC user
purgeAllowances.refDate	Entered Reference Purge Date
purgeAllowances.adapRefDate	Adapted Reference Purge Date
purgeAllowances.visitedC	Visited Provider Contract Count
purgeAllowances.visitedA	Visited Allowance Count
purgeAllowances.purged	Purged Allowance Count
purgeAllowances.failed	Failed Provider Contract Count