billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

ciparms list — General Parameters for the Customer Interface

LIST ATTRIBUTES

[Note] Note

The values in this list need not be unique. The entries may not be deleted.

Table 6.25. ciparms List Attributes

Attribute Explanation
Value Constraint
Attribute Explanation
Value Constraint
cginewfrmok Message to be displayed whenever customer data is successfully updated. This value is substituted for the tag "##Dgeneralmessage#" in the CI template updatesuccess.tmp. See the section called “Advanced CI topics”. Only used when cgirefreshform is NO.
   
cgirefreshok Message to be displayed whenever customer data is successfully updated. This value is substituted for the tag "##Dgeneralmessage#" in the template that is refreshed. See the section called “Advanced CI topics”. Only used when cgirefreshform is YES.
   
cgirefresherr Message to be displayed whenever customer data is unsuccessfully updated due to input error. This value is substituted for the tag "##Dgeneralmessage#" in the template that is refreshed. See the section called “Advanced CI topics”. Only used when cgirefreshform is YES.
   
emailalerts Send email alerts when system errors occur to the administration contact of the Virtual Company to which an existing customer belongs or to which a new customer is attempting to register. If Virtual Company cannot be determined, the email is set to "root".
YES ^YES$|^NO$
configfiledir Directory in which to put the bmui.config file on the BillMax server. This file should then be copied to the same directory as bmui.cgi on the machine hosting the web server that executes bmui.cgi.
/usr/local/billmax/tmp  
cgirefreshform Used when updating data in an existing account. If YES, the form used to collect the data is refreshed with data or error messages. If NO, then the Customer Interface template updatesuccess.tmp is displayed.
YES ^YES$|^NO$
cgitmpdir On the machine hosting the web server that executes bmui.cgi, a temporary directory to which bmui.cgi is able to write.
/tmp  
cgibsh On the machine hosting the web server that executes bmui.cgi, the filesystem name of the Bourne shell. Used when executing the program specified by cgimenu.
/bin/sh  
cgimenu On the machine hosting the web server that executes bmui.cgi, the filesystem name of a program that will generate the left hand navigation pane of the Customer Interface. See the section called “Replacing the CI Tree Pane”.
   
cgiimages On the machine hosting the web server that executes bmui.cgi, the webserver location of the images used by the templates.
/bmuitemplates/images  
cgiloc On the machine hosting the web server that executes bmui.cgi, the webserver location of bmui.cgi.
/cgi-bin/bmui.cgi  
cgidefault The default basename of the template that bmui.cgi will display if run with no arguments. ".tmp" will be appended to this value to determine the actual filename.
authenticate  
cgihtml On the machine hosting the web server that executes bmui.cgi, the webserver location of the templates.
/bmuitemplates  
cgipath On the web server machine hosting bmui.cgi, the filesystem directory name where the templates reside.
/usr/local/billmax/html/bmuitemplates  
cgiserverip IP address of the BillMax server, i.e. the machine running bmuid.
127.0.0.1  
answerdir Directory which contains the Registration Response templates for a successful registration. See the section called “Registration Responses”.
/usr/local/billmax/regconf
allowsuspendaccess Allow access to the Customer Interface through a Service in Suspended State.
NO ^YES$|^NO$
allowwaitaccess Allow access to the Customer Interface through a Service in Wait_For_Payment State.
NO ^YES$|^NO$
allowcloseaccess Allow access to the Customer Interface through a Service in Closed State.
NO ^YES$|^NO$
chargenewservice If an existing Account paying by credit card or bank draft has added a new Service, collect the funds immediately if applicable for the BillMax installation. Note, only the amount billed for the new Service will be collected.
YES ^YES$|^NO$
chargenewaccount If a new Account has registered and has chosen to pay by credit card or bank draft, collect the funds immediately if applicable for the BillMax installation.
YES ^YES$|^NO$
allownewuserservice Allow existing Accounts to add a new User and a new Service.
YES ^YES$|^NO$
allownoncc Allow new customers to register without supplying a credit card.
NO ^YES$|^NO$
allownewservice Allow existing Accounts to add a new Services.
YES ^YES$|^NO$
newnoncc Indicates whether or not a credit card number on file is required to add new Users or Services.
NO ^YES$|^NO$
accountwrite The Authorized BillMax User to be used when entering payments from credit card/bank draft processing through the Customer Interface. This Authorized BillMax User must have Accounting Write and Basic Read Permissions.
test ^[a-zA-Z0-9]+$
numfields The number of security fields the customer must successfully match to gain access through the Customer Interface. The security fields consist of the service.d02, user.dob, user.ssn, user.maiden, user.dlnumber, user.dlstate and user.custsecret.
1 ^[1-9]$
passreq  
YES ^YES$|^NO$
cgipass Password used between bmuid and bmui.cgi.
pass1 ^[a-zA-Z0-9]+$
cgidebuglvl Diagnostic printout mask. The following values may be added together to create a mask:
  • 1 - DEBUG_TRACE

  • 2 - DEBUG_CONFIG

  • 4 - DEBUG_LOOKUPS

  • 8 - DEBUG_FILTERS

  • 16 - DEBUG_FIELDS

  • 32 - DEBUG_AUTH

  • 64 - DEBUG_SERVDEFS

  • 128 - DEBUG_EXTOUT

  • 256 - DEBUG_EXTSTATUS

  • 512 - DEBUG_ERRORHANDLING

  • 1024 - DEBUG_ENV

  • 2048 - DEBUG_DATACALL

  • 4096 - DEBUG_CIPHER

  • 8192 - DEBUG_SQL

  • 16384 - DEBUG_IO

  • 32768 - DEBUG_FILLMENU

  • 65536 - DEBUG_FILLTAGS

Specify "-2" to turn on all diagnostic output. Specify "-1" as a shortcut to "DEBUG_TRACE+DEBUG_FIELDS+DEBUG_EXTOUT+DEBUG_CONFIG+DEBUG_SERVDEFS+DEBUG_FILTERS+DEBUG_LOOKUPS+DEBUG_AUTH". This setting will cause bmuid to write diagnostic output to /tmp/bmuid.XXXXXX and bmui.cgi to write diagnostic output to /tmp/bmui.XXXXXX where XXXXXX is determined at the time of file creation.
-9  
cgiuser Username used between bmuid and bmui.cgi.
user1 ^[a-zA-Z0-9]+$
cginewfrmdaterr Message to be displayed whenever customer supplied data is invalid. This value is substituted for the tag "##Dgeneralmessage#" in the CI template error.tmp. See the section called “Advanced CI topics”. The default verbiage is "Your submission failed due to an error in your input. Please correct the error and re-submit. Specifics on the error are shown below:".
   
cginewfrmsyserr Message to be displayed whenever a system error occurs. This value is substituted for the tag "##Dgeneralmessage#" in the CI template error.tmp. See the section called “Advanced CI topics”. The default verbiage is "A system error occurred. Specifics on the error are shown below:".
   


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