X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS.pm;h=16845fac141957841b46db0e1dd7727f02581190;hp=2b86b6150ff6b866a74ed93541ed4b356d62877a;hb=HEAD;hpb=19f2731dbceb444c5dd45f57fb0a785dcaf9aa65 diff --git a/FS/FS.pm b/FS/FS.pm index 2b86b6150..16845fac1 100644 --- a/FS/FS.pm +++ b/FS/FS.pm @@ -3,7 +3,7 @@ package FS; use strict; use vars qw($VERSION); -$VERSION = '%%%VERSION%%%'; +$VERSION = '5.0~git'; #find missing entries in this file with: # for a in `ls *pm | cut -d. -f1`; do grep 'L' ../FS.pm >/dev/null || echo "missing $a" ; done @@ -39,6 +39,8 @@ L - Package representing the current user L - Non OO-subroutines for the web interface. +L - Locales + L - Message catalog L - Search cache @@ -51,7 +53,7 @@ L - Report data objects L - Report data objects -L - Backend XML::RPC server +L - Backend XML::RPC server L - Miscellaneous subroutines @@ -65,6 +67,8 @@ L - Customer searching L - Batch customer importing +L - Batch contact importing + =head2 Database record classes L - Database record base class @@ -85,6 +89,8 @@ L - Mixin class for records in tables that contain payinfo. L - Employees / internal users +L - Access sessions + L - Employee preferences L - Employee groups @@ -95,6 +101,10 @@ L - Group reseller access L - Access rights +L - Installers / schedulable resources + +L - Installer/resource availability + L - POP (Point of Presence, not Post Office Protocol) class @@ -122,7 +132,9 @@ L - External mail account class L - Time worked application to account class -L - RADIUS groups +L - RADIUS user group membership + +L - RADIUS groups L - Domain class @@ -150,12 +162,18 @@ L - DSL, wireless and other broadband class. L - DSL +L - DSL device MAC addresses + L - DSL order notes L - Address block class L - Router class +L - Tower class + +L - Tower sector class + L - Broadband virtual field class L - Phone service class @@ -166,6 +184,18 @@ L - Device definition class L - Phone number availability cache +L - LATA number to name mapping class + +L - MSA number to name mapping class + +L - Rate center list (for bulk DID orders) + +L - Bulk DID order vendor class + +L - Bulk DID order class + +L - Bulk DID order item class + L - Call Detail Record class L - Call Detail Record batch class @@ -180,14 +210,44 @@ L - Externally tracked service class. L - PBX service class +L - PBX extension class + +L - PBX device class + L - Certificate service class +L - Dish network service class + +L - Cable service class + +L - Cable-modem model class + +L - Cable provider class + +L - Alarm service class + +L - Alarm system class + +L - Alarm type (inputs and outputs) class + +L - Alarm central station class + +L - Conferencing service class + +L - Conferencing type class + +L - Conferencing quality class + +L - Video (IPTV/video-on-demand) service class + L - Inventory classes L - Inventory items L - Service definition class +L - Service class class + L - Column constraint class L - Class linking service definitions (see L) @@ -203,6 +263,16 @@ L - Package class class L - Package definition class +L - Package definition localization class + +L - Package definition usage pricing add-on class + +L - Customer package usage pricing add-on class + +L - Package definition local currency prices + +L - Currency exchange rates + L - Package definition link class L - Tax class class @@ -232,10 +302,22 @@ L - Rate region prefixes for call billing L - Rate plan detail for call billing +L - Rate tiers for call billing + +L - Rater tier details for call billing + L - Usage class class +L - Sales person class + +L - Sales person package class commission class + L - Agent (reseller) class +L - Agent (reseller) currency class + +L - Agent (reseller) package class commission class + L - Agent type class L - Class linking agent types (see L) with package definitions (see L) @@ -248,17 +330,23 @@ L - Agent payment gateway class L - Service class +L - Export hostname choice class + +L - Customer export hostname class + L - Customer package class L - Customer package option class L - Customer package details class -L - Customer package discount class +L - Customer package discount class + +L - Customer package discount line item application class -L - Customer package discount line item application class +L - Discount class -L - Discount class +L - Discount class class L - Reason type class @@ -266,6 +354,8 @@ L - Reason class L - Package reason class +L - Contact class class + L - Contact class L - Contact phone class @@ -284,12 +374,16 @@ L - Customer real-time billing class L - Customer packages class +L - Customer payment information class + L - Customer location class L - Mixin class for records that contain fields from cust_main L - Invoice destination class +L - Customer credit limit events class + L - Customer classification class L - Customer category class @@ -302,6 +396,8 @@ L - Customer tax exemption class L - Customer note class +L - Customer note classification class + L - Banned payment information class L - Invoice class @@ -312,9 +408,7 @@ L - Invoice line item class L - Invoice line item detail class -L - (Old) Invoice event definition class - -L - (Old) Completed invoice event class +L - Legacy data invoice class L - (New) Billing event definition class @@ -356,6 +450,8 @@ L - Credit application to invoice class L - Line-item specific credit application to invoice class +L - Line-item sources for triggered package credits + L - Refund application to payment class L - Credit card transaction queue class @@ -376,6 +472,8 @@ L - Job arguments L - Job dependencies +L - Job statistics + L - Message templates (customer notices) L - Message catalogs (error messages) @@ -404,17 +502,27 @@ L - Historical account objects L - Historical broadband connection objects +L - Historical certificate services + +L - Historical Dish Network services + L - Historical domain objects +L - Historical DSL objects + L - Historical externally tracked service objects L - Historical mail forwarding alias objects +L - Historical isntalled hardware service objects + L - Historical mailing list objects +L - Historical PBX objects + L - Historical phone number objects -L - Historical PBX objects +L - Historical port number objects L - Historical web virtual host objects @@ -424,6 +532,8 @@ L - Self-service API L - Self-service XML-RPC API +L - Backoffice XML-RPC API + =head2 User Interface classes L - Web user-interface class @@ -432,43 +542,91 @@ L - Byte counter user-interface class =head2 Command-line utilities +=head3 Setup and upgrade + L - Command line interface to add (freeside) users. +L - Recreate database schema cache + +L - Create new database + +L - Upgrades database schema for new freeside verisons. + +L - Seed LATA data + +L - Seed MSA data + +=head3 Cron + L - Run daily billing and collection events. L - Run monthly billing and invoice collection events. -L - Recreate database schema cache +=head3 Cron (payment batches) + +L - Download EFT Canada batch results + +L - Upload an EFT Canada batch + +L - Download Chase Paymentech batch results + +L - Upload a Chase Paymentech batch + +=head3 Usage + +L - Download and import CDR files -L - Command line interface to delete (freeside) users. +L - Download usage data from IPifony -L - Emails notifications of credit card expirations. +=head3 Misc. Tools (retreiving data) L - Prints email addresses of all users on STDOUT -L - Send a freeside page to a list of employees. +L - List all usernames in the sytem -L - Real-time daemon for prepaid packages +L - List all phone numbers in the system + +=head3 Misc. Tools (taking actions) L - Removes stray applications of credit, payment to bills, refunds, etc. -L - Job queue daemon - -L - Command line utility to manipulate radius groups +=head3 Services L - Command line tool to re-trigger export jobs for existing services L - Command line tool to set the fixed columns for existing services -L - Command line tool to eliminate duplicate usergroup entries from radius tables +=head3 RADIUS -L - Real-time radacct import daemon +L - Command line utility to manipulate radius groups + +L - Command line tool to eliminate duplicate usergroup entries from radius tables L - Command line interface to reset and recreate RADIUS SQL tables L - Command line time-online tool -L - Upgrades database schema for new freeside verisons. +=head2 Daemons + +L - CDR daemon + +L - Real-time CDR rating daemon + +L - CDR rewriting daemon + +L - Real-time daemon for prepaid packages + +L - Job queue daemon + +L - Self-service server + +L - Self-service XML-RPC server + +L - Real-time radacct import daemon + +L - Torrus virtual port combining daemon + +L - Back-office XML-RPC server =head1 Notes @@ -484,33 +642,29 @@ http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out. Freeside is a billing and administration package for wired and wireless ISPs, VoIP, hosting, service and content providers and other online businesses. -The Freeside home page is at . +The Freeside home page is at . -The main documentation is at . +The main documentation is at . =head1 SUPPORT A mailing list for users is available. Send a blank message to - to subscribe. + to subscribe. A mailing list for developers is available. It is intended to be lower volume and higher SNR than the users list. Send a blank message to - to subscribe. - -Commercial support is available; see -. + to subscribe. -=head1 AUTHORS +Commercial products and services are available; see + and . -Primarily Ivan Kohler, with help from many kind folks, including core -contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen. +=head1 AUTHORS AND CONTRIBUTORS -See the CREDITS file in the Freeside distribution for a (hopefully) complete -list and the individal files for details. +See httemplate/docs/credits.html =head1 SEE ALSO -perl(1), main Freeside documentation at +perl(1), main Freeside documentation at =head1 BUGS