Command response will be returned for each command upon delivery to the Automation. The format for the response is:
“<command>;<status>[;<state>][;Reason=<reason>]”
The parameters in brackets are optional, depending on the command and command processing:
|
Parameter |
Description |
|
command |
The command the response refers to – generally upper-case ASCII but checks against a given value should be performed in a case-insensitive manner. |
|
status |
The status of the command – “SUCCEEDED” means the command was passed to the analyzer; “FAILED” means the command was not passed to the analyzer or the analyzer could not process the command. |
|
state (optional) |
Some commands may return a state parameter in the form “State=<state>” where the state value will be command dependent. |
|
reason (optional) |
Some commands may return a reason parameter in the form “Reason=<reason>” where the reason value will be command dependent. |
In general:
-
The Automation Server does not block waiting on a response to any command. The client is responsible for the block based on whether the response of a command is required before the next command can be sent.
-
A failure notification is always sent if a command is not delivered to the analyzer successfully.
-
A success notification is always sent if a command is delivered to the analyzer
successfully. The word “delivered” is important. A success notification does not mean that the command was completed successfully, only that it was delivered to the analyzer successfully and that the action was started. The successful delivery of a command to the analyzer does not guarantee a successful execution of the command.
-
Checks for command returns should be made in a case-insensitive manner.