Checking Dependency Errors


Prerequisites: The asset item schema type must be DITA Content. The Depends On tab displays for only DITA items.

The Depends On tab provides dependency information about DITA and non-DITA content that the currently selected DITA item references.

For example, let's say the currently selected DITA content contains a cross reference to another DITA topic and a reference to an image asset. Both dependency links display within the Depends On tab list entries. Also, let's say the referenced DITA topic contains dependency links. The currently selected asset will include these links in the Depends On tab list entries, as the links correlate to the asset's hierarchical relationship structure (for example, the dependency route).

See Dependencies Overview for more details about DITA dependency linking.

Version Notes: CMS 10.6.378 vs. CMS 10.6.308–10.6.342
Dependency functionality differs between CMS 10.6.378 and CMS 10.6.308–10.6.342.
  • In CMS 10.6.378, dependencies are accounted for based on the DITA asset's latest content version and versions marked to publishing targets. To filter dependencies based on version in the Depends On tab, you can use the Dependency Version drop-down list.

  • In CMS 10.6.308–10.6.342, dependencies are only accounted for based on the current version of the DITA asset item. If you make and save changes to an asset item's dependencies via the Edit tab, the Depends On list entries update to reflect the new changes, no matter if the asset is checked in or out. If you mark an older version of the DITA asset item for publish, the CMS dependency system will not account for the dependencies in that version.

See CMS DITA Versioning Functionality for more details about CMS 10.6 dependency functionality changes.

To review dependencies referenced within other DITA content:

  1. Navigate to Assets > Assets Tree.
  2. Select the DITA item, then click the DITA Properties > Depends On tab.
    The Depends On tab displays the list of dependencies associated with the currently selected DITA item.
  3. Choose the All Dependents filter option to display all descendant dependencies associated with the currently selected DITA map.

    This data includes child dependencies, grandchild dependencies, etc. If the currently selected DITA content contains zero dependencies, this filter option displays as inactive.

  4. Select the Show Errors Only checkbox to display only dependencies that have errors Validity Error Icon in the list.

    Errors are indicated in the Validity column.

  5. You can opt to review errors for all dependency versions or for a particular version. Choose one of the following filter options from the Dependency Version drop-down list:
    Version Notes: CMS 10.6.378

    The Dependency Version drop-down list is exclusive to CMS 10.6.378. If you have CMS 10.6.308–10.6.342, skip this step.

    In CMS 10.6.378, you can filter dependencies based on the latest version or based on a publishing target.

    OptionDescription
    Show All

    Provides a comprehensive list of dependencies associated with the DITA asset item, regardless of version or publishing target.

    The Show All option displays all dependency entries, including the dependencies referenced in the Latest Version and those referenced in any version of the asset marked to a publishing target.

    If no dependency entries display, this indicates the DITA asset does not have any dependencies in the latest version or in any marked-for-publish version.

    Latest VersionDisplays dependencies referenced in the latest content version of the DITA asset. The Dependency Version column in the list will indicate targets where the latest content is marked.
    Note
    • This version filter includes any dependency changes that have been saved but have not been checked in to the DITA asset.
    • If no dependency entries display, this indicates the DITA asset does not have any dependencies in the latest version.

    Name of Publishing TargetDisplays only dependencies referenced in the version of the asset item marked to the publishing target you select from this drop-down list.

    In the drop-down list, the publish icon displays next to publishing target options.

    Note
    • If the latest version of the DITA asset is marked to a publishing target, the CMS will only account for the latest checked-in changes marked to that publishing target.
    • If no dependency entries display for the publishing target, this indicates either the DITA asset is not marked to the target or that the marked DITA asset version does not have any dependencies.
  6. Optional: You can hover over the Validity error icon of each dependency entry to display error details. These details will indicate the dependency version where the error is detected.

Next Steps: Interpret and resolve dependency errors.