View a completeness report for a project component

You can submit a request for Inspire to provide details about a component before you send it for publishing or translation. Inspire provides a completeness report that checks for the filtering of conditional text, approval state, electronic signatures, lock state, invalid state, invalid XML, and whether there are comments or track changes in the component. Additionally, if a component has been sent for translation, Inspire can check to see if the translation has been completed or if it still needs to be translated (the job is in progress).

Tips and tricks

If you want to generate more than one completeness report at a time, you must go to the Components browser. There, you can select multiple components and use the Selected Components panel. Follow the steps in: View a completeness report for selected components.

Translation Completeness Report. After a component is translated, you can check the translation status of all its referenced components by creating a Translation Completeness Report.

This report shows the status of the component and its references by Target Language. You can see in one place if a translation is missing or out-of-date.

Create a completeness report in a project for a translated component

To view a completeness report for a project component:

  1. Click Projects.
  2. On the Project Management tab, all projects in your organization are listed. To find a specific project, you can:
    • Filter the list of available projects by words in the project name. In the Search text box, enter a keyword, and then click the magnifying glass search_button.
    • Filter the list of available projects to include only those you own or are participating in. In Type, select an option to filter the list by that criterion.
    • To include completed projects in the list, select Include Completed and then click the magnifying glass search_button.
  3. To open one project, select the project and double-click it.
    You can also open a project by:
    • Right-clicking the project and then selecting Open.
    • Clicking Action_Menu the Options menu and then selecting Open.
  4. In the Content pane, find the component you want to create a report for.
    To see the complete name of the components and use advanced search to search through all folders within a project, click the Select Project Components option.

    • To see more text in the Components pane, collapse the Folders panel by clicking the arrow that's pointing left.

    • To quickly expand or collapse the folders, use the expand all and collapse all buttons.

    • To find a component by keyword, in Search, enter words or phrases used in the component's name. In Within, select where in the project you want to search (Current Folder, Current and Subfolders, All Folders). Click Search search_button.
    • To find a component by creating a query, click Advanced Search.

      • Fields correspond to the columns in the grid. In the Field list, select the column you want to search in, such as Component State.
      • After you select a Field, you must describe the relationship it has with the Value. In the Operator list, to include or exclude some or all of the values that you want to use, select an operator, such as <> (not equal to).
      • The options in the Value list change depending on what you selected in Field. In the Value, select or enter the word, phrase, or number you are searching for in relation to the Field. For example, Component State (Field) <> (Operator) Invalid (Value).
      • In Within, select where in the project you want to search (Current Folder, Current and Subfolders, All Folders).
      • Optionally, to enter another clause to your query, click Add. Select whether you want to narrow your search by requiring that all statements must be true (And), or expand your search by requiring that any of the statements can be true (Or).
      • Click Search search_button.
    • To select multiple components to manage, select the checkbox for each component.

      Result: The components are listed on the Selected Components panel.

    • To close the Select Project Components screen, click Select.
  5. Right-click the component, select Reports, and then select Completeness report...
    You can also start the process by clicking the Options menu, selecting Reports, and then selecting Completeness report...
  6. Optionally, on the Check component completeness screen, you can quickly clear all report options and choose only the few you need using the Deselect All option.

    • By default, all report options are selected.
    • After you click Deselect All and choose only the report options you need, Inspire remembers your selections. The next time you select the Completeness Report option for any component, only the options you chose previously are selected by default. If you want to return to the default of having all report options selected, clear your browser cache.
  7. Optionally, on the Check component completeness screen, to filter on conditional text:
    1. Click Add Filter.
    2. On the Filter profiling attributes screen, select the attributes that you want to include in this report.

      To find an attribute:

      • Expand all categories and show all attributes. Go to the toolbar, and click Expand all .
      • Show only the categories and hide all child attributes. Go to the toolbar, click Collapse all .
      • Use a filter to limit the list of categories and child attributes. In Saved Filters, select an option.
    3. On the Filter profiling attributes tab, click Select.

      You see the profiling attributes you select on the Check component completeness screen, listed below the Add Filter button.

  8. On the Check component completeness screen, all verification tests are selected by default. If there is something you don't want to see in the report, clear the checkbox for that option. By default, all the following checks are completed in the report:
    • Components that are not approved ( Approved, Draft)
      • To exclude files from the report that have a Type of Binary, select Ignore Images.
    • Components that are not signed ( When you approve a component, you may be required to attach your electronic signature)
    • Components that are locked by system or by other user ( System lock, Approval lock, Other user lock)
    • Components that are locked to yourself ( You made changes that aren't submitted)
    • Target components that are locked ( if any translated files returned from the vendor are locked)
    • Components that are in Invalid state ( one or both issues: a component has a problem with its references to other components; a component has invalid XML and it is a binary)
    • Components that contain invalid references (links to conrefs, xrefs, topicrefs, etc., that are broken)
    • Components that are Invalid XML (one or both issues: well-formed XML, valid XML)
    • Components that contain Comments and Track Changes (identified if a component contains any of these artifacts)
    • Components with tags (Lists all selected components that have at least one of the tags listed.)

      You must select at least one tag for the heading to appear in the report.

    • Components without tags (Lists all selected components that are missing at least one of the tags listed.)

      You must select at least one tag for the heading to appear in the report.

    For a description of all the categories in the report, read Check component completeness.

  9. On the Check component completeness dialog, click OK.

    Result: When you complete a task that triggers a notification, such as creating a report, the Slack and email message bodies contain:

    • A summary header.
    • 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.
  10. In the top menu, click Notification TopMenu Notifications, and then See all notifications.
  11. From the list of notifications, select the one that says Component Completeness Report.

    You see a report similar to the following:

  12. The same message that is sent to your email is displayed below the list in the Details pane.

    Result: f the component meets one of the criteria, it's listed. If it doesn't, the report will display No components match this criteria.

    Go to all. If you want to open the folder that contains all the components listed in a section of the report, click the Select All link.

    • If you click this link from an email, a browser tab opens, and Inspire opens to the Components browser.
    • If you click this link from a notification inside Inspire, the Components browser opens.
    • In the browser, you see all the components highlighted that are from that section of the report.
    • If the components are in different folders, you see the items from the first folder listed in the Folders pane.
    • The components are also listed in the Selected Components pane.

    Open. If the component's content needs to be updated, you can click on the component Name, which is a link that opens the component in the Oxygen editor.

    • The Name is listed first.
    • The Name does not contain the file extension. For example, "Copyrights".
    • If the component is locked or a binary, you see the component in a read-only viewer.

    Go to one. If you need to update a component using a system function, such as Rename, you can click on the File Name which is a link that opens the folder where it's stored.

      • The File Name is listed second, after the shorter Name and in parenthesis ().
      • The File Name contains the file extension. For example, "Copyrights_cda13aa4.xml".