Glossary#
One-line definitions of the terms used across the Reportworq documentation. Where a term has a fuller treatment, the definition points to it.
| Term | Definition |
|---|---|
| Additional Files | A static list of extra files attached to a delivery as separate attachments; they are never merged into the report PDF and cannot be varied per parameter value. |
| Address book | The workspace store of contacts and their fields, used to resolve burst and distribution recipients; imports are additive and never delete existing contacts. |
| Administrator | The licensed role that configures and manages the environment (security, users, integrations, content, licensing); it has the author experience plus the Settings surfaces and is the only role that bypasses content security. It is server-wide: it reaches every workspace regardless of grants, and it cannot be scoped to a single workspace. Labeled System Administrator in earlier versions. |
| AI insights | AI-authored narrative text generated for a report and embedded in the output or email body rather than delivered as a separate file; produced by the RWAIINSIGHT function. |
| AI Profile | Curated context (purpose, audience, terminology, caveats) attached to a report so that AI answers from finance-approved information instead of raw data. |
| AI provider | A configured connection to an AI service (OpenAI, Azure OpenAI, Bedrock, or Reportworq AI) that Reportworq calls for generative features. |
| AI prompt store | The central library of editable prompt templates (Settings, AI Prompts) that Reportworq sends to AI providers, with {{variables}} and factory defaults. |
| API | The licensed installation-level capability that enables the REST API and the Script Runner. |
| Author | The licensed role that builds jobs (reports), data models, and campaigns within the workspaces and folders granted to it, and can see all output; includes the Excel authoring add-in. It respects ACLs and does not bypass content security. The entitlement was formerly labeled "Reportworq Administrator"; the retired "Reporting End User" / Excel-add-in seat folds into Author. |
| Bootstrap service | The Windows service (Bootstrapper) that runs Reportworq under a service account; its logon account needs the UNC and Repository rights the product uses. |
| Burst | The act of running one report once per recipient or per data slice, producing a separately parameterized output for each. |
| Burstable parameter | A parameter flagged to drive bursting directly from your source system (a Planning Analytics subset, MDX, or SQL attribute), the recommended bursting path. |
| Burst set | A defined list of burst iterations (static, Excel, SQL, or Planning Analytics subset) used when recipients are not driven directly from the source system. |
| Campaign | A contribution project that generates and assigns input forms, gathers submitted data, and writes it back to a planning system. |
| CloudHub | Reportworq's cloud relay that gives a trust path for AI and remote-execution integrations without exposing the on-prem server inbound. |
| Cloud API | The cloud-hosted automation endpoint; it uses a global API key plus a ?workspace= selector and needs only outbound 443. |
| Collation | A job option that combines multiple worksheets or outputs into a single file for delivery. |
| Combine emails | A distribution option that merges multiple outputs or recipients into a single email instead of sending one message per output. |
| Combine key | The field that tells Combine Emails which outputs belong together in one message; only one job can combine into a given email body. |
| Connector | An integration type that lets Reportworq read from (or, for some, write to) an external system such as TM1, SQL, Salesforce, or Pigment. |
| Contact | An address-book entry that can receive distributed output; a directly created contact is a recipient only and carries no entitlement or license. See Recipient. |
| Contact mapping | The fallback rule that matches a burst iteration to a contact by field value (case-insensitive) when a burst set does not name the contact directly. |
| Content browser | The workspace view that lists folders, reports, campaigns, and data models as cards or a grid, with filters and search. |
| Contribution | Reportworq's write-back capability: collecting data from users through forms and writing it back into planning systems. Licensed as an installation-level capability that includes Data Collection. |
| Contributor | A User who is assigned to fill in and submit contribution forms. Contribution participation is a capability of the User role, not a separate role or seat. See User and Contribution. |
| Copilot agent | The Microsoft 365 Copilot agent that lets Copilot users query Reportworq content through the governed AI trust path. |
| Cron | The 5-field schedule expression (Cronos syntax) used by the schedule editor to define recurrence. |
| Data collection | The processing pipeline that receives submitted contribution data (including a monitored mailbox) and writes it back to the target system; licensed as part of the Contribution capability. |
| Data connection | A configured data-source connection. Under the license, every configured connection across all workspaces counts toward the Data Connections limit, except the Excel file (Excel/CData) source, which is free and does not count. See Datasource. |
| Data model | A curated source definition used to build Excel Reports in the add-in; it is not a live query-driven report source. |
| Datasource | A saved, named connection to an external system; its name must be unique, and editing or deleting a live one breaks every job or form that refreshes from it. |
| Destination | A place a job delivers output to: email, a network folder, SharePoint, Slack, Teams, SFTP, a cloud drive, or a Planning Analytics application folder. |
| Direct query | A data-model mode that pushes each request to the source at run time instead of caching; it defaults to off. |
| Distribution | The stage that decides which output formats a job produces and where they are delivered. |
| Distributor | The component that sends output to a particular destination type (for example the Slack distributor or the Email distributor). |
| Dynamic Path | A parameter-driven source-file path, available for distribution reports only (not contribution). |
| Entitlement | A licensed role or capability assigned to an account or group (for example Administrator, Author, or User) that unlocks a set of features. Recipient is not an entitlement. |
| Exception check | A whole-report send gate: if any exception cell across any worksheet evaluates TRUE, the output is sent; otherwise the recipient gets nothing. |
| Form | A contribution input document generated from a template and assigned to a contributor to fill in and submit. |
| Global parameter | A workspace-level variable, referenced with %global:%, that reports can read so a value is defined once and reused. |
| Hold-for-Delivery | A run mode that produces output but holds it for review and manual release instead of delivering it immediately; the alternative to Production. |
| Integrations hub | The Settings area where providers, datasources, distributors, and AI providers are configured. |
| Job | The configured unit of work (source report, parameters, output formats, destinations, schedule) that Reportworq runs to produce and deliver output. |
| Local API | The on-server REST automation endpoint; its access token doubles as the workspace selector, with a per-workspace key model. |
| Load balancer | A cluster node; a server joins a cluster through the setup wizard, by choosing to add a load balancer to an existing web app and giving the UNC path to the shared Repository, with no further node-side configuration. Load balancing is a licensed capability expressed as a node count, where 0 disables it. |
| Master scheduler | The global on/off switch that governs whether scheduled content runs, plus its catch-up and overdue behavior. |
| MCP shim | The stdio Model Context Protocol shim that lets desktop AI clients reach Reportworq content over the governed trust path. |
| Message template | A reusable email subject and body with dynamic tokens so a recurring send does not have to be re-edited each period. |
| Output format | A file type a job can generate (Excel, PDF, PowerPoint, CSV) or embedded AI insights; formats are additive within one run. |
| Parameter | A named value that drives report content; changing it updates the formulas and the data a report returns. |
| Parameter set | A finite list of pipe-delimited parameter combinations (for example C5|C6) supported for cell-based reports with Text-List parameters. |
| Process manager | The per-server memory console for contribution runtime sessions, including the high-memory new-session valve and session logs. |
| Proportional Spreading | The setting that lets a write-back post to a consolidated cell by spreading the value across leaves; without it, consolidated writes are rejected. |
| Provider | See Report provider. |
| Reader | Former role name; folds into User. See User. |
| Recipient | Someone who receives distributed content (email, Slack, Teams, SharePoint, and so on) without any Reportworq login or license. A recipient is not an account or an entitlement; recipients are unlimited and free. See Contact. |
| Replication | Generating repeated output from one report driven by a parameter's values (none, one page per item, or one report per item). |
| Report | A template that produces outputs, not an output itself; the same report can generate many files across runs and recipients. |
| Report provider | A configured source location (for example a network share or SharePoint) that Reportworq reads source workbooks from; a security trust boundary. |
| Report viewer | The monitoring view for opening, downloading, and re-sending the outputs a run produced. |
| Reportworq licensing service | The service that activates a Reportworq installation and enforces its entitlements. Each activation consumes one installation seat; releasing an activation returns it. |
| Repository | The Reportworq content store that holds jobs, reports, schedules, and configuration; relocate it through Backup and Restore, never a live move. |
| Repository metadata report | A 7-worksheet workbook (Jobs, Reports, Report Parameters, Parameters, Static Burst Sets, Schedules, Contacts) exported from Configuration, Backup as a queryable audit. |
| Retention | The policy that enforces, purges, or soft-deletes stored output after a period, with restore for soft-deleted items. |
| Run history | The per-report record of past runs and their outputs, used to view, download, or re-deliver a previous version. |
| Schedule | A recurrence definition (5-field cron) that runs a job automatically, optionally with parameter overrides. |
| Secured list | A row-level data-security list that restricts which data rows an account can see. |
| Sheet suppression | Removing a worksheet from the delivered file, either by a cell formula evaluating TRUE or automatically when a provider report returns no data. |
| Turbo Integrator | The IBM Planning Analytics scripting process; Reportworq launches jobs from it through the REST API (and the Cloud Connector relay for PA Cloud). |
| User | The licensed role for people who consume Reportworq: signs in to the portal and sees folders, reports, and outputs by ACL; can be a contributor or approver on contribution forms when Contribution is licensed; can refresh distributed PowerPoint decks in the add-in; and can reach content through the MCP server and the built-in AI assistant. Folds in the former Reader, Consumer, Contribution End User, and PowerPoint End User roles. |
| Workspace | An isolated container of content, security, and datasources; instances can host multiple workspaces that share one job queue. |
| Write-back | See Contribution. |
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 pageOr write to support@reportworq.com directly.