Adding the CICS® Transaction Gateway agent to a client application

To record or virtualize requests in a CICS® Transaction Gateway Java™ client, you must add the CICS® Transaction Gateway agent that is provided with Test Virtualization Control Panel to the client application.

Procedure

  1. Download and extract the CICS® Transaction Gateway exits package (IBMCICSTransactionGateway.zip) that is provided with Test Virtualization Control Panel into a location.
    Based on the type of client applications you are using, select the method as follows:
    • If you are working with java client applications, go to Step 2.
    • If you are working with IBM® WebSphere® Application Server client applications, go to Step 4.
  2. Open the registration.xml file, which is located in the same directory as the com.ibm.rational.rit.ctg.jar file to verify that the server base-url attribute has the correct URL for an instance of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel). If the value is not correct, change it to the correct value.
  3. Perform any of the following steps if you moved the com.ibm.rational.rit.ctg.jar file from its default installation location:
    • Copy the registration.xml file into the same directory as the com.ibm.rational.rit.ctg.jar file.
    • Specify the following Java™ system property when running the client application:

      -Dcom.ibm.rational.rit.registration=<location of registration.cicstg>

      where <location of registration.cicstg> is the full path to the registration.cicstg file.

    You have added the CICS® Transaction Gateway agent to a java client application.

  4. Open the registration.xml file, which is located in the same directory as the com.ibm.rational.rit.ctg.jar file to verify that the server base-url attribute has the correct URL for an instance of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel). If the value is not correct, change it to the correct value.
  5. Modify the classpath for the client application to include com.ibm.rational.rit.ctg.jar, which is located in the extracted CICSTransationGateway folder.
  6. Use the following information to determine where to place the com.ibm.rational.rit.ctg.jar file.
    Note: Apply the following information when you use the supported versions of IBM® WebSphere® Application Server. You might want to refer for specific instructions to the product documentation for the specific version and type of the server you have deployed. You must use the following information only as a guideline if any of the conditions match your requirements.

    If...

    		 Then...

    If you want to use a single version of com.ibm.rational.rit.ctg.jar file that is shared with other enterprise applications installed on the server that does not cause the server to malfunction.

    Follow the instructions for setting up a shared library with a server classloader.

    If you want to use a single version of com.ibm.rational.rit.ctg.jar file that is shared with other enterprise applications installed on the server to prevent the server from malfunctioning.

    Follow the instructions for setting up a shared library with an application or module.

    If you want to use a single version of com.ibm.rational.rit.ctg.jar file that is shared with other enterprise applications installed on the server and multiple modules within the application use this jar file.

    Follow the instructions for setting up a shared library with an application or module. You must place the jar file at the root of the EAR file.

    If you want to use a single version of com.ibm.rational.rit.ctg.jar file that is shared with other enterprise applications installed on the server and multiple modules within the application do not use this jar file.

    Follow the instructions for setting up a shared library with an application or module. You must place the jar file within the module that uses the jar file.

    If you want to use multiple versions of com.ibm.rational.rit.ctg.jar files.

    Follow the instructions for setting up a shared library for each unique version of the jar file. You must then associate the shared library to the appropriate application that uses the specific version of the jar file.

    If you want to override a file that is included with IBM® WebSphere® Application Server.

    		 After you have set up the shared library, you must change the classloader settings of the classloader where the jar file is added.

    You have added the CICS® Transaction Gateway agent to a IBM® WebSphere® Application Server client application.