General tab (document)

The General tab provides the basic information about the document: its name, its identifier number, its revision or version, its lifecycle phase, who created it and when, and the product families that use it.

Document
The item class icon indicates the current document iteration release status:
Pending document icon Pending
Released document icon Released
Canceled document icon Canceled
You can drag the icon and drop it onto a destination, such as another item's markup list or a change form's affected list.
Owner
This is the organization that assigns the document number, controls the document's contents and approves its release. Typically, your own organization owns documents that describe its designs, processes, and procedures. Other partner organizations can also own documents, such as (a) regulatory agencies that publish industry requirements, (b) manufacturers that publish product datasheets, or (c) customers that issue product requirements to your designers.
Type
The type defines the document's attributes and behaviors (like numbering, revision format, custom attributes, etc.), which are controlled by its Document Types collection member.
The Type cannot be edited. If you want to apply a different part type, you must convert the document and let PDXpert copy whatever it can from the old document using the new Document Type's rules. You can then remove the unwanted document from your system or, if it's been released, cancel the released iteration.
Lifecycle phase
Independent of technical content revisions, a document can be assigned a level of "business maturity". You may have relatively little confidence in a first-draft document: you may need to circulate it for comment, try out its procedures, or build prototype parts with it. As your confidence in the document's accuracy and relevance develops, the lifecycle progresses. When the document is fully validated, you release it for production use.
Lifecycle selections are defined in the Item Lifecycle Phases collection.
If the Document Types collection member specifies a Subsequent revision sequence, after selecting a new Lifecycle phase value, verify that the Revision is correct.
Number

The document Owner and Type determine how document numbers are assigned:

  • Documents designed and controlled by your home organization are assigned a number based on the document type:

    • Manually: You can enter your own number or click the 123 button to assign a new number, and further edit the assigned value. The Number textbox and the 123 button are both enabled.

    • Automatically: The Number field, as well as the 123 "AutoNumber" button on the right-most end of the textbox, is locked and the document number is already present.

  • Documents designed and controlled by partner organizations are assigned document numbers by those organizations. The Number field is editable and the 123 button disabled.

The auto-number format and value are defined in a Sequences: Identifier collection member, which is then used by the current document type.

Revision

A document revision identifies each step in the evolution of a document's technical content.

Depending upon the process adopted by your company, a document revision can indicate a major functional, or a minor ("clerical"), difference. Normally, a design iteration that results in significantly altered content is assigned a new document number. Modifications that simply add to the content in minor ways, clarify technical information, or correct clerical errors likely retain the same document number, but require a new revision.

The revision's 123 button sets the revision value to the starting value of the current revision sequence.

Version
A version is any number of characters that you assign to distinguish documents with the same document number. The Version field may be displayed or hidden, depending on whether the current Document Types collection member permits documents to have versions.
Like a revision, a document version distinguishes earlier iterations of a document from later ones. Unlike a revision, which is assigned automatically by PDXpert, the version is created by an outside entity - a person or another computer application, such as a software compiler - and manually entered here. If both revisions and versions are used for a document, you must create a new revision to also change the version.
Document name (title)
The document title provides an indexed, searchable description of the document's contents or purpose.
The starting value is copied from the document type's Text template value. See the Collections reference > Documents > Document Types: Document title template help topic.
The Name{a} button merges the current values on the Custom tab into the document type's Text template. The button is visible only when custom attributes have been defined on the document type. To create a new document title, first enter the custom attribute values, and then click the Name{a} button to create the title. The new name completely replaces the previous name. You can edit the new name after the custom attributes have been merged.
Trustee
This is the person who has overall responsibility for the document's contents. The trustee can edit various fields, assign references, attach files, and add the document to a change form's Affected tab. The current trustee, as well as analyst, can re-assign the document to another user, who becomes the new trustee.
Revision area
If a particular document location ("zone A-3", "Appendix B", "pages 7-9") has been affected, you can summarize that here.
Language
The document is written in this language, which need not be the same language as that used by PDXpert. When a new document is created, the owning organization's default language is copied to this field, but can be overridden.
Product families
Product families restrict who can work with the items based on permissions granted within a product family's collection member. If you do not specify a product family, then any user role with general document permissions can view the document.
Release description
The Release description summarizes how the current iteration has been changed, and is shown on the change form Affected list as a brief note to reviewers.
Released

The system marks the checkbox when the document iteration record is released for use.

  • If the iteration is not on any implementing change form's Affected list, then both the checkbox and the accompanying text field are empty.
  • If the iteration is assigned to an implementing change form but is not yet released, then the checkbox is empty. The accompanying text field displays the change form that will release the iteration.
  • If the iteration is released, then the system marks the checkbox and shows the change form that released it.

Double-click the change number to open the related change form.

Release date
This date is set by the system to indicate when the new document iteration was released on the releasing change form.
Canceled

The system marks the checkbox when the document iteration record is replaced by a later iteration, or the document is withdrawn from use.

  • If the iteration is not on any implementing change form's Affected list, then both the checkbox and the accompanying text field are empty.
  • If the iteration is assigned to an implementing change form but is not yet canceled, then the checkbox is empty. The accompanying text field displays the change form that will cancel the iteration.
  • If the iteration is canceled, then the system marks the checkbox and shows the change form that canceled it.

Double-click the change number to open the related change form.

Cancel date
This date indicates when the document iteration was canceled.
Effective date
This date indicates when the current iteration may be used for its intended purpose. Although the effective date is typically the same as the revision's Release date, you can specify a different date to indicate, for instance, a delay before the document may be shared with suppliers. Set the effective date as the same as (or earlier than) the effectivity date of parts that rely on the document.
Snapshot from
If you've created the document from another item (Edit | Snapshot Duplicate...), then this textbox displays the original item. Double-clicking on the displayed item opens it.

1055

Learn More
Help Guide Contents [PDF]