Process Name (pos.0)
(Required)
| The name of the process that you want to run. |
Orchestrator URL (pos.1)
(Required)
| The URL of the Orchestrator instance. |
Orchestrator Tenant (pos.2)-
(Required) for SaaP deployments.
-
(Optional) for PaaS
deployments.
| The tenant of the Orchestrator instance, where you
want to run processes.
|
-i, or --input_path
(Required only if the entry point of the
workflow has input parameters)
| The full path to the JSON input file corresponding to
the process that you want to run.
|
-u, or --username
(Required if you use Basic
Authentication, through a username and a
password)
| The username used for authenticating to Orchestrator.
You must pair it with the corresponding
password.
|
-p, or --password
(Required if you use Basic
Authentication, through a username and a
password)
| The password used for authenticating to Orchestrator.
You must pair it with the corresponding
username.
|
-t, or --token
(Required if you use token-based
authentication)
| The OAuth2 refresh token used for
authenticating to Orchestrator. You must pair it with
the Account Name and Client ID.
|
-a, or
--accountName (Required if
you use token-based
authentication)
| The Orchestrator CloudRPA account name. You must pair
it with the OAuth2 refresh token and Client
ID.
|
-I, or
--applicationID (Required if
you use external application
authentication)
| The external Application ID. You must pair it with
the Application Account, Application
Secret, and Application scope.
|
-S, or
--applicationSecret
(Required if you use external application
authentication)
| The external Application Secret. You must pair it
with the Application Account, Application
ID, and Application scope.
|
--applicationScope (Required
if you use external application
authentication)
| The list of application scopes, separated by single
spaces. You must pair it with the Application
Account, Application ID, and
Application Secret for external
application.
|
-P, or
--priority | The priority that you want to run the job with:-
Low.- Normal (default).- High.
|
-r, or
--robots | A list of specific robot names, separated by
commas.
|
-j, or
--jobscount | The number of times that you want to run the process.
The default number of times that the process runs is
one.
|
-U, or
--user | The name of the user. This should be a machine user,
not an Orchestrator user. For local users, the format is
MachineName\UserName.
|
-M, or
--machine | The name of the machine that you want to run the
process on.
|
-R, or
--result_path | The full path to a JSON file, or to a folder, where
you want to store the results of the job. The results
return as JSON files.
|
-W, or
--timeout | The timeout for job executions (seconds). The default
is 1800 seconds.
|
-f, or
--fail_when_job_fails | The command fails when one job fails, The default for
this is True.
|
-w, or
--wait | The command waits for the job to finish. The default
for this is True.
|
-b, or --job_type
(for modern folders only)
| The type of runtime for the job. You can choose:-
Unattended-
NonProduction.
|
-A, or
--accountForApp | The Orchestrator CloudRPA account name. You must pair
it with the Application ID, Application
Secret, and Application scope for
external application.
|
-o, or
--organizationUnit
| The name of the Orchestrator folder (organization
unit).
To input subfolders make sure to input both
the parent folder name and the name of the
subfolder. For instance, use
AccountingTeam\TeamJohn.
|
