PBK (Print Copybook)

Purpose
Prints a report showing the field definitions in:
  • a copybook
  • a template that was based on a copybook (not Db2® templates)
  • a dynamic template
  • an IMS™ view
  • an IMS criteria set
Usage notes
When referencing a copybook, the copybook must be stored in a partitioned data set member, a CA-Panvalet library member, or a library accessed using the Library Management System Exit. All other source types can be stored in a sequential data set, partitioned data set member, CA-Panvalet library member, or a library accessed using the Library Management System Exit.
Options
None.
Related functions
None.
Read syntax diagramSkip visual syntax diagram
Syntax

        .-INPUT=DDIN---.                     .-ARRAY=NO--.   
>>-PBK--+--------------+--+---------------+--+-----------+------>
        +-INPUT=ddname-+  '-MEMBER=member-'  '-ARRAY=YES-'   
        '-DSNIN=dsname-'                                     

   .-HEXLOC=NO--.  .-HEXLEN=NO--.  .-CRITERIA=NO--.   
>--+------------+--+------------+--+--------------+------------->
   '-HEXLOC=YES-'  '-HEXLEN=YES-'  '-CRITERIA=YES-'   

>--+--------------------------+--------------------------------->
   |           .-,--------.   |   
   |           V          |   |   
   '-MEMLIST=(---member_n-+-)-'   

>--+---------------------------------+-------------------------><
   '-| Copybook processing options |-'   

Copybook processing options

   .-LANG=AUTO-------.                                        
|--+-----------------+--| COBOL options |--| PL/I options |----->
   '-LANG=-+-COBOL-+-'                                        
           +-PLI---+                                          
           '-HLASM-'                                          

>--| HLASM options |--------------------------------------------|

COBOL options

   .-DBCS=NO--.  .-CDPC=NO--.  .-CAE=NO--.   
|--+----------+--+----------+--+---------+---------------------->
   '-DBCS=YES-'  '-CDPC=YES-'  '-CAE=YES-'   

>--+----------------------------------------+------------------->
   | .------------------------------------. |   
   | V                                (1) | |   
   '---RFROMn=operand1--RTOn=operand2-----+-'   

>--+------------------+-----------------------------------------|
   '-CBLADDOP=options-'   

PL/I options

   .-BIN63=NO--.  .-DEC31=NO--.  .-GRAPHIC=NO--.   
|--+-----------+--+-----------+--+-------------+---------------->
   '-BIN63=YES-'  '-DEC31=YES-'  '-GRAPHIC=YES-'   

   .-UNALIGNED=NO--.  .-PLIMAXRC=4---.   
>--+---------------+--+--------------+-------------------------->
   '-UNALIGNED=YES-'  '-PLIMAXRC=num-'   

>--+------------------------+--+------------------+-------------|
   |           .--------.   |  '-PLIADDOP=options-'   
   |           V        |   |                         
   '-PLILIBS=(---dsname-+-)-'                         

HLASM options

   .-DBCS=NO--.  .-NOALIGN=NO--.  .-ASMMAXRC=4---.   
|--+----------+--+-------------+--+--------------+-------------->
   '-DBCS=YES-'  '-NOALIGN=YES-'  '-ASMMAXRC=num-'   

>--+------------------------+--+------------------+-------------|
   |           .--------.   |  '-ASMADDOP=options-'   
   |           V        |   |                         
   '-ASMLIBS=(---dsname-+-)-'                         

Notes:
  1. n= 1 to 5.
INPUT=ddname
Defines a reference to a DD or TSO ALLOC statement for the input data sets. The default is DDIN.

If you specify a concatenated DD, then you must provide the member name, member.

DSNIN=dsname
Specifies the name of the data set that contains the copybooks, templates, IMS views, or IMS criteria sets. The name may include a member name in parenthesis. If the member is specified here, the associated Member parameter must be empty.
MEMBER=member
Where dsname is a partitioned data set, CA-Panvalet library, or a library accessed using the Library Management System Exit, specifies the member name. You can specify a pattern to print multiple members. If the input data set is partitioned and you omit the MEMBER parameter, then every member is printed.
ARRAY=YES
Print all occurrences of array elements.
ARRAY=NO
Do not print all occurrences of array elements.
HEXLOC=YES
Print start and end values as hexadecimal offsets.
HEXLOC=NO
Print start and end values as decimal offsets.
HEXLEN=YES
Print length values as hexadecimal.
HEXLEN=NO
Print length values as decimal.
CRITERIA=YES
Both template layout and template criteria information are reported.
CRITERIA=NO
Only template layout information (and not template criteria information) is reported.
MEMLIST
Allows you to specify a list of member names.
member_n
The name of the member to be processed. Generic name masks are allowed.
INPUT=DDIN
Note: If you specify a concatenated DD, then you must provide the member name, member.
Copybook processing
If you specify a copybook (instead of an existing template), then Z Data Tools uses these processing options to compile the copybook into a template:
LANG
Determines whether Z Data Tools automatically detects the copybook language or interprets the language as COBOL, PL/I, or HLASM.
Note: The COMPLANG setting in FMN0POPT is the equivalent of the LANG parameter in batch functions.
  • If COMPLANG is set it determines the installation default language for online and batch compilation.
  • If COMPLANG is not specified then COBOL is the installation default for online compilation and AUTO is the default for batch compilation.
  • If a value of COBOL, HLASM, PL/1, or AUTO is specified (in the Compiler Language Selection panel or through the LANG parameter in a batch job) it overrides the default language.
AUTO
Automatically detect whether the copybook language is COBOL or PL/I, and invoke the appropriate compiler. If the compilation results in a return code greater than 4, then invoke the compiler for the other language. If the second compilation also results in a return code greater than 4, then retry the first compiler and report the compilation errors. If Z Data Tools successfully creates a template (despite the compilation errors), then continue processing with the template.
COBOL
Invoke the COBOL compiler to create a template from the copybook. (Do not invoke the PL/I compiler, even if the COBOL compilation results in errors.)
PLI
Invoke the PL/I compiler to create a template from the copybook. (Do not invoke the COBOL compiler, even if the PL/I compilation results in errors.)
HLASM
Invoke the HLASM compiler to create a template from the copybook.
COBOL options
The following options are used to compile a COBOL copybook into a template:
DBCS=YES
Use the DBCS compiler option.
DBCS=NO
Use the NODBCS compiler option.

For details on the effect of the DBCS and NODBCS compiler options, see the IBM COBOL Programming Guide for OS/390 & VM.

CDPC=NO
Do not use the COBOL SPECIAL-NAMES paragraph "Decimal-point is comma".
CDPC = YES
Use the COBOL SPECIAL-NAMES paragraph "Decimal-point is comma".
CAE=NO
Do not use the COBOL compile option ARITH(EXTEND).
CAE = YES
Use the COBOL compile option ARITH(EXTEND).
MIXED = NO
Field names stored in the template in uppercase.
MIXED = YES
Field names stored in the template in the original case as coded in the COBOL copybook.
RFROM1 RTO1 … RFROM5 RTO5
Up to five pairs of “From” and “To” pseudo-text character strings for the COBOL REPLACE compiler-directing statement.

If your COBOL copybooks contain characters that you want to remove or replace with other characters before compiling the copybooks into templates, then use these replacing options.

For example, if your copybooks contain colon characters (:) that you want to remove before compiling, then specify '==:==' as operand1 and '=====' as operand2.

For details on specifying “From” and “To” strings for COBOL REPLACE, see the IBM COBOL Language Reference.

CBLMAXRC
Sets the maximum acceptable return code for a copybook compile. A return code higher than the specified level causes the function to stop. Default is 4.
Note: The COMPMAXRC parameter is still supported but it is recommended that the CBLMAXRC parameter is used instead. If you do specify the COMPMAXRC parameter, it takes precedence over the language MAXRC.
CBLLIBS
Allows you to specify a list of up to ten data set names to be specified in the SYSLIB concatenation list. These data sets are searched in the order specified for COPY and INCLUDE members for the compilation.
dsname
The name of the data set name to be processed. Generic name masks are not allowed.
CBLADDOP
Additional COBOL compiler options which are included in a CBL statement when compiling COBOL copybooks.
PL/I options
The following options are used to compile a PL/I copybook into a template:
BIN63=YES
Use the LIMITS(FIXEDBIN(63)) compiler option.
BIN63=NO
Use the LIMITS(FIXEDBIN(31)) compiler option.
DEC31=YES
Use the LIMITS(FIXEDDEC(31)) compiler option.
DEC31=NO
Use the LIMITS(FIXEDDEC(15)) compiler option.
GRAPHIC=YES
Use the GRAPHIC compiler option.
GRAPHIC=NO
Use the NOGRAPHIC compiler option.
UNALIGNED=YES
Use the DEFAULT RANGE (*) UNALIGNED, language statement to change the default alignment.
UNALIGNED=NO
Use the PL/I default.
PLIMAXRC
Sets the maximum acceptable return code for a copybook compile. A return code higher than the specified level causes the function to stop. Default is 4.
Note: The COMPMAXRC parameter is still supported but it is recommended that the PLIMAXRC parameter is used instead. If you do specify the COMPMAXRC parameter, it takes precedence over the language MAXRC.
PLILIBS
Allows you to specify a list of up to ten data set names to be specified in the SYSLIB concatenation list. These data sets are searched in the order specified for COPY and INCLUDE members for the compilation.
dsname
The name of the data set name to be processed. Generic name masks are not allowed.
PLIADDOP
Additional PL/I compiler options which are included in a *PROCESS statement when compiling PL/I copybooks.

For details on the effect of these compiler options, see the IBM VisualAge PL/I for OS/390 Programming Guide.

HLASM options
The following options are used to compile a HLASM copybook into a template:
DBCS=YES
Use the DBCS compiler option.
DBCS=NO
Use the NODBCS compiler option.
NOALIGN=YES
Use the NOALIGN compiler option.
NOALIGN=NO
Use the ALIGN compiler option.
ASMMAXRC
Sets the maximum acceptable return code for a copybook compile. A return code higher than the specified level causes the function to stop. Default is 4.
Note: The COMPMAXRC parameter is still supported but it is recommended that the ASMMAXRC parameter is used instead. If you do specify the COMPMAXRC parameter, it takes precedence over the language MAXRC.
ASMLIBS
Allows you to specify a list of up to ten data set names to be specified in the SYSLIB concatenation list. These data sets are searched in the order specified for COPY and INCLUDE members for the compilation.
dsname
The name of the data set name to be processed. Generic name masks are not allowed.
ASMADDOP
Additional HLASM compiler options which are included in a *PROCESS statement when compiling COPY and MACRO members.

For details on the effect of these compiler options, see the HLASM V1R6 Programmer's Guide.

$$FILEM PBK DSNIN=HFMUSER.TEMPLATE,
$$FILEM MEMBER=DITTST1