When you Finalize a Document, you make the Document available for use in Penelope which puts the Document into a temporarily frozen state. This state prevents you or other users from making significant changes to the Document (for example, adding or removing Questions).
You can, however, update your Document in the future if needed by creating a new Document Revision which returns the Document to being In Progress and editable.
When you create a new Revision, you’re not creating a separate instance of the Document but rather you’re updating an existing Document while retaining the history of each time a new Revision was created. Adding a revision to a Document automatically locks the previous Revision but not the Document itself. The Document is not locked and can still be edited or revised, but the previous Revision is locked.
Keep in mind that many Document components don’t require a new Revision to be modified.
In general, more significant actions like adding or removing Elements requires a new Revision while less significant actions like modifying wording can be completed whether the Document status is In Progress or Finalized.
The following table contains information about what aspects of specific Document components can be modified with or without creating a new Revision. Items listed that require a status of In Progress means that you must create a new Revision to
| Document Component | Document Status Required |
| Adding or Removing | Modifying Component Properties |
n/a | Variable | |
In Progress | Variable | |
In Progress | Variable | |
In Progress | Variable | |
In Progress | Variable | |
In Progress | Variable | |
In Progress | In Progress | |
In Progress (cannot be modified after the first time you Finalize the Document) | Can only be modified if the Document has never been Finalized. | |
In Progress | Variable | |
Any status | Any status | |
In Progress | In Progress | |
Any status | Any status | |
Any status | Any status | |
Any status | Any status | |
Any status | Any status |
View the Revision History of a Document
The Revision History of a Document shows a history of each time the Document has been modified through a new Revision and later Finalized.
In the Document > Revision section, click Show Revision History.
Each revision is listed including the date of last modification and status.
View a Specific Revision of a Document
In the Document > Revision section, click Show Revision History.
In the timeline, click which Document Revision you want to view.
The Component and Main Body sections update to reflect the Revision you’ve selected.
Create a New Revision
Adding a revision to a Document automatically locks the previous revision but not the Document itself. The Document is not locked and can still be edited or revised, but the previous Revision is locked.
In the Document > Revision section, click Show Revision History.
Click Add.
Click Okay to confirm your action.
Modify the Document as required and Finalize.
Delete a Revision
You can delete the current Revision of a Document provided it has an In Progress status (i.e. it has not been Finalized). Previous Revisions cannot be deleted as they are automatically locked when you create a new Revision.
1. In the Revision > Component tab, click Delete.
2. Click Okay to confirm your action.