The macro is used to set properties and metadata used by the SCM command macros. The macro needs to be executed once per session, prior to the invocation of any SCM subcommand macro.

Attributes

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

Macro Specific Attributes
Attribute	Description	Required
authenticate	The authentication method to use when logging into the EWM^® server. The default is: `PasswordFile`. Valid values are: `Certificate` Authenticate with a user login certificate. `Kerberos` Authenticate with Windows user credentials using Kerberos/SPNeGO. `Password` Authenticate with userid and password. `PasswordFile` Authenticate with userid and password file. `SmartCard` Authenticate with the connected smart card. `Windows` Authenticate with Windows user credentials using Integrated Windows Authentication.	No
repository	The name of a property that contains the address of the team repository to use.	Yes
password	The name of a property that contains the password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both. Note: The password value contained within the property must be encrypted. Any plain-text password value can be encrypted in the proper format using the Build Extensions Toolkit, Build Services Ant Tasks, setPassword task.	No
passwordFile	The path to the password file to use for authentication to the repository. 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
certificate	The path to the file that contains the user’s login certificate for authentication. Requires password or passwordFile to be set.	No
userid	The name of a property that contains the User ID for authentication to the repository. Requires password or passwordFile to be set.	No
cfg	The path to the SCM configuration folder to use. The name of the folder typically is "`.jazz-scm`".	Yes
daemon	Specifies whether or not to use the SCM daemon. Specify `true` to use the daemon (the lscm command). Specify `false` to not use the daemon (the scm command). The default is true.	No
dir	The path to the workspace to use.	Yes
scm	The path to the folder where the SCM program resides, typically "install_directory/scmtools/eclipse".	Yes

Notes

Examples

Set SCM properties:

<?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/folders/fm/s15wygq559xglxd08x43gpzr0000gn/T/MacroTestingScm/.jazz-scm"/>
    <property name="root" value="/var/folders/fm/s15wygq559xglxd08x43gpzr0000gn/T/MacroTestingScm/root"/>
    <property name="scmd" value="/var/folders/fm/s15wygq559xglxd08x43gpzr0000gn/T/MacroTestingScm/scmtools/eclipse"/>
    
    <!-- - - - - - - - - - - - - - - - - - - *
    *  Example                               *
    *- - - - - - - - - - - - - - - - - - - -->
    <target name="main" description="main">
        
        <!-- Scm -->
        <ScmProperties
            authenticate="Password"
            password="passwd"
            userid="userId"
            cfg="conf"
            dir="root"
            scm="scmd"
        />
        
    </target>
    
    <target depends="main" description="all" name="all"/>
</project>

getTaskNameHdr()

Attributes

Notes

Examples