Overview#
The global execution pause lets a system administrator stop Reportworq from touching your data sources for a while, and then let it carry on. Use it when something else needs a quiet system, for example:
- A TM1 maintenance window.
- A dimension update that should not run while reports are querying the same dimensions.
- A restart or an upgrade of a Planning Analytics server.
While Reportworq is paused:
- New jobs wait. Jobs that are queued, scheduled or started from the API stay Pending and start when the pause ends.
- Running jobs pause at a safe point. A running job does not stop in the middle of a query. It holds just before its next TM1 query or its next report step, and carries on from that point when Reportworq resumes. A job that is already inside a query finishes that query first.
- Reportworq tells you when it is quiet. Once every running job has paused, the status reads All jobs paused, safe to proceed. That is your signal to start the maintenance.
The pause covers every workspace on the Reportworq server and every machine that runs jobs for it.
You can pause from the footer of the Reportworq web app, from the REST API, or from a Turbo Integrator process using the pause samples for Planning Analytics, which come in a variant for Planning Analytics v11 and one for Planning Analytics Engine (v12).
The footer controls#
System administrators see the pause controls in the footer at the bottom of the Reportworq window. Other users do not see them.
Pause all jobs. Select Pause all jobs and enter the number of minutes to pause for:
- A number greater than 0 pauses for that many minutes. The time counts from the moment every running job is paused, not from the moment you press the button, so the quiet time you asked for is the quiet time you get. The longest pause is 525,600 minutes (one year).
- 0 pauses until someone resumes.
The status message. While Reportworq is paused the footer shows a live message. It changes as running jobs reach a safe point:
| Message | Meaning |
|---|---|
| 12 of 17 running jobs paused | Jobs are still finishing their current step. Wait. |
| All jobs paused, safe to proceed | Every running job is held. Start your maintenance. Shown for a pause that lasts until resumed. |
| Paused until 14:30 | A timed pause where every running job is held. Reportworq resumes by itself at that time (the date is added when it is not today). The time is the server's local time. |
| Paused by 2 requests. followed by one of the messages above | More than one pause is active, for example one from the footer and one from the API. Reportworq stays paused until every one of them is released or has run out. |
Hover over the message to see who asked for the pause, when, how long it lasts and how many jobs are waiting to start.
A running job that runs inside the web app itself cannot pause. The message names it, for example 2 of 3 running jobs paused (1 runs inside the web app and cannot pause). See Limits of the pause.
Resume. While paused, the footer shows Resume. It ends every active pause at once, including one started from the API, and queued jobs start again. The API's resume command without a holdId does the same: it is an all-clear for every pause, whoever made it.
Cancel all. When any job is running or pending, the footer also shows Cancel all. After you confirm, it cancels every running job in every workspace. Select also cancel pending jobs before you press it to cancel the jobs waiting in the queue as well. A cancel cannot be undone. Cancel all does not start or end a pause, so pause first when you want nothing to start again.
Limits of the pause#
- Jobs that run inside the web app cannot pause. Jobs normally run in their own job process. If out-of-process execution is turned off, a job runs inside the web app, never pauses, and is counted in the status message as one that cannot pause. Reportworq does not report All jobs paused while such a job runs.
- A job in a long stretch without TM1 calls answers later. A job holds at its next TM1 query or report step. If it is in the middle of a long calculation, a large file operation or a slow distribution step, it keeps going until it reaches the next safe point, so All jobs paused can take a while to appear.
- Writeback and contribution work are not paused. Writes made from contributions and writeback run in the web app and are not held by the pause. Do not rely on the pause to keep these away from TM1.
- Previews are refused while paused. A report preview or a test run started while Reportworq is paused does not run. It shows Jobs are paused by an administrator. Try again after they resume. Run it again after the resume.
- Upgrade the web app before the job machines. A job process on an older release never reports that it has paused, so Reportworq can never report that all jobs are paused while it runs. Upgrade the Reportworq web app first, then the machines that run jobs.
- A pause survives a restart. If the Reportworq web app restarts during a pause, it is still paused when it comes back. A timed pause that ran out while the web app was down ends at start-up. Reportworq also waits a few seconds after a new pause request, and after a restart, before it reports that all jobs are paused, to give running jobs time to answer.
- The pause is controlled from the web app. The pause API answers 404 if the request reaches a machine that only runs jobs.
Related topics#
- Reportworq API: the pause, status, resume and cancel-all calls.
- Pause samples for Planning Analytics: two Turbo Integrator processes, each in a Planning Analytics v11 and a Planning Analytics Engine (v12) variant, that pause and resume Reportworq around a dimension update.
- Upgrading Reportworq
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.