BI 接続
BI 接続は、プロジェクトが所有する、ダッシュボードを表示するシステムへのアクセスです。Grafana ではそのアドレスとサービスアカウントトークン、Power BI では Microsoft Entra アプリ（サービスプリンシパル）とそのクライアントシークレット、Tableau では接続アプリとユーザー、Web ページではサインインが必要なダッシュボードを表示するサイトのサービスアカウント、またはサインイン済みブラウザーのクッキーを指定します。接続 ID は bic_ で始まります。シークレットはサーバー上で封印され、二度と表示されません。読み取りでは secret {set, hint} と表示されます（hint は 12 文字以上のシークレットの末尾 4 文字）。接続は 1 つのプロジェクトに属します。bi connection list、show、browse には読み取りアクセスが必要で、それ以外のコマンドにはすべて Manage アクセスが必要です。BI ダッシュボードのないプランでは、接続またはビューの作成と変更（資格情報の置き換えを除く）に対して feature_not_in_plan（終了コード 8）が返ります。プランの一覧は価格設定ページにあります。
シークレットはファイルで渡します: Grafana は --token-file、Power BI と Tableau は --secret-file、Web ページは --password-file、--totp-file、--cookies-file です。いずれも標準入力には - を指定でき、引数では渡せません。Web 接続の --steps スクリプトも同様です。1 つのコマンドで標準入力を読むオプションは最大 1 つです。
ビューは、接続の 1 つのダッシュボード、レポート、ページを、その embed_url を表示する iframe プリミティブを通じて再生します；bi view create --connection-id ID でビューを作成します。サインインが必要なダッシュボードを表示するでは Web 接続の手順を説明し、API リファレンスではすべての種類を扱います。
bi connection create grafana#
Grafana 接続を追加します: そのアドレスとサービスアカウントトークン。
bi connection create grafana --url URL --token-file FILE [--name NAME] [--org-id N]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
--url URL | string | はい | なし | 公開ホスト上の Grafana のアドレス。パスのプレフィックスも指定できます: https://grafana.example.com または https://example.com/grafana。プライベート、ループバック、予約済みのアドレスは invalid_request（終了コード 8）になり、Grafana はリダイレクトせずに応答する必要があります。 |
--token-file FILE | string | はい | なし | サービスアカウントトークンをこのファイルから、または標準入力を表す - から読み取ります（引数では渡しません）；ファイルにはトークンだけを入れます。 |
--name NAME | string | いいえ | ホスト名 | 1～80文字。 |
--org-id N | integer | いいえ | 1 | トークンが属する Grafana の組織: 1 以上の整数。 |
screenrig bi connection create grafana --url https://grafana.example.com --token-file token.txt
screenrig bi connection create grafana --url https://example.com/grafana --token-file - --name "Ops Grafana" --org-id 2Grafana で、Grafana Image Renderer プラグインまたはリモートレンダリングサービスをインストールし（ダッシュボードを画像として描画するもので、ないと何もレンダリングされません）、Viewer ロールのサービスアカウントを作成してトークンを追加します。次に bi connection test を実行します。
bi connection create tableau#
Tableau 接続を追加します: 接続アプリ（ダイレクトトラスト）、スクリーンのビューの表示に使うユーザー、アプリのシークレットの値。
bi connection create tableau --url URL --client-id ID --secret-id ID --username USER
--secret-file FILE [--site SITE] [--name NAME]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
--url URL | string | はい | なし | Tableau Server の https アドレス、または https://10ay.online.tableau.com のようなご利用の Tableau Cloud の pod のアドレス（online.tableau.com ではなく pod）。 |
--site SITE | string | いいえ | Tableau Server のデフォルトサイト | サイトのコンテンツ URL。ビューのアドレスで /site/ または /t/ の後ろにある部分。 |
--client-id ID | string | はい | なし | 接続アプリのクライアント ID。 |
--secret-id ID | string | はい | なし | 接続アプリ用に生成したシークレットのシークレット ID。 |
--username USER | string | はい | なし | スクリーンのビューの表示に使う Tableau ユーザー（Tableau Cloud ではメールアドレス）。 |
--secret-file FILE | string | はい | なし | シークレットの値をこのファイルから、または標準入力を表す - から読み取ります（引数では渡しません）；ファイルにはシークレットの値だけを入れ、シークレット ID は入れません。 |
--name NAME | string | いいえ | ホスト名 | 1～80文字。 |
screenrig bi connection create tableau --url https://10ay.online.tableau.com --site lobby --client-id 11111111-2222-3333-4444-555555555555 --secret-id 66666666-7777-8888-9999-000000000000 --username screens@example.com --secret-file secret.txtTableau で一度だけ設定します。設定の接続アプリで、ダイレクトトラストの接続アプリを作成し、そのクライアント ID をコピーし、シークレットを生成してシークレット ID とシークレットの値をコピーし、アプリとシークレットを有効にします。スクリーンが表示に使う Tableau ユーザーを選ぶか作成し、スクリーンが表示するビューだけにアクセスを与えてください: スクリーンのチケットを持つ人は、そのユーザーが見られるどのビューでも埋め込めます。次に bi connection show ID を実行し、その embed_origin のホストを接続アプリのドメイン許可リストに入力します。Tableau Cloud または Tableau Server 2023.3 以降が必要です；スクリーンから Tableau ホストに到達でき、スクリーンのブラウザーがそのホストからのサードパーティクッキーを受け入れる必要があります。次に bi connection test を実行し、その後 bi connection browse でビューを探します。
bi connection create powerbi#
Power BI 接続を追加します: Microsoft Entra アプリ（サービスプリンシパル）とそのクライアントシークレット、またはこのプロジェクトの Microsoft 接続。
bi connection create powerbi
(--tenant-id ID --client-id ID --secret-file FILE | --connection-id ID) [--name NAME]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
--tenant-id ID | string | --connection-id なし | なし | ご自身の Microsoft Entra の Directory (tenant) ID、または contoso.onmicrosoft.com のようなそのドメイン；common、organizations、consumers は指定できません。--client-id と --secret-file とともに指定します。 |
--client-id ID | string | --connection-id なし | なし | アプリ登録の Application (client) ID。 |
--secret-file FILE | string | --connection-id なし | なし | クライアントシークレットの値をこのファイルから、または標準入力を表す - から読み取ります（引数では渡しません）；ファイルにはシークレットの値だけを入れ、シークレット ID は入れません。 |
--connection-id ID | string | --tenant-id なし | なし | --tenant-id、--client-id、--secret-file の代わりに、このプロジェクトのモード own_app の Microsoft 接続（pcn_…）を通じてサインインします。screenrig_app 接続は拒否されます。これらとは併用できません。 |
--name NAME | string | いいえ | Power BI | 1～80文字。 |
screenrig bi connection create powerbi --tenant-id 11111111-2222-3333-4444-555555555555 --client-id aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --secret-file secret.txt
screenrig bi connection create powerbi --connection-id pcn_01EXAMPLECONNECTION0000 --name "Contoso Power BI"一度だけ設定します。Microsoft Entra で、アプリ登録（シングルテナント、リダイレクト URI なし、API のアクセス許可なし）とクライアントシークレットを作成します。Power BI の管理者は、管理ポータルのテナント設定、開発者設定で、Embed content in apps と Service principals can call Fabric public APIs を、組織全体、またはアプリを含むセキュリティグループに対してオンにします。表示する各ワークスペースに、アプリを Member または Admin ロールで追加します；Member が最小のアクセスです。本番の埋め込みでは、ワークスペースが Fabric (F)、Power BI Embedded (A)、Premium (P/EM) のいずれかの容量上にある必要があります。商用クラウドのみ。次に bi connection test を実行し、その後 bi connection browse でワークスペースとレポートを探します。
bi connection create web#
Web 接続を追加します: サインインが必要なダッシュボードを表示するサイトのサービスアカウント、またはサインイン済みブラウザーのクッキー。
bi connection create web --login-mode auto|steps|none [--login-url URL] [--username USER]
[--password-file FILE] [--totp-file FILE] [--steps FILE] [--cookies-file FILE] [--name NAME]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
--login-mode MODE | string | はい | なし | auto は、--login-url のフォームに --username とパスワードを入力します。steps は --steps のスクリプトを実行します。none は何もサインインしないため、ページは --cookies-file のクッキーセットで表示され、--login-url、--username、--password-file、--totp-file、--steps はいずれも指定できません。 |
--login-url URL | string | auto または steps とともに | なし | 公開ホスト上にある、サイトのサインインページの https アドレス。パスワードを入力するのはそのページとスクリプトの goto ステップだけで、ビューのアドレスに入力することはありません。 |
--username USER | string | auto とともに | なし | サービスアカウントのユーザー名。steps スクリプトでは {{username}} として読み取られます。 |
--password-file FILE | string | auto とともに | なし | サービスアカウントのパスワードをこのファイルから、または標準入力を表す - から読み取ります（引数では渡しません）；スペースは使え、末尾の改行はすべて取り除かれます。 |
--totp-file FILE | string | いいえ | なし | アカウントの認証アプリ用にサイトが表示する base32 キー（16〜128 文字）、またはその otpauth://totp アドレスを、このファイルまたは - から読み取ります（コードはサーバーが計算します）。 |
--steps FILE | string | steps とともに | なし | サインインスクリプト。最大 30 ステップの JSON 配列で、ファイルまたは - から読み込みます。アクション: goto（url）、fill（selector、value）、click、wait_for（selector）、press（Enter などの value、任意で selector）、wait_ms（ms、1～10000）。値には {{username}}、{{password}}、{{otp}} を含められますが、シークレット自体は含められません。auto とは併用できません。 |
--cookies-file FILE | string | いいえ | なし | サインイン済みのブラウザーからエクスポートしたクッキーセット。クッキーの JSON 配列（クッキー拡張機能のエクスポート）、または cookies 配列を持つオブジェクト（Playwright のストレージ状態）を、ファイルまたは - から読み込み、最大 100 件です。送信されるのは name、value、domain、path、expires、httpOnly、secure、sameSite だけです。 |
--name NAME | string | いいえ | サインインのホスト、または Web page（--login-mode none 使用時） | 1～80文字。 |
screenrig bi connection create web --login-mode auto --login-url https://login.example.com/signin --username screens@example.com --password-file password.txt --name "Ops dashboard"
screenrig bi connection create web --login-mode steps --login-url https://login.example.com/signin --username screens@example.com --password-file password.txt --steps steps.json
screenrig bi connection create web --login-mode none --cookies-file cookies.json --name "Signed-in jar"パスワード、キー、クッキーは封印され、二度と表示されません: 設定済みかどうかは data.secret と data.totp_secret が、サインインの状況は data.session が示します（idle、active、login_needed、paused、stopped、expired のいずれか）。読み取り専用のサービスアカウントを使ってください。拒否されたサインインは 5 分待ち、その後 15 分、60 分、120 分待ちます。5 回連続すると、認証情報またはサインイン設定が変更されるまで接続が停止します。電話でサインインを承認するサイト、デバイスを確認するサイト、CAPTCHA を表示するサイトはスクリプト化できません: クッキーセットを使ってください。ページレンダラーがないサーバーは bi_web_unavailable（終了コード 5）を返します。次に bi connection test を実行します。
bi connection list#
このプロジェクトの BI 接続を、種類、マスクされたシークレット、直近のテストとともに一覧表示します。
bi connection listパラメーターなし。
screenrig bi connection listdata.items にはプロジェクトのすべての接続が入ります。シークレットは返されません。
bi connection show#
接続とその直近のテストを確認します。
bi connection show <id>| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | 接続（bic_…）。 |
screenrig bi connection show bic_01EXAMPLECONNECTION0000応答には、kind、config（Grafana では url と org_id、Power BI では tenant_id と client_id、または Microsoft 接続がサインインする場合は connection_id、Tableau では url、site、client_id、secret_id、username、Web 接続では login_mode、login_url、username、steps）、secret {set, hint}、embed_origin（プロジェクトの埋め込みホストで、接続アプリのドメイン許可リストで指定するもの）、last_test が含まれます。Web 接続には totp_secret {set} と session も含まれます：その state、cookies の件数、cookies_updated_at、last_login_at、login_failures、retry_at です。
bi connection update#
接続の名前、アドレス、組織、テナント、アプリ、サイト、ユーザー、シークレット、または Web 接続の場合はそのサインインとクッキーを変更します。
bi connection update <id> [--name NAME] [--url URL] [--org-id N] [--tenant-id ID] [--client-id ID]
[--site SITE | --default-site] [--secret-id ID] [--username USER]
[--token-file FILE | --secret-file FILE | --password-file FILE | --clear-password]
[--login-mode auto|steps|none] [--login-url URL] [--totp-file FILE | --clear-totp]
[--steps FILE] [--cookies-file FILE | --clear-cookies] [--expect-rev REVISION]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | 接続（bic_…）。 |
--name NAME | string | いいえ | 変更なし | 接続の名前を変更します。 |
--url URL | string | いいえ | 変更なし | Grafana、または Tableau のサーバーか pod の新しいアドレス。 |
--org-id N | integer | いいえ | 変更なし | トークンが属する Grafana の組織。 |
--tenant-id ID | string | いいえ | 変更なし | Power BI 接続の Microsoft Entra テナント。 |
--client-id ID | string | いいえ | 変更なし | Power BI 接続の Application (client) ID、または Tableau 接続アプリのクライアント ID。 |
--site SITE | string | いいえ | 変更なし | Tableau 接続のサイトコンテンツ URL。--default-site とは併用できません。 |
--default-site | boolean | いいえ | オフ | Tableau Server: デフォルトサイトにサインインします。--site とは併用できません。 |
--secret-id ID | string | いいえ | 変更なし | Tableau 接続アプリのシークレット ID。 |
--username USER | string | いいえ | 変更なし | スクリーンのビューの表示に使う Tableau ユーザー、または Web 接続のサービスアカウント。 |
--token-file FILE | string | いいえ | 変更なし | Grafana: サービスアカウントトークンをこのファイルから、または標準入力を表す - から読み取ります；保存済みのトークンが置き換えられます。--token-file、--secret-file、--password-file、--clear-password のうち指定できるのは 1 つまでです。 |
--secret-file FILE | string | いいえ | 変更なし | Power BI または Tableau: シークレットの値をこのファイルから、または標準入力を表す - から読み取ります；保存済みのシークレットが置き換えられます。 |
--login-mode MODE | string | いいえ | 変更なし | Web: サインインの方法（auto、steps、none のいずれか）。 |
--login-url URL | string | いいえ | 変更なし | Web: サイトのサインインページの https アドレス。新しいオリジンには同じコマンドで --password-file が必要で、保存済みのパスワードが、指定していないページに送られることはありません。 |
--password-file FILE | string | いいえ | 変更なし | Web: サービスアカウントのパスワードをこのファイルから、または標準入力を表す - から読み取ります；保存済みのパスワードが置き換えられます。 |
--clear-password | boolean | いいえ | オフ | Web: 保存済みのパスワードを削除します。 |
--totp-file FILE | string | いいえ | 変更なし | Web: 認証アプリのキーをこのファイルから、または標準入力を表す - から読み取ります；保存済みのキーが置き換えられます。--clear-totp とは併用できません。 |
--clear-totp | boolean | いいえ | オフ | Web: 保存済みの認証アプリのキーを削除します。--totp-file とは併用できません。 |
--steps FILE | string | いいえ | 変更なし | Web: サインインスクリプト（最大 30 ステップの JSON 配列）を、ファイルまたは - から読み込んで置き換えます。 |
--cookies-file FILE | string | いいえ | 変更なし | Web: ファイルまたは - から、サインイン済みのブラウザーからエクスポートしたクッキーセット（bi connection create web が受け付ける形式）に置き換えます。--clear-cookies とは併用できません。 |
--clear-cookies | boolean | いいえ | オフ | Web: 保存済みのクッキーセットを削除します。--cookies-file とは併用できません。 |
--expect-rev REVISION | integer | いいえ | なし | 接続がこのリビジョンでない限り変更を拒否します（revision_conflict、終了コード 6）。 |
screenrig bi connection update bic_01EXAMPLECONNECTION0000 --token-file new-token.txt
screenrig bi connection update bic_01EXAMPLECONNECTION0000 --password-file new-password.txt
screenrig bi connection update bic_01EXAMPLECONNECTION0000 --clear-totp --clear-cookies
screenrig bi connection update bic_01EXAMPLECONNECTION0000 --url https://grafana.example.com --token-file new-token.txt --name "Ops Grafana" --expect-rev 2少なくとも 1 つの変更が必要で、省略したシークレットは保持されます。別のホスト、スキーム、ポートの新しいアドレスには、同じコマンドで --token-file（Grafana）または --secret-file（Tableau）が必要です: 保存済みのシークレットは、保存時のアドレスにしか送信されません。新しいアドレス、組織、テナント、アプリ、サイト、ユーザー、シークレットは last_test を消去し、接続のビュー用にキャッシュされたレンダリングをすべて破棄するので、もう一度テストしてください。認証情報またはサインイン設定を変更すると、停止していた Web セッションが解除されます。
bi connection test#
認証情報を確認します: Grafana のトークンと Image Renderer、Power BI のアプリとそのワークスペース、Tableau のサインイン、または Web 接続のサインイン。
bi connection test <id>| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | 接続（bic_…）。 |
screenrig bi connection test bic_01EXAMPLECONNECTION0000Grafana: token（Grafana が受け入れること）と image_renderer（プラグインが一覧にあること。ない場合は警告のみで、リモートレンダリングサービスはプラグインとして表示されないため）。Power BI: token（Microsoft Entra がアプリ向けにトークンを発行したこと）と workspaces（アプリから見えるワークスペース。なければ失敗し、拒否された場合は、テナントの開発者設定とワークスペースでのアプリのメンバーまたは管理者のロールが示されます）。Tableau: 接続のユーザーとしての signin（コンテンツ読み取りトークン付き）に続いてサインアウトします。Web: login はサービスアカウントとしてサインインし、そのサインインページを描画します。何にもサインインしない Web 接続にはテストするサインインがないため警告が返り、bi view test がそのクッキーを確認します。拒否はベンダー自身の回答を含む失敗したチェックで、結果は last_test として保存されます。このテストは、Tableau のドメイン許可リスト、容量、行レベルセキュリティ、ダッシュボードの権限は判定しません: ビューを実際に確認するのは bi view test です。
bi connection browse#
接続が表示できるものを一覧表示します: Grafana のダッシュボードとパネル、Power BI のワークスペースとレポート、または Tableau のビュー。
bi connection browse <id> [--query TEXT] [--dashboard UID] [--workspace ID]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | 接続（bic_…）。 |
--query TEXT | string | いいえ | なし | 名前が一致するダッシュボード、ワークスペース、レポート、ビューのみ。最大 200 文字。 |
--dashboard UID | string | いいえ | なし | Grafana: 代わりにこのダッシュボードのパネルを一覧表示します。--workspace とは併用できません。 |
--workspace ID | string | いいえ | なし | Power BI: 代わりにこのワークスペースのレポートを GUID で指定して一覧表示します。--dashboard とは併用できません。 |
screenrig bi connection browse bic_01EXAMPLECONNECTION0000 --query lobby
screenrig bi connection browse bic_01EXAMPLECONNECTION0000 --dashboard abc123
screenrig bi connection browse bic_01EXAMPLECONNECTION0000 --workspace f089354e-8366-4e18-aea3-4cb4a3a50b48 --query salesdata.items は、Grafana ではトークンで表示できる各ダッシュボードの uid、title、folder、tags を、--dashboard を付けるとそのパネルの id、title、type を一覧表示します（行は平坦化されるため、折りたたまれた行の中のパネルも一覧に含まれます）；Power BI ではアプリから見える各ワークスペースの id と name を、--workspace を付けるとそのレポートの id、name、embed_url を一覧表示します；Tableau では接続のユーザーから見える各ビューの path（Workbook/View の形式）と name を一覧表示します。これらの値は bi view create で使います。Web 接続は何も一覧表示しません。各 Web ビューにはそのページのアドレスを指定します。
bi connection delete#
どのビューも使っていない接続を削除します。
bi connection delete <id> [--expect-rev REVISION]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | 接続（bic_…）。 |
--expect-rev REVISION | integer | いいえ | なし | 接続がこのリビジョンでない限り削除を拒否します（revision_conflict、終了コード 6）。 |
screenrig bi connection delete bic_01EXAMPLECONNECTION0000ビューがその接続を使っている間は、それらを示して resource_conflict（終了コード 5）が返ります；先にそれらのビューを削除してください。応答は data.id と data.deleted true です。
BI ビュー
ビューは、Grafana 接続の 1 つのダッシュボードまたはパネル、Power BI ワークスペースの 1 つのレポート、Tableau サイトの 1 つのビュー、Web 接続の 1 つのページ、または接続が不要な公開リンク（Grafana の公開ダッシュボード、Power BI の Publish to web リンク、Tableau Public のビジュアライゼーション）です。ビュー ID は biv_ で始まり、ビューは自身のプロジェクトのスクリーンでのみ再生されます。
ビューの embed_url を、content_fit fill を指定した iframe プリミティブに入れて、通常どおり公開します: プレイリストは認証情報を保持しません。Grafana と Web のビューは、--refresh ごとにサーバー上で画像として描画され、同じサイズのすべてのスクリーンで共有されます。そのため、ロビーのスクリーン 10 台でもレンダリングは 1 回で、スクリーンがシステムと通信することはありません；キャプチャが失敗している間は、最後の正常な画像が画面上に残ります。Power BI のレポートと Tableau のビューは、サーバーが生成して更新する表示専用トークンで埋め込まれ、スクリーンがシークレットを保持することはありません。画像が描画されるのは、スクリーンのマニフェストがそのビューを指定している間だけです。
読み取りには読み取りアクセスが必要で、変更にはすべて Manage アクセスが必要です。各ターゲットフラグは特定の種類の接続に対応し、使う値は bi connection browse ID で一覧表示されます。
bi view create#
接続のダッシュボード、パネル、レポート、Tableau ビュー、または公開リンクのビューを追加します。
bi view create (--connection-id ID (--url URL | --dashboard UID | --workspace ID --report ID | --view WORKBOOK/VIEW)
| --public-url URL) [--name NAME] [--refresh DURATION] [--fit contain|cover|fill] [--rotate DURATION]
[--panel ID] [--from TIME] [--to TIME] [--var NAME=VALUE]... [--theme dark|light] [--timezone ZONE]
[--page NAME]... [--all-pages] [--rotate-sheets] [--wait-for CSS] [--wait-ms MS] [--clip CSS]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
--connection-id ID | string | --public-url なし | なし | 表示元の接続（bic_…）。 |
--url URL | string | ターゲット 1 つ | なし | 接続の Grafana ホスト上のダッシュボードのアドレス、Power BI のレポートのアドレス、Tableau のビューのアドレス、または Web 接続の場合は公開ホスト上のページの https アドレス。ターゲットの残りの部分はそこから読み取られるため、--panel、--from、--to、--var、--theme、--timezone、--page、--all-pages のいずれも併用できません。 |
--dashboard UID | string | ターゲット 1 つ | なし | Grafana: ダッシュボードの uid。アドレスの /d/ の後ろにある部分。 |
--workspace ID | string | ターゲット 1 つ | なし | Power BI: ワークスペース ID。--report とともに指定します。 |
--report ID | string | --workspace とともに | なし | Power BI: レポート ID。--workspace とともに指定します。 |
--view WORKBOOK/VIEW | string | ターゲット 1 つ | なし | Tableau: ビュー。アドレスの /views/ の後ろにある名前（一覧は bi connection browse）。 |
--public-url URL | string | ターゲット 1 つ | なし | Grafana の公開ダッシュボードリンク、Power BI の Publish to web リンク、または Tableau Public のビジュアライゼーションのアドレス。接続は不要で、ホストからライブで再生されます。単独で、または --name、--refresh、--fit、--rotate-sheets、--rotate とともに指定します。 |
--name NAME | string | いいえ | ターゲットから | 1～80文字。 |
--refresh DURATION | string | いいえ | 5m | Grafana: 画像を再描画する頻度、30s から 24h。Web: ページを再描画する頻度、60s から 24h。Power BI と Tableau: レポートまたはビューがデータを更新する頻度、60s から 24h、更新しない場合は 0。30s、5m、1h のような期間、または秒数で指定します。 |
--fit FIT | string | いいえ | contain | Grafana と Web: 画像がスクリーンを埋める方法（contain、cover、fill のいずれか）。 |
--rotate DURATION | string | いいえ | なし | Power BI: 各ページを表示する時間、10s から 1h；--page を 2 つ以上指定する場合、または --all-pages を指定する場合に必要です。Tableau: 各シートを表示する時間；--rotate-sheets を指定する場合に必要です。 |
--page NAME | string | いいえ | なし | Power BI: 表示するページ（名前または表示名で指定）。1～200 文字。繰り返し指定できます；ページはこの順序で表示されます。 |
--all-pages | boolean | いいえ | オフ | Power BI: 表示されるすべてのページを順に切り替えます。--rotate とともに指定します。 |
--rotate-sheets | boolean | いいえ | オフ | Tableau: ワークブックの公開済みシートを切り替えます。--rotate とともに指定します。 |
--panel ID | string | いいえ | ダッシュボード全体 | Grafana: ダッシュボード全体ではなく、このパネル 1 つを表示します。アドレスの viewPanel と同じ整数です。 |
--from TIME | string | いいえ | なし | Grafana: 時間範囲の始点（now-6h、now/d、ミリ秒単位のエポックなど）。 |
--to TIME | string | いいえ | なし | Grafana: 時間範囲の終点（now、now/d、ミリ秒単位のエポックなど）。 |
--var NAME=VALUE | string | いいえ | なし | Grafana: ダッシュボード変数。NAME には var- プレフィックスを付けられ、値は最大 200 文字です。繰り返し指定できます。 |
--theme THEME | string | いいえ | dark | Grafana のテーマ（dark または light）。 |
--timezone ZONE | string | いいえ | なし | Grafana: ダッシュボードのタイムゾーン（Europe/Paris、utc、browser など）。 |
--wait-for CSS | string | いいえ | なし | Web: ページの準備ができたとき、かつサインイン済みの場合にだけ表示される要素の CSS セレクター。キャプチャはその要素を待ち、表示されないと bi_web_timeout で失敗します。 |
--wait-ms MS | integer | いいえ | なし | Web: 遅れて表示されるチャートのために、ページの準備ができてから待つミリ秒数、0〜10000。 |
--clip CSS | string | いいえ | ページ全体 | Web: 描画するページの部分の CSS セレクター。 |
screenrig bi view create --connection-id bic_01EXAMPLECONNECTION0000 --url 'https://grafana.example.com/d/abc123/lobby?orgId=1&viewPanel=4' --refresh 5m
screenrig bi view create --connection-id bic_01EXAMPLECONNECTION0000 --dashboard abc123 --panel 4 --from now-6h --to now --var host=web1 --theme light --name "Web CPU"
screenrig bi view create --public-url https://grafana.example.com/public-dashboards/TOKEN --name "Public status"
screenrig bi view create --connection-id bic_01EXAMPLECONNECTION0000 --workspace f089354e-8366-4e18-aea3-4cb4a3a50b48 --report 5b218778-e7a5-4d73-8187-f10824047715 --page Overview --page Detail --rotate 30s --name "Sales rotation"
screenrig bi view create --connection-id bic_01EXAMPLECONNECTION0000 --view Sales/Overview --rotate-sheets --rotate 30s --refresh 0 --name "Sales sheets"
screenrig bi view create --connection-id bic_01EXAMPLECONNECTION0000 --url https://app.example.com/dashboards/42 --refresh 5m --wait-for '#dashboard.loaded' --wait-ms 1500 --clip '#chart-grid'ターゲットはちょうど 1 つ指定します: --url、--dashboard、--report を付けた --workspace、--view、--public-url のいずれか。応答には data.embed_url が含まれます。次に bi view test を実行します。
Grafana: --url は、アドレスから orgId、viewPanel または panelId、from、to、var-*、theme、timezone を読み取ります。画像は Grafana のレンダリングサービスで描画され、同じサイズのすべてのスクリーンで共有されます。Grafana が停止している間、スクリーンはレンダリング時刻を隅に表示した最後の画像を保持します。公開ダッシュボードのリンクは Grafana からライブで再生されるため、Grafana は埋め込みを許可している必要があります（設定で allow_embedding = true）: bi view test で確認できます。
Power BI: --url には、Power BI からコピーしたレポートのアドレス https://app.powerbi.com/groups/WORKSPACE/reports/REPORT を指定し、任意で /ReportSection のページを付けられます；または --workspace と --report を指定します。2 ページ以上には --rotate が必要で、--rotate には 2 ページ以上または --all-pages が必要です。--refresh 0 は、DirectQuery や自動ページ更新のレポートのように、自身で更新されるレポートに適しています。--fit は適用されません。Publish to web リンクは、リンクを知っている全員にレポートを表示し、Power BI が提供するとおりに再生され、--refresh ごとに再読み込みされ、ページの切り替えはありません。
Tableau: --url には、Tableau からコピーしたビューのアドレス https://HOST/t/SITE/views/WORKBOOK/VIEW、Tableau Cloud の https://HOST/#/site/SITE/views/WORKBOOK/VIEW、または WORKBOOK/VIEW だけを指定できます；アドレスは接続のホストとサイト上にある必要があります。--rotate-sheets と --rotate は互いに他方が必要です。--fit は適用されません。スクリーンから Tableau ホストに到達でき、そのホストのサードパーティクッキーを受け入れる必要があり、ビューの embed_origin は接続アプリのドメイン許可リストに含まれている必要があります。Tableau Public のビジュアライゼーション（--public-url https://public.tableau.com/app/profile/USER/viz/WORKBOOK/VIEW、またはその /views/ アドレス）には、接続もトークンも不要で、--rotate-sheets もそこで使えます。
Web: --url はページのアドレスで、--wait-for、--wait-ms、--clip は Web ビューにのみ適用されます。キャプチャが失敗しても、最後の正常な画像は画面上に残り、理由は status.last_error に示されます（bi_web_login_failed、bi_web_otp_required、bi_web_session_expired、bi_web_login_paused、bi_web_timeout、bi_web_navigation_failed、bi_web_blocked のいずれか）。
bi view list#
このプロジェクトの BI ビューを、ターゲット、頻度、ステータスとともに一覧表示します。
bi view listパラメーターなし。
screenrig bi view listdata.items にはプロジェクトのすべてのビューが、それぞれの embed_url とともに入ります。
bi view show#
ビューを確認します。embed_url と、画面上での直近の状況を表示します。
bi view show <id>| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | ビュー（biv_…）。 |
screenrig bi view show biv_01EXAMPLEVIEW0000000000応答には kind、name、connection_id（公開リンクにはありません）、target（Tableau では view と rotate_sheets）、refresh_s、rotate_s、fit、status、embed_url、revision が含まれます。Web ビューには wait_for、wait_ms、clip も含まれます。status は last_ok_at と last_error を保持し、それぞれ code と detail を持ちます：Grafana がトークンを拒否した場合は bi_upstream_refused、レンダリングできなかった場合は bi_upstream_unavailable、または Web ビューの bi_web_* コードのいずれかです。
bi view update#
ビューの名前、ターゲット、頻度、フィットを変更します。
bi view update <id> [--name NAME] [--refresh DURATION] [--fit contain|cover|fill] [--rotate DURATION]
[--url URL | --dashboard UID | --workspace ID | --view WORKBOOK/VIEW | --public-url URL] [--report ID]
[--page NAME]... [--all-pages] [--rotate-sheets] [--panel ID] [--from TIME] [--to TIME]
[--var NAME=VALUE]... [--theme dark|light] [--timezone ZONE] [--wait-for CSS | --clear-wait-for]
[--wait-ms MS] [--clip CSS | --clear-clip] [--expect-rev REVISION]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | ビュー（biv_…）。 |
--name NAME | string | いいえ | 変更なし | ビューの名前を変更します。 |
--url URL | string | いいえ | 変更なし | ダッシュボード、レポート、Tableau ビューのアドレス、または Web ビューのページアドレス；ターゲット全体を置き換えます。他のターゲットフラグとは併用できません。 |
--dashboard UID | string | いいえ | 変更なし | Grafana: このダッシュボードを表示します；ターゲット全体を置き換えます。 |
--workspace ID | string | いいえ | 変更なし | Power BI: このワークスペースのレポートを表示します。--report とともに指定します；ターゲット全体を置き換えます。 |
--report ID | string | いいえ | 変更なし | Power BI: このレポートを、--workspace で指定したワークスペースまたは現在のワークスペースから表示します。 |
--view WORKBOOK/VIEW | string | いいえ | 変更なし | Tableau: このビューを表示します；ターゲット全体を置き換えます。 |
--public-url URL | string | いいえ | 変更なし | 公開リンク；ターゲット全体を置き換えます。 |
--rotate-sheets | boolean | いいえ | オフ | Tableau: ワークブックの公開済みシートを切り替えます。--rotate とともに指定します。 |
--page NAME | string | いいえ | 変更なし | Power BI: 表示するページ（名前または表示名で指定）。繰り返し指定できます；現在のページを置き換えます。 |
--all-pages | boolean | いいえ | オフ | Power BI: 表示されるすべてのページを順に切り替えます。 |
--rotate DURATION | string | いいえ | 変更なし | Power BI: 各ページを表示する時間、10s から 1h、1 ページの場合は 0。Tableau: 各シートを表示する時間、切り替えを停止する場合は 0。 |
--panel ID | string | いいえ | 変更なし | Grafana: このパネル 1 つを表示します。 |
--from TIME | string | いいえ | 変更なし | Grafana: 時間範囲の始点。 |
--to TIME | string | いいえ | 変更なし | Grafana: 時間範囲の終点。 |
--var NAME=VALUE | string | いいえ | 変更なし | Grafana: ダッシュボード変数を設定します。繰り返し指定できます；1 つの変数を設定し、他の変数は保持されます。 |
--theme THEME | string | いいえ | 変更なし | Grafana のテーマ（dark または light）。 |
--timezone ZONE | string | いいえ | 変更なし | Grafana: ダッシュボードのタイムゾーン。 |
--refresh DURATION | string | いいえ | 変更なし | 画像を再描画する、またはレポートを更新する頻度: Grafana は 30s から 24h；Web は 60s から 24h；Power BI と Tableau は 60s から 24h、なしの場合は 0。 |
--fit FIT | string | いいえ | 変更なし | Grafana と Web: 画像がスクリーンを埋める方法（contain、cover、fill のいずれか）。 |
--wait-for CSS | string | いいえ | 変更なし | Web: ページの準備ができ、サインイン済みのときに表示される要素。--clear-wait-for とは併用できません。 |
--clear-wait-for | boolean | いいえ | オフ | Web: 要素を待つのをやめます。--wait-for とは併用できません。 |
--wait-ms MS | integer | いいえ | 変更なし | Web: ページの準備ができてから待つミリ秒数、0〜10000；0 で待機がなくなります。 |
--clip CSS | string | いいえ | 変更なし | Web: 描画するページの部分。--clear-clip とは併用できません。 |
--clear-clip | boolean | いいえ | オフ | Web: ページ全体を描画し直します。--clip とは併用できません。 |
--expect-rev REVISION | integer | いいえ | なし | ビューがこのリビジョンでない限り変更を拒否します（revision_conflict、終了コード 6）。 |
screenrig bi view update biv_01EXAMPLEVIEW0000000000 --wait-for '#dashboard.loaded' --wait-ms 2000
screenrig bi view update biv_01EXAMPLEVIEW0000000000 --clear-wait-for --clear-clip
screenrig bi view update biv_01EXAMPLEVIEW0000000000 --theme light --var host=web2
screenrig bi view update biv_01EXAMPLEVIEW0000000000 --dashboard def456 --panel 2 --expect-rev 3
screenrig bi view update biv_01EXAMPLEVIEW0000000000 --page Overview --page Detail --rotate 45s
screenrig bi view update biv_01EXAMPLEVIEW0000000000 --view Sales/Detail少なくとも 1 つの変更が必要です。--url、--dashboard、--workspace、--public-url はターゲット全体を置き換え、--panel、--from、--to、--var、--theme、--timezone はビューの現在の Grafana ターゲットを、--report、--page、--all-pages は Power BI のターゲットを、--view と --rotate-sheets は Tableau のターゲットを変更します。--page はページの一覧を置き換えます；消去するには、--workspace と --report をもう一度 --rotate 0 とともに指定します。--rotate 0 だけを指定すると、Tableau ビューはシートの切り替えを停止します。--url と --public-url は --rotate-sheets 以外のターゲットフラグと併用できず、公開リンクのビューは --public-url でのみターゲットを変更できます。新しいターゲットはステータスを消去し、キャッシュ済みレンダリングを破棄し、スクリーンは再公開しなくても、次の更新で変更を取得します。ビューは接続と種類を保持します。
bi view test#
ビューを実際に確認します: Grafana または Web のレンダリング、Power BI の埋め込みトークン、Tableau の検索、または公開リンク。
bi view test <id> [--output FILE [--width PIXELS] [--height PIXELS]]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | ビュー（biv_…）。 |
--output FILE | string | いいえ | なし | Grafana または Web: チェックを実行する代わりに、レンダリングした PNG をここに保存します。Power BI または Tableau のビューと公開リンクには PNG がありません（not_found）。 |
--width PIXELS | integer | いいえ | 1920 | 保存する画像の幅、1〜10000。--output が必要です。 |
--height PIXELS | integer | いいえ | 1080 | 保存する画像の高さ、1〜10000。--output が必要です。 |
screenrig bi view test biv_01EXAMPLEVIEW0000000000
screenrig bi view test biv_01EXAMPLEVIEW0000000000 --output lobby.png --width 1920 --height 1080Grafana: 接続ビューは、共有キャッシュを使わず、ビューのステータスにも触れずに、実際にレンダリングされます。Grafana がトークンを拒否した場合、レンダラーがない場合、ダッシュボードを認識しない場合、data.ok は Grafana の理由とともに false になります；失敗したテストもデータであり、終了コードは 0 です。Web: 接続ビューは、共有キャッシュの外で、サーバーのブラウザー（render）で 1 回描画され、描画に失敗すると理由が示されます。公開前に、保存された PNG を開いて確認してください。公開リンクでは、テストはページを取得し、Grafana がビューの埋め込みページのフレーム化を許可していることを確認します。
Tableau: 接続ビューは接続のユーザーとしてサインインしてビューを検索します（signin、view）；ユーザーが見られないビューや、大文字小文字が違う名前は、パスを示す view チェックの失敗になります。Tableau Public のビューは、ワークブックが存在するかを Tableau Public に問い合わせます。Power BI: 接続ビューはレポートを読み取り（report）、そのための実際の表示専用の埋め込みトークンを生成します（embed_token）；拒否された場合は、行レベルセキュリティのあるデータセット、401 または 403（テナント設定またはワークスペースのロール）、アプリから見えないレポートなど、Power BI 自身の理由が表示されます。Publish to web リンクは取得され、そのフレーミングヘッダーが読み取られます。
このテストは、画像の内容、ビューが指定するページ、容量、Tableau のドメイン許可リストは判定しません。data には at、ok、checks が入り、各チェックは name、ok、任意の warn、detail を持ちます。Grafana または Web のレンダリングでは width、height、bytes が加わります。--output を指定すると、代わりに data に id、file、bytes、width、height が入ります。
bi view delete#
ビューを削除します。
bi view delete <id> [--expect-rev REVISION]| パラメーター | タイプ | 必須 | デフォルト | メモ |
|---|---|---|---|---|
<id> | string | はい | なし | ビュー（biv_…）。 |
--expect-rev REVISION | integer | いいえ | なし | ビューがこのリビジョンでない限り削除を拒否します（revision_conflict、終了コード 6）。 |
screenrig bi view delete biv_01EXAMPLEVIEW0000000000
screenrig bi view delete biv_01EXAMPLEVIEW0000000000 --expect-rev 3ビューの embed_url をまだ表示しているスクリーンは、プレイリストが変わるまで not_found を返します。応答は data.id と data.deleted true です。