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

People Soft Agent

Default values have been specified for most parameters. They can be changed if required. Parameters that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJPSX.INI

Section/Parameter Description
[GLOBAL]  
name=

Name of the agent. 

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

The host 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 be identical to the entry in the Automation Engine's INI file.
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 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).

userid_type=

You can use this option to allow or reject certain Operator IDs.

Allowed values: INCL, EXCL

"INCL" = Access must be allowed under [USERID] for each individual Operator ID.
"EXCL" = The Operator IDs under [USERID] are not allowed. You can start jobs using one of the other Operator IDs.

UCXPWI3#=

Dynamic link library that complies with the PeopleTools version that is used.

Allowed values: "1"

WRITE=

You can use this parameter in order to specify the type of message transfer (such as lines in reports). Note that individual transfers that include thousands of lines 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 package (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=

Internal timer cycle that can be used to check the status of a job compared to PeopleSoft.

Default value: 1 second

The agent's internal job table is checked in this interval. It depends on a job's runtime whether a status check is made. The job is checked while it is running at constantly increasing time intervals (the "time" value is doubled). These intervals never exceed the value specified for the agent with JOB_CHECKINTERVALin 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....

[USERID]

Specification of the allowed PeopleTools user in the format:
User name
=START

Specification of the non-permitted PeopleTools user in the format:
User name
=NO_START

[TRACE]  
file=

Path and file name of the trace file.

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=
jcl=
databaseA database is an organized collection of data including relevant data structures.=

Trace flag for the agent's TCP/IP communication.

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 their connections to the agent by using this port number.

bindaddr=

IP address or host name for the connection to the agent.

Use this parameter if the connection should be established with a particular IP address (for example, 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 the 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=
alarm=

The PeopleSoft agent for Windows uses the parameter connect= for this function. For historical reasons, the PeopleSoft agent for UNIX uses the parameter alarm=.

Time interval in seconds in which the agent tries to establish connection to the Automation Engines. Effects the connection setup for a start or after a lost connection.

Default value: 180 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 for this purpose.

report=

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

Default value: 60 seconds

CP=

Address of the primary communication process in the AE system to which the agent should connect itself.

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 (CP or another agent). If the time limit is exceeded, the connection to the communication partner will be disconnected again.

Default value: 20 seconds

[VARIABLES]

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

[PS]

 

version=

PeopleTools version that is used.

LANGUAGE_CD=

Language indicator for the PeopleSoft messages.

Allowed values: see PeopleSoft
Default: "ENG" = English

OPRPSWD=

Source of the Operator ID passwords.

Allowed values: "0" and "1"
"0" = Passwords are stored in the Login object.
"1" = Passwords are defined in the [PSOPRPSWD] section of this INI file.

PID=

Process information that should be displayed for a PeopleSoft job in the activity and detail windows and in the statistics.

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

"0" = Session ID
"1" = Process instance number

APPSERVER= Name or TCP/IP address of the application server and number of the JOLT port.
LOG2UC4=

You can use this parameter to add log files from processes of the PeopleTools Process Scheduler Batch Server to the job report.

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

"0" = No log file is included in the job report. 
"1" = Log file is included n the job report.

DOMAIN_CONNECTION_PWD=

You can indicate the Domain Connection passwordA secret combination of characters for a Automation Engine user. here if it is used in PeopleSoft.

Note that the password must be encrypted.

[PRCS_SBB_JAVA]  
ENABLED=

Java Class usage for the PROCESSREQUEST_SBB component interface.

Allowed values: "0" and "1"
"0" = Not used.
"1" = Used.

VERSION= PROCESSREQUEST_SBB component interface version.

Allowed values:
"V0.002" for PeopleTools Version 8.2x
"V1.03" for PeopeTools Version 8.4x

CLASSES=

Path specifications for the PeopleSoft Java Object Adapter Library (psjoa.jar) Class library and for the supplied Java Classes.

Note that Windows paths are separated with the character";" and in UNIX with ":".

[PSCONFIG]

Path and file name of the application server's configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. file in the form Server Name = File.

[GENPRCSTYPE]

Only when the PeopleSoft standard interface is used. You can use it to create log-file names.

[PSOPRPSWD]

Passwords for the Operator IDs in the form Operator ID = Password.

Only used if the parameter OPRPSWD is set to "1" in the [PS] section.

[CP_LIST]

List of communication processes.

This list is created when the agent starts and it is extended if 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=HR7TEST
system=UC4
language=(E,D)
logging=..\TEMP\PS_LOGG_##.txt
logcount=5
helplib=uc.msl
helpcache=all
userid_type=EXCL
UCXPWI3#=1


[AUTHORIZATION]
InitialPackage=
KeyStore=


[STATUS_CHECK]
time=20


[USERID]
;PSDEMO=NO_START


[TRACE]
file=..\TEMP\PS_TRACE_##.txt
trccount=8
tcp/ip=0
jcl=0
database=0


[TCP/IP]
port=2545
connect=180
report=60
CP=PC01:2217
connwait=20


[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=PS
UC_EX_PATH_BIN=..\
UC_EX_PATH_TEMP=..\TEMP\
UC_EX_PATH_JOBREPORT=..\TEMP\
UC_EX_JOB_MD=
UC_EX_ERP_CONNECT=


[PS]
version=8.42
LANGUAGE_CD=ENG
OPRPSWD=0
PID=0
APPSERVER=//psserv01:9100
LOG2UC4=0


[PRCS_SBB_JAVA]
enabled=1
Version=V0.001
classes=\\hostname\Psoft\HR800\web\PSJOA\psjoa.jar;\\hostname\Psoft\HR800\web\PSJOA\


[PSCONFIG]
PSNT=\\psserv01\appserv\prcs\PSHR800\psprcs.cfg
PSUNX=\\psserv01\appserv\prcs\PSHR800\psprcs.cfg


[GENPRCSTYPE]
0=OTH
1=SQR
2=CBL
3=CRW
4=WRD
5=AE
6=CUBE
7=NVS


[PSOPRPSWD]
UC4=UC4


[CP_LIST]
2218=PC01

 

See also:

Notes for Configuration-File Adjustments