Documentation

Run your screens from the dashboard

The dashboard is where people run a project: pair screens, build playlists in a page editor, schedule what plays, approve an agent's changes, watch the fleet and look after the people who work with it. People and agents share one project, so what an agent publishes is there for you to open and edit, and what you change is what the agent sees next. It lives at screenrig.ai/dashboard. A control that needs a plan the project lacks carries a mark, and choosing it names the plan that includes it (see pricing).

Sign in and your account

Sign in and sign up share one page. Enter your email address. An address with an account goes to its passkey, a new address starts an account with your name and a passkey, and an address on an organization's single sign-on domain goes to its identity provider. Enterprise sign-in takes a work address straight there. You sign in with a passkey, not a password. Lost your passkey? emails a link, good for one hour, that sets up a new one. From a terminal, screenrig dashboard opens the dashboard.

One login belongs to any number of projects. The project switcher changes project, and All projects lists them all and starts a new one. Your name at the foot of the rail opens your profile: your name and email address, Language, a link to your organization's single sign-on and your passkeys, which you add, rename or remove, keeping at least one.

The dashboard reads in English, Canadian French, Spanish, German, Brazilian Portuguese, Italian, Japanese and Simplified Chinese. It follows your browser's language, and Language overrides it. It also installs as a web app from your browser's install command, and a new release loads the next time you move between pages.

Find your way

The rail on the left groups the pages: Summary, with Reviews beneath it once the project uses review, then Signage (Screens, Alerts, Playlists, Web apps and Media), Project (Access, Data sources, Connections, Logs and Settings), Buy ads, Sell ads and Organization. A project shows the pages it uses; a project that only buys ads has no screens. A change that goes live at once, such as assigning a playlist, editing a schedule or publishing page content, takes the project owner or a member who can approve.

Screens

Screens lists every screen with its status, place, tags and health, and a picture. Filter by text, tag or health. Once the project has folders the list is a tree: a folder rolls up the screens inside it and opens its own details, where you rename it, give it a default playlist, protect it, move it or delete it. Drag screens or folders onto a folder to move them. A protected folder sends every change that reaches its screens to a second approver; protecting folders is a Premium feature.

Pair screen takes the six-character code a Player shows. Every Player except Windows also shows a QR code: scan it with a phone signed in to the dashboard and confirm. Players covers installing one, and Settings → Fleet links enrolls many devices from one URL with no code.

A screen opens on nine tabs:

  • Properties holds the name, tags, fields, location, time zone and folder, a link that opens the screen in a browser source, its video wall layout, reboot schedule and device settings.
  • Screenshot shows the latest picture, and Start live view plays live video on a Player that supports live view.
  • Playbacks, Health, Storage, Logs, Commands and Events show its plays, its health and availability, what it stores, what it reports, the commands sent to it and the project's events for it.
  • Schedule shows what plays now and why (see Schedules and campaigns).

The header and footer tools reload, reboot, turn the display on or off, suspend or resume, archive and delete a screen, and identify it, clear its cache, restart its app, update its software, replace its device or move it to a folder. A reload, reboot, cache clear, app restart or update sent to an offline screen waits up to 24 hours for it to return.

Media

Media is the project's library of files, folders and tags. Upload PNG and WebP images, MP3 audio and video; the browser converts a video to MP4 and fits it to the project's video limit first. Drag files onto folders and open a file for its Preview, Properties, Used in, Versions, Playbacks and Events.

Properties holds a file's tags and the dates and weekly windows when a media selector may pick it. Replace file swaps the bytes and keeps the identifier, so every playlist that names the file plays the new one. Versions lists the history, previews any version and restores or deletes a past one. The Sync tab keeps a media folder in step with a folder in SharePoint, OneDrive, Dropbox or Google Drive, or with a Canva design; media sync is a Plus feature (Signage CLI).

Playlists

Playlists lists the project's playlists, with a Drafts group for the ones you have started in the editor. A playlist opens on Pages, Properties, Screens, Playbacks, Revisions and Events. Pages orders the pages, sets when each one shows and how long a timed page lasts. A save bar confirms the change and names the screens it reaches at once.

New playlist, Add page and Edit page open the page editor, which takes the whole window. Tools place an image, a video, a card, a web app or a website, and a media selector plays files by folder or tag. The draft stays in your browser until Publish writes it live. Revisions lists every revision and Make current copies an earlier one forward, a Premium feature. New from template starts a playlist from a template, a Premium feature, and a header, footer or side strip is a playlist too.

Web apps

Web apps lists the applications your agent built with the SDK and uploaded. Open one to run its Preview in a sandbox, read its Properties, see the playlists and screens that show it under Used in, follow its Playbacks and Events, or delete it. A web app joins a playlist as a page in the page editor.

Data sources and connections

Data sources keep cards live from a calendar, a sheet, a till or an address you name: create one, test it before it saves, read its status and sync it now. Connections save the project's access to Microsoft 365 or Google once, for room sources, Power BI dashboards and media sync. Data sources and Connections cover both; connected sources are a Plus feature.

Schedules and campaigns

A screen's Schedule tab, and a folder's, shows what plays now and why. It lists the levels that decide it, highest first: a takeover, campaigns, the screen's own schedule and the default playlist. A person who can approve assigns the default playlist, adds a level with a playlist and when it plays, reorders levels and removes them. The calendar also opens in its own window for a screen, a folder, a shared level or a tag, by day, week or month, and flags conflicts; the calendar of a folder, a tag or a campaign is a Premium feature. A takeover set by an agent or the browser extension sits at the top.

A shared level is a campaign: one rule that switches every screen in its audience to a playlist while it holds. Campaigns are a Plus feature. Your agent creates campaigns (Signage CLI). In the dashboard a person who can approve edits a campaign's rule, priority and the area of the page it covers, or reserves it for approvers, and the calendar shows how many screens it reaches.

Schedule change control saves a change as a draft, publishes it to one test folder or screen first, promotes it when it is ready and keeps a History with Restore. Import applies a whole schedule from a CSV or Excel sheet after a preview. Change control is an Enterprise feature and schedule import a Premium feature.

Watch the fleet

  • Summary is the first page: five figures (screens, health, availability, plays and storage), plays per day with the busiest screens and media, health history, the newest activity and a live picture of each online screen. Export playback downloads plays as CSV or JSON.
  • Alerts lists open alerts, one for each screen and condition while it lasts, and the resolved ones. Acknowledge an alert when someone is on it, snooze it, or mute screens by name or tag for up to 30 days. The list downloads as CSV, Excel or PDF.
  • Logs has six tabs: Playbacks for recent plays, Events for the project's live event stream, Screen logs for what Players report, Screen health for availability and alerts rolled up by folder or tag, Screen reports and Audit. Open in Logs on a screen, a file or a playlist opens the matching tab, filtered.
  • Screen reports builds any report as a table, downloads it as CSV, Excel or PDF, and keeps Email schedules; reports are a Plus feature. Audit shows the project's audit log with each change before and after; reading it is a Premium feature.

Reviews

Reviews is the queue for changes an agent proposes to playlists, screens and media, and for ad creatives buyers submit. The project owner and members who can approve read each change, then approve it exactly as proposed, send it back with a note or reject it. Turn on Require review for agent changes in Settings to hold every agent change here; Agents and Authentication cover how an agent proposes.

People, agents and settings

Access is the one list of who and what can act in the project: sign-ins waiting for approval, agents, people (members, then invitations), connected apps and service clients. Invite sends an email or a link shown once, Can approve makes a member an approver, and Remove ends a member's access at once. A member can be limited to screen folders, a Plus feature (Permissions), or made an Uploader who adds media to chosen playlists and folders, a Plus feature (Authentication). Groups binds an organization's identity provider groups to the project.

Settings → General holds the project's name, Require review for agent changes, moving the project to another organization, transferring its ownership and deleting it. Settings → Fleet links makes the URL that enrolls every device that opens it (fleet links).

Organizations

The Organization group opens the organization the project belongs to. Everyone in it sees Projects; its admins see the rest.

  • Projects lists the organization's projects. Open one to see its owner and members, join it or set members' access.
  • Members has People, with each person's admin role and access in every project, and Invitations.
  • Notifications creates email and webhook notifications for screen state changes, covering every project of the organization or the ones you choose.
  • Audit is the organization's own log, a Premium feature.
  • Settings has General (name, guest policy and the shared Library project, a Premium feature), Billing (statement and payment method), Domains (prove a domain with a DNS record), Single sign-on (a Premium feature) and Provisioning (an Enterprise feature) connect your identity provider (single sign-on, user provisioning).

A project has no billing page of its own: its organization pays. Admins of a reseller organization also see a Reseller group with Customers and Reports (resellers).

Selling and buying ads

Advertising is invitation-only and runs on the same account. Sell ads holds the Ads network (pricing, screens, ad slots, delivery and fill), Direct campaigns for advertisers you deal with yourself, a Premium feature, and Buyers. Buy ads holds the Marketplace of networks that invited you, Creative, where you prepare an ad from ready media, and Campaigns, where you draft, quote, activate and pause a campaign. A buying project needs no screens. Quickstart walks through the first steps, and the advertising commands cover the rest.