Install the Bulk Upload Plugin

Info: Bloomreach provides Enterprise support for this feature to Bloomreach Experience customers. The release cycle for this feature may differ from the core product release cycle.

Installation Steps

Add Maven Dependency

1. In your project's main pom.xml, add a property for the Bulk Upload Plugin version in the properties section. Refer to the Release Notes for the correct version number.

    <bloomreach.gallery-asset-bulk-upload.version>version-number</bloomreach.gallery-asset-bulk-upload.version>
copy

2. In cms-dependencies/pom.xml, add the following dependencies:

  <dependency>
    <groupId>com.bloomreach.cms.gallery-asset-bulk-upload</groupId>
    <artifactId>gallery-asset-bulk-upload-repository</artifactId>
    <version>${bloomreach.gallery-asset-bulk-upload.version}</version>
  </dependency>
 
  <dependency>
    <groupId>com.bloomreach.cms.gallery-asset-bulk-upload</groupId>
    <artifactId>gallery-asset-bulk-upload-frontend</artifactId>
    <version>${bloomreach.gallery-asset-bulk-upload.version}</version>
  </dependency>
copy

After adding these dependencies, the plugin is available for use.

Configure Bulk Image Upload Dialog

You can configure the Bulk Image Upload dialog by setting properties at the /hippo:configuration/hippo:workflows/gallery/image-gallery/frontend:renderer node.

Property	Type	Description	Default Value
option.overwrite.visible	String	When set to 'true', displays a checkbox to allow overwriting an existing image at the same path.	'false'
option.overwrite.value	String	Sets the default value for overwriting an existing image at the same path.	'false'
option.publish.visible	String	When set to 'true', displays a checkbox to allow publishing associated documents handled by custom SynchronousEventBus event listeners. The dialog does not publish gallery images directly, as they are not publishable. The selection is passed to custom listeners, which can access it via com.onehippo.cms7.galleryasset.bulkupload.GalleryProcessingContext#isPublishOption(). See the Developer's How-to for details.	'false'
option.publish.value	String	Sets the default value for publishing associated documents handled by custom SynchronousEventBus event listeners.	'false'

Configure Bulk Asset Upload Dialog

Configure the Bulk Asset Upload dialog by setting properties at the /hippo:configuration/hippo:workflows/gallery/asset-gallery/frontend:renderer node.

Property	Type	Description	Default Value
option.overwrite.visible	String	When set to 'true', displays a checkbox to allow overwriting an existing asset at the same path.	'false'
option.overwrite.value	String	Sets the default value for overwriting an existing asset at the same path.	'false'
option.publish.visible	String	When set to 'true', displays a checkbox to allow publishing associated documents handled by custom SynchronousEventBus event listeners. The dialog does not publish gallery assets directly, as they are not publishable. The selection is passed to custom listeners, which can access it via com.onehippo.cms7.galleryasset.bulkupload.GalleryProcessingContext#isPublishOption(). See the Developer's How-to for details.	'false'
option.publish.value	String	Sets the default value for publishing associated documents handled by custom SynchronousEventBus event listeners.	'false'

Configure Maximum ZIP File Upload Size

The maximum ZIP file upload size is controlled by the upload-limit init parameter in the Wicket filter configuration for the CMS web application. There is no additional configuration specific to the Bulk Upload Plugin.

Example configuration:

  <!--Default application-->
  <filter>
    <filter-name>CMS</filter-name>
    <filter-class>org.apache.wicket.protocol.http.WicketFilter</filter-class>
    <!-- SNIP -->
    <init-param>
      <param-name>upload-limit</param-name>
      <param-value>100m</param-value>
    </init-param>
    <!-- You may also want to increase the request timeout to support large file uploads. -->
    <init-param>
      <param-name>wicket.deployment.request.timeout</param-name>
      <param-value>600000</param-value>
    </init-param>
  </filter>
copy