Sei sulla pagina 1di 1087

Robotic Process Automation

Version : 2019.11
PDF Generated on : 28 Jan 2020
Robotic Process Automation 2019.11

Table of Contents
Home ............................................................................................................................................................ 11
Release notes ............................................................................................................................................... 12
Enhancements .............................................................................................................................................. 15
Fixed issues .................................................................................................................................................. 16
Known issues ................................................................................................................................................ 17
Deprecation and obsolescence ..................................................................................................................... 18
Get started ................................................................................................................................................... 19
RPA architecture ........................................................................................................................................... 20
RPA capabilities ............................................................................................................................................ 24
RPA personas ................................................................................................................................................ 28
Glossary ........................................................................................................................................................ 30
Install ............................................................................................................................................................ 37
Plan ............................................................................................................................................................... 39
Deployment architecture .............................................................................................................................. 40
System requirements ................................................................................................................................... 48
Virtual systems and cloud deployments ....................................................................................................... 56
Performance and sizing information ............................................................................................................. 57
Prepare ......................................................................................................................................................... 65
Configure RabbitMQ ...................................................................................................................................... 66
Set up database environment ...................................................................................................................... 69
Prepare the database environment .............................................................................................................. 70
Deploy and maintain a Microsoft SQL server database ................................................................................ 75
Workflow for Microsoft SQL Server Deployment ........................................................................................... 76
System requirements for Microsoft SQL server ............................................................................................ 77
Configure SQL server .................................................................................................................................... 80
Manually create an RPA database on Microsoft SQL server .......................................................................... 82
Maintain the Microsoft SQL server database ................................................................................................ 85
Deploy and maintain an Oracle database ..................................................................................................... 95
Workflow for Oracle deployment .................................................................................................................. 96
System requirements for Oracle ................................................................................................................... 97
Configure an Oracle database ...................................................................................................................... 99
Manually create an RPA database on an Oracle instance ........................................................................... 101
Oracle database maintenance .................................................................................................................... 104
Deploy and maintain a PostgreSQL database ............................................................................................. 112
Workflow for PostgreSQL deployment ........................................................................................................ 113
System Requirements for PostgreSQL ........................................................................................................ 114
Configuring PostgreSQL .............................................................................................................................. 116
Manually create an RPA database on PostgreSQL ...................................................................................... 117
PostgreSQL database maintenance ............................................................................................................ 119
Installation Wizard Other database option .................................................................................................. 126
Robotic Process Automation 2019.11

Database purging ....................................................................................................................................... 131


Set up database environment for RPA Workflow Designer ......................................................................... 133
Prepare the database environment ............................................................................................................ 134
Deploy and maintain a Microsoft SQL server database .............................................................................. 138
Workflow for Microsoft SQL Server Deployment ......................................................................................... 139
System Requirements for Microsoft SQL Server ......................................................................................... 140
Configure SQL server .................................................................................................................................. 142
Manually create an RPA Workflow Designer database on Microsoft SQL server ......................................... 144
Microsoft SQL server database maintenance .............................................................................................. 146
Deploy and maintain an Oracle database ................................................................................................... 150
Workflow for Oracle deployment ................................................................................................................ 151
System requirements for Oracle ................................................................................................................. 152
Configure an Oracle database .................................................................................................................... 154
Manually create an RPA database on an Oracle instance ........................................................................... 156
Oracle database maintenance .................................................................................................................... 159
Deploy and maintain a PostgreSQL database ............................................................................................. 163
Workflow for PostgreSQL deployment ........................................................................................................ 164
System Requirements for PostgreSQL ........................................................................................................ 165
Configuring PostgreSQL .............................................................................................................................. 167
Manually create an RPA database on PostgreSQL ...................................................................................... 168
PostgreSQL database maintenance ............................................................................................................ 170
Installation Wizard Other database option .................................................................................................. 172
Pre-installation tasks .................................................................................................................................. 176
Deploy ........................................................................................................................................................ 178
Install RPA components .............................................................................................................................. 179
Install RPA Workflow Designer .................................................................................................................... 180
Install RPA Recorder ................................................................................................................................... 190
Install RPA Central ...................................................................................................................................... 192
Install RPA RAS ........................................................................................................................................... 204
Install RPA Robot ........................................................................................................................................ 210
Install RPA Central and RPA RAS ................................................................................................................. 213
Install RPA Self-Service X ............................................................................................................................ 225
Install an RPA cluster .................................................................................................................................. 234
Silent installation ........................................................................................................................................ 242
Silent installation of Central and RAS ......................................................................................................... 243
Silent installation of Workflow Designer ..................................................................................................... 249
Silent installation of Self-Service X ............................................................................................................. 254
Silent installation of Recorder ..................................................................................................................... 258
Silent installation of Robot .......................................................................................................................... 260
Post installation tasks ................................................................................................................................. 262
Uninstall RPA components .......................................................................................................................... 263
Silent uninstall of RPA components ............................................................................................................ 268
Upgrade ...................................................................................................................................................... 269
Robotic Process Automation 2019.11

Upgrade RPA ............................................................................................................................................... 270


Integrate ..................................................................................................................................................... 275
Administer .................................................................................................................................................. 276
Initial administration tasks for RPA Central ................................................................................................ 277
Configure and enable authentication .......................................................................................................... 278
Manage RPA licenses .................................................................................................................................. 279
Adjusting the logging levels ........................................................................................................................ 282
Configure LW-SSO settings ......................................................................................................................... 284
Change the service name ........................................................................................................................... 286
Change the timeout limit for the RPA web interface ................................................................................... 288
Schedule database purging ........................................................................................................................ 289
Capture the credentials of the logged-in user ............................................................................................ 291
Specify communication protocols ............................................................................................................... 292
Initial administration tasks for RPA Robot ................................................................................................... 293
Configure RPA Robot execution results ...................................................................................................... 294
Initial administration tasks for RPA Workflow Designer .............................................................................. 295
View system information ............................................................................................................................ 296
Configure a proxy for RPA Workflow Designer ............................................................................................ 297
Configure Recorder settings for RPA Workflow Designer ............................................................................ 298
Configure Record and Run settings for RPA Workflow Designer ................................................................. 299
Configure an emulator to work with RPA Recorder ..................................................................................... 302
Recurring administration tasks for RPA Central .......................................................................................... 305
Encrypt and obfuscate passwords .............................................................................................................. 306
Change the database password .................................................................................................................. 308
Change the database IP .............................................................................................................................. 309
Change the hostname IP ............................................................................................................................. 310
Change the URL of a load balancer or RPA Central ..................................................................................... 312
Back up and recover RPA ............................................................................................................................ 313
Set up disaster recovery ............................................................................................................................. 314
System tuning ............................................................................................................................................. 315
Recurring administration tasks for RPA Workflow Designer ........................................................................ 317
Advanced configuration of RPA components .............................................................................................. 318
Change the database password .................................................................................................................. 320
Change the database IP .............................................................................................................................. 321
Change the hostname IP ............................................................................................................................. 322
Encrypt passwords ...................................................................................................................................... 323
Create a Git repository ............................................................................................................................... 324
Adjust the logging levels ............................................................................................................................ 325
Change the service name and description .................................................................................................. 327
Change the timeout limit ............................................................................................................................ 328
Configure content pack import size ............................................................................................................ 329
Back up RPA Workflow Designer ................................................................................................................. 330
Set up disaster recovery ............................................................................................................................. 331
Robotic Process Automation 2019.11

System tuning ............................................................................................................................................. 332


Set up the system configuration ................................................................................................................. 333
Set up security settings .............................................................................................................................. 334
Set up security for roles .............................................................................................................................. 341
Set up security using LDAP authentication ................................................................................................. 352
Set up security for internal users ................................................................................................................ 377
Set up security for SAML authentication ..................................................................................................... 383
Set up security using LWSSO ...................................................................................................................... 390
Set up a security banner ............................................................................................................................. 395
Set up topology for workers and RPA RASes ............................................................................................... 397
Set up topology for RPA Robot .................................................................................................................... 410
Set up an automatic RPA RAS upgrade ....................................................................................................... 412
Set up general settings ............................................................................................................................... 417
Set up the system settings for licensing ..................................................................................................... 423
Monitor and control database size .............................................................................................................. 425
Control database size by purging ............................................................................................................... 431
Send email notifications ............................................................................................................................. 432
Customize email notifications ..................................................................................................................... 433
Set the browser language ........................................................................................................................... 435
Enable authentication ................................................................................................................................. 437
Enable auditing ........................................................................................................................................... 439
Set up security for RPA Central ................................................................................................................... 440
Security concepts ....................................................................................................................................... 441
Secure implementation and deployment .................................................................................................... 443
Secure installation guidelines ..................................................................................................................... 444
Network and communication security ........................................................................................................ 445
Administration interface security ................................................................................................................ 446
User management and authentication ....................................................................................................... 447
Authorization .............................................................................................................................................. 449
Configure RPA Central in IDM mode ........................................................................................................... 451
Configure LDAP in IDM mode ...................................................................................................................... 455
Backup ........................................................................................................................................................ 457
Encryption .................................................................................................................................................. 458
Hardening RPA Central ............................................................................................................................... 461
Hardening recommendation ....................................................................................................................... 462
Working with server and client certificates ................................................................................................. 464
Encrypting the communication using a server certificate ........................................................................... 465
Client certificate manual authentication ..................................................................................................... 476
Configure the TLS protocol ......................................................................................................................... 481
Prevent flows from accessing the Central/RAS local file system ................................................................. 482
Adding Java security manager .................................................................................................................... 484
Enable redirection to HTTPS ....................................................................................................................... 486
Disable CSRF protection ............................................................................................................................. 487
Robotic Process Automation 2019.11

Set up security and hardening for RPA Workflow Designer ........................................................................ 488
Security concepts ....................................................................................................................................... 489
Secure implementation and deployment .................................................................................................... 490
Secure installation guidelines ..................................................................................................................... 491
Network and communication security ........................................................................................................ 493
User management and authentication ....................................................................................................... 494
Backup ........................................................................................................................................................ 495
Encryption .................................................................................................................................................. 496
Log files ...................................................................................................................................................... 498
Security questions and answers ................................................................................................................. 499
Hardening RPA Workflow Designer ............................................................................................................. 500
Security hardening recommendations ........................................................................................................ 501
Working with server and client certificates ................................................................................................. 502
Encrypt the communication using a server certificate ............................................................................... 503
Replace the RPA Workflow Designer TLS server certificate ........................................................................ 504
Import a CA root certificate to the RPA Workflow Designer TrustStore ....................................................... 507
Change and encrypt obfuscate the KeyStore TrustStore password ............................................................ 508
Encrypt passwords ...................................................................................................................................... 510
Remove the RC4 cipher from the SSL-supported ciphers ........................................................................... 511
Change or disable the HTTP/HTTPS ports ................................................................................................... 512
Configure the secured properties ............................................................................................................... 514
Set SSL configuration properties ................................................................................................................ 516
Troubleshoot the HTTPS connector ............................................................................................................. 517
Troubleshoot multiple deployment requests .............................................................................................. 518
Promote content packs ............................................................................................................................... 519
Overview of promoting content pack .......................................................................................................... 520
Deploy and manage content packs ............................................................................................................ 525
Manage the flow library .............................................................................................................................. 547
View a flow graph ....................................................................................................................................... 557
Set up configuration items for a content pack ............................................................................................ 562
Test and troubleshoot a flow ...................................................................................................................... 576
Use ............................................................................................................................................................. 577
Use RPA Workflow Designer ....................................................................................................................... 582
Keyboard shortcuts ..................................................................................................................................... 591
Use IDM Admin ........................................................................................................................................... 593
Set up the workspace ................................................................................................................................. 595
Set up and work with source control management .................................................................................... 597
Set up the RPA Workflow Designer Project ................................................................................................. 627
Import Content Packs to the Dependencies Pane ....................................................................................... 631
Use CloudSlang files created outside RPA Workflow Designer .................................................................... 638
Author content using RPA Workflow Designer ............................................................................................ 640
Author flows ................................................................................................................................................ 641
Create or edit a flow ................................................................................................................................... 642
Robotic Process Automation 2019.11

Create steps in a flow ................................................................................................................................. 644


Create navigation lines between steps in a flow ......................................................................................... 652
Add result steps to a flow ........................................................................................................................... 655
Define flow properties ................................................................................................................................ 661
Define step properties ................................................................................................................................ 671
Edit the expression of a value for an input or output ................................................................................. 682
Extract and modify output values ............................................................................................................... 684
Add decisions to a flow ............................................................................................................................... 697
Assign a step to a worker group ................................................................................................................. 702
Change the start step ................................................................................................................................. 707
Create flows with loops ............................................................................................................................... 708
View the CloudSlang code .......................................................................................................................... 719
YAML file textual representation ................................................................................................................. 720
Validate flows ............................................................................................................................................. 722
Author operations ....................................................................................................................................... 728
Hybrid authoring in RPA Workflow Designer ............................................................................................... 737
Author System Properties ........................................................................................................................... 739
Debug the flow ........................................................................................................................................... 743
Create an RPA activity ................................................................................................................................ 747
Object identification in RPA Workflow Designer .......................................................................................... 754
Create and deploy a content pack .............................................................................................................. 757
Use RPA Central .......................................................................................................................................... 762
Introduction to RPA Central ........................................................................................................................ 765
Working with the dashboard ....................................................................................................................... 774
Work with CloudSlang content flows ........................................................................................................... 778
Run and monitor flows ................................................................................................................................ 781
Run a flow ................................................................................................................................................... 783
Execute a hybrid flow ................................................................................................................................. 796
Schedule flow runs ..................................................................................................................................... 798
Track and manage flow runs ...................................................................................................................... 818
Adjust the display of flow runs .................................................................................................................... 824
Test and troubleshoot a flow run ................................................................................................................ 830
Embed RPA Central views in external web pages ....................................................................................... 853
Use RPA Self-Service X ............................................................................................................................... 856
Access RPA Self-Service X .......................................................................................................................... 857
Manage RPA Self-Service X ......................................................................................................................... 858
Run Self-Service X scenarios ...................................................................................................................... 864
Troubleshoot ............................................................................................................................................... 867
Troubleshoot RPA Workflow Designer ......................................................................................................... 868
Error when accessing RPA Workflow Designer on Oracle Linux .................................................................. 869
Run button is disabled ................................................................................................................................ 871
Password issue when creating a new SAP user using RPA Workflow Designer ........................................... 872
Troubleshoot RPA Recorder ........................................................................................................................ 873
Robotic Process Automation 2019.11

A different RPA Workflow Designer user cannot initiate recording ............................................................. 874
Recorder does not capture screen events .................................................................................................. 875
Unable to configure UFT ............................................................................................................................. 876
Troubleshoot RPA Central ........................................................................................................................... 877
Special characters are not displayed correctly in the .csv file .................................................................... 878
SSL handshake error ................................................................................................................................... 879
Plugins are not deleted ............................................................................................................................... 880
Slower execution of flows ........................................................................................................................... 881
Low resolution on Firefox ............................................................................................................................ 882
Deploying content packs takes longer time ................................................................................................ 883
Locked out of RPA Central .......................................................................................................................... 884
Remote host supports RC4 cipher increasing security risk ......................................................................... 885
Mapping group alias and worker group do not work ................................................................................... 886
Default algorithm is unsafe ......................................................................................................................... 887
Content deployment does not end ............................................................................................................. 888
Scheduled runs have inconsistent times .................................................................................................... 889
RPA help links are not working ................................................................................................................... 890
Some buttons are not visible ...................................................................................................................... 891
Problems with new worker registration or existing worker functionality .................................................... 892
Steps appear scrambled in the Tree View and Table View ......................................................................... 893
Exception occurred during deployment ...................................................................................................... 894
Service unavailable ..................................................................................................................................... 895
Exception occurs during content pack deployment with a duplicated UUID ............................................... 896
During deployment, the file name becomes corrupted .............................................................................. 897
No permission to perform an action ........................................................................................................... 898
Unexpected error status ............................................................................................................................. 899
Unable to log on to RPA .............................................................................................................................. 900
Internal server error ................................................................................................................................... 901
Unable to trigger a flow .............................................................................................................................. 902
Out of memory error - Metaspace ............................................................................................................... 903
RPA crashes when running a content ......................................................................................................... 904
Scheduler password expires ....................................................................................................................... 905
Troubleshoot RPA RAS ................................................................................................................................ 906
Log files are not generated in Windows ...................................................................................................... 907
Troubleshoot RPA Robot ............................................................................................................................. 908
Robot executes RPA activities only when the RDP session is active ........................................................... 909
Troubleshoot RPA Self-Service X ................................................................................................................. 910
Activities display unknown state ................................................................................................................ 911
Activities are refreshed once every 15 seconds ......................................................................................... 912
Unable to use Self-Service X after password change .................................................................................. 913
Develop ...................................................................................................................................................... 914
RPA REST APIs ............................................................................................................................................ 915
Basic authentication ................................................................................................................................... 920
Robotic Process Automation 2019.11

CSRF protection in RPA ............................................................................................................................... 921


Dashboard .................................................................................................................................................. 922
Flow execution ............................................................................................................................................ 924
Get execution summary ............................................................................................................................. 926
Get execution step count ............................................................................................................................ 928
Get execution steps with pagination and filtering ...................................................................................... 930
Get execution summary with pagination and filtering to a CSV file ............................................................ 936
Get a single execution step ........................................................................................................................ 938
Get execution steps as a CSV file ............................................................................................................... 939
Get execution steps as a text file ............................................................................................................... 941
Execution pauses ........................................................................................................................................ 943
Get execution log ....................................................................................................................................... 948
Change the status of an execution ............................................................................................................. 950
Execute a flow by UUID .............................................................................................................................. 953
Flow execution status ................................................................................................................................. 955
Flow input ................................................................................................................................................... 956
Purge debugger execution events .............................................................................................................. 959
Purge execution data .................................................................................................................................. 961
Delete steplog data .................................................................................................................................... 963
Flow library ................................................................................................................................................. 965
Scheduler .................................................................................................................................................... 973
Deployment ................................................................................................................................................ 981
How can I deploy content packs with progress? ......................................................................................... 983
Upload the deployment process file ........................................................................................................... 985
Run a specific deployment or delete process ............................................................................................. 987
Get the deployment process object ............................................................................................................ 989
Delete content pack from deployment process .......................................................................................... 991
Add content pack files for deleting ............................................................................................................. 992
Content packs ............................................................................................................................................. 994
Configuration items .................................................................................................................................. 1005
Audit events ............................................................................................................................................. 1013
LDAP configuration ................................................................................................................................... 1021
Workers .................................................................................................................................................... 1040
Firewall friendly APIs ................................................................................................................................. 1046
Users ......................................................................................................................................................... 1053
LWSSO configuration ................................................................................................................................ 1058
User authentication .................................................................................................................................. 1060
Roles ......................................................................................................................................................... 1062
System information and settings .............................................................................................................. 1069
System log level ....................................................................................................................................... 1074
System notifications ................................................................................................................................. 1077
Get RPA version ........................................................................................................................................ 1080
Target tracking ......................................................................................................................................... 1081
Robotic Process Automation 2019.11

RPA Robot APIs ......................................................................................................................................... 1083


RPA Self-Service X APIs ............................................................................................................................. 1085
CloudSlang content documentation .......................................................................................................... 1087
Home
Robotic Process Automation (RPA) is an automation application powered by an enterprise-scale orchestration
engine, which uses software robots that mimic UI-based human actions. With RPA, you can record screen actions,
and then insert those recordings into workflows to link processes end-to-end. RPA provides superior business logic
and decision making to any task and offers a hybrid authoring experience with graphical drag and drop and textual
with YAML scripting capabilities.

Benefits of RPA
Robots interact with applications and systems like humans do. But they are faster and more accurate. This means
they increase quality, reduce costs, and free up employees to focus on more important things.
RPA provides easy solutions:

When you want to automate with minimal changes to existing systems and applications—in a practical and non-
invasive way, without having to go through expensive and lengthy system integration and application
deployment projects.
When you do not have a way to easily integrate legacy applications, which have no API or difficult API.
When you want to automate quickly.

Deployment mode
RPA is available for deployment in classic mode. Classic mode refers to the conventional deployment model with
standalone installers for each RPA component such as RPA Central, RPA Workflow Designer, RPA Recorder, and RPA
Robot. You need to download the components from the software entitlement site and install them separately.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 11
Robotic Process Automation 2019.11

Release notes
This release of Robotic Process Automation (RPA) introduces 15 new features.
Provide your feedback on what you'd like to see in future release through RPA Idea Exchange.

What's new in RPA 2019.11

RPA Recorder and Robot

Enhanced recording skills. Support to record and run terminal emulator actions and in UI Automation mode.
The supported emulators include MicroFocus (including Attachmate), IBM, Rocket, OpenText, Putty and others.
For more information, see Configure Record and Run settings for RPA Workflow Designer and Create an RPA
activity respectively.

RPA Workflow Designer

Ability to import existing UFT tests. You can now build on existing UFT scripts to create new RPA activities.
This enables you to leverage your past investment in UFT and streamline the migration of automation tests into
the RPA environment. As a result, you can optimize flow creation and execute new RPA processes faster.
For more information, see Create a new RPA activity.
Debug flows containing RPA activities. The built-in debugger in RPA Workflow Designer now also supports
debugging workflows that contain RPA recordings. This enables you to check for execution errors before
deploying the workflow to RPA Central. For more information, see Debug the flow.
Object identification functionality. Ability to identify the objects and their properties and create repository
during the recording session for customization and reuse. See, Object identification in RPA Workflow Designer.
Added a pause functionality for an activity step. Ability to add a wait step to an RPA activity and control an
RPA workflow, see Create an RPA activity.
Assign ROI value to step navigations in CloudSlang flows. When authoring flows in RPA Workflow
Designer, you can now specify a return of investment (ROI) value for step navigations. This enables RPA Central
to compute the ROI of a flow execution at a more granular level. For more information, see Create navigation
lines between steps in a flow.
Enhanced content pack import. Support to assign an imported content pack. For more information, see
Import Content Packs to the Dependencies pane.
Improved adaptability in worker group assignment. Support to assign an RPA native step to a worker
group. See Assign a step to a worker group.
Enhanced output fields usage. Support to use the output fields of RPA native step as an input for a flow.
see Hybrid authoring in RPA Workflow Designer.
Introduced customization for an RPA activity. Ability to customize run settings of a specific RPA activity, see
Create an RPA activity.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 12
Robotic Process Automation 2019.11

RPA Self-Service X

Ability to edit existing scenarios. You can now quickly update the basic details of a scenario from the List
view or change the entire scenario definition in Full Edit mode. For more information, see Edit a scenario in
Manage RPA Self-Service X.

Installer enhancements

When installing RPA Central and RPA Designer, you can now choose to create a new centralized database
schema for Identity Management (IDM) authentication. This adds to the existing option to connect to an available
IDM database, created outside RPA. The new Create database/schema option is available on the IDM
Database Configuration page of the installer and for silent installations of RPA Central and RPA Workflow
Designer.

Performance improvements

Refactored the tree view of flows in RPA Central to improve loading performance when drilling-
down through a very large number of flow steps.
Improved the way workers handle large-context flows. Workers now postpone executing heavy-load steps
in order to avoid out-of-memory crashes. Repeatedly postponed executions will be canceled.

Concurrent licensing

RPA 2019.11 introduces support for concurrent licensing using Micro Focus AutoPass License Server 10.9.2.
Concurrent licensing provides a flexible, cost-effective solution for sharing and managing a pool of robots. An
RPA license plan counts the maximum number of robots that are able to execute activities simultaneously. Each
license enables one robot to execute one RPA activity at a time, on one or multiple servers. One robot can
execute multiple flows and multiple activities as long as the activities are running sequentially and the robot is
handling one activity at a time. For more information, see Manage RPA licenses.

System configuration updates

Updated IDM support. RPA now supports integration with Identity Management (IDM) authentication version
1.26.
Full support for Oracle 18c and PostgreSQL 10. RPA now supports Oracle 18c and PostgreSQL 10 databases
for both native and IDM authentication modes.
Added support for JDBC 7.4.1. RPA MSSQL Server databases now use version 7.4.1 of JDBC driver.
Upgraded Apache Tomcat version. The Apache Tomcat version in RPA is upgraded from 8 to 9.0.22.

Upgrade RPA

Support to upgrade RPA components from 2019.07 to 2019.11 version. For instructions, see Upgrade.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 13
Robotic Process Automation 2019.11

Related topics
What's new in RPA 2019.07

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 14
Robotic Process Automation 2019.11

Enhancements
No enhancements are delivered in this release.

Related topic
Learn about enhancements and submit ideas on the RPA Idea Exchange.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 15
Robotic Process Automation 2019.11

Fixed issues
No issues are fixed in this release.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 16
Robotic Process Automation 2019.11

Known issues
This version of Robotic Process Automation (RPA) has no known issues.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 17
Robotic Process Automation 2019.11

Deprecation and obsolescence

Deprecated items
Deprecated items are components, features or parameters which Micro Focus will no longer provide
enhancements. They will continue to be supported until a notice of obsolescence is published. In addition, bug fixes
and support cases will be handled until the deprecated item becomes obsolete.

Deprecated item Description Deprecated since version

MS SQL Server 2008 MS SQL Server 2008 is now deprecated. 2019.11

Obsoleted items
No items are obsoleted in this release.

Related topics
For more information about supported items, see System requirements.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 18
Robotic Process Automation 2019.11

Get started
Robotic Process Automation (RPA) is an automation solution that allows you to automate rules-driven business
processes. Integrated with RPA Central and RPA Workflow Designer, you can complete actions using the automated
workflows that link steps to standardized RPA processes.
This section contains the following topics that provide you an overview of RPA

RPA architecture : Provides information of the functional architecture and how RPA works
RPA capabilities: Provides information on RPA capabilities and benefits of RPA
RPA personas: Provides information on user roles and functions that are part of RPA processes

Related topics
For instructions to install RPA, see Install.
To understand the RPA terminologies, see Glossary.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 19
Robotic Process Automation 2019.11

RPA architecture
RPA is composed of the following main components:

Authoring tool

Workflow Designer
Recorder
Runtime environment

RPA Central
RPA Bot
Queue
Self Service end-user interface

Self Service X

RPA Workflow Designer


RPA Workflow Designer is a web-based environment for authoring flows, which is available as a standalone product
that can be deployed either on a Windows or Linux server. Flows are authored in the CloudSlang language and run
in Robotic Process Automation (RPA) Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 20
Robotic Process Automation 2019.11

RPA Workflow Designer has the following features:

Web-based UI: RPA Workflow Designer provides web access, which minimizes time-to-value and allows for
simple management.
Hybrid authoring interface: Textual and graphical: RPA Workflow Designer provides a graphical interface on
top of the CloudSlang textual language. Every graphical change is immediately reflected in the underlying source
code. This source code can be preserved in a GIT repository and is visible from the RPA Workflow Designer UI.
Collaboration using Git: RPA Workflow Designer allows collaboration using Git. This means that different
authors (Central IT, line of business, operator, or application developer) can contribute to the authoring, while
they can each work using their preferred tool. This can be either the RPA Workflow Designer in which the
authoring is graphical, or via ATOM with the CloudSlang plugin which allows authoring the source files directly in
a textual manner.
Enhanced usability: RPA Workflow Designer and CloudSlang provide enhanced usability for authoring flows,
with features such as default errors, sensitive system properties, decisions, input bindings, and direct
deployment to RPA Central.

RPA Central
RPA Central is the run time environment of RPA. It is used for running flows, monitoring the various runs, and
generating reports. It has a web-based UI and a set of Application Programming Interfaces (API), which are
accessed by the administrators, end users, and integrators.
RPA Central has the following features:

Flow execution: RPA Central provides execution capabilities for the deployed flows. The execution can be
triggered from a web-based UI and from RESTful APIs. The execution capabilities include browsing the flow
library, launching an execution, and tracking that execution until its end.
Reporting: RPA Central provides reports about the various executions. These include running flows, paused
flows, completed flows, successful and failed flows, and so on. In addition, the rich set of RESTful APIs let you to
gather execution information and to compound a more advanced set of dashboard and reports.
RPA administration: RPA Central provides administrators with the means to manage RPA from system and
operational perspectives. It covers areas such as setting permissions, defining system components, configuring
LDAP, and more.
API: RPA Central provides a complete set of RESTful APIs for every capability. In fact, every capability of the web
UI is implemented on top of public RESTful API, enabling you to implement your own web UI and to combine RPA
capabilities within your web applications.
Engine : The engine works behind the scenes of RPA Central. This is the back end component that processes
and manages the entire flow execution. The engine manages the step execution, the persistence, and the
manual interaction with the users.
Scheduler: RPA Central includes an out-of-the-box scheduler. This enables the RPA administrator to define
various recurrence patterns for flow executions, to track, and to manage them.
Events: Through the execution of a flow, RPA Central exposes a REST API for the execution events. Clients can
poll that API and track the execution in a live manner.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 21
Robotic Process Automation 2019.11

Content

RPA provides a rich set of out-of-the-box operations and flows that enable you to author complex flows,
orchestrating various services. The content is delivered as a set of granular content packs that you can download,
deploy, and manage individually.
RPA provides a Java SDK, to enable developing custom content and operations.
By using the out of the box RPA content, you can build a rich set of custom content.
RPA Central enables:

Element automation – automation of either networks, servers, or storage, spanning tasks from provisioning and
change management to compliance enforcement and reporting
Runbook automation – automation of common and repeatable IT processes across all infrastructure tiers, IT
groups, and systems
Activity automation - automation of recorded business processes
Integrated automation of applications, servers, networks, storage, and common processes across the data center
Automation of the business service, with continuous control of each phase of the service life cycle, across the
data center and client end points, from automated operations to monitoring and ticketing
Reduced operational cost with automation of common tasks and processes
Improved service quality with accelerated incident resolution
Reduced risk and errors during change execution
Improved audit compliance through documentation generation and reporting
Integration with current IT environment to ensure minimal impact on procedures and tools

RPA Robot
The RPA Robot is the execution engine that processes the recorded activities systematically. This RPA steps are
pushed by Central to the queue, and are retrieved by the RPA Robot.
The result of the activity execution is reported back to RPA Central.

RPA Recorder
An RPA Recorder can be triggered from the Workflow Designer to record screen events in real-time, in order to
automate mundane business processes. The Activity Recorder controller bar is a free-flowing visual component
that can be moved across the current screen. After the recording session is over, the resulting RPA Activity can be
managed in RPA Workflow Designer.
The RPA Recorder has the following features:

Record settings: RPA Recorder provides the possibility to select a number of Add-ins for each recording
session, and to configure specific record and run settings for each of them. Standard Windows, SAP and Web
Add-ins are enabled by default.
Activity management: Activities can be parameterized by adding input and output values for a specific step.
Sensitive information can be hidden by marking inputs as sensitive. Steps can be edited and deleted.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 22
Robotic Process Automation 2019.11

RPA Self-Service X
The RPA Self-Service X is a web-based portal that has a catalog of RPA flows for reuse. It lets the users search for
process scenarios that have been published by authors for production use and execute them with just a few clicks
and inputs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 23
Robotic Process Automation 2019.11

RPA capabilities
Following are the capabilities that you can leverage using RPA:

A proven automation engine with an array of recording options


Failure management through recovery procedures
UI automation through object recognition of more than 40 technologies, including SAP, Web, WPF, .NET, and Java
Reusable business process description-based automation
Custom libraries for UI, API, and CLI business actions with predefined connectors for automation
Business and deep technical reports with easy-to-find root causes
Encoding methods designed to ensure the integrity of passwords
Rich out-of-the-box orchestration content for any use case, any technology, with more than 8,000 operations and
workflows
Extensible, open, vendor agnostic orchestrator to invoke from any place, integrate with anything using REST
APIs, command line API, or integration wizards
Secure, scalable, high-availability orchestration architecture

Benefits of RPA

For flow authors

Easy-to-use

RPA Workflow Designer offers an intuitive drag-and-wire capability to design, create, share, and customize flows.
The drag-and-wire visual interface enables rapid time-to-value. A visual flow debugger makes it easy to debug
flows.

CloudSlang content

The CloudSlang language is a YAML-based DSL for writing workflows. Using CloudSlang you can define a workflow
in a structured, human-readable format, that can be executed by the CloudSlang Orchestration engine embedded
in the RPA Workflow Designer and RPA Central.

Out-of-the-box content

RPA offers out-of-the-box content to manage operating systems, databases, app/web servers and networking
platforms. You can utilize out-of-the-box integrations with common Micro Focus and third-party systems
management tools, such as ticketing, monitoring and event consoles, virtualization, CMDB, and data center
automation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 24
Robotic Process Automation 2019.11

Standard source control integration

RPA Workflow Designer integrates with standard source control software. Even the out-of-the box solution is based
on common source control software (GIT). This means that the common capabilities of source control software are
available for Designer, so you can connect and use your organization's source control software. This also means
that the automation code can reside with other source code and follow the same life cycle (automation as code).

Multi-authors and multi-geographies

RPA Workflow Designer works offline and leverages standard source control software to share work between
multiple and distributed authors.

Fine-grained RPA content

RPA content is organized into a set of about 15 content packs. Each content pack provides flows and operations for
a functional domain. You have control over which content packs to download and which to deploy. You can use
only what you really need and ignore others.

Fine-grained customer content

In RPA Workflow Designer, your content can be separated into projects and managed separately for each author
and group. This gives you complete flexibility in defining the flows that are grouped together and the workspace of
each author. Different authors get a focused development environment with the flows that are relevant to them,
and do not affect other authors' flows.

Remote debugging

RPA Workflow Designer allows the author to connect to a live RPA Central environment and achieve full debugging
capabilities for that environment . This enables multiple authors to test their flows on a real environment and
control the testing from within the RPA Workflow Designer debugging environment. Flow debugging does not affect
the content that is deployed on RPA Central and does not require pre-deployment; however, it provides full logging
information in RPA Central and is protected by entitlement.

Administrators

UI experience

The RPA Central web UI has been designed to reflect common RPA use cases. Functionalities for the same roles are
grouped into the same areas. The permissions assigned to the logged-on user define the parts of the UI that the
user sees. By assigning these permissions to roles, the Administrator can formulate a dedicated UI experience for
each group of users.
Live scale out
In RPA, you can add a component while the system is live, without restarting the other components. You can scale

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 25
Robotic Process Automation 2019.11

out the Central nodes to achieve high availability and accelerate execution throughput. Simply install a new RPA
Central node and point it to the same database schema. You can add additional RAS instances via the worker
group mechanism, without the need for a load balancer. You can add a RAS instance while the system is live,
without needing to change flow.

High performance

RPA has a powerful execution mechanism, which enables high performance. RPA Central can be scaled to reach
high numbers of steps per second.

Highly parallelized runs

The RPA execution mechanism is based on an asynchronous execution mechanism, which enables large bursts of
executions. RPA Central supports launching 100 flows/sec and there is no limit to the number of parallel
executions.

Automatic database purging

RPA comes with built-in purging capabilities. You can schedule the execution of various purging flows to control the
RPA database size.

Automatic content distribution

In RPA, content binaries are automatically distributed to the appropriate RASes. When there is a change in their
version, the system automatically distributes them to the relevant RAS upon their first use.

Isolated content dependencies

RPA lets you use different versions of third-party libraries for every content pack. You can use your own required
third party versions and these are not affected by changing the out-of-the-box version.

Simple RAS management

RPA uses a group mechanism that separates the logical notion of the target RAS (which is what the author is aware
of) and the physical notion of the target RAS (which is what the op admin is aware of). For every environment, the
op admin can map between the logical and physical notions. Therefore, promotion of content between
environments does not require content changes, and the addition of a RAS doesn’t require going back to the
author.

Integrators

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 26
Robotic Process Automation 2019.11

Complete REST API

RPA provides a complete REST API for the entire set of Central functionalities. Every functionality that is exposed in
Central is implemented over a public REST API, enabling you to utilize the same set of APIs to integrate your
systems with RPA.

Live event stream

RPA exposes the execution events via a REST API. You can poll this API and react to execution events immediately

End users

Simplified execution gateway

RPA Central has a refined permission model, which lets you set end user permissions accurately, to allow end users
to use Central and be exposed just to the information they need, while limiting their ability to harm the system.
In addition, RPA Central provides interactive execution capabilities and UI-embedding capabilities, which enable
end users to interact with the system in a much more usable fashion.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 27
Robotic Process Automation 2019.11

RPA personas
Robotic Process Automation (RPA) personas represent the people responsible for performing particular tasks in the
RPA workflow.
The suggested persona in this topic is for a recommendation only, as the practices may vary across different
workplaces.
For example, while we have assigned the task of promoting all content packs to the Op Admin, some workplaces
may have an integrator, who might be responsible for promoting all content packs. Additionally, in other
workplaces, a flow author may also be an API developer
The following personas play a key role in the RPA processes.

Flow author

The Flow Author creates and debugs flows in RPA Workflow Designer. The Flow Author leverages the RPA out-of-
the-box content, the content developed by API Developers, and the utilities provided by SMEs.

Operational administrator (Op Admin)

The Op Admin is responsible for the day-to-day operations of RPA. This includes configuration, maintenance, run
and monitor flows, content pack promotion, and setting permissions for RPA users.
The Op Admin troubleshoots any failures in the production environment and either solves the problem or routes it
to the System Administrator, to Micro Focus Support, or to the Flow Author (depending on the issue).

System administrator (Sys Admin)

The System Administrator is responsible for the RPA hardware and software and its configurations. The Sys Admin
installs and patches RPA (RPA Central and RASes), and is responsible for the correct functioning of the application
from the system perspective, dealing with things such as CPU, memory, and OS environment.

End user

The End User triggers and monitors flows. The End User can access entitled RPA flows directly through RPA Central
or indirectly through the RPA Self-Service X interface or an embedded web UI in another application.

API developer

The Action Developer is an expert in code development, who creates actions that can be used in flows. The Action
Developer creates these actions mainly in Java and occasionally in .NET.

Subject matter expert (SME)

The SME may be an expert in DBA, Linux, or a specific application. The SME creates focused automations (through
scripts, executable files, and so on) for day-to-day operations in their area of expertise. These focused automations

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 28
Robotic Process Automation 2019.11

can be leveraged into the RPA flow authoring.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 29
Robotic Process Automation 2019.11

Glossary

Action
An action is a software component invoked by the RPA run time in order to achieve a certain task. An action can be
developed using the Java or Python programming language. Actions are packaged in the form of a .JAR files and
can be used as the basis for operations.
In addition to the actions developed by RPA, an action can be developed at your own site or provided by a third
party vendor aiming to extend the capabilities of RPA.

Activity
An activity is the outcome of a recording session. Activities contain a linked set of steps that can parametrized or
deleted. They can be linked together with other activities or with out of the box or operations in order to create
flows.

CloudSlang
CloudSlang (CloudSlang.io) is an open source environment for process automation, which provides a textual
language (YAML over Python), a lightweight engine (which can be embedded in a Java process or run via a
command line), and a content library. All the CloudSlang code, including documentation and content, are available
in GitHub CloudSlang repositories. Score is a general-purpose Java-based open-source orchestration engine, which
is process-based, embeddable, lightweight, scalable, and multilingual. The CloudSlang language is a YAML (version
1.2) based language for describing a workflow that can be run by Score engine. The supported file extensions are:
.sl, .sl.yaml and .sl.yml.

Configuration item
Configuration items are RPA objects (filters, scriptlets, system properties, and so on) that you can use to process
operation results, create reports, and facilitate the running of flows.

Content pack
A content pack is a file containing operations, flows, actions (Java-based, .Net, or CloudSlang based), localization
data, and configuration items. Content packs are deployed to the Central server and stored in the database. A
content pack can be created in RPA Workflow Designer by an author, or it can be provided by Micro Focus or a third
party.
Micro Focus provides a wide range of content packs with prepackaged flows, out-of-the-box integrations, and

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 30
Robotic Process Automation 2019.11

orchestration of multiple systems. The content packs are available from ITOM Marketplace.

Content permission
Content permission is permission to view or run individual flows or the flows in a particular folder. Users who have
been assigned a specified role will be able to access the flows according to the content permissions assigned to
their role.
For example, users with the Administrator role may be entitled to view and run all the flows in the system, while
users with the User role may be entitled to run certain flows, and have view permission for others.

Context
The context is a container that holds various values that can be exchanged with a step at various points. There are
two kinds of context:

Local context exists for the duration of the step.


Global context exists for the duration of the flow.
You can pass values to and from the local or global context.

Flow
A flow is the composition of steps and transitions together forming a set of actions that are linked by decision-
making logic in order to automate tasks. For example, health checks, troubleshooting, or any other repetitive IT
support tasks. Flows are created in RPA Workflow Designer and then run in RPA Central.

Flow run
A flow run is a single execution of a flow in Central. Flow runs collect data, enabling you to analyze the
performance of your IT system.

Group alias
Group aliases let you separate between assigning an operation to a worker during authoring time and in the run
time environment. In RPA Workflow Designer, the author can define an operation to execute on a group alias rather
than a worker group. In Central, the Op Admin maps the group alias to the actual worker group.

Hard copied operation


In a hard copy of an operation, the copy is directly linked to the action plugin in the same way that the original
operation was. When the action plugin jar file is updated—for example if the name of the JAR or the class is

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 31
Robotic Process Automation 2019.11

changed—this needs to be updated in all the hard copied operations.

Input
Inputs give the operation the data that it needs to act upon. For example, an operation to check a web page needs
to know which page to check and what text to look for.
Inputs can be:

Set to a specific value


Obtained from information gathered by another step
Entered by the person running the flow, at the start of the flow

Operation
An operation holds the inputs, outputs, responses, and other properties that are required to perform a certain
action. Operations are available for the flow author to use as steps inside a flow. A rich set of out-of-the-box
operations is available with RPA Workflow Designer.

Output
Outputs are data produced by operations—for example, success code, output string, error string, or failure
message.

Output fields
In a subflow (a flow within a flow), output fields are used to store a step's results so that the result data is
accessible to operations, transitions, and prompts in the parent flow.

Primary output
Primary output is the output used to populate the step's primary result. The primary output supplies a value to an
input whose assignment is Previous Step’s Result.

Raw result
The raw result is all of the operation’s return code, data output, and error strings.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 32
Robotic Process Automation 2019.11

Response
Responses are the possible outcomes of an operation. For example, a Read Web Page operation may have three
possible responses:

The web page can’t be found (failure)


The page is there and the desired text is present (success)
The page is there but the text isn’t present (partial success - needs another action)

Result
Results are output produced by a step in a flow. For each step, you decide which of the operation's outputs you
want to retain. Outputs are not automatically retained in the flow. If they were, this could affect performance, by
slowing down the flow with unnecessary data.

Robotic Process Automation Central


RPA Central is the runtime environment of RPA. It is used for running flows, monitoring the various runs, and
generating reports.

Robotic Process Automation Content


RPA contains an out-of-box content library with over 4,000 flows and operations, accelerator packs, and
integrations.

Robotic Process Automation Designer project


An RPA Designer project is a directory in RPA Workflow Designer, containing the flows and operations that a flow
author is working on. In order to create a flow, a flow author must be working within a project.
Every project contains two folders:

Library - holds all the flows and operations in that project.


Configuration - holds other RPA objects (filters, scriptlets, system properties, and so on) that you can use to
process operation results, create reports, and facilitate the running of flows
When flow authors complete a project, they package it into a content pack for promotion to the Central server.

Robotic Process Automation RAS


RAS is a remote action server, containing a worker and a remote protocol for connecting with Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 33
Robotic Process Automation 2019.11

Robotic Process Automation Recorder


Recording tool that can be configured with RPA Workflow Designer. It can be invoked from RPA Workflow Designer
to record and play all the actions of the user.

Robotic Process Automation Self Service X


A web-based portal that has a catalog of RPA flows for reuse. It lets the users to search for scenarios that are
published by authors for production use.

Robotic Process Automation Robot


Execution engine that processes the recorded activities systematically and presents the data in a sequential
manner.

Robotic Process Automation Workflow Designer


RPA Workflow Designer is a web-based authoring environment for creating and modifying flows using CloudSlang
language.

Role
A role is a collection of permissions. For example, the Flow Administrator role may be assigned the View
Schedules permission and the Manage Schedules permission.

Role permission
A permission is a predefined ability to perform a task. Central includes a set of permissions that can be assigned to
roles. For example, the Schedule permission grants the ability to view and create flow run schedules.

Scriptlet
Scriptlets (written in JavaScript) are optional parts of an operation that you can use to manipulate data from either
the operation’s inputs or results for use in other parts of the operation or flow.

Soft copied operation


When you copy an operation that is linked to an action plugin jar file, the copied operation continues to reference
the original operation. If the action plugin jar file is upgraded—for example if the name of the JAR or the class is

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 34
Robotic Process Automation 2019.11

changed— when you update the original operation to call the new version, the copied operations are all updated
automatically. This is known as a soft copy.

Step
Steps are the building blocks of a flow. A flow author creates a step by dragging an operation onto the authoring
pane. A step is an instance of the operation, and it inherits the inputs, flow variables, and other properties of the
operation. A step can be modified without affecting the original operation.

Subflow
A subflow is a flow that is used as a step within another flow. The flow that contains the subflow step is known as
the parent flow. It is possible (and recommended) to debug the parent flow and subflow separately in RPA
Workflow Designer.

Transition
A transition is the connection from an operation's response to one of the possible next steps.

User
A user is an object associated with a person (or application identity) representing the person and defining their
authorization. Roles are assigned to users, to define the actions they have permission to perform in Central. For
example, the user Joe Smith may be assigned the Administrator role. It is possible to configure different kinds of
users:

LDAP users log on to Central using their LDAP user name and password.
Internal users log on to Central using the user name and password that was set up in Central.
IDM users log on to Central using their SiteMinder logon details.
LWSSO users can enter the Central application directly, bypassing the Central logon screen, if they have logged
onto another product web client that has LWSSO enabled.
When an internal user and an LDAP user with the same role are logged in, there is no difference between their
permissions.

Note It is recommended to use LDAP users rather than internal users, because
LDAP users are secured according to policies implemented by the LDAP provider.

Variable
Variables make data available in a flow run. There are two kinds of variable:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 35
Robotic Process Automation 2019.11

Global variables are name/value pairs that come from system properties and selection lists, and are provided to
a flow run at its start. You can also create a global variable by using the Set Global Flow Variable operations
from the Base content pack.
Flow variables are available only for the flow within which they are defined. You can assign a value to a flow
variable from:

A step's result - for example, a step with an operation to count hits can be set to store the result in a flow
variable
An input value - for example, a step where a user needs to enter an IP address can be set to store the address as
a flow variable
A scriptlet - for example, a scriptlet that evaluates data that is returned from a step can be set to store the data
in a flow variable

Workers
Workers are the software components that are responsible for executing flows. A worker connects to Central to
obtain tasks (flow execution messages) to process.

Worker group
A worker group is a logical collection of workers. A worker may belong to more than one group simultaneously. You
can define a worker group in Central.

YAML
YAML is a human-friendly data-serialization standard for all programming languages.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 36
Robotic Process Automation 2019.11

Install
This section provides the information required to install the following Robotic Process Automation (RPA)
components. All components of RPA can be installed using the installer or through silent installation.

Components Description Source

RPA Central Download and install. Provided by Micro Focus

RPA Workflow Designer Download and install. Provided by Micro Focus

RPA Self-Service X Download and install. Provided by Micro Focus

RPA Recorder Download and install. You must configure the port Provided by Micro Focus
details to connect with RPA Workflow Designer.

RPA Robot Download and install. You must configure the port Provided by Micro Focus
details to connect with RabbitMQ service.

RabbitMQ Download and Install RabbitMQ 3.7.11 and its Third-party software
dependencies such as Erlang.

AutoPass License Server Download and install version 10.9.2 or later from Available on Micro Focus
the Marketplace. Marketplace

RPA & OO Content Packs Download and install the content from the Available on Micro Focus
Marketplace. Marketplace

Installation prerequisites
Before you install RPA:

Download and install AutoPass License Server (APLS). RPA uses AutoPass License Server to store and
manage concurrent licenses.
After your RPA trial license expires, you will need to download and install APLS version 10.9.2 or later from
the ITOM Marketplace.
If you already have APLS installed for managing other Micro Focus product licenses, make sure you are using
version 10.9.2 or later.
To install and set up your AutoPass License server, see Install AutoPass License Server and Administer AutoPass
License Server in the dedicated AutoPass License Server documentation.
Check system requirements. Check that your system meets all the hardware and software requirements
detailed in the Support matrix.
Check permission requirements. Ensure that you have Administrator privileges to avoid UAC (user access
control) errors. If you are not sure about your UAC settings, right-click on the installer and choose to Run it as an
Administrator.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 37
Robotic Process Automation 2019.11

Consider install location restrictions. If you are installing RPA on a Chinese or Japanese Windows OS, make
sure that the installation path does not contain special characters from other languages, like accents or
diacritics. For any other language Windows OS, make sure the installation path does not contain Chinese or
Japanese characters.
For Linux OS, the directory names in the installation path cannot contain any special characters at all.
In addition, the path for the installation folder of RPA Recorder and RPA Robot should not contain hyphens (-).

Related topics
Deployment architecture

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 38
Robotic Process Automation 2019.11

Plan
This section provides the information required to plan the installation of RPA.

Topic Description

Deployment architecture Collect and evaluate data from your current environment to determine the
following:
• RPA deployment option that suits your environment the best
• Size and complexity of the the RPA deployment

System requirements Based on your installation plan, review the system requirements for the installation
of the following components of RPA:
• RPA Central
• RPA RAS
• RPA Workflow Designer
• RPA Self-Service X
• RPA Recorder
• RPA Robot
• Unified Functional Testing (UFT)

Next step
Deployment architecture

Related topics
To determine and create a deployment plan that suites your environment, see Deployment architecture.
For more information on the supported hardware, operating systems, and other components, see System
requirements.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 39
Robotic Process Automation 2019.11

Deployment architecture
RPA deployment consists of the following components:

Authoring tool:

RPA Workflow Designer


RPA Recorder
Runtime environment

RPA Central
RPA Bot
RabbitMQ
Self Service end-user interface

RPA Self-Service X
Database
The following graphic illustrates a basic deployment architecture consisting of all the components.

RPA can be deployed in two ways:

a. Simple deployment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 40
Robotic Process Automation 2019.11

b. Cluster deployment

Simple deployment
A simple deployment of RPA consists of a single RPA Central instance. The following diagram illustrates how
you can set up a simple deployment environment.

Cluster deployment
In a cluster deployment, RPA Central is deployed as a cluster of multiple RPA Central nodes.
To prevent the RPA Central being the single point of failure, it is recommended to have a high-availability
deployment. You can set a cluster of multiple RPA Central nodes, the simplest of which contains two RPA
Central nodes connected to the same database schema. As shown in the image below, a load balancer can
be set before the Central cluster to expose a single URL to the end users. Exposing a single URL can also be
done with DNS load balancing. The load balancer/reverse proxy should redirect to the RPA Centrals that use
ports 8443 and 8080, if the default values are chosen during installation.

Configure a cluster

Clustering provides high availability and scalability to enhance throughput. In a simple cluster, two
installations of RPA Centrals to the same database schema.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 41
Robotic Process Automation 2019.11

To create a cluster, you install one RPA Central, and then add another node pointing to the same database
schema, and this creates a cluster.
You can set up the load balancer/reverse proxy to expose a single URL to the clients of the system; however,
the load balancer/reverse proxy is optional and not imperative to the cluster. Exposing a single URL can also
be done with DNS load balancing instead.
For information about how to install a load balancer, see the documentation provided by your load balancer
vendor.

Scalability

RPA offers horizontal scaling for increasing execution throughput.


You can add more Central instances to the Robotic Process Automation cluster. Robotic Process Automation
supports live scalability, which means that no downtime is required when adding a Central node. Simply
install an additional Central instance and point it to the existing database schema.

Load balancer requirements

It is recommended that you configure the load balancer with two separate virtual IPs for the user interface
and for RASes:

i. For the RPA user interface and customer portals, the virtual IP should use a sticky session policy. The

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 42
Robotic Process Automation 2019.11

sticky session ensures that all subsequent requests will be sent to the server that handled the first
login request. This means that users will only need to log in to the Robotic Process Automation
interface once.

ii. For RASes, the virtual IP should use a round robin policy, to distribute the load across the different
servers.

If you have a different configuration that satisfies these requirements, it is okay to use it. For example, if you
have a load balancer that supports JSESSION, you can use the JSESSIONID parameter to set up a single
virtual IP with a sticky session policy for all sources. Since RAS requests are stateless (no JSESSIONID), this
will provide a round robin policy for RASes.
RPA Central uses the following URL to check which server is live:
HTTP://<IP>:<PORT>/oo/hello.html

Load balancer security

In a hardened high availability environment, the load balancer should be configured for TLS.
Communication between the RPA interface and the load balancer can use HTTPS. It is recommended that
you install the TLS certificate on the load balancer so that this is the termination point for the encryption.
Beyond the load balancer, communication will continue in HTTP, at a faster rate.

Adding a Remote Action Server (RAS)

An RAS instance is an optional RPA component. You can include an RAS instance in the following scenarios:

i. When RPA needs to run flows in a network segment that is not reachable from the RPA Central nodes.
In such case, you can install an RAS instance in the target network segment and it will pull the
required flows from the Central and run them locally.

ii. When the executed flow requires specific binaries on the local machine. In this scenario, there is no
need to install the binaries on each RPA node. It is enough to install them on a host where a RAS is
installed, and configure the flows (or specific steps) to run on this RAS. This can be achieved by
leveraging the worker group functionality.

You can attach RAS instances to RPA Central or a cluster of RPA Central nodes. The image below shows how
RAS3 and RAS4 communicate with the Central cluster. Note that RAS4 is located behind a firewall.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 43
Robotic Process Automation 2019.11

Configuring the RAS connectivity direction

In Robotic Process Automation, you can configure RASes so that some initiate the connection to Central while
others wait for Central to initiate the connection.
For example, if Central and a RAS are installed in different networks, with Central deployed on a more
secured network, and your security rules do not allow connecting from the less secured network to the more
secured one, you can have Central initiate the connection to the RAS.
During the installation of a RAS, you must choose between two options:

i. Standard RAS - RAS initiates communication to Central - This is the simplest option and is
recommended if your security rules permit it.

ii. Reverse RAS - Central initiates communication to RAS - Choose this option, if RPA Central is
installed in a different, more secured network, and your security rules do not allow connecting from
the less secured network to the more secured one.

You will need to configure the RAS to accept connection from RPA Central, and configure RPA Central to
register the RAS (in the System Configuration>Topology>Workers tab). When the RAS starts up, it will
be idle, waiting for RPA Central to initiate connection.

RAS high availability

When an RAS is deployed in a network segment to manage the machines in that segment, you do not have
to make do with a single instance. To achieve high availability, you can deploy an additional RAS instance in
the same segment. Make sure to associate it with the same worker group. This is illustrated in the image
below.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 44
Robotic Process Automation 2019.11

There is no need for an additional load balancer between the RPA RAS cluster and RPA Central. Because both
RAS 4 and RAS 5 belong to the same worker group, they share the load of executing flows or steps that are
designated for that worker group and provide high availability.

RabbitMQ communication
RPA Central, RPA Robot, and RAS communicate with the RabbitMQ broker via passing messages conforming
to the AMQP 0-9-1 messaging protocol; these components act as both consumers and producers with respect
to the RabbitMQ broker.
It is recommended that the communication between Central, Robot, RAS and the RabbitMQ broker is
performed over TLS 1.2 protocol.
For more details on how to achieve this, see the RabbitMQ broker hardening section.

Adding a Robot (UI Worker)


To achieve high availability, it is recommended to have at least two Robot instances connected to the
RabbitMQ broker.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 45
Robotic Process Automation 2019.11

Considering your UI step execution load, you might need to scale out the execution of UI steps, by adding
additional Robot instances to your deployment.
After a Robot instances is started and is acknowledged by the Central, this Robot becomes eligible to
execute UI steps.
The execution load is distributed among all available Robot instances.

Configure the load balancer and RPA Central servers


for TLS offloading
If a load balancer is used to access the RPA Central servers, it is recommended to configure the load
balancer for TLS offloading.

i. Edit the Tomcat server.xml file, to include the following, for example:

<Engine name="Catalina" defaultHost= "localhost" >

. . .

<Valve className="org.apache.catalina.valves.RemoteIpValve"protocolHeader="X-Forwarded-
Proto" />

. . .

</Engine>

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 46
Robotic Process Automation 2019.11

Configure the load balancer to add a new header to all the clients’ requests.
The header name is configurable and should match the Tomcat configuration specified above. In this
example, the name is "X-Forwarded-Proto".
In the F5 load balancer, the configuration would look like this:

when HTTP_REQUEST {

HTTP::header insert "X-Forwarded-Proto" "https";

Related topics
For more information on RPA architecture, see RPA Architecture

For information related to securing and hardening RPA, see Set up security and hardening for RPA
Workflow Designer

For information about how to configure TLS, see Configure the TLS protocol

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 47
Robotic Process Automation 2019.11

System requirements
This section provides information about the hardware and software requirements for Robotic Process Automation
(RPA) components.

RPA Central and RPA RAS

Operating systems

The following operating systems are supported:

Operating system Architecture type Versions

Microsoft Windows Server x86_x64 2012, 2012 R2, 2016

Oracle Linux x86_x64 6.6

SUSE Enterprise Linux x86_x64 12.x

Red Hat Enterprise Linux x86_x64 6.x, 7.x

Note You might encounter performance issue when using RPA on Windows 2016.

File compression program

Compression
program name Description

bzip2 This open source compression program is required for installing RPA Central on
Red Hat systems. If it does not already exist on your Linux system, you can
download it from http://www.bzip.org/downloads.

Databases

Database Versions

Oracle 12cR1 RAC, 12c R1 (regular, non-CDB), 12c R2 (regular and CDB), 18c

PostgreSQL 9.4x, 9.5x, 9.6, 10

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 48
Robotic Process Automation 2019.11

Database Versions

Microsoft SQL Server 2012**, 2014, 2016, 2017

** All service packs are supported.

Browser support

Browser Versions

Microsoft Internet Explorer 10.x, 11.x

Google Chrome** 49.x and higher

Mozilla Firefox** 53.x and higher

Microsoft Edge 42.x and higher

** Future versions of Firefox and Chrome are considered supported, subject to the browser's backward-
compatibility.

Software framework

Software framework Version

.NET (Dot Net) Framework Microsoft .NET Framework 4.5 or later, full installation. This is also required for RPA
RAS installations.

Software

Software Version

RabbitMQ 3.7.x

RPA Workflow Designer

Operating systems

The following operating systems are supported:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 49
Robotic Process Automation 2019.11

Operating system Architecture type Versions

Microsoft Windows Server x86_x64 2012, 2012 R2, 2016

Oracle Linux x86_x64 6.6

SUSE Enterprise Linux x86_x64 12.x

Red Hat Enterprise Linux x86_x64 6.x, 7.x*

* You can install RPA Workflow Designer in a default installation of Linux. There is no need for special packages.

Databases

Database Versions

Oracle 12cR1 RAC, 12c R1 (regular, non-CDB), 12c R2 (regular and CDB), 18c

PostgreSQL 9.4x, 9.5x, 9.6, 10

Microsoft SQL Server 2012**, 2014, 2016, 2017

** All service packs are supported.

Browser support

Browser Versions

Microsoft Internet Explorer 11.x and higher

Google Chrome* 49.x and higher

Mozilla Firefox* 53.x and higher

* Disclaimer: Future versions of Firefox and Chrome are considered supported, subject to the browser's backward-
compatibility.
The recommended screen resolution for the browser is 1280 x 1024 or 1920 x 1080. Some browsers default zoom
level is 125%. If some of the RPA Workflow Designer UI does not fit into your browser window, reduce the zoom
level to 100%.

RPA Self-Service X

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 50
Robotic Process Automation 2019.11

Operating systems

The following operating systems are supported:

Operating system Architecture type Versions

Microsoft Windows Server x86_x64 2012, 2012 R2, 2016

Oracle Linux x86_x64 6.6

SUSE Enterprise Linux x86_x64 12.x

Red Hat Enterprise Linux x86_x64 6.x, 7.x

Databases

Database Versions

Oracle 12cR1 RAC, 12c R1 (regular, non-CDB), 12c R2 (regular and CDB), 18c

PostgreSQL 9.4x, 9.5x, 9.6, 10

Microsoft SQL Server 2012**, 2014, 2016, 2017

** All service packs are supported.

Browser support

Browser Versions

Microsoft Internet Explorer 11.x and higher

Google Chrome 53.x and higher

Mozilla Firefox 53.x and higher

Microsoft Edge 42.x and higher

RPA Recorder

Operating systems

The following operating systems are supported:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 51
Robotic Process Automation 2019.11

Operating system Architecture type Versions

Microsoft Windows Server x86_x64 2012, 2012 R2, 2016

Microsoft Windows x86_x64 7 SP1, 8.1, 10

RPA Robot

Operating systems

The following operating systems are supported:

Operating system Architecture type Versions

Microsoft Windows Server x86_x64 2012, 2012 R2, 2016

Microsoft Windows x86_x64 7 SP1, 8.1, 10

Hardware requirements
The hardware requirements described here are the minimal supported configuration.
Many customers may require more powerful hardware, depending on their load and usage of the system. In some
cases, scaling out (adding nodes) is preferable to scaling up (stronger hardware).

RPA Central servers

The minimum hard-drive space requirements differ depending on whether you install RPA Central and RPA RAS on
the same machine.
These requirements are for on-premise installations where the key components (RPA Central servers and RPA RAS)
are installed at the customer’s site.

Component RPA Central server

CPU 3 Gigahertz (GHz) for single-processor systems or 2 GHz for multi-processor systems
Minimum: 1 CPU core
Recommended: 4 CPU cores

Memory (RAM) Minimum: 2 GB


Recommended: 4 GB

Hard-drive space 4 GB

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 52
Robotic Process Automation 2019.11

Database servers

The minimum hard-drive space requirements differ depending on whether you install RPA Central and the database
on the same machine.
These requirements are for on-premise installations where the key components (RPA Central servers and RPA RAS)
are installed at the customer’s site.

Component Database server

CPU 3 Gigahertz (GHz) for single-processor systems or 2 GHz for multi-processor systems
According to the database vendor’s recommendations and requirements, but no less than 2
CPU cores

Memory (RAM) As specified by the vendor, but no less than 4 GB

Hard-drive space Database server:


-
Centralized database:

50 GB for Robotic Process Automation data - out of which a few GB are for the Robotic
Process Automation installation and content pack deployment, and the rest is used for
Robotic Process Automation’s operational data.
For extensive usage, it is recommended to allocate 100 GB or more, depending on your
data retention policy.

Dedicated database server:

80 GB hard drive
For extensive usage, it is recommended to allocate a 140 GB hard-drive or bigger,
depending on your data retention policy.

For off-premise installations, where the key components are installed on a cloud-based virtualized machine, the
hardware requirements are:

RPA Central/RPA RAS: For Cloud systems, an extra small machine


Database: According to the database vendor’s recommendations and requirements, but no less than a small
machine.

RPA Central web client

Web client machines for RPA Central must meet the minimum hardware requirements for their web browser.

RPA RAS installations

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 53
Robotic Process Automation 2019.11

Component Requirement (minimum)

CPU 2 GHz for single- or multi-processor systems


Minimum: 1 CPU core
Recommended: 4 CPU cores

Memory (RAM) 1 GB

Hard-drive space 2 GB (this includes room for the flows and operations that are included in the installation)

RPA Workflow Designer, RPA Self-Service X and Database Servers

The hardware requirements described here are the minimal supported configuration.
On-premise installations
These requirements are for on-premise installations where the key components are installed at the customer’s site.

Component Requirement per server (minimum)

CPU 3 Gigahertz (GHz) for single-processor systems or 2 GHz for multi-processor systems.

Database server:
• According to the database vendor’s recommendations and requirements, but no less than
2'CPU cores'

RPA Workflow Designer server:


• Minimum: 1'CPU core'
• Recommended: 4'CPU cores'

Memory (RAM) Database server:


• As specified by the vendor, but no less than 4 GB

RPA Workflow Designer server:


• Minimum: 2 GB
• Recommended: 4 GB

Hard-drive space Database server:


Centralized database:
• 20 GB for RPA Workflow Designer data - out of which a few GB are for the RPA
Workflow Designer installation and content pack deployment, and the rest is used for RPA
Workflow Designer’s operational data.

Dedicated database server:


• 50 GB hard drive
For extensive usage, it is recommended to allocate a 100 GB hard-drive or bigger,
depending on your data retention policy.

RPA Workflow Designer server:


• 2 GB

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 54
Robotic Process Automation 2019.11

RPA Recorder and RPA Robot

Component Minimum Recommended

CPU Dual-core CPUs or better, for example, AMD Phenon II X2 IntelR CoreTM i3 Processor or
and Intel Core Duo Phenom II X3

Memory 2 GB (An additional 512 MB of RAM is required when 4 GB or more of RAM


using a virtual machine)

Resolution 1024 X 768 or higher

Free HD space 2 GB of free disk space for application files and folders

Ports

For each product, one or two ports must be available in order to configure them. Each product has default values
for the required ports (HTTP or HTTPS) , however, you can specify different ones during installation or change them
after the installation.

Component HTTP HTTPS

RPA Central 8080 8443

RPA Workflow Designer 8081 8445

RPA Self-Service X 8446

RPA Recorder 5433

Language support

Supported RPA Central RPA Workflow RPA Self- RPA RPA


languages and RPA RAS Designer Service X Recorder Robot

English ✔ ✔ ✔ ✔ ✔

Related topics
For information related to virtual systems and cloud deployments, see Virtual systems and cloud deployments.
For information about performance and sizing information, see Performance and sizing information.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 55
Robotic Process Automation 2019.11

Virtual systems and cloud deployments

Virtual systems
Installation of the Robotic Process Automation (RPA) components on guest systems hosted by the following
hypervisors is supported, as long as the guest systems meet the requirements described in this System
Requirements document:

VMware ESX Server, version 3.x or later.


Microsoft Hyper-V (for all supported Windows versions).

Cloud deployments
RPA can be installed on cloud computer units.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 56
Robotic Process Automation 2019.11

Performance and sizing information


Robotic Process Automation (RPA) is a generic platform that can be installed in a variety of environments and used
in various use cases. Therefore, the platform performance and experience may be influenced by many parameters.
This section aims to help the administrator to understand the different parameters that can impact system
performance and to provide a set of tools for tuning the system in cases of less than optimal performance.

Note The appropriate tuning depends on how you use the system. If you change
the parameters described in this document, you will need to monitor your system
performance and re-tune if required.

Minimum requirements
The minimal requirements for Robotic Process Automation are described in the Support matrix section.
This topic aims to help the administrator in the process of tuning the system.
If you face a performance issue, you need to identify the cause or causes. This section lists the different
parameters that might be impacting your system's performance.
It is recommended to read the list below, and to consider whether the various parameters apply to your use case.
If so, click each relevant link to see more information about how to tune that parameter.
Each bullet should explain how this parameter affects the system (for example, large #of triggers per day, can
exhaust the available resources (threads) and therefore the solution is increasing the # of threads. Then, put a link
to how-to increase the number of threads. In addition, defining the Max # of threads should be defined after I jump
to the relevant tool
Performance may be affected by the following parameters:

Load - A heavy load can exhaust the available resources (threads). This may be caused by running flows with a
large number of parallel or multi-instance lanes, or by triggering a large number of flows simultaneously.

In this case, the solution is to increase the number of threads.

Memory consumption - Your performance may be low because the JVM heap size is not appropriate and
garbage collection is slowing down your system.

It is recommended to analyze the time and frequency of garbage collection. You may need to adjust the initial
and maximum size of the Central/RAS heap so that it is in accordance with your memory needs.

We recommend configuring RPA Central to 4GB and RAS to 2GB.

Database size - Robotic Process Automation is database-intensive, and this may cause your database to
become very large, and this will slow down performance.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 57
Robotic Process Automation 2019.11

To keep your database is running efficiently, you need to purge it regularly to keep the size down.

If you have other issues with your database, contact your database administrator.

Run Log persistence level - Your database may also be getting too large because of the run history that is
persisted to the Run Log.

You can reduce the information that is saved by adjusting the persistence level in RPA Central.

Number of database connections - Your system may be running slowly because either the RPA Central server
or the database server is limiting the number of concurrent connections.

For more information about how to check whether the number of database connections needs tuning, and how to
adjust this, see "Adjust the number of database connections" topic.

Number of Centrals - If you have tried all the methods listed above and are still having performance issues,
you may need to scale out, by installing additional RPA Central servers or by adding more workers. Our
recommendation is to add Central servers.

Number of Robots - If you have performance issues due to RPA flows taking too long to complete, it might be
because a Robot can only execute one activity at a time. In order to run multiple activities in parallel, you can
install additional RPA Robots.

Increase number of worker threads


By default, each Robotic Process Automation node has 20 worker threads. If your flows have a large number of
parallel or multi-instance lanes, or if you trigger a large number of flows simultaneously, we recommend increasing
this number. For example, you might increase this number for up to 100 threads per worker (RPA RAS or RPA
Central).

Note The number of threads that can be configured is dependent on the amount
of memory available to the RPA Central or worker.

Increasing the number of worker threads in RPA Central or RPA RAS

1. Open the central-wrapper.conf or ras-wrapper.conf file (located under


<installation_folder>/central/conf and <installation folder>/ras/conf, respectively) in a text editor.

2. To configure the number of execution threads, edit the property

-Dcloudslang.worker.numberOfExecutionThreads

The default value is 20.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 58
Robotic Process Automation 2019.11

3. To configure the size of the incoming buffer, edit the property

-Dcloudslang.worker.inBufferCapacity

The default value is 200.

4. Restart the configured node. These are newly-supported properties. If this is the first time that you have
configured them, you will need to add them manually as follows:

wrapper.java.additional.<next available number>=

-Dcloudslang.worker.numberOfExecutionThreads=<new value>

wrapper.java.additional.<next available number>=

-Dcloudslang.worker.inBufferCapacity=<new value>

Increase the JVM heap size


You can adjust the initial and maximum size of the RPA Central/RPA RAS heap, so that it is in accordance with your
memory needs and garbage collection is faster.
The recommended initial size is 1GB for both RPA Central and RPA RAS.
The recommended maximum size is 4GB for RPA Central and 2GB for RPA RAS.

1. Open the central-wrapper.conf and ras-wrapper.conf files (located under


<installation_folder>/<central or ras>/conf/).

2. Edit the following properties:

wrapper.java.initmemory=<value in MB>

wrapper.java.maxmemory=<value in MB>

3. Restart the configured node.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 59
Robotic Process Automation 2019.11

Purge the database


By default, Robotic Process Automation saves all flow and step execution data in the database, in order to support
debugging of flow runs. As a result, the database size will grow according to system throughput and flow
complexity.
It is highly recommended to purge the database regularly, in order to control its size and enhance performance.
You can monitor the size of the database in RPA Central, under the Database Health tab in the System
Configuration workspace.

Purging flows

The purging flows are available in the Micro Focus Solutions content pack (available on ITOM Marketplace). It is
recommended to deploy this content pack, configure the flows with your required settings, and then schedule
them in RPA Central.
The following purging flows are located under Library > Integrations > Micro Focus > Operations
Orchestration > 10.x > Database:

Purge Execution Summary - Purges run data.

It is recommended to schedule this flow as soon as you start to run flows.

Purge Audit Records - Purges old auditing records if auditing is enabled.

If you have enabled security auditing, schedule this flow.

Purge Rerun Info - Purges rerun data.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 60
Robotic Process Automation 2019.11

If you have defined rerun points in your flows, schedule this flow.

For more information about these purging flows, see the flow descriptions in RPA Central.

Purging APIs

Purging via the RPA Central UI


As an alternative to using the purging flows, you can perform purging functions via API.
The following APIs are available:

DELETE /audit/records: Purges old auditing records if auditing is enabled.


DELETE /executions: Purges run data such as bound inputs, outputs and step log events. This run data needs
to be purged regularly, because running large numbers of runs can cause the database to reach the maximum
table size.

Note This only affects the data of completed runs.

DELETE/executions/rerun: Purges the rerun data from the database.


DELETE /steps-log: Purges step data according to time and number of executions to purge.
By using the purge APIs, you can purge the data manually as required, or by scheduling recurrent flows that
incorporate these APIs.
You can set up recurring purging jobs in the RPA Central UI.
The following purging jobs are available in RPA Central under System Configuration workspace > Persistence
Control > Purging:

Purge Run Details


Purge Run Details from RPA Workflow Designer Remote Debugger
Purge Audit Details
You can enable these jobs, and configure the recurrence pattern (daily, weekly, every x days, and so on) and the
retention (for example, all events older than 90 days).
Purging jobs are available only to users with "Manage System Settings" and "Manage data cleanup" permissions.

Adjust the number of database connections


Your system may be performing badly because the minimum and maximum database connection pool size is not
set correctly.
Analyze whether you need to adjust the database connections
To identify if the number of database connections is an issue in your environment:

1. Open the database.properties file (located under <installation_folder>/central/conf/), and register the
value of the db.pool.minPoolSize and db.pool.mxPoolSize properties.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 61
Robotic Process Automation 2019.11

The RPA Central server aims to keep the number of database connections at the defined minimum value. If
necessary the RPA Central server will add connections but will not exceed the maximal value.

2. Review your database server configuration and check the current limitation on the number of database
connections.

Note that in some cases, this limitation is global (the sum of all connections to all database schemas) and in
other cases, resource-usage profiles may apply. Consult your DBA, in that case.

3. Connect to the database server and track the number of connections from this RPA Central server to the
database throughout busy hours. It is important to count only the connections that originated from this
specific Central server.

If you are using an Robotic Process Automation cluster, you must configure the database server to allow
connections from a number of RPA Central servers, as well as connections from other clients and consumers.
Change the number of database connections
In order to change the maximum number of database connections on the RPA Central server’s end:

1. Open the database.properties file (located under <installation_folder>/central/conf/).

2. Edit the db.pool.maxPoolSize property.

3. Restart the configured node.

4. Repeat for every RPA Central node.

Configure the amount of data written to the database


In RPA Central, a very detailed run history is persisted. This makes it easy to troubleshoot, as all the information is
available in the Run Log. However, if your database size has increased to the limit, you may need to reduce the
information that is saved to the Run Log.
Two persistence levels are available, and each one saves a different set of data:

Standard - large input/output values are truncated at approximately 4,000 bytes when logged
Extended - large input/output values are not truncated when logged

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 62
Robotic Process Automation 2019.11

Under the Database Health tab in the System Configuration workspace, select the default log level. This will be
applied, by default, to all flows that are run.
You can override this default for individual flows in the flow library, or when triggering or scheduling a flow run.
You can also set the log level in API runs (REST/SOAP).

Scaling out
Scalability is the ability of the Robotic Process Automation system to be enlarged to accommodate a growing
amount of work, so that it increases its total throughput under an increased load.

Adding more RPA Central servers

One way to scale out is to install additional RPA Central servers in an Robotic Process Automation cluster.
Clustering provides high availability and scalability to enhance throughput. To create a cluster, you run the
Installation wizard to create the first RPA Central. Then, you run it again on the other machine to create the next
node and, during this second installation, make it point to the same database schema.

Adding more workers

Another method of scaling out is to add more workers to the existing RPA Central server.
Workers are responsible for executing flows. An external worker connects to RPA Central to obtain tasks (flow
execution messages) to process.
To create a new worker, install a new RPA RAS.

Adding more RPA Robots

Another method of scaling out is to increase the number of Robots in order to be able to run multiple activities at
the same time.
Robots are responsible for executing activities. Robots connect to an execution queue, which is populated by the
RPA Central and RPA RAS,.
In order to achieve this, install a new RPA Robot.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 63
Robotic Process Automation 2019.11

Related topics
For system requirements of RPA, see Support matrix
For an overview on how to prepare a database environment for RPA, see Introduction to preparing the database
environment
For instructions on installing RPA RAS, see Install RAS

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 64
Robotic Process Automation 2019.11

Prepare
This section provides the information required to prepare your environment for RPA components installation.
Ensure that you meet all the hardware and software requirements of all the RPA components.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 65
Robotic Process Automation 2019.11

Configure RabbitMQ
Robotic Process Automation (RPA) uses RabbitMQ as a message broker.
Before installing RPA, you must install and configure RabbitMQ.
This topic provides details on how to configure RabbitMQ. For help with installation, refer to RabbitMQ
documentation online.

Basic Configuration

Enable management plugin

To enable the management plugin for RabbitMQ:

1. Navigate to the RabbitMQ installed path:

Example: \RabbitMQ Server\rabbitmq_server-3.7.11\sbin


2. Open the command prompt and run the following command:

rabbitmq-plugins enable rabbitmq_management


3. Restart the RabbitMQ service.

4. Access the RabbitMQ management portal at http://<rabbitmq_fqdn>:15672 and provide your user name and
password.

Add a virtual host

To add a virtual host:

1. Log in to the RabbitMQ management portal http://<rabbitmq_fqdn>:15672 using the default user/guest user
credentials.

Guest users can access the management portal only from a local connection.
2. From the Admin menu, select Virtual Hosts.

3. Specify a name for your virtual host and click the Add virtual host button.

Create a user

By default, the guest user created during RabbitMQ installation is restricted from connecting through remote hosts;
the guest user can only connect over a loopback interface (localhost). This applies to connections regardless of the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 66
Robotic Process Automation 2019.11

protocol. Other users are not restricted in this way, by default.


The recommended way to address this in production systems is to create a new user or set of users with the
permissions to access the necessary virtual hosts. You can do so using CLI tools or the Management UI.
To create a user using Management UI:

1. Go to Admin menu and select Users tab.

2. Click the Add a user dropdown list.

3. Specify a user name and password.

4. Add the ”administrator” tag.

5. Click the Add user button.

Grant permissions

To grant permissions to a user to access a virtual host:

1. From the Admin menu, select Users tab.

2. Select the required user.

3. Under the Permissions section, select the required virtual host and click the Set permission button.

4. Under the Topic permissions section, select the required virtual host and click the Set topic permission
button.

RabbitMQ hardening
The following are the recommended actions to harden RabbitMQ:

Change the hashing function configuration used by the RabbitMQ credentials store to SHA-512 hashing function
for increased security. For more details, see RabbitMQ official documentation.
Ensure to have the periodic credentials rollover for the RabbitMQ RPA integration user.
For RabbitMQ production environment, delete the default user guest as it has well-known credentials.

Warning
Ensure to have a dedicated RabbitMQ vhost (Virtual Host) for each RPA
solution (simple or clustered) deployment that is not shared with other
applications.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 67
Robotic Process Automation 2019.11

Ensure to use TLS 1.2 as a communication protocol between RPA Central, RAS, and RPA Robot with the RabbitMQ
broker over the network. This secures the transmitted data using encryption, provides data integrity and protects
against data disclosure. In order to configure the RabbitMQ broker to use TLS 1.2 follow RabbitMQ's official
documentation section for setting up TLS Support.
After providing the TLS configuration on the RabbitMQ broker side, you must install the RPA Central, RAS, and RPA
Robot components to have a secured communication out-of-the-box.
RPA solution components (RPA Central, RAS, RPA Robot) authenticate to the RabbitMQ broker by making use of
RabbitMQ username/password authentication mechanism.
In order to configure RabbitMQ secured connection for RPA Central/RAS or RPA Robot components after their
installation, follow the steps below:

1. Stop RPA Central/RAS/Robot service

2. Open the command prompt and enter the following command to import RabbitMQ's server certificate in RPA
Central/RAS/Robot client.truststore file, located in <installation
dir>/<product>/var/security/client.truststore.
keytool -importcert -alias <any_alias> -keystore <path to the client.truststore> -file <certificate_name.cer> -
storepass <changeit>

3. Add the following lines in queue.properties file, located in <installation


dir>/<product>/conf/queue.properties:
queue.truststore.type=JKS

queue.truststore.path=<installation dir>/<product>/var/security/client.truststore

Set queue.use.tls=true and queue.port=<rabbitmq_configured_tls_port>

4. Start RPA Central/RAS/Robot service

Related topics
To know the RabbitMQ supported version, see System requirements.
To download RabbitMQ, go to Download RabbitMQ.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 68
Robotic Process Automation 2019.11

Set up database environment


This section describes the database administrator how to configure different types of databases to be used with
Robotic Process Automation (RPA).
Setting up and maintaining the database is important in order to maintain the efficiency and throughput of RPA.
The following topics are covered in this section:

Prepare the database environment


Deploy and maintain a Microsoft SQL server database
Deploy and maintain an Oracle database
Deploy and maintain a Postgres database
Database purging
Installation Wizard Other database option

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 69
Robotic Process Automation 2019.11

Prepare the database environment


This section contains information about the types of databases used with Robotic Process Automation.

The term “database” may be interpreted in several ways, depending on the database vendor/technology used. In
Oracle, the term “database” relates to a collection of files containing data and metadata. A single Oracle database
may contain one or more schemas (and users). A Microsoft SQL Server “database” is closer in definition to Oracle’s
"schema" than to Oracle’s "database".
In order to avoid confusion, this section will use the following terms:

Instance/server – the software and memory structures providing RDBMS services


Database – the entity containing tables, views, indexes, and so on
Robotic Process Automation requires a single database to be created. This database may co-exist with other
databases contained in a database server.
You can set up an RPA database on one of the following database server types:

Microsoft SQL Server Standard/Enterprise (2012/2014/2016/2017)


Oracle 11gR2 Standard/Enterprise Server, including RAC environment
Oracle 12cR1 Standard/Enterprise Server - regular instance (non-CDB) including RAC environment and Oracle
12cR2 Standard/Enterprise Server - regular instance (CDB).
Postgres (9.4/9.5/9.6)
This section is intended for trained database administrators. If you are not familiar with the type of database you
wish to use, or you feel that you lack the relevant knowledge required in order to create and configure an RPA
database, see the database vendor’s documentation and make sure you fully understand each action you perform
as described in this section.
RPA database connectivity relies on Java JDBC. If your environment requires specific adaptations or security
measures, see the JDBC documentation (or database vendor documentation) to find out exactly how the JDBC
connection URL should be formatted.
This section describes the required database settings for RPA. Settings that are not specified in this document can
be left with default values or configured by your organization's DBA.

Language support
RPA can be installed in English. Databases and database servers should be properly configured in order to support
the desired language.

Database clusters
Database clusters protects the database from several types of failures and makes Robot Process Automation more
robust.
RPA does not provide database cluster-related features of its own, such as database connection failover. It relies on

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 70
Robotic Process Automation 2019.11

the functionality of the JDBC package being used and the database cluster environment capabilities, such as
SCAN/AG listeners.
You can install RPA in conjunction with any type of database cluster environment that satisfies the following
conditions:

Connection pooling is supported


A single, valid database URL can be provided
It provides reliable transaction handling during failover (a single, complete transaction must either completely
fail or succeed)
The RPA installer does not provide database cluster-specific installation options. During installation, you need to
provide the installer a simplistic / "regular" form of database connection. Database URL adaptations usually have to
be made after the system is already installed in the database.properties configuration file.

Database security
The RPA database is at the heart of the RPA system, containing the RPA system configuration and possibly
corporate-sensitive data. It is highly recommended that you enforce strict security settings on your database by
following these guidelines.
Harden your database server by following the recommendations from the database vendor and the operating
system vendor. Server hardening may include, among other items to:

Restrict SSH access on Linux servers to a well-controlled set of OS users


Enforce a strict OS user password policy – password length, complexity, lockout-policy, and so on
Set up an audit system to detect and report break-in attempts
Harden your database user/login accounts to:

Enforce the password policy – password length, complexity, lockout-policy, and so on


Restrict access to administration-level accounts
Set up an audit system to detect and report break-in attempts
Database encryption at file-system level is supported as long as it does not compromise RPA’s performance, and
completely transparent to RPA. For example, Oracle TDE may be used as long as it does not cause any
performance degradation or prevent LOB free-space reclaim.

Database schema
Robotic Process Automation databases are always created using the default database schema. For SQL Server, RPA
uses the dbo schema, and for PostgreSQL - the public schema. Currently, no other schemas are supported by
RPA.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 71
Robotic Process Automation 2019.11

RPA database connection pooling


A connection pool is a cache of database connections maintained so that the connections can be reused when
future requests to the database are required. Connection pools are used to enhance the performance of executing
commands on a database. In connection pooling, after a connection is created, it is placed in the pool and used
again so that a new connection does not have to be established. If all the connections are being used, a new
connection is made and is added to the pool. Connection pooling reduces the time required to establish a
connection to the database.
RPA supports 2 connection pooling strategies: Hikari and tomcat-dbcp2. By default RPA starts with Hikari
connection pooling strategy. You can switch to the tomcat-dbcp2 by editing the database.properties file. A RPA
service restart is required for the change to go in effect. We recommend using Hikari connection pooling strategy.

Configure the database connection pooling in RPA Central

1. Locate the file central/conf/database.properties in an existing Central installation.

2. Add or edit the property named db.connection.pool.strategy to one of the values such as hikari or tomcat-
dbcp2. In case the value is left empty or parameters does not exist, the default strategy tomcat-dbcp2 will be
used.

Example:db.connection.pool.strategy=hikari

3. Restart the RPA Central service for the changes to take effect.

RPA database sizing


RPA keeps all flow and step execution data in the database by default, enabling comprehensive debugging of
previous flow runs. As a result, the database size grows in accordance to the system throughput and flow
complexity.
This topic will help you prepare for installing RPA. By estimating your system scale (small/standard/enterprise), you
will be able to derive the amount of disk space required, derive the amount of memory (RAM) used by the
database, and determine additional database installation parameters.

1. Estimate the system scale according to complexity:

System Criteria\Scale Small Standard Enterprise

Average number of steps per flow 50 or less 100 or more 1000 or more

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 72
Robotic Process Automation 2019.11

System Criteria\Scale Small Standard Enterprise

Average flow duration Seconds to minutes 1 hour or more Up to 24 hours

Average payload size per flow 1 1 KB or less 1 MB or more 4 MB or more

[1] – The term "payload" refers to flow/step data of considerable size. For
example, a CSV or XML file used as flow input, a large JSON object / REST API
call data.

2. Estimate the system scale according to concurrency/frequency:

System Criteria\Scale Small Standard Enterprise

Average number of flows per day Less than 100 300 or more 1000 or more

The following table provides disk space and memory requirements for different RPA deployment scales:

System Scale\Parameter RPA Database Disk Size Requirements Memory

Small 50 GB 4 GB

Standard 500 GB 8 GB

Enterprise Between 500 GB and 2 TB 12 GB

Notes:

Disk space and memory values are estimates. Actual disk space and memory consumption vary, depending on
the database vendor and database server configuration.
Memory (RAM) reflects recommended database memory, not the overall amount of memory available on the
database machine (virtual or physical server).
Disk space reflects the amount of disk space required for day-to-day operation of the RPA system and reasonable
historical data retention—not including long-term database backups.

It is highly recommended to regularly purge historical data using the stored procedure published on
ITOM Marketplace and the database purge flows provided in the Micro Focus Solutions content pack, in order to
keep the database size within your environment limitations. For data that can be purged by both stored
procedures and purge flows pick either flows or procedures, not both.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 73
Robotic Process Automation 2019.11

The amount of additional disk space required for keeping RPA database backups depends on the backup policy
(frequency and retention period).

Hardware requirements
The following table describes the hardware (CPU and memory) requirements recommended for the each of the
database servers.

Note The memory values reflect database memory consumption as part of the
entire machine’s memory.

Database\Scale Small/Standard Enterprise

CPUs RAM CPUs RAM

Small Standard Min Rec Min Rec Min Rec

SQL Server 2 4 4 GB 8 GB 4 12 8 GB 12 GB

Oracle 2 4 4 GB 8 GB 4 12 8 GB 12 GB

Postgres 2 4 4 GB 8 GB 4 12 8 GB 12 GB

Min = Minimal value, Rec = Recommended value In addition to the generalized hardware requirements above,
refer to the appropriate hardware requirements and software requirements sections per database.

Related topics
Deploy and maintain a Microsoft SQL server database
Deploy and maintain an Oracle database
Deploy and maintain a Postgres database
Performance and sizing information

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 74
Robotic Process Automation 2019.11

Deploy and maintain a Microsoft SQL server


database
To deploy Robotic Process Automation (RPA) using Microsoft SQL Server, you must have an existing SQL Server
database service.
If you need to create a new database service, see the relevant documentation provided by Microsoft.
It is recommended to use the SQL Server Agent service to schedule data purging and index maintenance jobs.
This section includes the following topics:

Workflow for Microsoft SQL Server Deployment


System Requirements for Microsoft SQL Server
Configure SQL server
Manually create an RPA database on Microsoft SQL server
Microsoft SQL server database maintenance

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 75
Robotic Process Automation 2019.11

Workflow for Microsoft SQL Server Deployment


To deploy RPA using Microsoft SQL Server, perform the following steps:

1. Review sizing guidelines.

2. Review Hardware and Software Requirements.

3. Configure Microsoft SQL Server.

4. Create an RPA database on Microsoft SQL Server.

5. (Optional) Set up Windows authentication.

Related topics
For database sizing details, see Prepare the database environment
For software and hardware requirements, see System requirements for Microsoft SQL server
To configure SQL server, see Configure SQL server
For instructions to create RPA database on Microsoft SQL server, see Manually create an RPA database on
Microsoft SQL server

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 76
Robotic Process Automation 2019.11

System requirements for Microsoft SQL server


This section describes the system requirements for working with Microsoft SQL Server in conjunction with RPA.

Hardware requirements
For RPA database sizing guidelines and hardware requirements, see Prepare the database environment topic.
For Microsoft SQL Server hardware requirements, see the relevant installation section for your Microsoft SQL Server
release and operating system.

Software requirements
For the supported Microsoft SQL server database versions, see System requirements topic.
See the Microsoft documentation for supported platforms.

Examples of tested deployment environments


The following table lists the deployment environments that have been rigorously tested by quality assurance
personnel.

Database Release

Version 32/64Bit Service Pack Operating System

Microsoft SQL Server 2017 Enterprise 64 bit CU 1 Windows 2012 R2 Standard Edition 64
Edition Bit

Microsoft SQL Server 2016 Enterprise 64 Bit 0 Windows 2012 R2 Standard Edition 64
Edition Bit

Microsoft SQL Server 2014 Enterprise 64 Bit 1 Windows 2012 Standard Edition 64 Bit
Edition

Microsoft SQL Server 2012 Enterprise 64 Bit 2 Windows 2012 Standard Edition 64 Bit
Edition

Language support
In Microsoft SQL Server, unlike other databases, RPA database does not use Unicode collation.
Use one of the following collations depending on your RPA installation language:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 77
Robotic Process Automation 2019.11

Language Database Collation

English SQL_Latin1_General_CP1_CS_AS

Japanese Japanese_Unicode_CS_AS

Simplified Chinese Chinese_Simplified_Stroke_Order_100_CS_AS

German SQL_Latin1_General_CP1_CS_AS

French French_100_CS_AS

Spanish SQL_Latin1_General_CP1_CS_AS

Note When an MS SQL database is created with a case-sensitive collation, object


names such as tables, keys, and so on become case-sensitive as well.
For example, for the OO_STEP_LOG_BINDINGS table, a command such as SELECT *
FROM oo_step_log_bindings is seen as using an invalid object name.

If you are currently using a different collation, it is highly recommended that you change your RPA database
collation to one of the collations above, in order to support future RPA versions.
The following procedure is an example of how to change an existing database collation:

1. Connect to your database server using an administrative login (for example, “sa”).

2. Disconnect all existing sessions to the specific RPA database that you intend to change.

Important! The command will fail unless this database has exactly 0 sessions/connections.

3. Run the following code (change my_database to the actual name of the database):

USE [master] GO ALTER DATABASE [my_database] COLLATE Japanese_Unicode_CS_AS GO

Note This change does not alter existing column collations. Any new column or
table will use the new collation by default from this point on. The new collation
sorting rules are applied immediately. In other words, the new collation affects
sorting behavior and future data, rather than existing data.

If you have user input in two languages apart from English (for example, German and Chinese) then MS SQL should
not be used. You should use an alternative database such as Oracle or PostgreSQL with Unicode configuration.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 78
Robotic Process Automation 2019.11

Related topics
Prepare the database environment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 79
Robotic Process Automation 2019.11

Configure SQL server


This section contains information on Microsoft SQL Server and database configuration settings.
You can install an RPA database in any SQL Server environment including clustered environments.

Microsoft SQL Server 2012, 2014, 2016, and 2017 IDM database

Server Options/Features

Configuration Item Supported Configuration Options

Server Configuration Options Defaults, unless instructed otherwise

Instances Default, Single

Authentication Mode Mixed, Windows [1]

Full-Text Search (Not required for RPA)

[1] At the moment, the RPA installer supports only SQL authentication. Windows authentication can be configured
later.

Microsoft SQL Server 2012, 2014, 2016, and 2017 IDM database

Instance/Server Options

Mandatory Recommended Supported

Server SQL_Latin1_General_CP1_CS_AS Any Collation. For IDM database (IDM


Collation Service), the collation must be case
insensitive. For example,
SQL_Latin1_General_CP1_CI_AS.

Network Server: TCP/IP


Libraries Client: TCP/IP

Concurrent >= 800 0 (unlimited)


Connections

Max Server > 4GB 2,147,483,647 (default, unlimited)


Memory Allocate 4-12 GB depending on
system scale according to
the Performance and Sizing
Information topic of OO Install
section.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 80
Robotic Process Automation 2019.11

Microsoft SQL Server 2012, 2014, 2016, and 2017 IDM database

Database Options

Mandatory Recommended Supported

Collation Any collation listed in the “Language


Support” section in System
requirements for Microsoft SQL server
topic.

Recovery Model Full Simple, Full

Allow Snapshot Isolation True

Is Read Committed Snapshot On True

Auto Shrink False

Auto Create Statistics True

Note SQL Server uses a READ-COMMITTED transaction isolation without snapshot


isolation by default. It is mandatory to set the Allow Snapshot Isolation and Is
Read Committed Snapshot On flags. RPA fails to operate properly using any
other type of transaction isolation.

Related topics
Performance and sizing information
System requirements for Microsoft SQL server

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 81
Robotic Process Automation 2019.11

Manually create an RPA database on Microsoft


SQL server
During RPA setup, a new database can be created automatically by the RPA installer or an existing database can
be used.
If during installation, you are authorized to connect to the database server as sysadmin (that is, connect as “sa”),
use the installer's “Create the database/schema” option, and you can skip this section.
This section describes the procedure for manually creating an RPA database, login, and user on Microsoft SQL
Server.

Note Only the database, login and user are created at this point; objects such as
tables and indexes are not created yet. These objects are created when RPA starts
for the first time.

This section is relevant for you if, for example, due to security restrictions, you do not wish to use login/user
credentials with elevated privileges during the RPA installation. In such a case, you (or your organization’s DBA)
should create the database, login, and user first, and then let the RPA installer connect to the pre-existing
database using “lower” privileges.
To create a database, you must connect to the SQL Server instance using a login that has CREATE DATABASE
permission.

Members of the sysadmin server roles automatically have CREATE DATABASE


permission, and are also mapped to dbo in all databases.
Perform the following procedures only if you are an experienced Microsoft SQL
Server database administrator.
If you prefer to use the database creation wizard/GUI, make sure you select all
options that correspond with the T-SQL code presented below. For example,
make sure you set Allow Snapshot Isolation to TRUE under the Options
page/Other Options pane/Miscellaneous tab in the New Database dialog box.
Not all database creation options are specified—only those that differ from the
default value. When in doubt, use default values.
In order to use Microsoft SQL Server in the most efficient way with RPA, it is
required that language-specific database collations are used. This enables using
the varchar data-type for textual columns instead of the nvarchar data-type.
Using the varchar data type is more efficient and reduces overall database size.
Selecting a specific collation also means that an RPA system that uses SQL Server

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 82
Robotic Process Automation 2019.11

is limited to the set of languages supported by that specific collation. For example,
if the SQL_Latin1_General_CP1_CS_AS collation is used, English, German, and
Spanish characters may be used, but Japanese characters may not. If
Japanese_Unicode_CS_AS is used, French accent characters will not be
presented properly. For the complete specification of each collation, see the
Microsoft SQL Server documentation.
To create a database:

1. Log in to Microsoft SQL Server as “sa” or any other login with a sysadmin role
or the CREATE DATABASE permission.

2. Run <installation folder>/central/bin/sql/MS-


SQL/mssql_create_oo_db.sql and verify that the database, login, and user
were created successfully. Adapt the script parameters to match your
environment.

3. (Optional) In order to verify that database objects can be created by the new
login and user, connect to the database server using RPA’s newly created
login role credentials and run <installation folder>/central/bin/sql/MS-
SQL/mssql_create_test_table.sql.

Verify that the script ran correctly and that no errors are shown.

Manually create database objects

Once the database, login, and user are in place, the database objects (tables,
indexes, and so on) are created when the RPA service starts and connects to the
database for the first time.
You could create the database objects manually if the user created for RPA does
not have permissions to create or modify database objects (limited to DML
operation only).
It is highly recommended to grant the RPA database user DDL-related privileges,

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 83
Robotic Process Automation 2019.11

in order to allow RPA to perform upgrade operations without manual intervention,


as these operations sometimes require modifications to the database structure.
To manually create the database objects:

1. Extract the mssql.sql files from the RPA installation zip file under docs\sql.

2. Log in to Microsoft SQL Server as the relevant user, who is permitted to create
and modify database objects in the RPA database.

3. Run the mssql.sql file and verify that no errors occurred.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 84
Robotic Process Automation 2019.11

Maintain the Microsoft SQL server database


This section describes the maintenance tasks that Micro Focus recommends for keeping in good shape the Robotic
Process Automation (RPA) databases created on a Microsoft SQL server.

Back up the RPA database


Microsoft SQL Server databases are either configured for the Full recovery model, or the Simple recovery model.
You can back up an RPA database using either one of these models. As RPA keeps all configuration and operational
history in a single database, always backup the complete database.
Consider the following guidelines when you create your backup plan for RPA:

Backup method

The backup method depends mainly on business considerations—how much information ”may” be lost? What is
the maximum time for system recovery? If you need to be able to perform point-in-time recovery, and only “allow”
a few hours-worth of data loss, use the full recovery model and perform full or differential backups daily, and
transaction log backup every N hours depending on your business requirements.
If your organization is more tolerant to data loss, you can use the simple recovery model and perform a daily or
weekly full backup.

Backup frequency

Daily backup is recommended, especially if you are using/modifying RPA on a daily basis.
You should back up once a month at the very least.

Timing

Schedule backup for the time when RPA is least active.

Retention

Retention depends on your business guidelines and regulations.

Create a maintenance plan


Use the scripts and tools described in this section, in order to keep the RPA database in good shape.

Supplied utilities for RPA database maintenance

RPA provides a set of scripts to update statistics, maintain indexes, and purge history. These scripts create stored

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 85
Robotic Process Automation 2019.11

procedures that you can tune and schedule to run periodically.


Micro Focus recommends using these procedures, but you can also use other methods in accordance with
company policy.
To purge data, Micro Focus highly recommends using only Micro Focus-provided flows and procedures to make
sure you do not compromise database structure or data.

SQL scripts location

The SQL scripts are included in the RPA DB Maintenance package, available from the ITOM Marketplace.

Scheduling the maintenance

Make sure to schedule the maintenance activity at a time when RPA is least active. This is because the
maintenance activity usually consumes additional resources from the database server.

Monitoring database size

Micro Focus highly recommends that you track your database size to make sure old, irrelevant information is
periodically purged or removed. For more information, see Performance and sizing information

Update indexes and statistics


Rebuilding indexes online, without RPA system downtime, requires an enterprise-grade database. Make sure you
are running an enterprise version of Microsoft SQL Server before rebuilding online index.
To install and use the RPA Maintenance Stored procedure:

1. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant release
version.

2. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

3. Log in to the Microsoft SQL Server as sa or as any member of the sysadmin role.

4. Give the RPA user access to dm_oo_performance_counters dynamic management view (DMV). To do
this, you can either:

execute the following command, making sure to replace <myRPADBLogin> with the actual login role that
you have created for RPA.

USE [master] GO GRANT VIEW SERVER STATE TO myRPADBLogin GO

edit and use the mssql_grant_view_server_state.sql script from the extracted folder: <your temporary
folder>\RPA_DB_Maintenance\MS-SQL

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 86
Robotic Process Automation 2019.11

5. Go to MS-SQL\2019.07 folder and open the following scripts:

RPA_DB_MAINTENANCE_LOG.sql
RPAIndexMaintenance.sql (optional)

6. Edit both scripts by replacing each instance of USE <your_db_name_here> in the file headers with your
actual RPA database name. For example, if your database name is RPAPROD, replace it with USE RPAPROD.
Do not skip this step, otherwise the procedure will not be created in the correct database!

7. Log in to Microsoft SQL Server as the RPA user.

8. Run the T-SQL scripts from the MS-SQL\2019.11 folder in the following order and verify that the new objects
have been created successfully:

RPAIndexMaintenance.sql (optional)
RPA_DB_MAINTENANCE_LOG.sql

9. Tune your stored procedure by editing the ssql_execute_index_mainenance.sql script available in the MS-SQL
folder. See below the tuning parameters and their description.

Parameters for tuning the RPA Maintenance stored procedure

<your_db_name_here>: replace the two occurrences of this variable with the actual name of your
database.
@Fragmentation<sensitivity/level>: sets the sensitivity and the flow of the script’s fragmentation
level. The default threshold levels and subsequent actions are the ones that Microsoft recommends.
Tune these values carefully. Available options are: @FragmentationLow,
@FragmentationMedium, @FragmentationHigh, @FragmentationLevel,
@FragmentationLevel2.
@SortInTempdb: set this to Y to run sorting operations in the tempdb database during index
reorganization/rebuild. This improves performance as these operations are no longer run in the
memory. If you choose to use this option, make sure you have sufficient free space in tempdb.
@Indexes: use this filter for including/excluding indexes during maintenance. Keep the default value if
you want to analyze all indexes.
@TimeLimit: specify the timeout in seconds for completing the maintenance operation. Set this
according to your maintenance plan and schedule.
@LockTimeout: specifies the timeout in seconds to wait for object lock. When this timeout expires,
the specific operation fails and the procedure resumes with the next object.
@LogToTable: specifies whether to log the results of the maintenance operation in a table. This helps
you debug and keep track of your maintenance operations. To create the table, use the
RPA_DB_MAINTENANCE_LOG.sql script.
@Execute: specifies whether to run actual operations, for example index rebuilding. If you set this

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 87
Robotic Process Automation 2019.11

parameter to N, the procedure performs a dry run and shows an analysis of the relevant objects.

Purge historical data


Before installing the procedures, you must make sure to run the create purge tables script to create all the tables
required by the procedures. The script is located in the same folder as the procedures.

Collect historical data


The RPACollectHistory procedure collects information about historical data and stores it in specific external
tables. Historical data is any data that exceeds your specified retention period and should be deleted. You can run
RPACollectHistory as a standalone procedure or call it automatically from the RPAPurgeHistoryExt procedure.
This procedure alone does not delete any historical data from the RPA database.
To install and use the RPACollectHistory stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run the RPA_DB_Maint.pks file, then the RPA_DB_Maint.pkb file. Check that the new package and procedures
have been created successfully.

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_RPACollectHistory.sql script. Before executing the script, you can tune the
procedure according to the parameters below.

Parameters for tuning the RPACollectHistory stored procedure:

@CollectDataOlderThan: specifies the number of days to keep the execution data. This time value is relative
to 'now'. This parameter is mandatory and does not have a default value.
@CollectDataInBatchesOf: determines how many rows to handle at a time. Default is the minimum value of
1,000,000. Maximum value is 10,000,000.
@StopCollectingAfter: specifies the maximum number of hours that the procedure can run. The default value
is four hours.
@CollectLimit: limits the number of rows into which data is collected, based on the RPA_STEP_LOG_STARTED
table. This enables the purge procedure to delete small batches of data quickly. The default value is 0—Collect

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 88
Robotic Process Automation 2019.11

everything that qualifies. The minimum value for restriction is 100,000. Default value is 1,000,000. Maximum
value is 10,000,000.

Delete historical data


The RPAPurgeHistoryExt procedure deletes historical RPA data. Unlike the deprecated RPAPurgeHistory
procedure which stored data marked for deletion in memory structures, the RPAPurgeHistoryExt procedure
stores this data in external tables. This allows timed out purged events to continue or to collect new data and start
from scratch with the new batch of data Not continuing timed out procedures may create orphan records.
To install and use the RPAPurgeHistoryExt stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run the RPA_DB_Maint.pks file, then the RPA_DB_Maint.pkb file. Check that the new package and procedures
have been created successfully.

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_RPAPurgeHistoryExt.sql script. Before executing the script, you can tune the
procedure according to the parameters below.

Parameters for tuning the RPAPurgeHistoryExt stored procedure:

@CollectDataOlderThan: specifies the number of days to keep the execution data. This time value is relative
to 'now'. This parameter is mandatory and does not have a default value.
@CollectDataInBatchesOf: determines how many rows to handle at a time. Default is the minimum value of
1,000,000. Maximum value is 10,000,000.
@ShouldPurgeExecutionSummary: specifies whether to purge the RPA_EXECUTION_SUMMARY table. The
default value is 0⁠—Do not purge this table.
@ContinueOldPurge: instructs the procedure to continue deleting data from a previous run of the purge
procedure that has timed out, instead of collecting new data for deletion. This parameter is valid only for the
RPAPurgeHistoryExt procedure, and is not available for the deprecated RPAPurgeHistory procedure.
Accepted values are: 0—OFF, 1—ON.
@StopPurgingProcessAfter: specifies the maximum number of hours that the procedure can run. The default
value is four hours.
@DelayInMillisecPerBatch: sets a delay between delete batches. This reduces resource contention between

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 89
Robotic Process Automation 2019.11

the purge procedure and regular RPA processes. Delays allow other transactions to complete in between delete
operations.
@CollectLimit: limits the number of rows into which data is collected, based on the RPA_STEP_LOG_STARTED
table. This enables the purge procedure to delete small batches of data quickly. The default value is 0—Collect
everything that qualifies. The minimum value for restriction is 100,000. Default value is 1,000,000. Maximum
value is 10,000,000.

Deep Clean
The RPADeepClean procedure extracts the Deep Clean functionality from the deprecated RPAPurgeHistory
procedure and runs it as a standalone process. This procedure deletes orphaned records from the RPA step log
tables. Similarly to the RPAPurgeHistoryExt, the RPADeepClean procedure uses external tables to store
information about data to be deleted. You cannot run this procedure at the same time with the
RPAPurgeHistoryExt procedure. This procedure does not affect data collected by the RPAPurgeHistoryExt
procedure.
To install and use the RPADeepClean stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run the RPA_DB_Maint.pks file, then the RPA_DB_Maint.pkb file. Check that the new package and procedures
have been created successfully.

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_RPADeepClean.sql script. Before executing the script, you can tune the
procedure according to the parameters below.

Parameters for tuning the RPADeepClean stored procedure:

@PurgeExecutionsInBatchesOf: determines how many rows to handle at a time. Default is the minimum
value of 1,000,000. Maximum value is 10,000,000.
@StopPurgingProcessAfter: specifies the maximum number of hours that the procedure can run. The default
value is four hours.
@ContinueOldPurge: instructs the procedure to continue deleting data from a previous run of the purge
procedure that has timed out, instead of collecting new data for deletion. This parameter is valid only for the
RPADeepClean procedure, and is not available for the deprecated RPAPurgeHistory procedure. Accepted

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 90
Robotic Process Automation 2019.11

values are: 0—OFF, 1—ON.


@DelayInMillisecPerBatch: sets a delay between delete batches. This reduces resource contention between
the purge procedure and regular RPA processes. Delays allow other transactions to complete in between delete
operations.

Clear old execution plans


To install and use the RPA Execution Plans stored procedure:

1. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

2. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

3. Go to <your temporary folder>\RPA_DB_Maintenance\MS-SQL\2019.07

4. Edit the RPA_PURGE_RUNNING_EXECUTION_PLANS.SQL script by replacing each instance of USE


<your_db_name_here> in the file headers with your actual RPA database name. For example, if your
database name is RPAPROD, replace it with USE RPAPROD. Do not skip this step, otherwise the procedure will
not be created in the correct database!

5. Log in to the SQL Server as the RPA database user.

6. Run the modified RPA_PURGE_RUNNING_EXECUTION_PLANS.SQL script and verify that the new objects have
been created successfully.

7. Tune your stored procedures according to the procedure parameters below. These are also embedded in the
script as comments.

8. Go to the MS-SQL folder and use the mssql_execute_plans_stored_procedure script to execute the Plans
stored procedure.

Parameters for tuning the RPA Execution Plans stored procedure

<your_db_name_here>: replace the two occurrences of this variable with the actual name of your database.
@PurgeExecutionsInBatchesOf: determines how many flows are handled together. Smaller values imply
smaller, more frequent transactions. Higher values imply less frequent, larger transactions. The recommended
value for most systems is 10000.
@StopPurgingProcessAfter: specifies the timeout in hours for the operation to complete. Set this according to
your maintenance schedule.
@DelayInMiliSecPerBatch: creates a pause window between the deletion of one batch and the start of the
next batch of plans to be deleted.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 91
Robotic Process Automation 2019.11

Upgrade instructions
Prior to any upgrade of RPA, take the following steps:

1. Purge non-essential data from the database. The upgrade operation converts flow execution data. Less data
means a shorter upgrade. If all flow execution data is essential, perform a complete database backup first
and then purge.

2. Back up your database, preferably after the database was purged.

3. Schedule the operation to the database server’s quiet period.

4. Verify that no shared resources are exhausted – temporary space, transaction log, and similar resources.

Following any upgrade of RPA, take the following steps:

1. Install relevant versions of maintenance and purge stored procedures. Stored procedures and purge flows are
not upgraded back by the RPA upgrade utility.

2. Reschedule database maintenance and purge routines (stored procedures and/or purge flows).

Database server upgrade from 2012

Upgrade database to SQL Server 2014, 2016 or 2017

To upgrade the RPA 2019.07 database server from 2012, modify the RPA Central server configuration to use a
different JDBC connector jar. RPA interfaces SQL Server 2012 using JTDS 1.3.0 connector. SQL Server 2014 and
later are interfaced using Microsoft JDBC 4.2.
To upgrade to SQL Server database server 2014, 2016 or 2017:

1. Edit Central server database.properties file located under the central\conf folder.

2. Modify the jdbc.driver_class value


fromnet.sourceforge.jtds.jdbc.Drivertocom.microsoft.sqlserver.jdbc.SQLServerDriver

3. Modify the jdbc.url value


fromjdbc:jtds:sqlserver://your_db_host:your_db_port/your_db_name;sendStringParametersAsUnicode=true to
jdbc:sqlserver://your_db_host:your_db_port;databaseName=your_db_name;sendStringParametersAsUnicode=
true If you have edited your JDBC URL and used additional options, see Microsoft’s JDBC 4.2 document for
information on formatting correctly the new URL.

4. Repeat the steps above for each Central server in the RPA system.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 92
Robotic Process Automation 2019.11

5. Restart the RPA Central servers.

Upgrade RPA and the SQL Server database simultaneously

To simultaneously upgrade RPA and the SQL Server database to 2014 or higher:

1. Upgrade RPA using the current database. Follow the instructions in the sections above as usual: purge
beforehand, back up, etc. Micro Focus highly recommends performing a sanity test on the RPA system using
the current database.

2. Make a backup of the RPA database, preferably a full, copy-only backup. Backup RPA’s login role, if
necessary.

3. Upgrade the SQL Server database server to 2014, 2016 or 2017.

4. Restore the RPA’s database backup, if necessary. If the RPA’s database has been upgraded alongside the
database server, there is no need to restore it.

5. Reconfigure the login role authentication and database ownership, if necessary.

6. Configure Central servers to use Microsoft JDBC instead of JTDS.

Microsoft SQL Server Always On feature

RPA supports SQL Server 2012 Always On as a legacy client to implement a high availability and/or disaster
recovery solution.
RPA does not support the MultiSubnetFailover feature for SQL Server 2012, and requires that
RegisterAllProvidersIP is set to 0 in the cluster/listener configuration.
Starting with SQL Server 2014, connection to Always On is supported including the MultiSubnetFailover
feature. However, this has not been certified for RPA.

High Availability setup

As RPA requires a single point of contact, it is essential that an Availability Group Listener (AG listener) exist in the
High Availability setup. RPA’s database connection is defined by a single URL - containing a single hostname.
Normally, RPA interfaces with the AG listener in order to connect to the availability group primary replica (a READ-
WRITE capable instance).
In the case of a database failover scenario, while database connectivity is lost, RPA will repeatedly attempt to
connect to the database until a new READ-WRITE capable instance accepts the connection. The redirection of the
configured database hostname to a different IP address should be done by the AG Listener and cluster
environment.

Note RPA has no use for a read-only database, therefore no use for read-only

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 93
Robotic Process Automation 2019.11

routing.

Disaster Recovery Solution

In a disaster recovery setup, stop and reconfigure RPA by editing the database.properties file. Restart RPA once
the new database instance is available.

Related topics
Back up and recover RPA

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 94
Robotic Process Automation 2019.11

Deploy and maintain an Oracle database


In order to deploy Robotic Process Automation using Oracle, you must have an existing Oracle database service. If
you need to create a new database instance/service, see the relevant documentation provided by Oracle, because
this information is not included within this section. However, this section contains recommendations for the Oracle
instance configuration.
This section includes the following topics:

Workflow for Oracle deployment


System requirements for Oracle
Configure an Oracle database
Manually create an Robotic Process Automation database on an Oracle instance
Oracle database maintenance

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 95
Robotic Process Automation 2019.11

Workflow for Oracle deployment


To deploy RPA using Oracle, perform the following steps:

1. Review sizing guidelines.

2. Review Hardware and Software Requirements.

3. Configure an Oracle Database.

4. Create a Database.

5. (Optional) Connect RPA to an Oracle RAC environment. This step is only relevant if you are using RPA in
an Oracle RAC environment.

Related topics
To review sizing guidelines, see Prepare the database environment
To review hardware and software requirements, see System requirements for Oracle
To configure Oracle database, see Configure an Oracle database
To create RPA database on Microsoft SQL server, see Manually create an RPA database on Microsoft SQL server

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 96
Robotic Process Automation 2019.11

System requirements for Oracle


This section describes the system requirements for working with Oracle in conjunction with Robotic Process
Automation.

Hardware requirements
For RPA database sizing guidelines and hardware requirements, see Prepare the database environment topic.
For Oracle hardware requirements, see the relevant installation section for your Oracle release and operating
system.

Software requirements
For supported Oracle database versions, see System requirements topic.

Only the listed patch sets should be installed. Newer patch sets are also supported
unless stated otherwise in the RPA Release Notes.

[1] It is highly recommended to apply Oracle’s “DATABASE PATCH SET UPDATE


11.2.0.4.6”.

See the Oracle documentation for supported platforms.

The Oracle 12c RAC environment is supported in backward-compatible form. New


features such as multiple cluster subnets for SCAN listener are not supported.

RPA is compatible with Oracle Data Guard protected databases. For RPA to work with a database protected by
Oracle Data Guard, ensure that the Data Guard protection mode is either set to “Maximum Availability" or
"Maximum protection”. The Data Guard environment must be configured for Fast-Start Failover to limit the down
time of the RPA service during failovers. The JDBC URL requirements are similar as those for Oracle RAC.

During failover, RPA may function in read only mode (that is, no new flow
executions can occur) for a short period of time while the database change occurs.
Also, during failover, historical data may be out of sync. This will be resolved when
the failover completes.

Oracle connector
The jdbc connector.jar file is not provided by default. When installing provide the connector to the installer. If
upgrading from a previous version of RPA the connector will not be deleted.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 97
Robotic Process Automation 2019.11

The jdbc connector .jar fie is not provided with the RPA installation. You must download it and place it under each
Central <installation folder>/central/lib folder.
Verify that the connector version you are using is fully compatible with your database server version. The
recommended driver is the Oracle JDBC driver version 7-12.1.0.2

Examples of tested deployment environments


The following table lists the deployment environments that have been rigorously tested by quality assurance
personnel.

Database Release

Version 32/64Bit Patch Set Operating System

Oracle 11g R2 Enterprise Edition 64 Bit 11.2.0.4.6 Red Hat Enterprise Linux 6.5 64 Bit

Oracle 11g R2 Enterprise Edition 64 Bit 11.2.0.4.0 Windows 2012 Standard Edition 64 Bit

Oracle 12c R1 Enterprise Edition 64 Bit 12.1.0.2 Red Hat Enterprise Linux 6.5 64 Bit

Oracle 12c R2 Enterprise Edition 64 Bit 12.2.0.2 Oracle Linux 7.3 64 Bit

Oracle 18C 64 Bit 18.3.0.0.0 Oracle Linux 7.3 64 Bit

Language support
The Oracle instance character set should be set to AL32UTF8. This enables using any Unicode character (and
practically all common characters in all languages).

Related topics
Prepare the database environment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 98
Robotic Process Automation 2019.11

Configure an Oracle database


This section contains information on the Oracle instance and database configuration settings.
You can install an RPA database in an Oracle clustered environment (Oracle RAC or other).
Legend:

Mandatory configuration options/values appear in bold/orange font.


Recommended configuration options/values appear in bold/purple font.
Supported configuration options/values appear in normal font, and may show as a comma-separated list.
Comments appear in italic font.

Oracle Database 11gR2 / 12cR1 / 12cR2

Instance/Server Options

Instance configuration options Defaults, unless instructed otherwise

Mandatory Recommended Supported

PROCESSES >= 500

SESSIONS >= 555

TIMED_ STATISTICS TRUE TRUE, FALSE

OPEN_CURSORS >= 900

Shared/Dedicated Server 'Dedicated' Dedicated, Shared

UNDO_ MANAGEMENT AUTO Automatic, Manual

Undo size >= 4GB 6GB – 10GB

Memory Management ASMM AMM, ASMM

MEMORY_TARGET 0 (disabled) >= 5G (for AMM)

SGA_TARGET 8G – 12G >= 4G (for ASMM)

SGA_MAX_SIZE 8G – 12G >= 4G (for ASMM)

PGA_AGGREGATE_ TARGET 1G – 2G >= 500M (for ASMM)

All values reflect resources required by Robotic Process Automation. If RPA shares
the Oracle instance with other users, these values should be added to whatever is
currently consumed by others.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 99
Robotic Process Automation 2019.11

Oracle Database 11gR2 / 12cR1 / 12cR2

Instance/Server Options

Mandatory Recommended Supported

File system ASM, Any

Storage options Locally managed tablespace

Automatic segment space


management (ASSM)

Automatic local extent management

ARCHIVELOG mode ARCHIVELOG ARCHIVELOG,


NOARCHIVELOG

Redo Log total size >= 600MB 1GB

All values reflect resources required by RPA. If RPA shares the Oracle instance with
other users, these values should be added to whatever is currently consumed by
others.

Related topics
Performance and sizing information

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 100
Robotic Process Automation 2019.11

Manually create an RPA database on an Oracle


instance
During RPA setup, a new database can be created automatically by the RPA installer or a pre-existing database can
be used.
If during installation, you are authorized to connect to the database server as dba (connect as “SYSTEM”), use the
“create the database/schema” option, and you can skip this section.

Note In some cases, the term "database" is used but in the case of Oracle, it
should be interpreted as "user".

This section describes the procedure for manually creating an RPA database in an Oracle instance.

Note Only the database is created at this point; objects such as tables and
indexes are not created yet. These objects are created once RPA starts for the first
time.

This section is relevant for you if, for example, due to security restrictions, you do not wish to use user credentials
with elevated privileges during the RPA installation. In such a case, you (or your organization’s DBA) should create
the user (database) first, and then let the RPA installer connect to the pre-existing database using basic privileges.
To create a database, you must connect to the Oracle instance using a login that has CREATE USER system
privilege—for example, system user.

Any user with the DBA role has sufficient privileges to create the new user.
Perform the following procedures only if you are an experienced Oracle database
administrator.
If you prefer to use the database creation wizard/GUI, make sure you select all
options that correspond with the SQL code presented below.
Not all database creation options are specified—only those that differ from the
default value. When in doubt, use default values.
To create a database:

1. Log in to the oracle as “system” or any other user with a DBA role.

2. Edit the <installation


folder>/central/bin/sql/Oracle/oracle_create_oo_db.sql SQL script, run it,
and verify that the database was created successfully.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 101
Robotic Process Automation 2019.11

3. (Optional) In order to verify that database objects can be created by the new
user, connect to the Oracle instance as RPA user, edit and run: <installation
folder>/central/bin/sql/Oracle/oracle_create_test_table.sql

Verify that the script ran successfully, and no errors or warnings were shown.

Manually create database objects

Once the database is in place, the database objects (tables, indexes, and so on)
are created when the RPA service starts and connects to the database for the first
time.
You can create the database objects manually if the user created for RPA does not
have permissions to create or modify database objects (limited to DML operation
only).
It is highly recommended to grant the RPA database user DDL-related privileges,
in order to allow RPA to perform upgrade operations without manual intervention,
as these operations sometimes require modifications to database structure.
To manually create the database objects:

1. Extract the oracle.sql file from the RPA installation zip file under docs\sql.

2. Edit the oracle.sql file and prefix each object with the RPA user, to make sure
the objects are created under the RPA user.

3. Connect to the RPA database as the relevant user, who is permitted to create
and modify database objects in the RPA database.

4. Run the oracle.sql file and verify that no errors occurred, and that all objects
are created and owned by the RPA user.

Connect to Oracle using SID or service name

Connecting to an Oracle database server requires you to specify either the SID

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 102
Robotic Process Automation 2019.11

(system ID) or Service Name. RPA supports specifying the service name during
installation (using either the Installation Wizard or a silent installation).
The following examples show how to format JDBC URL for each option, as it should
appear in the Central database.properties file under the central\conf folder.
Connecting to an Oracle instance using the SID:

jdbc.url=jdbc\:oracle\:thin\:@DB_HOSTNAME_OR_IP\:PORT\:SID

Connecting to an Oracle instance using the Service Name:

jdbc.url=jdbc\:oracle\:thin\:@//DB_HOSTNAME_OR_IP\:PORT/SERVICE_NAME

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 103
Robotic Process Automation 2019.11

Oracle database maintenance


This section describes the maintenance tasks that Micro Focus recommends for keeping in good shape the Robotic
Process Automation (RPA) databases created on an Oracle server.
These procedures are applicable for Oracle 11g R2, 12C and 18C.

Back up the Operations Orchestration database


Oracle databases can be backed up using several tools, such as expdp and RMAN. An RPA database can be
backed up using any type of method/tool as long as the complete database is backed up.
Consider the following guidelines when you create your backup plan for RPA:

Backup method

The backup method depends mainly on business considerations—how much information ”may” be lost? What is
the maximum time for system recovery? If you need to be able to perform point-in-time recovery, and only “allow”
a few hours-worth of data loss, use the full recovery model and perform full or differential backups daily, and
transaction log backup every "n" hours depending on your business requirements.

Backup frequency

Daily backup is recommended, especially if you are using/modifying RPA on a daily basis.
You should back up once a month at the very least.

Timing

Schedule backup for the time when RPA is least active.

Retention

Retention depends on your business guidelines and regulations.

Create a maintenance plan


Use the scripts and tools described in this section, in order to keep the RPA database in good shape.

Supplied utilities for RPA database housekeeping

RPA provides a set of scripts to update statistics, maintain indexes, and purge history. These scripts create stored
procedures that you can tune and schedule to run periodically.
Micro Focus recommends using these procedures, but you can also use other methods in accordance with

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 104
Robotic Process Automation 2019.11

company policy. To purge data, Micro Focus highly recommends using only Micro Focus-provided flows and
procedures to make sure you do not compromise database structure or data.

SQL scripts location

The SQL scripts are included in the RPA DB Maintenance package, available from the ITOM Marketplace.

Scheduling the maintenance

Make sure to schedule the maintenance activity at a time when RPA is least active. This is because the
maintenance activity usually consumes additional resources from the database server.

Monitoring database size

Micro Focus highly recommends that you track your database size to make sure old, irrelevant information is
periodically purged or removed.

Update indexes and statistics


Rebuilding indexes online, without RPA system downtime, requires an enterprise-grade database. Make sure you
are running an enterprise version of Oracle before rebuilding online indexes. Otherwise, index rebuilding may lock
tables and indexes and interfere with RPA functionality.
To install and use the RPA Index Maintenance stored procedure:

1. Log in to Oracle as system or as any other user with a DBA role. This role can verify that the stored
procedures you create can execute index analysis and rebuild.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant release
version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open the RPA_DB_Maintenance\Oracle folder.

5. Give the RPA user the rights to alter the indexes. You can either:

edit and execute the oracle_privs_for_index_maintenance.sql script from the Oracle folder.
run the following command:

GRANT CREATE TABLE TO <username> GRANT ANALYZE ANY TO <username> GRANT ALTER ANY INDEX TO
<username>

6. Open the RPA_DB_Maintenance\Oracle\2019.07 folder.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 105
Robotic Process Automation 2019.11

7. Log in to Oracle as the RPA database user.

8. Run the RPA_DB_MAINT.pks file, then the RPA_DB_MAINT.pkb file. Check that the new package and
procedures have been created successfully.

9. Execute the oracle_execute_IndexMaintenance.sql script. Before executing the script, you can tune the
procedure according to the parameters below.

Parameters for tuning the RPA Index Maintenance stored procedure

pMaxHeight (IN): the minimal index height threshold for index rebuilding. The Oracle documentation
recommends 3. Smaller values may generate unnecessary rebuilding operations.
pMaxLeafsDeleted (IN): the minimal deleted leaves threshold for index rebuilding. The Oracle documentation
recommends 15. Smaller values may generate unnecessary rebuilding operations.
pRebuild (IN): type 1 to rebuild indexes or 0 to perform a dry-run. This shows only recommendations for index
rebuilding.
pReturnValue (OUT): the number of rebuilt indexes.

Purge historical data


Before installing the procedures, you must make sure to run the create purge tables script to create all the tables
required by the procedures. The script is located in the same folder as the procedures.

Collect historical data


The CollectData procedure collects information about historical data and stores is in specific external tables.
Historical data is any data that exceeds your specified retention period and should be deleted. You can run
CollectData as a standalone procedure or call it automatically from the ExternalPurge procedure. This
procedure alone does not delete any historical data from the RPA database.
To install and use the CollectData stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run theRPA_DB_Maint_E.pks file, then the RPA_DB_Maint_E.pkb file. Check that the new package and
procedures have been created successfully.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 106
Robotic Process Automation 2019.11

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_CollectData.sql script. Before executing the script, you can tune the procedure
according to the parameters below.

Parameters for tuning the CollectData stored procedure:

pCollectDataOlderThan: specifies the number of days to keep the execution data. This time value is relative to
'now'. This parameter is mandatory and does not have a default value.
pCollectDataInBatchesOf: determines how many rows to handle at a time. Default is the minimum value of
1,000,000. Maximum value is 10,000,000.
pStopCollectingAfter: specifies the maximum number of hours that the procedure can run. The default value is
four hours.
pCollectLimit: limits the number of rows into which data is collected, based on the RPA_STEP_LOG_STARTED
table. This enables the purge procedure to delete small batches of data quickly. The default value is 0—Collect
everything that qualifies. The minimum value for restriction is 100,000. Default value is 1,000,000. Maximum
value is 10,000,000.

Delete historical data


The ExternalPurge procedure deletes historical RPA data. Unlike the deprecated RPAPurgeHistory procedure
which stored data marked for deletion in memory structures, the ExternalPurge procedure stores this data in
external tables. This allows timed out purged events to continue or to collect new data and start from scratch with
the new batch of data Not continuing timed out procedures may create orphan records.
To install and use the ExternalPurge stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run the RPA_DB_Maint_E.pks file, then the RPA_DB_Maint_E.pkb file. Check that the new package and
procedures have been created successfully.

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_ExternalPurge.sql script. Before executing the script, you can tune the procedure
according to the parameters below.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 107
Robotic Process Automation 2019.11

Parameters for tuning the ExternalPurge stored procedure:

pCollectDataOlderThan: specifies the number of days to keep the execution data. This time value is relative to
'now'. This parameter is mandatory and does not have a default value.
pCollectDataInBatchesOf: determines how many rows to handle at a time. Default is the minimum value of
1,000,000. Maximum value is 10,000,000.
pShouldPurgeExecutionSummary: specifies whether to purge the RPA_EXECUTION_SUMMARY table. The
default value is 0⁠—Do not purge this table.
pContinueOldPurge: instructs the procedure to continue deleting data from a previous run of the purge
procedure that has timed out, instead of collecting new data for deletion. This parameter is valid only for the
ExternalPurge procedure, and is not available for the deprecated RPAPurgeHistory procedure. Accepted
values are: 0—OFF, 1—ON.
pStopPurgingProcessAfter: specifies the maximum number of hours that the procedure can run. The default
value is four hours.
pDelayInMillisecPerBatch: sets a delay between delete batches. This reduces resource contention between
the purge procedure and regular RPA processes. Delays allow other transactions to complete in between delete
operations.
pCollectLimit: limits the number of rows into which data is collected, based on the RPA_STEP_LOG_STARTED
table. This enables the purge procedure to delete small batches of data quickly. The default value is 0—Collect
everything that qualifies. The minimum value for restriction is 100,000. Default value is 1,000,000. Maximum
value is 10,000,000.

Deep Clean
The DeepCleanExt procedure extracts the Deep Clean functionality from the deprecated RPAPurgeHistory
procedure and runs it as a standalone process. This procedure deletes orphaned records from the RPA step log
tables. Similarly to the ExternalPurge, the DeepCleanExt procedure uses external tables to store information
about data to be deleted. You cannot run this procedure at the same time with the ExternalPurge procedure. This
procedure does not affect data collected by the ExternalPurge procedure.
To install and use the DeepCleanExt stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run the RPA_DB_Maint_E.pks file, then the RPA_DB_Maint_E.pkb file. Check that the new package and
procedures have been created successfully.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 108
Robotic Process Automation 2019.11

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_DeepCleanExt.sql script. Before executing the script, you can tune the procedure
according to the parameters below.

Parameters for tuning the DeepCleanExt stored procedure:

pPurgeExecutionsInBatchesOf: determines how many rows to handle at a time. Default is the minimum value
of 1,000,000. Maximum value is 10,000,000.
pStopPurgingProcessAfter: specifies the maximum number of hours that the procedure can run. The default
value is four hours.
pContinueOldPurge: instructs the procedure to continue deleting data from a previous run of the purge
procedure that has timed out, instead of collecting new data for deletion. This parameter is valid only for the
DeepCleanExt procedure, and is not available for the deprecated RPAPurgeHistory procedure. Accepted
values are: 0—OFF, 1—ON.
pDelayInMillisecPerBatch: sets a delay between delete batches. This reduces resource contention between
the purge procedure and regular RPA processes. Delays allow other transactions to complete in between delete
operations.

Clear old execution plans


To install and use the RPA PurgePlans stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.07

5. Run the RPA_DB_MAINT.pks file, then the RPA_DB_MAINT.pkb file. Check that the new package and
procedures have been created successfully.

6. Execute the oracle_execute_PurgePlans.sql script. Before executing the script, you can tune the procedure
according to the parameters below.

Parameters for tuning the RPA Execution Plans stored procedure

pPurgeExecutionsInBatchesOf: determines how many flows are handled together. Smaller values imply
smaller, more frequent transactions. Higher values imply less frequent, larger transactions. The recommended

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 109
Robotic Process Automation 2019.11

value for most systems is 10000.


pStopPurgingProcessAfter: specifies the timeout in hours for the operation to complete. Set this according to
your maintenance schedule.

Reclaim LOB space


Oracle databases are slow when it comes to freeing space occupied by LOB segments. Depending on the
configuration of the database server, LOB segment space may not be released immediately after purge operations.
As LOB space may have a significant impact on the database size, you can add a post-purge operation to force
freeing LOB segments.

Timing

Shrinking LOB segments of considerable size (tenths or hundreds of Giga-Bytes) may take some time to complete
and may consume a considerable amount of database resources—CPU and I/O. Therefore, it is recommended to
execute this process when the database server is least active.

Prerequisites

The shink operation is successful only if the following conditions are met:

TABLESPACE and database tables are not compressed.


ROW MOVEMENT is enabled for all tables.
TABLESPACE must be configured as AUTO segment space management.
LOBs storage is not SECUREFILE.
See the Oracle documentation for the complete set of conditions.

Command structure

The general structure of the command is ALTER TABLE FRPA MODIFY LOB ( LOB_COLUMN_NAME ) (shrink space);
The list of tables and columns involved may vary from one RPA version to another.

Install the LOB space reclaim stored procedure

To install and use the RPA LOB space reclaim stored procedure:

1. Open the <temporary folder>/RPA_DB_Maintenance/Oracle/2019.07 folder

2. Log in to Oracle database as RPA database user.

3. Execute the RPA_DB_MAINT.pks file, then the RPA_DB_MAINT.pkb file. Verify that the new package and
procedures were created successfully.

4. Run the oracle_execute_ForceLobShrink.sql to execute the procedure. The script also includes an example of

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 110
Robotic Process Automation 2019.11

how to use this procedure.

Upgrade prerequisites
Prior to any upgrade of RPA, take the following steps:

1. Purge non-essential data from the database. The upgrade operation converts flow execution data. Less data
means a shorter upgrade. If all flow execution data is essential, perform a complete database backup first,
and then purge.

2. Back up your database, preferably after the database was purged.

3. Schedule the operation to the database server’s quiet period.

4. Verify that no shared resources are exhausted – temporary space, UNDO/REDO, and similar resources.

Post-upgrade tasks
Following any upgrade of RPA, take the following steps:

1. Install relevant versions of maintenance and purge stored procedures. Stored procedures and purge flows are
not upgraded back by the RPA upgrade utility.

2. Reschedule database maintenance and purge routines (stored procedures and/or purge flows).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 111
Robotic Process Automation 2019.11

Deploy and maintain a PostgreSQL database


In order to deploy Robotic Process Automation (RPA) using Postgres, you must have an existing Postgres database
service. If you need to create a new database service, see the relevant documentation provided by Postgres,
because this information is not included within this section. However, this section contains recommendations for
the Postgres configuration.
This section includes the following topics:

Workflow for Postgres deployment


System Requirements for Postgres
Configuring Postgres
Manually create an Robotic Process Automation database on Postgres
Postgres database maintenance

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 112
Robotic Process Automation 2019.11

Workflow for PostgreSQL deployment


To deploy RPA using Postgres, perform the following steps:

1. Review sizing guidelines.

2. Review Hardware and Software Requirements.

3. Configure Postgres.

4. Create RPA database on Postgres.

Related topics
Prepare the database environment
Configure Postgres
Manually create an RPA database on Postgres

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 113
Robotic Process Automation 2019.11

System Requirements for PostgreSQL


This section describes the system requirements for working with PostgreSQL in conjunction with RPA.

Hardware requirements
For RPA database sizing guidelines and hardware requirements, see Prepare the database environment
For PostgreSQL hardware requirements, see the relevant installation section for your PostgreSQL release and
operating system.

Software requirements
For the supported PostgreSQL database versions, see System requirements topic.

Examples of tested deployments


The following table lists the deployment environments that have been rigorously tested by the quality assurance
personnel.

Database Release

Version 32/64Bit Operating System

Postgres 9.4.6 64 Bit Red Hat Enterprise Linux 7 64 Bit

Postgres 9.5.1 64 Bit Red Hat Enterprise Linux 7 64 Bit

Postgres 9.6.3 64 Bit Windows 2012 R2

PostgreSQL 10.9 64 Bit Windows 2012 R2

Language support
PostgreSQL determines character set and collation at the database level. The RPA database uses Unicode (utf8)
encoding and collation. This lets you use any Unicode character (and practically all common characters in all
languages).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 114
Robotic Process Automation 2019.11

Related topics
Configure PostgreSQL
Manually create an RPA database on PostgreSQL
PostgreSQL database maintenance

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 115
Robotic Process Automation 2019.11

Configuring PostgreSQL
This section contains information on Postgres configuration settings.
Legend:

Mandatory configuration options/values appear in bold/orange font.


Recommended configuration options/values appear in bold/purple font.
Supported configuration options/values appear in normal font, and may show as a comma-separated list.
Comments appear in italic font.

Postgres 9.4 - 9.6

Instance/Server Options

Instance Configuration Options Defaults, unless instructed otherwise

Mandatory Recommended Supported

max_connections >= 1000

default_transaction_isolation 'read committed'

autovacuum on

track_counts on

shared_buffers >=512MB 1

effective_cache_size >=2048MB 1

work_mem >=1MB 1

maintenance_work_mem >=32MB 1

lc_messages 'en_US.UTF-8' Any

lc_monetary 'en_US.UTF-8' Any

[1 ] - Minimal values. See the Postgres documentation on how to tune these values
in accordance with your environment.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 116
Robotic Process Automation 2019.11

Manually create an RPA database on PostgreSQL


During RPA setup, a new database can be created automatically by the RPA installer or a pre-existing database can
be used.
If during installation, you are authorized to connect to the database server as a privileged user (connect as
“postgres”), use the “create the database/schema” option, and you can skip this section.
This section describes the procedure for manually creating an RPA database on Postgres.

Note Only the database and role are created at this point; objects such as tables
and indexes are not created yet. These objects are created once RPA starts for the
first time.

This section is relevant for you if, for example, due to security restrictions, you do not wish to use login/user
credentials with elevated privileges during the RPA installation. In such a case, you (or your organization’s DBA)
should create the database, login, and user first, and then let the RPA installer connect to the pre-existing
database using basic privileges.
To create a database, you must connect to the Postgres instance using a login that has CREATEUSER and
CREATEDB privileges at the very least.

The postgres built-in user has all the required privileges.


Perform the following procedures only if you are an experienced Postgres
database administrator.
If you prefer to use the PgAdmin GUI, make sure you select all options that
correspond with the SQL code presented below.
Not all database creation options are specified—only those that differ from the
default value. When in doubt, use default values.
To create a database:

1. Log in to Postgres as “postgres” or any other login role with CREATEUSER


and CREATEDB privileges.

2. Edit and run:

<installation
folder>/central/bin/sql/PostgreSQL/postgres_create_oo_db_linux.sql

or:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 117
Robotic Process Automation 2019.11

postgres_create_oo_db_windows.sql

Verify that the database, login, and user were created successfully. Adapt the
script parameters to match your environment.

3. (Optional) In order to verify that database objects can be created by the new
login and user, connect to the database server using RPA’s newly created
login role credentials and run:

<installation folder>/central/bin/sql/PostgreSQL/postgres_create_test_table.sql

Verify that the script ran correctly and that no errors are shown.

Manually create database objects

Once the database and role are in place, the database objects (tables, indexes,
and so on) are created when the RPA service starts and connects to the database
for the first time.
To manually create the database objects (instead of the RPA service):

1. Extract the postgres.sql file from the RPA installation zip file under docs\sql.

2. Connect to the RPA database as the RPA database user.

3. Run the postgres.sql file and verify that no errors occurred.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 118
Robotic Process Automation 2019.11

PostgreSQL database maintenance


This section describes the maintenance tasks that Micro Focus recommends for keeping in good shape the Robotic
Process Automation (RPA) databases created on a Postgres server.

Back up the RPA database


You can back up a Postgres database using several tools, such as the pg_dump or pg_backup script. You can
back up the RPA database using any type of method/tool as long as the complete database is backed up.
Consider the following guidelines when you create your backup plan for RPA:

Backup method: The backup method depends mainly on business considerations—how much information
”may” be lost? What is the maximum time for system recovery? If you need to be able to perform point-in-time
recovery, and only “allow” a few hours-worth of data loss, use the full recovery model and perform full or
differential backups daily, and transaction log backup every N hours depending on your business requirements. If
your organization is more tolerant to data loss, you can use the simple recovery model and perform a daily or
weekly full backup.
Backup frequency: Daily backup is recommended, especially if you are using/modifying RPA on a daily basis.
You should back up once a month at the very least.
Timing: Schedule backup for the time when RPA is least active.
Retention: Retention depends on your business guidelines and regulations.

Monitoring database size

Micro Focus highly recommends that you track your database size to make sure old, irrelevant information is
periodically purged or removed. For more information, see Performance and sizing information.

Maintain indexes
To keep the RPA Postgres database in good shape, use table REINDEX.

Scheduling the maintenance

Micro Focus recommends that you run the REINDEX action during a system maintenance window.

This operation locks tables. Reindex only during the maintenance window when
the RPA system is not active.

Reindex example

Here is an example of how to REINDEX a complete database using the reindexdb utility: reindexdb -d

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 119
Robotic Process Automation 2019.11

RPAdatabase –U RPAusername–W RPADBuserpassword


Micro Focus recommends that you do not to provide the password explicitly. See the Postgres documentation for
recommendations on how to secure database passwords.

Purge historical data


Before installing the procedures, you must make sure to run the create purge tables script to create all the tables
required by the procedures. The script is located in the same folder as the procedures.

Collect historical data


The RPACollectHistory procedure collects information about historical data and stores is in specific external
tables. Historical data is any data that exceeds your specified retention period and should be deleted. You can run
RPACollectHistory as a standalone procedure or call it automatically from the RPAPurgeHistoryExt procedure.
This procedure alone does not delete any historical data from the RPA database.
To install and use the RPACollectHistory stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run the RPA_DB_Maint.pks file, then the RPA_DB_Maint.pkb file. Check that the new package and procedures
have been created successfully.

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_RPACollectHistory.sql script. Before executing the script, you can tune the
procedure according to the parameters below.

Parameters for tuning the RPACollectHistory stored procedure:

pCollectDataOlderThan: specifies the number of days to keep the execution data. This time value is relative to
'now'. This parameter is mandatory and does not have a default value.
pCollectDataInBatchesOf: determines how many rows to handle at a time. Default is the minimum value of
1,000,000. Maximum value is 10,000,000.
pStopCollectingAfter: specifies the maximum number of hours that the procedure can run. The default value is
four hours.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 120
Robotic Process Automation 2019.11

pCollectLimit: limits the number of rows into which data is collected, based on the RPA_STEP_LOG_STARTED
table. This enables the purge procedure to delete small batches of data quickly. The default value is 0—Collect
everything that qualifies. The minimum value for restriction is 100,000. Default value is 1,000,000. Maximum
value is 10,000,000.

Delete historical data


The RPAPurgeHistoryExt procedure deletes historical RPA data. Unlike the deprecated RPAPurgeHistory
procedure which stored data marked for deletion in memory structures, the RPAPurgeHistoryExt procedure
stores this data in external tables. This allows timed out purged events to continue or to collect new data and start
from scratch with the new batch of data Not continuing timed out procedures may create orphan records.
To install and use the RPAPurgeHistoryExt stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run the RPA_DB_Maint.pks file, then the RPA_DB_Maint.pkb file. Check that the new package and procedures
have been created successfully.

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_RPAPurgeHistoryExt.sql script. Before executing the script, you can tune the
procedure according to the parameters below.

Parameters for tuning the RPAPurgeHistoryExt stored procedure:

pCollectDataOlderThan: specifies the number of days to keep the execution data. This time value is relative to
'now'. This parameter is mandatory and does not have a default value.
pCollectDataInBatchesOf: determines how many rows to handle at a time. Default is the minimum value of
1,000,000. Maximum value is 10,000,000.
pShouldPurgeExecutionSummary: specifies whether to purge the RPA_EXECUTION_SUMMARY table. The
default value is 0⁠—Do not purge this table.
pContinueOldPurge: instructs the procedure to continue deleting data from a previous run of the purge
procedure that has timed out, instead of collecting new data for deletion. This parameter is valid only for the
RPAPurgeHistoryExt procedure, and is not available for the deprecated RPAPurgeHistory procedure.
Accepted values are: 0—OFF, 1—ON.
pStopPurgingProcessAfter: specifies the maximum number of hours that the procedure can run. The default

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 121
Robotic Process Automation 2019.11

value is four hours.


pDelayInMillisecPerBatch: sets a delay between delete batches. This reduces resource contention between
the purge procedure and regular RPA processes. Delays allow other transactions to complete in between delete
operations.
pCollectLimit: limits the number of rows into which data is collected, based on the RPA_STEP_LOG_STARTED
table. This enables the purge procedure to delete small batches of data quickly. The default value is 0—Collect
everything that qualifies. The minimum value for restriction is 100,000. Default value is 1,000,000. Maximum
value is 10,000,000.

Deep Clean
The RPADeepClean procedure extracts the Deep Clean functionality from the deprecated RPAPurgeHistory
procedure and runs it as a standalone process. This procedure deletes orphaned records from the RPA step log
tables. Similarly to the RPAPurgeHistoryExt, the RPADeepClean procedure uses external tables to store
information about data to be deleted. You cannot run this procedure at the same time with the
RPAPurgeHistoryExt procedure. This procedure does not affect data collected by the RPAPurgeHistoryExt
procedure.
To install and use the RPADeepClean stored procedure:

1. Log in to Oracle as the RPA database user.

2. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

3. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

4. Open <your temporary folder>\RPA_DB_Maintenance\Oracle\2019.11

5. Run the RPA_DB_Maint.pks file, then the RPA_DB_Maint.pkb file. Check that the new package and procedures
have been created successfully.

6. Run the create_purge_tables.sql script to generate the necessary tables in the RPA database.

7. Execute the oracle_execute_RPADeepClean.sql script. Before executing the script, you can tune the
procedure according to the parameters below.

Parameters for tuning the RPADeepClean stored procedure:

pPurgeExecutionsInBatchesOf: determines how many rows to handle at a time. Default is the minimum value
of 1,000,000. Maximum value is 10,000,000.
pStopPurgingProcessAfter: specifies the maximum number of hours that the procedure can run. The default
value is four hours.
pContinueOldPurge: instructs the procedure to continue deleting data from a previous run of the purge

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 122
Robotic Process Automation 2019.11

procedure that has timed out, instead of collecting new data for deletion. This parameter is valid only for the
RPADeepClean procedure, and is not available for the deprecated RPAPurgeHistory procedure. Accepted
values are: 0—OFF, 1—ON.
pDelayInMillisecPerBatch: sets a delay between delete batches. This reduces resource contention between
the purge procedure and regular RPA processes. Delays allow other transactions to complete in between delete
operations.

Clear old execution plans


To install and use the RPA Execution Plans stored procedure:

1. Go to the RPA Database Maintenance product page on the ITOM Marketplace and expand the relevant
product version.

2. Download the RPA_DB_Maintenance.zip file and unpack it to a temporary folder.

3. Open the PostgreSQL folder and select the folder corresponding to your version of RPA.

4. Log in to PostgreSQL as the RPA database user.

5. Run the RPAPurgePlans.sql script and verify that the new function has been created successfully. Before
executing the script, you can tune your procedure according to the parameters below. The description of
these parameters is also embedded as comments in the script.

The following example shows how to add these parameters to the stored procedure (from left to right):

SELECT FROM RPAPURGEPLANS(10000,4,0);

Parameters for tuning the RPA Execution Plans procedure

pPurgeExecutionsInBatchesOf: determines how many flows are handled together. Smaller values imply
smaller, more frequent transactions. Higher values imply less frequent, larger transactions. The recommended
value for most systems is 10000.
pStopPurgingProcessAfter: specifies the timeout in hours for the operation to complete. Set this according to
your maintenance schedule.
pSleepInterval: specifies number of seconds to sleep between batch iterations. By default, this is set to 0—No
Delay.

Release unused large objects


The RPA database uses OID datatypes for some of the tables. When the references to OID are deleted, PostgreSQL
does not automatically remove the corresponding data from the pg_largeobject internal table.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 123
Robotic Process Automation 2019.11

To clear this data, invoke the vacuumLO utility included in PostgreSQL:

1. Log in to the database server and locate PostgreSQL's bin folder.

2. From the Windows Command Prompt or the Linux shell, run the following command at the bin folder :
vacuumlo -U postgres -W -v oo database name

Arguments for the vacuumLO utility

The arguments for this command are case sensitive and do the following:

-U: specifies the username that will execute the utility. This must be an administrative user with
access to both the largeobjects table and to the RPA database. The postgre user in the example
above is the default administrator user for PosgreSQL databases.
-W: instructs vacuumLO to prompt for the user's password. Vacuumlo will automatically prompt for a
password if the server demands password authentication. However, on some versions of PostgreSQL,
the utility fails due to invalid credentials if this parameter is omitted.
-v: writes the progress messages as the utility is running. This argument is optional.

Finalize the vacuum process

After the execution of the purge procedure, the vacuum process usually springs into action and starts “vacuuming”
tables and indices.
Allow the vacuum process to complete successfully before starting another purge. If the purge and vacuum
overlap, they stall each other as they compete for object locks.
The freed up space becomes available after the next PostgreSQL event. If you want to make this space available
for reuse immediately after running vacuumlo, run the postgresql VACUUM command from the pgsql command
line or from pg admin.

Upgrade prerequisites
Prior to any upgrade of RPA, take the following steps:

1. Purge non-essential data from the database. The upgrade operations convert flow execution data. Less data
means a shorter upgrade. If all flow execution data is essential, perform a complete database backup first
and then purge.

2. Verify that you have sufficient disk space to support a “vacuum full" operation, and initiate a “vacuum full”
operation.

3. Back up your database, preferably after the database was purged.

4. Schedule the operation to the database server’s quiet period.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 124
Robotic Process Automation 2019.11

5. Verify that sufficient free disk space is available for transaction log files.

Post-upgrade steps
Following any upgrade of RPA, take the following steps:

1. Install the relevant version of the purging stored procedure. Stored procedures and purge flows are not
upgraded by the RPA upgrade utility.

2. Reschedule the database purge routines (stored procedure and/or purge flows).

3. Reschedule the routine database “vacuum full” operations.

Related topics
Set up database environment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 125
Robotic Process Automation 2019.11

Installation Wizard Other database option


This topic contains information about the Other database option in the RPA installation wizard.
This option enables using specific JDBC driver and connection options. Use this option if:

You want to use a different version of the JDBC driver, other than the ones provided in the RPA installation (see
the note below).
You want to provide a JDBC connection URL yourself, to include an option or options which are not currently
provided by the standard database connection options.
NOTES:

Connection is restricted to the types and versions of database described in the "Overview" topic of Prepare the
database environment topic.
Use a non-provided JDBC driver at your own risk. The following JDBC drivers are supported:

jtds-1.3.0.jar – for SQL Server 2012


sqljdbc4-4.2.jar – for SQL Server 2014 or later
ojdbc7-12.1.0.2.jar
postgresql-9.4.1207.jar
When you install RPA using the Other database option, the installation wizard does not create the database
and/or related user or roles. You must create these beforehand, using the installation wizard. Detailed instructions
on how to create the database/user/role can be found in this document, under the “Manually Creating an RPA
Database” section in each database topic.

Microsoft SQL server named instance example


SQL Server 2012
The following example show a connection to a Microsoft SQL Server Named Instance using jtds JDBC Connector.
The database, login role, and user are pre-created by the DBA, and the login role is the owner of the database (has
full DML and DDL privileges).
Use the following details in the installation wizard, and revise the highlighted values to match your environment.
Use JDBC URL Option #1 when a unique TCP port is assigned to each instance.
Use JDBC URL Option #2 when Database Browser :service is active and is able to route connections based on
the instance name. Note that TCP port number does not appear in this option.

Field Value Comments

JDBC Driver C:\my\path\jtds-1.3.0.jar


jar

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 126
Robotic Process Automation 2019.11

Field Value Comments

JDBC Driver net.sourceforge.jtds.jdbc.Driver


class name

JDBC URL jdbc:jtds:sqlserver://<DB_IP_OR_HOSTNAME>:<DB_PORT>/<DB_


Option #1 NAME>;instance=<INSTANCE_ NAME>;sendStringParametersAsUnicode=true

JDBC URL jdbc:sqlserver://<DB_IP_OR_HOSTNAME>:<INSTANCE_


Option #2 PORT>;databaseName=<DB_ NAME>;sendStringParametersAsUnicode=true

Username <LOGIN_ROLE>

Password <LOGIN_ROLE_PASSWORD>

SQL Server 2014 or later


The following example show a connection to a Microsoft SQL Server Named Instance using Microsoft JDBC
Connector. The database, login role, and user are pre-created by the DBA, and the login role is the owner of the
database (has full DML and DDL privileges).
Use the following details in the installation wizard, and revise the highlighted values to match your environment.
Use JDBC URL Option #1 when a unique TCP port is assigned to each instance.
Use JDBC URL Option #2 when Database Browser service is active and is able to route connections based on the
instance name. Note that TCP port number does not appear in this option.

Field Value Comments

JDBC Driver C:\my\path\sqljdbc4-4.2.jar


jar

JDBC Driver com.microsoft.sqlserver.jdbc.SQLServerDriver


class name

JDBC URL jdbc:sqlserver://<DB_IP_OR_HOSTNAME>:<INSTANCE_ INSTANCE_PORT


Option #1 PORT>;databaseName=<DB_ represents the
NAME>;sendStringParametersAsUnicode=true separate instance

JDBC URL jdbc:sqlserver://<DB_IP_OR_HOSTNAME>;instanceName= If Database Browser


Option #2 <INSTANCE_NAME>;databaseName= service is active
<DB_NAME>;sendStringParametersAsUnicode=true

Username <LOGIN_ROLE>

Password <LOGIN_ROLE_PASSWORD>

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 127
Robotic Process Automation 2019.11

Microsoft SQL server Windows authentication example


SQL Server 2012
The following example shows a connection to a Microsoft SQL Server using Windows Authentication and jtds JDBC
connector. The database is pre-created by the DBA, and the Windows login account is the owner of the database
(has full DML and DDL privileges).
Use the following details in the installation wizard, and revise the highlighted values to match your environment:

Field Value Comments

JDBC C:\my\path\jtds-1.3.0.jar Use jtds


Driver jar JDBC driver
only

JDBC net.sourceforge.jtds.jdbc.Driver
Driver
class
name

JDBC URL jdbc:jtds:sqlserver://<DB_IP_OR_HOSTNAME>:<DB_PORT>/<DB_NAME>;domain=<DOMAIN_NAME>;sendStringParametersAsUnicode=true

Username <WINDOWS_USERNAME>

Password < WINDOWS_USERNAME_PASSWORD>

Note Ignore the error regarding incompatible collation, but make sure to set your
collation to one of the supported collations described in the “Language support”
topic in "Prepare the database environment" section.

It is recommended but not required, that RPA Central service(s) is run as the same user that is used for database
authentication. Note that using a domain account for authentication may enforce security policies that may change
from time to time by the domain administrator.
Whenever the domain account password changes, the new password must be encrypted and the new encrypted
password must be placed in the database.properties file located under <RPA installation>/central/conf. If an
RPA cluster is used, this operation must be repeated for all RPA Central servers.
SQL Server 2014 or later
The following example show connection to a Microsoft SQL Server 2014 (or newer) using Windows Authentication
and Microsoft JDBC Connector.
Prerequisites:

1. The database is pre-created by the DBA

2. The relevant Windows account is the owner of the database (has full DML and DDL privileges)

3. RPA’s installation wizard must be unzipped and extracted to a folder form

4. sqljdbc_auth.dll must be downloaded and copied to RPA’s installation wizard under


<installer_folder>\java\bin. This dll file is not provided along with the RPA installation and is available for
download from Microsoft web site. Download Microsoft JDBC 4.2 and extract 64bit version of

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 128
Robotic Process Automation 2019.11

sqljdbc_auth.dll.

Installation steps:

1. Run the RPA installer by executing <installer_folder>\installer.bat as the same Windows account that
owns the RPA database.

2. In the Connectivity page, select the Do not start central server after installation… checkbox.

3. In the Database Connection page select the Other database option and fill in the details according to the
table below. Edit and replace highlighted parts with actual values.

4. After the installation:

a. Verify sqljdbc_auth.dll is located in <central installation>\java\bin.

b. Configure the service to run under the same Windows account that owns the RPA database.

c. Start the RPA service and verify successful connection to the database.

Repeat the steps above for all central server installations


Use the following details in the installation wizard, and revise the highlighted values to match your environment:

Field Value Comments

JDBC C:\my\path\sqljdbc4-4.2.jar
Driver jar

JDBC com.microsoft.sqlserver.jdbc.SQLServerDriver
Driver
class
name

JDBC URL jdbc:sqlserver://<DB_IP_OR_HOSTNAME>:<DB_PORT>;databaseName=<DB_NAME>;integratedSecurity=true;sendStringParametersAsUnicode=true

Username Fully qualified Windows account: DOMAIN\USERNAME

Password DOMAIN\USER PASSWORD-

Note Ignore the error about incompatible collation, but make sure to set your
collation to one of the supported collations described in the “Language support”
topic in "Prepare the database environment" section.

Using a domain account for authentication may enforce security policies that may
change from time to time by the domain administrator.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 129
Robotic Process Automation 2019.11

Oracle RAC example


The following example shows a connection to an Oracle RAC cluster using explicit JDBC URL. The database (user)
must be pre-created by the DBA, and must be granted DML and DDL privileges.
Use the following details in the installation wizard, and revise the highlighted values to match your environment:

Field Value Comments

JDBC C:\my\path\ojdbc7-12.1.0.2.jar
Driver jar

JDBC oracle.jdbc.OracleDriver
Driver
class
name

JDBC URL jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=on)(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=Server1_VIP)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=Server2_VIP)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RAC1.MY.DOMAIN)))

Username <PRE-CREATED-DATABASE>

Password < PRE-CREATED-DATABASE-PASSWORD>

Related topics
For more information on preparing the database environment, see Prepare the database environment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 130
Robotic Process Automation 2019.11

Database purging

Purge flows
Purge flows are provided as content in the Micro Focus Solutions content pack, and are the preferred method for
purging the RPA database. As long as purge flows provide sufficient “throughput” (are able to delete a sufficient
amount of rows in a given amount of time), it is recommended to use them instead of the purge stored procedures.
Purge flows have several advantages over stored procedures:

Manageability – The RPA administrator can easily schedule and track purge operations.
Database privileges – No need for assistance from the DBA in installing and scheduling purge operations.
Purge functionality upgrades – When RPA is upgraded, and a new table requires purging, this capability will be
added to an existing flow or a new one will be created for that purpose.

New stored procedures, however, must be manually downloaded and installed.

Note For each purge type (rerun, steplog, and so on), you can only run one
purge flow at a time.

Purge best practices


Relating to purge operations, it is important to distinguish between two separate criteria:

Retention – the age of the data you wish to keep


Purge frequency – how often the purge operations are executed
These two criteria are completely unconnected. You can keep one years worth of data, while purging every 30
minutes.
As the retention period is often determined as a tradeoff between database size and business requirements, the
purge frequency can vary between hourly, daily, or even weekly. The recommended purge frequency is between
“hourly” and “daily”.
Purging smaller amounts of data frequently proves (in most cases) to be a better strategy than purging large
amounts of data during a weekly or monthly maintenance window.
Here is a suggested workflow for optimizing purge frequency:

Schedule a recurring purge operation for every four hours and monitor it:

How long does it take for the purge operation to complete (average and max. duration)?
What was the effect on database performance?

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 131
Robotic Process Automation 2019.11

What was the effect on Robotic Process Automation’s performance (user interface and flow execution)?
As long as purge operations complete in under 30 minutes and no dramatic effect was registered by the DBA or
the database, keep this frequency.

You may also try frequencies from hourly to daily and see which works best.

Note that some effect on the database and RPA is considered normal.

Otherwise, if RPA's activity changes considerably throughout the day, and consistent “quiet periods” exist,
schedule purge operations to run during these periods.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 132
Robotic Process Automation 2019.11

Set up database environment for RPA Workflow


Designer
This section shows the database administrator how to configure four different types of database, to be used with
RPA Workflow Designer.
Setting up and maintaining the database is important in order to maintain the efficiency and throughput of RPA
Workflow Designer.

Prepare the database environment


Deploy and maintain a Microsoft SQL server database
Deploy and maintain an Oracle database
Deploy and maintain a Postgres database
Installation wizard Other database option

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 133
Robotic Process Automation 2019.11

Prepare the database environment


This section is intended for trained database administrators. If you are not familiar with the type of database you
wish to use, or you feel that you lack the relevant knowledge required in order to create and configure an RPA
Workflow Designer database, see the database vendor’s documentation and make sure you fully understand each
action you perform as described in this section.
This section also contains information about the types of databases used with RPA Workflow Designer and
describes the required database settings. If the settings are not specified you can leave the default values or
continue with those configured by your organization's DBA.

Overview
The term “database” may be interpreted in several ways, depending on the database vendor/technology used. In
Oracle, the term “database” relates to a collection of files containing data and metadata. A single Oracle database
may contain one or more schemas (and users). A Microsoft SQL Server “database” is closer in definition to Oracle’s
"schema" than to Oracle’s "database".
In order to avoid confusion, this topic will use the following terms:

Instance/server – the software and memory structures providing RDBMS services


Database – the entity containing tables, views, indexes, and so on.
RPA Workflow Designer requires a single database to be created. This database may co-exist with other databases
contained in a database server.
You can set up an RPA Workflow Designer database on one of the following database server types:

1. Microsoft SQL Server Standard/Enterprise (2012/2014/2016/2017)

2. Oracle 11gR2 Standard/Enterprise Server, including RAC environment

3. Oracle 12cR1 Standard/Enterprise Server (regular or CDB) including RAC environment and Oracle 12cR2
Standard/Enterprise Server - regular instance or CDB.

4. PostgreSQL (9.4/9.5/9.6/10)

Hardware requirements
The following table describes the hardware (CPU and memory) requirements recommended for the each of the
database servers.

Note
The memory values reflect database memory consumption as part of the entire

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 134
Robotic Process Automation 2019.11

machine’s memory.

Small/Standard Enterprise

CPUs RAM CPUs RAM

Database\Scale Small Standard Min Rec Min Rec Min Rec

SQL Server 2 4 4 GB 8 GB 4 8 GB 4 GB 8 GB

Oracle 2 4 4 GB 8 GB 4 8 GB 4 GB 8 GB

Postgres 2 4 4 GB 8 GB 4 8 GB 4 GB 8 GB

Min = Minimal value, Rec = Recommended value In addition to the generalized hardware requirements above,
refer to the appropriate hardware requirements and software requirements sections per database.

Use database clusters


Database clusters help to make the RPA Workflow Designer system more robust, by protecting the database from
several types of failures. RPA Workflow Designer does not provide database cluster-related features of its own,
such as database connection failover. It relies on the functionality of the JDBC package being used, and the
database cluster environment capabilities, such as SCAN/AG listeners. You can install RPA Workflow Designer in
conjunction with any type of database cluster environment that satisfies the following conditions:

Connection pooling is supported


A single, valid database URL can be provided
It provides reliable transaction handling during failover (a single, complete transaction must either completely
fail or succeed)
The RPA Workflow Designer installer does not provide database cluster-specific installation options. During
installation, you need to provide the installer a simplistic / "regular" form of database connection. Database URL
adaptations usually have to be made after the system is already installed in the database.properties
configuration file.

Database security
The RPA Workflow Designer database is at the heart of the RPA Workflow Designer system, containing the RPA
Workflow Designer system configuration and possibly corporate-sensitive data. It is highly recommended that you
enforce strict security settings on your database by following these guidelines. Harden your database server by
following the recommendations from the database vendor and the operating system vendor. Server hardening may
include, among other items:

Restrict SSH access on Linux servers to a well-controlled set of OS users


Enforce a strict OS user password policy – password length, complexity, lockout-policy, and so on
Set up an audit system to detect and report break-in attempts
Harden your database user/login accounts:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 135
Robotic Process Automation 2019.11

Enforce the password policy – password length, complexity, lockout-policy, and so on


Restrict access to administration-level accounts
Set up an audit system to detect and report break-in attempts
Database encryption at file-system level is supported as long as it does not compromise RPA Workflow Designer’s
performance, and is completely transparent to RPA Workflow Designer. For example, Oracle TDE may be used as
long as it does not cause any performance degradation or prevent LOB free-space reclamation.

Database sizing
RPA Workflow Designer keeps all content and configuration data in the database. This topic will help you prepare
for installing RPA Workflow Designer. By estimating your system scale (small/standard/enterprise), you will be able
to derive the amount of disk space required, derive the amount of memory (RAM) used by the database, and
determine additional database installation parameters. Estimate the system scale:

System Criteria\Scale Small Standard Enterprise

Number of content packs* 1-9 10 - 49 50 or more

Number of users** 1-9 10 - 49 50 or more

* Number of content packs refers to the number of distinct items in the OOST_CONTENT_ITEMS table
(and satellite tables).

** Number of users means the number of workspaces, projects, and so on. This is assuming that every
user has 10 workspaces.

The following table provides disk space and memory requirements for different RPA Workflow Designer deployment
scales:

System Scale\Parameter Database Disk Size Requirements Memory

Small 10 GB 4 GB

Standard 50 GB 8 GB

Enterprise Between 50 and 100 GB 12 GB

Notes

Disk space and memory values are estimates. Actual disk space and memory
consumption vary, depending on the database vendor and database server
configuration.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 136
Robotic Process Automation 2019.11

Memory (RAM) reflects recommended database memory, not the overall amount
of memory available on the database machine (virtual or physical server).
Disk space reflects the amount of disk space required for day-to-day operation of
the RPA Workflow Designer system and reasonable historical data retention—not
including long-term database backups.
The amount of additional disk space required for keeping RPA Workflow Designer
database backups depends on the backup policy (frequency and retention
period).

Related topics
To deploy and maintain a Microsoft SQL server database for RPA, see Deploy and maintain a Microsoft SQL
server database
To deploy and maintain a Oracle database for RPA, see Deploy and maintain an Oracle database
To deploy and maintain a PostgreSQL database for RPA, see Deploy and maintain a PostgreSQL database

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 137
Robotic Process Automation 2019.11

Deploy and maintain a Microsoft SQL server


database
In order to deploy RPA Workflow Designer using Microsoft SQL Server, you must have an existing SQL Server
database service. If you need to create a new database service, see the relevant documentation provided by
Microsoft, because this information is not included within this section. However, this section contains
recommendations for the SQL Server configuration. It is also recommended to use the SQL Server Agent service in
order to comfortably schedule index maintenance jobs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 138
Robotic Process Automation 2019.11

Workflow for Microsoft SQL Server Deployment


To deploy RPA Workflow Designer using Microsoft SQL Server, perform the following steps:

1. Review sizing guidelines.

2. Review Hardware and Software Requirements.

3. Configure Microsoft SQL Server.

4. Create an RPA Workflow Designer database on Microsoft SQL Server.

5. (Optional) Set up Windows authentication. This step is only relevant if you are using Windows
authentication instead of SQL Server authentication.

Related topics
Prepare the database environment
System requirements for Microsoft SQL server
Configure SQL server
Manually Create an RPA Workflow Designer database on Microsoft SQL s8.NGerver

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 139
Robotic Process Automation 2019.11

System Requirements for Microsoft SQL Server

This section describes the system requirements for working with Microsoft SQL Server in conjunction with RPA
Workflow Designer.

Hardware requirements
For RPA Workflow Designer database sizing guidelines and hardware requirements, see Prepare the database
environment section. For Microsoft SQL Server hardware requirements, see the relevant installation guide for your
Microsoft SQL server release and operating system.

Software requirements
The following table lists the Microsoft SQL Server releases supported by RPA Workflow Designer:

Microsoft SQL Server Database Releases

Version Type 32/64Bit Service Pack

2017 Standard 64Bit CU1

Enterprise 64 Bit CU1

2016 Standard 64 Bit 1

Enterprise 64 Bit 1

2014 Standard 64 Bit 1

Enterprise 64 Bit 1

2012 Standard 64 Bit 2

Enterprise 64 Bit 2

See the Microsoft documentation for supported platforms.

Examples of tested deployments


The following table lists the deployment environments that have been rigorously tested by Micro Focus quality
assurance personnel.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 140
Robotic Process Automation 2019.11

Database Release

Version 32/64Bit Service Pack Operating System

Microsoft SQL Server 2017 Enterprise 64 Bit CU1 Windows 2012 R2 Standard Edition 64
Edition Bit

Microsoft SQL Server 2016 Enterprise 64 Bit 1 Windows 2016 Standard Edition 64 Bit
Edition

Microsoft SQL Server 2014 Enterprise 64 Bit 1 Windows 2012 Standard Edition 64 Bit
Edition

Microsoft SQL Server 2012 Enterprise 64 Bit 2 Windows 2012 Standard Edition 64 Bit
Edition

Language support
In Microsoft SQL Server, unlike other databases, RPA Workflow Designer database does not use Unicode collation.
Use one of the following collations depending on your RPA Workflow Designer installation language:

Language Database Collation

English SQL_Latin1_General_CP1_CS_AS

Japanese Japanese_Unicode_CS_AS

Simplified Chinese Chinese_Simplified_Stroke_Order_100_CS_AS

NOTE:
When an MS SQL database is created with a case-sensitive collation, object names
such as tables, keys, and so on become case-sensitive as well.
For example, for the MY_TABLE_STEP_LOG_BINDINGS table, a command such as
SELECT * FROM my_table_step_log_bindings is seen as using an invalid object
name.

Related topics
Configure SQL server
Manually create an RPA Workflow Designer database on Microsoft SQL server
Microsoft SQL server database maintenance

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 141
Robotic Process Automation 2019.11

Configure SQL server

This topic contains information on Microsoft SQL Server and database configuration settings. You can install an RPA
Workflow Designer database in any SQL Server environment including clustered environments. Legend:

Mandatory configuration options/values appear in bold font.


Recommended configuration options/values appear in bold font.
Supported configuration options/values appear in normal font, and may show as a comma-separated list.
Comments appear in italic font.

Microsoft SQL Server 2012, 2014, 2016, and 2017 IDM database

Server Options/Features

Configuration Item Supported Configuration Options

Server Configuration Options Defaults, unless instructed otherwise

Instances Default, Single

Authentication Mode Mixed, Windows 1

Full-Text Search (Not required for RPA Workflow Designer)

[1] At the moment, the RPA Workflow Designer installer supports only SQL authentication. Windows authentication
can be configured afterward.

Microsoft SQL Server 2012, 2014, 2016, and 2017 IDM database

Instance/Server Options

Mandatory Recommended Supported

Server SQL_Latin1_General_CP1_CS_AS Any Collation. For IDM database (IDM


Collation Service), the collation must be case
insensitive. For example,
SQL_Latin1_General_CP1_CI_AS.

Network Server:
Libraries TCP/IP Client:
TCP/IP

Concurrent >= 800 0 (unlimited)


Connections

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 142
Robotic Process Automation 2019.11

Max Server > 4GB 2,147,483,647 (default, unlimited)


Memory Allocate 4-12 GB depending on
system scale

Microsoft SQL Server 2012, 2014, 2016, and 2017 IDM database

Database Options

Mandatory Recommended Supported

Collation Any collation listed in the


“Language support” in System
requirements for Microsoft SQL
server topic.

Recovery Model Full Simple, Full

Allow Snapshot Isolation True

Is Read Committed Snapshot On True

Auto Shrink False

Auto Create Statistics True

NOTE:
SQL Server does not use READ-COMMITTED transaction isolation by default. It is
mandatory to set the Allow Snapshot Isolation and Is Read Committed
Snapshot On flags. RPA Workflow Designer fails to operate properly using any
other type of transaction isolation.

Related topics
System requirements for Microsoft SQL server

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 143
Robotic Process Automation 2019.11

Manually create an RPA Workflow Designer


database on Microsoft SQL server
This topic describes the procedure for manually creating an RPA Workflow Designer database, login, and user on
Microsoft SQL Server. During RPA Workflow Designer setup, a new database can be created automatically by the
RPA Workflow Designer installer or an existing database can be used. If during installation, you are authorized to
connect to the database server as sysadmin (that is, connect as “sa”), use the installer's “Create the
database/schema” option, and you can skip this section.

NOTE:
Only the database, login and user are created at this point; objects such as tables
and indexes are not created yet. These objects are created once RPA Workflow
Designer starts for the first time.

This topic is relevant for you if, for example, due to security restrictions, you do not wish to use login/user
credentials with elevated privileges during the RPA Workflow Designer installation. In such a case, you (or your
organization’s DBA) should create the database, login, and user first, and then let the RPA Workflow Designer
installer connect to the pre-existing database using “lower” privileges. To create a database, you must connect to
the SQL Server instance using a login that has CREATE DATABASE permission.

NOTE:

Members of the sysadmin server roles automatically have CREATE DATABASE


permission, and are also mapped to dbo in all databases.
Perform the following procedures only if you are an experienced Microsoft SQL
Server database administrator.
If you prefer to use the database creation wizard/GUI, make sure you select all
options that correspond with the T-SQL code presented below. For example,
make sure you set Allow Snapshot Isolation to TRUE under the Options
page/Other Options pane/Miscellaneous tab in the New Database dialog box.
Not all database creation options are specified—only those that differ from the
default value. When in doubt, use default values.

To create a database:

1. Log in to Microsoft SQL Server as “sa” or any other login with a sysadmin role or the CREATE DATABASE
permission.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 144
Robotic Process Automation 2019.11

2. Run <installation folder>/designer/bin/sql/MS-SQL/mssql_create_ws_db.sql and verify that the database,


login, and user were created successfully. Adapt the script parameters to match your environment.

3. (Optional) In order to verify that database objects can be created by the new login and user, connect to the
database server using the newly created login role credentials and run <installation
folder>/designer/bin/sql/MS-SQL/mssql_create_test_table.sql.

Verify that the script ran correctly and that no errors are shown.

Manually create database objects


Once the database, login, and user are in place, the database objects (tables, indexes, and so on) are created
when the RPA Workflow Designer service starts and connects to the database for the first time. You could create
the database objects manually if the user created for RPA Workflow Designer does not have permissions to create
or modify database objects (limited to DML operation only). It is highly recommended to grant the RPA Workflow
Designer database user DDL-related privileges, in order to allow RPA Workflow Designer to perform upgrade
operations without manual intervention, as these operations sometimes require modifications to the database
structure. To manually create the database objects:

1. Extract the mssql.sql files from the RPA Workflow Designer installation zip file under docs\sql.

2. Log in to Microsoft SQL Server as the relevant user, who is permitted to create and modify database objects
in the RPA Workflow Designer database.

3. Run the mssql.sql file and verify that no errors occurred.

Related topics
Workflow for Microsoft SQL Server Deployment
System Requirements for Microsoft SQL Server
Configure SQL server
Microsoft SQL server database maintenance

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 145
Robotic Process Automation 2019.11

Microsoft SQL server database maintenance

This topic describes the various maintenance tasks that are recommended for RPA Workflow Designer databases
created on Microsoft SQL server, such as backing up the database, checking database integrity, handling index
fragmentation, and monitoring the database.

Backing up the RPA Workflow Designer database


Microsoft SQL Server databases are either configured for the Full recovery model, or the Simple recovery model.
You can back up an RPA Workflow Designer database using either one of these models. As RPA Workflow Designer
keeps all configuration and data in a single database, always backup the complete database.
Consider the following guidelines when you create your backup plan for RPA Workflow Designer:
Backup method:
The backup method depends mainly on business considerations—how much information ”may” be lost? What is
the maximum time for system recovery? If you need to be able to perform point-in-time recovery, and only “allow”
a few hours-worth of data loss, use the full recovery model and perform full or differential backups daily, and
transaction log backup every N hours depending on your business requirements.
If your organization is more tolerant to data loss, you can use the simple recovery model and perform a daily or
weekly full backup.
Backup frequency:
Daily backup is recommended, especially if you are using/modifying RPA Workflow Designer on a daily basis.
You should back up once a month at the very least.
Timing:
Schedule backup for the time when RPA Workflow Designer is least active.
Retention:
Retention depends on your business guidelines and regulations.

Create a maintenance plan


Maintaining an RPA Workflow Designer database includes rebuilding the index and reclaiming free space. Use the
scripts and tools described in this section, in order to keep the RPA Workflow Designer database in good shape.
Utilities for RPA Workflow Designer Database Housekeeping

NOTE:
SQL scripts are also available in the RPA Workflow Designer installation under the
designer/bin/sql folder.
If you are copying SQL scripts from this document, note that you may need to
remove redundant line breaks from the copied version.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 146
Robotic Process Automation 2019.11

It is recommended to perform index maintenance on a regular basis.


Note that index rebuilding online (without RPA Workflow Designer system downtime) requires an enterprise grade
database. Make sure you are running an enterprise version of Microsoft SQL Server before attempting online index
rebuilding.
Also, note that maintenance activity usually consumes additional resources from the database. This is why it is
important to schedule maintenance activity at the times when RPA Workflow Designer is least active.

Always on support
Microsoft SQL Server 2012 “Always On” is supported by RPA Workflow Designer as a legacy client[1] to
implement a high availability and/or disaster recovery solution.
[1] RPA Workflow Designer does not support the “MultiSubnetFailover” feature for SQL Server 2012, and requires
that RegisterAllProvidersIP is set to 0 in the cluster/listener configuration.
Connection to SQL Server 2014 and 2016 "Always On" is supported including the “MultiSubnetFailover” feature,
but have not been certified for RPA Workflow Designer.
High availability setup
As RPA Workflow Designer requires a single point of contact, it is essential that an Availability Group Listener (AG
listener) exist in the high availability setup. RPA Workflow Designer's database connection is defined by a single
URL - containing a single hostname.
Normally, RPA Workflow Designer interfaces with the AG listener in order to connect to the availability group
primary replica (a READ-WRITE capable instance).
In the case of a database failover scenario, while database connectivity is lost, RPA Workflow Designer will
repeatedly attempt to connect to the database until a new READ-WRITE capable instance accepts the connection.
The redirection of the configured database hostname to a different IP address should be done by the AG Listener
and cluster environment.

NOTE:
RPA Workflow Designer has no use for a read-only database (thus, has no use for
read-only routing).

Disaster Recovery Solution


In a disaster recovery setup, RPA Workflow Designer should be halted, reconfigured (i.e, edit the
database.properties file), and then started again once the new database instance is available.

Use Windows authentication to access Microsoft SQL


server databases
Unless configured otherwise, RPA Workflow Designer uses Microsoft SQL Server authentication to access Microsoft
SQL Server databases. Note that the RPA Workflow Designer installer currently does not support using Windows
authentication during RPA Workflow Designer installation. However, Windows authentication can be used once RPA

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 147
Robotic Process Automation 2019.11

Workflow Designer is installed.


This topic describes how to enable RPA Workflow Designer to use Windows authentication to access Microsoft SQL
Server databases.

Configure RPA Workflow Designer to work with


Windows authentication
You can enable RPA Workflow Designer to use Windows authentication instead of Microsoft SQL Server
authentication to access RPA Workflow Designer databases.
To enable RPA Workflow Designer to use Windows authentication to access a Microsoft SQL database:

1. Encrypt the Windows user password using the encrypt-password.bat utility located under
<installation>/designer/bin by running:

encrypt-password.bat --encrypt --password <password>

Save the generated string in order to use it in the next step.

2. Back up your current database.properties file located under <installation>/designer/conf if you have an
existing (usable) database connection.

3. Edit the database.properties file located under <installation>/designer/conf, and change only the
relevant parameter syntax to match the following example.

When copying scripts, note that you may need to remove redundant line breaks
from the copied version.

jdbc.url=jdbc\:jtds\:sqlserver\://[DB_HOSTNAME]\:[PORT]/[DB_NAME]
;sendStringParametersAsUnicode\=true ;domain\=[DOMAIN NAME]

db.username=[USERNAME]

db.password=[the string generated by encrypt-password.bat]

jdbc.url=jdbc\:sqlserver\://[DB_HOSTNAME]\:[PORT];databaseName\=[DB_NAME];sendStringParametersAsUnic
ode\=true;integratedSecurity\=true;

There might be a need to copy sqljdbc_auth.dll to the system path of the RPA Workflow Designer server machine.
For more details, see the Microsoft JDBC documentation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 148
Robotic Process Automation 2019.11

Replace all the highlighted items with the correct values that match your environment.
Note that the jdbc.url parameter is broken in this topic into several lines for readability. When copying this
example onto your database.properties file, remove all line breaks so the jdbc.url parameter is composed of a
single line containing no white spaces.

Configure RPA Workflow Designer to work with Always


On
RPA Workflow Designer connects to SQL Server databases using the Microsoft JDBC 4.2 connector.
Here is an example on how to format JDBC URL in order to connect to an Always On cluster:

db.url=jdbc:sqlserver://[AG-NET-NAME];instanceName=[NAMED-INST-NAME]; databaseName=[DB-
NAME];multiSubnetFailover=true;applicationIntent=ReadWrite; sendStringParametersAsUnicode=true

The multiSubnetFailover and applicationIntent are added in order to allow


more complex behaviors.

The Multi-Subnet Failover scenarios in conjunction with SQL Server 2014 (or
newer) Always On cluster were not certified with RPA Workflow Designer.

For additional information and connection options, refer to "JDBC Driver Support for High Availability, Disaster
Recovery" in the Microsoft documentation and Setting the Connection Properties in the Microsoft JDBC
documentation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 149
Robotic Process Automation 2019.11

Deploy and maintain an Oracle database


In order to deploy RPA Workflow Designer using Oracle, you must have an existing Oracle database service. If you
need to create a new database instance/service, see the relevant documentation provided by Oracle, because this
information is not included within this guide. However, this guide contains recommendations for the Oracle
instance configuration.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 150
Robotic Process Automation 2019.11

Workflow for Oracle deployment


To deploy RPA Workflow Designer using Oracle, perform the following steps:

1. Review sizing guidelines.

2. Review Hardware and Software Requirements.

3. Configure an Oracle Database.

4. Create a Database.

5. (Optional) Connect RPA Workflow Designer to an Oracle RAC environment. This step is only relevant if
you are using RPA Workflow Designer in an Oracle RAC environment.

Related topics
Prepare the database environment
System requirements for Oracle
Configure an Oracle database
Manually Create an RPA Workflow Designer Database on an Oracle instance

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 151
Robotic Process Automation 2019.11

System requirements for Oracle


This topic describes the system requirements for working with Oracle in conjunction with RPA Workflow Designer.

Hardware requirements
For RPA Workflow Designer database sizing guidelines and hardware requirements, see "RPA Workflow Designer
database sizing" and "Hardware requirements” in "Prepare the database environment" section.

NOTE: For Oracle hardware requirements, see the relevant installation guide for
your Oracle release and operating system.

Software requirements
The following table lists the Oracle releases supported by RPA Workflow Designer:

Oracle Releases

Version Type 32/64Bit Patch Set

11g R2 Standard 64 Bit 11.2.0.1 – 11.2.0.4 [1]

Enterprise 64 Bit 11.2.0.1 – 11.2.0.4 [1]

12c R1 Regular instance, non-CDB Standard 64 Bit 12.1.0.1 - 12.1.0.2

Enterprise 64 Bit 12.1.0.1 - 12.1.0.2

The listed patch sets are the minimal patch sets supported. Newer patch sets are also supported unless stated
otherwise in the RPA Release Notes.

NOTE: See the Oracle documentation for supported platforms.

NOTE: Oracle 12c R1 is only supported in its regular, backward-compatible


instance form. RPA Workflow Designer does not support connecting to an Oracle
12c container database (CDB). The Oracle 12c RAC environment is supported in
backward-compatible form. New features such as multiple cluster subnets for
SCAN listener are not supported.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 152
Robotic Process Automation 2019.11

Oracle connector
The jdbc connector .jar fie is not provided with the RPA Workflow Designer installation. You must download it and
place it under each Designer <installation folder>/designer/lib folder. Verify that the connector version you are
using is fully compatible with your database server version. The recommended driver is the Oracle JDBC driver
version 7-12.1.0.2

Examples of tested deployments


The following table lists the deployment environments that have been rigorously tested by quality assurance
personnel.

Database Release

Version 32/64Bit Patch Set Operating System

Oracle 11g R2 Enterprise Edition 64 Bit 11.2.0.4.6 Red Hat Enterprise Linux 6.5 64 Bit

Oracle 11g R2 Enterprise Edition 64 Bit 11.2.0.4.0 Windows 2012 Standard Edition 64 Bit

Oracle 12c R1 Enterprise Edition 64 Bit 12.1.0.2 Red Hat Enterprise Linux 6.5 64 Bit

Oracle 12c R2 Enterprise Edition 64 Bit 12.2.0.2 Oracle Linux 7.3 64 Bit

Oracle 18C 64 Bit 18.3.0.0.0 Oracle Linux 7.3 64 Bit

Language support
The Oracle instance character set should be set to AL32UTF8. This enables using any Unicode character (and
practically all common characters in all languages).

Related topics
Prepare the database environment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 153
Robotic Process Automation 2019.11

Configure an Oracle database


This topic contains information on the Oracle instance and database configuration settings. You can install an RPA
Workflow Designer database in an Oracle clustered environment (Oracle RAC or other). Legend:

Mandatory configuration options/values appear in light/blue font.


Recommended configuration options/values appear in bold/blue font.
Supported configuration options/values appear in normal font, and may show as a comma-separated list.
Comments appear in italic font.

Oracle Database 11gR2 / 12cR1

Instance/Server Options

Instance configuration options Defaults, unless instructed otherwise

Mandatory Recommended Supported

PROCESSES >= 500

SESSIONS >= 555

TIMED_ STATISTICS TRUE TRUE, FALSE

OPEN_CURSORS >= 900

Shared/Dedicated Server Dedicated Dedicated, Shared

UNDO_ MANAGEMENT AUTO Automatic, Manual

Undo size >= 4GB 6GB – 10GB

Memory Management ASMM AMM, ASMM

MEMORY_TARGET 0 (disabled) >= 5G (for AMM)

SGA_TARGET 8G – 12G >= 4G (for ASMM)

SGA_MAX_SIZE 8G – 12G >= 4G (for ASMM)

PGA_AGGREGATE_ TARGET 1G – 2G >= 500M (for ASMM)

Note: All values reflect resources required by RPA Workflow Designer. If RPA Workflow Designer shares the
Oracle instance with other users, these values should be added to whatever is currently consumed by others.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 154
Robotic Process Automation 2019.11

Oracle Database 11gR2 / 12cR1

Instance/Server Options

Mandatory Recommended Supported

File system ASM, Any

Storage options Locally managed tablespace

Automatic segment space management


(ASSM)

Automatic local extent management

ARCHIVELOG mode ARCHIVELOG ARCHIVELOG,


NOARCHIVELOG

Redo Log total size >= 600MB 1GB

Note: All values reflect resources required by RPA Workflow Designer. If RPA Workflow Designer shares the
Oracle instance with other users, these values should be added to whatever is currently consumed by others.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 155
Robotic Process Automation 2019.11

Manually create an RPA database on an Oracle


instance
This topic describes the procedure for manually creating an RPA Workflow Designer database in an Oracle
instance. During RPA Workflow Designer setup, a new database can be created automatically by the RPA Workflow
Designer installer or a pre-existing database can be used. If during installation, you are authorized to connect to
the database server as dba (connect as “SYSTEM”), use the “create the database/schema” option, and you can
skip this section.

NOTE: In some cases, the term "database" is used but in the case of Oracle, it
should be interpreted as "user".

NOTE: Only the database is created at this point; objects such as tables and
indexes are not created yet. These objects are created once RPA Workflow
Designer starts for the first time.

This topic is relevant for you if, for example, due to security restrictions, you do not wish to use user credentials
with elevated privileges during theRPA Workflow Designer installation. In such a case, you (or your organization’s
DBA) should create the user (database) first, and then let the RPA Workflow Designer installer connect to the pre-
existing database using basic privileges. To create a database, you must connect to the Oracle instance using a
login that has CREATE USER system privilege—for example, system user.

NOTE:

Any user with the DBA role has sufficient privileges to create the new user.
Perform the following procedures only if you are an experienced Oracle database
administrator.
If you prefer to use the database creation wizard/GUI, make sure you select all
options that correspond with the SQL code presented below.
Not all database creation options are specified—only those that differ from the
default value. When in doubt, use default values.

To create a database:

1. Log in to the oracle as “system” or any other user with a DBA role.

2. Edit the <installation folder>/designer/bin/sql/Oracle/oracle_create_ws_db.sql SQL script, run it, and


verify that the database was created successfully.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 156
Robotic Process Automation 2019.11

3. (Optional) In order to verify that database objects can be created by the new user, connect to the Oracle
instance as RPA Workflow Designer user, edit and run: <installation
folder>/designer/bin/sql/Oracle/oracle_create_test_table.sql

Verify that the script ran successfully, and no errors or warnings were shown.

Manually create database objects


Once the database is in place, the database objects (tables, indexes, and so on) are created when the RPA
Workflow Designer service starts and connects to the database for the first time. You can create the database
objects manually if the user created for RPA Workflow Designer does not have permissions to create or modify
database objects (limited to DML operation only). It is highly recommended to grant the RPA Workflow Designer
database user DDL-related privileges, in order to allow RPA Workflow Designer to perform upgrade operations
without manual intervention, as these operations sometimes require modifications to database structure. To
manually create the database objects:

1. Extract the oracle.sql file from the RPA Workflow Designer installation zip file under docs\sql.

2. Edit the oracle.sql file and prefix each object with the RPA Workflow Designer user, to make sure the objects
are created under the RPA Workflow Designer user.

3. Connect to the RPA Workflow Designer database as the relevant user, who is permitted to create and modify
database objects in the RPA Workflow Designer database.

4. Run the oracle.sql file and verify that no errors occurred, and that all objects are created and owned by the
RPA Workflow Designer user.

Connect to Oracle using SID or service name


Connecting to an Oracle database server requires you to specify either the SID (system ID) or Service Name. RPA
Workflow Designer supports specifying the service name during installation (using either the Installation Wizard or
a silent installation). The following examples show how to format JDBC URL for each option, as it should appear in
the database.properties file under the designer\conf folder. Connecting to an Oracle instance using the SID:

jdbc.url=jdbc\:oracle\:thin\:@DB_HOSTNAME_OR_IP\:PORT\:SID

Connecting to an Oracle instance using the Service Name:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 157
Robotic Process Automation 2019.11

jdbc.url=jdbc\:oracle\:thin\:@//DB_HOSTNAME_OR_IP\:PORT/SERVICE_NAME

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 158
Robotic Process Automation 2019.11

Oracle database maintenance


This topic describes the various maintenance tasks that are recommended for RPA Workflow Designer databases
created on Oracle, such as backing up the database, checking database integrity, handling index fragmentation,
and monitoring the database.

Back up the RPA Workflow Designer database


Oracle databases can be backed up using several tools, such as expdp and RMAN. An RPA Workflow Designer
database can be backed up using any type of method/tool as long as the complete database is backed up.
Consider the following guidelines when you create your backup plan for RPA Workflow Designer:
Backup method:
The backup method depends mainly on business considerations—how much information ”may” be lost? What is
the maximum time for system recovery? If you need to be able to perform point-in-time recovery, and only “allow”
a few hours-worth of data loss, use the full recovery model and perform full or differential backups daily, and
transaction log backup every N hours depending on your business requirements.
Backup frequency:
Daily backup is recommended, especially if you are using/modifying RPA Workflow Designer on a daily basis.
You should back up once a month at the very least.
Timing:
Schedule backup for the time when RPA Workflow Designer is least active.
Retention:
Retention depends on your business guidelines and regulations.

Create a maintenance plan


Maintaining an RPA Workflow Designer database includes rebuilding the index and reclaiming free space. Use the
scripts and tools described in this section, in order to keep the RPA Workflow Designer database in good shape.
Utilities for RPA Workflow Designer Database Housekeeping

NOTE:
SQL scripts are also available in the RPA Workflow Designer installation under the
designer/bin/sql folder.
If you are copying SQL scripts from this document, note that you may need to
remove redundant line breaks from the copied version.

It is recommended to perform index maintenance on a regular basis.


The index rebuilding online (without RPA Workflow Designer system downtime) requires an enterprise grade
database. Make sure you are running an enterprise version of Oracle before attempting online index rebuilding.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 159
Robotic Process Automation 2019.11

You must also consider that maintenance activity usually consumes additional resources from the database.
Therefore it is important to schedule maintenance activity at the times when RPA Workflow Designer is least
active.

NOTE: ONLINE index rebuilding should only be performed when the enterprise
edition is used. Otherwise, the index rebuilding operation may lock tables and
indexes and may interfere with the operation of RPA Workflow Designer.

Additional guidelines
This section contains the configuration that needs to be done for RPA Workflow Designer to work with Oracle
11gR2 and 12cR1 Real Application Cluster (RAC) environments. This information is for advanced users only.

Oracle RAC

A cluster is a collection of interconnected servers that appear as one server to the end user and to applications.
Oracle Real Application Cluster (RAC) is Oracle's solution for high availability, scalability, and fault tolerance. It is
based on clustered servers that share the same storage. Oracle RAC is a single Oracle database installed on a
cluster of hardware servers. Each server runs an instance of the database and all the instances share the same
database files. For more details about Oracle RAC, see the Oracle Clusterware Guide and the Oracle Real
Application Clusters Administration and Deployment Guide in the Oracle documentation set of your release. In this
topic, the following Oracle RAC example is used:

Oracle RAC Cluster name: RPARAC


Service Name: ORCL.MY.DOMAIN
Machine names: Server1, Server2
On each machine, there is an Oracle instance of RPARAC:

SID on Server1: RPARAC1


SID on Server2: RPARAC2
On each machine, there is a virtual IP (Server1-Vip and Server2-Vip):

Server1-Vip is assigned to Server1


Server2-Vip is assigned to Server2
The virtual IP is in addition to the static IP assigned to the machine.

SCAN listener uses a virtual IP, usually published using DNS/GNS:


SCAN-Vip

The local listeners on both servers listen on the default port 1521 and support the database service RPA RAC.
SCAN listener(s) reside on one of the cluster nodes, and may failover along with their virtual IP addresses in the
case of a failure.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 160
Robotic Process Automation 2019.11

NOTE:
Although 12c SCAN allows configuring multiple SCAN listeners (per subnet), RPA
Workflow Designer only supports connecting to a single 12c SCAN listener.

Single client access name

In release 11g, Oracle introduced the Single Client Access Name (SCAN), as a preferred access method for clients
connecting to the RAC. In this method, clients are not required to configure individual nodes in the RAC; rather,
they use a single virtual IP known as the SCAN or the SCAN VIP. The SCAN is a single network name defined for the
cluster either in your organization's Domain Name Server (DNS) or in the Grid Naming Service (GNS) that rotates
between several IP addresses, reflecting multiple listeners in the cluster. The SCAN eliminates the need to change
clients when nodes are added to or removed from the cluster. The SCAN and its associated IP addresses provide a
stable name for clients to use for connections, independent of the nodes that make up the cluster. 11g SCAN
addresses, virtual IP addresses, and public IP addresses must all be on the same subnet. 12c SCAN allows
configuring multiple SCAN listeners – one per subnet. RPA Workflow Designer only supports connecting to a single
12c SCAN listener. The SCAN method is recommended when using RPA Workflow Designer in an Oracle 11g RAC
environment.

Configure RPA Workflow Designer to work with Oracle RAC

Connecting to a SCAN Listener Virtual IP

1. In the RPA Designer installation wizard Database Connection page, enter the SCAN listener virtual IP
address/network name in the Hostname or IP address field.

2. Select the Service Name radio button instead of the SID radio button and enter the Oracle RAC service
name.

3. Enter the rest of the details and click the Test Connection button.

Providing the SCAN listener virtual IP address guarantees that the RPA Workflow Designer server will be able to
reconnect to the database in the case of a failure. This connection method is the preferred one as it enables the
RPA Workflow Designer installation wizard to create the database as well as populate it. For silent installation use
(replace the highlighted text with the actual values):

db.url=jdbc:oracle:thin:@//[SCAN-Vip]:[PORT]/[ORCL.MY.DOMAIN]

Load-Balancing Using Explicit Connection String Although using Oracle’s SCAN listener virtual IP is the
preferred method, you can also provide an explicit connection string by using the Other database installation
option. For complete details, see “Oracle RAC example” in Install RPA Workflow Designer topic. Here is an example
of how a load balancing connection string would appear in the RPA Workflow Designer database.properties file.

1. Back up your current database.properties file located under < installation>/designer/conf if you have

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 161
Robotic Process Automation 2019.11

an existing (usable) database connection.

2. Edit the database.properties file as follows, while replacing the highlighted items with the values that
match your environment.

NOTE:
When copying scripts, note that you may need to remove redundant line breaks
from the copied version.

jdbc.url=jdbc\:oracle\:thin\:@ (DESCRIPTION=(LOAD_BALANCE=on)(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=TCP)(HOST=Server1-Vip)(PORT=1521)) (ADDRESS=(PROTOCOL=TCP)(HOST=Server2-
Vip)(PORT=1521))) (CONNECT_DATA=(SERVICE_NAME=ORCL.MY.DOMAIN)))

Note that the jdbc.url above is broken into several lines for readability, while it should appear as a single line in
the actual configuration file. When Load Balancing is set to “on”, failover between listeners is active by default.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 162
Robotic Process Automation 2019.11

Deploy and maintain a PostgreSQL database


In order to deploy RPA Workflow Designer using Postgres, you must have an existing Postgres database service. If
you need to create a new database service, see the relevant documentation provided by PostgreSQL as this
information is not included within this section. However, this section contains recommendations for the Postgres
configuration.
This section has the following topics:

Workflow for Postgres deployment


System Requirements for Postgres
Configuring Postgres
Manually create an RPA database on Postgres
Postgres database maintenance

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 163
Robotic Process Automation 2019.11

Workflow for PostgreSQL deployment


To deploy RPA Workflow Designer using Postgres, perform the following steps:

1. Review sizing guidelines.

2. Review Hardware and Software Requirements.

3. Configure Postgres.

4. Create RPA Workflow Designerdatabase on Postgres.

Related topics
Prepare the database environment
System requirements for Postgres
Configure Postgres
Manually create an RPA Workflow Designer database on Postgres

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 164
Robotic Process Automation 2019.11

System Requirements for PostgreSQL


This topic describes the system requirements for working with PostgreSQL in conjunction with RPA Workflow
Designer.

Hardware requirements
For RPA Workflow Designer database sizing guidelines and hardware requirements, see Prepare the database
environment section.
For PostgreSQL hardware requirements, see the relevant installation guide for your PostgreSQL release and
operating system.

Software requirements
For the supported PostgreSQL database versions, see System requirements topic.

Examples of tested deployment environments


The following table lists the deployment environments that have been rigorously tested by Micro Focus quality
assurance personnel.

Database Release

Version 32/64Bit Operating System

PostgreSQL 9.4.6 64 Bit Red Hat Enterprise Linux 7 64 Bit

PostgreSQL 9.5.1 64 Bit Red Hat Enterprise Linux 7 64 Bit

PostgreSQL 9.6.1 64 Bit Red Hat Enterprise Linux 7 64 Bit

PostgreSQL 9.6.3 64 Bit Windows 2012 R2

PostgreSQL 10.9 64 Bit Windows 2012 R2

Language support
PostgreSQL determines character set and collation at the database level. The RPA Workflow Designer database
uses Unicode (utf8) encoding and collation. This lets you use any Unicode character and all common characters in
all languages.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 165
Robotic Process Automation 2019.11

Related topics
Prepare the database environment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 166
Robotic Process Automation 2019.11

Configuring PostgreSQL

This topic contains information on RPA Workflow Designer Postgres configuration settings. Legend details:

Mandatory configuration options/values appear in Sky blue font.


Recommended configuration options/values appear in bold/blue font.
Supported configuration options/values appear in normal font, and may show as a comma-separated list.
Comments appear in italic font.

Postgres 9.4 - 9.6

Instance/Server Options

Instance Configuration Options Defaults, unless instructed otherwise

Mandatory Recommended Supported

max_connections >= 1000

default_transaction_isolation 'read committed'

autovacuum on

track_counts on

shared_buffers >=512MB 1

effective_cache_size >=2048MB1

work_mem >=1MB1

1
maintenance_work_mem >=32MB

lc_messages 'en_US.UTF-8' Any

lc_monetary 'en_US.UTF-8' Any

[1 ] - Minimal values. See the Postgres documentation on how to tune these values in accordance with your
environment.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 167
Robotic Process Automation 2019.11

Manually create an RPA database on PostgreSQL


This topic describes the procedure for manually creating an RPA Workflow Designer database on Postgres.
During RPA Workflow Designer setup, a new database can be created automatically by the RPA Workflow
Designerinstaller or a pre-existing database can be used.
If during installation, you are authorized to connect to the database server as a privileged user (connect as
“postgres”), use the “create the database/schema” option, and you can skip this section.

NOTE:
Only the database and role are created at this point; objects such as tables and
indexes are not created yet. These objects are created once RPA Workflow
Designer starts for the first time.

This topic is relevant for you if, for example, due to security restrictions, you do not wish to use login/user
credentials with elevated privileges during the RPA Designer installation. In such a case, you (or your
organization’s DBA) should create the database, login, and user first, and then let the RPA Workflow Designer
installer connect to the pre-existing database using basic privileges.
To create a database, you must connect to the Postgres instance using a login that has CREATEUSER and
CREATEDB privileges at the very least.

NOTE:

The postgres built-in user has all the required privileges.


Perform the following procedures only if you are an experienced Postgres
database administrator.
If you prefer to use the PgAdmin GUI, make sure you select all options that
correspond with the SQL code presented below.
Not all database creation options are specified—only those that differ from the
default value. When in doubt, use default values.

To create a database:

1. Log in to Postgres as “postgres” or any other login role with CREATEUSER and CREATEDB privileges.

2. Run <installation folder>/designer/bin/sql/PostgreSQL/postgres_create_ws_db_linux.sql or


postgres_create_ws_db_windows.sql depending on the database server’s operating system, and verify
that the database and user were created successfully. Adapt the script parameters to match your
environment.

3. (Optional) In order to verify that database objects can be created by the new user, connect to the database
server using the newly created user and run <installation

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 168
Robotic Process Automation 2019.11

folder>/designer/bin/sql/PostgreSQL/postgres_create_test_table.sql. Verify that the script ran correctly and


that no errors are shown.

Note SQL scripts are also available in the RPA Workflow Designer installation
under the designer/bin/sql folder.

If you are copying SQL scripts from this document, note that y ou may need to remove redundant line breaks
from the copied version.

Manually create database objects


Once the database and role are in place, the database objects (tables, indexes, and so on) are created when the
RPA Workflow Designer service starts and connects to the database for the first time.
To manually create the database objects (instead of the RPA Workflow Designer service):

1. Extract the postgres.sql file from the RPA Workflow Designer installation zip file under docs\sql.

2. Connect to the RPA Workflow Designer database as the RPA Workflow Designer database user.

3. Run the postgres.sql file and verify that no errors occurred.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 169
Robotic Process Automation 2019.11

PostgreSQL database maintenance


This topic describes the various maintenance tasks that are recommended for RPA Workflow Designer databases
created on Postgres, such as backing up the database, checking database integrity, handling index fragmentation,
and monitoring the database.

Back up the RPA Workflow Designer database


You can back up a Postgres database using several tools, such as the pg_dump or pg_backup script. You can
back up the RPA Workflow Designer database using any type of method/tool as long as the complete database is
backed up.
Consider the following guidelines when you create your backup plan for RPA Workflow Designer:
Backup method:
The backup method depends mainly on business considerations—how much information ”may” be lost? What is
the maximum time for system recovery? If you need to be able to perform point-in-time recovery, and only “allow”
a few hours-worth of data loss, use the full recovery model and perform full or differential backups daily, and
transaction log backup every N hours depending on your business requirements.
If your organization is more tolerant to data loss, you can use the simple recovery model and perform a daily or
weekly full backup.
Backup frequency:
Daily backup is recommended, especially if you are using/modifying RPA Workflow Designer on a daily basis.
You should back up once a month at the very least.
Timing:
Schedule backup for the time when RPA Workflow Designer is least active.
Retention:
Retention depends on your business guidelines and regulations.

Create a maintenance plan


RPA Workflow Designer Postgres database maintenance mainly includes table REINDEX, as autovacuum needs to
be activated. Use the example below, in order to keep the RPA Workflow Designer database in good shape.
Recommended Utility for Database Maintenance
To keep the RPA Workflow Designer database stable, it is recommended to run the REINDEX action during a
system maintenance window.
This operation may lock tables. You must perform this action during a maintenance window when the RPA
Workflow Designer system is not operating.
Here is an example of how to REINDEX a complete database using the reindexdb utility:

reindexdb -d WS –U wsuser –W ?????

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 170
Robotic Process Automation 2019.11

Replace “OOD” and “designeruser” with actual RPA Workflow Designer database and user names.
It is recommended not to provide the password explicitly. See the PostgreSQL documentation for recommendations
on how to secure database passwords.

Releasing unused large objects


The Operations Orchestration Workflow Designer database utilizes OID datatypes for some of the tables.
PostgreSQL does not automatically remove the corresponding data from the pg_largeobject internal table when the
references to OIDs are deleted. In order to clear this data, you need to invoke the vacuumLO utility included on
the PostgreSQL server.
In order to do this:

1. Login to the database server and locate PostgreSQL’s bin folder.

2. Run the following command from Windows command prompt or from linux’s shell: vacuumlo -U postgres -W -
v oo_dtabase_name

The parameters are case sensitive and represent the following:

“-U” represents the username under which to execute the utility. This utility has to be run as an administrative
user who has access to both the pg_largeobjects table and the OO Workflow Designer database. In the example
above we used the default administrative user for PostgreSQL databases “postgres”.
“-W” instructs the utility to prompt for the user’s password. While this normally happens by default on some
versions of the PostgreSQL database when omitting this parameter the utility fails due to invalid credentials.
“-v” writes the progress messages of the utility while running. Can be omitted.
The space freed up by the vacuumlo utility will be available for reuse after the next PostgreSQL vacuum event. In
case you want to have the freed up space from pg_largeobjects table to be available for reuse immediately after
the vacuumlo utility completes, you can run postgresql VACUUM command from pgsql command line or pg admin.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 171
Robotic Process Automation 2019.11

Installation Wizard Other database option

This topic contains information about the Other database option in the RPA Workflow Designer installation
wizard.
This option enables using specific JDBC driver and connection options. Use this option if:

You want to use a different version of the JDBC driver, other than the ones provided in the RPA Workflow
Designer installation (see the note below).
You want to provide a JDBC connection URL yourself, to include an option or options which are not currently
provided by the standard database connection options.
NOTES:

Connection is restricted to the following types and versions of database:

Microsoft SQL Server Standard/Enterprise (2012/2014/2016/2017)


Oracle 11gR2 Standard/Enterprise Server, including RAC environment
Oracle 12cR1 Standard/Enterprise Server - regular instance (non-CDB), including RAC environment
Postgres (9.4/9.5/9.6)
Use a non-provided JDBC driver at your own risk. The following JDBC drivers are supported:

sqljdbc4-4.2.jar – for SQL Server 2014


ojdbc7-12.1.0.2.jar
postgresql-9.4.1207.jar
When you install RPA Workflow Designer using the Other database option, the installation wizard does not create
the database and/or related user or roles. You must create these beforehand. Detailed instructions on how to
create the database/user/role can be found under the “Manually Creating an RPA Workflow Designer Database”
section in each database chapter.

Microsoft SQL server named instance example


The following example show a connection to a Microsoft SQL Server Named Instance using Microsoft JDBC
Connector. The database, login role, and user are pre-created by the DBA, and the login role is the owner of the
database (has full DML and DDL privileges).
Use the following details in the installation wizard, and revise the highlighted values to match your environment.
Use JDBC URL Option #1 when a unique TCP port is assigned to each instance.
Use JDBC URL Option #2 when Database Browser :service is active and is able to route connections based on the
instance name. Note that TCP port number does not appear in this option.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 172
Robotic Process Automation 2019.11

Field Value Comments

JDBC Driver C:\my\path\sqljdbc4-4.2.jar


jar

JDBC Driver com.microsoft.sqlserver.jdbc.SQLServerDriver


class name

JDBC URL jdbc:sqlserver://<DB_IP_OR_HOSTNAME>:<INSTANCE_ INSTANCE_PORT


Option #1 PORT>;databaseName=<DB_ represents the
NAME>;sendStringParametersAsUnicode=true separate instance

JDBC URL jdbc:sqlserver://<DB_IP_OR_HOSTNAME>;instanceName= If Database Browser


Option #2 <INSTANCE_NAME>;databaseName= service is active
<DB_NAME>;sendStringParametersAsUnicode=true

Username <LOGIN_ROLE>

Password <LOGIN_ROLE_PASSWORD>

Microsoft SQL Server Windows Authentication Example

NOTE:
Ignore the error regarding incompatible collation, but make sure to set your
collation to one of the supported collations, depending on your RPA Designer
installation language:

The following example show connection to a Microsoft SQL Server 2014 using Windows Authentication and
Microsoft JDBC Connector.
Prerequisites:

1. The database is pre-created by the DBA.

2. The relevant Windows account is the owner of the database (has full DML and DDL privileges).

3. The RPA Workflow Designer installation wizard must be unzipped and extracted to a folder form.

4. sqljdbc_auth.dll must be downloaded and copied to the RPA Workflow Designer installation wizard under
<installer_folder>\java\bin. This dll file is not provided along with the RPA Workflow Designer installation and
is available for download from Microsoft web site. Download Microsoft JDBC 4.2 and extract 64bit version of
sqljdbc_auth.dll.

Installation steps:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 173
Robotic Process Automation 2019.11

1. Run the RPA Workflow Designer installer by executing <installer_folder>\installer.bat as the same
Windows account that owns the RPA Workflow Designer database.

2. In the Connectivity page, select the Do not start RPA Workflow Designer server after installation…
checkbox.

3. In the Database Connection page select the Other database option and fill in the details according to the
table below. Edit and replace highlighted parts with actual values.

4. After the installation:

a. Verify sqljdbc_auth.dll is located in <installation>\java\bin.

b. Configure the service to run under the same Windows account that owns the RPA Workflow Designer
database.

c. Start the RPA Workflow Designer service and verify successful connection to the database.

Repeat the steps above for all RPA Workflow Designer server installations.
Use the following details in the installation wizard, and revise the highlighted values to match your environment:

Field Value Comments

JDBC C:\my\path\sqljdbc4-4.2.jar
Driver jar

JDBC com.microsoft.sqlserver.jdbc.SQLServerDriver
Driver
class
name

JDBC URL jdbc:sqlserver://<DB_IP_OR_HOSTNAME>:<DB_PORT>;databaseName=<DB_NAME>;integratedSecurity=true;sendStringParametersAsUnicode=true

Username Fully qualified Windows account:DOMAIN\USERNAME

Password ---- keep empty ----

NOTE:
Ignore the error about incompatible collation, but make sure to set your collation
to one of the supported collations, depending on your RPA Workflow Designer
installation language:

Language Database Collation

English SQL_Latin1_General_CP1_CS_AS

Japanese Japanese_Unicode_CS_AS

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 174
Robotic Process Automation 2019.11

Language Database Collation

Simplified Chinese Chinese_Simplified_Stroke_Order_100_CS_AS

Note that using a domain account for authentication may enforce security policies that may change from time to
time by the domain administrator.

Oracle RAC example


The following example shows a connection to an Oracle RAC cluster using explicit JDBC URL. The database (user)
must be pre-created by the DBA, and must be granted DML and DDL privileges.
Use the following details in the installation wizard, and revise the highlighted values to match your environment:

Field Value Comments

JDBC C:\my\path\ojdbc7-12.1.0.2.jar
Driver jar

JDBC oracle.jdbc.OracleDriver
Driver
class
name

JDBC URL jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=on)(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=Server1_VIP)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=Server2_VIP)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RAC1.MY.DOMAIN)))

Username <PRE-CREATED-DATABASE>

Password < PRE-CREATED-DATABASE-PASSWORD>

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 175
Robotic Process Automation 2019.11

Pre-installation tasks
This section provides information on how to setup the required environment before installing Robotic Process
Automation (RPA) components.
Before installing RPA, you must complete the following required activities:

1. Download and install Microsoft Visual C++ 2010 Redistributable Package.

2. Download and install Oracle JDBC driver, if you want to use Oracle database for RPA Central.

3. Use SQL scripts to create the database objects with ready database or schema.

Download and install Microsoft Visual C++ 2010


Redistributable Package
You must download and install Microsoft Visual C++ 2010 Redistributable Package (x86). Ensure that you install
the version for the x86 platform, regardless of your Windows version.
This package can be downloaded from: http://www.microsoft.com/en-us/download/confirmation.aspx?id=5555.

It is recommended to install RPA on a secured environment.


If you are installing Central with Oracle, you will need to install the Oracle JDBC driver. Download the JDBC driver
from https://www.oracle.com/technetwork/database/application-development/jdbc/downloads/index.html.

It is recommended to use Oracle JDBC driver version 7-12.1.0.2.

If you are performing a silent installation, set the value of the db.driver.location parameter to the path of
JDBC driver in the silent.properties file.

Before installing RPA, make sure to back up your system. Consult with your system administrator.

SQL scripts to create database objects

If, for security reasons, the RPA database user lacks the ability to create objects such as tables, indexes,
sequences, and so on, you can use SQL scripts from the ZIP file to manually create the database objects using an
elevated privileges database connection.
Before using these scripts, you need to have the database or schema already created. The scripts to create the
database or schema can be found in the Manually create an Robotic Process Automation database section.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 176
Robotic Process Automation 2019.11

The SQL scripts are located at \docs\sql on the ZIP file. They include:

mssql.sql
oracle.sql
postgres.sql

Database-specific adaptations

This section describes several key database-specific adaptations and requirements.

Postgres: If you are deploying RPA using a PostgreSQL database, you need to configure the PostgreSQL server
configuration file postgresql.conf with the following options:

default_transaction_isolation = 'read committed' autovacuum = on track_counts = on max_connections


= 1000

Oracle: If you are deploying RPA using an Oracle database, you need to configure the Oracle server PROCESSES
and OPEN_CURSORS to guarantee up to 1000 concurrent connections for RPA and up to 900 open cursors per
session.

SQL Server: If you are deploying RPA using an SQL Server database, you need to set the following options for
the database:

ALLOW_SNAPSHOT_ISOLATION ON READ_COMMITTED_SNAPSHOT ON AUTO_CREATE_STATISTICS ON AUTO_SHRINK


OFF

Related topics
Manually Creating an RPA Database
Set up database environment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 177
Robotic Process Automation 2019.11

Deploy
This section provides the steps required to install the Robotic Process Automation (RPA) components.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 178
Robotic Process Automation 2019.11

Install RPA components


This section describes how to install the following Robotic Process Automation (RPA) components.

Install RPA Workflow Designer


Install RPA Recorder
Install RPA Central
Install RPA RAS
Install RPA Robot
Install RPA Central and RPA RAS
Install RPA Self-Service X
Install an RPA cluster

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 179
Robotic Process Automation 2019.11

Install RPA Workflow Designer


This section provides the information required to install an RPA Workflow Designer on Windows and Linux
environments.
Before starting this installation, ensure you have administrative rights.

1. Download the RPA_Product_SW_and_Doc_2019.11_rpa-2019.11.0.0.zip file from the Software Licenses and


Downloads Portal and extract it into a local drive on your computer.

2. To start the installer:

a. On Windows: Right-click the installer-rpa-designer-win64-2019.11.exe installation file and run it


as an Administrator.

b. On Linux: Right-click the installer-rpa-designer-linux64-2019.11.bin file as an Administrator or


run this command from a Linux desktop/an X-Window terminal:

bash installer-rpa-designer-linux64-2019.11.bin

3. After you start the installer, the installation package is extracted, and the Robotic Process Automation
Designer Installation Wizard automatically opens. Click Next.

4. In the License page, select I Agree, and then click Next.

5. In the Location step, select the location for the installation root directory, and then click Next.

The default path for Windows and Linux is:

a. Windows: C:\Program Files\Micro Focus\Robotic Process Automation Designer

b. Linux: /opt/micro focus/rpa-designer

Valid characters for the installation path include English letters, digits, spaces, hyphens (-) and underscores (_).
If the directory does not exist, the directory will be created automatically. You are prompted to confirm the
creation of the new location.

6. In the Option Selection page, select the Robotic Process Automation Designer check box, and then

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 180
Robotic Process Automation 2019.11

click Next.

7. In the Connectivity page, you configure the RPA Workflow Designer ports and TLS properties.

Default values (8081 and 8445) appear for each port, but you can change the port details.

8. Select Disable HTTP Port and configure a port in the HTTPS field.

This option is recommended for security reasons, so that the communication channel is encrypted

9. Select Allow HTTP access and configure two ports in the HTTP and HTTPS fields.

This option is not recommended for security reasons

NOTE:
Configuring at least one port is mandatory. If a port is not defined or if the
ports are occupied by other applications, you will not be able to complete the
installation.

10. Select Provide a secure TLS certificate, and then click Browse to select the certificate.

This step is recommended for security reasons. If you do not select a TLS certificate, RPA Workflow Designer
uses a self-signed certificate.

Do not use a network path for the location of the RPA Workflow Designer TLS certificate.

11. If you select a Central TLS certificate, enter its password, and enter it again for confirmation.

12. Click Browse to specify the location of the CA root certificate, which will be imported into the TrustStore for
RPA Workflow Designer.

Do not use a network path for the location of the CA root certificate.

13. (Optional) Enter the LWSSO initialization string under LW SSO init string. This must be the same LW-SSO
initialization string that is used by the embedding application, must be at least 32 characters and must
contain lower case, upper case, and numeric letters.

14. Click Test ports availability. If the ports are available, a Success check mark appears.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 181
Robotic Process Automation 2019.11

a. If you encounter an error, adjust the ports accordingly and try again.

b. If the Success check mark appears, click Next.

15. In the Identity Management Configuration page, choose one of the following options:

a. Connect to an existing IDM service: If you already have an existing IDM management service.

b. Create a new IDM service: If you want to create a new IDM management service

16. If you select Connect to an existing IDM service option, then provide appropriate details for the
corresponding sections that is displayed:

Name of the section Field name and description

IDM service details IDM URL: Location of your IDM management service
IDM Transport Username: Your IDM service username
IDM Transport Password: Your IDM service password
Signing Key: The signing key must be at least 32 characters and must contain
lower case, upper case, digits, and special characters.

Tenant credentials Tenant: Location of your IDM management service


IDM Administrator Username: Your IDM service administrator username
IDM Administrator Password: Your IDM service administrator password

17. If you select Create IDM service option, then provide appropriate details for the corresponding sections that
are displayed. A new link to IdM Admin is added in the standalone RPA Workflow Designer after installation.
The administrator can create new database users.

Name of the section Field name and description

IDM Configuration Hostname: Hostname of your IDM service


Tenant: Provider (default)
Signing Key: Automatically generated. However, you can change it and must
contain lower case, upper case, digits, and special characters of at least 32
characters long.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 182
Robotic Process Automation 2019.11

Name of the section Field name and description

RPA Workflow Designer IDM Administrator Username: Your IDM service administrator username
Credentials IDM Administrator Password: Your IDM service administrator password
IDM Transport Username: Your IDM REST integration username
IDM Transport Password: Your IDM REST integration password
NOTE: The idmTransportUser, idmTransportUser do not respect password
policy requirements. You must ensure that the password is of at least 8
characters and must contain lowercase, uppercase, digits, and special
characters.

18. Check Save the passwords to a file, and then click Browse to navigate and select a plain text file.

19. Click Next

20. In the Designer Database Configuration page, you must configure and create the database schema.

NOTE:
If you have user input in two languages apart from English (for example,
Japanese and Chinese), then MS SQL should not be used. You should use an
alternative database such as Oracle, or PostgreSQL with the recommended
Unicode configuration for RPA Workflow Designer.

a. From the Database Type list, select the database vendor, and then enter the connection properties.

i. When the Connect to existing database/schema option is selected, the installer verifies that the
schema/database and user exist. It is recommended to not to use administrative user accounts in
the Username and Password fields, because this will install RPA Workflow Designer under the
administrative account.

You can then select from the following database types:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 183
Robotic Process Automation 2019.11

Database Fields

Oracle database JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
SID or Service Name: Select either of the two and then enter the SID or
service name of the database.
It is recommended to use Oracle database's service name rather than
using the SID.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created

Microsoft SQL Hostname or IP address: Enter the Hostname or IP address of the VM


Server that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Microsoft SQL Server
database that you created
Password: Enter the password to connect with the Microsoft SQL Server
database that you created

Oracle MySQL JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
It is advised to not to use the root credential in the Username and
Password fields.
If you are installing RPA Workflow Designer with Oracle RAC (Real
Application Cluster), you must choose Other database and provide the
URL.

PostgreSQL Hostname or IP address: Enter the Hostname or IP address of the VM


that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created

Internal database This uses an H2 local database. This should not be used for production.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 184
Robotic Process Automation 2019.11

Database Fields

Other database (use to enable advanced features in supported databases).


You can use this option and enable advanced features in supported
databases, such as PostgreSQL, Oracle, Oracle RAC and SQL Server. You
must provide the jdbc URL only for Designer's database. For IDM's
database, you can enter only the name of the database with the
credentials, or the user and password with the SID or Service name for
Oracle.
JDBC Driver jar: Browse and select the jar file of other database.
JDBC Driver class name: Enter the class name of the other database.
JDBC URL: Enter the valid JDBC URL to connect with other database.
Username: Enter the Username to connect with other database that you
created.
Password: Enter the password to connect with other database that you
created.

ii. When the Create the database/schema option is used, it enables you to create a new database
or schema.

You can then select from the following database types:

Database type Description

Oracle Do not use SYS, SYSTEM, or other administrative accounts credentials in the
Username and Password fields. If you are using Oracle 11g R2 or 11g R2
RAC, it is recommended to apply patch 20299013 before installing RPA
Workflow Designer.

Microsoft SQL Do not use sa or other administrative account credentials in the Username
Server and Password fields. If you are installing RPA Workflow Designer with Oracle
RAC (Real Application Cluster), you must choose Other database and provide
the URL.

PostgreSQL Do not use the PostgreSQL credential in the Username and Password fields.
You may note that PostgreSQL database names are case-sensitive. You may
note that PostgreSQL database names are case-sensitive.

Internal database This uses an H2 local database. This should not be used for production.

Other database (use to enable advanced features in supported databases). You must provide
the complete jdbc URL only for Workflow Designer's database. For IDM's
create database scenario, you can enter only the name of the database with
the credentials.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 185
Robotic Process Automation 2019.11

Database Fields

Oracle JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar file as
database part of your preinstallation task. You can download the JDBC driver from
http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html. It is
recommended to use ojdbc7.jar or later, depending on the Oracle version. If you are
performing a silent installation, set the value of the db.driver.location parameter to
the path of JDBC driver in the silent.properties file.
Hostname or IP address: Enter the the FQDN (Fully Qualified Domain Name) of
the Hostname or IP address of the VM that has the database. If you want to use
IPv6, put the IPv6 address in brackets, for example, [3fff::20]. Otherwise, errors will
occur.
Port: The connection port for Oracle database is selected by default
SID or Service Name: Select either of the two and then enter the SID or service
name of the database.
It is recommended to use Oracle database's service name rather than using the SID.
Username: Enter the Username to connect with the Oracle database that you
created
Password: Enter the password to connect with the Oracle database that you
created
DBA Username: Enter the Username to connect with the Oracle database that you
created
DBA Password: Enter the password to connect with the Oracle database that you
created. This elevated-privileges user must be able to connect to the database and
create the new schema, user, or database for Operations Orchestration.
Tablespace: Enter the Oracle datafile Tablespace path
Temporary tablespace: Enter the Oracle Temporary tablespace path

Microsoft Hostname or IP address: Enter the Hostname or IP address of the VM that has the
SQL Server database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Microsoft SQL Server database
that you created
Password: Enter the password to connect with the Microsoft SQL Server database
that you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the Microsoft
SQL Server database
Admin Password: Enter the Administrator password to connect with the Microsoft
SQL Server database

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 186
Robotic Process Automation 2019.11

Database Fields

Oracle JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar file as
MySQL part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM that has the
database
Port: The connection port for Oracle database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that you
created
Password: Enter the password to connect with the Oracle database that you
created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the Oracle
MySQL database
Admin Password: Enter the Administrator password to connect with the Oracle
MySQL database

PostgreSQL Hostname or IP address: Enter the Hostname or IP address of the VM that has the
database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that you
created
Password: Enter the password to connect with the Oracle database that you
created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
PostgreSQL database
Admin Password: Enter the Administrator password to connect with the
PostgreSQL database

Internal This option is disabled.


database

21. Click Test Connection. If you are unable to connect to the database, you will not be able to proceed to the
next steps in the wizard.

If your password is not strong enough, a warning is displayed. You will still be able to proceed with the
installation, but it is strongly recommended to replace it with a stronger password.

The installer checks for non-empty schemas/databases, and shows a warning message if the schema or
database is not empty. If the installation fails during schema validation, the installation process is stopped.

22. In the IDM Database Configuration page, select whether you want to connect to an existing database
schema or create a new one.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 187
Robotic Process Automation 2019.11

Make sure that the IDM database that you are configuring is empty. Otherwise, a warning message is
displayed when testing the connection.

IMPORTANT:

If you had selected MS SQL as the database type previously, you


must set the Database COLLATION to CASE INSENSITIVE (Example:
SQL_Latin1_General_CP1_CI_AS) and then run the following queries
to set the snapshot isolation and read committed snapshot flags to
true

ALTER DATABASE <DB_NAME> SET ALLOW_SNAPSHOT_ISOLATION ON ALTER


DATABASE <DB_NAME> SET READ_COMMITTED_SNAPSHOT ON

23. Click Next.

24. In the Language step, select a supported language for RPA Workflow Designer, in addition to English, if
required, and then click Next.

NOTE: RPA Workflow Designer is available in the following languages: English,


French, German, Japanese, Simplified Chinese, and Spanish.

25. The Summary page displays the installation and configuration settings that you selected and entered in the
wizard. Check that the settings are correct. If you want to correct one of the items, click Back.

26. Click Install. The installation begins, and the wizard displays a check mark next to each successfully installed
item on the Installation and Configuration Progress page.

NOTE: If there is a problem with one of the installation or configured items,


the installation might attempt to continue with the rest of the items regardless
of that error. You can open the installer.log file in the installation directory to
check for errors. The default location is C:\Program Files\Micro
Focus\Robotic Process Automation Designer for Windows and
/opt/microfocus/oo-designer for Linux.

27. When the installation is complete, click Next.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 188
Robotic Process Automation 2019.11

28. Click Finish to close the Installation and Configuration wizard.

RPA Workflow Designer is now installed and a menu shortcut is created on your system.

Related topics
For information related to user management and authentication, see User management and authentication.
For more detailed information about setting up the database, see the section Set up database environment for
RPA Workflow Designer.
For more detailed information about TLS and other security configurations, see the RPA Workflow Designer
Secure and Harden RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 189
Robotic Process Automation 2019.11

Install RPA Recorder


This topic describes how to install Robotic Process Automation (RPA) Recorder and Unified Functional Testing (UFT)
components.
RPA Recorder can only be installed on Windows. It is recommended to not install both RPA Robot and RPA Recorder
on the same machine.
Before starting this installation, ensure you have administrative rights.

1. Download the RPA_Product_SW_and_Doc_2019.11_rpa-2019.11.0.0.zip ZIP file from the Software Licenses and
Downloads Portal and extract it into a local drive on your computer.

2. Right-click the installer-rpa-recorder-win64-2019.11.exe installation file and run it as an Administrator.

3. After you start the installer, the installation package is extracted, and the Robotic Process Automation
Recorder Installation Wizard automatically opens. Click Next.

4. In the License page, select I Agree, and then click Next.

5. In the Location page, select the location for the installation root directory.

If the directory does not exist, the directory is created automatically. You are prompted to confirm the
creation of the new location.

If you create a directory, you must provide valid characters for the installation path that can include English
letters, digits, spaces and underscores (_) but not a hyphen (-).

The default path for Windows is: C:\Program Files\Micro Focus\Robotic Process Automation Recorder

6. Click Next.

7. In the Prerequisites Information page, click Check Windows Updates.

8. After the Windows updates are successfully verified, click Next

9. In the Option Selection page, select Robotic Process Automation Recorder or Unified Functional Testing or
both and then click Next.

You can choose to install UFT only once either during RPA Robot or RPA recorder installation process.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 190
Robotic Process Automation 2019.11

10. In the RPA Recorder Server Connectivity page, provide the Recorder Server port details.

11. Click Test ports availability. If the ports are available, a Success check mark appears.

a. If you encounter an error, adjust the ports accordingly and try again.

b. If the Success check mark appears, click Next.

12. The Summary page displays the installation and configuration settings that you selected and entered in the
wizard. Check that the settings are correct. If you want to correct one of the items, click Back.

13. Click Install. The installation begins, and the wizard displays a check mark next to each successfully installed
item on the Progress page. When the installation is complete, click Next.

If there is an issue with one of the installation or configured items, the installation attempts to continue with
the rest of the items regardless of that error. Check the installer.log file located at C:\Micro Focus\Robotic
Process Automation Recorder to check for errors.

14. Click Finish to close the Robotic Process Automation Recorder Installation Wizard.

RPA Recorder is installed and menu shortcuts are created on your system.

It must be noted that in a multi-author environment. If two users are logged on the same RPA Recorder machine,
the Recorder triggered by one user might appear on the other user's session.

Related topics
For more information on how to install RPA RAS, see Install RAS.
For instructions on how to install RPA Central in a cluster environment, see Install RPA Central in a cluster.
For troubleshooting UFT configuration during installation, see Unable to configure UFT.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 191
Robotic Process Automation 2019.11

Install RPA Central


This section provides the information required to install an RPA Central on Windows and Linux environments.
Before starting this installation, ensure you have:

1. Downloaded and installed RabbitMQ 3.7.11 and its dependencies such as Erlang.

2. Administrator permissions.

To install RPA Central, complete the following steps:

1. Download the RPA_Product_SW_and_Doc_2019.11_rpa-2019.11.0.0.zip ZIP file from the Software Licenses and
Downloads Portal and extract it into a local drive on your computer.

2. To start the installer:

a. On Windows: Right-click the installer-rpa-win64-2019.11.exe installation file and run it as an


administrator.

b. On Linux: Right-click the installer-rpa-linux64-2019.11.bin file and run it as an administrator or run


the following command from a Linux desktop/an X-Window terminal: bash installer-rpa-
linux64-2019.11.bin

3. After you start the installer, the installation package is extracted, and the Robotic Process Automation
Installation Wizard automatically opens.

4. In the License page, select I Agree, and then click Next.

5. In the Location page, select installation root directory, and then click Next.

The default paths for Windows and Linux are:

a. Windows: C:\Program Files\Micro Focus\Robotic Process Automation

b. Linux: /opt/microfocus/rpa

If the directory does not exist, the directory is created automatically. You are prompted to confirm the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 192
Robotic Process Automation 2019.11

creation of the new location.

If you create a directory, you must provide valid characters for the installation path that must include English
letters, digits, spaces, hyphens (-) and underscores (_).

6. In the Option Selection page, select Central, and then click Next.

You can install RPA Central without setting up a Remote Action Server (RAS). If you install an RPA RAS Server,
it is recommended that you install this on a separate server to RPA Central.

7. In the Central Cluster page, click Next to pass through the cluster step without modifying anything

8. In the Connectivity page, configure the available Central Server ports and TLS properties.

Default values (8080 and 8443) appear for each port, however you can change the port details.

9. Select Disable HTTP Port and configure a port in the HTTPS field.

This option is recommended for security reasons, so that the communication channel is encrypted.
Configuring at least one port is mandatory. If a port is not defined, or if the ports are occupied by other
applications, you will not be able to continue with the installation.

10. Select Provide a secure TLS certificate, and then click Browse to select the certificate.

This step is recommended for security reasons. If you do not select a RPA Central TLS certificate, RPA uses a
self-signed certificate.

Do not use a network path for the location of the RPA Central TLS certificate.

11. If you select Central TLS certificate, enter its password, and enter it again for confirmation.

12. Click Browse to specify the IDM Configuration of the CA root certificate, which will be imported into the
TrustStore for RPA Central/RPA RAS. You must ensure to not use a network path for the location of the CA root
certificate.

13. Select Do not start Central server after installation if either of the following is true:

a. If you are configuring RPA to be compliant with FIPS 140-2.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 193
Robotic Process Automation 2019.11

b. If you are installing RPA Central and RPA RAS together, this option will not be available as the RAS
server needs to connect to the RPA Central server. If RPA Central is not started, the installation of the
RAS will fail.

14. Click Test ports availability. If the ports are available, a Success check mark appears.

a. If you encounter an error, adjust the ports accordingly and try again.

b. If the Success check mark appears, click Next.

15. In the IDM Configuration page, you can install a centralized IDM Service or you can connect to an existing
IDM service. You can also choose to use the RPA built-in authentication mechanism.

17. If you choose to Create IDM service, perform the following steps:

a. In the Tenant field, enter the value of the tenant to be configured in the IDM service. The default value
fis "RPA".

b. In the Signing Key field, enter the value of the IDM configuration signing key. The signing key must be
at least 32 characters and must contain lower case, upper case, and numeric letters.

c. In the RPA Central Credentials area, admin field, enter the administrator user name of the IDM
integration account.

d. In the ooadmin field, , enter the password for the user who has the SUPER_IDM_ADMIN role. This user is
an elevated API user and is used only for API calls between RPA and IDM. This user is not to be used to
log in to RPA as the role assigned to the user is "END_USER”.

The ooadmin, idmTransportUser, oopromoter, ooenduser, and


ooeverybody do not respect password policy requirements. You must
ensure that the password is of at least 8 characters and must contain
lowercase, uppercase, number, and a special character.

e. In the idmTransportUser field, enter your IDM integration account details.<l/i>

f. In the oopromoter field, enter the password for the user with the PROMOTER role. This user can access
the Content Management and Run Management workspaces.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 194
Robotic Process Automation 2019.11

g. In the oosysadmin field, enter the password for the user with the SYSTEM_ADMIN role. This user can
access the System Configuration and the Run Management workspaces.

h. In the ooenduser field, enter the password for the user with the END_USER role. This user can access
only the Run Management workspace.

i. In the ooeverybody field, enter the password for the user with the EVERYBODY role. This user can
access only the Run Management workspace.

j. Select the Save the passwords to a file check box if you want save the information in this screen to a
file. If you select the check box, browse and select a file in which information from this page will be
saved. The default IDM transport user and IDM transport password are also saved in this file
(idm.configuration.username and idm.configuration.password).

18. If you choose to Connect to an existing IDM service, perform the following steps:

a. In the IDM URL field, enter the he URL of the IDM service.

For example, <idm_protocol>://<idm_hostname>:<idm_port>/<idm_service_path>

b. In the IDM Transport Username field, enter the user name of the IDM REST integration.

c. In the IDM Transport Password field, enter the IDM REST integration password.

d. In the Signing Key field, enter the signing key for the IDM configuration. The signing key must be of at
least 32 characters and must contain lowercase, uppercase, and numeric letters.

e. In the Tenant Credentials area, Tenant field, enter the tenant value of Central to be configured in the
IDM service. The default value "RPA".

f. In the IDM Administrator Username field, enter the user name of the user with full access to the IDM
database.

g. In the IDM Administrator Password field, enter the password of the IDM administrator user.
You must create a new database for the IDM component and provide the authentication details of the
user with access to that database.

19. In the Central Database Configuration page, you configure and create the database schema.

If you have user input in two languages apart from English (for example, German and Chinese) then MS SQL
should not be used. You should use an alternative database such as Oracle, or PostgreSQL with the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 195
Robotic Process Automation 2019.11

recommended Unicode configuration for RPA Central .

a. From the Database Type list, select the database vendor, and then enter the connection properties.

i. When the Connect to existing database/schema option is selected, the installer verifies that
the schema/database and user exist. It is recommended to not to use administrative user accounts
in the Username and Password fields, because this will install RPA Central under the
administrative account.

You can then select from the following database types:

Database Fields

Oracle database JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver
jar file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
SID or Service Name: Select either of the two and then enter the SID or
service name of the database.
It is recommended to use Oracle database's service name rather than
using the SID.
Username: Enter the Username to connect with the Oracle database
that you created
Password: Enter the password to connect with the Oracle database that
you created

Microsoft SQL Server Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Microsoft SQL
Server database that you created
Password: Enter the password to connect with the Microsoft SQL Server
database that you created

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 196
Robotic Process Automation 2019.11

Database Fields

Oracle MySQL JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver
jar file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database
that you created
Password: Enter the password to connect with the Oracle database that
you created
It is advised to not to use the root credential in the Username and
Password fields.
If you are installing Operations Orchestration with Oracle RAC (Real
Application Cluster), you must choose Other database and provide the
URL.

PostgreSQL Hostname or IP address: Enter the Hostname or IP address of the VM


that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database
that you created
Password: Enter the password to connect with the Oracle database that
you created

Internal database This uses an H2 local database. This should not be used for production.

Other database (use to enable advanced features in supported databases). If you select
Other database, you can only use a database type that is supported for
use with RPA. It supports any valid JDBC URL.
JDBC Driver jar: Browse and select the jar file of other database.
JDBC Driver class name: Enter the class name of the other database.
JDBC URL: Enter the valid JDBC URL to connect with other database.
Username: Enter the Username to connect with other database that
you created.
Password: Enter the password to connect with other database that you
created.

ii. When the Create the database/schema option is used, it enables you to create a new database
or schema.

You can then select from the following database types:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 197
Robotic Process Automation 2019.11

Database type Description

Oracle Do not use SYS, SYSTEM, or other administrative accounts credentials in


the Username and Password fields. If you are using Oracle 11g R2 or 11g
R2 RAC, it is recommended to apply patch 20299013 before installing RPA
Central.

Microsoft SQL Do not use sa or other administrative account credentials in the Username
Server and Password fields. If you are installing RPA with Oracle RAC (Real
Application Cluster), you must choose Other database and provide the URL.

PostgreSQL Do not use the PostgreSQL credential in the Username and Password fields.
You may note that PostgreSQL database names are case-sensitive. You
may note that PostgreSQL database names are case-sensitive.

Internal database This uses an H2 local database. This should not be used for production.

Other database (use to enable advanced features in supported databases). If you select
Other database, you can only use a database type that is supported for use
with RPA. It supports any valid JDBC URL.

Database Fields

Oracle database JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the the FQDN (Fully Qualified Domain
Name) of the Hostname or IP address of the VM that has the database. If
you want to use IPv6, put the IPv6 address in brackets, for example,
[3fff::20]. Otherwise, errors will occur.
Port: The connection port for Oracle database is selected by default
SID or Service Name: Select either of the two and then enter the SID or
service name of the database.
It is recommended to use Oracle database's service name rather than
using the SID.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
DBA Username: Enter the Username to connect with the Oracle
database that you created
DBA Password: Enter the password to connect with the Oracle database
that you created. This elevated-privileges user must be able to connect to
the database and create the new schema, user, or database for
Operations Orchestration.
Tablespace: Enter the Oracle datafile Tablespace path
Temporary tablespace: Enter the Oracle Temporary tablespace path

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 198
Robotic Process Automation 2019.11

Database Fields

Microsoft SQL Server Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Microsoft SQL Server
database that you created
Password: Enter the password to connect with the Microsoft SQL Server
database that you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
Microsoft SQL Server database
Admin Password: Enter the Administrator password to connect with the
Microsoft SQL Server database

Oracle MySQL JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
Oracle MySQL database
Admin Password: Enter the Administrator password to connect with the
Oracle MySQL database

PostgreSQL Hostname or IP address: Enter the Hostname or IP address of the VM


that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
PostgreSQL database
Admin Password: Enter the Administrator password to connect with the
PostgreSQL database

Internal database This option is disabled.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 199
Robotic Process Automation 2019.11

20. Click Test Connection to test the database settings. If you are unable to connect to the database, you will
not be able to proceed to the next steps in the wizard.

If your password is not strong enough, a warning is displayed. You will still be able to proceed with the
installation, but it is strongly recommended to replace it with a stronger password.

The installer checks for non-empty schemas/databases, and shows a warning message if the schema or
database is not empty. If the installation fails during schema validation, the installation process is stopped.

Note This test only verifies the connection between RPA and the selected
database, and does not verify the conditions required by the database, like
the user's read/write permissions on the provided schema.

Note For all the database vendors, if you select to create a new database, the
created database uses case-sensitive collation as follows:

PostgreSQL: Case-sensitive by design. No need for specific settings. UTF-8


encoding is supported
Oracle: Case-sensitive by default. No need for specific settings. UTF-8
encoding is supported.
MS SQL: Use only the following database collations per your required
language:

English: SQL_Latin1_General_CP1_CS_AS

Japanese: Japanese_Unicode_CS_AS

Simplified Chinese: Chinese_Simplified_Stroke_Order_100_CS_AS

German: SQL_Latin1_General_CP1_CS_AS

French: French_100_CS_AS

Spanish: SQL_Latin1_General_CP1_CS_AS

However, if you already have a database installed, RPA creates the tables
using the database specific collation. It is important to note that using other
collations can cause characters to appear in gibberish in the user interface for

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 200
Robotic Process Automation 2019.11

localized installations. In addition, other collations are not officially supported


in Microsoft SQL Server for localized installations.

If the installer is used in order to create a new SQL Server database, selecting
your language in the language selection page sets the correct collation for the
new database.

Using one of the above collations enables using the varchar datatype for
textual columns instead of the nvarchar data type. Using the varchar data
type is more efficient and reduces overall database size.

Selecting a specific language also means that an RPA system that uses SQL
Server is limited to the set of languages supported by that specific collation.
For example, if the SQL_Latin1_General_CP1_CS_AS collation is used,
English, German, and Spanish characters may be used, but Japanese
characters may not. If Japanese_Unicode_CS_AS is used, French accent
characters will not be presented properly. For the complete specification of
each collation, see the Microsoft SQL Server documentation.

21. In the IDM Database Configuration, choose whether to connect to an existing database schema or create
a new one. The IDM database that you are configuring must be empty. Otherwise, a warning message is
displayed when testing the connection.

22. Click Test Connection to test the connection. If successful, click Next.

23. In the Queue Configuration page, provide the queue configuration details. If your RabbitMQ connection is
secured, the installer is able to automatically detect and adapt to the required configuration.

Field name Details

Host Enter the IP or FQDN details of the Queue management application.

Port Provide the port details of the queue management tool. Default is: 5672

Username Provide the username to access the queue management tool.

Password Provide the username to access the queue management tool.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 201
Robotic Process Automation 2019.11

Field name Details

Virtual Host Provide the Virtual Host of your queue management tool.

24. In the Language page, select a supported language for RPA Central, in addition to English, and then click
Next.

This language support will be used for:

a. The MS SQL collation language, if relevant

b. The central-wrapper.conf language for content. This language support may be required if, for
example, you need to ping a server that is configured in Japanese.
You can change the language support choice after installation, by editing the central-wrapper.conf
file, located in the installation directory under central/conf.

25. The Summary page displays the installation and configuration settings that you selected and entered in the
wizard. Check that the settings are correct. If you want to correct one of the items, click Back.

26. Click Install. The installation begins, and the wizard displays a check mark next to each successfully installed
item on the Progress page. When the installation is complete, click Next.

Note If there is a problem with one of the installation or configured items, the
installation might attempt to continue with the rest of the items regardless of
that error. Check the installer.log file in your installation directory(the
default located is C:\Micro Focus\Robotic Process Automation for
Windows), to check for errors.

27. (Optional) In the Finish page, select Open Welcome Page to display the RPA Welcome page in your default
web browser, in the language that was selected on the Language page.

28. Click Finish to close the Installation and Configuration wizard.


RPA Central is installed and menu shortcuts are created on your system.

You must ensure that RPA Central is connected to the same RabbitMQ and virtual host as RPA Robot for
seamless interaction.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 202
Robotic Process Automation 2019.11

The installation is of the trial version of RPA Central. Install the commercial license within 60 days.

Related topics
For instructions on how to manage licenses, see Manage RPA Licenses.
For instructions to install RPA RAS, see Install RAS.
For instructions to install RPA Central in a cluster environment, see Install RPA Central in a cluster.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 203
Robotic Process Automation 2019.11

Install RPA RAS


This section describes how to perform a fresh installation of RPA RAS in Windows and Linux environments.
Before starting this installation, ensure you have administrative rights.

1. Download the RPA_Product_SW_and_Doc_2019.11_rpa-2019.11.0.0.zip file from the Software Licenses and


Downloads Portal and extract it into a local drive on your computer.

2. To start the installer:

a. On Windows: Right-click the installer-rpa-ras-win64-2019.11.exe installation file and run it as an


Administrator.

b. On Linux: Right-click the installer-rpa-ras-linux64-2019.11.bin file and run it as an administrator


or run the following command from a Linux desktop/an X-Window terminal:

bash installer-rpa-ras-linux64-2019.11.bin

3. After you start the installer, the installation package is extracted, and the Robotic Process Automation
Installation and Configuration Wizard automatically opens. Click Next.

4. In the License page, select I Agree, and then click Next.

5. In the Location page, select the location for the installation root directory, and then click Next

If the directory does not exist, the directory is created automatically. You are prompted to confirm the
creation of the new location.

If you create a directory, you must provide valid characters for the installation path that must include English
letters, digits, spaces, hyphens (-) and underscores (_).

a. Windows: C:\Program Files\Micro Focus\Robotic Process Automation

b. Linux: /opt/microfocus/rpa

6. In the Option Selection page, select the Remote Access Server (RAS) check box, and then click Next.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 204
Robotic Process Automation 2019.11

If you use installer-win64-ras.exe file to install standalone RAS, then


the options for other components are grayed out on Option Selection
screen. You are allowed to select only the Remote Action Server (RAS)
option.

7. Choose between one of the following options:

a. Standard RAS - RAS initiates communication to Central - this is the simplest option and is
recommended if your security rules permit it.

b. Reverse RAS - Central initiates communication to RAS - choose this option if Central is installed
in a different, more secured network, and your security rules do not allow connecting from the less
secured network to the more secured one.

You will need to configure the RAS to accept connection from Central. When the RAS starts up, it will be
idle, waiting for Central to initiate connection.

8. In the Queue Configuration page, provide the queue configuration details.

If your RabbitMQ connection is secured, the installer is able to automatically detect and adapt to the required
configuration.

Field name Details

Host Enter the IP or FQDN details of the Queue management application.

Port Provide the port details of the queue management tool. Default is: 5672

Username Provide the username to access the queue management tool.

Password Provide the username to access the queue management tool.

Virtual Host Provide the Virtual Host of your queue management tool.

9. This step follows, if you selected Standard RAS - RAS initiates communication to Central. In the RAS ->
Central page, enter, in the Central URL box, enter the properties and location of the Central.

Note If you are installing RAS and Central at the same time, this page does
not appear, because the RAS is automatically registered to the Central that is

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 205
Robotic Process Automation 2019.11

being installed at the same time.

Make sure to use the FQDN (Fully Qualified Domain Name) for the RPA Central URL.

If you want to use IPv6 address, enter the IPv6 address within the brackets as in: [3fff::20] to avoid errors.

Note If Central is set up with HTTPS, make sure to enter the hostname exactly
as specified in Central's TLS certificate.

10. (Optional) Select the Central user capable of registering a RAS check box and enter the user name and
password of this user.

If relevant, add the LDAP domain using the following conventions:

domain\username
username@domain

11. (Optional) Select the HTTP proxy definition for connecting to the Central and enter the HTTP proxy
definition.

12. Click Test Connection.

Note If you test the connection to a Central with a custom CA certificate


without providing the certificate to the RAS, a java.lang.RuntimeException
error message will appear.

a. If the connection test is successful, continue.

b. If the connection test is not successful, review the settings that you entered in steps 1 - 3 above.

13. When you installed Central, if you provided a CA certificate for Central, you must provide the root CA
certificate for the RAS. This certificate will be imported to the RAS TrustStore:

a. Select the Supply the CA root certificate of Central check box.

b. Click Browse to select the relevant CA root certificate.

If the default certificates were used in Central, you should leave this check box cleared, to automatically use

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 206
Robotic Process Automation 2019.11

the self-signed certificate.

14. If Central requires an X.509 certificate from the client, complete the following steps, and then click Next. You
may need to scroll down to see all the fields.

a. Click the Provide an X.509 client certificate of the RAS check box.

A UUID for the RAS is automatically generated.

b. Create the client certificate using this RAS UUID. The client certificate must be in PKCS format and must
be with a .pfx or .p12 extension.

c. Click Browse to select the X.509 client certificate that you created.

d. Enter the password of the X.509 client certificate that you created.

e. Click Browse to select the client certificate of a user capable of registering a RAS.

f. Enter the password for the user capable of registering a RAS.

15. This step follows if you selected Reverse RAS - Central initiates communication to RAS. In the Central
-> RAS page, enter a shared secret, and enter it again to confirm.

When Central is configured to register this RAS, this secret will need to be entered, in order for Central to
connect to the RAS.
The shared secret must conform to the following rules:

Minimal length of 8 characters


Contain at least one upper case character

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 207
Robotic Process Automation 2019.11

Contain at least one lower case character


Contain at least one number

16. In the RAS listening address box, enter the FQDN or IP of the RAS server.

By default, this is populated with the IP/FQDN (based on the selected protocol).

17. Enter the port on which the RAS server will listen for the Central connection.

18. Click Test port availability. If the ports are available, a Success check mark appears.

If you encounter an error, adjust the ports accordingly and try again.

19. Select Supply a secure TLS certificate.

This step is recommended, for security reasons. If you do not select a secure TLS certificate, RPA will
generate and use a self-signed certificate, which will be exported to the <RAS>/var/security folder.

20. If you selected Supply a secure TLS certificate, click Browse to specify the location of the RAS TLS
certificate.

21. Enter the certificate's password and enter it again for confirmation.

22. Click Browse and specify the location of the CA root certificate, and then click Next. The certificate will be
imported into the TrustStore for Central/RAS.

Note Do not use a network path for the location.

23. If you selected Reverse RAS - Central initiates communication to RAS, you must also configure RPA
Central to register the RAS, by providing all required information about the RAS: host/IP, port, and so on.

You need to do this in Central, under the System Configuration > Topology > Workers tab. Once the RAS
is registered, Central opens the connection to the RAS.

Note If the protocol is HTTPS, make sure that the root certificate from the
reverse RAS has been added to the Central's client.truststore before
attempting to register the worker in the Central UI. It is not required to restart
Central after importing the certificate.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 208
Robotic Process Automation 2019.11

Note If you selected Reverse RAS, the installation process creates a file
named ras-connectivity.properties under <installation-
directory>\ras\conf.
. This file includes the following information:

protocol type: WS/WSS


listen address: FQDN/IP
listen port: <integer>
reverse RAS flag: true/false (The RAS uses this flag to define the mode to
use upon startup: regular RAS or reverse RAS)
hashed shared secret
24. A summary of the installation is displayed, review the settings and click
Install.

25. Click Finish to complete the installation.

Related topics

To secure and harden RPA, see Secure and harden RPA.


To set up topology for workers and RASes, see Set up topology for workers and
RASes.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 209
Robotic Process Automation 2019.11

Install RPA Robot


This topic describes how to perform a fresh installation of a single Robotic Process Automation (RPA) Robot and
Unified Functional Testing (UFT) tools.
Robot can only be installed on Windows. It is recommended to not install both RPA Robot and RPA Recorder on the
same machine.
Before starting this installation, ensure you have administrative rights.

1. Download the RPA_Product_SW_and_Doc_2019.11_rpa-2019.11.0.0.zip ZIP file from the Software Licenses and
Downloads Portal and extract it into a local drive on your computer.

2. To start the installer, right-click the installer-rpa-robot-win64-2019.11.exe installation file and run it as
an Administrator.

3. After you start the installer, the installation package is extracted, and the Robotic Process Automation
Recorder Installation Wizard automatically opens. Click Next.

4. In the License page, select I Agree, and then click Next.

5. In the Location page, select the location for the installation root directory.

If the directory does not exist, the directory is created automatically. You are prompted to confirm the
creation of the new location.

If you create a directory, you must provide valid characters for the installation path that must include English
letters, digits, spaces and underscores (_) but not the hyphen (-).

The default path is for Windows is: C:\Program Files\Micro Focus\Robotic Process Automation Robot

6. Click Next.

7. In the Prerequisites Information page, click Check Windows Updates.

8. After the Windows updates are successfully verified, click Next

9. In the Option Selection page, select Robotic Process Automation Robot, and then click Next.

If you had already installed UFT during RPA Recorder installation process, the wizard will be disable UFT

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 210
Robotic Process Automation 2019.11

checkbox from selection.

10. In the Queue Configuration page, provide the Queue Configuration port details.

Field name Details

Host Enter the IP or FQDN details of the queue management tool.

Port Provide the port details of the queue management tool. Default is: 5672

Username Provide the username to access the queue management tool.

Password Provide the password to access the queue management tool.

Virtual Host Provide the Virtual Host of your queue management tool.

11. Click Test ports availability. If the ports are available, a Success check mark appears.

a. If you encounter an error, adjust the ports accordingly and try again.

b. If the Success check mark appears, click Next.

12. The Summary page displays the installation and configuration settings that you selected and entered in the
wizard. Check that the settings are correct. If you want to correct one of the items, click Back.

13. Click Install. The installation begins, and the wizard displays a check mark next to each successfully installed
item on the Progress page. When the installation is complete, click Next.

If there is a problem with one of the installation or configured items, the installation attempts to continue with
the rest of the items regardless of that error. You can check the installer.log file located at C:\Micro
Focus\Robotic Process Automation Robot to check and fix errors. Additionally, you can customize the
configuration and use the option to get logging events from all the classes in the code including the 3rd party
for debugging purpose.

14. Click Finish to close the Robotic Process Automation Robot Installation Wizard.

RPA Robot is installed and menu shortcuts are created on your system.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 211
Robotic Process Automation 2019.11

Related Topics
To install RPA RAS, see Install RPA RAS.
To install RPA in a cluster environment, see Install an RPA cluster.
To install RPA Recorder component, see Install RPA Recorder.
For troubleshooting UFT configuration during installation, see Unable to configure UFT.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 212
Robotic Process Automation 2019.11

Install RPA Central and RPA RAS


This section describes how to perform installation of both RPA Central and RPA RAS in Windows and Linux
environments.
Before starting this installation, ensure you have administrative rights.

1. Download the RPA_Product_SW_and_Doc_2019.11_rpa-2019.11.0.0.zip ZIP file from the Software Licenses and
Downloads Portal and extract it into a local drive on your computer.

2. To start the installer:

a. On Windows: Right-click the installer-rpa-win64-2019.11.exe installation file.

b. On Linux: Right-click the installer-rpa-linux64-2019.11.bin and run it as an administrator or run the


following command from a Linux desktop/an X-Window terminal:

bash installer-rpa-linux64-2019.11.bin

3. After you start the installer, the installation package is extracted, and the Robotic Process Automation
Installation and Configuration Wizard automatically opens.

4. In the License page, select I Agree, and then click Next.

5. In the Location page, select the location for the installation root directory, and then click Next.

If the directory does not exist, the directory is created automatically. You are prompted to confirm the
creation of the new location.

If you create a directory, you must provide valid characters for the installation path that must include English
letters, digits, spaces, hyphens (-) and underscores (_).

The default path for Windows and Linux is:

a. Windows: C:\Program Files\Micro Focus\Robotic Process Automation

b. Linux: /opt/microfocus/rpa

6. In the Option Selection page, select Central and Remote Action Server (RAS) check boxes, and then

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 213
Robotic Process Automation 2019.11

click Next.

7. In the Central Cluster page, click Next to pass through the cluster Step without modifying anything

8. In the Connectivity page, configure the Central Server ports and TLS properties.

Default values (8080 and 8443) appear for each port, however you can change the port details.

9. Select Disable HTTP Port and configure a port in the HTTPS field.

This option is recommended for security reasons, so that the communication channel is encrypted.
Configuring at least one port is mandatory. If a port is not defined, or if the ports are occupied by other
applications, you will not be able to complete the installation.

10. Select Allow HTTP access and configure two ports in the HTTP and HTTPS fields.

This option is not recommended due to security reasons. However, you can undo the selection after the
installation.

11. Select Provide a secure TLS certificate, and then click Browse to select the certificate.

This step is recommended, for security reasons. If you do not select a Central TLS certificate, RPA uses a self-
signed certificate.

Note Do not use a network path for the location of the Central TLS certificate.

12. If you had selected a Central TLS certificate, enter its password, and enter it again for confirmation.

13. Click Browse to specify the location of the CA root certificate, which will be imported into the TrustStore for
Central/RAS. You must ensure to not usea network path for the location of the CA root certificate.

Note Because you are installing Central and RAS together, the Do not start
Central server after installation option is not available. This is because the
RAS server needs to connect to the Central server. If Central is not started,
the installation of the RAS will fail.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 214
Robotic Process Automation 2019.11

14. Click Test ports availability. If the ports are available, a Success check mark appears.

a. If you encounter an error, adjust the ports accordingly and try again.

<il> If the Success check mark appears, click Next.

15. In the IDM Configuration page, you can install a centralized IDM service or you can connect to an existing
IDM service. You can also choose to use the RPA built-in authentication mechanism.

16. If you choose to create an IDM service, perform the following steps:

a. In the Tenant field, enter the value of the tenant to be configured in the IDM service. The default value
is "RPA".

b. In the Signing Key field, enter the value of the IDM configuration signing key. The signing key must be
at least 32 characters and must contain lower case, upper case, and numeric letters.

c. In the RPA Central Credentials area, admin field, enter the administrator user name of the IDM
integration account.

d. In the ooadmin field, , enter the password for the user who has the SUPER_IDM_ADMIN role. This user is
an elevated API user and is used only for API calls between RPA and IDM. This user is not to be used to
log in to RPA as the role assigned to the user is "END_USER”.

Note The ooadmin, idmTransportUser, oopromoter, ooenduser, and


ooeverybody do not respect password policy requirements. You must
ensure that the password is of at least 8 characters and must contain
lowercase, uppercase, number, and a special character.

e. In the idmTransportUser field, enter your IDM integration account details

.
f. In the oopromoter field, enter the password for the user with the PROMOTER role. This user can access
the Content Management and Run Management workspaces.

g. In the oosysadmin field, enter the password for the user with the SYSTEM_ADMIN role. This user can
access the System Configuration and the Run Management workspaces.

h. In the ooenduser field, enter the password for the user with the END_USER role. This user can access
only the Run Management workspace.

i. In the ooeverybody field, enter the password for the user with the EVERYBODY role. This user can
access only the Run Management workspace.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 215
Robotic Process Automation 2019.11

j. Select the Save the passwords to a file check box if you want save the information in this screen to a
file. If you select the check box, browse and select a file in which information from this page will be
saved. The default IDM transport user and IDM transport password are also saved in this file
(idm.configuration.username and idm.configuration.password).

17. If you choose to connect to an existing IDM service, perform the following steps:

a. In the IDM URL field, enter the he URL of the IDM service.

For example, <idm_protocol>://<idm_hostname>:<idm_port>/<idm_service_path>

b. In the IDM Transport Username field, enter the user name of the IDM REST integration.

c. In the IDM Transport Password field, enter the IDM REST integration password.

d. In the Signing Key field, enter the signing key for the IDM configuration. The signing key must be of at
least 32 characters and must contain lowercase, uppercase, and numeric letters.

e. In the Tenant Credentials area, Tenant field, enter the tenant value of Central to be configured in the
IDM service. The default value "RPA".

f. In the IDM Administrator Username field, enter the user name of the user with full access to the IDM
database.

g. In the IDM Administrator Password field, enter the password of the IDM administrator user.

You must create a new database for the IDM component and provide the authentication details of the
user with access to that database.

18. In the Central Database Configuration page, you configure and create the database schema.

If you have user input in two languages apart from English (for example, German and Chinese) then MS SQL
should not be used. You should use an alternative database such as Oracle, or PostgreSQL with the
recommended Unicode configuration for RPA Central.

a. From the Database Type list, select the database vendor, and then enter the connection properties.

i. When the Connect to existing database/schema option is selected, the installer verifies that
the schema/database and user exist. It is recommended to not to use administrative user accounts
in the Username and Password fields, because this will install RPA Central under the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 216
Robotic Process Automation 2019.11

administrative account.

You can then select from the following database types:

Database Fields

Oracle database JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver
jar file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
SID or Service Name: Select either of the two and then enter the SID or
service name of the database.
It is recommended to use Oracle database's service name rather than
using the SID.
Username: Enter the Username to connect with the Oracle database
that you created
Password: Enter the password to connect with the Oracle database that
you created

Microsoft SQL Server Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Microsoft SQL
Server database that you created
Password: Enter the password to connect with the Microsoft SQL Server
database that you created

Oracle MySQL JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver
jar file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database
that you created
Password: Enter the password to connect with the Oracle database that
you created
It is advised to not to use the root credential in the Username and
Password fields.
If you are installing Operations Orchestration with Oracle RAC (Real
Application Cluster), you must choose Other database and provide the
URL.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 217
Robotic Process Automation 2019.11

Database Fields

PostgreSQL Hostname or IP address: Enter the Hostname or IP address of the VM


that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database
that you created
Password: Enter the password to connect with the Oracle database that
you created

Internal database This uses an H2 local database. This should not be used for production.

Other database (use to enable advanced features in supported databases). If you select
Other database, you can only use a database type that is supported for
use with RPA. It supports any valid JDBC URL.
JDBC Driver jar: Browse and select the jar file of other database.
JDBC Driver class name: Enter the class name of the other database.
JDBC URL: Enter the valid JDBC URL to connect with other database.
Username: Enter the Username to connect with other database that
you created.
Password: Enter the password to connect with other database that you
created.

ii. When the Create the database/schema option is used, it enables you to create a new database
or schema.

You can then select from the following database types:

Database type Description

Oracle Do not use SYS, SYSTEM, or other administrative accounts credentials in


the Username and Password fields. If you are using Oracle 11g R2 or 11g
R2 RAC, it is recommended to apply patch 20299013 before installing RPA
Central.

Microsoft SQL Do not use sa or other administrative account credentials in the Username
Server and Password fields. If you are installing RPA with Oracle RAC (Real
Application Cluster), you must choose Other database and provide the URL.

PostgreSQL Do not use the PostgreSQL credential in the Username and Password fields.
You may note that PostgreSQL database names are case-sensitive. You
may note that PostgreSQL database names are case-sensitive.

Internal database This uses an H2 local database. This should not be used for production.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 218
Robotic Process Automation 2019.11

Database type Description

Other database (use to enable advanced features in supported databases). If you select
Other database, you can only use a database type that is supported for use
with RPA. It supports any valid JDBC URL.

Database Fields

Oracle database JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the the FQDN (Fully Qualified Domain
Name) of the Hostname or IP address of the VM that has the database. If
you want to use IPv6, put the IPv6 address in brackets, for example,
[3fff::20]. Otherwise, errors will occur.
Port: The connection port for Oracle database is selected by default
SID or Service Name: Select either of the two and then enter the SID or
service name of the database.
It is recommended to use Oracle database's service name rather than
using the SID.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
DBA Username: Enter the Username to connect with the Oracle
database that you created
DBA Password: Enter the password to connect with the Oracle database
that you created. This elevated-privileges user must be able to connect to
the database and create the new schema, user, or database for
Operations Orchestration.
Tablespace: Enter the Oracle datafile Tablespace path
Temporary tablespace: Enter the Oracle Temporary tablespace path

Microsoft SQL Server Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Microsoft SQL Server
database that you created
Password: Enter the password to connect with the Microsoft SQL Server
database that you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
Microsoft SQL Server database
Admin Password: Enter the Administrator password to connect with the
Microsoft SQL Server database

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 219
Robotic Process Automation 2019.11

Database Fields

Oracle MySQL JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
Oracle MySQL database
Admin Password: Enter the Administrator password to connect with the
Oracle MySQL database

PostgreSQL Hostname or IP address: Enter the Hostname or IP address of the VM


that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
PostgreSQL database
Admin Password: Enter the Administrator password to connect with the
PostgreSQL database

Internal database This option is disabled.

19. Click Test Connection to test the database settings. If you are unable to connect to the database, you will
not be able to proceed to the next steps in the wizard.

If your password is not strong enough, a warning is displayed. You will still be able to proceed with the
installation, but it is strongly recommended to replace it with a stronger password.

The installer checks for non-empty schemas/databases, and shows a warning message if the schema or
database is not empty. If the installation fails during schema validation, the installation process is stopped.

Note This test only verifies the connection between RPA and the selected
database, and does not verify the conditions required by the database, like

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 220
Robotic Process Automation 2019.11

the user's read/write permissions on the provided schema.

Note For all the database vendors, if you select to create a new database, the
created database uses case-sensitive collation as follows:

PostgreSQL: Case-sensitive by design. No need for specific settings. UTF-8


encoding is supported
Oracle: Case-sensitive by default. No need for specific settings. UTF-8
encoding is supported.
MS SQL: Use only the following database collations per your required
language:

English: SQL_Latin1_General_CP1_CS_AS

Japanese: Japanese_Unicode_CS_AS

Simplified Chinese: Chinese_Simplified_Stroke_Order_100_CS_AS

German: SQL_Latin1_General_CP1_CS_AS

French: French_100_CS_AS

Spanish: SQL_Latin1_General_CP1_CS_AS

However, if you already have a database installed, RPA creates the tables
using the database specific collation. It is important to note that using other
collations can cause characters to appear in gibberish in the user interface for
localized installations. In addition, other collations are not officially supported
in Microsoft SQL Server for localized installations.

If the installer is used in order to create a new SQL Server database, selecting
your language in the language selection page sets the correct collation for the
new database.

Using one of the above collations enables using the varchar datatype for
textual columns instead of the nvarchar data type. Using the varchar data

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 221
Robotic Process Automation 2019.11

type is more efficient and reduces overall database size.

Selecting a specific language also means that an RPA system that uses SQL
Server is limited to the set of languages supported by that specific collation.
For example, if the SQL_Latin1_General_CP1_CS_AS collation is used,
English, German, and Spanish characters may be used, but Japanese
characters may not. If Japanese_Unicode_CS_AS is used, French accent
characters will not be presented properly. For the complete specification of
each collation, see the Microsoft SQL Server documentation.

20. In the IDM Database Configuration, enter your IDM service credentials in the following fields:

IMPORTANT:

If you had selected MS SQL as the database type previously, you


must set the Database COLLATION to CASE INSENSITIVE (Example:
SQL_Latin1_General_CP1_CI_AS) and then run the following queries
to set the snapshot isolation and read committed snapshot flags to
true

ALTER DATABASE <DB_NAME> SET ALLOW_SNAPSHOT_ISOLATION ON ALTER


DATABASE <DB_NAME> SET READ_COMMITTED_SNAPSHOT ON

Note: The IDM database that you are configuring must be empty. Otherwise,
a warning message is displayed when testing the connection.

a. (For Oracle) Select either SID or Service Name, and enter the SID or service name of the database.
The default SID value is "ORCL".

b. In the IDM Database Name field, enter the database name created for IDM service.

c. In the IDM Database Username field, enter the user name of the user with full access to the IDM
database.

d. In the IDM Database Password field, enter the password for the specified user.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 222
Robotic Process Automation 2019.11

21. In the Queue Configuration page, provide the queue configuration details. If your RabbitMQ connection is
secured, the installer is able to automatically detect and adapt to the required configuration.

Field name Details

Host Enter the IP or FQDN details of the Queue management application.

Port Provide the port details of the queue management tool. Default is: 5672

Username Provide the username to access the queue management tool.

Password Provide the username to access the queue management tool.

Virtual Host Provide the Virtual Host of your queue management tool.

22. In the Language page, select a supported language for RPA, in addition to English, and then click Next.

This language support will be used for:

a. The MS SQL collation language, if relevant

b. The central-wrapper.conf language for content. This language support may be required if, for
example, you need to ping a server that is configured in Japanese.

You can also change the language support choice after installation, by editing the central-
wrapper.conf file, located in the installation directory under central/conf.

23. The Summary page displays the installation and configuration settings that you selected and entered in the
wizard. Check that the settings are correct. If you want to correct one of the items, click Back.

24. Click Install. The installation begins, and the wizard displays a check mark next to each successfully installed
item on the Progress page. When the installation is complete, click Next.

Note If there is a problem with one of the installation or configured items, the
installation attempts to continue with the rest of the items regardless of that
error. Check the installer.log file (the default located is C:\Micro
Focus\Robotic Process Automation for Windows), to check for errors.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 223
Robotic Process Automation 2019.11

25. (Optional) In the Finish page, select Open Welcome Page to display the RPA Welcome page in your default
web browser, in the language that was selected on the Language page.

26. Click Finish to close the Installation and Configuration wizard.


RPA Central and RPA RAS are installed and menu shortcuts are created on your system.

The installation is of the trial version of RPA. Install a commercial license within 60 days.

Related topics
For instructions on how to manage license, see Manage RPA Licenses.
For instructions to install RPA in a cluster environment, see Install an RPA cluster.
To set up security for RPA Central, see Set up security for RPA Central.
For information on pre-installation tasks, see Pre-installation tasks.
To set up database environment, see Set up database environment.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 224
Robotic Process Automation 2019.11

Install RPA Self-Service X


This section provides the information required to install Robotic Process Automation (RPA) Self-Service X in the
Windows and Linux environment. RPA Self-Service X works only when connected to RPA Central. Hence, ensure
that RPA Central is installed prior to attempting to install RPA Self-Service X.
To install RPA Self-Service X, complete the following steps:
Before starting this installation, ensure you have administrative rights.

1. Download the RPA_Product_SW_and_Doc_2019.11_rpa-2019.11.0.0.zip file from the Software Licenses and


Downloads Portal and extract it into a local drive on your computer.

2. To start the installer:

a. On Windows: Right-click the installer-rpa-ssx-win64-2019.11.exe installation file and run it as an


Administrator.

b. On Linux: Right-click the installer-rpa-ssx-linux64-2019.bin file as an Administrator and run this


command from a Linux desktop/an X-Window terminal:

bash installer-rpa-ssx-linux64-2019.bin

3. After you start the installer, the installation package is extracted, and the Micro Focus RPA Self-Service X
Installation Wizard automatically opens. Click Next.

4. In the License page, select I Agree, and then click Next.

5. In the Location page, select the location for the installation root directory.

If the directory does not exist, the directory is created automatically. You are prompted to confirm the
creation of the new location. Click Yes.

If you create a directory, you must provide valid characters for the installation path that must include English
letters, digits, spaces, hyphens (-) and underscores (_).

The default path for Windows and Linux are:

a. Windows: C:\Program Files\Micro Focus\Self-Service X

b. Linux: /opt/microfocus/ssx

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 225
Robotic Process Automation 2019.11

6. Click Next.

7. In the Option Selection page, select Self-Service X, and then click Next.

8. In the Connectivity page, configure the RPA Self-Service X ports and TLS properties.

Default values (8446) appear for HTTPS port, but you can change the port values.

Configuring a port is mandatory. If a port is not defined, or if the ports are occupied by other applications, you
will not be able to complete the installation.

9. Select Provide a secure TLS certificate, and then click Browse to select the certificate.

This step is recommended, for security reasons. If you do not select a Central TLS certificate, Self-Service X
will use a self-signed certificate.

Do not use a network path for the location of the Self-Service X TLS certificate.

10. If you select a Self-Service X TLS certificate, enter its password, and enter it again for confirmation.

11. Click Browse to specify the location of the CA root certificate, which will be imported into the TrustStore for
Self-Service X.

You must ensure to not use a network path for the location of the CA root certificate.

12. Select Do not start Self-Service X server after installation if you are configuring Self-Service X to be
compliant with FIPS 140-2

13. Click Test ports availability. If the ports are available, a Success check mark appears.

a. If you encounter an error, adjust the ports accordingly and try again.

b. If the Success check mark appears, click Next.

14. In the Database Configuration page, you must configure and create the database schema.

If you have user input in two languages apart from English (for example, German and Chinese) then MS SQL
should not be used. You should use an alternative database such as Oracle, or PostgreSQL with the
recommended Unicode configuration for RPA Self-Service X .

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 226
Robotic Process Automation 2019.11

a. From the Database Type list, select the database vendor, and then enter the connection properties.

i. When the Connect to existing database/schema option is selected, the installer verifies that the
schema/database and user exist. It is recommended to not to use administrative user accounts in
the Username and Password fields, because this will install RPA Self-Service X under the
administrative account.

You can then select from the following database types:

Database Fields

Oracle database JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
SID or Service Name: Select either of the two and then enter the SID or
service name of the database.
It is recommended to use Oracle database's service name rather than
using the SID.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created

Microsoft SQL Server Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Microsoft SQL Server
database that you created
Password: Enter the password to connect with the Microsoft SQL Server
database that you created

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 227
Robotic Process Automation 2019.11

Database Fields

Oracle MySQL JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
It is advised to not to use the root credential in the Username and
Password fields.
If you are installing Self-Service X with Oracle RAC (Real Application
Cluster), you must choose Other database and provide the URL.

PostgreSQL Hostname or IP address: Enter the Hostname or IP address of the VM


that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created

Internal database This uses an H2 local database. This should not be used for production.

Other database (use to enable advanced features in supported databases). If you select
Other database, you can only use a database type that is supported for
use with OO. It supports any valid JDBC URL.
JDBC Driver jar: Browse and select the jar file of other database.
JDBC Driver class name: Enter the class name of the other database.
JDBC URL: Enter the valid JDBC URL to connect with other database.
Username: Enter the Username to connect with other database that you
created.
Password: Enter the password to connect with other database that you
created.

ii. When the Create the database/schema option is used, it enables you to create a new database
or schema.

You can then select from the following database types:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 228
Robotic Process Automation 2019.11

Database type Description

Oracle Do not use SYS, SYSTEM, or other administrative accounts credentials in the
Username and Password fields. If you are using Oracle 11g R2 or 11g R2
RAC, it is recommended to apply patch 20299013 before installing RPA Self-
Service X.

Microsoft SQL Do not use sa or other administrative account credentials in the Username
Server and Password fields. If you are installing OO with Oracle RAC (Real
Application Cluster), you must choose Other database and provide the URL.

PostgreSQL Do not use the PostgreSQL credential in the Username and Password fields.
You may note that PostgreSQL database names are case-sensitive. You may
note that PostgreSQL database names are case-sensitive.

Internal database This uses an H2 local database. This should not be used for production.

Other database (use to enable advanced features in supported databases). If you select
Other database, you can only use a database type that is supported for use
with OO. It supports any valid JDBC URL.

Database Fields

Oracle database JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the the FQDN (Fully Qualified Domain
Name) of the Hostname or IP address of the VM that has the database. If
you want to use IPv6, put the IPv6 address in brackets, for example,
[3fff::20]. Otherwise, errors will occur.
Port: The connection port for Oracle database is selected by default
SID or Service Name: Select either of the two and then enter the SID or
service name of the database.
It is recommended to use Oracle database's service name rather than using
the SID.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
DBA Username: Enter the Username to connect with the Oracle database
that you created
DBA Password: Enter the password to connect with the Oracle database
that you created. This elevated-privileges user must be able to connect to
the database and create the new schema, user, or database for RPA Self-
Service X.
Tablespace: Enter the Oracle datafile Tablespace path
Temporary tablespace: Enter the Oracle Temporary tablespace path

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 229
Robotic Process Automation 2019.11

Database Fields

Microsoft SQL Server Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Microsoft SQL Server
database that you created
Password: Enter the password to connect with the Microsoft SQL Server
database that you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
Microsoft SQL Server database
Admin Password: Enter the Administrator password to connect with the
Microsoft SQL Server database

Oracle MySQL JDBC Driver jar: Select the path of the downloaded Oracle JDBC driver jar
file as part of your preinstallation task
Hostname or IP address: Enter the Hostname or IP address of the VM
that has the database
Port: The connection port for Oracle database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
Oracle MySQL database
Admin Password: Enter the Administrator password to connect with the
Oracle MySQL database

PostgreSQL Hostname or IP address: Enter the Hostname or IP address of the VM


that has the database
Port: The connection port for database is selected by default
Database: Enter the name of the database.
Username: Enter the Username to connect with the Oracle database that
you created
Password: Enter the password to connect with the Oracle database that
you created
Confirm Password: Reenter the password confirm
Admin Username: Enter the Administrator Username to connect with the
PostgreSQL database
Admin Password: Enter the Administrator password to connect with the
PostgreSQL database

Internal database This option is disabled.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 230
Robotic Process Automation 2019.11

15. Click Test Connection. If you are unable to connect to the database, you will not be able to proceed to the
next steps in the wizard.

If your password is not strong enough, a warning is displayed. You will still be able to proceed with the
installation, but it is strongly recommended to replace it with a stronger password.

The installer checks for non-empty schemas/databases, and shows a warning message if the schema or
database is not empty. If the installation fails during schema validation, the installation process is stopped.

This test only verifies the connection between Robotic Process Automation and the selected database, and
does not verify the conditions required by the database, like the user's read/write permissions on the
provided schema.

For all the database vendors, if you select to create a new database, the created database uses case-
sensitive collation as follows:

PostgreSQL: Case-sensitive by design. No need for specific settings. UTF-8 encoding is supported
Oracle: Case-sensitive by default. No need for specific settings. UTF-8 encoding is supported.
MS SQL: Use only the following database collations per your required language:

English: SQL_Latin1_General_CP1_CS_AS

Japanese: Japanese_Unicode_CS_AS

Simplified Chinese: Chinese_Simplified_Stroke_Order_100_CS_AS

German: SQL_Latin1_General_CP1_CS_AS

French: French_100_CS_AS

Spanish: SQL_Latin1_General_CP1_CS_AS

However, if you already have a database installed, RPA Self-Service X creates the tables using the database
specific collation. It is important to note that using other collations can cause characters to appear in
gibberish in the user interface for localized installations. In addition, other collations are not officially
supported in Microsoft SQL Server for localized installations.

If the installer is used in order to create a new SQL Server database, selecting your language in the language
selection page sets the correct collation for the new database.

Using one of the above collations enables using the varchar datatype for textual columns instead of the
nvarchar data type. Using the varchar data type is more efficient and reduces overall database size.

Selecting a specific language also means that an RPA Self-Service X system that uses SQL Server is limited to

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 231
Robotic Process Automation 2019.11

the set of languages supported by that specific collation. For example, if the
SQL_Latin1_General_CP1_CS_AS collation is used, English, German, and Spanish characters may be used,
but Japanese characters may not. If Japanese_Unicode_CS_AS is used, French accent characters will not be
presented properly. For the complete specification of each collation, see the Microsoft SQL Server
documentation.

16. In the Central Configuration page, provide your RPA Central port and login credential details to establish
connection.

17. Click Test Connection.

a. If you encounter an error, provide valid RPA Central details and try again.

b. If the Success check mark appears, click Next.

18. In the IDM Configuration page, provide the details of your Identity Management service.

a. In the IDM URL field, enter the he URL of the IDM service.

For example, <idm_protocol>://<idm_hostname>:<idm_port>/<idm_service_path>

b. In the IDM Transport Username field, enter the user name of the IDM REST integration.

c. In the IDM Transport Password field, enter the IDM REST integration password.

d. In the Signing Key field, enter the signing key for the IDM configuration. The signing key must be of at
least 32 characters and must contain lowercase, uppercase, and numeric letters.

e. In the Tenant Credentials area, Tenant field, enter the tenant value of Central to be configured in the
IDM service. The default value is "RPA".

f. Click Test Connection.

i. If you encounter an error, provide valid IDM service details and try again.

ii. If the Success check mark appears, click Next.

19. In the Language page, select a supported language for RPA Self-Service X, and then click Next.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 232
Robotic Process Automation 2019.11

Note In this release RPA Self-Service X supports only English language.

20. The Summary page displays the installation and configuration settings that you selected and entered in the
wizard. Check that the settings are correct. If you want to correct one of the items, click Back.

21. Click Install. The installation begins, and the wizard displays a check mark next to each successfully installed
item on the Progress page. When the installation is complete, click Next.

Note If there is a problem with one of the installation or configured items, the
installation attempts to continue with the rest of the items regardless of that
error. Check the installer.log file (the default located is C:\Program
Files\Micro Focus\Self-Service X for Windows), to check for errors.

22. (Optional) In the Finish page, select Open Welcome Page to display the RPA Self-Service X Welcome page
in your default web browser, in the language that was selected on the Language page.

23. Click Finish to close the Installation and Configuration wizard.

Related topics
For instructions to install RPA Central, see Install RPA Central.
To access RPA Self-Service X, see Access RPA Self-Service X.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 233
Robotic Process Automation 2019.11

Install an RPA cluster


This section provides the information required to install an Robotic Process Automation (RPA) Central in a cluster
environment.
Clustering provides high availability and scalability to enhance throughput. You do not need external clustering
software or a requirement for a shared file system.
To create a cluster, you run the Installation wizard to create the first RPA Central. Then, you run it again on the
other machine to create the next node. During the second installation, ensure to point to the same database
schema.
In a clustered environment, you must synchronize the clock times on all computers to a second. It is recommended
to use NTP sync to regularly maintain an accurate system time between all nodes (RPA Central and RPA RASes). If
a RPA Central node is connected to a specific RAS and is shut down, the connection to the RAS is automatically
moved to another working node. The RAS might be disconnected for up to three minutes. The identification may
take two minutes and the RAS reconnection up to one minute.
Before starting this installation, ensure you have administrative rights.
To install the first RPA Central node as a stand-alone RPA Central, complete the following steps in the Installation
wizard:

1. Download the RPA_Product_SW_and_Doc_2019.11_rpa-2019.11.0.0.zip file from the Software Licenses and


Downloads Portal and extract it into a local drive on your computer.

2. To start the installer:

a. On Windows: Right-click the installer-rpa-win64-2019.11.exe installation file and run it as an


administrator.

b. On Linux: Right-click the installer-rpa-linux64-2019.11.bin file and run it as an administrator or run


this command from a Linux desktop/an X-Window terminal:

bash installer-rpa-linux64-2019.11.bin

3. After you start the installer, the installation package is extracted, and the Robotic Process Automation
Installation and Configuration Wizard automatically opens. Click Next.

4. In the License page, select I Agree, and then click Next.

5. In the Location page, select the location for the installation root directory.

The default paths for Windows and Linux are:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 234
Robotic Process Automation 2019.11

a. Windows: C:\Program Files\Micro Focus\Robotic Process Automation

b. Linux: /opt/microfocus/rpa

If the directory does not exist, the directory is created automatically. You are prompted to confirm the
creation of the new location.

If you create a directory, you must provide valid characters for the installation path that must include English
letters, digits, spaces, hyphens (-) and underscores (_).

6. In the Options page, select Central and click Next.

7. In the Central Cluster page, click Next, without selecting any options.

You will select the clustering options when you install the other nodes.

8. In the Connectivity page, configure available ports for the Central Server. Default values (8080 and 8443)
appear for each port, however you can change the port details. Choose one of the following options:

9. Select Disable HTTP Port and configure a port in the HTTPS field.

This option is recommended for security reasons, so that the communication channel is encrypted.

10. Select Allow HTTP access and configure two ports in the HTTP and HTTPS fields.

This option is not recommended for security reasons

11. Select Provide a secure TLS certificate, and then click Browse to select the certificate.

This step is recommended, for security reasons. If you do not select a RPA Central TLS certificate, RPA uses
the default self-signed certificate.

12. If you select Central TLS certificate, enter its password, and enter it again for confirmation.

13. Click Browse to specify the location of the CA root certificate, which will be imported into the TrustStore for
Central/RAS. You must ensure to not use a network path for the location of the CA root certificate.

14. Select Do not start Central server after installation if you are configuring RPA to be compliant with FIPS
140-2.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 235
Robotic Process Automation 2019.11

If you are installing RPA Central and RPA RAS together this option is not
available.

15. Click Test ports availability. If the ports are available, a Success check mark appears. Click Next.

16. If you encounter an error, adjust the ports accordingly, and try again

17. In the Database Connection page, configure and create the database schema.

18. After the first RPA Central has been installed, collect the following files.

File Description Location

database.properties Defines the properties <installation dir>/central/conf/database.properties


of the database.

queue.properties Defines the properties <installation dir>/central/conf/queue.properties


of the queue
connection.

encryption properties Defines how the <installation dir>/central/var/security/encryption


database is encrypted. properties

encryption_repository Used to store the <installation


database encryption dir>/central/var/security/encryption_repository
details.

JDBC driver This is needed only if The location will vary


you are using an
Oracle database.

19. Start the Installer and install the next RPA Central node in the cluster. Complete the first four pages in the
Installation wizard: Welcome, License, Location, and Options.

If you modify the keystore password on the first node, you must apply the
same configuration changes on the additional nodes.

20. Copy the cluster install files to the server on which you are installing this RPA Central node.

21. In the Central Cluster page, select Add a node to the existing Central cluster.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 236
Robotic Process Automation 2019.11

In a cluster setting, you must not mix nodes with IDM authentication and
nodes with native authentication. If the cluster to which you are adding a node
uses IDM authentication, in the IDM Configuration screen select the Connect
to an existing IDM option.

22. Click Browse and select the cluster files from the location where you copied them:

a. database.properties

b. queue.properties

c. encryption properties

d. encryption_repository

23. Once you have installed two nodes, and are installing a third, you can copy the cluster files from either

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 237
Robotic Process Automation 2019.11

server, because they contain the same data.

24. If the First Node was installed with an Oracle Database, provide the location of the JDBC driver in the Central
Cluster page and then click Next, else go to the next step.

25. In the Connectivity page, configure available ports for the Central Server. Choose one of the following
options:

a. Select Disable HTTP Port and configure a port in the HTTPS field.

This option is recommended for security reasons, so that the communication channel is encrypted.

b. Select Allow HTTP access and configure two ports in the HTTP and HTTPS fields.

This option is not recommended for security reasons.

26. Select Provide a secure TLS certificate, and then click Browse to select the certificate.

27. If you select the Central TLS certificate enter its password, and enter it again for confirmation

28. Click Browse to specify the location of the CA root certificate, which will be imported into the TrustStore for
RPA Central/RAS. You must ensure to not usea network path for the location of the CA root certificate.

29. Select Do not start Central server after installation if either of the following is true:

a. You are configuring Robotic Process Automation to be compliant with FIPS 140-2

30. Click Test ports availability. If the ports are available, a Success check mark appears, Click Next. If you
encounter an error, adjust the ports accordingly and retry.

31. In the Language page, you can select a supported language for Robotic Process Automation, in addition to
English.

32. The Summary page displays the installation and configuration settings that you selected and entered in the
wizard. Check that the settings are correct. If you want to correct one of the items, click Back.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 238
Robotic Process Automation 2019.11

33. Click Install. The installation begins, and the wizard displays a check mark next to each successfully installed
item on the Progress page. When the installation is complete, click Next.

Note If there is a problem with one of the installation or configured items, the
installation attempts to continue with the rest of the items regardless of that
error. Check the installer.log file, located in C:\Micro Focus\RPA (or
selected installation folder), to check for errors.

34. (Optional) In the Finish page, select Open Welcome Page to display the Robotic Process Automation
Welcome page in your default web browser, in the language that was selected on the Language page.

35. Click Finish to close the Installation and Configuration wizard.

Central is installed and menu shortcuts are created on your system.

Verify RPA Central topology screen to ensure the node


was successfully installed
To verify that the node was successfully installed, you can check the Topology/Workers tab in RPA Central.

1. In Central, click the System Configuration button.

2. Select the Topology /Workers tab and check that the node was successfully installed.

a. If a new component for RPA Central was installed successfully (RPA RAS or cluster node) it will appear on
the screen. If there is no addition on the Topology/Workers screen after the component was installed,
this means that there was a problem and you should inspect the logs.

b. The Topology/Workers screen displays the status of the worker, so you can see if the new component
is viable.

For example, the status will be red (unusable) if there are problems with certificates, failures in the
operation of the worker unrelated to the initial installation, or loss of network connectivity with the
component.

c. All workers display their host name and type. So the Topology/Workers screen can be used to verify
any load balancer configuration issues.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 239
Robotic Process Automation 2019.11

For example, if there are three Centrals in the topology and only two in the load balancer, there is a
clear configuration issue within the environment.

Install another node


Repeat the process as often as required.
To install the next node, go back to Add a Node to an Existing Cluster topic.

Configure the load balancer


If you are using a load balancer, reverse proxy, or DNS load balancer, configure it according to your policies. This
step will vary depending on which load balancer or reverse proxy you are using. Contact your vendor for more
information.
If you are using a load balancer, reverse proxy, or DNS load balancer, tell Robotic Process Automation where the
relevant external URL is located.

1. In RPA Central, click the System Configuration button.

2. Select System Settings>General.

3. In the URL box, enter the URL of the load balancer, reverse proxy, or DNS load balancer.

4. Click Save.

Installation complete
The installation of the cluster is now complete.
After the installation of the cluster, nothing needs to be disabled. The start point and destination point of the
cluster are the same. The cluster has more internal workers and you can see all RPA Central nodes in your load
balancer.
If the first RPA Central node has a commercial license, then the second one does not need a new one.
If no license is available from the first node, the installation is of the Trial version of Robotic Process Automation.
Install a commercial license within 60 days.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 240
Robotic Process Automation 2019.11

Related topics
For instructions to install RPA Central, see Install RPA Central.
For details of RPA licenses, see Manage RPA Licenses.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 241
Robotic Process Automation 2019.11

Silent installation
A silent installation is one that is started from the command line and completes without any manual input from the
user. There is no need to provide input through a wizard or dialog boxes. The silent installation receives its input
from a Text input file.

Important information about silent installation


Ensure there are no trailing spaces in the property values to avoid incorrect reading and subsequent installation
failure.
Escape all property values that contain a backslash ('\') in the silent.properties file using the double-backslash
instead of a single one. This will be required in the following situations:

In Japanese environments, escape the path separator is the Yen sign in all the paths given. For example,
C:¥¥folder
For RPA-RAS installations with a LDAP user given in form of 'domain\user'. For example, domain\user
For a database user, if the database is set up with Windows system account authentication
For any other user that contains a backslash in the name
There are some instances where the default values are different in a silent installation. For example, when
installing with the wizard, by default the certificate is set to CA (user provided), while in a silent installation, this
defaults to self-signed. When installing with the wizard, by default the HTTP port is disabled, while in a silent
installation, it defaults to enabled.

Related topics
For instructions to install RPA Central and RPA RAS silently, see Silent installation of RPA Central and RPA RAS.
For instructions to install RPA Workflow Designer silently, see Silent installation of RPA Workflow Designer.
For instructions to install RPA Self-Service X silently, see Silent installation of RPA Self-Service X.
For instructions to install RPA Recorder silently, see Silent installation of RPA Recorder.
For instructions to install RPA Robot silently, seeSilent installation of RPA Robot.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 242
Robotic Process Automation 2019.11

Silent installation of Central and RAS


This section describes how to perform a silent installation of RPA Central and RPA RAS components.
To install RPA Central and RPA RAS silently:

1. On the machine where RPA Central and RPA RAS are installed, navigate to C:\Program Files\Micro
Focus\Robotic Process Automation\docs.

2. Using a text editor, open the text file sample-silent.properties that has the required installation and
configuration settings. This file is also available in the docs folder on the ZIP file. For more details about
these settings, see the descriptions in the sample-silent.properties text file at the end of this page.

3. Save a copy of the text file as silent.properties.

4. Remove the comment sign (#) from the properties that you need, and add the value for each of these
properties.

5. From a command line, type the following example code:

rpa-installer-win64.exe -gm2 -s c:\\temp\my-silent.properties

6. To disable the extracting installation files progress bar, add to the command line -gm2 before -s.

7. To disable the extracting installation files progress bar, add to the command line -gm2 before -s. The gm2 is
not supported with Linux. You can use the -n option if you do not want to start RPA Workflow Designer after
the installation has completed. The -s property accepts either a full or relative path depending on the
operating system:

Windows: Relative to the location of the .exe file.

For example: If dirA, is the current directory, and dirB is located under dirA and contains the
installer and silent.properties file.

Open a Command window in dirA and enter the following command: dirB\\installer.exe -s
silent.properties

You must add two backslashes \\ and not one backslash \. The installation folder to which you
download the installation file must not contain any spaces in the name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 243
Robotic Process Automation 2019.11

Linux: Relative to the location of the directory where the installer is launched.

Sample

######################################## #### #### General Properties #### ### Root directory of


the installation # root.dir= # On Windows, the path must be with / or with \\ # Example (Windows):
root.dir=c:/Program Files/Micro Focus/Robotic Process Automation # Example (Linux):
root.dir=/opt/microfocus/rpa ### What to install # install.java= # Valid values: true, false #
Default: true # This is required. You should only set this to false if Java Runtime has already been
installed in the target directory. # install.ras= # Valid values: true, false # Default: false #
install.central= # Valid values: true, false # Default: true # install.docs= # Valid values: true,
false # Default: true ### Central server ports # http.port= # Default: 8080 # https.port= #
Default: 8443 ### HTTP port access # http.port.access=enable # Options: enable (HTTP access is
enabled) # Options: disable (HTTP access is disabled) # Default: http.port.access=enable # Micro
Focus recommends to disable the HTTP port and to use a TLS certificate for security reasons. ###
Whether to start Central after the installation # should.start.central= # Valid values: true, false
# If you are configuring Micro Focus RPA to be compliant with FIPS 140-2, this must be set to false.
# If you are installing a new Central in cluster mode and the installer version is older # than the
current Central, this must be set to false. # If you are upgrading from 9.x OR installing a RAS
together with Central, Central will be # started, regardless of how this property is set. ###
Select a supported language for Micro Focus Robotic Process Automation, in addition to English. #
language= # Valid values: en, fr, de, ja, es, ch # Default: en # This configures the language for
Central in central-wrapper.conf. # For Central, this also changes the database schema language for
SQL Server. ######################################## #### #### IDM configuration #### ### Whether
to install or connect to an IDM service # idm.mode= # Valid values: native, connect, create. #
Default: native # native: use RPA built-in authentication # connect: connects to an existing IDM
service # create: installs the IDM service. ### ### Properties relevant only for idm.mode=create
### This option installs the IDM service along with RPA Central. ### #
idm.configuration.internal.password= # The password for the IDM super-user account, the super user
in IDM is named 'admin' and is used by RPA to communicate with the IDM service. Make sure the
password is at least eight characters long and includes: # * at least one lower case letter [a-z] #
* at least one upper case letter [A-Z] # * at least one number [0-9] # * at least one special
character ~`!@#$%^&*()-_+={}[]|\;:<>,./?" # idm.configuration.signing.key= # The IDM configuration
signing key. The signing key should be at least 32 characters. It must contain lower case, upper
case and numeric characters. # idmExportConfigurationToFile= # Boolean value specifying whether to
export IDM configurations to a file. # Possible values: true, false. # Default value: false #
idmExportFilePath= # Absolute path to the export file location including the file name. # On
Windows, the path must be with / or with \\ # Example (Windows): idmExportFilePath=c:/Program
Files/Micro Focus/idm-saved-configurations.txt # Example (Linux): idmExportFilePath=/usr/local/micro
focus/idm-saved-configurations.txt # idmOverwriteExportFile= # Boolean value specifying whether to
override an existing file. # Possible values: true, false. # Default value: false #
idm.configuration.oo.admin.password= # ooadmin user password, this is the password for the user with
ADMINISTRATOR role for OO Central. # idm.configuration.oo.promoter.password= # oopromoter user
password, this is the password for the user with PROMOTER role, can access the Content Management
workspace and the Run Management workspace. # idm.configuration.oo.system.admin.password= #
oosystemadmin user password, this is the password for the user with SYSTEM_ADMIN role, can access
the System Configuration workspace and the Run Management workspace. #
idm.configuration.oo.end.user.password= # ooenduser user password, this is the password for the
user with END_USER role, can only access the Run Management workspace. #
idm.configuration.oo.everybody.password= # ooeverybody user password, this is the password for the
user with EVERYBODY role, can only access the Run Management workspace. ### ### Properties

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 244
Robotic Process Automation 2019.11

relevant only for idm.mode=connect ### This option connects RPA Central to an existing IDM service.
### # idm.configuration.url= # IDM service url, format <http or https>://<HOSTNAME>:<PORT>/idm-
service # idm.configuration.username= # The IDM transport username which RPA will use in order to
get the authentication token from IDM service. # Default value: idmTransportUser #
idm.configuration.password= # The IDM transport username's password. #
idm.configuration.signing.key= # The IDM configuration signing key. The signing key should be at
least 32 characters. It must contain lower case, upper case and numeric characters. #
idm.configuration.oo.central.tenant= # The name of the tenant/organization that must exist in IDM. #
Default value: OO_Central # idm.configuration.internal.username= # This is the IDM super-user
account which will be created in IDM. # RPA Central will use this account in order to communicate
with IDM service. # idm.configuration.internal.password= # The password for the IDM super-user
account. Make sure the password is at least eight characters long and includes: # * at least one
lower case letter [a-z] # * at least one upper case letter [A-Z] # * at least one number [0-9] # *
at least one special character ~`!@#$%^&*()-_+={}[]|\;:<>,./?"
######################################## #### #### Properties Relevant to the First Installed
Central in a Cluster, or to a Standalone Central #### ####### Central server database properties
### Define the database type # db.type= # Valid values: oracle, postgresql, mysql, mssql, h2, and
other. # Default value: h2 # For db.type=mysql, db.driver.location MUST be set to the path of a
MySQL JDBC driver (a JAR # file) and for db.type=oracle, db.driver.location MUST be set to the path
of a Oracle JDBC driver (a JAR # file). It is also available for db.type=other. # For db.type=H2,
this uses an H2 local database. This should not be used for production. # For db.type=other, use to
enable advanced features in supported databases. If you select # other, you can only use a database
type that is supported for use with Micro Focus RPA. See the # System Requirements for more
information. ### Define the database driver # db.driver= # Resolved automatically from db.type, but
can be overridden. # Linkage: If db.type is other, this property is required. ### Define the
location of the database JDBC driver # db.driver.location= # Linkage: Required when db.type=mysql
or db.type=other. Required for mySQL even when adding a node to a cluster. # Example:
db.driver.location=c:/tmp/mydriver.jar # Note: This path is an example only. There is no need to
create a tmp directory. ### Define the database JDBC URL # db.url= # This is optional. Set this
value if you want advanced features supported by the driver. # Linkage: If you set this property,
the db.host, db.port, db.name and db.service.name properties are ignored. # MySQL example:
db.url=jdbc:mysql://<host>:<port>/<db.name> # Oracle example with SID:
db.url=jdbc:oracle:thin:@<host>:<port>:<sid> # Oracle example with service name:
db.url=jdbc:oracle:thin:@//<host>:<port>/<service.name> # PostgreSQL example:
db.url=jdbc:postgresql://<host>:<port>/<db.name> # MS Sql example:
db.url=jdbc:jtds:sqlserver://<host>:<port>/<db.name> ### Define the database host name # db.host=
# Linkage: This property is ignored when db.url is used. ### Define the database port # db.port= #
Linkage: This property is ignored when db.url is used. ### Define the database name or SID
(depending on the type of database) # db.name= # Linkage: This property is ignored when db.url is
used. # Example: db.name=ORCL # You cannot use special characters for the database name or SID,
except the underscore (_). # You can enter up to 30 characters for the database name or SID. ###
Define the name of the database user # db.username= # This user name is required when you use the
option to create a database. # The username is required also when connecting to an existing schema,
the difference is # that it’s not being created during the installation. # The user name is
created by the installer and eventually used by Micro Focus RPA. # Example: db.username=joe # In
Oracle, do not use SYS, SYSTEM, or other administrative account credentials. # In Microsoft SQL
Server, do not use sa or other administrative account credentials. # In PostgreSQL, do not use
postgres credentials. # PostgreSQL database names are case-sensitive. ### Define the password of
the database user # db.password= # This password is required when you use the option to create a
database. # The password is required also when connecting to an existing schema, the difference is
# that it’s not being created during the installation. # The password is created by the installer
and eventually used by Micro Focus RPA. # Example: db.password=pass # In Oracle, do not use SYS,
SYSTEM, or other administrative account credentials. # In Microsoft SQL Server, do not use sa or
other administrative account credentials. # In PostgreSQL, do not use postgres credentials. ###
Specify whether to create the database schema during installation # To create the database schema
you must provide the admin user credentials. This is a database user capable of # creating a schema

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 245
Robotic Process Automation 2019.11

or database. Usually, this is a DBA user or a system user # db.create-schema= # Valid values: true,
false # Default: false ### Define the admin user of the database # db.admin.username= # Used to
create a schema/database/user # Example: db.admin.username=postgres ### Define the database admin
user password # db.admin.password= # Used to create a schema/database/user # Example:
db.admin.password=manager ### Define the default tablespace name for the created user (Oracle
only) # db.tablespace= # Example: db.tablespace=USERS # Linkage: Only used when creating a schema
(user) in an Oracle database ### Define the default temporary tablespace name (Oracle only) #
db.temp.tablespace= # Example: db.temp.tablespace=TEMP # Linkage: Only used when creating a schema
(user) in an Oracle database ### Define the database connection type (Oracle only) # Valid values:
sid, service # Default value: sid # db.oracle.connection.type= # Example:
db.oracle.connection.type=sid # Linkage: Only used when setting up an Oracle database ### Define
the database service name (Oracle only) # db.service.name= # Example: db.service.name=orcl_name #
Linkage: Only used when db.oracle.connection.type=service ### Define the database SID (Oracle
only) # db.name= # Example: db.name=orcl_sid # Linkage: Only used when db.oracle.connection.type=sid
####### IDM server database properties # The below configuration parameters are required only when
idm.mode=create, and represent the database to which IDM service will be connected to. # You can
create a new database schema or you can connect to an already existing one. The schema name cannot
be the same as the schema name of RPA Central. # Important note: IDM connects to the same database
host as Central. This means that the database type, hostname and port will be inherited from
Central's database configuration. ### Define the database username # idm.db.username= # This is the
username that IDM will use to connect to it's existing schema. # Example: idm.db.username=idmServer
# In Oracle, do not use SYS, SYSTEM, or other administrative account credentials. # In Microsoft
SQL Server, do not use sa or other administrative account credentials. # In PostgreSQL, do not use
postgres credentials. # PostgreSQL database names are case-sensitive. ### Define the database name
or SID (depending on the type of database) # idm.db.name= # Example: idm.db.name=ORCL # You cannot
use special characters for the database name or SID, except the underscore (_). # You can enter up
to 30 characters for the database name or SID. ### Define the password of the database user #
idm.db.password= # Example: idm.db.password=pass # In Oracle, do not use SYS, SYSTEM, or other
administrative account credentials. # In Microsoft SQL Server, do not use sa or other
administrative account credentials. # In PostgreSQL, do not use postgres credentials. ### Define
the database service name (Oracle only) # idm.db.service.name= # Example:
idm.db.service.name=orcl_service_name # Linkage: Only used when the database is configured to
connect to an Oracle database configured with a service name. # If Central is configured to connect
to an Oracle # Default value: sid # Required only when the Oracle database configuration is with
service name instead of sid, if the parameter is not supplied the oracle configuration will be with
sid. ### Specify whether you want to create the IDM database schema during installation. # To
create the database schema, provide the admin user credentials. This is a database user that can #
create schemas and databases. Usually, this is a DBA user or a system user # idm.db.create.schema=
# Valid values: true, false # Default: false ### Define the admin user of the IDM database #
idm.db.admin.username= # Used to create a schema/database/user # Example:
idm.db.admin.username=postgres ### Define the IDM database admin user password #
idm.db.admin.password= # Used to create a schema/database/user # Example:
idm.db.admin.password=manager ### Define the default tablespace name for the created user (Oracle
only) # idm.db.tablespace= # Example: idm.db.tablespace=USERS # Linkage: Only used when creating
a schema (user) in Oracle databases ### Define the default temporary tablespace name (Oracle only)
# idm.db.temp.tablespace= # Example: idm.db.temp.tablespace=TEMP # Linkage: Only used when
creating a schema (user) in Oracle databases ######################################## #### ####
Properties Relevant to a Standalone Central, RAS #### ### Define whether the SSl certificate is
user-provided or self-signed # ssl.certificate.type= # Valid values: self-signed, user-provided #
Linkage: If you chose to set ssl.certificate.type to be user-provided, you must also set a # value
for ssl.user-provided-root-certificate.location # Example: ssl.certificate.type=self-signed ###
Specify the location of the user-provided keystore with the server certificate # ssl.user-
keystore.location= # This must be in PKCS12 format # On Windows, the path can use either / or \\ #
Example: ssl.user-keystore.location=c:/tmp/certificate.p12/pfx ### Define the password for the
user-provided keystore with service certificate # ssl.user-keystore.password= ### Specify the
location of the root certificate to be imported. # ssl.user-provided-root-certificate.location= #

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 246
Robotic Process Automation 2019.11

Needed only if Central was installed with different certificates than self-signed. # The root
certificate must be in .cer or .crt format # Linkage: If you chose to set ssl.certificate.type to be
user-provided for Central, and if you # chose to install both Central and RAS, you must set a #
value for ssl.user-provided-root-certificate.location # Example: ssl.user-provided-root-
certificate.location=c:/tmp/my.cer # Example: ssl.user-provided-root-
certificate.location=c:\\tmp\\my.cer ######################################## #### #### Properties
Relevant to a Central Node in a Cluster, But Not to the First Installed Central #### ####
Determine if this is a cluster installation # central.cluster= # Valid values: true, false #
Default: false #### Specify the absolute path of the database.properties file #
central.cluster.database.properties= # Absolute path of the database.properties file on the local
machine, copied from an existing node # Example:
central.cluster.database.properties=C:/<installation>/central/conf/database.properties ####
Specify the absolute path of the encryption.properties file # central.cluster.encryption.properties=
# Absolute path of the encryption.properties file on the local machine, copied from an existing node
#
Example:central.cluster.encryption.properties=C:/<installation>/central/var/security/encryption.prop
erties #### Specify the absolute path of the encryption_repository #
central.cluster.encryption_repository= # Absolute path of the encryption_repository file on the
local machine, copied from an existing node # Example:
central.cluster.encryption_repository=C:/<installation>/central/var/security/encryption_repository
# db.driver.location= # When using a MySQL database, it # would normally be required to set this
property. However, when installing a # cluster node, this property is ignored due to an issue in the
installer. # Therefore, you must manually copy the file to <installation>/central/lib and #
<installation>/central/tomcat/lib after the installation, then start the node. #
db.driver.location=C:/Users/admin/Desktop/mysql-connector-java-5.1.21.jar ### Whether to start
Central after the installation # should.start.central= # Valid values: true, false # If you are
installing a new Central in cluster mode and the installer version is older # than the current
Central, this must be set to false. ######################################## #### #### Installing
a standard RAS #### #### Root directory of the installation: # root.dir=C:/Program Files/Micro
Focus/Robotic Process Automation #### What to install: # install.java=true # install.central=false
# install.ras=true #### Define the Central connection properties - used to connect the RAS to the
central # central.url= # In the formats: http://<server-FQDN> or <IP address>:<HTTP_PORT>/oo #
Example: central.url=http://16.59.62.205:8293/oo # If you are using a cluster, this should be the
load balancer's URL: # central.url=https://74.125.225.240:8443/oo #### Define whether or not
access to Central requires an HTTP proxy # central.proxy= # Valid values: no, manual # Default: no
### Define the HTTP proxy host name for connecting to Central. # central.proxy-hostname= # Example:
proxy-hostname=myhost ### Define the HTTP proxy port for connecting to Central # central.proxy-
port= # central.proxy-port=880 ### Define the HTTP proxy user name for connecting to Central, if
proxy requires authentication. # central.proxy-username= ### Define the HTTP proxy password for
connecting to Central, if needed. # central.proxy-password= ### Specify whether the Central is
password protected # central.secured= # valid values for central.secured: true, false # Default:
true ### Define the Central user name that has MANAGE_TOPOLOGY permission. # central.username= #
Example: central.username=oouser ### Define the Central user's password # central.password= #
Example: central.password=oopass ### Define whether the RAS requires a SSL user-provided
certificate to register # ssl.certificate.type= # Valid values: self-signed, user-provided #
Linkage: If your Central was installed with a user provided certificate # set this value to user-
provided and also provide a # value for ssl.user-provided-root-certificate.location # Example:
ssl.certificate.type=self-signed ### Specify the location of the root certificate to be imported.
# ssl.user-provided-root-certificate.location= # Needed only if Central was installed with different
certificates than self-signed. # The root certificate must be in .cer or .crt format # Linkage: If
you chose to set ssl.certificate.type to be user-provided for Central, and if you # chose to
install both Central and RAS, you must set a # value for ssl.user-provided-root-
certificate.location # Example: ssl.user-provided-root-certificate.location=c:/tmp/my.cer #
Example: ssl.user-provided-root-certificate.location=c:\\tmp\\my.cer ### Specify whether the X.509
client certificate should be provided by the RAS to Central # ssl.client.certificate= # Valid
values: true, false # Default: false # This must be provided when Central requires an X.509

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 247
Robotic Process Automation 2019.11

certificate from the client as a part of the SSL handshake. ### Define the full path to the X.509
client certificate location of a user capable of registering a RAS #
ssl.user.client.certificate.location= # On Windows, the path must be with / or with \\ ###
Define the X.509 client certificate password # ssl.user.client.certificate.password= ### Define
the full path to the X.509 client certificate location # ssl.user-provided-client-
certificate.location= # On Windows, the path must be with / or with \\ ### Define the X.509
client certificate password # ssl.client.certificate.password= ### Define the UUID of the RAS #
ssl.client.certificate.ras.uuid= # If Central requires an X.509 client certificate, you need to
generate it. # The X.509 client certificate needs to have the principal name of the RAS, which is #
the RAS UUID (see "Processing a Certificate Principal" in the Micro Focus RPA System # Security and
Hardening Guide). # This must be in the UUID format. # You must generate the UUID and provide it
here. # Example of UUID format: c7fd89e1-d703-44a1-b067-732b8ebbfe23 ### Define the connectivity
direction of the RAS ### This determines whether the RAS initiates the connection to Central
(standard RAS) ### or whether the RAS waits for Central to initiate the connection (reverse RAS) #
register.ras=true # Valid values: true, false # true = standard RAS, false = reverse RAS
######################################## #### #### Installing a reverse RAS #### #### Root
directory of the installation: # root.dir=C:/Program Files/Micro Focus/Robotic Process Automation
#### What to install: # install.java=true # install.central=false # install.ras=true ### Define the
connectivity direction of the RAS ### This determines whether the RAS initiates the connection to
Central (standard RAS) ### or whether the RAS waits for Central to initiate the connection (reverse
RAS) # register.ras=false # Valid values: true, false # true = standard RAS, false = reverse RAS #
shared.secret= # For a reverse RAS, enter the shared secret that will be used by Central, to
communicate with this RAS # ras.server.address= # Enter the IP address of the reverse RAS #
Example: ras.server.address=16.60.234.64 # ras.connectivity.protocol= # Enter the protocol of the
reverse RAS # Valid values: HTTPS, HTTP # Example: ras.connectivity.protocol=HTTPS #
ras.connectivity.central.initiates.https.port= # Enter the https port number of the reverse RAS (if
protocol == HTTPS) # Example: ras.connectivity.central.initiates.https.port=8443 #
ras.connectivity.central.initiates.http.port= # Enter the http port number of the reverse RAS(if
protocol == HTTP) # Example: ras.connectivity.central.initiates.http.port=8080 ### Define whether
the SSl certificate is user-provided or self-signed # ssl.certificate.type= # Valid values: self-
signed, user-provided # Linkage: If you chose to set ssl.certificate.type to be user-provided, you
must also set a # value for ssl.user-provided-root-certificate.location # Example:
ssl.certificate.type=self-signed ### Specify the location of the user-provided keystore with the
server certificate # ssl.user-keystore.location= # This must be in PKCS12 format # On Windows, the
path can use either / or \\ # Example: ssl.user-keystore.location=c:/tmp/certificate.p12/pfx ###
Define the password for the user-provided keystore with service certificate # ssl.user-
keystore.password= ### Queue connection configuration # Required in order to connect to the
RabbbitMQ Broker. This queue is used to send execution commands # to a Robotic Process Automation
Robot that will read the messages from the queue and execute the # tests. Please make sure to create
users & virtual hosts besides the default ones (mentioned below) # in order to avoid common issues
(Users can not login with guest:guest credentials if they are not # using the localhost; New users
cannot connect to the default virtual host) # # queue.host=localhost # queue.port=5672 #
queue.username=guest # queue.password=guest # queue.virtual.host=/

Related topics
For instruction to install RPA Workflow Designer silently, see Silent installation of RPA Workflow Designer
For instruction to install RPA Self-Service X silently, see Silent installation of Self-Service X
For instruction to install RPA Recorder silently, see Silent installation of RPA Recorder
For instruction to install RPA Robot silently, see Silent installation of RPA Robot

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 248
Robotic Process Automation 2019.11

Silent installation of Workflow Designer


This section describes how to perform a silent installation of a Robotic Process Automation (RPA) Workflow
Designer.
To install RPA Workflow Designer silently:

1. On the machine where RPA Workflow Designer is installed, navigate to C:\Program Files\Micro Focus\Robotic
Process Automation Designer\docs.

2. Using a text editor, open the text file sample-designer-silent.properties that has the required installation
and configuration settings. This file is also available in the docs folder on the ZIP file.

For more details about these settings, see the descriptions in the sample-designer-silent.properties text file at
the end of this page.
3. Save a copy of the text file as silent.properties.

4. Remove the comment sign (#) from the properties that you need, and add the value for each of these
properties.

5. From a command line, type the following example code:

rpa-installer-designer-win64.exe -gm2 -s c:\\temp\my-silent.properties

To disable the extracting installation files progress bar, add to the command line -gm2 before -s. The gm2 is
not supported with Linux. You can use the -n option if you do not want to start RPA Workflow Designer after
the installation has completed. The -s property accepts either a full or relative path depending on the
operating system:

Windows: Relative to the location of the .exe file.

For example: If dirA, is the current directory, and dirB is located under dirA and contains the
installer and silent.properties file.

Open a Command window in dirA and enter the following command: dirB\\installer.exe -s
silent.properties

You must add two backslashes \\ and not one backslash \. The installation folder to which you
download the installation file must not contain any spaces in the name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 249
Robotic Process Automation 2019.11

Linux: Relative to the location of the directory where the installer is launched.

Sample

######################################## #### #### General Properties #### ### Root directory of the
installation # root.dir= # On Windows, the path must be with / or with \ # Example (Windows):
root.dir=c:/Program Files/Micro Focus/Robotic Process Automation Designer # Example (Linux):
root.dir=/opt/microfocus/rpa-designer ### What to install # install.java= # Valid values: true,
false # Default: true # This is required. You should only set this to false if Java Runtime has
already been installed in the target directory. # install.designer= # Valid values: true, false #
Default: true # install.docs= # Valid values: true, false # Default: true ### Designer server ports
# http.port= # Default: 8081 # https.port= # Default: 8445 ### HTTP port access # http.port.access=
# Options: enable (HTTP access is enabled) # Options: disable (HTTP access is disabled) # Default:
http.port.access=enable # Micro Focus recommends to disable the HTTP port and to use a TLS
certificate for security reasons. ### Whether to start Designer after the installation #
should.start.designer= # Valid values: true, false # Default: true # If you are configuring Micro
Focus Robotic Process Automation Designer to be compliant with FIPS 140-2, this must be set to
false. # lwsso.init.string= # Optional string used to generate the token when the authentication is
done in LWSSO mode. # It must be at least 12 characters long ### Select a supported language for
Micro Focus Robotic Process Automation Designer, in addition to English. # language= # Valid values:
en, fr, de, ja, es, ch # Default: en # This configures the language for Designer in the designer-
wrapper.conf files. # For Designer, this also changes the database schema language for SQL Server.
######################################## #### #### IDM configuration #### ### Whether to install or
connect to an IDM service # idm.mode= # Valid values: native(lwsso),create, connect. # Default:
native # native: connects using LWSSO # create: installs the IDM service. # connect: connects to an
existing IDM service ### ### Properties relevant only for idm.mode=create ### This option installs
the IDM service along with Robotic Process Automation Designer.. ### # idm.authentication.username=
# The username for the IDM account used by oo-designer to communicate with the IDM service. #
idm.authentication.password= # The password for the IDM account used by oo-designer to communicate
with the IDM service. Make sure the password is at least eight characters long and includes: # * at
least one lower case letter [a-z] # * at least one upper case letter [A-Z] # * at least one number
[0-9] # * at least one special character ~`!@#$%^&*()-_+={}[]|;:<>,./?" # idm.signing.key= # The IDM
configuration signing key. The signing key should be at least 32 characters. It must contain lower
case, upper case and numeric characters. # idm.entry.point.return.url= # Designer url, in the
format: <http or https>://<HOSTNAME>:<PORT>/oo-designer # idm.export.configuration.to.file= #
Boolean value specifying whether to export the IDM credentials(admin username,admin password,
tenant, signing key, username, password) to a file. # Possible values: true, false. # Default
value: false # idm.export.file.path= # Absolute path to the export file location including the file
name. # On Windows, the path must be with / or with \ # Example (Windows):
idm.export.file.path=c:/Program Files/Micro Focus/idm-saved-configurations.txt # Example (Linux):
idm.export.file.path=/usr/local/micro focus/idm-saved-configurations.txt #
idm.overwrite.export.file= # Boolean value specifying whether to override an existing file. #
Possible values: true, false. # Default value: false # install.idm.admin=true # Boolean value
specifying whether to deploy also the idm-admin tool, used for user management # Possible values:
true, false. # Default value: true ### ### Properties relevant only for idm.mode=connect ### This
option connects Robotic Process Automation Designer to an existing IDM service. ###
#idm.provider.protocol= # The protocol of the IDM service # Possible values: http, https. # Default
value: https #idm.provider.hostname= # The hostname of the IDM service #idm.provider.port= # The
port of the IDM service # idm.provider.integration.acct.username= # The IDM transport username
which Robotic Process Automation Designer will use in order to get the authentication token from the
IDM service. # Default value: idmTransportUser # idm.provider.integration.acct.password= # The IDM
transport username's password. # idm.signing.key= # The IDM configuration signing key. The signing

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 250
Robotic Process Automation 2019.11

key should be at least 32 characters. It must contain lower case, upper case and numeric characters.
# idm.tenant= # The name of the tenant/organization that must exist in IDM. # Default value:
OO_Designer # idm.authentication.usernam= # This is the IDM user account which will be created in
IDM. # Robotic Process Automation Designer will use this account in order to communicate with the
IDM service. # idm.authentication.password= # The password for the IDM user account. Make sure the
password is at least eight characters long and includes: # * at least one lower case letter [a-z] #
* at least one upper case letter [A-Z] # * at least one number [0-9] # * at least one special
character ~`!@#$%^&*()-_+={}[]|\;:<>,./?" ######################################## #### ####
Designer database connection properties #### ####### Designer server database properties ### Define
the database type # db.type= # Valid values: oracle, postgresql, mysql, mssql, h2, and other. #
Default value: h2 # For db.type=mysql, db.driver.location MUST be set to the path of a MySQL JDBC
driver (a JAR # file). It is also available for db.type=other. # For db.type=H2, this uses an H2
local database. This should not be used for production. # This database type is available only when
robotic-process-automation-designer is connecting to an IDM service. # For db.type=other, use to
enable advanced features in supported databases. # Other database types are available only when
robotic-process-automation-designer is connecting to an IDM service. # If you select ther, you can
only use a database type that is supported for use with Micro Focus Robotic Process Automation #
Designer. See the System Requirements for more information. ### Define the database driver #
db.driver= # Resolved automatically from db.type, but can be overridden. # Linkage: If db.type is
other, this property is required. ### Define the location of the database JDBC driver #
db.driver.location= # Linkage: Required when db.type=mysql, db.type=oracle or db.type=other. #
Example: db.driver.location=c:/tmp/mydriver.jar # Note: This path is an example only. There is no
need to create a tmp directory. ### Define the database JDBC URL # db.url= # This is optional. Set
this value if you want advanced features supported by the driver. # Linkage: If you set this
property, the db.host, db.port, db.name and db.service.name properties are ignored. # MySQL example:
db.url=jdbc:mysql://<host>:<port>/<db.name> # Oracle example with SID:
db.url=jdbc:oracle:thin:@<host>:<port>:<sid> # Oracle example with service name:
db.url=jdbc:oracle:thin:@//<host>:<port>/<service.name> # PostgreSQL example:
db.url=jdbc:postgresql://<host>:<port>/<db.name> # MS Sql example:
mssql.url=jdbc:sqlserver://<host>:<port> ### Define the database host name # db.host= # Linkage:
This property is ignored when db.url is used. ### Define the database port # db.port= # Linkage:
This property is ignored when db.url is used. ### Define the database name or SID (depending on the
type of database) # db.name= # Linkage: This property is ignored when db.url is used. # Example:
db.name=ORCL # # You cannot use special characters for the database name or SID, except the
underscore (_). # You can enter up to 30 characters for the database name or SID. ### Define the
name of the database user # db.username= # This user name is required when you use the option to
create a database. # The username is required also when connecting to an existing schema, the
difference is # that it’s not being created during the installation. # The user name is created by
the installer and eventually used by Micro Focus Robotic Process Automation Designer. # Example:
db.username=joe # In Oracle, do not use SYS, SYSTEM, or other administrative account credentials. #
In Microsoft SQL Server, do not use sa or other administrative account credentials. # In PostgreSQL,
do not use postgres credentials. # PostgreSQL database names are case-sensitive. ### Define the
password of the database user # db.password= # This password is required when you use the option to
create a database. # The password is required also when connecting to an existing schema, the
difference is # that it’s not being created during the installation. # The password is created by
the installer and eventually used by Micro Focus Robotic Process Automation Designer. # Example:
db.password=pass # In Oracle, do not use SYS, SYSTEM, or other administrative account credentials.
# In Microsoft SQL Server, do not use sa or other administrative account credentials. # In
PostgreSQL, do not use postgres credentials. ### Specify whether to create the database schema
during installation # To create the database schema you must provide the admin user credentials.
This is a database user capable of # creating a schema or database. Usually, this is a DBA user or a
system user # db.create-schema= # Valid values: true, false # Default: false ### Define the admin
user of the database # db.admin.username= # Used to create a schema/database/user # Example:
db.admin.username=postgres ### Define the database admin user password # db.admin.password= # Used
to create a schema/database/user # Example: db.admin.password=manager ### Define the
default tablespace name for the created user (Oracle only) # db.tablespace= # Example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 251
Robotic Process Automation 2019.11

db.tablespace=USERS # Linkage: Only used when creating a schema (user) in an Oracle database ###
Define the default temporary tablespace name (Oracle only) # db.temp.tablespace= # Example:
db.temp.tablespace=TEMP # Linkage: Only used when creating a schema (user) in an Oracle database ###
Define the database connection type (Oracle only) # Valid values: sid, service # Default value: sid
# db.oracle.connection.type= # Example: db.oracle.connection.type=sid # Linkage: Only used when
setting up an Oracle database ### Define the database service name (Oracle only) # db.service.name=
# Example: db.service.name=orcl_name # Linkage: Only used when db.oracle.connection.type=service
####### IDM server database properties # The below configuration parameters are required only when
idm.mode=create and represent the database to which # You can create a new database schema or you
can connect to an already existing one. The schema name cannot be the same as the schema name of RPA
Designer. # Important note: IDM connects to the same database host as Designer. This means that the
database type, hostname and port will be inherited from Designer's database configuration. ###
Define the database username # idm.db.username= # This is the username that IDM will use to connect
to it's existing schema. # Example: idm.db.username=idmServer # In Oracle, do not use SYS, SYSTEM,
or other administrative account credentials. # In Microsoft SQL Server, do not use sa or other
administrative account credentials. # In PostgreSQL, do not use postgres credentials. # PostgreSQL
database names are case-sensitive. ### Define the database name or SID (depending on the type of
database) # idm.db.name= # Example: idm.db.name=ORCL # You cannot use special characters for the
database name or SID, except the underscore (_). # You can enter up to 30 characters for the
database name or SID. ### Define the password of the database user # idm.db.password= # Example:
idm.db.password=pass # In Oracle, do not use SYS, SYSTEM, or other administrative account
credentials. # In Microsoft SQL Server, do not use sa or other administrative account credentials.
# In PostgreSQL, do not use postgres credentials. ### Define the database service name (Oracle only)
# idm.db.service.name= # Example: idm.db.service.name=orcl_service_name # Linkage: Only used when
the database is configured to connect to an Oracle database configured with a service name. # If
Designer is configured to connect to an Oracle # Default value: sid # Required only when the Oracle
database configuration is with service name instead of sid, if the parameter is not supplied the
oracle configuration will be with sid. ### Specify whether you want to create the IDM database
schema during installation. # To create the database schema, provide the admin user credentials.
This is a database user that can # create schemas and databases. Usually, this is a DBA user or a
system user # idm.db.create.schema= # Valid values: true, false # Default: false ### Define the
admin user of the IDM database # idm.db.admin.username= # Used to create a schema/database/user #
Example: idm.db.admin.username=postgres ### Define the IDM database admin user password #
idm.db.admin.password= # Used to create a schema/database/user # Example:
idm.db.admin.password=manager ### Define the default tablespace name for the created user (Oracle
only) # idm.db.tablespace= # Example: idm.db.tablespace=USERS # Linkage: Only used when creating
a schema (user) in Oracle databases ### Define the default temporary tablespace name (Oracle only)
# idm.db.temp.tablespace= # Example: idm.db.temp.tablespace=TEMP # Linkage: Only used when
creating a schema (user) in Oracle databases ######################################## #### ####
Designer SSL properties #### ### Define whether the SSl certificate is user-provided or
self-signed # ssl.certificate.type= # Valid values: self-signed, user-provided # Default: self-
signed # Linkage: If you chose to set ssl.certificate.type to be user-provided, you must also set a
# value for ssl.user-provided-root-certificate.location # Example: ssl.certificate.type=self-signed
### Specify the location of the user-provided keystore with the server certificate # ssl.user-
keystore.location= # This must be in PKCS12 format # On Windows, the path can use either / or \\ #
Example: ssl.user-keystore.location=c:/tmp/certificate.p12/pfx ### Define the password for the user-
provided keystore with service certificate # ssl.user-keystore.password= ### Specify the location of
the root certificate to be imported. # ssl.user-provided-root-certificate.location= # Needed only
if Designer was installed with different certificates than self-signed. # The root certificate must
be in .cer or .crt format # Example: ssl.user-provided-root-certificate.location=c:/tmp/my.cer #
Example: ssl.user-provided-root-certificate.location=c:\\tmp\\my.cer

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 252
Robotic Process Automation 2019.11

Related topics
For instructions to install RPA Central silently, see Silent installation of RPA Central
For instructions to install RPA Workflow Designer silently, see Silent installation of RPA Workflow Designer
For instructions to install RPA Self-Service X silently, see Silent installation of RPA Self-Service X
For instructions to install RPA Recorder silently, see Silent installation of RPA Recorder
For instructions to install RPA Robot silently, see Silent installation of RPA Robot

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 253
Robotic Process Automation 2019.11

Silent installation of Self-Service X


This section describes how to perform a silent installation of a Robotic Process Automation (RPA) Self-Service X.
To install RPA Self-Service X silently:

1. On the machine where RPA Self-Service X is installed, navigate to C:\Program Files\Micro Focus\Robotic
Process Automation Self-Service X\docs.

2. Using a text editor, open the text file sample-ssx-silent.properties that has the required installation and
configuration settings. This file is also available in the docs folder on the ZIP file.

3. Remove the comment sign (#) from the properties that you need, and add the value for each of these
properties.

4. Save a copy of the text file as silent.properties for example.

5. Remove the comment sign (#) from the properties that you need, and add the value for each of these
properties.

6. From a command line, type the following example code:

rpa-installer-ssx-win64.exe -gm2 -s c:\\temp\my-silent.properties

To disable the extracting installation files progress bar, add to the command line -gm2 before -s. The gm2 is
not supported with Linux. You can use the -n option if you do not want to start RPA Workflow Designer after
the installation has completed. The -s property accepts either a full or relative path depending on the
operating system:

Windows: Relative to the location of the .exe file.

For example: If dirA, is the current directory, and dirB is located under dirA and contains the
installer and silent.properties file.

Open a Command window in dirA and enter the following command: dirB\\installer.exe -s
silent.properties

You must add two backslashes \\ and not one backslash \. The installation folder to which you
download the installation file must not contain any spaces in the name.

Linux: Relative to the location of the directory where the installer is launched.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 254
Robotic Process Automation 2019.11

Sample
Here is a sample silent.properties file. You can uncomment a line by removing # in the starting of a line.

######################################## #### #### General Properties #### ### Root directory of the
installation # root.dir= # On Windows, the path must be with / or with \\ # Example (Windows):
root.dir=c:/Program Files/Micro Focus/Robotic Process Automation Self-Service X # Example (Linux):
root.dir=/opt/microfocus/ssx ### What to install # install.java= # Valid values: true, false #
Default: true # This is required. You should only set this to false if Java Runtime has already been
installed in the target directory. # install.ssx= # Valid values: true, false # Default: false #
install.docs= # Valid values: true, false # Default: true ### Self-Service X server ports #
https.port= # Default: 8445 ### HTTP port access # http.port.access=enable # Options: enable (HTTP
access is enabled) # Options: disable (HTTP access is disabled) # Default: http.port.access=enable #
Micro Focus recommends to disable the HTTP port and to use a TLS certificate for security reasons.
### Whether to start Self-Service X after the installation # should.start.ssx= # Valid values: true,
false # If you are configuring Self-Service X to be compliant with FIPS 140-2, this must be set to
false. # If you are installing a new Self-Service X in cluster mode and the installer version is
older # than the current Self-Service X, this must be set to false. ### Proxy configuration #
ssx.proxy= # Valid values: enabled, disabled # ssx.proxy-hostname= # ssx.proxy-port= # username and
password must be empty if the proxy does not have them; otherwise, it will not work # ssx.proxy-
username= # ssx.proxy-password= ### Select a supported language for Self-Service X, in addition to
English. # language= # Valid values: en, ja, ch # Default: en # This configures the language for
Self-Service X in the ssx-wrapper.conf files. # For Self-Service X, this also changes the database
schema language for SQL Server. ######################################## #### #### Properties
Relevant to the First Installed Self-Service X #### ####### Self-Service X server database
properties ### Define the database type ### Define the database type # db.type= # Valid values:
oracle, postgresql, mysql, mssql, h2, and other. # Default value: h2 # For db.type=mysql,
db.driver.location MUST be set to the path of a MySQL JDBC driver (a JAR # file). It is also
available for db.type=other. # For db.type=H2, this uses an H2 local database. This should not be
used for production. # For db.type=other, use to enable advanced features in supported databases. If
you select # other, you can only use a database type that is supported for use with Self-Service X.
See the # System Requirements for more information. ### Define the database driver # db.driver= #
Resolved automatically from db.type, but can be overridden. # Linkage: If db.type is other, this
property is required. ### Define the location of the database JDBC driver # db.driver.location= #
Linkage: Required when db.type=mysql or db.type=other. Required for mySQL even when adding a node to
a cluster. # Example: db.driver.location=c:/tmp/mydriver.jar # Note: This path is an example only.
There is no need to create a tmp directory. # When using a MySQL database, it would normally be
required to set this property. # However, when installing a cluster node, this property is ignored
due to an issue in the installer. # Therefore, you must manually copy the file to
<installation>/ssx/lib and # <installation>/ssx/tomcat/lib after the installation, then start the
node. # db.driver.location=C:/Users/admin/Desktop/mysql-connector-java-5.1.21.jar ### Define the
database JDBC URL # db.url= # This is optional. Set this value if you want advanced features
supported by the driver. # Linkage: If you set this property, the db.host, db.port, db.name and
db.service.name properties are ignored. # MySQL example: db.url=jdbc:mysql://<host>:<port>/<db.name>
# Oracle example with SID: db.url=jdbc:oracle:thin:@<host>:<port>:<sid> # Oracle example with
service name: db.url=jdbc:oracle:thin:@//<host>:<port>/<service.name> # PostgreSQL example:
db.url=jdbc:postgresql://<host>:<port>/<db.name> # MS Sql example:
db.url=jdbc:sqlserver://<host>:<port>;databaseName=<db.name> ### Define the database host name #
db.host= # Linkage: This property is ignored when db.url is used. ### Define the database port #
db.port= # Linkage: This property is ignored when db.url is used. ### Define the database name or
SID (depending on the type of database) # db.name= # Linkage: This property is ignored when db.url
is used. # Example: db.name=ORCL # You cannot use special characters for the database name or SID,
except the underscore (_). # You can enter up to 30 characters for the database name or SID. ###
Define the name of the database user # db.username= # This user name is required when you use the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 255
Robotic Process Automation 2019.11

option to create a database. # The username is required also when connecting to an existing schema,
the difference is # that it's not being created during the installation. # The user name is created
by the installer and eventually used by Self-Service X. # Example: db.username=joe # In Oracle, do
not use SYS, SYSTEM, or other administrative account credentials. # In Microsoft SQL Server, do not
use sa or other administrative account credentials. # In PostgreSQL, do not use postgres
credentials. # PostgreSQL database names are case-sensitive. ### Define the password of the database
user # db.password= # This password is required when you use the option to create a database. # The
password is required also when connecting to an existing schema, the difference is # that it's not
being created during the installation. # The password is created by the installer and eventually
used by Self-Service X. # Example: db.password=pass # In Oracle, do not use SYS, SYSTEM, or other
administrative account credentials. # In Microsoft SQL Server, do not use sa or other administrative
account credentials. # In PostgreSQL, do not use postgres credentials. ### Specify whether to create
the database schema during installation # To create the database schema you must provide the admin
user credentials. This is a database user capable of # creating a schema or database. Usually, this
is a DBA user or a system user # db.create-schema= # Valid values: true, false # Default: false ###
Define the admin user of the database # db.admin.username= # Used to create a schema/database/user #
Example: db.admin.username=postgres ### Define the database admin user password # db.admin.password=
# Used to create a schema/database/user # Example: db.admin.password=manager ### Define the default
tablespace name for the created user (Oracle only) # db.tablespace= # Example: db.tablespace=USERS #
Linkage: Only used when creating a schema (user) in an Oracle database ### Define the default
temporary tablespace name (Oracle only) # db.temp.tablespace= # Example: db.temp.tablespace=TEMP #
Linkage: Only used when creating a schema (user) in an Oracle database ### Define the database
connection type (Oracle only) # Valid values: sid, service # Default value: sid #
db.oracle.connection.type= # Example: db.oracle.connection.type=sid # Linkage: Only used when
setting up an Oracle database ### Define the database service name (Oracle only) # db.service.name=
# Example: db.service.name=orcl_name # Linkage: Only used when db.oracle.connection.type=service ###
Define the database SID (Oracle only) # db.name= # Example: db.name=orcl_sid # Linkage: Only used
when db.oracle.connection.type=sid ######################################## #### #### Properties
Relevant to a Standalone Self-Service X #### ### Define whether the SSL certificate is user-provided
or self-signed # ssl.certificate.type= # Valid values: self-signed, user-provided # Linkage: If you
chose to set ssl.certificate.type to be user-provided, you must also set a # value for ssl.user-
provided-root-certificate.location # Example: ssl.certificate.type=self-signed ### Specify the
location of the user-provided keystore with the server certificate # ssl.user-keystore.location= #
This must be in PKCS12 format # On Windows, the path can use either / or \\ # Example: ssl.user-
keystore.location=c:/tmp/certificate.p12/pfx ### Define the password for the user-provided keystore
with service certificate # ssl.user-keystore.password= ### Specify the location of the root
certificate to be imported. # ssl.user-provided-root-certificate.location= # Needed only if Self-
Service X was installed with different certificates than self-signed. # The root certificate must be
in .cer or .crt format # Linkage: If you chose to set ssl.certificate.type to be user-provided for
Self-Service X, and if you # chose to install Self-Service X, you must set a # value for ssl.user-
provided-root-certificate.location # Example: ssl.user-provided-root-
certificate.location=c:/tmp/my.cer # Example: ssl.user-provided-root-
certificate.location=c:\\tmp\\my.cer ### Define central url # central.url= # Example:
https://<host>:<port>/oo ###Define central administrator username # central.username= ###Define
central administrator password # central.password= ######################################## ####
#### IDM configuration #### ### Whether the central is installed in IDM mode # idm.mode= # Valid
values: native, connect. # Default: native # native: use RPA built-in authentication # connect:
connects to an existing IDM service ### ### Properties relevant only for idm.mode=connect ### This
option connects to an RPA Central in IDM mode. ### # idm.url= # IDM service url, format <http or
https>://<HOSTNAME>:<PORT>/idm-service # idm.integration.username= # The IDM transport username
which SSX will use in order to get the authentication token from IDM service. # Default value:
idmTransportUser # idm.integration.password= # The IDM transport username's password. #
idm.signing.key= # The IDM configuration signing key. The signing key should be at least 32
characters. It must contain lower case, upper case and numeric characters. # idm.tenant= # The name
of the tenant/organization that must exist in IDM. # idm.username= # This is the IDM super-user
account which will be created in IDM. # RPA Central will use this account in order to communicate

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 256
Robotic Process Automation 2019.11

with IDM service. # idm.password= # The password for the IDM super-user account.

Related topics
For instructions to install RPA Central and RPA RAS silently, see Silent installation of RPA Central and RPA RAS
For instructions to install RPA workflow Designer silently, see Silent installation of RPA Workflow Designer
For instructions to install RPA Recorder silently, see Silent installation of RPA Recorder
For instructions to install RPA Robot silently, see Silent installation of RPA Robot

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 257
Robotic Process Automation 2019.11

Silent installation of Recorder


This section describes how to perform a silent installation of a RPA Recorder.
To install Robotic Process Recorder silently:

1. On the machine where RPA Recorder is installed, navigate to c:/Program Files/Micro Focus/Robotic
Process Automation Recorder\docs.

2. Using a text editor, open the text file sample-silent.properties that has the required installation and
configuration settings. This file is also available in the docs folder on the ZIP file. For more details about
these settings, see the descriptions in the sample-silent.properties text file at the end of this page.

3. Save a copy of the text file as silent.properties.

4. Remove the comment sign (#) from the properties that you need, and add the value for each of these
properties.

5. From a command line, type the following example code:

installer-recorder-win64.exe -gm2 -s c:\\temp\my-silent.properties

To disable the extracting installation files progress bar, add to the command line -gm2 before -s. The gm2 is
not supported with Linux. You can use the -n option if you do not want to start RPA Workflow Designer after
the installation has completed. The -s property accepts either a full or relative path depending on the
operating system:

Windows: Relative to the location of the .exe file.

For example: If dirA, is the current directory, and dirB is located under dirA and contains the
installer and silent.properties file.

Open a Command window in dirA and enter the following command: dirB\\installer.exe -s
silent.properties

You must add two backslashes \\ and not one backslash \. The installation folder to which you
download the installation file must not contain any spaces in the name.

Linux: Relative to the location of the directory where the installer is launched.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 258
Robotic Process Automation 2019.11

Sample

######################################## #### #### General Properties #### ### Root directory of the
installation # root.dir= # On Windows, the path must be with / or with \\ # Example (Windows):
root.dir=c:/Program Files/Micro Focus/RA-X Recorder # ### Service # https.port = 5433

Related topics
For instructions to install RPA Central and RPA RAS silently, see Silent installation of RPA Central and RPA RAS
For instructions to install RPA workflow Designer silently, see Silent installation of RPA Workflow Designer
For instructions to install RPA Self-Service X silently, see Silent installation of RPA Self-Service X
For instructions to install RPA Robot silently, see Silent installation of RPA Robot

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 259
Robotic Process Automation 2019.11

Silent installation of Robot


This section describes how to perform a silent installation of a RPA Robot.
To install Robotic Process Robot silently:

1. On the machine where RPA Robot is installed, navigate to C:\Program Files\Micro Focus\Robotic Process
Automation Robot\docs.

2. Using a text editor, open the text file sample-silent.properties that has the required installation and
configuration settings. This file is also available in the docs folder on the ZIP file. For more details about
these settings, see the descriptions in the sample-silent.properties text file at the end of this page.

3. Save a copy of the text file as silent.properties.

4. Remove the comment sign (#) from the properties that you need, and add the value for each of these
properties.

5. From a command line, type the following example code:

rpa-installer-robot-win64.exe -gm2 -s c:\\temp\my-silent.properties

To disable the extracting installation files progress bar, add to the command line -gm2 before -s. The gm2 is
not supported with Linux. You can use the -n option if you do not want to start RPA Workflow Designer after
the installation has completed. The -s property accepts either a full or relative path depending on the
operating system:

Windows: Relative to the location of the .exe file.

For example: If dirA, is the current directory, and dirB is located under dirA and contains the
installer and silent.properties file.

Open a Command window in dirA and enter the following command: dirB\\installer.exe -s
silent.properties

You must add two backslashes \\ and not one backslash \. The installation folder to which you
download the installation file must not contain any spaces in the name.

Linux: Relative to the location of the directory where the installer is launched.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 260
Robotic Process Automation 2019.11

Sample

######################################## #### #### General Properties #### ### Root directory of the
installation # root.dir= # On Windows, the path must be with / or with \\ # Example (Windows):
root.dir=c:/Program Files/Micro Focus/RA-X Runner # # Service # https.port = 8083 # ### Queue
connection configuration # queue.host=localhost # queue.port=5672 # queue.username=guest #
queue.password=guest # queue.virtual.host=/test

Related topics
For instructions to install RPA Robot using a wizard, see Install RPA Robot
For instructions to install RPA Central and RPA RAS silently, see Silent installation of RPA Central and RPA RAS
For instructions to install RPA workflow Designer silently, see Silent installation of RPA Workflow Designer
For instructions to install RPA Self-Service X silently, see Silent installation of RPA Self-Service X
For instructions on how to install Recorder silently, see Silent installation of RPA Recorder

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 261
Robotic Process Automation 2019.11

Post installation tasks


After installation, if you need to generate an encrypted password for the database, you can do this in the
<install_dir>/central/conf/database.properties file.

RPA RabbitMQ Queue connection configuration


After you have installed the RabbitMQ and its dependencies. You must now configure the Queue connection details
in order to establish seamless connection with all the services that connect with RabbitMQ
To configure the RabbitMQ queue connection, complete the following steps

1. Navigate to installed path:

For example-

your install path\RabbitMQ Server\rabbitmq_server-3.7.11\sbin

2. Open the command prompt, and then run the following command:

rabbitmq-plugins enable rabbitmq_management

3. Restart RabbitMQ service and than access the management portal at


http://<rabbitmq_machine_address>:15672 and provide your username and password.

Related topics
To change the database password, see Changing the database password.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 262
Robotic Process Automation 2019.11

Uninstall RPA components


Before uninstalling Robotic Process Automation (RPA) components, ensure that you back up the current version of
RPA.
You can uninstall RPA components using the following methods:

Using the uninstall wizard on both Windows and Linux


Silent uninstallation on both Windows and Linux

RPA Central and RAS


1. Navigate to the RPA Central installation directory, for example, C:/Program Files/Micro Focus/Robotic
Process Automation.

2. Right-click uninstall.exe and select run as an administrator, and then click Next.

3. From the Option Selection page, select Central or Remote Action Server (RAS) or both, and then click
Uninstall. When prompted whether to continue, click Yes.

4. The Uninstall Progress screen displays the progress of the uninstall process, and displays the items that were
deleted and removed. For example:

a. RPA Central Service

b. RPA Central directory

c. Uninstaller control panel programs

Note The database and database user are not removed or dropped.

5. Click Finish.

The selected component/s are removed from your computer.

Note Uninstalling a RAS/remote worker does not remove the entry from the
database. You need to also remove the RAS from RPA Central UI, by selecting the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 263
Robotic Process Automation 2019.11

worker in the Topology > Workers tab and using the Delete button.

Uninstall RPA Central and RPA RAS on Linux

1. Press Ctrl + Alt + T to open a Terminal window

2. Type the following command at the prompt and then press Enter.

export DISPLAY=<ip address> ./uninstall

After the uninstallation is complete, you can delete the installation directory.

RPA Workflow Designer


1. Navigate to the installation directory, for example, C:\Program Files\Micro Focus\Robotic Process
Automation Designer

2. Right-click uninstall.exe and run as an administrator, and then click Next.

3. Select the RPA Workflow Designer, and then click Next.

4. When prompted whether to continue, click Yes. The Uninstall Progress screen displays the progress of the
uninstall process, and displays the items that were deleted and removed.

Uninstall RPA Workflow Designer on Linux

1. Press Ctrl + Alt + T to open a Terminal window

2. Type the following command at the prompt and then press Enter.

export DISPLAY=<ip address> ./uninstall

After the uninstallation is complete, you can delete the installation directory.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 264
Robotic Process Automation 2019.11

RPA Self-Service X
1. Navigate to the RPA Self-Service X installation directory, for example, C:\Program Files\Micro
Focus\Robotic Process Automation Self-Service X.

2. Right-click uninstall.exe and select run as an administrator, and then click Next.

3. From the Option Selection page, select Self-Service X component, and then click Uninstall. When
prompted whether to continue, click Yes.

4. The Uninstall Progress screen displays the progress of the uninstall process, and displays the items that were
deleted and removed.

5. Click Finish.

The selected component, RPA Self-Service X, is removed from your computer.

Uninstall RPA Self-Service X on Linux

1. Press Ctrl + Alt + T to open a Terminal window

2. Type the following command at the prompt and then press Enter.

export DISPLAY=<ip address> ./uninstall

After the uninstallation is complete, you can delete the installation directory.

RPA Robot
The uninstallation process of RPA Robot includes a selection of Unified Functional Testing (UFT) component as an
option. If you want to uninstall UFT, you can select it along with RPA Robot.
To uninstall RPA Robot, complete the following steps:

1. Navigate to the Robotic Process Automation (RPA) Robot installation directory, for example, C:/Program
Files/Micro Focus/Robotic Process Automation Robot.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 265
Robotic Process Automation 2019.11

2. Right-click uninstall.exe and select run as an administrator, and then click Next.

3. From the Option Selection page, select select Robotic Process Automation Robot or Unified
Functional Testing or both components, and then click Uninstall. When prompted whether to continue,
click Yes.

4. The Uninstall Progress screen displays the progress of the uninstall process, and displays the items that were
deleted and removed.

5. Click Finish. The Robot component is removed but UFT might not get deleted depending on the following
scenarios:

a. Robot and Recorder installed on the same machine

The UFT component is not deleted as it is consumed by Recorder.

b. Robot and Recorder installed on two different machines

The UFT component is not deleted as the Recorder consumes the UFT from a different source.

6. Navigate again to the Robot root installation directory, then select and delete the following files manually:

configurer, java, installer.log, uninstall.exe, and uninstall.log

RPA Recorder
The uninstallation process of RPA Recorder includes a selection of Unified Functional Testing (UFT) component as
an option. If you want to uninstall UFT, you can select it along with RPA Recorder.
To uninstall RPA Recorder, complete the following steps:

1. Navigate to the Robotic Process Automation (RPA) installation directory, for example, C:/Program
Files/Micro Focus/Robot Process Automation Recorder.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 266
Robotic Process Automation 2019.11

2. Right-click uninstall.exe and select run as an administrator, and then click Next.

3. From the Option Selection page, select Robotic Process Automation Recorder or Unified Functional
Testing or both components, and then click Uninstall. When prompted whether to continue, click Yes.

4. The Uninstall Progress screen displays the progress of the uninstall process, and displays the items that were
deleted and removed.

5. Click Finish. The Recorder component is removed but UFT might not get deleted depending on the following
scenarios:

a. Recorder and Robot installed on the same machine

The UFT component is not deleted as it is consumed by Recorder.

b. Recorder and Robot installed on two different machines

The UFT component is not deleted as the Recorder consumes the UFT from a different source.

6. Navigate again to the Recorder root installation directory, then select and delete the following files manually:

configurer, java, installer.log, uninstall.exe, and uninstall.log

Related topics
For instructions to uninstall RPA Central silently, see Silent uninstall.
For instructions on how to back up and recover RPA Workflow Designer, see Back up Workflow Designer.
For instructions on how to back up and recover RPA, see Back up and recover RPA.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 267
Robotic Process Automation 2019.11

Silent uninstall of RPA components


A silent uninstallation is one that is started from the command line and completes without any input from the
person who started it. You can uninstall silently from either Windows or Linux.
To uninstall RPA Central silently, type the following from a command line:uninstall -s <components>. In the
<components> placeholder, enter a comma-separated list of components to remove. The possible components
are: central, ras, designer, recorder,uft (for both Recorder and UFT), robot,uft (for both Robot and UFT), ssx, and all
For example: uninstall -s central, ras
When you uninstall RPA RAS silently, if RPA Central authentication is enabled, the RPA RAS is not removed from the
RPA Central topology. In RPA Central, go to System Configuration > Topology > Workers, and remove the RAS
from the topology manually.

Related topics
For instructions to uninstall RPA components using wizard, see Uninstall RPA components.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 268
Robotic Process Automation 2019.11

Upgrade
To upgrade Robotic Process Automation (RPA) to the latest version, 2019.11:

1. Back up the RPA data.

2. Install prerequisites.

3. Upgrade RPA from 2019.07 to 2019.11.

Upgrade matrix
Follow the upgrade matrix to determine which versions of RPA can be upgraded to version 2019.11.

Installed version Upgrade path Rollback

2019.07 2019.07 > 2019.11 Not supported.

Prerequisites
Before you upgrade to RPA 2019.11:

Download and install AutoPass License Server (APLS)

RPA uses AutoPass License Server to store and manage concurrent licenses. You can download and install APLS
version 10.9.2 or later from the ITOM Marketplace.
If you already have APLS installed for managing other Micro Focus product licenses, make sure you are using
version 10.9.2 or later. To install and set up your AutoPass License server, see Install AutoPass License
Server and Administer AutoPass License Server in the dedicated AutoPass License Server documentation.

Related topics
Manage RPA licenses
AutoPass License Server documentation

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 269
Robotic Process Automation 2019.11

Upgrade RPA

Plan
Before you start the upgrade process, read the RPA release notes and System requirements sections.

Important The rollback is not supported for RPA components.

You can upgrade RPA components in the following scenarios:

On the same machine, wherein all the RPA components are installed on Windows environment.
On different Windows or Linux machines, wherein the RPA Central, RPA Workflow Designer, RPA Self-Service X
are installed except for RPA Robot and RPA Recorder components which are supported on Windows machine
only.

Prerequisites tasks
Back up your RPA Central, RPA Workflow Designer, RPA Self-Service X, RAS, Robot, and RPA Recorder
workspaces from their respective home folder (<user_home>/.rpa) before applying the upgrade.
Make sure that the old version of RPA Central has started successfully at least once.
Cancel or finish all paused or running flows, activities and disable existing schedules before applying the
upgrade. If there are flows running or paused when you perform the upgrade, it will not be possible to resume
them, their status will be “Canceled” and the duration will be “0 seconds”.
Stop the RPA Central, RPA Workflow Designer, RPA Self-Service X, RPA Recorder, and RPA Robot services.
For stopping RPA components in Windows: Navigate to Windows>Task Manager>Services, and right-
click to select an RPA component, and then choose Stop
For stopping RPA components in Linux: Navigate to <Install Location>/<rpa component>/bin, and
open the terminal and type the command: ./<rpa component> stop
When upgrading to a latest version of Robotic Process Automation 2019.11, it is recommended to set up the
automatic upgrade of RPA RASes in RPA Central (under the Topology > RAS Upgrade tab). This will enable you
to upgrade all of your RASes at the same time. The initial steps, of uploading the upgrader file to RPA Central and
preparing the RPA RASes for upgrade should be done before you upgrade RPA Central. This is in order to
minimize downtime and to allow the administrator to fix any issues that may be encountered during the
download of the upgrader package to the RASes.
Make sure that there is sufficient disk space for this backup; otherwise, the upgrade will fail. You may wish to
archive the backup to save space.

Download and unzip the upgrade packages

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 270
Robotic Process Automation 2019.11

Role Privileges required

System administrator Root or sudo

1. Visit Micro Focus Software Licenses and Downloads Portal and download the upgrade package (upgrader-rpa-
<COMPONENT>-2019.11.0.0-upgrade.zip) to a temporary directory of your local environment or on different
machines.

2. Run the unzip command to unzip the upgrade package or packages. For example, you run the following
command: unzip upgrader-rpa-<COMPONENT>-2019.11.0.0-upgrade.zip

3. Save .zip files from the unzipped package in the same install directory of each RPA component.

Stop cluster instances manually

In a cluster setup, stop all RPA OO Central and RPA RAS instances manually. This step is crucial. It will make the
process "clean", and prevent damage that could occur due to the yet-to-be-upgraded nodes running against the
upgraded database.

For RPA Central and RPA RAS, the upgrade process shuts down the server
automatically. However, on a cluster, the upgrade stops the node being upgraded,
but does not shut down the entire cluster.

Start upgrade
To upgrade RPA components:

1. Extract the downloaded upgrader-<RPA component>-2019.11.0.0.zip of each RPA component onto the
respective components default root installation folders.
The root folder is the installation folder that you chose in the installer, when you installed the earlier version
of Robotic Process Automation 2019.07.

For example, C:\Program Files\Micro Focus\Robotic Process Automation. This creates an upgrade
folder containing a <new-version> folder (for example, 2019.11).

Important Make sure to extract the zip files directly into the main installation
folders of each component and not into a sub-folders. Because the apply-
upgrade(.bat) script will work, if the upgrade folder is directly under the main
installation folder.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 271
Robotic Process Automation 2019.11

Component
RPA Default root installation directory upgrade
component Zip file name examples notes

RPA OO upgrader-rpa-<latest Windows: C:\Program Files\Micro Applicable to


Central version>.zip Focus\Robotic Process Automation\upgrader- both
rpa-<latest version>-upgrade.zip Windows and
Linux: /opt/microfocus/rpa-<latest version>- Linux
upgrade.zip systems.

RPA upgrader-designer-<latest Windows: C:\Program Files\Micro Applicable to


Workflow version>.zip Focus\Robotic Process Automation both
Designer Designer\upgrader-rpa-designer-<latest Windows and
version>-upgrade.zip Linux
Linux: /opt/microfocus/rpa-designer-<latest systems.
version>-upgrade.zip

RPA upgrader-rpa-recorder-<latest Windows: C:\Program Files\Micro Applicable to


Recorder version>.zip Focus\Robotic Process Automation Windows
Recorder\upgrader-rpa-<COMPONENT>-<latest system only.
version>-upgrade.zip

RPA Robot upgrader-rpa-robot-<latest Windows: C:\Program Files\Micro Applicable to


version>.zip Focus\Robotic Process Automation Windows
Robot\upgrader-rpa-<COMPONENT>-<latest system only.
version>-upgrade.zip

RPA Self- upgrader-ssx-<latest Windows: C:\Program Files\Micro Focus\Self- Applicable to


Service X version>.zip Service X\upgrader-ssx.<latest version>- both
upgrade.zip Windows and
Linux: /opt/microfocus/rpa-ssx-<latest Linux
version>-upgrade.zip systems.

Important If you had installed both RPA Robot and RPA Recorder on the same
machine, it is highly recommended not to start the RPA Robot and RPA
Recorder upgrade packages at the same time.

2. For linux environment, complete the following tasks:

a. Navigate to [Download location]>[Zip file]>, and then run the command: unzip -q upgrader-
rpa-201911.0.0.zip -d

The upgrade package is extracted.

b. Navigate to [Upgrade folder]>[New_Version_Folder]>bin, and then run the command: chmod a+x
../java/linux64/bin/java

This grants Java folder an executable right.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 272
Robotic Process Automation 2019.11

c. Next, run the following command: chmod 775 apply-upgrade

This grants the permission to read, write, and execute the file for upgrade.

d. To apply upgrade, run the following script: ./apply-upgrade


The upgrade process starts.

3. For Windows environment, complete the following tasks:

a. In the <installation>\upgrade\<new-version>\bin sub-folder, open a command line as an


administrator and run the apply-upgrade(.bat) script.

b. (Optional) If required, use the following command line options:

-f,--force: Force-start the upgrade. This command upgrades the installation, without prompting.

-h,--help: Display help on the available parameters.

-n,--norestart: Do not restart Central/RAS after the upgrade.

c. Type y to apply the upgrade. The upgrade process starts and after completion, an upgrade.log file is
created under <installation>/upgrade/<new-version>.

The progress of the upgrade is displayed. For example:

Upgrade RPA RASes

When upgrading to RPA 2019.11 in Remote Action Servers (RASes), you must apply the upgrader zip and scripts to
each of the RPA RASes separately.
You can use the automatic RAS upgrade functionality to upgrade all of your RASes at once. Automatic upgrade is

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 273
Robotic Process Automation 2019.11

recommended for customers with a large number of RASes in their environment, or with RASes in different time
zones.

Apply the upgrade to the next node in a cluster environment

Apply the upgrade to all the RPA Central or RPA RAS instances. Repeat the process as often as required as stated
in the above Start upgrade topic.

Once you have upgraded one RPA Central node to the new version, you must
upgrade all additional nodes to the same version.

Related topics
For instructions to upgrade RPA RAS. see Set up an automatic RPA RAS upgrade

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 274
Robotic Process Automation 2019.11

Integrate
Robotic Process Automation (RPA) 2019.11 integrates with the following products:

Product Version

AutoPass Licensing Server 10.9.2 and later

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 275
Robotic Process Automation 2019.11

Administer
This section documents relevant information regarding the following RPA Central configuration tasks.

Complete advanced configuration tasks.


Configure three different types of database, to be used with RPA Central.
Deploy and manage RPA Central instances in a secure manner, and configuring security hardening for RPA
Central.

Related topics
For tasks that you will generally perform once, see Initial administration tasks.

For tasks that you will perform repeatedly, see Recurring administration tasks.

For information on setting up a database environment, see Set up database environment.

For information on deploying and managing RPA instances in a secure manner, see Set up security for RPA
Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 276
Robotic Process Automation 2019.11

Initial administration tasks for RPA Central


This section includes administration tasks that you will generally perform once, while setting up RPA Central after
installation.
The following topics are covered in this section:

Configure and enable authentication

Manage RPA licenses

Adjusting the logging levels

Configure LW-SSO settings

Change the service name

Change the timeout limit for the RPA Central web interface

Schedule database purging

Specify communication protocols

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 277
Robotic Process Automation 2019.11

Configure and enable authentication


After installing RPA Central, you must configure the authentication mechanism and enable authentication.

Configure authentication
Select the authentication mechanism to be used in RPA Central, for example, LDAP, SSO, internal users, etc.

Enable authentication
This is done in RPA Central by marking the Enable Authentication check box. The Enable Authentication
check box is only available if there are existing internal or LDAP users with permission to disable the authentication
in the future.

Related topics
To set up system configuration, see Setting up the system configuration
For more information related to enabling authentication in RPA Central, see Enable authentication

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 278
Robotic Process Automation 2019.11

Manage RPA licenses


When you first install Robotic Process Automation (RPA), the trial version is activated. To continue using RPA,
install the commercial version within 60 days.

Concurrent licensing
An RPA license plan counts the maximum number of robots that are able to execute RPA activities simultaneously.
Each license enables one robot to execute one RPA activity at a time, on one or multiple servers. To run different
RPA activities concurrently, you need multiple licenses. For example, RPA requires two licenses for two robots
executing one flow containing two activities running in a parallel split step. However, one robot can execute
multiple flows and multiple activities as long as the activities are running sequentially and the robot is handling
one activity at a time.

License distribution
When you start a flow, RPA checks out a license and returns it when the flow completes. In the case of split-step
flows, an additional license is checked out for every robot working on parallel activities. These licenses are freed up
as soon as each robot completes their parallel activity task.

Install AutoPass License Server


RPA concurrent licenses are stored and managed by AutoPass License Server.
AutoPass License Server is included in the trial version of RPA 2019.11 and later. After your trial license expires, or
if you are upgrading from RPA 2019.07, download and install the AutoPass License Server version 10.9.2 or later
from the ITOM Marketplace.
If you already have an AutoPass License Server installed for managing other Micro Focus product licenses, make
sure you are using AutoPass License Server version 10.9.2 or later.
For more information about how to install the License Server, see the dedicated AutoPass License Server
documentation.

Install a new license on the AutoPass License server

Prerequisites

Purchase an RPA 2019.11 license from your Sales team or Account Manager.
Download AutoPass License Server version 10.9.2 or later from the ITOM Marketplace.
Install and set up your AutoPass License server. For detailed instructions, see Install AutoPass License Server and
Administer AutoPass License Server in the dedicated AutoPass License Server documentation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 279
Robotic Process Automation 2019.11

Check that you are connected to the network and can access the AutoPass License Server.
To activate a new RPA concurrent license key:

1. Go to System Configuration > SYSTEM SETTINGS > License.

2. Enter the AutoPass License Server address: https://< license server ipaddress or Host name>:5814/autopass

3. Log in to the AutoPass License Server with your AutoPass credentials. Make sure your AutoPass account has
administrator rights. If you are connecting for the first time, use the initial AutoPass credentials:
admin/password AutoPass requires you to change the default password during the initial session. Before
setting up a new password, check the AutoPass Password Specifications.

4. Go to the AutoPass License pane and follow the Install a License instructions in the dedicated AutoPass
License Server documentation.

Release idle licenses


Concurrent licenses are automatically released when RPA is idle, with no mouse or keyboard activity, for seven
days. This ensures that idle connections do not lock licenses.

View license information


To display the status of your current RPA license:

In RPA Central, click the Info button in the top right corner. This displays Licensing information in the
About pop-up window.
In the AutoPass License Server check the Issued License Report tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 280
Robotic Process Automation 2019.11

Licensing limitations
No offline connections. To install and access concurrent licenses, make sure you have an active network
connection to the AutoPass License Server. RPA does not support commuter or remote commuter licenses.
No license borrowing: You cannot configure your AutoPass License Server to borrow RPA concurrent licenses
from another AutoPass License Server.

Related topics
Download the AutoPass License Server from the ITOM Marketplace
Install AutoPass License Server
Administer AutoPass License Server
Dedicated AutoPass License Server documentation

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 281
Robotic Process Automation 2019.11

Adjusting the logging levels


Because logging activity can slow the performance of RPA and create very large log files, it is important for RPA to
run with appropriate logging levels. The default logging level is set to INFO. This level provides the necessary
information without impacting performance.
In addition, you can adjust the granularity of the information in the log, separately for regular logging, deployment,
and execution.
The granularity options are:

INFO - Default logging information


DEBUG - More logging information
WARN - Less logging information
ERROR - Less logging information
To adjust the granularity in the logging:

1. Open the log4j.properties file (under /<installation_folder>/central/conf/log4j.properties).

2. Replace INFO with DEBUG, WARN or ERROR in the relevant places in the log4j.properties file. For example:

log.level=INFO

execution.log.level=DEBUG

deployment.log.level=DEBUG

Note: The Tomcat server keeps access logs under


/<installation_folder>/central/var/logs. To prevent these log files from
growing in size, it is recommended that you monitor the size of the files named
localhost_access_log.yyyy-mm-dd.txt, and delete old files as necessary. Use
established best practices for your operating system, whether Windows or Linux.
For example - To delete files older than 10 days:
Linux

find <RPA_HOME>/central/var/logs/ -name " localhost_access*.txt" -


type f -mtime +10 -exec rm -f {} \;

Windows

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 282
Robotic Process Automation 2019.11

C:\Users\Administrator>forfiles /p "<RPA_HOME>\central\var\logs" /s /m
localhost_access*.txt /d -10 /c "cmd /c del @PATH"

where <RPA_HOME> refers to the location of the RPA installation folder


You can set this up using a schedule in Central or use Cron or Windows Scheduler
to run these commands the background.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 283
Robotic Process Automation 2019.11

Configure LW-SSO settings


When you enable LW-SSO afterward, you may receive warnings under certain scenarios. To clear the warnings
from the log, follow the below steps to set the management URL property using the Fully Qualified Domain
Name(FQDN).

RPA Central and RPA RAS installed on the same


machine
When RPA Central and a RPA RAS are installed on the same machine, and the LW-SSO settings are enabled, you
must set the management URL property using the Fully Qualified Domain Name.

1. Stop the RPA RAS process.

2. In the ras/conf/ras-wrapper.conf file, change

wrapper.java.additional.<x>=-Dmgmt.url=<protocol>://localhost:<port>/oo

to

wrapper.java.additional.<x>=-Dmgmt.url=<protocol>://<FullyQualifiedDomainName>:<port>/oo

3. Start the RPA RAS process.

RPA RAS installed on a different machine


When the RPA RAS is installed on a different machine from the RPA Central and LW-SSO settings are enabled, you
must specify the management URL of the RPA Central with the fully qualified domain name during the RPA RAS
installation, instead of the IP address.

Connecting another application to RPA Central through LW-SSO

When connecting another application to RPA Central through LW-SSO, you must specify the management URL of
the RPA Central with the fully qualified domain name using the following instructions:

1. Stop the RPA Central process.

2. In the central/conf/central-wrapper.conf file, change

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 284
Robotic Process Automation 2019.11

wrapper.java.additional.<x>=-Dmgmt.url=<protocol>://localhost:<port>/oo

to

wrapper.java.additional.<x>=-Dmgmt.url=<protocol>://<FullyQualifiedDomainName>:<port>/oo

3. Start the RPA Central process.

Related topics
To set up security using LW-SSO, see Set up security using LW-SSO

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 285
Robotic Process Automation 2019.11

Change the service name


If you want to change the service name and description from the default values, you can edit these in the central-
wrapper.conf file.
This procedure can be applied to a RPA RAS as well by replacing the word "Central" with "RAS". For example, use
ras-wrapper.conf, ras\conf.
To change the service name:

1. Stop the RPA Central service.

2. Navigate to the central\bin directory. The default is C:\Program Files\Micro Focus\Robotic Process
Automation\central\bin.

3. Run uninstall-central-service.bat.

4. Verify that the service is uninstalled.

5. Navigate to the central\conf directory.

6. Make a copy of the central-wrapper.conf file.

Note This step is an optional step used for saving the original configuration,
so that you have a backup if a rollback is required or if the modified file
becomes unusable in any way.

7. Edit the central-wrapper.conf file, by modifying the following lines to suit your needs:

wrapper.name

wrapper.displayname

wrapper.description

For example:

# Name of the service

wrapper.name=RPACentral

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 286
Robotic Process Automation 2019.11

# Display name of the service

wrapper.displayname= RPA Central

# Description of the service

wrapper.description=Robotic Process Automation Central is the run time environment of Robotic


Process Automation. It is used for running flows, monitoring the various runs, and generating
reports.

8. Run install-central-as-service.bat.

9. Verify that the service is installed with the new names and description.

10. Start the new RPA Central service.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 287
Robotic Process Automation 2019.11

Change the timeout limit for the RPA web


interface
You can change the default session timeout (30 minutes) of the Central server by configuring the tomcat
web.xml file.
To configure the file:

1. Open the <installation_folder>/central/tomcat/conf/web.xml file with any XML editor.

2. Search for the following:

3. Change the session-timeout value (in minutes).

4. Restart the RPA Central server.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 288
Robotic Process Automation 2019.11

Schedule database purging


In order to keep the Robotic Process Automation database size under control, it is important to schedule database
purging operations from day one.

Purging flows
The purging flows are available in the Micro Focus Solutions content pack (available on ITOM Marketplace). It
is recommended to deploy this content pack, configure the flows with your required settings, and schedule them in
RPA Central.
The following purging flows are located under Library>Integrations>Micro Focus>Operations
Orchestration>10.x>Database::

Purge Execution Summary - Purges run data.

It is recommended to schedule this flow as soon as you start to run flows.

Purge Audit Records - Purges old auditing records if auditing is enabled.

If you have enabled security auditing, schedule this flow.

Purge Rerun Info - Purges rerun data.

If you have defined rerun points in your flows, schedule this flow.

For more information about these purging flows, see the flow descriptions in RPA Central.

Purging APIs
The purge APIs enable the system administrator to purge:

Run data such as flow inputs, outputs, and step logs.

This run data should be purged regularly, because running large numbers of runs can cause the database to
reach the maximum table size.

Note This only affects the data of completed runs.

Audit records - if auditing is enabled.


By using the purge APIs, you can purge the data manually as required, or by scheduling recurrent flows that

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 289
Robotic Process Automation 2019.11

incorporate these APIs.


As an alternative to using the purging flows, you can perform purging functions via API.
The following APIs are available:

DELETE /audit/records: Purges old auditing records if auditing is enabled.


DELETE /executions: Purges run data such as bound inputs, outputs and step log events. This run data needs
to be purged regularly, because running large numbers of runs can cause the database to reach the maximum
table size.

Note This only affects the data of completed runs.

DELETE/executions/rerun: Purges the rerun data from the database.


DELETE /steps-log: Purges step data according to time and number of executions to purge.
By using the purge APIs, you can purge the data manually as required, or by scheduling recurrent flows that
incorporate these APIs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 290
Robotic Process Automation 2019.11

Capture the credentials of the logged-in user


An administrator can enable RPA to capture the credentials of the logged-in user. This makes it possible to run
flows automatically, when they require logged-in user credentials as input parameters in flow steps.
When this option is enabled, when a user schedules, resumes, or starts a flow that contains logged-in user
credentials as an input parameter, the credentials of that logged-in user are captured in the flow run context (in
encrypted form).
During log in, a warning message appears, telling the user that their credentials may be captured. For a remote
RPA Central, the warning appears in the Remote Debugging login page.

Note By default this option is not enabled and the flow will prompt for logged-in
user credentials at the relevant step.

To enable this option in the RPA Central UI, select the Enable the capture of logged-in user credentials check
box in the RPA Central Security > Settings tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 291
Robotic Process Automation 2019.11

Specify communication protocols


To specify the communication protocols that must be used by the system notification feature, add the
system.notifications.smtp.enabled.protocols property in the
central-wrapper.conf file. To do this:

1. Open the central-wrapper.conf file located in the <installation_directory>\central\conf directory.

2. Add the system.notifications.smtp.enabled.protocols property as follows:

The system.notifications.smtp.enabled.protocols property is optional and its default value is TLSv1.2 TLSv1.1
TLSv1 SSLv3. You can overwrite the default value and specify the protocol that you want as a list of space-
separated values.

For example, to specify more than one protocol:

wrapper.java.additional.34=Dsystem.notifications.smtp.enabled.protocols=<protocol 1> <protocol 2>


<protocol 3>

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 292
Robotic Process Automation 2019.11

Initial administration tasks for RPA Robot


This section includes administration tasks that you will generally perform once, while setting up RPA Robot after
installation.
The following topic is covered in this section:

Configure RPA Robot execution results

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 293
Robotic Process Automation 2019.11

Configure RPA Robot execution results


Robotic Process Automation (RPA) Robot has the functionality to archive the results after executing an RPA activity.
You can use this capability for debugging purpose. As each step is executed by RPA Robot, a related .zip file
associated with an executed step in a workflow is generated for easier identification.
To configure automatic archiving of results from each Robot activity:

1. Navigate to the directory: <RPA Robot installation dir>\robot\conf\robot-wrapper.conf.

2. Using any text editor, open the robot-wrapper.conf file and add the following two configuration flags.

The first configuration flag is -Dusr.archive.location =<existing_path>, where <existing_path>


represents an existing path on the OS where the robot will save the RPA activity execution results.
This flag is mandatory if activation of the archiving capability is desired.
For each RPA activity the result is archived in a .zip file name which complies with the naming
pattern <workflow_execution_id>-<step_id>, where:

Parameter Description

<workflow_execution_id> represents the Central workflow execution id for which the results
were archived

<step_id> represents the step id for which the results were archived

The second configuration flag is -Dusr.archive.delay=<positive_integer_representing_seconds> and


specifies the delay between the end of the RPA step execution and the start of the archiving process.
If not specified the default delay value is 10 seconds.
3. Save the robot-wrapper.conf file.

4. Restart the Robot service from Windows services.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 294
Robotic Process Automation 2019.11

Initial administration tasks for RPA Workflow


Designer

This section includes administration tasks that you will generally perform once, while setting up RPA Workflow
Designer after installation.

Related topics
To view system details of RPA Workflow Designer, see View system information.
To configure a proxy for RPA Workflow Designer, see Configuring a Proxy for RPA Workflow Designer.
To Configure RPA Recorder settings, see Configure a Recorder settings for RPA Workflow Designer.
To configure Record and Run settings, see Configure Record and Run settings for RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 295
Robotic Process Automation 2019.11

View system information


You can view a system information report, which displays version and static system information, database
connection information, and general system information.
To view the system information report, enter the following text into your browser address line:
http://<Workflow Designer URL>:<port number>/oo-designer/reports/sysinfo

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 296
Robotic Process Automation 2019.11

Configure a proxy for RPA Workflow Designer


You can configure a proxy and authentication in RPA Workflow Designer settings.
To configure a proxy and authentication details, complete the following steps:

1. Navigate to Settings->Connection. The Settings dialog box is displayed.

2. Click Use Proxy toggle switch to activate the Proxy Host and Proxy Port fields, and then enter valid
values. The default Proxy Port value is 8080.

3. Click Proxy Authentication toggle switch to activate the Proxy User and Proxy Password fields, and then
enter valid values.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 297
Robotic Process Automation 2019.11

Configure Recorder settings for RPA Workflow


Designer
RPA Workflow Designer is now enhanced to record screen events in real-time to automate the mundane business
processes in RPA mode.
As an author, if you want to use RPA Workflow Designer in RPA mode. You must have installed RPA Recorder and
then configure its port details with RPA Workflow Designer.
To configure the Recorder port and Recorder Add-ins details in RPA Workflow Designer, complete the following
steps:

1. Navigate to Settings->Recorder.

2. In the Connectivity section, enter the valid values for Recorder Port field. The port availability and
connectivity is checked in real-time. A green tick is displayed for a successful connection else an yellow error
icon with a message is displayed for appropriate resolution

3. In the Recorder Add-ins section, other than the default Standard Windows, SAP, Java, Terminal
Emulators, UI Automation , and Web Add-ins, you can select All Add-ins or any other individual Add-ins
from the list for evaluation purpose only. Your selected Add-in is enabled for recording. You can click and
deselect the Add-in to disable. The RPA Recorder or Robot are designed to choose the default settings for all
of the Terminal Emulators available for selection. However, if your settings are different from the default
ones, you can make changes using advanced configuration. <link>

In some situations, the browser might not close even if you enable the setting from the Workflow Designer
Record & Run settings.

Related topics
To configure a proxy for RPA Workflow Designer, see Configure a proxy for RPA Workflow Designer.
To set up workspace in RPA Workflow Designer, see Set up the workspace.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 298
Robotic Process Automation 2019.11

Configure Record and Run settings for RPA


Workflow Designer
The Record and Run settings in RPA Workflow designer provides you with multiple options to start your recording
for each of the Add-ins you had selected for your Recording activity.
The following are the options you will see on the Record and Run tab of RPA Workflow Designer settings:

Web settings
SAP client settings
Windows application settings
Terminal Emulator settings
To configure the Record and Run settings in RPA Workflow Designer, complete the following steps:

1. Navigate to Settings->Record and Run.

2. Click the Web tab and specify the required information as explained below.

GUI Item Description

Open a new browser Click to activate or deactivate this option if you want a new preferred browser
when recording and to be opened each time you want to start recording.
running

URL Enter the preferred URL address that you want to open using the preferred
browser for the recording.

Browser Click the drop-down button in the field to view and select the browser from
the available list.
The current list of supported browsers are: Microsoft Internet Explorer,
Microsoft Internet Explorer 64 bit, Google Chrome, Mozilla Firefox, and Mozilla
Firefox 64 bit.

Close the browser upon Click to activate or deactivate this option if you want a selected browser to
completion close upon completion of recording.

3. Click the SAP tab and specify the required information as explained below.

GUI Item Description

Open a new SAP client when Click to activate or deactivate this option if you want a new SAP client
recording and running to be opened each time you start recording.

Server description Enter the description of the server you want to use.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 299
Robotic Process Automation 2019.11

GUI Item Description

Enable auto logon Click to activate or deactivate this option if you want to enable
automatic log in to your SAP client
Provide Username, Password, Client details and Language
preference in the respective fields.

Close the SAP client upon Click to activate or deactivate this option if you want the SAP client to
completion close upon completion of recording.

Do not record and run on Click to activate or deactivate this option if you do not want to record
opened sessions and run the current opened SAP sessions.

4. Click the Windows tab and specify the required information as explained below.

GUI Item Description

Windows Click to activate or deactivate this option if you want to select your own applications for
recording and running.

Click button to add the following details of your applications:


Application Path: The executable file on which to record or run. It should contain only the
file name and path for the application. You can specify a document or other file associated
in the file system with an application, for example, c:\tmp\a.txt. In this case both the
recorder and the robot will automatically open the specified file in the associated application
(Notepad in this example).
Working Folder: The current working folder for the application. The current working folder
is used by the application to search for related files. If a working folder is not specified, the
executable folder is used as the working folder
Arguments: Instructs both the recorder and the robot to open the application using the
specified command line arguments.

5. Click the Terminals tab and specify the required information as explained below:

GUI Item Description

Use the following Click to activate or deactivate this option if you want to select your own
Terminal Emulator applications for recording and running.
settings

Vendor Click the drop-down and select a Vendor. Depending on the selected vendor,
you may need to change the configuration settings on the actual terminal
emulators for RPA recorder to use it.

Emulator The relevant Emulator is auto-selected based on your Vendor selection.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 300
Robotic Process Automation 2019.11

6. Click Save.

Related topics
To configure a proxy for RPA Workflow Designer, see Configure a proxy for RPA Workflow Designer.
To set up workspace in RPA Workflow Designer, see Set up the workspace.
For instructions to configure RPA Recorder terminal emulators, see Configure an emulator to work with RPA
Recorder
For information on advanced configuration of RPA components, see Advanced configuration of RPA components

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 301
Robotic Process Automation 2019.11

Configure an emulator to work with RPA Recorder


Terminal emulator configuration differs depending on your emulator type. You must configure the settings on the
each of the following emulators.

Micro Focus EXTRA!


1. Open EXTRA! and select Options>Global preferences. The Global Preferences dialog box opens.

2. Click the Advanced tab.

3. In the HLLAPI shortname list, select the uppercase letter A as the Short Name.

4. Click the browse button, browse to and select your session profile, and click OK.

5. Save the profile before you start recording with RPA Recorder. This enables you to configure the terminal
emulator once and then reuse the saved settings.

Micro Focus INFOConnect


1. Open Micro Focus INFOConnect and then select Options > Global Preferences from the main menu.

2. Select the Advanced tab.

3. Select A as the session short name.

4. To associate the session short name (A), with your session, click Browse and locate your session profile in
the file system.

5. Click OK.

Micro Focus RUMBA


1. Open RUMBA and then select Options > API. The API Options dialog box opens.

2. Click the Identification tab.

3. In the Session Short Name field, type the uppercase letter A.

4. Click OK.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 302
Robotic Process Automation 2019.11

5. Save the profile.

Micro Focus Web-to-Host


1. Open the RUMBA Web-to-Host Session Configuration Manager and open a session.

2. In addition to your standard configuration steps in the Configuration Manager:

a. Select Pro client from the Implementation drop-down list.

b. Click HLLAPI Configuration and select A from the Session Short Name drop-down list.

3. Save the profile.

Micro Focus Reflection


1. Open a new or existing session, and then select Setup > Terminal.

2. In the Short Name field, type the uppercase letter A.

3. Click OK.

Rocket Passport
1. Open a new or existing session.

2. Check that the session shortname (A) Passport.zws appears in the window title bar.

Rocket BlueZone
1. Open BlueZone, and then select Options > API. The API Properties dialog box opens.

2. Click the Options tab.

3. In the Short NameSession Identifier field, type the uppercase letter A.

4. Click OK.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 303
Robotic Process Automation 2019.11

5. Save the session.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 304
Robotic Process Automation 2019.11

Recurring administration tasks for RPA Central


This section includes administration tasks that you may need to perform periodically or in response to a situation
that occurs.
This section covers the following topics:

Encrypt and obfuscate passwords

Changing the database password

Change the database IP

Change the hostname IP

Change the URL of a load balancer/Central on the RAS side after its installation

Back up and recover Robotic Process Automation

Set up disaster recovery

System tuning

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 305
Robotic Process Automation 2019.11

Encrypt and obfuscate passwords


You can encrypt or obfuscate a password using the encrypt-password script, which is located in
<installation_folder>/central/bin.
It is recommended to use encryption.
Important: After using the encrypt-password script, clear the command history. This is because, on a Linux OS,
the password parameter will be stored in cleartext under /$USER/.bash_history and accessible by the history
command.

Encrypt passwords
1. Locate the encrypt-password script, in <installation_folder>/central/bin.

2. Run the script with the -e -p <password> option, where password is the password you want to encrypt.

Note You can either use -p as the flag to encrypt the password or --password.

The encrypted password should appear as follows:

{ENCRYPTED}<some_chars>.

Encrypt RabbitMQ password

1. If RPA Central and RPA Robot are up and running, stop both the services.

2. Run the encrypt-password script with the --password <password> option, where <password> is the database
password.

Note You can either use -p as the flag to encrypt the password or --password.

For example: <install-dir>/designer/bin/encrypt-password --password <plain-text-pass>

3. Copy the result. It should appear as follows: {ENCRYPTED}<some_chars>.

4. Go to the folder <installation_folder>/conf/queue.properties, and open the queue.properties file.

5. Change the queue.password value to the one that you copied. In a cluster, make sure to do this on each
node.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 306
Robotic Process Automation 2019.11

Note The password is stored encrypted, so make sure you include the
{ENCRYPTED} prefix. The = character needs to be escaped. For example,
queue.password=GFDGDS12\=\=.

Obfuscate passwords
1. Locate the encrypt-password script, in <installation_folder>/central/bin.

2. Run the script with the -o <password> option, where password is the password that you want to obfuscate.

The obfuscated password should appear as follows:

{OBFUSCATED}<some_chars>.

Create a prompt for the password


It is recommended to run the encrypt-password script without providing the –p argument. For example:

This will create a prompt for the hidden password inputs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 307
Robotic Process Automation 2019.11

Change the database password


To change the database password in RPA Central:

1. If RPA Central is up and running, stop the RPA Central Service.

2. Run the encrypt-password script with the --password <password> option, where <password> is the database
password.

Note You can either use -p as the flag to encrypt the password or --password.

For example:

<install-dir>/central/bin/encrypt-password --password <plain-text-pass>

3. Copy the result. It should appear as follows:

${ENCRYPTED}<some_chars>.

4. Go to the folder <installation_folder>/central/conf, and open the database.properties file.

5. Change the db.password value to the one that you copied.

6. In a cluster, repeat steps 1 to 5 on each node.

Note The password is stored encrypted, so make sure you include the
{ENCRYPTED} prefix.The = character needs to be escaped. For example,
db.password=GFDGDS12\=\=.

Related topics
For more information related to encrypting passwords, see Encrypting passwords.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 308
Robotic Process Automation 2019.11

Change the database IP


This section is relevant when you need to configure Robotic Process Automation to work with another database
instance. All the database parameters, such as database credentials, schema name, tables, and so on, should be
identical.

1. Edit the file <installation_folder>/central/conf/database.properties.

2. Look for the jdbc.url parameter. For example:

jdbc.url=jdbc\:jtds\:sqlserver\://16.60.185.109\:1433/schemaName;sendStringParametersAsUnicode\
=true

3. Change the IP address\FQDN of the database server.

4. Save the file.

5. Restart RPA Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 309
Robotic Process Automation 2019.11

Change the hostname IP

Change of RPA Central hostname or IP


If the Central hostname or IP has changed, you will need to manually update this hostname/IP address in a number
of places by completing the following steps:

1. Edit the file <installation_folder>/central/conf/central-wrapper.conf.

2. Look for the -Dmgmt.url parameter and update it with the correct hostname or IP address. For example:

-Dmgmt.url=http://[machine_name or IP]:8080/oo

3. Update the same -Dmgmt.url parameter in the file <installation_folder>/ras/conf/ras-wrapper.conf.

You need to perform this step for each RAS that communicates with the Central.

4. If you are using a Central certificate, generate a new Central certificate with the new FQDN.

It is not recommended to use the IP.

You will also need to replace the certificate in the Central keystore.

5. If there is a load balancer link configured, update this link in Central.

6. Restart Central and all affected RASes.

7. If you have configured a remote debugging session that uses the Central hostname or IP address, you will
need to modify the connection URL accordingly in RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 310
Robotic Process Automation 2019.11

Change of RAS IP
If the RAS IP is changed, this change affects the presentation in the Central URL, under System Configuration >
Topology > Workers.

If the RAS is a “reverse RAS”, it will become disabled in the Topology > Workers tab. You need to edit the row,
and replace the previous IP with the new one.
If the RAS is a “standard RAS”, the change will not affect functionality, because it is the RAS that connects to the
Central.

Related topics
To change the database IP, see Change the database IP

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 311
Robotic Process Automation 2019.11

Change the URL of a load balancer or RPA Central


While the best practice is to configure the URL of a Central/load balancer via the installer, if you need to make
changes to the URL after the RAS was already installed, you can do this by editing the ras-wrapper.conf file.
For example, this would be needed if you installed a RAS against a Central/load balancer and the Central/load
balancer’s FQDN changed. You will need to change Central/load balancer’s URL stored at the RAS level, so that the
RAS is able to communicate again with the Central/load balancer.

1. Stop the RAS.

2. Open the ras-wrapper.conf file, located under <installation folder>/ras/conf.

3. Edit the URL in the following line:

wrapper.java.additional.<x>=-Dmgmt.url=<http or https>://<FQDN>:<port>/oo

4. Restart the RAS.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 312
Robotic Process Automation 2019.11

Back up and recover RPA


You can back up and recover Robotic Process Automation as described below.

Back up
Back up the entire content of the <installation_folder>central\var\security folder and the
<installation_folder>central\conf\database.properties file.

Recover
1. Install a new RPA Central with "Do not start Central after installation" option and an existing schema.

2. Open the central/var/security folder.

3. Delete the credentials.store file, if it exists.

4. Override the encryption_repository and encryption.properties files with the backed up versions.

5. Override the central/conf/database.properties file with the backed up file.

6. Start the RPA Central service.

Related topics
For instructions to uninstall RPA components, see Uninstall RPA components

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 313
Robotic Process Automation 2019.11

Set up disaster recovery


Follow the below instructions to set up a successful disaster recovery.

Plan for disaster recovery


To enable disaster recovery, create a secondary datacenter by replicating the following:

Database configuration
Schema
RPA configuration and security files: <installation_folder>\central\var\security and
<installation_folder>\central\conf
The replication can be ongoing, using whatever means you choose, for example, disk replication or database
replication.

Perform disaster recovery


RPA supports cold disaster recovery, which requires a manual process to switch over from the primary datacenter
to the secondary datacenter. This may be required in the case of a full or partial failure in the primary datacenter.

1. Restore the RPA server(s) by reinstalling all nodes (RPA Central and RPA RAS). Use the database
configuration, schema, and RPA configuration and security files that you replicated for the secondary
datacenter.

Note You can configure the database (by editing the database.properties
file). See the "Secure and harden Robotic Process Automation" topic for more
information about configuring the database connection details.

2. Delete the old worker nodes in the database, which no longer exist.

3. Turn off RPA in the primary datacenter.

4. Switch over to the secondary datacenter.

Related topics
For information on deploying and managing RPA instances in a secure manner, see Set up security for RPA
Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 314
Robotic Process Automation 2019.11

System tuning
You can configure one or more of the following parameters for each Central node. The JVM and worker threads are
also applicable to each RAS node.

Note Changing any of the parameters below requires a restart of the configured
node.

JVM heap size


You can increase the initial and maximum size of the Central/RAS heap by configuring the central-wrapper.conf
and ras-wrapper.conf files (located under <installation_folder>/<central or ras>/conf/).

wrapper.java.initmemory=<value in MB>

wrapper.java.maxmemory=<value in MB>

We recommend configuring Central to 4GB and RAS to 2GB.

Worker threads
By default, each node has 20 worker threads. If your flows have a large number of parallel or multi-instance lanes,
we recommend gradually increasing this number, over several iterations, up to 100 threads.
You can configure the number of worker threads in the central-wrapper.conf and ras-wrapper.conf files
(located under <installation_folder>/<central or ras>/conf/).
Open the file and edit the -Dcloudslang.worker.numberOfExecutionThreads property.
This is a new property, which was not supported in versions earlier than 10.22. Therefore, it should be added, if it
doesn't exist, as follows:

wrapper.java.additional.<next available number>=

-Dcloudslang.worker.numberOfExecutionThreads=<new value>

Database connections
You can increase the number of database connections in the database.properties file (located under
<installation_folder>/central/conf/).
Edit the db.pool.maxPoolSize property. Recommended changes is for up to 100 connections to the DB, in total for
all Centrals.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 315
Robotic Process Automation 2019.11

Related topics
For more information on performance and sizing RPA, see Performance and sizing information.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 316
Robotic Process Automation 2019.11

Recurring administration tasks for RPA Workflow


Designer
This section includes administration tasks that you may need to perform periodically or in response to a situation
that occurs.
This section contains the following topics:

Advanced configuration of RPA components


Changing the database password
Change the database IP
Change the hostname IP
Encrypting passwords
Create a Git repository
Adjust the logging levels
Change the service name and description
Changing the Timeout Limit for the RPA Workflow Designer Web Interface
Configure content pack import size
Back up RPA Workflow Designer
Set up disaster recovery
System tuning

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 317
Robotic Process Automation 2019.11

Advanced configuration of RPA components


This topic describes the advanced configuration settings for each RPA component.

1. Navigate to the Robot or Recorder installation directory: <RPA Robot/Recorder installation


dir>\robot\conf\robot-wrapper.conf. For this example, Robot wrapper is explained.

2. Using any text editor, open the robot-wrapper.conf or recorder-wrapper.conf file and modify the
properties listed in the following table according to your need.

Property Description

Properties configurable for RPA Recorder and RPA Robot

wrapper.java.additional.XX=-Denabled.skills= List of all skills enabled in Recorder by default:


Java,Web,SAP,SAPUI5,SAPWDJ,SAPWebExt,SAP
NWBC Desktop,Terminal Emulators,UI
Automation.
The list of extra skills available on
experimental basis: ".NET, ActiveX, Delphi,
Flex, Mobile, Oracle, PeopleSoft, PowerBuilder,
Qt, Siebel, Stingray, Visual Basic,
VisualAgeSmallTalk, WPF, Silverlight."

wrapper.java.additional.XX=-Dterminal.hllapi.dll.name Specify a different name/path to the HllApi.dll


file that the terminal emulator uses.

wrapper.java.additional.XX=-Dterminal.hllapi.proc.name Specify the process name of the HllApi.proc in


case if it is different from the default one.

wrapper.java.additional.XX=-Dterminal.protocol Specify the terminal protocol.

wrapper.java.additional.XX.stripquotes=TRUE The qoutes will be stripped.

RPA Robot properties

wrapper.java.additional.XX=-Dusr.archive.location="C:\<TestResults>" The path and folder name (TestResults)


where Robot recordings are stored.

wrapper.java.additional.XX=-Drestart.on.skill.reconfiguration=FALSE If you set this to TRUE, the Robot will restart


the UFT and reconfigure it with additional
skills that may not have been added
previously to enable it to continue running.

wrapper.java.additional.XX=-Dusr.archive.delay=10 The delay time set for writing the archive with
results on the file system. In this example, the
set delay time is 10 seconds.

RPA Recorder properties

wrapper.java.additional.XX=-Dusr.temp=C:/Users/<USER>/AppData/Local/Temp/2/ The file path of the temp folder to store the


recordings.

wrapper.java.additional.33=-Dpreserve.temp.recordings=FALSE If set to TRUE, the temporary recordings will


persist with the Temp folder mentioned in the
above property.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 318
Robotic Process Automation 2019.11

Related topics
For more information on configuring Recorder settings, see Configure Recorder settings for RPA Workflow
Designer.
For more information on configuring RPA Robot execution results, see Configure RPA Robot execution results.
For more information on configuring Terminal emulators, see Configure an emulator to work with RPA Recorder.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 319
Robotic Process Automation 2019.11

Change the database password


To change the database password in RPA Workflow Designer:

1. If RPA Workflow Designer Service is up and running, stop the service.

2. Run the encrypt-password script with the --password <password> option, where <password> is the database
password.

Note You can either use -p as the flag to encrypt the password or --password.

For example: <install-dir>/designer/bin/encrypt-password --password <plain-text-pass>

3. Copy the result. It should appear as follows: {ENCRYPTED}<some_chars>.

4. Go to the folder <installation_folder>/designer/conf, and open the database.properties file.

5. Change the db.password value to the one that you copied. In a cluster, make sure to do this on each node.

Note The password is stored encrypted, so make sure you include the
{ENCRYPTED} prefix. The = character needs to be escaped. For example,
db.password=GFDGDS12\=\=.

Related topics
For more information related to encrypting passwords, see Encrypting passwords.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 320
Robotic Process Automation 2019.11

Change the database IP

This topic is relevant when you need to configure RPA Workflow Designer to work with another database instance.
All the database parameters, such as database credentials, schema name, tables, and so on, should be identical.

1. Edit the file <installation_folder>/designer/conf/database.properties.

2. Look for the jdbc.url parameter. For example:


jdbc.url=jdbc\:jtds\:sqlserver\://16.60.185.109\:1433/schemaName;sendStringParametersAsUnicode\=true.

3. Change the IP address/FQDN of the database server.

4. Save the file.

5. Start RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 321
Robotic Process Automation 2019.11

Change the hostname IP


If the hostname/IP has changed in RPA Workflow Designer, you must manually update this hostname/IP address, as
follows:

1. If you are using an RPA Workflow Designer certificate, generate a new certificate with the new FQDN (do not
use the IP address).

2. Replace the certificate in the RPA Workflow Designer keystore file, located in <installation
dir>/designer/var/security.

3. Restart RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 322
Robotic Process Automation 2019.11

Encrypt passwords
You can encrypt a password using the encrypt-password script, which is located in
<installation_folder>/designer/bin.

Encrypt passwords
1. Locate the encrypt-password script, in <installation_folder>/designer/bin.

2. Run the script with the -e -p <password> option, where password is the password you want to encrypt.

You can either use -p as the flag to encrypt the password or --password.
The encrypted password should appear as follows:
{ENCRYPTED}<some_chars>.

Important After using the encrypt-password script, clear the command


history. This is because, on a Linux OS, the password parameter will be stored
in cleartext under /$USER/.bash_history and accessible by the history
command.

Create a prompt for the password


It is recommended to run the encrypt-password script without providing the –p argument. For example:

C:\Program Files\Micro Focus\Robotic Process Automation Designer\designer\bin>encrypt-password.bat


Password <typing will be hidden>: Confirm password <typing will be hidden>:
<ENCRYPTED>sdf874sgs787fds09ewff== C:\Program Files\Micro Focus\Robotic Process Automation
Designer\designer\bin>

This will create a prompt for the hidden password inputs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 323
Robotic Process Automation 2019.11

Create a Git repository


If you do not have a Git server account, you can create a local Git repository. RPA Workflow Designer includes a
batch file for creating this repository: git-create-repo.bat.

1. Double-click the git-create-repo.bat file in the <installation path>/bin folder.

2. In the command line dialog box, enter the path to an existing folder on the current machine or on a network
location, where you want to create the repository. For example: \\xxx.net\shared\GIT\GitRepo. If the
repository is on a shared file system, make sure that the user for whom the RPA Workflow Designer server
will run has read and write permission for this file system.

3. You are now prompted to enter a name for the new repository that will be created under the path you
provided earlier. Add any name. You do not need to add the suffix ".git" to the name, as this is added by the
tool.

Note The repository name must not contain characters that are forbidden by
Windows or Linux, for example, *, <, >, or % and must not begin and end with
white spaces.

4. The URL of the newly created Git repository is displayed. Make a note of this URL, and press any key to close
the command-line dialog box.

Note The URL should be in the following format: file://<path>/<repo>.git

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 324
Robotic Process Automation 2019.11

Adjust the logging levels


Because logging activity can slow the performance of RPA Workflow Designer and create very large log files, it is
important for RPA Workflow Designer to run with appropriate logging levels. The default logging level is set to
INFO. This level provides the necessary information without impacting performance.
In addition, you can adjust the granularity of the information in the log, separately for regular logging, deployment,
and execution.
The granularity options are:
*INFO - Default logging information
*DEBUG - More logging information
*WARN - Less logging information
*ERROR - Less logging information
To adjust the granularity in the logging:

1. Open the log4j.properties file located at: /<installation_folder>/designer/conf/log4j.properties.

2. Replace INFO with DEBUG, WARN or ERROR in the relevant places in the log4j.properties file.

For example: log.level=WARN import.log.level=INFO project.log.level=INFO scm.log.level=INFO

The Tomcat server stores access logs under /<installation_folder>/designer/var/logs. To prevent these log
files from growing in size, it is recommended that you monitor the size of the files named
localhost_access_log.yyyy-mm-dd.txt, and delete old files as necessary. Use established best practices for
your operating system, whether Windows or Linux.

Sample
To delete files older than 10 days:

Unix

find <installation_folder>/designer/var/logs/ -name " localhost_access*.txt"


-type f -mtime +10 -exec rm -f {} \;

Windows

C:\Users\Administrator>forfiles /p "<installation_folder>\designer\var\logs" /s /m
localhost_access*.txt /d -10 /c "cmd /c del @PATH"
where <installation_folder> refers to the location of the RPA Workflow Designer installation folder.
You can set this up using a schedule in RPA Central or use Cron or Windows Scheduler to run these commands

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 325
Robotic Process Automation 2019.11

the background.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 326
Robotic Process Automation 2019.11

Change the service name and description

If you want to change the service name and description from the default values, you can edit these in the
designer-wrapper.conf file.

1. Stop the RPA Workflow Designer service.

2. Navigate to the designer\bin directory. The default is C:\Program Files\Micro Focus\Robotic Process
Automation Designer\designer\bin.

3. Run uninstall-designer-service.bat.

4. Verify that the service is uninstalled.

5. Navigate to the designer\conf directory.

6. Make a copy of the designer-wrapper.conf file.

Note

This step is an optional step used for saving the original configuration, so that
you have a backup if a rollback is required or if the modified file becomes
unusable in any way.

7. Edit the designer-wrapper.conf file, by modifying the following lines to suit your needs: wrapper.name
wrapper.displayname wrapper.description

For example: # Name of the service wrapper.name=MICROFOCUSOODC # Display name of the service
wrapper.displayname=Robotic Process Automation Designer

8. Run install-designer-as-service.bat.

9. Verify that the service is installed with the new names and description.

10. Start the new RPA Workflow Designer service.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 327
Robotic Process Automation 2019.11

Change the timeout limit


You can change the default session timeout (30 minutes) of the RPA Workflow Designer server by configuring the
tomcat web.xml file.

1. Open the <installation_folder>/designer/tomcat/conf/web.xml file with any XML editor.

2. Search for the following:

3. Change the session-timeout value (in minutes).

4. Restart the RPA Workflow Designer server.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 328
Robotic Process Automation 2019.11

Configure content pack import size


The default size limit of content packs that can be uploaded to RPA Workflow Designer is 200 MB (the exact size
limit is 209715200 bytes). However, you can configure this size limit. For example, you may want to adjust the size
limit to protect against DOS (Denial of Service).

1. Open the secured.properties file, located under <installation_dir>/designer/var/security/.

2. Update the value for the upload.max.fileSize.limit property.


Example:upload.max.fileSize.limit=209715200

3. Restart RPA Workflow Designer.

Related topics
For information about the secured properties file, see Configure the secured properties.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 329
Robotic Process Automation 2019.11

Back up RPA Workflow Designer

You can back up and recover RPA Workflow Designer as described below.

Backing up
Back up the entire content of the <installation_folder>designer\var\security folder and the
<installation_folder>designer\conf\database.properties file.

Recovery
1. Install a new RPA Workflow Designer with an existing schema. The installation will fail on the Start RPA
Workflow Designer step.

2. Stop the RPA Workflow Designer service and verify that RPA Workflow Designer is not running.

3. Open the designer/var/security folder.

4. Delete the credentials.store file, if it exists.

5. Override the encryption_repository, encryption.properties and secured.properties files with the


backed up versions.

6. Override the designer/conf/database.properties file with the backed up file.

7. Start the RPA Workflow Designer service.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 330
Robotic Process Automation 2019.11

Set up disaster recovery

Plan for disaster recovery


To enable disaster recovery, create a secondary datacenter by replicating the following:

Database configuration
Schema
RPA Workflow Designer configuration and security files: <installation_folder>\designer\var\security and
<installation_folder>\designer\conf
The replication can be ongoing, using whatever means you choose, for example, disk replication or database
replication.

Perform disaster recovery


RPA Workflow Designer supports cold disaster recovery, which requires a manual process to switch over from the
primary datacenter to the secondary datacenter. This may be required in the case of a full or partial failure in the
primary datacenter.

1. Restore the RPA Workflow Designer server(s) by reinstalling all nodes. Use the database configuration,
schema, and RPA Workflow Designer configuration and security files that you replicated for the secondary
datacenter.

Note

You can configure the database connection by editing the database.properties


file.

2. Delete the old worker nodes in the database, which no longer exist.

3. Turn off RPA Workflow Designer in the primary datacenter.

4. Switch over to the secondary datacenter.

Related topics
To set up database environment for RPA Workflow Designer, see Set up database environment for RPA Workflow
Designer

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 331
Robotic Process Automation 2019.11

System tuning
You can configure one or more of the following parameters for each RPA Workflow Designer node.

Note Changing any of the parameters below requires a restart of the configured
node.

JVM heap size


You can increase the initial and maximum size of the RPA Workflow Designer heap by configuring the designer-
wrapper.conf files (located under <installation_folder>/designer/conf/).
wrapper.java.initmemory=<value in MB>
wrapper.java.maxmemory=<value in MB>
We recommend configuring RPA Workflow Designer to 4GB.

Database connections
You can increase the number of database connections in the database.properties file (located under
<installation_folder>/designer/conf/).
Edit the db.pool.maxPoolSize property. We recommend changing it to 100 connections.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 332
Robotic Process Automation 2019.11

Set up the system configuration

Setting up the system configuration is usually done by the system administrator, after Robotic Process
Automation (RPA) is installed.
For more information on setting system configurations, see the following topics.

Set up security settings


Set up security for roles
Set up security using LDAP authentication
Set up security for internal users
Set up security for SAML authentication
Set up security using LW-SSO
Set up topology for workers and RASes
Set up the general settings
Set up the system settings for licensing
Monitor and control database size
Send email notifications
Customize email notifications
Set the browser language
Enable authentication
Enable auditing

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 333
Robotic Process Automation 2019.11

Set up security settings

The administrator can enable or disable the following security settings for RPA Central:

Authentication
Capturing of logged-in user credentials
Auditing
A customized security banner

The Security > Security Settings tab is only visible if you have been assigned a role with the Manage Security
Configuration or View Security Configuration permission. You will only be able to edit the settings if you have
been assigned a role with the Manage Security Configuration permission.

Reference material
Security > Enable Authentication

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 334
Robotic Process Automation 2019.11

GUI item Description

User Name Enter your administrator user name.


If the chosen LDAP domains has been set up, you will also need to select the domain for the
authentication.

Password Enter your administrator password.

OK Click to save the credentials and enable the authentication.

Security > Security Settings

GUI item Description

General section

Enable Authentication check Select the check box to enable the user authentication functionality in RPA.
box If this check box is cleared, there is no authentication and all users can
access all tasks.

Enable Capture of Logged-in Select the check box to enable RPA to capture the credentials of the logged-
User Credentials in user.

Enable Audit check box Select the check box to enable the auditing functionality in RPA. Users who
have been granted View Audit permission will be able to retrieve an audit
trail.

Security Banner section

Enable check box Select the check box to enable the security banner, so that it is displayed in
the Logon screen.

Banner text box Enter the text for the security banner. The maximum length of this text is
2000 characters.

Save Click to save the security banner.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 335
Robotic Process Automation 2019.11

Enable authentication
The Enable Authentication check box is available under the Security > Security Settings tab. You can use
this to enable or disable the authentication functionality in RPA Central. You must enable authentication
immediately after installation. If authentication is not enabled, all users will be able to access all tasks.
Only users with administrator credentials can enable authentication in RPA Central. This is to prevent a user from
becoming locked out of the system.
The Enable Authentication check box is only available if there are existing internal or LDAP users with
permission to disable the authentication in the future.

Enable auditing
RPA gives you the option to audit events, so that you can track security breaches. Auditing lets you track actions
that took place on RPA Central, such as logins, triggering flows, creating schedules, editing configurations, and so
on.
The Enable Audit check box is available under the Security > Security Settings tab. You can use this to enable
or disable the auditing functionality in RPA Central.
Once auditing has been enabled, a user who has been granted View Audit permission can retrieve an audit trail.

By default, the Enable Audit check box is not selected.


Audit events are persisted in the database.
Currently, it is only possible to retrieve an audit trail via APIs.

Enable the capture of logged-in user credentials


You can enable RPA to capture the credentials of the logged-in user. These credentials will then be used in flows
that have inputs assigned from logged-in user credentials.

When this option is not enabled (this is the default), the flow will prompt for a password at the relevant step.
When this option is enabled:

If a user starts or resumes a flow that includes logged-in credentials as an input parameter, the credentials of
the logged-in user will be captured in the database and in memory (in a protected manner) and used during
the flow run. This enables you to make the flow run automatically.

If a flow contains logged-in user credentials as an input parameter and you are using SAML or SSO
authentication, flow run automation is not available, because RPA does not have enough authentication
information.

The logged-in credentials that are captured are available to RPA Central only in the context of this session.
When the user logs out, the credentials are not saved in the database.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 336
Robotic Process Automation 2019.11

The logged-in user name will contain the domain unless the user belongs to the default LDAP or the user is an
internal user and a default LDAP is configured in the system.

When a user logs in to RPA Central, a message appears, warning that the user's credentials might be
captured and used during flow runs, if this is required by the runs.
When to use this?

The best practice for new flows is to pass credentials as inputs.

Limitations

There are limitations to using this option:

Capturing of logged-in user credentials in not supported on scheduled runs


Capturing of logged-in user credentials is supported only for users logging to RPA via the default LDAP or an
internal user repository

In the Scheduler, if the logged in user has updated his/her credentials, he/she can click the Update
Credentials button to update the credentials for all of this user's scheduled flows.

Caution If you enable the capture of the logged-in user credentials, this causes
these credentials to pass through the network. Therefore, we highly recommend
to use a secured network, or to use HTTPS redirect in order to protect the user
credentials. Additionally, when this setting is changed, if auditing is enabled, an
audit log is created.

Set up a security banner


You can configure a security banner to appear before the Logon screen. This banner may be useful if you want to
warn users about security rules and issues. When a security banner is enabled, it appears as a pop-up dialog box
before the Logon screen, and the user needs to click an OK button to continue. In IDM authentication mode the
security banner is not available.

What do you want to do?

Enable authentication

1. Click the System Configuration button to display the System Configuration workspace.

2. Click the Security tab and then click the Security Settings tab beneath it.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 337
Robotic Process Automation 2019.11

3. Select the Enable Authentication check box to display the Enable Authentication dialog box.

4. In the Enable Authentication dialog box, enter your administrator user name and password, and click Yes.

Note If a choice of LDAP domains has been set up, you will also need to select
the domain for the authentication.

Disable authentication

1. After the authentication functionality has been enabled, clear the Enable Authentication check box.

2. In the confirmation dialog box, click Yes.

Enable auditing

1. Click the System Configuration button to display the System Configuration workspace.

2. Click the Security tab and then click the Security Settings tab beneath it.

3. Select the Enable Audit check box.

4. In the confirmation dialog box, click Yes.

Disable auditing

1. After the auditing functionality has been enabled, clear the Enable Audit check box.

2. In the confirmation dialog box, click Yes.

Enable the capture of logged-in user credentials

1. Click the System Configuration button to display the System Configuration workspace.

2. Click the Security tab and then click the Security Settings tab beneath it.

3. Select the Enable capture of logged-in user credentials check box.

4. In the confirmation dialog box, click Yes.

Disable the capture of logged-in user credentials

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 338
Robotic Process Automation 2019.11

1. If the capture of logged-in user credentials functionality has been enabled, clear the Enable capture of
logged-in user credentials check box.

2. In the confirmation dialog box, click Yes.

Add a security banner

1. Click the System Configuration button to display the System Configuration workspace.

2. Click the Security tab and then click the Security Settings tab beneath it.

3. In the Security Banner section, select the Enable check box.

4. In the Banner text box, enter the text that you want to appear on the banner. The maximum length of this
text is 2000 characters.

5. Click Save to save the banner.

Edit a security banner

1. Click the System Configuration button to display the System Configuration workspace.

2. Click the Security tab and then click the Security Settings tab beneath it.

3. Make the required changes in the Banner text box.

4. Click Save.

Remove a security banner


If you clear the Enable check box, but do not delete the text from the Banner text box, you can save this text for
later use.

1. Click the System Configuration button to display the System Configuration workspace.

2. Click the Security tab and then click the Security Settings tab beneath it.

3. Clear the Enable check box in the Security Banner section.

4. Click Save.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 339
Robotic Process Automation 2019.11

Related topics
To set up roles, see Set up roles

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 340
Robotic Process Automation 2019.11

Set up security for roles

Access to RPA Central tasks is managed using Role-Based Access Control (RBAC). RBAC lets the administrator
control which actions RPA users are allowed to perform, based on their role.

A permission is a predefined ability to perform a task. RPA Central comes ready with a set of permissions that
can be assigned to roles.
A role is a collection of permissions. Roles can be assigned to users.
The Role tab is only visible if you have been assigned a role with the Manage Security Configuration or View
Security Configuration permission. You will only be able to edit the roles if you have a role with the Manage
Security Configuration permission. For example, you could create a role called FLOW MANAGER with permission
to run flows, view schedules, schedule flows, manage runs, and create reports. An END USER role could have
permission to run flows, but not to schedule them. If a role is set up with no schedule permissions, users with this
role do not even see the Scheduler module.
The large number of available permissions enables a refined definition of which parts of the web UI each role sees.
The administrator can formulate a dedicated UI experience for each group of users . This enables end users to use
Central and only be exposed to the information they need, limiting their ability to harm the system. Once the roles
are set up, they can be assigned to internal users or mapped to LDAP or SAML users:

The administrator can map a role to one or more groups, so that LDAP users who are assigned to these groups
will be assigned the permissions in the role.
The administrator can assign a role to an internal user, while setting up the user configuration.
By default, RPA Central includes the roles ADMINISTRATOR, END_USER, EVERYBODY, PROMOTER, and
SYSTEM_ADMIN, corresponding to these roles in RPA Workflow Designer.

Role-Based Access Control is not the same as content permissions. If you want to restrict access to
data (flows and folders), you will need to configure the permission of that content. This is done as
part of the promotion of a content pack..

Reference material
Security > Roles

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 341
Robotic Process Automation 2019.11

GUI item Description

Opens the Role Details dialog box, so that you can add a new role.

Add button

Opens the User Configuration dialog box, so that you can edit the selected role.

Edit button

Deletes the selected role.

Delete button

Set Default Role button Makes the selected role the default role. If the selected role was set as the
default role, makes it no longer the default role.

Role Name Displays the role name.

Description Displays a description of the role.

Group Mapping Displays the groups that have been mapped to the role.

Filter Boxes In the filter boxes at the top of the columns, enter text to filter the displayed
roles.

Role Details dialog box > Permissions tab

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 342
Robotic Process Automation 2019.11

GUI item Description

Name Enter a name for the role, of up to 255 characters.

Description Enter a description of the role, of up to 255 characters.

Run Management

View Schedules Permission to view schedules.

Manage Schedules Permission to create and modify schedules.

Manage Others' Runs Permission to modify runs that were triggered by other users.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 343
Robotic Process Automation 2019.11

GUI item Description

Remote Debugging Permission to trigger the RPA Workflow Designer Debugger on a remote RPA
Central. This permission also gives view and run permissions on all the Flow
Library. This can be limited by configuring the wrapper file, "central-wrapper.conf
file" with:
-DrestrictFlowDebugPermission=true

Content

View Content Packs Permission to view content packs.

Manage Content Packs Permission to modify content packs, deploy content, and roll back a deployment.

View Configuration Items Permission to view configuration items (for example, group aliases, system
accounts, system properties).

Manage Configuration Permission to modify the values of configuration items (for example, group aliases,
Items system accounts, system properties).

Manage Content Settings Permission to modify content permissions (for flows, system accounts, and
folders), flow persistence settings, and flow timeout settings.

System

View System Settings Permission to view the Monitoring and System Information reports, which contain
information for Micro Focus Support:
• /oo/reports/sysinfo shows the system configuration
• /oo/monitoring is a performance monitoring dashboard

Manage System Settings Permission to configure the log level using REST API.
Permission to manage the Audit configuration.

View Topology Permission to view workers and worker groups

Manage Topology Permission to enable/disable workers and configure worker groups

View Security Permission to view the security configuration. This includes viewing internal users,
Configuration roles, LDAP authentication, LWSSO, SAML, and the Security banner.

Manage Security Permission to modify the security configuration. This includes configuring internal
Configuration users, roles, LDAP authentication, LWSSO, SAML, and the Security banner.

View Audit Permission to access the audit trail.

Manage Data Cleanup Permission to use the data cleanup (purging) APIs.

Dashboard

View Dashboard Permission to view the Dashboard.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 344
Robotic Process Automation 2019.11

GUI item Description

Add Group button Displays a text box so that you can create a mapping from this role to a group.

Text box In the text box, type the name of the group to which you want to map this role.

Deletes the mapping in the adjacent text box.

Delete button

Create a role
You must have the Manage Security Configuration permission in order to create and edit roles.

1. Click the System Configuration button to display the System Configuration workspace.

2. Select Security > Roles.

3. Click the Add button.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 345
Robotic Process Automation 2019.11

4. In the Name box, enter a unique name for the role. The role name cannot have more than 255 characters.

5. In the Description box, enter a description of the role. The description cannot have more than 255
characters.

6. Select the check boxes next to the permissions that you want to assign to this role. The permissions are
grouped according to the four Central workspaces. If a role is not assigned any permissions in a workspace,
users with this role will not be able to enter that workspace.

Run Management

View Schedules – Permission to view schedules

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 346
Robotic Process Automation 2019.11

Manage Schedules – Permission to create and modify schedules


Manage Others' Runs – Permission to modify runs that were triggered by other users
Remote Debugging – Permission to trigger the RPA Workflow Designer Debugger on a remote RPA
Central. This permission also gives view and run permissions on all the Flow Library. If you want to
constrain this permission to the permissions assigned to the role of the user, modify the central-
wrapper.conf file with the following parameter;

-DrestrictFlowDebugPermission=true

.
Content

View Content Packs – Permission to view content packs


Manage Content Packs – Permission to modify content packs, deploy content, and roll back a
deployment.
View Configuration Items – Permission to view configuration items (for example, group aliases, system
accounts, system properties)
Manage Configuration Items – Permission to modify the values of configuration items (for example,
group aliases, system accounts, system properties)

Manage Content Settings - Permission to modify content permissions (for flows, system accounts, and
folders), flow persistence settings, and flow timeout settings.

System

View System Settings – Permission to view the Monitoring and System Information reports and to view
the system configuration values.

Note These reports contain information for Micro Focus Support:

/oo/reports/sysinfo shows the system configuration

/oo/monitoring is a performance monitoring dashboard

Manage System Settings – Permission to configure the log level using REST API, to manage the system
configuration values to manage the Audit configuration
View Topology – Permission to view workers and worker groups
Manage Topology – Permission to enable/disable workers and configure worker groups
View Security Configuration – Permission to view the security configuration. This includes viewing
internal users, roles, LDAP authentication, LWSSO, SAML, and Security banner configurations.
Manage Security Configuration – Permission to modify the security configuration. This includes

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 347
Robotic Process Automation 2019.11

configuring internal users, roles, LDAP authentication, LWSSO, SAML, and the Security banner.
View Audit – Permission to access the audit trail.
Manage Data Cleanup – Permission to use the data cleanup (purging) APIs.
Dashboard

View Dashboard - Permission to view the Dashboard

7. To map this role to an LDAP group, click the Group Mapping tab.

8. Click Save to save the role.

9. To enable the authentication functionality, select the Settings tab (under Security) and select the Enable
Authentication check box to display the Enable Authentication dialog box.

Note The Enable Authentication check box is only available if there are
existing internal or LDAP users with permission to disable the authentication in
the future.

If the Enable Authentication check box is not selected, there is no


authentication and all users will be able to access all tasks.

Edit a role
You must have Manage Security Configuration permission in order to edit a role.

1. Select Security > Roles.

2. Select the role that you want to edit and click the Edit button.

3. Make the required changes in the Role Details dialog box.

4. Click Save.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 348
Robotic Process Automation 2019.11

Delete a role
1. Select Security > Roles.

2. Select the role that you want to delete and click the Delete button.

3. Click OK in the confirmation dialog box.

Map a role to a group


Group mapping is case-sensitive. If you have two groups with similar names (for example, QG_Basic and qg_basic),
which you assign to two different roles, a user logged in with one of these roles will not have access to the
permissions of the other.

1. Select Security > Roles.

2. Select the role that you want to map to a group, and click the Edit button.

3. In the Role Details dialog box, click the Group Mapping tab.

4. Click the Add Group button to add a new mapping.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 349
Robotic Process Automation 2019.11

5. In the text box, type the name of the group to which you want to map this role.

6. If required, click the Add Group button again to map the role to further groups.

7. Click Save.

Delete the mapping of a role to a group


1. Select Security > Roles.

2. Select the role from which you want to remove the mapping to a group, and click the Edit button.

3. In the Role Details dialog box, click the Group Mapping tab.

4. Click the Delete button next to the mapping that you want to delete.

There is no confirmation dialog box when you delete a mapping. If you change your mind, click Cancel to
close the Role Details dialog box without saving.

5. Click Save.

Assign a role to be the default role


When a role is defined as the default role, it will be assigned to all users that have not been assigned a role. This
means that all LDAP users will have the permissions from this default role, in addition to users that are explicitly
associated with the role. If you are setting a default role, it is recommended to set this as the one with the least
privileges. Exercise caution while setting a default role as adding permissions to that role will affect all LDAP users.

1. Select Security > Roles.

2. Select the role that you want to specify as the default role.

3. Click the Set Default Role button in the Roles toolbar.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 350
Robotic Process Automation 2019.11

You can click the Set Default Role button again to remove the default role functionality from this role.

Related topics
To manage the flow library, see Manage the flow library
To set up security for internal users, see Set up security for internal users
To set up security settings, see Set up security settings

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 351
Robotic Process Automation 2019.11

Set up security using LDAP authentication

If you are using an LDAP authentication service, you can add the LDAP configuration to RPA Central. Users will
be able to log in to the system by providing their credentials from their organization. This change is
dynamic—there is no need to restart RPA Central for the change to be applied.
The LDAP groups that users belong to can be mapped to RPA roles, so that the administrator can control which
actions users are allowed to perform in the system.
If your organization works with multiple LDAP servers, it is possible to configure RPA Central to work with all of
them. This includes LDAPs with different schemes and from different vendors. For example, you might have an
Active Directory (Microsoft LDAP) implementation for one part of the organization and a Sun One (Oracle LDAP)
implementation for another part.
If you set up multiple LDAP configurations on different domains, when users log in to RPA, they will need to select
from a drop-down list with the active domains. There will be no drop-down list of domains if one of the LDAP
configurations is set as the default or if only internal users are configured.

Login Conventions
Users will be able to log in using the following conventions:

domain\username
username@domain
The domain name is required unless a user is logging in as an internal user or if they belong to the default LDAP.
It is also possible to log in using the samAccountName, mail, and principalName attributes.

Note For non-Active Directory configurations, it is also possible to log in with any
unique attribute.

Default LDAP
If you flag an LDAP configuration as default, users who belong to this LDAP will be able to log in without having to
select a domain.

Note If you do not have an LDAP service, you can set up internal users, who will
log in using their RPA user name and password. It is also possible to run RPA
Central without the user authentication feature. All Central users will be identified
as "anonymous" and the system will not require authentication. All RPA Central
users will have full administrative access to do anything in the system—triggering,
content management, and system configuration.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 352
Robotic Process Automation 2019.11

Note The LDAP tab is only visible if you have been assigned a role with the
Manage Security Configuration or View Security Configuration permission.
You will only be able to edit the LDAP authentication if you have a role with the
Manage Security Configuration permission.

Reference material

LDAP Navigation pane

GUI item Description

Add button Click to display the list of LDAP types that you can choose from.

Delete button Click to delete the selected LDAP configuration.

Click to make the selected LDAP configuration the default. This means that an
authentication attempt without a domain will go first to this LDAP and then to the internal
Default button users.
If you do not set a default, an authentication attempt without a domain will go directly to
the internal users.

The Default button is only available if the selected LDAP configuration has been
saved.

Navigation pane Displays the names of the LDAP configuration domain names. Click a domain name to
edit the configuration.

Disabled A domain name appears in gray text if the Enabled check box has been cleared for that
LDAP configuration.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 353
Robotic Process Automation 2019.11

Security > LDAP>Non-Active Directory configuration

Mandatory fields are indicated with a red asterisk.

GUI item Description

Click to test the configuration. A pop-up message displays the following


information:
Test button • Whether the authentication is successful
• Whether the configuration is valid
• Groups to which the user belongs, if any were found

Click to revert the configurations to the last saved configurations on the server.

Revert button

Click to save the selected LDAP configuration.

Save button

LDAP details section

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 354
Robotic Process Automation 2019.11

GUI item Description

LDAP Type Displays the LDAP type that you selected from the Add menu.

Domain Enter a name for the domain. This is name will be displayed when users log in to
RPA.
For example, if you have a single LDAP configuration, you might enter your
company name. If you are setting up multiple LDAP configurations, you would
give each one a domain that will identify it.

Privileged User DN Enter the distinguished name of a user with search privileges.
For example, uid=john,ou=people,dc=devlab,dc=ad
It is recommended to provide a privileged user, because some RPA functionality
uses searching, for example, the scheduler. If there is no privileged user, this
functionality may not work properly.
Make sure to use the exact DN for the user with these privileges.

Privileged User Password Enter the password of the user with search privileges.

Enabled Click to enable the authentication of this LDAP.

Connections section

Secured Channel Select the Secured Channel check box to support secured transport layer
connection.

Add button Click to add a new connection.

Delete button Click to delete the selected connection.

Use the arrows to move a connection up and down in the list. A connection that is
higher in the list has a higher priority in the case of failover

Host Enter the IP address or host name of the LDAP server.


For example, 16.55.222.71

Port Enter the port number of the LDAP server. This value must be between 0 and
64435.
For example, 389

Users section

Users DNs
Define the distinguished
names to use for the
users. Click the browse

button to open the


User DNs dialog box.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 355
Robotic Process Automation 2019.11

GUI item Description

Users Filter Enter the search filter parameters in order to filter users. This filter will be applied
on each user DN that was entered in the User DNs box.
It is recommended to modify the default values, even if they work, because this
filter is very general. It is highly recommended that the filter contain the
objectclass attribute.
In this filter, {0} is a placeholder for the user ID. When a user logs in, {0} is
automatically replaced with the supplied user name.

User Common Name Enter the attribute that defines how the user name will be displayed on the
Attribute screen.
In most LDAP implementations, cn is the default.

Users SUB Search Scope Select this check box if you want the users filter to run recursively.
check box If recursive searching is not required, then it is not recommended to select this
check box.

Groups section

Groups DNs Define the distinguished names to use for the groups. Click the browse button

to open the Group DNs dialog box.

Groups By User DN Filter Enter the search filter parameters in order to filter the groups. This filters the
groups of which the given user is a member. The filter is applied on each Group
DN.
It is recommended to modify the default values even if they work, because this
filter is very general. It is highly recommended that the filter contain the
objectclass attribute.

Group Name Attribute Enter the attribute that defines how the name of the group will be displayed in
the UI
Note In most LDAP implementations, cn is the default.

Groups SUB Search Scope Select this check box if you want the groups filter to run recursively.
check box If recursive searching is not required, then it is not recommended to select this
check box.

Security > LDAP> Active Directory configuration

Mandatory fields are indicated with a red asterisk.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 356
Robotic Process Automation 2019.11

GUI item Description

Click to test the configuration. A pop-up message displays the following


information:
Test button • Whether the authentication is successful
• Whether the configuration is valid
• Groups to which the user belongs, if any were found

Click to revert the configurations to the last saved configurations on the server.

Revert button

Click to save the selected LDAP configuration.

Save button

LDAP details section

LDAP Type Displays the LDAP type that you selected from the Add menu.

Domain (NetBIOS name) Enter the name of the domain (NetBIOS name) that you want to authenticate
against.
The domain name appears in the navigation pane to the left.

Privileged User Name Enter the user name of a user with search privileges.
It is recommended to provide a privileged user, because some RPA
functionality uses searching, for example, the scheduler. If there is no
privileged user, this functionality may not work properly.

Privileged User Password Enter the password of the user with search privileges.

Enabled Click to enable the authentication of this LDAP

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 357
Robotic Process Automation 2019.11

GUI item Description

Connections section

Secured Channel Select the Secured Channel check box to support secured transport layer
connection.

Add button Click to add a new connection.

Delete button Click to delete the selected connection.

Use the arrows to move a connection up and down in the list. A connection that
is higher in the list has a higher priority in the case of failover

Host Enter the IP address or host name of the LDAP server.


For example, 16.55.222.71

Port Enter the port number of the LDAP server. This value must be between 0 and
64435.
For example, 389

Users section

Users DNs Define the distinguished names to use for the users. Click the browse button

to open the User DNs dialog box.

Users Filter Enter the search filter parameters in order to filter users. This filter will be
applied on each user DN that was entered in the Users DNs box.
It is recommended to modify the default values, even if they work, because
this filter is very general. It is highly recommended that the filter contain the
objectclass attribute.
In this filter, {0} is a placeholder for the sAMAccountNameuser identifier
attribute. When a user logs in, {0} is automatically replaced with the supplied
user name..

User Common Name Enter the attribute that defines how the user name will be displayed on the
Attribute screen.

Group Membership Attribute Enter the attribute that shows which groups the user belongs to.
For example, memberOf

Users SUB Search Scope Select this check box if you want the users filter to run recursively.
check box If recursive searching is not required, then it is not recommended to select this
check box.

Groups section

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 358
Robotic Process Automation 2019.11

GUI item Description

Group Name Attribute Enter the attribute that contains the name of the group to be displayed in the
UI.
In most LDAP implementations, cn is the default.

Security > LDAP > Alternate Groups configuration

The Alternate Groups view is similar to the other non-Active Directory views. However, it does not contain a
Groups section, and it contains the Alternate Group Attributes box.
This enables you to set up an LDAP authentication configuration with a list of attribute names to be used as groups,
instead of group filters.

GUI item Description

Alternate Group Attributes Enter the attribute names that will be used as groups. Use a semicolon (;) as the
separator.

User DNs/Group DNs dialog box

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 359
Robotic Process Automation 2019.11

Click the browse button next to the User DNs box, to open the User DNs dialog box.

Click the browse button next to the Group DNs box, to open the Group DNs dialog box.
The fields in the two dialog boxes are the same.

GUI item Description

Add Base DN Click to select from the list of available root DNs that are fetched from the LDAP. Select the
one that is closes to your needs and then refine it.

Click to add a new, empty row, in order to manually enter the DN information.
If you have multiple LDAP hosts, use ";" as the delimiter.
Add
For example, ou=people,dc=devlab,dc=ad;ou=people,dc=devlab,dc=com

Click to delete the selected DN row.

Delete

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 360
Robotic Process Automation 2019.11

GUI item Description

Use the arrows to adjust the order of the DN rows. The first item in the list is used first.

There is a limit to how many groups a user can have. Users who are members of more than 1,015 groups may fail
logon authentication. For more information, see http://support.microsoft.com/kb/328889

Add an LDAP authentication configuration (not Active


Directory)
This procedure is relevant for all LDAP authentication configurations, apart from Active Directory.

1. Click the System Configuration button to display the System Configuration workspace.

2. Select Security > LDAP.

3. From the Add menu, select the type of LDAP configuration that you want to add.

The LDAP tab displays the fields relevant to the selected LDAP configuration.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 361
Robotic Process Automation 2019.11

4. In the Domain box, enter a name for the domain.

For example, if you have a single LDAP configuration, you might enter your company name. If you are setting
up multiple LDAP configurations, you would give each one a domain that will identify it.

When users log in to RPA, they will be able to select from a drop-down list of the active domains. They will be
required to select a domain name unless they are logging in as an internal user or if they belong to the
default LDAP.

The domain name appears in the LDAP navigation pane to the left.

5. In the Privileged User DN box, enter the distinguished name of a user with search privileges.

It is recommended to provide a privileged user, because some RPA functionality uses searching, for example,
the scheduler. If there is no privileged user, this functionality may not work properly, depending on how the
LDAP is configured.

For example, uid=john,ou=people,dc=devlab,dc=ad

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 362
Robotic Process Automation 2019.11

Note Make sure to use the exact DN for the user with these privileges.

6. In the Privileged User Password box, enter the password of the user with search privileges.

7. Select the Enabled check box to enable the authentication of this LDAP.

8. In the Connections section, select Secured Channel to support secured transport layer connection.

9. In the Hosts box, enter the IP address or host name of the LDAP server.

10. In the Ports box, enter the port number of the LDAP server. This value must be between 0 and 64435.

11. If you have multiple LDAP servers, click the Add button to add a new line, and add the additional host and
port.

12. Use the Up and Down arrows to move a connection up and down in the list. A connection that
is higher in the list has a higher priority in the case of failover.

13. Click the browse button next to the User DNs box, to open the User DNs dialog box, in order to define
the distinguished names for users.

If you know the user DN, click the Add button to add an empty row, and enter the user DN information
manually. If you have multiple LDAP hosts, use ";" as the delimiter.

For example, ou=people,dc=devlab,dc=ad;ou=people,dc=devlab,dc=com

If you don't know the exact syntax, click Add Base DN to fetch a base DN from the LDAP.

From the list of available root DNs, select the one that is closes to your needs and then refine it.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 363
Robotic Process Automation 2019.11

14. Use the Up and Down arrows to adjust the order of the user DN rows. The first item in the list
is used first.

15. Click OK to close the User DNs dialog box and load the information into the User DNs box.

16. In the Users Filter box, enter the search filter parameters in order to filter users. This filter will be applied on
each user DN that was entered in the Users DNs box.

It is recommended to modify the default values, even if they work, because this filter is very general. It is
highly recommended that the filter contain the objectclass attribute.

Note In this filter, {0} is a placeholder for the user ID. When a user logs in,
{0} is automatically replaced with the supplied user name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 364
Robotic Process Automation 2019.11

17. In the User Common Name Attribute box, enter the attribute that defines how the user name will be
displayed on the screen.

Note In most LDAP implementations, cn is the default.

18. Select the Users SUB Search Scope check box if you want the users filter to run recursively.

Note If recursive searching is not required, then it is not recommended to


select this check box.

19. Click the browse button next to the Group DNs box, to open the Group DNs dialog box, in order to
define the distinguished names for groups.

This step is very similar to defining the distinguished names for users.

20. In the Groups By User DN Filter box, enter the search filter parameters in order to filter the groups. This
filters the groups of which the given user is a member. The filter is applied on each Group DN.

It is recommended to modify the default values even if they work, because this filter is very general. It is
highly recommended that the filter contain the objectclass attribute.

21. In the Group Name Attribute box, enter the attribute that defines how the name of the group will be
displayed in the UI.

Note In most LDAP implementations, cn is the default.

22. Select the Groups SUB Search Scope check box if you want the groups filter to run recursively.

Note If recursive searching is not required, then it is not recommended to


select this check box.

23. Make sure to test the configuration before saving.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 365
Robotic Process Automation 2019.11

24. Click Save to save the configuration.

Note Make sure to save your changes before enabling authentication. If you
don't save, the authentication will not include your changes!

If the LDAP configuration is not saved, an asterisk appears next to the domain name in the LDAP navigation
pane to the left. If you leave the page before saving, a message appears, warning that there are unsaved
changes.

25. To enable the authentication functionality, select the Settings tab (under Security) and select the Enable
Authentication check box to display the Enable Authentication dialog box.

Note The Enable Authentication check box is only available if there are
existing internal or LDAP users with permission to disable the authentication in
the future.

If the Enable Authentication check box is not selected, there is no


authentication and all users will be able to access all tasks.

Add an Active Directory LDAP authentication


configuration
This procedure is relevant for Active Directory configurations only.

1. Click the System Configuration button to display the System Configuration workspace.

2. Select Security > LDAP.

3. From the Add menu, select Active Directory.

The LDAP tab displays the Active Directory view.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 366
Robotic Process Automation 2019.11

4. In the Domain (NetBIOS name) box, enter the AD short domain (NetBIOS name) that you want to
authenticate against, for example, EMEA, US, or ASIA. When users log in to RPA, they will be able to select
from a drop-down list of the active domains.

The domain name appears in the LDAP navigation pane to the left.

5. In the Privileged User Name box, enter the user name of a user with search privileges.

It is recommended to provide a privileged user, because some Robotic Process Automation functionality uses
searching, for example, the scheduler. If there is no privileged user, this functionality may not work properly.

6. In the Privileged User Password box, enter the password of the user with search privileges.

7. Select the Enabled check box to enable the authentication of this LDAP.

8. In the Connections section, select Secured Channel to support secured transport layer connection.

9. In the Hosts box, enter the IP address or host name of the LDAP server.

10. In the Ports box, enter the port number of the LDAP server. This value must be between 0 and 64435.

11. If you have multiple LDAP servers, click the Add button to add a new line, and add the additional host and
port.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 367
Robotic Process Automation 2019.11

12. Use the Up and Down arrows to move a connection up and down in the list. A connection that
is higher in the list has a higher priority in the case of failover.

13. Click the browse button next to the User DNs box, to open the User DNs dialog box, in order to define
the distinguished names for users.

If you know the user DN, click the Add button to add an empty row, and enter the user DN information
manually. If you have multiple LDAP hosts, use ";" as the delimiter.

For example, ou=people,dc=devlab,dc=ad;ou=people,dc=devlab,dc=com

If you don't know the exact syntax, click Add Base DN to fetch a base DN from the LDAP.

From the list of available root DNs, select the one that is closes to your needs and then refine it.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 368
Robotic Process Automation 2019.11

14. Use the Up and Down arrows to adjust the order of the user DN rows. The first item in the list
is used first.

15. Click OK to close the User DNs dialog box and load the information into the User DNs box.

16. In the Users Filter box, enter the search filter parameters in order to filter users. This filter will be applied on
each user DN that was entered in the Users DNs box.

It is recommended to modify the default values, even if they work, because this filter is very general. It is
highly recommended that the filter contain the objectclass attribute.

Note In this filter, {0} is a placeholder for the sAMAccountName user


identifier attribute. When a user logs in, {0} is automatically replaced with the
supplied user name.

17. In the User Common Name Attribute box, enter the attribute that defines how the user name will be
displayed on the screen.

Note For example, displayName.

18. In the Group Membership Attribute box, enter the attribute that shows which groups the user belongs to.

For example, memberOf

19. Select the Users SUB Search Scope check box if you want the users filter to run recursively.

Note If recursive searching is not required, then it is not recommended to


select this check box.

20. In the Group Name Attribute box, enter the attribute that defines how the name of the group will be
displayed in the UI.

Note In most LDAP implementations, cn is the default.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 369
Robotic Process Automation 2019.11

21. Make sure to test the configuration before saving.

22. Click Save to save the configuration.

Note Make sure to save your changes before enabling authentication. If you
don't save, the authentication will not include your changes!

If the LDAP configuration is not saved, an asterisk appears next to the domain name in the LDAP navigation
pane to the left. If you leave the page before saving, a message appears, warning that there are unsaved
changes.

23. To enable the authentication functionality, select the Settings tab (under Security) and select the Enable
Authentication check box to display the Enable Authentication dialog box.

Note The Enable Authentication check box is only available if there are
existing internal or LDAP users with permission to disable the authentication in
the future.

If the Enable Authentication check box is not selected, there is no


authentication and all users will be able to access all tasks.

24. In the Enable Authentication dialog box, enter your administrator user name and password, and click OK.

Edit an LDAP authentication configuration


1. Select Security > LDAP.

2. Select the LDAP authentication configuration that you need to edit.

3. Enter the required changes.

4. Make sure to test the configuration before saving.

5. Click Save.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 370
Robotic Process Automation 2019.11

Configure a list of attributes whose values will be used


as groups
It is possible to set up an LDAP authentication configuration with a list of attribute names that will be used as
groups, as an alternative to group filters.
This enables organizations to base the functional groups of users on LDAP attributes, rather than LDAP groups.

1. Select Security > LDAP.

2. From the Add menu, select Alternate Groups.

The LDAP tab displays the Alternate Groups view. This view is similar to the Non-Active Directory view, but it
has an extra text box, Alternate Group Attributes, and does not include the Groups section.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 371
Robotic Process Automation 2019.11

3. In the Alternate Group Attributes box, enter the attribute names that will be used as groups. Use a
semicolon (;) as the separator.

4. Enter the rest of the configuration details as described in "Add an LDAP authentication configuration (not
Active Directory)" topic, apart from the Group fields.

Set the default LDAP authentication configuration


If you set a default LDAP configuration, users who belong to this LDAP will not be required to select a domain, upon
login.
Any authentication attempt without a domain will go first to the default LDAP and then to the internal users.

Note The Default button is only available if the selected LDAP configuration
has been saved.

1. Select one of the LDAP authentication configurations from the navigation pane to the left.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 372
Robotic Process Automation 2019.11

2. Click the Default button in the toolbar.

The Default icon appears next to the configuration name.

3. To stop this configuration from being the default, select the configuration name and then click the Remove

Default LDAP button.

Test an LDAP authentication configuration

1. After entering the LDAP details, click the Test button.

2. In the Test LDAP Configuration dialog box, enter the user name and password, and click Test.

A pop-up message displays the following information:

Whether the authentication is successful


Whether the configuration is valid
Groups to which the user belongs, if any were found

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 373
Robotic Process Automation 2019.11

3. Click Close to close the dialog box when the testing is complete.

Delete an LDAP authentication configuration


1. Select an LDAP configuration.

2. Click the Delete button in the toolbar.

3. Click Yes in the confirmation dialog box.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 374
Robotic Process Automation 2019.11

Disable an LDAP authentication configuration


You might want to temporarily disable an LDAP configuration, while saving the details for later.

1. Select an LDAP configuration.

2. Clear the Enabled check box in the LDAP Details section.

The selected LDAP configuration name appears in gray text in the LDAP Navigation pane.

Enable Central to trust valid certificates from secured


LDAP servers
When this configuration item is enabled, Central will trust any valid certificate from a secured LDAP server. You do
not have to add it to the client.truststore.
When this is not enabled, you are required to add the certificates from the LDAP servers used for LDAP
authentication to the client.truststore. Central will not trust them otherwise.

1. In the command line of the OOSH utility, type (for example):

set-sys-config --key ldaps.trustAllCertificates --value true

2. Press the Enter key.

By default, the configuration item named ldap.trustAllCertificates is set to false. This means that RPA will not
trust all certificates, and you must configure the LDAP certificate in the Central truststore accordingly.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 375
Robotic Process Automation 2019.11

Related topics
To set up security for roles, see Set up security – roles
To set up security for internal users, see Set up security – internal users
To set up security settings, see Set up security settings

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 376
Robotic Process Automation 2019.11

Set up security for internal users

As an alternative to using an external authentication system, such as LDAP, it is possible to set up internal
users in RPA Central. Internal users will log in using their RPA user name and password, and they will not require
any external authentication.
By assigning roles to users, the administrator controls which actions users are allowed to perform in the system.
The Internal Users tab is only visible if you have been assigned a role with the Manage Security Configuration
or View Security Configuration permission. You will only be able to edit the users if you have been assigned a
role with the Manage Security Configuration permission.

If a user has been assigned the same user name for both LDAP user and internal user, RPA Central will relate to the
LDAP user.

Reference material

Security > Internal Users

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 377
Robotic Process Automation 2019.11

GUI item Description

Opens the Internal Users Configuration dialog box, so that you can add a new user.

Add button

Opens the Internal Users Configuration dialog box, so that you can edit the selected user.

Edit button

Deletes the selected user.

Delete button

User Name Displays the user name.

Roles Displays the roles that have been assigned to the user.

Filter boxes In the filter boxes at the top of the columns, enter text to filter the displayed users.

Internal User Details dialog box

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 378
Robotic Process Automation 2019.11

GUI item Description

User Name Enter a unique user name of up to 255 characters.

Password Enter a password of 6 to 255 characters.

Confirm Password Enter the password a second time for verification.

Roles Select the check box next to each role that you want to assign to this user. You can assign
multiple roles to a user.

Save Click to save the user.

Add a user
1. Click the System Configuration button to display the System Configuration workspace.

2. Select Security > Internal Users.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 379
Robotic Process Automation 2019.11

3. Click the Add button.

4. Enter the details for the internal user:

a. In the User Name box, enter a unique user name. The user name must not contain \ or : and cannot
have more than 255 characters.

b. Enter the password in both the Password and the Confirm Password boxes. The password cannot
have more than 255 or less than 6 characters.

c. Select the check box next to each role that you want to assign to this user. You can assign multiple
roles to a user.

Note If you assign multiple roles to a user, the user will be able to access
all the permissions in those assigned roles. A role with fewer permissions
will not restrict this user's access to the permissions in their other roles.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 380
Robotic Process Automation 2019.11

5. Click Save to save the new user.

6. To enable the authentication functionality, select the Settings tab (under Security) and select the Enable
Authentication check box to display the Enable Authentication dialog box.

Note The Enable Authentication check box is only available if there are
existing internal or LDAP users with permission to disable the authentication in
the future.

If the Enable Authentication check box is not selected, there is no


authentication and all users will be able to access all tasks.

Edit a user account


1. Click the System Configuration button to display the System Configuration workspace.

2. Select Security > Internal Users.

3. Select the check box next to the user that you want to edit and click the Edit button.

Note The Edit button is only enabled if a single user is selected.

4. Make the required changes in the User Configuration dialog box.

5. Click Save.

Delete a user
1. Select Security > Internal Users.

2. Select one or more users that you want to delete and click the Delete button.

Note The Delete button is only enabled if at least one user is selected.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 381
Robotic Process Automation 2019.11

3. Click OK in the confirmation dialog box.

Note A user cannot delete their own account.

Related topics
To set up security for roles, see Set up security for roles.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 382
Robotic Process Automation 2019.11

Set up security for SAML authentication

Administrators can configure RPA Central to work with SAML 2.0 authentication.
SAML (Security Assertion Markup Language) is an XML-based open standard data format for exchanging
authentication and authorization data between an identity provider and a service provider. The process of
authenticating and authorizing users with the identity provider involves the use of a SAML artifact and SAML
assertions.
A SAML assertion is an XML document that includes the attributes that define the user and the user's group. The
identity provider sends these attributes to the service provider, and based on these attributes, the service provider
provides access rights to the user.
A SAML artifact is a sequence of bytes that encodes two pieces of information:

The artifact ID for the SAML assertion, which is retrievable from the identity provider
A SOAP endpoint, which can be used to resolve this handle.
The SAML artifact string should be passed as a query parameter over the request URL in Base64 encoding format.
For example:
http(s)://<FQDN>:<PORT>/saml/SSO/alias/defaultAlias?SAMLart=ARTIFACTEncodedString
The SAML tab is only visible if you have been assigned a role with the Manage Security Configuration or View
Security Configuration permission. You will only be able to edit the SAML authentication if you have a role with
the Manage Security Configuration permission.
It is recommended to keep the admin user, so that you will be able to log in directly, if there is an error in your
SAML configuration.
You must use an internal/ldap user for RPA Workflow Designer remote debugger, when creating a flow schedule
in RPA Central, and when using RESTful APIs or backwards compatible SOAP and RESTful APIs.

Prerequisites
Before setting up SAML authentication, complete the following steps:

1. Configure RPA Central for SSL.

2. If you have changed the key.store default password, you need to set it as a system configuration item.

Note This step is not needed if you use the default password.

3. If you have changed the server certificate (private key) default password and the alias default value of this
certificate in the key.store, you need to set them as system configuration items.

Note This step is not needed if you use the default values.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 383
Robotic Process Automation 2019.11

4. Import the public keys of the identity provider's certificate into the RPA Central key.store. For example:

keytool -importcert -alias <any_alias> -keystore key.store -file <certificate_name.cer>


–storepass <changeit>

5. Restart the server.

6. Open the RPA Central user interface. Make sure to use the fully qualified domain name in the URL.

7. Create the administrator user and administrator role, and any other roles that are needed.

8. Map the roles to the required groups.

Change the default values of the SAML system


configuration
If you have changed the key.store default password, you need to set it as a system configuration item.
If you have changed the server certificate (private key) default password and the alias default value of this
certificate in the key.store, you need to set them as system configuration items. However, you will not need these
steps if you use the default values.
If you want to change the password of the key.store or the Robotic Process Automation server certificate (that
was imported into the key.store), you need to encrypt the password with the encryption tool using the following
steps:

1. On the machine where you have installed RPA Central, navigate to <install dir>/central/bin/encrypt-
password and enter the following code:

encrypt-password --encrypt --password <your password>

2. Run set-sys-config --key <key> --value <value> For example:

set-sys-config --key key.store.private.key.alias.name --value newValue

You can view a list of all system configurations by running the ‘lsc’ command.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 384
Robotic Process Automation 2019.11

Add a SAML authentication configuration


Before starting this procedure, read the "Prerequisites" topic, and complete any necessary steps.

1. Click the System Configuration button to display the System Configuration workspace.

2. Select Security > SAML.

3. In the Service Provider section, enter the entity ID of the service provider (RPA Central). The default is
ooentityid.

4. In the Identity Provider section, enter the details of the identity provider:

IDP metadata URL: Enter the SAML metadata for the identity provider with which you will interact.
User name attribute: Enter the SAML assertion attribute name that defines the user.
Group names attribute: Enter the SAML assertion attribute name that defines the user groups.
Group names delimiter: Enter the delimiter used for the groups in the SAML assertion group names
attribute. Ensure that the attributes are correct; otherwise, access will be denied.

5. If RPA Central is installed behind a proxy, define the forward (web) proxy host and port number.

6. Define the Internal user that can be used for scheduling.

7. Click Enable to enable SAML.

8. Click Save.

9. Click the Download Metadata button to save the metadata file. This button is enabled after you enable and
save the SAML configuration.

10. Provide the metadata file to the identity provider.

11. To enable the authentication functionality, select the Settings tab (under Security) and select the Enable
Authentication check box to display the Enable Authentication dialog box. The Enable Authentication
check box is only available if there are existing internal or LDAP users with permission to disable the
authentication in the future. If the Enable Authentication check box is not selected, there is no
authentication and all users will be able to access all tasks.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 385
Robotic Process Automation 2019.11

Add SAML authentication configuration to a load


balancer
When setting up a load balancer, you need to resend the service provider metadata to the identity provider.
Before starting this procedure, read the "Prerequisites"topic, and complete any necessary steps.

1. Create a copy of the key.store file in the same /<rpa-installation>/central/var/security path, and
rename it to saml.store.

2. Change the SAML key manager store from key.store in saml.store by modifying the
samlSecurityContext.xml file which resides at the following path: /<rpa-
installation>/central/tomcat/webapps/oo/WEB-INF/classes/META-INF/spring To do that, you need to
modify the following line: <constructor-arg value="file:#{systemProperties['oo.home'] +
'/var/security/key.store'}"/>

3. Restart RPA Central.

4. Access the above RPA Central and complete all the steps in the "Add a SAML authentication configuration"
topic.

5. Set the external URL of the load balancer (under the System Settings tab) and save.

6. Click the Download Metadata button to get the new metadata with the external URL details.

7. Delete the <ds:Signature></ds:Signature> from the metadata.

8. Provide the metadata file to the identity provider.

9. Copy the above saml.store file to all RPA Centrals from the cluster, in the /<rpa-
installation>/central/var/security path.

10. Repeat the step 2 on all RPA Centrals.

11. Restart all RPA Centrals.

Change the SAML log level


You can change the SAML log level in the log4j.properties file.

1. Open the log4j.properties file (under /<rpa-installation>/central/conf/log4j.properties).

2. Locate the line that refers to the SAML logging level. For example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 386
Robotic Process Automation 2019.11

saml.log.level=INFO

3. Change the logging level to DEBUG or ERROR/WARNING as required.

Configure SAML to work with SHA-1, SHA-256 and


SHA-512
To change the SAML SHA signing algorithm, perform the following actions on all RPA Central installations in your
environment:

1. Go to <RPA Central installation>/central/conf and open the central-wrapper.conf file.

2. Scroll down to the last wrapper.java.additional parameter in the file. Add a new instance of the parameter,
continuing numbering from the last wrapper.java.additional parameter and assigning one of the following
values: sha1, sha256 or sha512 value. For example:

#Extra Central settings

wrapper.java.additional.<last parameter number +1>=-Dsaml.rsa.algorithm=sha256

3. Restart RPA Central.

Reference material

Security > SAML

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 387
Robotic Process Automation 2019.11

GUI item Description

Enable check box Select to enable the SAML authentication

Entity ID Enter the identity ID of the service provider (RPA Central). The default is
ooentityid.

IDP metadata URL Enter the SAML metadata for the identity provider with which you will interact.

User name attribute Enter the SAML assertion attribute name that defines the user.

Group names attribute Enter the SAML assertion attribute name that defines the user groups.

Group names delimiter Enter the delimiter used for the groups in the SAML assertion group names
attribute.

Host If RPA Central is installed behind a proxy, define the forward (web) proxy host.

Port If RPA Central is installed behind a proxy, define the forward (web) proxy port
number.

Download metadata Click to save the metadata file, which then needs to be sent to the identity
provider. This button is enabled after you enable and save the SAML
configuration.

Scheduling settings Define the internal user that can be used for scheduling.

Enable Authentication check Select to enable the user authentication functionality in RPA. If this check box
box is cleared, there is no authentication and all users can access all tasks.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 388
Robotic Process Automation 2019.11

SAML system configuration

If you update the following configuration items, you will need to restart the server (security context).

Configuration item Action

key.store.password To set the password used to access to the key.store. The default value
is 'changeit'.

key.store.private.key.alias.name To set the alias used to for the server certificate (private key) in the
key.store. The default value is 'tomcat'.

key.store.private.key.alias.password To set the password used to access the server certificate (private key)
from the key.store. The default value is 'changeit'.

Known issues and troubleshooting


The Central Scheduler does not work when using SAML authentication.
If you get locked out, with no access via the identity provider, log into RPA directly. Make sure to keep the admin
user, for this. To log in directly, go to http(s)/<host>:<port>/RPA/login/directSet up SAML authentication.
If you are using LDAP, you must set a default LDAP configuration.

Related topics
To set up LDAP authentication, see Set up security with LDAP authentication
For more information about creating roles and mapping them to groups, see Set up security for roles
To set up security settings, see Set up security settings
To set up workers and RASes, see Set up topology for workers and RASes
To adjust logging levels, see Adjust the logging levels

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 389
Robotic Process Automation 2019.11

Set up security using LWSSO

Introduction to LWSSO in RPA

You can set up single sign-on (SSO) for RPA through Lightweight Single Sign On (LWSSO). LWSSO is a solution
that enables single sign-on using one authentication across various applications.
LWSSO shares a cookie between products that are accessed from a web browser. As a result, if a user logs onto
another product web client that has LWSSO enabled, such as the SM web client or the BSM web client, this user will
be able to enter the RPA Central application directly, bypassing the RPA Central log on screen.
Prerequisites for this configuration:

The LWSSO feature must be enabled on all the products between which you want to use single sign-on.
The user's logon credentials in the other product must match those of an RPA user account.

For example, if BSM is integrated with RPA, the user that is logged into BSM must also exist in RPA (either an
LDAP user or an internal user).

Even if RPA is set up with multiple LDAP configurations, it is only possible to authenticate the user using LWSSO
with the default LDAP. LWSSO will first try to authenticate the user with the default LDAP, and if this fails, will try to
authenticate within the RPA internal domain. If you are using LDAP, you must set a default LDAP configuration.
After you save an LWSSO configuration, the changes take effect immediately, and there is no need to restart the
server.
All nodes in the cluster configuration will refresh their configuration from the database periodically at a 10 minute
interval. In the case of a single server, the node will update its configuration from the database at the same 10
minute interval.
When connecting another application that employs LWSSO to RPA, you must specify the connection URL of RPA
using the following format:
<protocol>://<FQDN>:<portNumber>
For example, http://lab.lab:8080
The LWSSO enabling procedure may be different for other products. See the corresponding documentation for each
product.
For example, for some applications, the connection URL needs to be in the format
<protocol>://<FQDN>:<portNumber>/oo.
The SSO tab is only visible if you have been assigned a role with the Manage Security Configuration or View
Security Configuration permission. You will only be able to edit the LWSSO authentication if you have a role with
the Manage Security Configuration permission..
When RPA Central and a RPA RAS are installed on the same machine, and the LWSSO settings are enabled, you
must set the management URL property using the fully qualified domain name, in the ras/conf/ras-wrapper.conf
file.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 390
Robotic Process Automation 2019.11

Reference material

Security > SSO

GUI item Description

Enable Authentication Select the check box to enable the user authentication functionality in RPA. If this
check box check box is cleared, there is no authentication and all users can access all tasks.

The icons next to the LW SSO Settings title indicate whether the settings are
enabled or disabled.

Enable Select the check box to enable LWSSO.

initString The initstring is used to encrypt the LWSSO cookie and has no link to the user’s
password. However, when two applications are integrated using LWSSO, the initstring
in both applications must match. Otherwise, the cookie encrypted by one application
cannot be decrypted by the other application.

Domain Enter the domain of the RPA server.

Protected Domains If there are multiple domains used by applications that employ LWSSO, enter them in
the Protected Domains box, using commas as separators.
The RPA server domain must appear in the Protected Domains list. When there are
several domains in the Protected Domains box, all applications that are integrated
through LWSSO must define the same list of protected domains.

Save Click to save the LWSSO authentication configuration.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 391
Robotic Process Automation 2019.11

Set up the LWSSO authentication configuration


1. Click the System Configuration button to display the System Configuration workspace.

2. Select Security > SSO.

3. In the initString box, enter the password you want to use to connect products. This value must be the same
as those used in the LWSSO configuration of the other products. This password must contain at least 12
characters.

The initstring is used to encrypt the LWSSO cookie and has no link to the user’s password. However, when
two applications are integrated using LWSSO, the initstring in both applications must match. Otherwise, the
cookie encrypted by one application cannot be decrypted by the other application.

4. In the Domain box, enter the domain of the RPA server.

5. If there are multiple domains used by applications that employ LWSSO, enter them in the Protected
Domains box, using commas as separators.

The RPA server domain must appear in the Protected Domains list. When there are several domains in the
Protected Domains box, all applications that are integrated through LWSSO must define the same list of
protected domains.

6. Select the Enable check box to enable the LWSSO configuration. If you do this, after you save the settings,

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 392
Robotic Process Automation 2019.11

the icon next to the LW SSO Settings title will change to Enabled .

The Enable check box is there to let you disable an LWSSO configuration while keeping the general
authentication feature enabled. For example, you might have authentication enabled for internal users and
LDAP users, but you may or may not want the LWSSO configuration to be enabled.

The new state of LWSSO settings is not enabled immediately when you select the Enable check box, but it
does when you save the new configuration.

7. Click Save.

8. To enable the authentication functionality, select the Settings tab (under Security) and select the Enable
Authentication check box to display the Enable Authentication dialog box.

Note The Enable Authentication check box is only available if there are
existing internal or LDAP users with permission to disable the authentication in
the future.

If the Enable Authentication check box is not selected, there is no


authentication and all users will be able to access all tasks.

Edit an existing LWSSO authentication configuration


1. Select Security > SSO.

2. Enter the required changes.

3. Click Save.

Update or retrieve the LWSSO configuration via


REST API
Updating or retrieving the LWSSO configuration via REST API may be useful if LWSSO is configured incorrectly and
you get locked out of the RPA Central system.
To update the LWSSO configuration:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 393
Robotic Process Automation 2019.11

HTTP Rest call at /oo/rest/authns/lwsso-config with the PUT HTTP method.


With a .json of the type: { enabled : false, initString : “CENTRAL_PASS_PHRASE”, domain : “domain1”
protectedDomains : [“domain1”, “domain2”] }
To retrieve the LWSSO configuration:
HTTP Rest call at /oo/rest/authns/lwsso-config with the GET HTTP method.

Related topics
To configure LWSSO setings for RPA, see Configure LWSSO settings.
To set up security using LDAP authentication, see Set up security – LDAP authentication.
To set up security settings for RPA, see Set up security settings.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 394
Robotic Process Automation 2019.11

Set up a security banner

You can configure a security banner to appear before the Logon screen. This banner may be useful if you want
to warn users about security rules and issues.
For example, you may want to create a banner that says "You are now logging on to our PRODUCTION
environment. Do not continue unless you are familiar with the Governance rules for this system and have taken the
necessary training."
When a security banner is enabled, it appears as a pop-up dialog box before the Logon screen, and the user needs
to click OK to continue.
The Security Banner tab is only visible if you have been assigned a role with the Manage Security
Configuration or View Security Configuration permission. You will only be able to edit the banner if you have
been assigned a role with the Manage Security Configuration permission.
The Security Banner is not available when using IDM.

Add a security banner


1. Click the System Configuration Workspace button to display the System Configuration workspace.

2. Select Security > Security Banner.

3. Select the Enable check box.

4. In the Banner text box, enter the text that you want to appear on the banner. The maximum length of this
text is 2000 characters.

5. Click Save to save the banner.

6. To enable authentication, select the Enable Authentication check box, and select OK in the confirmation
dialog box.

The Enable Authentication check box is only available if there are existing internal or LDAP users with
permission to disable the authentication in the future.

If the Enable Authentication check box is cleared, there is no authentication and all users can access all
tasks.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 395
Robotic Process Automation 2019.11

Edit a security banner


1. Click the 'System Configuration Workspace button to display the System Configuration workspace.

2. Select Security > Security Banner.

3. Make the required changes in the Banner text box.

4. Click Save.

Remove a security banner


If you clear the Enable check box, but do not delete the text from the Banner text box, you can save this text for
later use.

1. Click the System Configuration Workspace button to display the System Configuration workspace.

2. Select Security > Security Banner.

3. Clear the Enable check box.

4. Click Save.

Related topics
To set up security using LWSSO, see Set up security using LWSSO
To set up topology for workers and RASes, see Set up topology for workers and RASes

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 396
Robotic Process Automation 2019.11

Set up topology for workers and RPA RASes

Network topology is the arrangement of the various elements (links, nodes, and so on) in a network. Workers
and RPA RASes are part of the topology and can be configured under the Topology tab.
The Workers tab displays information about the following items:

Central worker - RPA Central workers are responsible for executing flows. A RPA Central worker obtains tasks
(flow execution messages) to process from RPA Central. An RPA Central worker can be assigned to a worker
group. This enables workers to withstand a high action execution load and increases availability of workers in a
data center.

Standard RPA RAS - a RPA RAS is a remote action server, containing a worker and a remote protocol for
connecting with RPA Central. A standard RPA RAS will initiate the connection to RPA Central. After a standard
RPA RAS is installed, it will appear in the grid in the Workers tab.
Reverse RAS - a reverse RAS will wait for Central to initiate the connection. To define a reverse RAS, you must:

a. Install the reverse RAS during the installation procedure. This creates the ras-connectivity.properties file
containing the RAS configuration details.

b. Then, register the reverse RAS in the Workers tab.

One of the RPA Centrals is selected to establish connection to the RAS. If this RPA Central is shut down, all RASes
that this RPA Central was responsible to establish connection to, will be reassigned to other RPA Central nodes in
the cluster equally.

While attempting to connect to a reverse RAS:

If the RAS does not answer after 30 seconds, a timeout will occur.
If there are several consecutive failed connection attempts (because the wrong shared secret was entered),
this will result in a delay. If this occurs, check that you are using the correct shared secret.
The Topology tab is only visible if you have been assigned a role with the Manage Topology or View Topology
permission. You will only be able to edit the topology if you have a role with the Manage Topology permission.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 397
Robotic Process Automation 2019.11

The Topology > Workers tab displays information about each worker/RAS: their status (Running or Stopped),
installation path, connection details, operating system, ID, and so on.
The status can take a minute or two to update. If you stop a RPA RAS service, it takes a few minutes until this is
reflected in the Topology > Workers tab. There is no need to restart RPA Central.
Execution Status
The Topology > Workers tab displays information about the resources that are being consumed by each
worker/RAS, under Execution Status. This information may help with troubleshooting the system, and may
contribute to decisions about scaling and resource allocation.
The information about resource consumption is automatically refreshed periodically. Take into account that the
displayed information is only relevant to the last few minutes, since the previous refresh, and is not cumulative. In
order to properly understand what is happening in your environment, it is recommended to observe the statuses
over a period of time
A worker/RAS can have one of the following execution statuses:

Idle: This worker has almost no tasks to process.


Low Utilization: This worker is working at low utilization.

If your workers are with idle/low utilization over a long period of time, you might consider removing them.

Working: This worker is working with a regular load.


Pending on RPA Central: Most of the time, this worker is waiting to send execution results to Central. Central
is busy with handling other tasks. If this state is displayed over a long period of time, you might consider adding
more RPA Centrals, or monitoring your database for space, connectivity, and so on, to make sure it is not a bottle
neck.
Loaded: At the current time, this worker works at maximum ability and is not able to get more tasks from
Central. If all your workers are loaded most of time, consider adding more RPA Centrals or RPA RASes.
N/A: No information is provided for this worker.
Registering a Reverse RAS
While installing a RAS, you chose whether the RAS will initiate the connection to RPA Central (Standard RPA RAS) or
wait for Central to initiate the connection (Reverse RAS)
If a RAS was configured to accept connection from Central (Reverse RAS), you must configure Central to register
the RAS by providing all required information: host/IP, port, and so on. Until you do this, the RAS will be idle,

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 398
Robotic Process Automation 2019.11

waiting for RPA Central to initiate the connection.


If you configured the RAS to initiate connection with Central (Standard RAS), then there is no need to register the
RAS.
You cannot connect a reverse RAS to more than one Central.
Reversing the Direction of the RAS - Central Communication
If you want to reverse the direction of the communication between the RAS and the RPA Central, this can be done
manually, in the configuration files.
Assigning RPA Central Workers to Groups
A worker group is a logical collection of RPA Central workers. Having a group, rather than a single worker, enables
workers to withstand a high action execution load and increases availability of workers in a data center.
A worker may belong to more than one group simultaneously.
Under the Topology > Workers tab, you can assign workers to worker groups, remove workers from groups,
enable, disable, or delete workers.
Some execution stages always run on the default group, which is RAS_Operator_Path. Therefore, make sure that
at least one worker is assigned to this group.
It is recommended to assign most (or even all) workers to RAS_Operator_Path, in order to optimize the execution
time. You should only exclude a RAS from this group if you want to minimize its usage, and if you have only few
operations that use it.

Reference material

Topology > Workers

GUI item Description

Add Reverse RAS Click to create a new reverse RAS connection. You must do this for each reverse RAS
that you installed (those that were configured to accept connection from RPA Central).

button

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 399
Robotic Process Automation 2019.11

GUI item Description

Edit Reverse RAS Click to modify the connection details of the selected reverse RAS.

button

Click to enable the selected worker/RAS. The Enable button is only available if at least
one disabled worker/RAS is selected.
Enable button

Disable button Click to disable the selected worker/RAS. The Disable button is only available if at least
one enabled worker/RAS is selected.

Click to delete the selected worker/RAS. The Delete button is only available if at least
one worker/RAS is selected and if the selected worker/RAS is not currently running.
Delete button

Refresh button Click to refresh the display of workers/RASes.

Clear Filters button Click to remove the filters and display all the workers/RASes.

Select Columns Click to display the column picker, to choose which columns to display.

button

Assign to Group Click to display the Assign to Group pop-up menu.


button

Filter boxes In the filter boxes at the top of the columns, enter text to filter the displayed
workers/RASes.

Host Name The name of the host where this worker/RAS is located.

Enabled Whether the worker/RAS is enabled or disabled.

Availability Whether the worker/RAS is online or offline.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 400
Robotic Process Automation 2019.11

GUI item Description

Execution Status Displays information about the resource consumption of the worker/RAS. The
information about resource consumption is automatically refreshed periodically. Take
into account that the displayed information is only relevant to the last few minutes,
since the previous refresh, and is not cumulative. In order to properly understand what
is happening in your environment, it is recommended to observe the statuses over a
period of time.
• Idle: This worker/RAS has almost no tasks to process.
• Low Utilization: This worker/RAS is working at low utilization. If your workers/RASes
are with idle/low utilization for a long while, consider removing them.
• Working: This worker/RAS is working with a regular load.
• Pending on RPA Central: Most of the time, this worker/RAS is waiting to send
execution results to Central. Central is busy with handling other tasks. Consider adding
more Centrals, or monitor your database for space, connectivity, and so on, to make
sure it is not the bottle neck.
• Loaded: At the current time, this worker/RAS is not able to process all RPA Central
tasks. If a worker/RAS is in a loaded state for a long time, consider scaling out or scaling
up by adding more worker threads.

Path The path to the host where this worker is located. The path indicates if the worker is in
RPA Central or in a RAS.

OS The operating system of the machine where this worker/RAS is located.

JDK The JDK version that is installed on the worker/RAS machine.

.NET The .NET version that is installed on the worker/RAS machine.

ID The UUID (unique identifier) of the worker/RAS.

Groups The worker groups to which the selected worker/RAS is assigned.

Type Whether the item is a RPA Central worker, a standard RAS, or a reverse RAS.

Central worker • Central workers are responsible for executing flows. An


external worker connects to RPA Central to obtain tasks (flow
execution messages) to process. It can be assigned to a worker
group.

Standard RAS An RPA RAS is a remote action server, containing a worker and
a remote protocol for connecting with RPA Central. A standard
RPA RAS will initiate the connection to RPA Central.

Reverse RAS A reverse RPA RAS will wait for RPA Central to initiate the
connection.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 401
Robotic Process Automation 2019.11

GUI item Description

Connecting RPA For a reverse RAS only: The host name of the RPA Central that connects to the
Central reverse RPA RAS.

Connect Reverse RAS dialog box

GUI item Description

RAS host name/IP Enter the name or IP of the RPA RAS (mandatory).

Port Enter the port of the RPA RAS (mandatory).

Protocol Enter whether the protocol is HTTP or HTTPS.

Share secret to connect Enter the shared secret that was entered in the installation wizard when this RPA
RAS was installed (mandatory).

Test It is recommended to test the connection before submitting.

Topology > Workers > Assign to Group pop-up

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 402
Robotic Process Automation 2019.11

GUI item Description

Assign to Group Click the button to display the Assign to Group pop-up menu.

Add New Group Select the check box and enter the name of a new group, to which the selected worker will
be assigned.

<Worker groups> Select the check boxes next to group names to assign the selected worker to these
groups. The display in the dialog box will vary, depending on the groups that have been
set up.

Apply Click to apply the changes to the worker.

Cancel Click to close the Assign to Group pop-up without saving the changes.

Register a new reverse RAS


For each reverse RAS that you installed (those that were configured to accept connection from RPA Central), you
must configure RPA Central to register the RAS. Until you do this, the RAS will be idle, waiting for RPA Central to
initiate the connection.

1. Click the System Configuration button to display the System Configuration workspace.

2. Select Topology > Workers.

3. Click Add Reverse RAS.

4. In the dialog box, enter the RAS connection details: host name or IP, port, and protocol.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 403
Robotic Process Automation 2019.11

5. Enter the shared secret, which was entered when the reverse RAS was installed.

6. Click Test.

If you encounter an error, adjust the details and try again.

7. Click Save.

RPA Central initializes the connection and the connection remains active. If the connection becomes disconnected,
RPA Central will try to reconnect at specified intervals.
The new reverse RAS appears in the table below.

Move a reverse RAS to a different port or IP address


1. Select Topology > Workers.

2. Select the reverse RAS you want to move.

3. Click .

4. In the dialog box, change the reverse RAS connection details: host name or IP, port, and protocol.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 404
Robotic Process Automation 2019.11

5. Click Test.

If you encounter an error, adjust the details and try again.

6. Click Save.

The new reverse RAS appears in the table below.

Assign a RPA Central worker to an existing worker


group
1. Select Topology > Workers.

2. Select the check box next to the worker name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 405
Robotic Process Automation 2019.11

3. Click the Assign to Group button.

4. Select the check boxes next to the worker groups that you want to assign this worker to.

5. Click Apply.

Create a new worker group and assign a RPA Central


worker to it
1. Select Topology > Workers.

2. Select the check box next to the worker name.

3. Click the Assign to Group button.

4. Click the check box next to the empty box and enter the name of the new worker group that you want to
create.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 406
Robotic Process Automation 2019.11

5. Click Apply.

Remove an RPA Central worker from the a worker


group
1. Select Topology > Workers.

2. Select the check box next to the worker name.

3. Click the Assign to Group button.

4. Clear the check boxes next to the worker groups that you want to remove this worker from.

5. Click Apply.

Disable a worker/RAS
1. Select Content Management > Topology > Workers.

2. Select the check box next to the worker name.

3. In the Workers toolbar, click Disable .

Note The Disable button is only available if at least one enabled worker is
selected.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 407
Robotic Process Automation 2019.11

Enable a worker/RAS
1. Select Topology > Workers.

2. Select the check box next to the name of the disabled worker.

3. In the Workers toolbar, click Enable .

Note The Enable button is only available if at least one disabled worker is
selected.

Delete a RAS
You can delete a RAS only if it is stopped.
It is not possible to delete an internal worker, which is within RPA Central.
If you have stopped a RAS service (or even uninstalled the RAS), it takes a few minutes until this is reflected in the
Topology>Workers tab. You may need to wait for a few minutes before that status is updated to Stopped before
you can delete the RAS. There is no need to restart RPA Central.

1. Select Topology > Workers.

2. Select the check box next to the worker name.

3. In the Workers toolbar, click Delete .

Note The Delete button is only available if at least one worker is selected
and if the selected worker is not currently running.

Verify that a component (RAS or cluster node) was successfully installed


You can use the Topology/Workers tab to verify that a component was successfully installed.
If a worker is successfully installed, it will be visible in the grid and shown to be online and it's Availability column
will display Online.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 408
Robotic Process Automation 2019.11

If a new component for RPA Central was installed successfully it will appear on the screen. If there is no addition
on the Topology/Workers screen after the component was installed, this means that there was a problem and
you should inspect the logs.
The Topology/Workers screen displays the status of the worker, so you can see if the new component is viable.

For example, the status will be red (unusable) if there are problems with certificates, failures in the operation of
the worker unrelated to the initial installation, or loss of network connectivity with the component.

All workers display their host name and type. So the Topology/Workers screen can be used to verify any load
balancer configuration issues.

For example, if there are three RPA Centrals in the topology and only two in the load balancer, there is a clear
configuration issue within the environment.

Related topics
For instructions to install RPA RAS, see Install RPA RAS.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 409
Robotic Process Automation 2019.11

Set up topology for RPA Robot

To establish communication with RPA Robot, you must have configured RPA Central with a relevant
external URL of RPA Robot during installation.

View RPA Robot topology


To view the details of configured RPA Robot with RPA Central, complete the following steps:

1. Click the System Configuration button to display the System Configuration tab.

2. Select TOPOLOGY>Robots.

The Robot topology view is read-only. Delete of a Robot is not supported.

GUI item Description

HOSTNAME Displays the URL of the RPA Robot (FQDN path).

AVAILABILITY Displays the available status of RPA Robot such as Offline or Online.

ROBOT STATUS Displays the activity status of RPA Robot such as: Not launched, Ready, Busy, Running,
Recording, Waiting, Paused, and Unknown. The execution status is not updated in case Robot
is offline.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 410
Robotic Process Automation 2019.11

GUI item Description

OS Displays the Operating System on which the RPA Robot is installed.

GROUPS Displays the group to which the RPA Robot belongs to. It is currently set to Default group.

The update of RPA Robot skills from the RPA Central is not supported yet.

Related topics
For details on configuring RPA Robot with RPA Central during installation, see Install RPA Central

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 411
Robotic Process Automation 2019.11

Set up an automatic RPA RAS upgrade

Your RPA Centrals and RASes must be the same version. RPA Central will only assign jobs to RASes that are of
the same version.
Robotic Process Automation supports the automatic upgrade of RASes from RPA Central for some versions without
manual intervention and without needing to access the RAS machines physically.
Automatic RAS upgrade is useful for customers with a large number of RASes in their environment, or with RASes
in different time zones, making manual upgrading difficult.
Before the RPA RAS upgrade, it is recommended to read the below table:
RAS upgrade compatibility matrix

RPA Version Target RPA Version

2019.07 2019.11

2019.07 NA A

2019.11 NA NA

Legend:

Item Description

A Automatic upgrade

NA Not Applicable

The RAS Upgrade tab is only visible if you have been assigned a role with the Manage Topology or View
Topology permission.
There are four steps that you need to complete in order to upgrade your RASes using Automatic RAS Upgrade:

1. Upload the RAS-Upgrade.zip file to Central. This is a zip file containing the files that are required to
upgrade the RASes to the relevant version. You can download the RAS-Upgrade.zip file from the same
location where you download the new RPA installation. Then, you upload the file to the Central database.

2. Prepare the RASes for upgrade. In this step, the RAS automatically runs a set of preparations, to ensure
that the upgrade will be successful. This step runs pre-checks to verify that there are no problems in each
RAS environment, and prepares those environments for upgrade. The RASes then download the upgrade
package from RPA Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 412
Robotic Process Automation 2019.11

a. To start the preparation process, you need to manually select the required RASes from the grid and

click the Prepare for Upgrade button.

During the preparation process, each RAS displays its status in the RAS grid. At the end, it displays
whether the process was successful.

If a RAS encounters a problem, the details are displayed on the RAS grid. You need to fix the problem
before upgrading that RAS. Examples of problems might be:

Insufficient disk space. The RAS upgrade file may require up to 2 GB.

Missing OS permissions (administrator permissions).

Another RPA component (RPA Central or RPA Workflow Designer) is installed alongside the RAS in the
same RPA installation directory. This kind of setup is not supported by this feature, and will require a
manual upgrade.

Problems where you need to check in the logs for more information.

b. Once you have fixed the problems, you should run the preparation process again. This process can be
repeated multiple times.

During the first two steps, you can use the RASes as usual. There is no need to schedule downtime.

The RAS-Upgrade.zip file is signed and verified before uploading and also after downloading. If
packages are lost, the download will fail, so if this occurs, the download should be restarted.

When RAS transfers the RAS-Upgrade.zip file, this is done by streaming very small packets. This
means that it can be sent to multiple RASes simultaneously, while taking up only minimal resources.
This also means that if the download fails, on retry, it will start from where it failed, so the packets that
were transferred successfully don't need to be transferred again.

3. Upgrade Central. The next step is to upgrade your environment, by upgrading Central to the new version
manually.

4. Upgrade the RASes. After Central is upgraded, you need to upgrade your RASes to the same version.

Important The versions of RPA Central and the RASes must be aligned.
RASes with older versions will not be able to run flows.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 413
Robotic Process Automation 2019.11

In the RAS grid, the Version column displays the version of each RAS. Check this column to see if your RASes
are aligned with the RPA Central version.

A RAS can only be upgraded if the preparation was successful, and its Upgrade State shows as Ready for
upgrade.

To start the upgrade process, you need to manually select the required RASes and click the Upgrade Now

button.

During this process, each RAS runs the upgrade batch file, which is located in the Upgrade-RAS.zip file.

When the process ends, the Upgrade State column in the RAS grid shows whether the upgrade was
successful. Each RAS that was successfully upgraded restarts and reports to Central that it is up in a new
version.

The first two steps should be performed before the Central upgrade. This minimizes downtime and enables you to
fix any issues that may be encountered, before the upgrade.

Upload the upgrade file to RPA Central

This preparatory step should be completed before RPA Central is upgraded.

1. Get a local copy of the RAS-Upgrade.zip file for the new version. You can do one of the following:

Go to the Software Licenses and Downloads Portal and download the RAS-Upgrade.zip file and save it to
your local file system.
Go to the Software Licenses and Downloads Portal and download the complete RPA Central
upgrade/installation package for the new version, and save it to your local file system.

2. Click the System Configuration button.

3. Select Topology > RAS Upgrade.

4. Click the Upload button.

5. In the Upload File dialog box, click Browse to navigate to the RAS-Upgrade.zip file, in the location where
you saved it. You must make sure to upload the RAS-Upgrade.zip file, and not the full upgrade package.

6. Click OK to upload the upgrade file to RPA Central. RPA Central performs validations (for example, verifies the
digital signature of the upgrade file), and receives the upgrade file.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 414
Robotic Process Automation 2019.11

Prepare the RASes for upgrade

This step prepares the environment for upgrade by running pre-checks on the RASes, checking for disk space,
permissions, and so on, and downloading the upgrader package to the RASes. The preparation is done in the
background, and doesn’t interrupt the routine work of your RASes.

1. In the Topology > RAS Upgrade tab, select one or more RASes and click the Prepare for Upgrade
button.

2. Check the status of the RASes, as displayed in the Upgrade State column.

If there are any issues encountered during the download of the upgrader package to any of the RASes, the
details are displayed next to that RAS.

3. If required, fix the problems and click the Prepare for Upgrade button again.

When the checks and download are completed successfully for a RAS, the Upgrade State for that RAS is
updated to Ready for Upgrade. You can prepare RASes for upgrade either before or after you upgrade
Central. you must note that you can only prepare RASes for upgrade if you have uploaded the RAS-
Upgrade.zip file to RPA Central.

Upgrade RPA Central

Upgrade RPA Central to the relevant version, by running the upgrade script.

Upgrade the RPA RASes

This step should be done after RPA Central has been upgraded and after the RASes have been prepared for
upgrade. The RAS can only be upgraded if the preparation was successful, and its Upgrade State shows as
Ready for upgrade.

1. Select Topology > RAS Upgrade.

2. Select the RASes that you want to upgrade (from those that passed the preparation), and click the Upgrade

Now button. This triggers the auto upgrade in the RASes. When you click the Upgrade Now

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 415
Robotic Process Automation 2019.11

button, the RASes perform the prerequisite checks again. This is done because time may have passed since

when you clicked the Prepare for Upgrade button, and the situation may have changed.

3. Follow the Upgrade State to monitor when your RASes have the status of Upgrade succeeded.

Related topics
To set up topology for workers and RPA RAses, see Set up topology for workers and RPA RASes.
To set up topology for RPA Robot, see Set up topology for RPA Robot.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 416
Robotic Process Automation 2019.11

Set up general settings

you can set defaults and customizations, and configure a forward proxy, reverse proxy, or load balancer in the
general system settings (System Configuration > System Settings > General), .
Customize elements of the RPA user interface
You can add extra text to the header title in the top banner in RPA Central, in addition to the default text of
“Robotic Process Automation”.
By adding text, you can make RPA Central look different in different environments, so that users will be able to
identify which environment they are in. For example:

You can add a description of the ROI counter, in the Dashboard, in order to help users understand the meaning of
the ROI values. For example, by entering the words "Total ROI in dollars" or "Total ROI in work days" you can show
users that ROI is calculated in dollars or in work days.

Note The text that you enter as the ROI description overwrites the default title of
"Total ROI". Note also that this text does not get translated if you change the
locale of the browser.

Set default timeout settings for runs You can configure the default timeout settings for the system, so that if a
flow run exceeds the specified duration, it will be canceled and will show the status Canceled-Timeout Expired.

Note The system timeout setting is applied to all flows in the system. However, if
a flow is given a custom timeout setting in the Flow Library, or set to have none,
this will overwrite the default.

Configure the external URL


If you are using a load balancer, reverse proxy, or DNS load balancer, you need to tell RPA where the relevant
external URL is located.
For example, https://my.server.com:443/oo.
If the URL of the load balancer host is not configured, the Run Tree and the Run Log will refer to the IP/host from
the HTTP request.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 417
Robotic Process Automation 2019.11

Compression should not be set on the load balancer configuration. This can affect the connection between RPA
Central and workers and can lead to problems in new worker registration or existing worker functionality.
Configure a forward proxy
If you are using a forward proxy, you need to tell RPA its IP address, port number, username and password.

Reference material

System Settings> General tab

GUI item Description

General Settings

Extra text in the title Enter the extra text to be displayed in the header title after “Robotic
Process Automation”.
The maximum number of characters that can be entered is 30 for Latin
letters and 19 for double-byte letters.

Override ROI description Enter a description of the value that is used to calculate ROI. For
example, "Total ROI in US dollars".

Run Settings

Timeout (minutes) Enter a number larger than 0, to set the number of minutes for the
default timeout setting. A flow run will be canceled if it exceeds this
duration. If nothing is entered, the system timeout is disabled.
Note This value must be an integer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 418
Robotic Process Automation 2019.11

GUI item Description

Enable the rerun option for failed Select or Deselect the check box to enable or disable the rerun
or canceled runs functionality

Set default: Use empty value for Select or Deselect the check box, if you want the default behavior of a
prompts flow run manually to skip the prompts for inputs that are left empty.

Automatically resume 'Paused - No Select or Deselect the check box to enable or disable the auto-resume
Workers in Group' runs paused runs.

External URL

URL Enter the URL of the load balancer, reverse proxy, or DNS load balancer.

Forward Proxy

IP Enter the IP address and port number for the forward proxy.

Username Enter the user name for the forward proxy.

Password Enter the password for the forward proxy.

Add extra text to the header title


1. Click the System Configuration button to display the System Configuration workspace.

2. Select System Settings.

3. In the Extra text in title box, enter the extra text to be displayed in the header title after “Robotic Process
Automation”. The maximum number of characters that can be entered is 30 for Latin letters and 19 for
double-byte letters.

4. Click Save.

Add a description of the ROI counter


1. Click the System Configuration button to display the System Configuration workspace.

2. Select System Settings > General.

3. In the Override ROI description box, enter a description of the value that is used to calculate ROI. For
example, "Total ROI in US dollars".

4. Click Save.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 419
Robotic Process Automation 2019.11

Enable or disable the rerun


1. Select the System Configuration > System Settings tab.

2. In the Run Settings area, select the Enable the rerun option for failed or canceled runs check box.

You can use the Enable the Rerun option for failed or cancelled runs for OO native content packs or
out-of-the-box content packs that has rerun functionality enabled.

3. Reselect the check box to disable the rerun functionality. The rerun icon will no longer appear next to steps
that can be rerun.

Enable/disable auto-resume for 'Paused - No Workers


in Group' runs
a. Select the System Configuration > System Settings tab.

b. In the Run Settings area, select the Automatically resume 'Paused - No Workers in Group'
runs check box and then click Save.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 420
Robotic Process Automation 2019.11

c. To disable the auto-resume paused runs functionality, Re-select the check box and then click Save.

Configure the default timeout settings


a. Click the System Configuration button to display the System Configuration workspace.

b. Select System Settings > General.

c. In the Timeout (minutes) box, enter a number larger than 0, to set the number of minutes for the
default timeout setting. A flow run will be canceled if it exceeds this duration.

Note This value must be an integer.

d. Click Save.

Configure a external URL for a load balancer, reverse


proxy, or DNS load balancer
a. Click the System Configuration button to display the System Configuration workspace.

b. Select System Settings > General.

c. In the URL box, enter the URL of the load balancer, reverse proxy, or DNS load balancer.

d. Click Save.

Configure a forward proxy


a. Click the System Configuration button to display the System Configuration workspace.

b. Select System Settings > General.

c. Enter the IP address, host number, username, and password for the forward proxy.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 421
Robotic Process Automation 2019.11

d. Click Save.

Related topics
To manage flow library, see Manage the flow library.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 422
Robotic Process Automation 2019.11

Set up the system settings for licensing

When you install RPA, this installs the trial version license. Install a commercial license within 60 days.

You can view the license information by clicking the Info button in the top right corner, to display the About
popup window. This window displays the current status of the license: if the license is limited in time or number of
runs, it shows how much is left.
If you try to run flows after the license has expired, an error message appears, suggesting that you install a
commercial license.
You can also view details about the current license in the License tab under System Configuration> System
Settings.
You can also see the remaining days/runs in the banner that appears at the top of all the RPA Central windows.
You can click this banner from any location in RPA Central, to open the License tab.

Acquire a license
To acquire an RPA license:

Download the license from the Micro Focus web site at

https://www.microfocus.com/licensing

For more information about licensing details, contact your Sales team or Account Manager.

Install a license
1. Acquire the relevant license, as described above.

2. In RPA Central, click the System Configuration button to display the System Configuration workspace.

Important If you are working with a cluster, make sure that the open RPA
Central is at the IP address for which the license was issued.

3. Go to SYSTEM SETTINGS>License tab. The method to acquire license and the remaining trial days is
displayed.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 423
Robotic Process Automation 2019.11

4. In the AutoPass License Server section, fill the following fields

a. Enter the URL details of the AutoPass server in the following format: https://FQDN:<port>/autopass

b. Enter your Username and Password credentials of the Autopass Integration account.

5. Click Save. The applied license and license details are displayed.

License management
For a cluster, you chose one of the nodes and issued a license for the IP address of this node.

Make sure that you are working from the RPA Central at the IP address that was specified when you issued
the license.
Make sure that you are not working from the Load Balancer IP.
If you have RPA cluster, you issue one license for a selected node.

Make sure that you are working from the RPA Central at the IP address that was specified when you issued
the license.
Make sure that you are not working from the Load Balancer IP.
Make sure that you selected the license for the RPA IP.

Related topics
For information on setting defaults, customization's, forward and reverse proxy, and load balancer, see Set up
general settings
For information on monitoring and controlling database size, see Monitor and control database size

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 424
Robotic Process Automation 2019.11

Monitor and control database size

It is possible to monitor and control the size of your database, in order to enhance performance.
Under the Database Health tab in the System Configuration workspace, you can:

Monitor the size of your database over different periods of time, and see how data is divided between execution,
debugger and auditing usage.
See information about how to schedule purging flows, in order to reduce the database size.
Set the default level of information that is persisted in the Run Log. Reducing this level can help reduce the
database size.

Monitor the Database Size


In the Database Size section, you can monitor the size of your database, comparing the current size to the size
that it was in the past. You can adjust the graph to display the database size over the past month, quarter, half
year, year, or total time. You can also see how the data is divided between execution, debugger and auditing
usage.
The graph is updated approximately every 24 hours from the time RPA Central was first up. For example, if you run
a purging flow to reduce the database size, the updated size will be displayed on the following day.
The RPA Database Consumption section displays information about how to schedule purging flows, in order to
reduce the size of the database. It is highly recommended to follow the described steps to deploy the RPA Micro
Focus Solutions content pack and run the purging flows.

A Help button is available, which you can click to see more information about scheduling purging flows.
It is important that you should schedule the Purge Execution Summary flow before you start to run flows in RPA
Central. This will help reduce the size of the database and thus enhance the performance of RPA.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 425
Robotic Process Automation 2019.11

The Step Persistence type selected for a step in a flow (Concise or Detailed) also affects the database size.

Default persistence level for the run log


A detailed run history is saved to the database. This makes it easy to troubleshoot, as all the information is
available in the Run Log. However, you may want to reduce the level of information that is persisted. For example,
if your database size has increased to the limit or if some of the persisted data is not relevant for you.
By selecting the default persistence level, you can control the level of detail that is saved to the Run Log. You can
choose between:

1. Extended - large input/output values are not truncated when persisted.

2. Standard - when persisted, large input/output values are truncated when they exceed the truncation
threshold (in English, 4,000 bytes) in UTF-8 encoding.

Note The default persistence level is Standard

The top-level inputs and outputs of the launched flow are always logged with
their full values (even at Standard level).

The default persistence level is applied to all flows that are run. You can override this default for individual flows in
the flow library, or when triggering or scheduling a flow run.
All runs started from the Remote Debugger have the Extended persistence level.

How values are truncated at standard level


At Standard level, large input/output values are truncated when they exceed the truncation threshold in UTF-8
encoding. For English letters and symbols, this is 4000 bytes, but for other collations it may vary from 1000 to
4000 bytes (3000, in most cases).
This translates to:

1. 4,000 ASCII characters

2. 2,000 Latin-based characters (non-ASCII)

3. 1,333 common CJK characters (Chinese, Japanese and Korean)

4. 1,000 rare CJK characters and symbols

If the value combines different types of characters, the truncation threshold will be somewhere in between the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 426
Robotic Process Automation 2019.11

above numbers. For example, Latin-based languages use a lot of ASCII characters, so the truncation point for such
texts can be anywhere between 2,000 and 4,000 characters (typically over 3,000).
When the value is truncated, a “(truncated)” suffix is added to the stored value, so there are 3,985 bytes of actual
content (instead of 4,000).

Reference material

Database health tab

GUI item Description

Run Log Select the default level of detail that will be saved to the Run Log when a flow is run:
Persistence Level •
Standard - large input/output values are truncated at approximately 4,000 bytes when
persisted

Extended - large input/output values are not truncated when persisted
The top-level inputs and outputs of the launched flow are always logged with their full
values (even at Standard level).

RPA Database See a graph showing the database size in MB, over a period of time, ending with the
Consumption current date. Select the options to change the displayed time period.
If required, click the arrows to display areas of the graph that are hidden.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 427
Robotic Process Automation 2019.11

GUI item Description

Legend blocks

Click the Legend blocks


under the graph to filter the display, in order to hide/show the execution, debugger, and
auditing data.

5 Steps to Control View the steps describing how to deploy the Micro Focus Solutions content pack and
Database Size run the purging flows.

Set the persistence level for the run Log


1. Click the System Configuration button to display the System Configuration workspace, and select the
Database Health tab.

2. Select one of the options from the Default persistence level list:

Extended - large input/output values are not truncated when persisted


Standard - when persisted, large input/output values are truncated when they exceed the truncation
threshold (in English, 4,000 bytes) in UTF-8 encoding.

This default level will be applied to all flows that are run. You can override this default for individual flows or folders
in the flow library, or when triggering or scheduling a flow run.

Overwrite the persistence level for the run Log


It is possible to overwrite the default persistence level that is set on the Database Health tab, in the following
places:

Flow Library - You can set the persistence level for individual flows in the Flow Library.
Flow Launcher - You can set the persistence level for a specific flow, when triggering a run. By default, the
persistence level is taken from the system configuration (first) and the Flow Library (second).
Scheduler - You can set the persistence level for the specific scheduler configuration. By default, the
persistence level is taken from the system configuration (first) and the Flow Library (second).

Monitor the size of your database


1. Click the System Configuration button to display the System Configuration workspace, and select the
Database Health tab.

2. Under RPA Database Consumption, select one of the options to display the database size (in MB) over the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 428
Robotic Process Automation 2019.11

past month, quarter, half year, year, or total time.

3. If required, click the arrows to display areas of the graph that are hidden.

4. Click the Legend blocks under the graph to filter the display, in order to hide/show the execution, debugger,
and auditing and rerun data.

Control the size of your database


It is strongly recommended to schedule the purging flows, in order to control the size of the RPA database and
enhance the performance of RPA.
Ensure to schedule the Purge Execution Summary flow before you start to run flows in RPA Central
For each purge type (rerun, steplog, and so on), you can only run one purge flow at a time.

1. Download the Micro Focus Solutions content pack from ITOM Marketplace.

2. Deploy this content pack to RPA Central.

a. Open the Content Packs tab in Content Management and click the Deploy New Content button.

b. In the Deploy New Content dialog box, click the Add button.

c. Browse to and select the Solutions content pack, and then click Open.

3. Open the Flow Library tab in Content Management and locate the purging flows, under Integrations/Micro
Focus/Robotic Process Automation/10.x/Database.

4. Open the Scheduler tab in Run Management.

5. Create schedules to run the following flows on a regular basis:

Purge Execution Summary - recommended for all users

Purge Debug Events - if you use the RPA Workflow Designer Remote Debugger

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 429
Robotic Process Automation 2019.11

Purge Audit Records - if you have enabled security auditing


Purge Rerun Info - if you have defined rerun points

Related topics
To manage flow library, see Manage the flow library
To run a flow, see Run a flow
To schedule flow runs, see Schedule flow runs
To deploy and manage content packs, see Deploy and manage content packs

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 430
Robotic Process Automation 2019.11

Control database size by purging


It is highly recommended to schedule the purging flows, in order to control the size of the Robotic Process
Automation database and enhance the performance of Robotic Process Automation.

Make sure to schedule the Purge Execution Summary flow before you start to
run flows in RPA Central.

1. Download the Micro Focus Solutions content pack from ITOM Marketplace.

2. Deploy this content pack to RPA Central.

a. Open the Content Packs tab in Content Management and click the Deploy New Content button.

b. In the Deploy New Content dialog box, click the Add button.

c. Browse to and select the Solutions content pack, and then click Open.

3. Open the Flow Library tab in Content Management and locate the purging flows, under Integrations/Micro
Focus/Operations Orchestration/10.x/Database.

4. Open the Scheduler tab in the Run Management workspace.

5. Create schedules to run the following flows on a regular basis:

Purge Execution Summary - recommended for all users

Purge Audit Records - if you have enabled security auditing


Purge Rerun Info - if you have defined rerun points

Related topics
To deploy and manage content packs, see Deploy and manage content packs
To schedule flow runs, see Schedule flow runs

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 431
Robotic Process Automation 2019.11

Send email notifications


You can notify Robotic Process Automation (RPA) users about system events through email messages. Notifications
cannot be sent if you are using a trial license. By default, no notifications are sent.
RPA supports the following types of events:

Authentication was disabled


Flow running for more than a specified threshold
You need to configure a mail server and the notifications that you want to receive using the System Notifications
screen. To configure notifications:

1. Click System Configuration > System Notifications.

2. In the Host field, enter the host name of the email server host.

3. In the Port field, enter the port number of the email server port.

4. In the Username field, enter the name of the

5. In the Password field,

6. In the From field, enter the name of the person from whom the email message is sent.

7. In the To field, enter the names of RPA users who must receive the notifications.

8. From the Notifications area, select the notifications for which emails must be sent.

Depending on the type of notification you selected, emails are sent to all users specified in the To field
if authentication is disabled or if a flow runs longer than a specified threshold.

Related topics
To customize email notifications, see Customize email notifications.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 432
Robotic Process Automation 2019.11

Customize email notifications


You can customize the email notifications that you can send by creating your own email templates. Email
templates are located in the central/conf/notifications folder. For the "Authentication was disabled" event, you
have to customize the authenticationDisabled#$filename| file and for the "Flow running for more than a
specified threshold" event, you must customize the runningTimeExceeded#$filename| file.

Create email templates


1. Open the authenticationDisabled#$filename| or the runningTimeExceeded#$filename| file depending
on which email notification you want to customize.

2. Insert the following values:

Variable Description

${url} URL of the Central installation

${id} ID of the execution

${name} Name of the execution

${flow} Path of the running flow

${count} Number of hours for which the execution is running

3. You can also include images in your templates. These images must be located in a directory with the same
file name as that of the template (that is, authenticationDisabled, runningTimeExceeded). Images are
included in the template by reference.

For example, if you have an image named image01.png in the authenticationDisabled directory, you can
reference it in the authenticationDisabled#$filename| template as
<img src="2018.02/Use/Using_RPA_Central/cid:image01"/>

Configure the resend interval


Email notifications about flows running for more than a specified threshold are resent once in 24 hours by default.
You can configure the resend interval by changing the value of the runningTimeExceede.repeat.interval
configuration item.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 433
Robotic Process Automation 2019.11

Related topics
To send email notifications, see Send email notifications.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 434
Robotic Process Automation 2019.11

Set the browser language


RPA Central language support is according to the browser language. If the language is not supported, RPA Central
is displayed in English.
Set up your browser for foreign language support.

Note Make sure that the added language is the first in the list.

Change the language preferences on Internet Explorer


1. Go to Tools > Internet Options > General (tab) > Languages > Language preference.

2. Select the required language. Make sure the primary language is the first in the list.

Change the language preferences on Firefox


1. Go to Tools > Options, Content (tab) > Languages > Choose (button).

2. Select the required language.

Change the language preferences on Google Chrome


1. Click the Customize and control Google Chrome button, and then select Settings > Show advanced
settings.

2. In the Languages section, click Language and input settings.

3. Click Add, and select the required language.

You can add languages to this from a predefined set, and Chrome will send all the languages you choose with
the Accept-Language header in the order in which you arrange them.

Change the language preferences on Safari


In Windows, you can't change the language sent by Safari. The language sent with the Accept-Language header is
derived from your system settings.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 435
Robotic Process Automation 2019.11

Note It is also possible to change the MS SQL collation language or the central-
wrapper.conf language for content.

Related topics
To enable authentication to users, see Enable authentication
To enable auditing of events, see Enable auditing

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 436
Robotic Process Automation 2019.11

Enable authentication

The Enable Authentication check box is available under the Security tab. You can use this to enable or
disable the authentication functionality in RPA Central. If authentication is not enabled, all users will be able to
access all tasks.

Only users with administrator credentials can enable authentication in RPA Central. This is to prevent a user from
becoming locked out of the system.
The Enable Authentication check box is only available if there are existing internal or LDAP users with
permission to disable the authentication in the future.

Enable authentication
1. Click the System Configuration button to display the System Configuration workspace.

2. Select the Security tab.

3. Select the Enable Authentication check box to display the Enable Authentication dialog box.

4. In the Enable Authentication dialog box, enter your administrator user name and password, and click OK.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 437
Robotic Process Automation 2019.11

If a choice of LDAP domains has


been set up, you will also need to select the domain for the authentication.

GUI item Description

User Name Enter your administrator user name.


Note If a choice of LDAP domains has been set up, you will also need to select the domain
for the authentication.

Password Enter your administrator password.

OK Click to save the credentials and enable the authentication.

Disable authentication
1. If the authentication functionality has been enabled, clear the Enable Authentication check box.

2. In the confirmation dialog box, click OK.

Related topics
To enable auditing of events, see Enable auditing.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 438
Robotic Process Automation 2019.11

Enable auditing
RPA gives you the option to audit events, so that you can track security breaches. Auditing lets you track actions
that took place on RPA Central, such as logins, triggering flows, creating schedules, editing configurations, and so
on.
The Enable Audit check box is available under the Security tab. You can use this to enable or disable the
auditing functionality in RPA Central.
Once auditing has been enabled, a user who has been granted View Audit permission can retrieve an audit trail.

By default, the Enable Audit check box is not selected.


Audit events are persisted in the database.
Only users with Manage Security Configuration permission can enable auditing in Central.
Currently, it is only possible to retrieve an audit trail via APIs.

Enable auditing
1. Click the System Configuration button to display the System Configuration workspace.

2. Select the Security tab.

3. Select the Enable Audit check box.

Disable auditing
1. If the auditing functionality has been enabled, clear the Enable Audit check box.

2. In the confirmation dialog box, click OK.

Related topics
To enable authentication to users, see Enable authentication

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 439
Robotic Process Automation 2019.11

Set up security for RPA Central


Security requirements for the enterprise are constantly evolving and this section should be viewed as Micro Focus's
best effort to meet those stringent requirements. If there are additional security requirements that are not covered
by this section, you can open a support case with the Micro Focus support team to document them and we will
include them in future editions of this section.
This section is designed to help IT professionals who deploy and manage Robotic Process Automation (RPA)
instances in a secure manner. The objective is to help you make well-informed decisions about the various
capabilities and features that RPA provides to meet modern enterprise security needs.
This section provides an overview of the security models and recommendations for a secure implementation of
Robotic Process Automation (RPA). This includes subjects such as authentication, authorization, encryption, and
more. Where relevant, there are references to other RPA topics, which describe how to complete security-related
tasks.

Security concepts
Secure implementation and deployment
Secure installation guidelines
Network and communication security
Administration interface security
User management and authentication
Authorization
Configure RPA Central in IDM mode
Configure LDAP in IDM mode
Backup
Encryption

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 440
Robotic Process Automation 2019.11

Security concepts
Before attempting to secure your RPA system, it is recommended to understand the security concepts as described
in the following table:

Term Description

Role Permission A permission is a predefined authorization to perform a task. RPA Central includes a set
of permissions that can be assigned to roles.
For example, the Schedule permission grants the ability to view and create run
schedules.

Role A role is a collection of permissions. For example, the Flow Administrator role may be
assigned the View Schedules permission and the Manage Schedules permission.

User A user is an object associated with a person (or application identity) representing the
person and defining their authorization. Roles are assigned to users, to define the actions
they are authorized to perform in Central. For example, the user Joe Smith may be
assigned the Flow Administrator role.
It is possible to configure different kinds of users:
• LDAP users log on to Central using their LDAP user name and password. For example,
using their Active Directory user name and password.
• Internal users log on to Central using the user name and password that was set up
locally in Central.
• LWSSO - Lightweight Single Sign On (SSO) is a mechanism in which a single action of
user authentication and authorization can permit a user to access all systems that
support LWSSO. For example, if users have logged onto another product web client that
has LWSSO enabled, they can enter the RPA Central application directly, bypassing the
RPA Central logon screen.
When an internal user and an LDAP user with the same role are logged in, there is no
difference between their permissions.
Note It is recommended to use LDAP users rather than internal users, because LDAP
users are secured according to policies implemented by the LDAP provider.

Content Permission Content permission is permission to view or run individual flows or the flows in a
particular folder.
Users who have been assigned a specified role will be able to access the flows according
to the content permissions assigned to their role.
For example, users with the Administrator role may be entitled to view and run all the
flows in the system, while users with the User role may be entitled to run certain flows,
and have view permission for others.

Common Security Concepts

System Security The processes and mechanisms by which computer-based equipment, information, and
services are protected from unintended or unauthorized access, change, or damage.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 441
Robotic Process Automation 2019.11

Term Description

Least Privilege The practice of limiting access to the minimal level that will allow normal functioning.
This means giving a user account only those privileges that are essential to that user's
work.

Authentication The process of identifying an individual, usually based on a user name and password, or
certificate.

Authorization Permission to access system objects, based on an individual's identity.

Encryption A way to enhance the security of a message or file by scrambling the contents so that it
can be read only by someone who has the right encryption key to encode it. For
example, the TLS protocol encrypts the communication data.

Countermeasure A way to mitigate the risk of a threat.

Defense in Depth Layers of protection, so that you don't have to rely on a single security measure alone.

Risk A possible event that could cause damage. For example, financial loss, damage to the
company image, and so on.

Threat Triggering a risk event that exploits a vulnerability.

Vulnerability A weakness in a target that can potentially be exploited by a security threat.

Related topics
Secure implementation and deployment.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 442
Robotic Process Automation 2019.11

Secure implementation and deployment

RPA security hardening


This section provides recommendations for safeguarding your RPA deployment from security risks or threats. Some
of the most important reasons to secure an application include protecting the confidentiality, integrity, and
availability of an organization's critical information.
To comprehensively protect your RPA system, it is necessary to secure both RPA and the computing environment
(for example, the infrastructure and the operating system) upon which the application runs.
The section also provides recommendations to help secure RPA at the application level and does not cover how to
secure the infrastructure within the customer environment. The customer is solely responsible for understanding
his/her infrastructure/environment and applying the respective hardening policies.

Physical security
It is recommended that RPA is protected by physical security controls defined by your organization. The RPA server
components are installed in a physically secured environment, according to best practice. For example, the server
must be in a closed room with access control.

Related topics
To know about the security concepts of RPA, see Security concepts
To know about supported operating systems and recommended operating system hardening, see Secure
installation guidelines
To know about supported protocol, channel security, RPA RAS security, see Network and communication security

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 443
Robotic Process Automation 2019.11

Secure installation guidelines

Supported Operating Systems


For the types and versions of supported operating systems, see the Support matrix section .

Operating System hardening recommendations


Contact your operating system vendor for recommended best practices for hardening your operating system.
For example:

Patches should be installed


Unnecessary services/software should be removed or disabled
Minimal permissions should be assigned to users
Auditing should be enabled

Tomcat hardening
When you install RPA Central, Tomcat is partially hardened by default. If you want extra hardening, see the
recommendations in the Hardening Robotic Process Automation section.

Installation permissions
The following permissions are required to install and run RPA:

Installing RPA Windows/Linux: Any standard user who is able to run a Java process, and who has permission
to create folders and services

Running RPA • Windows: The Windows service runs as the system user or a specific user (the user must
have access to the RPA installation directory)
• Linux: Any standard user who is able to run a Java process

See also the recommendations in the CIS Apache Tomcat documentation.

Related topics
Support matrix

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 444
Robotic Process Automation 2019.11

Network and communication security

Supported protocols and configuration


RPA supports the TLS protocol.
The RPA Central ports are defined by the administrator during the installation.

Channel security
RPA supports the following secure channels:

Channel (Directed) Supported Secure Protocol

Browser, RPA Workflow Designer For a secure channel, use the TLS communication for encryption and
Remote Debugger, or RAS à Central Client Certificate for authentication.

Central à LDAP Server To encrypt communication between Central and LDAP, use Secure
LDAP, using the TLS protocol.

RPA RAS security


In a topology with a reverse RAS (which waits for RPA Central to initiate the connection), the following mechanism
protects the security of the RPA RAS:

If there are several consecutive failed connection attempts (because the wrong shared secret was entered), this
will result in a delay.

Related topics
For instructions to replace the RPA Central TLS server certificate, see Encrypt the communication using a server
certificate
For setting up Workers and RPA RASes topology, see Set up Topology for Workers and RASes

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 445
Robotic Process Automation 2019.11

Administration interface security

Access the administration interface


There are several ways to control access to the administration interface:

Credentials
Client certificate
SAML

Secure the administration interface recommendations


1. Authentication must be enabled in RPA Central.

2. It is recommended to secure the administration interface with the TLS protocol. You should set up TLS
between the client and the RPA Central interface for encryption.

3. It is recommended to work with LDAP users, rather than internal users, because this is more secure. LDAP
users should be defined with a strong password policy.

4. It is recommended to set up authentication to access RPA Central via Client Certificates. This is more secure
than user passwords.

Related topics
Work with server and client certificates
Enable authentication

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 446
Robotic Process Automation 2019.11

User management and authentication

Authentication model
To enable easy bootstrapping of the authentication mechanism in RPA, the product starts with authentication
disabled. You must enable authentication immediately after installation.
There are a number of ways to authenticate access to RPA Central.
Choose the method of identifying users:

User name and password


Client Certificate
SAML token
Single sign on ( LWSSO)
Choose one of two ways to manage the users:

LDAP users, saved on an LDAP server as Active Directory (recommended)


Internal users and passwords, saved locally on the RPA Central server (not recommended)

Types of users
Different types of users can have different permissions assigned for them. For example, flow author, administrator,
system administrator, and so on.

Authentication administration and configuration


The authentication could be for either Internal or LDAP Users
You can set up internal users with passwords in the RPA Central UI or define the user in the LDAP server and map
LDAP groups to RPA Central roles.

Note It is highly recommendation to not use internal users, but to use a more
secure alternative such as LDAP users.

Database authentication
RPA supports four databases: Oracle, MS SQL, MySQL, and PostgreSQL.
We recommend using a strong database password for database authentication and using a strong password policy.
For example, blocking after a number of failed attempts.
When using MS SQL, it is possible to work with either database authentication or with OS authentication. Our

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 447
Robotic Process Automation 2019.11

recommendation is to work with OS authentication, where this is possible. For example, it is possible to use
Windows authentication to access Microsoft SQL Server databases.

Related topics
Enable authentication

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 448
Robotic Process Automation 2019.11

Authorization

Authorization model
User access to RPA resources is authorized based on the user’s role, and the permissions configured for that role.

Minimal permissions guidelines

It is recommended to:

Select appropriate permissions for the role.


Use minimal permissions when creating new roles.
Grant minimal permissions and extend the permissions only as needed to avoid unwanted privilege escalation.
For example, start with View permissions and add additional permissions individually as needed.

Authorization configuration
RPA Central is installed with a number of out-of-the box roles, which you can configure and assign to users. By
default, the out-of-the box roles are assigned the following permissions:

Role Default Permissions

Administrator All

End_user None

Everybody None

Promoter All the Content permissions

System_admin All the System permissions

Default role

It is possible to configure one of the roles with the Default Role attribute. If you do so, make sure that this is the
role with the least privileges. When you give permissions to this role, this affects all LDAP users, in addition to
those are explicitly associated with the role.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 449
Robotic Process Automation 2019.11

Related topics
Set up Security – Roles

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 450
Robotic Process Automation 2019.11

Configure RPA Central in IDM mode


When RPA Central is connected to IDM, authentication is enabled by default at startup. To use RPA Central in the
IDM mode, you must switch from the LWSSO security profile to the IDM security profile.

Switch to the IDM security profile


1. Open the <installation dir>\central\conf\central-wrapper.conf file in a text editor and locate the
wrapper.java.additional parameter called -Doverride.startup.mode under the # Java Additional Parameters
section.

2. Update the value of the -Doverride.startup.mode parameter to IDM. For example:

wrapper.java.additional.33=Doverride.startup.mode=IDM

To switch back to the LWSSO security profile, update the value of the -Doverride.startup.mode parameter to
LWSSO.

3. Save and close the central-wrapper.conf file.

4. Restart the RPA Central service.

Update the IDM properties file


You can configure IDM properties in the <installation dir>\central\conf\idm.properties file. After configuring a
property, save and close the file. Then restart the RPA Central service.
The following table describes the properties in the idm.properties file.

Property Description

idm.configuration.url Represents the URL of the IDM service. For example,


<idm_protocol>://<idm_hostname>:<idm_port>/<idm_service_path>

idm.configuration.username User name of the REST IDM integration

idm.configuration.password Password of the REST IDM integration. This value can be encrypted
using the <installation dir>\central\bin\encrypt-password.bat
tool.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 451
Robotic Process Automation 2019.11

Property Description

idm.configuration.internal.username User name of the internal account (used for PAS authentication and
API calls towards the IDM service). This user has the IDM_ADMIN
permission to be able to perform IDM administration operations for
consumer organizations.

idm.configuration.internal.password Password of the internal account (used for PAS authentication and API
calls towards the IDM service). This value can be encrypted using the
<installation dir>\central\bin\encrypt-password.bat tool.

idm.configuration.scheduler.username User name of the scheduling account used to execute Central flow
schedules.

idm.configuration.scheduler.password Password of the scheduling account used to execute Central flow


schedules. This value can be encrypted using the <installation
dir>\central\bin\encrypt-password.bat tool.

idm.configuration.signing.key Signing key of the IDM configuration

idm.configuration.oo.central.tenant Tenant value of Central configured in the IDM service. The default
value is OO_Central.

idm.configuration.oo.central.return.url Return URL of Central after being redirected from the IDM login page.
For example,
<central_protocol>://<central_hostname>:<central_port>/oo

Configure the return URL of RPA Central in IDM mode

When RPA Central is running in IDM mode, users trying to access RPA Central are first redirected to the IDM login
page to provide their credentials. This return URL is used to redirect the user back to Central's dashboard after a
successful login. The value of the return URL can be configured using the idm.configuration.oo.central.return.url
property in the idm.properties file.

Ensure that the protocol and ports used in the return URL are consistent
throughout the entire login flow. For example, you cannot start the login flow
through HTTP and provide an HTTPS return URL.

Example of the idm.properties file

# IDM Properties idm.configuration.url=https://idm-hostname:8443/idm-service/


idm.configuration.username=idmTransportUser
idm.configuration.password={ENCRYPTED}uNEBrRr29t/78P700j3BiA==
idm.configuration.internal.username=admin
idm.configuration.internal.password={ENCRYPTED}30l15qHg/7770l15qHgP700d2MiA==
idm.configuration.signing.key={ENCRYPTED}uWRUrRQ4BzUNr2EG/4PDfB700j9LiA==
idm.configuration.oo.central.tenant=OO_Central
idm.configuration.oo.central.return.url=https://central-hostname:8433/oo

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 452
Robotic Process Automation 2019.11

Hidden tabs in the IDM mode


RPA authentication allows the RPA administrator to define internal users. However, in the IDM mode, the RPA
administrator cannot define internal users. Therefore, some tabs are hidden when RPA is used in the IDM mode.
The following figure shows the tabs that are hidden in the IDM mode.

Roles in IDM
In the IDM mode, the RPA administrator cannot create additional roles. The administrator can map only existing
roles to groups. Therefore, the Roles tab in the UI displays only the Edit and Clear Filters icons.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 453
Robotic Process Automation 2019.11

Related topics
User management and authentication
Authorization
Configure LDAP in IDM mode

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 454
Robotic Process Automation 2019.11

Configure LDAP in IDM mode


When RPA Central is configure to use IDM for authentication, you can add an LDAP configuration for IDM directly
from RPA Central.
The IDM server will use the LDAP configuration to authenticate and authorize user access to RPA Central. RPA
Central supports a single LDAP configuration for an IDM server.

Add an LDAP configuration for the IDM server


1. Click the System Configuration button to display the System Configuration workspace.

2. Select Security > LDAP.

3. Click Add.
The LDAP tab displays the fields relevant to the LDAP configuration.

4. In the Base DN field, enter the root DNs for fetching users.

5. In the User ID field, enter the distinguished name of a user with search privileges.
It is recommended to provide a privileged user, because some RPA functionality uses searching, for example,
the scheduler. If there is no privileged user, this functionality may not work properly, depending on how the
LDAP is configured.
For example, uid=john,ou=people,dc=devlab,dc=ad
Ensure that you use the exact DN for the user with these privileges.

6. In the Password field, enter the password of the user with search privileges.

7. In the Connections section, select Secured Channel to support secured channel transport.

8. Click Add in the Connections section to add a the connectivity details of the LDAP host.

9. In the Host field, enter the IP address or host name of the LDAP server.

10. In the Port field, enter the port number of the LDAP server. This value must be between 0 and 64435.

11. In the User Name Attribute field, enter the LDAP attribute that contains the user name.

12. In the Common Name field, enter the attribute that defines how the user name will be displayed on the
screen. In most LDAP implementations, cn is the default.

13. In the User Search Base field, enter the root DN for fetching users.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 455
Robotic Process Automation 2019.11

14. In the Users Search Filter field, enter the search filter parameters in order to filter users. This filter will be
applied on the user DN that was entered in the User Search Base field.

15. In the User Email field, enter the LDAP attribute that contains the user email.

16. Select the Users SUB Search Scope check box if you want the users filter to run recursively.

17. In the Group Membership field, enter the LDAP attribute that defines to which groups the user belongs.

18. In the Manager Identifier field, enter the LDAP attribute that identifies the group.

19. In the Manager Identifier Value field, enter the search value for the Manager Identifier field.

20. Click Save to save the configuration.

If the LDAP configuration is not saved, an asterisk appears next to the domain name in the LDAP navigation pane
to the left. If you leave the page before saving, a message appears, warning that there are unsaved changes.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 456
Robotic Process Automation 2019.11

Backup
In order to prevent data loss, It is highly recommended to regularly back up your data on the servers onto secure
media. This is also helpful for disaster recovery and business continuity.
After installing RPA, make sure to back up the central\var\security folder and the
central\conf\database.properties file.
Some data on the database schema is encrypted and the keys for decryption are stored locally on the RPA Central
server. If these system files become corrupted or deleted, the schema will be useless, because there will be no way
to decrypt the data.

Note The keys are encrypted, so it is important to include them in the backup.
The keys are located in the security folder.

Related topics
Back up and recover RPA
Set up disaster recovery

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 457
Robotic Process Automation 2019.11

Encryption

Encryption model
RPA supports encryption and hash algorithms to protect sensitive data. Encryption is designed to prevent the
exposure and modification of sensitive data, such as passwords, definitions, and so on in RPA.
It is important to use well-known, standard algorithms without known vulnerabilities, in order to prevent decryption
by unauthorized persons.
For example, SSL is not used, because of known vulnerabilities in the SSL protocol.

Static data

All saved passwords are protected using well known algorithms and none appear in clear text.
For example:

The system account passwords are encrypted.


The internal user passwords are hashed.
The database passwords are encrypted.

Data in-transit

RPA uses the Transport Layer Security (TLS) protocol to encrypt the data between components (such as RPA
Central and RPA RAS).

Disable the HTTP port

It is recommended to disable the HTTP port, for security reasons, so that the only communication channel will be
on TLS and encrypted.

Encryption administration

Default configuration set

Symmetric-key algorithm: AES with key size 128


Hashing algorithm: SHA1

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 458
Robotic Process Automation 2019.11

Digital certificates
A digital certificate is an electronic "passport" for a person, server, station, and so on.

To use encryption between a browser and the RPA Central server, you need to install a digital certificate on the
server side.
To use Client Certificate to authenticate the RPA Central server, you need to install a Client Certificate on the
client side (for example, on the browser, RAS etc).
RPA uses the Java Keytool utility to manage cryptographic keys and trusted certificates. This utility is included in
the RPA installation folder, in <installation dir>/java/bin/keytool.

Certificate location

Installations of RPA Central include two files for the management of certificates using Keytool:

<installation dir>/central/var/security/client.truststore: Contains the list of trusted certificates


<installation dir>/central/var/security/key.store: Contains the RPA private certificate (including the private
key)
Access Control to KeyStore and TrustStore
It is recommended that the TrustStore and KeyStore are stored with read permissions only for the user that runs
the RPA Central service.

Replace the RPA Self-signed Certificate

It is recommended to replace the RPA self-signed certificate after a new installation of RPA or if your current
certificate has expired.
Part of the process of replacing the certificate is generating a PKCS12 format certificate, using your CA. Contact
your CA for specific details about the certificate process or refer to your corporate policy.

Add digital signatures to a content pack

If a content pack has a digital signature from a trusted CA, this provides assurance that the content is trusted.
Adding a digital signature is not mandatory.

RPA out-of-the-box content packs contain a digital signature from Verisign.


RPA authors are recommended to add a digital signature to their custom content packs.
If a signed content pack is breached, the content pack cannot be deployed.
If the signature is expired, a warning appears before deployment, and the user must select a check box
acknowledging that they are ignoring the expired signature.
Pay attention to content packs that are not signed. An unsigned content pack is not trusted, and could contain
malicious content. Note also that unsigned content pack could be breached and with the signature removed.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 459
Robotic Process Automation 2019.11

Sensitive information in a content pack


System account passwords

Do not include passwords when creating a content pack. The passwords will be obfuscated inside the content pack,
which is not a secure option.
The RPA security best practice is to configure the system account passwords in RPA Central.

Related topics
To change or disable HTTP or HTTPS ports, see Change or disable the HTTP/HTTPS ports
To deploy and manage content packs, see Deploy and manage content packs
To set up configuration items for a content pack, see Set up configuration items for a content pack

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 460
Robotic Process Automation 2019.11

Hardening RPA Central


This section describes how to configure security hardening for Robotic Process Automation (RPA) and has the
following topics:

Hardening recommendation
Working with server and client certificates
Encrypting the communication using a server certificate
Client certificate manual authentication
Configure the TLS protocol
Preventing flows from accessing the Central/RAS local file system
Adding Java security manager
Enable redirection to HTTPS
Disable CSRF protection

Related topics
For information on administering RPA, see Administer

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 461
Robotic Process Automation 2019.11

Hardening recommendation
Following are the security hardening recommendations for RPA Central:

1. Install Robotic Process Automation (RPA).

2. Configure the RPA Central server certificate for TLS encryption and client certificate for strong authentication
(mutual).

This can also be done during installation.

3. For the RPA RAS Debugger provide certificate authentication if required (for the server certificate) and use
the client certificate for authentication against the RPA Central.

4. Harden the RPA Central server by removing the HTTP port and replacing the passwords of the KeyStore and
TrustStore with strong passwords.

5. Remove the RC4 cipher from the SSL-supported ciphers.

6. (Optional) Configure the TLS protocol version.

7. Enable authentication in RPA Central. Internal users are not secured, so use a secured LDAP with a strong
password policy.

8. Harden/secure the operating system and database.

9. Add a security banner with a meaningful message. For example, "You are now logging on to our PRODUCTION
environment! Do not continue unless you are familiar with the governance rules for this system and have
taken the necessary training.

10. In the Windows and SQL server environment, configure RPA to work with Windows authentication.

11. Make sure that auditing is enabled in RPA Central.

Related topics
To install RPA components, see Install
To work with server and client certificates, see Work with server and client certificates

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 462
Robotic Process Automation 2019.11

To change or disable HTTP or HTTPS ports, see Change or disable the HTTP/HTTPS ports
To know more about TrustStore password, see Change, encrypt, and obfuscate the KeyStore TrustStore
password
To remove vulnerable ciphers, see Remove the RC4 cipher from the SSL supported ciphers
To configure TLS protocol, see Configure the TLS protocol
To enable authentication, see Enable authentication
To know more about LDAP authentication, see Set up security – LDAP authentication
To enable auditing, see Enable auditing

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 463
Robotic Process Automation 2019.11

Working with server and client certificates


Transport Layer Security (TLS) certificates digitally bind a cryptographic key to the details of an organization,
enabling secure and encrypted connections from a web server to a browser.
RPA uses the Keytool, which is an open source utility, to manage cryptographic keys and trusted certificates. This
utility is included in the RPA installation folder, in <installation dir>/java/bin/keytool. For more information
about the Keytool utility, see http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/keytool#$filename|.
Installations of RPA Central include two files for the management of certificates:

<installation dir>/central/var/security/client.truststore: Contains the list of trusted certificates.


<installation dir>/central/var/security/key.store: Contains the RPA certificate (private key).
If you use client certificates with LDAP, the LDAP must be configured as default in RPA Central.
Recommendations:

It is recommended to replace the RPA self-signed certificate after a new installation of RPA or if your current
certificate is expired.
It is recommended to store the TrustStore and KeyStore with read permissions only for the user that runs the
RPA Central service.
It is recommended to clear the console after using Keytool or to use the prompt for password inputs.

Related topics
To setup security using LDAP authentication, see Set up security – LDAP authentication

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 464
Robotic Process Automation 2019.11

Encrypting the communication using a server


certificate
This section describes the encryption scenarios.

Replace the Central TLS server certificate


You can use a certificate signed by a well-known certificate authority or a custom server certificate from a local
certificate authority.
Replace the parameters mentioned within "<parameter>" to match the location of the key.store file and other
details on your computer.
The following procedure uses the Keytool utility that is located in <installation dir>/java/bin/keytool.

1. Stop Central and back up the original key.store file, located in <installation dir>/central/var/security.

2. Open a command line in <installation dir>/central/var/security.

3. Delete the existing server certificate from the Central key.store file, using the following command:

keytool -delete -alias tomcat -keystore key.store -storepass <keystore password>

4. If you already have a certificate with a .pfx or .p12 extension, go to the next step. If not, you need to export
the certificate with private key into PKCS12 format (.pfx,.p12). For example, if the certificate format is PEM:

>openssl pkcs12 –export –in <cert.pem> -inkey <.key> -out <certificate name>.p12 –name
<name>

If the certificate format is DER, add the –inform DER parameter after pkcs12.For example:

>openssl pkcs12 –inform DER –export –in <cert.pem> -inkey <.key> -out <certificate name>.p12
–name <name>

To generate the PKCS12 format certificate, you need to use your CA. As this step may vary according to CA
vendor and policy, contact your CA for a detailed explanation of the certificate generation process.

Make a note of the password that you provide. You will need this password for the private key when you input
the KeyStore passphrase later in this procedure.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 465
Robotic Process Automation 2019.11

Make sure to choose a strong password.

5. List the alias for your certificate’s alias, using the following command:

keytool -list -keystore <certificate_name> -v -storetype PKCS12

The certificate alias is displayed and should be provided in the next command.

In the example below, it is the fourth line from the bottom.

6. Import the PKCS12 format server certificate to the Central key.store file using the following command:

keytool -importkeystore -srckeystore <PKCS12 format certificate path> -destkeystore key.store -srcstoretype
pkcs12 -deststoretype JKS -alias <cert alias> -destalias tomcat

7. If the imported server certificate has a different password from the original server certificate, it is important
to change the keyPass password.

It is also recommended to change the default “changeit” password in the automatically generated KeyStore
in the Central server.

8. Start Central.

Import a CA root certificate to the RPA Central


truststore
If you are using a custom root certificate for RPA Central, you will need to import the trusted root certificate
authority (CA) to the client.truststore. If you are using a well known root CA (like Verisign) you do not have to
perform the following procedure, because the certificate will already be in the client.truststore file.
By default, RPA supports all self-signed certificates. However, in a production environment, it is recommended to
change this default to a custom CA or a well-known CA for security reasons.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 466
Robotic Process Automation 2019.11

Replace the parameters as in the below example.

Note The following procedure uses the Keytool utility that is located in
<installation dir>/java/bin/keytool.

1. Stop RPA Central and back up the original client.truststore file, located in <installation
dir>/central/var/security/client.truststore .

2. Import the trusted root certificate authority (CA) to the RPA Central client.truststore file, if it does not
already exist in the CA list (by default, all the CAs are stored here).

keytool -importcert -alias <any_alias> -keystore <path to the client.truststore> -file <certificate_name.cer> -
storepass <changeit>

3. Start RPA Central.

Import a CA root certificate to the RPA RAS TrustStore


After installing a RPA RAS, if you are using a custom root certificate for RPA Central and you didn't provide this root
certificate during the RPA RAS installation, you will need to import the trusted root certificate authority (CA) to the
RPA RAS client.truststore. If you are using a well known root CA (like Verisign) you do not have to perform the
following procedure, because the certificate will already be in the client.truststore file.
By default, RPA supports all self-signed certificates. However, in a production environment, it is recommended to
change this default to a custom CA or a well known CA for security reasons.
Replace the parameters as described in the below example.

Note The following procedure uses the Keytool utility that is located in
<installation dir>/java/bin/keytool.

1. Stop the RPA RAS and back up the original client.truststore file, located in <installation
dir>/ras/var/security/client.truststore.

2. Open command line in <installation dir>/ras/var/security.

3. Open the <installation dir> ras/conf/ras-wrapper.conf file and make sure that the -Dssl.support-self-
signed value is set to false. This enables the trusted root certificate authority (CA).

For example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 467
Robotic Process Automation 2019.11

wrapper.java.additional.<x>=-Dssl.support-self-signed=false

4. Open the <installation dir> ras/conf/ras-wrapper.conf file and make sure that the -Dssl.verifyHostName
is set to true. This verifies that the FQDN in the certificate matches the FQDN of the request.

For example:

wrapper.java.additional.<x>=-Dssl.verifyHostName=true

Note This property is set to true by default.

5. Import the trusted root certificate authority (CA) to the RAS client.truststore file if it doesn't already exist in
the CA list (by default, all the well known CAs are there):

keytool -importcert -alias <any_alias> -keystore <path to the client.truststore> -file


<certificate_name.cer> -storepass <changeit>

6. Start the RPA RAS.

Check the revoke status of a certificate


A certificate revocation list (CRL) is a list of certificates (or more specifically, a list of serial numbers for certificates)
that have been revoked. Entities that present these (revoked) certificates should no longer be trusted.

From the RAS side

The RAS can determine when a Central certificate has been revoked in the remote server. When the RAS is started
and performs a handshake with Central, it retrieves the Central certificate that contains a link to the location of the
CRL file. The RAS then goes to the CRL file and validates the Central certificate against this CRL file.
If a certificate has been revoked, there is no connection between the RAS and the Central. In addition, there will be
error messages in the log file on the RAS side.

From the Central side

On the Central side, the RAS appears with Availability Offline (not connected) in the Topology area.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 468
Robotic Process Automation 2019.11

Central has configuration in the Central wrapper xml files that contains the field checking the revocation status
enable set to true.
The Central will then go to the CRL file and validate the entity’s certificate against this CRL file. In case of
revocation there will be no connection between the Central and the Entity
In Central side there will be errors in the log file that the certificate was revoked and also the reason for the
revocation.
The operation that Central is trying to perform fails.

What do you want to do?

Enable Revoke Status Check

1. Open the RAS wrapper file ras-wrapper.conf located under


<RAS_INSTALLATION>/ras\conf.

2. Add the following lines to the RAS:

wrapper.java.additional.<n>=-Dcom.sun.security.enableCRLDP=true wrapper.java.additional.<n>=-
Dcom.sun.net.ssl.checkRevocation=true

3. Set the following flag to false:

ssl.support-self-signed=false

Change and encrypt/obfuscate the KeyStore/TrustStore


password
To change the KeyStore,TtrustStore, and server certificate passwords in the Central configuration:

1. Make sure that Central is running.

Note Before doing this step, make sure that there are encrypted passwords.

From OOSH, run the following command:

set-sys-config --key <keyName> --value <encryptedPassword>

where <keyName> is one of the values from the table below:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 469
Robotic Process Automation 2019.11

Configuration item Action

key.store.password To set the password used to access to the key.store. The default
value is "changeit".
This needs to correspond with the value for keystorePass, as set in
the steps below.

key.store.private.key.alias.password To set the password used to access the server certificate (private
key) from the key.store. The default value is "changeit".
This needs to correspond with the value for keyPass, as set in the
steps below.

2. Stop the Central service.

3. Change the KeyStore, TrustStore, and server certificate password using Keytool.

Use the following keytool command to change the KeyStore password:

keytool -storepasswd -keystore <installation_folder>/central/var/security/key.store

Use the following keytool command to change the server certificate private key entry password:

keytool –keypasswd -alias tomcat -keystore


<installation_folder>/central/var/security/key.store

Use the following keytool command to change the TrustStore password:

keytool -storepasswd -keystore <installation_folder>/central/var/security/client.truststore

4. Change the passwords also in the server.xml file located in <installation


dir>/central/tomcat/conf/server.xml.

a. Locate the HTTPS connector. For example:

keyPass="changeit" keystoreFile="C:/Program Files/Micro Focus/Robotic Process


Automation/central/var/security/key.store" keystorePass="changeit" keystoreType="JKS"
maxThreads="200" port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol"
scheme="https" secure="true" sslProtocol="TLSv1.2"
sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2" truststoreFile="C:/Program Files/Micro
Focus/Robotic Process Automation/central/var/security/client.truststore"
truststorePass="changeit" truststoreType="JKS"/>

Change the required password.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 470
Robotic Process Automation 2019.11

keyPass - the password used to access the server certificate private key from the specified key.store
file. The default value is "changeit".

keystorePass - the password used to access the specified key.store file. The default value is the value
of the keyPass attribute.

Note It is recommend not to use the same password as the keyPass,


and to use a strong password.

truststorePass - the password to access the TrustStore (that includes all of the trusted CAs). The
default is the value of the javax.net.ssl.trustStorePassword system property. If that property is
null, no TrustStore password will be configured. If an invalid TrustStore password is specified, a
warning will be logged and an attempt will be made to access the TrustStore without a password,
which will skip validation of the TrustStore contents.

b. Save the file.

5. Edit the central-wrapper.conf file located in <installation dir> central\conf\central and replace the
password of the TrustStore with new password in encrypted or obfuscated form. Examples:

wrapper.java.additional.<x>=-Djavax.net.ssl.trustStorePassword={ENCRYPTED}<encrypted_password>

wrapper.java.additional.<x>=-
Djavax.net.ssl.trustStorePassword={OBFUSCATED}<obfuscated_password>

6. Start the Central sevice.

Change the RAS TrustStore passwords


You should change the KeyStore, TrustStore, and server certificate password using Keytool, before completing the
following step:
To change the standalone RAS TrustStore password: Edit the ras-wrapper.conf file and change the
password of the TrustStore.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 471
Robotic Process Automation 2019.11

Encrypt and obfuscate passwords

You can encrypt or obfuscate a password using the encrypt-password script, which is located in
<installation_folder>/central/bin.
Our recommendation is to use encryption.
After using the encrypt-password script, clear the command history. This is because, on a Linux OS, the password
parameter will be stored in cleartext under /$USER/.bash_history and accessible by the history command.

Encrypt passwords

1. Locate the encrypt-password script, in <installation_folder>/central/bin.

2. Run the script with the -e -p <password> option, where password is the password you want to encrypt.

Note You can either use -p as the flag to encrypt the password or --password.

The encrypted password should appear as follows:

{ENCRYPTED}<some_chars>.

Obfuscate passwords

1. Locate the encrypt-password script, in <installation_folder>/central/bin.

2. Run the script with the -o <password> option, where password is the password that you want to obfuscate.

The obfuscated password should appear as follows:

{OBFUSCATED}<some_chars>.

Create a prompt for the password

It is recommended to run the encrypt-password script without providing the –p argument. For example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 472
Robotic Process Automation 2019.11

This will create a prompt for the hidden password inputs.

Remove vulnerable ciphers from the SSL supported


Ciphers
The DES and Triple DES ciphers, as used in the TLS protocol have a birthday bound of approximately four billion
blocks, which makes it easier for remote attackers to obtain cleartext data via a birthday attack against a long-
duration encrypted session, as demonstrated by an HTTPS session using Triple DES in CBC mode, aka a "Sweet32"
attack.
For more information about this attack, see https://sweet32.info/.
To disable RC4, DES and Triple DES ciphers in RPA:

1. Open the $JRE_HOME/lib/security/java.security file.

2. Remove the comments and change the parameters according to the example below:

jdk.certpath.disabledAlgorithms=DES, DESede, RC4, MD2, RSA keySize < 1024

jdk.tls.disabledAlgorithms=DES, DESede, RC4, MD5, DSA, RSA keySize < 1024

3. Restart the RPA Central server.

For more information, see http://stackoverflow.com/questions/18589761/restict-cipher-suites-on-jrelevel.

Change or disable the HTTP/HTTPS ports


The file server.xml under [RPA_HOME]/central/tomcat/conf contains two elements named <Connector>
under the element <Service>. These connectors define or enable the ports that the server are listening to.
Each connector configuration is defined through its attributes. The first connector defines a regular HTTP connector
and the second defines an HTTPS connector.
By default, the connectors look as follows.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 473
Robotic Process Automation 2019.11

HTTP connector:

<Connector URIEncoding="UTF-8" compression="on" connectionTimeout="20000" port="8080"


protocol="org.apache.coyote.http11.Http11NioProtocol" redirectPort="8443"/>

HTTPS connector:

<Connector SSLEnabled="true" URIEncoding="UTF-8" clientAuth="false" compression="on"


keyAlias="tomcat" keyPass="changeit" keystoreFile="C:/Program Files/Micro Focus/Robotic Process
Automation/central/var/security/key.store" keystorePass="changeit" keystoreType="JKS"
maxThreads="200" port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol" scheme="https"
secure="true" sslProtocol="TLSv1.2" sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2"
truststoreFile="C:/Program Files/Micro Focus/Robotic Process
Automation/central/var/security/client.truststore" truststorePass="changeit" truststoreType="JKS"/>

By default, both are enabled.


Important! If you change or disable one of the RPA Central ports in the server.xml file, you will also need to
update the central-wrapper.conf file and each RAS-wrapper.conf file to point to the Central URL with the
updated port. Otherwise, all your flows will fail when run from RPA Central. Also, make sure to check the load
balancer configurations.

Change port values

To change the values of one of the ports:

1. Edit the server.xml file located in <installation_dir>/central/tomcat/conf/server.xml.

2. Locate the HTTP or HTTPS connector, and adjust the port value in the line.

Note If you are keeping both HTTP and HTTPS active and you want to change
the HTTPS port, you will need to change the redirectPort value for the HTTP
connector and the port value for the HTTPS connector.

3. Save the file.

4. Restart RPA Central.

Disable the HTTP port

You might want to disable the HTTP port, for security reasons, so that the only communication channel will be on
TLS and encrypted.

1. Edit the server.xml file located in <installation_dir>/central/tomcat/conf/server.xml.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 474
Robotic Process Automation 2019.11

2. Locate the HTTP connector, and delete or comment out the line.

3. Import the trusted root certificate authority (CA) to the Central client.truststore file, if it doesn't already
exist in the CA list:

keytool -importcert -alias <any_alias> -keystore <path to the client.truststore> -file <certificate_name.cer> -
storepass <changeit>

Note If you are using a well known root CA (like Verisign) you do not have to
perform this step, because the certificate will already be in the
client.truststore file.

4. Save the file.

5. Restart RPA Central.

Note It is also possible to disable the HTTP port during installation.

Troubleshoot the HTTPS connector


If the server doesn’t start, open the wrapper.log file and look for an error in ProtocolHandler ["http-nio-8443"].
This can happen when Tomcat is initializing or starting the connector. There are many variations but the error
message can provide information.
All the HTTPS connector parameters are in the Tomcat configuration file located at C:\Micro Focus\Robotic
Process Automation\central\tomcat\conf\server.xml.
Open the file and scroll to the end, until you see the HTTPS connector:

<Connector SSLEnabled="true" clientAuth="false" keyAlias="tomcat" keystoreFile="C:/Micro


Focus/Robotic Process Automation/central/var/security/keystore.p12" keystorePass="tomcat-keystore-
password" keystoreType="PKCS12" maxThreads="200" port="8443"
protocol="org.apache.coyote.http11.Http11NioProtocol" scheme="https" secure="true"
sslProtocol="TLSv1.2" sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2"/>

Check if there is any mismatch in the parameters, by comparing them to the parameters you entered in the
previous steps.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 475
Robotic Process Automation 2019.11

Client certificate manual authentication


The most common use of X.509 certificate authentication is in verifying the identity of a server when using TLS,
most commonly when using HTTPS from a browser. The browser automatically checks that the certificate
presented by a server has been issued by one of a list of trusted certificate authorities, which it maintains.
You can also use TLS with mutual authentication. The server requests a valid certificate from the client as part of
the TLS handshake. The server authenticates the client by checking that its certificate is signed by an acceptable
authority. If a valid certificate has been provided, it can be obtained through the servlet API in an application.

Configure client certificate authentication in RPA


Central
Before you configure the client certificate authentication in RPA Central, make sure you have configured the TLS
server certificate
By default, the user certificate is matched against internal users of RPA Central. If you want to match the
certificate against LDAP users, make sure you set the desired LDAP as default LDAP. Set the clientAuth attribute to
true if you want the TLS stack to request a valid certificate chain from the client before accepting a connection. Set
the clientAuth attribute to want if you want the TLS stack to request a client certificate. When the attribute is set to
want and:

The certificate is not presented, then the authentication does not fail and the user is redirected to the login page.
An invalid certificate is presented, then the authentication fails and the user is not redirected to the login page.
A false value (default) does not require a certificate chain unless the client requests a resource protected by a
security constraint that uses CLIENT-CERT authentication. (For more information, see the Apache Tomcat
Configuration Reference). Set the Certificate Revocation List (CRL) file. This can contain several CRLs.In the
operation of some cryptosystems, usually public key infrastructures (PKIs), a certificate revocation list (CRL) is a list
of certificates (or more specifically, a list of serial numbers for certificates) that have been revoked, and therefore,
entities presenting those (revoked) certificates should no longer be trusted.

Note The following procedure uses the Keytool utility that is located in
<installation dir>/java/bin/keytool.

1. Stop the RPA Central server.

2. Import the appropriate root certificate (CA) into RPA Central client.truststore: <installation
dir>/central/var/security/client.truststore, if it doesn't already exist in the CA list (by default, all the well
known CAs are there). For example:

keytool -importcert -alias <any_alias> -keystore <path>/client.truststore -file


<certificate_path> -storepass <changeit>

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 476
Robotic Process Automation 2019.11

3. Edit the server.xml file located in <installation_dir>/central/tomcat/conf/server.xml.

4. Set the clientAuth attribute in the Connector tag to want or true. The default is false.

For example:

<Connector SSLEnabled="true" URIEncoding="UTF-8" clientAuth="false" compression="on"


keyAlias="tomcat" keyPass="changeit" keystoreFile="C:/Program Files/Micro Focus/Robotic Process
Automation/central/var/security/key.store" keystorePass="changeit" keystoreType="JKS" maxThreads="200"
port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol" scheme="https" secure="true"
server="RPA" sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2" sslProtocol="TLSv1.2"
truststoreFile="C:/Program Files/Micro Focus/Robotic Process
Automation/central/var/security/client.truststore" truststorePass="changeit" truststoreType="JKS"/>

We recommend starting the server at the end of this procedure, but note
that it is also possible to start the server at this point.

5. (Optional) Add the crlFile attribute to define the certificate revocation list file for the TLS certificate validation,
for example:

crlFile="<path>/crlname.<crl/pem>"

The file can be with the .crl extension for a single certificate revocation list or with the .pem (PEM CRL format)
extension for one or more certificate revocation lists. The PEM CRL format uses the following header and
footer lines:

-----BEGIN X509 CRL----- -----END X509 CRL-----

Example of the .pem file structure for one CRL (for more than one, concatenate another CRL block):

-----BEGIN X509 CRL----- MIIBbzCB2QIBATANBgkqhkiG9w0BAQUFADBeMQswCQYDVQQGEwJVUzEYMBYGA1UE


ChMPVS5TLiBHb3Zlcm5tZW50MQwwCgYDVQQLEwNEb0QxEDAOBgNVBAsTB1Rlc3Rp
bmcxFTATBgNVBAMTDFRydXN0IEFuY2hvchcNOTkwMTAxMTIwMTAwWhcNNDgwMTAx
MTIwMTAwWjAiMCACAScXDTk5MDEwMTEyMDAwMFowDDAKBgNVHRUEAwoBAaAjMCEw
CgYDVR0UBAMCAQEwEwYDVR0jBAwwCoAIq5rr+cLnVI8wDQYJKoZIhvcNAQEFBQAD
gYEAC7lqZwejJRW7QvzH11/7cYcL3racgMxH3PSU/ufvyLk7ahR++RtHary/WeCv
RdyznLiIOA8ZBiguWtVPqsNysNn7WLofQIVa+/TD3T+lece4e1NwGQvj5Q+e2wRt
GXg+gCuTjTKUFfKRnWz7O7RyiJKKim0jtAF4RkCpLebNChY= -----END X509 CRL-----

6. Edit the central-wrapper.conf file, located in <installation dir> central\conf\central.

Uncomment the following properties and set the client certificate location and password to a client certificate

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 477
Robotic Process Automation 2019.11

with an administrator user.

#wrapper.java.additional.23=-
Djavax.net.ssl.keyStore="%CENTRAL_HOME%/var/security/certificate.p12"

#wrapper.java.additional.24.stripquotes=TRUE

#wrapper.java.additional.25=-
Djavax.net.ssl.keyStorePassword={OBFUSCATED}ZUoMreNLw6qIOyzX7g5YKw==

#wrapper.java.additional.26=-Djavax.net.ssl.keyStoreType=PKCS12

7. Start the RPA Central server.

Note For each client certificate, you need to define a user, either an internal user
or LDAP user. The name of the user should be defined in the certificate attributes.
The default is value of the CN attribute. Note that even if RPA is set up with
multiple LDAP configurations, it is only possible to authenticate the user using the
client certificate attributes with the default LDAP.

Update the configuration of a client certificate in RPA


RAS
The client certificate is configured during the installation of the RPA RAS. However, if you need to update the client
certificate, you can do this manually in the ras-wrapper.conf file.
Prerequisite: You must import the CA root certificate of RPA Central into the RPA RAS TrustStore.
To update the configuration of the client certificate in an external RPA RAS:

1. Stop the RPA RAS server.

2. Open the ras-wrapper.conf file from <installation dir>ras/conf/ras-wrapper.conf.

3. Uncomment the following properties and change the following according to your client certificate:

#wrapper.java.additional.&lt;x&gt;=-Djavax.net.ssl.keyStore=&lt;installation
dir&gt;/var/security/certificate.p12&quot; #wrapper.java.additional.<x>.stripquotes=TRUE
#wrapper.java.additional.&lt;x&gt;=-
Djavax.net.ssl.keyStorePassword={OBFUSCATED}&lt;obfuscated_password&gt;

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 478
Robotic Process Automation 2019.11

#wrapper.java.additional.&lt;x&gt;=-Djavax.net.ssl.keyStoreType=PKCS12

Important The X.509 client certificate needs to have the principal name of the RAS, which is the RAS ID. You can
find the RAS ID under the Topology tab in Central.

Process certificate policies


RPA handles the processing of certificate polices for the end certificate.

You can set the purpose string in the certificate.


RPA lets you add the policy string(s) as a configuration item and check the policy string of each end certificate. If
it does not match, reject the certificate.

Enable or disable the certificate policy verification by adding the following configuration item:
x509.certificate.policy.enabled=true/false (default is false).
Define the policy list by adding the following configuration item:
x509.certificate.policy.list=<comma_separated_list> (the default is an empty list).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 479
Robotic Process Automation 2019.11

Process a certificate principal


You can define how to get the principal from a certificate using a regular expression match against the Subject.
The regular expression should contain a single group. The default expression CN=(.?) matches the common name
field.
For example, CN=Jimi Hendrix, OU= assigns a user name of Jimi Hendrix.

The matches are case-insensitive.


The principal of the certificate is the user name in RPA (LDAP or internal user).
To change the regular expression, change the configuration item: x509.subject.principal.regex.

Enable RPA to read from the subject alternative name


field in a certificate
You can enable RPA to read from the Subject Alternative Name field in a certificate, using the configuration item
x509.principal.lookup.field.
This configuration item controls which certificate field is used to extract the username.
Possible values are:

subjectDN - represents the Subject field of the certificate, meaning that RPA OO keeps its default behavior and
attempts to extract the username from the Subject field. This is the default value.
subjectAltNames.otherName.principalName - represents the User Principal Name (OID 1.3.6.1.4.1.311.20.2.3)
contained in the Other Name entry of the Subject Alternative Names certificate extension. For CAC
Authentication, it might be required to use the value of the User Principal Name, so you would use this value.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 480
Robotic Process Automation 2019.11

Configure the TLS protocol


You can configure RPA to define the supported TLS protocol version. By default, RPA allows TLS v1, TLS v1.1 and
TLS v1.2, but you can narrow this down.

Note SSLv3 and other versions of SSL are not supported.

1. Open the <installation_folder>/central/tomcat/conf/server.xml file .

2. Locate the SSL connector (at the end of the file).

3. Edit the default value of sslEnabledProtocols. For example, change

sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2" to

sslEnabledProtocols="TLSv1.2"

4. Restart the server.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 481
Robotic Process Automation 2019.11

Prevent flows from accessing the Central/RAS


local file system
You should modify the wrapper configuration and java.policy files of Central or RAS, in order to prevent flows from
accessing the local file system of Central or RAS, and gaining access to sensitive resources.

Note In order to exploit this scenario, a user would need to have both deployment
and triggering permissions, in addition to entitlement on flows or the ability to
entitle flows. Users with such permissions are likely to be trustworthy users.

To protect from this scenario:

1. In the wrapper configuration file of Central or RAS


(<installation_folder>/<ras/central>/conf/<central/ras>-wrapper.conf), add the
wrapper.java.additional.<nn> parameter as follows:

wrapper.java.additional.<nn>=-Djava.security.manager

Replace <nn> with the number after the last number.

2. In the java.policy file (located at <installation_folder>/java/lib/security/java.policy), add the following.


This allows access to the minimum resources that are required by Robotic Process Automation and prevents
access to the local file system of Central/RAS that contains sensitive data.

grant codebase "file:${oo.home}/bin/-" { permission java.security.AllPermission; }; grant


codebase "file:${oo.home}/lib/-" { permission java.security.AllPermission; }; grant codebase
"file:${oo.home}/tomcat/-" { permission java.security.AllPermission; }; grant codebase
"file:${oo.home}/var/cache/-" { permission java.lang.RuntimePermission "getClassLoader";
permission java.io.FilePermission "${oo.home}/var/cache/-", "read, write"; permission
java.io.FilePermission "${oo.home}/var/logs", "read, write"; };

Note You may need to add more permissions depending on the content you
run.

To allow the flow to access to resources in the local file system of Central/RAS, you should specify this in the
java.policy. For example:

grant codebase "file:${oo.home}/var/cache/-" { permission java.io.FilePermission


"C:\\users\\cathy\\foo.bat", "read, write, execute, delete"; permission java.io.FilePermission

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 482
Robotic Process Automation 2019.11

"C:\\users\\cathy\\-", "read,write,execute,delete"; // Recursive Example permission


java.io.FilePermission "C:\\users\\cathy\\*", "read,write,execute,delete"; // Flat Example
..... };

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 483
Robotic Process Automation 2019.11

Adding Java security manager


To avoid a possible scenario where user creates a flow which shuts down the localhost server, apply the
specifications as described in "Preventing flows from accessing the Central/RAS local file system" topic.
The following sections describe how to set up the Java policy file for standalone RAS and Central embedded worker.

Configure RAS to add Java security manager


To activate security manager on a standalone RAS:

1. In the %RAS_HOME% \conf folder, create a text file named ras.policy, add the following content:

grant codeBase "file:${oo.home}/lib/score-worker-manager-impl.jar" { permission


java.lang.RuntimePermission "exitVM.75"; }

2. In the ras-wrapper.conf file located in the %RAS_HOME%\conf folder, add the following wrapper:

wrapper.java.additional.<next_index>=-Djava.security.policy="%RAS_HOME%/conf/ras.policy"

3. Restart the RAS.

Configure Central embedded worker to add Java


security manager
To activate security manager on a Central embedded worker:

1. Add the following content before System Code Permissions in the


%CENTRAL_HOME%/tomcat/conf/catalina.policy file.
grantcodeBase "file:${oo.home}/tomcat/webapps/oo/WEB-INF/lib/score-worker-manager-
impl.jar"
{
permission java.lang.RuntimePermission "exitVM.75";
}

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 484
Robotic Process Automation 2019.11

Related topics
Prevent flows from accessing the Central/RAS local file system

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 485
Robotic Process Automation 2019.11

Enable redirection to HTTPS


If you selected Allow HTTP access in the Installation wizard, and you want to change this to redirect the HTTP
traffic to HTTPS, you can configure this manually in the web.xml file.

1. Stop the Central server.

2. Open the <installation_folder>/central/tomcat/conf/web.xml file.

3. Locate the <security-constraint> property.

4. Change the value of <transport-guarantee> to CONFIDENTIAL.

For example:

<security-constraint>

<web-resource-collection>

<web-resource-name>HTTPSOnly</web-resource-name>

<url-pattern>/*</url-pattern>

</web-resource-collection>

<user-data-constraint>

<transport-guarantee>CONFIDENTIAL</transport-guarantee>

</user-data-constraint>

</security-constraint>

5. Start the Central server.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 486
Robotic Process Automation 2019.11

Disable CSRF protection


A CSRF (Cross-Site Request Forgery) attack is when a malicious web site, email, blog, instant message, or program
causes a user’s web browser to perform an unwanted action on a trusted site for which the user is currently
authenticated. The impact of a successful cross-site request forgery attack is limited to the capabilities exposed by
the vulnerable application.
In a fresh installation of RPA, or when you upgrade from an earlier version, CSRF protection is enabled by default.
You can enable or disable CSRF protection by setting the csrf.protection.enabled system configuration item to true
or false. This can be done via REST API.
When using REST APIs, in some situations you will need to add the CSRF token header (just for POST/DELETE/PUT).

Note Make sure that the load balancer does not remove the XSRF header and
cookie from the request/response.

You can disable CSRF protection by setting the csrf.protection.enabled system configuration item to the value
false. This can be done via REST API.
To re-enable, set the value back to true.
To set this system configuration item, you must have Manage System Settings permissions.
You can enable or disable this protection in the central-wrapper.conf file.

1. Stop the RPA Central server.

2. Open the <installation_folder>/central/conf/central-wrapper.conf file .

3. Locate the Dcsrf.enabled property and change it to true, to enable CSRF protection.

4. Start the Central server.

For more information about CSRF protection, see


https://www.owasp.org/index.php/Cross-Site_Request_Forgery_%28CSRF%29_Prevention_Cheat_Sheet#Disclosure_
of_Token_in_URL.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 487
Robotic Process Automation 2019.11

Set up security and hardening for RPA Workflow


Designer
This section provides information on security models and recommendations for a secure implementation of RPA
Workflow Designer. This includes subjects such as authentication, authorization, encryption, and more. There are
references to other relevant RPA Workflow Designer sections or topics, which describe how to complete security-
related tasks.
This section includes the following topics:

Security concepts
Secure installation guidelines
Secure implementation and deployment
Network and communication security
User management and authentication
Backup
Encryption
Log files
Security questions and answers

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 488
Robotic Process Automation 2019.11

Security concepts
Before securing the RPA Workflow Designer application, it is recommended to go through the following table to
understand terminologies:

Term Description

User A user is an object associated with a person (or application identity) representing the person
and defining their authorization.
RPA Workflow Designer users are authenticated via LWSSO (Lightweight Single Sign On).
This is a mechanism in which a single action of user authentication and authorization can
permit a user to access all Micro Focus systems that support LWSSO. For example, if users
have logged onto another Micro Focus product web client that has LWSSO enabled, they can
enter the RPA Workflow Designer application directly, bypassing the RPA Workflow Designer
logon screen.

System Security The processes and mechanisms by which computer-based equipment, information, and
services are protected from unintended or unauthorized access, change, or damage.

Authentication The process of identifying an individual, usually based on a user name and password, or
certificate.

Encryption A way to enhance the security of a message or file by scrambling the contents so that it can
be read only by someone who has the right encryption key to encode it. For example, the
TLS protocol encrypts the communication data.

Related topics
Secure installation guidelines

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 489
Robotic Process Automation 2019.11

Secure implementation and deployment

Default security settings


In many cases, it is recommended to modify the default security settings that are provided out-of-the-box.

Authentication – RPA Workflow Designer uses LWSSO for authentication.


TLS Encryption – By default, RPA Workflow Designer supports TLS protocol 1.2.
TLS Server Certificate – By default, the user is asked to provide a CA certificate during the installation of the
RPA Workflow Designer server.
KeyStore, TrustStore, and Server Certificate Passwords – By default, Java passwords are provided for the
keyStore, trustStore, and Server Certificate. It is recommended to replace these with encrypted passwords.

RPA Workflow Designer Security Hardening


The Hardening chapter provides recommendations for safeguarding your RPA Workflow Designer deployment from
security risks or threats. Some of the most important reasons to secure an application include protecting the
confidentiality, integrity, and availability of an organization's critical information.
To comprehensively protect your RPA Workflow Designer system, it is necessary to secure both RPA Workflow
Designer and the computing environment (for example, the infrastructure and the operating system) upon which
the application runs.
The Hardening section provides recommendations to help secure RPA Workflow Designer at the application level
and does not cover how to secure the infrastructure within the customer environment. The user is solely
responsible for understanding the infrastructure or environment and applying the respective hardening policies.

Physical security
It is recommended that the RPA Workflow Designer is protected by physical security controls defined by your
organization. The RPA Workflow Designer server components are installed in a physically secured environment,
according to best practice. For example, the server must be in a closed room with access control.

Related topics
Change and encrypt/obfuscate the KeyStore/TrustStore password

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 490
Robotic Process Automation 2019.11

Secure installation guidelines

Supported operating systems


For the types and versions of supported operating systems, see the Support matrix section.

Operating system hardening recommendations


Contact your operating system vendor for recommended best practices for hardening your operating system.
For example:

Patches should be installed


Unnecessary services/software should be removed or disabled
Minimal permissions should be assigned to users
Auditing should be enabled
Recommended: Put up a firewall to protect against DDoS.

Tomcat hardening
When you install RPA Workflow Designer, Tomcat is partially hardened by default. If you want extra hardening, see
the recommendations in the Hardening chapter.

Installation permissions
The following permissions are required to install and run RPA Workflow Designer:

Activity User type

Installing RPA Workflow Windows/Linux: Any standard user who is able to run a Java process, and who has
Designer permission to create folders and services

Running RPA Workflow • Windows: The Windows service runs as the system user or a specific user (the
Designer user must have access to the RPA Workflow Designer installation directory)
• Linux: Any standard user who is able to run a Java process. See also the
recommendations in the CIS Apache Tomcat documentation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 491
Robotic Process Automation 2019.11

Security protection in RPA Workflow Designer


The following security features have been designed to protect the security of your RPA Workflow Designer
installation.

CSRF protection

RPA Workflow Designer is protected against CSRF (Cross-Site Request Forgery).


A CSRF attack is when a malicious web site, email, blog, instant message, or program causes a user’s web browser
to perform an unwanted action on a trusted site for which the user is currently authenticated. The impact of a
successful cross-site request forgery attack is limited to the capabilities exposed by the vulnerable application.
For more information about CSRF, see https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF) .

XSS protection

RPA Workflow Designer is protected against XSS (Cross-Site Scripting).


An XSS attack is when an attacker injects malicious code, generally in the form of a browser side script, to a
different end user. An XSS vulnerability may be used by attackers to bypass access controls such as the same-
origin policy.
For more information about XSS, see https://www.owasp.org/index.php/Cross-site_Scripting_(XSS).

Clickjacking protection

RPA Workflow Designer is protected against clickjacking.


Clickjacking is when an attacker manipulates a website user's activity by concealing hyperlinks beneath legitimate
clickable content. Thus, the attacker is "hijacking" clicks meant for one page and routing them to another page.
For more information about clickjacking, see https://www.owasp.org/index.php/Clickjacking.

Related topics
Security concepts
Secure implementation and deployment

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 492
Robotic Process Automation 2019.11

Network and communication security


This topic describes network and communication security in RPA Workflow Designer.

Communication channel security


Supported Protocols and Configuration
RPA Workflow Designer supports the TLS protocol.
The RPA Workflow Designer ports are defined by the administrator during the installation.
Channel Security
RPA Workflow Designer supports the following secure channel:

Channel (Directed) Supported Secure Protocol

Browser à RPA Workflow Designer For a secure channel, use the TLS communication for encryption and Client
Certificate for authentication.

Related topics
To replace TLS server certificate in RPA Workflow Designer, see Replace the RPA Workflow Designer TLS server
certificate
For instructions to install RPA Workflow Designer, see Install RPA Workflow Designer
For instructions to configure a proxy in RPA Workflow Designer, see Configure a proxy for RPA Workflow Designer

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 493
Robotic Process Automation 2019.11

User management and authentication

Authentication model
There are two methods to authenticate access to RPA Workflow Designer:

Single sign on ( LWSSO) - supported at the backend


LWSSO is used to authenticate user access to RPA Workflow Designer at the backend and IDM service for the
installer.

Database authentication
RPA Workflow Designer supports Oracle, MS SQL, and PostgreSQL databases.
We recommend using a strong database password for database authentication and using a strong password policy.
For example, blocking after a number of failed attempts.
When using MS SQL, it is possible to work with either database authentication or with OS authentication. Our
recommendation is to work with OS authentication, where this is possible. For example, it is possible to use
Windows authentication to access Microsoft SQL Server databases.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 494
Robotic Process Automation 2019.11

Backup
In order to prevent data loss, It is highly recommended to regularly back up your data on the servers onto secure
media. This is also helpful for disaster recovery and business continuity.
After installing RPA Workflow Designer, make sure to back up the designer\var\security folder and the
designer\conf\database.properties file.
Some data on the database schema is encrypted and the keys for decryption are stored locally on the RPA
Workflow Designer server. If these system files become corrupted or deleted, the schema will be useless, because
there will be no way to decrypt the data.

NOTE: The keys are encrypted, so it is important to include them in the backup.
The keys are located in the security folder.

Related topics
For instructions to encrypt RPA Workflow Designer password, see Encryption
For information on RPA Workflow Designer log files, see Log files

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 495
Robotic Process Automation 2019.11

Encryption

Encryption model
RPA Workflow Designer supports encryption and hash algorithms to protect sensitive data. Encryption is designed
to prevent the exposure and modification of sensitive data, such as passwords, definitions, and so on in RPA
Workflow Designer.
It is important to use well-known, standard algorithms without known vulnerabilities, in order to prevent decryption
by unauthorized persons.
For example, SSL is not used, because of known vulnerabilities in the SSL protocol.

Static Data
All saved passwords are protected using well known algorithms and none are left in clear text. For example, the
database passwords are encrypted.

Data in-transit
RPA Workflow Designer uses the Transport Layer Security (TLS) protocol to encrypt the data between components.

Disabling the HTTP port


It is recommended to disable the HTTP port, for security reasons, so that the only communication channel will be
on TLS and encrypted.

Encryption administration
Default Configuration Set

Symmetric-key algorithm: AES with key size 128


Hashing algorithm: SHA1

Digital certificates
A digital certificate is an electronic "passport" for a person, server, station, and so on.
To use encryption between a browser and the RPA Workflow Designer server, you need to install a digital
certificate on the server side.
RPA Workflow Designer uses the Java Keytool utility to manage cryptographic keys and trusted certificates. This
utility is included in the RPA Workflow Designer installation folder, in <installation dir>/java/bin/keytool.
Certificate Location
Installations of RPA Workflow Designer include two files for the management of certificates using Keytool:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 496
Robotic Process Automation 2019.11

<installation dir>/designer/var/security/client.truststore: Contains the list of trusted certificates.


<installation dir>/desginer/var/security/key.store: Contains the RPA Workflow Designer private certificate
including the private key.
Access Control to KeyStore and TrustStore
It is recommended that the TrustStore and KeyStore are stored with read permissions only for the user that runs
the RPA Workflow Designer service.
Replacing the RPA Workflow Designer Self-signed Certificate
It is recommended to replace the RPA Workflow Designer self-signed certificate after a new installation of RPA
Workflow Designer or if your current certificate has expired.
Part of the process of replacing the certificate is generating a PKCS12 format certificate, using your CA. Contact
your CA for specific details about the certificate process or refer to your corporate policy.

Related topics
To change and disable HTTP or HTTPS ports, see Change and disable the HTTP/HTTPS ports
To replace RPA Workflow Designer TLS server certificate, see Replace the RPA Workflow Designer TLS server
certificate

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 497
Robotic Process Automation 2019.11

Log files
Logs let you trace errors, warnings, information, and debugging messages.
The logs for RPA Workflow Designer are saved in the file server in the following location:
<installation>/designer/var/logs
It must be noted that no sensitive data is kept in the log files in RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 498
Robotic Process Automation 2019.11

Security questions and answers


How can I generate a certificate request that can be signed by an external CA?
Export the certificate request and send it to the external CA for signing.
Which TCP/UDP ports does RPA Workflow Designer use? What is the direction, user, and encryption?
When you install RPA Workflow Designer, you need to configure at least one available port for the RPA Workflow
Designer Server in the HTTP/HTTPS fields. The default provided values are 8080 and 8443, but you can change
these.
How do I configure self-signed SSL certificates for RPA Workflow Designer?
During the installation of RPA Workflow Designer, if you do not provide a certificate, a self-signed certificate is
created by default. However, for security reasons, it is not recommended to use self-signed certificates. It is
recommended to work with a certificate from a custom-root CA or from a well-known CA.
How detailed are the logs, and how do I change the amount of logging?
The logs can be set to different levels of granularity. The default level is INFO, but you can adjust this.
Which authentication mechanism does RPA Workflow Designer support?
RPA Workflow Designer supports Client Certificate and LWSSO.
Can I limit the RPA Workflow Designer user IP address?
No, this is not supported at the moment.

Related topics
Replace the RPA Workflow Designer TLS server certificate
Network and communication security
Log files
Encryption
User management and authentication

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 499
Robotic Process Automation 2019.11

Hardening RPA Workflow Designer


This section describes how to configure security hardening for RPA Workflow Designer and includes the following
topics.

Security hardening recommendations


Working with server and client certificates
Encrypt the communication using a server certificate
Change or disable the HTTP/HTTPS ports
Configure the secured properties
Set SSL configuration properties
Troubleshoot the HTTPS connector
Troubleshoot multiple deployment requests

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 500
Robotic Process Automation 2019.11

Security hardening recommendations

1. Install RPA Workflow Designer.

2. Configure the RPA Workflow Designer server certificate for TLS encryption and client certificate for strong
authentication (mutual).

NOTE:
This can be done during installation.

1. Harden the RPA Workflow Designer server by removing the HTTP port and replacing the passwords of the
KeyStore and TrustStore with strong passwords.

2. Remove the RC4 cipher from the SSL-supported ciphers.

3. Harden/secure the operating system and database.

4. In the Windows and SQL server environment, configure RPA Workflow Designer to work with Windows
authentication.

Default security settings


In many cases, it is recommended to modify the default security settings that are provided out-of-the-box.

Authentication – RPA Workflow Designer uses LWSSO for authentication.


TLS Encryption – By default, RPA Workflow Designer supports TLS protocol 1.2.
TLS Server Certificate – By default, the user is asked to provide a CA certificate during the installation of the
RPA Workflow Designer server.
KeyStore, TrustStore, and Server Certificate Passwords – By default, Java passwords are provided for the
keyStore, trustStore, and Server Certificate. It is recommended to replace these with encrypted passwords.

Related topics
Change and disable the HTTP/HTTPS ports
Change and encrypt/obfuscate the KeyStore/TrustStore password
Encrypting the communication using a server certificate
Change and encrypt/obfuscate the KeyStore/TrustStore password

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 501
Robotic Process Automation 2019.11

Working with server and client certificates


The Transport Layer Security (TLS) certificates digitally bind a cryptographic key to the details of an organization,
enabling secure and encrypted connections from a web server to a browser.
RPA Workflow Designer uses the Keytool utility to manage cryptographic keys and trusted certificates. This utility is
included in the RPA Workflow Designer installation folder, in <installation dir>/java/bin/keytool. For more
information about the Keytool utility, see http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/keytool.html.

NOTE: Keytool is an open source utility.

Installations of RPA Workflow Designer include two files for the management of certificates:

<installation dir>/designer/var/security/client.truststore: Contains the list of trusted certificates.


<installation dir>/designer/var/security/key.store: Contains the RPA Workflow Designer certificate (private
key).
Below are some of the recommendations:

It is recommended to replace the RPA Workflow Designer self-signed certificate after a new installation of RPA
Workflow Designer or if your current certificate is expired.
It is recommended to store the TrustStore and KeyStore with read permissions only for the user that runs the
RPA Workflow Designer service.
It is recommended to clear the console after using Keytool or to use the prompt for password inputs.

Related topics
To encrypt communication, see Encrypt the communication using a server certificate

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 502
Robotic Process Automation 2019.11

Encrypt the communication using a server


certificate
This section describes the encryption and obfuscation of the communication using a server certificate.

Replace the RPA Workflow Designer TLS server certificate

Import a CA root certificate to the RPA Workflow Designer TrustStore

Change and encrypt/obfuscate the KeyStore/TrustStore password

Encrypt passwords

Remove the RC4 cipher from the SSL-supported ciphers

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 503
Robotic Process Automation 2019.11

Replace the RPA Workflow Designer TLS server


certificate
You can use a certificate signed by a well-known certificate authority or a custom server certificate from a local
certificate authority.
Replace the parameters between brackets < > to match the location of the key.store file and other details on
your computer.

NOTE: The following procedure uses the Keytool utility that is located in
<installation dir>/java/bin/keytool.

1. Stop RPA Workflow Designer and back up the original key.store file, located in <installation
dir>/designer/var/security.

2. Open a command line in <installation dir>/designer/var/security.

3. Delete the existing server certificate from the RPA Workflow Designer key.store file, using the following
command:

keytool -delete -alias tomcat -keystore key.store -storepass changeit

4. If you already have a certificate with a .pfx or .p12 extension, then go to the next step. If not, you need to
export the certificate with private key into PKCS12 format (.pfx, .p12). For example, if the certificate format is
PEM:

>openssl pkcs12 –export –in <cert.pem> -inkey <.key> -out <certificate name>.p12 –name
<name>

If the certificate format is DER, add the –inform DER parameter after pkcs12.For example:

>openssl pkcs12 –inform DER –export –in <cert.pem> -inkey <.key> -out <certificate name>.p12
–name <name>

NOTE:

To generate the PKCS12 format certificate, you need to use your CA.
As this step may vary according to CA vendor and policy, contact
your CA for a detailed explanation of the certificate generation
process.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 504
Robotic Process Automation 2019.11

NOTE:

Make a note of the password that you provide. You will need this
password for the private key when you input the KeyStore passphrase
later in this procedure.

Make sure to choose a strong password.

5. List the alias for your certificate’s alias, using the following command:

keytool -list -keystore <certificate_name> -v -storetype PKCS12

The certificate alias is displayed and should be provided in the next command.

In the example below, it is the fourth line from the bottom.

6. Import the PKCS12 format server certificate to the RPA Workflow Designer key.store file using the following
command: keytool -importkeystore -srckeystore <PKCS12 format certificate path> -destkeystore key.store -
srcstoretype pkcs12 -deststoretype JKS -alias <cert alias> -destalias tomcat

NOTE:

The alias should be tomcat unless it is also changed in the


server.xml file.

7. If the imported server certificate has a different password from the original server certificate, it is important
to change the keyPass password. It is also recommended to change the default “changeit” password in the
automatically generated KeyStore in the RPA Workflow Designerserver.

8. Start RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 505
Robotic Process Automation 2019.11

Related topics
To change and encrypt the keystore or truststore password in RPA Workflow Designer, see Change and
encrypt obfuscate the KeyStore TrustStore password

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 506
Robotic Process Automation 2019.11

Import a CA root certificate to the RPA Workflow


Designer TrustStore
If you are using a custom root certificate for RPA Workflow Designer, you will need to import the trusted root
certificate authority (CA) to the client.truststore. If you are using a well known root CA (like Verisign) you do not
have to perform the following procedure, because the certificate will already be in the client.truststore file.
By default, RPA Workflow Designer supports all self-signed certificates. However, in a production environment, it is
recommended to change this default to a custom CA or a well-known CA for security reasons.
Replace the parameters between brackets < >.
The following procedure uses the Keytool utility that is located in <installation dir>/java/bin/keytool.

1. Stop RPA Workflow Designer and back up the original client.truststore file, located in <installation
dir>/designer/var/security/client.truststore.

2. Import the trusted root certificate authority (CA) to the RPA Workflow Designer client.truststore file if it
doesn't already exist in the CA list (by default, all the well-known CAs are there). keytool -importcert -alias
<any_alias> -keystore <path to the client.truststore> -file <certificate_name.cer> -storepass <changeit>

3. Start RPA Workflow Designer.

Related topics
To change and encrypt the keystore or truststore password in RPA Workflow Designer, see Change and
encrypt obfuscate the KeyStore TrustStore password
To encrypt RPA Workflow Designer passwords, see Encrypt passwords

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 507
Robotic Process Automation 2019.11

Change and encrypt obfuscate the KeyStore


TrustStore password

Change the KeyStore, TrustStore, and server


certificate passwords in the RPA Workflow Designer
configuration
1. Make sure that RPA Workflow Designer is running.

NOTE: Before doing this step, make sure that there are encrypted passwords.

2. Stop the RPA Workflow Designer service.

3. Change the KeyStore, TrustStore, and server certificate password using Keytool. Use the following keytool
command to change the KeyStore password:

keytool -storepasswd -keystore <installation_folder>/designer/var/security/key.store

Use the following keytool command to change the server certificate private key entry password:

keytool –keypasswd -alias tomcat -keystore


<installation_folder>/designer/var/security/key.store

Use the following keytool command to change the TrustStore password:

keytool -storepasswd -keystore <installation_folder>/designer/var/security/client.truststore

4. Change the passwords also in the server.xml file located in <installation


dir>/designer/tomcat/conf/server.xml.

a. Locate the HTTPS connector. For example:

keyPass="changeit" keystoreFile="C:/Program Files/Micro Focus/Robotic Process Automation


Designer/designer/var/security/key.store" keystorePass="changeit" keystoreType="JKS"
maxThreads="200" port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol"
scheme="https" secure="true" sslProtocol="TLSv1.2" sslEnabledProtocols="TLSv1.2"
truststoreFile="C:/Program Files/Micro Focus/Robotic Process Automation

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 508
Robotic Process Automation 2019.11

Designer/designer/var/security/client.truststore" truststorePass="changeit"
truststoreType="JKS"/>

Change the required password.

keyPass - the password used to access the server certificate private key from the specified key.store
file. The default value is "changeit".

keystorePass - the password used to access the specified key.store file. The default value is the value
of the keyPass attribute.

NOTE: It is recommend not to use the same password as the keyPass,


and to use a strong password.

truststorePass - the password to access the TrustStore (that includes all of the trusted CAs). The
default is the value of the javax.net.ssl.trustStorePassword system property. If that property is
null, no TrustStore password will be configured. If an invalid TrustStore password is specified, a
warning will be logged and an attempt will be made to access the TrustStore without a password,
which will skip validation of the TrustStore contents.

b. Save the file.

5. Edit the designer-wrapper.conf file located in <installation dir> designer\conf\ and replace the
password of the TrustStore with new password in encrypted or obfuscated form. Examples:

wrapper.java.additional.<x>=-Djavax.net.ssl.trustStorePassword={ENCRYPTED}<encrypted_password>

wrapper.java.additional.<x>=-
Djavax.net.ssl.trustStorePassword={OBFUSCATED}<obfuscated_password>

6. Start the RPA Workflow Designer service.

Related topics
Encrypt passwords

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 509
Robotic Process Automation 2019.11

Encrypt passwords

You can encrypt a password using the encrypt-password script, which is located in
<installation_folder>/designer/bin.
Our recommendation is to use encryption.
Important! After using the encrypt-password script, clear the command history.
This is because, on a Linux OS, the password parameter will be stored in cleartext under /$USER/.bash_history
and accessible by the history command.

Encrypting passwords
1. Locate the encrypt-password script, in <installation_folder>/designer/bin.

2. Run the script with the -e -p <password> option, where password is the password you want to encrypt.

NOTE: You can either use -p as the flag to encrypt the password or --password.

The encrypted password should appear as follows:

{ENCRYPTED}<some_chars>.

Creating a prompt for the password


It is recommended to run the encrypt-password script without providing the –p argument. For example:

This will create a prompt for the hidden password inputs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 510
Robotic Process Automation 2019.11

Remove the RC4 cipher from the SSL-supported


ciphers
The remote host supports the use of the RC4 cipher. This cipher is flawed in its generation of a pseudo-random
stream of bytes so that a wide variety of small biases are introduced into the stream, decreasing its randomness.
If plain text is repeatedly encrypted (for example, HTTP cookies), and an attacker is able to obtain many (i.e., tens
of millions of) cipher texts, the attacker may be able to derive the plain text.
Disable the RC4 cipher on the JRE level (starting with Java 7):

1. Open the <installation_dir>/java/bin/lib/security/java.security file.

2. Disable the RC4 cipher by removing the comments and changing the parameters according to the example
below:

jdk.certpath.disabledAlgorithms=RC4, MD2, RSA keySize < 1024

jdk.tls.disabledAlgorithms=RC4, MD5, DSA, RSA keySize < 1024

3. Restart the OO Designer server.

For more information, see http://stackoverflow.com/questions/18589761/restict-cipher-suites-on-jre-level.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 511
Robotic Process Automation 2019.11

Change or disable the HTTP/HTTPS ports


The file server.xml under [RPA_HOME]/designer/tomcat/conf contains two elements named <Connector>
under the element <Service>. These connectors define or enable the ports that the server are listening to.
Each connector configuration is defined through its attributes. The first connector defines a regular HTTP connector
and the second defines an HTTPS connector.
By default, the connectors look as follows.
HTTP connector:

<Connector URIEncoding="UTF-8" compression="on" connectionTimeout="20000" port="8080"


protocol="org.apache.coyote.http11.Http11NioProtocol" redirectPort="8443"/>

HTTPS connector:

<Connector SSLEnabled="true" URIEncoding="UTF-8" clientAuth="false" compression="on"


keyAlias="tomcat" keyPass="changeit" keystoreFile="C:/Program Files/Micro Focus/Robotic Process
Automation/central/var/security/key.store" keystorePass="changeit" keystoreType="JKS"
maxThreads="200" port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol" scheme="https"
secure="true" sslProtocol="TLSv1.2" sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2"
truststoreFile="C:/Program Files/Micro Focus/Robotic Process
Automation/central/var/security/client.truststore" truststorePass="changeit" truststoreType="JKS"/>

By default, both are enabled.


Important! If you change or disable one of the Central ports in the server.xml file, you will also need to update
the central-wrapper.conf file and each RAS-wrapper.conf file to point to the Central URL with the updated
port. Otherwise, all your flows will fail when run from Central. Also, make sure to check the load balancer
configurations.

Change port values


To change the values of one of the ports:

1. Edit the server.xml file located in <installation_dir>/central/tomcat/conf/server.xml.

2. Locate the HTTP or HTTPS connector, and adjust the port value in the line.

Note If you are keeping both HTTP and HTTPS active and you want to change
the HTTPS port, you will need to change the redirectPort value for the HTTP
connector and the port value for the HTTPS connector.

3. Save the file.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 512
Robotic Process Automation 2019.11

4. Restart Central.

Disable the HTTP port


You might want to disable the HTTP port, for security reasons, so that the only communication channel will be on
TLS and encrypted.

1. Edit the server.xml file located in <installation_dir>/central/tomcat/conf/server.xml.

2. Locate the HTTP connector, and delete or comment out the line.

3. Import the trusted root certificate authority (CA) to the Central client.truststore file, if it doesn't already
exist in the CA list:

keytool -importcert -alias <any_alias> -keystore <path to the client.truststore> -file <certificate_name.cer> -
storepass <changeit>

Note If you are using a well known root CA (like Verisign) you do not have to
perform this step, because the certificate will already be in the
client.truststore file.

4. Save the file.

5. Restart Central.

Note It is also possible to disable the HTTP port during installation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 513
Robotic Process Automation 2019.11

Configure the secured properties


When RPA Workflow Designer is installed, decisions are made which may affect security. When the LWSSO
initialization string is set, a decision is made on whether to keep the HTTP port open, and a proxy may have been
configured. If you need to change these decisions after installation, you can adjust the parameters in the
secured.properties file.
For example, an administrator might decide to harden the configuration and close the HTTP port. In this case, you
will need to set the secure flag for the CSRF cookie.
In the secured.properties file, you can configure the size limit of content packs that can be uploaded to RPA
Workflow Designer. The default size limit is 200 MB (the exact size limit is 209715200 bytes). However, you may
want to adjust this to protect against DOS (Denial of Service). You can also configure the number of content packs
that can be uploaded in parallel, and the number of content packs that can be created in parallel.

1. Open the secured.properties file, located in <installation_dir>/designer/var/security/.

2. If you need to close the HTTP port, make sure that the is.secured.cookie property is activated, as follows.

is.secured.cookie=true

Setting the is.secured.cookie property to true adds a secured attribute to the CSRF cookie. This the default
when RPA Workflow Designer is installed with no HTTP connection. However, if RPA Workflow Designer was
installed with an HTTP connection and you want to harden the installation later, you can change this property
to true.

NOTE: This should be set to true only when HTTP is disabled. Setting it to true
when HTTP is enabled will prevent the users from working in HTTP.

To close the HTTP port, you also need to complete the steps described in Change and disable the HTTP or
HTTPS ports topic.

3. To verify that the LWSSO initialization string is encrypted, enter the encryption string in the lwsso.initString
property. This string must be at least 12 characters in length and must be the same LWSSO initialization
string that is used by the embedding application.

4. To adjust the number of content packs that can be created in parallel across the system (for all users),
update the value of the max.parallel.cp.creation property. (The default is 30).

5. To adjust the number of content packs that can be uploaded to RPA Workflow Designer in parallel, update the
value of the max.parallel.cp.upload property. (The default is 50).

6. To adjust the size limit of content packs that can be uploaded to RPA Workflow Designer, update the value of
the upload.max.fileSize.limit property.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 514
Robotic Process Automation 2019.11

7. Restart RPA Workflow Designer.

Related topics
To change and disable HTTP or HTTPS ports, see Change and disable the HTTP or HTTPS ports

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 515
Robotic Process Automation 2019.11

Set SSL configuration properties


Setting SSL configuration properties affects secured communication with external apps\services such as git server
and RPA Central.
Supporting Self-signed Certificates
Self-signed certificates are user generated certificates that have not been signed by a well-known CA and are,
therefore, not guaranteed to be authentic. While self-signed certificates can be useful for some testing scenarios,
they are not suitable for production use. For more information, see
https://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html.
To allow the RPA Workflow Designer server accept work with self-signed certificates, the ssl.support-self-signed
property must be enabled (in the designer-wrapper file). This property is enabled by default.
Host Name Verification
Host name verification ensures that both the host name in the URL and the host name sent back by the server in
the digital certificate match. By default, host name verification is enabled, and we recommend enabling this in a
production environment to prevent man-in-the-middle attacks.
To disable this verification, you can set the ssl.verifyHostname property to false.

1. Open the designer.wrapper.conf file, located under <installation dir>/conf/ .

2. Add the ssl.support-self-signed and the ssl.verifyHostName properties to the designer.wrapper.conf


file.

3. If you set the ssl.support-self-signed value to true the RPA Workflow Designer server will allow work with
self-signed certificates.

4. If you set the ssl.verifyHostName value to false, this disables the verification of host name matching
between the URL and the certificate.

5. Restart RPA Workflow Designer.

Related topics
To troubleshoot the HTTPS connectors in RPA Workflow Designer, see Troubleshoot the HTTPS connector
To troubleshoot multiple deployment requests for RPA workflow Designer, see Troubleshoot multiple deployment
requests

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 516
Robotic Process Automation 2019.11

Troubleshoot the HTTPS connector


If the server doesn’t start, open the wrapper.log file and look for an error in ProtocolHandler ["http-nio-8443"].
This can happen when Tomcat is initializing or starting the connector. There are many variations but the error
message can provide information.
All the HTTPS connector parameters are in the Tomcat configuration file located at
<installation>designer\tomcat\conf\server.xml.
Open the file and scroll to the end, until you see the HTTPS connector:

<Connector SSLEnabled="true" URIEncoding="UTF-8" allowTrace="false" clientAuth="false"


compression="on" keyAlias="tomcat" keyPass="changeit" keystoreFile="C:/Program Files/Micro
Focus/Robotic Process Automation Designer/designer/var/security/key.store" keystorePass="changeit"
keystoreType="JKS" maxSwallowSize="-1" maxThreads="200" port="8445"
protocol="org.apache.coyote.http11.Http11NioProtocol" scheme="https" secure="true"
sendReasonPhrase="true" server="RPADESIGNER" sslEnabledProtocols="TLSv1.2" sslProtocol="TLSv1.2"
truststoreFile="C:/Program Files/Micro Focus/Robotic Process Automation
Designer/designer/var/security/client.truststore" truststorePass="changeit" truststoreType="JKS"/>

Check if there is any mismatch in the parameters, by comparing them to the parameters you entered in the
previous steps.

Related topics
To change or disable HTTP or HTTPS ports, see Change or disable the HTTP/HTTPS ports

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 517
Robotic Process Automation 2019.11

Troubleshoot multiple deployment requests


Sending multiple deployment requests can block and even slow down the whole system. In the
secured.properties file, located in <installation_dir>/designer/var/security/, the value of the
max.parallel.cp.creation key limits the number of simultaneous CP deployments to RPA Central (the key refers
only to parallel CP creation; for CP deployments to RPA Central there is a different parameter:
max.parallel.cp.upload with the default value =50). The default is 30. If users get errors that the limit was
reached, the administrator should consider increasing this value.
This behavior might also be used by an attacker together with automated tools in order to create a DoS attack on
the system and prevent legitimate users from using it. In such a case, the administrator should identify the
malicious IP address/domain and block it.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 518
Robotic Process Automation 2019.11

Promote content packs

. The Op Admin is usually the one responsible for promoting content packs.
This topic includes the following topics.

Overview of promoting content pack


Deploy and manage content packs
Manage the flow library
View a flow graph
Set up configuration items for a content pack
Test and troubleshooting a content pack

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 519
Robotic Process Automation 2019.11

Overview of promoting content pack

What is promotion?
Promotion is the process of deploying OO content packs across several environments, in order to ensure that
results are predictable and without (unknown) risks. This is in particular important for maintaining a stable
production environment that contains content that has been tested and validated prior to deployment.
For example, deploying the content pack on the following RPA Central environments: Development, QA, Staging,
Production.
The final aim of promotion is to deploy a new content pack to the RPA Central Production server, to make the flows
available to users.

Is promotion the same as deployment?


Deployment is part of promotion. However, the promotion process also includes other tasks, such as:

Configuring the content pack: configuring worker group aliases, mapping system accounts, and so on
Testing and troubleshooting the flows in the content pack

What is a content pack?


A content pack is a file containing operations, flows, actions, and configuration items. When flow authors complete
a project, they package it into a content pack for promotion on the Central server.

CloudSlang operations use actions that are Java-based or python-based.


Native OO operations use actions that are Java-based or .Net based.

When do you promote a content pack?


You promote a content pack when:

There is a need for new content in the Production environment.


You have fixed a bug in a flow and need to upload the new version of the flow to the Production environment.
You need to add new functionality to an existing flow in the Production environment.
You are upgrading to a new version of an out-of-the-box content pack.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 520
Robotic Process Automation 2019.11

Who does the promotion?


The promotion process in each of the environments is slightly different and may be done by a different persona.
However, in most cases, it is the Op Admin who is responsible for promotion.
The person doing the promotion must be assigned a role with View Content Packs and Manage Content Packs
permissions.
For more information, see the Best practices for OO content promotion document, available on ITOM Marketplace.

What is a content pack patch?


A content pack patch is used when a content pack has already been promoted on the Central server, and then
modifications were made in the project in RPA Workflow Designer. By deploying a patch, the Op Admin only
replaces the files that were modified, and does not have to replace the entire content pack with a new version.
For example, a flow author creates a content pack called MyCP1.0, which contains a large number of flows and
operations. The Op Admin promotes this content pack to the Staging server. However, there are problems with
three of the flows. The flow author fixes the problematic flows and creates a new content pack called MyCP1.2-
patch, which contains only the three modified flows. When the Op Admin deploys MyCP1.2-patch, the three flows
on the Staging server are overwritten with the new versions.

Promotion steps

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 521
Robotic Process Automation 2019.11

Note This is just a high level look at the Central workflow, and there are many
options that are not described here. For more detailed information about any of
the steps, use the links to learn about the options in-depth.

Step 1: Get the Content Pack From the Flow Author

1. The Flow Author creates a content pack or a content pack patch in RPA Workflow Designer.

2. The Flow Author saves the content pack to the Artifact Repository.

3. The Flow Author shares the content pack with the Op Admin/Promoter.

Step 2: Deploy to a non-Production Server

1. The Op Admin receives the content pack from the Flow Author.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 522
Robotic Process Automation 2019.11

2. The Op Admin deploys the content pack on the a non-Production server, for example, the Staging server.

Step 3: Configure the Content in the Content Pack


In this step, the Op Admin adjusts the content pack to the environment by configuring the content in it.

1. The Op Admin sets the content permissions on the flows.

2. The Op Admin sets the persistence level and run timeout for the flows.

Step 4: Set up the Configuration Items in the Content Pack


In this step, the Op Admin adjusts the content pack to the environment by setting up the configuration items in it.

1. If the content pack includes system and system properties, the Op Admin assigns values to these in the
content pack.

2. The Op Admin maps the aliases of the worker groups to actual worker groups.

Step 5: Test and Troubleshoot the Flows in the Content Pack

1. The Op Admin runs each flow from Content Management > Flow Library and checks whether it runs
properly.

2. If a flow run fails, the Op Admin can drill down into a flow to identify the problems.

Step 6: Deploy to the Production Server

1. If required, the Op Admin adjusts the configuration of the content pack, for the Production server. For
example, it may be necessary to map the worker group aliases and system accounts differently for this
server.

2. Finally, the Op Admin deploys the content pack to the Production server.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 523
Robotic Process Automation 2019.11

Related topics
To deploy and manage content packs, see Deploy and manage content packs.
To manage a flow library, see Manage the flow library.
To set up configuration items for a content pack, see Set up configuration items for a content pack.
To track and mange flow runs, see Track and manage flow runs.
To test and troubleshoot flow runs, see Test and troubleshoot a flow run.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 524
Robotic Process Automation 2019.11

Deploy and manage content packs

In the Content Packs tab, you can deploy content packs to the RPA Central environment. For example,
Development, Testing, Production. Deployment is performed at least twice in the promotion process.
It is recommended to deploy the base content pack before deploying your own content packs.

Reference material

Deploy new content dialog box

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 525
Robotic Process Automation 2019.11

Content packs tab

GUI item Description

Click the Deploy button to open the Deploy New Content dialog box.

Deploy button

Click the Roll Back button to roll back to the last deployment.

Roll Back button

Click to delete the selected content pack.

Delete button

Click to remove the filters and display all the content packs.

Clear Filters button

Click to display and compare statistical information about all deployed content
packs.
Statistics button

Select Columns button Click to display the column picker, to choose which columns to display.

Click to remove the filters and display all the content packs.

Clear Filters button

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 526
Robotic Process Automation 2019.11

GUI item Description

Filters Enter a content pack name or the name of the user who deployed it, or part of a
name, to filter the displayed content packs.

Version column Displays the version number of the content pack.

Deployed column Displays the time and date when the content pack was deployed.
Note If the content pack was deployed during the current day, only the time of day
is displayed.

Deployed By column Displays the user who deployed the content pack.

Content tab Click the Content tab to display the details of the selected content pack. This
information includes the:
• Version
• Publisher
• Certification- the digital signature of the content pack, verifying that the
content pack was created by a known sender and that it was not altered in transit
• Description
• Deployed By - the user who deployed the content pack
• SCM Tag - from the source control management system in RPA Workflow
Designer
• SCM Revision - this is available only for a content pack that was created in a
RPA Workflow Designer that is connected to SVN
Under What's Inside, the entities inside the content pack are arranged in a tree,
under Library and Configuration folders, reflecting the way that the content
pack appeared in RPA Workflow Designer. You can drill down into the folders and
see exactly which items exist in the content pack.

Changes tab Click the Changes tab to display the changes that have been made to the
selected content pack. This information tells you which items have been added,
deleted, updated, or moved.
For CloudSlang Content Packs, you can also view Descriptions.***
For an item that has been moved, hover the mouse over the item to see where it
has been moved from.

Statistics tab Click the Statistics tab to display statistical information about the selected
content pack.

Use the Open/Close button in the slider on the left edge of the Details pane to
toggle between hiding and displaying the pane.

Open/Close button

Content packs tab - changes pane

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 527
Robotic Process Automation 2019.11

GUI item Description

Type Select one or more entity type to display only the changes relating to this type of entity. Options
are Flow, Operation, Configuration Item, or All.

Path Enter part or all of the path to display only changes to entities in a path containing this string.

Change Select one or more type of change to display only changes of this type. Options are Added,
Deleted, Modified, Moved, or Content pack moved.

Content packs tab - statistics pane

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 528
Robotic Process Automation 2019.11

GUI item Description

Monthly Usage bar chart See how many flows were run were using content from this deployed content pack
for each month since first use, compared with the total runs over the same period.
Roll over a month in the bar chart to see a pop-up with a summary of the total
number of runs for that month and the number of runs from the content pack.

Legend blocks Click to filter the display.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 529
Robotic Process Automation 2019.11

GUI item Description

Click to display more months, if not all are displayed onscreen.


Arrow buttons

Periodical Usage Select a time period, to see how this content pack usage fits into the percentage
(percentage) of all runs during the current month, previous month, quarter, half year, year, or in
total.

Periodical usage of all content packs dialog box

GUI item Description

Bar chart Compare the number of flows that were run from the different deployed content
packs over the selected period. Roll over the bar chart to see a pop-up with a table
showing the number of runs for each content pack during the selected period and the
total number of runs.

Periodical Usage Select a time period, to compare the number of runs of all deployed content packs
options over that period.

Legend blocks Click to filter the display.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 530
Robotic Process Automation 2019.11

GUI item Description

Click to display more content packs if not all are displayed onscreen.
Arrow buttons

View content pack details


After content packs have been deployed, they are displayed on the Content Packs tab.
If you had upgraded the application, the deployment time is not displayed for content packs that were deployed to
the previous version.
The Content tab on the right side displays more details about the selected content pack. This information includes
the version, publisher, description, digital signature details, the name of the user who deployed it, the Source
Control Management tag, SCM revision (for SVN), and the entities inside the content pack. The contents are
arranged in a tree, under Library and Configuration folders, reflecting the way that the content pack appeared in
Workflow Designer. You can drill down into the folders and see exactly which items exist in the content pack and
where they are stored. This includes flows, operations, and configuration items.

The Changes tab displays the changes that have been made to the selected content pack since the version that
was previously deployed on RPA Central. This information tells you which items have been added, deleted,
updated, or moved.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 531
Robotic Process Automation 2019.11

The Statistics tab displays statistical information about the selected content pack:

See how many flows were run were using content from this deployed content pack for each month since first
use, and compare this with the total number of all runs over the same period.
See how this content pack usage fits into the percentage of all runs during the current month, previous month,
quarter, half year, year, or in total.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 532
Robotic Process Automation 2019.11

You can also click the Statistics button in the toolbar to display and compare statistical information about all
deployed content packs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 533
Robotic Process Automation 2019.11

Content pack versions

You can deploy a content pack to a server multiple times, as the content is updated by flow authors, and new
versions of the content pack are created.
After a content pack has been deployed, it is possible to roll back to the last deployment version. This might be
useful if you find that there are problems with the flows in a new deployment.

Note When you roll back to the last deployment, you return the content to the
state that it was in before your most recent deployment. If the most recent
deployment involved multiple content packs, the rollback returns all of these
content packs to the state they were in, previously. Note also that you can only
roll back one version. You cannot roll back to earlier versions than the last one.

Deploy multiple content packs

A single user can deploy multiple content packs at once, by using the Add button in the Deploy New Content
dialog box.
However, it is not possible for two users to deploy content packs to the same RPA Central at the same time. If you
try to deploy content to RPA Central while another user is already deploying content, you will see an error
message, indicating that another deployment is currently in progress.

Split a content pack deployment


After a content pack has been deployed, it is possible to split the original content pack into two or more parts in
RPA Workflow Designer and deploy each of these separately. Note that if one of these smaller content packs has
the same name as the one that was originally deployed, it will overwrite the original one on the RPA Central server.
If it has a different name, it will be deployed alongside it.

Validate the digital signature on the content pack


A valid digital signature on a content pack verifies that the content pack was created by a known sender and that it
was not altered in transit.
During the upload process, before deployment, RPA Central checks that content packs with digital signatures have
not been altered or expired, and displays the details of the certificate.

Note RPA verifies the following common signature types: .DSA, .RSA, .EC, .SF

If a signed content pack has been altered, that content pack cannot be deployed. If the signature has expired, the
content pack can be deployed only if you select a check box agreeing to ignore this expiry.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 534
Robotic Process Automation 2019.11

The scenarios for signatures are the following:

The out-of-the-box content packs created by RPA are signed with the private key.
When you buy a content pack from a content pack vendor, the vendor uses an official certificate authority (CA)
certificate.

If the signing authority is not already in the RPA Central TrustStore, you will need to import the CA certificate into
it, in order to enable RPA Central to verify the content pack's certificate.

When RPA authors create content packs in-house, they need a CA private key to be able to add a signature to a
content pack. You can request this certificate from a company such as VeriSign, for example. It is also possible to
use a self-signed signature, but this is not recommended, for security reasons.

a. The promoter adds a digital signature to the content pack, using an external signing tool, such as Java
JarSigner.

b. The administrator adds the trusted root certificate authority (CA) into the RPA client.truststore file
(under central/var/security). In a cluster, import the CA to the client.truststore file for all nodes.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 535
Robotic Process Automation 2019.11

Security Note: It is recommended to verify the digital signature of a content pack manually using well known
tools before importing it into RPA Workflow Designer.

Validate the dependencies on the content pack


During the upload process, before deployment, RPA Central checks whether the content pack has any
dependencies. If you are deploying a content pack that uses elements (for example, operations or properties) that
are in a different content pack, the content pack that you are deploying will have a dependencies file that points to
this other content pack.
However, what happens if any of these items were deleted from the other content pack, and the new version of
this content pack has been deployed in your environment? If this occurs, the content pack that you are now trying
to deploy will have missing dependencies, and this could cause the deployment to fail.
If there are missing dependencies, RPA Central displays a warning icon in the Deploy New Content dialog box and
displays the expected version of the content pack that contained these dependencies. This gives you an
opportunity to add the expected version of this content pack to the deployment, so that the deployment of the
content pack that depends on it will be successful.
Note: You have an option to continue with the deployment without adding the dependencies.

Validate duplication of the content pack


During the deployment process, RPA Central performs a complete path validation for all elements that have a
unique path on RPA Central (such as flow, group alias, domain term, system property, system account, and
selection list).
If there are any duplications of these elements (either within the deployment unit, or within previously deployed
entities), an error message is displayed, listing the duplications.

Validate structural integrity of the content pack


During the deployment process, RPA Central validates the content packs to make sure that the structural integrity
of the deployed content is intact.
Checking the structural integrity includes checking that there are no missing references, there are no duplicate
UUIDs, the flows in the content packs are correctly formed, and there are no duplicate flow paths or duplicate
system property names.
For example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 536
Robotic Process Automation 2019.11

Deploy content pack after making changes


Each entity (flow, operation, and configuration item) in deployed content packs must have a unique UUID. If you try
to deploy a content pack with a duplicated entity (with the same UUID as an entity in another deployed content
pack), the deployment will fail.
If you move an entity from one content pack to another, this may result in a duplication, which will cause
deployment to fail. For example, you have two content packs, A and B. You deploy content pack A to RPA Central,
and then you move entity X from A to B. When you try to deploy content pack B, the deployment will fail because
entity X appears in both A and B.
In such a situation, the correct workflow is to deploy both A and B together after moving the entity, and not to
deploy B on its own. The new version of A, without entity X, overwrites the previous version on RPA Central, so
there is no duplication.
When you want to promote content from one RPA Central environment to another, you will only need to deploy all
of the latest versions of the content packs that were deployed in the original RPA Central environment.

Deploy a content pack


When you deploy a content pack, RPA checks the content pack for a digital signature.

If a content pack with a digital signature has been altered, this content pack cannot be deployed.
If the signature has expired, you will need to select the Ignore expiry of digital signature check box in order
to deploy the content pack.
If there is no digital signature on the content pack, you can deploy it, but a warning is displayed, because there is
no verification that the content pack was created by a known sender and that it was not altered in transit.
If a content pack is signed, but the signature is not from a known and trusted authority, you can still deploy it.

1. Click the Content Management button to display the Content Management workspace.

2. Under the Content Packs tab, click the Deploy New Content button.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 537
Robotic Process Automation 2019.11

3. In the Deploy New Content dialog box, click the Add button.

4. Browse to and select one or more content packs, and then click Open.

Tip You can also drag-and-drop a content pack from your file management
system into the Deploy New Content dialog box.

5. During the upload process, RPA verifies the selected content packs. Icons next to the content packs indicate if
there are any issues with their certification.

Select a content pack to display its certification details.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 538
Robotic Process Automation 2019.11

If a content pack appears with a Delete icon , this content pack cannot be deployed. You need to click

the Delete button in the toolbar to remove this content pack from the dialog box.

For example, a content pack whose digital signature has been altered cannot be deployed.

If a content pack appears with a Warning icon , this content pack can be deployed, but there is
information you need to check about it.

For example, the signature has expired. In this situation, you need to select the Ignore expiry of digital
signature check box in order to deploy the content pack.

If a content pack appears with an OK icon , this content pack is okay to be deployed.

If a content pack has no digital signature, and appear with a None icon you can deploy the content
pack, but be aware that there is no verification of the content pack.

6. Repeat Steps 3 - 5 to add more content packs to the Deploy New Content dialog box, if desired.

7. Click Deploy.

The deployment may take a few minutes. A progress bar displays the progress of the deployment, showing
when each step is completed.

Note It is not possible for two users to deploy a content pack to the same RPA
Central at the same time. If you try to deploy content to RPA Central while
another user is already deploying content, you will see an error message,
indicating that another deployment is currently in progress.

If deployment was successful, an icon indicating success is displayed in the dialog box and you can click
Close.
If deployment fails, messages are displayed, describing the causes of the failure.

For example, a content pack will fail deployment if it lacks structural integrity (for example, missing
references, duplicate UUIDs, duplicate flow paths, duplicate system property names).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 539
Robotic Process Automation 2019.11

If the deployment failed, especially in the case of dependency failure, you can click the Back button to
return to the Deployment page. There, you can verify the dependency data, clear the pane, upload all
required content packs, and try again.

8. Click Close to close the dialog box.

Rollback to the last deployment


After a content pack has been deployed, it is possible to rollback to the last deployment. This might be useful if you
find that there are problems with the flows in a new deployment. However, If you rollback after a content pack has
been deleted, this will undo the deletion.

1. Click the Content Management> Content Packs tab.

2. Select a content pack and click the Roll Back Deployment button.

3. Choose a specific content pack version, and then click OK in the confirmation dialog box.

Delete a deployed content pack


1. Click the Content Management > Content Packs tab.

2. Select a content pack and click the Delete button.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 540
Robotic Process Automation 2019.11

3. Click Delete in the confirmation dialog box.

Export content packs


1. Navigate to System Configuration>System Settings>Content Pack and select Export Content Pack
checkbox. The functionality is enabled.

2. Click the Content Management > Content Packs tab.

3. Select a content pack, and then click the Export Content Pack button. The content pack is downloaded
onto your local machine.

Filter content packs


1. Click the Content Management > Content Packs tab.

2. In the filter box under CP Name or Deployed By, enter a content pack name, or part of a name, to filter the
displayed content packs.

3. To remove the filter, click the Clear Filters button.

Display details of a selected content pack


1. Click the Content Management > Content Packs tab.

2. Select a deployed content pack from the list.

3. Click the Content tab in the Details pane, to the right.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 541
Robotic Process Automation 2019.11

4. View the displayed details about the version, publisher, signature, SCM tag, SCM revision (for SVN),
description, and the user who deployed it.

5. See how the entities in the content pack are arranged in a tree, under Library and Configuration folders.

6. Expand and collapse the nodes to see the contents of different folders within the content pack.

7. Clear the check box next to the name of a content pack to remove its details from the Details pane.

Display changes that were made to a selected content


pack
1. Click the Content Management > Content Packs tab.

2. Select a deployed content pack from the list.

3. Click the Changes tab in the Details pane, to the right, to see which items have been added, deleted,
updated, or moved in the content pack.

For an item that has been moved, hover the mouse over the item to see where it has been moved from.

4. If desired, you can filter the changes so that only certain types of changes are displayed:

Under Type, select one or more entity type to display only the changes relating to this type of entity.
Options are Flow, Operation, Configuration Item, or All.
Under Path, enter part or all of the path to display only changes to entities in a path containing this string.
Under Change, select one or more type of change to display only this type of change. Options are Added,
Deleted, Modified, Moved, or Content pack moved.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 542
Robotic Process Automation 2019.11

Adjust the display of panes


Use the open/close button in the slider on the edge of the panes to toggle between hiding and displaying the pane.
Drag the slider to adjust the size of a pane.

View statistics about an individual content pack

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 543
Robotic Process Automation 2019.11

1. Click the Content Management > Content Packs tab.

2. Select a deployed content pack from the list.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 544
Robotic Process Automation 2019.11

3. Click the Statistics tab in the Details pane, to the right.

4. In the Monthly Usage section, see how many flows were run were using content from this deployed content
pack for each month since first use, compared with the total runs over the same period.

a. Roll over a month in the bar chart to see a pop-up with a summary of the total number of runs for that
month and the number of runs from the content pack.

b. Click the arrows to display more months, if not all are displayed onscreen.

c. Click the Legend blocks under the bar chart to filter the display.

5. In the Periodical Usage (percentage) section, select a time period, to see how this content pack usage fits
into the percentage of all runs during the current month, previous month, quarter, half year, year, or in total.

There may be a delay of 10-20 minutes between the time that a flow is run and when it is reflected in the statistics.

View statistics about all deployed content packs

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 545
Robotic Process Automation 2019.11

1. Click the Content Management > Content Packs tab.

2. Click the Statistics button in the toolbar to display the Periodical Usage of all Content Packs dialog box.

3. Select a time period, to compare the number of runs of all deployed content packs over that period.

4. Click the Legend blocks under the bar chart to filter the display.

5. Roll over the bar chart to see a pop-up with a table showing the number of runs for each content pack during
the selected period and the total number of runs.

6. Click the arrows to display more content packs if not all are displayed onscreen.

7. Click anywhere outside the dialog box to close it.

Related topics
To know more about importing certificate, see Encrypt the communication using a server certificate.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 546
Robotic Process Automation 2019.11

Manage the flow library

After a content pack has been deployed, you can see the flows inside it in the Flow Library. From here, you can
browse or filter flows, to find the one that you need. You can view the flow meta data, view reports about the last
time that a flow was run, configure persistence level and run timeout, and set the content permissions.
You will only be able to edit the settings here if you have a role with the Manage Content Settings permission.
To access the Flow Library, click Content Management > Flow Library tab. The icons of CloudSlang flows and
Native flows are different.
When you select a flow in the flow library, information about that flow is displayed in the information pane to the
right.
This information includes a description of the flow, if one exists, the path to the location where the flow is stored,
the flow version, UUID, and ROI.

Configuring the Flow Run Settings for Flows

Flow run settings let you control the persistence level and timeout for the selected flow.

Persistence Level defines the level of detail that is saved to the Run Log for the flow. You can choose an
extended or standard level, or use the system default.

Timeout defines how long (in minutes) a flow can run before it is canceled and shows the status Canceled-
Timeout Expired. You can set up a custom timeout setting for the flow, use the system default, or set this flow
to have no timeout.

The timeout setting applies to both triggered and scheduled flow runs.
If you change the timeout value of a flow, this change is applied to new flow runs, but not to those that are
already running.
The timeout setting applied to a flow overrides the system default and is applied even if the system timeout
is not enabled.

Note If a timeout setting was defined for an operation inside a flow, the timeout
assigned for the flow is not affected. The flow timeout is triggered according to

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 547
Robotic Process Automation 2019.11

its value, regardless the values of the timeout values of the steps inside the flow.

Auto-resume on status "Paused - No Workers in Group” defines if flow execution should automatically
resume when a worker is available in the group in which the flow is required to be run. There are three available
options for this execution:

System setting default values are executed first which is the global setting.
If Enabled, all runs of this flow are automatically resumed.
If Disabled, none of the runs of this flow are automatically resumed.

Note Flow runs that were launched before with different settings for the Auto-
resume option will not be affected by the new Auto-resume settings.
Manipulating the Auto-resume option for flows will affect only runs triggered
after the Auto-resume option has been set.

Set permissions for content


Content permissions let you restrict access to data (flows and folders) according to the roles that have been
assigned to users. This should be done as part of the promotion of a content pack.
You can entitle a role to have either view permission or run permission, or both, for a flow or folder. For example,
you might want to give users with the role Promoter permission to view and run the contents of a selected folder,
and give users with the role End User permission to view the content only.

Note To modify the content permissions, you must be assigned a role with
Manage Content Settings permission.

If you set the content permissions of a folder and apply the change to all children, these permissions will apply to
all the flows within that folder. It is also possible to set the permissions of the entire library.
By default, only roles with permissions are displayed. However, you can select the Show all roles check box to
display all the roles, including those that do not have permissions for the content.

Note Content permission is not the same as restricting the actions that RPA users
are allowed to perform in the system. This is done via Role-Based Access Control
(RBAC).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 548
Robotic Process Automation 2019.11

Reference Material

Flow Library pane

GUI item Description

Filter By To locate the flow that you need, enter part or all of the flow path in the Filter By text
box to filter the flows.

Run button Click to run the selected flow.

Schedule button Click to open the Schedule Flow dialog box.

Last Run Report Displays the details about what happened the last time that the selected flow was run.
button The Last Run Report button is only available for flows that have been run at least
once.

Open Graph Button Click the Open Graph button to display a graphical representation of the flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 549
Robotic Process Automation 2019.11

GUI item Description

ID Displays the ID of the selected flow.


• Native flows IDs have a UUID format. The UUID is unique.
• CloudSlang flows, operations and system properties IDs have the
<namepace>.<name> format.
Note The recommended best practice is that the namespace is part of the path and that
the name is the filename, but this is not required. The name and namespace are
defined inside the yaml file. The id (<namespace>.<name>) must be unique in the
system.
The filters in the Flow Library use the flow path. So if you don’t use the best practice,
when you use the filter, using flow name/namespace will not work.
For example, in the element user.flows.hello_world, the namespace is the folder path
user/flows and the element name is hello_world.

Path Displays the path to the location of the selected flow.

Content Pack Displays the content pack that the selected flow came from.

Version Displays the version number of the selected flow.

Run Link You can embed parts of the Central UI into an external application.

Description Displays a description of the selected flow. If required, use the scrollbar to scroll down
and view the contents of the Description section.

Input Displays the input information for CloudSlang flows only.


Note This field may be encrypted as configured by the flow creator.

Output Displays the output information for CloudSlang flows only.


Note This field may be encrypted as configured by the flow creator.

Persistence Level From the Persistence Level list, select the persistence level for the flow. The options
are:

Standard - Includes raw results, step results, and big inputs/outputs.

Extended - Includes the complete raw results, step results, subflow outputs (from step
results), and big inputs/outputs.

Taken from system default - whatever was selected as the default persistence level.
Note It is possible to override a flow's persistence level, when running or scheduling a
flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 550
Robotic Process Automation 2019.11

GUI item Description

Timeout (minutes) Enter the timeout setting, so that a flow run will be canceled if it exceeds this duration.
The options are:
• Taken from system default - whatever was selected as the default timeout setting
for the system is applied for this flow.
• No timeout (this flow only) - no timeout will be applied to this flow, even if a
default timeout has been set for the system.

Custom (this flow only) - lets you specify a timeout for this flow. Enter a number
larger than 0, to set the number of minutes for the timeout setting.
Note A custom timeout setting overrides the system default timeout setting and is
applied even if the system timeout is not enabled.

Permissions Displays the permissions that have been set for this flow or folder, for each role that has
been defined in the system:
• Displays View if users with the adjacent role have permission to view this flow (or the
contents of this folder) in Central.
• Displays Run if users with the adjacent role have permission to run this flow (or the
contents of this folder) in Central.
The display of roles in this section corresponds to the roles that have been defined in
the system.

Edit Click to open the Edit Permissions dialog box for the selected flow or folder.

Show all roles By default, only roles with permissions are displayed. However, you can select the
Show all roles check box to display all the roles, including those that do not have
permissions for the content.

Edit Permissions dialog box

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 551
Robotic Process Automation 2019.11

GUI item Description

View Select View to enable users with the selected role to view this flow (or the contents
of this folder) in Central.

Run Select Run to enable users with the selected role to run this flow (or the contents of
this folder) in Central.

Apply to children If you have selected a folder, select the Apply to Children check box to apply the
updated permissions to all the flows in the folder.

All Roles/Modified Roles Select whether to apply the changes to all the roles in the folder or to modified roles
only.

Save Click to save the changes to the permissions.

What do you want to do?

Display flow information

1. Click the Content Management button to display the Content Management workspace.

2. Click the Flow Library tab.

3. Expand the folders to look for the flow that you need.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 552
Robotic Process Automation 2019.11

4. (Optional) Enter part or all of the flow path in the Filter By text box to filter the flows.

For example, if you enter "network", only flows that contain the word "network" or which are located in a path
with a folder containing the word "network" are displayed.

Note The search is not case-sensitive.

5. Select a flow.

6. View the flow information, displayed in the information pane to the right.

7. If required, use the scroll bar to scroll down and view the contents of the Description section.

8. If required, use the sliders at the edges of the information pane to adjust the width and height of the pane.

9. (Optional) Click the Open Graph button to display a graphical representation of the flow.

Display information about the last time a flow was run

You can view the details about what happened the last time a flow was run.

1. Click the Content Management button to display the Content Management workspace.

2. Click the Flow Library tab.

3. Select a flow in the flow library.

4. Click the Last Run Report button. The Drill Down window opens, showing what happened the last time
this flow was run.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 553
Robotic Process Automation 2019.11

The Last Run Report button is only available for flows that have been run at least once in the current
session.
The information in the Drill Down window is the same as the information in the Run Explorer drill down view.

Set up content permission for a flow or folder

1. Select a flow or folder in the flow library.

2. In the Permissions section, click the Edit button

3. In the Edit Permissions dialog box, select the View and Run check boxes to assign permissions for the
selected role.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 554
Robotic Process Automation 2019.11

Select View to enable users with the selected role to view this flow or the contents of this folder in
Central.
Select Run to enable users with the selected role to run this flow or the contents of this folder in Central.

4. If you have selected a folder, you can select the Apply to Children check box to apply these permissions to
all the flows in the folder.

5. Click Save.

Set up the Run Log persistence level for a flow

By selecting the persistence level, you can control the level of detail that is saved to the Run Log for an individual
flow.

1. Select a flow in the flow library.

2. From the Persistence Level list, select the persistence level for the flow. The options are:

Standard - Includes raw results, step results, and big inputs/outputs.

Extended - Includes the complete raw results, step results, subflow outputs (from step results), and big
inputs/outputs.

Taken from system default - whatever was selected as the default persistence level.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 555
Robotic Process Automation 2019.11

Note It is possible to override a flow's persistence level, when running or


scheduling a flow.

Set up the timeout for a flow

When you assign a timeout value to a flow, if the flow run exceeds the specified duration, it will be canceled and
will show the status Canceled-Timeout Expired.

1. Select a flow in the flow library.

2. From the Timeout (minutes) list, select the timeout setting for the flow. The options are:

Taken from system default - whatever was selected as the default timeout setting for the system is
applied for this flow.
No timeout (this flow only) - no timeout will be applied to this flow, even if a default timeout has been
set for the system.
Custom (this flow only) - lets you specify a timeout for this flow.

3. If you selected Custom (this flow only), enter a number larger than 0, to set the number of minutes for the
timeout setting.

4. Click Save.

Related topics
To set up security for roles, see Set up security for roles.
To view a flow graph, see View a flow graph.
To test and troubleshoot a flow run, see Test and troubleshoot a flow run.
To monitor and control database size, see Monitor and control database size.
To set up general settings, see Set up general settings.
To embed RPA Central views in external web pages, see Embedding RPA Central views in external web pages.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 556
Robotic Process Automation 2019.11

View a flow graph

From the Flow Library or Flow Launcher, you can click the Open Graph button to display a flow graph
representing the flow. This is the same graph that existed in RPA Workflow Designer, when the flow was created.

Note This feature is not supported when the flow was written in CloudSlang. A
"not supported" message is shown when you click the Open Graph button.

Why View a Flow Graph?

In the promotion phase, the Op Admin can view the flow graph in order to better understand what the flow does
and which steps and outputs to expect.
In the execution phase, the End User can use the flow graph to get a clear picture of what the flow does and to
verify that this is the flow they need.
In the troubleshooting phase, the End User and Op Admin can use the flow graph to understand exactly which
series of steps caused a flow to fail.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 557
Robotic Process Automation 2019.11

Reference material

Flow graph elements

GUI item Description

An operation has a gray background.

Operation

Operations have predefined response icons, for “error”,“resolved”,


“diagnosed” and “no action”.

Responses

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 558
Robotic Process Automation 2019.11

GUI item Description

A non-blocking step does not block the rest of the flow. While it is
running, the flow run continues to carry out the steps that come
after it.
A non-blocking step appears with an orange lightning bolt.
Non-blocking

A subflow is a flow within a flow.


A subflow appears with a blue background.

Subflow

Response steps are end points for a flow.

Response steps

Transitions between steps have labels, color-coded using the same


colors as the response steps.

Transitions

A gated transition restricts access to the next step to users who


have been assigned a particular role.
Gated transition
Gated transitions appear with a red arrow.

Handoff transition A handoff transition is one where a message appears, suggesting


that the current user hand off the flow run to another user.
Handoff transitions appear with a hollow arrow head.

Multi-instance step A multi-instance step can run multiple times, with multiple targets.
A multi-instance step resides within a multi-instance branch.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 559
Robotic Process Automation 2019.11

GUI item Description

Parallel Split Step A parallel split step is a set of step sequences that are carried out
simultaneously.
Each series of steps is represented visually in the flow diagram as a
lane.

Flow graph toolbar

GUI item Description

Click the Zoom In button to increase the zoom.

Zoom In

Click the Zoom Out button to decrease the zoom.

Zoom Out

Click to reset the view to the default size and position.

Reset button

What do you want to do?

Display a flow graph

1. Open either the Content Management > Flow Library or the Run Management > Flow Launcher.

2. Select the flow that you want to view.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 560
Robotic Process Automation 2019.11

3. Click the Open Graph button to display a flow graph representing the flow.

Adjust the zoom of a flow graph


When you display a flow graph, the zoom level is automatically adjusted so that the entire flow fits into the
window. However, you can increase or decrease this zoom level.

1. Display the flow graph for the selected flow.

2. Adjust the zoom levels:

Click the Zoom In button to increase the zoom.

Click the Zoom Out button to decrease the zoom.

Click the Reset button to reset the view to the default size and position.

Pan across a flow graph

1. Display the flow graph for the selected flow.

2. Roll your mouse over the flow graph so that the cursor changes to a hand icon.

3. Press down on the cursor and drag across the graph to move the display to a specific location on the graph.

Related topics
For an overview of promoting content pack, see Overview of promoting content pack
To deploy and manage content packs, see Deploy and manage content packs
To manage a flow library, see Manage the flow library
To set up configuration items for a content pack, see Set up configuration items for a content pack
To test and troubleshoot a content pack, see Test and troubleshooting a content pack

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 561
Robotic Process Automation 2019.11

Set up configuration items for a content pack

After a content pack has been deployed to a RPA Central server, the Op Admin may need to configure the
contents of this content pack, in order to adjust it to the environment. This includes setting up the:

System accounts - In many cases, content packs come with system accounts configured. For example, if you
are deploying a content pack for an Oracle database, it will include Oracle user accounts. You will need to create
RPA Central user names and map them to the system accounts in the content pack.

System properties - In many cases, content packs come with system properties configured. You may want to
override these properties in RPA Central. If a system account or system property was created via API, it is not
possible to edit it in the RPA Central UI. You can only edit it via API. In the Central UI, you can edit system
accounts and system properties that were created in a content pack in RPA Workflow Designer

Group aliases - If the content pack includes operations that have been assigned to group aliases, rather than
actual worker groups, you will need to map these group aliases to actual worker groups. If a group name and
alias name are the same, these are mapped automatically by default.

To access the configuration items, click the Content Management > Configuration Items tab. The
Configuration Items tab is only visible if you have been assigned a role with the Manage Configuration Items
or View Configuration Items permission. You will only be able to edit the items if you have a role with the
Manage Configuration Items permission.

Assigning permissions to a system account


You can assign permissions for system accounts. This enables the administrator to control which users can view
which system accounts and run (or resume) flows that use them. This feature is useful for customers with multiple
organizations, who may wish to hide some of the system accounts from some users.

Only users whose roles have View and Run permission on a system account will be able to view it in the
Configuration Items tree.
Only users whose roles have View and Run permission on a system account will be able to run a flow that uses
this system account at the flow level. If a user without permissions tries to run such a flow, it will fail with a
“Failed to Complete” status.
Only users with View and Run permission on a system account will be able to remote debug a flow that uses it,
from Studio.
You can assign permissions for multiple system accounts at once, by assigning permissions to folders.
If you do not specify the permissions, the system account inherits the permissions from its nearest parent.
When you move a system account, if it has permissions configured, these permission remain configured. If not, the
system account inherits the permissions from its nearest parent in the new location.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 562
Robotic Process Automation 2019.11

View information about configuration items


The configuration items are displayed in a tree, with icons representing the different types of item.
Next to the Configuration Items tree, two columns display the values of the items:

The Deployed Value column displays the original value of the configuration item from a deployed content pack.
The RPA Central Value column displays the new value, if the original value was overridden in RPA Central.

When you select an item in the Configuration Items tree, information about that item is displayed in the
information pane to the right. This information includes the ID of the item, the path to the location where the item
is stored in the content pack, a description, information about the content pack, and so on.
For system accounts, permissions are also displayed. By default, only roles with permissions are displayed.
However, you can select the Show all roles check box to display all the roles, including those that do not have
permissions for the account.
Deployed values and Central values
If you override the value of a configuration item in Central, the Deployed value and the Central value are
connected. If you move or rename a configuration item in RPA Workflow Designer and deploy it again, the Central
value is also moved or renamed.
If a configuration item is deleted during deployment, the Central value is not deleted from the database. It is
saved and is marked in gray in the Central UI. This helps you to avoid losing data. When you deploy the
configuration item again, it is connected to the saved Central value.
Path uniqueness for configuration items
Configuration items must be unique. If you deploy a configuration item in a folder containing a configuration item
with the same name, it will either overwrite that item (if they have the same UUID) or fail deployment (if it has a
different UUID).

Note However, it is possible to have two configuration items with the same name
if they are located in different folders.

System Accounts in Resumed Flows


When you resume a flow, RPA fetches the system account configuration from the current system. So if a system
account was changed between the time the flow was started and the time it was resumed, RPA takes the new

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 563
Robotic Process Automation 2019.11

system account value.

Reference Material

Configuration Items Tree

GUI item Description

Name Displays the name of the configuration item as it appears in the content pack.

Deployed Value Displays the original value as deployed to RPA Central.

RPA Central Value Displays the new value, which overrides the original value.

Depending on which configuration item is selected, opens the relevant dialog box, so that
you can edit the configuration item.
Edit button

Revert button Reverts the selected configuration item to its original deployed value, which was
overridden in RPA Central.

Delete button Deletes the selected configuration item.


It is possible to delete configuration items that have a Central value but not a Deployed
value.
It is not possible to delete a configuration item that is part of a content pack that is
deployed to RPA Central.

Edit System Account dialog box


The Edit System Account dialog box will vary depending on the permissions of the currently logged in user. For
example, if the logged in user is not entitled to assign permissions, the Permissions section is not shown in the
dialog box.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 564
Robotic Process Automation 2019.11

GUI item Description

Path Displays the path where the system account is located.

Deployed User Displays the user name of the system account, as defined in the content pack.
Name

User Name Enter the RPA Central value for the system account user name. This user name will be
mapped to the system account from the content pack, overriding the deployed user
name.

Password Enter the password for the user name.


Note If the Include system account passwords check box was selected when this
content pack was created in RPA Workflow Designer, the password is automatically
loaded into the Password box. You can change this value.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 565
Robotic Process Automation 2019.11

GUI item Description

Confirm Password Enter the password a second time, for confirmation.

View and Run Select the check box under View and Run for all the roles for which you want to assign
permission for this system account.
Only users with View and Run permission on a system account will be able to view it in
the Configuration Items tree or to run flows and operations that use this system account.

Edit System Account dialog box - Folder

GUI item Description

View and Run Select the check box under View and Run for all the roles for which you want to assign
permission for the system accounts in this folder.
Only users with View and Run permission on these system accounts will be able to
view them in the Configuration Items tree or to run flows and operations that use these
system accounts.

Apply to Children: All Select the Apply to Children check box and the All Roles option to apply these
Roles changes to all the system accounts in the folder, for all roles, including those that have
not been modified.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 566
Robotic Process Automation 2019.11

GUI item Description

Apply to Children: Select the Apply to Children check box and the Modified Roles option to apply these
Modified Roles changes to all the system accounts in the folder, but only for roles that have been
modified.

System Property Details dialog box

GUI item Description

Name Displays the name of the system property, as defined in the content pack.

Deployed Value If the system property had an original value in the deployed content pack, displays that
value.

Override Value Enter a value for the system property. If the system property had an original value in the
deployed content pack, this value will override it.

Group Alias Details dialog box

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 567
Robotic Process Automation 2019.11

GUI item Description

Alias Name Displays the name of the group alias as it appears in the content pack.

Worker Group Name Select the worker group to which you want to map this group alias.

What do you want to do?

Display configuration items in a content pack


1. Click the Content Management button to display the Content Management workspace.

2. Select Configuration Items.

3. In the Configuration Items tree, expand the folders to look for the item that you need.

4. (Optional) Enter part or all of the configuration item path in the Filter By text box to filter the items.

For example, if you enter "network", only items that contain the word "network" or which are located in a
path with a folder containing the word "network" are displayed.

Note The search is not case-sensitive.

5. Select a configuration item or folder and view the information displayed in the pane to the right.

6. If required, use the scroll bar to scroll down and view the contents of the Description section.

7. If required, use the sliders at the edges of the information pane to adjust the width and height of the pane.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 568
Robotic Process Automation 2019.11

8. In the case of a system account, you can also view the roles that are assigned View and Run permission for
the selected folder or account. By default, only roles with permissions are displayed. However, you can select
the Show all roles check box to display all the roles, including those that do not have permissions for the
account.

Note To add View and Run permission for a system account or folder, click

the Edit button.

Add configuration items to a content pack


It is not possible to add configuration items to a content pack in RPA Central. These should be created in RPA
Workflow Designer and deployed to RPA Central.

Edit a system account in a content pack


If a system account was created via API, it is not possible to edit it in the RPA Central UI. You can only edit it via
API.
In the RPA Central UI, you can edit system accounts that were created in a RPA Workflow Designer content pack.

1. Click the Content Management button to display the Content Management workspace.

2. Select Configuration Items.

3. Select the system account that you want to edit and click the Edit button.

The Edit System Account dialog box opens. This dialog box will vary depending on the permissions of the
currently logged in user. For example, if the logged in user is not entitled to assign permissions, the
Permissions section is not shown in the dialog box.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 569
Robotic Process Automation 2019.11

The Deployed User Name box displays the system account user name as it appears in the content pack, as
defined in RPA Workflow Designer.

4. In the User Name box, enter the RPA Central value for the system account user name. This user name will
be mapped to the system account from the content pack, overriding the deployed user name.

Note The user name does not have to be identical to the deployed user name.

5. In the Password box, enter a password for the user.

Note If the Include system account passwords check box was selected

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 570
Robotic Process Automation 2019.11

when this content pack was created in RPA Workflow Designer, the password
is automatically loaded into the Password box.

6. Enter the password a second time in the Confirm Password box.

7. In the Permissions section, select the check box under View and Run for all the roles for which you want to
assign permission for this system account.

Only users with View and Run permission on a system account will be able to view it in the Configuration
Items tree or to run or resume flows and operations that use this system account.

8. Click Save.

Edit permissions for a system account folder


You can assign permissions to a system account folder, which assigns those permissions to all the system accounts
in that folder.

1. Click the Content Management button to display the Content Management workspace.

2. Select Configuration Items.

3. Select a folder in the Configuration Items tree and click the Edit button.

4. In the Permissions section, select the check box under View and Run for all the roles for which you want to
assign permission for the system accounts in this folder.

Only users with View and Run permission on these system accounts will be able to view them in the
Configuration Items tree or to run flows and operations that use these system accounts.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 571
Robotic Process Automation 2019.11

5. Select the Apply to Children check box to apply these changes to all the system accounts in the folder.

Select All Roles to apply the changes to all roles, including those that have not been modified.
Select Modified Roles to apply the changes only to roles that have been modified.

6. Click Save.

Edit a system property in a content pack


If a system property was created via API, it is not possible to edit it in the RPA Central UI. You can only edit it via
API.
In the RPA Central UI, you can edit system properties that were created in a RPA Workflow Designer content pack.

1. Click the Content Management button to display the Content Management workspace.

2. Select Configuration Items.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 572
Robotic Process Automation 2019.11

3. Select the system property that you want to edit and click the Edit button.

The System Property Details dialog box opens.

4. In the Override Value box, enter a new value for the system property.

5. Click Save.

Assign a worker group to a worker group alias


1. Click the Content Management button to display the Content Management workspace.

2. Select Configuration Items.

3. Select the worker group alias that you want to edit and click the Edit button.

The Group Alias Details dialog box opens.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 573
Robotic Process Automation 2019.11

The Alias Name box displays the name of the alias that was used in the operations.

4. From the Worker Group Name list, select the worker group to which you want to map this group alias. If
you want to map the group alias to a group that does not exist yet, go to System Configuration >
Topology > Workers and create a new group, and then return to this task to do the mapping.

5. Click Save.

Revert configuration items to their original value


If someone has changed the value of a configuration item that was in the content pack at the time of deployment,
you can revert it to the original value.

1. Select the item and click the Revert button.

2. Click Yes in the confirmation dialog box.

Delete configuration items in a content pack


It is possible to delete configuration items that have a Central value but not a Deployed value.
It is not possible to delete a configuration item that is part of a content pack that is currently deployed to RPA
Central.

1. Click the Content Management button to display the Content Management workspace.

2. Select Configuration Items.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 574
Robotic Process Automation 2019.11

3. Select the configuration item that you want to delete and click the Delete button.

4. Click Yes in the confirmation dialog box.

Related topics
For an overview of promoting content pack, see Overview of promoting content pack.
To deploy and manage content packs, see Deploy and manage content packs.
To manage a flow library, see Manage the flow library.
To test and troubleshoot a content pack, see Test and troubleshooting a content pack.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 575
Robotic Process Automation 2019.11

Test and troubleshoot a flow

In this step, the Op Admin tests and troubleshoots the flows in the Staging server.

Test a content pack on the Staging server


1. Click the Content Management button to display the Content Management workspace.

2. Click the Flow Library tab.

3. Select the flow that you want to test, and click the Run button.

4. Monitor the progress of the run, and check whether it runs as expected.

5. To further test the flow, run it again, with the same or different parameters.

Related topics
For an overview of promoting content pack, see Overview of promoting content pack
To deploy and manage content packs, see Deploy and manage content packs
To manage a flow library, see Manage the flow library
To set up configuration items for a content pack, see Set up configuration items for a content pack

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 576
Robotic Process Automation 2019.11

Use
This section describes capabilities of each Robotic Process Automation (RPA) component.
The following image shows the general workflow involving all the components of RPA.

RPA capabilities can be used to run the following operations:

Author flows
Record activities
Promote content
Run and monitor flows

Author flows
The authoring process is performed by the Flow Author.

1. Create a new project: Create a project to contain the flows, operations, folders, and configuration items for
a business purpose.

2. Set up source control management: Set up Git source control management system.

3. Import a content pack: Import any content packs that you need, so you will be able to copy the relevant
content into your project. The first two steps do not have to performed in this order. It is possible to import a
content pack before creating the project.

4. Import existing UFT tests (optional): If you have existing automation UFT scripts, you can reuse them to
create new RPA activities. Migrating existing automation actions enables you to create RPA flows quicker.

5. Create a flow: Put together the operations, inputs, transitions, responses, and return steps that make up

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 577
Robotic Process Automation 2019.11

your flow.

6. Run and debug the flow: Validate your flow in the Debugger.

7. Release the content, packaged into a content pack: Package your project into a content pack,
containing the flows, operations, actions, and configuration items, in order to promote it to RPA Central.

Record activity
The recording process is performed by the Flow Author.

1. Create a new project: Create a project to contain the flows, operations, folders, and configuration items for
a business purpose.

2. Record an RPA Activity: Use Record new RPA Activity button to open the Recorder panel. This creates
two new entities: the Activity and a blank flow. Perform the set of actions that you want to record. The
Recorder panel is populated with each recorded step.

3. Stop recording: Once all steps have been recorded, use the button in the Recorder panel to stop the
recording. The recorded steps become visible in the RPA Workflow Designer Graphical Editor pane.

4. Edit activity steps: In the RPA Workflow Designer's Graphical Editor pane, you can assign value to step
inputs, outputs, and set them as sensitive.

5. Complete RPA flow: Drag the Activity onto the canvas of the RPA flow, and add the transitions to the flow
result steps.

Promote content
The promotion process is performed by the Op Admin.

1. Get the content pack from the flow author:

a. The Flow Author creates a content pack in RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 578
Robotic Process Automation 2019.11

b. The Flow Author saves the content pack to the Artifact Repository.

c. The Flow Author shares the content pack with the Op Admin/Promoter.

2. Deploy to a non-production server:

a. The Op Admin receives the content pack from the Flow Author.

b. The Op Admin deploys the content pack on the a non-Production server, for example, the Staging
server.

3. Configure the content in the content pack: In this step, the Op Admin adjusts the content pack to the
environment by configuring the content in it.

a. The Op Admin sets the content permissions on the flows.

b. The Op Admin sets the persistence level and run timeout for the flows.

4. Set up the configuration items in the content pack: In this step, the Op Admin adjusts the content pack
to the environment by setting up the configuration items in it.

a. If the content pack includes system and system properties, the Op Admin assigns values to these in the
content pack.

b. The Op Admin maps the aliases of the worker groups to actual worker groups.

5. Test and troubleshoot the flows in the content pack: In this step, the Op Admin adjusts the content
pack to the environment by setting up the configuration items in it.

a. The Op Admin runs each flow from Content Management>Flow Library and checks whether it runs
properly.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 579
Robotic Process Automation 2019.11

b. If a flow run fails, the Op Admin can drill down into a flow to identify the problems.

6. Deploy to the Production Server:

a. If required, the Op Admin adjusts the configuration of the content pack, for the Production server. For
example, it may be necessary to map the worker group aliases and system accounts differently for this
server.

b. Finally, the Op Admin deploys the content pack to the Production server.

Run and monitor flows


The process of running and monitoring flows is performed by the Op Admin or the end user.

1. Find the flow that you want to run: The Op Admin/End User locates the flow either from the Flow Library
or the Flow Launcher. Go to the Content Management>Flow Library module or to the Run
Management>Flow Launcher module.

2. Run the flow: The Op Admin/End User runs the flow. Alternatively, the Op Admin/End User schedules the
flow to run later.

3. Import a content pack: Import any content packs that you need, so you will be able to copy the relevant
content into your project. The first two steps do not have to performed in this order. It is possible to import a
content pack before creating the project.

4. Monitor the flow run: The Op Admin/End User tracks the flow run in the Run Explorer. If required, the Op
Admin/End User performs actions on flow runs, such as pausing, resuming, and canceling flow runs.

5. Troubleshoot the flow run: If required, the Op Admin investigates any problems with the run. Navigate
through the following topics to know how to use each of these components.

Navigate through the following topics to know how to use each of these components.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 580
Robotic Process Automation 2019.11

Use RPA Workflow Designer


Use RPA Central
Use RPA Self-Service X

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 581
Robotic Process Automation 2019.11

Use RPA Workflow Designer


This section shows how to set up your RPA Workflow Designer workspace and how to use RPA Workflow Designer
for authoring.

Log on
1. Enter the following URL into your browser address bar to launch RPA Workflow Designer:

https://<Local Host>:8445/oo-designer

You can access the application using a supported web browser, from any computer with a network
connection (intranet or Internet) to the servers. We recommend that you restore your browser to the
default settings.
2. Log on to RPA Workflow Designer as the admin user. Use the password you set during RPA Workflow Designer
installation configuration.

Log out
To log out of RPA Workflow, follow these steps:

1. Click the button the top right corner of the application and select Logout.

2. The application closes, and the LOGON screen is displayed.

Navigate RPA Workflow Designer


The RPA Workflow Designer User Interface includes several sections:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 582
Robotic Process Automation 2019.11

Projects Pane

The Projects pane on the top-left shows the project you are currently working on. It displays the editable flows,
RPA recordings, Operations and Configuration Items that you can use in the project.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 583
Robotic Process Automation 2019.11

Dependencies Pane

The Dependencies pane on the top-left shows the imported native and CloudSlang content packs . You can import
existing content packs and use its flows, operations and configuration items in your flows.

Authoring Pane

The Authoring pane is a rectangular box in the middle. It contains the canvas to work on flows. You can launch a
flow onto the canvas area by double-clicking a flow from the Projects pane.
If you are working on multiple flows, they are indicated in tabs with the corresponding flow names. Some of these
tabs are hidden from view and are displayed in the top-right corner of the authoring pane with a number indicating

a number of hidden tabs .


Click the arrow to view a list of hidden tabs, and then point and click to select a hidden flow to open.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 584
Robotic Process Automation 2019.11

You can close a flow by clicking the x displayed next to the flow name.

Properties Pane

The Properties pane contains the Description/Inputs/Outputs/Results tabs about the current flow.

Click the Inputs tab to display the Inputs pane. This is where you can add and configure inputs for the flow.
Click the Outputs tab to display the Outputs pane. This is where you can add and configure outputs for the
flow.
Click the Results tab to display the Results pane. This is where you can view the results for the flow, and also
configure the descriptions.
Click the Description tab to display the Description pane. This is where you can enter the description for the
flow.

Graph Pane

The Graph pane is the graphical representation of a flow with the Inputs and Outputs in tabs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 585
Robotic Process Automation 2019.11

Select the relevant step on the canvas, and:

Click the Inputs tab at the bottom of the right pane to display the Inputs pane. This is where you can view the
inputs for the step that correspond to the step operation inputs.
Click the Outputs tab at the bottom of the right pane to display the Outputs pane. This is where you can add
and configure outputs for the step.

Click the Go to source icon to identify the flow of the selected flow or activity.

Click the Save icon to save your authoring activities.

Click the Show as Text icon in the Authoring pane toolbar to view the CloudSlang code of the selected flow
or activity.

Click the Rename Step icon to rename the step or activity.

Click the Delete icon to delete your authoring activities.

Click the Drill Down into the Step icon to drill down within a step to see the details of the flow, decision, or
operation

Click the Create Loop icon to convert a step to a loop step.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 586
Robotic Process Automation 2019.11

Click the Toggle Worker Group icon to assign a step as a Worker Group.

Click the Cut icon to cut the flow, step, or an activity.

Click the Copy icon to copy the flow, step, or an activity.

Click the Paste icon to paste the flow, step, or an activity.

Click the auto-arrange icon from the authoring pane toolbar to reorganize the steps and results on the
canvas.

Click the zoom icon to expand the slider icon . Hover the cursor on the slider icon to view
the current zoom percentage, and press and drag on the slider to zoom-in or zoom-out of the canvas. To reset

the zoom, click .

Click to undo or redo action on a flow and to view list of historical actions of a flow.

Click and respectively to expand and collapse the Step Properties pane.

Click and respectively or drag the resize bars to expand and collapse individual panels.

Click and respectively to show or hide all panels.

Click to change the theme of RPA Workflow Designer to a default black background.
Warning: The theme change refreshes the application and you will lose unsaved progress.

Click to manage Workspace, Connection, Recorder, Record and Run settings of RPA Workflow
Designer.

Tip
The selected flows, success, and failures appear with a green outline.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 587
Robotic Process Automation 2019.11

Debugger Pane

The Debugger pane enables you to test the Flows and RPA activities locally.
To open the Debugger pane:

1. Select the relevant Flow or an RPA Activity on the canvas.

Note
By default, the Debugger pane is in a collapsed state.

2. Click or drag resize bar to expand or collapse the pane with the Run Tree that has
expandable nodes of the flow in a graphical mode.

3. Select a node in the tree to display the context of that Flow or RPA Activity in the Context Inspector

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 588
Robotic Process Automation 2019.11

SCM Pane

This is where you save your project in a centralized location and share content with other authors.

The resize bar from the SCM panel can be used to expand and collapse the pane:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 589
Robotic Process Automation 2019.11

Drag the resize bar of the default SCM pane upwards to expand the pane.
When the pane is expanded, drag the resize bar downwards to more than a minimum size to return to
its default state.

Click and to fully expand or collapse the SCM pane.

Related topics
To set up the workspace in RPA Workflow Designer, see Set up the workspace.
To set up and work with Source Control Management, see Set up and work with SCM.
To set up RPA workflow Designer project, see Set up the RPA Workflow Designer Project.
For instructions to import content packs, see Import Content Packs to the Dependencies Pane.
For information related to authoring in RPA Workflow Designer, see Author in RPA Workflow Designer.
For more information to author flows, see Author flows.
For information to author operations, see Author operations.
For information to author system properties, see Author System Properties.
For information to debug the flow, see Debug the flow.
For instructions to create and deploy a content pack, see Create and deploy a content pack.
For information on how to use external CloudSlang files in RPA Workflow Designer, see Use CloudSlang files
created outside RPA Workflow Designer.
For information on keyboard shortcuts, see Keyboard shortcuts.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 590
Robotic Process Automation 2019.11

Keyboard shortcuts
To enhance productivity and accelerate navigation and common repetitive actions, RPA Workflow Designer offers
keyboard shortcuts as alternatives to clicking buttons and selecting options in the UI.
The main operation key for shortcuts is Alt, together with one letter.

Tip Print this section for easy access to the keyboard shortcuts.

Global

Click OK Enter

Click Cancel Esc

Projects Pane

Open the selected tree node in the Authoring pane Enter

Copy the selected tree node Ctrl + C

Paste the selected tree node Ctrl + V

Delete the selected tree node Delete

Create a new project Alt + P

Create a new folder Alt + L

Create a new flow Alt + W

Create a new Python Operation Alt + O

Add RPA Activity Alt + R

Create a new system property Alt + S

Create a content pack Alt + C

Dependencies Pane

Import a content pack Alt + I

Graph Pane

Copy a selected step Ctrl + C

Cut a selected step Ctrl + X

Paste a selected step Ctrl + V

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 591
Robotic Process Automation 2019.11

Global

Redo an action Ctrl + Y

Undo an action Ctrl + Z

Debug Pane

Start debug Alt + F11

Cancel debug Alt + F12

Expand Tree pane Shift + SPACE

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 592
Robotic Process Automation 2019.11

Use IDM Admin


The IDM Administration provides the identity management (IDM) services for RPA Workflow Designer. It helps to
manage users, groups of each user and the Single sign-on (SSO) to allow users using the same user name and
password for multiple applications.
The IDM administrator is configured during installation of the RPA Workflow Designer.

Create users

To create new users, complete the following steps:

1. At the Log in page, enter your administrator user name and password, and then click Login.

2. At the right-top corner of the RPA Workflow Designer home screen, click the IDM Admin icon as highlighted in
the following image. The IDM Administration Console opens in a separate tab.

The link to IDM Admin icon is accessible only to the admin user configured at
the time of installation.

3. From the Organization List tab, and choose your organization.

4. The Overview displays the general information of the selected organization.

5. Select the Users tab, and then click + icon to add a new user.

6. In the User section, enter the details for the new user:

a. Enter your unique user name, display name, and password details in Name, Display Name, and
Password fields.

b. If you want to add user attributes for a user, click + icon under the User Attributes, and add
attributes such as Attribute Name and Value, and then click SAVE. The user attributes are added.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 593
Robotic Process Automation 2019.11

7. Click SAVE to complete creating a new user.

Edit user password

To edit an existing user:

1. Click the Users tab, and then choose the user that needs password change

2. Click from the tools menu.

3. Click RESET PASSWORD, and enter new password.

4. Click SAVE to complete resetting the password.

Delete users

To delete users:

1. Repeat steps 1 to 4 from "Create Users" topic

2. From the Users tab, select the user and then click to delete a user.

3. Click REMOVE in the "REMOVE USER" dialog box to delete the user.

Related topics
For information on how to set up workspace, see Set up the workspace.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 594
Robotic Process Automation 2019.11

Set up the workspace


Before you begin to use the RPA Workflow Designer, you must set up your workspace.
Setting up your workspace helps you to:

Allow multiple authors to collaborate on the same project.

Note If you do not want to use SCM, you can work on a local project. All changes
and modifications will be saved only in the database, and you will not be able to
recover or revert any of the changes.

Import Content Packs into the workspace to use the content in your projects.
Create one or more Projects.
Set up the System Properties for your projects.
The access to the workspace and the project in RPA Workflow Designer is user-specific. For example, if authors A
and B are using a common computer, and if A logs into the computer, only A's workspace and projects are
displayed.

Manage workspace
To set up the workspace:

1. On the top-right corner, click Settings button and then select Workspace option.

2. Under the Flow Editor tab:

a. Click Show Grid button to enable or disable. By default, Show Grid is enabled.

c. In the Zoom Value field, enter your preferred value. By default, Zoom Value is set to 100 percent.

e. Click Use Autosave button to enable or disable. By default, Use Autosave is enabled.

g. In the Autosave Interval field, enter your preferred interval time in minutes. By default, Autosave

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 595
Robotic Process Automation 2019.11

Interval is set to 10 minutes.

3. Under the Undo/Redo tab, In the Jump In History Limit field, enter your preferred value to view history of
your actions. By default, Jump In History Limit is set to 10 actions.

4. Click Save to save the Workspace settings or Cancel to stop the settings.

Related topics
For instructions to import a content pack, see Import Content Packs to the Dependencies Pane.
To set up the RPA Workflow Designer Project, see Set up the RPA Workflow Designer Project.
For instructions to author system properties, see Author System Properties.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 596
Robotic Process Automation 2019.11

Set up and work with source control management


If you work in a multi-author environment, working with a Source Control Management (SCM) enables you to
manage your project in a centralized location and collaborate on it with other authors. It also enables you to
recover or revert changes.
Using the Git functionality, you can connect to a remote repository on a server (such as Github, for example) or
connect to a shared file system.

Important
Working with SCM is not mandatory, but it is recommended.

You can attach only one repository per workspace. Within that repository, it is possible to have multiple projects.
When using SCM, prior to importing a repository, you must imported a dependent base content pack.

Git terminology
Pull changes
In Git, downloading the latest version of the files from the remote repository is known as a "Pull" action.
After you complete a "Pull" action, new files are added to your projects and files that were modified in Git are
updated in your project.
It is recommended to pull the latest version each day, before starting to work on the files.
Committ and push changes
In some Git applications, there are two steps to syncing your modified files into the repository: "committing" them
to a local repository in preparation for upload and "pushing" them to the remote repository.
In RPA Workflow Designer, there is a single action "commit and push", which you use to sync your files into the
remote repository.
Using the Git functionality, you can either connect to a remote repository on a server (recommended), such as,
Stash, or connect to a shared file system.
Why do this? If you work in a multi-author environment, working with a source control management tool enables
you to save your project in a centralized location and share content with other authors. It also enables you to
recover or revert changes.
In order to set up Source Control Management (SCM) for RPA Workflow Designer, you need to import a Git
repository to your workspace. There are several protocols that you can use to import the repository:

HTTPS (secured)
SSH (secured)
File System (not secured) - use this protocol if you do not have a Git server account

Note
If you already have an unversioned project in your workspace (i.e., saved locally
and not part of the Git repository), when you import a repository, this project will

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 597
Robotic Process Automation 2019.11

be added to your local version of the repository. You will be able to commit and
push this project to the remote repository.

Note
If the projects in the repository do not have the right structure, they will not
appear in the project pane and you will not be able to edit them in RPA Workflow
Designer.

Import a Git repository using the HTTPS protocol

1. In the Projects pane, click the Git button, and then select Import Repository.
The Import Git repository dialog is displayed.

2. Select HTTPS as the SCM protocol type.

3. In the Git URL field, enter the URL of the Git repository in the format:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 598
Robotic Process Automation 2019.11

https://<domain>/<username>/<repository_name>.git.

4. Enter your Email Address and Full Name.

5. Click Verify to check that the Git server you are connecting to is trusted.

6. After the verification is complete, enter your user name and password and click Import.

RPA Workflow Designer verifies that the repository exists in the location, and imports the repository.

7. When the import has been completed successfully. click Close.

The imported repository appears. All the projects in the repository are added to the Projects pane.

Import a Git repository using the SSH protocol

1. In the Projects pane, click the Git button, and then select Import Repository.

2. Select SSH as the SCM protocol type.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 599
Robotic Process Automation 2019.11

3. In the Git URL field, enter the URL of the Git repository in the format:
git@<domain>:<username>/<repository_name>.git.

4. Enter your Email Address and Full Name.

5. Click the Verify button.

6. After the verification is complete, the Generate button appears. Click Generate to create an SSH public key.

7. After the key has been generated, copy the key. For example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 600
Robotic Process Automation 2019.11

8. Go to your Git server and copy the SSH public key to your user account.

9. Go back to the Git Import Repository dialog box and click Import.

RPA Workflow Designer verifies that the repository exists in the location, and that authentication is successful
via the public\private key pair, and then imports the repository.

10. When the import is completed successfully, click Close.

The imported repository is displayed. All the projects in the repository are added to the Projects pane.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 601
Robotic Process Automation 2019.11

Import a AWS CodeCommit repository using the SSH


protocol

1. In the Projects pane, click the Git button, and then select Import Repository.

2. Select SSH as the SCM protocol type.

3. In the Git URL field, enter the URL of the AWS CodeCommit repository.

4. Enter your Email Address and Full Name.

5. Click the Verify button.

6. After the verification is complete, the Generate button appears. Click Generate to create an SSH public key.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 602
Robotic Process Automation 2019.11

7. After the key has been generated, copy the key. For example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 603
Robotic Process Automation 2019.11

8. Go to your AWS CodeCommit server and copy the SSH public key to your user account.

9. Copy the SSH Key ID generated by the server for the new SSH public key and paste it in the SSH key ID field
in RPA Workflow Designer

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 604
Robotic Process Automation 2019.11

10. Go back to the Git Import Repository dialog box and click Import.

RPA Workflow Designer verifies that the repository exists in the location, and that authentication is successful
via the public\private key pair, and then imports the repository.

11. When the import is completed successfully, click Close.

The imported repository is displayed. All the projects in the repository are added to the Projects pane.

Note You can import a repository using an existing SSH key ID by providing the
actual SSH key ID in the URL. An example of the URL format is:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 605
Robotic Process Automation 2019.11

ssh://Your-SSH-Key-ID@git-codecommit.us-
east-2.amazonaws.com/v1/repos/Repo

Import a Git repository using the file system protocol


Use this protocol, if you do not have a Git server account.

Note The File System protocol is not as secured as HTTPS and SSH protocols.

If you don't already have a local Git repository, you must create one using the following file:

For Windows: {RPA Workflow Designer root folder}/designer/bin/git-create-repo.bat


For Linux: {RPA Workflow Designer root folder}/designer/bin/git-create-repo.bin
If you already have a local Git repository, start from step 3.

1. Use the git-create-repo.bat file to create a local Git repository.

2. Make a note of the URL of the local Git repository.

3. In the Projects pane in RPA Workflow Designer, click the Git button and then select Import Repository.

4. Select File System as the SCM protocol type.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 606
Robotic Process Automation 2019.11

5. In the Git URL field, enter the URL of the Git repository that you created: file://<hostname or IP>/<shared
folder>/<repository_name>.git

6. Enter your Email Address and Full Name.

7. Click the Import button.

RPA Workflow Designer verifies that the repository exists in the location, and imports the repository.

8. When the import is completed successfully, click Close.

The imported repository appears. All the projects in the repository are added to the Projects pane.

Manage Git repositories using SCM


You can manage your imported Git repositories using SCM branching capability.

1. To list the branches of the current imported repository

Click Branch displayed on the right bottom corner of the SCM panel.

A pop-up with the list of local and remote branches is displayed.

You can also perform search for a specific branch using search string in the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 607
Robotic Process Automation 2019.11

Search branch field.

2. To Fetch Git branches updates

Click Fetch icon from the SCM toolbar list.

Clicking the Fetch icon will trigger a fetch action temporarily visible as below.

The newly discovered branches are auto-populated in the branch list

3. To Checkout branch from the list of displayed branches.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 608
Robotic Process Automation 2019.11

Ensure to save any unsaved or committed data before proceeding to checkout


a branch.

Select a branch and then click Checkout.

Following are the scenarios you may encounter during checkout process:

a. If a remote branch is already checked and listed in the local branches, the following image appears.

b. If a current branch has changes, the checkout action is not performed until you complete necessary
actions.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 609
Robotic Process Automation 2019.11

c. If you are performing checkout of a remote branch as a local branch for the first time, select Yes or
Cancel from the dialog-box as in the following image to either continue or to stop the checkout
process.

Clicking Yes triggers the checkout process for the above scenario.

The checkout error is displayed, if the checkout process fails due to


network/ proxy or similar cases. You can resolve the issues and retry the
process.

d. If there are conflicts, you must first resolve the conflicts before fixing any other SCM related actions.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 610
Robotic Process Automation 2019.11

If you do not fix the conflicts, any subsequent login into RPA Workflow Designer will display a resolve
conflicts window for appropriate action.

e. You can use the resolve conflicts button that gets enabled in the SCM panel during conflicts for
resolving conflicts.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 611
Robotic Process Automation 2019.11

4. After the successful checkout of the selected branch, it defaults as your new working local branch and
appears on top of local branches list with a blue tick.

5. From the new checkout branch, you can make changes and perform Commit & Push to move the data to
the remote repository.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 612
Robotic Process Automation 2019.11

6. To merge a specific branch with your current branch, click Merge into current to trigger the merge process
as in the following image.

In case of conflicts, you must resolve conflicts and retry the merge process.

7. To Create a new branch:

Click from the SCM tool panel.

Or

Click Branch displayed on the right bottom corner of the SCM panel, and then select Create branch.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 613
Robotic Process Automation 2019.11

8. In the Create Branch dialog box, enter name for the new branch, and then click OK to create branch or
Cancel to abort the process.

By default, the Checkout branch check box is selected to automatically


Checkout the new branch after it is created. You can select or Deselect the
check box as per your requirement.

Ensure the following naming conventions are followed to avoid errors:

Names must be unique.


Branch names must contain alphanumeric characters (A-Z, a-z, 0-9), hyphens ( - ), underscores ( _ ), and
can also contain only digits (0-9).
Branch names cannot contain white spaces, parentheses ( () ), square brackets ( [] ), and curly braces ( {}
).
Branch names must not begin with period (.) and end with the following characters /, \, .lock, . (period).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 614
Robotic Process Automation 2019.11

If the current branch has any changes, the Create branch action cannot be performed until it is resolved.

In case of unresolved conflicts, both Create branch icons in SCM tool panel
and SCM pop-up view are disabled.

9. To Delete a local branch:

Select a local branch listed under Local branches, and then click Delete option.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 615
Robotic Process Automation 2019.11

In the Delete Local Branch dialog, select either of the two listed options, and then click Yes to confirm or
Cancel to abort the process.

a. Force Delete: If the local branch has commits that are not merged.

b. Delete Tracking: If you want to delete the remotely tracked branch too.

The following errors are displayed if there are issues with local branches:

a. Local branch to be deleted has commits that are not merged.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 616
Robotic Process Automation 2019.11

b. If the Delete Tracking option is selected and the remote branch cannot be deleted, the local branch will
be deleted and the user will see an appropriate reason (for example in case of protected branch).

10. To Delete a remote branch:

Important: In order to ensure that collaborators on your repository cannot make irrevocable changes to
branches, it is recommended to enforce branch protection for relevant branches (Example: release branches).

Select a remote branch listed under Remote branches, and then click Delete option.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 617
Robotic Process Automation 2019.11

In the Delete Remote Branch dialog, click Yes to confirm or Cancel to abort the process.

The following error with an appropriate reason is displayed if there are issues while deleting remote branches:

Delete a Git repository from the workspace

1. In the Projects pane, click the Git button, and then select Delete Repository.

2. Click OK to confirm the deletion.

Caution
All the imported projects from your workspace and data not pushed will be
removed. The files that you created and were not pushed to the remote
repository will be lost.

Edit a Git repository in the workspace

1. In the Projects pane, click the Git button, and then select Edit Repository Settings.

2. The Edit Git Repository dialog box fields vary according to the protocol type that was used to import the
repository. Before you edit, review the fields that are read-only and editable for three protocols.

File System protocol - you can edit the full name and email address.
SSH protocol - you can edit the full name and email address.

For AWS CodeCommit repository, you can also edit the SSH key ID as displayed in the following image.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 618
Robotic Process Automation 2019.11

Tip
To generate a new SSH public key, you must re-import the Git repository.

HTTPS protocol - you can edit the full name, email address, user name, and provide a new password.

Note
You cannot edit the repository path. To change this, you need to delete the
existing repository and import the new one.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 619
Robotic Process Automation 2019.11

3. Click Save.

Track local changes

1. Click the SCM button to open the SCM pane.

2. Click the Changes tab to see the changes that were made to the folders and files. Items that were modified,
deleted, or added appear in distinct colors.

Green - indicates that a new item has been added to the project, locally.
Grey - indicates that an item has been removed from the project, locally.
Blue - indicates that an item has been edited.
Red - indicates that an item is in conflict.

Manage changes using Git Stash


The Git stash functionality allows you to:

Flexibly manage changes on the imported Git repository locally.


Save changes on a stack of unfinished changes and reapply at any time.
To use stash functionality:

1. Import a Git repository.

2. Make changes such as modify, add, or delete files or folders of your project.
The stash icon gets activated for new changes.

3. To view the list of stashes click the Unstash icon .

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 620
Robotic Process Automation 2019.11

4. Click Stash icon to stash the changes with an appropriate description.

The imported Git repository reverts to the last commit state. The list of stashes are also visible with
description.

5. From the list of Stashes, select a required stash and then click Apply if you want the stashed change to be
applied on your project.

6. To delete stashed changes:

a. Select the required stash and then select "Drop stash” checkbox

b. Click Apply.

The stashed change is removed from the list of stashes.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 621
Robotic Process Automation 2019.11

7. Click Commit and Push button to upload your most recent changes to the remote Git repository.
The stashed changes are merged with the remote Git repository.

8. If you make more changes to the project and stash it and try to commit and push the changes again, you
must resolve the conflict using an appropriate Resolution Strategy as listed below.

Resolution Strategy for Git Stash Description

Use mine For changes from Git

Use Theirs For changes from Stash

Note: “Use Theirs” strategy updates the changes in the changes list because the project differs from GIT sources

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 622
Robotic Process Automation 2019.11

Pull the most recent changes from the repository


Before starting to work, you must import the most recent changes from the repository to your workspace.
To import, complete the following steps:

1. Click the SCM button to open the SCM pane.

2. Click the Pull button to download the most recent changes to your workspace.

Commit and push your changes to a remote repository


After you make changes locally, you must upload these changes to the remote repository.
To upload, complete the following steps:

Note
In some applications, there are two steps: "committing" files to a local repository
in preparation for upload and "pushing" them to the remote repository. In RPA
Workflow Designer, these steps are merged into a single action.

1. Make sure you have saved all your changes.

2. Click the SCM button to open the SCM pane.

3. Click the Commit and Push button to upload your most recent changes to the remote repository.

Note
All changes will be committed and pushed to the remote repository.

4. In the Commit and Push Changes to the Remote Repository dialog box, enter a description for the
changes that were made, and then click Commit & Push.

The changes are saved to the remote repository.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 623
Robotic Process Automation 2019.11

Resolve conflicts
Conflicts may arise if another author has made change to a file you are currently modifying. If the changes occur in
different lines in the file, Git is able to automatically merge the two versions. If there are two sets of changes in the
same line, they cannot be merged and you need to decide which of the 2 versions you want to keep.

Note
Items that are in conflict appear in red in the Changes pane.

Caution
The resolve conflict for SCM is disabled for BitBucket.

When there is a conflict, you can solve it in the Resolve Conflicts dialog box, by choosing whether to keep your
version of the file (Use mine) or the version that it is in conflict with (Use theirs).

1. When a conflict occurs (for example, when you try to pull a file from Git and another user has pushed a
conflicting version of that file), the Resolve Conflicts dialog box appears.

2. Under Resolution Strategy, select one of the following:

Use mine - to use your version of the file to the repository


Use theirs - to keep the file that the other user created

3. Select the Keep Copy check box to save a local copy of the version that was not selected under Resolution

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 624
Robotic Process Automation 2019.11

Strategy.

4. Click Done.

Revert to a previous version


You can revert changes that you made to an individual file or revert everything to a previous version. This action
discards the changes that you have made.

To revert changes for one file: Select the file in the SCM pane and click the Revert changes for the selected

file button.

To revert all changes, click the Revert all changes button.

Note
In case you Revert from a state of conflict (conflict dialog was closed without
resolving), you will get the version of the file prior to triggering the conflict. You
can then also Revert once again to discard your not pushed changes.

View the SCM message history


The Console tab is a console that displays a record of all the SCM actions that were taken in this session.

1. Click the SCM button to open the SCM pane.

2. Click the Console tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 625
Robotic Process Automation 2019.11

3. To clear the console, click Delete .

Related topics
To set up the RPA Workflow Designer Project, see Set up the RPA Workflow Designer Project.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 626
Robotic Process Automation 2019.11

Set up the RPA Workflow Designer Project


Before starting to create flows, you need to set up a project in which to work.

Project and folder naming recommendations


Names must be unique within their folders.
Names are not case-sensitive, so names such as "Ping" and "ping" are considered duplicates. However, when
calling an item, make sure to use the correct case.
Names can contain alphanumeric characters (A-Z, a-z, 0-9), hyphens ( - ), and underscores ( _ ).
Project names and Folder names cannot contain white spaces, parentheses ( () ), square brackets ( [] ), and curly
braces ( {} ).
Names cannot be identical to the following Windows reserved words: CON, PRN, AUX, CLOCK$, COM1, COM2,
COM3, COM4, COM5, COM6, COM7, COM8, COM9, NUL, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8,
LPT9 .

Create a project

1. In the PROJECTS pane, click the Create a new project button.

2. Enter the project name in the New Project pop-up window. A new Project tree is created with a
Library and Configuration folders. These store the flows, operations and project's system property files.

3. Right-click the Library folder and select Add Folder. Alternatively, click the button and select Folder to
create a new folder.

4. In the New Folder dialog box, enter the folder name, and click OK. A new Library folder is created where you
can add RPA activities from screen recordings or UFT scripts.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 627
Robotic Process Automation 2019.11

5. Right-click on the new folder and select Add Flow. Enter the flow name and click OK.

Manage the folders in the project


Before you can create flows or Python Operations, you must create at least one folder under Library.
It is recommended to set up and organize the folders in your project before you start creating flows.

1. To add a folder to the project, select Library or an existing folder.

2. Click New and select Folder.

3. Enter a name for the folder and click OK (or press the Enter key).

You can now add subfolders, create flows and Python Operations in the folder.

4. To delete a folder, select it and click the Delete button, and then click OK to confirm.

Note
Deleting a folder will delete all of its contents including subfolders and their
contents, and will close all open tabs of files that were under that folder.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 628
Robotic Process Automation 2019.11

Manage the flows, decisions, and operations in the


project
1. To delete flows, decisions, or operations: Select the item, and then click Delete. Click OK to confirm.

Deleting a flow will invalidate any other flows that depend on it.

Note
If you copied an item from a content pack and then deleted the item from the
project, this does not affect the content pack that it was copied from.

2. To filter the specific items to be displayed in the project pane, enter some text into the Filter box in the
Projects pane.

For example, enter "ping" to display only flows, decisions, operations, folders, and system properties files
containing "ping".

Note
If the text is part of a folder name, all the contents of that folder, including
sub-folders, are displayed.

3. To remove a filter, click x at the corner of the Filter box.

Check for errors in the project


If there is an error or invalid content anywhere in the Project pane (in a flow, operation, decision. or system
property), the item with the error is displayed with a red underline. All flows that use this item and the folders

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 629
Robotic Process Automation 2019.11

above it are also displayed with a red underline.

When you fix the error, the relevant red lines disappear.

Related topics
To create, deploy and to resolve invalid content errors, see Create and deploy a content pack.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 630
Robotic Process Automation 2019.11

Import Content Packs to the Dependencies Pane


You can import content pack and use it according to your requirement.

Import content packs to the workspace


Before importing a content pack, you must prepare content packs to be imported.

1. Locate your required Content Packs, you may want to:

Use the content packs that were included when you installed RPA Workflow Designer.
Download additional content packs from ITOM Marketplace.
Create content packs from existing CloudSlang content.
Important! Make sure to import a Base content pack first as it is a dependency for all the other content packs
before importing a content pack.

2. Click the Import Content Pack button in the Dependencies pane.

3. In the Import Content Pack dialog box, click New .

4. In the browse dialog, select one or more content packs and click Open to upload. You can also drag and drop
from the browse dialog.

5. When you upload a content pack, RPA Workflow Designer checks the content pack for a digital signature. The
following possible certificate statuses are displayed:

Certificate
Status Icon Description Deployment State

⚬ Digital signature or Content pack is altered This content pack cannot be


deployed.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 631
Robotic Process Automation 2019.11

Certificate
Status Icon Description Deployment State

⚬ Digital signature is expired This content pack can be


⚬ Content Pack is not signed deployed.
⚬ Content Pack is signed but the signed CA is
not in the client.truststore

⚬ Digital signature has passed and the This content pack can be
signature's CA is known to RPA Workflow deployed.
Designer.

6. Click the certificate icon to view the details of the certificate and the issuing authority.

7. If all selected content packs are digitally signed and successfully uploaded, the Import button is enabled.

If any of the content packs digital signature fails or were already imported, the Import button is not disabled.

You must remove the invalid or corrupted content packs from the dialog box. To do that:

Select a content pack that has digital signature issues or duplicate content packs and click the

Delete button to remove it.

Or click the Clear button to clear all displayed content packs from the dialog box and restart the
process of uploading content packs. The default size limit of content packs that can be uploaded to RPA
Workflow Designer is 200 MB. However, you can configure this size limit. See related topics section at the
bottom of this page for a related topic.

8. After the content packs are successfully uploaded, click the Import button.

You can see the progress bar of the import content pack progress at the bottom.

If any of the content packs were not successfully imported, you can click the Clear button to start a new
import process.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 632
Robotic Process Automation 2019.11

9. Click Close to close the Import Content Pack dialog box. The successfully imported content packs are
displayed in the Dependencies pane.

Once you have imported a content pack, these items are available in the Dependencies pane as read-only, and
you can use them in your flows.

Important If you modify and then import a content pack that was already
imported to RPA Workflow Designer (for example, by a different user), it must
have an updated version number in order for the changes to take effect. If you
import a content pack with the same name and version number as one that was
already imported, the new content pack will reference the original one and will
not replace it.

After you have imported the desired content packs into the workspace, you can copy flows and system properties
into the project (by copying from the Dependencies pane and pasting into the Projects pane).
Once flows are copied into the project, you can edit them in the RPA Workflow Designer Authoring pane.
Why do this? When you create a step from an operation/flow, the step is an instance of that operation/flow. Items
in the Dependencies pane are read-only. If you create a step from a flow from there, you will be able to modify
that step only. If you want to make changes to a flow, in order to use the modified version for multiple steps, you
need to copy it from the Dependencies pane and paste it into the Projects pane.

Assign an imported content pack


In a multi-author environment, two users accessing the same RPA Workflow Designer instance can view and assign
a content pack already imported by another user from their workspace to own workspace. This results in not
having to re-import the same content pack that authors might need. The assigned and imported content pack is
read-only, which means the user who imports the content pack can use its flows in the working projects but cannot
edit them.
For example, if user A has imported the content pack, then user B accessing the same RPA Workflow Designer
service can view, assign, and import an already imported content pack to own workspace.
It must be noted that this functionality is disabled by default due to security reasons.

Assign content pack

To assign an already imported content pack, complete the steps as follows:

1. Click the Import Content Pack button in the Dependencies pane.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 633
Robotic Process Automation 2019.11

2. In the Import Content Pack dialog box, click Assign button. The content pack/s imported by another
user is/are listed.

3. From the Assign Content Pack dialog box, select the content pack/s listed, pick the desired version, and
then click Assign. The content pack/s is assigned to the current workspace.

If the Assign button is not visible, contact your administrator to enable this feature for your workspace.

Filter the dependencies


1. To filter the specific items to be displayed in the dependencies pane, enter some text into the Filter box in
the Dependencies pane.

For example, enter "ping" to display only flows, decisions, operations, folders, and system properties files
containing "ping". If the text is part of a folder name, all the contents of that folder, including sub-folders, are
displayed.

2. To remove a filter, click the x at the side of the Filter box.

View the details of a read-only item on the


dependencies pane
While you cannot edit a flow/operation from the Dependencies pane, you can view its details in the Authoring
pane.

1. Select the flow/operation in the Dependencies pane.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 634
Robotic Process Automation 2019.11

2. Double-click the flow/operation to display it as read-only in the Authoring pane. A Read-only icon
appears in the tab, next to the name. If there is no open flow in the Authoring pane, you can also open the
item by dragging it to the Authoring pane. However, if there is already an flow in the Authoring pane, the act
of dragging the item will move it to that flow.

Identifying content packs created without using RPA


Workflow Designer
If you had imported Content packs that were created without using RPA Workflow Designer, you can:

View that the configuration elements of the content packs are disabled for use for now.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 635
Robotic Process Automation 2019.11

Open the Flows, Operations, System Accounts, and System Properties.

Analyze the Flows and Operations before use. You can double-click on the flows from the Dependencies
pane to view its inputs, outputs, results, and descriptions as in the following image.

Tip Select the flows or operations from the authoring canvas and click the Drill

Down into the Step button to view more details

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 636
Robotic Process Automation 2019.11

You can open the System Accounts and System Properties of the native OO content pack by double-clicking from
the Dependencies pane to view the details as in the following image.

Related topics
To prepare a content pack before importing, see Create and deploy a content pack.
To use CloudSlang files created outside RPA Workflow Designer, see Use CloudSlang files created outside RPA
Workflow Designer.
To configure the content pack import size, See Configure content pack import size.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 637
Robotic Process Automation 2019.11

Use CloudSlang files created outside RPA


Workflow Designer
Before importing CloudSlang content to RPA Workflow Designer, you need to create a content pack.
Before creating the content pack, it is recommended to run the build tool in CloudSlang. The build tool validates
the content against failures during import to RPA Workflow Designer.

1. Create a folder with the name of your content pack, and create the folder structure inside it, as follows:

<Content Pack folder name>\Content\Library

<Content Pack folder name>\Lib

2. Place your CloudSlang content in the Library folder. You can organize it into sub-folders inside the Library
folder.

3. Create a text file and name it contentpack.properties.

4. Add the following properties to the file:

content.pack.name=slang-content-master content.pack.version=1.0.0 content.pack.description=RPA


slang-content-master content.pack.publisher=CustomerX

5. Store the contentpack.properties file at the top level of the content pack folder, at same level as the
Content and Lib folders.

6. Create a .jar file from the content pack folder.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 638
Robotic Process Automation 2019.11

Note
You can do this using any tool that creates zip files. Create the file as a zip file
and rename the suffix to jar.

Related topics
To create and to deploy a content pack in RPA Workflow Designer, see Create and deploy a content pack.
To import content packs in RPA Workflow Designer, see Import Content Packs to the Dependencies Pane.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 639
Robotic Process Automation 2019.11

Author content using RPA Workflow Designer


Authoring is the process of creating and editing content.
In RPA Workflow Designer, you can author:

Operations
Flows
System properties
Add or Record RPA Activity

Related topics
Author operations
Author flows
Author System Properties
Record RPA Activity

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 640
Robotic Process Automation 2019.11

Author flows
The major steps in creating a flow are:

1. Create a new flow in the project.

2. Add steps to the flow.

3. Create navigation lines to connect between steps.

4. Add result steps (success, failure, custom) to the end points of the flow.

5. Set up inputs and outputs for the flow.

6. Set up the values of inputs and outputs for steps.

7. Change the start step.

8. Create flows with loops.

Related topics
Create or edit a flow
Create steps in a flow
Create navigation lines between steps in a flow
Add result steps to a flow
Define flow properties
Define step properties
Change the start step
Create flows with loops

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 641
Robotic Process Automation 2019.11

Create or edit a flow


A flow is a composition of steps that forms a set of actions that are linked by decision-making logic in order to
automate tasks. For example: Health checks, troubleshooting, remediation, or any other repetitive IT tasks.
Creating flows is the main function of RPA Workflow Designer.
You can also display and edit a flow that was created externally from RPA Workflow Designer, for example in
ATOM. However, if the flow contains errors, RPA Workflow Designer may not be able to display it in the Authoring
pane. In such a case, you will need to fix the flow in the editor in which it was created and import it to RPA
Workflow Designer again.

Naming flows
The name of a flow is limited to 128 characters.
The combined name and path of a flow (under the Library folder) is limited to 220 characters.
Names must be unique within their folders.
Names are not case-sensitive, so names such as "Ping" and "ping" are considered duplicates. However, when
calling an item, make sure to use the correct case.
Flow names must contain alphanumeric characters (A-Z, a-z, 0-9), hyphens ( - ), and underscores ( _ ).
Flow names cannot contain white spaces, parentheses ( () ), square brackets ( [] ), curly braces ( {} ), and only
digits (0-9).
Names cannot be identical to the following Windows reserved words: CON, PRN, AUX, CLOCK$, COM1, COM2,
COM3, COM4, COM5, COM6, COM7, COM8, COM9, NUL, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8,
LPT9 .

Create a new flow


1. In the Projects pane, select the folder in which you want to locate the new flow.

2. Click the New button and select Flow.

3. In the New Flow dialog box, enter a name for the flow and click OK.

Note
When naming a flow, make sure the naming conventions are followed. To
change a flow name, copy it as a new flow with the correct name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 642
Robotic Process Automation 2019.11

A new tab opens in the Authoring pane with the name of the new flow.

4. Click the Properties button to display the flow's Properties pane.

5. Click the Description tab. You can enter a summary of what the flow does.

Copy an RPA workflow


To copy an RPA flow to a different project:

1. In the PROJECTS pane, select the RPA flow that you want to copy.

2. Press Ctrl+C or right-click and select Copy.

3. Go to the Library folder of the target project and press Ctrl+V or select . A Paste Flow dialog will prompt
for a new name.

4. Enter a valid name for a copied RPA flow and click OK to confirm. The copied RPA flow is added to a selected
RPA project with all the parameters of the original flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 643
Robotic Process Automation 2019.11

Create steps in a flow


When you create a step from an operation, decision, or flow, the step is an instance of that operation or flow and
so inherits the inputs, outputs , and other characteristics.

Create a step from a flow, operation, or decision


1. In the Projects pane, double-click the flow in which you want to create the step, so that it opens in the
authoring pane.

2. Drag a flow/operation/decision to the authoring pane, from either the Projects pane or the Dependencies
pane.

Note
The step icon reflects whether the step was created from an operation, a flow,
or a decision operation.

Flow Operation Decision

3. To copy, cut, paste, and rename a step, select it and use appropriate buttons from the Authoring pane
toolbar.

You can also right-click the step and choose the following actions: Set as Start Step, Rename, Drill Down,
Copy, Cut, Set as Loop, Set as Parallel Loop, and Delete.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 644
Robotic Process Automation 2019.11

a. To copy a step, click the Copy button in the authoring pane toolbar or press CTRL+C keys, then click

Paste button or press CTRL+V keys to paste.

b. To cut a step, click the Cut button in the authoring pane toolbar or press CTRL+X, then click Paste

button or press CTRL+V keys to paste.

You can copy and paste steps on the canvas multiple times as per your requirement.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 645
Robotic Process Automation 2019.11

4. To rename a step, click the Edit button in the authoring pane toolbar. Enter a name for this step and
click OK.

For example: you may want to rename a step to reflect its function within the flow.

Note

A name of a renamed step must be unique in the flow. This applies to


names with different case—for example, you cannot name one step to
"Ping" and another to "ping".
A renamed step cannot have an blank name.

5. To delete a step from the canvas, select it and click the Delete button in the authoring pane toolbar.

Note
When you delete a step, any navigation lines linking this step to other steps
are also deleted.

6. To reorganize the steps and results on the canvas, click the auto arrange icon from the authoring pane
toolbar.

7. To zoom-in or zoom-out of the canvas, you can use mouse-click and drag or scroll on the slider

. To reset the zoom, click .

Note The auto arrange, zoom and reset zoom icons are active and enabled in
graph view only.

8. Click Save .

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 646
Robotic Process Automation 2019.11

Undo and redo actions in a flow


You can undo and redo an action in RPA Workflow Desinger for a flow that is triggered on an authoring pane. You
can also view the entire list of actions in history and select any action from the list that is persisting in the memory
to make further modifications and thereby overwrite the actions.

A maximum of 10 actions are stored in the memory. After the buffer of 10 actions
in history are utilized, only the most recent actions will be retained including the
initial state that will be always be kept in place.

Caution Each author’s history of states is stored individually and will be lost on
closing the editor.

The following images are examples of different scenarios of undo and redo capability:

1. When no history exists.

2. When there is a history of steps.

You can also use Ctrl+Z and Ctrl+Y for undo and redo actions respectively.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 647
Robotic Process Automation 2019.11

3. When you select a specific action from the history and skip existing actions.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 648
Robotic Process Automation 2019.11

When you select a specific action from the history, the previously existing
actions are displayed in grey. Any new action you make thereon will overwrite
the grayed out actions.

4. When future actions (grayed out actions as above) are overwritten by new actions.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 649
Robotic Process Automation 2019.11

View the step properties


1. Click a step in the authoring pane. The Step Properties pane appears at the right side of the canvas.

The Properties pane contains the Input/Output tabs, with information about the selected step.

To filter specific inputs or outputs to be displayed in the pane, enter some text into the Filter inputs text
box.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 650
Robotic Process Automation 2019.11

Drill down to view a subflow/operation within a step


To drill down within a step to see the details of the flow, decision, or operation that was used to create it:

Click the Drill Down into the Step button in the authoring pane toolbar.

Related topics
To define step properties, see Define step properties

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 651
Robotic Process Automation 2019.11

Create navigation lines between steps in a flow


You must connect any two steps in a flow with a navigation line.

About navigation lines


A navigation line starts from one of a step’s response ports and connects to another step or to a result step.

Every Success or Custom response in a flow must have a navigation line either to a subsequent step or to a
result step.
It is optional to connect Failure responses to a subsequent step or result step.
The response ports that appear in a step are in accordance with the responses that were defined for the operation
or flow that the step instantiates. For example, if a step instantiates a subflow with three responses: success,
failure, and a custom response, the step will have three corresponding response ports.

If a flow already has a navigation line from a step's response port, and that response is deleted from the flow or
operation instantiated in the step, in the flow the response port is grayed-out and navigation line appears as a
dotted gray line.

Create and delete the navigation lines between steps


1. On each step that you want to connect to the next step (or to a result step), click the icon that represents one
of the response ports, and drag a line to the destination step for that response.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 652
Robotic Process Automation 2019.11

2. Repeat the process for the other response icons on the step.

3. To add, move, and remove a vertex from the navigation line, follow the steps in the table below.

Action Instructions Result

To add or move SHIFT + click the navigation line A small vertex with x icon appears on the
vertex on the then drag it to the required navigation line as shown below.
navigation line, position.

To delete a vertex hover over the navigation line The vertex is removed and the original navigation
from the navigation with the vertex and click x icon. line without a vertex is displayed.
line,

To delete a hover over the navigation line


navigation line and click the x that appears on
the line.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 653
Robotic Process Automation 2019.11

Assign ROI value to navigations


Specify a return of investment (ROI) value for a navigation in the flow. If the flow follows that navigation during a
run, its value is added to the total ROI value of the flow for that run.
This enables RPA Central to count the completion of a navigation when generating ROI statistics for the overall flow
run.

1. Create a navigation lines between two steps.

2. Double-click on the navigation line or the default failure mark to open Navigation Properties.

3. In the ROI box, enter a numerical value for the navigation.

Related topics
To add result steps to a flow, see Add result steps to a flow

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 654
Robotic Process Automation 2019.11

Add result steps to a flow


Result steps return an outcome for the entire flow and end the flow. To create a result step, drag it from the
Results toolbar.

All Success and Custom response ports must be connected either to another step or to a result step.

Options for failure response ports


There are two options for Failure response ports:

If you don't connect a step’s Failure response port to a step, the response icon will remain with grounding
and will end the flow with a default failure step.

The default failure step can be configured to run a specific step/flow before failing.

Use this option if there are a lot of fail points in a flow and you want the same action to occur on each failure.

You can also use this option if you want the flow to be readable and clean, as it removes the failures from the
graph and promotes the successful path of the flow.

If you connect a step’s Failure response port to any step, the grounding disappears, the flow depends on what it
is connected to, and does not run the default failure step.

Use this option if you want to configure the action for a specific fail point separately.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 655
Robotic Process Automation 2019.11

Example of multiple option of how to handle failure in a flow.

Add results to the flow


1. To add Success and Custom result points to the flow, drag result steps from the Results toolbar, and place
them next to the step connected to it.

2. Click the icon that represents one of the response ports, and drag a line to the result step for that response.

3. To copy, cut, paste, and rename a result step, select it and use appropriate buttons from the authoring pane

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 656
Robotic Process Automation 2019.11

toolbar .

a. To copy a result step, click the Copy button in the authoring pane toolbar or press CTRL+C keys,

then Click or press CTRL+V keys to paste.

b. To cut a result step, click the Cut button in the authoring pane toolbar or press CTRL+X, then Click

or press CTRL+V keys to paste.

Note

You can copy and paste result steps on the canvas multiple times as per
your requirement.

4. To rename a result step, select it and click the Edit button in the authoring pane toolbar.

Note

If you rename a Success/Failure step, the new name must start with the
prefix Success/Failure.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 657
Robotic Process Automation 2019.11

A Custom step can have any name.


A renamed step must be unique in the flow. This applies to names with
different case—for example, you cannot name one step to "Success_All" and
another to "success_all".
A renamed step cannot have a blank name.
You cannot change the type of a response step by renaming.
A Failure step cannot be named "on_failure".

Optional set up a default failure step for the flow


You can set up a default failure step, to run by default for steps that go to the default failure. For example, you
might want an email to be sent to the administrator for every failed step.
Every step whose Failure response is grounding will run the default failure step before the flows ends in failure.

1. Open the flow for which you want to create a default failure step.

2. If the Default Failure pane on the canvas is contracted, click the arrow to expand it.

3. Drag an operation or flow from the Projects pane or Dependencies pane into the Default Failure pane.

4. Bind the step inputs for this new step (and outputs if needed).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 658
Robotic Process Automation 2019.11

5. Save the flow.

Note
If all the Failure response ports are connected to a step, the default failure
step is inactive and the icon in the top right corner of the Default Failure
pane appears in gray.

6. To change the default failure step, drag a different operation or flow from the Projects pane or
Dependencies pane into the Default Failure pane.

7. To remove the default failure step, select it and click the Delete button from the authoring pane toolbar.

8. To rename the default failure step, select it and click the Edit button in the authoring pane toolbar.

The FAILURE results in the default error cannot be renamed.

Note

If a step is based on a subflow that previously had a Failure result step, and this
Failure result step was deleted, the step based on it will have an upgraded
Failure result port. If this occurs, click the small x button to remove that result
port.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 659
Robotic Process Automation 2019.11

If a Failure result is added, the step will have a small black grounding icon next
to the new failure port, to connect it to on_failure.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 660
Robotic Process Automation 2019.11

Define flow properties


The PROPERTIES tab displays the flow's properties. It include:

Inputs - flow inputs specify the data required by the flow. You can define flow inputs when you want to use their
value throughout the whole flow and various steps or if you want the inputs to get values from outside (from the
user or when other flows use it). Step inputs are the inputs that the contained flow/operation/decision needs.

If this flow is used as a subflow in another flow, the flow inputs are exposed as step inputs.

Outputs - you can set up outputs for a flow. Once outputs have been set up for the flow, you will be able to
choose flow outputs to be published as step outputs when this flow is used as a step.

Results - the Results tab displays the results that were dragged to the canvas for the flow. You can enter
descriptions for these results.

Description - you can enter a summary of what the flow does. It is recommended to include in this summary
only the flow level description and not the input/output level description.

Set up inputs for the flow


Flow inputs are available for the entire flow. For example, you can set the value of a flow variable and use this in
various steps in the flow.

1. Click PROPERTIES to display the Flow Properties pane for the current flow. The inputs of the flow are
displayed under the Inputs tab. If you open a flow from the Dependencies pane, the Flow Properties pane
is in read-only mode. If you want to edit the flow, first copy it to the Projects pane and edit the copy.

2. To add a new input, click the New Input button.

3. In the new row that appears, enter the details of the input:

4. To delete an input, select the input row and click the Delete button.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 661
Robotic Process Automation 2019.11

5. To move an input up or down in the list, click the Up and Down arrows.

Set up outputs for a flow


Flow outputs are available for the entire flow. A flow output can be used as inputs to other flows.

1. Click PROPERTIES to display the Flow Properties pane for the current flow.

The outputs of the flow are displayed under the Outputs tab. If you open a flow from the Dependencies
pane, the Flow Properties pane is in read-only mode. If you want to edit the flow, first copy it to the
Projects pane and edit the copy.

2. To add a new output, click the New Output button.

3. In the new row that appears, enter the details of the output. For example:

4. To delete an output, select the output row and click the Delete button.

5. To move an output up or down in the list, click the Up and Down arrows.

Adding a description to flow results


On the Results tab, you can add description to the results that were added to the flow. You cannot add new
results in this tab. You must drag a result step to the canvas from the Results toolbar.

1. Click PROPERTIES to display the Flow Properties pane for the current flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 662
Robotic Process Automation 2019.11

2. Click the Results tab to display the results that have been dragged to the canvas for the flow.

3. (Optional) Enter a description of the results in the Description column.

Check for errors in a flow

Flow errors

If a flow or its properties contain errors, an error flag is displayed in the GRAPH and/or PROPERTIES buttons at
the top of the Authoring pane. This flag includes a number, representing the number of errors.

Click the error flag to display a tooltip with information about the errors.
After you fix the errors, numbers in the error flag are adjusted, and when all are fixed, the flag disappears.

Error in the flow properties

If errors exist in the flow properties, the error flag appears on the relevant tab and in the rows that are affected.
Also at these levels, you can click the error flag to display a tooltip with information about the error.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 663
Robotic Process Automation 2019.11

If the value being entered is not correct from CloudSlang point-of-view, an error will be displayed. If the error
causes the corresponding YAML to be corrupted, the value will be reset after removing the focus from the item.

View the CloudSlang code

1. You can see information about the input, output, and result CloudSlang code.

To view the code defining the flow,operation, decision, or system property, click the Show as Text button
in the Authoring pane toolbar. A text box appears. This text is the CloudSlang code that will actually run.

Add inputs to a step


Inputs are defined for steps, operations, decisions, or flows.
Under the Inputs tab, you can view the inputs that the steps, operations, decisions, or flows receive. The Inputs
tab for the steps are on the right side of the canvas. Each input has a value that can be set in a number of ways. It
may be a constant value, a python expression, the value of a flow variable or system property, and more.
For example, you can set the value of a flow variable and use this in various steps in the flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 664
Robotic Process Automation 2019.11

Name. Displays the name of the input.

The combined input name, flow name, and folder path of the input (under the Library folder) must add up to no
more than 255 characters.

Input names must start with a letter or an underscore ( _ ) and must contain only the characters (A-Z, a-z, 0-9) or
_.
The Input name cannot contain white spaces.

NoteFor localized characters, this limit is even lower. For example, in Japanese,
the 255 characters need to be divided by 4, so the number of characters is only
64.

Default value. A user can add a default value to the input. If no value is passed for this input, the default value
is used instead.

(Optional) You can directly edit the expression of a value. Open the Expression Editor by clicking the Edit button
next to the value.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 665
Robotic Process Automation 2019.11

Private. Click the check box if the input needs to be private. This means that it cannot be overridden. This
cannot be seen when this flow is triggered or when this flow is referenced as a step

NoteIf a flow input is marked as private, it must have a default value. If there is
no default value, this is flagged as an error.

Sensitive. Click the check box if the input contains sensitive data. During runtime, the value will be encrypted.
It is not recommend to set a default constant value when an input is marked as sensitive. The values are
displayed as asterisks in the file.

Required. This check box is selected if this input is mandatory for the operation/flow to function.
Description. Displays a description of the input.

When the flow is used as a step (subflow) in another flow, an Info button will appear when a mouse is rolled
over the input (under Step Properties > Inputs).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 666
Robotic Process Automation 2019.11

When this Info button is clicked, a smart tooltip will display the description that you entered.

Add ouputs to a step


Under the Output tab, a user can put any information to be send back to the calling flow.
Output values can have complicated expressions, such as trimming, parsing etc. Output expressions must evaluate
to strings.
After you set up the outputs for a flow, you can use the flow as a step and add outputs to that step whose value
will be taken from the outputs defined in the original flow.
Step Outputs can be used in the flow outputs. For example, if a user adds a step output called 'vacant', the step
can be used in a flow output by choosing it from the drop down under the flow variable list

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 667
Robotic Process Automation 2019.11

Name. Displays the name of the output. A default name is provided, but you can change this.
Output names must start with a letter or an underscore ( _ ) and must contain only the characters (A-Z, a-z, 0-9)
or _.
The Output name cannot contain white spaces.

Value. Displays how to obtain the flow output value. This may be a constant value, a flow input, published
outputs from any of the steps, or any expression.

(Optional) You can directly edit the expression of a value. Click the Edit button to open the expression
editor.

Sensitive. Select this check box if you want the value to be encrypted at runtime. It is not recommended to set
a constant value when an output is marked as sensitive. The values are displayed as asterisks in the file.

Description Enter a meaningful description of the output.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 668
Robotic Process Automation 2019.11

Set the input, output, and system property as sensitive


The following can be set as Sensitive: an input field, an output field, and a system property. It is not
recommended to set a default constant value when an Input, Output, or System Property is marked as sensitive.
The values are displayed as asterisks in the file.

Handle sensitive information at back-end - API

You cannot access the flows and system property files of the content that supports sensitive data through an API
using non-secured channel such as HTTP protocol. You are prompted to use secured protocol (HTTPS) as displayed
in the below image.

Rules and limitations

When an Input is defined as Sensitive, it flags the system to protect its value when this flow is executed. By
extension, any input or expression that refers to it will be treated as Sensitive.
If an Output refers to another output that is defined as Sensitive, then the resulting Output is treated as

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 669
Robotic Process Automation 2019.11

Sensitive.

View the results


Under the Results tab, view the results that will be returned from the current item.

Name. Displays the name of the result.

Type. Displays the type of the result. The options are Success , Failure , and Custom .
Rule. Rules can be used to define a result. Rules are relevant only in operations and decisions.
Description. Displays a description of the result.

Related topics
To edit the input and output using Expression editor, see YAML file textual representation.
To define step properties, see Define step properties.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 670
Robotic Process Automation 2019.11

Define step properties

View inputs in a step that was created from another


flow
If you include flow inputs in one flow (Flow A) and you use this flow as a subflow step in another flow (Flow B),
these inputs are available as step inputs for the step in Flow B.
You can also view the descriptions that were given to the flow inputs in the original flow (Flow A).

1. Create a flow with flow inputs (Flow A), and give these inputs descriptions.

For example:

2. Create a second flow (Flow B) and use Flow A as a step.

3. In Flow B, select that step.

In the Step Properties pane, the inputs of the step are displayed under the Inputs tab.

4. Roll a mouse over an input, to display the Info button.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 671
Robotic Process Automation 2019.11

5. Click the Info button to display a smart tooltip showing the description that was entered for the original
flow input.

Add and edit the inputs of a step


Step inputs are defined for a single step. To add and edit the inputs in a step.

1. Click on the step in the authoring pane. The Step Properties pane appears at the right side of the canvas.

The Step Properties pane has two tabs where you can view the inputs and outputs of the selected step.

2. To add a new input for a single step:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 672
Robotic Process Automation 2019.11

a. Click the New Step Input button. The new step input field is displayed.
For example: input_0, input_1 etc.

b. Click the Value arrow and enter appropriate values (constant or expression)

c. Click Save button in the authoring pane to save the step input.

3. To rename a newly added input for a single step:

a. Hover over the selected step input field to view the step input toolbar as shown below.

b. Click Edit icon to enter the editing mode as shown below.

c. Click inside the Step Input box and rename as required. For example: From input_0 to input_1. If you
select an existing step input name, a red indicator is displayed warning of a duplicate name.

d. To set a step input as sensitive, select the Sensitive check box. The values of sensitive steps are
replaced and displayed with asterisks in both Input field and YAML source. However, the values are
cleared when a step input is removed off its sensitive state.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 673
Robotic Process Automation 2019.11

Only the custom added step input is editable. The input text box of the step input having a dependency
is set to read-only state and is not editable.

e. Press ENTER key or Click Save icon from the step input toolbar to save.

f. Click Cancel icon or press ESC key to cancel.

4. To edit an input value in the selected step, click the down arrow next to the input value and select a value
from the list.

The default value of the origin flow/operation appears in gray italic text, but you can enter a different value.
Required inputs appear with an asterisk*.

Each input in a step has a value that can be set in the following ways:

A constant value.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 674
Robotic Process Automation 2019.11

A default value as defined in the flow/operation that the step is based on.

A system property - system properties can be defined under Configuration > System Properties. If
you choose to define the value from a system property, the content pack or project from which the system
property originates is displayed. An empty string value for a required step input is invalid.
A python expression.

A flow variable - flow variables can be defined in the flow inputs, as described in "Set up inputs for the
flow" topic. Flow variables also contain published output data from steps in the workflow.

5. (Optional) You can directly edit the expression of a value. Open the Expression Editor by clicking the Edit
button next to the value.

In the Expression Editor, enter the value that you want to assign, and click Save. The value will appear in the
value box without quotation marks.

6. (Optional) If you select a system property or a flow variable, you can add an Otherwise option. At runtime, if
the flow variable or system property does not exist or is empty, the Expression Editor will use the Otherwise
value

Click the button to add an Otherwise option.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 675
Robotic Process Automation 2019.11

7. Click the drop-down of the Otherwise option and select a value from the list.

You can assign the value from a flow variable, a constant, an expression, or a system property.

If you do not click the New button, the Otherwise field does not appear and this option remains disabled.

8. To delete an input from a single step:

a. Hover over the selected Step Input box to view the step input toolbar.

b. Click the trash icon to delete the step input.

Only the custom added step input can be deleted. A step input coming from a dependency is set to
read-only state; if it was not edited, and cannot be deleted. Otherwise the input value will be reset to
the default value.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 676
Robotic Process Automation 2019.11

Publish outputs for a step


When setting up step outputs, you choose which information you want to use, from the data that was received in
the various flows and operations.
This output will be available to be used as input in other steps and is available to be a flow output:

1. To add outputs to a step, click the step in the Authoring pane. The Step Properties pane appears at the right
side of the canvas.

The outputs of the selected step are displayed under the Outputs tab.

2. If the Step Properties pane is hidden, click the Expand button to display it.

3. To add a new output to the selected step, click the New button or click to choose from the list that
opens.

4. To edit the name of an output value in the selected step, click in the Name field and edit the text. While you
are entering the output name, if the characters entered cause the underlying YAML file to be corrupted, for
example, an empty value, the value is reset to its previous value after focusing out.

5. To set a step output as sensitive, click the edit button and then select the Sensitive check box.

Only the custom added step output is editable. The input text box of the step output having a dependency is
set to read-only state and is not editable.

6. Press ENTER key or Click Save icon from the step output toolbar to save.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 677
Robotic Process Automation 2019.11

The values of sensitive steps are replaced and displayed with asterisks in both output field and YAML source.
However, the values are cleared when a step output is removed off its sensitive state.

7. Click Cancel icon or press ESC key to cancel.

8. To edit an output value in the selected step, click the down arrow next to the output value and select a value
from the list.

The default value of the origin flow/operation appears in gray italic text, but you can enter a different value.

The output values that were marked as sensitive will appear with an asterisk* as shown in the following
image.

9. To edit an output value in the selected step, click the drop-down of the output value and select a value from
the list.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 678
Robotic Process Automation 2019.11

You can assign the value of an output from one of the following:

Constants.
Current step input.
An Underline output - the most common use case is to use outputs received from an operation or flow.
A system property - system properties can be defined under Configuration>System Properties, as
described in "Author system properties" topic.
Directly edit the expression of a value. Open the Expression Editor by clicking the Edit button next to the
value.
You can also extract and modify parts of an output, using Python.

For example, if you have a step that counts the number of servers that are online, this output is published as
a flow variable, which can be added to an email that is sent to the system administrator.

10. To delete an output from a step, hover over that output to view the Delete button, and then click to
delete.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 679
Robotic Process Automation 2019.11

Check for errors in a step

In the Authoring pane, if there is an error in a step operation, for example, missing information, the error appears
with a red error flag in the top left corner.

Tip Click the error flag to display a tooltip with information about the error.

If there is a step with a missing dependency (for example, a step that is based on a flow that was deleted), that
step appears with a gray, striped background.

In the Step Properties pane, if there are fields with errors in the Inputs and Outputs tabs, these fields appear
with an error flag.

The tabs at the bottom of the Step Properties pane also appear with an error flag, which includes a number,
representing the number of errors.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 680
Robotic Process Automation 2019.11

When you fix the errors, these error signs disappear.

Related topics
To define flow properties, see Define flow properties.
For instructions to author system properties, see Author System Properties.
To edit an expression of input and output using Expression Editor, see Edit the expression of a value for an input
or output.
For instructions to extract and modify output values, see Extract and modify output values.
For instructions to create and deploy content pack, see Create and deploy a content pack.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 681
Robotic Process Automation 2019.11

Edit the expression of a value for an input or


output

You access the Expression Editor by clicking the Edit button available from the Step Properties pane, on
the Inputs and Outputs tabs, and in the Flow Properties pane, on the Inputs and Outputs tabs.
The Expression Editor displays the python value of the selected input or output value. For example, if you selected
a system property named 'sp1' as the input value, this will be displayed as the python expression: get_sp('sp1') in
the Expression Editor. It can include any valid python expression.

About the expression editor


You can directly edit the expression of this value in the Expression Editor.

Expressions in RPA Workflow Designer


In the Expression Editor, if there is a multi-line description:

Make sure additional lines do not start with @. For example, the following is an invalid description:

@input input_name: this is the first line @this is the second line
this is the third line

To create strings that span on multiple lines, use triple single quotes ''' or triple double quotes """ . This is a
specific Python string literal.
For example:

return_result.split('')+ '''this is a string spanning on multiple lines'''

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 682
Robotic Process Automation 2019.11

Related topics
To define flow properties, see Define flow properties.
To define step properties, see Define step properties.
For instructions to extract and modify output values, see Extract and modify output values.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 683
Robotic Process Automation 2019.11

Extract and modify output values


You can extract and modify parts of an output, using python.
For example, if you only want the maximum, minimum, and average round-trip times for a ping operation to a
server, you can isolate and extract all three pieces of information from the operation’s raw output.
Another example is to extract the HTTP code from an HTTP response.

Extract and modify the output value


1. In the Step Properties pane, under Outputs, or in the Flow Properties pane, under Outputs, select the
output and click the Edit button.

2. In the Expression Editor, enter the python expression to manipulate the output value.

Example: To convert the output to lowercase, you just need to copy the following expression in the OO
Workflow Designer UI:

output1.lower()

if the original expression was:

pub1: ${output1.lower()}

3. Click Save.

Examples of using Python to manipulate outputs


Diff Case

Diff Case changes all the characters in the string either to upper case or to lower case.

Example:

# to change to lowercase

output1.lower()

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 684
Robotic Process Automation 2019.11

# to change to uppercase

output1.upper()

Extract Number

Extract Number extracts the first number found in the result. It treats an unbroken series of integers as a single
number.

Example:

To extract the number “123” from the strings “123Test” or “Test123”:

# extract first number # requires another step - extract_first_number: do: strings.match_regex: -


regex: '\d+' - text: ${var_name} publish: - first_number: ${match_text} navigate: - MATCH: MATCH -
NO_MATCH: NO_MATCH

Format

Format attaches text to a result or output or replaces the original content of the result or output with the text
that you specify.

To attach the text to the front of the existing text, use prepend.

Example:

# prepend 'xyz' + output1

To add the text to the back of the existing text, use append.

Example:

# append output1 + 'xyz'

To replace the output with the text, use replace.

Example:

# replace output1.replace('old', 'new')

Line Count

Line Count outputs the total number of lines of the result.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 685
Robotic Process Automation 2019.11

Example:

# string line count len(output1.split('\n'))

Loop

Loop is synchronous. It will act like ordinary loop in other languages (such as java). It runs over a collection of
items and executes the step mentioned inside (operation or flow).

For

The variable name that is assigned the current value from the collection that is defined in the In section. This
variable is available in the current running of the inner step as flow variable. In case of iterating map there
will be two variable names, for the key and value. This variable is required.

Supported characters: A to Z, a to z, 0 to 9, _ variable name starting with letter or underscore.

Example:

for: "value in '1','2','3'"

or

for: "value in '1,2,3'"

to actually enter a constant in the expression editor

for: 'k,v in {"key1":"val1","key2":"val2"}'

In

The collection to be iterated on. You can use any python expression that results in a list or map. The In
section contains dropdowns that contain SP and flow variables. Click the Edit button to open the expression
dialog where you can insert any string. This variable is required.

Example:

Array: ['1','2','3','4'] or ['a','b','c','d']


Python expression: map(str,range(1,5)) to return a string collection.
Map: {"key1":"value1","key2":"value2"}
Comma delimited strings: which would be split automatically into a list: "1,2,3"
Flow variable: select it from the drop down (all step published outputs and flow inputs).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 686
Robotic Process Automation 2019.11

System property: select it from the drop down.

Break

A loop exits when either the collection being looped has been exhausted or the operation or subflow called
returns one of the results mentioned in the break section. The break section is a property of a loop, which is
mapped to a list of results on which to break out of the loop. The list of results is a subset of the results of the
inner step.

When the operation or subflow of the iterative task returns a result in the break list, the iteration halts and the
iterative task navigation logic is run.

If there is no break section in the YAML, by default FAILURE breaks the loop. In Java-based operations and in
Python, FAILURE result is added by default to the Break list. You can delete FAILURE.

Publish

The publish output is set like a regular step (In the step properties). At runtime, it will contain the value from
the last iteration of the loop (make sure the 'publish' key is inside the loop).

You can also aggregate outputs from a loop. To do so, put a python expression that will aggregate the
outputs.

Example:

The sum is calculated in each iteration and at the end provides the sum of all iterations.

- aggregate: loop: for: "value in '1','2','3'" do: square: - to_square: ${value} - sum
publish: - sum: ${sum + squared}

Navigate

The navigation logic runs when the last iteration of the step is completed or after exiting the iteration due to a
break. The navigation runs according to the last iteration of the loop.

For keys, the supported characters: A to Z, a to z, 0 to 9.

For values, restricted to step/result names.

Example:

- custom3: loop: for: "value in '1','2','3','4','5'"

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 687
Robotic Process Automation 2019.11

do: custom3: - text: ${value} do: break: -


CUSTOM publish: - CUSTOM: aggregate - SUCCESS: skip_this

You can also use: for: "value in '1,2,3,4,5'"

Parallel Loop

A Parallel loop runs over a collection in an asynchronous way, meaning that each execution of the step is run
simultaneously and in a different context. A new branch is created for each value in a list and the branches run in
parallel. The various branches running the flow will run in parallel and the rest of the flow will continue only after
all the branches have completed.

For

The variable name that is assigned the current value from the collection that is defined in the In section. This
variable is available in the current running of the inner step as flow variable. In case of iterating map there
will be two variable names, for the key and value. This variable is required.

Supported characters: A to Z, a to z, 0 to 9, _ variable name starting with letter or underscore.

Example:

for: "value in '1','2','3'"

or

for: "value in '1,2,3'"

to actually entering a constant in the expression editor.

for: 'k,v in {"key1":"val1","key2":"val2"}'

In

The collection to be iterated on. You can use any Python expression that results in a list or map. The In
section contains drop downs that contain SP and flow variables. Click the Edit button to open the expression
dialog where you can insert any string. This variable is required.

Example:

Array: ['1','2','3','4'] or ['a','b','c','d']


Python expression: map(str,range(1,5))
Map: {"key1":"value1","key2":"value2"}

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 688
Robotic Process Automation 2019.11

Comma delimited strings: which would be split automatically into a list: "1,2,3"
Flow variable: select it from the drop down (all step published outputs and flow inputs).
System property: select it from the drop down.

Publish

The publish mechanism defines the step aggregation logic, generally making use of the branches_context
construct.

The branches context is a list that includes all the contexts of all the iterations. It is set according to the order
of execution, meaning that the execution that finishes first gets the first place in the list and so on.

After all branches of a Parallel Loop have completed, the execution of the flow continues with the publish
section. The expression of each output pair is evaluated and published to the flow scope.

In Parallel Loops, the publish keyword is at the loop level in the YAML and not as in a Loop where it is inside
the loop, in line with the do keyword.

In a Parallel Loop, there is no publish section inside the inner step. Instead, it publishes all the outputs of the
inner step by default to the branches_context, allowing for aggregation.

The aggregation syntax should be a python expression.

Example:

Retrieves the name variable from the first branch to finish:

- publish: - first_name: '${str(branches_context[0]["name"])}'

Publishes an aggregate output (it iterates over the :', which contains a list of all the iterations of the
Parallel Loop, and takes the value of 'name' from each branch):

- publish: - name_list: '${str([str(x["name"]) for x in branches_context])}'

Creates a list of branch results (as branches of a Parallel Loop complete, branch results get placed into the
branches_context list under the branch_result key):

- publish: - result_status_list: '${str([str(x["branch_result"]) for x in


branches_context])}'

Navigate

The navigation logic runs after the last branch has completed. If any of the branches return a result of
FAILURE, the flow will follow the navigation path of FAILURE. Otherwise, the flow will follow the SUCCESS

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 689
Robotic Process Automation 2019.11

navigation path. Any other result beside SUCCESS and FAILURE will be evaluated as SUCCESS.

For keys, the supported characters: A to Z, a to z, 0 to 9.

For values, restricted to step/result names.

Note

If the inner step does not contain a FAILURE result, the navigation (ports) do
not contain a FAILURE port, but only a SUCCESS port.

If a step has a custom result, after setting it in a parallel loop, the ports
change to be SUCCESS and FAILURE. After removing the step from the
parallel loop, the original ports of the step is returned.

Example:

- print_values: parallel_loop: for: value in values do:


print_branch: - ID: ${value} do: publish:
- name_list: '${str([str(x["name"]) for x in branches_context])}' navigate: - SUCCESS:
print_list - FAILURE: FAILURE

Regular Expression

Regular Expression filters the raw results using a regular expression (regex).

Example:

# regular expression # as above, requires another step base.string.match_regex: - regex:


'<expression>' - text: ${output1}

Replace

Replace replaces the first or last instance or all instances of one string with another string.

Use First, All, or Last, to define which instances of the target string to replace.

Example:

# replace first output1.replace('old', 'new', 1)

To make the search not case-sensitive, use Ignore case.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 690
Robotic Process Automation 2019.11

Example:

'abcabdAb'.lower().replace('ab'.lower(), 'XX')

Round Number

Round Number rounds numbers up or down.

Use Number of Decimal Places to define the number of decimal places the number should be rounded to.

Example:

# round # note: float function call is not always needed # note: python rounding of floats
sometime returns # unexpected results # see https://docs.python.org/2/library/functions#round
round(float(output1), <number_of_decimal_places>)

Round rounds the number up if the last significant digit is 5 or more, and down otherwise

Example:

round(2.734) -> 2.73

round(2.734, 2) -> 2.73

Select Range

Select Range defines a string that you want to extract from the input data. The two criteria for defining the
string are its length in characters and the position of its first character from the start of the input data.

Use Start to specify the zero-based start position of the string.


Keep in mind that a new line may count as one or two characters, depending on the operating system from
which you obtain the data you’re filtering.

Example:

# select range

# note: <end> is not included in the selection

output1[<start>:<end>]

Sorted

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 691
Robotic Process Automation 2019.11

Sorted orders the lines of input data by the first character in each line.

To specify the direction of the sort, use Ascending.


To order the data by ASCII order, use Treat as Numbers.

Note that ascending ASCII order is roughly as follows, for English characters:

White space
Symbols
Numbers
Alphabetic characters

Example:

# sort lines # note: returns a list, can be joined to a single string using join function
sorted(output1.split('\n'))

Strip

Strip strips characters from the beginning or end of the raw results.

Use Strip Method to specify how you want the filter to strip the raw results:

All Characters Up To the string.


All Characters Up To And Including the string.
All Characters After the string.
All Characters After And Including the string .

Use Characters to Strip to specify the string to find.


Example:

# strip other characters # note: can also be used with lstrip and rstrip
output1.strip(<characters_to_strp>)

Strip Whitespace

Strip Whitespace removes all the whitespace characters from the front and the end of the raw results.

Example:

# strip whitespace from both sides output1.strip() # strip whitespace from left side
output1.lstrip() # strip whitespace from right side output1.rstrip()

Table

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 692
Robotic Process Automation 2019.11

Table does not convert the raw results into a table, but enables you to manipulate the raw results as if they
were a table, including sorting columns and selecting columns, rows, and blocks.

Use Column Delimiter to specify the character that will serve to divide the data into columns in a
meaningful way.
Use Row Delimiter to specify the character that will serve to divide the data into rows in a meaningful way.

Note
Two or more consecutive whitespaces count as a single whitespace, so a
column may be occupied by data that you expected to find in a column to the
right. For example, this behavior will appear if you apply this filter to the
output of a “dir” command-line command with whitespace specified as the
column delimiter.

Use First Row is Header to treat the members of the first row as column headers, .
Use Strip First Row of Result to remove the first row.
Use Sort On Column to sort on a column, by specifying the (1-based) column number.

Tip
The value -1 means do not sort on any column.

Use Ascending to specify the ascending order. By default, the sort order is descending.
To select the row that you want the filter to extract, specify the row number with Select Row (-1 selects all
the rows) and specify the number of columns in that row that you want extracted using Select Width (-1
selects all the remaining columns to the right of the column specified by Select Col).
To select the column that you want the filter to extract, specify the column number with Select Col (-1
selects all the columns) and specify the number of rows in that column that you want extracted using Select
Height (-1 selects all the remaining columns to the right of the column specified by Select Row)
Example:

nd th
To extract the first 5 rows of the 2 through 4 columns, you would specify the following:

Select Row= 0 Select Height= 5 Select Col= 2 Select Width= 3

In these settings, the first two settings define the selected rows, and the last two settings define the selected
rows.

XML

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 693
Robotic Process Automation 2019.11

XML enables you to parse XML within a step, the XML being obtained from the step’s input or output. The XML
Get Attribute filter extracts the value for each of one or more instances of the attribute that you specify. You
can control which instance of the attribute the filter is applied to by specifying an element path to the attribute.

You can obtain the value for a single instance of the attribute or for multiple instances, returned in a table. In
such a table, the columns are comma-delimited and the rows are new line-delimited.

Using Element Path, specify the path of the element that contains the attribute whose value you want to
extract. Use forward slashes to separate the parts of the path to the element.
To control which instance of the element the filter gets the attribute’s value from, add a specification such as
[2] or [3]. The numbering of elements is 1-based (starts with [1]). Thus to specify the second instance of an
element, you would use [2].

To search child elements of the element you’ve specified, use Include sub-elements.
Using Attribute Name, specify the name of the attribute whose value you want.
For Result, use one of the following:

To restrict the result extracted to the value of a single instance of an attribute, use Single Match.
To extract the value of all the instances of the attribute you have named, use As Table.

Example:

# xml # requires another step base.xml.xpath_query: - xml_document: ${output1} - xpath_query:


<query> - query_type: <node|value|nodelist>

XML Get Element

XML Get Element enables you to extract an element in its entirety (including child elements, values, and
attributes) by describing it in any of the following ways:

Use Element Path to specify an absolute path to the element.

../ specifies the parent of the last-named element.


./ specifies the last-named element.
You can specify a particular instance of any element in the path with an integer inside square brackets.

Example:

/tickets/ticket/details/comment specifies all the comments in the details for all the tickets.

/tickets/ticket/details/comment[2] specifies the second comment for each ticket.

/tickets/ticket[2]/details/comment specifies all the comments for the second ticket.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 694
Robotic Process Automation 2019.11

Use Child Named to specify the name of an element that is a child of the element (or elements) that you
want to extract. If the child element has a value, you can narrow the results by specifying that value using
Value.

Child Named works for only one level of child elements. The filter only returns the direct parent of the
child element that you specify.
Value is intended for brief values. The value that you type there must be an exact match of the value of
the child element of the element that you want to extract.

Using Attribute Named, specify the name of an attribute that is unique to the element you want to extract.
To further narrow the results, you can give a value of the attribute for Value.

Example:

# xml # requires another step base.xml.xpath_query: - xml_document: ${output1} - xpath_query:


<query> - query_type: <node|nodelist>

XML Get Element Value

XML Get Element Value enables you to get the value of a specific element.

Use Element Path to specify the path to the element whose value you're interested in.

As with the other filters, if there are multiple instances of an element, the filter returns the first one, unless you
specify a different instance.

Example:

# xml # requires another step base.xml.xpath_query: - xml_document: ${output1} - xpath_query:


<query> - query_type: <node|value|nodelist>

XPath Query

XPath Query enables you to extract data from the result with queries that use the standard XPath syntax,
which you define for XPath Query .

The path that precedes the square brackets identifies the scope of the query with which you are narrowing
the results.
Square brackets contain the filtering portion of the query. There can be more than one set of filters in a query.
Example:

# xml # requires another step base.xml.xpath_query: - xml_document: ${output1} - xpath_query:


<query> - query_type: <node|value|nodelist>

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 695
Robotic Process Automation 2019.11

Related topics
To add decisions to a flow, see Add decisions to a flow.
To change the start step, see Change the start step.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 696
Robotic Process Automation 2019.11

Add decisions to a flow


A Decision is a step that serves as a gateway for a decision in a flow. A Decision performs a calculation and then
controls the direction of the flow, based on rules that are used to calculate the result. Decisions do not perform
actual operations but only calculate where to navigate next.
A Decision might compare two values and return the difference between them. If the result is higher than a
specified value, the flow will branch to one direction and if the result is lower, it will branch to another direction.

Recommendations to use a decision


It is optional to add Decisions to a flow.

Decision names can contain alphanumeric characters, and underscores ( _ ).

Decision names cannot contain parentheses ( () ), square brackets ( [] ), curly braces ( {} ), hypens ( - ), spaces (
), and dots (.).

Decisions are read-only and cannot be created and edited in RPA Workflow Designer, or copied to the Projects
pane.

You can use them as steps in flows by dragging them from the Dependencies pane.

Add a decision step to a flow


1. Drag a Decision from the Dependencies pane to a flow in the Authoring pane.

Decisions appear in the Dependencies pane with an icon in the shape of a badge .

In the Authoring pane, they appear in the shape of a diamond.

2. Drag navigation lines from the decision step's response ports to other steps.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 697
Robotic Process Automation 2019.11

3. Click the decision step to open the Step Properties pane at the right side of the canvas.

4. Under Inputs, enter any relevant inputs. For example, if the action is to compare two values, specify how
these values will be assigned to the inputs.

5. Under Outputs, enter any relevant outputs.

View the details of a Decision


You can view the details of the Decision in the Editor.

1. Double-click a Decision in the Dependencies pane, in order to display its details in the Editor.

Decisions appear in the Dependencies pane with an icon in the shape of a badge .

2. Under Inputs, view the inputs that were defined for this decision. For example, if the action is to compare
two values, these are included as inputs.

3. Under Outputs, view any outputs that were defined for this decision.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 698
Robotic Process Automation 2019.11

4. Under Results, view the results that were defined for this decision.

5. Under the Description tab, view a description of what the Decision does, if one was entered.

6. To view the code behind the Decision, click the Show as Text button. A text box appears, displaying the
code.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 699
Robotic Process Automation 2019.11

If there is an error in the decision step, a red error flag is displayed. Click the flag to display a tooltip with
information about the error.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 700
Robotic Process Automation 2019.11

Related topics
To learn more about defining step properties, see Define step properties.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 701
Robotic Process Automation 2019.11

Assign a step to a worker group

Worker groups
Many deployments can benefit from having more than a single worker in a specific environment. For example, this
could be helpful if you are managing a remote data center in which you need workers to be able to withstand the
action execution load, or simply for high availability of the workers in that data center.
Therefore RPA includes the notion of a “worker group”. A group is a logical collection of workers and a worker may
belong to more than one group simultaneously. Having a worker group helps prevent bottlenecks, because a step
can run on any of the workers in the group.
Groups can be created and workers assigned to groups in RPA Central.

Group aliases
In RPA, in addition to worker groups, there is another level of flexibility in the assignment of an operation to a
worker (or workers). Group aliases let you separate between assigning an operation to a worker during authoring
time and in the runtime environment. At authoring time, an operation can be defined to execute on a group alias
rather than a group. The alias is then mapped to a group in the runtime environment at the Central level. As a
fallback, if the group alias is identical to the group name, it is mapped automatically to that group. Optionally, at
triggering time, it is possible to override the group alias and map the operation to a different worker group.
Using this functionality, the RPA administrator can let the author use an alias, for example, WorkerAlias1. In RPA
Central, the administrator maps the alias to the actual worker group. When the content pack is imported to RPA
Central, there is no need for the administrator to dive into the flows and modify the worker assignment manually.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 702
Robotic Process Automation 2019.11

Assign a step to a worker group


In Operations Orchestration Workflow Designer, you can assign a specific step of a flow to a specific worker group
or groups.
The steps can be from OO native content packs (Created using OO Desktop Studio) or CloudSlang content packs
(Created using OO Workflow Designer).
To assign a specific step to a worker group, complete the following:

1. In the Authoring pane, right-click the CloudSlang or the OO native step. A list of options are displayed.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 703
Robotic Process Automation 2019.11

2. Select the Set Worker Group option. A new field will appear in the Step Properties>Inputs tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 704
Robotic Process Automation 2019.11

Alternatively, click the Toggle Worker Group icon from the authoring pane to assign a step as a Set
Worker Group.

3. Select the field input value and then click Save. The step is assigned with a worker group and the CloudSlang
code is updated

The field values can be a constant, an expression or a flow variable or a system property.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 705
Robotic Process Automation 2019.11

4. Run a flow. Each step will be run on the specified worker group.

In the following illustration of a CloudSlang code in view as a text, the first step has a worker group set from a
flow variable and the second one is set from a constant.

Related topics
To add decisions to a flow, see Add decisions to a flow.
To change the start step, see Change the start step.
To create flows with loops, see Create flows with loops.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 706
Robotic Process Automation 2019.11

Change the start step


By default, the first step that is dragged onto the canvas for a flow is flagged as the start step for that flow. The
start icon appears in the corner of the step.

However, you can assign another step to be the one that starts the flow.

Change the start step in a flow


To assign a step as the starting point of a flow:

Right-click the step and choose Set as start Step option from the list or

Select the step, and then click the Set as Start Step button in the Authoring pane

The start icon appears in the corner of the step icon, and is removed from the default start step.

Remove the start step in a flow


It is not possible to have a flow with no start step.
The only way to remove the start icon from a step is to assign a different step as the start step.

Related topics
To create a step in the flow, see Create steps in a flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 707
Robotic Process Automation 2019.11

Create flows with loops


You can set a step as a loop, in order to create an iterative task. A loop step can be based on an operation or flow.
RPA Workflow Designer supports two kinds of loops:

Loop

A loop step runs over a collection of items in a synchronous way.

Steps that have been set as a loop appear with a circular arrows icon.

Parallel loop

A parallel loop step runs over a collection of items in an asynchronous way. This means that the step can run
simultaneously and in different contexts.

Steps that have been set as a parallel loop appear with a branch icon.

Create a flow with a loop


1. Create a flow and select the step that you want to use as a loop step.

2. Click the Create Loop button in the authoring pane toolbar.

3. From the menu that appears, select Set as loop.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 708
Robotic Process Automation 2019.11

4. For a step that has been set as a loop, the Step Properties > Inputs tab has an extra Loop Details
section, where you can define the collection that the input will be iterated on and the break points of the loop.

For: Enter the name of the variable that will be assigned the current value from the collection that is
defined under In. This step is compulsory.

This variable will be available while the loop step is running.

In: Define the collection to be iterated on. This step is compulsory.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 709
Robotic Process Automation 2019.11

You can define the collection using a flow variable or system property. For example, you can create a
system property with a comma delimited string ('1,2,3,4,5') as the value and use this to define the
collection.

Note
The evaluation of the flow variable or system properties must be a string as
CloudSlang supports only strings. For example. 'Range(1,6)' will work inline
only if the for variable (which will be a digit) isn't assigned to an inner step
input (which requires string). It will not work if passed as a value of system
property or flow variable.

You can also open the Expression Editor and write a Python expression that results in a list or map. For
example:

An array: ['1','2','3','4'] or ['a','b','c','d']

A Python expression: map(str,range(1,5))

A map: {"key1":"value1","key2":"value2"}

A comma delimited string, which will be split automatically into a list: '1,2,3'.

Break On: A loop ends either when the list that it is looping on is finished or when the looped step returns
one of the results defined as a break point.

Click the Select break result to add button to choose one of the step results as a break point. There
can be multiple break points.

Note

To remove a break point, roll over it so that the Remove button is

displayed, and click the Remove button.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 710
Robotic Process Automation 2019.11

5. In the Step Properties > Outputs tab, define how the output will be published. At run time, the output will
contain the value from the last iteration of the loop.

a. Click the Add a Step Output button to add a new output to the step.

b. Choose one of the underline outputs to define the output.

c. Under Value, open the Expression Editor and enter a Python expression to aggregate all the iterations.

d. Set up the navigation logic for the loop step.

The navigation to the next step in the flow occurs when the last iteration of the step is completed or
after the loop exits the iteration due to a break. The navigation will run according to the last iteration of
the loop.

Note
If you want to use the for value inside the step, you must add it as the
value to one of the step inputs.

Aggregation of loop outputs


To aggregate the results of a specific loop step, proceed as in the following example, where we add the numbers
generated in the loop's iterations:

1. Import a base content pack onto dependencies pane and choose the random_number_generator
operation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 711
Robotic Process Automation 2019.11

2. Drag the random_number_generator operation to the flow and set the resulting step as a loop.

3. Define the collection that the loop will run on as shown in the following example image.

4. Enter the values for min and max Step Inputs.

5. Define the aggregated output for the loop step. The random_number output shown in the above image is
optional.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 712
Robotic Process Automation 2019.11

The Python expression for the sum_random output using (aggregating) the outputs from the iterations is:

6. Add a new Step Input and rename it as the Output. For example the following image shows the Step Input
name as sum_random. This sum_random step input is assigned from itself, or with 0 when it has no value
yet (at the first iteration).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 713
Robotic Process Automation 2019.11

7. Click Save . The flow is saved.

Create a flow with a parallel loop


In a parallel loop step, a new branch is created for each value in the collection and the branches run in parallel. The
rest of the flow will continue only after all the branches have finished running./

1. Create a flow and select the step that you want to use as a parallel loop step.

2. Click the Create Loop button in the Authoring pane toolbar.

3. From the menu that appears, select Set as a parallel loop.

4. For a step that has been set as a loop, the Step Properties > Inputs tab has an extra Loop Details

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 714
Robotic Process Automation 2019.11

section, where you can define the collection that the step will iterate on.

For: Enter the name of the variable that will be assigned the current value from the collection that is
defined under In. This step is compulsory.

This variable will be available while the loop step is running.

In: Define the collection to be iterated on. This step is compulsory.

You can define the collection using a flow variable or system property. For example, you can create a
system property with a comma delimited string (1,2,3,4,5) as the value and use this to define the
collection.

You can also open the Expression Editor and write a Python expression that results in a list or map. For
example:

An array: ['1','2','3','4'] or ['a','b','c','d']

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 715
Robotic Process Automation 2019.11

A Python expression: map(str,range(1,5))

A map: {"key1":"value1","key2":"value2"}

A comma delimited string, which will be split automatically into a list: '1,2,3'.

5. In the Step Properties > Outputs tab, define how the output will be published.

a. Click the Add a step output button to add a new output to the step.

b. Choose one of the underline outputs to define the output:

c. Under Value for the output, open the Expression Editor and enter a Python expression to aggregate the
outputs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 716
Robotic Process Automation 2019.11

To define the step aggregation logic, you can use the branches_context construct. This is a list that
includes the context of all the iterations. The branches_context is set according to the order of the
executions, so that the execution that finishes first takes the first place in the list, and so on.

After all the branches of the parallel loop have completed, the execution of the flow continues with the
output that is published. The expression of each output pair is evaluated and published to the flow's
scope. The out-of-the-box outputs are name (first branch), name_list, iteration_size,
result_status_list, and num_of_failures.

Examples:

To retrieve the name variable from the first branch to finish:

branches_context[0]['name']

To publish aggregated output: (this iterates over the branches_context, which contains a list of all the
iterations of the parallel flow, and takes the value of 'name' from each branch)

str([str(x["name"]) for x in branches_context])

To create a list of branch results: (as branches of a parallel flow complete, the branch results get
placed into the branches_context list under the branch_result key)

str([str(x["branch_result"]) for x in branches_context])

To configure the iteration size.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 717
Robotic Process Automation 2019.11

str(len(branches_context))

To configure the number of failures, use num_of_failures:

str([x["branch_result"] for x in branches_context].count("FAILURE"))

Remove the loop from a step


1. Select the loop step.

2. Click the Create Loop button in the Authoring pane toolbar.

3. From the menu that appears, click the selected option to clear it.

Related topics
To create or edit a flow, see Create or edit a flow.
To create steps in a flow, see Create steps in a flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 718
Robotic Process Automation 2019.11

View the CloudSlang code


View the CloudSlang code about the inputs, outputs, and results of the step.
You can see information about the step's inputs, outputs, and navigation steps in the CloudSlang code for the flow.

To view the code, click the Show as Text button in the Authoring pane toolbar.. A text box appears, displaying
the code. The details of the steps are displayed in the "workflow:" section.

Related topics
YAML file textual representation

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 719
Robotic Process Automation 2019.11

YAML file textual representation


You can view the YAML file corresponding to a selected flow, operation, decision, or system property, by clicking

the Show as Text button in the Authoring pane toolbar.


The YAML file includes the textual representation of the UI editor, so that each action done in the UI editor, such as,
for example, adding inputs, editing outputs, adding steps, is reflected in the YAML file. It is not recommend to set a
default constant value when an input and output is marked as sensitive. The values are displayed as asterisks in
the file.
Example of a typical file:

The first part (in green) displays the contents of the description of the item (flow, operation, decision, system
property), as well as the description of input, output, and result.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 720
Robotic Process Automation 2019.11

#!! #! @description: This flow does something. #! @input flow_input_0: This input is for
something... #! @output flow_output_0: This output is for something... #!!#

The second part (in blue), starting with namespace:, provides the CloudSland code that corresponds to the
information about the selected flow or system property that were entered in the UI editor.

namespace: sss flow: name: flow1 inputs: - flow_input_0:


"${get_sp('io.cloudslang.base.from')}" - flow_input_1:
"${get_sp('io.cloudslang.base.hostname')}" workflow: - get_time: do:
io.cloudslang.base.datetime.get_time: [] navigate: - FAILURE: CUSTOM -
SUCCESS: SUCCESS outputs: - flow_output_0 results: - SUCCESS - CUSTOM

The third part (in blue), starting with extensions: provides the CloudSlang code that enables the graphical
representation of the flow in the Graph tab. At run time, this section is ignored.

extensions: graph: steps: get_time: x: 64 y: 132 navigate:


dd888147-9fbf-25ef-bee5-d9946ce91bef: targetId: 519f1a15-eeb9-65f8-c115-bb0d96faff02
port: SUCCESS 56ba3221-c9f9-6dc5-689a-ffbd26643467: targetId: 54582fee-
d5e9-315e-149a-5c2a884c0297 port: FAILURE results: SUCCESS: 519f1a15-
eeb9-65f8-c115-bb0d96faff02: x: 384 y: 75 CUSTOM: 54582fee-
d5e9-315e-149a-5c2a884c0297: x: 360 y: 230

Related topics
To view the CloudSlang code, see View the CloudSlang code.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 721
Robotic Process Automation 2019.11

Validate flows
There are a number of built-in validation errors and warning in RPA Workflow Designer.
It is highly recommended to check that your flows are valid before exporting your content to a content pack, as
invalid content will not be exported to content packs.
This section provides the location of errors and warnings appearing in the UI.

View errors
You can validation errors on the following panes of RPA Workflow Designer

Projects or Dependencies pane

If there is an error anywhere in the Project pane or Dependencies pane, (in a flow, operation, or system
property), the item with the error is displayed with a red underline. All flows that use this item and the folders
above it are also displayed with a red underline.

When you fix the error, the red lines disappear under that item and under the folders that contain it or flows that
use it.
As soon as you add or create a flow, RPA Workflow Designer automatically runs the validation and displays all
errors underlined. There is no need to do anything to start this process.

Authoring pane

Flow tabs. If there is any error on the flow\operation, an error flag appears on the tab. Click the error flag to
display a tooltip with a detailed list of errors.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 722
Robotic Process Automation 2019.11

Flow inner Graph or Properties tabs.

If a flow or its properties contain errors, an error flag is displayed in the Graph and/or Properties tabs at the top
of the Authoring pane. This flag includes a number, representing the number of errors.

Click the error flag to display a tooltip with a detailed list of errors.

Error indications on the step. if there is an error in a step, that step appears with an error flag in the top left
corner.

Tip
Click an error flag to display a tooltip with information about the error.

If there is a step with a missing dependency (for example, a step that is based on a flow that was deleted), that
step appears with a gray, striped background.

Errors on the step properties tabs.

If there is an error at the step inputs or outputs, a red error sign is displayed in the Step Properties pane, on the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 723
Robotic Process Automation 2019.11

Inputs and/or Outputs tabs. This includes a number, representing the number of input or output errors in the
step.

Errors inside step inputs tab and step outputs tab.

Errors in a specific input or output appear as a red error sign in the top left corner. Click to display the detailed
error tooltip.

While you are entering text in a field (for example, entering a flow input), if the value being entered will cause
the underlying YAML file to be corrupted, RPA Workflow Designer shows a red warning on the text field. If you
focus out of the field at this point, the value will be reset to the previous value.

Error indication on the flow inputs, inputs, or results.

If there is an error at the flow inputs, outputs, or results, a red error sign is displayed in the Inputs, Outputs, or
Results tabs in the flow Properties tab. This includes a number, representing the number of errors. Click the
error flag to display the detailed error tooltip.

Inside each tab, the elements with errors appear with a red error sign in the top left corner. Click the error flag to
display the detailed error tooltip.

Errors on flow identifier.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 724
Robotic Process Automation 2019.11

If the flow identifier already exists in the workspace, an error is issued and appears at the top left corner of the
flow identifier. Click the error flag to display the detailed error tooltip.

Check for errors in the step properties

1. Click a step in the Authoring pane. The Step Properties pane appears at the right side of the canvas.

The Step Properties pane contains the Inputsand Outputs tabs, with information about the selected step.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 725
Robotic Process Automation 2019.11

2. Expand or collapse this pane by clicking the Expand or Collapse button.

3. The tabs display any relevant warnings in the inputs, outputs, or results.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 726
Robotic Process Automation 2019.11

View warnings
Warnings are issued if there is a problem, but it does not prevent the relevant operation to be performed. For
example, if there is invalid content in a content pack that you try to download, the dialog box displays a warning
message that there are invalid flows, which will not be packed inside the content pack.

Related topics
To create steps in a flow, see Create steps in a flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 727
Robotic Process Automation 2019.11

Author operations
An operation is an executable that performs a single action. It has metadata like a flow (inputs, outputs and
results). For example, one operation checks a web page to see whether it contains specific text, and another
operation copies a file.
The action in an operation can be Java-based or Python-based.
There are two types of actions in CloudSlang:

Python-based actions.
Java-based actions.
Operations must be created externally . They can then be imported:

As part of content packs, they are displayed in the Dependencies panel. They are read-only. They cannot be
copied.
Via Source Control Management (SCM), they are displayed in the Projects panel. They are read-only. They
cannot be copied.
In RPA Workflow Designer, you can use operations in flows by dragging the operation from the relevant content
pack from the Dependencies pane. You can also import a repository that includes the operation by dragging it
from the Projects panel. In both cases, the operation is read-only.

Operation file structure


An operation file must end with the .sl extension and start with a namespace.
Example of an operation file with its namespace.

namespace: io.cloudslang.base.comparisons operation: name: less_than_percentage inputs: -


first_percentage - second_percentage python_action: script: | error_message = ""
result = "" first_percentage_nr = first_percentage.replace("%", "") second_percentage_nr
= second_percentage.replace("%", "") try: int_value1 = int(first_percentage_nr)
int_value2 = int(second_percentage_nr) result = int_value1 < int_value2 except
ValueError: error_message = "Both inputs have to be integers" outputs: -
error_message results: - LESS: ${error_message == "" and result} - MORE: ${error_message
== "" and not result} - FAILURE

All CloudSlang files start with a namespace, which mirrors the folder structure in which the files are found. The
namespace can be used by flows that call this operation.

Validate operations
Operations are validated and will not work when:

Missing action. Operations must contain an action.


Corrupted YAML.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 728
Robotic Process Automation 2019.11

Duplicate inputs. When an input is duplicated, or two inputs have the same name but use different cases (for
example: Ping and ping).
Input\output\result name or value.

Name cannot be empty


The combined input name, flow name, and folder path of the input (under the Library folder) must add up to
no more than 255 characters.

Note
For localized characters, this limit is even lower. For example, in Japanese, the
255 characters need to be divided by 4, so the number of characters is only
64.

Name must be unique.


It is recommended to manually validate the inputs that your operation will receive. For example, if you expect a
number, make sure that the input is a string representing a number. If you expect an email address, check that
the format complies with an email address format.

Missing rules in operation results. Operation with more than one empty result (with no defined rule).
Operations can have multiple expression results, but can have only one mandatory empty default result, and it
must be the last one.
Incorrect operation name. When the name of the operation does not comply with the rules below:

Name cannot be identical to the following reserved word: "on_failure".

Names must be unique within their folders.

Names are not case-sensitive, so names such as "Ping" and "ping" are considered duplicates. However, when
calling an item, make sure to use the correct case.

Names can contain alphanumeric characters, and underscores ( _ ).

Names cannot contain parentheses ( () ), square brackets ( [] ), curly braces ( {} ), hypens ( - ), spaces ( ), and
dots (.).

Names cannot be identical to the following Windows reserved words: CON, PRN, AUX, CLOCK$, COM1, COM2,
COM3, COM4, COM5, COM6, COM7, COM8, COM9, NUL, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8,
LPT9 .

Decisions. A Decision is a step that serves as a gateway for a decision in a flow. A Decision performs a
calculation and then controls the direction of the flow, based on rules that are used to calculate the result.
Decisions do not perform actual operations but only calculate where to navigate next. They are read-only. Their

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 729
Robotic Process Automation 2019.11

inputs, outputs and results can be viewed but not edited.

Use Java based actions


A Java-based operation includes inputs, outputs, results, and one action.
Java-based actions are read only and you cannot add\copy\edit them. They can only be found under the
Dependencies panel, or imported using Source Control Management (SCM) (you cannot edit and copy them even if
they are located in the Projects panel). You can use them as steps in flows by dragging them from the
Dependencies or the Projects pane.
Use the Operation Editor to display information about an operation.

Java Actions

Java action contain the following elements:

GAV. GAV is short for "Group, Artifact, Version". The GAV coordinate standard is the foundation for how Maven
manages dependencies.

A group identifier groups a set of artifacts into a logical group


An artifact is an identifier for a software component
The version of a project follows the established convention of Major, Minor, and Point release versions.
Class Name. This is the class within the GAV where the running method can be found.
Method Name.This is the method to run within the action.

View the properties of a Java operation

1. Double-click an operation in the Projects or Dependencies pane to open it in the Operation Editor as read-
only.

The Java Action view displays the GAV (group, artifact, version), class name, and method name that define
the Java action in the operation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 730
Robotic Process Automation 2019.11

2. Click the Properties button to display the Properties view.

You can return to the Java Action view, by clicking either the Java Action button or the Back to Action

button.

3. Under the Inputs tab, view the inputs that the operation receives. Each input in an operation has a value that
can be set in a number of ways. It may be a constant value, a python expression, the value of a flow variable
or system property, and more.

4. Under the Outputs tab, view the values returned from the Java code. They will be sent back to the calling
step.

The Outputs tab lists any information that needs to be sent back to the calling step. The outputs are a list of
key:value pairs where the key is the name of the output and the value is the expression to be returned,
blank, constant, or more.

5. Under the Results tab, view the results that will be returned to the calling flow.

6. Under the Description tab, view a description of what the operation does, if one was entered.

7. To view the code behind the operation, click the Show as Text button. A text box appears, displaying the
code.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 731
Robotic Process Automation 2019.11

8. Click OK to close the text box.

Use python based operations


Python operations can be created, imported, and copied from both the Projects panel and the Dependencies panel.
It include inputs, outputs, results, and actions.
Example:

namespace: io.cloudslang.base.comparisons operation: name: less_than_percentage inputs: -


first_percentage - second_percentage python_action: script: | error_message = ""
result = "" first_percentage_nr = first_percentage.replace("%", "") second_percentage_nr
= second_percentage.replace("%", "") try: int_value1 = int(first_percentage_nr)
int_value2 = int(second_percentage_nr) result = int_value1 < int_value2 except
ValueError: error_message = "Both inputs have to be integers" outputs: -
error_message results: - LESS: ${error_message == "" and result} - MORE: ${error_message

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 732
Robotic Process Automation 2019.11

== "" and not result} - FAILURE

You can use operations as steps in flows by dragging them from the Dependencies pane or from the Projects
pane.
Use the Operation Editor to display information about an operation.

Create a Python operation


1. In the Projects pane, select the folder in which you want to create a new Python operation.

2. Press Alt + O or click the New button and select Python Operation.

Tip: You can also right-click the Projects Folder and select Add Python Operation.
3. In the New Operation dialog box, enter a name for the Python operation and click OK.

Note
When naming a Python Operation, make sure the naming conventions are
followed. To change a Python Operation, copy it as a Python Operation with
the correct name.

A new tab opens in the PYTHON ACTION pane or a Python textual editor with the
name of the new Python Operation.

4. Click the Properties button to display the Python operations Properties pane.

5. Enter names and values for Inputs, Outputs, Results, and Description tabs.

Note: You can define rules for Results. You must also ensure that there is only one default ending result and
that it is on a last position.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 733
Robotic Process Automation 2019.11

6. Click PYTHON ACTION and enter the python script as displayed in the following
example image.

Note: Python Operation editor supports multi-line code.

7. Navigate to Properties>Outputs and Properties>Inputs to enter the values for the Inputs and Outputs
based on the Python operation script.

8. Save the Python operation script

9. Drag and drop the Python operation inside an existing flow or a new flow on the canvas for debugging
process.

View the properties of a Python operation


1. Double-click an operation in the Projects or the Dependencies pane to open it in the Operation Editor as
read-only.

The Python Action view displays the python action script.

2. Click the Properties button to display the Properties view.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 734
Robotic Process Automation 2019.11

You can return to the Python Action view, by clicking either the Python Action

button or the Back to Action button.

3. Under the Inputs tab, view the inputs that the operation takes. Each input in an operation has a value that
can be set in a number of ways. It may be a constant value, a python expression, the value of a flow variable
or system property, and more.

a. Under the Outputs tab, view the values returned from the python script, which will be sent back to the
calling step.

The outputs are a list of key:value pairs where the key is the name of the output and the value is the
expression to be returned, blank, constant, or more.

For example:

‘outputs:

- available: ${vacant}’

will return the value of a variable called ‘vacant’ in the python code, with the name of ‘available’ to the
calling flow. More complicated expressions can be passed, such as trimming, parsing etc. Output
expressions must evaluate to strings.

If the value is blank, the output result will be the name of the output, which will translate to a python
variable that is declared inside a python code. For example, ‘outputs: -vacant’ will return the value of
the variable vacant under its’ original name as declared inside the python code.

4. Under the Results tab, view the results that will be returned to the calling step.

5. Under the Description tab, view a description of what the operation does, if one was entered.

6. To view the code behind the operation, click the Show as Text button. A text box appears, displaying the
code.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 735
Robotic Process Automation 2019.11

Note
Python scripts are not validated inside RPA Workflow Designer.

7. Click OK to close the text box.

Related topics
For instructions to add decisions to a flow, see Add decisions to a flow
To debug a flow, see Debug the flow

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 736
Robotic Process Automation 2019.11

Hybrid authoring in RPA Workflow Designer


As an author you can now open and use the native content packs steps along with CloudSlang content pack steps
together to create flows or operations.
Perform the following actions in hybrid authoring:

1. Open the native content packs flows, operation, system account, and system property. The linking of system
account, system property, and configuration items such as selection lists, domain terms etc are disabled.

2. View a proper reason for an invalid native OO items.

3. Drag and drop the native items into CloudSlang flows.

4. Link native step to CloudSlang step and vice-versa.

5. Link flow variables into native steps such as inputs and outputs.

6. Create custom inputs on the OO native content pack step.

When you drag and drop the native step with configurations items set at flow level (system accounts, system
property, and so on) the native configuration settings is lost requiring manual authoring and CloudSlang
alignment.

7. Click Outputs and select to view and use the output field of the OO native content pack flows.

Below example shows the usage of sleep operation of native content pack.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 737
Robotic Process Automation 2019.11

Related topics
For information related to authoring flows, see Author flows.
For information related to authoring operations, see Author operations

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 738
Robotic Process Automation 2019.11

Author System Properties


System Properties are global variables with values that do not change. Once created, you can use these system
properties in any flow without having to recreate a flow variable each time. The flow referenced to a system
property obtains the value of the system property.
More about system properties
For example, you can set a system property whose value is the URL of a server, and then use this property in a
flow that runs a series of actions on the server. Rather than entering the URL each time, you can just select the
property.
System properties are stored in system properties files located in the Configuration/System Properties folder.

(Optional) You can add extra folders, to organize the system properties files.
Naming system property files

The name of a system property is limited to 128 characters.

Valid characters for system property names are: a-z A-Z, 0-9, underscore ( _ ), and hyphen ( - ).

Period (.) can be used as delimiter (only in the middle of the name).

The combined name and path of a system property (under the Configuration/System properties folder) is
limited to 220 characters.

Names must be unique within their folders.

Names are not case-sensitive, so names such as "Ping" and "ping" are considered duplicates. However, when
calling an item, make sure to use the correct case.

A system property name cannot include spaces.

Names cannot be identical to the following Windows reserved words: CON, PRN, AUX, CLOCK$, COM1, COM2,
COM3, COM4, COM5, COM6, COM7, COM8, COM9, NUL, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8,

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 739
Robotic Process Automation 2019.11

LPT9 .

If you enter a name with an error, an error indication is displayed. When you focus out of the field, the value will
be reset and a default name assigned.

In certain cases, if the change is causing the YAML to be corrupted (for example name too long) the name will be
reset. Otherwise, it will not be reset and an error indication is displayed.

Create a system properties file containing system properties

1. In the Projects pane, expand the Configuration folder.

2. From the System Properties folder or a subfolder within the System Properties folder, click the New

button and select System Properties File.

NoteYou can also click the New button to create folders in which to store
the system properties files.

3. Enter a name for the system properties file and click OK.

4. In the Authoring pane, under the system properties file tab, click the New button to add a new
system property to the system properties file.

5. Enter the details of the system property in the columns:

Identifier: Generated automatically, based on the namespace and the name that you provide in the
Name column.
Name: Enter a unique name.
Value: Enter a value for the system property.
Sensitive: Select the check box, if the system property contains sensitive data. During runtime, the value
will be encrypted.

Tip
It is recommend not to set a value when a system property is marked as
sensitive. The sensitive values appear as asterisks in the file.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 740
Robotic Process Automation 2019.11

As you enter text in a field, if the value being entered will cause the underlying YAML file to be corrupted,
RPA Workflow Designer shows a warning on the text field. If you select a different field at this point, the
value will be reset to the previous value.

6. Repeat to add more system properties to the system properties file.

7. Click the Save button in the Authoring pane.

8. Click Show as Text to display the system properties file information in YAML code and click OK to close.

Manage individual system properties

1. To edit a System Property:

a. Open a system properties file containing it, and then double-click the cell you want to edit.

Tip
You can use the Tab key to move between cells in a row.

a. After making changes, click the Save button in the Authoring pane.

2. To delete a System Property from within a system properties file:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 741
Robotic Process Automation 2019.11

a. Click on the system property row to select.

b. Click the Delete button.

c. Click the Save button in the Authoring pane.

Note
If you delete a system property that is used in a flow, this system property will
still be shown as selected in the flow. You need to replace this in the flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 742
Robotic Process Automation 2019.11

Debug the flow


You can debug flows directly in Workflow Designer or you can execute the flow remotely in Robotic Process
Automation (RPA) Central.

Debug in Workflow Designer


To debug a flow in Workflow Designer:

1. Open an existing flow from the project pane or from an imported Content Pack (CP).

2. Click to expand the Debugger pane.

3. Click Start or press Alt + F11 in the keyboard to begin the debug process. To cancel the debug process,

click Cancel or press Alt + F12.

Debug to RPA Central


Debugging a flow from Workflow Designer to a remote RPA Central enables you to connect to RPA Central remotely
and trigger a hybrid flow directly into it. Hybrid flows are flows that contain both CloudSlang and RPA legacy
operations and flows.
To debug a hybrid flow from Workflow Designer to RPA Central:

1. Open an existing flow from the project pane or from an imported Content Pack.

2. Click to expand the Debugger pane.

3. Click Start or press Alt + F11 in the keyboard to begin the debug process.

4. In the Debug to Central dialog box, enter the HTTPS connection details of your RPA Central environment. To
avoid the RPA Central login screen when triggering a hybrid debug, you can configure the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 743
Robotic Process Automation 2019.11

cors.security.origin.whitelist system configuration as a list of semicolon (“;”) delimited trusted endpoints.

5. Click Approve in the Approve Certificate dialog box. This imports the RPA Central's certificate
automatically into the Designer's TrustStore, if it was not already imported earlier.

6. Enter your credentials in the RPA Central Log in screen. To avoid this screen, configure the
cors.security.origin.whitelist system configuration as a list of semicolon (“;”) delimited trusted endpoints.

7. The flow will be triggered on the targeted Central and the actual run will be displayed in a pop-up window.
From here you can resume, pause, cancel or reassigned the flow to a different user. If run succeeds, a drill-
down based view on the flow will be displayed. The Run is superseded with the Debug text.

Debugging prerequisites
Only users with Remote Debugging permissions assigned from Central can debug flows.
Flows that have not been deployed to Central can be debugged as long as all the dependencies are available in
the Central environment.
Make sure RPA Central and RPA Workflow Designer have the same version.
Check that RPA Central and RPA Workflow Designer use the same CP versions (recommended).

Debugging restrictions

The Debug icon is disabled for invalid flows.


Debugging of operations, decisions, and system properties is not available yet.
You can only debug flows containing RPA activities on the machine where RPA Recorder is installed.

Debugging in a multi-author environment


In the multi-author environment:

A user can debug multiple flows at the same time.


A user cannot debug the same flow while it is still in the debugging process.
Multiple users connected to one Designer can debug the same flow in their work-spaces.

Debugging statuses
After debugging the flow, you can view the outputs and results of the flow in a Run Tree pane. Select any node in
the Run Tree to check the context of that step in the Context Inspector.
The table below explains all possible debugging statuses.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 744
Robotic Process Automation 2019.11

Icon Description

Flow is currently in debugging process

Failure result

Success result

Debug canceled or terminated abruptly

Runtime exception

Custom result

Errors and warnings


Errors and warnings are displayed at the footer of the Debug to RPA Central window as shown below. Investigate
logs of both RPA Workflow Designer and RPA Central if errors occurs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 745
Robotic Process Automation 2019.11

Related topics
For instructions on how to validate flows, see Validate flows
For details about system information and settings, see System information and settings

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 746
Robotic Process Automation 2019.11

Create an RPA activity

After setting up your RPA Workflow Designer project, add new RPA activities to it by recording your screen actions
or by importing existing actions from UFT tests. You can then configure these activities and use them to create
flows for running in RPA Central.

Record a new activity

Prerequisites

Before you start capturing screen data:

Ensure the RPA Recorder is installed on the computer or virtual machine where you want to record.
Ensure you have a valid port connection configured in the RPA Workflow Designer under Settings >
Connection.
Set up an RPA project to which you can attach the recorded activity.
Ensure that the Enhanced Security Configuration is set to Off in Server Manager when using Internet
Explorer (IE) browser.

Record your screen actions and generate input for automation flows

1. In the PROJECTS pane, expand your project to show the Library folder. If you do not have an RPA project to
which you can attach the recording, see Set up the RPA Workflow Designer project.

2. Right-click on the project's folder to which you want to add the record activity, and select Record RPA

Activity. Alternatively, you can also click the button and select RPA Activity.

3. In the New RPA Activity pop-up, enter the required activity name, and click OK. Keep the Use Run and
Record option enabled if you want to record using the applications you selected when you set up your
workspace.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 747
Robotic Process Automation 2019.11

4. Enter a valid RPA Activity name, and click OK. This adds a new RPA activity recording under your Library
folder and opens the ACTIVITY RECORDER controller bar.

5. Click to start the recording. RPA automatically opens the applications that you enabled for recording when
you set up your workspace.

6. Start performing the actions that you want to record. The Activity Recorder bar shows a real-time capture
of events.

7. To add a custom output value for a specific step, select the location icon from the Activity recorder
window.

8. Click on the screen element that you want to capture. This opens the STANDARD OUTPUT VALUE pop-up
window.

9. Update the Name of the captured output value and select the type of Property whose value you want to
retrieve, and click OK. The updated output value is available when the recording is complete.

10. Continue your screen actions as required, and click to stop the recording and display the recorded steps.

11. Click DONE to save the recording, and close the Activity Recorder window.

Change the recording mode

RPA Recorder has two modes for recording screen elements:

Default. A default selection for recording activity.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 748
Robotic Process Automation 2019.11

UI Automation. Available as a default skill when you face inadequate object identification of screen elements.
Microsoft User Interface Automation (UIA) is a framework that enables you to access, identify, and manipulate UI
elements of any application by providing programmatic access to these user interface elements. You can use the
UI Automation mode with any Windows-based application that has implemented UI Automation provider interfaces.
RPA uses different parts of the framework to properly create recorded RPA activities with UI Automation based
steps. These steps can be identified by the corresponding UI Automation terminology that appears for the recorded
steps..
To change the recording mode:

1. During the recording session, click Change Mode from the Activity recorder window. The CHANGE
RECORDING MODE dialog box opens.

2. Click Recording mode drop-down and select UI Automation.

3. Click OK to confirm and then continue with the recording session.

You can revert to the default setting anytime during the recording session by following the same steps.

Manage recording details

After completing the recording session, RPA Workflow Designer adds the recording to the project's activity. In
addition, a simple flow is created to hold the activity in a sequential manner.
The Authoring pane automatically opens to show the RPA ACTIVITY and the PROPERTIES tabs. Here you can
check the activity details and the properties of the captured events. You can also add input and output values for a
specific step or edit and delete recorded steps.

Use the buttons to undo/redo your actions on a recorded activity and view list of historical actions.

Import an UFT test


Import tests created in Unified Functional Testing (UFT) to leverage existing automated actions. Reusing UFT
actions enables you to create CloudSlang workflows quicker.

Compatible UFT packages

You can only import UFT tests that have been specifically designed to be opened in RPA. Make sure the package
you want to import has been exported from UFT using the Save for RPA option. Fore more information, see the
official UFT documentation.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 749
Robotic Process Automation 2019.11

1. In the PROJECTS pane, expand your project to show the Library folder. If you do not have an RPA project
into which to import the UFT script, see Set up the RPA Workflow Designer project.

2. Right-click on the Library subfolder to which you want to add the UFT activities and select Add RPA Activity.

Alternatively, you can also click the button and select RPA Activity.

3. In the New RPA Activity pop-up window, enter the required activity name, and click OK.

4. Click IMPORT TEST FROM UFT and navigate to the ZIP containing the UFT test that you want to import into
RPA.

5. Select your UFT package and click Open to import it into RPA Workflow Designer. Once the package is
successfully imported, Workflow Designer shows the project's GAV coordinates on the RPA ACTIVITY page.

Restrictions on editing imported UFT activities

RPA Workflow Designer exposes all the components of a UFT test that can be reused to create an RPA flow.
However, you cannot change some properties that might alter the main configuration of an UFT test. Use UFT to
reauthor tests if you cannot work with the following restrictions:

cannot delete inputs or steps


cannot delete Robot outputs
can only edit an input's Default Value and Description properties

Manage an RPA activity

Edit the input value of a step

1. Open the PROPERTIES tab of a recorded or imported activity.

2. In the Inputs section, select the activity step whose value you want to change.

3. Double-click on the Default value field and enter the new input constant.

4. Click SAVE.

Customize run settings of an activity

You can customize the Run Settings for a specific activity for various use case, for example::

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 750
Robotic Process Automation 2019.11

In order to meet new needs: You may have originally recorded on one browser but want to execute on another
browser.
In order to be able to use different systems: You may have originally recorded with a target system (SAP server
for example) but want to execute on another system.
The Run settings is available for an RPA activity and will not be displayed for RPA flow or an RPA activity that is
based on a imported UFT test.
The Run Settings for a specific activity are auto-populated with data from Settings>Record and Run at record
time. All the Record and Run settings that are configured under the RPA Workflow Designer’s settings are
captured irrespective of it wa enabled or disabled.
It is advised to limit the change in the Run Settings to those settings that actually match the use-case that the
recorded activity covers (e.g. enabling Terminal for a recording that has no Terminal related action does not bring
any benefit).
To customize the run settings for a specific activity:

1. From your RPA project, select the recorded activity, and then click PROPERTIES tab. The custom options are
displayed.

2. Toggle to enable and expand the following available options, and then provide new inputs.

Open a new browser when running: The required inputs are similar to Web settings that was originally
configured.
Open a new SAP client when running: The required inputs are similar to SAP settings that was
originally configured.
Open applications below when running: The required inputs are similar to Windows settings that was
originally configured.
Use the following Terminal Emulator settings: The required inputs are similar to Terminal
Emulators settings that was originally configured.

3. Click SAVE. The new run settings for the activity is updated.

The following example code shows the changes made in browser selection:

web: active: true address: '' close_on_exit: false browser: CHROME

Set a step as Sensitive

RPA Workflow Designer displays the values of sensitive inputs and outputs as asterisks ********, both in the step
view and in the Source view.
To set an input step as Sensitive:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 751
Robotic Process Automation 2019.11

1. Open the PROPERTIES tab of a recorded or imported activity.

2. Click on the Inputs tab and double-click on the activity step that you want to mark as sensitive.

3. Enable the Sensitive checkbox.

In the Authoring pane, click the Source view icon to check the activity's input values:

operation: name: rpaactivity inputs: - Param1: sensitive: true default:


********

Add a wait step to an activity step

To add a wait step to a specific activity steps from a recorded activity:

1. Open the RPA ACTIVITY tab of a recorded activity. The sequential list of activity steps are displayed.

2. Hover over and click Add button that is located between all the recorded steps. The new wait step is added
to the selected step.

You can add multiple wait steps as per your requirement

3. In the new step, click the input field and enter the required wait time, and the press ENTER. The default
value is 1 second.

The constant value can be between 1 - 86400 seconds.

4. Click Save . The wait step is now bound to the selected step.

Delete a step

You can only delete steps within recorded activities. Activity steps imported from UFT tests cannot be deleted from
Workflow Designer,
To delete a specific step from a recorded activity:

1. Open the RPA ACTIVITY tab of a recorded activity.

2. Select the step that you want to delete, and then click the X button in the upper right-hand corner of the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 752
Robotic Process Automation 2019.11

step.

If you delete the wait step, the Add button is restored to the activity step.

Related topics
To set up RPA Workflow Designer Project, see Set up the RPA Workflow Designer project
To enable default applications for recording, see the applications Set up your workspace
To configure Proxy for Workflow Designer, see Configure a proxy for RPA Workflow Designer
To configure Recorder Port details, see Configure a Recorder Port for RPA Workflow Designer
To create a workflow, see Author flows.
To deploy the project to RPA Central, see Create and deploy a content pack
To run a flow in RPA Central, see Run a Flow
To check the official UFT documentation, see the Unified Functional Testing Help Center

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 753
Robotic Process Automation 2019.11

Object identification in RPA Workflow Designer


Robotic Process Automation (RPA) records the dynamically changing applications or screens by identifying
elements and their expected properties and values. To do this, it analyses each element in the application or
screen much like a person would look at a photograph and remember its details. By learning and classifying
elements, it creates a repository of element classes and their properties and stores it. You can then retrieve and
customize the stored screen elements and their values according to your need.
An object identification repository contains a large set of object types or classes that represents the objects of
the recorded screen or application. Each object class has a list of description properties that RPA learns about the
object, a sub-set of these properties that can uniquely identify object of that class, and a set of relevant operations
that RPA can perform on the object.

View the properties of an identified element


To view the properties of an identified element from a recorded activity:

1. Expand the activity project and select a recorded RPA activity. A list of sequential steps are displayed under
the RPA ACTIVITY tab.

2. Select and double-click on any step. The Step Path and its child tab Step Properties is displayed.

3. In the Step Path tab, select any element from the list. The elements related properties are listed under Step
Properties tab.

4. Alternatively, you can click the Source view icon to view the properties of an element.

Modify the properties of an identified element


To modify the properties of an identified element from a recorded activity:

1. Expand the activity project and select a recorded RPA activity. A list of sequential steps are displayed under
the RPA ACTIVITY tab.

2. Select and double-click on any step. The Step Path and its child tab Step Properties is displayed.

3. In the Step Path tab, select any element from the list. The elements related properties are listed under Step
Properties tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 754
Robotic Process Automation 2019.11

4. Click the to view and select from the list of properties associated with an element.

5. Select the property and click its input field and then either enter the new values or pick the values
dynamically that you added as an activity input. The values of an elements property is modified.

6. Click SAVE. The new values are applied to a selected property of an element.

7. Alternatively, you can click the Source view icon to view the new values of a modified element
property.

Replay an RPA activity with modified properties in RPA


Central
To run an RPA activity that has modified properties:

1. Deploy an RPA content pack to RPA OO Central.

2. Click the Run Management button.

3. Click the Flow Launcher tab.

4. In the Flows tree on the left, browse to find the RPA activity that you want to run.

5. (Optional) To locate the flow that you need, enter part or all of the flow path in the Filter By text box. For
example, if you enter "network", only flows that contain the word "network" or which are located in a path
with a folder containing the word "network" are displayed. The search is not case-sensitive.

6. Select the flow that you want to run. Details about the flow are displayed in the Flow Details pane on the
right.

7. In the Run Name box, enter a name for the run.

8. Click Run. The RPA Robot replays the modified RPA activity and displays the expected results.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 755
Robotic Process Automation 2019.11

Related topics
To create and deploy a content pack, see Create and deploy a content pack.
To run an RPA activity, see Run a flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 756
Robotic Process Automation 2019.11

Create and deploy a content pack


When you have finished authoring your content, you can export it as a content pack.

Get the project ready to be exported to a content pack


To export a project as a content pack, complete the following steps:

1. Make sure that you have saved all changes in the workspace.

2. Check that the content in the project is valid and that there are no errors.

Before exporting your content to a content pack, it is strongly recommended to check that your flows are
valid. If the project contains invalid flows, decisions, operations, or system properties, a warning message is
displayed, listing the number of invalid items that will be excluded from the content pack. If this occurs, it is
recommended to fix the errors and then to try again as invalid content will not be exported.

Download a project as a content pack


To download a project as a content pack, complete the following steps:

1. In the Projects pane, select the project from which you want to create a content pack.

2. Click the arrow next to the Create Content Pack button and select Download as content pack.

Note

The Create Content Pack button is only enabled when a project is


selected.

If there are unsaved editors open, the Save Changes dialog box gives you the option to save the changes.
Click Save All to save all changes in the open editors.

3. RPA Workflow Designer validates the project before creating a content pack. If the project contains invalid
flows, operations, or system properties, these are not included.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 757
Robotic Process Automation 2019.11

4. In the dialog box, enter the content pack version number.

Note Version numbers can be a maximum of 50 characters long. Make sure


that the version number does not include invalid characters, such as: \/:*?"<>|

5. Click Download to download the content pack locally.

If there is invalid content in the project, the dialog box displays a warning that there are invalid items, which
will not be packed inside the content pack.

You must note that when you download a project as a content pack the user password is stored in clear text.

Create a content pack and deploy it to RPA Central


To create and deploy a content pack onto RPA Central, complete the following steps:

Ensure you have the Manage Content permission in RPA Central.

1. In the Projects pane, select the project from which you want to create and deploy a content pack.

2. Click the arrow next to the Create Content Pack button and select Deploy as content pack to RPA
Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 758
Robotic Process Automation 2019.11

The Create Content Pack button is only enabled when a project is


selected.

If there are unsaved editors open, the Save Changes dialog box gives you the option to save the changes.
Click Save All to save all changes in the open editors.

3. RPA Workflow Designer validates the project before creating a content pack. If the project contains invalid
flows, decisions, operations, or system properties, these are not included.

4. In the dialog box, enter the content pack version number.

NoteVersion numbers can be a maximum of 50 characters long. Make sure


that the version number does not include invalid characters, such as: \/:*?"<>|

5. Enter the URL of RPA Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 759
Robotic Process Automation 2019.11

If the URL uses the HTTP protocol, a warning message displays that HTTPS is recommended, for security
reasons. The RPA Central Username and Password credential fields are disabled. However, you are still
able to deploy the content pack. The validation only checks the format of the URL, not its existence. The
format should be: <protocol>://<hostname>:<port>/oo.
If the URL uses the recommended HTTPS protocol, the RPA Central Username and Password credential
fields are enabled for inputs.

6. Enter the RPA Central Username and Password credentials, and then Click Deploy.

If there is invalid content in the project, the dialog box displays a warning that there are invalid items, which
will not be packed inside the content pack.

If the operation fails before the deployment to RPA Central, for example, during the creation of the content
pack, an error is displayed in the dialog box.

If the operation fails during the deployment in RPA Central, the list of problematic items is shown in the dialog
box.

You can still download the content pack locally by clicking Click to download the content pack.

7. If the content pack is deployed successfully to RPA Central, you can also click Click to download the
content pack.

NoteIf you are deploying to RPA Central using a HTTPS URL, and the RPA
Central server certificate is not trusted, a dialog box opens showing the
certificate details. The deployment process starts only if you approve the
certificate.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 760
Robotic Process Automation 2019.11

Related topics
For instructions to how to validate flows, see Validate flows

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 761
Robotic Process Automation 2019.11

Use RPA Central


Robotic Process Automation Central is a web-based application used for promoting flows, running and scheduling
flows, administering the system, and extracting and analyzing data resulting from flow runs.
The following tables describe the RPA Central usage of different RPA personas.

Sample scenario

System Admin Op Admin Flow Author

Setup roles

After the installation of RPA Central, the system administrator, configures the LDAP authentication.

The system administrator sets up the RPA Central roles and maps these roles to the LDAP groups.

The system administrator assigns workers to the worker groups. He creates a new group, ”Windows”,
for the external worker.

The operations administrator deploys the base content in the RPA Central servers.

Promotion

The flow author creates a new content pack in RPA Workflow Designer and deploys it to the file system.

The operations administrator receives an email from the flow author, saying that a new content pack is
ready for deployment.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 762
Robotic Process Automation 2019.11

The operations administrator deploys the new content pack to the RPA Central Staging server.

The operations administrator maps the RPA Central user accounts to the system accounts in the content
pack.

The operations administrator sets up the system properties in the content pack.

The operations administrator verifies that the Windows alias was automatically assigned to the worker
group and maps the other group aliases to actual worker groups.

The operations administrator takes a look at the flow library and verifies that all the flows are there and
that when she selects a flow, she can see the flow meta data.

The operations administrator sets the permissions for the flows in the content pack.

Running and monitoring flows

The operations administrator triggers one of the flows in the content pack.

The operations administrator navigates to the Runs view to see the flow status.

The operations administrator pauses, resumes, or cancels the flows, if required.

The operations administrator drills down to the flow details and tests the flow, to see if there are any
problems.

The operations administrator generates a report about the flow and exports it to Excel.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 763
Robotic Process Automation 2019.11

Updating the content pack

The operations administrator identifies a problem with the content pack as being too large and decides
it to be split into two smaller content packs.

The operations administrator sends an email to the flow author for splitting the content pack into two
smaller content packs.

The flow author splits the content pack into two smaller content packs and sends them to the
operations administrator.

Final deployment

The operations administrator deploys the new content packs to the Staging server and verifies that
there are no other problems.

The operations administrator deploys the content packs to the Production server.

Navigate to the following topics for more information on how to use RPA Central.

Introduction to RPA Central


Working with the dashboard
Work with CloudSlang content flows
Run and monitor flows

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 764
Robotic Process Automation 2019.11

Introduction to RPA Central


Robotic Process Automation (RPA) Central is a web-based application used for promoting flows, running and
scheduling flows, administering the system, and extracting and analyzing data resulting from flow runs.

Login to RPA Central


If authentication has been set up for RPA Central, the Logon screen is shown when It is started.

Follow the below instructions while logging into RPA Central:

1. Enter your user name and password.

Note You cannot log in with a user name that includes a colon.

2. If multiple domains are available, you also need to select a domain. The domain that you select will remain
the default choice for the browser that you're using.

Note Your current domain is selected by default.

There is no choice of domain, if:

a. Only internal users have been set up

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 765
Robotic Process Automation 2019.11

b. There is only one domain and this has been set as the default

Note If there is a single domain, but it has not been set as the default,
you will have a choice between this domain and the internal users.

If there are multiple domains, you must select a domain name, unless
you are logging in as an internal user or if you belong to the default LDAP.

3. If the option to capture logged-in user credentials has been enabled, the Login screen includes a warning
message, saying that RPA will capture your credentials and may transfer them over the network.

Hover over to see more information about the capture of logged-in user credentials.

4. Click Login.

If authentication has not been enabled, the Logon screen is not shown.

Navigating RPA Central


RPA Central is divided into four workspaces, so you can perform end-to-end tasks from the same place. A
workspace is a unit that holds all the screens that belong to the same end-to-end task group.

Dashboard – used to display the system’s ROI, and analyzed flow aggregation. For users with an Op Admin
role.
Run Management – used for running flows, monitoring runs, scheduling runs, and troubleshooting runs. Can be

used by users with an End User or Op Admin role.


Content Management – used for promotion tasks, such as deploying new content, setting permissions on
flows, setting up configuration items, and rolling back to earlier versions of content packs. For users with an Op

Admin role.
System Configuration – used to configure topology, and set up users, roles, LDAP authentication, IDM
authentication, LWSSO, security banners, monitor and control the size of the database, and personalize the RPA

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 766
Robotic Process Automation 2019.11

Central UI appearance. For users with a System Administrator role.

Dashboard

Click the Dashboard button to display the Dashboard workspace.


This workspace provides statistical information about the system (popular flows, result distribution, execution time,
and so on) and financial information about ROI (return on investment).

Run management

Click the Run Management button to display the Run Management workspace.
You cannot limit an RPA flow to a single robot. Each step can be run by any available robots.
This workspace includes the following modules:

Run Explorer – In the Run Explorer module, the Op Admin or End User can monitor their running flows and the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 767
Robotic Process Automation 2019.11

flows that have finished running. You can track flow runs, export in a CSV format, monitor their progress, and
perform actions on flow runs, such as pausing, resuming, and canceling them. If a flow fails and you want to
troubleshoot, you can drill down into the run to display detailed information. If you have many flows running at
the same time, you can use filters to locate the flow that you need.

You may want to note that, by default, 200 flows are listed in the downloaded CSV file.

You must ensure pop-up blocker is disabled in your browser to export the runs
in CSV format.

By default, the export to CSV format icon is disabled. Purchase a commercial


license to use this functionality.

Flow Launcher – In the Flow Launcher module, the Op Admin or End User can browse for a flow, view the flow
information, name the run, enter inputs, and run the flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 768
Robotic Process Automation 2019.11

Scheduler – In the Scheduler module, the Op Admin can view, create, and modify flow run schedules.

Content Management

Click the Content Management button to display the Content Management workspace.
This workspace includes the following modules:

Flow Library – The Flow Library displays the flows that have been deployed. From here, the Op Admin can run
or schedule a flow, view a flow's meta data, set the content permissions, or run a flow for testing.

Content Packs - In this module, the Op Admin can view the deployed content packs, filter them, delete them,
deploy or roll back content packs, view the details of content packs, compare statistics about deployed content
packs, and view changes that were made to them.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 769
Robotic Process Automation 2019.11

Configuration Items – In this module, the Op Admin can configure the contents of a content pack, in order to
adjust it to the environment: mapping group aliases to actual worker groups, mapping system accounts in the
content pack to RPA Central user accounts, and mapping system properties.

System configuration

Click the System Configuration button to display the System Configuration workspace.
This workspace contains the following modules:

Security – Enables the System Administrator to set up roles for RPA and to apply these roles to internal users or
to users in an authentication system such as LDAP, IDM, or LWSSO. This is also where the System Administrator
can enable authentication and auditing, and configure a security banner.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 770
Robotic Process Automation 2019.11

Topology – Enables the System Administrator to configure workers, worker groups, Robots, and RASes, and to
set up an automatic upgrade process for RASes. The status in topology page does not refresh automatically. You
need to use the refresh button from the topology page to display changes.

System Settings – Enables the System Administrator to set defaults and customizations, and configure a
forward proxy, reverse proxy, or load balancer. It also enables the System Administrator to install an Robotic
Process Automation license.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 771
Robotic Process Automation 2019.11

System Notifications – Notifies users about system events through email messages.

Viewing the workspaces

It is possible to set up the RPA roles so that users who have been assigned particular roles will only be able to
access the workspaces that are relevant to their role.
For example, you can set up roles so that:

Users who belong to the End User role will see only the Run Management workspace.
Users who belong to the Promoter role will see the Content Management workspace and the Run Management
workspace.
Users who belong to the System Administrator role will see the System Configuration workspace and the Run
Management workspace.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 772
Robotic Process Automation 2019.11

Adjusting the display of panes in the workspace

Use the sliders between panes, to adjust the display:

Drag the edge of a slider to adjust the height or width of a pane.


Use the open/close button in a slider to toggle between hiding and displaying a pane.

Related topics
To work with the RPA Central dashboard, see Working with the dashboard

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 773
Robotic Process Automation 2019.11

Working with the dashboard


The dashboard provides statistical information about the system (popular flows, result distribution, execution time,
and so on) and financial information about return on investment (ROI).
The Dashboard tab is only visible if you have been assigned a role with the View Dashboard permission.

Note Existing flows with prefigured ROI are shown in the dashboard. Setup of ROI
from RPA Workflow Designer is not yet supported.

The dashboard shows information about all flows that the logged-in user is entitled to see.
The dashboard enables the Op Admin to analyze the flow statistics, and compare the performance of the top ten
flows. The dashboard does not include flows that were run using the Remote Debugger in RPA Workflow Designer.
This ensures that the statistics and ROI calculations in the dashboard will not be affected by test runs.
The time range of the data in the dashboard appears in the top right corner. This time range can be set to the last
day, the last seven days, or the last thirty days.
It is also possible to perform a wider range of dashboard tasks using APIs:

1. Set the date range with a wider range of possible date ranges.

2. Display a larger number of flows

3. Sort and filter data

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 774
Robotic Process Automation 2019.11

If you do not have ROI values assigned in your flows, the total ROI value will be 0.
You can personalize the dashboard by adding text to the ROI title, in order to help users understand the meaning
of the ROI values. For example, you can tell them if ROI is calculated in dollars or in work days.

What do you want to do?

Customize the dashboard time range

In the dashboard, you can display information about all the flow runs that you are entitled to see, over the past day
(the last 24 hours starting from now), the past week (the last 7 days starting from today), or the past 30 days
(starting from today).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 775
Robotic Process Automation 2019.11

If you do not adjust the date range, the default is seven days.

1. Click the Dashboard button to display the dashboard workspace.

2. In the top right corner, select the option with the number of days that you want to include in the date range:

1 - to display information about runs from the past day


7 - to display information about runs from the past 7 days
30 - to display information about runs from the past 30 days

Extract the ROI Information by API

You can extract the relevant ROI information by API, as a basis for periodical reports for the business manager.

System ROI

GUI item Description

Time range All the data in the dashboard is relevant to the specified time range in the top right
corner. To adjust the date range, select one of the options :
• 1 Day - to display information about runs from the past day
• 7 Days - to display information about runs from the past 7 days
• 30 Days - to display information about runs from the past 30 days

Total ROI This value is the sum of the ROI values of all performed transitions in the defined
time range, which the logged on user is entitled to see.

Main Contributors pie Displays the flows that were the major contributors to the ROI, with their relative
chart contributions expressed in a pie chart.

10 Most Popular Flows

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 776
Robotic Process Automation 2019.11

GUI item Description

Results Distribution For each of the top ten flows, displays the number of finished runs. Finished runs
bar graph means those with a status of success, error, failed to complete, diagnosed, or no
action taken. This does not include flows that are paused, running, canceled, pending
cancel, or pending pause.
The bar graph displays the relative distribution of runs according to status. The
different statuses are expressed by the following colors:
• Green: Completed - Resolved
• Red: Completed - Error
• Gray: Completed – No Action Taken
• Blue: Completed - Diagnosed
• Yellow: Failed to Complete
The colors are the same as the colors of the status icons in the Run Explorer.
Tip To identify the status indicated by a color, roll the cursor over a colored bar to
display a tool-tip.

Average Execution Displays the average duration of each flow, based on the finished runs for that flow
Time bar over the time that was set as the date range. The bar displays the duration time of the
flow, relative to the other flows in the top ten.

ROI column Displays the ROI value of each flow. The coins represent the relative ROI score of the
flow compared to the other flows in the top ten.

Related topics
To set up general settings, see Set up the general settings.
To set up security for roles, see Set up security for roles.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 777
Robotic Process Automation 2019.11

Work with CloudSlang content flows

It is also possible to deploy and run content that was authored using CloudSlang 1.0.
CloudSlang
CloudSlang is a flow-based orchestration tool for managing deployed applications.
The CloudSlang project is composed of three main parts: the CloudSlang Orchestration Engine, the CloudSlang
language and the ready-made CloudSlang content.
The engine is packaged as a lightweight Java .jar file and can be embedded into existing Java projects.
The language is a YAML-based DSL for writing workflows. The workflows can be run by an embedded instance of
the engine or the stand-alone CloudSlang CLI. The main types of CloudSlang content are operations, flows, and
decisions. An operation contains an action, which can be written in Python or Java. Operations perform the “work”
part of the workflow. A flow contains steps, which stitch together the actions performed by operations, navigating
and passing data from one to the other based on operation results and outputs. Flows perform the “flow” part of
the workflow. A decision provides the capability to select different outcomes.
The supported file extensions are: .sl, .sl.yaml and .sl.yml.

Note For more information about CloudSlang, see: http://www.cloudslang.io/Slang#/docs


https://github.com/cloudslang/cloud-slang
https://github.com/cloudslang/score

You can run CloudSlang flows in all the different RPA topologies—single node, RPA Central and RPA RAS, and
clustering.
Content Lifecycle when working with CloudSlang
CloudSlang content has the same life cycle as native content:

Deploy a CloudSlang content pack.


Manage Flows: View flows in the flow library and set flow permissions.
View and edit System Properties. For CloudSlang, System Properties can also be configured as Sensitive.
Run and monitor flows: Run flows, schedule runs, track and manage flow runs.
Troubleshooting Flows Runs: Drill down into the flow run.
Features supported by CloudSlang and/or native Flows
This section describes where CloudSlang content and native Flows content behavior is different:

Content Permissions. Permissions to run a CloudSlang flow is are computed when the flow is launched or
resumed. If you don’t have the correct content permissions for all dependencies, you will not be able to launch or
resume the flow.
Flow graphical representation. A flow graphical representation is not available: If you open the Flow Graph
tab for a flow that was written in CloudSlang, a not supported message is shown.
Sensitive Data for System Properties. In CloudSlang, any system property can be sensitive. When viewing a
flow in Content Management > Flow Library, and in Run Management > Flow Launcher, the CloudSlang
system properties that are defined by the author as sensitive will appear masked in the System Properties view.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 778
Robotic Process Automation 2019.11

Native and CloudSlang flows can include Sensitive Inputs and Outputs, and they will be hidden in RPA Central.
Decisions. CloudSlang step type called Decision, works along with existing subflows and operations. When
running a flow that includes a decision, the result of a decision looks like a Custom result.
Content Distribution. All required resources are resolved and downloaded from RPA Central to the RPA RAS at
the start of the operation execution using maven. For Python based content, the administrator must add
manually, in the python library in each RPA RAS, all the dependencies needed to run the flow and are not
included in out-of-the-box python lib. This is done by adding them to the RPA class path in ALL RPA nodes in your
environment (RPA Central or RPA RAS):

For RPA Central: <Installation_path>\central\lib\pythonlib


For RPA RAS: <Installation_path>\RAS\lib\pythonlib
CloudSlang content IDs use the format <namepace>.<name>.
Worker Group. If you display a CloudSlang flow run in the Run Explorer drill-down, Worker Group properties are
supported.
Default input filling when running a flow. Only string inputs are supported for CloudSlang flows.

Supported in Supported in
Feature CloudSlang native Flows

Content Packs: Deploy, rollback, delete, view details ✔ ✔


in the Content Management workspace.

Distribution Capability Java automatically ✔ ✔


Python manually ✔

Content Permission ✔ ✔

Run Flows ✔ ✔

Schedule a flow ✔ ✔

Monitor Flows ✔ ✔

Manage Flow Runs ✔ ✔

Decisions ✔ X

Sensitive Data in Input and Output Fields ✔ ✔

Sensitive Data for System Properties ✔ X

View the Flow Graph for a flow X ✔

Worker Group ✔ ✔

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 779
Robotic Process Automation 2019.11

Related topics
To deploy and manage content packs, see Deploy and manage content packs
To manage the flow library, see Manage the flow library
To set up configuration items fora content pack, see Set up configuration items for a content pack
To run and monitor flows, see Run and monitor flows
To test and troubleshoot flow runs, see Test and troubleshoot a flow run
To view a flow graph, see View a flow graph
To schedule flow runs, see Schedule flow runs
To adjust the display of the flow runs, see Adjust the display of flow runs
To track and manage flow runs, see Track and manage flow runs

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 780
Robotic Process Automation 2019.11

Run and monitor flows

The Op Admin and the End User are responsible for running and monitoring flows.
Once the content packs have been deployed, the Op Admin or End User can run flows and monitor the flow runs.
The following flow diagram describes the normal flow of run and monitoring flows:

This is a high level look at the workflow. There are many options that are not described here. For more detailed
information about any of the steps, use the links to learn about the options in-depth.
Step 1: Find the flow that you want to run

The Op Admin/End User locates the flow either from the Flow Library or the Flow Launcher. Go to the
Content Management > Flow Library module or to the Run Management > Flow Launcher module.
Step 2: Run the flow

The Op Admin/End User runs the flow.

Alternatively, the Op Admin/End User schedules the flow to run later.


Step 3: Monitor the flow run

The Op Admin/End User tracks the flow run in the Run Explorer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 781
Robotic Process Automation 2019.11

If required, the Op Admin/End User performs actions on flow runs, such as pausing, resuming, and canceling
flow runs handing off, reassigning ownership.
Step 4: Troubleshoot the flow run

If required, the Op Admin investigates any problems with the run.


Step 5: Create reports about the flow run

After the flow has run, the Op Admin generates a report about its progress.
This section has the following topics.

Run a flow
Hybrid flow execution in RPA Central
Schedule flow runs
Track and manage flow runs
Adjust the display of flow runs
Test and troubleshooting a flow run
Embedding RPA Central views in external web pages

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 782
Robotic Process Automation 2019.11

Run a flow

In the Flow Launcher tab in the Run Management tab you can select a flow, view its details, prepare it
for running, and start the run.
You must note that when the RPA premium license expires, the triggered flows will be stuck and will continue to
remain stuck even if you have the trial license or if the AutoPass server is disconnected.

The flows are displayed in a tree, where you can browse to locate the one you need. You can enter text in the
Filter By box to filter the display of flows, and you can expand and collapse the tree nodes.

In the Flow Details pane, on the upper right, you can view information about the selected flow, such as ID,
content pack, description, and inputs.

In the Inputs pane, on the lower right, you can give the run a name and enter any required inputs.

The flow level input appears in RPA Central only if it can be modified by a user as follows:

The input was defined as one that prompts the user

The value of Assign From is the same as the flow input name
For example, the input will not appear if the flow author has not assigned a value to Assign From and has set
Otherwise to Use Constant.

When you have entered the inputs and the flow is ready, you can click the Run button to start the flow. It is also
possible to run a flow from the Flow Library in Content Management.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 783
Robotic Process Automation 2019.11

If you have run this flow previously, you can click the Last Run button to view the progress of your last run in the
Drill Down dialog box.

Flow Launcher tab

GUI item Description

Filter By To locate the flow that you need, enter part or all of the flow path in the Filter By
text box to filter the flows.

Flows tree Displays the flows that you have permission to view. Expand and collapse the
nodes to see the flows in different folders.

Flow Details pane Displays information about the selected flow.

Open Graph Button Click the Open Graph button to display a graphical representation of the flow.

ID Displays the UUID of the selected flow.

Content Pack Displays the content pack that the selected flow came from.

Description Displays a description of the selected flow. If required, use the scrollbar to scroll
down and view the contents of the Description section. For Content flows, you
can add input and output information under Description.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 784
Robotic Process Automation 2019.11

GUI item Description

Input Displays the input information for CloudSlang flows only. This field may be
encrypted as configured by the flow creator.

Output Displays the output information for CloudSlang flows only. This field may be
encrypted as configured by the flow creator.

Inputs Displays an explanation of the inputs required in the selected flow.

Run Name In the Run Name box, enter a name for the run. The name does not have to be
the same name as the original flow. You may want to give it a name that identifies
this particular run. For example, you may want to run the same flow multiple
times, each with different input. Naming the runs makes it easier to identify them
based on the inputs.

Persistence Level Select the persistence level, in order to control the level of detail that is saved to
the Run Log. The options are:
• Standard - Includes raw results, step results, and big inputs/outputs.
• Extended - Includes the complete raw results, step results, subflow outputs
(from step results), and big inputs/outputs.
Note The flow's default persistence level is selected by default.
If you do not select a persistence level, the default is used. For information about
how to set the default persistence level, see "Monitor and control database size"
topic.

<Input fields> Enter inputs if these are required. The number of input fields and the labels on
them will vary, depending on the inputs that are required in the selected flow.

Open Run After Launch Select to automatically track the flow after it is started. If this check box is
check box selected, the flow's progress is displayed in the Run Explorer Drill Down dialog box.

Last Run button If you have run this flow previously, you can click the Last Run button to view the
progress of your last run in the Drill Down dialog box.

Reset button Click the Reset button to clear all the inputs from the Flow Input pane.

Run button Click the Run button to run the selected flow.

Run Flow dialog box


The Run Flow dialog box is displayed when the Run button is clicked, in the Flow Library.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 785
Robotic Process Automation 2019.11

GUI item Description

Flow Displays the path to the flow.

Run Name In the Run Name box, enter a name for the run. The name does not have to be the same
name as the original flow. You may want to give it a name that identifies this particular run.
For example, you may want to run the same flow multiple times, each with different input.
Naming the runs makes it easier to identify them based on the inputs.

Persistence Level Select the persistence level, in order to control the level of detail that is saved to the Run
Log. The options are:
• Standard - Includes raw results, step results, and big inputs/outputs.
• Extended - Includes the complete raw results, step results, subflow outputs (from step
results), and big inputs/outputs.

<Input fields> Enter inputs if these are required. The number of input fields and the labels on them will
vary, depending on the inputs that are required in the selected flow.

Run Click to run the flow.

Drill Down dialog box


The Drill Down dialog box displays the progress of the run, when you run a flow from the Flow Launcher or from the
Flow Library, when the Open Run After Launch check box is selected.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 786
Robotic Process Automation 2019.11

GUI item Description

Show Full Tracking Click Show Full Tracking to navigate to the Run Explorer Drill Down.

Other UI items The UI items in the Drill Down dialog box are the same as those in the Run Explorer Drill
Down.

Run a flow
1. Click the Run Management button.

2. Click the Flow Launcher tab.

3. In the Flows tree on the left, browse to find the flow that you want to run.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 787
Robotic Process Automation 2019.11

4. (Optional) To locate the flow that you need, enter part or all of the flow path in the Filter By text box.

For example, if you enter "network", only flows that contain the word "network" or which are located in a path
with a folder containing the word "network" are displayed. The search is not case-sensitive.

5. Select the flow that you want to run. Details about the flow are displayed in the Flow Details pane on the
right.

6. In the Run Name box, enter a name for the run.

By default, the run name is the flow name, but you can change this. You may want to give it a name that
identifies this particular run. For example, you may want to run the same flow multiple times, each with
different input. Naming the runs makes it easier to identify them based on the inputs.

7. From the Persistence Level list, select the persistence level, in order to control the level of detail that is
saved to the Run Log. The options are:

Standard - Includes raw results, step results, and big inputs/outputs.

Extended - Includes the complete raw results, step results, subflow outputs (from step results), and big
inputs/outputs.

Note The flow's default persistence level is selected by default.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 788
Robotic Process Automation 2019.11

If you do not select a persistence level, the default is used. For information about how to set the default
persistence level, see "Monitor and control database size" topic.

8. Select the Use empty value for prompts check box, if you want the flow to skip prompts for input fields left
empty. Even if the check box is checked, a flow can only run if all required inputs (marked in red asterisks)
are submitted.

9. Enter any inputs that are required. You can click the Reset button to apply the default values.

10. (Optional) Click the Open Graph button to display a graphical representation of the flow.

11. (Optional) Select the Open Run After Launch check box to automatically track this flow after it is started.

12. Click Run.

If the Open Run After Launch check box was selected, the progress of the run is displayed in the Drill
Down dialog box.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 789
Robotic Process Automation 2019.11

Click Show Full Tracking to navigate to the Run Explorer Drill Down.

If the Open Run After Launch check box was not selected, the Drill Down dialog box is not opened. A
message displays whether the flow was launched successfully.

If you have run this flow previously, you can click the Last Run button to view the progress of your last
run in the Drill Down dialog box.

Run a flow from the Flow Library


1. Click the Content Management button to display the Content Management workspace.

2. Click the Flow Library tab.

3. Browse for a flow in the flow library.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 790
Robotic Process Automation 2019.11

4. (Optional) To locate the flow that you need, enter part or all of the path in the Filter By text box.

For example, if you enter "network", only flows that contain the word "network" or which are located in a path
with a folder containing the word "network" are displayed. The search is not case-sensitive.

5. (Optional) Click the Open Graph button to display a graphical representation of the flow.

Select the flow that you want to run, and click the Run button in the toolbar.

6. In the Run Flow dialog box, enter a name for this flow run.

By default, the run name is the flow name, but you can change this. You may want to give it a name that
identifies this particular run. For example, you may want to run the same flow multiple times, each with
different input. Naming the runs makes it easier to identify them based on the inputs.

7. Enter the necessary inputs for the run in the Run Flow dialog box.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 791
Robotic Process Automation 2019.11

8. Click Run.

The progress of the run is displayed in the Drill Down dialog box.

Run an interactive flow


1. Run the flow.

2. When the run reaches an interactive point (such as Inputs Required, Handoff, Display Message, and so
on), its status is changed to Paused - Action Required.

3. The flow can be resumed from the Run Explorer Drill Down or from the Drill Down dialog box.

Select the run in the Run Explorer and click the Drill down button at the end of the row to display the

Run Information window, and click the Expand button to expand the prompt message.
If the Open Run After Launch check box was selected, the prompt message appears in the Drill Down

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 792
Robotic Process Automation 2019.11

dialog box.

You can click the Contract button on the left side of the Inputs Required dialog box to hide it again.

4. Read the message and follow its instructions to resume the run—enter the required inputs, handoff, and so
on, and click Resume.

Run a flow with a gated transition


A gated transition restricts access to the next step to users who have been assigned a particular role.

Note Gated transition flows can only be resumed by users who have Manage
Others' Runs permissions.

1. Run the flow.

2. When the flow run reaches the gated transition, if you have not been assigned a role with the required
permission, the flow run is paused. The run status appears as Paused – Action Required.

3. If the Open Run After Launch check box was selected, the prompt message appears in the Drill Down
dialog box.

If not, select the run in the Run Explorer and click the Drill down button at the end of the row to display

the Run Information window, and click the Expand button to expand the prompt message.

4. In the prompt message, click the Hand off to another user (email this run) link to create an email
message to send to the user who needs to complete the flow run.

5. An email message opens with a message for the person to whom you are handing off the flow run and a link
to the flow run. Enter the email address of this person and send the message.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 793
Robotic Process Automation 2019.11

Run a flow with a handoff transition


A handoff transition is one where a message appears, suggesting that the current user hand off the flow run to
another user. Unlike with a gated transition, the first user has the option to resume the flow run without handing it
off to another user.

1. Run the flow.

2. When the flow run reaches the handoff transition, the flow run is paused. The run status appears as Paused –
Action Required.

3. If the Open Run After Launch check box was selected, the prompt message appears in the Drill Down
dialog box.

If not, click the Drill down button at the end of the row to display the Run Information window, and click

the Expand button to expand the prompt message.

4. You have two options:

To hand off the flow run to another user, click Hand off to another user (email this run). An email
message opens with a message for the person to whom you are handing off the flow run and a link to the
flow run. Enter the email address of this person and send the message.
Click Resume to continue the flow without handing it off.

Run a flow with a Paused - No Workers interaction


A flow has the Paused – No workers status when there is a worker group that has not yet been mapped to any
workers. Before you can resume the run, you will need to map the worker group to actual workers.

1. Run the flow.

2. When the flow run reaches the point where it relates to a worker group with no workers, the flow run is
paused. The run status appears as Paused – No Workers.

3. If the Open Run After Launch check box was selected, the prompt message appears in the Drill Down

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 794
Robotic Process Automation 2019.11

dialog box.

If not, click the Drill down button at the end of the row to display the Run Information window, and click

the Expand button to expand the prompt message.

4. Map the worker group to the relevant workers.

5. Return to the pause message and click Resume.

Related topics
To track and manage flow runs in RPA Central, see Track and manage flow runs.
To monitor and control database size in RPA Central, see Monitor and control database size.
To learn how to test and troubleshoot a flow run, see Test and troubleshoot a flow run.
To set up configuration items for a content pack, see Set up configuration items for a content pack.
To view a graph of a flow, see View a flow graph.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 795
Robotic Process Automation 2019.11

Execute a hybrid flow


A hybrid flow is a CloudSlang flow that has the native content flows as a substep. You can run the CloudSlang flow
like a regular flow and execute the native content substeps. This seamless external execution is achieved as the
native content substep is bound to the CloudSlang flow using the do_external tag in the CloudSlang framework as
described below.

namespace: io.cloudslang.base.hybrid flow: name: generate_random_with_subflow inputs: - min:


required: true - max: required: true workflow: - step1: do_external: 06fe8531-868b-4e79-
aa7a-13a5e30a66ec: - min: ${min} - max: ${max} results: - SUCCESS - FAILURE

You can view the execution results in Step Details menu.

You can execute hybrid flow with native content flows with the following:

Input prompt
Display prompt
No-worker-in-groups prompt
System account at step level
System property at step level
Configuration item at step level (selection list, domain term, and others)
Multi-instance steps
Parallel step
Sequence of flow steps that require context/session caching (AFL looping, SSH with session and others)
Step set to loop
However, the hybrid flow with step with configuration items set at flow level (in native content) will not be resolved
properly at run-time, such as:

Selection list set at the flow level will not be prompted at trigger time in RPA Central.
System account will not be resolved at the trigger time in RPA Central.

Connection or session objects for operations like SSH and HTTP are not kept on

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 796
Robotic Process Automation 2019.11

the GlobalSessionObject of a hybrid flow. Connections will be recreated after each


transition of the flow between native content and CloudSlang steps.

Related topics
For instructions on how to run a flow, see Run a flow
To schedule a flow run, see Schedule flow runs
To track and manage flow runs, see Track and manage flow runs
To adjust the display of a flow run, see Adjust the display of flow runs
To test and troubleshoot a flow run, see Test and troubleshoot a flow run
To embed RPA Central views in external web pages, see Embedding RPA Central views in external web pages

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 797
Robotic Process Automation 2019.11

Schedule flow runs

Schedules allow you to control when to run your flows. You can specify a schedule to run for a specific flow.
You can also set up recurring schedules for a task that needs to be repeated.
For example, you need to regularly check whether a number of servers are online. In this case, you can define a
flow to check the IP address and then create a schedule to run that flow.
Schedules are displayed in the Scheduler tab. The display of schedules depends on the permissions that you have
been assigned in your role:

If you have been assigned a role with the View Schedules permission, you will be able to view the RPA
schedules and their details.
If you have been assigned a role with the Manage Schedules permission, you will be able to view and edit
schedules. The RPA Central Scheduler does not work when SAML authentication is used.

Schedule owner
Each schedule has an owner. This is the user who created the schedule. The name of the owner appears in the
User column in the Scheduler

In the Scheduler tab, the User column indicates the schedule owner.
In the Run Explorer tab, the User column indicates the owner of this flow execution (the user who performs the
scheduled run).
If another user updates the schedule (for example, the recurrence, name, or time zone), the schedule owner
changes to this user. This user is displayed as the schedule owner in the Scheduler and as the flow executor in the
Run Explorer. The new owner appears only for runs that started after the change. For runs that started before the
change, the original owner is displayed in the User column.
If the schedule is created or updated by a user who is logged in as an anonymous user, the User column will
display N/A. If the schedule is updated by a user without run permissions on the scheduled flow, this flow will not
run. If an LDAP configuration exists and the configured LDAP server is not responding, this will affect all types of
schedules. This includes both schedules that are run with a LDAP user and schedules that are run with an internal
user.

Schedule name
Each schedule has a name. The flow name is entered by default, but you may prefer to use a different name, for
example, if you have multiple schedules using the same flow.

Note If you give the schedule a different name, this is the name that will appear
in the Run Explorer, rather than the flow name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 798
Robotic Process Automation 2019.11

View existing schedules


To view the Scheduler tab, you must be logged in with a user account that is assigned a role with View
schedules permissions.

1. Click the Run Management button to display the Run Management workspace.

2. Click the Scheduler tab. A table displays all the current schedules, including the following information:

State: Displays whether the schedule is enabled or disabled .


Schedule Name: Displays the name that was given to this schedule. This value can be edited in the Edit
Schedule dialog box.
Flow Name: Displays the name of the flow that the schedule relates to. This value is taken from the flow
and cannot be modified in the schedule.
Next Run: Displays the time and date when the next run is scheduled to occur. The time and date
displayed is in the your time zone.
Previous Run: Displays the time and date when the previous run occurred, if this exists.
User: Displays the name of the user who created or modified this schedule.

Display the details of a schedule


You can drill down to see the details of a schedule in the Schedule Details dialog box. This functionality is useful for
users with View Schedules permission, but without permission to edit schedules.
The details include information that is not displayed in the table in the Scheduler tab, such as recurrence pattern,
range of recurrence, and the timezone in which the schedule runs.
To display the details of a schedule:

1. Click the Scheduler tab.

2. Select the check box next to the schedule that you want to view and click the Details button in the
Scheduler toolbar. The details of the selected schedule are displayed in the Schedule Details dialog box. The
Details button is only available if a single schedule is selected.

3. When you have finished viewing the details of the schedule, click OK.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 799
Robotic Process Automation 2019.11

Edit schedules
To edit a schedule, you must be logged in with a user account that is assigned a role with Manage schedules
permission.
To edit a schedule:

1. Click the Scheduler tab.

2. Select the check box next to the schedule that you want to edit and click the Edit button in the
Scheduler toolbar.

3. In the Edit Schedule dialog box, make the required changes to the schedule, and then click Save.

4. If you try to set the end date for the schedule to the current date (or earlier), the Save button is disabled and
the following warning message appears:

The end date must be after the start date.

Clone schedules
You can create an identical copy of a schedule that appears in the Scheduler tab. You can make any required
changes to this schedule in the Clone Schedule dialog box.
To clone a schedule:

1. Click the Scheduler tab.

2. Select the check box next to the schedule that you want to clone, and click the Clone button in the

Scheduler toolbar. The Clone button is only enabled if a single schedule is selected.

The Clone Schedule dialog box opens. All the fields in the dialog box are populated with the values from the
selected schedule.

3. If required, edit the schedule details in the Clone Schedule dialog box. You may wish to give the clone a
different name.

4. Click Save.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 800
Robotic Process Automation 2019.11

Note If you try to set the end date for the cloned schedule to the current date (or
earlier), the Save button is disabled and the following warning message appears:

The end date must be after the start date.

Delete schedules
You can delete individual or multiple schedules.
To delete schedules:

1. Click the Scheduler tab.

2. Select the check boxes next to the schedules that you want to delete and click the Delete button in the
Scheduler toolbar.

3. In the confirmation dialog box, click Yes.

The selected schedules are deleted from the Scheduler tab.

Enable a schedule
By default, when a new schedule is created, it is enabled. If a schedule has been disabled, you need to enable it
before it will run. You can enable individual or multiple schedules.
To enable a schedule for a flow run:

1. In the Scheduler tab, select the check box next to each disabled schedule that you want to enable.

2. In the Scheduler toolbar, click Enable .

Note The Enable button is only available if at least one disabled schedule is
selected.

3. In the confirmation dialog box, click Yes.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 801
Robotic Process Automation 2019.11

The icon in the State column changes to Enabled for this schedule.

Disable a schedule
You can disable individual or multiple schedules. These schedules remain in the Scheduler tab, but they will not
run until they are enabled.
To disable a schedule for a flow run:

1. In the Scheduler tab, select the check box next to each enabled schedule that you want to disable.

2. In the Scheduler toolbar, click Disable .

Note The Disable button is only available if at least one enabled schedule is
selected.

3. In the confirmation dialog box, click Yes.

The icon in the State column changes to Disabled for this schedule.

Filter the display of schedules


You can filter the schedules that are displayed in the Scheduler tab. This can help you locate schedules quickly,
when there is a large number of schedules.
For example, if you are looking for schedules of flows relating to connectivity, you could enter "Connect" as the
filter term in the Flow Namecolumn.

Note The filter is not case-sensitive.

1. Click the Scheduler tab.

2. In the text boxes under the column titles, enter the information to filter by.

If you do not know the exact name, enter part of the name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 802
Robotic Process Automation 2019.11

Refresh the display of schedules


If someone creates, edits, deletes, enables, or disables a schedule in another client, this does not show in the
Scheduler tab until you have refreshed the page.
To refresh the display of schedules:

1. Click the Scheduler tab.

2. In the Scheduler toolbar, click Refresh .

Note It is also possible to refresh the page using a browser refresh command
(for example, using key combinations such as F5 or Ctrl+R), but this loads the
entire page. Clicking the Refresh button is faster, because it only refreshes
the display of schedule data .

Sort the display of schedules


If there are multiple schedules displayed in the Scheduler tab, you can sort them according to any of the column
headings.

1. Click the Scheduler tab.

2. Click the column header that you want to use to sort the schedules.

By default, the schedules are sorted in ascending order, in the Next Run column. The ascending icon is
displayed next to the column header that was used to sort.

3. If you want to reverse the order, so that the schedules are sorted in descending order, click the column
header again.

The schedules are sorted in descending order, and the descending icon is displayed next to the column
header.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 803
Robotic Process Automation 2019.11

Run a scheduled flow now


You can trigger an ad-hoc run of a scheduled flow.
RPA Central users that can perform this action must have the following permissions enabled for their role:

View Schedules and Manage Schedules permissions.


View and Run content permissions.

Note If a schedule is set to end after a specific number of occurrences, running


this scheduled flow ad-hoc will not be counted as an occurrence. Only runs that
are initiated by the schedule's recurrence pattern will be counted in the number of
occurrences.

1. Click the Scheduler tab.

2. Select the schedule from the list.

3. In the Scheduler toolbar, click the Run-now button .

Navigate through schedules


If there are schedules displayed on multiple pages in the Scheduler tab, you can navigate between the pages
using the pagination bar.

1. Click the Run Management button to display the Run Management workspace.

2. Click the Scheduler tab.

3. Use the pagination bar to navigate between the pages. Enter the number
of a specific page in the center box, or click the buttons to jump to the following pages:

First
Previous
Next
Last

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 804
Robotic Process Automation 2019.11

Create a schedule
To create a schedule, you must be logged in with a user account that is assigned a role with View schedules and
Manage schedules permissions.

1. You can create a new schedule either from the Scheduler or from the Flow Library:

To create a schedule from the Flow Library:

i. Click the Content Management button to display the Content Management workspace.

ii. Click the Flow Library tab.

iii. Select a flow from the Flow Library.

iv. Click the Schedule button. The Create Schedule dialog box opens.

v. Click the browse button to browse for and select the flow for which you want to create the
schedule.

To create a schedule from the Scheduler:

i. Click the Run Management button to display the Run Management workspace.

ii. Click the Scheduler tab.

iii. In the Scheduler toolbar, click the Create button.

iv. Select the flow for which you want to create the schedule, and click OK. The Create Schedule dialog
box opens.

2. In the Schedule Name box, enter a meaningful name for this schedule. The flow name is entered by default,
but you may prefer to use a different name, for example, if you have multiple schedules using the same flow.

Note If you give the schedule a different name, this is the name that will
appear in the Run Explorer, rather than the flow name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 805
Robotic Process Automation 2019.11

3. From the Persistence Level list, select the persistence level for the scheduled run, to control the level of
detail that is saved to the Run Log. The options are:

Standard - Includes raw results, step results, and big inputs/outputs.

Extended - Includes the complete raw results, step results, subflow outputs (from step results), and big
inputs/outputs.

Taken from flow settings - whatever was selected as the default persistence level for the flow.

4. Select the Use empty value for prompts check box if you want the schedule to skip over prompts for
inputs. For any prompt that has no value assigned, it will use blank, and the scheduled flow will run without
stopping to prompt for values.

However, note that if any of these are required inputs, the flow will fail.

If you do not select this check box, the run is stopped and prompts for inputs, even if they are not required
inputs.

5. In the Recurrence pattern section, select from one of the following recurrence frequencies for the schedule:
daily, weekly, monthly.

Daily: To run the flow on a daily basis, select Daily and one of the following:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 806
Robotic Process Automation 2019.11

Every: To run the flow every day at regular intervals, select Every, and then enter the value and
select minutes or hours.

Note If you select Every, the interval field cannot be left empty, and the
value must be at least 1.

Every day: Select to run the flow once every day of the week.

Note The flow run will start at the time set in the Start time field in the
Range of recurrence section.

Every weekday: Select to run the flow once a day, on weekdays only.

Note If the working week is not Monday-to-Friday, use the Weekly


option instead, and select the working days.

Weekly: To run the flow on a weekly basis, select Weekly and then select the days of the week on which
you want the flow to run.

Note If you select Weekly, you must select at least one day.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 807
Robotic Process Automation 2019.11

Monthly: To run the flow every month, select Monthly and one of the following:

To run the flow on a particular date in each month, select Day and select the date. For example, select
15 to run the flow on the 15th of every month.

To run the flow once a month on a particular day of the week, select the day of the week and whether
it is the first, second, third, fourth, or last time that this day occurs in the month. For example, to run
the schedule on the third Friday of each month, select third, then select Friday, and then select 1
month(s).

To run the flow at intervals of several months, select a number of months. For example, to run a
schedule once a quarter, on the first Monday of the quarter, select first, then select Monday, and then
select 3 months.

For example, in a schedule starting on April 1, 2013, and ending on December 20, 2013, with a
recurrence pattern of the third day of every 2 months, the flow will run on June 3, August 3, October 3,
and December 3.

To run the flow on the last day of the month, select last and then select day instead of a specific day
of the week.

Yearly: To run the flow once a year, select Yearly and one of the following:

To run the flow on a particular date each year, select Every and then select the month and the date.
For example, every July 4.

To run the flow once a year on a particular month and on a particular day of the week, select the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 808
Robotic Process Automation 2019.11

month, then select the day of the week and whether it is the first, second, third, fourth, or last time
that this day occurs in the month. For example, the second Monday of each November.

6. In the Range of recurrence section, in the Start date box, enter the date on which you want the flow
schedule to start.

Note If a schedule with an earlier date undergoes content upgrade, the start
date is changed to the current date.

Note The date format appears in accordance with the locale of the client
browser.

7. In the Start time boxes, enter the time at which you want the flow schedule to start, in hours and minutes.

8. From the Timezone list, select the time zone where you are located.

Note Time zones around the world are expressed as positive or negative
offsets from Coordinated Universal Time (UTC). When you create a schedule, a
time zone is selected by default from the alphabetically-ordered list that is
currently available. Robotic Process Automation selects the first time zone
from the list that has the offset equal to the client offset (computed with
daylight savings, if relevant).

The timezone might not be geographically correct. For example, if you are

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 809
Robotic Process Automation 2019.11

located in a location where the time zone is UTC-09.00, the default time zone
will be America/Anchorage. If desired, you can select the geographically
correct location from the Timezone list.

9. Specify what to do if a scheduled task misfires. For detailed explanation of the available misfire options, see
the Handle misfires instructions below.

10. Select when you want the schedule to end:

Select No end date if you do not want to set an end date for the schedule.
To limit the schedule to a specific number of runs, select End after and enter the number of runs after
which the schedule will stop. This option is only available for daily schedules that have been set to run at
intervals of a number of hours or minutes.
To end the schedule on a specific date, select End by and enter the date after which schedule will stop.

If you try to set the end date for the schedule to the current date (or earlier), the Save button is disabled
and the following warning message appears:

The end date must be after the start date.

11. If the flow requires inputs, enter them in the Inputs section on the right side. If a red star appears next to an
input box, this means that the input is required, and the Save button will not be enabled unless an input
value is provided.

12. If you want to enter additional inputs that are not flow inputs, click Add Input at the bottom of the Inputs
section, and enter the name and value of the input. If you want to encrypt an input, select Sensitive Input
check box against an input.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 810
Robotic Process Automation 2019.11

13. Click Save.

If the Save button is not enabled, this means that a required input has not been provided, or there is a
mistake in one of the fields in the dialog box. For example, the Save button is not enabled if a non-existent
date is entered, such as February 31, or if no days of the week are selected for a weekly recurrence pattern.

Handle misfires
A misfire occurs when the RPA Scheduler fails to trigger a flow at the scheduled start time. This might happen
when you schedule too many flows to fire at the same time and all worker threads are already allocated to other
flows. Misfires might also happen when the Central Service is not running, or when the server is rebooting at the
time when a flow was scheduled to start.
The Scheduler detects and records all misfired flows. Each misfired flow is then checked against its specified
misfire settings to verify whether and when to retry running the flow.
To specify how to handle misfires

1. Go to Run Management > Scheduler and select the Create icon.

2. In the Create Schedule dialog box, go to Range of recurrence > On Misfire. Depending on the
recurrence pattern of your flow's schedule, RPA shows different misfire options for simple and cron schedules.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 811
Robotic Process Automation 2019.11

Misfires on simple schedules

RPA shows the following misfire options if the Recurrence pattern of your flow defines regular flow executions over
a period of time. For example, run a flow every 2 hours.

Default misfire for simple schedules is Reschedule next with remaining repeat count.

Ignore misfire policy: never evaluate schedule for misfire situations but try to fire flow as soon possible. The
schedule is then updated as if the flow had fired at the right time. This option replaces the Repeat indefinitely
option in RPA 2019.07 and earlier.
Smart policy for simple schedules is selected based on the repeat count. This is the remaining runs before the
end date:

if there are no remaining runs, the Scheduler instructs the flow to Fire now.
if there is at least one remaining run, the Scheduler instructs the flow to Reschedule now with existing
repeat count.
for an indefinite number of remaining runs, the Scheduler instructs the flow to Reschedule next with
remaining repeat count.
Fire now: trigger flow run immediately after misfire.
Reschedule now with existing repeat count: reschedules misfired flow, keeping the original repeat count.
This option respects the schedule's end date. This means that if 'now' is a time after the specified end date, the
flow does not refire again.
Reschedule now with remaining repeat count: reschedules misfired flow, but only executes any repetitions
that have not completed yet. This option respects the schedule's end date. This means that if 'now' is a time
after the specified end date, the flow does not refire again.
Reschedule next with remaining repeat count: reschedules misfired flow starting with the next firing time,
but only executes any repetitions that have not completed yet.
Reschedule next with existing repeat count: reschedules misfired flow starting with the next firing time,
and uses the repeat count specified originally.

Misfires on Cron schedules

RPA shows the following misfire options if the recurrence pattern of your flow defines one or several flow
executions at a specific date and time. For example, run a flow every day, at 1 PM.

Default misfire for cron schedules is Do nothing.


Ignore misfire policy: never evaluate schedule for misfire situations but try to fire flow as soon possible. The
schedule is then updated as if the flow had fired at the right time. This option replaces the Repeat indefinitely
option in RPA 2019.07 and earlier.
Smart policy for cron schedules is Fire once now.
Fire once now: execute misfired flows immediately.
Do nothing: do not fire misfired flow now, but wait for the next fire time.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 812
Robotic Process Automation 2019.11

Reference material

Scheduler tab

GUI item Description

Opens the Create Schedule dialog box, so that you can add a new schedule.

New button

Opens the Edit Schedule dialog box, so that you can edit the selected schedule.
The Edit button is only available if at least one schedule is selected.
Edit button

Deletes the selected schedules. The Delete button is only available if at least one
schedule is selected.
Delete button

Enables the selected schedules. The Enable button is only available if at least one
disabled schedule is selected.
Enable button

Disables the selected schedules. The Disable button is only available if at least
one enabled schedule is selected.

Disable button

Creates an identical copy of the selected schedule. The Clone button is only
enabled if a single schedule is selected.
Clone button

Displays the details of the selected schedule. The Details button is only enabled if
a single schedule is selected.
Details button

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 813
Robotic Process Automation 2019.11

GUI item Description

Click to refresh the display of schedules.

Refresh button

Select Columns button Click to display the column picker, to choose which columns to display.

Click to remove the filters and display all the schedules.

Clear Filters button

Click to trigger an ad-hoc run of the scheduled flow.


Note The “Run Now” button is only enabled if a single schedule is selected.

Run now button

Filter boxes In the filter boxes at the top of the columns, enter text to filter the displayed
schedules.

State

Displays whether the schedule is enabled

or disabled .

Schedule Name Displays the name that was given to the schedule.
In the filter box under Schedule Name, enter the name of a schedule or part of a
name, to filter the displayed schedules.

Schedule Name Displays the name that was given to the schedule.
In the filter box under Schedule Name, enter the name of a schedule or part of a
name, to filter the displayed schedules.

Flow Name Displays the name of the flow that is run in the schedule.
In the filter box under Flow Name, enter the name of a flow or part of a name, to
filter the displayed schedules.

Next Run Displays the time when the next run is scheduled.

Previous Run Displays the time when the previous run in the schedule occurred.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 814
Robotic Process Automation 2019.11

GUI item Description

Persistence Level Displays the persistence level, which controls the level of detail that is saved to the
Run Log:
• Standard - Includes raw results, step results, and big inputs/outputs.
• Extended - Includes the complete raw results, step results, subflow outputs
(from step results), and big inputs/outputs.
• Taken from flow settings - whatever was selected as the default persistence
level for the flow.

User Displays the name of the user who created or modified the schedule.
If the schedule is created or updated by a user who is logged in as an anonymous
user, the User column will display N/A.

Create Schedule dialog box

GUI item Description

Flow Path Displays the path to where the flow is located.

Schedule Name Enter a meaningful name for this schedule.

Use empty value for Select this check box if you want the schedule to skip over prompts for inputs. For
prompts example, when you just want the schedule to run without you, and you don't want to
wait to see the prompt and enter the input. However, note that if input is required for
that flow, the flow will fail.
This option is selected by default after an upgrade from version 9.x to 10.x. This is to
enable backward compatibility, because this is how all schedules worked in 9.x

Persistence Level Select the persistence level, in order to control the level of detail that is saved to the
Run Log. The options are:
• Standard - Includes raw results, step results, and big inputs/outputs.
• Extended - Includes the complete raw results, step results, subflow outputs (from
step results), and big inputs/outputs.
• Taken from flow settings - whatever was selected as the default persistence level
for the flow.

Recurrence pattern In the Recurrence pattern section, you define the frequency at which the schedule
section recurs.
The Recurrence pattern section changes, depending on whether you select Daily,
Weekly, Monthly, or Yearly.

Daily - Every <n> To run the flow every day at regular intervals, select Daily, select Every, enter the
minutes/hours value, and select minutes or hours.
Note If you select Every, the interval field cannot be left empty, and the value must
be at least 1.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 815
Robotic Process Automation 2019.11

GUI item Description

Daily – Every day To run the flow once a day, every day of the week, select Daily, and then select
Every day.
Note The flow run will start at the time set in the Start time field in the Range of
recurrence section.

Daily – Every weekday To run the flow every weekday, select Daily, and then select Every day.
Note If the working week is not Monday-to-Friday, use the Weekly option instead, and
select the working days.

Weekly To run the flow on a weekly basis, select Weekly and then select the days of the week
on which you want the flow to run.
Note If you select Weekly, you must select at least one day.

Monthly – Day <n> of To run the flow on a particular day of each month , select Monthly, select Day and
every month then select the date. For example, select 15 to run the flow on the 15th of every
month.

Monthly – The <nth> To run the flow once a month on a particular day of the week, select the day of the
<day of week> of week and whether it is the first, second, third, fourth, or last time that this day occurs
every <n> month(s) in the month. For example, to run the schedule on the third Friday of each month,
select third, then select Friday, and then select 1 month(s).
To run the flow at intervals of several months, select a number of months. For
example,to run a schedule once a quarter, on the first Monday of the quarter, select
first, then select Monday, and then select 3 month(s).
To run the flow on the last day of the month, select last, and then select day instead
of a specific day of the week. colspan='2'|

Yearly – Every To run the flow on a particular date each year, select Yearly, select Every, and then
<month> <n> select the month and the date. For example, every July 4.

Yearly – The <nth> To run the flow once a year on a particular month and on a particular day of the week,
<day of week> of select Yearly, select the month, select the day of the week and whether it is the first,
<month> second, third, fourth, or last time that this day occurs in the month. For example, the
second Friday of each November.

Range of recurrence In the Range of recurrence section, you define when the schedule starts and ends.
section

Start date Enter the date on which you want the schedule to start.
Note If a schedule with an earlier start date undergoes content upgrade, the start
date is changed to the current date.

Start time Enter the time of day at which you want the schedule to start.

No end date Select if you want the schedule to run continuously.

End after <n> To limit the schedule to a specific number of runs, select End after and enter the
occurrences number of runs after which the schedule will stop. This option is only available for
daily schedules that have been set to run at intervals of a number of hours or
minutes.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 816
Robotic Process Automation 2019.11

GUI item Description

End by <date> To end the schedule on a specific date, select End by and enter the date after which
schedule will stop.

Timezone From the Timezone list, select the time zone where you are located.
Note Time zones around the world are expressed as positive or negative offsets from
Coordinated Universal Time (UTC). When you create a schedule, a time zone is
selected by default from the alphabetically-ordered list that is currently available.
Robotic Process Automation selects the first time zone from the list that has the offset
equal to the client offset (computed with daylight savings, if relevant).
Note that this timezone might not be geographically correct. For example, if you are
located in a location where the time zone is UTC-09.00, the default time zone will be
America/Anchorage. If desired, you can select the geographically correct location
from the Timezone list.

On misfire Specify what to do if a scheduled task misfires. For detailed explanation of the
available misfire options, see the Handle misfires instructions above.

Inputs If the flow requires inputs, enter them in the Inputs section. This section will look
different, depending on whether inputs are required. You can also mark an input that
you want to encrypt by choosing Sensitive Input check box.

Save Click to save the schedule.

Related topics
To set up security for roles, see Set up security for roles.
To monitor and control database size, see Monitor and control database size.
To find out more about cron schedulers, see Quartz Cron Triggers.
To learn more about simple schedulers, see Quartz Simple Triggers.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 817
Robotic Process Automation 2019.11

Track and manage flow runs

While a flow is running, you can track the run and monitor its progress in the Run Explorer tab. The table
displays information for basic monitoring of your runs and those of other users.
The Run Explorer is auto-refreshed. The view is updated whenever a new run is started or if the run status,
duration, or user is updated.
The name that appears under Run Name in the Run Explorer is not always the flow name:

If you gave the run a name, this is the name that appears.
For a scheduled run, if you gave the schedule a name, this is the name that appears.
You can use the Run Explorer to manage flow runs when there are multiple flows running. You can perform actions
on one or more flow runs, such as pausing, resuming, reassigning, and canceling them.
The display of runs depends on the content permissions that your user has been assigned. You can only see runs of
flows you have permission to view.
The actions that you can perform on flow runs depends on permissions that you have been assigned in your role:

If you have been assigned a role with the Manage Others' Runs permission, you will be able to perform actions
on the runs triggered by all users.
If you have been assigned a role without this permission, you will be able to perform actions on the runs that you
have triggered.

If you are unable to locate a flow run, you can use the filter capabilities of the Run Explorer to find the flow run that
you need.

View basic details about a flow run


To view basic details about a flow run:

1. Click the Run Management button to display the Run Management workspace.

2. Click the Run Explorer tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 818
Robotic Process Automation 2019.11

3. View the basic details about each run, in the Runs table.

Select multiple runs


You can perform the following actions on multiple runs: Cancel, Pause, Reassign, Resume.
There are two ways to select multiple runs in the Run Explorer:

Click in the check box next to each run that you want to select
Hold down the Shift/Ctrl keys and click anywhere in the row to select a run:

Use Shift to select multiple runs that are adjacent. Select the first run, and hold the Shift key while you
select the last run.
Use Ctrl to select multiple runs that are not adjacent.

Display advanced details about a flow run


1. Click the Run Explorer tab.

2. Select the flow run that you want to look at in detail.

3. Click the Drill down button at the end of each row to display more information about the selected run.

Note Alternatively, you can double-click a row to drill down to see this
information.

Note The Drill down button is only displayed when you select a row in the
table.

Pause a flow run


You cannot pause flows if the execution is in a RPA step.

1. Click the Run Management button to display the Run Management workspace.

2. Click the Run Explorer tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 819
Robotic Process Automation 2019.11

3. Select one or more flows that are currently running.

4. Click the Pause button in the Run Explorer toolbar. This button is only available if all selected runs are
currently running.

The Pending pause status will be timed out if the timeout threshold is reached.

The run status is changed to Pending pause and then to Paused.

Resume a flow run that was paused


You can resume a run that has Paused – User Paused status. If you have been assigned a role with the Manage
Others' Runs permission, you can resume runs that were paused by others. Otherwise, you can resume runs that
you paused.

1. Click the Run Management> Run Explorer tab.

2. Select one or more runs that were paused.

3. If the Resume button is available in the Run Explorer toolbar, click it to resume the run (or runs).

If the Resume button is not available in the Run Explorer toolbar, this means that you need to interact with the
system in order to complete these runs individually:

1. Click the Drill down button at the end of the row to display more information about a run.

2. Click the Expand button to expand the prompt message.

3. Enter the required information.

4. Click Resume .

5. Repeat for the next run that needs to be resumed.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 820
Robotic Process Automation 2019.11

Note The Resume button is only available if all selected runs are currently
paused.

Cancel a flow run


You cannot cancel an execution once the run has started.

1. Click the Run Management> Run Explorer tab.

2. Select one or more flows that are currently running.

3. Click the Cancel button in the Run Explorer toolbar.

4. In the confirmation dialog box, click Yes to confirm that you want to cancel the flow run (or runs).

Note The Cancel button is only available if all selected runs can be canceled:
if they are running or paused but not finished.

Note There is no intermediary states such as PENDING_CANCEL or


PENDING_PAUSE when you cancel an RPA activity.

Reassign ownership of a flow run


Each run has an owner. By default, this is the person who started the run, but you can change the owner during
execution by assigning the run to a different user. The owner of a run is the user who appears in the User column.
You can reassign multiple runs at the same time. However, you cannot reassign flows if the execution is in a RPA
step.
Reassignment is usually triggered as a result of a gated transition, where the run is paused because it doesn’t
have permission to proceed, or as a result of a handoff, where the author marked a transition as needing to be
handed off to another user. However, you can also reassign a flow at any point in the flow run. If the flow is
running, it will become paused so that it can be reassigned. Reassignment does not validate that the reassigned
user exists.
If you reassign a flow with the status of Paused – Action Required, the assigned user will not be able to resume
it via the Run Explorer. The assigned user will need to drill down into the run and resume it from there.

1. Click the Run Management> Run Explorer tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 821
Robotic Process Automation 2019.11

2. Select one or more flows that are currently running or paused.

3. Click the Reassign button.

4. In the Reassign a Run dialog box, enter the user name of a different user and the domain to which this user
belongs.

5. Click Reassign. This button is only available if the selected runs are running or paused.

Hand off a flow run


Some flows contain gated transitions, requiring the current user to hand off the run to another user. The run
pauses, and a dialog box enables the current user to send an email to another user, asking them to continue the
run.

1. Click the Run Management > Run Explorer tab.

2. Select a run that is currently paused at the gated transition.

3. Click the Drill down button at the end of the row to display more information about the selected run.

4. Click the Expand button to expand the prompt message.

5. In the prompt message, click the Hand off to another user (email this run) link to create an email
message to send to the user who needs to complete the flow run.

6. An email message opens, with a message for the person to whom you are handing off the flow run and a link
to the flow run. Enter the email address of this person and send the message.

Refresh the runs in the Run Explorer

The Refresh button refreshes the view that is currently below in the Run Explorer—whether this is the run
list or the drill down.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 822
Robotic Process Automation 2019.11

Click the Refresh button in the Run Explorer toolbar.

Note that after you refresh, your selected row is cleared.

Note It is also possible to refresh the page by pressing F1 on your keyboard, but
this loads the entire page. Clicking the Refresh button only refreshes the data
display, so this is much faster.

Related topics
To adjust the display of flow runs, see Adjust the display of flow runs.
To test and troubleshoot flow run, see Test and troubleshoot a flow run.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 823
Robotic Process Automation 2019.11

Adjust the display of flow runs

Adjust filters
The Run Explorer can display up to 200 flow runs in a single page. If you have multiple flows running at the same
time, it is recommended to use filters to locate the flow that you need.

You can create a filter to view runs that contain a specific word in their name, runs with a specific status, runs that
were started by a specific user, or runs that started within a defined time range.
You can apply multiple filters at the same time. For example, you can filter the Run Explorer to display only failed
runs with the word "Ping" in their name, which were started on the first of June.
To apply a filter, select or enter text in the filter boxes in the Run Explorer toolbar. Once you have entered the
criteria, the filter is applied—there is no need to click a button to apply it.
It is also possible to filter runs via API.

Adjust columns
You can also adjust the width and position of a column, and decide which columns to show and which to hide.
Changes that you make to these settings (column width, column order, hidden columns, and applied filter) are
saved in the local cache of the browser. Changes that you make to the columns will affect all users on this
machine, regardless of which user is logged in. When you hide a column, if you were using a filter, it deletes the
filter.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 824
Robotic Process Automation 2019.11

Reference material

Run Explorer toolbar - Filter options

GUI item Description

Filter by: Status From the Status list, select the status or statuses that you want to filter by.

Filter by: User Enter part or all of the user name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 825
Robotic Process Automation 2019.11

GUI item Description

Filter by: Start Time

Select the arrow next to Start Time to filter according to the date and time that the
runs were started. Select one of the options:
• Last Day – to display only runs that started within the last 24 hours.
• Last 7 Days – to display only runs that started within the last week.
• Last 30 Days – to display only runs that started within the last 30 days.

Custom Range, and then select the start and finish of the time range that you want to
filter by. You can select both the date and the time of day. The calendar on the left is for
the start of the time range and the calendar on the right is for the end of the time range.
For example, you may want to display only runs that started between 9:00 and 10:00 AM
on Monday August 20, 2013.

Filter by: Run Name Enter part or all of the run name.

Filter by: Run ID Enter part or all of the Run ID.

Clear Filter button Click to remove the filters and display all the flows.

What do you want to do?

Create a filter according to run status

1. Click the Run Management button to display the Run Management workspace.

2. Click the Run Explorer tab.

3. From the Status list, select the status that you want to filter by. You can select more than one status.

The Run Explorer only displays runs with one of the selected statuses.

Note After you have selected a status for the filter, the name of this status
appears as the title of the Status list.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 826
Robotic Process Automation 2019.11

Create a filter according to start time

1. In Run Management, click the Run Explorer tab.

2. In the Run Explorer toolbar, select the arrow next to Start Time.

3. Select one of the following options:

Last Day – to display only runs that started within the last 24 hours.
Last 7 Days – to display only runs that started within the last week.
Last 30 Days – to display only runs that started within the last 30 days.
Custom Range, and then select the start and finish of the time range that you want to filter by. You can
select both the date and the time of day. The calendar on the left is for the start of the time range and the
calendar on the right is for the end of the time range.

For example, you may want to display only runs that started between 9:00 and 10:00 AM on Monday
August 20, 2013.

Create a filter according to user name

Filters are not case-sensitive, so you can type in upper or lower case.

1. In Run Management, click the Run Explorer tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 827
Robotic Process Automation 2019.11

2. In the User text box, enter part or all of the user name.

The Run Explorer displays only runs that were started by the specified user. For example, entering your user
name displays only the flow runs that you have run.

Create a filter according to run name

Filters are not case-sensitive, so you can type in upper or lower case.

1. In Run Management, click the Run Explorer tab.

2. In the Run Name text box, enter part or all of the run name.

The Run Explorer displays only runs that contain this text in their name. For example, typing “network”
returns all the rows where the filtered field contains the word “network”.

Create a filter according to run ID

1. In Run Management, click the Run Explorer tab.

2. In the Run ID text box, enter part or all of the run ID.

The Run Explorer displays only the run with this run ID.

Remove a filter

1. In Run Management, click the Run Explorer tab.

2. To remove an individual filter, clear the relevant filter text box.

3. To remove all the filters, click the Clear Filter > button.

The filters are no longer applied.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 828
Robotic Process Automation 2019.11

Change the position of a column

1. In Run Management, click the Run Explorer tab.

2. In the Run Explorer toolbar, drag a column name to the left or the right, to adjust the column's position in the
Run Explorer.

Adjust the width of a column

1. In Run Management, click the Run Explorer tab.

2. In the Run Explorer toolbar, drag the edge of a column name, to adjust its width.

Hide/display a column

1. In Run Management, click the Run Explorer tab.

2. In the Run Explorer toolbar, click the Select Columns button to display the column picker.

3. To hide a column, clear the check box next to its name.

Related topics
To track and manage flow runs, see Track and manage flow runs.
To test and troubleshoot a flow run, see Test and troubleshoot a flow run.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 829
Robotic Process Automation 2019.11

Test and troubleshoot a flow run

After you have triggered a flow run, you can drill down into the run and investigate its progress in detail.
This is particularly helpful if a flow run fails.

When you click the Drill down button at the end of a row in the Run Explorer, this displays detailed information
about the selected run. Alternatively, you can double-click a row to drill down to see this information.
To the left, the Run Tree displays the steps in the run and the transition messages. The Run Tree highlights the
currently running step and displays information about the progress of the run. If a flow fails, you will see at which
step the failure occurred. The steps and transition messages are automatically refreshed as the run progresses.
While a flow is running, if you click a step, the auto-refresh will pause. In order to resume you need to click the

Resume Refresh button.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 830
Robotic Process Automation 2019.11

There are a number of collapsible views that you can use to display different kinds of information:

Information about the flow—UUID, flow name, path, description, flow inputs, flow outputs, and so on.

Click the Down arrow in the center of the Run Explorer drill down view toolbar.

Information about a selected step in the flow—start time, end time, step result, duration, inputs, results,
error message, warning, Robot ID, worker group, the ID of the worker that executed the step, and so on. Click
the Step Details tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 831
Robotic Process Automation 2019.11

The Step Details tab displays details about the step that is currently running. If you select a step in the Run
Tree, the Step Details tab displays details about the selected step.

The Step Details tab may contain Concise or Detailed information about the step. The information shown
depends on the option selected for the step in the Advanced tab of the Step Inspector. If any of these details
were defined as sensitive data, they will be encrypted and will appear as asterisks.

All sensitive data is encrypted in-memory and in the database during the run and later. The event is persistent
and is presented as asterisks in the UI. This property is propagated between elements. For example, if a step
result was marked as sensitive data, the step result passes this behavior to every input/step result that is
assigned from it. This includes sensitive data returned by a scriptlet.

You can drag the slider on the left edge of the Flow Info pane to adjust its width.

A graphical view of the flow, with the currently running step highlighted. Click the Flow Graph tab.

The Flow Graph highlights the step that is currently running. If you select a step in the Run Tree, the Flow Graph
highlights the selected step. You can adjust the way that the flow graph is displayed, by dragging it across the
screen to view hidden item, or by using the zoom buttons to adjust the size of the image.

The Run Log—a table with information about the entire run (steps, start time, duration, inputs, results, and so
on), with the option to find a specific step.

Click the Run Log button to display the Run Log pane.

If the run includes subflows, the steps in the subflows are indented in the run log.

Click the Run Tree button to collapse the Run Log pane and show the Run Tree.

You can click the button in the toolbar to toggle between viewing a selected step in the Run Tree and in the
Run Log. The run has no drill down details, if the run details were cleared in the system.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 832
Robotic Process Automation 2019.11

Reference material

Run Explorer drill down view toolbar

When you drill down to see the details of a flow run, the toolbar at the top remains constant, and the details
displayed below vary according to your selections.

GUI item Description

Click to return to the main Run Explorer window.

Back button

Click to display the Run Tree pane, when the Run Log is displayed.

Run Tree button

Click to display the Run Log pane, when the Run Tree is displayed.

Run Log button

Run name Displays the name of the flow run.

Down arrow Click to expand the Flow Info pane.

Status Displays the status of the flow run:

Success or

Error

Run Tree

When you drill down to see the details of a flow run, the Run Tree appears on the left. The Run Tree displays all the
steps in the flow run and their transition messages. The action toolbar at the top enables you to perform actions on
the run.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 833
Robotic Process Automation 2019.11

GUI item Description

Action Toolbar The action toolbar shows different buttons, depending on whether the Run Log
or the Run Tree is displayed.

Click to pause the selected run. The run will stop until it is resumed. This button
is only available for runs that are currently running.
Pause button

Click to resume the run. This button is only available for runs that are paused.

Resume button

Click to cancel the run.

Cancel button

Click to reassign the run to a different user.

Reassign button

Click to refresh the run.

Refresh button

While a step is selected in the Run Tree, jump to that same step in the Run Log.

Go to Log Tree button

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 834
Robotic Process Automation 2019.11

GUI item Description

Collapse the Run Tree and display only the top level of the steps.

Collapse All button

While a flow is running, if you click a step, the autorefresh will pause. In order
to resume you need to click the Resume Refresh button.

Resume Refresh button

Step Name Displays the name of each step in the flow run. Next to each step, an icon
displays the step's status.
Click a step to display its details in the Flow Info pane to the right.

Transition Message Displays the transition message for the step, if one exists.

Step Details tab with Concise Step Persistence

Click the Step Details tab to display information about the currently running step. If you select a step in the Run
Tree, the Step Details tab displays details about the selected step.
The fields displayed in the Step Details tab may vary between different types of step.

GUI item Description

Run ID Displays the execution ID of the selected run.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 835
Robotic Process Automation 2019.11

GUI item Description

Step ID Displays the UUID of the selected step.

Start Time Displays the time when the selected step started.

End Time Displays the time when the selected step ended.

Response Displays the response of the selected step, if one exists.

Duration Displays the duration of the selected step.

Description Displays the description of the selected step, if one exists.

Workers Group Displays the worker group of the selected step, if one exists.

Start Worker ID Displays the UUID of the worker that executed the selected step, if one exists.

End Worker ID Displays the UUID of the end worker that executed the selected step, if one exists.

Robot Groups Displays the UUID of the Robot Groups. It is currently set to Default group.

Robot ID Displays the UUID of the Robot that executed the selected RPA step, if one exists.

Transition Message Displays the message that appears during the transition of the selected step, if one
exists.

Step Persistence Displays the persistence level for this step. Concise means inputs and results are not
shown

Step Details tab with detailed step persistence

Click the Step Details tab to display information about the currently running step. If you select a step in the Run
Tree, the Step Details tab displays details about the selected step.
The fields displayed in the Step Details tab may vary between different types of step.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 836
Robotic Process Automation 2019.11

GUI item Description

Run ID Displays the Execution ID of the selected run.

Step ID Displays the UUID of the selected step.

Start Time Displays the time when the selected step started.

End Time Displays the time when the selected step ended.

Step Response Displays the response of the selected step, if one exists.

Duration Displays the duration of the selected step.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 837
Robotic Process Automation 2019.11

GUI item Description

Inputs Displays the inputs of the selected step, if these exist.


If these inputs were defined as sensitive data, they will be encrypted and will appear as
asterisks.

Primary Result Displays the primary result of the selected step, if one exists.
If the raw result is marked as sensitive, then the primary result will be encrypted and will
appear as asterisks.

Step Results Displays the error message and return results of the selected step in separate fields. You
can click inside the fields to view and export the code for troubleshooting.
If these results were defined as sensitive data, they will be encrypted and will appear as
asterisks.

Worker Group Displays the worker group of the selected step, if one exists.

Start Worker ID Displays the UUID of the start worker that executed the selected step, if one exists.

End Worker ID Displays the UUID of the end worker that executed the selected step, if one exists.

Robot Groups Displays the UUID of the Robot Groups. It is currently set to Default group.

Robot ID Displays the UUID of the Robot that executed the selected step, if one exists.

Transition Message Displays the message that appears during the transition of the selected step, if one
exists.

Step Persistence Detailed.

Flow Graph tab

Click the Flow Graph tab to display a graphical view of the flow, with the currently running step highlighted. If you
select a step in the Run Tree, the Flow Graph highlights the selected step.
The flow graph is not supported for RPA steps.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 838
Robotic Process Automation 2019.11

GUI item Description

Zoom In button Click to increase the size of the flow graph.

Zoom Out button Click to decrease the size of the flow graph.

Reset button Click to reset the graph to the default size and position.

Run Log

Click the Run Log button to display the Run Log pane with details about the entire run. The action toolbar
at the top enables you to perform actions on the run.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 839
Robotic Process Automation 2019.11

GUI item Description

Action Toolbar The action toolbar shows different buttons, depending on whether the Run Log or
the Run Tree is displayed.

Click to pause the selected run. The run will stop until it is resumed. This button is
only available for runs that are currently running.
Pause button

Click to resume the run. This button is only available for runs that are paused.

Resume button

Click to cancel the run.

Cancel button

Click to reassign the run to a different user.

Reassign button

Click to refresh the run.

Refresh button

While a step is selected in the Run Log, jump to that same step in the Run Tree.

Go to Run Tree view


button

Find Click to open the Find dialog box, to locate a step.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 840
Robotic Process Automation 2019.11

GUI item Description

After running a search, close the Find dialog box and use the arrows in the toolbar
to navigate across the search results.

Export All to Text/CSV Click to export the run log into a text/CSV file, listing all the events that occurred in
the flow run.

button

Step # Displays the step number of each step

Displays the type of step. Icons represent operation, subflow, return step, and
other.
Icon

Name Displays the name of the step. If the step is part of a subflow, the step name is
indented.

Start Time Displays the time when each step started.

Duration Displays the duration of each step.

Inputs Displays the inputs of each step, if these exist.

Raw Results Displays the results of each step.


If these results were defined as sensitive data, they will be encrypted and will
appear as asterisks.

Response An icon represents the response of each step: Resolved, Error, Diagnosed, No
Action Taken.

Transition Displays the description of the outgoing transition, or its name if there is no
description.

ROI Displays the ROI of the outgoing transition.

Current Flow Displays the name of the flow containing the step. If there are subflows, this
contains the name of the subflow containing the step.

User Displays the run owner at the time the step was run.

Worker Displays the UUID of the worker that executed the step.

Run Log > Find dialog box

Use the Find button in the Run Log to help locate a step that you want to see. Enter one or more search criteria,
scrolling down to see those that are hidden. Steps that correspond to the search criteria are highlighted.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 841
Robotic Process Automation 2019.11

GUI item Description

Clear Click to clear the search criteria boxes.

Next Click to highlight the next step that corresponds to the search criteria.

Previous Click to highlight the previous step that corresponds to the search criteria.

You can close the Find dialog box and use the arrows in the toolbar to navigate across the search
results.

Flow Information

Click the Down arrow

to the right of the flow run name, to expand the Flow Info pane.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 842
Robotic Process Automation 2019.11

GUI item Description

General details Displays basic information about the run, such as start time, duration, user, run ID, and the
persistence level, which specifies how the run history is saved to the database.

Flow ID Displays the UUID (unique identifier) of the flow.

Flow Name Displays the name of the flow.

Path Displays the path to where the flow is located.

Description Displays the description of the flow, if one exists. If you can't see all the text in the pane, use
the slider to display the text that is lower down in the pane.

Flow Inputs Displays the flow inputs (if any exist).

Flow Outputs Displays the flow output.

Click to collapse the Flow Info pane.


Up arrow

What do you want to do?

Display details about the steps in a flow run

1. Click the Run Management button to display the Run Management workspace.

2. Click the Run Explorer tab.

3. Select the flow run that you want to look at in detail.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 843
Robotic Process Automation 2019.11

4. Click the Drill down button at the end of the row to display the drill down information about the selected
run.

To the left, the Run Tree displays the steps in the run and the transition messages. It highlights the currently
running step and displays information about the progress of the run. If a flow fails, you will see at which step
the failure occurred. The steps and transition messages are automatically refreshed as the run progresses.
While a flow is running, if you click a step, the auto-refresh will pause. In order to resume you need to click

the Resume Refresh button.

5. When you click a step in the Run Tree, you display information about that step in the Run Info pane on the
right.

In the Run Info pane, click the Step Details tab to display information about the currently running step,
such as the start time, duration, inputs, results, description, worker group, the ID of the worker that executed
the step, and so on.

If you select a step in the Run Tree, the Step Details tab displays details about the selected step.

The fields displayed in this section will vary between different steps, depending on whether they include
inputs, results, and so on.

6. (Optional) You can click the button in the toolbar to view the selected step in the Run Log.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 844
Robotic Process Automation 2019.11

7. Click the Back button to return to the main Run Explorer window.

Display the graph of a flow run

You can display a graphical image of a flow run, and highlight the position of the currently running (or selected)
step.

NoteFlow graph is not supported for RPA steps yet.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

2. Select the flow run that you want to look at in detail, and click the Drill down button at the end of the
row.

3. Click a step in the Run Tree on the left.

4. In the Run Info pane on the right, click the Flow Graph pane to display a graphical view of the flow, with the
currently running step highlighted.

If you select a step in the Run Tree, the Flow Graph highlights the selected step.

5. You can adjust the way that the flow graph is displayed:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 845
Robotic Process Automation 2019.11

Drag the flow graph across the screen, to display elements that are not visible.
Click the zoom buttons to increase or decrease the size of the flow graph.

Click the Reset button to reset the view to the default size and position.

Display the Run Log with details of the entire run

The Run Log is a table with information about the entire run (steps, start time, duration, inputs, results, and so on).
This information is useful for identifying issues about a run, while troubleshooting.
The Run Log displays a maximum of 500 runs in one page, in order to meet performance requirements. Runs with
over 500 steps are displayed in multiple pages. You can use the paging functionality to navigate through the
pages.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

2. Select the flow run that you want to look at, and click the Drill down button at the end of the row.

3. Click the Run Log button to toggle between expanding and collapsing display the Run Log pane, with
details about the entire run. If the run includes subflows, the relevant steps are indented.

4. For runs of over 500 steps, which are displayed in multiple pages, navigate through the pages:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 846
Robotic Process Automation 2019.11

Click the arrow buttons


Enter the number of a specific page

5. To hide or display columns, click the Select Columns button to display the column picker. Select the
check box next to a column name to display that column or clear the check box to hide it.

Note When you hide a column, this does not affect the results if you run a
search.

6. You can click the Run Tree button to collapse the Run Log pane and show the Run Tree. Or click the

button in the toolbar to view the selected step in the Run Tree.

Find a step in the Run Log

In a long run, it may be difficult to find a particular step. Use the Find button to help locate the step that you want
to see.
Searching in the Run Log is only supported if the storage space taken up by the searched field is no more than
4,000 bytes. The Japanese and Chinese take up about 3 bytes per character, while other (non-English) languages
take up about 1.5 bytes per character. In the case of transition descriptions, the 4,000 bytes are shared among all
of the locales in which the description is available.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

2. Select the flow run that you want to look at, and click the Drill down button at the end of the row.

3. Click the Run Log button to display the Run Log pane.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 847
Robotic Process Automation 2019.11

4. Click the Find button to display the Find dialog box.

5. Enter the search criteria, scrolling down to see those that are hidden. This is not a filter. Steps that
correspond to the search criteria are highlighted, but the unselected steps are displayed, so that you can see
the context of the highlighted steps.

6. Click Next to highlight, in turn, each step that corresponds to the search criteria.

7. If desired, you can close the Find dialog box and use the Next and Previous arrows in the toolbar
to navigate across the search results.

Toggle between viewing a step in the Run Tree, Flow Graph and in the
Run Log

You can move in either direction:

While a step is selected in the Run Tree, you can jump to that same step in the Run Log to display more
information about that step.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 848
Robotic Process Automation 2019.11

While a step is selected in the Run Tree, you can jump to that same step in the Run Log and Flow Graph, to see
how the step fits into the overall picture of the flow.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

2. Select the flow run that you want to look at, and click the Drill down button at the end of the row.

3. When you select a step in the Run Tree, click the button to display the Run Log with the selected step
highlighted.

4. When you select a step in the Run Log, click the button to display the Run Tree with the selected step
highlighted. The selected step is also highlighted in the Flow Graph.

Collapse the Run Tree

If the Run Tree is expanded, you can collapse the expanded steps.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

2. Select the flow run that you want to look at, and click the Drill down button at the end of the row.

3. Click the steps in the Run Tree, in order to expand them, and display subflows and lanes.

4. Click the Collapse All button to collapse the Run Tree and display only the top level of the steps.

Adjust the width of the Run Info pane

You can use the slider at the edge of the Run Info pane to adjust its size.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 849
Robotic Process Automation 2019.11

2. Select the flow run that you want to look at, and click the Drill down button at the end of the row.

3. Drag the edge of the slider to adjust the width of the Run Info pane.

4. Use the open/close button in the slider to toggle between expanding and collapsing the pane.

Display details about the flow

While drilling down to a flow run, you can view details about the original flow, such as flow UUID, flow name, path,
description, flow inputs, flow outputs, and so on.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

2. Select the flow run that you want to look at, and click the Drill down button at the end of the row.

3. Click the Down arrow

to the right of the flow run name, to expand the Flow Info pane.

4. If you can't see all the text in the pane, use the slider to display the text that is lower down in the pane.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 850
Robotic Process Automation 2019.11

5. Click the Up arrow to collapse the Flow Info pane.

Export the Run Log as a text file

You can export the Run Log into a text file, listing all the steps' logs, which occurred in the flow run. This can help
identify the causes of a problem. It may be useful to send the this file to the flow author, when a flow needs fixing.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

2. Select the flow run that you want to look at, and click the Drill down button at the end of the row.

3. Click the Run Log button to display the Run Log pane.

4. Click the Export button and from the dropdown, select .

The button with the name of the text file appears at the lower edge of the RPA window. You can click it to
open the file in your default text editor.

5. You can send the text file to the flow author, when requesting a change to a flow.

Export the Run Log as a CSV file

You can export the Run Log into a CSV file, listing all the steps' logs, which occurred in the flow run. This can help
identify the causes of a problem. It may be useful to send the this file to the flow author, when a flow needs fixing.
In order to open the CSV file in Excel, make sure that Excel is configured correctly for character encoding.

1. Click the Run Management button to display the Run Management workspace, and click the Run Explorer
tab.

2. Select the flow run that you want to look at, and click the Drill down button at the end of the row.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 851
Robotic Process Automation 2019.11

3. Click the Run Log button to display the Run Log pane.

4. Click the Export button and from the dropdown, select .

A button with the name of the CSV file appears at the lower edge of the RPA window. You can click it to open

the CSV file in Excel.

5. You can send the CSV file to the flow author, when requesting a change to a flow.

Related topics
To track and manage flow runs, see Track and manage flow runs.
For information about the persistence level, see Monitor and control database size.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 852
Robotic Process Automation 2019.11

Embed RPA Central views in external web pages

RPA gives you the option to embed parts of the RPA Central UI into an external application. You can embed:

Flow Run view - for running and interacting with flows


Drill Down view - for advanced tracking of running flows
To embed the view in your web page, use an iFrame element in the HTML with the appropriate URL.
In the example below, the 999 in drilldown-ex.html#999 stands for the <run_id> value.

<!DOCTYPE html> <html lang="en-US"> <head> <style> iframe { width : 800px; height : 600px; }
</style> <title>HTML iframe tag</title> </head> <body> <iframe
src="http://localhost:8080/oo/drilldown-ex.html#999"></iframe> </body> </html>

Important If you are going to embed the Drill Down window into an external
HTML page, it is recommended to have an SSO solution in place (for example,
SAML 2.0). If an SSO solution has not been configured, an RPA login screen will
appear in the iframe, when it first loads inside the page. On some browsers (for
example, IE11), the default privacy settings will need to be updated to allow third
party cookies before users will be able to log into RPA via the iframe.

What do you want to do?

Run a flow in an embedded Flow Run view

The Flow Run view lets you run a specific flow and perform minimal tracking as it runs.
For example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 853
Robotic Process Automation 2019.11

After the flow is run, the basic tracking view appears.

To run a flow in an embedded Flow Run view, use the following URL pattern:
http://<hos_name>:<port>/oo/trigger.html#<flow_uuid>
Identify the flow to run via the <flow_uuid>. You can find it in the flow's Run Link section in the Flow Library.
If required, use the input_ and runName prefixes to edit the run link. You can get it to pass inputs or to change the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 854
Robotic Process Automation 2019.11

name of the flow run.


The format is input_<inputName>=<inputValue> and runName=<runNameValue>. These values should come
after the ? and concatenate with &.
For example:
http://<hos_name>:<port>/oo/trigger.html#7a1fc3c7-1c5b-4868-a1c7-2932d878897e?input_host=someHost&inp
ut_username=someUsername
Track a flow in an embedded Drill Down view
The embedded drill down view lets you track and interact with a running flow.

To track a flow in an embedded Drill Down view, use the following URL:
http://<hos_name>:<port>/oo/drilldown-ex.html#<run_id>
Identify the flow to track via the <run_id>. You can find it in the flow's Run Link section in the Flow Library.

Related topics
To set up using LWSSO, see Set up security using LWSSO.
To set up security using SAML authentication, see Set up security using SAML authentication.
To troubleshoot RPA Central, see Troubleshooting RPA Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 855
Robotic Process Automation 2019.11

Use RPA Self-Service X


The Robotic Process Automation (RPA) Self-Service X is a web-based end-user interface that brings a new way to
organize and run RPA workflows. It lets the users to search for process scenarios that are published for production
use and execute them with just a few clicks and inputs (as required by the process).
RPA Self-Service X works only when connected to RPA Central and simplifies the usage of the deployed RPA
workflows both for administrators and end users.
An Administrator can choose what information is relevant to end-users and expose only specific data.
The End Users will be able to submit and monitor their own activity.

RPA Self-Service X concepts


Category: Contains a list of associated RPA Scenarios for easier identification, search, and to execute the
scenarios.
Scenario: A wrapper over an RPA Workflow that contains either predefined inputs or customized inputs and
outputs for the end-user submission.
Activity: Contains a list of user-triggered scenarios and their respective status.
For more information on how to use RPA Self-Service X, click each of the following topics.

Access Self-Service X
Manage Self-Service X
Run Self-Service X scenarios

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 856
Robotic Process Automation 2019.11

Access RPA Self-Service X

Log on
1. Enter the following URL into your browser address bar to launch RPA Self-Service X:

https://<fqdn>:8446/oo-ssx

You can access the application using a supported web browser, from any computer with a network
connection (intranet or Internet) to the servers. We recommend that you restore your browser to the
default settings.
2. Log on to RPA Self-Service X with the admin user from RPA Central. Use the password you set during RPA
Self-Service X installation configuration. Using an admin user will grant you access to the RPA Self-Service X
management interface.

You can use any existing user in RPA Central to log on into the RPA Self-Service X, but their access to view
and execute the scenarios will be restricted based on their assigned roles in RPA Central. The activity view is
limited only to the executions of the logged in user.

Any user has a session timeout, configured by default, to 30 minutes. When a user is logging in, the RPA Self-
Service X will initiate a communication with the RPA Central on their behalf to retrieve any relevant
information. The session refreshing time between RPA Self-Service X and RPA Central is set to 15 minutes.

Log out
To log out of RPA Self-Service X, follow these steps:

1. Click the [User Name] button the top right corner of the application and select Logout.

2. The application closes, and the LOGON screen is displayed.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 857
Robotic Process Automation 2019.11

Manage RPA Self-Service X


You can manage scenarios from the Self-Service X UI. If you need to also manage categories, use the Swagger API
instead. To manage categories/scenarios, make sure at least one of your user roles in RPA Central has the
manageCategory/manageScenario.​

Create category
To create a category, complete the following steps:

1. Log on to RPA Self-Service X as an admin user.

2. Click the [User Name] button at the top right corner of the application and select Management.

3. On the Categories tab, click the icon.

4. Provide a Name and Description for the category.

5. Click the down arrow on the default icon and customize the icon and color of the category, if required.

6. Click the Add button.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 858
Robotic Process Automation 2019.11

The name of the new category is automatically converted to uppercase when you create a category. This may
result in an error in certain languages by displaying extra characters such as ß -> SS.​

View category
The Self-Service X categories are containers of all the associated scenarios or workflows to easily search and
trigger as required.
The following example image is a main page after you log in to RPA Sellf-Service X. It displays the available
Categories such as, MATH and STRING.

Delete category
To delete a category, complete the following steps:

1. Log on to RPA Self-Service X as an admin user.

2. Click the [User Name] button at the top right corner of the application and select Management.

3. On the Categories tab, click and select a category you want to delete. The delete icon is activated.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 859
Robotic Process Automation 2019.11

4. Click YES to confirm and NO to cancel.

Create scenario
To create a scenario, complete the following steps;

1. Log on to RPA Self-Service X as an admin user.

2. Click the [User Name] button at the top right corner of the application and select Management.

3. On the Scenarios tab, click the icon. The project tree of the default content pack from the associated
RPA Central is displayed.

4. Customize your scenario using the steps listed below. To move between steps, use Back and Next buttons,
or click the desired step number.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 860
Robotic Process Automation 2019.11

Step Description

1. Select From the listed workflows, select the workflow you want to associate with this scenario.
Workflow You can limit/filter the search results using keywords in the Search workflow... text box.
The details of the selected workflow will be displayed under Workflow Details. If you do
not select a workflow but click NEXT, the color of the Select Workflow tab changes to red
to indicate an error, "Flow selection is required in order to add scenarios."

2. Details Name: Name of the scenario. Displayed automatically based on the selected workflow.
You can change it, if required.
Description: Provide a brief description of the scenario.
Category: Select the category to which you want to associate this scenario.
Timeout: Specify the duration (in minutes) by which the scenario must time out once the
execution starts.
Permissions: Add/remove the roles of users who can access this scenario. The current
roles associated with RPA Central is displayed. Click the down arrow button to select the
roles you want to access this scenario.

3. Inputs Name: Name of the input parameter configured in the workflow. Displayed automatically.
You can change it, if required.
Value: Specify a value for the input parameter.
Required: Use this field to make this input parameter mandatory/optional. If a parameter
is marked as mandatory in the selected workflow, you cannot make it optional.
Expose: Use this field to make this input parameter visible (exposed) or invisible to the
users. If a parameter is allowed to be exposed to users in the selected workflow, you
cannot hide it.
Type: Parameter type. Displayed by default. You can change it, if required.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 861
Robotic Process Automation 2019.11

Step Description

4. Outputs Name: Output parameter as configured in the selected workflow. Displayed by default.
You can change it, if required.
Expose: Use this field to make this output parameter visible (exposed) or invisible to the
users. If a parameter is allowed to be exposed to users in the selected workflow, you
cannot hide it.

5. Review Displays the details provided under each step above, so that you can review the same
before saving the scenario.

5. Click the Submit button to save the scenario.

You will encounter an error when creating scenarios using API, if the IDM Central roles are not displayed
correctly in RPA Central User Interface.

View available scenarios


To view all the available scenarios on RPA Self-Service X portal:

1. Click the [User Name] button at the top right corner of the application and select Management. The
following information is displayed for all the available scenarios:

ID NAME CATEGORY FLOW PATH DESCRIPTION

Unique ID of a Name of a Name of the category Path of a Description of a


scenario or scenario or to which a scenario is scenario in a scenario
category Category assigned project

Edit a scenario
To edit the configuration of an existing scenario:

1. On the RPA Self-Service X Home page, click on your username at the top right-hand corner and select
Management.

2. Click on the SCENARIOS tab and select the scenario that you want to edit. You can edit the selected scenario
in one of the following ways:

Quick Edit mode: click on the name, category or description of the selected scenario to quickly update
these details directly from the List view.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 862
Robotic Process Automation 2019.11

Full Edit mode: click on the Edit icon to open the Edit Scenario wizard where you can access the
full scenario definition. Update the required details and click Submit on the last page to save your
changes and close the Edit Scenario wizard.

Search available scenarios


To search through the available scenario or category:

1. Log in to RPA Self-Service X.

2. Click the [User Name] button at the top right corner of the application and select Management.

3. Click the Search by name text box, and enter the name of a scenario or category. Relevant results are
displayed.

Delete a scenario
To delete a scenario:

1. Click and select a Scenario from the list of available Scenarios.

2. Click the active delete icon . A DELETE SCENARIO prompt window is displayed.

3. Click Yes to delete the scenario or choose No to cancel.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 863
Robotic Process Automation 2019.11

Run Self-Service X scenarios


In RPA Self-Service X portal, all RPA flows are available for reuse in an easy to find self-service catalog that lets you
search for process workflows that are published by authors for production use and execute them with just a few
clicks and inputs (as required by the process).

View a scenario
To view Scenarios and its associated Category:

Click on the Category box. A list of available scenarios associated with it are displayed.
The following example image lists the scenario SUM under MATH category.

Search for a scenario


To search a Scenario and its associated Category:

Click inside the Search box and then type in the search string.

A list of available Scenarios and their associated Category is displayed.


The following image lists the scenarios for a search string "SAP" with Create SAP User, Delete SAP
User as results and their assigned category SAP.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 864
Robotic Process Automation 2019.11

Run Self-Service X scenarios


To run a scenario:

1. Click a required Scenario.

2. Enter an appropriate Trigger name and complete required inputs.

3. Click Submit.

A notification pop-up appears at the top-right corner for a few seconds to indicate successful trigger
of a scenario.

The number of unread notifications are indicated on the notification icon .


4. Click Notification icon to view a list of successful triggers and your activities

5. Click VIEW YOUR ACTIVITY to view the the list of IN PROGRESS and DONE activities.

The activities are bound to the specific username configured in RPA Central. If you make changes to
credentials, your past activities will not be displayed.

6. Click IN PROGRESS and DONE tabs to view the list of activities.

To abort the ongoing activity, Select IN PROGRESS tab and then click CANCEL. The current activity is
stopped.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 865
Robotic Process Automation 2019.11

Icon Result

indicates success of a triggered scenario

indicates failure of a triggered scenario

indicates cancellation of a triggered scenario

Each of the triggered scenarios are displayed with their unique Execution id with embedded link to your
RPA Central. You can click the link to explore the details of the scenario in your RPA Central.

View Activity status in RPA Central

To explore the triggered scenario in RPA Central, click the Execution id hyperlink. If prompted with the RPA
Central login dialog-box, provide your RPA Central username and password, and then click Ok. (you will not be
prompted if the RPA Central is installed in IdM mode). A separate browser opens displaying the activity status.

Related topics
For troubleshooting issues of RPA Self-Service X, see Troubleshoot RPA Self-Service X

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 866
Robotic Process Automation 2019.11

Troubleshoot
This section helps you identify and resolve some of the issues that you might come across while using Robotic
Process Automation (RPA).
Navigate through following topics to get accustomed with the range of problems and solutions, which may be
useful for troubleshooting the processes of installing RPA and working with RPA Central, RPA Workflow Designer,
RPA Self-Service X and RPA Robot.

Troubleshoot RPA Central


Troubleshoot RPA Workflow Designer
Troubleshoot RPA Recorder
Troubleshoot RPA Self-Service X
Troubleshoot RPA RAS
Troubleshoot RPA Robot

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 867
Robotic Process Automation 2019.11

Troubleshoot RPA Workflow Designer


This section helps you identify and resolve some of the issues that you might come across while using RPA
Workflow Designer.
This section covers the following issues:

Run button is disabled


Password issue when creating an SAP user
Password issue when creating an SAP user

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 868
Robotic Process Automation 2019.11

Error when accessing RPA Workflow Designer on


Oracle Linux
500 internal server error when accessing RPA Workflow Designer installed on Oracle Linux with IDM Create mode.

Cause
It could happen because of IP address mapping instead of hostname of the machine where RPA is installed.

Solution
If you had changed your RPA Workflow Designer’s keystore password, then you must use the updated password in
the below commands instead of changeit.

1. Open a command prompt and enter the following command to backup RPA Workflow Designer's keystore

mv <designer_install_directory>/designer/var/security/key.store
<designer_install_directory>/designer/var/security/key.store.old

2. Generate a new keystore for RPA Workflow Designer that has the server’s FQDN in the Common Name (CN)
attribute, and both the FQDN and the IP address in the Subject Alternative Names (SAN) attribute:

keytool -genkey -noprompt -keyalg RSA -alias tomcat -keystore


<designer_install_directory>/designer/var/security/key.store -storepass changeit -dname
"CN=<''input_server_hostname_here''>" \ –ext
san="dns:''input_server_hostname_here'',ip: =''input_server_IP_address_here''" -keypass
changeit -keysize 2048 -storetype JKS

3. Add the new key to RPA Workflow Designer client.truststore:

Export Certificate from new key.store

keytool -export -alias tomcat -keystore

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 869
Robotic Process Automation 2019.11

<designer_install_directory>/designer/var/security/key.store -rfc -file


<designer_install_directory>/designer/var/security/oodesigner.crt -storepass changeit

Add it to client.truststore.

keytool -importcert -file <designer_install_directory>/designer/var/security/oodesigner.crt


-keystore client.truststore -alias tomcat -storepass changeit -noprompt

4. Using a text any editor, open the designer-wrapper file located at


<designer_install_directory>/designer/conf/designer-wrapper.conf

5. Edit to replace the IP address in the -Dmgmt.url java parameter with the server's FQDN.

Example: From wrapper.java.additional.30=-Dmgmt.url=https://12.34.56.78:8446/oo-designer

To wrapper.java.additional.30=-Dmgmt.url=https://my.server.fqdn:8446/oo-designer

6. Enter the following command to restart the RPA Workflow Designer service:

<designer_install_directory>/designer/bin/./designer restart

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 870
Robotic Process Automation 2019.11

Run button is disabled


The Run button is disabled after remote debugging from RPA Workflow Designer.

Cause
It may happen that after you have remotely debugged a hybrid flow from Designer, if you minimize the Debug tab
and then expand it again, the Run button is disabled although the RPA Central URL and credentials are filled in.

Solution
Edit any of the text boxes for the Run button to become active again.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 871
Robotic Process Automation 2019.11

Password issue when creating a new SAP user


using RPA Workflow Designer
When recording a SAP scenario to create a new user, the password input is marked in asterisks (******).

Cause
This is due to the reuse of the recorded activity of creating a SAP user.

Solution
Change this to actual password in RPA Workflow Designer.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 872
Robotic Process Automation 2019.11

Troubleshoot RPA Recorder


This section helps you identify and resolve some of the issues that you might come across while using RPA
Recorder.
This section covers the following issues:

A different RPA Workflow Designer user cannot initiate recording


Recorder does not capture screen events
Unable to configure UFT

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 873
Robotic Process Automation 2019.11

A different RPA Workflow Designer user cannot


initiate recording
When the different user opens the activity dialog and populates the fields and presses OK, a dialog prompt Failed
to save the test or business component. is displayed.

Cause
This is an error from UFT that basically says that UFT could not save the new uses recorded activity by over-riding
the current users temp folder that was created on using Recorder.

Solution
Try the following solutions one by one.

Solution 1

1. Navigate to <recorder_install_dir>/recorder/conf/recorder-wrapper.conf and using any text editor


open the file.

2. Change the -Dusr.temp property to a desired location with enough permissions for the users that need to
trigger the Recorder.

Solution 2

1. Navigate to the user who installed Recorder's temp folder, search for "RPA Recordings"

2. Right click the RPA Recordings and navigate to Properties>Security and then manually grant permissions
for the other user(s) that need to trigger the Recorder.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 874
Robotic Process Automation 2019.11

Recorder does not capture screen events


RPA Recorder is not capturing screen events.

Cause
This issue occurs because the Recorder browser extension has not been installed after RPA installation.

Solution
Download and install the Recorder extension from the following locations:

Firefox - Manually add the Recorder browser extension from this location: Recorder <install
location>/uft/Installations (add WebExtension.xpi).
Chrome - Go to
https://chrome.google.com/webstore/detail/micro-focus-functional-te/hkheagicnendeidmgfnaaocibkmiibbo and
add it from the store.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 875
Robotic Process Automation 2019.11

Unable to configure UFT


The following error is displayed Unable to configure UFT

Cause
Possible causes:

Cause 1: The user might not have the permission to install at the given location.
Cause 2: Another process might prevent the installation.

Solution
1. Navigate to Control Panel>Programs>Program and Features and choose Uninstall a program.

2. Search for Micro Focus Unified Functional Testing application.

3. Right-click and choose Uninstall. The UFT is manually removed.

4. Restart the installation process.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 876
Robotic Process Automation 2019.11

Troubleshoot RPA Central


This section helps you identify and resolve some of the issues that you might come across while using RPA Central.
This section covers the following issues:

Special characters are not displayed correctly in the *.csv file


SSL handshake error
Plugins are not deleted
Slower execution of flows
Low resolution on Firefox
Deploying content packs takes longer time
Locked out of RPA Central
Remote host supports RC4 cipher
Mapping group alias and worker group do not work
Default algorithm is unsafe
Content deployment does not end
Scheduled runs have inconsistent times
RPA help links are not working
Some buttons are not visible
Problems with new worker registration or existing worker functionality
Steps appear scrambled in the Tree View and Table View
Exception occurred during deployment
Service unavailable
Exception occurs during content pack deployment with a duplicated UUID
During deployment, the file name becomes corrupted
No permission to perform an action
Unexpected error status
Unable to log on to RPA
Internal server error
Unable to trigger a flow
Out of memory error - Metaspace
RPA crashes when running a content

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 877
Robotic Process Automation 2019.11

Special characters are not displayed correctly in


the .csv file
Special characters are not displayed correctly in the *.csv file when you export the Run Log to a CSV file.

Cause
This issue occurs because the problem is in the Excel CSV encoding.

Solution
Try the following solutions one by one.

Solution 1

Make sure you are working with the correct configuration in RPA and in the database.

Solution 2

Change the encoding as explained here:


http://superuser.com/questions/280603/how-to-set-character-encoding-when-opening-excel.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 878
Robotic Process Automation 2019.11

SSL handshake error


SSL handshake error occurs when running flows that make HTTP requests.

Cause
This issue occurs because later versions of the product use a java distribution that has SNI support enabled by
default. Certain mis-configured servers may send an Unrecognized Name warning in the SSL handshake which Java
treats as an exception.

Solution
Apply the following java settings in the wrapper.conf file and restart the RPA Central service.

wrapper.java.additional.32=-Djsse.enableSNIExtension=false

If the environment contains RASes, you need to add the setting to ras-wraper.conf file and restart the RAS service,
for all available RASes.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 879
Robotic Process Automation 2019.11

Plugins are not deleted


Content pack plugins are not deleted from RPA Central cache

Cause
This issue occurs when you delete a content pack that contains a plugin, the plugin is not deleted from the RPA
Central cache. If you redeploy an artifact with the same version of the plugin, it does not overwrite the old one.

Solution
The administrator should manually clean up the cache, so that only the required libraries will be downloaded.
When the RPA Central and RASes are down, delete the var/cache folder.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 880
Robotic Process Automation 2019.11

Slower execution of flows


Execution of flows is slower, and it looks as if, over time, the run duration is getting longer.

Solution
Try the following solutions one by one.

Solution 1

Make sure the root cause of the bottleneck is not database-related. Monitor the database resource usage (CPU,
memory, IO, storage, network).

Solution 2

Increase the number of worker threads if your hardware can take it.

Solution 3

Increase the number of database connections.

Solution 4

Scale out.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 881
Robotic Process Automation 2019.11

Low resolution on Firefox


Low resolution on Firefox.

Cause
This issue occurs because Firefox on Windows uses the desktop configuration for font size. In some cases, the
desktop is configured to use 125% font size as default, when using low resolution this may result in some layout
problems in RPA Central.

Solution
Reduce the zoom to 100%.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 882
Robotic Process Automation 2019.11

Deploying content packs takes longer time


Deploying content packs take a long time and the following message is displayed: out of memory

Cause
This issue occurs because there is insufficient memory allocated for RPA Central.

Solution
Increase the memory for RPA Central by changing the configuration of the central-wrapper.conf file.
Example:

# Initial Java Heap Size (in MB) wrapper.java.initmemory=1024 # Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=2048

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 883
Robotic Process Automation 2019.11

Locked out of RPA Central

Symptom
Locked out of RPA Central when there is SAML authentication.

Solution
Log in to RPA directly. To do so, go to: http(s)/<host>:<port>/oo/login/direct.
In addition, ensure that you have not deleted the admin user. If you are using LDAP, you must set a default LDAP
configuration.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 884
Robotic Process Automation 2019.11

Remote host supports RC4 cipher increasing


security risk
The remote host supports the use of the RC4 cipher.

Cause
The RC4 cipher on the JRE level might not have been disabled. This cipher is flawed in its generation of a pseudo-
random stream of bytes as a wide variety of small biases are introduced into the stream thereby decreasing its
randomness. For example, if the user repeatedly encrypts plain text (for example, HTTP cookies) and an attacker is
able to obtain many (i.e., tens of millions of) cipher texts then the attacker may be able to derive the plain text.

Solution
1. Open the $JRE_HOME/lib/security/java.security file.

2. Edit the jdk.tls.disabledAlgorithms property to disable the RC4 cipher.

For more information, see http://stackoverflow.com/questions/18589761/restict-cipher-suites-on-jre-level.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 885
Robotic Process Automation 2019.11

Mapping group alias and worker group do not


work
Mapping group alias and worker group do not work.

Cause
For a flow that has already started running on RPA Central, if it requires a group alias that does not have a worker
group mapped, the mapping during the run will not work. Unless the worker group name is identical to the group
alias. The flow will remain in a Paused_No_Workers_in_Group state and resuming the run will not work either.
For example, you have a step that needs to run on group alias Alias_A, and there is no mapping of workers to this
alias. RPA tries to run the step on group alias Alias_A, but since there are no workers in Alias_A, the execution is
paused. When the administrator maps group alias Alias_A to the worker group Group_D and tries to resume the
run, it does not work.

Solution
From the Topology > Workers tab, assign a worker to a worker group with exactly the same name as the group
alias required by the flow. Then, resume the flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 886
Robotic Process Automation 2019.11

Default algorithm is unsafe


Default DRBG algorithm ECDRBG128 is not safe, according to NIST.

Cause
The security property is not set.

Solution
Set the security property com.rsa.crypto.default to HMACDRBG by adding the following line in the
<oo_jre>\lib\security\java.security file:

com.rsa.crypto.default.random = HMACDRBG

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 887
Robotic Process Automation 2019.11

Content deployment does not end


In some cases, the content deployment does not end or does not appear to end.

Cause
This may be caused by the anti-virus blocking the browser read actions.

Solution
Check the CPU consumption of the anti-virus process at the time of deployment, or check the anti-virus log file. If
required, contact your server system administrator to discuss possible solutions.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 888
Robotic Process Automation 2019.11

Scheduled runs have inconsistent times


Scheduled runs have inconsistent start times in flows and steps.

Cause
This issue occurs when a flow is run via the Scheduler and RPA Central, RPA RAS, and RPA Central client (browser)
are in different time zones. For example, the start time in the flow will be different from the start time in the step.

Solution
Change the time zone on the RPA RAS to be the same as the time zone on RPA Central.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 889
Robotic Process Automation 2019.11

RPA help links are not working


The RPA help links do not work through the Load Balancer.

Cause
This issue occurs because the Load Balancer may not be configured correctly.

Solution
Make sure that the Load Balancer is configured correctly. You need to add to the Load Balancer all suffixes that are
different from /oo.

Note For Apache httpd, it is sufficient to make sure that the balancer members'
URLs are just http://central_host:central_port/.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 890
Robotic Process Automation 2019.11

Some buttons are not visible


Some of the buttons on the UI are not visible.

Cause
This issue occurs because of low screen resolution.

Solution
Increase the screen resolution to 1280 x 1024 or 1920 x 1080.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 891
Robotic Process Automation 2019.11

Problems with new worker registration or existing


worker functionality
Problems with new worker registration or existing worker functionality.

Cause
The cause of this issue could be the compression set on the load balancer configuration. This can affect the
connection between RPA Central and workers and can lead to problems in new worker registration or existing
worker functionality.

Solution
Remove the compression.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 892
Robotic Process Automation 2019.11

Steps appear scrambled in the Tree View and


Table View
Steps appear scrambled in the Tree View and Table View, as well as in the Run Report, despite executing in correct
order.

Cause
The RPA environments installed with Oracle database and specific language settings on the database, one might
experience scrambled display in the execution of steps for some flows (with more than 4 steps). Thus, in Run
Explorer: in the Tree View and Table view, as well as in the Run Report saved, the steps are not displayed in
correct order, even though they are executed in correct chronological order.

Solution
1. Check if the Oracle environment parameter NLS_SORT is set up for a linguistic definition ( French, German,
etc) as follows:
Select sys_context(‘USERENV’, ‘NLS_SORT’) from dual;

2. If yes, set it to ‘BINARY’ on the database.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 893
Robotic Process Automation 2019.11

Exception occurred during deployment


The following exception error message is displayed during deployment. An exception occurred during deployment.
Check the server log for more details

Cause
This error message may appear in a number of different situations, leading to an exception during deployment.
This includes conflicts between two deployed configuration items with the same type and path.

Solution
Check the server log to see the details of the exception. In the case of a configuration item path conflict, check the
general.log file for the most detailed information.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 894
Robotic Process Automation 2019.11

Service unavailable
While using RPA Central, the following error message appears: Service unavailable. The server may be down, too
busy, or experiencing network problems. Check the server log for the deployment status.

Cause
This error message appears when the server is either too busy to handle the request or is down for maintenance,
or when some network error has prevented the response from arriving to the client.

Solution
Check the server log to see if the deployment didn’t start or end successfully, or failed.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 895
Robotic Process Automation 2019.11

Exception occurs during content pack


deployment with a duplicated UUID
The following error message appears during content pack deployment with a duplicated UUID.
A ‘<flow or operation/type of configuration item>’ with a duplicated UUID: <uuid> is being deployed. This UUID
already exists in a ‘<flow or operation/type of configuration item>’in the content pack ‘<name of content pack>’.

Cause
This issue occurs when you are trying to deploy a content pack with a flow, operation, or configuration item that
has the same UUID as an item in another content pack that is deployed in the deployment unit.

Solution
1. In RPA Workflow Designer, search for the flow, operation, or configuration item with the given UUID.

2. Copy the flow, operation, or configuration item into the same project.

3. Delete the original copy of the flow, operation, or configuration item, from the same project.

4. Select Create content pack, and redeploy the content pack.

Note Do not edit the contents of the content pack manually.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 896
Robotic Process Automation 2019.11

During deployment, the file name becomes


corrupted
During deployment, the file name gets corrupted and the following message is displayed: During deployment the
file name became corrupted. Please try to redeploy.

XUAW
In some cases, the file name arrives in a corrupt state, and causes an exception.

Solution
Deploy again.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 897
Robotic Process Automation 2019.11

No permission to perform an action


The following error message appears while performing an action.
You do not have permission to perform this action

Cause
This issue occurs when you are logged in as a user that does not have permission to perform the action.

Solution
Log in as a user with the appropriate permission. Alternatively, ask the administrator to give you the permission to
perform the action.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 898
Robotic Process Automation 2019.11

Unexpected error status


The following error message is displayed: An error has occurred. Check the server log for more details.

Cause
This issue occurs when there is an unexpected error status from the server, but no error status text was received.

Solution
Check the server logs to see if there was an exception.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 899
Robotic Process Automation 2019.11

Unable to log on to RPA


After a few attempts to log on, the server does not start and the following error message appears: liquibase:
Waiting for changelog lock

Cause
The changelog lock of the database is missing the correct setting value.

Solution
In the DATABASECHANGELOGLOCK table, set the value of the LOCKED column to 0.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 900
Robotic Process Automation 2019.11

Internal server error


An internal server error appears with the following message:
<server response status (for example, Internal Server Error)>. Check the server log for more details

Cause
This error message appears when there is an unexpected error status from the server (for example, “Out of
memory”).

Solution
Check the server logs to see if there was an exception.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 901
Robotic Process Automation 2019.11

Unable to trigger a flow


When triggering a flow from RPA Central, an issue occurs and the following error message appears:
There was a problem launching the flow. See the logs for details.

Cause
A worker from a default group might not have been assigned.

Solution
Check if the default group RAS_Operator_Path is assigned to any worker.
Some phases of a run always run on the default group, which is RAS_Operator_Path. Make sure that at least one
worker is assigned to this group.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 902
Robotic Process Automation 2019.11

Out of memory error - Metaspace


RPA Central/RPA RAS fails with the following error in the wrapper log: java.lang.OutOfMemoryError:
Metaspace

Cause
Less size is assigned to the Metaspace.

Solution
Increase the size of the Metaspace. This can be found in the in the central-wrapper.conf (or ras-wrapper.conf)
file, in the following parameter:

-XX:MaxMetaspaceSize=<new defined size>

Note Metaspace consumes native memory on the server. If it exhausts all


available physical memory and starts using swap space, the performance of RPA
will degrade significantly.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 903
Robotic Process Automation 2019.11

RPA crashes when running a content


RPA Central/RPA RAS crashes with an OutOfMemory (OOM) exception when running a content.

Cause
Less heap size is configured.

Solution

Solution 1

Increase the heap size for RPA Central/RPA RAS.

Solution 2

Check if the content you ran can be changed so that its context will be smaller.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 904
Robotic Process Automation 2019.11

Scheduler password expires


This page is still under development. No published version is available at this time

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 905
Robotic Process Automation 2019.11

Troubleshoot RPA RAS


This section helps you identify and resolve some of the issues that you might come across while using RPA RAS.
This section covers the following issue:

Log files are not generated in Windows

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 906
Robotic Process Automation 2019.11

Log files are not generated in Windows


RPA RAS is not generating log files in Windows.

Cause
This issue occurs because when installing a RAS on Windows, sometimes in the var/logs folder only the
wrapper.log file is generated. Inside the wrapper.log file, you can find a message similar to "Failed to init logger:
unknown protocol: c", wherein the C protocol is the drive letter of the disk in which the RPA RAS is installed.

Solution
1. Edit the ras-wrapper.conf file at the location: ras\conf folder.

2. Change the line

wrapper.java.additional.3=-Dlog4j.configuration="%RAS_HOME%/conf/log4j.properties"

to

wrapper.java.additional.3=-Dlog4j.configuration="file:///%RAS_HOME%/conf/log4j.properties"

4. Restart of the RPA RAS service for the change to take effect.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 907
Robotic Process Automation 2019.11

Troubleshoot RPA Robot


This section helps you identify and resolve some of the issues that you might come across while using RPA Robot.
This section covers the following issue:

Robot executes RPA activities only when the RDP session is active

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 908
Robotic Process Automation 2019.11

Robot executes RPA activities only when the RDP


session is active
Robot running on Remote Desktop Protocol (RDP) session does not execute RPA activities.

Cause
The Remote Desktop Protocol (RDP) session that runs Robot is not active.

Solution

Configure Robot for remote connections

1. Navigate to Robot installation folder <RPA Robot installation path>uft/ and open UFT. You can access it
directly on the computer where it is installed, or connect to that computer using a remote desktop client,
such as Windows Remote Desktop Connection.

2. In the Options dialog box, open the Run Sessions pane (Tools > Options > General tab
> Run Sessions node).

3. Select Enable testing on locked/disconnected remote computers and save your changes.

4. Enter the credentials to use for the remote session. These might be the same credentials you use to access
the remote computer. Scroll down and click Check Connection to verify that it works.

UFT uses these credentials which in turn is used by Robot in the following situations:

You were connected and running RPA when the screen locked or you closed the session.
When you disconnect from the UFT machine or restart it, a Windows session is automatically started, using these
credentials to log in. This enables other programs to run UFT remotely without anyone manually logging in to the
machine.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 909
Robotic Process Automation 2019.11

Troubleshoot RPA Self-Service X


This section helps you identify and resolve some of the issues that you might come across while using RPA Self-
Service X.
This section covers the following issue:

Activities display unknown state


Activities are refreshed once every 15 seconds
Unable to use Self-Service X after password change

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 910
Robotic Process Automation 2019.11

Activities display unknown state


Integration username and password is updated or deleted in RPA Central shows the activities in unknown state in
RPA Self-Service X user interface.

Cause
The activities, including the previous runs, triggered on RPA Self-Service X portal might display Unknown state
after you have changed the integration username and password details in RPA Central.

Solution
If the integration user details were changed or updated in RPA Central, the properties related to the integration
user central.username and central.password must be updated in RPA Self-Service X central properties file at :
Micro Focus\Self-Service X\ssx\conf\central.properties.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 911
Robotic Process Automation 2019.11

Activities are refreshed once every 15 seconds


Activities are refreshed once every 15 seconds.​

Cause
This is due to the missing customization to control refresh rate that is set for every 15 seconds.

Solution
Control refresh rate by editing ssx-wrapper.conf file and adding a new java property: central.polling.delay.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 912
Robotic Process Automation 2019.11

Unable to use Self-Service X after password


change
Unable to use Self-Service X after the admin user password change.

Cause
This issue occurs if you change the password of the RPA Central Admin user that you had used during the Self-
Service X installation.

Solution
Update the password in the central.properties file available under Self-Service installation path,

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 913
Robotic Process Automation 2019.11

Develop
Robotic Process Automation (RPA) activities produced by the Recorder can be used with either AFL or CloudSlang
operations to create new hybrid flows that are executed inside the RPA Flow Execution Engine. This section
provides information to:

Use RPA APIs and Self-Service X APIs


Develop CloudSlang content for the Robotic Process Automation platform
Navigate through the following topics for more information.

RPA APIs
Self-Service X APIs
CloudSlang content documentation

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 914
Robotic Process Automation 2019.11

RPA REST APIs


This section provides information about all the RPA Application Programming Interfaces (APIs) that you can use.

Public RPA APIs


The public RPA APIs are HTTP-based. All APIs are RESTful and use JavaScript Object Notation (JSON).

Versions and headers

The version should be specified as a prefix to all REST calls (for example, /oo/rest/v2/executions).
New RPA releases may introduce new optional fields to returned representations that are not considered as an API
break.
Therefore, the client should be tolerant to new attributes when deserializing JSONs. For example, when performing
a GET operation on /test, the following is returned:

{ "msg" : "hello world" }

We may add a new attribute in the next version and then the GET on /test will return the following, in this case the
client should not break:

{ "msg" : "hello world", }

Request headers

The "Content-Type" and "Accept" headers are usually added for every request.
The "Content-Type" represents the MIME (RFC2045) type of the request body. It is usually "application/json", unless
stated otherwise for a specific API.
The "Accept" header represents the requested format of the response from the Central server. It is also usually
"application/json", unless mentioned differently.

Sample use case - Integration


This section describes a common usage of the RPA APIs to demonstrate its capabilities. The use case below is only
one example for RPA platform integration; however, the APIs allow more capabilities.

Use case description

For example, to remediate an incident, doing routine tasks like reset password for a user or creating a DB schema
in Development environment can be automated through RPA.
The following implementation is a suggestion and can be adopted at any level you see fit.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 915
Robotic Process Automation 2019.11

Use case implementation

The integration includes two separate processes. They are described from the user perspective, but also describe
the work to be done by the integration developer.

Admin process - Select flows to expose to users

Process description

Before the user of the Organizational Portal or Application is able to invoke flows from it, the Administrator must
determine the below two items:

1. Which flows are to be exposed to the users.

2. Determine for each user what data sources he needs to access and assign them to flow inputs.

The Administrators experience is:

Process implementation

This process, if used as described, requires UI development on the custom portal/application side in order to allow
the Admin user to browse the library and select a flow.
For example:

Drop down selection box that lists all the flows in a specific folder in the library (means that the path will need to
be decided in advance).
A folders tree graphical window.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 916
Robotic Process Automation 2019.11

Another option (less usability for the Admin user) is a basic UI that will allow him to manually insert the flow UUID
and input parameters value sources.
The following table describes how the implementation of the interactions with RPA Central server look like.

Step Admin Action Integrator Actions (interaction with RPA)

Browse RPA Browse the content library from the Lists the folders and flows under a given path while
Library portal/application. the root of the path is the Content Library (which is
‘Library/’). In this example, if the organizational portal
team decides to implement in the UI the full library
tree display (as shown in the image above), the
integrator code is required to be recursive. That is, a
REST call will be implemented for every branch that
the end user clicks.
Looking at the example in the image above, the first
REST call was to list the top level libraries, then when
the user clicked on ‘Accelerator Packs’ a REST call was
submitted to list the levels below it, and so on.

Select Flow Select flows to invoke in order to Get the selected flow details like UUID, Inputs,
make them available in the Description, etc. The details that will be collected
portal/application and also define depend on what information was decided to display to
where. the Admin in the UI. For invoking, the information
needed is UUID and inputs information.

Assign flow Bind value sources to the flow inputs. Provide the capability for this in the portal/application.
inputs values The sources will most likely be Note: A validation will need to be implemented to
sources dynamic objects from the application make sure the Admin will provide value source to each
data (like internal variable, called of the flow inputs that are marked as Prompt User.
SelectedItemHostname) and not Otherwise the flow will pause and will wait for inputs,
static values. for example, RPA Admin will need to login to RPA
Central and enter them.

Store data in Store all the information in the Save the relevant data to the portal/application (in its
Portal/App Portal/Application. DB/Forms/Files/etc.)

The flow UUID, inputs and their value source must be kept on the
Portal/Application side for the flow invocation.

End user process - Invoking and monitoring workflows

Process description

This process occurs in the organizational portal or the third party applications, on the area that is exposed to the
end user. The best practice is to have one place that holds the functionality, like an internal service, so the other
areas of the application that allow users to trigger flows calls it over and over.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 917
Robotic Process Automation 2019.11

Process implementation

The following table describes how the implementation of the interactions with RPA Central server looks like. The
interaction is done through the RPA REST API.

Integrator
Actions
End User (interaction
Step Action with RPA) API to use

Select From the Collect the Get Flow Details and Get Flow Inputs.
flow portal/application, information to
to run. the end user will be used later
select the flow to for invoking
invoke from a the flow. This
predefined list or includes UUID
just click on a of the flow
button that the selected and
admin made input
available. parameters
designated
values.

Invoke The workflow will Use the REST Execute a Flow By UUID API. It is also recommended to use the runName invocation
the be invoked while API to invoke parameters in order to allow better troubleshooting later on. A suggested format for
flow the the flow. Use the runName can be:
portal/application the UUID and <InvokingAppName>:<InvokingUserName>:<TargetSystemName>:<ActionName>
will feed it with the flow input
the needed input parameters
values. names and
values.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 918
Robotic Process Automation 2019.11

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 919
Robotic Process Automation 2019.11

Basic authentication
When user authentication is on, the client must provide their credentials when calling the REST APIs. RPA Central
supports preemptive basic authentication.
The client should add a header with the following key/value:

Key: Authorization

Value: Basic ( base64 encoded username:password)


For example, the authorization value for admin:1234 is: Basic YWRtaW46MTIzNA==
On an unsuccessful authentication attempt, the service returns an HTTP 401 code.

Permissions
If the user does not have the assigned permission to activate an API, the following status code appears:

403 – Forbidden. The user attempting to execute this command does not have the needed permission.

This applies to all the API’s in the version.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 920
Robotic Process Automation 2019.11

CSRF protection in RPA


A CSRF (Cross-Site Request Forgery) attack is when a malicious web site, email, blog, instant message, or program
causes a user’s web browser to perform an unwanted action on a trusted site for which the user is currently
authenticated. The impact of a successful cross-site request forgery attack is limited to the capabilities exposed by
the vulnerable application.
In a fresh installation of RPA, or when you upgrade from an earlier version, CSRF protection is enabled by default.
For more information about CSRF protection, see
https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet#Disclosure_of_Tok
en_in_URL .

Add the CSRF token header


This section is only relevant for those working with a REST client that retains the session. You will need to provide
the CSRF token for all the POST/PUT/ DELETE requests.

1. The CSRF token can be obtained after one GET request on any valid RPA API.
However for the most light-weight call and for faster integration to RPA, we recommend you to do the
following call to obtain the CSRF token: HEAD /oo/rest/v2/l10n/available-languages
The CSRF token received from the first call is a valid one and can be used in further POST/PUT/DELETE calls.
The response headers contain fields such as:
X-CSRF-HEADER: X-CSRF-TOKEN
X-CSRF-PARAM: csrf
X-CSRF-TOKEN: 5a81b051-1a73-4b87-85ad-7c672803c65f

2. You can then take this token and put it as a Request Parameter in the POST call:
X-CSRF-TOKEN: 5a81b051-1a73-4b87-85ad-7c672803c65f

To demonstrate how the CSRF token can be obtained correctly, a sample flow is
created in the Micro Focus Solutions Content Pack (latest version), under :
Library/Integrations/Micro Focus/Operations Orchestration/10.x/Samples/Launch
flow with HTTP Cookies and CSRF token.

You can enable or disable CSRF protection by setting the csrf.protection.enabled system configuration item to true
or false. This can be done via REST API. To set this system configuration item, you must have Manage System
Settings permissions.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 921
Robotic Process Automation 2019.11

Dashboard
The Dashboard workspace reflects the system’s ROI, and analyzed flow aggregation. It provides statistical
information about the system (popular flows, result distribution, execution time, and so on) and financial
information about the return on investment. This API allows you to get the statistic information in order to generate
reports.

Get statistics
Request
GET /executions/statistics
Description
Returns a flows statistic info (list of FlowStatisticsDataVO): ROI, number of executions, average execution time and
result distribution.
Request parameters

Attribute Description Type Required

top Get top N results Integer No

measurements Which statistics to Predefined Value No


display. If nothing is set
then the four statistics
are displayed. The
following options are
available: roi,
numOfExecutions,
avgExecutionTime,
resultDistribution.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 922
Robotic Process Automation 2019.11

sortBy The following options are Predefined No


available: roi, Value
numOfExecutions,
avgExecutionTime
If nothing is set then:
• If the measurements
list is empty, then the
sort is set to
numOfExecutions.
• If the Measurements
are not empty, then
nothing is sorted. If
sortBy is set, then it
should be contained in
measurement (if
supplied).

sortDescending Default is descending. Boolean No

endedBefore Default is now. Long No

endedAfter Default is one week ago. Long No

Sample
GET /executions/statistics?sortBy=avgExecutionTime&endedBefore=1415176455471&top=3
Response status codes:

Code Meaning Returned When

200 OK Operation was successful

400 Bad • Wrong measurements value.


Request • Wrong sortByvalue. It must be
included in the measurements,
unless it's empty.
• Ended after > Ended Before

403 Forbidden The user does not have dashboard


read permission.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 923
Robotic Process Automation 2019.11

Flow execution
This section provides information about APIs that enable you to execute flows.

Get executions summary with pagination and filtering

Request

GET /executions

Description

Returns a paginated list of executions summary, with filtering. The returned objects include the execution
summary, detailed objects with data about the execution.

Request parameters

Attribute Type Description Required

pageNum Integer The number of the returned No


page.
Default value: 1

pageSize Integer The size of the returned page. No


Default value: 200

flowPath String Return runs that their flow path No


contains this string.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 924
Robotic Process Automation 2019.11

status Array of Predefined Return runs with the following No


Values statues.
Possible values:
RUNNING, COMPLETED,
COMPLETED_ RESOLVED,
COMPLETED_DIAGNOSED,
COMPLETED_ERROR,
COMPLETED_NO_ACTION_TAKEN,
COMPLETED_CUSTOM,
SYSTEM_FAILURE, PAUSED,
PENDING_PAUSE,
PENDING_CANCEL,
PAUSED_USER_PAUSED,
PAUSED_INPUT_REQUIRED,
PAUSED_
INPUT_REQUIRED_MANUAL_OP,
PAUSED_DISPLAY,
PAUSED_GATED_ TRANSITION,
PAUSED_HAND_OFF,
PAUSED_INTERRUPT,
PAUSED_NO_
WORKERS_IN_GROUP, PAUSED_
BRANCH_PAUSED, CANCELED

owner String Return runs when the owner No


name contains this string.

runName String Return runs with a run name No


that contains this string.

executionId String Return runs when the execution No


id contains this string.

flowUuid String Return runs where the flow UUID No


contains this string.

startedAfter Long Returns runs where the start No


time is after this time.

startedBefore Long Returns runs where the start No


time is before this time.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 925
Robotic Process Automation 2019.11

Get execution summary


Request
GET /executions/{executionIds}/summary
Description
Retrieves the details of a specific execution.
Sample
GET /executions/3332190961082830376,679861347442169334/summary
Request path variables

Attribute Description

executionIds The IDs of the executions

Response status codes:

Code Meaning Returned When

200 Successful (OK) The requested execution log was.

403 Forbidden

404 Not Found The requested execution log was


not found.

Response entity body


On success, returns a JSON object with the following format:

[{ "executionId": "101000011", "branchId": null,


"startTime": 1563969735064, "endTime": 1563969735583, "status":
"COMPLETED", "resultStatusType": "RESOLVED", "resultStatusName":
"success", "pauseReason": null, "cancelReason": null,
"owner": "anonymousUser", "ownerDomain": null, "triggeredBy":
"anonymousUser", "flowUuid": "06fe8531-868b-4e79-aa7a-13a5e30a66ec",
"flowPath": "Library/Utility Operations/Samples/Generate Random Number.xml",
"executionName": "Generate Random Number", "triggeringSource": "central",
"roi": 0 }, { "executionId": "101000001",
"branchId": null, "startTime": 1563969666202, "endTime":
1563969711647, "status": "COMPLETED", "resultStatusType":
"RESOLVED", "resultStatusName": "success", "pauseReason": null,
"cancelReason": null, "owner": "anonymousUser", "ownerDomain": null,
"triggeredBy": "anonymousUser", "flowUuid": "06fe8531-868b-4e79-aa7a-13a5e30a66ec",
"flowPath": "Library/Utility Operations/Samples/Generate Random Number.xml",
"executionName": "Generate Random Number", "triggeringSource": "central",
"roi": 0 } ]

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 926
Robotic Process Automation 2019.11

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 927
Robotic Process Automation 2019.11

Get execution step count


Request
GET /executions/{executionId}/steps/count
Description
Returns the total number of executed steps for the given execution, including finished steps and currently
executing (or paused) steps. If a step has been executed more than once (e.g., in a loop), this will be reflected in
the result. The count includes virtual steps such as lanes.
This command is useful when retrieving steps with pagination. It allows one to compute the total number of pages,
or the page number in which a given step could be found.
Request path variables:

Attribute Description

executionId Execution ID whose steps to count.

Request parameters

Attribute Type Description Required Default

includeRerunHistory Boolean Only relevant to No False


reruns. If true, the
result will include
the steps of the
original run (if not
purged yet)

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 928
Robotic Process Automation 2019.11

upToPath String If provided, the No N/A


result will only
count steps
positioned before
this path
(exclusive). The
given value is a
step path in the
execution tree: The
paths of the steps
at the top level of
the flow are 0.0 for
the 1st step, 0.1 for
the 2nd and so on.
If the 2nd step (0.1)
is a subflow, then
the paths of the
steps in that
subflow are 0.1.0,
0.1.1 and so on.

Example:

GET /executions/100300001/steps/count?upToPath=0.7.0.13

Response status codes:

Code Meaning Returned When

200 Successful (OK) Successful. If there are no results,


the result will be 0, but this is still
OK.

400 Bad Request If any of the arguments are invalid.

404 Not Found If the execution cannot be viewed


or does not exist.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 929
Robotic Process Automation 2019.11

Get execution steps with pagination and filtering


Request
GET /executions/{executionId}/steps
Description
Returns a paginated list of executed steps, with optional filtering. If a step has been executed more than once, for
example, loop, this will be reflected in the result. The result includes virtual steps such as lanes.
The returned objects are step logs – detailed objects with all available data about the steps. Step logs are created
as soon as the step begins to execute, and are updated with more data when the step finishes.
Request path variables

Attribute Description

executionId Execution ID whose steps to retrieve.

Request parameters – Pagination (optional)

Attribute Type Description Default Required

pageNum Long The wanted page 1 No


number (1 or
greater).

pageSize Long The size of each 50 No


page – can be 1 to
1000.

order Predefined The order of the asc No


Value returned steps – asc
for ascending or
desc for
descending. The
order is by step
path.

Request parameters – Filtering criteria

All filtering parameters are optional.


Only steps that satisfy all of the given criteria will be returned.
Filtering is performed before the pagination. In other words, when filtering, the pagination will give you pages of
search results.
Filtering by text is case insensitive.
Range conditions (such as roiFrom and roiUpTo) are exclusive. See the example below for details.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 930
Robotic Process Automation 2019.11

Attribute Type Description

includeRerunHistory Boolean Only relevant to reruns. If true, the


result will include the steps of the
original run (if not purged yet)

path String Get the step with this exact path.

pathFrom String Get steps whose paths are greater


than this path. Greater refers to a
collapsible tree representation of
the execution, the greater path
would show up lower in the tree.
For example, 0.10.0 is greater than
both 0.10 (its parent)
and0.9.99999.

pathUpTo String Get steps whose path is less than


this path (also see pathFrom).

nameContains String Get steps whose names contain this


substring.

types Predefined Get steps of the given types


Value (comma-separated list, no spaces).
The types are: operation, subflow,
return_step, other.
other represents special steps like
Multi Instance, as well as lanes.

startTime Long Get steps that started at this exact


timestamp.
Timestamps are "Unix time"
numbers with millisecond resolution
(the number of milliseconds elapsed
since 00:00:00 1 January 1970
UTC).

startTimeFrom Long Get steps that started after this


timestamp.

startTimeUpTo Long Get steps that started before this


timestamp.

endTime Long Get steps that ended at this exact


timestamp.

endTimeFrom Long Get steps that ended after this


timestamp.

endTimeUpTo Long Get steps that ended before this


timestamp.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 931
Robotic Process Automation 2019.11

durationSec Long Gets steps with this exact execution


time (seconds).

durationSecFrom Long Get steps that took longer to


execute than this value (seconds).

durationSecUpTo Long Get steps that took less time to


execute than this value (seconds).

inputsContain String Get steps where any of the inputs


contain this sub-string, in either the
input name or its value. It is also
possible to make a search in the
form name=value.
Values over 4,000 bytes cannot be
searched.

rawResultsContain String Get steps where any of the raw


results contain this sub- string, in
either the result name or its value.
It is also possible to make a search
in the form name=value.
Values over 4,000 bytes cannot be
searched.

primaryResultContains String Get steps where the primary result


contains this sub- string.
Values over 4,000 bytes cannot be
searched.

stepResultsContain String Get steps where any of the step-


defined results contain this sub-
string, in either the result name or
its value. It is also possible to make
a search in the form name=value.
Values over 4,000 bytes cannot be
searched.

responseTypes Predefined Get steps having one of the given


Value response types (comma-separated
list, no spaces).
The types are: resolved, error,
diagnosed, no_action_taken,
exception.
exception means the step’s
execution could not be completed.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 932
Robotic Process Automation 2019.11

transitionContains String Get steps whose outgoing transition


messages contain this sub-string.
The transition message is either the
transition’s description, or the
transition’s name if no description
has been defined.
Transition descriptions over 4,000
bytes (for all locales combined)
cannot be searched.

roi Double Get steps whose outgoing


transitions have this exact ROI
value.

roiFrom Double Get steps whose outgoing


transitions have ROI values greater
than this.

roiUpTo Double Get steps whose outgoing


transitions have ROI values less
than this.

currentFlowContains String Get steps that belong to flows


whose names contain this sub-
string.

currentFlowIdContains String Get steps that belong to the flow


with the given ID (or a sub-string in
it).

stepIdContains String Get steps with the given static step


ID (or a sub-string in it). This ID is
hard-coded in the parent flow
definition. Note that the same step
ID may appear in multiple steps of
the execution, for example, when
the flow employs a loop. To get a
specific step in the execution tree,
use the path parameter.

invokedIdsContain String Get steps that invoke (execute) the


operation or subflow with the given
ID (or a sub-string in it).
For steps that run soft copies of
operations, the invoked IDs include
both the soft copy and its parent
operation.

userContains String Get steps that executed while the


given Central user name (or a sub-
string in it) was the execution
owner.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 933
Robotic Process Automation 2019.11

workerIdContains String Get operation-type steps that were


executed by the given worker UUID
(or a sub-string in it).

workerGroupContains String Get operation-type steps that were


executed by a worker in the given
worker group name (or a sub-string
in it).

Sample
GET /executions/100300001/steps?pageNum=3&pageSize=20&order=desc
Use the following codes in the URL to filter the result:

&pathFrom=0.7.2&pathUpTo=0.9&path=0.9

&nameContains=ping

&types=operation,subflow

&startTime=1391359774000&startTimeFrom=1391359774000&startTimeUpTo=1391359780000

&durationSecFrom=300&durationSecUpTo=400&durationSec=400

&inputsContain=localhost

&resultsContain=ping+completed

&responseTypes=resolved,diagnosed

&transitionContains=success

&roi=7.5&roiFrom=7.5&roiUpTo=30

&currentFlowContains=My+Subflow

&userContains=jon

&workerIdContains=5c2002da

This will search execution 100300001 for steps satisfying all of the criteria, and return the 3rd page out of the
result set (with 20 steps per result page). The steps will be searched in descending path order, starting with the

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 934
Robotic Process Automation 2019.11

step that has the greatest path (normally the main flow’s return step).
The combination of these three conditions: roi=7.5&roiFrom=7.5&roiUpTo=30, will search for: 7.5 ≤roi < 30.
Following are the possible search ranges:

Use paramaters… To search for…

roi=7.5 roi = 7.5

roiFrom=7.5 roi > 7.5

roi=7.5&roiFrom=7.5 roi ≥ 7.5

roiFrom=7.5&roiUpTo=30 7.5 < roi < 30

roi=7.5&roiFrom=7.5&roiUpTo=30 7.5 ≤ roi < 30

roiUpTo=7.5&roiFrom=30 roi < 7.5 or roi > 30

roiUpTo=7.5&roiFrom=7.5 roi ≠ 7.5

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 935
Robotic Process Automation 2019.11

Get execution summary with pagination and


filtering to a CSV file

Request

GET /executions/reports/mediaType=csv

Description

Returns execution summary in a CSV file with filtering capability. The returned objects include the execution
summary and details of objects with data related to execution.

Sample

GET {protocol}://{url}:{port} /oo/rest/latest/executions/reports?mediaType=csv

Request parameters

Attribute Type Description Required

mediaType String Data format into which to export the run explorer. Yes
Possible values: csv

pageNum Integer The number of the returned page. No


Default value: 1

pageSize Integer The size of the returned page. No


Default value: 200

flowPath String Return runs that their flow path contains this string. No

status Array of Return runs with the following statues. No


Predefined Possible values: RUNNING, COMPLETED, COMPLETED_
Values RESOLVED, COMPLETED_DIAGNOSED, COMPLETED_ERROR,
COMPLETED_NO_ACTION_TAKEN, COMPLETED_ CUSTOM,
SYSTEM_FAILURE, PAUSED, PAUSED_ USER_PAUSED,
PAUSED_INPUT_REQUIRED, PAUSED_
INPUT_REQUIRED_MANUAL_OP, PAUSED_DISPLAY,
PAUSED_GATED_ TRANSITION, PAUSED_HAND_OFF,
PAUSED_INTERRUPT, PAUSED_NO_ WORKERS_IN_GROUP,
PAUSED_ BRANCH_PAUSED, CANCELED

owner String Return runs when the owner name contains this string. No

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 936
Robotic Process Automation 2019.11

Attribute Type Description Required

runName String Return runs with a run name that contains this string. No

executionId String Return runs when the execution id contains this string. No

flowUuid String Return runs where the flow UUID contains this string. No

startedAfter Long Returns runs where the start time is afterthis time. No

startedBefore Long Returns runs where the start time is before this time. No

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 937
Robotic Process Automation 2019.11

Get a single execution step

Request

GET /executions/{executionId}/steps/{stepPath}

Description

Returns data about a single step of an execution.

Request path variables

Attribute Description

executionId Execution ID whose step to retrieve.

stepPath The step's path in the execution tree. Step paths work
as follows:
The paths of the steps at the top level of the
execution are 0.0 for the 1st step, 0.1 for the 2nd and
so on.
If the 2nd step (0.1) is a subflow, then the paths of the
steps in that subflow will be 0.1.0, 0.1.1 and so on.
Virtual steps such as lanes also have a path.

Sample

GET /executions/100300001/steps/0.7.0.13

Response status codes

Code Meaning Returned When

200 Successful (OK) Successful.

400 Bad Request Any of the arguments are invalid.

404 Not Found The requested step wasn’t found in


the given execution, or the
execution is not viewable

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 938
Robotic Process Automation 2019.11

Get execution steps as a CSV file

Request

GET /executions/{executionId}/steps?mediaType=csv

Description

Returns all executed steps for the given execution, as a CSV file.

Request path variables

Attribute Description

executionId Execution ID whose steps to retrieve.

Request parameters

The mediaType parameter must be set to CSV otherwise the request will be treated as "Get execution steps with
filtering and pagination" API.

Additional parameters

Attribute Type Description Required Default

includeRerunHistory Boolean Only relevant to No false


reruns. If true, the
result will include
the steps of the
original run (if not
purged yet)

Samples

GET /executions/100300001/steps?mediaType=csv

GET /executions/100300001/steps?mediaType=csv&includeRerunHistory=true

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 939
Robotic Process Automation 2019.11

Code Meaning Returned When

200 Successful (OK) Successful. If there are no results,


the result will be empty, but this is
still OK.

404 Not Found If the execution cannot be viewed


or does not exist.

400 Bad Request If any of the arguments are invalid.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 940
Robotic Process Automation 2019.11

Get execution steps as a text file

Request

GET /executions/{executionId}/steps?mediaType=text

Description

Given an execution ID, returns the text representation of all executed steps in a format.

Request path variables

Attribute Description

executionId Execution ID whose steps to retrieve.

Request parameters

The mediaType parameter must be set to text. Otherwise, the request will be treated as Get Execution Steps (with
Filtering and Pagination).

Additional parameters

Attribute Description Required Default

includeRerunHistory Only relevant to reruns. If No false


true, the result will
include steps of the
original run(if not purged
yet).

Samples

GET /executions/186400079/steps?mediaType=text

GET /executions/186400079/steps?mediaType=text&includeRerunHistory=true

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 941
Robotic Process Automation 2019.11

Response status codes

Code Meaning Returned When

200 OK Successful

404 Not Found The specified execution does not


exist or is not viewable by the
current user.

400 Bad request If any of the arguments are invalid.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 942
Robotic Process Automation 2019.11

Execution pauses

Request

GET /executions/{executionId}/pauses

Description

Retrieves current pauses for the given execution id.

Request path variables

Attribute Description

executionId The ID of the execution which the client wishes to


retrieve its pauses.

Sample

GET /executions/100001/pauses

Response status codes

Code Meaning Returned When

200 OK All requested pauses were returned.

404 Not Found The provided execution ID doesn’t


exist.

Response entity body

An array which contains all the current pauses of the requested execution. Each element in the array represents a
pause of a lane in the execution tree.
The returned array is not ordered and is empty if no pauses exist for the given execution id. There are five possible
reasons for pauses, which can be differentiated by inspecting the pauseReason attribute.
There are different return attributes between the different types:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 943
Robotic Process Automation 2019.11

Reason 1: Input Required

Attribute Type Description Comments

pauseReason Predefined The value


Value INPUT_REQUIRED

pauseId Long An ID for the returned


pause.

executionId String The execution ID

branchId String The ID of the branch were null ID represents the


the pause has occurred. main branch.

stepId String The UUID of the step in


which the pause has
occurred.

stepName String The name of the step in


the flow.

requiredInputs FlowInput See Get Flow Inputs topic

Reason 2: Display

Attribute Type Description Comments

pauseReason Predefined The value DISPLAY


Value

pauseId Long An ID for the returned


pause.

executionId String The execution ID

branchId String The ID of the branch were null ID represents the


the pause has occurred. main branch.

stepId String The UUID of the step in


which the pause has
occurred.

stepName String The name of the step in


the flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 944
Robotic Process Automation 2019.11

title String The author’s specified


localized title for the
prompt message that
should be presented to
the user.

text String The author’s specified


localized message that
should be presented to
the user

height String For future use. Ignore this field.

width String For future use. Ignore this field.

Sample

[{ "pauseId": 101100010, "executionId": "100100312", "branchId": null,


"stepId": "c12fc96a-f938-4a8c-81a1-5dbcc3b81e6d", "stepName": "Resolved : success",
"pauseReason": "DISPLAY", "title": "Return Step title with input: value1", "text":
"Return Step text:\ninput1: value1", "height": "0.0", "width": "0.0" }]

Reason 3: Gated Transition

Attribute Type Description Comments

pauseReason Predefined The value


Value GATED_TRANSITION

pauseId Long An ID for the returned


pause.

executionId String The execution ID

branchId String The ID of the branch were null ID represents the


the pause has occurred. main branch.

stepId String The UUID of the step in


which the pause has
occurred.

stepName String The name of the step in


the flow.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 945
Robotic Process Automation 2019.11

roleName String The role which the user is


missing in order to pass
the gated
transition.

userName String The user which is trying


to pass through the gated
transition.

Sample

[{ "pauseId": 101100008, "executionId": "100100274", "branchId": null,


"stepId": "2ba782f2-ea84-4f66-936d-4226d4bfa134", "stepName": "UUID Generator",
"pauseReason": "GATED_TRANSITION", "roleName": "AUDITOR", "userName":
"anonymousUser" }]

Reason 4: Hand Off

Attribute Type Description Comments

pauseReason Predefined The value HAND_OFF


Value

pauseId Long An ID for the returned


pause.

executionId String The execution ID.

branchId String The ID of the branch were A null ID represents the


the pause has occurred. main branch.

stepId String The UUID of the step in


which the pause has
occurred.

stepName String The name of the step in


the flow.

Sample

[{ "pauseId": 101100009, "executionId": "100100293", "branchId": null,


"stepId": "70eaf376-72ca-4440-9f60-a743fcfa56b2", "stepName": "UUID Generator",
"pauseReason": "HAND_OFF" }]

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 946
Robotic Process Automation 2019.11

Reason 5: No Workers In Group

Attribute Type Description Comments

pauseReason Predefined The value


Value NO_WORKERS_IN_GROUP

pauseId Long An ID for the returned


pause.

executionId String The execution ID

branchId String The ID of the branch were A null ID represents the


the pause has occurred. main branch.

stepId String The UUID of the step in Would be null, please


which the pause has ignore
occurred.

stepName String The name of the step in Would be null, please


the flow. ignore

groupName String The unavailable group.

Sample

[{ "pauseId": 101100012, "executionId": "100100341", "branchId": null,


"stepId": null, "stepName": null, "pauseReason": "NO_WORKERS_IN_GROUP",
"groupName": "RAS_Operator_Path" }]

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 947
Robotic Process Automation 2019.11

Get execution log

Request

GET /executions/{executionId}/execution-log

Description

This API retrieves the extended summary of a specific execution. It is an extension of the Execution Summary API
and holds additional information, such as the inputs and outputs of that execution.

Request path variables

Attribute Description

executionId The id of the execution

Response status codes

Code Meaning Returned When

200 Successful (OK) The requested execution log was


successful.

403 Forbidden The requested execution log was


forbidden.

404 Not Found The requested execution log was


not found or not viewable.

Response entity body

On success, returns a JSON object with the following format:

{ "executionSummary": { "executionId": "348246628680024354",


"branchId": null, "startTime": 1371366300297, "endTime": null,
"status": "PAUSED", "resultStatusType": "RESOLVED",
"resultStatusName": "HAHA", "pauseReason": null, "owner":
"anonymous", "ownerDomain": null, "triggeredBy": "anonymous",
"flowUuid": "a8e8fc10-b584-4d39-921f-987b29c9dd19", "flowPath": null,
"executionName": "mock flow", "triggeringSource": "central", "roi":
null }, "executionLogLevel": "STANDARD", "flowVars": [{

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 948
Robotic Process Automation 2019.11

"name": "flowVar0", "termName": "flowVar0TermName",


"value": "flowVar0Value" }, { "name":
"flowVar1", "termName": "flowVar1TermName", "value":
"flowVar1Value" }, { "name": "flowVar2",
"termName": "flowVar2TermName", "value": "flowVar2Value" },
{ "name": "flowVar3", "termName":
"flowVar3TermName", "value": "flowVar3Value" },
{ "name": "flowVar4", "termName":
"flowVar4TermName", "value": "flowVar4Value" } ],
"flowOutput": { "flowOutput4": "flowOutput4Value", "flowOutput3":
"flowOutput3Value", "flowOutput0": "flowOutput0Value",
"flowOutput2": "flowOutput2Value", "flowOutput1": "flowOutput1Value" } }

Response attributes

Attribute Type Description

executionSummary Predefined Value An array which contains all of the executions summary which
match the requested filters.

flowVars List of FlowInput The flow’s bound inputs. Each FlowInput object has three fields:
objects name (String), value (String) and termName (domain term that
the input is recorded under).

flowOutput Map (String to String) A name-to-value map of the flows outputs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 949
Robotic Process Automation 2019.11

Change the status of an execution


Request
PUT /executions/{executionIds}/status
Description
Update existing executions statuses. Each request has a single action and data but can be applied to multiple
executions.
Changing the run status is allowed when the following conditions are true:

1. The user has the Run permission (entitlement) for the executed flow.

2. The run is currently assigned to the user, or alternatively, the user has the Manage Others’ Runs permission.

You cannot change the status of a completed execution. You cannot change the status of an execution to the same
status.
Request path variables

Attribute Description Type

executionIds The IDs of the executions which the String


user wants to update the statuses.
Separated by a comma.

Request entity body


The execution status can be changed to one of the following states: CANCEL, PAUSE, REASSIGN, or RESUME. The
desired status should be set in the action attribute.
Samples
To cancel executions:

Attribute Type Description Required Default

action Predefined Value The value CANCEL Yes N/A

{ "action": "CANCEL" }

To pause executions:

Attribute Type Description Required Default

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 950
Robotic Process Automation 2019.11

action Predefined Value The value PAUSE Yes N/A

{ "action": "PAUSE" }

For reassigning executions to another user:

Attribute Type Description Required Default

action Predefined Value The value Yes N/A


REASSIGN

data Key value Contains the key Yes


userName and the
reassigned user as
value.

{ "action": "REASSIGN", "data": { "userName": "John" } }

For resuming executions:

Attribute Type Description Required Default

action Predefined Value The value RESUME Yes N/A

data Key value Should contain two Yes – but it can be • brachId default
key-value pairs: • empty and use the value is null
branchId key for the default values. • input_binding only
branch that should required when
be resumed. Null resuming an
should be provided execution which
for the branch root. has the
• input_binding key pauseReason
is used to provide INPUT_REQUIRED.
the required inputs See Execution
for an execution Pauses
which is waiting for
inputs.The
input_binding value
must be an object
using the format:
{input_name :
input_value}

Resume without inputs:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 951
Robotic Process Automation 2019.11

{ "action": "RESUME", "data": { "branchId": null } }

Resume with inputs:

{ "action": "RESUME", "data": { "branchId": "f47ac10b-58cc-4372-a567-0e02b2c3d479:1",


"input_binding": { "Input 1": "VALUE2", "Input 2": [ "VALUE1", "VALUE2", "VALUE3" ], "Input 3":
null, "Input 4": "434" } } }

Response status codes

Code Meaning Returned When

200 Successful (OK) Successful. If there are failures it


will be reflected in the response
body.

400 Bad request If the request was wrong. For


example, if reassign without
username data.

Response entity body


On success, returns a JSON object with the following format:

[{ "executionId": "3332190961082830376", "executionName": "mock flow1", "result": "SUCCESS" }, {


"executionId": "3098745634785645678", "executionName": "mock flow2", "result":
"FAILED_ALREADY_COMPLETED" } ]

The result is predefined value.


Values are: SUCCESS, FAILED_ALREADY_PAUSED, FAILED_ALREADY_COMPLETED, FAILED_ALREADY_CANCELED,
FAILED_ALREADY_RUNNING, FAILED_NOT_FOUND, FAILED_PENDING_PAUSE, FAILED_SYSTEM_FAILURE,
FAILED_FORBIDDEN, FAILED_BAD_REQUEST;

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 952
Robotic Process Automation 2019.11

Execute a flow by UUID


Request
POST /executions
Description
Executes a flow specified by UUID.
Request entity body

Attribute Type Description Required? Default

flowUuid String Flow ID Yes

runName String Execution run name No Flow name

logLevel String Execution log level. No Flow log level


The logLevel
attribute receives
one of these values:
STANDARD,
EXTENDED.

inputs String Execution bound No


inputs

inputPromptUseBlan Boolean If true, disables all No False


k prompts for input
values

sensitiveInputs Map<String,Boolean Specify the input No


> name and whether to
encrypt it or not

The body of this request must include a JSON object with the following format:

{ "flowUuid": "8d52dfc3-1de5-48d4-9c2a-887718de4696", "runName": "run1",


"logLevel": "STANDARD", "inputs": { "input1": "value for input1",
. . . "inputn": "value for inputn" },
"sensitiveInputs": { "input1": true, "input2": false,
. . . "inputn": true } }

There is an option to change the group alias mapping during a specific flow execution, by specifying an input called
OO_ALIAS_GROUP_MAPPING.
For example, to map the group alias newAlias to the worker group name provide the following inputs:

{ "OO_ALIAS_GROUP_MAPPING": "{\"newAlias\":\"group name\"}" . .


. }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 953
Robotic Process Automation 2019.11

inputs and runName are optional and can be omitted. If the flows were defined with inputs which are either set
as prompt user or/and are required, the flow will pause.
LogLevel is also optional – if not specified, the default level for the given flow will be used.
The logLevel attribute receives one of these values: STANDARD, EXTENDED.

The sensitiveInputs attribute can be used on those inputs from the inputs attribute that you want to be
encrypted. For example, if you want input1 to be encrypted, then you must add input1:true in the sensitiveInputs
map. By default, the value of the encryption flag is set as false for all inputs.

Response status codes

Code Meaning Returned When

201 Created A new flow execution was created.

400 Bad Request One of the arguments are not correct.

Response entity body


On success, returns a string which represents execution ID.
In the response, the Location header will contain the REST request relative path for retrieving information about
the steps executed so far.

/executions/8d52dfc3-1de5-48d4-9c2a-887718de4696/steps

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 954
Robotic Process Automation 2019.11

Flow execution status

Flow execution status


The following are the possible values of the status attribute that appear in the APIs:

Status Description

RUNNING The flow execution is in progress.

COMPLETED The flow has finished. In order to understand the


result (for example, success or failure) use the
resultStatusType attribute.

SYSTEM_ FAILURE The execution failed due to an unexpected error in


the system.

PAUSED The flow execution paused.

PENDING_ PAUSE A flow execution pause request was submitted, and


the system is waiting for an action to complete in
order to enter the pause state.

CANCELED The flow execution was canceled by the user.

PENDING_ CANCEL A flow execution cancel request was submitted, and


the system is waiting for an action to complete in
order to cancel the execution.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 955
Robotic Process Automation 2019.11

Flow input
Defines for the client, how an input should be presented to the end user.
Request:
GET /rest/flows/{flowUUID}/inputs
Description:
Retrieves the input of the flows
Response status codes:

Code Meaning Returned When

200 Successful (OK) The request was successful.

404 Not found The flow UUID is not valid.

Attribute Type Description Comments

uuid String The UUID of this input. null is possible

name String A unique name of this


input.

valueDelimiter String The expected delimiter in null is possible


the value, in case this is a
multiple value input.

description String A localized description of


this input, this provides
more information to the
user.

encrypted Boolean Indicates whether this is


a classified input. It is
advised to mask the user
input in the presentation.

multiValue Boolean Indicates whether


multiple values are
expected. They will be
delimited by the
valueDelimiter attribute.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 956
Robotic Process Automation 2019.11

mandatory Boolean Set if the user must


provide this input. In this
case the attribute is true
and the user does not
provide the required
input, the operation
which requests this input
will fail.

sources Array Suggested input values null is possible


for the user.

type Predefined String: Indicates that a


Value free text input is
expected.
SelectionList: User should
choose value/values from
the supplied sources.

validationId String For future use. Would be null. Please


ignore this attribute.

defaultValue String A default value for this null is possible


input. This is a hint for
the
UI and could be used by
the user.

Example from Central UI:


input2, list_bool, list_char, multi_list_char are flow inputs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 957
Robotic Process Automation 2019.11

Example:

[{ "uuid": "6582905f-0253-4f86-b247-7de5ef7b6a79", "name": "measuredValue", "valueDelimiter": ",",


"description": "", "encrypted": false, "multiValue": false, "mandatory": true, "sources": null,
"type": "String", "validationId": null, "defaultValue": null }, { "uuid": "a565290f-5412-40f0-
a4b7-4fdfaab39cdd", "name": "threshold", "valueDelimiter": ",", "description": "", "encrypted":
false, "multiValue": false, "mandatory": true, "sources": null, "type": "String", "validationId":
null, "defaultValue": null }, { "uuid": "734d3efa-0b9f-471e-8e0d-0ac093309efb", "name": "diagnostic
name", "valueDelimiter": ",", "description": "", "encrypted": false, "multiValue": false,
"mandatory": true, "sources": null, "type": "String", "validationId": null, "defaultValue": null }]

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 958
Robotic Process Automation 2019.11

Purge debugger execution events

Request

DELETE /debugger-events/endedBefore=

Description

Purges debugger events of remote executions.


This command is useful for keeping the database clean from debugger events, which become useless after
executions have completed and also affect the size and memory the database occupies.

Request parameters

Attribute Type Description Required Default

endedBefore Long Time to use as Yes


upper limit for
purging

maxAmount Long Max number of No 100


executions to purge

Sample

DELETE /debugger-event?endedBefore=1411998175833
DELETE /debugger-event?endedBefore=1411998175833&maxAmount=1000

Response status codes

Code Meaning Returned When

200 Successful (OK) Successful. If there are no results,


the result will be empty (which is
OK).

400 BadRequest If any of the arguments are invalid.

403 Forbidden The user attempting to execute this


command does not have the
Manage
Data Cleanup permission.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 959
Robotic Process Automation 2019.11

Response entity body

On success, returns the number of purged executions.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 960
Robotic Process Automation 2019.11

Purge execution data

Request

DELETE /executions

Description

Purges execution data for runs matching the given criteria. It is possible to purge all execution data (including the
execution summaries), or only specific items (flow inputs, flow outputs and/or steps).
Since RPA Self-Service X relies on RPA Central to show more details about the execution context, when the
execution context is purged Self-Service X Activity will show an Unknown icon.

Request parameters

Attribute Type Description Required Default value

endedBefore Long Time to use as upper limit for purging Yes

maxAmount Integer Max number of executions to purge No 100

purgeItems Predefined Value List of items that should be purged. No


Valid values: flowInputs, flowOutputs, steps.
If not specified, will purge all data for
executions (including execution summaries).

statuses Predefined Value List of execution statuses according to which No


the relevant execution will be purged.
Valid values:
COMPLETED, COMPLETED_RESOLVED,
COMPLETED_DIAGNOSED,COMPLETED_ERROR,
COMPLETED_NO_ACTION_TAKEN,
COMPLETED_CUSTOM SYSTEM_FAILURE,
CANCELED.
If not specified, will not filter according to
status.

flowUuids String Purge data for executions of the given flow No


UUIDs.
If not specified, will not filter according to flow
UUID.

Samples

DELETE /executions?endedBefore=1445421975041&flowUuids=2da44b9a-2161-47c5-94a9-864920bedef8
Purges all run data (execution summaries, steps, flow inputs and outputs) for runs of the flow with UUID
2da44b9a-2161-47c5-94a9-864920bedef8 which ended before 2015-10-21 10:06:15 UTC. Up to 100 runs will be
purged.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 961
Robotic Process Automation 2019.11

DELETE /executions?endedBefore=1445421975041&statuses=SYSTEM_FAILURE,CANCELED
&flowUuids=2da44b9a-2161-47c5-94a9-864920bedef8
Purges all run data (execution summaries, steps, flow inputs and outputs) for runs with status SYSTEM_FAILURE or
CANCELED which ended before 2015-10-21 10:06:15 UTC. Up to 100 runs will be purged.

DELETE /executions?endedBefore=1412150176345&maxAmount=200&purgeItems=steps
Purges step data only, for runs which ended before 2014-10-01 07:56:16 UTC. Up to 200 runs will be purged.

Response status codes

Code Meaning Returned When

200 Successful (OK) Successful. The requested contents


were deleted.

400 Bad Request If any of the parameters are invalid.

403 Forbidden The user attempting to execute this


command does not have the
ManageData Cleanup permission.

Response entity body

On success, returns the amount of executions whose summaries/steps/inputs/outputs were purged.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 962
Robotic Process Automation 2019.11

Delete steplog data

Request

DELETE /steps-log

Description

Purge step data according to time and amount of executions to purge.

Sample

DELETE /steps-log?endedBefore=1412150176345&maxAmount=200

Request parameters

Attribute Type Description Default value Required?

endedBefore Long The time in 30 days back (in No


milliseconds to start milliseconds)
purging

maxAmount int The max amount of 100 No


executions on
which step’s data is
purged

Response status codes

Code Meaning Returned When

200 Successful (OK) The step data was deleted


successfully.

400 Bad Request Arguments are invalid

403 Forbidden The user does not have the


permission Manage Cleanup Data

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 963
Robotic Process Automation 2019.11

Response entity body

On success, turns a JSON string of the number of executions that their step data has been purged.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 964
Robotic Process Automation 2019.11

Flow library
This section provides information about APIs pertaining to the Flow Library.

Get flows library


Request
GET /flows/library
Description
Retrieves all flows deployed in the system. This returns an ordered list, and contains all the folders and flows in the
flow library, ordered according to the tree structure.
Response status codes

Code Meaning Returned When

200 Successful (OK) The requested library was returned.

Response entity body


A list of elements that contains all of the flows that exist in the system.

Attribute Type Description Comments

id String The id of node. For a non-leaf (folder)


node, the id is the same
as the path. For a leaf
node (deployed entity),
the id is the entity’s id.

name String The name of the node. Folder name or flow


name.

parentId String The id of the parent node. Null if this is a root node.

leaf Boolean Whether the node is a leaf is a flow, not leaf =


leaf or not. folder

path String The path of the node.

runnable Boolean Whether the node is a


runnable or not.

childrenIds Array of List of the the node’s


Strings children id

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 965
Robotic Process Automation 2019.11

Sample

[{ "id": "Library/cp-dotnet/InputsOutputsResponses/flows", "name": "flows",


"parentId": "Library/cp-dotnet/InputsOutputsResponses", "leaf": false,
"path": "Library/cp-dotnet/InputsOutputsResponses/flows", "runnable": false,
"childrenIds": ["Library/cp-dotnet/InputsOutputsResponses/flows/DOTNET_Action inputs and outputs 2
op.xml", "Library/cp-dotnet/InputsOutputsResponses/flows/DOTNET_Action inputs and outputs.xml"]
}, { "id": "0e98f028-3a59-4cce-9196-4690bd48ea95", "name":
"DOTNET_Action inputs and outputs 2 op", "parentId": "Library/cp-
dotnet/InputsOutputsResponses/flows", "leaf": true, "path":
"Library/cp-dotnet/InputsOutputsResponses/flows/DOTNET_Action inputs and outputs 2 op.xml",
"runnable": true, "childrenIds": [] } ]

Read next level of library tree


Request
GET /flows/tree/level
Description
Returns a flat list of all tree Items under the path (lazy loading).
Request parameters

Attribute Description Required

path Return the tree items under this No


path. Default value is root.

Response status codes

Code Meaning Returned When

200 Successful (OK) The requested items were found

Response entity body


On success, returns a JSON object with the following format:

[{ "id": "library/Accelerator Packs", "name": "Accelerator Packs",


"leaf": false, "path": "Library/Accelerator Packs", "runnable":
false, "children": null }, { "id": "library/How Do I
flows", "name": "How Do I flows", "leaf": false,
"path": "Library/How Do I flows", "runnable": false, "children":
null } ]

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 966
Robotic Process Automation 2019.11

Get flow details


Request
GET /flows/{uuid}
Description
Returns flow properties by the UUID.
Request path variables

Attribute Description

uuid The flow uuid

Response status codes

Code Meaning Returned When

200 Successful (OK) The requested flow was found.

404 Not Found The requested flow was not found


or the user does not have
permission to view it or the uuid
was empty

Response entity body


On success, returns a JSON object with the following format:

{ "id": "1fe1be31-2c78-40dd-8326-b8ca527e5587", "name": "Recently Run", "path":


"Library/Utility Operations/Date and Time/Recently Run.xml", "description": "flow
desciption", "cpName": "HPEOO-oo-base", "version": "version111",
"logLevelInfo": { "logLevel": "EXTENDED", "logLevelSource": "SYSTEM"
} }

Get flow inputs


Request
GET /flows/{uuid}/inputs
Description
Retrieves a list of flow’s inputs by its UUID.
Request path variables

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 967
Robotic Process Automation 2019.11

Attribute Description

uuid The flow uuid

Response status codes

Code Meaning Returned When

200 Successful (OK) The requested flow’s inputs were


found

404 Not Found The requested flow was not found


or the user does not have
permission to view it or the uuid
was empty

Response entity body


On success, returns a JSON object with the following format:

[{ "uuid": "c4454566-6bb5-4be9-9824-2a08945f1574", "name": "message",


"valueDelimiter": ",", "description": "", "encrypted": false,
"multiValue": false, "mandatory": true, "sources": null,
"type": "String", "validationId": null, "defaultValue": null
}, { "uuid": "cdac00b3-f550-4cd5-a3eb-f15d2f80fd78", "name":
"title", "valueDelimiter": ",", "description": "",
"encrypted": false, "multiValue": false, "mandatory": false,
"sources": null, "type": "String", "validationId": null,
"defaultValue": "Status message" } ]

Get all flow inputs


Request
GET /flows/inputs
Description
Gets a list of all deployed flows with all of their inputs.
Sample
GET /flows/inputs
Response status codes

Code Meaning Returned When

200 OK Successful

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 968
Robotic Process Automation 2019.11

Response entity body


An array of flows where each flow includes the flow UUID, flow name and an array of its inputs.

[{ "flowUuid": "3bb3f887-f4f1-4c4b-a7a3-7e7f4c403283", "flowName": "Check Process by PID",


"flowInputs": [{ "flowUuid": "3bb3f887-f4f1-4c4b-a7a3-7e7f4c403283",
"flowName": "Check Process by PID", "inputUuid": "d4237daa-a415-4647-
a270-7e0ce14edce2", "inputName": "host",
"inputValueDelimiter": ",", "inputEncrypted": false,
"inputMultiValue": false, "inputMandatory": true,
"inputType": "String", "inputValidationId": null,
"inputDefaultValue": null, "sources": null },
{ "flowUuid": "3bb3f887-f4f1-4c4b-a7a3-7e7f4c403283",
"flowName": "Check Process by PID", "inputUuid": "d2a0860a-696d-4696-
ba18-65f6b55f747c", "inputName": "username",
"inputValueDelimiter": ",", "inputEncrypted": false,
"inputMultiValue": false, "inputMandatory": false,
"inputType": "String", "inputValidationId": null,
"inputDefaultValue": null, "sources": null } ] }]

Get flow outputs


Request
GET /flows/{uuid}/outputs
Description
Retrieves a list of all the outputs defined for the flow with the requested uuid. The list of outputs retrieved will
contain only outputs defined in the flow properties.
Request path variables

Attribute Description

uuid The requested flow’s uuid.

Sample
GET /flows/22de91c4-f651-42fd-a404-1bf0ca921f36/outputs
Response status codes

Code Meaning Returned When

200 Successful The requested flow’s inputs were


(OK) found.

404 Not Found The requested flow was not found


or the user does not have
permission to view it or the uuid
was empty.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 969
Robotic Process Automation 2019.11

Response entity body === An array which contains all of the outputs that are defined for the flow. Each
element in the array represents an output of the flow. The returned array is not ordered.

Attribute Type Description Comments

name String The name of the output.

[{ "name": "Result" }, { "name": "output2" },


{ "name": "output1" } ]

Get flow settings


Request
GET /flows/{UUID}/settings
Description
Retrieves execution settings for the specified flow.
Request path variables

Attribute Description

UUID The flow UUID

Sample
GET /flows/8aff6b34-15a2-11e5-b60b-1697f925ec7b/settings
Response status codes

Code Meaning Returned When

200 OK The flow settings were found

404 Not Found The specified flow does not exist or


the user is not entitled to view it

Response entity body

Attribute Type Description

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 970
Robotic Process Automation 2019.11

logLevelInfo Object The object contains two strings:


logLevel: The run log level
(persistence level) of this flow.
Possible values: STANDARD,
EXTENDED
logLevelSource: Indicates whether
the log level is taken from the
system default, or is explicitly set
for this flow.
Possible values: SYSTEM, FLOW

flowTimeout Integer or null Possible values:


• null: This flow has no explicit
timeout setting. The system default
timeout will be used instead .
• 0: This flow is explicitly set to
have no timeout.
• Positive number: This flow is
explicitly set to have the specified
execution timeout, in minutes.

autoResume boolean values or null Possible values:


• true/false - the flow level auto-
resume is set and the auto-resume
functionality will use it
• null - the flow level autoresume is
not set and the auto-resume
functionality will use the system
auto-resume setting

Example:

{ "logLevelInfo": { "logLevel": "STANDARD", "logLevelSource":


"FLOW" }, "flowTimeout": 0, "autoResume": null }

Update flow settings


Request
PUT /flows/{UUID}/settings
Description
Sets execution settings for the specified flow.
Request path variables

Attribute Description

UUID The flow UUID

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 971
Robotic Process Automation 2019.11

Request entity body

Attribute Type Description

logLevelInfo Object This object should contain a single


property named logLevel.
Possible values for logLevel:
• null: Remove the explicit log level
for this flow (use the system default
log level).
• One of the predefined logLevel
values.

flowTimeout Integer or null See possible values for flowTimeout


in Get flow settings topic.

autoResume boolean values or null Possible values:


• true/false - the flow level auto-
resume is set and the auto-resume
functionality will use it
• null - the flow level autoResume is
not set and the auto-resume
functionality will use the system
auto-resume setting

Sample === PUT /flows/8aff6b34-15a2-11e5-b60b-1697f925ec7b/settings

{ "flowTimeout": "0", "logLevelInfo": { "logLevel": "STANDARD" },


"autoResume": null }

Response status codes

Code Meaning Returned When

204 Successful (No Content) The flow settings were updated.

400 Bad Request The request body is invalid.

403 Forbidden The user does not have the Manage


Content Packs permission.

404 Not Found The specified flow does not exist or


the user is not entitled to view it.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 972
Robotic Process Automation 2019.11

Scheduler
The scheduler API allows you to schedule flow executions. You can specify a schedule to run for a specific occasion.
You can also setup recurring schedules for a flow for a repeated task. These APIs enable you to manage schedules,
for example create new schedules. The scheduler supports only the quartz CRON syntax.

CRON expression format

A CRON expression is a string comprised of 6 fields separated by white space. The Fields can contain any of the
allowed values, along with various combinations of the allowed special characters for that field. The fields are as
follows:

Field Name Mandatory Allowed Values Allowed Special Characters

Seconds YES 0-59 ,-*/

Minutes YES 0-59 ,-*/

Hours YES 0-23 ,-*/

Day of month YES 1-31 ,-*?/LW

Month YES 1-12 or JAN-DEC ,-*/

Day of week YES 1-7 or SUN-SAT ,-*?/L#

Format for special characters

Special
character When to use

* (“all values”) You can use this to select all values within a field. For example, “*” in the minute field means
“every minute”.

? (“no specific This is useful when you need to specify something in one of the two fields in which the
value”) character is allowed, but not the other. For example, if you want the trigger to fire on a
particular day of the month (say, the 10th), but don’t care what day of the week that happens
to be, you must put “10” in the day-of-month field, and “?” in the day-of-week field.

- You can use this to specify ranges. For example, “10-12” in the hour field means “the hours
10, 11 and 12”.

, You can use this to specify additional values. For example, “MON,WED,FRI” in the day-of-
week field means “the days Monday, Wednesday, and Friday”.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 973
Robotic Process Automation 2019.11

Special
character When to use

/ You can use this to specify increments. For example, “0/15” (equivalent with "/15") in the
seconds field means “the seconds 0, 15, 30, and 45”. And “5/15” in the seconds field means
“the seconds 5, 20, 35, and 50”. ‘1/3’ in the day-of-month field means “fire every 3 days
starting on the first day of the month”.

L (“last”) This has different meaning in each of the two fields in which it is allowed. For example, the
value “L” in the day-of-month field means “the last day of the month” - day 31 for January,
day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply
means “7” or “SAT”. But if used in the day-of-week field after another value, it means “the
last xxx day of the month” - for example “6L” means “the last Friday of the month”. You can
also specify an offset from the last day of the month, such as “L-3” which would mean 3 days
before the end of the month. When using the ‘L’ option, it is important not to specify lists, or
ranges of values, as you’ll get confusing/unexpected results.

W (“weekday”) You can use this to specify the weekday (Monday-Friday) nearest the given day. As an
example, if you were to specify “15W” as the value for the day-of-month field, the meaning
is: “the nearest weekday to the 15th of the month”. So if the 15th is a Saturday, the trigger
will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If
the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify “1W” as
the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd,
as it will not ‘jump’ over the boundary of a month’s days. The ‘W’ character can only be
specified when the day-of-month is a single day, not a range or list of days.

# Used to specify “the nth” XXX day of the month. For example, the value of “6#3” in the day-
of-week field means “the third Friday of the month” (day 6 = Friday and “#3” = the 3rd one
in the month). Other examples: “2#1” = the first Monday of the month and “4#5” = the fifth
Wednesday of the month. Note that if you specify “#5” and there is not 5 of the given day-of-
week in the month, then no firing will occur that month.

The legal characters and the names of months and days of the week are not case sensitive. MON is the same as
mon.

Create new flow schedule

Request

POST /schedules

Description

Add a new schedule for a flow execution.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 974
Robotic Process Automation 2019.11

Request entity body:

The body of this request must include a JSON object with the following format:
JSON for a scheduled flow with a CRON triggering expression:

{ "flowScheduleName": "Scheduled Flow Created By REST", "flowUuid": "c34de7d6-14cc-4a1c-


b25e-85afbb064359", "triggerExpression": "0 10 10 ? * 6", "startDate": 1314079869000, "endDate":
1491302669536, "runLogLevel": "STANDARD", "inputPromptUseBlank": true, "timeZone": "Asia/Amman",
"inputs": { "input1": "value for input1", "inputn": "value for inputn" } }

JSON for a scheduled flow with a simple triggering expression:

{ "flowScheduleName": "Scheduled Flow Created By REST", "flowUuid": "c34de7d6-14cc-4a1c-


b25e-85afbb064359", "triggerExpression": "*/60000", "startDate": 1314079869000, "endDate":
1491302669536, "numOfOccurrences": 5, "runLogLevel": "STANDARD", "timeZone": "Asia/Amman",
"inputPromptUseBlank": false, "inputs": { "input1": "value for input1", "inputn": "value for inputn"
} }

If endDate is not set, by default, it receives a value of 0.

If username is not set, by default, it receives a value of null.

The trigger expression should be either a valid cron expression or a simple expression according the pattern
below.

If you use the cron expression, you can validate it using an expression validity.
If you want to use a simple trigger expression (every x minutes) you should use the syntax according to the
following example:
*/6000 = run every 60000 milliseconds (every minute)

If you use a cron expression you cannot add the numOfOccurences attribute as it
may conflict with the cron expression. In addition, if you use simple triggers and
add both end time and number of occurrences, the triggering ends according to
the number of occurrences.

Response status codes

Code Meaning Returned When

201 Created A schedule was created


successfully.

400 Bad Request


The user does not have Manage
Schedules permission.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 975
Robotic Process Automation 2019.11

403 Forbidden

Response entity body

On success: Returns a JSON object of the created schedule with the following format:

{ "id": "1347298851037", "flowScheduleName": "Scheduled Flow Created By REST", "flowUuid":


"c34de7d6-14cc-4a1c-b25e-85afbb064359", "triggerExpression": "*/60000", "startDate": 1314079869000,
"endDate": 1491302669536, "username": "DavisJ", "numOfOccurrences": 5, "runLogLevel": "STANDARD",
"timeZone": "Asia/Amman", "nextFireTime": -1, "prevFireTime": -1, "enabled": false,
"inputPromptUseBlank": false, "inputs": { "input1": "value for input1", "inputn": "value for inputn"
} }

In addition, a location header containing a URI to retrieve the created schedule for example:
/schedules/1347298851037

{ "flowScheduleName": "Scheduled Flow Created By REST", "flowUuid": "c34de7d6-14cc-4a1c-


b25e-85afbb064359", "triggerExpression": "*/60000", "startDate": 1314079869000, "endDate":
1491302669536, "username": "DavisJ", "numOfOccurrences": 5, "runLogLevel": "STANDARD", "timeZone":
"Asia/Amman", "inputPromptUseBlank": true, "inputs": { "input1": "value for input1", "inputn":
"value for inputn" } }

Enable or disable flow schedule


Request:
PUT /schedules/{ids}/enabled
Description:
Enable or disable existing flow-schedules.
Request path variables:

Attribute Description

ids The identifiers of the flow-schedules to enable or


disable.

Request entity body:


true or false
Response status codes:

Code Meaning Returned When

204 Successful (No Content) The flow-schedules were updated


successfully.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 976
Robotic Process Automation 2019.11

400 Bad Request

403 Forbidden The user does not have Manage


Schedules permissions.

Request entity body:


The body of this request needs to include a JSON value of either true to enable the schedules or false to disable
them.

Delete flow schedule


Request:
DELETE /schedules/{ids}
Description:
Deletes the existing flow-schedules.
Request path variables:

Attribute Description

ids The identifiers of the flow-schedules to be deleted.

Response status codes:

Code Meaning Returned When

200 OK The flow-schedules is deleted


successfully.

400 Bad Request

403 Forbidden The user does not have Manage


Schedules permissions.

Get flow schedule


Request:
GET /schedules
Description:
Returns all existing flow-schedules headers.
Response status codes:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 977
Robotic Process Automation 2019.11

Code Meaning Returned When

200 OK The requested flow-schedules were


found.

403 Forbidden The user does not have View


Schedules or Manage Schedules
permission.

Request parameters:

Attribute Type Description Is required? Default value

start Integer The page number No 1


to return (starting
with 1 for the first
page of results).

pageSize Integer The number of No 50


results in each
page.

direction Predefined Value The direction in No ASC


which to sort the
results: ASC for
ascending or DESC
for descending.

orderBy Predefined Value The schedule No scheduleName


property by which
to sort the results:
scheduleName,
flowName,
nextFireTime,
prevFireTime,
scheduleState or
username.

filter String String to filter by. No No filter

Example:
GET /schedules?start=3&pageSize=20&direction=DESC&orderBy=nextFireTime&filter=my-schedule
Response entity body:

on success: Returns a JSON array, containing all existing flow-schedules headers, with the following format:

[{ "id": "123", "enabled": true, "flowUuid": "78bec456-db6a-4c05-99ad-0675b230bfeb", "nextFireTime":


-1, "prevFireTime": -1, "flowScheduleName": "schedule 1", "flowName": "flow1", "flowPath": "path0",
"username": "admin", "triggerExpression": "0 10 10 ? * 6" }, { "id": "567", "enabled": true,

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 978
Robotic Process Automation 2019.11

"flowUuid": "3d32e475g-ab54-fe21-df32-4743346ebebd", "nextFireTime": -1, "prevFireTime": -1,


"flowScheduleName": "schedule n", "flowName": "flow3", "flowPath": "path2", "username": "admin",
"triggerExpression": null } ]

Get flow schedule details


Request:
GET /schedules/{id}
Description:
Returns details about a flow-schedule specified by ID.
Request path variables:

Attribute Description

id The identifier of the flow-schedule to retrieve.

Response status codes:

Code Meaning Returned When

200 OK The requested flow-schedule was


found.

403 Forbidden The user does not have View


Schedules or Manage Schedules
permission.

404 Not Found The requested flow-schedule was


not found.

Response entity body:

on success: Returns a JSON object of the flow-schedule details with the following format:

{ "id": "1399455773960", "flowScheduleName": "Scheduled Flow Created By REST", "flowUuid":


"c34de7d6-14cc-4a1c-b25e-85afbb064359", "triggerExpression": "0 10 10 ? * 6", "startDate":
1399455780000, "endDate": 1491302669536, "numOfOccurrences": null, "timeZone": "Asia/Amman",
"username": "admin", "runLogLevel": "STANDARD", "nextFireTime": 1399619400000, "prevFireTime": -1,
"enabled": true, "inputPromptUseBlank": false, "inputs": { "input1": "value for input1", "input2":
"value for input2" } }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 979
Robotic Process Automation 2019.11

Update flow schedule


Request:
PUT /schedules/{id}
Description:
Updates an existing flow-schedule. Includes a list of values that can be updated.
Request path variables:

Attribute Description

id The identifier of the flow-schedule to update.

Request entity body:


The body of this request needs to include a JSON object with the following format:

{ "flowScheduleName": "Scheduled Flow Created By REST", "flowUuid": "c34de7d6-14cc-4a1c-


b25e-85afbb064359", "triggerExpression": "0 10 10 ? * 6", "startDate": 1376072040000, "endDate":
1377334800000, "runLogLevel": "STANDARD", "timeZone": "Asia/Amman", "inputPromptUseBlank": false,
"inputs": { "input1": "value for input1", "inputn": "value for inputn" } }

Response status codes:

Code Meaning Returned When

200 OK Returned when update schedule


successfully

400 Bad Request

403 Forbidden The user does not have Manage


Schedules permission.

Response entity body:

On success: Returns a JSON value: true

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 980
Robotic Process Automation 2019.11

Deployment

Deploy content packs


Request
PUT /content-packs/{cpFileName}
Description
Deploys a content pack. The file extension should not be provided in the name.
Response status codes:

Code Meaning Returned When

201 Created Deployment succeed

403 Forbidden The user does not have Manage


Content Packs permission.

417 Expectation Failed Deployment failed

Sample
/content-packs/base-cp
Request path variables

Attribute Description Required

name The name of the content pack to be Yes


deployed.

The body of the request should contain the contents of the content pack file to be
deployed (as a raw stream of bytes).

Response entity body:


On success, returns a JSON value: true

{ "aggregatedSeverity": "Info", "contentPackResponses": { "content pack


file name.jar": { "contentPackUUID": " a4618f99-309d-4537-b67c-
e43dd9f73baa", "contentPackName": "content pack filename.jar",
"message": "content pack file name.jar (author: date:)", "responses": [{
"contentPackName": "content pack file name.jar", "responseCategory":
"Success", "level": "Info",
"message": "Successfully deployed content pack file name.jar" }]

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 981
Robotic Process Automation 2019.11

} } }

The aggregatedSeverity and level attribute receives one of the following values: Info, Warning, and Error.
The responseCategory attribute receives one of the following values:

Success: The content pack was deployed successfully.


ContentPackFile: The content pack file was invalid.
FlowDependency: Cannot deploy the content pack because of missing flow dependency.
OperationDependency: Cannot deploy the content pack because of missing operation dependency.
Overwrite: Cannot deploy the content pack because it can’t overwrite the existed one because of flow/operation
dependencies issues.
ScheduledFlow: A list of scheduled flows that will be affected/deleted if the deployment will be carried out (since
the deployment is trying to delete a flow that is scheduled to run).
Exception: Cannot deploy the content pack because of an unexpected exception.
On error: returns a JSON value:

{ "aggregatedSeverity": "Error", "contentPackResponses": { "cp.jar": {


"contentPackUUID": "N/A", "contentPackName": "cp.jar",
"message": "cp.jar (author: , date: )", "responses": [
{ "contentPackName": "cp.jar",
"responseCategory": "FlowDependency", "level": "Error",
"message": "Missing 'operation'/'flow' with UUID d1bbf441-824a-450e-afae-2ddec0e0f35e, which is
required by the 'flow': 'Library/tesdt/flowwww.xml'." }
] } } }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 982
Robotic Process Automation 2019.11

How can I deploy content packs with progress?

1. Create deployments – Returns deploymentProcessId

2. Upload the deployment process file – Provide the deploymentProcessId

3. Run a specific deployment process – Provide the deploymentProcessId

4. Request the "Get the deployment process object". There are two kinds of responses: "status":"RUNNING" –
with data about the progress and "status":"FINISHED" – with data about the result.

Create deployments

Request

POST /deployments

Description

Create a deployment process object and return the id to the client. You can also use this process to "Delete
content pack from deployment process".

Response status codes

Code Meaning Returned When

201 Created Deployment progress object is


created.

403 Forbidden The user does not have Manage


Content Packs permission.

Sample

"deploymentProcessId":123

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 983
Robotic Process Automation 2019.11

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 984
Robotic Process Automation 2019.11

Upload the deployment process file


Request

POST /deployments/{deploymentProcessId}/files

Description
Uploads one or more content pack files, and associates them with an existing deployment process. The request
should be formatted according to the "multipart/form-data" standard for uploading files to a web server (RFC
2388). The request body should be the contents of the content pack files to be deployed.
Request path variables:

Attribute Description

deploymentProcessId The deployment process ID to associate the files with.


The ID is returned when creating a new deployment
process.

Sample
POST /deployments/109600004/files
Response status codes

Code Meaning Returned When

200 OK The files were uploaded and


associated with the specified
deployment process.

400 Bad Request Some or all of the uploaded files


have failed basic validation.

403 Forbidden The user does not have Manage


Content Packs permission.

404 Not Found The deployment process object with


the specific id does not exist.

409 Conflict Some or all of the uploaded content


packs have already been added to
this deployment process.

500 Internal Server Error The HTTP request was not a valid
"multipart/form-data" request (RFC
2388).

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 985
Robotic Process Automation 2019.11

Response body
The response body includes details for each of the uploaded files. The signDetails property contains the content
pack’s digital signature details. The deleteUrl and deleteType properties represent a REST request, which you can
send to remove the particular file from this deployment process.

{ "files": [{ "name": "cp-signed.jar", "size": 10095,


"fileUploadId": 110800009, "deleteUrl": "/deployments/109600005/files/110800009",
"deleteType": "DELETE", "signDetails": { "signStatus":
"signed", "signedBy": "CN=qa-MAINDC-CA, DC=qa, DC=ad, DC=com",
"warnings": [], "certs": [{
"certType": "X.509", "certDn": "CN=Administrator, CN=Users,
DC=qa, DC=ad, DC=com", "certKeystoreEntryAlias": null,
"validityTimeFrom": 1417599979000, "validityTimeNotAfter":
1480758979000, "validityTimeNotBefore": 0,
"supportCodeSign": false }, {
"certType": "X.509", "certDn": "CN=qa-MAINDC-CA, DC=qa,
DC=ad, DC=com", "certKeystoreEntryAlias": null,
"validityTimeFrom": 1390826569000, "validityTimeNotAfter":
1706359968000, "validityTimeNotBefore": 0,
"supportCodeSign": false } ],
"trusted": false } }] }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 986
Robotic Process Automation 2019.11

Run a specific deployment or delete process


Request
PUT /deployments/{deploymentProcessId}
Description
Run the specific deployment process. Make sure that no other process is running.
Request path variables:

Attribute Description

deploymentProcessId The requested deployment process id. The id is


returned when creating a new deployment process.

Request parameters

Attribute Type Description Is required? Default value

force Boolean Deploy/delete even No false


when there are
warnings (for
example, scheduled
runs for a flow
being deleted).

Samples
PUT /deployments/12345?force=true
PUT /deployments/12345
Response status codes:

Code Meaning Returned When

204 No Content The deployment process has


started successfully.

403 Forbidden The user who executed this


command does not have permission
to manage content packs.

404 Not Found The requested deployment process


is not found.

409 Conflict Another deployment is in process.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 987
Robotic Process Automation 2019.11

500 Bad Request The deployment process status is


not PENDING or there are no
content packs for deployment and
no content packs for deleting, or
there are both content packs for
deployment and content packs for
delete. In addition:
• When this process is already
running or finished.
• There are no content pack files for
deleting.
• Both content pack files for
deployment and content files for
deleting exist together.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 988
Robotic Process Automation 2019.11

Get the deployment process object


Request
GET /deployments/{deploymentProcessId}
Description
Gets the status and details of a previously-created deployment process. A deployment process is usually used
when deploying files with progress, but can also be used for deleting a content pack.
Sample
/deployments/3332190961082830376
Request path variables

Attribute Description

deploymentProcessId The deployment process ID. The ID is returned when


creating a new deployment process.

Response status codes:

Code Meaning Returned When

200 OK The specific deployment process


was found.

403 Forbidden The user does not have Read


Content Packs or Manage Content
Packs permission.

404 Not Found The deployment process object with


the specific id does not exist.

These are the responses:

status:RUNNING – with data about the progress.


status:FINISHED – with data about the result.
status:PENDING – when the deployment was created and files are being uploaded, and before it has started
running.

{ "deploymentProcessId": 137100008, "status": "PENDING", "currentStep":


"Downloading files ", "currentStepIndex": 0, "numOfSteps": 11,
"numOfSubSteps": 0, "currentSubStep": 0, "deploymentResultVO": null }

If your deployment process is still running, the JSON response appears as follows:

{ "deploymentProcessId": 137100005, "status": "RUNNING", "currentStep": "Deploying

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 989
Robotic Process Automation 2019.11

artifacts", "currentStepIndex": 12, "numOfSteps": 16, "numOfSubSteps": 470,


"currentSubStep": 409, "deploymentResultVO": null }

If your deployment process has finished or failed, the JSON appears as follows:

{ "deploymentProcessId": 137100005, "status": "FINISHED", "currentStep":


"Committing data", "currentStepIndex": 16, "numOfSteps": 16,
"numOfSubSteps": 1, "currentSubStep": 0, "deploymentResultVO": {
"aggregatedSeverity": "Info", "contentPackResponses": {
"fv11n-test-content-pack-10.10.182.jar": { "contentPackUUID": "
a4618f99-309d-4537-b67c-e43dd9f73baa", "contentPackName": "fv11n-
test-content-pack-10.10.182.jar", "message": "fv11n-test-content-
pack-10.10.182.jar (author: , date: )", "responses": [{
"contentPackName": "fv11n-test-content-pack-10.10.182.jar",
"responseCategory": "Success", "level": "Info",
"message": "Successfully deployed fv11n-test-content-pack-10.10.182.jar"
}] } } } }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 990
Robotic Process Automation 2019.11

Delete content pack from deployment process


Request
DELETE /deployments/{deploymentProcessId}/files/{fileId}
Description
Delete a specific content pack from a deployment process.
Response status codes:

Code Meaning Returned When

204 No Content The specific file was deleted from


deployment process.

403 Forbidden The user does not have Manage


Content Packs permission.

404 Not Found The deployment process object with


the specific id does not exist.

Delete content packs


1. Run "Create deployments". It returns the deploymentProcessId . Example: POST /deployments
JSON response example:
{
"deploymentProcessId":12345
}

2. Add to the request body a JSON array with the IDs of the Content Pack files that you want to delete, to the
given deploymentProcessId.
Example: POST /deployments/12345/cpsForDelete

3. Run a specific deployment process to the given deploymentProcessId.


Example: PUT /deployments/12345

4. Request "Get the deployment process object".

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 991
Robotic Process Automation 2019.11

Add content pack files for deleting

Request

POST /deployments/{deploymentProcessId}/cpsForDelete

Description

Add content pack files to the deployment process that you want deleted during the process.

Request path variables

Attribute Description

deploymentProcessId The requested deployment process id. The id is


returned when creating a new deployment process.

Sample

POST /deployments/12345/cpsForDelete

Response status codes

Code Meaning Returned When

204 No Content The requested content packs were


added to the deployment process.

403 Forbidden The user who executed this


command does not have permission
to manage content packs.

404 Not Found The requested deployment process


is not found.

500 Bad Request The requested content pack is not


deployed or the deployment
process status is not PENDING.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 992
Robotic Process Automation 2019.11

Request entity body

A string array which contains all of the ids of content packs that should be deleted. To acquire the content pack ID
see "Get content packs" topic.

Example

["39d15573-aad6-44b3-a571-39c98c9bd508","a2c87d2a-2192-4087-8387-763d38246d26"]

Rollback last deployment

Request

DELETE /content-packs/last

Description

Rolls back the last content pack deployment or deletion. Note that only the last action can be rolled back; you
cannot roll back twice in a row.

Response status codes

Code Meaning Returned When

204 Successful (no-content) The last deployed content pack had


been removed

400 Bad Request There was already rollback on the


last revision.

403 Forbidden The user does not have Manage


Content Packs permission.

404 Not Found There is no deployment to rollback.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 993
Robotic Process Automation 2019.11

Content packs
A content pack is a collection of flows, operations, configuration items (selection lists, system accounts, group
aliases, and so on), as well as the binaries required to run actions. A content pack can be created in RPA Workflow
Designer by an author, or it can be provided by Micro Focus or a third party.
The following table lists the metadata for a content pack:

Attribute Type Description Comments

id String The id of the content


pack.

name String The name of the content


pack.

version String The version of the Can be null.


content pack.

publisher String The name of the Can be null.


publisher that created
the content pack.

description String The description of the Can be null.


content pack.

deploymentDate Long Time-stamp in Can be null.


milliseconds when the
deployment of the
content pack started.

signDetails SignDetailsVO The signature details of


the content pack

SignDetailsVO

Attribute Type Description Comments

signStatus String The signature status, can


be: signed, notSigned,
broken, expired, na

signedBy String The issuer distinguished


name of the signature.

warnings List<String> List of signing warnings Can be empty.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 994
Robotic Process Automation 2019.11

certs List< CertSignVO> List of all signature’s CAs. Can be empty.

trusted boolean Whether the CA is trusted


by RPA or not (The CA
should be imported into
the client.truststore)

CertSignVO

Attribute Type Description Comments

certType String The type of the certificate

certDn String The subject of the


certificate

certKeystoreEntryAlias String The CA entry alias

validityTimeFrom long The from date of the milliseconds


certificate validity

validityTimeNotAfter long The not after (end) date milliseconds


of the certificate validity

validityTimeNotBefore long The not before date of milliseconds


the certificate validity

supportCodeSign boolean True if the certificate is


designed to be a code
signer

Get content packs


Request
GET /content-packs
Description
Retrieves a list of all the deployed content packs and with the related details.
Request parameters

Attribute Type Description Is required? Default value

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 995
Robotic Process Automation 2019.11

active Boolean Allows you to No False


retrieve either a list
of all content packs
including content
(flows, operations
and configuration
items) and binaries
or content packs
including just
content.

Sample
GET /content-packs
GET /content-packs?active=false
Response status codes

Code Meaning Returned When

200 OK The requested content pack was


returned.

403 Forbidden The user who executed this


command does not have permission
to view content packs.

Response entity body


An array which contains all of the content packs which are deployed in the central.
Each element in the array represents a content pack. See the content pack meta-data table in "Content packs"
topic.
The returned array is ordered by descending deployment times, in other words, the content pack that was
deployed last will be first.
Example

[{ "name": "cp-with-only-success-flow", "version": "10.30.2", "id": "a4deec31-


f10e-4249-9a71-7309fe0dbc5a", "publisher": "OO Tests", "description": "OO cp-with-
only-success-flow Test Content Pack", "deploymentDate": 1418208680626, "deployedBy":
"anonymousUser", "signDetails": { "signStatus": "signed",
"signedBy": "CN=qa-MAINDC-CA, DC=qa, DC=ad, DC=com", "warnings": [],
"certs": [{ "certType": "X.509",
"certDn": "CN=Administrator, CN=Users, DC=qa, DC=ad, DC=com",
"certKeystoreEntryAlias": null, "validityTimeFrom": 1417599979000,
"validityTimeNotAfter": 1480758979000, "validityTimeNotBefore": 0,
"supportCodeSign": false }, {
"certType": "X.509", "certDn": "CN=qa-MAINDC-CA, DC=qa, DC=ad,
DC=com", "certKeystoreEntryAlias": null,
"validityTimeFrom": 1390826569000, "validityTimeNotAfter":
1706359968000, "validityTimeNotBefore": 0,
"supportCodeSign": false } ], "trusted":

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 996
Robotic Process Automation 2019.11

false, "exportable": true } }]

Get single content pack details


Request
GET /content-packs/{id}
Description
Retrieves details of the specified deployed content pack.
Request path variables

Attribute Description Type

id The requested content pack’s id. int


The id may be acquired by
retrieving the list of all content
packs and extracting the id of
element of the required content
pack by its name.

Sample
GET /content-packs/b137e165-f4f7-4201-b262-2265c8085d27
Response status codes

Code Meaning Returned When

200 OK The requested content pack was


returned.

401 Unauthenticated The user did not authenticate and


anonymous authentication is not
allowed.

403 Forbidden The user who executed this


command does not have permission
to view content packs.

404 Not Found The requested content pack was


not found.

Response entity body


A content pack element which represents the details of requested Content Pack.

{ "name": "cp-with-only-success-flow", "version": "10.30.2", "id": "a4deec31-


f10e-4249-9a71-7309fe0dbc5a", "publisher": "OO Tests", "description": "OO cp-with-
only-success-flow Test Content Pack", "deploymentDate": 1418208680626, "deployedBy":

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 997
Robotic Process Automation 2019.11

"anonymousUser", "signDetails": { "signStatus": "signed",


"signedBy": "CN=qa-MAINDC-CA, DC=qa, DC=ad, DC=com", "warnings": [],
"certs": [{ "certType": "X.509",
"certDn": "CN=Administrator, CN=Users, DC=qa, DC=ad, DC=com",
"certKeystoreEntryAlias": null, "validityTimeFrom": 1417599979000,
"validityTimeNotAfter": 1480758979000, "validityTimeNotBefore": 0,
"supportCodeSign": false }, {
"certType": "X.509", "certDn": "CN=qa-MAINDC-CA, DC=qa, DC=ad,
DC=com", "certKeystoreEntryAlias": null,
"validityTimeFrom": 1390826569000, "validityTimeNotAfter":
1706359968000, "validityTimeNotBefore": 0,
"supportCodeSign": false } ], "trusted":
false, "exportable": true } }

Get content pack contents tree


Request
GET /content-packs/{id}/content-tree
Description
Returns a flat list that of the contents of the content pack in tree-nodes format.
Request path variables

Attribute Description

id The requested content pack’s id. The id may be


acquired by retrieving the list of all content packs and
extracting the id of element of the required content
pack by its name.

Sample
GET /content-packs/b137e165-f4f7-4201-b262-2265c8085d27/content-tree
Response status codes

Code Meaning Returned When

200 OK The requested content pack’s


contents were returned.

403 Forbidden The user who executed this


command does not have permission
to view content packs.

404 Not Found The requested content pack was


not found.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 998
Robotic Process Automation 2019.11

Response entity body


An array of elements which represents one or two trees that contain all of the entities contained in the content
pack.
Each element in the array represents a tree node which is either a folder (which isn’t a leaf and has children) or a
content element (which is a leaf and doesn't not have children).
The returned array is ordered in the following way: first the tree whose root is the "Library" folder, then the tree
whose root is the "Configuration" folder. Each tree is ordered alphabetically by the path attribute.

Attribute Type Description Comments

id String The id of node. For a non-leaf (folder)


node, the id is the same
as the path. For a leaf
node (deployed entity),
the id is the entity’s id.

name String The name of the node. Folder name or deployed


entity name.

parentId String The id of the parent node. Null if this is a root node.

leaf Boolean Whether the node is a


leaf or not.

path String The path of the node.

type Predefined The type of node.


Value Possible values: FOLDER,
FLOW, OPERATION,
CATEGORY, DOMAIN_
TERM, GROUP_ALIAS,
ROLE_ALIAS, SCRIPTLET,
SELECTION_LIST,
SYSTEM_ACCOUNT,
SYSTEM_ EVALUATOR,
SYSTEM_FILTER,
SYSTEM_PROPERTY

Response code

[{ "id": "Library", "name": "Library", "parentId": null,


"leaf": false, "path": "Library", "type": "FOLDER" }, {
"id": "Library/MyFlows", "name": "MyFlows", "parentId": "Library",
"leaf": false, "path": "Library/MyFlows", "type": "FOLDER"
}, { "id": "a3e6572a-8268-4124-9ccb-b3d7e46e5051", "name":
"my-flow1", "parentId": "Library/MyFlows", "leaf": true,
"path": "Library/MyFlows/my-flow1.xml", "type": "FLOW" }, {
"id": "ddee425f-f259-4012-b799-51e0fa40151a", "name": "my-flow2",
"parentId": "Library/MyFlows", "leaf": true, "path":
"Library/MyFlows/my-flow2.xml", "type": "FLOW" }, {

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 999
Robotic Process Automation 2019.11

"id": "Library/MyOperations", "name": "MyOperations", "parentId":


"Library", "leaf": false, "path": "Library/MyOperations",
"type": "FOLDER" }, { "id": "17c8bb11-bbd8-4b1b-bfaa-5c3f1ef90051",
"name": "operation1", "parentId": "Library/MyOperations", "leaf":
true, "path": "Library/MyOperations/my-operation.xml", "type":
"OPERATION" }, { "id": "Configuration", "name":
"Configuration", "parentId": null, "leaf": false,
"path": "Configuration", "type": "FOLDER" }, { "id":
"Configuration/Categories", "name": "Categories", "parentId":
"Configuration", "leaf": false, "path": "Configuration/Categories",
"type": "FOLDER" }, { "id": "6a3a17c4-2c84-46c9-bef6-e043433878d6",
"name": "my-category", "parentId": "Configuration/Categories",
"leaf": true, "path": "Configuration/Categories/my-category.xml",
"type": "CATEGORY" }, { "id": "Configuration/Domain Terms",
"name": "Domain Terms", "parentId": "Configuration", "leaf": false,
"path": "Configuration/Domain Terms", "type": "FOLDER" }, {
"id": "2bc8c8e3-b742-43e5-8038-7c060dc8df77", "name": "my-domain-term",
"parentId": "Configuration/Domain Terms", "leaf": true, "path":
"Configuration/Domain Terms/my-domain-term.xml", "type": "DOMAIN_TERM" } ]

Get content pack statistics


Request
GET /content-packs/statistics
Description
Retrieves the content pack usage statistics according to the given request parameters. A content pack will be
counted if it is actually used by the executed flow (as an operation or subflow). Each content pack will be counted
at most once for every execution. Once an execution ends, it will take 10 to 20 minutes to show up in the statistics.
Request parameters

Attribute Type Description Required

cpNames List of Strings The content pack names No


to retrieve the statistics
for. An empty list means
all the content packs.
Note that the content
pack does not have to be
currently deployed.

months List of numbers The months to retrieve No


the statistics for. An
empty list means all
months.

years List of numbers The years to retrieve the No


statistics for. An empty
list means all years.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1000
Robotic Process Automation 2019.11

Sample
GET/content-packs/statistics?cpNames=Base,Solutions&months=1,2,3&years=2015
Response status codes

Code Meaning Returned When

200 OK The requested content pack


statistics was returned.

403 Forbidden The user who executed this


command does not have permission
to view or manage content packs.

Response entity body


A map containing all of the content pack statistics that match the request.
The first level of the map is the statistics years. Each year is mapped to the different months, and each month
contains the statistic element. This statistics element contains the total runs for that year and month and a map of
content packs with their total runs.
Example

{ "2014": { "12": { "total": 6500,


"cps": { "Base": 6200, "Solutions":
1600, "Database": 300 } }
}, "2015": { "1": { "total": 7000,
"cps": { "Base": 7000, "Solutions":
2000, "Database": 1300 } },
"2": { "total": 1000, "cps": {
"Base": 950, "Solutions": 400 }
} } }

Get content pack changes


Request
GET /content-packs/{id}/changes
Description
Retrieves all deployed entities changes from the last deployment of this content pack.
Request path variables

Attribute Description

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1001
Robotic Process Automation 2019.11

id The requested content pack’s id. The id may be


acquired by retrieving the list of all content packs and
extracting the id of element of the required content
pack by its name.

Sample
GET /content-packs/b32b3a3d-0d7a-4780-85a1-5438987803ef/changes
Response status codes

Code Meaning Returned When

200 OK The requested content pack’s


changes were returned.

403 Forbidden The user who executed this


command does not have permission
to view content packs.

404 Not The requested content pack was


Found not found.

Response entity body


An array which contains all of the deployed entities changes from the last deployment of this content pack.
Each element in the array represents a change to a deployed entity. The returned array is not ordered.

Attribute Type Description Comments

id String The id of the deployed


entity.

changeType Predefined The type of change that


Value occurred. Possible values:
ADD: The deployed entity
was added.
DEL: The deployed entity
was deleted.
MOD: The deployed
entity was modified
(name changed, moved,
xml changed, value
changed)

oldCpName String The name of the content Null if the content pack
pack that the entity name hasn’t changed.
belonged to before the
last deployment.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1002
Robotic Process Automation 2019.11

oldPath String The path of the entity in Null if the path has not
the old content pack. changed.

currentPath String The current path of the


entity.

entityType Predefined The type of entity that


Value changed. Possible values:
FLOW, OPERATION,
CATEGORY,
DOMAIN_TERM,
GROUP_ALIAS,
ROLE_ALIAS, SCRIPTLET,
SELECTION_LIST,
SYSTEM_ACCOUNT,
SYSTEM_ EVALUATOR,
SYSTEM_FILTER, SYSTEM_
PROPERTY

xmlChanged Boolean Whether the entity’s xml


was changed or not.

Example

[{ "id": "c8100970-8044-4d70-abbe-72f1a4ace903", "changeType": "ADD",


"oldCpName": null, "oldPath": null, "currentPath": "Library/cp-
filters/Set of filters/ops/op - set of filters TC3 validation.xml", "entityType":
"OPERATION", "xmlChanged": false }, { "id":
"e3aac28a-b430-47e9-b285-342fa7e2310f", "changeType": "DEL",
"oldCpName": null, "oldPath": "Library/my-flows/delete-this-flow.xml",
"currentPath": null, "entityType": "FLOW", "xmlChanged": false
}, { "id": "1465b8aa-1ce6-4b2a-a3d3-d6214bd7b025",
"changeType": "MOD", "oldCpName": "old-cp", "oldPath": "Library/my-
flows/subflows.xml", "currentPath": "Library/events/Flow with subflows.xml",
"entityType": "FLOW", "xmlChanged": false } ]

Enable assign content pack feature


Request
POST /oo-designer/rest/v0/xfeatures/{workspace_id}
Description
Enables an assign feature to the workspace ID.
Sample

curl -X POST --header "Content-Type: application/json" --header "Accept: */*" --header "X-CSRF-
TOKEN: f2e55754-1681-4d89-b8d2-918b478e522c" -d "{ \"name\": \"assign_cp\", \"visible\": true }"
"https://myd-hvm01996.swinfra.net:8446/oo-designer/rest/v0/xfeatures/312"

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1003
Robotic Process Automation 2019.11

Response status codes

Code Meaning Returned When

200 OK The assign content pack is enabled.

Response entity body

{ "assign_cp": true, "hybrid_debugger": true, "open_afl": true, "debugger": true,


"hybrid_authoring": true }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1004
Robotic Process Automation 2019.11

Configuration items
This sections contains information on APIs related to configuration items.

Get a configuration item for a content


Request
GET /config-items/{type}/{path}
Description
Returns a Configuration Item, such as a System Account.
Request path variables

Attribute Description

type The type of the Configuration Item to return.


Supported types:
domain-terms, group-aliases, selection-lists, system-
accounts, system-properties

path The relative path of the Configuration Item.


For example, if the item is stored at
Configuration/System
Accounts/folder/sa.xml, the relative path is folder/sa.
Note: Paths are case-sensitive in RPA Central.

Sample
GET /config-items/system-accounts/folder1/folder2/sa1
Response status codes

Code Meaning Returned When

200 Successful (OK) Successful

403 Forbidden The user is not allowed to view


Configuration Items

404 Not Found The Configuration Item does not


exist, or the given type is not
supported.
For System Accounts, this can also
mean the user does not have
privileges to access this particular
item.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1005
Robotic Process Automation 2019.11

Response body
On success, returns a JSON object with the following properties:

Attribute Description Type

type The Configuration Item type, in the Predefined


same format as given in the request Value
URI (see above).

path The item’s relative path, as given in String


the request URI (see above)

name The item’s name String

value The item’s actual value, as will be String


used in flow execution. This will be
the same as customValue if set,
otherwise it will be the same as
defaultValue.
• For Domain Terms and Selection
Lists, the value is a pipe- delimited
collection of values. For example:
"First Value|Second Value|Third
Value".
• For System Accounts, the value is
formatted as a JSON object with
properties username and password
(see example below). Note that the
server never sends passwords; they
are masked as asterisks.

defaultValue The item’s default (deployed) value String

customValue The item’s custom (override) value, String


which can be set in Central or
through REST

sensitive True when the entire value of the Boolean


configuration item is hidden

fullPath The item’s full path in the Content String


Pack, including the .xml suffix

uuid The item’s UUID – will be null if this String


item is not deployed (or if it is a
duplicate)

referencedId The ID used to reference the String


configuration item in flows and
REST API

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1006
Robotic Process Automation 2019.11

Example

{ "type": "system-accounts", "path": "folder1/folder2/sa1", "name": "sa1",


"value": "{\"username\":\"admin\",\"password\":\"************\"}", "defaultValue":
"{\"username\":\"admin\",\"password\":\"************\"}", "customValue": null,
"fullPath": "Configuration/System Accounts/sa1.xml", "uuid": "4f32bcb8-969c-470f-9803-
f823b72a9436" }

Get configuration items by type for a content


Request
GET /config-items/{type}
Description
Returns all Configuration Items of the specified type.
Request path variables

Attribute Description

type The type of the Configuration Item to return.

Sample
GET /config-items/system-accounts
Response status codes

Code Meaning Returned When

200 Successful (OK) Successful

403 Forbidden The user is not allowed to view


Configuration Items

404 Not Found The given type is not supported

Response body
On success, returns a JSON array of Configuration Items. The array will be empty if there are no items of the
requested type.
For the format of each item, see Get a configuration item for a content.

Get all configuration items for a content


Request
GET /config-items

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1007
Robotic Process Automation 2019.11

Description
Returns all Configuration Items of the supported types.
Response status codes

Code Meaning Returned When

200 Successful (OK) Successful

403 Forbidden The user is not allowed to view


Configuration Items

Response body
Returns a JSON array of Configuration Items (will be empty if there are none).

Set a configuration items value for a content


Request
PUT /config-items/{type}/{path}
Description
Sets (or clears) the custom value of an existing Configuration Item, such as a System Account. If the item has a
default (deployed) value, the custom value will override it.
Request path variables

Attribute Description

type The type of the Configuration Item to return.

path The relative path of the Configuration Item.

Sample
PUT /config-items/system-accounts/folder1/folder2/sa1
Request body
The body must include the new value as a JSON string. To clear the value, put null in the body.
Examples

"some value"

"some value with \"quotes\" in it"

null
"{\"username\":\"user1\",\"password\":\"pass1\"}"
Response status codes

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1008
Robotic Process Automation 2019.11

Code Meaning Returned When

200 Successful (OK) Successful

400 Bad Request The given value is not valid JSON


(must be either a string or null), or
it is not formatted correctly for this
Configuration Item’s type

403 Forbidden The user is not allowed to manage


Configuration Items

404 Not Found The Configuration Item does not


exist, or the given type is not
supported
For System Accounts, this can also
mean the user does not have
privileges to access this particular
item.

Some Configuration Item types expect a particular value format.


Response body
On success, returns the updated Configuration Item.

Delete a configuration item of a content


Request
DELETE /config-items/{type}/{path}
Description
Deletes a Configuration Item, such as a System Account. Note that this will fail if the item to delete is currently
marked as deployed (in other words, its uuid property is not null).

To delete a deployed Configuration Item, remove it from the Content Pack and redeploy.

If you want to clear the override value.


Request path variables

Attribute Description

type The type of the Configuration Item to return.

path The relative path of the Configuration Item.

Sample
DELETE /config-items/system-accounts/folder1/folder2/sa1

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1009
Robotic Process Automation 2019.11

Response status codes

Code Meaning Returned When

200 Successful (OK) Successful

403 Forbidden The Configuration Item is currently


deployed (its uuid property is not
null), or the user is not allowed to
manage Configuration Items

404 Not Found The Configuration Item does not


exist, or the given type is not
supported.
For System Accounts, this can also
mean the user does not have
privileges to access this particular
item.

Response body
On success, returns the deleted Configuration Item.

Get content configuration tree


Request
GET /config-items/tree
Description
Returns the content configuration tree.
Sample
GET /config-items/tree
Response status codes

Code Meaning Returned When

200 Successful (OK) Successful. If there are no results,


the result will be empty.

Response entity body

[{ "id": "Configuration", "parentId": null, "leaf": false,


"path": "Configuration", "name": "Configuration", "type": "FOLDER",
"icon": null }, { "id": "Configuration/Group Aliases",
"parentId": "Configuration", "leaf": false, "path":
"Configuration/Group Aliases", "name": "Group Aliases", "type":
"FOLDER", "icon": null }, { "id":

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1010
Robotic Process Automation 2019.11

"Configuration/Group Aliases/RAS_Operator_Path.xml", "parentId":


"Configuration/Group Aliases", "leaf": true, "path":
"Configuration/Group Aliases/RAS_Operator_Path.xml", "name": "RAS_Operator_Path",
"type": "GROUP_ALIAS", "icon": null, "workerGroup":
"RAS_Operator_Path", "deployed": true }, { "id":
"Configuration/System Accounts/central_user.xml", "parentId": "Configuration/System
Accounts", "leaf": true, "path": "Configuration/System
Accounts/central_user.xml", "name": "central_user", "type":
"SYSTEM_ACCOUNT", "icon": null, "deployedValue": "sa-change-it-
case", "overrideValue": null, "sensitive": false,
"deployed": true, "referencedId": "central_user" }, {
"id": "Configuration/System Properties/rerunSystemProperty.xml", "parentId":
"Configuration/System Properties", "leaf": true, "path":
"Configuration/System Properties/rerunSystemProperty.xml", "name":
"rerunSystemProperty", "type": "SYSTEM_PROPERTY", "icon": null,
"deployedValue": "************", "overrideValue": null, "sensitive":
true, "deployed": true, "referencedId": "rerunSystemProperty"
} ]

Get configuration item details


Request
GET /config-items/{type}/{path}?details=true
Description
Returns the deployed entity data of a configuration item
Sample
GET /config-items/system-accounts/folder1/folder2/sa1?details=true
Request path variables

Attribute Description

type The type of the Configuration Item to return.

path The relative path of the Configuration Item.

Request parameters
This API requires the parameter "details=true", otherwise it will be treated as Get a configuration item for a
content API. There are no other parameters.
Response status codes

Code Meaning Returned When

200 Successful (OK) The requested path was found.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1011
Robotic Process Automation 2019.11

403 Forbidden The user is not allowed to view


Configuration Items

404 Not Found The Configuration Item does not


exist, or the given type is not
supported.
For System Accounts, this can also
mean the user does not have
privileges to access this particular
item

Response entity body


On success, returns a JSON object with the following format:

{ "id": "2283acc2-95f0-4cc4-8f45-e5053ace7aaf", "name": "some-prop", "path":


"Configuration/System Properties/some-prop.xml", "description": "This is just some
property", "cpName": "cp-props", "version": "10.20.01 " }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1012
Robotic Process Automation 2019.11

Audit events
Robotic Process Automation now gives you the option to audit events, so that you can track security breaches.
Auditing lets you track actions that took place on Central, such as logins, triggering flows, creating schedules,
editing configurations, and so on.

Get audit configuration


Request
GET /audit/config
Description
Gets the audit configuration.
Response status codes

Code Meaning Returned When

200 Successful (OK) The requested contents were


returned.

403 Forbidden The user attempting to execute this


command does not have the View
Security
Configuration or the Manage
Security Configuration permissions.

Response entity body

Attribute Type Description Comment

enabled Boolean True when auditing is


enabled. False when
auditing is disabled.

Sample
{"enabled":true}

Update audit configuration


Request
PUT /audit/config
Description

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1013
Robotic Process Automation 2019.11

Updates the audit configuration.


Request entity body

Attribute Type Description Required Default

enabled Boolean True to enable Yes


auditing. False to
disable auditing.

Sample
{"enabled":true}
Response status codes

Code Meaning Returned When

200 Successful (OK) The audit configuration was


updated successfully.

400 Bad Request The data in the request body is


invalid.

403 Forbidden The user attempting to execute this


command does not have the
Manage
Security Configuration permission.

Response entity body


Returns the updated audit configuration object.
Example
{"enabled":true}

Get audit records


Request
GET /audit/records
Description
Returns a page of the audit records that were recorded in reverse chronological order.
Request parameters

Attribute Type Description Required Default

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1014
Robotic Process Automation 2019.11

sortDescending Boolean Whether to sort by No true


descending order. If
false – sort by
ascending order.

pageNum Integer The number of the No 1


returned page. This
must be a positive
(>0) number.

pageSize Integer The number of No 50


records in the
returned page.
This must be a
positive (>0)
number.

Sample
GET /audit/records?sortDescending=false&pageNum=2&pageSize=10
Response status codes

Code Meaning Returned When

200 Successful (OK) The requested contents were


returned.

400 Bad Request If any of the arguments are invalid.

403 Forbidden The user attempting to execute this


command does not have the View
Audit permission.

Response entity body


An array which contains all of the events which were audited and meet the filtering criteria. Each element in the
array represents an audited event.

Attribute Type Description Comment

time Long The audit time

type Predefined The type of operation


Type being audited.
Possible values: See the
"Audit types or groups"
table.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1015
Robotic Process Automation 2019.11

group Predefined The group to which the


Type operation being audited
belongs.
Possible values: See the
"Audit types or groups"
table.

subject String The user that performed


the operation being
audited.
If the operation is a
general system event,
the subject will be the
default user name
(anonymousUser).

outcome Predefined The outcome of the


Type operation being audited.
Possible values:
Success, Failure and
System Error

data String The extra audit data In JSON key/value format


specific to the type of
operation being audited.

Example

[{ "time": 1412312016740, "type": "AuditConfigurationChange",


"group": "AuditManagement", "subject": "mydomain/myuser2",
"outcome": "Success", "data": { "enabled": "false"
} }, { "time": 1412312016722, "type":
"InternalUserDelete", "group": "Authentication-Authorization",
"subject": "mydomain/myuser2", "outcome": "Success", "data": {
"usersNames": ["admin"] } } ]

Delete audit records


Request
DELETE /audit/records
Description
Delete the audit records according to the request parameters. Returns the number of records that were actually
deleted.
Request parameters

Attribute Type Description Required Default

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1016
Robotic Process Automation 2019.11

timeBefore Long Records of Yes


operations that
were audited before
this time will be
purged. In UTC time
format.

maxAmount Integer The maximum No 1000


amount of records
to delete.
Note: In some cases
the number of
records deleted
might be slightly
larger than the
maxAmount that
was passed.

Sample
DELETE /audit/records?timeBefore=1387218013000&maxAmount=3000
Response status codes

Code Meaning Returned When

200 Successful (OK) The requested contents were


deleted.

400 Bad Request If any of the arguments are invalid.

403 Forbidden The user attempting to execute this


command does not have the
Manage
Data Cleanup permission

Response entity body


On success, returns the number of audit records that have been deleted. This number might be higher than the
maxAmount parameter that was passed.

Audit types or groups

Type Group

CentralStartup CentralLifecycle

CentralShutdown CentralLifecycle

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1017
Robotic Process Automation 2019.11

AuditConfigurationChange AuditManagement

AuthenticationFailure Authentication-Authorization

AuthorizationFailure Authentication-Authorization

LoginAttempt Authentication-Authorization

Logout Authentication-Authorization

AuthenticationConfigurationUpdate Authentication-Authorization

CaptureCredentialsConfigurationUpdate Authentication-Authorization

RoleCreate Authentication-Authorization

RoleUpdate Authentication-Authorization

RolesDelete Authentication-Authorization

RoleSetDefault Authentication-Authorization

LDAPConfigurationCreate Authentication-Authorization

LDAPConfigurationUpdate Authentication-Authorization

LDAPConfigurationsDelete Authentication-Authorization

InternalUserCreate Authentication-Authorization

InternalUserUpdate Authentication-Authorization

InternalUsersDelete Authentication-Authorization

SAMLConfigurationCreate Authentication-Authorization

SAMLConfigurationUpdate Authentication-Authorization

SAMLConfigurationDelete Authentication-Authorization

SSOConfigurationUpdate Authentication-Authorization

PathEntitlementUpdate Authentication-Authorization

RunTriggered Runs

RunStatusChange Runs

ScheduleCreate Runs

ScheduleEdit Runs

SchedulesEnable Runs

SchedulesDisable Runs

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1018
Robotic Process Automation 2019.11

SchedulesDelete Runs

DeploymentProcessCreate ContentDeployment

ContentUploadToDeploymentProcess ContentDeployment

ContentRemoveFromDeploymentProcess ContentDeployment

ContentForDeleteAddToDeploymentProcess ContentDeployment

DeploymentProcessStart ContentDeployment

ContentDeployment ContentDeployment

ContentRollback ContentDeployment

ContentDelete ContentDeployment

GroupAliasCreate ContentConfiguration

GroupAliasUpdate ContentConfiguration

GroupAliasesDelete ContentConfiguration

SystemAccountCreate ContentConfiguration

SystemAccountUpdate ContentConfiguration

SystemAccountsDelete ContentConfiguration

ContentConfigurationItemCreate ContentConfiguration

ContentConfigurationItemUpdate ContentConfiguration

ContentConfigurationItemDelete ContentConfiguration

WorkerRegister TopologyManagement

WorkersDelete TopologyManagement

WorkerUpdate TopologyManagement

WorkersUpdate TopologyManagement

WorkersAssignToGroup TopologyManagement

WorkersRemoveFromGroup TopologyManagement

ExternalUrlCreateOrUpdate TopologyManagement

ExternalUrlDelete TopologyManagement

SystemConfigurationCreateOrUpdate SystemConfiguration

SystemConfigurationUpdate SystemConfiguration

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1019
Robotic Process Automation 2019.11

SystemConfigurationDelete SystemConfiguration

FlowRerun Runs

RerunDataPurging Runs

RunDataPurging Runs

AddReverseRAS TopologyManagement

UpdateReverseRAS TopologyManagement

ForwardProxyCreateOrUpdate TopologyManagement

ForwardProxyDelete TopologyManagement

TestConnectionToReverseRAS TopologyManagement

RasUpgradeUploadFile TopologyManagement

RasUpgradeDeleteFile TopologyManagement

RasUpgradePrepare TopologyManagement

RasUpgradeStart TopologyManagement

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1020
Robotic Process Automation 2019.11

LDAP configuration
The LDAP API allows you to configure your organization’s LDAP.
This enables users to log in with their organizational credentials and for the administrator to map LDAP groups to
RPA Roles.
The LDAP API includes a test API to verify configurations are going to be set correctly before saving them. It is
recommended to set LDAP configurations when you want to authenticate users and not rely on the internal users
feature, which are less secure.
Although with the LDAP API the configurations are set, you should enable the system authentication for them to
take place.
In the case both the LDAP configurations and internal users were set, the LDAP settings override the internal user
settings, if there is a collision between user IDs.

API supported with multiple LDAPs


If your organization works with multiple LDAP servers, it is now possible to configure Central to work with all of
them. This includes LDAPs with different schemes and from different vendors. For example, you might have an
Active Directory (Microsoft LDAP) implementation for one part of the organization and a Sun One (Oracle LDAP)
implementation for another part.

Get LDAP configuration by ID


Request: GET /authns/ldap-config/{id}
Description: Retrieves an LDAP configuration according to the specified ID.
Response status codes:

Code Meaning Returned When

200 Successful (OK) LDAP was retrieved successful.

403 Forbidden User does not have view/manage


security configurations permissions.

404 Not found The requested LDAP does not exist.

Response entity body:

Attribute Type Description

id String The ID for the returned LDAP.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1021
Robotic Process Automation 2019.11

type Predefined The type of the LDAP.


Value

domain String The domain of the LDAP.

addresses An array of The address of the LDAP and other


Address addresses for the case of failover.

securedChannel boolean True if a secured channel is used


(SSL).

enabled boolean Whether the returned LDAP is


operational.

privilegedUser String The DN of a user with search


capabilities on the provided User &
Group DNs. In case the LDAP type is
ACTIVE_DIRECTORY the exact user
name will be returned (and not a
DN).

privilegedUserPassword String Indicates whether a password for


the privileged user was provided.
"********" appears when a
password was set.

groupsDns String[] The DNs on which to apply the


groups filter for search.

groupsSearchRecursive boolean Whether groups search should be


recursive.

groupsFilter String A search filter to apply on the


groups DNs.

usersDns String[] The DNs on which to apply the


users filter for search.

usersSearchRecursive boolean Whether users search should be


recursive.

userCommonNameAttribute String The attribute of the user which


should be used for display
purposes.

userEmailAttribute String The attribute of the user which


contains the mail address.

groupMembershipAttribute String In ACTIVE_DIRECTORY type, this


represents the attribute of the user
which contains the groups. In any
other type, it is null.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1022
Robotic Process Automation 2019.11

groupNameAttribute String The attribute of the group which


contains the group's name used for
mapping Roles to Groups.

usersFilter String A search filter to apply on the users


DNs.

customGroupsAttributesNames String Attribute names that will be used as


groups. Separated by semicolon.

Example:

{ "id": "72cdc1a7-1005-4800-a412-5e4a9b8f6bec", "type": "OPEN_DJ", "domain": "Indigo", "addresses":


[ { "port": 389, "host": "mysite.com" }, { "port": 389, "host": "mysite.com" }, { "port": 3021,
"host": "mysite.com" } ], "securedChannel": false, "enabled": true, "privilegedUser":
"uid=user,ou=people,dc=HPE,dc=com", "privilegedUserPassword": "********", "groupsDns": [
"ou=products,dc=HPE,dc=com" ], "groupsSearchRecursive": true, "groupsFilter": "(uniqueMember={0})",
"groupNameAttribute": "cn", "usersFilter": "(&(objectclass=person)(uid={0}))", "usersDns": [
"ou=people,dc=HPE,dc=com" ], "usersSearchRecursive": true, "userCommonNameAttribute": "cn",
"userEmailAttribute": "mail", "groupMembershipAttribute": null, "customGroupsAttributesNames": null
}

Create a new LDAP configuration


Request: POST /authns/ldap-config
Description: Creates an LDAP configuration.
Response status codes:

Code Meaning Returned When

201 Successful (Created) LDAP was successfully created

400 Bad Request Client didn’t provide the mandatory


field or provided some fields with
wrong format.

403 Forbidden User does not have manage


security configuration permissions.

409 Conflict The provided domain already


exists.

Request body:

Attribute Type Description Required? Default value

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1023
Robotic Process Automation 2019.11

type Predefined The type of LDAP. No OTHER


Value

domain String The domain of the Yes


LDAP. For Active
Directory this must be
a real domain that can
be bound on. In all
other cases any name
is suitable.

addresses An array of The address of the Yes


Address LDAP and other
addresses for the case
of fail-over.

securedChannel boolean True if a secured No False


channel should be used
(SSL).

enabled boolean Whether the provided No False


LDAP should be
operational.

privilegedUser String The DN of a user with No None


search capabilities on
the provided User and
Group DNs. In case the
LDAP type is ACTIVE_
DIRECTORY the exact
user name should be
provided (and not a
DN). If the LDAP allows
anonymous search, this
field is not required.

privilegedUserPasswor String The password of the No None


d privileged user.

groupsDns String[] The DNs on which to Required for types


apply the groups filter other than ACTIVE_
for search. DIRECTORY and
ALTERNATE_ GROUP

groupsSearchRecursiv boolean Whether groups search No False


e should be recursive

groupsFilter String A search filter to apply Required for types


on the groups DNs. other than ACTIVE_
DIRECTORY and
ALTERNATE_ GROUP

usersDns String[] The DNs on which to Yes


apply the users filter
for search.

usersSearchRecursive boolean Whether users search No False


should be recursive

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1024
Robotic Process Automation 2019.11

userCommonNameAtt String The attribute of the Yes


ribute user which should be
used for display
purposes.

userEmailAttribute String The attribute of the No None


user which contains the
mail address

groupMembershipAttri String In ACTIVE_ DIRECTORY Required only for Mandatory for


bute type, this represents ACTIVE_ DIRECTORY ACTIVE_
the attribute of the type. DIRETORY
user which contains the
groups. In any other
type, it is null.

groupNameAttribute String The attribute of the Required for all types


group which contains other than
the group's name used ALTERNATE_ GROUP.
for mapping Roles to
Groups.

usersFilter String A search filter to apply Yes


on the users DNs.

customGroupsAttribut String Attribute names that Required only for


esNames will be used as groups. ALTERNATE_ GROUP
Separated by type
semicolon.

Example:

[{ "type": "OPEN_DJ", "domain": "MyDomain", "addresses": { "host": "mysite.com", "port": "389" } },


{ "securedChannel": false, "enabled": true, "privilegedUser": "uid=user,ou=people,dc=HPE,dc=com",
"privilegedUserPassword": "1234", "groupsDns": [ "ou=products,dc=HPE,dc=com" ] }, {
"groupsSearchRecursive": true, "groupsFilter": "(uniqueMember={0})", "groupNameAttribute": "cn",
"usersFilter": "(&(objectclass=person)(uid={0}))", "usersDns": ["ou=people,dc=HPE,dc=com"],
"usersSearchRecursive": true, "userCommonNameAttribute": "cn" } ]

Response entity body:

LdapConfig for successful request.


RestError for unsuccessful response.

Get all LDAP configurations


Request: GET /authns/ldap-config
Description: Retrieves all the configured LDAPs.
Response status codes:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1025
Robotic Process Automation 2019.11

Code Meaning Returned When

200 OK LDAPs were retrieved successfully.

403 Forbidden User does not have view/manage


security configurations permissions.

Response entity body:


An array of LDAP configurations. An empty array if none exists.

Attribute Type Description

id String The ID for the returned LDAP.

type Predefined The type of the LDAP.


Value

domain String The domain of the LDAP.

addresses An array of The address of the LDAP and other


Address addresses for the case of failover.

securedChannel boolean True if a secured channel is used


(SSL).

enabled boolean Whether the returned LDAP is


operational.

privilegedUser String The DN of a user with search


capabilities on the provided User &
Group DNs. In case the LDAP type is
ACTIVE_DIRECTORY the exact user
name will be returned (and not a
DN).

privilegedUserPassword String Indicates whether a password for


the privileged user was provided.
"********" is displayed when a
password is set.

groupsDns String[] The DNs on which to apply the


groups filter for search.

groupsSearchRecursive boolean Whether groups search should be


recursive.

groupsFilter String A search filter to apply on the


groups DNs.

usersDns String[] The DNs on which to apply the


users filter for search.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1026
Robotic Process Automation 2019.11

usersSearchRecursive boolean Whether users search should be


recursive.

userCommonNameAttribute String The attribute of the user which


should be used for display
purposes.

userEmailAttribute String The attribute of the user which


contains the mail address.

groupMembershipAttribute String In ACTIVE_DIRECTORY type, this


represents the attribute of the user
which contains the groups. In any
other type, it is null.

usersFilter String A search filter to apply on the users


DNs.

groupNameAttribute String The attribute of the group which


contains the group's name used for
mapping Roles to Groups.

customGroupsAttributesNames String Attribute names that will be used as


groups. Separated by semicolon.

Get default LDAP


Request: GET /authns/ldap-config/default
Description: Retrieve the default LDAP.
Response status codes:

Code Meaning Returned When

200 OK LDAPs were retrieved successfully.

403 Forbidden User does not have read/manage


security configuration permissions.

404 Not Found A default LDAP does not exist.

Response entity body:

Attribute Type Description

id String The ID for the returned LDAP.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1027
Robotic Process Automation 2019.11

type Predefined The type of the LDAP.


Value

domain String The domain of the LDAP.

addresses An array of The address of the LDAP and other


Address addresses for the case of failover.

securedChannel boolean True if a secured channel is used


(SSL).

enabled boolean Whether the returned LDAP is


operational.

privilegedUser String The DN of a user with search


capabilities on the provided User &
Group DNs. In case the LDAP type is
ACTIVE_DIRECTORY the exact user
name will be returned (and not a
DN).

privilegedUserPassword String Indicates whether a password for


the privileged user was provided.
"********" is displayed when a
password is set.

groupsDns String[] The DNs on which to apply the


groups filter for search.

groupsSearchRecursive boolean Whether groups search should be


recursive.

groupsFilter String A search filter to apply on the


groups DNs.

Attribute Type Description

usersDns String[] The DNs on which to apply the


users filter for search.

usersSearchRecursive boolean Whether users search should be


recursive.

userCommonNameAttribute String The attribute of the user which


should be used for display
purposes.

userEmailAttribute String The attribute of the user which


contains the mail address.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1028
Robotic Process Automation 2019.11

groupMembershipAttribute String In ACTIVE_DIRECTORY type, this


represents the attribute of the user
which contains the groups. In any
other type, it is null.

customGroupsAttributesNames String Attribute names that will be used as


groups. Separated by semicolon.

groupNameAttribute String The attribute of the group which


contains the group's name used for
mapping Roles to Groups.

usersFilter String A search filter to apply on the users


DNs.

Delete default LDAP marking


Request: DELETE /authns/ldap-config/default
Description: Deletes the default LDAP marking.
Note: The LDAP is not deleted.
Response status codes:

Code Meaning Returned When

204 No Content No default LDAP marking exists


anymore

403 Forbidden User does not have manage


security configuration permissions.

Create or update a default LDAP marking


Request: PUT/authns/ldap-config/default or POST/authns/ldap-config/default
Description: Creates or updates default LDAP marking.
Request body:

Attribute Type Description Required? Default value

id String The ID that Yes N/A


represents the
LDAP to be marked
as default

Example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1029
Robotic Process Automation 2019.11

{ "id": "72cdc1a7-1005-4800-a412-5e4a9b8f6bec" }

Response status codes:

Code Meaning Returned When

200 OK The default LDAP was set


accordingly. There was a default
LDAP before.

201 Created The default LDAP was set


accordingly. There was no default
LDAP before.

400 Bad Request The user did not provide a


mandatory attribute, or provided an
invalid value, for example, the
given ID does not correspond with
an existing LDAP configuration.

403 Forbidden User does not have manage


security configuration permissions.

404 Not Found The provided ID does not relate to


some existing LDAP

Response entity body:

Attribute Type Description

id String The ID for the returned LDAP.

type Predefined The type of the LDAP.


Value

domain String The domain of the LDAP.

addresses An array of The address of the LDAP and other


Address addresses for the case of failover.

securedChannel boolean True if a secured channel is used


(SSL).

enabled boolean Whether the returned LDAP is


operational.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1030
Robotic Process Automation 2019.11

privilegedUser String The DN of a user with search


capabilities on the provided User &
Group DNs. In case the LDAP type is
ACTIVE_DIRECTORY the exact user
name will be returned (and not a
DN).

privilegedUserPassword String Indicates whether a password for


the privileged user was provided. Is
displayed "********"when a
password is set.

groupsDns String[] The DNs on which to apply the


groups filter for search.

groupsSearchRecursive boolean Whether groups search should be


recursive.

groupsFilter String A search filter to apply on the


groups DNs.

usersDns String[] The DNs on which to apply the


users filter for search.

usersSearchRecursive boolean Whether users search should be


recursive.

userCommonNameAttribute String The attribute of the user which


should be used for display
purposes.

userEmailAttribute String The attribute of the user which


contains the mail address.

groupMembershipAttribute String In ACTIVE_DIRECTORY type, this


represents the attribute of the user
which contains the groups. In any
other type, it is null.

groupNameAttribute String The attribute of the group which


contains the group's name used for
mapping Roles to Groups.

customGroupsAttributesNames String Attribute names that will be used as


groups. Separated by semicolon.

usersFilter String A search filter to apply on the users


DNs.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1031
Robotic Process Automation 2019.11

Test LDAP configurations


There are two APIs for testing LDAP configurations:

1. Request:

POST /authns/ldap-config/{id}/test

Description: Test an existing LDAP configuration.

2. Request:

POST /authns/ldap-config/test
Description:

Test an ad hoc LDAP configuration.

Request body (only for ad hoc API):

Attribute Type Description Required? Default value

userName String The user to test the Yes


provided configurations
with.

userPassword String The password of the No None


user. In case the
password is not
provided, there will be
no authentication
attempt.

type Predefined The type of the LDAP. No OTHER


Value

domain String The domain of the Yes


LDAP. In case of Active
Directory this must be
a real domain that can
be bind on, in all other
cases any name would
fit.

addresses An array of The address of the Yes


Address LDAP and other
addresses for the case
of fail-over.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1032
Robotic Process Automation 2019.11

securedChannel boolean True if a secured No False


channel should be used
(SSL)

privilegedUser String The DN of a user with No None


search capabilities on
the provided User &
Group DNs. In case the
LDAP type is ACTIVE_
DIRECTORY the exact
user name should be
provided (and not a
DN). If the LDAP allows
anonymous search, this
field is not required.

privilegedUserPasswor String The password of the No None


d privileged user. If the
password of the
existing LDAP should
be used, displayed with
asterisk ("********").
Note: If you decided to
provide the password
itself, the
/authns/ldap-
config/test is more
suitable.

groupsDns String[] The DNs on which to Yes


apply the groups filter
for search.

groupsSearchRecursiv boolean Whether groups search No False


e should be recursive

groupsFilter String A search filter to apply Yes


on the groups DNs

usersDns String[] The DNs on which to Yes


apply the users filter
for search.

usersSearchRecursive boolean Whether users search No False


should be recursive

userCommonNameAtt String The attribute of the Yes


ribute user which should be
used for display
purposes.

userEmailAttribute String The attribute of the No None


user which contains the
mail address

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1033
Robotic Process Automation 2019.11

groupMembershipAttri String In ACTIVE_ DIRECTORY No Mandatory for


bute type, this represents ACTIVE_
the attribute of the user DIRETORY
which contains the
groups. In any other
type, it is null.

groupNameAttribute String The attribute of the Required for all types


group which contains other than
the group's name used ALTERNATE_ GROUP
for mapping Roles to
Groups.

usersFilter String A search filter to apply Yes


on the users DNs.

enabled boolean Whether the returned No False


LDAP is operational

customGroupsAttribut String Attribute names that Required only for


esNames will be used as groups. ALTERNATE_ GROUP
Separated by type
semicolon.

Response status codes:

Code Meaning Returned When

200 OK The provided LDAP configurations


were legal and a test was
performed.

400 Bad Request The provided configurations were


bad or server encountered some
error while performing the test.

403 Forbidden User does not have read/manage


security configuration permissions.

404 Not found The provided LDAP id does not


exist.

Response body:

Attribute Type Description Comments

authenticated boolean Whether or not the user


was authenticated.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1034
Robotic Process Automation 2019.11

groupsNames String[] An array with the names


of the groups the user
belongs to.

userAttributes Attribute[] An array with the


attributes of the user.

multipleResults boolean Whether or not multiple


users with the given
name were found.

RestError for Bad Request (400 code).

Get LDAP root details


Request:
POST /authns/ldap-root or PUT /authns/ldap-root
Description:
Retrieves LDAP root details.
Request body:

Attribute Type Description Required? Default value

addresses Address[] An array of Yes


addresses.

securedChannel boolean Whether to No False


establish a secured
connection (SSL)

Example:

{ "addresses": [{ "host": "mydwbld0006g.isr.HPE.com",


"port": 389 }, { "host":
"mydwbld0126g.isr.HPE.com", "port": 3089 } ],
"securedChannel": false }

Response status codes::

Code Meaning Returned When

200 OK LDAPs were retrieved successfully

400 Bad Request Client provided illegal/incorrect


parameters.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1035
Robotic Process Automation 2019.11

Successful response body:

Attribute Type Description Comments

rootDns String[] An array of DNs which


represents the
LDAProots.

serverAddress Address The address to which OO


successfully connected.

vendorName String The name of the vendor Not all LDAPs support this
of this LDAP functionality

vendorVersion String The version of this LDAP Not all LDAPs support this
functionality

Example:

{ "rootDns": ["dc=mercury,dc=com", "dc=indigo,dc=com"], "serverAddress": {


"port": 389, "host": "mysite.com" }, "vendorName": "ForgeRock AS.",
"vendorVersion": "OpenDJ 2.6.0" }

Bad Request (400 Code) response.

Update an existing LDAP configuration


Request:
PUT /authns/ldap-config/{ldapId}
Description:
Update an existing LDAP configuration
Request body:

Attribute Type Description Required? Default value

type Predefined The type of LDAP. Yes


Value

domain String The domain of the Yes


LDAP. For Active
Directory this must be a
real domain that can be
bound on. In all other
cases any name is
suitable.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1036
Robotic Process Automation 2019.11

addresses An array of Address The address of the Yes


LDAP and other
addresses for the case
of fail-over.

securedChannel boolean True if a secured No False


channel should be used
(SSL).

enabled boolean Whether the provided No False


LDAP should be
operational.

privilegedUser String The DN of a user with No None


search capabilities on
the provided User and
Group DNs. In case the
LDAP type is ACTIVE_
DIRECTORY the exact
user name should be
provided (and not a
DN). If the LDAP allows
anonymous search, this
field is not required.

privilegedUserPasswo String The password of the No None


rd privileged user.

groupsDns String[] The DNs on which to Yes


apply the groups filter
for search.

groupsSearchRecursiv boolean Whether groups search No False


e should be recursive

groupsFilter String A search filter to apply Yes


on the groups DNs

usersDns String[] The DNs on which to Yes


apply the users filter for
search.

usersSearchRecursive boolean Whether users search No False


should be recursive

userCommonNameAtt String The attribute of the Yes


ribute user which should be
used for display
purposes.

userEmailAttribute String The attribute of the No None


user which contains the
mail address

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1037
Robotic Process Automation 2019.11

groupMembershipAttri String In ACTIVE_ DIRECTORY No Mandatory for


bute type, this represents ACTIVE_
the attribute of the user DIRETORY
which contains the
groups. In any other
type, it is null.

Response status codes:

Code Meaning Returned When

200 Successful The LDAP configuration was


updated successfully.

400 Bad Request Client didn’t provide the mandatory


field or provided some fields with
wrong format.

403 Forbidden User does not have manage


security configuration permissions.

409 Conflict The provided domain already


exists.

Example:

{ "type": "SUN_ONE", "domain": "MyDomain", "addresses": [{ "host":


"mysite.com", "port": 389 }], "securedChannel": false,
"enabled": true, "privilegedUser": "uid=user,ou=people,dc=HPE,dc=com",
"privilegedUserPassword": "1234", "groupsDns": ["ou=products,dc=HPE,dc=com"],
"groupsSearchRecursive": true, "groupsFilter": "(uniqueMember={0})",
"groupNameAttribute": "cn", "usersFilter": "(&(objectclass=person)(uid={0}))",
"usersDns": ["ou=people,dc=HPE,dc=com"], "usersSearchRecursive": true,
"userCommonNameAttribute": "cn" }

LDAP attributes and types


Address:

Attribute Type Description Comments

host String The IP or HOST name of


the LDAP

port int The port of the LDAP

Attribute:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1038
Robotic Process Automation 2019.11

Attribute Type Description Comments

name String The attribute name

value String The attribute value

LDAP Type includes one of the following strings:

ACTIVE_DIRECTORY
SUN_ONE
E_DIRECTORY
OPEN_DJ
OPEN_LDAP
OTHER
ALTERNATE_GROUP

General

RestError

Attribute Type Description Comments

message String A localized description of


an error that occurred.

Message can be
presented to the end
user.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1039
Robotic Process Automation 2019.11

Workers
Many deployments can benefit from having more than a single Worker in a specific environment. For example, this
could be helpful if you are managing a remote data center in which you need Workers to be able to withstand the
action execution load, or simply for high availability of the Workers in that data center. In previous versions, a load
balancer would have been required to balance the load between two Workers, which Central would know as a
single logical Worker.

Get all RASes


Request: GET /rases Description: Retrieves the information of all the RASes in the system. Response status
codes'

Code Meaning Returned When

200 OK Successful

403 Forbidden The user does not have the View


Topology or Manage Topology
permission.

Response entity body:

On success: Returns a JSON object with the following format:

[ { "upgradeStatus": "READY_FOR_UPGRADE", "upgradeDetails": null, "upgradeVersion":null,


"upgradeDetailsForLoaclization":null, "worker":{ "uuid": "1fc88b1f-33f3-4178-a3ee-996f90f36feb",
"installPath": "C:\\PROJS\\INSTALLATIONS\\10_60\\ras", "os": "Windows 8.1", "jvm": "1.8.0_45",
"description": "1fc88b1f-33f3-4178-a3ee-996f90f36feb", "dotNetVersion": "4.x", "hostName":
"somehost", "groups":["RAS_Operator_Path"], "status": "RECOVERED", "executionStatus": "Idle",
"monitorInfo": null, "ipAddress": null, "listenPort": 0, "protocolType": null, "reversedWorker":
false, “connectedCentralUuid": null, "connectedCentralHostname":null, "sharedSecret": null,
"version": "10.70", "versionId": "20160300", "active": false } } ]

Update a specific worker


Request:
PUT /workers/{workerId}
Description:
Update an existing worker.
Request path variables:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1040
Robotic Process Automation 2019.11

Attribute Description

workerId The ID of the worker to be updated.

Request entity body:


The body of this request must include a JSON object with the following format:
JSON for the worker

{ "groups":[ "worker_Operator_Path" ], "active":false }

Response status codes:

Code Meaning Returned When

200 Successful (OK) Updated the default role


successfully.

403 Forbidden The user doesn’t have Manage


Topology permission.

404 Not found The requested worker is not found.

Get all workers


Request:
GET /workers
Description:
Retrieves all the workers.
Response status codes:

Code Meaning Returned When

200 Successful (OK) The requested workers were found.

403 Forbidden The user doesn’t have View


Topology or Manage Topology
permissions.

Response entity body:


on success: Returns a JSON object with the following format:

[ { "uuid":"a97e30da-179e-4f19-af93-453c33338f53", "installPath":"c:/jenkins/workspace/carmel-demo-
deployment/oo/central", "os":"Windows Server 2008", "jvm":"1.7.0_13",
"description":"a97e30da-179e-4f19-af93-453c33338f53", "dotNetVersion":"4.x",

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1041
Robotic Process Automation 2019.11

"hostName":"VMCNCDEV41.devlab.ad", "groups":[ "worker_Operator_Path" ], "active":true,


"status":"RUNNING" }, { "uuid":"4440c50e-79d1-45d2-a8dc-94bc42eb9b1f",
"installPath":"c:\\jenkins\\workspace\\carmel-demo-deployment\\oo\\worker", "os":"Windows Server
2008", "jvm":"1.7.0_13", "description":"4440c50e-79d1-45d2-a8dc-94bc42eb9b1f",
"dotNetVersion":"4.x", "hostName":"VMCNCDEV41.devlab.ad", "groups":[ "Worker_Operator_Path" ],
"active":false, "status":"RUNNING" } ]

Worker status
The following are the possible values of the status attribute, which appears in the APIs:

Status Description

RUNNING Normal status

IN_RECOVERY The worker is being recovered, but not finished. Once


the recovery is finished it will change the status to
RECOVERED

RECOVERED Once the recovery is finished it will change the status


to RECOVERED. If this worker starts again and
performs a keepalive to the server it will change to
RUNNING. If this worker has permanently stopped it
will not change and remain RECOVERED.

FAILED This is the initial status when the worker is created


before keepalive is sent for the first time

Get all workers groups


Request:
GET /workers-groups
Description:
Return a list of Workers groups.
Response status code:

Code Meaning Returned When

200 OK

403 Forbidden The user does not have View


Topology or Manage Topology
permission.

Response entity body:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1042
Robotic Process Automation 2019.11

on success: Returns a JSON array of the Workers Groups with the following format:

[ { "uuid":"a97e30da-179e-4f19-af93-453c33338f53", "installPath":"c:/jenkins/workspace/carmel-demo-
deployment/oo/central", "os":"Windows Server 2008", "jvm":"1.7.0_13",
"description":"a97e30da-179e-4f19-af93-453c33338f53", "dotNetVersion":"4.x",
"hostName":"VMCNCDEV41.devlab.ad", "groups":[ "worker_Operator_Path" ], "active":true,
"status":"RUNNING" }, { "uuid":"4440c50e-79d1-45d2-a8dc-94bc42eb9b1f",
"installPath":"c:\\jenkins\\workspace\\carmel-demo-deployment\\oo\\worker", "os":"Windows Server
2008", "jvm":"1.7.0_13", "description":"4440c50e-79d1-45d2-a8dc-94bc42eb9b1f",
"dotNetVersion":"4.x", "hostName":"VMCNCDEV41.devlab.ad", "groups":[ "Worker_Operator_Path" ],
"active":false, "status":"RUNNING" } ]

Assign workers to a group


Request:
PUT /workers-groups/{name}/workers/{workersUuids}
Description:
Assign Workers to a group.
Request path variables:

Attribute Description

name The name of the Workers group to add

WorkersUuids The workersUuids of the Worker(s) to be added to the


group

Response status codes:

Code Meaning Returned When

204 No Content

400 Bad Request

403 Forbidden The user doesn’t have Manage


Topology permission.

404 Not Found The requested worker is not found.

Remove workers from a group


Request:
DELETE /workers-groups/{name}/workers/{workersUuids}

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1043
Robotic Process Automation 2019.11

Description:
Remove Workers from a Workers Group.
Request path variables:

Attribute Description

name The name of the Workers Group to remove from

workersUuids The uuid of the Worker(s) to remove from the group

Response status codes:

Code Meaning Returned When

204 No Content

400 Bad Request

403 Forbidden The user does not have Manage


Topology permission.

404 Not Found The requested worker is not found


or worker group does not exist.

Delete a worker
Request:
DELETE /workers/{workersUuid}
Description:
Delete workers.
Request path variables:

Attribute Description

workersUuid List of worker uuids

Response status codes:

Code Meaning Returned When

204 OK No content, workers deleted


successfully.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1044
Robotic Process Automation 2019.11

400 Bad Request When you try to delete a worker


that is still running.

403 Forbidden The user does not have Manage


Topology permission.

404 Not Found The requested worker is not found.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1045
Robotic Process Automation 2019.11

Firewall friendly APIs

Register reverse RAS


Request:
POST /reverse-rases
Description:
Connect to and register reverse RAS.
Request entity body:
JSON object of worker object

Attribute Type Description Comments

ipAddress String Hostname/IP of the Mandatory


reverse RAS

listenPort Integer The port on which the Mandatory


reverse RAS is listening

sharedSecret String Phrase used to Mandatory


authenticate the
connection to the reverse
RAS

protocolType String Protocol used to connect Mandatory


to the reverse RAS Possible values:
ws – regular connection
(http initiated)
wss – secured connection
(https initiated)

{ "ipAddress": "10.20.30.40", "listenPort": 8081, "sharedSecret": " Admin111",


"protocolType": "wss" }

Examples:
POST /reverse-rases
Response status codes:

Code Meaning Returned When

201 Created

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1046
Robotic Process Automation 2019.11

400 Bad Request

403 Forbidden Access denied user does not have


manage topology permission

500 Internal Server Error RAS creation failed. For more


details see log files

Response entity body:


On success: Returns a JSON object of the new worker with its uuid.

{ "uuid": "d10d4382-ae54-49a1-9e90-2cdfeac4f949", "ipAddress": "10.20.30.40",


"listenPort": 1234, "sharedSecret": "Admin111", "protocolType": "wss" }

Update reverse RAS


Request:
PUT /reverse-rases/{uuid}
Description:
Update reverse RAS details.
Request path variables:

Attribute Description

uuid RAS unique identifier

Request entity body:


JSON object of worker object.

Attribute Type Description Comments

ipAddress String Hostname/IP of reverse Mandatory


RAS

listenPort Integer Port reverse RAS listen on Mandatory

sharedSecret String Phrase used to Mandatory


authenticate connection
to reverse RAS

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1047
Robotic Process Automation 2019.11

protocolType String Protocol used to connect Mandatory


to reverse RAS Possible values:
ws – regular connection
(http initiated)
wss – secured connection
(https initiated)

Examples:
PUT /reverse-rases/d10d4382-ae54-49a1-9e90-2cdfeac4f949

{ "ipAddress": "16.60.202.145", "listenPort": 8081, "sharedSecret": "Abcabc12",


"protocolType": "ws" }

Response status codes:

Code Meaning Returned When

200 OK RAS was updated

400 Bad Request Illegal arguments

403 Forbidden Access denied user does not have


manage topology permission

404 Not Found RAS with given uuid doesn’t exist

500 Internal Server Error RAS update failed. For more details
see log files

Response entity body:


On success: Returns a JSON object of the updated RAS

Test connection to reverse RAS


Request:
POST /reverse-rases/test
Description: Open connection to the worker and close it after success.
Request entity body:

Attribute Type Description Comments

ipAddress String Hostname/IP of reverse Mandatory


RAS

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1048
Robotic Process Automation 2019.11

listenPort Integer Port reverse RAS listen on Mandatory

sharedSecret String Phrase used to Mandatory


authenticate connection
to reverse RAS

protocolType String Protocol used to connect Mandatory


to reverse RAS Possible values:
ws – regular connection
(http initiated)
wss – secured connection
(https initiated)

JSON object of worker object

{ "ipAddress": "10.20.30.40", "listenPort": 1234, "sharedSecret": "Admin111",


"protocolType": "wss" }

Examples:
POST /reverse-rases/test
Response status codes:

Code Meaning Returned When

200 OK Connection tested, regardless of


success or failure

400 Bad Request Illegal arguments

500 Internal Server Error RAS test failed. For more details see
log files

Response entity body:


On success: Returns test connection status code:

0 – test connection success


1 – failure, see logs (unable to identify specific error)
2 – timeout
3 – connection already opened to the requested destination (ip:port)
4 – Invalid configuration
5 – SSL certificate validation failure
6 – Wrong RAS connection (occurs when for already registered RAS we test /edit connection with providing
ip:port of different RAS)
7 – Invalid credentials (in our case wrong shared secret)
8 – No Credentials provided (can be only theoretically)
9 – Connection refused (port is closed)

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1049
Robotic Process Automation 2019.11

Get Reverse RAS Proxy Configuration


Request:
GET /reverse-ras-proxy
Description:
Retrieve proxy configuration for reverse RAS connection.
Response status codes:

Code Meaning Returned When

200 OK Successful (empty body if not


defined)

403 Forbidden Access denied user does not have


manage topology permission

Response entity body:


on success: Returns a JSON object with proxy configuration

{ "proxyAddress": "100.201.130.5", "proxyListenPort": "3322", "proxyUserName":


"admin", "proxyPassword": "admin" }

Create reverse RAS proxy configuration


Request:
POST /reverse-ras-proxy
Description:
Create a reverse RAS proxy configuration.

Attribute Type Description Comments

proxyAddress String Hostname/IP of forward Mandatory


RAS

proxyListenPort Integer Port forward proxy listen Mandatory


on

proxyUserName String Forward proxy user Optional

proxyPassword String Forward proxy password Optional


Required if proxy user
provided

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1050
Robotic Process Automation 2019.11

Examples:
POST /reverse-ras-proxy
Request entity body:
JSON object of proxy configuration object

{ "proxyAddress": "100.201.130.4", "proxyListenPort": 3322, "proxyUserName":


"admin", "proxyPassword": "admin" }

Response status codes:

Code Meaning Returned When

200 OK Successful

400 Bad Request Illegal arguments

403 Forbidden Access denied user does not have


manage topology permission

Response entity body:


on success: Returns a JSON object of the new proxy configuration

Update reverse RAS proxy configuration


Request:
PUT /reverse-ras-proxy
Description:
Update reverse RAS proxy configuration.

Attribute Type Description Comments

proxyAddress String Hostname/IP of forward Mandatory


RAS

proxyListenPort Integer Port forward proxy listen Mandatory


on

proxyUserName String Forward proxy user Optional

proxyPassword String Forward proxy password Optional


Required if proxy user
provided

Examples:
Request entity body:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1051
Robotic Process Automation 2019.11

JSON object of proxy configuration object

{ "proxyAddress": "100.201.130.5", "proxyListenPort": 3322, "proxyUserName":


"admin", "proxyPassword": "admin" }

Examples:
PUT /reverse-ras-proxy
Response status codes:

Code Meaning Returned When

200 OK Successful

400 Bad Request Illegal arguments

403 Forbidden Access denied user does not have


manage topology permission

Response entity body:


On success: Returns a JSON object with proxy configuration

Delete reverse RAS proxy configuration


Request:
DELETE /reverse-ras-proxy
Description:
Delete proxy configuration for reverse RAS connection.
Examples:
DELETE /reverse-ras-proxy
Response status codes:

Code Meaning Returned When

200 OK

403 Forbidden Access denied user does not have


manage topology permission

Response entity body:


On success: No return value

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1052
Robotic Process Automation 2019.11

Users
The Users API allows you to retrieve, update, create and delete users.

Create new internal user


Request:
POST /users
Description:
Adds a new internal user. If the username contains white spaces at the beginning or end, it will be automatically
removed. For example, " internal user " will result as "internal user".
Request entity body:
The body of this request must include a JSON object with the following format:
JSON for a user with a password and roles

{ "username": "mranderson", "password": "12345", "roles": [{


"name": "EVERYBODY" }, { "name": "PROMOTER"
} ] }

If roles are provided with an empty array, the user is granted with the role that was set as the default.

Do not use the me user name as this is reserved.

Response status codes:

Code Meaning Returned When

201 Successful (Created) An internal user was created


successfully.

400 Bad Request When the wrong parameters are


entered.

403 Forbidden The user who executed this


command does not have the
Manage Security Configuration
permission.

409 Conflict The given username already exists.

Response entity body:

on success: Returns a JSON object of the created Internal User with the following format:

{ "displayName": "mranderson", "userId": "mranderson", "emails": null,

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1053
Robotic Process Automation 2019.11

"roles": [ "END_USER", "PROMOTER", "SYSTEM_ADMIN" ],


"permissions": null }

Update existing user


Request:
PUT /users/{username}
Description:
Update an existing internal user
Request path variables:

Attribute Description

username The name of the internal user to update.

Request entity body:


The body of this request must include a JSON object with the following format:
JSON for an Internal User update with both optional and mandatory fields:

{ "password": "12345", "roles": [{ "name": "EVERYONE"


}, { "name": "PROMOTER" } ],
"username": "mranderson" }

Response status codes:

Code Meaning Returned When

200 Successful (OK) Updated the user successfully.

400 Bad Request

403 Forbidden The user who executed this


command does not have the
Manage Security Configuration
permission.

404 Not Found The user to update does not exist.

409 Conflict Trying to rename a user to a name


that already exists.

Response entity body:

on success: Returns a JSON object of the updated internal user.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1054
Robotic Process Automation 2019.11

{ "displayName": "mranderson", "userId": "mranderson", "emails": null,


"roles": [ "END_USER", "PROMOTER", "SYSTEM_ADMIN" ],
"permissions": null }

Delete internal user


Request:
DELETE /users/{userNames}
Description:
Deletes users according to a specific list of user names.
Request path variables:

Attribute Description Required

userNames The names of internal users to Yes


delete.

Response status codes:

Code Meaning Returned When

200 Successful (OK) The request was finish with


success.

403 Forbidden The user who executed this


command does not have the
Manage Security Configuration
permission.

A logged in user cannot delete their own internal user account. In this case the
response status will be 200 OK and in the response body the result will be
FORBIDDEN.

Response Body:
A map containing the user Ids as keys and the delete result as values. The values are predefined values: SUCCESS,
FORBIDDEN, NOT_FOUND.
Example:

{ userName1: "FORBIDDEN", userName2: "SUCCESS", userName3: "NOT_FOUND" }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1055
Robotic Process Automation 2019.11

Get users
Request:
GET /users?domain=internal
Description:
Retrieves users
Request parameters:

Attribute Description Default Value Required

domain The location from which No Yes


the user’s provider
should be retrieved.
Internal stands for
internal users.

Response status codes:

Code Meaning Returned When

200 Successful (OK) Returned the requested users list.

403 Forbidden The user does not have View


Security Configuration or Manage
Security
Configuration permission.

Response entity body:


* on success: Returns a JSON object with the following format:

[{ "displayName": "admin", "userId": "admin", "emails":


null, "roles": [ "ADMIN" ],
"permissions": null }, { "displayName": "mranderson",
"userId": "mranderson", "emails": null, "roles": [
"END_USER" ], "permissions": null }, {
"displayName": "rothjohn", "userId": "rothjohn", "emails": null,
"roles": [ "EVERYONE" ], "permissions": null
} ]

Get session user


Request:
GET /users/me

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1056
Robotic Process Automation 2019.11

Description:
Retrieves this session’s user.
Response status codes:

Code Meaning Returned When

200 Successful (OK) The session’s user was returned.

Response entity body:

on success: Returns a JSON object with the following format:

{ "displayName": "admin", "userId": "admin", "emails": null, "roles": [


"ADMIN" ], "permissions": [ "cpManage", "cpRead", "topologyManage",
"flowPermissionManage", "topologyRead", "securityConfigManage", "securityConfigRead",
"systemSettingsRead", "systemSettingsManage", "scheduleManage", "scheduleRead",
"configurationItemManage", "configurationItemRead", "othersRunsManage" ] }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1057
Robotic Process Automation 2019.11

LWSSO configuration
The LWSSO API allows you to configure LWSSO.

Get LWSSO configuration


Request:
GET /authns/lwsso-config
Description:
Retrieves the lightweight SSO configuration.
Response status codes:

Code Meaning Returned When

200 Successful The LW-SSO configuration was


(OK) returned.

403 Forbidden The user does not have View


Security Configuration or Manage
Security
Configuration permission.

Response entity body:

on success: Returns a JSON object with the following format:

{ "enabled": false, "initString": "************", "domain": "mydomainnew1.com",


"protectedDomains": [ "mydomainnew1.com", "mydomainnew2.com"
] }

Update LWSSO configuration


Request:
PUT /authns/lwsso-config
Description:
Updates the lightweight SSO configuration.
Request entity body:
The body of this request must include a JSON object with the following format (some properties are optional):

{ "enabled": false, "initString": "myInitString", "domain": "mydomainnew1.com",


"protectedDomains": [ "mydomainnew1.com", "mydomainnew2.com"

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1058
Robotic Process Automation 2019.11

] }

The initString must be at least 12 characters long.

Response status codes:

Code Meaning Returned When

200 Successful (OK) Updated the LW SSO configurations


successfully.

400 Bad Request

403 Forbidden The user does not have Manage


Security Configuration permission.

Response entity body:

on success: Returns a JSON object of the saved configurations.

{ "enabled": false, "initString": "************", "domain": "mydomainnew1.com",


"protectedDomains": [ "mydomainnew1.com", "mydomainnew2.com"
] }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1059
Robotic Process Automation 2019.11

User authentication
The Authentication API allows to enable and disable user authentication.

Get authentication configurations


Request:
GET /authns
Description:
Retrieves the authentication status
Response status codes:

Code Meaning Returned When

200 Successful (OK) The authentication status we


returned

Response entity body:

{ "enable": true, "domains": [ "Internal" ] }

Update authentication configurations


Request:
PUT /authns
Description:
Updates the authentication configurations.
Request body:

{ "enable": true }

Response status codes:

Code Meaning Returned When

204 Successful (no-content) The authentication configuration


were updated.

403 Forbidden The user does not have Manage


Security Configuration permission.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1060
Robotic Process Automation 2019.11

404 Not Found The specified path was not found.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1061
Robotic Process Automation 2019.11

Roles
The Roles API allows you to configure roles.

Get specified role


Request
GET /roles/{roleName}
Description:
Retrieves a role according to the specified role name.
Request path variables:

Attribute Description

roleName The name of the required role.

Response status codes:

Code Meaning Returned When

200 Successful (OK) The requested role was found.

403 Forbidden The user does not have View


Security Configuration or Manage
Security Configuration permission.

404 Not Found The requested role was not found.

Response entity body:

on success: Returns a JSON object with the following format:

{ "name":"ADMINISTRATOR", "description":"Administration Role", "permissions":[


"flowPermissionManage", "cpManage", "dashboardRead", "configurationItemRead", "cpRead",
"configurationItemManage", "scheduleManage", "systemSettingsManage", "scheduleRead",
"securityConfigRead", "topologyRead", "flowDebug", "securityConfigManage", "topologyManage",
"systemSettingsRead", "othersRunsManage" ], "groupsNames":[ ] }

groupsNames attribute refers to the LDAP groups mapping. An empty array


indicates that there is no mapping to any LDAP group.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1062
Robotic Process Automation 2019.11

Get all roles


Request
GET /roles
Description
Retrieves all the existing roles.
Response status codes

Code Meaning Returned When

200 Successful (OK) The requested roles were found.

403 Forbidden The user doesn’t have View


Security Configuration or Manage
Security
Configuration permission.

Response entity body

on success: Returns a JSON object with the following format:

[ { "name": "ADMINISTRATOR", "description": "Administration Role",


"defaultRole": false, "permissions": [ "cpManage", "flowDebug",
"othersRunsManage", "auditRead", "categoryManage",
"dashboardRead", "dataCleanupManage", "topologyManage",
"scheduleRead", "configurationItemRead", "systemSettingsRead",
"flowPermissionManage", "topologyRead", "scenarioManage",
"systemSettingsManage", "configurationItemManage", "cpRead",
"scheduleManage", "securityConfigManage", "securityConfigRead" ],
"groupsNames": [] }, { "name": "END_USER", "description": "End User Role",
"defaultRole": false, "permissions": [], "groupsNames": [] }, {
"name": "EVERYBODY", "description": "Everybody Role", "defaultRole": false,
"permissions": [], "groupsNames": [] }, { "name": "PROMOTER",
"description": "Promoter Role", "defaultRole": false, "permissions": [
"cpManage", "flowPermissionManage", "configurationItemManage",
"cpRead", "configurationItemRead" ], "groupsNames": [] }, {
"name": "SYSTEM_ADMIN", "description": "System Administrator Role", "defaultRole":
false, "permissions": [ "systemSettingsRead", "topologyRead",
"systemSettingsManage", "auditRead", "dataCleanupManage",
"securityConfigManage", "topologyManage", "securityConfigRead" ],
"groupsNames": [] } ]

Create a new role


Request
POST /roles

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1063
Robotic Process Automation 2019.11

Description
Adds a new role Request entity body.
The body of this request must include a JSON object with the following format:
JSON for a role configuration with both optional and mandatory fields:

{ "name": "NEW_ROLE", "description": "", "permissions": [], "groupsNames": [] }

description and groupsNames are optional. The groupsNames refers to the LDAP groups that should be mapped to
this role.
Response status codes

Code Meaning Returned When

201 Successful (Created) A new role was created.

400 Bad Request The data in the body is incorrect.

403 Forbidden The user does not have Manage


Security Configuration permission.

409 Conflict When the user tries to add a role


which is already exists.

Response entity body:

on success: Returns a JSON object of the created role with the following format:

{ "name": "NEW_ROLE", "description": "", "defaultRole": false, "permissions": [], "groupsNames": []


}

Update an existing role


Request:
PUT /roles/{roleName}
Description:
Update an existing role
Request path variables:

Attribute Description

roleName The name of the role to update.

Request entity body:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1064
Robotic Process Automation 2019.11

The body of this request must include a JSON object with the following format:
JSON for a Role update with both optional and mandatory fields:

{ "description": "Not super power anymore", "groupsNames": [ "Not Super


Group" ], "name": "Not Super Power", "permissions": [
"othersRunsManage", "flowPermissionManage", "securityConfigRead",
"securityConfigManage" ] }

Response status codes

Code Meaning Returned When

200 Successful (OK) Updated the role successfully.

400 Bad Request The JSON body is incorrect.

403 Forbidden The user does not have Manage


Security Configuration permission.

404 Not Found When the role does not exist.

Response entity body:

on success: Returns a JSON object of the updated internal user.

{ "description": "Not super power anymore", "groupsNames": [ "Not Super


Group" ], "name": "Not Super Power", "permissions": [
"othersRunsManage", "flowPermissionManage", "securityConfigRead",
"securityConfigManage" ] }

Delete
Request:
DELETE /roles/{roleName}
Description:
Deletes a role according to the specified role name.
Request path variables:

Attribute Description

roleName The identifier of the role name to delete.

Response status codes:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1065
Robotic Process Automation 2019.11

Code Meaning Returned When

204 Successful (no-content) The role was deleted successfully.

403 Forbidden The user does not have Manage


Security Configuration permission.

404 Not found

Get a default role


Request:
GET /roles/default-name
Description:
Retrieves the default role.
Response status codes:

Code Meaning Returned When

200 Successful (OK) The default role found.

403 Forbidden The user does not have View


Security Configuration or Manage
Security
Configuration permission.

Response entity body:

on success: Returns a JSON object with the following format:


{"defaultRole":"EVERYBODY"} defaultRole attribute maps between the default role and an existing one.

Get entitlements per path and role


Request:
GET /roles/{rolesNames}/entitlements/{path}
Description:
Retrieves the entitlements for the requested roles and path.
Example:
GET /roles/ADMINISTRATOR,EVERYBODY,PROMOTER/entitlements/Library/Flows/flow.xml
Request path variables:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1066
Robotic Process Automation 2019.11

Attribute Description

rolesNames The roles for which the entitlements are requested.

Path The full path of the resource, including .xml.


Note: The "/" in the path must not be encoded.

Response status codes:

Code Meaning Returned When

200 Successful (OK) The requested entitlements were


found.

400 Bad request

403 Forbidden The user does not have Manage


Content Permissions permission.

404 Not Found The requested path was not found.

Response entity body:

On success: Returns a JSON object with the following format:

{ "ADMINISTRATOR": ["RUN", "VIEW" ], "EVERYBODY": [ ],


"END_USER": [ ], "SYSTEM_ADMIN": [ ], "PROMOTER": [
"RUN", "VIEW" ] }

Existing entitlements are:


RUN – run flow,
VIEW – view flow,
VIEW_EXECUTE – view and use system account.

Update path entitlement per role


Request:
PUT /roles/{roleName}/entitlements/{path}
Description:
Update the entitlements of the requested role and path. The path can be both a flow and configuration item. The
privileges for flows are RUN and VIEW, and for configuration items, VIEW_EXECUTE.
Example:
PUT /roles/SYSTEM_ADMIN/entitlements/Library/cp-parallel

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1067
Robotic Process Automation 2019.11

Request path variables:

Attribute Description

roleName The role for which the entitlements are impact.

Path The full path of the resource, including .xml.


Note: the "/" in the path must not be encoded.

Request entity body:


The body of this request must include a JSON object with the following format:
JSON for an entitlement path update with both optional and mandatory fields:

{ "privileges": ["VIEW", "RUN"], "isRecursive": true }

The default value for isRecursive is false.

Response status codes:

Code Meaning Returned When

200 Successful (OK) Updated the role successfully.

400 Bad Request The request contains the wrong


data, for example, no existing
privileges.

403 Forbidden The user does not have Manage


Content Permissions permision.

404 Not found The specified path was not found.

Response entity body:

on success: Returns a JSON object of the updated path entitlement on the role.

{ "privileges":[ "VIEW", "RUN" ], "isRecursive":true }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1068
Robotic Process Automation 2019.11

System information and settings

Create a system configuration item


Request:
POST /config
Description:
Creates a system configuration item.
Request entity body:
The body of this request needs to include a JSON object with the following format:

{ "value": "value", "key": "my.test.key" }

Response status codes:

Code Meaning Returned When

201 Created A system configuration item was


created successfully.

403 Forbidden The user does not have Manage


System Settings permission.

409 Conflict The system configuration item is


already exists.

Response entity body:


* on success: Returns a JSON object of the created system configuration item with the following format:

{ "id": "1179648", "key": "myKey", "value": "value" }

In addition, a location header containing a URI to retrieve the created system configuration item:
/config/myKey

Get all system configuration items


Request:
GET /config
Description:
Retrieves all system configuration items.
Response status codes:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1069
Robotic Process Automation 2019.11

Code Meaning Returned When

200 OK All existing system configuration


items were retrieved.

403 Forbidden The user does not have View


System Settings or Manage System
Settings permission.

Response entity body:


* on success: Returns a JSON object with the following format:

{ "key 1": "value 1", "key 2": "value 2", .... "key n": "value n" }

Get a system configuration item


Request:
GET /config/{key}
Description:
Retrieves a system configuration item by key.
Request path variables:

Attribute Description

key The key of the requested system configuration item.

Response status codes:

Code Meaning Returned When

200 OK The requested system configuration item was retrieved successfully.

403 Forbidden The user does not have View System Settings or Manage System Settings permission.

404 Not Found No system configuration was retrieved.

Response entity body:


* On success: Returns a JSON string with the value of the requested system configuration item.<;/p>

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1070
Robotic Process Automation 2019.11

Update system configuration item


Request:
PUT /config/{key}
Description:
Updates an existing system configuration item.
Request path variables:

Attribute Description

key The key of the system configuration item to update.

Request entity body:


The body of this request needs to include the new value of the system configuration item, as plain text (no JSON
encoding).
Response status codes:

Code Meaning Returned When

202 Accepted The system configuration item was


updated successfully.

403 Forbidden The user does not have Manage


System Settings permission.

404 Not Found The requested system configuration


item was not found.

Response entity body:

On success: Returns a JSON value of the updated configuration item's ID.

Get database usage statistics


Request:
GET /db-statistics
Description:
Retrieves the RPA database usage statistics (in MB) according to the given request parameters.

Database usage represents the sum of database segments/pages in use by RPA. It


does not reflect the overall “size-on-disk” and/or database transaction log.

Request parameters:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1071
Robotic Process Automation 2019.11

Attribute Type Description Required Default

months List of numbers The months to No false


retrieve the
statistics for. An
empty list means all
months.

years List of numbers The years to No false


retrieve the
statistics for. An
empty list means all
years.

Example:

GET/db-statistics?months=1,2,3&amp;years=2015

Response status codes:

Code Meaning Returned When

200 OK The requested database usage


statistics was returned.

403 Forbidden The user who executed this


command does not have permission
for Manage cleanup data or to view
or manage system settings.

Response entity body:


An object containing two fields: lastUpdate, which represents the last time the database size was checked, and
data, which is a map containing all of the database statistics that match the request.
The first level of the map is the statistics years. Each year is mapped to the different months, and each month is
mapped to the different days. Each day contains the statistics element. This statistics element contains the total
usage of the database, the debugger usage, the execution usage and the audit usage for that time (in MB).
Example:

{ "lastUpdate": 1182139200000, "data": { "2014": { "12": { "31": { "totalUsage": 3,


"executionUsage": 0, "debuggerUsage": 0, "auditUsage": 0 } } }, "2015": { "1": { "1": {
"totalUsage": 1050, "executionUsage": 568, "debuggerUsage": 150, "auditUsage": 0 }, "2": {
"totalUsage": 3, "executionUsage": 756, "debuggerUsage": 150, "auditUsage": 3 } } } } }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1072
Robotic Process Automation 2019.11

Get AutoPass server details


Request:
GET /licensing/autopassconfig
Description:
Retrieves all the details of AutoPass server such as the URL, username and password.

Connect to AutoPass server


Request:
PUT /licensing/autopassconfig
Description:
To establish connection with AutoPass server.
Request entity body:

{"url:"autopassHost", "username": "username", "password": "password" }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1073
Robotic Process Automation 2019.11

System log level

Get system log level


Request:
GET /loglevel
Description:
Retrieves the system default run log level (persistence level).
Example:
GET/loglevel
Response status codes:

Code Meaning Returned When

200 OK The requested log level was


returned.

403 Forbidden The user does not have the


permission View System Settings or
Manage System Settings

Response entity body:

On success: Returns a quoted JSON string of the system log level.


Possible values:
STANDARD, EXTENDED
Example:
"STANDARD"

Get general setting by key


Request:
GET /general-settings/{key}
Description:
Returns the value of the requested general setting. The following keys are allowed:

masthead.extra.title
roi.description
system.level.flow.timeout
Example:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1074
Robotic Process Automation 2019.11

GET /general-settings/system.level.flow.timeout
Response status codes:

Code Meaning Returned When

200 Successful (OK) Request is successful and the value


is returned.

404 Not Found Requested key is not a general


settings key and cannot be found.

Update System Log level


Request:
PUT /loglevel
Description:
Updates the system default run log level (persistence level).
Example:
PUT /loglevel
Request entity body:
The body of this request must include one of the predefined values (quoted JSON string): STANDARD, EXTENDED.
Example:
"STANDARD"
Response status codes:

Code Meaning Returned When

204 No Content The requested log level was


updated successfully.

400 Bad Request The provided log level does not


match the predefined values (Case
sensitive).

403 Forbidden The user does not have the


permission Manage System Settings

Delete Step log data


Request:
DELETE /steps-log
Description:

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1075
Robotic Process Automation 2019.11

Purge step data according to time and amount of executions to purge.


Example:
DELETE /steps-log?endedBefore=1412150176345&maxAmount=200
Request parameters:

Attribute Type Description Default value Required?

endedBefore Long The time in 30 days back (in No


milliseconds to start milliseconds)
purging

maxAmount int The max amount of 100 No


executions on
which step’s data is
purged

Response status codes:

Code Meaning Returned When

200 Successful (OK) The step data was deleted


successfully.

400 Bad Request Arguments are invalid

403 Forbidden The user does not have the


permission Manage Cleanup Data

Response entity body:

On success: Returns a JSON string of the number of executions that their step data has been purged.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1076
Robotic Process Automation 2019.11

System notifications

Get system notifications


Request: GET /notifications
Description: Retrieves the available notifications, their description and status.
Response status codes:

Code Meaning Returned When

200 OK The requested notifications were returned.

402 Forbidden License required to use premium feature.

403 Forbidden The user does not have the permission to View System Settings or Manage System
Settings.

Response entity body:

[ { "name": "authenticationDisabled", "mailEnabled": false,


"description": "Central Authentication was disabled", "properties": {} },
{ "name": "runningTimeExceeded", "mailEnabled": false,
"description": "Flows running for more than # hours", "properties": {
" hours": "24" } } ]

Set system notifications


Request: PUT/notifications
Description: Sets the details and status for the system notifications.
Response status codes:

Code Meaning Returned When

200 OK The requested notifications were returned.

402 Forbidden License required to use premium feature.

403 Forbidden The user does not have the permission to View System Settings or Manage System
Settings.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1077
Robotic Process Automation 2019.11

Example:

[ { "name": "authenticationDisabled", "mailEnabled": true,


"properties": {} }, { "name": "runningTimeExceeded",
"mailEnabled": true, "properties": { "hours": "72"
} } ]

The request can only change the enabled status and properties. If a value is not
provided, the previous value is retained.

Set system notification channel


Request: PUT/notification-channel/mail
Description: Sets the notification channel details
Response status codes:

Code Meaning Returned When

204 OK The requested notifications were returned.

402 Forbidden License required to use premium feature.

403 Forbidden The user does not have the permission to View System Settings or Manage System
Settings.

Example:

[{ "host": "smtpServer", "port": "25", "username": "admin", "password":


"password", "from": "senderAddress", "to": "receiver1Address;receiver2Address" }]

The PUT request overwrites the existing configuration. Any field that is left blank
will not retain its previous value.

Get system notifications channel


Request: GET /notification-channel/mail
Description: Gets the notification channel details
Response status codes:

Code Meaning Returned When

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1078
Robotic Process Automation 2019.11

Code Meaning Returned When

200 OK The requested notifications were returned.

402 Forbidden License required to use premium feature.

403 Forbidden The user does not have the permission to View System Settings or Manage System
Settings.

Response entity body:

{ "host": "smtpServer", "port": "25", "username": "admin", "password":


"password", "from": "senderAddress", "to": "receiver1Address;receiver2Address" }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1079
Robotic Process Automation 2019.11

Get RPA version


Request: GET /version
Description: Retrieves information about the RPA version.
Response entity body:

on success: Returns a JSON object with the RPA version information, similar to the one below:

{ "version": "2019.07", "revision": "61583", "build ID": "2019-07-05_15-03-32",


"build number": "8", "build job name": "branch-product" }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1080
Robotic Process Automation 2019.11

Target tracking

Get targets
Request:
GET /targets/all
Description:
Returns a page of targets that were hit by central.
Request parameters:

Attribute Type Description Required Default

pageNum Integer The number of the returned page. This must be a No 1


positive (>0) number.

pageSize Integer The number of records in the returned page. No 50


This must be a positive (>0) number.

Example:

GET /targets/all?pageNum=2&pageSize=10

Response status codes:

Code Meaning Returned When

200 OK The requested contents were returned.

400 Bad Request If any of the arguments are invalid.

403 Forbidden The user attempting to execute this command does not have any of View Audit, or
System Settings permissions.

Response entity body:


An array which contains all of the targets which were hit by each flow that completed successfully. Each element in
the array represents a target.

Attribute Type Description

target String The name of the target

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1081
Robotic Process Automation 2019.11

Attribute Type Description

count Long The number of times that the target was hit.

lastAccessTime Long The last access time in milliseconds since Epoch

Example:

[{ "target": "10.18.23.169", "count": 1, "lastAccessTime":


1539769097424 }, { "target": "mydomain.com:8080",
"count": 17, "lastAccessTime": 1539769939902 } ]

Get targets number hit by RPA Central


Request: GET /targets/count
Description: Returns a long value that represents the total number of targets hit by successfully completed flows
in RPA Central
Example:
GET /targets/count
Response status codes:

Code Meaning Returned When

200 OK The requested contents were returned.

403 Forbidden The user attempting to execute this command does not have any of View Audit or
System Settings permissions.

Response entity body:


A long value that represents the total number of targets hit by successfully completed flows in RPA Central.
Example:
17

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1082
Robotic Process Automation 2019.11

RPA Robot APIs

Get all Robots


Request: GET /robots
Description: This API retrieves the list of robots registered.
Response status codes:

Code Meaning

200 The request was successful.

403 Unauthorized (requires topologyRead)

Response entity body:

[{ "uuid": "9c1d0bf5-adb5-48d7-953b-1ff3e521dd7b", "status": "RUNNING", "active": true, "hostName":


"robot.microfocus.com", "installPath": "C:/Products Micro Focus/Robots/robot", "description":
"9c1d0bf5-adb5-48d7-953b-1ff3e521dd7b", "os": "Windows 10", "jvm": "1.8.0_162", "version":
"2019.02", "groups": ["Default"] }]

Get all robot groups


Request: GET /robot-groups
Description: This API retrieves the list of robot groups.
Response status codes:

Code Meaning

200 The request was successful.

403 Unauthorized (requires topologyRead)

Response entity body:

["robotgroup1","robotgroup2"]

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1083
Robotic Process Automation 2019.11

Create a Robot group


By default, a default robot group called Default will be assigned. Ensure that the Robot group name is less than
255 bytes if it includes a custom prefix and suffix after execution. The default size is 232 bytes.
Request: POST /robot-groups
Description: This API create a robot group.
Response status codes:

Code Meaning

204 The request was successful.

400 Bad request, a constraint was violated (name too long) etc.

403 Unauthorized/csrf token expired (requires topologyRead or


topologyManage)

Response entity body: <The body of this request needs to include the name of the robot group to create.>

Assign Robots to Robot groups


Request: POST /robots/assign
Description: This API assigns robots to robot groups.
Response status codes:

Code Meaning

200 The request was successful.

400 Bad request

403 Unauthorized/csrf token expired (requires topologyRead or


topologyManage)

404 A robot or robot group not found

Response entity body:

The body of this request needs to include a JSON object with the following format: { "9c1d0bf5-
adb5-48d7-953b-1ff3e521dd7b": ["robotgroup1","robotgroup2","robotgroup3"],
"d9ecfa9d-2ed6-4aaa-89cb-836a74a4d598": [] }

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1084
Robotic Process Automation 2019.11

RPA Self-Service X APIs


RPA Self-Service X provides a Swagger Application Programming Interface (API) that allows application developers
to interact with many of the capabilities that RPA offers.
You can access all the Swagger APIs available for RPA Self-Service X, from the the following URL: https://<RPA SSX
fqdn>:<RPA SSX port>/oo-ssx/apidoc/.
You can exercise API calls and view responses from your server related to the following methods:

Activity: Provides management capabilities (trigger/cancel/view) for activities. Activities are the results of
triggering a scenario.
Category: Provides management capabilities (create/update/delete/view) for categories. Categories can be used
for grouping scenarios.
Graphic Resource: Provides management capabilities (add/remove/view) for graphical resources (colors and
icons) that can be used for category customization.
Scenario: Provides management capabilities (add/remove/delete/view) for scenarios. Scenarios are the Self-
Service X equivalent of RPA Central flows and they can be used for advanced flow customization that include
adding default values, hiding inputs/outputs etc.
User: Provides view capabilities of current logged user permissions and properties like name and email.
Click on any method listed to get detailed content for that call, and an interactive "Try it out!" feature.

Access the RPA Self-Service X APIs

To access RPA Self-Service X APIs:

1. Log on to RPA Self-Service X.

2. After logging in, append apidoc/ to the URL in the address bar of your browser.

Example: https://<fqdn>:8446/oo-ssx/apidoc/.
The Swagger UI page appears.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1085
Robotic Process Automation 2019.11

3. Click any of the listed methods to see its respective API calls and click the required call.

Example: To view the categories list, click GET under Category.


4. Provide the required parameters and click Try it out!.

All the details pertaining to the selected call will now be displayed under Response Body. Similarly, to create
a scenario, click the POST call under Scenario method, and use Model Schema to customize your scenario.
You will encounter errors when deleting a resource from Swagger that is in use and when you create a scenario
with two labels of a same name.

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1086
Robotic Process Automation 2019.11

CloudSlang content documentation


CloudSlang is a flow-based orchestrator for managing deployed applications. The CloudSlang project is composed
of three main parts: the CloudSlang Orchestration Engine, the CloudSlang language and the ready-made
CloudSlang content. These 3 components are integrated in the Robotic Process Automation (RPA) platform.
It allows you to rapidly automate your DevOps and everyday IT operations use cases using ready-made operations
or create custom ones using a YAML-based DSL.
For the development of custom operations and workflows, please consult the official documentation of CloudSlang
project at CloudSlang Documentation

This PDF was generated for your convenience. For the latest documentation, always see https://docs.microfocus.com.
Page 1087

Potrebbero piacerti anche