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.
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 a TurboIntegrator process by calling the ReportWORQ REST API through the RunApiJob.ps1 PowerShell client.
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.
- Point JobRequestFolder and PowerShellScriptFolder in the prolog at real folders on this TM1 server.
- Set the
pApiUrl,pAccessTokenandpJobNameparameter defaults, then run the process.
Files
- ReportWORQ - Rest API Run Job Sample 2.4.pro (15 KB)
4bb803e97a001be6c4a63f77fea43ffe3e9e2b3615de6b31b3ff98cf895c47f7 - ReportWORQ - Rest API Run Job Sample 2.4.json (15 KB)
7f6de182b3eaa43ec4893da6e247de330783dad3d2c301f48e24c8bb12fc51d0
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)
Add Queued Job Sample
Version 1.2
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
- Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your PA v11 TM1 REST API Processes endpoint.
- Set the
pServer,pJobDefinition,pNotificationEmailandpReadyToRunparameter defaults, then run the process. - 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 NamepJobDefinition: ReportWORQ Job DefinitionpNotificationEmail: Email address to send notificationpReadyToRun: Begin Running Job
Add Queued Job For Workspace Sample
Version 1.3
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
- Import the .pro with Architect or Planning Analytics Workspace (Processes, Import), or POST the .json to your PA v11 TM1 REST API Processes endpoint.
- Set the
pServer,pJobDefinition,pNotificationEmail,pReadyToRunandpWorkspaceNameparameter defaults, then run the process. - 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 NamepJobDefinition: ReportWORQ Job DefinitionpNotificationEmail: Email address to send notificationpReadyToRun: Begin Running JobpWorkspaceName: ReportWORQ workspace to run job on
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 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. Take the token from Reportworq Settings, Reportworq API. - Run the process with
pActionset to pause, resume, status or cancelall. For pause, setpDurationMinutes(blank = until resumed),pWaitForPause,pWaitSecondsandpMaxWaits. For resume, setpHoldIdto the holdId a pause logged to release only that pause (blank releases every pause: an all-clear). - If the Reportworq address uses a self-signed certificate, set
pAcceptSelfSignedCertificateto 1 (the process then passes -k to ExecuteHttpRequest).
Files
- ReportWORQ - Global Pause Control Sample 1.0 (PA Engine).pro (14 KB)
486e5a65b8544c2351b247e687e8926f1c6a7d4ae2f2b5cf6b34a3e8700cf215 - ReportWORQ - Global Pause Control Sample 1.0 (PA Engine).json (15 KB)
930acdd14894c6c4d8191a78d908f985f591e07391fc6d8b2a6fcbde48c40ad6
Parameters (11)
pApiUrl: Base address of the Reportworq REST API, ending in api/v1/pAccessToken: Access token required for API accesspAction: 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. Take the token from Reportworq Settings, Reportworq API. - Set
pProcessNameto the TI process to run while Reportworq is paused, for example your dimension update, andpDurationMinutesto longer than that process needs (it is the safety net that resumes Reportworq if this process dies). - If the Reportworq address uses a self-signed certificate, set
pAcceptSelfSignedCertificateto 1 (the process then passes -k to ExecuteHttpRequest). - Schedule this process in place of the dimension update, for example in a chore every 30 minutes.
Files
- ReportWORQ - Pause Run Resume Sample 1.0 (PA Engine).pro (16 KB)
e1a7cdfad3c3a3262a2d8cad7ce670f8af57299c5f4c134d7cb426d1498dcab3 - ReportWORQ - Pause Run Resume Sample 1.0 (PA Engine).json (16 KB)
5db65606a4207168832b2477cc8e9797bff0f4ccc9ae462eeb02a2cb3c8bc76e
Parameters (7)
pApiUrl: Base address of the Reportworq REST API, ending in api/v1/pAccessToken: Access token required for API accesspProcessName: 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. Take the token from Reportworq Settings, Reportworq API. - Run the process with
pActionset to pause, resume, status or cancelall. For pause, setpDurationMinutes(blank = until resumed),pWaitForPause,pWaitSecondsandpMaxWaits. For resume, setpHoldIdto the holdId a pause logged to release only that pause (blank releases every pause: an all-clear). - If the Reportworq address uses a self-signed certificate, set
pAcceptSelfSignedCertificateto 1 (the process then passes -k to curl). SetpCurlPathif curl is not on the TM1 server's PATH (curl ships with Windows 10 1803 and Windows Server 2019 and later, and with Linux).
Files
- ReportWORQ - Global Pause Control Sample 1.0 (PA v11).pro (20 KB)
7468686a69104ef3d9bf8b18dbfd003e436c0bb15681b1e773f2faaa2a3a56a8 - ReportWORQ - Global Pause Control Sample 1.0 (PA v11).json (21 KB)
c1198b3a8a8cf170c36686783e531e7debf324edd564362cb6d8f84b3db5ae9f
Parameters (12)
pApiUrl: Base address of the Reportworq REST API, ending in api/v1/pAccessToken: Access token required for API accesspAction: 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. Take the token from Reportworq Settings, Reportworq API. - Set
pProcessNameto the TI process to run while Reportworq is paused, for example your dimension update, andpDurationMinutesto longer than that process needs (it is the safety net that resumes Reportworq if this process dies). - If the Reportworq address uses a self-signed certificate, set
pAcceptSelfSignedCertificateto 1 (the process then passes -k to curl). SetpCurlPathif curl is not on the TM1 server's PATH (curl ships with Windows 10 1803 and Windows Server 2019 and later, and with Linux). - Schedule this process in place of the dimension update, for example in a chore every 30 minutes.
Files
- ReportWORQ - Pause Run Resume Sample 1.0 (PA v11).pro (22 KB)
dc15514ed67184bfbb13b53eb073fc285f6cdf5eecfc143e6258b510fde98fd6 - ReportWORQ - Pause Run Resume Sample 1.0 (PA v11).json (22 KB)
3a93d63d032cc360d8ad365a547a00a89e1c10e73943da385a6989ec569b64c5
Parameters (8)
pApiUrl: Base address of the Reportworq REST API, ending in api/v1/pAccessToken: Access token required for API accesspProcessName: 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)
178c24868c73b910debfdd23682ed3a9ac96c006323c9b66f1957b74e175b2b3 - ReportWORQ - Pause Response Reader 1.0 (PA v11).json (5 KB)
4a4381b81e3657b785ba0cefbd17b9b313efce66da387fc6a31d17c23ca1af12
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 client the on-premises Rest API Run Job sample invokes to POST a job request to the ReportWORQ REST API.
How to import
- Copy RunApiJob.ps1 to the folder the sample's PowerShellScriptFolder points at (
C:\by default).ReportWORQ\ Scripts\ - On a ReportWORQ server the installer has already placed a signed copy in the WebApp folder,
C:\;.Program Files\ ReportWORQ\ Versions\ v<version> - 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)
74b8353d4e3739f460f6300193e5ee05e171289ef069d018416bbe8ed7f4c161
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 a TurboIntegrator process on Planning Analytics on Cloud through the ReportWORQ Cloud connector.
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.
- Set the
pApiUrl,pCloudConnectorApiKey,pJobNameandpWorkspaceNameparameter defaults, then run the process. - 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 (22 KB)
b2235bdfe44610abf50b741fb60af3657ad8402b46d9cebf34ca3e826294de29 - ReportWORQ - Rest API Run Job Sample - Cloud - 1.1.json (22 KB)
f09f8bde59e9c2f0cdc1e2e8fe2ec6f07a80a7a650c49ec2204207b268271484
Parameters (11)
pApiUrl: Could 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)
ReportWORQ_RunAPIJob.ps1
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
- 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.
- 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.
- This copy is unsigned, exactly like the one the process writes; it never leaves the TM1 server.
Files
- ReportWORQ_RunAPIJob.ps1 (2 KB)
ec02772b075b44f744f966bdb793436e305cfcee614673a45a4f23d216fff0c8
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:\
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 pageOr write to support@reportworq.com directly.