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 type Definition

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 Name Description

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 admin artifact artifactVersion event formalParameter group job jobStep license notifier procedureStep project property propertySheet repository resource resourcePool server schedule systemObject user userSettings workspace plugin

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 Name Description

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 Name Description

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 Name Description

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 Name Description

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 Name Description

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 Name Description

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 Name Description

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 Name Description

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 Name Description

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 Name Description

abortStatus

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