DOCDEFAggregateRecordType

Document Template Definitions aggregate record

Fields

CSDGroup (StringAggregationType)

The name of the CSD group for this CICS resource definition. This field is ignored for BAS definitions.

appendcrlf (EnumAggregationType)

Specifies whether CICS is to delete trailing blanks from and append carriage-return line-feed to each logical record of the template as it is read from the PDS, FILE, TDQUEUE, or TS QUEUE:

  • YES - Carriage return/linefeed pairs should be appended, and trailing blanks should be removed.
  • NO - Carriage return/linefeed pairs should not be appended, and trailing blanks should not be removed.
changeAgent (EnumAggregationType)

The change agent identifier that made the last modification.

  • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CSDBATCH - The resource was last changed by a DFHCSDUP job.
  • DREPAPI - Resource was last changed by a CICSPlex SM API command.
changeAgentRelease (StringAggregationType)

The CICS release level of the agent that made the last modification.

changeTime (DateAggregationType)

The local date and time when the definition was last changed.

changeUserID (StringAggregationType)

The user ID that made the last modification.

createTime (DateAggregationType)

The local date and time when the definition was created.

ddname (StringAggregationType)

The DDname of the PDS. The name can be up to eight characters in length. If you specify a value for the MEMBERNAME attribute, but do not specify a value for DDNAME, the default value of DFHHTML is taken. If you specify this attribute, you cannot specify EXITPGM, FILE, PROGRAM, TDQUEUE, TSQUEUE or HFSFILE.

desccodepage (LongAggregationType)

The code page of the description field. This field is ignored for CICS CSD resource definitions.

description (StringAggregationType)

A description of the document template definition.

doctype (EnumAggregationType)

Specifies the format of the contents of the template:

  • BINARY - When the template is loaded from the template library, no parsing of the template's contents is done.
  • EBCDIC - When the template is loaded from the template library, the contents are parsed as EBCDIC text.
exitProgram (StringAggregationType)

Name of the exit program for the document template. The name can be up to eight characters in length. If you specify this attribute, you cannot specify DDNAME, FILE, MEMBERNAME, PROGRAM, TDQUEUE, TSQUEUE or HFSFILE.

file (StringAggregationType)

The name of the file when the template resides in a CICS file. The name can be eight characters in length. If you specify this attribute, you cannot specify DDNAME, EXITPGM, MEMBERNAME, PROGRAM, TDQUEUE, TSQUEUE or HFSFILE.

hfsfile (StringAggregationType)

When the template resides in a z/OS UNIX System Services file, this specifies the fully qualified (absolute) or relative name of the z/OS UNIX file. The name can be specified as an absolute name including all directories and beginning with a slash, for example, /u/facts/images/bluefish.jpg. Alternatively, it can be specified as a name relative to the HOME directory of the CICS region user ID, for example, facts/images/bluefish.jpg. Up to 255 characters can be used. If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, PROGRAM, TDQUEUE or TSQUEUE.

membername (StringAggregationType)

When the template resides in an MVS partitioned data set (PDS), specifies the name of the member containing the template. The name can be up to eight characters in length. If you specify this attribute, you cannot specify EXITPGM, FILE, PROGRAM, TDQUEUE, TSQUEUE or HFSFILE.

name (StringAggregationType)

The name of the document template definition.

program (StringAggregationType)

When the template resides in a CICS program, specifies the name of the program. The name can be up to eight characters in length. If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, TDQUEUE, TSQUEUE or HFSFILE.

tdqueue (StringAggregationType)

When the template resides in a transient data queue, specifies the name of the queue. The name can be up to four characters in length. If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, PROGRAM, TSQUEUE or HFSFILE.

templateName (StringAggregationType)

The name by which the template is known to application programs that use it. The name can be up to 48 characters in length. If no value is specified, the default is the 1- to 8-character name for the document template definition.

tsqueue (StringAggregationType)

When the template resides in a temporary storage queue, specifies the name of the queue. The name can be up to 16 characters in length. If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, PROGRAM, TDQUEUE or HFSFILE.

userdata1 (StringAggregationType)

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

userdata2 (StringAggregationType)

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

userdata3 (StringAggregationType)

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

version (LongAggregationType)

The version number of the BAS resource definition, from 1 to 15. This field is ignored for CICS CSD resource definitions.