Agent Installation Guide (Windows)

Prerequisites

Java

Oracle Java (preferred)

  • Oracle Java includes an installer which will fully install Java.

Open JDK

OpenJDK does not bundle an installer and can must be installed manually by carrying out the following steps:

  1. Unzip the OpenJDK Archive to a suitable directory, for example, C:\Program Files (x86)\OpenJDK.

  2. Add the OpenJDK bin directory to the system PATH and JAVA_HOME environment variables.

    1. Select the System applet from the Control Panel, and click Advanced System Properties.

    2. Click Environment Variables in the System Properties dialog.

    3. In the System Variables section, add or modify the PATH and JAVA_HOME environment variables.

  3. In a terminal/command line, execute java -version to validate that Open JDK is accessible.

Additional versions of Java exist, but have not been tested.

Some organizations have a preferred Java version, please consult your IT organization if you need assistance selecting the right version.

Installation

TTA Agent is shipped as a single executable which can be run directly. No additional installation is necessary. The Agent executable will be listed under the Resources section of the TTA Application within ServiceNow.

On the first execution of Agent, files are extracted and this may take several minutes.

Running in Server Mode

Server mode will continuously poll and run tests from a TTA Application on ServiceNow. To start Agent in server mode you may run the following:

./tta-agent --server

If you have not previously configured Agent you may also specify a configuration token to automatically set up your instance settings. This token will be listed on the Agent resource page in the TTA Application. The command will look similar to the following:

./tta-agent --config XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --server

Running in Local Mode

Local mode may be used to develop and run tests locally using the TTA Visual Studio Code extension. To run agent in local mode, you may use the command…

./tta-agent

… with no additional parameters.

Configuration

Configuring Agent may be done automatically on execution of the command as described in the previous section, or through the web portal as described below. This will only be necessary for Agents running in server mode.

  1. From your web browser navigate to http://localhost:8080

  2. Select the ServiceNow menu item.

  3. Specify the ServiceNow instance information and enable the toggle button.

  4. Click Submit.

Removing Agent

To remove Agent, you may delete the Agent files located in the users Application Data folder. For example, in Windows, this directory would be:

C:\Users\<name>\AppData\Local\caxa\applications\tta-agent

Agent Installation Guide