Applies to ReadyAPI 3.0, last modified on November 19, 2019

To view or change properties of your SOAP virtual APIs (virtual service), select the service in the Navigator panel. You will see the properties on the right of the ReadyAPI window, and on the left, at the bottom of the Navigator panel:

Service virtualization and API testing: Properties of a SOAP virtual service

Click the image to enlarge it.

Properties on the right

The properties are organized into several groups.

Info

Property Description
Location The computer, where the virtual service resides.
Time running How long the virtual service is running. 0 if the service is not running.
Status Indicates if the service is running or not.
Received The number of incoming requests (including those requests for which the service has no virtual operations).
Sent The number of responses the service sent to clients.
Protocol The virtual service protocol: http or https.
Port The port number, which the virtual service will use for the run. Also, view and change it on the property list in the Navigator panel.
To use the same port number for two virtual services on one computer, set different paths for them.
If you start your service from the command line, use the -m argument to specify a path or another port.
Autostart on server Commands the service to start automatically right after you deploy it to a remote computer.
Path The path that follows the virtual service computer name and port in the URL string:
http://computer:port/path/{operation-pages}
Also, view and change it on the property list in the Navigator panel.
Virtual service URL The basic URL that you can use for sending a request to the virtual service. This basic URL includes the protocol, the virtual service computer and port and the Path property value. The URL that you use for the call will also include the operation path.
Max Routed Response per Operation If you configured your virtual service to use routing, the service will forward incoming requests to some other API, transfer responses from this API to the client that sent the requests, and will then record these responses. This property restricts the maximum number of responses the service will record. You can add the necessary number of additional responses manually.
If the number of incoming requests for an operation exceeds the specified value, the service will route incoming requests and return responses, but it will not record these responses. ReadyAPI will post an informative message to the log in this case.

Assertions

A list of assertions that the virtual service applies to incoming requests to verify their contents. For more information on this, see Assertions in ServiceV.

To add assertions, click and select the desired assertion in the subsequent dialog. To remove an assertion, select it on the list and click . To modify assertion parameters, select the assertion on the list and click .

The virtual service applies assertions in their order on the list. If needed, select an assertion and change its position with the and buttons.

Assertion Results

This section displays assertion results. It includes both service- and operation-level assertions. Green dots denote passed assertions, red dots indicate failed assertions.

Tip:

To view detailed results for an assertion, simply click the assertion on the list. This will display a list of checks grouped by the result and the cause of a fail.

To get to the request and response contents, double-click the timestamp of a failed or successful execution. This will invoke a dialog box, where you can explore the request and response bodies, headers and properties.

Description

Arbitrary text describing your virtual API. This is the same text that you can view and change on the property list in the Navigator panel.

Properties

A list of user-defined virtual service properties. These are the same properties that you can see on the Custom Properties page in the Navigator panel.

The toolbar above the property list contains commands for creating and deleting properties, changing their order, sorting, clearing property values, and loading property values from and saving them to a file.

Start Script

Groovy script code that executes right after the virtual service starts. For information on writing scripts and available script objects, see Virtual Service Scripting.

Stop Script

Groovy script code that executes right before the moment when the virtual service stops. See Virtual Service Scripting for information on writing scripts and available script objects.

OnRequest Script

Groovy script code that is run right after the virtual service receives an incoming request.

Note: The script runs for all requests, including those for which your service has no virtual operations.

See Virtual Service Scripting for information on writing scripts and available script objects.

AfterRequest Script

Groovy script code that is executed after your virtual service replies to the client request.

Note: The script runs for all requests, including those for which your service has no virtual operations.

See Virtual Service Scripting for information on writing scripts and available script objects.

DataSources

Provides information on data sources that your virtual service uses. The Loops column indicates the number of times the service iterated through all the records of the data source during the run.

Properties in the Navigator

SOAP virtual service properties

Property Description
Name The virtual service name.
Description Arbitrary text describing the virtual service. Also, view and change it in the property editor on the right of the product window.
Path The path that follows the virtual service computer name and port in the URL string:
http://computer:port/path/{operation-pages…}
Also, view and change this value in the editor on the right of the product window.
Port The port number, which the virtual service will use for the run. This is the same value that is available in the editor on the right of the product window.
To use the same port number for two virtual services on one computer, set different paths for them.
If you start your service from the command line, use the -m argument to specify a path or another port.
Match SOAP Version

Specifies if the virtual service compares the SOAP version of incoming requests and corresponding virtual operations. If this property is true, the versions must coincide. If they are different, the service will return an error. If the property is false, the service does not compare the SOAP versions. Set this property to true if you need strict processing or want to test error handling on incorrect SOAP versions.

Require SOAP Version

Specifies if the virtual service requires that incoming requests have the “SOAP Action” header. If this property is true and the incoming request does not have the “SOAP Action” header, the service will return an error. Some clients do not send this header, so set this property to true when you want strict processing, or if you need to test error handling on the client side. If you use SoapUI to send client requests, then use the Skip SOAP Action parameter of the SOAP request to include or exclude that header.

Dispatch Response

Not used. Kept in the product for backward-compatibility purposes.

Incoming WSS

Specifies the incoming WS-Security configuration to be used for processing of incoming requests.

Default Outgoing WSS

Specifies the outgoing WS-Security configuration that the virtual service will use by default for processing outgoing responses like adding encryption, signature, and so on.

Note: To view or create WS-Security configurations, select your service under the APIs node in the Navigator panel, and then select WSS сonfig on the toolbar. This will open the WS-Security configurations dialog box, where you can create WS-Security configurations.

Custom properties

On this page, you can create, delete, edit and view user-defined properties for your virtual API. You can also see and change these properties in the property editor on the right of the product window (in the Properties section).

The toolbar above the property list contains commands for creating and deleting properties, changing their order, sorting, clearing property values, and loading property values from and saving them to a file.

See Also

JMS Virtual Service Properties
Reference

Highlight search results