消息模板

Message Templates 视图中,用户可以创建、编辑或删除消息模板。

点击 Create 按钮,显示 Message Template 视图,包含 Template DetailsParameters 两个 tab。

模板详情

Template Details 包含一个配置模板属性的面板以及一个设计模板布局和内容的 HTML 编辑器。

template body

模板属性

模板可以配置下列属性:

  • Name:模板的可读名称,必填字段。

  • Code:模板的唯一标识符,必填字段。

  • TypePlain TextHTML

  • Group(可选):模板分组。模板组可以在 Template groups 视图中配置。

模板设计

在 HTML 编辑器中,可以使用文本、图片、按钮等元素创建模板。元素的属性可以通过编辑器内的面板设置。

在模板的文本中,可以使用 占位符 插入动态数据。

关于编辑器的更多信息,请参阅 GrapesJS 文档

占位符

占位符是消息模板中的变量,在运行时使用实际的数据替换。使用 FreeMarker 的插值语法定义,如 ${variableName}

用于替换占位符的数据可以来自模板中定义的 参数,或从应用程序代码编程式传入。

FreeMarker 还提供了内置函数用于对占位符的数据进行处理和格式化。例如,${date?string["MM/dd/yyyy"]} 将日期格式化为 MM/dd/yyyy

更多信息,请参阅 FreeMarker 文档。

模板编辑工具

HTML 编辑器顶部的按钮面板提供以下工具:

  • Import HTML:上传已有的 HTML 到模板中。

  • Export HTML:以 HTML 格式下载当前的模板内容。

  • View Source Code:显示 HTML 代码,可以查看或编辑。

模板预览

可以在编辑器或 Message templates 列表视图中预览消息模板。如果模板定义了 参数,则首先打开参数的输入框,然后在预览窗口显示渲染结果。

参数

Parameters tab 可以创建和配置模板参数。

参数详情

Parameter details tab,可以为每个参数配置以下属性:

  • Name:显示在输入表单中的参数名。

  • Alias:唯一标识符,在模板和代码中使用。

  • Type:参数的数据类型。支持的类型包括 StringNumberBooleanDateTimeDate and TimeEnumerationEntity 以及 List of Entities

  • Hidden:在输入表单中隐藏该参数。

  • Required:参数是否必填。

  • Default Value:参数的默认值。

参数类型和附加字段

有些参数类型需要配置额外的字段:

  • 实体实体列表

    • Entity:参数的实体类型。类型为 EntityList of Entities 时必填。

  • 枚举

    • Enumeration:参数使用的枚举类型。类型为 Enumeration 时必填。

  • DateTimeDate and Time

    • Default date/time is current:默认使用当前日期或时间。

本地化

Localization tab 中可以定义参数不同地区语言的名称。