Launching a Web Agent

A web agent is a Java TCP/IP service that can be used to execute scenarios via a web interface.

This agent works as follows:

Note: A web agent has all the functionality of a scheduler and listener agent.

To launch a web agent:
  1. Open a Unix shell, Windows command line, or QSH (for AS/400) session

  2. Launch the appropriate command file (agentweb.bat on Windows, agentweb.sh on Unix or AS/400-QSH), with any necessary parameters.

The agent starts up.

Examples:

Agent Parameters

Caution: To launch a web agent, the parameters for connecting to the work repository where the scenarios are stored must be specified. These parameters are generally stored in the odiparams file.

The table below lists the different parameters that allow the agent to be configured according to your needs. The parameters are preceded by the "-" character and the possible values are preceded by the "=" character. You should take into account the syntax for delimiting strings specific to the command line used.

 

Parameters

Description

-port=<port>

Port on which the agent is listening. If this parameter is not specified, the agent listens on the default port of 20910.

-help

Displays the options and parameters that can be used, without launching the agent.

-name=<agent name>

This is the name of the physical agent used.

Oracle Data Integrator needs this parameter to identify which agent executed a given session in the following situations:

  • More than one agent is declared on the same machine (on different ports).

  • Your machine's IP configuration prevents Oracle Data Integrator from identifying the agent. This problem occurs frequently on AS/400.

  • The agent's IP address does not allow the agent to be identified (127.0.0.1 or "loopback").

-v=<trace level>

Specifies the level of verbosity for the agent. There are five trace levels:

  1. Displays the start and end of each session.

  2. Also displays the start and end of each step.

  3. Also displays each task executed.

  4. Also displays each SQL query executed.

  5. Displays all information, generally reserved for support calls.

As some of these levels can produce a lot of output, it is recommended that you redirect them to a text file using the following command:

  • On Windows: agentweb.bat "-v=5" > trace.txt

  • On Unix:  agentweb.sh -v=5 > trace.txt

-WEB_PORT=<http port>

HTTP port for the agent to listen for web requests on.

Work repository connection parameters

These parameters, which specify how to connect to the work repository, are specified in the file odiparams.

-SECU_DRIVER=<driver name>

The JDBC driver used to access the master repository.

For example:  oracle.jdbc.driver.OracleDriver

-SECU_URL=<url>

 

The JDBC URL used to access the master repository.

For example:  jdbc:oracle:thin:@168.67.0.100:1522:ORCL

-SECU_USER=<user>

The database user for the master repository connection.

-SECU_PASS=<password>

Password of the user for the master repository connection. This password must be encrypted using the command agent ENCODE <password>.

-WORK_REPOSITORY=<work repository name>

Name of the work repository that contains the scenarios to be executed.

See also: