Configuration changes that affect the Core Module

Languages:

[[::Configuration changes that affect the Core Module|English]] | Translate this article...

{{#hierarchy-top:}}

Overview

Openbravo ERP's core functionality is held in a central module, called Core. If you require a change to the application that affects the Core module, for example enabling an inactive menu, it is recommended that you create a separate industry template module to hold this kind of configuration change. Creating a separate configuration module has the following advantages:

• If you upgrade Openbravo ERP, the changes you make are not overwritten.
• You can share the configuration changes with other instances of Openbravo ERP, just as with any other module.

There are two ways to create a configuration module:

1. By putting Openbravo ERP into configuration mode. In configuration mode, Openbravo ERP creates the industry template automatically to house your changes. If you do not plan to share your customizations this is the recommended method.
2. Manually, by creating an industry template. If you plan to share your customizations within your own organization or with the community, this is the recommended method.

Please note that only changes to the Application Dictionary (and therefore, only changes done to tables which belong to the dataset AD) can be exported as a configuration script.

See also: Modularity Functional Documentation

Customizing Openbravo ERP using customization mode

1. Log into Openbravo ERP with System Administrator role.
2. From the Application menu, select General Setup > Application > System Info.
3. Select the Customization Allowed checkbox.
4. Click Save. The system creates a module called System Customization with the Java Package name mySystem.CustomizationTemplate. Artifacts (fields, columns, tabs, ...) of Core module can now be modified.
5. Make the customizations you require.
6. Save customizations to the Customization Module (see step below).

Customizing Openbravo ERP using a manually-created industry template

Only one industry template module can be active at any one time. If you try to manually create an industry template while customization mode is enabled, an error message is displayed. Disable customization mode before you create an industry template module manually.

1. Log into Openbravo ERP with System Administrator role.
2. From the Application menu, select Application Dictionary > Module.
3. Click New.
4. In the Name field, give the module a name, for example Configuration.
5. In the Java Package field, type a java package name using the Java naming standard, for example org.myname.myconfiguration.
6. Select Template in the Type drop-down list.
7. Select the In Development checkbox.
8. In the Description field, type a brief description of the new module.
9. Click Save.
10. Make the customizations you require.
11. Save customizations to the Customization Module (see step below).

Saving customizations to the customization module

In order to extract the configurations done to your Openbravo ERP system and thus saving them please execute the following command:

Before executing this command please make sure that, in Application Dictionary > Module: core module is NOT in development. Configuration module is in development. Otherwise, your configuration will be applied to the core module and not to your Configuration module.

ant export.database export.config.script -Dforce=true

This command will generate an xml file containing the changes.

You can find now the following folder structure in your modules directory.

Sharing the configuration module

After executing of the previous step you can then package this module and distribute the .obx file internally for use with other instances of Openbravo ERP in your enterprise, or share it with the community via the Openbravo repository. To package the module in a shareable .obx file, execute the command:

ant package.module -Dmodule='org.myname.myconfiguration'

{{#hierarchy-bottom:}}