ヘッドレス・エクスペリエンスと連携

5 ヘッドレス・エクスペリエンスと連携

Oracle Content Managementは、コンテンツ・リポジトリと公開チャネルを、Oracle Content Managementの外部で開発および管理されたヘッドレス・エクスペリエンスに接続し、コンテンツの変更または公開ステータスに基づいてデプロイメントを自動的にトリガーする方法を提供します。

コンテンツ・プロバイダは、コンテンツを整理、取得、翻訳、コラボレーション、承認および公開するための強力なツールなど、リポジトリ・アセット管理の利点を活用できます。その後、Oracle Content Managementを離れずに、コンテキスト内およびコンテンツでヘッドレス・アプリケーションをプレビューできます。

経験ある開発者は、所有しているツールを操作でき、ヘッドレス・エクスペリエンスを構成して、関連するリポジトリのコンテンツの変更や関連する公開チャネルのコンテンツの公開ステータスに基づいて自動的に構築し、継続的な統合/継続的デプロイメント(CI/CD)を推進できます。

次のトピックでは、Oracle Content Management以外のエクスペリエンスへの接続を作成および構成する方法について説明します:

エクスペリエンス・オブジェクトの作成

Oracle Content Managementの外部でヘッドレス・エクスペリエンスに接続するエクスペリエンス・オブジェクトをOracle Content Managementで作成するには、開発者ロールを持つエンタープライズ・ユーザーであり、接続するエクスペリエンスの作成および管理に使用されるサード・パーティ・アプリケーションをよく理解している必要があります。

ノート:

Oracle Content Management Starter Editionインスタンスで作成できるエクスペリエンス・オブジェクトは1つのみです。無制限のオブジェクトの場合、Premium Editionにアップグレードします。

サイド・ナビゲーション・パネルで「操作性」をクリックします。
エクスペリエンス・ページで、「作成」をクリックします。
接続するヘッドレス・エクスペリエンスの名前、オプションの説明およびデフォルトのURLを入力し、「作成」をクリックします。デフォルトのURLは、通常、接続しているヘッドレス・エクスペリエンスのサイトURLであり、Oracle Content Managementでエクスペリエンスを表示する必要があります。

ノート: 各フィールドで使用できる情報のタイプには、いくつかの制限があります。

フィールド	制限
名前(必須)	文字列の最大長は256文字です。文字列にchacacters `;":?<%>{}/#\\|*`を含めることはできません
説明(オプション)	文字列の最大長は500文字です。文字列には任意の文字を含めることができます。
エクスペリエンスURL (体験プレビューを開くために必要)	文字列の最大長は4000文字です。この文字列には、URLで有効な任意の文字を含めることができます。文字列を解析して有効なURLにする必要があります。

エクスペリエンス・オブジェクト・プロパティの構成

エクスペリエンス・オブジェクトが作成されたら、Oracle Content Managementのコンテンツ・ライフサイクル・イベントに基づいてヘッドレス・エクスペリエンス・デプロイメントを自動化する送信ターゲットを含めるように構成する必要があります。ターゲットがトリガーされると、Oracle Content Managementは、ターゲットの定義時に、送信ターゲットで指定したURLエンドポイントにリクエストを送信します。通常、URLエンドポイントは、送信ターゲットの受信および応答のためにヘッドレス・エクスペリエンスに実装され、通常はCI/CDワークフローを自動化します。たとえば、更新されたコンテンツに関する通知により、エクスペリエンスの新規構築、キャッシュのフラッシュ、または更新されたコンテンツの使用経験に必要なその他のアクションが実行される場合があります。

エクスペリエンス・ページでエクスペリエンス・オブジェクトを選択し、アクション・バーの「プロパティ」をクリックします。
プロパティ・タブで、エクスペリエンス・オブジェクトに関する情報の確認、説明またはデフォルトのURLの変更、ヘッドレス・エクスペリエンス接続の有効化または無効化を行うことができます。これを無効にすると、コンテンツ・ライフサイクル・イベントによってエクスペリエンス・オブジェクト内のターゲットがトリガーされなくなります。

経験ごとに最大10のターゲットを構成して、特定のコンテンツ・ライフサイクル・イベントに基づいて様々なデプロイメント・シナリオを処理できます。たとえば、リポジトリ内で未公開のアセットの新しいバージョンが更新されたときに1つのターゲットをトリガーし、エクスペリエンスのプレビューを開始します。一方、2つ目のターゲットは、アセットがチャネルに公開または再公開されたときにトリガーされ、新しいビルドを開始できます。

エンドポイントから受信したレスポンスは、エクスペリエンス・オブジェクト・プロパティを構成するときに「分析タブ」で定義されたルールを使用して処理されます。レスポンスには、次のものが含まれます:

リクエストに含まれているターゲット識別子
ステータス・メッセージまたはコード
更新されたヘッドレス・エクスペリエンスを表示できるURL

エクスペリエンス・オブジェクトへの送信ターゲットの追加

Oracle Content Management内からヘッドレス・エクスペリエンスのデプロイメントおよびプレビューを自動化するには、エクスペリエンス・オブジェクト・プロパティの「送信」タブでターゲットを追加し、トリガー・イベントを指定する必要があります。特定のコンテンツ・ライフサイクル・イベントに基づいて様々なデプロイメント・シナリオを処理するように最大10のターゲットを構成できます。

エクスペリエンス・オブジェクトのプロパティ・パネルを開いた状態で、「送信」タブをクリックします。
送信ターゲットを追加するには、「追加」をクリックします。
ターゲットの名前、URLエンドポイントを入力し、使用するメソッド(GETまたはPOST)を指定します。

ノート:
URLエンドポイントは、セキュアなhttpsプロトコルを使用する必要があります。
デプロイするターゲットをトリガーするOracle Content Managementイベントを選択し、リポジトリ(アセット変更イベント用)またはチャネル(アセット公開イベント用)を指定します。
- 「変更」-指定されたリポジトリでアセットが変更されると、ターゲットがトリガーされます。
- 「公開」-ターゲットは、指定した公開チャネルでアセットが公開されたときにトリガーされます。
必要に応じて、「ヘッダー」および「本文」をクリックして必要な追加情報を追加します。
「保存」をクリックします。
ターゲットを手動でトリガーするには、「テスト」をクリックします。ターゲットをトリガーすると、レスポンスを要求するリクエストがターゲット・エンドポイントに送信されます(通常はJSON本文ペイロードの形式)。リクエストが有効な場合は、イベント・タブに表示されるイベントをリフレッシュして、追加情報とともにリストを表示できます。リクエストが無効な場合は、エラー・メッセージが表示されます。

TARGET_IDENTIFIERトークンの追加

{{TARGET_IDENTIFIER}}トークンを送信ターゲットに追加できます。このトークンは、ターゲットがコンテンツ・ライフサイクル・イベントによって自動的にトリガーされるか、「テスト」をクリックして手動でトリガーされたときに、ターゲットIDをリクエストに追加します。 {{TARGET_IDENTIFIER}}トークンを追加する場所は、ヘッドレス・エクスペリエンスの管理に使用するサード・パーティ・アプリケーションによって異なります。 URLエンドポイント、HTTP本文またはHTTPヘッダーに追加される場合があります。

受信ペイロードを受信すると、ペイロードが評価され、ターゲットIDが存在するかどうかが確認されます。 Oracle Content Managementエクスペリエンス・オブジェクトの送信ターゲットIDと一致するターゲットIDが見つかった場合、そのペイロードはそのIDを持つ送信ターゲットに関連付けられます。

ペイロードがターゲットに関連付けられると、イベント・アイテムは適切なタイトルでイベント・タブに記録されます。ペイロードがターゲットに関連付けられ、URLがターゲットの分析タブで構成されたURL固有文字列と一致する場合、そのURLはそのターゲットのプレビューURLとして格納されます。

送信ターゲットIDと一致する受信ペイロードでターゲットIDが見つからない場合は、ペイロードをターゲットに関連付けできず、イベント・タブに不明と表示されます。

受信Webフックの有効化および無効化

Oracle Content Managementを使用すると、コンテンツ・コントリビュータはヘッドレス・エクスペリエンスの最新バージョンを簡単に表示できます。ヘッドレス・エクスペリエンスが更新されると、デプロイメント・システムはエクスペリエンスwebフックにリクエストを送信してOracle Content Managementに通知できます。すべての受信リクエストはイベント・タブに記録されます。

受信webフックURLを確認し、エクスペリエンス・プロパティ・パネルの「受信」タブで有効化または無効化できます。

ペイロード情報の分析および抽出

「分析」タブでは、受信レスポンス・ペイロードから情報を抽出し、イベント・タブに表示して、コンテンツ・エディタおよびコントリビュータにとって重要な情報(コンテンツが保存、公開、稼働したときなど)を提供できます。

ターゲットがトリガーされ、リクエストがヘッドレス・エクスペリエンスのエンドポイントURLに送信されると、エクスペリエンスはレスポンス・ペイロードを返します。レスポンス・ペイロードはリクエストと結合され、結合されたデータ構造はイベント・タブにイベント・アイテムとして表示され、イベント・アイテムのhttpBodyセクションにレスポンス・ペイロードが表示されます。

分析タブで、二重カッコ{{}}内に抽出する情報へのJSONパスをエンコードして、リクエストされたデータをペイロードのhttpBodyセクションから抽出するイントロスペクト文字列を作成できます。抽出された情報は、イベント・タブのイベント・リストに表示されます。

たとえば、ペイロードのセクションは次のようになります:

"httpBody": {
  "data": {
    "url": "https://sample.com",
    "status": "Building",
    "name": "Sample Target"
  }
}

分析タブでURL、ステータスおよび名前データのJSONパスを、次のURL固有文字列として指定します:

{{data.url}}

{{data.status}}

{{data.name}}

デプロイメントのURL、デプロイメント・ステータスおよび名前は、イベント・タブで動的にリストされます。

ノート:

URLイントロスペクト文字列には特別なステータスがあり、関連付けられたターゲットのデプロイメントをプレビューするためのURLを識別するために予約されています。このURL値は格納され、エクスペリエンス・オブジェクトを表示するときにトリガーされたターゲットの最新の結果をプレビューするために使用されます。

文字列値をハードコードすることもできます。これを行う理由の1つは、JSONパスの結果にラベルを付けて、コンテンツ・コントリビュータの情報を簡単に識別することです。たとえば、デプロイメント名を抽出する場合、次のように入力

Name: {{data.name}}

分析タブのイントロスペクト文字列内。これにより、そのターゲットのイベント・タブに「名前: サンプル・プレビュー」が表示されます。

同様に、エンコードされたJSONパスとハードコードされた文字列を1つの内部文字列エントリに結合できます。たとえば、

Name: {{data.name}} Status: {{data.status}}

プレビューの作成中に、ターゲットのイベント・タブに「名前: サンプル・プレビュー・ステータス: ビルディング」が表示されます。

イントロスペクト文字列のJSONパスをエンコードするときにスペルまたは構文エラーがある場合、文字列の解釈は失敗し、情報はペイロードから抽出されず、イベント・タブに表示されません。イベント文字列で複数のJSONパスを使用している場合、1つのエラーによってすべてが失敗します。

エクスペリエンスのイベント情報の表示

ヘッドレス・エクスペリエンスのイベント情報は、エクスペリエンス・オブジェクトのプロパティ・パネルのイベント・タブにリストされます。リスト内のイベントを展開して完全なペイロードを表示し、ヘッドレス・エクスペリエンス開発者に役立つ受信および送信通知の詳細を確認できます。

「そのイベント」タブには、ペイロードに含まれるすべての情報が記録されます。「分析タブ」のイントロスペクト文字列を使用して、コンテンツ・プロバイダに有用な情報を提供するために、イベント・リストに表示される情報を絞り込むことができます。これにより、コンテンツ・プロバイダが、ビルド・ステータスやプレビューURLなどの有用な情報をすばやく確認できます。ペイロード全体を展開およびレビューして情報を見つける必要はありません。

ヘッドレス・コネクテッド・エクスペリエンスを可視化

Oracle Content Management以外のヘッドレス・エクスペリエンスが接続されると、コンテンツ・プロバイダはOracle Content Management内のヘッドレス・エクスペリエンス・イベントを表示できます。これにより、エクスペリエンスの構成方法に応じて、アセットを編集または公開することで、イベントをトリガーしたときにヘッドレス・エクスペリエンスのプレビューを公開または構築することにより、ワークフローが自動化されます。

ヘッドレス・エクスペリエンスを表示するには、エクスペリエンス・オブジェクトを選択し、右クリック・メニューから「表示」を選択するか、アクション・バーのをクリックします。

エクスペリエンス・パネルが表示されたら、表示するターゲットをドロップダウン・リストから選択します。ヘッドレス・エクスペリエンスがiframeに表示されます。セキュリティ上の理由でエクスペリエンスをiframeに正しく表示できない場合は、「起動」をクリックして、新しいブラウザ・タブでエクスペリエンスを表示します。

エクスペリエンス作成の成功後にプロパティを起動

ユーザーは通常、作成後にエクスペリエンスをカスタマイズする必要があります。 Oracle Content Managementは、作成ウィザードの完了後にプロパティを起動し、「送信」タブに切り替えます。

APIを使用したセキュリティ管理設定の設定

サービス管理者ロールがある場合は、APIを介してセキュリティ管理設定を設定できます。

また、CORsリストを更新して、文書、CaasおよびOSNにわたるCORS処理を標準化することもできます。

エクスペリエンス・オブジェクトの共有

エクスペリエンス・オブジェクトを作成したか、自分と共有されているエクスペリエンス・オブジェクトのマネージャである場合、他のユーザーと共有してオブジェクトの使用または編集を許可できます。

ノート:

エクスペリエンスはエンタープライズ・ユーザーのみが使用できるため、エクスペリエンス・オブジェクトを共有できるのは他のエンタープライズ・ユーザーのみです。

「操作性」ページを開き、共有するエクスペリエンス・オブジェクトを選択します。
右クリック・メニューまたはアクション・バーの「メンバー」を選択またはクリックします。
サイド・パネルの「メンバーの追加」をクリックします。
エクスペリエンス・オブジェクトを共有する個人の名前またはEメール・アドレスを入力します。新しいメンバーに送信するオプションのメッセージを削除または変更できます。
追加したメンバーにするロールを選択します。選択したロールは、このプロセスにリストしたすべてのメンバーに割り当てられます。異なるメンバーに対して異なるロールを指定する場合や、追加後にロールを個別に変更する場合は、プロセスを複数回実行できます。

次のロールをエクスペリエンス・オブジェクト・メンバーに割り当てることができます。
- 「所有者」-所有者は、エクスペリエンス・オブジェクトを作成したユーザーであり、変更できません。オブジェクト、オブジェクト・プロパティおよびメンバーを完全に制御できます。
- 「マネージャ」-マネージャは、オブジェクト、オブジェクト・プロパティおよびメンバーを完全に制御します。
- 「貢献者」-コントリビュータはオブジェクトとオブジェクト・プロパティの完全な制御を持ち、メンバーのリストを表示できますが、メンバーを追加または削除することはできません。
- 「参照者」-ビューアはエクスペリエンス・オブジェクトを表示および使用できますが、変更はできません。メンバーのリストを表示することもできますが、メンバーを追加または削除することはできません。
- 「削除」-所有者またはマネージャの場合は、メンバーに割り当てられたロールを削除するオプションがあり、エクスペリエンス・オブジェクトのメンバーとしてそのロールを削除します。
追加する個人の選択が終了したら、「追加」をクリックします。選択した個人がメンバー・サイド・パネルのメンバーとしてリストされます。
「完了」をクリックして、メンバーのサイド・パネルを閉じます。

エクスペリエンス・ページでのエクスペリエンス・オブジェクトのフィルタリング

タイトル・メニューからオプションを選択して、Experiencesページに表示されるエクスペリエンス・オブジェクトを選択できます。使用できるフィルタ・オプションは、次のとおりです。

「すべて」-自分が作成または自分と共有するすべてのエクスペリエンス・オブジェクトがリストされます。
「お客様が所有」-自分で作成したエクスペリエンス・オブジェクトのみがリストされます。
「共有」-共有されているエクスペリエンス・オブジェクトのみがリストされます。