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.
On-premises scripts#
Rest API Run Job Sample
Version 2.4
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
- Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your PA v11 TM1 REST API Processes endpoint.
- Open the process, edit JobRequestFolder and PowerShellScriptFolder in the prolog so they point at real folders on this TM1 server, set the
pApiUrl,pAccessTokenandpJobNameparameter defaults, then run it.
Files
- Reportworq - Rest API Run Job Sample 2.4.pro (15 KB)
1aa4f8ab6496447ae9a3b9e0fd6608e0bf0cb137a256ecf3adeb3d5a1e5315c8 - Reportworq - Rest API Run Job Sample 2.4.json (15 KB)
cea037a52bb554f551f95b3b3bba85ad8d36d18894b8fcca080f3d7951cfc1a3
Parameters (10)
pApiUrl: Api endpoint for running a job from TIpAccessToken: Access token required for API accesspJobName: 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 ReportworqpLogLevel: Optional Reportworq job log level (Debug/Trace)
Rest API Run Job Sample - v12 On-Prem
Version 1.0
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
- 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.
- Open the process, set the
pApiUrlparameter default to this Reportworq server's API URL, paste the Local API access token intopAccessToken, setpJobName, then run it.
Files
- Reportworq - Rest API Run Job Sample - v12 On-Prem - 1.0.pro (22 KB)
02d3550606f7bfef57fe51222570e4e4497bfbb5c2738b0506e578975cf033aa - Reportworq - Rest API Run Job Sample - v12 On-Prem - 1.0.json (23 KB)
2ce0bb00f07cd1d1d17de19ef3a96473105b992a6236b7b7b0aeef8a61ff0f6d
Parameters (10)
pApiUrl: Api endpoint for running a job from TIpAccessToken: Access token required for API access - in Reportworq: Settings -> Configuration -> API -> Local API keyspJobName: 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
Global Pause Control Sample 1.0 (PA Engine)
Version 1.0
What it does and how to import
What it does
Pauses, resumes, checks or cancels all Reportworq job execution from a TurboIntegrator process through the local Reportworq REST API with ExecuteHttpRequest, optionally waiting until every running job is held.
How to import
- Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your Planning Analytics Engine or Planning Analytics as a Service TM1 REST API Processes endpoint.
- Set the
pApiUrl(ending in api/v1/) andpAccessTokenparameter defaults (the token is a Local API key: Settings, Configuration, API), setpAcceptSelfSignedCertificateto 1 for a self-signed certificate, then run it withpActionset to pause, resume, status or cancelall. A pause logs a holdId: resume withpHoldIdset to it to release only that pause, or blank to release every pause.
Files
- Reportworq - Global Pause Control Sample 1.0 (PA Engine).pro (14 KB)
822683664df55efd7fb13280622678999ea3078b5750cfd2c539334482b6c6ed - Reportworq - Global Pause Control Sample 1.0 (PA Engine).json (15 KB)
657645f673c79f71a37900b3324cf19fe56cede982b06be9179b1fd916ad8e23
Parameters (11)
pApiUrl: Base address of the Reportworq REST API, ending in api/v1/pAccessToken: Access token required for API access, in Reportworq: Settings, Configuration, API, Local API keyspAction: Action: pause, resume, status or cancelallpDurationMinutes: Pause only: whole minutes to stay paused once every running job is held, blank or 0 = until resumedpWaitForPause: Pause only: wait until every running job is held (true/false)pWaitSeconds: Seconds to wait in one call for the pause to complete (1 to 300)pMaxWaits: How many waits ofpWaitSecondsbefore giving uppFailIfNotPaused: Stop the process with an error when the pause is not confirmed in time (1 = yes, 0 = continue)pIncludePending: Cancel all only: also cancel jobs that are still Pending (true/false)pAcceptSelfSignedCertificate: 1 = do not verify the Reportworq TLS certificate (self-signed), 0 = verify itpHoldId: Resume only: the holdId a pause logged, to release only that hold (blank = release every pause: an all-clear)
Pause Run Resume Sample 1.0 (PA Engine)
Version 1.0
What it does and how to import
What it does
Pauses Reportworq with ExecuteHttpRequest, waits until every running job is held, runs another TurboIntegrator process such as a dimension update, and always resumes Reportworq afterwards.
How to import
- Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your Planning Analytics Engine or Planning Analytics as a Service TM1 REST API Processes endpoint.
- Set the
pApiUrl(ending in api/v1/) andpAccessTokenparameter defaults (a Local API key: Settings, Configuration, API), setpProcessNameto the process to run while Reportworq is paused andpDurationMinutesto longer than it needs (the safety net that resumes Reportworq if this process dies), then schedule this process in place of that one.
Files
- Reportworq - Pause Run Resume Sample 1.0 (PA Engine).pro (16 KB)
004469182163890197308010688696d297b818437ad6d88a46494785da8bae7e - Reportworq - Pause Run Resume Sample 1.0 (PA Engine).json (17 KB)
f5107ca9c40bfc4478e57938f350b5bd9dcb2822271e373d6f9900e65b6eb4ed
Parameters (7)
pApiUrl: Base address of the Reportworq REST API, ending in api/v1/pAccessToken: Access token required for API access, in Reportworq: Settings, Configuration, API, Local API keyspProcessName: The TI process to run while Reportworq is pausedpDurationMinutes: Safety net: Reportworq resumes by itself this many minutes after it is fully pausedpWaitSeconds: Seconds to wait in one call for the pause to complete (1 to 300)pMaxWaits: How many waits ofpWaitSecondsbefore giving uppAcceptSelfSignedCertificate: 1 = do not verify the Reportworq TLS certificate (self-signed), 0 = verify it
Global Pause Control Sample 1.0 (PA v11)
Version 1.0
What it does and how to import
What it does
The Planning Analytics v11 variant of Global Pause Control: the same four actions, sent with curl through ExecuteCommand because v11 has no ExecuteHttpRequest. Needs the Pause Response Reader.
How to import
- Import this process and Reportworq - Pause Response Reader 1.0 (PA v11) with Architect or Planning Analytics Workspace (Processes, Import), or POST both .json files to your TM1 REST API Processes endpoint. Keep the reader's name exactly as it is.
- Set the
pApiUrl(ending in api/v1/) andpAccessTokenparameter defaults (a Local API key: Settings, Configuration, API), setpAcceptSelfSignedCertificateto 1 for a self-signed certificate andpCurlPathif curl is not on the TM1 server's PATH, then run it withpActionset to pause, resume, status or cancelall.
Files
- Reportworq - Global Pause Control Sample 1.0 (PA v11).pro (20 KB)
9ee4492559b15c0400e1d2415161c9faff8f7e8da69a73d81c1c20fc4dd26227 - Reportworq - Global Pause Control Sample 1.0 (PA v11).json (21 KB)
a045379459468aa28e7fb0f8a199a8f03a1bdc04c0a197743210747cee233f69
Parameters (12)
pApiUrl: Base address of the Reportworq REST API, ending in api/v1/pAccessToken: Access token required for API access, in Reportworq: Settings, Configuration, API, Local API keyspAction: Action: pause, resume, status or cancelallpDurationMinutes: Pause only: whole minutes to stay paused once every running job is held, blank or 0 = until resumedpWaitForPause: Pause only: wait until every running job is held (true/false)pWaitSeconds: Seconds to wait in one call for the pause to complete (1 to 300)pMaxWaits: How many waits ofpWaitSecondsbefore giving uppFailIfNotPaused: Stop the process with an error when the pause is not confirmed in time (1 = yes, 0 = continue)pIncludePending: Cancel all only: also cancel jobs that are still Pending (true/false)pAcceptSelfSignedCertificate: 1 = do not verify the Reportworq TLS certificate (self-signed, curl option -k), 0 = verify itpHoldId: Resume only: the holdId a pause logged, to release only that hold (blank = release every pause: an all-clear)pCurlPath: The curl program to run, for exampleC:\or /usr/bin/curl (blank = curl on the PATH)Windows\ System32\ curl.exe
Pause Run Resume Sample 1.0 (PA v11)
Version 1.0
What it does and how to import
What it does
The Planning Analytics v11 variant of Pause Run Resume: pauses Reportworq with curl through ExecuteCommand, waits until every running job is held, runs another TurboIntegrator process, and always resumes Reportworq afterwards. Needs the Pause Response Reader.
How to import
- Import this process and Reportworq - Pause Response Reader 1.0 (PA v11) with Architect or Planning Analytics Workspace (Processes, Import), or POST both .json files to your TM1 REST API Processes endpoint. Keep the reader's name exactly as it is.
- Set the
pApiUrl(ending in api/v1/) andpAccessTokenparameter defaults (a Local API key: Settings, Configuration, API), setpProcessNameto the process to run while Reportworq is paused,pDurationMinutesto longer than it needs, andpCurlPathif curl is not on the TM1 server's PATH, then schedule this process in place of that one.
Files
- Reportworq - Pause Run Resume Sample 1.0 (PA v11).pro (22 KB)
9e94441079bc0aae857b1f7a48842ea2c7019db91a16c5d5e853d84966eb0c28 - Reportworq - Pause Run Resume Sample 1.0 (PA v11).json (22 KB)
0da3922c8b28353978a23bca035c142dc6df703f4b4be4922b2bef5dc6829d4e
Parameters (8)
pApiUrl: Base address of the Reportworq REST API, ending in api/v1/pAccessToken: Access token required for API access, in Reportworq: Settings, Configuration, API, Local API keyspProcessName: The TI process to run while Reportworq is pausedpDurationMinutes: Safety net: Reportworq resumes by itself this many minutes after it is fully pausedpWaitSeconds: Seconds to wait in one call for the pause to complete (1 to 300)pMaxWaits: How many waits ofpWaitSecondsbefore giving uppAcceptSelfSignedCertificate: 1 = do not verify the Reportworq TLS certificate (self-signed, curl option -k), 0 = verify itpCurlPath: The curl program to run, for exampleC:\or /usr/bin/curl (blank = curl on the PATH)Windows\ System32\ curl.exe
Pause Response Reader 1.0 (PA v11)
Version 1.0
What it does and how to import
What it does
The helper both Planning Analytics v11 pause samples call to read the Reportworq answer that curl wrote to a file. Import it with them; you do not run it yourself.
How to import
- Import it with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your TM1 REST API Processes endpoint, under exactly this name.
- Nothing to configure: the PA v11 pause samples set its
pFileparameter each time they call it.
Files
- Reportworq - Pause Response Reader 1.0 (PA v11).pro (5 KB)
fc653a9814e7965a54dc2369f9b3d6f0155692b5447fae33fdc43a274f87012b - Reportworq - Pause Response Reader 1.0 (PA v11).json (5 KB)
c1b544d4edbd6e3d76a8746d32e822f616a32ec737b026bbda57ba7710e117f8
Parameters (1)
pFile: Full path of the answer file to read (set by the PA v11 pause samples; blank reads nothing)
RunApiJob.ps1
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
- Copy RunApiJob.ps1 to the folder the on-premises PA v11 sample's PowerShellScriptFolder points at (
C:\by default); on a Reportworq server the installer has already placed a copy atReportworq\ Scripts\ <install>\andVersions\ v<version>\ RunApiJob.ps1 <install>\.Versions\ v<version>\ Scripts\ RunApiJob.ps1 - 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 (8 KB)
c53163773f386f2237f2f8140cac882bbb9ddd594a47f20d9c199253d6603614
Cloud scripts#
Rest API Run Job Sample - Cloud
Version 1.1
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
- 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.
- Open the process, set the
pApiUrlandpCloudConnectorApiKeyparameter defaults to your Reportworq Cloud connector endpoint and key, setpJobName(andpWorkspaceNameif the instance has more than one workspace), then run it.
Files
- Reportworq - Rest API Run Job Sample - Cloud - 1.1.pro (22 KB)
1703b83745bf318e5883554383618df112f07524d9b63d9664692274767f2948 - Reportworq - Rest API Run Job Sample - Cloud - 1.1.json (23 KB)
395cccb81f5e045f57fa924688524f0af818a23455fa115d1012fdff3eeb1834
Parameters (11)
pApiUrl: Cloud API endpoint for running a job from TIpCloudConnectorApiKey: Cloud API KeypJobName: Reportworq Job Path (MyFolder/MyJob or MyJob)pWorkspaceName: Reportworq workspace to run job on. If there is only one workspace available, this parameter is optionalpNotificationEmail: 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 ReportworqpLogLevel: Optional Reportworq job log level (Debug/Trace)
Rest API Run Job Sample - v12
Version 1.0
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
- 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.
- Open the process, set the
pApiUrlandpCloudConnectorApiKeyparameter defaults to your Reportworq Cloud connector endpoint and key, setpJobName(andpWorkspaceNameif the instance has more than one workspace), then run it.
Files
- Reportworq - Rest API Run Job Sample - v12 - 1.0.pro (20 KB)
3601191b4c912664be96a33e78d85b5d5b3783f9d54b404c5905c5e5b4daf62d - Reportworq - Rest API Run Job Sample - v12 - 1.0.json (21 KB)
9fc3d1b16fdd9da59d2bda7edbbef84f51e650197fca3378fa1bbd166b0d7e16
Parameters (11)
pApiUrl: Cloud API endpoint for running a job from TIpCloudConnectorApiKey: Cloud API KeypJobName: Reportworq Job Path (MyFolder/MyJob or MyJob)pWorkspaceName: Reportworq workspace to run job on. If there is only one workspace available, this parameter is optionalpNotificationEmail: 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
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
- 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.
- Download it to inspect the script, or to replace a stale copy at <TM1 data directory>\Reportworq\Reportworq_RunAPIJob.ps1 on the TM1 server.
- It is unsigned, like the copy the process writes itself.
Files
- Reportworq_RunAPIJob.ps1 (2 KB)
154a6cb994269ba00c6768727ada4c5431ca7251377e79d3e1dd0e644807a0b1
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>\. 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 pageOr write to support@reportworq.com directly.