Job Control Window

This a dockable window that displays the order and status of jobs. Jobs are tasks that have been submitted to the server for execution. Examples of jobs are manually scheduled simulations, generation of alerts, results export and TSD updates (see table below for further details).

The window also displays information about the Alert engine.

Note: Automatic runs' order and status are displayed in the Server Job Control Window.

When jobs are scheduled they are added to a queue. Unless specified otherwise, jobs will be processed in the order in which they are scheduled. This order can be changed using options on the control window toolbar.

The status of any job currently being run can be viewed on the Job Progress Window.

To open the window, select Job Control window from the Window menu.

Job Control window toolbar

Many of the toolbar commands are carried out on a selection of jobs.

Toolbar icon Function

Cancel

Cancels selected jobs provided they have not already completed. Cancelled jobs will change to a status of Failed (Cancelled).

Reschedule

Reschedules selected jobs.

The Schedule Job(s) dialog is displayed to allow a new choice of agent group, results location and start time. Jobs that are running or have succeeded cannot be rescheduled, but failed jobs can be rescheduled.

Run immediately on this computer

Run a single selected job immediately on the local agent. Any jobs already running will continue but at a reduced priority until the immediate job has finished.

Note: This button will disabled if the local machine has been configured not to accept simulation jobs (See Agent Options section of the Manage Job Agents Dialog topic for further information).

View and control progress

Displays status of a selected job in the Job Progress Window.

Clicking this button turns off the automatic cycling of the Job Progress Window through the currently-simulating jobs.

Move to front

Moves selected jobs to the top of the queue.

Tip: This function can only be used to move the current user's jobs relative to each other. This cannot be used to jump the queue past another user's jobs.

Move up

Moves selected jobs one place higher in the queue.

Tip: This function can only be used to move the current user's jobs relative to each other. This cannot be used to jump the queue past another user's jobs.

Move down

Moves selected jobs one place lower in the queue.

Tip: This function can only be used to move the current user's jobs relative to each other. This cannot be used to jump the queue past another user's jobs.

Move to back

Moves selected jobs to the bottom of the queue.

Tip: This function can only be used to move the current user's jobs relative to each other. This cannot be used to jump the queue past another user's jobs.

Remove completed jobs

Refresh the list of jobs, removing any jobs that have completed from the list.

Manage agent

Displays the Manage Job Agents, dialog, which lets you manage the connection to the local agent and the configuration of connected agents.

A green icon indicates that the underlying services are working correctly but a red one indicates that there is a problem that will prevent runs from proceeding.

Job Queue Grid

The following information is displayed in the job queue grid of the Job Control Window:

Submitted The time and date that the job was submitted.

Job type

The type of the job that has been submitted (see table in the Target row below).

Source

The source of data that will be used as input for the job (see table in the Target row below).

Target

The target data that will receive the output from the job.

The following table shows the job type / source / target combinations available in ICMLive Operator Client:

Job type Source Target

Simulation

Run name

Simulation name

Time Series Data Update

Spatial or scalar TSD name

Data source name or stream name

Alert generation

Simulation name

Alert instance list name

Live Task Manifest name

'Post Event Analysis Report' or 'Results Export'

Tip: Results export may relate to export to CSV, or export to database or to both.

Status

The current status of the job.

A job passes through a range of states between submission and completion. Each state is associated with a colour that is used to colour the entire row:

  • White - indicates that the job is waiting in the queue
  • Blue - indicates that the job is being actively processed (e.g. pre-processing or actual job)
  • Red - indicates failure (but not necessarily completion)
  • Green - indicates success (but not necessarily completion, as the results may still need to be downloaded)
  • Yellow - indicates that results are being downloaded
  • Grey - indicates that there is no connection to the agent that is handling the job, so it is not possible to determine the current status. The displayed status is shown as the most recently notified status followed by '[Disconnected]'. The computer in question could be a remote agent (jobs running on that agent will be greyed out) or the coordinator (jobs waiting on the coordinator will be greyed out).

The available job states are as follows.

Note: Some of the statuses are job type-dependent and therefore may only be displayed under the right conditions for a specific job type.
Status Description

Waiting to pre-process

The job is in the queue and is waiting to be pre-processed.

Pre-processing

Creating input files for use by the engine.

Waiting

The job is waiting in the local agent's job queue. Reasons for waiting include:

  • No job slot available
  • Job is scheduled to start at a later time
  • Coordinator is not ready to receive job files (already uploading files for a different job)
  • Job is waiting for another job to finish so that it can use the final states of that job as its initial states
  • Job is waiting for another job to finish so that it can use the initial states of that job as its initial states

Uploading

The job files are being uploaded to either the Coordinator or directly to a remote agent.

Waiting (on server)

The job files have been uploaded to the Coordinator and the job is waiting to be assigned to a remote agent. Reasons for waiting include:

  • No remote agent in the relevant agent group has a job slot available
  • Job is scheduled to start at a later time
  • Job is waiting for another job to finish so that it can use the final states of that job as its initial states

Running remote

This is not normally displayed, but may be seen if contact with the remote agent is lost before it has reported the job's status.

Initialising

The job engine has started and is initialising the job.

Starting

The job has started.

Exporting

Initialisation has completed and results are being exported.

Result export jobs only

Generating

Initialisation has completed and alerts are being generated.

Alert generation jobs only

Loading

Initialisation has completed and TSD updates are being retrieved.

Time series data update jobs only

Simulating

Initialisation has completed and the simulation is running.

Simulation paused

The job engine has paused the simulation (in response to a request issued by a user using the Job Progress Window).

On-premise simulationSimulation jobs only

Stopping

Normally happens too quickly to be seen.

Waiting to download

Waiting to download results from the agent that carried out the job to the local agent because other jobs are already downloading results.

Downloading results Downloading results from the agent that carried out the job to the local agent.
Waiting for server

Waiting to download results and/or final states from the agent that carried out the job to the server (coordinator). This is usually because the coordinator is busy downloading results from a different job.

Downloading to server

Downloading results and/or final states from the agent that carried out the job to the server (coordinator).

Ended

The job has completed.

An indication of the success of the simulation may follow:

  • 'Ended' - the job completed successfully and results are available. These are full results for on-premise simulations.
  • 'Ended - Incomplete' - the job ended but is incomplete. For simulations for example, this could indicate that the simulation ended due to failure to meet convergence criteria. Results are available up to the point of failure.
  • 'Ended - Warnings' - the job completed, but with warnings. Open the job log to view details of these warnings.
Failed

The job has completed but the simulation has failed. An indication of the reason for failure follows e.g. 'Failed [Cancelled]' and full details can be found by opening the job log file.

After

The time after which the job is scheduled to start (blank if scheduled for 'Now').

User

The name of the user who submitted the job.

Run On

The name of the computer or agent group that the job is scheduled to run on.

If this is an agent group or 'Any computer', then once the job has started, the name of the computer that the job is or has actually run on is appended in brackets.

Mouse-click behaviour and tooltips

Click the Status cell for a complete job to open the job results / log.

Additionally, information is displayed in a tooltip when the mouse cursor is positioned over a cell. Refer to the table below for more information.

Job type Source Target Status

Simulation

Tooltip showing job summary.

Tooltip showing job summary.

When job is complete - Click to open simulation results.

When job is not complete - Click to view and control the job progress. This displays the Job Progress Window.

Time Series Data Update

Tooltip showing job summary.

Tooltip showing job summary.

When job is complete - Click to open the TSD update log.

When job is not complete - A tooltip shows the job summary.

Alert generation

Tooltip showing job summary.

Tooltip showing job summary.

When job is complete - Click to open the alert log.

When job is not complete - A tooltip shows the job summary.

Live Task

Tooltip showing job summary.

Tooltip showing job summary.

When job is complete - Click to open the live task log.

In the case of export to CSV, the log file includes the path of the folder to which the results files have been exported.

When job is not complete - A tooltip shows the job summary.