git-svn-id: https://svn.apache.org/repos/asf/ofbiz/trunk@824216 13f79535-47bb-0310-9956-ffa450edef68
352 lines
19 KiB
XML
352 lines
19 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one
|
|
or more contributor license agreements. See the NOTICE file
|
|
distributed with this work for additional information
|
|
regarding copyright ownership. The ASF licenses this file
|
|
to you under the Apache License, Version 2.0 (the
|
|
"License"); you may not use this file except in compliance
|
|
with the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing,
|
|
software distributed under the License is distributed on an
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
KIND, either express or implied. See the License for the
|
|
specific language governing permissions and limitations
|
|
under the License.
|
|
-->
|
|
<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
|
|
xmlns:xl="http://www.w3.org/1999/xlink"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xsi:schemaLocation="http://docbook.org/ns/docbook ../../content/dtd/docbook.xsd"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
|
|
<info>
|
|
<title>Apache OFBiz Technical documentation.</title>
|
|
<copyright><year>2009</year><holder>Apache Foundation</holder></copyright>
|
|
</info>
|
|
|
|
<dedication>
|
|
<para>
|
|
I was reading the book in development from Norman Walsh called <link xl:href="http://www.docbook.org/tdg5/en/html/docbook.html">DocBook 5.0: The Definitive Guide
|
|
</link> and found that a book can have a dedication. My first thought was there is only one man to whom this book can be dedicated. Without him I would not have been writing it.
|
|
Sometimes i talk to other people about my dinners with David Jones in Pucket, Thailand which were very revealing to me. At a relative young age David designed and developed with Andy Zenesky
|
|
the cornerstones of the OFBiz system called entity engine and recognized that in 2001 SOA (System Oriented Architecture) would be the future.
|
|
So, David, thank you very much spending your efforts creating this excellent system.
|
|
</para>
|
|
</dedication>
|
|
|
|
<chapter>
|
|
<title>Introduction.</title>
|
|
<para>
|
|
Welcome to Apache OFBiz, the ready to use open source ERP system. Let me first say if you downloaded
|
|
the system for the first time it will be very overwhelming because the system is pretty big what is actually pretty normal for an ERP system
|
|
because of its size.
|
|
</para>
|
|
<para>
|
|
This document is describing the technical aspects of the system. How to install it, how to load the data and how to make the system available to the Internet.
|
|
This is described pretty well in the 'production setup guide' in the next section. If you looking how to setup the system from a user point of view then better
|
|
have a look at the Apache OFBiz user guide.
|
|
</para>
|
|
|
|
<section>
|
|
<title>The production setup guide.</title>
|
|
<para>
|
|
An excellent guide to configure the system in a production environment, read the document at the <link xl:href="http://docs.ofbiz.org/display/OFBTECH/Apache+OFBiz+Technical+Production+Setup+Guide">OFBiz documentation site</link>
|
|
</para>
|
|
</section>
|
|
|
|
<section>
|
|
<title>The quick setup of an Ubuntu/Debian Linux with Postgresql Apache OFBiz server</title>
|
|
<para>
|
|
Ubuntu/Debian is certainly not the only distribution which is suitable for OFBiz. In general all Linux distributions can be used.
|
|
The OFBiz system will also run on Windows, however this is not preferred and much less experience is available in the OFBiz communiy.
|
|
The preferred data base is Postgresql although most databases will do.
|
|
</para>
|
|
<orderedlist>
|
|
<listitem>
|
|
<para>Upgrade Linux to Ubuntu/Debian remotely using Grub menu</para>
|
|
<para>
|
|
If you have a version of Linux running already on your server which using the GRUB menu, it is possible to upgrade to Debian/Ubuntu
|
|
without even touching the server physically. With the method below the Debian installer is loaded into a Ram disk from where it can
|
|
reformat and re-partition the harddisk and install the system.
|
|
Practice this first on a local server, because if after the reboot the server is unreachable you have to ask somebody at the datacenter to manually reboot the system.
|
|
</para>
|
|
<para>
|
|
If you have a proper Linux installed go to the Postgres installation.
|
|
</para>
|
|
<orderedlist>
|
|
<listitem>
|
|
<para>Get the OS kernel and the related initrd.gz</para>
|
|
<para>
|
|
Make sure you server can handle 64bit if you take that version, if not sure take the 32bit version.
|
|
Example url for 64bit Ubuntu: http://us.archive.ubuntu.com/ubuntu/dists/hardy/main/installer-amd64/current/images/netboot/ubuntu-installer/amd64/linux for the kernel and
|
|
http://us.archive.ubuntu.com/ubuntu/dists/jaunty/main/installer-amd64/current/images/netboot/ubuntu-installer/amd64/initrd.gz for the initrd.gz file
|
|
</para>
|
|
<para>
|
|
If not sure take the 32bit version:
|
|
Example url for 32bit Ubuntu: http://us.archive.ubuntu.com/ubuntu/dists/hardy/main/installer-i386/current/images/netboot/ubuntu-installer/amd64/linux for the kernel and
|
|
http://us.archive.ubuntu.com/ubuntu/dists/jaunty/main/installer-i386/current/images/netboot/ubuntu-installer/i386/initrd.gz for the initrd.gz file
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Uncompress the initrd.gz: gzip -dc ../initrd.gz | cpio -id</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Edit the preseed.cfg file inside the initrd.gz file</para>
|
|
<para>
|
|
The file I used had the following content:
|
|
<programlisting>
|
|
d-i debconf/priority select critical
|
|
d-i debian-installer/locale string en_US
|
|
d-i console-setup/ask_detect boolean false
|
|
d-i console-setup/layoutcode string us
|
|
d-i auto-install/enabled boolean true
|
|
d-i netcfg/choose_interface select eth0
|
|
d-i netcfg/disable_dhcp boolean true
|
|
d-i netcfg/get_nameservers string x.x.x.x <--- EDIT! (max 3)
|
|
d-i netcfg/get_ipaddress string x.x.x.x <--- EDIT!
|
|
d-i netcfg/get_netmask string 255.255.255.0 <--- EDIT!
|
|
d-i netcfg/get_gateway string x.x.x.x <--- EDIT!
|
|
d-i netcfg/confirm_static boolean true
|
|
d-i netcfg/get_hostname string servername <--- EDIT!
|
|
d-i netcfg/get_domain string yourdomain.com <--- EDIT!
|
|
d-i network-console/password password password <--- EDIT!
|
|
d-i network-console/password-again password password <--- EDIT!
|
|
d-i preseed/early_command string anna-install network-console
|
|
</programlisting>
|
|
You can find the ip addresses in the current Linux normally in the /etc/network/interfaces file.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Create the new Archive:
|
|
<programlisting>
|
|
find ./ | cpio -H newc -o > initrd-preseed
|
|
gzip initrd-preseed
|
|
</programlisting>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Copy the Kernel and the new initrd.gz to the server</para>
|
|
<para>
|
|
Copy these to files to the /boot/ directory on the server.
|
|
</para>
|
|
<para>If using LiLo</para>
|
|
<para>
|
|
You have to download the vmlinuz image and put that in the /boot directory under the name vmlinuzNew
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>If Grub is used: Edit the /boot/grub/menu.lst file on the server:
|
|
<programlisting>
|
|
# menu entry before the first:(for root, look at the other menu items)
|
|
title Ubuntu Install
|
|
root xxxxx
|
|
kernel /linux
|
|
initrd /initrd-preseed.gz
|
|
savedefault 1
|
|
</programlisting>
|
|
</para>
|
|
<para>If Lilo is used edit the /etc/lilo.conf file on the server:
|
|
<programlisting>
|
|
image=/boot/vmlinuzNew
|
|
label="newUbuntu"
|
|
initrd=/boot/init-preseed.gz
|
|
</programlisting>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Reboot the server</para>
|
|
<para>and hopfully after some time you can login with SSH and using the username "installer" and the password you specified in the preseed file</para>
|
|
<para>From that point you can configure the server and repartition the harddisk</para>
|
|
</listitem>
|
|
</orderedlist>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Install Subversion</para>
|
|
<para>use the command (as root) apt-get install subversion</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Install Apache using proxy AJP to talk to OFBiz</para>
|
|
<para>Use the command (as root): apt-get install apache2</para>
|
|
<para>Make symbolic links from mods-available to mods-enabled for ssl.config, ssl.load, proxy.load, proxy_ajp.load and proxy.config. Modify proxy.config and replace "Deny from all" with "Allow from all"</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Install Java SDK</para>
|
|
<para>Use the command (as root): apt-get install sun-java6-jdk</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Install PostGresql</para>
|
|
<para>Use the command (as root): apt-get install postgresql</para>
|
|
<para>
|
|
Then logon as root, and su to the user "postgres" and issue the command: createuser "ofbiz"
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Install Ofbiz</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Start ofbiz.....and look for he result in your browser.....</para>
|
|
</listitem>
|
|
</orderedlist>
|
|
</section>
|
|
</chapter>
|
|
<xi:include href="../../../framework/documents/Framework.xml"/>
|
|
<xi:include href="../../../framework/base/documents/FrameworkBase.xml" />
|
|
<xi:include href="../../../framework/common/documents/FrameworkCommon.xml" />
|
|
<xi:include href="../../../framework/entity/documents/EntityEngine.xml" />
|
|
<xi:include href="../../../framework/service/documents/ServiceEngine.xml" />
|
|
<xi:include href="../../../framework/webtools/documents/Webtools.xml" />
|
|
<xi:include href="../../../framework/testtools/documents/TestTools.xml" />
|
|
|
|
<appendix>
|
|
<title>The Apache OFBiz documentation system</title>
|
|
|
|
<section>
|
|
<title>Overview.</title>
|
|
<para>
|
|
The OFBiz documentation system consist out of a number of DocBook xml
|
|
files. In general the files are stored within the subject
|
|
component either in the 'documents' or data/helpdata
|
|
directories.
|
|
The 'master' document is stored in the file
|
|
applications/commonext/documents/ApacheOfbiz.xml. The
|
|
docbook schemas are stored in the applications/content/dtd
|
|
directory and the stylesheets are
|
|
stored in the applications/content/templates/docbook directory.
|
|
</para>
|
|
<para>
|
|
the definition of the content and dataresource records can be found in
|
|
the application/content/data/ContentType.xml file at the
|
|
bottom. They are in this file because the documentation and
|
|
helpfile
|
|
are considered 'seed' data: essential for the operation of OFBiz.
|
|
</para>
|
|
<para>
|
|
If you are looking for docbook files format examples, please
|
|
look at the following files:
|
|
<orderedlist>
|
|
<listitem>
|
|
<para>The master document at:
|
|
applications/commonext/documents/ApacheOfbiz.xml
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>An example for a chapter of a component at:
|
|
applications/accounting/documents/Accounting.xml
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>An example of a help screen:
|
|
applications/accounting/data/helpdata/HELP_ACCOUNTING_main.xml
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>An example of content creation:
|
|
applications/accounting/data/AccountingHelpData.xml
|
|
</para>
|
|
</listitem>
|
|
</orderedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section>
|
|
<title>Contributing a new help screen, a few steps.</title>
|
|
<para>
|
|
There is a difference between portlets and 'normal' screens. If a
|
|
page contains a portlet, the general help of the myportal component is shown with
|
|
at the botton a list of the portlets used at that page. Help can be obtained by clicking on
|
|
the relavant portlet.
|
|
</para>
|
|
<section>
|
|
<title>Normal pages.</title>
|
|
<para>
|
|
So if you would like to create a new help menu for a certain
|
|
screen, you need to do the following:
|
|
<orderedlist>
|
|
<listitem>
|
|
<para>In the helplink.ftl un-comment the
|
|
${helpTopic} variable so it will appear at the
|
|
top right hand of your screen</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>in the specific component data/helpData create
|
|
the HELP_${helpTopic}.xml file. you can find an
|
|
example in the HELP_ACCOUNTING_main.xml file.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Update/create the
|
|
data/${componentName}HelpData.xml, an example
|
|
can be found in the AccountingHelpData.xml. If
|
|
new make also an entry in the
|
|
ofbiz-component.xml</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Load the HelpDataFile and the file should
|
|
show up when you click on the help button.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Submit the change to the svn repository or
|
|
create a diff file and attach it to a jira
|
|
issue.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
If the help text is usefull in the ofbiz document include it in the files in the document directory.
|
|
</para>
|
|
</listitem>
|
|
</orderedlist>
|
|
</para>
|
|
</section>
|
|
<section>
|
|
<title>Contributing a new Portlet) help screen.</title>
|
|
<para>
|
|
Portlets are normally defined and explained in the ${component name}PortletData.xml files. An example
|
|
of an portlet with an existing help screen have a look at WorkEffortPortletData.xml
|
|
</para>
|
|
<para>
|
|
The content records for the help file is defined together with the portlet definition and the axual help
|
|
file is store in the related component /data/helpdata directory wit the nam HELP_PORTLET_${portletId}.xml.
|
|
</para>
|
|
</section>
|
|
</section>
|
|
<section>
|
|
<title><anchor id="helpInternationalization"/>Internationalization of the help system</title>
|
|
<para>
|
|
Because the help system is making use of the content component, internationalization of the help files is very easy because
|
|
it is a basic function of the content component. If you want to make a translation of an existing help file, make a copy in the same directory
|
|
and make it unique by attaching the "_languageCode" at he end.
|
|
Create, as also was done for the english version a dataresource and content record in the data/${componentName}HelpData.xml file.
|
|
Then create an ContentAssoc record in data/${componentName}HelpData.xml file to associate this new file with the english file with the type
|
|
ALTERNATE_LOCALE. Please find below an example from the ContentHelpData.xml for a Dutch version of the root help file.
|
|
<programlisting>
|
|
<!-- how to create alternative locales -->
|
|
<DataResource dataResourceId="HELP_ROOT_NL" localeString="nl" dataResourceTypeId="OFBIZ_FILE"
|
|
objectInfo="applications/content/data/helpdata/HELP_ROOT_NL.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
|
|
dataResourceName="Help system root" mimeTypeId="text/xml" isPublic="Y" />
|
|
<Content contentId="HELP_ROOT_NL" contentTypeId="DOCUMENT" templateDataResourceId="HELP_TEMPL"
|
|
dataResourceId="HELP_ROOT_NL" localeString="nl" statusId="CTNT_IN_PROGRESS"
|
|
contentName="Help system root in dutch" mimeTypeId="text/html"/>
|
|
<ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_ROOT_NL"
|
|
contentAssocTypeId="ALTERNATE_LOCALE" fromDate="2006-01-12 01:01:01"/>
|
|
</programlisting>
|
|
The switching between locales is from then on completely automatic.
|
|
</para>
|
|
</section>
|
|
|
|
</appendix>
|
|
|
|
<appendix>
|
|
<section>
|
|
<title>Revisions Requiring Data Migration.</title>
|
|
<para>
|
|
A List of migration actions you need to perform can be found at the <link xl:href="http://docs.ofbiz.org/display/OFBTECH/Revisions+Requiring+Data+Migration">OFBiz documentation site</link>
|
|
</para>
|
|
</section>
|
|
</appendix>
|
|
|
|
|
|
</book> |