Auto-repair an invalid component relationship

When a reference to another component is broken or invalid, you can use a tool to repair the relationship in a single click. After the process finishes you receive a notification inside Inspire and by email sent to the address associated with your Inspire account.

Tips and Tricks
  • Although you can do this action from the Components browser or a project, these instructions tell you how to do it from the Components browser.
  • You can only create relationships to elements with ID values. For more information read Repair component relationships.
  • If the auto-repair tool can't correct the invalid relationship, you can fix it manually in the Manage Relationships screen. Follow the steps in Manually repair an invalid relationship.
  • If you aren't sure what to select using the Manage Relationships screen, you can open the component in the Oxygen editor and use the Validation pane to learn more about the error and fix it in the editor. Follow the steps in Check for errors in the Validation pane.
  • Inspire now supports content references to ditabase topics. A ditabase topic is a composite topic. Before maps, ditabase was used to collect multiple topics and structure them within a single topic file.
    • If you use a conref to a ditabase topic, Inspire no longer identifies it as an invalid relationship.

  • When you repair a self-referencing link, the following syntax is used:

    • If a cross-reference is pointing to content in a separate file, Inspire includes the file name:
      <filename>#<rootid>/<elementid>
    • If a cross-reference is pointing to content that exists in the same file, DITA assumes it's the same, so Inspire drops the file name:
      #<rootid>/<elementid>

To auto-repair an invalid component relationship:

  1. Click Components_TopMenuOpt Components.
  2. In the Folders pane, navigate to the folder where you've saved the component.
  3. In the Components pane, select the component that has an invalid relationship that you want to repair.
    Components with an invalid relationship display an Invalid icon .
  4. Right-click the component's row, select Advanced, and then select Relationships...
    You can also click the Options menu, select Advanced, and then select Relationships...
  5. On the Manage Relationships screen, look in the Status column and select a component that has an Invalid relationship.
  6. On the toolbar, click Auto-Repair .
    You can also click the Options menu and select Auto-Repair.
  7. On the Repair Component Relationship Issues confirmation dialog, click Yes.

    You see the following notifications in Inspire:

    After the repair process finishes you receive a notification.

    • Previously this notification showed you relationships that were successfully repaired and those that failed to be repaired.
    • Now the notification only shows you relationships that failed to be repaired.

    When you complete a task that triggers a notification, such as repairing relationships, the Slack and email message bodies contain:

    • The the title and file name of the component that was repaired.
    • Ten or less Issues, Errors, and Warnings.
    • A link at the bottom of the message [See Full Version].
    • You can click the [See Full Version] link to expand a section under the link with the full details.
    • For more information, review the Sample Inspire notification.