What's new ⬇ Download Reportworq
⬇ Guide PDF

Pause job execution#

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 Activity screen, from the REST API, or from a Turbo Integrator process using the pause samples for Planning Analytics.

Pause from the Activity screen#

Only system administrators see the pause controls. They sit in the page header of Activity, beside Refresh.

  1. Open Activity.

  2. Select Pause jobs. A menu opens under the heading Pause all jobs:

    • Until I resume pauses until someone resumes.
    • For 15 minutes, For 30 minutes and For 1 hour pause for that long.
    • For a number of minutes... asks for a number. Enter a number greater than 0. The longest pause is 525,600 minutes (one year).
    The Pause jobs menu open on the Activity screen, listing Until I resume, For 15 minutes, For 30 minutes, For 1 hour and For a number of minutes
    The Pause jobs menu open on the Activity screen, listing Until I resume, For 15 minutes, For 30 minutes, For 1 hour and For a number of minutesTap or click the image to view it full screen
  3. Watch the status message under the page header until it reads All jobs paused, safe to proceed (or Paused until a time, for a timed pause). The message, which everyone who can open Activity sees while Reportworq is paused, ends with Applies to every workspace on this server., and the Pause jobs button's tooltip says the same.

For a timed pause, the time counts from the moment every running job is paused, not from the moment you chose it, so the quiet time you asked for is the quiet time you get.

Read the status#

While Reportworq is paused a status message appears under the Activity page header. Its color tells you where things stand: amber while running jobs are still reaching a safe point, green once every one is held.

Message Meaning
Pausing: no jobs are running, confirming in a few seconds. Nothing is running. Reportworq waits a few seconds, in case a job was just starting, before it reports that it is quiet.
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 Activity and one from the API. Reportworq stays paused until every one of them is released or has run out.
The Activity screen just after a pause was asked for: an amber status reading 0 of 1 running job paused, and a Running row whose progress text starts with Pausing
The Activity screen just after a pause was asked for: an amber status reading 0 of 1 running job paused, and a Running row whose progress text starts with PausingTap or click the image to view it full screen

Once the last running job holds, the status turns green and each held job's row shows Paused:

The Activity page header with Resume jobs, and a green status reading All jobs paused, safe to proceed
The Activity page header with Resume jobs, and a green status reading All jobs paused, safe to proceedTap or click the image to view it full screen

Below the message, a line says who asked for the pause, when, how long it lasts and how many jobs are waiting to start.

People who are not system administrators see only Jobs are paused by an administrator. and that queued jobs start, and running jobs carry on, when they resume. They never see another workspace's numbers.

Paused rows#

In the Activity grid, a running job that is held shows a Paused chip in the Category column in place of Running, and its progress bar stops moving. The progress text starts with what the pause is doing to that job:

Text Meaning
Paused, ... The job is held at a safe point, with no data-source query running, and its work waits for the resume.
Pausing, ... The job is finishing its current step or data-source query and holds at the next safe point.
Cannot pause, ... The job runs inside the web app and cannot pause. See Limits of the pause.

The header indicator#

On every screen, a system administrator sees when jobs are paused: the Activity icon in the application header turns into a pause icon with a small amber dot, and the running animation stops. Hover over it to see the running jobs and the pause status. Resuming is done on the Activity screen.

The application header while Reportworq is paused: the Activity icon has become a pause icon with a small amber dot, and the Activity page shows Resume jobs
The application header while Reportworq is paused: the Activity icon has become a pause icon with a small amber dot, and the Activity page shows Resume jobsTap or click the image to view it full screen

Resume#

While paused, Pause jobs is replaced by Resume jobs. It ends every active pause at once, including one started from the API, and queued jobs start again. If more than one pause is active, Reportworq asks you to confirm first, because some of them may belong to Turbo Integrator processes.

The API's resume command without a holdId does the same: it is an all-clear for every pause, whoever made it.

Cancel all#

Cancel all is in the page header too. It is available when any job is running or pending. Choose:

After you confirm, Reportworq cancels the jobs in every workspace on the server and reports how many it canceled. A cancel cannot be undone. Cancel all does not start or end a pause, so pause first when you want nothing to start again.

The Cancel all menu open during a pause, listing Cancel pending jobs, Cancel running jobs and Cancel running and pending jobs
The Cancel all menu open during a pause, listing Cancel pending jobs, Cancel running jobs and Cancel running and pending jobsTap or click the image to view it full screen

Use Cancel pending jobs during a pause when you want to clear the backlog and let the work in flight finish.

Cancel all in the API is narrower. The Activity screen cancels across every workspace. The API's cancelall command cancels only the jobs of the workspace the access token belongs to.

Limits of the pause#

Going deeper. For the calls a script or Turbo Integrator process makes, see Pause and resume by API. For the ready-made processes, see Pause samples for Planning Analytics. To watch jobs and cancel one, see Track activity and run history.

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.