akabotplatform installationguide akabot installation... · 2.0.1.1.war”. rename this file to...

akaBot PLATFORM INSTALLATION GUIDE

2

2

Table of ContentsI.INTRODUCTION…………………………………………………………………………………………………… 3II.SYSTEM REQUIREMENTS………………………………………………………………………………………….31. AKABOT STUDIO……………………………………………………………………………………………........32. AKABOT AGENT………………………………………………………………………………………………….43. AKABOT CENTER…………………………………………………………………………………………………4III.INSTALL REQUIRED COMPONENTS ……………………………………………………………………………51. JAVA JDK 8……………………………………………………………………………………………………….51.1 Download JDK …………………………………………………………………………………………………51.2 Install JDK ………………………………………………………………………………………………………72. MY SQL 8.0 ……….………………………………………………………………………………………………92.1 Download MYSQL……………………………………………………………………………………………..92.2 Install MYSQL ……………………………………………………………………………………………………92.3 Setup MYSQL account to enable remote connection……………………………………………… 203. APACHE TOMCAT 8.5 …………………………………………………………………………………………273.1 Download TOMCAT …………………………………………………………………………………………273.2 Install TOMCAT ………………………………………………………………………………………………..274. APACHE ACTIVE MESSAGE QUEUE …………………………………………………………………………314.1 Download Active Queue …………………………………………………………………………………..314.2 Install Active Queue …………………………………………………………………………………………314.3 Verify installation progress …………………………………………………………………………………33IV.INSTALL AKABOT STUDIO & AKABOT AGENT………………………………………………………………351. Download Installer……………………………………………………………………………………………. 352. Install akaBot platform ……………………………………………………………………………………….353. Request trial license …………………………………………………………………………………………..374. Install web extension…………………………………………………………………………………………. 39V. FRESH INSTALL CENTER IN A SEPARATED COMPUTER ……………………………………………………411. Create MySQL Database for CENTER ………………………………………………..……………………412. Get CENTER Package from aka team…………………………………………………………………….413. Stop TOMCAT …………………………………………………………………………………………………..414. Unzip package and update credentials information’s………………..………………………………435. Copy ROOT folder into Tomcat8.5\webApps folder………………………………………………….. 446. Restart Tomcat …………………………………………………………………………………………………447. Verify the result…………………………………………………………………………………………………45VI. UPGRADE CENTER …………………………………………………………………………………………….461. Get upgraded Package from aka team ………………………………………………………………..462. Stop Tomcat ……………………………………………………………………………………………………463. Backup original configuration………………………………………………………………………………464. Remove current website……………………………………………………………………………………..475. Overwrite upgraded version ………………………………………………………………………………..476. Restore original configuration ………………………………………………………………………………477. Restart Tomcat…………………………………………………………………………………………………478. Verify the result…………………………………………………………………………………………………47VII.APPENDIXS……………………………………………………………………………………………………..481. Change MYSQL Root Password with MYSQL Workbench……………………………………………..482. Create MYSQL Database ……………………………………………………………………………………49

3

3

No Effective Date Version Change Description Reason Reviewer Approver

1 21/02/2020 1.0 First creationFirst

creationTHUYLN1 THUYLN1

2 07/04/2020 1.2Add: .Upgrade Center/LMS,

Email Configuration Update THUYLN1 THUYLN1

3 09/04/2020 1.3Update AKABOT STUDIO,

AGENT, remove Email Configuration

Update THUYLN1 THUYLN1

RECORD OF CHANGES

II.SYSTEM REQUIREMENTS

1. AKABOT STUDIO

I. INTRODUCTION

akaBot is at the forefront of transforming the future of robotic process automation. The software is designed to serve businesses of different sizes. For businesses which use high volume human labor, akaBot provides a reliable technology that adds impetus to their innovation and profitability.

This document aims to guide you how to install akaBot components: akaBot Studio, Agent and Center. The akaBot Platform installer enables you to install the entire akaBot suite.

This document aims to guide you how to install AKABOT CENTER, STUDIO, AGENT and all required softwaresincluding: JDK, MySQL, Tomcat and Apache Active Message Queue.

4

4

2. AKABOT AGENT

Hardware Requirements

Software Requirements

3. CENTER

Hardware Requirements

5

5

Software Requirements

III. INSTALL REQUIRED COMPONENTS

1. INSTALL & CONFIGURE JDK

JAVA JDK 8 , MySQL Community Server ,Tomcat 8.x and Apache Active Queue

1. JAVA JDK 8

Step 1: 1.1 Download JDK

- Go to Java SE download site at JAVA SE

- Choose one the JDK for your operating system

6

6

- You also need to follow addition Oracle site’s instructions to be able to download this file

7

7

- Just always hit “Next” in this process

Step 2: 1.2. Install JDK

- Run installer with administration right

8

8

- Finally, hit “Close” to finish installation process.

9

9

Step 1 2.1 Download MYSQL

- Go to MYSQL download site at https://dev.mysql.com/downloads/installer/

- You also need to follow addition Oracle site’s instructions to be able to download this file

Step 2 2.2 Install MYSQL

2.2.1 Run MySQL installer under administration right then hit “Next” to start

2. INSTALL MY SQL

2. MY SQL 8.0

10

10

2.2.3 Some softwares cannot be resolved automatically. You need to manually download and install them in your computer.

2.2.2 “Check Requirements” dialog will show all required softwares for MySQL. This software list may different in your computer. You need to click “Execute” button to resolve them automatically .

11

11

2.2.4 After installing all required software. You need to hit “check” button to make sure they installed successfully then click “Next” to the next step.

2..2.5 Just hit “Execute” to start installation

12

12

2.2.7 click “Next” to advance to next step

2.2.6 Just hit “Execute” then wait until all product’s installation progress finish

13

13

2.2.9 click “Next” to advance to next step

2.2.8 click “Next” to advance to next step

14

14

2.2.11 Click “Next” to advance to next step

2.2.10 Click “Next” to advance to next step

15

15

*2.2.12 Enter MSQL Root Password , we input sis@12345 for my demonstration

2.2.13 Hit “Next” to advance to next step

16

16

2.2.14 Hit “Next” to advance to next step

2.2.15 Hit “Execute” to apply the changes

17

17

2.2.16. And wait until it finishes

2.2.17. Hit “Next” to advance to next step

18

18

2.2.18. Hit “Finish”

2.2.19. Hit “Next”

19

19

2.2.20. You can test if MySQL server work (hit Check button) then hit “next” button

2.2.21. Hit “Execute” button to apply the changes

20

20

Step 3: 2.3 Setup MYSQL account to enable remote connection

Follow these steps to know how to setup remote connection with MYSQL. This will help to install MYSQL and CENTER in separated systems.

2.3.1. Create a MYSQL account and grant access to specific database (Center in this document)

- Open MySQL Workbench and go to Local instance with root account as below.

2.2.23. Finally, we finish installation process

2.2.22. Hit “Next” button

21

21

- Access “Users and Privileges” function in the left panel (1)

- Then click “Add Account” (2)

22

22

- Leave “Account Limits” as default.

- Enter data for Login tab including: Login Name, Password as bellowed, leave authentication Type and Limit to hosts Matching with default values. “%” in “Limit to Host Matching” means that the host does not include “localhost” so it can access from other remote computer, remote IPs.

23

23

- You can grant any roles for this account by checking designed roles item in the left panel. In this scenario, we only want to grant this account to specific database with normal user permission (not admin at all) so we leave it with default values (do not check anything).

- “Schema Privileges” tab helps to grant specific permission to one or more schema like CENTER Database.

- Click to “Add Entry” to begin setup

24

24

- Apply suitable access rights to this schema, we select all access rights for specific data base in this scenario,

- Object Rights are right to work with any records, DDL Rights are right to work with data base definition type…

- Then select database that is designed for this user (in this case we select database of CENTER application)

- If database has not been created yet, you can create it first by following this link .

25

25

- After click “Apply”, you will see new user named “lmsUser” in user accounts list. You can click “refresh” button to force MYSQLWORKBENCH update the list for you. Note that: “%” in column “From Host” means that this account can be accessed remotely.

26

26

- Input IP address of MySQL that you want to test, explorer in “HostName”, input MySQL UserName that you create in previous step then click to “Test Connection” button”

- After dialog “Connect to MySQL Server” appears, you enter password for this account then hit ok to test this connection

2.3.1 Test your MySQL from remote client using MySQL Workbench

- Open MySQL Workbench in other computer, click to the add connection button (see picture bellowed) to open “Setup New Connection” window.

27

27

3. APACHE TOMCAT 8.5

Step 1: 3.1 Download TOMCAT

- Go to TOMCAT download site at : https://tomcat.apache.org/download-80.cgi

- Choose binary file for your operating system (64 or 32 bit). In this scenario we select MSI installer file at: https://downloads.apache.org/tomcat/tomcat-8/v8.5.53/bin/apache-tomcat-8.5.53.exe

- After connect successfully, you can browse remote database in details using MySQL Workbench

- You will see this dialog if everything is OK.

Step 2: 3.2 Install TOMCAT

- Run apache-tomcat-8.5.53.exe under administration right.

- In Windows 10, you need to confirm to run by click “Run anyway” button

28

28

- Simply hit “Next” in every open dialog

- Hit “I Agree” button

29

29

- Simply hit “Next” in every open dialog

- You don’t need to setup anything, leave them at default settings and hit “Next”

30

30

- Hit “Install”

- Then wait until it finishes

31

31

4. APACHE ACTIVE MESSAGE QUEUE

Step 1: 4.1 Download Active Queue

- Go to ActiveMQ 5.15 download site at : https://activemq.apache.org/download-archives

- In the |Apache ActiveMQ releases page”, select package ver 5.15.1 or click in this link

- In the “Getting the Binary Distributions” list, you can choose suit package for your OS. In this scenario we select Windows Distribution package .

Step 2: 4.2 Install Active Queue

- Unzip downloaded file in step 1, you will see this folder structure

32

32

- Go to BIN folder and open WIN64 or WIN32 directory (this defends on your current OS)

33

33

- Right click on “InstallService.Bat” and select “Run as administrator”

Step2: 4.3 Verify installation progress

- Press Windows + R key to open run dialog, type “services.msc”

34

34

- Restart service “ActiveMQ”

- Navigate to URL : http://localhost:8161/ enter default credential: username/password = admin/admin. You will see the result like this:

IV. INSTALL AKABOT STUDIO & AKABOT AGENT

Step 1: 1. Download Installer

- To install the akaBot Studio & akaBot Agent, you need to have the installer file in .msi or .exe format. You can download it here.

Step 2: 2. Install akaBot platform

- Installing akaBot platform is very simple, you can just hit “Next” to setup in default mode (no

specific configuration needed):

- Hit “Next”

35

35

- Hit “Next”

- After successful installation, click Close button to finish.

36

36

- And you can find the shortcuts of aka Studio & Agent on the desktop.

- Hit “Next”

Step3: 3. Request trial license

After installation, you can request an trial license on our website.

Fill your information in the request form and click button “Submit” to send your request.

37

37

After submit, our Customer Service Representatives will send you the license file through

email. You will need this to active your akaBot license later.

38

38

Step 4: 4. Install web extension

To make akaBot interact with web applications, you may need to install the akaBot extension

in your web browser. You need to follow below steps:

- Open Extensions page of your web browser. Ex: Chrome.

- Turn on developer mode

39

39

- Click on load unpacked

- Then browse to akaBot BrowerExtentsions folder (this folder contains supported

extensions for almost browsers). It will be: C:\Program Files\FPT Software\akaBot

Platform\akaBot\BrowserExtensions in a 64-bit system. You can choose one folder

then click “Select Folder” button.

40

40

41

41

V. FRESH INSTALL CENTER IN A SEPARATED COMPUTER

Step 1: 1. Create MySQL Database for CENTER

- For the newly /first time installation, you must create new database for your CENTER.

- Follow these steps to create a database with the name “aka_orchestrator” ” in machine that designed to install MYSQL Database for CENTER.

Step 2: 2. Get CENTER Package from aka team

- You need CENTER package to start installation process, please contact aka

team to get one. This package contains only one WAR file. E.g.: “akaBot-center-

2.0.1.1.war”. Rename this file to “ROOT.WAR” to prepare for the next step.

Step 3: 3. Stop TOMCAT

- Open run dialog: (hold windows key + R) and type services.msc then locate

Apache Tomcat 8

- If everything is OK, you will see AkaBot component for browser interaction.

42

42

- Hit “Stop” button to stop this service

Step 4: 4. Unzip package and update credentials information’s

- Unzip ROOT.WAR (this is an archived file) using 7z or any zip tool

- Go to ROOT\WEB-INF\classes\config folder then open “application-prod.yml”, “application-dev.yml” . file

- Update all necessary information’s including: remote MySQL URL , CENTER DataBasename , and credentials that you created in this step for two configuration files: application-dev.yml , application-prod.yml .

43

43

Step 5: 5. Copy ROOT folder into Tomcat8.5\webApps folder

- Locate Tomcat 8.5 \webApps directory and remove every things

- Copy our ROOT folder to this directory

44

Step 6: 6. Restart Tomcat

- Start Apache Tomcat 8.5 service and wait several minutes because it takes time for the system to generate entire database layout at the first run.

Step 7: 7. Verify the result.

- Open your browser and navigate to : http://localhost:8080/#/

- Enter your account /password: admin/admin to access CENTER

45

45

46

46

VI. UPGRADE CENTER

Step 1: 1. Get upgraded Package from aka team

- You need upgraded CENTER package to start this process, please contact aka team to get one. This package contains only one WAR file. E.g.: “akaBot-center-2.0.1.1.war”. Rename this file to “ROOT.WAR” to prepare for the next step.

Step 2: 2. Stop Tomcat

- Stop Tomcat service:

Step 3: 3. Backup original configuration

- Locate CENTER Web application base path. In 64 bit system, it will be located at “C:\Program Files\Apache Software Foundation\Tomcat 8.5\webapps\”

- In this base path, locate “ROOT\WEB-INF\classes\config” then backup all *.yml file as you see bellowed.

Step 4: 4. Remove current website.

- Locate CENTER Web application base path in the previous step then remove entire ROOT folder

Step 5: 5. Overwrite upgraded version

- Copy ROOT.WAR (in the step 1) to LMS/CENTER Web application base path.

- Unzip ROOT.WAR (this is an archive file) using 7z or any zip tool

47

47

Step 6: 6. Restore original configuration.

- Copy override configuration files backed up from Step 6.3 to path base path \ROOT\WEB-INF\classes\config.

Step 7: 7. Restart Tomcat

- Restart Tomcat service then wait for a minutes.

Step 8: 8. Restart Tomcat

- Open your browser and navigate to: http://localhost:8080/#/

- Enter your account /password: admin/admin to access CENTER

VII. APPENDIXS

Step 1: 1. Change MYSQL Root Password with MYSQL Workbench.

- You can change MySQL Root password any time by click to” Local Instance MySQL” with root account

48

- Click (1) to open Administration Panel , select (2)“Users and Privileges” (3) select root account.

Update root account password follow your requirement then hit apply.

48

- You can read this link to know more information’s about administration tasks.

Step 2: 2. Create MYSQL Database

- Open MySQL Workbench in the machine you want to create a MySQL Data base

49

49

- Open MySQL Workbench, access local instance

- Click to (1) to open “Create new database dialog” then input (2) (3) (4) as below (schema name=” aka_orchestrator” the database name of CENTER , Charset =”utf8 ,utf8_general_ci”.

- Hit “Apply” after you finish all (1) (2) (3) (4).

50

50

- Hit “Apply” to create our LMS Database

- Hit “Finish”

51