Manual KPI – Update Dashboards Without an API

Manual KPI is the operator-entry workflow for layouts that use a Manual data source.

Use it when the values on screen should be entered by a person instead of being fetched from REST, WebSocket, or Ingest.

---

1. When to Use Manual KPI #

Manual KPI is a good fit when:

• the API is not ready yet
• values are updated by shift leaders or supervisors
• operators need to type alerts, counts, or comments
• the same production line values should appear on multiple TVs

Manual KPI is not a separate layout editor. It updates runtime values for an existing layout.

---

2. Before You Start #

Make sure all of these are already done:

1. A layout exists.
2. The layout contains data-driven widgets such as KPI, progress, table, alerts, sparkline, text block, content image, pie, or target/actual.
3. A Manual data source exists.
4. That Manual data source is assigned to the layout.
5. The layout is in a playlist used by at least one device.
6. The device has a production line value, because Manual KPI is selected by production line.

Manual KPI is not based on the layout alone.

In practice, the runtime chain is:

• device
• device production line
• assigned playlist
• layout inside that playlist
• Manual data source bound to that layout

---

3. Open the Manual KPI Screen #

1. Click Manual KPI in the left navigation.
2. Select the production line.
3. Select the layout.
4. Wait for the preview to load.

The preview uses the real runtime renderer, so what you see is close to what the TV will show.

The production line list is built from the production lines assigned to your devices.

The layout list is filtered to show only layouts that:

• use a Manual data source
• are included in a playlist
• are assigned to a device for the selected production line

---

4. Update Widget Values #

1. Click a widget in the preview.
2. Use the inspector panel on the right to edit that widget’s runtime values.
3. Repeat for each widget that needs data.
4. Click Save.

Examples:

• KPI: enter a number
• Progress Bar: enter current and total
• Alerts List: add alert rows
• Table List: add item rows
• Sparkline: enter a series of values
• Text Block: update the message body
• Content: change the runtime image URL

---

5. What Manual KPI Changes #

Manual KPI changes:

• values
• rows
• series points
• alert items
• text body
• runtime content image URL

Manual KPI does not change:

• widget titles owned by the layout
• widget styling
• layout structure
• top and bottom chrome
• theme colors

If the structure is wrong, go back to the Layout Editor.
If the values are wrong, stay in Manual KPI.

The preview in Manual KPI uses the same runtime renderer as the Reader, so it is also a useful validation screen before you check the physical TV.

---

6. Production-Line Behavior #

Manual KPI is saved per:

• layout
• production line

It is not saved per device.

That means all TVs on the same production line that use the same layout see the same Manual KPI snapshot.

If no exact saved row exists for a production line, the Reader can fall back to the layout’s empty production-line snapshot when one exists.

---

7. Best Practices #

Do #

• create one clear process for who updates values and when
• use stable widget labels in the layout
• save after every meaningful update round
• use Manual KPI as a fallback when an API is temporarily unavailable
• make sure the correct playlist and device assignment already exist before testing the screen

Avoid #

• using Manual KPI for layout design changes
• creating one layout that mixes several unrelated production lines
• assuming values are device-specific

---

8. Typical Workflow #

1. Create a layout called Shift Performance.
2. Bind it to a Manual data source.
3. Add it to a playlist.
4. Assign the playlist to the Line 1 TV.
5. Open Manual KPI.
6. Choose Line 1 and Shift Performance.
7. Enter actual output, target, downtime alerts, and comments.
8. Save.
9. The TV updates using that saved snapshot.

---

9. Admin Preview and Manual KPI #

If you want to verify the result before checking the real TV, use the admin preview flow.

This helps you confirm:

• the device is assigned to the correct playlist
• the layout is the one expected for that device
• the Manual KPI payload is being applied correctly
• the screen output looks right before checking the physical display