Installation Steps
If you need offline installation support, you must request it at least five days in advance (based on Working Day). After completing the solution supply contract, installation support requests must be made officially through the Samsung SDS RPA Business Strategy Group. Offline installation work will deduct 8 hours of technical support time.
Step | Period | In charge | Confirm | Verification (Y/N) |
|---|---|---|---|---|
Server HW preparation | more than 1 week | Customer | HW Requirements Reference | |
OS installation and preparatory work | 1 day | Customer | Server and OS installation (required)JDK installation (optional - can be done together with RPA installation) | |
Disable Firewall and Network Settings | 2-3 days | Customer | Disabling firewall between serversWhen configuring redundancy, consider additional work periods such as L4 switch settings | |
Preparing the client test environment | 1-2 days | Customer | VDI or PC preparation (prior consultation required for VDI)See HW RequirementsNeed to disable firewall for access to RPA server port 8080, 8777, 9001 | |
Prepare the working environment for installation | 1-2 days | Customer | Prepare a working environment that allows access to the server (if necessary, turn off the related firewall) | |
Buy solution license | N/A | Customer/Samsung SDS | Consult with Samsung SDS RPA Business Strategy Group to complete solution purchase contract and obtain license in advance | |
Install the application server | 1 day | Customer/Samsung SDS | Install Brity RPA Server (Orchestrator) according to the installation guide (MariaDB, ActiveMQ, and Tomcat can be installed together)If there is a customer request, offline installation support is available | |
Check installation | N/A | Customer | Confirm normal operation through client Bot, Designer, Portal(Bot and Designer tests are possible only when the license is activated) |
HW Requirements
HW Requirements
Category | Solutions provided | Specification | Verification (Y/N) |
|---|---|---|---|
Server | Orchestrator Server | CPU: Intel Xeon E3 (or Intel i7) or higher Disk : Recommended 300Gb or more (at least 100Gb or more) AP and DB single server: Memory recommended 32Gb (at least 16Gb or more) When AP and DB server are separated: Memory 16Gb each or more (total 32Gb), at least 8Gb each (total 16Gb) | |
OCR Server | CPU: Intel Xeon E3 (or Intel i7) or higher Memory: 8Gb or more (SDS Virtual Machine : 2 Core, 8Gb or more)
| ||
Client | Bot | CPU: Intel i5 or higher Disk : 100Gb or more Memory: 8Gb or more | |
Designer | Same as above |
Disk capacity calculation criteria (Depends on project size, rough estimate)
Standard | Volume |
|---|---|
Number of projects | Number of projects * 10Mb |
Number of running processes | Number of processes * 1Mb |
(example) - 10 daily average update projects - The average number of running processes per day is 100 ☞ Day increase Disk size = 10 * 10 + 100 * 1 = 200Mb (Actual operation case - confirmed in July 2020) - Average number of projects updated per day: around 100 (more than 100 per day excluding weekends) - Average number of jobs executed per day: Around 2,500 to 2,700 (slightly different for each day of the week) ☞ Check disk capacity increase of 25Gb on average per week
Calculating the Total Physical Memory of the Solution
It is estimated through the trend of measured values according to the increase in the number of active bots and the number of concurrently running jobs, which are the main factors in memory usage.
Category | Description | Unit Memory | Usage |
|---|---|---|---|
System area | OS operation, DBMS engine execution, JDK, Recovery, etc. | 3GB | system default usage |
Web Portal | Orchestrator | Basic 2GB ~ Max 6GB | Proportional to the number of simultaneous connections and simultaneous screen views. Automatic allocation by tomcat |
Memory required for job execution | RPA execution job | 100MB | Average per bot concurrent execution |
Bot operating memory | RPA Bot | 20MB | Average usage of mobile bots |
Buffer cache calibration | Cache area to improve processing speed | 1.15 | Holds 15% Cash |
System redundancy | Calibration for stable operation of the system | 1.15 | Less than 85% redundancy rate |
Required Memory Formula
Memory (in MB) = {System area + Web Portal + (Memory required for job execution * Number of simultaneous executions) + (Bot operation memory * Number of bots)} * Buffer cache correction * System free rate
(Example) Estimated usage: Up to 200 concurrent bots, 200 operating bots
= {3072M + 6144M + (200*100M) + (200*20M)} * 1.15 * 1.15 = 43928 / 1024(MB) = 42.8GB
Settings for each service (solution specification)
Installation Update Image
Java vm options explained
-Xms specifies the initial size of the Java heap, -Xmx specifies the maximum size of the Java heap
To minimize the overhead caused by dynamic changes, it is recommended to assign the same initial size and maximum size.
It is recommended to gradually increase the memory setting value according to the increased number of GC executions and the GC execution time.
If excessively increased, there may be unnecessary performance degradation when the OS operates memory resources.
Configuring the Server Environment
S/W requirements configuration
DBMS : MariaDB 10.3.28 / MySQL 8.13 / Microsoft SQL Server 2019
OS : Ubuntu 16.04.1 LTS / CentOS Linux 8 / RHEL 7.4 or higher
JAVA : 1.8 (check path setting)
WAS: Apache Tomcat/9.0.46
ActiveMQ : apache-activemq-5.15.14
MariaDB, Tomcat, and ActiveMQ can also be installed offline via installation packages. Oracle JDK, MySQL server does not support installation.
If requested by the customer, we will install the open source together, but we do not take responsibility for the management and operation of the open source. However, Oracle JDK, MySQL, and MS-SQL Server installation are not supported.
Notes to customers who configure redundancy and OCR
L4 Switch: Necessary for redundancy configuration. It can be replaced with Web Proxy, but L4 Switch is recommended. (Not required for single server configuration)
Web Proxy: Not required when using L4 (or L7) Switch in redundant configuration. When redundancy cannot be configured using Web Proxy. Nginx 1.14 or higher. (Not required for single server configuration)
Infrastructure Checklist
Item | Checklist |
|---|---|
CPU | Is it 4 Core (2.6 GHz or higher) or higher? |
Memory | 16 GB RAM or more? (32GB or more is recommended) |
Storage Medium | Is it more than 200GB HDD capacity? |
JAVA | Is it open jdk 1.8? (Oracle jdk available) Is the JDK Path setting correct? |
OS | Ubuntu 16.04.1 LTS / CentOS Linux 8 / RHEL 7.4 or higher installed? |
Account | Is the account ready for SSH/Telnet access? |
Time Setting | Is the server time set properly? In case of KST standard, same time as Window PC (GMT+9) GMT+0 hours in UTC (9 hours before Windows PC time) |
IP | Is IPv4 static IP secured? |
Firewall | Is it possible to access the RPA portal from a Windows PC? (For information on how to disable the firewall when RPA portal access is not possible due to the Linux firewall, see RPA service access check in the appendix of this document) |
Infrastructure Tasks and Checklist
Before RPA installation, infrastructure work should be performed in advance, considering the overall schedule, and details of each checklist item should be checked before proceeding. Some work contents differ depending on whether the AP is a stand-alone server installation environment or a redundant environment. Please refer to the checklist tailored to the server environment being built.
Installation checklist
Item | Description | Confirm | Verification (Y/N) |
|---|---|---|---|
Installed infrastructure | Linux server for WAS, DBMS installation | Prepare in advance to enable access to port 22 of the Linux server(s) with an SSH client from a PC. | |
Working PC for performing installation work | |||
OS installation | Linux OS installation | For a Windows platform server, refer to the separate installation guide. | |
Install account (Grant sudo permission) | Linux account for application installation (required) In case of separate operation of RDBMS account, add account (optional) Securing an admin representative email account (optional) | Ipaadm (required) ipadb (option - in case of dividing DB account) It can be installed with one account, but in an environment that requires separation in terms of security and account management, it can be installed by separating the account. The sudo privilege is used during installation and retrieving it is safe after installation. | |
Java installation | OpenJDK 1.8 version is pre-installed on the AP server | It can be done with the RPA installation if it is not pre-installed. | |
Open source installation | Install ActiveMQ and Tomcat DBMS installation | When using an open source that is separately installed/managed by the customer, information is requested in advance (version, installation path) ActiveMQ, Tomcat, MariaDB, etc. can be installed together when installing RPA (however, management operation is the responsibility of the customer) If the customer directly installs MariaDB, the DB Character-set must be set to utf8_general_ci | |
Get RPA License | RPA Orchestrator License (required) RPA Designer, RPA BOT License (required) | Check the MAC address of the server to be installed and deliver it to the AI business team => Delivers the MAC address of Ethernet in actual operation except for Loop back (lo) and virtual bridges (virbr0, lxcbr0) In the case of dual environment configuration, (AP) issue request including both MAC addresses of server 1 and server 2 | |
Securing TLS public certificate | If you want to use a public certificate Purchase a TLS certificate in advance for HTTPS warning-free access | A browser warning window occurs when using the Brity RPA private certificate for basic installation. If the customer using the domain wants to prevent the browser warning message from appearing, please proceed with the purchase of a public certificate in advance. |
Installation checklist (AP single server installation environment)
Item | Description | Confirm | Verification (Y/N) |
|---|---|---|---|
Turn off the firewall (client → server) | Installation PC → AP Server (22) RPA Bot → AP Server (8777, 9001) RPA Designer → AP Server (8777) Portal access PC → AP server (8080, 9001) | Port 22: SSH connectionPort 8080, 8777: HTTPS connection Port 9001: WebSocket SSecure (WSS) connections | |
Disable Firewall (Server → Server) | AP Server → SMTP Server (25) AP Server → OCR Server (9095) AP Server → DB Server (4406) | In connection with SMTP server for sending E-Mail When installing the OCR server separately When DB server is installed separately |
Installation checklist (AP redundant installation environment)
Item | Description | Confirm | Verification (Y/N) |
|---|---|---|---|
Securing installation infrastructure (dual configuration) | L4 or L7 switch AP server 1 AP Server2 DB serve | Open source DB redundancy method is not provided by the solution | |
switch settings(L4 or L7) | 8080 port Sticky Session settings 9001 Port Active-Standby setting 9094 Port Active-Standby setting 8777, 9091, 9093, 9096, 9099 Port Active-Active setting | From RPA Orchestrator v.2.1.0, Workflow service on port 9094 also supports Active-Standby. OCR use port (9095) is not subject to duplication | |
Turn off the firewall (client → server) | Installation PC → AP server 1, AP server 2, DB server (22) RPA Bot → Switch (8777, 9001) RPA Designer → Switch (8777) Portal access PC → Switch (8080, 9001) | Port 22: SSH connection Port 8080, 8777: HTTPS connection Port 9001: WebSocket SSecure (WSS) connections | |
Disable Firewall (Server → Server) | AP server 1, 2 → SMTP server (25) AP server 1, 2 → OCR server (9095) AP server 1, 2 → DB server (4406) | In connection with SMTP server for sending E-Mail When installing the OCR server separatelyWhen DB server is installed separately |
Download Installation Package
Download the installation package via SAMSUNG SDS Brityworks.ai. For information on joining Brityworks.ai and downloading the installation package, contact [Contact] on Brityworks.ai. The installation package is approximately 1.7 GB in size.
Checking Installation
After installation, basic operation tests of each component (server, designer, bot) are performed to check whether they are OK.
Server Portal and Maintenance Checklist
Item | Checklist | Verification (Y/N) |
|---|---|---|
Admin/Tenant/User Portal Login | Server address/admin, server address/tenant, server address/user Connect to each of the three portals with an admin account and check if you can log in. Beforehand, check to disable the firewall between the accessor's PC and the server. | |
Create Tenant | Create a tenant and check whether it operates normally. | |
Create User Account | Create a user account and check whether it is mapped to the corresponding tenant. | |
Register License File | Register the license file in the tenant portal and check whether it is normal. | |
Assign Registered Licenses | Assign licenses and verify that licenses are normally retrieved for each tenant. | |
Create Group Permissions and Assign Users | Set the group authority in the admin portal and assign it to a specific user. | |
Register Screen Menu Authority by Group | Create a bot group in the admin portal and map the bots. Create user groups in the admin portal, add specific users, and map bot groups. | |
Shared Resource Registration | Shared resources are registered, and other users of the user group check if the public resources are searched in the user portal. | |
Add User Queue | Create a queue and grant permission. Check the queue lookup within the process. | |
Email Confirmation after Password Reset | Confirm that the temporary password is sent to the email of the created account. Check email settings in the tenant portal in advance. |
Designer and Launch Checklist
Item | Checklist | Verification (Y/N) |
|---|---|---|
Activate Designer License | After installing and running the designer, check whether the license is activated. Check the firewall open and proxy settings between the user PC and server. | |
Designer Login | Check whether the designer is logged in as a specific tenant. | |
Process Share Resource Reference | Create and execute a process that refers to the registered public resource and check whether the public resource is searched. | |
Data Actions on User Queues | Try in/out data from the process to the user queue (using QueueSendData, etc.) | |
Deploy the Project File Server | Publish the project file from the designer to the server | |
Project Approval and Authorization | Approve the project in the Admin portal and grant permission (granted to the user group to which the user belongs) | |
Run Process | Try running the process in 3 ways - Run with the rocket icon in the Process menu - Monitoring > Job Execution History > Run with New Job button - Schedule > Scheduled Tasks > Scheduled Task Registration button | |
Check Process Execution Result | The Jop execution history is queried. In case of error termination, logs and captures are queried. | |
Process Flow Test | Create a process flow including WaitEmail and WakeUp to test distribution/approval/execution. Test by including callProcess in the process flow | |
Process Flow History Query | Query the execution result of the process flow, the current state, and the execution result of the called process | |
(Samsung Affiliate) Knox API Operation Check | Test sample that utilize the knox API call in the process (e.g. GetDeptInfo) | |
(Samsung Affiliate) Check Whether Knox Message is Interlocked | Test the SendKnoxMessenger card to check whether the messenger is called. |
Bot Execution Environment Checklist
Item | Checklist | Verification (Y/N) |
|---|---|---|
Activating Bot License | Activate the bot's license and verify that the bot is running. | |
Bot Monitoring | When the bot is searched, remote access must be possible. Change the bot's status (running, running, stopped, etc.) and check if the bot's status usually changes. | |
Set Bot Options | Check the auto logon setting in the VM where the bot is installed. | |
Restarting the Bot | After restarting the bot on the server, you should check if the bot status returns to normal. |
Operator Checklist (Required)
After installation, the solution operator explains the essential guides to be performed and checks whether you are familiar with them.
Checklist | Guide | Confirmation (Y/N) |
|---|---|---|
Server startup and shutdown procedures | ||
Server restart procedure | ||
Memory-related monitoring methods | ||
How to extract server error log | ||
How to increase Java memory size | ||
How to check and take action when OOM occurs | ||
How to check server disk capacity status | ||
How to check DB usage and increase space |