Previous Topic: Configure Agent Parameters on the Scheduling ManagerNext Topic: How to Set Up an Alias for the Agent Plug-in

Configuring the Agent Plug-in › PeopleSoft Agent Plug-in Parameters in the agentparm.txt File

PeopleSoft Agent Plug-in Parameters in the agentparm.txt File

You can configure the following parameters in the agentparm.txt file. The file is located in the agent installation directory. You can open the agentparm.txt file in any standard text editor.

communication.alias_n

Defines the alias name for the agent. The n suffix increments sequentially for each alias agent.

Note: To enable an alias on the agent, verify that the comment character (#) is removed from the parameter line.

Default: AGENTNAME_PS

plugins.start_internal_n

Specifies the agent plug-in to start by the core Java agent.

n

Denotes an integer that is assigned to the agent plug-in, starting at 1. The n suffix must increase sequentially for each agent plug-in.

Default: ps

ps.db.accessId

Sets the user ID that the agent plug-in uses to connect to the PeopleSoft database.

Example: sysadm

ps.db.accessPassword

Sets the encrypted password that the agent plug-in uses to connect to the PeopleSoft database.

Example: 7379736164D

ps.db.typeName

Sets the database type to one of the following databases:

ps.db.typeNr

Sets the database type number as follows:

ps.db.url

Specifies the JDBC connection string (URL) for the database. The URL format for each database is as follows:

Note: The agent only works with one PeopleSoft database instance. To change the URL, update this parameter in the agentparm.txt file. You cannot override the ps.db.url parameter in the job definition.

ps.default.oprId

Sets the default operator ID under whose authority the PeopleSoft reports run. The agent plug-in validates this operator ID against the corresponding value in the PeopleSoft database. The ps.default.oprPassword parameter specifies the password that is related to this ID. You can specify an operator ID in a job definition to override the default value.

Example: VP1

ps.default.oprPassword

Sets the encrypted password for the default operator ID specified in the ps.default.oprId parameter.

Example: 6343B940CFCBC53E

ps.default.outDestFormat

Sets the default output destination format. For a list of output destination formats, see the PSXLATITEM table in the PeopleSoft database. You can specify an output destination format in a job definition to override the default value.

Example: PDF

ps.default.outDestType

Sets the default output destination type. For a list of output destination types, see the PSXLATITEM table in the PeopleSoft database. You can specify an output destination type in a job definition to override the default value.

Example: FILE

ps.default.printer

Sets the default value for the printer and includes the complete path and name of the printer.

Default: lpt

ps.default.runCntlId

Sets the default value for the run control ID that identifies a set of run parameters for a given PeopleSoft process. You can specify a run control ID in a job definition to override the default value.

Example: PS_ALL

ps.default.serverName

Sets the default value for the name of the target server executing the PeopleSoft job. You can leave this parameter undefined. The PeopleSoft scheduler determines where to run the job. You can specify a server name in a job definition to override the default value.

Example: PSNT

ps.home

Specifies the PeopleSoft home directory relative to the agent plug-in. Set this value only if the agent plug-in does not have access to the PS_HOME directory.

Note: If you installed the agent and the agent plug-in on the same server as the PeopleSoft Process Scheduler server, you do not have to set ps.home.

ps.jobmonitor.pollinginterval

Sets the PeopleSoft job monitor polling interval in milliseconds.

Default: 10000 milliseconds (10 seconds).

ps.noCreateRunCntl

Overrides the default agent plug-in behavior of creating run control IDs if they do not exist, as follows:

true

Indicates that the agent plug-in does not create run control IDs. If the run control ID specified in the job definition does not exist, the job fails.

false

Indicates that the agent plug-in tries to create a run control ID if the run control ID specified in the job definition does not exist.

Default: false

ps.reportRepositoryPath

Specifies the path to the PeopleSoft report repository directory required when the output destination type value is WEB.

Example: C:\psreports

ps.runIndependent

Do not change this value. This parameter resolves conflicts with retrieving the spool file.

ps.skipOprPswdValidation

Overrides the default agent plug-in behavior of skipping the validation of the operator ID password, as follows:

true

Lets you submit a PeopleSoft process request without a valid password for the corresponding operator ID.

false

Requires you to have a valid password for the corresponding operator ID.

Default: false

ps.unquoteBindVar.Process Type

Sets how the agent plug-in handles quotation marks for bind variables for a specified Process Type, as follows:

custom

Lets you specify the Process Names for the bind variables that should be unquoted.

false

Sets bind variables in quotation marks for a specified Process Type.

true

Does not set bind variables in quotation marks for a specified Process Type. For example, if you specify ps.unquoteBindVar.Informatica, the resolved bind variables are not quoted for the Informatica process type.

Default: false

Process_Type

Specifies the name of the process. If there is a space in the Process Type, use an underscore instead of a space.

Examples: ps.unquoteBindVar.Informatica, ps.unquoteBindVar.Application_Engine

ps.version

Specifies the version of your PeopleTools. The version must be a number.

Example: 8.49 (for PT 8.4.9)

Note: You can determine your version of PeopleTools by pressing CTRL+J while you are on a PIA page in an application.

PS_HOME

Sets the home directory for the PeopleSoft application relative to the PeopleSoft Process Scheduler server.

Example: c:/appl/PeopleSoft/PT8.40