Technical Documentation - OFBiz Project Open Wiki - Apache Software Foundation
DUE TO SPAM, SIGN-UP IS DISABLED. Goto
Selfserve wiki signup
and request an account.
OFBiz Project Open Wiki
Pages
Space shortcuts
How-to articles
Child pages
Documentation
Technical Documentation
New Features Roadmap - Living Document
Apache OFBiz Technical Production Setup Guide
Component and Component Set Dependencies
Comprehensive OFBiz Training Outlines
Control Servlet Guide
Core Overview
Data File Guide
Data Model
Entity Engine Configuration Guide
Entity Engine Guide
Distributed Entity Cache Clear (DCC) Mechanism
Framework Configuration Guide
Framework Introduction Videos and Diagrams
Groovy DSL for OFBiz business logic
How to upgrade the embedded Tomcat
Internationalization
JSP Tag Library Guide
Keeping OFBiz secure
Metrics
Mini-Language Guide (Version 1 - Deprecated)
OFBiz Security Permissions
Run OFBiz under outside Application Servers
Scaling and Performance Plan
Service Engine Configuration Guide
Service Engine Guide
Unified Expression Language (JSR-245) in OFBiz
Using Service Stream Handler
System Requirements
Demo and Test Setup Guide
Misc Pages - Technical
UML Diagrams
Notes startup settings
Introduction to Load Balancing an OFBiz Cluster
OFBiz localisation - aka translations
How to Migrate from Embedded Solr to Standalone Solr
32 more child pages
Browse pages
Access to add and change pages is restricted. See:
tachments (1)
Page History
Resolved comments
Page Information
View in Hierarchy
View Source
Export to PDF
Export to Word
Copy Page Tree
Jira links
Technical Documentation
Created by
Sharan Foga
, last modified by
Jacques Le Roux
on
Jan 21, 2022
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
DEPRECATED since R17 - We now use AsciiDoc
DEPRECATED since R17 - We now use AsciiDoc
We are currently setting up a document which is located inside the OFBiz system. You can access it in using the
demo server
or when you have OFBiz running locally with the url:
. (you need seed  data installed for this link to work).
The document is also available in the content application content -> navigation -> documents and re-uses the text from The OFBiz help system.
If you are willing to contribute to the OFBiz Help System, please see
OFBIZ-2219
Getting issue details...
STATUS
. The document is in
Docbook format
and can be updated by any OFBiz committer. An explanation is given in the same document.
We now use AsciiDoc, see the doc at
(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
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
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.
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 .
Information for installing or setting up OFBiz
Minimum System Requirements
Installation
Guide
Setting Up Security
This page is about
authorisation
(i.e. permission to access OFBiz artifacts: services, screen, data, etc.)
not authentication
(login)
Scaling and Performance
Technical Production Setup Guide
Data Migration Guide
Integrating External Data
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 Overview
Data Model
Data File Guide
Component and Component Set Dependencies
Entities
Service Engine Guide
Service Engine Configuration Guide
Entity Engine Guide
Entity Engine Configuration Guide
Framework Configuration Guide
Mini Language - minilang - simple-method - Reference
Information for Developers
Developer Best Practices Guide
Beginners Tutorial
Using Service Stream Handler
Unified Expression Language (JSR-245) in OFBiz
Control Servlet Guide
JSP Tag Library Guide
Framework Introduction Videos and Diagrams
Miscellaneous / Other
FAQs, Tips & Tricks and How Tos
Metrics
How to Upgrade the Embedded Tomcat
Run OFBiz under outside Application Servers
Internationalization
Glossary
technical
documentation
development
faq
Overview
Content Tools
Atlassian Confluence Open Source Project License
granted to Apache Software Foundation.
Evaluate Confluence today
Atlassian Confluence
8.5.31
Printed by Atlassian Confluence 8.5.31
Report a bug
Atlassian News
Atlassian
{"serverDuration": 263, "requestCorrelationId": "5d30a63813a290a7"}