Test Suite
2023.4
false
Running a job inside Orchestrator - Automation Suite 2023.4
Banner background image
logo
Test Suite
Last updated Dec 19, 2023

Running a job inside Orchestrator

  • Create a process in Orchestrator.
  • Run the CLI exe (for Windows) or dll (for Linux) file.
  • Add the Orchestrator API Access Application Scopes below:

    Application Scope

    Description

    OR.Assets

    Assets read and write access in Orchestrator.

    OR.BackgroundTasks

    BackgroundTasks read and write access in Orchestrator.

    OR.Execution

    Execution read and write access in Orchestrator.

    OR.Folders

    Folders read and write access in Orchestrator.

    OR.Jobs

    Jobs read and write access in Orchestrator.

    OR.Machines.Read

    Machines read access in Orchestrator.

    OR.Monitoring

    Monitoring read and write access in Orchestrator.

    OR.Robots.Read

    Robots read access in Orchestrator.

    OR.Settings.Read

    Settings read access in Orchestrator.

    OR.TestSets

    TestSets read and write access in Orchestrator.

    OR.TestSetExecutions

    TestSetExecutions read and write access in Orchestrator.

    OR.TestSetSchedules

    TestSetSchedules read and write access in Orchestrator.

    OR.Users.Read

    Users read access in Orchestrator.

  1. Run the job task, using uipcli job. Now you can see a list of the available the sub-tasks.
  2. Specify the required parameters and run the run sub-task.
    See the list of parameters below.
    ParameterDescription
    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 --priorityThe priority that you want to run the job with:- Low.- Normal (default).- High.
    -r, or --robotsA list of specific robot names, separated by commas.
    -j, or --jobscountThe number of times that you want to run the process. The default number of times that the process runs is one.
    -U, or --userThe name of the user. This should be a machine user, not an Orchestrator user. For local users, the format is MachineName\UserName.
    -M, or --machineThe name of the machine that you want to run the process on.
    -R, or --result_pathThe 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 --timeoutThe timeout for job executions (seconds). The default is 1800 seconds.
    -f, or --fail_when_job_failsThe command fails when one job fails, The default for this is True.
    -w, or --waitThe 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 --accountForAppThe 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.
  • job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P High -o MyFolder
  • job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P High -j 3 -w false
  • job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.json

Adding an External Application

To register an external application so that it can access your UiPath resources using OAuth:

  1. Log in to the tenant as an Administrator.
  2. Go to Tenant > Manage access > Assign roles and click Manage Accounts & Groups.

    The tenant-level opens.

  3. Along the left, select External Applications.

    The External Applications page opens, listing all the existing external applications registered for the current tenant:



  4. Above the table, on the right, click Add Application.
  5. Fill in the Application Name field.
  6. Select an option for Application Type.

    If you select Confidential application, you receive an app secret at the end, so make sure your application can store it securely. If it can't, select Non-confidential application.

  7. Under Resources, click Add Scopes.

    The Edit Resource panel opens on the right, where you can select the resources to which the application should have access.

  8. From the Resource drop-down list, select the UiPath API that the application can use.
    Note: You can only add scope for one resource at a time. If you want to allow access to multiple resources, repeat this process to add scope for each resource.
  9. On the User Scope(s) tab, select the check boxes for the logical API permissions that you want to grant, as needed.

    Granting permissions under user scope means that the external application can access those resources within a user context and a user with the appropriate permissions must be logged in.

  10. If this is a confidential application, you can switch to the Application Scope(s) tab to also grant application-level permissions for the selected resource, as needed.

    With permissions under application scope, the external application has access to application-wide data for the selected scopes without the need for user interaction.

    Non-confidential applications cannot access application scope.

  11. Click Save.

    The panel closes and the selected resource and scopes are added to the Resources table in the form.

  12. If the external application can accept it, you can add a URL in the Redirect URL field and the authorization response is sent there. The application can then use it to access UiPath resources.
  13. Click Add to create the registration.

    A confirmation message opens. For confidential applications, the confirmation message includes the app secret that the registered external application can use to request authorization. Make sure you save it in a secure location because you cannot see it again.

  • Adding an External Application
Support and Services icon
Get The Help You Need
UiPath Academy icon
Learning RPA - Automation Courses
UiPath Forum icon
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.