The task is used to update an existing build engine in the Jazz™ repository. There are currently four supported build engines: Jazz Build Engine, Hudson/Jenkins Engine, Rational Build Agent Engine, and Rational Build Forge Engine. Additional engine elements may be required for these engines. Refer to the Build Engine Reference to determine which elements are valid for the engine you are defining.

Attributes

The task supports Team Build Attributes, Build Extensions Debugging Attributes, Build Extensions General Attributes, as well as, its own task specific attributes. Click on a link for more information on the common attributes.

The following table describes the task specific attributes for the task:

Task Specific Attributes
Attribute	Description	Required
activateEngine	This option controls whether the engine is active or not. Valid values are: `true` and `false`. If `true`, the engine is active. If `false`, the engine is inactive. The default is `true`.	No
createReport	This option controls whether or not a build engine report is generated. Valid values are: `true` and `false`. If `true`, a build engine report is generated. If `false`, no report is generated. If other report 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
createWorkspace	This option controls whether or not a workspace is created when referenced by a build property, but not found. Valid values are: `true` and `false`. If `true`, and a non-existing workspace is referenced by a build property, the workspace is created by this task using the engineWorkspace workspace as a template. If `false`, and a non-existing workspace is referenced by a build property, the build fails. The default is `true`.	No
engineDescription	The description of the build engine to create.	No
engineId	The ID of the build engine to create.	Yes
engineWorkspace	The name of a workspace to use to resolve build properties that reference streams, components, projects or files included in the engine definition. It must be a workspace that is attached to the same streams, components, projects, and files referenced by the build properties. This workspace is used as a prototype for any workspace that is created for build properties (see: createWorkspace for more information on workspaces created for engine properties). It is also used to locate streams, components, projects, and files referenced by build properties. Note: This workspace must exist prior to running the this task.	No
monitorThreshold	This option controls the engine monitor threshold. Valid values are: in minutes. The default is 0.	No
processAreaName	The name of the EWM process area where the engine is defined.	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.	No
propertyCopy	This option is used to copy the existing property values. It’s used with the enginePropertyCopy element. Refer to Build Engine Reference for details. Valid values are: `true` and `false`. The default is `false`.	No
reportAppend	This option controls whether the build engine report is appended to, or overwrites, the specified report file. Valid values are: `true` and `false`. If `true`, the build engine report will be appended to the specified report file. If `false`, the build engine report will overwrite (replace) the specified report file. The default is `false`.	No
reportCondensed	This option controls the format of build properties written to the build engine report. Valid values are: `true` and `false`. If `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 is `false`.	No
reportFile	The name of the report file. If a reportFile is specified, the build engine report will be written to the file. If omitted, the build engine 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 `true`, UUID values are printed x-ed out. If `false`, UUID values are printed as strings. The default is `false`.	No
reportSorted	This option controls whether or not build properties are reported in sorted order in the build engine report. Valid values are: `true` and `false`. If `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

Examples

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>

getTaskNameHdr()

Attributes

Examples