billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 
billmax.conf
Prev  Chapter 4. Various BillMax files  Next

Name

billmax.conf — Various BillMax Settings

DESCRIPTION

The /usr/local/billmax/local/billmax.conf file is a shell style script that may be sourced to set up the BillMax environment. The purpose of billmax.conf is to set the values of variables. The values of these variables are then used by various BillMax programs. Most of these settings are used by billmax-admin.

The variable entries may be divided into four broad categories:

  1. Variables pertinent to the base functionality of BillMax.

    BILLMAXDIR

    The installation location of BillMax. Always /usr/local/billmax.

    PATH

    The directories in which needed executables are located. This is passed to the BillMax Hooks.

    HOME

    The installation location of BillMax. Always /usr/local/billmax.

    TERM

    A valid terminal. May be needed when executing a BillMax Hook.

    DB_SERVER, DB_DATABASE, DB_USER, DB_PASSWD, DB_SOCKET, DB_PORT

    Database connection parameters used in the operation of most BillMax processes.

    MYSQL_ADMIN_USER, MYSQL_ADMIN_PASSWD

    MYSQL system authentication used when stopping and starting MYSQL. Used when backing up the MYSQL database.

    MYSQLD, MYSQLD_START, MYSQLD_STOP

    If MYSQLD is set to YES, billmax-admin will execute the value for MYSQLD_START to start the Daemon for the MYSQL database and MYSQLD_STOP to stop the Daemon.

    MYSQLD_UP

    Command used to determine if the MYSQL Daemon is running.

    HTTPD, HTTPD_START, HTTPD_STOP

    If HTTPD is set to YES, billmax-admin will execute the value for HTTPD_START to start the Daemon for the web server and HTTPD_STOP to stop the Daemon.

    ECONTACT

    E-mail address for an emergency contact. Used by billmax-admin when it detects a severe failure.

  2. Variables for starting and stopping optional Daemons.

    RADIUSD, RADIUSD_START, RADIUSD_STOP

    If RADIUSD is set to YES, billmax-admin will execute the value for RADIUSD_START to start the Daemon for the capturing accounting RADIUS data and RADIUSD_STOP to stop the Daemon.

    RADMOND, RADMOND_START, RADMOND_STOP

    If RADMOND is set to YES, billmax-admin will execute the value for RADMOND_START to start the radmond Daemon for monitoring and killing terminal server sessions and RADMOND_STOP to stop the Daemon.

    RADMOND_USER, RADMOND_GROUP

    The commands to kill terminal server sessions will be executed on behalf of the specified UNIX user and group. If radmond is to be used, it is necessary to do the following:

    1. cd /usr/local/billmax/secure

    2. mkdir username - username is the value for RADMOND_USER.

    3. cd /usr/local/billmax/secure/username

    4. ln -s /usr/bin/at

    5. ln -s /usr/bin/atrm

    Please note that these instructions assume /usr/bin is the directory for at and atrm. If this is not the case, use the appropriate director for the ln commands.

    SAMBA, SMBD_START, SMBD_STOP, NMBD_START, NMBD_STOP

    If SAMBA is set to YES, billmax-admin will execute the value for SMBD_START and NMBD_START to start the Daemons for file sharing with Windows computers and SMBD_STOP NMBD_STOP to stop the Daemons.

    BMUID, BMUID_START, BMUID_STOP, BMUID_UP

    If BMUID is set to YES, billmax-admin will execute the value for BMUID_START to start the bmuid Daemon for supporting self management by the end-customer and BMUID_STOP to stop the Daemon. BMUID_UP is used to determine if bmuid is running.

  3. Variables that reference daily processes that may be run by billmax-admin.

    ACTION, ACTION_PROG

    ACTION and ACTION_PROG denote a keyword set recognized by billmax-admin. If ACTION is YES, then billmax-admin will execute ACTION_PROG. The ACTION and ACTION_PROG set are considered in the following order (only ACTION is listed):

    1. LOAD_DATACALL - Load RADIUS data records that may have been stored in a file when the MYSQL database was unavailable.

    2. CLOSEOFDAY - Run daily Account/User/Service processing for BillMax.

    3. CCDAILY - Run credit card processing.

    4. ECHDAILY - Run electronic check processing.

    5. MAKESTATEMENTS - Generate Summary lines for Accounts and create Statements for Accounts.

    6. SENDSTATEMENTS - E-mail, fax, or print the Statements created by MAKESTATEMENTS_PROG.

    7. BALCHECK - Validate the Summary records in the BillMax database.

    8. DBCK - Check the BillMax database for data errors.

  4. Miscellaneous variables.

    LOG_ROTATE

    A number. Files in /usr/local/billmax/logs with a ".gz" extension that have a modification date more than LOG_ROTATE days in the past are deleted.

    ISAM_ROTATE

    A number. Files in /usr/local/billmax/mysql/var with a ".gz" extension that have a modification date more than ISAM_ROTATE days in the past are deleted.

    MYSQLD_LOG_ROTATE_FREQUENCY

    weekly or daily. weekly occurs on Sundays. Only effective if MYSQLD_START contains the option "--log-update=filename". filename is compressed and renamed to include the current date and "*.gz".

    RUNHOOK_USER, RUNHOOK_GROUP

    The BillMax Hooks will be executed on behalf of the specified UNIX user and group.

Prev  Up  Next
Chapter 4. Various BillMax files  Home  ccbatch results
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