billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Initial CI Configuration

As shipped, the Customer Interface is not configured or enabled. This section describes how to get the CI working without any special configuration.

Click on the Settings link on the Navigation Bar. Click on the "CUSTOMER INTERFACE" button. The "Customer Interface Configuration" page will be displayed:

Figure 5.2. BillMax Customer Interface Configuration

BillMax Customer Interface Configuration


Unless otherwise specified, instructions to click on a button will refer to a button on this page.

Configuring the ciparms list

Click on the "GENERAL PARAMETERS" button. This will bring up the "ciparms list" page. This list contains multiple configuration parameters.

Figure 5.3. BillMax ciparms list - Part 1

BillMax ciparms list - Part 1


(1)

The ciparms list is a BillMax List and may be used as such. See Configuring Lists.

(2)

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.

(3)

Allow access to the Customer Interface through a Service in Closed State.

Figure 5.4. BillMax ciparms list - Part 2

BillMax ciparms list - Part 2


(1)

Allow existing Accounts to add a new Services.

(2)

Allow existing Accounts to add a new User and a new Service.

(3)

Allow new customers to register without supplying a credit card.

(4)

Allow access to the Customer Interface through a Service in Suspended State.

(5)

Allow access to the Customer Interface through a Service in Wait_For_Payment State.

(6)

Directory which contains the Registration Response templates for a successful registration. See the section called “Registration Responses”.

(7)

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.

(8)

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)

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.

(10)

On the machine hosting the web server that executes bmui.cgi, the webserver location of the templates.

(11)

On the machine hosting the web server that executes bmui.cgi, the webserver location of the images used by the templates.

(12)

On the machine hosting the web server that executes bmui.cgi, the webserver location of bmui.cgi.

(13)

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”.

(14)

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:".

(15)

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.

(16)

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:".

(17)

Password used between bmuid and bmui.cgi.

(18)

On the web server machine hosting bmui.cgi, the filesystem directory name where the templates reside.

(19)

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.

(20)

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.

(21)

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.

Figure 5.5. BillMax ciparms list - Part 3

BillMax ciparms list - Part 3


(1)

IP address of the BillMax server, i.e. the machine running bmuid.

(2)

On the machine hosting the web server that executes bmui.cgi, a temporary directory to which bmui.cgi is able to write.

(3)

Username used between bmuid and bmui.cgi.

(4)

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.

(5)

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.

(6)

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.

(7)

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".

(8)

Indicates whether or not a credit card number on file is required to add new Users or Services.

(9)

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.

(10)

Specify whether or not the customer has to supply, at a minimum, the service.d02 value (Service password) to gain access through the Customer Interface?

Final Steps for Initial CI configuration

After reviewing the ciparms List, do the following:

  1. Make sure that the ciparms value for accountwrite is a Authorized BillMax User with Accounting Write and Basic Read Permissions.

  2. Edit /usr/local/billmax/local/billmax.conf and change the setting for BMUID from NO to YES. This will cause bmuid to be stopped and started when normal nighttime BillMax processing occurs.

  3. Create the bmui.config by clicking the "GENERATE bmui.config".

  4. Install the necessary files on the machine hosting the web server. The files that need to be installed are:

    1. /usr/local/billmax/cgi-bin/bmui.cgi - copy to the web server cgi directory as specified by the value of ciparms cgipath.

    2. configfiledir/bmui.config where configfiledir is the value specified for ciparms configfiledir - copy to the web server cgi directory as specified by the value of ciparms cgipath.

    3. /usr/local/billmax/html/bmuitemplates/* - copy to the web server directory specified by the value of ciparms cgihtml.

    4. /usr/local/billmax/html/bmuitemplates/images/* - copy to the web server directory specified by the value of ciparms cgiimages.

  5. On the machine hosting the web server, edit the /etc/services and add the following entry:


    bmui            5023/tcp 

    This defines the port through which bmuid and bmui.cgi will begin communications. This entry was created in the /etc/services on the BillMax server when BillMax was installed. The value 5023 may be changed if desired, but must be changed on both the BillMax server and the machine hosting the web server. Any further references to the port will assume 5023 was used.

  6. If a firewall is between the BillMax server and the machine hosting the web server, make sure that the firewall allows traffic from the machine hosting the web server to pass through to the BillMax server using port 5023.

  7. On the BillMax server, execute /usr/local/billmax/billmax-admin start bmuid. This will cause bmuid to be started.

At this point, access to the BillMax customer self-maintenance interface is functional. In addition, customer self-registration is active, but nothing to sell has been configured.

Understanding the tabledefaults table

The last part of the BillMax self-maintenance model is understanding the tabledefaults table. This table contains both information for self-maintenance and for self-registration.

The tabledefaults table contains information that controls what data may be updated and viewed by existing customers, what data is required when a new customer registers, and other pieces of information that may be used to customize the customer experience and protect the BillMax server/database.

The tabledefaults table, is accessed by clicking the "TABLE DEFAULTS". This brings up the "Table Defaults for Online Registration" page which consists of the following:

Figure 5.6. BillMax Table Defaults for Online Registration

BillMax Table Defaults for Online Registration


(1)

The name of the database field and/or bmuitemplate form field. Not all values specified here need to be a database field.

(2)

A filter used to choose a record from tabledefaults table. Supplying the value for htmlfile is described in the section called “New Customer Self Registration”. "*" matches any value for htmlfile. If the desire is to use more than one htmlfile, all htmlfile will need to be specified for the fields in question and the "*" entries for the fields in question will need to be removed. The default value for htmlfile is "default". Note that this means that is any htmlfile desired other that "default" will require the removal of the "*" entry for that field.

(3)

The default value for a field. If non-NULL, this value is used when creating a new record. As an example, if htmlfile is "special", then the default value for the field SERVICE_price could be set to the special price. Note that the default may be used even if the field is not submitted by a bmuitemplate.

(4)

An override to the standard error message generated by BillMax. As an example, when a credit card is invalid, then a customized message may be displayed.

(5)

User specified sort order of entries. Used for display purposes.

(6)

Specify whether a field must be supplied by bmui.cgi to bmuid upon creation of a Account/User/Service triplet for a new customer. An example is requiring that SERVICE_d01 (the field in which BillMax stores login names) be supplied.

  • NO - Field is not required.

  • YES - Field is required.

(7)

Specify whether a field may be supplied by bmui.cgi to bmuid upon creation of a Account/User/Service triplet for a new customer. Using SERVICE_price as an example, in general SERVICE_price should not be allowed to be supplied as a customer could specify their own price for a service.

  • NO - Field may not supplied.

  • YES - Field may be supplied.

(8)

When updating the records of an existing customer, is a value for the field required.

  • NO - Value for the field is not required.

  • YES - Value for the field is required.

(9)

Specifies the customer's accessibility to the value specified by tabledefaults.field.

  • Neither - No access.

  • READ - Read-only access.

  • WRITE - Write-only access. Credit card number would be an example.

  • READWRITE - Read/Write access.


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