billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 
enter_tierplan.cgi
Prev  BillMax Executables  Next

Name

enter_tierplan.cgi — Manage a Tierplan

Synopsis

/usr/local/billmax/bin/enter_tierplan

DESCRIPTION

using enter-tierplan.cgi, you may add, delete, modify or clone a Tierplan as well as add or delete Tiers.

REQUIRED ENVIRONMENT VARIABLES

Different environment variables are required for different values of FORM_action. The first table documents environment variables associated with the Tierplan. The second table documents environment variables associated with a Tier

[Note] Note

Both sets of variables are required when calling enter_tierplan.cgi.

Table 1. Tierplan Variables. Variables required for FORM_action SAVE, CLONE, DELETE or INSERT.

FORM_action - GEV_STRING

Valid Values

  1. SAVE

  2. CLONE

  3. DELETE

  4. INSERT

  5. RMTIER

FORM_number - GEV_INT

System Identifier for a database row. In most cases automatically generated. Allowable range is 1-2147483647.

FORM_descr - GEV_STRING

Usage Plan Name.

FORM_method - GEV_INT

Computational method used to determine Usage Based Computation Result See Tierplan Valid Values.

FORM_direction - GEV_INT

Statistics recorded in the stats table may represent a direction measurement by using a Named Samples. An inbound static is denoted by "in='value'". An outbound statistic is denoted by "out='value'". Both directions may be recorded in the stats table using the form in='value',out='value'. Computations may be based based on in values, out values, the larger of the two values, or the sum of the in and out values. Choose Not Applicable when using the Sum computation method.

FORM_percentile - GEV_INT

Used for the Percentile computation method.

FORM_datapurge - GEV_INT

The number of elapsed days before the applicable statistics are automatically purged from the stats table.

[Warning] Warning

The applicable statistics are purged even if they have not been used for a Usage Based Computation Result

FORM_units - GEV_STRING

The units of measurement captured in the stats table.

[Warning] Warning

This is for descriptive purposes only. Specifying units such as MB and capturing the data in another such as Mb will cause incorrect billing and confusion

FORM_stype - GEV_STRING

A description of the type of sample. This links the type of sample specified here with statistics entered in the stats table using enter_stat with the stype parameter set to the value specified here.

Example 2. Examples for the field stype

  1. Bandwidth Usage

  2. account states

  3. new calltracks


FORM_reportfreq - GEV_INT

Usage report for a Service may be mailed to the email address of the Account every reportfreq days. The last previous date a usage report was sent is stored in the bwreportdate field of the service table

FORM_cangodown - GEV_CHECKBOX

Species whether the usage for a Service with a Usage Based Billing plan can be billed at a lower-priced Tier after having been billed at a higher-priced Tier.

FORM_style - GEV_INT

0 - Tier Plan Style Step. 1 - Tier Plan Style Linear

FORM_linearfree - GEV_DOUBLE

Used when the Linear style Tierplan is selected. Pricing is computed by multiplying linearprice and (Usage Based Computation Result minus linearfree). Ignored when the Step style Tierplan is selected.

FORM_linearprice - GEV_DOUBLE

Used when the Linear style Tierplan is selected. Pricing is computed by multiplying linearprice and (Usage Based Computation Result minus linearfree). Ignored when the Step style Tierplan is selected.


Table 2. Tier variables required for FORM_action INSERT

FORM_top - GEV_DOUBLE

The top value for this Tier The price from this Tier will not be used if the Usage Based Computation Result exceeds this value. The price from this Tier will be used if the Usage Based Computation Result is less than this top value and not less the top value of any other Tier belonging to the same Tierplan

FORM_price - GEV_MONEY

The price associated with this Tier


Table 3. Variables required for FORM_action RMTIER

FORM_tier - GEV_INT

System Identifier for a database row. In most cases automatically generated. Allowable range is 1-2147483647.

FORM_number - GEV_INT

System Identifier for a database row. In most cases automatically generated. Allowable range is 1-2147483647.


RETURN VALUE

System value EX_OK for success.

NOTES

NONE

SEE ALSO

tierplan table tier table

Prev  Up  Next
enter_stat  Home  enter_user.cgi
Document Revision A for BillMax 2.2.0   -   Copyright © 1997-2006 The iSpark Group, Inc.

All rights reserved. No part of this documentation may be reproduced or transmitted in any fashion without written permission by The iSpark Group, Inc. This documentation is for the sole use of licensees of the BillMax billing software created by The iSpark Group, Inc. Making the documentation available to a non-licensee of BillMax without written permission of The iSpark Group, Inc. is a violation of the use of this documentation.

While precautions have been taken in the preparation of this documentation, The iSpark Group, Inc. assumes neither liability nor responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.

All terms mentioned that are known to be trademarks have been appropriately capitalized. Use of the a trademark does not affect the validity of any trademark or service mark.

Links to third-party Web sites are provided for convenience. The iSpark Group, Inc. is not responsible for any content contained in the third-party Web sites.

Comments about this documentation may be sent to doc@billmax.com