pega robotic automation studio - community.pega.com robotic... · robotic automation studio is a...

24
Pega Robotic Automation Studio INSTALLATION INSTRUCTIONS 8.0 Start

Upload: ngodat

Post on 07-Oct-2018

325 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio

INSTALLATION INSTRUCTIONS8.0

Start

Page 2: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Notice

© 2018 Pegasystems Inc., Cambridge, MAAll rights reserved.

Trademarks

For Pegasystems Inc. trademarks and registered trademarks, all rights reserved. All other trademarks or service marks are property of their respective holders. For information about the third-party software that is delivered with the product, refer to the third-party license file on your installation media that is specific to your release.

Notices

This publication describes and/or represents products and services of Pegasystems Inc. It may contain trade secrets and proprietary information that are protected by various federal, state, and international laws, and distributed under licenses restricting their use, copying, modification, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc.This publication is current as of the date of publication only. Changes to the publication may be made from time to time at the discretion of Pegasystems Inc. This publication remains the property of Pegasystems Inc. and must be returned to it upon request. This publication does not imply any commitment to offer or deliver the products or services described herein.This publication may include references to Pegasystems Inc. product features that have not been licensed by you or your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems Inc. services consultant.Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors, as well as technical inaccuracies. Pegasystems Inc. shall not be liable for technical or editorial errors or omissions contained herein. Pegasystems Inc. may make improvements and/or changes to the publication at any time without notice.Any references in this publication to non-Pegasystems websites are provided for convenience only and do not serve as an endorsement of these websites. The materials at these websites are not part of the material for Pegasystems products, and use of those websites is at your own risk.Information concerning non-Pegasystems products was obtained from the suppliers of those products, their publications, or other publicly available sources. Address questions about non-Pegasystems products to the suppliers of those products.This publication may contain examples used in daily business operations that include the names of people, companies, products, and other third-party publications. Such examples are fictitious and any similarity to the names or other data used by an actual business enterprise or individual is coincidental.This document is the property of:Pegasystems Inc.One Rogers StreetCambridge, MA 02142-1209USAPhone: (617) 374-9600Fax: (617) 374-9620www.pega.com

Updated: August 21, 2018

Feedback

If you have suggestions or comments for how we can improve our materials, send an email [email protected].

Page 3: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

iii

CONTENTS

1 Installing Pega Robotic Automation Studio

2 Minimum requirements

3 Installing Robotic Automation Studio using the Setup wizard

10 Installing Robotic Automation Studio from the command line

10 Switches11 Parameters

15 Installing Robotic Automation Studio offline

16 Installing the OCR screen scraping feature

17 Uninstalling the system

Page 4: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

iv

Page 5: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 1

Installing Pega Robotic Automation Studio

This document describes the step-by-step instructions for installing the Pega Robotic Automation Studio 8.0 stand-alone edition. Pega offers two editions of Pega Robotic Automation Studio to support the different needs of our users.

This document includes the following topics:

• Minimum requirements• Installing Robotic Automation Studio using the Setup wizard• Installing Robotic Automation Studio from the command line• Installing Robotic Automation Studio offline• Installing the OCR screen scraping feature• Uninstalling the system

Robotic Automation Studio

Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual Studio 2015 installed.As part of the Robotic Automation Studio installation, the Microsoft Visual Studio 2015 Isolated Shell is installed, which provides the Integrated Development Environment (IDE) foundation for Robotic Automation Studio and a familiar, feature-rich development environment.

Robotic Automation Studio Plug-in

The Robotic Automation Studio Plug-in integrates with Visual Studio 2015, so you can leverage Microsoft developer tools to rapidly create Pega Robotic Automation Studio projects from within Visual Studio.Refer to Pega Robotic Automation Studio Plug-in 8.0 Installation Instructions for guidance on installing the Robotic Automation Studio Plug-in.

Note Both editions include support for all features of the Pega Robotic Automation Studio IDE and you can switch between editions as your needs and environment change.

Page 6: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Minimum requirements

Pega Robotic Automation Studio 8.0 Installation Instructions 2

Minimum requirementsThe minimum configuration required to run Pega Robotic Automation Studio is shown here.

The Setup wizard requires Internet access. With this access, it downloads and installs any needed prerequisites. If, however, the computer on which you are installing Robotic Automation Studio does not have access to the Internet, you must download and install the prerequisite applications before installing Robotic Automation Studio. For more information, see Installing Robotic Automation Studio offline.

Note Version 8.0.1053 and later builds require Microsoft Visual Studio 2015 Update 3 for the stand-alone and plug-in versions of Pega Robotic Automation Studio.

Component RequirementProcessor Dual core or faster processor

RAM 4 GB total RAM

Disk space 10 GB

Operating system These Windows operating systems are supported:• Windows 7 (32- and 64-bit)• Windows 8.1 (32- and 64-bit) *• Windows 10 (32- and 64-bit) **• Windows Server 2008 R2 (64-bit)• Windows Server 2012 R2 (64-bit) *

Browser Microsoft Internet Explorer versions 8-11 (32-bit) are supported. The 64-bit version of Internet Explorer 11 is also supported. Pega Robotic Automation Studio offers limited support for these browsers:• Mozilla Firefox versions 31-39.• Mozilla Firefox ESR versions from 31.6.0-38.3.0 (expected to work through Firefox ESR

38.8.0).• Google Chrome versions 38-52.

Other applications

You must also have these applications:• Microsoft .NET Framework versions 2.0 (bundled with 3.5 SP1), 4.0, and 4.6Note: If you do not have the correct versions of these applications, the Setup wizard downloads and installs them. For more information, see What prerequisites does the Setup wizard install?

* You must install update 2919355 (available through Windows Update) before installing Visual Studio 2015 because the .NET Framework 4.6 installer requires this update.** Requires build 8.0.1015 or higher.For information on interrogating web applications on Windows 10 and Windows server 2012, see How do I interrogate web pages in Windows 10?

Note All applications integrated using the Pega Robotic Automation Studio platform must run at the same integrity level. The sole exception is that this version of Robotic Automation Studio supports Internet Explorer protected mode.

Page 7: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 3

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio using the Setup wizard

Installing Robotic Automation Studio using the Setup wizardFollow these steps to install the stand-alone version of Pega Robotic Automation Studio.

1. Download and unzip the Robotic Automation Studio setup file into a temporary folder location.

2. Right click on the setup executable file (OpenSpanStudioVS2015Setup.exe) and select Run as Administrator. The Setup wizard starts.

Click Next to continue. The Pega Robotics Office Support panel is displayed.

Note For best results, install from a local drive, not a mapped drive. If you are upgrading from an earlier version of Studio, first back up your solutions and then use Windows Control Panel to uninstall the earlier version.

Note The Setup wizard performs prerequisites system and machine checks before installing Robotic Automation Studio on your machine. If any programs required to run Robotic Automation Studio are missing, you are prompted to install them.

Page 8: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio using the Setup wizard

Pega Robotic Automation Studio 8.0 Installation Instructions 4

3. Select the version of Microsoft Office installed on this machine. Select None if Office is not installed on this machine, the installed version is not listed, or if you do not plan to integrate Microsoft Office.

4. Click Next to continue. The Training CRM Application Setup File panel is displayed.

5. Click Yes to install sample CRM application setup file that is used with Robotic Automation Studio training. Leave this box unchecked if you do not want to install sample CRM application.

Click Next to continue. The OpenSpan Services panel is displayed.

Robotic Automation Studio includes connectors you can use in automations to, for instance, write data to cells in Excel spreadsheets, schedule appointments in Outlook, or write and read text from Word documents. On this panel, you enable those connectors for your version of Office.

Page 9: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 5

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio using the Setup wizard

6. Make sure the box is checked to install OpenSpan services, unless instructed otherwise by Support. Then click Next. The Connectivity Configuration panel is displayed.

7. FFor updates, the system retrieves values from the CommonConfig.xml file and displays the following fields. If you need to change any of these values, do so and click Next. If you are unsure what to enter, check with your System Administrator. Typically, the displayed values are correct for your installation.

Note The Management Console was renamed to Robotic Automation Deployment Portal with the release of Robotic Automation Deployment Portal version 8.0. This release coincided with Robotic Automation Studio 8.0.1024.

Page 10: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio using the Setup wizard

Pega Robotic Automation Studio 8.0 Installation Instructions 6

For first time installs, enter the following information. If you are unsure what to enter, check with your system administrator.

8. When finished, check Next to continue.

Field DescriptionNone Select this option if you do not want to connect to either the Pega Robot

Manager or Robotic Automation Deployment Portal.

Enable Robot Manager Connectivity

Select this option to connect to Robot Manager and to enable the Robot Manager URL, Package Server Endpoint URL, and Enable Robotic Process Automation fields.Robot Manager lets you monitor the performance, health, and throughput of your Robotic Process Automation (RPA) robots (virtual machines) and perform these tasks:• Manage robots and work queues, such as specifying the number of

automations that can fail on a virtual machine.• Configure the organizational hierarchy of departments and users.• Apply roles to users to define the tasks that they can perform.• Get updated automation packages and deploy them to robotic workgroups,

departments, and users.

Robot Manager URL Enter the URL you want the system to use to connect to Robot Manager.

Package Server Endpoint URL

Enter the URL you want the system to use to connect to the Package Server.

Enable Robotic Process Automation

Check this box to tell the system that your robots are Robotic Process Automation robots which do not require user interaction.If you leave this box unchecked, the system assumes you have Robotic Desktop Automation robots, which do interact with users.

Robot Workgroup Specify the name of the robot workgroup in this field.

Enable Deployment Portal Connectivity

Select this option to connect to the Robotic Automation Deployment Portal and to enable the Tenant Name and Configuration Server fields.

Tenant Name The tenant name assigned to your company or organization. This is typically the company name, omitting any non-alphanumeric characters.

Configuration Server The name (type) of the configuration server. Configuration servers are used to authenticate and deliver configuration settings.

Note You can change these values after you install Robotic Automation Studio.

Page 11: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 7

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio using the Setup wizard

The Robotic Desktop Automation (RDA) Integration panel is displayed.

9. On this panel, you let the system know if you want Robotic Automation Studio to communicate with web-based Pega implementations and, if so, what port should be used. You can also use this panel to enable JSON web token (JWT) security.

After you make your entries, click Next. The Installation Folder panel is displayed.

Note Robotic Desktop Automation (RDA)/REST Service integration with the Pega Platform is not supported in a server deployment, such as Citrix or Terminal Server.

Field DescriptionEnable RDA Integration

Check this box if you want Robotic Automation Runtime to communicate with web-based Pega implementations.

Port Accept the default, 9443, unless otherwise instructed by your system administrator.

Enable JSON Web Token Security

Check this box if you want Robotic Automation Runtime to use JSON Web Token (JWT) Security. JWT Security lets you include an additional level of security to prevent a browser session from spoofing its domain and invoking automations from a malicious website. With JWT Security enabled, Robotic Automation Runtime requests the public key from the Pega server and then uses that key to validate incoming invocation requests.

Pega Server URL

If you enabled JSON Web Token (JWT) Security, enter the URL you want the system to use to retrieve the JWT public profile key. The system uses this key to validate RDA requests.

Page 12: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio using the Setup wizard

Pega Robotic Automation Studio 8.0 Installation Instructions 8

10. Accept the default installation folder for Robotic Automation Studio or click Browse to select a different location.

Click Next to continue. The Browser Extension Installation panel is displayed.

11. Check the appropriate browser extension boxes if you plan to automate other browsers in addition to Internet Explorer. Robotic Automation Studio offers limited support for the browsers shown on this panel. For more information, see the Application Support Matrix.

Click Next to continue. The Shortcuts panel is displayed.

Note The default Robotic Automation Studio installation folder is \Program Files, which is protected by default in Windows 7. So, for Robotic Automation Studio to save files and folders on Windows 7 machines, you must either...• Give to all potential users full control permissions to the Robotic Automation Studio program folder.• Install Robotic Automation Studio in a location other than the \Program Files folder.

Page 13: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 9

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio using the Setup wizard

12. Choose from the following options:

Click Next to continue. The Disclaimer panel is displayed.

13. Read the disclaimer and if you agree to the terms click the I accept these terms option.

14. Click Next to continue. The Ready to Install panel is displayed.Click Install to begin the Robotic Automation Studio installation.

A message shows the installation progress. When the installation finishes, the Completing the Pega Robotic Automation Studio for Microsoft Visual Studio 2015 Setup Wizard panel is displayed.

15. Click Finish to exit the Setup wizard.

Pega Robotic Automation Studio is now installed and ready to use.

Click If you wantDesktop A Studio shortcut created on the desktop.

Start Menu Programs folder A program group and shortcuts created on the Start menu.

Startup folder Robotic Automation Studio to start automatically when Windows starts.

Page 14: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio from the command line

Pega Robotic Automation Studio 8.0 Installation Instructions 10

Installing Robotic Automation Studio from the command lineYou can bypass the Setup wizard and install Robotic Automation Studio using the command line using the OpenSpanStudioVS2015Setup.exe program.

1. Open a command prompt window.

2. At the command prompt, enter the command to start Robotic Automation Studio and include the applicable Switches and Parameters.

Here is an example of the command line syntax:OpenSpanStudioVS2015Setup.exe (switches) (parameters)

Switches

This table shows the command line switches you can use.

Switch Description/? or /help Displays Help information.

/exebasicui Launches the .exe setup with only a basic user interface.

/exelang <locale> Launches the .exe setup using the language you specify using a locale code, such as 1033 for English - United States.

/exelog <path> Tells the system to create a log file in the location you specify.

/exenoui Launches the .exe setup with no user interface.

/exenoupdates Launches the .exe setup without checking for a newer version.

/extract <folder> Extracts all of the files in the folder you specify. Here is an example:/extract c:\pega

/i Installs the system.

/L*v Tells the program to log all install information including that generated by the v (verbose) option. Include the name of the log file you want to use.

/listlangs Lists the languages supported by in this version.

/password <password> Specifies the password you want the proxy to use.

/qn (Silent Mode). Installs the system with no user interaction at all.

/qn+ Installs the system with no user interaction except for a modal dialog that is displayed at the end.

/username <name> Specifies the user name you want the proxy to use.

<msiOptions> Lists the options to use when you run the .msi package. For more information on these options, see the Microsoft TechNet web site:

http://technet.microsoft.com/en-us/library/cc759262%28v=WS.10%29.aspx

Page 15: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 11

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio from the command line

Parameters

This table shows the command line parameters you can use.

Parameter DescriptionAI_DESKTOP_SH={0,1}

Enter one (1) to create desktop icons.The default is zero (0), which does not create desktop icons.

AI_QUICKLAUNCH_SH={0,1}

Enter one (1) if you want the installation program to add an icon to the Windows Quick Launch toolbar.The default is zero (0), which tells the program not to add the icon.

AI_STARTMENU_SH={0,1}

Enter zero (0) if you do not want the installation program to create a Start menu program folder.The default is one (1), which tells the program to create a Start menu folder

AI_STARTUP_SH={0,1}

Enter one (1) if you want the installation program to add an icon in the Startup folder.The default is zero (0), which tells the program not to add an icon.

APPDIR= Use this parameter to override the default installation folder. The default is blank, which tells the program to install Robotic Automation Runtime into the default folder.

APP_TOGGLE= Enter AGILEDESKTOP to install a Robotic Automation Agile Desktop icon. The default is RUNTIME, which installs a Robotic Automation Runtime icon. Here is an example.

APP_TOGGLE=AGILEDESKTOP

ENABLE_SERVER= Enter True to enable the Workforce Intelligence server. The default is False.

ENABLE_INT= To change the availability of the Workforce Intelligence component, include this parameter.

ENABLE_INT = "TRUE" INT_URL = "some.url.com"

INSTALL_CONFIG_FILES={0,1}

Enter zero (0) to preserve your existing configuration files during the installation.Keep in mind that new functionality may depend on settings in these configuration files and if you choose to preserve the existing files, you may not be able to take advantage of the new functionality, unless you manually update these files after the installation finishes.The default is one (1), which tells the program to overwrite the RuntimeConfig.xml, OpenSpan.Runtime.exe.Config, and OpenSpan.Runtimex64.exe.Config files during the installation.

INSTALL_OFFICE={0,2002,2003,2007,2010, 2013,2016}

Enter the version of Microsoft Office installed on the computer.The default is zero (0), which indicates Microsoft Office is not installed on this machine, the installed version is not listed, or if you do not plan to integrate with Microsoft Office.

INST_CHROME=(0,1)

Enter one (1) to install the Chrome extension. This lets you run solutions that automate Chrome. If omitted, the Chrome extension is not installed.Note: For more information on the Chrome extension, see the Community site.

INST_FIREFOX=(0,1)

Enter one (1) to install the Firefox extension. This lets you run solutions that automate Firefox. If omitted, the Firefox extension is not installed.Note: For more information on the Firefox extension, see the Community site.

Page 16: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio from the command line

Pega Robotic Automation Studio 8.0 Installation Instructions 12

INST_SERVICES=(0,1)

The default is one (1), which installs these services. Typically, you should accept the default. Enter zero (0) if you do not want Runtime Services and the Runtime Driver Service installed. You would only set this parameter to zero in Citrix environments where you could not install these services.

LOGVIEWER={0,1}

Enter one (1) to install the Log Viewer. The Log Viewer lets you read and work with SuperTrace® diagnostics output.The default is zero (0).Note: For more information, see the Log Viewer topic.

Robotic Automation Deployment Portal and Pega Robot Manager parameters

ENABLE_IDP= In versions 8.0.1058 and later, enter True to enable an Identity Provider (IdP) server. IdP servers provide security tokens which are used by either the Config server or the Robot Manager. Accept the default if you want the system to prompt users to enter their email address and password when they log in to Robotic Automation Runtime or Studio. The default is False.

IDP_URL= If you enable an Identity Provider (IdP) server in the ENABLE_IDP parameter, enter the URL you want to use to connect to that server. This URL is used by the Configuration server and Robot Manager to receive security tokens.

ENABLE_ADFS= Note: In versions 8.0.1058 and later, this parameter has been deprecated and replaced with the ENABLE_IDP parameter.Accept the default to enable Active Directory Federation Services (ADFS) authentication. The default is True. Enter False to disable the use of ADFS authentication. If you enable Robotic Automation Deployment Portal connectivity and disable ADFS authentication, Robotic Automation Deployment Portal prompts you to enter a user name and password for authentication.

ADFS_URL= Note: In versions 8.0.1058 and later, this parameter has been deprecated and replaced with the IDP_URL parameter.Enter the URL to your internal ADFS service.

Robotic Automation Deployment Portal parameters

BASEURL= This defines the URL from which updates are downloaded. The default is shown here:

https://omc.openspan.comDo not change this default.

ENABLE_SERVER= Enter True to enable a connection to the Robotic Automation Deployment Portal server. Enter False to disable Robotic Automation Deployment Portal connectivity. The default is True.

TENANT= Enter the tenant name assigned to your organization.

Pega Robot Manager parameters

Parameter Description

Page 17: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 13

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio from the command line

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.

PACKAGE_SERVER_URL= Enter the URL to use to connect Robotic Automation Runtime with the Pega Robotic Automation Package Server. The Package Server stores deployment files (packages) that are uploaded and assigned to Robotic Automation Runtime systems by the Robot Manager.

ENABLE_RPA= If you enable a connection to the Robot Manager, enter True to tell the Robot Manager that the robot is a Robotic Process Automation (RPA) robot. If you enter False, the robot acts a Robotic Desktop Automation (RDA) robot.The default is False.

You can set these RDA configuration RuntimeConfig.xml keys (in parentheses) using the following command line parameters. For more information, see Runtime Configuration Settings.

JWT_SECURITY= (JWTSecurity) Enter True to enable JSON Web Token (JWT) Security between Pega applications that are running in a local browser, such as Pega Customer Service or Pega Sales Automation, and Robotic Automation Runtime. Enable JWT Security to include an additional level of security to prevent a browser session from spoofing its domain and invoking automations from a malicious website. The default is False.

JWT_URL= (PegaServerURL) If you enable JWT security, enter the URL that you want to use to retrieve the JWT profile public key. The system uses this key to validate the signature of RDA requests from Robot Manager to Robotic Automation Runtime.

RDA_INT= (Enabled/Disabled) Enter True to enable Robotic Desktop Automation (RDA) support. If set to True, Robotic Automation Runtime self hosts a REST service which accepts requests from the Pega application.

RDA_PORT= (Port) Specify the port. The default is 9443.

ALLOWED_ORIGINS= (AllowedOrigins) Here you can specify any allowed origins. Enter a comma-delimited list of domains from which requests should be accepted. Here is an example:

*.pega.com,acme.pegacloud.comPlease note there is no user interface for Allowed_Origins. You can only configure allowed origins using the command line parameter.

PEGA_BASE_URL= Note: In versions 8.0.1058 and later, this parameter has been deprecated. Instead, you set up this connectivity using the CommonConfig.xml file.(BaseURL) Specify the base URL. This is the address that Robotic Automation Runtime uses when it requests work items in a Robotic Process Automation (RPA) implementation.

Parameter Description

Page 18: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio from the command line

Pega Robotic Automation Studio 8.0 Installation Instructions 14

Here is an example:

OpenSpanStudioVS2015Setup.exe /qn+ /L*v LogFileName.txt INSTALL_OFFICE=2013 AI_STARTMENU_SH=1 AI_DESKTOP_SH=1

Page 19: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 15

Installing Pega Robotic Automation Studio | Installing Robotic Automation Studio offline

Installing Robotic Automation Studio offlineThe Setup wizard requires Internet access. With this access, it downloads and installs any needed prerequisites. If, however, the computer on which you are installing Robotic Automation Studio does not have access to the Internet, you must download and install the prerequisite applications before you install Robotic Automation Studio. Here is a list of the prerequisites.

• .NET Framework version 4.6• Visual Studio Shell (Integrated)• Visual Studio Isolated Shell• Visual Studio 2015 Update 2 (Update 3 is required for 8.0.1053 and later builds.)

Since there are prerequisites that require Internet access, there are additional steps you must perform to prepare a machine without Internet access for a Pega Robotic Automation Studio install.

1. First download the .NET offline installers from Microsoft. You can find them on this webpage:

https://www.microsoft.com/en-us/download/details.aspx?id=48137Download this offline installer on a machine with Internet access and then copy the offline installer to the offline machine. After doing so, install .NET manually.

2. You can install Visual Studio 2015 Update 2 (or 3) offline but doing so requires a some additional setup. There are a couple ways you can get a Visual Studio 2015 Update 2 (or 3) offline installer:

— With a MSDN Developer account, you can download an ISO for the Visual Studio 2015 Update 2 (or 3) from MSDN.

— On a machine with Internet access, run this command at a command prompt:vs2015.2.exe /layout or vs2015.3.exe /layout

This lets you decide where you want to download the packages that Visual Studio 2015 Update 2 (or 3) needs to perform an offline installation.

Both methods provide a package that lets you install Visual Studio Update 2 (or 3) offline.

Once you have downloaded these prerequisites, follow these steps to continue the installation of Pega Robotic Automation Studio.

1. Install .NET 4.6.

2. Install Visual Studio Isolated Shell. vs_isoshell.exe.

3. Install Visual Studio Integrated Shell. vs_intshelladditional.exe.

4. Install Visual Studio 2015 Update 2 (or 3).

5. Restart the computer.

After your computer restarts, you can install Robotic Automation Studio. For more information, see these topics:

• Installing Robotic Automation Studio using the Setup wizard• Installing Robotic Automation Studio from the command line

Note You can find these applications on the Microsoft Developer Network (MSDN).

Page 20: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Installing the OCR screen scraping feature

Pega Robotic Automation Studio 8.0 Installation Instructions 16

Installing the OCR screen scraping featureBuild 8.0.1087 added support for creating automations by using Optical Character Reader (OCR) screen scraping. The OCR screen scraping feature allows you to collect data that is displayed on the screen and then manipulate that data in automations that are created with Pega Robotic Automation Studio.

To use the OCR screen scraping feature, you must separately install the PegaRobotOCREssentials module. This module is included in your Pega Robotic Automation Studio installation files. A Setup wizard guides you through the installation of this module.

1. Open the Pega Robotic Automation Studio update that you downloaded from Pega.

2. Unzip the Pega_Robot_OCR_Essentials_8.0.0.zip file.

3. Double-click the PegaRobotOCREssentials.exe file.

4. Follow the prompts that the Setup wizard displays to complete the installation.

By default, the wizard installs the OCR screen scraping files into the following folder:

C:\Program Files (x86)\OpenSpan\Pega Robot OCR Essentials\

Note By default, the OCR library writes to the ProgramData\ABBYY folder. Make sure that your Robotic Automation Runtime users have permission to read from and write to this folder.

Page 21: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Pega Robotic Automation Studio 8.0 Installation Instructions 17

Installing Pega Robotic Automation Studio | Uninstalling the system

Uninstalling the system

Follow these steps to uninstall Robotic Automation Studio:

1. Use Windows Control Panel to uninstall OpenSpan Studio for Microsoft Visual Studio 2015.

2. (Optional.) If you installed the OCR screen scraping feature, use Windows Control Panel to uninstall Pega Robot OCR Essentials.

3. Remove the OpenSpan folder in the following locations:

— CommonApplicationData: \ProgramData — ApplicationData: \Users\<userName>\AppData\Roaming — LocalApplicationData: \Users\<userName>\AppData\Local

Note If you customized any of the configuration files, such as the CommonConfig.xml or RuntimeConfig.xml files, make backup copies of these files before you uninstall the system. Making a backup copy allows you to reapply your changes after you install the new version.

Page 22: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Installing Pega Robotic Automation Studio | Uninstalling the system

Pega Robotic Automation Studio 8.0 Installation Instructions 18

Page 23: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

INDEX

Symbols.NET Framework

installing offline 15.NET Framework requirements 2

Aadministrator rights 3AI_DESKTOP_SH parameter 11AI_QUICKLAUNCH_SH

parameter 11AI_STARTMENU_SH parameter 11AI_STARTUP_SH parameter 11APPDIR parameter 11APP_TOGGLE parameter 11

BBASEURL parameter 12

CChrome extension 11Citrix 7, 12command line

parameters 11switches 10

company name 6configuration files 11Configuration Server field 6

CRM application 4

Ddesktop icon 11desktop shortcut 9disk space requirements 2

EEnable Server Connectivity field 6ENABLE_ADFS parameter 12ENABLE_INT parameter 11ENABLE_SERVER parameter 11,

12

FFirefox extension 11

Iinstallation folder 8INSTALL_CONFIG_FILES

parameter 11INSTALL_OFFICE parameter 11INST_CHROME parameter 11INST_FIREFOX parameter 11INST_SERVICES parameter 12integrity level 2

Page 24: Pega Robotic Automation Studio - community.pega.com Robotic... · Robotic Automation Studio is a complete stand-alone version built for developers who do not have Microsoft Visual

Index 20

LLOGVIEWER parameter 12

Mmapped drives 3Microsoft Office 4, 11Microsoft Visual Studio

requirements 2Microsoft Windows

requirements 2

OOCR screen scraping 16OCR screen scraping feature 17offline installation 15OpenSpan.Runtime.exe.Config file 11OpenSpan.Runtimex64.exe.Config

file 11OpenSpanRuntimeEntSetup.exe

program 3, 10OpenSpanStudioVS2010Setup.exe

program 10

PPegaRobotOCREssentials module 16prerequisites 3

installing manually 15processor requirements 2Program Files folder 8

QQuick Launch toolbar 11

RREST 7Run as Administrator option 3RuntimeConfig.xml file 11

Sshortcuts 8Start menu folder 11Start Menu Programs Folder option 9Startup folder 9, 11Studio

plug-in 1requirements 2

standalone version 1SuperTrace 12

TTenant Name field 6TENANT parameter 12Terminal Server 7

VVisual Studio

installing offline 15

WWindows

requirements 2