Codatum Docs

Appearance

署名付き埋め込み ​

概要 ​

署名付き埋め込みは、ノートブックの公開時点の内容を外部サイトやアプリに埋め込む機能です。埋め込み先の認証システムと組み合わせて利用し、Codatum へのログインは不要です。認証には APIキー と、サーバー側で発行するトークンを使います。

利用可否はプランにより異なります。

閲覧者はパラメータの変更と SQL の再実行ができます。ダウンロードとエクスプローラは公開時のオプションで制御します。コメントは利用できません。共有方法の比較は 共有 を参照してください。

組み込み手順は 組み込み手順 を、テナントごとのデータ分離は マルチテナント を参照してください。フロントエンドへの組み込みには、公開リポジトリの Codatum Embed SDK（@codatum/embed / @codatum/embed-react / @codatum/embed-vue）を利用できます。

主な機能 ​

公開 ​

公開には、公開元ノートブックの公開権限と、公開対象ページに含まれるコネクションの公開権限が必要です。共有フォルダ経由のノートブックは公開できません。

  1. ノートブック画面の 共有 を開き、署名付き埋め込み タブを選びます
  2. 署名付き埋め込みを作成 を選びます
  3. 次を設定して 公開 します
項目説明
署名付き埋め込み名埋め込みの名前です。既定はノートブック名です。アイコン（絵文字）を付けられます
公開ページ公開するページです。セクション区切り を除く、少なくとも1ページが必要です。既定は全ページです
埋め込みコネクション公開対象ページから自動で抽出されます。対象コネクションの公開権限が必要です
ダウンロードを有効化埋め込み閲覧者がソースデータをダウンロードできます。既定は無効です
エクスプローラを有効化埋め込み閲覧者がソースデータを探索できます。既定は無効です

公開後は、一覧から次の操作ができます。

  • 名前または 設定 から設定・プレビュー画面を開きます
  • 変更を公開: ノートブックの変更や公開時オプションの変更を反映します
  • 現在のノートブックと比較
  • 削除

ノートブック本体の変更は自動では反映されません。反映するには 変更を公開 が必要です。ダウンロードとエクスプローラの変更にも再公開が必要です。

設定 ​

設定画面では、次を変更できます。

項目説明
署名付き埋め込み名埋め込みの表示名です
権限を付与するAPIキートークン発行に使える APIキーです。少なくとも1つ必要です
サーバーサイドパラメータトークン発行時にサーバー側で値を指定するパラメータです。ここで指定しないパラメータはクライアントサイドパラメータになります
許可されたオリジン埋め込みを許可するオリジンです。http:// または https:// で始まる値を指定します。未設定の場合は、任意のオリジンからの埋め込みを許可します
公開時のオプションダウンロードとエクスプローラの設定です。変更には再公開が必要です

サーバーサイドパラメータ ​

各パラメータについて、次のいずれかを選べます。

種類説明
固定値サーバーサイドで固定された値です。ユーザーは値を変更できず、入力フォームも非表示になります
初期値初期値を設定しますが、ユーザーはフロントエンドの入力フォームから値を変更できます

固定値の変更には、トークンの再発行が必要です。詳細は マルチテナント を参照してください。

仕様 ​

  • 埋め込み内の SQL 実行やダウンロード、エクスプローラには、コネクション権限は不要です
  • トークンのデフォルト有効期限は 3600 秒（1 時間）、最大は 86400 秒です（制約と上限値）
  • cache_max_age を省略した場合の既定は 86400 秒です。最大も 86400 秒です
  • 作成数にはプランによる上限があります（制約と上限値）
  • 署名付き埋め込み タブは、ワークスペースで署名付き埋め込み機能が有効な場合に表示されます

公開できない場合 ​

次を確認してください。

  1. 公開元ノートブックの公開権限があるか（共有フォルダ経由のノートブックは公開できません）
  2. 公開対象ページに含まれるコネクションの公開権限があるか
  3. 署名付き埋め込み数の上限に達していないか（グローバルナビ > ワークスペース設定 > 使用量）
  4. 署名付き埋め込み タブが表示されない場合は、ワークスペースで機能が有効かを確認してください

© Codatum Inc.