Nuxeo Server

How to Customize the Bulk Edit Form

Updated: October 13, 2017 Page Information Edit on GitHub

The bulk edit screen offers a form that allows to edit several documents at the same time. This is implemented using the BulkEditService component. You can customize it with Studio by creating a form layout named bulkEdit. The "Edit" layout will be used on the bulk edit popup. The default bulk edit layout can be found on GitHub or in the Explorer.

Creating a Form Layout in Studio

  1. In Studio, go to Listings & Views > Form Layouts and click on New.
  2. Fill in the Feature ID: bulkEdit and click on Next.

    Make sure that your form layout is named bulkEdit to override the default one.

  3. Go to the Edit Layout tab.
  4. Drag and drop the widgets you need.
  5. In the Advanced Configuration part, attach the layout_bulkedit_template.xhtml which is in the folder $NUXEO/nxserver/nuxeo.war/layouts.

    See the GitHub documentation about the layout bulk edit template.

  6. Click on Save.

Deploying Changes on Your Nuxeo Platform Instance

  1. Go to your Nuxeo Platform instance.
  2. Connect as Administrator with Administrator password.
  3. Click on Admin Center > Update Center > Nuxeo Studio.
  4. Click on the Update button.
  5. Go to a workspace and edit your documents.

Specific Cases

When you want to create a bulk edit form with the possibility to edit the collections and the tags, you need a particular configuration.

Tags

When you configure a widget to select tags, the field that needs to be referenced is contextData['request/bulk_tags']

  1. Drag and drop a generic widget from the right to the grid.
  2. Fill in the creation form.
  3. In the Edit Properties, select Yes for the Can Select New Tag field.
  4. Click on Save and deploy your changes on your instance.

Collections

When configuring a widget to select collections, the field that needs to be referenced is contextData['request/bulk_collections'].

  1. Drag and drop a generic widget from the right to the grid.
  2. Fill in the creation form.
  3. Fill in the Edit properties:

    Document page provider name default_document_suggestion
    Selection Formatter formatSelectedCollection
    Suggestion Formatter formatSuggestedCollection
  4. In the Custom properties part fill in the following fields:

    restoreSeamCtx false
    operationId Collection.Suggestion
  5. Click on Save and deploy your changes on your instance.

    You should end up with something like this:

Customizing the Bulk Edit Versioning Policy

When users edit several documents at the same time using the bulk edit form, a new version of the documents is saved before applying the modifications. The default versioning policy is to create a minor version.

This versioning policy can be configured through the versioning extension point:

<extension target="org.nuxeo.ecm.webapp.bulkedit.BulkEditService"
  point="versioning">
  <versioning>
    <defaultVersioningOption>MINOR</defaultVersioningOption>
  </versioning>
</extension>
9 days ago manonlumeau NXDOC-1346-FT review screenshot
a year ago Solen Guitter 51 | pdate how-to topic
2 years ago Solen Guitter 50
2 years ago Solen Guitter 49 | Add TOC
3 years ago Manon Lumeau 48
3 years ago Manon Lumeau 47
3 years ago Manon Lumeau 46
3 years ago Manon Lumeau 45
3 years ago Manon Lumeau 44
3 years ago Manon Lumeau 43
3 years ago Manon Lumeau 42
3 years ago Manon Lumeau 41
3 years ago Manon Lumeau 40
3 years ago Manon Lumeau 39
3 years ago Manon Lumeau 36
3 years ago Manon Lumeau 37
3 years ago Manon Lumeau 38
3 years ago Manon Lumeau 35
3 years ago Manon Lumeau 32
3 years ago Manon Lumeau 33
3 years ago Manon Lumeau 34
3 years ago Manon Lumeau 31
3 years ago Manon Lumeau 29
3 years ago Manon Lumeau 30
3 years ago Manon Lumeau 28
3 years ago Manon Lumeau 27
3 years ago Manon Lumeau 26
3 years ago Manon Lumeau 25
3 years ago Manon Lumeau 24
3 years ago Manon Lumeau 23
3 years ago Manon Lumeau 22
3 years ago Manon Lumeau 21
3 years ago Manon Lumeau 20
3 years ago Manon Lumeau 19
3 years ago Manon Lumeau 18
3 years ago Manon Lumeau 17
3 years ago Manon Lumeau 16
3 years ago Manon Lumeau 15
3 years ago Manon Lumeau 14
3 years ago Manon Lumeau 13
3 years ago Manon Lumeau 12
3 years ago Manon Lumeau 11
3 years ago Manon Lumeau 10
3 years ago Manon Lumeau 9
3 years ago Manon Lumeau 8
3 years ago Manon Lumeau 7
3 years ago Manon Lumeau 6
3 years ago Manon Lumeau 5
3 years ago Manon Lumeau 4
3 years ago Manon Lumeau 3
3 years ago Manon Lumeau 2
3 years ago Manon Lumeau 1
History: Created by Manon Lumeau