Forum Discussion

cunderw's avatar
cunderw
Community Hero
10 years ago

Store result of custom keyword operation in a user defined project variable?

Example:   Say I have a custom script extension / keyword test operation that takes user defined input to do some operation without the tester needing to script anything.   What I want is for...
  • HKosova's avatar
    HKosova
    10 years ago
    cunderw wrote:

    The only way I've found to do this is use set variable and select last operation result.

    That's the standard approach, and it's used by the built-in operations as well.

    That said, you can probably use an operation parameter for the output variable name. Say it's named OutVariableName, and should contain just the variable name, without the Project.Variables prefix.

     

    <!-- description.xml -->
<KDTOperation Name="My Operation" Category="My Category">
  ...
  <Parameters>
        ...
        <Parameter Name="OutVariableName">The name of a project variable to save the operation result to.</Parameter>
  </Parameters>
  ...
</KDTOperation>

    In the operation code, you can check if the variable is specified and exists, and if so save the operation result to it. (Note: the code is off the top of my head and untested.)

     

    // JScript
function MyOperation_OnExecute(Param1, ..., OutVariableName){
  // Do something
  ...
  var result = true;

  var strVarName = Parameters.OutVariableName;
  if ((strVarName == null) || (strVarName == "")) {
    // Variable name isn't specified
    ...
  } else if (! Project.Variables.VariableExists(strVarName)) {
    // Variable doesn't exist
    ...
  } else {
    // Variable exists - save the operation result to it
    Project.Variables.VariableByName(strVarName) = result;
  }

  return result;
}

     

cunderw's avatar
cunderw
Community Hero

This works great if I hard code strVarName to a string of the variable name. How ever doing:

 

var strVarName = Parameters.OutVariableName;

Returns empty even after setting it in the paremeters edit dialog that appears after my user form.

 

Are there any additional steps that are required to access the parameter inside the script besides declaring it in the description.xml and the function itself?

 

EDIT: Was able to get this work using Data field and adding it to the form as opposed to the parameter.

HKosova's avatar
HKosova
SmartBear Alumni (Retired)
10 years ago

Does it work if you use just OutVariableName instead of Parameters.OutVariableName? Parameter values should be available as the OnExecute function parameters.

  • cunderw's avatar
    cunderw
    Community Hero
    10 years ago

    It was not working for me, even when sending a log message with OutVariableName or Parameters.OutVariableName it was showing empty.

     

    Being able to access the Parameters would be my next required step though.

     

    Basically what I'm attempting to do is create a custom keyword operation to issue database queries using ADO and variables because the built in database check points do not allow for passing variables in the statements. Having this be an operation instead of a script would be beneficial to testers who aren't not as familiar with scripting/programming.

      • cunderw's avatar
        cunderw
        Community Hero
        10 years ago

        That was working, fine, but it was still causing problems when accessing the parameter insidi the script for the operation.

         

        I actually found a different way to access the variables of the project with a nice dropdown list to store the result in which exactly what I was looking to do, it's just a modification of the first suggestion. In case anyone else is attempting to do the same thing. 

         

        function addComboVariables(Combobox){
  var variablesCount = Project.Variables.VariableCount;
  var i = 0;
  var items = Combobox.Properties.Items;
  items.Clear();
     
  while (i < variablesCount){
    items.add(Project.Variables.GetVariableName(i));
    i++;
  }
}

        I call the above function in the the onShow routine of the editForm to get all of the variables currently in the project and set them to a combo dropdown list. Then follow the above suggestion, assign the Data.OutVariableName to the text property of the combo box.