Thursday, February 1, 2018

Start Process From Command Line--UiPath(RPA)

There are four ways how you can run a process in UiPath Studio 8
  1. From UiPath Studio
  2. From UiPath Robot Agent
  3. From command line
  4. Through a REST command
 This article's scope is to define and exemplify how you can start a process from command line in UiPath Studio 8 or higher. If you are still working with UiPath Studio 7.5 and upgrading is not an option you can check this article or this one.
UiPath Studio 8 comes bundled with UiRobot.exe application that allows you to execute processes without requiring UiStudio.exe.
This is very useful when you want to start a process from command line, a shortcut, a schedule or from your own application.
Syntax
"C:\Program Files (x86)\UiPath Studio\UiRobot.exe" /file:"full path of your workflow"
By default the location of UiRobot is: C:\Program Files (x86)\UiPath Studio\UiRobot.exe
Example:
Without arguments:
"C:\Program Files (x86)\UiPath Studio\UiRobot.exe"
/file:"C:\Users\Iordache Razvan\Documents\UiPath\OpenExcelApp\Main.xaml"
With arguments:
"C:\Program Files (x86)\UiPath Studio\UiRobot.exe"
/file:"C:\Users\Iordache Razvan\Documents\UiPath\StartFromCmd\Main.xaml"
/input:"{'arg1':'hello'}"

Command line arguments 

/f: /file:  Mandatory      Absolute path to xaml file that defines the process you want to startRemarks     Make sure to quote the path if it contains spaces
/i: /input
     A dictionary of input parameters to the workflow, keyed by argument name
Remarks     The dictionary must be in JSON format and should contain only standard types
/executor
     If passed, the process will be executed in an interactive Windows session
Remarks
    This or /process argument must be specified.
     The Windows session in which the process will be executed is defined by the credential specified through /target argument. If /target is not passed then the process will execute in the current user session
/process
      If passed, the process will be executed in Windows session 0
Remarks
     This or /executor argument must be specified.
      This should be used only when starting a process from Windows Task Scheduler or if /target argument is passed. The user account that hosts the process must have Log on as batch job permission
 /target
      The name of the credential stored in Windows Credential Store
Remarks      In order to start a project in Windows Session 0 a username and its password are required. 
To avoid passing them directly into command line, you can store them in Windows Credential Store and pass only the credential name. If /executor is specified, then UiPath automatically logs in a Windows session for the user if one doesn't exists

/monitored
      If passed, UiPath monitors the user's interactive session
Remarks      Now processes can run even when the desktop is locked. To achieve this, UiPath must be instructed to monitor the Windows session in order to automatically unlock the screen and keep executing the process. Ex: Human user can start a lengthy process then lock the desktop and go to lunch.

9 comments:


  1. You won't believe me, but I was planning to write a blog very similar to the one you have posted here. Great work!

    Selenium Training In Chennai

    Java Training In Chennai

    ReplyDelete
  2. Great work... Thanks for the information please visit below link for more information on UiPath(RPA)
    https://www.kausalvikash.in/blog/non_it-person-uipath-rpa-journey/
    https://youtu.be/XnkYSySw308

    ReplyDelete
  3. The argument /monitored (or --monitor) appears to be removed from the available argument list in UiPath since versions 2018.x (https://robot.uipath.com/docs/arguments-description).

    Would there be a way to continue using an 'Attended Robot' license and run it on a locked screen?

    ReplyDelete
  4. Can we call this CMD Script from Python ?
    we want to access our bot as a API (not by UIPath Orchestrator), so can this CMD script get executed by a python code to run my bot.

    my CMD Script is :- "C:\Users\shubham.f.jain\AppData\Local\UiPath\app-19.7.0\UiRobot.exe" /file "C:\Users\shubham.f.jain\Desktop\Final OCR\InvoiceAutomation\PDFReadwithNative.xaml"

    if yes then will you please help me with Python script as well. I am trying to archive the same using python SUbProcess library.

    ReplyDelete
  5. Awesome post. You Post is very informative. Thanks for Sharing.
    RPA Training in Noida

    ReplyDelete
  6. how can we stop the process through command prompt

    ReplyDelete
  7. nice information thanks for sharing...........!
    ui path training

    ReplyDelete