Skip to main content

Editor Guidelines

Use message editing to allow users to create any type of message sent through the SAP Engagement Cloud platform.

Structure​

Message editing is a workflow with the following steps:

  1. Message type selection
  2. Message settings
  3. Content editing
    • Message name
    • Save button
    • Additional actions
    • Tool panel
    • Preview panel
    • Message editing progress
  4. Optional steps
  5. Distribution settings
    • Message name
    • Save button
    • Message details
    • Scheduling / activation settings
    • Launch / Activate primary call to action
    • Preview panel
    • Message editing progress

Best Practices​

Message editing should:

  • Display the whole workflow: where the user came from, and what's next. Use the Steps component for this.
  • Display a button that takes the user back to the overview page (the list of messages being edited).
  • Allow users to edit the page title (message name) inline on any part of the process.
  • Group additional actions related to the document itself next to the Save button. Less important actions can be grouped under a drop-down menu.
  • Help the user understand the current state of the message. Possible states: draft, scheduled, launched/activated.

Try to avoid:

  • Displaying additional navigational elements like tabs to other parts of the service — this clutters the UI and distracts the user from their current workflow.

Message Settings​

Message settings should:

  • Allow the user to set up basic settings for the message, for example name, template used, and audience.
  • List all settings not specific to the message's contents or distribution.

Try to avoid:

  • Having settings that cannot be changed later.

Content Editing​

Content editing should:

  • Show tools related to editing in the left panel.
    • List tools to interact with content in a vertical tab (e.g. settings, versioning, listing of links).
    • Be hidden in the right context — for example when the user needs to compare previews, or when the preview also provides editing tools.
    • The width of the left panel should be fixed, but may differ based on the tools used.
    • Allow drag and drop if the preview panel also allows editing.
  • Show a live preview of the message in the right panel.
    • Provide a preview as the message would appear to contacts.
    • Show the live preview — changes should be propagated immediately.
    • Provide options for multiple views depending on the message (e.g. different devices, personalisation review).
    • Provide live editing if possible: rewriting words, changing images, rearranging content.

Try to avoid:

  • Mixing up content editing with other steps in the process.

Distribution Settings​

Distribution settings should:

  • Provide a safe, checkout-like experience showing the potential impact of launching/activating the message (e.g. potential number of contacts affected).
  • Provide a clear way of scheduling the message — when it will launch or what timeframe it will be active.
  • Show a live preview of the message to be sent, as a last check.