⬇ Download Reportworq

This is the archived documentation for Reportworq 5. It is kept for reference and is no longer updated.

Go to the Reportworq 6 documentation

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:

While Reportworq is paused:

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).

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:

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#

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.