INSTALLATION MANUAL
General Description :
CK-ERP 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.
Functionally, it is divided
into 16 modules:
Administration, Contact Management, 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, delete and view log
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-erp
http://gro.clinux.org/projects/ck-ledger
http://cosoft.org.cn/projects/ck-ledger
http://sf.linuxforum.net/projects/ck-ledger
Platforms :
CK-ERP has
been tested against the following configurations (LAMP +Phpgw or
LAPP+Phpgw),
O/S |
Webserver |
DB Engine |
Phpgw |
Fedora Core 2 |
Apache2.0.49 |
PostgreSQL 7.4.2 / MySQL 3.23.58 |
0.9.16.002 |
Php.ini
Setting:
register_globals may be set to [on] or [off] (with [off]
being recommended)
Hardware
Requirement :
If everything (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 – 256M, 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-erp-0.8.1, you could untar ck-erp 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-erp modules. Click the “Manage Application” button at Setup III menu to confirm if the CK-ERP modules are properly installed. If everything went OK, step 8 – 12 may be skipped.
1.Setup a working Linux
environment with Apache and PostgreSQL/MySQL fully installed and
started.
2.Setup phpgroupware 0.9.16.xxx. For detail instruction,
please refer to www.phpgroupware.org .
3.Test to ensure you have
a working phpgroupware setup.
4.Download ck-erp-0.8.1.tar.gz from
http://sourceforge.net/projects/ck-erp
5.# cd
/var/www/html/phpgroupware [assuming /var/www/html/phpgroupware is
phpgw's base directory]
6.# tar -xzvf <full (path)name of
ck-erp-0.8.1.tar.gz>
[extract code into 17
folders, ck-api, ck-admin, ck-contact, 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]
7.Login phpgroupware as administrator.
8.Invoke (phpgroupware's) admin (the castle icon) module.
9.Pick
the “Applications” choice.
10.Repeat the following process 16
times (ie step 11, 12a, 11, 12b, 11, 12c,.....).
11.Press “Add”
button.
12.Fill in the new application details,
a. Application name: ck-admin; Application title: Administration;
Press “Add”
b.
Application name: ck-contact: Application title: Contact Management;
Press “Add”
c.
Application name: ck-ledger; Application title: Ledger; Press “Add”
d. Application name:
ck-bank; Application title: Bank Reconciliation; Press “Add”
e. Application name:
ck-inv; Application title: CK-inventory; Press “Add”
f. Application name: ck-service; Application title: Service; Press
“Add”
g.
Application name: ck-ap; Application title: Accounts Payable; Press
“Add”
h.
Application name: ck-ar; Application title: Accounts Receivable;
Press “Add”
i.
Application name: ck-po; Application title: Purchase Order; Press
“Add”
j.
Application name: ck-so; Application title: Sales Order; Press “Add”
k. Application name:
ck-quote; Application title: Quotation; Press “Add”
l. Application name: ck-pos-c; Application title: POS for Cashier;
Press “Add”
m.
Application name: ck-pos-m; Application title: POS for Manage; Press
“Add”
n.
Application name: ck-hr; Application title: Human Resources; Press
"Add"
o.
Application name: ck-sss; Application title: Staff Self Service;
Press "Add"
p. Application name: ck-payroll; Application title: Payroll; Press
"Add"
13.Invoke (phpgroupware's) admin (the castle
icon) module again.
14.Pick the “User groups” choice.
15.Click “Edit” on the Default group line. [This is just an
example. You could create your own group and work from there too]
16.Click to activate the modules, ck-admin, ck-contact,
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
17.Press “Submit Changes” button
18.Logout from administrator account.
19.Login as a common
member of the Default group, say demo.
20.The CK-ERP modules will
show up as icons with an “abacus” background.
21.Choose the
(CK-ERP's) Administration module (castle icon with “abacus”
background).
[The following error
message (or something similar) will show up,
Database
error: Invalid SQL: SELECT checksum FROM ck_md5 WHERE
script='/ck-admin/index.php'
MySQL
Error: 1146 (Table 'ckerp.ck_md5' doesn't
exist)
Session
halted.
But
don't worry, this is due to the absence of the checksum table which
will be created in a later step]
22.You may have to click
all 16 icons to find out which icon relates to which module.
23.Read
in detail the “Welcome to Administration” page.
24.Pick
Admin/Setup choice at the top left hand corner.
25.Choose action
4 – Delete all Data and Data Tables.
26.Press “Start Action”
button.
27.Press “Start Action” button [For new installs,
there may be error messages saying that the data tables does not
exist. But don't worry]
28.Press one of the “Done” buttons
29.Choose action 1 – Setup Data Tables.
30.Press “Start
Action” button.
31.Press “Start Action” button. [A long
list of table created message will appear]
32.Press one of the
“Done” buttons.
339.Choose
action 5 – Generate MD5 Script checksum.
34.Press “Start
Action” button.
35.Press “Start Action” button. [A 'xxx MD5
Checksum 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 “Start Action” button.
39.Pick your desired Chart of Account. [Only Default Chart of
Account will work with the sample test data set.]
40.Press “Start
Action” button. [A 'Chart of Accounts and other Master Data Added'
message will appear]
41.Press one of the “Done” buttons.
42.Choose action 3 – Create Test Data [For life production,
creation of test data should be skipped]
43.Press “Start
Action” button.
44.Press “Start Action” button. [A 'Test
Data Added' message will appear]
45.Press one of the “Done”
buttons.
At this point, CK-ERP 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.Since ck-api is a programming
library module, it is not set up to be accessible by users.
3.There
is an inventory module native to phpgroupware, therefore, CK-ERP's
inventory module is named ck-inv.
4.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.
5.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.
6.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
(CK-ERP's) Administration
2.Choose Data Backup
3.A backup
(flat) file, with its name appearing on screen, will be created.
Data Restore
1.Click
(CK-ERP's) Administration.
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 [Note: Because there are too many changes in data structure, CK-Ledger data cannot be upgraded to run in a CK-ERP environment. Manual data transportation is required in this circumstances.]
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-ERP folder within the phpgw base directory.
3.Untar new CK-ERP tarball within the phpgw base directory.
4.Follow installation procedure step 24 – 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
Last Updated: 2004-07-30