Parameters/Checkpoints Tab (Properties Pane - API Testing)

Relevant for: API testing only

Overview

This tab enables you to define input and output properties and parameters and checkpoint properties for your test steps.

Option Description
To access
  1. Open the Properties pane.

  2. Select one of the following in the canvas.

    • The Start or End steps

    • The Test Flow

    • A test step

  3. In the Properties Pane, select the tab. This tab's name and content depend on the test step you selected.

Important information

The name of this tab depends on the test step you select:

  • If you selected a Start or End steps, this tab is Test Input/Output Parameters.

  • If you selected the test flow, this tab is Input.

  • If you selected any other step, this tab is Input/Checkpoints.

Back to top

Test Input/Output Parameters Tab

When the Start or End step of your test is selected, this tab is displayed. You can use the tab to create and define values for input and output properties/parameters to which any test step in your test can link.

The tab's user interface elements are described below (unlabeled elements are shown in angle brackets).

UI Element

Description

<Properties list>

A list of all available properties.

Add

Opens the Edit Input/Output Property/Parameter Dialog Box (API Testing) which enables you to define custom input and output properties or parameters for your test.

Edit Parameter. When a property/parameter is selected, opens the Edit Input/Output Property/Parameter Dialog Box (API Testing) , enabling you to edit any custom input or output properties/parameters

Delete. Deletes the selected property/parameter.

Back to top

Input Tab

When the Test Flow is selected, this tab is displayed. You can use the tab to specify properties for iteration test runs.

The following options are available:

UI Element

Description

Do While Loop - Use condition

Repeats the loop as long as the specified condition is met:

  • Variable. The variable to evaluate. Use the Select Link Source button to enter a data source expression.

  • Operator. A comparison operator relevant to the variable such as =, !=, Contains, Starts and Regex.

  • Value. The value with which to compare the result.

Do While Loop - Use event

Performs iterations until the event returns True. This mode is useful for complex conditions that can be defined in an event handler. When you select this option, the Input Properties grid opens.

  • Click to define properties.

  • Click to open the Events view. Click Create a default handler in the Handler column.

  • Modify or add code to the event handler method that defines your condition.

For Each Loop

Performs an iteration for each element in the associated array or collection of objects. Data is selected using the Select Link Source button .

Note: When you delete data from a data table, it continues to run an iteration for that row, with empty values. To remove an entire row of a data, click the row and select Delete from the shortcut menu (only with Excel installations).

For Loop

Performs the Test Flow or custom loop the number of times that you specify in the Number of Iterations box.

Back to top

Input/Checkpoints Tab

When a test step is selected, this tab is displayed. You can use the tab to specify input and checkpoint properties for the selected test step.

The tab's user interface elements are described below (unlabeled elements are shown in angle brackets).

UI Element

Description

<properties list>

A list of all available properties. The fields differ per step type:

  • For most activities: The activity's Input properties.

  • For Web Service, REST Service, and WADL methods:

    • the properties as designed in the WSDL or WADL file (for Web Service or Web Application methods),
    • The custom input or output properties defined for your REST method in the REST Service editor. For details on creating input or output properties for REST Service methods, see Define custom properties - optional.
<checkpoint list>

A list of the step's output properties/parameters, displaying the following columns:

  • Checkpoints. A list of the output properties/parameters.

  • Validate. When selected, OpenText Functional Testing validates the current output properties/parameters when running the step. When cleared, OpenText Functional Testing does not check the output properties/parameters.

  • Expected Value. The expected value for the output parameter. Select the down arrow to view a drop down list of comparison operators, number scrolling, and boolean values. You can also manually enter the expected value into the cell.

Additional checkpoint properties include:

  • Trim whitespace (from start and end of string). Removes whitespace before and after the text.

  • Ignore case. When looking for a match, ignores the case.

  • Stop test if checkpoint fails. Exits the test run if the checkpoint fails. You set this individually for each checkpoint.

Note: You must click on a row in the Checkpoint section to see these properties. The first two properties are available only for string data types.

<checkpoints list>
(available for- Web Service and SOAP Request steps)

Checkpoints options for Web Service and SOAP request steps include:

  • Send request to service. Sends the step's request to the service when running the test. This is the normal behavior for Web Services and most types of actions. It is enabled by default.

    Note: To send messages using JMS transport, clear this checkbox. Link a subsequent JMS step to the output of this step. For Web services, you can set the security settings and include attachments, and send this over JMS.

  • Validate Structure. Validates that the service's response—either for the response defined in the operation or a SOAP Fault response-- is in conformance with the schema defined in the imported XSD for the service. The run results indicate whether or not the validation succeeded.

    Note: This checkpoint does not validate the XML schema values, just the tags of the XML schema

    This option is available only when the Send request to server option is enabled. It is enabled by default.

    Note: If you modify the elements in the response, this will not affect the response schema. For example, adding array elements, selecting specific Choice elements, changing the derived type, affect only the response—not the schema. To validate the element values, specify expected values in the Value column or use an XPath expression.

  • Validate WS-I. Adds a checkpoint to verify that the SOAP response in compliance with WS-I standards. The run results indicate whether the response was in compliance. It also provides a View Report link that opens the WS-I Validation report in a separate window.
<XPath checkpoint options>
(available for steps with XML output properties)

For steps with XML output properties (such as String to XML), the following additional options are relevant:

  • XML tab. A grid representation of the response's schema. In this section you can enter the expected response values. Use the following options to enter your XML:

    • Import Schema. Imports a schema for the XML response.

    • Load XML. Loads an XML file as a basis for the schema of the response.

    • Clear. Removes the displayed schema.

  • XPath tab. A list of XPath expressions used to evaluate the XML response. Use the following options to use XPath expressions:

    • Adds a line for a new XPath expression.

    • Removes the selected XPath expression.

    • Ignore namespaces: Ignores namespaces in the XPath validation, allowing you to use simple XPath expressions. For details, see Set XPath checkpoints.

Back to top

Context Menu Options

The following context menu options are available in this tab:

UI Element

Description

<context menu>- input properties

Provides shortcuts for including properties and setting their values.

  • Collapse/Expand All. Displays or hides the list of array elements.

  • Set Auto-value. Inserts a sample value for the argument, based on its data type.

  • Include/Include All. Includes the current or all Choice input properties in the test run.

  • Exclude/Exclude All. Excludes the current or all Choice input properties from the test run.

  • Copy XPath. Copies a simplified XPath expression to the clipboard. For details, see XPath checkpoints.

  • Copy Fully Qualified XPath. Copies the complete XPath expression of the value to the clipboard.

  • Link to Data Source. Opens the Select Link Source Dialog Box (API Testing)

  • Clear Cell Contents. Clears the contents of the cell.

Note: Some options are available only for specific property types.

<context menu> - checkpoints list

Provides shortcuts for including properties and setting their values.

  • Remove Array Element. Removes the selected array element.

  • Duplicate Array Element. Duplicates the selected array element with its values.

  • Select All. Selects/clears the Validate checkbox for all child array elements.

  • Expand/Expand All. Expands all elements included in an array.

  • Collapse/Collapse All. Controls the display of array elements.

  • Clear/Clear All. Clears the selected or all checkboxes for validation.

  • Set Auto-value. Inserts a sample value for the argument, based on its data type.

  • Copy XPath. Copies a simplified XPath expression to the clipboard. For details, see XPath checkpoints.

  • Copy Fully Qualified XPath. Copies the complete XPath expression of the value to the clipboard.

  • Link to Data Source. Opens the Select Link Source Dialog Box (API Testing).

  • Display Outgoing Links. Lists the property's outgoing links. For details, see Outgoing Links.

  • Insert Keyword. Insert a keyword in the Expected Value column. The available keywords are #NIL#, #EXISTS#, #NOT_FOUND#, and #SKIP#.

Back to top