Projects:Openbravo3DemoSampleDataAPI
Contents |
ABOUT THIS DOCUMENT
This document describes how to create new sample clients ready to be installed into the Openbravo's official Demo web.
INTRODUCTION
The Openbravo's official Demo web offers different sample clients for each country localization pack. This allows partners to show a great example of all the localization pack capabilities in a real client.
In order to facilitate the creation and importation of this sample client, Openbravo has created the "Openbravo 3 Demo Sampledata API" module. This module defines the framework and the API that all the sample clients must fulfill to be available into the official demo page.
CONFIGURATION
Set the following property in Openbravo.properties file
authentication.class=org.openbravo.demo.loginpage.authentication.DemoAuthenticationManager
By default the module will generate new user (inheriting configuration of the user selected for each localization pack) for each login. The username will be built as follows: DemoUser_<sequencenumber>
It is possible to disable the user autogeneration adding the following property to Openbravo.properties file:
demo.useronthefly.deactive=true
HOW TO CREATE THE DEMO CLIENT
The basic process for creating the demo client is exactly the same as when creating a normal client, i.e., using the Initial Client Setup.
Take into account that your client will be publicly exposed, so be very careful about the data you introduce, like Organization names, Business Partners names, Products, Bank accounts numbers, etc. Try to avoid using real names or data.
IMPORTANT CONSIDERATIONS
1. When creating your client, your system must contain only your localization pack with the exact version as it is going to be installed into the official demo application (and of course, all the mandatory dependencies/inclusions).
This is mandatory because, when exporting the client, the system will export all the data available for this client. Imagine you have an external module not related to your localization pack which adds a new column to the AD_Client table. When exporting the client, this column will be also exported. But, when trying to import the client into the official demo, the process would fail because this column is not available.
2. Apart from your localization pack, you need to install the "Openbravo 3 Demo Sampledata API" module (distributed under the Openbravo Public License).
This module adds a new window called "Localization Pack Info" where you must define the very basic info about your localization pack:
You must create a new record for your sample client where you define the Country and Default Language for your localization pack, and the User and Default Role used for login into the Openbravo's official demo. Usually the role should be the Admin one.
With this simple configuration, your sample client is linked with your localization pack.
HOW TO INCLUDE YOUR CLIENT INTO THE OPENBRAVO'S OFFICIAL DEMO
Once you have created your client, you need to export it. Openbravo provides a process that automatically exports your client. Follow the instructions for exporting your client.
To verify it's going to work fine into the official demo, try to import it into a fresh environment that contains your localization pack and the "Openbravo 3 Demo Sampledata API" module.
If everything goes well, then send an email to staff.rm -AT- openbravo.com attaching your client's XML file.