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

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
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
commaSeparated	This option controls how list items for build properties are specified. Valid values are: `true` and `false`. If `true`, any build property that can be specified as a list must have items separated by commas. If `false`, list items must be separated by a space. 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
exportAll	Specify `true` to export all build engines defined to the specified process area. The default is `false`. Any value specified for engineId and any Engine Elements specified will be ignored.	No
exportAsis	Specify `true` to have build property values exported "asis" and to have the asis attribute added to the build property elements. An "asis" property value means that the value is already in its resolved form. For example, if a build property specifies a workspace name, the unresolved form of the value is the name of the workspace and the resolved form of the value is a workspace UUID string. When the asis attribute is set to `true`, it signifies that the workspace value is already in UUID form. This attribute is optional. The default is `false`.	No
exportCreate	Specify `true` to have a createBuildEngine task created by the export. Specify `false` to have an updateBuildEngine task created by the export. The default is `true`.	No
exportFile	The name of the export file. This is the file where the Ant script with exported build engine is written. Since the export file is also an Ant build script, the file extension typically used for this file would be "xml".	Yes
exportFolder	The name of the export file folder. This is the location for the export file. A fully qualified path is required.	Yes
exportFormat	This option controls whether or not the resulting export file, and the XML it contains, is formatted for human consumption. Specify `true` to have the XML formatted into a more readable form. Specify `false` to create a standard, compact XML file. The default is `true`.	No
exportLog	This option controls whether or not the resulting export file is written to the console as well as the file. Specify `true` to write the XML to the console, or build log, in addition to the file. Specify `false` to write the XML only to the export file. The default is `false`.	No
exportReportAppend	This option controls the contents of the reportAppend attribute on the exported createBuildEngine or updateBuildEngine task. Specify `true` to have the reportAppend="true" attribute added to the task. Specify `false` to have the reportAppend="false" attribute added to the task. If this attribute is omitted, the reportAppend attribute will be omitted from the task in the export.	No
exportReportCondensed	This option controls the contents of the reportCondensed attribute on the exported createBuildEngine or updateBuildEngine task. Specify `true` to have the reportCondensed="true" attribute added to the task. Specify `false` to have the reportCondensed="false" attribute added to the task. If this attribute is omitted, the reportCondensed attribute will be omitted from the task in the export.	No
exportReportFile	This option controls the contents of the reportFile attribute on the exported createBuildEngine or updateBuildEngine task. Specify a `file_name` to have the reportFile="file_name" attribute added to the task. If this attribute is omitted, the reportFile attribute will be omitted from the task in the export.	No
exportReportFolder	This option controls the contents of the reportFolder attribute on the exported createBuildEngine or updateBuildEngine task. Specify a `folder_path` to have the reportFolder="folder_path" attribute added to the task. If this attribute is omitted, the reportFolder attribute will be omitted from the task in the export.	No
exportReportNoUuid	This option controls the contents of the reportNoUuid attribute on the exported createBuildEngine or updateBuildEngine task. Specify `true` to have the reportNoUuid="true" attribute added to the task. Specify `false` to have the reportNoUuid="false" attribute added to the task. If this attribute is omitted, the reportNoUuid attribute will be omitted from the task in the export.	No
exportReportSorted	This option controls the contents of the reportSorted attribute on the exported createBuildEngine or updateBuildEngine task. Specify `true` to have the reportSorted="true" attribute added to the task. Specify `false` to have the reportSorted="false" attribute added to the task. If this attribute is omitted, the reportSorted attribute will be omitted from the task in the export.	No
ignoreErrors	Specify `true` to ignore errors encountered while fetching a build property value. The default is `false`. This option can be used when build properties reference repository items that have been deleted. Normally a build exception would be generated when an item can not be found or fetched. This option ignores those errors and allows the export to complete. When using this option review the export XML file, any error will be flagged with "ERROR:" followed by the exception message that would have been issued.	No
processAreaName	The name of the EWM process area where the build 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
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

Engine Elements

One or more buildEngine elements can be specified within the element. Build engine elements are used to identify a series of build engines to export. Both the engineId attribute and Engine elements can be specified. At least one Engine element, or the engineId attribute, is required.

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

buildEngine Element Attributes
Attribute	Description	Required
engineId	The ID of the build engine to create.	Yes
exportReportAppend	This option controls the contents of the reportAppend attribute on the exported createBuildEngine or updateBuildEngine task. Specify `true` to have the reportAppend="true" attribute added to the task. Specify `false` to have the reportAppend="false" attribute added to the task. If this attribute is omitted and the attribute was omitted from the task, the reportAppend attribute will be omitted from the task in the export. If this attribute is omitted here, but is specified on the task, the value from the task will be used.	No
exportReportCondensed	This option controls the contents of the reportCondensed attribute on the exported createBuildEngine or updateBuildEngine task. Specify `true` to have the reportCondensed="true" attribute added to the task. Specify `false` to have the reportCondensed="false" attribute added to the task. If this attribute is omitted and the attribute was omitted from the task, the reportCondensed attribute will be omitted from the task in the export. If this attribute is omitted here, but is specified on the task, the value from the task will be used.	No
exportReportFile	This option controls the contents of the reportFile attribute on the exported createBuildEngine or updateBuildEngine task. Specify a file_name to have the reportFile="file_name" attribute added to the task. If this attribute is omitted and the attribute was omitted from the task, the reportFile attribute will be omitted from the task in the export. If this attribute is omitted here, but is specified on the task, the value from the task will be used.	No
exportReportFolder	This option controls the contents of the reportFolder attribute on the exported createBuildEngine or updateBuildEngine task. Specify a folder_path to have the reportFolder="folder_path" attribute added to the task. If this attribute is omitted and the attribute was omitted from the task, the reportFolder attribute will be omitted from the task in the export. If this attribute is omitted here, but is specified on the task, the value from the task will be used.	No
exportReportNoUuid	This option controls the contents of the reportNoUuid attribute on the exported createBuildEngine or updateBuildEngine task. Specify `true` to have the reportNoUuid="true" attribute added to the task. Specify `false` to have the reportNoUuid="false" attribute added to the task. If this attribute is omitted and the attribute was omitted from the task, the reportNoUuid attribute will be omitted from the task in the export. If this attribute is omitted here, but is specified on the task, the value from the task will be used.	No
exportReportSorted	This option controls the contents of the reportSorted attribute on the exported createBuildEngine or updateBuildEngine task. Specify `true` to have the reportSorted="true" attribute added to the task. Specify `false` to have the reportSorted="false" attribute added to the task. If this attribute is omitted and the attribute was omitted from the task, the reportSorted attribute will be omitted from the task in the export. If this attribute is omitted here, but is specified on the task, the value from the task will be used.	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 the specified report file. If this attribute is omitted here, but is specified on the task, the value from the task will be used. 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. If this attribute is omitted here, but is specified on the task, the value from the task will be used. 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. If this attribute is omitted here, but is specified on the task, the value from the task will be used.	No
reportFolder	The name of the report file folder. This is the location for the report file. A fully qualified path is required. If this attribute is omitted here, but is specified on the task, the value from the task will be used.	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. If this attribute is omitted here, but is specified on the task, the value from the task will be used. 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 order. If `false`, build properties are reported in random order. If this attribute is omitted here, but is specified on the task, the value from the task will be used. The default is `false`.	No

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.

Examples

Export build engine

<target name="export" description="Export Build Engine">
  
  <xt:exportBuildEngine
      repositoryAddress="${repositoryAddress}"
      userId="${userId}"
      password="${password}"
      engineId="${engineId}"
      processAreaName="${projectArea}"
      exportFile="${exportFile}"
      exportFolder="${exportFolder}"
    >
  </xt:exportBuildEngine>
  
</target>

Export build engines:

<target name="export" description="Export Build Engine">
  
  <xt:exportBuildEngine
      repositoryAddress="${repositoryAddress}"
      userId="${userId}"
      password="${password}"
      engineId="${engineId}"
      processAreaName="${projectArea}"
      exportFile="${exportFile}"
      exportFolder="${exportFolder}"
    >
    
    <xt:engine enginId="${engineId2"/>
    <xt:engine enginId="${engineId3"/>
    
  </xt:exportBuildEngine>
  
</target>

getTaskNameHdr()

Attributes

Engine Elements

Notes

Examples