The macro is used to create a repository workspace. If you specify a flow target or snapshot, the repository workspace will be populated with the components of that stream or snapshot.

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
empty	Specify `true` to create an empty workspace. A default component will not be created for the workspace.	No^*
duplicate	The workspace to duplicate. To specify the workspace, use the name[@repo], alias, or UUID[@repo].	No^*
historyRef	The history reference to use as the initial workspace history. To specify the history reference, use its alias, or UUID[@repo]. History references can be obtained with the "show operations" command.	No^*
name	The name of the workspace.	Yes
snapshot	The snapshot to use as the initial workspace history. To specify the snapshot, use name[@repo], alias, or UUID[@repo].	No^*
stream	The stream or workspace to set as the default flow target and initial workspace history. To specify the stream or workspace, use its name[@repo], alias, or UUID[@repo].	No^*

Notes

^*Specify only one of the empty, duplicate, historyRef, snapshot, or stream attributes.
This macro specifies the following options on the SCM command:
- --empty
- --duplicate <arg>
- --historyRef <arg>
- --snapshot <arg>
- --stream <arg>
The following options can be added to the command using the additionalArgs element:
- --description <arg>
- --json

Examples

Load and duplicate 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}"/>
        
        <!-- Create -->
        <ScmCreateWorkspace duplicate="${workspace}" name="${workspace}.new"/>
       
    </target>
    
    <target depends="main" description="all" name="all"/>
</project>

getTaskNameHdr()

Attributes

Notes

Examples