[OFBIZ-6164] Improve configurability of OFBiz

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Implemented
• Affects Version/s: Trunk, Upcoming Branch
• Component/s: ALL APPLICATIONS, ALL COMPONENTS
• Labels: configuration multi-tenant
• Sprint: Community Day 1 - 2015
• Assignee: Unassigned
• Reporter: Pierre Smits
• Created: 16/Mar/15 22:15
• Updated: 27/Sep/22 12:58
• Resolved: 27/Sep/22 12:58

Description

The configuration of an OFBiz is determined by 2 aspects:

1. configuration settings required to successfully start the implementation
2. configuration settings required to have component functions work properly

The latter involve default choices for various functions to cater to the usability of business processes (and therefore screen/forms and/or screens/templates.

Several of these configuration settings are already loaded into the SystemProperty table in the underlying RDBMS, to enable adjustments of the systemPropertyValue while the implementation is in use. While it is not expected that these settings change often, it is possible that they are required to be changed during the lifespan of the company/organisation. 

However, it should not be required to go through a deployment process of regarding such changed configuration settings in the OFBiz production instance (which most - if not all - companies/organisations require when files are changes).

Having all configuration settings of components in the SystemProperty table enhances the usability of OFBiz allowing system administrators to adjust the value(s) of system property records while the instance keeps running.

Some examples of the latter kind of configuration settings expected to change during the lifespan of the company (and the production instance of OFBiz) are:

    <SystemProperty systemResourceId="general" systemPropertyId="defaultFromEmailAddress" systemPropertyValue="[e-mail]" description="general default 'fromEmailAddress' can be overridden in: EmailTemplateSetting"/>
    <SystemProperty systemResourceId="general" systemPropertyId="mail.notifications.enabled" systemPropertyValue="N" description="mail notifications enabled (Y|N)"/>
    <SystemProperty systemResourceId="general" systemPropertyId="mail.smtp.relay.host" description="the default mail server to use"/>
    <SystemProperty systemResourceId="general" systemPropertyId="mail.smtp.auth.user" description="SMTP Auth username setting"/>
    <SystemProperty systemResourceId="general" systemPropertyId="mail.smtp.auth.password" description="SMTP Auth password setting"/>

 

Furthermore, in a multi-tenancy OFBiz setup, configurations can differ per tenant.

This is a placeholder issue to capture related issues to improve the configurability of OFBiz.

Issue Links

• is related to: OFBIZ-5949 ofbizsetup create product store cause exception, remove use of temp file to load entity data
• is related to: OFBIZ-6224 Rename search.properties in special purpose/lucene to lucene.properties
• is related to: OFBIZ-6719 Remove superfluous .properties extension from EntityUtilProperties requests
• is related to: OFBIZ-7112 EntityUtilProperties
• is related to: OFBIZ-7754 The big problem when loading seed.
• is related to: OFBIZ-5902 Fetch configurable settings data driven by replacing UtilProperties.getPropertyValue() method with EntityUtilProperties.getPropertyValue()
• is related to: OFBIZ-6523 service findOrders set viewSize and viewIndex to optional
• is related to: OFBIZ-6712 Increase the number of EntityUtilProperties methods which really use getSystemPropertyValue()
• relates to: OFBIZ-6205 Use EntityUtilProperties to get the WebSiteProperties
• relates to: OFBIZ-8297 Convert <property-to field functions to tenant-aware solutions
• relates to: OFBIZ-6208 rename AccountingConfig.properties to accounting.properties
• relates to: OFBIZ-6710 Improve the way default position and size lookup parameters are set
• relates to: OFBIZ-10407 create a docker image from the ofbiz system

Sub-Tasks

• Improve FindScreenDecorator to work with configurability of Search Find Screens per app.: Closed
• Have configuration options regarding freemarkerImports.properties: Closed
• Have configuration options regarding widgets: Closed
• Have configuration options for accounting: Closed
• Have configuration options for Content.: Closed
• Split configuration options in /framework/common .properties files: Closed
• Move hard coded 'require_*' options in UserEvents.xml to SystemProperty entity records.: Closed
• Ensure that appropriate fields of the OfbizSetup process in commonext register as SystemProperty entity records: Closed
• Move hard coded 'require_*' options in SetupEvents.xml to SystemProperty entity records.: Closed
• Have the ability to configure SVN setup for scrum per tenant: Closed
• Improve configuration options for Search/Find screens in project mgr.: Closed
• Have configuration options for catalog webapp: Closed
• Have configuration options for bi: Closed
• Have configuration options for workeffort: Closed
• Have configuration options for sfa: Closed
• Have configuration options for ordermgr: Closed
• Have configuration options for the ecommerce component.: Closed
• Replace Static["org.ofbiz.base.util.UtilProperties"].getPropertyValue in .ftl files with EntityUtilProperties variant: Closed
• Make xssi prefix configurable: Closed
• Have configuration options for lucene indexing: Closed