Reference Documents

You can use the list of reference documents associated with a requirement to see what other supporting information is available.

Required access roles:

  • Baseline: Reader, Author, or Leader

To access the page:

Open a requirement. See Opening a Requirement. From the navigation pane, select Properties > Reference Documents.

This topic describes:

This page discusses:

Columns

Column NameDescription
NameThe name of the document.
(Lock State)Indicates how many versions of the reference document exist and how many of those are locked by a user. Click to open the Files page. See Collaboration and Approvals User's Guide: File List for a Versioning Document.
(Route) indicates that there are routes associated with the document's lifecycle.
TitleThe brief title of the document.
RevThe revision number of the document. Click to open the Revisions page. See Collaboration and Approvals User's Guide: Document Revisions Page.
VerThe number of versions of the document. Click to open the File Versions page. See Collaboration and Approvals User's Guide: File Versions Page.
TypeThe document type.
ActionsThe available actions for the reference document:

IconMeaning
(Subscriptions)Allows you to subscribe to events for the reference document. See Collaboration and Approvals User's Guide: Subscription Management.
(Download)Downloads the reference document. See Downloading Reference Documents.
(Checkout) Checks out a reference document and locks it. See Checking Out Reference Documents.
(Checkin)Checks in a reference document that you previously checked out and unlocks it.
(Update)Uploads and checks in a new reference document.

DescriptionThe document's detailed description.
StateThe document's lifecycle state.
(New window)Opens the reference document's Properties page in a new browser window. See Collaboration and Approvals User's Guide: Document Properties and Files Page.

Actions/Toolbar Commands

Required responsibilities:

  • Baseline: Leader (when the object is in the Frozen state) or Author

ActionDescriptionFor More Information
Add Existing Adds an existing document as a reference document for the requirement.Adding Existing Reference Documents
Download Downloads the reference document.Downloading Reference Documents
Checkout Checks out the reference document for editing.Checking Out Reference Documents
Remove Removes the reference document from the requirement, but does not delete it from the database. Click OK to confirm.Removing or Deleting Reference Documents
Delete Deletes the reference document from the requirement and from the database. Click OK to confirm.Removing or Deleting Reference Documents
Create New > Document Creates a new reference document and associates it with the requirement.Creating New Reference Documents