Client Commands

The client command enables you to run different commands in AE for both single and clustered setup. This command can be used to start and stop the component, check the status of components, apply the patch files, and take a heap snapshot of AE running on several servers from a single server.  While executing this command, both single and clustered setups will respond in the same way. The sample output provided for the client command is for a clustered setup.


The client command includes the following commands:

NOTE: 

In the command prompt, a partial search can be used to filter the AE client commands. For example, if you type pa, then it will filter the PATCH and STOPALL commands.

Prerequisites

For executing the client command at least one component should be running on the server machine. To view all of the server names in a clustered system, each server machine must have at least one component running.

Syntax Defined

Syntax: ae client

Sample Output

D:\RPA\AssistEdgeAutomation\scripts>ae client
Connected to Server
? Command ...
Status
Start
Stop
StopAll
Patch
HeapSnapshot
Exit

 

NOTE:

At a time, you can only run the desired client command on a single server.

 

STATUS

The status command is used to get the status of the components across all the server machines.

Sample Output

  1. Run the ae client command.
  2. Select the status command and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Status
    Server               :RPASERVER-02
    Started On       :2023-02-17T09:15:05.000Z
    Profile               :default
    MESSAGING             :STARTING
    TXNSTORE                :STOPPED
    ML                             :STOPPED
    LOWCODE                :STOPPED
    REPORTING             :PreCheck failed: TxnStore not started yet. Next try in 30sec
    ETL                            :PreCheck failed: TxnStore not started yet. Next try in 30sec
    CONTROLTOWER    :PreCheck failed: TxnStore not started yet. Next try in 30sec
    VANGUARD             :PreCheck failed: TxnStore not started yet. Next try in 30sec
    ---------------------------------------------------------
    Server               :RPASERVER-03
                              :Status unknown
    ---------------------------------------------------------
    Server               :RPASERVER-04
                              :server stopped
    ---------------------------------------------------------
    *********************************************************
    ? Command ...
    Status
    Start
    Stop
    StopAll
    Patch
    HeapSnapshot
    Exit

 

NOTE:

The status is unknown if a server machine has crashed or if no component is manually started for a server machine.

START

The start command is used to start the component on the selected server machine. You can start one component at a time.

Sample Output

  1. Run the ae client command.
  2. Select the status command and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Start
    ? Components ...
    TXNSTORE
    MESSAGING
    CONTROLTOWER
    VANGUARD
    ETL
    REPORTING
    LOWCIDE
    ML
  3. Select the desired component and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Start
    √ Components · CONTROLTOWER
    ? Server ...
     RPASERVER-02
    RPASERVER-04
  4. Select the desired server and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Start
    √ Components · CONTROLTOWER
    √ Server · RPASERVER-04
    *********************************************************
    ? Command ...
    Status
    Start
    Stop
    StopAll
    Patch
    HeapSnapshot
    Exit

STOP

The stop command is used to stop the component on the selected server machine. You can stop only one component at a time.

 

Sample Output

  1. Run the ae client command.
  2. Select the status command and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Stop
    ? Components ...
    TXNSTORE
    MESSAGING
    CONTROLTOWER
    VANGUARD
    ETL
    REPORTING
    LOWCIDE
    ML
  3. Select the desired component and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Stop
    √ Components · CONTROLTOWER
    ? Server ...
    RPASERVER-02
    RPASERVER-04
  4. Select the desired server and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Stop
    √ Components · CONTROLTOWER
    √ Server · RPASERVER-04
    *********************************************************
    ? Command ...
    Status
    Start
    Stop
    StopAll
    Patch
    HeapSnapshot
    Exit

 

NOTE:

If you stop each component individually, the status of that server will be Status unknown.

STOPALL

The stopall command stops all the components on the selected server machine.

 

Sample Output

  1. Run the ae client command.
  2. Select the stopall command and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · StopAll

    ? Server ...
     RPASERVER-02
     RPASERVER-04
  3. Select the desired server and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server

    √ Command · StopAll 
    √ Server · RPASERVER-04
    *********************************************************
    ? Command ...
    Status
    Start
    Stop
    StopAll

    Patch
    HeapSnapshot
    Exit

 

NOTE:

If you stop all component at a time, the status of that server will be server stopped.

Exceptional Handling

If you use the stopall command to stop all the components on the logged in server machine, the following message is displayed.

 

D:\RPA\AssistEdgeAutomation\scripts>ae client
√ Command · StopAll
√ Server · RPASERVER-02
14 UNAVAILABLE: read ECONNRESET

PATCH

The patch command is used to apply minor debugging fixes. The main benefit of the patch command is that it enables the administrator to update the patch file without stopping the control tower, so that the end user session remains active. With this command, only minor patches can be applied. See Patch Commands for applying major patches.

Prerequisites

Before you run the patch commands, ensure you replace the patch files at the desired location.
 

Sample Output

  1. Run the ae client command.
  2. Select the patch command and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Patch
    ? Components ...
    CONTROLTOWER

    PROXY
  3. Select the desired component and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Patch
    √ Components · CONTROLTOWER
    ? Server ...
    RPASERVER-02
    RPASERVER-04
  4. Select the desired server and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · Patch
    √ Components · CONTROLTOWER
    √ Server · RPASERVER-04
    *********************************************************
    ? Command ...
    Status
    Start
    Stop
    StopAll
    Patch
    HeapSnapshot
    Exit

HEAPSNAPSHOT

The heapsnapshot command is used to debug the memory leakage issues. It provides the memory utilization of the running process by creating a heap dump file. The file is created based on the provided PID (process ID) and is stored in the <Installation Directory>/AssistEdgeAutomation/data folder.

 

NOTE:

Debugging can not be used in a live production setup. This command will result in a CPU and memory surge.



Sample Output

  1. Run the ae client command.
  2. Select the heapsnapshot command and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · HeapSnapshot
    ? Components ...
    CONTROLTOWER

    PROXY
  3. Select the desired component and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · HeapSnapshot
    √ Components · CONTROLTOWER
    ? PID>>
  4. Provide the PID and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · HeapSnapshot 
    √ Components · CONTROLTOWER
    √ PID · 61268
    ? Server ...
     RPASERVER-02
     RPASERVER-04
  5. Select the desired server and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · HeapSnapshot 
    √ Components · CONTROLTOWER

    √ PID · 61268
    √ Server · RPASERVER-04
    *********************************************************
    ? Command ...
    Status
    Start
    Stop
    StopAll
    Patch
    HeapSnapshot
    Exit

    NOTE:
    • The PID for Control Tower can be obtained from the controltower.log file.
    • The status command can be used to get the PID for proxy.

EXIT

If you want to stop the client command in AE, use the exit command.

Sample Output

  1. Run the ae client command.
  2. Select the heapsnapshot command and then press <Enter>8 .

    D:\RPA\AssistEdgeAutomation\scripts>ae client
    Connected to Server
    √ Command · HeapSnapshot
    ? Components ...
    CONTROLTOWER

    PROXY