Properties

A property is a key-value pair of data used to configure elements of the CloudBees platform, such as an action, an environment, or an integration.

A property data type can be any of the following:

String
Number
Boolean

Access a property

Display the properties of an organization.

To access a property:

Select Configurations Properties.
(Optional) Search for a specific property configuration, by entering all or part of a property name into Search.
(Optional) Select an option in Sort by to sort the properties list by either Ascending or Descending alphanumerical sort order.
(Optional) Select Filter to filter the property list, and then select from the Type or Source options.

The properties are displayed according to your search or sort criteria.

Create a property

Create a key/value pair, with the option of encryption for sensitive information. The property name must only contain alphanumeric characters and/or underscores.

The Prevent override option enables you to maintain the value of a property even if a workflow step attempts to specify a different value for it.

The Secret option enables you to encrypt the property.

To create a property:

Select Configurations Properties.
Select Create property.
Enter a Property name.
(Optional) Enter a Description.
Select a Data type from the options.
Enter a Value.
(Optional) Select Secret, to encrypt the property.
(Optional) Select Prevent override, to disallow the ability to override the property.
Select Save.

Your property is created, and listed in Properties.

Update a property

Update any field in the property configuration, including name, value, and whether it is stored as a secret.

Updating a property in use may have unintended effects.

To update a property:

Select Configurations Properties.
Select next to the property you want to update.
Select Edit.
Make any desired changes.
Select Save.

The selected property is updated accordingly.

Delete a property

Delete any of your properties. A deleted property is completely removed from the CloudBees platform, and deletion is irreversible.

To delete a property:

Select Configurations Properties.
Select next to the property you want to update.
Select Delete property.
Select Delete.

The selected property is deleted and removed from the property list.