Skip to main content

Editing a Figure Document

Standard Operating Procedure (SOP) for editing a figure document within a site, including updating details, using the Figure Generator, uploading PDFs, publishing revisions, and creating new revisions.

T
Written by Trin Murphy

Objective

Edit an existing figure document for a site in EnviroAutomate. The edit page lets you update figure details, design figures using the built-in Figure Generator, upload PDF documents, publish revisions, and create new revisions of published figures.

Key Steps

1. Navigate to the Figure Document

  • In the left sidebar under Tasks, click Sites

  • Click on the site containing the figure document

  • Select the Figures tab on the site edit page

  • Click on the figure document row you want to edit

2. Review and Edit Basic Information

The top section shows the figure document details:

  • Name - Editable when the current revision is in Draft status. Disabled when the revision is Published. Must be unique within the site.

  • Figure Type - Display only. The figure type is set when the figure document is created and cannot be changed.

  • Revision Number - Display only. Shows the current revision number.

  • Summary - Editable when the current revision is in Draft status.

  • Published By and Published Date - Display only. Shown only for published revisions.

3. Add Content to a Draft Revision

When the revision is in Draft status, the Document section offers two options side by side:

Option 1: Figure Generator (Recommended)

  • Click Open Figure Generator to launch the built-in visual editor

  • The Figure Generator is a canvas-based tool where you can design site plans and diagrams with shapes, layers, and annotations

  • It automatically loads the site's assessment location coordinates for plotting on the figure

  • You can export the figure as a PNG image or PDF directly from the editor

  • Your work is saved automatically as you design

Option 2: Upload Existing PDF (Alternative)

  • Click Browse... to choose a PDF file from your computer. The filename appears in the input next to the Browse button.

  • Click Save at the bottom of the page to upload the PDF and attach it to the revision

  • Only PDF files are accepted

  • If a PDF has already been uploaded, choosing a new one and clicking Save replaces the existing document

4. Review the Document Preview

Once a PDF has been uploaded or generated, the Document Preview card displays:

  • A preview of the PDF document inside the page

  • The filename and file size

  • A download icon to save the PDF to your computer

  • A trash icon (Draft revisions only) to remove the uploaded PDF. A browser confirmation prompt appears before removal.

5. Publish the Revision

  • Ensure the draft revision has content - either a PDF uploaded or content created in the Figure Generator

  • Click the Publish button at the bottom of the page

  • The revision status changes from Draft to Published

  • If a previous revision was published, it is automatically marked as Superseded

  • Once published, the Name and Summary fields become read-only

Creating a New Revision

After a revision has been published, you can create a new revision to make updates:

  • Open the published figure document

  • Click the Create New Revision button at the bottom of the page

  • A new draft revision is created with the next revision number

  • The Figure Generator content and metadata from the published revision are automatically copied to the new draft as a starting point

  • You can then modify the figure and publish the new revision when ready

Differences from the Create Page

  • The Figure Type field is read-only on the edit page

  • The edit page includes Document upload/preview, Publish, and Create New Revision functionality that is not available on the create page

  • Field editability depends on the revision status - Draft revisions allow editing, Published revisions are read-only

Revision Workflow Summary

  • Draft - The revision is being worked on. Name, Summary, and Document can be edited. Can be published.

  • Published - The revision is finalised and read-only. A new revision can be created from it.

  • Superseded - A previously published revision that has been replaced by a newer published revision.

Audit Log

All changes to figure documents and their revisions are recorded in the audit trail, including who made changes and when.

Cautionary Notes

  • You cannot publish a revision without content - either upload a PDF or use the Figure Generator first

  • You cannot create a new revision if a draft revision already exists. Publish or discard the current draft first.

  • Removing an uploaded PDF cannot be undone - you will need to re-upload the file

  • Publishing a revision is permanent - the published revision becomes read-only and any previously published revision is superseded

  • The Figure Type cannot be changed after creation. If the wrong type was selected, create a new figure document with the correct type.

  • Save is the only way to persist changes to Name, Summary, or a newly selected PDF on a draft. Closing the page without saving discards your edits.

Tips for Efficiency

  • Use the Figure Generator for best results - it integrates with the site's assessment location data and produces consistent, professional figures

  • Review the figure in the Document Preview before publishing to ensure accuracy

  • Use the Summary field to describe what changed in each revision for easy tracking on the Figures list

  • When creating a new revision, the previous figure content is carried over, so you only need to update what has changed

Did this answer your question?