Skip to main content

Design Notes

Message Templates define the inbox messages that can be sent from form-related business flows. A template controls the message name, description, message body, card appearance, footer action, status, and the form fields that can be inserted as variables.

Use Message Templates when a form process needs a reusable notification card, approval reminder, task notice, result notice, or business message that should keep a consistent layout.

Page Structure​

Message Templates includes two main areas:

AreaPurpose
Template ListSearches, creates, edits, deletes, and opens message templates
Design PageSelects the related form, writes the body, inserts field variables, configures the card header, body limits, footer action, previews the result, and manages status

The current editor focuses on inbox templates. Other delivery channels should be documented separately after their editor flows are available.

Card Anatomy​

Every inbox message uses the same card. The parts are fixed; only their content and visibility change:

PartDescription
HeaderA rounded icon chip (optional) plus the title text, which is always displayed
BodyMarkdown content built from an H3 title line and one attribute row per field; it can be hidden or limited to a number of lines
FooterAn optional clickable strip with the footer name and a right arrow; it disappears when the switch is off
Trigger actionWhat a card or footer click opens: content details, an internal route, or an external URL

Common Workflow​

  1. Create a template and enter a clear name
  2. Add a short description so other admins understand where the template is used
  3. Open the design page
  4. Select the related form when the message needs form field variables
  5. Write the message body and insert field variables where dynamic data is needed
  6. Configure the title text, body lines, footer name, and trigger action
  7. Preview the card in light and dark mode and save the template
  8. Enable the template after the content is ready

Design Principles​

PrincipleDescription
Keep messages reusableAvoid writing content that only works for one record unless that value is inserted with a field variable
Choose a stable related formChanging the related form clears variables that no longer match the selected form
Keep the standard body shapeStart with an H3 title line, then write one {color:#8c8c8c}Label{/color}: value row per attribute
Use a concise footer nameThe footer name should describe the action, such as View Details or Open Task
Card colors are not configurableEvery card uses the fixed #F9FAFB / #171717 palette. Only the icon chip background color is configurable
Enable only completed templatesDraft templates can still be edited freely. Enabled templates should be treated as live configuration