Skip to main content

Note / NoteThread

Introduction

Note and NoteThread entities provide a threaded note/comment system attachable to any entity (orders, contacts, commodities, etc.). Notes are organized into threads for structured conversations and audit trails.

Entity Structure

NoteThread Properties

Property NameTypeRequiredDescription
NoteThreadIdintYesPrimary key
EntityIdintYesID of the parent entity
EntityTypestringYesType of the parent entity (e.g., "Order")
NamestringNoThread name/subject
CreatedDateTimeYesCreation timestamp
CreatedBystringYesUser who created the thread

Note Properties

Property NameTypeRequiredDescription
NoteIdintYesPrimary key
NoteThreadIdintYesForeign key to NoteThread
ContentstringYesNote content
AuthorstringYesNote author
CreatedDateTimeYesCreation timestamp
LastModifiedDateTimeYesLast modification timestamp

Relationships

RelationshipTypeDescription
NoteThread.NotesCollectionNotes within a thread

Workflow Tasks

Notes are managed via dedicated workflow tasks:

  • Note/Create@1 - Create a note in a thread
  • Note/Update@1 - Update note content
  • Note/Delete@1 - Delete a note
  • Note/Import@1 - Bulk import notes
  • Note/Export@1 - Export notes
  • Note/RenameThread@1 - Rename a thread

See Note Tasks for YAML examples.