Cancel a released document

You cancel an obsolete document when it's no longer relevant to your product or procedure, and you want to ensure no one uses it in the future.

Cancel a released document by adding it to an executing change form's Affected list, and then approve and release the change form.

If the document iteration is pending, then you can't cancel it; instead, remove the pending document iteration.

A canceled document cannot be used on any pending or released parent item. Before canceling the document, examine its Appears On: References list. If it's a child item on any pending or released parent item, then remove it from the parent. If the parent item is released, then the parent must be revised to remove the document, and the parent revision must be released with (or before) the child document's canceling change form.

Canceling, instead of revising, a document ends its internal history timeline at the canceled iteration. If you later create a new iteration, a new history timeline begins. Markups show all previous rows as added (blue "add on" icon ) because they're copied from the canceled iteration onto the new history.

You don't need to change the iteration's lifecycle when you cancel it. Keeping the current lifecycle indicates its technical status when it was canceled, and simplifies re-releasing later if it's needed for servicing or a new application.

No reference child items are affected by canceling the parent document.

Canceling a released document iteration is very similar to releasing it.

  1. Start a new executing change form, such as a Change Notice. Or, use an existing change form that's at Originated state.

  2. Drag the released document that you want to cancel from the Item Explorer's Search or Recent lists to the change form's Affected list. The released iteration is shown with Cancel icon (change cancels iteration).

  3. Process the change form for review, approval, and release. See the Processing a change help topic.

Un-cancel a document §

After a document is canceled, you can return it to a released state by creating and releasing a new iteration.

  • If the document does not have any new technical content, edit the pending Revision and Lifecycle values to match the canceled iteration values.

  • If the technical content has changed, edit the new pending iteration as described in the Revise a released document help topic.

When you've finished editing the new iteration, release your document on a change form. When it's added to the change Affected list, the pending iteration is shown with Cancel icon (change releases iteration); the canceled iteration is not shown.