The Ant resource represents a buildable file for the build. The buildableSet resource collection is a collection of resource items.

Attributes

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

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

Task Specific Attributes
Attribute Description Required
buildFile The name of the file to be built. For z/OS builds this is typically the member name in the data set specified by buildPath. For other builds this is typically the file name of the resource. Yes
buildMacro The unique name of the macrodefs.xml macro that compiles this resource. Yes
buildPath The path to the file to be built. For z/OS builds this is typically the data set name for the library that contains the member, buildFile, to be built. For other builds this is typically the file system path to the resource. Yes
componentName The name of the EWM® SCM component where the resource resides. Yes
hfs Specifies whether or not this is an HFS resource. Valid values are true or false. The default is false. No
inputType The input type, or file extension, for the resource. Yes
langDefName The name of the Enterprise Extensions (EE) language definition to which the resource is assigned. Yes
langDefStateId The state UUID of the EE language definition to which the resource is assigned. Yes
languageCode The language code for the EE language definition to which the resource is assigned. Yes
objLib The object library for the resource. Yes1
projectName The name of the EWM project where the resource resides. Yes
reason

The build reason code. This is an integer with one of the following values:

Reason: Description:
-1 Not a dependency build.
0 No reason.
1 File changed.
2 Dependencies changed.
3 Generated inputs changed.
4 No buildmap found.
5 Dependency set changed.
6 Output file changed.
7 Always build.
Yes
rebuild Specifies whether or not a rebuild is required. Valid values are true or false. The default is true. No
srcLib The source library for the resource. Yes1
text The nested text specified with the element. No
uuid The SCM file item UUID for the resource. Yes
versionId The SCM version ID for the resource. Yes
1 Applicable for IBMi systems only.
2 Applicable for z/OS systems only.

File Elements

Build file elements are specified within the element. Build file elements define extended information to the build process: input dependency files, output files, and BLZLKEPS parser output information. Input dependency files are specified as file elements within a dependency-set element: 

<ds:dependency-set>
  ${commonTxt.c108}&lt;inputs:file rdf:parseType="Resource"&gt;${commonTxt.c109}
    <inputs:buildFile>BLZSLDS</inputs:buildFile>
    <inputs:buildPath>JAZZ00.V703.BUILT.GMLJPN</inputs:buildPath>
    <inputs:type>SELF</inputs:type>
    ...
  ${commonTxt.c108}&lt;/inputs:file&gt;${commonTxt.c109}
  ${commonTxt.c108}&lt;inputs:file rdf:parseType="Resource"&gt;${commonTxt.c109}
    <inputs:buildFile>BLZSLDSB</inputs:buildFile>
    <inputs:buildPath>JAZZ00.V703.BUILT.GMLINC</inputs:buildPath>
    <inputs:type>DTLINC</inputs:type>
    ...
  ${commonTxt.c108}&lt;/inputs:file&gt;${commonTxt.c109}
  ${commonTxt.c108}&lt;inputs:file rdf:parseType="Resource"&gt;${commonTxt.c109}
    <inputs:buildFile>BLZ@ENT1</inputs:buildFile>
    <inputs:buildPath>JAZZ00.V703.BUILT.GMLJPN</inputs:buildPath>
    <inputs:type>DTLINC</inputs:type>
    ...
  ${commonTxt.c108}&lt;/inputs:file&gt;${commonTxt.c109}
</ds:dependency-set>

Output files are specified as file elements within an outputs element: 

<bf:outputs>
  ${commonTxt.c108}&lt;outputs:file&gt;${commonTxt.c109}
    ...
  ${commonTxt.c108}&lt;/outputs:file&gt;${commonTxt.c109}
</bf:outputs>

Parser output files are specified as file elements within a buildable element: 

<bf:buildable>
   ${commonTxt.c108}&lt;bf:file bf:uuid="_6CIpEC9SEe2mLLbAK0ghoA"/&gt;${commonTxt.c109}
</bf:buildable>

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

File Element Attributes
Attribute Description Required
buildFile The name of the file. For z/OS builds this is typically the member name in the data set specified by buildPath. For other builds this is typically the file name of the resource. Yes
buildPath The path to the file. For z/OS builds this is typically the data set name for the library that contains the member to be built. For other builds this is typically the file system path to the resource. Yes
componentName The name of the EWM SCM component where the file resides. Yes
componentUUID The UUID of the EWM SCM component where the file resides. Yes
consumableAsSource Specifies whether or not this file is consumable as source. Valid values are true or false. The default is false. No
deployType

Specifies the deployment type. Valid values are:

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
doLoad Specifies whether or not to load the file on the build machine. Valid values are true or false. The default is true. No
fileStateUUID The state UUID for the file. Yes
fileUUID The item UUID for the file. Yes
hfs Specifies whether or not this is an HFS resource. Valid values are true or false. The default is false. No
inputType The input type, or file extension, for the resource. Yes
module Deprecated. No
outputType Deprecated. No
parserOutputBuildPath Path to unresolved parser output file. No
pathName The path to the file within the zProject. For example: zOSsrc/GMLINC/BLZSLDSB.gmlinc. Yes
promotionBuildPath The path to the item that is built by the build. Yes
resolvedTo The "resolved to" build path. No
resourceDefinitionStateUUID The state UUID of the resource definition to which the file is assigned. Yes
resourceDefinitionUUID The item UUID of the resource definition to which the file is assigned. Yes
scmLocation The SCM path to the file including the project name. For example: com.ibm.teamz.ispf.client/zOSsrc/GMLINC/BLZSLDSB.gmlinc. Yes
sequential Specifies whether or not this is a sequential file. Valid values are true or false. The default is false. No2
serviceProgram Deprecated No
timestamp A timestamp value for the file. Yes
type

The name of the dependency type. Valid values are:

Type: Description:
COPY COBOL COPY statements and PL/I %INCLUDE statements
DSPF External file DSPF External file
DTLGML DTL GML file
DTLINC DTL include
ILE CL External file ILE CL External file
-INC CA Easytrieve -INC statements
++INCLUDE CA Easytrieve ++INCLUDE statements
LF External file LF External file
MACRO Assembler MACRO calls
MACRO_DEF Assembler MACRO definition
OPM CL External file OPM CL External file
PF External file PF External file
PGM External file PGM External file
PROC JCL PROC invocations
PRTF External file PRTF External file
RPG COPY RPG /COPY or /INCLUDE statements
RPG External Data RPG External Data
RPG External File RPG External File
RPG SQL INLCUDE EXEC SQL INCLUDE statements
RPGLE COPY RPG /COPY or /INCLUDE statements
RPGLE SQL INLCUDE EXEC SQL INCLUDE statements
SELF The file itself
SQL INCLUDE EXEC SQL INCLUDE statements
SRVPGM Export file SRVPGM Export file
SRVPGM External file SRVPGM External file
UNKN Unknown
ZUNITINC Zunit include
No
1 Applicable for IBMi systems only.
2 Applicable for z/OS systems only.

Variables Element

The variables element is specified within the element. It is a container for variable elements. Variable elements define the name and value of a build variable: 

<bf:variables>
  ${commonTxt.c108}&lt;bf:variable&gt;${commonTxt.c109}
    <bf:name>OPTIONS</bf:name>
    <bf:value>LIST,LET,MAP,XREF,REUS,RENT,AMODE=31,RMODE=ANY,AC=1</bf:value>
  ${commonTxt.c108}&lt;/bf:variable&gt;${commonTxt.c109}
  ${commonTxt.c108}&lt;bf:variable&gt;${commonTxt.c109}
    <bf:name>AUTHORISED</bf:name>
    <bf:value>true</bf:value>
  ${commonTxt.c108}&lt;/bf:variable&gt;${commonTxt.c109}
</bf:variables>

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

Variable Element Attributes
Attribute Description Required
name The name of the variable. Yes
value The value of the variable. Yes

Work Items Element

The workItems element is specified within the element. It is a container for workItem elements. Work item elements define the ID of a work item associated with the build: 

<bf:workItems>
  ${commonTxt.c108}&lt;bf:workItem&gt;${commonTxt.c109}
    <bf:id>568432</bf:id>
  ${commonTxt.c108}&lt;/bf:workItem&gt;${commonTxt.c109}
</bf:workItems>

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

Work Item Element Attributes
Attribute Description Required
id The string representation of the integer work item ID. Yes

Notes

Examples

IBMi buildableFile.xml example: 

<bf:component bf:name="Alfonso Default Component">
  <bf:project bf:name="Maillist">
    <bf:file
        bf:buildFile="MLGINQR"
        bf:buildMacro="_cWy_YJNcEe2yIOePByLLnQ"
        bf:buildPath="AR703A_L/QRPGLESRC"
        bf:changedDependencyUUIDs=""
        bf:componentUUID="_t0WYMJNYEe2YzIr0ZDq1Qg"
        bf:inputType="RPGLE"
        bf:langDefName="arod_Build_RPG_Modules"
        bf:langDefStateId="_cWut_pNcEe2YzIr0ZDq1Qg"
        bf:languageCode="RPGLE"
        bf:objLib="AR703A_O"
        bf:reason="-1"
        bf:rebuild="true"
        bf:srcLib="AR703A_L"
        bf:stateID="_lXVy7pNcEe2YzIr0ZDq1Qg"
        bf:uuid="_WnSe4JNcEe2yIOePByLLnQ"
        bf:versionId="2">
      <ds:dependency-set>
        <inputs:file rdf:parseType="Resource">
          <inputs:buildFile>MLGINQR</inputs:buildFile>
          <inputs:buildPath>AR703A_L/QRPGLESRC</inputs:buildPath>
          <inputs:promotionBuildPath>${team.enterprise.scm.resourcePrefix}_L/QRPGLESRC</inputs:promotionBuildPath>
          <inputs:type>SELF</inputs:type>
          <inputs:timestamp>1334086706000</inputs:timestamp>
          <inputs:inputType>RPGLE</inputs:inputType>
          <inputs:uuid>_WnSe4JNcEe2yIOePByLLnQ</inputs:uuid>
          <inputs:stateUuid>_lXVy7pNcEe2YzIr0ZDq1Qg</inputs:stateUuid>
          <inputs:componentUUID>_t0WYMJNYEe2YzIr0ZDq1Qg</inputs:componentUUID>
          <inputs:componentName>Alfonso Default Component</inputs:componentName>
          <inputs:pathName>QRPGLESRC/MLGINQR.RPGLE</inputs:pathName>
          <inputs:resourceDefinitionID>_a2qpYJNcEe2yIOePByLLnQ</inputs:resourceDefinitionID>
          <inputs:resourceDefinitionStateID>_a3d6oJNcEe2YzIr0ZDq1Qg</inputs:resourceDefinitionStateID>
          <inputs:scmLocation>Maillist/QRPGLESRC/MLGINQR.RPGLE</inputs:scmLocation>
          <inputs:changed>false</inputs:changed>
          <inputs:load>true</inputs:load>
        </inputs:file>
        <inputs:file rdf:parseType="Resource">
          <inputs:buildFile>MLGINQD</inputs:buildFile>
          <inputs:buildPath>AR703A_O/MLGINQD OBJTYPE(*FILE):AR703A_L/MLGINQD OBJTYPE(*FILE)</inputs:buildPath>
          <inputs:type>RPG External File</inputs:type>
          <inputs:changed>false</inputs:changed>
          <inputs:load>true</inputs:load>
        </inputs:file>
        <inputs:file rdf:parseType="Resource">
          <inputs:buildFile>FOOCPYR</inputs:buildFile>
          <inputs:buildPath>AR703A_L/QRPGLEINC</inputs:buildPath>
          <inputs:promotionBuildPath>${team.enterprise.scm.resourcePrefix}_L/FOOCPYR.RPGLE</inputs:promotionBuildPath>
          <inputs:type>RPGLE COPY</inputs:type>
          <inputs:timestamp>1334086706000</inputs:timestamp>
          <inputs:inputType>RPGLE</inputs:inputType>
          <inputs:uuid>_Wm1y8JNcEe2yIOePByLLnQ</inputs:uuid>
          <inputs:stateUuid>_lXT9pZNcEe2YzIr0ZDq1Qg</inputs:stateUuid>
          <inputs:componentUUID>_t0WYMJNYEe2YzIr0ZDq1Qg</inputs:componentUUID>
          <inputs:componentName>Alfonso Default Component</inputs:componentName>
          <inputs:pathName>QRPGLEINC/FOOCPYR.RPGLE</inputs:pathName>
          <inputs:resourceDefinitionID>_a2qpYJNcEe2yIOePByLLnQ</inputs:resourceDefinitionID>
          <inputs:resourceDefinitionStateID>_a3d6oJNcEe2YzIr0ZDq1Qg</inputs:resourceDefinitionStateID>
          <inputs:scmLocation>Maillist/QRPGLEINC/FOOCPYR.RPGLE</inputs:scmLocation>
          <inputs:changed>false</inputs:changed>
          <inputs:load>true</inputs:load>
        </inputs:file>
        <inputs:file rdf:parseType="Resource">
          <inputs:buildFile>MLGMSTP</inputs:buildFile>
          <inputs:buildPath>AR703A_O/MLGMSTP OBJTYPE(*FILE):AR703A_L/MLGMSTP OBJTYPE(*FILE)</inputs:buildPath>
          <inputs:type>RPG External File</inputs:type>
          <inputs:changed>false</inputs:changed>
          <inputs:load>true</inputs:load>
        </inputs:file>
      </ds:dependency-set>
    </bf:file>
  </bf:project>
</bf:component>

z/OS buildableFile.xml example: 

<bf:component bf:name="ISPF Client">
  <bf:project bf:name="com.ibm.teamz.ispf.client.jp">
    <bf:file
        bf:buildFile="BLZSLDS"
        bf:buildMacro="_1Q5x4L-8EeexPP6ErhE4Tw"
        bf:buildPath="JAZZ00.V703.BUILT.GMLJPN"
        bf:changedDependencyUUIDs=""
        bf:componentUUID="_Kv0iQONDEd6ypLJPHGMEPw"
        bf:inputType="gmljpn"
        bf:langDefName="DTL Panel - Japanese"
        bf:langDefStateId="_sTpGhb-9EeeLhvio9QXMvw"
        bf:languageCode="OTH"
        bf:objLib=""
        bf:reason="-1"
        bf:rebuild="true"
        bf:srcLib=""
        bf:stateID="_EhWqSGCFEe2NoKpzGEoBBA"
        bf:uuid="_x15dENYwEeGBNoo6rO7vVQ"
        bf:versionId="19">
      <ds:dependency-set>
        <inputs:file rdf:parseType="Resource">
          <inputs:buildFile>BLZSLDS</inputs:buildFile>
          <inputs:buildPath>JAZZ00.V703.BUILT.GMLJPN</inputs:buildPath>
          <inputs:promotionBuildPath>${team.enterprise.scm.resourcePrefix}.GMLJPN</inputs:promotionBuildPath>
          <inputs:type>SELF</inputs:type>
          <inputs:timestamp>1668015881000</inputs:timestamp>
          <inputs:uuid>_x15dENYwEeGBNoo6rO7vVQ</inputs:uuid>
          <inputs:stateUuid>_EhWqSGCFEe2NoKpzGEoBBA</inputs:stateUuid>
          <inputs:componentUUID>_Kv0iQONDEd6ypLJPHGMEPw</inputs:componentUUID>
          <inputs:componentName>ISPF Client</inputs:componentName>
          <inputs:pathName>zOSsrc/GMLJPN/BLZSLDS.gmljpn</inputs:pathName>
          <inputs:resourceDefinitionID>_1LIjQNYfEeGBNoo6rO7vVQ</inputs:resourceDefinitionID>
          <inputs:resourceDefinitionStateID>_ZKN-kL-9EeeLhvio9QXMvw</inputs:resourceDefinitionStateID>
          <inputs:scmLocation>com.ibm.teamz.ispf.client.jp/zOSsrc/GMLJPN/BLZSLDS.gmljpn</inputs:scmLocation>
          <inputs:changed>false</inputs:changed>
          <inputs:load>true</inputs:load>
        </inputs:file>
        <inputs:file rdf:parseType="Resource">
          <inputs:buildFile>BLZSLDSB</inputs:buildFile>
          <inputs:buildPath>JAZZ00.V703.BUILT.GMLINC</inputs:buildPath>
          <inputs:promotionBuildPath>${team.enterprise.scm.resourcePrefix}.GMLINC</inputs:promotionBuildPath>
          <inputs:type>DTLINC</inputs:type>
          <inputs:timestamp>1668015821000</inputs:timestamp>
          <inputs:uuid>_PATeAMv6EeGJjoGevuU6UA</inputs:uuid>
          <inputs:stateUuid>_dLhI12CDEe2NoKpzGEoBBA</inputs:stateUuid>
          <inputs:componentUUID>_Kv0iQONDEd6ypLJPHGMEPw</inputs:componentUUID>
          <inputs:componentName>ISPF Client</inputs:componentName>
          <inputs:pathName>zOSsrc/GMLINC/BLZSLDSB.gmlinc</inputs:pathName>
          <inputs:resourceDefinitionID>_2EbiwNYfEeGBNoo6rO7vVQ</inputs:resourceDefinitionID>
          <inputs:resourceDefinitionStateID>_ZD1CsL-9EeeLhvio9QXMvw</inputs:resourceDefinitionStateID>
          <inputs:scmLocation>com.ibm.teamz.ispf.client/zOSsrc/GMLINC/BLZSLDSB.gmlinc</inputs:scmLocation>
          <inputs:changed>false</inputs:changed>
          <inputs:load>true</inputs:load>
        </inputs:file>
        <inputs:file rdf:parseType="Resource">
          <inputs:buildFile>BLZ@ENT1</inputs:buildFile>
          <inputs:buildPath>JAZZ00.V703.BUILT.GMLJPN</inputs:buildPath>
          <inputs:promotionBuildPath>${team.enterprise.scm.resourcePrefix}.GMLJPN</inputs:promotionBuildPath>
          <inputs:type>DTLINC</inputs:type>
          <inputs:timestamp>1668015824000</inputs:timestamp>
          <inputs:uuid>_tYOX4NYwEeGBNoo6rO7vVQ</inputs:uuid>
          <inputs:stateUuid>_EiIGYGCFEe2NoKpzGEoBBA</inputs:stateUuid>
          <inputs:componentUUID>_Kv0iQONDEd6ypLJPHGMEPw</inputs:componentUUID>
          <inputs:componentName>ISPF Client</inputs:componentName>
          <inputs:pathName>zOSsrc/GMLJPN/BLZ@ENT1.gmlinc</inputs:pathName>
          <inputs:resourceDefinitionID>_1LIjQNYfEeGBNoo6rO7vVQ</inputs:resourceDefinitionID>
          <inputs:resourceDefinitionStateID>_ZKN-kL-9EeeLhvio9QXMvw</inputs:resourceDefinitionStateID>
          <inputs:scmLocation>com.ibm.teamz.ispf.client.jp/zOSsrc/GMLJPN/BLZ@ENT1.gmlinc</inputs:scmLocation>
          <inputs:changed>false</inputs:changed>
          <inputs:load>true</inputs:load>
        </inputs:file>
      </ds:dependency-set>
    </bf:file>
  </bf:project>
</bf:component>

z/OS langOutputs.xml example: 

<ld:langdef
    ld:name="EE703-COBOL compilation"
    ld:stateid="_zy8OMLhSEe2XD7Vr4zJYcg"
    ld:uuid="_JWe84C9TEe2mLLbAK0ghoA">
  <outputs:file>
    <outputs:buildFile>@{source.member.name}</outputs:buildFile>
    <outputs:buildPath>${team.enterprise.scm.resourcePrefix}.OBJ</outputs:buildPath>
    <outputs:resourceDefinitionID>_H0wrcC9TEe2mLLbAK0ghoA</outputs:resourceDefinitionID>
    <outputs:resourceDefinitionStateID>_H1dPAC9TEe2c7uYq2cjAHA</outputs:resourceDefinitionStateID>
  </outputs:file>
</ld:langdef>

z/OS parserOutputs.xml example: 

<bf:buildable xmlns:bf="http://www.ibm.com/team/enterprise/build/buildablefiles/1.0/">
   <bf:file bf:uuid="_6CIpEC9SEe2mLLbAK0ghoA"/>
</bf:buildable>