Keyword Test Parameters

1. Click Add Parameter on the toolbar of the Keyword Test editor. The Add Parameter wizard will appear.

2. On the first page of the wizard, specify the parameter properties needed for parameter creation:

   • In the Name edit box, specify the parameter name.

     Note:

     The parameter name must match the naming rules of the scripting language used in your project. The easiest way to do this is to specify a name that only consists of alphanumeric or underscore characters and starts with a letter.

   • In the Type box, specify the parameter’s type.

   • In the Description edit box, enter any descriptive text related to the parameter.

3. Click Next to specify the default value to the parameter. Finish will generate the parameter that will not have the default value.

4. On the second page, specify the value which the parameter will have by default. The values that will be used for the test run are specified in the script code, or in the Execution Plan editor of the project, or in the Keyword Test editor (see below).

5. Click OK to close the dialog and add a new parameter to a keyword test. Cancel will close the dialog without performing any actions.

The created parameter will be added to the Parameters page of the test automatically. Open your keyword test and switch to the Parameters tab at the bottom of the test editor:

Click the image to enlarge it.

The Parameters page contains information about existing parameters: name, data type, default value and description. For detailed information about the columns, see description of the page.

1. Press the Add Parameter button on the page’s toolbar or right-click somewhere within the page and choose Add Parameter from the context menu.

2. Then you can specify the parameter’s name, type, default value and description.

Notes:

• The parameter name must be a valid script identifier.

• The order of parameters on the page is important, because it specifies the order, in which the parameters must be specified when the keyword test is executed from scripts (see below).

  To change a parameter's position, you can either use the Move Up and Move Down buttons on the page’s toolbar or right-click the parameter on the page and then choose Move Up or Move Down from the context menu.

• A parameter may have a default value. In this case, you do not have to specify the parameter’s value for each test run.

  In the parameters list, the parameters that have default values must follow the parameters that do not have default values. So, if you define a default value for a parameter, you should position this parameter after the parameters that do not have default values.

A test parameter can have one of the following data types:

• String - Use this type for parameters that will contain characters and strings (including multi-line text).
• Integer - Use this type for parameters that will contain integer values.
• Double - Use this type for parameters that will contain floating-point values and dates.
• Boolean - Use this type for parameters that will contain True or False.
• Object - Use this type for parameters that store object references, for instance, references to the process or window objects. These parameters can have Null or Unassigned default values.

TestComplete checks the parameter type when you specify the parameter value in scripts. See the next section for details.

As a test item

From another keyword test

From a script

1. Add an item for the test to the Execution Plan editor of your project.

2. Click the ellipsis button in the Parameters column.

3. In the resulting Test Parameters dialog, specify values for the test parameters.

   Note:

   When you are creating a project test item that will use your keyword test, default values of test parameters are copied to the test item’s settings. If you then modify parameter values in the Keyword Test editor, the changes will not affect the test item. To change the test parameters, you have to modify the test item’s properties in the Execution Plan editor.

To run a parameterized keyword test (“callee”) from another keyword test (“caller”), you use the Run Keyword Test or Run Test operations:

1. Add any of these operations to the “caller” test.

2. In the resulting Operation Parameters dialog, assign values to “callee” test parameters.

To modify parameters of a “callee” test already added to another test:

1. Select the operation in the test.
2. Select the Value cell and then either click within the cell or press F2. This will activate the in-place editor.
3. Click the ellipsis button of the editor. This will invoke the Operation Parameters dialog, where you can specify the desired parameters’ values.
4. To save the changes, close the dialog with the OK button and press Enter in the in-place editor to confirm the change.

1. To run a keyword test from a script, use the KeywordTests.<KeywordTest_Name>.Run method:

   KeywordTests.KeywordTest1.Run()

2. Specify the test’s parameters as the method’s parameters.

   Suppose, you have a keyword test KeywordTest1 that has three parameters: Param1 (string), Param2 (integer) and Param3 (boolean). To specify the parameters and run the test, you can use the following script code:

   JavaScript, JScript

   Python

   VBScript

   DelphiScript

   C++Script, C#Script

   JavaScript, JScript

   KeywordTests.KeywordTest1.Run("My String Parameter", 10, true);

   Python

   KeywordTests.KeywordTest1.Run("My String Parameter", 10, true)

   VBScript

   Call KeywordTests.KeywordTest1.Run("My String Parameter", 10, True)

   DelphiScript

   KeywordTests.KeywordTest1.Run('My String Parameter', 10, True)

   C++Script, C#Script

   KeywordTests["KeywordTest1"]["Run"]("My String Parameter", 10, true);