What's new ⬇ Download Reportworq
⬇ Guide PDF
Home › Reference › Downloads
referenceadministratorintegration user

TM1 Script Downloads#

Turbo Integrator process samples and the PowerShell launcher, offered as plain downloads so you can pick up the latest version without upgrading your instance of Reportworq.

Showing 6 of 6 Download everything as a ZIP (186 KB)

On-premises scripts#

Rest API Run Job Sample
Version 2.4

IBM Planning Analytics v11 (on-premises)Reportworq 6.0.0.1 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 TurboIntegrator on classic on-premises Planning Analytics v11, by writing a JSON job request to disk and calling RunApiJob.ps1 through ExecuteCommand.

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. Open the process, edit JobRequestFolder and PowerShellScriptFolder in the prolog so they point at real folders on this TM1 server, set the pApiUrl, pAccessToken and pJobName parameter defaults, then run it.

Files

  • Reportworq - Rest API Run Job Sample 2.4.pro (13 KB) 6cd8e84409bfca8d74aafec19bf20b87add0cb90a6e96b20c14d8dc451941dad
  • Reportworq - Rest API Run Job Sample 2.4.json (14 KB) dda7e50676f89111d7bda6f493f73c6a3ef1cf2bccbf80a73a2018226c537210
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)

Rest API Run Job Sample - v12 On-Prem
Version 1.0

Planning Analytics v12 / PA-Engine (on-premises)Reportworq 6.0.0.3 or laterLast changed 2026-08-31

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

What it does

Runs a Reportworq job from TurboIntegrator on on-premises Planning Analytics v12 / PA-Engine, posting to the local Reportworq API with the native ExecuteHttpRequest function and no PowerShell.

How to import

  1. Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your on-premises PA v12 / PA-Engine TM1 REST API Processes endpoint.
  2. Open the process, set the pApiUrl parameter default to this Reportworq server's API URL, paste the Local API access token into pAccessToken, set pJobName, then run it.

Files

  • Reportworq - Rest API Run Job Sample - v12 On-Prem - 1.0.pro (22 KB) 0c958dd22282e5b8f0c90abb4e366127c969686c5a236d437b9ece7365236298
  • Reportworq - Rest API Run Job Sample - v12 On-Prem - 1.0.json (23 KB) 566e0d2fb49ba35bea0bdda1de156719fee48f7e3b364513f0105332cd8b1285
Parameters (10)
  • pApiUrl: Api endpoint for running a job from TI
  • pAccessToken: Access token required for API access - in Reportworq: Settings -> Reportworq API -> the Local API access token
  • 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)
  • pLogLevel: Optional Reportworq job log level (Debug/Trace)
  • pRequestLogFolder: Optional folder to write a timestamped copy of the request (URL + JSON payload) and response (status + body) for debugging. Leave blank to write no file

RunApiJob.ps1

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

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

What it does

The PowerShell helper the on-premises PA v11 sample calls through ExecuteCommand to post a Reportworq job request to the Reportworq REST API.

How to import

  1. Copy RunApiJob.ps1 to the folder the on-premises PA v11 sample's PowerShellScriptFolder points at (C:\Reportworq\Scripts by default); on a Reportworq server the installer has already placed a copy at <install>\Versions\v<version>\RunApiJob.ps1 and <install>\Versions\v<version>\Scripts\RunApiJob.ps1.
  2. This downloaded copy is unsigned, unlike the two installed copies, which the release pipeline Authenticode-signs - so Windows may mark it as coming from the internet; run Unblock-File on it, or use the signed installed copy instead.

Files

  • RunApiJob.ps1 (7 KB) c2206830d0df4fa2fb558d192fe456823a238c1a5a9f164c01ceb4766a941098

Cloud scripts#

Rest API Run Job Sample - Cloud
Version 1.1

IBM Planning Analytics v11 Cloud (IBM-hosted)Reportworq 6.0.0.1 or laterLast changed 2026-08-05

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

What it does

Runs a Reportworq job from TurboIntegrator on IBM-hosted Planning Analytics v11 Cloud, by writing an embedded PowerShell script to the model's own file space and calling the Reportworq Cloud connector REST API through it.

How to import

  1. Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your IBM-hosted PA v11 Cloud TM1 REST API Processes endpoint.
  2. Open the process, set the pApiUrl and pCloudConnectorApiKey parameter defaults to your Reportworq Cloud connector endpoint and key, set pJobName (and pWorkspaceName if the instance has more than one workspace), then run it.

Files

  • Reportworq - Rest API Run Job Sample - Cloud - 1.1.pro (20 KB) 94f73f6b6808641fb7a901c7badd5cfb6a531a7b2316d61be39a0b57f21a1c09
  • Reportworq - Rest API Run Job Sample - Cloud - 1.1.json (21 KB) 7c1ae5820bd7f5cb128ebfc55099b0a6efc15b52dae84f35eaf112a3bff42388
Parameters (11)
  • pApiUrl: Cloud 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)

Rest API Run Job Sample - v12
Version 1.0

Planning Analytics v12 Cloud / PAaaSReportworq 6.0.0.3 or laterLast changed 2026-08-28

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

What it does

Runs a Reportworq job from TurboIntegrator on Planning Analytics v12 Cloud / PAaaS, posting to the Reportworq Cloud connector REST API with the native ExecuteHttpRequest function and no PowerShell.

How to import

  1. Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your PA v12 Cloud / PAaaS TM1 REST API Processes endpoint.
  2. Open the process, set the pApiUrl and pCloudConnectorApiKey parameter defaults to your Reportworq Cloud connector endpoint and key, set pJobName (and pWorkspaceName if the instance has more than one workspace), then run it.

Files

  • Reportworq - Rest API Run Job Sample - v12 - 1.0.pro (20 KB) 8df62444120a2ca08091f4c3d57253ff53a3b0a5300231311de88ae91f0921e3
  • Reportworq - Rest API Run Job Sample - v12 - 1.0.json (21 KB) 7c15c7e281482026cebcaa2ffc51352ac346391a7015ead6e8ff748f693c3e89
Parameters (11)
  • pApiUrl: Cloud 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)
  • pLogLevel: Optional Reportworq job log level (Debug/Trace)
  • pRequestLogFolder: Optional folder to write a timestamped copy of the request (URL + JSON payload) and response (status + body) for debugging. Leave blank to write no file

Reportworq_RunAPIJob.ps1

IBM Planning Analytics v11 Cloud (IBM-hosted)Reportworq 6.0.0.1 or laterLast changed 2026-07-09

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

What it does

The PowerShell client the Cloud 1.1 process writes into its './Reportworq/' folder on the TM1 server and calls to post the job request to the Reportworq Cloud connector.

How to import

  1. Normally there is nothing to do: the Cloud 1.1 TI process writes this file into its own './Reportworq/' folder on the TM1 server when it runs.
  2. Download it to inspect the script, or to replace a stale copy at <TM1 data directory>\Reportworq\Reportworq_RunAPIJob.ps1 on the TM1 server.
  3. It is unsigned, like the copy the process writes itself.

Files

  • Reportworq_RunAPIJob.ps1 (2 KB) 1ff8d3637895b3cf43f9e0bdbbcdc5956f75e4e8eebf73c56f8be351c3e47304
Why these downloads exist

The in-product installer is the normal way to get these files onto a Planning Analytics server (see Turbo Integrator and automation and Connect IBM Planning Analytics). That installer is deliberately conservative: install does not overwrite an existing process, so an instance running an older release of Reportworq keeps installing the version of a sample that shipped with it, 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:

  • Windows (PowerShell): Get-FileHash <file> (defaults to SHA-256).
  • macOS or Linux: shasum -a 256 <file>.

A match confirms the file arrived exactly as published.

About the unsigned PowerShell script

The downloaded copy of RunApiJob.ps1 is unsigned. A signed copy is inside every Reportworq install at <install>\Versions\v<version>\RunApiJob.ps1. 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.