ドキュメントAEM 6.5ユーザーガイド

ContextHub の設定 configuring-contexthub

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • 開発者

ContextHub は、コンテキストデータを保存、操作および表示するためのフレームワークです。ContextHub について詳しくは、開発者のドキュメントを参照してください。ContextHub は、タッチ UI の ClientContext に代わる機能です。

ContextHub ツールバーを設定すると、プレビューモードで表示されるかどうかを制御したり、ContextHub ストアを作成したり、タッチ操作向け UI を使用して UI モジュールを追加したりすることができます。

ContextHub の無効化 disabling-contexthub

デフォルトでは、AEM のインストールで ContextHub が有効になっています。ContextHub を無効にすると、js／css の読み込みと初期化を回避できます。

  • CRXDE Lite を使用して、/libs/settings/cloudsettings/legacy/contexthub の disabled プロパティを true に設定します。
NOTE
AEM 6.4 でのリポジトリの再構築に伴い、ContextHub 構成の場所が /etc/cloudsettings から次のように変更されました。
  • /libs/settings/cloudsettings
  • /conf/global/settings/cloudsettings
  • /conf/<tenant>/settings/cloudsettings

ContextHub UI の表示と非表示 showing-and-hiding-the-contexthub-ui

Adobe Granite ContextHub OSGi サービスを設定して、ページで ContextHub UI を表示または非表示にします。このサービスの PID は、com.adobe.granite.contexthub.impl.ContextHubImpl. です。

このサービスは、Web コンソールまたはリポジトリ内の JCR ノードを使用して設定できます。

  • Web コンソール： UI を表示するには、「Show UI」プロパティを選択します。UI を非表示にするには、「非表示 UI」プロパティをクリアします。
  • JCR ノード： UI を表示するには、com.adobe.granite.contexthub.show_ui ブール値プロパティを true に設定します。UI を非表示にするには、プロパティを false に設定します。

ContextHub UI を表示する場合は、AEM オーサーインスタンスのページにのみ表示されます。この UI は、パブリッシュインスタンスのページには表示されません。

ContextHub UI のモードとモジュールの追加 adding-contexthub-ui-modes-and-modules

ContextHub ツールバーに表示される UI のモードとモジュールをプレビューモードで設定します。

  • UI モード：関連モジュールのグループ
  • モジュール：ストアからのコンテキストデータを公開し、オーサーがそのコンテキストを操作できるようにするウィジェット

UI モードは、ツールバーの左側に一連のアイコンとして表示されます。選択すると、UI モードのモジュールが右側に表示されます。

chlimage_1-319

アイコンは、Coral UI アイコンライブラリからの参照です。

UI モードの追加 adding-a-ui-mode

UI モードを追加すると、関連する ContextHub モジュールをグループ化できます。UI モードの作成時に、ContextHub ツールバーに表示されるタイトルとアイコンを指定します。

  1. Experience Manager パネルで、ツール／Sites／Context Hub をクリックします。

  2. デフォルトの設定コンテナをクリックします。

  3. 「ContextHub 設定」をクリックします。

  4. 「作成」ボタンをクリックして、「ContextHub UI モード」をクリックします。

    chlimage_1-320

  5. 次のプロパティの値を指定します。

    • UI モードのタイトル：UI モードを識別するタイトル。
    • モードアイコン：使用する Coral UI アイコンのセレクター（例：coral-Icon--user）。
    • 有効：ContextHub ツールバーに UI モードを表示する場合に選択します

  6. 「保存」をクリックします。

UI モジュールの追加 adding-a-ui-module

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
日付と時間の情報が表示されます
datetime
contexthub.device
クライアントデバイスが表示されます。
emulators
contexthub.location
クライアントの緯度と経度、およびマップ上の位置が表示されます。位置は変更できます。
geolocation
contexthub.screen-orientation
デバイスの画面の向きが表示されます（横置きまたは縦置き）
emulators
contexthub.tagcloud
ページのタグに関する統計が表示されます
tagcloud
granite.profile
authorizableID、displayName、familyName など、現在のユーザーのプロファイル情報が表示されます。displayName と familyName の値は変更できます。
プロファイル

  1. Experience Manager パネルで、ツール／Sites／ContextHub をクリックします。

  2. UI モジュールを追加する設定コンテナをクリックします。

  3. UI モジュールを追加する ContextHub 設定コンテナをクリックまたはタップします。

  4. UI モジュールを追加する UI モードをクリックします。

  5. 「作成」ボタンをクリックして、「ContextHub UI モジュール（汎用）」をクリックします。

    chlimage_1-321

  6. 次のプロパティの値を指定します。

    • UI モジュールのタイトル：UI モジュールを識別するタイトル。
    • モジュールタイプ：そのモジュールのタイプ。
    • 有効：オンにすると ContextHub ツールバーに UI モジュールが表示されます。

  7. （オプション）デフォルトのストアの設定をオーバーライドするには、UI モジュールを設定する JSON オブジェクトを入力します。

  8. 「保存」をクリックします。

ContextHub ストアの作成 creating-a-contexthub-store

ContextHub ストアを作成してユーザーデータを保持し、必要に応じてそのデータにアクセスします。ContextHub ストアは、登録済みのストア候補に基づきます。ストアを作成する際には、ストア候補が登録された storeType の値が必要です（カスタムストア候補の作成を参照してください）。

ストアの詳細設定 detailed-store-configuration

ストアを設定すると、詳細設定プロパティによりストア固有のプロパティの値を指定できます。値は、ストアの config 関数の init パラメーターに基づきます。このため、この値を指定する必要があるかどうかと、指定する値の形式はストアによって変わります。

詳細設定プロパティの値は、JSON 形式の config オブジェクトです。

サンプルのストア候補 sample-store-candidates

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 パネルで、ツール／Sites／ContextHub をクリックします。

  2. デフォルトの設定コンテナをクリックします。

  3. 「Contexthub 設定」をクリックします。

  4. ストアを追加するには、作成アイコンをクリックし、「ContextHub ストアの設定」をクリックします。

    chlimage_1-322

  5. 次の基本設定のプロパティの値を指定して、「次へ」をクリックします。

    • 設定タイトル： ​ストアを識別するタイトル。
    • ストアタイプ： ​ストアのベースとなるストア候補の storeType プロパティの値。
    • 必須： ​オン。
    • 有効： ​オンにするとストアが有効になります。

  6. （オプション）デフォルトのストアの設定をオーバーライドするには、「詳細設定（JSON）」ボックスに JSON オブジェクトを入力します。

  7. 「保存」をクリックします。

例：JSONP サービスの使用 example-using-a-jsonp-service

この例は、ストアを設定して UI モジュールにデータを表示する方法を示します。この例では、ストアのデータソースとして jsontest.com サイトの MD5 サービスが使用されています。サービスが指定の文字列の MD5 ハッシュコードを JSON 形式で返します。

contexthub.generic-jsonp ストアがサービスコール https://md5.jsontest.com/?text=%22text%20to%20md5%22 のデータを格納するように設定されます。サービスが UI モジュールに表示される次のデータを返します。

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

contexthub.generic-jsonp ストアの作成 creating-a-contexthub-generic-jsonp-store

contexthub.generic-jsonp のサンプルのストア候補を使用すると、JSON データを返す JSONP サービスや web サービスからデータを取得できます。このストア候補では、そのストア設定を使用して、使用する JSONP サービスに関する詳細を指定します。

ContextHub.Store.JSONPStore Javascript クラスの init 関数は、このストア候補を初期化する config オブジェクトを定義します。config オブジェクトには JSONP サービスに関する情報が含まれる service オブジェクトが含まれています。ストアを設定するには、詳細設定プロパティの値として service オブジェクトを JSON 形式で指定します。

jsontest.com サイトの MD5 サービスからのデータを保存するには、次のプロパティを使用して ContextHub ストアの作成の手順に従います。

  • 設定のタイトル： md5

  • ストアの種類： contexthub.generic-jsonp

  • 必須： ​オン。

  • 有効： ​オン

  • 詳細設定（JSON）：

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

md5 データの UI モジュールの追加 adding-a-ui-module-for-the-md-data

ContextHub ツールバーに UI モジュールを追加して、サンプルの md5 ストアに格納されているデータを表示します。この例では、contexthub.base module が次の UI モジュールの生成に使用されています。

chlimage_1-323

UI モジュールの追加手順に従って、サンプルのペルソナ UI モードなどの既存の UI モードに UI モジュールを追加します。UI モジュールには、次のプロパティ値を使用します。

  • UI モジュールのタイトル： MD5

  • モジュールの種類： contexthub.base

  • 詳細設定（JSON）：

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

ContextHub のデバッグ debugging-contexthub

ContextHub のデバッグモードを有効にして、トラブルシューティングに対応できます。デバッグモードは、ContextHub 設定または CRXDE のいずれかを利用して有効にできます。

設定による有効化 via-the-configuration

ContextHub の設定を編集し、「デバッグ」オプションをオンにします。

  1. パネルで、ツール／Sites／ContextHub をクリックします。
  2. デフォルトの「設定コンテナ」をクリックします。
  3. 「ContextHub の設定」を選択し、「選択した要素を編集」をクリックします。
  4. 「デバッグ」をクリックし、「保存」をクリックします。

CRXDE による有効化 via-crxde

CRXDE Lite を使用して、debug プロパティを true に設定します。

  • /conf/global/settings/cloudsettings または
  • /conf/<tenant>/settings/cloudsettings
NOTE
ContextHub 設定が従来のパスの下に残っている場合は、debug property を設定する場所は /libs/settings/cloudsettings/legacy/contexthub になります。

サイレントモード silent-mode

サイレントモードでは、すべてのデバッグ情報が無効になります。各 ContextHub 設定に対して個別に設定可能な通常のデバッグオプションとは異なり、サイレントモードは、ContextHub 設定レベルのあらゆるデバッグ設定より優先されるグローバル設定です。

これは、デバッグ情報をまったく必要としないパブリッシュインスタンスに便利なモードです。これはグローバル設定なので、OSGi を介して有効にします。

  1. http://<host>:<port>/system/console/configMgr で Adobe Experience Manager Web コンソール設定 ​を開きます。
  2. Adobe Granite ContextHub を検索します。
  3. 設定「Adobe Granite ContextHub」をクリックして、そのプロパティを編集します。
  4. 「サイレントモード」チェックボックスをオンにし、「保存」をクリックします。

アップグレード後の ContextHub の設定の復元 recovering-contexthub-configurations-after-upgrading

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
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2