References (document)

The References lists show parts and documents that affect, influence or validate the document's content. For instance, a product performance specification document may refer to a set of industry standards or regulations.

The References lists are shown when documents and parts are enabled as references. See the References Tabs system rule.

Do not make cross references (where ItemA shows ItemB as its reference, and ItemB shows ItemA as its reference). Cross references complicate revision management, can't be represented in PDX packages, and make some types of Transforms difficult to write.

Use the item icon to drag a part or document from the list to any other location that accepts the item. To select multiple items, click on the first row, press the keyboard Shift (range) or Ctrl (individual), then click on a different row.

Markup list §

This is the initial set of child items that will be approved for use on the iteration. The mark-up list is used to modify the list of items referenced by the document iteration.

While the document iteration is pending, a reference record's most recent pending or released iteration is shown.

To change the contents of the References: Markup list:

• Add a new reference to the list by dragging an item (document or part) from the Search or Recent lists on the Item Explorer, and then dropping it onto the References: Markup list. Add notes as needed.

  You can only drop documents and parts onto documents that will accept them. The References accept parts and References accept documents checkboxes are specified in the References Tabs system rule.

• Modify the Row and Notes values by unlocking the record and editing the value. (This can also be done after the document iteration is released.)

• Replace an existing reference by dragging an item from the Item Explorer and dropping it onto an existing References: Markup row. The notes are copied to the replacement row, and can be edited.

• Remove an existing reference by selecting the reference, opening the context menu, and selecting the Remove Item From List command (or pressing your keyboard's Delete key). The row is still shown, but is marked to be removed upon release.

Releasing the part iteration on a change form copies the References: Markup list to the References: Current list. (Removed references aren't copied.) The iteration's References: Markup list cannot be changed. It permanently shows the released child iteration as the row's starting point.

Current list §

This is the most recent set of child items that are approved for use on the iteration. While a document iteration remains pending, its References: Current list of references remains hidden.

After a document iteration is released, its References: Current list always shows the latest released iteration of a referenced item. That is, each time a referenced item is revised and released, the document's References: Current list of references is automatically updated each time it's opened.

When a document iteration is canceled, the References: Current list shows the reference iteration that was valid at the time of cancelation. If a referenced item is subsequently revised, the canceled document's References: Current list of references won't be updated.

Markup and Current data fields §

The document's trustee can edit the References: Markup list while the iteration remains pending. The document's References: Markup and References: Current lists are locked when the iteration is released or canceled.

Row §

This is the sequence in which the references list is sorted. Enter any non-negative (≥0) integer value.

Item §

This identifies the item referenced by the document.

Notes §

You may use this text for any purpose.

The contents of this field are indexed, and will return the reference item.

The Notes field is not under revision control, and can be edited by the trustee and product team members.

• To change the released iteration's value without creating a new iteration, unlock the released iteration, select the Markup list, and edit the data.

• To keep the previous iteration's value, create a new iteration. On the Markup list's context menu, select the Modify Item command, then edit the data.

Use the sort buttons along the top of each list to temporarily adjust the references.

The IPC-2570 standard does not define References. PDXpert uses the AdditionalAttributes element to include a referenced item, which is added to the Items list. That item includes the referenced item's attributes; attachments for revision (isFileIn=Yes) and item (isFileIn=No) files; materials; and change history.

The PDX specification's AdditionalAttributes element doesn't support a recursive structure, and therefore a PDX package excludes the referenced item's own references, sources and BOM items. If your supply chain partner needs these details, the referenced item must be exported in its own PDX package.

Related topics

• Manage document references

• How to manage documents

1057