Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Installing Pega Robotic Automation from the command line

Updated on June 29, 2022

You can bypass the Setup wizard and install Pega Robotic Automation from the command line. This involves installing all of the prerequisites and both of the components that comprise the Pega Robotic Automation.

  1. Install all requirements. For more information, see Minimum requirements.
  2. Go to My Software, and then download the applicable component setup file, such as the Robot Runtime setup file.
  3. Extract the setup file into a temporary folder.
  4. Start Windows File Explorer, go to the folder where you downloaded the setup file, and enter cmd to open a command prompt window.
    Note: Place both installers in the same folder.
  5. At the command prompt, enter the command to install the Pega Native Foundation component. Include the APPDIR parameter to specify the installation folder. The following is an example:
    PegaNativeFoundationSetup.exe /qn APPDIR="C:\Program Files (x86)\Pegasystems\Pega Native Foundation" 
    Note: The /qn switch installs the system with no user interaction. For more information, see Command line switches and parameters.
  6. If you are installing Robot Studio, skip this step.
    If you are installing Robot Runtime, at the command prompt install the Pega Synchronization Engine (PegaSynchronizationEngineSetup.exe). Include the following parameters:

    Robot Runtime parameters

    ParameterDescription
    APPDIR=Include this parameter to specify the installation folder.
    PRODUCTREPOSITORY=Specify the URL to the product repository where updates are stored.
    LOCALSERVICEPORT=

    Specify the port to use for internal product HTTP communication. The default is 9000.

    Only change the default if there is a conflict with other software.

    PREFETCHMINS=Specify, in minutes, how often the server should check for updates. Set to zero (0) to use the server value.
    SHORTCUT_ARGS=

    Include this parameter to create a shortcut for the Pega Synchronization Engine on the desktop.

    If you want the Pega Synchronization Engine to specify the shortcut, omit this parameter.

    To create a shortcut for Robot Runtime, include these arguments:

    SHORTCUT_ARGS="-p Runtime -e OpenSpan.Runtime.exe"

    SHOWNOPACKAGEDIALOG=Enter True to display a dialog if there are no packages to download. For RPA robots, enter False.
    AI_DESKTOP_SH=

    Enter one (1) to create desktop icons.

    The default is zero (0).

    AI_QUICKLAUNCH_SH=

    Enter one (1) if you want the installation program to add an icon to the Windows Quick Launch toolbar.

    The default is zero (0).

    AI_STARTMENU_SH=

    Enter zero (0) if you do not want the installation program to create a Start menu program folder.

    The default is one (1), which creates a Start menu folder.

    AI_STARTUP_SH=

    Enter one (1) if you want the installation program to add an icon in the Startup folder.

    The default is zero (0).

    The following is an example:
    PegaSynchronizationEngineSetup.exe /qn APPDIR="C:\Program Files 
    (x86)\Pegasystems\Pega Synchronization Engine" PRODUCTREPOSITORY=https://myserver:port/api/v1 
    LOCALSERVICEPORT=9000 PREFETCHMINS=0 SHOWNOPACKAGEDIALOG=1 AI_DESKTOP_SH=1
  7. Optional: If you are creating or running Robotic Process Automations (RPA), install the Pega RPA Service (PegaRPAServiceSetup.exe).
    Include the following required parameters:

    Pega RPA Service parameters

    ParameterDescription
    APPDIR=Include this parameter to specify the installation folder.
    ENABLE_RPA_SERVICE=Enter True to enable the use of the Pega RPA Service.
    RPA_GROUP=Specify the RPA group in which this robot works. If the robot is available for everyone, enter Everyone.
    RPA_MODE=

    Enter OnDemand if you want the robot to work on jobs as they come in from Robot Manager. Enter Scheduled if the robot performs work based on a schedule specified in the RpaSchedule.json file.

    The default is OnDemand.

    RPA_LOGGING=

    Enter True to log information about the Pega RPA Service. The system writes logging information to the following file:

    C:\ProgramData\Pegasystems\RPAService\RpaService.log

    The default is True.

    ROBOT_WORKGROUP=Specify the default work group for this robot. The default is "Customer service".
    ROBOTNAME=Specify the default robot name that is registered in Robot Manager. The default is the machine name.
    RPA_SERVICE_OPERATOR=Specify the RPA registration operator that is used to register the RPA service with Robot Manager. The default is “RPAOperator”.
    The following is an example:
    PegaRPAServiceSetup.exe APPDIR=”C:\Program Files (x86)\Pegasystems\Pega RPA 
    Service” ENABLE_RPA_SERVICE=TRUE RPA_GROUP=Everyone RPA_MODE=OnDemand RPA_LOGGING=TRUE
  8. If you are creating or running automations that run in a Google Chrome or Microsoft Edge browser, install the Pega Browser Extension (PegaBrowserExtensionSetup.exe).
    Include one or both of the following parameters:

    Pega Browser Extension parameters

    ParameterDescription
    INST_CHROME=Include this parameter to install the extension for Google Chrome.
    INST_EDGE=Include this parameter to install the extension for Microsoft Edge.

    The following is an example of how you would install the extension for both Chrome and Edge:

    PegaBrowserExtensionSetup.exe /qn INST_CHROME=1 INST_EDGE=1
  9. At the command prompt, enter the command to install the runtime environment and include the applicable switches and parameters. The following example shows the command line syntax for installing Robot Runtime: PegaRobotRuntimeSetup.exe (switches) (parameters)
    The following is an example:
    PegaRobotRuntimeSetup.exe /qn+ /L*v LogFileName.txt INSTALL_OFFICE=2019 
    ENABLE_PRM=True PRM_SERVER=https://<yPegaServer.com PACKAGE_SERVER_URL=https://MyPackageServer.com:5000 
    INST_CHROME=1
Result: When the installer finishes, the Pega Robotic Automation product, in this example Robot Runtime, is installed on the computer.

Command line switches and parameters

Use the following switches and parameters to customize the command you use to install Pega Robotic Automation.

The following table shows the command-line switches that you can use.

Command line switches

SwitchDescription
/iInstalls the system.
/qn+Installs the system with no user interaction except for a modal dialog that appears at the end.
/qn(Silent Mode). Installs the system with no user interaction at all.
/L*vLogs all installation information, including information generated by the v (verbose) option. Include the name of the log file that you want to use.
/norestartDo not restart the system after the installation is complete.

The following table shows the command-line parameters that you can use.

Command line parameters

ParameterDescription
APPDIR=

Use this parameter to override the default installation folder.

The default is blank, which installs Robot Runtime into the default folder:

C:\Program Files (x86)\Pegasystems\Pega Robot Runtime

ENABLE_IDP=

Enter True to enable an Identity Provider (IdP) server. IdP servers provide security tokens which are used by Robot Runtime.

Accept the default if you want the system to prompt users to enter their email address and password when they log in to Robot Runtime or Robot Studio.

The default is False.

IDP_URL=

If you enable an Identity Provider (IdP) server in the ENABLE_IDP parameter, Enter the URL that you want to use to connect to that server.

This URL is used by the Configuration server and Robot Manager to receive security tokens.

The following is an example:

https://MyAuthServer.com/Endpoint

ENABLE_PRM=

Enter True to enable a connection to the Robot Manager. The Robot Manager provides a way to manage the RDA and RPA robots that are implemented for your organization.

Set to False to disable Robot Manager connectivity.

The default is False.

PRM_SERVER=If you enable a Robot Manager connection, specify the name of the Pega server that runs the Robot Manager application. This sets the Robot Manager base URL in the CommonConfig.xml file.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us