BANAL 0.10 - Quickstart Guide

BANAL 0.10 - Quickstart Guide

Matthew Rice - matt@starnix.com

Starnix Inc.

August 2000

Table of Contents

1: Installing BANAL

1.1: Installing RPMs

1.2: Installing from a tarball

2: Starting BANAL

3: Initial Configuration

3.1: Changing Editors

3.2: Running the Client

3.3: Adding Your Company Information

4: Getting Help on Commands

5: Some Tips



This file serves as the method to get you started using banal.

1: Installing BANAL

Download either the RPMs or the tarball from:
http://www.starnix.com/banal/dl/

1.1: Installing RPMs

As root, simply run the command:
rpm -ivh banal-*

This will install both the client and server RPMs. You can install just the client RPM on other machines (but you'll have to set the BKPORT environment variable.

If you see a warning like "chkconfig: command not found", then you'll have to put the links from /etc/rc.d/init.d/banal to the various runlevels.

The following commands (as root) should do the trick:

ln -s ../init.d/banal /etc/rc.d/rc{3,4,5}/S95banal
ln -s ../init.d/banal /etc/rc.d/rc{0,1,2,6}/K05banal

If you have no books setup, an empty set will be placed in:

/home/banal/books

1.2: Installing from a tarball

NOTE: This won't be as complete a setup as using the RPM. If you want the complete installation go through the steps that the RPM SPEC file do (including adding a user, etc...).

As a non-root user, untar the tarball in a directory of your choice with the command (for example, we'll assume the you chose /usr/local/banal/banal-<VERSION> for the installation and /usr/local/banal/books as the final resting place for your data):

cd /usr/local/banal
gzip -dc banal-<VERSION>.tgz | tar xvf -

If you don't already have some books, you can start with the empty books that come with the tarball. Do this (or something equivalent) to make a copy:

cp -avr banal-<VERSION>/samples/empty books

2: Starting BANAL

With the RPMs installed, BANAL will automatically startup upon boot. You can also start it manually (ie. after the install if you don't want to reboot) with:
/etc/rc.d/init.d/banal start

With the tar balled version you'd have to run a command similar to:

/usr/local/banal/banal-<VERSION>/bkd -b /usr/local/banal/books >BKLOG 2>&1 &

3: Initial Configuration

3.1: Changing Editors

BANAL uses the EDITOR environment variable if it is set. If you don't like vi or vi isn't installed as /usr/bin/vi, just set it to what you like (eg. EDITOR=vim export EDITOR).

3.2: Running the Client

The client command is called bk. If you installed the RPMs you will find it, ready to run, at /usr/bin/bk.

If you did the tarball installation, you will either need to add /usr/local/banal/banal-<VERSION>/bin to your PATH environment variable or read the user guide on installing the client.

3.3: Adding Your Company Information

The first thing to do is create a profile for yourself. This information gets used in generating invoices for example. Say for instance that you have a company named FooBar International. Pick an unique id for you company (let's say FBI) and run the command:
bk client FBI

Fill in the form, save the file and exit the editor. If you filled in all of the required fields, everything should be fine. If you get a message about some fields not being a valid value for the category (like State and Country) just leave them blank until you figure out what the category values are.

Now the FBI is a valid client ID, change the setting for the CompanyID with:

bk setting /UserInfo/CompanyID

Change the value field to FBI (or whatever you picked), save and exit the editor.

4: Getting Help on Commands

Any BANAL command that you use has useful help by typing (for example):
bk help setting

General help is available with:

bk help

A list of commands is available with:

bk help commands

5: Some Tips

All data entry commands are identical. So, for example, you will add, edit and delete a client with the bk client command. You can list all clients with the bk clients command. Read the online help (bk help client and bk help clients) for more info.

You can't use an ID from another table until it is defined. For example, invoices, require a Client ID. You must first define the client with bk client SOME_ID and then you can use it in an invoice.

Create the invoice, then create the charges (line items).

When creating a new invoice, charge, timesheet, ... leave the ID as 'new' if you don't care what the ID is. This will keep you from having to come up with a new ID everytime. I only explicitly define them for Clients.

Read the user guide's information on how to add values to a category.

When you're ready to start adding your own tax codes, read the user quide's information on TaxCodes. HINT: You have to make the Tax a legal value in the Category table and then you have to define its percentage and behaviour in the Setting table.

Read the user guide.

Ask questions on the mailing list. Simply send an e-mail to banal-request@starnix.com with the subject of the message (NOT the body) saying: subscribe

An e-mail will be sent to you asking you to confirm the request. Follow the instructions sent. An e-mail with your password will be sent upon confirmation. This will be needed later.

Send your questions and comments to: banal@starnix.com

Solutions :: Services :: Support :: Training :: About Us
copyright ©2002-2006 starnix inc. all rights reserved.