Download Reportworq
⬇ Guide PDF

Licensing and entitlements#

Reportworq is licensed through the Reportworq licensing service. The License tab on the Settings > Configuration screen is where an administrator views license status and details and activates, releases, or manually activates the license. The license carries entitlements that gate which features and connectors are available, so licensing determines not just whether the product runs but which capabilities appear.

The License tab#

The License tab shows a license-status line, a license-info property list (an Information category and a Details category), and a masked key field. Unlike other Configuration tabs, it has no save state, Save stays disabled, because licensing changes happen through its own actions rather than the shared Save.

Action What it does
Activate Validates and binds the license against the Reportworq licensing service. Each activation consumes one installation seat, which is a seat for this installation of Reportworq. It is not a user assignment and has nothing to do with the role seats below.
Release Reverts an activation and returns the installation seat, for example when moving or decommissioning an instance.
Manual activation An offline request-code / response-code flow for a server that cannot reach the Reportworq licensing service directly. See Install Reportworq for the step-by-step.

The commercial model#

A Reportworq license carries two kinds of thing: role seats for the people who sign in, and installation-level capabilities that turn features on for the whole environment. There is no limit on the number of reports you configure, and recipients, the people you distribute output to, are unlimited and free, because a recipient never signs in and holds no license. You license the people who operate Reportworq, not the reports or the audiences they reach.

Roles and seats#

Reportworq licenses three roles. Each is sold as a seat count that is either numbered or unlimited, and each is drawn from its own pool. A fourth role, Recipient, needs no license and is listed here for completeness:

Role seat Who it is for
Administrator Configures and manages the environment (security, users, integrations, content, licensing); reaches every workspace.
Author Builds jobs (reports), data models, and campaigns within the workspaces granted to them; includes the Excel authoring add-in.
User Signs in to consume Reportworq: view output by ACL, participate in contribution campaigns, refresh a distributed PowerPoint deck, or reach content through the MCP server and the AI assistant.
Recipient (not licensed) Receives distributed output by email, Slack, Teams, SharePoint, and so on, without ever signing in. Holds no seat; unlimited and free.

Two naming changes matter when reading a license:

For what each role can do, see Roles and what you can do.

Installation-level capabilities#

Beyond the role seats, the license enables capabilities for the whole installation. These are properties of the license, not of individual users:

Capability What it enables
Contribution Contribution write-back, including Data Collection. When Contribution is licensed, Users can be assigned as contributors and approvers and collected data can be written back to a planning system. Data Collection is part of Contribution, not a separate line.
API The REST API and the Script Runner. Without it, an API command or webhook call is refused with HTTP 400, "REST API not available for this license". The MCP server, CloudHub setup, and output downloads are not gated by this capability.
Load Balancer A count of load-balancer nodes for a clustered deployment. A count of 0 means load balancing is off. See Deployment topology.
Data Connections How many data-source connections may be configured, numbered or unlimited. Creating one while over the count is still allowed, but an overage stops jobs and campaigns from running. See the counting rule below and What happens when you go over a limit.
Workspaces How many workspaces may be configured, numbered or unlimited. Creating one while over the count is still allowed, but an overage stops non-administrators from signing in. See What happens when you go over a limit.

If a counted limit is missing from the license, the default differs by lever, deliberately: Load Balancer defaults to off, while Data Connections and Workspaces default to unlimited. A feature that has to be bought is never given away by an unstamped license, and a limit on something every installation already has never cripples one.

When a feature is unavailable, check the License tab before requesting an upgrade. For example, without Contribution the Data Collection settings show a "not included in your license" lock, and Reportworq hosted AI is filtered out of the integrations catalog without the hosted-AI entitlement.

How data connections are counted#

Every configured data-source connection across all workspaces counts as one connection toward the Data Connections limit, with a single exception: the Excel file source (the Excel/CData connector) is free and does not count.

Worked example. An installation with 3 IBM Planning Analytics systems, 2 SQL Server databases, and 3 Excel file sources uses 5 counted connections. The 3 Excel files are free, even when spread across several workspaces.

How seats are counted#

Non-production licenses#

You can request a non-production license key for development and test environments. It is fully functional, so a dev or test instance behaves exactly like production, with two deliberate differences that keep non-production output from being mistaken for the real thing:

Ask Reportworq for a non-production key rather than pointing a second environment at your production key. Each activation consumes an installation seat, so a shared key would draw a seat you meant to keep for production.

What happens when you go over a limit#

Going over a licensed limit never fails at the moment you cause it. You can assign one more entitlement, add one more data connection, or create one more workspace while already over. The enforcement happens later, and it is real: an overage is not a cosmetic notice on the License screen.

Sign-in is blocked while you are over the User seat count or the Workspace count. An Author or a User who is not an administrator is refused at the portal with a message naming the User or Workspace limit. Administrators are exempt, deliberately, so an administrator can always get in to disable accounts or remove a workspace and bring the installation back under its limits. The Excel add-in task pane is also exempt.

Jobs and campaigns fail to run while you are over a count or a seat limit. A Data Connections or Load Balancer overage is checked when the run is queued, and the run then fails with the reason recorded against it. Administrator and Author seat overages are checked as the run starts and fail the same way. This check is deliberately fail-open: if the licensing service cannot be reached, the job is allowed to run rather than blocked by an unrelated fault.

The API capability is a separate, immediate block. Without it, REST API commands and webhooks are refused outright, whatever your counts are.

A limit only ever enforces when the license carries a finite value and the live count exceeds it, so a license that has not been reissued does not suddenly start blocking.

Watch the counts before they bite. Because nothing fails at assignment time, the first symptom of an overage is usually a user who cannot sign in or a scheduled job that stopped running. Check the License screen when either happens.

This matters most with single sign-on. An entitlement granted through an identity-provider group only draws a license when each account first signs in, so an overage can surface gradually as users come online. To avoid it:

  1. Assign entitlements at the group level rather than per account, so counts are easy to reason about.
  2. Keep any OIDC-provider group that is mapped to a feature under that feature's licensed count.
  3. Pre-provision accounts and reconcile against seat counts before a rollout.
  4. Run periodic user and license audits.

See Accounts, groups, and entitlements for the entitlement catalog and the lever to release a seat after removing a role.

Notes and limits#

Going deeper. For moving a license between servers, release on the old server and activate on the new one, see Migrate to a new server.

Feedback on this page

Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.

Email feedback on this page

Or write to support@reportworq.com directly.