Build board-Karte für Digital-Signage-Bildschirme

Live-Karte

Diese Karte wird in Ihrem Browser vom gleichen Code gezeichnet, den die Player ausführen, mit Beispieldaten.

Kategorie: Betrieb. Schlagwörter: Warnungen und Status, Zahlen und Kennzahlen, Büros und Arbeitsplätze.

Layouts

Diese Vollbildkarte füllt den gesamten Bildschirm im Quer- oder Hochformat und wird nicht als Ecke, Chip oder Streifen platziert.

Layouts: voll. Formulare: Querformat, Hochformat.

Kartenlayouts, Designs und Veröffentlichung. Karten durchsuchen.

Daten und Datenschutz

Feed: screenrig.builds/v1.

Feed-Dokumente tragen Quellenangaben. Der Player liefert den Feed an die Karte.

Eigenschaften

Für Thema, Hintergrund, Akzent und Position siehe Gemeinsame Eigenschaften.

Legen Sie statische Eigenschaften in den params der Karte fest, wenn Sie sie erstellen. Ihr Datendokument enthält nur dynamische Eigenschaften. Verschachtelte Zeilen beschreiben den Inhalt ihrer übergeordneten Eigenschaft.

Statische Eigenschaften

Name	Typ	Standard	Werte und Grenzwerte	Beschreibung
`title`	string	`"Builds"`	maxLength: `40`
`branch`	string	`""`	maxLength: `60`	Zeigt nur Läufe in diesem Zweig; leer zeigt jeden Zweig an.
`show`	string	`"all"`	`"all"`, `"builds"`, `"deploys"`
`staleMinutes`	integer	`10`	Minimum: `1`; Maximum: `1440`	Daten, die älter sind, zeigen Aktualisiert vor N Min.
`backgroundColor`	String, Null	`null`	Muster: `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Überschreibt den Kartenhintergrund und die Platte mit einer flachen, CSS-geordneten Farbe. #RRGGBBAA gibt die Deckkraft an. Hintergrund none hat Vorrang.
`textColor`	String, Null	`null`	Muster: `"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"`	Überschreibt die Haupt- und Sekundärtextfarben. Akzent- und semantische Statusfarben behalten ihre Funktion.

Dynamische Eigenschaften

Name	Typ	Standard	Werte und Grenzwerte	Beschreibung
`updatedAt`	string	`""`	maxLength: `40`	ISO-8601-Zeitpunkt, zu dem die Pipelines erfasst wurden (nur Datenspeicher; ein Feed enthält fetchedAt).
`pipelines`	array	`[]`	maxItems: `60`
`pipelines[].id`	string	`""`	maxLength: `60`
`pipelines[].name`	string		minLength: `1`; maxLength: `60`; Pflichtfeld	Das Repository oder die Pipeline.
`pipelines[].branch`	string	`""`	maxLength: `60`
`pipelines[].kind`	string	`"build"`	`"build"`, `"deploy"`
`pipelines[].environment`	string	`""`	maxLength: `30`	Wohin eine Bereitstellung geht, zum Beispiel Produktion.
`pipelines[].status`	string	`""`	maxLength: `24`	Bestanden, fehlgeschlagen, läuft, in Warteschlange oder abgebrochen. Auch gelesen als: Erfolg, erfolgreich, ok, grün, bereitgestellt; Fehler, fehlerhaft, kaputt, rot, Zeitüberschreitung; in Bearbeitung, Aufbau, Bereitstellung, gestartet; ausstehend, wartend, geplant; abgebrochen, übersprungen, abgebrochen. Jedes andere Wort wird grau wie angegeben angezeigt.
`pipelines[].startedAt`	string	`""`	maxLength: `40`	ISO-8601-Zeitpunkt, zu dem der Lauf begann (bei Warteschlangenläufen: wann sie eingereiht wurden). Die Dauer einer laufenden Pipeline zählt ab diesem Zeitpunkt.
`pipelines[].finishedAt`	string	`""`	maxLength: `40`	ISO-8601-Zeitpunkt, zu dem der Lauf beendet wurde.
`pipelines[].durationSeconds`	integer	`0`	Minimum: `0`; Maximum: `8640000`	Die Länge des Laufs. Wird sie weggelassen, ist sie finishedAt minus startedAt.
`pipelines[].actor`	string	`""`	maxLength: `60`	Wer es gestartet oder ausgelöst hat.

Canvas-Beispiel

Speichern Sie die statischen Eigenschaften als params.json und erstellen Sie die Karte. Das Ergebnis enthält ihre crd_ ID.

{
  "theme": "neomustard"
}

screenrig card create --type build-board --major 1 --file params.json

Fügen Sie diesen Eintrag den primitives einer Playlist-Seite hinzu, mit dieser ID anstelle der Beispiel-ID. Veröffentlichen Sie die Playlist und weisen Sie einen Bildschirm zu.

{
  "id": "build-board",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

Live-Daten schreiben

Schreiben Sie das Dokument nach dem Erstellen in die Karte und ersetzen Sie es dann, um den Bildschirm ohne erneute Veröffentlichung zu aktualisieren. Die Karte prüft jeden Schreibvorgang gegen ihre dynamischen Eigenschaften und lehnt ein Dokument ab, das sie nicht akzeptiert. Verwenden Sie dasselbe Projekt wie die Playlist.

Speichern Sie das Dokument als card-data.json. Die CLI liest das Dokument selbst, ohne Wrapper:

{
  "updatedAt": "",
  "pipelines": []
}

screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

Oder rufen Sie die API direkt auf. Die API verpackt dasselbe Dokument in ein document-Feld. Ein Agent-Token benennt bereits sein Projekt, daher wird kein Projekt-Header gesendet; wenn Sie ScreenRig-Project senden, muss es zum Token-Projekt passen. Stellen Sie Ihre API-Autorisierung über die Umgebung bereit; siehe API-Authentifizierung.

curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"updatedAt":"","pipelines":[]}}'