Daily Usage Commands
Following are the daily usage commands:
Prerequisites
Before you run the daily usage commands, ensure the build is installed in the server machines(s).
START/STARTALL
The start command starts one or more components required to run AE. In addition, you can use the start command to start components for a specific profile. If no profile name is specified, the default profile is used.
Syntax Defined
Syntax: ae startall
Syntax: ae start [--profile <Profile Name>] [<Component Name 1> <Component Name 2> …]
Alias Defined
Alias: ae sall
Input Parameters
Following are the profile and component Name that can be passed as input parameters with the start command:
Profile:
Using profiles, you can set the memory usage, and logging-related information. The profile gets applied when you are starting the first component on the server machine, if you want to change profile, you must stop all components then start again. When you do not specify any profile in the start command, the components start with the default profile. For more information about profiles, see Installation.
|
NOTE: |
You can create your own profile which enables you to select the components you wish to run and specify memory usage. You must save your custom profile file in the <Installation Directory>\AssistEdgeAutomation\scripts folder as ae-profile-<Custom Name>.properties file.
|
Component Name:
- TxnStore (TXN): It is the search and analytics engine. All the data related to automation processes such as the transactional data are stored in the OpenSearch.
- Messaging (MQ): It is a message-oriented middleware that helps the various components to communicate with each other.
- Controltower (CT): It is a web-based administrative and monitoring system for users, roles, license, robots, and others.
- Vanguard (V): It is a background service that helps to perform various background jobs, monitors the status of the components of AssistEdge and sends the notifications to the intended recipients.
- ETL: It is a data processing pipeline that sends data to the OpenSearch.
- Reporting (R): It is used for reporting of the data that is stored in OpenSearch. It helps to search, view, analyze and project the data in an easy-to-understand format such as charts, tables, and maps.
- Lowcode (LC): It is a web-based system which provides the drag-drop and point-click abilities to build feature rich responsive web applications.
- ML: It is the Machine Learning (ML) component that helps in the execution of tasks using algorithms and statistical models.
|
NOTE: |
|
Sample Output
The start command can perform various operations such as:
- ae start/ae startall: This command starts all the AE components that are installed on the server machine.
The following is an example of starting all components at once:
D:\RPA\AssistEdgeAutomation\scripts> ae startall
D:\RPA\AssistEdgeAutomation\scripts>
The following is an example of starting all components, when some components are already running from the same profile:
D:\RPA\AssistEdgeAutomation\scripts>ae startall
TXNSTORE status is: STARTED
MESSAGING status is: STARTED
CONTROLTOWER status is: STARTED
D:\RPA\AssistEdgeAutomation\scripts>
This command will display the message as illustrated above for the components already running and start the remaining components. - ae start [Component Name]: If you want to start multiple components at the same time, you can specify the component names separated by space.
For example: ae start [<Component Name 1>] [<Component Name 2>]D:\RPA\AssistEdgeAutomation\scripts>ae start mq txn
D:\RPA\AssistEdgeAutomation\scripts> - ae start [--profile <Profile Name>] [<Component Name 1> <Component Name 2>]: This command will start the components based on the specified profile.
D:\RPA\AssistEdgeAutomation\scripts>ae start --profile dev mq
D:\RPA\AssistEdgeAutomation\scripts>
|
NOTE: |
|
Exception Handling
When you execute the start command, but the ports are blocked the following error message is displayed.
|
D:\RPA\AssistEdgeAutomation\scripts> ae start mg
MESSAGING: Ports not available: [“5672”, “15672”, “25672”, “4369”] Cannot start any component.
D:\RPA\AssistEdgeAutomation\scripts> |
Solution: Find and stop the process id that are accessing these ports.
STATUS
The status command is used to get the status of the components of AE for a single server machine.
Syntax Defined
Syntax: ae status
Alias Defined
Alias: ae s
Sample Output
|
D:\RPA\AssistEdgeAutomation\windows\scripts> ae status
D:\RPA\AssistEdgeAutomation\scripts>ae status LOWCODE :STOPPED REPORTING :PreCheck failed: Txnstore not started yet. Next try in 30sec |
Status command shows the status of
- Server Name: appears; indicates the name of the server on which the build is installed.
- PID: Indicates the process ID.
- Started On: Indicates the date and time at which the components started.
- Profile: Indicates the profile that is used to start the components.
Following are the various statuses of the components:
- STARTED- Signifies that the component has started.
- STARTING- Signifies that the component is still starting.
- STOPPED- Signifies that the component has stopped.
- STOPPING- Signifies that the component is stopping.
- PreCheck - Signifies that the component is waiting for another component to start on which it is dependent. For example, CONTROLTOWER is dependent on MESSAGING and TXNSTORE to start. So, until the MESSAGING AND TXNSTORE components are not started, CONTROLTOWER will show pre-check pending.
- Not installed on this System- Signifies that the stated component is not install on the server.
Exception Handling
If you use the command to check the status of a component for the build that is not installed, the following message is displayed.
|
D:\RPA\AssistEdgeAutomation\scripts> ae status
Install detail not found.
D:\RPA\AssistEdgeAutomation\scripts> |
STATUSALL
The statusall command is used to get the status of the component across all the server machine where AE is installed.
Syntax Defined
Syntax: ae statusall
Sample Output
Following is the output if AE is installed on three-machine clustered setup.
|
D:\RPA\AssistEdgeAutomation\scripts>ae statusall |
|
NOTE: |
If AE is installed on single machine, the output of status and statusall command remains same. |
STOP
The stop command stops one or more components of AE that are currently running, you can seperate the component names with space.
Syntax Defined
Syntax: ae stop <Component Name 1> [<Component Name 2> <Component Name 3> …]
Sample Output
|
D:\RPA\AssistEdgeAutomation\scripts>ae stop mq txn |
STOPALL
The stopall command stops all components of AE that are currently running.
Syntax Defined
Syntax: ae stopall
Sample Output
|
D:\RPA\AssistEdgeAutomation\scripts> ae stopall
D:\RPA\AssistEdgeAutomation\scripts> |
REPAIR
The repair command is used to update the configurations for the installed AE build on the server machine, such as port numbers, machine names, proxy server hostnames, and so on.
To update the configurations, you need to update the desired properties file(s) located in <Installation Directory>\AssistEdgeAutomation\scripts\app\install\config folder and execute the repair command.
Repair command can be used when:
- Existing ports are not available, or the user want to update the port number.
- Proxy server host name has changed.
- The machine name provided either for WEB or for APP is incorrect.
|
NOTE: |
|
Prerequisites
Before executing the repair command:
- Ensure the properties file in the <Installation Directory>\AssistEdgeAutomation\scripts\app\install\config folder is updated.
- Make sure all the components are stopped.
Syntax Defined
Syntax: ae repair
Sample Output
|
D:\RPA\AssistEdgeAutomation\scripts>ae repair **************************************************************************************************** Following components are marked for installation on this system. Following configurations have been taken from 'server.properties' and will be used for installation. Updating RabbitMQ........... [SUCCESS] Updating Migration Workbench configuration........... [SUCCESS] Reference component URLs as follows:
|