Gallery Asset Bulk Upload - BloomReach Experience - Open Source CMS

Install the Bulk Upload Plugin

BloomReach offers Enterprise support for this feature to BloomReach Experience customers. The release cycle of this feature may differ from our core product release cycle. 

Instructions

Add Maven Dependency

In the main pom.xml of your project, add a new property in the properties section. For the correct version number for your project, check the Release Notes page.

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

Add the following dependency in the cms-dependencies/pom.xml:

  <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>
Note: Since v13, the maven coordinates have been changed from com.onehippo.cms7:hippo-addon-gallery-asset-bulk-upload-* to com.bloomreach.cms.gallery-asset-bulk-upload:gallery-asset-bulk-upload-*.

Now, you're ready to use the plugin!

Configurations for Bulk Image Uploading Dialog

The following properties can be set at /hippo:configuration/hippo:workflows/gallery/image-gallery/frontend:renderer node for the Bulk Image Uploading Dialog.

 Property  Type  Description  Default Value
 option.overwrite.visible  String  If this is set to 'true', then the dialog shows a checkbox to indicate whether or not to overwrite any existing image at the same path.  'false'
 option.overwrite.value  String  The default value of whether or not to overwrite any existing image at the same path.  'false'
 option.publish.visible  String  If this is set to 'true', then the dialog shows a checkbox to indicate whether or not to publish any associated document(s) handled by custom SynchronousEventBus event listener(s). 
 The dialog itself does not do anything on the gallery image as gallery images are not publishable. The selection is simply passed to custom SynchronousEventBus event listener(s) which can read the selection through com.onehippo.cms7.galleryasset.bulkupload.GalleryProcessingContext#isPublishOption().  
 See Developer's How-to for detail. 
 'false'
 option.publish.value  String  The default value of whether or not to publish any associated document(s) handled by custom SynchronousEventBus event listener(s).  'false'

Configurations for Bulk Asset Uploading Dialog

The following properties can be set at /hippo:configuration/hippo:workflows/gallery/asset-gallery/frontend:renderer node for the Bulk Asset Uploading Dialog.

 Property  Type  Description  Default Value
 option.overwrite.visible  String  If this is set to 'true', then the dialog shows a checkbox to indicate whether or not to overwrite any existing asset at the same path.  'false'
 option.overwrite.value  String  The default value of whether or not to overwrite any existing asset at the same path.  'false'
 option.publish.visible  String  If this is set to 'true', then the dialog shows a checkbox to indicate whether or not to publish any associated document(s) handled by custom SynchronousEventBus event listener(s). 
 The dialog itself does not do anything on the gallery asset as gallery assets are not publishable. The selection is simply passed to custom SynchronousEventBus event listener(s) which can read the selection through com.onehippo.cms7.galleryasset.bulkupload.GalleryProcessingContext#isPublishOption(). 
 See Developer's How-to for detail.
 'false'
 option.publish.value  String  The default value of whether or not to publish any associated document(s) handled by custom SynchronousEventBus event listener(s).  'false'

Maximum ZIP File Upload Size

There's no special configuration for the limit of maximum ZIP file upload size other than the default upload-limit init parameter in the Wicket filter in CMS web application like the following:

  <!--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>
    <!-- Also, you might want to increase the request timeout as well to accept long time file upload requests. -->
    <init-param>
      <param-name>wicket.deployment.request.timeout</param-name>
      <param-value>600000</param-value>
    </init-param>
  </filter>
Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?