使用表单数据模型

表单数据模型编辑器提供了用于编辑和配置表单数据模型的直观用户界面和工具。 使用编辑器，您可以在表单数据模型中添加和配置来自关联数据源的数据模型对象、属性和服务。 此外，它允许您创建数据模型对象和属性（无需数据源），并在以后将它们与相应的数据模型对象和属性绑定。 您还可以为数据模型对象属性生成和编辑示例数据，在预览时可以使用这些数据预填自适应表单和交互式通信。 您可以测试在表单数据模型中配置的数据模型对象和服务，以确保它与数据源正确集成。

如果您是Forms数据集成的新手，但尚未配置数据源或创建表单数据模型，请参阅以下主题：

• AEM Forms数据集成
• 配置数据源
• 创建表单数据模型

阅读有关各种任务和配置的详细信息，您可以使用表单数据模型编辑器执行这些操作。

添加数据模型对象和服务

如果您使用数据源创建了表单数据模型，则可以使用表单数据模型编辑器添加数据模型对象和服务、配置其属性、在数据模型对象之间构建关联以及测试表单数据模型和服务。

您可以在表单数据模型中添加来自可用数据源的数据模型对象和服务。 当添加的数据模型对象显示在“模型”选项卡中时，添加的服务显示在“服务”选项卡中。

要添加数据模型对象和服务，请执行以下操作：

1. 登录AEM作者实例，导航到 Forms>数据集成，然后打开要在其中添加数据模型对象的表单数据模型。

2. 在“数据源”窗格中，展开数据源以视图可用的数据模型对象和服务。

3. 选择要添加到表单数据模型的数据模型对象和服务，然后点按添 加选定。

   

   所选数据模型对象和服务

   “模型”(Model)选项卡显示所有数据模型对象及其添加到表单数据模型的属性的图形表示。 每个数据模型对象由表单数据模型中的框表示。

   

   “模型”(Model)选项卡显示添加的数据模型对象

   注意

   您可以按住并拖动数据模型对象框以在内容区域中组织它们。 在“数据源”窗格中，在表单数据模型中添加的所有数据模型对象都灰显。

   “服务”选项卡列表添加了服务。

   

   “服务”选项卡显示数据模型服务

   注意

   除了数据模型对象和服务外，OData服务元数据文档还包括定义两个数据模型对象之间的关联的导航属性。 有关详细信息，请 参阅使用OData服务的导航属性。

4. 点按 保存 ，以保存表单模型对象。

   注意

   您可以使用自适应表单规则调用在表单数据模型的“服务”选项卡中配置的服务。 配置的服务在规则编辑器的调用服务操作中可用。有关在自适应表单规则中使用这些服务的详细信息，请参阅调用服务和设置规则 的值。

创建数据模型对象和子属性

创建数据模型对象

您可以从配置的数据源添加数据模型对象，也可以创建没有数据源的数据模型对象或实体。 这非常有用，如果您尚未在表单数据模型中配置数据源。

要创建没有数据源的数据模型对象，请执行以下操作：

1. 登录AEM作者实例，导航到 Forms>数据集成，然后打开要在其中创建数据模型对象或实体的表单数据模型。

2. 点按 创建实体。

3. 在“创建数据模型”对话框中，指定数据模型对象的名称，然后点按“添 加”。 数据模型对象被添加到表单数据模型。 请注意，新添加的数据模型对象未绑定到数据源，并且没有任何属性，如下图所示。

   

接下来，可以在未绑定数据模型对象中添加子属性。

添加子属性

表单数据模型编辑器允许您在数据模型对象中创建子属性。 创建时的属性不绑定到数据源中的任何属性。 您以后可以将子属性与包含数据模型对象中的其他属性绑定。

要创建子属性，请执行以下操作：

1. 在表单数据模型中，选择数据模型对象，然后点按创 建子属性。

2. 在“创 建子属性 ”对话框中，分别在“名称”和“类型”字段中为属 性指 定名 称和数据 类型。 您可以选择指定属性的标题和说明。

3. 启用计算（如果属性是计算属性）。 计算属性的值基于规则或表达式。 有关详细信息，请参阅 编辑属性。

4. 如果数据模型对象绑定到数据源，则添加的子属性将自动绑定到具有相同名称和数据类型的父数据模型对象的属性。

   要使用数据模型对象属性手动绑定子属性，请点按“绑定引用”字段旁 的浏览图标 。 “选 择对象 ”对话框列表父数据模型对象的所有属性。 选择要绑定的属性，然后点按勾号图标。 请注意，您只能选择与子属性数据类型相同的属性。

5. 点按 完成 以保存子属性，然后点 按保存 以保存表单数据模型。 子属性现已添加到数据模型对象。

创建数据模型对象和属性后，您可以继续创建基于表单数据模型的自适应表单和交互式通信。 以后，当您有可用的数据源并进行配置时，您可以将表单数据模型与数据源绑定。 绑定将在相关的自适应表单和交互式通信中自动更新。 有关使用表单数据模型创建自适应表单和交互式通信的更多信息，请 参阅使用表单数据模型。

绑定数据模型对象和属性

当要与表单数据模型集成的数据源可用时，您可以按照更新数据源中的说明将它们添加到表单 数据模型。 然后，执行以下操作以绑定未绑定的数据模型对象和属性：

1. 在表单数据模型中，选择要与数据源绑定的未绑定数据源。

2. 点按 编辑属性。

3. 在“编 辑属性 ”窗格中，点按“绑定”字段旁 边的浏览图 标。 它打开“选 择对象 ”对话框，列表在表单数据模型中添加的数据源。

   

4. 展开数据源树，选择要与其绑定的数据模型对象，然后点按勾号图标。

5. 点按 完成 以保存属性，然后点 按保存 以保存表单数据模型。 数据模型对象现在与数据源绑定。 请注意，数据模型对象不再标记为“未绑定”。

   

配置服务

要读取和写入数据模型对象的数据，请执行以下操作以配置读取和写入服务：

1. 选中数据模型对象顶部的复选框以将其选中，然后点按编辑 属性。

   

   编辑属性以为数据模型对象配置读和写服务

   此时将打开编辑属性对话框。

   

   编辑属性对话框

   注意

   除了数据模型对象和服务外，OData服务元数据文档还包括定义两个数据模型对象之间的关联的导航属性。 将OData服务数据源添加到表单数据模型时，表单数据模型中有可用于数据模型对象中所有导航属性的服务。 您可以使用此服务读取相应数据模型对象的导航属性。

   有关使用服务的详细信息，请参 阅使用OData服务的导航属性。

2. 切换 顶级对象 ，以指定数据模型对象是否为顶级模型对象。

   在表单数据模型中配置的数据模型对象可用于基于表单数据模型的自适应表单的内容浏览器中的“数据模型对象”选项卡。 在两个数据模型对象之间添加关联时，您要关联的数据模型对象嵌套在您要从“数据模型对象”(Data Model Objects)选项卡中关联的数据模型对象下。 如果嵌套数据模型是顶级对象，它也将单独显示在“数据模型对象”(Data Model Objects)选项卡中。 因此，您将看到它的两个条目，一个在嵌套层次结构内部，另一个在嵌套层次结构外部，这可能会使表单作者感到困惑。 要使关联的数据模型对象仅显示在嵌套层次结构中，请禁用“顶级对象”属性。

3. 为所选数据模型对象选择“读取和写入”服务。 出现服务的参数。

   

   为员工数据源配置的读写服务

4. 点 （获取读取服务参数）, 将参数绑定到“用户用户档案属性”、“请求属性”或“文本”值 ，然后指定绑定值。

5. 点 按完成 以保存参数， 单击完成 以保存属性， 然后单击保 存以保存表单数据模型。

绑定读取服务参数

根据绑定值将Read服务参数绑定到用户用户档案属性、请求属性或文本值。 该值作为参数传递到服务，以从数据源获取与指定值关联的详细信息。

Literal value

从“ 绑定 到” 下拉菜单中选 择“文本 ”，并在“绑定值”字 段中输入值。 从数据源检索与该值相关联的详细信息。 使用此选项可检索与静态值关联的详细信息。

在此示例中，从数据源 检索与 4367655678 mobilenum （作为参数的值）关联的详细信息。 如果传递了移动号码参数的值，则关联的详细信息可以包括客户名称、客户地址和城市等属性。

用户配置文件属性

从“ 绑定到 ”下 拉菜单中选 择“用户用户档案 属性”，并在“绑定值”字段中输 入属性名。 登录AEM实例的用户的详细信息基于属性名称从数据源检索。

在“绑定值”字段中指 定的属性名 ，必须包括完整的绑定路径，直到用户的属性名。 打开以下URL以访问CRXDE上的用户详细信息：

https://[server-name]:[port]/crx/de/index.jsp#/home/users/

在此示例中，在 profile.empid 用户 的“绑定值 ”字段中 grios 指定。

该 id 参数使用用户用户档案 empid 的属性的值，并将它作为参数传递给读取服务。 它从员工数据模型对象中读取并返回与登录用户关 empid 联的相关属性值。

请求属性

使用request属性从数据源检索关联的属性。

1. 从“ 绑定到 ” 下拉菜单中选择 “请求属性”，并在“绑定值”字段 中输入属性名 。

2. 为head .jsp创建叠加。 要创建叠加，请打开CRX DE并将文 https://<server-name>:<port number>/crx/de/index.jsp#/libs/fd/af/components/page2/afStaticTemplatePage/head.jsp 件复制到 https://<server-name>:<port number>/crx/de/index.jsp#/apps/fd/af/components/page2/afStaticTemplatePage/head.jsp

   注意

   • 如果使用静态模板，请在以下位置叠加head.jsp:
     /libs/fd/af/components/page2/afStaticTemplatePage/head.jsp
   • 如果使用可编辑的模板，请在以下位置叠加aftemplatedpage.jsp:
     /libs/fd/af/components/page2/aftemplatedpage/aftemplatedpage.jsp

3. 设置 paramMap 请求属性。 例如，在apps文件夹的。jsp文件中包含以下代码：

   <%Map paraMap = new HashMap();
    paraMap.put("<request_attribute>",request.getParameter("<request_attribute>"));
    request.setAttribute("paramMap",paraMap);
   

   例如，使用以下代码从数据源检索petid的值：

   <%Map paraMap = new HashMap();
   paraMap.put("petId",request.getParameter("petId"));
   request.setAttribute("paramMap",paraMap);%>
   

根据在请求中指定的属性名称从数据源检索详细信息。

例如，在请求中指 petid=100 定属性会从数据源检索与属性值关联的属性。

添加关联

通常，在数据源中的数据模型对象之间构建关联。 关联可以是一对一或一对多。 例如，可以有多个与某个员工关联的依赖项。 它称为一对多关联，由连接相关数据模 1:n 型对象的线上描述。 但是，如果关联为给定的员工ID返回唯一的员工名称，则它称为一对一关联。

在数据源中向表单数据模型添加关联数据模型对象时，它们的关联会保留并显示为通过箭头线连接。 您可以在表单数据模型中跨不同数据源添加数据模型对象之间的关联。

添加关联：

1. 选中数据模型对象顶部的复选框以将其选中，然后点按添加 关联。 此时将打开添加关联对话框。

   

   注意

   除了数据模型对象和服务外，OData服务元数据文档还包括定义两个数据模型对象之间的关联的导航属性。 在表单数据模型中添加关联时，可以使用这些导航属性。 有关详细信息，请 参阅使用OData服务的导航属性。

   此时将打开添加关联对话框。

   

   “添加关联”对话框

2. 在“添加关联”窗格中：

   • 指定关联的标题。
   • 选择关联类型——一到一或一到多。
   • 选择要关联的数据模型对象。
   • 选择读取服务以从选定的模型对象读取数据。 将显示读取服务参数。 编辑以根据需要更改参数，并将其绑定到要关联的数据模型对象的属性。

   在以下示例中，Dependents数据模型对象的读取服务的默认参数为 dependentid。

   

   依赖项读取服务的默认参数是dependentid

   但是，参数必须是关联数据模型对象之间的公用属性，本例中为 Employeeid。 因此，该参 Employeeid 数必须绑定到Employee数据模 id 型对象的属性，才能从Dependents数据模型对象中获取关联的依赖项详细信息。

   

   更新了参数和绑定

   点按 完成 ，以保存参数。

3. 点按 完成 以保存关联，然后 点按保 存以保存表单数据模型。

4. 重复这些步骤以根据需要创建更多关联。

编辑属性

您可以编辑数据模型对象的属性、其属性以及在表单数据模型中添加的服务。

要编辑属性，请执行以下操作：

1. 选中表单数据模型中数据模型对象、属性或服务旁的复选框。

2. 点按 编辑属性。 此时 将打开选定 模型对象、属性或服务的“编辑属性”(Edit Properties)窗格。

   • 数据模型对象:指定读写服务和编辑参数。
   • 属性:指定属性的类型、子类型和格式。 您还可以指定选定属性是否是数据模型对象的主键。
   • 服务:指定服务的输入模型对象、输出类型和参数。 对于Get服务，您可以指定它是否应返回阵列。

   

   获取服务的“编辑属性”对话框

3. 点按 完成 以保存属性，然后 点按保 存以保存表单数据模型。

创建计算属性

计算属性是根据规则或表达式计算其值的属性。 使用规则，您可以将计算属性的值设置为文本字符串、数字、数学表达式的结果或表单数据模型中其他属性的值。

例如，可以创建计算属 性FullName ，其值是现有FirstName和LastName属性 串联 的 结 果。 为此，请执行以下操作：

1. 创建一个数据类型为“字符 FullName 串”的名称的新属性。

2. 启用 计算 ，然后 点按完 成，以创建属性。

   

   将创建FullName计算属性。 请注意属性旁边的图标以描述计算属性。

   

3. 选择FullName属性并点按编 辑规则。 将打开规则编辑器窗口。

4. 在规则编辑器窗口中，点按 创建。 “设 置值 ”规则窗口打开。

   从选择选项下拉框中，选择数学 表达式。 其他可用选项 包括表单数据模型对象 和 字符串。

5. 在数学表达式中， 分别选 择第 一个和第 二个对象中的FirstName和LastName。 选择 加号 作为运算符。

   点按 完成 ，然后点 按关闭 ，以关闭规则编辑器窗口。 该规则类似于以下内容。

   

6. 在表单数据模型上，点按保 存。 已配置计算属性。

使用OData服务的导航属性

在OData服务中，导航属性用于定义两个数据模型对象之间的关联。 这些属性是在实体类型或复杂类型上定义的。 例如，在从示例TripPin OData示例服务的元数据文 件中提取 ，人物实体包含三个导航属性：好友、好友和旅行。

有关导航属性的详细信息，请参 阅OData文档。

<edmx:Edmx xmlns:edmx="https://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
<script/>
<edmx:DataServices>
<Schema xmlns="https://docs.oasis-open.org/odata/ns/edm" Namespace="Microsoft.OData.Service.Sample.TrippinInMemory.Models">
<EntityType Name="Person">
<Key>
<PropertyRef Name="UserName"/>
</Key>
<Property Name="UserName" Type="Edm.String" Nullable="false"/>
<Property Name="FirstName" Type="Edm.String" Nullable="false"/>
<Property Name="LastName" Type="Edm.String"/>
<Property Name="MiddleName" Type="Edm.String"/>
<Property Name="Gender" Type="Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender" Nullable="false"/>
<Property Name="Age" Type="Edm.Int64"/>
<Property Name="Emails" Type="Collection(Edm.String)"/>
<Property Name="AddressInfo" Type="Collection(Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location)"/>
<Property Name="HomeAddress" Type="Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location"/>
<Property Name="FavoriteFeature" Type="Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature" Nullable="false"/>
<Property Name="Features" Type="Collection(Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature)" Nullable="false"/>
<NavigationProperty Name="Friends" Type="Collection(Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person)"/>
<NavigationProperty Name="BestFriend" Type="Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"/>
<NavigationProperty Name="Trips" Type="Collection(Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip)"/>
</EntityType>

在表单容器模型中配置OData服务时，实体数据中的所有导航属性都可以通过表单数据模型中的服务提供。 在此TripPin OData服务示例中，可以使用表单容器模型中的 Person 一个服务读取实体 GET LINK 中的三个导航属性。

下面将重点 GET LINK of Person /People 介绍表单数据模型中的服务，它是TripPin OData服务实体中三个导航属 Person 性的组合服务。

将服务添 GET LINK 加到表单数据模型中的“服务”选项卡后，您可以编辑属性以选择要在服务中使用的输出模型对象和导航属性。 例如，以下示例 GET LINK of Person /People 中的以下服务将Trip用作输出模型对象，将导航属性用作Trips。

在此示例中，您还可以选择输出模型对象作为Person，选择导航属性参数作为Friends还是BestFriend(取决于 Return数组？ 启用或禁用)。

同样，在表单数据模型 GET LINK 中添加关联时，您可以选择服务并配置其导航属性。 但是，要能够选择导航属性，请确保将“ 绑定到 ”字段设 置为Literal。

生成和编辑示例数据

表单数据模型编辑器允许您为表单数据模型中的所有数据模型对象属性（包括计算属性）生成示例数据。 它是一组随机值，它们符合为每个属性配置的数据类型。 您还可以编辑和保存数据，即使重新生成示例数据，数据也会保留。

执行以下操作以生成和编辑示例数据：

1. 打开表单数据模型并点按编 辑示例数据。 它会在“编辑示例数据”窗口中生成并显示示例数据。

   

2. 在“ 编辑示例数据 ”窗口中，根据需要编辑数据，然后点按 保存。

接下来，您可以使用范例数据基于表单数据模型预填和测试交互式通信。 有关详细信息，请参 阅使用表单数据模型。

测试数据模型对象和服务

您的表单数据模型已配置，但在投入使用之前，您可能希望测试配置的数据模型对象和服务是否按预期工作。 要测试数据模型对象和服务：

1. 以表单数据模型选择数据模型对象或服务，并分 别点按测试模型​对象或测​试服务。

   “测试表单数据模型”窗口将打开。

   

2. 在“测试表单数据模型”窗口中，从“输入”窗格中选择要测试的数据模型对象或服务。

3. 在测试代码中指定参数值，然后点按 测试。 成功的测试将返回“输出”窗格中的输出。

   

同样，您还可以测试表单数据模型中的其他数据模型对象和服务。

输入数据的自动验证

表单数据模型验证在调用DermisBridge API时作为输入接收的数据（基于表单数据模型中可用的验证标准）。 验证基于查询对 ValidationOptions 象中设置的用于调用API的标志。

该标志可以设置为以下任意值：

• 完整:FDM根据所有约束执行验证
• 关闭:无验证
• 基本:FDM根据“必需”和“可为空”约束执行验证

如果未为标志设置任何 ValidationOptions值， 则对输入数 据执行BASIC验证。

以下是将验证标志设置为FULL的 示例:

operationOptions.setValidationOptions(ValidationOptions.FULL);

表单数据模型基于列表类型约束验证输入数据。 输入数据约束的列表可能因数据源而异。

下表列表了基于数据源的输入数据的约束：

约束	描述	输入数据源
必需	如果为true，则该参数必须包含在输入数据中。	Swagger、WSDL和数据库
可为	如果为true，则输入数据中的参数值可设置为Null。	WSDL、Odata和数据库
最大值	指定数值的上界。 指定为上界的最大值也可以分配给输入数据中的参数。	Swagger和WSDL
最小	指定数值的下限。 指定为下限的最小值也可以分配给输入数据中的参数。	Swagger和WSDL
exclusiveMaximum	指定数值的上界。 指定为上限的最大值不能分配给输入数据中的参数。	Swagger和WSDL
exclusiveMinimum	指定数值的下限。 指定为下限的最小值不能分配给输入数据中的参数。	Swagger和WSDL
minLength	指定字符串中包含的字符数的下界。 指定为下限的最小值也可以分配给输入数据中的参数。	Swagger和WSDL
maxLength	指定字符串中包含的字符数的上界。 指定为上界的最大值也可以分配给输入数据中的参数。	Swagger、WSDL、Odata和数据库
图案	指定固定的字符序列。 仅当字符符合指定模式时，才成功验证输入字符串。	斯瓦格
minItems	指定数组中最小项数。 指定为下限的最小值也可以分配给输入数据中的参数。	Swagger和WSDL
maxItems	指定数组中最大项数。 指定为上界的最大值也可以分配给输入数据中的参数。	Swagger和WSDL
uniqueItems	如果为true，则该数组的所有元素在输入数据中必须是唯一的。	斯瓦格
枚举（字符串）	将输入数据中参数的值限制为固定字符串值集。 它必须是至少具有一个元素的数组，其中每个元素都是唯一的。	Swagger、WSDL和Odata
枚举（数字）	将输入数据中参数的值限制为一组固定的数字值。 它必须是至少具有一个元素的数组，其中每个元素都是唯一的。	WSDL

在此示例中，根据Swagger文件中定义的最大、最小和必需约束验证输入数据。 仅当订单ID存在且其值介于1和10之间时，输入数据才符合验证标准。

   parameters: [
   {
   name: "orderId",
   in: "path",
   description: "ID of pet that needs to be fetched",
   required: true,
   type: "integer",
   maximum: 10,
   minimum: 1,
   format: "int64"
   }
   ]

如果输入数据不符合验证条件，则显示异常。 如果日志级别设置为 Debug，则错误将记录 到error.log 文件。 例如，

21.01.2019 17:26:37.411 *ERROR* com.adobe.aem.dermis.core.validation.JsonSchemaValidator {"errorCode":"AEM-FDM-001-044","errorMessage":"Input validations failed during operation execution.","violations":{"/orderId":["numeric instance is greater than the required maximum (maximum: 10, found: 16)"]}}

后续步骤

您有一个工作表单数据模型，现在可以在自适应表单和交互式通信工作流中使用。 有关详细信息，请参 阅使用表单数据模型。