The macro is a wrapper method for calling tasks that support all Team Build login options; it handles all login option processing, as well as, all task-specific processing needs. The macro greatly reduces the volume of code needed to support all of the login attributes and options for a Team Build task.

Attributes

The macro supports Team Build Attributes, as well as, its own macro specific attributes. Click on a link for more information on the common attributes.

The following table describes the macro specific attributes for the macro:

Task Attribute Elements

A Task Attribute element is required for each attribute to be passed to the called Team Build task that is not one of the common Team Build attributes documented here. For example: if the task is startBuildActivity, you would specify three Task Attribute elements, one each for: autoComplete, buildResultUUID, and label.

The following table describes the valid Task Attribute element attributes and their options:

Task Element Elements

Some Team Build tasks support embedded elements. The TeamTask macro supports embedded elements with Task Element elements. Specify each Team Build task embedded element in an embedded Task Element element. Thankfully, the Task Element element does not support attributes.

Notes

• None

Examples

• Use the TeamTask macro to call the startBuildActivity Team Build task using just the Password Login Option:
  

  <TeamTask
          task="startBuildActivity"
          repositoryAddress="${repositoryAddress}"
          userId="${userId}"
          password="${password}"
      >
      <taskAttribute name="autoComplete" value="true"/>
      <taskAttribute name="buildResultUUID" value="${buildResultUUID}"/>
      <taskAttribute name="label" value="${label}"/>
  </TeamTask>
          

• Use the TeamTask macro to call the startBuildActivity Team Build task supporting all login options. Note that the required information for each login method still needs to be specified, but that all other information can simply be left empty. Also note that no matter what login method is used, this example code would remain the same:
  

  <TeamTask
          task="startBuildActivity"
          repositoryAddress="${repositoryAddress}"
          userId="${userId}"
          password="${password}"
          certificateFile="${certificateFile}"
          integratedWindows="${integratedWindows}"
          kerberos="${kerberos}"
          passwordFile="${passwordFile}"
          repositoriesFile="${repositoriesFile}"
          smartCard="${smartCard}"
          failOnError="${failOnError}"
          reuseLoginOption="${reuseLoginOption}"
          verbose="${verbose}"
      >
      <taskAttribute name="autoComplete" value="true"/>
      <taskAttribute name="buildResultUUID" value="${buildResultUUID}"/>
      <taskAttribute name="label" value="${label}"/>
  </TeamTask>
          

• Use the TeamTask macro to call the getWorkItem Team Build task supporting all login options. Note that the getWorkItem task is a namespace referenced task which requires embedded elements:
  

  <xt:addReference>
      <xt:getWorkItem id="getWorkItemTaskReference"/>
  </xt:addReference>
  
  <TeamTask
          refid="getWorkItemTaskReference"
          repositoryAddress="${repositoryAddress}"
          userId="${userId}"
          password="${password}"
          certificateFile="${certificateFile}"
          integratedWindows="${integratedWindows}"
          kerberos="${kerberos}"
          passwordFile="${passwordFile}"
          repositoriesFile="${repositoriesFile}"
          smartCard="${smartCard}"
          failOnError="${failOnError}"
          reuseLoginOption="${reuseLoginOption}"
          verbose="${verbose}"
      >
      <taskAttribute name="workItemId" value="${workItemId}"/>
      <taskElement>
          <xt:fetch name="approvals" property="lcl.approvals" ApprovalsJson="true"/>
      </taskElement>
  </TeamTask>