Looking to get custom dashboards made? Contact Virkplan at kontakt@virkplan.dk.

Follow our general guide on working with integrations in Q-Play to start a new integration, and choose Virkplan as the type.

1. Enter your API key

The only Virkplan-specific step during setup is entering your API key in the Credentials step.

Your Virkplan BI API key is obtained directly from Virkplan — contact them to order one.

2. Set up a job

Once the integration is created, add a job to tell Q-Play what to display and how. Virkplan supports two job types depending on your player hardware:

• Report — embeds the report live on screen. Viewers can interact with it. Use this for external media players.
• Report Screenshot — captures a static screenshot of the report on a schedule. Use this for SOC players (LG, Samsung, Sony, etc.) that may not handle live embeds well.

Report (embed)

Enter the Report ID of the report you want to display. Contact Virkplan if you don't know your Report ID.

Under Data identity, choose how the report is filtered:

• None (no filtering) — shows the report as-is, with no identity sent.
• Row-Level Security (RLS) — applies a named role and username, required if your report is RLS-protected in Virkplan. This reveals two additional fields:
  • RLS role — the role name exactly as defined in Virkplan, e.g. Kunde.
  • RLS username — the username the role is applied to, e.g. Kundenavn ApS.

Report Screenshot

The screenshot job has the same Report ID and Data identity fields as the embed job, plus:

Capture — what part of the report to screenshot:

• Full report — captures the entire report.
• Specific page — captures one page. Requires Page name: the system name of the page, exactly as provided by Virkplan.
• Single visual — captures one visual from a page. Requires both Page name and Visual name: the system name of the visual, which Virkplan can provide.

Capture width and Capture height — the pixel dimensions of the captured image. Defaults to 1920 × 1080.

Under Scheduling, set how often Q-Play captures a fresh screenshot with Capture new screenshot every. This is the only way new data reaches the display in screenshot mode, so set it to match how frequently your report data updates.

For displaying Virkplan data on your screens, see Displaying Virkplan on Your Screens.