The task is used to call z/OS® based programs, for instance, the High Level Assembler program ASMA90. 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. Yes
callMethod

The call method for this invocation of the task. The callMethod attribute accepts an integer value between 0 and 2. The meaning of the value is as follows:

Value: Description:
0 Call the specified z/OS program.
1 Issue an ISPF command.
2 Issue a TSO/E command.
Yes
command The text of the command to issue. The command attribute is required if the callMethod is 1 or 2; an ISPF or TSO command. No1
description A description for the call, which is typically the name of the file being processed. No
loadDir The path to the load directory for the build. The value of this attribute is typically ${team.enterprise.scm.fetchDestination} because that property is built-in for a Dependency Build. Yes
maxrc An integer value for the maximum return code allowed for the call to be considered successful. Yes
name A name for the call, which is typically the name of the language definition for the file being processed. No
parm The parameter to be passed to the called program. Specify an empty string if the called program does not need a parameter. Yes
pgm The name of the program to call. The pgm attribute is required if the callMethod is 0. No2
publishoutputs Specifies whether or not to publish the output of the called program. Valid values are true or false. The default is false. Yes
publishoutputsdds Specifies a list of DD names that contain the output of the called program. Yes
publishoutputsforerrorsonly Specifies whether or not to publish output of the called program only for errors. Valid values are true or false. The default is false. Yes
publishsuccessfullogsaszips Specifies whether or not to publish output of the called program as a zip file. Valid values are true or false. The default is false. Yes
1 For callMethod 1 or 2, issuing an ISPF or TSO command, the command attribute is required.
2 For callMethod 0, calling a z/OS program, the pgm attribute is required.

Alloc Elements

One or more alloc elements can be specified within the element. An alloc element is used to allocate a data set required by the called program. The alloc element is optional.

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

Alloc Element Attributes
Attribute Description Required
compact Specifies whether or not output published by the build will have trailing whitespace removed from each line of the file. Outputs in a PDS will be compressed, requiring BLZCMPST to extract the member. Valid values are true or false. The default is false. No
componentName The name of the component for an SCM maintained source file. No
consolidate Specifies whether or not output log files should be appended to the previous one or stored on their own. Valid values are true or false. The default is false. No
dd The DD name for the allocation. The dsn attribute is required for a standard allocation, but may be omitted for inStream or temporary data sets. Yes
dsn The name of the data set to be allocated. No
filedata File data for an HSF file. No
if The "if" condition defined for the allocation. No
input Specifies whether or not the DD is input to a compile process. Valid values are true or false. The default is false. No
inStream Lines for an instream data set. No
keep Specifies whether or not a temporary data set should remain allocated for use by a later step. Valid values are true or false. The default is false. No
output Specifies whether or not the DD is output from the compile process. Valid values are true or false. The default is false. No
parm Parameters to be specified on the BPXWDYN allocation request. No
path Path for an HFS file allocation request. No
pathdisp Disposition options for an HFS file allocation request. No
pathopts Options for an HFS file allocation request. No
pathperm Permissions options for an HFS file allocation request. No
projectName Name of the project that contains the component named above. No
publish Specifies whether or not the data set is to be published. Valid values are true or false. The default is false. No
publishType

The type of publishing for this DD. Valid values are:

Value: Description:
0 Never publish.
1 Inherit publishing type.
2 Always publish.
3 Publish on error.
No
unless The "unless" condition defined for the allocation. No
usageType

Usage type for the data set. Valid values are:

Value: Description:
0 zFolder.
1 New data set.
2 Temporary data set.
3 Existing data set.
No

Concat Elements

One or more concat elements can be specified within the element. A concat element is used to allocate a set of data sets required by the called program. The specific data sets to be allocated to the concatenation are specified with alloc elements coded within the concat element. The dd, dsn, and parm attributes are allowed on alloc elements within the concat element. The concat element is optional.

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

Concat Element Attributes
Attribute Description Required
dd The DD name for the allocation. Yes
if The "if" condition defined for the allocation. No
unless The "unless" condition defined for the allocation. No

Variable Elements

One or more variable elements can be specified within the element. A variable element specifies the value of a translator variable to be used for this invocation of the task. The variable element is optional.

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

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

Notes

Examples

Call the z/OS Assembler compiler program: 

<antz:mvsexec
    buildResultUUID="${buildResultUUID}"
    callMethod="0"
    command=""
    description="@{source.dataset}"
    loadDir="${team.enterprise.scm.fetchDestination}"
    maxrc="0"
    name="Assembler"
    parm="&ASMOPTS"
    passwordFile="${passwordFile}"
    pgm="ASMA90"
    publishoutputs="${team.enterprise.build.publishoutputs}"
    publishoutputsdds="${team.enterprise.build.publishoutputs.dds}"
    publishoutputsforerrorsonly="${team.enterprise.build.publishoutputs.erroronly}"
    publishsuccessfullogsaszips="${team.enterprise.build.publishoutputs.successfulLogsAsZips}"
    repositoryAddress="${repositoryAddress}"
    userId="${userId}">
  <antz:variable name="&ASMOPTS" value="@{var.ASM.ASMOPTS}"/>
  <antz:variable name="&RTCReturnCodeForTranslator" value="@{var.1.1RTCReturnCodeForTranslator}"/>
  <antz:alloc componentName="@{source.component}" dd="SYSIN" dsn="@{source.dataset}" input="true" parm="shr" projectName="@{source.project}"/>
  <antz:alloc dd="SYSLIN" dsn="${team.enterprise.scm.resourcePrefix}.OBJ@{source.member}" parm="cyl space(1,1) blksize(27920) lrecl(80) dsorg(PO) recfm(F,B) dsntype(library)  new catalog"/>
  <antz:alloc dd="SYSPRINT" dsn="${team.enterprise.scm.resourcePrefix}.LIST@{source.member}" output="true" parm="cyl space(40,10) lrecl(121) dsorg(PO) recfm(F,B,A) dsntype(library)  new catalog" publish="true"/>
  <antz:alloc dd="SYSUT1" parm="cyl space(5,5) unit(SYSALLDA)  new"/>
  <antz:concat dd="SYSLIB">
     <antz:alloc dd="SYSLIB" dsn="${team.enterprise.scm.resourcePrefix}.MAC" parm="cyl space(1,10) lrecl(80) dsorg(PO) recfm(F,B) dsntype(library)  new catalog"/>
     <antz:alloc dd="TMP00034" dsn="CEE.SCEEMAC" parm="shr"/>
     <antz:alloc dd="TMP00035" dsn="SYS1.MACLIB" parm="shr"/>
     <antz:alloc dd="TMP00036" dsn="ASM.SASMMAC2" parm="shr"/>
     <antz:alloc dd="TMP00037" dsn="SYS1.MODGEN" parm="shr"/>
  </antz:concat>
</antz:mvsexec>