扩展默认元模型 extend-the-default-meta-model
automated forms conversion服务识别源表单中的表单对象并将其从中提取。 语义映射器可帮助服务确定提取的对象如何以自适应形式表示。 例如,源表单可以有许多不同类型的日期表示形式。 语义映射器帮助将源表单的日期表单对象的所有表示形式映射到自适应表单的日期组件。 语义映射器还允许该服务在转换期间预配置验证、规则、数据模式、帮助文本和可访问性属性并将其应用于自适应表单组件。
元模型是一个JSON架构。 在开始使用元模型之前,请确保您熟悉JSON。 您必须具有创建、编辑和读取以JSON格式保存的数据的经验。
默认元模型 default-meta-model
automated forms conversion服务具有默认的元模型。 它是一个JSON架构,通过Automated forms conversion服务的其他组件驻留在Adobe云上。 您可在本地AEM服务器上找到元模型的副本,网址为:http://<server>:<port>/aem/forms.html/content/dam/formsanddocuments/metamodel/global.schema.json
. 您还可以 单击此处 访问或下载英语架构。 的元模型 法语, 德语 西班牙语, 意大利语、和 葡萄牙语 语言也可供下载。
元模型的模式源自https://schema.org/docs/schemas.html上的模式实体。 它具有Person、PostalAddress、LocalBusiness和https://schema.org上定义的更多实体。 元模型的每个实体都遵循JSON架构对象类型。 以下代码表示一个元模型结构示例:
"Entity": {
"id": "Entity",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"description": "Description of the item"
}
}
}
下载默认元模型 download-the-default-meta-model
执行以下步骤以将默认元模型下载到本地文件系统:
- 登录到您的AEM Forms实例。
- 导航到 Forms > Forms & Documents > Meta Model 文件夹。
- 选择 global.schema.json 文件并点按 Download. 此时将显示下载对话框。 选择 Download asset(s) as binary files 选项。 点击 Download。已下载存档。
了解元模型 understanding-the-meta-model
元模型是指包含实体的JSON架构文件。 JSON架构文件中的所有实体都包含名称和ID。 每个实体可以包含多个属性。 图元及其属性可因域而异。 您可以使用关键字和字段配置来扩充架构文件,以将架构属性映射到自适应表单组件。
"Event": {
"id": "Eventid",
"allOf": [
{
"$ref": "#Entity"
},
{
"properties": {
"startDate": {
"type": "string",
"format": "date",
"description": "Specify the start date and time of the event in ISO 8601 date format."
},
"endDate": {
"type": "string",
"format": "date",
"description": "Specify the end date and time of the event in ISO 8601 date format."
},
"location": {
"$ref": "#PostalAddress",
"description": "Specify the location of the event."
}
}
}
]
}
在此示例中, 事件 表示实体的名称,其值为 id 作为 Eventid. 事件实体包括多个属性:
- startDate
- endDate
- 位置
此 allOf 元模型中的构造实现了实体间的继承。
每个属性还可以包括:
基于使用的引用关键词 aem:affKeyword,转换服务对源表单字段执行搜索操作。 转换服务将JSON架构属性和其他属性应用于符合搜索条件的字段。
在此示例中,转换服务在源表单中搜索电话、电话、移动电话、工作电话、家庭电话、电话号码、电话号码和电话号码关键字。 转换服务会根据包含这些关键字的字段,在转换后将类型、模式和aem:afProperties应用于自适应表单字段。
生成的自适应表单字段的JSON架构属性 jsonschemaproperties
元模型支持使用Automated forms conversion服务生成的自适应表单字段的以下JSON架构通用属性:
基于关键字的搜索,用于将属性应用于生成的自适应表单字段 keywordsearch
automated forms conversion服务在转换期间对源表单执行关键词搜索。 筛选满足搜索条件的字段后,转换服务将为元模型中的这些字段定义的属性应用于生成的自适应表单字段。
关键字的引用方式 aem:affKeyword 属性。
{
"numberfields": {
"type": "number",
"aem:affKeyword": ["Bank account number"]
}
}
在此示例中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 银行帐号 文本,转换服务会将字段转换为 数字 使用键入 type 属性。
生成的自适应表单字段的其他属性 additionalproperties
您可以使用 aem:afProperties 元模型中的属性,以便为使用Automated forms conversion服务生成的自适应表单字段定义以下附加属性:
用您自己的语言创建自定义元模型 language-specific-meta-model
您可以创建特定于语言的元模型。 此类元模型可帮助您使用所选语言创建映射规则。 automated forms conversion服务允许您使用以下语言创建元模型:
- 英语(en)
- 法语 (fr)
- 德语 (de)
- 西班牙语 (es)
- 意大利语 (it)
- 葡萄牙语(pt-br)
添加 aem:Language 元模型顶部的metatag标记可指定其语言。 例如,
"metaTags": {
"aem:Language": "fr"
}
当未指定语言时,服务会认为元模型是英语的。
创建语言特定元模型的注意事项
-
确保每个键的名称都使用英语。 例如,emailAddress。
-
确保所有id键的所有实体引用和预定义值只包含ASCII字符。 例如,“id”:“ContactPoint”/“$ref”:“#ContactPoint”。
-
确保与以下键对应的所有值都使用指定的元模型语言:
- aem:affKeyword
- 标题
- 说明
- enumName
- shortdescription
- validatePictureClauseMessage
例如,当元模型的语言是法语(“aem:Language”:“fr”)时,请确保所有描述和消息都使用法语。
-
确保全部 JSON架构属性 仅使用支持的值。 例如,type属性只能跨选定的String、Number、Integer和Boolean值。
下图显示了英语元模型和相应的法语元模型的示例:
使用自定义元模型修改自适应表单字段 modify-adaptive-form-fields-using-custom-meta-model
除了默认元模型中列出的模式和验证之外,您的组织还可以具有这些模式和验证。 可以扩展缺省元模型,以添加特定于贵组织的阵列、验证和图元。 automated forms conversion服务在转换期间将自定义元模型应用于表单字段。 当发现特定于您组织的新模式、验证和图元时,可以不断更新元模型。
automated forms conversion服务使用保存在以下位置的默认元模型,在转换期间将源表单字段映射到自适应表单字段:
http://<server>:<port>/aem/forms.html/content/dam/formsanddocuments/metamodel/global.schema.json
但是,您可以将自定义元模型保存在文件夹中,并修改转换服务属性以在转换期间使用自定义元模型。
在转换期间使用自定义元模型 use-custom-meta-model-during-conversion
执行以下步骤以在转换期间使用自定义元模型:
-
在中创建文件夹 Forms > Forms & Documents 并将自定义元模型JSON架构文件上传到文件夹。
-
使用以下方式打开转换服务属性:
Tools > Cloud Services > Automated Forms Conversion Configuration > <properties of="" selected="" configuration="">
-
在 Basic 选项卡中,指定自定义元模型在 Custom Meta-model 字段并点按 Save & Close.
-
运行转换 将自定义元模型应用于转换过程。
自定义元模型示例 custommetamodelexamples
使用自定义元模型修改自适应表单字段属性的常见示例包括:
- 修改表单字段的标签
- 修改表单字段的类型
- 将帮助文本添加到表单字段
- 将表单字段转换为自适应表单中的多选单选按钮
- 修改表单字段的格式
- 向自适应表单字段添加验证
- 将表单字段转换为自适应表单中的下拉列表选项
- 向下拉列表添加其他选项
- 将字符串字段转换为多行字段
修改表单字段的标签 modify-the-label-of-a-form-field
示例: 在转换后,将表单中的银行帐号标签修改为自适应表单中的自定义帐号。
在此自定义元模型中,转换服务使用 标题 属性作为搜索关键词。 检索 银行帐号 文本,转换服务会将该文本替换为 客户帐号 字符串中提及了 jcr:title 中的属性 aem:afProperties 部分。
{
"numberfields": {
"type": "number",
"title": "Bank account number",
"aem:afProperties" : {
"jcr:title" : "Customer account number"
}
}
}
修改表单字段的类型 modify-the-type-of-a-form-field
示例:修改 银行帐号 表单中文本类型的字段,在转换为自适应表单中的数字类型字段之前,在转换之后。
在此自定义元模型中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 银行帐号 文本,转换服务将使用以下代码将字段转换为数字类型 type 属性。
{
"numberfields": {
"type": "number",
"aem:affKeyword": ["Bank account number"]
}
}
将帮助文本添加到表单字段 add-help-text-to-a-form-field
示例:将帮助文本添加到 银行帐号 自适应表单的字段。
在此自定义元模型中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 银行帐号 文本,转换服务使用将帮助文本添加到自适应表单字段 描述 属性。
{
"numberfields": {
"type": "number",
"aem:affKeyword": ["Bank account number"],
"description": "Specify your bank account number."
}
}
将表单字段转换为自适应表单中的多选复选框 convert-a-form-field-to-multiple-choice-check-boxes-in-the-adaptive-form
示例:转换 国家/地区 表单中字符串类型的字段,转换为自适应表单中的复选框。
在此自定义元模型中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 国家/地区 文本时,转换服务会使用将字段转换为以下复选框 枚举 属性:
- 印度
- 英国
- 澳大利亚
- 新西兰
sling:resourceType 和 guideNodeClass 属性将表单字段映射到自适应表单组件复选框。
{
"title": {
"aem:affKeyword": [
"country"
],
"type" : "string",
"enum": [
"India",
"England",
"Australia",
"New Zealand"
],
"aem:afProperties": {
"sling:resourceType": "fd/af/components/guidecheckbox",
"guideNodeClass": "guidecheckbox"
}
}
}
修改表单字段的格式 modify-the-format-of-a-form-field
示例:修改格式 电子邮件地址 字段转换为电子邮件格式。
在此自定义元模型中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 电子邮件地址 文本,转换服务使用将字段转换为电子邮件格式 格式 属性。
{
"additionalDetails" : {
"aem:affKeyword": ["E-mail Address"],
"type" : "string",
"format" : "email"
}
}
向自适应表单字段添加验证 add-validations-to-adaptive-form-fields
示例1: 将验证添加到 邮政编码 自适应表单的字段。
在此自定义元模型中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 邮政编码 文本,转换服务将使用以下内容向字段添加验证 validatePictureClause 在中定义的属性 aem:afProperties 部分。 根据验证,您为 邮政编码 自适应表单中的字段在转换后必须包含六个字符。
{
"postalCode" : {
"aem:affKeyword": ["Postal Code"],
"type" : "string",
"aem:afProperties" : {
"validatePictureClause" : "\\d{6}"
}
}
}
示例2: 将验证添加到 银行帐号 自适应表单的字段。
在此自定义元模型中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 银行帐号 文本,转换服务将使用以下内容向字段添加验证 必需 在中定义的属性 aem:afProperties 部分。 根据验证,必须为 银行帐号 字段。
{
"numberfields": {
"type": "number",
"aem:affKeyword": ["Bank account number"],
"aem:afProperties" : {
"mandatory": "true"
}
}
}
将文本字段转换为自适应表单中的下拉列表 convert-a-text-field-to-drop-down-list-in-the-adaptive-form
示例:转换 国家/地区 表单中字符串类型的字段,在转换为自适应表单中的下拉选项之前,在转换之后。
在此自定义元模型中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 国家/地区 文本时,转换服务会使用将字段转换为以下下拉列表选项 枚举 属性:
- 印度
- 英国
- 澳大利亚
- 新西兰
sling:resourceType 和 guideNodeClass 属性将表单字段映射到下拉自适应表单组件。
{
"title": {
"aem:affKeyword": [
"country"
],
"type" : "string",
"enum": [
"India",
"England",
"Australia",
"New Zealand"
],
"aem:afProperties": {
"sling:resourceType": "fd/af/components/guidedropdownlist",
"guideNodeClass": "guideDropDownlist"
}
}
}
向下拉列表添加其他选项 add-additional-options-to-the-drop-down-list
示例: 添加 斯里兰卡 作为使用自定义元模型的现有下拉列表的额外选项。
要添加额外选项,请更新 枚举 属性。 在此示例中,更新 枚举 属性 斯里兰卡 作为额外选项。 中列出的值 枚举 属性显示在下拉列表中。
{
"title": {
"aem:affKeyword": [
"country"
],
"type" : "string",
"enum": [
"India",
"England",
"Australia",
"New Zealand",
"Sri Lanka"
],
"aem:afProperties": {
"sling:resourceType": "fd/af/components/guidecheckbox",
"guideNodeClass": "guidecheckbox"
}
}
}
将字符串字段转换为多行字段 convert-a-string-field-to-a-multi-line-field
示例: 转换 地址 字符串类型的字段转换为表单中的多行字段。
在此自定义元模型中,转换服务使用中的文本 aem:affKeyword 作为搜索关键词。 检索 地址 文本,该服务将使用以下内容将文本字段转换为多行字段 多行 在中定义的属性 aem:afProperties 部分。
{
"multiLine" : {
"aem:affKeyword": [
"Address"
],
"type" : "string",
"aem:afProperties": {
"multiLine": "true"
}
}
}