Server settings

13 minute readReference

This page serves as a reference to all CloudBees CD/RO server settings. Server settings are divided into catagories based on their function and control various aspects of CloudBees CD/RO server operation. To access server settings in the CloudBees Software Delivery Automation UI, select Administration Server Settings from the main menu. From here you can view or edit settings as needed.

Only CloudBees Software Delivery Automation system administrators have privileges to modify settings.

Each entry contains:

  • The name as it appears in the Server settings UI.

  • The corresponding property name to use with property management commands to programmatically manage its value.

  • A description.

  • The default value.

  • The license type for which the setting is available. Choices are

    • CloudBees CD/RO: Available for installations with license type Server.

    • CloudBees Software Delivery Automation: Available for installations with license type SDA.

    For example, a setting available only for CloudBees CD/RO denotes it is only available on installations with a Server license. Learn more about licenses here.

Agent Settings

SettingPropertyDescription

Agent abort timeout

/server/settings/agentAbortTimeout

The number of milliseconds the server waits for responses to the abort agent command. After this timeout has elapsed, the step is force aborted.

Default value: 90000

Applicable for: CloudBees CD/RO

Agent connection timeout

/server/settings/agentConnectionTimeout

The number of milliseconds to wait for connections to agents to open.

Default value: 60000

Applicable for: CloudBees CD/RO

Agent heartbeat interval

/server/settings/agentHeartBeatInterval

The number of seconds between pings to all enabled and busy agents. An update of this setting takes effect after server restart.

Default value: 3600

Applicable for: CloudBees CD/RO

Agent heartbeat spread

/server/settings/agentHeartBeatSpread

If true, the heartbeat pings to all enabled and busy agents in other zones are spread out over the period of the agent heartbeat interval, rather than all happening at the beginning of the interval. This reduces load spikes in ping traffic through zone gateways, but makes it take longer after a server restart for agents in other zones to pick up on changes to the server. An update of this setting takes effect after server restart.

Default value: false

Applicable for: CloudBees CD/RO

Agent ping failure max retry interval

/server/settings/agentPingFailureMaxRetryInterval

When an agent ping fails, the max interval, in seconds, at which the server re-pings the agent until the ping succeeds, the resource is disabled, or the resource is deleted.

Default value: 300

Applicable for: CloudBees CD/RO

Agent socket timeout

/server/settings/agentSocketTimeout

The number of milliseconds the server waits for responses to agent commands.

Default value: 60000

Applicable for: CloudBees CD/RO

Agent waits for all descendants

/server/settings/agentWaitsForAllDescendants

Controls how the agent determines step completion. true means that the agent waits for all processes generated by a step to terminate for the step to be considered completed. false means that the agent only waits for the top-level child process (e.g. the shell) to terminate for the step to be considered completed.

Default value: false

Applicable for: CloudBees CD/RO

Default agent host type

/server/settings/defaultAgentHostType

Controls the default setting for a agent host type when it is not defined while creating a resource. Valid values are concurrent or registered

Default value: ``

Applicable for: CloudBees CD/RO

Default agent port

/server/settings/defaultAgentPort

The default port number used by agents.

Default value: 7800

Applicable for: CloudBees CD/RO

Idle connection timeout

/server/settings/agentIdleConnectionTimeout

The number of milliseconds to keep idle connections open.

Default value: 300000

Applicable for: CloudBees CD/RO

Maximum agent connections total

/server/settings/maxAgentConnectionsTotal

Controls how many connections the server will open across all agents. If the connection limit is reached, the server will enqueue additional requests.

Default value: 2000

Applicable for: CloudBees CD/RO

Maximum connections per agent

/server/settings/maxAgentConnectionsPerRoute

Controls how many connections the server will open to a single agent. If the connection limit is reached, the server will enqueue additional requests.

Default value: 20

Applicable for: CloudBees CD/RO

Artifact Management

SettingPropertyDescription

Artifact Publish from UI

/server/settings/allowArtifactPublishFromUI

Controls visibility of Publish Artifact button on UI.

Default value: true

Applicable for: CloudBees CD/RO

Artifact Version name template

/server/settings/artifactVersionNameTemplate

The default template used to name new artifactVersions.

Default value: $[/myArtifactVersion/groupId]:$[/myArtifactVersion/artifactKey]:$[/myArtifactVersion/version]

Applicable for: CloudBees CD/RO

Initial delay between retries for Retrieve Artifact

/server/settings/initialDelayBetweenRetriesForRetrieveArtifact

Initial delay (in milliseconds) between retries when doing artifact retrieval.

Default value: 100

Applicable for: CloudBees CD/RO

Maximum delay between retries for Retrieve Artifact

/server/settings/maximumDelayBetweenRetriesForRetrieveArtifact

Maximum delay (in milliseconds) between retries when doing artifact retrieval.

Default value: 30000

Applicable for: CloudBees CD/RO

Maximum upload size

/server/settings/maxUploadSize

Specifies the maximum size of file that the server will accept as an uploaded attachment.

Default value: 250000000

Applicable for: CloudBees CD/RO

Number of retries for Retrieve Artifact

/server/settings/numberOfRetriesForRetrieveArtifact

Number of retries when doing artifact retrieval.

Default value: 3

Applicable for: CloudBees CD/RO

Upload Artifact Directory

/server/settings/uploadArtifactDirectory

Upload Artifact Directory.

Default value: true

Applicable for: CloudBees CD/RO

Data Retention

SettingPropertyDescription

Data Retention Management

/server/settings/enableDataRetentionManagement

When enabled, the data retention management service is run periodically to archive or purge data based on the defined data retention policies.

Default value: true

Applicable for: CloudBees CD/RO

Data Retention Management batch size

/server/settings/dataRetentionManagementBatchSize

Number of objects to process as a batch for a given data retention policy in one iteration.

Default value: 100

Applicable for: CloudBees CD/RO

Data Retention Management service frequency in minutes

/server/settings/dataRetentionManagementFrequencyInMinutes

Controls how often, in minutes, the data retention management service is scheduled to run.

Default value: 1440

Applicable for: CloudBees CD/RO

Maximum iterations in a Data Retention Management cycle

/server/settings/maxDataRetentionManagementIterations

Maximum number of iterations performed in a scheduled data retention management cycle.

Default value: 10

Applicable for: CloudBees CD/RO

Number of minutes after which archived data maybe purged

/server/settings/purgeArchivedDataAfterMinutes

Number of minutes after which archived data maybe purged if a data retention policy is setup to purge the data after archiving.

Default value: 10080

Applicable for: CloudBees CD/RO

Email Notifications

SettingPropertyDescription

Date and time format for email notifications

/server/settings/dateFormatPattern

Format to use for rendering date and time in email notifications

Default value: yyyy-MM-dd’T’HH:mm:ss.SSSZ

Applicable for: CloudBees CD/RO

Date and time timezone for email notifications

/server/settings/timezone

Timezone to use for rendering date and time in email notifications

Default value: UTC

Applicable for: CloudBees CD/RO

Set the 'From' header when sending email notifications

/server/settings/setFromEmailHeader

If true, set the From header in the email message.

Default value: true

Applicable for: CloudBees CD/RO

JavaScript

SettingPropertyDescription

Maximum JavaScript duration

/server/settings/maxJavaScriptDuration

Controls the maximum duration of JavaScript execution, in seconds.

Default value: 15

Applicable for: CloudBees CD/RO

Maximum JavaScript stack depth

/server/settings/maxJavaScriptStackDepth

Controls the maximum stack depth allowed in JavaScript.

Default value: 100

Applicable for: CloudBees CD/RO

Property Modification in JavaScript

/server/settings/javaScriptReadOnly

If true, property modification in JavaScript is not allowed.

Default value: false

Applicable for: CloudBees CD/RO

Name Templates

SettingPropertyDescription

Application process job name template

/server/settings/appProcessJobNameTemplate

The default template used to name new jobs created from a application process run.

Default value: $$[/myJob/processName]$$[/myJob/projectName]$[/timestamp yyyyMMddHHmmss]

Applicable for: CloudBees CD/RO

Flow name template

/server/settings/flowNameTemplate

The default template used to name flow runtimes.

Default value: flow_$[/increment /server/ec_counters/flowCounter]_$[/timestamp yyyyMMddHHmmss]

Applicable for: CloudBees CD/RO

Job name template

/server/settings/jobNameTemplate

The default template used to name new jobs.

Default value: job_$[/increment /server/ec_counters/jobCounter]_$[/timestamp yyyyMMddHHmmss]

Applicable for: CloudBees CD/RO

Pipeline name template

/server/settings/pipelineNameTemplate

The default template used to name pipeline runtimes.

Default value: $$[/increment /myPipeline/ec_counters/pipelineCounter]$[/timestamp yyyyMMddHHmmss]

Applicable for: CloudBees CD/RO

Release name template

/server/settings/releaseNameTemplate

The default template used to name pipeline runtimes associated with release.

Default value: $$[/myPipeline]$[/increment /myPipeline/ec_counters/pipelineCounter]_$[/timestamp yyyyMMddHHmmss]

Applicable for: CloudBees CD/RO

Service process job name template

/server/settings/serviceProcessJobNameTemplate

The default template used to name new jobs created from a service process run.

Default value: $$[/myJob/processName]$$[/myJob/projectName]$[/timestamp yyyyMMddHHmmss]

Applicable for: CloudBees CD/RO

Workflow name template

/server/settings/workflowNameTemplate

The default template used to name new workflows.

Default value: workflow_$[/increment /server/ec_counters/workflowCounter]_$[/timestamp yyyyMMddHHmmss]

Applicable for: CloudBees CD/RO

Pipeline

SettingPropertyDescription

Enable progress percentage data fix

/server/settings/enablePipelineRunProgressPercentageDataFix

Flag to indicate if progress percentage for previously completed pipeline or release runs is enabled.

Default value: true

Applicable for: CloudBees CD/RO

Enable root flowRuntime reference fix

/server/settings/enableRootFlowRuntimeReferenceFix

Flag to indicate if fixing up for root flowRuntime references for old flowRuntimeStates is enabled

Default value: true

Applicable for: CloudBees CD/RO

Maximum number of required approvals

/server/settings/maxRequiredApprovalsCount

Maximum number of users from a group that should approve a gate rule or a manual task to make it finally approved.

Default value: 3

Applicable for: CloudBees CD/RO

Pipeline task runtime job name template

/server/settings/pipelineTaskRuntimeJobNameTemplate

The default template used to name new jobs created from a pipeline task runtime when running a procedure.

Default value: $$[/myTaskRuntime/id]$[/timestamp yyyyMMddHHmmss]

Applicable for: CloudBees CD/RO

Portfolio View Auto Refresh Threshold

/server/settings/portfolioViewAutoRefreshThreshold

Auto refresh in the Portfolio Views will be disabled when the number of records reaches this threshold.

Default value: 50

Applicable for: CloudBees CD/RO

Users to Change the Pipeline UI Preference

/server/settings/allowUsersToChangePipelineUIPreference

If true, users will be able to change their pipeline UI preference.

Default value: false

Applicable for: CloudBees CD/RO

View for Pipelines

/server/settings/useReleaseKanbanViewForPipelines

If true, use Release Kanban view for pipelines.

Default value: true

Applicable for: CloudBees CD/RO

flowRuntime Hierarchy Data Fix

/server/settings/enableFlowRuntimeHierarchyDataFix

Flag to indicate if flowRuntime hierarchy data fix is enabled

Default value: true

Applicable for: CloudBees CD/RO

SDM

SettingPropertyDescription

CloudBees Account

/server/settings/cloudBeesAccount

Applicable if 'Connect to CloudBees Platform' is checked.

Default value: cloudbees

Applicable for: CloudBees CD/RO

CloudBees Platform Server

/server/settings/cloudBeesPlatform

Applicable if 'Connect to CloudBees Platform' is checked.

Default value: ``

Applicable for: CloudBees CD/RO

Connect to CloudBees Platform

/server/settings/connectToCloudBeesPlatform

If checked, CloudBees Platform services will be available to this instance of CloudBees CD/RO. The CloudBees CD/RO App must be registered in the platform instance to enable communication with the platform.

Default value: false

Applicable for: CloudBees CD/RO

Default SDM Platform synchronization frequency

/server/settings/platformSynchronizationFrequency

Default SDM Platform synchronization frequency, in minutes.

Default value: 30

Applicable for: CloudBees CD/RO

Private Key for the CD app installed on the Platform

/server/settings/cdPlatformAppPrivateKey

Required if 'Connect to CloudBees Platform' is checked.

Default value: ``

Applicable for: CloudBees CD/RO

Refresh token required to get access token for CD app installed on the Platform

/server/settings/cdPlatformAppRefreshToken

Required if 'Connect to CloudBees Platform' is checked.

Default value: ``

Applicable for: CloudBees CD/RO

System of Record Endpoint

/server/settings/systemOfRecordEndpoint

Applicable if 'Connect to CloudBees Platform' is checked.

Default value: ``

Applicable for: CloudBees CD/RO

Scheduler Settings

SettingPropertyDescription

Maximum background delete batch size

/server/settings/deleteObjectsBatchSize

Maximum number of objects to delete in a single batch.

Default value: 100

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Maximum background delete delay

/server/settings/maxBackgroundDeleteDelay

Controls the maximum amount of time between invocations of the background delete thread, in seconds.

Default value: 3600

Applicable for: CloudBees CD/RO

Maximum expired sessions delete batch size

/server/settings/deleteExpiredSessionsBatchSize

Maximum number of expired sessions to delete in a single batch.

Default value: 100

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Maximum number of job steps to process before resource scheduler commits pending work

/server/settings/resourceSchedulerBatchSize

Specifies the maximum number of job steps the resource scheduler will process before committing pending work. This setting is considered along with the timeout calculated using resourceSchedulerMinTimeout and resourceSchedulerMaxTimeout. Whichever event occurs first determines the total amount of pending work that is committed in one cycle by the resource scheduler.

Default value: 500

Applicable for: CloudBees CD/RO

Maximum number of log calls in a scheduler pass

/server/settings/resourceSchedulerMaxLogCount

Number of log calls during a scheduler pass after which log output from the scheduler is throttled.

Default value: 100

Applicable for: CloudBees CD/RO

Maximum step retry delay

/server/settings/maxStepRetryDelay

Maximum delay in milliseconds between retries after a failed attempt to start a job step on a resource.

Default value: 30000

Applicable for: CloudBees CD/RO

Maximum time before resource scheduler commits pending work

/server/settings/resourceSchedulerMaxTimeout

Specifies the most amount of time in milliseconds that the resource scheduler will continue to look for other schedulable steps before committing pending assignments.

Default value: 20000

Applicable for: CloudBees CD/RO

Maximum time in minutes between runs of the resource scheduler (if not otherwise triggered) when operating in a cluster

/server/settings/resourceSchedulerClusterMaxTimeBetweenRuns

Specifies the longest amount of time between runs (if not triggered) of the resource scheduler in a cluster. The purpose of this is to ensure that even if a resource scheduler trigger message between nodes is lost due to network problems, the job will not be stalled indefinitely if no other jobs are running.

Default value: 10

Applicable for: CloudBees CD/RO

Minimum time before resource scheduler commits pending work

/server/settings/resourceSchedulerMinTimeout

Specifies the least amount of time in milliseconds that the resource scheduler will continue to look for other schedulable steps before committing pending assignments.

Default value: 10000

Applicable for: CloudBees CD/RO

Number of separate threads the resource scheduler attempts to split its work across

/server/settings/resourceSchedulerBucketCount

Specifies the number of buckets that the step scheduler attempts to divide resources into, and thus the number of threads that it runs to handle these buckets of work. Defaults to 1, minimum 1, maximum 8. An update of this setting takes effect after server restart.

Default value: 1

Applicable for: CloudBees CD/RO

Security Settings

SettingPropertyDescription

Auto register SSO users

/server/settings/enableSSOUserAutoRegistration

Whether users authenticated by the SSO identity providers will be automatically registered, if not available through the configured directory providers.

Default value: true

Applicable for: CloudBees CD/RO

Credential Password Recovery

/server/settings/credentialPasswordRecoveryAllowed

Controls the default setting of whether credential password recovery is allowed. If true, then credentials that don’t explicitly override this setting will be recoverable.

Default value: true

Applicable for: CloudBees CD/RO

Enable ACL caching

/server/settings/enableAclCaching

If true, enable ACL caching.

Default value: true

Applicable for: CloudBees CD/RO

Enable admin user

/server/settings/enableAdminUser

If true, enable logins by the admin user.

Default value: true

Applicable for: CloudBees CD/RO

Group claim SAML attribute delimiter

/server/settings/groupClaimSAMLAttributeDelimiter

Delimiter used in case multiple groups are sent as a single-valued attribute in the SAML response.

Default value: ,

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Idle login session timeout

/server/settings/sessionTimeout

Number of minutes before an idle user session is terminated.

Default value: 4320

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Local Users

/server/settings/enableLocalUsers

If true, enable logins by local users.

Default value: true

Applicable for: CloudBees CD/RO

Protocols for SSL connections to the SMTP server

/server/settings/smtpSSLProtocols

Whitespace-separated list of protocols that will be enabled for SSL connections to the SMTP server. Used to set mail.smtp.ssl.protocols system property.

Default value: TLSv1.2

Applicable for: CloudBees CD/RO

System Settings

SettingPropertyDescription

Default background plugin statistics thread schedule

/server/settings/defaultBackgroundPluginStatistcisSchedule

Default background plugin statistics watchdog thread schedule

Default value: 7200

Applicable for: CloudBees CD/RO

Delay between cluster membership change and a resulting change of service leadership

/server/settings/serviceResignationDelay

In clustered mode, this specifies the delay in seconds from when a node gets notification of a change in cluster membership that causes it to no longer be the node hash-designated to run a service that it is currently the leader for until when that node resigns from leadership of that service and precipitates a new leadership election. This delay is intended to allow cluster membership to stabilize (e.g. when several nodes are started or stopped together), and to allow time for all nodes to be notified of the changes and for the new hash-designated owner to submit its name for election.

Default value: 60

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Enable Hibernate statistics logging

/server/settings/enableHibernateStatistics

If true, enable per-operation Hibernate statistics logging.

Default value: true

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Enable sending statds metrics

/server/settings/enableStatsdMetrics

If true (and a statsd metrics server has been configured), enables sending system metrics to that server.

Default value: true

Applicable for: CloudBees CD/RO

Enabling/disabling change tracking at a project level

/server/settings/allowEnablingDisablingChangeTrackingAtProjectLevel

Controls who is allowed to enable/disable change tracking at a project level. Valid values are adminOnly or anyoneWithAccess

Default value: adminOnly

Applicable for: CloudBees CD/RO

Event log retain time

/server/settings/eventLogRetainTime

Number of minutes worth of entries to retain in the event log. Zero disables automatic deletion of event log entries.

Default value: 43200

Applicable for: CloudBees CD/RO

How often to record cluster diagnostics

/server/settings/clusterDiagnosticsFrequency

Controls how often cluster diagnostics are emitted to the server log, in seconds.

Default value: 900

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

How often to record memory diagnostics

/server/settings/memoryDiagnosticsFrequency

Controls how often server memory usage diagnostics are emitted to the server log, in seconds.

Default value: 900

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Job summaries minimum jobs

/server/settings/getJobSummariesMinJobs

Minimum number of jobs the getJobSummaries API requests from the database.

Default value: 50

Applicable for: CloudBees CD/RO

Max DSL duration

/server/settings/maxDslDuration

Controls the maximum duration of DSL execution, in seconds.

Default value: 300

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Maximum Number of Records for Change Tracking

/server/settings/changeTrackingMaxRecords

Maximum number of records returned by any change tracking query. Cannot exceed and defaults to a value CHANGE_TRACKING_HARD_MAX_RECORDS set in wrapper.conf

Default value: 0

Applicable for: CloudBees CD/RO

Maximum connections to the database

/server/settings/databaseConnectionPoolSize

Controls the maximum number of database connections the server can use.

Default value: 200

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Maximum idle time before a user license expires

/server/settings/licenseIdleTimeout

Specifies the maximum idle time of a user’s license in seconds before it is returned to the pool of available licenses.

Default value: 600

Applicable for: CloudBees CD/RO

Maximum logged message length

/server/settings/maxLoggedMessageLength

Controls the maximum size of an XML message that the server will log. Messages larger than this will be truncated.

Default value: 8192

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Plugins directory

/server/settings/pluginsDirectory

Specifies the directory where plugins will be installed by the server. If not provided, defaults to ${DATA_DIRECTORY}/plugins.

Default value: ``

Applicable for: CloudBees CD/RO

Reservation recurrence interval

/server/settings/reservationRecurrenceInterval

Used as default recurrence end time for a reservation when generating time slots

Default value: 100

Applicable for: CloudBees CD/RO

SSL for Stomp

/server/settings/stompSecure

If provided, determines whether the stomp protocol uses SSL. If not provided, the default is to use SSL. The server must be restarted for the setting to take effect.

Default value: true

Applicable for: CloudBees CD/RO

Select resources in creation order from pools

/server/settings/useCreationOrderInResourcePools

Controls the order in which pooled resources are selected when other criteria (exclusivity, step count, e.g.) are the same. If true, pre-3.10 behavior is used (creation order). If false, the resource is chosen randomly.

Default value: false

Applicable for: CloudBees CD/RO

Send Usage Data

/server/settings/enableTelemetry

This information is used by CloudBees to help make CloudBees CD/RO better and more intuitive to use. Telemetry collects anonymized aggregated information and does not collect any identifying information like user names. For privacy reasons, you can turn off the ability to send telemetry data to CloudBees.

Default value: true

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Server IP address

/server/settings/ipAddress

If provided, this property is sent to the agents as the IP address of the server. If not present, the server sends the IP address of its first non-localhost network interface.

Default value: ``

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Server status message capacity

/server/settings/serverStatusMessageCapacity

The maximum number of server status messages that will be preserved. Older messages will be removed to make room for new ones.

Default value: 1000

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Stomp Client URI

/server/settings/stompClientUri

If provided, this property is used as the URI for stomp clients. If not present, a default value is calculated using the server’s host name. The server must be restarted for the setting to take effect.

Default value: ``

Applicable for: CloudBees CD/RO

Temporary directory

/server/settings/temporaryDirectory

Specifies the directory where the server should place temporary files that it creates. If a relative path is specified, the directory is considered relative to the DATA_DIRECTORY.

Default value: tmp

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Tutorials

/server/settings/enableTutorials

Controls if the tutorials should be enabled or disabled.

Default value: true

Applicable for: CloudBees CD/RO

UI auto-refresh frequency in seconds

/server/settings/autoRefreshFrequency

Controls how often, in seconds, only the UI pages such as the pipeline and release runs page automatically refresh. This setting is not for other platform pages.

Default value: 30

Applicable for: CloudBees CD/RO

Wait time for job which is waiting for reservation

/server/settings/waitForReservationHours

Wait time for job which is waiting for reservation

Default value: 2

Applicable for: CloudBees CD/RO

Web Server Host

/server/settings/webServerHost

Specifies the web server host. This field can be specified as <hostname> or <hostname>:<port>, if port is other than 80. If load balancer is used for web servers, then set value to the load balancer’s host. If this value is not set, then access to this property would return value from /server/hostName.

Default value: ``

Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO

Webhook session timeout

/server/settings/webhookSessionTimeout

Number of minutes before a webhook session is terminated.

Default value: 259200

Applicable for: CloudBees CD/RO