BI-Dashboards: CLI-Befehle

Fügt eine Grafana-Verbindung hinzu: ihre Adresse und ein Dienstkonto-Token.

bi connection create grafana --url URL --token-file FILE [--name NAME] [--org-id N]

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 2

Installieren Sie in Grafana das Plugin Grafana Image Renderer oder den Remote-Rendering-Dienst (er zeichnet Dashboards als Bilder; ohne ihn wird nichts gerendert), erstellen Sie dann ein Dienstkonto mit der Rolle Viewer und fügen Sie ein Token hinzu. Führen Sie als Nächstes bi connection test aus.

Fügt eine Tableau-Verbindung hinzu: eine verbundene App (Direct Trust), den Benutzer, als der die Ansichten der Bildschirme angezeigt werden, und den Secret-Wert der App.

bi connection create tableau --url URL --client-id ID --secret-id ID --username USER
    --secret-file FILE [--site SITE] [--name NAME]

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.txt

Einmalig in Tableau einrichten: Erstellen Sie unter Settings, Connected Apps eine verbundene App vom Typ Direct trust, kopieren Sie ihre Client ID, erzeugen Sie ein Secret, kopieren Sie die Secret ID und den Secret-Wert und aktivieren Sie die App und das Secret. Wählen Sie den Tableau-Benutzer, den die Bildschirme zeigen, oder legen Sie ihn an, und geben Sie ihm nur Zugriff auf die Ansichten, die Bildschirme zeigen: Wer das Ticket eines Bildschirms hält, kann jede Ansicht einbetten, die dieser Benutzer sehen kann. Führen Sie dann bi connection show ID aus und tragen Sie den Host von embed_origin in die Domain-Allowlist der verbundenen App ein. Erforderlich ist Tableau Cloud oder Tableau Server 2023.3 oder neuer; die Bildschirme müssen den Tableau-Host erreichen, und ihr Browser muss Cookies von Drittanbietern von ihm akzeptieren. Führen Sie als Nächstes bi connection test aus und dann bi connection browse, um eine Ansicht zu finden.

Fügt eine Power-BI-Verbindung hinzu: eine Microsoft-Entra-App (Dienstprinzipal) und ihr Client-Secret oder eine Microsoft-Verbindung dieses Projekts.

bi connection create powerbi
    (--tenant-id ID --client-id ID --secret-file FILE | --connection-id ID) [--name NAME]

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"

Einmalig einrichten. Erstellen Sie in Microsoft Entra eine App-Registrierung (nur ein Mandant, keine Weiterleitungs-URI, keine API-Berechtigungen) und ein Client-Secret. Ein Power-BI-Administrator aktiviert im Admin-Portal unter Mandanteneinstellungen, Entwicklereinstellungen die Einstellungen Embed content in apps und Service principals can call Fabric public APIs, für die gesamte Organisation oder für eine Sicherheitsgruppe, die die App enthält. Fügen Sie die App jedem Arbeitsbereich, den Sie zeigen, mit der Rolle Mitglied oder Administrator hinzu; Mitglied ist der geringste Zugriff. Für das Einbetten in der Produktion muss der Arbeitsbereich auf einer Kapazität vom Typ Fabric (F), Power BI Embedded (A) oder Premium (P/EM) liegen. Nur kommerzielle Cloud. Führen Sie als Nächstes bi connection test aus, dann bi connection browse, um einen Arbeitsbereich und einen Bericht zu finden.

Fügt eine Web-Verbindung hinzu: ein Dienstkonto einer Website, die ein Dashboard hinter einer Anmeldung zeigt, oder die Cookies eines angemeldeten Browsers.

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]

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"

Das Passwort, der Schlüssel und die Cookies werden versiegelt und nie wieder angezeigt: data.secret und data.totp_secret sagen, ob sie gesetzt sind, und data.session sagt, wie es um die Anmeldung steht (idle, active, login_needed, paused, stopped oder expired). Verwenden Sie ein Dienstkonto mit reinem Lesezugriff. Eine abgelehnte Anmeldung wartet 5 Minuten, dann 15, 60 und 120, und die fünfte in Folge stoppt die Verbindung, bis sich ihre Zugangsdaten oder Anmeldeeinstellungen ändern. Eine Website, die Anmeldungen auf einem Telefon genehmigt, Geräte prüft oder ein CAPTCHA zeigt, lässt sich nicht skripten: Verwenden Sie einen Cookie-Satz. Ein Server ohne den Seiten-Renderer antwortet mit bi_web_unavailable (Exit 5). Führen Sie als Nächstes bi connection test aus.

Listet die BI-Verbindungen dieses Projekts mit ihrer Art, dem maskierten Secret und dem letzten Test auf.

bi connection list

Keine Parameter.

screenrig bi connection list

data.items enthält jede Verbindung des Projekts; es wird kein Secret zurückgegeben.

Zeigt eine Verbindung und ihren letzten Test.

bi connection show <id>

screenrig bi connection show bic_01EXAMPLECONNECTION0000

Die Antwort enthält kind, config (url und org_id für Grafana; tenant_id und client_id für Power BI oder connection_id, wenn sich eine Microsoft-Verbindung anmeldet; url, site, client_id, secret_id und username für Tableau; login_mode, login_url, username und steps für eine Web-Verbindung), secret {set, hint}, embed_origin (der Einbettungs-Host des Projekts, den die Domain-Allowlist einer verbundenen App nennt) und last_test. Eine Web-Verbindung enthält außerdem totp_secret {set} und session: state, die cookies-Anzahl sowie cookies_updated_at, last_login_at, login_failures und retry_at.

Ändert Name, Adresse, Organisation, Mandant, App, Site, Benutzer oder Secret einer Verbindung oder, bei einer Web-Verbindung, ihre Anmeldung und ihre Cookies.

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]

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

Mindestens eine Änderung ist erforderlich, und ein ausgelassenes Secret bleibt erhalten. Eine neue Adresse mit anderem Host, Schema oder Port braucht im selben Befehl --token-file (Grafana) oder --secret-file (Tableau): Das gespeicherte Secret wird nur an die Adresse gesendet, für die es gespeichert wurde. Eine Änderung von Adresse, Organisation, Mandant, App, Site, Benutzer oder Secret löscht last_test und verwirft jedes für die Ansichten der Verbindung zwischengespeicherte Rendering: Testen Sie die Verbindung erneut. Eine Änderung der Zugangsdaten oder Anmeldeeinstellungen hebt eine gestoppte Web-Sitzung auf.

Prüft die Zugangsdaten: Token und Image Renderer von Grafana, App und Arbeitsbereiche von Power BI, die Anmeldung bei Tableau oder die Anmeldung einer Web-Verbindung.

bi connection test <id>

screenrig bi connection test bic_01EXAMPLECONNECTION0000

Grafana: token (Grafana akzeptiert es) und image_renderer (das Plugin ist aufgeführt; Grafana ohne es warnt nur, weil ein Remote-Rendering-Dienst nicht als Plugin erscheint). Power BI: token (Microsoft Entra hat eines für die App ausgestellt) und workspaces (die Arbeitsbereiche, die die App sehen kann; ist keiner sichtbar, schlägt die Prüfung fehl, und eine Ablehnung nennt die Entwicklereinstellungen des Mandanten und die Rolle Mitglied oder Administrator der App im Arbeitsbereich). Tableau: signin als Benutzer der Verbindung mit einem Token zum Lesen von Inhalten, gefolgt von einer Abmeldung. Web: login meldet sich als Dienstkonto an und zeichnet seine Anmeldeseite; eine Web-Verbindung, die sich nirgends anmeldet, hat keine Anmeldung zu testen und antwortet daher mit einer Warnung, und bi view test prüft ihre Cookies. Eine Ablehnung ist eine fehlgeschlagene Prüfung, die die eigene Antwort des Anbieters trägt, und das Ergebnis wird als last_test gespeichert. Der Test beurteilt weder eine Domain-Allowlist von Tableau noch Kapazität, Zeilensicherheit oder die Berechtigungen eines Dashboards: bi view test prüft eine Ansicht wirklich.

Listet auf, was eine Verbindung anzeigen kann: Grafana-Dashboards und -Panels, Power-BI-Arbeitsbereiche und -Berichte oder Tableau-Ansichten.

bi connection browse <id> [--query TEXT] [--dashboard UID] [--workspace ID]

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 sales

data.items listet für Grafana je Dashboard, das das Token anzeigen kann, uid, title, folder und tags auf, oder mit --dashboard je Panel des Dashboards id, title und type (Zeilen werden abgeflacht, sodass auch ein Panel in einer eingeklappten Zeile aufgeführt wird); für Power BI je Arbeitsbereich, den die App sehen kann, id und name, oder mit --workspace je Bericht des Arbeitsbereichs id, name und embed_url; für Tableau je Ansicht, die der Benutzer der Verbindung sehen kann, path (als Workbook/View) und name. Verwenden Sie diese Werte mit bi view create. Eine Web-Verbindung listet nichts auf: Jede Web-Ansicht nimmt die Adresse ihrer Seite.

Löscht eine Verbindung, die keine Ansicht nutzt.

bi connection delete <id> [--expect-rev REVISION]

screenrig bi connection delete bic_01EXAMPLECONNECTION0000

Solange Ansichten sie nutzen, lautet die Antwort resource_conflict (Exit 5) und nennt sie: Löschen Sie diese Ansichten zuerst. Die Antwort ist data.id und data.deleted true.

Fügt eine Ansicht für ein Dashboard, ein Panel, einen Bericht oder eine Tableau-Ansicht einer Verbindung oder für einen öffentlichen Link hinzu.

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]

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'

Geben Sie genau ein Ziel an: --url, --dashboard, --workspace mit --report, --view oder --public-url. Die Antwort enthält data.embed_url. Führen Sie als Nächstes bi view test aus.

Grafana: --url liest orgId, viewPanel oder panelId, from, to, var-*, theme und timezone aus der Adresse. Das Bild wird über den Rendering-Dienst von Grafana gezeichnet und von jedem Bildschirm derselben Größe geteilt, und ein Bildschirm behält das letzte Bild, mit der Zeit des Renderings in einer Ecke, solange Grafana ausgefallen ist. Ein öffentlicher Dashboard-Link wird live von Grafana abgespielt, das Einbettung erlauben muss (allow_embedding = true in seinen Einstellungen): bi view test prüft das.

Power BI: --url nimmt eine aus Power BI kopierte Berichtsadresse entgegen, https://app.powerbi.com/groups/WORKSPACE/reports/REPORT, mit optionaler Seite /ReportSection; oder geben Sie --workspace und --report an. Zwei oder mehr Seiten brauchen --rotate, und --rotate braucht zwei oder mehr Seiten oder --all-pages. --refresh 0 eignet sich für einen DirectQuery-Bericht oder einen Bericht mit automatischer Seitenaktualisierung, der sich selbst aktualisiert. --fit gilt nicht. Ein Publish-to-web-Link zeigt den Bericht jedem, der den Link hat, und wird so abgespielt, wie Power BI ihn ausliefert, alle --refresh neu geladen, ohne Seitenrotation.

Tableau: --url nimmt eine aus Tableau kopierte Ansichtsadresse entgegen, https://HOST/t/SITE/views/WORKBOOK/VIEW, https://HOST/#/site/SITE/views/WORKBOOK/VIEW von Tableau Cloud oder nur WORKBOOK/VIEW; die Adresse muss auf dem Host und der Site der Verbindung liegen. --rotate-sheets und --rotate setzen einander voraus. --fit gilt nicht. Die Bildschirme müssen den Tableau-Host erreichen und seine Cookies von Drittanbietern akzeptieren, und die embed_origin der Ansicht muss in der Domain-Allowlist der verbundenen App stehen. Eine Tableau-Public-Visualisierung (--public-url https://public.tableau.com/app/profile/USER/viz/WORKBOOK/VIEW oder ihre /views/-Adresse) braucht weder Verbindung noch Token, und --rotate-sheets funktioniert dort ebenfalls.

Web: --url ist die Adresse der Seite, und --wait-for, --wait-ms und --clip gelten nur für eine Web-Ansicht. Das letzte gute Bild bleibt auf dem Bildschirm, wenn eine Aufnahme fehlschlägt, und status.last_error sagt, warum: bi_web_login_failed, bi_web_otp_required, bi_web_session_expired, bi_web_login_paused, bi_web_timeout, bi_web_navigation_failed oder bi_web_blocked.

Listet die BI-Ansichten dieses Projekts mit Ziel, Rhythmus und Status auf.

bi view list

Keine Parameter.

screenrig bi view list

data.items enthält jede Ansicht des Projekts, jeweils mit ihrer embed_url.

Zeigt eine Ansicht, ihre embed_url und wie es ihr zuletzt auf dem Bildschirm erging.

bi view show <id>

screenrig bi view show biv_01EXAMPLEVIEW0000000000

Die Antwort enthält kind, name, connection_id (bei einem öffentlichen Link nicht vorhanden), target (view und rotate_sheets bei Tableau), refresh_s, rotate_s, fit, status, embed_url und revision; eine Web-Ansicht enthält außerdem wait_for, wait_ms und clip. status enthält last_ok_at und last_error mit code und detail: bi_upstream_refused, wenn Grafana das Token abgelehnt hat, bi_upstream_unavailable, wenn es nicht rendern konnte, oder einen der bi_web_*-Codes einer Web-Ansicht.

Ändert Name, Ziel, Rhythmus oder Anpassung einer Ansicht.

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]

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

Mindestens eine Änderung ist erforderlich. --url, --dashboard, --workspace und --public-url ersetzen das gesamte Ziel, während --panel, --from, --to, --var, --theme und --timezone das aktuelle Grafana-Ziel der Ansicht ändern, --report, --page und --all-pages das Power-BI-Ziel und --view und --rotate-sheets das Tableau-Ziel. --page ersetzt die Seitenliste; um sie zu leeren, geben Sie --workspace und --report erneut mit --rotate 0 an. --rotate 0 allein hindert eine Tableau-Ansicht daran, ihre Blätter zu rotieren. --url und --public-url nehmen keine andere Zieloption außer --rotate-sheets entgegen, und die Ansicht eines öffentlichen Links ändert ihr Ziel nur mit --public-url. Ein neues Ziel löscht den Status und verwirft die zwischengespeicherten Renderings, und Bildschirme übernehmen die Änderung bei ihrer nächsten Aktualisierung ohne erneutes Veröffentlichen. Eine Ansicht behält ihre Verbindung und Art.

Prüft eine Ansicht wirklich: über ein Grafana- oder Web-Rendering, ein Power-BI-Einbettungs-Token, eine Tableau-Abfrage oder einen öffentlichen Link.

bi view test <id> [--output FILE [--width PIXELS] [--height PIXELS]]

screenrig bi view test biv_01EXAMPLEVIEW0000000000
screenrig bi view test biv_01EXAMPLEVIEW0000000000 --output lobby.png --width 1920 --height 1080

Grafana: Eine Verbindungsansicht wird wirklich gerendert, außerhalb des gemeinsamen Caches und ohne den Status der Ansicht zu berühren. data.ok ist false mit dem Grund von Grafana, wenn es das Token ablehnt, keinen Renderer hat oder das Dashboard nicht kennt; ein fehlgeschlagener Test liefert Daten, Exit 0. Web: Eine Verbindungsansicht wird einmal im Browser des Servers gezeichnet (render), außerhalb des gemeinsamen Caches, und ein fehlgeschlagenes Zeichnen nennt den Grund. Öffnen Sie das gespeicherte PNG und sehen Sie es sich an, bevor Sie veröffentlichen. Bei einem öffentlichen Link ruft der Test die Seite ab und prüft, ob Grafana der Einbettungsseite der Ansicht erlaubt, sie einzubetten.

Tableau: Eine Verbindungsansicht meldet sich als Benutzer der Verbindung an und sucht die Ansicht (signin, view); eine Ansicht, die der Benutzer nicht sehen kann, oder ein Name mit falscher Groß-/Kleinschreibung ist eine fehlgeschlagene view-Prüfung, die den Pfad nennt. Eine Tableau-Public-Ansicht fragt Tableau Public, ob die Arbeitsmappe existiert. Power BI: Eine Verbindungsansicht liest den Bericht (report) und erzeugt dafür ein echtes Einbettungs-Token nur zur Ansicht (embed_token); der eigene Grund von Power BI wird angezeigt, wenn es ablehnt, etwa bei einem Dataset mit Zeilensicherheit, einem 401 oder 403 (Mandanteneinstellung oder Arbeitsbereichsrolle) oder einem Bericht, den die App nicht sehen kann. Ein Publish-to-web-Link wird abgerufen und seine Framing-Header werden gelesen.

Der Test beurteilt weder das, was das Bild zeigt, noch die Seiten, die die Ansicht nennt, noch die Kapazität noch eine Domain-Allowlist von Tableau. data enthält at, ok und checks, jede Prüfung mit name, ok, optional warn und detail; ein Grafana- oder Web-Rendering ergänzt width, height und bytes. Mit --output enthält data stattdessen id, file, bytes, width und height.

Löscht eine Ansicht.

bi view delete <id> [--expect-rev REVISION]

screenrig bi view delete biv_01EXAMPLEVIEW0000000000
screenrig bi view delete biv_01EXAMPLEVIEW0000000000 --expect-rev 3

Ein Bildschirm, der die embed_url der Ansicht noch zeigt, antwortet mit not_found, bis sich seine Playlist ändert. Die Antwort ist data.id und data.deleted true.