Versions and edit windows
The Versions tab of the product page lists each published version of the passport. When an edit window is open, it also shows the window and its actions. The tab needs the View DPPs & Products module.
A published passport is not edited in place. You open an edit window, change the data, and publish the result as a new version. The public passport keeps showing the live version until you do.
Open an edit window
- Open the product page of an Approved product.
- Select Edit passport. For a Withdrawn product the button reads Reopen.
- In the dialog "Re-open product for edits", answer "Why are you re-opening? (operator-only audit detail)". Type at least 10 characters, up to 500.
- Select Open edit window. The toast reads "Edit window opened".
The window lasts 14 days. The dialog says the published version stays live on the public passport until you publish a new version, and that cancelling the window or letting it expire reverts every change.
You need the Publish DPPs module and an Approver-or-above role to open a window. While it is open, the product shows an Edit window open chip, and the product list shows "Edit window closes <date>" under the name.
The edit window panel
While a window is open, the top of the Versions tab shows a panel headed "Edit window open", followed by who opened it ("by you" or "by <name>") and the date it runs until.
Under the heading, the panel says what the public sees in the meantime:
| Status | Text |
|---|---|
| Approved | The live passport stays as it is until version N is published. |
| Deprecated | The passport stays as it is until correction version N is published. It remains no longer produced. |
| Withdrawn | The passport stays withdrawn until it is published again. |
The panel has these buttons:
| Button | What it does | Who sees it |
|---|---|---|
| Continue editing | Opens the editor | Roles that can edit product data |
| Cancel edit window | Ends the window and returns the product to the data it had when the window opened. The toast reads "Edit window cancelled". | Approver-or-above with the Publish DPPs module |
| Take over | Hands a window held by someone else to you. The dialog "Take over edit window" asks why, reverts the edits pending in the current window, and opens a fresh 14-day window in your name. | Approver-or-above with the Publish DPPs module, when the window is not yours. The panel and the dialog say take over is for team admins, but the server accepts any Approver or Admin who has the Publish DPPs module. |
| Publish version N | Opens "Publish a new version?" | Approvers with the Publish DPPs module, on Approved and Deprecated products |
Publish a new version
Select Publish version N on the panel, or on the product page header. The dialog "Publish a new version?" says the checks run again, the public passport then shows your current data as a new version, and earlier versions stay on record and cannot be changed. Confirm with Publish new version.
If the checks fail, the dialog stays open and lists what to fix. When it works, the toast reads "Your passport is live" and says which version the public passport now shows.
Without an open window, an Approved product shows a line on this tab: "No edit window is open. To change the passport, choose Edit passport; the live version stays public until the new one is published." An approver still gets a Publish version N button there. The dialog then adds that the passport data cannot be changed before this version without a window.
For a Deprecated passport, the same steps publish a correction version. The product stays Deprecated.
The version list
Below the panel is a table of the published versions on record.
| Column | Meaning |
|---|---|
| Version | The version number, for example v2 |
| Status | Live for the current version of a live product, Latest for the current version of any other product, Replaced for earlier ones |
| Published | The publication date |
| By | The name of the person who published it, "A team member" when the publisher has no name on record, or "Not recorded" when no publisher was recorded |
| Kind | Publication, or Correction (with its reference when one was recorded) |
When nothing has been published, the tab says "No published versions yet. Publishing this passport records its first version here." If the list cannot load, the tab says "The version history could not load." When versions are on record it adds how many and asks you to reload, for example "3 versions are on record; reload the page to try again." (or "1 version is on record; reload the page to try again."). With no count it reads "Reload the page to try again."
The first publish of a product is not reliably version 1. Earlier versions are stored as snapshots and can be fetched read-only at /api/dpp/[slug]/v/[version] without signing in.