exportBuildEngine

The exportBuildEngine task exports build engines from a Jazz™ repository into an executable Ant build script as a createBuildEngine or updateBuildEngine task embedded in a Build.Engines target.

You can use the exportBuildEngine task 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.

The following table describes exportBuildEngine 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 using the Jazz Build Engine.

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

No

smartCard

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

No

verbose

Specifies more message output. The default is false.

No

engineId

For the getNextTeamBuildRequest task, the identifier of the build engine for which to retrieve the next build request.

Yes

commaSeparated

This option controls how list items for build properties are specified. Valid values are true and false. If the value is true, a build definition report is generated. If false, list items must be separated by a space. 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

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 value is false.

No

exportCreate

Specify true to have a createBuildDfinition task created by the export. Specify false to have an updateBuildDefinition task created by the export. The default value is true.

No

exportFile

The name of the export file. This is the file where the Ant script with exported build definition is written. Since the export file is also an Ant build script, the file extension typically used for this file is "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 wheterh 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 xexport file. The default value is false.

No

exportReportAppend

This option controls the contents of the reportAppend attribute on the exported createBuildDefinition or updateBuildDefinition 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 createBuildDefinition or updateBuildDefinition 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 adttribute on the exported createBuildDefinition or updateBuildDefinition task. Specify a file_name to have the reportFile="file_name"attribute added to the task. If this attribute is omitted, the reportFolder attribute will be omitted from the task in the export.

No

exportReportFolder

This option controls the contents of the reportFolder attribute on the exported createBuildDefinition or updateBuildDefinition 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 createBuildDefinition or updateBuildDefinition 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 createBuildDefinition or updateBuildDefinition 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

processAreaName

The name of the EWM process area where the build is defined. The process area name can be a combination of elements. For example, if a process area is a team area, the process area name is the concatenation of three elements: the process area, a backslash (/) and the team area.

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. Nevertheless, if the process area is a team area, the EWM process area must be explicitly identified to define where the Enterprise Extensions system definitions are.

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

Engine Elements

One or more Engine elements can be specified in the exportBuildEngine 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.

Attribute Description Required

engineId

For the getNextTeamBuildRequest task, the identifier of the build engine for which to retrieve the next build request.

Yes

exportReportAppend

This option controls the contents of the reportAppend attribute on the exported createBuildDefinition or updateBuildDefinition 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 createBuildDefinition or updateBuildDefinition 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 adttribute on the exported createBuildDefinition or updateBuildDefinition task. Specify a file_name to have the reportFile="file_name"attribute added to the task. If this attribute is omitted, the reportFolder attribute will be omitted from the task in the export.

No

exportReportFolder

This option controls the contents of the reportFolder attribute on the exported createBuildDefinition or updateBuildDefinition 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 createBuildDefinition or updateBuildDefinition 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 createBuildDefinition or updateBuildDefinition 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

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

Note:
  • If any one of the exportReportAppend, exportReportCondensed, exportReportFile, exportReportFolder, exportReportNoUuid, exporeReportSorted, or exportReportOnly attributes are specified on the exportBuildEngine 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 exportBuildEngine element, the value for the attribute can be overridden by a similar attribute on a buildEngine element.
  • If any one of the exportReportAppend, exportReportCondensed, exportReportFile, exportReportFolder, exportReportNoUuid, exportReportSorted, or exportReportOnly attributes are specified on the exportuildEngine element and overridden by a similar attribute on a buildEngine element, the value for the attribute will revert back to the value specified on the exportBuildEngine element for subsequent buildEngine elements unless overridden on the subsequent buildEngine elements.

Example

  • 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 engineId="${engineId2}"/>
    		<xt:engine engineId="${engineId3}"/>
    	</xt:exportBuildEngine>
    
    </target>

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki