The macro is used to touch "done" and "submitted" files associated with a Build Orchestrator build.

Attributes

The macro supports Team Build Attributes, as well as, its own macro specific attributes. Click on a 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
activityLabel	The label of the current parent build activity. Child build activities will be created by this macro using the following label pattern: `@{activityLabel}.childStep`. The default is: `${lblMainParent}`.	No
buildId	The ID of the currently running Build Orchestrator build. The value of this attribute is typically `${buildDefinitionId}` because the property is built-in when using the Jazz Build Engine. The default is: `${buildDefinitionId}`.	No
buildResultUUID	The UUID of the build result. The value of this attribute is typically `${buildResultUUID}` because the property is built-in when using the Jazz Build Engine. The default is: `${buildResultUUID}`.	No
doneDirectory	The path on the build machine to the directory where "done" files are stored.	No
parent	The identifier of an existing activity to use as the parent. An activity with this identifier must exist and must not be complete. The default is: `${team.enterprise.build.ant.buildActivityId}`.	No

Notes

This macro should be executed at the end of every orchestrated build via a post-build exit. It is responsible for declaring a build "done".

Examples

Declare the orchestrated build done:

<?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/$bldmac.xml">
            <classpath location="${jarPath}"/>
        </javaresource>
    </import>
    
    <!-- - - - - - - - - - - - - - - - - - - *
    *  Example                               *
    *- - - - - - - - - - - - - - - - - - - -->
    <target name="main" description="main">
        
        <-- Done -->
        <BuildOrchestratorTouch
                activityLabel="${lblMainParent}"
                buildId="${buildDefinitionId}"
                buildResultUUID="${buildResultUUID}"
                doneDirectory="${dir.done}"/>
        
    </target>
    
    <target depends="main" description="all" name="all"/>
</project>

getTaskNameHdr()

Attributes

Notes

Examples