teamFetch

The teamFetch task fetches the contents of a repository workspace into a local destination directory.

You can use load rules to specify which content to fetch. Otherwise, the contents of all specified components are fetched. You cannot use a load rule to fetch an excluded component.

The following table contains teamFetch task attributes.

Attribute Description Required

destination

Local directory where the fetched files are stored.

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 for authentication to the repository. Requires password or passwordFile to be set.

Yes

workspaceName

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

Yes

Note: Either workspaceUUID or workspaceName must be given, but not both.

workspaceUUID

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

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

Yes

Note: Either workspaceUUID or workspaceName must be given, but not both.

componentLoadConfiguration

When loadPolicy is set to useComponentLoadConfig, this attribute determines whether to load all components or exclude some components during load. Valid values are loadAllComponents and excludeSomeComponents.

No

expandKeywords

When enabled, any occurrence of a keyword in a file is converted to its expanded form. For example, the expanded form of $VersionId$ is the following for a file whose version id is 10: $VersionId: 10$.

No

loadPolicy

Determines whether to load the repository workspace according to componentLoadConfiguration or use a load rule file. Valid values are useLoadRules and useComponentLoadConfig.

No

loadRulesByPath

Specifies the path to a load rule file. The path begins with the component name followed by the full path to the load rule file in the repository. Use forward slashes (/) to separate path segments. Use a semicolon (;) to separate multiple load rule files.

No

Note: Either loadRulesByPath or loadRulesByUUID can be given, but not both.

loadRulesByUUID

Specifies the UUIDs to the load rule file. The UUIDs are the item ids of the component and load rule file. To get the UUIDs, use the web client to navigate to the load rule file (the URL specifies the item ids). The id of the component is followed by the id of the file. Use spaces to separate multiple load rule files.

No

Note: Either loadRulesByPath or loadRulesByUUID can be given, but not both.

certificateFile

The path to the file that contains the user's login certificate for authentication. Requires password or passwordFile to be set. You can specify certificateFile or repositoriesFile, but not both.

No

buildResultUUID

For teamFetch task, this build result will be updated with the build workspace information. 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.

No

componentsToExcludeByName

Specifies which components to exclude, giving the names (separated by semicolon).

No

Note: Either componentsToExcludeByName or componentsToExcludeByUUID can be given, but not both.

componentsToExcludeByUUID

Specifies which components to exclude, giving the component item ids (UUIDs, separated by space).

No

Note: Either componentsToExcludeByName or componentsToExcludeByUUID can be given, but not both.

createFoldersForComponents

If true, component roots will be loaded as directories in the file system.

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

maxScmContentThreads

Updates the number of simultaneous transfers that can occur at one time. The Ant attribute value cannot be negative. Default value is 10.

No

integratedWindows

Whether to use Integrated Windows Authentication

No

kerberos

Whether to use Windows user credentials using Kerberos/SPNeGO.

No

password

Password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both.

No

passwordFile

The password file to use for authentication to 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. Either password or passwordFile can be provided, but not both.

No

preserveFileTimestamps

When repository files are loaded, the timestamp from the file in the repository is used as the timestamp on disk (true).

No

repositoriesFile

The repositories registry file containing a listing of repositories and their login credentials. You can specify repositoriesFile or certificateFile, but not both. If you specify repositoriesFile, do not specify either password or passwordFile. The repositories file is created and updated through the use of scm login and logout commands.

No

reuseLoginOption

The first time an Ant task logs in to a repository, a connection is not terminated at the end of this task. All subsequent tasks reuse this connection as long as they connect to same repository with same user ID. When a task logs in to a different repository or with a different user ID, the previous connection is terminated and a new connection is created and reused.

No

smartCard

Whether to use the connected smart card for authentication (true or false). Requires userId to be set. For more information about smart card authentication, see Connecting to repositories and project areas.

No

verbose

Specifies more message output. The default is false.

No

Example

<mkdir dir="${java.io.tmpdir}/toolkittest" />
<teamFetch repositoryAddress="${repositoryAddress}"
                           userId="${userId}"
                           password="${password}"
                           workspaceName="workspace1"
                           buildResultUUID="${buildResultUUID}"
                           destination="${java.io.tmpdir}/toolkittest"
                           componentsToExcludeByName="Component 1;Component 2"
                           verbose="true" />

In the following example, two load rule files are specified by path. The first load rule is in the component MainComponent at Releng/loadRules/testBuild.loadRule. The second rule is in the component TestComponent at Test/teamA.loadRule.

<teamFetch repositoryAddress="${repositoryAddress}"
                           userId="${userId}"
                           password="${password}"
                           workspaceName="workspace1"
                           buildResultUUID="${buildResultUUID}"
                           destination="${java.io.tmpdir}/toolkittest"
                           loadRulesByPath="MainComponent/Releng/loadRules/testBuild.loadRule;TestComponent/Test/teamA.loadRule"
                           verbose="true" />

In the following example, two load rule files are specified by UUID. The load rule file with item id CvIiUIOlEeO3fKSFDyJm1g is in the component with item id yamC4NWiEdylmcAI5HeTUQ. The load rule file with item id kkmC4NWiEdylmcAI5HeTUQ is in the component with item id hHRgsYqSEdyfxpVoexuVpg.

<teamFetch repositoryAddress="${repositoryAddress}"
                           userId="${userId}"
                           password="${password}"
                           workspaceName="workspace1"
                           buildResultUUID="${buildResultUUID}"
                           destination="${java.io.tmpdir}/toolkittest"
                           loadRulesByUUID="_yamC4NWiEdylmcAI5HeTUQ _CvIiUIOlEeO3fKSFDyJm1g _hHRgsYqSEdyfxpVoexuVpg _kkmC4NWiEdylmcAI5HeTUQ"
                           verbose="true" />

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki