⬇ Download Reportworq

This is the archived documentation for Reportworq 5. It is kept for reference and is no longer updated. The TM1 script downloads on this page are the exception. They are regenerated from the latest Reportworq 5 release.

Go to the Reportworq 6 documentation
Home › Support

TM1 script downloads#

The current Turbo Integrator process samples and PowerShell launcher for Reportworq 5, as plain downloads so you can pick up the latest version without upgrading your server.

Showing 6 of 6

On-premises scripts#

Rest API Run Job Sample
Version 2.4

IBM Planning Analytics v11 (on-premises)Reportworq 5.0.0.87 or laterLast changed 2026-09-02

⬇ pro · 13 KB⬇ json · 14 KB
What it does and how to import

What it does

Runs a ReportWORQ job from a TurboIntegrator process by calling the ReportWORQ REST API through the RunApiJob.ps1 PowerShell client.

How to import

  1. Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your PA v11 TM1 REST API Processes endpoint.
  2. Point JobRequestFolder and PowerShellScriptFolder in the prolog at real folders on this TM1 server.
  3. Set the pApiUrl, pAccessToken and pJobName parameter defaults, then run the process.

Files

  • ReportWORQ - Rest API Run Job Sample 2.4.pro (13 KB) 0891c0a13ce1ea8b0d3dde76be551b1d72dca9c48f5ff612754b80fe133ad830
  • ReportWORQ - Rest API Run Job Sample 2.4.json (14 KB) f2362695cddaf9cfc484cc2851849188cb6f71d5578533c0a029e45fb4fda0f3
Parameters (10)
  • pApiUrl: Api endpoint for running a job from TI
  • pAccessToken: Access token required for API access
  • pJobName: ReportWORQ Job Path (MyFolder/MyJob or MyJob)
  • pNotificationEmail: Email address to send notification (optional)
  • pHoldForDelivery: Hold Jobs for Review before Distribution (true/false)
  • pAllowedFileOutputTypes: Allowed output types for the job, semicolon delimited, blank defaults to all configured (excel/pdf/ppt/csv)
  • pAllowedDestinationTypes: Allowed distribution types for the job, semicolon delimited, blank defaults to all configured (file/sharepoint/sheets/email/slack/teams)
  • pConvertPowerPointToPdf: Convert PPT files to PDF before Distribution (true/false)
  • pTlsSecurity: Supported Tls security modes used to connect to ReportWORQ
  • pLogLevel: Optional ReportWORQ job log level (Debug/Trace)

Add Queued Job Sample
Version 1.2

IBM Planning Analytics v11 (on-premises)Reportworq 5.0.0.82 or laterLast changed 2026-03-13

⬇ pro · 4 KB⬇ json · 4 KB
What it does and how to import

What it does

Queues a ReportWORQ job from a TurboIntegrator process by adding a row to the job-queue cube that Cube Monitor polls.

How to import

  1. Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your PA v11 TM1 REST API Processes endpoint.
  2. Set the pServer, pJobDefinition, pNotificationEmail and pReadyToRun parameter defaults, then run the process.
  3. Switch on Enable Cube Monitor for this server's connection in ReportWORQ; queued rows are only picked up while it is on.

Files

  • ReportWORQ - Add Queued Job Sample 1.2.pro (4 KB) 0893ba7530523ef9710b0838b866784ccc8933db7145cf06f05a7c1235beedd7
  • ReportWORQ - Add Queued Job Sample 1.2.json (4 KB) a90bb558e3e57d28e23609415f4d5f691ab10d2990591f98493a684be7813789
Parameters (4)
  • pServer: TM1 Server Name
  • pJobDefinition: ReportWORQ Job Definition
  • pNotificationEmail: Email address to send notification
  • pReadyToRun: Begin Running Job

Add Queued Job For Workspace Sample
Version 1.3

IBM Planning Analytics v11 (on-premises)Reportworq 5.0.0.82 or laterLast changed 2026-03-13

⬇ pro · 5 KB⬇ json · 4 KB
What it does and how to import

What it does

Queues a ReportWORQ job on a named workspace from a TurboIntegrator process by adding a row to the job-queue cube that Cube Monitor polls.

How to import

  1. Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your PA v11 TM1 REST API Processes endpoint.
  2. Set the pServer, pJobDefinition, pNotificationEmail, pReadyToRun and pWorkspaceName parameter defaults, then run the process.
  3. Switch on Enable Cube Monitor for this server's connection in ReportWORQ; queued rows are only picked up while it is on.

Files

  • ReportWORQ - Add Queued Job For Workspace Sample 1.3.pro (5 KB) 958c9fbf8b0bf9fe030e938a5a4ec7514400585906a443c4f21dda4212dcaf4b
  • ReportWORQ - Add Queued Job For Workspace Sample 1.3.json (4 KB) c203a0bf2a5b9881024cd2040ee6053e1ff32cf432118a39e4003d8e6825eed8
Parameters (5)
  • pServer: TM1 Server Name
  • pJobDefinition: ReportWORQ Job Definition
  • pNotificationEmail: Email address to send notification
  • pReadyToRun: Begin Running Job
  • pWorkspaceName: ReportWORQ workspace to run job on

RunApiJob.ps1

Windows PowerShell 5.1 or laterReportworq 5.0.0.87 or laterLast changed 2026-09-02

⬇ ps1 · 7 KB
What it does and how to import

What it does

The PowerShell client the on-premises Rest API Run Job sample invokes to POST a job request to the ReportWORQ REST API.

How to import

  1. Copy RunApiJob.ps1 to the folder the sample's PowerShellScriptFolder points at (C:\ReportWORQ\Scripts by default).
  2. On a ReportWORQ server the installer has already placed a signed copy in the WebApp folder, C:\Program Files\ReportWORQ\Versions\v<version>;.
  3. This download is unsigned, so Windows may block it as an internet file: run Unblock-File on it, or use the installed signed copy.

Files

  • RunApiJob.ps1 (7 KB) 90499e3407cfa18bc65e2df5bede888aa7eee6196c4759948afc6e7927a16fc9

Cloud scripts#

Rest API Run Job Sample - Cloud
Version 1.1

IBM Planning Analytics v11 Cloud (IBM-hosted)Reportworq 5.0.0.87 or laterLast changed 2026-08-11

⬇ pro · 20 KB⬇ json · 21 KB
What it does and how to import

What it does

Runs a ReportWORQ job from a TurboIntegrator process on Planning Analytics on Cloud through the ReportWORQ Cloud connector.

How to import

  1. Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your PA v11 TM1 REST API Processes endpoint.
  2. Set the pApiUrl, pCloudConnectorApiKey, pJobName and pWorkspaceName parameter defaults, then run the process.
  3. The process writes its own PowerShell client under ReportWORQ in the model's Data folder, so nothing has to be copied to the server.

Files

  • ReportWORQ - Rest API Run Job Sample - Cloud - 1.1.pro (20 KB) 4ebcb2fd6544fd2d2c73ea25dc79cf0e74c085e51676a11af62a21f5db5f4109
  • ReportWORQ - Rest API Run Job Sample - Cloud - 1.1.json (21 KB) 09a8eca9a7d512fea620fc7d74730cd9cd5643fdd28f66668731cf4ea7cc7ea5
Parameters (11)
  • pApiUrl: Could API endpoint for running a job from TI
  • pCloudConnectorApiKey: Cloud API Key
  • pJobName: ReportWORQ Job Path (MyFolder/MyJob or MyJob)
  • pWorkspaceName: ReportWORQ workspace to run job on. If there is only one workspace available, this parameter is optional
  • pNotificationEmail: Email address to send notification (optional)
  • pHoldForDelivery: Hold Jobs for Review before Distribution (true/false)
  • pAllowedFileOutputTypes: Allowed output types for the job, semicolon delimited, blank defaults to all configured (excel/pdf/ppt/csv)
  • pAllowedDestinationTypes: Allowed distribution types for the job, semicolon delimited, blank defaults to all configured (file/sharepoint/sheets/email/slack/teams)
  • pConvertPowerPointToPdf: Convert PPT files to PDF before Distribution (true/false)
  • pTlsSecurity: Supported Tls security modes used to connect to ReportWORQ
  • pLogLevel: Optional ReportWORQ job log level (Debug/Trace)

ReportWORQ_RunAPIJob.ps1

IBM Planning Analytics v11 Cloud (IBM-hosted)Reportworq 5.0.0.87 or laterLast changed 2026-05-26

⬇ ps1 · 2 KB
What it does and how to import

What it does

The PowerShell client that the Cloud 1.1 process writes to the TM1 data directory and runs to POST a job request to the ReportWORQ REST API.

How to import

  1. Normally nothing to do: the Cloud 1.1 process writes this file itself as ReportWORQ\ReportWORQ_RunAPIJob.ps1 under the TM1 data directory the first time it runs.
  2. Download it to inspect what the process runs, or to replace a stale copy: delete ReportWORQ\ReportWORQ_RunAPIJob.ps1 under the TM1 data directory and the process rewrites it on its next run.
  3. This copy is unsigned, exactly like the one the process writes; it never leaves the TM1 server.

Files

  • ReportWORQ_RunAPIJob.ps1 (2 KB) a6060096a836552d6bfb92a63c80159b6903df378477f7bb5192403540c9e8e1
Why these downloads exist

Reportworq 5 ships these same files inside every install. Install does not overwrite an existing process, so a server running an older release keeps whatever version of a sample it was installed with, even after the sample itself has moved on. The files above are the current versions of those same samples.

How to verify your download

Every file above lists a SHA-256 hash. Compare it against a hash you compute locally before you import or run anything: Get-FileHash <file> on Windows, or shasum -a 256 <file> on macOS or Linux.

About the unsigned PowerShell script

The downloaded copy of the PowerShell launcher is unsigned. The copy that ships inside every Reportworq 5 install is Authenticode-signed, at C:\Program Files\ReportWORQ\Versions\v<version>\RunApiJob.ps1 by default. If PowerShell refuses to run the downloaded copy, unblock it first with Unblock-File.

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 page

Or write to support@reportworq.com directly.