Build Engine Reference

This section identifies the supported build engines and their characteristics. The name, description, and template ID are listed for each of the supported engines.

This section also describes the configuration elements and team build properties that are supported by each of the build engines. Every build engine supports a predetermined set of configuration elements, the properties associated with those configuration elements, and team build properties. When creating a build engine, you must ensure to include only those configuration element properties and team build properties that are supported by the build engine.

When a build engine is created, all required configuration elements and team build properties are added to the engine definition. The value for any configuration element property or team build property that you include will be used when the elements and properties are processed. Any configuration element property or team build property that you do not include will be set to its default value. The required configuration elements for each engine type are identified in the ‘Configuration elements’ entry for the engine type with a ^(*).

If you include a configuration element property for an optional configuration element, the optional configuration element will be added to the engine and the specified property will be set to the specified value within that configuration element. Any other properties that are required by the optional configuration element which are not included will be defined using their default values. If you delete all configuration element properties for an optional configuration element, the element will be deleted from the engine definition.

The following sections identify each of the supported build types and their details.

Jazz Build Engine

Hudson/Jenkins Engine

Rational Build Agent Engine

Rational Build Forge Engine

Engine Properties

The following sections describe how to define general build properties used in a build engine. Each section describes an element that can be specified within the createBuildEngine or updateBuildEngine element. These elements are not required and may not be applicable to the type of engine you are creating. Refer to the Build Engine Reference section to determine which elements are valid for the engine you are defining.

engineProperty Element

Code as many engineProperty elements as are needed to define the custom build properties for the build engine. One engineProperty element is needed for each custom build property. The following table describes the valid values for the engineProperty element attributes:

<xt:buildProperty name="name">value</xt:buildProperty>
            

enginePropertyCopy Element

Code enginePropertyCopy elements to identify which properties are to be copied during a updateBuildEngine task. When the updateBuildEngine task propertyCopy attribute is set to true each property identified will have its value copied into the specified Ant property prior to any updates. The enginePropertyCopy facility can be used to save, update, and then restore build property values during a build.The following table describes the valid values for the enginePropertyCopy element attributes:

Configuration Properties

The following sections describe how to define the various configuration properties used in an engine definition. Each section describes an engine definition sub-element that can be specified within the createBuildEngine or updateBuildEngine element. These sub-elements are used to define information required by an engine configuration element. Each engine definition sub-element represents a corresponding engine configuration element. Not all configuration elements are applicable to a type of engine. Refer to Build Engine Reference to determine which elements are valid for the engine you are defining.

All engine configuration properties support the standard property attributes, but most attributes are ignored as the values for the attributes are set internally and can not be overridden. The following table describes the attributes and what affect, if any, specifying the attributes has on the engine property itself.

hdsnEngineProperty Element

Code hdsnEngineProperty elements to specify configuration details for a Hudson/Jenkins build engine. The hdsnEngineProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the hdsnEngineProperty element attributes:

rbaEngineProperty Element

Code rbaEngineProperty elements to specify configuration details for a Rational Build Agent build engine. The rbaEngineProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the rbaEngineProperty element attributes:

rbfEngineProperty Element

Code rbfEngineProperty elements to specify configuration details for a Rational Build Forge build engine. The rbfEngineProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the rbfEngineProperty element attributes:

Team Build Properties

The following sections describe how to define the Team Build properties used in a build definition. Each section describes a set of Team Build properties that can be defined using the teamEngineProperty element. The teamEngineProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format.

Code as many teamEngineProperty elements as are needed to define the Team Build properties for the build definition. One teamEngineProperty element is needed for each Team Build property. Code the teamEngineProperty element within the createBuildEngine or updateBuildEngine element. Specify only those Team Build properties that are valid for the type of engine you are defining. The teamEngineProperty element is not required and may not be applicable to the type of engine you are creating. Refer to xxx to determine if teamEngineProperty elements are valid for the engine you are defining.

All Team Build properties support the standard property attributes, but most attributes are ignored as the values for the attributes are set internally and can not be overriden. The following table describes the attributes and what affect, if any, specifying the attributes has on the build property itself.

teamEngineProperty Element - Hudson/Jenkins Engine

The following table describes the valid values for the teamEngineProperty element attributes for an Hudson/Jenkins build engine:

teamEngineProperty Element - Rational Build Forge Engine

The following table describes the valid values for the teamEngineProperty element attributes for an Hudson/Jenkins build engine:

Build Engine Examples

This section provides Ant script examples for each of the engine types.

Jazz Build Engine Example

This build engine registration represents a Jazz Build Engine or other process on a build machine that polls the repository for build requests.

Result

Hudson/Jenkins Engine Example

This build engine registration represents a connection to an Hudson/Jenkins build system.

Rational Build Agent Engine Example

This build engine registration represents a Rational Build Agent process on a build machine that handles build requests.

Rational Build Forge Engine Example

This build engine registration represents a connection to Rational Build Forge.