Batch CLIST Processing

This appendix provides a description of the batch CLIST processor, USDBCLST. This utility provides an easy way to migrate CLISTs between CA IDMS systems.
idms
This appendix provides a description of the batch CLIST processor, USDBCLST. This utility provides an easy way to migrate CLISTs between CA IDMS systems.
The batch CLIST processor supports the following functionality:
  • Uploading one or more new CLISTs to the system.
  • Printing one or more existing CLISTs from the system.
  • Downloading one or more existing CLISTs from the system in a format which can be submitted directly for upload processing.
  • Removing one or more existing CLISTs from the system.
The CA IDMS installation media contains the following sample JCL (intended for demonstration purposes only):
  • USDBCLST - Contains a skeleton of the JCL required to invoke the batch CLIST processor.
For more information, see
Work Files
For z/OS
Input datasets
DD Name
Description
Usage
LRECL
SYSIPT
Request cards
Required for PRINT, DOWNLOAD, REMOVE
80
UPLOAD
Source of CLISTs to add
Required for UPLOAD
80
 
Output datasets
DD Name
Description
Usage
LRECL
REPORT
Source of printed CLISTs
Optional for all functions
133
AUDIT
Status of requests
Required for all functions
133
DOWNLOAD
Listings of downloaded CLISTs
Required for DOWNLOAD
80
 
For z/VSE
Input Datasets
DD Name
Logical Unit
Description
Usage
LRECL
SYSIPT
SYS015
Request Cards
Required for PRINT, DOWNLOAD, REMOVE
80
UPLOAD
SYS016
Source of CLISTs to add
Required for UPLOAD
80
 
Output Datasets
DD Name
Logical Unit
Description
Usage
LRECL
REPORT
SYS017
Source of printed CLISTs
Optional for all functions
133
AUDIT
SYS018
Status of Requests
Required for all functions
133
DOWNLOAD
SYS019
Listings of downloaded CLISTs
Required for DOWNLOAD
80
Batch CLIST Request Cards
Use request cards to download, print, or remove one or more CLISTs. 
Note:
Request cards are not required to upload a CLIST.
A request card describes the CLIST to be processed and the desired function. All variables must start in the appropriate columns. Values should be padded with spaces when necessary. The request card is described in detail below.
Columns
Variable
Description
01 - 08
user-name
Variable specifies a 1-8 character user name for whom the requested CLIST is stored
09 - 16
clist-name
Variable specifies a 1-8 character CLIST identifier
17 - 17
operation code
Variable specifies a 1 character operation code
 
The following table describes the operation code variable.
Code
Function
Description
P
Print only
Print the requested CLIST
D
Download only
Download the requested CLIST
X
Print and Download
Print and download the requested CLIST
R
Remove
Delete the requested CLIST
 
For example, the following request card will prompt the batch CLIST processor to delete the CLIST named SAMPLE belonging to user USER0001:
USER0001SAMPLE  R
The following request card prompts the batch CLIST processor to print the CLISTs SAMP1 and SAMP2 belonging to USER0002 in the report file. Additionally, the source for these CLISTs will be stored into the download file:
USER0002SAMP1   X USER0002SAMP2   X
Batch CLIST Upload File
The upload file is used to add one or more CLISTs to the CA IDMS system. Each CLIST described in this file must begin with a parameter card which names the CLIST and assigns it to a user. Each request must end with an end card.
No request cards are required to upload a CLIST. If a CLIST is already present on the system, the existing version is overwritten.
The parameter card is described below. All variables must start in the appropriate columns. Values should be padded with spaces when necessary.
Columns
Values
Description
01 - 01
‘~’ constant
Specifies a constant representing the start of a parameter or end card
02 - 09
user-name
Specifies a 1-8 character name of the user for whom the CLIST will be stored
10 - 17
clist-name
Specifies a 1-8 character CLIST identifier
 
One or more data cards follow a parameter card. Each data card contains one line of CLIST source. These lines should follow the standard CLIST conventions. Detailed information on CLIST command syntax can be found in CA IDMS DMLO Session.
Every CLIST must end with an end card. The end card is described in detail below. All variables must start in the appropriate columns. Values should be padded with spaces when necessary.
Columns
Values
01 - 01
‘~’ constant
02 - 09
‘**END***’ constant
 
For example, the following lines coded in an upload file would prompt the batch CLIST processor to add CLISTs SAMP1 and SAMP2 belonging to USER0001:
~USER0001SAMP1   * OBTAIN CLIST   OBTAIN FIRST %1 WITHIN %2   ENDC   ~**END***   ~USER0001SAMP2   * STORE CLIST   STORE %1   ENDC   ~**END***