Status Transition Actions

Certain actions that can only occur during specific transitions.

Status Actions lists the possible status actions. Note that status actions impact all instances of the specified product offer or bundle in the subscription or group wallet.
Note: Currently, only MtxStatusActionUpdateField applies to users.
Table 1. Status Actions
Action Description
MtxStatusActionActivateAllOffer Activates all pre-active purchased items. For information about pre-active purchased items, see the discussion about managing product offers in MATRIXX Subscriber Management.
Note: All the pre-active offers must activate successfully before the status transition can occur.
MtxStatusActionCancelOffer On the transition, all valid specified offers are canceled (that is, offers that have not been cancelled and have not expired). To enter more than one offer ID, separate the IDs with a comma (such as 245,244). Note that if you specify a catalog item ID, pricing validation will fail. You must specify a ProductOfferId or BundleId. All purchased catalog items containing the specified ID (directly or indirectly) are cancelled.
Note: Offers are cancelled with the write_off_all debt cancellation mode. If an offer has any debt balances, all the debts are written off.
MtxStatusActionCancelAllOffer On the transition, all valid offers are cancelled (that is, offers that have not been cancelled and have not expired). When a bundle is cancelled, all offers within the bundle are cancelled. The individual product offer CancelType values (Immediate, BillCycle, BalanceCycle, or PurchasedItemCycle) in the bundle are used to determine the CancelEndTime of the individual offers when a bundle is cancelled.
Note: Offers are cancelled with the write_off_all debt cancelation mode. If an offer has any debt balances, all the debts are written off.
For more information about bundles, see MATRIXX Pricing and Rating.

Check Send Notification to generate a notification when this action is performed. This option is not checked by default (that is, no notification is generated).
MtxStatusActionModifyParentStatus On the transition, if the parent status is the expected value, the object will transition to the new status. This must be listed a valid transition in the parent object. All parent status transitions will be performed. The fields are:
  • ExpectedStatus
  • Status
MtxStatusActionResumeAllOffer On the transition, all offers and recurring operations are resumed immediately. When a bundle is resumed, all offers within the bundle that can be resumed are resumed. See Proration Type below for information about configuring proration properties.
Note: Suspend and resume do not affect offers in a cancelled state.
MtxStatusActionSuspendAllOffer On the transition, all offers that are configured as Can Be Suspended in the product offer template are suspended. When a bundle is suspended, all offers within the bundle that can be suspended are suspended. Recurring operations on price components within suspended offers are not executed while the offer is suspended. Suspended offers are evaluated during usage rating.

To prevent recurring charges and grants when a subscription is in a barred status, add this action to the status transition into the barred status. To resume recurring charges and grants, add MtxStatusActionResumeAllOffer to the transition out of barred. See Proration Type below for information about configuring proration properties.

Check Pause on Suspension to suspend the offer and put it into Pause mode. When in Pause mode, no refunds or forfeitures are issued when the offer is suspended, and no recurring charges or grants are issued at the time of offer resumption. When an offer is taken out of Pause mode, the offer's end time is extended by the length of the offer's suspension.When in Pause mode, no refunds or forfeitures are issued when the offer is suspended, and no recurring charges or grants are issued at the time of offer resumption. When an offer is taken out of Pause mode, the offer's end time is extended by the length of the offer's suspension.

For more information about product offer templates, see My MATRIXX Help.

MtxStatusActionWriteOff Balances in the wallet are forfeited immediately regardless of the Forfeiture Enabled balance template setting for balance expiration.

Check Send Notification to generate a notification when this action is performed. This option is not checked by default (that is, no notification is generated).

Note the following:
  • Only G/L balances are written off.
  • Meters are not written off.
MtxStatusActionSaveTransitionTime When a status change occurs, record the date and time in a custom data container field. Define the following:
  • Save Expected Transition Time — Check this box to save the date and time when the status transition is expected to occur. If this option is not checked, the date and time when the status transition actually occurs is saved. Because life cycle maintenance is performed in the background, a delay in transitioning to a new status is possible.
    Note: If an MtxStatusActionSaveTransitionTime status action with this field checked is triggered by a status condition that does not support an expected transition time, then the actual transition time value is saved instead.
  • Save First Transition Time Only — Check this box to only update the date and time at the first occurrence of transitioning to a particular status. If this option is not checked, the previously saved date and time is updated each time the object transitions to a status. The life cycle might transition to the same status multiple times.
  • Container — Select from the drop-down menu the name of the MATRIXX data container (MDC) containing the field where the date/time of the status change is stored. 
  • Field — Select from the drop-down menu the custom MDC field that stores the date/time of the status change. The specified MDC field must have a data type of DATETIME. 
MtxStatusActionUpdateField When a status object transitions to another status, this action sets the date and time for when the next status transition will occur to a custom DATETIME field of the status object (subscriber, group, device, user, or account). The time when the next transition will occur depends upon normalizer and decision table execution results. The data modify profile selector that you configure here executes the applicable normalizers. These results determine which data modify profile to use to update the custom DATETIME field to the next transition time using a data modify action, which specifies the unit and count used to update the custom DATETIME field.

For more information, see the discussion about creating data modify profiles and selectors.

Proration Type

The proration type must be set for the following actions:
  • MtxStatusActionSuspendAllOffer
  • MtxStatusActionResumeAllOffer
Important: The proration type defined in the status life cycle overrides the proration type defined in the product offer when suspending or resuming an offer unless the proration type value is Offer.

The default proration type for all actions is Scaled.

Proration is applied based on the following factors:
  • When an offer is cancelled, the cancel proration type in the offer is used based on consumption.
  • When an offer is suspended, the proration type in MtxStatusActionSuspendAllOffer is used to calculate the balance amount and the credit floor.
  • When an offer is resumed, the proration type in MtxStatusActionResumeAllOffer is used to calculate the balance amount and the credit floor.
There are separate proration types for charges and grants:
  • Grant Proration Type
  • Charge Proration Type

Suspend Proration Types

Suspend Grant Proration Types describes the grant proration type values for suspending an offer.
Table 2. Suspend Grant Proration Types
Grant Proration Type Description
Scaled The forfeited grant amount for the final cycle is scaled according to the portion of the cycle in which the product offer was owned. This is the default.
None Forfeit no granted assets.
Full Forfeit any unused amount of the granted assets.
Consumption Based The forfeited grant amount is based on the amount of assets a subscription consumed from the amount granted with the offer being cancelled. If the consumed amount is greater than or equal to the granted amount, the amount removed from the grant balance is the granted amount. If the consumed amount is less than the granted amount, the consumed amount is removed from the grant balance.
Offer The proration settings in the product offer override the proration settings in the status life cycle definition.
Suspend Charge Proration Types describes the charge proration type values for suspending an offer.
Table 3. Suspend Charge Proration Types
Charge Proration Type Description
Scaled The refunded charges for the final cycle are scaled according to the portion of the cycle in which the product offer was owned. This is the default.
None Refund no charges.
Full Refund the full charge.
Offer The proration settings in the product offer override the proration settings in the status life cycle definition.
Forfeiture Based The charge amount that is refunded is scaled according to the unused amount of one specific recurring grant during the portion of the cycle the product offer was owned and valid.

Resume Proration Types

Resume Charge and Grant Proration Types describes the charge and grant proration type values for resuming an offer.
Table 4. Resume Charge and Grant Proration Types
Charge/Grant Proration Type Description
Scaled Charge and grant amounts are scaled according to the portion of the cycle period that the product offer is owned by the subscription or group. This is the default.
None Charge or grant amounts are not applied for any of the cycle period in which the purchase occurs.
Full Charge and grant amounts are applied in total for the full cycle period in which the purchase occurs.
Offer Proration settings in the product offer override the proration settings in the status life cycle definition.