Wikiadmin: Created page with "{{(!)| Contents in this document are available from '''3.0MP20'''}} == Introduction == ''Multi Selector'' is a reference that allows to select multiple items at the same tim..."

2018-10-15T13:42:41Z

Created page with "{{(!)| Contents in this document are available from '''3.0MP20'''}} == Introduction == ''Multi Selector'' is a reference that allows to select multiple items at the same tim..."

New page

{{(!)| Contents in this document are available from '''3.0MP20'''}}

== Introduction ==

''Multi Selector'' is a reference that allows to select multiple items at the same time. It is intended to be used as parameter of ''[[How_to_create_a_Standard_Process_Definition|Standard Process Definition]]''.

Multi Selector reference is defined pretty much as regular selectors (which allow to select a single value). For more information about selectors take a look to this [[Selector_Example|example]].

== Example Module ==
This howto is supported by an example module which shows examples of the code shown and discussed.

The code of the example module can be downloaded from this mercurial repository: https://code.openbravo.com/erp/mods/org.openbravo.client.application.examples/

The example module is available through the Central Repository (See 'Client Application Examples'), for more information see the [[Projects/ExamplesClientApplication|Examples Client Application]] project page.

== Steps to implement the Process ==

=== Overview ===

This howto explains how to create a Multi Order selector.

[[Image:MultiSelector1.png|center|250px]]
[[Image:MultiSelector2.png|center|550px]]

=== Defining the Selector ===

* As ''System Administrator'' open ''Reference'' window.
* Create a new record.
** Name: Multi Order Selector
** Parent Reference: OBUISEL_Multi Selector Reference
* In ''Defined Selector'' tab, set the properties for the selector:
** Template: Selector Template
** Table: C_Order

=== Adding fields to Selector's Pop Up ===

Last step is to define which are the fields that will be present in the popup to select records.

* Go to ''Defined Selector Field'' tab
* Create records:
** Name: it is the name the use will see (i.e. Business Partner)
** Property: actual property to retrieve information from (i.e. businessPartner)
** Sorting of columns in the grid: Position of this column in the grid (i.e. 20)

[[Image:MultiSelectorAD1.png|center|650px]]

=== Using the Selector ===

This selector can be used as parameter for a Process Definition. In [[How_to_create_a_Standard_Process_Definition#Adding_Parameters|this howto]] it is used.

=== Retrieving values in backend ===

In backend, the Java implementing the process, receives an <code>JSONArray</code> with the IDs of all selected rows. In case no row is selected, an empty array is received.

<source lang="java">
//...
JSONArray orders = params.getJSONArray("orders"); // get the array

// iterate it
for (int i = 0; i < orders.length(); i++) {
// ...
}
</source>

== Advanced topics ==

=== Using custom query selector ===

When using a [[Selector_Example|custom query to define the selector]], there must be an alias in the query named <code>_identifier</code> which will be used as user readable identifier for the selected records and another one named <code>id</code> which will be sent to backend as id of the selected records. Fields for these query columns with the same names are also required.

== Limitations ==

Multi Selectors can only be used as parameters in ''Standard Process Definition'', they cannot be included in ''Standard Windows''.

[[Category:HowTo]]

How to create a Multi Selector - Revision history

Wikiadmin: Created page with "{{(!)| Contents in this document are available from '''3.0MP20'''}} == Introduction == ''Multi Selector'' is a reference that allows to select multiple items at the same tim..."