Allowance Validity Period Updater Operator

Important: In the case of automatic allowance renewal and at runtime, if an Allowance Validity Period Updater Operator (*) tries to set the validity start date of an allowance to a date that is earlier than its current validity start date, the validity period of the allowance is automatically shifted to the current validity start date. See also the Create Allowance Operator about the allowance renewal.

(*) This rule is only true if the Allowance Validity Period Updater is used in a one-shot trigger (creation event) of the allowance logic and if the allowance was created by a one-shot trigger at expiration time.

The Allowance Validity Period Updater Operator component enables to redefine the end date or redefine the start date and the end date of the validity period of the allowances. This component is available in the Allowance Logic and can be inserted in the decision tree after an Event-Based Trigger, a Recurring Trigger, or a One-Shot Trigger component.

Use

Use the Allowance Validity Period Updater Operator component when you need to change the validity period of an allowance.

Example

As a service provider, you create an allowance valid for six months for a customer. The allowance extends its validity period when a new allowance is created (carry-over).

At creation time, the new allowance generates an allowance event of the “ALLOWANCE_CREATED” type including the following fields:

Its validity period start date
Its validity period end date

The old allowance that receives the allowance event first checks that its end date is before the end date of the new allowance. If it is the case, the old allowance extends its own validity end date.

Identification Area

Name: Type the name of the component (mandatory).

Description: Allows you to type the description of the component (optional).

Definition tab

An Allowance has a validity period, which is the period of time during which the allowance can be debited by the charging process. The validity period is specified according to two dates, the start date and the end date. Note that the start date is included in the validity period and the end date is excluded from the validity period: [start date, end date[.

Update the validity period according to the allowance status

Note: When selecting a date property, keep in mind the following:

Keep: Does not change the date
Creation Date: Is the date when the allowance is created (only available in a Creation One-Shot Trigger)
Event Date: Is the date of the current event (Event, Recurring or One-Shot)
Validity Start Date: Is the current start date of the validity period of the allowance
Validity End Date: Is the current end date of the validity period of the allowance
You can select your own date properties created in the allowance logic (context properties)

Note: The values of the Validity Start Date and Validity End Date properties are updated according to the modifications performed by the Allowance Validity Period Updater Operator and are then available for the next logic components that can use these dates.

Inactive: The allowance has not been yet activated by SAP CC (activation process). You can then redefine the start and end dates of the validity period of the allowance:

Validity Start Date: Select a date property
Validity End Date: Select a date property

Note: Make sure that the validity start date is earlier than the validity end date; otherwise, the system changes the dates so that the validity end date is equal to the validity start date, which means that the allowance is valid but expired.

Active: The allowance has been activated by SAP CC (activation process). You can then redefine the end date of the validity period of the allowance:

Validity End Date: Select a date property.
Allow to shorten the validity period: If you select this option, the validity period of the allowance can be either shortened or extended; otherwise, the validity period of the allowance can only be extended.

Notes:

If the Allow to shorten the validity period option is selected, make sure that the validity end date is greater than the following dates:
The date of the current event, which corresponds to the value of the “Event Date” property
The date when the last Recurring or One-Shot was triggered
The date of the latest reservation which may have accessed the allowance (so that such reservation is not impacted by the modification of the validity end date)

If the specified validity end date is not greater than these dates, the validity end date is automatically set to the greatest of these dates, plus 1 second (because the end date is excluded from the validity period).

If the Allow to shorten the validity period option is not selected, make sure that the new value of the validity end date is greater than its current value. Otherwise, the validity end date is not modified.

Example

If the end date of the validity period of the allowance is modified to the date C, the modification is performed as configured whether the Allow to shorten the validity period option is selected or not.
If the end date of the validity period is modified to the date A:
If the Allow to shorten the validity period option is not selected, the end date of the validity period of the allowance is not modified.
If the Allow to shorten the validity period option is selected and there is no reservation in progress, the end date of the validity period of the allowance is modified to the date A as configured.
If the Allow to shorten the validity period option is selected and there is a pending reservation at the date B, the end date of the validity period of the allowance is modified to the date B plus 1 second instead of the date A.

Expired: The allowance is expired. You cannot update the validity period of the allowance.