installation guide for agent, studio & center...step 5: start tomcat to unzip root.war. verify...

38
INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER Network License

Upload: others

Post on 08-Jul-2020

5 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

INSTALLATION GUIDE FOR

AGENT, STUDIO & CENTERNetwork License

Page 2: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

2

2

Table of ContentsI. INTRODUCTION …………………………………………………………………………… 3

II. INSTALL AKABOT STUDIO & AKABOT AGENT …………………………...…………4

1. Download Installer ..…………………………………………………………………….....4

2. Install akaBot platform .………….………………………………………………………... 4

3. Install web extension .…………………………………………………………………….... 7

II. INSTALL AKABOT CENTER ……………………………………………………………10

1. Install JAVA JDK .......……………………………………………………………………..10

2. Install MySQL .……………………………………………………………………………..14

3. Install TomCat ..…………………………………………………………………………….25

4. Install Apache Active Queue ...…..……………………………………………………….30

5. Install AKABOT CENTER ..……………………………………………………………….33

III. SYSTEM REQUIREMENTS ……………………………………………………………. 37

1. AKABOT STUDIO ……………………………………………………………………....... 37

2. AKABOT AGENT …...……………………………………………………………………..37

3. AKABOT CENTER .…...…………………………………………………………………..38

https://akabot.com

Page 3: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

3

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 with a high

volume of human labor, akaBot provides a reliable technology that adds impetus to their

innovation and profitability.

This document aims to give you a step-by-step instruction on how to install akaBot

Studio, Agent & Center for NETWORK license. NETWORK license is provided as a

package with 1 Center License and a quota on the number of Studio & Agent licenses.

Instead of activating from central license management system, you can generate,

activate and manage Studio & Agent licenses from your akaBot Center.

Start using NETWORK license by installing akaBot Center, Studio & Agent. For

installation, you can install the components in any order, on the same or different

machines, as you wish. However, for activation, you will need to activate Center first,

before moving on to activate Studio & Agent. Please follow this document for details on

installation.

Once installation is completed, please proceed to activate the components. License key

for Center is provided in the Licensing Email. License key for Agent & Studio can be

acquired from Center. More details on Activation is attached in Licensing Email.

Thank you and Enjoy automating with akaBot!

https://akabot.com

3

Page 4: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

II. INSTALL AKABOT STUDIO & AKABOT AGENT

Before you start:

1. akaBot Studio & Agent are included in the same installer. By the end of Part II, you will

have both components installed. However, activation will be separate for these

components.

2. Note that this guide is only for Installation. To activate Studio & Agent, you will need to

install & activate Center first, then get the license key for Studio & Agent from Center.

3. Please make sure your machine meet System Requirements.

Step 1: Download Installer

To install the akaBot Studio & akaBot Agent, you will need the installer file in .msi or .exe

format. You can download it from the link provided in the Licensing Email or here.

Successful download will lead you to akaBotPlatform.zip file.

In this file you will see two versions for akaBot Installer: 64-bit and 32-bit. Unzip the

appropriate folder to find the .msi file.

Step 2: Install akaBot platform (Agent + Studio)

Run the Installer. A Setup Wizard will show up as below.

Please follow the steps as specified on the prompt to continue installation process.

Simply hit “Next”.

4

4

https://akabot.com

Page 5: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

5

Hit “Next”

Hit “Next”

https://akabot.com

Page 6: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

6

6

After the installation is done, you will see the Installation Complete notification as

below. Hit “Close”. Now you should have the shortcuts for akaBot Studio & Agent

successful present on the desktop.

This Installation Prompt will show up.

https://akabot.com

Page 7: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

Step 3: Install web extension (Optional)

To facilitate akaBot’s interaction with web applications, you may need to install

akaBot extension on your web browser. Please follow the below steps:

- Open Extensions page on your web browser. E.g. Chrome

- Turn on developer mode

7

7

- Turn on Developer Mode.

https://akabot.com

Page 8: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

- This will prompt you to Select Extension prompt as below.

Browse to akaBot BrowerExtentsions folder in C:\Program Files\FPT

Software\akaBot Platform\akaBot\BrowserExtensions in a 64-bit system.

- Choose the browser you want to install the extension on. Then click “Select Folder”

button.

8

- Click on “Load unpacked”

https://akabot.com

Page 9: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

9

9

- If you see this confirmation prompt, you have successfully installed akaBot

Web Extension.

https://akabot.comhttps://akabot.com

Page 10: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

Before you start:

1. akaBot Center requires some additional programs to be installed. The instruction is

included in this guideline.

A. JAVA JDK 8

B. MySQL Community Server

C. Tomcat

D. Apache Active Queue

2. Please make sure your machine meet the System Requirements.

A. JAVA JDK 8

Step 1: Download Java JDK 8

1. Go to Java SE download site at JAVA SE

2. Scroll down to Java SE Development Kit. You will see a list of versions for different

systems. Download the version for your Operating System.

III. INSTALL AKABOT CENTER

10

10

https://akabot.com

Page 11: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

11

https://akabot.com

3. Accept Oracle License Agreement. Click Download. This will lead you to Oracle Login

Website.

4. Log in with your Oracle Account. Successful login will prompt the Download to start.

Page 12: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

12

https://akabot.com

Step 2: Install Java JDK 8

1. Run the Installer you have downloaded from Step 1. Make sure you run as

Administrator. You will see a Setup Wizard to guide you through the steps. Simply

click “Next” for all prompts.

Page 13: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

13

https://akabot.com

2. After Installation is complete, you will see the Complete Notification as below. Simply

click “Close”. You have successfully installed JDK.

Page 14: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

B. MySQL 8.0

Step 1: Download MySQL 8.0

1. Go to MySQL download site at https://dev.mysql.com/downloads/installer/

2. Follow the website instructions to download MySQL. Choose MySQL Community

Installer.

14

https://akabot.com

Step 2: Install MySQL

1. Run the Installer you have downloaded from Step 1. Make sure you run as

Administrator. You will see a Setup Wizard to guide you through the steps.

2. To run akaBot Center, you will need MySQL Server and MySQL Workbench.

Choose “Custom” as the Setup Type. Click “Next”.

Page 15: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

14

https://akabot.com

3. Under MySQL Servers > MySQL Server, choose the newest version for MySQL

Server. Add to the download list by clicking the green arrow (i).

4. Similarly, under Application > MySQL Workbench, choose the newest version for

MySQL Workbench. Add to the download list by clicking the green arrow (i).

5. Now you should see MySQL Server and MySQL Workbench in the “Products To

Be Installed” box. Click “Next”.

(i)

Page 16: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

6. Click “Execute” to start installation. Wait until all products have been installed.

16

16

https://akabot.com

7. Click “Next”.

Page 17: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

8. Click “Next”.

17

17

https://akabot.com

9. Click “Next”.

Page 18: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

10. Click “Next”.

18

18

https://akabot.com

11. Click “Next”.

Page 19: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

12. Set a MySQL Root Password. It is recommended you set it to the default password

”sis@12345” to avoid having to update Config file later. Click “Next”.

19

19

https://akabot.com

13. Click “Next”.

Page 20: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

14. Click “Execute” to apply the changes.

20

20

https://akabot.com

15. Wait till everything is finished. Click “Finish”.

Page 21: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

16. Click “Next”.

21

21

https://akabot.com

17. If you see this prompt, we have successfully finished installation. Click “Finish”.

Page 22: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

22

https://akabot.com

Step 3: Setup MYSQL account to enable remote connection

Please follow these steps to set up remote connection with MYSQL.

1. Create a MYSQL account and grant access to specific database (akaBot Center

Database in this document)

i. Open MySQL Workbench. Go to “Local instance”. You will see a “Connect to

MySQL Server” prompt. Enter the password for root account, which you have set

in Step 2.12.

Page 23: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

23

23

https://akabot.com

ii. If “aka_orchestrator” database has not been created, create it as follows:

1. Click (1) to open Create new database prompt.

2. Input Schema Information as below:

• Name: aka_orchestrator

• Charset/Collation: utf8 ; utf8_general_ci

3. Hit “Apply”.

4. “Apply SQL Script to Database” dialog will show up. Click “Apply”.

5. Click “Finish”.

1

4

5

Page 24: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

24

https://akabot.com

Step 4: Test MySQL from remote client using MySQL Workbench

Before installing other software, make sure that MySQL has been set up properly.

1. Re-open MySQL Workbench .

2. Click the “Add Connection” button (see picture below) to open “Setup New

Connection” window.

3. In the “Setup New Connection” prompt, create a Connection Name and enter your

Username (Account created in Step 2.12)

4. Click “Test Connection”.

5. You will see a prompt to enter your credentials. Enter your password. Click “OK”.

6. If you see a prompt confirming successful connection, MySQL has been successfully

installed.

Page 25: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

25

25

C. Apache Tomcat 8.5

Step 1: Download TOMCAT

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

2. Choose the appropriate installer for your operating system (64 or 32 bit).

Step 2: Install TOMCAT

1. Run the apache-tomcat-8.5.53.exe file you have downloaded from Step 1. Make sure you

Run as Administrator.

2. In Windows 10, the Windows Defender Smart Screen prompt might show up. Confirm

to run by clicking “Run anyway”.

3. Apache Tomcat Setup prompt will show up. Click “Next”.

Page 26: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

26

26

4. Click “I Agree”.

5. Click “Next”.

Page 27: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

27

27

6. Leave all fields as Default. Click “Next”.

7. Click “Next”.

Page 28: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

28

28

7. Click “Install”.

8. Wait until the Installation is finished.

Page 29: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

29

29

9. Click “Finish”.

Page 30: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

30

30

D. APACHE ACTIVE MESSAGE QUEUE

Step 1: Download Active Queue

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

2. Under “All time Apache ActiveMQ releases pages”, select package version 5.15.1.

3. You will be redirected to the page below. Download the Windows Distribution

package.

Step 2: Install Active Queue

1. Unzip the downloaded file in Step 1. You will see the folder below. Open “BIN”.

Page 31: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

31

31

2. You will see the folder below. Depending on your current OS, open “WIN32” or “WIN64”.

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

Step 3: Verify installation

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

Page 32: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

32

32

2. You will find the “Services” prompt as below. Click on “ActiveMQ” (1). You will see the

“ActiveMQ Properties” prompt show up. Click “Start” (2).

3. Navigate to URL: http://localhost:8161/

4. If needed, enter the default credential as below

• Username: admin

• Password: admin

5. If you see the result as below, you have successfully installed ActiveMQ.

1

2

Page 33: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

33

33

E. AKABOT CENTER

Step 1: Create MySQL Database for CENTER

1. You should already have “aka_orchestrator” database created in Step 3.1.viii.

Step 2: Get CENTER Installation Package

You can acquire CENTER installation package from the Licensing Email, or from this link.

This package contains one .war file (E.g: “akaBot-center-2.0.1.1.war”). Rename this file to

“ROOT.war”.

Step 3: Stop TOMCAT

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

2. Click on Apache Tomcat 8. (1)

3. You will see the “Apache Tomcat 8 Properties” prompt show up. Click “Stop” (2).

1

2

Page 34: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

34

34

Step 4: Copy root.war into Tomcat8.5\webApps folder

1. Locate Tomcat 8.5/webApps directory. Remove everything in this folder.

2. Copy root.war file to this directory.

Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then

Stop TOMCAT.

1. Start Apache Tomcat 8.5 service. The steps are similar as in Step 3.

2. After you start TOMCAT, go back to Tomcat 8.5/webApps. You should see an

unzipped ROOT folder.

3. Stop Apache Tomcat 8.5 service. The steps are similar as in Step 3.

Page 35: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

35

35

Step 4: Update credentials information

1. Go back to Tomcat 8.5/webApps. You should see the ROOT folder already

unzipped.

2. Go to ROOT > WEB-INF > classes > config. You will need to update information

into 2 files: “application-prod.yml” and “application-dev.yml”.

3. In each file, update the following information. Make sure you change for both files.

1. Database Credentials (Created from Step 3.12). If you use the default

Credentials (root / sis@12345), you will not have to update this.

2. Database URL: Change the initial part of the URL (See Picture below).

It should be

[IP Address of the machine with akaBot Center]:3306/[Database Name].For example, if your Machine’s IP Address is 10.16.20.16, Database Name is aka_orchestrator, then the

Database URL should be changed to jdbc:mysql:// 10.16.20.16:3306/aka_orchestrator/...

2

1

Page 36: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

36

36

Step 6: Verify the result.1. Open your browser and navigate to : http://localhost:8080/#/ . If you are using a

different machine (not the machine where Center is installed), replace “localhost”

with the Center Machine’s IP address.

2. Enter your account to access CENTER

1. Username: admin

2. Password: admin

If you log in successfully, you have successfully installed akaBot Center.

Step 5: Start TOMCAT

Follow the same steps in Step 3 to start TOMCAT again.

Page 37: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

37

III.SYSTEM REQUIREMENTS

1. AKABOT STUDIO

HARDWARE REQUIREMENTS

https://akabot.com

Item Pre-requisites Recommended

CPU 1.4 GHz 32-bit (x86) Dual Core 1.8 GHz

RAM 4 GB 4 GB

SOFTWARE REQUIREMENTS

Item Supported Versions

Operating

Systems

Windows 7

Windows 8

Windows 10

Windows Server 2008 R2

Windows Server 2012 R2

Windows Server 2016

.NET

FrameworkMinimum: 4.5.2

2. AKABOT AGENT

HARDWARE REQUIREMENTS

Item Pre-requisites Recommended

CPU 2x1.8 GHz 32-bit (x86) 4x2.4 Hz 64-bit

RAM 4 GB 4 GB

SOFTWARE REQUIREMENTS

Item Supported Versions

Operating

Systems

Windows 7

Windows 8.1

Windows 10

Windows Server 2008 R2

Windows Server 2012 R2

Windows Server 2016

.NET

FrameworkMinimum: 4.5.2

Page 38: INSTALLATION GUIDE FOR AGENT, STUDIO & CENTER...Step 5: Start Tomcat to unzip ROOT.war. Verify ROOT.war has been unzipped. Then Stop TOMCAT. 1. Start Apache Tomcat 8.5 service. The

38

3. AKABOT CENTER

HARDWARE REQUIREMENTS

https://akabot.com

Number of

Robots

CPU Cores

(min 2 GHz)

RAM

(GB)

HDD

(GB)

<20 4 8 200

<50 4 8 250

<100 4 8 300

<200 4 8 350

<250 4 8 400

<300 8 16 400

<400 8 16 450

<500 16 16 450

SOFTWARE REQUIREMENTS

Item Supported Versions

Operating Systems

Windows 7

Windows 8.1

Windows 10

Windows Server 2008

R2 Windows Server

2012 R2 Windows

Server 2016

MySQL

Community ServerMinimum: MySQL Community Server version 8.0

JRE (JDK*) Minimum: JRE 8 (JDK 8)

Tomcat Minimum: Tomcat 8.5

Apache Active

Message QueueMinimum: version 1.15.1

*JDK is optional