Some users have been asking for a more comprehensive usage document
for citrusdb.  I've posted this outline to the issue tracker
(http://bugs.citrusdb.org/view.php?id=213), but also wanted to put it
up here and see what everyone thinks about this outline.  Is this the
kind of usage info you are looking for?  Are there other sections that
you think should be included?

About half of this outline already exists in the help documentation,
though I would like to expand on some of it with examples, and the
rest would be brand new information, some things I don't even have any
method worked out yet, like importing Radius or Call Detail Records,
but it should be possible.

Paul


--- cut from document below ---


CitrusDB Usage Manual

This manual provides instructions for normal day-to-day usage of the
features of citrusdb.

Introduction
        
        What is CitrusDB

        CitrusDB is an open source customer service and billing database.  It
can be used by customer service personnel to provide sales and support
to customers and by billing staff to send invoices and credit card
batches for the customer's service fees.

        Requirements

        (off the website)

        Installation of LAMP or WAMP or MAMP

        There are many methods to install Apache MySQL and PHP on your chosen
platform.  I am only going to cover some of the more common ones:
Installing AMP in a Debian/Ubuntu Linux Distro,, Installing an all in
one solution like XAMP in Windows or Mac OS X, and  Installing AMP by
compiling the packages it for any Unix.  While compiling it manually
will  not be the fastest way, it gives you the most flexibility and
allows you to add other modules and features that may not be included
in the default packages.

        Installation of CitrusDB Internal
        Installation of CitrusDB Online

Upgrading CitrusDB

Initial Setup of CitrusDB
        General Info
        Users
                Adding New Users
                Editing Users
                User Classes
                        Normal
                        Manager
                        Administrator

        Billing
                Default Types
                Adding New Types
                        Recurring
                        One Time
                        Free
                Removing Billing Types
                Holidays

        Services
                Types of services
                        One-Time Services/Charges
                                Setup and Install Fees
                        Recurring Services
                        Taxes & Fees
                                Fixed or Percentage
                                Linking Taxed Services
                        Service Options (attributes)
                        Bundled Services (linked services)
                        Services with Measured Costs/Usage
                                Hourly, Megabytes, Etc.
                        Products and Physical Goods
                        Billing ID's
                        
        Searches
                Default Searches
                Adding New Searches
                Examples of Searches

Customer Service
        Searching for Customers
        Adding New Customers
        Editing Customer Records
        Editing Billing Records
        Adding New Services
                Choosing services from the list
                        Service Categories
                        Credit
                        Prorate
                        Automatically adds linked services
        Editing Services
        Service History
        Adding Support Notes
        Customers with Multiple Billing Types
        Customer Billing Status
        Reading Support Notes
                Sent To You or Your Group
                On the Customer Record
        Reading Billing & Payment Records
        Re-Billing Credit Cards or Invoices
        Canceling A Customer
                Un-Canceling A Customer

Managing Services
        Activate and Deactivate Services
                Export data and using scripts
        Sending welcome letters

Billing
        While you do not have to bill every workday, daily billing will help
with cash flow and keeps the daily workload even.  You can use
holidays or the pro-rate service to move billing into different
billing day cycle, such as the 1st or 15th of each month.
        Daily credit card batches
        Daily invoice printing
        Daily e-invoice emailing
        Entering Invoice Payments
        Importing New Accounts
        Importing Service Usage
        Importing Credit Card Changes
        Past Due Report
        Credit Card Declined Report
        Invoice Maintenance

Reporting
        Customer Summary
        Revenue Report
        Past Due Report
        Recent Declines

Administration
        Security
        Backing Up

Module Building
        Module Requirements
        Installing Modules
        Example Module

Data Import/Export Formats
        Credit Card Batch Exports
        Credit Card Batch Imports
        New Accounts Data
        Service Usage Data
                Radius
                Call Detail Records
        Credit Card Changes

Automation Scripts
        New Account Activation
        Billing Credit Cards
        Printing Invoices
        Emailing Invoices

Online Resources
        Mailing Lists
        Websites

-- 
The CitrusDB Project | http://www.citrusdb.org
Open Source Customer Care & Billing System

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys-and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Citrusdb-users mailing list
Citrusdb-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/citrusdb-users

Reply via email to