General (document)

The General page provides the basic information about the document: its unique identity (owner, number, name), a selected technical content identifier (revision), and how that technical content may be used (lifecycle).

Owner§

This is the organization that gives the document number, controls the document's contents and approves its release. Typically, your organization owns documents that define its designs 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.

The value is locked on first release.

Released document icon Document 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 class icon shows the most recent iteration's release status:

  • Pending document icon Pending
  • Released document icon Released
  • Canceled document icon Canceled

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 document 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. If the new item must use the same Number, then search the web for this application note: PDXpert Switching an existing item to a different type.

Number§

The document Owner and Type determine the document number rules:

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

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

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

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

The auto-number format and value are specified in a Sequences: Identifier collection member.

The value is locked on first release.

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 Document types: Document title template help topic.

The Name{a} button inserts the values on the Custom page into the document type's Text template. The button is visible only when custom attributes have been specified on the document type. To make a new document title, first enter the custom attribute values, and then click the Name{a} button to make the title. The new name completely replaces the previous name. You can edit the new name after the custom attributes have been inserted.

The value is locked on first release.

Trustee§

This is the person who has overall responsibility for the document's contents. The trustee can edit various fields, add references, attach files, and add the document to a change form's Affected list. The trustee, as well as analyst, can give the document to a different user, who becomes the new trustee.

Product families§
Product families limit 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.

— Iteration: Revision at Lifecycle —

This area shows the selected iteration's current status – Pending Released Canceled – with supporting details.

Revision§

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

Depending upon the rules adopted by your company, a document revision can specify a major non-interchangeable change, or a minor ("clerical") difference. Normally, technical content that has major changes is given a new document number. Changes that simply add minor content, clarify technical information, or correct clerical errors usually retain the same document number, but require a new revision.

The revision's Increment button sets the revision to the starting value of the current revision sequence, based on the selected Lifecycle phase.

The value is locked on release.

Lifecycle phase§

Independent of technical content revisions, a document can be given 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 specified in the Item Lifecycle Phases collection.

If the Document Types collection member specifies a Subsequent revision sequence, after selecting a new Lifecycle phase value, make sure that the Revision is correct.

The value is locked on release.

Version§

A version is used to distinguish documents with the same document number. The Version field may be shown or hidden, depending on whether the Document Types collection member lets documents have versions.

Like a revision, a document version distinguishes earlier iterations of a document from later ones. Unlike a revision, which is managed by PDXpert, the version is made by an outside entity—a person or a different computer application, such as a software compiler—and manually entered here. If both revisions and versions are used for a document, you must make a new iteration to change the version.

The Document Types collection member's Show Version field setting shows or hides this field.

The value is locked on release.

Person #1
Person #2§

These fields can show people with responsibility for the selected iteration's contents. This list is managed in the Persons collection.

The Document Types collection member's Show a Person #1/#2 role settings show or hide these fields, and can show custom labels, such as Author or Reviewed by.

Revision area§

Identify where document changes have been made ("pages 7-9", "Appendix B", "zone A-3").

The value is locked on release.

Release description§

The Release description summarizes how or why the iteration has been changed. The change form's Affected list shows the first 50 characters as a brief note to reviewers.

The value is locked on release.

Release status§

The system shows when the selected iteration is released for use.

  • If the iteration is not on any executing change form's Affected list, then the status is shown as Pending and the text field is empty.
  • If the iteration is added onto an executing change form but is not yet released, then the status is shown as Pending and the text field shows the change form that will release the iteration.
  • If the iteration is released, then the status shows Released and 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 show the release date of the selected iteration. Users cannot change it.
Effective date§
This date shows when the iteration may be used for its intended purpose. You can give a different date to show, 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. If you do not set the date, then the system will copy the iteration's Release date.
Cancel status§

The system shows when the selected iteration is replaced by a new released iteration, or the item is withdrawn from use.

  • If the iteration is not shown on any executing change form's Affected list, then these fields are not shown.
  • If the iteration is added onto an executing change form but is not yet canceled, then the status is shown as To be canceled, and the text field shows the change form that will cancel the iteration.
  • If the iteration is canceled, then  the status shows Canceled and shows the change form that canceled it.

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

Cancel date§

This date is set by the system to show the cancel date of the selected iteration. Users cannot change it.

Related topics

1055

Help Guide Contents [as PDF]