Configuring Test Step Additional Prompts (Validation Management)

Test Step Additional Prompts are available in the Test Authoring Interface and the Text Execution Interface for setup and execution steps. Test Step Additional Prompts that are a part of a Test Script display all associated prompts defined by a Test Author; a maximum of 15 prompts can be defined for each Test Step. The default prompts for a step are Procedure, Expected Results, and Actual Results, but Vault supports the following prompt types for Test Steps:

  • Procedure: Describes what the Executor must do to complete the step.
  • Expected Results: Describes the expected outcome after completing the step. This is only available for execution steps.
  • Actual Results: An input prompt that allows the Executor to describe the results after testing.
  • Reference Instruction: An additional reference instruction, such as an image, video, or document.
  • Text Instruction: Additional instructions for the executor.
  • Text Response: An input prompt for the Executor to provide text.
  • Date/Time Response: An input prompt for the Executor to provide a date and time value.
  • Number Response: An input prompt for the Executor to provide a numerical value with a unit of measure.

Configuration Overview

Admins can complete the following steps to configure Test Step Additional Prompts:

Configuring the Test Step Additional Prompt Object

Activate the Test Step Additional Prompt (val_test_step_additional_prompt__v) object, and ensure that the following object types are available on the Test Step (val_test_step_svo__v) object:

  • Procedure Setting (procedure_setting__v)
  • Procedure Fit to Width (fit_to_width__v)
  • Actual Results Fit to Width (actual_results_fit_to_width__v)
  • Expected Results Setting (expected_results_fit_to_width__v)
  • Expected Results Fit to Width (expected_results_fit_to_width__v)
  • Verdict Setting (verdict_setting__v)
  • Actual Results Setting (actual_results__v)
  • Attachment Setting (attachment_setting__v)

Optionally, activate the Reference Instruction (document_instruction__v) object type on the Test Step Additional Prompt (val_test_step_additional_prompt__v) object, and ensure that a Document Instruction and a Description field are enabled for the object type. This ensures that Test Authors can use the Reference Instruction Prompt to include a file or link an existing document in a Test Step. These files and documents provide Executors with immediate access to critical reference materials during test execution.

Configuring the Test Step Additional Prompt Lifecycle

At minimum, add the Test Author and Executor roles to the Test Step Additional Prompt lifecycle and give Edit permissions to the applicable states, such as In Authoring, Pre-Approved, In Execution, and Completed. Also configure the atomic security settings for the Test Author and Executor roles for the applicable states. 

Optionally, you can update the Test Step object lifecycle to change the states of additional prompts when a Test Step moves to another state.

Configuring the Reference Instruction Prompt Settings

To configure the available document types for Reference Instruction Prompts:

  1. Navigate to Admin > Configurations > Validation Reference Instruction Prompt Settings. 
  2. Select the document types for the Reference Instruction Prompts for display in the Test Authoring Interface and related Validation Management application pages.
    1. If you select a document subtype, all existing classifications under that subtype are automatically selected.
    2. You cannot deselect the Reference Instruction Prompt document type as it is required to upload the file attachments or existing documents.

Configuring the Reference Instruction Prompt Document Subtype

Activate the Test Step Prompt document subtype and Reference Instruction Prompt classification under the Validation (validation__v) document type to ensure that Vault uses this document type when creating a new document for a Reference Instruction Prompt. 

Configuring the Reference Instruction Prompt Document Lifecycle

To configure the Reference Instruction Prompt document lifecycle:

  1. Configure the role security settings for the Draft and Available for Use states.
  2. Add the Set Major Version entry action for the Available for Use state.

Additionally, If there are required fields for the Reference Instruction Prompt document type, change them to optional. If required fields are inherited from the parent document type, change the fields to optional on the parent document type, and add field dependency settings to make those fields required for all other document types except the Reference Instruction Prompt document type. If these fields are not made optional, Vault will experience an issue uploading files for the Reference Instruction Prompt in the Test Authoring Interface.