administrator
81 pages tagged administrator (audience).
- Accounts, groups, and entitlements
Administrator Guide · Security & accessCreate accounts, collect them into groups, grant entitlements (roles), and bulk-provision from an accounts workbook, while keeping license seats and your administrator access safe.
- Audit logs
Administrator Guide · AuditingThe four audit log tabs, System, Job, AI Interactions, and MCP, what each records, the columns and detail they carry, and how to filter and export them.
- Data collection processing
Administrator Guide · OperationsProcess contribution write-back, from uploaded or mailbox-received input workbooks back into your planning system, including the consolidated-cell and Exchange Online mailbox traps.
- Performance and capacity planning
Administrator Guide · Performance & capacityThe starting point for sizing a Reportworq deployment and for improving content that is already slow. Explains the two independent capacity stories, distribution and contribution, names every measurement Reportworq keeps about itself, and routes each question to the page that answers it.
- Server configuration
Administrator Guide · ConfigurationThe Settings, Configuration screen, a seven-tab editor for instance-wide settings covering the web server, execution, logging, email, API, license, and data collection, plus the parallel-execution memory rule, the safe way to relocate the Repository, and the SSL self-signed certificate traps.
- System requirements
Administrator Guide · Install & licensingThe operating system, hardware, browser, and network requirements for a Reportworq server on Windows or Linux, including the minimum and recommended browser window size and why it differs from the monitor size, the Linux fonts requirement, running version 5 and version 6 side by side, the two ports every server must open, the default port change to 8600, the self-signed certificate that makes local access HTTPS out of the box, and the HTTPS requirement for the Excel add-in and Microsoft 365.
- Deployment topology
Administrator Guide · Install & licensingChoose a Reportworq deployment, on-premises Windows, on-premises Linux, single-tenant Azure container, or CloudHub relay, with the requirements for each, and scale an on-premises instance into a load-balanced cluster whose nodes join through the setup wizard, share a UNC Repository, and each run whole jobs atomically.
- Distribute the load
Administrator Guide · Performance & capacitySize a Reportworq deployment and spread its work across it, covering the concurrency settings and the memory rule behind them, what a load-balanced cluster does and does not distribute, why job granularity decides whether extra nodes help, how per-node capacity and job filters pin work to machines, and how to spread the clock so a batch does not collide with itself.
- Install Reportworq
Administrator Guide · Install & licensingInstall Reportworq on Windows with the MSI (or on Linux and containers), set the Reportworq 6 Bootstrap Service account so jobs can reach network shares, activate the license, and uninstall safely.
- Log diagnostics and support packets
Administrator Guide · AuditingGather log files into a single support packet for the Reportworq support desk, with the Verbose-before-the-run rule and the Debug Logging and HAR trap.
- Sign-in and SSO
Administrator Guide · Security & accessChoose the active authentication provider, native username and password or an OIDC single sign-on such as Microsoft Entra ID, understand the add-in login, and recover if every administrator is locked out.
- Diagnose job failures
Administrator Guide · OperationsDiagnose a failed or warning job run from the server side, read the log and trace, send a run to support, and handle the "job succeeds but produces no output" pattern.
- First-run setup
Administrator Guide · Install & licensingThe one-time setup wizard that runs on a fresh install, Welcome, Repository, License, Users, and Finish, where the Repository step lets you create a new repository, import a v5 repository, connect to an existing one, or add a load-balancer node.
- Manage and improve performance
Administrator Guide · Performance & capacityDiagnose content that is already slow and make it faster, covering the four questions to ask in order and the surface that answers each, how to read the run breakdown and the engine table, the levers worth pulling and the order to try them, and how to prove a change actually worked.
- Output retention
Administrator Guide · ConfigurationControl how long a report's run history is kept, set per-folder and per-report policies, pin runs to keep forever, and understand the soft-delete and restore lifecycle.
- Compare performance across reports
Administrator Guide · OperationsUse Settings > Performance to rank every report by how far its latest run has drifted from its own baseline, and to pivot the whole estate by product release and by execution node, so you can answer whether a release regressed you or whether one node is slower.
- Licensing and entitlements
Administrator Guide · Install & licensingHow Reportworq is licensed, the License tab, entitlements that gate features, how seats are counted, and why keeping group sizes under licensed counts avoids silently disabling users.
- The repository metadata report
Administrator Guide · AuditingA one-click Excel export from Settings, Auditing, System Log that documents a workspace's whole distribution configuration across seven cross-linked worksheets, Jobs, Reports, Report Parameters, Parameters, Static Burst Sets, Schedules, and Contacts, making it queryable for auditing.
- Workspaces
Administrator Guide · Security & accessUnderstand what a workspace is, create rename and delete one, manage who belongs to it, switch the active workspace, and see why the shared job queue redacts jobs that belong to another workspace.
- Contribution processes
Administrator Guide · OperationsThe contribution process console on Settings > Performance, the per-server contribution memory view, the 90% memory admission valve that governs new contributor sessions, and the session-log tools for support.
- Secured lists
Administrator Guide · Security & accessDefine named value-to-group mappings that decide which security groups, and therefore which Users, may open each bursted report output. Secured lists are report-level, not row-level, and apply to the User role only.
- Update Reportworq
Administrator Guide · Install & licensingKeep a Reportworq instance current with the in-product updater, back up first from Configuration then know how to restore, apply official releases or hotfixes, update an air-gapped server from a patch file, update a container deployment by swapping its image, and update a load-balanced cluster together.
- Migrate to a new server
Administrator Guide · Install & licensingMove a Reportworq instance to new hardware by copying the Repository folder in the right order with the service stopped, reproducing the service account, moving the license (with an optional non-production key to test first), decommissioning the old server, or moving just a subset of content.
- AI in Reportworq
AI & Integrations Guide · AI in ReportworqHow Reportworq applies AI to finance-approved, governed content instead of raw databases, so answers are trusted, auditable, and scoped to what each user is allowed to see.
- Authentication providers
AI & Integrations Guide · Identity & authenticationWhich identity providers Reportworq supports, what each one needs from you, and the cutover facts that decide whether a switch goes smoothly or locks everyone out.
- Copilot, MCP, and trust paths
AI & Integrations Guide · Copilot & MCPThe three ways an AI client or external system reaches Reportworq, the Microsoft 365 Copilot agent, the MCP shim, and the automation API, and the two trust paths that broker their traffic.
- Plan your integrations
AI & Integrations Guide · Integration strategyThe decisions an integration owner makes before wiring anything up, where reports come from, which data sources to connect, how people sign in, whether to expose AI and MCP, and how to keep content safe once you do.
- Source report providers
AI & Integrations Guide · Source report providersThe configured, trusted locations Reportworq is allowed to read report source files from, what each provider type can and cannot do, and the parameter-driven dynamic paths that let one job read a different workbook per run.
- The automation API
AI & Integrations Guide · Automation & extensibilityReportworq's HTTP API for running and monitoring jobs from outside the product, delivered two ways, the Local REST API on the LAN and the Cloud API over CloudHub, with opposite key models.
- The integrations hub
AI & Integrations Guide · Data sources & connectorsSettings, Integrations is the single place to add, test, enable, and edit every external connection Reportworq uses, grouped into six families covering authentication, the MCP platform tool, AI providers, datasources, distributors, and report providers.
- Secure content before you expose it to AI
AI & Integrations Guide · Copilot & MCPThe content-security decisions to make before enabling the MCP server, which path carries a user identity and which does not, what a reader can reach, and how to verify it rather than assume it.
- Connect a data source
AI & Integrations Guide · Data sources & connectorsAdd a datasource connection in the integrations hub, fill its connector-specific settings, and validate it with Test connection before anyone models or reports against it.
- Connect an AI provider
AI & Integrations Guide · AI in ReportworqAdd and enable an AI provider connection (OpenAI, Azure OpenAI, Amazon Bedrock, or Reportworq AI) so every downstream AI feature has a model to call.
- Microsoft 365 Copilot agent
AI & Integrations Guide · Copilot & MCPGenerate the Reportworq Copilot agent package, deploy it into Microsoft 365, and let Copilot users query their reports in natural language, scoped to their own permissions.
- Microsoft 365 OAuth setup
AI & Integrations Guide · Identity & authenticationRegister one Azure (Entra ID) application and authenticate Reportworq to it, so Entra sign-in, the SharePoint provider, the Email, SharePoint, and Teams distributors, and email data collection all work from a single credential.
- Run a job by API
AI & Integrations Guide · Automation & extensibilityCall the /api/v1 commands to list, run, monitor, and cancel a job, and filter a single run to one output type and one destination so different callers get different deliveries from the same job.
- Connector catalog
AI & Integrations Guide · Data sources & connectorsEvery datasource connector Reportworq ships, grouped by category, with the authentication approach and the per-connector traps that most often block a connection.
- The AI assistant
AI & Integrations Guide · AI in ReportworqThe in-app AI assistant is present in the product but not yet switched on in this build. This page explains its current state and points to the AI features you can use today.
- The MCP shim for desktop AI clients
AI & Integrations Guide · Copilot & MCPDownload the Reportworq MCP connector, paste a per-client snippet into a desktop AI client such as Claude Desktop, and confirm the connection reaches your reports.
- Turbo Integrator, Workato, and Task Scheduler
AI & Integrations Guide · Automation & extensibilityLaunch Reportworq jobs from an IBM Planning Analytics Turbo Integrator process, from a Workato recipe, or from Windows Task Scheduler, with the PowerShell hang fix that keeps a script from stalling.
- AI-generated insights in reports
AI & Integrations Guide · AI in ReportworqAttach model-written narrative to a distributed report, either as a distribution-time AI Insight variable or inline in the workbook with the RWAIINSIGHT function.
- Connect IBM Planning Analytics
AI & Integrations Guide · Data sources & connectorsConnect Reportworq to IBM Planning Analytics (TM1), choose the right authentication type for self-hosted, Cloud (IBM SoftLayer), or Cloud (MCSP), and handle the deployment traps that support is most often asked about.
- Deploy the Office add-in
AI & Integrations Guide · Automation & extensibilityGet the Reportworq Office add-in onto users' Excel and PowerPoint, by Microsoft 365 Centralized Deployment or by a shared-folder Trusted Add-in Catalog sideload, with SSL as a hard prerequisite.
- MCP audit
AI & Integrations Guide · Copilot & MCPThe MCP Server Log records every MCP tool call served to an AI client and every request rejected at the gate, with a full request-and-result drill-in, under Settings ▸ Auditing.
- Connect SQL, OLE DB, and ODBC
AI & Integrations Guide · Data sources & connectorsConnect Reportworq to relational databases with the SQL Server, OLE DB, ODBC, and SQLite connectors, and to API and SaaS systems through CData drivers, keeping credentials out of the connection string and avoiding the common ODBC DSN and timeout traps.
- The AI prompt store
AI & Integrations Guide · AI in ReportworqThe global store of the internal prompts Reportworq sends to your AI provider, editable in Settings ▸ AI Prompts, with variable tokens, factory defaults, and a one-click reset.
- The Script Runner
AI & Integrations Guide · Automation & extensibilityAttach C# script files to a distribution job so they run at six points in the execution pipeline, what the six hooks can reach, how to configure and validate a script, and the full-trust security posture to understand before enabling it.
- Connect Power BI and Analysis Services
AI & Integrations Guide · Data sources & connectorsConfigure the native ADOMD connection to a Power BI semantic model, Azure Analysis Services, or SQL Server Analysis Services, choose an authentication mode, and query it with DAX, DMV, or MDX.
- Data models
AI & Integrations Guide · Data sources & connectorsWhat a data model is, why it sits between a source system and report authors, and how to build one, curate its fields and filters, and publish a view for authors to use in the Excel add-in.
- Glossary
Reference · ReferencePlain-language definitions of every Reportworq term used across the User, Administrator, and AI and Integrations guides.
- Troubleshooting index
Reference · ReferenceA symptom-to-cause-to-fix table for the most common Reportworq problems, grouped by area.
- Limits and known constraints
Reference · ReferenceThe current, confirmed limits of Reportworq, what is not supported, and the boundaries to design around, grouped by area.
- Download the demo system
Timberline Demo System · OrientationGet the Timberline demo system as a content store you can run on your own server, with no data source to connect.
- Timberline release notes
Timberline Demo System · OrientationWhere changes to the downloadable Timberline demo system are recorded.
- Start here
Timberline Demo System · OrientationWhat the Timberline demo system is, the order to explore it in, and the things people most often miss.
- How Timberline rolls the reporting year forward
Timberline Demo System · Use casesOne global parameter, four pieces of content that follow it, and the single edit that moves a whole reporting year. Open it, change it, and watch.
- What Timberline is
Timberline Demo System · OrientationOne fictitious company, four layers, and a complete Reportworq deployment you can drive.
- Signing in, and who to be
Timberline Demo System · OrientationThe seats the Timberline demo ships with, what each one is scoped to see, and how to read what a recipient actually received without signing in at all.
- Use the MCP server
Timberline Demo System · AI and integrationsWhat is pre-configured for MCP in Timberline, the one switch you have to turn on first, and what to point an AI client at.
- Where the files live
Timberline Demo System · OrientationThe nine source files behind every Timberline report, the two places they are stored, and the naming rule that keeps a workbook edit from breaking a job.
- Export campaign data
Timberline Demo System · CampaignsHow Timberline gets contributed numbers back into the planning model, and the two export shapes it demonstrates.
- Use a global parameter
Timberline Demo System · ReportsTimberline has one global parameter, Current Year. Change it once and four pieces of content follow.
- Campaigns at large scale
Timberline Demo System · CampaignsWhat changes when a campaign goes from three forms to hundreds, and how to size one before you invite anyone.
- Schedule jobs
Timberline Demo System · ReportsThe one Timberline schedule, how to demo a scheduled run safely, and how campaign automation differs from job scheduling.
- Back, Forward, and shareable links
User Guide · Working in the workspaceReportworq keeps the browser address bar in step with the screen you are on, so browser Back and Forward work, and any screen can be bookmarked, refreshed, or shared as a link that opens exactly there.
- Run a job
User Guide · Running and schedulingUse Run Jobs to run one or more reports on demand, pick which outputs to produce, choose Production or Hold for Delivery, and set logging and notifications.
- Track activity and run history
User Guide · MonitoringUse Activity to watch running jobs, release or cancel held deliveries, and review recent runs, and open a report's Run History for its full per-report record.
- Roles and what you can do
User Guide · Working in the workspaceThe Reportworq roles, Administrator, Author, and User, plus the Recipient who simply receives distributed content, what each one sees and can do, and who can see and change permissions.
- Run estimates and expected completion
User Guide · MonitoringHow Reportworq predicts how much longer a running job has to go, where the estimate appears, how it is calculated, and why it sometimes shows nothing at all.
- Schedule a job
User Guide · Running and schedulingCreate a schedule in the Schedule editor with a 5-field cron expression, a job or folder selection, per-schedule parameter overrides, and delivery behavior.
- Item properties
User Guide · Working in the workspaceInspect and configure any report, campaign, data model, or folder from the Properties panel - its description and retention, who can access it, the schedules that run it, and the context it gives AI and search.
- Manage scheduled content
User Guide · Running and schedulingUse Scheduled Content to see every schedule, turn the master scheduler on or off, run or edit a schedule, check health, and understand how missed runs are handled.
- View and download results
User Guide · MonitoringUse the Report Viewer to open a run's output in Markdown, HTML, PDF, Excel, PowerPoint, or CSV, switch between runs and variants, download files, and email a copy to yourself.
- Store files in the workspace
User Guide · Working in the workspaceKeep supporting files - logos, source workbooks, templates, reference documents - inside the governed workspace alongside your reports, with the same folders, security, and actions.
- When a job fails
User Guide · MonitoringRead a failed run's log, work through common causes, and escalate to support with the right logs.
- Destinations
User Guide · DistributionThe full catalog of distribution destinations, Email, Network Folder, SharePoint, Box, OneDrive, Google Drive, Slack, Teams, SFTP, and IBM Planning Analytics, with per-destination setup notes.
- Profile and stress-test a campaign
User Guide · ContributionUse the Campaign profiling screen to measure a form's server-side memory footprint, build load-test plans for the rw-stress-runner, and read a plain-language report of what contributors experienced under load, before you open a campaign to real people.
- Review a run's performance
User Guide · MonitoringCompare a run against the report's own recent history with the Elapsed vs baseline, Trend, and Peak mem columns, then open the Performance tab on a run's diagnostics to see where the time went, by output, workbook, processing phase, and calculation engine.
- Find when a report got slower
User Guide · MonitoringUse the Compare tab on a run's diagnostics to search a report's whole history for the single point where its typical run time stepped, and narrow the search to one variation of a bursting job.
- Scale and size a contribution campaign
User Guide · ContributionTurn the campaign profiling measurements into decisions, how much a form should cost, how many concurrent contributors a server carries, how many servers a round needs, and how to confirm the sizing held while the round is live.
- The Workspace Inbox
User Guide · DistributionKeep a copy of every message Reportworq sends and read it in the app, alongside your real email provider or with no mail server at all.
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.