Appearance
ノートブックの共有
概要
ノートブックのスナップショット共有(レポート・署名付き埋め込み・パブリックリンク)を対象とするサブコマンド群です。公開中のスナップショットの一覧取得や、ノートブックの変更の差分確認・公開ができます。
| サブコマンド | 機能概要 |
|---|---|
notebook report list | ノートブックのレポートを一覧 |
notebook report diff | 変更を公開した場合の差分を確認 |
notebook report publish | ノートブックの変更を公開 |
notebook signed-embed list | ノートブックの署名付き埋め込みを一覧 |
notebook signed-embed diff | 変更を公開した場合の差分を確認 |
notebook signed-embed publish | ノートブックの変更を公開 |
notebook public-link list | ノートブックのパブリックリンクを一覧 |
notebook public-link diff | 変更を公開した場合の差分を確認 |
notebook public-link publish | ノートブックの変更を公開 |
以下では、個々のレポート・署名付き埋め込み・パブリックリンクを「公開先」と呼びます。
変更を公開する流れ
CLI からは、Web版で公開済みの公開先に、ノートブックの変更を公開できます。公開するページや公開時のオプションなどの設定は、前回の公開時のものを引き継ぎます。新規の公開と設定の変更は、Web版で行ってください。
サーバ上のノートブックを公開する
公開されるのは、サーバ上のノートブックです。ローカルで編集した場合は、SQL を実行して先にサーバへ反映してから公開します。
bash
cdm notebook run notebooks/sales.cnb.md
cdm notebook push notebooks/sales.cnb.md --yes
cdm notebook report diff notebooks/sales.cnb.md --report-id 6a01b2c3d4e5f60718293a51
cdm notebook report publish notebooks/sales.cnb.md --report-id 6a01b2c3d4e5f60718293a51WARNING
ノートブックの変更を公開するためには、ページ内に含まれる SQL が実行済で、その実行結果が有効期限内でなければなりません。
差分を確認してから公開する
diff で、公開すると閲覧者に見えるものがどう変わるかを確認できます。publish は差分のある公開先にだけ公開するため、変更がなければ公開処理はスキップされます。diff で確認した後にサーバ上のノートブックが編集された場合は、その変更も含めて公開されます。複数の公開先に公開する場合、公開先ごとにその時点の内容を公開するため、途中で編集されると内容が揃わない場合もあります。
差分と公開前の確認
差分
差分は「公開すると、閲覧者に見えるものが変わるか」で判定します。サーバ上のノートブックを公開した場合の内容と、公開中の内容を比べます。
- ページの内容や、パラメータ、カラーパレットなどの変更を差分とします
- 実行結果を埋め込んで公開する公開先では、SQL を実行し直しただけでも差分になります。詳細は、各
diffの説明を参照してください
公開前の確認
CLI から公開できるのは、安全に公開できる変更だけです。差分とは別に、公開する前に次のような変更がないかを確認します。
- 閲覧者が見られる範囲や操作できる範囲が、前回の公開より広がる変更
- 公開すると、閲覧者の画面が正しく動かなくなる変更
該当する変更がある公開先には、CLI から公開できません。確認の結果は、公開する前に diff で確かめられます。公開できない理由は error として表示します。error が表示された場合は、Web版で設定を見直してから公開してください。
判定の結果
diff と publish は、公開先ごとに次のいずれかを表示します。
| 表示 | 意味 |
|---|---|
changed | 差分があり、公開できます |
unchanged | 差分がなく、公開はスキップされます |
blocked | 差分があるが、公開前の確認で error があるため公開できない |
レポート
公開先の指定
<notebook|file>には、サーバ上のノートブック または ノートブックファイル を指定してください- ノートブックファイルを指定した場合、ファイルとサーバ上のノートブックが一致しないとき(ジョブ実行情報は除く)は
exit 1で終了します - 静的レポート と、公開時点のデータを埋め込み を有効にしたレポートが対象に含まれる場合は、ファイルにジョブ実行情報があれば、ジョブ実行情報も一致するかを確認します
- ノートブックファイルを指定した場合、ファイルとサーバ上のノートブックが一致しないとき(ジョブ実行情報は除く)は
- 公開先は
--report-idまたは--allで指定します--report-idには、レポートの ID または URL を指定します。複数指定できます--allはノートブックのすべてのレポートを対象にします- 両方を同時に指定した場合、またはどちらも指定しなかった場合は
exit 1で終了します
一覧
cdm notebook report list <notebook|file>
-f, --format <fmt> 出力形式: text | json(既定: text)
--profile <name> 利用する profile を指定指定したノートブックのレポートを列挙します。
<notebook|file>には、サーバ上のノートブック または ノートブックファイル を指定してください- レポートが 0 件の場合、text では
No reports foundを表示します(json では"reports": []) - ノートブック単体の閲覧権限もしくはフォルダの閲覧権限が必要です
出力例(text)
$ cdm notebook report list notebooks/sales.cnb.md
Id Name PublishedAt
6a01b2c3d4e5f60718293a51 Weekly KPI 2026-09-30T08:12:00Z
6a01b2c3d4e5f60718293a52 Sales Monthly 2026-09-12T02:40:00Z出力例(json)
json
{
"reports": [
{ "id": "6a01b2c3d4e5f60718293a51", "name": "Weekly KPI", "publishedAt": "2026-09-30T08:12:00Z" },
{ "id": "6a01b2c3d4e5f60718293a52", "name": "Sales Monthly", "publishedAt": "2026-09-12T02:40:00Z" }
]
}利用例
bash
# ノートブックファイルから一覧
cdm notebook report list notebooks/sales.cnb.md
# スクリプト用に JSON 出力
cdm notebook report list 671ef14b0d08cf6c657df7da -f json差分確認
cdm notebook report diff <notebook|file>
--report-id <id> 対象のレポート(複数指定可)
--all すべてのレポートを対象にする
-f, --format <fmt> 出力形式: text | json(既定: text)
--exit-code 差分がある場合に exit 2 を返す
--profile <name> 利用する profile を指定指定したレポートに publish した場合の差分と、公開前の確認の結果を出力します。
- 対象の指定は 公開先の指定 を参照してください
- 静的レポート と、公開時点のデータを埋め込み を有効にしたレポートでは、SQL を実行し直すと差分になります
- text では、差分のないレポートは出力しません。公開するページの差分は unified diff で出力します
--exit-codeを指定した場合、差分がある場合はexit 2で終了しますblockedのレポートがある場合は、--exit-codeの指定にかかわらずexit 1で終了します- ノートブック単体の閲覧権限もしくはフォルダの閲覧権限が必要です
出力例(text)
Summary: 2 changed, 1 blocked
Weekly KPI (6a01b2c3d4e5f60718293a51) changed
Changed: query results
Sales Monthly (6a01b2c3d4e5f60718293a52) changed
Changed: page "Sales Overview"
info: Fixed parameter "Region" on page "Sales Overview" will be removed because it is no longer used.
Region Report (6a01b2c3d4e5f60718293a53) blocked
Changed: page "Sales Overview"
error: Parameter "Segment" is now used on page "Sales Overview" but is not fixed. Fix it in the report on the web.
--- Sales Monthly (6a01b2c3d4e5f60718293a52, published)
+++ Sales Monthly (6a01b2c3d4e5f60718293a52, server)
@@ -12,7 +12,7 @@
-SELECT region, SUM(amount) FROM orders GROUP BY region
+SELECT region, SUM(amount) FROM orders WHERE status = 'completed' GROUP BY region出力例(json)
json
{
"summary": { "changed": 2, "unchanged": 0, "blocked": 1, "hasChange": true },
"results": [
{
"notebookId": "671ef14b0d08cf6c657df7da",
"path": "notebooks/sales.cnb.md",
"reports": [
{
"id": "6a01b2c3d4e5f60718293a51",
"name": "Weekly KPI",
"status": "changed",
"reasons": ["data"],
"changes": [],
"checks": [],
"patch": null
},
{
"id": "6a01b2c3d4e5f60718293a52",
"name": "Sales Monthly",
"status": "changed",
"reasons": ["content"],
"changes": [
{ "kind": "page", "pageId": "66a75e5c3a1402e7954373ca", "pageName": "Sales Overview", "change": "changed", "published": true }
],
"checks": [
{ "level": "info", "code": "FIXED_PARAM_REMOVED", "message": "Fixed parameter \"Region\" on page \"Sales Overview\" will be removed because it is no longer used." }
],
"patch": "--- Sales Monthly (6a01b2c3d4e5f60718293a52, published)\n+++ Sales Monthly (6a01b2c3d4e5f60718293a52, server)\n..."
},
{
"id": "6a01b2c3d4e5f60718293a53",
"name": "Region Report",
"status": "blocked",
"reasons": ["content"],
"changes": [
{ "kind": "page", "pageId": "66a75e5c3a1402e7954373ca", "pageName": "Sales Overview", "change": "changed", "published": true }
],
"checks": [
{ "level": "error", "code": "NEW_PARAM_NOT_FIXED", "message": "Parameter \"Segment\" is now used on page \"Sales Overview\" but is not fixed. Fix it in the report on the web." }
],
"patch": "--- Region Report (6a01b2c3d4e5f60718293a53, published)\n+++ Region Report (6a01b2c3d4e5f60718293a53, server)\n..."
}
]
}
]
}reasonsは差分の種類です。content(ページなどの内容)とdata(SQL の実行結果)がありますpatchは、公開するページに差分がない場合はnullです
利用例
bash
# すべてのレポートの差分を確認
cdm notebook report diff notebooks/sales.cnb.md --all
# CI で変更検知(差分があれば exit 2)
cdm notebook report diff notebooks/sales.cnb.md --all --exit-code変更の公開
cdm notebook report publish <notebook|file>
--report-id <id> 対象のレポート(複数指定可)
--all すべてのレポートを対象にする
-y, --yes 確認プロンプトをスキップして公開
--profile <name> 利用する profile を指定サーバ上のノートブックの変更を、指定したレポートに公開します。
- 対象の指定は 公開先の指定 を参照してください
- 公開するページ・レポート名・レポートタイプ・公開時のオプションは、前回の公開時のものを引き継ぎます
- Web版の 変更を一括公開 と同様に、利用しているアカウント(PAT の場合は発行者)はレポートの共有先に追加されず、レポートの共有先は変わりません
- Web版の 変更を公開 で公開した場合は、公開したアカウントがレポートの共有先にないと、そのアカウントが閲覧者として共有先に追加されます
- 差分のないレポートには公開しません
blockedのレポートが1件でもある場合は、どのレポートにも公開せずにexit 1で終了します- 公開前に確認プロンプトが表示されます
--yesを指定することで、確認をスキップできます
- 公開に失敗したレポートがある場合、残りのレポートには続けて公開し、
exit 1で終了します - 公開中に Ctrl-C を押すと公開を取り消し、残りには公開せずに
exit 1で終了します。Publishingと表示された後は取り消せないため、終わるまで待ちます - ノートブック単体の閲覧権限と公開権限の両方、もしくはフォルダの閲覧権限と公開権限の両方が必要です。あわせて、公開するページで使うコネクションの閲覧権限と公開権限が必要です
公開前の確認
| 状況 | 結果 |
|---|---|
| 固定パラメータを利用 していて、新たに使われるようになったパラメータが固定されていない | error |
| 固定パラメータの値が、パラメータの種類に合わなくなった | error |
| 公開していたページが削除された | error |
| 公開中の内容で使っているコネクションが削除された | error |
公開中の内容で使っているコネクションの公開権限がない(publish のときだけ確認します) | error |
| 固定パラメータが利用されなくなった(該当パラメータを固定パラメータから外して公開します) | info |
| ノートブックに追加したページがある(追加されたページは公開されません) | info |
出力例
Weekly KPI (6a01b2c3d4e5f60718293a51) changed
Sales Monthly (6a01b2c3d4e5f60718293a52) unchanged
2 reports processed: 1 changed, 1 unchanged
? Publish 1 report? (y/N)
✔ Weekly KPI published (12.4s)
✔ Published 1 report.
Weekly KPI
https://app.codatum.com/workspace/66a75e5c3a1402e7954373c0/report/6a01b2c3d4e5f60718293a51/利用例
bash
# 差分を確認してから公開
cdm notebook report diff notebooks/sales.cnb.md --report-id 6a01b2c3d4e5f60718293a51
cdm notebook report publish notebooks/sales.cnb.md --report-id 6a01b2c3d4e5f60718293a51
# 複数のレポートに公開
cdm notebook report publish notebooks/sales.cnb.md --report-id 6a01b2c3d4e5f60718293a51 --report-id 6a01b2c3d4e5f60718293a52
# 最新のデータで静的レポートを更新
cdm notebook run notebooks/sales.cnb.md --refresh
cdm notebook push notebooks/sales.cnb.md --yes
cdm notebook report publish notebooks/sales.cnb.md --report-id 6a01b2c3d4e5f60718293a51署名付き埋め込み
公開先の指定
<notebook|file>には、サーバ上のノートブック または ノートブックファイル を指定してください- ノートブックファイルを指定した場合、ファイルとサーバ上のノートブックが一致しないとき(ジョブ実行情報は除く)は
exit 1で終了します
- ノートブックファイルを指定した場合、ファイルとサーバ上のノートブックが一致しないとき(ジョブ実行情報は除く)は
- 公開先は
--signed-embed-idまたは--allで指定します--signed-embed-idには、署名付き埋め込みの ID または設定画面の URL を指定します。複数指定できます--allはノートブックのすべての署名付き埋め込みを対象にします- 両方を同時に指定した場合、またはどちらも指定しなかった場合は
exit 1で終了します
一覧
cdm notebook signed-embed list <notebook|file>
-f, --format <fmt> 出力形式: text | json(既定: text)
--profile <name> 利用する profile を指定指定したノートブックの署名付き埋め込みを列挙します。
<notebook|file>には、サーバ上のノートブック または ノートブックファイル を指定してください- 署名付き埋め込みが 0 件の場合、text では
No signed embeds foundを表示します(json では"signedEmbeds": []) - ノートブック単体の閲覧権限もしくはフォルダの閲覧権限が必要です
出力例(text)
$ cdm notebook signed-embed list notebooks/sales.cnb.md
Id Name PublishedAt
6a01b2c3d4e5f60718293a4b Partner Portal 2026-09-30T08:12:00Z
6a01b2c3d4e5f60718293a4c Customer Portal 2026-09-12T02:40:00Zjson では、レポートの一覧 と同じ形で、キーが signedEmbeds になります。
利用例
bash
# ノートブックファイルから一覧
cdm notebook signed-embed list notebooks/sales.cnb.md差分確認
cdm notebook signed-embed diff <notebook|file>
--signed-embed-id <id> 対象の署名付き埋め込み(複数指定可)
--all すべての署名付き埋め込みを対象にする
-f, --format <fmt> 出力形式: text | json(既定: text)
--exit-code 差分がある場合に exit 2 を返す
--profile <name> 利用する profile を指定指定した署名付き埋め込みに publish した場合の差分と、公開前の確認の結果を出力します。
- 対象の指定は 公開先の指定 を参照してください
- 署名付き埋め込みは閲覧のたびに SQL を実行するため、SQL を実行し直しただけでは差分になりません
- text では、差分のない署名付き埋め込みは出力しません。公開するページの差分は unified diff で出力します
--exit-codeを指定した場合、差分がある場合はexit 2で終了しますblockedの署名付き埋め込みがある場合は、--exit-codeの指定にかかわらずexit 1で終了します- ノートブック単体の閲覧権限もしくはフォルダの閲覧権限が必要です
出力例(text)
Summary: 1 changed, 1 unchanged, 1 blocked
Partner Portal (6a01b2c3d4e5f60718293a4b) changed
Changed: page "Sales Overview"
info: Pages added to the notebook are not published: "Draft"
Customer Portal (6a01b2c3d4e5f60718293a4c) blocked
Changed: page "Sales Overview"
error: Parameter "Segment" is now used on page "Sales Overview" but is not a server-side parameter. Set it in the signed embed settings on the web.
--- Partner Portal (6a01b2c3d4e5f60718293a4b, published)
+++ Partner Portal (6a01b2c3d4e5f60718293a4b, server)
@@ -12,7 +12,7 @@
-SELECT region, SUM(amount) FROM orders GROUP BY region
+SELECT region, SUM(amount) FROM orders WHERE status = 'completed' GROUP BY regionjson では、レポートの差分確認 と同じ形で、キーが signedEmbeds になります。
利用例
bash
# すべての署名付き埋め込みの差分を確認
cdm notebook signed-embed diff notebooks/sales.cnb.md --all
# CI で変更検知(差分があれば exit 2)
cdm notebook signed-embed diff notebooks/sales.cnb.md --all --exit-code変更の公開
cdm notebook signed-embed publish <notebook|file>
--signed-embed-id <id> 対象の署名付き埋め込み(複数指定可)
--all すべての署名付き埋め込みを対象にする
-y, --yes 確認プロンプトをスキップして公開
--profile <name> 利用する profile を指定サーバ上のノートブックの変更を、指定した署名付き埋め込みに公開します。
- 対象の指定は 公開先の指定 を参照してください
- 公開するページ・署名付き埋め込み名・公開時のオプションは、前回の公開時のものを引き継ぎます
- 差分のない署名付き埋め込みには公開しません
blockedの署名付き埋め込みが1件でもある場合は、どの署名付き埋め込みにも公開せずにexit 1で終了します- 公開前に確認プロンプトが表示されます
--yesを指定することで、確認をスキップできます
- 公開に失敗した署名付き埋め込みがある場合、残りには続けて公開し、
exit 1で終了します - 公開中に Ctrl-C を押すと公開を取り消し、残りには公開せずに
exit 1で終了します。Publishingと表示された後は取り消せないため、終わるまで待ちます - ノートブック単体の閲覧権限と公開権限の両方、もしくはフォルダの閲覧権限と公開権限の両方が必要です。あわせて、公開するページで使うコネクションの閲覧権限と公開権限が必要です
公開前の確認
| 状況 | 結果 |
|---|---|
| 新たに使われるようになったパラメータが、サーバーサイドパラメータにない | error |
| サーバーサイドパラメータが、削除されたパラメータを指している | error |
| サーバーサイドパラメータに指定したパラメータの種類が変わった | error |
| 公開していたページが削除された | error |
| 公開中の内容で使っているコネクションが削除された | error |
公開中の内容で使っているコネクションの公開権限がない(publish のときだけ確認します) | error |
| ノートブックに追加したページがある(追加されたページは公開されません) | info |
出力例
Partner Portal (6a01b2c3d4e5f60718293a4b) changed
Customer Portal (6a01b2c3d4e5f60718293a4c) unchanged
2 signed embeds processed: 1 changed, 1 unchanged
? Publish 1 signed embed? (y/N)
✔ Partner Portal published (4.6s)
✔ Published 1 signed embed.
Partner Portal
https://app.codatum.com/workspace/66a75e5c3a1402e7954373c0/notebook/671ef14b0d08cf6c657df7da/integration/6a01b2c3d4e5f60718293a4b利用例
bash
# 差分を確認してから公開
cdm notebook signed-embed diff notebooks/sales.cnb.md --signed-embed-id 6a01b2c3d4e5f60718293a4b
cdm notebook signed-embed publish notebooks/sales.cnb.md --signed-embed-id 6a01b2c3d4e5f60718293a4b
# 複数の署名付き埋め込みに公開
cdm notebook signed-embed publish notebooks/sales.cnb.md --signed-embed-id 6a01b2c3d4e5f60718293a4b --signed-embed-id 6a01b2c3d4e5f60718293a4cパブリックリンク
公開先の指定
<notebook|file>には、サーバ上のノートブック または ノートブックファイル を指定してください- ノートブックファイルを指定した場合、ファイルとサーバ上のノートブックが一致しないとき(ジョブ実行情報は除く)は
exit 1で終了します - ファイルにジョブ実行情報がある場合は、ジョブ実行情報も一致するかを確認します
- ノートブックファイルを指定した場合、ファイルとサーバ上のノートブックが一致しないとき(ジョブ実行情報は除く)は
- 公開先は
--public-link-idまたは--allで指定します--public-link-idには、パブリックリンクの ID または URL を指定します。複数指定できます--allはノートブックのすべてのパブリックリンクを対象にします。有効期限が切れたものは対象から外します- 両方を同時に指定した場合、またはどちらも指定しなかった場合は
exit 1で終了します
一覧
cdm notebook public-link list <notebook|file>
-f, --format <fmt> 出力形式: text | json(既定: text)
--profile <name> 利用する profile を指定指定したノートブックのパブリックリンクを列挙します。
<notebook|file>には、サーバ上のノートブック または ノートブックファイル を指定してください- 有効期限が切れたパブリックリンクも表示します。
ExpiresAtは、有効期限がない場合は-、有効期限が切れた場合はexpiredを表示します - パブリックリンクが 0 件の場合、text では
No public links foundを表示します(json では"publicLinks": []) - ノートブック単体の閲覧権限もしくはフォルダの閲覧権限が必要です
出力例(text)
$ cdm notebook public-link list notebooks/sales.cnb.md
Id Name PublishedAt ExpiresAt
6a01b2c3d4e5f60718293a61 Public KPI 2026-09-30T08:12:00Z 2026-10-30T08:12:00Z
6a01b2c3d4e5f60718293a62 Press Kit 2026-09-12T02:40:00Z -
6a01b2c3d4e5f60718293a63 Event Report 2026-07-01T00:00:00Z expired出力例(json)
レポートの一覧 の項目に加えて、expiresAt(有効期限がない場合は null)と expired を出力します。
json
{
"publicLinks": [
{ "id": "6a01b2c3d4e5f60718293a61", "name": "Public KPI", "publishedAt": "2026-09-30T08:12:00Z", "expiresAt": "2026-10-30T08:12:00Z", "expired": false },
{ "id": "6a01b2c3d4e5f60718293a62", "name": "Press Kit", "publishedAt": "2026-09-12T02:40:00Z", "expiresAt": null, "expired": false },
{ "id": "6a01b2c3d4e5f60718293a63", "name": "Event Report", "publishedAt": "2026-07-01T00:00:00Z", "expiresAt": "2026-07-31T00:00:00Z", "expired": true }
]
}利用例
bash
# ノートブックファイルから一覧
cdm notebook public-link list notebooks/sales.cnb.md差分確認
cdm notebook public-link diff <notebook|file>
--public-link-id <id> 対象のパブリックリンク(複数指定可)
--all すべてのパブリックリンクを対象にする
-f, --format <fmt> 出力形式: text | json(既定: text)
--exit-code 差分がある場合に exit 2 を返す
--profile <name> 利用する profile を指定指定したパブリックリンクに publish した場合の差分と、公開前の確認の結果を出力します。
- 対象の指定は 公開先の指定 を参照してください
- パブリックリンクは実行結果を埋め込んで公開するため、SQL を実行し直すと差分になります
- text では、差分のないパブリックリンクは出力しません。ただし、
--allで有効期限が切れたため対象から外したものは、infoとともに出力します。公開するページの差分は unified diff で出力します --exit-codeを指定した場合、差分がある場合はexit 2で終了しますblockedのパブリックリンクがある場合は、--exit-codeの指定にかかわらずexit 1で終了します- ノートブック単体の閲覧権限もしくはフォルダの閲覧権限が必要です
出力例(text)
Summary: 1 changed, 1 unchanged
Public KPI (6a01b2c3d4e5f60718293a61) changed
Changed: query results
info: The link will expire 30 days after publishing.json では、レポートの差分確認 と同じ形で、キーが publicLinks になります。
利用例
bash
# すべてのパブリックリンクの差分を確認
cdm notebook public-link diff notebooks/sales.cnb.md --all
# CI で変更検知(差分があれば exit 2)
cdm notebook public-link diff notebooks/sales.cnb.md --all --exit-code変更の公開
cdm notebook public-link publish <notebook|file>
--public-link-id <id> 対象のパブリックリンク(複数指定可)
--all すべてのパブリックリンクを対象にする
-y, --yes 確認プロンプトをスキップして公開
--profile <name> 利用する profile を指定サーバ上のノートブックの変更を、指定したパブリックリンクに公開します。
- 対象の指定は 公開先の指定 を参照してください
- 公開するページ・リンク名・有効期限の設定は、前回の公開時のものを引き継ぎます
- 有効期限を有効にしている場合、有効期限は公開した時点から再計算されます(延長されます)
- 差分のないパブリックリンクには公開しません
blockedのパブリックリンクが1件でもある場合は、どのパブリックリンクにも公開せずにexit 1で終了します- 公開前に確認プロンプトが表示されます
--yesを指定することで、確認をスキップできます
- 公開に失敗したパブリックリンクがある場合、残りには続けて公開し、
exit 1で終了します - 公開中に Ctrl-C を押すと公開を取り消し、残りには公開せずに
exit 1で終了します。Publishingと表示された後は取り消せないため、終わるまで待ちます - ワークスペースポリシーでパブリックリンクの作成・更新が禁止されている場合は、公開できません
- ノートブック単体の閲覧権限と公開権限の両方、もしくはフォルダの閲覧権限と公開権限の両方が必要です。あわせて、公開するページで使うコネクションの閲覧権限と公開権限が必要です
公開前の確認
| 状況 | 結果 |
|---|---|
有効期限が切れている(--public-link-id で指定した場合) | error |
| 公開していたページが削除された | error |
| 公開中の内容で使っているコネクションが削除された | error |
公開中の内容で使っているコネクションの公開権限がない(publish のときだけ確認します) | error |
有効期限が切れている(--all で指定した場合。対象から外します) | info |
| 有効期限を有効にしている(公開後の新しい有効期限を表示します) | info |
| ノートブックに追加したページがある(追加されたページは公開されません) | info |
有効期限が切れたパブリックリンクを再び公開する場合は、Web版で行ってください。
出力例
Public KPI (6a01b2c3d4e5f60718293a61) changed
info: The link will expire 30 days after publishing.
Press Kit (6a01b2c3d4e5f60718293a62) unchanged
2 public links processed: 1 changed, 1 unchanged
? Publish 1 public link? (y/N)
✔ Public KPI published (64.2s)
✔ Published 1 public link.
Public KPI
https://app.codatum.com/public/workspace/66a75e5c3a1402e7954373c0/link/6a01b2c3d4e5f60718293a61/notebook/671ef14b0d08cf6c657df7da/利用例
bash
# 差分を確認してから公開
cdm notebook public-link diff notebooks/sales.cnb.md --public-link-id 6a01b2c3d4e5f60718293a61
cdm notebook public-link publish notebooks/sales.cnb.md --public-link-id 6a01b2c3d4e5f60718293a61
# 最新のデータでパブリックリンクを更新
cdm notebook run notebooks/sales.cnb.md --refresh
cdm notebook push notebooks/sales.cnb.md --yes
cdm notebook public-link publish notebooks/sales.cnb.md --public-link-id 6a01b2c3d4e5f60718293a61