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>
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 Platform Agent is running on. |
|
InstallDirectory |
OS Platform 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 |
| Time delay between messages related to the same file event. Remote: false | |
| 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 |
|
| Exceptions treated as OK (separated by commas). Remote: false | |
| States to deliberately fail on (separated by commas). Remote: false | |
| AS/400 exceptions to be ignored (separated by commas). Remote: false | |
| Retrieve QPJOBLOG independently of output Queue settings? Remote: false | |
| Language used in the AS/400 system (en, de, nl). Remote: false | |
| Default log level for the stdlog file. Remote: false | |
| Deprecated( New monitor functionality introduced): Maximum time to wait for the job to complete (seconds). Remote: false | |
| Allow operators to reply to AS/400 messages from the corresponding Operator Message. Remote: false | |
| Full operator trace output? Remote: false | |
| Retrieve output files from AS400 jobs? Remote: false | |
| Parse messages in the log file into job notes. Remote: false | |
| List of IFS paths of output Queues to check for output files. Remote: false | |
| Default banner prefixed to the spool. Parameter substitutions use @{name}. You can use \\t and \\n for tabs and new lines. Remote: false | |
| Spool files larger than this will not be retrieved (bytes). Remote: false | |
| Default Printer for Spooling Output (Manufacturer, Type, and Model). Remote: false | |
| Remove control characters from job spools? Remote: false | |
| Default workstation if the MFRTYPMDL is set to *WSCST (default). May be explicitly set to null to be ignored. Remote: false | |
| States that signal the end of the job (separated by commas). Remote: false | |
| Include the output Queue in the criteria when searching for output files. Remote: false | |
| Include the job start and end times in the criteria when searching for output files. Remote: false | |
| Remote host on which the AS/400 job will run. Remote: false | |
| User under which the AS/400 job will run. Remote: false | |
| 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 |
|
| User that the process will run as if no other user is specified. Remote: false | |
| 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 |
|
| Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false | |
| Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false | |
| Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false | |
| 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 |
|
|
|
|
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 |
| 300000 | Integer | ||
| String | |||
| CPF3C53,CPF3C52 | String | ||
| String | |||
| CPF3C54 | String | ||
| true | Boolean | ||
| en | String | ||
| debug | String | ||
| 259200 | Integer | ||
| true | Boolean | ||
| false | Boolean | ||
| true | Boolean | ||
| false | Boolean | ||
| null | String | ||
| -- Spool @{spool} @{number} --\\n | String | ||
| 1000000 | Integer | ||
| *WSCST | String | ||
| true | Boolean | ||
| /QSYS.LIB/QWPDEFAULT.WSCST | String | ||
| *OUTQ | String | ||
| false | Boolean | ||
| false | Boolean | ||
| String | |||
| String | |||
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| String | |||
| lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| 120 | Integer | 0 - | |
| 5 | Integer | 5 - | |
| 120 | Integer | 10 - | |
| 10 | Integer | 10 - |
OraApps Service
OraApps service runs remote Oracle Application jobs.
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 |
| 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 |
|
| 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 | |
| Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false | |
| Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false | |
| Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false | |
| Minimum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false | |
| 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 | |
| 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 | |
| Get(HTTP) or Link(via the Platform Agent) the Oracle Applications Logfile. Remote: false | |
| Get(HTTP) or Link(via the Platform Agent) the Oracle Applications Outputfile. Remote: false | |
| Oracle EBS Applications that uses extra security by using FND_SESSION 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 |
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 |
| All | String | ||
| 1 | Integer | 1 - | |
| 120 | Integer | 0 - | |
| 5 | Integer | 5 - | |
| 120 | Integer | 10 - | |
| 10 | Integer | 10 - | |
| 100 | Integer | 5 - | |
| 0 | Integer | 0 - | |
| true | Boolean | ||
| true | Boolean | ||
| PER, PAY | String |
Oracle Health Insurance Service
Oracle Health Insurance service runs OHI Jobs.
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 |
| 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 | |
| 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 |
|
| 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 |
|
| 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 | |
| Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false | |
| Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false | |
| Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false | |
| Minimum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false | |
| 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 | |
| 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 | |
| Number of seconds before an Platform Agent will respond that there are no messages to be retrieved. Remote: true | |
| Remote host on which the processes need to be executed. Remote: false | |
| The TCP port on which the Platform Agent on the remote host is listening. Remote: false | |
| Do you want HTTPS to be used as the connection protocol instead of HTTP? If you set this to true, make sure the Platform Agent has an X509 certificate and key, and has the appropriate extra security library installed. Remote: false | |
| Transfer the Logfile from the external system to the scheduler. Remote: false | |
| Transfer the Outputfile(s) from the external system to the scheduler. 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 |
|
|
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 |
| BEFMKVWSL | String | ||
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| All | String | ||
| 1 | Integer | 1 - | |
| 120 | Integer | 0 - | |
| 5 | Integer | 5 - | |
| 120 | Integer | 10 - | |
| 10 | Integer | 10 - | |
| 100 | Integer | 5 - | |
| 0 | Integer | 0 - | |
| 60 | Integer | 5 - 900 | |
| String | |||
| 1555 | Integer | 0 - 65535 | |
| false | Boolean | ||
| true | Boolean | ||
| true | Boolean |
PeopleSoft Service
PeopleSoft service runs PeopleSoft jobs.
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 |
| 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 |
|
| 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 |
|
| 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 | |
| Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false | |
| Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false | |
| Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false | |
| Minimum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false | |
| Should we use the distribution status to map PeopleSoft statuses to our status. Remote: false | |
| 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 | |
| Transfer the Outputfile(s) from the external system to the scheduler. 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 |
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| All | String | ||
| 1 | Integer | 1 - | |
| 120 | Integer | 0 - | |
| 5 | Integer | 5 - | |
| 120 | Integer | 10 - | |
| 10 | Integer | 10 - | |
| true | Boolean | ||
| EODI_SYSTEM, PROCESSREQUEST | String | ||
| true | Boolean |
SAPBObj Service
SAPBObj service runs remote Business Objects jobs.
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 |
| 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 |
|
| 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 | |
| Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 | |
| Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 |
|
| 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
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 |
|
|
|
|
|
|
|
|
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| String | |||
| lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| All | String | ||
| 10 | Integer | 1 - |
SAPPI Service
SAPPI service runs remote SAP PI jobs.
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 |
| 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 |
|
| 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 | |
| Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 | |
| Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. 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 |
|
|
|
|
|
|
|
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| String | |||
| 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
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 |
| 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 |
|
| 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 | |
| Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 | |
| Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 | |
| 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 | |
| Maximum number of seconds for the poll interval of the XAL CCMS alerts synchronizer component of the SAP service. Remote: false | |
| Minimum number of seconds for the poll interval of the XAL CCMS alerts synchronizer component of the SAP service. Remote: false | |
| 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 | |
| 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 | |
| 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 | |
| Maximum number of seconds for the poll interval of the XMW component of the SAP service. Remote: false | |
| Minimum number of seconds for the poll interval of the XMW component of the SAP service. Remote: false | |
| Default job priority for jobs created by the XBP job synchronizer component of the SAP service. Remote: false | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| If set to true, the application return code will NOT be set on the job in the scheduler. Remote: false | |
| 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 | |
| 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 |
|
| 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 | |
| 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 | |
| Number of workers used by the job monitoring component of the SAP service. Remote: false | |
| 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 | |
| Decrease poll interval in seconds for the job monitoring component of the SAP service. Remote: false | |
| Increase poll interval in seconds for the job monitoring component of the SAP service. Remote: false | |
| Maximum poll interval in seconds for the job monitoring component of the SAP service. Remote: false | |
| 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 | |
| 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 | |
| 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 | |
| Maximum number of seconds for the poll interval of the XBP job synchronizer component of the SAP service. Remote: false | |
| Minimum number of seconds for the poll interval of the XBP job synchronizer component of the SAP service. Remote: false | |
| Time stamp of the last synchronization cycle of the XBP job synchronizer component. Remote: false | |
| 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 | |
| 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 | |
| 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 |
|
| Poll interval in seconds for the BI process Chains in status Console. Remote: false | |
| 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 kernel / ABAP release. Remote: false | |
| Time after which active RFC connections are considered stale and aborted (in seconds). 0 means no connections are aborted. Remote: false | |
| Time after which idle RFC connections are closed (in seconds). Remote: false | |
| 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 | |
| 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 | |
| SID. Remote: false | |
| 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 | |
| Whether to uppercase the password before opening an RFC connection. Remote: false | |
| 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 | |
| Determines whether the functions provided with the transport files from Redwood should be used. Remote: false | |
| XBP Version. 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 |
|
|
|
|
|
|
|
|
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| String | |||
| lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| 120 | Integer | 0 - | |
| 5 | Integer | 0 - | |
| 120 | Integer | 10 - | |
| 10 | Integer | 10 - | |
| 300 | Integer | 60 - | |
| 120 | Integer | 0 - | |
| 5 | Integer | 0 - | |
| 120 | Integer | 10 - | |
| 10 | Integer | 10 - | |
| 50 | Integer | 1 - 100 | |
| false | Boolean | ||
| true | Boolean | ||
| 10 | Integer | 1 - | |
| 600 | Integer | 0 - | |
| false | Boolean | ||
| false | Boolean | ||
| 25 | Integer | 1 - | |
| All | String | ||
| 1 | Integer | 1 - | |
| 25 | Integer | 0 - | |
| 10 | Integer | 1 - | |
| 10 | Integer | 1 - | |
| 300 | Integer | 1 - | |
| 10 | Integer | 1 - | |
| 300 | Integer | 1 - | |
| 5000 | Integer | 1 - | |
| 120 | Integer | 0 - | |
| 5 | Integer | 5 - | |
| 120 | Integer | 10 - | |
| 10 | Integer | 10 - | |
| Integer | |||
| 1048576 | Integer | -1 - | |
| 0 | Integer | 0 - | |
| 1048576 | Integer | -1 - | |
| 60 | Integer | 10 - | |
| true | Boolean | ||
| String | |||
| 0 | Integer | 0 - | |
| 300 | Integer | 0 - | |
| true | Boolean | ||
| true | Boolean | ||
| String | |||
| 3600 | Integer | -1 - 86400 | |
| false | Boolean | ||
| false | Boolean | ||
| true | Boolean | ||
| String |
CustomJob Service
CustomJob service runs Custom jobs.
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 |
| Decrease number of seconds for the poll interval of the process synchronizer component of the connector service when the system is busy. Remote: false | |
| Increase number of seconds for the poll interval of the process synchronizer component of the connector service when the system is idle. Remote: false | |
| Maximum number of seconds for the poll interval of the process synchronizer component of the connector service. Remote: false | |
| 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 |
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 |
| 120 | Integer | 0 - | |
| 5 | Integer | 5 - | |
| 120 | Integer | 10 - | |
| 10 | Integer | 10 - |
JXBP Service
JXBP service runs and intercepts JXBP jobs.
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 |
| 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 |
|
| 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 | |
| Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 | |
| Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 |
|
| Number of JXBP events to fetch simultaneously. Remote: false | |
| Poll interval for JXBP events (in seconds). Remote: false | |
| Poll interval for JXBP jobs (in seconds). JXBP jobs which stay longer than the given amount of time in active state are polled for their status. Set to 0 to disable. Remote: false | |
| Number of log lines of JXBP jobs to fetch simultaneously. Remote: false | |
| 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 |
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 |
|
|
|
|
|
|
|
|
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| String | |||
| lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| All | String | ||
| 1000 | Integer | ||
| 1 | Integer | ||
| 300 | Integer | ||
| 100 | Integer | ||
| 0 | Integer | 0 - |
JDBC Service
JDBC service deals with JDBC connections.
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 |
| 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 |
|
| User that the process will run as if no other user is specified. Remote: false | |
| Use Oracle DBMS Output? Remote: false | |
| The alternative Process Server that is used to enable Queue Jumping. Remote: false | |
| Format of the SQL statement feedback in JDBC jobs. Possible options are: Simple, Normal or Extended Remote: false | |
| 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 | |
| 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 | |
| Is the Cronacle v6/7 compatible PL/SQL API available in this (Oracle) database. 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 |
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| false | Boolean | ||
| String | |||
| Normal | String | ||
| Pretty | String | ||
| String | |||
| 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 Platform 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 Platform 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 Platform Agent. This account does not have access to network shares. Since version M28 the Microsoft Windows Platform 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
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 |
| Is Platform Agent going to connect to the server, instead of the server connecting to the Platform Agent? If this is set to true you need to set the Platform Agent configuration file 'agent_initiated_url' to the scheduler URL http[s]://server:port/redwood/ipi-platformagentservice/BusinessKey/[<Partition>.]<ps-name> Remote: false | |
| URL of the server at which this Platform Agent last contacted the server. Remote: false | |
| Set to true if you do not want to install a Platform Agent to run processes on this system. This precludes non-process running features such as monitoring and file events. Remote: false | |
| Agent has been running since this timestamp Remote: false | |
| Branch from which this Platform Agent was built. Remote: false | |
| Revision and branch from which the Platform Agent was built from. Remote: false | |
| Revision of the branch from which the Platform Agent was built. Remote: false | |
| Specify the Burster watch directory. Remote: true | |
| 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 | |
| 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 Platform Agent's public certificate and the root CA certificate. Remote: false | |
| 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 Platform Agent's certificate. Remote: false | |
| List of cipher suites that is enabled for outgoing traffic to the Platform Agent when the connection is encrypted. Remote: false | |
| 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 | |
| External URL of the scheduler UI. Remote: true | |
| Override the installation path of Cygwin on the Microsoft Windows server. Use when auto-detection fails or when you have multiple installations. Remote: true | |
| 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 |
|
| User that the process will run as if no other user is specified. Remote: false | |
| Which algorithm is used to encrypt network data between the Platform Agent and the scheduler server. Remote: false | |
| 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 |
|
| Extra environment variables for the processes are loaded from this file, in the format `[export ]<name>=<value> [;|\\n]` with UNIX quoting rules (use " to store spaces, commas and newlines, \\ escapes the next character). Remote: true | |
| 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 | |
| Directory that the binaries used for the Platform Agent are installed in. Remote: false | |
| URL of the server that will be contacted by the Platform Agent when the main AgentInitiatedURL server is no longer reachable or refuses communication. Remote: true | |
| Use the given credential for file detection and file moves (for file events). Applies to Microsoft Windows only. * `[LM DOMAIN\]<real_user>@<domain>` - uses credential * `<LM DOMAIN>\<user>/<password>` - hardcoded password (not recommended) * `<real_user>/<password>@<domain>` - hardcoded password (not recommended) Remote: true | |
| Command to be used to check if a file is in use, on UNIX only. Remote: true | |
| File protection mask (umask), on UNIX only. Value in traditional unix octal mode, for example 022. Remote: true | |
| 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 Platform 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 |
|
| Directory in which the Platform Agent network Process Server is installed. Remote: false | |
| Instance name used by the Platform Agent. Used to install multiple Platform Agents in one installation. Remote: false | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| URL of the server that will be forwarding IP connections via this Platform Agent to the network reachable from the Platform Agent. Remote: true | |
| 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 | |
| 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 |
|
| Is Platform Agent to keep all job-processor work files in the Process directory? Remote: true | |
| Is Platform Agent to keep intermediate files after a job-processor crash? Remote: true | |
| Is Platform Agent to keep empty output or log files? Remote: true | |
| 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. Remote: true | |
| Is Platform Agent to keep all job-processor work files when the process ends in error? Remote: true | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| Path to file to which the Platform Agent should log after it has been configured. Remote: true | |
| Number of log files to keep before the oldest is deleted. Remote: true | |
| Maximum size of an individual log file, in megabytes. Remote: true | |
| Logging level for the Platform Agent after it has been configured. Comma delimited list of [[executable.]<category>=]level values. Remote: true | |
| 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 | |
| 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 |
|
| Number of seconds before an Platform Agent will respond that there are no messages to be retrieved. Remote: true | |
| Number of files that can be created on the file-system used for job files before a Platform Agent will run jobs. ProcessServer will go to status Error when the number of possible files goes below this limit. Remote: true | |
| Number of megabytes free disk space for job files before a Platform Agent will run jobs. ProcessServer will go to status Error when the disk space goes below this limit. Remote: true | |
| Interval in seconds for measuring the built-in monitoring data. To switch this off, set the value to 0. Remote: true | |
| Directory from which the Platform Agent is configured. Remote: false | |
| Operating system information such as version number Remote: false | |
| Operating system family. Remote: false | |
| Operating system platform and CPU type that the Platform Agent was built for. Remote: false | |
| Type of process under which Platform Agent is running. Remote: false | |
| Protocol extensions supported. Comma separated list of protocol changes that this Platform Agent supports. Remote: false | |
| Names of the Process Servers that are allowed to proxy processes to the final RemoteHost. Remote: false | |
| The HTTP proxy that is configured on the Platform Agent. Remote: false | |
| 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 |
|
| Remote host on which the processes need to be executed. Remote: false | |
| In AgentInitiated mode only one remote system can contact this Process Server. If a failover setup with multiple Platform 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 | |
| The TCP port on which the Platform Agent on the remote host is listening. Remote: false | |
| Remote URL, changed depending on Platform Agent hostname and SSL settings. The last defined setting is used for retrieving files. Remote: false | |
| Do you want HTTPS to be used as the connection protocol instead of HTTP? If you set this to true, make sure the Platform Agent has an X509 certificate and key, and has the appropriate extra security library installed. Remote: false | |
| Firewall rules that apply for forwarded IP connections via this Platform Agent to the network reachable from the Platform Agent. Remote: true | |
| 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 | |
| Server UUID used for authentication between the Process Server and the remote Platform Agent. Remote: true | |
| Shared secret used for authentication between the Process Server and the remote Platform Agent. This must match the value for the remote Platform Agent. Remote: false | |
| 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 | |
| System has been running since this timestamp Remote: false | |
| System ID sent to the remote side to allow its use in directories. Remote: true | |
| System ID's sent to the remote side to reconfigure server_acl list if necessary. Remote: true | |
| Set to 'server', 'client', 'both' or 'none' in order to check server certificates (of all HTTPS servers that the Platform Agent connects to), client certificates (for all HTTP clients of the Platform Agent, including end-user browsers) or both. The effective value is the combination of this parameter and any setting within the Platform Agent itself. Remote: true | |
| 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 Platform 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 |
|
| Directory used by the Platform Agent as its working (current) directory. Remote: true | |
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></code>, like <code>/bin/*,/usr/bin/ksh</code> in <code>InterpreterWhitelist_KSH</code>, for example. These interpreters can then be used on a job definition-level using the <code>JCS_INTERPRETER_<jobDefinitionType> Remote: false |
|
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></code>, like <code>/usr/bin/pdksh</code> in <code>Local_KSH, for example. 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 |
|
|
| All | |
| All | |
| ${Filename} | |
| All | |
|
|
|
|
|
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 |
| false | Boolean | ||
| String | |||
| false | Boolean | ||
| Integer | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| false | Boolean | ||
| false | Boolean | ||
| String | |||
| 0;100;30000 | String | ||
| String | |||
| String | |||
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
|
Default value on most UNIX platforms: Default value on macOS: Default value on Linux: |
String | ||
| 022 | String | ||
| fallback | String | ||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
|
Default value on Microsoft Windows: Default value on UNIX: Default value on HP OpenVMS: |
RemoteDirectory | ||
| Ignore | String | ||
| false | Boolean | ||
| false | Boolean | ||
| false | Boolean | ||
|
Default value on UNIX: |
String | ||
| false | Boolean | ||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| ${TraceDirectory}${FileSeparator}${ProcessServer}-${ProcessName}-${TimeStamp}-${ProcessId}.log | RemoteDirectory | ||
| 10 | Integer | 0 - 10000 | |
| 100 | Integer | 0 - 2047 | |
| info | String | ||
| 120 | Integer | 5 - 900 | |
| false | Boolean | ||
| 60 | Integer | 5 - 900 | |
| 10000 | Integer | 0 - | |
| 100 | Integer | 0 - | |
| 0 | Integer | 0 - 900 | |
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| String | |||
| false | String | ||
| String | |||
| String | |||
| 1555 | Integer | 0 - 65535 | |
| String | |||
| false | Boolean | ||
| String | |||
| 1 | Integer | ||
| String | |||
| {RedwoodSecureStorage}:YvkgnwAdnjY6jlBqWJXTJ8Z0dv95GHjVKqK0s2pmVY2ht7yuklUolYklFCNVHpyYlX4gpoq4NfuaDlAf862xlA== | String | ||
|
Default value on UNIX: |
String | ||
| Integer | |||
| String | |||
| String | |||
| none | String | ||
| String | |||
|
Default value on Microsoft Windows: Default value on UNIX: Default value on HP OpenVMS: |
RemoteDirectory | ||
| String of CSV | |||
| String |
OracleJob Service
OracleJob service runs Oracle jobs.
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 |
| 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 |
|
| User that the process will run as if no other user is specified. Remote: false | |
| Use Oracle DBMS Output? Remote: false | |
| 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 | |
| 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 |
|
| Is the Cronacle v6/7 compatible PL/SQL API available in this (Oracle) database. 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 |
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| false | Boolean | ||
| String | |||
| String | |||
| false | Boolean |
Publish Service
Publish service runs jobs to publish or approve files on a remote server.
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 |
| 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
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 |
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 |
| String |
Script Service
Script service runs RedwoodScript jobs.
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 |
| 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 |
|
| 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 | |
| Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 | |
| Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 | |
| Shared secret used for authentication between the Process Server and the remote Platform Agent. This must match the value for the remote Platform Agent. Remote: false | |
| 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 Platform 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
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 |
|
|
|
|
|
|
|
|
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| String | |||
| lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| String | |||
| {RedwoodSecureStorage}:YvkgnwAdnjY6jlBqWJXTJ8Z0dv95GHjVKqK0s2pmVY2ht7yuklUolYklFCNVHpyYlX4gpoq4NfuaDlAf862xlA== | String | ||
| String |
System Service
System service runs internally defined jobs.
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 |
| 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 |
|
| 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 | |
| Default for process log file name suffix. This is appended to DataRootDirectory to create a file name. Remote: false | |
| 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 | |
| Default for process output file name suffix. This is appended to DataRootDirectory to create a file name. 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 |
|
|
|
|
|
|
|
|
|
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 |
|
Default on Microsoft Windows: Default on UNIX: Default on HP OpenVMS: Default on Java platforms: |
RemoteDirectory | ||
| String | |||
| log${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String | ||
| String | |||
| lis${FileSeparator}${ProcessServer}_${JobId}_${JobFileOrder}.${FormatExtension} | String |