Inspecting Doclets

This topic applies to Office-based and non-Office-based doclets of all types, including reference and supplemental, and of all supported file formats.

For detailed information on regular doclets, reference doclets, and supplemental doclets, click Inspect in the Narrative Reporting ribbon.

The Inspect button launches the Properties dialog box.

From the Properties dialog box, you can also download previous versions of a doclet, reference doclet-, or Office-based supplemental doclet.

Note:

All steps in the following procedure are optional.

To view information about a regular doclet, linked regular doclet reference doclet, or supplemental doclet:

1. If the report package is not already open, in the Smart View Panel, navigate to the report package and open it.
2. Select a regular doclet, linked regular doclet, reference doclet, or supplemental doclet in the list and click the Inspect button in the Narrative Reporting ribbon.
3. In the Properties dialog box, view the information the Properties tab (the default tab).

   The Properties tab displays basic information about the doclet, such as the file name, doclet type, link status, suppression status, and the user who created the doclet.

   Figure 23-42 Properties for a Regular Doclet

   
   
   

   Figure 23-43 Properties for a Linked Regular Doclet

   
   
   

   Figure 23-44 Properties for a Reference Doclet

   

   Figure 23-45 Properties for a Supplemental Doclet

   
   
   
4. Click the Embedded Content tab, , to view a list of the embedded content that is being used in the doclet.
   
5. Click the Version tab, , to download previous versions of Office-based doclets.

   As new versions of doclets are checked in, the previous versions are stored so that you can download and view them to see what changed.

   Note:

   Doclet versioning is optimized to minimize the impact of multiple automated check-ins. When multiple automated check-ins are performed on the doclet due to variable or embedded content changes, the system will update the doclet contents but will not generate a new version.

   To download a previous version of a doclet, click the link next to the version that you want to view.

   
   
   

   A message notifies you of the location of the downloaded doclet .

   You may download any type of doclet; however, only Office-based doclets may have previous versions.

6. Click the History tab, , to view audit information about the doclet , such as the user who last updated it (if applicable).
   
   
   
7. Click the Actors tab, , to view the actors associated with the doclet.

   The Responsibility node shows the user who has currently checked out the doclet. The Authors node shows the authors assigned to the doclet. The Approvers node shows the assigned approvers.

   In the following illustration, the doclet is currently checked out by Adam P. Axelrod. There are two assigned authors, and there are no assigned approvers.