The Question step can be used to add a decision point to your workflows. This allows you to define a question with preconfigured responses that determine the next step to run in the workflow.
When the step is run, the question appears and the responses are displayed as buttons. If help text was configured for the step, it appears at the bottom of the job tile. Clicking a response sets the return code for the question and completes the step. If more than three responses are configured, they are displayed in a drop-down list along with a Proceed button. Choosing a response in the drop-down list and clicking Proceed sets the return code for the question and completes the step.
When the step is run you can click Cancel to cancel the step and return to the Work page.
Примечание:
When this step is running, other people can't interact with the job.
Configure the step
Complete these steps to configure the Question step:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Question from the Step Library to a connection arrow of a step on the workflow canvas.
The Step Details panel appears.
- Provide a name for the step in the Step Name text box.
- Optionally, provide a description for the step in the Step Description text box.
- Configure step options in the Options section as necessary.
- Automatically Executes—Runs the step as soon as it becomes active.
- Can Be Skipped—Allows the step to be finished without being run.
- In the Logic section, provide a question in the Question text box.
- Provide preconfigured answers and return code values in the Answer and Return Code text boxes.
Multiple answers can be configured to use the same return code, but all Answer text boxes must contain unique values.
Примечание:
All paths from the step must be configured to match one of the return code values defined in the step.
- Optionally, click Add New Response to add additional answers.
Примечание:
To delete an answer, hover over it and click the Delete Answer button
. - Optionally, reorder the answers.
- Hover over an answer.
- Click the Reorder Answer button
and drag it to the desired location.
- Optionally, click the Help tab and provide help text for the step in the Help text box.
- Optionally, click the Style tab to change the shape and color of the step.
Return codes
When the step finishes running, it sends a return code to indicate the result of the step. The return code is evaluated, and the workflow follows all paths that match the step's return value. The following table lists the step's return code:
| Return code | Description |
|---|---|
| <CustomReturnCode> | The step completed successfully, and the step returns the matching custom return code for the answer defined on the step logic section. |