The macro is used to unload the workspace, component, or root paths. If no argument is specified, the workspace is determined from the current working directory.

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
all	Specify `true` to unload all the workspaces of the specified repository in the current sandbox. The default is `false`.	No^*
component	Specify the first component to unload. To specify the component, use the component name[@repo], alias, or UUID[@repo]. Additional components can be added with separate arg elements specified first in an embedded additionalArgs element.	No^*
path	The root paths to unload. If the path is not a root path, the operation has no effect.	No^*
workspace	The workspace to unload. To specify the workspace, use its name[@repo], alias, or UUID[@repo].	No^*

Notes

^*Specify only one of the all, component, path, or workspace attributes.
This macro specifies the following options on the SCM command:
- --all
- --components
- --directory <arg>
- --paths
- --workspace <arg>
The following options can be added to the command using the additionalArgs element:
- --delete
- --no-local-refresh
- --ignore-uncommitted

Examples

Unload 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"
        />
        
        <!-- Load -->
        <ScmLoadWorkspace workspace="${workspace}"/>
        
        <!-- Unload -->
        <ScmUnload workspace="${workspace}"/>
       
    </target>
    
    <target depends="main" description="all" name="all"/>
</project>

getTaskNameHdr()

Attributes

Notes

Examples