Configuration Properties

Edit online

The following sections describe how to define the various build properties used in a build definition. Each section describes an element that can be specified within the createBuildDefinition or updateBuildDefinition element. Not all elements are applicable to a type of build.

Refer to Build Reference to determine which elements are valid for the build you are defining.

All build configuration properties support the standard property attributes, but most attributes are ignored as the values for the attributes are set internally and can not be overridden. The following table describes the attributes and what affect, if any, specifying the attributes has on the build property itself.

Attribute Required Description

name

Yes

Name of the build property. Valid names are described in each of the following sections.

value

Yes

Value of the build property. Valid values and restrictions are described in each of the following sections. Restrictions on the valid values are noted in the value column. The restrictions noted are as follows:

Restriction	Description
boolean	This is a boolean value which must be specified as either `true` or `false`.
integer	This must be an integer value.
true/false	This is a boolean value which must be specified as either `true` or `false`.
value list	One of the listed values must be specified. For example: `ALWAYS`, `NO_ERRORS`, or `NO_WARNINGS`.

asis

This attribute is ignored.

description

This attribute is ignored.

genericEditAllowed

This attribute is ignored.

kind

This attribute is ignored.

label

This attribute is ignored.

override

This attribute is ignored.

required

This attribute is ignored.

scheduleOverride

This attribute is ignored.

wellKnown

This attribute is ignored.

antBuildProperty Element

Code antBuildProperty elements to specify configuration details, the build file to use, and the build targets to be invoked for an Ant build. The antBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the antBuildProperty element attributes:

name	value	Description
com.ibm.team.build.ant.antArgs		Ant arguments: These arguments will be passed to the invocation of Ant.
com.ibm.team.build.ant.antHome		Ant home: By default, the Ant within the Jazz build engine will be used. This may be an absolute path on the build machine or a path relative to the current directory of the build engine process.
com.ibm.team.build.ant.buildFile		Build file:* The path to the Ant build file on the build machine. This can be an absolute path on the build machine or may be a path relative to the current directory of the build engine process.
com.ibm.team.build.ant.includeToolkit	true false	Jazz build toolkit: Include the Jazz build toolkit tasks on the Ant library path. Adds the -lib Ant argument with the path to the Jazz buildtoolkit directory.
com.ibm.team.build.ant.javaHome		Java home: If none is specified, it will default to the Java instance running the build engine.
com.ibm.team.build.ant.javaVMArgs		Java VM arguments: These arguments will be passed to the VM used to invoke Ant.
com.ibm.team.build.ant.propertiesFile		Properties file: This is an output file that will contain all build definition, build engine, and built-in properties used in the build.
com.ibm.team.build.ant.targets		Build targets: The targets in the build file to execute. Multiple targets must be separated by commas. If none are specified, the build file's default target is executed.
com.ibm.team.build.ant.workingDir		Working directory: The working directory to be used by the invoked Ant process. By default, the current directory of the build engine process is used.

antzBuildProperty Element

Code antzBuildProperty elements to specify configuration details, the build file to use, and the build targets to be invoked for an Ant with Enterprise Extensions build. The antzBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the antzBuildProperty element attributes:

name	value	Description
teamz.build.ant.antArgs		Ant arguments: These arguments will be passed to the invocation of Ant.
teamz.build.ant.antHome		Ant home: By default, the Ant within the Jazz build engine will be used. This may be an absolute path on the build machine or a path relative to the current directory of the build engine process.
teamz.build.ant.buildFile		Build file:* The path to the Ant with Enterprise Extensions build file on the build machine. This can be an absolute path on the build machine or may be a path relative to the current directory of the build engine process. Note: It is advised to avoid using blanks or $ in the path as these characters (or their national language equivalents) can cause inconsistent results. The load directory can be referenced using the built-in build property `${teamz.scm.fetchDestination}`. For example: `${teamz.scm.fetchDestination}/buildProject/build.xml`
teamz.build.ant.buildOrder		Build order: Configure the order in which items will be built. Specify a list of language names, in the order in which they should be built, with each name separated by a comma.
teamz.build.ant.createBuildMaps	true false	Create build maps: Create build maps for the build results.
teamz.build.ant.generateReports	true false	Generate a build file: Specify `true` when the teamz.build.ant.useGeneratedBuildFile attribute is set to `true`.
teamz.build.ant.javaHome		Java home: If none is specified, it will default to the Java instance running the build engine.
teamz.build.ant.javaVMArgs		Java VM arguments: These arguments will be passed to the VM used to invoke Ant.
teamz.build.ant.propertiesFile		Properties file: This is an output file that will contain all build definition, build engine, and built-in properties used in the build.
teamz.build.ant.targets		Build targets: The targets in the build file to execute. Multiple targets must be separated by commas. If none are specified, the build file's default target is executed.
teamz.build.ant.useGeneratedBuildFile	true false	Generate a build file: Specify `true` to generate a build file automatically from available language definitions. When this property is set to `true`, a build order property, teamz.build.ant.buildOrder, is required. Use an existing build file: Specify `false` to specify a custom build file and the targets to be invoked. When this property is set to `false`, a build file property, teamz.build.ant.buildFile, is required.
teamz.build.ant.workingDir		Working directory: The working directory to be used by the invoked Ant process. By default, the current directory of the build engine process is used.

Note:

The following is a list of reserved properties names which can not be specified unless overridden:
- teamz.build.ant.buildAllItems
- teamz.build.ant.conditionalBuild
The following is a list of reserved properties names which can not be specified:
- teamz.build.ant.buildableSubset

cmdBuildProperty Element

Code cmdBuildProperty elements to specify configuration details for the Command Line build. The cmdBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the cmdBuildProperty element attributes:

name	value	Description
com.ibm.team.build.cmdline.arguments		Arguments: Arguments for the command.
com.ibm.team.build.cmdline.command		Command:* The command to be invoked.
com.ibm.team.build.cmdline.environmentVariablePolicy	ADD NONE OVERRIDE REPLACE	Environment variables (policy): Choose how environment variables are set. The following lists the valid values and their meaning: ADD - This value indicates that environment variables will be added but not override existing environment variables. NONE - This value indicates no environment variables will be added. OVERRIDE - This value indicates that environment variables will be added and override existing environment variables. REPLACE - This value indicates that the entire native environment will be replaced with the build properties.
com.ibm.team.build.cmdline.environmentVariablePrefix		Environment variables (prefix): The prefix added to the name of each new environment variable.
com.ibm.team.build.cmdline.propertiesFile		Properties file: This is an output file that will contain all build definition, build engine, and built-in properties used in the build.
com.ibm.team.build.cmdline.workingDir		Working directory: The working directory to be used by the invoked command process. By default, the current directory of the build engine process is used.

dpndBuildProperty Element

Code dpndBuildProperty elements to specify configuration details, the build file to use, and the build targets to be invoked for a z/OS Dependency build. The dpndBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the dpndBuildProperty element attributes:

name value Description

team.enterprise.build.ant.antArgs

Ant arguments: These arguments will be passed to the invocation of Ant.

team.enterprise.build.ant.antHome

Ant home: By default, the Ant within the Jazz build engine will be used. This may be an absolute path on the build machine or a path relative to the current directory of the build engine process.

team.enterprise.build.ant.buildAllItems

true

false

Build workspace: Build all items in the workspace. When this property is set to false, a build subset property, team.enterprise.build.ant.buildableSubset, is required (see Team Build Properties for more information). When this property is set to true, any value specified for the build subset property is ignored.

team.enterprise.build.ant.buildFile

Build file:* The path to the Ant with Enterprise Extensions build file on the build machine. This can be an absolute path on the build machine or may be a path relative to the current directory of the build engine process.

Note: It is advised to avoid using blanks or $ in the path as these characters (or their national language equivalents) can cause inconsistent results.

The load directory can be referenced using the built-in build property ${team.enterprise.scm.fetchDestination}.

For example: ${team.enterprise.scm.fetchDestination}/buildProject/build.xml

team.enterprise.build.ant.buildOrder

Build order: Configure the order in which items will be built. Specify a list of language names, in the order in which they should be built, with each name separated by a comma.

team.enterprise.build.ant.conditionalBuild

true

false

Conditional build: Terminate the build if an error occurs. If true is specified, the build terminates immediately upon encountering the first error. If false is specified and an error is encountered, the build completes all language processing and then terminates.

team.enterprise.build.ant.generateReports

true

false

Generate a build file: Specify true when the team.enterprise.build.ant.useGeneratedBuildFile attribute is set to true.

team.enterprise.build.ant.javaHome

Java home: If none is specified, it will default to the Java instance running the build engine.

team.enterprise.build.ant.javaVMArgs

Java VM arguments: These arguments will be passed to the VM used to invoke Ant.

team.enterprise.build.ant.propertiesFile

Properties file: This is an output file that will contain all build definition, build engine, and built-in properties used in the build.

team.enterprise.build.ant.targets

Build targets: The targets in the build file to execute. Multiple targets must be separated by commas. If none are specified, the build file's default target is executed.

team.enterprise.build.ant.useGeneratedBuildFile

true

false

Use an existing build file: Specify false to specify a custom build file and the targets to be invoked. When this property is set to false, a build file property, team.enterprise.build.ant.buildFile, is required.

team.enterprise.build.ant.workingDir

Working directory: The working directory to be used by the invoked Ant process. By default, the current directory of the build engine process is used.

team.enterprise.build.excludedComponents

Select components to be excluded from build: Specify a list of component names that are to be excluded from the build with each name separated by a comma.

team.enterprise.build.ui.requestOptionVisibility

Property visibility: Select which properties are available when requesting a build. Specify a single continuous string with the list of property values separated by commas. Specify =t to make a property available to a team build. Specify =p to make a property available to a personal build. Specify =tp to make a property available to both build types. Specify = to make a property unavailable to both build types.

For example:


verifyBuildOutputs=t,conditionalBuild=,antArgs=,
customBuildFile=,customBuildTargets=,trustOutputs=,
prebuildScript=,postbuildScript=,alwaysRunPostbuild=,
changedItemsOnly=tp,impactsInRepo=,impactsNotRepo=,
impactsAlwaysBuild=,mandatorySubset=,deleteDirectory=,
fullMinLoad=p,previewBuild=t,simulationBuild=t

The following is a list of property values:

Property Value	Description
verifyBuildOutputs	Verify build outputs during a simulation build
conditionalBuild	Conditional build
antArgs	Ant arguments
customBuildFile	Build file
customBuildTargets	Build targets
trustOutputs	Trust build outputs
prebuildScript	Run pre-build script
postbuildScript	Run post-build script
alwaysRunPostbuild	Always run post-build script
changedItemsOnly	Build changed items only
impactsInRepo	Calculate impacted dependencies stored in the repository
impactsNotRepo	Calculate impacted dependencies not in the repository
impactsAlwaysBuild	Calculate impacts of files being forced to be built
mandatorySubset	Mandatory subset
deleteDirectory	Delete directory before loading
fullMinLoad	Perform full minimum load
previewBuild	Preview build
simulationBuild	Simulation build

Note:

The following is a list of reserved properties names which can not be specified:

team.enterprise.build.buildmaps.needMigrateComponent

hdsnBuildProperty Element

Code hdsnBuildProperty elements to specify the Hudson/Jenkins job to run. The hdsnBuildProperty element accepts two attributes, name and value, which are both required. The following table describes the valid values for the hdsnBuildProperty element attributes:

name	value	Description
com.ibm.rational.connector.hudson.job		Specify the Hudson/Jenkins job to run. Saving the build definition will add the buildResultUUID parameter to the Hudson/Jenkins job if it is not already present.

icmdBuildProperty Element

Code icmdBuildProperty elements to configure the required environment for the specified build command(s) and to specify the command to launch the build. Optionally, pre-build and post-build commands can be specified. The icmdBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the icmdBuildProperty element attributes:

name	value	Description
com.ibm.teami.build.qcmd.buildAllMembers	true false	Run the build command for all artifacts in the workspace: When this option is selected, the substitution variables &A, &F, &L, &N, &T, and &S are supported in the build command. Only one of the two build options, buildAllMembers and buildEachChangedMember, may be set to `true`, not both.
com.ibm.teami.build.qcmd.buildEachChangedMember	true false	Run the build command for every changed artifact: When this option is selected, the substitution variables &A, &F, &L, &N, &T, and &S are supported in the build command. Only one of the two build options, buildAllMembers and buildEachChangedMember, may be set to `true`, not both.
com.ibm.teami.build.qcmd.command		Build command: The command to be invoked. If neither of the buildAllMembers or buildEachChangedMember build options is selected, the command will be invoked once.
com.ibm.teami.build.qcmd.currentlibrary		Current library: The library to be set as current when connecting to IBM i.
com.ibm.teami.build.qcmd.librarylist		Library list: The library names to be added to the user portion of the library list. Specify a list of library names with each name separated by a comma.
com.ibm.teami.build.qcmd.postbuild		Post-build command: The command to be invoked after the build command.
com.ibm.teami.build.qcmd.prebuild		Pre-build command: The command to be invoked prior to the build command.

idpnBuildProperty Element

Code idpnBuildProperty elements to specify configuration details, the build file to use, and the build targets to be invoked for an IBM i Dependency build. The idpnBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the idpnBuildProperty element attributes:

name value Description

team.enterprise.build.ant.antArgs

Ant arguments: These arguments will be passed to the invocation of Ant.

team.enterprise.build.ant.antHome

Ant home: By default, the Ant within the Jazz build engine will be used. This may be an absolute path on the build machine or a path relative to the current directory of the build engine process.

team.enterprise.build.ant.buildAllItems

true

false

Build workspace: Build all items in the workspace. When this property is set to false, a build subset property, team.enterprise.build.ant.buildableSubset, is required (see Team Build Properties for more information). When this property is set to true, any value specified for the build subset property is ignored.

team.enterprise.build.ant.buildFile

Note: It is advised to avoid using blanks or $ in the path as these characters (or their national language equivalents) can cause inconsistent results.

The load directory can be referenced using the built-in build property ${team.enterprise.scm.fetchDestination}.

For example: ${team.enterprise.scm.fetchDestination}/buildProject/build.xml

team.enterprise.build.ant.buildOrder

Build order: Configure the order in which items will be built. Specify a list of language names, in the order in which they should be built, with each name separated by a comma.

team.enterprise.build.ant.conditionalBuild

true

false

team.enterprise.build.ant.generateReports

true

false

Generate a build file: Specify true when the team.enterprise.build.ant.useGeneratedBuildFile attribute is set to true.

team.enterprise.build.ant.javaHome

Java home: If none is specified, it will default to the Java instance running the build engine.

team.enterprise.build.ant.javaVMArgs

Java VM arguments: These arguments will be passed to the VM used to invoke Ant.

team.enterprise.build.ant.propertiesFile

Properties file: This is an output file that contains all build definition, build engine, and built-in properties used by the build.

team.enterprise.build.ant.targets

Build targets: The targets in the build file to execute. Multiple targets must be separated by commas. If none are specified, the build file's default target is executed.

team.enterprise.build.ant.useGeneratedBuildFile

true

false

Generate a build file: Specify true to generate a build file automatically from available language definitions. When this property is set to true, a build order property, team.enterprise.build.ant.buildOrder, is required.

Generate a build file: Specify true to generate a build file automatically from available language definitions. When this property is set to true, a build order property, team.enterprise.build.ant.buildOrder, is required. Use an existing build file: Specify false to specify a custom build file and the targets to be invoked. When this property is set to false, a build file property, team.enterprise.build.ant.buildFile, is required.

team.enterprise.build.ant.workingDir

Working directory: The working directory to be used by the invoked Ant process. By default, the current directory of the build engine process is used.

team.enterprise.build.excludedComponents

Select components to be excluded from build: Specify a list of component names that are to be excluded from the build with each name separated by a comma.

team.enterprise.build.ui.requestOptionVisibility

For example:


verifyBuildOutputs=t,conditionalBuild=,antArgs=,
customBuildFile=,customBuildTargets=,trustOutputs=,
prebuildScript=,postbuildScript=,alwaysRunPostbuild=,
changedItemsOnly=tp,impactsInRepo=,impactsNotRepo=,
impactsAlwaysBuild=,mandatorySubset=,deleteDirectory=,
fullMinLoad=p,previewBuild=t,simulationBuild=t

The following is a list of property values:

Property Value	Description
verifyBuildOutputs	Verify build outputs during a simulation build
conditionalBuild	Conditional build
antArgs	Ant arguments
customBuildFile	Build file
customBuildTargets	Build targets
trustOutputs	Trust build outputs
prebuildScript	Run pre-build script
postbuildScript	Run post-build script
alwaysRunPostbuild	Always run post-build script
changedItemsOnly	Build changed items only
impactsInRepo	Calculate impacted dependencies stored in the repository
impactsNotRepo	Calculate impacted dependencies not in the repository
impactsAlwaysBuild	Calculate impacts of files being forced to be built
mandatorySubset	Mandatory subset
deleteDirectory	Delete directory before loading
fullMinLoad	Perform full minimum load
previewBuild	Preview build
simulationBuild	Simulation build

Note:

The following is a list of reserved properties names which can not be specified unless overridden:
- team.enterprise.build.buildmaps.needMigrateComponent
The following is a list of reserved properties names which can not be specified:
- team.enterprise.build.ant.createBuildMaps

iprmBuildProperty Element

Code iprmBuildProperty elements to specify configuration details, the build file to use, the build targets to be invoked, and the enterprise promotion configuration properties for an IBM i Promotion build. The iprmBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the iprmBuildProperty element attributes:

name	value	Description
team.enterprise.promotion.ant.antArgs		Ant arguments: These arguments will be passed to the invocation of Ant.
team.enterprise.promotion.ant.antHome		Ant home: By default, the Ant within the Jazz build engine will be used. This may be an absolute path on the build machine or a path relative to the current directory of the build engine process.
team.enterprise.promotion.ant.buildFile		Build file:* The path to the Ant with Enterprise Extensions build file on the build machine. This can be an absolute path on the build machine or may be a path relative to the current directory of the build engine process.
team.enterprise.promotion.ant.buildTarget		Build targets: The targets in the build file to execute. Multiple targets must be separated by commas. If none are specified, the build file's default target is executed.
team.enterprise.promotion.ant.javaHome		Java home: If none is specified, it will default to the Java instance running the build engine.
team.enterprise.promotion.ant.javaVMArgs		Java VM arguments: These arguments will be passed to the VM used to invoke Ant.
team.enterprise.promotion.ant.propertiesFile		Properties file: This is an output file that will contain all build definition, build engine, and built-in properties used in the build.
team.enterprise.promotion.ant.workingDir		Working directory: The working directory to be used by the invoked Ant process. By default, the current directory of the build engine process is used.
team.enterprise.promotion.componentList		Component list: Select components from the source build definition workspace to promote. Specify a list of component names with each name separated by a comma.
team.enterprise.promotion.destinationPath		Destination directory:* The destination directory is the location on the build system where intermediate build files will be placed.
team.enterprise.promotion.sourceDefinition		Source build definition:* A source build definition must be specified.
team.enterprise.promotion.targetDefinition		Target build definition:* A target build definition must be specified.
com.ibm.team.enterprise.promotion.createSnapshot	true false	Create a snapshot of the target stream before promoting source: Specify `true` to create a snapshot of the target stream before promoting source.
com.ibm.team.enterprise.promotion.type.both	true false	Enable both component promotion and work item promotion: Specify `true` to enable both types of promotion. If `true` is specified, both com.ibm.team.enterprise.promotion.type.comp and com.ibm.team.enterprise.promotion.type.wi must be `false`.
com.ibm.team.enterprise.promotion.type.comp	true false	Enable only component promotion: Specify `true` to enable only component promotion. If `true` is specified, both com.ibm.team.enterprise.promotion.type.both and com.ibm.team.enterprise.promotion.type.wi must be `false`.
com.ibm.team.enterprise.promotion.type.wi	true false	Enable only work item promotion: Specify `true` to enable only work item promotion. If `true` is specified, both com.ibm.team.enterprise.promotion.type.both and com.ibm.team.enterprise.promotion.type.comp must be `false`.
com.ibm.team.enterprise.promotion.workitem.decide.in.promotion	true false	Specify options during work item promotion: Specify `true` to specify promotion of source and outputs or source only during promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.sourceonly to define the state of Specify options during work item promotion to promote source only or promote source and outputs.
com.ibm.team.enterprise.promotion.workitem.sourceonly	true false	Promote source only: Specify `true` to promote source only. Promote source and outputs: Specify `false` to promote source and outputs.
com.ibm.team.enterprise.promotion.workitem.decide.include.children	true false	Include children of selected work items: Specify `true` to specify during work item promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.include.children to define the state of Include children of selected work items to always enabled or always disabled.
com.ibm.team.enterprise.promotion.workitem.include.children	true false	Include children of selected work items: Specify `true` to enable. Note: The property com.ibm.team.enterprise.promotion.workitem.decide.include.children must be `false` for this property to be in effect.
com.ibm.team.enterprise.promotion.workitem.decide.include.impacted	true false	Include impacted outputs: Specify `true` to specify during work item promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.include.impacted to define the state of Include impacted outputs to always enabled or always disabled.
com.ibm.team.enterprise.promotion.workitem.include.impacted	true false	Include impacted outputs: Specify `true` to enable. Note: The property com.ibm.team.enterprise.promotion.workitem.decide.include.impacted must be `false` for this property to be in effect.
com.ibm.team.enterprise.promotion.workitem.decide.ignore.changes	true false	Consider ignored changes: Specify `true` to specify during work item promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.ignore.changes to define the state of Consider ignored changes to always enabled or always disabled.
com.ibm.team.enterprise.promotion.workitem.ignore.changes	true false	Consider ignored changes: Specify `true` to enable. Note: The property com.ibm.team.enterprise.promotion.workitem.decide.ignore.changes must be `false` for this property to be in effect.
com.ibm.team.enterprise.promotion.workitem.decide.ignore.validation.error.for.impacted.files	true false	Consider ignored validation error for impacted files: Specify `true` to specify during work item promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.ignore.validation.error.for.impacted.files to define the state of Consider ignored validation error for impacted files to always enabled or always disabled.
com.ibm.team.enterprise.promotion.workitem.ignore.validation.error.for.impacted.files	true false	Consider ignored validation error for impacted files: Specify `true` to enable. Note: The property com.ibm.team.enterprise.promotion.workitem.decide.ignore.validation.error.for.impacted.files must be `false` for this property to be in effect.
team.promotion.ibmi.pfRestoreMethod	REPLACE MIGRATE USRCMD	Rules for promoting physical files: Specify how to handle physical file (FILE:PF-DTA) objects during promotion. REPLACE* - Overwrite physical file objects with source objects. MIGRATE - Keep existing data in physical files. USRCMD - Keep existing data in physical files using command specified by pfRestoreCommand.
team.promotion.ibmi.pfRestoreCommand		USRCMD: Keep existing data in physical files using this command.

Note:

The following is a list of reserved properties names which can not be specified:

team.enterprise.promotion.sourceBuildResult

jdtBuildProperty Element

Code a jdtBuildProperty element to specify the location of an ECJ (Eclipse compiler for Java) log file, or directory of log files. The jdtBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the jdtBuildProperty element attributes:

name	value	Description
com.ibm.team.build.jdt.publishing.log		Log or directory: This can be an absolute path on the build machine or may be a path relative to the current directory of the build engine process.

jntBuildProperty Element

Code a jntBuildProperty element to specify the location of a JUnit XML log file, or directory of log files. JUnit XML log files can be created by specifying a formatter type of XML when invoking JUnit. The jntBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the jntBuildProperty element attributes:

name	value	Description
com.ibm.team.build.junit.publishing.log		Log or directory: This can be an absolute path on the build machine or may be a path relative to the current directory of the build engine process.

msbBuildProperty Element

Code msbBuildProperty elements to specify the configuration for a Microsoft Visual Studio Solution build. The msbBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the msbBuildProperty element attributes:

name	value	Description
com.ibm.team.build.msbuild.buildCmd	Devenv MSbuild	Build Command: The build command to run (devenv or msbuild). Devenv - devenv.exe MSbuild - msbuild.exe
com.ibm.team.build.msbuild.buildCmdPath		Path to build command: Optional location of the build command (provide the location if the build command is not on the path).
com.ibm.team.build.msbuild.buildItem	Not allowed	Placeholder to allow for the specification of msbBuildItem elements.
com.ibm.team.build.msbuild.continueBuild	true false	Continue build: Proceed building remaining items on build failure.
com.ibm.team.build.msbuild.propertiesFile		Properties file: This is an output file that will contain all build definition, build engine, and built-in properties used in the build.

msbBuildItem Element

One or more msbBuildItem elements can be specified within an msbBuildProperty element to define a list of solution or project files to build. To define msbBuildItem elements, code an msbBuildProperty element with the name attribute set to com.ibm.team.build.msbuild.buildItem and include the msbBuildItem elements within. For example:


<xt:msbBuildProperty name="com.ibm.team.build.msbuild.buildItem">
    <xt:msbBuildItem .../>
</xt:msbBuildProperty>

The items will be built in the order given. At least one msbBuildItem element is required. The following table describes the valid values for the msbBuildProperty element attributes:

Attribute	value	Description
arguments		Additional arguments: Specify additional arguments to the build command.
configuration		Build Configuration: Configuration to build. A configuration is required.
directory		Working directory: The working directory to be used by the invoked process. By default, the current directory of the build engine process is used.
log		Build Log: Specify the file to store the build log.
solution		Solution/Project file name: Name of the solution or project file to build. A solution is required.
type	Build ReBuild	Build Type: Type of the build to run (example: Build, ReBuild).

msbBuildText Element

The msbBuildText element can be specified within an msbBuildProperty element to define the value of a property in nested text format. For example:


<xt:msbBuildProperty name="com.ibm.team.build.msbuild.buildCmd">
    <xt:msbBuildText>Devenv</xt:msbBuildText>
  </xt:msbBuildProperty>

Note:

The following is a list of reserved properties names which can not be specified unless overridden:

com.ibm.team.build.msbuild.additionalArg
com.ibm.team.build.msbuild.buildOutput
com.ibm.team.build.msbuild.buildType
com.ibm.team.build.msbuild.buildConfiguration
com.ibm.team.build.msbuild.solutionFile
com.ibm.team.build.msbuild.workingDir

mstBuildProperty Element

Code mstBuildProperty elements to specify the configuration for MSTest unit tests. Unit tests will be run after a successful compilation. The mstBuildProperty element accepts two attributes, name and value, which are both required. The following table describes the valid values for the mstBuildProperty element attributes:

name	value	Description
com.ibm.team.build.mstest.additionalArg		Additional arguments: Specify additional arguments to the MSTest command.
com.ibm.team.build.mstest.mstestFile		MSTest specification file (vsmdi)*: Specify the MSTest specification file (vsdmi) file to use.
com.ibm.team.build.mstest.msTestPath		Path:* The path to MSTest.exe program.
com.ibm.team.build.mstest.mstestResultFile		MSTest results file: Specify the MSTest result file (*.trx) to generate.
com.ibm.team.build.mstest.workingDir		Working directory: The working directory to be used by the invoked MSTest process. By default, the current directory of the build engine process is used.

mvnBuildProperty Element

Code mvnBuildProperty elements to specify the path to the Maven project and the goals to build. The mvnBuildProperty element accepts two attributes, name and value, which are both required. The following table describes the valid values for the mvnBuildProperty element attributes:

name	value	Description
com.ibm.team.build.maven.javaHome		Java home: If none is specified, it will default to the Java instance running the build engine.
com.ibm.team.build.maven.javaVMArgs		Java VM arguments: These arguments will be passed to the VM used to invoke Maven.
com.ibm.team.build.maven.mavenGoals		Goals:* Specify goals, phases, and arguments. For example: install. These will be passed to the invocation of Maven.
com.ibm.team.build.maven.mavenHome		Maven home:* This may be an absolute path on the build machine or a path relative to the current directory of the build engine process.
com.ibm.team.build.maven.projectLocation		Project location:* This can be an absolute path on the build machine or a path relative to the current directory of the build engine process.
com.ibm.team.build.maven.propertiesFile		Properties file: This can be an absolute path on the build machine or a path relative to the current directory of the build engine process.

nutBuildProperty Element

Code nutBuildProperty elements to specify the configuration for NUnit unit tests. Unit tests will be run after a successful compilation. The nutBuildProperty element accepts two attributes, name and value, which are both required. The following table describes the valid values for the nutBuildProperty element attributes:

name	value	Description
com.ibm.team.build.nunit.additionalArg		Additional arguments: Specify additional arguments to the NUnit command.
com.ibm.team.build.nunit.nunitFile		NUnit test configuration file*: Specify the NUnit test configuration file to use.
com.ibm.team.build.nunit.nUnitPath		Path:* The path to NUnit.exe program.
com.ibm.team.build.nunit.nunitResultFile		NUnit results file: Specify the NUnit result file (*.xml) to generate.
com.ibm.team.build.nunit.workingDir		Working directory: The working directory to be used by the invoked NUnit process. By default, the current directory of the build engine process is used.

prmtBuildProperty Element

Code prmtBuildProperty elements to specify configuration details, the build file to use, the build targets to be invoked, and the enterprise promotion configuration properties for an z/OS Promotion build. The prmtBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the prmtBuildProperty element attributes:

name	value	Description
teamz.build.ant.antArgs		Ant arguments: These arguments will be passed to the invocation of Ant.
teamz.build.ant.antHome		Ant home: By default, the Ant within the Jazz build engine will be used. This may be an absolute path on the build machine or a path relative to the current directory of the build engine process.
teamz.build.ant.buildFile		Build file:* The path to the Ant with Enterprise Extensions build file on the build machine. This can be an absolute path on the build machine or may be a path relative to the current directory of the build engine process.
teamz.build.ant.buildTarget		Build targets: The targets in the build file to execute. Multiple targets must be separated by commas. If none are specified, the build file's default target is executed.
teamz.build.ant.javaHome		Java home: If none is specified, it will default to the Java instance running the build engine.
teamz.build.ant.javaVMArgs		Java VM arguments: These arguments will be passed to the VM used to invoke Ant.
teamz.build.ant.propertiesFile		Properties file: This is an output file that will contain all build definition, build engine, and built-in properties used in the build.
teamz.build.ant.workingDir		Working directory: The working directory to be used by the invoked Ant process. By default, the current directory of the build engine process is used.
team.enterprise.promotion.componentList		Component list: Select components from the source build definition workspace to promote. Specify a list of component names with each name separated by a comma.
team.enterprise.promotion.destinationPath		Destination directory:* The destination directory is the location on the build system where intermediate build files will be placed.
team.enterprise.promotion.sourceDefinition		Source build definition:* A source build definition must be specified.
team.enterprise.promotion.targetDefinition		Target build definition:* A target build definition must be specified.
com.ibm.team.enterprise.promotion.createSnapshot	true false	Create a snapshot of the target stream before promoting source.
com.ibm.team.enterprise.promotion.type.both	true false	Enable both component promotion and work item promotion: Specify `true` to enable both types of promotion. If `true` is specified, both com.ibm.team.enterprise.promotion.type.comp and com.ibm.team.enterprise.promotion.type.wi must be false.
com.ibm.team.enterprise.promotion.type.comp	true false	Enable only component promotion: Specify `true` to enable only component promotion. If `true` is specified, both com.ibm.team.enterprise.promotion.type.both and com.ibm.team.enterprise.promotion.type.wi must be false.
com.ibm.team.enterprise.promotion.type.wi	true false	Enable only work item promotion: Specify `true` to enable only work item promotion. If `true` is specified, both com.ibm.team.enterprise.promotion.type.both and com.ibm.team.enterprise.promotion.type.comp must be false.
com.ibm.team.enterprise.promotion.workitem.decide.in.promotion	true false	Specify options during work item promotion: Specify `true` to specify promotion of source and outputs or source only during promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.sourceonly to define the state of Specify options during work item promotion to promote source only or promote source and outputs.
com.ibm.team.enterprise.promotion.workitem.sourceonly	true false	Promote source only: Specify `true` to promote source only. Promote source and outputs: Specify `false` to promote source and outputs.
com.ibm.team.enterprise.promotion.workitem.decide.include.children	true false	Include children of selected work items: Specify `true` to specify during work item promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.include.children to define the state of Include children of selected work items to always enabled or always disabled.
com.ibm.team.enterprise.promotion.workitem.include.children	true false	Include children of selected work items: Specify `true` to enable. Note: The property com.ibm.team.enterprise.promotion.workitem.decide.include.children must be `false` for this property to be in effect.
com.ibm.team.enterprise.promotion.workitem.decide.include.impacted	true false	Include impacted outputs: Specify `true` to specify during work item promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.include.impacted to define the state of Include impacted outputs to always enabled or always disabled.
com.ibm.team.enterprise.promotion.workitem.include.impacted	true false	Include impacted outputs: Specify `true` to enable. Note: The property com.ibm.team.enterprise.promotion.workitem.decide.include.impacted must be `false` for this property to be in effect.
com.ibm.team.enterprise.promotion.workitem.decide.ignore.changes	true false	Consider ignored changes: Specify `true` to specify during work item promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.ignore.changes to define the state of Consider ignored changes to always enabled or always disabled.
com.ibm.team.enterprise.promotion.workitem.ignore.changes	true false	Consider ignored changes: Specify `true` to enable. Note: The property com.ibm.team.enterprise.promotion.workitem.decide.ignore.changes must be `false` for this property to be in effect.
com.ibm.team.enterprise.promotion.workitem.decide.ignore.validation.error.for.impacted.files	true false	Consider ignored validation error for impacted files: Specify `true` to specify during work item promotion. Specify `false` to allow the property com.ibm.team.enterprise.promotion.workitem.ignore.validation.error.for.impacted.files to define the state of Consider ignored validation error for impacted files to always enabled or always disabled.
com.ibm.team.enterprise.promotion.workitem.ignore.validation.error.for.impacted.files	true false	Consider ignored validation error for impacted files: Specify `true` to enable. Note: The property com.ibm.team.enterprise.promotion.workitem.decide.ignore.validation.error.for.impacted.files must be `false` for this property to be in effect.

Note:

The following is a list of reserved properties names which can not be specified:

team.enterprise.promotion.sourceBuildResult

rbfBuildProperty Element

Code rbfBuildProperty elements to specify Build Forge configuration properties. The rbfBuildProperty element accepts two attributes, name and value, which are both required. The following table describes the valid values for the rbfBuildProperty element attributes:

name	value	Description
com.ibm.rational.connector.buildforge.logs.all	true false	Include all step logs.
com.ibm.rational.connector.buildforge.logs.all.not.passed.or. skipped	true false	Steps not passed or skipped.
com.ibm.rational.connector.buildforge.bom.custom	true false	Include custom data from BOM.
com.ibm.rational.connector.buildforge.logs.first	integer	Include step logs from first n steps.
com.ibm.rational.connector.buildforge.logs.first.enabled	true false	Enable include step logs from first n steps.
com.ibm.rational.connector.buildforge.logs.last	integer	Include step logs from last n steps.
com.ibm.rational.connector.buildforge.logs.last.enabled	true false	Enable include step logs from last n steps
com.ibm.rational.connector.buildforge.project		Build Forge Project: Specify a Build Forge project name.

Note:

The following is a list of reserved properties names which can not be specified:

com.ibm.rational.connector.buildforge.project.uuid

ucdpBuildProperty Element

Code ucdpBuildProperty elements to specify the Post-build Deploy configuration. The ucdpBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the ucdpBuildProperty element attributes:

name	value	Description
team.udeploy.abortOnIncompleteActivityEnabled	true false	Incomplete activities: Abort post-build deploy if there are incomplete build activities.
team.udeploy.application		Application:* The application to deploy.
team.udeploy.baseDirectory		Base directory: The base directory to publish files from. The default is . which is the build engine's current directory. Build properties can be used. For example: ${team.scm.fetchDestination}, if Jazz Source Control option is selected.
team.udeploy.component		Component:* The component which will receive the new version.
team.udeploy.deployEnabled	true false	Enable: Run application process.
team.udeploy.enabled	true false	Enable: Enable post-build deploy.
team.udeploy.environment		Environment:* The environment to deploy into.
team.udeploy.excludeFiles		Exclude files: A new line separated list of file filters to exclude from publishing. The default is blank which excludes nothing. Use nested text notation to specify new line separated items.
team.udeploy.includeFiles		Include files: A new line separated list of file filters to select the files to publish. The default is blank which includes nothing, whereas */ includes everything. Use nested text notation to specify new line separated items.
team.udeploy.links		Links: A new line separated list of links. Each link should be of the form name=URI. Build properties can be used. For example: Build Result = ${repositoryAddress}resource/itemOid/com.ibm.team.build.BuildResult/ ${buildResultUUID}. Support introduced in UrbanCode Deploy 6.0. Use nested text notation to specify new line separated items.
team.udeploy.password		Password:* The password for the user name. The password is not secure. It is saved and sent to the server in plain text.
team.udeploy.passwordFile		Password file:* The file containing the password for the user name. A password file is created with jbe -createPasswordFile.
team.udeploy.passwordType	`PASSWORD` `PASSWORD_FILE`	Password type:* The type of password to use: PASSWORD or PASSWORD_FILE.
team.udeploy.process		Process:* The process to run.
team.udeploy.properties		Properties: A new line separated list of properties. Each property should be of the form name=value. Build properties can be used. For example: snapshotUUID=${team.scm.snapshotUUID}, if Jazz Source Control option is selected. Use nested text notation to specify new line separated items.
team.udeploy.serverURI		Server URI:* The URI where the server is located. (e.g. https://localhost:8443/)
team.udeploy.triggerPolicy	ALWAYS NO_ERRORS NO_WARNINGS	Trigger policy: The trigger policy used to determine when to deploy. ALWAYS Deploy always NO_ERRORS Deploy if build has no errors (warnings allowed) NO_WARNINGS Deploy if build has no errors or warnings
team.udeploy.userName		User name:* The user name to log in with.
team.udeploy.version		Version:* The name of the new version to create. Build properties can be used. For example: ${buildLabel}.

Note:

The following is an example of using the nested text notation to specify new line separated items.


  <ucdpBuildProperty name=team.udeploy.excludeFiles>file.name.01
file.name.02
file.name.03
  </ucdpBuildProperty>

zcmdBuildProperty Element

Code zcmdBuildProperty elements to specify configuration details for the z/OS Command Line build. The zcmdBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the zcmdBuildProperty element attributes:

name	value	Description
com.ibm.rational.buildforge.buildagent.cmdline.command		Command:* The command to be invoked.
com.ibm.rational.buildforge.buildagent.cmdline.timeout	integer	Connection time-out: Connection time-out in seconds.
com.ibm.rational.buildforge.buildagent.cmdline.workingDir		Working directory:* The working directory to be used by the invoked command process.

zpreBuildProperty Element

Code zpreBuildProperty elements to specify configuration details for the z/OS Pre-Build Command. The zpreBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the zpreBuildProperty element attributes:

name	value	Description
com.ibm.rational.buildforge.buildagent.precmdline.command		Command:* The command to be invoked.
com.ibm.rational.buildforge.buildagent.precmdline.timeout	integer	Connection time-out: Connection time-out in seconds.
com.ibm.rational.buildforge.buildagent.precmdline.workingDir		Working directory:* The working directory to be used by the invoked command process.

zpstBuildProperty Element

Code zpstBuildProperty elements to specify configuration details for the z/OS Post-Build Command. The zpstBuildProperty element accepts two attributes, name and value, which are both required. Other build properties can be referenced when specifying a value using the ${propertyName} format. The following table describes the valid values for the zcmdBuildProperty element attributes:

name	value	Description
com.ibm.rational.buildforge.buildagent.postcmdline.command		Command:* The command to be invoked.
com.ibm.rational.buildforge.buildagent.postcmdline.timeout	integer	Connection time-out: Connection time-out in seconds.
com.ibm.rational.buildforge.buildagent.postcmdline.workingDir		Working directory:* The working directory to be used by the invoked command process.