TYPO3 CMS System Notes

TYPO3 CMS System Notes 

Extension key

sys_note

Package name

typo3/cms-sys-note

Version

main

Language

en

Author

TYPO3 contributors

License

This document is published under the Open Content License.

Rendered

Mon, 19 Jan 2026 15:21:50 +0000

Records with messages which can be placed on any page and contain instructions or other information related to a page or section.

Table of Contents:

Introduction 

What does it do? 

The goal of the sys_note extension is to keep the backend more organized. You can add notes for yourself or for other backend users.

The sys_note table in TYPO3 is a database table used for storing notes or annotations related to records within your TYPO3 installation. These notes can be added by administrators or users to provide additional context or information about a specific record.

Video showing TYPO3 system notes in action 

This TYPO3 Feature Demo video from October 2024 shows the system notes usage in action.

For Editors 

Target group: Editors

The internal notes are a useful feature for adding context and notes to pages. It provides a way for users to document important information related to specific pages.

Table of Contents

Usage 

Adding a note 

To add a note to a page:

  1. Log in to the TYPO3 backend as a user with appropriate permissions.
  2. Navigate to the page where you want to add a note.

  3. Click on Create internal note for this page .

    Screenshot demonstrating the location of the "Create internal note" button in the module header of the Layout module

    The button to create a system not is located on the top right of the "Layout" and "Record" modules

  4. Create a new internal note, select the appropriate category and add the desired text content.
  5. Save the note.

Categories 

You can choose between:

Instructions
Used to provide instructions to the backend user.
Notes
Used for simple notes.
To-Do
Used to allow a backend user to see and complete pending to-dos.
Template
Used to output a template.
Creating a new internal note

Create a new internal note

Describing the note 

Enter the title of your note in the Subject field and the description in the Message field.

Activate the Personal toggle in the Access tab, if the note should be displayed only for you.

How does the internal note look in the backend? 

A System note is displayed on the top or bottom (depending on which option was activated in the record) of the modules "Page" and "List" when viewing the page in question:

Screenshot of a TODO note on the top of the "Page" backend module

If you have sufficient permissions you can edit or delete the note.

System notes dashboard 

New in version 13.3

There are multiple widgets available in the dashboard that show either all system notes or just those in a certain category. Only notes on pages for which you have access are shown.

Screenshot of the widget "All System Notes" in the Dashboard of a TYPO3 backend

Click the button to go to the page with the note in the backend.

If such a widget is not displayed in your dashboard, click the "+ Add widget to dashboard" button on the buttom right of the module and add the desired dashboard:

Screenshot of the "Add widget to dashboard" dialogue in tab "System notes"

Choose "All System Notes" or just the notes of a certain category

If you cannot find this type of widget in the dialogue or the widget does not show any messages talk to your administrator as your user permissions might be insufficient.

Installation 

Target group: Administrators

This extension is part of the TYPO3 Core.

Installation with Composer 

Check whether you are already using the extension:

composer show | grep sys-note
Copied!

This should either give you no result or something similar to:

typo3/cms-sys-note       v12.4.9
Copied!

If it is not installed, use the composer require command to install the extension:

composer require typo3/cms-sys-note
Copied!

The version installed depends on which version of the TYPO3 Core you are using.

Installation without Composer 

In an installation without Composer, the code of EXT:sys_note is already shipped. You just have to activate the extension. Head over to the System > Extensions module and activate the extension.

Extension Manager showing System Notes extension

Extension manager showing System Notes extension

For integrators 

Properly configuring access permissions to the sys_note table is essential to enable editors to effectively utilize this system extension. Internal notes allow editors to document important information related to specific pages, enhancing the overall usability and functionality of TYPO3 for your organization.

Administration / configuration 

To ensure smooth operation of the "Internal notes" extension, it is important to configure the necessary access permissions for editors. Editors must have read and/or write access to the sys_note table in TYPO3. Without the appropriate access permissions, editors may encounter issues when trying to create, view, or modify notes.

User permissions configuration 

Access to the sys_note table can be configured through TYPO3's backend user access settings. Here is how you can configure the necessary permissions:

  1. Log in to the TYPO3 backend as an administrator.
  2. In the backend, navigate to the Administration > Users module.

  3. Create a new Backend user group, if you do not have one already.

    Go to tab Record Permissions.

  4. Activate the Internal note checkbox for both Read & Write access in field Table permissions.

    Screenshot of the backend user group record, tab "Record permissions", field "Table permissions"

    Giving access to the sys_note table

  5. Save the changes.

By configuring access rights in this way, editors will have the necessary permissions to create, edit, and view notes using the "Internal notes" extension. This ensures that they can effectively use this feature to add context and notes to pages within your TYPO3 installation.

Remember to regularly review and update access permissions as needed to maintain security and compliance with your organization's requirements.

Permissions to use the system note dashboard widgets 

If typo3/cms-dashboard is installed and your editors are using the dashboard, it is recommended to grant them access to the special system note widgets.

In module Administration > Users > Backend user groups edit the user group in question. In tab Module Permissions, field "Allowed dashboard widgets" allow the dashboard widgets related to the system notes.

Sitemap