HFMIMSIN control statements

You use the HFMIMSIN control statements to specify:
  • If the Print is to run in a BMP or DLI region.
  • Whether to use a static PSB or if ZDT/IMS is to generate a dynamic PSB to print the IMS data.
  • The format the IMS segments are printed in (CHAR, HEX, SNGL, or TABL).
  • The ZDT/IMS view to be used when printing the IMS segments. Selection criteria (if specified) are used to determine the IMS segment to be printed. When printing in SNGL or TABL format, ZDT/IMS uses the fields to format the IMS segment.
Each line in HFMIMSIN starts with a $$FILEM and the first line contains the parameter IPR to specify that ZDT/IMS is performing a Print. 
$$FILEM IPR REGNTYPE=DLI,
$$FILEM     PSBTYPE=DYNAMIC,
$$FILEM     DBDDSN=HFM.IMS.IVP.DBDLIB,
. . .
Figure 1. Syntax

1 IPR IMSID=imsid REGENTYPE=
2.1  BMP  %BMP parameters
2.1  DLI  %DLI parameters? PSBTYPE=
2.1! installation default
2.1  DYNAMIC  %DYNAMIC parameters
2.1  STATIC  %STATIC parameters
1! DBDDSN=subsystem defaults
1  DBDDSN=dbddsn? + DBDDSNi=dbddsni
1? DBDDD=dbddd
2 DBDMEM=dbdname
1! VIEW=N
1 VIEW=Y
2.1! VIEWDD=VIEWDD
2.1 VIEWDD=ddname
2.1 VIEWDSN=VIEWdsn
1?VIEWMEM=VIEWmem
1! PRTFORM=CHAR
1 PRTFORM=HEX
1 PRTFORM=SNGL
1 PRTFORM=TABL
1! KEYPRT=N
1 KEYPRT=Y
5?  KEYLIST=( + , rootkey )
5?  KEYRANGE=(startkey,endkey)
5?  MAXROOTS=number
BMP parameters

1? AGN=agn
1! PARDLI=subsystem default
1 PARDLI=0
1 PARDLI=1
1! IMSNBA=subsystem default
1 IMSNBA=number
1! IMSOBA=subsystem default
1 IMSOBA=number
1! LOCKMAX=subsystem default
1 LOCKMAX=number
DLI parameters

1! RESLIB=subsystem defaults
1?  + RESLIBi=reslibi
2?  RECON1=recon1 RECON2=recon2 RECON3=recon3
1! DFSVSAMP=subsystem default
1 DFSVSAMP=dfsvsamp
1! VSMPMEM=subsystem default
1 VSMPMEM=vsmpmem
1! MACLIB=subsystem default
1 MACLIB=maclib
1! IMSBKO=subsystem default
1 IMSBKO=N
1 IMSBKO=Y
1! DBRC=subsystem default
1 DBRC=Y
1 DBRC=N
1 DBRC=IMS
1! IRLM=subsystem default
1 IRLM=Y
1 IRLM=N
1 IRLM=IMS
1! IRLMNAME=subsystem default
1 IRLMNAME=irlname
1! GSGNAME=subsystem default
1 GSGNAME=NONE
1 GSGNAME=gsgname
1! TMINAME=subsystem default
1 TMINAME=tminame
11? IMSBUF=number
1! LOCKMAX=subsystem default
1 LOCKMAX=number
1! LOGUSAGE=subsystem default
1 
2.1 LOGUSAGE=KEEP
2.1 LOGUSAGE=KEEPUPD
2.1 LOGUSAGE=DELETE
1  %LOG parameters
1 LOGUSAGE=NONE
LOG parameters

1! LOGDSN=subsystem default
1 LOGDSN=logdsn
1! LOGSUNIT=installation default
1 LOGSUNIT=CYL
1 LOGSUNIT=TRK
1 LOGSUNIT=BLK
1 LOGSUNIT=MB
1 LOGSUNIT=KB
1! LOGPQTY=installation default
1 LOGPQTY=number
1! LOGSQTY=installation default
1 LOGSQTY=number
1! LOGMGMTC=installation default
1 LOGMGMTC=management_class_name
1! LOGSTORC=installation default
1 LOGSTORC=storage_class_name
1! LOGDATAC=installation default
1 LOGDATAC=data_class_name
1! LOGUNIT=installation default
1 LOGUNIT=unit
DYNAMIC parameters

1! PROCOPT=subsystem default
1 PROCOPT=G
1 PROCOPT=GO
STATIC parameters

1! PSBDSN=subsystem defaults
1  PSBDSN=psbdsn? + PSBDSNi=psbdsni
1? PSBDD=psbdd
2 PSBMEM=psbmbr
1? PCBNUM=(+ ,pcbnum)
1? PCBNAME=(+ ,pcbname)

The VIEW, VIEWDD, VIEWDSN, VIEWMEM and PRTFORM parameters are described here. All the other parameters in this syntax diagram can also be specified for the Extract (IXB) function. For a description of these common parameters, see Extract (IXB) for details.

VIEW
Optional parameter. Specifies whether or not the Print uses a view.
N
The Print does not use a view.
Y
The Print uses a view. If Y is specified, you must specify the view that is to be used as outlined in the VIEWDD, VIEWDSN and VIEWMEM entries:
VIEWDD=ddname
Identifies the DD statement for the sequential data set or PDS(E) and member that contains the view you want your Print to use. The default is VIEWDD.
VIEWDSN=viewdsn
The name of the data set that contains the view that you want your Print to use. You may specify a sequential data set or a PDS(E). If you specify a PDS(E), the parameter may also include a member name in parentheses.
VIEWMEM=viewmem
Required when the VIEWDSN or VIEWDD parameter specifies a PDS(E) and does not specify the member. Specifies the member of the PDS(E) that contains the view you want your Print to use.
PRTFORM
Required parameter. Specifies the format in which the data is to be printed:
CHAR
Prints the data in character format.
HEX
Prints the data in hexadecimal "updown" format. This format uses three lines; one for the character, one for the zone digit, and one for the numeric digit of each byte.
SNGL
Prints the data in SNGL format. This format splits the data into fields and uses a separate line for each field. Only available when you are using a view.
TABL
Prints the data in a tabular format. Splits the data into fields and arranges the fields in columns. Only available when you are using a view.
KEYPRT
Optional parameter. Specifies whether or not the Print is restricted to those records that are specified in a key values data set.
N
The Print does not use a key values data set.
Y
The Print uses a key values data set. The key values data set contains the key values of the root segments of the records that you want printed.

You specify the key values data set in the KEYSFILE DD statement.

You may specify a sequential data set or a PDS(E) and member.

KEYLIST(rootkey1,rootkey2,...)
Optional parameter. Specifies a list of the root segment key values of the database records that you want printed. If the length of a root key value is less than the key length of the root segment, then the function considers it to be the first part of the key and prints all those database records with root key values that match the partial key value.
KEYRANGE(startkey,endkey)
Optional parameter. Specifies the start and the end of a range of root key values. The function prints those database records that have a root key value in the specified range.
startkey
The start of the range of the root key values. If the length of the startkey value is less than the key length of the root segment then the function appends low values (X'00') to the specified value.
endkey
The end of the range of the root key values. If the length of the endkey value is less than the key length of the root segment then the function appends high values to the specified value.
MAXROOTS=number
Optional parameter. Limits the number of database records that the function prints. When this parameter is specified, the function counts the number of database records that it has printed and terminates when it reaches the specified limit.