Balance Template Thresholds Properties

Thresholds properties determine the type of threshold, whether it recurs, and whether it sends a notification when a threshold is reached. A credit limit threshold must be defined for all balances. During upgrade, My MATRIXX generates and persists a credit limit threshold for any balance that does not already have one (with a value of infinity, which means there is no spending limit).

Thresholds Properties lists the thresholds properties.

Table 1. Thresholds Properties
Property	Description
Id	An auto-generated unique ID used internally during rating to locate the balance.
Name	A descriptive name for the threshold.
Value Type	A threshold can be an absolute value or a percentage. Absolute — Sets the threshold as a specific amount. Percentage — Sets the threshold as a percentage of the credit limit, for example, 85%. If the Threshold Type is Balance Floor, this is an absolute value (you cannot specify a balance-floor threshold as a percentage).
Value	Specifies the absolute or percentage value. If the Threshold Type is Balance Floor, this is a negative amount and cannot be zero.
Threshold Type	A threshold type can be: Credit Limit — The threshold is based on the credit limit. Note: When you create a new balance, you must define a credit limit threshold for it (pricing validation requires a credit limit threshold to be defined within the pricing repository for all balances). Important: When selected, the threshold is a credit limit. A credit limit stops subscriber activity when the credit limit is reached. Balance Amount — The threshold is based on the balance amount. Consumed Amount — The threshold is based on the quantity of a balance (or meter) being used from the credit floor towards the credit limit. Available Amount — The threshold is based on the quantity of a balance (or meter) remaining from the credit limit towards the credit floor. Balance Floor — The threshold is based on the maximum allowable amount for an instance of that balance. This threshold type applies to prepaid balance templates and balance-amount meters that track prepaid balances only.
Recurring	Sets the threshold to trigger every time the Value amount is removed from a prepaid balance or added to a post-paid balance. For example, say you have a recurring threshold on a postpaid US Dollars balance and the threshold value is 20. Every time 20 dollars are added to the subscriber's balance, a threshold is triggered. The recurring parameter can apply to both an absolute and a percentage value and can have optional start and end values that limit the balance range within which the thresholds are triggered. Start — Specifies the starting point from which a recurring threshold is triggered: prepaid default = infinity (0) postpaid default = -infinity (0) Stop — Specifies the point beyond which recurring threshold is no longer generated: prepaid default = -infinity postpaid default = infinity
Group Notification	If the balance or meter is configured to send notifications on increases or decreases, sets who receives the notifications when the balance owner is a group: Use Group Setting — Use the setting the group has set on it. Notify Admins — Notifies the group administrator. Notify Members — Notifies group members.
Locked	When selected, the credit limit cannot be changed.
Notify	When selected, a notification is sent when the threshold (soft threshold or credit limit) is reached.
Event Enabled	When selected, an event (MtxBalanceThresholdEvent) is generated each time the threshold is reached or crossed.
Applies to Balance Increase	Sets whether the threshold is triggered when the balance increases above the threshold value. For example, when a postpaid minutes balance has a credit limit of 500 and reaches 400 minutes, trigger the threshold. If notifications are enabled, a notification is sent to alert subscribers they are nearing their credit limit.
Applies to Balance Decrease	Sets whether a threshold is triggered when the balance decreases below the threshold value. For example, when a prepaid minutes balance falls below 20 minutes, trigger the threshold. If notifications are enabled, a notification is sent to subscribers so that they can top up.
Threshold Cycle Notification Limit	Defines how often you want notifications for the same threshold to be triggered during a cycle: Unlimited — A notification is triggered each time the threshold is crossed during a cycle. This is the default. Once Per Cycle — A notification is triggered the first time the threshold is crossed during a cycle. Subsequent threshold crossings do not trigger a notification. Note: This property only applies to thresholds configured in My MATRIXX. You can override this configuration using the SubMan API AddThreshold requests. For more information, see the discussion about AddThreshold requests in MATRIXX Subscriber Management API.
Threshold Cycle Event Limit	Defines how often you want events for the same threshold to be triggered during a cycle: Unlimited — An event is triggered each time the threshold is crossed during a cycle. This is the default. Once Per Cycle — An event is triggered the first time the threshold is crossed during a cycle. Subsequent threshold crossings do not trigger an event. Note: This property only applies to thresholds configured in My MATRIXX. You can override this configuration using the SubMan API AddThreshold requests. For more information, see the discussion about AddThreshold requests in MATRIXX Subscriber Management API.
Threshold Cycle	If Once Per Cycle is selected for either Threshold Cycle Notification Limit or Threshold Cycle Event Limit, Threshold Cycle defines the period over which the notification and event re-triggering applies: None — Only one notification/event is sent for this threshold during the balance lifetime. This is the default. Balance Cycle Aligned — The cycle used for the re-triggering of notifications and events is aligned with the balance cycle. This option does not display for simple balances. Billing Cycle Aligned — The cycle used for the re-triggering of notifications and events is aligned with the billing cycle.