PIPEDEF Resource Table

A CICS® Definition that describes the processing nodes that will act on a service request and on the response to it when a CICS application acts in the role of a Web-service provider or requester.

The First key field for this resource is NAME.

The Second key field for this resource is DEFVER.

The Third key field for this resource is CSDGROUP.

The following actions are supported:
ADDTOGRP
Add to resource group
The parameter data for the ADDTOGRP action is: 
   PARM('RESGROUP(resgroup).')

     where:

     resgroup = The name of a RESGROUP definition.
CSDCOPY
Copy the CICS CSD resource definition in a CSD group into an different CSD group.
The parameter data for the CSDCOPY action is described in Managing CICS definitions in the CSD.
CSDINSTALL
Install the CICS CSD resource definition in a CSD group into an active system.
The parameter data for the CSDINSTALL action is described in Managing CICS definitions in the CSD.
INSTALL
Install a Web Service Pipeline Definition.

The parameter data for the INSTALL action is described in Parameters for installing CICS definitions using BAS.

External resource name(CMCI)
CICSDefinitionPipeline
Object type
CICS Definition
Length
920
Usage
API, Batch Utility, WUI, CICS Management Client Interface(CMCI)
API view
No
CMAS context
No
SCOPE applies
No
Only query CMASs in workload
No
Copybook identifier
EYUt3834
CICS Commands subject to CICS Security
INQUIRE PIPELINE
Unsupported CICS Releases
None
Table 1. Valid CPSM operations
Operations Actions Parameters Required
CREATE   CSD No
    RESGROUP(value) No
GET   CICSGRP(value) No
    CICSSYS(value) No
    CSDGROUP(value) No
    RESGROUP(value) No
REMOVE   CSD No
UPDATE   CSD No
PERFORM SET, PERFORM OBJECT ADDTOGRP RESGROUP(value) Yes
  CSDCOPY AS_RESOURCE(value) No
    DUPACTION(DUPERROR, DUPNOREPLACE, DUPREPLACE) No
    TO_CSDGROUP(value) No
  CSDINSTALL None N/A
  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
Table 2. PIPEDEF FEEDBACK error codes
Value Code Description
1 PIPEDEF_INV_DATA Attribute data invalid
2 PIPEDEF_REC_NOT_FOUND Requested resource not found
4 PIPEDEF_REC_EXISTS Resource already exists
5 PIPEDEF_REC_CHANGED Resource definition already changed
6 PIPEDEF_INV_RESTYPE Invalid resource type
7 PIPEDEF_INV_VER Invalid resource version
11 PIPEDEF_NON_MP Maintenance point CMAS not available
12 PIPEDEF_INV_CONTEXT Context not found
13 PIPEDEF_INCONSISTENT_SET Inconsistent set condition
14 PIPEDEF_INV_RESGROUP Resource group not found
21 PIPEDEF_INV_ACTION Invalid action
22 PIPEDEF_INV_RECADDR Invalid record address
23 PIPEDEF_INV_RECLEN Invalid record length
24 PIPEDEF_DIFF_VERSION Different version
25 PIPEDEF_EARLY_NAMELIST_END Early name list end
26 PIPEDEF_INV_NAMELIST Invalid name list
27 PIPEDEF_INV_NAME Invalid name
28 PIPEDEF_INV_MINNAME Invalid minor name
29 PIPEDEF_NOTIFY Notify
30 PIPEDEF_PARTIAL_INSTALL Partial install
31 PIPEDEF_NOTHING_INSTALLED Nothing installed
32 PIPEDEF_NO_TARGETS No targets
33 PIPEDEF_NO_RELATED No related systems
34 PIPEDEF_INV_TSCOPE Invalid target scope
35 PIPEDEF_INV_RSCOPE Invalid related scope
36 PIPEDEF_INV_USAGE Invalid usage
37 PIPEDEF_INV_MODE Invalid mode
38 PIPEDEF_INV_STATECHK Invalid state check
39 PIPEDEF_INV_FORCEINS Invalid force install
40 PIPEDEF_INV_NOTIFY Invalid notify
41 PIPEDEF_INV_OVERTYPE Invalid over type
42 PIPEDEF_INV_OVRBLOCK Invalid override block
43 PIPEDEF_INV_ORSTRING Invalid override string
44 PIPEDEF_INV_STRNGTERM Invalid string term
45 PIPEDEF_INV_EMBEDTERM Invalid embedded terminator
46 PIPEDEF_INV_ATTRIBUTE Invalid attribute
47 PIPEDEF_INV_LITERAL Invalid literal
48 PIPEDEF_INV_ORSTGNA Invalid override string
49 PIPEDEF_SCOPE_REQUIRED Scope required
50 PIPEDEF_USAGE_CONFLICT Usage conflict
51 PIPEDEF_NODEFS_SELECTED No definitions selected
52 PIPEDEF_MORE_THAN_1_RELSYS More than one related system
53 PIPEDEF_MISSING_RELSYSID Missing related system identifier
54 PIPEDEF_SCOPE_CONFLICT Scope conflict
55 PIPEDEF_INV_CSDGROUP Invalid CSD group
56 PIPEDEF_REC_NOT_REMOVED Record not removed
57 PIPEDEF_INV_RESOURCE Invalid resource
58 PIPEDEF_INV_CICS_RESTYPE Invalid CICS restype
59 PIPEDEF_PARTIAL_ACTION Partial action
60 PIPEDEF_NOTHING_ACTIONED Nothing actioned
61 PIPEDEF_INV_BOTHTOAS TO_CSDGROUP and AS_RESOURCE are mutually exclusive
62 PIPEDEF_INV_NOTTOAS Either TO_CSDGROUP or AS_RESOURCE is required
63 PIPEDEF_CSD_ERROR CSD access error
Table 3. PIPEDEF resource table attributes
Name Datatype Source Len Req Sum Description Default Value Range Get Invalid Offset
 NAME-1  CHAR CPSM 8 Yes DIFF Name       25
 DEFVER-2  BINARY CPSM 1 Yes AVG Version 0 0-15   24
 CSDGROUP-3  CHAR CPSM 8 Yes DIFF CSD group       908
CHANGEAGENT CVDAS CPSM 4 No LIKE Last modification agent       8
CHANGEAGENT Input/output valid values
  • CSDAPI
  • CSDBATCH
  • DREPAPI
  • N_A
CHANGEAGREL CHAR CPSM 4 No DIFF Last modification agent release       20
CHANGETIME DATETIME CPSM 8 Yes MAX Last modification time       0
CHANGEUSRID CHAR CPSM 8 No DIFF Last modification user ID       12
CONFIGFILE CHAR CPSM 255 Yes DIFF Configuration file name on zFS for this pipeline       130
CREATETIME DATETIME CPSM 8 Yes MAX Time created       40
DESCCODEPAGE BINARY CPSM 4 No DIFF Description code page 37 0-99999999   900
DESCRIPTION CHAR CPSM 58 No DIFF Description       72
RESPWAIT CHAR CPSM 4 No DIFF Response wait time for Requester Pipeline (SSSS) DEFT 0-9999   904
RESPWAIT Input/output valid values
  • DEFT
SHELF CHAR CPSM 255 No DIFF Name of a directory (shelf) for WSBind files /var/cicsts     385
STATUS CVDAS CPSM 4 No LIKE ENABLED status ENABLED     640
STATUS Input/output valid values
  • ENABLED
  • DISABLED
USERDATA1 CHAR CPSM 8 No DIFF User data area 1       48
USERDATA2 CHAR CPSM 8 No DIFF User data area 2       56
USERDATA3 CHAR CPSM 8 No DIFF User data area 3       64
WSDIR CHAR CPSM 255 No DIFF Name of the WSBind (pickup) directory on zFS       644