Document template definitions - DOCDEF
The Document template definition (DOCDEF) views display information about document template definitions for use in managed CICS systems.
Supplied views
To access from the main menu, click:
| View | Notes |
|---|---|
| Document template definitions EYUSTARTDOCDEF.ADDTOGRP |
Add one or more document template definitions to a resource group. |
| Document template definitions EYUSTARTDOCDEF.CREATE |
Create a document template definition and add it to the data repository. |
| Document template definitions EYUSTARTDOCDEF.DETAILED |
Detailed information about a selected document template definition. |
| Document template definitions EYUSTARTDOCDEF.INSTALL |
Install a document template definition in an active system. |
| Document template definitions EYUSTARTDOCDEF.REMOVE |
Remove a document template definition from the data repository. |
| Document template definitions EYUSTARTDOCDEF.TABULAR |
Tabular information about all document template definitions for the current context. |
Actions
| Action | Description |
|---|---|
| ADDTOGRP | Add one or more document template definitions to a resource group. |
| CREATE | Create a document template definition and add it to the data repository. |
| CSDCOPY | Copy a CICS CSD resource definition. |
| CSDINSTALL | Install a CICS CSD resource definition into an active system. |
| INSTALL | Install a document template definition in an active system. |
| REMOVE | Remove a document template definition from the data repository. |
| UPDATE | Update a document template definition in the data repository. |
Fields
| Field | Attribute name | Description |
|---|---|---|
| Carriage return line feed (CRLF) append option | APPENDCRLF | 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:
|
| Last modification agent | CHANGEAGENT | The change agent identifier that made the last modification.
|
| Last modification agent release | CHANGEAGREL | The CICS release level of the agent that made the last modification. |
| Last modification time | CHANGETIME | The local date and time when the definition was last changed. |
| Last modification user ID | CHANGEUSRID | The user ID that made the last modification. |
| Time created | CREATETIME | The local date and time when the definition was created. |
| CSD group | CSDGROUP | The name of the CSD group for this CICS resource definition. This field is ignored for BAS definitions. |
| DDname of partitioned data set | DDNAME | 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. |
| Version | DEFVER | The version number of the BAS resource definition, from 1 to 15. This field is ignored for CICS CSD resource definitions. |
| Description code page | DESCCODEPAGE | The code page of the description field. This field is ignored for CICS CSD resource definitions. |
| Description | DESCRIPTION | A description of the document template definition. |
| Document content type | DOCTYPE | Specifies the format of the contents of the template:
|
| Exit program name | EXITPGM | 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 name | FILE | 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. |
| zSeries File System template file | HFSFILE | 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. |
| Member of partitioned data set | MEMBERNAME | 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 | NAME | The name of the document template definition. |
| Program name | PROGRAM | 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. |
| Transient data queue name | TDQUEUE | 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. |
| Document template name | TEMPLATENAME | 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. |
| Temporary storage queue name | TSQUEUE | 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. |
| User data area 1 | USERDATA1 | 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. |
| User data area 2 | USERDATA2 | 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. |
| User data area 3 | USERDATA3 | 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. |