View a component usage report for one project component

You can select a component and create a report that shows the complete hierarchy of references. This report provides more details than when you select a component and choose Details to open the Where Used tab. On the Where Used tab, you can see the list of components that directly reference the selected component. If you want to trace those parent components all the way back to their first reference, you can create a component usage report.

Tips and tricks

To view a component usage report for one project component:

  1. Click Projects.
  2. On the Project Management tab, find the project that includes the component you want to create a report for.
  3. To open project details, select the project and double-click it.
    You can also open a project by:
    • Right-clicking the project and then selecting Open.
    • Clicking the Options menu and then selecting Open.
  4. In the Content pane, do one of the following:
    • Use a menu.

      1. In the component's row, right-click or select the Options menu.
      2. Select Reports, and then Component usage report.
    • Use the Selected Components panel.

      1. Select the checkbox for the component you want to run a report on.
      2. On the Selected Components panel, select Reports, and then Component usage report.
  5. On the Convert Time screen, select one of the following options:

    • Yes. Changes all dates and times in the report to reflect the Time Zone specified in your Profile. (To change your Time Zone, follow the steps in: Select your time zone.)
    • No. Displays all dates based on the Time Zone where your Inspire server instance is located.
    Results: You see a notification that the report is being generated, and another when it's completed.
  6. In the top menu, click Notification TopMenu Notifications.

    You do not receive a copy of the report in email or Slack, and it cannot be configured.

  7. From the list of notifications, select the one with a Subject of Component Usage Report.

    When you run a report on a single component, Inspire adds the component name to the report's CSV file name.

  8. To download the report, click the link containing the name of the CSV file.
  9. On your local computer, open the report to see the details.

    Results: There are two columns in the spreadsheet.

    • ComponentNames. This is the first column, which lists the names of components that, at some level, reference the selected component. A greater-than sign is used as a separator, and the selected component is always listed last.
    • ComponentFilenames. The second column lists the same hierarchy except that the display names are appended with the GUID to create the full filenames.

    The following sample report has been modified to add bolding and color.

    The report can be visualized in the following hierarchical relationships:

    • The root-level component is shown in Bold.
    • On the left side:

      • is directly referenced by .

      • has a relationship with because it is a branched copy of .

      • is not directly referenced by the map.

      • is directly referenced by the map.

    • On the right side:
      • is directly referenced by .
      • is directly referenced by the map.