Overview
A Notes Field allows Users to add successive updates to a Record while retaining previous entries. It is useful for project commentary, investigation updates and handovers where colleagues need to understand how work has progressed.
The Field displays the latest saved note on the Record Form. Clicking the notepad icon opens the Notes window, where Users can read earlier entries and add another update. Each saved entry shows the author's email address and the date and time it was added.
This article uses a Latest Update Field in a Projects App to show how a team can follow a blocker from initial investigation through testing to resolution.
- When to Use a Notes Field
- Creating a Notes Field
- Using Notes in Workspace
- Using Notes in a Table Report
- Notes and Other Record Features
When to Use a Notes Field
Use Notes when Users need to record updates over time and keep the sequence available in one place.
For example, the Cyber Security Modernisation project has a blocker involving two legacy applications. The team adds a note at each development:
- The initial review identifies that further testing is required.
- Application owners agree a phased rollout while testing continues.
- Testing is completed and the rollout is scheduled.
- The rollout is completed and the blocker is resolved.
The latest note gives colleagues the current position. Earlier notes explain the decisions and work that led to it.
A Long Text Field suits a description or summary maintained as a single piece of text. A Notes Field provides a dedicated history of separate updates, each with its author and timestamp.
Creating a Notes Field
1. Select the Field Type
In App Studio, open the App and navigate to Input & Layout → Fields.
Select Add, search for Notes, then select the Notes result.
Search for Notes when choosing the new Field type.
2. Configure the Field
Complete the properties for the new Field.
| Property | Purpose |
|---|---|
| Label | The name displayed to Users. Choose a label that explains the purpose of the updates, such as Latest Update, Investigation Updates or Project Commentary. |
| Identifier | The unique system reference used to identify the Field within the App. It must contain only letters and numbers, start with a letter and contain at least three characters. |
| Type | Identifies the Field as Notes. |
| Description | Describes the Field’s purpose for those maintaining the App. |
| Note Display Order | Controls whether the saved entries appear Oldest First or Newest First in the Notes window. |
| Include In Free Text Quick Filter | Makes the Field searchable using the Report’s Free Text Quick Filter. |
| Exclude This Field From Templated Record Copies? | Excludes the Field’s data when a Record is copied using Template Copy. |
For our Projects App, the Field has the Label Latest Update and the Identifier LatestUpdate.
Configure the Field and choose how saved entries will be ordered.
3. Choose the Note Display Order
Choose the order that best supports how Users will review the history.
| Option | When to use it |
|---|---|
| Oldest First | To read the sequence from the beginning, such as following how an investigation developed. |
| Newest First | To check recent developments first, such as reviewing current project progress. |
For our Latest Update Field, Newest First makes the most recent development easy to find when opening Notes.
This setting controls the history in the Notes window. The Field on the Record Form continues to display the latest saved note, whichever order is selected.
4. Save, Add to a Template and Publish
Click Save, then add the Field to the appropriate Template.
We recommend spanning the Notes Field across the full Template row to give Users enough space to read the latest update comfortably.
Save the Template changes and publish the App to make the changes available in Workspace.
Using Notes in Workspace
Adding the First Note
- Open the Record and locate the Notes Field.
- Click the notepad icon beside the Field.
- Enter the update in the text box.
- Click Save Note.
When no notes have been saved, the window displays No Notes Found above the entry box.
Enter the first update and click Save Note.
Adding Further Updates
Open the Notes window again to read previous entries and add another update in the blank text box.
Click Save Note to add the new entry to the history. The window remains open and the entry box clears, ready for another note.
Each saved entry shows:
- The author’s email address.
- The date and time the note was added.
- The note text.
Earlier updates remain available above the entry box.
Click Close when you have finished.
Note: Closing the window without clicking Save Note discards any text in the entry box. Unsaved text will not reappear when the Notes window is reopened.
Saved entries have no edit or delete controls in the Notes window. Check the wording before saving. If an earlier update needs correcting, add a new note explaining the correction.
Reading the Latest Update
After closing the Notes window, the Field on the Record Form displays the latest saved entry.
In our example, this confirms that multi-factor authentication has been enabled for both legacy applications and that the blocker is resolved. The earlier investigation, planning and testing updates remain available through the notepad icon.
The latest update is visible on the Record, with the notepad icon providing access to the history.
Viewing the Notes History
Click the notepad icon to reopen the Notes window. Scroll within the history area to read entries that do not fit in the window.
The App Builder’s Note Display Order setting determines the sequence. With Newest First selected, the resolution appears at the top, followed by the earlier testing and planning updates.
Newest First places the most recent update at the top of the history.
Using Notes in a Table Report
App Builders can also add a Notes Field as a column in a Table Report.
In our Projects Report, the Latest Update column displays a notepad icon for each Record. This gives Users access to the updates alongside other project information.
The Latest Update column provides access to Notes for each project.
Click the notepad icon in the relevant row to open that Record’s Notes window. Users can read the history and add an update directly from the Report, without first opening the full Record Form.
Enter the update, click Save Note, then Close to return to the Report.
Read previous entries and save a new update directly from the Table Report.
Notes and Other Record Features
Notes, Record Comments and the Audit Trail support different activities.
| Feature | Purpose |
|---|---|
| Notes Field | Captures successive updates for a particular subject defined by the App Builder, such as project progress or investigation updates. |
| Record Comments | Provides a place for general discussion or observations associated with the Record. |
| Audit Trail | Provides a history of changes made to the Record. |
An App can contain separate Notes Fields for different purposes. For example, a project could have Delivery Updates and Budget Commentary, keeping each sequence of updates together under a clear label.
Comments
0 comments
Please sign in to leave a comment.