Understanding Manual Commands

Create and run manual tests in scripts for tasks that can't be automated.

Manual commands can be created and run only in scripts. They consist of a prompt and a collection of responses from which the user can choose when the command is run. They do not require a Toffee Performer to execute.

See the Combine Automated and Manual Steps video tutorial for an overview describing how to use manual commands.

Creating Manual Commands

Manual commands are created in scripts by writing a prompt in the new step bar and either pressing the shift+enter key combination or clicking on the hand icon button on the right side of the new step bar. When they are created, a default list of responses is added to the manual command, with the verdicts Pass, Fail, and Error. These responses become visible when clicking on the created step for editing.

Each response's text can be changed or left as the default. You can remove or add any number of responses respectively using the delete button to the right of each response or the verdict buttons at the bottom of the step editor. New responses that are added using the verdict buttons are modeled after the default responses. Each response has a toggle for requiring an explanation for the verdict. If the option is not enabled, the user still has the option to include an explanation when the manual command is run. For the default list of responses, the fail and error verdicts require an explanation, while the pass verdict does not.

There is currently no way to set the expected result of manual commands. In the step result, the expected result is blank by default.

Manual commands can also use variables, both in the prompt and in the text of the responses. See the Save and Use Variables page for information on how to use variables in a string.

Running Manual Commands

When a script containing a manual command is run and the manual command is executed, a modal appears in the SPA. This modal presents the prompt defined for the manual command and any of the possible responses the user can make.

If the response chosen by the user requires an explanation, the user will not be able to continue until an explanation is written in the text box below the responses. If the response does not require an explanation, they can add an explanation if they deem one is necessary and click on the Continue button to confirm the verdict.

When the verdict is confirmed by the user, the response is added to the result. The text of the response appears first in the actual result. If any explanation is given, it is appended to the actual result.