bpm’online development guide
Adding multiple records to a detail

Glossary Item Box


By default, a detail allows you to add only one record at a time. Adding multiple records to a detail is done through the LookupMultiAddMixin mixin.

A mixin is a class designed to extend the functions of other classes. Learn more about mixins in the “Mixins. The "mixins" property”.

The LookupMultiAddMixin is designed to extend detail schemas. It provides an opportunity to add multiple lookup records to a detail at the same time. 

The sequence of adding the multiple records selection functionality to a detail:

1. Create a replacing detail schema

2. Use mixin methods instead of base detail methods.

Case description

Implement multiple record selection in the [Contacts] detail on the [Opportunities] section records edit page.

Case implementation algorithm

1. Create a replacing view model schema of a detail

To do this, create a replacement client module in a custom package (Fig. 1). The procedure for creating a replacing client schema is covered in the “Creating a custom client module schema” article.

Fig. 1. Adding a replacing client module


Select the OpportunityContactDetailV2 schema as the parent object

Fig. 2. Adding replacing client module

2. Use mixin methods instead of base detail methods.

To use the LookupMultiAddMixin in a schema, add it to the mixins property and initialize it in the overridden init() schema method. Learn more about overriding the init() method in the “Modular development principles in bpm'online” article.

You will also need to override the “add” button displaying methods (getAddRecordButtonVisible()), saving detail page methods (onCardSaved()), and adding a detail record methods (addRecord()).

Saving a detail page and adding record methods include the openLookupWithMultiSelect() method for opening the help window for multiple selection and the associated getMultiSelectLookupConfig() method which configures the help window, is used. The description and parameters of these methods are given in Table 1.

Table 1. Methods for opening and configuring the help window

Methods. Description
openLookupWithMultiSelect(isNeedCheckOfNew) Opens a lookup window with a multiple selection option The isNeedCheckOfNew {bool} parameter indicates the need to check if the record is new.

Returns the configuration object for the help window. Object properties:

rootEntitySchemaName – root object schema;

rootColumnName – a connected column that indicates the root schema record;

relatedEntitySchemaName – connected schema;

relatedColumnName – a column that indicates the connected schema record.

In this case the help window will pull data from the OpportunityContact table using the Opportunity and Contact columns. 

The source code of the detail view model schema:

define("OpportunityContactDetailV2", ["LookupMultiAddMixin"], function() {
    return {
        mixins: {
            // Connecting the mixin to the schema.
            LookupMultiAddMixin: "Terrasoft.LookupMultiAddMixin"
        methods: {
            // Overriding the base method for initializing the schema.
            init: function() {
                // Initializing the mixin.
            // Overriding the base method for displaying the "Add" button.
            getAddRecordButtonVisible: function() {
                //Displaying the "add" button if the detail is maximized, even if the detail edit page is not implemented.
                return this.getToolsVisible();
            // Overriding the base method.
            // The save event handler for the detail edit page.
            onCardSaved: function() {
                // Opens the window for multiple record selection.
            // Overriding the base method of adding a detail record.
            addRecord: function() {
                // Opens the window for multiple records selection.
            // A method that returns a window configuration object.
            getMultiSelectLookupConfig: function() {
                return {
                    // Root schema — [Opportunities].
                    rootEntitySchemaName: "Opportunity",
                    // Root schema column.
                    rootColumnName: "Opportunity",
                    // Connected schema — [Contact].
                    relatedEntitySchemaName: "Contact",
                    // Root schema column.
                    relatedColumnName: "Contact"

After saving the schema and reloading the application page (with cache cleaning), the user will be able to select multiple records from the lookup (Fig. 4) by clicking the “add” detail record button (Fig. 3). All selected records will be added to the [Contacts] detail of the [Sales] section record edit page.

Fig. 3. Adding multiple records to a detail

Fig. 4. Selecting necessary records from a lookup

Fig. 5. Case result: all selected records are added to the detail

© bpm'online 2002-2017.

Did you find this information useful?

How can we improve it?