Content Dependencies module

The Content Dependencies module allows you to add a tab to a dialog that displays dependent items from both the current and other Magnolia workspaces. Editors can see what the consequence of deleting the item will be and whether dependent items need to be activated. 

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

Installing

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

• magnolia-module-content-dependencies.jar

Dependencies tab

The module includes a preconfigured Dependencies tab that is designed to be added 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. 

The Dependencies tab is configured in /modules/dependencies/dialogs/tabDependencies. Both fields extend the reference field configuration.

Properties:

Adding Dependencies tab to dialogs

The easiest way to make the Dependencies tab available to editors is to use the ready-made tab from the module. 

• JCR: If you configure your dialog using JCR nodes,  extend  the  tabDependencies definition. 
• YAML: If you configure your dialog using a YAML file,  paste the tab configuration below into your form definition.

Example: Adding Dependencies tab to MTE's pageProperties dialog.

form:
  i18nBasename: info.magnolia.templating.models.messages
  label: pages.pageProperties.label
  tabs:
    - name: tabMain
      # Main tab configuration
    - name: tabMeta
      # Meta tab configuration
    - name: tabDependencies   
      fields:
        - name: referencesTo
          class: info.magnolia.module.dependencies.field.DependenciesFieldDefinition
          referencesTo: true
          references:
            pages: 
              appMapping: app:pages:browser
              workspace: website
        - name: referencesFrom
          class: info.magnolia.module.dependencies.field.DependenciesFieldDefinition
          referencesTo: false
          references:
            pages: 
              appMapping: app:pages:browser
              workspace: website
            assets:
              appMapping: app:assets:browser
              workspace: dam
              patheResolver:
                class: info.magnolia.module.dependencies.field.resolver.AssetPathResolverImpl
              appLocationFactory:
                class: info.magnolia.module.dependencies.field.factory.DamAppLocationFactoryImpl
actions:
# Actions configuration

Here's 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.

Here are the components on the About page that are picked up in the depends on section of the dialog.

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. 

Reference properties are configured in /modules/dependencies/config/referenceProperties. 

Example: Reference properties to display dependent pages from the website workspace, and images and videos from the dam workspace.

The easiest way to find the correct reference properties to configure is 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 in the JCR browser.

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.

Deletion warnings are configured in the confirmDeleteAsset action defintion. The configuration patterns follows that of the Dependencies tab (above). 

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

Example: confirmDeleteAsset action in the Assets app configured in /modules/dam-app/apps/subapps/browser/actions/confirmDeleteAsset.

 subApps:
  browser:
    subAppClass: info.magnolia.ui.contentapp.browser.BrowserSubApp
    class: info.magnolia.ui.contentapp.browser.BrowserSubAppDescriptor
    actions:
      confirmDeleteAsset:
        icon: icon-delete
        successActionName: delete
        class: info.magnolia.module.dependencies.action.DependencyAwareConfirmationActionDefinition
        availability:
          multiple: true
          writePermissionRequired: true
          rules:
            - name: IsNotDeletedRule
              implementationClass: info.magnolia.ui.framework.availability.IsNotDeletedRule
        references:
          - name: website
            nodeType: mgnl:page
            workspace: website

Properties