DOCDEF Resource Table

A CICS® Definition that describes a document template.

The Primary key field for this resource class is NAME.

The Secondary key field for this resource class is DEFVER.

The Tertiary key field for this resource class is CSDGROUP.

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 using BAS.

External resource name
CICSDefinitionDocumentTemplate
Length
512
Usage
API or Batch Utility or WUI or CICS Management Client Interface
API view
No
CMAS context
No
SCOPE applies
No
Only query CMASs in workload
No
Object type
CICS Definition
Copybook identifier
EYUt3824
Table 1. Valid CPSM operations
Operations Actions Parameters Required
GET   CICSSYS(value) No
    CSDGROUP(value) No
    RESGROUP(value) No
CREATE   CSD No
    RESGROUP(value) No
UPDATE   CSD No
REMOVE   CSD No
PERFORM SET INSTALL FORCEINS(YES, NO) No
    MODE(value) No
    NOTIFY(NO, INACTIVE, RELEASE, FULL) No
    OVERRIDE No
    OVERTYPE(TARGET, RELATED, BOTH, NONE) No
    RELATED(value) No
    STATECHK(YES, NO) No
    TARGET(value) Yes
    USAGE(LOCAL) Yes
  ADDTOGRP RESGROUP(value) Yes
  CSDINSTALL None N/A
  CSDCOPY AS_RESOURCE(value) No
    DUPACTION(DUPERROR, DUPNOREPLACE, DUPREPLACE) No
    TO_CSDGROUP(value) No
Table 2. DOCDEF FEEDBACK error codes
Value Code Description
1 DOCDEF_INV_DATA Attribute data invalid
2 DOCDEF_REC_NOT_FOUND Requested resource not found
4 DOCDEF_REC_EXISTS Resource already exists
5 DOCDEF_REC_CHANGED Resource definition already changed
6 DOCDEF_INV_RESTYPE Invalid resource type
7 DOCDEF_INV_VER Invalid resource version
11 DOCDEF_NON_MP Maintenance point CMAS not available
12 DOCDEF_INV_CONTEXT Context not found
13 DOCDEF_INCONSISTENT_SET Inconsistent set condition
14 DOCDEF_INV_RESGROUP Resource group not found
21 DOCDEF_INV_ACTION Invalid action
22 DOCDEF_INV_RECADDR Invalid record address
23 DOCDEF_INV_RECLEN Invalid record length
24 DOCDEF_DIFF_VERSION Different version
25 DOCDEF_EARLY_NAMELIST_END Early name list end
26 DOCDEF_INV_NAMELIST Invalid name list
27 DOCDEF_INV_NAME Invalid name
28 DOCDEF_INV_MINNAME Invalid minor name
29 DOCDEF_NOTIFY Notify
30 DOCDEF_PARTIAL_INSTALL Partial install
31 DOCDEF_NOTHING_INSTALLED Nothing installed
32 DOCDEF_NO_TARGETS No targets
33 DOCDEF_NO_RELATED No related systems
34 DOCDEF_INV_TSCOPE Invalid target scope
35 DOCDEF_INV_RSCOPE Invalid related scope
36 DOCDEF_INV_USAGE Invalid usage
37 DOCDEF_INV_MODE Invalid mode
38 DOCDEF_INV_STATECHK Invalid state check
39 DOCDEF_INV_FORCEINS Invalid force install
40 DOCDEF_INV_NOTIFY Invalid notify
41 DOCDEF_INV_OVERTYPE Invalid over type
42 DOCDEF_INV_OVRBLOCK Invalid override block
43 DOCDEF_INV_ORSTRING Invalid override string
44 DOCDEF_INV_STRNGTERM Invalid string terminator
45 DOCDEF_INV_EMBEDTERM Invalid embedded terminator
46 DOCDEF_INV_ATTRIBUTE Invalid attribute
47 DOCDEF_INV_LITERAL Invalid literal
48 DOCDEF_INV_ORSTGNA Invalid override string
49 DOCDEF_SCOPE_REQUIRED Scope required
50 DOCDEF_USAGE_CONFLICT Usage conflict
51 DOCDEF_NODEFS_SELECTED No definitions selected
52 DOCDEF_MORE_THAN_1_RELSYS More than one related system
53 DOCDEF_MISSING_RELSYSID Missing related system identifier
54 DOCDEF_SCOPE_CONFLICT Scope conflict
55 DOCDEF_INV_CSDGROUP Invalid CSD group
56 DOCDEF_REC_NOT_REMOVED Record not removed
57 DOCDEF_INV_RESOURCE Invalid resource
58 DOCDEF_INV_CICS_RESTYPE Invalid CICS restype
59 DOCDEF_PARTIAL_ACTION Partial action
60 DOCDEF_NOTHING_ACTIONED Nothing actioned
61 DOCDEF_INV_BOTHTOAS TO_CSDGROUP and AS_RESOURCE are mutually exclusive
62 DOCDEF_INV_NOTTOAS Either TO_CSDGROUP or AS_RESOURCE is required
63 DOCDEF_CSD_ERROR CSD access error
Table 3. DOCDEF resource table attributes
Name Datatype Source Len Req Sum Description Default Value Range Get Invalid Attr ID
APPENDCRLF EYUDA CPSM 4 Yes LIKE Carriage return line feed (CRLF) append option YES     23
APPENDCRLF Input/output valid values YES, NO
CHANGEAGENT CVDAS CPSM 4 No LIKE Last modification agent     E640 E650 27
CHANGEAGENT Input/output valid values DREPAPI
CHANGEAGREL CHAR CPSM 4 No DIFF Last modification agent release     E640 E650 29
CHANGETIME DATETIME CPSM 8 Yes MAX Last modification time       1
CHANGEUSRID CHAR CPSM 8 No DIFF Last modification user ID     E640 E650 28
CREATETIME DATETIME CPSM 8 Yes MAX Time created       16
 CSDGROUP-3  CHAR CPSM 8 Yes DIFF CSD group     E640 E650 31
DDNAME CHAR CPSM 8 No DIFF DDname of partitioned data set       10
 DEFVER-2  BINARY CPSM 1 Yes AVG Version 0 0-15   5
DESCCODEPAGE BINARY CPSM 4 No DIFF Description code page 37 0-99999999   26
DESCRIPTION CHAR CPSM 58 No DIFF Description       20
DOCTYPE CVDAS CPSM 4 Yes LIKE Document content type EBCDIC     24
DOCTYPE Input/output valid values EBCDIC, BINARY
EXITPGM CHAR CPSM 8 No DIFF Exit program name       8
FILE CHAR CPSM 8 No DIFF File name       9
HFSFILE CHAR CPSM 255 No DIFF zSeries File System template file       25
MEMBERNAME CHAR CPSM 8 No DIFF Member of partitioned data set       11
 NAME-1  CHAR CPSM 8 Yes DIFF Name       7
PROGRAM CHAR CPSM 8 No DIFF Program name       12
TDQUEUE CHAR CPSM 4 No DIFF Transient data queue name       14
TEMPLATENAME CHAR CPSM 48 No DIFF Document template name       21
TSQUEUE CHAR CPSM 16 No DIFF Temporary storage queue name       13
USERDATA1 CHAR CPSM 8 No DIFF User data area 1       17
USERDATA2 CHAR CPSM 8 No DIFF User data area 2       18
USERDATA3 CHAR CPSM 8 No DIFF User data area 3       19