IntroductionInstallationFrequently asked questionsConfiguration values
IntroductionSpecial-case installationsInstaller optionsServer topology best practicesDefault installation directories
IntroductionDefault configurationCustom configurationExpress agentExpress agent-onlyAdvanced agent-onlyCloudBees Analytics server
IntroductionExpress serverAdvanced serverExpress agentExpress agent-only (standalone)Advanced agent-only (standalone)CloudBees Analytics server installation
IntroductionSilent install overviewSilent install argumentsLinux installation examplesWindows installation examplesLinux repository server installation exampleWindows repository server installation exampleWindows or Linux CloudBees Analytics server installation example
IntroductionUNIX agent interactive command-lineUNIX agent unattended
IntroductionPrerequisitesPermissionsInstalling via the web interfaceInstalling via the API
Moving the artifact repository in Linux
Moving the artifact repository in Windows
Connecting CloudBees CD/RO to a Microsoft SQL server
Installing the MySQL JDBC driver
IntroductionUninstalling CloudBees CD/RO on Linux, Unix, or macOSUninstalling CloudBees CD/RO on WindowsUninstalling the CloudBees Analytics Server on LinuxUninstalling the CloudBees Analytics Server on Windows
Signing in to CloudBees CD/RO
Introduction
Microservice applications
IntroductionArtifact stagingSnapshotsRollbackManaging dependencies
IntroductionApplications and processesCreating processesAdding process stepsProcess branchingPlugin process stepsManual steps and tasksExample: manual step with runtime parameters
IntroductionCreating environmentsCreating environment tier mapsInventory trackingEnvironment inventoryEnvironment reservationsEnvironment lockingModeling dynamic environmentsAutomated environment discoveryExample: dynamic environment with Amazon and Chef
IntroductionMaster Component ExamplesMaster components list
IntroductionApplication deploy optionsDeploying and troubleshooting applicationsDeployment packagesDeployment examplesDeploying applications with provisioned cloud resourcesExample: implementing deployment strategies
Property reference use case
Creating a project
Parameters
Full-stack dependency view
Configuration drift
Attaching credentials to processes
Developer task: creating custom plugins
Introduction
Release and Environment Reservations Calendar
Visibility and Status of Release Pipelines
Release Definition
Release Dashboard
Planned Versus Actual View
Path to Production View
Release Summary
IntroductionPipeline concepts
Pipeline stages and gates
Pipeline access control
Pipeline tasks
Entry and exit gates
Pipeline conditions
Pipeline start and end stages and stage skipping
Wait dependencies
Native CI integration
Event-based triggers
IntroductionAuthoring and running pipelines
Defining gate approvals
Pipeline objects and conditions
Pipeline stage summary
IntroductionPipeline examples
Example: Creating a manual task in a pipeline
Example: plugin pipeline tasks
Example: integrating test automation in release pipelines
Example: leveraging test data management and service virtualization in release pipelines
Example: Surfacing Jenkins build details in Flow
Signing in to CloudBees CD/RO
Guided Tutorials
Home page
Personas
Access control
My work dashboard
Object list layout
Object schedules
IntroductionPaginationSearching and filteringHierarchy menuProperty browserProjects in CloudBees CD/ROObject tags
IntroductionCleanupStalledJobClusterInfoTooleccertecconfigureecdaemonecproxyecremotefilecopyZKConfigtool
IntroductionThe default zone and gateways to remote zonesSetting agent environment variablesLicensesExternal Database ConfigurationConfiguring CloudBees CD/RO to Use an Alternate DatabaseConfiguring autostart for non-root/non-sudo Linux installationsUniversal access to the plugins directoryEnvironment proxy server configurationSystem health monitoringIncreasing file descriptors on LinuxAdjusting swappiness on LinuxSetting variables on Windows agent machinesConfiguring Kibana to work with CloudBees AnalyticsServer settings
Data Retention
IntroductionPerformance consequences of change trackingEstimating database growthBest practices for change trackingConfiguring change trackingSearching the change historyViewing the change historyModifying what you see in the change historyReverting changes to a tracked object and its tracked contentsExporting a previous state of a tracked object and its tracked contents
IntroductionSetting Email NotificationsSelecting and Editing Email Messages for Application or Microservice Processes
Producing audit reports
Configuration drift
Self-Service Catalogs
IntroductionArchitecture of a CloudBees CD/RO ClusterResource, agent, and procedure considerationsSoftware for clusteringDependencies for clusteringConfiguring clusteringSeparating agents from flow serversPreparing your cluster resourcesInstalling and configuring a load balancerInstalling ZooKeeperConfiguring a multi-ZooKeeper clusterInstalling CloudBees CD/RO softwareConfiguring repository serversConfiguring machines to operate in clustered modeRunning a cluster in single-server modeAdding the configuration to ZooKeeperUploading configuration files to ZooKeeperGetting Information on the CloudBees CD/RO server cluster from ZooKeeperAdding a node to an existing clusterConfiguring web server propertiesConfiguring repository server propertiesConfiguring CloudBees CD/RO agentsConfiguring the cluster workspaceConfiguring CloudBees CD/RO repositoriesAdding trusted agents to clustersVerifying CloudBees CD/RO servicesAccessing CloudBees CD/RO with clusteringHealth check for the CloudBees CD/RO clusterAdditional Ways to improve a clusterInstalling the CloudBees Analytics server in cluster modeDisaster recovery
Introduction
Build-test automation
IntroductionScenario 1 - Creating a simple procedureScenario 2 - Creating a procedure that uses an SCMScenario 3 - Notification, scheduling, and reportingScenario 4 - Multi-agent build and test
IntroductionAutomation platform home pageCustomizing the automation platform UIConfiguring CloudBees CD/ROUsing CloudBees CD/RO in your environmentCloudBees CD/RO Installed tools
IntroductionAccess controlArtifact managementAuthenticating users for ldap and active directoryAuto-discoveryDefect trackingElectricSentryJob step execution environmentPreflight buildsPostprocessorsReportsWorkflow overviewWorkspaces and disk space management
IntroductionIntrinsic propertiesProperty shortcutsProperty error codes
IntroductionAdding a link to a jobCalling a subprocedureChecking the outcome of preceding stepsConditional executionCustom parameter layoutsEmail notificationsExecuting tasks on all resources in a poolFactory proceduresPostp extensionPublishing and retrieving an artifactReserving a resource for the job step durationRunning steps in parallelStep timeouts and steps that always runStoring and retrieving properties in a jobWorking with properties stored in a procedure
Using special characters in object names
IntroductionDefining entriesCreate new or edit existing privileges
IntroductionArtifact detailsCreate new or edit existing artifactsArtifact versionsArtifact version detailsEdit an existing artifact versionRepositoriesCreate new or edit existing repositories
Database configuration
IntroductionCreate new or edit existing configurationsDefect tracking reports
IntroductionCreate new or edit existing email configurationsEmail notifiers
Event log
IntroductionJob configurationShortcutsJobs quick view
IntroductionJob step details
IntroductionView licenseImport license
Plugin manager
IntroductionCreate new or edit existing procedureCreate new or edit existing stepsPublish artifact version stepsRetrieve artifact version stepsSend email stepsExtract preflight sources stepsCreate new or edit existing parameters
IntroductionCreate new or edit existing projectsProject detailsRun proceduresCreate new or edit existing schedulesCreate new or edit existing credentials
IntroductionNested Property Sheet
Reports
IntroductionResource poolsCreate new or edit existing poolsResource pool detailsZonesGateways
IntroductionSearch results
IntroductionEdit existing property settings
IntroductionCreate new or edit existing configurations
IntroductionUsersCreate new or edit existing local usersUser detailsEdit user settingsGroupsCreate new or edit existing groupsGroup detailsDirectory providersCreate new or edit existing directory providersSingle sign-onTest directory provider
IntroductionCreate new or edit exiting workflow definitionsWorkflow definition detailsRun workflowWorkflow detailsWorkflow logTransition workflow
IntroductionCreate new or edit existing workspacesWorkspace file

Property error codes

1 minute readAutomation

The following list provides error codes that may appear as a value within an errorCode property.

ABORTED

AGENT_UNKNOWN_COMMAND

ACCESS_DENIED

AGENT_WRONG_FILE_TYPE

AGENT_BAD_WORKINGDIR

BAD_AGENT_RESPONSE

AGENT_FAILED_CONNECT_BROKER

BAD_LOGFILE_PATH

AGENT_FAILED_CREATE_FILE

CANCELED

AGENT_FAILED_CREATE_WORKSPACE

CIRCULAR_PROCEDURE_REFERENCE

AGENT_FAILED_IMPERSONATION

CORRUPT_CREDENTIAL

AGENT_FAILED_MAP_DRIVE

DUPLICATE_JOB_NAME

AGENT_FAILED_PROXYTARGET_PING

EMPTY_SUBPROCEDURE

AGENT_INCOMPATIBLE_VERSION

FAILED_JOB_RENAME

AGENT_INTERNAL_ERROR

FORMAL_PARAMETER_ERROR

AGENT_INVALID_CWD

INTERNAL_ERROR

AGENT_INVALID_MESSAGE

INVALID_EMAIL_HEADER

AGENT_INVALID_PING_TOKEN

MY_EVENT_EXPANSION_ERROR

AGENT_INVALID_WORKSPACE

NO_EMAIL_HEADERS_SEPARATOR

AGENT_IO_CONNECTION_REFUSED

NONEXISTENT_EMAIL_CONFIG

AGENT_IO_CONNECTION_RESET

NONEXISTENT_PROCEDURE

AGENT_IO_ERROR

NONEXISTENT_RESOURCE

AGENT_IO_NO_ROUTE_TO_HOST

NONEXISTENT_WORKSPACE

AGENT_IO_PORT_UNREACHABLE

NOTIFIER_EXPANSION_ERROR

AGENT_MALFORMED_XML

POST_PROCESSOR_ERROR

AGENT_NONABSOLUTE_PATH

POST_PROCESSOR_OUTPUT_FAILURE

AGENT_NONEXISTENT_DIR

PROPERTY_REFERENCE_ERROR

AGENT_NONEXISTENT_FILE

RESOURCE_WITHOUT_HOSTNAME

AGENT_PING_FAILED

SERVER_SHUTDOWN

AGENT_STREAM_STOPPED

TIMEOUT

AGENT_TIMEOUT

UNKNOWN_HOST

AGENT_UNKNOWN_CMDID

AGENT_UNKNOWN_COMMAND

AGENT_WRONG_FILE_TYPE

AGENT_UNKNOWN_COMMAND

BAD_AGENT_RESPONSE

AGENT_WRONG_FILE_TYPE

BAD_LOGFILE_PATH

BAD_AGENT_RESPONSE

CANCELED

BAD_LOGFILE_PATH

CIRCULAR_PROCEDURE_REFERENCE

CANCELED

CORRUPT_CREDENTIAL

CIRCULAR_PROCEDURE_REFERENCE

DUPLICATE_JOB_NAME

CORRUPT_CREDENTIAL

EMPTY_SUBPROCEDURE

DUPLICATE_JOB_NAME

FAILED_JOB_RENAME

EMPTY_SUBPROCEDURE

FORMAL_PARAMETER_ERROR

FAILED_JOB_RENAME

INTERNAL_ERROR

FORMAL_PARAMETER_ERROR

INVALID_EMAIL_HEADER

INTERNAL_ERROR

MY_EVENT_EXPANSION_ERROR

INVALID_EMAIL_HEADER

NO_EMAIL_HEADERS_SEPARATOR

MY_EVENT_EXPANSION_ERROR

NONEXISTENT_EMAIL_CONFIG

NO_EMAIL_HEADERS_SEPARATOR

NONEXISTENT_PROCEDURE

NONEXISTENT_EMAIL_CONFIG

NONEXISTENT_RESOURCE

NONEXISTENT_PROCEDURE

NONEXISTENT_WORKSPACE

NONEXISTENT_RESOURCE

NOTIFIER_EXPANSION_ERROR

NONEXISTENT_WORKSPACE

POST_PROCESSOR_ERROR

NOTIFIER_EXPANSION_ERROR

POST_PROCESSOR_OUTPUT_FAILURE

POST_PROCESSOR_ERROR

PROPERTY_REFERENCE_ERROR

POST_PROCESSOR_OUTPUT_FAILURE

RESOURCE_WITHOUT_HOSTNAME

PROPERTY_REFERENCE_ERROR

SERVER_SHUTDOWN

RESOURCE_WITHOUT_HOSTNAME

TIMEOUT

SERVER_SHUTDOWN

UNKNOWN_HOST

TIMEOUT

AGENT_UNKNOWN_COMMAND

UNKNOWN_HOST
Property shortcuts