Page History

Table of Contents

Related Documents

• Entity Engine Configuration Guide
• Service Engine Configuration Guide
• JavaDoc List (Documents Page)
• XML File Definitions (Documents Page)

Introduction

This document describes the configuration of the Framework of the Open For Business Framework. It goes through each of the OFBiz Framework properties files to explain the available properties and their usage. The properties files used for the OFBiz applications have examples of the different options and are located in ofbiz/commonapp/etc/.

...

The entityengine.xml file is not described in this document, it is described in the Entity Engine Configuration Guide as a separate document because of the large number of options in the file. See the Related Documents section for a link to the Entity Engine Configuration Guide. The same is true for the Service Engine Configuration Guide and the serviceengine.xml file, including a link in the Related Documents section above. 

Properties File Extensions

...

Note that these extensions are only currently available for properties files used in configuration. The internationalization and localization related message properties files use the standard Java MessageBundle class that does not use these conventions. They do, however support parameters inserted into the messages using the Java MessageFormat class and related conventions.

cache.properties

The cache.properties file contains cache setting used by the UtilCache class. Default cache parameters can be passed in when a cache is created but, if cache parameters exist in this file for the given cache name, then they will be loaded from the cache.properties file.

...

If the values are not specified and are not passed to the UtilCache constructor, the values in the default.maxSize, default.expireTime and default.useSoftReference properties will be used.

debug.properties

The debug.properties file contains options to turn OFBiz debug threads on/off and also serves as the Log4J properties file (see jakarta.apache.org for documentation on Log4J).

In addition to the Log4J properties there are properties that turn OFBiz logging levels on and off. These are formatted like print.{level-name} where level-name is verbose, timing, info, important, warning, error, or fatal. 

jndiservers.xml

This is a simple XML file that contains a number of jndi-server tags inside a single jndi-config tag. Each jndi-server tag corresponds to a named JNDI Server configuration that will be used in various places in the OFBiz Framework, especially in the Entity and Service Engines.

...