billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 
CI Functions
Prev  Chapter 5. Configuring the BillMax Customer Interface  Next

CI Functions

In order to facilitate the discussion, the concept of CI templates is presented here.

The browser interface presented to the customer is governed by HTML-like templates called CI templates. These are HTML files located on the public web server that are processed by bmui.cgi. The result is sent to the customer browser.

References to a file such as defaultphone.tmp indicates the CI template defaultphone.tmp installed in the proper location on the public web server. See the section called “Advanced CI topics”.

References to a CI template prepended with the word "processed" indicate a CI template that has been processed by bmui.cgi.

New Customer Self Registration

This is the process whereby a new customer registers and orders a new Service for the first time. This is done using either a web browser, a CD signup product or a browser within a CD signup product. The process using a web browser or browser within a CD signup product is described here.

The process begins with the customer accessing a URL that executes the bmui.cgi with the parameter "op=register" supplied to the bmui.cgi. For example: "http://www.customerbillmaxsite.com/cgi-bin/bmui.cgi?op=register". This may be accomplished by a customer clicking on a registration link on the public web server. It may also be accomplished by a CD signup that directs the customer to the URL. When this occurs, the following takes place:

  1. The new customer is presented with the processed defaultphone.tmp template. The page is used to collect information that may be used to determine which Services to offer the customer and (in the case of an Internet Service Provider), what POP information may be sent back to configure the customer's computer for dialup and email access.

    [Tip] Tip

    If collecting this information is unnecessary for your business process, simply replace defaultphone.tmp with altdefaultphone.tmp. This is done by making a backup copy of defaultphone.tmp and then copying altdefaultphone.tmp to defaultphone.tmp.

  2. Upon submission of the phone template, the customer is presented with the processed defaultregform.tmp template. This page is used to collect customer contact information, payment information, and the Service to purchase. Upon submittal, the system will validate the input and, if OK, add the new Account, User, and Service to BillMax. The system will also perform Electronic Funds Processing if it has been configured to do so.

  3. If the process is successful up to this point, a results file will be presented to the browser or the CD signup product. This file may be an HTML file showing the registration was successful or a file specific to CD sign up software.

In order for the customer to add more Services, they must then use the self-maintenance function.

There are two other parameters to bmui.cgi that govern it behavior during registration. These are:

  • client - client indicates what client software is driving the registration process. This is used to determine what Registration Response will be sent back to the registration client. For example: "http://www.customerbillmaxsite.com/cgi-bin/bmui.cgi?op=register&client=abc" indicates that the client software "abc" is being run. Please see the section called “Registration Responses” to see how this parameter is used.

  • htmlfile - htmlfile indicates what templates to process and display to the customer. The default for htmlfile is "default". In the preceding discussion, the defaultphone.tmp was used. If "http://www.customerbillmaxsite.com/cgi-bin/bmui.cgi?op=register&client=abc&htmlfile=specialprice", then templates prepended with "specialprice", such as specialpricephone.tmp will be used if they exist. If they don"t exist, then files with "default" prepended will be used. This is a technique that may be used to brand special offers. htmlfile is also used by bmuid to dictate tabledefaults table usage. Please see the section called “Understanding the tabledefaults table”.

Current Customer Self Maintenance

This is the process whereby an existing customer views or edits their Account, User or Service information. This is also the process by which a customer may subscribe to new Services.

The process begins with the customer accessing a URL that executes the bmui.cgi without "op=register" supplied to the bmui.cgi. For example: "http://www.customerbillmaxsite.com/cgi-bin/bmui.cgi". This may be accomplished by a customer clicking on a self-maintenance link on the public web server.

[Note] Note

client is not applicable for self-maintenance. Do not include it in the self-maintenance URL. htmlfile is applicable to self-maintenance. It is only effective when adding a new Service or a new User/Service to an existing Account.

The following happens when the self-maintenance system is accessed:

  1. The customer is first presented with the processed authenticate.tmp template. The page gathers information from the customer for authentication purposes. Typically the customer must enter their login name and password from a Service. However, the CI may be configured to accept other authentication information.

  2. After successful authentication, the resulting display depends on what Service was used to access the CI. If the Service belongs to a special User that is the designated by the Account as the "Controlling" User, then the display includes access to Account information. If the Service does not belong to the "Controlling" User, the only the User information for that Service is accessible. In addition, all information for the Services that belong to the User is available.

When logged in, the customer is presented with a web page with two frames. By default, the left frame contains a tree structure showing the Account's Users and Services. The tree contains links for viewing and editing data as well as adding new Services. When the customer clicks a link in the tree, a page with information about that Account element (User or Service) displays in the right frame. The customer can add a new User or Service. The customer will be presented with the defaultnewuser.tmp or the defaultnewsrvc.tmp.

[Tip] Tip

The tree structure is replaceable. See the section called “Replacing the CI Tree Pane”.

Prev  Up  Next
System Architecture  Home  Initial CI Configuration
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