BillMax Reference

Table of Contents

I. BillMax Executables

alterdb — Modify/Create a BillMax database

archivetable — Archive rows of a BillMax database table

billmax-admin — BillMax server control interface.

bmui.cgi — The client program for the Customer Interface

bmuid — Provide communication between bmui.cgi and BillMax

bxgcc — Prints the version of the gcc compiler

bxobj — Print the runtime root for BillMax binaries and create the runtime subdirectories if necessary.

bxos — Print information about the operating system on which BillMax is installed

bxroot — Print the root of the source directory for BillMax source code

bsd-killall — Send a signal to one or more programs referenced by program name

catlog.cgi — Print in HTML the contents of a file

ccbatch — Create credit card/EFT batch file

ccck.pl — Validate the construction of a credit card number

ccdaily.cybercash — Process credit card batch using Cybercash™

ccdaily.icverify — Process credit card batch using ICVerify™

ccnow.cgi — Process an Electronic Funds Processing transaction

ccparse — Import Electronic Funds Processing results into BillMax

ccpost — Process credit card transactions

ccpost.processor.type — Processor specify code

ccrun — Run credit card processing

ccsettle — Settle charges of an ICVERIFY™ credit card run

cgimenu — Generate the Customer Interface menu pane

chargeterm — Bill for one or more terms of a Service

closeofday — Run daily BillMax Account management processes.

close — Close an Account, a User, or a Service

computetax — Calculate the tax for a given amount.

convertpayhist — Convert a 1.5.x BillMax payhist table to a 2.0.x BillMax payhist table

create_applies — Create the payhist table Allocate records

createconfig — Create a configuration file from a List

createcust — Create an Account, User or Service

create_monthlysales — Populate the monthlysale table

crypt — Encrypt a string

cyberauthcap — Process a file of credit card transactions through the Cybercash processor

Process a single credit card transaction through the Cybercash processor — Process a single credit card transactions through the Cybercash processor

dbck — Database integrity check

dbenv — Generate a string suitable for accessing the BillMax database

dbread — Read a value from the BillMax database.

decrypt — Decipher account.ccnumenc

deposit — Create a Deposit Charge or a Deposit Refund

encrypt — Cipher account.ccnum and store result in account.ccnumenc

enter_account.cgi — Create or Modify a Account

enter_auth.cgi — Create or Modify a Authorized BillMax User

enter_calltrack.cgi — Create or Modify a Calltrack

enter_charge — Enter a Sale or a Store Credit for an Account

enter_listitem.cgi — Create or Modify a List Item

enter_payhist.cgi — Create or Modify a Payhist record

enter_payment — Enter a Payment for an Account

enter_refund — Record in BillMax that a Refund was made to an Account

enter_service.cgi — Create or Modify a Service record

enter_servicechange.cgi — Create or Modify a Service Change record. Execute a Service Change

enter_stat — Enter data samples for Usage Based Billing

enter_tierplan.cgi — Manage a Tierplan

enter_user.cgi — Create or Modify a User

genduedates — Populate payhist.duedate fields.

gentiermargins — Generate Tier Margins

graph — graph data from the stats table. Internal BillMax command.

hist — Output an abbreviated transaction history for an Account

invoice — Generate a Sale for a Service

license_install — Install the BillMax License

licenseinfo — Display BillMax license information

licensevalid — Validate and Display a BillMax license

loadenv — Output shell commands suitable to place table values into the process environment

machid — Print the MAC addresses of ethernet devices

make_statements — Creates customer Statements

makemysql — Create the mysql database

manualallocate — Manipulate/Create specific Allocation records

mkca — Load cgiaction table. Internal BillMax command.

mklists — Load a text file of List data into the lists table

move_service — Moves a Service from one User to another User

move_user — Moves a User from one Account to another Account

note — Inserts a Note for an Account

payhist_changeto_update — Modify payhist records for Service Change purposes

pwverify — Verify a password

radmond — Monitor data in datacall table and schedule termination jobs

radparse — Load data from RADIUS log files into datacall table

reopen — Reopen an Account, User, or Service

report_accrualsales — Generate different sales reports

report_aging — Generates an aging report

report_balancear — balances accounts-receivable.

report_balcheck — Validate and optionally repair Summary records

report_creditmemos — Generate report of Store Credits

report_custcount — Generate a customer count report

report_customsql.cgi — Execute an SQL command

report_datacall — Generate reports based on RADIUS data stored in datacall table

report_deposits — Generate reports of Deposit Charges billed and Deposit Charges paid

report_deposittrans — Generate report of Deposit Charges and Deposit Refunds

report_inactive — Generate report of applicable Services that have no recent data in datacall table

report_invoiceaging — Generate an aging report of Sales and Deposit Charges

report_liability — Generate a report of billings for service to be delivered in the future

report_marketing — Generate a report of Account marketing data

report_memorized.cgi — Execute a report stored in the Reports database

report_nightly.cgi — Display the different sections of output from running "billmax-admin nightly"

report_paymentallocs — Generate report of Allocations to Deposit Charges and Refunds

report_payments — Generate report of Payments or Refunds

report_revenue — Generate a report that may be used to indicate subscription Sales trends

report_salestax — Generate a Sales Tax report

report_timetrack — Generate report from timetrack table data

report_voids — Generate a report of Voids

report2csv.pl — Re-format a financial web page to a CSV download

runhook — Setuid wrapper for BillMax BillMax Hooks. Internal BillMax command.

search — Search for Accounts, Users or Services

send_statements — Send Statements to customers

service_update — Populate service.invday and service.invdate

statement — Output a Statement in ASCII text format

statement_xml — Output a Statement in XML format

summarize — Create a Summary record for an Account.

suspend — Change the State of an Account, User or Service to Suspended State

terminate-dist — Template for terminating a session

tree — Lists Users and Services associated with an Account. Alternatively verify the existence of a Calltrack

ua.cgi — Process a BillMax template

unalloctrans — Display unAllocated Financial Transactions

usage — Display un-billed usage data associated with Usage Based Billing for a Service.

version — Display the current version number for BillMax.

void — Void a voidable Financial Transaction

voidable — List Voidable Financial Transactions for an Account

1. libbillmax BillMax Library

libbillmax C Structures, Public Variables and Constants

ACCOUNT Routines

AUTH Routines

CALLTRACK Routines

CONFIG Routines

CUSTOMSQL Routines

DATACALL Routines

DATE Routines

DB Routines

ERROR Routines

FINANCIAL Routines

FINANCIALREPORT Routines

GLOBALCONF Routines

LIST Routines

MISC Routines

MONTHLYSALE Routines

NOTE Routines

PAYHIST Routines

REPORTING Routines

REPORTTABLES Routines

SALESTAX Routines

SERVDEF Routines

SERVICECHANGE Routines

SERVICE Routines

STATS Routines

TIERPLAN Routines

TIMETRACK Routines

USER Routines

UTIL Routines

2. libbillmaxpub Routines

BillMax_DataCipher — Return a ciphered string

BillMax_DataDecipher — Return a deciphered string

3. Database Schema

account table — table for Account data

answers table — table for Registration Response data

applylock table — table for Applylock data

auth table — table for Permissions data

calltrack table — table for Calltrack data

cgiaction table — table for CGI Action Files data

config table — table for Virtual Company data

customsql table — table for CustomSQL data

datacall table — table for Datacall data

datatopop table — table for Data to POP data

globalconf table — table for Globalconf data

listdef table — table for List Definition data

lists table — table for List data

monthlysale table — table for Monthlysale data

note table — table for Note data

notice table — table for Notice data

payhist table — table for payhist data

popdata table — table for POP Data data

reporttables table — table for Reports Table data

resources table — table for Resources data

salestax table — table for salestax data

servdef table — table for Service Definition data

servdefselection table — table for Service Definition Selection data

service table — table for Service data

servicechange table — table for servicechange data

stats table — table for Stats data

tabledefaults table — table for Table Defaults data

termservers table — table for Terminal Servers data

tier table — table for Tier data

tierplan table — table for Tierplan data

timetrack table — table for Timetrack data

user table — table for User data

4. Various BillMax files

billmax.conf — Various BillMax Settings

ccbatch results — Format of ccbatch results

ccsoft.conf — Defines different output and input for credit card processing

cgiaction files — Input for the cgiaction table

dbschema — BillMax Database Definition

Email Templates — Definition of Email Templates

lists — Default data for lists table

messages — Default message format for Customer Interface

messages — State files in /usr/local/billmax/logs

5. RADIUS related information

RADIUSD — Remote Authentication Dial In User Service Daemon - Customized for BillMax

billmax.attributes — Map RADIUS attributes to fields in BillMax datacall table

billmax.realms — Realms to Resource mapping

DICTIONARY — dictionary translations for parsing RADIUS requests

CLIENTS — RADIUS client/host to shared-secret mapping file

6. Miscellaneous

BillMax Default Lists

Lists that accessed via the LIST link

Customer Interface lists