Install Akabot Center 4X and MSSQL on Microsoft Windows

This guide provides instructions to installing a single instance of akaBot Center version: 4.x with MSSQLas the database engine. The target Operating System (OS) in this guideline is Microsoft Windows.

1. Prerequisites

1.1. Hardware and OS Requirements


Configuration	Requirements
Hardware	RAM: 32GB or higher Core: 8 CPU or higher SSD: 512 GB
Operating System	Windows 10, 11, Server 2012 R2/2016/2019

1.2. Software Packages

The installation must be performed using an account with Administrator (root) privileges on the target machine.
You need to prepare the installation package according to the following list.

Note:

If the computer where you're installing Center does not have an internet connection, please download the installation package externally and copy it to the machine.
To avoid errors during installation with command line execution, please use a dedicated folder for akaBot Center installation and name the installation package directory without any spaces. For example: C:\akaBot


#	Name	File Name	Version	Description	Download Link
1	akaBot Center	akaBot-center- 4.x.x.x.war	Newest version	akaBot Center installation package	akaBot provides through email after the customer makes a purchase.
2	Java Developer Kit	openlogic-openjdk-17.0.16	17.0.16	Open logic JDK 17.0.16	Download
3	Apache tomcat	apache-tomcat-*.exe	10.1.54	Web server Apache Tomcat	Download
4	ActiveMQ	apache-activemq- 5.15.1-bin.zip	5.15.1	ActiveMQ for Queue functionality in akaBot Center	Download
5	MS SQL Server	SQL2025-SSEI-Eval	2025	The database engine of akaBot Center	Read Section 3.1 for more details

2. Java JDK 17 Installation

Run the installer -openlogic-openjdk-17.0.16 you have downloaded. After that, click "Next" to proceed.

After Installation is complete, you will see the Complete Notification below. Simply click Finish. You have successfully installed JDK.

Note: Make sure that JAVA_HOME presents in your environment variables by typing command echo %JAVA_HOME%, the output should be a path that point to jdk 17 ex:C:\Program Files\OpenLogic\jdk-17.0.16.8-hotspot

3. MSSQL installation

3.1. Install MSSQL

Download link: MSSQL 2025

3.2.Setup MSSQL

Step 1: Install

Opensetup file from your computer
Select "Download media" option

Click "Download"

Step 2: Open file

Right-click to open the downloaded file in Windows Explorer.

After that, a new DVD drive named SQLServer2025 (D:) will appear. Click it to open.

Step 3: Set up

Opensetup file from the computer

Click Installation -1 and click New SQL Server standalone installation or add features to an existing installation -2

Follow these steps below:

Uncheck "Azure Extension for SQL Server" before clicking "Next"

Tick box "Database Engine Services" then click button "Next"

Wait for operation completing then click button "Back"

Continue to click "Next"

Tick Mixed Mode - 1, Enter password (example: sis@12345) - 2, Add Current User - 3 and click Next - 4

Here is the successful screen. Click "Close"

3.3. Enable Remote Connection

Step 1: Open SQL Server Management Studio and connectto server.

(1) Open "Home" to copy this field and paste as server name

(2) Input password that you created in 3.2 > Step 3

(3) Tick "Trust Server certificate"

(4) Click "Connect"

Step 2: Open Properties SQLServer.

Select Security and tick SQL Server and Windows Authentication mode.

Step 3: Open SQL Server Configuration Manager.

Selected Protocols for MSSQLSERVER -> Enabled Named Pipes and TCP/IP

Step 4: Click "Restart" MSSQL Server Service.

3.4. Create new Database empty

Step 1:Open SQL Server Management Studio

Step 2: Right Click Databases -1 & click New Database-2

Step 3: Enter Database Name -1, click OK -2

Ex: database name aka_orchestrator

4. Apache Tomcat installation

4.1. Install Apache Tomcat

Apache Tomcat installation:

Uncheck "Run Apache Tomcat"
Uncheck "Show Readme"
Click the "Finish" button to complete the installation.pe your information message here.

The installation path for Apache Tomcat: %TOMCAT_PATH% = C:\Program Files\Apache Software Foundation\Tomcat 10.1

4.2. Apache Tomcat Configuration

4.2.1. Configure log settings

Step 1: Open the file**%TOMCAT_PATH%\conf\logging.properties**

Step 2: Add attribute maxDays to specify the maximum number of days that rotated access logs will be retained for before being deleted for the catalina, localhost, host-manager, manager logs. If not specified, the default value of-1will be used which means never delete old files.

Example: keep 90 daysworth of history. Change the number at the end of the following rows:
- 1catalina.org.apache.juli.AsyncFileHandler.maxDays = 90
- 2localhost.org.apache.juli.AsyncFileHandler.maxDays =90
- 3manager.org.apache.juli.AsyncFileHandler.maxDays =90
- 4host-manager.org.apache.juli.AsyncFileHandler.maxDays =90

Step 3: Save changes and close the file.

Step 4: Open the file %TOMCAT_PATH%\conf\server.xml*

Step 5: Un-Comment the line of log setting to turn on the log and add attribute maxDays as below:

Step 6: Save changes and close the file

4.2.2. Other settings

Step 1: Navigate to the path %TOMCAT_PATH%\bin and double-click the file Tomcat10w.exe to open the Apache Tomcat Service configuration.

Step 2: On the General tab

Select Startup type: Automatic
Choose Apply to apply the configuration changes.

Step 3: On the Logging tab

(1) Log prefix: Remove "commons-daemon"

(2) Redirect Stdout: Remove "auto"

(3) Redirect Stderror: Remove "auto"

(4) Choose Apply to apply the configuration changes.

Step 4: On the Java tab

a. Adjust the Java Heap configuration:

Initial memory pool: Enter a value <= 1/4 of the server's RAM.

Example: Server RAM = 32 GB -> Initial memory pool should be <= 1/4 * 16 * 1024 MB

Maximum memory pool: Enter a value <= 1/2 of the server's RAM.

Example: Server RAM = 32 GB -> Maximum memory pool should be <= * 16 * 1024 MB

Note: If you enter a value that is too large, it may prevent Apache Tomcat service from starting and result in errors.

b.Choose Apply to apply the configuration changes.

Step 5: Start the Tomcat Service

On the General tab, select Start to initiate the Apache Tomcat service.

4.3. Check Apache Tomcat Installation

Step 1: After installation and configuration, go to the Services screen and check the status of the Apache Tomcat service.

If the Status is not Running, start the Apache Tomcat service.
If the Status is Running, proceed to step 2.

Step 2: Access the URL http://localhost:8080 in Chrome to verify the successful installation of Apache Tomcat:

5. ActiveMQ installation

5.1. Install ActiveMQ

Step 1: Extract the file "apache-activemq-5.15.1-bin.zip" to the desired installation path.

For example: ACTIVEMQ_PATH = C:\akaBot\apache-activemq-5.15.1

Note: The installation path should not contain any spaces.

Step 2: Open Command Prompt with Administrator privileges.

Step 3: Run the file %ACTIVEMQ_PATH%\bin\win64\InstallService.bat to install the ActiveMQ service.

Run command:C:\Windows\System32>C:\akaBot\apache-activemq-5.15.1\bin\win64\InstallService.bat

Step 4: Start the ActiveMQ service.

5.2. Java Heap Configuration

Step 1: Stop service ActiveMQ

Step 2: Open the file %ACTIVEMQ_PATH%\bin\win64\wrapper.conf and configure the parameters:

wrapper.java.initmemory: Enter the initial value for the Java Heap memory.

For example, if the server has 32 GB of RAM, you can enter 1024.

wrapper.java.maxmemory: Enter the maximum value for the Java Heap memory.

For example, with a server having 32 GB of RAM, you can enter 4096.

Step 3: Start ActiveMQ Service

5.3.Check ActiveMQ Installation

Step 1: Check the Running status of the ActiveMQ service. If it is not running, start the service.

Step 2: Access the URL http://localhost:8161 to verify the successful installation of ActiveMQ.

6. akaBot Center Installation

Download akaBot-center- 4.x.x.x.war.

6.1. Copy and extract war file

Step 1: Stop Apache Tomcat service

Step 2: Delete all folders in %TOMCAT_PATH%/webapps.

Step 3: Copy the file akaBot-center-x.x.x.x.war to the**%TOMCAT_PATH%/webapps/** directory

Rename it to ROOT.war.

Step 4: Restart the Apache Tomcat service and wait for the ROOT.war to be extracted into the ROOT directory.

Step 5: Stop the Apache Tomcat service.

6.2. akaBot Center configuration

6.2.1. Config quartz.properties

Step 1: Stop the Apache Tomcat service (if the Apache Tomcat service is currently running).

Step 2: Modify the configuration in the file %TOMCAT_PATH%/webapps/ROOT/WEB-INF/classes/quartz.properties as follows:

1. Comment out the jobstore configuration for MySQL.

2. Remove the "#" character at the beginning of the line for the jobstore configuration for MSSQL to uncomment it.

6.2.2. Configure the MSSQL Database Connection

Step 1: Navigate to the path %TOMCAT_PATH%/webapps/ROOT/WEB-INF/classes/config/

Step 2: Modify the configuration in both files: application-dev.yml and application-prod.yml

Removethe # characters at the beginning of the lines to uncomment the configuration and enable MSSQL usage. Add the "#" characters at the beginning of the lines to comment out the configuration and disable MySQL.

Input your username and password that you created in 3.2>Step 3.

application-dev.yml

application-prod.yml

Save files after configuring.

6.2.3. Log setting

Open the file %TOMCAT_PATH%/webapps/ROOT/WEB-INF/classes/logback-spring.xml
Change the log level to ERROR
Change the setting in rolling log file as below:

maxFileSize: Limit the size of each file. Ex: 200MB.
maxHistory: The optional maxHistory property controls the maximum number of archive files to keep. Ex: 20
totalSizeCap: The optional totalSizeCap property controls the total size of all archive files. Ex: 20GB

Save changes and close file
Start the Apache Tomcat service and access http://localhost:8080/ to verify the installation of akaBot Center.

username:admin
password: admin
You will be redirected to the dashboard as shown below.

7. Troubleshooting

7.1. ActiveMQ

7.1.1. Unable to execute Java command

Open the file %ACTIVEMQ_PATH%\bin\win64\wrapper.conf and configure the parameter:

wrapper.java.command=%JAVA_HOME%/bin/java.exe

7.1.2. Other Errors

Please check the error details in the log file of ActiveMQ: %ACTIVEMQ_PATH%\logs\data\wrapper.log

8. Backup for disaster recovery

Information to be backed up for disaster recovery scenarios:


No	Name	Path	Description
1	akaBot Center	Database	Database (MSSQL) of akaBot Center
		%TOMCAT_PATH%/filestorage	Folder containing .nupkg files from akaBot Studio published to akaBot Center
		%TOMCAT_PATH%\webapps\webapps\ROOT\WEB- INF\classes\config\application.yml %
		TOMCAT_PATH%\webapps\webapps\ROOT\WEB- INF\classes\config\application-dev.yml %
		%TOMCAT_PATH%\webapps\webapps\ROOT\WEB- INF\classes\config\application-prod.yml %
		TOMCAT_PATH%\webapps\webapps\ROOT\WEB- INF\classes\config\quartz.properties	Configuration files for akaBot Center
2	activeMQ	%ACTIVEMQ_PATH%\data	activeMQ data directory

9. Activate Licenses

Please follow the instruction via Activation

1. Prerequisites​

2. Java JDK 17 Installation​

3. MSSQL installation​

3.1. Install MSSQL​

3.2.Setup MSSQL​

3.3. Enable Remote Connection​

4. Apache Tomcat installation​

4.1. Install Apache Tomcat​

4.2. Apache Tomcat Configuration​

4.3. Check Apache Tomcat Installation​

5. ActiveMQ installation​

5.1. Install ActiveMQ​

5.2. Java Heap Configuration​

5.3.Check ActiveMQ Installation​

6. akaBot Center Installation​

6.1. Copy and extract war file​

6.2. akaBot Center configuration​

7. Troubleshooting​

7.1. ActiveMQ​

8. Backup for disaster recovery​