Automation Blog

from Stefan Schnell

Sometimes it could be necessary to make an individual user input to an action that is running. Normally an input is not possible because JavaScript runs in headless mode, this means that a screen, keyboard or mouse cannot be used. This blog post presents an approach that allows to made an user input during the runtime of a VCF Automation action.

User Input During Running Action


To enable an input we use a workflow that is called by the action. This workflow in this example contains only the User Interaction item. The workflow has also an output variable, in this example out_result, which gets the content from the User Interaction item. This variable contains the content that is to be processed in the action.

vcf automation workflow schema with user interaction item
vcf automation workflow inputs outputs
The following action now calls this workflow. In the main function this workflow is named and executed with the callWorkflow function. The result of the workflow, in this case the input, is assigned to a variable and output in the log. 

/**
 * Example to call a workflow from an action.
 * In this case the workflow 'userInput' is called to get an input from
 * the user during the execution of an action.
 *
 * @author Stefan Schnell <mail@stefan-schnell.de>
 * @license MIT
 * @version 0.1.0
 *
 * Checked with VMware Aria Automation 8.18.1 and VCF Automation 9.0.1.
 */

function callWorkflow(in_folderName, in_workflowName, in_inputs) {

  // Detect workflow and get its ID
  var workflowId = null;
  const workflowCategory =
    Server.getWorkflowCategoryWithPath(in_folderName);
  const allWorkflows = workflowCategory.allWorkflows;
  allWorkflows.forEach( function(workflow) {
    if (workflow.name === in_workflowName && workflowId === null) {
      workflowId = workflow.id;
    }
  });

  if (workflowId !== null) {

    const workflow = Server.getWorkflowWithId(workflowId);

    // Execute the workflow
    const workflowToken = workflow.execute(in_inputs);

    // Wait that the workfow terminated
    var workflowTokens = [];
    workflowTokens.push(workflowToken);
    System.getModule("de.stschnell")
      .waitForCompletionForBatchWorkflow(workflowTokens);

    // Get the outputs
    return workflowToken.getOutputParameters();

  } else {
    System.warn("Can not find " + folderName + "/" + workflowName);
  }

}

function main() {

  var workflowInputs = new Properties();

  // Define folder and name of the workflow
  const folderName = "de.stschnell";
  const workflowName = "userInput";

  // Execute workflow
  const result = callWorkflow(
    folderName,
    workflowName,
    workflowInputs
  );

  const name = result.out_result;
  System.log(name);

}

main();

In the action the waitForCompletionForBatchWorkflow function waits for the workflow to finish, in this case the user input. But the standard function of the com.vmware.library.vc.basic module has one disadvantage: If no input parameters are available, an exception is thrown. This is the case with the userInput workflow. Therefore a modified copy is used. 

for (var i = 0; i < wfTokens.length; i++) {
    var allComplete = false;
    while (!allComplete) {
        System.sleep(2000); // Wait 2 seconds
        allComplete = true;
        if (!(
            wfTokens[i].state != "running" &&
            wfTokens[i].state != "waiting"
        )) {
            // Look if it's running or waiting
            allComplete = false;
        }
    }
    // Now the state is completed, failed or canceled
    var logMessage = "The workflow '" + wfTokens[i].name + 
        "' terminated with status '" + wfTokens[i].state + "'.";
    var parameters = wfTokens[i].rootWorkflow.inParameters;
    if (parameters.length > 0) {
        var name = parameters[0].name;
        var object = wfTokens[i].getInputParameters().get(name);
        logMessage = "The workflow '" + wfTokens[i].name + 
            "' terminated with status '" + wfTokens[i].state +
            "' on the object '" + object.name + "'.";
    }
    if (wfTokens[i].state == "failed") {
        System.warn(logMessage);
        System.error(wfTokens[i].exception);
    } else {
        System.log(logMessage);
    }
}

var tokens = new Array();
for (var i in wfTokens) {
    tokens.push(wfTokens[i]);
}
if (wfTokens.length > 0) {
    System.log("***All workflows completed***");
}

Once the action has been executed, it is necessary to select Waiting for Input in the side menu.

vcf automation wait for input
If Answer is selected, the input can be made.

vcf automation input request
The action then processes this input.

vcf automation workflow schema with user interaction item

Conclusion

It is possible to make inputs during the runtime of an action. Headless mode is bypassed by calling a workflow with the item User Interaction. This application may certainly be of interest for very specific use cases. At least in a development process, this makes it possible to respond individually to specific conditions.

References


Addendum

Example - Yes/No/Cancel Dialog

The following description shows an example of how a yes/no/cancel dialog can be built, which can be used during the execution of an action as described above.

vcf automation workflow schema with user interaction item yes no cancel
A radio group can be created using the Input Form Designer by modifying an existing input parameter. Here a simple description how to set it up:

  1. Define input parameters
    Before the form can be designed, a variable must be created to store the selected value. To do this, select the Inputs/Outputs tab in the workflow editor and define a new output variable, e.g. out_result, of type string.

  2. Create radio group in the Input Form Designer
    Now switch to the Input Form tab to customize the appearance. Select the desired parameter in the canvas, e.g. out_result. On the right-hand side, under Appearance, change the Display type from "Text Field" to "Radio Group". Now define the selection options in the Values tab. Select Constant as the Value source to enter fixed values. These fixed values must have a specific format. They must be entered in Options in the format Value|Label, e.g. yes|Yes, no|No, cancel|Cancel.

  3. Linking to variables/logic
    In order for the selected value to be used in the workflow, it must be linked to the schema element. In the Schema tab, select the script element, e.g. the User Interaction. Now add the parameter out_result in the In/Out area under Inputs.

vcf automation input form appearance yes no cancel
vcf automation input form values yes no cancel
The dialog box is now ready for use.

vcf automation input form yes no cancel
After selecting an option and pressing the Answer button, the desired value is returned in the variable out_result.

vcf automation input form result of input yes no cancel