billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

lists — Default data for lists table

DESCRIPTION

The /usr/local/billmax/cfg/lists file contains the definitions for the standard BillMax Lists. The lists file is used by mklists populate the lists table and the listdef table. The lists file must be formatted in the following manner:

  • Each line must begin with one of the following strings:

    1. # - comment line

    2. LISTDEF - A list definition

    3. LISTREC - A list entry

  • A LISTDEF line consists of 9 fields separated by tabs. Each field must be present. Consecutive tabs are allowed. The fields are:

    1. LISTDEF - specifying a List definition line.

    2. List name.

    3. List description.

    4. List button title for display on the "Administer Lists" web page.

    5. The Permissions set of a Authorized BillMax User must intersect this set of Permissions to be able to view the List entries.

    6. The Permissions set of a Authorized BillMax User must intersect this set of Permissions to be able to modify the List entries.

    7. The Constraints used enforce data integrity for lists.value when entering a new item in a List. regexmacros list values are not allowed.

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

    9. Specifies whether entries in a particular list may be deleted.

      • 0 - list items may be deleted.

      • 1 - list items may not be deleted.

    10. Specifies whether the entries for lists.value for a particular List must be unique.

      • 0 - non-unique entries allowed.

      • 1 - entries must be unique.

  • A LISTREC line consists of 8 fields separated by tabs. Each field must be present. Consecutive tabs are allowed. The fields are:

    1. LISTREC - specifying a List entry line.

    2. List name.

    3. Inserted into the lists.value field.

    4. Inserted into the lists.descr field.

    5. A number specifying the sort order when displaying the List entries.

    6. Inserted into the lists.mutable field. If non-zero, the interpretation is that the entry may not be modified or deleted.

    7. The Constraints used to enforce data integrity for the lists.value for the specific entry when entering a new item in a List. regexmacros list are not allowed.

    8. Inserted into the lists.explanation field.

Example 4.6. List adcodes LISTDEFREC entry

	LISTDEFREC	adcodes	Values for the "Adcodes" list on the account page.	AD CODES	1	16	^[0-9]+$	0.00	0	1
					


Example 4.7. List adcodes LISTREC entry

LISTREC	adcodes	0	None	0.00	1		(1)
LISTREC	adcodes	1	Radio	1.00	1		
LISTREC	adcodes	2	TV	2.00	1		
LISTREC	adcodes	3	Magazine	3.00	1		
LISTREC	adcodes	4	Newspaper	4.00	1		
LISTREC	adcodes	5	Phonebook	5.00	1		
LISTREC	adcodes	6	Billboard	6.00	1		
LISTREC	adcodes	7	UseNET	7.00	1		
LISTREC	adcodes	8	Search Engine	8.00	1		
LISTREC	adcodes	9	Friend	9.00	1		
LISTREC	adcodes	10	Web	10.00	1		
LISTREC	adcodes	11	Seminars	11.00	1		
LISTREC	adcodes	12	Direct Mail	12.00	1		
					


(1)

Note that absence of a constraint or a mutable entry. However, there are 2 tabs at the end of the line.


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