Configuring CloudBees CD/RO properties or property sheets

The Property list, Property sheet, and Property UIs are available within CloudBees CD/RO by selecting the Properties from the three-dots menu while:

Figure 1. Properties list

Review property data.

Select the navigation links to access associated pipeline, project, release or service account.
Review the Value and Description information.

Configure a property or property sheet.

Create a new property by selecting Create property.
Configure a property or property sheet by selecting the three-dots menu.
- Modify a property or property sheet by selecting Edit.
- Select Create property or Create nested sheet to add new ones.
- Relocate the property or nested sheet by selecting Move to.
- Create a copy of the property or nested in another location by selecting Copy to.
- Specify explicit permissions for the property or property sheet by selecting Access Control.
- Remove the item by selecting Delete.

Configuring a property or property sheet

Use these features to create or modify a CloudBees CD/RO property or nested property sheet.

Figure 2. New property and property sheet

Enter information into the fields as follows:

Field Name Description

Property name or Property sheet name

The name is an arbitrary text string. Unless you are an experienced CloudBees CD/RO user, CloudBees recommends that you avoid using slashes and brackets as a part of the property name.

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

Value

This value is an arbitrary text string.

Description

(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with <html> … </html> tags. Allowable HTML tags are <a>, <b>, <br>, <div>, <dl>, <font>, <i>, <li>, <ol>, <p>, <pre>, <span>, <style>, <table>, <tc>, <td>, <th>, <tr>, and <ul>.

For example, the following HTML:

<p>
<span style="font-family: Arial;">
  <i>Note:</i> For more information about the <b>abc</b> object, see
         <a href="https://www.google.com/">\https://www.google.com</a>.
</span>
</p>

renders as follows:

<i>Note</i>: For more information about the <b>abc</b> object, see \https://www.google.com.

Expandable

Do not select this check box if you do not want to allow property expansion.

Track Changes to Value

Uncheck to disable tracking of changes to this property value into the change history of modifications where the only change was to the value of this property. Unchecking it is useful where an automated process (such as a job step, pipeline stage, or workflow transition) makes numerous value-only changes.

Unchecking it is strongly recommended for properties that are used as build counters, most recent build or artifact names, or are used to store runtime output from jobs, pipelines, or workflows into a property attached to a change-tracked non-runtime entity. Otherwise, these will rapidly fill the change history with numerous irrelevant events.

This checkbox does not appear if change tracking is not enabled or is not tracking this property.

Unchecking this checkbox also modifies the behavior of the ectool export --revisionNumber revision_number option for exporting previous states of entities containing properties with this checkbox cleared. The current value of the property is exported, so that immediately reimporting it does not reset the property value.

See the KBEC-00422 - Locating and Fixing Properties with Excessive Unwanted Change History Generated by Automated Processes_ KB article for details about locating properties for which this should have been done (but was not) and thus have a large change history.

In an XML output <property> tag and in the ectool createProperty, modifyProperty, and setProperty commands, this option is named suppressValueTracking, and its Boolean truth value is inverted.

Select OK to save your new or modified property information. For more information regarding creating and using properties, refer to: Properties help topic.