Skip to content

Linking to help from Studio

Every page in this help site has its own permanent URL, and every section inside a page has its own anchor (the part after #). You can link straight to any heading, for example https://help.digitalvi.app/players/player-details/#admin-menu.

To link from any Studio screen to its help, add /app plus the Studio path to the help site address:

Studio page: https://studio.digitalvi.app/screenLayouts/299/builder
Help link: https://help.digitalvi.app/app/screenLayouts/299/builder
Redirects to: https://help.digitalvi.app/players/layout-builder/

In the Studio page template, the help button can be a single line:

<a href="https://help.digitalvi.app/app${location.pathname}" target="_blank" rel="noopener">Help</a>

IDs in the path (299, user IDs and so on) are ignored, and unknown paths go to the help home page. So the link never breaks, even as Studio gains new screens.

The redirects are defined in vercel.json in the help site repository. This table is generated from that file.

Studio pathHelp page
//home/dashboard/
/dashboard/map/home/dashboard/#map
/notifications/:path*/home/messages/
/tutorialScenarios/:path*/home/tutorials/
/users/edit/:path*/clients/users/#add-a-new-user
/users/:id/resetPassword/clients/users/#actions-menu
/users/:id/apikey/:path*/clients/users/#api-keys
/users/:path*/clients/users/
/permissions/:path*/clients/user-permissions/
/roles/:path*/clients/user-roles/
/locations/edit/:path*/players/locations/#add-a-new-location
/locations/:id/playerSettings/reference/player-settings/
/locations/:id/openingHours/:path*/players/locations/#opening-hours
/locations/:id/dashboard/:path*/players/locations/#edit-the-location-dashboard
/locations/:id/info/players/locations/#location-details-page
/locations/:id/players/locations/#location-dashboard
/locations/players/locations/
/players/edit/:path*/players/players/#add-a-new-player
/players/:id/playlistSchedules/players/player-details/#playlist-schedules
/players/:id/layoutSchedules/players/player-details/#layout-schedules
/players/:id/screenshot/players/player-details/#screenshot
/players/:id/displays/players/player-details/#player-displays
/players/:id/changeClient/players/player-details/#change-client
/players/:id/settings/reference/player-settings/
/players/:id/statusHistory/players/player-details/#status-history
/players/:id/:path*/players/player-details/
/players/players/players/
/screenLayouts/edit/:path*/players/layouts/#add-a-new-layout
/screenLayouts/:id/builder/players/layout-builder/
/screenLayouts/:id/schedules/:path*/players/layouts/#zone-schedules
/screenLayouts/:id/players/layouts/#layout-details-page
/screenLayouts/players/layouts/
/tags/bulk/players/tags/#bulk-tags-for-players
/tags/:path*/players/tags/
/appVersion/:path*/players/app-versions/
/playStatistics/:path*/players/display-statistics/
/licenses/:path*/players/licenses/
/contentCreation/:path*/content/content-creation/
/extraContent/:path*/content/data-feeds/
/playerGroups/edit/:path*/playlists/playlist-groups/#add-a-new-playlist-group
/playerGroups/:id/fallbackPlaylist/playlists/playlist-groups/#fallback-playlist
/playerGroups/:id/fallbackLayout/playlists/playlist-groups/#fallback-layout
/playerGroups/:id/bulkAssign/playlists/playlist-groups/#bulk-assign-players
/playerGroups/:id/addNotScheduledPlaylist/playlists/playlist-groups/#event-playlists
/playerGroups/:id/playlists/playlist-groups/#playlist-group-details
/playerGroups/playlists/playlist-groups/
/playlists/edit/:path*/playlists/playlists/#add-a-new-playlist
/playlists/:path*/playlists/playlists/
/files/:path*/playlists/media-manager/
/synchronizations/:path*/playlists/synchronizations/
/devices/:path*/control/devices/
/hardwareDrivers/:path*/control/hardware-drivers/
/support/about/support/
/about/about/about/
/:path*/

:id matches a single path segment. :path* matches anything, including nothing. Rules are checked top to bottom, and the first match wins.