分析とシンジケーション

ダッシュボードおよび可視化: カタログおよびスペースでの継承の流れについて

カタログおよびそのスペースのダッシュボードと可視化の「継承」の流れを定義するために、階層化された実装が使用されます。この構造は、カタログのダッシュボードと可視化に対する更新がスペースに反映されるかどうかを決定し、また、デフォルトのダッシュボードまたは可視化を編集、削除、または復元しようとしたときの表示内容およびカスタムのダッシュボードまたは可視化を作成、編集、または削除しようとしたときの表示内容に影響します。

ダッシュボードまたは可視化の状態が、デフォルト、カスタム、または継承のいずれであるかを識別できるように、API Manager ユーザー・インターフェース内のダッシュボードおよび可視化にタグが適用されます。これらのタグは、「保存済みオブジェクトの管理 (Manage Saved Objects)」ページに表示されます。このページには、すべての保存済みダッシュボードおよび可視化がリストされ、ここからダッシュボードと可視化を管理できます。

デフォルトのダッシュボードおよび可視化

デフォルトのダッシュボードおよび可視化では、編集、削除、または復元の操作に対して以下の原則が適用されます。

• 編集: カタログのデフォルトのダッシュボードまたは可視化を編集すると、変更内容がそのカタログのスペースの対応するデフォルトのダッシュボードおよび可視化に自動的に伝搬されます (以下の図の  a1  および  a2 )。 カタログのデフォルトのダッシュボードまたは可視化に対するカスタマイズは、スペース内のダッシュボードまたは可視化を編集するまでスペースにカスケードされます。編集後は、スペース内のダッシュボードまたは可視化は、カタログ内のダッシュボードまたは可視化から関連付けが解除されます ( a2  および  a3 )。スペース内のデフォルトのダッシュボードまたは可視化に対するカスタマイズは、そのスペース内にのみ反映されます ( a3 )。
• 削除: デフォルトのダッシュボードおよび可視化は、元の状態であるかカスタマイズされた状態であるかにかかわらず、カタログやスペースから削除することはできません。
• 復元: 前にカスタマイズされているデフォルトのダッシュボードまたは可視化を復元機能を使用してリセットすると、カタログ内の復元されたダッシュボードまたは可視化は、その設定を、最初にインストールされていた API Manager のデフォルトから回復します ( b1  および  b2 )。この変更は、そのカタログ内のスペースの対応するダッシュボードおよび可視化に自動的に伝搬されます。ただし、スペース内のダッシュボードおよび可視化がそのスペース内で独立して変更されていないことが前提です ( b3 )。スペースから手動で復元する場合、そのスペース内のダッシュボードまたは可視化は、そのデフォルト設定を、カタログ内の対応するダッシュボードまたは可視化の現在の (オリジナルまたはカスタマイズされた) 状態から回復します ( b4  および  b5 )。
  警告: 自動保存機能により、ダッシュボードをロードまたは更新すると、ダッシュボードは自動的に保存されます。スペースにダッシュボードをロードすると、そのダッシュボードは保存されて固有なものとなるため、継承のフローが切れることに注意してください。その結果、カタログ内の対応するダッシュボードを編集または復元する前 に、スペースにダッシュボードをロードすると、ここでの説明とは異なる結果になる場合があります。

以下の図に、カタログおよびスペース全体のデフォルトのダッシュボードおよび可視化に適用される継承の流れを示します。

カスタムのダッシュボードおよび可視化

カスタムのダッシュボードおよび可視化については、作成、編集、または削除の操作に対して以下の原則が適用されます。

• 作成: カタログ内にダッシュボードまたは可視化を作成すると、そのカタログ内のスペースに自動的に追加されます (以下の図の  a1  および  a2 )。 スペース内にダッシュボードまたは可視化を作成すると、そのダッシュボードまたは可視化は、そのスペースのみに追加されます ( a3 )。
• 編集: カタログ内のカスタムのダッシュボードまたは可視化を編集すると、変更内容がそのカタログ内のスペースの対応するダッシュボードまたは可視化に自動的に伝搬されます。ただし、スペース内のダッシュボードまたは可視化が、そのスペース内で独立して変更されていないことが前提です ( b1  および  b2 )。継承されたカスタムのダッシュボードまたは可視化をスペース内で編集した場合、変更はそのスペース内にのみ反映されます ( b3 )。
• 削除: カタログからカスタムのダッシュボードまたは可視化を削除すると、そのカタログ内のスペースの対応するダッシュボードまたは可視化が自動的に削除されます。ただし、スペース内のダッシュボードまたは可視化がそのスペース内で独立して変更されていないことが前提です ( c1  および  c2 )。ダッシュボードまたは可視化がスペース内に作成され、そのスペースに固有のものである場合、削除すると、そのダッシュボードまたは可視化はスペースから削除されます ( c3 )。

  スペース内のダッシュボードまたは可視化がカタログから継承され、スペース内で編集されていない場合、そのダッシュボードおよび可視化はスペースから削除できません。必要に応じて、カタログから削除してください。継承されたダッシュボードまたは可視化で、スペース内で更新されたものも、そのスペースから削除することはできず、カタログから削除する必要があります。

  スペース内のダッシュボードまたは可視化がカタログから継承され、スペース内で編集されていない場合、そのダッシュボードまたは可視化をスペースから削除すると、カタログからも削除されます。そのカタログ内の他のスペースに、そのダッシュボードまたは可視化の未編集のバージョンが含まれている場合、それらのスペースからも削除されます。

  警告: 自動保存機能により、ダッシュボードをロードまたは更新すると、ダッシュボードは自動的に保存されます。スペースにダッシュボードをロードすると、そのダッシュボードは保存されて固有なものとなるため、継承のフローが切れることに注意してください。その結果、カタログ内の対応するダッシュボードを編集または削除する前 に、スペースにダッシュボードをロードすると、ここでの説明とは異なる結果になる場合があります。

以下の図に、カタログおよびスペース全体のカスタムのダッシュボードおよび可視化に適用される継承の流れを示します。

「保存済みオブジェクトの管理 (Manage Saved Objects)」ページでのダッシュボードおよび可視化へのタグの適用方法

すべての保存済みダッシュボードおよび可視化のリストが表示され、ダッシュボードおよび可視化を編集、削除、復元、エクスポート、およびインポートできる「保存済みオブジェクトの管理 (Manage Saved Objects)」ページでは、タグを使用して、ダッシュボードまたは可視化の状態がデフォルト、カスタム、または継承として強調表示されます。

• カタログ・レベルでは、リスト内のダッシュボードおよび可視化に以下のタグが適用されて、その状態が示されます。
  • カスタマイズされていないデフォルトの各ダッシュボードまたは可視化には、Default ラベルのタグのみが付けられます。
  • カスタマイズされているデフォルトの各ダッシュボードまたは可視化には、Default ラベルのタグが付けられ、さらに Custom ラベルのタグが付けられます。
  • 各カスタム・ダッシュボードまたはカスタム可視化には、Custom ラベルのタグのみが付けられます。
• スペース・レベルでは、リスト内のダッシュボードおよび可視化に以下のタグが適用されて、その状態および継承設定が示されます。
  • カスタマイズされていないデフォルトの各ダッシュボードまたは可視化には、Default ラベルのタグのみが付けられます。
  • そのスペース内でカスタマイズされているデフォルトの各ダッシュボードまたは可視化には、Default ラベルのタグが付けられ、さらに Custom ラベルのタグが付けられます。
  • カタログ内でカスタマイズされ、そのスペースで継承されたデフォルトの各ダッシュボードまたは可視化で、そのスペース内でカスタマイズされていないものには、Default ラベルのタグと、追加で Inherited ラベルのタグが付けられます。
  • カタログ内でカスタマイズされ、そのスペースで継承されたデフォルトの各ダッシュボードまたは可視化で、その後そのスペース内でカスタマイズされたものには、Default ラベルのタグと、追加で Inherited ラベルおよび Custom ラベルのタグが付けられます。
  • そのスペース内で作成された各カスタム・ダッシュボードまたは可視化には、Custom ラベルのタグのみが付けられます。
  • カタログ内で作成され、そのスペースで継承されたカスタムの各ダッシュボードまたは可視化で、そのスペース内でカスタマイズされていないものには、Inherited ラベルのタグのみが付けられます。
  • カタログ内で作成され、そのスペースで継承されたカスタムの各ダッシュボードまたは可視化で、その後そのスペース内でカスタマイズされたものには、Inherited ラベルおよび Custom ラベルのタグが付けられます。

API Manager UI からの「保存済みオブジェクトの管理 (Manage Saved Objects)」ページへのアクセスについては、以下を参照してください。

• 可視化の編集
• 可視化のエクスポート
• 可視化のインポート
• カスタムの可視化の削除
• デフォルトの可視化の復元
• ダッシュボードの編集
• ダッシュボードのエクスポート
• ダッシュボードのインポート
• カスタム・ダッシュボードの削除
• デフォルト・ダッシュボードの復元