Developer documentation table of contents
From AdempiereWiki
The documents included in the Developer documentation category are a bit scattered all over the place, there is valuable information here, but we lack the whole picture. Please add here where does each document fit if you have such information. This entry will serve as a Table of contents or a big picture for all the documents included in this category. It's also a good way to identify in which places the documentation is lacking.
For now, we do not need to add sophisticated Markup, just add a wikilink to your entry with a sentence or two to explain what it does. Include your entry in the relevant chapter, if no chapter apply, create a new one.
We hope that this page will slowly organize itself in a typical Wikian way, this document is a work in progress.
Contents |
Introduction
Installation
There are two ways to get started with ADempiere, the first one is to go with the ADempiere Virtual Appliance which runs under the VMware player, this is a ready to use ADempiere prebuilt installation. This solution can be very convenient if you want to quickly evaluate ADempiere and don't want to be bothered with the intricacies and tuning of a whole new install.
If you are a power user, or if you want to hack ADempiere source code, you can go with a whole new install.
Creating your own development environment and contributing
ADempiere is an open source product, you can download the source code and start hacking, developing new functionalities, or correcting bugs. One of the best open source IDE out there is Eclipse. Eclipse Setup Show you how to create your own development environment in Eclipse and start your own development process.
Your contributions to ADempiere source code are of course welcome, ADempiere is a project entirely driven by its community. The Hacker's guide show you how you can start contributing, but remember first to sign the Contributor agreement.
The Active Data Dictionary and parametrization
One of the main stregnth of ADempiere, is the concept of Active Data Dictionary (ADD). ADmpiere Data Dictionary contains definitions of a data entity (type, validation, etc.), how it is displayed (label on screens and reports, help, display sequence and position relative to other fields), and the display rules. It also contains security and access rules. To make using the Dictionary more straightforward, all the columns in the same table have the same prefix, Table Prefix has a list of all the prefix used in ADempiere.
An important part of the adaption process of ADempiere to your specific needs is done by understanding the Active Dictionary Data model.
Understanding which window is used to maintain a table
This information here is a good technical help, i.e. if you want to know which window is used to maintain a table, you can find that table on this document, it will also show you which is the corresponding maintenance window. Same if you want to find which window executes a process, you will find it and it will show the window/process/report.
Changing the Look and Feel
You can adapt the ADempiere Look and Feel to your own needs, there are at least two ways to do it.
Data migration
Sage Line 50 describes a data migration process.
Localization
In order for ADempiere to be usable in any country, it needs to be adapted to the local language and accounting system, if you want to adapt ADempiere to your own language see Localization Guide.
There are already many localized versions of ADempiere, please checke first with the ADempiere community, if the version you are looking for have not been already done.
