startBuildActivity

The startBuildActivity task starts a new build activity for a build. A build might have multiple activities in progress at any time. You can organize activities hierarchically. When an activity is started, you can specify an existing parent activity for it. Activities can be completed explicitly (see completeBuildActivity) or automatically if the autoComplete attribute is set.

The table below describes startBuildActivity task attributes.

Attribute Description Required

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.

Yes

repositoryAddress

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

Yes

userId

User ID to use.

Yes

label

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

Yes

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.

No

autoComplete

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.

No

failOnError

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

No

parentActivityID

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

No

password

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

No

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.

No

verbose

Specifies more message output. The default is false.

No

Example

<startBuildActivity repositoryAddress="${repositoryAddress}"
		                    userId="${userId}"
		                    password="${password}"
		                    activityIdProperty="activityId"
		                    label="compiling"
		                    autoComplete="false"
		                    verbose="true"
		                    buildResultUUID="${buildResultUUID}" />

Feedback