createBuildEngine

The createBuildEngine task creates a build engine in the Jazz™ repository.
There are currently four support build engines:
  • Jazz Build Engine
  • Hudson/Jenkins Engine
  • Rational Build Agent Engine
  • Rational Build Forge Engine
Additional engine elements may be required for these engines. Refer to the Build Engine Reference section to determine which elements are valid for the engine you are defining.

The following table describes createBuildEngine attributes.

Attribute Description Required

repositoryAddress

Address of the team repository to use. The value of this attribute is typically ${repositoryAddress} because that property is built-in when using the Jazz Build Engine.

Yes

userId

User ID for authentication to the repository. Requires password or passwordFile to be set.

Yes

certificateFile

The path to the file that contains the user's login certificate for authentication. Requires password or passwordFile to be set. You can specify certificateFile or repositoriesFile, but not both.

No

password

Password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both.

No

passwordFile

The password file to use for authentication to the connection. You can create a suitable password file by invoking the Jazz Build Engine with the -createPasswordFile argument. You can only specify one password file. Either password or passwordFile can be provided, but not both.

No

smartCard

Whether to use the connected smart card for authentication (true or false). Requires userId to be set. For more information about smart card authentication, see Connecting to repositories and project areas.

No

failOnError

If true (the default), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

No

verbose

Specifies more message output. The default is false.

No

activateEngine

This option controls whether the engine is active. Valid values are true and false. If the value is true, the engine is active. If false, the engine is inactive. The default value is true.

No

createReport

This option controls whether or not a build definition report is generated. Valid values are true and false. If the value is true, a build definition report is generated. If false, no report is generated. If other reporte attributes are specified and createReport is set to false, no report is generated and the other report attributes are ignored. The default is true.

No

engineDescription

The description of the build engine to create.

Yes

engineId

For the getNextTeamBuildRequest task, the identifier of the build engine for which to retrieve the next build request.

Yes

monitorThreshold

This option controls the engine monitor threshold. Valid values are in minutes. The default value is 0.

No

processAreaName

The name of the EWM process area where the build is defined. The process area name can be a combination of elements. For example, if a process area is a team area, the process area name is the concatenation of three elements: the process area, a backslash (/) and the team area.

Yes

processAreaNameDefinitions

The name of the EWM process area where Enterprise Extensions resource definitions used by this build are defined. If not specified, the EWM process area identified by the processAreaName attribute is used. Nevertheless, if the process area is a team area, the EWM process area must be explicitly identified to define where the Enterprise Extensions system definitions are.

No

reportAppend

This option controls whether the build definition report is appended to or overwrites the specified report file. Valid values are true and false. If the value is true, the build definition report will be appended to the specified report file. If false, the build definition report will overwrite (replace) the specified report file. The default is false.

No

reportCondensed

Thihs option controls the format of build properties written to the build definition report. Valid values are true and false. If the value is true, each build property will be reported on a single line, displaying only the name and value of the property. If false, each build property will be reported on multiple lines, displaying each attribute of the build property on a line. The default value is false.

No

reportFile

The name of the report file. If a reportFile is specified, the build definition report will be written to the file. If omitted, the build definition report will be written to the build log.

No

reportFolder

The name of the report file folder. This is the location for the report file. A fully qualified path is required.

No

reportNoUuid

This option controls whether or not UUID values are printed. Valid values are true and false. If the value is true, UUID values are printed x-ed out. If false, UUID values are printed as strings. The defualt value is false.

No

reportOnly

Specify true to have createBuildDefinition only create a build report. This option h as been superseded by the reportBuildDefinition tasks and is kept for compatibility purposese only. Valid values are true and false. The default value is false.

No

reportSorted

This option controls whether or not build properties are reported in sorted order in the build definition report. Valid values are true and false. If the value is true, build properties are reported in sorted name order. If false, build properties are reported in random order. The default is false.

No

templateId

Specify the template ID or template alias for the build that is to be created. See the Build Reference section for more information on build template IDs or template aliases.

Yes

updateOnly

Specify true to limit the update process to updating existing properties and to avoid automatic property clean up actions. Valid values are true and false. The default is false.

No

Example

  • Create a Jazz Build Engine:
    <target name="create" description="Create Build Engine">
      
         <xt:createBuildEngine
             repositoryAddress="${repositoryAddress}"
             userId="${userId}"
             password="${password}"
             engineId="${engineId}"
             engineDescription="${engineDesc}"
             processAreaName="${projectArea}"
             templateId="com.ibm.team.build.engine.jbe"
             activateEngine="true"
             monitorThreshold="5"
             processRequests="true">
         </xt:createBuildEngine>
      
    </target>
  • Create a Rational Build Agent Engine with additional engine elements:
    <target name="create" description="Create Build Engine">
      
         <xt:createBuildEngine
             repositoryAddress="${repositoryAddress}"
             userId="${userId}"
             password="${password}"
             engineId="${engineId}"
             engineDescription="${engineDesc}"
             processAreaName="${projectArea}"
             templateId="com.ibm.rational.buildforge.buildagent.engine"
             activateEngine="true"
             monitorThreshold="5"
             processRequests="true">
      
             <!-- Rational Build Agent Properties -->
             <xt:rbaEngineProperty name="com.ibm.rational.buildforge.buildagent.hostname"        value="http://hostname"/>
             <xt:rbaEngineProperty name="com.ibm.rational.buildforge.buildagent.password"        value="password"/>
             <xt:rbaEngineProperty name="com.ibm.rational.buildforge.buildagent.port"            value="1234"/>
             <xt:rbaEngineProperty name="com.ibm.rational.buildforge.buildagent.secure"          value="false"/>
             <xt:rbaEngineProperty name="com.ibm.rational.buildforge.buildagent.secure.protocol" value="default"/>
             <xt:rbaEngineProperty name="com.ibm.rational.buildforge.buildagent.userid"          value="userid"/>
         </xt:createBuildEngine>
      
    </target>

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