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

Name

cgimenu, cgimenu_html — Generate the Customer Interface menu pane

Synopsis

/usr/local/billmax/bin/cgimenu

/usr/local/billmax/bin/cgimenu_html

DESCRIPTION

cgimenu and cgimenu_html are plug-ins used by bmui.cgi to generate the menu pane of the Customer Interface. cgimenu mimics the default behavior of bmui.cgi. cgimenu_html generates an HTML version of the menu pane.

All data is passed via environment variables.

Access using the Customer Interface is either at the Account level or the User level. If access is at the User level, then the Account related environment variables will not exist.

AVAILABLE ENVIRONMENT VARIABLES

For the following variables, "number" is used to order and make unique multiple variables representing the same type of entity, i.e. multiple Users.

Account related variables

FILLMENU_SVCLEVEL

LEVEL3ID

FILLMENU_SVCPARENT

LEVEL2ID

FILLMENU_ACCOUNT_KEY

account.number of the Account logged in.

FILLMENU_ACCOUNT_LABEL

account.number of the Account logged in.

User related variables

FILLMENU_USER_number_KEY

user.number of one User associated with the Account.

FILLMENU_USER_number_LABEL

The user.fname and user.lname.

Service related variables

"user" will be a the value of user.number to which the Service is associated.

FILLMENU_SERVICE_user_number_KEY

service.number of one Service associated with the User denoted by "user", the value of user.number.

FILLMENU_SERVICE_user_number_LABEL

The value of service.d01.

FILLMENU_SERVICE_user_number_DESC

The value servdef.descr for the Service.

Statement related variables

These variables are used to run the statement program to display to the end customer Statements as represented by Summary records.

FILLMENU_STMNT_number_KEY

payhist.number of one Summary record in payhist table.

FILLMENU_STMNT_number_LABEL

A label representing the date range of the Statement

General variables

FILLMENU_ALLOWNEWUSERSERVICE

  • YES - Allow customer to add a new User/Service pair.

  • NO - Do not allow customer to add a new User/Service pair.

FILLMENU_ALLOWNEWSERVICE

  • YES - Allow customer to add a new Service.

  • NO - Do not allow customer to add a new Service.

FILLMENU_SVCPARENT

LEVEL2ID

FILLMENU_SVCLEVEL

LEVEL3ID

FILLMENU_HTMLFILE

The bmui htmlfile parameter.

BMUI_CGILOC

Location of bmui.cgi relative to the web server.

BMUI_HTML

Location of Customer Interface HTML files relative to the web server.

BMUI_IMAGES

Location of Customer Interface image files relative to the web server.

RETURN VALUE

0 for success.

NOTES

NONE

SEE ALSO

bmui.cgi

Prev  Up  Next
ccsettle  Home  chargeterm
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