This page describes how to install, configure, and administer the Named Overlays Editor in a Viz Mosart deployment.

Prerequisites

Accessing the Editor

Once the Web Apps server is running, the Named Overlays Editor is served at: https://<server-address>/namedoverlayseditor/

Replace <server-address> with the host name or IP address of the machine running the Web Apps server. The editor can also be opened from Home in the Mosart Web Apps Configuration Tool.

On an installation with more than one studio the editor works on one studio at a time. Home launches it with the studio selected there, appended to the address as ?studioId=<id>, and the toolbar shows the active studio with a dropdown to switch. Opened without that parameter, the editor falls back to the first configured studio. Named overlays live on each studio's own Mosart server, so the overlay set changes with the studio.

If authentication is enabled, you are redirected to a sign-in page before the editor opens. See Authentication and roles below.

Authentication and Roles

The editor recognises two roles. You assign them in your identity provider, not in the Configuration Tool, and the editor reads them from the roles claim in the user's token.

Assign the roles before you enable authentication

A signed-in user who holds neither role does not get a read-only view. The editor shows an unauthorized-access screen and nothing else, because it fails closed. An identity provider with no Mosart roles configured therefore locks out everybody, which reads as a fault in the editor rather than as missing configuration. Assign a role to every user who needs the editor before you turn authentication on.

The roles must reach both tokens

Two layers check the user, and they read two different tokens:

This is the most common misconfiguration. If the roles are present in only the ID token, the editor looks completely correct and every save fails.

The claim must be flat, top-level, and named exactly roles. A nested claim, such as Keycloak's default realm_access.roles, is not read: the Web Apps server matches the claim name exactly.

Confirm that your provider emits the claim in both tokens. In Keycloak this means adding a protocol mapper for the roles and enabling it for the ID token and the access token separately. In Microsoft Entra ID, app roles that you have defined and assigned are emitted in a roles claim with no further claim mapping.

Where roles are enforced

Hiding the editing controls in the browser is not the whole protection. The Mosart server checks the role on every named overlays REST call, so a viewer cannot create, change, or delete an overlay by calling the API directly.

With authentication disabled, every user is treated as an administrator, no request is refused, and the roles have no effect.

Session Timeout

Where authentication is enabled, the Named Overlays Editor signs a user out after a period without activity. This is new in this version. Previously an editor left open held its session for as long as the page was open, because its own background token refresh kept the session alive. That background traffic no longer counts as activity.

The controls are on the Server Configuration page of the Configuration Tool, inside the Authentication (OIDC) block, under Allow session timeout:

• The Named Overlays Editor switch is on by default, reading Renews while in use; can time out when idle. Switch it off to read Stays signed in while open, which restores the earlier behaviour.

• Session timeout sets how long an unused session survives, in minutes, from 5 to 10080, defaulting to 30. It applies only to the apps whose switch is on.

Activity means typing, clicking, scrolling and moving the pointer in the editor. The embedded Viz Pilot Edge panel is a separate frame, so its events are invisible to the editor: having the panel in focus stands in for activity for five minutes after the last action in the editor and no longer, while a graphic sent back from the plugin counts as activity in full. A long spell spent only inside the panel can therefore still reach the countdown. Ninety seconds before the session ends, a dialog headed You will be logged out soon offers Continue session or Log out now; if that is missed, the editor shows Session timeout! with a Login button. See Authentication.

Messages you may see

Configuring the Viz Pilot Edge Plugin

The Pilot Edge plugin panel is configured in the Configuration Tool, on the Named Overlays Editor page of App Configuration:

1. In the Configuration Tool, open App Configuration and select Named Overlays Editor.

2. Check that VIZ PILOT GRAPHICS AND ELEMENTS is selected. It is selected when the page opens: the tool fills it in from Showmaker's Pilot Edge configuration when one exists, and from the defaults below otherwise. Clear it if this editor should have no plugin panel.

3. Provide values for:

   • Application URL: where Viz Pilot Edge is running. Default: http://localhost:8177/app/pilotedge/pilotedge.html?mosid=pilot&sendbutton. Enter the host of your Viz Pilot Edge installation if it is not on the same machine.

   • MOS Plugin ID: the MOS ID stamped on overlays created from this plugin. Default: PILOT.

4. Click Save.

Main and Backup Servers

The toolbar carries a beacon and a label for the main Mosart server, and a second pair for the backup server in a redundancy setup. Each label is that server's own name as Viz Mosart reports it, falling back to Main and Backup when no name is available, and each beacon shows that server's own state, so the green one is the server reported as Active. The editor is routed to whichever server is active; it does not choose between them.

In a redundancy setup, named overlays live on both servers, and the two can drift apart if overlays are edited while one of them is unavailable. To align them, use Sync to backup server in the sidebar. It makes the backup server's overlays identical to the main server's: every overlay on the main server is copied across, replacing any overlay with the same slug, and overlays that exist only on the backup are removed. A confirmation dialog appears first, and a notification reports how many overlays were copied and removed.

The sync always reads from the main server and writes to the backup server explicitly, so it is safe to run during a failover: it will not copy the backup onto itself. Because it removes overlays that exist only on the backup, make sure the main server holds the set you want before running it.

Where overlays are stored

Overlays are stored on the Mosart server in NamedOverlayGraphics.xml, not in the browser and not on the Web Apps host. Any editor instance pointed at the same Mosart server sees the same overlay set, and the overlays are available to Mosart automation as soon as they are created. To keep a copy outside Mosart, use Export XML in the editor.

For background on named overlays and how Viz Mosart uses them, see Named Overlay Graphics in the Viz Mosart Administrator Guide. The editor links to it directly from Help in its help menu.

Troubleshooting

For general connectivity issues, see section Troubleshooting.