Generic Usage Commands

Following are the generic usage commands:

HELP

The Help command displays the complete list of AE commands along with their respective description. It helps you to keep the list at your finger-tip and identify the command you need as per your requirement.

Syntax Defined

Syntax: ae help

Alias Defined

The help command has the following alias defined.

  • ae h
  • ae ?

INSTALL

The install command installs the AE components on a single system or in a clustered setup based on the configurations specified.

Prerequisites

Before you run the install command:

  • Ensure the build is downloaded and extracted in the server machine.
  • The license must be placed in the <Installation Directory>\AssistEdgeAutomation\data\License folder. Every server machine in a cluster setup should have its own license.
  • The properties files must be updated as per the deployment you wish to achieve. In case of a clustered setup, the updated properties files must be copied in all the server machines.
  • Deployment, component, and server properties are updated as per the required configuration. For more details, see Installation.

Syntax Defined

Syntax: ae install

Alias Defined

Alias: ae i

Sample Output

D:\RPA\AssistEdgeAutomation\scripts>ae install
********************************************************************************
                                            AssistEdge Installation
********************************************************************************
Following components are marked for installation on this system.
Please validate component and Port Numbers.
--------------------------------------------------------------------------------
Web server:                             Port: 8443
         Messaging                                Port: 5672 
         Reporting                                 Port: 5601
         ControlTower                          Port: 3860
         LowCode                                  Port: 8001
App server:                           Port: 8443
        TxnStore                                Port: 9200 
        ETL                                          Port: 9600
        ML                                           Port: 8000
Following configurations have been taken from 'server.properties' and will be used for installation.
Please validate the configurations:
-----------------------------------------------------------------------------------------
    _AE_MESSAGING_WEB_PORT        : 15672
    _AE_MESSAGING_EPMD_POR        : 4369
    _AE_MESSAGING_DIST_PORT         : 25672
    ERLANG_COOKIE_VALUE                 : ZVIJOUEQVPCRXLMYJWAFJFVDFHTYFDSFFYHHJMNKLPOJIJNMGVXSZQAZCVBNM
GDSRYGJNIKPOKLJHFEDSXCFHNMKKLHSQWDXGOLKHNCFDFZXVEDKLOJTGDSCVHMSWQQADFJKOIJJNGFDWSSSFIIKHE
    _AE_TXNSTORE_TCP_PORT            : 9300
    _AE_CLUSTER_PORT                        : 8445
    _AE_CLUSTER_NAME                      : aedev
    _AE_ML_PREDICTOR                       : true
    _AE_ML_MODEL_GENERATOR           : true
    _AE_ML_QUEUE_FORECAST               : true
    _AE_LOWCODE_SERVER_PORT          : 8002
-----------------------------------------------------------------------------------------
Do you want to continue with Installation? (Y/N):

Enter Y to continue with the installation.

Install Byfile (Optional Switch)

INSTALL BYFILE (ae install byfile):  The byfile switch can be used to install AssistEdge on individual servers in a clustered setup. All the user inputs provided during the installation are saved in encrypted format in the installDetail file located at <Installation Directory>\AssistEdgeAutomation\scripts\app\install\config once the installation is completed on a single server. When you run the install byfile command, the command ensures to use the user input by reading data from the installDetail file.

Prerequisites

  • You must install the build on at least on one server machine, to generate the installDetail file.
  • Ensure to copy the installDetail file in the <Installation Directory>\AssistEdgeAutomation\scripts\app\install\config folder from the server machine, where the build was installed and paste it in the <Installation Directory>\AssistEdgeAutomation\scripts\app\install\config folder of the other server machines where you want to run the installation.
  • Ensure to copy and paste the SSL certificates and the updated properties files from the server where the installation was completed to the server where the installation is to be done.

Syntax Defined

Syntax: ae install byfile

Alias Defined

Alias: ae i byfile

Sample Output

D:\RPA\AssistEdgeAutomation\scripts>ae install byfile
********************************************************************************
                                            AssistEdge Installation
********************************************************************************
Following components are marked for installation on this system.
Please validate component and Port Numbers.
--------------------------------------------------------------------------------
Web server:                             Port: 8443
         Messaging                                Port: 5672 
         Reporting                                 Port: 5601
         ControlTower                          Port: 3860
         LowCode                                  Port: 8001
App server:                           Port: 8443
        TxnStore                                Port: 9200 
        ETL                                          Port: 9600
        ML                                           Port: 8000
Following configurations have been taken from 'server.properties' and will be used for installation.
Please validate the configurations:
-----------------------------------------------------------------------------------------
    _AE_MESSAGING_WEB_PORT        : 15672
    _AE_MESSAGING_EPMD_POR        : 4369
    _AE_MESSAGING_DIST_PORT         : 25672
    ERLANG_COOKIE_VALUE                 : ZVIJOUEQVPCRXLMYJWAFJFVDFHTYFDSFFYHHJMNKLPOJIJNMGVXSZQAZCVBNM
GDSRYGJNIKPOKLJHFEDSXCFHNMKKLHSQWDXGOLKHNCFDFZXVEDKLOJTGDSCVHMSWQQADFJKOIJJNGFDWSSSFIIKHE
    _AE_TXNSTORE_TCP_PORT            : 9300
    _AE_CLUSTER_PORT                        : 8445
    _AE_CLUSTER_NAME                      : aedev
    _AE_ML_PREDICTOR                       : true
    _AE_ML_MODEL_GENERATOR           : true
    _AE_ML_QUEUE_FORECAST               : true
    _AE_LOWCODE_SERVER_PORT          : 8002
-----------------------------------------------------------------------------------------
Updating RabbitMQ...........                                                                         [SUCCESS]

Updating Migration Workbench configuration...........                           [SUCCESS]

Reference component URLs as follows:
ControlTower    :  https://EngageLB-01:8443/ui/Admin
TxnStore             :  https://EngageLB-01:8443/ts-api
Messaging          :  https://EngageLB-01:8443/messaging-sso
Reporting           :  https://EngageLB-01:8443/reports
LowCode            :  https:/EngageLB-01:8443/jw
ETL                      :  https://EngageLB-01:8443/etl
ML                       :  https://EngageLB-01:8443/ml
D:\RPA\AssistEdgeAutomation\windows\scripts>

UNINSTALL

The uninstall command uninstalls the AE components.

 

NOTE: 

Once you execute the uninstall command, delete the entire product build folder.

Prerequisites

Before executing the uninstall command. Run the stopall Command.

Syntax Defined

Syntax: ae uninstall

Sample Output

D:\RPA\AssistEdgeAutomation\scripts>ae uninstall


Please delete Container folder.


D:\RPA\AssistEdgeAutomation\scripts>