Build Definition Reference

This section identifies the supported build types and their characteristics. The name, description, template ID, template aliases, and required build engine type are listed for each of the supported build types.

Table of Contents

This section also describes the configuration elements and team build properties that are supported by each of the build types. Every build supports a predetermined set of configuration elements, the properties associated with those configuration elements, and team build properties. When creating a build, you must ensure to include only those configuration element properties and team build properties that are supported by the build.

When a build is created, all required configuration elements and team build properties are added to the build definition. The value for any configuration element property or team build property that you include will be used when the elements and properties are processed. Any configuration element property or team build property that you do not include will be set to its default value. The required configuration elements for each build type are identified in the ‘Configuration elements’ entry for the build type with an asterisk (*).

If you include a configuration element property for an optional configuration element, the optional configuration element will be added to the build and the specified property will be set to the specified value within that configuration element. Any other properties that are required by the optional configuration element which are not included will be defined using their default values. If you delete all configuration element properties for an optional configuration element, the element will be deleted from the build definition.

The following sections identify each of the supported build types and their details.

Ant Build

Name: Ant - Jazz Build Engine
Description: A build using Ant and the Jazz Build Engine.
Template ID: com.ibm.team.build.ant
Template aliases: ant
Ant
Ant - Jazz Build Engine
Build engine type: JBE
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Ant Build Properties*
antBuildProperty Element
ECJ Publishing Properties
jdtBuildProperty Element
JUnit Publishing Properties
jntBuildProperty Element
Build Forge Properties
rbfBuildProperty Element
Post-build Deploy Properties
ucdpBuildProperty Element
Post-build Delivery Properties
deliverProperty Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an Ant Build
teamBuildProperty Element - UrbanCode Deploy

Ant Enterprise Extensions Build

Name: Ant with Enterprise Extensions - Rational Build Agent
Description: A build on System z using Ant with Enterprise Extensions and the Rational Build Agent.
Template ID: com.ibm.teamz.build.antz
Template aliases: antz
Antz
Ant with Enterprise Extensions
Ant with Enterprise Extensions - Rational Build Agent
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Ant Enterprise Extensions Build Properties*
antzBuildProperty Element
z/OS Pre-Build Command Properties
zpreBuildProperty Element
z/OS Post-Build Command Properties
zpstBuildProperty Element
Team build properties:
teamBuildProperty Element - Ant Enterprise Extensions Build
teamBuildProperty Element - Ant Enterprise Extensions Publishing
teamBuildProperty Element - Jazz Source Control for an Ant Enterprise Extensions Build

Command Line Build

Name: Command Line - Jazz Build Engine
Description: A build that invokes a command line using the Jazz Build Engine.
Template ID: com.ibm.team.build.cmdline
Template aliases: cmd
Cmd
cmdline
Cmdline
Command Line
Command Line - Jazz Build Engine
Build engine type: JBE
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Command Line Build Properties*
cmdBuildProperty Element
ECJ Publishing Properties
jdtBuildProperty Element
JUnit Publishing Properties
jntBuildProperty Element
Build Forge Properties
rbfBuildProperty Element
Post-build Deploy Properties
ucdpBuildProperty Element
Post-build Delivery Properties
deliverProperty Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an Ant Build
teamBuildProperty Element - UrbanCode Deploy

z/OS Deployment Build

Name: z/OS Deployment Build
Description: Configuration for deploying z/OS applications using the Rational Build Agent.
Template ID: com.ibm.team.enterprise.deployment.nonseq.zos
Template aliases: dply
Dply
Deployment
z/OS Deployment
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Ant Build Properties*
antBuildProperty Element
Team build properties:
teamBuildProperty Element - z/OS Deployment Build

z/OS Dependency Build

Name: z/OS Dependency Build - Rational Build Agent
Description: A build on System z using Ant with Enterprise Extensions that determines what to build based on changes since the last successful team build.
Template ID: com.ibm.team.enterprise.zos.build.dependency.template
Template aliases: dpnd
Dpnd
dependency
Dependency
z/OS Dependency Build
z/OS Dependency Build - Rational Build Agent
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
z/OS Dependency Build Properties*
dpndBuildProperty Element
Enterprise Interactive Gateway
gwayBuildProperty Element
z/OS Pre-Build Command Properties
zpreBuildProperty Element
z/OS Post-Build Command Properties
zpstBuildProperty Element
Team build properties:
teamBuildProperty Element - z/OS Dependency Build
teamBuildProperty Element - Enterprise Interactive Gateway
teamBuildProperty Element - Enterprise Extensions Publishing
teamBuildProperty Element - Jazz Source Control for a Dependency Build

Rational Build Forge Build

Name: Rational Build Forge
Description: A build using Rational Build Forge.
Template ID: com.ibm.rational.connector.buildforge.ui.buildDefinitionTemplate
Template aliases: frg
Frg
buildforge
Buildforge
Build Forge
Rational Build Forge
Build engine type: RBF
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Build Forge Properties*
rbfBuildProperty Element
Post-build Deploy Properties
ucdpBuildProperty Element
Post-build Delivery Properties
deliverProperty Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an Ant Build
teamBuildProperty Element - UrbanCode Deploy

Generic Build

Name: Generic
Description: A generic build.
Template ID: com.ibm.team.build.generic
Template aliases: gen
Gen
generic
Generic
Build engine type: JBE
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Build Forge Properties
rbfBuildProperty Element
Team build properties: None

Hudson/Jenkins Build

Name: Hudson/Jenkins Build
Description: Creates a build definition for a Hudson/Jenkins server.
Template ID: com.ibm.rational.connector.hudson.ui.buildDefinitionTemplate
Template aliases: hdsn
Hdsn
hudson
Hudson
Hudson/Jenkins
Hudson/Jenkins Build
Build engine type: HUDSON
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Hudson/Jenkins Build Properties*
hdsnBuildProperty Element
Post-build Delivery Properties
deliverProperty Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an Ant Build

IBMi Command Line Build

Name: IBMi Command - Jazz Build Engine
Description: An IBMi build that submits a command using the Jazz Build Engine.
Template ID: com.ibm.teami.build.qcmd
Template aliases: icmd
Icmd
icommand
iCommand
IBMi Command
IBMi Command - Jazz Build
Build engine type: JBE
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
IBMi Command Line Build Properties*
icmdBuildProperty Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an IBMi Command Line Build

IBMi Continuous Load Build

Name: IBMi Continuous Load - Jazz Build Engine
Description: An IBMi build used to load i artifacts from a Jazz repository workspace to IBMi libraries on a defined schedule.
Template ID: com.ibm.teami.build.autoload
Template aliases: icnl
Icnl
icontinuous
iContinuous
IBMi Continuous Load
IBMi Continuous Load - Jazz Build Engine
Build engine type: JBE
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
Build Property Copy
buildPropertyCopy Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an IBMi Continuous Load Build

IBMi Deployment Build

Name: IBMi Deployment Build
Description: Configuration for deploying IBMi applications using the Rational Build Agent.
Template ID: com.ibm.team.enterprise.deployment.nonseq.ibmi
Template aliases: idpl
Idpl
iDeployment
IBMi Deployment
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Ant Build Properties*
antBuildProperty Element
Team build properties:
teamBuildProperty Element - IBMi Deployment Build

IBMi Dependency Build

Name: IBMi Dependency Build - Rational Build Agent
Description: A build on IBMi using Ant with Enterprise Extensions that determines what to build based on changes since the last successful team build.
Template ID: com.ibm.team.enterprise.ibmi.build.dependency.template
Template aliases: idpn
Idpn
idependency
iDependency
IBMi Dependency Build
IBMi Dependency Build - Rational Build Agent
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
IBMi Dependency Build Properties*
idpnBuildProperty Element
Team build properties:
teamBuildProperty Element - IBMi Dependency Build
teamBuildProperty Element - Jazz Source Control for a Dependency Build

IBMi Packaging Build

Name: IBMi Packaging Build
Description: Configuration for packaging IBMi applications using the Rational Build Agent.
Template ID: com.ibm.team.enterprise.packaging.nonseq.ibmi
Template aliases: ipkg
Ipkg
iPackage
iPackaging
IBMi Package
IBMi Packaging
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Ant Build Properties*
antBuildProperty Element
Team build properties:
teamBuildProperty Element - IBMi Packaging Build

IBMi Promotion Build

Name: IBMi Promotion Build
Description: A build enabling promotion of components from a source stream to a target stream.
Template ID: com.ibm.team.enterprise.promotion.ibmi
Template aliases: iprm
Iprm
iPromotion
IBMi Promotion
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
IBMi Promotion Build Properties*
iprmBuildProperty Element
Team build properties:
teamBuildProperty Element - IBMi Promotion Build

Microsoft Visual Studio Solution Build

Name: Jazz Build for Microsoft Visual Studio Solution - Jazz Build Engine
Description: A build configuration using Microsoft Build System and the Jazz Build Engine.
Template ID: com.ibm.team.build.msbuild
Template aliases: msb
Msb
visual studio
Visual Studio
Microsoft Visual Studio Solution
Microsoft Visual Studio Solution - Jazz Build Engine
Build engine type: JBE
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Microsoft Build Items*
msbBuildProperty Element
MS Visual Studio MSTest Properties
mstBuildProperty Element
MS Visual Studio NUnit Properties
nutBuildProperty Element
Build Forge Properties
rbfBuildProperty Element
Post-build Deploy Properties
ucdpBuildProperty Element
Post-build Delivery Properties
deliverProperty Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an Ant Build
teamBuildProperty Element - UrbanCode Deploy

Maven Build

Name: Maven - Jazz Build Engine
Description: A build using Maven 2 and the Jazz Build Engine.
Template ID: com.ibm.team.build.maven
Template aliases: mvn
Mvn
maven
Maven
Maven - Jazz Build Engine
Build engine type: JBE
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Maven Build Properties*
mvnBuildProperty Element
ECJ Publishing Properties
jdtBuildProperty Element
JUnit Publishing Properties
jntBuildProperty Element
Build Forge Properties
rbfBuildProperty Element
Post-build Deploy Properties
ucdpBuildProperty Element
Post-build Delivery Properties
deliverProperty Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an Ant Build
teamBuildProperty Element - UrbanCode Deploy

z/OS Packaging Build

Name: z/OS Packaging Build
Description: Configuration for packaging z/OS applications using the Rational Build Agent.
Template ID: com.ibm.team.enterprise.packaging.nonseq.zos
Template aliases: pkg
Pkg
Package
Packaging
z/OS Package
z/OS Packaging
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Ant Build Properties*
antBuildProperty Element
Team build properties:
teamBuildProperty Element - z/OS Packaging Build

z/OS Promotion Build

Name: z/OS Promotion Build
Description: A build that copies dependency build outputs from a source location to a target destination on the build machine.
Template ID: com.ibm.team.enterprise.packaging.nonseq.zos
Template aliases: prmt
Prmt
Promotion
z/OS Promotion
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
z/OS Promotion Build Properties*
prmtBuildProperty Element
z/OS Pre-Build Command Properties
zpreBuildProperty Element
z/OS Post-Build Command Properties
zpstBuildProperty Element
Team build properties:
teamBuildProperty Element - z/OS Promotion Build

Linux/UNIX Deployment Build

Name: Linux/UNIX Deployment Build
Description: Configuration for deploying applications on Linux/UNIX using the Rational Build Agent.
Template ID: com.ibm.team.enterprise.deployment.luw
Template aliases: xdpl
Xdpl
xDeployment
Linux/UNIX Deployment
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Ant Build Properties*
antBuildProperty Element
Team build properties:
teamBuildProperty Element - Unix Deployment Build

Linux/UNIX Packaging Build

Name: Linux/UNIX Packaging Build
Description: Configuration for packaging applications on Linux/UNIX using the Rational Build Agent.
Template ID: com.ibm.team.enterprise.packaging.luw
Template aliases: xpkg
Xpkg
xPackage
xPackaging
Linux/UNIX Package
Linux/UNIX Packaging
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
Ant Build Properties*
antBuildProperty Element
Team build properties:
teamBuildProperty Element - Unix Packaging Build

z/OS Command Line Build

Name: Command Line - Rational Build Agent
Description: A build that invokes a command line using the Rational Build Agent.
Template ID: com.ibm.rational.buildforge.buildagent.ui.buildDefinitionTemplate
Template aliases: zcmd
Zcmd
zCommand Line
Command Line - Rational Build Agent
Build engine type: RBA
Configuration elements:
Build Engine Define
buildEngineDefine Element
Build Engine Delete
buildEngineDelete Element
Build Notification
buildNotification Element
Build Scheduling
buildSchedule Element
Build Properties
buildProperty Element
Build Property Copy
buildPropertyCopy Element
z/OS Command Properties*
zcmdBuildProperty Element
z/OS Pre-Build Command Properties
zpreBuildProperty Element
z/OS Post-Build Command Properties
zpstBuildProperty Element
Team build properties:
teamBuildProperty Element - Jazz Source Control for an Ant Build

Build Engines

The following sections describe how to manage the build engines that support a build definition. Each section describes an element that can be specified within the createBuildDefinition or updateBuildDefinition element. These elements are not required and may not be applicable to the type of definition you are creating. Refer to the Build Reference section to determine which elements are valid for the build you are defining.

buildEngineDefine Element

Code one or more buildEngineDefine elements to specify the build engines that support the build definition. The following table describes the attributes for the buildEngineDefine element:

Build Engine Define
Attribute Required Description
id Yes Specify the ID of a build engine that supports the build. The build engine specified must support the build’s type. For example, a Rational Build Agent engine for a z/OS Dependency build.

buildEngineDelete Element

Code one or more buildEngineDelete elements to specify the build engines that no longer support the build definition. These build engines will be removed from the build definition’s supporting build engine list. No error is generated if the build engine has already been removed from the build definitions supporting build engine list. The following table describes the attributes for the buildEngineDelete element:

Build Engine Delete
Attribute Required Description
id Yes Specify the ID of a build engine that is to be removed from the build definition’s supporting build engine list.

Build Notifications

The following sections describe how to manage the notification process for the build definition. Each section describes an element that can be specified within the createBuildDefinition or updateBuildDefinition element. These elements are not required and may not be applicable to the type of definition you are creating. Refer to the Build Reference section to determine which elements are valid for the build you are defining.

buildNotification Element

Code one or more buildNotification elements to configure the notification process for the build definition. The following table describes the attributes for the buildNotification element:

Build Notification
Attribute Required Description
name Yes Specify the name for this notification item.
enabled Yes Specify true to enable this notification item. Specify false to disable this notification item. Notifications will only be made for enabled items. The default is false.
emailsToNotify No Specify a comma separated list of email addresses that will receive the notification.
usersToNotify No Specify a comma separated list of EWM userids that will receive the notification.
rolesToNotify No Specify a comma separated list of EWM roles that will receive the notification.
includePersonalBuilds No Specify true to enable this notification for personal builds. Specify false to restrict notifications to team builds. The default is false.
notifyOnBuildCompleted No Specify true to send notifications when the build has completed. The default is false.
notifyOnBuildCompletedAlways No Specify true to always send notifications when the build has completed. Specify false to send notifications only when the build completes with errors. The default is false.
notifyOnBuildAbandoned No Specify true to send notifications when the build was abandoned. The default is false.
notifyOnBuildAbandonedAlways No Specify true to always send notifications when the build was abandoned. Specify false to send notifications only when the build was abandoned with errors. The default is false.
notifyUsersWhoDelivered No Specify true to send notifications to users who delivered changes that were included in the build. The default is false.
notifyBuildRequestor No Specify true to send a notification to the user that requested the build. The default is false.

Build Scheduling

The following sections describe how to manage the scheduling for automatic submission of the build definition. Each section describes an element that can be specified within the createBuildDefinition or updateBuildDefinition element. These elements are not required and may not be applicable to the type of definition you are creating. Refer to the Build Reference section to determine which elements are valid for the build you are defining.

buildSchedule Element

Code one or more buildSchedule elements to configure scheduling for the build definition using the Jazz scheduler. The following table describes the attributes for the buildSchedule element:

Build Schedule
Attribute Required Description
hour No Specify the time to submit the build. The hour must be an integer in the range 0-23. Either a time (hour and minute) or an interval is required.
minute No Specify the time to submit the build. The minute must be an integer in the range 0-59. Either a time (hour and minute) or an interval is required.
interval No Specify an integer build submit interval in minutes. The build will be submitted at the end of the interval, continuously throughout the day. Either a time (hour and minute) or an interval is required.
sun No Specify true if the schedule item is enabled on Sunday. The schedule must be enabled at least one day during the week. The default is false.
mon No Specify true if the schedule item is enabled on Monday. The schedule must be enabled at least one day during the week. The default is false.
tue No Specify true if the schedule item is enabled on Tuesday. The schedule must be enabled at least one day during the week. The default is false.
wed No Specify true if the schedule item is enabled on Wednesday. The schedule must be enabled at least one day during the week. The default is false.
thu No Specify true if the schedule item is enabled on Thursday. The schedule must be enabled at least one day during the week. The default is false.
fri No Specify true if the schedule item is enabled on Friday. The schedule must be enabled at least one day during the week. The default is false.
sat No Specify true if the schedule item is enabled on Saturday. The schedule must be enabled at least one day during the week. The default is false.

scheduleProperty Element

One or more scheduleProperty elements can be specified within a buildSchedule element to define build properties associated with the schedule item. For example:

<xt:buildSchedule hour="02" minute="30" mon="true">
  <xt:scheduleProperty
    name="monday"
    value="this is monday"
    description="Property for Monday"
    kind="com.ibm.team.build.property.string"
  />
</xt:buildSchedule>
    

The monday property will be available to the build when the schedule item submits the build. The following table describes the valid values for the scheduleProperty element attributes:

Build Schedule Properties
Attribute Required Description
name Yes Name of the build property. The name can not be another build property or contain white space. A build property can be specified as part of the name, but it must be present and resolvable prior to the invocation of this task.
value Yes Value of the build property. The value for the property may be specified in nested text format. For example:
<xt:scheduleProperty name="name">value</xt:scheduleProperty>
            
asis No 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. Valid values are: true and false. The default is false.
description No Description of the build property.
genericEditAllowed No Specify true to allow this property to be altered during processing. Valid values are: true and false. The default is true.
kind No The type of build property. The default data type is string. Valid values are:
Data type: Value to specify:
Boolean com.ibm.team.build.property.boolean
Build com.ibm.team.build.property.build
Build Result com.ibm.team.build.property.buildresult
Component com.ibm.team.build.property.component
Dataset com.ibm.team.build.property.dataset
File Item com.ibm.team.build.property.fileitem
Integer com.ibm.team.build.property.integer
Language com.ibm.team.build.property.language
Library List com.ibm.team.build.property.librarylist
Search Path com.ibm.team.build.property.searchpath
Stream com.ibm.team.build.property.stream
String com.ibm.team.build.property.string
String List com.ibm.team.build.property.stringlist
String Pair com.ibm.team.build.property.stringpair
String Pair List com.ibm.team.build.property.stringpairlist
Timestamp com.ibm.team.build.property.timestamp
Translator com.ibm.team.build.property.translator
Work Item com.ibm.team.build.property.workitem
Workspace com.ibm.team.build.property.workspace
label No Internal use attribute of type string. Do not specify this attribute. The default is null.
override No Whether or not this property overrides a Team Build property value. Valid values are true and false. The default is false. Code true when specifying a schedule override for a Team Build property.
required No Internal use attribute of type boolean. Do not specify this attribute. The default is false.
scheduleOverride No Whether or not this property is a schedule override. Valid values are true and false. The default is true.
wellKnown No Internal use attribute of type boolean. Do not specify this attribute. The default is false.

teamBuildProperty Element

One or more teamBuildProperty elements can be specified within a buildSchedule element to define Team Build properties associated with the schedule item. For example:

<xt:buildSchedule hour="02" minute="30" mon="true">
  <xt:teamBuildProperty name="team.deploy.common.action" value="loadMain"/>
</xt:buildSchedule>
    

The team.deploy.common.action property will be available to the build when the schedule item submits the build. The following table describes the valid values for teamBuildProperty element attributes:

Team Build Properties
Attribute Required Description
name Yes Name of the build property. Valid names are described in the Team Build Properties section.
value Yes Value of the build property. Valid values and restrictions are described in the Team Build Properties section. 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.
JSON array A JSON formatted collection of string values.
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 No Valid values are: true and false. The default is false. Specifying this attribute will control how the property is resolved.
description No This attribute is ignored.
genericEditAllowed No This attribute is ignored.
kind No This attribute is ignored.
label No This attribute is ignored.
override No This attribute is ignored.
required No This attribute is ignored.
scheduleOverride No This attribute is ignored.
wellKnown No This attribute is ignored.

Build Properties

The following sections describe how to define general build properties used in a build definition. Each section describes an element that can be specified within the createBuildDefinition or updateBuildDefinition element. These elements are not required and may not be applicable to the type of definition you are creating. Refer to the Build Reference section to determine which elements are valid for the build you are defining.

buildProperty Element

Code as many buildProperty elements as are needed to define the custom build properties for the build definition. One buildProperty element is needed for each custom build property. The following table describes the valid values for the buildProperty element attributes:

Build Properties
Attribute Required Description
name Yes Name of the build property. The name can not be another build property or contain white space. A build property can be specified as part of the name, but it must be present and resolvable prior to the invocation of this task.
value Yes Value of the build property. The value for the property may be specified in nested text format. For example:
<xt:buildProperty name="name">value</xt:buildProperty>
            
asis No 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. Valid values are: true and false. The default is false.
description No Description of the build property.
genericEditAllowed No Specify true to allow this property to be altered during processing. Valid values are: true and false. The default is true.
kind No The type of build property. The default data type is string. Valid values are:
Data type: Value to specify:
Boolean com.ibm.team.build.property.boolean
Build com.ibm.team.build.property.build
Build Result com.ibm.team.build.property.buildresult
Component com.ibm.team.build.property.component
Dataset com.ibm.team.build.property.dataset
File Item com.ibm.team.build.property.fileitem
Integer com.ibm.team.build.property.integer
Language com.ibm.team.build.property.language
Library List com.ibm.team.build.property.librarylist
Search Path com.ibm.team.build.property.searchpath
Stream com.ibm.team.build.property.stream
String com.ibm.team.build.property.string
String List com.ibm.team.build.property.stringlist
String Pair com.ibm.team.build.property.stringpair
String Pair List com.ibm.team.build.property.stringpairlist
Timestamp com.ibm.team.build.property.timestamp
Translator com.ibm.team.build.property.translator
Work Item com.ibm.team.build.property.workitem
Workspace com.ibm.team.build.property.workspace
label No Internal use attribute of type string. Do not specify this attribute. The default is null.
override No Whether or not this property overrides a Team Build property value. Valid values are true and false. The default is false. Code true when specifying a schedule override for a Team Build property.
required No Internal use attribute of type boolean. Do not specify this attribute. The default is false.
scheduleOverride No Whether or not this property is a schedule override. Valid values are true and false. The default is false.
wellKnown No Internal use attribute of type boolean. Do not specify this attribute. The default is false.

buildPropertyCopy Element

Code buildPropertyCopy elements to identify which properties are to be copied during a updateBuildDefinition task. When the updateBuildDefinition task propertyCopy attribute is set to true each property identified will have its value copied into the specified Ant property prior to any updates. The buildPropertyCopy facility can be used to save, update, and then restore build property values during a build.The following table describes the valid values for the buildPropertyCopy element attributes:

Build Property Copy Element
Attribute Required Description
copy Yes Name of the build property to copy. Any valid build property can be copied: Configuration Properties, Post-build Deliver Properties, Team Build Properties, and Build Properties.
name Yes Name of the Ant property to create with the copied value.

Configuration Properties

The following sections describe how to define the various configuration properties in a build definition. Each section describes a build definition sub-element that can be specified within the createBuildDefinition or updateBuildDefinition element. These sub-elements are used to define information required by a build configuration element. Each build definition sub-element represents a corresponding build configuration element. Not all configuration elements are applicable to a type of build. Refer to the Notes section of each build definition sub-element description to determine which configuration 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.

Configuration Properties
Attribute Required Description
name Yes Name of the configuration property. Valid names are described in each of the following sections.
value Yes Value of the configuration 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.
JSON array A JSON formatted collection of string values.
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 No Valid values are: true and false. The default is false. Specifying this attribute will control how the property is resolved.
description No This attribute is ignored.
genericEditAllowed No This attribute is ignored.
kind No This attribute is ignored.
label No This attribute is ignored.
override No This attribute is ignored.
required No This attribute is ignored.
scheduleOverride No This attribute is ignored.
wellKnown No 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:

Ant Build Properties
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:

Ant Enterprise Extensions Build Properties
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. 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 property 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.

Notes

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:

Command Line Build Properties
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:
Policy: Description:
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:

z/OS Dependency Build Properties
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. The load directory can be referenced using the built-in build property ${team.enterprise.scm.fetchDestination}.

For example:

${team.enterprise.scm.fetchDestination}/project/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 property 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 AntAnt.
team.enterprise.build.ant.propertiesFile Properties file: This is an output file that contains 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
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.excludedComponentsAreIncludes Select whether components are included or excluded: Specify whether the list of components are to be included or excluded from the build.
team.enterprise.build.loadOnlySelf File loading has been modified during a dependency build such that if the dependencies of a buildable file are also a buildable file, then it will not load the file as a dependency (since it will be loaded as a buildable file). This property can be used to turn off this behavior. If it is set to false, then the new behavior will not be turned on and everything will be loaded regardless.
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

Notes

gwayBuildProperty Element

Code gwayBuildProperty elements to specify Enterprise Interactive Gateway configuration details for a z/OS Dependency build. The gwayBuildProperty element accepts two attributes, name and value, which are both required. The following table describes the valid values for the gwayBuildProperty element attributes:

Enterprise Interactive Gateway Properties
name value Description
team.enterprise.gateway.acctnum TSO account number: The TSO/E account number to be used for a TSO/E session. This parameter is required on a request for the start of a new TSO/E session. Valid values are 1 to 40 characters long.
team.enterprise.gateway.enabled Interactve gateway enabled: Whether or not the ISPF Interactive Gateway feature is enabled or not.
team.enterprise.gateway.groupid TSO group ID: The TSO/E group name to be used for a TSO/E session. This parameter is required on a request for the start of a new TSO/E session. Valid values are 1 to 8 characters long.
team.enterprise.gateway.procname TSO procedure name: The name of the TSO/E logon procedure to be used for a TSO/E session. This parameter is required on a request for the start of a new TSO/E session. Valid values are 1 to 8 characters long.
team.enterprise.gateway.regionsz TSO region size: The region size to be used for a TSO/E session. This parameter is required on a request for the start of a new TSO/E session. Valid values are 0 to 2,096,128.
team.enterprise.gateway.steplib TSO module steplib: The steplib concatenation to use for the gateway session for access to ISP.SISPLPA and ISP.SISPLOAD.

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:

Hudson/Jenkins Build Properties
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:

IBMi Command Line Build Properties
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 IBMi.
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 IBMi 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:

IBMi Dependency Build Properties
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. The load directory can be referenced using the built-in build property ${team.enterprise.scm.fetchDestination}.

For example:

${team.enterprise.scm.fetchDestination}/project/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 property 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.
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.excludedComponentsAreIncludes Select whether components are included or excluded: Specify whether the list of components are to be included or excluded from the build.
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

Notes

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 IBMi 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:

IBMi Promotion Build Properties
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.ignore.changes true
false
Consider ignored changes: Specify true to specify during work item promotion.
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.
com.ibm.team.enterprise.promotion.workitem.decide.include.impacted true
false
Include impacted outputs: Specify true to specify during work item promotion.
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.
com.ibm.team.enterprise.promotion.workitem.ignore.changes true
false
Consider ignored changes: Specify true to enable.
com.ibm.team.enterprise.promotion.workitem.include.children true
false
Include children of selected work items: Specify true to enable.
com.ibm.team.enterprise.promotion.workitem.include.impacted true
false
Include impacted outputs: Specify true to enable.
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.
team.promotion.ibmi.pfRestoreMethod REPLACE
MIGRATE
USRCMD
Rules for promoting physical files: Specify how to handle physical file (*FILE:PF-DTA) objects during promotion.
Rule: Description:
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.

Notes

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:

ECJ Publishing Properties
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:

JUnit Publishing Properties
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:

Microsoft Visual Studio Solution Build Properties
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:

Microsoft Build Items
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>
    

Notes

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:

Microsoft Unit Testing Properties
name value Description
com.ibm.team.build.mstest.additionalArg Additional arguments: Specify additional arguments to the MSTest command.
com.ibm.team.build.mstest.mstestDLLFile MSTest specification file (dll): Specify the path to the dll file to use.
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:

Maven Build Properties
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:

NUnit Testing Properties
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:

z/OS Promotion Build Properties
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.ignore.changes true
false
Consider ignored changes: Specify true to specify during work item promotion.
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.
com.ibm.team.enterprise.promotion.workitem.decide.include.impacted true
false
Include impacted outputs: Specify true to specify during work item promotion.
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.
com.ibm.team.enterprise.promotion.workitem.ignore.changes true
false
Consider ignored changes: Specify true to enable.
com.ibm.team.enterprise.promotion.workitem.include.children true
false
Include children of selected work items: Specify true to enable.
com.ibm.team.enterprise.promotion.workitem.include.impacted true
false
Include impacted outputs: Specify true to enable.
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.

Notes

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:

Build Forge Properties
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 Specify a Build Forge project name.

Notes

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:

Post-build Deploy Properties
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, if Jazz Source Control option is selected:

"snapshotUUID=${team.scm.snapshotUUID}"

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. Valid values are:
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}".

Notes

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.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:

z/OS Command Line Build Properties
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:

z/OS Pre-Build Command Properties
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:

z/OS Post-Build Command Properties
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.

Post-build Deliver Properties

The following sections describe how to define the Post-build Deliver properties used in a build definition. Each section describes an element that can be specified within the createBuildDefinition or updateBuildDefinition element. These elements are not required and may not be applicable to the type of definition you are creating. Refer to the Build Reference section to determine which elements are valid for the build you are defining.

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

Post-build Deliver Properties
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.
JSON array A JSON formatted collection of string values.
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 No Valid values are: true and false. The default is false. Specifying this attribute will control how the property is resolved.
description No This attribute is ignored.
genericEditAllowed No This attribute is ignored.
kind No This attribute is ignored.
label No This attribute is ignored.
override No This attribute is ignored.
required No This attribute is ignored.
scheduleOverride No This attribute is ignored.
wellKnown No This attribute is ignored.

deliverProperty Element

Code deliverProperty elements to specify the trigger policy used to determine when to automatically deliver component changes, the target stream you would like to flow changes to, the components that will be delivered, and the owner of the snapshot created (ownership can only be changed if all components are delivered) for the Post-build Delivery facility. The deliverProperty 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 deliverProperty element attributes:

Post-build Delivery Properties
name value Description
team.scm.deliver.abortOnIncompleteActivity true
false
Abort post-build deliver if there are incomplete build activities.
team.scm.deliver.addNewComponentsToTarget true
false
Add components to deliver if they do not exist in the deliver target.
team.scm.deliver.changeSnapshotOwner true
false
Specify false to leave the build workspace as the owner of the snapshot. Specify true to set the deliver target as the owner of the snapshot.
team.scm.deliver.componentsToDeliver Specify a comma separated list of component names to deliver.
team.scm.deliver.deliverAllComponents true
false
Deliver all components in build workspace. When false is specified, a non-blank team.scm.deliver.componentsToDeliver property is required. When true is specified, the team.scm.deliver.componentsToDeliver property must not be specified.
team.scm.deliver.enabled true
false
Enable post-build deliver.
team.scm.deliver.removeComponentsInTarget true
false
Remove components from deliver target if they do not exist in the build workspace.
team.scm.deliver.targetUUID Specify the name of the target stream you would like to flow changes to.
team.scm.deliver.triggerPolicy ALWAYS
NO_ERRORS
NO_WARNINGS
Specify the trigger policy used to determine when to automatically deliver component changes. Valid values are:
ALWAYS Deploy always.
NO_ERRORS Deploy if build has no errors (warnings allowed).
NO_WARNINGS Deploy if build has no errors or warnings.

Team Build Properties

The following sections describe how to define the Team Build properties used in a build definition. Each section describes a set of Team Build properties that can be defined using the teamBuildProperty element. The teamBuildProperty 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.

Code as many teamBuildProperty elements as are needed to define the Team Build properties for the build definition. One teamBuildProperty element is needed for each Team Build property. Code the teamBuildProperty element within the createBuildDefinition or updateBuildDefinition element. Specify only those Team Build properties that are valid for the type of build you are defining. The teamBuildProperty element is not required and may not be applicable to the type of definition you are creating. Refer to the Build Reference section to determine if teamBuildProperty elements are valid for the build you are defining.

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

Team Build Properties
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.
JSON array A JSON formatted collection of string values.
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 No Valid values are: true and false. The default is false. Specifying this attribute will control how the property is resolved.
description No This attribute is ignored.
genericEditAllowed No This attribute is ignored.
kind No This attribute is ignored.
label No This attribute is ignored.
override No Valid values are: true and false. The default is false. Specify true for this attribute when updating restricted Team Build property values.
required No This attribute is ignored.
scheduleOverride No This attribute is ignored.
wellKnown No This attribute is ignored.

teamBuildProperty Element - Ant Enterprise Extensions Build

The following table describes the valid values for teamBuildProperty element attributes for an Ant with Enterprise Extensions build:

Team Build Properties - Ant Enterprise Extensions Build
name value Description
teamz.build.ant.bpxwdyn.options BPXWDYN Options: Dynamic allocation options. Define any options that you want to pass to the BPXWDYN interface. The default value is MSG(1), which means that messages are directed to file descriptor 1, which is the build log file for all Ant with Enterprise Extensions dependency builds.
teamz.build.ant.reuseISPFSession true
false
Reuse ISPF Session: Specify true if you have translators that use a call method of ISPF command or EXEC and wish to avoid the overhead of repeated session setup and teardown. Note: This option is for advanced use cases only.

teamBuildProperty Element - z/OS Deployment Build

The following table describes the valid values for teamBuildProperty element attributes for a z/OS Deployment build:

Team Build Properties - z/OS Deployment Build
name value Description
team.deploy.common.action ""
deployMain
loadMain
rollbackMain
Deploy type: Specify the type of deployment to perform. Valid values are:
Value: Description:
"" Load and deploy (a blank or empty value).
deployMain Deploy.
loadMain Load.
rollbackMain Rollback.

This property should be included as a Schedule Team Property.

team.deploy.common.deploy.postCommand Deploy post-command: Command to be executed after deployment.
team.deploy.common.deploy.preCommand Deploy pre-command: Command to be executed prior to deployment.
team.deploy.common.load.ftp.hostname Host name: FTP host name.
team.deploy.common.load.ftp.passwordFile Password file: FTP password file.
team.deploy.common.load.ftp.userid User ID: FTP user ID.
team.deploy.common.load.postCommand Load post-command: Command to be executed after load.
team.deploy.common.load.preCommand Load pre-command: Command to be executed prior to load.
team.deploy.common.loadMethod Copy
ftp
Load method: Specify the type of load method to use and the appropriate command and/or FTP properties. When copy is specified, the FTP host name, user ID, and password file attributes must not be specified. When ftp is specified, the FTP host name, user ID, and password file attributes are required. Valid values are:
Value: Description:
Copy Copy data sets on this system. Note: "Copy" must be specified with a capital "C".
ftp FTP data sets from another system.
team.deploy.common.localPackageRoot.dir Deployed package root directory:* Local package root directory.
team.deploy.common.packageLabel Package: Specify the label of the target packaging build result.
This property should be included as a Schedule Team Property.
team.deploy.common.packagedefinitionUUID Package definition:* Specify the ID of the packaging build definition.
team.deploy.common.publishCumulativeDeploy true
false
Publish cumulative deploy manifest: Specify true to publish the cumulative deployment manifest file in the deployment result.
team.deploy.common.publishDeltaDeploy true
false
Publish delta deploy manifest: Specify true to publish the delta deployment manifest file in the deployment result.
team.deploy.common.publishRollbackManifest true
false
Publish rollback manifest: Specify true to publish the rollback manifest file in the deployment result.
team.deploy.common.remotePackageRoot.dir Original package root directory:* Remote package root directory.
team.deploy.common.restoreMappingList From Data Set/To Data Set: Specify the names of the PDS’s created by the packaging build, and where to deploy them, in the restore mapping table. Specify a semicolon separated list of From/To paired dataset names.

For example, for these data set names:

From: DATA.SET.FROM0
To:   DATA.SET.TO0

From: DATA.SET.FROM1
To:   DATA.SET.TO1
            
you would specify this string:
DATA.SET.FROM0;DATA.SET.TO0;DATA.SET.FROM1;DATA.SET.TO1
            
team.deploy.common.rollback.maximumKeep integer Maximum number of rollbacks to keep: Specify an integer value for the number of rollbacks to keep.
team.deploy.common.rollback.multipleAllowed true
false
Allow multiple rollbacks: Specify true to allow your team to roll back a saved package that was successfully deployed. The default is false. Note: Ignored for agents older than 5.0.1.
team.deploy.common.rollback.postCommand Rollback post-command: Command to be executed after roll back.
team.deploy.common.rollback.preCommand Rollback pre-command: Command to be executed prior to roll back.

Notes

teamBuildProperty Element - z/OS Dependency Build

The following table describes the valid values for teamBuildProperty element attributes for a z/OS Dependency Build:

Team Build Properties - z/OS Dependency Build
name value Description
team.enterprise.build.ant.alwaysRunPostBuildFile true
false
Always run post-build script: Specify true to run the specified post-build Ant script whether or not the build was successful. The default is false, the specified post-build Ant script will only be run if the build was successful.
team.enterprise.build.ant.bpxwdyn.options BPXWDYN Options: Dynamic allocation options. Define any options that you want to pass to the BPXWDYN interface. The default value is MSG(1), which means that messages are directed to file descriptor 1, which is the build log file for all Ant with Enterprise Extensions and dependency builds.
team.enterprise.build.ant.buildChangesOnly true
false
Build changed items only: Specify true to build only the items that have changed since the last successful build. Specify false to build all items found in the workspace. The default is true.
team.enterprise.build.ant.buildableSubset Build subset: Specify the name of an existing build subset. Build subsets specify a group of buildable items that will be included when executing a dependency build.
team.enterprise.build.ant.fullMinimumLoad true
false
Perform full minimum load: Specify true to load all items that recently changed or that depend on items that changed since the last successful build. This option is only valid for personal builds. Items will be loaded from the workspace specified on the build request to the resource prefix specified on the build request.
team.enterprise.build.ant.mandatorySubset Mandatory Subset: If there are files to be included in each build for this build definition, specify the name of the subset containing the files that are required to be included in this build. The files in the mandatory subset are always built, even if they are not changed.
team.enterprise.build.ant.mandatorySubset.useInPersonal true
false
Include this mandatory subset in personal builds by default: Specify true to include the manadatory subset in personal builds.
team.enterprise.build.ant.postBuildFile Post-build script: Specify the path to the post-build script 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.build.ant.preBuildFile Pre-build script: Specify the path to the pre-build script 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.build.ant.reuseISPFSession true
false
Reuse ISPF Session: Specify true if you have translators that use a call method of ISPF command or EXEC and wish to avoid the overhead of repeated session setup and teardown. Note: This option is for advanced use cases only.
team.enterprise.build.ant.simulationModeBinaryCheck true
false
Verify build outputs during a simulation build: Specify true to updates the simulation registry to reflect whether each output is present. Specify false to reduce simulation build overhead by assuming all build outputs are present and correct.
team.enterprise.build.dependency.needToDeleteOutputs true
false
Delete obsolete outputs: Specify true to delete outputs that are no longer produced by any buildable files.
team.enterprise.build.dependency.preprocessUpdateF integer Frequency of updates to the number of buildable files pre-processed in the build report contribution summary: Specify the number of files to preprocess before updates are made in the Build Result editor. The default is 100.
team.enterprise.build.dependency.trustInputs true
false
Trust build inputs: Specify true to trust the files that are already loaded in zFolder data sets. When SCM metadata is not available for any reason, and this property is set to true, existing files loaded into zFolder data sets are considered to be valid and will not be overwritten when a workspace load is processed. New SCM metadata will be generated for the files as part of this process.

The trust inputs option can significantly decrease the load time on z/OS when the SCM configuration directory needs to be cleared for housekeeping.

The default value is false; data set contents are not trusted unless they can be validated by SCM metadata, and if that SCM metadata is not available, the files will be reloaded.

This property is especially useful when running a build across multiple build agents or installing a new build agent.

team.enterprise.build.dependency.trustOutputs true
false
Trust build outputs: Specify true to have the build run on the premise that you did not delete or modify the outputs that were created in previous builds. This option improves performance when you rebuild because you skip unnecessary checks for missing or changed outputs.
team.enterprise.build.impacts.disableAlwaysBuildQueries true
false
Calculate impacts of files being forced to be built: Specify false to do the calculation. Specify true to skip the calculation. When impact calculations are enabled, they are also run on files that are forced to be rebuilt. For example, files in a mandatory subset.
team.enterprise.build.impacts.disableInputQueries true
false
Calculate impacted dependencies stored in the repository: Specify false to do the calculation. Specify true to skip the calculation. This corresponds to reason code 2 in the build report: One or more dependencies stored in the repository have changed.
team.enterprise.build.impacts.disableParserOutputQueries true
false
Calculate impacted dependencies not in the repository: Specify false to do the calculation. Specify true to skip the calculation. This corresponds to reason code 3 in the build report: One or more dependencies not in the repository, such as generated input files, have changed.
team.enterprise.build.suppressBuildMapLinks true
false
Publish build map links: Specify true to publish build map links on the External Links tab of the build.

Notes

teamBuildProperty Element - Enterprise Interactive Gateway

The following table describes the valid values for teamBuildProperty element attributes for a Enterprise Interactive Gateway session:

Team Build Properties - Enterprise Interactive Gateway
name value Description
team.enterprise.gateway.debug true
false
Enterprise Interactive Gateway debugging facility: Specify true to enable end-to-end Gateway logging for debug purposes. The default is false, debug logging is not enabled.
team.enterprise.gateway.loglevel integer ISPF Interactive Gateway logging level: Add values for multiple types:
  • 1 - Log error information
  • 2 - Log debug information
  • 4 - Log communication information
  • 8 - Log time information
  • 16 - Log information to the system console
  • 32 - Include time stamps in log information
A value of 47 will provide all ISPF Interactive Gateway logging information.

Notes

teamBuildProperty Element - IBMi Deployment Build

The following table describes the valid values for teamBuildProperty element attributes for an IBMi Deployment build:

Team Build Properties - IBMi Deployment Build
name value Description
team.deploy.common.action ""
deployMain
loadMain
rollbackMain
Deploy type: Specify the type of deployment to perform. Valid values are:
Value: Description:
"" Load and deploy (a blank or empty value).
deployMain Deploy.
loadMain Load.
rollbackMain Rollback.

This property should be included as a Schedule Team Property.

team.deploy.common.deploy.postCommand Deploy post-command: Command to be executed after deployment.
team.deploy.common.deploy.preCommand Deploy pre-command: Command to be executed prior to deployment.
team.deploy.common.load.ftp.hostname Host name: FTP host name.
team.deploy.common.load.ftp.passwordFile Password file: FTP password file.
team.deploy.common.load.ftp.userid User ID: FTP user ID.
team.deploy.common.load.postCommand Load post-command: Command to be executed after load.
team.deploy.common.load.preCommand Load pre-command: Command to be executed prior to load.
team.deploy.common.loadMethod Copy
ftp
Load method: Specify the type of load method to use and the appropriate command and/or FTP properties. When copy is specified, the FTP host name, user ID, and password file attributes must not be specified. When ftp is specified, the FTP host name, user ID, and password file attributes are required. Valid values are:
Value: Description:
Copy Copy libraries on this system. Note: "Copy" must be specified with a capital "C".
ftp FTP libraries from another system.
team.deploy.common.localPackageRoot.dir Deployed package root directory:* Local package root directory.
team.deploy.common.packageLabel Package: Specify the label of the target packaging build result.
This property should be included as a Schedule Team Property.
team.deploy.common.packagedefinitionUUID Package definition:* Specify the ID of the packaging build definition.
team.deploy.common.publishCumulativeDeploy true
false
Publish cumulative deploy manifest: Specify true to publish the cumulative deployment manifest file in the deployment result.
team.deploy.common.publishDeltaDeploy true
false
Publish delta deploy manifest: Specify true to publish the delta deployment manifest file in the deployment result.
team.deploy.common.publishRollbackManifest true
false
Publish rollback manifest: Specify true to publish the rollback manifest file in the deployment result.
team.deploy.common.remotePackageRoot.dir Original package root directory:* Remote package root directory.
team.deploy.common.restoreMappingList From Library/To Library: Specify the names of the libraries created by the packaging build, and where to deploy them, in the restore mapping table. Specify a double-semicolon separated list of From/To paired library names. For example, for these library names:
From: libraryf0
To:   libraryt0

From: libraryf1
To:   libraryt1
            
you would specify this string:
ibraryf0;;libraryt0;;libraryf1;;libraryt1
            
team.deploy.common.rollback.maximumKeep integer Maximum number of rollbacks to keep: Specify an integer value for the number of rollbacks to keep.
team.deploy.common.rollback.multipleAllowed true
false
Allow multiple rollbacks: Specify true to allow your team to roll back a saved package that was successfully deployed. The default is false. Note: Ignored for agents older than 5.0.1.
team.deploy.common.rollback.postCommand Rollback post-command: Command to be executed after roll back.
team.deploy.common.rollback.preCommand Rollback pre-command: Command to be executed prior to roll back.
team.deploy.ibmi.intermediateSaveFileLibrary IBMi intermediate save file library:* Specify a working library on the IBMi server to temporarily store objects.
team.deploy.ibmi.pfRestoreMethod REPLACE
MIGRATE
USRCMD
Rules for deploying physical files: Specify how to handle physical file (*FILE:PF-DTA) objects during deployment.
Value: Description:
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.deploy.ibmi.pfRestoreUsrCmd User-defined command to deploy each physical file: Specify the CL command to be executed for each file. When this option is selected, the substitution variables &A, &F, &L, &N, &T, and &S are supported in the build command.
team.deploy.ibmi.savePfForRollback true
false
Save physical files in rollback archive before deployment: Specify true to save physical files in a rollback archive before deployment to save a backup of your physical files in case errors occur during the deployment process. The default is true. If an error occurs, the original objects can be restored by requesting a rollback.

Notes

teamBuildProperty Element - IBMi Dependency Build

The following table describes the valid values for teamBuildProperty element attributes for an IBMi Dependency build:

Team Build Properties - IBMi Dependency Build
name value Description
team.enterprise.build.ant.alwaysRunPostBuildFile true
false
Always run post-build script: Specify true to run the specified post-build Ant script whether or not the build was successful. The default is false, the specified post-build Ant script will only be run if the build was successful.
team.enterprise.build.ant.buildChangesOnly true
false
Build changed items only: Specify true to build only the items that have changed since the last successful build. Specify false to build all items found in the workspace. The default is true.
team.enterprise.build.ant.buildableSubset Build subset: Specify the name of an existing build subset. Build subsets specify a group of buildable items that will be included when executing a dependency build.
team.enterprise.build.ant.fullMinimumLoad true
false
Perform full minimum load: Specify true to load all items that recently changed or that depend on items that changed since the last successful build. This option is only valid for personal builds. Items will be loaded from the workspace specified on the build request to the resource prefix specified on the build request.
team.enterprise.build.ant.mandatorySubset Mandatory Subset: If there are files to be included in each build for this build definition, specify the name of the subset containing the files that are required to be included in this build. The files in the mandatory subset are always built, even if they are not changed.
team.enterprise.build.ant.mandatorySubset.useInPersonal true
false
Include this mandatory subset in personal builds by default: Specify true to include the manadatory subset in personal builds.
team.enterprise.build.ant.postBuildFile Post-build script: Specify the path to the post-build script 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.build.ant.preBuildFile Pre-build script: Specify the path to the pre-build script 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.build.ant.simulationModeBinaryCheck true
false
Verify build outputs during a simulation build: Specify true to updates the simulation registry to reflect whether each output is present. Specify false to reduce simulation build overhead by assuming all build outputs are present and correct.
team.enterprise.build.dependency.preprocessUpdateF integer Frequency of updates to the number of buildable files pre-processed in the build report contribution summary: Specify the number of files to preprocess before updates are made in the Build Result editor. The default is 10.
team.enterprise.build.dependency.trustOutputs true
false
Trust build outputs: Specify true to have the build run on the premise that you did not delete or modify the outputs that were created in previous builds. This option improves performance when you rebuild because you skip unnecessary checks for missing or changed outputs.
team.enterprise.build.impacts.disableAlwaysBuildQueries true
false
Calculate impacts of files being forced to be built: Specify false to do the calculation. Specify true to skip the calculation. When impact calculations are enabled, they are also run on files that are forced to be rebuilt. For example, files in a mandatory subset.
team.enterprise.build.impacts.disableInputQueries true
false
Calculate impacted dependencies stored in the repository: Specify false to do the calculation. Specify true to skip the calculation. This corresponds to reason code 2 in the build report: One or more dependencies stored in the repository have changed.
team.enterprise.build.impacts.disableParserOutputQueries true
false
Calculate impacted dependencies not in the repository: Specify false to do the calculation. Specify true to skip the calculation. This corresponds to reason code 3 in the build report: One or more dependencies not in the repository, such as generated input files, have changed.
team.enterprise.build.suppressBuildMapLinks true
false
Publish build map links: Specify true to publish build map links on the External Links tab of the build.
team.enterprise.build.ibmi.postCommand Post-command: Specify an IBMi command to run after the build script runs.
team.enterprise.build.ibmi.preCommand Pre-command: Specify an IBMi command to run before the build script runs.
com.ibm.team.enterprise.ibmi.build.AppendLoadObjLibraries true
false
Append load and object libraries from the build definition: Specify true to append load and object libraries from the build definition for personal builds.
com.ibm.team.enterprise.ibmi.build.ant.failOnError true
false
Stop and fail the build (compile error level): Specify true to fail the build when the generated events file contains a severity level that meets or exceeds the value specified with the com.ibm.team.enterprise.ibmi.build.ant.failOnError.level property.
com.ibm.team.enterprise.ibmi.build.ant.failOnError.level integer Stop and fail the build (compile error level): Specify the error level found in the generated events file that will trigger a build failure.
com.ibm.team.enterprise.ibmi.build.ant.icmd.failOnError true
false
Stop and fail the build (i command): Specify true to fail the build when an IBMi command completes with a severity level that meets or exceeds the value specified with the com.ibm.team.enterprise.ibmi.build.ant.icmd.failOnError.level property.
com.ibm.team.enterprise.ibmi.build.ant.icmd.failOnError.level integer Stop and fail the build (i command level): Specify the error level received for IBMi command that will trigger a build failure.
com.ibm.team.enterprise.ibmi.build.searchPath Search path: Specify a search path for the build to use as the library list for the build.

Notes

teamBuildProperty Element - IBMi Packaging Build

The following table describes the valid values for teamBuildProperty element attributes for an IBMi Packaging build:

Team Build Properties - IBMi Packaging Build
name value Description
team.enterprise.packaging.includeImpactedObjects true
false
Include Impacted Outputs: Specify true to include indirect outputs for work item packaging (e.g. linked load modules, bound service programs). This property should be included as a Schedule Team Property.
team.enterprise.packaging.packagedWorkitems Work Items Specify a comma separated list of work items IDs whose outputs should be packaged. This property should be included as a Schedule Team Property.
team.package.common.buildDefinition.uuid Build definition: Specify the name of a build definition to be packaged.
team.package.common.exclude.binaries Resource filters to exclude: Specify a generic filter or a specific library, object, and type. To specify a generic filter, indicate the library name and member name pattern in the following format:
LIB.NAME(*) OBJTYPE(*)
LIB.NAME(*) OBJTYPE(abc)
LIB.NAME(def) OBJTYPE(*)
            

To specify a specific data set and member by name, indicate the data set name and member name in the following format:

LIB.NAME(abc) OBJTYPE(def)
            

A list of resource filters can be specified with each separated by a comma.

team.package.common.include.binaries Resource filters to exclude: Specify a generic filter or a specific library, object, and type. To specify a generic filter, indicate the library name and member name pattern in the following format:
LIB.NAME(*) OBJTYPE(*)
LIB.NAME(*) OBJTYPE(abc)
LIB.NAME(def) OBJTYPE(*)
            

To specify a specific data set and member by name, indicate the data set name and member name in the following format:

LIB.NAME(abc) OBJTYPE(def)
            

A list of resource filters can be specified with each separated by a comma.

team.package.common.isAutoClean true
false
Auto clean: Specify true to delete a package from the package root directory so that you have more package space available.
team.package.common.isConcurrentSafe true
false
Allow concurrent package requests: Specify true to allow multiple packaging builds to run concurrently (not allowed for agents older than 5.0.2).
team.package.common.isIntermediatesPublished true
false
Publish intermediate files: Specify true to publish intermediate packaging results.
team.package.common.isManifestPublished true
false
Publish manifest: Specify true to publish packaging manifest.
team.package.common.isPackagePublished true
false
Publish package: Specify true to publish packaging results.
team.package.common.packageBinariesSinceTimestamp Time Stamp: Omit ship list resources older than this time stamp (format: yyyyMMdd-HHmmssSSSS or leave blank to ignore time stamps). This property should be included as a Schedule Team Property.
team.package.common.packageRoot.dir Package root directory:* Specify a directory on the build systems where you want to store all packages.
team.package.common.postPackageCommand Package post-command: Specify a command to run on the build system after packaging.
team.package.common.prePackageCommand Package pre-command: Specify a command to run on the build system before packaging.
team.package.common.workItemPackaging Packaging Type: Specify true to calculate package contents from work items. Specify false to calculate package contents from a list of resources. This property should be included as a Schedule Team Property.
team.package.ibmi.intermediateSaveFileLibrary IBMi intermediate save file library:* Specify a library name to temporarily store objects on the IBMi server.
team.package.ibmi.savefileOptions IBMi save file options: Specify a TGTRLS VRM_release_level, where VRM_release_level is a valid target release for saving objects on the packaging host; for example, *CURRENT, *PRV, or V6R1M0. If you do not specify this option, the objects are saved at TGTRLS(*CURRENT).
team.package.restore.mapping From Library/To Library: Specify the libraries to package and where to deploy them in the restore mapping table. Specify a comma separated list of From/To paired library names. For example:
fromLib,toLib,fromLib2,toLib2
            

Notes

teamBuildProperty Element - IBMi Promotion Build

The following table describes the valid values for teamBuildProperty element attributes for an IBMi Promotion build:

Team Build Properties - IBMi Promotion Build
name value Description
team.enterprise.promotion.component.skipFullAnalysisTargetBuild true
false
IBM Engineering Workflow Management runs a build on a target build definition after a component promotion by default. Use this property to prevent the build from requesting the target build.
team.enterprise.promotion.ibmi.postCommand Post-command: Specify an IBMi command to run after the build script runs.
team.enterprise.promotion.ibmi.preCommand Pre-command: Specify an IBMi command to run before the build script runs.
team.enterprise.promotion.component.skipFullAnalysisTargetBuild true
false
IBM Engineering Workflow Management runs a build on a target build definition after a component promotion by default. Use this property to prevent the build from requesting the target build. This property should be included as a Schedule Team Property.
team.enterprise.promotion.promotionUserId User ID used during scheduled component promotions to promote source and update the summary work item. You can use this property to specify the user ID that runs the promotion. The default user ID for promotions is ADMIN.
team.enterprise.promotion.suppressBuildMapLinks true
false
IBM Engineering Workflow Management publishes all build maps that are promoted in the build result by default. For performance reasons, you can use this property to prevent the build map links from being published in the build result.
com.ibm.team.enterprise.promotion.skipTimestampCheck true
false
Skip timestamp check when build outputs are promoted: The time stamp check verifies that the built objects that you are promoting match the objects that are specified in the build map. If you know that the built objects changed and you want to promote anyway, specify true to skip the timestamp check when promoting build outputs.

Notes

teamBuildProperty Element - Ant Enterprise Extensions Publishing

The following table describes the valid values for teamBuildProperty element attributes for the Ant with Enterprise Extensions publishing facility:

Team Build Properties - Ant Enterprise Extensions Publishing
name value Description
teamz.build.publishoutputs true
false
Publish job output logs: Specify true to have designated compiler listings published in the build results.
teamz.build.publishoutputs.erroronly true
false
Publish only when an error occurred: Specify true to limit the overhead of log publishing by only publishing listings when an error occurs in the build process.

teamBuildProperty Element - z/OS Packaging Build

The following table describes the valid values for teamBuildProperty element attributes for an z/OS Packaging build:

Team Build Properties - z/OS Packaging Build
name value Description
team.enterprise.packaging.deleteObsoleteOutputs true
false
Delete obsolete work item outputs: Specify true to analyse the change sets of the work items being packaged and locate outputs no longer being created by the files in the change sets. There are limitations to the deletion of outputs.
team.enterprise.packaging.includeImpactedObjects true
false
Include Impacted Outputs: Specify true to include indirect outputs for work item packaging (e.g. linked load modules, bound service programs). This property should be included as a Schedule Team Property.
team.enterprise.packaging.packagedWorkitems Work Items Specify a comma separated list of work items IDs whose outputs should be packaged. This property should be included as a Schedule Team Property.
team.package.common.buildDefinition.uuid Build definition: Specify the name of a build definition to be packaged.
team.package.common.exclude.binaries Resource filters to exclude: Specify a generic filter or a specific data set and member by name. To specify a generic filter, indicate the data set name and member name pattern in the following format:
DATA.SET.NAME(*)
            

To specify a specific data set and member by name, indicate the data set name and member name in the following format:

DATA.SET.NAME(MEMBER)
            

A list of resource filters can be specified with each separated by a comma.

team.package.common.exclude.hfs.binaries Resource filters to exclude for HFS files: Specify a generic filter or specific files from the build in the following format:
directory:pattern
            

For example:

myOtherProject/:**/*.jar:myJavaProject:**/*.jar:
            

A list of resource filters can be specified with each directory and pattern separated by a colon.

team.package.common.include.binaries Resource filters to include: Specify a generic filter or a specific data set and member by name. To specify a generic filter, indicate the data set name and member name pattern in the following format:
DATA.SET.NAME(*)
            

To specify a specific data set and member by name, indicate the data set name and member name in the following format:

DATA.SET.NAME(MEMBER)
            

A list of resource filters can be specified with each separated by a comma.

team.package.common.include.hfs.binaries Resource filters to include for HFS files: Specify a generic filter or specific files from the build in the following format:
directory:pattern
            

For example:

myOtherProject/:**/*.jar:myJavaProject:**/*.jar:
            

A list of resource filters can be specified with each directory and pattern separated by a colon.

team.package.common.isAutoClean true
false
Auto clean: Specify true to delete a package from the package root directory so that you have more package space available.
team.package.common.isConcurrentSafe true
false
Allow concurrent package requests: Specify true to allow multiple packaging builds to run concurrently (not allowed for agents older than 5.0.2).
team.package.common.isIntermediatesPublished true
false
Publish intermediate files: Specify true to publish intermediate packaging results.
team.package.common.isManifestPublished true
false
Publish manifest: Specify true to publish packaging manifest.
team.package.common.isPackagePublished true
false
Publish package: Specify true to publish packaging results.
team.package.common.packageBinariesSinceTimestamp Time Stamp: Omit ship list resources older than this time stamp (format: yyyyMMdd-HHmmssSSSS or leave blank to ignore time stamps). This property should be included as a Schedule Team Property.
team.package.common.packageRoot.dir Package root directory:* Specify a directory on the build systems where you want to store all packages.
team.package.common.postPackageCommand Package post-command: Specify a command to run on the build system after packaging.
team.package.common.prePackageCommand Package pre-command: Specify a command to run on the build system before packaging.
team.package.common.workItemPackaging Packaging Type: Specify true to calculate package contents from work items. Specify false to calculate package contents from a list of resources. This property should be included as a Schedule Team Property.
team.package.restore.mapping From Data Set/To Data Set: Specify the PDS to package and where to deploy them in the restore mapping table. Specify a comma separated list of From/To paired data set names. For example:
FROM.DSN0,TO.DSN0,FROM.DSN1,TO.DSN1
            
team.package.ucd.component UrbanCode Deploy component name: Specify the name of the UrbanCode Deploy component for which the versions are being created.
team.package.ucd.generate true
false
Generate UrbanCode Deploy package: If true is specified, UrbanCode Deploy generates a component version. If false is specified, a ship list is generated that UrbanCode Deploy can use later to generate a component version.
team.package.ucd.tk.script UrbanCode Deploy Toolkit script: Specify the path name of the toolkit script that creates z/OS versions. For example: /var/ucd611/agent/bin/buztool.sh
team.package.ucd.type true
false
UrbanCode Deploy package type: Specify true to generate an UrbanCode Deploy package from this package definition.
team.package.ucd.versionName.convention PROMPT
TIMESTAMP
WORKITEM
UrbanCode Deploy version naming convention: Specify one of the following choices:
Choice: Description:
PROMPT You specify the component version name when you request the package.
TIMESTAMP Creates a component version name based on the time of the package request.
WORKITEM The resulting component version name is the first work item number selected on the package request followed by a timestamp.
team.package.ucd.versionName.prefix Prefix for UrbanCode Deploy version name: Specified text is prepended to the version name, regardless of which naming convention you select.
team.package.zos.script z/OS ISPF gateway script:* Specify the path to the z/OS UNIX System Services (USS) shell script startispf.sh, which is used for running REXX EXEC files. The location of this shell script depends on how you configured your Build System Toolkit on z/OS. The default directory is: /etc/jazz601/ccm/startispf.sh

Notes

teamBuildProperty Element - z/OS Promotion Build

The following table describes the valid values for teamBuildProperty element attributes for an z/OS Promotion build:

Team Build Properties - z/OS Promotion Build
name value Description
com.ibm.team.enterprise.promotion.skipTimestampCheck true
false
Skip timestamp check when build outputs are promoted: The time stamp check verifies that the built objects that you are promoting match the objects that are specified in the build map. If you know that the built objects changed and you want to promote anyway, specify true to skip the timestamp check when promoting build outputs.
team.enterprise.promotion.promotionUserId User ID used during scheduled component promotions to promote source and update the summary work item. You can use this property to specify the user ID that runs the promotion. The default user ID for promotions is ADMIN.
team.enterprise.promotion.component.skipFullAnalysisTargetBuild true
false
IBM Engineering Workflow Management runs a build on a target build definition after a component promotion by default. Use this property to prevent the build from requesting the target build. This property should be included as a Schedule Team Property.
team.enterprise.promotion.suppressBuildMapLinks true
false
IBM Engineering Workflow Management publishes all build maps that are promoted in the build result by default. For performance reasons, you can use this property to prevent the build map links from being published in the build result.
team.promotion.zos.script z/OS ISPF gateway script:* Specify the path to the z/OS UNIX System Services (USS) shell script startispf.sh, which is used for running REXX EXEC files. The location of this shell script depends on how you configured your Build System Toolkit on z/OS. The default directory is: /etc/jazz601/ccm/startispf.sh

Notes

teamBuildProperty Element - Enterprise Extensions Publishing

The following table describes the valid values for teamBuildProperty element attributes for the Enterprise Extensions publishing facility:

Team Build Properties - Enterprise Extensions Publishing
name value Description
team.enterprise.build.publishoutputs true
false
Publish job output logs: Specify true to have designated compiler listings published in the build results.
team.enterprise.build.publishoutputs.erroronly true
false
Publish only when an error occurred: Specify true to limit the overhead of log publishing by only publishing listings when an error occurs in the build process.
team.enterprise.build.publishoutputs.successfulLogsAsZips true
false
Publish successful logs as zip files (one zip file per 100 logs): Specify true to limit the overhead of log publishing by consolidating logs into a single compressed zip file.

teamBuildProperty Element - Jazz Source Control for an Ant Build

The following table describes the valid values for teamBuildProperty element attributes for Jazz Source Control for an Ant build:

Team Build Properties - Jazz Source Control for an Ant Build
name value Description
team.scm.acceptBeforeFetch true
false
Accept latest changes before loading: Specify true to accept incoming changes to the workspace before loading the workspace to the fetch destination (creates a snapshot of the build workspace).
team.scm.buildOnlyIfChanges true
false
Build only if there are changes accepted: Specify true to build only if there are changes delivered to the build stream that have not been accepted into the build workspace. This option is only applicable for scheduled builds.
team.scm.componentLoadRules Load rules: To define a subset of component files and folders for the build to load, specify the path to the component load rules file. The path should include the component name, folder name(s), and the load rule file name. For example:
/ComponentName/ProjectFolder/RulesFolder/RulesFile.loadrules
            

If the file is stored at the top level of the component, where there is no project folder, specify just the component name and the load rule file name. For example:

/ComponentName/RulesFile.loadrules
            
team.scm.createFoldersForComponents true
false
Create folders for components: Specify true to create component level folders during the load. Normally, folders are created starting at the project level.
team.build.createWorkItemIncludeLinks true
false
Add build result links in accepted work items:Specify whether to create ’Included in Builds’ links in the accepted work items. By default, links will be created.
team.scm.deleteDestinationBeforeFetch true
false
Delete directory before loading: Specify true to delete source control metadata from the load directory before the workspace is loaded. Source control metadata stores information about the files that you load from IBM Engineering Workflow Management. When a build fails because of corrupted metadata, specify true to clean up the metadata and resolve the issue. However, when metadata is not corrupted and you select this option, your build might take longer to complete. Select this option only if you want to clean up the load directory and its associated metadata prior to loading the workspace.
team.scm.fetchDestination Load directory:* Specify the path to the directory on the build machine where workspace files should be loaded.
team.scm.loadComponents Components to exclude: Specify a comma separated list of component names that are to be excluded from the load process. This option can be used to restrict which components are loaded during the build.
team.scm.maxContentThreads integer Maximum content threads: Specify a positive integer value for the number of simultaneous transfers that can occur at one time. The Ant attribute value cannot be negative. Default value is 10.
team.scm.workspaceUUID Workspace:* Specify the name of the build workspace.

Notes

teamBuildProperty Element - Jazz Source Control for a Dependency Build

The following table describes the valid values for teamBuildProperty element attributes for Jazz Source Control for a Dependency Build:

Team Build Properties - Jazz Source Control for a Dependency Build
name value Description
team.enterprise.build.ant.fetchAll true
false
Load workspace to the resource with the resource prefix at the beginning of the build: Specify true to have artifacts stored in an enterprise file system (like PDSE on z/OS or Library on IBMi) to be loaded to the resources defined with the resource prefix at the beginning of the build.
team.enterprise.build.ant.fetchWorkspaceBeforeBuild true
false
Load workspace to the load directory at the beginning of the build: Specify true to have artifacts stored in the Hierarchical File System to be loaded to the load directory at the beginning of the build.
team.enterprise.scm.acceptBeforeFetch true
false
Accept latest changes before loading: Specify true to accept incoming changes to the workspace before loading the workspace to the fetch destination (creates a snapshot of the build workspace).
team.enterprise.scm.buildOnlyIfChanges true
false
Build only if there are changes accepted: Specify true to build only if there are changes delivered to the build stream that have not been accepted into the build workspace. This option is only applicable for scheduled builds.
team.enterprise.scm.componentLoadRules Load rules: To define a subset of component files and folders for the build to load, specify the path to the component load rules file. The path should include the component name, folder name(s), and the load rule file name. For example:
/ComponentName/ProjectFolder/RulesFolder/RulesFile.loadrules
            

If the file is stored at the top level of the component, where there is no project folder, specify just the component name and the load rule file name. For example:

/ComponentName/RulesFile.loadrules
            
team.enterprise.scm.createFoldersForComponents true
false
Create folders for components: Specify true to create component level folders during the load. Normally, folders are created starting at the project level.
team.enterprise.scm.deleteDestinationBeforeFetch true
false
Delete directory before loading: Specify true to delete source control metadata from the load directory before the workspace is loaded. Source control metadata stores information about the files that you load from IBM Engineering Workflow Management. When a build fails because of corrupted metadata, specify true to clean up the metadata and resolve the issue. However, when metadata is not corrupted and you select this option, your build might take longer to complete. Select this option only if you want to clean up the load directory and its associated metadata prior to loading the workspace.
team.enterprise.scm.fetchDestination Load directory:* Specify the path to the directory on the build machine where workspace files should be loaded.
team.enterprise.scm.loadComponents Components to exclude: Specify a comma separated list of component names that are to be excluded from the load process. This option can be used to restrict which components are loaded during the build.
team.enterprise.scm.log.loading true
false
Log loading: Specify true to create a log file and attach it to the build results on the Logs tab. The log file shows all of the commands that run to perform the required loading.
team.enterprise.scm.maxContentThreads integer Maximum content threads: Specify a positive integer value for the number of simultaneous transfers that can occur at one time. The Ant attribute value cannot be negative. Default value is 10.

This property controls the number of threads used to load source control files into z/OS® data sets. When this property is specified it overrides the value of the team.scm.maxContentThreads property. The two properties can be used in conjunction: team.enterprise.scm.maxContentThreads to control the number of threads used to load data sets and team.scm.maxContentThreads to control the number of threads used to load USS contents. If only the team.scm.maxContentThreads property is specified, that value is used for the thread count for both data sets and USS contents. If only the team.enterprise.scm.maxContentThreads property is specified, that value is used for the thread count for data sets; the default thread count will be used for USS contents.

team.enterprise.scm.resourcePrefix Resource prefix:* Specify the high-level qualifier for data set names. The name prefix to be used when allocating data sets.
team.enterprise.scm.resourceTeamPrefix Resource prefix:* Specify the high-level qualifier for data set names. The name prefix to be used when allocating data sets.
team.enterprise.scm.teamWorkspaceUUID Workspace:* Specify the name of the build workspace.
team.enterprise.scm.workspaceUUID Workspace:* Specify the name of the build workspace.
teamz.scm.workspaceUUID Workspace:* Specify the name of the build workspace.

Notes

teamBuildProperty Element - Jazz Source Control for an IBMi Command Line Build

The following table describes the valid values for teamBuildProperty element attributes for Jazz Source Control for an IBMi Command Line build:

Team Build Properties - Jazz Source Control for an IBMi Command Line Build
name value Description
team.scm.acceptBeforeFetch true
false
Accept latest changes before loading: Specify true to accept incoming changes to the workspace before loading the workspace to the fetch destination (creates a snapshot of the build workspace).
team.scm.buildOnlyIfChanges true
false
Build only if there are changes accepted: Specify true to build only if there are changes delivered to the build stream that have not been accepted into the build workspace. This option is only applicable for scheduled builds.
team.scm.clearDestinationBeforeFetch true
false
Clear libraries before loading: Specify true to execute the CLRLIB command. The CLRLIB command will clear each of the mapped libraries in the repository workspace properties before i Projects artifacts in the repository workspace (for example, source physical files, source members, and save files) are loaded to those mapped libraries.
team.scm.fetchChangesOnly true
false
Load latest changes only: Specify true to load those artifacts that are accepted into the build workspace when the build runs.
Load all workspace contents : Specify false to load all workspace artifacts every time the build runs.
team.scm.workspaceUUID Workspace:* Specify the name of the build workspace.

Notes

teamBuildProperty Element - Jazz Source Control for an IBMi Continuous Load Build

The following table describes the valid values for teamBuildProperty element attributes for Jazz Source Control for an IBMi Continuous Load build:

Team Build Properties - Jazz Source Control for an IBMi Continuous Load Build
name value Description
team.scm.workspaceUUID Workspace:* Specify the name of the build workspace.

Notes

teamBuildProperty Element - Jazz Source Control for an Ant Enterprise Extensions Build

The following table describes the valid values for teamBuildProperty element attributes for Jazz Source Control for an Ant with Enterprise Extensions build:

Team Build Properties - Jazz Source Control for an Ant Enterprise Extensions Build
name value Description
teamz.scm.acceptBeforeFetch true
false
Accept latest changes before loading: Specify true to accept incoming changes to the workspace before loading the workspace to the fetch destination (creates a snapshot of the build workspace).
teamz.scm.buildOnlyIfChanges true
false
Build only if there are changes accepted: Specify true to build only if there are changes delivered to the build stream that have not been accepted into the build workspace. This option is only applicable for scheduled builds.
teamz.scm.dataset.prefix Data set prefix:* Specify the high-level qualifier for data set names. The name prefix to be used when allocating data sets.
teamz.scm.deleteDestinationBeforeFetch true
false
Delete directory before loading: Specify true to delete source control metadata from the load directory before the workspace is loaded. Source control metadata stores information about the files that you load from IBM Engineering Workflow Management. When a build fails because of corrupted metadata, specify true to clean up the metadata and resolve the issue. However, when metadata is not corrupted and you select this option, your build might take longer to complete. Select this option only if you want to clean up the load directory and its associated metadata prior to loading the workspace.
teamz.scm.fetchDestination Load directory:* Specify the path to the directory on the build machine where workspace files should be loaded.
teamz.scm.workspaceUUID Workspace:* Specify the name of the build workspace.

Notes

teamBuildProperty Element - UrbanCode Deploy

The following table describes the valid values for teamBuildProperty element attributes for a build using UrbanCode Deploy:

Team Build Properties - UrbanCode Deploy
name value Description
team.udeploy.personalBuilds true
false
Personal builds: Specify true to enable for personal builds.

Notes

teamBuildProperty Element - Unix Deployment Build

The following table describes the valid values for teamBuildProperty element attributes for a Unix Deployment build:

Team Build Properties - Unix Deployment Build
name value Description
team.deploy.common.deploy.postCommand Deploy post-command: Command to be executed after deployment.
team.deploy.common.deploy.preCommand Deploy pre-command: Command to be executed prior to deployment.
team.deploy.common.isCompletePackage true
false
Deploy complete package: Specify true to deploy complete package.
team.deploy.common.load.ftp.hostname Host name: FTP host name.
team.deploy.common.load.ftp.passwordFile Password file: FTP password file.
team.deploy.common.load.ftp.userid User ID: FTP user ID.
team.deploy.common.load.postCommand Load post-command: Command to be executed after load.
team.deploy.common.load.preCommand Load pre-command: Command to be executed prior to load.
team.deploy.common.loadMethod Copy
ftp
Load method: Specify the type of load method to use and the appropriate command and/or FTP properties. When copy is specified, the FTP host name, user ID, and password file attributes must not be specified. When ftp is specified, the FTP host name, user ID, and password file attributes are required. Valid values are:
Value: Description:
Copy Copy data sets on this system. Note: "Copy" must be specified with a capital "C".
ftp FTP data sets from another system.
team.deploy.common.localPackageRoot.dir Deployed package root directory:* Local package root directory.
team.deploy.common.packagedefinitionUUID Package definition:* Specify the ID of the packaging build definition.
team.deploy.common.publishCumulativeDeploy true
false
Publish cumulative deploy manifest: Specify true to publish the cumulative deployment manifest file in the deployment result.
team.deploy.common.publishDeltaDeploy true
false
Publish delta deploy manifest: Specify true to publish the delta deployment manifest file in the deployment result.
team.deploy.common.publishRollbackManifest true
false
Publish rollback manifest: Specify true to publish the rollback manifest file in the deployment result.
team.deploy.common.remotePackageRoot.dir Original package root directory:* Remote package root directory.
team.deploy.common.rollback.postCommand Rollback post-command: Command to be executed after roll back.
team.deploy.common.rollback.preCommand Rollback pre-command: Command to be executed prior to roll back.
team.deploy.luw.runtimeRoot.dir Runtime root directory: Specify a runtime root directory.

Notes

teamBuildProperty Element - Unix Packaging Build

The following table describes the valid values for teamBuildProperty element attributes for a Unix Packaging build:

Team Build Properties - Unix Packaging Build
name value Description
team.package.common.applicationDescription Description: Specify a description of the application.
team.package.common.applicationName Name:* Specify the name of the application.
team.package.common.excludeFilePath Exclude file: Specify the path to the exclude file to identify which built members to exclude.
team.package.common.isCompletePackage true
false
Complete package: Specify true if the package is a complete application.
team.package.common.isManifestPublished true
false
Publish manifest: Specify true to publish packaging manifest.
team.package.common.isPackagePublished true
false
Publish package: Specify true to publish packaging results.
team.package.common.packageRoot.dir Package root directory:* Specify a directory on the build machine where you want to store all packages.
team.package.common.postPackageCommand Package post-command: Specify a command to run on the build machine after packaging.
team.package.common.prePackageCommand Package pre-command: Specify a command to run on the build machine before packaging.
team.package.common.shiplistFilePath Ship list file:* Specify the path to the ship list file to identify which built members to package.
team.package.common.version Version:* Specify the application version to package.
team.package.luw.buildRoot.dir Build root directory:* Specify a build root directory.

Notes

Build Examples

This section provides Ant script examples for each of the build types.

Ant Build Example

A build using Ant and the Jazz Build Engine.

      
    

Result

Ant Build Example - Overview

Ant Build Example - Properties

Ant Build Example - Jazz Source Control

Ant Build Example - Ant

Ant Enterprise Extensions Build Example

A build on System z using Ant with Enterprise Extensions and the Rational Build Agent.

      
    

Command Line Build Example

A build that invokes a command line using the Jazz Build Engine.

      
    

z/OS Deployment Build Example

Configuration for deploying z/OS applications using the Rational Build Agent.

      
    

z/OS Dependency Build Example

A build on System z using Ant with Enterprise Extensions that determines what to build based on changes since the last successful team build.

      
    

Rational Build Forge Build Example

A build using Rational Build Forge.

      
    

Generic Build Example

A generic build.

      
    

Hudson/Jenkins Build Example

Creates a build definition for a Hudson/Jenkins server.

      
    

IBMi Command Line Build Example

An IBMi build that submits a command using the Jazz Build Engine.

      
    

IBMi Continuous Load Build Example

An IBMi build used to load i artifacts from a Jazz repository workspace to IBMi libraries on a defined schedule.

      
    

IBMi Deployment Build Example

Configuration for deploying IBMi applications using the Rational Build Agent.

      
    

IBMi Dependency Build Example

A build on IBMi using Ant with Enterprise Extensions that determines what to build based on changes since the last successful team build.

      
    

IBMi Packaging Build Example

Configuration for packaging IBMi applications using the Rational Build Agent.

      
    

IBMi Promotion Build Example

A build enabling promotion of components from a source stream to a target stream.

      
    

Microsoft Visual Studio Build Example

A build configuration using Microsoft Build System and the Jazz Build Engine.

      
    

Maven Build Example

A build using Maven 2 and the Jazz Build Engine.

      
    

z/OS Packaging Build Example

Configuration for packaging z/OS applications using the Rational Build Agent.

      
    

z/OS Promotion Build Example

A build that copies dependency build outputs from a source location to a target destination on the build machine.

      
    

Linux/UNIX Deployment Build Example

Configuration for deploying applications on Linux/UNIX using the Rational Build Agent.

      
    

Linux/UNIX Packaging Build Example

Configuration for packaging applications on Linux/UNIX using the Rational Build Agent.

      
    

z/OS Command Line Build Example

A build that invokes a command line using the Rational Build Agent.