Base Package SQ Rules
SQ Algorithm | Alg Type | What It Does | Parameters Used |
---|---|---|---|
Bill days (Days) | DY | This SQ rule calculates the total number of days in the bill period. This algorithm is necessary if you have charges that are based on the number of days of service (e.g., a minimum charge that varies based on the days of service). Refer to Calculated Minimum Charges and Step Boundaries Based On The Number Of Days Of Usage And The Region In Which The Customer Resides for good examples of when to use such an SQ rule. | No parameters are used. |
Characteristic Value | CV |
This SQ rule creates an entry in the SQ array containing the sum of the characteristic values of a given Characteristic Type. The values are accumulated from the entity defined in the parameter list. Resulting Quantity (expressed in the Output UOM / Sub-UOM / SQI) = the sum of the characteristic values of a given Characteristic Type. Characteristic Source determines the entity that holds the characteristic values:
|
Param 1 = Characteristic Type Param 2 = Characteristic Source Param 3 = Minimum Value |
If Minimum Value is greater than zero and the resultant characteristic value is less than the specified Minimum Value, an error is generated. |
|||
Contract Quantity | CQ |
This SQ rule is used to create an entry in the SQ array for a given Contract Quantity Type specified in a contract. If multiple values are effective during a bill period, the Proration Rule determines what happens. (See below). Resulting Quantity (expressed in the Output UOM / Sub-UOM / SQI) = the value of a given Contract Quantity Type in a contract. If multiple values are effective during a bill period the Proration Rule determines what happens:
|
Param 1 = Contract Quantity Type Param 2 = Proration Rule: CQBD, CQED, CQMA, CQMI, CQPR |
|
|||
Direct Access Credits | CD |
This SQ rule creates a characteristic type / value to handle credits issued to the customer for participating in direct access. These values are used by one or more bill factors in the rate components to vary the amount associated with a given bill line. |
|
Early Pay | EP |
This SQ rule is only used if you provide customers with early payment discounts via a discount on their next bill segment. This rule works as follows:
|
Param 1 = Char Type - Number of Days Early Param 2 = Char Type - Eligible For Early Pay Disc Param 3 = Char Value - Eligible For Early Pay Disc |
This rules anticipates the early pay discount being levied using two rate components: |
|||
|
|||
Math | MA |
This SQ rule performs mathematical functions on service quantities prior to rate application. There are three major groups of parameters: 1) Quantity 1 (identified by a service quantity's UOM/Sub-UOM/SQI). 2) Mathematical operand 3) Quantity 2 (identified by a service quantity's UOM/Sub-UOM/SQI or a Bill Factor) For example, if you want to add together two SQ entries, these values would contain: 1) the unique identifier of one of the SQ's (in parameters 1 through 3) 2) the "+" symbol (in parameter 4) 3) the unique identifier of the other SQ (in parameters 5 through 7) It should be stressed that Quantity 2 can either reference a bill factor (param 8) or an SQ entry (parameters 5 through 7). If both are specified, the bill factor is used. The two default values (param 9 and param 10) are only used if Quantity 1 and/or Quantity 2 reference SQ's / bill factor that are not present at billing time. There are three ways to use these default values: |
Quantity 1: Param 1 = UOM of service quantity entry Param 2 = Sub-UOM of service quantity entry Param 3 = SQI of service quantity entry Or Param 9 = Decimal number Mathematical Operand: Param 4 = operand symbol (i.e., +, -, *, /) Quantity 2: Param 5 = UOM of service quantity entry Param 6 = Sub-UOM of service quantity entry Param 7 = SQI of service quantity entry Or Param 8 = Bill factor ID Or Param 10 = Decimal number |
The following mathematical operands use only Quantity 1. ABS, NEGATE, ROUND, FLOOR (meaning to round down), CEILING (meaning to round up), SIN, ASIN, COS, ACOS, TAN, ATAN, LOG, LOG10, EXP, EXP10, SQRT |
|||
The following mathematical operands use both Quantity 1 and Quantity 2: +, -, *, /, **, MOD, <, <=, >, >=, =, <>, MAX, MIN, AVG The following mathematical operands use both Quantity 1 and Quantity 2 and return a value of 1 if the comparison is true and a value of 0 if the comparison is false: <, <=, >, >=, =, <> |
|||
Maximum Service Quantity | MQ |
This SQ rule compares a quantity (either measured or created via a previous SQ rule) against a contract quantity and returns whichever is larger. Resulting Quantity (expressed in the Output UOM / Sub-UOM / SQI) = greater of quantity for UOM/ Sub-UOM/ SQI OR contract quantity for Contract Quantity Type |
Param 1 = UOM Param 2 = Sub-UOM Param 3 = SQI Param 4 = Contract Quantity Type |
Required UOM/TOU Validation | RP |
This SQ rule verifies if one UOM/Sub-UOM quantity is non-zero then the other should be non-zero too. UOM1/Sub-UOM1/SQI1 is the ID of the first SQ entry. UOM2/Sub-UOM2/SQI2 is the ID of the second SQ entry. |
Service Quantity ID1
Service Quantity ID2
|
Sum | SM |
This SQ rule adds up several quantities (either measured or created via a previous SQ rule). This algorithm would be useful when you need to add together "Sub-Unit of Measure" registers because there are charges in the rate that are for the total amount of consumption regardless of when it was used. Resulting Quantity (expressed in the Output UOM / Sub-UOM / SQI) = Quantity for UOM (in param 1) Sub-UOM (in param 2) SQI (in param 3) + Quantity for UOM (in param 4) Sub-UOM (in param 5) SQI (in param 6) + Quantity for UOM (in param 7) Sub-UOM (in param 8) SQI (in param 9) |
Quantity 1 Param 1 = First UOM Param 2 = First Sub-UOM Param 3 = First SQI Quantity 2 Param 4 = Second UOM Param 5 = Second Sub-UOM Param 6 = Second SQI Quantity 3 Param 7 = Third UOM Param 8 = Third Sub-UOM Param 9 = Third SQI |
For more information about defining algorithm types, refer to Setting Up Algorithm Types.
Where Used
A Rate Schedule may have zero or more SQ Rules. Refer to Rate Schedule - SQ Rules for more information.