How to Use AUT Environments with VAPI-XP

ALM Editions:  AUT Environments and Functional test sets are available only for ALM Edition. For information about ALM editions and their functionality, see ALM Editions. To find out what edition of ALM you are using, ask your ALM site administrator.

VAPI-XP tests can be run using server-side execution when they are part of a Functional test set. When using server-side execution, you can take advantage of AUT Environments. AUT Environments allows users to make test execution more dynamic by parameterizing the environment data used for testing. Instead of defining and running several different VAPI-XP tests that use the same logic but need different environment parameters, you can simply program your VAPI-XP test to use an already defined AUT environment configuration that ALM inserts into your test at run-time.

For details about Functional test sets, see Test Set Specification Overview.

For information about setting up AUT environment configurations and environment parameters, see How to Work with AUT Environments.

To use your AUT environment configuration in a VAPI-XP script, you use the following functions:

Post

Invoke this function before calling functions that access AUT parameters.

currentRun.post()

getRunTimeParameterByName

Returns the environment parameter value based on parameter name.

currentRun.getRunTimeParameterByName(Name)

Name. Environment parameter name.

getRunTimeParameterByGuid

Returns the environment parameter value based on parameter Guid.

currentRun.getRunTimeParameterByGuid(Guid)

Guid. Environment parameter Guid.

isSSE

Returns TRUE if the test is being run as a server-side execution test in a Functional test set.

currentRun.isSSE

ReservationId

Returns the timeslot ID of the test if the test is being run as a server-side execution test in a Functional test set.Otherwise, returns NULL.

currentRun.ReservationID

Back to top