INSTALLATION MANUAL

General Description :

CK-Ledger is an accounting system written in php and operates above phpgroupware. It runs as a web application with Apache and phpgroupware serving as middle layer. Internal data is managed by PostgresSQL/MySQL. SQL server can either be local or remote. Client access is via web browsers, Konqueror, Mozilla, Netscape, Opera and the like. Please note that Konqueror/KDE3/RedHat7.3 has problem accessing the various features of CK-Ledger, while Konqueror/KDE3/RedHat8.0 and other browsers have been tested to work fine under similar circumstances. Mandrake9.0/KDE also functions properly.

Functionally, it is divided into 15 modules:
Ledger Administration, Ledger (G/L), Bank Reconciliation, Inventory, Service, Accounts Payable, Accounts Receivable, Purchase Order, Sales Order, Quotation, POS for Cashier, POS for Manager, Human Resources, Staff Self Service, Payroll.

Each of these modules can be made visible or hidden from users/groups utilizing phpgroupware's native account management function.

Most transactions are provided with standard search, add, view, copy and delete facilities. Journal reversing feature is included. Two separate streams are provided to handle invoices, POs, SOs, Quotations and Cash Sale that do and do not carry transactional tax (sales tax or VAT). For detail features, please refer to the Festures List (Docs).

Demo Sites:

http://ck-ledger.sourceforge.net
http://ck-ledger.gro.clinux.org
http://ck-ledger.cosoft.org.cn

Latest Version :

The latest version is available from,
http://sourceforge.net/projects/ck-ledger
http://gro.clinux.org/projects/ck-ledger
http://cosoft.org.cn/projects/ck-ledger
http://sf.linuxforum.net/projects/ck-ledger

Platforms :
CK-Ledger has been tested against the following configurations (LAMP +Phpgw or LAPP+Phpgw),

Note:

When installing over Mandrake9.1, php-xml-4.3.0-2mdk.i586.rpm (from install CD2) may need to be installed.

When installing over Mandrake9.0, php-xml-4.2.3-1mdk.(arch).rpm (from install CD2) may need to be installed.
When utilizing a remote dbserver, be sure to invoke postgresql(postmaster) with -i to allow accessing of the dbserver via tcp/ip socket and to adjust pg_hba.conf to allow access from the webserver.

Client Browsers :
Konqueror/KDE3/RedHat8.0 – work fine.
Konqueror/KDE3/RedHat7.3 – has problems accesing various features of CK-Ledger.
Mandrake9/KDE functions properly.
Other Browsers – work fine.

Php.ini Setting:
register_globals may be set to [on] or [off] (with [off] being recommended)

Hardware Requirement :
If everyting(O/S, webserver, dbserver, phpgroupware, client GUI, browser) runs on a single machine, the system will probably need at least,
CPU – Intel Pentium III 600mhz, RAM – 128M, H/D – 40M (excluding the space needed to house the accounting data, which varies depending on transaction volume). [However, if other phpgroupware modules are utilizing the same machine, the configuration above is most likely to be inadequate]

Installation Procedure :

Note: Since ck-ledger-0.1.3, you could untar ck-ledger tarball into phpgw's base directory immediately after step 1. Then during phpgw setup, if you click on the “[install] all applications” button at Setup III menu, the setup process will auto-install ck-ledger modules. Click the “Manage Application” button at Setup III menu to confirm if the ck-ledger modules are properly installed. If everything went OK, step 12 – 16 may be skipped.

1.Setup a working Linux environment with Apache and PostgreSQL/MySQL fully installed and started.
2.Setup phpgroupware 0.9.14.001. For detail instruction, please refer to www.phpgroupware.org .
3.For phpgroupware 0.9.14.000, refer to special handling at the bottom.
4.For phpgroupware 0.9.14RC4, refer to special handling at the bottom.
5.For phpgroupware 0.9.14RC2:, refer to special handling at the bottom.
6.Test to ensure you have a working phpgroupware setup.
7.Download ck-ledger-0.7.1.tar.gz from http://sourceforge.net/projects/ck-ledger
8.# cd /var/www/html/phpgroupware [assuming /var/www/html/phpgroupware is phpgw's base directory]
9.# tar -xzvf <path of ck-ledger-0.7.1.tar.gz>
   [extract code into 15 folders, ck-ledadmin, ck-ledger, ck-bank, ck-inv, ck-service, ck-ap, ck-ar, ck-po, ck-so, ck-quote, ck-pos-c,ck-pos-m, ck-hr, ck-sss, ck-payroll]
10.If the error [Database error: Invalid SQL: select * from phpgw_inv_statuslist] occurs, refer to special handling at the bottom
11.Login phpgroupware as administrator.
12.Invoke admin (the castle icon) module.
13.Pick the “Applications” choice.
14.Repeat the following process 14 times (ie step 15, 16a, 15, 16b, 15, 16c,.....).
15.Press “Add” button.
16.Fill in the new application details,
        a. Application name: ck-ledadmin; Application title: Ledger Administration; Press “Add”
        b. Application name: ck-ledger; Application title: Ledger; Press “Add”
        c. Application name: ck-bank; Application title: Bank Reconciliation; Press “Add”
        d. Application name: ck-inv; Application title: CK-inventory; Press “Add”
        e. Application name: ck-service; Application title: Service; Press “Add”
        f. Application name: ck-ap; Application title: Accounts Payable; Press “Add”
        g. Application name: ck-ar; Application title: Accounts Receivable; Press “Add”
        h. Application name: ck-po; Application title: Purchase Order; Press “Add”
        i. Application name: ck-so; Application title: Sales Order; Press “Add”
        j. Application name: ck-quote; Application title: Quotation; Press “Add”
        k. Application name: ck-pos-c; Application title: POS for Cashier; Press “Add”
        l. Application name: ck-pos-m; Application title: POS for Manage; Press “Add”
        m. Application name: ck-hr; Application title: Human Resources; Press "Add"
        n. Application name: ck-sss; Application title: Staff Self Service; Press "Add"
        o. Application name: ck-payroll; Application title: Payroll; Press "Add"
17.Invoke admin (the castle icon) module again.
18.Pick the “User groups” choice.
19.Click “Edit” on the Default group line. [This is just an example. You could create your own group and work from there too]
20.Click to activate the modules, Ledger Administration, Ledger, Bank Reconciliation, CK-inventory, Service,
                                                    Accounts Payable, Accounts Receivable, Purchase Order, Sales Order, Quotation
                                                    POS for Cashier, POS for Manager, Human Resources, Staff Self Service, Payroll
21.Press “Submit Changes” button
22.Logout from administor account.
23.Login as a common member of the Default group, say demo.
24.The CK-Ledger modules will show up as icons with an “abacus” background.
25.Choose the LedgerAdmin module (castle icon with “abacus” background).
26.You may have to click all 15 icons to find out which icon relates to which module.
27.Read in detail the “Welcome to LedgerAdmin” page.
28.Pick Admin/Setup choice at the top left hand corner.
29.Choose action 4 – Delete all Data and Data Tables.
30.Press “Input Admin Action Parameters” button.
31.Press “Start Action” button [For new installs, there may be error messages saying that the data tables does not exist. But don't worry]
32.Press one of the “Done” buttons
33.Choose action 1 – Setup Data Tables.
34.Press “Input Admin Action Parameters” button.
35.Press “Start Action” button. [A list of table created message will appear]
36.Press one of the “Done” buttons.
37.Choose action 2 – Build Chart of Accounts and other Master Data
38.Press “Input Admin Action Parameters” button.
39.Pick your desired Chart of Account. [Currently, only Default Chart of Account works.]
40.Press “Start Action” button.
41.Press one of the “Done” buttons.
42.Choose action 3 – Create Test Data [For live production, creation of test data should be skipped]
43.Press “Input Admin Action Parameters” button.
44.Press “Start Action”.
45.Press one of the “Done” buttons.

At this point, CK-Ledger is fully functional and all features are available for your testing.

A few points to note:

1.Some of the menu choices are still not implemented.
2.There is an inventory module native to phpgroupware, therefore, CK-Ledger's inventory module is named CK-inventory.
3.The cheque printing facility assumes a normal stub-based manual handwritten cheque format (not the computer stationery type). The layout would have to be tuned for different bank's cheque format. The included facility is just for sample only.
4.Since the current version is a beta release, so DO NOT, DON'T, DO NOT AGAIN use this version against any production data or environment.
5.Some browsers may show distorted display. You may need to try different browsers and font (size) to get the best fit.

Please report any error to ck-ledger-users@lists.sourceforge.net.

Data Backup
1.Click LedgerAdmin
2.Choose Data Backup
3.A backup (flat) file, with its name appearing on screen, will be created.

Data Restore
1.Click LedgerAdmin.
2.Choose Data Restore.
3.A list of backup files kept at your user home directory will be displayed.
4.Choose the appropriate file.
5.Press “Start Database Restoration” button.

Upgrading

While the upgrading process has not been tested, the most complete and detail upgrading process is as follows,

1.Perform a data backup
2.Delete all CK-Ledger folder within the phpgw base directory.
3.Untar new CK-Ledger tarball within the phpgw base directory.
4.Follow installation procedure step 28 – 36 to delete old database tables and build new ones.
5.Perform a data restore.
6.When the upgrade does not involve change in data structure, the previous two steps may not be needed.
7.Whether data structure has been changed will be specified in the software release notes.

Special Handling

1.For phpgroupware 0.9.14.000:
   When installing this version over RedHat8.0 (apparently the critical issue is php4.2.2),
   there may be a problem with login being returned a blank page with cd=5 at the url.
   The workaround is to change line 159 within [phpgroupware folder]/login.php,
          from, if (getenv(REQUEST_METHOD) .......
          to, if ($_SERVER[REQUEST_METHOD] .....
2.For phpgroupware 0.9.14RC4:
   You will most likely have error that reads,
          Warning: Supplied argument is not a valid File-Handle resource in
           /var/www/html/phpgroupware/phpgwapi/inc/class.network.inc.php on line 81
           If this is the case, go to ..../phpgwapi/inc/class.datetime.inc.php,
                     comment out the line, if (!$this->gmtnow && !@isset($GLOBALS['phpgw_info']['server']['tz_offset']))
                     and add below it, if (false)
3.For phpgroupware 0.9.14RC2:
   You may have some error messages relating to seq_phpgw_eldaptir_servers.
   However, these errors do not seem to affect the subsequent working of CK-Ledger.
4.If the error [Database error: Invalid SQL: select * from phpgw_inv_statuslist] occurs,
     check via phpgw's Setup/Manage Applications to ensure phpgw's native “inv” module had been installed,
     or perform either one of the next two actions.
          For Postgres user: # su -l -c "psql phpgroupware < /var/www/html/phpgroupware/inv/doc/create_tables.pgsql"
          For MySQL user: # mysql phpgroupware then, mysql> source /var/www/html/phpgroupware/inv/doc/create_tables.mysql

Last Updated: 2003-08-08