The 5.7 branch of Magnolia reached End-of-Life on December 31, 2023, as specified in our End-of-life policy. This means the 5.7 branch is no longer maintained or supported. Please upgrade to the latest Magnolia release. By upgrading, you will get the latest release of Magnolia featuring significant improvements to the author and developer experience. For a successful upgrade, please consult our Magnolia 6.2 documentation. If you need help, please contact info@magnolia-cms.com.
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:
<field name> | required Name of the field. |
| optional, default is Regular expression to filter allowed files by their MIME type. For example, to allow only Excel files set the value to |
| optional, default is Name of the subnode that will contain the file binary and related information. |
| optional, default is When set to |
| optional, default is When set to |
| optional, default is Maximum file size in bytes. |
Caption properties. Values are typically retrieved from a message bundle.
<field name> | required Name of the field |
Empty view | |
| optional, default is Text displayed as tooltip on the upload button. |
| optional, default is Text displayed as label for dropping invitation. |
| optional, default is You have aborted the upload of your file Text displayed in the warning note. |
In progress view | |
| optional, default is Text displayed as title. |
| optional, default is Text displayed as file upload ratio. |
Completed view | |
| optional, default is Text displayed as file detail header. |
| optional, default is Text displayed as file name label. |
| optional, default is Text displayed as file size label. |
| optional, default is Text displayed as file format label. |
| optional, default is Text displayed as file source label. |
| optional, default is Text displayed as tooltip on the delete icon. |
| optional, default is Text displayed on the upload button. |
| optional, default is Text displayed in the success note. |
| optional, default is Text displayed in the error note. |
| optional, default is Text displayed in the warning when file size > |
| optional, default is Text displayed in the warning when file type not in |
| optional, default is 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 |
| optional, default is Text displayed as tooltip when you hover over the preview action icon. |
| optional, default is 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.