Views

From Wiki

Download area

How to register a module within the Forge

This document explains the steps that you have to follow to register an Openbravo ERP module within Openbravo Forge.

1. You have to the Openbravo ERP 2.50 Module Window from the administration and Create a New Module (see the video) and also the developer's manual.
2. Once the module is register, login into Openbravo Forge. Go to your user page, from the Forge Main Page selecting 'My Profile'. The module will appear under 'My modules' section. You have to link the module to a project.
   1. You can only link a module to a project
   2. You have to be project owner of the project.
3. Develop and package your module
4. Go to your project in Openbravo Forge, and click on MODULE tab in the top quickbar. Click on 'Publish Version' tab to upload your .obx file
5. Once the module is published, you can check that it is available by doing a search in Openbravo ERP Module Manager window.

Central repository

The central repository is a piece of software that maintains all information related with all available modules that are ready to be installed on your Openbravo ERP installation. It allows developers to add new modules, update and maintain its information. It is synchronized with the Openbravo Forge, so whenever you update or add a module to your project in the Openbravo Forge the central repository and then the users will be available to install your update or new module.

Thanks to the central repository Openbravo ERP users can browse through the available modules, install, update and uninstall them. To do so they will only have to use the Openbravo ERP as allways, within the Openbravo ERP web interface they will be able to do anything related to any module (browse, search, install, update and uninstall). For the step to step process see these videos published in the Openbravo wiki:

• Install modules
• Update modules
• Uninstall modules

Publish files

Before publishing files

Before uploading files to a project, the project has to enable the downloads area. To do so, go to the project admin area and enable it turning the corresponding lamp green.

Then you are able to choose if you want to place your files locally or remotely (editing the downloads option in the admin area).

Local or remote?

There are two ways to publish files, either locally or remotely:

• Publishing files locally means that your files will be hosted in Openbravo Forge and thus you will only need to upload them.
• Publishing files remotely means that you will need to host your own files and then enter the link to the file in Openbravo Forge.

Packages, releases and files

In order to keep everything clean and organized there are three nested levels: Packages, Releases and Files.

• Packages are meant to be used to separate different kind of files (for example in a localization project there could be a pack for translations and another pack for the chart of accounts or in another project there could be a pack for the code itself another pack for the skins and a third one for the reports that can be generated with that module).
• Releases are used to version your packages. Your projects will improve as they grow: more functionality, bugs corrections, user interface changes ... So whenever you think it would be useful for other you can create a new release and put your files there.
• Files are actually what users will download. Inside each release you will place all needed files for that release. You will usually compress all files in one .zip, .tar.gz or .tar.bz2 (see the file type selector in the upload files form to see all allowed formats).

Publishing local files

Create at least a package and a version and upload your files.

You have to choose which kind of file (which extension) and for which architecture it has been compiled (if there are binary files). You have to add some basic description about it too.

And that's all. Your files will be available to the world and you will be able to see how many downloads have been done in the release view.

Publishing remote files

In order to publish remote files you can:

• Publish everything remotely: Thus editing the downloads option in the admin area and adding a link to the remote destination.
• Use the link option in the packages, releases or files sub-section in order to create a remote package, release or file download.

As you can see, you are free to choose in each section and each time you publish a file to publish as a local or remote file depending on your own needs, thus giving as much freedom as you can need.