Home
Rational® Performance Test Server
Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
Integration Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide is intended for Integration testers.
Working in non-GUI mode
You can use the tools and executable files that are provided along with the product software. You can use these tools to perform different test actions in a non-GUI mode.
Managing environments
Locking a Rational® Test Control Panel environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
Locking an environment by using an Ant task
You can lock an environment by using the IBM® Rational® Test Control Panel Ant tasks.

Rational® Performance Test Server
- Release Notes
  This document contains information about What's new, installation, known issues, and contact information of IBM Support.
- System Requirements
  This document includes information about hardware and software requirements for IBM® Rational® Test Virtualization Server.
- Getting Started
  This guide provides an overview and describes the tasks to get you started with IBM® Rational® Performance Test Server.
- Administrator Guide
  Typically, a user with the administrator role is responsible for certain tasks including installation, configuration, and integration of the product. This guide lists all such topics.
- Tester Guide
  This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
  - Technical Tester Guide
    Typically, a user with the Integration Tester role is also responsible for performance testing. This guide lists all such topics.
  - Integration Tester Guide
    This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide is intended for Integration testers.
    - Integration Tester Guide
      This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide is intended for Integration testers.
    - Extending Rational® Integration Tester functionality by using custom functions
      You can add more calculations and operations to tests by using the Rational® Integration Tester custom function class. Rational Integration Tester custom function is a Java™ class that extends the com.ghc.ghTester.expressions function.
    - Working in non-GUI mode
      You can use the tools and executable files that are provided along with the product software. You can use these tools to perform different test actions in a non-GUI mode.
      - Command-line interfaces
        Rational® Integration Tester command-line client is available in Rational Integration Tester 8.0.1 or later.
      - Ant tasks
        You can use the supported Ant tasks that is supplied with Rational® Test Control Panel to create, update, or manage the environment, scenarios, and stubs.
      - REST services
        Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with IBM® Rational® Test Control Panel, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
      - Running tests
        Use Rational® Integration Tester to run tests with command-line and Ant APIs.
      - Managing test results
        Use IBM® Rational® Test Control Panel to manage test results with command-line APIs.
      - Managing domains
        You can create, list, update, and delete domains with the Rational® Test Control Panel REST API.
      - Managing environments
        Locking a Rational® Test Control Panel environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
        Locking an environment by using the command line
        You can lock an environment by using the Rational® Integration Tester command line. This option is useful in situations where Ant is not available.
        Unlocking an environment by using the command line
        You can unlock an environment by using the Rational® Integration Tester command line. This option is useful in situations where Ant is not available.
        Deleting an environment by using the command line
        You can delete an environment and its associated artifacts by using the Rational® Integration Tester command line. This option is useful in situations where Ant is not available.
        Creating an environment by using an Ant task
        You can create an environment by using the IBM® Rational® Test Control Panel Ant task.
        Deleting an environment by using an Ant task
        You can delete an environment and its associated artifacts by using the IBM® Rational® Test Control Panel Ant tasks.
        Updating an environment by using an Ant task
        You can update values of the attributes of an environment by using the IBM® Rational® Test Control Panel Ant task.
        Locking an environment by using an Ant task
        You can lock an environment by using the IBM® Rational® Test Control Panel Ant tasks.
        Unlocking an environment by using an Ant task
        You can unlock an environment by using the IBM® Rational® Test Control Panel Ant tasks.
        REST services
        Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with IBM® Rational® Test Control Panel, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
      - Managing scenarios
        Use IBM® Rational® Test Control Panel to manage scenarios with command-line, Ant, and REST APIs.
      - Managing stubs
        You can manage stubs by using the command-line, Ant, and REST APIs.
- Security Considerations
  You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
- Notices
  This document provides information about copyright, trademarks, terms and conditions for product documentation.

Locking an environment by using an Ant task

You can lock an environment by using the IBM® Rational® Test Control Panel Ant tasks.

Here is an example syntax:

<taskdef name="lockEnvironment" classname="com.ghc.ghTester.ant.LockEnvironment" classpathref="tasklib"/>

<lockEnvironment domain="<Domain name>" environment="<Environment name>"
username="<User name>" reason="<Reason>" duration="<Number of minutes>" serverUrl="https://Host name or IP address:5443/RTCP/"/>

The following table lists the attributes that you can use with the lockEnvironment Ant task for locking an environment.

Table 1. List of available attributes
Attribute	Description	Required
`serverUrl`	URL of the Rational® Test Control Panel	Yes
`domain`	Domain name	Yes
`environment`	Environment name	Yes
`username`	The user name under which to perform the operation.	No
`reason`	The reason for locking the environment.	No
`duration`	The number of minutes that you expect to keep the environment locked.	No.
`force`	Attempt to first unlock the environment if another user has the lock (flag).	No, default is false.
`securityToken`	The value of the security token to use for authentication with Rational® Test Control Panel when domain security is enabled (optional). For more information, see Domain level security.	No, default is to send no token.
`haltOnFailure`	Set to true to fail the Ant script if the environment fails to lock (flag).	No, default is false.
`failureProperty`	The name of a property that is set in the event of a failure.	No
`waitFor`	If the environment is already locked, to specify the number of seconds that the task should wait for to allow the environment to be unlocked. If the environment gets unlocked during this period, the task locks the environment. A value of 0 indicates the task to wait indefinitely.	No

Error codes

For details of any error codes, see Exit codes for Command-line client and Ant client.