Intrinsic properties listed by object type

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

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.

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.

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

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` `adminartifactartifactVersioneventformalParametergroupjobjobSteplicensenotifierprocedureStepprojectpropertypropertySheetrepositoryresourceresourcePoolserverschedulesystemObjectuseruserSettingsworkspaceplugin`
parentId	`id:` The parent ACL.

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

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`

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

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

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

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.

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

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

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