AI & Integrations Guide#

Decide what Reportworq connects to and on what terms: source report providers, data sources and connectors, authentication providers, AI providers, Microsoft 365 Copilot and MCP with a content-security strategy, the REST API, and the Script Runner.

Integration strategy#

• Plan your integrations - The 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#

• Source report providers - The 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.
• Set up Google Drive - Connect Reportworq to Google Drive as both a report provider (read source workbooks) and a distributor (deliver output). Choose OAuth (recommended) or a Google Cloud service account with a JSON key, Shared Drive vs. folder IDs, and Domain-Wide Delegation with an impersonated Workspace user.

Data sources & connectors#

• The integrations hub - Settings, Integrations is the single place to add, test, enable, and edit every external connection Reportworq uses, grouped into families covering authentication, the MCP platform tool, AI providers, datasources, distributors, report providers, and shared credentials.
• Connect a data source - 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.
• Connector catalog - Every datasource connector Reportworq ships, grouped by category, with the authentication approach and the per-connector traps that most often block a connection.
• Connect IBM Planning Analytics - Connect Reportworq to IBM Planning Analytics (TM1), choose the right authentication type for self-hosted, IBM Cloud, or IBM SaaS (MCSP), and handle the deployment traps that support is most often asked about.
• IBM Planning Analytics functions - Full 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.
• Connect Workday Adaptive Planning - Connect Reportworq to Workday Adaptive Planning so it can refresh OfficeConnect Excel reports through the Adaptive Planning API, including the token-based Workday OAuth mode where Reportworq handles the access-token and public-API-token exchange for you.
• Connect Oracle Smart View - Connect Reportworq to Oracle EPM Cloud (Fusion Cloud EPM Planning) with the Oracle Smart View connector, author a Smart View grid Reportworq can refresh, use the Oracle Smart View Dimension parameter, and distribute the result through the normal Reportworq channels.
• Connect SQL Server, OLE DB, and ODBC - Decide between the native SQL Server connector and the generic OLE DB and ODBC connectors, learn what each one requires, configure the shared connection editor with credentials kept out of the connection string, and copy a working example connection string for SQL Server, Azure SQL, OLE DB providers, and the common ODBC drivers.
• Connect SQLite - Connect Reportworq to a file-backed SQLite database with the built-in SQLite connector, point the connection string at a file on the server or inside the repository, and query it through table or SQL mode like any other relational source.
• Connect Snowflake - Connect Reportworq to a Snowflake data warehouse. The guided CData Snowflake tile is the preferred path, with named fields and native key-pair authentication; a native ODBC route is available as an alternative.
• Connect Snowflake via ODBC - How to connect Reportworq to Snowflake through the generic ODBC Provider datasource tile - driver prerequisites, the recommended System DSN approach, and DSN-less connection strings for key-pair and username/password auth. A native ODBC alternative to the guided CData SnowFlake tile.
• Connect CData sources - Connect Reportworq to API and SaaS systems such as Salesforce, Jira, NetSuite, Dynamics 365, and Workday through the CData drivers Reportworq ships, find each driver's connection properties, and query the source like a relational database.
• Connect QuickBooks Online - Connect Reportworq to a QuickBooks Online company and complete the OAuth 2.0 sign-in on a headless or server install, where there is no browser on the server, using the server-side redirect flow.
• Connect Excel - Connect an Excel workbook as a tabular data source through the Excel connector Reportworq ships, keep the workbook on the server or ship it inside the repository with the repository: prefix, and query each worksheet like a database table.
• Connect Power BI and Analysis Services - 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 - 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.

Identity & authentication#

• Authentication providers - Which 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.
• Microsoft 365 OAuth setup - Register an Azure (Entra ID) application and authenticate Reportworq to it as a Microsoft 365 shared credential, so Entra sign-in, the SharePoint provider, the Email, SharePoint, and Teams distributors, and email data collection can each reference it by name.
• Google Workspace OAuth setup - Register a Google Cloud OAuth client and connect a Google Workspace shared credential in Reportworq to it, so the Google Drive report provider and the Google Drive distributor can each reference it by name and authenticate as a Workspace identity instead of a per-role service-account JSON key.

AI in Reportworq#

• AI in Reportworq - How 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.
• Connect an AI provider - 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.
• The AI assistant - The 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.
• AI-generated insights in reports - 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.
• The AI prompt store - The 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.

Copilot & MCP#

• Copilot, MCP, and trust paths - The 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.
• Secure content before you expose it to AI - The 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.
• Microsoft 365 Copilot agent - 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.
• The MCP shim for desktop AI clients - 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.
• MCP audit - The 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.

Automation & extensibility#

• The automation API - Reportworq'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.
• Run a job by API - 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.
• Turbo Integrator, Workato, and Task Scheduler - Launch Reportworq jobs from an IBM Planning Analytics Turbo Integrator process (including the native ExecuteHttpRequest samples for PA v12, both Cloud/PAaaS and on-premises PA-Engine, picked from the install chooser), from a Workato recipe, or from Windows Task Scheduler, with the PowerShell hang fix for the v11 samples.
• Deploy the Office add-in - 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.
• The Script Runner - 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.
• Script API reference - Everything 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 - A 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.

IBM Planning Analytics function reference#

• DBRW function - Reference 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 - Reference 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 - Reference 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 - Reference for the native TM1 VIEW worksheet function in Reportworq - assemble a server:cube:view reference for a block of retrieval formulas.
• ELPAR function - Reference for the native TM1 ELPAR worksheet function in Reportworq - return a parent of an element by index.
• ELPARN function - Reference for the native TM1 ELPARN worksheet function in Reportworq - return the number of parents of an element.
• ELLEV function - Reference for the native TM1 ELLEV worksheet function in Reportworq - return the level of an element.
• ELWEIGHT function - Reference for the native TM1 ELWEIGHT worksheet function in Reportworq - return the weight of a child in its consolidation.
• ELCOMP function - Reference for the native TM1 ELCOMP worksheet function in Reportworq - return a child (component) of a consolidated element by index.
• ELCOMPN function - Reference for the native TM1 ELCOMPN worksheet function in Reportworq - return the number of children of a consolidated element.
• ELISCOMP function - Reference for the native TM1 ELISCOMP worksheet function in Reportworq - test whether one element is a component (child) of another.
• ELISPAR function - Reference for the native TM1 ELISPAR worksheet function in Reportworq - test whether one element is a parent of another.
• ELSLEN function - Reference for the native TM1 ELSLEN worksheet function in Reportworq - return the length of an element's name.
• DIMIX function - Reference for the native TM1 DIMIX worksheet function in Reportworq - return the index of an element within a dimension.
• DIMSIZ function - Reference for the native TM1 DIMSIZ worksheet function in Reportworq - return the number of elements in a dimension.
• DNEXT function - Reference for the native TM1 DNEXT worksheet function in Reportworq - return the next element in a dimension.
• DNLEV function - Reference for the native TM1 DNLEV worksheet function in Reportworq - return the number of hierarchy levels in a dimension.
• DTYPE function - Reference for the native TM1 DTYPE worksheet function in Reportworq - return an element or attribute type code.
• DFRST function - Reference for the native TM1 DFRST worksheet function in Reportworq - return the first element in a dimension.
• TABDIM function - Reference for the native TM1 TABDIM worksheet function in Reportworq - return the name of a cube's dimension at a given position.
• SUBSIZ function - Reference 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 - Reference 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 - Reference for the native TM1 TM1RPTVIEW Active Form worksheet function in Reportworq - the anchor of an Active Form report region.
• TM1RPTROW function - Reference 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 - Reference for the native TM1 TM1RPTTITLE Active Form worksheet function in Reportworq - emits a title member reference for an Active Form.
• TM1RPTFILTER function - Reference for the native TM1 TM1RPTFILTER Active Form worksheet function in Reportworq - builds the sort and filter MDX for an Active Form region.
• TM1RPTELISCONSOLIDATED function - Reference for the native TM1 TM1RPTELISCONSOLIDATED Active Form worksheet function in Reportworq - tests whether an Active Form row is a consolidation.
• TM1RPTELLEV function - Reference for the native TM1 TM1RPTELLEV Active Form worksheet function in Reportworq - returns the display level of an Active Form row.
• TM1RPTELISEXPANDED function - Reference for the native TM1 TM1RPTELISEXPANDED Active Form worksheet function in Reportworq - always returns FALSE because Active Form drilling is not supported.
• TM2RPTELISCONSOLIDATED function - Reference for the native TM1 TM2RPTELISCONSOLIDATED Universal Report worksheet function in Reportworq - tests whether a Universal Report axis member is a consolidation.
• TM2RPTELLEV function - Reference for the native TM1 TM2RPTELLEV Universal Report worksheet function in Reportworq - returns the display level of a Universal Report axis member.
• TM2RPTELISEXPANDED function - Reference for the native TM1 TM2RPTELISEXPANDED Universal Report worksheet function in Reportworq - always returns FALSE because Universal Report drilling is not supported.
• TM1ELLIST function - Reference 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 - Reference for the native TM1 TM1VAL worksheet function in Reportworq - a hierarchy-aware cube retrieval, the complement to DBR. Read mode only.
• DefineCalc function - Reference for the native TM1 DefineCalc worksheet function in Reportworq - declare an MDX calculated member for use in cube retrieval.
• TM1USER function - Reference for the native TM1 TM1USER worksheet function in Reportworq - return the current user's display name on a server.
• TM1SET function - Reference 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 - Reference for the native TM1 TM1PRIMARYDATASOURCE worksheet function in Reportworq - returns the workbook's last-saved primary data source value.
• TM1PRIMARYDBNAME function - Reference for the native TM1 TM1PRIMARYDBNAME worksheet function in Reportworq - returns the workbook's last-saved primary server name.