Documents Tab
When you open redline, you can view the Documents tab in the redline structure pane. The Documents tab is visible for the BOM redline part, that is a root part and for the selected child part that has a BOM redline.
From the Documents tab, you can only view the documents associated with a part. The following types of document association tables are displayed:
• Described By Documents — Displays version-specific views of documents for the selected part. You can add or remove a document as needed.
• Reference Documents — Displays the documents associated with the selected part. You can add or remove a document as needed.
• CAD/Dynamic Documents — Displays the read only view of the documents representing elements of a CAD assembly structure for the selected part.
 |
You cannot perform actions such as adding or deleting entries from the document association tables for CAD/Dynamic Documents.
|
The following tables and sections describe the Described By Documents in the redline.
A Described By Documents in Windchill is a type of document that remains unchanged in the Windchill part structure, even after the part is revised.
Reference Documents is a type of document that remains unchanged in the Windchill part structure, even when the part is revised.
When you select a redline, the Documents tab provides information such as name, number, version, context, state, and last modified date of a document. Use this tab to perform the following actions:
• View attribute information of associated documents.
• Add existing or new Described By Documents and Reference Documents to a BOM redline or to a selected child part that has a BOM redline.
• Remove Described By Documents and Reference Documents from a BOM redline or from the selected child part that has a BOM redline.
The following table describes the actions you can perform on the Documents tab for Described By Documents and Reference Documents.
Action | Icon | Description | ||
|---|---|---|---|---|
Insert Existing |  | Associates an existing document with the BOM redline part and with the selected child part that has a BOM redline. For more information, see Inserting a Document.
| ||
Remove Selected |  | Removes the selected Described By Documents or Reference Documents from the BOM redline part or from a selected child part that has a BOM redline.
|
Attributes Description
The following table describes the document attributes shown in the default table view on the Documents tab:
Attribute | Description | ||
|---|---|---|---|
Change Indicator | The type of change when compared with the base object. The Change Indicator column is not available out-of-the-box.
| ||
Number | The unique numeric identifier for the document. | ||
Version | The revision and iteration of the document. | ||
Name | The text identifier for the document. | ||
Context | The context in which the object is stored, such as Product, Library, or Project. | ||
Last Modified | The date and time when the object was last checked in. |
Change Indicators for the Documents Tab
The change indicator displays a summary of the type of change that occurred when comparing the base object with the redline. The following table explains the icon and description for the Change Indicator column:
Indicator | Icon | Description |
|---|---|---|
Blank | Indicates that the document is not modified. | |
Insert New |  | Indicates that an existing document that is not released or a newly created document is inserted. |
Insert Existing | | Indicates that an existing released document is inserted into the redline structure. |
Remove | | Indicates that the document is removed from the redline structure. |
Use Case for the Revert Action for the Parts Associated with the Documents
The Revert action does not revert the changes related to documents.
Consider the following redline structure tree for a parent redline Part, Chg-A-1.1 with child parts in the organization:
• Part, Chg-A-1.1
◦ Part1
◦ Part2, Chg-A-2.1 (associated with a Doc_1 document)
◦ Part3
◦ Part4, Chg-A-2.5 (associated with a Doc_3 document)
◦ Part5, Chg-A-2.8
The child parts Part2, Chg-A-2.1, Part4, Chg-A-2.5, and Part5, Chg-A-2.8are also redlines. The child parts Part2 and Part4 are associated with the Doc_1 and Doc_3 documents, respectively.
If you make some changes to the child part Part5, Chg-A-2.8, such as modifying part usage, attributes, occurrences, and adding the document Doc_5 to the child part and perform the Revert action, you can observe the following:
• Changes to part usage, attributes, and occurrences are restored to their original state.
• The Documents tab still shows Doc_5 because the changes are not reverted.
The resulting visual highlight Part5, Chg-A-2.8 in the redline structure tree remains red. In the Documents table, Doc_5 remains green even after the Revert action because Doc_5 is not reverted.
| | The color in the redline structure tree node might change to black, indicating that there are no changes as all modifications are reverted. However, even if the usage change is reverted, the redline structure tree node may still indicate a change due to non-reverted modifications related version attributes, documents, and AML/AVL. |
Related Topics