Ant attribute reference

This topic describes Jazz™ Team Build Ant task attributes.

The table below describes Jazz Team Build Ant task attributes.

Attribute Description

activityId

Unique identifier of the build activity. The activityId passed to completeBuildActivity is held in a property set by the startBuildActivity task. Specify the activityId attribute value by using the ${} property value substitution syntax.

activityIdProperty

Stores the unique ID of a newly started activity. Only required if the caller intends to explicitly complete this activity using the completeBuildActivity task or if this activity is used as a parent for child activities.

autoComplete

For the startTeamBuild task, specifies whether the build should be completed automatically. The default is true. When this attribute is true, you must use the parameter -listener com.ibm.team.build.ant.listener.TeamBuildListener when launching Ant.

For the startBuildActivity task, specifies whether to complete the activity automatically in any of the following situations: the parent activity is completed, the next peer activity starts, or the build is completed The default is false.

buildDefinitionId

For the getNextTeamBuildRequest task, specifies a build definition ID to check for pending requests. If the build definition id is not supported by the specified build engine, then a request is not retrieved.

For the requestTeamBuild task, the identifier of the build definition to use.

For the startTeamBuild task, the build definition of the build to start. Required if requestUUID is not specified.

buildDefinitionIdProperty

Stores the build definition id of the next build request for the specified engine. It is defined only if a request for the specified engine is retrieved. Does not apply if buildDefinitionId is specified.

buildLabel

The build label that was generated by the Jazz Build Engine. For example, 20080215-1234.

buildLabelPrefix

Specifies a prefix for the build label, such as I for integration. If you define this property in your build definition or build engine, the value is prepended to the label that the Jazz Build Engine generates. For example, I20080215-1234.

buildResultUUID

The UUID of the build result to update. The value of this attribute is typically ${buildResultUUID} because the property is built-in when using the Jazz Build Engine.

For the completeBuild task, the UUID of the build result to complete.

For the teamAccept task, the build result to update with the snapshot information. The snapshot can be used to recreate the build workspace at a later time.

For teamFetch task, this build result will be updated with the build workspace information. This enables the build workspace to be recreated at a later time from the build result. This attribute should be set on at most one invocation of this task per build. Build results cannot have more than one workspace associated with them. This task throws an exception if the build result already has a workspace associated with it.

For waitForTeamBuild, the UUID of the build result that is waited on. This is typically specified if the build was started using {@link StartBuildTask}, which returns the build result uuid in the property specified by the resultUUIDProperty attribute.

buildNotNecessary

Set to true if the build was not necessary. For example, a build might not be necessary if there have been no source changes since the previous build. Only use this attribute in an Ant script that controls the entire build lifecycle.

buildStateProperty

The property to write the state of the build when the task finishes waiting. It is only set if the build entered one of the specified states to wait for.

buildStatusProperty

The property gets assigned the status of the build, where the value is one of OK, INFO, WARNING, or ERROR.

changeSetFile

File to use to store serialized change sets.

changesAcceptedProperty

Stores the number of change sets accepted. The property is defined and set only if at least one change set is accepted.

componentMap

Path to a file that contains package-name-to-component mapping information.

The path to a file that contains package-name-to-component mapping information. The package name must match the package for the test suite class.

componentName

The specific component to associate with this contribution.

contentType

The type of the artifact. If not specified, it is set to application/unknown.

For the filePublisher task, the type of the artifact. If not specified, the default is application/unknown.

For the logPublisher task, the type of the artifact. If not specified, the default is text/plain.

contributionTypeId

The extended contribution type ID of this contribution.

characterEncoding

The character encoding used in the artifact file. It must be an IANA-compliant name. Defaults to the default encoding of the current platform. For more information, see IANA List of Character Set Names.

deletePropertiesFile

Path to a properties file. This properties file specifies properties that should be omitted when the build is run. The properties are assumed to exist in the build definition. The path can be a relative path from the base directory of the build file or a full path.

deleteAllowed

Sets whether the build result can be deleted.

destination

Local directory where the fetched files are stored.

engineId

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

For the startTeamBuild task, the identifier of the build engine that runs the build. Required if the requestUUID is not specified.

failOnError

If true (the default), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

filePath

For tasks that need an input file, specifies the path to a file. It can be an absolute path or a path relative to the base directory of the build file.

The path to the XML log, or a path to a directory containing XML logs. The path can be a relative path from the base directory of the build file or a full path.

For the jdtCompileLogPublisher task, the path to the JDT compiler log file or directory of files to publish.

For the filePublisher task, the path to the file or directory of files to publish.

For the workItemPublisher task, set to the path to a change set file output from the teamAccept task, or a work item file. A work item file must contain work item IDs one per line. The path can be relative to the base directory of the build file or an absolute path.

For mstestLogPublisher, the path to the TRX XML log, or a path to a directory containing TRX XML logs. The path can be a relative path from the base directory of the build file or a full path.

inputFileType

For the workItemPublisher task, this flag indicates whether the filePath attribute indicates a change set file or a work item file. Valid values are CHANGESET and WORKITEM. If this attribute is not specified, the task assumes the filePath attribute points to a changeset file.

interval

The time between checks to determine if the build is in the required state. The value is in seconds and must be greater than zero and less than or equal to the timeout value. The default is to check every 30 seconds.

label

Label to use for the build.

For the startBuildActivity, the label that describes the build activity. If not specified, the value for the activityID is used as the label.

LocalFilePath

A path to a local file that is used to compute the file size for the published link.

mayFailPattern

A substring of a test suite class name. Any test suite class name that contains the pattern is allowed to fail without causing the overall build to fail. The pattern is a simple string, not a regular expression. If not specified, any test suite failure causes the build to fail.

overridePropertiesFile

Path to a properties file. This properties file can add new properties or override existing properties in the build definition. The path can be a relative path from the base directory of the build file or a full path.

outputPropertiesFile

Specifies an output file that will be written to contain a property for each directory under sourceDirectory. This properties file contains folder paths and timestamps which describe the modification time for each of the folders in the sourceDirectory. Each property's value is its last modified time in GMT. The file is formatted as a java style properties file. For example:

  • com.ibm.team.scm.admin.service=200803060309
  • com.ibm.team.scm.client=200803060309
  • com.ibm.team.scm.feature.server=200803060309

parentActivityID

The identifier of an existing activity to use as the parent. An activity with this identifier must exist and must not be complete.

password

Password for the user ID, a zero-length string by default unless specified.

passwordFile

The password file to use for the connection. You can create a suitable password file by invoking the Jazz Build Engine with the -createPasswordFile argument. You can only specify one password file.

pdeBuild

If true, the publisher interprets the log directory structure as being generated by pde build. A plug-ins directory must appear in the hierarchy under the given filePath. The publisher groups packages by plugin.

rawOutputPropertiesFile

Path to a properties file. The path can be a relative path from the base directory of the build file or a full path. This properties file contains internal folder and baseline ids which describe the latest baselines for each of the folders in the "sourceDirectory

requestUUID

Specifies an existing build request to use when starting the build. If specified, the buildDefinitionID and the engineID cannot be specified.

For waitForTeamBuild, the UUID of the build request that is waited on. This is typically specified if the build was requested using {@link RequestBuildTask}, which returns the build request uuid in the property specified by the requestUUIDProperty attribute.

requestUUIDFile

Path to the file in which to store the UUID of the next build request for the specified build engine. The path can be relative to the base directory of the build file or a full path. The file is formatted as a java.util.Properties format and contains a property with the name specified by the requestUUIDProperty.

requestUUIDProperty

Stores the UUID of the retrieved build request. It is set only if a request is found.

repositoryAddress

Address of the team repository to use. The value of this attribute is typically ${repositoryAddress} because that property is built-in when using the Jazz Build Engine.

resultUUIDFile

File to use to store the build result. The path can be a relative path to the base directory of the build file or a full path. The file is formatted in java.util.Properties format and contains a property with the name specified by the resultUUIDProperty attribute.

resultUUIDProperty

Property to store the UUID of the build result.

snapshotName

Name for a snapshot that is created in the workspace.

snapshotUUIDProperty

Provides a property name to access the UUID of the snapshot that is created.

sourceDirectory

For the pluginOrganizer task, the source directory to use. It is assumed to have plugin and feature directories.

For the teamLastModified task, a directory location in the local file system. The value of the sourceDirectory attribute must be the root of the Jazz repository workspace. For example, if the teamFetch task fetches to c:\fetched , the sourceDirectory in the teamLastModified should be c:\fetched. This task is not compatible with the scmtools command line utility.

statesToWaitFor

A comma separated list of build state names. Defaults are COMPLETED and INCOMPLETE. Valid values are the following:
  • NOT_STARTED: a requested build has not started. Also referred to as pending.
  • IN_PROGRESS: the build is in progress.
  • COMPLETED: the build completed normally, but can contain errors.
  • CANCELED: the build request is canceled before the build started.
  • INCOMPLETE: the build did not complete normally. Also referred to as abandoned.

status

Status to set in the IBuildResultContribution. Valid values are OK, ERROR, and WARNING.

tags

Sets the tags for the build result. Individual tags within the string are separated by comma or space.

targetDirectory

The directory to move content to.

timeout

The maximum amount of time that the task waits on the build. The value is in seconds and must be greater than zero. The default is to wait forever.

timestampFormat

A time stamp format, such as http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html. Default is yyyyMMddHHmm.

url

URL of the link.

userId

User ID to use.

verbose

Specifies more message output. The default is false.

workspaceUUID

For the teamAccept task, the UUID of the workspace into which to accept changes.

For the teamFetch task, the UUID of the workspace from which to fetch.

For the teamLastModified task, the UUID of the workspace context to use.

If you have multiple workspaces with the same name, you may need to use this attribute instead of workspaceName.

workspaceName

For the teamAccept task, the name of the workspace into which to accept changes.

For the teamFetch task, the name of the workspace from which to fetch.

For the teamLastModified task, the name of the workspace to use.


Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug