Registering Rational Integration Tester Agent with Rational Test Control Panel

IBM® Rational® Test Control Panel runs stubs on agents. Agents can also be used to run scheduled tests. During the installation of IBM Rational Integration Tester Agent, the agent is configured to register with Rational Test Control Panel instances so that they are available for stubs and/or running scheduled tests.

About this task

After the installation of the Rational Integration Tester Agent, you can change the configuration of the agent by editing the Agent.config file manually. For example, you might need to change the URL of the Rational Test Control Panel instance with which the agent is registered.

Note: An agent can be registered with only one Rational Test Control Panel instance at any given time.

Note: The settings in the Agent.config file are used regardless of whether the agent is run from a command prompt or as a service.

Procedure

Using a text editor program, open the Agent.config file, which is in <Rational Integration Tester Agent installation directory>\config.

Find the Rational Test Control Panel properties at the end of the file:

<rtcp enabled="true">
    <jmxPort value="8765"/>
        <!-- <rtcpURL value="http://localhost:7819/RTCP" security-token="" /> -->
    <!-- NOTE: If editing by hand the URL should include http:// at the beginning -->
    <rtcpURL value="http://localhost:7819/RTCP" />
        <!--
        The optional identifier name can be used to help identify the agent within the Agnts
        view in Rational Test Control Panel
        -->
        <identifier name="identifier"/>
        -->
<!--
    The Agent does not need to register against a specific domain
    or environment. By default it will be made available to all domains/environments. If
    you want to restrict its use then add <domain> entries based on the example
    below. Each domain may have 0 or more environments, if 0 environments are specified
    then the Agent will register for all environments within the supplied domain.
-->
<!--
<domains>
     <domain name="testDomain">
         <environment name="testEnvironment"/>
     </domain>
</domains>
-->
<!--
    The Agent can have custom attributes defined that can then be used when running stubs
    or scheduling tests. By default the operating system name (e.g. "Windows 7") is added
    as an attribute, to add custom ones uncomment the "agentAttributes" section below and
    add an "attribute" element for each attribute. An example has been provided with the
    attribute "DB2". 
    Attributes must not contain the comma character, but may contain spaces. Attributes
    are case-insensitive.
-->
<!--
<agentAttributes>
     <attribute value="DB2" />
</agentAttributes>
-->
</rtcp>

Ensure that the enabled attribute is set to true.
Set the jmxPort and rtcpURL values as required.
Notes:
- The jmxPort is used for internal agent communication and, in normal use, it would need to be changed only if the default configuration port is already in use on the computer where the agent is installed.
- The server URL must not end with a forward slash (/).
- You can specify Internationalized Domain Names (IDN) values as the host name in the URL field. To update the file with the IDN value, you must open the file in "UTF-8" encoding format.
Uncomment and edit the <identifier name> value if you want to specify a name for the agent.
The name will be displayed on the Agents page of Rational Test Control Panel 8.6.0 or later. Assigning a name to an agent makes it easier to identify the agent when there are two or more agents of the same type registered with Rational Test Control Panel.
Note: The <identifier name> value is available only in Rational Integration Tester Agent 8.6.0 or later.
If you want to restrict this agent so that it is available only for specific domains and environments, uncomment the <domains> block and enter one or more domains and environments.
Note: If Rational Integration Tester Agent was installed in agent mode, you must restrict the agent so that it is available only for specific domains and environments. This is because the default Agent.config file makes the agent available for running stubs in all domains and environments managed by Rational Test Control Panel.

Note: Each environment name value must end with a forward slash (/). Otherwise, the XML will be invalid and the agent may not start.
Save and close the file.
If the agent was running while the Agent.config file was being modified, restart it to enable the changes that you have made to take effect.

Results

To determine if Rational Integration Tester Agent registered correctly, log into Rational Test Control Panel as an administrator and open the Agents page. A list of registered agents and proxies will be displayed.

Note: Rational Test Control Panel "heartbeats" with Rational Integration Tester agents and Rational Integration Tester proxies, so Rational Test Control Panel is aware if they stop running, and the agent and proxies are aware if Rational Test Control Panel stops running. The agent/proxy logs and Agents page of Rational Test Control Panel will indicate this if it happens. The environment will recover itself when the agent/proxy or Rational Test Control Panel restarts. For example, if an environment is running with two or more Rational Integration Tester Agents and two or more Rational Integration Tester proxies, and Rational Test Control Panel is restarted, the agents and proxies will register automatically when Rational Test Control Panel restarts, so they do not need to have to be restarted manually.

Feedback