Home
Rational® Integration Tester
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.
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.
Testing with the HTTP transport
To provide support for HTTP-based communications, you must configure and run Rational® Integration Tester by using the HTTP transport and SOAP message formatters.
Common Schema Definition Language definitions

Rational® Integration Tester
- 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® Integration Tester.
- Getting Started
  This guide provides an overview and describes the tasks to get you started with Rational® Integration Tester.
- Administrator Guide
  This guide describes how to install Rational® Integration Tester. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
- 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.
    - 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.
      - Testing Java™ applications
        You can use Rational® Integration Tester to test Java™ applications.
      - Testing Java™ Message Service (JMS) systems
        Use the generic JMS plug-in to connect Rational® Integration Tester to a wide range of EAI platforms, which includes any vendor that provides an implementation of this Java™ standard. JMS provides a way of separating the application from the transport layer of providing data. The same Java classes can be used to communicate with different JMS providers by using the JNDI information for a specific provider. The classes first use a connection factory to connect to the queue or topic, and then use populate and send or publish the messages. On the receiving side, the clients then receive or subscribe to the messages
      - Testing Java™ objects
        You can import Plain Old Java™ Objects (POJOs) from JAR files into Rational® Integration Tester in order to parse and construct messages containing the serialized forms of those objects. You can construct and parse the Java objects and perform validation, but you cannot test the objects directly.
      - Testing with Apache Camel components
        You can use Rational® Integration Tester to create tests and stubs by setting up an Apache Camel component in a Rational Integration Tester project. You can configure the technology endpoints supported by the Camel component as the physical resources in the Rational Integration Tester project and test for the services provided by the technology.
      - Testing with Apache Kafka
        Starting from IBM® Rational® Integration Tester 10.0.2 and later, you can create Kafka transports to test Kafka services.
      - Testing with Docker
        You can use Docker containers with Rational® Integration Tester to run stubs co-located with your test systems.
      - Testing with the email transport
        When you use applications in your test environment that use email services, you can use Rational® Integration Tester to create tests and stubs for testing the email services. You can set up an email transport in a Rational Integration Tester project and configure the email servers as the physical resources in the Rational Integration Tester project, and then test the email services.
      - Testing with Envoy Proxy (Experimental)
        You can use Rational® Integration Tester to record the HTTP traffic on the Envoy Proxy by using the Experimental HTTP Tap Filter feature of the Envoy Proxy.
      - Testing with the File transport
        As with any other transport, the File transport includes both logical and physical configurations. Tests and stubs are associated with the logical File resource, which represents an abstraction of the File resource and is the same for all environments. The physical File Access configuration includes connection details, and you can configure a different physical File Access for each environment.
      - Testing with the FIX transport
        You can use the Financial Information eXchange (FIX) transport and FIX dictionaries in Rational® Integration Tester to help you test trade-related messages and the systems that use them.
      - Testing with the HTTP transport
        To provide support for HTTP-based communications, you must configure and run Rational® Integration Tester by using the HTTP transport and SOAP message formatters.
        Adding a synchronization source
        You can add any of the available synchronization sources to automatically create the resources that are required for testing the API that the definition describes.
        WADL documents
        A Web Application Description Language (WADL) document is a machine-readable XML description of HTTP-based web applications (typically REST web services). WADL models the resources provided by a service and the relationships between them.
        Swagger definitions
        A Swagger definition specifies a set of metadata that describes a REST API.
        RAML definitions
        A RAML definition specifies a set of metadata that describes a REST API.
        OpenAPI 3.0 definitions
        An OpenAPI 3.0 definition specifies a set of metadata that describes a REST API.
        Common Schema Definition Language definitions
        Adding a CSDL definition as a synchronization source
        You can add a CSDL definition to automatically create the resources that are required for testing the API that the definition describes.
        Web services
        To provide support for HTTP-based communications and communicate with Web Services, you must configure and run Rational® Integration Tester by using the HTTP transport and SOAP message formatters.
        HTTP transport
        Rational® Integration Tester provides access to HTTP and HTTPS-based communications through an extension of its transport mechanism.
        Troubleshooting: HTTP and Web Services
        You can use workarounds to common problems that you might encounter when you use HTTP and Web Services.
      - Testing with IBM® API Developer Portals
        You can configure IBM® Rational® Integration Tester to synchronize IBM API Connect™ Developer Portal resources or IBM API Management Developer Portal resources.
      - Testing with IBM® App Connect Enterprise
        When you want to test the services on applications deployed by the integration node of IBM® App Connect Enterprise, you can use the synchronization feature in Rational® Integration Tester to import details of deployed applications into a Rational Integration Tester project. You can select the tests and stubs to be created in your project during the synchronization process in Rational Integration Tester.
      - Testing with IBM® Integration Bus
        When you want to test the services on applications deployed by the integration node of IBM® Integration Bus, you can use the synchronization feature in Rational® Integration Tester to import details of deployed applications into a Rational Integration Tester project. You can select the tests and stubs to be created in your project during the synchronization process in Rational Integration Tester.
      - Testing with IBM® WebSphere® Application Server
        You can configure IBM® Rational® Integration Tester to synchronize IBM WebSphere® Application Server resources.
      - Testing with IBM® WebSphere® MQ messages
        You can test WebSphere® MQ messages using the WebSphere MQ transport method or JMS interface. Rational® Integration Tester also supports testing WebSphere MQ on z/OS systems.
      - Testing with WebSphere® Portal
        You can configure IBM® Rational® Integration Tester to synchronize IBM WebSphere® Portal resources.
      - Testing with IBM® z/OS® Connect Enterprise Edition
        IBM® z/OS® Connect Enterprise Edition provides a framework for enabling z/OS®-based programs and data to fully participate in the new API economy for mobile and cloud applications. Use IBM® z/OS® Connect Enterprise Edition to access z/OS subsystems, such as CICS®, IMS™ and Batch, by using RESTful APIs with JSON formatted messages. You can access multiple z/OS subsystems concurrently through a common interface.
      - Testing with Istio
        When you have applications hosted in a Kubernetes cluster that have Istio as a service mesh, you can virtualize the services in the cluster by creating stubs and tests for testing with Istio in Rational® Integration Tester.
      - Testing with Kubernetes
        For testing with Kubernetes set up a Kubernetes cluster, and then you can create and publish stubs from Rational® Integration Tester so that stubs can be run within Kubernetes. The stubs published can be co-located with existing services running within the Kubernetes cluster.
      - Testing with Microsoft™ .NET objects
        You can import serializable .NET objects from .NET assembly files (.exe or .dll) into IBM® Rational® Integration Tester and apply them to messages in the same way as you would apply a schema. A service-based test or stub can then send and receive a message containing a serialized form of a .NET object from the assembly file. You can construct and parse the .NET objects and perform validation, but you cannot test the objects directly.
      - Testing with MongoDB
        If you are using Rational® Integration Tester 9.5.0 or later, you can create MongoDB transports and run tests against them.
      - Testing with the MQ telemetry transport
        If you are using Rational® Integration Tester 8.6.0 or later, you can create MQ telemetry transports.
      - Testing with Oracle Fusion
        Configure and run Rational® Integration Tester with the Oracle Fusion plug-in, which provides support for synchronization with and testing of the web services and composites that are available on a configured SOA server (that is, an Oracle WebLogic server with Oracle SOA Suite 11g deployed on it).
      - Testing with RabbitMQ
        If you are using Rational® Integration Tester 9.2.1.1 or later, you can create RabbitMQ transports.
      - Testing with SAP applications
        You can use Rational® Integration Tester to test SAP application server resources.
      - Testing with Software AG CentraSite
        You can incorporate governance in your SOA by using the integration of Rational® Integration Tester with Software AG CentraSite.
      - Testing with Software AG Universal Messaging
        You can use Rational® Integration Tester API to test Software AG Universal Messaging Broker server resources. From Rational Integration Tester 10.0.2 or later, you can create Software AG Universal Messaging Broker transports, configure and run Rational Integration Tester with the Software AG Universal Messaging server.
      - Testing with Software AG webMethods
        You can configure and run Rational® Integration Tester with the Software AG webMethods Integration Server to connect to Software AG webMethods Broker and Integration Server resources.
      - Testing with SSL
        To provide secure connections between clients and servers during testing, you can use the Secure Sockets Layer (SSL) technology supported by Rational® Integration Tester.
      - TCP and UDP
        In Rational® Integration Tester, you can create transports that facilitate communication between clients and servers by using both TCP- and UDP-based sockets.
      - Testing with TIBCO applications
        To use IBM® Rational® Integration Tester to test TIBCO messaging, you must configure and run Rational Integration Tester with the TIBCO messaging plug-in. Doing so supports TIBCO Rendezvous messaging ("plain" TIBCO Rendezvous messaging and TIBCO ActiveEnterprise (AE) formats), TIBCO EMS messaging, and sending and receiving AE messages by using TIBCO EMS.
      - Testing applications on z/OS®
        You can test applications on IBM® z/OS® systems by using the capabilities that are supported for mainframes by Rational® Integration Tester. Rational Integration Tester is installed as part of the IBM Rational Test Workbench product offering.
      - Configuration of virtual IP addresses as virtual clients
        You can find information about how to configure virtual IP addresses in the operating system, and then use the virtual IP addresses to configure them as virtual clients in tests or as virtual servers in stubs.
    - 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.
  - 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 (Service Virtualization)
    This guide describes the tasks that you can perform for using virtual services or stubs to simulate parts of an environment if the real services are not yet available or because they are difficult or expensive to use. This guide is intended for Integration Testers.
- Test Manager Guide
  This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
- Troubleshooting
  While working with Rational® Integration Tester, you might encounter some problems that you can easily troubleshoot.
- Reference Guide
  This guide provides the topics to help the Integration tester use the product by using the user interface, commands or scripts. This guide is intended for Integration testers.
- 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.

Common Schema Definition Language definitions

Common Schema Definition Language (CSDL) 4.0 definition specifies a set of metadata that describes an OData service.

When a URL points to a CSDL document, you can use it as an external synchronization source. You can synchronize this source with the project. For more information about synchronization, see the related links on this page.

Synchronization creates the following resources:

Operations in the Logical view of the Architectural School perspective for all of the entity sets and singletons defined in the CSDL file
Tests and stubs in the Test Factory view
New schemas in the Schema Library of the following types:
- JSON Schema
- WEB URL schema
The schemas are used to test the service described in the CSDL file.

You can use the new schemas to create tests and stubs, either manually or from Message Exchange Pattern (MEP) that can test the API with valid requests.