View source | View content page | Page history | Printable version   

Projects:Support for Commercial Modules/Specifications


Support for Commercial Modules - Functional Specifications



Central Repository is going to be enhanced to support Commercial Modules and a most convenient way to download obx files (for modules installation and update). Openbravo ERP must support these new developments, the purpose of this document is to detail the functional specifications for this support.


There are items to be supported by Openbravo ERP:

Commercial Modules
Commercial modules can be only installed/updated from Openbravo Subscription active instances that have an active license for that concrete module.
High Volume Modules Download
Currently the installation or update of high volume modules is painful. It is necessary to refactor the way modules are downloaded. After this, it will be possible to update core using the standard UI, as the rest of modules.


Specifications for Openbravo Professional Subscription and Central Repository v2 are explained in their own projects documentation.

Design Considerations


This project depends on Openbravo Profession Subscription and Central Repository v2 projects.


In Central Repository v2 project is taken into account that after the new developments it is needed to maintain backwards compatibility to support Openbravo ERP instances in older versions.

It is a known issue that even though old Openbravo ERP versions (which all of them will be in Community Edition) won't be able to install/update commercial modules, they will not be able to show a proper message when this is tried to be done.

Functional Requirements

User roles & profiles

This project affects to System Administrators trying to install new modules or upgrade existent ones.

Business process definition

Community Edition Instance
Professional Subscription Active Instance

User stories

Tom is the system administrator of an Openbravo Community Edition Instance, whereas Jerry administers a Openbravo Professional Subscription Instance.

Tom is looking for a module that allows him to do a human resources management, he searches for modules in the Module Manager Console within the Openbravo ERP application and founds a pair of them that could fit his needs. The first one is non commercial. He decides to install it. The experience he has during the installation is as it was in previous Openbravo ERP versions: he is informed about what is about to install, he is asked to agree the module's license and finally he installs the module.

The second module Tom can see is a commercial one, in this case he can easily identify the module is commercial, and in case he clicks the Install button he will not see the standard installation process windows, but a window with information about how he can upgrade his Openbravo Community Edition to Professional Subscription, and how he could then acquire the license for that module.

Jerry is in the same case as Tom, he also wants a module to manage human resources. As Tom did he uses the Module Manager Console to search for modules and finds the two ones Tom found. He also can differentiate the commercial from the non commercial one. He decides to install the non commercial one, and as Tom, the experience is the same as it used to be.

After that, Jerry wants to install the commercial module because it has very useful extensions. When he clicks in the Install Now button he sees a window with the information needed to obtain the license for this module. He acquires it and comes back to the Module Manager Console, now he can install it in the same way he did with the non commercial one.

Functional requirements based on business processes

Num Requirement Importance Status
1.1 Disallow installation of non allowed modules (because they are commercial and the instance is Community Edition or the license for that module is not available for the current Professional Subscription instance). Must Have Done
1.2 Allow core updates through Module Manager Console Must Have Done
1.3 Show a proper message when the module cannot be installed because of license limitation. Two messages to define:
  • Community Edition Instance: how to upgrade to Professional Subscription.
  • Professional Subscription, not license for the module: how to obtain that license.
Must Have TBD
1.4 Distinguish visually commercial and not commercial modules when searching and updating. Nice to have

User Interface Mockups


Technical Requirements

Num Requirement Importance Status
2.1 In order to allow requirement 1.2, reimplement the way obx files are downloaded from central repository. Must have Done

Open Discussion Items

Closed Discussion Items

Retrieved from ""

This page has been accessed 6,815 times. This page was last modified on 8 June 2012, at 05:31. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.