0029424: API change in process definition client side validation function

Openbravo Issue Tracking System - Openbravo ERP

View Issue Details

Project

Category

View Status

Date Submitted

Last Update

0029424

Openbravo ERP

A. Platform

public

2015-03-26 08:42

2015-04-07 07:59

Reporter

alostale

Assigned To

alostale

Priority

immediate

Severity

critical

Reproducibility

have not tried

Status

closed

Resolution

fixed

Platform

OS Version

Product Version

Target Version

3.0PR15Q1.3

Fixed in Version

Merge Request Status

Review Assigned To

OBNetwork customer

Web browser

Modules

Core

Support ticket

Regression level

Regression date

Regression introduced in release

Regression introduced by commit

Triggers an Emergency Pack

Summary

0029424: API change in process definition client side validation function

Description

In order to fix issue 0029416 Done button in process definition is locked while client side validations are being executed. If the validation succeeds, the complete UI is locked to execute the process, but if it fails, UI should be unlocked again.

As client side validation can perform asynchronous tasks, caller cannot decide when the UI should be unlocked, so this should be done by the client side definition function.

Proposed API change:

-Current API for client side validation functions [1] is:
  function (view, actionHandlerCall)
    This function is charge of invoking actionHandlerCall in case of successful validation or do nothing if they fail.


-New proposed API:
  function (view, actionHandlerCall, clientSideValidationFail)
    Now the function should call actionHandlerCall in case of success and clientSideValidationFail in case of invalid.

[1] http://wiki.openbravo.com/wiki/How_to_create_a_Standard_Process_Definition#Invoking_a_client_side_validation_before_calling_the_action_handler [^]

Steps To Reproduce

Proposed Solution

This change affects to all process definitions with client side validations (this feature was added in PR14Q3), it affects 5 processes in Openbravo 3 distribution, but as it is a relatively new feature, we don't expect many modules making use of it.

Risk assessment: medium

Components affected by this change that are not updated would misbehave in case parameter values don't satisfy client side validation, in which case Done button would be locked. When in this situation, button would be unlocked in case of changing parameter values or if the process popup/window is reopened.

Note if issue 0029388 is backported to PR15Q1, this API change will also be backported.

Additional Information