Content Dependencies module

Edition DX Core

License

MLA

Issues

MGNLCDEP

Maven site

Content Dependencies

Latest

2.0.2

Content dependencies are references between content items. When a page links to another page, a dependency is created. Similarly, when a page uses an asset from the DAM, a dependency is created between the page and the asset.

The Content Dependencies module displays dependencies between the selected content item and other items, whether the items reside in the same Magnolia workspace or in different ones. Editors can see the consequence of deleting the selected item and whether dependent items need to be published together.

image

image

Installing with Maven

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

<dependency>
  <groupId>info.magnolia</groupId>
  <artifactId>magnolia-module-content-dependencies</artifactId>
  <version>2.0.2</version>
</dependency>

Dependencies tab

A typical use case is adding a dependencies tab to a page properties dialog. The tab has two fields:

  1. Lists content items that link to the item

  2. Lists items the item links to.

Property Description

tabDependencies

required

Dependencies tab.

     fields

required

Fields node.

         <field name>

required

referencesFrom and referencesTo fields extend the generic references field.

             references

required

References node.

                 <workspace name>

required

Arbitrary node name. One for each workspace you want to track.

                     appMapping

required

Subapp in app:<app name>:<subapp name> format.

                     workspace

required

Workspace name.

                     nodeType

required

Node type.

                     referenceProperties

required

                     pathResolver

optional

Path resolver node.

                         class

optional, default is `info.magnolia.module.dependencies.field.resolver.PathResolverImpl`

Default implementation returns a node’s path. AssetPathResolverImpl implements PathResolver for assets.

                     appLocationFactory

optional

App location factory node.

                         class

optional, default is `info.magnolia.module.dependencies.field.factory.AppLocationFactoryImpl`

Default implementation creates an app’s location. DamAppLocationFactoryImpl implements AppLocationFactory for the Assets app.

                     label

optional

Label displayed in dialog.

             class

required

DependenciesViewDefinition shows dependencies to and from workspaces.

             referencesTo

optional, default is false

Whether items linking to the item should be included.

Adding dependencies tab to dialogs

Example: Adding a dependencies tab to MTK’s basic page dialog.

<light-module-folder>/<light-module-name>/decorations/mtk2/dialogs/pages/basic.yaml

form:
  properties:
    referencesTo:
      class: info.magnolia.module.dependencies.ui.field.DependenciesViewDefinition
      referencesTo: true
      references:
        pages:
          appMapping: app:pages-app:browser
          workspace: website
          referenceProperties:
            - link
            - linkTypepage #teaser component
    referencesFrom:
      class: info.magnolia.module.dependencies.ui.field.DependenciesViewDefinition
      referencesTo: false
      references:
        pages:
          appMapping: app:pages-app:browser
          workspace: website
          referenceProperties:
            - link
            - linkTypepage #teaser component
        assets:
          appMapping: app:dam:jcrBrowser
          workspace: dam
          pathResolver:
            class: info.magnolia.module.dependencies.field.resolver.AssetPathResolverImpl
          appLocationFactory:
            class: info.magnolia.module.dependencies.field.factory.DamAppLocationFactoryImpl

  layout:
    tabs:
      - name: tabDependencies
        fields:
          - name: referencesTo
          - name: referencesFrom

Here is the dependencies tab after adding it to the Travel Demo’s Page properties dialog and viewing it on the About page.

  • This page is depended upon by:

    • Pages: Lists pages that link to the page.

  • This page depends on:

    • Pages: Lists pages the page links to.

    • Assets: Lists assets added to the page.

All links are clickable and open the item in the target app.

image

Reference properties

Reference properties are properties that the module uses retrieve nodes that an item depends on. They are typically properties that hold references to other nodes and whose value is the JCR identifier or UUID.

If you do not include the correct reference properties in your configuration, the items will not show up in the depends on section of the dependencies tab.

The easiest way to find the correct reference properties to configure is to export the JCR content or to look in the JCR Browser app.

Here is the video component (column 1) and Our Company teaser component (column 2) on the About page in the website workspace:

'00':
  'headline': 'About Magnolia Travels'
  'headlineLevel': 'small'
  'headline_de': 'Über Magnolia Travels'
  'imagePosition': 'below'
  'jcr:primaryType': 'mgnl:component'
  'jcr:uuid': '01db6fc1-78af-4284-adf0-8c997309df6a'
  'mgnl:activationStatus': true
  'mgnl:created': 2015-02-02T19:23:37.199Z
  'mgnl:createdBy': 'superuser'
  'mgnl:lastActivated': 2015-10-27T12:50:52.396Z
  'mgnl:lastActivatedBy': 'superuser'
  'mgnl:lastModified': 2015-06-18T09:08:06.983Z
  'mgnl:lastModifiedBy': 'superuser'
  'mgnl:template': 'travel-demo:components/jumbotron'

Deletion Warnings

The module displays dependency-ware deletion warning messages in the Pages and Assets apps by default. The confirmation dialog lists links to the referring items that will be broken once the deletion is complete.

image

Deletion warnings are configured in the confirmDeleteAsset action defintion. The configuration patterns follow those of the dependencies tab (above).

You can configure dependency-aware delete warnings in any app by adding a references node to deleteConfirmationAction.

ConfirmDeletion action in the Assets app.

Property Description

<action name>

required

Action node.

     references

required

References node.

         <workspace name>

required

Arbitrary node name. One for each workspace you want to track.

             workspace

required

Workspace name.

             nodeType

required

Node type.

     class

required

DependencyAwareConfirmationActionDefinition adds dependency awareness to the action.

     icon

optional

CSS class that identifies an icon used for the action. For available names, see Icons.

     successActionName

required

Name of action to execute on confirmation.

Feedback