Configuration Entries

Configuration entries are available in multiple backends, the user interface allows you to customize settings using the Registry; settings set in the following backends cannot not overridden using the registry:

Configuration Backends

Configuration entries are specified in backends, each backend carries a weight, lighter backends override heavier ones: Command Line settings override System Properties settings, which override Environment Variables and so on.

The following backends are available:

Backend	Description	Weight
Command Line	Command-line options are specified in the startup script, daemon, or service that starts the central server. This backend is only accessible in on-site environments.	5
System Properties	System properties are specified in the setvars configuration file. This backend is only accessible in on-site environments.	10
Environment Variables	Environment variables are specified in the environment of the central server and read on startup. This backend is only accessible in on-site environments.	15
Global configuration file	The global configuration file is read on startup from <installation_path>/j2ee/cluster/global/conf/server.properties. This backend is only accessible in on-site environments.	20
CronacleFiles	This is a built-in backend to map JAR files on the classpath to hashes. This backend is read-only.	21
Custom backends	You can have one or more custom backends with properties files. This backend is only accessible in on-site environments.	custom weight
Servlet Variables	Servlet variables are specified in the web.xml file of the central Redwood server. This backend is only accessible in on-site environments.	25
Registry	Registry entries are specified in Configuration > Registry.	30
Deprecated System Properties	Deprecated system properties are specified in the setvars configuration file. This backend is only accessible in on-site environments.	80
Deprecated Registry	Deprecated registry entries are specified in Configuration > Registry	90
Default	Default values are read-only.	1000

You use System_Info to inspect current values.

Registry Hives

Registry keys can be set in the Redwood Server registry, which is available under "Configuration > Registry".

note

The Redwood Server registry is a central location for setting system-wide and user settings that are not related to the Microsoft Windows registry. The user interface allows you to customize Redwood Server registry settings.

warning

Take special care when editing the registry as a typo can potentially cause havoc.

When a registry entry does not exist, the default value will be used. Some settings, such as /configuration/jcs/mail/Server, do not have a default value.

The registry is split-up in three hives:

• configuration - system-wide configuration settings are stored here
• system - internal configuration settings are stored here
• user- user configuration settings are stored here

Specifying a Value

Registry entries take values, the following values are supported:

• Enum - a list of valid values is provided, you choose which value you want.
• String - any printable UTF-8 character sequence is accepted.
• Boolean - accepts true or false.
• Filesize - accepts <n><unit>, when <n> is the number and <unit> is either TB,GB,MB,KB,B, B (Bytes) is the default unless otherwise stated.
• Duration - accepts a duration, optionally with a minimum and maximum duration, with the syntax [<n>d<m>h<o>m]<p>.<q>s where:
  • <n> (optional) - number of days.
  • <m> (optional) - number of hours, if days not set.
  • <o> (optional) - number of minutes, if hours not set.
  • <p> - number of seconds.
  • <q> - number of milliseconds.

Configuration Hive

Billing

Billing configurations

ServerURL

The server to contact to submit billing data. This setting is optional.

System property:	-Dbilling.serverurl
Environment variable:	BILLING_SERVERURL
Configuration file:	billing.serverurl
Servlet variables:	<param-name>billing.serverurl</param-name>
Registry entry:	/configuration/jcs/billing/serverurl

String configuration entry, which can take a list of valid values:

• Default: https://billing.runmyjobs.cloud

History

History configurations

JobHistory

The length of time to keep jobs - this is rounded to the nearest day. This setting is optional.

System property:	-Dhistory.jobhistory
Environment variable:	HISTORY_JOBHISTORY
Configuration file:	history.jobhistory
Servlet variables:	<param-name>history.jobhistory</param-name>
Registry entry:	/configuration/jcs/history/jobhistory
Deprecated system property:	-Dconfiguration.history.jobhistory converted from fromDays
Deprecated registry entry:	/configuration/history/jobhistory converted from fromDays

Duration configuration entry:

• Minimum: 0

• Default: 365d

CleanUpSystemLogDirectoryRange

The offset that is used in the job System_DeleteJobFiles to clean up the system log directory; if set, files older than the current timestamp minus this offset are deleted. This setting is optional.

System property:	-Dhistory.cleanupsystemlogdirectoryrange
Environment variable:	HISTORY_CLEANUPSYSTEMLOGDIRECTORYRANGE
Configuration file:	history.cleanupsystemlogdirectoryrange
Servlet variables:	<param-name>history.cleanupsystemlogdirectoryrange</param-name>
Registry entry:	/configuration/jcs/history/cleanupsystemlogdirectoryrange

Period onfiguration entry:

• Minimum: P1D
• Maximum: P1Y

Monitoring

Options for configuring the monitoring. If this group is disabled, all monitoring will be disabled.

RefreshInterval

The time between each update cycle. Increasing this value reduces load on the server, but increases the risk on loosing more data in case of server crash. This setting is mandatory.

System property:	-Dmonitoring.refreshinterval
Environment variable:	MONITORING_REFRESHINTERVAL
Configuration file:	monitoring.refreshinterval
Servlet variables:	<param-name>monitoring.refreshinterval</param-name>
Registry entry:	/configuration/jcs/monitoring/refreshinterval
Deprecated system property:	-Dconfiguration.monitoring.refreshinterval
Deprecated registry entry:	/configuration/monitoring/refreshinterval

Duration configuration entry:

• Minimum: 10

• Default: 30

JMXEnabled

Should JMX information be published. This setting is mandatory.

System property:	-Dmonitoring.jmxenabled
Environment variable:	MONITORING_JMXENABLED
Configuration file:	monitoring.jmxenabled
Servlet variables:	<param-name>monitoring.jmxenabled</param-name>
Registry entry:	/configuration/jcs/monitoring/jmxenabled
Deprecated system property:	-Dconfiguration.monitoring.jmx
Deprecated registry entry:	/configuration/monitoring/jmx

Boolean configuration entry, accepts true or false.

• Default: false

JMXTimeout

Interval between publishing JMX information. This setting is mandatory.

System property:	-Dmonitoring.jmxtimeout
Environment variable:	MONITORING_JMXTIMEOUT
Configuration file:	monitoring.jmxtimeout
Servlet variables:	<param-name>monitoring.jmxtimeout</param-name>
Registry entry:	/configuration/jcs/monitoring/jmxtimeout
Deprecated system property:	-Dconfiguration.monitoring.jmxtimeout
Deprecated registry entry:	/configuration/monitoring/jmxtimeout

Duration configuration entry:

• Minimum: 30

• Default: 60

LoadTimeout

Interval between calculating load. This setting is mandatory.

System property:	-Dmonitoring.loadtimeout
Environment variable:	MONITORING_LOADTIMEOUT
Configuration file:	monitoring.loadtimeout
Servlet variables:	<param-name>monitoring.loadtimeout</param-name>
Registry entry:	/configuration/jcs/monitoring/loadtimeout
Deprecated system property:	-Dconfiguration.monitoring.loadtimeout
Deprecated registry entry:	/configuration/monitoring/loadtimeout

Duration configuration entry:

• Minimum: 5

• Default: 15

LoadDefault

The value to use for the Load when the Process Server can not be contacted or does not return a value. This setting is mandatory.

System property:	-Dmonitoring.loaddefault
Environment variable:	MONITORING_LOADDEFAULT
Configuration file:	monitoring.loaddefault
Servlet variables:	<param-name>monitoring.loaddefault</param-name>
Registry entry:	/configuration/jcs/monitoring/loaddefault
Deprecated system property:	-Dconfiguration.monitoring.loaddefault
Deprecated registry entry:	/configuration/monitoring/loaddefault

Integer configuration entry, which can take a list of valid values:

• Default: 100

TablesExcludePrefix

This is a , separated list of prefixes that will be used to filter out tables from being added to the monitor tree for monitoring. This setting is optional.

System property:	-Dmonitoring.tablesexcludeprefix
Environment variable:	MONITORING_TABLESEXCLUDEPREFIX
Configuration file:	monitoring.tablesexcludeprefix
Servlet variables:	<param-name>monitoring.tablesexcludeprefix</param-name>
Registry entry:	/configuration/jcs/monitoring/tablesexcludeprefix
Deprecated system property:	-Dconfiguration.monitoring.sap.tables.excludePrefix
Deprecated registry entry:	/configuration/monitoring/sap/tables/excludePrefix

This entry takes a string.

RootPathNaming

Defines how entries in the monitor tree should be separated. This setting is optional.

System property:	-Dmonitoring.rootpathnaming
Environment variable:	MONITORING_ROOTPATHNAMING
Configuration file:	monitoring.rootpathnaming
Servlet variables:	<param-name>monitoring.rootpathnaming</param-name>
Registry entry:	/configuration/jcs/monitoring/rootpathnaming
Deprecated system property:	-Dconfiguration.monitoring.MonitorRootPath
Deprecated registry entry:	/configuration/monitoring/MonitorRootPath

Enum configuration entry:

• PartitionColonNonGlobal
• PartitionColonAlways
• PartitionPathAlways
• Default: PartitionColonNonGlobal

RetentionWarning

Options for configuring when a warning should be shown because of poor retention configuration.

Count

Amount of rows in a table to trigger a retention warning if retention is not properly configured. This setting is mandatory.

System property:	-Dretentionwarning.count
Environment variable:	RETENTIONWARNING_COUNT
Configuration file:	retentionwarning.count
Servlet variables:	<param-name>retentionwarning.count</param-name>
Registry entry:	/configuration/jcs/retentionwarning/count
Deprecated system property:	-Dconfiguration.retention.warning.count
Deprecated registry entry:	/configuration/retention/warning/count

Integer configuration entry, which can take a list of valid values:

• Minimum: 0
• Maximum: 10000000

• Default: 100000

Delta

Amount of rows that can get added per day before a warning is shown if retention is not configured properly. This setting is mandatory.

System property:	-Dretentionwarning.delta
Environment variable:	RETENTIONWARNING_DELTA
Configuration file:	retentionwarning.delta
Servlet variables:	<param-name>retentionwarning.delta</param-name>
Registry entry:	/configuration/jcs/retentionwarning/delta
Deprecated system property:	-Dconfiguration.retention.warning.delta
Deprecated registry entry:	/configuration/retention/warning/delta

Integer configuration entry, which can take a list of valid values:

• Minimum: 0
• Maximum: 1000000

• Default: 100000

Ratio

Ration (in percent) of Process Definitions that have retention defined versus not defined before a warning is shown if retention is not configured properly. This setting is mandatory.

System property:	-Dretentionwarning.ratio
Environment variable:	RETENTIONWARNING_RATIO
Configuration file:	retentionwarning.ratio
Servlet variables:	<param-name>retentionwarning.ratio</param-name>
Registry entry:	/configuration/jcs/retentionwarning/ratio
Deprecated system property:	-Dconfiguration.retention.warning.ratio
Deprecated registry entry:	/configuration/retention/warning/ratio

Integer configuration entry, which can take a list of valid values:

• Minimum: 80
• Maximum: 100

• Default: 80

SupportServlet

Options for configuring the support servlet.

SystemJob

Configuration for the system jobs.

CollectJobOutputMaxSize

The maximum size of the zip created by System_CollectJobOutput. This setting is optional.

System property:	-Dsystemjob.collectjoboutputmaxsize
Environment variable:	SYSTEMJOB_COLLECTJOBOUTPUTMAXSIZE
Configuration file:	systemjob.collectjoboutputmaxsize
Servlet variables:	<param-name>systemjob.collectjoboutputmaxsize</param-name>
Registry entry:	/configuration/jcs/systemjob/collectjoboutputmaxsize

Filesize configuration entry:

• Default: 1GB

MonitorTablesThreshold

The threshold used in System_MonitorTables to check if the table growth should be taken into account; only tables with more than this number of rows are included in the output. This setting is optional.

System property:	-Dsystemjob.monitortablesthreshold
Environment variable:	SYSTEMJOB_MONITORTABLESTHRESHOLD
Configuration file:	systemjob.monitortablesthreshold
Servlet variables:	<param-name>systemjob.monitortablesthreshold</param-name>
Registry entry:	/configuration/jcs/systemjob/monitortablesthreshold

Integer configuration entry, which can take a list of valid values:

• Minimum: 100
• Maximum: 1000000

• Default: 10000

SchemaInitialization

Configuration for the schema initialization at start up.

UpgradeOnStartup

Checks if the system may upgrade at startup. If so, it generates the DDL changes and applies them. If not, it checks that no DDL changes are needed (if changes are needed, startup will fail). This setting is optional.

System property:	-Dschemainitialization.upgradeonstartup
Environment variable:	SCHEMAINITIALIZATION_UPGRADEONSTARTUP
Configuration file:	schemainitialization.upgradeonstartup
Servlet variables:	<param-name>schemainitialization.upgradeonstartup</param-name>
Registry entry:	/configuration/jcs/schemainitialization/upgradeonstartup
Deprecated system property:	-Dconfiguration.selfupgrade
Deprecated registry entry:	/configuration/selfupgrade

Boolean configuration entry, accepts true or false.

• Default: false

Profiling

Profiling configuration

DefaultRetentionForOperatorMessages

Default retention for operator messages, time after they will be deleted by default

RetentionDuration

Duration amount of operator messages retention This setting is optional.

System property:	-Ddefaultretentionforoperatormessages.retentionduration
Environment variable:	DEFAULTRETENTIONFOROPERATORMESSAGES_RETENTIONDURATION
Configuration file:	defaultretentionforoperatormessages.retentionduration
Servlet variables:	<param-name>defaultretentionforoperatormessages.retentionduration</param-name>
Registry entry:	/configuration/jcs/defaultretentionforoperatormessages/retentionduration

Duration configuration entry:

• Minimum: 0

• Default: 91D

DBAuth

Options for the Database Authentication

USERMANAGEMENT_URL_DISABLED

The sentinel value to disable the UserManagement URL This setting is optional.

System property:	-Dsecurity.dbauth.usermanagement_url_disabled
Environment variable:	SECURITY_DBAUTH_USERMANAGEMENT_URL_DISABLED
Configuration file:	security.dbauth.usermanagement_url_disabled
Servlet variables:	<param-name>security.dbauth.usermanagement_url_disabled</param-name>
Registry entry:	/configuration/jcs/security/dbauth/usermanagement_url_disabled

String configuration entry, which can take a list of valid values:

• Default: disabled

UserManagementURL

The URL for the external user management provider. It can be disabled so no URL is displayed by using the constant USERMANAGEMENT_URL_DISABLED as the value. The value can contain the wildcard ${contextpath} which will replace the string with the context path of the host. This setting is optional.

System property:	-Dsecurity.dbauth.usermanagementurl
Environment variable:	SECURITY_DBAUTH_USERMANAGEMENTURL
Configuration file:	security.dbauth.usermanagementurl
Servlet variables:	<param-name>security.dbauth.usermanagementurl</param-name>
Registry entry:	/configuration/jcs/security/dbauth/usermanagementurl

String configuration entry, which can take a list of valid values:

• Default: ${contextpath}/ui/react/?Page=DatabaseUserAdminPage

BCrypt

If BCrypt is supported for use with the external database authentication provider This setting is optional.

System property:	-Dsecurity.dbauth.bcrypt
Environment variable:	SECURITY_DBAUTH_BCRYPT
Configuration file:	security.dbauth.bcrypt
Servlet variables:	<param-name>security.dbauth.bcrypt</param-name>
Registry entry:	/configuration/jcs/security/dbauth/bcrypt
Deprecated system property:	-Djdbc.bcrypt
Deprecated registry entry:	/jdbc/bcrypt

Boolean configuration entry, accepts true or false.

• Default: false

Locations

The location of files and directories on the Redwood Platform

Gateway

The Secure Gateway is a VPN implementation that allows safe operation of networking operations taking place in our cloud servers. It works by forwarding all customer instigated traffic to the customer network.

ContextURL

The Context URL for the secure gateway This setting is optional.

System property:	-Dsecurity.gateway.contexturl
Environment variable:	SECURITY_GATEWAY_CONTEXTURL
Configuration file:	security.gateway.contexturl
Servlet variables:	<param-name>security.gateway.contexturl</param-name>
Registry entry:	/configuration/jcs/security/gateway/contexturl

This entry takes a string.

ContextPath

If the ContextURL is not defined, then the context path is added to the security.contexturl. This should not contain any leading slash. This setting is optional.

System property:	-Dsecurity.gateway.contextpath
Environment variable:	SECURITY_GATEWAY_CONTEXTPATH
Configuration file:	security.gateway.contextpath
Servlet variables:	<param-name>security.gateway.contextpath</param-name>
Registry entry:	/configuration/jcs/security/gateway/contextpath

String configuration entry, which can take a list of valid values:

• Default: securegateway

ListenerPortOffset

The offset to use from the Server Port This setting is mandatory.

System property:	-Dsecurity.gateway.listenerportoffset
Environment variable:	SECURITY_GATEWAY_LISTENERPORTOFFSET
Configuration file:	security.gateway.listenerportoffset
Servlet variables:	<param-name>security.gateway.listenerportoffset</param-name>
Registry entry:	/configuration/jcs/security/gateway/listenerportoffset

Integer configuration entry, which can take a list of valid values:

• Default: 8

ForwardPortOffset

The offset from the ListenerPort to use for the Forward Port This setting is mandatory.

System property:	-Dsecurity.gateway.forwardportoffset
Environment variable:	SECURITY_GATEWAY_FORWARDPORTOFFSET
Configuration file:	security.gateway.forwardportoffset
Servlet variables:	<param-name>security.gateway.forwardportoffset</param-name>
Registry entry:	/configuration/jcs/security/gateway/forwardportoffset

Integer configuration entry, which can take a list of valid values:

• Default: 1

RestartTimeout

The duration to wait before restarting proxy processor if there is an error to avoid spinning the startup. This setting is optional.

System property:	-Dsecurity.gateway.restarttimeout
Environment variable:	SECURITY_GATEWAY_RESTARTTIMEOUT
Configuration file:	security.gateway.restarttimeout
Servlet variables:	<param-name>security.gateway.restarttimeout</param-name>
Registry entry:	/configuration/jcs/security/gateway/restarttimeout

Duration configuration entry:

• Minimum: 0

• Default: 60

ServerNameIdentifier

The ServerNameIdentifier to enforce use of when connecting to the server. This setting is optional.

System property:	-Dsecurity.gateway.servernameidentifier
Environment variable:	SECURITY_GATEWAY_SERVERNAMEIDENTIFIER
Configuration file:	security.gateway.servernameidentifier
Servlet variables:	<param-name>security.gateway.servernameidentifier</param-name>
Registry entry:	/configuration/jcs/security/gateway/servernameidentifier

This entry takes a string.

Servers

The server listener port configurations. The key is the business key of the platform agent. This setting is optional.

System property:	-Dsecurity.gateway.servers
Environment variable:	SECURITY_GATEWAY_SERVERS
Configuration file:	security.gateway.servers
Servlet variables:	<param-name>security.gateway.servers</param-name>
Registry entry:	/configuration/jcs/security/gateway/servers
Deprecated system property:	-Dconfiguration.security.gateway.servers
Deprecated registry entry:	/configuration/security/gateway/servers

Map configuration entry:

Key:

This entry takes a string.

Value:

This entry takes a string.

ACL

The Access Control List. The key is always the number for processing order, the value is the rule. This setting is optional.

System property:	-Dsecurity.gateway.acl
Environment variable:	SECURITY_GATEWAY_ACL
Configuration file:	security.gateway.acl
Servlet variables:	<param-name>security.gateway.acl</param-name>
Registry entry:	/configuration/jcs/security/gateway/acl

Map configuration entry:

Key:

Integer configuration entry, which can take a list of valid values:

Value:

This entry takes a string.

Alert

Do we need alerting when the Secure Gateway is down. When the Proxy-Processor returns the process in Java a check is done to see if any of the Secure Gateway Candidates are configured. If not the Alert is sent.

AlertUrl

The Alert url to send the alert to. This setting is mandatory.

System property:	-Dsecurity.gateway.alert.alerturl
Environment variable:	SECURITY.GATEWAY_ALERT_ALERTURL
Configuration file:	security.gateway.alert.alerturl
Servlet variables:	<param-name>security.gateway.alert.alerturl</param-name>
Registry entry:	/configuration/jcs/security.gateway/alert/alerturl

This entry takes a string.

AlertAPIToken

The Alert API Token to send with the request in the X-API-TOKEN header. This setting is mandatory.

System property:	-Dsecurity.gateway.alert.alertapitoken
Environment variable:	SECURITY.GATEWAY_ALERT_ALERTAPITOKEN
Configuration file:	security.gateway.alert.alertapitoken
Servlet variables:	<param-name>security.gateway.alert.alertapitoken</param-name>
Registry entry:	/configuration/jcs/security.gateway/alert/alertapitoken

This entry takes a string.

InformOnDown

Do we need to inform the customer when the Secure Gateway is down? This setting is optional.

System property:	-Dsecurity.gateway.alert.informondown
Environment variable:	SECURITY.GATEWAY_ALERT_INFORMONDOWN
Configuration file:	security.gateway.alert.informondown
Servlet variables:	<param-name>security.gateway.alert.informondown</param-name>
Registry entry:	/configuration/jcs/security.gateway/alert/informondown

Boolean configuration entry, accepts true or false.

• Default: true

AlertHeaderOnDown

The Header that is sent in the alert when the Secure Gateway is down. This setting is mandatory.

System property:	-Dsecurity.gateway.alert.alertheaderondown
Environment variable:	SECURITY.GATEWAY_ALERT_ALERTHEADERONDOWN
Configuration file:	security.gateway.alert.alertheaderondown
Servlet variables:	<param-name>security.gateway.alert.alertheaderondown</param-name>
Registry entry:	/configuration/jcs/security.gateway/alert/alertheaderondown

String configuration entry, which can take a list of valid values:

• Default: Secure Gateway down

AlertBodyOnDown

The body that is sent to the customer when the alert is sent when the Secure gateway is down. This setting is mandatory.

System property:	-Dsecurity.gateway.alert.alertbodyondown
Environment variable:	SECURITY.GATEWAY_ALERT_ALERTBODYONDOWN
Configuration file:	security.gateway.alert.alertbodyondown
Servlet variables:	<param-name>security.gateway.alert.alertbodyondown</param-name>
Registry entry:	/configuration/jcs/security.gateway/alert/alertbodyondown

String configuration entry, which can take a list of valid values:

• Default: Secure Gateway down

InformOnUp

Do we need to inform the customer when the Secure Gateway is up again? This message will only be send if the Secure Gateway went down unexpected. This setting is optional.

System property:	-Dsecurity.gateway.alert.informonup
Environment variable:	SECURITY.GATEWAY_ALERT_INFORMONUP
Configuration file:	security.gateway.alert.informonup
Servlet variables:	<param-name>security.gateway.alert.informonup</param-name>
Registry entry:	/configuration/jcs/security.gateway/alert/informonup

Boolean configuration entry, accepts true or false.

• Default: true

AlertHeaderOnUp

The Header that is sent in the alert when the Secure Gateway is up again. This setting is mandatory.

System property:	-Dsecurity.gateway.alert.alertheaderonup
Environment variable:	SECURITY.GATEWAY_ALERT_ALERTHEADERONUP
Configuration file:	security.gateway.alert.alertheaderonup
Servlet variables:	<param-name>security.gateway.alert.alertheaderonup</param-name>
Registry entry:	/configuration/jcs/security.gateway/alert/alertheaderonup

String configuration entry, which can take a list of valid values:

• Default: Secure Gateway is up again

AlertBodyOnUp

The body that is sent to the customer when the alert is sent when the Secure Gateway is up again. This setting is mandatory.

System property:	-Dsecurity.gateway.alert.alertbodyonup
Environment variable:	SECURITY.GATEWAY_ALERT_ALERTBODYONUP
Configuration file:	security.gateway.alert.alertbodyonup
Servlet variables:	<param-name>security.gateway.alert.alertbodyonup</param-name>
Registry entry:	/configuration/jcs/security.gateway/alert/alertbodyonup

String configuration entry, which can take a list of valid values:

• Default: Secure Gateway is up and running again

PlatformAgent

The server side configuration settings for the PlatformAgent

InstallationKey

Get the random value used to authenticate server installations that want to register a process server. This setting is optional.

System property:	-Dplatformagent.installationkey
Environment variable:	PLATFORMAGENT_INSTALLATIONKEY
Configuration file:	platformagent.installationkey
Servlet variables:	<param-name>platformagent.installationkey</param-name>
Registry entry:	/configuration/jcs/platformagent/installationkey
Deprecated system property:	-Dconfiguration.platformagent.key
Deprecated registry entry:	/configuration/platformagent/key

This entry takes a string.

SimplifiedInstallation

The installation process is simplified and automatic values are supplied. This setting is optional.

System property:	-Dplatformagent.simplifiedinstallation
Environment variable:	PLATFORMAGENT_SIMPLIFIEDINSTALLATION
Configuration file:	platformagent.simplifiedinstallation
Servlet variables:	<param-name>platformagent.simplifiedinstallation</param-name>
Registry entry:	/configuration/jcs/platformagent/simplifiedinstallation
Deprecated system property:	-Dconfiguration.platformagent.simplifiedinstallation
Deprecated registry entry:	/configuration/platformagent/simplifiedinstallation

Boolean configuration entry, accepts true or false.

• Default: false

AgentInitiated

Platform Agent installers are agent initiated. This setting is mandatory.

System property:	-Dplatformagent.agentinitiated
Environment variable:	PLATFORMAGENT_AGENTINITIATED
Configuration file:	platformagent.agentinitiated
Servlet variables:	<param-name>platformagent.agentinitiated</param-name>
Registry entry:	/configuration/jcs/platformagent/agentinitiated
Deprecated system property:	-Dconfiguration.platformagent.agentinitiatedonly
Deprecated registry entry:	/configuration/platformagent/agentinitiatedonly

Boolean configuration entry, accepts true or false.

• Default: false

AgentInitiatedRoles

The comma separated list of roles that This setting is optional.

System property:	-Dplatformagent.agentinitiatedroles
Environment variable:	PLATFORMAGENT_AGENTINITIATEDROLES
Configuration file:	platformagent.agentinitiatedroles
Servlet variables:	<param-name>platformagent.agentinitiatedroles</param-name>
Registry entry:	/configuration/jcs/platformagent/agentinitiatedroles
Deprecated system property:	-Dconfiguration.platformagent.agentinitiatedonly converted from trueOrList
Deprecated registry entry:	/configuration/platformagent/agentinitiatedonly converted from trueOrList

This entry takes a string.

DefaultQueueList

The default queues to associate a newly register Platform Agent with. This setting is mandatory.

System property:	-Dplatformagent.defaultqueuelist
Environment variable:	PLATFORMAGENT_DEFAULTQUEUELIST
Configuration file:	platformagent.defaultqueuelist
Servlet variables:	<param-name>platformagent.defaultqueuelist</param-name>
Registry entry:	/configuration/jcs/platformagent/defaultqueuelist
Deprecated system property:	-Dconfiguration.PlatformAgentRegistration.QueueList
Deprecated registry entry:	/configuration/PlatformAgentRegistration/QueueList

String configuration entry, which can take a list of valid values:

• Default: System

DefaultTimeZone

The default timezone to use when registering a platform agent if it isn't provided. If this is not set then the system default timezone is used. This setting is optional.

System property:	-Dplatformagent.defaulttimezone
Environment variable:	PLATFORMAGENT_DEFAULTTIMEZONE
Configuration file:	platformagent.defaulttimezone
Servlet variables:	<param-name>platformagent.defaulttimezone</param-name>
Registry entry:	/configuration/jcs/platformagent/defaulttimezone
Deprecated system property:	-Dconfiguration.PlatformAgentRegistration.TimeZone
Deprecated registry entry:	/configuration/PlatformAgentRegistration/TimeZone

This entry takes a string.

WindowsLocalInterpreterBits

Whether the default CMD runs as 32 or as 64 bit process on a 64 bit server. This setting is mandatory.

System property:	-Dplatformagent.windowslocalinterpreterbits
Environment variable:	PLATFORMAGENT_WINDOWSLOCALINTERPRETERBITS
Configuration file:	platformagent.windowslocalinterpreterbits
Servlet variables:	<param-name>platformagent.windowslocalinterpreterbits</param-name>
Registry entry:	/configuration/jcs/platformagent/windowslocalinterpreterbits
Deprecated system property:	-Dconfiguration.PlatformAgent.Windows.LocalInterpreterBits
Deprecated registry entry:	/configuration/PlatformAgent/Windows/LocalInterpreterBits

Integer configuration entry, which can take a list of valid values:

• Default: 32

DynamicIPAddresses

During registration of ServerInitiated agents or connect of AgentInitiated agents the IP addresses are added to RemoteHostNameWhitelist and used as fallback for connection (SI mode) or as validator for the current allowed list of hosts that can connect (AI mode). Set this to true in an environment where IP addresses are dynamic in nature. This setting is optional.

System property:	-Dplatformagent.dynamicipaddresses
Environment variable:	PLATFORMAGENT_DYNAMICIPADDRESSES
Configuration file:	platformagent.dynamicipaddresses
Servlet variables:	<param-name>platformagent.dynamicipaddresses</param-name>
Registry entry:	/configuration/jcs/platformagent/dynamicipaddresses

Boolean configuration entry, accepts true or false.

• Default: false

MaxUpdateAttempts

How many times the system attempts auto-update before stopping the process server. This setting is mandatory.

System property:	-Dplatformagent.maxupdateattempts
Environment variable:	PLATFORMAGENT_MAXUPDATEATTEMPTS
Configuration file:	platformagent.maxupdateattempts
Servlet variables:	<param-name>platformagent.maxupdateattempts</param-name>
Registry entry:	/configuration/jcs/platformagent/maxupdateattempts

Integer configuration entry, which can take a list of valid values:

• Default: 5

MaxUpdateViaURLAttempts

How many times the system attempts auto-update via retrieval by URL before stopping the process server. Downloading via an URL saves a lot of server side memory so it is more efficient, especially when there are many platform agents. This setting is mandatory.

System property:	-Dplatformagent.maxupdateviaurlattempts
Environment variable:	PLATFORMAGENT_MAXUPDATEVIAURLATTEMPTS
Configuration file:	platformagent.maxupdateviaurlattempts
Servlet variables:	<param-name>platformagent.maxupdateviaurlattempts</param-name>
Registry entry:	/configuration/jcs/platformagent/maxupdateviaurlattempts

Integer configuration entry, which can take a list of valid values:

• Default: 2

Database

The Database Storage implementation configuration

CleanTime

The time to keep files in the cache for from creation. This setting is mandatory.

System property:	-Dstorage.database.cleantime
Environment variable:	STORAGE_DATABASE_CLEANTIME
Configuration file:	storage.database.cleantime
Servlet variables:	<param-name>storage.database.cleantime</param-name>
Registry entry:	/configuration/jcs/storage/database/cleantime

Duration configuration entry:

• Minimum: 0

• Default: 7D

FileCache

The Storage FileCache implementation configuration

CacheDirectory

The directory to store the local cache files This setting is mandatory.

System property:	-Dstorage.filecache.cachedirectory
Environment variable:	STORAGE_FILECACHE_CACHEDIRECTORY
Configuration file:	storage.filecache.cachedirectory
Servlet variables:	<param-name>storage.filecache.cachedirectory</param-name>
Registry entry:	/configuration/jcs/storage/filecache/cachedirectory

String configuration entry, which can take a list of valid values:

• Default: new java.io.File(com.redwood.scheduler.infrastructure.systemid.SystemId.getJavaWorkDirectory(), "storagecache").getAbsolutePath()

ClearCacheOnStartup

If the storage cache directory should be cleared on startup. This setting is mandatory.

System property:	-Dstorage.filecache.clearcacheonstartup
Environment variable:	STORAGE_FILECACHE_CLEARCACHEONSTARTUP
Configuration file:	storage.filecache.clearcacheonstartup
Servlet variables:	<param-name>storage.filecache.clearcacheonstartup</param-name>
Registry entry:	/configuration/jcs/storage/filecache/clearcacheonstartup

Boolean configuration entry, accepts true or false.

• Default: false

MaximumSize

The maximum size of the file storage cache. This is a hard limit and will clear the cache while in the process of writing out data. If there is insufficient allocation in the cache then the write will fail. This setting is optional.

System property:	-Dstorage.filecache.maximumsize
Environment variable:	STORAGE_FILECACHE_MAXIMUMSIZE
Configuration file:	storage.filecache.maximumsize
Servlet variables:	<param-name>storage.filecache.maximumsize</param-name>
Registry entry:	/configuration/jcs/storage/filecache/maximumsize

Filesize configuration entry:

• Default: 500MB

Configuration

Options to configure the configuration module.

CustomBackends

JSON string defining additional back ends. This setting is optional.

System property:	-Dconfiguration.custombackends
Environment variable:	CONFIGURATION_CUSTOMBACKENDS
Configuration file:	configuration.custombackends
Servlet variables:	<param-name>configuration.custombackends</param-name>
Registry entry:	/configuration/jcs/configuration/custombackends

This entry takes a string.

SchedulerSessionFactory

All of the options required to configure the schedulersessionfactory

Type

The type of database connection we're going to use. Depending on this field, either the jdbcSession or the DatasourceSession need to be provided. This setting is mandatory.

System property:	-Dschedulersessionfactory.type
Environment variable:	SCHEDULERSESSIONFACTORY_TYPE
Configuration file:	schedulersessionfactory.type
Servlet variables:	<param-name>schedulersessionfactory.type</param-name>
Registry entry:	/configuration/jcs/schedulersessionfactory/type

Enum configuration entry:

• auto
• jdbc
• jndi
• Default: jdbc

JdbcSession

These configuration settings are not validated on startup.

Options to configure a JDBC connection.

DriverClass

Which class do we need to instantiate to get this driver working This setting is mandatory and incorrectly setting this will prevent startup.

System property:	-Djdbcsession.driverclass
Environment variable:	JDBCSESSION_DRIVERCLASS
Configuration file:	jdbcsession.driverclass
Servlet variables:	<param-name>jdbcsession.driverclass</param-name>

Class configuration entry descends from java.sql.Driver, which can take a list of valid values:

URL

The JDBC URL needed to connect to the database This setting is mandatory and incorrectly setting this will prevent startup.

System property:	-Djdbcsession.url
Environment variable:	JDBCSESSION_URL
Configuration file:	jdbcsession.url
Servlet variables:	<param-name>jdbcsession.url</param-name>

This entry takes a string.

Username

The username to use when connecting to the database This setting is optional.

System property:	-Djdbcsession.username
Environment variable:	JDBCSESSION_USERNAME
Configuration file:	jdbcsession.username
Servlet variables:	<param-name>jdbcsession.username</param-name>

This entry takes a string.

Password

The password to use when connecting to the database This setting is optional.

System property:	-Djdbcsession.password
Environment variable:	JDBCSESSION_PASSWORD
Configuration file:	jdbcsession.password
Servlet variables:	<param-name>jdbcsession.password</param-name>

Password configuration entry, which can take a list of valid values, plain-text passwords are permitted

DatasourceSession

These configuration settings are not validated on startup.

Options to configure a Datasource connection.

ControlDataSource

The path of the jndi DataSource that gives out database control connections. This must NOT be XA. This setting is mandatory.

System property:	-Ddatasourcesession.controldatasource
Environment variable:	DATASOURCESESSION_CONTROLDATASOURCE
Configuration file:	datasourcesession.controldatasource
Servlet variables:	<param-name>datasourcesession.controldatasource</param-name>
Registry entry:	/configuration/jcs/datasourcesession/controldatasource

This entry takes a string.

UserDataSource

The path of the jndi DataSource that gives out database user connections. Future versions will support XA on this datasource. This setting is mandatory.

System property:	-Ddatasourcesession.userdatasource
Environment variable:	DATASOURCESESSION_USERDATASOURCE
Configuration file:	datasourcesession.userdatasource
Servlet variables:	<param-name>datasourcesession.userdatasource</param-name>
Registry entry:	/configuration/jcs/datasourcesession/userdatasource

This entry takes a string.

SessionParameters

Options for the Scheduler.

SequenceBufferSize

The number of sequence keys to buffer. This setting is mandatory.

System property:	-Dsessionparameters.sequencebuffersize
Environment variable:	SESSIONPARAMETERS_SEQUENCEBUFFERSIZE
Configuration file:	sessionparameters.sequencebuffersize
Servlet variables:	<param-name>sessionparameters.sequencebuffersize</param-name>
Registry entry:	/configuration/jcs/sessionparameters/sequencebuffersize

Integer configuration entry, which can take a list of valid values:

• Minimum: 1
• Maximum: 100

• Default: 50

QueryTimeout

SQL Query Timeout in Duration. A value of 0 disables the timeout. This setting is mandatory.

System property:	-Dsessionparameters.querytimeout
Environment variable:	SESSIONPARAMETERS_QUERYTIMEOUT
Configuration file:	sessionparameters.querytimeout
Servlet variables:	<param-name>sessionparameters.querytimeout</param-name>
Registry entry:	/configuration/jcs/sessionparameters/querytimeout

Duration configuration entry:

• Minimum: 0

• Default: 180s

HLQueryCache

Options for the Scheduler.

SystemSize

The total size of system SQL queries to cache from HL to LL SQL. This setting is mandatory.

System property:	-Dpersistence.hlquerycache.systemsize
Environment variable:	PERSISTENCE_HLQUERYCACHE_SYSTEMSIZE
Configuration file:	persistence.hlquerycache.systemsize
Servlet variables:	<param-name>persistence.hlquerycache.systemsize</param-name>
Registry entry:	/configuration/jcs/persistence/hlquerycache/systemsize

Filesize configuration entry:

• Default: 5M

UserSize

The total size of user SQL queries to cache from HL to LL SQL. This setting is mandatory.

System property:	-Dpersistence.hlquerycache.usersize
Environment variable:	PERSISTENCE_HLQUERYCACHE_USERSIZE
Configuration file:	persistence.hlquerycache.usersize
Servlet variables:	<param-name>persistence.hlquerycache.usersize</param-name>
Registry entry:	/configuration/jcs/persistence/hlquerycache/usersize

Filesize configuration entry:

• Default: 2M

Etcd

Options for the external configuration project

URL

The (base) URL of the etcd cluster. This setting is mandatory.

System property:	-Detcd.url
Environment variable:	ETCD_URL
Configuration file:	etcd.url
Servlet variables:	<param-name>etcd.url</param-name>

This entry takes a string.

Username

The username for fetching the auth token. This setting is mandatory.

System property:	-Detcd.username
Environment variable:	ETCD_USERNAME
Configuration file:	etcd.username
Servlet variables:	<param-name>etcd.username</param-name>

This entry takes a string.

Password

The password for fetching the auth token. This setting is mandatory.

System property:	-Detcd.password
Environment variable:	ETCD_PASSWORD
Configuration file:	etcd.password
Servlet variables:	<param-name>etcd.password</param-name>

Password configuration entry, which can take a list of valid values, plain-text passwords will cause a warning to be logged

ReconnectBackoffDuration

The duration that should be waited before attempting to reconnect after the watch connection to etcd fails. This setting is mandatory.

System property:	-Detcd.reconnectbackoffduration
Environment variable:	ETCD_RECONNECTBACKOFFDURATION
Configuration file:	etcd.reconnectbackoffduration
Servlet variables:	<param-name>etcd.reconnectbackoffduration</param-name>

Duration configuration entry:

• Minimum: 1s

• Default: 30s

ConfigurationBackends

A map of backends with the key being the backend name and the value a colon seperated pair containing the priority and the namespace. This setting is mandatory.

System property:	-Detcd.configurationbackends
Environment variable:	ETCD_CONFIGURATIONBACKENDS
Configuration file:	etcd.configurationbackends
Servlet variables:	<param-name>etcd.configurationbackends</param-name>

Map configuration entry:

Key:

This entry takes a string.

Value:

This entry takes a string.

SNMPDefaults

Default options for the SNMP monitoring

Host

Host where to send the SNMP traps to This setting is optional.

System property:	-Dsnmpdefaults.host
Environment variable:	SNMPDEFAULTS_HOST
Configuration file:	snmpdefaults.host
Servlet variables:	<param-name>snmpdefaults.host</param-name>
Registry entry:	/configuration/jcs/snmpdefaults/host
Deprecated system property:	-Dconfiguration.snmp.host
Deprecated registry entry:	/configuration/snmp/host

This entry takes a string.

Port

Port on the host where to send the SNMP traps to This setting is optional.

System property:	-Dsnmpdefaults.port
Environment variable:	SNMPDEFAULTS_PORT
Configuration file:	snmpdefaults.port
Servlet variables:	<param-name>snmpdefaults.port</param-name>
Registry entry:	/configuration/jcs/snmpdefaults/port
Deprecated system property:	-Dconfiguration.snmp.port
Deprecated registry entry:	/configuration/snmp/port

Integer configuration entry, which can take a list of valid values:

Community

Community that is encoded This setting is optional.

System property:	-Dsnmpdefaults.community
Environment variable:	SNMPDEFAULTS_COMMUNITY
Configuration file:	snmpdefaults.community
Servlet variables:	<param-name>snmpdefaults.community</param-name>
Registry entry:	/configuration/jcs/snmpdefaults/community
Deprecated system property:	-Dconfiguration.snmp.community
Deprecated registry entry:	/configuration/snmp/community

This entry takes a string.

Id

First of 2 parameters that are sent as content of the trap This setting is optional.

System property:	-Dsnmpdefaults.id
Environment variable:	SNMPDEFAULTS_ID
Configuration file:	snmpdefaults.id
Servlet variables:	<param-name>snmpdefaults.id</param-name>
Registry entry:	/configuration/jcs/snmpdefaults/id
Deprecated system property:	-Dconfiguration.snmp.id
Deprecated registry entry:	/configuration/snmp/id

Integer configuration entry, which can take a list of valid values:

Data

Second of 2 parameters that are sent as content of the trap This setting is optional.

System property:	-Dsnmpdefaults.data
Environment variable:	SNMPDEFAULTS_DATA
Configuration file:	snmpdefaults.data
Servlet variables:	<param-name>snmpdefaults.data</param-name>
Registry entry:	/configuration/jcs/snmpdefaults/data
Deprecated system property:	-Dconfiguration.snmp.data
Deprecated registry entry:	/configuration/snmp/data

This entry takes a string.

UnitOfWork

All of the options required to configure the API

DatabaseRetries

The number of times to retry a persist in the face of competition. This setting is mandatory.

System property:	-Dunitofwork.databaseretries
Environment variable:	UNITOFWORK_DATABASERETRIES
Configuration file:	unitofwork.databaseretries
Servlet variables:	<param-name>unitofwork.databaseretries</param-name>
Registry entry:	/configuration/jcs/unitofwork/databaseretries
Deprecated system property:	-Dconfiguration.api.DatabaseRetries
Deprecated registry entry:	/configuration/api/DatabaseRetries

Integer configuration entry, which can take a list of valid values:

• Minimum: 1
• Maximum: 45

• Default: 18

DatabaseSpin

The number of times to immediately retry (spin) the persist instead of pausing. This value should be less than or equal to the number of retries for it to make sense. This setting is mandatory.

System property:	-Dunitofwork.databasespin
Environment variable:	UNITOFWORK_DATABASESPIN
Configuration file:	unitofwork.databasespin
Servlet variables:	<param-name>unitofwork.databasespin</param-name>
Registry entry:	/configuration/jcs/unitofwork/databasespin
Deprecated system property:	-Dconfiguration.api.DatabaseSpin
Deprecated registry entry:	/configuration/api/DatabaseSpin

Integer configuration entry, which can take a list of valid values:

• Minimum: 0
• Maximum: 10

• Default: 2

DatabaseRetryMaxInitialBackoff

The maximum number of milliseconds to wait before the first non-spinning retry. The actual backoff time will be a random value between DatabaseRetryMinInitialBackoff and this (inclusive). (Subsequent retries grow in an exponential manner.) This setting is mandatory.

System property:	-Dunitofwork.databaseretrymaxinitialbackoff
Environment variable:	UNITOFWORK_DATABASERETRYMAXINITIALBACKOFF
Configuration file:	unitofwork.databaseretrymaxinitialbackoff
Servlet variables:	<param-name>unitofwork.databaseretrymaxinitialbackoff</param-name>
Registry entry:	/configuration/jcs/unitofwork/databaseretrymaxinitialbackoff
Deprecated system property:	-Dconfiguration.api.DatabaseRetryMaxInitialBackoff converted from fromMillis
Deprecated registry entry:	/configuration/api/DatabaseRetryMaxInitialBackoff converted from fromMillis

Duration configuration entry:

• Minimum: 0.01
• Maximum: 0.250

• Default: 0.05

DatabaseRetryMinInitialBackoff

The minimum number of milliseconds to wait before the first non-spinning retry. The actual backoff time will be a random value between this and DatabaseRetryMaxInitialBackoff. (Subsequent retries grow in an exponential manner.) This setting is mandatory.

System property:	-Dunitofwork.databaseretrymininitialbackoff
Environment variable:	UNITOFWORK_DATABASERETRYMININITIALBACKOFF
Configuration file:	unitofwork.databaseretrymininitialbackoff
Servlet variables:	<param-name>unitofwork.databaseretrymininitialbackoff</param-name>
Registry entry:	/configuration/jcs/unitofwork/databaseretrymininitialbackoff
Deprecated system property:	-Dconfiguration.api.DatabaseRetryMinInitialBackoff converted from fromMillis
Deprecated registry entry:	/configuration/api/DatabaseRetryMinInitialBackoff converted from fromMillis

Duration configuration entry:

• Minimum: 0.001
• Maximum: 0.100

• Default: 0.005

System

System configuration settings.

Id

The basic identifier for the system. This setting is optional.

System property:	-Dsystem.id
Environment variable:	SYSTEM_ID
Configuration file:	system.id
Servlet variables:	<param-name>system.id</param-name>

String configuration entry, which can take a list of valid values:

• Default: com.redwood.scheduler.infrastructure.systemid.SystemId.getSystemId()

Mail

The Mail configurations

Server

The default server to send mail through This setting is optional.

System property:	-Dmail.server
Environment variable:	MAIL_SERVER
Configuration file:	mail.server
Servlet variables:	<param-name>mail.server</param-name>
Registry entry:	/configuration/jcs/mail/server
Deprecated system property:	-Dconfiguration.mail.Server
Deprecated registry entry:	/configuration/mail/Server

This entry takes a string.

Transport

The transport type to send mail This setting is mandatory.

System property:	-Dmail.transport
Environment variable:	MAIL_TRANSPORT
Configuration file:	mail.transport
Servlet variables:	<param-name>mail.transport</param-name>
Registry entry:	/configuration/jcs/mail/transport
Deprecated system property:	-Dconfiguration.mail.Transport
Deprecated registry entry:	/configuration/mail/Transport

Enum configuration entry:

• smtp
• smtps
• Default: smtp

Port

The server port to send mail through This setting is optional.

System property:	-Dmail.port
Environment variable:	MAIL_PORT
Configuration file:	mail.port
Servlet variables:	<param-name>mail.port</param-name>
Registry entry:	/configuration/jcs/mail/port
Deprecated system property:	-Dconfiguration.mail.Port
Deprecated registry entry:	/configuration/mail/Port

Integer configuration entry, which can take a list of valid values:

• Minimum: 0
• Maximum: 65535

From

The default email address to send mail from This setting is optional.

System property:	-Dmail.from
Environment variable:	MAIL_FROM
Configuration file:	mail.from
Servlet variables:	<param-name>mail.from</param-name>
Registry entry:	/configuration/jcs/mail/from
Deprecated system property:	-Dconfiguration.mail.From
Deprecated registry entry:	/configuration/mail/From

This entry takes a string.

User

The default user to authenticate with the mail server This setting is optional.

System property:	-Dmail.user
Environment variable:	MAIL_USER
Configuration file:	mail.user
Servlet variables:	<param-name>mail.user</param-name>
Registry entry:	/configuration/jcs/mail/user
Deprecated system property:	-Dconfiguration.mail.User
Deprecated registry entry:	/configuration/mail/User

This entry takes a string.

AttachmentError

The behavior for mails when attachment files are not found This setting is optional.

System property:	-Dmail.attachmenterror
Environment variable:	MAIL_ATTACHMENTERROR
Configuration file:	mail.attachmenterror
Servlet variables:	<param-name>mail.attachmenterror</param-name>
Registry entry:	/configuration/jcs/mail/attachmenterror
Deprecated system property:	-Dconfiguration.mail.attachmentError
Deprecated registry entry:	/configuration/mail/attachmentError

Enum configuration entry:

• operatormessage
• error
• none
• Default: operatormessage

ConnectionSecurity

The connection security that is allowed for the mail connection This setting is optional.

System property:	-Dmail.connectionsecurity
Environment variable:	MAIL_CONNECTIONSECURITY
Configuration file:	mail.connectionsecurity
Servlet variables:	<param-name>mail.connectionsecurity</param-name>
Registry entry:	/configuration/jcs/mail/connectionsecurity
Deprecated system property:	-Dconfiguration.mail.connectionSecurity
Deprecated registry entry:	/configuration/mail/connectionSecurity

Enum configuration entry:

• none
• starttls_optional
• starttls_required
• Default: starttls_optional

AccessiblePath

The base path on the server that mail attachments can be read from This setting is optional.

System property:	-Dmail.accessiblepath
Environment variable:	MAIL_ACCESSIBLEPATH
Configuration file:	mail.accessiblepath
Servlet variables:	<param-name>mail.accessiblepath</param-name>
Registry entry:	/configuration/jcs/mail/accessiblepath

List configuration entry:

Value:

This entry takes a string.

SendPartial

Send email even if one of the recipients is invalid. This setting is optional.

System property:	-Dmail.sendpartial
Environment variable:	MAIL_SENDPARTIAL
Configuration file:	mail.sendpartial
Servlet variables:	<param-name>mail.sendpartial</param-name>
Registry entry:	/configuration/jcs/mail/sendpartial

Boolean configuration entry, accepts true or false.

• Default: true

JavaMail

The java mail properties for custom configuration options when sending mail This setting is optional.

System property:	-Dmail.javamail
Environment variable:	MAIL_JAVAMAIL
Configuration file:	mail.javamail
Servlet variables:	<param-name>mail.javamail</param-name>
Registry entry:	/configuration/jcs/mail/javamail
Deprecated system property:	-Dconfiguration.mail.Properties
Deprecated registry entry:	/configuration/mail/Properties

Map configuration entry:

Key:

This entry takes a string.

Value:

This entry takes a string.

Mail2SMS

The SMS configurations

Server

The default server to send SMS through This setting is optional.

System property:	-Dmail2sms.server
Environment variable:	MAIL2SMS_SERVER
Configuration file:	mail2sms.server
Servlet variables:	<param-name>mail2sms.server</param-name>
Registry entry:	/configuration/jcs/mail2sms/server
Deprecated system property:	-Dconfiguration.sms.Server
Deprecated registry entry:	/configuration/sms/Server

This entry takes a string.

Security

System Security configuration options.

Auth

The HTTP Authentication Provider implementation for the system This setting is optional.

System property:	-Dsecurity.auth
Environment variable:	SECURITY_AUTH
Configuration file:	security.auth
Servlet variables:	<param-name>security.auth</param-name>
Registry entry:	/configuration/jcs/security/auth
Deprecated system property:	-Dconfiguration.security
Deprecated registry entry:	/configuration/security

This entry takes a string.

Method

The port allocation method for Redwood Platform where the port is not configured. This setting is optional.

System property:	-Dsecurity.method
Environment variable:	SECURITY_METHOD
Configuration file:	security.method
Servlet variables:	<param-name>security.method</param-name>
Registry entry:	/configuration/jcs/security/method

Enum configuration entry:

• method
• direct

LoginURL

The URL to use for the loopback login for authorizing shell and tool logins. There is a special value of localhttp for RedwoodPlatform which will calculate the port automatically. If this is not defined the default behaviour is to fall back to using the ContextURL. This setting is optional.

System property:	-Dsecurity.loginurl
Environment variable:	SECURITY_LOGINURL
Configuration file:	security.loginurl
Servlet variables:	<param-name>security.loginurl</param-name>
Registry entry:	/configuration/jcs/security/loginurl
Deprecated system property:	-Dconfiguration.LoginURL
Deprecated registry entry:	/configuration/LoginURL

This entry takes a string.

ContextURL

The URL to use for the the context path for references to the Redwood Scheduling instance when accessing it remotely. This setting is optional.

System property:	-Dsecurity.contexturl
Environment variable:	SECURITY_CONTEXTURL
Configuration file:	security.contexturl
Servlet variables:	<param-name>security.contexturl</param-name>
Registry entry:	/configuration/jcs/security/contexturl
Deprecated system property:	-Dconfiguration.ContextURL
Deprecated registry entry:	/configuration/ContextURL

This entry takes a string.

FailoverContextURL

The URL to use for the the context path for agent initiated Platform Agent connections if the primary ContextURL cannot be accessed. This setting is optional.

System property:	-Dsecurity.failovercontexturl
Environment variable:	SECURITY_FAILOVERCONTEXTURL
Configuration file:	security.failovercontexturl
Servlet variables:	<param-name>security.failovercontexturl</param-name>
Registry entry:	/configuration/jcs/security/failovercontexturl

String configuration entry, which can take a list of valid values:

• Default:

HttpFrameOptions

The X-Frame-Options HTTP response header that is set in the channel filter. The keys in the map contain the servlet path and the values contain the header that should be used. This setting is optional.

System property:	-Dsecurity.httpframeoptions
Environment variable:	SECURITY_HTTPFRAMEOPTIONS
Configuration file:	security.httpframeoptions
Servlet variables:	<param-name>security.httpframeoptions</param-name>
Registry entry:	/configuration/jcs/security/httpframeoptions
Deprecated system property:	-Dconfiguration.security.http.frame-options
Deprecated registry entry:	/configuration/security/http/frame-options

Map configuration entry:

Key:

This entry takes a string.

Value:

This entry takes a string.

ContentSecurityPolicy

A map of policy values for the Content Security Policy. These values are concatenated to produce the Content-Security-Policy header for all responses. This setting is mandatory.

System property:	-Dsecurity.contentsecuritypolicy
Environment variable:	SECURITY_CONTENTSECURITYPOLICY
Configuration file:	security.contentsecuritypolicy
Servlet variables:	<param-name>security.contentsecuritypolicy</param-name>
Registry entry:	/configuration/jcs/security/contentsecuritypolicy

Map configuration entry:

Key:

This entry takes a string.

Value:

List configuration entry:

Value:

This entry takes a string.

• Default: { "default-src": ["'self'", "data:", "https://*.runmyjobs.cloud", "https://*.runmyfinance.cloud"], "img-src": ["'self'", "data:", "https://heapanalytics.com", "https://*.runmyjobs.cloud", "https://*.runmyfinance.cloud"], "script-src": ["'self'", "'unsafe-inline'", "'unsafe-eval'", "https://cdn.heapanalytics.com", "https://heapanalytics.com", "https://*.runmyjobs.cloud", "https://*.runmyfinance.cloud"], "style-src": ["'self'", "'unsafe-inline'", "https://heapanalytics.com", "https://*.runmyjobs.cloud", "https://*.runmyfinance.cloud"], "connect-src": ["'self'", "data:", "https://heapanalytics.com", "https://*.runmyjobs.cloud", "https://*.runmyfinance.cloud"], "font-src": ["'self'", "data:", "https://heapanalytics.com", "https://*.runmyjobs.cloud", "https://*.runmyfinance.cloud"] }

RESTAuth

The configuration options for the REST Authentication Provider.

URL

The URL of the REST provider to connect to. This setting is mandatory.

System property:	-Dsecurity.restauth.url
Environment variable:	SECURITY_RESTAUTH_URL
Configuration file:	security.restauth.url
Servlet variables:	<param-name>security.restauth.url</param-name>
Registry entry:	/configuration/jcs/security/restauth/url

This entry takes a string.

Secret

The shared secret for the auth provider. This setting is mandatory.

System property:	-Dsecurity.restauth.secret
Environment variable:	SECURITY_RESTAUTH_SECRET
Configuration file:	security.restauth.secret
Servlet variables:	<param-name>security.restauth.secret</param-name>
Registry entry:	/configuration/jcs/security/restauth/secret

Password configuration entry, which can take a list of valid values, plain-text passwords will cause a warning to be logged

UseProxy

Should we use the proxy configured for the scheduler? This setting is mandatory.

System property:	-Dsecurity.restauth.useproxy
Environment variable:	SECURITY_RESTAUTH_USEPROXY
Configuration file:	security.restauth.useproxy
Servlet variables:	<param-name>security.restauth.useproxy</param-name>
Registry entry:	/configuration/jcs/security/restauth/useproxy

Boolean configuration entry, accepts true or false.

• Default: false

MaintenanceMode

Configuration for the maintenance mode user settings.

Enabled

Value that indicates whether or not maintenance is ongoing This setting is mandatory.

System property:	-Dui.maintenancemode.enabled
Environment variable:	UI_MAINTENANCEMODE_ENABLED
Configuration file:	ui.maintenancemode.enabled
Servlet variables:	<param-name>ui.maintenancemode.enabled</param-name>
Registry entry:	/configuration/jcs/ui/maintenancemode/enabled

Boolean configuration entry, accepts true or false.

• Default: false

Message

The message that will be shown to users when their login attempt is blocked This setting is mandatory.

System property:	-Dui.maintenancemode.message
Environment variable:	UI_MAINTENANCEMODE_MESSAGE
Configuration file:	ui.maintenancemode.message
Servlet variables:	<param-name>ui.maintenancemode.message</param-name>
Registry entry:	/configuration/jcs/ui/maintenancemode/message

String configuration entry, which can take a list of valid values:

• Default: @locale@:com.redwood.scheduler.jsp.login.MaintenanceModeDefaultText

HTTP

HTTP configuration settings

The group name and some property names match the historically defined system properties supported by the Java default implementation. These values are used for outgoing HTTP client connections, not the J2EE server that the product runs in.

TunnelingDisabledSchemes

This can be used to disable specific authentication schemes when authenticating HTTPS requests to a HTTP proxy. This setting is optional.

System property:	-Dnet.http.tunnelingdisabledschemes
Environment variable:	NET_HTTP_TUNNELINGDISABLEDSCHEMES
Configuration file:	net.http.tunnelingdisabledschemes
Servlet variables:	<param-name>net.http.tunnelingdisabledschemes</param-name>
Registry entry:	/configuration/jcs/net/http/tunnelingdisabledschemes

List configuration entry:

Value:

This entry takes a string.

ProxyingDisabledSchemes

This can be used to disable specific authentication schemes when authenticating HTTP requests to a HTTP proxy. This setting is optional.

System property:	-Dnet.http.proxyingdisabledschemes
Environment variable:	NET_HTTP_PROXYINGDISABLEDSCHEMES
Configuration file:	net.http.proxyingdisabledschemes
Servlet variables:	<param-name>net.http.proxyingdisabledschemes</param-name>
Registry entry:	/configuration/jcs/net/http/proxyingdisabledschemes

List configuration entry:

Value:

This entry takes a string.

ProxyHost

Hostname of HTTP proxy server. If not set, no proxying is done. This setting is optional.

System property:	-Dnet.http.proxyhost
Environment variable:	NET_HTTP_PROXYHOST
Configuration file:	net.http.proxyhost
Servlet variables:	<param-name>net.http.proxyhost</param-name>
Registry entry:	/configuration/jcs/net/http/proxyhost

This entry takes a string.

ProxyPort

Port where the HTTP proxy server listens. This setting is mandatory.

System property:	-Dnet.http.proxyport
Environment variable:	NET_HTTP_PROXYPORT
Configuration file:	net.http.proxyport
Servlet variables:	<param-name>net.http.proxyport</param-name>
Registry entry:	/configuration/jcs/net/http/proxyport

Integer configuration entry, which can take a list of valid values:

• Minimum: 1
• Maximum: 65535

• Default: 3128

ProxyUser

Username to use in authenticating to the proxy server. This setting is optional.

System property:	-Dnet.http.proxyuser
Environment variable:	NET_HTTP_PROXYUSER
Configuration file:	net.http.proxyuser
Servlet variables:	<param-name>net.http.proxyuser</param-name>
Registry entry:	/configuration/jcs/net/http/proxyuser

This entry takes a string.

ProxyPassword

Password to use in authenticating to the proxy server. This setting is optional.

System property:	-Dnet.http.proxypassword
Environment variable:	NET_HTTP_PROXYPASSWORD
Configuration file:	net.http.proxypassword
Servlet variables:	<param-name>net.http.proxypassword</param-name>
Registry entry:	/configuration/jcs/net/http/proxypassword

Password configuration entry, which can take a list of valid values, plain-text passwords are permitted

SystemNonProxyHosts

List of hosts that should be contacted directly. For historic reasons this may be comma or "vertical bar" separated. This is combined with the list in NonProxyHosts if both are specified. This setting is optional.

System property:	-Dnet.http.systemnonproxyhosts
Environment variable:	NET_HTTP_SYSTEMNONPROXYHOSTS
Configuration file:	net.http.systemnonproxyhosts
Servlet variables:	<param-name>net.http.systemnonproxyhosts</param-name>
Registry entry:	/configuration/jcs/net/http/systemnonproxyhosts
Deprecated system property:	-Dhttp.NonProxyHosts
Deprecated registry entry:	/http/NonProxyHosts

This entry takes a string.

NonProxyHosts

List of hosts that should be contacted directly. For historic reasons this may be comma or "vertical bar" separated. This is combined with the list in SystemNonProxyHosts if both are specified. This setting is mandatory.

System property:	-Dnet.http.nonproxyhosts
Environment variable:	NET_HTTP_NONPROXYHOSTS
Configuration file:	net.http.nonproxyhosts
Servlet variables:	<param-name>net.http.nonproxyhosts</param-name>
Registry entry:	/configuration/jcs/net/http/nonproxyhosts

String configuration entry, which can take a list of valid values:

• Default: localhost,127.*,[::1],0.0.0.0,[::0]

VerifyHostname

Verify that HTTPS certificate matches the hostname

When set to the default value 'Verify', the system will verify that the hostname used to connect to an HTTPS server matches the certificate presented by the HTTPS server. For example, if you connect to https://www.redwood.com, the certificate must allow 'www.redwood.com'. It can contain a CommonName 'www.redwood.com' or one of the SubjectAlternateNames can contain this or a wildcard '*.redwood.com'.

If you connect via an IP address the certificate must explicitly allow this IP address.

On upgrades from earlier versions this value will be set to 'Warn', which will only generate operator messages. Check all operator messages and fix the hostnames or the certificates until no warnings are created. Once no operator messages are created the value can be set to 'Verify'.

Set this to 'DontVerify' to remove all certificate hostname verifications. This setting is optional.

System property:	-Dnet.http.verifyhostname
Environment variable:	NET_HTTP_VERIFYHOSTNAME
Configuration file:	net.http.verifyhostname
Servlet variables:	<param-name>net.http.verifyhostname</param-name>
Registry entry:	/configuration/jcs/net/http/verifyhostname

Enum configuration entry:

• Verify
• Warn
• DontVerify
• Default: Verify

Client

TLS client configuration settings used for outgoing (client) connections.

VerifyServerCertificateTrust

Verify that server certificate is trusted

TLS servers present a certificate for their endpoint combined with a chain of certificates that signed the previous certificate in the chain, leading up to a Root Certificate Authority (Root CA). Trust of a certificate is established when the system trusts the Root CA.

The Java SDK contains a Java KeyStore that contains a generally accepted list of trusted Root CAs, such as DigiCert, GoDaddy, Google and various country authorities. The Java system administrator can also add extra certificates to this KeyStore.

It is also possible to add Credentials of type X509_TrustedCertificate. If your connections are to servers that are issued by one or more private Root CAs, you only need to create a Credential for each Root CA. If your connections are to servers that use self-signed certificates, you create a Credential for every self-signed certificate.

When set to the default value 'Verify', the system will verify that certificates presented by TLS servers such as HTTPS or SMTPS servers are trusted.

On upgrades from earlier versions this value will be set to 'Warn', which will allow all certificates but generate an operator message for every incorrect certificate. Check all operator messages and fix the hostnames or the certificates until no warnings are created. Once no operator messages are created the value can be set to 'Verify'.

Set this to 'DontVerify' to allow all certificates. This setting is mandatory.

System property:	-Dnet.tls.client.verifyservercertificatetrust
Environment variable:	NET.TLS_CLIENT_VERIFYSERVERCERTIFICATETRUST
Configuration file:	net.tls.client.verifyservercertificatetrust
Servlet variables:	<param-name>net.tls.client.verifyservercertificatetrust</param-name>
Registry entry:	/configuration/jcs/net.tls/client/verifyservercertificatetrust

Enum configuration entry:

• Verify
• Warn
• DontVerify
• Default: Verify

DisabledCipherSuites

List of strings that may not be present in cipher suites. This setting is mandatory.

System property:	-Dnet.tls.client.disabledciphersuites
Environment variable:	NET.TLS_CLIENT_DISABLEDCIPHERSUITES
Configuration file:	net.tls.client.disabledciphersuites
Servlet variables:	<param-name>net.tls.client.disabledciphersuites</param-name>
Registry entry:	/configuration/jcs/net.tls/client/disabledciphersuites

List configuration entry:

Value:

This entry takes a string.

• Default: ["_EXPORT_"]

DisabledProtocols

List of protocols that are not allowed. A value can end in * to indicate all protocols starting with that string are disabled. By default SSL and TLSv1 are not allowed as these are unsafe. This setting is mandatory.

System property:	-Dnet.tls.client.disabledprotocols
Environment variable:	NET.TLS_CLIENT_DISABLEDPROTOCOLS
Configuration file:	net.tls.client.disabledprotocols
Servlet variables:	<param-name>net.tls.client.disabledprotocols</param-name>
Registry entry:	/configuration/jcs/net.tls/client/disabledprotocols

List configuration entry:

Value:

This entry takes a string.

• Default: ["TLSv1","SSL*"]

UI

Configuration for generic UI features.

KeepAliveTimeout

How often will the UI contact the server to ensure that the connection is kept alive. This setting is mandatory.

System property:	-Dui.keepalivetimeout
Environment variable:	UI_KEEPALIVETIMEOUT
Configuration file:	ui.keepalivetimeout
Servlet variables:	<param-name>ui.keepalivetimeout</param-name>
Registry entry:	/configuration/jcs/ui/keepalivetimeout
Deprecated system property:	-Dconfiguration.keepalivetimeout converted from fromMillis
Deprecated registry entry:	/configuration/keepalivetimeout converted from fromMillis

Duration configuration entry:

• Minimum: 5s
• Maximum: 30s

• Default: 30s

HelpUrl

The URL to the help server, needs a trailing forward slash. This setting is mandatory.

System property:	-Dui.helpurl
Environment variable:	UI_HELPURL
Configuration file:	ui.helpurl
Servlet variables:	<param-name>ui.helpurl</param-name>
Registry entry:	/configuration/jcs/ui/helpurl

String configuration entry, which can take a list of valid values:

• Default: https://docs.runmyjobs.cloud/

HelpVersion

The version of the help to link to. This setting is optional.

System property:	-Dui.helpversion
Environment variable:	UI_HELPVERSION
Configuration file:	ui.helpversion
Servlet variables:	<param-name>ui.helpversion</param-name>
Registry entry:	/configuration/jcs/ui/helpversion

This entry takes a string.

ProductInfoDoc

The document to display in the product information menu; you specify the full path to a document with format HTMLFragment. This setting is optional.

System property:	-Dui.productinfodoc
Environment variable:	UI_PRODUCTINFODOC
Configuration file:	ui.productinfodoc
Servlet variables:	<param-name>ui.productinfodoc</param-name>
Registry entry:	/configuration/jcs/ui/productinfodoc

This entry takes a string.

LoginMessage

A message for display on the login page. This setting is optional.

System property:	-Dui.loginmessage
Environment variable:	UI_LOGINMESSAGE
Configuration file:	ui.loginmessage
Servlet variables:	<param-name>ui.loginmessage</param-name>
Registry entry:	/configuration/jcs/ui/loginmessage
Deprecated system property:	-Dconfiguration.security.title
Deprecated registry entry:	/configuration/security/title

This entry takes a string.

RoundTripTime

Configuration for RoundTripTime analysis.

Threshold

Threshold value at which an end user will be informed that their connection to the server is slow. This setting is mandatory.

System property:	-Dui.roundtriptime.threshold
Environment variable:	UI_ROUNDTRIPTIME_THRESHOLD
Configuration file:	ui.roundtriptime.threshold
Servlet variables:	<param-name>ui.roundtriptime.threshold</param-name>
Registry entry:	/configuration/jcs/ui/roundtriptime/threshold
Deprecated system property:	-Dconfiguration.logging.roundTripTime.threshold converted from fromMillis
Deprecated registry entry:	/configuration/logging/roundTripTime/threshold converted from fromMillis

Duration configuration entry:

• Minimum: 0

• Default: 0.2

Interval

How often will the UI check how fast the clients connection to the server is. This setting is mandatory.

System property:	-Dui.roundtriptime.interval
Environment variable:	UI_ROUNDTRIPTIME_INTERVAL
Configuration file:	ui.roundtriptime.interval
Servlet variables:	<param-name>ui.roundtriptime.interval</param-name>
Registry entry:	/configuration/jcs/ui/roundtriptime/interval
Deprecated system property:	-Dconfiguration.logging.roundTripTime.interval converted from fromMinutes
Deprecated registry entry:	/configuration/logging/roundTripTime/interval converted from fromMinutes

Duration configuration entry:

• Minimum: 0

• Default: 10m

Importing

Options for configuring the Import of objects via CAR files.

lockDown

When a system is in LockDown, it does not allow arbitrary imports of CAR files, but only from approved servers defined in Remote Systems. This setting is optional.

System property:	-Dimporting.lockdown
Environment variable:	IMPORTING_LOCKDOWN
Configuration file:	importing.lockdown
Servlet variables:	<param-name>importing.lockdown</param-name>
Registry entry:	/configuration/jcs/importing/lockdown
Deprecated system property:	-Dconfiguration.import.LockDown
Deprecated registry entry:	/configuration/import/LockDown

Boolean configuration entry, accepts true or false.

• Default: false

RunAsUser

Defines that the import of a CAR file should be done as the provided user instead of the user who submits the import job. This setting is optional.

System property:	-Dimporting.runasuser
Environment variable:	IMPORTING_RUNASUSER
Configuration file:	importing.runasuser
Servlet variables:	<param-name>importing.runasuser</param-name>
Registry entry:	/configuration/jcs/importing/runasuser
Deprecated system property:	-Dconfiguration.import.RunAsUser
Deprecated registry entry:	/configuration/import/RunAsUser

This entry takes a string.

DisableFileOnServer

Is import allowed from a file that is present on the server. This setting is optional.

System property:	-Dimporting.disablefileonserver
Environment variable:	IMPORTING_DISABLEFILEONSERVER
Configuration file:	importing.disablefileonserver
Servlet variables:	<param-name>importing.disablefileonserver</param-name>
Registry entry:	/configuration/jcs/importing/disablefileonserver
Deprecated system property:	-Dconfiguration.import.ImportArchiveSettings.disableFileOnServer
Deprecated registry entry:	/configuration/import/ImportArchiveSettings/disableFileOnServer

Boolean configuration entry, accepts true or false.

• Default: false

CatalogObjectImportRule

By default, catalog cars will be imported only when an older version of the car is already installed. When a newer, or equal version is already installed, the car import is skipped. Note this value can be overridden at import time via the parameter of the import process. This setting is optional.

System property:	-Dimporting.catalogobjectimportrule
Environment variable:	IMPORTING_CATALOGOBJECTIMPORTRULE
Configuration file:	importing.catalogobjectimportrule
Servlet variables:	<param-name>importing.catalogobjectimportrule</param-name>
Registry entry:	/configuration/jcs/importing/catalogobjectimportrule

Enum configuration entry:

• Absent
• Newer
• All
• Default: Newer

Exporting

Options for configuring the Export of objects via CAR files.

CustomObjectDefinition

Configuration for Custom Object Definitions

AdditionalGrantorRoles

The list of roles to give grantor rights when a custom Object Definition is created. The privilege is always granted to 'scheduler-administrator', and the user that creates the Object Definition (unless the user is Redwood System, who inherits the privilege from the 'scheduler-administrator' role) This setting is optional.

System property:	-Dcustomobjectdefinition.additionalgrantorroles
Environment variable:	CUSTOMOBJECTDEFINITION_ADDITIONALGRANTORROLES
Configuration file:	customobjectdefinition.additionalgrantorroles
Servlet variables:	<param-name>customobjectdefinition.additionalgrantorroles</param-name>
Registry entry:	/configuration/jcs/customobjectdefinition/additionalgrantorroles

List configuration entry:

Value:

This entry takes a string.

TemporaryFiles

Options for the creation and cleaning up of temporary files

Directory

The directory where the temporary files are created. This setting is optional.

System property:	-Dsystem.temporaryfiles.directory
Environment variable:	SYSTEM_TEMPORARYFILES_DIRECTORY
Configuration file:	system.temporaryfiles.directory
Servlet variables:	<param-name>system.temporaryfiles.directory</param-name>
Registry entry:	/configuration/jcs/system/temporaryfiles/directory

String configuration entry, which can take a list of valid values:

• Default: System.getProperty("java.io.tmpdir")

CleanOnStartup

Indicates whether the directory is cleaned at startup. This setting is optional.

System property:	-Dsystem.temporaryfiles.cleanonstartup
Environment variable:	SYSTEM_TEMPORARYFILES_CLEANONSTARTUP
Configuration file:	system.temporaryfiles.cleanonstartup
Servlet variables:	<param-name>system.temporaryfiles.cleanonstartup</param-name>
Registry entry:	/configuration/jcs/system/temporaryfiles/cleanonstartup

Boolean configuration entry, accepts true or false.

• Default: true

SSO

The Single Sign On configuration

Scheme1

The encoded key for scheme1 SSO authentication This setting is optional.

System property:	-Dsecurity.sso.scheme1
Environment variable:	SECURITY_SSO_SCHEME1
Configuration file:	security.sso.scheme1
Servlet variables:	<param-name>security.sso.scheme1</param-name>
Registry entry:	/configuration/jcs/security/sso/scheme1
Deprecated system property:	-Dconfiguration.security.sso.scheme1
Deprecated registry entry:	/configuration/security/sso/scheme1

This entry takes a string.

RSS

The encoded key for Restricted Scheduler Session SSO authentication This setting is optional.

System property:	-Dsecurity.sso.rss
Environment variable:	SECURITY_SSO_RSS
Configuration file:	security.sso.rss
Servlet variables:	<param-name>security.sso.rss</param-name>
Registry entry:	/configuration/jcs/security/sso/rss
Deprecated system property:	-Dconfiguration.security.sso.rss
Deprecated registry entry:	/configuration/security/sso/rss

This entry takes a string.

Timeout

The timeout as seconds for SSO Tokens before they expire This setting is optional.

System property:	-Dsecurity.sso.timeout
Environment variable:	SECURITY_SSO_TIMEOUT
Configuration file:	security.sso.timeout
Servlet variables:	<param-name>security.sso.timeout</param-name>
Registry entry:	/configuration/jcs/security/sso/timeout
Deprecated system property:	-Dconfiguration.security.sso.timeout
Deprecated registry entry:	/configuration/security/sso/timeout

Duration configuration entry:

• Minimum: 0

• Default: 120

External

The external address to redirect to that provides the SSO tokens. If NextURIParameter is set, it will be appented to this, unless redirecting upon logout. This setting is optional.

System property:	-Dsecurity.sso.external
Environment variable:	SECURITY_SSO_EXTERNAL
Configuration file:	security.sso.external
Servlet variables:	<param-name>security.sso.external</param-name>
Registry entry:	/configuration/jcs/security/sso/external
Deprecated system property:	-Dconfiguration.security.sso.external
Deprecated registry entry:	/configuration/security/sso/external

This entry takes a string.

Cookie

The cookie configuration used by the scheme1 SSO implementation. This provides the name of the cookie and the secret key. This setting is optional.

System property:	-Dsecurity.sso.cookie
Environment variable:	SECURITY_SSO_COOKIE
Configuration file:	security.sso.cookie
Servlet variables:	<param-name>security.sso.cookie</param-name>
Registry entry:	/configuration/jcs/security/sso/cookie
Deprecated system property:	-Dconfiguration.security.sso.scheme1.cookie
Deprecated registry entry:	/configuration/security/sso/scheme1/cookie

Map configuration entry:

Key:

This entry takes a string.

Value:

This entry takes a string.

LoginParameters

The additional login parameters for SSO solutions of external tools (iPhone, jTool, api-tool, BAE, PL/SQL, etc) This setting is optional.

System property:	-Dsecurity.sso.loginparameters
Environment variable:	SECURITY_SSO_LOGINPARAMETERS
Configuration file:	security.sso.loginparameters
Servlet variables:	<param-name>security.sso.loginparameters</param-name>
Registry entry:	/configuration/jcs/security/sso/loginparameters
Deprecated system property:	-Dconfiguration.security.AppendLoginParameters
Deprecated registry entry:	/configuration/security/AppendLoginParameters

This entry takes a string.

LogoutRedirect

Redirect behaviour after logging out. This setting is optional.

System property:	-Dsecurity.sso.logoutredirect
Environment variable:	SECURITY_SSO_LOGOUTREDIRECT
Configuration file:	security.sso.logoutredirect
Servlet variables:	<param-name>security.sso.logoutredirect</param-name>
Registry entry:	/configuration/jcs/security/sso/logoutredirect

Enum configuration entry:

• ToLogin
• None
• Custom

CustomLogoutURL

The custom URL to redirect to after logging out. This setting is optional.

System property:	-Dsecurity.sso.customlogouturl
Environment variable:	SECURITY_SSO_CUSTOMLOGOUTURL
Configuration file:	security.sso.customlogouturl
Servlet variables:	<param-name>security.sso.customlogouturl</param-name>
Registry entry:	/configuration/jcs/security/sso/customlogouturl

This entry takes a string.

NextURIParameter

If this parameter is set, then it will be appended to the External configuration value, unless redirecting upon logout. This setting is optional.

System property:	-Dsecurity.sso.nexturiparameter
Environment variable:	SECURITY_SSO_NEXTURIPARAMETER
Configuration file:	security.sso.nexturiparameter
Servlet variables:	<param-name>security.sso.nexturiparameter</param-name>
Registry entry:	/configuration/jcs/security/sso/nexturiparameter

String configuration entry, which can take a list of valid values:

• Default: nexturi

SecureStorageEncryption

Configuration for the secure storage subsystem

Key

The key to use when encrypting/decrypting the secure storage values. If this is changed, old encrypted values cannot be decrypted. This setting is optional.

System property:	-Dsecurity.securestorageencryption.key
Environment variable:	SECURITY_SECURESTORAGEENCRYPTION_KEY
Configuration file:	security.securestorageencryption.key
Servlet variables:	<param-name>security.securestorageencryption.key</param-name>
Registry entry:	/configuration/jcs/security/securestorageencryption/key
Deprecated system property:	-Dconfiguration.securestorageencryption.key
Deprecated registry entry:	/configuration/securestorageencryption/key

Password configuration entry, which can take a list of valid values, plain-text passwords are stored

Algorithm

What algorithm is used by SecureStorage. Note that this cannot be overridden, this is set internally. This setting is optional.

System property:	-Dsecurity.securestorageencryption.algorithm
Environment variable:	SECURITY_SECURESTORAGEENCRYPTION_ALGORITHM
Configuration file:	security.securestorageencryption.algorithm
Servlet variables:	<param-name>security.securestorageencryption.algorithm</param-name>
Registry entry:	/configuration/jcs/security/securestorageencryption/algorithm
Deprecated system property:	-Dconfiguration.securestorageencryption.algorithm
Deprecated registry entry:	/configuration/securestorageencryption/algorithm

This entry takes a string.

UUID

Universally Unique iDentifier. Changing this will invalidate all existing keys in your system. This setting is optional.

System property:	-Dsecurity.securestorageencryption.uuid
Environment variable:	SECURITY_SECURESTORAGEENCRYPTION_UUID
Configuration file:	security.securestorageencryption.uuid
Servlet variables:	<param-name>security.securestorageencryption.uuid</param-name>
Registry entry:	/configuration/jcs/security/securestorageencryption/uuid
Deprecated system property:	-Dconfiguration.securestorageencryption.uuid
Deprecated registry entry:	/configuration/securestorageencryption/uuid

Password configuration entry, which can take a list of valid values, plain-text passwords are stored

Session

The HTTP Session configuration options

Timeout

The timeout in for HTTP sessions. If specified, this must be longer than 1 minute in duration. This setting is optional.

System property:	-Dsecurity.session.timeout
Environment variable:	SECURITY_SESSION_TIMEOUT
Configuration file:	security.session.timeout
Servlet variables:	<param-name>security.session.timeout</param-name>
Registry entry:	/configuration/jcs/security/session/timeout
Deprecated system property:	-Dconfiguration.sessiontimeout converted from fromMinutes
Deprecated registry entry:	/configuration/sessiontimeout converted from fromMinutes

Duration configuration entry:

• Minimum: 60

Scheduling

Additional scheduling configuration

DelayForUnlimitedRestarts

The restart delay that is used if no max restarts is specified. This setting is optional.

System property:	-Dscheduling.delayforunlimitedrestarts
Environment variable:	SCHEDULING_DELAYFORUNLIMITEDRESTARTS
Configuration file:	scheduling.delayforunlimitedrestarts
Servlet variables:	<param-name>scheduling.delayforunlimitedrestarts</param-name>
Registry entry:	/configuration/jcs/scheduling/delayforunlimitedrestarts

Duration configuration entry:

• Minimum: 1

• Default: 15s

DefaultStatusForOverdue

The default value for the field JobDefinition.overdueStatus (the status that will be applied if a job is overdue). This setting is optional.

System property:	-Dscheduling.defaultstatusforoverdue
Environment variable:	SCHEDULING_DEFAULTSTATUSFOROVERDUE
Configuration file:	scheduling.defaultstatusforoverdue
Servlet variables:	<param-name>scheduling.defaultstatusforoverdue</param-name>
Registry entry:	/configuration/jcs/scheduling/defaultstatusforoverdue

Enum configuration entry:

• Scheduled
• Overdue
• Canceling
• Held
• Default: Overdue

DefaultJobDefinitionRestartLimit

The default maximum number of Job (and JobChain) restarts that is used if no max restarts is specified. This setting is mandatory.

System property:	-Dscheduling.defaultjobdefinitionrestartlimit
Environment variable:	SCHEDULING_DEFAULTJOBDEFINITIONRESTARTLIMIT
Configuration file:	scheduling.defaultjobdefinitionrestartlimit
Servlet variables:	<param-name>scheduling.defaultjobdefinitionrestartlimit</param-name>
Registry entry:	/configuration/jcs/scheduling/defaultjobdefinitionrestartlimit

Integer configuration entry, which can take a list of valid values:

• Minimum: 0

• Default: 100

DefaultStepRestartLimit

The default maximum number of JobChainStep restarts that is used if no max restarts is specified. This setting is mandatory.

System property:	-Dscheduling.defaultsteprestartlimit
Environment variable:	SCHEDULING_DEFAULTSTEPRESTARTLIMIT
Configuration file:	scheduling.defaultsteprestartlimit
Servlet variables:	<param-name>scheduling.defaultsteprestartlimit</param-name>
Registry entry:	/configuration/jcs/scheduling/defaultsteprestartlimit

Integer configuration entry, which can take a list of valid values:

• Minimum: 0

• Default: 100

RedwoodScript

Options for compiling and running Redwood Script

CompilerOptions

Additional options to be passed into the compiler when compiling RedwoodScript This setting is optional.

System property:	-Djavatoolkit.redwoodscript.compileroptions
Environment variable:	JAVATOOLKIT_REDWOODSCRIPT_COMPILEROPTIONS
Configuration file:	javatoolkit.redwoodscript.compileroptions
Servlet variables:	<param-name>javatoolkit.redwoodscript.compileroptions</param-name>
Registry entry:	/configuration/jcs/javatoolkit/redwoodscript/compileroptions
Deprecated system property:	-Dconfiguration.javatoolkit.CompilerOptions
Deprecated registry entry:	/configuration/javatoolkit/CompilerOptions

Map configuration entry:

Key:

This entry takes a string.

Value:

This entry takes a string.

StubParentClass

Class name that the generated Stub should extend This setting is optional.

System property:	-Djavatoolkit.redwoodscript.stubparentclass
Environment variable:	JAVATOOLKIT_REDWOODSCRIPT_STUBPARENTCLASS
Configuration file:	javatoolkit.redwoodscript.stubparentclass
Servlet variables:	<param-name>javatoolkit.redwoodscript.stubparentclass</param-name>
Registry entry:	/configuration/jcs/javatoolkit/redwoodscript/stubparentclass
Deprecated system property:	-Dconfiguration.javatoolkit.StubParentClass
Deprecated registry entry:	/configuration/javatoolkit/StubParentClass

This entry takes a string.

SourceVersion

What is the source version for compiling RedwoodScript This setting is mandatory.

System property:	-Djavatoolkit.redwoodscript.sourceversion
Environment variable:	JAVATOOLKIT_REDWOODSCRIPT_SOURCEVERSION
Configuration file:	javatoolkit.redwoodscript.sourceversion
Servlet variables:	<param-name>javatoolkit.redwoodscript.sourceversion</param-name>
Registry entry:	/configuration/jcs/javatoolkit/redwoodscript/sourceversion
Deprecated system property:	-Dconfiguration.javatoolkit.SourceVersion converted from ignoreNone
Deprecated registry entry:	/configuration/javatoolkit/SourceVersion converted from ignoreNone

String configuration entry, which can take a list of valid values:

• Default: 1.8

TargetVersion

What is the target version for compiling RedwoodScript This setting is mandatory.

System property:	-Djavatoolkit.redwoodscript.targetversion
Environment variable:	JAVATOOLKIT_REDWOODSCRIPT_TARGETVERSION
Configuration file:	javatoolkit.redwoodscript.targetversion
Servlet variables:	<param-name>javatoolkit.redwoodscript.targetversion</param-name>
Registry entry:	/configuration/jcs/javatoolkit/redwoodscript/targetversion
Deprecated system property:	-Dconfiguration.javatoolkit.TargetVersion converted from ignoreNone
Deprecated registry entry:	/configuration/javatoolkit/TargetVersion converted from ignoreNone

String configuration entry, which can take a list of valid values:

• Default: 1.8

DisableRuntimeExec

Should System.exec() be prevented from RedwoodScript This setting is mandatory.

System property:	-Djavatoolkit.redwoodscript.disableruntimeexec
Environment variable:	JAVATOOLKIT_REDWOODSCRIPT_DISABLERUNTIMEEXEC
Configuration file:	javatoolkit.redwoodscript.disableruntimeexec
Servlet variables:	<param-name>javatoolkit.redwoodscript.disableruntimeexec</param-name>
Registry entry:	/configuration/jcs/javatoolkit/redwoodscript/disableruntimeexec
Deprecated system property:	-Dconfiguration.javatoolkit.disableRuntimeExec
Deprecated registry entry:	/configuration/javatoolkit/disableRuntimeExec

Boolean configuration entry, accepts true or false.

• Default: true

HashCacheSize

The maximum number of entries in the RedwoodScript hash cache. This setting is mandatory.

System property:	-Djavatoolkit.redwoodscript.hashcachesize
Environment variable:	JAVATOOLKIT_REDWOODSCRIPT_HASHCACHESIZE
Configuration file:	javatoolkit.redwoodscript.hashcachesize
Servlet variables:	<param-name>javatoolkit.redwoodscript.hashcachesize</param-name>
Registry entry:	/configuration/jcs/javatoolkit/redwoodscript/hashcachesize

Integer configuration entry, which can take a list of valid values:

• Minimum: 0
• Maximum: 2147483647

• Default: 1000

JobChain

Configuration options for Job Chains

CopyIgnoredStatusWhenLooping

If a job chain loops, or does a backwards goto causing a new step to be created, should the Ignored status from the previous instance of the step be copied? This setting is mandatory.

System property:	-Dscheduler.jobchain.copyignoredstatuswhenlooping
Environment variable:	SCHEDULER_JOBCHAIN_COPYIGNOREDSTATUSWHENLOOPING
Configuration file:	scheduler.jobchain.copyignoredstatuswhenlooping
Servlet variables:	<param-name>scheduler.jobchain.copyignoredstatuswhenlooping</param-name>
Registry entry:	/configuration/jcs/scheduler/jobchain/copyignoredstatuswhenlooping
Deprecated system property:	-Dconfiguration.jcs.propagateOldStepsStatus converted from falseIfEntryExists
Deprecated registry entry:	/configuration/jcs/propagateOldStepsStatus converted from falseIfEntryExists

Boolean configuration entry, accepts true or false.

• Default: true

UseLastExecutedStepStatus

Should the final status of the chain reflect the status of the last executed step (true), or the status of the last step in the chain (false). This setting is mandatory.

System property:	-Dscheduler.jobchain.uselastexecutedstepstatus
Environment variable:	SCHEDULER_JOBCHAIN_USELASTEXECUTEDSTEPSTATUS
Configuration file:	scheduler.jobchain.uselastexecutedstepstatus
Servlet variables:	<param-name>scheduler.jobchain.uselastexecutedstepstatus</param-name>
Registry entry:	/configuration/jcs/scheduler/jobchain/uselastexecutedstepstatus
Deprecated system property:	-Dconfiguration.jcs.jobchain.useLastExecutedStepStatus
Deprecated registry entry:	/configuration/jcs/jobchain/useLastExecutedStepStatus

Boolean configuration entry, accepts true or false.

• Default: false

ObjectTypeToUseForMessages

How should messages from the chain engine be generated? This specifies what sort of objects to create to track chain errors. This setting is mandatory.

System property:	-Dscheduler.jobchain.objecttypetouseformessages
Environment variable:	SCHEDULER_JOBCHAIN_OBJECTTYPETOUSEFORMESSAGES
Configuration file:	scheduler.jobchain.objecttypetouseformessages
Servlet variables:	<param-name>scheduler.jobchain.objecttypetouseformessages</param-name>
Registry entry:	/configuration/jcs/scheduler/jobchain/objecttypetouseformessages
Deprecated system property:	-Dconfiguration.jcs.JobChainMessageLocation
Deprecated registry entry:	/configuration/jcs/JobChainMessageLocation

Enum configuration entry:

• OperatorMessage
• JobNote
• Default: JobNote

RestartVersion

When the user is given an option to restart a chain, which version should be chosen? If nothing is specified, the user will be able to choose. This setting is optional.

System property:	-Dscheduler.jobchain.restartversion
Environment variable:	SCHEDULER_JOBCHAIN_RESTARTVERSION
Configuration file:	scheduler.jobchain.restartversion
Servlet variables:	<param-name>scheduler.jobchain.restartversion</param-name>
Registry entry:	/configuration/jcs/scheduler/jobchain/restartversion
Deprecated system property:	-Dconfiguration.jcs.jobchain.RestartVersion
Deprecated registry entry:	/configuration/jcs/jobchain/RestartVersion

Enum configuration entry:

• currentVersion
• latestVersion

Core

All of the options required to configure an agent core

MaxAllocatedJobs

The maximum number of jobs that will be assigned to a process server at a time. This setting is optional.

System property:	-Dcore.maxallocatedjobs
Environment variable:	CORE_MAXALLOCATEDJOBS
Configuration file:	core.maxallocatedjobs
Servlet variables:	<param-name>core.maxallocatedjobs</param-name>
Registry entry:	/configuration/jcs/core/maxallocatedjobs

Integer configuration entry, which can take a list of valid values:

• Minimum: 1

• Default: 20

MonitorUpdateInterval

The number of seconds between updating the runtime values for Queues and ProcessServers in the Monitor tree. Note that this cannot be less than the default. This setting is optional.

System property:	-Dcore.monitorupdateinterval
Environment variable:	CORE_MONITORUPDATEINTERVAL
Configuration file:	core.monitorupdateinterval
Servlet variables:	<param-name>core.monitorupdateinterval</param-name>
Registry entry:	/configuration/jcs/core/monitorupdateinterval

Duration configuration entry:

• Minimum: 30

• Default: 30

RestrictedDefinitionNames

A list of prefixes that can not be used for process definitions. This setting is optional.

System property:	-Dcore.restricteddefinitionnames
Environment variable:	CORE_RESTRICTEDDEFINITIONNAMES
Configuration file:	core.restricteddefinitionnames
Servlet variables:	<param-name>core.restricteddefinitionnames</param-name>
Registry entry:	/configuration/jcs/core/restricteddefinitionnames

Map configuration entry:

Key:

This entry takes a string.

Value:

This entry takes a string.

SystemDataRootDirectory

Location for store JobFiles and logs, if value isn't set it uses InstallDirectory by default. This setting is optional.

System property:	-Dcore.systemdatarootdirectory
Environment variable:	CORE_SYSTEMDATAROOTDIRECTORY
Configuration file:	core.systemdatarootdirectory
Servlet variables:	<param-name>core.systemdatarootdirectory</param-name>
Registry entry:	/configuration/jcs/core/systemdatarootdirectory

String configuration entry, which can take a list of valid values:

• Default: ${InstallDirectory}

Upload

Option group for holding upload configuration.

UploadedFilesPath

Location for store Uploaded files, if value isn't set it uses InstallDirectory by default. This setting is optional.

System property:	-Dupload.uploadedfilespath
Environment variable:	UPLOAD_UPLOADEDFILESPATH
Configuration file:	upload.uploadedfilespath
Servlet variables:	<param-name>upload.uploadedfilespath</param-name>
Registry entry:	/configuration/jcs/upload/uploadedfilespath

This entry takes a string.

Document

Configuration for Document management features

AllowRawHtml

Allow storing raw HTML in documents, without putting in the ";render=raw" comment in the HTML file. This setting is mandatory.

System property:	-Dscheduler.document.allowrawhtml
Environment variable:	SCHEDULER_DOCUMENT_ALLOWRAWHTML
Configuration file:	scheduler.document.allowrawhtml
Servlet variables:	<param-name>scheduler.document.allowrawhtml</param-name>
Registry entry:	/configuration/jcs/scheduler/document/allowrawhtml

Boolean configuration entry, accepts true or false.

• Default: false

StreamBufferLineSize

The number of lines (1000 bytes in length) to buffer in memory when streaming Document data. This setting is mandatory.

System property:	-Dscheduler.document.streambufferlinesize
Environment variable:	SCHEDULER_DOCUMENT_STREAMBUFFERLINESIZE
Configuration file:	scheduler.document.streambufferlinesize
Servlet variables:	<param-name>scheduler.document.streambufferlinesize</param-name>
Registry entry:	/configuration/jcs/scheduler/document/streambufferlinesize

Integer configuration entry, which can take a list of valid values:

• Default: 10

CustomHealth

Monitoring Dashboard Custom Health Settings

Enabled

Indicates whether custom query filters are enabled. This setting is optional.

System property:	-Dmonitoringdashboard.customhealth.enabled
Environment variable:	MONITORINGDASHBOARD_CUSTOMHEALTH_ENABLED
Configuration file:	monitoringdashboard.customhealth.enabled
Servlet variables:	<param-name>monitoringdashboard.customhealth.enabled</param-name>
Registry entry:	/configuration/jcs/monitoringdashboard/customhealth/enabled

Boolean configuration entry, accepts true or false.

• Default: false

QueryFilter

Settings for query filters

JobsDelayedInRemoteSystem

The threshold for the 'Delayed in remote system' query filter; only processes that are delayed longer than this period are taken into account. This setting is optional.

System property:	-Dqueryfilter.jobsdelayedinremotesystem
Environment variable:	QUERYFILTER_JOBSDELAYEDINREMOTESYSTEM
Configuration file:	queryfilter.jobsdelayedinremotesystem
Servlet variables:	<param-name>queryfilter.jobsdelayedinremotesystem</param-name>
Registry entry:	/configuration/jcs/queryfilter/jobsdelayedinremotesystem

Duration configuration entry:

• Minimum: 1s
• Maximum: 1d

• Default: 60s

OneSecondSubmit

Configuration for the background submit process used by the UI.

ExpirationTimeBeforeCleaning

Expiration time for to determine if a submit form the UI has been "abandoned". This setting is mandatory.

System property:	-Donesecondsubmit.expirationtimebeforecleaning
Environment variable:	ONESECONDSUBMIT_EXPIRATIONTIMEBEFORECLEANING
Configuration file:	onesecondsubmit.expirationtimebeforecleaning
Servlet variables:	<param-name>onesecondsubmit.expirationtimebeforecleaning</param-name>
Registry entry:	/configuration/jcs/onesecondsubmit/expirationtimebeforecleaning
Deprecated system property:	-Dconfiguration.submit.expirationTimeBeforeCleaning converted from fromMinutes
Deprecated registry entry:	/configuration/submit/expirationTimeBeforeCleaning converted from fromMinutes

Duration configuration entry:

• Minimum: 5m
• Maximum: 1d

• Default: 30m

Executor

Options for the Redwood Script executor service

MinThreads

Minimum number of threads to keep available in the ThreadPool. This setting is mandatory.

System property:	-Djavatoolkit.redwoodscript.executor.minthreads
Environment variable:	JAVATOOLKIT.REDWOODSCRIPT_EXECUTOR_MINTHREADS
Configuration file:	javatoolkit.redwoodscript.executor.minthreads
Servlet variables:	<param-name>javatoolkit.redwoodscript.executor.minthreads</param-name>
Registry entry:	/configuration/jcs/javatoolkit.redwoodscript/executor/minthreads

Integer configuration entry, which can take a list of valid values:

• Minimum: 1

• Default: 5

KeepAlive

Duration before threads are cleaned up after being idle. This setting is mandatory.

System property:	-Djavatoolkit.redwoodscript.executor.keepalive
Environment variable:	JAVATOOLKIT.REDWOODSCRIPT_EXECUTOR_KEEPALIVE
Configuration file:	javatoolkit.redwoodscript.executor.keepalive
Servlet variables:	<param-name>javatoolkit.redwoodscript.executor.keepalive</param-name>
Registry entry:	/configuration/jcs/javatoolkit.redwoodscript/executor/keepalive

Duration configuration entry:

• Minimum: 0

• Default: 30s

Recurrence

Configuration options for recurrences

DefaultPreSubmit

The default value to use for the presubmit count. This is also used in the submit wizard. This setting is mandatory.

System property:	-Dscheduler.recurrence.defaultpresubmit
Environment variable:	SCHEDULER_RECURRENCE_DEFAULTPRESUBMIT
Configuration file:	scheduler.recurrence.defaultpresubmit
Servlet variables:	<param-name>scheduler.recurrence.defaultpresubmit</param-name>
Registry entry:	/configuration/jcs/scheduler/recurrence/defaultpresubmit
Deprecated system property:	-Dconfiguration.jcs.recurrence.DefaultPreSubmit
Deprecated registry entry:	/configuration/jcs/recurrence/DefaultPreSubmit

Integer configuration entry, which can take a list of valid values:

• Minimum: 1

• Default: 1

MaximumPreSubmit

The maximum number of pre-submitted jobs that can be submitted in a recurrence. If a value larger than this is specified, it will be capped to this value. This setting is mandatory.

System property:	-Dscheduler.recurrence.maximumpresubmit
Environment variable:	SCHEDULER_RECURRENCE_MAXIMUMPRESUBMIT
Configuration file:	scheduler.recurrence.maximumpresubmit
Servlet variables:	<param-name>scheduler.recurrence.maximumpresubmit</param-name>
Registry entry:	/configuration/jcs/scheduler/recurrence/maximumpresubmit
Deprecated system property:	-Dconfiguration.jcs.recurrence.MaximumPreSubmit
Deprecated registry entry:	/configuration/jcs/recurrence/MaximumPreSubmit

Integer configuration entry, which can take a list of valid values:

• Minimum: 1

• Default: 50

CronacleLibrary

Configuration options for Cronacle Library

EnvironmentName

Name of the environment. This setting is optional.

System property:	-Dcronaclelibrary.environmentname
Environment variable:	CRONACLELIBRARY_ENVIRONMENTNAME
Configuration file:	cronaclelibrary.environmentname
Servlet variables:	<param-name>cronaclelibrary.environmentname</param-name>
Registry entry:	/configuration/jcs/cronaclelibrary/environmentname

This entry takes a string.

EnvironmentTheme

CSS theme of the environment This setting is mandatory.

System property:	-Dcronaclelibrary.environmenttheme
Environment variable:	CRONACLELIBRARY_ENVIRONMENTTHEME
Configuration file:	cronaclelibrary.environmenttheme
Servlet variables:	<param-name>cronaclelibrary.environmenttheme</param-name>
Registry entry:	/configuration/jcs/cronaclelibrary/environmenttheme

Enum configuration entry:

• Blue
• Green
• Red
• Default: Red

PollInterval

The time between each update cycle. Increasing this value reduces load on the server, but increases the risk on loosing more data in case of server crash.

Min

The minimum poll interval when the system is busy. This setting is mandatory.

System property:	-Dcustomjob.pollinterval.min
Environment variable:	CUSTOMJOB_POLLINTERVAL_MIN
Configuration file:	customjob.pollinterval.min
Servlet variables:	<param-name>customjob.pollinterval.min</param-name>
Registry entry:	/configuration/jcs/customjob/pollinterval/min

Duration configuration entry:

• Minimum: 10s

• Default: 10s

Max

The maximum poll interval if the system is not busy. This setting is mandatory.

System property:	-Dcustomjob.pollinterval.max
Environment variable:	CUSTOMJOB_POLLINTERVAL_MAX
Configuration file:	customjob.pollinterval.max
Servlet variables:	<param-name>customjob.pollinterval.max</param-name>
Registry entry:	/configuration/jcs/customjob/pollinterval/max

Duration configuration entry:

• Minimum: 0
• Maximum: 120s

• Default: 120s

Increment

Increase number of seconds for the poll interval of the Custom job synchronizer when the system is idle. This setting is mandatory.

System property:	-Dcustomjob.pollinterval.increment
Environment variable:	CUSTOMJOB_POLLINTERVAL_INCREMENT
Configuration file:	customjob.pollinterval.increment
Servlet variables:	<param-name>customjob.pollinterval.increment</param-name>
Registry entry:	/configuration/jcs/customjob/pollinterval/increment

Duration configuration entry:

• Minimum: 5s

• Default: 5s

Decrement

Decrease number of seconds for the poll interval of the Custom job synchronizer when the system is busy. This setting is mandatory.

System property:	-Dcustomjob.pollinterval.decrement
Environment variable:	CUSTOMJOB_POLLINTERVAL_DECREMENT
Configuration file:	customjob.pollinterval.decrement
Servlet variables:	<param-name>customjob.pollinterval.decrement</param-name>
Registry entry:	/configuration/jcs/customjob/pollinterval/decrement

Duration configuration entry:

• Minimum: 10s

• Default: 60s

CronacleFiles

The configuration for the Cronacle System files.

Boot

Options for the Bootstrap

Resource

Location of the resource list file This setting is mandatory and incorrectly setting this will prevent startup.

System property:	-Dboot.resource
Environment variable:	BOOT_RESOURCE
Configuration file:	boot.resource
Servlet variables:	<param-name>boot.resource</param-name>
Registry entry:	/configuration/jcs/boot/resource

This entry takes a string.

SAP

SAP global options

SpoolHostMandatory

Is the spool host field visible and if so mandatory This setting is mandatory.

System property:	-Dsap.spoolhostmandatory
Environment variable:	SAP_SPOOLHOSTMANDATORY
Configuration file:	sap.spoolhostmandatory
Servlet variables:	<param-name>sap.spoolhostmandatory</param-name>
Registry entry:	/configuration/jcs/sap/spoolhostmandatory
Deprecated system property:	-Dconfiguration.SAP.output.ProcessServerUI
Deprecated registry entry:	/configuration/SAP/output/ProcessServerUI

Enum configuration entry:

• mandatory
• optional
• none
• Default: none

SelfMonitoring

Is self monitoring active? This setting is optional.

System property:	-Dsap.selfmonitoring
Environment variable:	SAP_SELFMONITORING
Configuration file:	sap.selfmonitoring
Servlet variables:	<param-name>sap.selfmonitoring</param-name>
Registry entry:	/configuration/jcs/sap/selfmonitoring
Deprecated system property:	-Dconfiguration.SAP.SelfMonitoring
Deprecated registry entry:	/configuration/SAP/SelfMonitoring

Boolean configuration entry, accepts true or false.

• Default: true

ShowBIBatchJobs

Define whether BI batch jobs should be created. Process Server parameter SAP_ShowBIBatchJobs overrides this setting. This setting is optional.

System property:	-Dsap.showbibatchjobs
Environment variable:	SAP_SHOWBIBATCHJOBS
Configuration file:	sap.showbibatchjobs
Servlet variables:	<param-name>sap.showbibatchjobs</param-name>
Registry entry:	/configuration/jcs/sap/showbibatchjobs

Boolean configuration entry, accepts true or false.

• Default: true

Output

SAP output options

DefaultOutputProcessServer

Default output retrieval Process Server. Can either be name in current partition or business key. This setting is optional.

System property:	-Dsap.output.defaultoutputprocessserver
Environment variable:	SAP_OUTPUT_DEFAULTOUTPUTPROCESSSERVER
Configuration file:	sap.output.defaultoutputprocessserver
Servlet variables:	<param-name>sap.output.defaultoutputprocessserver</param-name>
Registry entry:	/configuration/jcs/sap/output/defaultoutputprocessserver
Deprecated system property:	-Dconfiguration.SAP.output.DefaultProcessServer
Deprecated registry entry:	/configuration/SAP/output/DefaultProcessServer

This entry takes a string.

FailOverOutputProcessServer

Failover output retrieval Process Server. Can either be name in current partition or business key. This setting is optional.

System property:	-Dsap.output.failoveroutputprocessserver
Environment variable:	SAP_OUTPUT_FAILOVEROUTPUTPROCESSSERVER
Configuration file:	sap.output.failoveroutputprocessserver
Servlet variables:	<param-name>sap.output.failoveroutputprocessserver</param-name>
Registry entry:	/configuration/jcs/sap/output/failoveroutputprocessserver
Deprecated system property:	-Dconfiguration.SAP.output.FailOverProcessServer
Deprecated registry entry:	/configuration/SAP/output/FailOverProcessServer

This entry takes a string.

SpoolBlockSize

Spool block size. This setting is optional.

System property:	-Dsap.output.spoolblocksize
Environment variable:	SAP_OUTPUT_SPOOLBLOCKSIZE
Configuration file:	sap.output.spoolblocksize
Servlet variables:	<param-name>sap.output.spoolblocksize</param-name>
Registry entry:	/configuration/jcs/sap/output/spoolblocksize

Integer configuration entry, which can take a list of valid values:

• Minimum: 100
• Maximum: 1000

• Default: 250

BinSpoolBlockSize

BIN Spool block size in bytes. This setting is optional.

System property:	-Dsap.output.binspoolblocksize
Environment variable:	SAP_OUTPUT_BINSPOOLBLOCKSIZE
Configuration file:	sap.output.binspoolblocksize
Servlet variables:	<param-name>sap.output.binspoolblocksize</param-name>
Registry entry:	/configuration/jcs/sap/output/binspoolblocksize

Integer configuration entry, which can take a list of valid values:

• Minimum: 4194304
• Maximum: 104857600

• Default: 4194304

RetrieveOutputViaAgent

If the spool host is not set, this parameter is ignored and the output is retrieved by the server. If the spool host is set the output will be retrieved by the indicated platform agent. When RetrieveOutputViaAgent is 'true' the agent will use Java and JCo to access the SAP system. If the value is 'false' it will be retrieved by a program 'jrfc'. This setting is optional.

System property:	-Dsap.output.retrieveoutputviaagent
Environment variable:	SAP_OUTPUT_RETRIEVEOUTPUTVIAAGENT
Configuration file:	sap.output.retrieveoutputviaagent
Servlet variables:	<param-name>sap.output.retrieveoutputviaagent</param-name>
Registry entry:	/configuration/jcs/sap/output/retrieveoutputviaagent

Boolean configuration entry, accepts true or false.

• Default: false

PartnerOptions

SAP AIR Key

ApplicationInterfaceKey

Application Interface Key (AIR Key) to all SAP applications. This setting is optional.

System property:	-Dsap.partneroptions.applicationinterfacekey
Environment variable:	SAP_PARTNEROPTIONS_APPLICATIONINTERFACEKEY
Configuration file:	sap.partneroptions.applicationinterfacekey
Servlet variables:	<param-name>sap.partneroptions.applicationinterfacekey</param-name>
Registry entry:	/configuration/jcs/sap/partneroptions/applicationinterfacekey

This entry takes a string.

Component registry Keys

ProcessStudio

Options for configuring ProcessStudio

CatalogURL

Defines catalog-server URL This setting is optional.

System property:	-Dprocessstudio.catalogurl
Environment variable:	PROCESSSTUDIO_CATALOGURL
Configuration file:	processstudio.catalogurl
Servlet variables:	<param-name>processstudio.catalogurl</param-name>
Registry entry:	/configuration/jcs/processstudio/catalogurl
Deprecated system property:	-Dconfiguration.apps.ProcessStudio.CatalogURL
Deprecated registry entry:	/configuration/apps/ProcessStudio/CatalogURL

String configuration entry, which can take a list of valid values:

• Default: https://catalog.runmyjobs.cloud/catalog/product

Connections

Options to configure Azure Connections

ConnectTimeout

Duration to wait for a connection to be established This setting is mandatory.

System property:	-Dapps.azure.connections.connecttimeout
Environment variable:	APPS.AZURE_CONNECTIONS_CONNECTTIMEOUT
Configuration file:	apps.azure.connections.connecttimeout
Servlet variables:	<param-name>apps.azure.connections.connecttimeout</param-name>
Registry entry:	/configuration/jcs/apps.azure/connections/connecttimeout

Duration configuration entry:

• Minimum: 1s
• Maximum: 600s

• Default: 10s

SocketTimeout

Duration to wait for reads to be completed. This setting is mandatory.

System property:	-Dapps.azure.connections.sockettimeout
Environment variable:	APPS.AZURE_CONNECTIONS_SOCKETTIMEOUT
Configuration file:	apps.azure.connections.sockettimeout
Servlet variables:	<param-name>apps.azure.connections.sockettimeout</param-name>
Registry entry:	/configuration/jcs/apps.azure/connections/sockettimeout

Duration configuration entry:

• Minimum: 1s
• Maximum: 600s

• Default: 15s

MaxLoginAttempts

Maximum number of login attempts to try before failing This setting is mandatory.

System property:	-Dapps.azure.connections.maxloginattempts
Environment variable:	APPS.AZURE_CONNECTIONS_MAXLOGINATTEMPTS
Configuration file:	apps.azure.connections.maxloginattempts
Servlet variables:	<param-name>apps.azure.connections.maxloginattempts</param-name>
Registry entry:	/configuration/jcs/apps.azure/connections/maxloginattempts

Integer configuration entry, which can take a list of valid values:

• Minimum: 1
• Maximum: 100

• Default: 20

ApiKey

Options for API Key Authentication

NotAccessedExpirationPeriod

The period after their last used time when API keys are expired. This setting is mandatory.

System property:	-Dapps.apikey.notaccessedexpirationperiod
Environment variable:	APPS_APIKEY_NOTACCESSEDEXPIRATIONPERIOD
Configuration file:	apps.apikey.notaccessedexpirationperiod
Servlet variables:	<param-name>apps.apikey.notaccessedexpirationperiod</param-name>
Registry entry:	/configuration/jcs/apps/apikey/notaccessedexpirationperiod

Period onfiguration entry:

• Minimum: p0d
• Maximum: p1y

• Default: p3m

MaxExpirationPeriod

The period after their creation time when API keys are expired. This setting is mandatory.

System property:	-Dapps.apikey.maxexpirationperiod
Environment variable:	APPS_APIKEY_MAXEXPIRATIONPERIOD
Configuration file:	apps.apikey.maxexpirationperiod
Servlet variables:	<param-name>apps.apikey.maxexpirationperiod</param-name>
Registry entry:	/configuration/jcs/apps/apikey/maxexpirationperiod

Period onfiguration entry:

• Minimum: p0d
• Maximum: p1y

• Default: p6m

UserAdmin

Options for the User Administration Extension point

api_id

ID that the incoming request must must use. This setting is mandatory.

System property:	-Dapps.useradmin.api_id
Environment variable:	APPS_USERADMIN_API_ID
Configuration file:	apps.useradmin.api_id
Servlet variables:	<param-name>apps.useradmin.api_id</param-name>
Registry entry:	/configuration/jcs/apps/useradmin/api_id

This entry takes a string.

api_secret

The secret that the incoming request must use. This setting is mandatory.

System property:	-Dapps.useradmin.api_secret
Environment variable:	APPS_USERADMIN_API_SECRET
Configuration file:	apps.useradmin.api_secret
Servlet variables:	<param-name>apps.useradmin.api_secret</param-name>
Registry entry:	/configuration/jcs/apps/useradmin/api_secret

Password configuration entry, which can take a list of valid values, plain-text passwords are permitted

RoboLib

Configuration for robo-library.

InThresholdOperator

The threshold of supported query bindings. This setting is optional.

System property:	-Drobolib.inthresholdoperator
Environment variable:	ROBOLIB_INTHRESHOLDOPERATOR
Configuration file:	robolib.inthresholdoperator
Servlet variables:	<param-name>robolib.inthresholdoperator</param-name>
Registry entry:	/configuration/jcs/robolib/inthresholdoperator

Integer configuration entry, which can take a list of valid values:

• Default: 2048

Heap

Heap configuration options

HeapAppId

AppId identifier for heap This setting is mandatory.

System property:	-Dheap.heapappid
Environment variable:	HEAP_HEAPAPPID
Configuration file:	heap.heapappid
Servlet variables:	<param-name>heap.heapappid</param-name>
Registry entry:	/configuration/jcs/heap/heapappid

String configuration entry, which can take a list of valid values:

• Default: 2955929780

CIDS

Options to configure SAP CI DS extension

ImportPrefix

If set, the value of this entry will override the default prefix that is added to the name of definitions created by the Import job. Any value set on the Import job’s prefix parameter will override this registry value. This setting is optional.

System property:	-Dapps.sap.cids.importprefix
Environment variable:	APPS.SAP_CIDS_IMPORTPREFIX
Configuration file:	apps.sap.cids.importprefix
Servlet variables:	<param-name>apps.sap.cids.importprefix</param-name>
Registry entry:	/configuration/jcs/apps.sap/cids/importprefix
Deprecated system property:	-Dconfiguration.sap.HCIDS.ImportPrefix
Deprecated registry entry:	/configuration/sap/HCIDS/ImportPrefix

This entry takes a string.

PartnerOptions

SAP AIR Key

ApplicationInterfaceKey

Application Interface Key (AIR Key) to all SAP applications. This setting is optional.

System property:	-Dsap.partneroptions.applicationinterfacekey
Environment variable:	SAP_PARTNEROPTIONS_APPLICATIONINTERFACEKEY
Configuration file:	sap.partneroptions.applicationinterfacekey
Servlet variables:	<param-name>sap.partneroptions.applicationinterfacekey</param-name>
Registry entry:	/configuration/jcs/sap/partneroptions/applicationinterfacekey

This entry takes a string.

Workbench

The configuration options for Workbench.

BatchSize

The number of items that are loaded by a single fetch in Workbench can be configured here. This setting is mandatory.

System property:	-Dworkbench.batchsize
Environment variable:	WORKBENCH_BATCHSIZE
Configuration file:	workbench.batchsize
Servlet variables:	<param-name>workbench.batchsize</param-name>
Registry entry:	/configuration/jcs/workbench/batchsize

Integer configuration entry, which can take a list of valid values:

• Default: 5000

PartnerOptions

SAP AIR Key

ApplicationInterfaceKey

Application Interface Key (AIR Key) to all SAP applications. This setting is optional.

System property:	-Dsap.partneroptions.applicationinterfacekey
Environment variable:	SAP_PARTNEROPTIONS_APPLICATIONINTERFACEKEY
Configuration file:	sap.partneroptions.applicationinterfacekey
Servlet variables:	<param-name>sap.partneroptions.applicationinterfacekey</param-name>
Registry entry:	/configuration/jcs/sap/partneroptions/applicationinterfacekey

This entry takes a string.

DataIntegrator

Options for the Oracle DataIntegrator Connector

LoadPlanStopLevel

The StopLevel that Load Plans need to be stopped with (IMMEDIATE or NORMAL, default NORMAL). This setting is mandatory.

System property:	-Dapps.dataintegrator.loadplanstoplevel
Environment variable:	APPS_DATAINTEGRATOR_LOADPLANSTOPLEVEL
Configuration file:	apps.dataintegrator.loadplanstoplevel
Servlet variables:	<param-name>apps.dataintegrator.loadplanstoplevel</param-name>
Registry entry:	/configuration/jcs/apps/dataintegrator/loadplanstoplevel

Enum configuration entry:

• IMMEDIATE
• NORMAL
• Default: NORMAL

Orchestrator

Configuration for Orchestrator.

GanttChartVisibility

Should the Gantt chart be shown, hidden, or configurable per process list? Defaults to SHOWN_BY_DEFAULT (shown by default, but configurable per process list). This setting is mandatory.

System property:	-Dorchestrator.ganttchartvisibility
Environment variable:	ORCHESTRATOR_GANTTCHARTVISIBILITY
Configuration file:	orchestrator.ganttchartvisibility
Servlet variables:	<param-name>orchestrator.ganttchartvisibility</param-name>
Registry entry:	/configuration/jcs/orchestrator/ganttchartvisibility

Enum configuration entry:

• ALWAYS_SHOWN
• ALWAYS_HIDDEN
• SHOWN_BY_DEFAULT
• HIDDEN_BY_DEFAULT
• Default: SHOWN_BY_DEFAULT

IBP

Options to configure SAP IBP connection

ImportPrefix

If set, the value of this entry will override the default prefix that is added to the name of definitions created by the Import job. Any value set on the Import job’s prefix parameter will override this registry value. This setting is mandatory.

System property:	-Dapps.sap.ibp.importprefix
Environment variable:	APPS.SAP_IBP_IMPORTPREFIX
Configuration file:	apps.sap.ibp.importprefix
Servlet variables:	<param-name>apps.sap.ibp.importprefix</param-name>
Registry entry:	/configuration/jcs/apps.sap/ibp/importprefix
Deprecated system property:	-Dconfiguration.sap.IBP.ImportPrefix
Deprecated registry entry:	/configuration/sap/IBP/ImportPrefix

This entry takes a string.

ExtraUrlParameters

If set, the value of this entry will be appended as an additional parameter on the url for all calls made to the IBP system. This setting is mandatory.

System property:	-Dapps.sap.ibp.extraurlparameters
Environment variable:	APPS.SAP_IBP_EXTRAURLPARAMETERS
Configuration file:	apps.sap.ibp.extraurlparameters
Servlet variables:	<param-name>apps.sap.ibp.extraurlparameters</param-name>
Registry entry:	/configuration/jcs/apps.sap/ibp/extraurlparameters
Deprecated system property:	-Dconfiguration.sap.IBP.ExtraUrlParameters
Deprecated registry entry:	/configuration/sap/IBP/ExtraUrlParameters

This entry takes a string.

ConnectTimeout

Duration before threads are cleaned up after being idle. This setting is mandatory.

System property:	-Dapps.sap.ibp.connecttimeout
Environment variable:	APPS.SAP_IBP_CONNECTTIMEOUT
Configuration file:	apps.sap.ibp.connecttimeout
Servlet variables:	<param-name>apps.sap.ibp.connecttimeout</param-name>
Registry entry:	/configuration/jcs/apps.sap/ibp/connecttimeout
Deprecated system property:	-Dconfiguration.sap.IBP.ConnectTimeout
Deprecated registry entry:	/configuration/sap/IBP/ConnectTimeout

Duration configuration entry:

• Minimum: 0

• Default: 10s

SocketTimeout

Duration before threads are cleaned up after being idle. This setting is mandatory.

System property:	-Dapps.sap.ibp.sockettimeout
Environment variable:	APPS.SAP_IBP_SOCKETTIMEOUT
Configuration file:	apps.sap.ibp.sockettimeout
Servlet variables:	<param-name>apps.sap.ibp.sockettimeout</param-name>
Registry entry:	/configuration/jcs/apps.sap/ibp/sockettimeout
Deprecated system property:	-Dconfiguration.sap.IBP.SocketTimeout
Deprecated registry entry:	/configuration/sap/IBP/SocketTimeout

Duration configuration entry:

• Minimum: 0

• Default: 15s

PartnerOptions

SAP AIR Key

ApplicationInterfaceKey

Application Interface Key (AIR Key) to all SAP applications. This setting is optional.

System property:	-Dsap.partneroptions.applicationinterfacekey
Environment variable:	SAP_PARTNEROPTIONS_APPLICATIONINTERFACEKEY
Configuration file:	sap.partneroptions.applicationinterfacekey
Servlet variables:	<param-name>sap.partneroptions.applicationinterfacekey</param-name>
Registry entry:	/configuration/jcs/sap/partneroptions/applicationinterfacekey

This entry takes a string.

JavaJob

Options for the Native Java Job executor

JobID

Job id (from Cronacle) This setting is mandatory and incorrectly setting this will prevent startup.

System property:	-Djavajob.jobid
Environment variable:	JAVAJOB_JOBID
Configuration file:	javajob.jobid
Servlet variables:	<param-name>javajob.jobid</param-name>
Registry entry:	/configuration/jcs/javajob/jobid

Integer configuration entry, which can take a list of valid values:

ParameterFile

Path to file for parameters (without extension) This setting is mandatory and incorrectly setting this will prevent startup.

System property:	-Djavajob.parameterfile
Environment variable:	JAVAJOB_PARAMETERFILE
Configuration file:	javajob.parameterfile
Servlet variables:	<param-name>javajob.parameterfile</param-name>
Registry entry:	/configuration/jcs/javajob/parameterfile

This entry takes a string.

NativeJava

Options for the Native Java platform agent

Classpath

A platform specific separator list of values to add to the classpath. This setting is optional.

System property:	-Dnativejava.classpath
Environment variable:	NATIVEJAVA_CLASSPATH
Configuration file:	nativejava.classpath
Servlet variables:	<param-name>nativejava.classpath</param-name>
Registry entry:	/configuration/jcs/nativejava/classpath

This entry takes a string.

Connections

The configuration options for Connections.

OAuth2RedirectUrl

The OAuth 2.0 Redirect URI. This setting is optional.

System property:	-Dapps.connections.oauth2redirecturl
Environment variable:	APPS_CONNECTIONS_OAUTH2REDIRECTURL
Configuration file:	apps.connections.oauth2redirecturl
Servlet variables:	<param-name>apps.connections.oauth2redirecturl</param-name>
Registry entry:	/configuration/jcs/apps/connections/oauth2redirecturl

String configuration entry, which can take a list of valid values:

• Default: https://oauth2.cs.redwood.com

RedwoodBot

Options for the adaptive card project

URL

The (base) URL of the Redwood Bot Service. This setting is optional.

System property:	-Dredwoodbot.url
Environment variable:	REDWOODBOT_URL
Configuration file:	redwoodbot.url
Servlet variables:	<param-name>redwoodbot.url</param-name>
Registry entry:	/configuration/jcs/redwoodbot/url

This entry takes a string.

PowerBI

The configuration options for the PowerBI Reports.

APIURL

The root URL where PowerBI api calls are made. This setting is mandatory.

System property:	-Dpowerbi.apiurl
Environment variable:	POWERBI_APIURL
Configuration file:	powerbi.apiurl
Servlet variables:	<param-name>powerbi.apiurl</param-name>
Registry entry:	/configuration/jcs/powerbi/apiurl

String configuration entry, which can take a list of valid values:

• Default: https://api.powerbi.com/v1.0/myorg

AuthorityURL

The [common] authority URL where a User Principal is authenticated. Note that 'common' is automatically replaced with the tenant name (configuration option) when authenticating a Service Principal. This setting is mandatory.

System property:	-Dpowerbi.authorityurl
Environment variable:	POWERBI_AUTHORITYURL
Configuration file:	powerbi.authorityurl
Servlet variables:	<param-name>powerbi.authorityurl</param-name>
Registry entry:	/configuration/jcs/powerbi/authorityurl

String configuration entry, which can take a list of valid values:

• Default: https://login.microsoftonline.com/common/

ResourceUrl

Identifier of the target resource that is the recipient of the requested token. This setting is mandatory.

System property:	-Dpowerbi.resourceurl
Environment variable:	POWERBI_RESOURCEURL
Configuration file:	powerbi.resourceurl
Servlet variables:	<param-name>powerbi.resourceurl</param-name>
Registry entry:	/configuration/jcs/powerbi/resourceurl

String configuration entry, which can take a list of valid values:

• Default: https://analysis.windows.net/powerbi/api

ApplicationID

Identifier of the Application, registered in Azure AD, against which authentication will take place. This setting is optional.

System property:	-Dpowerbi.applicationid
Environment variable:	POWERBI_APPLICATIONID
Configuration file:	powerbi.applicationid
Servlet variables:	<param-name>powerbi.applicationid</param-name>
Registry entry:	/configuration/jcs/powerbi/applicationid

This entry takes a string.

ReportWorkspaceId

Identifier of the Power BI Workspace where reports are published. This setting is optional.

System property:	-Dpowerbi.reportworkspaceid
Environment variable:	POWERBI_REPORTWORKSPACEID
Configuration file:	powerbi.reportworkspaceid
Servlet variables:	<param-name>powerbi.reportworkspaceid</param-name>
Registry entry:	/configuration/jcs/powerbi/reportworkspaceid

This entry takes a string.

BindDatasetWorkspaceId

Identifier of the Power BI Workspace where bind datasets are pushed. This setting is optional.

System property:	-Dpowerbi.binddatasetworkspaceid
Environment variable:	POWERBI_BINDDATASETWORKSPACEID
Configuration file:	powerbi.binddatasetworkspaceid
Servlet variables:	<param-name>powerbi.binddatasetworkspaceid</param-name>
Registry entry:	/configuration/jcs/powerbi/binddatasetworkspaceid

This entry takes a string.

TenantName

The name of the Azure AD Tenant where the reports and datasets are hosted. This value is used to identify the PowerBIServicePrincipal Credential (if the configured authentication mode is ServicePrincipal). This setting is optional.

System property:	-Dpowerbi.tenantname
Environment variable:	POWERBI_TENANTNAME
Configuration file:	powerbi.tenantname
Servlet variables:	<param-name>powerbi.tenantname</param-name>
Registry entry:	/configuration/jcs/powerbi/tenantname

This entry takes a string.

UserName

A named Power BI user account (requires minimum license of Power BI Pro). This value is used to identify the PowerBIUserPrincipal Credential (if the configured authentication mode is UserPrincipal). This setting is optional.

System property:	-Dpowerbi.username
Environment variable:	POWERBI_USERNAME
Configuration file:	powerbi.username
Servlet variables:	<param-name>powerbi.username</param-name>
Registry entry:	/configuration/jcs/powerbi/username

This entry takes a string.

Home

Options for the Home Extension point

AdditionalControlCenterAccessRoles

List of additional Roles (on top of redwood-administrator and scheduler-administrator) that get the Control Center button in the Home screen. This setting is mandatory.

System property:	-Dapps.home.additionalcontrolcenteraccessroles
Environment variable:	APPS_HOME_ADDITIONALCONTROLCENTERACCESSROLES
Configuration file:	apps.home.additionalcontrolcenteraccessroles
Servlet variables:	<param-name>apps.home.additionalcontrolcenteraccessroles</param-name>
Registry entry:	/configuration/jcs/apps/home/additionalcontrolcenteraccessroles

List configuration entry:

Value:

This entry takes a string.

• Default: ["scheduler-it-user"]

DataTransformer

Configuration options for Data Transformer

UIRowLimit

Certain operations in Data Transformer require large amounts of data to be manipulated in memory. As a consequence, in the user interface, this consumption can run into the limits of the total available memory available to the application.

This option can be used to tune the total number of rows taken from each input source to transformer and consequently worked with when using the user interface.

Note: when running a Data Transformer job this option is ignored. It is purely for user interface performance purposes. This setting is mandatory.

System property:	-Ddatatransformer.uirowlimit
Environment variable:	DATATRANSFORMER_UIROWLIMIT
Configuration file:	datatransformer.uirowlimit
Servlet variables:	<param-name>datatransformer.uirowlimit</param-name>
Registry entry:	/configuration/jcs/datatransformer/uirowlimit

Integer configuration entry, which can take a list of valid values:

• Minimum: 1
• Maximum: 5000

• Default: 1000

ExecutionEnvironment

Data Transformer supports running jobs on platform agents and/or the Cronacle instance.

A parameter on the job dictates this - runOnPlatformAgent. When set to true the transform job will be run on a platform agent. When set to false, the transformer job will be run on the cronacle instance.

Valid values, and their effects as as follows:

AGENT - transformer jobs will be run on an available platform agent LOCAL - transformer jobs will be run on the cronacle instance USER_DEFINED - isJDTJob job parameter will be created and will default to true if the transformer was initially created using Process Studio, false otherwise.

The isJDTJob job parameter will not be created if AGENT or LOCAL are specified This setting is mandatory.

System property:	-Ddatatransformer.executionenvironment
Environment variable:	DATATRANSFORMER_EXECUTIONENVIRONMENT
Configuration file:	datatransformer.executionenvironment
Servlet variables:	<param-name>datatransformer.executionenvironment</param-name>
Registry entry:	/configuration/jcs/datatransformer/executionenvironment

Enum configuration entry:

• AGENT
• LOCAL
• USER_DEFINED
• Default: USER_DEFINED

InputSourceOrdering

The InputSourceOrdering serves as a system-wide flag that enables/disables the Input Source Ordering feature. The feature orders input sources (files/tables) based on an algorithm that compares them with the example data used when the transformer robot was created. Should files arrive out of order the best effort is made to correct this based on the metadata for the input. The flag can be overridden on the Transformer level via the "Manage Input Source" dialog. By default this flag is set to the system-wide setting. This setting is mandatory.

System property:	-Ddatatransformer.inputsourceordering
Environment variable:	DATATRANSFORMER_INPUTSOURCEORDERING
Configuration file:	datatransformer.inputsourceordering
Servlet variables:	<param-name>datatransformer.inputsourceordering</param-name>
Registry entry:	/configuration/jcs/datatransformer/inputsourceordering

Boolean configuration entry, accepts true or false.

• Default: true

Registry-only Configuration settings

Aggregation

Monitor history data is stored for use in various monitoring tools; it is disabled by default. You can enable this by specifying the following registry entry with value true:

/configuration/aggregation/enabled

The following registry entry should not be altered unless you know what you are doing; its value is maintained by System_Aggregate_History processes. Do not move backward in time! Note that it uses the server timezone, so make sure to keep that in mind when overriding. Format: yyyy-MM-DD HH (where HH = 0-23).

/configuration/aggregation/startTime

aliases

You can set aliases to make the built-in web services available via a proxy. The key name should be the alias name of the web service and the value must be the actual hostname.

You create aliases under the following registry entry:

/configuration/webservices/aliases

maxWaitTime

When using ExternalCompletionStartegy, on busy systems it can happen that the process has not been completely created for the first UpdateJob; in this case, you can set a timeout in milliseconds for the process creation to complete. By default, this is 5000 milliseconds.

/configuration/webservices/maxWaitTime

AutoExtension

Redwood Server appends extensions automatically to text files and HTML files, which do not already have a.txt or.html extension.

You can disable this by specifying one of the following registry entries:

1. Registry key /configuration/jcs/mail/AutoExtension/<Format_Partition>/<Format_Name>=false.
2. Registry key /configuration/jcs/mail/AutoExtension=false.

Note that the settings are parsed in this order, the first setting found is used. If none are found, the default is true.

bindAddress

The address to which the communication port is bound. By default this is the System Host Name.

The bind address can be changed with the following registry entry

/configuration/boot/cluster/<System_Host_Name>/<Cluster_Instance_Id>/<Cluster_Node_Id>/bindAddress

Alternatively the bind address for all nodes in an instance can be changed with the following registry entry

/configuration/boot/cluster/<System_Host_Name>/<Cluster_Instance_Id>/bindAddress

If both these values are set the more specific (Instance + Node) value is used.

CacheSize

The cache size to use for cached PL/SQL REL functions, default is 50.

/configuration/REL/PLSQL/CacheSize

check

Redwood Server can automatically check if a critical update has become available and warn you about it. This can be set in the following registry entry:

/configuration/update/check

checksum

Every time an autoexec.car file is imported, its checksum is stored in the following registry entry:

/configuration/boot/car/checksum

This ensures that that car file is not re-imported.

DefaultKeepStatus

Processes that reach one of statuses defined by the ScriptKeepStatus are excluded from the keep clause of the process definition. These processes are kept indefinitely as long as the KeepExpiration field on the process is not used. You can force deletion of a process by specifying a DateTimeZone in the past on the KeepExpiration field of the process; the process will be deleted as soon as KeepExpiration has been reached by the System_ProcessKeepClauses process regardless of any other settings.

This can be set with the following registry entry:

/configuration/DefaultKeepStatus

If this registry entry is not set, processes in all final statuses adhere to the keep clause. The registry entry takes a succession of status codes, note that no spaces, commas or semi-colons should be used; the order is not relevant.

Status codes for final status

• A - Canceled
• C - Completed
• E - Error
• K - Killed
• U - Unknown

Example value: KAUE

DefaultMaxCacheAge

The default maximum age of PL/SQL REL cache entries, default is 3600 seconds or 1 hour.

/configuration/REL/PLSQL/DefaultMaxCacheAge

Download

You redirect the download of software using the following registry entry:

/configuration/Download/RedirectSoftwareDownloadURL

This is useful if you want to redirect users who wish to download platform agent installers to a server in another geographical location. The value should be that of

The value should be a Redwood Server URL, for example http://pr1.example.com:53000/redwood.

error

When the import of an autoexec.car file fails, startup continues by default. You can force the central Redwood Server to abort startup by specifying abort in the following registry entry:

/configuration/boot/car/error

This registry entry only accepts the value abort, any other value will be ignored.

GetSupportFilesMaxSize

This is the maximum total size in Mb of the (unzipped) files that are included in the Get Support Files zip. The default value is 1000 MB (1 GB) which once compressed corresponds roughly to a 60 MB ZIP file.

This maximum size can be changed with the following registry entry:

/configuration/logging/GetSupportFilesMaxSize

instanceId

This is a unique identifier for the cluster. This allows you to have two clusters on the same host. By default this is set to 0.

The id can be changed with the following registry entry

/configuration/boot/cluster/<System_Host_Name>/instanceId

KeepDisabled

You can disable keep-clauses with the following registry entry:

/configuration/KeepDisabled

Language

The default language to use in the ui user has no language defined.

You set the default language with the following registry entry:

/configuration/Language

location

You specify the location of autoexec.car files with the following registry entry:

/configuration/boot/car/location

The car files are imported at system startup if its checksum differs from that stored in /configuration/boot/car/checksum.

lockTimeoutThreshold

/configuration/jcs/clustering/lockTimeoutThreshold

The value is in seconds. The default value is 300 seconds and will be used if this registry entry is not set or its value is invalid.

name

This is used for display purposes (for example within the output of the System_Info process) for identifying a cluster. By default it is CLUSTER.

The name can be changed with the following registry entry

/configuration/boot/cluster/name

NewChainDefaultsToEasyRestart

This is used to enable or disable the Easy Restart mode for new chain definitions created in the chain definition editor. The default behavior, when this registry entry is not set, is to enable the Easy Restart mode. Note that this registry entry only affects the behavior of the chain definition editor.

The registry entry accepts values true or false.

/configuration/ui/JobChain/NewChainDefaultsToEasyRestart

password

When you use the Redwood Server operator message client on Microsoft Windows, you can set a password as opposed to having the users log in with their account.

The password can be set with the following registry entry:

/configuration/feed/feeds/operator_message/password

port

The port to which the communication is bound. By default this is determined from the Cluster Instance Id, and the Cluster Node Id via the following equation:

Port Number = 10000 + (1000 * Cluster Instance Id) + 70 + (Cluster Node Id)

On a default setup this will be 10071.

The port can be changed with the following registry entry

/configuration/boot/cluster/<System_Host_Name>/<Cluster_Instance_Id>/<Cluster_Node_Id>/port

ProcessServerParameters

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

/configuration/ProcessServerParameters/<name>

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

propagateOldStepsStatus

When you upgraded from 9.0.6 or earlier, this registry entry is created to enable backward compatibility. When this registry entry exists, disabled steps or processes are forgotten when the step or chain is restarted; without this registry entry, disabled steps or processes are remembered when the step is restarted, the step is ignored. You can enable the old behavior, disabled steps and processes lose their Disabled status when the step is restarted, by specifying the following registry entry:

/configuration/jcs/propagateOldStepsStatus

note

Redwood Server only checks if the registry exists and if it does enables the old behavior, the value is ignored. To disable the old behavior you must delete the registry entry; the change takes effect immediately.

Properties

The defaults for the mail.smtp.timeout and mail.smtp.connectiontimeout mail session properties are set to 10 seconds. You can override these and any other properties in the com.sun.mail.smtp package using the following registry entry. Note that special caution must be taken when you set other properties; failure to understand a property correctly can cause issues if you override the default.

/configuration/jcs/mail/Properties

Release

The release registry entry under the update node displays the current release of the software. The key can be found at this location:

/configuration/update/release

Skip JCo for non-SAP Environments

Redwood Server automatically tries to load SAP JCo drivers used for connecting to the ABAP stack of SAP instances. If you have no SAP systems, you can set this registry entry to true.

• /configuration/jco/skip - skip the loading of SAP drivers

SQLServerCheck

This registry entry is set during the database initialization when mandatory configuration parameters are not set for SQL Server databases. The following SQL Server database connection parameters are mandatory:

• responseBuffering=adaptive
• selectMethod=direct

/configuration/SQLServerCheck

ThreadPriority

The dispatcher thread priority is set to a default of 8. The priority can be changed by setting the registry entry:

/configuration/jcs/dispatcher/ThreadPriority

Valid values range from 1 to 10. Note that you must restart Redwood Server in order for this setting to become effective.

ToolbarRefreshRate

This registry entry allows you to specify the refresh interval of the toolbar. The registry entry takes seconds as a value, the minimum value is 30 seconds. The default value, when this registry entry is not set, is 60.

/configuration/ui/ToolbarRefreshRate

type

This is the implementation that is used to perform all clustering operations.

The configuration is set with the following registry entry:

/configuration/boot/cluster/type

The possible values are (Note: these values are case-sensitive):

• RWM - Redwood Messaging, the default implementation
• Standalone - A non-clustered implementation designed as a Failsafe

upgradeHistoryJobsCacheSize

When you upgrade the central Redwood Server, a number of database tables need to be upgraded as well. The HistoryJob table is one of the bigger tables on busy systems that can cause the System_Upgrade to run out of memory. By default, the cache size is set to 500000 (500k). You can configure the cache size, which must be between 2000 (2k) and 10000000 (10 000k) using the following registry entry:

/configuration/update/upgradeHistoryJobsCacheSize

note

The bigger the cache size, the more memory the process will consume.

Visibility

The visibility key and child keys are used to specify who can see which tabs and links in object editors. You specify the levels in the /configuration/ui/visibility/Levels registry entry; it must be set to a comma-separated list of roles. The roles must be entered in ascending order starting with the role that should have the most limitations and ending with the most privileged role. Note that this does not grant any additional privileges, it merely restricts the privileges a user has.

Note that these registry entries are generated using the System_CreateEditScreenEntries process definition.

The following table lists the values

Key	Value	Description
Levels	<Comma separated list of roles, treated as levels from lowest to highest>
Tabs//		<Filled in by process definition as the translation of for ObjectType/TabName>
Links/	<Minimum level to see New…/Edit… links next to fields for this object type>

The following registry entries, as well as their children (not shown), will be generated by the System_CreateEditScreenEntries process definition

/configuration/ui/visibility/Levels

/configuration/ui/visibility/Links/<object_type>/<tab_name>

/configuration/ui/visibility/Tabs/<object_type>/<tab_name>

Active Monitoring-Related Registry Keys

Active Monitoring-related registry entries are stored under the configuration/Alerting node. The following are available:

• /configuration/Alerting/Message - The default message for alert operator messages
• /configuration/Alerting/Response - The default Reply for alert operator messages
• /configuration/Alerting/System_Alert_Send/ErrorOnNoMessage - When this registry entry is set to true and no matching operator message could be found, an exception will be thrown.

Worker Queues

By default, a process server has 100 worker queues, which means that it can execute 100 concurrent processes (process running in parallel). You can set the maximum number of worker queues using the registry:

/configuration/requestQueueSize/<process_server_partition>/<process_server>/<service>

You set the maximum workers for the ScriptService (RedwoodScript) to 20, for the ProcessServer named 'PS_TEST' which is in the GLOBAL partition as follows:

/configuration/requestQueueSize/GLOBAL/PS_TEST/ScriptService=20

Archiving Server-Related Registry Keys

Archiving Server-Related registry entries are stored under the /configuration/archiving/ node. The following are available:

• /configuration/archiving/ - the fully qualified domain name of the archiving server
• /configuration/Archiving// - the location of the root directory on the archiving server

compressionlevel

To speed-up the archival of output you specify the ZipOutputStream compression-level (0-9) using the following registry entry:

/configuration/Archiving/compressionLevel

SAP-Related Registry Keys

DefaultJobQueue

Override the parent process's queue using the following registry entries:

• /configuration/sap/<Partition>.<SAPSystem>/DefaultJobQueue - default queue for SAP system <Partition>.<SAPSystem> (<partition> is optional, defaults to GLOBAL).
• /configuration/sap/DefaultJobQueue - default queue for all SAP systems when not specified in the job control rules or for the specific SAP System.

The evaluation order is as follows:

1. Job control rules.
2. Registry setting.
3. Parent process's queue.

DefaultProcessServer

The following registry entry can be used to specify the default process server for retrieving output from an SAP system.

/configuration/sap/output/DefaultProcessServer

DenyDisabledUsers

The following registry entry allows you to deny deactivated users from logging-in on the SAP BAE (SAP Inbound) interface. By default, deactivated users are allowed to login via SAP BAE; create this registry entry and set its value to true and the users are denied access.

/configuration/sap/bae/DenyDisabledUsers

IgnoreApplicationReturnCode

If this registry entry is set to true, the application return code is ignored. By default, Redwood Server uses the application return code to determine the final status of the process. This setting affects all SAP process servers, if you do not want to set this for all process servers, consider the SAP_IgnoreApplicationReturnCode process server parameter.

• /configuration/sap/<Partition>.<SAPSystem>/xbp/IgnoreApplicationReturnCode - only the SAP instance for which this registry entry is defined is affected; for SAP systems in the GLOBAL partition, leave the <partition>. out.
• /configuration/sap/xbp/IgnoreApplicationReturnCode - only used if the SAP System-specific is not set.

The settings are processed in this order, the first setting found has precedence:

1. Parameter IGNORE_APPL_RC, only valid for all processes of this process definition.
2. Process server parameter SAP_IgnoreApplicationReturnCode, only valid for all processes that run on the process server.
3. Registry entry /configuration/sap/<Partition>.<SAPSystem>/xbp/IgnoreApplicationReturnCode, only valid for the specified SAP system (<partition> is optional, defaults to GLOBAL).
4. Registry entry /configuration/sap/xbp/IgnoreApplicationReturnCode, valid for all SAPR3 processes across all SAP systems for which the SAP System-specific key is not set.

Examples

Registry key for SAP system PR1 in partition Global

• /configuration/sap/PR1/xbp/IgnoreApplicationReturnCode

Registry key for SAP system PR2 in partition MSLN_PR2

• /configuration/sap/MSLN_PR2.PR2/xbp/IgnoreApplicationReturnCode

EnableFLParameters

You ignore the FL_SHOWSPOOL, FL_SHOWLOG, and FL_SHOWAPPLLOG process definition parameters by setting the following registry entry to false. When this registry entry does not exist, the parameters are adhered to.

• /configuration/sap/xbp/EnableFLParameters

IgnoreError

You ignore specific transient BW error messages that occur while a BW job is active by specifying a comma-separated list of error codes in the IgnoreError registry entry. As long as the process is active in SAP, these errors will not cause the Redwood Server process to reach status Error. When the BW job finishes with one of these errors, the process will reach status Error as usual.

By default, the following errors are ignored:

• RSM2 010 - Request still running
• RSM2 047 - Data loaded successfully; activate the DataStore object

So the default value of the registry entry is RSM2010, RSM2047; these errors should always be ignored for active BW jobs.

The registry entry path is as follows:

• /configuration/sap/<Partition>.<SAPSystem>/bw/log/IgnoreError - SAP System-specific setting, <partition> is optional, defaults to GLOBAL.
• /configuration/sap/bw/log/IgnoreError - System-wide setting, used when the SAP System-specific key is not set.

JobLogFormat

The following registry entry specifies the fields of the SAP job log to retrieve.

Note that when you create this registry entry it will be read by the process servers; a process server restart is required when you change the value, though.

• /configuration/sap/<Partition>.<SAPSystem>/JobLogFormat/joblog - CCMS jobs for SAP system <Partition>.<SAPSystem> (<partition> is optional, defaults to GLOBAL).
• /configuration/sap/<Partition>.<SAPSystem>/JobLogFormat/bwchain - BW_ProcessChain for SAP system <Partition>.<SAPSystem> (<partition> is optional, defaults to GLOBAL).
• /configuration/sap/JobLogFormat/joblog - global setting for CCMS job logs on all SAP systems for which the SAP System-specific key is not set.
• /configuration/sap/JobLogFormat/bwchain - global setting for BW_ProcessChain job logs on all SAP systems for which the SAP System-specific key is not set.

An example value of such an entry for registry entry /configuration/sap/JobLogFormat/joblog:

ENTERTIME, ENTERDATE, MSGID, MSGNO, MSGTYPE, TEXT

Field	Description
ENTERTIME	Job log entry time
ENTERDATE	Date of entry into job log
MSGID	Message Class
MSGNO	Message Number
MSGTYPE	Message Type
TEXT	Message text

KilledMessages

If this registry entry is set, the specified codes in the log files of SAP jobs will force the job to Killed.

• /configuration/sap/<partition>.<SAP system>/xbp/joblog/KilledMessages
• /configuration/sap/xbp/joblog/KilledMessages

Default value: 00518, 00554, 00564, 00574, 00660, 00663, 00671, BT608

The following table lists the default codes:

Value	Reason
00	Message class 00
518	Job cancelled
554	Job also cancelled due to process termination. See the system log
564	Job cancelled after system exception ERROR_MESSAGE
574	Job cancelled due to system shutdown
660	Session was deleted by system administrator
663	Work process re-started, session terminated
671	ABAP/4 processor: &
BT	Message class BT
608	Job status was manually set to Canceled

See this site for a list of possible values and their meaning.

output

By default SAP output file notifications are created as operator messages. You can choose to create process notes or ignore output file notifications.

• /configuration/sap/output/Notification=<notification_type>
• /configuration/sap/<Partion.SAPSystem>/output/Notification=<notification_type>

<notification_type> can be set to OperatorMessage, JobNote, or Ignore.

• OperatorMessage - Output notifications are created as operator messages. This is the default.
• JobNote - Output notifications are created as job notes.
• Ignore - No output notifications are created

Output notifications include:

• joblog / spool exceeding size limits
• PDF spool exceeding number of pages limit
• unsupported spool format
• empty spool

note

The registry entry is read only once when the SAP process server starts up, as such changes to this registry entry require a restart of the SAP process server.

RestartMode

By default, monitored BW chains have the restart option set to (F)ailed, this can be overridden using the following registry entries:

• /configuration/sap/<Partition>.<SAPSystem>/bw/restart/RestartMode - SAP System-specific, <partition> is optional, defaults to GLOBAL.
• /configuration/sap/bw/restart/RestartMode - system-wide setting, only used when SAP System-specific setting is not set.

Allowed values:

• N - monitored BW chains are not restartable
• F - monitored BW chains are restartable, only failed processes are shown (default)
• A - monitored BW chains are restartable, all processes are shown

note

This applies only to monitored BW chains, so those that were started in BW. BW chains started in BPA have a parameter that defines the restart behavior.

ReturnCodeOperatorMessages

When return code mapping is performed, operator messages are issued. If you do not want these messages, you can set the following registry entry to false:

1. /configuration/sap/<Partition>.<SAPSystem>/xbp/ReturnCodeOperatorMessages - SAP System-specific, <partition> is optional, defaults to GLOBAL.
2. configuration/sap/xbp/ReturnCodeOperatorMessages - system-wide setting, only used when SAP System-specific setting is not set.

SolutionManagerURL

Redwood Server integrates with SAP Solution Manager to allow you to seamlessly file incident reports. The following registry entry must be set to the incident report Web Dynpro application of SAP Solution Manager:

/system/ui/configuration/SolutionManagerURL

Syntax:

http://<solman_host>:<solman_port>/sap/bc/webdynpro/sap/ags_work_incident_create_app

Example:

http://solman.example.com:53000/sap/bc/webdynpro/sap/ags_work_incident_create_app

SolutionManagerUserName

This registry entry is used in conjunction with the SolutionManagerURL registry entry above. By default, the Reporter User Id is determined from the Redwood Server login credentials. You can override the Reporter User Id using the following registry entry:

/user/<username>/ui/configuration/SolutionManagerUserName

note

Note that this registry entry is set in the user-hive of the Redwood Server registry; it will have to be set for each user that requires it independently.

SolutionManagerBPABaseNumber

This registry entry is used in conjunction with the SolutionManagerURL registry entry above. The value of this registry entry will be used for the IBase number of the SAP System in the incident report.

/system/ui/configuration/SolutionManagerBPABaseNumber

note

This registry entry overrides registry entries SolutionManagerBPAInstallationNumber and SolutionManagerBPAClientNumber.

SolutionManagerBPAInstallationNumber

This registry entry is used in conjunction with the SolutionManagerURL registry entry above. The value of this registry entry will be used for the Installation number of the SAP System in the incident report. This registry entry is ignored if the SolutionManagerBPABaseNumber registry entry above has been set.

/system/ui/configuration/SolutionManagerBPAInstallationNumber

SolutionManagerBPAClientNumber

This registry entry is used in conjunction with the SolutionManagerURL and SolutionManagerBPAInstallationNumber registry entries above. The value of this registry entry will be used for the Client number of the incident report. If this is not set, the default of 000 will be used. This registry entry is ignored if the SolutionManagerBPABaseNumber registry entry above has been set.

/system/ui/configuration/SolutionManagerBPAClientNumber

StepUserList

The StepUserList registry entry allows you to specify a list of users that are allowed to be used as step users (parameter SAP_USER_NAME). You enforce a non-empty SAP_USER_NAME by specifying * in the StepUserList registry entry, in this case, any valid SAP user is allowed.

1. /configuration/sap/<Partition>.<SAPSystem>/xbp/StepUserList - SAP System-specific.
2. /configuration/sap/xbp/StepUserList - system-wide defaults, only used when SAP System-specific key is not set.

SynchronizationMode

Normally the synchronization mode is automatically selected based on the availability of the transport files and the XBP version. However, sometimes there are situations where a particular method has advantages over the other, for example: XBP 2.0 synchronization confirms jobs that were seen by Redwood Server, while Redwood transports and/or XBP 3.0 do not do this.

If the values do not match the capabilities of the SAP system (for example, use of transports is set but no transports are installed) it will automatically select the next best synchronization mode among T, 3, 2...

• /configuration/sap/xbp/synchronization/SynchronizationMode
• /configuration/sap/<Partition.SAPSystem>/xbp/synchronization/SynchronizationMode

Allowed values:

• T - use transport files
• 0 - use XBP 0.1 synchronization
• 1 - use XBP 1.0 synchronization
• 2 - use XBP 2.0 synchronization
• 3 - use XBP 3.0 synchronization

Normally the synchronization mode is automatically selected based on the availability of the transport files and the XBP version. However, sometimes there are situations where a particular method has advantages over the other, for example: XBP 2.0 synchronization confirms jobs that were seen by Redwood Server, while Redwood transports and/or XBP 3.0 do not do this.

If the values do not match the capabilities of the SAP system (for example, use of transports is set but no transports are installed) it will automatically select the next best synchronization mode among T, 3, 2...

tip

The value is used by the SAPR3 service as soon as it is detected, there is no need to restart the process server.

note

When the process server parameter SAP_UseTransports is set to false, the transport files might not have been installed correctly. In this case, the use of transport files will not be possible regardless of the value of the registry entry.

ViewerURL

You specify the viewer URL for BusinessObjects Reports to be able to access them from within Redwood Server.

• /configuration/sap/bobj/ViewerURL - system-wide URL.
• /configuration/sap/<Partition>.<BOBJ System>/bobj/ViewerURL - BusinessObjects system-specific URL (Note that you do not specify the partition for BusinessObjects residing in the GLOBAL partition).

Example 1:

/configuration/sap/bobj/ViewerURL=${URL}/${KIND}s/viewrpt.cwr?id=${ID}

For a Crystal Report job executed on a BOBJ system with J2EE URL http://bobj.example.com:8080 with the report id 1234 this would be automatically translated into:

http://bobj.example.com:8080/CrystalReports/viewrpt.cwr?id=1234

Platform Agent-Related

SimultaneousReconnections

When the connection has been interrupted between a platform agent and the central Redwood Server, you can specify how many concurrent reconnection attempts are made with the following registry entry:

/configuration/PlatformAgent/SimultaneousReconnections

note

The default value is fine for most, if not all scenarios. Only change this value if Redwood support services ask you to do so.

Promotion Module-Related Registry Keys

export

The following registry entry holds the alias for a remote system object. The name of Source and Both remote systems must match either the last part of the system.id license key or the alias as defined in the following registry entry:

/configuration/export/name

JobResolutionAction

Process Definitions and chain definitions overwritten by the import that have processes in an initial state ( New, Scheduled, Held, Modified ) will by default use the old process definition. You customize the promotion module process definition and chain definition import behavior by specifying the following registry entry:

• /configuration/Promotion/JobResolutionAction

The following values are accepted:

• UseOldJobDefinition - the old definitions are used (default).
• UseNewJobDefinition - the new definitions are used.
• CancelAndRestart - current processes and canceled and restarted with the new process definition.
• HoldJob - the process is set to status Held, retaining the old definition.
• CancelJob - the process or chain is canceled.
• SetToError - the process is set to status Error.
• Abort - the import is aborted.

User Hive

You usually use the options dialog to set registry entries in the user hive, the following key can to be set manually.

ExpirationNotification

You can set when the license expiration warning starts warning about the approaching expiration. The default value is 28 days, the minimum is 7 days.

/user/<username>/ui/configuration/ExpirationNotification

MessageOfTheDay

The Message of the day (MessageOfTheDay) is used to inform users of down-times, maintenance windows and other important information. Once you have read the document, you can suppress it from appearing each time you log in. It will only re-appear once the document has been updated. By setting the following registry entry to a high number, you can suppress it completely. The value is milliseconds since Jan 1 1970.

/user/<user>/behavior/MessageOfTheDay/suppress

See Messages of the Day Document section for more information.

Partition

You specify the default partition for a specific user in the following registry key:

/user//ui/configuration/Partition

The user will need to log out and log in again for the change to take effect.