Policy Rule Variables for Quotas, Quota Conventions, and Quota Objects

In addition to the basic policy rule variables, you can use the following variables to get quota-related information.

The format of a policy rule variable when used with a quota or quota convention is:

{object[.scope].attribute[.subAttribute[.divisor]]}

where:

object
An object or attribute described in Quota and Quota Convention Object Variables.
scope (optional)
Used to narrow or expand the object. Possible values are:
  • parent—For passes, all the passes that share the same name as the instance. For top-ups, all the top-ups associated with the plan with which that the top-up is associated.
  • lookupname—The next value is the name of the pass or plan to look up.
  • lookupgroup—The next value is the group of the pass (groups are not defined for plans).
  • best—Selects only the current pass or top-up (if available).
  • next—Selects only the next pass or top-up after the best.
attribute (required)
Possible values are:
  • name—Returns the current plan or pass name.
  • group—Returns the current pass group (groups are not defined for plans).
  • field—Returns custom or unknown fields delivered by the SPR.
  • expirationtime—Returns any defined expiration time for the best pass unless a scope value of next has been used.
  • purchasetime—Returns any defined purchase time for the best pass (unless a scope value of next has been used).
  • activationtime—Returns any defined activation time for the best pass (unless a scope value of next has been used).
  • count—Returns the number of passes or top-ups in the current selection scope.
The following attributes require the specification of a sub-attribute.
  • time—Returns the sum of the time attribute for the current passes or top-ups scope. This value can have a sub-attribute.
  • volume—Returns the sum of the volume attribute for the current passes or top-ups scope. This value can have a sub-attribute.
  • upvolume—Returns the sum of the input-volume (uplink-volume) attribute for the current passes or top-ups scope. This value can have a sub-attribute.
  • downvolume—Returns the sum of the output-volume (downlink-volume) attribute for the current passes or top-ups scope. This value can have a sub-attribute.
  • servicespecific—Returns the sum of the service specific attribute for the current passes or top-ups scope. This value can have a sub-attribute.
subAttribute
Allows limits/used/available to be specified for a counter. If a sub-attribute is defined, a divisor may also be defined. Possible values are:
  • limits—Returns the sum of all unit limits for all passes or top-ups in the current scop.
  • used—Returns the units used for the ACTIVE pass or top-up.
  • available—Returns the sum of all units available for all passes or top-ups in the current scope.
divisor
A number that tells the system to divide a result by a specified number. Allows values to be specified in higher-division units (days instead of seconds and megabytes instead of bytes).

Quota and Quota Convention Object Variables defines quota objects that can be used when creating policies that involve quotas and quota conventions.

Quota and Quota Convention Attribute Variables defines policy rule variables that can be used with quotas and quota conventions (passes, rollovers, and topups).