借助格式化输出模板,可以快速将完整对象记录传输到自定义模板文件中。新建格式化输出模板时,可以在允许用户生成和下载模板文件的对象记录上配置用户操作。格式化输出模板包含对象记录数据的总体表示,包括其字段、相关记录字段和相关文档字段。格式化输出模板与特定对象关联。

关于格式化输出模板

格式化输出模板使用预先配置的 XML 表单架构 (XFA) PDF 文件,其控制在文档上呈现模板时捕获的特定字体、样式、布局、图像和 Vault 字段。这些模板是启用了表单的 PDF 文件,通常在 Adobe LiveCycle Designer 或 Adobe AEM Forms Designer 中创建。您必须在 Vault 之外创建这些文件,并将它们作为模板上传。

创建 XFA PDF 文件以使用格式化输出模板时:

  • 您必须使用“文本”字段类型添加 Vault 字段,而无论 Vault 中的字段类型如何。例如,通过插入标记为 VLT__name__v 的文本字段包括对象名称。Vault 不会接受包含与 Vault 中的对象记录字段名称不匹配的文本字段名称的模板。
  • 您可以选择“富文本”作为字段格式,以合并 Vault 的富文本格式设置选项。
  • 要包含图像,例如您的公司徽标,请将它们作为图像对象添加。在 Vault 内不支持图像字段对象。必须标记图像对象,才能将图像嵌入到 PDF 文件中。
  • Vault 在格式化输出模板中最多支持 150 个映射字段。
  • Vault 支持子查询,例如,表示相关记录的模板的 TableTableRow 元素上的 VQL WHERE 子句。Vault 根据查询响应将相关记录信息分组为相关页面和报告输出的特定节段。
  • 您可以使用 VQL ORDER BY 子句指定相关记录的顺序。

下面这几个建议有助于确保您的模板具有专业的外观并正常工作:

  • 将表单字段放在表格中,以便元素的顺序和间距在不同长度的字段值中保持一致。
  • 使用自定义 Adobe 对象样式来保持字体、字体大小和粗细一致。
  • 定义可以更改的元素(调整大小、跨页面拆分、连字符)。
  • 为所有页面、主页面、表格和表格行命名。给予元素唯一名称。如果不返回数据,则可以使用喜欢的任何命名约定。唯一元素名称将防止上传时的运行时和验证错误。

限制

subformSet 元素中包括的 CJK 字符可能不会在格式化输出模板中正确显示。

格式化输出和 VQL

格式化输出使用 VQL 从模板生成输出。限定版 Vault 使用 VQL 的当前测试版本,正式版 Vault 使用 VQL 的当前正式版。这意味着对 VQL 的更改可能会影响您的格式化输出。

例如,假设格式化输出模板包括文档编号字段 dosage__c。Vault 在创建格式化输出时执行 VQL 语句以获取此字段的值。用户为 dosage__c 输入值 10

在 Vault 版本 21R1(使用 VQL 版本 v21.1)中,文档编号字段完全按用户输入内容显示。格式化输出将为 dosage__c 显示 10

在 Vault 版本 21R2(使用 VQL 版本 v21.2)中,文档编号字段显示字段配置的小数位。如果 dosage__c 配置的小数位2,则即使用户输入 10,格式化输出也将显示 10.00

您可以在开发人员门户中详细了解 VQL。您还可以在开发人员发布说明中了解 VQL 的更改。

访问模板管理

管理选项位于管理 > 业务管理员 > 格式化输出中。所有管理员都可以通过此页面管理格式化输出模板。

如何创建格式化输出模板

要创建格式化输出模板,请执行以下操作:

  1. 格式化输出页,单击创建格式化输出
  2. 输入标签
  3. 可选:修改名称。系统不会向最终用户显示此值。它是通过 API 使用的。
  4. 根对象选项列表中选择一个对象。
  5. 如果对象拥有对象类型,则从根对象类型选项列表中选择一个对象类型。
  6. 单击选择并上传 XFA PDF。附加之后,文件名将出现在选择按钮的旁边。此时,Vault 会运行自动化验证流程。
  7. 从选项列表中选择一个输出格式。
  8. 单击保存

格式化输出模板

验证

上传模板文件后,Vault 会运行自动化验证。此流程会检查 XFA 文件,以确保它们符合一组上传要求,例如,支持上传的文件类型。验证后,文件会成功上传并保存。如果验证失败,Vault 会提供错误消息以及失败原因。

如何编辑格式化输出模板

要编辑格式化输出模板,请执行以下操作:

  1. 格式化输出页,从列表中单击模板。
  2. 单击编辑
  3. 做必要的改动。您可以上传模板标签、名称和输出格式。您无法更改根对象或根对象类型。
  4. 单击保存

如何删除格式化输出模板

要删除格式化输出模板,请将光标悬停在要删除的模板上并单击红色 (x) 按钮。在删除格式化输出模板窗口中,单击继续。您还可以单击某个模板,然后单击删除按钮。

配置用户操作以下载格式化输出模板

您可以在对象生命周期状态上配置下载格式化输出用户操作,以允许用户下载格式化输出模板。借助此用户操作,您可以进行以下设置:

  • 从配置的格式化输出模板列表中选择要下载的模板。
  • 将记录附件打包并包括在文件中:完成时,此操作会将生成的打包文件附加到记录。需要编辑权限。
  • 将文件附加到根对象/对象类型记录:此选项仅当与模板关联的对象支持附件时才可用。需要编辑权限。

如果选择不在记录中附加文件,用户无需编辑访问权限即可生成输出。这让 Vault 能够为处于关闭或锁定状态的对象记录生成输出。

字段引用语法

设置 XFA PDF 文件以引用根对象字段、相关对象记录字段以及相关文档字段上的值。其中每一项都有必须使用的特定语法,其遵循 VQL 标准模式。所有文本字段都必须以 VLT__ 前缀开头。

名称作用示例
引用根对象上的特定对象字段引用审计对象(从中运行报告的记录的对象)的名称和编号。name__v
number__v
通过对重复元素进行一次或多次引用来引用与根对象相关的对象上的特定字段根据以下内容获取与审计关联的每项调查的名称:

审计对象与内部调查 (internal_investigations__vr) 和外部调查 (external_investigations__vr) 对象有入站关系。

VLT__internal_investigation__vr.name__v
VLT__external_investigaton__vr.name__v
通过对重复元素进行一次或多次引用来引用与根对象相关的文档上的字段根据以下内容获取与产品关联的每个文档的文档编号:

包含产品的产品套件(通过产品套件的入站关系 primary_suite__vr 相关)以及与“主要产品 (primary_product__c)”文档字段关联的相关文档元素。

VLT__product_suite__vr.

primary_suite__vr.

document_primary_product__cr.

document_number__v

引用创建输出的用户显示生成格式化输出的用户的姓名和用户名。VLTR__user__sys.first_name__sys
VLTR__user__sys.last_name__sys
VLTR__user__sys.name__v
VLTR__user__sys.username__sys
引用用户创建输出的时间显示用户生成格式化输出的日期和时间VLTR__fo_generated_datetime
引用记录上的附件列表显示根记录上的附件列表。每个附件都在所分配文本字段的单独一行中显示。请注意,此令牌无法用于显示根记录以外的记录上的附件。VLTF__attachmentsList__v