文档AEM as a Cloud Service用户指南

处理表单数据模型 work-with-form-data-model

Last update: Thu Mar 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • Beginner
  • Intermediate
  • Admin
  • User
版本
文章链接
AEM 6.5
单击此处
AEM as a Cloud Service
本文

数据集成

表单数据模型编辑器提供了直观的用户界面和用于编辑和配置表单数据模型的工具。 使用该编辑器，您可以从表单数据模型中的关联数据源添加和配置数据模型对象、属性和服务。 此外，它还允许您在不使用数据源的情况下创建数据模型对象和属性，并在以后将它们与各自的数据模型对象和属性绑定。 您还可以生成和编辑可用于预填充自适应Forms的数据模型对象属性的示例数据 在预览时。 您可以测试在表单数据模型中配置的数据模型对象和服务，以确保其与数据源正确集成。

如果您是初次使用Forms数据集成，并且尚未配置数据源或创建表单数据模型，请参阅以下主题：

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

NOTE
您必须同时是这两个角色的成员 fdm-author 和 forms-user 组才能创建和使用表单数据模型。 联系 Experience Manager 管理员以成为组的成员。

添加数据模型对象和服务 add-data-model-objects-and-services

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

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

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

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

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

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

    选定对象

    选定的数据模型对象和服务

    此 模型 选项卡以图形形式显示添加到表单数据模型的所有数据模型对象及其属性。 每个数据模型对象在表单数据模型中都由一个框表示。

    model-tab

    模型 选项卡显示添加的数据模型对象

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

    此 服务 选项卡列出了已添加的服务。

    “服务”选项卡

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

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

  4. 选择 保存 以保存表单模型对象。

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

创建数据模型对象和子属性 create-data-model-objects-and-child-properties

创建数据模型对象 create-data-model-objects

虽然可以从配置的数据源添加数据模型对象，但也可以创建没有数据源的数据模型对象或实体。 如果您尚未在表单数据模型中配置数据源，则此功能尤为有用。

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

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

  2. 选择 创建实体.

  3. 在 创建数据模型 对话框，指定数据模型对象的名称，然后选择 添加. 数据模型对象将添加到表单数据模型。 新添加的数据模型对象未绑定到数据源，并且不具有下图中所示的任何属性。

    new-entity

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

添加子属性 child-properties

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

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

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

  2. 在 创建子属性 对话框，请在 名称 和 类型 字段。 您可以选择为属性指定标题和描述。

  3. 如果属性是计算属性，则启用计算属性。 计算属性的值是根据规则或表达式计算的。 有关更多信息，请参阅 编辑属性.

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

    要手动将子属性与数据模型对象属性绑定，请选择 绑定引用 字段。 此 选择对象 对话框列出了父数据模型对象的所有属性。 选择要绑定的属性，然后选择勾号图标。 您只能选择与子属性具有相同数据类型的属性。

  5. 选择 完成 保存子属性并选择 保存 以保存表单数据模型。 现在，子属性已添加到数据模型对象中。

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

绑定数据模型对象和属性 bind-data-model-objects-and-properties

当要与表单数据模型集成的数据源可用时，可将其添加到表单数据模型，如中所述 更新数据源. 然后，执行以下操作以绑定未绑定的数据模型对象和属性：

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

  2. 选择​ 编辑属性。

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

    选择对象

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

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

    绑定模型对象

配置服务 configure-services

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

  1. 选中数据模型对象顶部的复选框以将其选中并选择 编辑属性.

    edit-properties

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

    此 编辑属性 对话框打开。

    edit-properties-2

    “编辑属性”对话框

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

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

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

  3. 为选定的数据模型对象选择读取和写入服务。 将显示服务的参数。

    读写服务

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

  4. 选择 aem_6_3_edit 将读取服务参数设置为 将参数绑定到用户配置文件属性、请求属性或文本值 和指定绑定值。

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

绑定读取服务参数 bindargument

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

文本值 literal-value

选择 文本 从 绑定到 下拉菜单，然后在 捆绑值 字段。 从数据源中检索与值关联的详细信息。 使用此选项可检索与静态值关联的详细信息。

在此示例中，与 4367655678，作为的值 mobilenum 参数)进行检索。 如果传递手机号码参数的值，则关联的详细信息可以包括客户名称、客户地址和城市等属性。

文本值

用户配置文件属性 user-profile-attribute

选择 用户配置文件属性 从 绑定到 下拉菜单，然后在 捆绑值 字段。 已登录用户的详细信息 Experience Manager 实例根据属性名称从数据源中检索。

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

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

用户配置文件

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

编辑参数

此 id 参数采用 empid 用户配置文件的属性，并将其作为参数传递给读取服务。 它会从员工数据模型对象读取并返回关联属性的值， empid 与登录用户相关联。

请求属性 request-attribute

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

  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

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

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

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

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

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

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

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

添加关联 add-associations

通常，数据源中的数据模型对象之间会建立关联。 关联可以是一对一或一对多。 例如，可以有多个与员工关联的家属。 它称为一对多关联，由以下内容描述 1:n 在连接关联的数据模型对象的行上。 但是，如果关联为给定员工ID返回唯一的员工姓名，则称为一对一关联。

当您将数据源中的关联数据模型对象添加到表单数据模型时，它们的关联将保留并以箭头线连接的方式显示。 您可以在表单数据模型中跨不同数据源的数据模型对象之间添加关联。

NOTE
JDBC数据源中的预定义关联不会保留在表单数据模型中。 您必须手动创建它们。

要添加关联，请执行以下操作：

  1. 选中数据模型对象顶部的复选框以将其选中并选择 添加关联. 将打开“添加关联”对话框。

    添加关联

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

    此 添加关联 对话框打开。

    add-association-2

    “添加关联”对话框

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

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

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

    add-association-example

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

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

    add-association-example-2

    已更新参数和绑定

    选择 完成 以保存参数。

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

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

NOTE
所添加的关联将显示在数据模型对象框中，其中包含指定的标题和连接关联的数据模型对象的线。
通过选中关联旁边的复选框并选择 编辑关联.

添加关联

编辑属性 properties

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

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

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

  2. 选择 编辑属性. 此 编辑属性 此时将打开选定模型对象、属性或服务的窗格。

    • 数据模型对象：指定读取和写入服务以及编辑参数。

    • 属性：指定属性的类型、子类型和格式。 您还可以指定selected属性是否为数据模型对象的主键。

    • 服务：指定服务的输入模型对象、输出类型和参数。 对于Get服务，您可以指定它是否应返回数组。

      edit-properties-service

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

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

创建计算属性 computed

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

例如，您可以创建一个计算属性 全名 其值是现有串连的结果 名字 和 姓氏 属性。 为此，请执行以下操作：

  1. 使用名称创建新属性 FullName 数据类型为字符串的数据。

  2. 启用 已计算 并选择 完成 以创建资产。

    已计算

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

    计算属性

  3. 选择FullName属性并选择 编辑规则. 此时将打开一个规则编辑器窗口。

  4. 在规则编辑器窗口中，选择 创建. A 设置值 规则窗口将打开。

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

  5. 在数学表达式中，选择 名字 和 姓氏 分别在第一和第二对象中。 选择 加 作为运算符。

    选择 完成 然后选择 关闭 以关闭规则编辑器窗口。 该规则与以下内容类似。

    规则

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

使用OData服务的导航属性 work-with-navigation-properties-of-odata-services

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

有关导航属性的更多信息，请参阅 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 表单数据模型中的服务，它是三个导航属性的组合服务。 Person TripPin OData服务的实体。

nav-prop-service

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

edit-prop-nav-prop

NOTE
中可用的值 默认值 字段 NavigationPropertyName 参数取决于 返回数组？ 切换按钮。 启用后，它将显示收藏集类型的导航属性。

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

edit-prop-nav-prop2

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

add-association-nav-prop

生成和编辑示例数据 sample

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

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

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

    生成示例数据

  2. 在 编辑示例数据 窗口，根据需要编辑数据，然后选择 保存.

测试数据模型对象和服务 test-data-model-objects-and-services

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

  1. 在表单数据模型中选择数据模型对象或服务，然后选择 测试模型对象 或 测试服务、ID名称和ID名称等。

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

    test-data-model

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

  3. 在测试代码中指定一个参数值，然后选择 测试. 成功的测试会在“输出”窗格中返回输出。

    测试结果

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

自动验证输入数据 automated-validation-of-input-data

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

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

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

如果没有为 ValidationOptions标志， 基本 对输入数据进行验证。

以下是将验证标志设置为 完整：

operationOptions.setValidationOptions(ValidationOptions.FULL);
NOTE
为输入数据中的属性提供的值必须与为元数据文档中的属性定义的数据类型匹配。
如果值与为属性定义的数据类型不匹配，则DermisBridge API将显示异常，而不管的 ValidationOptions 标志。 如果日志级别设置为Debug ，则会将错误记录到 error.log 文件。

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

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

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

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

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

如果输入数据不符合验证标准，则显示例外。 如果日志级别设置为 调试，则会将错误记录到 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)"]}}

后续步骤 next-steps

您有一个工作表单数据模型，现在可以在自适应Forms中使用 工作流。 有关更多信息，请参阅 使用表单数据模型.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab