Skip to main content
Skip table of contents

Notes

Overview

The Notes feature offers users the flexibility to add supplementary information to an object within the system.

This powerful tool enhances user interaction, providing a seamless way to annotate, clarify, or expand upon the data linked to an object.

The Notes editor allows the use of rich content including tables, links and images providing a better and more friendly way to add context to your notes.

Notes vs Diary

Notes and Diary serve the purpose of adding additional information to an object, but they are of different nature and have different use-cases.

The Diary is mainly used to record events. When an email or SMS is sent to a student or a counselling session occurs for example, a diary entry for that student is created. The Diary has the history of the events with a particular entity. Due to this nature, the Diary is only available on objects that represent individuals or business entities such as students, leads or agents.

Notes have a more generic nature and can be used to add more generic information to an object. For this reason, Notes are also available on objects that do not represent an individual or business entities. For example, Notes can be added to Students but also to Offers, Enrolments, Invoices etc.

Unlike Diary entries, which include extra fields like a subject and a category, Notes consist solely of the body without any additional fields. However, Notes allow rich content with advance formatting but Diary entries can only have plain text.

Notes allow you to mention other users to draw their attention to a specific note, while diary entries do not support mentions.

As Diary entries are mainly used to record communication events, a date different to the creation date can be set for each entry. Notes do not have a different date than the creation date.

When to use the Diary

  • To record events (calls, emails, sms, meetings, etc).

  • When more structured details for the entry are required (subject, date, time, category).

When to use the Notes

  • To annotate, clarify, or expand upon a record.

View Notes

Permissions Required

To access Notes, permissions are granted based on the target object.
For instance, to view the Notes for a student, you would need the following permissions:

  • Students > View Students

  • Students > Notes > View Student Notes

  1. Navigate to the details page of the object that you want to see the notes for.

  2. Click on the Notes tab.

    image-20241018-002420.png
  3. You’ll see the notes available. The options available are:

    1. Create a Note: Adds a note entry.

    2. Notes Preview: The current note entry’s preview under this object.

    3. Expand Icon: Click to expand the note body content.

    4. Details Icon: Click to navigate to the note’s detail page.

    5. Edit the Detail: Edits the selected note entry.

    6. Delete the note: Deletes the selected note entry.

      image-20241018-003225.png
  4. Click on the expand icon of the note entry to see the full content of the note, or click on Details icon to see the full details of the note entry.

    image-20241018-004401.png

Mentions

You can mention one or more users to draw their attention to a Note. To do this, type "@" and choose the desired users from the displayed list. Once the note is saved, the tagged users will receive both in-app and email notifications.

Create Notes

Permissions Required

To add new Note, permissions are granted based on the target object.
For instance, to create a Note for a student, you’d need the following permissions:

  • Students > View Students

  • Students > Notes > View Student Notes

  • Students > Notes > Create, Edit and Delete own Notes

  1. In the Notes tab, click on New Note.

    image-20241018-003352.png
  2. Enter the content of the note using the text editor.
    Details such as Created Date or Created By will be automatically entered by system.

Tip

Mention other users by typing @ and selecting the user from the dropdown list.
The mentioned user(s) will receive a notification in the app and by email.

  1. Click on Save to finish.

    image-20241018-003656.png

Edit Notes

Permissions Required

To modify a Note, permissions are granted based on the target object.
For instance, to edit Notes that the user created in a student, you’d need the following permissions:

  • Students > View Students

  • Students > Notes > View Student Notes

  • Students > Notes > Create, Edit and Delete own Notes

To edit Notes created by other users, the following extra permission is required:

  • Students > Notes > Edit other users notes

  1. Go to the Notes of the object that you want to edit the note for.

  2. Find the note that you’d like to update. Then click on the Edit icon.

    image-20241018-005236.png
  3. Update the note as needed.

  4. Click on Save to finish.

    image-20241018-005427.png

When a note gets updated and it mentions someone, the mentioned users will get a notification letting them know about the update.

Delete Notes

Permissions Required

To delete a Note, permissions are granted based on the target object.

For instance, to delete Notes that the user created in a student, you’d need the following permissions:

  • Students > View Students

  • Students > Notes > View Student Notes

  • Students > Notes > Create, Edit and Delete own Notes

To delete Notes created by other users, the following extra permission is required:

  • Students > Notes > Delete other users notes

  1. Go to the Notes of the object that you want to edit the note for.

  2. Locate the note that you’d like to delete. Then click on the Delete icon.

  3. Click Yes to delete.

    image-20241018-005839.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.