About Properties

Applies to ReadyAPI 3.53, last modified on June 07, 2024

In ReadyAPI, you use several properties depending on your purpose:

Object Properties

The Properties Tab

Click the image to enlarge it.

Use Object Properties to modify configurations of different test items (workspace, project, test suite, load test, security test, virtual service, and so on). You can do this in the Properties tab at the bottom of the Navigator panel.

Note: If the tab is disabled, select View > Properties from the main menu.

Custom properties

Every item in the project – a test step, test case, test suite, load and security tests, the project itself – can have its own set of custom properties. They are available in the custom properties panel in the Navigator and/or in the editor of the test item itself.

Note: All these properties exist in their own scopes, so, for example, project-level properties won't override test case-level properties.

To modify custom properties, use the toolbar at the top of the tab:

Name Description
Add Add a new custom property.
Up and Down Move the selected property up or down correspondingly.
Sort Sort the properties in the alphabetical order.
Clear Clear the property values.
Load from file Load the properties from a file.
Save to file Save the properties to a file.
Remove Remove the selected property.
Note: Depending on a test item, some buttons may be absent.
  1. Click Load from file and specify the file to be imported in the ensuing Load Properties dialog.

  2. Set the desired options of the load process:

    • If the file contains properties that are not specified in the test item, ReadyAPI can create them. To do this, enable the Create Missing option.

    • If the test item contains properties that are not specified in the file, ReadyAPI can remove them. For this, enable the Delete Remaining option.

Global properties

Global Properties do not depend on the used project. To modify them, use the Global Properties tab of the ReadyAPI Setting.

Also, it is possible to modify global properties by using the -G command-line attribute.

System properties

ReadyAPI is a Java application. To view the Java machine settings with which the current ReadyAPI instance was started, use the System Properties dialog. To modify these properties, use the -D command-line attribute.

To invoke the dialog, select Help > System Properties from the ReadyAPI main menu.

API testing with ReadyAPI: System Properties dialog

Save custom properties between sessions

If the value of a custom property of a project, test suite, or test case has been changed during the test run, all the subsequent test steps will use the new value of that property. When the test run is over, ReadyAPI can either restore the value or save it for later test runs. To control this behavior, use the Save Properties Between Test Runs project property.

Set this property to false to command ReadyAPI to make a backup of custom property values before each test run and to restore these values when the test run is over so that the original property values can be used during later test runs.

Set this property to true to command ReadyAPI to save the modified property values within the project file and use these values during the subsequent test runs.

This affects custom properties of the following items:

  • Projects
  • Test suites
  • Test cases
  • Requests

The properties specified in the Environment settings are also affected.

Important notes:

  • To avoid losing the modified property values, save the project before closing it.

  • This feature is not supported in command-line runners. So, ReadyAPI does not make a backup of custom property values before the test run, nor does it restore them after the test run is over. ReadyAPI does not save the project unless you use the -S argument, thus, custom property values will not be modified. To learn more, see Command-Line Arguments.

Store properties locally

When you work in a team and store your project in a source control system, you might want to keep certain property values outside of it because they only make sense in your environment. In this case, you can exclude a property from the project and store it locally.

Custom project properties: Select properties to be excluded

To learn more about it, see Locally Stored Properties.

Encrypt properties

If you need to store sensitive data in your projects, you can encrypt project properties or your entire project. You can also encrypt ReadyAPI preferences to protect global properties.

Values of encrypted properties will not be displayed in the project and will not show up in logs, reports, or test results.

Custom project properties: Encrypt a property

To learn more about it, see Protecting Sensitive Data.

See Also

Transferring Property Values
Get Data Dialog
Examples of Using Properties

Watch the video
Highlight search results