Tableaux de bord BI : commandes CLI

Ajoutez une connexion Grafana : son adresse et un jeton de compte de service.

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

Dans Grafana, installez le plugin Grafana Image Renderer ou le service de rendu distant (il dessine les tableaux de bord sous forme d’images ; sans lui, rien n’est dessiné), puis créez un compte de service avec le rôle Viewer et ajoutez un jeton. Exécutez ensuite bi connection test.

Ajoutez une connexion Tableau : une application connectée (direct trust), l’utilisateur sous lequel les vues des écrans sont affichées, et la valeur du secret de l’application.

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

À configurer une seule fois dans Tableau : sous Settings, Connected Apps, créez une application connectée Direct trust, copiez son Client ID, générez un secret et copiez le Secret ID et la valeur du secret, puis activez l’application et le secret. Choisissez ou créez l’utilisateur Tableau sous lequel les écrans affichent leurs vues et donnez-lui l’accès uniquement aux vues que les écrans affichent : quiconque détient le ticket d’un écran peut intégrer toute vue que cet utilisateur peut voir. Puis exécutez bi connection show ID et entrez l’hôte de son embed_origin dans la liste d’autorisation des domaines de l’application connectée. Il faut Tableau Cloud ou Tableau Server 2023.3 ou version ultérieure ; les écrans doivent atteindre l’hôte Tableau, et leur navigateur doit accepter les cookies tiers de cet hôte. Exécutez ensuite bi connection test, puis bi connection browse pour trouver une vue.

Ajoutez une connexion Power BI : une application Microsoft Entra (principal de service) et son secret client, ou une connexion Microsoft de ce projet.

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"

À configurer une seule fois. Dans Microsoft Entra, créez une inscription d’application (locataire unique, sans URI de redirection, sans autorisations d’API) et un secret client. Un administrateur Power BI active, dans le portail d’administration, sous Tenant settings, Developer settings, les options Embed content in apps et Service principals can call Fabric public APIs, pour toute l’organisation ou pour un groupe de sécurité qui contient l’application. Ajoutez l’application à chaque espace de travail que vous affichez avec le rôle Membre ou Administrateur ; Membre est l’accès minimal. Pour une intégration en production, l’espace de travail doit se trouver sur une capacité Fabric (F), Power BI Embedded (A) ou Premium (P/EM). Cloud commercial seulement. Exécutez ensuite bi connection test, puis bi connection browse pour trouver un espace de travail et un rapport.

Ajoutez une connexion web : un compte de service d’un site qui affiche un tableau de bord derrière une connexion, ou les cookies d’un navigateur connecté.

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"

Le mot de passe, la clé et les cookies sont scellés et jamais affichés de nouveau : data.secret et data.totp_secret indiquent s’ils sont définis, et data.session indique où en est l’ouverture de session (idle, active, login_needed, paused, stopped ou expired). Utilisez un compte de service en lecture seule. Une ouverture de session refusée attend 5 minutes, puis 15, 60 et 120, et la cinquième de suite arrête la connexion jusqu’à ce que ses identifiants ou ses paramètres de connexion changent. Un site qui approuve les ouvertures de session sur un téléphone, vérifie les appareils ou affiche un CAPTCHA ne peut pas être scripté : utilisez un fichier de cookies. Un serveur sans le moteur de rendu de pages répond bi_web_unavailable (sortie 5). Exécutez ensuite bi connection test.

Liste les connexions BI de ce projet avec leur type, leur secret masqué et leur dernier test.

bi connection list

Aucun paramètre.

screenrig bi connection list

data.items contient toutes les connexions du projet ; aucun secret n’est renvoyé.

Consultez une connexion et son dernier test.

bi connection show <id>

screenrig bi connection show bic_01EXAMPLECONNECTION0000

La réponse porte kind, config (url et org_id pour Grafana ; tenant_id et client_id pour Power BI, ou connection_id quand une connexion Microsoft ouvre une session ; url, site, client_id, secret_id et username pour Tableau ; login_mode, login_url, username et steps pour une connexion web), secret {set, hint}, embed_origin (l’hôte d’intégration du projet, que nomme la liste d’autorisation des domaines d’une application connectée) et last_test. Une connexion web porte aussi totp_secret {set} et session : son state, le nombre de cookies et cookies_updated_at, last_login_at, login_failures et retry_at.

Modifiez le nom, l’adresse, l’organisation, le locataire, l’application, le site, l’utilisateur ou le secret d’une connexion ou, pour une connexion web, son ouverture de session et ses 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

Au moins un changement est requis, et un secret omis est conservé. Une nouvelle adresse sur un autre hôte, schéma ou port exige --token-file (Grafana) ou --secret-file (Tableau) dans la même commande : le secret stocké n’est envoyé qu’à l’adresse pour laquelle il a été enregistré. Un changement d’adresse, d’organisation, de locataire, d’application, de site, d’utilisateur ou de secret efface last_test et retire tous les rendus mis en cache pour les vues de la connexion : testez-la de nouveau. Un changement d’identifiants ou de paramètres d’ouverture de session rétablit une session web arrêtée.

Vérifiez les identifiants : le jeton et l’Image Renderer de Grafana, l’application de Power BI et ses espaces de travail, l’ouverture de session de Tableau, ou l’ouverture de session d’une connexion web.

bi connection test <id>

screenrig bi connection test bic_01EXAMPLECONNECTION0000

Grafana : token (Grafana l’accepte) et image_renderer (le plugin est listé ; Grafana sans lui avertit seulement, car un service de rendu distant ne s’affiche pas comme un plugin). Power BI : token (Microsoft Entra en a émis un pour l’application) et workspaces (les espaces de travail que l’application peut voir ; aucun fait échouer le test, et un refus nomme les paramètres de développeur du locataire et le rôle Membre ou Administrateur de l’application dans l’espace de travail). Tableau : signin comme l’utilisateur de la connexion avec un jeton de lecture de contenu, suivi d’une déconnexion. Web : login ouvre une session avec le compte de service et dessine sa page de connexion ; une connexion web qui n’ouvre aucune session n’a aucune connexion à tester, donc elle répond par un avertissement, et bi view test vérifie ses cookies. Un refus est une vérification échouée qui porte la réponse propre du fournisseur, et le résultat est stocké sous last_test. Le test ne juge ni la liste d’autorisation des domaines de Tableau, ni la capacité, ni la sécurité au niveau des lignes, ni les autorisations d’un tableau de bord : bi view test vérifie réellement une vue.

Liste ce qu’une connexion peut afficher : les tableaux de bord et panneaux Grafana, les espaces de travail et rapports Power BI, ou les vues Tableau.

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 liste, pour Grafana, les uid, title, folder et tags de chaque tableau de bord que le jeton peut afficher, ou, avec --dashboard, les id, title et type de ses panneaux (les lignes sont aplaties, de sorte qu’un panneau dans une ligne repliée est listé) ; pour Power BI, les id et name de chaque espace de travail que l’application peut voir, ou, avec --workspace, les id, name et embed_url de ses rapports ; pour Tableau, le path, sous la forme Workbook/View, et le name de chaque vue que l’utilisateur de la connexion peut voir. Utilisez ces valeurs avec bi view create. Une connexion web ne liste rien : chaque vue web prend l’adresse de sa page.

Supprimez une connexion qu’aucune vue n’utilise.

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

screenrig bi connection delete bic_01EXAMPLECONNECTION0000

Tant que des vues l’utilisent, la réponse est resource_conflict (sortie 5), en les nommant : supprimez d’abord ces vues. La réponse est data.id et data.deleted true.

Ajoutez une vue d’un tableau de bord, d’un panneau, d’un rapport ou d’une vue Tableau d’une connexion, ou d’un lien public.

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'

Donnez exactement une cible : --url, --dashboard, --workspace avec --report, --view ou --public-url. La réponse porte data.embed_url. Exécutez ensuite bi view test.

Grafana : --url lit orgId, viewPanel ou panelId, from, to, var-*, theme et timezone dans l’adresse. L’image est dessinée par le service de rendu de Grafana et partagée par tous les écrans de même taille, et un écran garde la dernière image, avec l’heure du rendu dans un coin, tant que Grafana est indisponible. Un lien de tableau de bord public se joue en direct depuis Grafana, qui doit autoriser l’intégration (allow_embedding = true dans ses paramètres) : bi view test le vérifie.

Power BI : --url prend l’adresse d’un rapport copiée depuis Power BI, https://app.powerbi.com/groups/WORKSPACE/reports/REPORT, avec une page /ReportSection facultative ; ou donnez --workspace et --report. Deux pages ou plus exigent --rotate, et --rotate exige deux pages ou plus ou --all-pages. --refresh 0 convient à un rapport DirectQuery ou à actualisation automatique des pages qui se met à jour lui-même. --fit ne s’applique pas. Un lien Publish to web montre le rapport à toute personne qui a le lien et se joue tel que Power BI le sert, rechargé selon --refresh, sans rotation des pages.

Tableau : --url prend l’adresse d’une vue copiée depuis Tableau, https://HOST/t/SITE/views/WORKBOOK/VIEW, la forme https://HOST/#/site/SITE/views/WORKBOOK/VIEW de Tableau Cloud, ou simplement WORKBOOK/VIEW ; l’adresse doit se trouver sur l’hôte et le site de la connexion. --rotate-sheets et --rotate exigent chacun l’autre. --fit ne s’applique pas. Les écrans doivent atteindre l’hôte Tableau et accepter ses cookies tiers, et le embed_origin de la vue doit figurer dans la liste d’autorisation des domaines de l’application connectée. Une viz Tableau Public (--public-url https://public.tableau.com/app/profile/USER/viz/WORKBOOK/VIEW, ou son adresse /views/) n’a besoin d’aucune connexion ni d’aucun jeton, et --rotate-sheets y fonctionne aussi.

Web : --url est l’adresse de la page, et --wait-for, --wait-ms et --clip ne s’appliquent qu’à une vue web. La dernière bonne image reste à l’écran quand une capture échoue, et status.last_error en indique la raison : bi_web_login_failed, bi_web_otp_required, bi_web_session_expired, bi_web_login_paused, bi_web_timeout, bi_web_navigation_failed ou bi_web_blocked.

Liste les vues BI de ce projet avec leur cible, leur cadence et leur statut.

bi view list

Aucun paramètre.

screenrig bi view list

data.items contient toutes les vues du projet, chacune avec son embed_url.

Consultez une vue, son embed_url et son comportement le plus récent à l’écran.

bi view show <id>

screenrig bi view show biv_01EXAMPLEVIEW0000000000

La réponse porte kind, name, connection_id (absent pour un lien public), target (view et rotate_sheets pour Tableau), refresh_s, rotate_s, fit, status, embed_url et revision ; une vue web porte aussi wait_for, wait_ms et clip. status contient last_ok_at et last_error avec un code et un detail : bi_upstream_refused quand Grafana a refusé le jeton, bi_upstream_unavailable quand il n’a pas pu produire le rendu, ou l’un des codes bi_web_* d’une vue web.

Modifiez le nom, la cible, la cadence ou l’ajustement d’une vue.

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

Au moins un changement est requis. --url, --dashboard, --workspace et --public-url remplacent la cible entière, tandis que --panel, --from, --to, --var, --theme et --timezone modifient la cible Grafana actuelle de la vue, --report, --page et --all-pages celle de Power BI, et --view et --rotate-sheets celle de Tableau. --page remplace la liste de pages ; pour l’effacer, donnez de nouveau --workspace et --report avec --rotate 0. --rotate 0 seul empêche une vue Tableau de faire défiler ses feuilles. --url et --public-url n’acceptent aucun autre flag de cible que --rotate-sheets, et une vue d’un lien public ne change de cible qu’avec --public-url. Une nouvelle cible efface le statut et retire ses rendus mis en cache, et les écrans prennent le changement en compte à leur prochaine actualisation, sans republication. Une vue garde sa connexion et son type.

Vérifiez réellement une vue : un rendu Grafana ou web, un jeton d’intégration Power BI, une recherche Tableau, ou un lien public.

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 : une vue de connexion est réellement dessinée, hors du cache partagé et sans toucher au statut de la vue. data.ok est à false, avec la raison de Grafana, quand il refuse le jeton, n’a pas de moteur de rendu ou ne connaît pas le tableau de bord ; un test échoué est une donnée, sortie 0. Web : une vue de connexion est dessinée une fois dans le navigateur du serveur (render), hors du cache partagé, et un dessin échoué en nomme la raison. Ouvrez le PNG enregistré et regardez-le avant de publier. Pour un lien public, le test récupère la page et vérifie que Grafana permet à la page d’intégration de la vue de l’encadrer.

Tableau : une vue de connexion se connecte comme l’utilisateur de la connexion et recherche la vue (signin, view) ; une vue que l’utilisateur ne peut pas voir, ou un nom dont la casse est incorrecte, donne une vérification view échouée qui nomme le chemin. Une vue Tableau Public demande à Tableau Public si le classeur existe. Power BI : une vue de connexion lit le rapport (report) et génère pour lui un vrai jeton d’intégration en lecture seule (embed_token) ; la raison propre de Power BI est affichée quand il refuse, comme un jeu de données avec sécurité au niveau des lignes, un 401 ou un 403 (paramètre du locataire ou rôle dans l’espace de travail) ou un rapport que l’application ne peut pas voir. Un lien Publish to web est récupéré et ses en-têtes d’encadrement sont lus.

Le test ne juge ni ce que l’image affiche, ni les pages que la vue nomme, ni la capacité, ni la liste d’autorisation des domaines de Tableau. data contient at, ok et checks, chaque vérification avec name, ok, un warn facultatif et un detail ; un rendu Grafana ou web ajoute width, height et bytes. Avec --output, data contient plutôt id, file, bytes, width et height.

Supprimez une vue.

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

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

Un écran qui affiche encore le embed_url de la vue répond not_found jusqu’à ce que sa liste de lecture change. La réponse est data.id et data.deleted true.