The task is used to delete an existing build engine from the Jazz™ repository. The build engine is permanently removed from the repository. This action is not reversible.

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
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
deleteAll This option controls whether or not all build engines in the specified process area are deleted. If true, all build engines in the specified process area are permanently deleted. If false, only the build engine identified by engineId will be deleted. The default is false. If this attribute is set to true, a engineId is not required, and if one is specified, it will be ignored. No
deleteIgnore This option controls whether or not the task fails if the build engine is not found. If the build engine is not found and deleteIgnore is set to true, the task returns and the build continues. If the build engine is not found and deleteIgnore is set to false, an exception is thrown and the build fails. The default is true. No
engineId The ID of the build engine to create. Yes
processAreaName The name of the EWM process area where the build is defined. Yes
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

Notes

Examples

Delete a build engine 

<target name="delete" description="Delete Build Engine">
  
  <xt:deleteBuildEngine
      repositoryAddress="${repositoryAddress}"
      userId="${userId}"
      password="${password}"
      engineId="${engineId}"
      processAreaName="${projectArea}"
    >
  </xt:deleteBuildEngine>
  
</target>