how-to

78 pages tagged how-to (content type).

• Accounts, groups, and entitlements
  Administrator Guide · Security & access
  Create accounts, collect them into groups, grant entitlements (roles), and bulk-provision from an accounts workbook, while keeping license seats and your administrator access safe.
• Data collection processing
  Administrator Guide · Operations
  Process contribution write-back, from uploaded or mailbox-received input workbooks back into your planning system, including the consolidated-cell and Exchange Online mailbox traps.
• Distribute the load
  Administrator Guide · Performance & capacity
  Size 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 & licensing
  Install 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 · Auditing
  Gather 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 & access
  Choose 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 · Operations
  Diagnose 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 & licensing
  The 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 & capacity
  Diagnose 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 · Configuration
  Control 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 · Operations
  Use 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.
• Workspaces
  Administrator Guide · Security & access
  Understand 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.
• Secured lists
  Administrator Guide · Security & access
  Define 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 & licensing
  Keep 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 & licensing
  Move 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.
• The integrations hub
  AI & Integrations Guide · Data sources & connectors
  Settings, 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.
• Connect a data source
  AI & Integrations Guide · Data sources & connectors
  Add 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 Reportworq
  Add 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 & MCP
  Generate 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 & authentication
  Register 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 & extensibility
  Call 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.
• The MCP shim for desktop AI clients
  AI & Integrations Guide · Copilot & MCP
  Download 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 & extensibility
  Launch 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 Reportworq
  Attach 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 & connectors
  Connect 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 & extensibility
  Get 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.
• Connect SQL, OLE DB, and ODBC
  AI & Integrations Guide · Data sources & connectors
  Connect 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 Script Runner
  AI & Integrations Guide · Automation & extensibility
  Attach 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 & connectors
  Configure 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 & connectors
  What 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.
• Download the demo system
  Timberline Demo System · Orientation
  Get the Timberline demo system as a content store you can run on your own server, with no data source to connect.
• Check out the AI features
  Timberline Demo System · AI and integrations
  Timberline's AI setup in four layers, and the demo that lands the "AI done differently" argument.
• Build a campaign
  Timberline Demo System · Campaigns
  The seven decisions behind Timberline's budget campaign, in the order you make them.
• Signing in, and who to be
  Timberline Demo System · Orientation
  The 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 integrations
  What is pre-configured for MCP in Timberline, the one switch you have to turn on first, and what to point an AI client at.
• Update an input form
  Timberline Demo System · Campaigns
  How to change what contributors type into, the template, the bindings, the validation, and what happens to forms that already exist.
• Where the files live
  Timberline Demo System · Orientation
  The 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 · Campaigns
  How Timberline gets contributed numbers back into the planning model, and the two export shapes it demonstrates.
• Use a global parameter
  Timberline Demo System · Reports
  Timberline has one global parameter, Current Year. Change it once and four pieces of content follow.
• Build a compelling email dashboard
  Timberline Demo System · Reports
  The recipe Timberline's jobs share for an email people read on a phone without opening the attachment.
• Campaigns at large scale
  Timberline Demo System · Campaigns
  What changes when a campaign goes from three forms to hundreds, and how to size one before you invite anyone.
• Try out PowerPoint
  Timberline Demo System · Reports
  Run the board deck, then open the template and see how every number, table and chart on the slides is bound back to Excel.
• Schedule jobs
  Timberline Demo System · Reports
  The 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 workspace
  Reportworq 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.
• Choose the source workbook and worksheets
  User Guide · Authoring reports
  On the Reports step of the Job Editor, pick the source workbooks a report renders and choose which worksheets it outputs, in order.
• Run a job
  User Guide · Running and scheduling
  Use 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.
• Sign in and take the tour
  User Guide · Getting started
  Sign in to Reportworq, then take a guided tour of the shell: the frame, the content library, filtering, paging, search, and creating your first item.
• Track activity and run history
  User Guide · Monitoring
  Use 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.
• Address book and contacts
  User Guide · Distribution
  The workspace directory of contacts that distribution and contribution resolve recipients against, covering contact fields and access rules, the additive-only import, the D_ and P_ column contract, why a custom field needs a value to save, and why directly-created contacts get no entitlements.
• Author a contribution campaign
  User Guide · Contribution
  Build a write-back campaign in the five-section campaign editor, generate and assign input forms, set notifications, and configure the export that writes collected data back to your plan.
• Excel: build and refresh reports
  User Guide · Office add-ins
  Use the Excel companion pane to import a published data-model view, shape it into a list report with grouping, sorting, aggregates and filters, place it on the sheet, and refresh it from source or from cache.
• Global parameters
  User Guide · Authoring reports
  Define a named parameter value once at the workspace level and reuse it across every report, so a period, version, currency, or entity is one edit instead of many, with an impact review before you change a widely-used value.
• Replicate output from your source system
  User Guide · Bursting
  Let a parameter's own values fan the output out, one file per value, so the list of outputs stays current in your source system and you never open the Bursting step.
• Schedule a job
  User Guide · Running and scheduling
  Create a schedule in the Schedule editor with a 5-field cron expression, a job or folder selection, per-schedule parameter overrides, and delivery behavior.
• Burst sets
  User Guide · Bursting
  Build one row per output on the Bursting step, by hand, from an Excel workbook, or from a SQL query, so individual outputs can carry their own values, their own query, and their own recipient.
• Excel: find and insert functions
  User Guide · Office add-ins
  Use the Formula Library dock in the Excel companion pane to search the Reportworq worksheet functions, read what one does, and insert it into the active cell.
• Fill in and submit a form
  User Guide · Contribution
  Open an assigned input form from My Input Forms, enter values, use the planning toolbar and its operators, clear validation, track your work in the Details dock, and submit; approvers review and approve or reject.
• Item properties
  User Guide · Working in the workspace
  Inspect 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 scheduling
  Use 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.
• Parameterize a report
  User Guide · Authoring reports
  Turn a single workbook into a reusable report by driving it from named parameters, so changing one input updates every formula and lets the report fan out per period, entity, or recipient.
• View and download results
  User Guide · Monitoring
  Use 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.
• Collect data with an input workbook
  User Guide · Contribution
  Send a workbook out, let people fill it in wherever they are, and have Reportworq post the values back to your planning system when it returns. The workbook route is a separate process from a contribution campaign, and this page explains when to reach for it.
• Assign recipients to bursts
  User Guide · Bursting
  Recipients are optional. Route each output by an attribute from your source system, a value on a worksheet, a contact column in a burst source, or a contact assigned by hand, and understand which one wins.
• Name and organize output files
  User Guide · Distribution
  Build output file names from literal text and variable tokens, and use a token in a destination path to auto-create a folder tree at delivery.
• Store files in the workspace
  User Guide · Working in the workspace
  Keep 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 · Monitoring
  Read a failed run's log, work through common causes, and escalate to support with the right logs.
• Profile and stress-test a campaign
  User Guide · Contribution
  Use 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 · Monitoring
  Compare 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.
• Email messages and templates
  User Guide · Distribution
  Write a dynamic email subject and body with variable tokens so you do not edit it every week, add an AI-generated insight, and save the message as a reusable template.
• Find when a report got slower
  User Guide · Monitoring
  Use 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 · Contribution
  Turn 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.
• Worksheet output options
  User Guide · Authoring reports
  Set per-worksheet output behavior, sheet name, tab color, order, PDF bookmark, suppression, and the exception-check send gate, on the Reports step.
• Combine emails, collate, and zip
  User Guide · Distribution
  Group multiple outputs into a single email with combining and the combine key, sort report pages with collation, bundle outputs into a zip, and split a workbook into one file per tab.
• Job options: collation and splitting
  User Guide · Authoring reports
  Set report-level output assembly from the Job Editor chrome, collate worksheets into one file or split them into separate files, and know when to use each.
• Save and Save As
  User Guide · Authoring reports
  Save Changes writes your edits back to the same report. Save As creates an independent copy under a new name and leaves the original untouched.
• The Workspace Inbox
  User Guide · Distribution
  Keep 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.
• PowerPoint reporting
  User Guide · Authoring reports
  Turn a branded PowerPoint template into data-driven presentation output, link each slide shape to a report object in the add-in, and distribute the deck through the same pipeline as your Excel reports.
• Create an AI Profile for a report
  User Guide · Authoring reports
  Describe a report's purpose, audience, and terminology in its AI Profile so AI assistants, search, and recommendations answer from your curated business context instead of guessing from raw data.