Image placement module

Edition

Incubator (services)

Issues

IMGPLACE

Git

Git

Latest

2.0

Compatible with Magnolia 6.2.

The Image Placement module enables you to see the image utilization of the assets stored in the magnolia dam. It shows you how often an image is placed as well as when it was placed the last time.

This module is at the INCUBATOR level.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.dam</groupId>
  <artifactId>magnolia-image-placement</artifactId>
  <version>2.0</version>
</dependency>

Configuration

Default configuration

The default configuration of the module is located at /image-placement/config.yaml

scheduled: false
workspaceConfig:
    stories:
        nodeType: mgnl:composition
        workspace: stories
    pages:
        nodeType: mgnl:page
        workspace: website
referenceProperties:
    - images
    - image
    - imagesource
    - backgroundImage

Field descriptions

Property Description

scheduled

optional, default is `false`

False: In this case, the placements are updated for images with every change of an image.

True: In this case, a scheduler validates whether an update of all placements is necessary. If yes, the scan is carried out.

workspaceConfig

required

Defines the workspaces in which placements are searched for.

referenceProperties

required

Defines the property names that can trigger an update event.

Usage

dam app

Scanned workspaces

As per default, the following workspaces are scanned:

  • pages

  • stories

If you wish to add more, you need to decorate the config.yaml here /image-placement/config.yaml.

Scanned properties

As per default, the module scan only the following node properties for image references:

  • contact

  • image

  • link

  • teaserImg

If you have image data linked in other node properties, you need to decorate the config.yaml here /image-placement/config.yaml..

Post process

In case you install this module after assigning images, you can use the groovy script imagePlacementProcessor for indexing the images accordingly.

groovy script

Changelog

Version Notes

2.0

IMGPLACE-1 - Placement count is not removed if image is not used anymore

1.0.7
Feedback

Incubators

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the Image placement module docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules