THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
This is a work in progress to develop a way to re-organise and consolidate the pages / documents in the OFBTECH Technical Documentation Workspace and migrate them into the Wiki.
Welcome to the OFBiz Technical Documentation Wiki.
...
In this wiki, you will find a wide range of information to help you setup, use or develop OFBiz.
| Table of Contents |
|---|
| Info | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
DEPRECATED since R17 - We now use AsciiDoc
We now use AsciiDoc, see the doc at https://nightlies.apache.org/ofbiz (get curious there, the stable documentation is for the current released branch, the next documentation is for the next to release branch, the trunk documentation is for the current development branch). |
Getting Started
Once you have verified the minimum system requirements, you can download, build and then run your own version of OFBiz. Anyone looking to administer OFBiz will need to read the Apache OFBiz Technical Production Setup Guide.
If you are going to be using OFBiz in other languages or currencies then please take a look at our Internationalization / Localisation Guide.
Information for Developers
There are several resources available if you are going to be developing in OFBiz, a Beginners Tutorial, Developer Best Practices Guide, some detailed background information on the Data Model and Framework (add link to guide) that that OFBiz is built on, and a detailed guide that describes the Entities and also the Service Engine.
We also have some basic diagrams that can help you understand the framework components.
If you are looking for more detail then we have a range of more detailed guide around the Entity Engine (Entity Engine Guide, Entity Engine Configuration Guide), Service Engine (Service Engine Guide, Service Engine Configuration Guide)
We also have a section on FAQs, Tips & Tricks and How Tos. (
| Info |
|---|
| NOTE: May need to split that FAQ page up because |
...
| it has more tips and tricks and how tos rather than being really question based |
...
Upgrading
...
from a Previous OFBiz Version
If you are upgrading from a previous version of OFBiz then please take a look at the Data Migration Guide which can be used in conjunction with the Apache OFBiz Technical Production Setup Guide.
Technical Guides and Information
Please see below for links to all our technical information and remember if you have any questions then please post a message on our community mailing lists .
Table of Contents
...
Information for installing or setting up OFBiz
Setting Up Security This page is about authorisation (i.e. permission to access OFBiz artifacts: services, screen, data, etc.) not authentication (login)
Technical Production Setup Guide
Keeping OFBiz secure This page is about security as in "external security". In other words, it's not about authentication nor authorisation.
Background Information on OFBiz
Core OverviewBackground Info
Component and Component Set Dependencies
Service Engine Configuration Guide
...
Entity Engine Configuration Guide
Miscellaneous / Other
FAQs, Tips & Tricks and How Tos
Framework Introduction Videos and Diagrams
Verify if following are still needed or can be archived
Mini Language - minilang - simple-method - Reference
Information for Developers
Developer Best Practices Guide
...
Unified Expression Language (JSR-245) in OFBiz
~jacques.le.roux: http://ofbiz.apache.org/docs/services.html (would be cool to make new up to date wiki pages from those old pages like also http://ofbiz.apache.org/docs/entity.html and remove them)
Guides from the old docs space. I think some of them are no longer relevant but which ones?
http://ofbiz.apache.org/docs/minilang.html (MIni Language Guide)
http://ofbiz.apache.org/docs/regions.html (Regions Guide)
...
...
http://ofbiz.apache.org/docs/wf_cal_spec_chart.html (Workflow and Calendar Entity Spec Reference)
http://ofbiz.apache.org/docs/workflow.html (Workflow Engine Guide)
http://ofbiz.apache.org/docs/config_deploy_maint.html (Configuration,Deployment and Maintenance Guide - I think this one must be out of date now!)
http://ofbiz.apache.org/docs/control.html (Control Servlet Guide)
http://ofbiz.apache.org/docs/core.html (Core Overview)
http://ofbiz.apache.org/docs/coreconfig.html (Framework Configuration Guide)
Framework Introduction Videos and Diagrams
Miscellaneous / Other
FAQs, Tips & Tricks and How Tos
How to Upgrade the Embedded Tomcat
Run OFBiz under outside Application Servers
http://ofbiz.apache.org/docs/datafile.html (Data File Guide)
...