Skip To Content

Question

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 is 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.

When you run the step, you can perform the following actions:

  • Choose a response to complete the step.
  • If more than two responses are configured for the step, choose a response in the drop-down list and click Proceed to complete the step.
  • Click Cancel to cancel the step.

Configure the step

Complete these steps to configure the Question step:

  1. Create or edit a workflow diagram to access the Step Library panel.
  2. Drag Question from the Step Library to a connection arrow of a step on the workflow canvas.

    The Step Details panel appears.

  3. Provide a name for the step in the Step Name text box.
  4. Provide a question in the Question text box.
  5. 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.

  6. Optionally, click Add New Response to add additional answers.
    注意:

    To delete an answer, hover over it and click the Delete Answer button Delete Answer.

  7. Optionally, reorder the answers.
    1. Hover over an answer.
    2. Click the Reorder Answer button Reorder Answer and drag it to the desired location.
  8. Click the Options tab.
  9. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.
    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

  10. Optionally, provide help text for the step in the Step Help text box.
  11. Optionally, click the Style tab to change the shape and color of the step.
  12. Optionally, click the About tab and provide a description for the step in the Step Description text box.
    注意:

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

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 codeDescription

<CustomReturnCode>

The step completed successfully, and the step returns the matching custom return code for the answer defined in the step's properties.

Step output

When the step finishes running, its output is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table lists the step's stored output:

OutputDescription

<Answer>

The answer that was chosen when the step was run.

関連トピック


このトピックの内容
  1. Configure the step
  2. Return codes
  3. Step output