\(\renewcommand\AA{\unicode{x212B}}\)
Authenticate dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| ComputeResource | Input | string | Mandatory | The remote computer to authenticate to |
| UserName | Input | string | Mandatory | Name of the user to authenticate as |
| Password | Input | string | Mandatory | The password associated with the specified user |
Authenticate to the remote compute resource. This must be executed before calling any other remote algorithms. The authentication method and outcome of this algorithm is dependent on the particular implementation (job manager underlying the algorithm). But typically, if the authentication is successful, a cookie is received that is stored internally and re-used for all subsequent interactions with the compute resource.
In the simplest use case of remote algorithms, once you authenticate with this algorithm, you can create a transaction with StartRemoteTransaction v2. Then you can submit jobs (with SubmitRemoteJob v2, query the status of jobs (with QueryAllRemoteJobs v2 and QueryRemoteJob v2), upload files (with UploadRemoteFile v2) or download files (with QueryRemoteFile v2 and DownloadRemoteFile v2).
For specific details on remote algorithms when using the Mantid web service remote job submission API, see the remote job submission API docs.
Version 1 authenticates to a Mantid web service 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
C++ header: Authenticate2.h (last modified: 2020-03-20)
C++ source: Authenticate2.cpp (last modified: 2020-04-07)