The task is used to create and publish a build map for a buildable file. It is included in the macrodefs.xml macro for an Enterprise Extensions (EE) language definition when appropriate by the Dependency Build process.

Attributes

The task supports Team Build Attributes, Build Extensions Debugging Attributes, Build Extensions General Attributes, as well as, its own task specific attributes. Click on a link for more information on the common attributes.

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

Task Specific Attributes
Attribute Description Required
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. This attribute is used to identify the specific build that created the build map. Yes
buildableFile The name of the data set where the buildable file resides. Yes
file The path to the build map file that will be created. Yes
langDef The name of the EE language definition for the buildable file. Yes
languageCode The type of language associated with the EE language definition identified by the landDef attribute. Yes
preview Specifies whether the build is in preview mode or not. Valid values are true or false. The default is false. No

Output Elements

One or more output elements can be specified within the element. An output element is used to describe output that was generated by the build that is required for the build map. The output element is optional.

The following table describes the valid output element attributes and their options:

Output Element Attributes
Attribute Description Required
buildFile The member name of the generated output file. This is typically the name of a member in the buildPath data set described below. Yes
buildPath The name of the data set where the output file resides. Yes
deployType

Specifies the deployment type. This attribute is only applicable for Deployment builds.

Type: Description:
LOADANDDEPLOY Load the selected package on the deploy system and deploy the loaded package to the target libraries. Note: When LOADANDDEPLOY is specified, the deployed package is deleted from the deploy system, whether or not the deployment is successful. If the deployment fails, the package must be loaded on the deploy system again.
LOAD Load the selected package on the deploy system.
DEPLOY Deploy a previously loaded package to the target libraries. Note: When DEPLOY is specified, the deployed package is deleted from the deploy system, whether or not the deployment is successful. If the deployment fails, the package must be loaded on the deploy system again.
ROLLBACK Rolls back the package to a previously deployed state.
No
hfs Specifies whether or not this item is associated with an HFS build. Valid values are true or false. The default is false. No
if The "if" condition defined for the output. No
outputType Not used. No
prefix Specifies the prefix for the buildPath data set. The default is the value of the ${team.enterprise.scm.resourcePrefix} Dependency Build property. No
refid Specifies the variable name that provides the data set information. No
resourceDefinitionId Specifies the string value for the UUID for the buildPath EE data set definition. Yes
resourceDefinitionStateId Specifies the string value for the state UUID for the buildPath EE data set definition. Yes
sequential Specifies whether or not this item is for a sequential data set. Valid values are true or false. The default is false. No
usedAsInput Specifies whether or not this file is used as input to another step in the build. Yes

BuildLog Elements

One or more buildLog elements can be specified within the element. BuildLog elements are used to describe log or listing files that were generated by the build that are required for the build map. The buildLog element is optional.

The following table describes the valid output element attributes and their options:

Output Element Attributes
Attribute Description Required
compacted Specifies whether or not the log file is to be compacted. Valid values are true or false. The default is false. No
ddIndex Integer index into the list of allocation DD entries defined in the EE translator definition. Indexing starts with 0. Yes
if The "if" condition defined for the log. No
logFile The member name for the log file. Yes
logPath The name of the data set where the log file resides. Yes
prefix Specifies the prefix for the logPath data set. The default is the value of the ${team.enterprise.scm.resourcePrefix} Dependency Build property. No
refid Specifies the variable name that provides the data set information. No
resourceDefinitionId Specifies the string value for the UUID for the logPath EE data set definition. Yes
resourceDefinitionStateId Specifies the string value for the state UUID for the logPath EE data set definition. Yes
sequential Specifies whether or not the log file is a sequential data set. Valid values are true or false. The default is false. No
translatorId Specifies the string value for the UUID for the EE translator definition that generates the log. Yes
translatorStateId Specifies the string value for the state UUID for the EE translator definition that generates the log. Yes

Notes

Examples

Create a build map for a buildable file: 

<antz:buildmap
    buildResultUUID="${buildResultUUID}"
    buildableFile="@{source.dataset}"
    file="@{buildmap}"
    langDef="SHELL Script"
    languageCode="OTH"
    passwordFile="${passwordFile}"
    repositoryAddress="${repositoryAddress}"
    userId="${userId}">
  <antz:output
      buildFile="@{source.member.name}"
      buildPath="SBLZPAX"
      prefix="true"
      resourceDefinitionId="_1i5qUL3CEea3h_tBKdpO5Q"
      resourceDefinitionStateId="_BkuowF_TEeiDEPrvdFUsGg"
      usedAsInput="false"/>
</antz:buildmap>

Create a build map for a buildable file with output and build logs: 

<antz:buildmap buildResultUUID="${buildResultUUID}" buildableFile="@{source.dataset}" file="@{buildmap}" langDef="PLX" languageCode="OTH" passwordFile="${passwordFile}" repositoryAddress="${repositoryAddress}" userId="${userId}">
   <antz:buildLog ddIndex="4" logFile="@{source.member.name}" logPath="PLXLIST" prefix="true" resourceDefinitionId="_v0z-0NYfEeGBNoo6rO7vVQ" resourceDefinitionStateId="_6DQ34D5VEeqAh97DQt-YiQ" translatorId="_8NJ0gNYfEeGBNoo6rO7vVQ" translatorStateId="_pg9g0CGHEey9F8aNMT3Yug"/>
   <antz:buildLog ddIndex="2" logFile="@{source.member.name}" logPath="LIST" prefix="true" resourceDefinitionId="_uH9bcNYfEeGBNoo6rO7vVQ" resourceDefinitionStateId="_duJ6gAaREeqY-_ZlRJDgPQ" translatorId="_73AlYNYfEeGBNoo6rO7vVQ" translatorStateId="_Se3BYBRFEey9M5_2lsgQ1g"/>
   <antz:output buildFile="@{source.member.name}" buildPath="SBLZLOAD" if="${ID15}" prefix="true" resourceDefinitionId="_zlcX0NYfEeGBNoo6rO7vVQ" resourceDefinitionStateId="_uaOjUC4HEeuR4oEGCF8QGA" usedAsInput="false"/>
   <antz:output buildFile="@{source.member.name}" buildPath="SBLZAUTH" if="${ID16}" prefix="true" resourceDefinitionId="_p73eAJbIEeK5iZAOG25qNQ" resourceDefinitionStateId="_n_U8cS4HEeuR4oEGCF8QGA" usedAsInput="false"/>
   <antz:buildLog ddIndex="4" logFile="@{source.member.name}" logPath="LMAP" prefix="true" resourceDefinitionId="_0QkYcNYfEeGBNoo6rO7vVQ" resourceDefinitionStateId="_aAzBQL-9EeeLhvio9QXMvw" translatorId="_9OEe8NYfEeGBNoo6rO7vVQ" translatorStateId="_oVyJ5r-9EeeLhvio9QXMvw"/>
</antz:buildmap>