Introduction

• The Prompt Instruction halts

Purpose

• Halts execution of an order in a workflow until the prompt is confirmed. The order is assigned the PROMPTING state.
• PROMPTING orders remain with their workflow position and require user intervention to transition from this state.
• Users can confirm , suspend and or cancel PROMPTING orders, see JS7 - Order State Transitions.
• This instruction can be used to request confirmation by a user or an external application that makes use of the JS7 - REST Web Service API.

Workflow Instruction: Prompt

Configuration

Download Workflow Example (.json upload): pdwFailpdwPrompt.json

Image RemovedImage Added

Explanation:

• The workflow executes an initial job1 and makes use of an If a Prompt Instruction to check a previous job's return values. See JS7 - If Instruction for details of how to add expressions to If Instructions.
• If the If Instruction evaluates to true then the Fail Instruction is executed. The order is then assigned the FAILED state.
When an order is failed, a message and a return code that specify the reason for failing the order can be added as an option
• request confirmation to continue.
  • The prompt message can be added as a string.
  • In addition, the message can include variables that are available from the workflow, the order or from JS7 - Job Resources like this:
    • 'job completed with return code value: ' ++ $returnCode ++ ', please confirm the order to be continued'
    • When using text and variables then text is put in single quotes and is concatenated by use of the ++ operator, see JS7 - Expressions for Variables.
    • $returnCode is a built-in variable, in addition any variables accessible to workflow instructions can be used.
• If the confirmation is provided then the order continues and executes job2.

Execution

When the workflow described above is executed, then the order will be halted with the Prompt Instruction and put into the PROMPTING state.

The JOC Cockpit Dashboard view displays currently prompting orders. The JOC Cockpit Workflows view allows the execution to be confirmed from the order's action menu:

Image Added

Selecting the "Confirm" option opens a window that displays the message defined with the Prompt Instruction:

Image Added

If the prompt is confirmed then the order will continue execution of the workflow.