DOCDEF Resource Table

A CICS® Definition that describes a document template.

The Primary key field for this resource class is  NAME .

The following actions are supported:

INSTALL
Install a document Template Definition.

The parameter data for the INSTALL action is described in Parameters for installing CICS Definitions.

Length
480
Usage
API or Batch Utility
API view
No
CMAS context
No
SCOPE applies
No
Only query CMASs in workload
No
Object type
CICS Definition
Copybook identifier
EYUt3824 or DOCDEF
Valid API operations
GET CREATE UPDATE REMOVE and PERFORM
Parameters
GET
[RESGROUP] [CICSSYS]
CREATE
[RESGROUP]

API Actions

INSTALL
Install

PARM(' [NOTIFY(value)] USAGE(value) [FORCEINS(value)] [STATECHK(value)] [MODE(value)] [OVERTYPE(value)] [OVERRIDE(override)] TARGET(value) [RELATED(value)] .')

ADDTOGRP
Add to resource group

PARM(' [ERRQUEUE] RESGROUP(value) .')

Table 112. DOCDEF FEEDBACK error codes
Code Description Code Description
DIFF_VERSION Different version INV_RESTYPE Invalid resource type
EARLY_NAMELIST_END Early name list end INV_RSCOPE Invalid related scope
INCONSISTENT_SET Inconsistent set condition INV_STATECHK Invalid state check
INV_ACTION Invalid action INV_STRNGTERM Invalid string terminator
INV_ATTRIBUTE Invalid attribute INV_TSCOPE Invalid target scope
INV_CONTEXT Context not found INV_USAGE Invalid usage
INV_DATA Attribute data invalid INV_VER Invalid resource version
INV_EMBEDTERM Invalid embedded terminator MISSING_RELSYSID Missing related system identifier
INV_FORCEINS Invalid force install MORE_THAN_1_RELSYS More than one related system
INV_LITERAL Invalid literal NODEFS_SELECTED No definitions selected
INV_MINNAME Invalid minor name NON_MP Maintenance point CMAS not available
INV_MODE Invalid mode NOTHING_INSTALLED Nothing installed
INV_NAME Invalid name NOTIFY Notify
INV_NAMELIST Invalid name list NO_RELATED No related systems
INV_NOTIFY Invalid notify NO_TARGETS No targets
INV_ORSTGNA Invalid override string PARTIAL_INSTALL Partial install
INV_ORSTRING Invalid override string REC_CHANGED Resource definition already changed
INV_OVERTYPE Invalid over type REC_EXISTS Resource already exists
INV_OVRBLOCK Invalid override block REC_NOT_FOUND Requested resource not found
INV_RECADDR Invalid record address SCOPE_CONFLICT Scope conflict
INV_RECLEN Invalid record length SCOPE_REQUIRED Scope required
INV_RESGROUP Resource group not found USAGE_CONFLICT Usage conflict
Table 113. DOCDEF resource table attributes
Name Datatype Source Len Req Sum Description Default Value Range Attr ID
CHANGETIME DATETIME CPSM 8 Yes MAX Last time the definition was changed 1
 DEFVER-2  BINARY CPSM 1 Yes AVG Definition version 0 0-15 5
 NAME-1  CHAR CPSM 8 Yes DIF Document template definition name 7
EXITPGM CHAR CPSM 8 No DIF Exit program name 8
FILE CHAR CPSM 8 No DIF File name 9
DDNAME CHAR CPSM 8 No DIF DDname of partitioned data set 10
MEMBERNAME CHAR CPSM 8 No DIF Member of partitioned data set 11
PROGRAM CHAR CPSM 8 No DIF Program name 12
TSQUEUE CHAR CPSM 16 No DIF Temporay storage queue name 13
TDQUEUE CHAR CPSM 4 No DIF Transient data queue name 14
CREATETIME DATETIME CPSM 8 Yes MAX Definition create time 16
USERDATA1 CHAR CPSM 8 No DIF User data area 1 17
USERDATA2 CHAR CPSM 8 No DIF User data area 2 18
USERDATA3 CHAR CPSM 8 No DIF User data area 3 19
DESCRIPTION CHAR CPSM 58 No DIF Definition description 20
TEMPLATENAME CHAR CPSM 48 No DIF Document template name 21
APPENDCRLF EYUDA CPSM 4 Yes LIKE Carriage return line feed (CRLF) append option YES 23
APPENDCRLF Input/Output Valid Values YES NO
DOCTYPE CVDAS CPSM 4 Yes LIKE Document content type EBCDIC 24
DOCTYPE Input/Output Valid Values EBCDIC BINARY
HFSFILE CHAR CPSM 255 No DIF Hierarchical File System template file 25
[[ Contents Previous Page | Next Page Index ]]