Administration Guide > Configuration > Structure of the Configuration Files > Siebel Agent

Siebel Agent

Default values have been specified for most parameters. They can be changed if required. Parameters that must be adjusted to your system environmentAn Environment consists of Deployment Targets which represent your endpoints. Different environments are used for different phases in the software delivery cycle, for example Development, QA, Staging, Production. An environment is typically set up once and used by several applications. are written in red letters.

Structure of the INI File UCXJSLX.INI

Section/Parameter Description
[GLOBAL]  
name=

Name of the agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host

The agent name is limited to 32 of the following characters: A-Z, 0-9, _, ., $, @, - and #.

The hostComputer, target system. name is used instead if this parameter remains undefined. Lowercase letters are converted to uppercase letters.

Hyphens ("-") are only allowed in agent names. They must not be used in the names of any other objects.
system= Name of the AE system.
This entry must comply with the entry in the INI file of the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes..
language=

Language that should be used for the logging. You can specify a primary and a secondary language. 

Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a message in the secondary language.

logging= Path and file name of the log file.

The xx characters in the file name are placeholders. They stand for the two-character abbreviation of the respective Windows version. See:Terminology.

The number signs serve as placeholders for a series in numerical order. When you start the agent, the log files are renamed so that the most current log file is always the one with the number "00".

logcount= Number of stored log files.
helplib= Name of the message file.
helpcache= Availability of the messages and language dependant strings.

Allowed values: ALL (default value), NONE, CONTROLS

"ALL" = The complete message file is held in the RAM.
"NONE" = Always read from the hard drive.
"CONTROLS" = All language-dependant strings that are necessary for the display of the dialog program are held in the RAM (not relevant for the agent).

WRITE=

You can use this parameter to specify the type of message transfer (such as lines in reports). Note that individual transfers that include thousands of lines will negatively affect the performance of the Automation Engine).

Allowed values: "0" (default value), "1"

"0" - Messages are sent separately.
"1" - Messages are sent block by block every second.

WRITE_TIME=

Interval in seconds during which blocks are sent.

[AUTHORIZATION]  
InitialPackage=

The name and the path of the file that includes the authentication package (company-key file).

This parameter must be specified if you use the authentication methods "Server" or "Server and Agent". Any attempt to log in fails if the company-key file cannot be found.

When the agent starts, it reads the company-key file and stores its information in the file that is specified in the parameter KeyStore=. The first file is deleted afterward.

KeyStore=

The name and the path of the file that includes the information of the authentication packageA Package is an instance (a version, a revision, a tag, …) of your application and defines the content which you want to deploy. Here you decide, if you want to deploy the entire application or just a few specified components. (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending *.kstr) or the path of the agent's INI file. If you define a file name, the ending *.kstr is not automatically appended.

The KeyStore file is created when the agent starts for the first time. You must not delete, rename or move it subsequently. Regardless of the authentication method that you use, any attempt to log in will fail if the agent cannot find this file when it starts. In this case, you must open the menu item "Renew transfer key" in the affected agent's System Overview.

[STATUS_CHECK]

 

time=

This is the system-internal timer cycle that checks the statusThis represents the condition of a task (such as active, blocked, generating). of a jobAn Automation Engine object type for a process that runs on a target system. compared to SAP.

Default value: 1 second

The agent's internal job table is checked in this interval. Whether the job's status is checked depends on its runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start).. The job is checked while it is running at constantly increasing time intervals (the "time" value is doubled). However, these intervals never exceed the value that is specified for the agent in the parameter JOB_CHECKINTERVAL in the host characteristics.

For example: time=1, JOB_CHECKINTERVAL=60

The job table is checked each second.

Status check after: 1s, 2s, 4s,..., 60s, 60s....

[TRACE]

 

file=

Path and file name of the trace file.

The xx characters in the file name are placeholders. They stand for the two-digit abbreviation of the particular Windows version. See: Terminology

The number signs serve as placeholders for a series in numerical order. When you start a trace, the trace files are renamed so that the most current trace file is always the one with the number "00"

trccount= Number of stored trace files.
tcp/ip=
filetransfer=
mail=
Trace flags for TCP/IP communication of the agent.

Allowed values: "0" (default value) to "9"

Trace flags must only be used in close cooperation with Automic Support.

[TCP/IP]  
port= Port number of the agent.
Other agents and the Job Messenger establish connection with the agent via this port number.

bindaddr=

IP address or host name for Server-process connection.

You can use this parameter when the connection should be established via a particular IP address (e.g. the computer has more than one network interface card).

Alternately, you can also specify the IP address or host name in port=.

(Format: port=IP address:port or DNS name:port). Specifications made in bindaddr= are then ignored.

bindlocal=

Consideration of local host (127.0.0.1).

Use this parameter together with bindaddr=.

Allowed values: "0" (default value), "1"

"0" - No listen socket is created.
"1" - An additional listen socket is created on the local host.

connect=

Time interval in seconds in which the agent triets to establish connection to the Automation Engines. This affects the connection setup for a restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts. or after a lost connection.

Default value: 60 seconds

This parameter is only effective until the first successful logon to the AE system. Afterwards, you can use the parameter RECONNECT_TIME in the host characteristics.

reportA report provides more detailed information about a task's execution or a component.=

Time interval in seconds in which the agent sends the logging to the Automation Engine.

Default value: 60 seconds

SendBufferSize=

Size of the TCP/IP input buffer for messages that should be sent.

RecvBufferSize=

Size of the TCP/IP input buffer for messages that should be received.

cp=

Address of the communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components. in the AE system to which the agent should connect.

Allowed formats:
DNS Name
:Port number
TCP/IP Address
:Port number

connwait=

Time interval in seconds during which the agent waits for a response from the communication partner (a CP or another agent). If the time limit is exceeded, the connection to the communication partner will be terminated again.

Default value: 20 seconds

[VARIABLES]

This section contains agent variables that include agent settings and information.

[SIEBEL]

 

DELIMITER=

Separator for the log-file content.

Siebel log files are structured in tables. You can use this parameter to define a column separator (such as *).

repeat_check=

The number of repeated status checks if the Siebel system does not return the relevant job. Only then, the job is deemed to be vanished (ENDED_VANISHED).

Background information: It can occur that a "listShows entities in a grid view taskAn executable object that is running. Tasks are also referred to as activities." command does not list the jobs that are active in the Siebel system. Therefore, these jobs obtains the status ENDED_VANISHED. Nevertheless, the affected jobs are still running in the Siebel system. To avoid this problem, the agent check the states repeatedly according to the definitions you set in this parameter.

Allowed values: 0 to 2147483647
Default value: 0

report_repeat_check=

Logging if the job could not be found in the Siebel system.

Allowed values: "0" and "1"

"1" - Each of the agent's repeated status checks causes a message that is written to the job report.
"0" - A message is only output if the maximum number of repetitions specified in "repeat_check" has been reached and the AE job changes to the status "ENDED_VANISHED".

[CP_LIST]

List of communication processes.

This list is created when the agent starts and extended when new communication processes are activated. You will find more detailed information about establishing a connection in the chapter Multi-Server Operation.

The communication process that has been defined in the parameter cp= (section [TCP/IP]) is not included in the cp list.

Format:
Port number
=DNS name
or
Port number
=TCP/IP address

Example of an INI File

[GLOBAL]
name=SI8
system=UC4
language=(D,E)
logging=..\temp\siebel_log##.txt
logcount=10
helplib=uc.msl
helpcache=all
WRITE=1
WRITE_TIME=120


[AUTHORIZATION]
InitialPackage=
KeyStore=


[STATUS_CHECK]
time=1


[TRACE]
file=siebel_trc##.txt
trccount=10
tcp/ip=4
filetransfer=0
mail=0


[TCP/IP]
port=2509
connect=30
report=60
SendBufferSize=32768
RecvBufferSize=32768
cp=PC01:2217
connwait=120


[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=SIEBEL
UC_EX_PATH_BIN=.
UC_EX_PATH_TEMP=..\temp\
UC_EX_PATH_JOBREPORT=..\temp\
UC_SIEBEL_SRVRMGR=C:\siebel\srvrmgr.exe
UC_SIEBEL_LOGPATH=C:\siebel\siebelLOGS\


[SIEBEL]
DELIMITER=*

[CP_LIST]
2218=PC01

 

See also:

Notes for Configuration-File Adjustments

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH