Objective
This SOP outlines how to view and edit an existing guideline in EnviroAutomate. Guidelines can be either organisation-specific (fully editable) or shared across all organisations (read-only with overrides for report output fields).
Prerequisites
You must be logged in as an administrator
The guideline must already exist in the system
Key Steps
1. Navigate to the Guideline
Click "Guidelines" in the left sidebar under the Scientific Settings section
Find the guideline you want to view or edit in the list
Click on the guideline row, or click the edit icon (pencil) in the Actions column
2. Update Guideline Information
For organisation-specific guidelines, you can modify all fields:
Title - Update the guideline title
Version - Update the version number
Jurisdiction - Change the jurisdiction
Publication Date - Update the publication date
Source URL - Update the link to the source document
Description - Update the description
For shared guidelines, these fields are read-only.
3. Update Licence Information
Licence Number - Update the licence number
Licence Issue Date - Update the issue date
Licence Issuer - Update the issuer
4. Update Report Output
For organisation-specific guidelines, you can edit these fields directly. For shared guidelines, you can create tenant overrides:
Sort Order - Controls the display order in reports (higher numbers first). Overridable for shared guidelines.
Table Short Description - A short description for report table headers. Overridable for shared guidelines.
Table Reference Description - A longer reference for report footnotes. Overridable for shared guidelines.
5. Save Changes
Click "Save" to update the guideline (only visible if you have edit permissions)
6. View Audit Log (Optional)
Click the "Audit Log" button in the top-right corner to view the change history
Tenant Overrides for Shared Guidelines
Some guidelines are shared across all organisations. For these guidelines, the core fields (Title, Version, Jurisdiction, etc.) are read-only. However, you can override the following Report Output fields for your organisation:
Table Short Description - Customise the short description used in your reports
Table Reference Description - Customise the reference description used in your reports
Sort Order - Control the display order of this guideline in your reports
To create an override:
Click the "Override" button next to the field
Enter your organisation's preferred value in the modal dialog
Save the override — the field will show a yellow "Overridden for your tenant" indicator
Overrides only affect how the guideline appears in your organisation's reports. The shared value remains unchanged.
Organisation-Specific vs Shared Guidelines
Organisation-specific guidelines - Created by your organisation. All fields are fully editable. No override buttons are shown.
Shared guidelines - Shared across all organisations. Core fields are read-only. Override buttons appear next to Report Output fields.
Differences from the Create Page
Read-only mode - Shared guidelines have read-only core fields
Tenant overrides - Override buttons on Report Output fields for shared guidelines
Audit Log - Available on Edit, not on Create
Cautionary Notes
For organisation-specific guidelines, changes only affect your organisation
Tenant overrides only affect your organisation's reports
The Table Short Description and Table Reference Description appear in generated reports — ensure they are accurate
Always click "Save" before navigating away or your changes will be lost
Tips for Efficiency
Use tenant overrides to customise how shared guidelines appear in your organisation's reports without affecting other organisations
Use the Sort Order to control the order in which guidelines appear in report tables
Use the Audit Log to track changes to guideline details