配置 ContextHub

上次更新: 2023-12-04

ContextHub是一个用于存储、操作和呈现上下文数据的框架。 有关ContextHub的更多详细信息,请参阅 开发人员文档. ContextHub替换 客户端上下文 在触屏UI中。

配置 ContextHub 工具栏来控制它是否显示在预览模式下、创建ContextHub存储以及使用触屏优化UI添加UI模块。

禁用ContextHub

默认情况下,AEM安装中会启用ContextHub。 可以禁用ContextHub以阻止其加载js/css和初始化。

  • 使用CRXDE Lite设置属性 disabledtrue/libs/settings/cloudsettings/legacy/contexthub
注意

由于AEM 6.4中的存储库重组, ContextHub配置的位置已从 /etc/cloudsettings 至:

  • /libs/settings/cloudsettings
  • /conf/global/settings/cloudsettings
  • /conf/<tenant>/settings/cloudsettings

显示和隐藏ContextHub UI

配置AdobeGranite ContextHub OSGi服务以显示或隐藏 ContextHub UI 页面上。 此服务的PID为 com.adobe.granite.contexthub.impl.ContextHubImpl.

要配置服务,您可以使用 Web控制台 或使用 存储库中的JCR节点

  • Web控制台: 要显示UI,请选择显示UI属性。 要隐藏UI,请清除隐藏UI属性。
  • JCR节点: 要显示UI,请设置布尔值 com.adobe.granite.contexthub.show_ui 属性至 true. 要隐藏UI,请将属性设置为 false.

显示ContextHub UI时,它仅显示在AEM创作实例上的页面上。 UI未出现在发布实例的页面上。

添加ContextHub UI模式和模块

配置在预览模式下显示在ContextHub工具栏中的UI模式和模块:

  • UI模式:相关模块组
  • 模块:从存储中公开上下文数据并使作者能够处理上下文的小部件

UI模式在工具栏左侧显示为一系列图标。 选中后,UI模式的模块将显示在右侧。

chlimage_1-319

图标是来自的引用 Coral UI图标库.

添加UI模式

添加UI模式以分组相关的ContextHub模块。 在创建UI模式时,您需要提供显示在ContextHub工具栏中的标题和图标。

  1. 在Experience Manager边栏中,单击工具>站点>上下文中心。

  2. 单击默认配置容器。

  3. 单击上下文中心配置。

  4. 单击创建按钮,然后单击Context Hub UI模式。

    chlimage_1-320

  5. 提供以下属性的值:

    • 用户界面模式标题:标识用户界面模式的标题
    • 模式图标:的选择器 Coral UI图标 例如, coral-Icon--user
    • 启用:选择此项可在ContextHub工具栏中显示UI模式
  6. 单击“保存”。

添加UI模块

将ContextHub UI模块添加到UI模式,以便该模块显示在ContextHub工具栏中,用于预览页面内容。 添加UI模块时,您将创建一个已在ContextHub中注册的模块类型实例。 要添加UI模块,您必须知道关联模块类型的名称。

AEM提供了一个基本UI模块类型以及多个示例UI模块类型,您可以基于这些类型构建UI模块。 下表提供了每种类型的简要说明。 有关开发自定义UI模块的信息,请参阅 创建ContextHub UI模块.

UI模块属性包括一个详细配置,您可以在其中提供特定于模块的属性的值。 您以JSON格式提供详细配置。 表中的模块类型列提供了指向每个UI模块类型所需JSON代码信息的链接。

模块类型 描述 存储
contexthub.base 通用UI模块类型 在UI模块属性中配置
contexthub.browserinfo 显示有关浏览器的信息 surferinfo
contexthub.datetime 显示日期和时间信息 日期时间
contexthub.device 显示客户端设备 模拟器
contexthub.location 显示客户端的纬度和经度,以及地图上的位置。 允许您更改位置。 地理位置
contexthub.screen-orientation 显示设备的屏幕方向(横向或纵向) 模拟器
contexthub.tagcloud 显示有关页面标记的统计信息 tagcloud
granite.profile 显示当前用户的配置文件信息,包括authorizableID、displayName和familyName。 可以更改displayName和familyName的值。 侧面像
  1. 在Experience Manager边栏中,单击工具>站点> ContextHub。

  2. 单击要向其添加UI模块的配置容器。

  3. 单击或键入要将UI模块添加到其中的ContextHub配置。

  4. 单击要向其中添加UI模块的UI模式。

  5. 单击“创建”按钮,然后单击“ContextHub UI模块(通用)”。

    chlimage_1-321

  6. 提供以下属性的值:

    • 用户界面模块标题:标识用户界面模块的标题
    • 模块类型:模块类型
    • 已启用:选择此选项可在ContextHub工具栏中显示UI模块
  7. (可选)要覆盖默认存储配置,请输入要配置UI模块的JSON对象。

  8. 单击“保存”。

创建ContextHub存储

创建Context Hub存储以保留用户数据并根据需要访问数据。 ContextHub存储基于已注册的存储候选项。 在创建存储时,需要存储候选注册到的storeType的值。 (请参阅 创建自定义商店候选.)

详细存储配置

在配置存储时,细节配置属性允许您提供特定于存储的属性的值。 该值基于 config 商店的参数 init 函数。 因此,是否需要提供此值,以及此值的格式,取决于存储。

“详细信息配置”属性的值为 config JSON格式的对象。

示例存储候选

AEM提供了以下存储候选项示例,您可以根据它们创建存储。

存储类型 描述
aem.segmentation 存储已解析和未解析的ContextHub区段。 自动从ContextHub SegmentManager检索区段
aem.resolvedsegments 存储当前已解析的区段。 侦听ContextHub SegmentManager服务以自动更新存储
contexthub.geolocation 存储浏览器位置的纬度和经度。
contexthub.datetime 存储浏览器位置的当前日期、时间和季节
granite.emulators 为多个设备定义属性和功能,并检测当前的客户端设备
contexthub.generic-jsonp 从JSONP服务检索和存储数据
granite.profile 存储当前用户的配置文件数据
contexthub.surferinfo 存储有关客户端的信息,如设备信息、浏览器类型和窗口方向
contexthub.tagcloud 存储页面标记和标记计数
  1. 在Experience Manager边栏中,单击工具>站点> ContextHub。

  2. 单击默认配置容器。

  3. 单击Contexthub配置

  4. 要添加存储,请单击“创建”图标,然后单击ContexHub存储配置。

    chlimage_1-322

  5. 提供基本配置属性的值,然后单击下一步:

    • 配置标题: 标识存储的标题
    • 存储类型: 作为存储基础的存储候选的storeType属性的值
    • 必需: 选择
    • 已启用: 选择以启用存储
  6. (可选)要覆盖默认存储配置,请在详细信息配置(JSON)框中输入JSON对象。

  7. 单击“保存”。

示例:使用JSONP服务

此示例说明如何在UI模块中配置存储区并显示数据。 在此示例中,jsontest.com站点的MD5服务用作存储的数据源。 该服务以JSON格式返回给定字符串的MD5哈希代码。

contexthub.generic-jsonp存储已配置为存储服务调用的数据 https://md5.jsontest.com/?text=%22text%20to%20md5%22. 该服务会返回以下数据,这些数据显示在UI模块中:

{
   "md5": "919a56ab62b6d5e1219fe1d95248a2c5",
   "original": "\"text to md5\""
}

创建contexthub.generic-jsonp存储

Contexthub.generic-jsonp示例存储候选函数允许您从返回JSON数据的JSONP服务或Web服务中检索数据。 对于此存储候选项,请使用存储配置提供关于要使用的JSONP服务的详细信息。

init 的功能 ContextHub.Store.JSONPStore JavaScript类定义 config 初始化此存储候选的对象。 此 config 对象包含 service 包含有关JSONP服务的详细信息的对象。 要配置存储,您需要提供 service JSON格式的对象,作为详细信息配置属性的值。

要保存来自jsontest.com站点的MD5服务的数据,请按照 创建ContextHub存储 使用以下属性:

  • 配置标题: md5

  • 存储类型: contexthub.generic-jsonp

  • 必需: 选择

  • 已启用: 选择

  • 详细信息配置(JSON):

    {
     "service": {
     "jsonp": false,
     "timeout": 1000,
     "ttl": 1800000,
     "secure": false,
     "host": "md5.jsontest.com",
     "port": 80,
     "params":{
     "text":"text to md5"
         }
       }
     }
    

为md5数据添加UI模块

将UI模块添加到ContextHub工具栏,以显示存储在示例md5存储中的数据。 在此示例中,contexthub.base模块用于生成以下UI模块:

chlimage_1-323

请按照中的过程操作 添加UI模块 将UI模块添加到现有UI模式,如示例Perona UI模式。 对于UI模块,请使用以下属性值:

  • UI模块标题: MD5

  • 模块类型: contexthub.base

  • 详细信息配置(JSON):

    {
     "icon": "coral-Icon--data",
     "title": "MD5 Converstion",
     "storeMapping": { "md5": "md5" },
     "template": "<p> {{md5.original}}</p>;
                  <p>{{md5.md5}}</p>"
    }
    

调试Contexthub

可以启用ContextHub的调试模式以进行疑难解答。 调试模式可通过ContextHub配置或CRXDE启用。

通过配置

编辑ContextHub的配置并选中选项 调试

  1. 在边栏中,单击 工具>站点> ContextHub
  2. 单击默认值 配置容器
  3. 选择 ContextHub配置 并单击 编辑选定的元素
  4. 单击 调试 并单击 保存

通过CRXDE

使用CRXDE Lite设置属性 debugtrue 在:

  • /conf/global/settings/cloudsettings
  • /conf/<tenant>/settings/cloudsettings
注意

对于ContextHub配置,如果仍然位于其旧路径下,则位置设置 debug property/libs/settings/cloudsettings/legacy/contexthub.

静默模式

静默模式会隐藏所有调试信息。 与可为每个ContextHub配置单独设置的普通调试选项不同,静默模式是一种全局设置,其优先于ContextHub配置级别上的任何调试设置。

这对于您根本不需要任何调试信息的发布实例非常有用。 由于它是全局设置,因此可通过OSGi启用。

  1. 打开 Adobe Experience Manager Web控制台配置http://<host>:<port>/system/console/configMgr
  2. 搜索 AdobeGranite ContextHub
  3. 单击配置 AdobeGranite ContextHub 以编辑其属性
  4. 选中选项 静默模式 并单击 保存

升级后恢复ContextHub配置

升级到AEM 执行,ContextHub配置将备份并存储在安全位置。 在升级过程中,将安装默认ContextHub配置,并替换现有配置。 要保留所做的任何更改或添加,需要备份。

ContextHub配置存储在名为的文件夹中 contexthub 在下列节点下:

  • /conf/global/settings/cloudsettings
  • /conf/<tenant>/settings/cloudsettings

升级后,备份存储在名为的文件夹中 contexthub 在名为的节点下:

/conf/global/settings/cloudsettings/default-pre-upgrade_yyyymmdd_xxxxxxx
/conf/<tenant>/settings/cloudsettings/default-pre-upgrade_yyyymmdd_xxxxxxx

yyyymmdd 节点名称的一部分是执行升级的日期。

要恢复ContextHub配置,请使用CRXDE Lite从以下位置复制表示您的商店、UI模式和UI模块的节点 default-pre-upgrade_yyyymmdd_xxxxxx 节点到以下位置:

  • /conf/global/settings/cloudsettings
  • /conf/<tenant>/settings/cloudsettings

在此页面上