基本的なダッシュボードの埋め込み
このページでは、ダッシュボードを外部アプリケーションに iframe として埋め込む方法を示します。ビューアーは、Databricks アカウントまたはワークスペースの資格情報を使用してダッシュボードにアクセスします。
埋め込みコードを生成する
外部アプリケーションに貼り付けることができる埋め込みコードを生成するには:
-
埋め込む公開済みダッシュボードを開きます。ワークスペースでダッシュボードを表示してアクセスする方法については、「 ダッシュボードの表示と整理 」を参照してください。
-
右上隅の [共有] をクリックします。
-
[ 共有] ダイアログで [ダッシュボードを埋め込む] をクリックします。
-
[ 埋め込みコードをコピー] ダイアログが開きます。許可された埋め込みドメインのリストが存在する場合は、ドメインがリストされます。コピーボタン
をクリックして、コードスニペットをコピーします。
-
HTML 埋め込みをサポートし、iframe コンテンツをレンダリングできる任意のプラットフォームまたはアプリケーションに埋め込みコードを挿入します。例を参照してください。
埋め 込みコードのコピー ダイアログ に、ターゲット ドメインが含まれていない許可されたドメインのリストが含まれている場合は、ワークスペース管理者が追加できます。ダッシュボード と Genie アクセスの管理を参照してください。
例
次の例には、アプリケーションにダッシュボードを埋め込むためのステップバイステップのガイダンスが含まれています。各手順セットは、前のセクションで説明した埋め込みコードを既にコピーしていることを前提としています。
Confluence に埋め込む
生成された埋め込みコードは、Confluence の要件を満たすためにわずかな調整が必要です。ダッシュボードを Confluence ページに埋め込むには、次の手順を実行します。
-
埋め込みコードを編集して、生成された URL のみを含め、iframe タグや追加のマークアップ値を含めないようにします。
編集する前に、埋め込みコードには、iframe HTML タグ、iframe のソースを使用するためのダッシュボードへのリンク、および次のコードスニペットに示すように、高さ、幅、境界線の追加仕様が含まれます。ダッシュボードの場合、プレースホルダーの例は
<databricks-instance-name>``<dashboard-and-workspace-ID>
には、ワークスペースとダッシュボードに関連付けられた実際の値が含まれています。それらは次のとおりです。<databricks-instance-name>
は、ワークスペースにログインするときの URL の最初の部分です。ワークスペース オブジェクトの識別子の取得を参照してください。<dashboard-and-workspace-ID>
は、ダッシュボードを指すURLの最後の部分です。それは次のようになります:a4bf23c498752e79f1a2d6b4c9087e31?o=3498561237865447
。
<iframe src="https://<databricks-instance-name>/embed/dashboardsv3/<dashboard-and-workspace-ID>" width="100%" height="600" frameborder="0"></iframe>
次の例に示すように、リンク テキストのみが含まれるように文字列を編集します。
https://<databricks-instance-name>/embed/dashboardsv3/<dashboard-and-workspace-ID>
-
ページに iframe 要素を挿入します。ページに iframe を挿入する方法については、 Confluence のドキュメントを参照してください。
-
編集した埋め込みURLを URL テキストフィールドに貼り付け、幅を100%に設定します。
-
好みに応じてその他の設定を調整します。
Salesforce ナレッジへの埋め込み
ダッシュボードを Salesforce ナレッジページに埋め込むには、次の手順を実行します。
-
Visualforce ページを作成する。手順については、 Salesforce のドキュメントを参照してください。
-
[ ページ編集 ] 画面で、カーソルを Visualforce マークアップ エディタに移動します。
-
コピーした埋め込みコードを 2 つの
<apex:page></apex:page>
タグの間に貼り付けます。 -
埋め込みコードの周囲に 2 つの段落タグ (
<p></p>
) を追加します。次の例では、プレースホルダ
<dashboard-embed-code>
を使用して、Visualforce マークアップがどのように見えるかを示します。インスタンスには、コピーした完全な埋め込みコードが含まれている必要があります。<apex:page >
<p><dashboard-embed-code></p>
</apex:page> -
[保存] をクリックして変更を保存します。
-
[プレビュー] をクリックし、ダッシュボードがレンダリングされることを確認します。
-
コンポーネントプレビューのURLをコピーし、新しいiframeコンポーネントを作成します。次のコード スニペットのようになります。プレースホルダ
<your-salesforce-domain>
は、Salesforce ドメインに置き換える必要があります。<iframe src="https://<your-salesforce-domain>/apex/<component name>" width="100%" height="600" frameborder="0"></iframe>
-
ダッシュボードを埋め込む [ナレッジ] ページに移動します。
-
[ 編集] > [メディアコンポーネントを追加 ] をクリックします。
-
前のステップの iframe コードを [埋め込み] テキスト フィールドに貼り付けます。
SharePoint に埋め込む
ダッシュボードを SharePoint に埋め込むには、SharePoint に埋め込まれたコンテンツに許可されるサイトの一覧に Databricks URL を追加する必要がある場合があります。SharePoint ページへのコンテンツの埋め込みを許可する方法については、[Microsoft のドキュメント] を参照してください。次に、次の手順を実行します。
- 埋め込みダッシュボードをホストする SharePoint ページに移動します。
- ページに Embed 要素を追加します。
- 完全な埋め込みコードを、画面右側の [Web サイトのアドレス] または [埋め込みコード ] フィールドに貼り付けます。
- クリックして確認します。
1 つのウィジェットを埋め込む
ダッシュボードから 1 つのウィジェットを埋め込むには、ダッシュボードの埋め込みコードと、表示するウィジェットの一意の識別子が必要です。
一意の識別子をコピーする
1 つのウィジェットの識別子は、ページ name
値とウィジェット name
値の組み合わせで、チルダ (~
) で区切られています。
name
キーは、ダッシュボードを定義するシリアル化されたファイルに表示され、Databricks UI からアクセスできません。これは、UI に表示されるページ名を定義する displayName
値とは別のものです。ダッシュボードファイルの編集を参照してください。
一意の識別子をコピーするには:
-
Databricks ワークスペースで発行されたダッシュボードを開きます。
-
埋め込むウィジェットの
ケバブメニューをクリックします。
-
[ 全画面表示] または [ウィジェットへのリンクをコピー] をクリックします。 URL には、関連するページとウィジェットの
name
値が含まれています。 -
検索パラメーターをコピーします パラメーター
fullscreenWidget
と等号 (=
の後のすべてのもの)。次の例は、フルスクリーンウィジェットのURLの最後の部分を示しています。
fullscreenWidget=53eadf26~3490f286
生成された埋め込みコードを調整する
- ダッシュボードの埋め込みコードを生成する手順を見つけるには、 埋め込みコードの生成 を参照してください。
- 埋め込み URL に
&fullscreenWidget=<ID>
を追加し、<ID>
を結合された<page-name>~<widget-name>
値に置き換えます。
たとえば、基本埋め込み URL が次のようになるとします。
src="https://<databricks-instance-name>/embed/dashboardsv3/<dashboard-and-workspace-ID>&fullscreenWidget=<ID>"
一意の識別子を持つ更新された埋め込み URL は、次のようになります。
src="https://<databricks-instance-name>/embed/dashboardsv3/<dashboard-and-workspace-ID>&fullscreenWidget=53eadf26~82f66691"
埋め込みダッシュボードを表示する
埋め込みダッシュボードは、閲覧者が Databricks の外部でダッシュボード データにアクセスするための安全な方法を提供します。既存の共有設定はすべて適用されます。目的の閲覧者には、ダッシュボードへのアクセス権を付与する必要があります。「 ダッシュボードにアクセスできるユーザー」を参照してください。埋め込みダッシュボードにアクセスすると、ビューアーは、同じワークスペースへの最近のサインインからのアクティブなセッションがない限り、Databricks にサインインするように求められます。
埋め込みダッシュボードを表示するには:
- ダッシュボードが埋め込まれているページに移動します。
- 必要に応じて、Databricks 資格情報を使用してログインします。
ダッシュボードへのアクセス権が付与されていない登録ユーザーがダッシュボードを表示しようとすると、ダッシュボードが使用できないというエラーが表示されます。共有設定を調整する方法については、「 公開済みダッシュボードの共有」 を参照してください。
埋め込みダッシュボードを更新する
埋め込みダッシュボードのすべての閲覧者は、オンデマンドでダッシュボードを手動で更新できます。ダッシュボードを定期的に更新するスケジュールを設定することもできます。
スケジュールされたダッシュボードの更新とサブスクリプションの管理を参照してください。
埋め込みダッシュボードのトラブルシューティング
このセクションでは、発生する可能性のある一般的な問題と、推奨される解決策を示します。
埋め込み iframe は空白です
埋め込まれた iframe にデータが表示されない場合は、サードパーティの Cookie を無効にしている可能性があります。サードパーティ Cookie を有効にすることは、埋め込みダッシュボードなどの外部コンテンツが別の Web ページ内で正しく機能できるようにするために必要です。
ブラウザの設定を調整して、サードパーティ Cookie を許可またはブロック解除して、この問題を解決できます。すべてのサードパーティ Cookie を許可したくない場合は、多くのブラウザで、サードパーティ Cookie を許可する必要がある特定のサイトに例外を追加できます。Cookie の管理に関する詳細な手順については、ブラウザのヘルプ ドキュメントを参照してください。
次の手順では、Chrome ブラウザでサードパーティ Cookie を有効にしてセッションを再開する方法について説明します。 このプロセスでは、最初にサードパーティ Cookie を無効にしてから再度有効にすることで、クリーンな状態が保証されます。
- すべてのアクティブな Databricks セッションからログアウトします。
- URL の横にあるスライダー アイコンをクリックします。
- [ Cookie とサイト データ] をクリックし、 サードパーティ Cookie を 無効またはブロックします。ページを更新するように求められます。
- ページを更新し、埋め込まれた iframe で [サインイン] をクリックします。エラーメッセージが表示されます。ブラウザウィンドウを閉じます。
- [Cookie とサイト データ] で、[ サードパーティ Cookie] を許可します 。
- ページをもう一度更新します。
- 埋め込みダッシュボードに移動し、[ サインイン] をクリックします。
次のステップ
- 外部ユーザーの埋め込みを構成する: 「外部ユーザー向けの埋め込みとは」を参照してください。
- 埋め込み権限の管理 : 埋め込みダッシュボードをホストできるドメインを制御し、ワークスペース レベルの埋め込み設定を構成します。「 ダッシュボードの埋め込みを管理する」を参照してください。
- 公開されたダッシュボードを共有する : 公開されたダッシュボードの共有設定とアクセス許可をさまざまなユーザーグループで構成します。ダッシュボード の共有を参照してください。