Viewing Reference Documents

This task shows you how to view the reference documents attached to an object. You can attach documents as reference documents to builds, features, products, and requirements. These documents can come from your desktop or you can add a document that already exists in the database.

The reference documents category displays a list of all reference documents attached to the parent object. The Documents page shows reference documents attached to a build, feature, product, or requirement.

For complete details on reference documents, see "Document Management" in the Common Components Help.

Before you begin: Access the Properties page of the object where you want to view reference documents.
Related Topics
Running a Search
Working with Test Cases
Working with Specifications

  1. From the object's Categories menu, click Reference Documents.

    The list of reference documents for the object opens.

    It contains the following columns:

    (Locked icon). Shows the number of files locked / number of files checked in. Click any highlighted link in this column to go to the Files page.

    Name. Name of the reference document. This column contains highlighted links. Click on any name in this column to view the Properties page for that object, or click at the end of the row to view the Properties page in a new browser window.

    Title. The title of the document.

    Revision. Indicates the current revision of the document. Click any highlighted link in this column to open the Revisions page.

    Version. Current version of the reference document. Click any highlighted link in this column to open the Versions page.

    Type. Type of document.

    Actions. The following icons represent the allowable actions you can perform on the listed content:

    Icon Name Action
    Subscription To view and select subscriptions for a document
    Download To download one or more files to your local machine. Browse to the directory or folder you want to contain the file. Multiple files are downloaded in a single zip file.
    Checkout and Lock To check out one or more files to your local machine and lock the files from other users who cannot unlock it. Navigate to the folder or directory you want to contain the file.
    Update Files To update a file to its next version.
    Checkin To check in and unlock one or more files.

    Description. Overview of the document's content.

    State. The current state of the reference document in its lifecycle.

  2. Click any of the following from the page Actions menu or page toolbar to work with reference documents.


    • Create New. See Creating a New Document.
    • Add Existing. You can add an existing reference document to the list. The Search page opens.
    • Download. You can download one or more files to your local machine. Browse to the directory or folder you want to contain the file. Multiple files are downloaded in a single zip file.
    • Checkout. You can check out one or more files to your local machine and lock the files from other users who cannot unlock it. Navigate to the folder or directory you want to contain the file.
    • Remove. Removes the relationship between all checked reference documents and the parent object. It does not delete the reference documents from the database.
    • Delete. Removes all checked reference documents from the list and deletes them from the database.

    Note: You can only delete a reference document if you have delete access and the document has no other related objects.