Command-Line Tool adminCli

The adminCli command-line tool is a Java application that allows clients to check whether an engine is running and obtain its state. Further, users can call the tool with a script to initiate additional actions dependent upon the returned exit code.

Note that Engine Status can also be tested using the scheduled task CHECK_ENGINE_STATUS.

Refer to Calypso Scheduled Tasks documentation for details.

 

Run the tool in a command window opened to <calypso home>/deploy-local/<Env>/adminCli.bat\.sh.

You can use the following arguments:

• -help - To display adminCli's arguments.
• -list - To display a list of all engines registered in the system, both running and not running.
• -engineName <engine name> - Mandatory (except for -help)- Specify an engine name, or ALL to obtain the status for all running engines.
• -waitPeriod - Specify the period in milliseconds that the application will wait for a response from the engine. If not specified, the tool uses the default of 30000 milliseconds (30 seconds).
• -quiet - To display no output unless there is an error.
• -verbose - For debugging purposes. To provide detailed information.
• -env <env> - Mandatory - Specify the ENV name.
• -user <user name> - Mandatory - Specify the user name.
• -password <password> - Mandatory - Specify the password.

 

Examples

All examples are single-line commands.

 

Checks the status of the Message Engine.

adminCli.bat -engineName MessageEngine -env <env> -user <user name> -password <password>

Sample output

Engine MessageEngine as successfully responded, Status: Running

 

List all currently running engines and their status:

adminCli.bat -engineName ALL -env <env> -user <user_name> -password <password>

Sample output

Engines currently running:

PositionEngine   Status: Running

InventoryEngine   Status: Running

LiquidationEngine   Status: Running

MessageEngine   Status: Running

TransferEngine   Status: Running

 

Check the status of the Trade Diary engine:

adminCli.bat -engineName DIARYENGINE -env <env> -user <user_name> -password <password>

Sample output

Engine DiaryEngine is not running