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 information to help you setup, use or develop OFBiz.
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 OFBiz is built on, and a detailed guide that describes the Entities and also the Service Engine.
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. (NOTE: May need to split that FAQ page up because its has more tips and tricks and how tos rather than being really question based)
Upgrading form 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
Look at creating a Table of Contents that has the list of all the Technical Guides
Table of Contents
Setting Up Security This page is about authorisation (i.e. permission to access OFBiz artifacts: services, screen, data, etc.) not authentication (login)
Service Engine Configuration Guide
Entity Engine Configuration Guide
Technical Production Setup Guide
~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/taglib.html (JSP Tag Library 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)
http://ofbiz.apache.org/docs/datafile.html (Data File Guide)
Do we have:
- an OFBiz Installation Guide? ~jacques.le.roux: for me that's Apache OFBiz Technical Production Setup Guide (added above) SF: Thanks Jacques - I think we might need to extract some info into a specific page or rename things because installing OFBiz it doesnt necessarily mean a Production Setup.
- a System Administration Guide? ~jacques.le.roux: nope only Apache OFBiz Technical Production Setup Guide SF: Once again we might need to extract some info into a specific page around this topic.
Things to incorporate: