Skip to content

Notebook

The notebook allows creating and managing notes that are attached to inventory devices. Management is handled via the NotepadController in the Laravel API.

Notebook = filtered view of notepad entries

Notes, tasks and maintenance reminders share one data foundation (the notepad table). The notebook is the device-scoped view of these entries; a free-form note is technically a task (entry_type = task) without assignment and without a due date. For types and fields see Tasks — Overview.

Purpose

Notes serve as informal documentation for observations, hints, or information about a specific inventory device. They complement the structured data fields with a flexible comment function.

Typical Use Cases

  • Record special handling instructions for a device
  • Document results of informal visual inspections
  • Communication between team members about a device
  • Note hints for the next calibration

CRUD Operations

Notes are managed through the notepad resource. The device link is established via the inventory_id field; the notes of a device can be read via the subresource GET /api/v2/inventories/{mtag}/notepads.

Create Note

POST /api/v2/notepads
Field Required Description
comment Yes Note text (free text, up to 2048 characters)
inventory_id No Linked inventory device
date_time No Due date (leave empty for a plain note)
status No Status (default: new)

No priority column

The data model has no dedicated priority field. Urgency is expressed through the due date (date_time) and the status.

Edit Note

PUT /api/v2/notepads/{id}

Delete Note

DELETE /api/v2/notepads/{id}

Warning

Deleted notes cannot be restored. The deletion is recorded in the device's change log.

Display in Inventory

Notes are displayed in the detail view of an inventory device in the "Notebook" tab. They are sorted chronologically (newest first).

Each note shows:

  • Note text (comment)
  • Creation date and author
  • Last modified date (if edited)
  • Status

Dashboard Widget

The dashboard displays a "Recent Notes" widget that lists the most recently created or edited notes. It provides a quick overview of the latest entries across the entire system.

Information Description
Content Note text (comment)
Device Assigned inventory device (linked)
Author Creator of the note
Date Creation or modification date

Widget Configuration

The number of notes displayed in the widget can be adjusted in the user settings (default: 5).

Permissions

Access control for the notebook is managed through three separate permissions:

Permission Description
notepad_view Read notes and display in the dashboard widget
notepad_edit Create and edit notes
notepad_delete Delete notes

Tip

Grant the delete permission (notepad_delete) only to selected users to prevent accidental deletion of important notes.

Notes can be found via the global search function. The search considers the note text (comment).