Академический Документы
Профессиональный Документы
Культура Документы
Introduction
James Thompson
GNU: Enterprise Core Development Team
Derek Neighbors
GNU: Enterprise Core Development Team
Edited by
Derek Neighbors
GNU Enterprise - Developers Introduction
by James Thompson and Derek Neighbors
by
3
List of Tables
1-1. Base Packages .................................................................................................................10
4
Chapter 1. An Introduction for Developers
Introduction
GNU Enterprise is a meta-project aimed at developing a complete enterprise level business
environment. It will consist of tools to quickly build business applications. Several packages
and modules will be available ready for out of the box use or readily available to extend or
customize to your needs. There will be templates by industry type so you are only getting the
base of what your industry type would use.
Why?
Businesses seeking to move to digital processes often find themselves with limited options.
They find themselves choosing between the following options.
Purchase proprietary shrink-wrapped software
This option has many drawbacks which include but are not limited to.
• The business is forced to adapt their processes to conform to the rigid requirements of the
purchased software.
• A single source for updates and maintenance.
• Their fate is tied to that specific vendor.
• Often such packages have high entry costs many small or new businesses can not readily
afford.
Pay a consultant to create their software
This solution is better than a shrink-wrapped solution. The software is usually tailored to the
exact business needs. It does have a few drawbacks however. The software is tied to a specific
consultant or company, usually by copyright, in the same manner as shrink wrapped software.
If the consultant closes down their business, their customers can be left without any means
of support. If source code is not available the system can’t be maintained. If the source code
is available, a new consultant must be paid to learn the entire system before maintenance is
possible. The unique nature of the system has left the business vulnerable.
Maintain an in-house programming team
This solution is better than paying a consultant if a business can afford the personnel needed
to maintain the systems. But hiring only a single programmer leaves a business in the same
position as with a consultant. Many smaller companies cannot afford several full-time pro-
grammers. The unique nature of the code requires all development and testing to be done
in-house. Since the software isn’t usually shared outside the business it doesn’t get the levels
of peer review needed to achieve the highest quality.
None of these solutions provide a business with the security and freedom they deserve. Often
businesses find themselves making compromises in their business practices and paying large
sums of money to vendors they don’t particularly care for simply because they are "locked in"
to a specific solution.
It doesn’t need to be this way.
Features
Modular System Design
5
Chapter 1. An Introduction for Developers
GNU Enterprise objects are defined at application run-time. This allows a system to be easily
and rapidly modified by end users without risk of compromising the core system.
A technically savvy business owner can browse a list of modules from a library on the GNU
Enterprise site. She can pick various packages and modules that are of interest, install them
via a tool like RPM, check out their features, remove the ones she doesn’t like, finish up her
testing and go live. As new packages and modules become available she can add and remove
them as she desires (within reason). She ends up with a system that is exactly to her liking
w/o the expense of hiring a consultant to customize the system.
To achieve maximum modularity and be all things to all people within reason, GNUe is look-
ing at the following approach. GNUe will be a set of tools to build business applications.
With these tools modules will be built. Modules will be bundled by similar function to create
packages. One problem in doing this is the different needs of different industries. A doctor
has a very different billing situation than car dealer ship for instance. Therefore, there will
be "templates" by vertical industry if need be. The concept is GNUe->Packages->Modules-
>Components where components can be reused among modules. Modules are bundled by type
ex: accounts recievable, accounts payable, general ledger are bundled in accounting package.
Then multiple packages make up GNUe. Then each vertical industry can have specific tem-
plates if desired to make customization minimal from set up to setup. (Further documentation
and flow charts coming on this subject.)
Open Architecture
Every effort has been made to open the GNU Enterprise system to developers and users.
CORBA provides a clean interface to the objects that comprise a functional GNU Enterprise
system. All data is stored in a relational database system. The database structures are well
documented and accessible via standard SQL. XML is used to define forms that are parsed
and executed by a wide variety of clients.
Powerful Development Framework
The base distribution of GNU Enterprise will contain several powerful tools. Tools like GNUE
Forms, GNUE Reports, GEDI, GEAS and EWOK will allow developers to rapidly develop
GNU Enterprise applications.
Consistency
Widespread deployment of GNU Enterprise will allow programmers to become familiar with
the core GNU Enterprise components. They should require little time to get up to speed on
a specific company’s modifications to the code. This frees the programmer from learning the
details of a unique system that is useless to them in other jobs. They can spend more time
doing what they enjoy, writing code to solve unique problems.
Freedom from Single Source Vendors
A consultant can assure their customer that in the event they were unable to maintain the
software it would be easy to find others familiar with the core system. This also provides the
business some assurance that the consultant won’t hold a monopoly on their systems, that they
are free to let others work on their code.
Easy Maintenance
Since modules are used to store alterations to the system. Modifications made by the end site
are stored separately from the generic distribution. Updates to the generic system can be ap-
plied without effecting local changes. Consultants need not maintain several virtually identical
source trees with individual customer alterations, simple modules store all the changes.
Package Library
A person setting up an GNU Enterprise system would have access to growing number of
packages for the system. These packages could be specialized for specific areas of business
(manufacturing, legal, etc.) and would allow a programmer to produce a fairly specialized
system in short period of time then tweak the system to meet the exact needs of the business.
6
Chapter 1. An Introduction for Developers
Examples
The best way to understand what GNU Enterprise does is through examples.
Consultants
7
Chapter 1. An Introduction for Developers
Consultants can use GNU Enterprise to reduce the time they spend maintaining custom so-
lutions for their customer. In addition they can greatly increase the speed in which they can
respond to customer requests.
As an example we’ll look at the steps Carl D. Consultant takes to install and customize GNU
Enterprise to meet the needs of his customers.
We’ll first start at the local car dealership where Carl
• Modifies the CRM module included in the GNU Enterprise install to include a field to track a
customers favorite type of car.
• Installs the needed components, modules, and packages to provide an auto maintenance history
system to the repair shop.
• Tweaks the generic inventory module to handle issues specific to automobiles
• Installs the needed components, modules, and packages to maintain an auto parts counter
• Modifies the CRM module included a field to track a customers date of birth.
• Installs a component that generates a report of customer’s upcoming birthdays. This allows the
dealer to send birthday greetings to his prior customers.
• Installs module(s) to add specific modifications to the system the car dealer requested.
At the local doctors office
8
Chapter 1. An Introduction for Developers
Templates/Packages
It would be almost impossible for a small group of developers to oversee every aspect of
GNU Enterprise. In order to deal with this complexity the project is decomposed into separate
projects known as packages each with vertical industry templates. Each package consists of
everything needed to provide a single feature set to GNU Enterprise. Templates are a way to
group the packages by industry. For example, the GNUE Accounting package provides Gen-
eral Ledger, Accounts Payable, Accounts Recievable, etc. capabilities to the system. (More
diagrams and explanations coming soon.)
Categories
Standard
9
Chapter 1. An Introduction for Developers
Extended
Extended packages are packages that have requirements beyond those of the standard package.
They might require an administrator to install additional languages on the system. They must
however meet compatibility requirements. Extended packages are considered safe to use they
simply require additional effort during setup of the system.
Unfriendly
Unfriendly packages are the "hacks" that almost everyone has utilized at one time or another.
They bypass all guidelines so they can "just get the job done". Updates to the system may
cause these packages to break themselves, or the system.
Base Packages
Table 1-1. Base Packages
Other Packages
10
Chapter 1. An Introduction for Developers
Architecture
Most GNU Enterprise programs are broken down along a N-Tier architecture. Which consists
of
Back-end
GNU Enterprise relies on a third party SQL based RDBMS for data storage. GEDI will allow
support for a variety of database systems. (GEDI Proposal and information coming soon.)
Initial development efforts center around the usage of the PostgreSQL RDBMS or unixODBC.
Business Objects
Business objects are the heart of the GNU Enterprise system. These CORBA enabled objects
provide most of the business logic in the system.
Application
Applications can be broken down into two types, those that provide a user interface and those
that do not.
For applications that provide a UI this would be the logic behind the interface. It doesn’t
contain any business logic in most cases, that’s one layer down. It contains the processes that
occur when a trigger is fired from the ICL (button X is pressed, app has requested shutdown,
menu item Y selected, etc.)
If all ICLs support a standard set of form widgets, and a standard set of functions like
get_functions required to provide a list of defined functions in the application. It seems possi-
ble to develop a nice IDE for simple apps along the lines of VB.
An application could also be written at this level that would "simulate" the old SQL*Forms
program (with all it’s flaws and bonuses). It would bypass the lower levels and would make a
nice GUI builder for direct table access (something we should probably avoid, but someone,
somewhere will need it)
Most developers new to GNUe would work in at this level using only the higher level business
objects and the IDE.
The other type of applications would be applications that perform basic batch style processing
on the GNUe objects.
ICL
Interface Client Level (aka Thin Client)
These programs are basically identical regardless of what language/platform they cover. They
assume a certain number of procedures are available from applications. One of the most im-
portant would be a "get_ui" call that would tell the application to send a description of the
form to be drawn (encoded in XML). These programs would handle mapping UI widgets
11
Chapter 1. An Introduction for Developers
we’ve defined as valid for an OBE user interface. Things like entries, labels, lists, picture,
text, notebook tabs, triggers, etc.
Tools
GNU Enterprise will provide several tools that provide a powerful application development
framework.
GNUe Forms
GnuE Forms actually consists of two separate programs. A designer which generates user
interface definition files and a client which displays screens and accepts input from the user.
The GnuE Forms painter provides developers with a system that allows rapid development
of data entry screens. A developer simply chooses the objects and fields of interest and ar-
ranges the interface widgets to their liking. The system then generates a XML based interface
definition file that is used by the clients.
The GNUe Forms client reads the interface definition file produced by the designer and gen-
erates a data entry screen based upon its contents.
Since the interface definition file is simple XML text it is very portable. Clients can be writ-
ten for any number of display and data entry technologies and all utilize the same interface
definition file. Thus building a single screen via the desinger instantly makes it available to all
clients.
In addition programs can be written to communicate directly with a client using its XML
interface definition language. This allows programmers to bypass limitations of the screen
designer while retaining the robust, standardized front end clients.
GNUe Reports
GNUe Reports shares many features with GNUe Forms. It is comprised of a report designer
and a client that generates the requested output. Report definition files are also XML based.
And programs can communicate directly with the XML reports definition language much like
they can with GNUe Forms.
12
Chapter 1. An Introduction for Developers
13
Appendix A. GNU General Public License
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software-to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation’s software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author’s protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors’ reputations.
14
Appendix A. GNU General Public License
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
15
Appendix A. GNU General Public License
entire whole, and thus to each and every part regardless of who wrote it.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
16
Appendix A. GNU General Public License
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients’ exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
17
Appendix A. GNU General Public License
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
-one line to give the program’s name and a brief idea of what it does.-
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
Appendix A. GNU General Public License
Also add information on how to contact you by electronic and paper mail.
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than ‘show w’ and ‘show c’; they could even be
mouse-clicks or menu items-whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
19
Appendix B. GNU Free Documentation
License
GNU Free Documentation License
Version 1.1, March 2000
0. PREAMBLE
We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
20
Appendix B. GNU Free Documentation License
The "Cover Texts" are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License.
The "Title Page" means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, "Title Page" means
the text near the most prominent appearance of the work’s title,
preceding the beginning of the body of the text.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies of the Document numbering more than 100,
and the Document’s license notice requires Cover Texts, you must enclose
the copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
21
Appendix B. GNU Free Documentation License
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has less than five).
C. State on the Title page the name of the publisher of the
Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document’s license notice.
H. Include an unaltered copy of this License.
I. Preserve the section entitled "History", and its title, and add to
it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section entitled "History" in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
22
Appendix B. GNU Free Documentation License
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
23
Appendix B. GNU Free Documentation License
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
8. TRANSLATION
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except
as expressly provided for under this License. Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However,
24
Appendix B. GNU Free Documentation License
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.
25