Logbook¶

The Logbook module provides a way to record free-text notes tied to specific parts of the system. An entry is filed against the thing it concerns: a workview, an object, or a topic path of the operator's own choosing.

Entries are reached through a single topic tree that can be keyed two ways. Workview mode arranges notes by the folder structure of the process views, and signal mode arranges them by tag path. A note is reachable in both, because a note on an object also belongs to every view that object is drawn in, and a note on a view also belongs to the objects drawn in it.

The logbook is available in three places: globally under Documents & Logbook → Logbook, in the Logbook tab of any object popup, and through the SpeedDial menu on process views.

The global logbook also shows the logbooks of connected remote systems, each under its own top node, and every logbook view refreshes by itself when an entry changes.

Contents¶

Get started¶

• The Logbook View — Layout, topic tree, entry list and archiving.
• Switching How the Tree Is Keyed — Workview mode and signal mode.
• Creating an Entry — Fields and how to save.
• Filtering — Searching and filtering entries, including archived ones.

Configuring¶

• What an Entry Is Filed Against — Views, objects and free topics.
• How the Two Trees Are Built — Workview mode, signal mode and how a note appears in both.
• Contexts — Managing named context groups.
• Access Patterns — Global, object popup and view-scoped usage.
• Logbooks of Remote Systems — Remote systems as top nodes, writing to them and live updates.

Extending¶

• Privileges — Required privileges for adding, editing and archiving entries.
• Topic Storage — The topic, topic_kind and topic_ref columns.
• Archiving — The archived column, the archive functions and permanent deletion.
• Script Reference — The scLogBook functions behind the tree, the scoped views and the remote systems.

Troubleshooting¶

• Common Issues — Common issues and how to fix them.