\(\renewcommand\AA{\unicode{x212B}}\)

QueryRemoteJob v2

../_images/QueryRemoteJob-v2_dlg.png

QueryRemoteJob dialog.

Summary

Query staus information about a job on a remote compute resource

Properties

Name Direction Type Default Description
ComputeResource Input string Mandatory The name of the remote compute resource to query
JobID Input string Mandatory The ID of the job to query
JobName Output string   The name of the job
ScriptName Output string   The name of the script or executable that was (or will be) run
JobStatusString Output string   The current status of the job (example: Queued, Running, Complete, etc..)
TransID Output string   The transaction ID this job was submitted under
SubmitDate Output string   The date & time the job was submitted (availability is optional and implementation dependent)
StartDate Output string   The date & time the job actually started executing (availability is optional and implementation dependent)
CompletionDate Output string   The date & time the job finished (availability is optional and implementation dependent)
CommandLine Output string   The command line run by this job on the remote compute resource machine(s), which in some cases may provide additional low level information on the environment used (modules loaded, exact versions (paths) of scripts being run, etc.)

Description

Query information for a particular job (identified by its ID) submitted to the (remote) compute resource given in the properties. Jobs are submitted with SubmitRemoteJob v2.

For specific details on remote algorithms when using the Mantid web service remote job submission API, see the remote job submission API docs.

Previous Versions

Version 1

Version 1 queries the status of jobs using the Mantid remote job submission API. This is still supported as one of the variants of Versions 2 and above, when the compute resource uses the Mantid remote job submission API as job manager (underlying remote job scheduling mechanism).

Categories: AlgorithmIndex | Remote

Source

C++ header: QueryRemoteJob2.h (last modified: 2020-03-20)

C++ source: QueryRemoteJob2.cpp (last modified: 2020-04-07)