Review and manage document previews
Use the document preview panel to review generated document content, export it, and (if permitted) update its status or save a new version.
This guide is designed for project manager.
Steps
Step 1: Open the document preview panel
From the reports area, select a document to open its preview panel. The panel slides into view showing the document title, current status badge, and key details. Use the close icon in the top corner to hide the panel when you are finished.
Step 2: Review document details and status
Check the header area to see the document’s current status (such as Draft, Pending Validation, Valid, Current, Superseded, Archived, or Invalid) displayed as a coloured badge. Review any warning or status indicators, including timestamps and validation notes, so you understand whether the document is ready to be used.
Step 3: Preview the document content
Scroll through the main content area to read the full document. The preview renders the stored HTML content in a read-only format by default, allowing you to confirm that the wording, structure, and key information are correct before you share or approve it.
Step 4: Export the document
Select the Export or Download button in the panel toolbar to export the current document. Wait while the export runs; the button will show a loading state if exporting is in progress. Once complete, your browser will download the exported file so you can save or share it externally.
Step 5: Start editing the document content (if enabled)
If content editing is allowed, choose the Edit or Start editing option. The content area changes into an HTML editor where you can click into the text and make updates. Use the toolbar at the top of the editor (if available) to format headings, lists, and other elements as needed.
Step 6: Update the HTML content
Type directly into the editor to adjust the document content. As you make changes, the component keeps track of your edits but does not overwrite the saved version until you explicitly save, allowing you to review all adjustments before committing them.
Step 7: Save a new document version
When you are satisfied with your edits, select the option to Save new version. The panel sends the updated HTML content for saving and may show a saving indicator while the request completes. After saving, the preview refreshes to show the latest version, and edit mode is closed.
Step 8: Cancel editing and discard changes
If you decide not to keep your changes, select Cancel editing. The editor exits edit mode, discards unsaved content, and restores the view-only preview of the last saved version so that no accidental updates are applied.
Step 9: Adjust document status and current flag (if permitted)
If you have permission to manage status, use the status dropdown to select a new document status and, where available, toggle whether this version is marked as the current one. Confirm the change to update the status badge and flags, helping your team understand which version should be used operationally.
Step 10: Review and handle error messages
If an error occurs while exporting, saving a new version, or updating the status, review the error message displayed in the panel. Adjust your input or try the action again once the issue has been resolved, or contact an administrator if the error persists.
Related Tasks
Last updated: 2026-02-20