通用交互式USA数据映射组件
概述
通用交互式USA数据映射是可重复使用的Adobe Experience Manager (AEM) Sites组件,主要用于按美国州显示AEM自适应表单提交。
此组件以交互方式呈现表单提交活动,让用户能够了解美国各地提交的表单分布情况,识别提交量较高的州,并查看州级别的提交计数。
尽管其主要用例显示表单提交,但组件是独立于数据源的,并且可以可视化其他基于状态的业务量度,如销售、客户分发和服务请求。
内容作者可以通过AEM组件对话框配置兼容的REST API端点,而无需修改组件的JavaScript或后端实施。
组件使用 D3.js和TopoJSON 来呈现交互式USA映射,并根据配置的REST API返回的值动态着色状态。
主要功能
- 表单提交可视化:显示按美国州汇总的AEM自适应表单提交计数。
- 交互式地理地图:根据提交量为各个状态着色。
- 状态选择:允许用户单击状态以查看其名称、状态代码和提交计数。
- 摘要统计信息:显示提交总数、所呈现的状态数以及提交量最高的状态。
- 可配置的REST数据源:支持托管在Azure、Render、AWS或其他平台上的兼容REST API。
- 数据源独立性:不需要特定的数据库或后端技术。
- 可配置的JSON字段映射:允许作者指定表示状态代码和数值的JSON属性。
- 可自定义的演示文稿:支持可配置的映射标题、量度标签、摘要统计信息和工具提示。
- 响应式设计:可适应不同的屏幕大小。
- 键盘辅助功能:支持基于键盘的状态选择。
主要用例 — 按州列出的AEM Forms提交
该组件通常用作 AEM Forms功能板 的一部分,用于可视化自适应表单提交的地理分布。
当用户提交自适应表单时,提交数据存储在后端系统中,如Azure SQL数据库。
REST API可按状态检索和聚合提交内容,并返回组件应采用JSON格式的结果。
美国地图会使用此API响应并在地理位置显示提交计数。
示例
如果组织收到来自加利福尼亚、得克萨斯和纽约的提交内容,则地图会根据收到的提交内容数量突出显示这些州。
用户可以与映射交互以查看与每个状态关联的提交计数。
这提供了一种可视化的方法来监控表单提交活动并识别地理趋势。
REST API数据合同
该组件需要HTTP GET端点,以返回JSON格式的聚合状态级别数据。
示例响应:
{
"states": [
{ "state": "CA", "count": 150 },
{ "state": "TX", "count": 95 },
{ "state": "NY", "count": 70 }
]
}
每个记录表示一个美国状态及其对应的提交计数。
状态和值字段的名称可通过AEM创作对话框配置。
例如,可以通过映射组件配置中的这些字段来支持返回stateCode和totalSubmissions的REST API。
后端REST API负责检索、聚合表单提交数据,并将其格式化为预期的状态级别JSON结构。 该组件不会查询数据库或聚合单个提交。
AEM创作配置
该组件提供了一个包含以下配置选项的AEM Touch UI对话框:
安全配置字段不会单独强制执行访问控制。 受保护的端点必须实施自己的身份验证和授权。
数据源集成
该组件支持两种REST集成模式。
直接REST API集成
该组件直接从浏览器调用兼容的REST API。
端点必须支持HTTPS、相应的CORS配置和任何适用的内容安全策略要求。
受保护的REST API集成
对于需要API密钥或身份验证的后端服务,组件可以调用AEM Sling Servlet或其他安全后端代理。
这可以确保敏感凭据保留在服务器端。
经验证的实施
AEM Forms提交仪表板
该组件已经实施,以显示存储在Azure SQL数据库中的自适应表单提交计数。
该集成使用AEM自适应Forms、Azure函数、Azure SQL和AEM Sling Servlet来检索状态级提交计数。
外部REST API集成
该组件还使用在渲染器上托管的Node.js REST API进行了测试,返回了按美国州划分的示例销售数据。
这表明该组件可以可视化来自不同后端系统的数据,而无需更改其渲染逻辑。
技术栈栈
- Adobe Experience Manager as a Cloud Service
- AEM HTL和Granite UI
- JavaScript和SCSS
- D3.js和TopoJSON
- Webpack和AEM客户端库
- JSON REST API
可复用性
虽然该组件主要用于可视化按状态提交的 AEM Forms,但它也可以显示其他状态级量度,包括销售额、客户分布、营销转化、服务请求和分支活动。
要重用该组件,作者会配置兼容的REST端点和相应的JSON字段映射。
摘要
通用交互式USA数据图为AEM Sites提供可重复使用的地理可视化功能,将AEM自适应表单提交监控作为其主要用例。
它使组织能够可视化美国各州的表单提交量,识别地理趋势,并交互浏览州级别的提交计数。
其独立于数据源的架构也使其适用于其他业务报告场景,前提是配置的REST API返回兼容的状态级JSON数据。