The macro is used to list the change sets that are in the repository.

Attributes

The macro supports the SCM Macro Common Attributes, as well as, its own macro specific attributes. Click on the link for more information on the common attributes.

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

Macro Specific Attributes
Attribute	Description	Required
baseline	The baseline, as specified by its name, alias or UUID. When you specify this option, you must also specify a component using the additionalArgs element described below.	No^*
component	The component to select. Specify the name, alias, or UUID of the component.	No^*
workitems	Lists change sets associated with the specified work items. Specify the ID of the work item.	No^*
workspace	The workspace or stream, as specified by its name, alias, or UUID.	No^*

Notes

^*Specify only one of the baseline, component, workitems, or workspace attributes.
This macro specifies the following options on the SCM command:
- --baseline <arg>
- --component <arg>
- --workitems <arg>
- --workspace <arg>
The following options can be added to the command using the additionalArgs element:
- --created-after <arg>
- --created-before <arg>
- --creator <arg>
- --include-child-workitems
- --json
- --maximum <arg>
- --name <arg>
- --path <arg>
- --suspendedby <arg>
- --type <arg>

Examples

List change sets in a workspace:

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM
    (c) Copyright IBM Corporation 2020. All Rights Reserved.
    
    Note to U.S. Government Users Restricted Rights:
    Use, duplication or disclosure restricted by GSA ADP Schedule
    Contract with IBM Corp.
-->
<project
    basedir="."
    default="all"
    name="Example"
    xmlns:xt="antlib:com.ibm.team.build.extensions.toolkit">
    <description>Example</description>
    
    <!-- Load build extensions -->
    <xt:loadBuildExtensions/>
    <xt:getJarLocation property="jarPath"/>
    
    <!-- Load common resources -->
    <import>
        <javaresource name="scripts/smpe/imports/$common.xml">
            <classpath location="${jarPath}"/>
        </javaresource>
    </import>
    <import>
        <javaresource name="scripts/smpe/imports/$scmcmd.xml">
            <classpath location="${jarPath}"/>
        </javaresource>
    </import>
    
    <xt:setPassword password="${password}" property="passwd"/>
    <property name="userId" value="ADMIN"/>
    <property name="conf" value="/var/MacroTestingScm/.jazz-scm"/>
    <property name="root" value="/var/MacroTestingScm/root"/>
    <property name="scmd" value="/var/MacroTestingScm/zips/scmtools/eclipse"/>
    
    <!-- - - - - - - - - - - - - - - - - - - *
    *  Example                               *
    *- - - - - - - - - - - - - - - - - - - -->
    <target name="main" description="main">
        
        <!-- Scm -->
        <ScmProperties
            authenticate="Password"
            repository="repositoryAddress"
            password="passwd"
            userid="userId"
            cfg="conf"
            dir="root"
            scm="scmd"
        />
        
        <!-- List -->
        <ScmListChangesets workspace="${workspace}"/>
       
    </target>
    
    <target depends="main" description="all" name="all"/>
</project>

getTaskNameHdr()

Attributes

Notes

Examples