Job Control Window

This is 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 simulations, generation of 2D meshes, and TSDB updates (see table below), and for InfoWorks networks only, risk analysis runs.

When jobs are scheduled they are added to a queue. Unless specified otherwise, the 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 a job currently being run can be viewed on the Job Progress Window.

To open the window, click on the Docking Windows Toolbar or 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.

Click on a job in the window to select it.
To select multiple jobs hold the SHIFT or CTRL key down to add jobs to those currently selected.

Toolbar icon	Description of Functionality
Cancel	Cancel selected jobs provided they have not already completed. Cancelled jobs will change to a status of Failed (Cancelled).
Reschedule	Reschedule 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. Pressing this button turns of 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 Note that this 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 Note that this 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 Note that this 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 Note that this 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.

Toolbar icon

Description of Functionality

Cancel

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

Reschedule

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

Pressing this button turns of 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

Note that this 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

Note that this 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

Note that this 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

Note that this 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 Control Window Job Queue Grid

The following information regarding scheduled simulations 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 table below shows the job type / source / target combinations available in InfoWorks ICM:

Job type	Source	Target
Simulation	Run name	Simulation name
Mesh 2D Zones	Network name	Zone name
Time Series Database Update	Spatial or scalar TSDB name	Data source name or stream name
Risk Analysis	Risk run name	-

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 initialising 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.
Damage calculation	Risk analysis job type only. Pre-processing has completed and damage is being computed.
Risk calculation	Risk analysis job type only. Damage calculation has completed and risk analysis is being performed.
Loading	Time series database update job type only. Initialisation has completed and TSDB updates are being retrieved.
Meshing	Mesh 2D Zones job type only. Initialisation has completed and the meshing is being carried out.
Simulating	Simulation job type only. Initialisation has completed and the simulation is running.
Simulation paused	Simulation job type only. The job engine has paused the simulation (in response to a request issued by a user using the Job Progress Window).
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 full results are available '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. For a simulation for example, this could indicate that the simulation completed, but either a user threshold set in the Run Diagnostics was exceeded, or a depth exceeded the section height in a channel or river reach.
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 Target / Status cell for a job to highlight the source / target object in the Explorer window. Click the Source cell of 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	Click to highlight the run in the Explorer window.	Click to highlight the simulation in the Explorer window.	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.
Mesh 2D Zones	Click to highlight the network in the Explorer window.	Tooltip showing job summary.	When job is complete - Click to review and load mesh results. This displays the Manage mesh results dialog. When job is not complete - A tooltip shows the job summary.
Time Series Database Update	Click to highlight the TSDB in the Explorer window.	Tooltip showing job summary.	When job is complete - Click to open the TSDB update log. When job is not complete - A tooltip shows the job summary.
Risk Analysis	Click to highlight the risk analysis run in the Explorer window.	Tooltip showing job summary.	When job is complete - Click on the cell to open the risk analysis results view. When job is not complete - A tooltip shows the job summary.

Simulations

Job Progress Window

Manage Job Agents Dialog

Update Time Series Data Dialog

Using Dockable Windows