Process Server Parameters

Process Server parameters allow you to set up and customize the behavior of your Process Server and to fine tune it to reach the desired performance vs overhead.

Parameters that do not have default values must be specified. At the moment the only such parameters are the following:

RemoteHostName for UNIX/Windows/HP OpenVMS Process Servers.
Shared Secret for UNIX/Windows/HP OpenVMS Process Servers.

Process Server parameters have two values, a Current value that is being used by the Process Server right now and a Desired value that is the one that will be used after a restart of the Process Server. These will be different if you edit the parameters on a running Process Server but do not restart it. The Desired value reflects this change and makes it clear that a change has been made, but is not yet being used. Before you restart a Process Server in a production environment, it is recommended to check the Desired values of the parameters.

Process Server parameters can be Remote, which means they can be set in configuration files on the remote server.

Process Server parameters are available per Process Server service. Some are compulsory, others optional. The following parameters are grouped by service.

Overriding Process Server Default Values

You can override Process Server parameter default values globally by setting the following registry key:

/configuration/ProcessServerParameters/<name>

Process server parameters allow you to set up and customize the behavior of your process server and to fine tune it to reach the desired performance vs overhead.

Parameters that do not have default values must be specified. At the moment the only such parameters are the following:

RemoteHostName for UNIX/Windows/HP OpenVMS process servers.
Shared Secret for UNIX/Windows/HP OpenVMS process servers.

Process server parameters have two values, a Current value that is being used by the process server right now and a Desired value that is the one that will be used after a restart of the process server. These will be different if you edit the parameters on a running process server but do not restart it. The Desired value reflects this change and makes it clear that a change has been made, but is not yet being used. Before you restart a process server in a production environment, it is recommended to check the Desired values of the parameters.

Process server parameters can be Remote, which means they can be set in configuration files on the remote server.

Process server parameters are available per process server service. Some are compulsory, others optional. The following parameters are grouped by service.

Overriding Process Server Default Values

You can override process server parameter default values globally by setting the following registry key:

/configuration/ProcessServerParameters/<name>

The <name> is the name of the process server parameter. Note that this registry key only affects default values; if you add the process server parameter to the process server with a value, then that value will have precedence over the value of this registry key. Only the scheduler-isolation-administrator can create/edit these registry keys.

Variables

The following variables are used in process server parameters.

Name	Description
ALL	Magic parameter to allow all variable substitutions; see AbstractParameterDefinition
Command	Command to run.
DataRootDirectory	Data root directory.
DateTime	Date and time.
Filename	Filename to check.
FileSeparator	Local file separator (eg. / on UNIX, \ on Microsoft Windows). The value of the java.io.File.separator constant.
FormatExtension	Format extension.
HostName	Name of the host the OS agent is running on.
InstallDirectory	OS agent install directory.
JobApplication	Job application.
JobApplicationPartition	Job application partition.
JobDefinition	Job definition name.
JobDefinitionOwner	Job definition owner.
JobDefinitionPartition	Job definition partition.
JobFileName	Job file short name.
JobFileOrder	Job file order.
JobId	Job ID of the job.
JobOwner	Job owner.
ProcessId	Operating system process identification number of a process.
ProcessName	Type of platform agent process (network-processor, job-processor).
ProcessServer	Process Server name.
ProcessServerPartition	Process server partition.
ProcessType	Type of platform agent process (standalone, service, ...).
Queue	Queue name.
QueuePartition	Queue partition.
SystemId	System ID of the server.
Timestamp	Timestamp
TraceDirectory	Trace directory for system log files.
User	User name to change to.

AS400 Service

AS400 service runs remote AS/400 jobs.

The only required parameter is AS400Server if the Run As User field of every AS/400 job definition is filled and you do not use file events.

Redwood recommends to set the parameter AS400User in case you forget to fill the Run As User field.

AS/400 process servers can have the following parameters:

Process Server Parameter Description

The following three tables describe each parameter. The first table describes the parameters, the second and third table contain all variables, default values, the datatype as well as valid ranges of values for each parameter, where applicable and available.

Name	Description
AS400JobAppend	Default job control options (appended to the end of the SBMJOB command). This parameter controls how the output is written to the output file. Set the value to true if you want the output to be appended to the output file; if you set this to false, the output file will be overwritten. Remote: false
AS400JobConnectionRetry	Maximum number of retries when we catch an unexpected connection failure. Remote: false
AS400JobExitedOkExceptions	Exceptions treated as OK (separated by commas). Remote: false
AS400JobFailOnActiveStatus	States to deliberately fail on (separated by commas). Remote: false
AS400JobIgnoredExceptions	AS/400 exceptions to be ignored (separated by commas). Remote: false
AS400JobIndependentQPJOBLOG	Retrieve QPJOBLOG independently of output queue settings? Remote: false
AS400JobLanguage	Language used in the AS/400 system (en, de, nl, fr). Remote: false
AS400JobLogLevel	Default log level for the stdlog file. Remote: false
AS400JobMaxWait	Deprecated( New monitor functionality introduced): Maximum time to wait for the job to complete (seconds). Remote: false
AS400JobOperatorMessageReply	Allow operators to reply to AS/400 messages from the corresponding operator message. Remote: false
AS400JobOperatorTrace	Full operator trace output? Remote: false
AS400JobOutputFileRetrieval	Retrieve output files from AS400 jobs? Remote: false
AS400JobParseLogNotes	Parse messages in the log file into job notes. Remote: false
AS400JobSecondaryQueueList	List of IFS paths of output queues to check for output files. Remote: false
AS400JobSpoolBanner	Default banner prefixed to the spool. Parameter substitutions use @{name}. You can use \t and \n for tabs and new lines. Remote: false
AS400JobSpoolMaxSize	Spool files larger than this will not be retrieved (bytes). Remote: false
AS400JobSpoolMFRTYPMDL	Default Printer for Spooling Output (Manufacturer, Type, and Model). Remote: false
AS400JobSpoolRemoveControlCharacters	Remove control characters from job spools? Remote: false
AS400JobSpoolWSCST	Default workstation if the MFRTYPMDL is set to *WSCST (default). May be explicitly set to null to be ignored. Remote: false
AS400JobTerminalStates	States that signal the end of the job (separated by commas). Remote: false
AS400JobUseQueueCriteria	Include the output queue in the criteria when searching for output files. Remote: false
AS400JobUseTimeCriteria	Include the job start and end times in the criteria when searching for output files. Remote: false
AS400MessageInterval	Time delay between messages related to the same message. Remote: false
AS400Server	Remote host on which the AS/400 job will run. Remote: false
AS400User	User under which the AS/400 job will run. Remote: false
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
DefaultRunAsUser	User that the process will run as if no other user is specified. Remote: false
EndPoint	Identification of the system where the process runs. If this is set any credentials will be looked up using this as the end point, not the Remote Hostname. For most services this indicates where the job will run, and indicates a server name or such as well as the lookup for credentials. For the PlatformAgentService this only defines a domain used to look up credentials, and this can be set to (for instance) a domain name or other group of servers sharing the same credentials. Remote: true
JobOutputFileNameSuffix	Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
JobSyncPollIntervalBusyDecrease	Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false
JobSyncPollIntervalIdleIncrease	Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false
JobSyncPollIntervalMax	Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false
JobSyncPollIntervalMin	Minimum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false

Process Server Parameter Usage

The following tables provide all variables, default values, the data type as well as valid ranges of values for each parameter, where applicable and available. A description of each parameter is provided in the previous table.

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
AS400JobAppend
AS400JobConnectionRetry
AS400JobExitedOkExceptions
AS400JobFailOnActiveStatus
AS400JobIgnoredExceptions
AS400JobIndependentQPJOBLOG
AS400JobLanguage
AS400JobLogLevel
AS400JobMaxWait
AS400JobOperatorMessageReply
AS400JobOperatorTrace
AS400JobOutputFileRetrieval
AS400JobParseLogNotes
AS400JobSecondaryQueueList
AS400JobSpoolBanner
AS400JobSpoolMaxSize
AS400JobSpoolMFRTYPMDL
AS400JobSpoolRemoveControlCharacters
AS400JobSpoolWSCST
AS400JobTerminalStates
AS400JobUseQueueCriteria
AS400JobUseTimeCriteria
AS400MessageInterval
AS400Server
AS400User
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
DefaultRunAsUser
EndPoint
JobOutputFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}
JobSyncPollIntervalBusyDecrease
JobSyncPollIntervalIdleIncrease
JobSyncPollIntervalMax
JobSyncPollIntervalMin

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
AS400JobAppend		String
AS400JobConnectionRetry	5	Integer
AS400JobExitedOkExceptions	CPF3C53,CPF3C52	String
AS400JobFailOnActiveStatus		String
AS400JobIgnoredExceptions	CPF3C54	String
AS400JobIndependentQPJOBLOG	true	Boolean
AS400JobLanguage	en	String
AS400JobLogLevel	debug	String
AS400JobMaxWait	259200	Integer
AS400JobOperatorMessageReply	true	Boolean
AS400JobOperatorTrace	false	Boolean
AS400JobOutputFileRetrieval	true	Boolean
AS400JobParseLogNotes	false	Boolean
AS400JobSecondaryQueueList	null	String
AS400JobSpoolBanner	-- Spool @{spool} @{number} --\n	String
AS400JobSpoolMaxSize	1000000	Integer
AS400JobSpoolMFRTYPMDL	*WSCST	String
AS400JobSpoolRemoveControlCharacters	true	Boolean
AS400JobSpoolWSCST	/QSYS.LIB/QWPDEFAULT.WSCST	String
AS400JobTerminalStates	*OUTQ	String
AS400JobUseQueueCriteria	false	Boolean
AS400JobUseTimeCriteria	false	Boolean
AS400MessageInterval	300000	Integer
AS400Server		String
AS400User		String
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
DefaultRunAsUser		String
EndPoint		String
JobOutputFileNameSuffix	lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
JobSyncPollIntervalBusyDecrease	120	Integer	0 -
JobSyncPollIntervalIdleIncrease	5	Integer	5 -
JobSyncPollIntervalMax	120	Integer	10 -
JobSyncPollIntervalMin	10	Integer	10 -

OraApps Service

OraApps service runs remote Oracle Application jobs.

Process Server Parameter Description

Name	Description
JobDescriptionPolicy	Policy used for the service when automatically changing the descriptions of jobs. Possible options are: All, StandardOnly, None. The value All is the default, automatic job description change is active for all job definitions. The value StandardOnly restricts the job description change only to built-in job definitions (job definitions with System_ prefix). The value None disables job description changes. Remote: false
JobHistory	Number of days in the past considered by the process synchronization component of the connector service when it performs the initial synchronization on start-up Remote: false
JobSyncPollIntervalBusyDecrease	Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false
JobSyncPollIntervalIdleIncrease	Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false
JobSyncPollIntervalMax	Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false
JobSyncPollIntervalMin	Minimum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false
MaxNumberOfConnections	Sets the maximum number of connection instances the connector cache can hold. The default value is 100. If you put this value to zero that will mean that there is no limit enforced by the connection cache, so that the number of connections is limited only by the number of database sessions configured for the database. Note: If the number of concurrent connections exceeds the maximum number of sessions configured at the database server, then you will get ORA-00018 error. To avoid this error, you must set a value for the MaxNumberOfConnections property. This value should be less than the value of the SESSIONS parameter configured for the database server. Remote: false
MaxReconnectTime	Maximum length of time (in minutes) that the Connectors attempts to reconnect to an external system. If the connection cannot be reestablished within this time period, the corresponding process server is shut down. Remote: false
OraApps_LinkLogFile	Get(HTTP) or Link(via the Platform Agent) the Oracle Applications Logfile. Remote: false
OraApps_LinkOutputFile	Get(HTTP) or Link(via the Platform Agent) the Oracle Applications Outputfile. Remote: false
OraApps_SessionControlledApplications	Oracle EBS Applications that uses extra security by using FND_SESSION Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
JobDescriptionPolicy
JobHistory
JobSyncPollIntervalBusyDecrease
JobSyncPollIntervalIdleIncrease
JobSyncPollIntervalMax
JobSyncPollIntervalMin
MaxNumberOfConnections
MaxReconnectTime
OraApps_LinkLogFile
OraApps_LinkOutputFile
OraApps_SessionControlledApplications

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
JobDescriptionPolicy	All	String
JobHistory	1	Integer	1 -
JobSyncPollIntervalBusyDecrease	120	Integer	0 -
JobSyncPollIntervalIdleIncrease	5	Integer	5 -
JobSyncPollIntervalMax	120	Integer	10 -
JobSyncPollIntervalMin	10	Integer	10 -
MaxNumberOfConnections	100	Integer	5 -
MaxReconnectTime	0	Integer	0 -
OraApps_LinkLogFile	true	Boolean
OraApps_LinkOutputFile	true	Boolean
OraApps_SessionControlledApplications	PER, PAY	String

Oracle Health Insurance Service

Oracle Health Insurance service runs OHI Jobs.

Process Server Parameter Description

Name	Description
ChildStatusCodes	Which child processes should be shown? Child processes with the specified status codes will be shown in the scheduler. Child Processes with a status code not in this list will not be shown. The codes that can be specified are the statuscodes as used in OHI; K, B, F, M, V, W, S, L, and E. If no child processes should be shown, then use the code N. Remote: false
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
JobDescriptionPolicy	Policy used for the service when automatically changing the descriptions of jobs. Possible options are: All, StandardOnly, None. The value All is the default, automatic job description change is active for all job definitions. The value StandardOnly restricts the job description change only to built-in job definitions (job definitions with System_ prefix). The value None disables job description changes. Remote: false
JobHistory	Number of days in the past considered by the process synchronization component of the connector service when it performs the initial synchronization on start-up Remote: false
JobSyncPollIntervalBusyDecrease	Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false
JobSyncPollIntervalIdleIncrease	Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false
JobSyncPollIntervalMax	Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false
JobSyncPollIntervalMin	Minimum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false
MaxNumberOfConnections	Sets the maximum number of connection instances the connector cache can hold. The default value is 100. If you put this value to zero that will mean that there is no limit enforced by the connection cache, so that the number of connections is limited only by the number of database sessions configured for the database. Note: If the number of concurrent connections exceeds the maximum number of sessions configured at the database server, then you will get ORA-00018 error. To avoid this error, you must set a value for the MaxNumberOfConnections property. This value should be less than the value of the SESSIONS parameter configured for the database server. Remote: false
MaxReconnectTime	Maximum length of time (in minutes) that the Connectors attempts to reconnect to an external system. If the connection cannot be reestablished within this time period, the corresponding process server is shut down. Remote: false
MessageInterval	Number of seconds before an agent will respond that there are no messages to be retrieved. Remote: true
RemoteHostName	Remote host on which the processes need to be executed. Remote: false
RemotePort	The TCP port on which the agent on the remote host is listening. Remote: false
SecureConnection	Do you want HTTPS to be used as the connection protocol instead of HTTP? If you set this to true, make sure the agent has an X509 certificate and key, and has the appropriate extra security library installed. Remote: false
TransferLogFile	Transfer the Logfile from the external system to the scheduler. Remote: false
TransferOutputFile	Transfer the Outputfile(s) from the external system to the scheduler. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
ChildStatusCodes
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
JobDescriptionPolicy
JobHistory
JobSyncPollIntervalBusyDecrease
JobSyncPollIntervalIdleIncrease
JobSyncPollIntervalMax
JobSyncPollIntervalMin
MaxNumberOfConnections
MaxReconnectTime
MessageInterval
RemoteHostName
RemotePort
SecureConnection
TransferLogFile
TransferOutputFile

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
ChildStatusCodes	BEFMKVWSL	String
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
JobDescriptionPolicy	All	String
JobHistory	1	Integer	1 -
JobSyncPollIntervalBusyDecrease	120	Integer	0 -
JobSyncPollIntervalIdleIncrease	5	Integer	5 -
JobSyncPollIntervalMax	120	Integer	10 -
JobSyncPollIntervalMin	10	Integer	10 -
MaxNumberOfConnections	100	Integer	5 -
MaxReconnectTime	0	Integer	0 -
MessageInterval	60	Integer	5 - 900
RemoteHostName		String
RemotePort	1555	Integer	0 - 65535
SecureConnection	false	Boolean
TransferLogFile	true	Boolean
TransferOutputFile	true	Boolean

PeopleSoft Service

PeopleSoft service runs PeopleSoft jobs.

Process Server Parameter Description

Name	Description
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
JobDescriptionPolicy	Policy used for the service when automatically changing the descriptions of jobs. Possible options are: All, StandardOnly, None. The value All is the default, automatic job description change is active for all job definitions. The value StandardOnly restricts the job description change only to built-in job definitions (job definitions with System_ prefix). The value None disables job description changes. Remote: false
JobHistory	Number of days in the past considered by the process synchronization component of the connector service when it performs the initial synchronization on start-up Remote: false
JobSpoolMaxSize	Spool files larger than this will not be retrieved (bytes). Remote: false
JobSyncPollIntervalBusyDecrease	Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false
JobSyncPollIntervalIdleIncrease	Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false
JobSyncPollIntervalMax	Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false
JobSyncPollIntervalMin	Minimum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false
MaxCheckJobTime	Maximum time (in minutes) that the Connectors attempts to check job statuses from an external system, if the status check fails. After this time the job status will be set to Unknown. Remote: false
PeopleSoft_DistributionStatus	Should we use the distribution status to map PeopleSoft statuses to our status. Remote: false
PeopleSoft_WSDLRequests	Which WSDL requests are needed to run PeopleSoft connection. The default wsdl's needed to run are EODI_SYSTEM.1.wsdl and PROCESSREQUEST.1.wsdl The version number is optional, if the version is not filled the wsdl request will take the default version number 1 The suffix is also optional, if this one is not filled the word 'wsdl' is default attached. Remote: false
TransferOutputFile	Transfer the Outputfile(s) from the external system to the scheduler. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
JobDescriptionPolicy
JobHistory
JobSpoolMaxSize
JobSyncPollIntervalBusyDecrease
JobSyncPollIntervalIdleIncrease
JobSyncPollIntervalMax
JobSyncPollIntervalMin
MaxCheckJobTime
PeopleSoft_DistributionStatus
PeopleSoft_WSDLRequests
TransferOutputFile

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
JobDescriptionPolicy	All	String
JobHistory	1	Integer	1 -
JobSpoolMaxSize	-1	Integer
JobSyncPollIntervalBusyDecrease	120	Integer	0 -
JobSyncPollIntervalIdleIncrease	5	Integer	5 -
JobSyncPollIntervalMax	120	Integer	10 -
JobSyncPollIntervalMin	10	Integer	10 -
MaxCheckJobTime	60	Integer	0 -
PeopleSoft_DistributionStatus	true	Boolean
PeopleSoft_WSDLRequests	EODI_SYSTEM, PROCESSREQUEST	String
TransferOutputFile	true	Boolean

SAPBObj Service

SAPBObj service runs remote Business Objects jobs.

Process Server Parameter Description

Name	Description
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
JobLogFileNameFormat	Default for process log file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<jobid> will be appended to the directory name, where <n> is the integer of <jobid>/10000. For example: JobLogFileNameFormat is set to /var/redwood/joblog/${JobFileOrder}-${JobFileName} and jobId is 210955, the log file will be written to /var/redwood/joblog/210000-219999/210955/1-stderr.log. Remote: false
JobLogFileNameSuffix	Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
JobOutputFileNameFormat	Default for output file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<id> will be appended to the directory name, where <n> is the integer of <id>/10000. For example: JobOutputFileNameFormat is set to /var/redwood/jobout/${JobFileOrder}-${JobFileName} and Id is 210955, the log file will be written to /var/redwood/jobout/210000-219999/210955/2-stdout.log Remote: false
JobOutputFileNameSuffix	Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
SAP_JobDescriptionPolicy	Policy used for the SAP service when automatically changing the descriptions of jobs. Possible options are: All, StandardOnly, None. The value All is the default, automatic job description change is active for all job definitions. The value StandardOnly restricts the job description change only to built-in job definitions (job definitions with SAP_ prefix). The value None disables job description changes. Remote: false
SAP_JobMonitorPollInterval	Minimum poll interval in seconds for the job monitoring component of the SAP/BOBJ service. This component regularly checks the SAP/BOBJ jobs assigned to the scheduler and updates their status. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
JobLogFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobLogFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${FormatExtension}
JobOutputFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobOutputFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}
SAP_JobDescriptionPolicy
SAP_JobMonitorPollInterval

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
JobLogFileNameFormat		String
JobLogFileNameSuffix	log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
JobOutputFileNameFormat		String
JobOutputFileNameSuffix	lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
SAP_JobDescriptionPolicy	All	String
SAP_JobMonitorPollInterval	10	Integer	1 -

SAPPI Service

SAPPI service runs remote SAP PI jobs.

Process Server Parameter Description

Name	Description
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
JobLogFileNameFormat	Default for process log file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<jobid> will be appended to the directory name, where <n> is the integer of <jobid>/10000. For example: JobLogFileNameFormat is set to /var/redwood/joblog/${JobFileOrder}-${JobFileName} and jobId is 210955, the log file will be written to /var/redwood/joblog/210000-219999/210955/1-stderr.log. Remote: false
JobLogFileNameSuffix	Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
JobOutputFileNameFormat	Default for output file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<id> will be appended to the directory name, where <n> is the integer of <id>/10000. For example: JobOutputFileNameFormat is set to /var/redwood/jobout/${JobFileOrder}-${JobFileName} and Id is 210955, the log file will be written to /var/redwood/jobout/210000-219999/210955/2-stdout.log Remote: false
JobOutputFileNameSuffix	Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
JobLogFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobLogFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${FormatExtension}
JobOutputFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobOutputFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
JobLogFileNameFormat		String
JobLogFileNameSuffix	log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
JobOutputFileNameFormat		String
JobOutputFileNameSuffix	lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String

SAPR3 Service

SAPR3 service runs and interfaces jobs using XBP, and handles XAL, XMW and BC-SCH.

The default values are acceptable for most SAP Systems, These values should only be changed on very large systems and only then when advised to do so by customer support. Enhanced job scheduling functions as defined in the SAP note #1020092; parameters requiring these features have no effect on SAP Systems that do not comply with the prerequisites of this SAP note.

Process Server Parameter Description

Name	Description
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
JobLogFileNameFormat	Default for process log file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<jobid> will be appended to the directory name, where <n> is the integer of <jobid>/10000. For example: JobLogFileNameFormat is set to /var/redwood/joblog/${JobFileOrder}-${JobFileName} and jobId is 210955, the log file will be written to /var/redwood/joblog/210000-219999/210955/1-stderr.log. Remote: false
JobLogFileNameSuffix	Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
JobOutputFileNameFormat	Default for output file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<id> will be appended to the directory name, where <n> is the integer of <id>/10000. For example: JobOutputFileNameFormat is set to /var/redwood/jobout/${JobFileOrder}-${JobFileName} and Id is 210955, the log file will be written to /var/redwood/jobout/210000-219999/210955/2-stdout.log Remote: false
JobOutputFileNameSuffix	Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
SAP_AlertReadPollIntervalBusyDecrease	Decrease number of seconds for the poll interval of the XAL component of the SAP service if the SAP CCMS monitoring data has been changed. Remote: false
SAP_AlertReadPollIntervalIdleIncrease	Increase number of seconds for the poll interval of the XAL component of the SAP service if the SAP CCMS monitoring data has not been changed. Remote: false
SAP_AlertReadPollIntervalMax	Maximum number of seconds for the poll interval of the XAL CCMS alerts synchronizer component of the SAP service. Remote: false
SAP_AlertReadPollIntervalMin	Minimum number of seconds for the poll interval of the XAL CCMS alerts synchronizer component of the SAP service. Remote: false
SAP_AlertWriteForceSendInterval	Interval at which the XMW component of the SAP service will send the monitoring data to SAP CCMS, even if no changes were made to that data. Remote: false
SAP_AlertWritePollIntervalBusyDecrease	Decrease number of seconds for the poll interval of the XMW component of the SAP service if the monitoring data has been changed. Remote: false
SAP_AlertWritePollIntervalIdleIncrease	Increase number of seconds for the poll interval of the XMW component of the SAP service if the monitoring data has not been changed. Remote: false
SAP_AlertWritePollIntervalMax	Maximum number of seconds for the poll interval of the XMW component of the SAP service. Remote: false
SAP_AlertWritePollIntervalMin	Minimum number of seconds for the poll interval of the XMW component of the SAP service. Remote: false
SAP_DefaultJobPriority	Default job priority for jobs created by the XBP job synchronizer component of the SAP service. Remote: false
SAP_DisableDefaultPrintFeature	Set to true to disable the default print feature, such as sending a $ sign for empty parameters, as described in SAP Note 609462. Remote: false
SAP_EnableRoundTripOptimization	Reduction in round trips. If set to true, the JCo repository tries to use the function module for round trip optimization for meta data lookups. (Default is true). Remote: false
SAP_EventSyncPollInterval	Poll interval in seconds for the event synchronizer component of the SAP service. This component synchronizes SAP batch events with scheduler events when running alongside an SAP system that supports enhanced job scheduling functions, as defined in SAP Note 1020092. This parameter has no effect in SAP systems that do not meet the prerequisites of this SAP Note. Remote: false
SAP_EventSyncWindow	How far back in time (in seconds) the event synchronizer component of the SAP service checks for event synchronization when it is activated. This component synchronizes SAP batch events with scheduler events when running alongside an SAP system that supports enhanced job scheduling functions, as defined in SAP Note 1020092. This parameter has no effect in SAP systems that do not meet the prerequisites of this SAP Note. Remote: false
SAP_FullJobSynchronizationMode	Enables the full synchronization mode in which all jobs and all child jobs are synchronized even if they are marked as confirmed by another scheduler. Jobs are not confirmed. Enabling this slows down synchronization of jobs. This parameter should not be set on production systems and allows you to connect multiple schedulers to an SAP system, regardless of the brand and version. Remote: false
SAP_IgnoreApplicationReturnCode	If set to true, the application return code will NOT be set on the job in the scheduler. Remote: false
SAP_JobConfirmBlockSize	Number of jobs confirmed simultaneously by the XBP job synchronizer component of the SAP service when running on an SAP system that supports XBP 2.0. This parameter has no effect in XBP versions prior to 2.0. Remote: false
SAP_JobDescriptionPolicy	Policy used for the SAP service when automatically changing the descriptions of jobs. Possible options are: All, StandardOnly, None. The value All is the default, automatic job description change is active for all job definitions. The value StandardOnly restricts the job description change only to built-in job definitions (job definitions with SAP_ prefix). The value None disables job description changes. Remote: false
SAP_JobHistory	Number of days in the past considered by the XBP job synchronization component of the SAP service when it performs the initial synchronization on start-up. Remote: false
SAP_JobMonitorBlockSize	Number of jobs checked for updates by the job monitoring component of the SAP service when running on an SAP system that supports XBP 2.0. This parameter has no effect in XBP versions prior to 2.0. Set to 0 to deactivate the checks for updates. Remote: false
SAP_JobMonitorNumberOfWorkers	Number of workers used by the job monitoring component of the SAP service. Remote: false
SAP_JobMonitorPollInterval	Minimum poll interval in seconds for the job monitoring component of the SAP/BOBJ service. This component regularly checks the SAP/BOBJ jobs assigned to the scheduler and updates their status. Remote: false
SAP_JobMonitorPollIntervalDecrease	Decrease poll interval in seconds for the job monitoring component of the SAP service. Remote: false
SAP_JobMonitorPollIntervalIncrease	Increase poll interval in seconds for the job monitoring component of the SAP service. Remote: false
SAP_JobMonitorPollIntervalMax	Maximum poll interval in seconds for the job monitoring component of the SAP service. Remote: false
SAP_JobSyncBlockSize	Number of jobs retrieved simultaneously by the XBP job synchronizer component of the SAP service when running alongside an SAP system that supports enhanced job scheduling functions, as defined in SAP Note 1020092. This parameter has no effect in SAP systems that do not meet the prerequisites of this SAP Note. The greater the number, the more jobs are retrieved together, reducing the synchronization load. However, if the number of jobs to be retrieved is too high, the RFC function call may fail, depending on the configuration of the SAP system and the available resources. Remote: false
SAP_JobSyncPollIntervalBusyDecrease	Decrease number of seconds for the poll interval of the XBP job synchronizer component of the SAP service when the SAP system is busy. Remote: false
SAP_JobSyncPollIntervalIdleIncrease	Increase number of seconds for the poll interval of the XBP job synchronizer component of the SAP service when the SAP system is idle. Remote: false
SAP_JobSyncPollIntervalMax	Maximum number of seconds for the poll interval of the XBP job synchronizer component of the SAP service. Remote: false
SAP_JobSyncPollIntervalMin	Minimum number of seconds for the poll interval of the XBP job synchronizer component of the SAP service. Remote: false
SAP_LastJobSync	Time stamp of the last synchronization cycle of the XBP job synchronizer component. Remote: false
SAP_MaxLogSize	Maximum size of the job log file that is passed from SAP (in bytes). The SAP service does not retrieve job logs that are larger than the value of this parameter. Remote: false
SAP_MaxReconnectTime	Maximum length of time (in minutes) that the SAP service attempts to reconnect to an SAP system. If the connection cannot be reestablished within this time period, the corresponding process server is shut down. Remote: false
SAP_MaxSpoolSize	Maximum size of the job spool files that are passed from SAP (in bytes). Spool files that are greater than the value of this parameter are not retrieved by the SAP service. A value of 0 disables the check and all spool files are retrieved regardless of their size. A value of -1 disables spoolfile retrieval. The value of this parameter only has effect on jobs for which spool retrieval has been requested. This parameter is used in conjunction with the settings on the Job Control Rules tab of SAP system definitions. If you enable spool file retrieval on the Job Control Rules tab, the value of this process server parameter has precedence. You can overrule the settings on the SAP system for big spool files, for example. Remember that setting this parameter to -1 disables spool file retrieval, regardless of what you configure on the SAP system definition. Remote: false
SAP_ProcessChainRestartPollInterval	Poll interval in seconds for the BI process chains in status Console. Remote: false
SAP_ProcessChainWaitForEndStatus	Determines whether SAP BI process chains are to wait for batch jobs with status "Scheduled" in the BI system to be completed, even if the corresponding process of the chain already has status "Error". Remote: false
SAP_Release	SAP kernel / ABAP release. Remote: false
SAP_RFCAbortTimeout	Time after which active RFC connections are considered stale and aborted (in seconds). 0 means no connections are aborted. Remote: false
SAP_RFCIdleTimeout	Time after which idle RFC connections are closed (in seconds). Remote: false
SAP_ShowBIBatchJobs	Defines whether to show the BI Batch jobs. The process of a process chain in SAP could have a CCMS batch job defined to do the real work. If you don't want to see this CCMS batch job as a child job you can switch this off by setting this parameter to false. Remote: false
SAP_ShowBIProcessLogDetails	Defines whether to retrieve the log details of BI processes. If this functionality is enabled, then for every line in the BI process log an RFC-enabled function module is called. Remote: false
SAP_SID	SID. Remote: false
SAP_SpoolListRetrievalRetryInterval	When a platform agent is supposed to do ABAP spool list retrieval it may be down or not be able to retrieve the files. This regulates how often the SAP process server will retry the operation. Set this to -1 to disable retries all together or 0 so that it will only be retried when the process server is started. Remote: false
SAP_UppercaseRfcPassword	Whether to uppercase the password before opening an RFC connection. Remote: false
SAP_UseShortSpoolTableRows	Defines whether to use short table rows when retrieving spool lists. This enables the SAP service to retrieve larger spool lists, but may truncate long spool lines. Only use this parameter if the SAP service is connected to an SAP system using XBP 2.0. Changes to this parameter are effective immediately. Remote: false
SAP_UseTransports	Determines whether the functions provided with the transport files from Redwood should be used. Remote: false
SAP_XbpVersion	XBP Version. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
JobLogFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobLogFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${FormatExtension}
JobOutputFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobOutputFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}
SAP_AlertReadPollIntervalBusyDecrease
SAP_AlertReadPollIntervalIdleIncrease
SAP_AlertReadPollIntervalMax
SAP_AlertReadPollIntervalMin
SAP_AlertWriteForceSendInterval
SAP_AlertWritePollIntervalBusyDecrease
SAP_AlertWritePollIntervalIdleIncrease
SAP_AlertWritePollIntervalMax
SAP_AlertWritePollIntervalMin
SAP_DefaultJobPriority
SAP_DisableDefaultPrintFeature
SAP_EnableRoundTripOptimization
SAP_EventSyncPollInterval
SAP_EventSyncWindow
SAP_FullJobSynchronizationMode
SAP_IgnoreApplicationReturnCode
SAP_JobConfirmBlockSize
SAP_JobDescriptionPolicy
SAP_JobHistory
SAP_JobMonitorBlockSize
SAP_JobMonitorNumberOfWorkers
SAP_JobMonitorPollInterval
SAP_JobMonitorPollIntervalDecrease
SAP_JobMonitorPollIntervalIncrease
SAP_JobMonitorPollIntervalMax
SAP_JobSyncBlockSize
SAP_JobSyncPollIntervalBusyDecrease
SAP_JobSyncPollIntervalIdleIncrease
SAP_JobSyncPollIntervalMax
SAP_JobSyncPollIntervalMin
SAP_LastJobSync
SAP_MaxLogSize
SAP_MaxReconnectTime
SAP_MaxSpoolSize
SAP_ProcessChainRestartPollInterval
SAP_ProcessChainWaitForEndStatus
SAP_Release
SAP_RFCAbortTimeout
SAP_RFCIdleTimeout
SAP_ShowBIBatchJobs
SAP_ShowBIProcessLogDetails
SAP_SID
SAP_SpoolListRetrievalRetryInterval
SAP_UppercaseRfcPassword
SAP_UseShortSpoolTableRows
SAP_UseTransports
SAP_XbpVersion

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
JobLogFileNameFormat		String
JobLogFileNameSuffix	log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
JobOutputFileNameFormat		String
JobOutputFileNameSuffix	lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
SAP_AlertReadPollIntervalBusyDecrease	120	Integer	0 -
SAP_AlertReadPollIntervalIdleIncrease	5	Integer	0 -
SAP_AlertReadPollIntervalMax	120	Integer	10 -
SAP_AlertReadPollIntervalMin	10	Integer	10 -
SAP_AlertWriteForceSendInterval	300	Integer	60 -
SAP_AlertWritePollIntervalBusyDecrease	120	Integer	0 -
SAP_AlertWritePollIntervalIdleIncrease	5	Integer	0 -
SAP_AlertWritePollIntervalMax	120	Integer	10 -
SAP_AlertWritePollIntervalMin	10	Integer	10 -
SAP_DefaultJobPriority	50	Integer	1 - 100
SAP_DisableDefaultPrintFeature	false	Boolean
SAP_EnableRoundTripOptimization	true	Boolean
SAP_EventSyncPollInterval	10	Integer	1 -
SAP_EventSyncWindow	600	Integer	0 -
SAP_FullJobSynchronizationMode	false	Boolean
SAP_IgnoreApplicationReturnCode	false	Boolean
SAP_JobConfirmBlockSize	25	Integer	1 -
SAP_JobDescriptionPolicy	All	String
SAP_JobHistory	1	Integer	1 -
SAP_JobMonitorBlockSize	25	Integer	0 -
SAP_JobMonitorNumberOfWorkers	10	Integer	1 -
SAP_JobMonitorPollInterval	10	Integer	1 -
SAP_JobMonitorPollIntervalDecrease	300	Integer	1 -
SAP_JobMonitorPollIntervalIncrease	10	Integer	1 -
SAP_JobMonitorPollIntervalMax	300	Integer	1 -
SAP_JobSyncBlockSize	5000	Integer	1 -
SAP_JobSyncPollIntervalBusyDecrease	120	Integer	0 -
SAP_JobSyncPollIntervalIdleIncrease	5	Integer	5 -
SAP_JobSyncPollIntervalMax	120	Integer	10 -
SAP_JobSyncPollIntervalMin	10	Integer	10 -
SAP_LastJobSync		Integer
SAP_MaxLogSize	1048576	Integer	-1 -
SAP_MaxReconnectTime	0	Integer	0 -
SAP_MaxSpoolSize	1048576	Integer	-1 -
SAP_ProcessChainRestartPollInterval	60	Integer	10 -
SAP_ProcessChainWaitForEndStatus	true	Boolean
SAP_Release		String
SAP_RFCAbortTimeout	0	Integer	0 -
SAP_RFCIdleTimeout	300	Integer	0 -
SAP_ShowBIBatchJobs	true	Boolean
SAP_ShowBIProcessLogDetails	true	Boolean
SAP_SID		String
SAP_SpoolListRetrievalRetryInterval	3600	Integer	-1 - 86400
SAP_UppercaseRfcPassword	false	Boolean
SAP_UseShortSpoolTableRows	false	Boolean
SAP_UseTransports	true	Boolean
SAP_XbpVersion		String

CustomJob Service

CustomJob service runs Custom jobs.

Process Server Parameter Description

Name	Description
JobSyncPollIntervalBusyDecrease	Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false
JobSyncPollIntervalIdleIncrease	Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false
JobSyncPollIntervalMax	Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false
JobSyncPollIntervalMin	Minimum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
JobSyncPollIntervalBusyDecrease
JobSyncPollIntervalIdleIncrease
JobSyncPollIntervalMax
JobSyncPollIntervalMin

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
JobSyncPollIntervalBusyDecrease	120	Integer	0 -
JobSyncPollIntervalIdleIncrease	5	Integer	5 -
JobSyncPollIntervalMax	120	Integer	10 -
JobSyncPollIntervalMin	10	Integer	10 -

JDBC Service

JDBC service deals with JDBC connections.

Process Server Parameter Description

Name	Description
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
DefaultRunAsUser	User that the process will run as if no other user is specified. Remote: false
JDBCOracleDBMSOutput	Use Oracle DBMS Output? Remote: false
JDBCServer	The alternative process server that is used to enable Queue Jumping. Remote: false
JDBCStatementFeedbackFormat	Format of the SQL statement feedback in JDBC jobs. Possible options are: Simple, Normal or Extended Remote: false
JDBCStatementTimingFormat	Should the duration of SQL statements in JDBC jobs be printed and in milliseconds or in pretty format. Possible options are: None, MilliSeconds, Pretty Remote: false
LegacyModeFeatures	List of strings that can be set to enable legacy behavior of the service. This can be set with the help of customer support to allow older, usually insecure or incorrect, behavior after upgrading to a release that improves that particular behavior of the product. Remote: true
v7PLSQLApiAvailable	Is the Cronacle v6/7 compatible PL/SQL API available in this (Oracle) database. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
DefaultRunAsUser
JDBCOracleDBMSOutput
JDBCServer
JDBCStatementFeedbackFormat
JDBCStatementTimingFormat
LegacyModeFeatures
v7PLSQLApiAvailable

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
DefaultRunAsUser		String
JDBCOracleDBMSOutput	false	Boolean
JDBCServer		String
JDBCStatementFeedbackFormat	Normal	String
JDBCStatementTimingFormat	Pretty	String
LegacyModeFeatures		String
v7PLSQLApiAvailable	false	Boolean

FTP Service

FTP service runs remote FTP jobs.

This service uses no process server parameters.

PlatformAgent Service

PlatformAgent service runs platform jobs and handles file events.

The "DataRootDirectory" directory tree is not only used to store job output, but also as a way to persist data about the status of file events and messages being sent to the server. The agent has its own log directory, where it writes tracing information that can help in the event of problems. If the network goes down the agent cannot write out status information nor log that it is unable to do so. You are also reducing the speed at which jobs can be started and stopped, as a sizable amount of file operations take place for every job.

In other words: if you put this data on a network drive, the (un)reliability of the network becomes a serious issue.

On Microsoft Windows there is an additional complication in that the platform agent runs best as the Local System account (NT Authority\System), because that enables auto-updating of the agent. This account does not have access to network shares. Since version M28 the Microsoft Windows agent will not allow DataRootDirectory to be on a drive that is not marked by the operating system as a local device.

The "SharedSecret" is specified in an encoded format. The platform agent installers create values during the installation process. You should transfer these values into the process server parameter if you do not let the installer register itself as a processor server. To manually create a new secret use the "jregister" utility.

Process Server Parameter Description

Name	Description
AgentInitiated	Is platform agent going to connect to the server, instead of the server connecting to the agent? If this is set to true you need to set the agent configuration file 'agent_initiated_url' to the scheduler URL http[s]://server:port/redwood/ipi-platformagentservice/BusinessKey/[<partition>.]<ps-name> Remote: false
AgentInitiatedURL	URL of the server at which this agent last contacted the server. Remote: false
Agentless	Set to true if you do not want to install an agent to run processes on this system. This precludes non-process running features such as monitoring and file events. Remote: false
AgentStartTimestamp	Agent has been running since this timestamp Remote: false
AlternativeJobContextURL	ServerInitiated mode only. Overrules the default Context URL for jobs using jtools connecting back into the server. Remote: true
BuildBranch	Branch from which this platform agent was built. Remote: false
BuildId	Revision and branch from which the platform agent was built from. Remote: false
BuildRevision	Revision of the branch from which the platform agent was built. Remote: false
BurstWatchDirectory	Specify the Burster watch directory. Remote: true
CharacterSetMapping	Optional mappings from reported character set to desired IANA/Mime style character set. Set this if you have files that have a reported character set that your browser does not understand. The format is <cset>=<mime-type> [;...] Remote: true
CheckAgentCertificate	Do you want the scheduler's JVM to check the certificate presented by the platform agent? If you set this to true, the JVM truststore must contain the agent's public certificate and the root CA certificate. Remote: false
CheckAgentHostname	Do you want the scheduler's JVM to check the hostname in the certificate presented by the platform agent? If you set this to true, the RemoteHostName used to connect to the platform agent must be the same as that presented in the agent's certificate. Remote: false
CipherSuites	List of cipher suites that is enabled for outgoing traffic to the agent when the connection is encrypted. Remote: false
ConnectErrorBackoff	List of values (in ms, comma separated) that the service should delay for when a connect error occurs, or a list of three values containing the minimum, step and maximum value, separated by semicolons. The first value will be used when the connection request was successful. The last value will be used once the end of the list is reached. Remote: false
ContextURL	External URL of the scheduler UI. Remote: true
CygwinInstallPath	Override the installation path of Cygwin on the Microsoft Windows server. Use when auto-detection fails or when you have multiple installations. Remote: true
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
DefaultRunAsUser	User that the process will run as if no other user is specified. Remote: false
EncryptionAlgorithm	Which algorithm is used to encrypt network data between the platform agent and the scheduler server. Remote: false
EndPoint	Identification of the system where the process runs. If this is set any credentials will be looked up using this as the end point, not the Remote Hostname. For most services this indicates where the job will run, and indicates a server name or such as well as the lookup for credentials. For the PlatformAgentService this only defines a domain used to look up credentials, and this can be set to (for instance) a domain name or other group of servers sharing the same credentials. Remote: true
EnvironmentFile	Extra environment variables for the processes are loaded from this file, in the format <name>=<value> [;\|\n]... with UNIX quoting rules (use " to store spaces, commas and newlines, \ escapes the next character). Remote: true
EnvironmentVariables	Extra environment variables for the processes in format <name>=<value> [;]... with UNIX quoting rules (use " to store spaces, semi-colons and newlines, \ escapes the next character). Remote: true
ExecutableDirectory	Directory that the binaries used for the platform agent are installed in. Remote: false
FailoverURL	URL of the server that will be contacted by the agent when the main AgentInitiatedURL server is no longer reachable or refuses communication. Remote: true
FileEventCredentials	Use the given credentials for file detection and file moves (for file events). Applies to Microsoft Windows only. Remote: true
FileInUseCommand	Command to be used to check if a file is in use, on UNIX only. Remote: true
FileProtectionMask	File protection mask (umask), on UNIX only. Value in traditional unix octal mode, for example 022. Remote: true
FileTransferDirect	Should the files retrieved via jtool getfile be retrieved via a direct connection between the platform agent and jtool? Direct connections save network resources by not transmitting file data through the Java server. Valid values are 'only' (or 'true'), 'fallback' (the default) and 'never' (or 'false'). When set to 'true', 'only' or 'fallback' the server will validate a getfile request and then ask the agent for a valid temporary URL that it then sends to jtool, which will then attempt a direct connection. If this succeeds the data is transferred without going through the central server; this saves resources on the central server and can be much quicker if the process server and jtool client have a faster network connection. Note that clients must be able to access the process server on the URL that is shown in SystemInformation item RemoteURI. Remote: true
InstallDirectory	Directory in which the platform agent network process server is installed. Remote: false
InstanceName	Instance name used by the platform agent. Used to install multiple agents in one installation. Remote: false
InterpreterWhitelist_BASH	Regular expression that matches allowed values of JCS_INTERPRETER_BASH used for processes of the BASH Definition Type. Example: ".*" or "/usr/local/bash,/usr/bin/bash" (without ") Remote: false
InterpreterWhitelist_CMD	Regular expression that matches allowed values of JCS_INTERPRETER_CMD used for processes of the CMD Definition Type. Example: ".*" or "C:\Windows\Sysnative\cmd.exe,C:\Windows\System32\cmd.exe" (without ") Remote: false
InterpreterWhitelist_CSH	Regular expression that matches allowed values of JCS_INTERPRETER_CSH used for processes of the CSH Definition Type. Example: ".*" or "/usr/local/csh,/usr/bin/tcsh" (without ") Remote: false
InterpreterWhitelist_JAVA	Regular expression that matches allowed values of JCS_INTERPRETER_JAVA used for processes of the Java Definition Type. Example: ".*" or "/usr/lib/jvm/java-11/bin/java,/usr/bin/java" (without ") Remote: false
InterpreterWhitelist_KSH	Regular expression that matches allowed values of JCS_INTERPRETER_KSH used for processes of the KSH Definition Type. Example: ".*" or "/usr/local/pdksh,/usr/bin/ksh" (without ") Remote: false
InterpreterWhitelist_PERL	Regular expression that matches allowed values of JCS_INTERPRETER_PERL used for processes of the Perl Definition Type. Example: ".*" or "/usr/local/perl,/usr/bin/perl" (without ") Remote: false
InterpreterWhitelist_PERLUNICODE	Regular expression that matches allowed values of JCS_INTERPRETER_PERLUNICODE used for processes of the Perl (Unicode) Definition Type. Example: ".*" or "/usr/local/perl,/usr/bin/perl" (without ") Remote: false
InterpreterWhitelist_PS1	Regular expression that matches allowed values of JCS_INTERPRETER_PS1 used for processes of the PS1 Definition Type. Example: ".*" or "C:\Windows\Sysnative\WindowsPowershell\v1.0\powershell.exe,C:\Windows\System32\WindowsPowershell\v1.0\powershell.exe" (without ") Remote: false
InterpreterWhitelist_PYTHON	Regular expression that matches allowed values of JCS_INTERPRETER_PYTHON used for processes of the Python Definition Type. Example: ".*" or "/usr/local/python,/usr/bin/python" (without ") Remote: false
InterpreterWhitelist_VB_SCRIPT	Regular expression that matches allowed values of JCS_INTERPRETER_VBSCRIPT used for processes of the VB_SCRIPT Definition Type. Example: ".*" or "C:\Windows\Sysnative\cscript.exe,C:\Windows\System32\cscript.exe" (without ") Remote: false
IPForwarderURL	URL of the server that will be forwarding IP connections via this platform agent to the network reachable from the platform agent. Remote: true
JobWorkingDirectory	Directory used by processes as their working (current) directory when the process is started. The default is the directory where any created files will automatically be picked up as files. Remote: true
JobWorkingDirectoryBehaviour	Action to take when the Process Working Directory does not exist This parameter accepts the following values: Create - Try to create, fallback to the default if it cannot. CreateFail - Try to create, fail the job if it does not exist. NoCreateFail - Don't try to create, fail the job if it does not exist. Ignore - Ignore if it does not exist. On HP OpenVMS these values have no effect, default is ignore. Remote: true
KeepAllFiles	Is platform agent to keep all job-processor work files in the Process directory? Remote: true
KeepCrashFiles	Is platform agent to keep intermediate files after a job-processor crash? Remote: true
KeepEmptyFiles	Is platform agent to keep empty output or log files? Remote: true
KeepEnvironmentVariables	UNIX platform agent only. Environment variables that are passed to processes from the platform agent. Comma-separated list of variables with terminating * permitted. Default value is PATH,LANG,LC_*,NATIVEJAVA_CLASSPATH,TZ. The agent binary directory is always prepended to the path. Remote: true
KeepErrorFiles	Is platform agent to keep all job-processor work files when the process ends in error? Remote: true
LegacyModeFeatures	List of strings that can be set to enable legacy behavior of the service. This can be set with the help of customer support to allow older, usually insecure or incorrect, behavior after upgrading to a release that improves that particular behavior of the product. Remote: true
LocalInterpreter_BASH	Override the interpreter used for processes of the BASH Definition Type. Provide the full path to the interpreter, such as /usr/local/bin/bash, for example. Remote: false
LocalInterpreter_CMD	Override the interpreter used for processes of the CMD Definition Type. Provide the full path to the interpreter, such as C:\local\cmd.exe, for example. Remote: false
LocalInterpreter_CSH	Override the interpreter used for processes of the CSH Definition Type. Provide the full path to the interpreter, such as /usr/local/bin/csh, for example. Remote: false
LocalInterpreter_JAVA	Override the interpreter used for processes of the Java Definition Type. Provide the full path to the interpreter, such as /usr/local/jdk17/bin/java, for example. Remote: false
LocalInterpreter_KSH	Override the interpreter used for processes of the KSH Definition Type. Provide the full path to the interpreter, such as /usr/local/bin/ksh, for example. Remote: false
LocalInterpreter_PERL	Override the interpreter used for processes of the Perl Definition Type. Provide the full path to the interpreter, such as /usr/local/bin/perl, for example. Remote: false
LocalInterpreter_PERLUNICODE	Override the interpreter used for processes of the Perl (Unicode) Definition Type. Provide the full path to the interpreter, such as /usr/local/bin/perl, for example. Remote: false
LocalInterpreter_PS1	Override the interpreter used for processes of the PS1 Definition Type. Provide the full path to the interpreter, such as /usr/local/bin/pwsh, for example. Remote: false
LocalInterpreter_PYTHON	Override the interpreter used for processes of the Python Definition Type. Provide the full path to the interpreter, such as /usr/local/bin/python, for example. Remote: false
LocalInterpreter_R	Override the interpreter used for processes of the R Definition Type. Provide the full path to the interpreter, such as /usr/local/bin/r, for example. Remote: false
LocalInterpreter_VB_SCRIPT	Override the interpreter used for processes of the VB_SCRIPT Definition Type. Provide the full path to the interpreter, such as C:\local\cscript.exe, for example. Remote: false
LogFile	Path to file to which the platform agent should log after it has been configured. Remote: true
LogFileRetention	Number of log files to keep before the oldest is deleted. Remote: true
LogFileSize	Maximum size of an individual log file, in megabytes. Remote: true
LogLevel	Logging level for the platform agent after it has been configured. Comma delimited list of [[executable.]<category>=]level values. Remote: true
LogonTimeout	Number of seconds to allow for operating system logon. Logons on some operating systems may take a long time, in particular Microsoft Windows Server domain logons when a Remote Desktop session needs to be created. Remote: true
LowVolume	A low volume process server when set to true. A LowVolume ProcessServer requires a license item that specifies the threshold for the number of jobs the ProcessServer can run per day. Remote: true
MessageInterval	Number of seconds before an agent will respond that there are no messages to be retrieved. Remote: true
MinimalFreeDiskFiles	Number of files that can be created on the file-system used for job files before an agent will run jobs. ProcessServer will go to status Error when the number of possible files goes below this limit. Remote: true
MinimalFreeDiskSpace	Number of megabytes free disk space for job files before an agent will run jobs. ProcessServer will go to status Error when the disk space goes below this limit. Remote: true
MonitorInterval	Interval in seconds for measuring the built-in monitoring data. To switch this off, set the value to 0. Remote: true
NetDirectory	Directory from which the platform agent is configured. Remote: false
OperatingSystem	Operating system information such as version number Remote: false
OSFamily	Operating system family. Remote: false
Platform	Operating system platform and CPU type that the platform agent was built for. Remote: false
ProcessType	Type of process under which platform agent is running. Remote: false
ProtocolExtensions	Protocol extensions supported. Comma separated list of protocol changes that this agent supports. Remote: false
ProxyProcessServers	Names of the process servers that are allowed to proxy processes to the final RemoteHost. Remote: false
ProxyServer	The HTTP proxy that is configured on the platform agent. Remote: false
RedirectJobFiles	Should the files be retrieved directly by the client? If this is set to 'true' or a hostname the server will send a HTTP redirect to the user's browser for interactive file requests. When this process server parameter is set to true or a hostname, clients (browsers) will retrieve the job files residing on this process server directly from the process server without the file be routed through the central server; this is useful when the process server and central server do not reside in the same geographical location or subnet. Note that clients must be able to access the process server on the URL that is shown in SystemInformation item RemoteURI. If the system-derived RemoteURI is not satisfactory you can overrule the hostname by setting it as the value for RedirectJobFiles and the portnumber by setting the value for RemotePort. Remote: true
RemoteHostName	Remote host on which the processes need to be executed. Remote: false
RemoteHostNameWhitelist	In AgentInitiated mode only one remote system can contact this process server. If a failover setup with multiple agents competing for a single server is desired, set this to a comma-separated list of hostnames or IP addresses that is allowed to contact the server. In ServerInitiated mode this can be set to a comma-separated list of hostnames or IP addresses that can be used as alternatives to RemoteHostName. They will be used if resolving or contacting RemoteHostName fails. Remote: false
RemotePort	The TCP port on which the agent on the remote host is listening. Remote: false
RemoteURI	Remote URL, changed depending on agent hostname and SSL settings. The last defined setting is used for retrieving files. Remote: false
SecureConnection	Do you want HTTPS to be used as the connection protocol instead of HTTP? If you set this to true, make sure the agent has an X509 certificate and key, and has the appropriate extra security library installed. Remote: false
SecureGatewayFirewallRules	Firewall rules that apply for forwarded IP connections via this platform agent to the network reachable from the platform agent. Remote: true
SequenceMultiplier	The multiplier used to determine the process-range directories. Set this to a power of ten (10,100,1000 etc) to get more processes per directory. Remote: true
ServerUUID	Server UUID used for authentication between the process server and the remote agent. Remote: true
SharedSecret	Shared secret used for authentication between the process server and the remote agent. This must match the value for the remote agent. Remote: false
SwitchUserCommand	Command used to switch users, on UNIX only. This parameter should only be used when the user switch mode is sudo. In case of plain user switch mode, there is no user switching, in case of root and setuid the user switching is done by the job-processor. Remote: true
SystemBootTimestamp	System has been running since this timestamp Remote: false
SystemId	System ID sent to the remote side to allow its use in directories. Remote: true
SystemIdList	System ID's sent to the remote side to reconfigure server_acl list if necessary. Remote: true
VerifyPeerCertificate	Set to 'server', 'client', 'both' or 'none' in order to check server certificates (of all HTTPS servers that the agent connects to), client certificates (for all HTTP clients of the agent, including end-user browsers) or both. The effective value is the combination of this parameter and any setting within the agent itself. Remote: true
VersionCompatibility	Versions of the platform agent that the server is also compatible with. You set this to the version of your platform agents if the version of your platform agent is lower than that of the central server and you do not wish to auto-update the agent. For example: 9.0.22.5 Multiple versions can be specified comma-separated. For example: 9.0.22.1,9.0.22.2,9.0.22.3 The asterisk wildcard is allowed. For example: 9.0.22.* Remote: false
WorkingDirectory	Directory used by the agent as its working (current) directory. Remote: true
InterpreterWhitelist_	You can specify a whitelist of allowed interpreters for each platform agent job definition type by specifying them as a comma separated list in a value to the process server parameter named InterpreterWhitelist_<jobDefinitionType>, like /bin/,/usr/bin/ksh* in InterpreterWhitelist_KSH, for example. These interpreters can then be used on a job definition-level using the JCS_INTERPRETER_<jobDefinitionType> Remote: false
Local_	You can override the interpreter including the white-listed ones for each platform agent job definition type by specifying it as a value to the process server parameter named Local_<jobDefinitionType>, like /usr/bin/pdksh in Local_KSH, for example. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
AgentInitiated
AgentInitiatedURL
Agentless
AgentStartTimestamp
AlternativeJobContextURL
BuildBranch
BuildId
BuildRevision
BurstWatchDirectory
CharacterSetMapping
CheckAgentCertificate
CheckAgentHostname
CipherSuites
ConnectErrorBackoff
ContextURL
CygwinInstallPath
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
DefaultRunAsUser
EncryptionAlgorithm
EndPoint
EnvironmentFile	All
EnvironmentVariables	All
ExecutableDirectory
FailoverURL
FileEventCredentials
FileInUseCommand	${Filename}
FileProtectionMask
FileTransferDirect
InstallDirectory
InstanceName
InterpreterWhitelist_BASH
InterpreterWhitelist_CMD
InterpreterWhitelist_CSH
InterpreterWhitelist_JAVA
InterpreterWhitelist_KSH
InterpreterWhitelist_PERL
InterpreterWhitelist_PERLUNICODE
InterpreterWhitelist_PS1
InterpreterWhitelist_PYTHON
InterpreterWhitelist_VB_SCRIPT
IPForwarderURL
JobWorkingDirectory	All
JobWorkingDirectoryBehaviour
KeepAllFiles
KeepCrashFiles
KeepEmptyFiles
KeepEnvironmentVariables
KeepErrorFiles
LegacyModeFeatures
LocalInterpreter_BASH
LocalInterpreter_CMD
LocalInterpreter_CSH
LocalInterpreter_JAVA
LocalInterpreter_KSH
LocalInterpreter_PERL
LocalInterpreter_PERLUNICODE
LocalInterpreter_PS1
LocalInterpreter_PYTHON
LocalInterpreter_R
LocalInterpreter_VB_SCRIPT
LogFile	${TraceDirectory} ${InstallDirectory} ${DataRootDirectory} ${ProcessType} ${ProcessName} ${ProcessId} ${ProcessServer} ${Timestamp} ${FileSeparator}
LogFileRetention
LogFileSize
LogLevel
LogonTimeout
LowVolume
MessageInterval
MinimalFreeDiskFiles
MinimalFreeDiskSpace
MonitorInterval
NetDirectory
OperatingSystem
OSFamily
Platform
ProcessType
ProtocolExtensions
ProxyProcessServers
ProxyServer
RedirectJobFiles
RemoteHostName
RemoteHostNameWhitelist
RemotePort
RemoteURI
SecureConnection
SecureGatewayFirewallRules
SequenceMultiplier
ServerUUID
SharedSecret
SwitchUserCommand	${User} ${Command}
SystemBootTimestamp
SystemId
SystemIdList
VerifyPeerCertificate
VersionCompatibility
WorkingDirectory	${InstallDirectory} ${DataRootDirectory}

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
AgentInitiated	false	Boolean
AgentInitiatedURL		String
Agentless	false	Boolean
AgentStartTimestamp		Integer
AlternativeJobContextURL		String
BuildBranch		String
BuildId		String
BuildRevision		String
BurstWatchDirectory		String
CharacterSetMapping		String
CheckAgentCertificate	false	Boolean
CheckAgentHostname	false	Boolean
CipherSuites		String
ConnectErrorBackoff	0;100;30000	String
ContextURL		String
CygwinInstallPath		String
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
DefaultRunAsUser		String
EncryptionAlgorithm		String
EndPoint		String
EnvironmentFile		String
EnvironmentVariables		String
ExecutableDirectory		String
FailoverURL		String
FileEventCredentials		String
FileInUseCommand	Default value on most UNIX platforms: /usr/sbin/fuser "${Filename}" Default value on macOS: /usr/bin/fuser "${Filename}" Default value on Linux: builtin	String
FileProtectionMask	022	String
FileTransferDirect	fallback	String
InstallDirectory		String
InstanceName		String
InterpreterWhitelist_BASH		String
InterpreterWhitelist_CMD		String
InterpreterWhitelist_CSH		String
InterpreterWhitelist_JAVA		String
InterpreterWhitelist_KSH		String
InterpreterWhitelist_PERL		String
InterpreterWhitelist_PERLUNICODE		String
InterpreterWhitelist_PS1		String
InterpreterWhitelist_PYTHON		String
InterpreterWhitelist_VB_SCRIPT		String
IPForwarderURL		String
JobWorkingDirectory	Default value on Microsoft Windows: ${JobFilesDirectory} Default value on UNIX: ${JobFilesDirectory} Default value on HP OpenVMS: ${JobFilesDirectory}	RemoteDirectory
JobWorkingDirectoryBehaviour	Ignore	String
KeepAllFiles	false	Boolean
KeepCrashFiles	false	Boolean
KeepEmptyFiles	false	Boolean
KeepEnvironmentVariables	Default value on UNIX: PATH,LANG,LC_,NATIVEJAVA_CLASSPATH,TZ*	String
KeepErrorFiles	false	Boolean
LegacyModeFeatures		String
LocalInterpreter_BASH		String
LocalInterpreter_CMD		String
LocalInterpreter_CSH		String
LocalInterpreter_JAVA		String
LocalInterpreter_KSH		String
LocalInterpreter_PERL		String
LocalInterpreter_PERLUNICODE		String
LocalInterpreter_PS1		String
LocalInterpreter_PYTHON		String
LocalInterpreter_R		String
LocalInterpreter_VB_SCRIPT		String
LogFile	${TraceDirectory}${FileSeparator}${ProcessServer}-${ProcessName}-${TimeStamp}-${ProcessId}.log	RemoteDirectory
LogFileRetention	10	Integer	0 - 10000
LogFileSize	100	Integer	0 - 2047
LogLevel	info	String
LogonTimeout	120	Integer	5 - 900
LowVolume	false	Boolean
MessageInterval	60	Integer	5 - 900
MinimalFreeDiskFiles	10000	Integer	0 -
MinimalFreeDiskSpace	100	Integer	0 -
MonitorInterval	0	Integer	0 - 900
NetDirectory		String
OperatingSystem		String
OSFamily		String
Platform		String
ProcessType		String
ProtocolExtensions		String
ProxyProcessServers		String
ProxyServer		String
RedirectJobFiles	false	String
RemoteHostName		String
RemoteHostNameWhitelist		String
RemotePort	1555	Integer	0 - 65535
RemoteURI		String
SecureConnection	false	Boolean
SecureGatewayFirewallRules		String
SequenceMultiplier	1	Integer
ServerUUID		String
SharedSecret	{RedwoodSecureStorage}:YvkgnwAdnjY6jlBqWJXTJ8Z0dv95GHjVKqK0s2pmVY2ht7yuklUolYklFCNVHpyYlX4gpoq4NfuaDlAf862xlA==	String
SwitchUserCommand	Default value on UNIX: sudo -S -u ${User} ${Command}	String
SystemBootTimestamp		Integer
SystemId		String
SystemIdList		String
VerifyPeerCertificate	none	String
VersionCompatibility		String
WorkingDirectory	Default value on Microsoft Windows: ${InstallDirectory} Default value on UNIX: ${InstallDirectory} Default value on HP OpenVMS: ${InstallDirectory}	RemoteDirectory
InterpreterWhitelist		String of CSV
Local		String

OracleJob Service

OracleJob service runs Oracle jobs.

Process Server Parameter Description

Name	Description
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
DefaultRunAsUser	User that the process will run as if no other user is specified. Remote: false
JDBCOracleDBMSOutput	Use Oracle DBMS Output? Remote: false
LegacyModeFeatures	List of strings that can be set to enable legacy behavior of the service. This can be set with the help of customer support to allow older, usually insecure or incorrect, behavior after upgrading to a release that improves that particular behavior of the product. Remote: true
OracleRACConnectString	A (JDBC) connect string to connect to a specific Oracle instance of a Oracle RAC cluster A (JDBC) connect string to connect to a specific Oracle instance of a Oracle RAC cluster. The connect string can have %h and %s and %i. The %h is replaced with the hostname of the Oracle instance, %s is replaced with the instance name and %i with the instance id. When this parameter is not set, it will try to connect using jdbc:oracle:thin:@%h:1521:%s. Remote: false
v7PLSQLApiAvailable	Is the Cronacle v6/7 compatible PL/SQL API available in this (Oracle) database. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
DefaultRunAsUser
JDBCOracleDBMSOutput
LegacyModeFeatures
OracleRACConnectString
v7PLSQLApiAvailable

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
DefaultRunAsUser		String
JDBCOracleDBMSOutput	false	Boolean
LegacyModeFeatures		String
OracleRACConnectString		String
v7PLSQLApiAvailable	false	Boolean

Publish Service

Publish service runs jobs to publish or approve files on a remote server.

Process Server Parameter Description

Name	Description
URL	URL for the Remote publishing server. This is the base path of the service include protocol, host, port and context path, the folder is supplied in the process definition. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
URL

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type	Value Range
URL		String

Script Service

Script service runs RedwoodScript jobs.

Process Server Parameter Description

Name	Description
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
JobLogFileNameFormat	Default for process log file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<jobid> will be appended to the directory name, where <n> is the integer of <jobid>/10000. For example: JobLogFileNameFormat is set to /var/redwood/joblog/${JobFileOrder}-${JobFileName} and jobId is 210955, the log file will be written to /var/redwood/joblog/210000-219999/210955/1-stderr.log. Remote: false
JobLogFileNameSuffix	Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
JobOutputFileNameFormat	Default for output file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<id> will be appended to the directory name, where <n> is the integer of <id>/10000. For example: JobOutputFileNameFormat is set to /var/redwood/jobout/${JobFileOrder}-${JobFileName} and Id is 210955, the log file will be written to /var/redwood/jobout/210000-219999/210955/2-stdout.log Remote: false
JobOutputFileNameSuffix	Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
LegacyModeFeatures	List of strings that can be set to enable legacy behavior of the service. This can be set with the help of customer support to allow older, usually insecure or incorrect, behavior after upgrading to a release that improves that particular behavior of the product. Remote: true
SharedSecret	Shared secret used for authentication between the process server and the remote agent. This must match the value for the remote agent. Remote: false
VersionCompatibility	Versions of the platform agent that the server is also compatible with. You set this to the version of your platform agents if the version of your platform agent is lower than that of the central server and you do not wish to auto-update the agent. For example: 9.0.22.5 Multiple versions can be specified comma-separated. For example: 9.0.22.1,9.0.22.2,9.0.22.3 The asterisk wildcard is allowed. For example: 9.0.22.* Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
JobLogFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobLogFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${FormatExtension}
JobOutputFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobOutputFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}
LegacyModeFeatures
SharedSecret
VersionCompatibility

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
JobLogFileNameFormat		String
JobLogFileNameSuffix	log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
JobOutputFileNameFormat		String
JobOutputFileNameSuffix	lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
LegacyModeFeatures		String
SharedSecret	{RedwoodSecureStorage}:YvkgnwAdnjY6jlBqWJXTJ8Z0dv95GHjVKqK0s2pmVY2ht7yuklUolYklFCNVHpyYlX4gpoq4NfuaDlAf862xlA==	String
VersionCompatibility		String

System Service

System service runs internally defined jobs.

Process Server Parameter Description

Name	Description
DataRootDirectory	The root data directory that contains the directories for process output The DataRootDirectory should point to a file system that is served by a local device driver. In other words, not a NFS or Microsoft Windows network share. The reason for this is that the file tree needs to be as reliable as possible, as some parts are used for a database (of messages and file state). Remote: true
JobLogFileNameFormat	Default for process log file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<jobid> will be appended to the directory name, where <n> is the integer of <jobid>/10000. For example: JobLogFileNameFormat is set to /var/redwood/joblog/${JobFileOrder}-${JobFileName} and jobId is 210955, the log file will be written to /var/redwood/joblog/210000-219999/210955/1-stderr.log. Remote: false
JobLogFileNameSuffix	Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false
JobOutputFileNameFormat	Default for output file name format. The value should be a full path and contain at least ${JobFileName} as well as ${JobFileOrder}. The directory must be writable by the user that started the J2EE application server. <n0000>-<n9999>/<id> will be appended to the directory name, where <n> is the integer of <id>/10000. For example: JobOutputFileNameFormat is set to /var/redwood/jobout/${JobFileOrder}-${JobFileName} and Id is 210955, the log file will be written to /var/redwood/jobout/210000-219999/210955/2-stdout.log Remote: false
JobOutputFileNameSuffix	Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false

Process Server Parameter Usage

Following a link in the table below will take you to the corresponding entry in the parameter description table.

The following process server parameters can have variables in their value fields:

Name	Variables
DataRootDirectory	${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}
JobLogFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobLogFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${FormatExtension}
JobOutputFileNameFormat	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}
JobOutputFileNameSuffix	${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}

The following table lists the parameters and their default values as well as a range of values the parameter accepts:

Name	Default Value	Data Type
DataRootDirectory	Default on Microsoft Windows: ${InstallDirectory}\var\${SystemId}\${ProcessServer} Default on UNIX: ${InstallDirectory}/var/${SystemId}/${ProcessServer} Default on HP OpenVMS: ${InstallDirectory}[var.${SystemId}.${ProcessServer}] Default on Java platforms: ${InstallDirectory}	RemoteDirectory
JobLogFileNameFormat		String
JobLogFileNameSuffix	log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String
JobOutputFileNameFormat		String
JobOutputFileNameSuffix	lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}	String