Home skin

 

  Location : TOP > Usage
> Parameter reference
 
     
  Parameter overviews
tg.conf parameters
SYSTEM Field
AUTOEXEC
EDITOR
LOGFILE
PLATFORM
PROMPT
SLAVE_SERVERS
SPOOL
VARIABLE_IDENTIFIER
DATABASE Field
CONNECT_URL*
DATABASE_NAME
DRIVER_CLASS
DRIVER_TYPE
DRIVERTYPE*
HOSTNAME
JDBC_DRIVER
JDBC_URL
PORT
SID_NAME
SIDNAME*
TNSNAMES
AGENT Field
AGENT_LOGON_OPTION
AGENT_PASSWORD
AGENT_USERNAME
AUTO_COMMIT
DELAY_START
ERROR_RECONNECT_COUNT
ERROR_RECONNECT_WAIT
ERROR_RETRY_COUNT
ERROR_RETRY_WAIT
EXECUTION_COUNT
ISOLATION_LEVEL
PASSWORD*
RECONNECT_WAIT
SESSIONS
SHOW_RESULTSET_ROWS
SHOW_STMT_BEFORE_EXEC
THINKTIME
USERNAME*
VARIABLE Field
VARIABLE_NAME
VARIABLE_TYPE
VARIABLE_PROP
TRANSACTION Field
AVERAGE
STATEMENT
TRANS_NAME
TRANS_TYPE
JOB Field
DRIVER_CLASS
DRIVERTYPE*
EXECFILE
HOSTNAME
IMPORT_DB_PARAMETERS
JDBC_URL
JOB_LOGON_OPTION
JOB_NAME
JOB_TYPE
PORT
PASSWORD
SIDNAME*
TNSNAMES*
TRIGGER
USERNAME
USE_AGENT_PARAM*
Terminal parameters
COLUMN
INPUT_ENCODING
OUTPUT_ENCODING
OUTPUT_LINEFEED_STRING

* obsolete parameter at TG version 0.8X
 
     
  >> TOP  
 
   

 

 

 

 

 

 

 

 

 

  Parameter overviews
There are two types of parameters which are used by TG :

1) tg.conf parameters
2) Terminal parameters

The former mainly defines putting a load on a database server. You can write parameters into "tg.conf" configuration file in advance. The latter controls Terminal that is a command prompt which interpretes commands and displays results of executions.

This chapter describes the meaning and usage about each parameter.



  tg.conf parameters

Before starting transactions, you must specify target database and transaction informaion into the "tg.conf" configuration file.
* If you use TGC, "tg.conf" is generated by TGC automatically.

"tg.conf" is composed of five filelds.

SYSTEM
DATABASE
AGENT
VARIABLE
TRANSACTION
JOB

The meaning of each field is as follows.

SYSTEM Field
Define a whole attribution of TG. For example, configraion filename, log file name, etc...

DATABASE Field
Define a target database information.

AGENT Field
Define a virtual client(Agent) information.

VARIABLE Field
Define a variable which is used in a transaction. Two or more this fields can be defined according to the number of random numbers used. The number of VARIABLE fields that can be set is 20 or less.

TRANSACTION Field
Define a transaction. Two or more this fields can be defined according to the number of transactions used. The number of TRANSACTION fields that can be set is 20 or less.

JOB Field
Define a job which is executed according to specified timing. The job can be executed in a local node and a remote node using TELNET protocol.

Each field should enclose with "<" and ">" as follows, and parameters must be set here.

<SYSTEM
parameters ...
parameters ...
...
>

<DATABASE
parameters ...
parameters ...
...
>

Using a "#" on the head of line, you can comment out the line.

 

  SYSTEM field
 
AUTOEXEC
 
Parameter type
:
String
Syntax
:
AUTOEXEC = { on | off }
Default value
:
off
Range of Values
:
on | off
 
The AUTOEXEC parameter enables or disables a job executed automatically. When the value is set to "ON", some commands which is registered as a job are executed at the specified timing.

For details about "JOB", see "JOB Field" in this reference.
 

 
EDITOR
 
Parameter type
:
String
Syntax
:
EDITOR = filename string
Default value
:
notepad.exe
Range of Values
:
Any valid file name
 
EDITOR specifies an editor program which is started up when EDIT command is executed. This parameters is available in the windows platform only.

For details about "EDIT" command, see Command reference.
 

 
LOGFILE
 
Parameter type
:
String
Syntax
:
LOGFILE = filename
Default value
:
< the same directory of tg.jar >/tg.log
Range of Values
:
Any valid file name
 
LOGFILE specifies the pathname where debugging log files are written during TG operations.
 

 
PLATFORM
 
Parameter type
:
String
Syntax
:
PLATFORM = { windows | unix }
Default value
:
Set automatically by TG
Range of Values
:
windows | unix
 
PLATFORM parameter specifies platform name where TG is running. On most platforms, TG automatically sets the value of PLATFORM which is suitable for your system. If auto-detection does not work successfully, you can also set the value to this parameter manually.
 

 
PROMPT
 
Parameter type
:
String
Syntax
:
PROMPT = prompt string
Default value
:
"TG"
Range of Values
:
None
 
PROMPT specifies TG command prompt strings. When two or more TG is executed in one node, this parameter can be used as a identification flag.
 

 
SLAVE_SERVERS
 
Parameter type
:
String
Syntax
:
SLAVE_SERVERS = hostname : port-number , ...
Default value
:
none
Range of Values
:
The number of Maximum slave servers is 8.
 

SLAVE_SERVERS specifies hostname ( or IP address) and port number of TG which is running on a remote node. Specified this parameter, TG is act as a "Master server" and control slave servers.

 

 
SPOOL
 
Parameter type
:
String
Syntax
:
SPOOL = { filename | on | off }
Default value
:
off
Range of Values
:
on | off
 

SPOOL parameter enable or disable TG messages in a file.

filename represents the name of the file to which you wish to spool.

When SPOOL is set to "ON",TG messages are written in the file which is named as "YYYYMMDDHH24MISS.log".

 

 

VARIABLE_IDENTIFIER

 
Parameter type
:
String
Syntax
:
VARIABLE_IDENTIFIER = variable identifier string
Default value
:
Colon(:)
Range of Values
:
None
 

VARIABLE_IDENTIFIER parameter specifies variable identifier strings. When this identifier was detected in SQL statements of Transactions, TG considers a character string which is beggining with the identifier as a random variable.

The default vaule of this parameter is colon(:). If you want to contain colon(:)in SQL statements as a litera, you can escapde it using this parameter.

* This parameter is supported by TG ver 0.83 or later.

 

 

  DATABASE field
 
CONNECT_URL
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.8X. Please see parameter "JDBC URL" instead.
 

 
DATABASE_NAME
 
Parameter type
:
String
Syntax
:
DATABASE_NAME = database_name string
Default value
:
None
Range of Values
:
Any valid database name
 
DATABASE_NAME parameter specifies the name of the target database.

* This parameter is available when JDBC_DRIVER parameter is set to "MySQL" or "PostgreSQL" .
 

 
DRIVER_CLASS
 
Parameter type
:
String
Syntax
:
DRIVER_CLASS = driver class string
Default value
:
None
Range of Values
:
Any valid driver class name
 
DRIVER_CLASS parameter specifies JDBC driver class name. This parameter is used when you wish to use JDBC driver which is not supported by JDBC_DRIVER parameter(OTHER THAN : MySQL Connecter/J , PostgreSQL JDBC driver, ORACLE JDBC driver).

When you use this parameter, following parameters are ignored :
- DRIVER_TYPE
- HOSTNAME
- PORT
- DATABASE_NAME (SID_NAME)
and you must specifiy the parameter JDBC_URL manually.
 

 
DRIVER_TYPE
 
Parameter type
:
String
Syntax
:
DRIVER_TYPE = { thin | oci | oci8 }
Default value
:
Thin
Range of Values
:
thin | oci | oci8 *depending on JDBC_DRIVER
 
DRIVERTYPE parameter specifies JDBC driver type which agents use to connect to the target database. Some possible settings are shown below.
 
 
JDBC_DRIVER
DRIVER_TYPE
MySQL
THIN
PostgreSQL
THIN
ORACLE
THIN | OCI | OCI8
 

 
DRIVERTYPE
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.8X. Please see parameter "DRIVER_TYPE" instead.
 

 
HOSTNAME
 
Parameter type
:
String
Syntax
:
HOSTNAME = hostname string or IP address
Default value
:
None
Range of Values
:
Any valid hostname or IP address
 
HOSTNAME parameter spcefifies the hostname where target database is running.
* This parameter is available when DRIVER_TYPE parameter is set to "THIN".
 

 
JDBC_DRIVER
 
Parameter type
:
String
Syntax
:
JDBC_DRIVER = JDBC driver String
Default value
:
MySQL
Range of Values
:
MySQL | PostgreSQL | ORACLE
 

JDBC_DRIVER parameter specifies the JDBC driver which is used by TG(Agents). Now possible vaules are "MySQL", " PostgreSQL" and "ORACLE". When you use this parameter, DRIVER_CLASS will be generated automatically as follows :

 
 
JDBC_DRIVER
DRIVER_CLASS
MySQL
com.mysql.jdbc.Driver
PostgreSQL
org.postgresql.Driver
ORACLE
oracle.jdbc.driver.OracleDriver
 

 
JDBC_URL
 
Parameter type
:
String
Syntax
:
JDBC_URL = JDBC URL String
Default value
:
None
Range of Values
:
Any valid JDBC URL
 
JDBC_URL parameter specifies JDBC URL directly. Normally this parameter is set automatically by TG according to the following parameters : "HOSTNAME" , "PORT", "DATABASE_NAME(SID_NAME)".

Use this parameter when you wish to use particular functions of each JDBC driver.
 

 
PORT
 
Parameter type
:
Integer
Syntax
:
PORT = <port number >
Default value
:
1521
Range of Values
:
0 .. 65535
 
PORT parameter specifies port number which is used by agents connecting to the target database.

* This parameter is available when DRIVERTYPE parameter is set to "THIN".
 

 
SID_NAME
 
Parameter type
:
String
Syntax
:
SID_NAME = SID string
Default value
:
None
Range of Values
:
Any valid SIDNAME
 
SIDNAME parameter specifies SID name of the target database.

* This parameter is available when JDBC_DRIVER is set to "ORACLE" and DRIVER_TYPE is set to "THIN".
 

 
SIDNAME
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.8X. Please see parameter "SID_NAME" instead.
 

 
TNSNAMES
 
Parameter type
:
String
Syntax
:
TNSNAMES = tnsnames string
Default value
:
None
Range of Values
:
Any valid TNSNAMES
 
TNSNAMES parameter specifies tnsnames description of the target database. It is necessary to define tnsnames description appropriately in "tnsnames.ora"configuration file.

* This parameter is available when JDBC_DRIVER is set to "ORACLE" and DRIVER_TYPE is set to "OCI" or "OCI8" .
 

 

  AGENT field
 
AGENT_LOGON_OPTION
 
Parameter type
:
String
Syntax
:
AGENT_LOGON_OPTION = { normal | sysdba | sysoper }
Default value
:
normal
Range of Values
:
normal | sysdba | sysoper
 
AGENT_LOGON_OPTION parameter specifies logon-option which is used by Agent connecting to the target database.

* This parameter is available when you use ORACLE database as a target database.
* This parameter is supported by TG ver 0.83 or later.
 

 
AGENT_PASSWORD
 
Parameter type
:
String
Syntax
:
AGENT_PASSWORD = password string
Default value
:
none
Range of Values
:
Any valid password
 
AGENT_PASSWORD parameter specifies password which is used by agents connecting the target database.
 

 
AGENT_USERNAME
 
Parameter type
:
String
Syntax
:
AGENT_USERNAME = username string
Default value
:
None
Range of Values
:
Any valid database user name
 
AGENT_USERNAME parameter specifies username which is used by agents connecting to the target database.
 

 
AUTO_COMMIT
 
Parameter type
:
String
Syntax
:
AUTO_COMMIT = { true | false }
Default value
:
false
Range of Values
:
true | false
 
AUTO_COMMIT parameter enables / disables AUTO COMMIT function of JDBC. Default value of this parameter is "false". When you don't use AUTO COMMIT function, you must execute COMMIT explicitly to make all data modifications performed.
 

 
DELAY_START
 
Parameter type
:
String
Syntax
:
DELAY_START = { true | false }
Default value
:
false
Range of Values
:
true | false
 
When DELAY_START parameter is set to "TRUE", each agent delayed to start transactions after START command fired. Delay time is 20 seconds or less. This parameter is used to move the transaction execution timing of each Agent.
 

 
ERROR_RECONNECT_COUNT
 
Parameter type
:
Integer
Syntax
:
ERROR_RECONNECT_COUNT = <number of re-connect >
Default value
:
5
Range of Values
:
-1 or between 0 and unlimited
 

ERROR_RECONNECT_COUNT parameter specifies the maximum counts that agents reconnect to the target database when the session has been cut. "Session has been cut" means like following cases.

- Instance was restarted unexpectedly durling agents operation.
- Agent had failed to send SQL specified times and session was cut.

When the agent has failed over ERROR_RECONNECT_COUNT times, agents give up to establish the connection.

* When this parameter is set to "0", retry is not executed.
* When this parameter is set to "-1", retry is executed unlimitedly.

cf. Waiting time before reconnecting is specified by ERROR_RECONNECT_WAIT parameter.

 

 
ERROR_RECONNECT_WAIT
 
Parameter type
:
Integer
Syntax
:
ERROR_RECONNECT_WAIT = <time to wait >
Default value
:
10000 (milliseconds)
Range of Values
:
0 .. unlimitted
 
ERROR_RECONNECT_WAIT parameter specifies ( in milliseconds ) the waiting time before agent's reconnecting when the session has been cut.
 

 
ERROR_RETRY_COUNT
 
Parameter type
:
Integer
Syntax
:
ERROR_RETRY_COUNT = <the number of retry >
Default value
:
5
Range of Values
:
None or 0..unlimitted
 
ERROR_RETRY_COUNT parameter specifies number of times the agent will be allowed to fail to execute SQL statements. When the agent has failed over ERROR_RETRY_COUNT times, the agent disconnects from the target database.

* When this parameter is set to "0", retry is not executed.
* When this parameter is null, retry is repeated unlimitedly.

cf. Waiting time before retring is specified by ERROR_RETRY_WAIT parameter.
 

 
ERROR_RETRY_WAIT
 
Parameter type
:
Integer
Syntax
:
ERROR_RETRY_WAIT = <time of wait >
Default value
:
1000(milliseconds)
Range of Values
:
none
 
ERROR_RETRY_WAIT parameter specifies ( in milliseconds ) the waiting time before agent's re-executing SQL statements when the SQL has failed.
 

 
EXECUTION_COUNT
 
Parameter type
:
Integer
Syntax
:
EXECUTION_COUNT = <the number of executing transaction >
Default value
:
1000 (milliseconds)
Range of Values
:
None or 1 .. unlimitted
 
When EXECUTION_COUNT parameter has been set to a value, agents disconnect from the target database after executed SQL statements specified times.

This parameter is used when a lot of connection/disconnection are repeated.

Waiting time before reconnection is specified at RECONNECT_WAIT parameter.
 

 
ISOLATION_LEVEL
 
Parameter type
:
String
Syntax
:
ISOLATION_LEVEL = Isolation level string
Default value
:
DEFAULT
Range of Values
:
DEFAULT | NONE | READ_UNCOMMITTED | READ_COMMITTED | REPEATABLE_READ | SERIALIZABLE
 
ISOLATION_LEVEL parameter specifies SQL transaction isolation level. Following values are available, but the value must be supported by JDBC driver which is specified at "DRIVER_CLASS" parameter. If you want to know supported isolation level, use "check isolation" command.

Incidentally, when the value is set to "DEFAULT", Default isolation level of the JDBC driver is adopted.
 
 
value
Dirty read
Non-repeatable read
Phantom read
READ_UNCOMMITTED
possible
possible
possible
READ_COMMITTED
not possible
possible
possible
REPEATABLE_READ
not possible
not possible
possible
SERIALIZABLE
not possible
not possible
not possible
 

 
PASSWORD
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.85. Please see parameter "AGENT_PASSWORD" instead.
 

 
RECONNECT_WAIT
 
Parameter type
:
Integer
Syntax
:
RECONNECT_WAIT = <wait time>
Default value
:
None
Range of Values
:
None
 
RECONNECT_WAIT parameter specifies ( in milliseconds ) the waiting time before agent's reconnecting to the target database.

* This parameter is available when EXECUTION_COUNT parameter is set to some values.
 

 
SESSIONS
 
Parameter type
:
Integer
Syntax
:
SESSIONS = <the number of connection>
Default value
:
10
Range of Values
:
1 .. 2000
 
SESSIONS parameter specifies the number of agents (virtual clients) which connect to the target database.
 

 
SHOW_RESULTSET_ROWS
 
Parameter type
:
Integer
Syntax
:
SHOW_RESULTSET_ROWS = <the number of resultset rows>
Default value
:
5
Range of Values
:
1 .. 9999999
Others
:
This parameter is supported by TG ver 0.82 or later.
 
SHOW_RESULTSET_ROWS parameter specifies resultset rows which are displayed in the console, when Agents are running on verbose-mode. A default value is "5(rows)".

Incidentally, Agents get all resultset internally regardless of this parameter's value. Be careful that this parameter controls rows displayed in the console only.
 

 
SHOW_STMT_BEFORE_EXEC
 
Parameter type
:
Integer
Syntax
:
SHOW_RESULTSET_ROWS = <the number of resultset rows>
Default value
:
5
Range of Values
:
1 .. 9999999
Others
:
This parameter is supported by TG ver 0.82 or later.
 
Normally, TG displays verbose messages after executing a transaction.
When SHOW_STMT_BEFORE_EXEC parameter is set to "true", TG displayes verbose messages before executing a transaction.
This parameter enables you to detect a hunged-up SQL statement more easily.

* This parameter is supported by TG ver 0.83 or later.
 

 
THINKTIME
 
Parameter type
:
Integer
Syntax
:
THNKTIME = <wait time>
Default value
:
100
Range of Values
:
None
 
THINKTIME parameter specifies ( in milliseconds ) the interval after one transaction is executed. Agent stands by during the specified time and executes next transactions.
 

 
USERNAME
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.85. Please see parameter "AGENT_USERNAME" instead.
 

 

  VARIABLE field
 
VARIABLE_NAME
 
Parameter type
:
String
Syntax
:
VARIABLE_NAME = variable-name string
Default value
:
None
Range of Values
:
None
 
VARIABLE_NAME parameter specifies random variable name. This name must to be started with the specific variable identifier and entered in English one byte characters. The default value of the variable identifier is colon (:) .
 

 
VARIABLE_TYPE
 
Parameter type
:
String
Syntax
:
VARIABLE_TYPE = { NUMBER | CHARACTER | DATE | LIST_STRING |
LIST_INTEGER | AGENTID }
Default value
:
None
Range of Values
:
NUMBER | CHARACTER | DATE | LIST_STRING | LIST_INTEGER | AGENTID
 
VARIABLE_TYPE parameter specifies the type of random variable. Following types are avlilable now.
- NUMBER : Random integral number
- CHARACTER : Alphanumeric character of random length
- DATE : Random date(YYYY/MM/DD)
- LIST_STRING : The user definition character string is extracted at random
- LIST_INTEGER : The user definition integral number is extracted at random
- AGENTID : Agent-ID that execute transactions
 

 
VARIABLE_PROP
 
Parameter type
:
Integer
Syntax
:
VARIABLE_PROP = <depending on VARIABLE_TYPE parameter>
Default value
:
None
Range of Values
:
Depending on VARIABLE_TYPE parameter
 
VARIABLE_PROP parameter controls the value that is set into random variable.

Case1 VARIABLE_TYPE = NUMBER
VARIABLE_PROP specifies the minimum value and maximum value of random integer. When VARIABLE_PROP is set to "10..100", random integer between 10 and 100 is put into random variable.

Case2 VARIABLE_TYPE = CHARACTER
VARIABLE_PROP specifies the minimum length and maximum length of random alphanumeric characters. When VARIABLE_PROP is set to "10..255", string of random length between 10 and 255 characters is put into random variable.

Case3 VARIABLE_TYPE = DATE
VARIABLE_PROP specifies the minimum value and maximum value of random date. When VARIABLE_PROP is set to "2000/1/1..2001/12/31", random date between 2000/01/01 and 2001/12/31 is put into random variable.

Case4 VARIABLE_TYPE = LIST_STRING | LIST_INTEGER
VARIABLE_PROP is set to one or more character strings(LIST_STRING) or integral number(LIST_INTEGER). Each value must be Double-quoted, comma-separated list.

e.g. )
VARIABLE_PROP = "January", "February", "March", "April", "May", "June", "July" , "August" , "September","October", "November", "December"

Case5 VARIABLE_TYPE = AGENTID
Agent-ID executing transactions is put into random variable.
 

 

  TRANSACTION field
 
AVERAGE
 
Parameter type
:
Integer
Syntax
:
AVERAGE = <ratio of execution >
Default value
:
None
Range of Values
:
None
 
AVERAGE parameter specifies execution ratio of the transaction. For example, Three transactions are registered and AVERAGE parameter are set to "10", "20" and "30", each transaction is executed in 10, 20 and 30 percent.
 

 
STATEMENT
 
Parameter type
:
String
Syntax
:
STATEMENT = <one SQL statement>
Default value
:
None
Range of Values
:
Any valid SQL statement
Others
:
There are some functions which are supported by TG ver 0.82 or later.
 

STATEMENT parameter specifies SQL statements performed in the transaction. Two or more STATEMENT phrases can be defined in one TRANSCATION field. The number of STATEMENT that can be registered in one TRANSACTION is 20 or less.

Incidentally, you can execute stored procedures as a transaction using "call <procedure name>".
* This function is supported by TG ver 0.82 or later.

e.g. 1)
<TRANSACTION
AVERAGE = 90
STATEMENT = select name , id from test;
>

e.g. 2)
<TRANSACTION
AVERAGE = 80
STATEMENT = insert into ntab values (idseq.nextval,':NAME0',to_date(':YEAR/:MONTH/:DAY','yyyy/mm/dd'));
STATEMENT = commit;
>

e.g. 3)
<TRANSACTION
AVERAGE = 10
STATEMENT = select * from test where id = :ID for update;
STATEMENT = update test set name = :NAME where id = :ID;
STATEMENT = rollback;
>

e.g. 4)
<TRANSACTION
AVERAGE = 5
STATEMENT = call statspack.snap();
>

 

 
TRANS_NAME
 
Parameter type
:
String
Syntax
:
TRANS_NAME = <transaction type >
Default value
:
NONE
Range of Values
:
Any valid values
 
TRANS_NAME parameter specifies the name of transaction.
 

 
TRANS_TYPE
 
Parameter type
:
String
Syntax
:
TRANS_NAME = <transaction name >
Default value
:
None
Range of Values
:
NORMAL | PRE | POST | OFFLINE
Others
:
This parameters is supported by TG ver 0.91 or later.
 
TRANS_TYPE parameter specifies the type of transaction.

Case.1 TRANS_TYPE=NORMAL
A normal transaction type. A transaction is executed according to the execution-ratio which is specified at parameter(AVERAGE) in advance.

Case.2 TRANS_TYPE=PRE
Execute a transaction only once when virtual clients start transactions (Pre Transaction)

Case.3 TRANS_TYPE=POST
Execute a transaction only once when virtual clients disconnect from target database(Post Transaction)

Case.4 TRANS_TYPE=OFFLINE
A transaction is not executed.
 

 

  JOB field
 
DRIVER_CLASS
 
Parameter type
:
String
Syntax
:
DRIVER_CLASS = driver class string
Default value
:
None
Range of Values
:
Any valid driver class name
 
DRIVER_CLASS parameter specifies JDBC driver class name.

* When IMPORT_DB_PARAMETERS is set to "TRUE", this parameter is set automatically by TG.
 

 
DRIVERTYPE
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.8X.
 

 
EXECFILE
 
Parameter type
:
String
Syntax
:
EXECFILE = <depending on JOB_TYPE parameter>
Default value
:
None
Range of Values
:
Depending on JOB_TYPE parameter
 
EXECFILE parameter specifies the command (binary file) or the script file (text file) executed as JOB. This value changes depending on parameter "JOB_TYPE".

Case.1 JOB_TYPE=COMMAND
EXECFILE is set to the command (binary file) or the batch file in the full path.

Case.2 JOB_TYPE=TELNET | SQL | PL/SQL
EXECFILE is set to the name of text file where SQL or PL/SQL statements is written. Only the file name is specified for this parameter (not in the full path). The text files are must to be in the directory that is specified at "JOB_DIR" parameter.
 

 
HOSTNAME
 
Parameter type
:
String
Syntax
:
HOSTNAME = hostname string
Default value
:
None
Range of Values
:
Any valid Operating System user name
 
HOSTNAME parameter specifies remote host name where some commands are executed.

* This parameter is available when JOB_TYPE parameter is set to "TELNET" or "SQL" or "PL/SQL".
 

 
IMPORT_DB_PARAMETERS
 
Parameter type
:
String
Syntax
:
IMPORT_DB_PARAMETERS = { true | false }
Default value
:
false
Range of Values
:
true | false
 
When IMPORT_DB_PARAMETERS is set to "TRUE", some parameters in "DATABASE field" are diverted to specified Job.

Case.1 JOB_TYPE = TELNET
- HOSTNAME

Case.2 JOB_TYPE = SQL or PL/SQL
- DRIVER_CLASS
- JDBC_URL
 

 
JDBC_URL
 
Parameter type
:
String
Syntax
:
JDBC_URL = JDBC URL String
Default value
:
None
Range of Values
:
Any valid JDBC URL
 
JDBC_URL parameter specifies JDBC URL .

* When IMPORT_DB_PARAMETERS is set to "TRUE" this parameter is set automatically by TG .
 

 
JOB_LOGON_OPTION
 
Parameter type
:
Sting
Syntax
:
JOB_LOGON_OPTION = logon option string
Default value
:
Normal
Range of Values
:
Normal | Sysdba | Sysoper
 
JOB_LOGON_OPTION parameter specifies logon-option which is used by JOB-USER connecting to the target database.

This parameter is avaiable when JOB_TYPE is set to "SQL" or "PL/SQL" and the target database is ORACLE.

* This parameter is supported by TG ver 0.83 or later.
 

 
JOB_NAME
 
Parameter type
:
Sting
Syntax
:
JOB_NAME = job-name string
Default value
:
None
Range of Values
:
None
 
JOB_NAME parameter specifies the name of JOB.
 

 
JOB_TYPE
 
Parameter type
:
String
Syntax
:
JOB_TYPE = { COMMAND | TELNET | SQL | PL/SQL }
Default value
:
None
Range of Values
:
COMMAND | TELNET | SQL | PL/SQL
 

JOB_TYPE parameter specifies the type of JOB.

Case1 JOB_TYPE = COMMAND
JOB is executed on the local node. EXECFILE parameter must be set to one command or text file where some commands are written.

Case2 JOB_TYPE = TELNET
JOB is executed on the remote node. EXECFILE parameter must be set to the text file where some commands are written.
* It is necessary to set up the TELNET server appropriately on the remote node to send some commands by using the TELNET protocol.

Case3 JOB_TYPE = SQL
JOB is executed on the target database server. EXECFILE parameter must be set to the text file where some SQL statements are written.

Case4 JOB_TYPE = PL/SQL
JOB is executed on the target database server. EXECFILE parameter must be set to the text file where some PL/SQL statements are written.

 

 
PORT
 
Parameter type
:
Integer
Syntax
:
PORT = <port number>
Default value
:
23
Range of Values
:
0 .. 65535
 

PORT parameter specifies the port number to connect to the remote node when TG executes a JOB.

Case1 JOB_TYPE = COMMAND
PORT parameter is not used.

Case2 JOB_TYPE = TELNET
PORT parameter must be set to the port number where TELNET server is listening. Default value is "23".

Case3 JOB_TYPE = SQL or PL/SQL
PORT parameter is not used.

 

 
PASSWORD
 
Parameter type
:
String
Syntax
:
PASSWORD = password string
Default value
:
None
Range of Values
:
Any valid password
 

PASSWORD parameter specifies the password to connect to the remote node when TG executes a JOB.

Case1 JOB_TYPE = COMMAND
PASSWORD parameter is not used.

Case2 JOB_TYPE = TELNET
PASSWORD parameter must be set to OS USER password.

Case3 JOB_TYPE = SQL or PL/SQL
PASSWORD parameter is not used.

 

 
SIDNAME
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.8X.
 

 
TNSNAMES
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.8X.
 

 
TRIGGER
 
Parameter type
:
String
Syntax
:
TRIGGER =Trigger string, ...
Default value
:
None
Range of Values
:
ON_AGENTS_CONNECTING | ON_AGENTS_DISCONNECTING | ON_MONITOR_STARTING | ON_MONITOR_FINISHING | ON_TG_STARTING | ON_TG_FINISHING
 
TRIGGER parameter specifies the event name that becomes the trigger of the JOB execution.

Case1 TRIGGER = ON_AGENTS_CONNECTING
JOB is executed when agents connect to the target database.

Case2 TRIGGER = ON_AGENTS_DISCONNECTING
JOB is executed when agents disconnect from the target database.

Case3 TRIGGER = ON_MONITOR_STARTING
JOB is executed when TPS monitor is started.

Case4 TRIGGER = ON_MONITOR_FINISHING
JOB is executed when TPS monitor is terminated.


Case5 TRIGGER = ON_TG_STARTING
JOB is executed when TG startup.

Case6 TRIGGER = ON_TG_FINISHING
JOB is executed when TG terminate.

When you haven't specified TRIGGER, JOB is not executed automatically. You need to execute the JOB manually using the "EXECUTE" command.
 

 
USERNAME
 
Parameter type
:
String
Syntax
:
USERNAME = username string
Default value
:
None
Range of Values
:
Any valid user name
 

USERNAME parameter specifies the username to connect to the remote node when TG executes a JOB.

Case1 JOB_TYPE = COMMAND
USERNAME parameter is not used.

Case2 JOB_TYPE = TELNET
USERNAME parameter must be set to OS USER name.

Case3 JOB_TYPE = SQL or PL/SQL
USERNAME parameter is not used.

 

 
USE_AGENT_PARAM
 
Parameter type
:
-
Syntax
:
-
Default value
:
-
Range of Values
:
-
 
This parameter is obsoleted parameter at TG version 0.8X. Please see parameter "IMPORT_DB_PARAMETERS" instead.
 



  Terminal parameters
 
COLUMN
 
Parameter type
:
COLUMN NAME : String
COLUMN LENGTH : Integer
Syntax
:
COLMUN = < column name > < column length >
Default value
:
COLUMN NAME : * , COLUMN LENGTH:16
Range of Values
:
-
 
COLUMN parameter specifies a column name and length of a resultset which is displayed when SELECT SQL statement was executed manually.

Incidentally, "*" column name is dealed with as a wildcard. This value is used when column name is not specified.

*This parameter is available in TG version 0.85 or later.
 

 
INPUT_ENCODING
 
Parameter type
:
String
Syntax
:
INPUT_ENCODING = < characterset name >
Default value
:
depending on a system
Range of Values
:
any which is supported by Java
 
INPUT_ENCODING parameter specifies a characterset which is recieved by a Terminal.

*This parameter is available in TG version 0.85 or later.
 

 
OUTPUT_ENCODING
 
Parameter type
:
String
Syntax
:
OUTPUT_ENCODING = < characterset name >
Default value
:
depending on a system
Range of Values
:
any which is supported by Java
 
OUTPUT_ENCODING parameter specifies a characterset which is sent by a Terminal.

*This parameter is available in TG version 0.85 or later.
 

 
OUTPUT_LINEFEED_STRING
 
Parameter type
:
Hex integer
Syntax
:
OUTPUT_LINEFEED_STRING = < linefeed string >
Default value
:
depending on a system
Range of Values
:
0d |0a | 0d0a
 
OUTPUT_LINEFEED_STRING parameter specifies a linefeed string which is sent by a Terminal.

*This parameter is available in TG version 0.85 or later.
 

 

     
  >> TOP > Usage
> Parameter reference
 

 

 

 
 

 

 
 
Copyright 2003 - 2009 tgmstr. All rights reserved.