updateBuildEngine

The updateBuildEngine task updates a build engine in the Jazz® repository.

There are currently four support build engines:
  • Jazz Build Engine
  • Hudson/Jenkins
  • Rational Build Agent
  • Rational Build Forge
Addtional engine elements might be required for these engines. Refer to the Build Engine Reference to determine which elements are valid for the engine you are refining.

The following table describes updateBuildEngine 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 the Jazz Build Engine is used.

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. Only one password file can be specified. Either password or passwordFile can be provided, but not both.

No

smartCard

Use of 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 (default value), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

No

verbose

More message output. The default value is false.

No

activeEngine

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.

No

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 Engineering Workflow Management process area where the builds are defined.

When the process area is a child of a parent process area, like a team area, specify the process area name in a path format starting with the project area name ( /project_area_name/team_area_name/subteam_area_name for example).

Yes

processAreaNameDefinitions

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

No

propertyCopy

This option controls whether or not the property copy process is enabled. Valid values are true and false. If the value is true, all buildPopertyCopy attributes will be processed an new ant properties will be created for those build properties specified by the buildPropertyCopy elements. See the buildPropertyCopy Element section for more information. The default is false.

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

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

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

  • Update a Jazz Build Engine
    
    <target name="update" description="Update Build Engine">
      
         <xt:updateBuildEngine
             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:updateBuildEngine>
      
    </target>
    
  • Update a Rational Build Agent Engine and save original engine properties
    
    <target name="update" description="Update Build Engine">
    
         <xt:updateBuildEngine
             repositoryAddress="${repositoryAddress}"
             userId="${userId}"
             password="${password}"
             engineId="${engineId}"
             processAreaName="${projectArea}"
             activateEngine="true"
             monitorThreshold="5"
             processRequests="true"
             propertyCopy="true">
       
             <!-- Save Original Properties -->
             <xt:enginePropertyCopy copy="com.ibm.rational.buildforge.buildagent.hostname"        name="copyOf.hostname"/>      
             <xt:enginePropertyCopy copy="com.ibm.rational.buildforge.buildagent.password"        name="copyOf.password"/>      
             <xt:enginePropertyCopy copy="com.ibm.rational.buildforge.buildagent.port"            name="copyOf.port"/>          
             <xt:enginePropertyCopy copy="com.ibm.rational.buildforge.buildagent.secure"          name="copyOf.secure"/>        
             <xt:enginePropertyCopy copy="com.ibm.rational.buildforge.buildagent.secure.protocol" name="copyOf.secure.protocol"/>
             <xt:enginePropertyCopy copy="com.ibm.rational.buildforge.buildagent.userid"          name="copyOf.userid"/>        
     
             <!-- Rational Build Agent Properties -->
             <xt:rbaEngineProperty  name="com.ibm.rational.buildforge.buildagent.hostname"        value="http://newHostname"/>
             <xt:rbaEngineProperty  name="com.ibm.rational.buildforge.buildagent.password"        value="newPassword"/>
             <xt:rbaEngineProperty  name="com.ibm.rational.buildforge.buildagent.port"            value="5678"/>
             <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="newUserid"/>
         </xt:updateBuildEngine>
      
    </target>