Patch Commands

Following are the patch commands:

Prerequisites

  • The patch zip file must be downloaded on the server machine(s).
  • All the server-side and client-side components must be in STOP state.
  • User applying the patch must have admin rights on the sever machine.

 

NOTE: 

For more information on the patch settings, see Release Upgrade.

 

Pre-upgrade Steps

  • Create a Release folder in the <InstallationDirectory>\AssistEdgeAutomation folder of the existing build.
  • Unzip the Upgrade AssistEdgeAutomation product package, rename it as the patch name, and place it in the <InstallationDirectory>\AssistEdgeAutomation\Release folder. Rename it as patch name (for example: Release191).
  • Depending on the patch there are some additional pre-upgrade steps that must be completed before starting the upgrade. These steps are printed when upgrade command is executed. User applying the patch must ensure all the pre-steps are executed successfully.

UPGRADE

The upgrade command upgrades the AE build files from its current installed version to the patch version. For a clustered setup, this command should be used in all the server machines.

Syntax Defined

Syntax: ae upgrade <patch name>

Sample Output

D:\RPA\AssistEdgeAutomation\scripts>ae upgrade Release191
1.Ensure user is on 19.0 Version
2.Copy following files from patch
Copy ae.bat and node-version.bat from PATCH > scripts folder to BUILD > scripts folder
If any modification done in ae.bat file, please do same in new file also.
Copy ae.js file from PATCH > scripts > app folder to BUILD > scripts > app folder.

Please confirm if above pre steps has been executed?(Y/N): Y


Once the command is executed, Please confirm if above pre steps has been executed?(Y/N): 

  • Enter N, if you have not executed all the pre-steps.
  • Enter Y if you have executed all the pre-steps successfully. 
  • The command will take necessary backup, and upgrade the current installed version to latest release version.
  • If the version gets upgraded, you can see a Configuration updated and Patch Applied message.

Taking backup: Wed Jan 18 2023 08:57:02 GMT+0530 (India Standard Time)
Backup completed: Wed Jan 18 2023 08:57:28 GMT+0530 (India Standard Time)
Applying Patch: Wed Jan 18 2023 08:57:28 GMT+0530 (India Standard Time)
File copy completed: Wed Jan 18 2023 08:58:23 GMT+0530 (India Standard Time)
Updating configurations: Wed Jan 18 2023 09:04:57 GMT+0530 (India Standard Time)
Server components:
ControlTower              ........[SUCCESS]
MigrationWorkbench        ........[SUCCESS]
Vanguard                  ........[SUCCESS]
Client components:
AutomationStudio          ........[SUCCESS]
Engage                    ........[SUCCESS]
EnterprisePersonalAssistant........[SUCCESS]
RobotAgent                ........[SUCCESS]
RobotSE                   ........[SUCCESS]
APMClient                 ........[SUCCESS]
RobotAgentUpdateManager   ........[SUCCESS]
AutomationStudioUpdateManager........[SUCCESS]
Workbench                 ........[SUCCESS]
Configurations updated: Wed Jan 18 2023 09:04:57 GMT+0530 (India Standard Time)
Patch applied: Wed Jan 18 2023 09:04:57 GMT+0530 (India Standard Time)
1. Run command 'ae upgrade-db' to apply datatbase change before starting any component.
2. Run command 'ae upgrade-txn' to apply TxnStore change, TxnStore should be running before executing this command.
3. Add tag inside section for APMClient.exe.config wherever APMClient folder is placed.
4. Add following configuration inside \app\Admin\config\config.yml
beyondTrustVault:
url: "
apikey: " "
runas: " "
5. This patch contains changes for Proctor. For Proctor related changes please refer " RPA-Release Upgrade.pdf" document.
6. This patch contains changes for Vanguard .net framework version upgrade. For oracle database setup, please download below oracle DLL and place it in /data/Oracle folder.
Oracle.EntityFrameworkCore.dll (version: 6.21.61  URL: https://www.nuget.org/packages/Oracle.EntityFrameworkCore)
Oracle.ManagedDataAccess.dll (version:b3.21.6 URL: https://www.nuget.org/packages/Oracle.ManagedDataAccess.Core)
7. If any customizations or modifications done in following files:-
< >/runtime/elasticsearch/opendistroforelasticsearch-1.13.2/config/elasticsearch.yml  please apply same changes once patch is successfully applied.
8. Reports (Engage and EnterprisePersonalAssistant) are updated in this release. Please refer " RPA-Release Upgrade.pdf" steps to perform for reports.
Please execute above steps.
Updating Permission: Wed Jan 18 2023 09:04:57 GMT+0530 (India Standard Time)
Permission update complete: Wed Jan 18 2023 09:08:30 GMT+0530 (India Standard Time

D:\RPA\AssistEdgeAutomation\scripts>

 

The command will take necessary backup, and upgrade the current installed version to latest release version. If the version gets upgraded, you can see a Configuration updated and Patch Applied message. Depending upon the patch there are post upgrade steps that must be done after the upgrade is successful. These steps are printed once the patch is applied. User applying the patch must ensure all the post steps are executed.

 

NOTE: 

If an error occurs during upgrade, the command will automatically rollback to the previous version.

 

ROLLBACK

The rollback command is used to revert the AE build file changes from the patched version to the previously installed version. 


Rollback command can be used:  

  • When the rollback does not happen automatically in case there was any error during upgrade.
  • When the user decides not to proceed with the post upgrade steps and wants to rollback the build files to the previous version from the upgraded patch version.

NOTE:

In case the user applying the patch has executed the post upgrade steps then the rollback command should not be used.

 

Prerequisites

You can execute the rollback command only if you have upgraded build files from the installed version to the patched version.

Syntax Defined

Syntax: ae rollback  <patch name>

 

Sample Output  

D:\Engage\AssistEdgeAutomation\scripts>ae rollback Release191


Please confirm if you want to rollback the patch?(Y/N):
 

 

Enter Y to execute the action.

UPGRADE-DB


The upgrade-db command is used to upgrade the database changes from the release version to patch version. For a clustered setup, this command should be executed in any one of the server machines.

 

NOTE: 

This command should be used only when the post upgrade steps mention to upgrade the database.

Prerequisites

Before executing the upgrade-db command, make sure the current version is upgraded.

Syntax Defined

Syntax: ae upgrade-db

Sample Output

D:\RPA\AssistEdgeAutomation\scripts> ae upgrade-db


This script is part of 20.0 upgrade.

Are you sure you want to continue (Y/N) :

 

Enter Y to continue with the installation.

Once, the upgrade is done you will see a Database upgrade complete for version message with the upgraded version number.

UPGRADE-TXN

The upgrade-txn command is used to re-index the txnstore data from the current installed version to the patch version. For a clustered setup, this command should be executed in any one of the server machines.

 

NOTE: 

This command should be used only when the post upgrade steps mention to upgrade the TxnStore.

Prerequisites

Before executing the upgrade-txn command,

  • Ensure that the current installed version is upgraded.
  • Make sure the Txnstore is running.

Syntax Defined

Syntax: ae upgrade-txn

Sample Output

D:\RPA\AssistEdgeAutomation\scripts> ae upgrade-txn

 

Checking elastic status:

            Connection: Success

             Version: 7.10.2

             Health: yellow

 

Reindexing Completed Successfully.

 

D:\RPA\AssistEdgeAutomation\scripts>