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

QueryAllRemoteJobs v2

../_images/QueryAllRemoteJobs-v2_dlg.png

QueryAllRemoteJobs dialog.

Summary

Query a remote compute resource for all jobs the user has submitted.

Properties

Name Direction Type Default Description
ComputeResource Input string Mandatory The name of the remote computer to query
JobID Output str list   ID string for the job(s)
JobStatusString Output str list   Description of the job’s current status (Queued, Running, Complete, etc..)
JobName Output str list   Name of the job (specified when the job was submitted)
ScriptName Output str list   The name of the script (python, etc.) or other type of executable that the job runs
TransID Output str list   The ID of the transaction that owns the job
SubmitDate Output str list   The date & time the job was submitted
StartDate Output str list   The date & time the job actually started executing
CompletionDate Output str list   The date & time the job finished
CommandLine Output str list   The command line run by this job on the remote compute resource machine(s)

Description

Query information status for all the jobs available on the (remote) compute resource. In principle this includes all the jobs submitted, but in some cases (implementation dependent) the compute resource may not report anything about old finished jobs. Note that the output properties are all arrays. There will be one element for each job that was reported by the compute resource.

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: QueryAllRemoteJobs2.h (last modified: 2020-03-20)

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