reference
75 pages tagged reference (content type).
- 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.
- 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.
- 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.
- 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.
- Secret rotation API
Administrator Guide · SecurityThe write-only REST endpoint that lets an external secret manager such as CyberArk, Delinea, BeyondTrust, or HashiCorp Vault push a rotated password, API key, or token into Reportworq, how to enable it, mint and revoke rotation keys, discover rotatable coordinates, and wire it into a CyberArk CPM REST plugin.
- Reportworq Software Subscription & Services Agreement
Administrator Guide · LegalThe subscription and services agreement that governs installation, deployment, access, and use of the Reportworq Software Product Suite, together with its license grant, warranty, support commitments, and other terms between Reportworq and the customer.
- 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.
- 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.
- IBM Planning Analytics functions
AI & Integrations Guide · Data sources & connectorsFull reference for RW.PlanningAnalytics.MDX plus the catalog of native TM1 worksheet functions (DBRW, DBS, SUBNM, DIMIX, VIEW, TM1RPT*, and more) that Reportworq evaluates against an IBM Planning Analytics / TM1 connection.
- 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.
- Script API reference
AI & Integrations Guide · Automation & extensibilityEverything a Reportworq .csx script can call, the globals available at each hook, the shared job state dictionary, logging and halt semantics, the AfterSend job result, and the compilation environment.
- Example scripts
AI & Integrations Guide · Automation & extensibilityA library of 29 working .csx examples covering every Script Runner hook, downloadable individually or as a single zip, each one compile-checked against the live script API on every build.
- DBRW function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DBR and DBRW worksheet functions in Reportworq - retrieve a single cube cell value for an element tuple, with the argument rules and the exact result of each bad input.
- DBRA function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DBRA worksheet function in Reportworq - retrieve an element attribute value, with the argument rules and the result of each bad input.
- DBS function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DBS, DBSW, and DBSS write-back worksheet functions in Reportworq - send a value to a cube cell, with the argument rules and the result of each bad input.
- VIEW function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 VIEW worksheet function in Reportworq - assemble a server:cube:view reference for a block of retrieval formulas.
- ELPAR function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELPAR worksheet function in Reportworq - return a parent of an element by index.
- ELPARN function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELPARN worksheet function in Reportworq - return the number of parents of an element.
- ELLEV function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELLEV worksheet function in Reportworq - return the level of an element.
- ELWEIGHT function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELWEIGHT worksheet function in Reportworq - return the weight of a child in its consolidation.
- ELCOMP function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELCOMP worksheet function in Reportworq - return a child (component) of a consolidated element by index.
- ELCOMPN function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELCOMPN worksheet function in Reportworq - return the number of children of a consolidated element.
- ELISCOMP function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELISCOMP worksheet function in Reportworq - test whether one element is a component (child) of another.
- ELISPAR function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELISPAR worksheet function in Reportworq - test whether one element is a parent of another.
- ELSLEN function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 ELSLEN worksheet function in Reportworq - return the length of an element's name.
- DIMIX function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DIMIX worksheet function in Reportworq - return the index of an element within a dimension.
- DIMSIZ function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DIMSIZ worksheet function in Reportworq - return the number of elements in a dimension.
- DNEXT function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DNEXT worksheet function in Reportworq - return the next element in a dimension.
- DNLEV function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DNLEV worksheet function in Reportworq - return the number of hierarchy levels in a dimension.
- DTYPE function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DTYPE worksheet function in Reportworq - return an element or attribute type code.
- DFRST function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DFRST worksheet function in Reportworq - return the first element in a dimension.
- TABDIM function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TABDIM worksheet function in Reportworq - return the name of a cube's dimension at a given position.
- SUBSIZ function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 SUBSIZ worksheet function in Reportworq - return the number of elements in a subset. The trigger name is SUBSIZ, not SUBSIZE.
- SUBNM function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 SUBNM and DIMNM worksheet functions in Reportworq - return an element name from a subset by index or name, and drive a picklist.
- TM1RPTVIEW function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1RPTVIEW Active Form worksheet function in Reportworq - the anchor of an Active Form report region.
- TM1RPTROW function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1RPTROW Active Form worksheet function in Reportworq - defines the dynamic row axis that grows and shrinks with the underlying subset.
- TM1RPTTITLE function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1RPTTITLE Active Form worksheet function in Reportworq - emits a title member reference for an Active Form.
- TM1RPTFILTER function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1RPTFILTER Active Form worksheet function in Reportworq - builds the sort and filter MDX for an Active Form region.
- TM1RPTELISCONSOLIDATED function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1RPTELISCONSOLIDATED Active Form worksheet function in Reportworq - tests whether an Active Form row is a consolidation.
- TM1RPTELLEV function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1RPTELLEV Active Form worksheet function in Reportworq - returns the display level of an Active Form row.
- TM1RPTELISEXPANDED function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1RPTELISEXPANDED Active Form worksheet function in Reportworq - always returns FALSE because Active Form drilling is not supported.
- TM2RPTELISCONSOLIDATED function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM2RPTELISCONSOLIDATED Universal Report worksheet function in Reportworq - tests whether a Universal Report axis member is a consolidation.
- TM2RPTELLEV function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM2RPTELLEV Universal Report worksheet function in Reportworq - returns the display level of a Universal Report axis member.
- TM2RPTELISEXPANDED function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM2RPTELISEXPANDED Universal Report worksheet function in Reportworq - always returns FALSE because Universal Report drilling is not supported.
- TM1ELLIST function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1ELLIST spill worksheet function in Reportworq - spill the element names of a subset or MDX set down a column, indented by hierarchy level.
- TM1VAL function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1VAL worksheet function in Reportworq - a hierarchy-aware cube retrieval, the complement to DBR. Read mode only.
- DefineCalc function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 DefineCalc worksheet function in Reportworq - declare an MDX calculated member for use in cube retrieval.
- TM1USER function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1USER worksheet function in Reportworq - return the current user's display name on a server.
- TM1SET function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1SET worksheet function in Reportworq - a hierarchy-aware member selector with member, unique-name, and session-set output modes.
- TM1PRIMARYDATASOURCE function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1PRIMARYDATASOURCE worksheet function in Reportworq - returns the workbook's last-saved primary data source value.
- TM1PRIMARYDBNAME function
AI & Integrations Guide · IBM Planning Analytics function referenceReference for the native TM1 TM1PRIMARYDBNAME worksheet function in Reportworq - returns the workbook's last-saved primary server name.
- Reportworq 6 release notes
Reference · Release notesWhat each Reportworq 6 release delivers for you - the latest hotfix (cumulative) followed by the official releases, newest first.
- Glossary
Reference · ReferencePlain-language definitions of every Reportworq term used across the User, Administrator, and AI and Integrations guides.
- TM1 Script Downloads
Reference · DownloadsTI process samples and the PowerShell launcher as downloadable files, for customers who want the latest script without upgrading.
- Reportworq 6.0.0.3
Reference · Release notesRelease notes for Reportworq 6.0.0.3 - the first official Reportworq 6 release with release notes.
- Reportworq 6.0.0.2
Reference · Release notesRelease notes for Reportworq 6.0.0.2 - the initial Reportworq 6 release.
- 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.
- Timberline release notes
Timberline Demo System · OrientationWhere changes to the downloadable Timberline demo system are recorded.
- The campaign catalog
Timberline Demo System · CampaignsThe Timberline contribution campaign, what it demonstrates end to end, and the problem contribution campaigns are for.
- The report catalog
Timberline Demo System · ReportsThe five Timberline jobs, what each one demonstrates, and how to run one.
- Functions overview: which one do I use
User Guide · Worksheet functionsThe complete index of Reportworq worksheet functions, with a direct link to every function's full reference entry, a which-function-do-I-use table, how functions compare with the Excel add-in, and the naming trap that catches almost everyone.
- General report and layout functions
User Guide · Worksheet functionsFull reference for the ten RW.Tools.* functions that shape a generated workbook, with the signature, every argument and default, the pipeline order they run in, and what happens when an argument is wrong.
- 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.
- Output formats
User Guide · DistributionThe full catalog of output formats a Reportworq job can generate, Excel, PDF, PowerPoint, CSV, and Files, with every per-format option.
- The AI insight function
User Guide · Worksheet functionsFull reference for RW.Tools.AIInsight, the one genuinely generative worksheet function, which calls a configured AI provider and writes the response into a named TextBox or a cell.
- Contribution functions
User Guide · ContributionReference for the RW.Contribution Excel functions that define input ranges, validation, and interactive controls in a contribution form, plus the workbook-design rules that keep forms from breaking.
- Excel: charts and maps
User Guide · Office add-insThe complete reference for the add-in's chart and map builder - every chart type and the data it expects, the full mapping capability including cell-driven framing, and how an imported visual is kept current.
- Parameters reference
User Guide · Authoring reportsThe full parameter type catalog, per-worksheet mapping shapes, replication and cross-join behavior, and parameter sets.
- Workday Adaptive functions
User Guide · Worksheet functionsFull reference for the seven RW.Adaptive.* worksheet functions that read from and write back to Workday Adaptive Planning, with every argument and default, and why their AI* aliases are not artificial intelligence.
- 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.
- Relational database functions
User Guide · Worksheet functionsFull reference for RW.Relational.Export, Update and Upsert, the functions that read from and write back to SQL, OLE DB and ODBC sources, with every argument, the table-target rules, and how to split a long query across cells.
- Anaplan functions
User Guide · Worksheet functionsFull reference for ANAPLANINPUT, the Anaplan write-back function, including the tuple breadcrumb it depends on and why its optional trailing arguments are a trap.
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.