DAM upload field

DamUploadFieldDefinition renders a field for uploading files into a Magnolia workspace. This field is used by the Assets app for uploading assets into the dam workspace. It extends the basic upload field field and adds the following enhancements to the completed view:

The uploaded file is mapped to a media type based on its MIME type.
The default field labels are overridden with Media type specific labels such as Upload new image.
Actions for editing images in the media editor.
Actions for previewing images.
Thumbnail preview.

class: info.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition

Here's the completed view for an uploaded image.

Here's the completed view for an uploaded video.

DAM upload field properties

Simple DAM upload field configuration:

form:
  tabs:
    - name: tabUpload
      label: Upload
      fields:
        - name: upload
          class: info.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition
          label: Upload asset
          binaryNodeName: jcr:content
          editFileName: true

Node name	Value
form
tabs
tabUpload
fields
upload
binaryNodeName	jcr:content
class	info.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition
label	Upload asset
editFileName	true

You can use common field properties and the properties in the tables below in a basic upload field definition:

Properties:

`<field name>`	required Name of the field.
`allowedMimeTypePattern`	optional, default is `.` (all types)* Regular expression to filter allowed files by their MIME type. For example, to allow only Excel files set the value to `application.(excel\|xls)`. To allow images only, set the value to `image.`. For more information about the supported pattern, see `Pattern` . For digital asset management MIME types see MediaType.
`binaryNodeName`	optional, default is `binaryNodeName` Name of the subnode that will contain the file binary and related information.
`editFileFormat`	optional, default is `false` When set to `true`, the file extension displayed in the Format field is editable.
`editFileName`	optional, default is `false` When set to `true`, the file name displayed in the Name field is editable.
`maxUploadSize`	optional, default in BasicUploadFieldDefinition is Long.MAX_VALUE and is configurable; however, this seems to be superceded in CosMultipartRequestFilter, where it is set to 2000000000 (2 Gigabytes). Maximum file size in bytes.

Caption properties. Values are typically retrieved from a message bundle.

`<field name>`	required Name of the field
Empty view
`selectNewCaption`	optional, default is `Select a file to upload...` Text displayed as tooltip on the upload button.
`dropZoneCaption`	optional, default is `or <em>drag a file into this area</em> to upload it` Text displayed as label for dropping invitation.
`warningNoteCaption`	optional, default is You have aborted the upload of your file Text displayed in the warning note.
In progress view
`inProgressCaption`	optional, default is `Uploading file {0} ...` Text displayed as title.
`inProgressRatioCaption`	optional, default is `{0} of {1} uploaded` Text displayed as file upload ratio.
Completed view
`fileDetailHeaderCaption`	optional, default is `File detail` Text displayed as file detail header.
`fileDetailNameCaption`	optional, default is `Name` Text displayed as file name label.
`fileDetailSizeCaption`	optional, default is `Size` Text displayed as file size label.
`fileDetailFormatCaption`	optional, default is `Format` Text displayed as file format label.
`fileDetailSourceCaption`	optional, default is `Source` Text displayed as file source label.
`deleteCaption`	optional, default is `Upload a new File...` Text displayed as tooltip on the delete icon.
`selectAnotherCaption`	optional, default is `Upload a new File...` Text displayed on the upload button.
`successNoteCaption`	optional, default is `Your file has been uploaded successfully` Text displayed in the success note.
`errorNoteCaption`	optional, default is `An Error occurred while uploading your file` Text displayed in the error note.
`sizeInterruption`	optional, default is `A file size limitation` Text displayed in the warning when file size > `maxUploadSize`
`typeInterruption`	optional, default is `An unsupported upload file type` Text displayed in the warning when file type not in `allowedMimeTypePattern`
`userInterruption`	optional, default is `A user action` Text displayed in the warning when the user interrupts the upload.

Caption properties specific to the DAM upload field.

<field name>

required

Name of the field

lightboxCaption

optional, default is View in lightbox...

Text displayed as tooltip when you hover over the preview action icon.

editFileCaption

optional, default is Edit image...

Text displayed as tooltip when you hover over the edit action icon.

When using the basic upload field in a composite field use the DelegatingCompositeFieldTransformer. The other transformer classes do not work.

Usage

It's possible to configure the DamUploadFieldDefinition in dialogs or other apps, but keep in mind the file will placed into the workspace for which the field has been configured. For example, if you use the field in a dialog for a component template, then that file, when uploaded using the field, would be stored in the website workspace not the dam workspace. This is the same behavior as all other fields. It's best practice, whenever possible, to keep your assets in the DAM and link to them using a link field.

Page tree

DAM upload field

DAM upload field properties

Usage