Build Engine Reference

This section identifies the supported build engines and their characteristics.

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 identifies 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 element properties and team build properties. When creating a build engine, you need to ensure to include only configuration elements and team build properties that are supported by the build engine.

The following sections identify supported build types and details.

Jazz Build Engine
Name: Jazz Build Engine  
Description: This build engine registration represents a Jazz Build Engine or other process on a build machine that polls the repository for build requests.  
Template ID: com.ibm.team.build.engine.jbe  
Configuration elements:

Build Properties

Build Property Copy

engineProperty Element

enginePropertyCopy Element

Team build properties: None  
Hudson/Jenkins Engine
Name: Hudson/Jenkins Engine  
Description: This build engine registration represents a connection to an Hudson/Jenkins build system.  
Template ID: com.ibm.rational.connector.hudson.engine.template  
Configuration elements:

Build Properties

Build Property Copy

Hudson/Jenkins Engine Properties

engineProperty Element

enginePropertyCopy Element

hdsnEngineProperty Element

Team build properties teamEngine Property Element - Hudson/Jenkins  
Rational Build Agent Engine
Name: Rational Build Agent Engine  
Description: This build engine registration represents a Rational Build Agent process on a build machine that handles build requests.  
Template ID: com.ibm.rational.buildforge.buildagent.engine  
Configuration elements:

Build Properties

Build Property Copy

Rational Build Agent Engine Properties

engineProperty Element

enginePropertyCopy Element

rbaEngineProperty Element

Team build properties None  
Rational Build Forge Engine
Name: Rational Build Forge Engine  
Description This build engine registration represents a connection to Rational Build Forge.  
Template ID: com.ibm.rational.connector.buildforge.engine.template  
Configuration elements:

Build Properties

Build Property Copy

Hudson/Jenkins Engine Properties

engineProperty Element

enginePropertyCopy Element

rbfEngineProperty Element

Team build properties: teamEngine Property Element - Rational Build Forge  
  • 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 might not be applicable to the type of engine you are creating.

  • Configuration Properties

    The following sections describe how to define the various engine properties used in a build engine. Each section describes an element that can be specified within the createBuildEngine or updateBuildEngine element. Not all elements are applicable to a type of engine.

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

    Attribute Required Description
    name Yes Name of the engine property. Valid names are described in each of the following sections.
    value Yes
    Value of the engine property. Valid values and restrictions are described in each of the following sections. Restrictions on the valid values are noted in the value column. The restrictions noted are as follows:
    Restriction Description
    boolean This is a boolean value that must be specified as either true or false.
    integer This must be an integer value.
    true/false This is a boolean value that must be specified as either true or false.
    value list One of the listed values must be specified. For example: ALWAYS, NO_ERRORS, or NO_WARNINGs.
    asis No Valid values are true and false. The default value is false. Specifying this attribute will control how the property is resolved.
    description No This attribute is ignored.
    genericEditAllowed No This attribute is ignored.
    kind No This attribute is ignored.
    label No This attribute is ignored.
    override No This attribute is ignored.
    required No This attribute is ignored.
    scheduleOverride No This attribute is ignored.
    wellKnown No This attribute is ignored.
  • 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 u sing 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 ar valid for the type of engine you are defining. The teamEngineProperty element is not required and might not be applicable to the type of engine you are creating.

    All team build properties support the standard property attributes, but most attributes are ignored as the values for the attributes are set internally and cannot be overridden. The following table describes the attributes and what effect, if any, specifying the attributes has on the build property.

    Attribute Required Description
    name Yes Name of the build property. Valid names are described in eaqch of the following sections.
    value Yes
    Value of the build property. Valid values and restrictions are described in each of the following sections. Restrictions on the valid values are noted in the value column. The restrictions noted are as follows:
    Restrictions: Description:
    boolean This is a boolean value that must be specified as either true or false.
    integer This must be an integer value.
    true/false This is a boolean value that must be specified as either true or false.
    value list One of the listed values must be specified. For example, ALWAYS, NO_ERRORS, or NO_WARNINGS.
    asis No Valid values are true and false. The default value is false. Specifying this attribute will control how the property is resolved.
    description No This attribute is ignored.
    genericEditAllowed No This attribute is ignored.
    kind No This attribute is ignored.
    label No This attribute is ignored.
    override No Valid values are true and false. The default value is false. Specify true for this attribute when updating restriced Team Build property values.
    required No This attribute is ignored.
    scheduleOverride No This attribute is ignored.
    wellKnown No This attribute is ignored.
Restriction Description
boolean This is a boolean value that must be specified as either true or false.
integer This must be an integer value.
true/false This is a boolean value that must be specified as either true or false.
value list One of the listed values must be specified. For example, ALWAYS, NO_ERRORS, or NO_WARNINGS.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki