The task is used to create an Enterprise Extensions system definition for a translator.

Attributes

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

Task Specific Attributes

Attribute Description Required

antSnippet For callMethod 3, the snippet of Ant script to run. Yes³

callMethod

The call method used by this translator. The default is 0. Valid values are:

Method:	Description:
0	MVS program
1	ISPF command
2	TSO command
3	Ant snippet
4	Ant build file

commandMember For callMethod 1 or 2, the ISPF/TSO command string to run. For callMethod 4, the name of the Ant build script to run. Yes^1,2,4

dataSetDefinition The name of a data set definition that defines the z/OS^® data set and member for the module called by the translator. Yes⁰

ddnamelist Alternative DD names list for the translator. Many compilers support an alternate DD names list to avoid DD name conflicts. No

defaultOptions

Option string that is passed to the translator.

Note: If linkedit is set to true, add the string @{ssi_info} to the defaultOptions attribute. During a build the property will be converted to a hexadecimal time stamp that will be used by the link-edit analyzer.

description A free-form textual description of the translator. No

ispfLogCompact Specifies whether or not to compact the ISPF Gateway log prior to publishing. Valid values are true and false. The default is false. No

ispfLogConsolidate

Consolidate ISPF Gateway log. The default is 0. Valid values are:

Value:	Description:
0	Inherit setting from language definition.
1	Never
2	Always
3	On success

ispfLogPublishType

Publish ISPF Gateway log. The default is 1. Valid values are:

Value:	Description:
0	Never
1	Inherit setting from language definition.
2	Always
3	On error

linkedit Specifies whether or not the translator is used for link edit processing during a dependency build. If true, the post-link-edit parser analyzes object decks and program objects that are linked in the generated program object. Valid values are true and false. The default is false. No

maxRC Maximum return code allowed. The default is 0. No

name A unique name for the translator system definition item. Yes

nonImpacting Specifies that changes to this system definition do not force Enterprise Extensions dependency build request processing to use full analysis instead of change set analysis. Valid values are true and false. The default is false. No

⁰ For callMethod 0.
¹ For callMethod 1.
² For callMethod 2.
³ For callMethod 3.
⁴ For callMethod 4.

Allocation Element

The Allocation element is specified within the element. Each Allocation element defines one DD to allocate prior to executing the translator. The following table describes the valid Allocation attribute values:

Allocation Element Attributes

Attribute Description Required

compact

Indicates if the member is stored in compressed format or not. The default is 0. Valid only if the DD targets a physical PDS. Valid values are:

Value:	Description:
0	Inherit setting
1	Never
2	Always

condition An Ant condition string, written in escaped XML, that must evaluate to true for the DD to be used at runtime. No

consolidateLog

Indicates if the log should be appended to the previous one or if the should be stored in its own file. Applies only to a file published in the build result. The default is 0. Valid values are:

Value:	Description:
0	Inherit setting
1	Never
2	Always
3	On success

dataSetDefinition

The name of the data set definition that is associated with this allocation.

Note: Specify only one of dataSetDefinition, hfsPath, input, inStream or propertyName to define the contents for the DD.

deployType

Additional metadata set in the manifest when packaging an output, to be used by custom processing or UrbanCode Deploy (UCD).

For UCD this value is used for the deployType attribute on containers and resources when a ship list is generated. The deployType attribute is used to identify different types of artifacts so that they can be processed differently during a deployment. The value specified here should correspond to the "Deploy Type Filter" setting of the appropriate "Generate Artifact Information" step in UCD.

hsfFileType Specifies whether the data is to be treated as text or binary. Valid values are: TEXT and BINARY. No

hfsOptions

A comma-separated list of options for the HFS allocation. The supported keywords are:

Option:	Description:
`ORDONLY`	Specifies that the program should open the file for reading.
`OWRONLY`	Specifies that the program should open the file for writing.
`ORDWR`	Specifies that the program should open the file for reading and writing. Do not use this option for a FIFO special file.
`OAPPEND`	Specifies that MVS^™ sets the file offset to the end of the file before each write, so that data is written at the end of the file.
`OCREAT`	Specifies that: If the file does not exist, the system is to create it. If a directory specified in the pathname does not exist, one is not created, and the new file is not created. If the file already exists and `OEXCL` was not specified, the system allows the program to use the existing file. If the file already exists and `OEXCL` was specified, the system fails the allocation and the job step.
`OEXCL`	Specifies that: If the file does not exist, the system is to create it. If the file already exists, the system fails the allocation and the job step. The system ignores `OEXCL` if `OCREAT` is not also specified.
`ONOCTTY`	Specifies that if the PATH parameter identifies a terminal device, opening of the file does not make the terminal device the controlling terminal for the process.
`ONONBLOCK`	Specifies the following, depending on the type of file: For a FIFO special file: With `ONONBLOCK` specified and `ORDONLY` access: An open() function for reading-only returns without delay. With `ONONBLOCK` not specified and `ORDONLY` access: An open() function for reading-only blocks (waits) until a process opens the file for writing. With `ONONBLOCK` specified and `OWRONLY` access: An open() function for writing-only returns an error if no process currently has the file open for reading. With `ONONBLOCK` not specified and `OWRONLY` access: An open() function for writing-only blocks (waits) until a process opens the file for reading. For a character special file that supports nonblocking open: If `ONONBLOCK` is specified: An open() function returns without blocking (waiting) until the device is ready or available. Device response depends on the type of device. If `ONONBLOCK` is not specified: An open() function blocks (waits) until the device is ready or available. Specification of `ONONBLOCK` has no effect on other file types.
`OSYNC`	Specifies that the system is to move data from buffer storage to permanent storage before returning control from a callable service that performs a write.
`OTRUNC`	Specifies that the system is to truncate the file length to zero if all the following are true: The file specified on the `PATH` parameter exists. The file is a regular file. The file successfully opened with `ORDWR` or `OWRONLY`. The system does not change the mode and owner. `OTRUNC` has no effect on FIFO special files or character special files.

hfsPath

The fully-qualified HFS path to the file to allocate.

Note: Specify only one of dataSetDefinition, hfsPath, input, inStream or propertyName to define the contents for the DD.

hfsPathDisp The file disposition for normal and abnormal termination of the job step. Valid values are: KEEP and DELETE. No

hfsPathPerm Permissions on the file in Octal format. For example: 755. No

input

Specifies whether or not this allocation is considered input to the language definition that contains the translator that contains this allocation. Valid values are true and false. The default is false.

Note: Specify only one of dataSetDefinition, hfsPath, input, inStream or propertyName to define the contents for the DD.

inStream

Specifies 80-byte in-stream records for the DD.

Note: Specify only one of dataSetDefinition, hfsPath, input, inStream or propertyName to define the contents for the DD.

keep

Specifies whether or not to keep this allocation for subsequent translators. Valid values are true and false. The default is false.

Note: This attribute is only valid for temporary data sets.

member Specifies whether or not a member name is appended to the data set name used for this allocation. Valid values are true and false. The default is false. No

mod Specifies whether to use DISP=MOD to append data to an existing data set (temporary and sequential data sets only). Valid values are true and false. The default is false. No

name The DD name for the allocation. Yes

output Specifies whether or not this allocation is considered output of the language definition that contains the translator that contains this allocation. Valid values are true and false. The default is false. No

outputName The output name string. When outputNameKind is SAME_AS_INPUT, the build ignores it. When outputNameKind is USE_PATTERN, the build uses the pattern string that you specify. When outputNameKind is USE_VARIABLE, it indicates the name of a variable whose value is used as a pattern. No

outputNameKind The type of output member name. Valid values are: SAME_AS_INPUT, USE_PATTERN, and USE_VARIABLE. No

propertyName

The name of a build property that is contains the data set definition information.

Note: Specify only one of dataSetDefinition, hfsPath, input, inStream or propertyName to define the contents for the DD.

publish Specifies whether or not this allocation is published to the build results. Valid values are true and false. The default is false. No

publishType

Indicates if the DD is a file to attach to the build result. If the DD points to a physical PDS, a link to the member will be added in the BuildMap for successful logs. The default is 1. Valid values are:

Value:	Description:
0	Never
1	Inherit setting
2	Always
3	On error

sequential Specifies whether or not this allocation is for a sequential data set. Valid values are true and false. The default is false. No

usedAsInput Indicates whether or not the ouptut can be consumed by other programs. Valid values are true and false. The default is false. No

Concatenation Element

The Concatenation element is specified within the element. Each Concatenation element defines one DD to allocate prior to executing the translator. The following table describes the valid Concatenation attribute values:

Concatenation Element Attributes
Attribute	Description	Required
name	The DD name for the concatenation.	Yes
condition	An Ant condition string, written in escaped XML, that must evaluate to `true` for the DD to be used at runtime.	No

Allocation elements as described above are specified within the Concatenation element. Each Allocation element within the Concatenation element describes one data set to add to the concatenation. At least one Allocation element is required within the Concatenation element. Do not specify a name attribute on any Allocation element included within a Concatenation element.

Variable Element

The Variable element is specified within the element. Each Variable element defines one variable for the translator. The following table describes the valid Variable attribute values:

Variable Element Attributes
Attribute	Description	Required
name	Variable name.	Yes
value	Variable value.	Yes

HfsOutput Element

The HfsOutput element is specified within the element. Each HfsOutput element defines one HFS output path for the translator. The following table describes the valid HfsOutput attribute values:

HfsOutput Element Attributes
Attribute	Description	Required
condition	An Ant condition string, written in escaped XML, that must evaluate to `true` for the path to be used at runtime.	No
deployType	Additional metadata set in the manifest when packaging an output, to be used by custom processing or UrbanCode Deploy (UCD). For UCD this value is used for the deployType attribute on containers and resources when a ship list is generated. The deployType attribute is used to identify different types of artifacts so that they can be processed differently during a deployment. The value specified here should correspond to the "Deploy Type Filter" setting of the appropriate "Generate Artifact Information" step in UCD.	No
path	A fully-qualified path on the build machine that contains HFS output files.	Yes

Notes

Examples

The following is an example of a TranslatorTask that calls an MVS program (high-level assembler):

<xt:translator
    dataSetDefinition="ASMA90"
    defaultOptions="SYSPARM(MAP),DECK,NOOBJECT,&LIST"
    ddnamelist="SYSLIN,,,SYSLIB,SYSIN,ANTPRINT"
    maxRC="0"
    name="ASMMAP">
  <xt:concatenation name="SYSLIB">
    <xt:allocation dataSetDefinition="SDFHMAC"/>
    <xt:allocation propertyName="teamz.mylib"/>
  </xt:concatenation>
  <xt:allocation name="SYSIN" input="true"/>
  <xt:allocation name="SYSPUNCH" dataSetDefinition="OBJ" member="true"/>
  <xt:allocation name=SYSPRINT" propertyName="teamz.sysprint"/>
  <xt:allocation name="SYSUT1" dataSetDefinition="TEMPFILE"/>
  <xt:allocation name="SYSUT2" dataSetDefinition="TEMPFILE"/>
  <xt:allocation name="SYSUT3" dataSetDefinition="TEMPFILE"/>
  <xt:variable name="LIST" value="NOLIST"/>
</xt:translator>

The following is an example of a TranslatorTask that calls a REXX program in a TSO environment:

<xt:translator
    callMethod="2"
    commandMember="EXEC '${teamz.scm.dataset.prefix}.REXX(TOUPPER)'"
    maxRC="0"
    name="TOUPPER">
  <xt:allocation name="INDD" input="true"/>
  <xt:allocation name="OUTDD" dataSetDefinition="OUTPUT" member="true" output="true" outputnamekind="USE_PATTERN" outputName="*A" />
</xt:translator>

The following is an example of a TranslatorTask that contains a conditional allocation and concatenation:

<xt:translator
    callMethod="0"
    dataSetDefinition="Assembler"
    defaultOptions="SYSPARM(DSECT),DECK,NOOBJECT"
    maxRC="0"
    name="BMS map processing (copybook generation)">
  <xt:concatenation condition="<equals arg1="true" arg2="${myProp}"/>" name="SYSLIB">
    <xt:allocation dataSetDefinition="CICS.SDFHMAC"/>
    <xt:allocation dataSetDefinition="SYS1.MACLIB"/>
  </xt:concatenation>
  <xt:allocation condition="<equals arg1="true" arg2="${myProp}"/>" input="true" name="SYSIN"/>
  <xt:allocation dataSetDefinition="Temporary file" name="SYSPRINT" publish="true"/>
  <xt:allocation dataSetDefinition="Copybooks" member="true" name="SYSPUNCH" output="true"/>
  <xt:allocation dataSetDefinition="Temporary file" name="SYSUT1"/>
  <xt:allocation dataSetDefinition="Temporary file" name="SYSUT2"/>
  <xt:allocation dataSetDefinition="Temporary file" name="SYSUT3"/>
</xt:translator>

getTaskNameHdr()

Attributes

Allocation Element

Concatenation Element

Variable Element

HfsOutput Element

Notes

Examples