ERP/2.50/Configuration Manual/Configuration changes that affect the Core module

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.

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 Application Dictionary > Module.
3. Edit core record.
4. Select the In Development checkbox.
5. Click Save. Artifacts (fields, columns, tabs, ...) of Core module can now be modified.
6. From the Application menu, select General Setup > Application > System Info.
7. Select the Customization Allowed checkbox.
8. Click Save. The system creates a module called System Customization with the Java Package name mySystem.CustomizationTemplate.
9. Make the customizations you require, making sure that you select the System Customization module from the Module list. Otherwise, your changes will be overwritten when updating Openbravo ERP core module.
10. When you have finished customizing your system, go again to Application Dictionary > Module.
11. Edit core record.
12. Un-select the In Development checkbox.

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. Edit core record.
4. Select the In Development checkbox.
5. Click New.
6. In the Name field, give the module a name, for example Configuration.
7. In the Java Package field, type a java package name using the Java naming standard, for example org.myname.myconfiguration.
8. Select Template in the Type drop-down list.
9. Select the In Development checkbox.
10. In the Description field, type a brief description of the new module.
11. Click Save.
12. Make the customizations you require. Do not modify Module fields, keep them with value core.
13. When you have finished customizing your system, go again to Application Dictionary > Module.
14. Edit core record.
15. Un-select the In Development checkbox. Otherwise, your configuration will be applied to Openbravo ERP core module and not to your Configuration module.

Sharing the configuration module

In order to extract the configurations done to your Openbravo ERP system and before updating it (overwriting these changes), you must create a module of the industry template. 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. Creating the .obx file has two stages:

1. Generating an xml file containing the changes.
2. Packaging the .xml file into the .obx file.

Before executing the following commands 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.

To generate the .xml file, open a command prompt and execute the following command:

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

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

To package the module in a shareable .obx file, execute the command:

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

Once the command finishes successfully, you will find your module packaged into an *.oxb file inside your openbravo folder.

 Personalizing Openbravo ERP