Wikiadmin: Created page with "== Common Issues, Tips and Tricks == This part of the developers guide is dedicated to discussing common issues and answering frequently asked questions. It tries to provide..."

2018-10-15T13:52:05Z

Created page with "== Common Issues, Tips and Tricks == This part of the developers guide is dedicated to discussing common issues and answering frequently asked questions. It tries to provide..."

New page

== Common Issues, Tips and Tricks ==

This part of the developers guide is dedicated to discussing common issues and answering frequently asked questions. It tries to provide tips and tricks for common obstacles encountered when developing and extending Openbravo.

== Java Development Issues, Build Path problems ==

To check for a cause and solution check the [[Installation_and_setup_of_Eclipse_IDE|Setup for Eclipse guide]] and specifically the section on [[Installation_and_setup_of_Eclipse_IDE#Build_Path_Problems:_Common_Causes_and_Solutions|Build Path]] problems.

== Client side coding, JavaScript ==

This section highlights specific topics related to client side coding in JavaScript.

=== javascript error on OB object: OB undefined ===
This can happen if the javascript you created is loaded before the general Openbravo javascript code. To repair this you have to make sure that your module depends on the User Interface Application module. Based on this the Openbravo system will load your javascript after the base javascript provided by Openbravo.

In general if your module depends on javascript provided by other modules, you should set the correct dependency in the module dependencies.

See [[How_To_Create_and_Package_a_Module#Creating_a_Module|here]] for more information.

=== Use jslint ===
When you do your own client side javascript coding it can help to let your code be automatically checked using [http://www.jslint.com/ jslint]. At Openbravo we run jslint for all the javascript code being committed to the repository. We use [http://code.google.com/p/jslint4java/ JSLint4Java] for this, we enable the automatic check by adding this to the hgrc file in the .hg directory:
<source lang="ini">
[hooks]
precommit = modules/org.openbravo.client.kernel/jslint/jscheck-hg
</source>

If you work in a custom module then from MP31, there is another script which you should use, add a hook like this in the hgrc file in the .hg directory in your module:
<source lang="ini">
[hooks]
pretxncommit = ../org.openbravo.client.kernel/jslint/jscheck-module-hg
</source>

=== Read this book: JavaScript The Good Parts ===
JavaScript is not Java. '''To really understand JavaScript it is crucial to read this book''': [http://oreilly.com/catalog/9780596517748 JavaScript The Good Parts].

[[Image:js_goodparts.gif|center]]

=== Debugging JavaScript ===
All the static JavaScript code (from all modules) is concatenated into one large JavaScript file which is stored in the web application directory (in web/js/gen). The name of the file is based on a hash of the content (see the image below). You can check out the contents of the file using the browsers debugger. From there you can debug your code. At Openbravo we use Chromium and its [http://code.google.com/chrome/devtools/docs/scripts.html debugger] most of the time.

[[Image:chrome_debugger.png|center|700px]]

When working with client side code it is important to learn how to use the Chromium or Firefox debugger and console. Also check out the network tabs of the debugging tools to analyze the requests being done by the system. Search the internet for more information.

'''To see non-minimized code in the debugger you need to have the core/kernel/application modules in development.'''

=== JavaScript Coding Conventions ===
Check out the [[JavaScript_Coding_Conventions]] for specific tips on coding in JavaScript.

=== Client side API ===
Openbravo provides and implements several client side components for sending requests to the server, internationalization etc. See the [[Client_Side_Javascript_API|Client Side JavaScript API]] for more information.

=== Smartclient ===
Openbravo uses the [http://www.smartclient.com Smartclient] client side user interface library for implementing components. To work and development in Openbravo and create new widgets you need to understand Smartclient. Check out these resources:
* [http://www.smartclient.com/index.jsp#_Welcome Smartclient demo]
* [http://forums.smartclient.com/ Smartclient forum]
* [http://www.smartclient.com/docs/8.0/a/b/c/go.html Smartclient reference]

It can help to have the Smartclient source code and reference material in your Eclipse workspace, it is very easy to search source code then. The latest Smartclient source code is available in this Mercurial repository:
https://code.openbravo.com/erp/mods/org.openbravo.userinterface.smartclient.dev/

=== Videos ===
Here you have a list of 3 sessions of ''"Introduction to JavaScript"'', the sessions were held on Nov. 26th, 30th and Dec 1st 2010.

{| style="width:100%;background:#ffffcc"
|- style="text-align:center;width:100%"
| [[Image:Warning.png]] The sessions recorded and listed here are in '''''Spanish'''''
|}

==== Session 1: Introduction to JavaScript ====
* Part 1: [http://openbravo.emea.acrobat.com/p58999753/ http://openbravo.emea.acrobat.com/p58999753/]
* Part 2: [http://openbravo.emea.acrobat.com/p79534671/ http://openbravo.emea.acrobat.com/p58999753/]

==== Session 2: Introduction to SmartClient ====
* Part 1: [http://openbravo.emea.acrobat.com/p84569149/ http://openbravo.emea.acrobat.com/p84569149/]

==== Session 3: Introduction to New Architecture ====
* Part 1: [http://openbravo.emea.acrobat.com/p14323450/ http://openbravo.emea.acrobat.com/p14323450/]

=== Resources ===

* JavaScript: The Good Parts [http://oreilly.com/catalog/9780596517748/ http://oreilly.com/catalog/9780596517748/]
* JavaScript: The Good Parts (video) [http://video.yahoo.com/video/play?vid=630959 http://video.yahoo.com/video/play?vid=630959]
* Douglas Crockford — The JavaScript Programming Language [http://developer.yahoo.com/yui/theater/ http://developer.yahoo.com/yui/theater/]
* JavaScript in Ten (arbitrarily long) Minutes [https://github.com/spencertipping/js-in-ten-minutes https://github.com/spencertipping/js-in-ten-minutes]
* Slides sources (Markdown) used with [https://github.com/schacon/showoff showoff] [http://bitbucket.org/iperdomo/js-training/get/tip.zip http://bitbucket.org/iperdomo/js-training/get/tip.zip]
* A nice tutorial on closures and function scoping: [http://nathansjslessons.appspot.com/ [http://nathansjslessons.appspot.com/]

== Weld ==

=== My component is not found ===
If your component is not found maybe it falls within the exclusion filter defined in the Weld module. See [[Openbravo_3_Architecture#Analyzing_the_classpath|here]] for more information.

=== Can I run logic when the application starts? ===

Yes you can see [[Openbravo_3_Architecture#Implement_Application_Initialization_Logic|here]] for more information.

== Data Access Layer ==

=== SQL Functions in HQL: no data type for node error ===

See this [[Data_Access_Layer#SQL_Functions_in_HQL|wiki page]] for information on how to use SQL functions in HQL.

=== Getting warning: Unbalanced calls to enableAsAdminContext and resetAsAdminContext ===

This warning is displayed (together with a stacktrace) when setting administrator mode is not done correctly. See [[Data_Access_Layer#Administrator_Mode|this part]] of the developers guide.

=== How to call a Stored Procedure/Process through the DAL ===
See these [[How_to_call_a_stored_procedure_from_the_DAL#Notes|notes]] in the howto on calling a process through the DAL.

=== How to read data visible only from a specific Organization ===
The default DAL behavior (of OBQuery and OBCriteria) is to read information from all readable organizations. This is all organizations to which the current role has access. However, sometimes you want to read information which is only accessible/visible from a specific organization. The code snippet below shows how this can be accomplished:
<source lang="java">final OBCriteria<PaymentTerm> obc = OBDal.getInstance().createCriteria(PaymentTerm.class);
obc.add(Expression.in("organization.id", OBContext.getOBContext().getOrganizationStructureProvider().getNaturalTree(orgId)));
obc.setFilterOnReadableOrganization(false);
final List<PaymentTerm> pts = obc.list();
</source>

This code snippet shows that you have to add an in expression to the OBCriteria and then disable the standard organization filtering. A similar approach can be implemented for OBQuery.

=== When flushing/committing a trigger throws an exception, but I can't see/display the real trigger message ===

Hibernate and JDBC will wrap the exception thrown by the trigger in another exception (the java.sql.BatchUpdateException) and this exception is sometimes wrapped again. Also the java.sql.BatchUpdateException stores the underlying trigger exception in the nextException and not in the cause property. The following method can help you to get to the underlying trigger message:
<source lang="java">private String getExceptionMessage(Throwable t) {
if (t.getCause() instanceof BatchUpdateException
&& ((BatchUpdateException) t.getCause()).getNextException() != null) {
final BatchUpdateException bue = (BatchUpdateException) t.getCause();
return bue.getNextException().getMessage();
}
return t.getMessage();
}
</source>

{{(!)| Openbravo API provides a method called '''getUnderlyingSQLException()''' on the '''DbUtility''' class which already does this checks and covers other cases also.}}

=== Test your HQL: the HQL Query Tool ===

Openbravo forge contains a [http://forge.openbravo.com/projects/hqlquerytool module] which offers a query tool which allows you to try a HQL query directly in the Openbravo web interface. The HQL Query Tool is also available through the central repository. See [http://forge.openbravo.com/plugins/mwiki/index.php/Hqlquerytool/User_Manual here] for the manual of this utility module.

=== How can I see what SQL is executed? ===

To see the SQL queries fired by Hibernate, the following log4j property has to be set (in the WEB-INF/classes/log4j.properties or better in openbravo/src/log4j.properties):
<source lang="java">### log just the SQL
log4j.logger.org.hibernate.SQL=debug
</source>

For seeing the binding of values to query parameters set this property:
<source lang="java">### log JDBC bind parameters ###
log4j.logger.org.hibernate.type=error
</source>

If it does not work for you, it is possible that the log4j.properties file is read from another location than you expect. To see where log4j reads its properties from set this jvm parameter:

<source lang="java">-Dlog4j.debug
</source>

=== My query does not return my newly created object! ===

This can occur when you do not explicitly set the active property to true in the new business object.

The main Openbravo query classes ([[Data_Access_Layer#OBCriteria|OBCriteria]] and [[Data_Access_Layer#OBQuery|OBQuery]]) automatically add different filter criteria. One of the filter criteria is the active property. As a default the query classes will only return objects with active is true (or 'Y' in the database).

When creating a business object the active property has to be explicitly set to true (setActive(true)). This ensures that the active-filter will not miss it in queries.

=== My query does not return anything! ===

There are cases where Hibernate will perform an inner-join when executing a query. If there is no related data in the joined table then the complete query will return nothing.

As an example take the following query:
<source lang="sql">select p.id, p.image from Product as p</source>

This query seems pretty simple. However, in fact the image is a seperately persisted object and a many-to-one reference from the product to the image table. This query therefore results in an inner-join to the image table. In this case that table was empty and nothing was returned.

To solve this issue, the image has to be joined in an outer join:
<source lang="sql">select p.id, p.image from Product as p left outer join p.image</source>

=== not-null property references a null or transient value: *.creationDate ===

This exception is thrown when you try to save a new business object with its Id set. It makes sense to set an id if you want to control the id-setting (and not let hibernate create one for you). However, if the id is set then Hibernate/Openbravo will think it is an existing object and not set the audit info properties.

To solve this also call setNewOBObject(true) on the new business object. This signals to Openbravo that the object is new eventhough its id is set.

=== not-null property references a null or transient value: *.updated ===
Same issue as the previous one.

=== org.hibernate.TransientObjectException: object references an unsaved transient instance - save the transient instance before flushing: .... ===

This exception occurs when you save an object which refers to another object which has not yet been saved. It applies to so-called many-to-one references, for example from Order to Currency (many orders use the same currency). Openbravo maps the many-to-one associations without cascading. This is for performance reasons.

To prevent this exception save the refered-to instance before the refering instance.

Note that in practice this exception does not happen that often as most references are from transactional to master data, and master data is traditionally setup before transactional data is created.

The import data/REST webservices take care of persisting objects in the correct order so therefore this exception does not occur when importing data through these processes.

=== Performance: getting the id of a BaseOBObject ===
To improve performance of single-ended associations, the DAL makes use of the Hibernate proxy functionality. The Hibernate proxy functionality wraps an object inside a Hibernate (cglib) proxy object. The Hibernate proxy object takes care of loading the business object when it is actually accessed and not before.

In many cases a developer just wants access to the id or entityname of an object. To prevent loading of the business object when retrieving just this information, the [https://code.openbravo.com/erp/devel/pi/file/ff43c7c0a97b/src/org/openbravo/dal/core/DalUtil.java DalUtil] class in ''org.openbravo.dal.core'' offers a ''getId'' method and a ''getEntityName'' method. These methods work directly with the HibernateProxy object and do not load the underlying business object.

=== Classloading ===
The DAL loads classes when initializing the DAL. The DAL as a default uses the context class loader of the thread. In some cases this does not work correctly (for example when using the DAL in Ant). The DAL uses the [https://code.openbravo.com/erp/devel/pi/file/ff43c7c0a97b/src/org/openbravo/base/util/OBClassLoader.java OBClassLoader] class to make the classloader configurable. By calling ''OBClassLoader.setInstance'' with your own OBClassLoader you can control the class loader used by the DAL.

=== NPE when calling a getter of a Business Object ===

All getters of Openbravo business objects return an Object. This is also the case for primitive type properties. In this way Openbravo can support null values in the database (will result in a null value for the property). However, null values result in NPE's when used directly in expressions.
For example take this code:
<source lang="java">SystemInformation sys = OBDal.getInstance().get(SystemInformation.class, "0");
return sys.isEnableHeartbeat();
</source>
When the value of 'enableHeartbeat' is null in the database then the call to isEnableHeartbeat will result in a NPE eventhough the sys variable is set correctly.

The same will happen when using results of getter-calls directly in numeric expressions.

=== DAL Queries do not return or do not see changes in the database ===
This can occur in the following situation:
# your program reads objects from the database using the DAL
# then you update the database directly without going through the DAL (either through direct sql or through a stored procedure), the database updates the objects/data you read through the DAL in step 1
# then your program uses the same objects as read in step 1 or you read them again from the database

The problem you encounter then is that the objects do not reflect the database state (they are not up-to-date). This is caused by the following:

When Hibernate reads data from the database it is stored in a cache for that session. This session cache is not auto-updated when data changes in the database outside of your hibernate session. So when in the last step you read the objects again from the database, you get the objects from the session-cache and not from the database.

There are 2 solutions:
# clear the session cache completely
<source lang="java">OBDal.getInstance().getSession().flush();
OBDal.getInstance().getSession().clear();
</source>
# force reread of specific objects
<source lang="java">OBDal.getInstance().getSession().refresh(myObject);
</source>

The first approach makes sense if there are many updates in the database or you don't know exactly which objects have changed. The second approach makes sense if you know exactly which object(s) have changed and there are not that many.

In case of the first solution you have to note that objects that have been read (through the DAL) before flushing/clearing can not be used anymore after flush/clear. These objects need to be re-attached to the session or read completely new from the database:
<source lang="java">// reattach an object from the database, only if it is not already part of it
if (OBDal.getInstance().getSession().contains(myObject)) {
OBDal.getInstance().getSession().lock(myObject.getEntity().getName(), myObject, LockMode.NONE);
}
// or reread it again, this example assumes that the object
// is a Business Partner
BusinessPartner businessPartner = OBDal.getInstance().get(BusinessPartner.class, myPreviouslyReadBP.getId());
</source>

When choosing the 'lock' strategy it is important to choose the correct lock order. First lock the objects which are used by the other objects.

=== ERROR org.hibernate.LazyInitializationException - could not initialize proxy - no Session ===

Hibernate will lazily load objects which are referenced from other objects. So when an object A references an object B, then when reading A from the database, hibernate will create a so-called proxy object B, which is used by A. The B proxy object is not initialized (its data is not set), this initialization is done when B is accessed directly (calling a method on it for example).
To do this initialization hibernate needs the original hibernate session which was used to read A and create the B proxy object.

The LazyInitializationException occurs when this session is not valid anymore. This happens for example when OBDal.getInstance().commitAndClose() is called, this will close and remove the session. If an uninitialized proxy object is accessed after the commitAndClose call then this exception is thrown.

To prevent this make sure that the objects that you need after the commitAndClose are all initialized. This can be done using the Hibernate.initialize(object) call or by calling an arbitrary method on the object (for example getIdentifier()).

== REST Web Services ==

=== I am getting: 'Caused by: Object Entity(null) is new but not writable' ===

The REST webservice uses the '''default role, client and organization''' of the user. The error ''Caused by: Object Order(null) is new but not writable'' is caused by the fact that either the role or the organization of the user do not allow the writing/creating the entity you are passing in.

See this [http://forge.openbravo.com/plugins/espforum/view.php?group_id=100&forumid=549512&topicid=7012934&page=2 topic] in the Openbravo forum.

And see [https://issues.openbravo.com/view.php?id=13281 this issue] for a related bug fix.

=== My REST webservice does not return anything ===

If your REST webservice only returns this:<source lang="xml"><ob:Openbravo/>
</source>

Then most of the time the user you used to log in is not authorised to see the requested information.
Another reason for not seeing information is that the system will automatically add client and organization filtering to the REST query and only show objects which have active==true.

=== Using the REST XML Schema to generate (de-)serialization code ===

The [[REST_XML_Schema_Definition|REST XML Schema]] can be used to generate java or C# code which can be used to (de-)serialize the REST xml content in a type safe way. One thing to be aware of is that primitive typed elements (such as a name or description) have attributes defined in the XML Schema. This means that code generators will not create a String (or other primitive type) member/accessor but will instead use a separate generated type to encapsulate the primitive type value. This separately generated type also holds the other attributes.

See this [http://forge.openbravo.com/plugins/espforum/view.php?group_id=100&forumid=549511&topicid=6994738&topid=6995539 forum post] for a discussion around this.

=== Implementing your own webservice ===

There is a howto on this topic [[How_to_create_a_new_REST_webservice|here]].

=== Firefox Add-On:Poster, to test webservices ===
To support web service testing, Firefox has a nice add-on: [https://addons.mozilla.org/en-US/firefox/addon/2691 Poster]. This add-on allows you to POST/PUT XML to a URL and do GET and DELETE requests.

=== I am getting: 'message: "OBUIAPP_ActionNotAllowed" type: "user"' ===

You need to add the table you are trying to edit to the user profile in Role Access > Table Access

== Application Dictionary Data Model ==

=== Grids with CLOB fields fail on Oracle ===

Before 3.0MP4 CLOB fields are not supported in the grid in combination with Oracle. From 3.0MP4 onwards this is solved.

See these related issues:
* https://issues.openbravo.com/view.php?id=18517 (solved in MP4)
* https://issues.openbravo.com/view.php?id=15556
* https://issues.openbravo.com/view.php?id=13153

As a workaround: do not show the CLOB fields in the grid in Oracle, the form view should work fine.

=== Using search references not to show a drop down in non-editable fields ===

For the complete reference about Search reference, read the Search section in [[Data_Model|Data Model]] document.

A ''Search'' reference does not show a drop down list but just text box with the selected value and a button to call the search next to it. When the field is non writable the button is not shown and only appears the textbox.

If a column is known to be used always in non-editable fields and it follows the naming rule defined for ''TableDir'' references. It is a good practice not to set it as ''TableDir'' reference but as ''Search'' one, in this case is not necessary to set the ''Reference Search Key'' field. Doing this the generated page will be lighter because instead of generating a drop down list with all the elements it will just generate a textbox.

=== Application Dictionary syntax ===

Application Dictionary contains many examples of '''default values''', '''display logics''', '''read-only logics''' and '''validations''' syntax. Just query your database to find out how they are defined (you can execute these queries inside Openbravo ERP, logged with an user with ''System Administrator'' role inside ''Application Dictionary || Maintenance || SQL Query''). Find more info about dynamic expressions in the [[Dynamic_Expressions|''Dynamic Expressions'']] chapter of the Developer's Guide.

====Default values====
<source lang="sql">SELECT t.name AS table_name, c.name AS column_name, c.defaultvalue AS default_value
FROM ad_table t, ad_column c
WHERE c.defaultvalue is not null
--AND c.defaultvalue like '%+%'
--AND c.defaultvalue like '%SQL%'
AND c.ad_table_id = t.ad_table_id
ORDER BY t.name, c.name;
</source>

====Display logics====
<source lang="sql">SELECT w.name AS window, t.name AS tab, f.name AS field, f.displaylogic AS display_logic
FROM ad_window w, ad_tab t, ad_field f
WHERE f.displaylogic IS NOT NULL
AND w.ad_window_id = t.ad_window_id
AND t.ad_tab_id = f.ad_tab_id
ORDER BY w.name, t.name, f.name;
</source>

'''Example 1'''
If you want to restrict the access to a child tab based on the value of a field of its father tab you have to:
# Mark the column of the field inside the father's tab as ''Stored in Session''.
# Add to all the fields of the child tab a display logic in the form @Father_Column_Name@ = 'Value'
See, for instance, how it is done in ''Master Data Management || Product Setup || Attribute || Attribute >> Attribute Value'' when un-checking ''List'' check-box in ''Attribute'' tab by querying:
<source lang="sql">SELECT w.name AS window, t.name AS tab, f.name AS FIELD, f.displaylogic AS display_logic
FROM ad_window w, ad_tab t, ad_field f
WHERE f.displaylogic IS NOT NULL
AND w.ad_window_id = t.ad_window_id
AND t.ad_tab_id = f.ad_tab_id
AND UPPER(t.name) LIKE '%ATTRIBUTE VALUE%'
ORDER BY w.name, t.name, f.name;
</source>

====Read-only logics====
<source lang="sql">SELECT t.name AS table_name, c.name AS column_name, c.readonlylogic AS read_only_logic
FROM ad_table t, ad_column c
WHERE c.readonlylogic IS NOT NULL
AND c.ad_table_id = t.ad_table_id
ORDER BY t.name, c.name;
</source>

====Validations====
<source lang="sql">SELECT t.name AS table_name, c.name AS column_name, vr.code AS validation_rule
FROM ad_val_rule vr, ad_table t, ad_column c
WHERE c.ad_val_rule_id = vr.ad_val_rule_id
AND c.ad_table_id = t.ad_table_id
ORDER BY t.name, c.name;
</source>

== Build tasks ==

=== After export.database all the xml headers use double quotes ===

After export.database you see this in the top of the header:
<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
</source>
when diffing this with the repository you see that the repository has this (uses single quotes):
<source lang="xml"><?xml version='1.0' encoding='UTF-8'?>
</source>

The standard in Openbravo is to use single quotes. To solve this issue copy to '''''src-db/database/lib/wstx-asl-3.0.2.jar''''' file to ''lib'' folder inside your Ant folder.

Once it is copied to the ''lib'' folder inside your Ant folder, make sure the files have execution rights.

[[Category:Concepts]]

Common Issues Tips and Tricks - Revision history

Wikiadmin: Created page with "== Common Issues, Tips and Tricks == This part of the developers guide is dedicated to discussing common issues and answering frequently asked questions. It tries to provide..."