Intrinsic properties listed by object type

40 minute readAutomation

This section describes the intrinsic properties for some of the objects in the CloudBees CD/RO. The property’s type precedes each property description in the Description column.

Property typeDefinition

boolean

One of two possible values—either true or false. These values are more frequently represented by the numbers "0" and "1", where "0" equals false and "1" equals true.

date

A millisecond precision UTC date in ISO 8601 form: YYYY]- [MM]-[DD]T[hh]:[mm]Z For example, 2007-06-19T04:36:22.000Z.

id

Each time an object is created, CloudBees CD/RO generates a unique ID number for that object.

name

This is a unicode string value with a maximum of 255 characters.

number

This is a simple integer numeric value.

reference

This property refers to another object.

string

This is a unicode string value with a maximum CLOB size of the database, but only the first 450 characters are indexed, which means a defined search will not "see" beyond the first 450 characters.

In the following tables, the Description column displays the property type followed by the property description.

acl

An acl is an Access Control List.

Property NameDescription

aclId

id: The unique identifier for this acl object. Other objects can refer to this acl by its ID.

inheriting

boolean: If true, the ACL inherits ACEs from the ACL’s parent.

ownerType

This is any type of object the ACL controls and can be any of the objects listed below:

acl adminartifactartifactVersioneventformalParametergroupjobjobSteplicensenotifierprocedureStepprojectpropertypropertySheetrepositoryresourceresourcePoolserverschedulesystemObjectuseruserSettingsworkspaceplugin

parentId

id: The parent ACL.

artifact

An artifact is an object that contains zero or more artifact versions. An artifact has two purposes: 1. To group artifact versions and provide a template for naming the versions 2. To restrict who can publish artifact versions, based on groupId:artifactKey

Property NameDescription

acl

reference: `acl `

artifactId

id: The artifact’s ID number.

artifactKey

string: User-specified identifier for this artifact. This field may consist of alphanumeric characters, spaces, underscores, hyphens, and periods.

artifactName

name: The name of this artifact.

artifactVersionNameTemplate

name: The template for artifact version names published to this artifact.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

groupId

id: A user-generated group name for this artifact. This field may consist of alphanumeric characters, spaces, underscores, hyphens, and periods.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

artifactVersion

An artifact version is an object that represents a user-defined unit of related files typically produced by one job and consumed by one or more other jobs.

Property NameDescription

acl

reference: acl

artifactKey

string: User-specified identifier for this artifact. This field may consist of alphanumeric characters, spaces, underscores, hyphens, and periods.

artifactName

name: The name of the artifact.

artifactVersionId

id: The CloudBees CD/RO-generated ID number for this artifact version.

artifactVersionName

name: The name of the artifact version.

artifactVersionState

string: Possible values are: available|publishing|unavailable

buildNumber

number: User-defined build number component of the version attribute for the artifact version.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

groupId

id: A user-generated group name for this artifact. This field may consist of alphanumeric characters, spaces, underscores, hyphens, and periods.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

majorMinorPatch

string: ` major.minor.patch` component of the version attribute for the artifact.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

publisherJobId

id: The CloudBees CD/RO-generated ID number for the job that published the artifact version.

publisherJobName

string: The name of the job that published the artifact version.

publisherJobStepId

id: The CloudBees CD/RO-generated ID number for the job step that published the artifact version.

qualifier

string: User-defined qualifier component of the version attribute for the artifact.

repositoryName

name: The name of the artifact repository.

version

string: An artifact version specification uses the following form: major.minor.patch.qualifier.buildNumber

credential

In CloudBees CD/RO, a credential is an object that stores a username and password for later use.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

credentialId

id: The credential’s ID number.

credentialName

name: The name of this credential.

description

string: A user-specified text description of the object.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

password

string: The password corresponding to the username and this credential.

projectName

name: The name of the project that contains this credential.

propertySheet

reference: propertySheet

userName

name: A saved string that represents the name portion of a credential, typically a user account name.

directoryProvider

A directoryProvider is an object containing information about an external directory service (LDAP or ActiveDirectory).

Property NameDescription

acl

reference: acl

commonGroupNameAttribute

string: The attribute in a group record that contains the common group name. If specified, this name is used only when searching for groups from an external provider.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

directoryProviderId

id: The ID of the directory provider.

domainName

string: The domain name from which Active Directory servers are automatically discovered.

emailAttribute

string: The attribute in a user record that contains the user’s email address. If the attribute was not specified, the account name and domain name are concatenated to form an email address.

enableGroups

boolean: Determines whether or not external groups are enabled for the directory provider. Defaults to "true".

fullUserNameAttribute

name: The attribute in a user record that contains the user’s full name (first and last) for display in the UI.

groupBase

string: This string is prepended to the ` basedn` to construct the directory DN that contains group records.

groupMemberAttributes

string: A comma-separated attribute name list that identifies a group member.

groupMemberFilter

string: Two common forms of group record in LDAP directories: POSIX style groups where members are identified by account name, and groupOfNames or uniqueGroupOfNames records where members are identified by the full user DN. Both forms are supported, so the query is passed to parameters: {0} is replaced with the full user record DN, and {1} is replaced with the user’s account name.

groupNameAttribute

name: The group record that contains the name of the group.

groupSearchFilter

string: This LDAP query is performed in the context of the groups directory to enumerate group records.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

managerDn

name: The DN of a user who has read-only access to LDAP user and group directories.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

providerIndex

number: The index that specifies the search order across multiple directory providers. For example: 2 LDAP providers, one with index "0" and one with index "1" means the providers will be searched in that numerical order.

providerName

name: This human-readable name will be displayed in the user interface to identify users and groups that come from this provider.

providerType

` string: <ldap|activedirectory>`

realm

string: An identifier (string)used for LDAP directory providers so users and groups (within LDAP) can be uniquely identified in "same name" collisions across multiple directory providers. The realm is appended to the user or group name when stored in the CloudBees CD/RO server. For example, <user>@dir (where the realm is set to "dir").

url

string: The server URL is in the ` formprotocol://host:port/basedn`. Protocol is either ldap or ldaps (for secure LDAP).

userBase

string: This string is prepended to the basedn to construct the directory DN that contains user records.

userNameAttribute

name: The attribute in a user record that contains the user’s account name.

userSearchFilter

string: This LDAP query is performed in the context of the user directory to search for a user by account name. The string “{0}” is replaced with the user’s login ID. Typically, the query compares a user record attribute with the substituted user login ID.

userSearchSubtree

boolean: If true, the subtree below the user base is searched recursively.

useSSL

boolean: This flag is used to specify SSL to communicate with your Active Directory servers.

Transport Layer Security (TLS) has replaced Secure Sockets Layer version 3.0 (SSLv3) on the CloudBees CD/RO web server and the CloudBees CD/RO server.

emailConfig

An emailConfig is an object that stores information created and used to communicate with the email server.

Property NameDescription

acl

reference: acl

configName

string: The name of the email configuration.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

emailConfigId

id: The CloudBees CD/RO-generated ID for the email configuration.

emailConfigName

string: The name of the email configuration.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

mailFrom

string: The email address used as the email sender address for notifications.

mailHost

string: The name of the email server host.

mailPort

number: The port number for the mail server. The protocol software determines the default value (25 for SMTP and 465 for SSMTP).

mailProtocol

string: This is either SSMTP or SMTP (not case sensitive). Default is SMTP.

mailUser

name: An individual or a generic name like "CloudBees CD/RO" — the name of the email user on whose behalf CloudBees CD/RO sends email notifications.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

emailNotifier

An emailNotifier is an object that stores information created and used to notify users about various types information, including status.

Property NameDescription

acl

reference: acl

condition

string: Only send mail if the condition evaluates to "true". The condition is a string subject to property expansion. The notification will NOT be sent if the expanded string is "false" or "0". If no condition is specified, the notification is ALWAYS sent.

configName

string: The name of the email configuration.

container

id: The object ID to which the email notifier is attached (for example: procedure-123).

containerType

string: The type of object that the notifier is attached to (procedure, step, job, jobstep).

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

destinations

string: A space-separated list of valid email addresses, email aliases, or CloudBees CD/RO usernames, or a string subject to property expansion that expands into such a list.

emailNotifierId

id: The CloudBees CD/RO-generated ID for the email notifier.

eventType

string: < onEnter|onStart|onCompletion > onStart triggers an email notification when the job or job step begins. onCompletion, default, triggers an email notification when the job finishes, no matter how it finishes.

formattingTemplate

string: The email address used as the email sender address for notifications.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

notifierName

name: The name of the email notifier.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

formalParameter

A formalParameter is a parameter expected by a procedure, including its name, a default value, and an indication of whether the parameter is required. Formal parameters are different from "actual parameters"--- formal parameters define the type of parameters a procedure is expecting, and actual parameters provide values to use at run-time.

Property NameDescription

container

string: An object ID for a "container" that contains formal parameters.

containerType

string: The type of object containing the formal parameter.

createTime

date: The time when this object was created.

defaultValue

string: The formalParameter 's default value.

description

string: A user-specified text description of the object.

expansionDeferred

boolean: Determines whether or not the property expansion is deferred.

formalParameterId

id: This is this formal parameter’s ID.

formalParameterName

name: This is this formal parameter’s name.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

required

boolean: If true, a value for this parameter must be supplied when the procedure is called.

type

name: The custom type of formalParameter.

gateway

To communicate with a resource, workspace, or artifact repository server in another zone, a gateway must be created. A gateway object contains two resource (agent) machines, for example, GatewayResource1 and GatewayResource2—each configured to communicate with the other. One gateway resource resides in the source zone and the other in the target zone. A gateway is bidirectional and informs the CloudBees CD/RO server that each gateway machine is configured to communicate with its other gateway machine (in another zone).

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

gatewayDisabled

` boolean: ` If set to 1 (true), the gateway is disabled.

gatewayId

id: The unique CloudBees CD/RO-generated ID for this gateway.

gatewayName

string: The name of the gateway.

hostName1

string: The agent host name where Resource1 resides. This host name is used by Resource2 to communicate with Resource1 . Do not specify this option is you want to use the host name from Resource1’s definition.

hostName2

` string: The agent host name where Resource2 resides. This host name is used by Resource1 to communicate with Resource2. Do not specify this option is you want to use the host name from Resource2’s definition.`

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

port1

number: The port number used by Resource1 —defaults to the port number used by the resource.

port2

number: The port number used by Resource2 —defaults to the port number used by the resource.

propertySheet

reference: propertySheet

resourceName1

string: The name of your choice for the first of two required gateway resources. Do not include spaces in a resource name.

resourceName2

string: The name of your choice for the second of two required gateway resources. Do not include spaces in a resource name.

group

This is any group of users known to the CloudBees CD/RO server, including groups defined locally within the server and those groups defined in external repositories such as LDAP or ActiveDirectory.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

groupId

id: The unique CloudBees CD/RO-generated group ID.

groupName

name: This is this group’s name.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

mutable

boolean: If true, the member list of this group is editable within CloudBees CD/RO via the web UI or the modifyGroup API.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

providerName

name: The name of the directory provider that controls this group.

job

A job is a CloudBees CD/RO structure associated with invoking a procedure. A new job is created each time a procedure begins to execute. The job keeps track of all data associated with the procedure’s execution, such as the running time of each step and any errors that may occur during the step. CloudBees CD/RO retains job information after the job completes so you can examine what occurred.

Property NameDescription

abortStatus

string: If set, indicates the step was aborted. Values will be either ABORT or FORCE_ABORT —indicating how the step was aborted.

abortedBy

name: This is the user who issued the "abort."

acl

reference: acl

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter, which is passed to a procedure when it is invoked. Actual parameters can be provided for jobs and nested subprocedures within a job. Actual parameters are different from "formal parameters"- formal parameters define the parameters a procedure is expecting, and actual parameters provide values to use at run-time.

callingState

string: The full property path to the "calling state", which can appear on subjobs and subworkflows of a workflow.

callingStateId

id: The CloudBees CD/RO-generated ID number for the calling state.

combinedStatus

Provides more inclusive step status output—the resulting query output may contain up to three sub-elements: status|message|properties

createTime

date: The time when this object was created.

credentialName

name: The name of the credential being used for impersonation when the job runs commands on a resource.

deleted

The object was marked for background deletion. Possible values are "0" or "1". Default is "0" (not set).

directoryName

name: The name of this job’s directory within each workspace for this job.

elapsedTime

number: The number of milliseconds between the start and end times for the job.

errorCode

` errorCode:` When the outcome is error, this property displays the error code, identifying which error occurred.

errorMessage

string: When the outcome is error, this property displays the error description.

external

` boolean :` If 'true", the job is external.

finish

date: The time this job completed.

jobId

id: This is this job’s ID number, which is a UUID.

jobName

name: This is this job’s name.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

launchedByUser

name: The name of the user or project principal that explicitly launched the job. This property is blank when the job is launched by a schedule.

licenseWaitTime

The sum of time all job steps had to wait for a license.

liveProcedure

name: The current procedure name from which this job was created – if the procedure was renamed since the job launched, this will be the procedure’s new name, and if the procedure was deleted, this will be null.

liveSchedule

name: The current schedule name that launched this job – if the schedule was renamed since the job was launched, this will be the schedule’s new name, and if the schedule was deleted, this will be null.

modifyTime

date: The time when this object was last modified.

outcome

The overall result of the job: success, warning, error, or skipped.

owner

name: The person (username) who created the object.

priority

Values can be low, normal (default), high, or highest.

procedureName

name: The name of the procedure that defines the job’s steps.

projectName

name: The name of the project that contains this job.

propertySheetId

reference: propertySheet

resourceWaitTime

The sum of time all job steps had to wait for a resource. This could indicate that eligible resources for the step have reached their step limit, are in-use but the step requires a resource exclusively, or resources are down.

runAsUser

name: The name of the user being impersonated in this job.

scheduleName

name: The schedule name that launched this job – this field differs from liveSchedule in that it is written at job creation time only, and not changed, even if the schedule is renamed or deleted.

start

date: The time when this job began executing.

status

Possible values are:

pending —the job was created, but it is waiting for prerequisite steps to complete

runnable —the job step is waiting for a resource

scheduled —the job was assigned a resource, but the command has not started running

running —the job/job step is running a command on the assigned resource

completed —the job/job step has completed

totalWaitTime

The total sum of license, resource, a precondition, and workspace wait times job steps were restricted and had to wait to process.

workspaceWaitTime

The sum of time all job steps had to wait for a workspace.

jobStep

The jobStep object is an instance of a step that ran—a single invocation of a command on a resource or a single call to a subprocedure within the context of a job.

Property NameDescription

abortStatus

string: If set, indicates the step was aborted. Values will be either ABORT or FORCE_ABORT —indicating how the step was aborted.

abortedBy

name: The user who issued the "abort."

acl

reference: acl

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter, which is passed to a procedure when it is invoked. Actual parameters can be provided for jobs and nested subprocedures within a job. Actual parameters are different from "formal parameters"- formal parameters define the parameters a procedure is expecting, and actual parameters provide values to use at run-time.

alwaysRun

boolean: If true, this step runs even if the job is aborted before the step completes. Note that a "force abort" will abort an alwaysRun step.

assignedResourceName

name: The name of the resource assigned to this step by the resource scheduler.

broadcast

boolean: If true, this step runs on all resources in a pool.

combinedStatus

Provides more inclusive step status output—the resulting query output may contain up to three sub-elements: status|message|properties

command

string: This property specifies the command this step runs.

condition

string: If this element is not present, the event is ALWAYS triggered. If specified, the event is triggered only if the value of the condition argument is TRUE; if not true, a boolean value of "false" or "0" was used. Condition arguments can be a literal, a fixed value string, or a string subject to property expansion.

conditionExpanded

boolean: The result of the expansion on the step condition.

createTime

date: The time when this object was created.

delayUntil

For a step that was rescheduled due to a resource or workspace problem, this is the next time the step will be eligible to run.

elapsedTime

number: The number of milliseconds between the start and end times for the jobStep.

errorCode

` errorCode:` This property appears when the outcome is error and displays the error code, identifying which error occurred.

errorHandling

This is the error handling policy copied from the procedure step and indicates how the step responds to errors:

failProcedure —The current procedure continues, but the overall status is error (default).

abortProcedure —Aborts the current procedure, but allows already-running steps in the current procedure to complete.

abortProcedureNow —Aborts the current procedure and terminates running steps in the current procedure.

abortJob —Aborts the entire job, terminates running steps, but allows alwaysRun steps to run.

abortJobNow —Aborts the entire job and terminates all running steps, including alwaysRun steps.

failProcedure — The current procedure continues, but the overall status is error (default).

ignore —Continues as if the step succeeded.

errorMessage

string: When the outcome is error, this property displays an error message description.

exclusive

boolean: If true, this step acquires and retains its resource exclusively.

exclusiveMode

string: Possible values are: none, job, step, call

exitCode

number: This is this step’s exit code.

external

boolean: If "true", the job is external.

finish

date: The time when this job step completed.

hostName

name: The name of the host where this step was invoked (copied from the resource )

job

id: This is the ID number of the job that owns the job step.

The string representation of the job is its name, so $[job] evaluates to the job name, but $[job/foo] is also legal and refers to the foo property of the job.

jobId

id: This is this job’s ID number, which is a UUID.

jobName

name: This is the name of this step’s job.

jobStepId

id: This is this step’s ID number.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

licenseWaitTime

The length of time this job step had to wait to process because the license limit was reached or exceeded.

liveProcedure

string: The current procedure name for the procedure step from which the job or job step was created – if the procedure step was renamed since the job or job step was launched, this is the procedure step’s new name, and if the procedure step was deleted, this will be null.

liveProcedureStep

name: This property shows the current procedure name for the procedure step from which this job step was created – if the procedure step was renamed since the job was launched, this will be the procedure step’s new name, and if the procedure step was deleted, this will be null.

logFileName

name: The name of the log file produced by this step, relative to the job’s workspace directory.

modifyTime

date: The time when this object was last modified.

outcome

string: The overall result of the job—possible values are: success, warning, error, or skipped

owner

name: The person (username) who created the object.

parallel

boolean: If true,this step runs in parallel with other adjacent steps also marked to run in parallel.

postExitCode

number: This is this step’s post processor exit code.

postLogFileName

name: The log file name produced by this step’s post processor.

postProcessor

string: The post processor name used to gather information about this step.

precondition

string: By default, if a step has no precondition, it will run when scheduled. Set this property to make a step wait until one or more dependent conditions are met. When a job step is eligible to transition from pending to runnable, a precondition is evaluated. A precondition is a fixed text or text embedding property reference that is evaluated to TRUE or FALSE. An empty string, a \"0\" or \"false\" is interpreted as FALSE. Any other result string is interpreted as TRUE. The step will block until the precondition is TRUE.

procedureName

name: The name of the procedure that contains this jobStep.

projectName

name: The name of the project that contains this jobStep.

propertySheet

reference: propertySheet

releaseExclusive

boolean: A Boolean value indicating whether this step should release its resource upon completion.

releaseMode

string: Possible values are: none, release, releaseToJob

resourceName

name: The name of the resource or pool this step should use to run on.

resourceSource

This property indicates whether the resource for the job step is explicitly specified by the step or was defaulted from the procedure: procedure or procedureStep.

resourceWaitTime

The length of time this job step stalled because it could not get a resource. This could indicate that eligible resources for the step have reached their step limit, are in-use but the step requires a resource exclusively, or resources are down.

retries

number: This is a number—the number of retries before the request times out.

runAsUser

name: The name of the user being impersonated in this job step.

runnable

date: The time when the step became runnable.

runTime

number: The number of milliseconds the step command spent running on a resource.

shell

name: The shell used to execute the step’s commands on a resource. The script name is inserted into the command at the position of a {0} marker in the command, or appended as a final argument if no marker is present. A filename suffix adjacent to the marker will be appended to the script name. For more information on shells, see the Shell definition in the Step Help topic.

start

date: The time when this job step began executing.

status

Possible values are:

pending —the job step was created, but it is waiting for prerequisite steps to complete

runnable —the job step is waiting for a resource

scheduled —the job step was assigned a resource, but the command has not started running

running —the job/job step is running a command on the assigned resource

completed —the job/job step has completed

stepName

name: This is this step’s name.

subprocedure

name: The nested procedure name to call when this step executes.

subproject

name: This property appears if the subprocedure element is present and specifies the project to which the subprocedure belongs (by default, the current project is used.)

timeLimit

number: The maximum length of time this step is allowed to run.

timeout

date: The time when this job step will be automatically aborted if it has not yet completed.

totalWaitTime

The sum of resource, workspace, and license wait times for this job step.

waitTime

number: The number of milliseconds the step spent between runnable and running (for example, waiting for a resource).

workingDirectory

name: The name of this step’s working directory.

workspaceName

name: The workspace name used by the jobStep object.

workspaceWaitTime

The time this job step had to wait because no workspace was found or available.

logEntry

A logEntry is an object containing various types of information available in a log file generated from anywhere in the CloudBees CD/RO system. The Event Log can be configured for auto-deletion. By default, Event Log retention is 30 days. The CloudBees CD/RO server automatically marks old log entries for deletion and the background deleter cleans out old log entries. To change the default settings, go to Administration > Server > Settings and modify the Event log retain time and the Maximum background delete delay fields Note: Setting the "retain" period to "0" disables the automatic deletion mechanism, allowing you to use an external cleanup script to implement a custom cleanup policy.

Property NameDescription

category

(currently not used)

container

string: Typically, this is the type and name of the workflow or job with a corresponding ID.

containerName

name: The name of the container.

containerType

string: The type of object the log entry pertains to (for example, procedure, job step, step).

deleted

byte: The object was marked for background deletion. Possible values are 0 or 1. Default is 0 (which means "deleted" is not set).

logEntryId

id: The log entry CloudBees CD/RO-generated ID.

message

string: The message text will either be informational or display the warning or error message. The message may contain important information about a resource or workspace issue.

principal

string: The user or project principal from the session that was active when the event occurred.

severity

string: Severity can be either TRACE, DEBUG, INFO, WARN, ERROR

subject

string: The object associated with the message.

subjectName

name: The name of the object associated with the message.

subjectType

string: (similar to container ) Refers to the object the event concerns. This may be the same as the container, or it may be a different object that is related to the event in some manner.

time

string: The time the event was logged.

procedure

A procedure describes a series of actions to be performed on one or more resources. A procedure contains steps and properties and can define formal parameters.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

credentialName

name: The name of the credential assigned to this job step.

description

string: A user-specified text description of the object.

jobNameTemplate

name: The template used to name jobs created from this procedure.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

procedureId

id: This is this procedure’s ID number.

procedureName

name: This is this procedure’s name.

projectName

name: The name of the project that contains this procedure.

propertySheet

reference: propertySheet

resourceName

name: The name of the resource or pool this procedure should use to run on.

workspaceName

name: The workspace name used by the procedure object.

project

A project is an object used in CloudBees CD/RO to organize information. A project contains procedures, schedules, credentials, and properties.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

credentialName

name: The name of the credential assigned to this project.

deleted

The object was marked for background deletion. Possible values are "0" or "1". Default is "0" (not set).

description

string: A user-specified text description of the object.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

pluginName

name: The name of the plugin associated with this project.

projectId

id: This is this project’s ID.

projectName

name: The name of the project.

propertySheet

reference: propertySheet

resourceName

name: The name of the resource.

workspaceName

name: This is the workspace name used by the project.

property

A property is a string value with a name. Properties can have arbitrary names and values. You can attach properties to any object in the CloudBees CD/RO system, such as a project, procedure, or job. After a property is created, it is stored in the CloudBees CD/RO database. You can retrieve and/or modify the value later, and you can delete properties you no longer need. Properties provide a flexible and powerful mechanism to manage data about your builds.

The names " properties " and " project " are not valid property names.
Property NameDescription

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

expandable

boolean: If set to true, the property value will undergo string expansion when it is retrieved.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

canonicalPath

string: The path that specifies the property object.

propertyId

id: This property’s ID number.

propertyName

name: This property’s name.

propertySheetId

` reference: propertySheet—` If the property is a nested property sheet, the propertySheet refers to the nested sheet.

value

string: The property or actual parameter’s value—if this property is a string property.

propertySheet

A property value can be a simple string or a nested propertySheet containing its own properties. Property sheets can be nested to any depth, which allows you to create hierarchical collections of information. Most objects have an associated property sheet that contains "custom properties" created by user scripts.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheetId

id: This property sheet’s ID.

repository

A repository is an object that stores artifact versions. This object primarily contains information on how to connect to a particular artifact repository. Similar to steps in a procedure, repository objects are in a user-specified order. When retrieving artifact versions, repositories are queried in this order until one containing the desired artifact version is found.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

description

string: A user-specified text description for this object.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

repositoryDisabled

boolean: Determines whether the repository is disabled. Default is "false".

repositoryId

id: The CloudBees CD/RO-generated ID number of the repository.

repositoryIndex

number: The order of the repository, within a list of repositories.

repositoryName

name: The name of the repository.

url

string: The server URL is in the form protocol://host:port/. Typically, the repository server is configured to listen on port 8200 for https requests, so a typical URL looks like https://host:8200/.

zoneName

` name : ` ` ` The name of the zone where this repository is or will reside.

resource

A resource is associated with a server machine available to CloudBees CD/RO for running steps. A resource has a logical name in addition to a host name. A resource can be associated with one or more pools. The resource may be a "proxy target" machine that communicates with the CloudBees CD/RO server though a CloudBees CD/RO agent proxy machine.

Property NameDescription

acl

reference: acl

agentState

string: Specific information about an agent, including the state of the agent. Possible values are: unknown|alive|down

artifactCacheDirectory

string: The directory on the agent host where retrieved artifacts are stored.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

exclusiveJobId

id: The ID number of the job that owns this resource, which occurs when one of the job’s steps requests exclusive use of the resource for the duration of the job.

exclusiveJobName

name: The name of the job that owns this resource, which occurs when one of the job’s steps requests exclusive use of the resource for the duration of the job.

exclusiveJobStepId

id: The ID number of the job step that owns this resource, which occurs when one of the steps request exclusive use of the resource for the duration of the job.

exclusiveJobStepName

name: The name of the job step that owns this resource, which occurs when one of the steps request exclusive use of the resource for the duration of the job.

gateways

The gateway names associated with this resource.

hostName

name: The computer name or IP address for the machine containing the CloudBees CD/RO agent for this resource.

hostOS

string: The full name of the host operating system, plus its version. However, if this host is a proxy, "proxied" appears as the host description/name.

hostPlatform

string: Examples for "platform" are: Windows, Linux, and macOS. However, if this host is a proxy, "proxied" appears as the hostPlatform name.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

lastRunTime

date: The most recent time a job step ran on the resource.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

pools

string: A space-separated list of one or more pool names where this resource is a member. Steps defined to run on a resource pool will run on any available member (resource) in the pool.

port

number: The port number for this resource.

propertySheet

reference: propertySheet

proxyCustomization

string: This property displays the customization of the CloudBees CD/RO proxy agent.

proxyHostName

name: The name of the CloudBees CD/RO agent being used to proxy to another agent, the proxy target.

proxyPort

number: The port number of the CloudBees CD/RO agent being used to proxy to another agent, the proxy target.

proxyProtocol

name: The name of the proxy agent protocol used for communication from the CloudBees CD/RO proxy agent to the proxy target—default is SSH.

repositoryNames

A "new line" separated list of repository names.

resourceDisabled

boolean: A Boolean value indicating whether this resource was disabled.

resourceId

id: This is this resource’s ID.

resourceName

name: The name of the resource or pool.

shell

name: The shell used to execute the step’s commands on a resource. If no shell was defined on a step, the shell defined on the resource is used, or if no shell was defined on the resource, a default shell is used. For shells: The script name is inserted into the command at the position of a {0} marker in the command, or appended as a final argument if no marker is present. A filename suffix adjacent to the marker will be appended to the script name. For more information on shells, see the Shell definition in the Step Help topic.

stepCount

number: The current number of executing steps on this resource.

stepLimit

number: This property specifies the maximum number of steps that can run on this resource at one time.

trusted

boolean: If "true", this agent is trusted.

useSSL

boolean: A Boolean value indicating whether this resource uses SSL for communication.

Transport Layer Security (TLS) has replaced Secure Sockets Layer version 3.0 (SSLv3) on the CloudBees CD/RO web server and the CloudBees CD/RO server.

workspaceName

name: The workspace name used by this resource.

zoneName

` sting: ` The name of the zone where this resource resides.

resourcePool

A resource pool is a container for a group of resources.

Property NameDescription

acl

reference: acl

autoDelete

` boolean: ` If "true", the resource pool is deleted when the last resource is removed or deleted.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

lastResourceUsed

name: The name of the most recently used resource from the pool.

modifyTime

date: The time when this object was last modified.

orderingFilter

string: A Javascript block invoked when scheduling resources for a pool. A Javascript block is not required unless you need to override the default resource ordering behavior.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

resourcePoolDisabled

boolean: A Boolean value indicating whether this resource pool was disabled.

resourcePoolId

id: This resource pool’s ID number.

resourcePoolName

name: The name of the resource pool.

resourceUsage

Provides usage information for all resources in the system. For any job step running on a resource, there is a resource usage record that contains the ID and name of the job, job step, and resource.

Property NameDescription

jobId

id: This is this job’s ID number, which is a UUID.

jobName

name: The name of the job.

jobStepId

id: The ID number of the job step.

jobStepName

name: The name of the job step.

licenseWaitTime

The time this job step had to wait because no license was found or available.

resourceId

id: The CloudBees CD/RO-generated resource ID number.

resourceName

name: The name (or names) of the resource.

resourcePoolId

id: The CloudBees CD/RO-generated resource pool’s ID number.

resourcePoolName

name: The name of the resource pool.

resourceUsageId

id: The unique ID of the resource usage record.

resourceWaitTime

The time this job step had to wait because no resource was found or available. This could indicate that eligible resources for the step have reached their step limit, are in-use but the step requires a resource exclusively, or resources are down.

waitReason

Possible values are: license, resource, or workspace.

workspaceWaitTime

The time this job step had to wait because no workspace was found or available.

schedule

Schedules are used to execute procedures and determine when specific procedures run.

Property NameDescription

acl

reference: acl

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter, which is passed to a procedure when it is invoked. Actual parameters can be provided for jobs and nested subprocedures within a job. Actual parameters are different from "formal parameters"- formal parameters define the parameters a procedure is expecting, and actual parameters provide values to use at run-time.

beginDate

string: The first day on which the schedule is active, in the form YYYY-MM-dd. For example, "2009-06-25"

createTime

date: The time when this object was created.

credentialName

name: The name of the credential being used for impersonation when the schedule launches a job.

description

string: A user-specified text description of the object.

endDate

string: The end of the range of dates the schedule is active, in the form: YYYY-MM-dd. The actual end date is not included in the range. For example, 2009-06-25

interval

string: A floating point number that represents the time to wait between invocations of the schedule.

intervalUnits

string: These are the units to use when interpreting the interval value. The units can be hours, minutes, seconds, or continuous.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

lastRunTime

date: The last time a job was launched by a schedule.

misfirePolicy

string: The policy the schedule uses when it is unable to launch a job at the scheduled time: ignore —wait until the next scheduled time to run ` runOnce` —run immediately, then resume normal scheduling

modifyTime

date: The time when this object was last modified.

monthDays

string: This property specifies which days of the month this schedule should run—shown as a space-separated list of numbers (1-31).

owner

name: The person (username) who created the object.

priority

string: Values can be low, normal (default), high, or highest

procedureName

name: The name of the procedure that contains this schedule.

projectName

name: The name of the project that contains this schedule.

propertySheet

reference: propertySheet

scheduleDisabled

boolean: A Boolean value indicating whether this schedule was disabled.

scheduleId

id: This schedule’s ID number.

scheduleName

name: This property displays this schedule’s name and differs from the liveSchedule property found under a job in that the liveSchedule property is written at job creation time only, and not changed, even if the schedule is renamed or deleted.

startTime

string: The time of day when this schedule should start running, in the form: HH:mm:ss

stopTime

string: The time of day when this schedule should stop running, in the form: HH:mm:ss

timeZone

string: A Java-compatible time zone string.

weekDays

string: This property specifies which days of the week this schedule should run. This is a space-separated list of MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY. (Note: These are not localized strings.)

server

This is the CloudBees CD/RO server object. There is only one such object in your database.

These properties are especially useful for building a URL link to a CloudBees CD/RO web page. For example, a link in an email notifier that links back to a Job Details page.

A sample link:

https://$[/server/webServerHost]/commander/jobDetails.php?jobId=$[jobId]
Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

hostIP

string: Returns the server setting, ipAddress, if set. Otherwise, returns the IP address of its first non-localhost network interface. Legacy property available for use in a step, a script, or an email notifier, which can be used to identify the CloudBees CD/RO server location. Use hostName instead.

hostName

name: Returns the server setting, ipAddress, if it is set. Otherwise, returns the fully qualified host name of the CloudBees CD/RO server. This server property is available for use in steps or scripts, which can be used to identify the CloudBees CD/RO server location.

lastModifiedBy

name: This shows who last modified this object. This is generally a username.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

serverId

id: The server’s ID number.

serverName

string: The CloudBees CD/RO server’s name—defaults to "server".

webServerHost

string: Returns the server setting, webServerHost, if it is set. Else, returns the server property, hostName.

state

A state object belongs to a workflow and corresponds to the state definition, including a pointer to the workflow, formal parameters (cloned from definition), expanded actual parameters (form the last time a transition was taken to this state), and the "process" which includes the procedure or workflow (cloned from definition), unexpanded actual parameters (cloned from definition, expanded and passed to the process on entry), and the "last run" entity reference.

Property NameDescription

acl

reference: acl

active

boolean: If "true", the state of the workflow is active.

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter, which is passed to a procedure when it is invoked. Actual parameters can be provided for jobs and nested subprocedures within a job. Actual parameters are different from "formal parameters"- formal parameters define the parameters a procedure is expecting, and actual parameters provide values to use at run-time.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

errorMessage

string: When the outcome is error, this property displays an error message description.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

projectName

name: The name of the project that contains this state.

propertySheet

reference: propertySheet

stateId

id: The CloudBees CD/RO-generated ID number for the state.

stateName

name: The name of the state.

subjob

name: The name of the subjob.

subparameters

reference: propertySheet

subprocedure

name: The name of the nested procedure called when a step runs.

subproject

string: If a subprocedure argument was used, this is the name of the project where that subprocedure is found. By default, the current project is used.

substartingState

name: Name of the starting state for the workflow launched when the state is entered.

subworkflow

name: The name of the subworkflow—a workflow called by another workflow.

subworkflowDefinition

name: The name of the subworkflow definition.

workflow

name: The name of the workflow.

stateDefinition

A stateDefinition is a named object that belongs to a workflow definition, which includes specifications for whether or not the state is "startable", formal parameters, notifications, and the process. A process includes a procedure or workflow, the starting state (for workflows only), and actual parameters.

Property NameDescription

acl

reference: acl

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter, which is passed to a procedure when it is invoked. Actual parameters can be provided for jobs and nested subprocedures within a job. Actual parameters are different from "formal parameters"- formal parameters define the parameters a procedure is expecting, and actual parameters provide values to use at run-time.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

projectName

name: The name of the project that contains this state definition.

propertySheet

reference: propertySheet

startable

boolean: "True" means this state definition can be the initial state of an instantiated workflow.

stateDefinitionId

id: The CloudBees CD/RO-generated ID number for the state definition.

stateDefinitionName

name: The name of the state definition.

subprocedure

name: The name of the nested procedure called when a step runs.

subproject

string: If a subprocedure argument was used, this is the name of the project where that subprocedure is found. By default, the current project is used.

substartingState

name: Name of the starting state for the workflow launched when the state is entered.

subworkflowDefinition

name: The name of the subworkflow definition.

workflowDefinitionName

name: The name of the workflow definition.

step

A step includes a command or script executed on a single resource and is the smallest unit of work CloudBees CD/RO understands. Each step specifies a resource on which it should run (either the name of a specific machine or the name of a pool of equivalent machines, in which case CloudBees CD/RO picks a machine from the pool). A step can be given a time limit and if the step does not complete within the specified time, CloudBees CD/RO automatically aborts it. Steps are ordered within a procedure and normally execute sequentially. However, it is possible to mark a consecutive range of steps for parallel execution, so all steps in that range run concurrently. A step in one procedure can invoke another procedure instead of running a command. The invoking step provides parameters needed by the nested procedure.

Property NameDescription

acl

reference: acl

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter, which is passed to a procedure when it is invoked. Actual parameters can be provided for jobs and nested subprocedures within a job. Actual parameters are different from "formal parameters"- formal parameters define the parameters a procedure is expecting, and actual parameters provide values to use at run-time.

alwaysRun

boolean: If true, this step runs even if the job is aborted before the step completes. Note that a force abort will abort an alwaysRun step.

broadcast

boolean: If true, this step will run on all resources in a pool.

command

string: This property specifies the command this step runs.

condition

string: If this element is not present, the event is ALWAYS triggered. If specified, the event is triggered only if the value of the condition argument is TRUE; if not true, a boolean value of "false" or "0" was used. Condition arguments can be a literal, a fixed value string, or a string subject to property expansion.

createTime

date: The time when this object was created.

credentialName

name: The credential name assigned to this step.

description

string: A user-specified text description of the object.

errorHandling

This is the error handling policy copied from the procedure step and indicates how the step responds to errors:

failProcedure —The current procedure continues, but the overall status is error (default).

abortProcedure —Aborts the current procedure, but allows already-running steps in the current procedure to complete.

abortProcedureNow —Aborts the current procedure and terminates running steps in the current procedure.

abortJob —Aborts the entire job, terminates running steps, but allows alwaysRun steps to run.

abortJobNow —Aborts the entire job and terminates all running steps, including alwaysRun steps.

ignore —Continues as if the step succeeded.

exclusive

boolean: If true, this step acquires and retains its resource exclusively.

exclusiveMode

string: Possible values are: none, job, step, call

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

logFileName

name: The name of the log file produced by this step, relative to the job’s workspace directory.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

parallel

boolean: If true, this step runs in parallel with other adjacent steps also marked to run in parallel.

postLogFileName

name: This property displays the log file name produced by this step’s post processor.

postProcessor

string: This property displays the post processor name that is used to gather information about this step. Typically, this is either postp or postp <options>, or an appropriate command or path including options to a postprocessor available on the CloudBees CD/RO server.

precondition

` string: By default, if a step has no precondition, it will run when scheduled. Set this property to make a step wait until one or more dependent conditions are met. When a job step is eligible to transition from pending to runnable, a precondition is evaluated. A precondition is a fixed text or text embedding property reference that is evaluated to TRUE or FALSE. An empty string, a \"0\" or \"false\" is interpreted as FALSE. Any other result string is interpreted as TRUE. The step will block until the precondition is TRUE.`

procedureName

name: The name of the procedure that contains this step.

projectName

name: The name of the project that contains this step.

propertySheet

reference: propertySheet

releaseExclusive

boolean: A Boolean value indicating whether this step should release its resource upon completion.

releaseMode

string: Possible values are: none, release, releaseToJob

resourceName

name: The resource’s name this step should use to run on.

shell

name: The shell used to execute the step’s commands on a resource. The script name is inserted into the command at the position of a “ {0} ” marker in the command, or appended as a final argument if no marker is present. A filename suffix adjacent to the marker will be appended to the script name. For more information on shells, see the Shell definition in the Step Help topic.

stepId

id: The step’s ID number.

stepName

name: The step’s name.

subprocedure

name: The nested procedure name to call when this step executes.

subproject

name: This property is displayed if the subprocedure element is present and specifies the project to which the subprocedure belongs (by default, the current project is used.)

timeLimit

number: A floating point number that specifies the maximum length of time this step is allowed to run.

timeLimitUnits

The units to use when interpreting the time limit. Units can be hours, minutes, or seconds.

workingDirectory

name: The name of the step’s working directory.

workspaceName

name: The workspace name used by this step.

transition

A transition object belongs to a state and corresponds to the transition definition, and includes the target state (unexpanded actual parameters cloned from definition, expanded and passed to the target state on entry), the Javascript condition, and the trigger (onEnter\|onStart\|onCompletion\|manual).

Property NameDescription

acl

reference: acl

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter that is passed to the target state when the transition is taken.

condition

string: If empty or non-zero, the transition is allowed to trigger. If set to "0", the transition is ignored.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

index

The numeric index of a transition that indicates the transition order in the state definition’s transition list.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

projectName

name: The name of the project that contains this transition.

propertySheet

reference: propertySheet

stateName

name: The name of the state.

targetState

string: The target state for the transition definition.

transitionId

id: The CloudBees CD/RO-generated ID for the transition.

transitionName

name: The name of the transition.

trigger

string: Possible values are:

onEnter — before any actions

onStart — after a subjob or workflow is created

onCompletion — after a subjob or workflow completes

manual — when a user manually requests a transition

workflowName

name: The name of the workflow.

transitionDefinition

A transitionDefinition is a named object that belongs to a state definition, which includes the target state definition (with actual parameters to the target state, the Javascript condition, and the trigger (onEnter\|onStart\|onCompletion\|manual).

Property NameDescription

acl

reference: acl

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter passed to the target state.

condition

string: If empty or non-zero, the transition is allowed to trigger. If set to "0", the transition is ignored.

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

index

The numeric index of a transition that indicates the transition order in the state definition’s transition list.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

projectName

name: The name of the project that contains this transition definition.

propertySheet

reference: propertySheet

stateDefinitionName

name: The name of the state definition.

targetState

string: The target state for the transition definition.

transitionDefinitionId

id: The CloudBees CD/RO-generated ID for the transition definition.

transitionDefinitionName

name: The name of the transition definition.

trigger

string: Possible values are:

onEnter — before any actions

onStart — after a subjob or workflow is created

onCompletion — after a subjob or workflow completes

manual — when a user manually requests a transition

workflowDefinitionName

name: The name of the workflow definition.

user

User refers to any user currently logged into the CloudBees CD/RO system or any user who may use CloudBees CD/RO, but may not be currently logged in.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

email

name: Displays this user’s email address.

fullUserName

name: The user’s real name.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

mutable

boolean: If true, the user is editable within CloudBees CD/RO via the web UI or the modifyUser API.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

providerName

name: The name of the directory provider that controls this user.

userId

id: A unique ID number for a user object.

userName

name: Displays this user’s name and also appears in a group object and displays the name of a user who belongs to this group.

workflow

A workflow object includes a pointer to the workflow definition, sets of states, the active state, the starting stare, parameters to the initial state, "complete"—a boolean value determining whether or not the workflow is complete, and a log containing the transactions taken and user events.

Property NameDescription

acl

reference: acl

activeState

string: The name of the active state on the workflow object.

actualParameter

reference: propertySheet An actualParameter is an object that provides the value for a parameter that is passed to the target state when the transition is taken.

callingState

string: The full property path to the state that created this workflow.

callingStateId

id: The ID number for the full property path to the state that created this workflow.

completed

` boolean: ` If "true", the workflow is completed and no additional transactions will be evaluated.

createTime

date: The time when this object was created.

deleted

boolean: The object was marked for background deletion. Possible values are "0" or "1". Default is "0" (not set).

elapsedTime

The time this object ran from start to finish.

finish

date: The date/time when this object finished.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

launchedByUser

string: The name of the user or project principal that explicitly launched the workflow.

liveWorkflowDefinition

name: The current workflow definition name for the workflow definition from which the workflow was created.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

projectName

name: The name of the project that contains this workflow.

propertySheet

reference: propertySheet

start

date: The date/time when this workflow began to run.

startingState

string: The initial state of the workflow.

workflowDefinitionName

name: The name of the workflow definition.

workflowId

id: The CloudBees CD/RO-generated ID for the workflow.

workflowName

name: The name of the workflow.

workflowDefinition

A workflowDefinition object contains state and transition definitions, including the workflow name template (analogous to a job name template on a procedure), and ordered sets of state and transition definitions.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

description

string: A user-specified text description of the object.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

projectName

name: The name of the project that contains this workflow definition.

propertySheet

reference: propertySheet

workflowDefinitionId

id: The CloudBees CD/RO-generated ID for the workflow definition.

workflowDefinitionName

name: The name of the workflow definition.

workflowNameTemplate

string: Template used to determine the default names for workflows launched from a workflow definition.

workspace

CloudBees CD/RO provides each job step with an area on the disk it can use for "working files" and results. This disk area is called a job workspace . (The job workspace defaults to a directory under the workspace directory.) A job step can create whatever files it needs within its workspace, and CloudBees CD/RO automatically places files such as step logs in the workspace. Normally, a single workspace is shared by all steps in a job, but different steps within a job could use different workspaces. The location of the job step workspace is displayed on the Job Details page for the job under "Details" for the step.

Property NameDescription

acl

reference: acl

agentDrivePath

name: The drive-letter based mount point for this workspace on Windows agents.

agentUncPath

name: The UNC path for this workspace on Windows agents.

agentUnixPath

name: The UNIX path for this workspace on UNIX agents.

createTime

date: The time when this object was created.

credentialName

name: The name of the credential being used when a resource connects to a network share while setting up the workspace.

description

string: A user-specified text description of the object.

lastModifiedBy

name: This shows who (generally, a username) last modified this object.

local

` boolean: If "true", this workspace is local.`

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

workspaceDisabled

boolean: A Boolean value that indicates whether this workspace was disabled.

workspaceId

id: The workspace’s ID number.

workspaceName

name: The workspace’s name.

zoneName

name: The name of the zone where this workspace resides.

zone

CloudBees CD/RO provides the ability to create zones—often used to enhance security.

  • A zone is a way to partition a collection of agents to secure them from use by other groups. For example, you might choose to create a developers zone, a production zone, and a test zone—agents in one zone cannot directly communicate with agents in another zone.

  • A default zone is created during CloudBees CD/RO installation. The server implicitly belongs to the default zone, which means all agents in this zone can communicate with the server directly (without the use of a gateway).

  • Each zone can have one or more "gateway agents", which you define. Gateway agents are used for communication from one zone to another zone. For more information, see the Gateways Help topic.

Property NameDescription

acl

reference: acl

createTime

date: The time when this object was created.

description

string: A user-specified text description for the object.

lastModifiedBy

name: This person (generally, a username) last modified this object.

modifyTime

date: The time when this object was last modified.

owner

name: The person (username) who created the object.

propertySheet

reference: propertySheet

resources

string: A space-separated list of resources contained in this zone.

zoneId

id: The CloudBees CD/RO-generated ID for this zone.

zoneName

string: The name of the zone.