How to upgrade from akaBot Center from Version 3.0.1.4 - 3.0.1.9

This guide provides step-by-step instructions to safely update akaBot Center from version 3.0.1.4 to 3.0.1.9. Please follow all steps carefully and back up your data before proceeding.

Step 1: Back Up the webapps Folder

• Navigate to:
  %APACHE_TOMCAT_HOME%\webapps
  

Step 2: Stop Apache Tomcat Service

• Stop the Tomcat service before making any changes.

• 

Step 3: Clear the webapps Folder

• Delete all existing content inside the webapps directory.

Step 4: Copy and Rename the WAR File

• Rename the downloaded file:
  From: akaBot-center-3.0.1.9-b.war -> ROOT.war
  To: ROOT.war

• Copy the renamed ROOT.war file to: %APACHE_TOMCAT_HOME%/webapps

Step 5: Start Apache Tomcat Service

• Start the Tomcat service and wait until the ROOT folder is automatically extracted.

• 

• After successful extraction, stop the Tomcat service again.

Step 6: Compare and Update Configuration Files

⚠️ Important: Be careful with spacing and tabs when editing YAML files.
It is recommended to copy your previous configuration files from version 3.0.1.4 and compare/update them with version 3.0.1.9.

Navigate to:

webapps\ROOT\WEB-INF\classes\config

Files to update:

application.yml

• ✅ Add the following configuration:

consumer:
          # CAUTION: Set prefetch-size to a value > 1 will disable the priority queue item feature
          agent-pool:
            # To fix the issue agent pool with only one agent and get transaction item from agent pool queue, set prefetch-size to 1
            prefetch-size: 1000
          trigger:
            prefetch-size: 1
          on-demand:
            prefetch-size: 1000

• Update version values: Change from 3.0.1.4 → 3.0.1.
  

• ✅ Add additional optional configuration (commented by default):

#enable with cros websocket
#  web-socket:
#    allowed-origin-patterns: "*"
# Configuration for duplicated job checks, default is off.
# Schedule to check for duplicated jobs options:
  #1 . Every 5 minutes: 0 */5 * * * *
  #2 . Every 10 minutes: 0 */10 * * * *
  #3 . At midnight: 0 0 0 * * *
#  clear-duplicated-jobs-cron: 0 */5 * * * *

application-dev.yml

• Change value (add s)
  

• ✅ Add OAuth2 configuration:

oauth2:
  enable: false
  provider: azure
  client:
    #   URL login
    feCallback: "#/callback"
    registration:
      azure:
        client-id: ${clientId}
        client-secret:  ${secretId}
        scope: openid, profile, email
        authorization-grant-type: authorization_code
        redirect-uri: "{domain}/oauth2/callback/azure"
    provider:
      azure:
        authorization-uri: https://login.microsoftonline.com/${tenantId}/oauth2/v2.0/authorize
        token-uri: https://login.microsoftonline.com/${tenantId}/oauth2/v2.0/token
        user-info-uri: https://graph.microsoft.com/v1.0/me?$select=userPrincipalName,mail,givenName,surname
        sync-user-enable: true
        login-by-email: false
        #use mapping for account
        user-mapping:
          usernameMapping: "userPrincipalName"
          emailMapping: "mail"
          firstNameMapping: "givenName"
          lastNameMapping: "surname"
          ouNameMapping: ""
          #role default for account sync
          roleDefault: "ROLE_USER"

application-prod.yml

• Perform the same updates as in application-dev.yml.

Step 7: Restart Apache Tomcat Service

• Start the Tomcat service after all configurations are updated.

Step 8: Verify akaBot Center Access

• Open your akaBot Center URL in a browser.

• If everything is working correctly, the update was successful.

Troubleshooting

If you encounter any errors:

1. Stop the Apache Tomcat service.

2. Restore the previously backed-up webapps folder.

3. Start the Apache Tomcat service again.