Tutorial: Setting Test Step Input Properties Using Event Handler Code

In this tutorial, you will set the input properties using event handler code instead of the property value grid in an API test. This is useful if you have a property value generated dynamically during a test run, as you cannot use the Input/Checkpoint Properties tab in the Properties pane to set a property that does not exist before the test run.

In this tutorial, you will be setting the input properties of a Concatenate Strings step.

Note: We recommend printing this topic or putting the browser window on a second screen before performing this tutorial in a sample API test.

  1. Prerequisite - create a Concatenate Strings step in your test

    If necessary, from the String Manipulation section of the Toolbox pane, drag a Concatenate Strings step to the canvas.

    Back to top

  2. Create an event handler for the Concatenate Strings step

    For this test step, you want to set the value of the input and output properties before the step runs, so it is important to select the event handler that runs before the test step.

    1. In the Properties pane, select the Events tab .
    2. In the Events tab, in the BeforeExecuteStepEvent row, click the down arrow and select Create a default handler.

      A separate tab, titled TestUserCode.cs, opens in the document pane, and a section of code is added to this file for the BeforeExecuteStepEvent section.

    Back to top

  3. Add event handler code to set the input and output properties.

    1. In the TestUserCode.cs tab, find the TODO: Add your code here... section under the ConcatenateStringsActivity4_OnBeforeExecuteStepEvent portion of the code.
    2. Delete the //TODO: Add your code here... string.

      Note: Make sure not to delete the brackets on the line above and below the TODO line. These brackets are needed for proper code syntax.

    3. In the same line, enter this. (with the period). (While you type, UFT displays an autocomplete list. You can use this list if you want to find the this object.)

      After you type the this. object, UFT displays another autocomplete list.

    4. From the autocomplete list, select the ConcatenateStringsActivity<#> variable:

      Note: The number of your activity differs between UFT sessions, depending on what other activities you have previously added to the canvas.

    5. After the ConcatenateStringsActivity<#>, type a period (.) character. Another autocomplete list is displayed.
    6. From the autocomplete list, select the Prefix object and click ENTER:

    7. After the Prefix object, enter ="Hello " (with a space after Hello). Make sure to enclose the Hello string in quotes to ensure correct syntax.
    8. After the "Hello" string, type a semicolon (;) character.

      Your event handler code should now look like this:

      this.ConcatenateStringsActivity4.Prefix="Hello";
    9. Click Save .

    Back to top

  4. Repeat the process described in step 3 to set the Suffix property.

    1. Use the same process described above to set the Suffix property to be "World." (with the period after World.)

      After you enter the Suffix property in the event handler code, your event handler code should look like this:

      this.ConcatenateStringsActivity4.Prefix="Hello ";
      this.ConcatenateStringsActivity4.Suffix="World.";
    2. Click Save .

    Back to top

  5. Run the test to check if the properties are set correctly.

    1. In the toolbar, click the Run button .
    2. In the Run dialog box, click Run. UFT runs the test, using the property values provided in your event handler code as the input property values for the test step.

      After the test run is complete, you can see the results to ensure that the event handler code provided the property values correctly:

      Output pane

      In the User Logger log in the output pane, you can see the compilation log for the test run. In this compilation log, there is a step for the Prefix and Suffix properties of the Concatenate Strings step:

      Note also the Output Parameter 'Result' line, which validates that your input properties were taken from the event handler code correctly.

      Run results

      In the run results, if you look in the captured data for the step, you can see the input properties used by the test:

      Note also the Result line, which validates that your input properties were taken from the event handler code correctly.

    Back to top