Skip to content

Manage media assets

This section describes how to manage media assets and view configuration settings using HCL Digital Asset Management (DAM).

Prerequisite

HCL DAM CF181 or higher should be installed and configured for the HCL Digital Experience (HCL DX) 9.5 Container Release update, following these instructions in the Install the HCL DX 9.5 Container components topic.

Viewing supported file formats

Follow these steps to view a list of file formats supported by HCL DX 9.5 DAM.

HCL DAM CF181 or later must be installed and configured for the HCL Digital Experience (DX) 9.5 Container Release update by following the instructions in the Install the HCL Digital Experience 9.5 Container components topic.

Viewing supported file formats

Follow these steps to view the list of file formats supported by HCL DX 9.5 DAM.

  1. Log in to your HCL DX 9.5 platform and select Digital Assets from the Practitioner Studio navigator.

    Digital Asset Management user interface

    The HCL DX 9.5 DAM can also be accessed from the Practitioner Studio Digital Assets tile.

  2. From the HCL DX 9.5 DAM user interface, select the gear icon (for Settings) located at the top right of the DAM menu bar.

  3. Settings will display the Supported file formats section by default.

    DAM > Settings > Files

The following are supported media asset file formats in HCL DX 9.5 Container. From CF205 onwards, WebP file type extension is also supported.

File type Extension
.png image/png
.gif image/gif
.jpg image/jpeg
.jpeg image/jpeg
.tif image/tiff
.tiff image/tiff
.webp image/webp

Note

File type Extension
.ogv video/ogg
.mp4 video/mp4
.webm video/webm

Notes

  • Videos are automatically synchronized once they are uploaded. Auto-synchronization is a background activity in HCL DAM that happens when any video is uploaded and when Kaltura integration is configured and enabled.

  • You can set the maximum file size for DAM asset uploads. For more information on configuring the file size, refer to the MediaTypeGroupController.updateById API documentation topic.

  • Videos are automatically synchronized after they are uploaded. Auto-synchronization is a background process in HCL DAM that occurs when a video is uploaded and Kaltura integration is configured and enabled.

File type Extension
.pptx application/vnd.openxmlformats-officedocument.presentationml.presentation
.xls application/vnd.ms-excel
application/octet-stream
application/x-msi
.doc application/msword
.docx application/vnd.openxmlformats-officedocument.wordprocessingml.document
.xlsx application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
.ppt application/vnd.ms-powerpoint
.pdf application/pdf

Note

DAM does not scan uploaded files for viruses or vulnerabilities. PDF files and similar file types can be manipulated to include active code. Users with access to DAM should scan files for potential security issues. If scanning is not possible, disable file types that could be exploited by active code (for example, PDF files).

Enabling or adding other file types by using the DAM MediaTypeController API

This section explains how to enable additional file types in HCL DX DAM that are not included in the default supported file formats. It also explains how to add, configure, and activate new media types for asset uploads by using the DAM MediaTypeController API.

  1. Authenticate with the DAM API. Log in to the Ring API using:

    POST https://<domain>/dx/api/core/v1/auth/login
    

  2. Identify the media type group.

    Retrieve the list of media type groups (such as images, videos, etc.) to find the appropriate group for your file type:

    GET https://<domain>/dx/api/dam/v1/mediatypegroups
    

  3. Add a new MIME type. To enable uploading a new file type (for example, WebP or other formats), send a POST request to add it to DAM: http POST https://<domain>/dx/api/dam/v1/mediatypes

    Payload Example for Adding a New File Type
    
    [ { "mimeType": "image/webp", "extensions": ["webp"], "mediaTypeGroupId": "<mediaTypeGroupId>" } ] Replace "image/webp", ["webp"], and mediaTypeGroupId with your desired MIME type, file extensions, and the media type group ID retrieved earlier.

  4. Enable an existing or newly added file type. If a file type exists but is disabled, use a PATCH request to enable it:

    PATCH - https://<domain>/dx/api/dam/v1/mediatypes/<id>
    
    Payload example:
    {
    "enabled": true
    }
    
    The <id> is the ID for the media type obtained from the GET mediatypes endpoint.

  5. Verify and add additional configuration.

After enabling or adding the new file type, verify its status using a GET request to mediatypes.

Example:

To add and enable SVG or other custom formats, follow the GET media type group and POST/PATCH steps above. This allows uploading file types beyond those listed in the Supported file formats section.

Enabling or disabling other file types

To enable file types that are not listed in the Viewing supported file formats section for HCL DX DAM, you can use the DAM MediaTypeController API. The process involves adding new file types and enabling or disabling them for uploads.

Note

The SVG file type is disabled by default. To enable .svg files (image/svg+xml) for asset uploads, use the enabled parameter in the MediaTypeController.updateById API. For more information, see the MediaTypeController.updateById API documentation.

Playing a video in DAM

Play uploaded videos in DAM using the DAM binary URL or the Kaltura Player (if the Kaltura plugin is configured and enabled):

  • Use the DAM binary URL when:

    • The uploaded video synchronization status is SYNC FAILED.
    • The Kaltura plugin is not configured and enabled.

    Using the DAM binary URL to play a video

  • Use the Kaltura Player when:

    • The video synchronization status is SYNCED. Play the video based on the configured Player ID.
    • The Kaltura plugin is configured and enabled.

    Playing a video using the Kaltura Player For more information on the video synchronization statuses for uploaded videos, see Upload rich media assets.

Downloading a media asset source, version, or rendition

Use the HCL DX 9.5 DAM editor to download a media asset source, version, or rendition:

  1. From the HCL DX 9.5 DAM user interface, click the More actions menu (three horizontal dots icon) for a media asset, then click Download.

    Digital asset menu options

  2. A pop-up appears where you can select download actions. You can rename the downloaded media asset and choose to download Source, Renditions, or all asset types.

    Download media asset and renditions

  3. Click Download to proceed.

Moving a media asset to trash

Use the HCL DX 9.5 DAM editor to delete a media asset, including its renditions:

  1. From the HCL DX 9.5 DAM user interface, click the More actions menu (three horizontal dots icon) of a media asset. Click Delete.
  2. A pop-up will appear for you to select your Delete action. If the selected media assets will not affect any references, click Check for references and delete to complete action.

Use the HCL DX 9.5 DAM editor to move a media asset to trash, including its renditions:

  1. From the HCL DX 9.5 DAM user interface, click the More actions menu (three horizontal dots icon) of a media asset. Click Move to trash.
  2. A pop-up will appear for you to select your move to trash action. If the selected media assets will not affect any references, click Check for references and move to trash to complete action. If there are references, additional dialog appears citing the presence of reference item. Clicking on that will complete the action

Use the HCL DX 9.5 DAM editor to move a media asset to trash, including its renditions:

  1. From the HCL DX 9.5 DAM user interface, click the More actions menu (three horizontal dots icon) for a media asset, then click Move to trash.
  2. A pop-up appears where you can select the move-to-trash action. If the selected media assets do not affect any references, click Check for references and move to trash to complete the action. If references exist, an additional dialog appears indicating referenced items. Clicking it completes the action.

    Check references and move media asset to trash References found while moving media asset to trash

Permanent delete of media asset from trash

Use the HCL DX9.5 DAM editor to permanently delete a media asset:

  1. From the HCL DX9.5 DAM interface, click the Settings and go to Trash section and click Go to trash. Once trash is rendered click More actions menu of a media asset and click Permanently delete.

Use the HCL DX 9.5 DAM editor to permanently delete a media asset:

Accessing trash

  1. From the HCL DX 9.5 DAM interface, click Settings, go to the Trash section, and click Go to trash. Once the Trash view is displayed, click the More actions menu for a media asset, then click Permanently delete.

  2. A confirmation message appears. Permanently deleting a media asset is an irreversible action that removes the data from the database.

  3. Click Delete permanently to confirm the action.

Copying a media asset

When copying a media asset, only the latest version of the source assets is copied.

Refer to the following steps if you want to copy a media asset from one collection to another.

  1. Click the More actions menu for the asset.

    This displays actions such as Edit, Properties, Preview, Copy Link, Download, Copy, Move, Rename, and Move to trash.

  2. Click Copy.

    A dialog box appears that shows the list of collections. You can search for a specific collection or navigate inside a collection if a subcollection is present.

  3. Navigate to the collection where you want to copy the asset and click Paste here.

    If you copy an asset to the same collection, a dialog box appears to rename the asset.

  4. Click View Location to navigate to the collection.

Moving a media asset

Refer to the following steps if you want to move a media asset from one collection to another.

Note

Moving an asset can break its links if it is referenced in WCM or external systems. To update the link, manual relinking is required. To view asset references, go to Properties > Insights.

  1. Click the More actions menu for the asset.

    This displays actions such as Edit, Properties, Preview, Copy Link, Download, Copy, Move, Rename, and Move to trash.

  2. Click Move.

    A dialog box appears that shows the list of collections. You can search for a specific collection or navigate inside a collection.

    Move a media asset

  3. Navigate to the collection where you want to move the item and click Check for references and move.

    The confirmation dialogue appears if the asset is referenced in WCM. If an asset with the same name exists in the target collection, a dialogue box to rename the asset appears.

  4. Click View Location to navigate to the collection.

Renaming a media asset

Refer to the following steps to modify the name of a media asset.

Note

Renaming an asset breaks existing references to the asset name in WCM or external content. To update the asset name, manual relinking is required.

  1. Click the More actions menu for the asset.

    This displays actions such as Edit, Properties, Preview, Copy Link, Download, Copy, Move, Rename, and Move to trash.

  2. Click Rename.

    A dialogue box appears for renaming the media asset.

    Rename a media asset

  3. In the Rename dialog box, enter the new name of the media asset, then click Rename.

Another way to rename a media asset is to edit the asset by clicking the Pencil icon. Go to Properties. You can edit the Name, Title, and Description of the media asset. Click Save.

Enabling or disabling file types

Use the DAM MediaTypeController API to enable or disable supported file types for asset uploads in HCL DX DAM. For more information on how configure the HCL DX server to recognize other images, refer to How to enable support for additional image formats in HCL Web Content Manager

The SVG file type is disabled by default. To enable the .svg file type (image/svg+xml) for asset uploads, use the enabled parameter with the MediaTypeController.updateById API described in this documentation topic.

Changing duplicate asset names using DAM

If an asset has the same name as another asset in a collection, a rename dialog appears when editing the asset.

Notification to rename an asset

Copying friendly URLs for assets

You can copy the friendly URL and UUID URL of an asset from the URLs section of the asset's inspector panel.

HCL DX Solution Feedback

HCL DX is interested in your experience and feedback working with HCL DX 9.5 release software. To offer comments or issues on your findings, please access the HCL DX 9.5 Feedback Reporting application.

HCL DX welcomes your feedback on HCL DX 9.5 release software. To provide comments or report issues, access the HCL Digital Experience 9.5 Feedback Reporting application.

Related information