Reference Documents Page

You can attach documents as reference documents to builds, features, product lines, model versions, test cases, and requirements. These documents can come from your desktop or you can add a document that already exists in the system.

To access this page for a model version:

  1. Open the required model version. See Opening a Model Version.
  2. In the navigation pane, click Content.
  3. Click the Reference Documents page tab.

To access this page for all other object types:

  1. Open the required content.
  2. In the navigation pane, click Reference Documents.

This topic describes:

This page discusses:

Columns

Column NameDescription
NameThe name of the reference document. Click to view the default page for that object. Some types of documents show the Properties page. Others show the file list.
(Locked)The number of files locked / number of files checked in. Click the numbers in this column to go to the Files page.
(Route)The route icon shows if the specification is part of a route. Use the Routes page for the specification to find out more details.
TitleThe title of the document.
RevThe current revision of the document. Click to open the Revisions page. See Collaboration and Approvals User's Guide: Document Revisions Page.
VerThe current version of the reference document. Click to open the Versions page. See Collaboration and Approvals User's Guide: File Versions Page.
TypeThe type of document.
ActionsActions you can perform on the listed content:

IconAction
(Subscription)View and select subscriptions for a document.
(Download)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.
(Check Out)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)Update a file to its next version.
(Check In)Check in and unlock one or more files.

DescriptionThe detailed description of the document's content.
StateThe current state of the reference document in its lifecycle.

Actions/Toolbar Commands

ActionDescriptionFor More Information
Actions > Create New > Create Document Creates a new document. Collaboration and Approvals User's Guide: Creating Documents
Actions > Create New > DesignSync Object

Only shows for a model version or build when Defect Management and Collaboration is installed.

 Creates a new document connected to a new DesignSync object. Collaboration and Approvals User's Guide: Creating a New or Connecting to an Existing DesignSync Object
Actions > Create New > Connect To DesignSync Object

Only shows for a model version or build when Defect Management and Collaboration is installed.

 Creates a new document connected to an existing DesignSync object. Collaboration and Approvals User's Guide: Creating a New or Connecting to an Existing DesignSync Object
Actions > Create New > Copy From DesignSync

Only shows for a model version or build when Defect Management and Collaboration is installed.

 Copies files from DesignSync. Collaboration and Approvals User's Guide: Copying Files from DesignSync
Actions > Add Existing Adds an existing reference document to the list.About Searches
Actions > Download Downloads one or more files to your local computer. Browse to the directory or folder you want to contain the file. Multiple files are downloaded in a single zip file.—
Actions > Checkout Checks out one or more files to your local computer and lock the files from other users who cannot unlock it. Navigate to the folder or directory you want to contain the file.—
Actions > Remove Removes the selected reference documents from the list. Click OK to confirm. It does not delete the reference documents.—
Actions > Delete Deletes the selected reference documents. Click OK to confirm.

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

—