Project Properties

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

All project properties are available at the bottom of the Navigator.

Project Properties

Click the image to enlarge it.

Default Properties

Project properties relate to settings for the entire project and to custom properties used in or provided inside the project.

These properties are:

Option Description
Name The project name.
Special characters in the name, including (but not limited to) &, -, /, (, and ), may cause issues with reporting.
Description The project description.
File The project location.
Resource Root The resource root location.
Cache Definitions Set to true to cache the web service definitions you add to the project. This helps you avoid long loading when working with the project.
Set to false to disable the data caching. Note: If the parameter has not been modified, the global  Cache WSDLs property of ReadyAPI is used.
The option affects the following definitions:
  • WSDL
  • WADL
  • OpenAPI and Swagger definitions included to your project in ReadyAPI 2.2 and later
The option does not affect RAML definitions, as well as Swagger definitions included in your project in ReadyAPI 2.1 and earlier.
Project Password The password for encrypting the entire project or individual properties. See Protecting Sensitive Data.
To enable password protection, set the Encryption Mode property either to Entire project or to Selected properties (see below).
Encryption Mode Enable or disable project encryption to protect sensitive data. The following options are available:
  • Not encrypted – ReadyAPI does not encrypt the project.

  • Entire project – ReadyAPI encrypts the entire projects upon saving.

  • Selected properties – ReadyAPI encrypts individual custom properties.

The encryption password is specified by the Project Password property (see above).
For more information, see Protecting Sensitive Data.
Composite Project Set to true to convert the project to a composite project.
Composite Project Format The composite project version.
Script Language The scripting language you use in the project.
After you change the scripting language, you must restart ReadyAPI for the change to take effect.
Script Library The script library file location.
Tip: When you change this property during runtime, add a 10-second delay after it to let ReadyAPI load the libraries.
Disable CR Escaping If true, /r acts as the line break. Otherwise, ReadyAPI uses /r/n.
Save Properties Between Test Runs Control how ReadyAPI stores custom project properties between test runs.
true – ReadyAPI keeps any changes you apply to property values and saves them to the project file.
false – ReadyAPI will discard any changes you apply to custom properties of a project, test suite, test case, or request after the test run is over. If you run several tests simultaneously, the changes will be discarded after the last test run is finished.

Custom Project Properties

By using the Custom Project Properties tab in the Navigator, you can create any number of properties. These properties are available to all other entities in your project such as test suites and test cases. Also, you can change values of these properties by switching environments. To manage the property list, use the toolbar:

Custom project properties can be stored locally in your workspace file by selecting the checkbox on the right. To learn more about it, see Locally Stored Properties.

Scripting Language

ReadyAPI supports two scripting languages:

  • Groovy (ver. 2.4.17) – The default scripting language in ReadyAPI. To learn more about it, visit the Groovy website.

  • Rhino JavaScript (ver. 1.7.10) – ReadyAPI supports the JavaScript Rhino engine by Mozilla Foundation.

See Also

About Properties
Project Settings
Working with Projects

Highlight search results