The task is used to export build definitions from the Jazz™ repository into an executable Ant build script as a createBuildDefinition or updateBuildDefinition task embedded in a Build.Definitions target. The task can be used to export a single build definition, or a series of build definitions, into a fully formatted Ant build script. The generated build script can be used for build definition recovery, backup and restore of the build definition, moving the build definition to another repository, and/or ongoing maintenance of the build definition.

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:

buildDefinition Elements

One or more buildDefinition elements can be specified within the element. Build definition elements are used to identify a series of build definitions to export. Both the buildId attribute and buildDefinition elements can be specified. At least one buildDefinition element, or the buildId attribute, is required.

The following table describes the valid buildDefinition element attributes and their options:

Notes

• If any one of the exportReportAppend, exportReportCondensed, exportReportFile, exportReportFolder, exportReportNoUuid, exportReportSorted, or exportReportOnly attributes are specified on the element, the value for the attribute will be used for all exported builds.
• If any one of the exportReportAppend, exportReportCondensed, exportReportFile, exportReportFolder, exportReportNoUuid, exportReportSorted, or exportReportOnly attributes are specified on the element, the value for the attribute can be overridden by a similar attribute on a buildDefinition element.
• If any one of the exportReportAppend, exportReportCondensed, exportReportFile, exportReportFolder, exportReportNoUuid, exportReportSorted, or exportReportOnly attributes are specified on the element and overridden by a similar attribute on a buildDefinition element, the value for the attribute will revert back to the value specified on the element for subsequent buildDefinition elements unless overridden on the subsequent buildDefinition elements.
• If the processAreaNameDefinitions attribute is specified on the element, the value for the attribute will be used for all exported builds.
• If the processAreaNameDefinitions attribute is specified on the element, the value for the attribute can be overridden by a similar attribute on a buildDefinition element.
• If the processAreaNameDefinitions attribute is specified on the element and overridden by a similar attribute on a buildDefinition element, the value for the attribute will revert back to the value specified on the element for subsequent buildDefinition elements unless overridden on the subsequent buildDefinition elements.
• The value for the buildWorkspace attribute specified on the element, will be used for all exported builds.
• The value for the buildWorkspace attribute specified on the element, can be overridden by a similar attribute on a buildDefinition element.
• The value for the buildWorkspace attribute specified on the element and overridden by a similar attribute on a buildDefinition element, will revert back to the value specified on the element for subsequent buildDefinition elements unless overridden on the subsequent buildDefinition elements.
• When creating or maintaining a series of similar builds, define a single prototype workspace for the builds and specify that workspace for the buildWorkspace attribute. If the createWorkspace attribute is set to true, any unique workspaces required by a build, and not found in the repository, will be automatically created by the createBuildDefinition task using the prototype workspace as a model when the build definition is created. This feature can be used to avoid the overhead of manually creating individual workspaces for a series of builds.

Examples

Export build definition

<target name="export" description="Export Build Definition">
  
  <xt:exportbuilddefinition
      repositoryAddress="${repositoryAddress}"
      userId="${userId}"
      password="${password}"
      buildId="Test.djr.Dpnd.013"
      buildWorkspace="Test.djr.Stream.000.Workspace"
      processAreaName="${paDJR}"
      processAreaNameDefinitions="Liams PA"
      exportFile="BuildDefinition.000.xml"
      exportFolder="C:\Users\djreilly\Downloads"
      exportFormat="true"
      exportLog="true"
      exportReportCondensed="true"
      exportReportFile="Test.djr.Dpnd.013.txt"
      exportReportFolder="C:\Users\djreilly\Downloads"
      exportReportSorted="true">
  </xt:exportbuilddefinition>
  
  <xt:exportbuilddefinition
      repositoryAddress="${repositoryAddress}"
      userId="${userId}"
      password="${password}"
      buildId="Test.djr.Dpnd.013"
      buildWorkspace="Test.djr.Stream.000.Workspace"
      processAreaName="${paDJR}"
      processAreaNameDefinitions="Liams PA"
      exportFile="BuildDefinition.001.xml"
      exportFolder="C:\Users\djreilly\Downloads"
      exportFormat="true"
      exportLog="true"
      exportReportCondensed="true"
      exportReportFile="Test.djr.Dpnd.013.txt"
      exportReportFolder="C:\Users\djreilly\Downloads"
      exportReportSorted="true"
    >
    <xt:buildDefinition buildId="Test.djr.Dpnd.000" processAreaNameDefinitions="${paDJR}" exportReportFile="Test.djr.Dpnd.000.txt"/>
    <xt:buildDefinition buildId="Test.djr.Dpnd.001" processAreaNameDefinitions="${paDJR}" exportReportFile="Test.djr.Dpnd.001.txt"/>
    <xt:buildDefinition buildId="Test.djr.Dpnd.010" processAreaNameDefinitions="${paDJR}" exportReportFile="Test.djr.Dpnd.010.txt"/>
    <xt:buildDefinition buildId="Test.djr.Dpnd.011" processAreaNameDefinitions="${paDJR}" exportReportFile="Test.djr.Dpnd.011.txt"/>
    <xt:buildDefinition buildId="Test.djr.Dpnd.012" exportReportFile="Test.djr.Dpnd.012.txt"/>
    
  </xt:exportbuilddefinition>
  
</target>