Show TOC

Background documentationProcess Server Parameters Locate this document in the navigation structure

 

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.

UNIX/Windows/HP OpenVMS Process Server Parameters

Name

Description

Variables

Default Value

Data Type

Value Range

DataRootDirectory

The root data directory that contains the directories for job output Remote: true

The following variables are available: ${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}

platform-specific

RemoteDirectory

WorkingDirectory

Directory used by the agent as its working (current) directory Remote: true

The following variables are available: ${InstallDirectory} ${DataRootDirectory}

platform-specific

RemoteDirectory

LogFile

Path to file to which the platform agent should log after it has been configured Remote: true

The following variables are available: ${TraceDirectory} ${InstallDirectory} ${DataRootDirectory} ${ProcessType} ${ProcessName} ${ProcessId} ${ProcessServer} ${FileSeparator}

${TraceDirectory}${FileSeparator}${ProcessServer}-${ProcessName}-${ProcessId}.log

RemoteDirectory

LogLevel

Logging level for the platform agent after it has been configured. Comma delimited list of [[executable.]<category>=]level values Remote: true

The following variables are available:

info

String

MonitorInterval

Interval in seconds for measuring the built-in monitoring data. To switch this off, set the value to 0 Remote: true

The following variables are available:

60

Integer

0 - 900

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

The following variables are available:

{RedwoodSecureStorage}:YvkgnwAdnjY6jlBqWJXTJ8Z0dv95GHjVKqK0s2pmVY2ht7yuklUolYklFCNVHpyYlX4gpoq4NfuaDlAf862xlA==

String

EndPoint

Target host for the job to run on Remote: false

The following variables are available:

String

DefaultRunAsUser

User that the job will run as if no other user is specified Remote: false

The following variables are available:

String

RemoteHostName

Remote host on which the agent is installed Remote: false

The following variables are available:

String

RemotePort

The TCP port on which the agent on the remote host is listening Remote: false

The following variables are available:

1555

Integer

1 - 32767

FileInUseCommand

Command used to check if a file is in use, on UNIX only Remote: true

The following variables are available: ${Filename}

platform-specific

String

SwitchUserCommand

Command used to switch users, on UNIX only Remote: true

The following variables are available: ${User} ${Command}

platform-specific

String

KeepEnvironmentVariables

UNIX platform agent only. Environment variables that are passed to jobs from the platform agent. Comma-separated list of variables with terminating * permitted. Default value is PATH,LANG,LC_*. Remote: true

The following variables are available:

platform-specific

String

KeepEmptyFiles

Should the platform agent keep empty output or log files? Remote: true

The following variables are available:

false

Boolean

KeepAllFiles

Should the platform agent keep all job processor work files in the Job directory? Remote: true

The following variables are available:

false

Boolean

KeepErrorFiles

Should the platform agent keep all job processor work files when the job ends in error? Remote: true

The following variables are available:

false

Boolean

KeepCrashFiles

Should the platform agent keep all job processor work files when the job processor crashes? Remote: true

The following variables are available:

false

Boolean

ConnectErrorBackoff

List of delay values (in ms, comma separated) that the service should delay for when a connect error occurs. 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

The following variables are available:

0,100,100,1000,1000,10000,10000,10000,30000

String

SystemId

System ID sent to the remote side to allow its use in directories Remote: true

The following variables are available:

String

OSFamily

Operating system family. This will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

Platform

Operating system platform and cpu type. This will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

BuildBranch

Branch from which this platform agent was built. This will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

BuildRevision

Revision of the branch from which the platform agent was built. This will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

BuildId

Revision and branch that the platform agent was built from, this will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

ProcessType

Type of process the platform agent is running as, this will be set by the remote agent itself when it starts Remote: false

The following variables are available:

String

InstanceName

Instance name used by the platform agent. This will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

InstallDirectory

Directory the platform agent network process server is installed. This will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

ExecutableDirectory

Directory that the binaries used for the platform agent are installed. This will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

NetDirectory

Directory from which the platform agent is configured. This will be set by the platform agent itself when it starts Remote: false

The following variables are available:

String

SecureConnection

Should HTTPS 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

The following variables are available:

false

Boolean

CheckAgentCertificate

Should the scheduler's JVM 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

The following variables are available:

false

Boolean

CheckAgentHostname

Should the scheduler's JVM 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

The following variables are available:

false

Boolean

MessageInterval

Number of seconds before an agent will respond that there are no messages to be retrieved. Remote: true

The following variables are available:

60

Integer

5 - 900

RemoteURI

Remote URL, changed depending on agent hostname and SSL settings. The last defined setting is used for retrieving jobfiles Remote: false

The following variables are available:

String

EnvironmentVariables

Extra environment variables, in the format <name>=<value> [,]... with UNIX quoting rules (use " to store spaces, commas and newlines, \\ escapes the next character) Remote: true

The following variables are available: ${ALL}

String

EnvironmentFile

Extra environment variables are loaded from this file, in the format <name>=<value> [,]... with UNIX quoting rules (use " to store spaces, commas and newlines, \\ escapes the next character) Remote: true

The following variables are available: ${ALL}

String

VersionCompatibility

Versions of the platform agent that the server is also compatible with. Remote: false

The following variables are available:

String

SAP Specific Parameters

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.

Note Note

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.

End of the note.

You need to restart the process server for the values to take effect.

SAP RFC

Name

Description

Variables

Default Value

Data Type

Value Range

DataRootDirectory

The root data directory that contains the directories for job output Remote: true

The following variables are available: ${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}

platform-specific

RemoteDirectory

JobLogFileNameFormat

Default for job log file name format Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}

String

JobOutputFileNameFormat

Default for job output file name format Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}

String

JobLogFileNameSuffix

Default for job log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${FormatExtension}

log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}

String

JobOutputFileNameSuffix

Default for job output file name suffix. This is appended to DataRootDirectory to create a file name Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}

lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}

String

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. You use this parameter only if the SAP service is connected to an SAP system using XBP 2.0. Changes to this parameter are effective immediately. Remote: false

false

Boolean

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

120

Integer

0 -

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

5

Integer

5 -

SAP_JobSyncPollIntervalMax

Maximum number of seconds for the poll interval of the XBP job synchronizer component of the SAP service Remote: false

120

Integer

10 -

SAP_JobSyncPollIntervalMin

Minimum number of seconds for the poll interval of the XBP job synchronizer component of the SAP service Remote: false

10

Integer

10 -

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

1

Integer

1 -

SAP_DefaultJobPriority

Default job priority for jobs created by the XBP job synchronizer component of the SAP service Remote: false

50

Integer

1 - 100

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

5000

Integer

1 -

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

25

Integer

1 -

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

25

Integer

0 -

SAP_JobMonitorPollInterval

Poll interval in seconds for the job monitoring component of the SAP service. This component regularly checks the SAP jobs assigned to the scheduler and updates their status. Remote: false

10

Integer

1 -

SAP_JobMonitorNumberOfWorkers

Number of workers used by the job monitoring component of the SAP service Remote: false

10

Integer

1 -

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<SAPNoteNumber>1020092</SAPNoteNumber>. This parameter has no effect in SAP systems that do not meet the prerequisites of this SAP Note. Remote: false

10

Integer

1 -

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<SAPNoteNumber>1020092</SAPNoteNumber>. This parameter has no effect in SAP systems that do not meet the prerequisites of this SAP Note. Remote: false

600

Integer

0 -

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

120

Integer

0 -

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

5

Integer

0 -

SAP_AlertReadPollIntervalMax

Maximum number of seconds for the poll interval of the XAL CCMS alerts synchronizer component of the SAP service Remote: false

120

Integer

10 -

SAP_AlertReadPollIntervalMin

Minimum number of seconds for the poll interval of the XAL CCMS alerts synchronizer component of the SAP service Remote: false

10

Integer

10 -

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

120

Integer

0 -

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

5

Integer

0 -

SAP_AlertWritePollIntervalMax

Maximum number of seconds for the poll interval of the XMW component of the SAP service Remote: false

120

Integer

10 -

SAP_AlertWritePollIntervalMin

Minimum number of seconds for the poll interval of the XMW component of the SAP service Remote: false

10

Integer

10 -

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

300

Integer

60 -

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

0

Integer

0 -

SAP_EnableRfcServer

Enables the built-in RFC server, which enables the SAP API Remote: false

false

Boolean

SAP_NumberOfRfcServerThreads

Number of threads used by the RFC server Remote: false

10

Integer

1 -

SAP_RfcServerDestination

RFC destination name for the RFC server. If no destination is set, the RFC server will create a new one. Remote: false

String

SAP_API_DefaultScheduler

Determines whether the scheduler should register itself as the default scheduler for the SAP API Remote: false

true

Boolean

SAP_LastJobSync

Time stamp of the last synchronization cycle of the XBP job synchronizer component Remote: false

Integer

SAP_UppercaseRfcPassword

Whether to uppercase the password before opening an RFC connection Remote: false

false

Boolean

SAP_UseTransports

Determines whether the functions provided with the transport files from Redwood should be used Remote: false

true

Boolean

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. Remote: false

1048576

Integer

-1 -

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

true

Boolean

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

1048576

Integer

-1 -

SAP_JobDescriptionPolicy

Policy used for the SAP service when automatically changing the descriptions of jobs. Possible options are: All, StandardOnly, None. Remote: false

All

String

SAP_RFCIdleTimeout

Time after which idle RFC connections are closed (in seconds) Remote: false

300

Integer

0 -

SAP_RFCAbortTimeout

Time after which active RFC connections are considered being stale and aborted (in seconds). 0 means no connections are aborted Remote: false

0

Integer

0 -

SAP_DisableDefaultPrintFeature

Set to true to disable the default print feature, i.e. sending a $ sign for empty parameters, as described in SAP note 609462 Remote: false

false

Boolean

SAP_IgnoreApplicationReturnCode

If set to true, the application return code will NOT be set on the job in the scheduler Remote: false

false

Boolean

SAP_XbpVersion

XBP Version Remote: false

String

SAP_Release

SAP kernel / ABAP release Remote: false

String

SAP PI

Name

Description

Variables

Default Value

Data Type

Value Range

DataRootDirectory

The root data directory that contains the directories for job output Remote: true

The following variables are available: ${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}

platform-specific

RemoteDirectory

JobLogFileNameFormat

Default for job log file name format Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}

String

JobOutputFileNameFormat

Default for job output file name format Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}

String

JobLogFileNameSuffix

Default for job log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${FormatExtension}

log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}

String

JobOutputFileNameSuffix

Default for job output file name suffix. This is appended to DataRootDirectory to create a file name Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}

lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}

String

JXBP

Name

Description

Variables

Default Value

Data Type

Value Range

DataRootDirectory

The root data directory that contains the directories for job output Remote: true

The following variables are available: ${InstallDirectory} ${ProcessServer} ${HostName} ${SystemId}

platform-specific

RemoteDirectory

JobLogFileNameFormat

Default for job log file name format Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}

String

JobOutputFileNameFormat

Default for job output file name format Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder}

String

JobLogFileNameSuffix

Default for job log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${FormatExtension}

log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}

String

JobOutputFileNameSuffix

Default for job output file name suffix. This is appended to DataRootDirectory to create a file name Remote: false

The following variables are available: ${ProcessServer} ${HostName} ${SystemId} ${JobId} ${FileSeparator} ${JobOwner} ${DateTime} ${JobDefinitionOwner} ${JobDefinition} ${JobDefinitionPartition} ${ProcessServer} ${ProcessServerPartition} ${Queue} ${QueuePartition} ${JobApplication} ${JobApplicationPartition} ${JobFileName} ${JobFileOrder} ${FormatExtension}

lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension}

String

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

0

Integer

0 -

SAP_JobDescriptionPolicy

Policy used for the SAP service when automatically changing the descriptions of jobs. Possible options are: All, StandardOnly, None. Remote: false

All

String

SAP_JXBP_EventPollInterval

Poll interval for JXBP events (in seconds) Remote: false

1

Integer

SAP_JXBP_EventFetchSize

Number of JXBP events to fetch simultaneously Remote: false

1000

Integer

SAP_JXBP_LogFetchSize

Number of log lines of JXBP jobs to fetch simultaneously Remote: false

100

Integer