Openbravo.properties

Introduction

Openbravo.properties is the file where Openbravo environment configuration is centrally maintained.

Edition

Openbravo.properties is a plain text file that you can edit manually by duplicating the Openbravo.properties.template file or use a graphical assistant (wizard).

For this purpose, move to config/setup-tool folder inside your installation directory and execute the setup-properties assistant specific for your operating system and architecture.

Note: If there is no setup binary for your operating system and architecture, send a request to <jar at openbravo dot com>.

After accepting Openbravo Public License Version 1.1, select date and time formats:

• Date format. Date format used in Openbravo ERP. Available options: DD MM YYYY, MM DD YYYY, YYYY MM DD.
• Date separator. Separator for the date format. Available options: - (dash), / (slash), . (dot), : (colon).
• Time format. Time format used in Openbravo ERP. Available options: 12 hours, 24 hours.
• Time separator. Separator for the time format. Available options: : (colon), . (dot).

Then choose directories and context names:

• Attachments directory. Directory where the attachments will be stored.
• Context name. Context name of the application. This will also be the name of the Tomcat deployment WAR file and will consequently affect the URL to access the application. If using Eclipse IDE and selected a context name different from openbravo (e.g., openbravo-trunk), right click on openbravo project and select Properties option. In Properties for openbravo pop-up window, select Web Project Settings, type your Context Root name then click on OK button.
• Web url. URL where static content of the application is located (images, javascripts, CSS, etc). The default value @actual_url_context@/web is correct in most cases.
• Context url. Full URL to access the application context via a web browser including the port that the Tomcat service is listening on (e.g., 8080, 8880, 8180, ...).
  • If other clients on the local network apart from the localhost need to access the application, use the local IP or the local host alias of the machine where Openbravo ERP is being installed.
  • If clients outside the local network will access the application, use the public IP or the host name of the machine where Openbravo ERP is being installed.

If you will be developing the Openbravo ERP source code, fill in the development parameters:

• Output script location. Path to database output script.
• DB-XML operations log verbosity. Log database transactions in Debug, Info, Warn, Error or Fatal mode.
• Development environment ID. Type your development environment ID depending on the scope of your development: Openbravo ERP core contributions and modules or custom code.

After selecting your database type (Oracle or PostgreSQL), fill required parameters for its configuration:

• SID. System identifier. In PostgreSQL database you have to put the database name itself in lowercase.
• System User. Database administrator user. Usually, postgres in PostreSQL and system in Oracle.
• System Password. Database administrator password.
• DB User. Database user that will contain Openbravo ERP database objects. Take special care of not overwriting an existing database user unconsciously.
• DB User Password. Database user password.
• DB Server Address. The IP address or the host name where database service is running.
• DB Server Port. The port that database service is listening to. By default, 5432 in PostgreSQL and 1521 in Oracle.

Contents

The content of this file include:

Development configuration

Here is defined the information used by developers.

bbdd.outputscript=databasescript.sql
bbdd.verbosity=INFO
application.version=2.40
development.environment.id=1

• bbdd.outputscript is the path for the file generated with ant update.data.script.
• bbdd.verbosity is the log info level displayed for the DB ant tasks.
• development.environment.id this is the personal developer ID for a particular project. It is very important to have it properly set up in case you are going to make new developments, otherwise your contributions may be overwritten by others.

Date/Time formats

Here are defined display and storage formats for time and dates.

dateFormat.js = %d-%m-%Y
dateFormat.sql = DD-MM-YYYY
dateFormat.java = dd-MM-yyyy
dateTimeFormat.java = dd-MM-yyyy HH:mm:ss

DB configuration

This part of the file defines the database the application will connect to.

This lines define an Oracle connection:

bbdd.sid=xe
bbdd.systemUser=SYSTEM
bbdd.systemPassword=SYSTEM
bbdd.user=TAD
bbdd.password=TAD
bbdd.driver=oracle.jdbc.driver.OracleDriver
bbdd.url=jdbc:oracle:thin:TAD/TAD@localhost:1521:xe
bbdd.rdbms=ORACLE
bbdd.sessionConfig=ALTER SESSION SET NLS_DATE_FORMAT\='DD-MM-YYYY' NLS_NUMERIC_CHARACTERS\='.,'

And these others for PostgreSQL:

bbdd.sid=ob235_1
bbdd.systemUser=postgres
bbdd.systemPassword=password
bbdd.user=tad
bbdd.password=tad
bbdd.driver=org.postgresql.Driver
bbdd.url=jdbc:postgresql://localhost:5432
bbdd.rdbms=POSTGRE

Notice that here bbdd.sid is, in fact, the PostgreSQL database name.

Authentication configuration

This property is used configure the Authentication Manager for Openbravo ERP

The Authentication Manager included in Openbravo ERP are:

Default Authentication Manager 

This is the default authentication manager that provides the classic login page. Class name org.openbravo.authentication.basic.DefaultAuthenticationManager.

LAM Authentication Manager 

This is the authentication manager used for Single Sign-on. Class name org.openbravo.authentication.lam.LamAuthenticationManager.

Autologon Authentication Manager 

This is an authentication manager for demostration purposes. Class name org.openbravo.authentication.basic.AutologonAuthenticationManager.

This is an example using the default authentication manager.

authentication.class=org.openbravo.authentication.basic.DefaultAuthenticationManager

#authentication.class=org.openbravo.authentication.lam.LamAuthenticationManager

#authentication.class=org.openbravo.authentication.basic.AutologonAuthenticationManager
#authentication.autologon.username=Openbravo

build.xml properties

These properties are used by the build.xml file, so they must be properly configured before any ant task is executed:

attach.path=/opt/openbravo/attachments
web.url=@actual_url_context@/web
context.url=http://localhost:8080/openbravo

The main ones are:

• attach.path where attachments will be stored, also is used by the import/export language process. Notice that this directory should be writable by tomcat otherwise attachments won't be able to be stored.
• context.url The url the application will be published in.

Old configuration

Currently (all the releases including the 2.3x ones) this file is only used for date/time and development purposes.

The new parts of the file are used now in the development subversion trunk and will be in use for the 2.4x release. The goal is to remove (in order to have only one configuration file) dbCon5.xml and XmlPool.xml files.