Skip to main content

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

Installing Pega Synchronization Engine by using the Setup wizard

Updated on October 19, 2022

To update and keep in sync the modules that comprise the Pega Robot Runtime system and the automations you employ, install the Pega Synchronization Engine.

Note: For best results, install the system from a local drive, not a mapped drive.

  1. Go to My Software and download the Robot Runtime setup file. For more information, see Downloading Pega Robotic Automation software.
  2. Extract the setup file into a temporary folder, and then locate the ServerInstalls.exe file.
  3. Extract the ServerInstalls.exe file, and then locate the PegaSynchronizationEngineSetup.exe file.
  4. Right-click the PegaSynchronizationEngineSetup.exe file, and then select Run as Administrator.
  5. In the Welcome dialog box, click Next.
  6. In the End-User License Agreement dialog box, read the license and click the I accept the terms in the License agreement option. Then click Next.
  7. In the Select installation folder dialog box, browse to the folder in which to install, or accept the default installation folder. Then click Next.
  8. In the Configure Shortcuts dialog box, choose the shortcuts that you want to create, and then click Next.
    1. If you want a Pega Synchronization Engine icon on the desktop, select Desktop.
    2. If you want a program group and shortcuts on the Start menu, select Start Menu Programs folder.
    3. If you want Pega Synchronization Engine to start automatically when Windows starts, select Startup folder.
    4. If you want Pega Synchronization Engine to appear on the Quick Launch toolbar, select Quick Launch toolbar.
    5. If you want the Pega Synchronization Server to specify the application to launch, select Specified by Synchronization Server.
    6. If you want the Pega.Loader.exe program to launch Robot Runtime, select Pega Robot Runtime.
  9. In the Configure Updater Service dialog box, specify how the Updater Service connects to the Pega Synchronization Server to retrieve updates, and then click Next.
    1. In the Product Repository field, enter the URL to the product repository in the following format: https://{server}:{port}/api/v1. The api/v1 is required.
    2. In the Local Service Port field, specify the local service port that you want to use.
    3. Do not change the setting in the Pre-Fetch Minimum field unless there is a conflict with another application.
      If there is a conflict, enter the default frequency, in minutes, for the pre-fetch cycle on the client computers. You typically set this property to allow the client to connect with the server two or three times a day.
      Enter zero (0) to have the system retrieve the minimum setting from the Pega Synchronization Server. You can override this setting for individual clients.
    4. Select the Keep Trying to Connect to Server Until Connected option and enter the number of minutes to the Pega Synchronization Engine should continue to try to connect.
    5. In the Use 64-bit Runtime field, select True if you are using a 64-bit version of Robot Runtime.
    6. In the Show No Package Dialog field, select True if you want to display the No Package dialog.
    7. In the Hide Splash Screen field, select True to hide the Robot Runtime splash screen on startup.
  10. In the Ready to install dialog box, click Install to begin the installation.
  11. After the installation finishes, close the Setup wizard by clicking Finish.
Result: The Pega Synchronization Engine is now installed and you can install the other Pega Robotic Automation components that you use, such as Robot Runtime and Robot Studio.
  • Previous topic Installing Pega RPA Service by using the Setup wizard
  • Next topic Installing Pega Browser Extension by using the Setup wizard

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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us