File-AID Single Install Image Installation and

File-AID Single Install Image
Installation and Configuration Guide
Release 10.2
ii
File-AID Single Install Image Installation and Configuration Guide
Please direct questions about File-AID
or comments on this document to:
Compuware Customer Support
http://go.compuware.com/
This document and the product referenced in it are subject to the following legends:
Copyright 2014 Compuware Corporation. All rights reserved. Unpublished rights reserved under the
Copyright Laws of the United States.
U.S. GOVERNMENT RIGHTS-Use, duplication, or disclosure by the U.S. Government is subject to
restrictions as set forth in Compuware Corporation license agreement and as provided in DFARS
227.7202-1(a) and 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995),
FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable. Compuware Corporation.
This product contains confidential information and trade secrets of Compuware Corporation. Use,
disclosure, or reproduction is prohibited without the prior express written permission of Compuware
Corporation. Access is limited to authorized users. Use of this product is subject to the terms and
conditions of the user’s License Agreement with Compuware Corporation.
Abend-AID, File-AID, File-AID Data Editor, File-AID Data Privacy, File-AID/Data Solutions, File-AID/EX,
File-AID for DB2, File-AID/MVS, File-AID/RDX, File-AID for IMS, Compuware Shared Services, Compuware
Workbench, Host Explorer and Xpediter are trademarks or registered trademarks of Compuware
Corporation.
IBM, CICS, DB2, and MVS/ESA are trademarks or registered trademarks of International Business Machines
Corp.
CA Endevor, CA Endevor Software Change Manager, and CA Gen are trademarks or registered trademarks
of CA Technologies.
Adobe® Reader® is a trademark of Adobe Systems Incorporated in the United States and/or other
countries.
All other company and product names are trademarks or registered trademarks of their respective owners.
Doc. CWFCI10B
March 13, 2015
iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Manual Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxiii
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Related Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Customer Support Website . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
Online Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
World Wide Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
Accessibility Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
Documentation Accessibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Notation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Compuware Go Customer Support Website . . . . . . . . . . . . . . . . . . . . . . . xxvi
Contacting Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Corporate Website . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Chapter 1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
File-AID Single Install Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
License Management System (LMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
File-AID/MVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
File-AID/Data Solutions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
File-AID/RDX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
File-AID for DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
File-AID for IMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
File-AID/EX Enterprise Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Installation Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Product Delivery Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Receive From Network (RFN). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Extended Play (EP) Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
SMP/E Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
SMP/E Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
File-AID Configuration Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-5
File-AID Packaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Installation Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-6
New File-AID Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Access to File-AID Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
File-AID PDSE Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Authorized Library Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-7
Compuware Workbench . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
File-AID Load Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Required DB2 Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
DB2 System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Configuration Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Operating System and ISPF/PDF Changes . . . . . . . . . . . . . . . . . . . . . 1-9
iv
File-AID Single Install Image Installation and Configuration Guide
CPU Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Product Specific Installation Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
File-AID/MVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Installing File-AID/MVS in a ROSCOE Environment . . . . . . . . . . . . 1-9
Calling File-AID/MVS from REXX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
SMF Record Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
File-AID/Data Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Callable Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Upgrading Custom Date Pattern and Field Level Exits . . . . . . . . . . 1-10
File-AID/RDX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Installation Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Link-Edit Other Modules Depending on Site Requirements . . . . . 1-11
File-AID for DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Audit Trail Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Product Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
File-AID for IMS/ISPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
File-AID for IMS/CICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
File-AID for IMS/DC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
File-AID/EX Enterprise Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
Chapter 2. File-AID Configuration Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Configuration Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Step 1. Execute the File-AID Configuration CLIST . . . . . . . . . . . . . . . . . . 2-3
Specify a Work Dataset to Write Configuration JCL . . . . . . . . . . . . . 2-4
Configuration Facility Menu Options . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Allocation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Using Configuration Facility Help . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Step 2. Specify File-AID Common Component Parameters . . . . . . . . . . . 2-7
Step 2.1 Specify Configuration Module Dataset Names . . . . . . . . . 2-10
Step 2.2 Specify Product Configuration Parameters . . . . . . . . . . . . 2-14
Step 2.3 Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25
Step 3. Specify DB2/IMS/Data Privacy Environment (Option 2) . . . . . . 2-28
Step 3.1 Specify DB2 Subsystem (Option 1) . . . . . . . . . . . . . . . . . . 2-28
Step 3.2. Specify IMS Environment (Option 2) . . . . . . . . . . . . . . . 2-39
Step 3.3. Specify File-AID Data Privacy (Option 3) . . . . . . . . . . . . . 2-55
Step 4. Configure Product Specific Components . . . . . . . . . . . . . . . . . . 2-62
Step 4.1 Configure File-AID/MVS. . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
Step 4.2 Configure File-AID/Data Solutions . . . . . . . . . . . . . . . . . . 2-63
Step 4.3 Configure File-AID/RDX. . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
Step 4.4 Configure File-AID for DB2. . . . . . . . . . . . . . . . . . . . . . . . . 2-64
Step 4.5 Configure File-AID for IMS/ISPF . . . . . . . . . . . . . . . . . . . . . 2-65
Step 4.6 Configure File-AID for IMS/CICS . . . . . . . . . . . . . . . . . . . . 2-65
Step 4.7 Configure File-AID for IMS/DC . . . . . . . . . . . . . . . . . . . . . . 2-66
Step 4.8 Configure File-AID/EX Executive . . . . . . . . . . . . . . . . . . . . 2-66
Step 4.9 START . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-67
Step 5. APF Authorize File-AID Libraries . . . . . . . . . . . . . . . . . . . . . . . . . 2-67
Chapter 3. File-AID/MVS Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configuration Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configuration Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Step 1. Select File-AID/MVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Step 2. Specify Source of Product Parameters . . . . . . . . . . . . . . . . . . . . . . 3-2
Step 3. Review Target and Configuration Module Libraries . . . . . . . . . . . 3-4
Step 4. Specify File-AID/MVS Product Configuration Parameters. . . . . . . 3-4
Modify Batch Options at Execution . . . . . . . . . . . . . . . . . . . . . . . . 3-12
v
Criteria Exclusion Datasets (Optional) . . . . . . . . . . . . . . . . . . . . . . . 3-19
VSAM Record Level Sharing (RLS) Options . . . . . . . . . . . . . . . . . . . . 3-20
Step 5. Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
Step 6. Review Job Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21
Step 7. Generate Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21
What’s Next?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23
Chapter 4. File-AID/Data Solutions Product Configuration . . . . . . . . . . . . . . . . . 4-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-1
Configuration Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Configuration Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Step 1. Select File-AID/Data Solutions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Step 2. Specify Source of Product Parameters . . . . . . . . . . . . . . . . . . . . . . . 4-2
Step 3. Review Target and Configuration Module Libraries . . . . . . . . . . . 4-4
Step 4. Specify File-AID/Data Solutions Product Configuration 
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Modify Batch Options at Execution . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Step 5. Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
Step 6. Review Job Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Step 7. Generate Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
What’s Next?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
Chapter 5. File-AID/RDX Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Configuration Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Configuration Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Step 1. Select File-AID/RDX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Step 2. Specify Source of Product Parameters . . . . . . . . . . . . . . . . . . . . . . . 5-2
Step 3. Review Target and Configuration Module Libraries . . . . . . . . . . . 5-4
Step 4. Specify File-AID/RDX Product Configuration Parameters . . . . . . . 5-5
Step 5. Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
Step 6. Review Job Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Step 7. Generate Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Option 1, Site Profile - Generate The Default Site Profiles . . . . . . . . . 5-8
What’s Next?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Chapter 6. File-AID for DB2 Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Configuration Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Configuration Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Step 1. Select File-AID for DB2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Step 2. Specify Source of Product Parameters . . . . . . . . . . . . . . . . . . . . . . . 6-2
Step 3. Review Target and Configuration Module Libraries . . . . . . . . . . . 6-4
Step 4. Specify File-AID for DB2 Product Configuration Parameters . . . . . 6-5
Step 5. Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Step 6. Review Job Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Step 7. Object Administration Setup for DSN Command (Optional) . . . 6-11
What’s Next?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
Chapter 7. File-AID for IMS/ISPF Product Configuration . . . . . . . . . . . . . . . . . . . . 7-1
Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Source Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
IMS Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
DL/I Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
BMP Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Dynamic Backout/Secondary Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
DBRC and RECON Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
vi
File-AID Single Install Image Installation and Configuration Guide
Security Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Dynamic PSB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Static PSB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
ACB Processing (Dynamic PSBs Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
IMS System Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Dynamic PSB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Static PSB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
ACB Libraries (Dynamic PSBs Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
BMP Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Configuration Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Configuration Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Step 1. Select File-AID for IMS/ISPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Step 2. Specify Source of Product Parameters . . . . . . . . . . . . . . . . . . . . . . 7-7
Step 3. Review Target and Configuration Module Libraries . . . . . . . . . . . 7-9
Step 4. Specify File-AID for IMS/ISPF Product Configuration Parameters . 7-9
Step 5. Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Step 6. Review Job Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
Step 7. Generate Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
1) Security Exit PROC JCL (for ASM, COB, PLI, or Default) . . . . . . 7-13
2) Application Relationship Exits. . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
3) Segment Control Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Step 8. Static Link of XIXINTF (Optional) . . . . . . . . . . . . . . . . . . . . . . . 7-14
What’s Next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Chapter 8. File-AID for IMS/CICS Product Configuration . . . . . . . . . . . . . . . . . . . . 8-1
Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Installation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Single Transaction Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Multiple Transaction Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Audit Trail Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
DBD Tailoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
PSB Tailoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
Resource Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7
Space Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
CLT Control Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
BMS Maps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
File-AID for IMS/CICS Termination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Limiting DL/I Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Configuration Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
Configuration Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
Step 1. Select File-AID for IMS/CICS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
Step 2. Specify Source of Product Parameters . . . . . . . . . . . . . . . . . . . . . 8-11
Step 3. Review Target and Configuration Module Libraries . . . . . . . . . . 8-14
Step 4. Specify File-AID for IMS/CICS Product Configuration 
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14
Step 5. Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17
Step 6. Review Job Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-18
Step 7. Make Load Modules Available to CICS . . . . . . . . . . . . . . . . . . . . 8-18
Step 8. Generate Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
1) Assemble and Link IMS Modules (Required) . . . . . . . . . . . . . . . . 8-19
2) ALLOCATE LTM, CLT and Audit Trail Database 
Datasets (Required) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
3) Security Exit (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
4) Static Link of XVJOPNIX (Optional to support multiple 
vii
XVJOPNIX modules) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
Maintenance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25
Control Database DBD Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25
Control Database Segment Size Changes . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
Security Exit Added or Changed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
Installation Parameters Changed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
Control Segment Missing or Invalid . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27
DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27
XIXREBLD Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27
Back-up and Restore Control Databases . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
What’s Next?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
Chapter 9. File-AID for IMS/DC Product Configuration . . . . . . . . . . . . . . . . . . . . . 9-1
Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Installation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Single Transaction Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Multiple Transaction Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Audit Trail Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
DBD Tailoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
PSB Tailoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5
IMS System Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6
Access Fast Path Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8
Space Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8
CLT Control Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8
MFS Tailoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9
Limiting DL/I Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10
IMS Message Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10
Configuration Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
Configuration Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
Step 1. Select File-AID for IMS/DC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
Step 2. Specify Source of Product Parameters . . . . . . . . . . . . . . . . . . . . . . 9-11
Step 3. Review Target and Configuration Module Libraries . . . . . . . . . . 9-14
Step 4. Specify File-AID for IMS/DC Product Configuration Parameters . 9-14
Step 5. Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17
Step 6. Review Job Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18
Step 7. Make Load Modules Available to DC . . . . . . . . . . . . . . . . . . . . . . 9-18
Step 8. Generate Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18
1) Create Aliases for XIXDMAIN (Required) . . . . . . . . . . . . . . . . . . . 9-18
2) Assemble and Link IMS Modules (Required). . . . . . . . . . . . . . . . . 9-19
3) Allocate LTM, CLT and Audit Trail Datasets (Required) . . . . . . . . 9-25
4) Security Exit (Optional). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27
5) Static Link of XVJOPOIX (Optional to support multiple 
XVJOPOIX modules) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27
Maintenance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
Control Database DBD Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
Control Database Segment Size Changes . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
Security Exit Added or Changed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
Installation Parameters Changed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30
Control Segment Missing or Invalid . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30
DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-31
XIXREBLD Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-31
Back up and Restore Control Databases . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32
What’s Next?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32
viii
File-AID Single Install Image Installation and Configuration Guide
Chapter 10. File-AID/EX Enterprise Edition Product Configuration . . . . . . . . . . 10-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
MVS Access Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Configuration Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Configuration Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Step 1. Select File-AID/EX Executive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Step 2. Specify Source of Product Parameters . . . . . . . . . . . . . . . . . . . . . 10-2
Step 3. Review Target and Configuration Module Libraries . . . . . . . . . . 10-5
Step 4. Specify File-AID/EX Executive Product Configuration 
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5
Step 5. Review and Submit JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
Step 6. Review Job Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
Step 7. Generate Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
Option 1, Create DCLE JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
Taking Advantage of VSAM Share Options . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
Operator Commands and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
MVS Access Modules Operator Commands . . . . . . . . . . . . . . . . . . . . . 10-12
P DCLE and F DCLE,STOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
F DCLE,QUIESCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
F DCLE,KILL, client task ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
F DCLE,LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
MVS Access Modules Operator Messages. . . . . . . . . . . . . . . . . . . . . . . . 10-13
What’s Next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15
Chapter 11. Verifying File-AID Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
File-AID/MVS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Step 1 — Make Available and Access File-AID/MVS . . . . . . . . . . . . . . . . 11-2
Step 2 — Verify Primary Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Step 3 — Verify XFACOPY CLIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Step 4 — Verify Option 2 -- Edit Data File . . . . . . . . . . . . . . . . . . . . . . . 11-2
Step 5 — Verify Option 3.3 -- Copy Utility . . . . . . . . . . . . . . . . . . . . . . 11-3
Step 6 — Verify Keyed File Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
Step 7 — Verify CA Panvalet And CA Librarian Support . . . . . . . . . . . . 11-4
Step 8 — Verify Batch Job Submission from Online Print . . . . . . . . . . . 11-5
File-AID/Data Solutions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
Step 1 — Make Available and Access File-AID/Data Solutions . . . . . . . . 11-7
Step 2 — Verify Primary Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
Step 3 — Verify UDACOPY CLIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
Step 4 — Verify Option 1 - Date Aging . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
Step 5 — Verify Batch Job Submission from Online Print . . . . . . . . . . 11-11
Step 6 — Verify Option D, Data Privacy (Optional) . . . . . . . . . . . . . . . 11-12
File-AID for DB2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
File-AID/RDX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
File-AID for IMS/ISPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
Step 1. Verify Primary Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
Step 2 — Verify XIXCOPY CLIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
Step 3. Verify Option 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
Step 4. Verify Option 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18
Dynamic PSB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18
Static PSB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-20
Step 5. Verify Panvalet and Librarian Support . . . . . . . . . . . . . . . . . . . 11-21
Step 6. Verify Batch Extract Job Submission . . . . . . . . . . . . . . . . . . . . . 11-22
Step 7. Copy Default Profile Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-24
Generating Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-24
File-AID for IMS/CICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-25
Step 1. Verify Primary Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-26
Step 2. Edit DBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-26
ix
Step 3. Edit Database Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-27
Step 4. Select Segment and Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-27
Step 5. Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-30
Potential Problems Encountered During Installation . . . . . . . . . . . . . . 11-30
File-AID for IMS/DC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-31
Step 1. Verify Primary Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-31
Step 2. Edit DBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-32
Step 3. Edit Data Base Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-32
Step 4. Select Segment and Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-33
Step 5. Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-35
Potential Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-35
Chapter 12. Site Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Product Datasets Security Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Step 1 — Add the File-AID Load Library to Your System . . . . . . . . . . . . . . . . . 12-1
Step 2 — Make File-AID CLISTs Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
Step 3 — Make Remaining File-AID Libraries Available. . . . . . . . . . . . . . . . . . 12-3
Starting File-AID from ISPF/PDF Primary Panel (Optional) . . . . . . . . . . . . . . 12-7
New Connection Techniques With Release 10 . . . . . . . . . . . . . . . . . . . . . 12-7
CA Librarian and/or CA Panvalet Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-8
Modifications for VSAM Space Manager Pool Names or Volume Allocation . 12-8
Japanese and English Interfaces in One Install . . . . . . . . . . . . . . . . . . . . . . . . 12-9
Appendix A. File-AID/MVS Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
File-AID Security Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Allocation Function Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Open Function Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Installing The File-AID Security Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Debugging Your Security Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Security Exit Parameter Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Audit Trail Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
Installing the Audit Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
Audit Exit Parameter Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
Input Parms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
INPUT/OUTPUT PARMS - EXIT TYPE R . . . . . . . . . . . . . . . . . . . . . . . . . . A-8
I/O Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-10
I/O Exits From Prior File-AID Releases . . . . . . . . . . . . . . . . . . . . . . . . . . A-10
What’s Different About Current Release I/O Exits . . . . . . . . . . . . . . . . . A-10
I/O Exit Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
I/O Exit Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
Installation of the User I/O Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-13
Type 2 COBOL I/O Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-13
I/O Exit Communications Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-14
SMF Recording Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-15
Install or Modify SMF Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-16
Remove SMF Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-16
SMF Record Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-16
Common Header for all SMF Record Types . . . . . . . . . . . . . . . . . . A-17
Dataset Access Record Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-17
Field Update Record Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-18
Comprehensive Update Record Format . . . . . . . . . . . . . . . . . . . . . A-19
Dataset Update Summary Record Format . . . . . . . . . . . . . . . . . . . A-20
Writing a Dynamic SMF User Exit Program . . . . . . . . . . . . . . . . . . . . . . A-20
Writing an SMF Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-20
x
File-AID Single Install Image Installation and Configuration Guide
Appendix B. File-AID/Data Solutions Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Audit Trail Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Installing the Audit Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Audit Exit Parameter Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
Input Parms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
INPUT/OUTPUT PARMS - EXIT TYPE R . . . . . . . . . . . . . . . . . . . . . . B-3
I/O Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-4
SMF Recording Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-5
Install or Modify SMF Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-5
Remove SMF Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-5
SMF Record Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-6
Common Header for all SMF Record Types . . . . . . . . . . . . . . . . . . . B-6
Dataset Access Record Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-7
Field Update Record Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8
Comprehensive Update Record Format . . . . . . . . . . . . . . . . . . . . . . B-8
Dataset Update Summary Record Format . . . . . . . . . . . . . . . . . . . . . B-9
Writing a Dynamic SMF User Exit Program . . . . . . . . . . . . . . . . . . . B-9
Writing an SMF Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10
Date Pattern Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10
Supplied Date Pattern Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-11
Customizing Date Pattern Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-12
Field Level Exits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-14
Encryption Routine Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-16
Key Encrypt/Decrypt Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-17
Field Level Exit (with encryption key) . . . . . . . . . . . . . . . . . . . . . . . B-17
Field Level Exit (without encryption key) . . . . . . . . . . . . . . . . . . . . B-18
Record Level Exit (with encryption key) . . . . . . . . . . . . . . . . . . . . . B-18
Encryption Key Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-19
Creating Your Own Encryption/Decryption Exits . . . . . . . . . . . . . . . . . B-20
Appendix C. Call to File-AID/Data Solutions with the API . . . . . . . . . . . . . . . . . . C-1
Sample Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
COBOL API JCL Setup for Data Privacy (DPR) . . . . . . . . . . . . . . . . . . . . . . . . . C-6
Appendix D. File-AID for DB2 Audit Trail Facility . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
File-AID for DB2 Audit Trail Facility Overview . . . . . . . . . . . . . . . . . . . . . . . . . D-1
Activating the File-AID for DB2 Audit Trail Facility . . . . . . . . . . . . . . . . . . . . . D-2
Step 1. Modify the F2AUDIT Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2
Step 2. Modify the Audit Trail Exit (Optional) . . . . . . . . . . . . . . . . . . . . . D-3
Audit Trail Exit Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-3
Audit Trail Exit Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-4
Audit Trail Exit Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-4
Step 3. Assemble and Link-edit the Audit Trail Exit . . . . . . . . . . . . . . . . . D-4
About the Audit Trail Dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-4
Initial Activation of the File-AID for DB2 SMF Audit Trail Facility . . . . . . . . . D-5
Step 1. Create File-AID SVC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-5
Step 2. Modify the File-AID for DB2 Install Variables . . . . . . . . . . . . . . . . D-6
Audit Trail Exit (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-6
Printing the Audit Trail SMF Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-6
Appendix E. File-AID for IMS Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File-AID for IMS/ISPF Security Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dataset Allocation Exit for Type A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Allocation Exit for Type B . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IMS Initialization Exit for Type I . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Dataset Names Exit for Type N . . . . . . . . . . . . . . . . . . . . . . . . .
Dataset Open Exit for Type O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
E-1
E-1
E-2
E-2
E-2
E-3
E-3
xi
Audit Trail Exit for Type R . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3
IMS Termination Exit for Type T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
Security Exit Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
CALL Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
AMODE 31 and RMODE ANY Parameters. . . . . . . . . . . . . . . . . . . . . . E-5
Security Parms Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-6
Common Input Parms for All Exit Types . . . . . . . . . . . . . . . . . . . . . . E-6
Common Output Parms for All Exit Types . . . . . . . . . . . . . . . . . . . . .E-7
Input Parms for Exit Type A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-7
Input Parms for Exit Type O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-8
Input/Output Parms for Exit Type B . . . . . . . . . . . . . . . . . . . . . . . . . . E-8
Input/Output Parms for Exit Type N. . . . . . . . . . . . . . . . . . . . . . . . . . E-8
Input/Output Parms for Exit Type R . . . . . . . . . . . . . . . . . . . . . . . . . . E-9
Input/Output Parms for Exit Type I . . . . . . . . . . . . . . . . . . . . . . . . . . E-9
Input Parms for Exit Type T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-11
Concatenation Control Parms for Exit Types I and T . . . . . . . . . . . . E-11
Interface to System Security Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . E-13
Interface to ACF2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-13
Interface to RACF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-14
Interface to TOP SECRET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-14
Compile and Link Security Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-15
File-AID Segment Control Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-15
Initialization Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-15
Early Read Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-15
Late Read Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-16
Early Write Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-16
Late Write Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-16
Termination Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-17
Activating Segment Control Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-17
Data Exit Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-18
Call Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-18
Segment Control Parms Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-19
Data-Exit-Parms—Input Parms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-19
DATA-EXIT PARMS—Output Parms . . . . . . . . . . . . . . . . . . . . . . . . . E-21
Other Important Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-21
Exit Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-21
Exit Points and Valid Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-21
Potential Implications of the Exit Changing Segment Data . . . . . . . E-22
Potential Implications of Bypassing Segments . . . . . . . . . . . . . . . . . E-22
Application Relationship Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-23
CALL SEQUENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-23
SOURCE-SEGMENT-EXIT-PARMS LAYOUT. . . . . . . . . . . . . . . . . . . . . . . . E-24
TARGET-ROOT-KEYS-TABLE LAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . E-24
SOURCE-SEGMENT DATA LAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-24
CONCATENATED-KEY LAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-25
AR-EXIT-WORK-AREA LAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-25
XIXTDLI User Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-26
XIXTDLI EXIT Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-26
Input/Output Parameters for the XIXTDLI EXIT . . . . . . . . . . . . . . . E-27
Audit Trail Write User Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-29
CALL Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-29
File-AID for IMS/CICS and File-AID for IMS/DC Security Exit . . . . . . . . . . . . . E-30
Security Exit Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-30
Call Sequence: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-31
Security Parms Layout - INPUT PARMS . . . . . . . . . . . . . . . . . . . . . . . E-31
Security Parms Layout - INPUT PARMS/OUTPUT PARMS. . . . . . . . . E-31
xii
File-AID Single Install Image Installation and Configuration Guide
Appendix F. File-AID for IMS/CICS or File-AID for IMS/DC 
Batch DBD and XREF Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1
DBD Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-1
Checkpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-1
DBD Update JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-2
File-AID for IMS/CICS DBDUPBMP–IMSBATCH Procedure . . . . . . . . . . . .F-2
File-AID for IMS/DC DBDUPBMP–IMSBATCH Procedure . . . . . . . . . . . . . .F-3
File-AID for IMS/CICS DBDUPDLI–DLIBATCH Procedure . . . . . . . . . . . . . .F-4
File-AID for IMS/DC DBDUPDLI–DLIBATCH Procedure . . . . . . . . . . . . . . .F-5
DBD Update DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-6
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-6
Program Control Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-6
DBD Execution Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-7
Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-7
Batch XREF Update Facility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-8
Segment Layout Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-8
Checkpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-9
XREF Update JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-9
XRFUPBMP–IMSBATCH Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-10
XRFUPDLI–DLIBATCH Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-11
XREF Update DD Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-15
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-15
Option Control Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-15
Program Control Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-16
XREF Execution Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-17
Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .F-17
Appendix G. Refreshing the Relationship File . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1
Loading or Refreshing Referential Integrity Relationships . . . . . . . . . . . . . . . . G-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-2
Step 1. Modify the sample JCL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-2
Step 2. Load the Relationship File.. . . . . . . . . . . . . . . . . . . . . . . . . . . G-2
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-4
Loading or Refreshing CA Gen Application Relationships. . . . . . . . . . . . . . . . G-4
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-4
Step 1. Bind the Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
Step 2. Create a Sequential File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
Step 3. Load the Relationship File . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
Return Codes and Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
Front End Messages (Step 2). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
Back End Messages (Step 3) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
DB2 Application Relationships from Other Sources. . . . . . . . . . . . . . . . . . . . . G-6
COBOL Sample Program (XFRMRTUP) . . . . . . . . . . . . . . . . . . . . . . . . . . . G-6
Flat File Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-6
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7
Step 1. Modify the sample COBOL program . . . . . . . . . . . . . . . . . . . G-7
Step 2. Bind the modified COBOL program . . . . . . . . . . . . . . . . . . . G-7
Step 3. Run the modified COBOL program . . . . . . . . . . . . . . . . . . . . G-7
Step 4. Load the Relationship File . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7
Back End Messages (Step 4) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7
Appendix H. File-AID/RDX Encryption Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H-1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H-1
Sample Encryption Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H-1
Encryption Exit Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H-1
xiii
Appendix I. Installing Training Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-1
Execute the File-AID Training Data CLIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-1
Specify Training File VARIABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-2
Select File-AID Product Training File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-3
File-AID/Data Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-3
File-AID/MVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-4
File-AID for DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-5
File-AID for IMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-7
File-AID/RDX Load the Sample Data Solutions Trans. Tables . . . . . . I-7
File-AID/RDX Load Sample MVS Training Data, Create XFRCOPY . . I-9
File-AID/RDX Load the Sample DB2 Tables . . . . . . . . . . . . . . . . . . I-10
File-AID/EX Executive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-12
Appendix J. Advanced Configuration and Porting Techniques . . . . . . . . . . . . . . . .
Product Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Simple Configuration Scenario. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Re-syncing PARM Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing PARM Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating PARM Modules in Separate Configuration Libraries . . . . . . . . . . . . . .
Using FALIBDEF and CUSTLIBS values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DB2 Environment Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File-AID SVC - All Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
J-1
J-1
J-2
J-2
J-3
J-3
J-4
J-4
J-5
J-6
Appendix K. Parameter Cross-Reference Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . K-1
File-AID/MVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .K-1
File-AID/Data Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .K-5
File-AID for IMS/ISPF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .K-9
File-AID for IMS/CICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .K-11
File-AID for IMS/DC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .K-11
Appendix L. File-AID EP Media Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . L-1
Mainframe Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . L-1
Windows Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . L-2
z/OS UNIX (File-AID Rules Engine) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . L-2
UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . L-3
Workbench Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . L-3
Third-Party Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . L-4
Appendix M. File-AID Health Checker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-1
About the File-AID Health Checker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-1
Compuware Health Check Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-2
Running the Health Check Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . M-2
PARM Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-2
SYSIN Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-2
z/OS Operator Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-3
SHUTDOWN Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-3
STOP Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-3
START Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-4
RESTART Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-4
STATUS Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-4
SXVJSAMP JCL Members. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-5
File-AID Health Checks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-6
File-AID Execution Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-6
VJ_DATASETS_EXIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-6
File-AID for DB2 and File-AID/RDX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-9
VJ_DB2_SSID_VALID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-9
xiv
File-AID Single Install Image Installation and Configuration Guide
File-AID for IMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-13
IX_IMSID_VALID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-13
File-AID/RDX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-17
FR_CONFIG_MODULES EXIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-17
FR_CONFIG_MODULE_CHECK_PARAMETER. . . . . . . . . . . . . . . . . M-19
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1
xv
Figures
1-1.
2-1.
2-2.
2-3.
2-4.
2-5.
2-6.
2-7.
2-8.
2-9.
2-10.
2-11.
2-12.
2-13.
2-14.
2-15.
2-16.
2-17.
2-18.
2-19.
2-20.
2-21.
2-22.
2-23.
2-24.
2-25.
2-26.
2-27.
2-28.
2-29.
2-30.
2-31.
2-32.
2-33.
2-34.
2-35.
2-36.
2-37.
2-38.
2-39.
2-40.
2-41.
2-42.
2-43.
2-44.
2-45.
2-46.
2-47.
2-48.
2-49.
2-50.
2-51.
3-1.
3-2.
3-3.
3-4.
3-5.
3-6.
File-AID/EX Enterprise Edition Communication Flow ..........................................1-13
Load Library Specification ........................................................................................2-4
Configuration Facility Menu ....................................................................................2-4
Allocation Parameters...............................................................................................2-6
Source of Product Parameters ...................................................................................2-8
File-AID Common Component Menu .....................................................................2-9
Dataset Name Specification ....................................................................................2-11
File-AID Common Component Configuration Parameters ...................................2-14
Instructions when Merging Customized Libraries .................................................2-26
Japanese Libraries Required ....................................................................................2-26
Edit JCL Screen for File-AID Common Component Module XVJOPUNV.............2-27
DB2/IMS/Data Privacy Environment Menu ...........................................................2-28
Source of Product Parameters .................................................................................2-29
Environment Configuration DB2 Subsystem Menu ..............................................2-30
Maintain DB2 Subsystem Info................................................................................2-32
Adding a New Subsystem with the ADD Primary Command................................2-33
Adding a New Subsystem with the ADD Primary Command - Scrolled................2-34
Updating a Subsystem with the S Line Command ................................................2-34
DELETE Configuration ...........................................................................................2-35
Edit JCL Screen for Assembling DB2 Configuration Module XVJOPDB2..............2-37
Run DB2 Bind Jobs .................................................................................................2-37
Edit JCL Screen for Binding DB2 Subsystems.........................................................2-38
IMS Environment Definition Menu .......................................................................2-39
Create Environment Module Screen ......................................................................2-40
Update IMS Environment Module Screen..............................................................2-40
Select IMS Environment Screen..............................................................................2-41
Modify Environment Menu ...................................................................................2-42
Modify System Parameters .....................................................................................2-43
Modify System Parameters, Part 2 ..........................................................................2-43
Modify DLI Parameters Screen ...............................................................................2-45
Modify DLI Parameters Screen, Part 2 ....................................................................2-46
Modify BMP Parameters .........................................................................................2-47
Modify BMP Parameters, Part 2 ..............................................................................2-48
Modify ACB Parameters..........................................................................................2-49
Dataset Concatenation ...........................................................................................2-51
Assemble Environment module (XVJOPIMS) ........................................................2-53
IMS Environment Information Panel.....................................................................2-54
Edit JCL Screen for Assembling IMS Environment Module XVJOPIMS ................2-54
Source of Product Parameters .................................................................................2-55
Data Privacy Menu .................................................................................................2-56
File-AID Data Privacy Parameters ...........................................................................2-58
Edit JCL Screen for Assembling Data Privacy Configuration Module XVJOPDPR 2-62
Product Configuration Menu .................................................................................2-62
File-AID/MVS Product Configuration Menu ..........................................................2-63
File-AID/Data Solutions Product Configuration Menu..........................................2-64
File-AID/RDX Product Configuration Menu ..........................................................2-64
File-AID for DB2 Product Configuration Menu ......................................................2-65
File-AID for IMS/ISPF Product Configuration Menu...............................................2-65
File-AID for IMS/CICS Product Configuration Menu .............................................2-66
File-AID for IMS/DC Product Configuration Menu ................................................2-66
File-AID/EX Executive Product Configuration Menu ............................................2-67
Start Products Menu ...............................................................................................2-67
Product Configuration Menu ...................................................................................3-1
Source of Product Parameters ...................................................................................3-2
File-AID/MVS Product Configuration Menu ............................................................3-3
File-AID/MVS Product Configuration Parameters....................................................3-5
Edit JCL Screen for File-AID/MVS Parameter Module XVJOPXFA .........................3-20
File-AID/MVS Customization Tasks .......................................................................3-21
xvi
File-AID Single Install Image Installation and Configuration Guide
4-1.
4-2.
4-3.
4-4.
4-5.
4-6.
5-1.
5-2.
5-3.
5-4.
5-5.
5-6.
5-7.
6-1.
6-2.
6-3.
6-4.
6-5.
7-1.
7-2.
7-3.
7-4.
7-5.
7-6.
8-1.
8-2.
8-3.
8-4.
8-5.
8-6.
8-7.
8-8.
9-1.
9-2.
9-3.
9-4.
9-5.
9-6.
9-7.
9-8.
9-9.
9-10.
9-11.
9-12.
10-1.
10-2.
10-3.
10-4.
10-5.
10-6.
10-7.
11-1.
11-2.
11-3.
11-4.
11-5.
11-6.
11-7.
11-8.
11-9.
11-10.
Product Configuration Menu ...................................................................................4-2
Source of Product Parameters ...................................................................................4-2
File-AID/Data Solutions Product Configuration Menu............................................4-4
File-AID/Data Solutions Product Configuration Parameters....................................4-5
Edit JCL Screen for File-AID/Data Solutions Parameter Module XVJOPUDA........4-18
File-AID/Data Solutions Customization Tasks .......................................................4-18
Product Configuration Menu ...................................................................................5-2
Source of Product Parameters ...................................................................................5-2
File-AID/RDX Product Configuration Menu ............................................................5-4
File-AID/RDX Product Configuration Parameters....................................................5-5
Edit JCL Screen for File-AID/RDX Parameter Module XVJOPXFR ...........................5-8
File-AID/RDX Customization Tasks Menu ...............................................................5-8
Generate SITE Profiles Screen ...................................................................................5-9
Product Configuration Menu ...................................................................................6-2
Source of Product Parameters ...................................................................................6-2
File-AID for DB2 Product Configuration Menu ........................................................6-4
File-AID for DB2 Product Configuration Parameters................................................6-5
Edit JCL Screen for File-AID for DB2 Parameter Module XVJOPXFD.....................6-11
Product Configuration Menu ...................................................................................7-7
Source of Product Parameters ...................................................................................7-7
File-AID for IMS/ISPF Product Configuration Menu.................................................7-9
File-AID for IMS/ISPF Product Configuration Parameters ......................................7-10
Edit JCL Screen for File-AID for IMS/ISPF Parameter Module XVJOPXIX ..............7-12
File-AID for IMS/ISPF Customization Tasks Menu..................................................7-13
Product Configuration Menu .................................................................................8-11
Source of Product Parameters .................................................................................8-12
File-AID for IMS/CICS Product Configuration Menu .............................................8-13
File-AID for IMS/CICS Product Configuration Parameters .....................................8-14
Edit JCL Screen for File-AID for IMS/CICS Parameter Module XVJOPNIX.............8-18
File-AID for IMS/CICS Customization Tasks Menu ................................................8-19
File-AID for IMS/CICS Product Configuration Menu .............................................8-24
Online Control Information Update Summary Report .........................................8-28
Product Configuration Menu .................................................................................9-11
Source of Product Parameters .................................................................................9-12
File-AID for IMS/DC Product Configuration Menu ................................................9-13
File-AID for IMS/DC Product Configuration Parameters ........................................9-14
Edit JCL Screen for File-AID for IMS/DC Parameter Module XVJOPOIX ...............9-17
File-AID for IMS/DC Customization Tasks Menu ...................................................9-18
LMT DBD ................................................................................................................9-21
CLT DBD .................................................................................................................9-21
AUD DBD................................................................................................................9-22
Program Specification Block (PSB) .........................................................................9-23
File-AID for IMS/DC Product Configuration Menu ................................................9-28
Online Control Information Update Summary Report .........................................9-32
Product Configuration Menu .................................................................................10-2
Source of Product Parameters .................................................................................10-3
File-AID/EX Executive Product Configuration Menu ............................................10-4
File-AID/EX Executive Product Configuration Parameters ....................................10-6
Edit JCL Screen for File-AID/EX Executive Parameter Module XVJOPXFE..........10-10
File-AID/EX Executive Customization Tasks Menu .............................................10-10
Edit JCL Screen for Create DCLE JCL ...................................................................10-11
Edit - Dataset Specification Screen .........................................................................11-2
Edit Formatted Mode Screen ..................................................................................11-3
Copy Utility Screen.................................................................................................11-3
Browse - Dataset Specification Screen ....................................................................11-4
Browse Keyed Data in Character Mode Screen ......................................................11-4
View Record Layout - Dataset Specification Screen ...............................................11-5
Print Data File Screen .............................................................................................11-5
Print - JCL Specification Screen ..............................................................................11-6
Aging Tools Menu ..................................................................................................11-8
Input Dataset Specification Screen.........................................................................11-8
xvii
11-11.
11-12.
11-13.
11-14.
11-15.
11-16.
11-17.
11-18.
11-19.
11-20.
11-21.
11-22.
11-23.
11-24.
11-25.
11-26.
11-27.
11-28.
11-29.
11-30.
11-31.
11-32.
11-33.
11-34.
11-35.
11-36.
11-37.
11-38.
11-39.
11-40.
11-41.
11-42.
11-43.
11-44.
11-45.
11-46.
11-47.
11-48.
11-49.
11-50.
11-51.
11-52.
11-53.
11-54.
12-1.
12-2.
12-3.
12-4.
12-5.
12-6.
B-1.
B-2.
B-3.
B-4.
C-1.
C-2.
C-3.
C-4.
C-5.
C-6.
C-7.
Aging Criteria Screen ..............................................................................................11-9
Criteria Menu..........................................................................................................11-9
Output Specification Screen .................................................................................11-10
ANALYZE Execution Options Screen....................................................................11-10
Copy - Dataset Specification Screen .....................................................................11-11
ANALYZE Print Report Screen ..............................................................................11-11
Print Parameters Screen ........................................................................................11-11
Utilities Selection Menu .......................................................................................11-12
Print Change Criteria - Dataset Specification Screen ...........................................11-12
Input Dataset Specification Screen .......................................................................11-13
Privacy Repository List Screen ..............................................................................11-13
Privacy Project List Screen ....................................................................................11-14
Output Specification Screen .................................................................................11-14
JCL Specification Screen .......................................................................................11-15
Generated JCL Edit Screen....................................................................................11-15
EDIT Segment/Layout XREF - Dataset Specification Screen.................................11-17
EDIT Segment/Layout XREF - Segment List Screen..............................................11-18
EDIT - Data Base Specification Screen (Dynamic PSB) .........................................11-18
EDIT – Data Base Dataset Specification Screen ....................................................11-19
EDIT – Data Base Location Screen ........................................................................11-19
Formatted Screen ..................................................................................................11-20
EDIT - Data Base Specification Screen (Static PSB)...............................................11-20
DBD Selection List for Static PSB Screen ..............................................................11-21
Data Base Extract - Data Base Specification Screen ..............................................11-22
Data Base Extract - Option Specification Screen ..................................................11-23
EXTRACT - Data Base Dataset Specification Screen .............................................11-23
Data Base Extract - JCL Specification Screen ........................................................11-24
FIDUMP CLIST......................................................................................................11-25
Primary Option Menu ..........................................................................................11-26
DBD Member List Screen......................................................................................11-27
Data Base Location Screen ....................................................................................11-27
Formatted Screen ..................................................................................................11-28
Unformatted Screen..............................................................................................11-28
Key Specification Screen .......................................................................................11-29
Unformatted/HEX OFF Screen .............................................................................11-29
Index Screen .........................................................................................................11-30
Primary Option Menu ..........................................................................................11-32
DBD Member List Screen......................................................................................11-32
Data Base Location Screen ....................................................................................11-33
Formatted Screen ..................................................................................................11-33
Unformatted Screen..............................................................................................11-34
Key Specification Screen .......................................................................................11-34
Unformatted/HEX OFF Screen .............................................................................11-35
Index Screen .........................................................................................................11-35
TSO LOGON PROC Example..................................................................................12-4
Allocation CLIST Example 1...................................................................................12-5
Allocation CLIST Example 2...................................................................................12-5
CLIST Member XVJRUN .........................................................................................12-6
ISR@PRIM Panel......................................................................................................12-7
Start Products Menu ...............................................................................................12-8
File-AID/Data Solutions and COBOL Date Pattern Exit Flow ................................B-14
Field Level Exit (with encryption key) ...................................................................B-17
Field Level Exit (without encryption key) ..............................................................B-18
Record Level Exit (with encryption key) ................................................................B-19
CBL1OPTS................................................................................................................ C-2
CBL2CNTL ............................................................................................................... C-3
CBL3MSGS ............................................................................................................... C-4
CBLAPI00 ................................................................................................................. C-5
File-AID/Data Solutions Primary Option Menu ...................................................... C-6
Input Dataset Specification Screen .......................................................................... C-6
Privacy Project List Screen ....................................................................................... C-7
xviii
File-AID Single Install Image Installation and Configuration Guide
C-8.
C-9.
C-10.
D-11.
D-12.
F-1.
F-2.
F-3.
F-4.
F-5.
F-6.
F-7.
F-8.
F-9.
F-10.
F-11.
G-1.
I-1.
I-2.
I-3.
I-4.
I-5.
I-6.
I-7.
I-8.
I-9.
L-1.
L-2.
L-3.
L-4.
L-5.
L-6.
M-1.
M-2.
M-3.
M-4.
M-5.
M-6.
M-7.
M-8.
M-9.
M-10.
M-11.
M-12.
M-13.
M-14.
M-15.
M-16.
M-17.
M-18.
Output Specification Screen .................................................................................... C-7
JCL Specification Screen .......................................................................................... C-7
Generated JCL Edit Screen....................................................................................... C-8
Sample Audit Trail Report ....................................................................................... D-1
Create Audit Trail Field on Edit Options screen ..................................................... D-3
DBDUPBMP–IMSBATCH JCL Procedure (JCL member XIXNDUPB)....................... F-2
DBDUPBMP–IMSBATCH JCL Procedure (JCL member XIXODUPB)....................... F-3
DBDUPDLI–DLIBATCH JCL Procedure (JCL member XIXNDUPD) ........................ F-4
DBDUPDLI–DLIBATCH JCL Procedure (JCL member XIXODUPD) ........................ F-5
DBD Update Summary for Online Access ................................................................ F-7
XRFUPBMP–IMSBATCH JCL Procedure (JCL members XIXNXUPB for 
File-AID for IMS/CICS or XIXOXUPB for File-AID for IMS/DC)........................... F-10
XRFUPDLI–DLIBATCH JCL Procedure (JCL member XIXNXUPD for 
File-AID for IMS/CICS).......................................................................................... F-11
XRFUPDLI–DLIBATCH JCL Procedure (JCL member XIXNXUPD for 
File-AID for IMS/CICS) - Continued..................................................................... F-12
XRFUPDLI–DLIBATCH JCL Procedure (JCL member XIXOXUPD for 
File-AID for IMS/DC) ............................................................................................ F-13
XRFUPDLI–DLIBATCH JCL Procedure (JCL member XIXOXUPD for 
File-AID for IMS/DC) - Continued........................................................................ F-14
Seg/Layout XREF and COBOL Layout Update Summary....................................... F-18
Sample JCL to Update Relationship File ................................................................. G-3
Training File Options Menu ..................................................................................... I-1
Training File Variables .............................................................................................. I-2
Product Training File Generation............................................................................. I-3
Dataset Found Warning ........................................................................................... I-4
Dataset Found Warning ........................................................................................... I-5
Sample Data Create Screen ....................................................................................... I-6
Sample Translate Tables for Data Disguise............................................................... I-8
Sample Data Create for MVS Screen......................................................................... I-9
Sample Data Create for DB2 Screen ....................................................................... I-11
Mainframe Products .................................................................................................L-1
Windows® Products Tab...........................................................................................L-2
z/OS UNIX Tab .........................................................................................................L-2
UNIX Tab ..................................................................................................................L-3
Workbench Server Tab .............................................................................................L-3
3rd Party Products Tab .............................................................................................L-4
Sample SXVJSAMP(XVJHCCIN) ............................................................................. M-3
Sample SXVJSAMP(XVJHCC) ................................................................................. M-5
Sample SXVJSAMP(XVJHCCJ) ................................................................................ M-5
Sample VJ_DATASETS_EXIST Successful Report .................................................... M-7
Sample XVJOPUNV Does Not Exist Report............................................................ M-7
Sample VJ_DATASETS_EXIST Exception Report .................................................... M-8
Sample VJ_DB2_SSID_VALID Successful Report .................................................... M-9
Sample XVJOPDB2 Does Not Exist Report........................................................... M-10
Sample VJ_DB2_SSID_VALID Exception Report .................................................. M-11
Sample VJ_DB2_SSID_VALID Exception Report for no SSIDs with TPROCESS = YES..
M-12
Sample IX_IMSID_VALID Successful Report ........................................................ M-13
Sample IX_IMSID_VALID Exception Report ........................................................ M-14
Sample IX_IMSID_VALID Exception Report - No BMP processing...................... M-15
Sample IX_IMSID_VALID Exception Report - No XVJOPIMS module ................ M-16
FR_CONFIG_MODULES_EXIST Successful Report ............................................... M-17
FR_CONFIG_MODULES Exception Report .......................................................... M-18
FR_CONFIG_MODULE_CHECK_PARAMETER Successful Report........................ M-20
FR_CONFIG_MODULE_CHECK_PARAMETER Exception Report........................ M-21
xix
Tables
1-1.
1-2.
2-1.
2-2.
2-3.
2-4.
2-5.
2-6.
3-1.
3-2.
3-3.
3-4.
3-5.
3-6.
3-7.
3-8.
4-1.
4-2.
4-3.
4-4.
4-5.
4-6.
4-7.
5-1.
6-1.
6-2.
6-3.
6-4.
6-5.
6-6.
6-7.
7-1.
8-1.
8-2.
8-3.
8-4.
8-5.
8-6.
8-7.
8-8.
8-9.
9-1.
9-2.
9-3.
9-4.
9-5.
9-6.
9-7.
9-8.
9-9.
9-10.
9-11.
9-12.
9-13.
9-14.
9-15.
9-16.
10-1.
Important Variances in Installation Options depending on media ........................1-4
CLIST by Source Editor ...........................................................................................1-12
PARM modules .........................................................................................................2-1
File-AID Target and Configuration Module Libraries ............................................2-11
File-AID Common Component Parameters Variables ...........................................2-14
ARCHVOL1 and ARCHVOL2 Variable — Valid Entry Examples...........................2-25
Subsystem Variables ...............................................................................................2-35
File-AID Data Privacy Variables ..............................................................................2-59
BATCH Product Option Variables ............................................................................3-5
Environment 1 Product Option Variable ...............................................................3-13
Environment 2 Product Option Variable ...............................................................3-14
Other Options.........................................................................................................3-19
VSAM Record Level Sharing (RLS) options.............................................................3-20
Sample Audit Exits and JCL....................................................................................3-21
Sample I/O Exits and JCL .......................................................................................3-22
Sample Security Exits and JCL................................................................................3-22
BATCH Product Option Variables ............................................................................4-6
Environment 1 Product Option Variables..............................................................4-11
Environment 2 Product Option Variables..............................................................4-13
Environment 3 Product Option Variables..............................................................4-17
Sample Audit Exits and JCL....................................................................................4-19
Sample I/O Exits and JCL .......................................................................................4-19
Sample Date Pattern, Field Level, and Encryption Exits ........................................4-20
File-AID/RDX Product Parameter Variables .............................................................5-6
Group AUDIT—Audit Trail Options.........................................................................6-5
Group BATCH—Batch Options ................................................................................6-6
DB2— Database, Tablespace, and Index Defaults ....................................................6-7
EDIT— Edit Options .................................................................................................6-7
Group FIX—Restricted Fix Option ...........................................................................6-8
MISC—Miscellaneous Options ................................................................................6-9
Datasets...................................................................................................................6-10
File-AID for IMS/ISPF Product Options ...................................................................7-10
Naming Convention Rules .......................................................................................8-2
LTM and CLT Databases ...........................................................................................8-4
AUD Database ...........................................................................................................8-5
Resource Protection Approaches ............................................................................8-10
File-AID for IMS/CICS Product Options..................................................................8-15
XIXCDBD Symbolic Parameters .............................................................................8-22
XIXCPSB Symbolic Parameters...............................................................................8-22
XIXCACB Symbolic Parameters .............................................................................8-23
Rebuild Control Segment Program DD Statements ...............................................8-27
Naming Convention Rules .......................................................................................9-2
LTM and CLT Databases ...........................................................................................9-5
AUD Database ...........................................................................................................9-5
IMS Large Message Queue Requirements ...............................................................9-10
File-AID for IMS/DC Product Options.....................................................................9-15
XIXDALIA Symbolic Parameters ............................................................................9-19
Linkage Editor Control Cards.................................................................................9-19
XIXDDBD Symbolic Parameters.............................................................................9-22
XIXDPSB Symbolic Parameters ..............................................................................9-23
XIXDACB Symbolic Parameters .............................................................................9-24
Job XIXDMFS Symbolic Parameters .......................................................................9-25
XIXDALCV Symbolic Parameters ...........................................................................9-26
IDCAMS Keyword Defaults.....................................................................................9-26
XIXDALCO Symbolic Parameters...........................................................................9-26
XIXDSCXD and/or XIXDSCXS Symbolic Parameters............................................9-30
Rebuild Control Segment Program DD Statements ...............................................9-31
File-AID/EX Executive product parameter variables ..............................................10-6
xx
File-AID Single Install Image Installation and Configuration Guide
12-1.
12-2.
A-3.
A-4.
A-5.
A-6.
A-7.
A-8.
A-9.
A-10.
A-11.
A-12.
A-13.
A-14.
A-15.
B-1.
B-2.
B-3.
B-4.
B-5.
B-6.
B-7.
B-8.
B-9.
B-10.
B-11.
B-12.
B-13.
B-14.
B-15.
C-1.
E-1.
E-2.
E-3.
E-4.
E-5.
E-6.
E-7.
E-8.
E-9.
E-10.
E-11.
E-12.
E-13.
E-14.
E-15.
E-16.
E-17.
E-18.
F-1.
F-2.
F-3.
H-1.
H-2.
I-1.
I-2.
I-3.
I-4.
I-5.
J-1.
K-1.
File-AID Programs for Link Pack Area (LPA)...........................................................12-2
Prodids for File-AID products .................................................................................12-6
Sample Security Exits and JCL................................................................................. A-2
Security Exit Input Parms Layout............................................................................ A-3
Sample Audit Exits and JCL..................................................................................... A-7
Audit Exit Input Parms Layout................................................................................ A-7
Audit Exit Input/Output Parms Exit Type R Layout ............................................... A-8
Sample I/O Exits and JCL ...................................................................................... A-13
I/O Exit Communications Area ............................................................................. A-14
Sample Audit Exits and JCL................................................................................... A-16
SMF Common Header Format............................................................................... A-17
SMF Data Access Record Format............................................................................ A-17
SMF Field Update Record Format .......................................................................... A-19
SMF Comprehensive Update Record Format ........................................................ A-19
Dataset Update Summary Record Format ............................................................. A-20
Sample Audit Exits and JCL......................................................................................B-2
Audit Exit Input Parms Layout.................................................................................B-3
Audit Exit Input/Output Parms Exit Type R Layout ................................................B-3
Sample Audit Exits and JCL......................................................................................B-5
SMF Common Header Format..................................................................................B-6
SMF Data Access Record Format...............................................................................B-7
SMF Field Update Record Format .............................................................................B-8
SMF Comprehensive Update Record Format ...........................................................B-9
Dataset Update Summary Record Format ................................................................B-9
Supplied Date Pattern Exits ....................................................................................B-11
Date Exit Compile/Link JCL ...................................................................................B-13
Data Solutions Field-Level Exits .............................................................................B-14
Field-Level Exit Complile/Link JCL ........................................................................B-16
Data Solutions Encryption/Decryption Exits .........................................................B-20
Field-Level and Encryption Exit Compile/Link JCL...............................................B-21
CBLAPI0* Function Codes....................................................................................... C-1
Common Input Parms Passed To All Exit Types ......................................................E-6
Common Output Parms for All Exit Types ..............................................................E-7
Input Parms for Exit Type A .....................................................................................E-7
Input Parms for Exit Type O.....................................................................................E-8
Input/Output Parms for Exit Type B ........................................................................E-8
Input/Output Parms for Exit Type N........................................................................E-8
Input/Output Parms for Exit Type R ........................................................................E-9
Input/Output Parms for Exit Type I .........................................................................E-9
Concatenation Control Parameter Structure .........................................................E-12
Concatenation Control Parameters........................................................................E-12
Data Exit Input Parms ............................................................................................E-19
Data Exit Output Parms..........................................................................................E-21
Data Exit Output Parms..........................................................................................E-22
Input/Output Parameters for the XIXTDLI EXIT...................................................E-27
Input Parameters for the Audit Trail Write Exit.....................................................E-29
Output Parameters for the Audit Trail Write Exit ..................................................E-29
Input Parms ............................................................................................................E-31
Input/Output Parms ...............................................................................................E-31
DBD Update Program DD Statements...................................................................... F-6
Segment Layout Dataset Types................................................................................. F-8
XREF Update Program DD Statements................................................................... F-15
File-AID/RDX Encryption Exit Output Parameters ................................................. H-1
File-AID/RDX Encryption Exit Input Parameters .................................................... H-2
Training File Options Variables................................................................................ I-2
Tables Used During Installation of Sample Data ..................................................... I-7
Translate Tables ........................................................................................................ I-8
Parent and Dependent MVS objects - Sample Data ............................................... I-10
Tables Created During Installation of Sample Data............................................... I-12
Product Datasets ....................................................................................................... J-1
File-AID/MVS Batch Option Parameters ................................................................. K-1
xxi
K-2.
K-3.
K-4.
K-5.
K-6.
K-7.
M-1.
File-AID/MVS Online Option Parameters ............................................................... K-3
File-AID/Data Solutions Batch Option Parameters ................................................. K-5
File-AID/Data Solutions Online Option Parameters ............................................... K-6
File-AID for IMS/ISPF Parameters ............................................................................. K-9
File-AID for IMS/CICS Parameters.......................................................................... K-11
File-AID for IMS/DC Parameters............................................................................. K-11
Validation of File-AID/RDX Configuration Values .............................................. M-19
xxii
File-AID Single Install Image Installation and Configuration Guide
xxiii
Introduction
Intro
This guide is intended for system programmers and database administrators responsible
for the installation and/or configuration of the following z/OS versions of Compuware
File-AID products:
• File-AID/MVS
• File-AID/Data Solutions
• File-AID/RDX
• File-AID for DB2
• File-AID for IMS, including File-AID for IMS/ISPF, File-AID for IMS/CICS, and File-AID
for IMS/DC
• File-AID/EX Enterprise Edition
It describes how to install these File-AID products as a single install image using IBM’s
SMP/E facility and includes the procedures for configuring and customizing each
product. Detailed knowledge of your environment is helpful to complete the installation
and configuration process.
Manual Structure
This File-AID Single Install Image Installation and Configuration Guide is composed of the
following chapters:
• Chapter 1, “Overview”: This chapter explains the composition and purpose of the
File-AID products, and provides installation considerations and requirements.
• Chapter 2, “File-AID Configuration Facility”: Detailed step-by-step process for
completing the configuration of the File-AID Common Component PARM modules
for all File-AID products.
• Chapter 3, “File-AID/MVS Product Configuration”: Detailed step-by-step process
for completing the customization of File-AID/MVS.
• Chapter 4, “File-AID/Data Solutions Product Configuration”: Detailed step-bystep process for completing the customization of File-AID/Data Solutions.
• Chapter 5, “File-AID/RDX Product Configuration”: Detailed step-by-step process
for completing the customization of File-AID/RDX.
• Chapter 6, “File-AID for DB2 Product Configuration”: Detailed step-by-step process for completing the customization of File-AID for DB2.
• Chapter 7, “File-AID for IMS/ISPF Product Configuration”: Detailed step-by-step
process for completing the customization of File-AID for IMS/ISPF.
• Chapter 8, “File-AID for IMS/CICS Product Configuration”: Detailed step-by-step
process for completing the customization of File-AID for IMS/CICS.
• Chapter 9, “File-AID for IMS/DC Product Configuration”: Detailed step-by-step
process for completing the customization of File-AID for IMS/DC.
xxiv
File-AID Single Install Image Installation and Configuration Guide
• Chapter 10, “File-AID/EX Enterprise Edition Product Configuration”: Detailed
step-by-step process for completing the customization of File-AID/EX Enterprise Edition (File-AID/EX Executive).
• Chapter 11, “Verifying File-AID Installation”: Instructions for verifying the correct
installation of the File-AID products.
• Chapter 12, “Site Deployment”: Instructions for making the File-AID products
available on your system when the LIBDEF method was not chosen under
Configuration Facility and information on making modifications for VSAM Space
Manager Pool Names or Volume Allocation.
• Appendix A, “File-AID/MVS Exits”: Description of and procedures for installing the
audit trail exits and sample user I/O exits shipped with File-AID/MVS.
• Appendix B, “File-AID/Data Solutions Exits”: Description of and procedures for
installing the audit trail exits and sample user I/O exits shipped with File-AID/Data
Solutions. Also includes description of the SMF recording function and procedures
for installing, modifying, and removing it. Instructions for creating customized date,
field level, and encryption routine exits for File-AID/Data Solutions.
• Appendix C, “Call to File-AID/Data Solutions with the API”: Instructions for
creating customized program calls to File-AID/Data Solutions.
• Appendix D, “File-AID for DB2 Audit Trail Facility”: Description of and procedures
for installing the File-AID for DB2 audit trail exit.
• Appendix E, “File-AID for IMS Exits”: Describes various File-AID for IMS exits.
• Appendix F, “File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF
Update”: Describes the Batch DBD and XREF Update Facilities for File-AID for
IMS/CICS and File-AID for IMS/DC.
• Appendix G, “Refreshing the Relationship File”: Presents procedures for loading
and refreshing the relationship file with information on table relationships.
• Appendix H, “File-AID/RDX Encryption Exit”: Contains procedures for installing
the encryption exit.
• Appendix I, “Installing Training Files”: Instructions for creating training files with
sample data for use with the File-AID products.
• Appendix J, “Advanced Configuration and Porting Techniques”: Describes the
procedures for porting the completed File-AID installation to another LPAR.
• Appendix K, “Parameter Cross-Reference Lists”: Lists File-AID parameters with
their pre-Release 10.1 names.
• Appendix L, “File-AID EP Media Tabs”: contains the description of the File-AID
Extended Play (EP) media tabs.
• Appendix M, “File-AID Health Checker”: contains the description of the
Compuware Health Check Controller and lists the available File-AID Health Checks.
Intended Audience
This manual is intended for installers and application programmers. It is only to be used
for installing and configuring the z/OS versions of Compuware File-AID products.
Related Publications
For more information about the File-AID mainframe products, access the individual
File-AID product documentation from the Compuware Go customer support website at
http://go.compuware.com.
Introduction
xxv
A RFN order e-mail also includes a copy of the Compuware Installer Mainframe Products SMP/E
Installation Guide.
For more information about Compuware Workbench, Compuware Shared Services (CSS),
and Host Communication Interface (HCI), access their documentation from the
Compuware Go customer support website at http://go.compuware.com.
For more information on compiling COBOL, PL/I, Assembler, or C/C++ programs, refer to
the appropriate IBM manuals.
Instructions for accessing this documentation are given in the following paragraphs.
Customer Support Website
Access online technical support for Compuware products through our Compuware Go
(FrontLine) customer support website. View or download documentation, frequently
asked questions, and product fixes, or e-mail Compuware with questions or comments.
To access Compuware Go, you must first register and obtain a password at
http://go.compuware.com/.
Online Documentation
The File-AID Receive from Network (RFN) product installation package does not include
the product documentation. Access the File-AID documentation from the Compuware Go
customer support website at http://go.compuware.com in the following electronic
formats:
•
•
•
•
Release Notes in HTML format
Product manuals in PDF format
Adobe PDF index file (PDX file)
Product manuals in HTML format.
The product documentation is available for viewing or downloading:
• View PDF files with the free Adobe Reader, available at http://www.adobe.com.
• View HTML files with any standard web browser.
World Wide Web
Compuware’s site on the World Wide Web provides information about Compuware and
its products. The address is http://www.compuware.com.
Accessibility Information
Compuware is committed to making its products and services easier for everyone to use.
This section provides information about the features that make File-AID more accessible
for people with disabilities. This section also applies to File-AID’s features and
components.
File-AID is a mainframe application designed to run on IBM's OS/390 or z/OS operating
systems, utilizing IBM’s ISPF on IBM 327x-type terminals. This platform offers few if any
accessibility features in the mainframe environment referenced above. Due to this fact,
Compuware Corporation has focused its attention in regard to the accessibility of its
mainframe products in the area of emulated 3270 sessions on personal computers (PCs)
with Windows operating systems. File-AID supports and/or does not disrupt, with few
exceptions, Windows accessibility features and Windows-based Assistive Technology (AT)
devices and software such as Braille devices, screen readers, and magnifiers.
xxvi
File-AID Single Install Image Installation and Configuration Guide
Look for more information on accessibility features on our Compuware Go customer
support website at http://go.compuware.com/.
Note: File-AID is a mainframe system development tool intended for use by mainframe
systems software developers/programmers. Much of the input and output used
and produced by File-AID, such as program execution statistics, are not easily
understood by the general public, nor are they intended to be. Unfortunately, as
in the case of File-AID reports, data/information in these formats by its very
nature can be confusing to screen readers, and therefore to those who use them
as well. Effective use of this application requires the specialized knowledge of a
mainframe systems software developer/programmer.
Documentation Accessibility
Documentation is provided in PDF and other formats. The PDF documents provide the
best accessibility because they are tagged to enable reflow and correct reading order.
Notation Conventions
This section describes common terms and syntax conventions used in this manual. A
change bar (|) indicates an update to the manual for this release.
Terminology
The following notation rules are used throughout this document:
• Minimum strings for commands and keywords are shown in UPPERCASE characters
and must be spelled exactly as shown.
• All variables are user-specified values; they are printed in lowercase italics. For
example, dataset-name indicates that you are to substitute a value.
Getting Help
Compuware provides a variety of support resources to make it easy for you to find the
information you need.
Compuware Go Customer Support Website
You can access online information for Compuware products via our Compuware Go
customer support website at http://go.compuware.com.
Compuware Go provides access to critical information about your Compuware products.
You can review frequently asked questions, read or download documentation, access
product fixes, or e-mail your questions or comments. The first time you access
Compuware Go, you are required to register and obtain a password. Registration is free.
Compuware now offers User Communities, online forums to collaborate, network, and
exchange best practices with other Compuware solution users worldwide. To join, go to
http://groups.compuware.com.
Introduction
xxvii
Contacting Customer Support
Phone
• USA and Canada: 1-800-538-7822 or 1-313-227-5444.
• All other countries: Contact your local Compuware office. Contact information is
available at http://go.compuware.com.
Web
You can report issues via the Quick Link Create & View Support Cases on the
Compuware Go home page.
Note: Please report all high-priority issues by telephone.
Mail
Compuware Customer Support
Compuware Corporation
One Campus Martius
Detroit, MI 48226-5099
Corporate Website
To access Compuware’s site on the Web, go to http://www.compuware.com.
The Compuware site provides a variety of product and support information.
xxviii
File-AID Single Install Image Installation and Configuration Guide
1-1
Chapter 1.
Overview
Chap 1
This chapter explains the composition of the z/OS versions of Compuware File-AID
products, provides overview information as well as installation and configuration
considerations and requirements.
File-AID Single Install Image
The z/OS versions of the Compuware File-AID products are delivered and installed as one
File-AID Single Install Image when you order any or all of the File-AID mainframe
products. The license key(s) you receive from Compuware determine which of the
File-AID products you can activate and execute.
The products, or components, of the File-AID Single Install Image are:
• File-AID/MVS
• File-AID/Data Solutions
• File-AID/RDX
• File-AID for DB2
• File-AID for IMS, including File-AID for IMS/ISPF, File-AID for IMS/CICS, and File-AID
for IMS/DC
• File-AID/EX Enterprise Edition
License Management System (LMS)
Compuware provides the License Management System (LMS) to help manage access to
Compuware’s products at your site. The LMS includes several components that together
allow you to establish, maintain, diagnose, and upgrade access to the Compuware
products licensed by your enterprise.
Install LMS from the Enterprise Common Components (ECC) installation media.
Separately, via e-mail you receive a License Certificate for each File-AID product.
IMPORTANT:
Each licensed File-AID operation requires these steps:
1. Ensure that the Compuware License Management System has been installed from the
ECC installation media.
Refer to the Compuware Enterprise Common Components Installation and Customization
Guide for installation procedures. This step is only necessary for a first-time install of
LMS or when upgrading the License Management System itself.
2. Import the License Certificate into your License File.
3. Establish and update the Runtime License Management System by running the
program LMSINIT.
Refer to the “License Certificate Import Checklist” section in the Compuware License
Management User/Reference Guide for detailed instructions.
1-2
File-AID Single Install Image Installation and Configuration Guide
File-AID/MVS
File-AID/MVS consists of two components: File-AID/MVS and File-AID/Batch.
File-AID/MVS is an interactive full-screen product designed for use by applications and
systems programmers. It provides the ability to easily access and manipulate VSAM,
BDAM, PDS, IAM, CA Panvalet, CA Librarian, and sequential files without any
programming.
File-AID/Batch consolidates the functions of most standard IBM utilities. You can use
File-AID/Batch to run jobs instead of using specialized selection programs. After
execution, File-AID/Batch can print a report that shows the number of records read and
written and the number of records processed by the various functions within
File-AID/MVS.
File-AID/Data Solutions
File-AID/Data Solutions is an interactive software product that allows you to use
automated and repeatable processes to update information in your data files. It provides
functions for converting euro currencies, aging dates for testing, encrypting sensitive
data, translating data values, and generating test data.
File-AID/Data Solutions’ date analysis feature simplifies the identification of date fields.
Its formatted field exits enable you to create consistent and reliable test data for a variety
of business functions. The data analysis field exit analyzes the data in a field and reports
whether the data is valid or invalid.
File-AID/RDX
File-AID/RDX enables programmers and database administrators to easily extract and
load a complete subset of related MVS and/or DB2 data. Data related by referential
integrity or application-defined relationships can be copied within the MVS and/or DB2
environment with full support for all relational constraints.
File-AID for DB2
File-AID for DB2 is a self-contained DB2 database management and testing tool that lets
you create, populate, customize and refresh data in your DB2 database with ease. The
File-AID for DB2 interface is very similar to that of ISPF. The product’s familiar look and
feel helps you learn and use it quickly.
File-AID for IMS
File-AID for IMS/ISPF, File-AID for IMS/CICS or File-AID for IMS/DC provide the ability to
easily access and manipulate data within IMS databases. The databases can be browsed or
edited in any of the following modes directly under TSO/ISPF, CICS or IMS/DC
respectively:
• Formatted using COBOL or PL/I segment layouts
• Unformatted in hexadecimal
• Hierarchical sequence with one segment per screen line
File-AID for IMS/FLEX is a general purpose IMS database manipulation tool for use by
business professionals involved in modifying or reporting on the contents of IMS
databases. File-AID for IMS/FLEX extends the capabilities of File-AID for IMS to the MVS
batch environment.
Overview
1-3
File-AID/EX Enterprise Edition
File-AID/EX Enterprise Edition is an optional addition to File-AID/EX (a Windows based
version of File-AID for working with distributed LUW data). It provides the MVS Access
Modules that enable a developer to access mainframe data on z/OS.
The MVS Access Modules supply the z/OS data sources to the File-AID/EX Execution
Server. The access modules can accept requests from a File-AID/EX Execution Server
running locally or from a remote File-AID/EX Execution Server connected over the
network. The MVS Access Modules use TCP/IP communications connections to
communicate over the network. The supported z/OS data sources are: VSAM, QSAM, IMS,
and DB2 UDB z/OS. By moving related DB2 data types to a distributed database,
File-AID/RDX extract files are also supported.
Installation Considerations
Product Delivery Options
Compuware has made the following product delivery options available:
• Receive From Network (RFN)
• Extended Play (EP) media on DVD or electronic FTP download
Receive From Network (RFN)
The Receive From Network (RFN) process enables you to receive the File-AID Single
Install Image (including all File-AID mainframe products) directly to your z/OS
environment and install it using System Modification Program Extended (SMP/E).
After completing your product order from Compuware’s online ordering system, you
receive an e-mail message containing sample JCL to FTP the Compuware Installer which
has been customized to include installation information of your current order. Your order
e-mail also includes a copy of the Compuware Installer Mainframe Products SMP/E Installation
Guide (CompuwareInstaller.pdf). The e-mail may also contain links for downloading any
PC-based products that may have been ordered at the same time.
Note: For the RFN process, always use the customized Compuware Installer dialog PDS
that you receive with your current order.
The Compuware Installer is used to generate the JCL for SMP/E processing of your
Compuware mainframe products, including the Receive From Network step which FTPs
the binary data from the Compuware FTP site directly to your z/OS Environment.
Extended Play (EP) Media
File-AID can also be delivered as part of the File-AID installation media (DVD) or
electronic FTP download.
Information on the Product Media Label
When File-AID is delivered as part of the File-AID installation media, some of the label
information applies to installation capability, as noted below:
This DVD contains : List of the included File-AID products identifying each product’s
name and release number.
Security : Minimum level of Compuware’s License Management System required.
1-4
File-AID Single Install Image Installation and Configuration Guide
Created on : The File-AID installation media label shows when it was made. Compare
this creation date with any maintenance posted on the Compuware Go customer
support website at http://go.compuware.com.
If additional maintenance has become available since the date on the installation
DVD, either download the maintenance from the Compuware Go customer support
website, or call File-AID Customer Support to request a new installation media with
the current maintenance.
The product IDs (Prodid) of the File-AID products is determined by the following delivery
media:
Media
Prodid
Prodid Example
File-AID EP
FJnnnnnn
FJ100200
RFN
FMID
MXVJA20
IMPORTANT:
Compuware recommends to install the File-AID Single Install Image only from one
delivery method. Verify that the File-AID Single Install Image Release 10.2 has not
been installed before attempting to install; look for FMID MXVJA20.
SMP/E Installation
Follow the procedures as described in the Compuware Installer Mainframe Products SMP/E
Installation Guide. After the successful SMP/E installation, continue with the product
configuration as described in Chapter 2, “File-AID Configuration Facility”.
Table 1-1 shows variances in the naming of the installation components for the File-AID
Single Install Image depending on the selected distribution media and SMP/E installation
options.
Table 1-1.
Important Variances in Installation Options depending on media
Installation
Component
Receive From Network
(RFN)
File-AID SMP/E Install
from Media Browser
File-AID SMP/E Install
Using ISPF
UNLOAD file
N/A
FJnnnnnn.UNLOAD
FJnnnnnn.UNLOAD
Compuware Installer
dialog PDS
hlq.CPWRKCW.Vnnnnnn.I
NS
N/A
hlq.CPWR.INS
Compuware Installer
REXX CLIST
$$CWINST
N/A
$$CWINST
Installation Variables
Work dataset
“Step 3. Specify DSN for
Installation Settings ISPF
Table” on page 2-6 of the
Compuware Installer
Mainframe Products SMP/E
Installation Guide
FJnnnnnn.SMPE.DATA
“Step 2. Specify DSN
for Installation Settings
ISPF Table” on page B-5
of the Compuware
Installer Mainframe
Products SMP/E
Installation Guide
Table 2-1 on page 2-17 of Table A-1 on page A-12 of
the Compuware Installer
the Compuware Installer
SMP/E Installation Jobs
Mainframe Products SMP/E Mainframe Products SMP/E
Installation Guide
Installation Guide
Sample library
CPWR.MXVJA20.SXVJSAMP
Configuration Facility
CLIST in Sample library
XVJ$$CFG
Table B-1 on page B-15
of the Compuware
Installer Mainframe
Products SMP/E
Installation Guide
Overview
1-5
SMP/E Maintenance
Compuware recommends that you periodically obtain and apply maintenance to keep
your product version current. All maintenance for File-AID and each of its releases is
provided on the Compuware Go (FrontLine) customer support website at
http://go.compuware.com.
Locate the Fixes and Downloads section for the File-AID product and select the release
for which you wish to apply maintenance. Follow the instructions on the website for
acquiring the maintenance.
Optionally, you may acquire cumulative maintenance from Compuware’s online
ordering system, or by getting a current copy of the File-AID EP media and using it to
generate the JCL for applying maintenance via SMP/E.
To install the File-AID maintenance to an existing installation, perform the steps
described in Chapter 3, “Apply Maintenance with SMP/E” of the Compuware Installer
Mainframe Products SMP/E Installation Guide.
IMPORTANT:
If your File-AID installation chose to combine customized libraries (CUSTLIB=Y see
“CUSTLIBS” on page 2-15), after applying maintenance, you will need to copy your
updated SXVJLOAD, SXVJCLIB, and SXVJSENU target libraries to their combined
customized libraries CXVJLOAD, CXVJCLIB and CXVJSENU. You should use ISPF or
File-AID copy functions or execute the IEBCOPY utility to perform the copy. Be sure
to choose the option to replace existing members. The customized libraries are by
default allocated as PDSE and should allow the copy without issue.
If you have chosen to allocate your own customized libraries that are not PDSE, you
will need to ensure that there is sufficient space (double the size used) to allow an
update of most of the members. Also, you should perform a compress after the copy.
File-AID Configuration Considerations
The File-AID Common Component module XVJOPUNV is required for the installation
and execution of all Compuware Mainframe File-AID products as well as the File-AID
Eclipse and File-AID Data Privacy plug-ins of the Compuware Workbench. Module
XVJOPUNV is initially generated by the user during configuration and may be reused
henceforth.
Note: All products in this File-AID Single Install Image are on the same release level.
Compuware recommends that you activate all of your licensed File-AID
mainframe products at the same time to avoid compatibility issues between
different release levels.
File-AID Packaging
Compuware has registered the following element prefixes with IBM for the File-AID
components:
•
•
•
•
•
•
•
XVJ for File-AID Common Component
XFD for File-AID for DB2
UDA for File-AID/Data Solutions
XFA for File-AID/MVS
XFR for File-AID/RDX
XIX for File-AID for IMS
XFE for File-AID/EX Enterprise Edition
The FMIDs for each component are listed below.
1-6
File-AID Single Install Image Installation and Configuration Guide
•
•
•
•
•
•
•
•
•
•
•
•
•
•
MXVJA20 - File-AID Common Component 10.2.0 modules
NXVJA20 - File-AID Common Component 10.2.0 Japanese language modules
MXFDA20 - File-AID for DB2 10.2.0 modules
NXFDA20 - File-AID for DB2 10.2.0 Japanese language modules
MUDAA20 - File-AID/Data Solutions 10.2.0 modules
NUDAA20 - File-AID/Data Solutions 10.2.0 Japanese language modules
MXFAA20 - File-AID/MVS 10.2.0 modules
NXFAA20 - File-AID/MVS 10.2.0 Japanese language modules
MXFRA20 - File-AID/RDX 10.2.0 modules
NXFRA20 - File-AID/RDX 10.2.0 Japanese language modules
MXIXA20 - File-AID for IMS/ISPF 10.2.0 modules
PXIXA20 - File-AID for IMS/ISPF 10.2.0 Japanese language modules
NXIXA20 - File-AID for IMS/CICS 10.2.0 modules
OXIXA20 - File-AID for IMS/DC 10.2.0 modules
Installation Time
Allow 1-4 hours to install the File-AID Single Install Image and configure the individual
File-AID products depending on the availability of system resources.
New File-AID Releases
As part of your maintenance agreement with Compuware, periodic upgrades with
additional capabilities will be made available.
When installing a new release of File-AID products, Compuware recommends that you
create new libraries to verify the installation.
Access to File-AID Programs
If your site uses security processing (e.g., ACF2 or Topsecret ), or a command restricting
utility (e.g., TSO Program Control Facility II) that regularly restricts programs that can be
used as TSO commands, ensure that File-AID commands are available to your users and
do not fall under this restriction. If the commands are restricted, the message “command
NOT FOUND” is received.
Note: These commands must NOT be authorized.
If ACF2 is installed at your site, add the commands to the module referred to by the
CMDLIST field of the GSO TSO record. This module should be link edited into the system
linklib with the RENT attribute. Refresh the link list to make the changes effective.
Configuration Facility
XVJPRM
XVJPRMT

File-AID/MVS
XFASPF
Link Pack Area Method Considerations
If you place XFASPF in LPALIB (see also “Step 1 — Add the File-AID Load Library to
Your System” on page 12-1) you may need to update your ISPTCM table with an
entry for XFASPF. Without this update you may get the error message "COMMAND
XFASPF NOT FOUND". The entry for XFASPF should specify
FLAG=42,ENTNAME=XFASPF to indicate that XFASPF is invoked as a command. For
more details on the ISPTCM table, consult the IBM reference manuals on the ISPF
TSO Command Table.
Overview
1-7
File-AID/Data Solutions
UDASPF

Link Pack Area Method Considerations
If you place UDASPF in LPALIB (see also “Step 1 — Add the File-AID Load Library to
Your System” on page 12-1) you may need to update your ISPTCM table with an
entry for DASPF. Without this update you may get the error message “COMMAND
UDASPF NOT FOUND”. The entry for UDASPF should specify
FLAG=42,ENTNAME=UDASPF to indicate that UDASPF is invoked as a command. For
more details on the ISPTCM table, consult the IBM reference manuals on the ISPF
TSO Command Table.
File-AID/RDX
XFRINIT
XFREXED
XFRSWCH
XFRTATUS
XFRCMDS
F2FAD
XFREXEC
FRSPZ
File-AID for DB2
F2EDIT
F2EDITP
F2ENTRY
F2FAD

DBUSB00
DBADMNC
F2EDITL
F2FADB2
F2LFANAP
F2MENU
F2PRCMD
F2TORDX
F2XCMD
F2XXK50
F2SQLIDC
F2EDCNTL
F2EDREQ
F2STATUS
DBUIB00
DBIDLIB
DBUZB00
DBIDINT2
File-AID for IMS
XIXMAIN
XVJPRM 
File-AID PDSE Libraries
Some of the File-AID libraries must be PDSE (Partitioned Data Set Extended) datasets.
Table 2-2 on page 2-11 lists all File-AID Target and Configuration Module Libraries and
identifies which libraries must be PDSEs.
Authorized Library Requirements
Compuware Workbench
The SXVJAUTH and CXVJLOAD load libraries are required to support the following
components of the Compuware Workbench:
• File-AID/Eclipse
– File-AID Data Editor
– File-AID Search
• File-AID Data Privacy
After completing the installation and configuration, the SXVJAUTH and CXVJLOAD
load libraries need only be APF Authorized in order for them to be ready to be
referenced in the CSS TP Start-up procedure as mentioned in the Compuware Workbench
Installation Guide. These libraries MUST have universal read access. There are no actual
functions in SXVJAUTH and CXVJLOAD that require authorization.
1-8
File-AID Single Install Image Installation and Configuration Guide
File-AID Load Libraries
The File-AID load libraries (SXVJLOAD and CXVJLOAD) include all SMP/E and
configuration load modules. Depending on the options used, there may be a requirement
to load some File-AID modules from an authorized library. The following options require
an authorized library:
1. Writing audit trail records to SMF (File-AID/MVS, File-AID/Data Solutions, File-AID
for DB2, and File-AID for IMS) when using APF checking SVC (SVCAPF variable set to
Y, see “SVCAPF” on page 2-23 in Table 2-3).
Note:
When using NO APF checking SVC (SVCAPF variable set to N), CXVJLOAD
and SXVJLOAD do not have to be in an APF authorized library.
2. Using File-AID/RDX Image Copy option (see “UIMGCPY” on page 5-6).
3. Using a File-AID for IMS security exit option that requests the database dataset names
be returned when running in a BMP region.
If you do not intend to use any of these options, then there are no authorized library
requirements.
If some File-AID modules must come from an authorized library, it is suggested that you
make the File-AID load libraries authorized datasets.
Note: If an unauthorized dataset is concatenated with an authorized dataset, the
authorized dataset is considered not authorized.
File-AID SVC
Above Options 1 (SMF audit trail records) and 3 (File-AID for IMS security exit) require the
File-AID SVC. If you do intend to use any of these options that require the File-AID SVC,
then you need to install the SVC, and there may be authorized library requirements.
Note: Install File-AID SVC using the File-AID Configuration Facility (see “SVC
INFORMATION” on page 2-22). A File-AID SVC generated by a release prior to
Release 10.01.00 is not compatible with File-AID Release 10.02.00. It must be
replaced with an authorized SVC generated by the File-AID Configuration Facility.
The new File-AID authorized SVC is compatible with all current and prior releases
of File-AID for IMS, File-AID/Data Solutions, and File-AID/MVS. Releases of File-AID
for DB2 prior to Release 10.01.00 cannot use an SVC generated by File-AID Release
10.02.00.
There are two variations of the SVC supplied by File-AID. One contains validation code
that, among other things, checks that the module that issued the SVC came from an
authorized File-AID library (SVCAPF variable set to Y). The other variation (SVCAPF
variable set to N) does not make this check.
If the File-AID SVC is installed as a user SVC (IGC00nnn), the MVS SVC table (IEASVC00
in SYS1.PARMLIB) must be updated to include the new SVC number. For example:
SVCPARM 253,REPLACE,TYPE(3)
/* FILEAID SVC */
After link-editing the File-AID SVC module by executing the File-AID Common
Component Configuration (see “Step 2.3 Review and Submit JCL” on page 2-25), copy
the module (IGC00nnn)from CXVJLOAD into SYS1.LPALIB. Then perform an IPL (with a
CLPA) or use a program product such as RESOLVE to make the SVC available.
Overview
1-9
Required DB2 Privileges
Compuware recommends that the installer of File-AID products for DB2 have the
SYSADM privilege in order to configure the DB2 environment module.
The installer must have the authority to execute the following DB2 commands:
BIND PACKAGE
GRANT EXECUTE ON PLAN
BIND PLAN
SET CURRENT SQLID
GRANT EXECUTE ON PACKAGE
GRANT CREATE ON COLLECTION
The person who creates the training data must have the authority to execute the
following DB2 commands:
ALTER TABLE
CREATE INDEX
GRANT SELECT
CHECK DATA
CREATE TABLE
LOAD DATA
CREATE DATABASE
CREATE TABLESPACE
DB2 System Requirements
If you are using DDF (Distributed Data Facility), define the SYSIBM.LOCATIONS table in
the DB2 catalog for each subsystem on which you plan to access a File-AID product. If it
is not present and the subsystem variable DDF Installed is YES (see also Table 2-5 on page
2-35), a bind SQL error occurs when you bind the File-AID plan.
Configuration Considerations
Any changes to the installed product(s) can be made by using the Configuration Facility
(see Chapter 2, “File-AID Configuration Facility” and each of the product specific
chapters (Chapter 3, “File-AID/MVS Product Configuration” through Chapter 10,
“File-AID/EX Enterprise Edition Product Configuration”.
Operating System and ISPF/PDF Changes
No changes are required. All File-AID products require z/OS Release 1.12 or above and its
associated ISPF/PDF release.
CPU Changes
Contact a Compuware Worldwide License Management Representative when moving the
File-AID Single Install Image to a different CPU. A new license certificate/envelope will be
issued to make this change.
Product Specific Installation Considerations
Before you begin the installation and configuration of any of the File-AID products, you
should be familiar with these product specific considerations.
File-AID/MVS
Installing File-AID/MVS in a ROSCOE Environment
The steps required to install File-AID/MVS and make it operational in a ROSCOE/ETSO
environment are in the File-AID/MVS ROSCOE Users Installation Addendum. This document is
part of your File-AID/MVS documentation set.
1-10
File-AID Single Install Image Installation and Configuration Guide
Calling File-AID/MVS from REXX
It is possible to call File-AID/MVS from REXX. The following statement should allow you
to call member XFAFAID (FILEAID is an alias of XFAFAID) in your File-AID load library
and pass any parameters if needed.
/*rexx
*/ 
ADDRESS tso
/************* OBJECT *************/

/*
*/

"ALLOC F(SYSPRINT) dataset(*)"
"ALLOC F(SYSN) DA('tsoid01.LOGON.CNTL(SYSIN1)') SHR"
"ALLOC F(DD01) DA('tsoid01.LOGON.CNTL(INPUT1)') SHR"
"ALLOC F(DD01O) DA('tsoid01.LOGON.CNTL(OUTPUT1)') SHR"
“ISPEXEC LIBDEF ISPLLIB DATASET ID(‘CPWR.MXVJA20.CXVJLOAD’) STACK
"CALL 'hlq.CPWR.MXVJA20.SXVJLOAD(XFAFAID)'",

" 'SYSIN=SYSN'"
"FREE F(SYSPRINT,SYSN,DD01,DD01O)"






Since the customized load library, CPWR.MXVJA20.CXVJLOAD, needs to be available for
the configuration PARM modules, CXVJLOAD must be allocated to the session executing
the REXX, either with explicit ISPF allocation, system LINKLST, or preallocated in the
REXX itself, as in the example above.
You will receive a return code of 8 in REXX after the call to File-AID, while File-AID
returns 0. The RC=8 will happen when zero records are copied. However, when you copy
at least one record to the output, REXX will get RC=0.
SMF Record Mapping
The File-AID SMF Record Mapping facility is shipped with the File-AID product
installation media as two libraries, SXVJSMFL and SXVJSMFX. The mapping facility
consists of PL/I record layouts (SXVJSMFL) for most of the common IBM SMF record
types and a File-AID XREF library (SXVJSMFX), containing XREF and selection criteria
member that automate the process of layout selection when browsing SMF data records.
A complete File-AID/MVS system is required to use the files on the SMF record mapping
media.
File-AID/MVS users may employ the SMF Record Mapping facility to browse raw SMF data
intelligently using the Compuware-supplied PL/I source layouts, automatic layout cross
reference (XREF) members, and File-AID’s selection logic.
The File-AID SMF Record Mapping Reference JES 4 manual provides instructions for using
Compuware’s File-AID SMF Record Mapping facility to map IBM MVS JES Version 4 or 5
SMF records.
File-AID/Data Solutions
Callable Interface
For information on using the callable interface, see Appendix C, “Call to File-AID/Data
Solutions with the API”. The sample COBOL programs are provided in your File-AID
sample dataset (KCW.MXVJA20.SXVJSAMP) members CBLCALL1 and CBLCALL2.
Note: File-AID/Data Solutions is not compatible with CICS. It cannot be run/called from
a CICS transaction.
Upgrading Custom Date Pattern and Field Level Exits
In order to use any custom Date Pattern exits or Field Level exits you may have created in
a previous release of File-AID/Data Solutions, you must expand your entry for the “old”
Overview
1-11
exit in DATELIST or EXITLIST accordingly. See Appendix B, “File-AID/Data Solutions
Exits” for more information on creating entries for DATELIST or EXITLIST.
File-AID/RDX
Installation Notes
1. File-AID/RDX 10.2 uses only static SQL to access the DB2 system catalog tables.
Link-Edit Other Modules Depending on Site Requirements
For accessing CA Librarian or CA Panvalet libraries with File-AID/RDX: Use the
appropriate JCL member(s) in the Sample file after you have successfully installed
File-AID/RDX.
’hlq.KCW.MXVJA20.SXVJSAMP(XFRLK***)’
• XFRLKLIB (Librarian Sites Only): This member link-edits the File-AID Librarian
interface with the site’s Librarian system.
• XFRLKPAN (Panvalet Release 12A or Earlier Sites Only): This member link-edits
the File-AID Panvalet interface with the site’s Panvalet system.
• XFRLKPN1 (Panvalet Release 12B or Later Sites Only): This member loads the
File-AID Panvalet interface rather than static linking it.
• For sites with both CA Panvalet and CA Top Secret installed that want to browse
Panvalet files to which you only have READ access, refer to the TSSPAN11 exit in
your CA Panvalet System Management Guide.
File-AID for DB2
Audit Trail Exit
The Audit Trail Facility allows you to keep a record of table data modifications made with
File-AID for DB2 Edit. If you request an audit trail, an audit trail exit routine is executed
prior to the edit session. File-AID for DB2 is delivered with the audit trail facility inactive.
The procedures for activating the facility are optional. If you choose to activate the
facility and optionally modify the exit routine, you may wish to have the exit reviewed
while the installation is in progress. For additional audit trail information, see Appendix
D, “File-AID for DB2 Audit Trail Facility”.
Product Interfaces
File-AID for DB2 provides an interface to the Compuware products listed below.
Xpediter for DB2
Xpediter for DB2 extension is an option (XT) with File-AID for DB2. It allows you to
dynamically enter and experiment with SQL statements during an Xpediter/TSO
interactive test session without stopping to compile or bind.
To install the interface, you must set variable “F2XPOPT” to YES (see “F2XPOPT” on page
6-9) and make the Xpediter/TSO libraries available. To make the Xpediter/TSO libraries
available, copy XPSTART from SXVJCLIB to CXVJCLIB, uncomment the XT allocations
and libdefs and enter the proper Xpediter/TSO library names.
You can also make the Xpediter/TSO libraries available via your own linklist or logon
proc.
Additionally, you must complete the Xpediter/TSO installation procedure found in the
Xpediter/TSO Installation Guide as well as the procedures described in this manual.
1-12
File-AID Single Install Image Installation and Configuration Guide
DBA-XPERT for DB2
DBA-XPERT for DB2 includes a direct interface to File-AID for DB2. If you install the
interface option, you can invoke File-AID for DB2 Browse, Edit, and SQL Analysis
functions from DBA-XPERT. However, the Browse, Edit, and SQL Analysis functions are
not available from the File-AID for DB2 Object Administration utility. See the DBA-XPERT
for DB2 Installation Guide for instructions on installing the interface.
Note: If your installation uses this interface option, you must modify your DBA-XPERT
for DB2 installation to change the default File-AID for DB2 APPLID to FD48. For
more information, refer to the heading “Modifying a Product Option” in Chapter
5 of the DBA-XPERT for DB2 Installation Guide.
Xpediter and Abend-AID
Xpediter and Abend-AID batch compile processes can include the JCL necessary to run
File-AID for DB2’s Batch Explain. You can receive an explain report at compile time. No
special installation procedure is required to activate this feature. For more information,
see the File-AID for DB2 Reference Manual.
Library Management Tools
File-AID for DB2 provides an interface to both CA Panvalet and CA Librarian. The SQL
Source Analysis and Development facility can be used to analyze members stored in
either CA Panvalet or CA Librarian without the need to copy the member into a
sequential or partitioned dataset.
If you have a library management tool, for example CA Librarian, or CA Panvalet, review
the CLIST member that corresponds to your source editor and modify it if necessary
(Table 1-2). The CLISTs are located in hlq.CPWR.MXVJA20.SXVJCLIB.
Table 1-2.
CLIST by Source Editor
Source Editor
CLIST Member
Library Management Tool
F2EDLIBR
CA Panvalet
F2EDPANV
File-AID for IMS/ISPF
There are a number of execution environment items that need to be considered during
the installation process. Refer to “Product Overview” on page 7-1 for detailed
information.
File-AID for IMS/CICS
There are a number of execution environment items that need to be considered during
the installation process. Refer to “Product Overview” on page 8-1 for detailed
information.
File-AID for IMS/DC
There are a number of execution environment items that need to be considered during
the installation process. Refer to “Product Overview” on page 9-1 for detailed
information.
File-AID/EX Enterprise Edition
File-AID/EX Enterprise Edition is an optional addition to File-AID/EX. It provides the
MVS Access Modules that enable a developer to access mainframe data on z/OS. You must
set up a license before you can execute the MVS Access Modules.
Overview
1-13
The MVS Access Modules supply several z/OS data sources to the File-AID/EX Execution
Server. The access modules can accept requests from a File-AID/EX Execution Server
running on a client workstation or from a remote File-AID/EX Execution Server
connected over the network. The MVS Access Modules use TCP/IP communications
connections to communicate over the network. The supported z/OS data sources are:
VSAM, QSAM, and IMS. By moving related DB2 data types to a distributed database,
File-AID/RDX extract files are also supported.
Figure 1-1 on page 1-13 represents the flow of communication among the facilities of the
File-AID/EX Enterprise Edition.
Figure 1-1. File-AID/EX Enterprise Edition Communication Flow
File-AID/EX
Oracle
File-AID/EX
Enterprise
Edition
MVS Access
Modules
SQL
Server
IMS
VSAM ESDS
Sybase
VSAM KSDS
QSAM
DB2
UDB
File-AID/RDX
Extract
Flat File
ASCII
Sequential
File
XML
1-14
File-AID Single Install Image Installation and Configuration Guide
2-1
Chapter 2.
File-AID Configuration Facility
Chap 2
This chapter provides the information and procedures to configure and customize
File-AID mainframe products once the SMP/E installation has completed (see Chapter 2,
“RFN SMP/E Installation of Compuware Mainframe Products” or Appendix A, “SMP/E
Installation Using the EP Media Interface” of the Compuware Installer Mainframe Products
SMP/E Installation Guide). Configure and customize the File-AID products using the
Configuration Facility CLIST XVJ$$CFG, an automated ISPF-like procedure designed to
reduce the complexity of the Configuration.
Use the File-AID Configuration Facility during the initial installation of your File-AID
products to create your site specific parameter modules and anytime thereafter when you
want to modify any of your File-AID parameter modules.
The Configuration Facility CLIST XVJ$$CFG is located in the sample library, e.g.
hlq.CPWR.MXVJA20.SXVJSAMP.
Overview
PARM modules
The Configuration Facility allows you to specify the site specific parameters for all your
File-AID mainframe products. It creates the PARM modules to be used during execution
of the File-AID products. Since the configuration utility is a stand-alone function
embedded in the SXVJSAMP file, not only can the original SMP/E target libraries be
customized, but cloned target libraries, on any LPAR, can also easily be reviewed and/or
customized.
The configuration modules will be used at the execution start of the product components
to load the variables into the existing control blocks. Load modules created at
configuration time contain the values required for the products. The pertinent modules
will be used to populate the control blocks within each product. There is NO executable
code in a PARM module. Once created, the PARM modules are designed for continued
reuse of the parameters from release to release.
Configuration data is stored in the PARM (load) modules. They have fixed names for each
group of parameters. Use the Configuration Facility to create all common modules
needed by all individual products and only those product specific load modules you need
to run the products for which you are licensed. You can use the Configuration Facility to
create new modules, update or copy existing modules. Optionally, you could have
multiple PARM modules of the same name with different configurations and use
JOBLIB/STEPLIB search processing to activate the one(s) you wish to use. Table 2-1 lists
the PARM modules names.
Table 2-1.
PARM modules
Component
Module Name
Shared configuration data
File-AID Common Component (required
for all products)
XVJOPUNV
DB2 subsystem environment
XVJOPDB2
IMS environment
XVJOPIMS
2-2
File-AID Single Install Image Installation and Configuration Guide
Table 2-1.
PARM modules (Continued)
Component
Data Privacy environment
Module Name
XVJOPDPR
Individual product configuration data
File-AID/MVS
XVJOPXFA
File-AID/Data Solutions
XVJOPUDA
File-AID for DB2
XVJOPXFD
File-AID for IMS/ISPF
XVJOPXIX
File-AID for IMS/CICS
XVJOPNIX
File-AID for IMS/DC
XVJOPOIX
File-AID/RDX
XVJOPXFR
File-AID/EX Enterprise Edition
XVJOPXFE
The design intent of the Configuration Facility is to create stand-alone and reusable
configuration data. The Configuration Facility uses SMP/E product datasets (or clones
thereof) as input and generates parameter modules as output. These parameter modules
can then be deployed as necessary across different LPARs. Once in place, any subsequent
File-AID installs only need to roll out the new SMP/E generated datasets using the
existing configuration modules. Each customer site is free to design a deployment
scheme that suits its needs. Appendix J, “Advanced Configuration and Porting
Techniques” provides additional information on this topic.
Required Datasets:
You will need the following datasets for the Configuration Facility:
• File-AID Sample library, hlq.CPWR.MXVJA20.SXVJSAMP
• The set of executable datasets needing to be configured
Optional Datasets:
• Configuration Module Library (CXVJLOAD) of a previous File-AID release starting
with Release 10.1
• Installation Settings ISPF Table dataset specified in “Step 3. Specify DSN for
Installation Settings ISPF Table” on page 2-6 of the Compuware Installer Mainframe
Products SMP/E Installation Guide.
• Installation dataset(s) of a previous release of File-AID product(s) prior to Release
10.1
Installation Variables
• Compuware Installer
When using the Compuware Installer for the SMP/E installation of the File-AID
products (Chapter 2, “RFN SMP/E Installation of Compuware Mainframe
Products” or Appendix A, “SMP/E Installation Using the EP Media Interface” of
the Compuware Installer Mainframe Products SMP/E Installation Guide), many entered
variables are saved in the dataset specified in “Step 3. Specify DSN for
Installation Settings ISPF Table” on page 2-6 of the Compuware Installer Mainframe
Products SMP/E Installation Guide for later optional reuse in the Configuration
Facility (see “Source of Parameter Values” on page 2-6). Do not manually alter
these tables.
• Media Browser (File-AID EP)
When using the SMP/E installation (Appendix A, “SMP/E Installation Using the
EP Media Interface” of the Compuware Installer Mainframe Products SMP/E Installation
File-AID Configuration Facility
2-3
Guide) all entered variables are saved in member FJ of the
hlq.FJ100200.SMPE.DATA dataset. The Configuration Facility, however, does NOT
use any data from SMPE.DATA.
Configuration Procedures
Once invoked, the Configuration Facility prompts you for information and provides help
for screens and input fields to guide you through the Configuration and Customization
process.
The Configuration procedure consists of the following steps:
“Step 1. Execute the File-AID Configuration CLIST”
“Step 2. Specify File-AID Common Component Parameters”
“Step 2.1 Specify Configuration Module Dataset Names”
“Step 2.2 Specify Product Configuration Parameters”
“Step 2.3 Review and Submit JCL”
“Step 3. Specify DB2/IMS/Data Privacy Environment (Option 2)”
“Step 3.1 Specify DB2 Subsystem (Option 1)”
“Step 3.2. Specify IMS Environment (Option 2)”
“Step 3.3. Specify File-AID Data Privacy (Option 3)”
“Step 4. Configure Product Specific Components”
“Step 5. APF Authorize File-AID Libraries”
Step 1. Execute the File-AID Configuration CLIST
Execute the Configuration CLIST (XVJ$$CFG) from the File-AID Sample dataset (e.g.,
CPWR.MXVJA20.SXVJSAMP) that was created during the SMP/E installation (see Chapter
2, “RFN SMP/E Installation of Compuware Mainframe Products”, Appendix A, “SMP/E
Installation Using the EP Media Interface” or Appendix B, “SMP/E Installation Using the
ISPF Interface” in the Compuware Installer Mainframe Products SMP/E Installation Guide) by
entering the following in an ISPF/PDF COMMAND field:
TSO EX 'hlq.CPWR.MXVJA20.SXVJSAMP(XVJ$$CFG)'
where hlq is the high-level qualifier you entered during SMP/E installation (see “Step 7.
Specify Universal SMP/E Dataset High Level Qualifier(s)” on page 2-10, or Appendix A,
“SMP/E Installation Using the EP Media Interface”, or “Step 6. Specify Universal SMP/E
Dataset High Level Qualifier(s)” on page B-9 in the Compuware Installer Mainframe Products
SMP/E Installation Guide).
Note:
If you open the Sample library to execute XVJ$$CFG, use VIEW instead of EDIT
as EDIT puts a lock on the .SXVJSAMP dataset and can prevent certain batch jobs
from completing.
The Configuration Facility panel shown in Figure 2-2 on page 2-4 displays, unless a valid
load library is not available.
The Configuration Facility looks for a File-AID load library (SXVJLOAD) with the same
high-level qualifier as the library you are executing XVJ$$CFG from. When it cannot find
one, it prompts you to specify one (Figure 2-1 on page 2-4).
2-4
File-AID Single Install Image Installation and Configuration Guide
Figure 2-1. Load Library Specification
File-AID ---------------- Dataset Name Specification -------------------------

COMMAND ===>








The following dataset is required for configuration. A default name is used
from a previous configuration or using the hlq of the dataset you invoked
configuration from. Please confirm or update the dataset name to continue.

LOAD Library
SMPE Target Dataset

hlq.CPWR.MXVJA20.SXVJLOAD
The LOAD library name from your previous configuration, if applicable, is presented.
1. Specify the File-AID LOAD library to use for this configuration.
2. Press Enter.
The Configuration Facility panel shown in Figure 2-2 displays once a valid load library is
available.
Figure 2-2. Configuration Facility Menu
File-AID 10.02.00 --------- Configuration Facility --------------------------
OPTION ===>

Specify a work dataset to write Configuration JCL into:
(fully qualified name without quotes)



===>
hlq.CPWR.MXVJA20.WORK
Configuration Task



1
2
3
Module
File-AID Common Component
DB2/IMS/Data Privacy Environment
Product Specific Components
Allocation Parameters (Optional)
Press PF1 for help,


NO
(NO/YES)
END to exit.
XVJOPUNV









Specify a Work Dataset to Write Configuration JCL
Specify a work dataset to which File-AID can write any JCL created to build Configuration
objects. Unless the XVJOJCL variable is defined differently in the $XVJPROF ISPF profile
member, this field displays the default dataset name hlq.WORK, where hlq. is the high
level qualifier of the SXVJSAMP from which the Configuration Facility (XVJ$$CFG) was
executed.
The work dataset must be partitioned (DSORG=PO) with record format Fixed (RECFM=F)
or Fixed Blocked (RECFM=FB) and record length LRECL=80.
You can specify any valid dataset name. If it does not exist, it will be allocated using the
attributes specified in the “Allocation Parameters” panel (Figure 2-3 on page 2-6). The
JCL created in this dataset is not intended to be retained or reused as File-AID creates new
JCL each time a configuration module is to be created. File-AID overwrites any existing
JCL in the WORK dataset. When leaving this panel, File-AID updates the XVJOJCL
variable in your $XVJPROF ISPF profile member with the specified WORK dataset name.
File-AID Configuration Facility
2-5
Configuration Facility Menu Options
The Configuration Facility menu includes the following Configuration Tasks:
1. File-AID Common Component (Module XVJOPUNV)
Select this option to configure all parameters that are shared among all of the File-AID
products into the File-AID Common Component Configuration module XVJOPUNV:
• DATASETS: Specify configured dataset names.
• SPECIFY PARMS: Specify product configuration parameters.
Note: All File-AID products require the File-AID Common Component parameter
module XVJOPUNV. You must always create the (or have an existing) File-AID
Common Component module (XVJOPUNV) first before you can create any other
components’ parameter module. The dataset definitions are defined by the
File-AID Common Component parameter module for all other functions in the
Configuration Facility.
2. DB2/IMS/Data Privacy Environment
Option 2, DB2/IMS/Data Privacy Environment creates environment modules that are
required and shared for some of the File-AID products. Select Option 2 to display a
submenu with the following options:
• DB2 Subsystem (Module XVJOPDB2) : Enables you to create and maintain the DB2
subsystems on which you want to install File-AID products with access to DB2.
Required when installing File-AID for DB2 or File-AID/RDX with the DB2 option.
• IMS Environment (Module XVJOPIMS) : This option executes the File-AID for IMS
Admin Option to allow you to create or modify an IMS environment load module
(XVJOPIMS). Required when installing File-AID for IMS, optional for File-AID/EX.
• Data Privacy (Module XVJOPDPR) : File-AID Data Privacy Java Variables provide
configuration options for the Dynamic Privacy Rules (DPR) created with File-AID
Data Privacy. These variables are only needed when the File-AID Data Privacy plugin
of the Compuware Workbench is installed and DPR is to be used with File-AID/Data
Solutions, File-AID for DB2, File-AID/RDX, or File-AID for IMS/ISPF.
3. Product Specific Options
Option 3, Product Specific Options, creates product specific modules that are required for
the individual File-AID products. It also includes a START option that you can use to
verify the configuration of File-AID products. Select Option 3 to display a submenu with
the following options:
• File-AID/MVS (Module XVJOPXFA) : Use you this option to configure File-AID/MVS
with your site specific parameters.
• File-AID/Data Solutions (Module XVJOPUDA) : Use you this option to configure
File-AID/Data Solutions with your site specific parameters.
• File-AID/RDX (Module XVJOPXFR) : Use you this option to configure File-AID/RDX
with your site specific parameters.
• File-AID for DB2 (Module XVJOPXFD) : Use you this option to configure File-AID for
DB2 with your site specific parameters.
• File-AID for IMS/ISPF (Module XVJOPXIX) : Use you this option to configure
File-AID for IMS/ISPF with your site specific parameters.
• File-AID for IMS/CICS (Module XVJOPNIX) : Use you this option to configure
File-AID for IMS/CICS with your site specific parameters.
• File-AID for IMS/DC (Module XVJOPOIX) : Use you this option to configure File-AID
for IMS/DC with your site specific parameters.
2-6
File-AID Single Install Image Installation and Configuration Guide
• File-AID/EX Executive (Module XVJOPXFE) : Use you this option to configure
File-AID/EX Executive with your site specific parameters.
• START : After you have completed the configuration of each of your licensed
File-AID products, use the START option to verify the configuration of File-AID
products.
Allocation Parameters
You can specify certain allocation parameters for any required File-AID
Work/Configuration datasets. The allocation parameters are saved in member $XVJWALP
of the WORK dataset specified in “Specify a Work Dataset to Write Configuration JCL” on
page 2-4.
Allocation Parameters (Optional) : Specify YES, if you need to specify allocation
parameters for any required File-AID Work/Configuration datasets.
When you specify YES, the “Allocation Parameters” panel shown in Figure 2-3 on
page 2-6 displays.
Figure 2-3. Allocation Parameters
File-AID 10.02.00 ------------- Allocation Parameters -------------------------
COMMAND ===>


If needed, please specify the following parameters. These values will be

used when allocating any required Work/Configuration datasets. This data

will be saved in the work dataset provided in the previous panel.


Source of Parameter Values:
(change to any other Work or Install dataset) 
(fully qualified name without quotes)



===> hlq.CPWR.MXVJA20.WORK

SMS Parameters:
Optional:


Perm Unit ===> SYSDA

Data Class
===>
Storage Class
===>
Temp Unit ===> VIO

Volser:
===>

Management Class ===>

VSAM Volser ===>

Optionally specify an install dataset for other install default values:



===>

Press PF1 for help, END to exit.

If needed, please specify the following parameters. These values will be used when
allocating any required Work/Configuration datasets.
The SMS and Optional allocation field values listed on this panel are obtained from the
dataset listed in the “Source of Parameter Values” field.
Source of Parameter Values : If there are saved allocation parameter values in member
$XVJWALP of the WORK dataset specified in “Specify a Work Dataset to Write
Configuration JCL”, that dataset is the source and those values will be used in the
SMS and Optional allocation fields.
If that WORK dataset does not contain saved values, the field is left blank.
To import allocation parameter values from a different source, specify a dataset that
includes
– allocation parameter member $XVJWALP,
– or ISPF table KCWUGBL (see “Step 3. Specify DSN for Installation Settings ISPF
Table” on page 2-6 in the Compuware Installer Mainframe Products SMP/E Installation
Guide),
File-AID Configuration Facility
2-7
– or install repository member XVJREPOS, XBGREPOS or XBFREPOS from a
previous File-AID release.
The allocation parameters stored in either member will prefill the following
allocation parameters.
Specify the data class, storage class, and/or management class parameters for the SMS
operating environment as follows:
Data Class : Specify the eight-character data class name for SMS.
Storage Class : Specify the eight-character storage class name for SMS.
Management Class : Specify the eight-character management class name for SMS.
Perm Unit : (Optional) Enter a valid DASD unit name. The value of this field will be used
in the UNIT= parameter of the DD statements that allocate permanent non-VSAM
datasets. The default value is SYSDA.
Temp Unit : (Optional) Enter a valid DASD unit name. The value of this field will be
used in the UNIT= parameter of the DD statements that allocate temporary nonVSAM datasets. The default value is VIO.
Volser : (Optional) This field is optional. Enter a valid DASD unit name If a volume is
specified, SMP/E will use it as the target for library and dataset allocation.
VSAM Volser : (Optional) Specify the VOLSER of a volume to catalog VSAM clusters.
Optionally specify an install dataset for other install default values : Specify a work
dataset that includes ISPF table KCWUGBL (see “Step 3. Specify DSN for Installation
Settings ISPF Table” on page 2-6 in the Compuware Installer Mainframe Products SMP/E
Installation Guide) or an installation dataset from a previous File-AID release that
includes other install default values than allocation values you want imported.
If a matching work dataset or File-AID installation dataset is found, the following
configuration values are updated from the KCWUGBL or XVJREPOS member in that
dataset.
• JOBCARD (lines 1-5)
You may update this field with any valid dataset name. If it contains a valid install
repository member KCWUGBL, XVJREPOS, XBGREPOS or XBFREPOS, it updates the
listed configuration values.
Note: This dataset name will not be saved in your ISPF profile.
Press END (PF3) to return to the Configuration Facility panel shown in Figure 2-2 on page
2-4 and to save the values in the $XVJWALP member of the WORK dataset specified in
“Specify a Work Dataset to Write Configuration JCL” on page 2-4. CANCEL (CAN) returns
to the Configuration Facility panel without saving the values in the WORK dataset.
Using Configuration Facility Help
The Configuration Facility provides a comprehensive online tutorial. We recommend you
review the tutorial before continuing the configuration process. Access the tutorial by
entering HELP (PF1) on the “Configuration Facility Menu” or any of the following
Configuration Facility panels.
Step 2. Specify File-AID Common Component Parameters
Option 1, File-AID Common Component allows you to specify all parameters that are
shared among all of the File-AID mainframe products. It creates the File-AID Common
Component module XVJOPUNV with your site-specific parameters.
Note: All File-AID products require the File-AID Common Component module
XVJOPUNV. You must always create the (or have an existing) File-AID Common
2-8
File-AID Single Install Image Installation and Configuration Guide
Component module XVJOPUNV first before you can create any other
components’ parameter module. The File-AID library dataset definitions are
defined within the XVJOPUNV parameter module for all other functions in the
Configuration Facility.
Select Option 1, File-AID Common Component, to display the “Source of Product
Parameters” panel shown in Figure 2-4.
Figure 2-4. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):
Previous install dataset . .
OR
Configuration library . . .

Press ENTER to continue. 






1. Specify either
– the name of a File-AID product install dataset prior to Release 10.1
OR
– the name of the File-AID Configuration (load) library that includes a File-AID
Common Component XVJOPUNV module you want to use as a source for your
parameter input
OR
– Leave both fields blank if this is your initial installation of File-AID or you want
to preserve or restore the product installation defaults.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
A valid previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of a File-AID product,
then you may retain the variable values from that release. This is accomplished
by specifying the name of the install dataset (e.g. hlq.CPWR.MXFA940.INS, or
hlq.CPWR.FKnnnnnn.INS) that was previously used to install a File-AID product.
For Option 1, File-AID Common Component, you can only specify a previous
install dataset from one of these File-AID products:
• File-AID/MVS Release 9.4, 9.3.1, 9.3
• File-AID/Data Solutions Release 4.4
• File-AID for IMS Release 7.7
When specifying an unsupported install dataset, this pop-up message displays:
File-AID Configuration Facility
CANNOT IMPORT CONFIGURATION VALUES FROM
THE SPECIFIED DATASET
'TSOID01.CPWR.BG120815.INS'

2-9



DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINUNV) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters, especially the variables
listed under “EXTRACT, LOAD AND DISGUISE OPTIONS” on page 2-23.
Product installation defaults are used when previous variable values
cannot be imported. You must visit Option 2, SPECIFY PARMS (see “Step
2.2 Specify Product Configuration Parameters” on page 2-14) to verify the
variable values and change the default values as required for your site.
Configuration library : Leave blank if you want to preserve or restore the product
installation defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a File-AID Common Component XVJOPUNV module which you want to use as a
source for your parameter input.
If you want to use a preexisting File-AID Common Component XVJOPUNV
parameter module (v10.1 or higher), you can specify the name of the dataset that
contains it. If a valid parameter module is found, ALL values will be initialized
from there. If the utility finds a CXVJLOAD dataset with a HLQ that matches the
SXVJSAMP you are executing from AND a valid parameter module is found, this
field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID Common
Component Menu” shown in Figure 2-5 on page 2-9.
Figure 2-5. File-AID Common Component Menu


File-AID ----------------------- Configuration -------------------------------
OPTION ===>

Product.... File-AID Common Component

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- Specify Configuration Module Dataset names


2 SPECIFY PARMS
- Specify product configuration parameters


3 CUSTOMIZE
- Option not available



Compuware recommends to use Option 1 - DATASETS and verify/update the
dataset names before you use Option 2, especially if your current
configuration has a set of datasets that are named differently than what
SMPE has installed.




Figure 2-5 shows an example when both fields in the “Source of Product Parameters”
panel (Figure 2-4 on page 2-8) were left blank.
2-10
File-AID Single Install Image Installation and Configuration Guide
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 2-8). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the respective
default values. Make sure to review all parameter values before submitting the
job to create a PARM module.
Configuration Output : Identifies the configuration load library to which the File-AID
Common Component module XVJOPUNV will be saved. Specify the load library you
want to save the File-AID Common Component module XVJOPUNV to.
The available options in the “File-AID Common Component Menu” are:
• DATASETS: Specify Configuration Module Dataset names.
• SPECIFY PARMS: Specify product configuration parameters.
Select one of the available options.
Step 2.1 Specify Configuration Module Dataset Names
Select Option 1 from the “File-AID Common Component Menu” to display the “Dataset
Name Specification” panel (Figure 2-6). Here you review the dataset information for the
File-AID SMP/E Target Libraries that were created during the SMP/E installation (see
Chapter 2, “RFN SMP/E Installation of Compuware Mainframe Products” or Appendix A,
“SMP/E Installation Using the EP Media Interface” in the Compuware Installer Mainframe
Products SMP/E Installation Guide) and the File-AID Configuration Module Libraries
(hlq.CXVJxxxx). The Target Libraries are loaded by SMP/E during the installation process
and are used by File-AID products during execution.
Use the DATASETS option for specialized updates. The Configuration Module Libraries
(hlq.CXVJxxxx) are created, if they do not already exist, and modified as needed in the
Configuration Facility. These libraries are created and updated when you submit the JCL
to generate customized objects (see “Step 2.3 Review and Submit JCL” on page 2-25).
Note: When you make changes to the dataset names, you must also visit Option 2,
SPECIFY PARMS, and submit the generated JCL to include the dataset name
changes in the File-AID Common Component module XVJOPUNV (see “Step 2.3
Review and Submit JCL” on page 2-25).
File-AID Configuration Facility
2-11
Figure 2-6. Dataset Name Specification

File-AID ---------------- Dataset Name Specification -------------------------
COMMAND ===>


Product.... File-AID Common Component

Version.... 10.02.00

Reset...... N (Y/N)
(Reset datasets below to current HLQ - hlq.CPWR.MXVJA20)
Validate SMPE Target Datasets Y (Y/N)



More:

Load Library
SMPE Target Dataset
Configuration Module Dataset
Authorized Load Library
SMPE Target Dataset
hlq.CPWR.MXVJA20.SXVJLOAD
hlq.CPWR.MXVJA20.CXVJLOAD
+ 





hlq.CPWR.MXVJA20.SXVJAUTH

CLIST Library
SMPE Target Dataset
Configuration Module Dataset
hlq.CPWR.MXVJA20.SXVJCLIB
hlq.CPWR.MXVJA20.CXVJCLIB
English Message Library 
SMPE Target Dataset
hlq.CPWR.MXVJA20.SXVJMENU





Scroll down to view all the libraries. Refer to Table 2-2 on page 2-11 for a listing and
description of the libraries. You can modify the highlevel qualifier for each library
dataset. Compuware recommends to use the same highlevel qualifier for all libraries.
Some of the File-AID libraries must be PDSE (Partitioned Data Set Extended) datasets.
Table 2-2 on page 2-11 lists all File-AID Target and Configuration Module Libraries and
identifies which libraries must be PDSEs.
Reset : Set to Y to reset the highlevel qualifiers of listed datasets to the displayed current
highlevel qualifier.
Validate SMPE Target Datasets : Set to Y (default) to validate that the required SMP/E
Target Datasets exist as specified. The optional datasets (refer to “Optional Datasets”
on page 2-13) are not being validated here. The Japanese datasets are validated when
you set the configuration variable “DBCSSUP” to Y (see “DBCSSUP” on page 2-20).
Set to N if validation is not desired at this time. This will be useful when creating a
configuration instance that you intend to port to another LPAR (see also Appendix J,
“Advanced Configuration and Porting Techniques”).
After reviewing or updating the dataset information, enter END (PF3) to exit the screen.
For more information on using this screen, enter HELP (PF1).
Table 2-2.
File-AID Target and Configuration Module Libraries
Description
Default Value
Your Value
Comments
Load Library
SMPE Target Dataset
CPWR.MXVJA20.SXVJLOAD
SMP/E Target Load Library.
This PDSE stores the SXVJLOAD
library members.
2-12
File-AID Single Install Image Installation and Configuration Guide
Table 2-2.
File-AID Target and Configuration Module Libraries (Continued)
Description
Default Value
Configuration Module
Dataset
CPWR.MXVJA20.CXVJLOAD
Your Value
Comments
Configuration Module Load
Library.
This PDSE stores the CXVJLOAD
library members. These library
members contain customized
load modules.
The CXVJLOAD load library needs
only be APF Authorized in order
for it to be ready to be referenced
in the CSS TP Start-up procedure
as mentioned in the Compuware
Workbench Installation Guide. This
library MUST have universal read
access. See also “Compuware
Workbench” on page 1-7.
CPWR.MXVJA20.SXVJAUTH
SMP/E Target APF Authorized
Load Library.
This PDSE stores the SXVJAUTH
library members. These library
members contain customized
load modules.
The SXVJAUTH load library needs
only be APF Authorized in order
for it to be ready to be referenced
in the CSS TP Start-up procedure
as mentioned in the Compuware
Workbench Installation Guide. This
library MUST have universal read
access. See also “Compuware
Workbench” on page 1-7.
SMPE Target Dataset
CPWR.MXVJA20.SXVJCLIB
SMP/E Target CLIST library.
This PDS stores the SXVJCLIB
library members. These library
members contain CLISTs that are
input to the product.
Configuration Module
Dataset
CPWR.MXVJA20.CXVJCLIB
Configuration Module CLIST
library.
This PDS stores the CXVJCLIB
library members. These library
members contain configured
CLISTs that are input to the
product.
Authorized Load Library
SMPE Target Dataset
CLIST Library
Note: Member XVJFB2VB in
sample library SXVJSAMP
contains sample JCL to
combine the fixed
blocked CLIST libraries
SXVJCLIB and CXVJCLIB
into one variable blocked
CLIST library CXVJCLIV.
English Message Library
SMPE Target Dataset
English Panel Library
CPWR.MXVJA20.SXVJMENU
SMP/E Target Message library.
This PDS stores the SXVJMENU
library members which contain
product messages.
File-AID Configuration Facility
Table 2-2.
2-13
File-AID Target and Configuration Module Libraries (Continued)
Description
Default Value
SMPE Target Dataset
CPWR.MXVJA20.SXVJPENU
Your Value
Comments
SMP/E Target Panel library.
This PDS stores the SXVJPENU
library members which contain
product panels.
SMPE Target Dataset
CPWR.MXVJA20.SXVJSENU
SMP/E Target Skeleton library.
This PDS stores the SXVJSENU
library members which contain
product skeletons.
Configuration Module
Dataset
CPWR.MXVJA20.CXVJSENU
Configuration Module Target
Skeleton library.
This PDS is currently empty, but
may be used in the future to store
the CXVJSENU library members
which contain customized
product skeletons.
CPWR.MXVJA20.SXVJTENU
SMP/E Target Table library.
This PDS stores the SXVJTENU
library members which contain
product tables.
CPWR.MXVJA20.SXVJDBRM
SMP/E Target DBRM library.
This PDS stores the SXVJDBRM
library members.
CPWR.MXVJA20.SXVJPPSB
SMP/E Target PSB library.
This PDS stores the SXVJPPSB
library members.
English Skeleton Library
English Table Library
SMPE Target Dataset
DBRM Library
SMPE Target Dataset
PSB Library
SMPE Target Dataset
Object Administration Pattern Library
SMPE Target Dataset
CPWR.MXVJA20.SXVJPATT
Object Administration SMP/E
Target Pattern library.
This PDSE stores the SXVJPATT
library members. These library
members contain encrypted
patterns.
Optional Datasets
Japanese Message Library
SMPE Target Dataset
CPWR.MXVJA20.SXVJMJPN
SMP/E Target Japanese Language
Message library.
This PDS stores the SXVJMJPN
library members which contain
product messages in Japanese.
CPWR.MXVJA20.SXVJPJPN
SMP/E Target Japanese Language
Panel library.
This PDS stores the SXVJPJPN
library members which contain
product panels in Japanese.
CPWR.MXVJA20.SXVJSJPN
SMP/E Target Japanese Language
Skeleton library.
This PDS stores the SXVJSJPN
library members which contain
product skeletons in Japanese.
Japanese Panel Library
SMPE Target Dataset
Japanese Skeleton Library
SMPE Target Dataset
2-14
File-AID Single Install Image Installation and Configuration Guide
Step 2.2 Specify Product Configuration Parameters
Select Option 2 from the “File-AID Common Component Menu” to display the “File-AID
Common Component Configuration Parameters” panel (Figure 2-7). Option 2 allows you
to specify values for variables that the Configuration Facility uses to configure the
File-AID Common Component PARM module for all File-AID products. A listing of all the
PARM variables is provided in Table 2-3 on page 2-14.
The displayed variable values have been imported from the source you specified in
“Source of Product Parameters” (Figure 2-4 on page 2-8). If no source was specified, the
variables values represent the product installation defaults.
Note: File-AID attempts to import parameter values from the specified source. However,
when not all variables can be imported, File-AID loads the default values. Make
sure to review all parameter values before submitting the job to create a PARM
module.
Enter 2 to display the “File-AID Common Component Configuration Parameters” screen
shown in Figure 2-7.
Use the HELP command (PF1) to receive information on using this screen.
After entering the desired values, enter END (PF3) to continue to the EDIT Generated JCL
screen (Figure 2-10), or CANCEL to exit the screen without saving your changes.
Figure 2-7. File-AID Common Component Configuration Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>



Product.... File-AID Common Component
Version.... 10.02.00


Value
Description

--------------------------------------------------------------------
More:
+ 
-------------------------------------------------------------------------------
JOB Statement Information
Enter up to 5 Lines of JOB Statement Information:


//CONFIG01 JOB ('OIXBAS7.0.0DEV'),'CONFIGURE ',CLASS=A,
//
MSGCLASS=X,NOTIFY=&SYSUID,MSGLEVEL=(1,1),REGION=0M


//*
//*
OPTIONAL JES PARAMETER CARD GOES HERE


//*
--------------------------------------------------------------------------------
Use LIBDEF within File-AID allocation CLIST. 
FALIBDEF
(Y=YES,N=NO)

Merge SXVJ and CXVJ

CUSTLIBS N
(Y=YES,N=NO) Default=N

PERMANENT FILE ALLOCATION INFORMATION
Variable
--------
Change any of the variable values as required for your site.
Table 2-3 lists the variables in the Install Options table. A value is required for all
variables, unless stated otherwise in the comments column.
Table 2-3.
Variable
File-AID Common Component Parameters Variables
Default Value
JOB Statement Information
Your Value
Comments
File-AID Configuration Facility
Table 2-3.
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
JOBCARD1
//*
JOBCARD2
//*
JOBCARD3
//*
JOBCARD4
//*
JOBCARD5
//*
Your Value
FALIBDEF
CUSTLIBS
2-15
Comments
Specify information for up to 5 lines of JOB
Statement Information.
The job card information that was specified in
$$CWINST during SMP/E Install will be
presented as the default, if you specified the
install dataset in the “Configuration Facility
Menu” (Figure 2-2 on page 2-4).
Use LIBDEF within File-AID allocation CLIST.
(Y=YES,N=NO)
Specify whether File-AID can use the LIBDEF
facility to allocate the necessary datasets. Valid
values are Y and N. If N, see also Chapter 12,
“Site Deployment”.
N
Merge SXVJ and CXVJ.
(Y=YES,N=NO)
Specify whether all members of the SMP/E
target libraries (SXVJ) should be merged
(copied) into the customized (configuration
module) libraries (CXVJ). Valid values are Y and
N.
Y enables using only 1 library (CXVJ) in the
STEPLIB and LIBDEF definitions. However,
when the libraries are combined, you will need
to recopy the SXVJ libraries to the CXVJ libraries
after applying SMP/E maintenance PTFs.
N requires that you specify both libraries,
(CXVJLOAD and SXVJLOAD), in the STEPLIB
and LIBDEF definitions, or in batch JCL.
However, it has the advantage of not requiring
a copy after applying maintenance to the
target libraries.
PERMANENT FILE ALLOCATION INFORMATION
Specify your site preferred allocation information for permanent work files created by a File-AID process.
PRMVOL
PRMUNIT
Default Volume used for work file allocations.
This is the volume used for work files. Only
required for non-SMS.
SYSDA
Default allocation Unit.
Default=SYSDA
This is the default UNIT for allocating work files. 
This unit must allow datasets to be cataloged.
PRMMANC
Default dataset SMS management class.
This is the default SMS Management Class for
allocating work files.
PRMSTORC
Default dataset SMS storage class.
This is the default SMS Storage Class for
allocating work files.
PRMDATAC
Default dataset SMS data class.
This is the default SMS Data Class for allocating
work files.
WRKBLKS
0
Default block size for non-LOADLIBS.
(1-99999) Default=0
This is the default Block Size for non-LOADLIBS
for allocating work files.
WRKBLKL
6144
Default block size for LOADLIBS.
(1-99999) Default=6144
This is the default Block Size for LOADLIBS for
allocating work files. (1-99999)
2-16
File-AID Single Install Image Installation and Configuration Guide
Table 2-3.
Variable
File-AID Common Component Parameters Variables (Continued)
Default Value
Your Value
Comments
TEMPORARY FILE ALLOCATION INFORMATION
Specify your site preferred allocation information for temporary files created by a File-AID process that may be deleted
automatically after a File-AID process completes.
TMPVOL
TMPUNIT
Default Volume used for temporary file
allocations.
This is the volume used for temporary file
allocations.
VIO
Default UNIT used for temporary file
allocations.
Default=VIO
This is the default UNIT for allocating
temporary files. This unit must allow datasets
to be cataloged.
TMPMANC
Default SMS management class used for
temporary file allocations.
This is the default SMS Management Class for
allocating temporary files.
TMPSTORC
Default SMS storage class used for temporary
file allocations.
This is the default SMS Storage Class for
allocating temporary files.
TMPDATAC
Default SMS data class used for temporary file
allocations.
This is the default SMS Data Class for allocating
temporary files.
VSAM ALOCATION INFORMATION
VSAMVOLS
VSAMUNIT
Default Volume used for VSAM allocations.
Specify the default Volume to be used for
VSAM allocations.
SYSDA
Default UNIT used for VSAM allocations.
Default=SYSDA.
This option allows you to control volume
assignments for VSAM allocations. Valid entries
include:
UNIT NAME With an esoteric unit name
(SYSDA, 3380, etc.) allocations are restricted to
volumes within that group.
DEFAULT With the word DEFAULT, VSAM
allocation has the same volume restrictions as
the user’s LOGON ID.
VSAMMANC
Default SMS management class used for VSAM
allocations.
This is the default SMS Management Class for
allocating VSAM files.
VSAMSTRC
Default SMS storage class used for VSAM
allocations.
This is the default SMS Storage Class for
allocating VSAM files.
VSAMDATAC
Default SMS data class used for VSAM file
allocations.
This is the default SMS Data Class for allocating
VSAM files.
File-AID Configuration Facility
Table 2-3.
Variable
2-17
File-AID Common Component Parameters Variables (Continued)
Default Value
Your Value
Comments
VSAMHILV
Default VSAM high level qualifier.
This option enables the use of unqualified
VSAM dataset names. With VSAM catalogs, a
single high-level node belongs to a single
catalog. This option allows the site to specify a
VSAM high-level node that points to a specific
VSAM catalog. File-AID uses the VSAMHILV
variable and the VSAM intermediate name to
construct VSAM names for dataset searches.
You can specify the VSAM intermediate name
on the 0.1 System Parameters screen; the
default is your userid.
As in normal ISPF, whenever an unqualified
name is entered on a panel, File-AID searches
for that name prefaced with the TSO prefix
(normally your userid). If the name is not
found, File-AID repeats the search using the
VSAMHILV-variable·VSAM-intermediatename·unqualified-name-you-entered as the
search criteria. If a match is not found, File-AID
considers the name in error. For more
information on the VSAM intermediate name,
see the File-AID/MVS online tutorial for the 0.1
System Parameters screen.
VSAMDATA
Specify a name other than DATA for VSAM
DATA names.
This option enables you to specify a name
other than DATA for File-AID to use as the
VSAM low level data name.
VSAMINDX
Specify a name other than INDEX for VSAM
INDEX names.
This option enables you to specify a name
other than INDEX for File-AID to use as the
VSAM low level index name.
VSAMXALL
N
Default value for VSAM EXTD allocations.
(Y=YES,N=NO) Default=N
This option allows you to customize the default
value for the VSAM Extended Allocation Screen
option displayed on the VSAM Allocate New
VSAM Cluster screen. Valid entries are:
No Sets the VSAM Extended Allocation Screen
option default to NO.
Yes Sets the VSAM Extended Allocation Screen
option default to YES.
MISCELLANEOUS OPTIONS
HSMOPT
0
Default Archived/Migrated dataset screen.
(0,1) Default=0
This is the default Archived/Migrated Dataset
screen. (0, 1)
Alternative zapa:
NAME XVJOPUNV XVJOPUNV 
VER
REP
01D0
01D0
F0
F1
2-18
File-AID Single Install Image Installation and Configuration Guide
Table 2-3.
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
ARCHVOL1
MIGRAT
Your Value
Comments
False Volume used for archived datasets.
(Valid Volume,*) Default=MIGRAT
Specifies the “false” volume names that your
installation uses for archived datasets.
File-AID treats any dataset that is cataloged to
one of these volumes as archived. File-AID
presents the Archived/Migrated Dataset screen
before processing unless it is disabled with the
Archived/Migrated Dataset screen install
option. The presentation of this panel gives the
user the opportunity to cancel processing of
the archived dataset.
Entries must be a legal volume serial name and
six alphanumeric characters in length. Entries
may end with blanks or asterisks. If trailing
asterisks are entered, File-AID matches any
volume name with the same beginning
characters.
Note: If you have no archive volume, set
ARCHVOL1='*' and ARCHVOL2='*'.
Table 2-4 on page 2-25 shows sample
valid entries for the ARCHVOL1 and
ARCHVOL2 variables. When setting
this variable with Configuration
Facility, do not enter the quotes (’ ’).
ARCHVOL2
ARCIVE
Secondary false Volume used for archived
datasets.
(Valid Volume,*) Default=ARCIVE
See ARCHVOL1 description above. (Valid
Volume,*)
CCSID
01140
CCSID for Unicode conversion services. 
(0-65536) Default=01140
Specify TO-CCSID for the conversion from
Unicode (UTF-16 CCSID=1200) to EBCDIC
data being printable on the printer or
displayable on 3270 terminal. Value must be
numeric (0 through 65536) that represents a
valid coded character set identifier (CCSID) for
EBCDIC code page.
This value normally should match the terminal
CCSID.
The CCSID field in the File-AID Primary Option
Menu displays the ISPF variable ZTERMCID.
00037 is US-English (ENU)
File-AID Configuration Facility
Table 2-3.
2-19
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
CHARSET
DFLT
Your Value
Comments
Character set translation table. 
When the value of this option is appended to
“FAXT” it becomes the name of a character set
translation table in the File-AID load library.
This table is used to determine if a character is
displayable or printable. The default is DFLT
(American English). Values that are currently
valid are:
BELG (C2C5D3C7) Belgian.
CNBL (C3D5C2D3) Canadian Bilingual.
CNFR (C3D5C6D9) Canadian French.
CYRL (C3E8D9D3) Cyrillic.
DFLT (C4C6D3E3) American English.
FREN (C6D9C5D5) French.
GREK (C7D9C5D2) Greek.
HEB (C8C5C240) Hebrew.
HEBN (C8C5C2D5) Hebrew new, post Aleph.
HEBO (C8C5C2D6) Hebrew old, post Aleph.
ICLN (C9C3D3D5) Icelandic.
KANA (D2C1D5C1) Japanese.
K930 (D2F9F3F0) Katakana 0930.
K939 (D2F9F3F9) Katakana 0939.
LATN (D3C1E3D5) Roece Latin.
PGSE (D7C7E2C5) Portuguese.
POL (D7D6D340) Polish.
SPAN (E2D7C1D5) Spanish.
SWED (E2E6C5C4) Swedish.
SWFG (E2E6C6C7) Swiss-French and SwissGerman.
THAI (E3C8C1C9) Thai.
TURK (E3E4D9D2) Turkish.
YUGO (E8E4C7D6) Yugoslav.
3277 (F3F2F7F7) Model 3277 display
terminals.
For information on code pages, refer to the
IBM manual, 3270 Information Display Systems
Character Set Reference.
2-20
File-AID Single Install Image Installation and Configuration Guide
Table 2-3.
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
DBCSSUP
N
Your Value
Comments
Japanese Configuration.
(Y=YES,N=NO) Default=N
DBCS (Double Byte Character Set) Support.
Indicates whether product panels, messages,
and skeletons are displayed with English or
DBCS (Japanese) characters.
DBCS support is provided as a standard feature
of the product.
No (default) panels are displayed in English.
Yes product panels are displayed with DBCS
(Japanese) characters.
You must have also set Install Japanese
components? to Y during the SMP/E
installation (see “Step 8. Specify Target and
Distribution Zone Information” on page 2-10,
“Step 7. Specify Target and Distribution Zone
Information” on page B-9, or “Select Items for
Upload” on page A-3 of the Compuware
Installer Mainframe Products SMP/E Installation
Guide) to have Japanese panels, messages, and
skeletons available. The Japanese datasets are
validated in “Step 2.3 Review and Submit JCL”
on page 2-25.
Refer to “Japanese and English Interfaces in
One Install” on page 12-9 to make both
English and Japanese interfaces available from
the same product libraries.
DBCSDATA
N
Shift-in/shift out data support.
(Y=YES,N=NO) Default=N
Enable Shift-in/Shift-out data support. Enables
IBM double byte character set (DBCS) support
for formatted print. (was old BTOPT31)
No (D5) Standard print characters.
Yes (E8) IBM supported DBCS print characters.
DATEFRMT
2
Default date format. 
(0=MM/DD/YY,1=YY/MM/DD,2=DD/MM/YY)
Default=2 (was old BTOPT10)
Valid entries are:
0 (F0) - Displays dates in the MM/DD/YYYY
format.
1 (F1) - (Default) Displays dates in the
YYYY/MM/DD format.
2 (F2) - Displays dates in the DD/MM/YYYY
format.
Alternative zapa:
NAME XVJOPUNV XVJOPUNV 
VER
REP
MONTHFMT
1
0C2C
0C2C
F2
Fx
Date month format. 
(0=Numeric,1=Alpha) Default=1
Allows month to be a numeric or alpha value.
(was old BTOPT11)
0 (F0) Numeric.
1 (F1) Three-character alphabetic.
File-AID Configuration Facility
Table 2-3.
2-21
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
PRINTLPI
6
Your Value
Comments
Printer Spacing. 
(6=8LPI,8=12LPI) Default=6
Controls the lines per inch (LPI) on printed
output. (was old BTOPT06)
6 (F6) This number converts to 8 LPI for page
printers.
8 (F8) This number converts to 12 LPI for page
printers.
This option can be changed at run time with
the LPI parameter.
NUMLIN08
58
Number of print lines per page at 8LPI. 
(1-99) Default=58
Specifies the number of lines that are printed
before overflow on SYSLIST when PRINTER
SPACING is F6 (see displacement 0A). (was old
BTOPT15)
Note: File-AID prints in sets of lines (DUMP is
4, PRINT is 2, LIST is 1) and only
recognizes overflow at the end of a set.
NUMLIN12
82
Number of print lines per page at 12LPI. 
(1-99) Default=82
Specifies the number of lines that are printed
before overflow on SYSLIST when
displacement 0A is F8. (was old BTOPT16)
Note: File-AID prints in sets of lines (DUMP is
4, PRINT is 2, LIST is 1) and only
recognizes overflow at the end of a
set.
PRNTCNTL
M
Print Control character setting.
(A=ASA,M=IBM) Default=M
Allows File-AID to support either machine
control characters M (D4) or ASA control
characters A (C1) on all printer datasets
(SYSPRINT, SYSLIST, SYSTOTAL). (was old
BTOPT22 in File-AID/MVS, BTOPT20 in
File-AID/Data Solutions)
OUTCLASS
*
Default sysout class.
(A-Z,0-9,*) Default=*
Specify your default SYSOUT class. (A-Z,0-9,*)
#NSYMBOL
N
COBOL NSYMBOL Compiler option.
(D=DBCS,N=National) Default=N
(was old BTOPT51 in File-AID/MVS, BTOPT37
in File-AID/Data Solutions)
If COBOL ‘PICTURE N’ field is treated as
Graphic (PIC G) without usage DISPLAY-1,
specify 'D' (DBCS). If not, or no ‘PIC N’ in your
site, specify 'N' (NATIONAL).
#NSYMBOL applies to both Batch and Online
modes.
CAPSMODE
OFF
Default CAPS Setting.
(ON,OFF) Default=OF
User default CAPS mode, ON or OFF.
2-22
File-AID Single Install Image Installation and Configuration Guide
Table 2-3.
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
EXTADDR
004
Your Value
Comments
Extended addressing area in gigabytes.
(0-256) Default=004
Specify (in gigabytes) the maximum amount of
1 extended addressing area that can be used
by File-AID for batch extract and disguise
processing. Acceptable values: 0 – 256.
If this value is specified and is too small it may
force the internal tables built during extract to
be temporarily written to and read back from a
DASD file. To disable the use of extended
addressing area (not recommended) specify 0.
This variable will add a MEMLIMIT= parameter
on the job steps that will use above the bar
memory. If the MEMLIMIT= parameter in the
JCL is manually changed it must be equal to or
greater than the EXTADDR value.
The purpose of the EXTADDR value is to set a
reasonable limit within the product for use of
the extended addressing memory area. If there
is insufficient DASD to back the extended
addressing area requested across the LPAR then
IRA201E CRITICAL AUXILIARY STORAGE
SHORTAGE can occur.
Note: If your site has installed an IEFUSI (Step
Initiation Exit) that limits the use of
extended addressing area, it may need
to be modified to allow File-AID to
bypass those limits. Contact your
System Programming staff for more
information about the IEFUSI at your
site.
CALIB
N
Enable Librarian support.
(Y=YES,N=NO) Default=N
Specify whether you want to access CA
Librarian libraries. Valid values are:
Yes, Librarian support provided.
No, Librarian support NOT provided.
Note: When specifying Y, the CA Librarian
load libraries must be accessible for a
File-AID non-directed load.
CAPAN
N
Enable Panvalet support.
(Y=YES,N=NO) Default=N
Specify whether you want to access CA
Panvalet libraries. Valid values are:
Yes, Panvalet support provided.
No, Panvalet support NOT provided.
Note: When specifying Y, the Panvalet load
libraries must be accessible for a
File-AID non-directed load.
SVC INFORMATION
Only required for writing audit trail records to SMF (File-AID/MVS, File-AID/Data Solutions, File-AID for DB2, and
File-AID for IMS) and/or File-AID for IMS security exit option that requests the database dataset names be returned
when running in a BMP region (see also “File-AID SVC” on page 1-8).
File-AID Configuration Facility
Table 2-3.
2-23
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
SVCSW
NONE
Your Value
Comments
SVC usage.

(NONE/SVC/ESR) Default=NONE
Specify whether the SVC is not used (NONE), a
user SVC, or an ESR.
When specifying usage SVC or ESR, one or both
of XVJFUN16 or XVJFUN20 must also be
selected (Y).
SVC
000
SVC/ESROUTE number assigned for File-AID
use. 
(200-255) Default=000
Specify a customer assigned number between
200 and 255 (user SVC or ESR number) for the
File-AID SVC. Specify 000 if SVC usage is
NONE.
SVCAPF
N
SVC APF authorization check.
(Y=YES,N=NO) Default=N
Specify whether the SVC should check the
caller for authorization by testing to see if the
caller is loaded into protected storage.
XVJFUN16
N
Allow SMF records to be written to system log.
(Y=YES,N=NO) Default=N
Specify Yes to allow File-AID to write File-AID
SMF records to the system log. Valid values are
Yes and No. XVJFUN16 issues SVC 83 to write
File-AID SMF records to the system log.
XVJFUN20
N
Allow IMS (BMP MODE) control block access. 
(Y=YES,N=NO) Default=N
Yes loads FA/IMS module FDLITDSN, and then
issues a SYNCH to it that allows cross-memory
services. Required if the security exit names
option is used in BMP mode.
EXTRACT, LOAD AND DISGUISE OPTIONS
SPMULTIV
Y
Allow multi-volume split files during disguise.
(Y=YES,N=NO) Default=Y
Specify Y if you want to allow disguise split files
to be allocated over multiple DASD volumes.
SPSMSCLS
Y
Use SMS Management class for split files
during disguise. (Y=YES,N=NO) Default=Y
Specify Y if you want to use default SMS
parameters when allocating disguise split files.
ALLOWLK
N
Allow users to lock DB2 tables during extract
and load. 
(Y=YES,N=NO) Default=N
Specify Yes for File-AID to allow users to lock
DB2 tables during extract or SQL Insert load
process.
Specify No to prevent users from locking DB2
tables during extract or SQL Insert load
process.
MAXCOMIT
2000
Maximum commit interval. 
(1-99999) Default=2000
Maximum number of rows File-AID should
insert or update before File-AID performs a DB2
COMMIT with the SQL Insert load option.
2-24
File-AID Single Install Image Installation and Configuration Guide
Table 2-3.
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
AUTHOVRD
Y
Your Value
Comments
Bypass DB2 Authority Reporting
(Y=YES,N=NO) Default=Y
Set to Yes if you are using a third-party product
for DB2 security. This indicates whether
File-AID should produce DB2 authorization
reports prior to loading tables.
OLEXTR
N
Allow extracts to run online
(Y=YES,N=NO) Default=N
Interactive (online) extract option.
Y allows users to run extracts interactively
(online). When running extracts online the
user’s TSO session will be tied up for the
duration of the extract. To terminate an online
extract in progress, the user must press the
Attention key.
N disables interactive (online) extract for the
installation.
OLLOAD
N
Allow loads to run online.
(Y=YES,N=NO) Default=N
Interactive (online) load option.
(Y=YES,N=NO)
Y allows users to run loads interactively
(online). When running loads online the user’s
TSO session will be tied up for the duration of
the load. To terminate an online load in
progress, the user must press the Attention key.
N disables interactive (online) load for the
installation.
WRKTYPE
CYLS
Default work dataset space type.
(BLKS,TRKS,CYLS) Default=CYLS
This is the default Space Type (BLKS, TRKS or
CYLS) for allocating work files used during
extract, load, and data disguise. If BLKS are
specified, File-AID will use TRKS where BLKS are
not supported.
WRKPRIM
2
Default work dataset allocation primary space.
(1-16777215) Default=2
This is the default Primary Space for allocating
work files used during extract, load, and data
disguise. (1-16777215)
WRKSEC
2
Default work dataset allocation secondary
space.
(1-16777215) Default=2
This is the default Secondary Space for
allocating work files used during extract, load,
and data disguise. (1-16777215)
REQUIRED SYSTEM DATASETS
System
MACLIB
SYS1.MACLIB
System Macro library, if applicable.
System
CSSLIB
SYS1.CSSLIB
System CSSLIB (MVS Callable Services) Library.
System
IBM/C Run
Time
CEE.SCEERUN
System IBM/C Run Time Library.
System LE
Linklib
CEE.SCEELKED
System Language Environment Linklib,
required.
System LE
Linklib 2
CEE.SCEELKEX
System Language Environment Linklib 2.
File-AID Configuration Facility
Table 2-3.
2-25
File-AID Common Component Parameters Variables (Continued)
Variable
Default Value
System LE
MACLIB
CEE.SCEEMAC
Your Value
System LE Macro library, if applicable.
Comments
ISPF Load
Library
ISP.SISPLOAD
ISPF Load Library. This dataset contains the
load modules used by ISPF.
ISPF Panel
Library
ISP.SISPPENU
ISPF Panel Library. This dataset contains the
panels used by ISPF.
ISPF Message ISP.SISPMENU
Library
ISPF Message Library. This dataset contains the
messages used by ISPF.
ISPF Skeleton ISP.SISPSENU
Library
ISPF Skeleton Library. This dataset contains the
skeletons used by ISPF.
ISPF Table
Library
ISP.SISPTENU
ISPF Table Library. This dataset contains the
tables used by ISPF.
SORT Utility
Library
SYS1.SORTLIB
SORT Utility Load Library.
IGY.SIGYCOMP
COBOL
Comp Library
COBOL Comp Library.
OPTIONAL SYSTEM DATASETS
PDF Load
Library
PDF Load Library
PDF Panel
Library
PDF Panel Library
PDF Message
Library
PDF Message Library
PDF Skeleton
Library
PDF Skeleton Library
PDF Table
Library
PDF Table Library
a.Apply alternative zap only if you cannot regenerate module XVJOPUNV.
Table 2-4.
ARCHVOL1 and ARCHVOL2 Variable — Valid Entry Examples
Entry
Volume
Result
MIGRAT
MIGRAT
Match
ARC
ARC
Match
ARCIVE
ARCIVE
Match
ARCH**
ARCHIV
Match
ARCH*
ARCH01...99
Match
ARCH**
ARCH01...99
Match
ARCH
ARCH01...99
No Match
Step 2.3 Review and Submit JCL
After entering the desired values in the “File-AID Common Component Configuration
Parameters” screen (Figure 2-7), enter END (PF3) to continue.
If variable “CUSTLIBS” is set to Yes and the customized (configuration module) libraries
already exist, Figure 2-8 displays with instructions on how to continue.
If both variables “DBCSSUP” and “Validate SMPE Target Datasets” are set to "Y" and one
or more of the Japanese libraries don’t exist or aren’t valid, Figure 2-9 displays prompting
you to specify the Japanese libraries. Figure 2-9 also displays when “DBCSSUP” is set to
"Y" and “Validate SMPE Target Datasets” is set to "N", but the specified Japanese libraries
aren’t valid.
2-26
File-AID Single Install Image Installation and Configuration Guide
Otherwise, the “Edit JCL Screen for File-AID Common Component Module XVJOPUNV”
screen (Figure 2-10) displays.
Figure 2-8. Instructions when Merging Customized Libraries



File-AID ----------------------- Configuration -------------------------------
COMMAND ===>

Product.... File-AID Common Component

Version.... 10.02.00

-------------------------------------------------------------------------------
Configuration has detected CUSTLIBS = Y in your XVJOPUNV parameters. This

means your corresponding installation libraries will be merged into your

configuration libraries (listed below) to create a single set of execution 
libraries. You are receiving this message because one or more of your

configuration libraries already exists. If your configuration libraries were
originally created using CUSTLIBS = Y, the libraries will be large enough

for the merge. If not, they may be too small and could result in X37 abends.

hlq.CPWR.MXVJA20.CXVJLOAD
<== Already Exists

hlq.CPWR.MXVJA20.CXVJCLIB
<== Already Exists

hlq.CPWR.MXVJA20.CXVJSENU
<== Already Exists


Press ENTER to continue to the JCL to create XVJOPUNV and merge your

libraries.

Press F3 to return to the parameters panel to review your datasets and/or

options. 
Read all of the instructions. Then continue with either recommendation:
Press ENTER to continue to the JCL to create XVJOPUNV and merge your libraries.
or
Press END (F3) to return to the parameters panel to review your datasets and/or
options.
Figure 2-9. Japanese Libraries Required

File-AID ---------------- Dataset Name Specification ---- Enter required field
COMMAND ===>



Japanese Configuration is selected (DBCSSUP = Y).

Please update SMPE Japanese Target Datasets.




Message Library :
Panel Library
:


Skeleton Library :


Press PF1 for help, END to exit. 
Specify the SMP/E Japanese Target dataset names for the Message, Panel, and Skeleton
Libraries (see also “Optional Datasets” on page 2-13).
These datasets must exist if “Validate SMPE Target Datasets” is set to "Y" (refer to
“Validate SMPE Target Datasets” on page 2-11). With validation set to “N”, you still must
provide a valid dataset name for each of the Japanese libraries.
Press END to continue to the JCL to create XVJOPUNV and merge your libraries.
or
Enter CANCEL to return to the “File-AID Common Component Configuration
Parameters” screen (Figure 2-7) to review your parameter settings.
File-AID Configuration Facility
2-27
Figure 2-10. Edit JCL Screen for File-AID Common Component Module XVJOPUNV
EDIT
TSOID01.CPWR.MXVJA20.WORK($XVJ01) - 01.00
Columns 00001 00072 
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('ACCOUNT.NUMBER'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*

000007 //*-------------------------------------------------------------------- 
000008 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.

000009 //*-------------------------------------------------------------------- 
000010 //* You must SUBMIT this JOB to rebuild PARM module XVJOPUNV to make
000011 //* all changes permanent. 
000012 //*-------------------------------------------------------------------- 
000013 //*

000014 //* This job executes the following steps

000015 //*

000016 //*-------------------------------------------------------------------- 
000017 //*

000018 //* STEP0100 Allocates CXVJLOAD, CXVJCLIB and CXVJSENU if they

000019 //*
do not already exist

This JCL executes the following steps:
• STEP0100: Allocates CXVJLOAD, CXVJCLIB and CXVJSENU if they do not already
exist.
• STEP0150: Creates a dummy member in CXVJSENU
• STEP0200: Assembles XVJOPUNV to a temporary OBJ file.
• STEP0300: Link Edits XVJOPUNV to CXVJLOAD.
• STEP0400: Link Edits the File-AID SVC/ESR if SVCSW ¬= NONE to CXVJLOAD. See
also “File-AID SVC Considerations” on how to make the SVC available.
• STEP0450: Copies SXVJ Datasets to CXVJ (only if “CUSTLIBS” is set to Yes).
• STEP0500: Creates CLIST XVJALLOC and XVJRUN in CXVJCLIB.
Review the JCL and SUBMIT the job to create configuration module XVJOPUNV. Verify
that the job completed before continuing.
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Configuration Facility Menu” (Figure 2-2 on page 2-4), the changes you
made in the “Dataset Name Specification” and “File-AID Common Component
Configuration Parameters” panels (Figure 2-6 on page 2-11 and Figure 2-7 on page 2-14)
will NOT be saved.
File-AID SVC Considerations
If the File-AID SVC is installed as a user SVC (IGC00nnn), the MVS SVC table (IEASVC00
in SYS1.PARMLIB) must be updated to include the new SVC number. For example:
SVCPARM 253,REPLACE,TYPE(3)
/* FILEAID SVC */
After link-editing the File-AID SVC module by executing the File-AID Common
Component Configuration (see “Step 2.3 Review and Submit JCL” on page 2-25), copy
the module (IGC00nnn) from CXVJLOAD into SYS1.LPALIB. Then perform an IPL (with a
CLPA) or use a program product such as RESOLVE to make the SVC available.
2-28
File-AID Single Install Image Installation and Configuration Guide
Step 3. Specify DB2/IMS/Data Privacy Environment (Option 2)
When you select Option 2, DB2/IMS/Data Privacy Environment from the “Configuration
Facility Menu”, the “DB2/IMS/Data Privacy Environment Menu” shown in Figure 2-11
displays.
Use Option 2, DB2/IMS/Data Privacy Environment to create environment modules that
are required and shared for some of the File-AID products.
Figure 2-11. DB2/IMS/Data Privacy Environment Menu


File-AID 10.02.00 -------- Environment Configuration -------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:


hlq.CPWR.MXVJA20.CXVJLOAD

Select Environment to Configure:

Module


1 DB2 Subsystem
XVJOPDB2


2 IMS Environment
XVJOPIMS


3 Data Privacy
XVJOPDPR










Configuration Module Dataset containing member XVJOPUNV : Identifies the
Configuration Load Library that includes the File-AID Common Component
Configuration Module (XVJOPUNV). If the utility finds a CXVJLOAD dataset with a
hlq that matches the SXVJSAMP you are executing from AND a valid parameter
module is found, this field will be prefilled.
Specify the load library you want to save the Environment modules to.
After you verified the dataset that contains the File-AID Common Component
Configuration Module (XVJOPUNV) to be used, select one of the following options:
1. DB2 Subsystem (Module XVJOPDB2): Enables you to create and maintain the DB2
subsystems on which you want to install File-AID products with access to DB2. Only
required when installing File-AID for DB2 or File-AID/RDX.
2. IMS Environment (Module XVJOPIMS): This option executes the File-AID for IMS
Admin Option to allow you to create or modify an IMS environment load module
(XVJOPIMS). Only required when installing File-AID for IMS.
3. Data Privacy (Module XVJOPDPR): File-AID Data Privacy Java Variables provide
configuration options for the Dynamic Privacy Rules (DPR) created with File-AID
Data Privacy. These variables are only needed when the File-AID Data Privacy plugin
of the Compuware Workbench is installed and DPR is to be used.
Press Enter after you entered your option number.
Step 3.1 Specify DB2 Subsystem (Option 1)
Option 1, DB2 Subsystem enables you to maintain the DB2 subsystems on which you
want to install any of the File-AID products that can access the File-AID DB2 subsystem
definitions.
File-AID Configuration Facility
2-29
IMPORTANT:
You must complete this option before you can use any of the File-AID products that
need to access the File-AID DB2 subsystem definitions.
Note:
Only IBM DB2 V11 for z/OS or DB2 V10 for z/OS subsystems are supported.
When you select Option 1, DB2 Subsystem, the “Source of Product Parameters” panel
shown in Figure 2-12 is displayed.
Figure 2-12. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):
Previous install dataset . .
OR
Configuration library . . .

Press ENTER to continue. 






1. Specify either
– the name of a File-AID product install dataset prior to Release 10.1 for a product
that includes DB2 subsystem definitions
OR
– the name of the File-AID Configuration (load) library that includes a DB2
environment module XVJOPDB2 you want to use as a source for your parameter
input
OR
– Leave both fields blank if this is your initial installation of File-AID or you want
to preserve or restore the product installation defaults
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
A valid previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of a File-AID product
that includes DB2, then you may retain the previously specified variable values.
This is accomplished by specifying the name of the install dataset (e.g.
hlq.VJ.MXVJ210.INS, or hlq.FR.MXFR500.INS, or hlq.CPWR.FKnnnnnn.INS) that
was previously used to install a File-AID product.
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters, e.g. FRPLAN NAME is now
obsolete. Product installation defaults are used when previous variable
2-30
File-AID Single Install Image Installation and Configuration Guide
values cannot be imported. You must visit Option 1, “Maintain DB2
Subsystem Information” (see “Maintain DB2 Subsystem Information” on
page 2-31) to verify the variable values.
Configuration library : Leave blank if you want to preserve or restore the product
installation defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a DB2 environment module XVJOPDB2 and you want to use it as a source for
your parameter input.
If you want to use a preexisting DB2 environment module, you can specify the
name of the dataset that contains it. If a valid parameter module is found, ALL
values will be initialized from there. If the utility finds a CXVJLOAD dataset with
a hlq that matches the SXVJSAMP you are executing from AND a valid parameter
module is found, this field will be prefilled.
2. Press Enter. When a Previous install dataset is used, a message, e.g. XVJTSSID Member
copied displays notifying you that existing variables were copied.
3. Press Enter again to remove the message.
4. Press END (PF3) to continue with the DB2 Subsystem Configuration as shown in the
“Environment Configuration DB2 Subsystem Menu” shown in Figure 2-13.
Environment Configuration DB2 Subsystem Menu
The available options in the “Environment Configuration DB2 Subsystem Menu” are:
• DATASETS: List Configuration Module Datasets.
• SUBSYSTEM: Maintain DB2 Subsystem information.
• BIND: Create and Run BIND JCL.
Select one of the available options.
Figure 2-13. Environment Configuration DB2 Subsystem Menu
File-AID ----------------- Environment Configuration -------------------------
OPTION ===>

Environment.... DB2 Subsystem

Version........ 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD
Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD
Select Option:


1
DATASETS
- List Configuration Module Datasets
2
SUBSYSTEM
3
BIND
- Maintain DB2 Subsystem information

- Create and Run BIND JCL 






Press PF3 to Exit 
Review Target and Configuration Module Libraries
Select Option 1 from the “Environment Configuration DB2 Subsystem Menu” to display
the “Dataset Name Specification” panel (Figure 2-6 on page 2-11). Here you review the
dataset information for the File-AID SMP/E Target Libraries that were created during the
File-AID Configuration Facility
2-31
SMP/E installation (see Chapter 2, “RFN SMP/E Installation of Compuware Mainframe
Products” or Appendix A, “SMP/E Installation Using the EP Media Interface” in the
Compuware Installer Mainframe Products SMP/E Installation Guide) and the File-AID
Configuration Module Libraries. The displayed list is the same as displayed in Figure 2-6
on page 2-11. Refer to “Step 2.1 Specify Configuration Module Dataset Names” on page
2-10 for more information.
Maintain DB2 Subsystem Information
From the “Environment Configuration DB2 Subsystem Menu” select Option 2, Maintain
DB2 Subsystem Information to view, create, and maintain the DB2 subsystem
information.
Note:
If you update a subsystem variable after you have completed Option 2, you must
select Option 3 and submit the Create Bind JCL for the respective DB2
subsystem(s) to pick up the new value.
Option 2, Maintain DB2 Subsystem Information, enables you to specify the DB2
subsystems on which you want to install File-AID products that access the File-AID DB2
subsystem definitions.
Note:
Only IBM DB2 V11 for z/OS or DB2 V10 for z/OS subsystems are supported.
Enter 2 to display the screen shown in Figure 2-14 on page 2-32. The bottom portion of
the screen is blank the first time this option is selected and no subsystems had been
defined previously.
In the top portion of the screen, you specify required values for a default subsystem and
its default DB2 load library as well as Profile and Plan Name for File-AID for DB2 Object
Administration, and optionally, the Relationship file to be used with File-AID/RDX and
File-AID for DB2.
To add a new subsystem, enter the ADD primary command which displays the ADD panel
(see Figure 2-15 on page 2-33). The values for the subsystem variables in the ADD
window are either blank or prefilled with the values of the previously updated or added
subsystem definition during the same Configuration session. A listing of all the
subsystem variables is provided in Table 2-5 on page 2-35.
To view or update a subsystem definition, enter the S line command which displays the
UPDATE panel (see Figure 2-17 on page 2-34).
Use the D line command to delete a subsystem entry. The “DELETE Configuration” panel
(Figure 2-18 on page 2-35) displays where you enter the DELETE primary command to
confirm the delete request or use CANCEL to cancel it.
Note:
You must add all the DB2 subsystems on which you want all your File-AID
products to run that can access DB2.
For more information on using this screen, enter HELP (PF1). The help provides
information on the primary and line commands and field descriptions for the subsystem
variables.
After adding, updating or deleting subsystems, enter END (PF3) to exit the screen and
display the “Edit JCL Screen for Assembling DB2 Configuration Module XVJOPDB2”
screen (Figure 2-19).
Note: A Temporary copy of your Subsystem information (XVJTSSID) is stored within the
JCL Work dataset (see also “Specify a Work Dataset to Write Configuration JCL” on
page 4).
2-32
File-AID Single Install Image Installation and Configuration Guide
Figure 2-14. Maintain DB2 Subsystem Info
File-AID ---------------- Maintain DB2 Subsystem Info -------- Row 1 to 1 of 1
SCROLL===> PAGE
COMMAND ===>


Primary commands:
Line commands
:
ADD -Add a new DB2 SSID
S -Select for Update / D -Delete DB2 SSID
Default SSID
Default DB2 Loadlib
Object Admin Profile
Object Admin Plan Name
Relationship Dsn






==>
==>
==>
==>
==>
Press PF3 to Exit
Cmd
SSID
DB2 Ver
Act
Created
Changed
ID

_
DB01
1110
Y
2013-12-06
2014-05-30-12:49:13 TSOID01 
******************************* Bottom of data ********************************
Note:




If you update a subsystem variable after you have completed “Create and Run
Bind JCL” on page 2-37, you must re-execute “Create and Run Bind JCL” on page
2-37 to pick up the new value.
Default SSID : (Required) Specify a DB2 Subsystem ID (SSID) as the default SSID.
Default DB2 Loadlib : (Required) Specify the DB2 Load library for the default SSID.
Object Admin Profile : (Required for File-AID for DB2 Object Administration) Specify the
name of the VSAM profile dataset for the File-AID for DB2 Object Administration
option.
Object Admin Plan Name : (Required for File-AID for DB2 Object Administration)
Specify the DB2 plan name for the File-AID for DB2 Object Administration option.
This plan name is independent from the DB2 subsystem plan name (see also
“TPLAN” on page 2-35).
Relationship Dsn : (Optional) Specify the dataset name of the Relationship file to be
used with File-AID/RDX and File-AID for DB2.
Adding a Subsystem
To add a new subsystem, enter the ADD primary command which displays the ADD panel
(see Figure 2-15).
File-AID Configuration Facility
2-33
Figure 2-15. Adding a New Subsystem with the ADD Primary Command
File-AID ------------------------COMMAND ===>
ADD Configuration -------------------------


Primary Commands:CANCEL/SAVE/CLEAR


Variable Value
Description

--------- ---------- --------------------------------------------------------- 
More:
+ 
DB2 Subsystem ID.

TSUB

TLOCNID

DB2 remote location identification for this subsystem.


Plan Name for this subsystem.

TPLAN

DDF Installed

TLOCN
(Y,N)

Owner id to be assigned to the plan at BIND time.

TOWNER
TSOID01
(Valid Userid)

Use DB2 packages will be used during the BIND.

TPACKAGE
(Y,N)

Version of DB2 used in this subsystem.

TDB2VER
1010
(1110,1010)

Indicates if the DB2 Subsystem is in New Function Mode.

DB2MODE
Y
In the ADD and UPDATE panels, use the following primary commands:
SAVE : Saves your changes and exits the panel.
A message alerts you when an entry is invalid or a dataset doesn’t exist.
CLEAR : CLEAR blanks out most of the fields and allows you to reenter all required
values. The Bind Owner, DB2 Version, Bufferpool, and JES Statements fields remain
their values, but can be cleared manually.
CANCEL : Exits the panel without saving any changes.
Don’t forget to scroll through the whole ADD Subsystem panel (see Figure 2-15 through
Figure 2-16). The TPROCESS indicator (see also “TPROCESS” on page 2-36), needs special
attention:
• Setting the TPROCESS indicator to Y, will mark this subsystem as active and
available to be used with File-AID/RDX, File-AID for DB2, and File-AID Data
Editor of the Compuware Workbench. Only subsystems marked Act=Y will be
included in the DB2 subsystem list for Option 3, “Create and Run Bind JCL”.
• Setting the TPROCESS indicator to N, will mark this subsystem as inactive
and it will NOT be available to be used with File-AID/RDX, File-AID for DB2,
and File-AID Data Editor of the Compuware Workbench.
2-34
File-AID Single Install Image Installation and Configuration Guide
Figure 2-16. Adding a New Subsystem with the ADD Primary Command - Scrolled
File-AID ------------------------COMMAND ===>
ADD Configuration -------------------------


Primary Commands:CANCEL/SAVE/CLEAR


Variable Value
Description

--------- ---------- --------------------------------------------------------- 
More:
+ 
Indicates if the DB2 Subsystem is in New Function Mode.

DB2MODE
Y
(Y,N) 
The creator id that will be used for the internal tables. 
TINTCR

Enable this Subsystem for use.

TPROCESS Y
(Y,N)


DATASETS
Note: do not use quotes.
Description
Value

---------------------------- ------------------------------------------------- 

Extended Panels:

SSID Exit Library:
SSID Load Library:


SSID Messages:

SSID Panels:
SSID Runlib:

Updating a Subsystem
To view or update a subsystem definition, enter the S line command which displays the
UPDATE panel (see Figure 2-17 on page 2-34). The values for the subsystem variables in
the UPDATE panel are prefilled with the values of the previously updated or added
subsystem definition. The subsystem Id field remains protected and cannot be changed.
A listing of all the subsystem variables is provided in Table 2-5 on page 2-35.
Figure 2-17. Updating a Subsystem with the S Line Command
File-AID ------------------------- UPDATE Configuration -----------------------
COMMAND ===>


Primary Commands:CANCEL/SAVE/CLEAR


Variable Value
Description

--------- ---------- --------------------------------------------------------- 
More:
+ 
DB2 Subsystem ID.

TSUB
DB01

TLOCNID
DSNLOCATON

DB2 remote location identification for this subsystem.


Plan Name for this subsystem.

TPLAN
VJA10027

DDF Installed

TLOCN
Y
(Y,N)

Owner id to be assigned to the plan at BIND time.

TOWNER
TSOID01
(Valid Userid)

Use DB2 packages will be used during the BIND.

TPACKAGE Y
(Y,N)

Version of DB2 used in this subsystem.

TDB2VER
1110
(1110,1010)

Indicates if the DB2 Subsystem is in New Function Mode.

DB2MODE
Y
Deleting a Subsystem
To delete a subsystem definition, enter the D line command which displays the “DELETE
Configuration” panel (see Figure 2-18).
File-AID Configuration Facility
2-35
Figure 2-18. DELETE Configuration
File-AID ------------------------- DELETE Configuration -----------------------
COMMAND ===>


Primary Commands:CANCEL/SAVE/CLEAR


Variable Value
Description

--------- ---------- --------------------------------------------------------- 
More:
+ 
DB2 Subsystem ID.

TSUB
DB01

TLOCNID
DSNLOCATON

DB2 remote location identification for this subsystem.


Plan Name for this subsystem.

TPLAN
VJA10027

DDF Installed

TLOCN
Y
(Y,N)

Owner id to be assigned to the plan at BIND time.

TOWNER
TSOID01
(Valid Userid)

Use DB2 packages will be used during the BIND.

TPACKAGE Y
(Y,N)

Version of DB2 used in this subsystem.

TDB2VER
1110
(1110,1010)

Indicates if the DB2 Subsystem is in New Function Mode.

DB2MODE
Y
In the DELETE panel, use the following primary commands:
DELETE : Deletes the selected SSID information from the File-AID DB2 Subsystem list
and exits the panel.
CANCEL : Exits the panel without deleting the SSID information from the File-AID DB2
Subsystem list.
Table 2-5 lists the variables in the Subsystem list. The variables in the Subsystem list are
used by the Configuration Facility to establish your subsystem environment. You must
supply values for each subsystem on which you install File-AID products that access the
File-AID DB2 subsystem definitions.
Table 2-5.
Subsystem Variables
Variable Name
TSUB
TLOCNID
TPLAN
Your Value
Description
The DB2 subsystem ID for which you are installing File-AID.
This value helps identify JCL members and profiles that
File-AID generates for specific DB2 subsystems.
DB2 remote location identification for the DB2 subsystem.
Default File-AID plan name to be used for this subsystem.
If you access tables at remote locations, you must
specify the same plan name for all subsystems.
Y (Yes) or N (No). (DDF = Distributed Data Facility) Specifies
that the subsystem is to be connected to other subsystems. If
N, you will not be able to access other subsystems from this
one (File-AID will disable Location ID entry). Also, set to N
when SYSIBM.LOCATIONS does not exist.
Owner identification to be assigned to the plan at BIND time
Specifies whether DB2 packages will be used during the bind
of the File-AID plan.
Note:
TLOCN
TOWNER
TPACKAGE
Even if you do not use packages at your site, you
must specify Yes to access tables at remote
locations.
Version of DB2 for this subsystem (e.g. 1010 or 1110).
Numeric value only.
Note:
TDB2VER
2-36
File-AID Single Install Image Installation and Configuration Guide
Table 2-5.
Subsystem Variables (Continued)
Variable Name
DB2MODE
Your Value
Description
New Function Mode. Indicates if the DB2 Subsystem is in
New Function Mode:
Y (Yes) New Function Mode is enabled.
N (No) New Function Mode is NOT enabled.
If DB2 version is 1010, specify Y or N.(N=CM9)
If DB2 version is 1110, specify Y or N.
Note:
File-AID does NOT verify this status during
configuration to allow you to configure on one LPAR
and then deploy the configuration to other LPARs.
Creator id to be used to create tables for internal use.
Scrollable field.
Enable this Subsystem for use (Active subsystem)
Set to Y (Yes) to indicates that this subsystem is active and
available to be used with File-AID/RDX, File-AID for DB2, and
File-AID Data Editor of the Compuware Workbench. This
subsystem will be included in the DB2 subsystem list for
“Create and Run Bind JCL”.
Specify N (No) to indicate that this subsystem is NOT active
and NOT available for use with File-AID/RDX, File-AID for DB2,
and File-AID Data Editor of the Compuware Workbench. This
subsystem will NOT be included in the DB2 subsystem list for
“Create and Run Bind JCL”.
The process indicator (Act) as shown in Figure 2-14 on page
2-32 reflects the value you set here.
Select “Create and Run Bind JCL” and enter the ALL primary
command to process all subsystems with the process
indicator (Act) set to Y.
TINTCR
TPROCESS
DATASETS:
Extended Panels
Additional panel library (SDSNPFPE).
This panel library specification is only required if File-AID for
DB2 Primary Option Menu option 3.5, SQL Command
Manager (SPUFI), is to be invoked.
Customized DB2 exit library.
DB2 load library
DB2 Message Library
DB2 Panel Library
DB2 runlib load library. Usually contains DB2 samples and/or
utilities.
SSID Exit Library
SSID Load Library
SSID Messages
SSID Panels
SSID Runlib Load
Review and Submit JCL
When you press END in the “Maintain DB2 Subsystem Info” screen, the “Edit JCL Screen
for Assembling DB2 Configuration Module XVJOPDB2” screen (Figure 2-19) displays.
File-AID Configuration Facility
2-37
Figure 2-19. Edit JCL Screen for Assembling DB2 Configuration Module XVJOPDB2
EDIT
TSOID01.CPWR.MXVJA20.WORK($XVJDB2M)
- 01.00 Columns 00001 00072 
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('ACCOUNT.NUMBER'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*--------------------------------------------------------------------
000007 //* ASSEMBLE DB2 Configuration Module XVJOPDB2 
000008 //*--------------------------------------------------------------------
000009 //*--------------------------------------------------------------------
000010 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.
000011 //*-------------------------------------------------------------------- 
000012 //STEP0100 EXEC PGM=IEFBR14

000013 //OBJ
DD DSN=&OBJTEMP,DISP=(,PASS),

000014 //
UNIT=SYSDA,

000015 //
SPACE=(TRK,(10,10,5))

000016 //STEP200 EXEC PGM=ASMA90, 
000017 //
PARM=('XREF(SHORT),NORLD,LC(60),CPAT(SYSL),RENT',
000018 //
'BATCH,LANG(EN),TERM,SYSPARM(MVS),OBJ'),
000019 //
REGION=4096K
Review the JCL and submit the job to create the File-AID DB2 Configuration Module
XVJOPDB2. Verify that the job completed before continuing.
Create and Run Bind JCL
Option 3, BIND, in the “Environment Configuration DB2 Subsystem Menu” generates
BIND JCL to establish your DB2 subsystem environments.
When you select Option 3, BIND, the “Run DB2 Bind Jobs” panel displays (see Figure 220) and lists all active DB2 subsystems as indicated with the “TPROCESS” indicator.
Figure 2-20. Run DB2 Bind Jobs

File-AID --------------------- Run DB2 Bind Jobs ------------- Row 1 to 3 of 3 
SCROLL===> PAGE 
COMMAND ===>

Primary commands: ALL-Select all SSIDs,BIND -Bind selected SSIDs

Line commands
: S-Select / U - Unselect SSID for DB2 bind. 

Default SSID
==> DA01
Default DB2 Loadlib
==> DSNA10.SDSNLOAD
Object Admin Profile
==> TSOID01.MXVJA20.PROFILE
Object Admin Plan Name ==> VJA10022

Relationship Dsn
==> TSOID01.FRSAMP.RELATION
Press PF3 to Exit
Cmd
SSID
DB2 Ver
_ Selected
DA01
1010
_
DA1J
1010
_
DB01
1110
*******************************





Created
Changed
ID
2013-05-29
2014-05-30-12:49:05 TSOID01 
2013-05-29
2014-05-30-12:49:11 TSOID01 
2013-05-29
2014-05-30-12:49:13 TSOID01 
Bottom of data ********************************
Use the following primary commands:
ALL : Select all listed DB2 Subsystems.
BIND : Generate DB2 bind JCL for the selected subsystems.






2-38
File-AID Single Install Image Installation and Configuration Guide
Use the following line commands:
S : Select this DB2 Subsystem.
U : Unselect this DB2 Subsystem.
The JCL includes one job for each subsystem you selected. The comments in the JCL
detail what subsystems have been defined. Review the JCL and submit the job.
Note: You must rerun this JCL under the following circumstances:
• A change is made to the Subsystem definition. (See “Maintain DB2
Subsystem Information” on page 2-31.)
Review and Submit JCL
When you select all or individual SSIDs in the “Run DB2 Bind Jobs” screen, the “Edit JCL
Screen for Binding DB2 Subsystems” screen (Figure 2-21) displays.
Figure 2-21. Edit JCL Screen for Binding DB2 Subsystems
File
Edit
Edit_Settings
Menu
Utilities
Compilers
Test
Help

─────────────────────────────────────────────────
EDIT
TSOID01.CPWR.MXVJA20.WORK($XX$$BND) - 01.00
Columns 00001 00072 
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('ACCOUNT.NUMBER'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*--------------------------------------------------------------------
000007 //* THIS JOB INCLUDES FOLLOWING STEPS.

000008 //*
STEP
DESCRIPTION

000009 //*
-------------------------------------------------------------
000010 //*
BIND____: EXECUTE BIND PROC MEMBERS($XX$____) FOR TARGET SSID

000011 //*--------------------------------------------------------------------
000012 //XVJPROC JCLLIB ORDER=TSOID01.CPWR.MXVJA20.WORK

000013 //*--------------------------------------------------------------------
000014 //*

000015 //* 
000016 //BINDDA01 EXEC $XX$DA01
BIND FOR SUBSYSTEM DA01
1
Review the JCL and submit the job to bind the selected DB2 Subsystems. Verify that the
job completed before continuing.
File-AID Configuration Facility
2-39
Step 3.2. Specify IMS Environment (Option 2)
This option executes the File-AID for IMS Admin Option to allow you to create or modify
the IMS environment load module (XVJOPIMS). In pre-Release 10.01.00 the module was
called IXPENV. File-AID for IMS and the File-AID Data Editor of the Compuware
Workbench use this IMS environment load module.
The File-AID for IMS Administration function is used to create and update load module
XVJOPIMS.
XVJOPIMS Load Module
This load module can contain definitions of multiple environments that users of the
product can access. These definitions consist of parameters that control operation of the
product within each environment and also include lists of dataset concatenations to be
used with each environment. You can define multiple XVJOPIMS load modules
containing different collections of environments. If you do so, each XVJOPIMS load
module must be linked into its own load library, and you need to make separate
provisions to start the product with an appropriate load library concatenation to access
the correct XVJOPIMS load module.
Note: If you specified in the product parameter options (“FALIBDEF” on page 2-15) that
File-AID will be in your LINKLIST you must add the library to the LINKLIST before
you can execute the File-AID for IMS Admin Option.
The “IMS Environment Definition Menu” is displayed as shown in Figure 2-22 when you
select Option 2, from the “DB2/IMS/Data Privacy Environment Menu” (Figure 2-11 on
page 2-28).
Figure 2-22. IMS Environment Definition Menu


ADMIN ----------------------- IMS Environment Definition ----------------------
OPTION ===>


-------------------------------------------------------------------------------
New and existing customers may

1 CREATE an IMS Environment load module from scratch

-------------------------------------------------------------------------------
Once an IMS Environment load module has been created use

2 UPDATE to:

ADD environments to an existing IMS Environment load module 
MODIFY parameters for an existing environment

COPY an existing environment to a new environment

RENAME or DELETE environments

-------------------------------------------------------------------------------
Option 2 UPDATE may be used to convert an IMS Environment load module from a
prior release. 
NOTE: This function follows the ISPF convention that fully qualified 
dataset names be preceded by a single quote character ('). 
END Command to exit
Online technical support is available at http://go.compuware.com/



Note: The File-AID for IMS Admin function follows the ISPF convention that fully
qualified dataset names be preceded by a single quote character (').
Create New IMS Environment Module (Option 1)
When you select Option 1 – CREATE on the “IMS Environment Definition Menu” (Figure
2-22), the “Create Environment Module Screen” is displayed as shown in Figure 2-23 on
page 2-40.
2-40
File-AID Single Install Image Installation and Configuration Guide
Figure 2-23. Create Environment Module Screen


ADMIN ----------------------- Create Environment module -----------------------
COMMAND ===>

Enter the load library to contain the new IMS Environment load module:
Load Library Name ===> 'hlq.CPWR.MXVJA20.CXVJLOAD'

END Command to exit or ENTER to continue
Enter the fully qualified name, preceded by a single quote character ('), of the load library
to contain the IMS Environment load module (XVJOPIMS). If an XVJOPIMS load module
already exists in that library, you’re asked to confirm that it’s OK to replace it.
If no errors are detected, the “Select IMS Environment Screen” (Figure 2-25) is displayed.
If no list of environments is displayed on this screen, you can only add a new
environment definition.
To add a new environment definition, enter a unique environment name in the field
labeled Enter a name to add a new environment. The “Modify System Parameters” is
displayed as shown in Figure 2-27 on page 2-43. Refer to “Option 1 – IMS System
Parameters” on page 2-43 for an explanation about completing this screen.
Update Existing IMS Environment Load Module (Option 2)
When you select Option 2 – UPDATE on the “IMS Environment Definition Menu” (Figure
2-22 on page 2-39), the “Update IMS Environment Module Screen” is displayed as shown
in Figure 2-24.
Figure 2-24. Update IMS Environment Module Screen


ADMIN ----------------------- Update Environment Module -----------------------
COMMAND ===>
Enter the load library containing an existing Environment load module:
Load Library Name ===> 'hlq.CPWR.MXVJA20.CXVJLOAD'
END Command to exit
Enter the fully qualified name, preceded by a single quote character ('), of the load library
that contains an IMS Environment Load Module (either XVJOPIMS or, pre-Release
10.01.00, IXPENV) to be updated.
If no errors are detected, the “Select IMS Environment Screen” (Figure 2-25) is displayed.
The list of defined environments is displayed on this screen. Use line commands to
modify a listed environment.
To add a new environment definition, enter a unique environment name in the field
labeled Enter a name to add a new environment. The “Update IMS Environment
Module Screen” File-AID for IMS – Modify System Parameters screen is displayed as shown
in Figure 2-28 on page 2-43. Refer to “Option 1 – IMS System Parameters” on page 2-43
for an explanation about completing this screen.
Select Environment
The “Select IMS Environment Screen” as shown in Figure 2-25 displays a list of
environments and control Add, Change, Delete, Copy, and Rename functions. You access
this screen from the “IMS Environment Definition Menu” (Figure 2-22 on page 2-39). If
you selected Option 2 – UPDATE, the screen displays a list of environments. This list can
be processed using any of the listed line commands. You can also add a new environment
at this time.
File-AID Configuration Facility
2-41
If you access the “Select IMS Environment Screen” by selecting Option 1 –CREATE from
the “IMS Environment Definition Menu”, no environments are listed. You must create an
environment before any of the listed line commands can be used. Once you specified an
environment name, File-AID continues with stepping through all of the option screens,
similar to selecting Option A of the “Modify Environment Menu” (Figure 2-26 on page
2-42). The screen sequence starts with the “Modify System Parameters” screen (Figure 227 on page 2-43).
To add a new environment enter the name of the new environment in the field labeled
Enter a name to add a new environment.
Figure 2-25. Select IMS Environment Screen
ADMIN ------------------------- Select IMS Environment --------- Row 1 from 2 
COMMAND ===>
SCROLL ===> CSR 

END Command to continue processing

Bypass dataset validation (Y/N)
===> 
Enter a name to add a new environment
===>
or

Filter display by environment (* for all) ===> *
or

Filter display by IMSID (* for all)
===> *
or

Change the default environment
===>
or


Use line commands: S to Modify, D to Delete, C to Copy, R to Rename

Old New

Name Name Environment Description
IMSID 
- ---- ---- ----------------------------------------------------------- ----- 
TEST
IMS ENVIRONMENT
ID01 
IMSD
CONVERTED IPRMS BMP ENTRY
ID01 
******************************* Bottom of data ********************************

Upper, Fixed Portion of Screen
Bypass dataset validation (Y/N) : Controls whether dataset validation is bypassed for
the environment definition. Default is N, dataset validation is not bypassed,
whenever you start the Admin function.
Y : Specify Y to bypass the validation of datasets. This allows for creation of the
environment definition even if the datasets do not currently exist. This is useful
when you intend to port the XVJOPIMS load module to another target LPAR
where the datasets exist (see also Appendix J, “Advanced Configuration and
Porting Techniques”).
N : Specify N (default), if datasets should be validated for the environment
definition.
Enter a name to add a new environment : To add a new environment, enter the name
of an environment that does not already exist in the XVJOPIMS load module.
Filter display by environment (* for all) : This field is a filter to limit the display of
environments by environment name. Valid entries are a four-character identifier to
limit the display to a single environment name, a partial environment name plus an
asterisk (*) to limit the display to a subset of environment names, or an asterisk only
(*) to display all environment names.
Filter display by IMSID (* for all) : This field is a filter to limit the display of
environments by IMSID. Valid entries are a four-character ID to limit the display to a
single IMSID, a partial IMSID plus an asterisk (*) to limit the display to a subset of
IMSIDs, or an asterisk only (*) to display all IMSIDs.
Change the default environment : This required field specifies which environment is to
be used when the user does not select any environment. The default environment
allows a user to function in File-AID without selecting an environment. You can
change this value to any defined environment.
2-42
File-AID Single Install Image Installation and Configuration Guide
Lower, Variable Portion of Screen
Table display of defined environments : Whether File-AID displays a table of defined
environments on the Select Environment screen depends on the following scenarios:
• If you accessed the File-AID – Select Environment screen after selecting
Option 1 – CREATE, no list of environments is displayed, and you can only
add a new environment as described in “Create New IMS Environment
Module (Option 1)” on page 2-39.
• If you accessed the File-AID – Select Environment screen after selecting
Option 2 – UPDATE on the File-AID – Environment Definition menu (Figure
2-22 on page 2-39), a list of defined environments is displayed, showing the
environment name, description, and IMSID. You can select an environment
from the list to modify as described in “Update Existing IMS Environment
Load Module (Option 2)”, or add a new environment as described in “Create
New IMS Environment Module (Option 1)” below.
Using the Modify Environment Menu
The “Modify Environment Menu” is displayed as shown in Figure 2-26 on page 2-42
when you select an existing environment from the list on the “Select IMS Environment
Screen” (Figure 2-25 on page 2-41) to modify.
Figure 2-26. Modify Environment Menu
ADMIN --------------------------- Modify Environment --------------------------
OPTION ===>

ENV: TEST - IMS ENVIRONMENT


1 IMS System
IMS system parameters

2 DLI Parms
DLI parameters

3 BMP Parms
BMP parameters

4 ACB Parms
ACB parameters

5 Datasets
Dataset concatenations

A All Parms
Process options 1 through 5 in sequence








END to terminate processing of environment TEST

CANCEL to return to Select Environment panel





The “Modify Environment Menu” displays the environment name and description at the
top of the screen for the update request. You can enter the option number to modify a
particular subset of environment information only, or you can enter option A – All Parms
to step through all of the option screens.
The sequence of option screens displayed depends on the BMP processing allowed
indicator on the File-AID for IMS – Modify System Parameters screen (Figure 2-27 on page
2-43). If this value is set to Y, then screens for all 5 options are displayed. If this indicator
is set to N, then the BMP Parameters and ACB Parameters screens are not displayed. This
information is not required for DL/I processing.
Use the Down (PF8) and Up (PF7) keys to scroll to the second screen of an option. Press
Enter to save and process your updates and to move to the next option. Use the END
command to return to the previous screen.
After completing all updates for all options, use the END command to return to the
File-AID – Modify Environment menu (Figure 2-26 on page 2-42).
File-AID Configuration Facility
2-43
Option 1 – IMS System Parameters
If you enter option 1 or A on the “Modify Environment Menu”, the “Modify System
Parameters” screen as shown in Figure 2-27 on page 2-43 is displayed. You can also access
this screen by entering a new unique environment name in the field labeled “Enter a
name for a new environment” on the “Select IMS Environment Screen” (Figure 2-25 on
page 2-41). Modify or complete the fields on the “Modify System Parameters” screen as
desired. Refer to the field descriptions beginning on page 2-44.
Press the Down (PF8) and Up (PF7) keys to move between the screens. Press Enter to save
your changes and to continue to the other Modify Environment menu options.
Figure 2-27. Modify System Parameters
ADMIN ------------------------ Modify System Parameters -----------------------
COMMAND ===>
SCROLL ===> CSR 

END Command to return to previous screen

ENTER Command to continue

More:
+ 
Specify Environment Description:

Name
===> TEST

Description ===> IMS ENVIRONMENT


Specify General IMS Information:

IMSID
===> ID01

IMS version release
===> 13100
( E.G. 13100 for IMS 13.1.0 ) 
Region Controller Program name
===> DFSRRC00

File-AID for IMS PSBLIB ===> 'CPWR.MXVJA20.SXVJPPSB'


Specify DLI Processing Datasets:

DFSVSAMP Dataset ===> 'IX.IMSVS.CNTL'

Member
===> DFSVSAMP


Specify Processing Options:

PSB processing allowed ===> A
( D = Dynamic; S = Static;
A = All ) 
BMP processing allowed ===> Y
( N = No; Y = Yes )

Figure 2-28. Modify System Parameters, Part 2
ADMIN ------------------------ Modify System Parameters -----------------------
COMMAND ===>
SCROLL ===> CSR 

END Command to return to previous screen

ENTER Command to continue

More:

Specify Processing Options:

PSB processing allowed ===> A
( D = Dynamic; S = Static;
A = All ) 
BMP processing allowed ===> Y
( N = No; Y = Yes )


Specify Default Settings:

DLI Checkpoint interval frequency ===> 00050
( used in load option )

Audit trail dependent segments
===> ALL
( ALL or 0 - 32767 )


Specify Limit Information For Find/Change Command:

Allow CHANGE command
===> Y
( N = No; Y = Yes )

Allow CHANGE ALL command
===> Y
( N = No; Y = Yes )

Max database segments to search
===> 0000000000 ( 0 = No limit )


Specify options for BMP execution:

Wait limit
===> 30
( Specify value from 00 to 99 )

Sync check limit ===> 10
( Specify value from 00 to 99 )

Integrity check ===> Y
( N = No; Y = Yes )

The following section describes the fields on the “Modify System Parameters” screen:
2-44
File-AID Single Install Image Installation and Configuration Guide
Environment Description
Name : This field is view only and is the environment name that is unique for the entire
XVJOPIMS load module and that was either selected from or specified on the “Select
IMS Environment Screen” (Figure 2-25 on page 2-41).
Description : Specify a maximum 60-character, free-format environment description.
General IMS Information
IMSID : This value is used strictly as a filter on the “Select IMS Environment Screen”
(Figure 2-25 on page 2-41) to limit the display of environments.
IMS version release : Specify the version and release of IMS.
Region Controller Program name : Specify the name of the program to which File-AID
for IMS/ISPF attaches to invoke IMS. This program is usually DFSRRC00. A substituted
program name must reside in a dataset that is allocated to DFSRESLB.
File-AID PSBLIB : The dataset name of the PSBLIB of File-AID for IMS PSBs needed when
dynamic PSB processing is used in a BMP region.
Note:
For batch jobs in a DLI region with dynamic PSB processing, File-AID for IMS
will use the PSBLIB defined to the default environment.
DL/I Processing Datasets
DFSVSAMP Dataset : Specify the partitioned dataset name assigned to the DFSVSAMP
ddname. The DFSVSAMP ddname identifies IMS buffer subpools for VSAM, ISAM,
and OSAM datasets. Refer to the IMS Installation Guide and the IMS System
Programming Reference Manual for additional information.
Member : Specify the member name for the DFSVSAMP dataset.
Processing Options
PSB processing allowed : Specify whether dynamic or static PSB processing or both is
allowed within the environment. Valid entries are D=Dynamic, S=Static, and A=All.
BMP processing allowed : Specify whether BMP processing is allowed within the
environment. Valid entries are N=No or Y=Yes.
Default Settings
DLI checkpoint frequency interval : Specify the default number of database updates
that occur between DL/I checkpoint calls during batch database loads.
Audit trail dependent segments : Specify the number of deleted dependent segments to
be captured by the Audit Trail feature when it is activated during a database edit
session. Indicate the maximum number of deleted dependent segment images you
want written to the Audit Trail file for a given deleted parent. Valid entries are All or
any number in the range 0 through 32,767.
Limit Information for Find/Change Command
Allow CHANGE command : Specify to allow CHANGE command for a FIND/CHANGE.
Valid entries are N=No or Y=Yes.
Allow CHANGE ALL command : Allow CHANGE ALL command for a FIND/CHANGE.
Valid entries are N=No or Y=Yes.
MAX database segments to search : Specify the maximum number of database
segments to search if a user does not specify a value when using the FIND/CHANGE
command. Specify 0 to set no limit.
Note:
If a value greater than the value entered here for the FIND/CHANGE
command is specified, than the maximum value for the environment will be
used.
File-AID Configuration Facility
2-45
Options for BMP Execution (Required only if you specified Y for BMP processing allowed)
Wait limit : Specify the maximum time a BMP user can be in a wait state (no activity
from the terminal). When exceeded, the BMP task is ended. Compuware recommends
that the time should be less than the TSO wait time limit to avoid a timeout (522
ABEND) while the BMP region is active. Valid entries are in the range from 0 to 59
minutes. If WAITLMT is set to 0, no File-AID for IMS time out occurs. The default
value is 30 minutes.
Sync check limit : Specify the time interval to perform a check of the IMS (BMP) region
for shutdown when there is no user activity. If the online region is shutting down,
the File-AID for IMS task ends. Valid entries are in the range from 0 to 59 minutes. If
SYNCKLMT is set to 0, no check is made. The default value is 10 minutes.
Integrity check : Specify whether to check the segment for a change by a concurrent
user prior to replace. Valid entries are N=No (replace as is) or Y=Yes.
After you complete modifying or making entries for all the fields, press Enter to save
your inputs and to move to the next Modify Environment menu option.
Option 2 – DL/I Parameters
You can access the “Modify DLI Parameters Screen”, shown in Figure 2-29 and Figure 2-30
on page 2-46, in one of the following ways:
• Select option 2 – DLI Parms from the Modify Environment menu.
• Press Enter after you complete your entries on the “Modify System Parameters”
screen (Figure 2-27 on page 2-43) if you’re creating a new environment definition.
• Press Enter after you complete your entries on the “Modify System Parameters”
screen (Figure 2-27 on page 2-43) if you’re modifying an existing environment
definition and you selected option A – All Parms on the “Modify Environment
Menu” (Figure 2-26 on page 2-42).
Figure 2-29. Modify DLI Parameters Screen
ADMIN ------------------------- Modify DLI Parameters ------------------------
COMMAND ===>
SCROLL ===> CSR 
ENV: TEST - IMS ENVIRONMENT


END Command to return to previous screen 
ENTER Command to continue 

DLI PARMS ===> ,0000,,,,,,,ID01,,N,N,,N,,,,


More:
+ 
Specify DLI Parms:

BUF
===>
(Numeric)

SPIE
===> 0
( 0 or 1 )

TEST
===> 0
( 0 or 1 )

EXCPVR ===> 0
( 0 or 1 )

RST
===> 0
( 0 or 1 )

PRLD
===>
(Alphanumeric)

SRCH
===>
( 0 or 1 )

CKPTID ===>
(Alphanumeric)

MON
===>
( Y = Yes; N = No )

LOGA
===>
( 0 or 1 )

FMTO
===>
(Alphanumeric)

IMSID
===> ID01
(Alphanumeric)

SWAP
===>
( Y = Yes; N = No )

2-46
File-AID Single Install Image Installation and Configuration Guide
Figure 2-30. Modify DLI Parameters Screen, Part 2

ADMIN ------------------------- Modify DLI Parameters ------------------------
COMMAND ===>
SCROLL ===> CSR 
ENV: TEST - IMS ENVIRONMENT


END Command to return to previous screen 
ENTER Command to continue 
DLI PARMS ===> ,0000,,,,,,,ID01,,N,N,,N,,,,
More:
MON
LOGA
FMTO
IMSID
SWAP
DBRC
IRLM
IRLMNM
BKO
SSM
LOCKMAX
GSGNAME
TMINAME
===>
===>
===>
===>
===>
===>
===>
===>
===>
===>
===>
===>
===>
ID01
N
N
N
( Y = Yes; N =
( 0 or 1 )
(Alphanumeric)
(Alphanumeric)
( Y = Yes; N =
( Y = Yes; N =
( Y = Yes; N =
(Alphanumeric)
( Y = Yes; N =
(Alphanumeric)
(Numeric)
(Alphanumeric)
(Alphanumeric)
-
No )
No )
No; Blank is default)
No; Blank is default)
No )
















The following section describes the fields on the “Modify DLI Parameters Screen” screen:
DLI PARMS : DL/I parameters are passed to DFSRRC00 (the IMS region controller).
File-AID generates REGIONTYPE, PGMNAME, and PSBNAME and concatenates them
in front of your parameters. This field is display only and reflects the values specified
in the individual fields below.
BUF : Specify the number of 1K blocks for calculating OSAM Subpools if IOBF is not
specified in DFSVSAMP.
SPIE : Specify whether to allow SPIE established by the application program. Valid
entries are 0=allow SPIE or 1=negate SPIE. Default is 0.
TEST : Specify whether to validate addresses in the call list. Valid entries are 0=do not
validate or 1=validate. Default is 0.
EXCPVR : Specify whether to page fix OSAM buffer pool. Valid entries are 0=do not page
fix or 1=page fix. Default is 0.
RST : Specify whether to UCF restart. Valid entries are 0=no or 1=yes. Default is 0.
PRLD : Specify whether to pre-load the list suffix, DFSMPLxx.
SRCH : Specify the module search indicator. Valid entries are 0=standard or 1=search JPA
and LPA first.
CKPTID : Specify the checkpoint for restart of program.
MON : Specify whether IMS is to monitor activity. Valid entries are N=no or Y=yes.
LOGA : Specify the logging access method. Valid entries are 0=BSAM or 1=OSAM. No
longer used.
FMTO : Specify the dump formatting option.
IMSID : Specify the IMS subsystem ID.
SWAP : Specify whether to allow swappable address space. Valid entries are Y=yes or
N=no.
DBRC : Specify whether to use DBRC. Valid entries are blank=use your system default;
Y=always use DBRC; or N=no, unless system forces it with DBRC=FORCE.
IRLM : Specify whether to use IRLM. Valid entries are Y=yes or N=no.
IRLMNM : Specify the IRLM subsystem name.
File-AID Configuration Facility
2-47
BKO : Specify whether to perform dynamic backout. Valid entries are N=no or Y=yes.
SSM : Specify the subsystem member suffix for external subsystems.
LOCKMAX : Specify the locking limit overrides for PSB LOCKMAX. Valid entries are
0=none; or 1 through 32,767=locks in units of 1,000.
GSGNAME : Specify the global service group name.
TMINAME : Specify the transport manager instance name.
Option 3 – BMP Parameters
You can access the “Modify BMP Parameters” screen, shown in Figure 2-31 on page 2-47
and Figure 2-32 on page 2-48, in one of the following ways:
• Select option 3 – BMP Parms from the “Modify Environment Menu” (Figure 2-26 on
page 2-42).
• Press Enter after you complete your entries on the“Modify DLI Parameters Screen”
(Figure 2-29 on page 2-45) if you’re creating a new environment definition with BMP
entries.
• Press Enter after you complete your entries on the “Modify DLI Parameters Screen”
(Figure 2-29 on page 2-45) if you’re modifying an existing environment definition
with BMP entries and you had selected option A – All Parms on the “Modify
Environment Menu” (Figure 2-26 on page 2-42).
Figure 2-31. Modify BMP Parameters,

ADMIN ------------------------- Modify BMP Parameters -------------------------
COMMAND ===>
SCROLL ===> CSR 
ENV: TEST - IMS ENVIRONMENT


END Command to return to previous screen 
ENTER Command to continue 
BMP PARMS ===> ,,N00000,,,,1,,0000,0000,,IMSDRACF,,,,
More:
Specify BMP Parms:
IN
===>
OUT
===>
OPT
===> N
SPIE
===> 0
TEST
===> 0
DIRCA
===> 000
PRLD
===>
STIMER ===>
CKPTID ===>
PARDLI ===> 1
CPUTIME ===>
NBA
===> 0000
OBA
===> 0000
(Alphanumeric)
(Alphanumeric)
( N , W or C )
( 0 or 1 )
( 0 or 1 )
(Numeric)
(Alphanumeric)
( 0 or 1 )
(Alphanumeric)
( 0 or 1 )
(Numeric)
(Numeric)
(Numeric)


+ 














2-48
File-AID Single Install Image Installation and Configuration Guide
Figure 2-32. Modify BMP Parameters, Part 2

ADMIN ------------------------- Modify BMP Parameters -------------------------
COMMAND ===>
SCROLL ===> CSR 
ENV: TEST - IMS ENVIRONMENT


END Command to return to previous screen 
ENTER Command to continue 

BMP PARMS ===> ,,N00000,,,,1,,0000,0000,,IMSDRACF,,,,,
More:
DIRCA
PRLD
STIMER
CKPTID
PARDLI
CPUTIME
NBA
OBA
IMSID
AGN
SSM
PREINIT
ALTID
===>
===>
===>
===>
===>
===>
===>
===>
===>
===>
===>
===>
===>
000
1
0000
0000
IMSDRACF
-
(Numeric)
(Alphanumeric)
( 0 or 1 )
(Alphanumeric)
( 0 or 1 )
(Numeric)
(Numeric)
(Numeric)
(Alphanumeric)
(Alphanumeric)
(Alphanumeric)
(Alphanumeric)
(Alphanumeric)















The following section describes the fields on the “Modify BMP Parameters” screen:
BMP PARMS : BMP parameters are passed to DFSRRC00 (the IMS region controller).
File-AID for IMS/ISPF generates REGIONTYPE, PGMNAME, and PSBNAME and
concatenates them in front of your parameters. This field is display only and reflects
the values specified in the individual fields below.
IN : Specify the input transaction code.
OUT : Specify the output transaction code.
OPT : (Required) Specify which option to enable when the IMSID or ALTID system is not
available. Valid entries are N=ask operator, W=Wait, or C=Cancel.
SPIE : (Required) Specify whether to allow SPIE established by the application program.
Valid entries are 0=no or 1=yes.
TEST : (Required) Specify whether to validate addresses in the call list. Valid entries are
0=do not validate or 1=validate.
DIRCA : (Required) Specify the dependent region interregion communication area size.
PRLD : Specify whether to pre-load the list suffix, DFSMPLxx.
STIMER : Specify whether to gather processor time statistics. Valid entries are 0=No or
1=Yes.
CKPTID : Specify the checkpoint for the restart of the program.
PARDLI : Specify whether the parallel DL/I option is enabled. Valid entries are 0=enabled
or 1=disabled.
CPUTIME : Specify the task timing option. Valid entries are 0=none or 1 through
1440=maximum time in minutes.
NBA : Specify the initial number of fast path buffers for DEDB.
OBA : Specify the overflow number of fast path buffers for DEDB.
IMSID : Specify the IMS subsystem ID.
AGN : Specify the application group name.
SSM : Specify the subsystem member suffix for external subsystems.
PREINIT : Specify the pre-initialization list suffix, DFSINTxx.
File-AID Configuration Facility
2-49
ALTID : Specify the alternate IMS system.
LOCKMAX : Specify the locking limit, which overrides PSB LOCKMAX. Valid entries are
0=none or 1 through 32,767. This value locks in units of 1,000.
Option 4 – ACB Parameters
You can access the “Modify ACB Parameters” screen, shown in Figure 2-33 on page 2-49,
in one of the following ways:
• Select option 4 – ACB Parms from the “Modify Environment Menu” (Figure 2-26 on
page 2-42).
• Press Enter after you complete your entries on the “Modify BMP Parameters” screen
(Figure 2-31 on page 2-47) if you’re creating a new environment definition with BMP
entries.
• Press Enter after you complete your entries on the “Modify BMP Parameters” screen
(Figure 2-31 on page 2-47) if you’re modifying an existing environment definition
with BMP entries and you had selected option A – All Parms on the “Modify
Environment Menu” (Figure 2-26 on page 2-42).
Figure 2-33. Modify ACB Parameters

ADMIN ------------------------- Modify ACB Parameters -------------------------
COMMAND ===>
SCROLL ===> CSR 
ENV: TEST - IMS ENVIRONMENT


END Command to return to previous screen 
ENTER Command to continue 
Specify ACB Information:
ACBNAME Prefix
Number of ACB Names
Reset ACBLIB indicator
DOPT ACBLIB
===> FAIMS
===> 0005
(Maximum concurrent BMP users)
===> Y
( Y = Yes; N = No )
===> 'IX.IMSVS.DOPT.ACBLIB'
*** These ACBs must be defined to the IMS system before use
*** The DOPT ACBLIB must be in the ACBLIB concatenation

***
***














The following section describes the fields on the “Modify ACB Parameters” screen:
ACBNAME Prefix : Specify the ACBNAME prefix, which is any one- to five-character
string to be used to construct the ACBNAMEs. The ACBNAMEs that are used contain
the ACBNAME prefix followed by a three digit number (000-999). For example:
FAIMS000, FAIMS001, .... FAIMS(nnn-1)
where FAIMS is the prefix and nnn is the number of ACBNAMEs.
Note:
It is recommended that an ACB prefix that is unique for each environment
be added.
Number of ACB Names : Because an ACBNAME is required for each concurrent BMP
user of File-AID for IMS, specify a number high enough to satisfy all simultaneous
BMP users.
Reset ACBLIB Indicator : Specify whether to have File-AID for IMS automatically reset
(empty) the DOPT ACBLIB dataset. Valid entries are Y=yes or N=no. Specifying Y
2-50
File-AID Single Install Image Installation and Configuration Guide
causes the directory of the dataset to be reset to an empty state prior to writing out
the new ACB. Specify Y only if File-AID has exclusive use of that dataset.
You should not provide secondary extents. If an ACBGEN causes a secondary extent
to be obtained, IMS is not aware of the secondary extent and will get an IO error
when attempting to read the member.
DOPT ACBLIB : Specify the DOPT ACB library dataset name to contain File-AID for IMS’
dynamically created ACBs. This is a required library that you may need to allocate
yourself. The attributes of the dataset should match those of the static ACBLIB. After
creating the dataset, ensure that it is concatenated last on the IMSACBA and
IMSACBB DD cards of the JCL that is used to start the IMS control region.
This dataset can be shared with other products, but to greatly reduce maintenance on
this library, Compuware recommends that it be assigned exclusively to File-AID for
IMS. This library is used to dynamically create any ACBs that are required by the
users.
IMPORTANT
Here are a few reminders concerning the BMP installation:
– An APPLCTN macro must be included in the IMS stage 1 GEN input using the
specified ACB names. For example:
APPLCTN DOPT,PSB=FAIMS000,PGMTYPE=(BATCH,,,)
This example identifies the PSB name, FAIMS000, to IMS as a BMP PSB using the
dynamic option.
Note:
Cold start IMS or perform an online change after the GEN process to
bring in the new APPLCTN macros.
– The IMS startup JCL must include the DOPT ACB library named in the
BMPPARMS as part of the ACBLIB concatenation IMSACBA and IMSACBB DD
statements. This library must be included in the control region as well as the
DLI/SAS region JCL. The DOPT ACBLIB must be concatenated after the static
ACBLIBs. If the library already exists, File-AID uses the existing DOPT ACBLIB if
it is named in the BMPPARMS.
– If you have an existing security package, you may have to identify the BMP to
the security product.
Option 5 – Dataset Concatenations
You can access the “Dataset Concatenation” screen, shown in Figure 2-34 on page 2-51,
in one of the following ways:
• Select option 5 – Datasets from the “Modify Environment Menu” (Figure 2-26 on
page 2-42).
• Press Enter after you complete your entries on the “Modify ACB Parameters” screen
(Figure 2-33 on page 2-49) if you’re creating a new environment definition with BMP
entries.
• Press Enter after you complete your entries on the “Modify DLI Parameters Screen”
screen (Figure 2-29 on page 2-45) if you’re creating a new environment definition
without BMP entries.
• Press Enter after you complete your entries on the “Modify ACB Parameters” screen
(Figure 2-33 on page 2-49) if you’re modifying an existing environment definition
with BMP entries and you had selected option A – All Parms on the “Modify
Environment Menu” (Figure 2-26 on page 2-42).
• Press Enter after you complete your entries on the “Modify DLI Parameters Screen”
screen (Figure 2-29 on page 2-45) if you’re modifying an existing environment
definition without BMP entries and you had selected option A – All Parms on the
File-AID Configuration Facility
2-51
“Modify Environment Menu” (Figure 2-26 on page 2-42).
The “Dataset Concatenation” screen enables you to specify datasets for the specified
ddnames. File-AID for IMS supports the MVS limit of 114 datasets per ddname or 120
Extents. The environment name and description is displayed at the top of the screen for
the Add or Update request.
Figure 2-34. Dataset Concatenation


ADMIN ------------------------- Dataset Concatenation ------ Row 1 to 15 of 23 
COMMAND ===>
SCROLL ===> CSR 
ENV: TEST - IMS ENVIRONMENT


END Command to return to Modify Environment screen 
I to Insert, D to Delete, R to Repeat, S to Expand error msg or Recall
DD TYPE
-------IMS ACB
IMS ACB
COB 2
COB 1
IMS DBD
IMS DBD
IMS ESL
IMS ESL
FI FLEX
IMS MDA
IMS MDA
PLI 1
PLI 2
IMS PSB
Dataset Name
---------------------------------------------'IX.IMSVS.ACBLIB'
'IX.IMSVS.ACBLIBA'
'CW.FISAMP.COBOLLIB'
'IX.IMSVS.DBDLIB'
’TSOID01.FISAMP.DBDLIB'
'DB2.PROD.LOAD'
‘DB2.SDSNLOAD'
'TSOID01.FISAMP.FLEX'
'IX.IMSVS.MDALIB'
‘TSOID01.IMSVS.MDALIB'
'CW.FISAMP.PLILIB'
'CPWR.MXVJA20.SXVJPPSB'
Concat No.
---------0010
0020
0010
0010
0010
0020
0010
0020
0010
0010
0020
0010
0010
0010

Message 
-------- 





I625









You can enter the listed line commands to the left of any DD TYPE on the “Dataset
Concatenation” screen to do the following:
•
•
•
•
I (Insert): Inserts a blank line after the selected DD TYPE.
D (Delete): Deletes the selected dataset.
R (Repeat): Repeats the selected line.
S (Select): Selects the message text for viewing if the Message field is not blank, or
recalls the dataset if it is migrated.
The following section describes the fields on the “Dataset Concatenation” screen:
DD TYPE : Seventeen DD types are allowed in File-AID for IMS. This field is display only.
You cannot add new DD types. The datasets stored in the XIXOPIMS load module for
the environment always have a minimum of 17 entries, one per DD type. If all of the
datasets are deleted for a particular DD type, one default entry is built for that DD
type with the dataset name blank. Following is a list of DD types:
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
IMS ACB - ACB library
IMS DBD - DBD library
IMS ESL - DB2 library
IMS MDA - MDA library
IMS PSB - PSB library
IMS RES - RES library
IMS PROC - PROC library
COB XREF - COBOL cross-reference
PLI XREF - PL/I cross-reference
COB 1 - COBOL layouts 1
COB 2 - COBOL layouts 2
FI FLEX - FLEX command statements
PLI 1 - PL/I layouts 1
PLI 2 - PL/I layouts 2
FI APPL - Application relationships
FI SEL - Selection criteria
2-52
File-AID Single Install Image Installation and Configuration Guide
– IMS STEP - DBD exit routines
Dataset Name : Dataset names can be entered fully qualified with quotes or unqualified
without quotes. Dataset names entered without quotes append your TSO user ID as
the high-level qualifier. You may use the user ID variable #USERID to indicate that a
user’s TSO prefix or user ID should appear as the first node of a dataset name. All
dataset names must be valid and cataloged datasets; otherwise, an error message
displays in the Message field. The following edits are performed on the datasets based
on DD type:
– The four layout datasets can be a PDS, Panvalet, or Librarian format. If the
dataset is Panvalet or Librarian, then only one is allowed. You cannot mix PDSs,
Panvalet, or Librarian formats for any of the layout DD types.
– The two cross-reference datasets can be either a PDS or sequential format. If the
dataset is sequential, then only one is allowed.
– Selection criteria, application relationships, FLEX statements, and PROCLIB can
be a PDS only.
– ACBLIB, DBDLIB, PSBLIB, MDALIB, STEPLIB, DFHESL, and RESLIB must be a PDS
with RECFM=U.
CAUTION:
Datasets with an error message are still included in the XVJOPIMS load module
for the environment. These datasets are excluded from processing if the
environment is selected for use.
Concat No. : The concatenation number field is initialized to 10 and incremented by 10
for each dataset name per DD type. You can control the concatenation sequence of
the datasets by DD type. Simply renumber this field for the dataset sequence you
want, and then press Enter. When you use the R (Repeat) line command, a
concatenation number is repeated. Change this number if the dataset sequence is not
already in the desired sequence.
Message : The Message field in the table display shows a message ID when an error is
detected with the dataset. If the dataset is migrated, then the Message field displays
MIGRATED. When the message field is not blank, enter the S (Select) line command
to view the message text of the error message. For migrated datasets, the S line
command displays the MIGRATED DATASET panel and enables you to recall the
dataset. If the message field is blank, then the S line command is ignored. When the
user ID variable #USERID has been properly entered, the informational message I625
displays in the message field.
Option A – All Parms
If you select option A, all of the screens for the previous five options are displayed in
order beginning with the “Modify System Parameters” screen (Figure 2-27 on page 2-43).
You can modify any of the fields. Use the Down (PF8) and Up (PF7) keys to scroll to any
second screen for an option. Press Enter to save and process your changes and to move to
the next applicable option for the environment you’re updating. After the last applicable
screen, use the End command to display theAssemble XVJOPIMS screen (Figure 2-35 on
page 2-53).
Assemble Environment Module (XVJOPIMS)
The “Assemble Environment module (XVJOPIMS)” screen, as shown in Figure 2-35 on
page 2-53, is accessed by entering the END command on the “Select IMS Environment
Screen” (Figure 2-25 on page 2-41). The “Assemble Environment module (XVJOPIMS)”
screen is used to specify the dataset for the IMS Environment module, sysout class and
job cards to be used to create the batch job stream.
The SOURCE FOR Environment field displays the name of the original load library for the
XVJOPIMS load module to be updated for information only.
File-AID Configuration Facility
2-53
Figure 2-35. Assemble Environment module (XVJOPIMS)

ADMIN ---------------------- Assemble Environment module ----------------------
OPTION ===>


SOURCE FOR Environment ===> 'hlq.CPWR.MXVJA20.CXVJLOAD' 

LIBRARY FOR Environment ===> 'hlq.CPWR.MXVJA20.CXVJLOAD'

Specify batch JCL information:
SYSOUT CLASS ===>
JOB statement information:
===> //TSOID01 JOB ('ACCOUNT.INFO'),'USERNAME',CLASS=L,REGION=5M,
===> //
MSGCLASS=X,NOTIFY=TSOID01,MSGLEVEL=(1,1)
===> //*
===> //*

CANCEL Command to exit 
END Command or ENTER to continue









Link-edit Information
SOURCE FOR Environment : Displays the name of the original load library specified on
the “Create Environment Module Screen” (Figure 2-23) or “Update IMS Environment
Module Screen” (Figure 2-24).
LIBRARY FOR Environment : By default the name of the File-AID load library specified
on the Administration menu is used to link-edit the XVJOPIMS load module. You can
specify a different load library name.
Note:
You need to make sure that you are entering the load library name for the current
Release you are installing.
Batch JCL Information
SYSOUT CLASS : Specify the output class for the Assembly listing.
Job Statement Information : Enter the JOB statement and other related JCL statements.
For both /*JOBPARM and /*ROUTE statements.
When you’ve completed your entries for this screen, press Enter or END (PF3) to
continue, or CANCEL to return to the “IMS Environment Definition Menu” (Figure 2-22
on page 2-39).
IMS Environment Information Panel
The “IMS Environment Information Panel” screen, as shown in Figure 2-36 on page 2-54,
displays when you press Enter in the “Assemble Environment module (XVJOPIMS)” panel
and the specified environment load module already exists.
2-54
File-AID Single Install Image Installation and Configuration Guide
Figure 2-36. IMS Environment Information Panel
ADMIN ------------------- IMS Environment Information Panel -------------------
COMMAND ===>


******************************** C A U T I O N *******************************

An IMS Environment load module already exists in the load library.


Enter "N" below to keep the existing load module.


Enter "Y" below to replace the existing load module.


Do you want to replace the load module ===> N ( Y = Yes; N = No )
If you specify N to not replace the existing load module, you’re returned to the
“Assemble Environment module (XVJOPIMS)” screen, where you have a second
opportunity to generate and submit or save the JCL.
If you specify Y to replace the existing load module, the “Edit JCL Screen for Assembling
IMS Environment Module XVJOPIMS” screen (Figure 2-37) displays where you can review
and submit the generated JCL.
Review and Submit JCL
When you press Enter in the “IMS Environment Information Panel” screen, the “Edit JCL
Screen for Assembling IMS Environment Module XVJOPIMS” screen (Figure 2-37)
displays.
Figure 2-37. Edit JCL Screen for Assembling IMS Environment Module XVJOPIMS
EDIT
SYS13233.T072211.RA000.TSOID01.R0121315 Columns
00001 00072 
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('ACCOUNT.NUMBER'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

=NOTE= YOU ARE NOW EDITING THE JCL THAT FILE-AID HAS GENERATED TO PERFORM

=NOTE= THE REQUIRED FUNCTION. YOU CAN CHANGE THIS JCL IF DESIRED, AND USE

=NOTE= THE SUBMIT PRIMARY COMMAND TO SUBMIT THE JOB. TO KEEP THIS JCL FOR

=NOTE= FUTURE USE, USE THE CREATE OR REPLACE PRIMARY COMMAND. ENTER THE

=NOTE= END COMMAND TO EXIT THE FUNCTION WITHOUT SUBMITTING THE JOB.

000005 //*____________________________________________________________________ 
000006 //*
| 
000007 //*
A S S E M B L E X V J O P I M S L O A D M O D U L E
| 
000008 //*
--------------- --------------- ------- ----------| 
000009 //*
| 
000010 //* STEP
FUNCTION
| 
000011 //* ---------------------------------------------------------| 
000012 //*ASSEMBLE FILE-AID FOR IMS/ISPF ENVIRONMENT PARAMETERS
| 
000013 //*ASSEMBLE FILE-AID FOR IMS/ISPF ENVIRONMENT PARAMETERS
|
000014 //*
1
ASSEMBLE ENVIRONMENT PARAMTERS MODULE
|
Review the JCL and submit the job to create the Environment Module XVJOPIMS. Verify
that the job completed before continuing.
To save the generated JCL for future use, you can use the ISPF CREATE, REPLACE, or CUT
and PASTE commands. Note that simply issuing the CUT command with no modifiers
cuts the entire member.
Press END to return to the “IMS Environment Definition Menu”.
File-AID Configuration Facility
2-55
Step 3.3. Specify File-AID Data Privacy (Option 3)
Select Option 3 from the “DB2/IMS/Data Privacy Environment Menu” (Figure 2-11 on
page 2-28) to create or modify the Data Privacy module XVJOPDPR. This module is
required to make File-AID Data Privacy available to File-AID products.
Specify Source of Product Parameters
When you select Option 3, Data Privacy, the “Source of Product Parameters” panel shown
in Figure 2-38 displays.
Figure 2-38. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):
Previous install dataset . .
OR
Configuration library . . .

Press ENTER to continue. 






1. Specify either
– the name of a File-AID product install dataset prior to Release 10.1 for a product
that includes Data Privacy definitions
OR
– the name of the File-AID Configuration (load) library that includes a Data
Privacy module XVJOPDPR you want to use as a source for your parameter input
OR
– Leave both fields blank if this is your initial installation of File-AID or you want
to preserve or restore the product installation defaults
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
A valid previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID/Data
Solutions that includes Data Privacy, then you may retain the previously
specified variable values. This is accomplished by specifying the name of the
install dataset (e.g. hlq.CPWR.MUDA440.INS or
COMPWARE.MUDA440.INSTALL) that was previously used to install
File-AID/Data Solutions.
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
2-56
File-AID Single Install Image Installation and Configuration Guide
forward to the new configuration parameters. Product installation
defaults are used when previous variable values cannot be imported.
Configuration library : Leave blank if you want to preserve or restore the product
installation defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a Data Privacy module XVJOPDPR and you want to use it as a source for your
parameter input.
If you want to use a preexisting Data Privacy module, you can specify the name
of the dataset that contains it. If a valid parameter module is found, ALL values
will be initialized from there. If the utility finds a CXVJLOAD dataset with a hlq
that matches the SXVJSAMP you are executing from AND a valid parameter
module is found, this field will be prefilled.
2. Press Enter. When a Previous install dataset is used, a message displays whether
existing variables were loaded or not.
3. If variables couldn’t be loaded, press Enter again to remove the message and continue
with the “Data Privacy Menu” shown in Figure 2-39.
Figure 2-39. Data Privacy Menu

File-AID ------------------- Product Configuration ---------------------------
OPTION ===>

Product.... File-AID/Data Privacy

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters


3 CUSTOMIZE
- Option not available







Figure 2-5 shows an example when both fields in the “Source of Product Parameters”
panel (Figure 2-4 on page 2-8) were left blank.
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 2-55). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the respective
default values. Make sure to review all parameter values before submitting the
job to create a PARM module.
Configuration Output : Identifies the configuration load library to which the File-AID
Data Privacy module XVJOPDPR will be saved. Specify the load library you want to
save the File-AID Common Component module XVJOPDPR to.
File-AID Configuration Facility
2-57
The available options in the “Data Privacy Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
Select one of the available options.
Review Target and Configuration Module Libraries
Select Option 1 from the “Data Privacy Menu” to display the “Dataset Name
Specification” panel (Figure 2-6 on page 2-11). Here you review the dataset information
for the File-AID SMP/E Target Libraries that were created during the SMP/E installation
(see Chapter 2, “RFN SMP/E Installation of Compuware Mainframe Products” or
Appendix A, “SMP/E Installation Using the EP Media Interface” in the Compuware Installer
Mainframe Products SMP/E Installation Guide) and the File-AID Configuration Module
Libraries. The displayed list is the same as displayed in Figure 2-6 on page 2-11. Refer to
“Step 2.1 Specify Configuration Module Dataset Names” on page 2-10 for more
information.
Specify Data Privacy Product Configuration Parameters
Select Option 2 from the “Data Privacy Menu” to display the “File-AID Data Privacy
Parameters” panel (Figure 2-40). Option 2 allows you to specify values for variables that
the Configuration Facility uses to configure the Data Privacy module XVJOPDPR. A
listing of all the parameter variables is provided in Table 2-6 on page 2-59.
The displayed variable values have been imported from the source you specified in
“Source of Product Parameters” (Figure 2-38 on page 2-55). If no source was specified, the
variable values represent the product installation defaults.
Note: File-AID attempts to import parameter values from the specified source. However,
when not all variables can be imported, File-AID loads the default values. Make
sure to review all parameter values before submitting the job to create the Data
Privacy module.
After entering the desired values, enter END (PF3) to continue to the EDIT Generated JCL
screen (Figure 2-41 on page 2-62), or CANCEL to exit the screen without saving your
changes.
2-58
File-AID Single Install Image Installation and Configuration Guide
Figure 2-40. File-AID Data Privacy Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>

-----------------------------------------------------------------------------Product.... File-AID Data Privacy

Version.... 10.02.00
-----------------------------------------------------------------------------More:
+ 
Compuware Workbench Server
IP Address (IPV4) for the Compuware Workbench Server:
000.000.000.000
File-AID Data Privacy User Interface Port (default 5180): 5180
File-AID Data Privacy Execution Port (default 4180):
4180
z/OS UNIX Path Names for Java environment - Validate Path Names: Y (Y/N) 
Path Name for Java Virtual Machine (JVM) (maximum 512 bytes):
/usr/lpp/java/J6.0.bld102512/
----+----1----+----2----+----3----+----4----+----5----+----6----+----7-Path Name for File-AID Rules Engine (FARE) (maximum 512 bytes):
/opt/Compuware/FARE/
----+----1----+----2----+----3----+----4----+----5----+----6----+----7-Path Name for FARE Log Directory (maximum 512 bytes):


----+----1----+----2----+----3----+----4----+----5----+----6----+----7-
Java Options (maximum 10 options, maximum 80 bytes each) 
Opt 1: -verbose:sizes
Opt 2:
Opt 3:
Opt 4:
Opt 5:
Opt 6:
Opt 7:
Opt 8:
Opt 9:
Opt 10:









+ 


+ 


+ 

+
+
+
+
+
+
+
+
+
+
The File-AID Data Privacy variables provide configuration options for the Dynamic
Privacy Rules (DPR) created with File-AID Data Privacy. These variables are only needed
when the File-AID Data Privacy plugin of the Compuware Workbench is installed and
DPR is to be used.
Note:
File-AID Data Privacy must have been installed per the instructions in the
File-AID Data Privacy chapter of the Compuware Workbench Installation Guide before
proceeding with this step. 

Also, Option 3 can be skipped during initial configuration of File-AID and
returned to later, after the File-AID Data Privacy installation (Server, File-AID
Rules Engine, etc.) has been completed.
Disguising elements of a dataset using DPR can be requested from option D on the
File-AID/Data Solutions Main Menu or from File-AID/RDX, File-AID for DB2, or File-AID
for IMS if you are also licensed for File-AID/Data Solutions.
The Dynamic Privacy Rules (DPR) rules are stored in a File-AID Data Privacy Repository
and are accessed at execution time to disguise data as defined by the data privacy rules.
All repositories which are to be available for DPR from a given install of the File-AID
Single Install Image must be configured on the same Compuware Workbench Server as
each install of the File-AID Single Install Image only supports connecting to one
Compuware Workbench Server. If multiple Compuware Workbench Servers are required,
the File-AID Single Install Image must be customized multiple times.
Enter the appropriate values for each variable.
Fields marked with a plus sign (+) are left/right scrollable and can be expanded with the
EXPAND command.
For more information for using this screen, enter HELP.
File-AID Configuration Facility
2-59
After entering the desired variable values, press END (PF3) to continue with reviewing the
generated JCL (Figure 2-41 on page 2-62), or CANCEL to exit the screen without saving
your changes.
Note:
z/OS UNIX file/path names are CaSe SEnSiTiVE. Enter all path names fully
qualified without quotes.
Table 2-6 lists the parameter variables.
Table 2-6.
File-AID Data Privacy Variables
Description
Default Value
Compuware Workbench Server
Your Value
Comments
Three parameters are required to specify how to access the Compuware Workbench Server:
• IP address
• execution port
• user interface port
IP Address
(IPV4) for the
Compuware
Workbench
Server
000.000.000.000
File-AID Data
Privacy User
Interface Port
(default 5180)
5180
File-AID Data
Privacy
Execution Port
(default 4180)
4180
IP address.
Enter the IP address of the
machine where the Compuware
Workbench Server is running. This
must be the same as the value
entered during the configuration
of the Compuware Workbench.
Use IPV4 dotted decimal format.
Example: 127.0.0.1. None of the
four decimal numbers should have
a leading zero (0).
Note that the provided default
value is NOT a valid IP address.
Port number (1025 - 65535).
Enter the port to be used when
repository and project lists are
requested in the mainframe
File-AID user interface. This must
be the same as the File-AID User
Interface Port specified during
configuration of the Compuware
Workbench Server
This communication is configured
differently than the execution
time communication to reduce
the region size required for the
user; the JVM (JAVA virtual
machine) is not required for this
communication.
Port number (1025 - 65535).
Enter the port to be used for
execution time (batch)
communication with the
Compuware Workbench Server.
This port will be used to retrieve
the appropriate Dynamic Privacy
Rules from the requested
repository and project.
This must be the same as the
File-AID Data Privacy execution
port specified during
configuration of the Compuware
Workbench Server.
2-60
File-AID Single Install Image Installation and Configuration Guide
Table 2-6.
File-AID Data Privacy Variables (Continued)
Description
Default Value
z/OS UNIX Path Names for Java environment
Your Value
Four parameters are available to specify z/OS UNIX Path information:
• Validate Path Names
• Path Name for Java Virtual Machine (JVM)
• Path Name for File-AID Rules Engine (FARE)
• Path Name for FARE Log Directory
z/OS UNIX Path Y
Names for Java
environment Validate Path
Names
Path Name for
Java Virtual
Machine (JVM)
(maximum 512
bytes)
/usr/lpp/java/J6.0.bld102512/
Comments
Specify whether the z/OS UNIX
(z/OS UNIX, formerly known as
USS) path names should be
verified.
Specify Y for validation of Path
Names you are entering.
The default is Y.
If a Path Name you are entering
has not been defined yet, use N to
bypass validation.
Specify the z/OS UNIX path for
the directory where your JAVA JVM
is installed.
The path must start with a forward
slash, e.g.
“/usr/lpp/java/J7.1.bld111513/”
and should end with a forward
slash.
Note:
Path Name for
File-AID Rules
Engine (FARE)
(maximum 512
bytes)
/opt/Compuware/FARE/
The File-AID Rules Engine
5.0.0 and later requires a
Java 7 JVM (31-bit). 
The pre 5.0.0 Common
Disguise Engine requires
a Java 6 JVM (31-bit).
z/OS UNIX path name of your
site’s File-AID Rules Engine (FARE)
(formerly Common Disguise
Engine, or CDE) - max 512 chars.
All Dynamic Privacy Rules are
applied by the File-AID Rules
Engine (FARE). When DPR is
requested from a mainframe
product, FARE must be installed
on z/OS UNIX. FARE is on the
File-AID/EX and File-AID
Distributed Components media
via a link on your RFN order or on
the File-AID EP media (or
FrontLine) and must be uploaded
and installed to z/OS UNIX on the
LPAR (see also “z/OS UNIX
(File-AID Rules Engine)” on page
L-2).
Specify the z/OS UNIX path where
FARE is installed.
The path must start with a forward
slash, e.g. “/u/fa/busezt0/FARE/”
and should end with a forward
slash.
File-AID Configuration Facility
Table 2-6.
2-61
File-AID Data Privacy Variables (Continued)
Description
Path Name for
FARE Log
Directory
(maximum 512
bytes)
Default Value
Your Value
Comments
z/OS UNIX path name of your
site’s File-AID Rules Engine’s logs.
If the Path for the File-AID Rules
Engine Log Directory is not
specified (default), then the Path
for File-AID Rules Engine will be
suffixed with "log" and used as the
Log Directory.
The path must start with a forward
slash, and should end with a
forward slash.
Java Options
You can specify up to 10 JVM Options, up to 80 chars per option.
Opt 1 
-verbose:sizes
Opt 2
Opt 3 
Opt 4
Opt 5 
Opt 6
Opt 7 
Opt 8
Opt 9 
Opt 10
Specify the Java runtime
parameters for File-AID Data
Privacy
These Java options are the
parameters required for execution
of DPR.
Special Instructions for Oracle Translate Table
If your Data Privacy job uses Data Translation with an Oracle Translate Table, you need to
specify the following two JAVA options:
-Dfile.encoding=UTF-8
-Dlog.encoding=IBM1047
Adding these two lines will make it possible to run an Oracle translation while the log
will be generated in EBCDIC.
Review and Submit JCL
When you press END (PF3) in the “File-AID Data Privacy Parameters” screen, the “Edit
JCL Screen for Assembling Data Privacy Configuration Module XVJOPDPR” screen (Figure
2-41) displays.
2-62
File-AID Single Install Image Installation and Configuration Guide
Figure 2-41. Edit JCL Screen for Assembling Data Privacy Configuration Module XVJOPDPR
EDIT
TSOID01.CPWR.MXVJA20.WORK($XVJDPR1) - 01.00
Columns 00001 00072 
Scroll ===> PAGE 
Command ===>
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('ACCOUNT.NUMBER'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*--------------------------------------------------------------------
000007 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.

000008 //*--------------------------------------------------------------------
000009 //STEP1
EXEC PGM=ASMA90,

000010 //
PARM='NODECK,OBJECT,RENT,NOBATCH',REGION=1024K

000011 //SYSLIB
DD DSN=SYS1.MACLIB,DISP=SHR

000012 //SYSUT1
DD UNIT=SYSDA,SPACE=(TRK,(7,1),,CONTIG)

000013 //SYSUT2
DD UNIT=SYSDA,SPACE=(TRK,(7,1),,CONTIG)

000014 //SYSUT3
DD UNIT=SYSDA,SPACE=(TRK,(7,1),,CONTIG)

000015 //SYSLIN
DD DSN=&&OBJTEMP,

000016 //
UNIT=SYSDA,SPACE=(TRK,(5,1)),

000017 //
DCB=(BLKSIZE=0,LRECL=80,RECFM=FB),DISP=(NEW,PASS) 
000018 //SYSPRINT DD SYSOUT=*
000019 //SYSIN
DD *
Review the JCL and submit the job to create the Data Privacy Configuration load module
XVJOPDPR. Verify that the job completed before continuing.
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “DB2/IMS/Data Privacy Environment Menu” (Figure 2-11 on page 2-28), the
changes you made in the “File-AID Data Privacy Parameters” panel (Figure 2-40 on page
2-58) will NOT be saved.
Step 4. Configure Product Specific Components
Select option 3 from the “Configuration Facility Menu” (Figure 2-2 on page 2-4) to
display the File-AID “Product Configuration Menu” (see Figure 2-42 on page 2-62). It lists
all File-AID mainframe products.
Figure 2-42. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD


Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
9
START - Start products to verify installation 

XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE
Configuration Module Dataset containing member XVJOPUNV : Identifies the
Configuration Load Library that includes the File-AID Common Component












File-AID Configuration Facility
2-63
Configuration Module (XVJOPUNV). If the utility finds a CXVJLOAD dataset with a
hlq that matches the SXVJSAMP you are executing from AND a valid parameter
module is found, this field will be prefilled.
After you verified the dataset that contains the File-AID Common Component
Configuration Module (XVJOPUNV) to be used, enter the option number for the File-AID
product you would like to specify product specific parameters and create the customized
PARM module for the product.
When selecting an option, the “Source of Product Parameters” screen displays,
prompting you to specify the installation dataset of the previously installed product
release in order to populate product specific parameters.
After you have completed the configuration of each File-AID product, use option 9,
START to verify installation (see “Step 4.9 START” on page 2-67).
Step 4.1 Configure File-AID/MVS
Select option 1 from the “Product Configuration Menu” (Figure 2-42 on page 2-62). After
you specify the parameter source, the “File-AID/MVS Product Configuration Menu” (see
Figure 2-43 on page 2-63) displays. It lists the File-AID/MVS Product Configuration
options.
Figure 2-43. File-AID/MVS Product Configuration Menu

File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID/MVS

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 
3
CUSTOMIZE
- Generate customized objects
Continue with Chapter 3, “File-AID/MVS Product Configuration” for further details on
how to configure File-AID/MVS.
Step 4.2 Configure File-AID/Data Solutions
Select option 2 from the “Product Configuration Menu” (Figure 2-42 on page 2-62). After
you specify the parameter source, the “File-AID/Data Solutions Product Configuration
Menu” (see Figure 2-44 on page 2-64) displays. It lists the File-AID/Data Solutions
Product Configuration options.
2-64
File-AID Single Install Image Installation and Configuration Guide
Figure 2-44. File-AID/Data Solutions Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------

OPTION ===>
Product.... File-AID/Data Solutions

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.CXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Continue with Chapter 4, “File-AID/Data Solutions Product Configuration” for
further details on how to configure File-AID/Data Solutions.
Step 4.3 Configure File-AID/RDX
Select option 3 from the “Product Configuration Menu” (Figure 2-42 on page 2-62). After
you specify the parameter source, the “File-AID/RDX Product Configuration Menu” (see
Figure 2-45 on page 2-64) displays. It lists the File-AID/RDX Product Configuration
options.
Figure 2-45. File-AID/RDX Product Configuration Menu

File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID/RDX

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.CXVJLOAD


Source of DB2 Input . . . hlq.CPWR.MXVJA20.CXVJLOAD
Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD


Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Continue with Chapter 5, “File-AID/RDX Product Configuration” for further details on
how to configure File-AID/RDX.
Step 4.4 Configure File-AID for DB2
Select option 4 from the “Product Configuration Menu” (Figure 2-42 on page 2-62). After
you specify the parameter source, the “File-AID for DB2 Product Configuration Menu”
(see Figure 2-46 on page 2-65) displays. It lists the File-AID for DB2 Product Configuration
options.
File-AID Configuration Facility
2-65
Figure 2-46. File-AID for DB2 Product Configuration Menu

File-AID ------------------- Product Configuration ---------------------------
OPTION ===>

Product.... File-AID for DB2

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Source of DB2 Parms . . . hlq.CPWR.MXVJA20.CXVJLOAD

Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Option not available 
Continue with Chapter 6, “File-AID for DB2 Product Configuration” for further details
on how to configure File-AID for DB2.
Step 4.5 Configure File-AID for IMS/ISPF
Select option 5 from the “Product Configuration Menu” (Figure 2-42 on page 2-62). After
you specify the parameter source, the “File-AID for IMS/ISPF Product Configuration
Menu” (see Figure 2-47 on page 2-65) displays. It lists the File-AID for IMS/ISPF Product
Configuration options.
Figure 2-47. File-AID for IMS/ISPF Product Configuration Menu


File-AID ------------------- Product Configuration ---------------------------
OPTION ===>

Product.... File-AID for IMS/ISPF

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Continue with Chapter 7, “File-AID for IMS/ISPF Product Configuration” for further
details on how to configure File-AID for IMS/ISPF.
Step 4.6 Configure File-AID for IMS/CICS
Select option 6 from the “Product Configuration Menu” (Figure 2-42 on page 2-62). After
you specify the parameter source, the “File-AID for IMS/CICS Product Configuration
Menu” (see Figure 2-48) displays. It lists the File-AID for IMS/CICS Product Configuration
options.
2-66
File-AID Single Install Image Installation and Configuration Guide
Figure 2-48. File-AID for IMS/CICS Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID for IMS/CICS

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Continue with Chapter 8, “File-AID for IMS/CICS Product Configuration” for further
details on how to configure File-AID for IMS/CICS.
Step 4.7 Configure File-AID for IMS/DC
Select option 7 from the “Product Configuration Menu” (Figure 2-42 on page 2-62). After
you specify the parameter source, the “File-AID for IMS/DC Product Configuration
Menu” (see Figure 2-49 on page 2-66) displays. It lists the File-AID for IMS/DC Product
Configuration options.
Figure 2-49. File-AID for IMS/DC Product Configuration Menu

File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID for IMS/DC

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Continue with Chapter 9, “File-AID for IMS/DC Product Configuration” for further
details on how to configure File-AID for IMS/DC.
Step 4.8 Configure File-AID/EX Executive
Select option 8 from the “Product Configuration Menu” (Figure 2-42 on page 2-62). After
you specify the parameter source, the “File-AID/EX Executive Product Configuration
Menu” (see Figure 2-50 on page 2-67) displays. It lists the File-AID/EX Executive Product
Configuration options.
File-AID Configuration Facility
2-67
Figure 2-50. File-AID/EX Executive Product Configuration Menu

File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID/EX Executive

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Continue with Chapter 10, “File-AID/EX Enterprise Edition Product Configuration”
for further details on how to configure File-AID/EX Executive.
Step 4.9 START
After you have completed the configuration of each of your licensed File-AID products,
select Option 9 from the “Product Configuration Menu” (Figure 2-42 on page 2-62) to
display the “Start Products Menu” (see Figure 2-51 on page 2-67).
Figure 2-51. Start Products Menu
File-AID 10.02.00 ------------- Start Products -------------------------------
OPTION ===>


Select File-AID Products to Verify Installation:


1
File-AID/MVS
2
File-AID/Data Solutions

File-AID/RDX

File-AID for DB2

File-AID for IMS/ISPF

3
4
5






Enter the option number for the File-AID product you wish to verify. Refer to Chapter
11, “Verifying File-AID Installation” for suggested verification procedures.
Step 5. APF Authorize File-AID Libraries
After the configuration and customization of all your File-AID products has been
completed, the File-AID load libraries may have to be added to an APF authorized library
list.
Refer to “Authorized Library Requirements” on page 1-7 for information when APF
authorization is required.
2-68
File-AID Single Install Image Installation and Configuration Guide
3-1
Chapter 3.
File-AID/MVS Product Configuration
Chap 3
Overview
File-AID/MVS consists of two components: File-AID/MVS and File-AID/Batch.
File-AID/MVS is an interactive full-screen product designed for use by applications and
systems programmers. It provides the ability to easily access and manipulate VSAM,
BDAM, PDS, IAM, CA Panvalet, CA Librarian, and sequential files without any
programming.
File-AID/Batch consolidates the functions of most standard IBM utilities. You can use
File-AID/Batch to run jobs instead of using specialized selection programs. After
execution, File-AID/Batch can print a report that shows the number of records read and
written and the number of records processed by the various functions within
File-AID/MVS.
Configuration Prerequisites
Before continuing with the File-AID/MVS configuration you must have configured the
File-AID Common Component module XVJOPUNV (see “Step 2. Specify File-AID
Common Component Parameters” on page 2-7).
Configuration Procedures
Step 1. Select File-AID/MVS
Select option 3 from the “Configuration Facility Menu” (Figure 2-2 on page 2-4) to
display the File-AID “Product Configuration Menu” (see Figure 3-1). It lists all File-AID
mainframe products.
Figure 3-1. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD
Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
9
START - Start products to verify installation 
Select Option 1, File-AID/MVS.
XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE















3-2
File-AID Single Install Image Installation and Configuration Guide
Step 2. Specify Source of Product Parameters
When selecting Option 1, File-AID/MVS from the “Product Configuration Menu” (Figure
3-1 on page 3-1), the “Source of Product Parameters” screen displays, prompting you to
specify the installation dataset of the previously installed product release or the name of
a load library containing File-AID Configuration modules in order to populate product
specific parameters.
Figure 3-2. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):
Previous install dataset . .
OR
Configuration library . . .


Press ENTER to continue. 




1. Specify either
– the name of a File-AID/MVS install dataset prior to Release 10.1
OR
– the name of the File-AID Configuration (load) library that includes a
File-AID/MVS XVJOPXFA module you want to use as a source for your parameter
input
OR
– Leave both fields blank if this is your initial installation of File-AID.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
If you leave the Previous Install dataset as blank, it will be ignored. A valid
previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID/MVS, then
you may retain the previously specified variable values. This is accomplished by
specifying the name of the install dataset (e.g. hlq.CPWR.BG121116.INS,
hlq.CPWR.MXFA940.INS or hlq.COMPWARE.MXFA931.INSTALL)) that was
previously used to install File-AID/MVS.
When specifying an unsupported install dataset, this pop-up message displays:
File-AID/MVS Product Configuration
3-3
CANNOT IMPORT CONFIGURATION VALUES FROM

THE SPECIFIED DATASET

'TSOID01.FA.V080900.INSTALL'


DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINXFA) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters; product installation
defaults are used when previous variable values cannot be imported. You
must visit Option 2, SPECIFY PARMS (see “Step 4. Specify File-AID/MVS
Product Configuration Parameters” on page 3-4) to verify the variable
values.
Configuration library : Leave blank if you want to preserve the product installation
defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a File-AID/MVS XVJOPXFA module which you want to use as a source for your
parameter input.
If you want to use a preexisting XVJOPXFA parameter module (v10.1 or higher),
you can specify the name of the dataset that contains it. If a valid parameter
module is found, ALL values will be initialized from there. If the utility finds a
CXVJLOAD dataset with a hlq that matches the SXVJSAMP you are executing
from AND a valid parameter module is found, this field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID/MVS
Product Configuration Menu” shown in Figure 3-3 which lists the File-AID/MVS
Product Configuration options.
Figure 3-3. File-AID/MVS Product Configuration Menu

File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID/MVS

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 
3
CUSTOMIZE
- Generate customized objects
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 3-2). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
3-4
File-AID Single Install Image Installation and Configuration Guide
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARM module.
Configuration Output : Identifies the configured load library to which the
File-AID/MVS module XVJOPXFA will be saved.
The available options in the “File-AID/MVS Product Configuration Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
• CUSTOMIZE: Generate customized objects.
Select one of the available options.
Step 3. Review Target and Configuration Module Libraries
Select option 1 from the “File-AID/MVS Product Configuration Menu” to display the
“Dataset Name Specification” panel (Figure 2-6 on page 2-11). Here you review the
dataset information for the File-AID SMP/E Target Libraries that were created during the
SMP/E installation (see Chapter 2, “RFN SMP/E Installation of Compuware Mainframe
Products” or Appendix A, “SMP/E Installation Using the EP Media Interface” in the
Compuware Installer Mainframe Products SMP/E Installation Guide) and the File-AID
Configuration Module Libraries. The displayed list is the same as displayed in Figure 2-6
on page 2-11. Refer to “Step 2.1 Specify Configuration Module Dataset Names” on page
2-10 for more information.
Step 4. Specify File-AID/MVS Product Configuration Parameters
Select Option 2 from the “File-AID/MVS Product Configuration Menu” to display the
“File-AID/MVS Product Configuration Parameters” panel (Figure 3-4 on page 3-5). Option
2 allows you to specify values for variables that the Configuration Facility uses to
configure File-AID/MVS. A listing of all the variables is provided in Table 3-1 on page 3-5
through Table 3-4 on page 3-19.
The displayed parameter values reflect the values imported from the source you specified
in “Source of Product Parameters” (Figure 3-2 on page 3-2). If no source was entered,
File-AID displays the default values delivered with the product.
Edit the parameter values to configure File-AID/MVS to your site’s desired settings.
Use the HELP command (PF1) to receive information on using this screen.
After entering and reviewing the desired values, press END (PF3) to continue to the Edit
JCL screen where you can submit the job to assemble the File-AID/MVS parameter
module XVJOPXFA, or CANCEL to exit the screen without saving your changes.
File-AID/MVS Product Configuration
3-5
Figure 3-4. File-AID/MVS Product Configuration Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>


Product.... File-AID/MVS
Version.... 10.02.00
Variable
-------BATCH
RECPTDFT
FRMPTDFT
KEYPRINT
BATBUFSP
TSOBUFSP
PRNTCASE
TSOPRMPT



Value
Description

--------------------------------------------------------------------- 
More:
+ 

Record print default.
0250
(0 - 9999) Default=250 
Form print default.
1
(0=Short,1=Long) Default=1 
Key print.
0
(0=Do not print,1=Print) Default=0 
Batch buffer space. 
06
(5-99) Default=06

TSO buffer space.

06
(5-99) Default=06

Character set.

1
(0=Upper Case,1=Upper/Lower/Kana) Default=1
TSO prompting.

1
(0=No Prompt,1=Prompt) Default=1
Change any of the variable values as required for your site.
Select Option 1 to display the screen shown in Figure 3-4. Scroll through this screen to
review and update all the variables.
The variables are divided into groups. The valid groups are:
Batch:
Default values used to submit batch jobs and create datasets. Table 3-1 on page 3-5
provides a listing of these variables. Refer to the File-AID/MVS Batch Reference manual
for more information about the batch features of File-AID.
Environment 1:
Default values used to modify File-AID option. Table 3-2 on page 3-13 provides a
listing of these variables.
Environment 2:
Default values used to modify the File-AID online environment variables. Table 3-3 on
page 3-14 provides a listing of these variables.
Other Options:
Variables used to activate a restricted fix that resolves a specific issue or concern. Table
3-4 on page 3-19 provides a listing of these variables.
Table 3-1 through Table 3-4 list the variables. You may change the values of these
variables.
Table 3-1.
BATCH Product Option Variables
Variable
Name
Displace- Default
ment
Value
RECPTDFT
(old
BTOPT01)
00
0250
(F0F2F5F0)
Record print default.
(0-9999) Default=250
The number of records that File-AID prints if no
form of output control is placed on functions that
cause printing on SYSLIST. The value can be any
number from 0 through 9999. When all zeros
(F0F0F0F0) are entered, all records in the file are
printed.
FRMPTDFT
(old
BTOPT02)
04
1 (F1)
Form print default.

(0=Short,1=Long) Default=1
Controls the kind of form that is printed.
0 (F0) Short. Prints a count field only at the top and
bottom of the page.
1 (F1) Long. Prints a count field under each line.
Your Value
Comments
3-6
File-AID Single Install Image Installation and Configuration Guide
Table 3-1.
BATCH Product Option Variables (Continued)
Variable
Name
Displace- Default
ment
Value
KEYPRINT
(old
BTOPT03)
05
0 (F0)
KEY PRINT. 
(0=Do not print,1=Print) Default=0
Determines whether File-AID prints keys.
0 (F0) Do not print keys.
1 (F1) Print keys.
For datasets where the key is an integral part of the
record (keyed BDAM), the key is always printed
regardless of this setting. Printing the keys can be
changed dynamically with the KEY parameter.
BATBUFSP
(old
BTOPT04)
06
06 (F0F6)
Batch buffer space.
(5-99) Default=06
Controls the amount of memory assigned for buffer
space. The number of buffers assigned is calculated
by multiplying this option number by 10 kB, then
dividing the total by the block size of the dataset.
The minimum allowed entry is 05 (50 kB) and the
maximum is 99 (990 kB). The default for this option
is 6 which is multiplied by 10 kB = 60 kB.
Accordingly, the default for File-AID/Batch buffers is
60kB divided by the block size of the dataset.
This space is assigned to each open dataset. This
option can be overridden by coding the BUFNO
parameter in the DCB entry on DD statements.
The REGION size required at File-AID/Batch
execution time may need to be increased
depending on the value of BATBUFSP and BUFNO
coded in the JCL.
For VSAM datasets, this option times 10 kB
becomes the buffer space option. It is then used to
dynamically compute the number of buffers to
assign for VSAM processing. In the case of the USER
function where more than two datasets are open at
the same time, memory may be a problem if a
region parameter is not entered on the EXEC or JOB
card.
The minimum number of buffers File-AID allows is
five for MVS and three for non-MVS to allow
support for chained scheduling.
TSOBUFSP
(old
BTOPT05)
08
06 (F0F6)
TSO buffer space. 
(5-99) Default=06
Controls the amount of storage used for buffers by
each open dataset when File-AID is executed in a
TSO environment. The description for Batch Buffer
Space (displacement 06) also applies to this option.
PRNTCASE
(old
BTOPT07)
0B
1 (F1)
Character set.
(0=Upper Case,1=Upper/Lower/Kana) Default=1
0 (F0) Upper case only.
1 (F1) Upper case and lower case.
To change or add special characters, see the
Character Translation Table option at the end of this
table.
TSOPRMPT
(old
BTOPT08)
0C
1 (F1)
TSO prompting. 
(0=No Prompt,1=Prompt) Default=1
When executing File-AID under TSO, users can be
prompted for input or not prompted.
0 (F0) Do not prompt.
1 (F1) Prompt.
Your Value
Comments
File-AID/MVS Product Configuration
Table 3-1.
3-7
BATCH Product Option Variables (Continued)
Variable
Name
Displace- Default
ment
Value
IOERABND
(old
BTOPT09)
0D
1 (F1)
Abend control. 
(0-4) Default=1
Specifies whether File-AID is to abend if any I/O
errors occur.
0 (F0) No abends.
1 (F1) Abend if any I/O errors occur.
2 (F2) Abend for any I/O errors or any non-zero
return codes.
3 (F3) Abend when the first I/O error is
encountered.
4 (F4) Abend when the number of data checks
specified in the ERRS parameter is reached.
Values 1 and 2 do not produce a dump and
continue processing additional DDxx datasets.
Values 3 and 4 produce a dump and terminate all
processing. This option can be overridden with the
ABEND parameter.
IOERRCNT
(old
BTOPT12)
10
025 (F0F2F5)
I/O error count. 
(0-999) Default=025
Indicates the number of data checks File-AID is to
allow per volume on tape datasets before
considering the dataset unusable. Any number
from 0 (F0F0F0, which signifies unlimited errors)
through 999 (F9F9F9) can be specified. This option
can be changed with the ERRS parameter (see also
“ERRS (ERR)” on page 4-20 of the File-AID/MVS
Batch Reference manual).
UPDATOPT
(old
BTOPT13)
13
0 (F0)
Update option. 
(0-4) Default=0
Controls updating of datasets that are not
protected by your site security for the COPY, DROP,
REFORMAT, UPDATE, and USER functions. Four
settings may be entered:
0 (F0) Update any dataset.
1 (F1) Disallow updating of PDSs.
2 (F2) Disallow updating of any dataset.
3 (F3) N/A (Not applicable to File-AID batch
processing.)
4 (F4) Disallows destructive access to RECFM=U
PDSs (load libraries).
Your Value
Comments
3-8
File-AID Single Install Image Installation and Configuration Guide
Table 3-1.
Variable
Name
BATCH Product Option Variables (Continued)
Displace- Default
ment
Value
UPDACCOD 14
(old
BTOPT14)
0000
(F0F0F0F0)
Your Value
Comments
Update access code. 
(0-4095) Default=0000
Limits updates to specific groups of users. Any
number from 0 (F0F0F0F0) through 4095
(F4F0F9F5) is valid. This option is only valid if the
Update option is set to a value other than zero.
File-AID is shipped with zeros in this field, which
specifies NO access code. When a value is entered,
it is converted from the specified decimal value to
its hexadecimal equivalent. For example, if the
number 2748 (F2F7F4F8) is entered, the access
code to be entered at run time is ABC because
hex ’ABC’ is decimal 2748.
The access code is always a three-character field.
Even if the number 0001 is entered for the option
field, the access code that must be entered is still
001. This code need only be entered once and is
used to override the Update option. The CTL
parameter is available to enter the access code and
is coded as follows:
$$DDxx CTL=yyy
where yyy is the three-character access code to be
entered.
CAUTION:
This is the only place where this parameter is
referenced. When File-AID reads this control
card, it is not listed on SYSPRINT even if the
access code is wrong.
USERFUNC
(old
BTOPT17)
1C
1 (F1)
User function. 
(0=NO,1=YES) Default=1
Specifies whether the USER function will be
allowed. The value 0 (F0)indicates No; 1 (F1)
indicates Yes.
RECCPYRC
(old
BTOPT18)
1D
08 (F0F8)
No records copied return code. 
(00-99) Default=08
Specifies the return code that File-AID is to issue
when records are not selected for copying to any
output dataset in a copy operation. The value 08
reflects the current return code issued. Any number
from 00 (issue no return code) through 99 is valid.
File-AID always reflects the highest return code
issued during an execution.
MULTPASS
(old
BTOPT19)
1F
0 (F0)
Multiple file pass. 
(0=Single Pass,1=Multiple) Default=0
Indicates if more than one pass through a dataset is
to be made.
0 (F0) Single pass.
1 (F1) Multiple passes.
Normal processing does not reposition at the
beginning of a dataset for multiple functions. This
option allows those multiple passes to be made.
This option can also be changed with the FORM
parameter.
PADCHARC
(old
BTOPT20)
20
00
Pad character. 
(hexadecimal value) Default=00
Sets a default For File-AID to use to pad when the
record length changes during COPY processing.
File-AID/MVS Product Configuration
Table 3-1.
3-9
BATCH Product Option Variables (Continued)
Variable
Name
Displace- Default
ment
Value
FORCEEOV
(old
BTOPT23)
23
N (D5)
Force output end of volume. 
(Y=YES,N=NO) Default=N
Allows File-AID to force end-of-volume (EOV)
processing for the output tape dataset when the
input dataset reaches EOV. This option is only
applicable for multi-volume tape datasets. Values
are: No (D5) and Yes (E8).
This option can be overridden at execution time
with the FEOV parameter.
RDWPARM
(old
BTOPT24)
24
0 (F0)
RDW parameter explanation. 
(0-3) Default=0
Parameters can be set to the following values:
0 (F0) Include and print RDW.
1 (F1) Include and do not print the RDW.
2 (F2) Do not include and print RDW.
3 (F3) Do not include and do not print the RDW.
This option can be overridden with the RDW
parameter.
OPNERRRC
(old
BTOPT25)
25
08 (F0F8)
Open error return code. 
(00-99) Default=08
Specifies the return code that File-AID is to issue
when any type of open error occurs. Any number
from 00 (F0F0) through 99 (F9F9) is valid.
Your Value
Comments
Note: File-AID always reflects the highest return
code issued during an execution.
CEM 
(old
BTOPT26)
27
N (D5)
Copy empty members. 
(Y=YES,N=NO) Default=N
Allows the user to copy members without records.
the default is No (D5), do not copy empty
members. Change to Yes (E8) to copy empty
members.
USRFCLOS
(old
BTOPT27)
28
Y (E8)
Close output datasets after user function. 
(Y=YES,N=NO,A=Always) Default=Y
Controls the closing of output datasets after
consecutive USER functions.
E8 (Y) Close output file(s) when the $$DD changes
(for example, $$DD01, $$DD02). If a USER
function uses $$DD numbers that are identical to
the previous USER function, the output files are not
closed. This is the default setting.
D5 (N) Do not close output files after each USER
function. Close them only after the end of all
consecutive USER functions.
C1 (A) Always close output files after each USER
function.
Notes: 
1. PDS output will always be closed regardless of
the specified setting.
2. For related information, see Appendix A of the
File-AID/Batch Reference Manual. It has 2 examples
(35 and 36) which illustrate why you might choose
one option over another:
Example 35 illustrates splitting a single input
dataset into multiple outputs.
Example 36 illustrates splitting multiple input
datasets into multiple outputs.
3-10
File-AID Single Install Image Installation and Configuration Guide
Table 3-1.
BATCH Product Option Variables (Continued)
Variable
Name
Displace- Default
ment
Value
SDBPARM
(old
BTOPT28)
29
N (D5)
Support system-determined blocksize.
(Blocksize=0).
(Y,N,I) Default=N
If your operating system supports this installation
option, it allows you to have your system determine
the blocksize of new output PS and PO datasets
allocated for File-AID/Batch if the RECFM is not
undefined (=U). The following settings are valid:
Yes (E8) Enables your system to determine the
blocksize when the blocksize is not coded or
BLKSIZE=0 is coded.
I (C9) Uses the IBM process for determining
blocksize. File-AID allows the system to determine
the blocksize when BLKSIZE=0 is coded. File-AID
uses the blocksize of the input dataset when a
blocksize is not coded.
No (D5) Disables this support. File-AID uses the
blocksize of the input dataset when a blocksize is
not coded or BLKSIZE=0 is coded.
Note for option I and N: If the output blocksize is
not coded, then the output LRECL must be equal to
the input LRECL in order for File-AID to use the
blocksize of the input dataset. If the LRECLs are not
equal, then File-AID assigns the output LRECL as the
output blocksize.
Notes: 
1. File-AID ignores the setting of this Product
option unless you have IBM’s Data Facility Product
(DFP) Version 3 Release 1 or greater (for DASD),
DFP Version 3 Release 2 (for tape) or IBM’s DFSMS
installed.
2. Modifying this option may change default
allocations of existing batch jobs.
FPCPBALT
(old
BTOPT29)
2A
blank (40)
Formatted print copybook alternate library. 
(' ',L,P) Default=' '
Allows the user to specify Librarian or Panvalet
datasets for your formatted print copybook library.
blank (40) PDSs and PDSEs only.
L (D3) Librarian datasets.
P (D7) Panvalet datasets.
CTRUNCRC
(old
BTOPT30)
2B
04 (04)
Return code for record truncation. 
(00-FF) Default=04
Specifies the return code that File-AID is to issue
when records are truncated in a copy operation.
The value X'04' is default to issue RC=4. X'0C' would
issue RC=12, X'10' would issue RC=16. Any HEX
value X'00' through X'FF' is valid.
PRTRECAD
(old
BTOPT32)
2D
N (D5)
Print record information. 
(Y=YES,N=NO) Default=N
Specify No (D5), do not include record disk
addresses when printing user data files.
Change to Yes (E8) to include record disk addresses
when printing user data files.
PRDIRECT
(old
BTOPT33)
2E
F (C6)
Processing direction. 
(F=Forward,B=Backward) Default=F
Allows you to switch the processing direction. The
default is F (C6) forward. Change to B (C2) for
backwards.
Your Value
Comments
File-AID/MVS Product Configuration
Table 3-1.
3-11
BATCH Product Option Variables (Continued)
Variable
Name
Displace- Default
ment
Value
JCLFRMAT
(old
BTOPT34)
2F
N (D5)
Process in JCL format. 
(Y=YES,N=NO) Default=N
The default is No (D5), do not process in JCL
format. Change to Yes (E8) to process records in
JCL format.
This option can be overridden at execution time
with the FORM=JCL parameter.
RLM
(old
BTOPT35)
30
Y (E8)
PDS replace like members. 
(Y=YES,N=NO) Default=Y
Yes (E8), replaces like-named members in a PDS.
Change to No (D5), do not replace like-named
members.
This option can be overridden at execution time
with the RLM parameter.
ENTIRMEM
(old
BTOPT36)
31
N (D5)
Copy entire member. 
(Y=YES,N=NO) Default=N
No (D5), do not copy the entire member; copy only
the selected records. 
Change to Yes (E8) to copy the entire member
when any of the records in the member match the
selection criteria.
This option can be overridden at execution time
with the MEM parameter.
PDSSTAT
(old
BTOPT37)
32
N (D5)
Maintain PDS statistics.
(Y=YES,N=NO,A=ADD) Default=N
No (D5) Do not maintain PDS statistics.
Yes (E8) Maintain PDS statistics.
Add (C1) Maintain PDS statistics, and add when
they previously did not exist.
This option can be overridden at execution time
with the PDSSTAT parameter.
0 (00)
Unequal compare return code. 
(Hex Value 00-FF) Default=00
Specify the return code to issue when the Compare
function (File-AID option 10) finds any differences
in the data that you specify to compare from the
old to the new dataset. Valid entries are
hexadecimal values 00 through FF.
UNEQCOMP 34
(old
BTOPT39)
Your Value
Comments
Note: Compuware recommends that a non-zero
value should NOT be a multiple of 4 to
distinguish it from other usual return codes.
Depending of the perceived severity of an
unequal compare, set the value to either
03, 07, 0B (11), or 0F (15).
The options preceding this message can be modified at execution time. See “Modify Batch Options at Execution” on page 3-12. The
options following this message cannot be modified at execution time.
3-12
File-AID Single Install Image Installation and Configuration Guide
Table 3-1.
BATCH Product Option Variables (Continued)
Variable
Name
Displace- Default
ment
Value
CHXLATX1
CHXLATX2
CHXLATX3
CHXLATX4
CHXLATX5
CHXLATX6
CHXLATX7
CHXLATX8
CHXLATX9

(old
BTOPT40
BTOPT41
BTOPT42
BTOPT43
BTOPT44
BTOPT45
BTOPT46
BTOPT47
BTOPT48)
36
COMPMPTY 62
(old
BTOPT52)
Your Value
Comments
40 
(nine blanks)
Character translation table extension. 
(Hex Value) Default=40
Used for SYSLIST character translation. All 9
positions are set to blanks,
(404040404040404040). You may enter up to nine
additional special characters.
D
COMPARE return code for empty files.
(D,00,01,02,03,04,08,12,16,20,24,28,32,36,40,4
4,48,52,56) Default=D
Step return code when comparing empty files.
Default value D will give a return code of zero (00)
for read-ahead compare option, and a 04 for sorted
and 1 to 1 compare options.
When the return code is not zero you receive an
empty file error message (U325-NO RCDS WERE
SELECTED FOR COMPARE IN EITHER THE OLD OR
NEW FILES).
You can change this default to any other return
code from 00 to 04 and then by multiples of 4 up
to 56.
Valid values are: D, 00, 01, 02, 03, 04, 08, 12, 16,
20, 24, 28, 32, 36, 40, 44, 48, 52, 56.
Note: This compare return code for empty files
does not apply to multi-member PDS/PDSE
compares.
Modify Batch Options at Execution
The OPT parameter in the PARM field is used to override or change batch options with
displacements of 00 through 34. File-AID processes the option fields as one contiguous
data field, so all options to the left of the option being changed must be specified as well.
The data entered in the OPT parameter overlays the installation option area from left to
right.
Example
Change the Batch buffer space option from the default value 06 to 12.
// EXEC
PGM=XFAFAID,PARM='OPT=02501012'
Note: FILEAID is an alias of XFAFAID
File-AID/MVS Product Configuration
Table 3-2.
3-13
Environment 1 Product Option Variable
Variable Name
Default Value Your Value
Comments
FILEAID
FILEAID
PGM name of the interactive execution mode of FileAID/MVS.
Default=FILEAID
This variable reflects the program name of the
Interactive Execution mode of File-AID/MVS. If this
name conflicts with the site’s installation, rename the
module in the load library using ISPF option 3.1, and
change this variable to reflect the new name.
IOXDEF
NO
User-written I/O exit. 
(YES/NO/EXITNAME) Default=NO
This option is used in conjunction with user-written
I/O exits (see also “I/O Exit” on page A-10). Valid
entries include:
NO Do not display I/O exit fields on the File-AID
panels.
YES Display fields on the panels enabling the user to
enter the name of an I/O exit program module.
EXITNAME Display fields on the panels with a
prefilled name of an I/O exit program module.
TDSNFMT
ULIDTS
Customizes the temporary DSN's used by File-AID.
Default=ULIDTS
The variables TDSNFMT, TDSNLIT, and TDSNSFX
allow you to customize the temporary dataset name
used by File-AID.
TDSNFMT is a six-character string defining the node
sequence of the temporary dataset name. Each
character represents the contents of a node as follows:
U - Your TSO prefix, or user ID when a prefix is not set.
L - Literal, up to eight characters, defined by the
TDSNLIT variable. The default is FILEAID.
I - Two-character identifier that is assigned by File-AID
to identify the type of temporary dataset. This
character is required.
D - Date in Dyyddd (Julian) format.
T - Time in Thhmmss format.
S - Suffix, up to eight characters, defined by the
TDSNSFX variable. The defaults is blanks.
X - TSO user ID.
Note: U and X are not mutually exclusive. However,
if both are coded and no TSO prefix is
active/specified, the resulting DSN will
contain user ID twice.
You may rearrange the order of the nodes.
Note: It is possible to specify these variables so that
the temporary dataset name exceeds 44
characters. If this happens, File-AID detects it
on startup, stops, and issues the message:
MAX dataset name exceeds 44
characters.
Example:
File-AID names a compare criteria dataset created
according to the TDSNFMT variable default, ULIDTS,
as follows: userid.FILEAID.CC.Dyyddd.Thhmmss.
If you change the TDSNFMT variable to USILTD,
TDSNLIT to FA, and TDSNSFX to TEMP, File-AID names
the same compare criteria dataset:
userid.TEMP.CC.FA.Thhmmss.Dyyddd.
3-14
File-AID Single Install Image Installation and Configuration Guide
Table 3-2.
Environment 1 Product Option Variable (Continued)
Variable Name
Default Value Your Value
Comments
TDSNLIT
FILEAID
String for the literal node of a temp dataset.
Default=FILEAID
TDSNLIT specifies a string, up to eight characters, for
the LITERAL node of the temporary dataset name. See
TDSNFMT.
TDSNSFX
String for the suffix node of a temp dataset.
TDSNSFX specifies a string, up to eight characters, for
the SUFFIX node of the temporary dataset name. See
TDSNFMT.
Note: The variables in Table 3-3 “Environment 2 Product Option Variable” are used in
XVJOPXFA XVJOPXFA. FAOPTNS FAOPTNS, FILEAID FBOPTBAT and FASPF
FSOPTSPF no longer exist to modify these Product options. They have been
replaced by XVJOPXFA XVJOPXFA. For FILEAID FBOPTBAT the offsets are the
same, but the FASPF FSOPTSPF offsets are now different as shown in the comments
in Table 3-3. 
The comments in Table 3-3 “Environment 2 Product Option Variable”make
reference to alternative zaps. Apply alternative zaps only if you cannot regenerate
PARM module XVJOPXFA (see also “Step 5. Review and Submit JCL” on page
3-20).
Table 3-3.
Environment 2 Product Option Variable
Variable Name
Default Value Your Value
Comments
ABRALLC
0
ABR allocation. 
(0,1) Default=0
0 - ABR is not used.
1 - If your installation uses Innovation Data Processing,
Inc.’s Automatic Backup and Recovery (ABR) for
archival and retrieval, allocation of datasets will be
forced when an attempt to find them on a volume
fails.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
DSNMSG
0
0
F0
F1
Unexpired dataset message.
(0,1) Default=0
0 - File-AID rejects any attempt to delete an unexpired
dataset.
1 - Displays a warning message when a dataset is not
past its retention period.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
DSNRESV
84
84
80
80
F0
F1
Dataset Reserve/Enqueue.
(0=Reserve,2=Enqueue) Default=0
0 - Always do reserves.
2 - Always do enqueues. 2 is intended for sites that do
not have shared DASD or have software packages
such as MIM (Multi-Image Manager) or GRS.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
7B
7B
F0
F2
File-AID/MVS Product Configuration
Table 3-3.
3-15
Environment 2 Product Option Variable (Continued)
Variable Name
Default Value Your Value
Comments
EDITOPEN
0
Edit 1st open. 
(0,1) Default=0
0 - File-AID Edit (by default) opens datasets for
UPDATE processing when loading the dataset into
storage. This allows File-AID to inform the user of any
edit limitations at the beginning of the session. It also
may cause your installation’s security package to issue
security violation messages when you attempt to edit
read-only data.
1 - Open the DSN for input when loading into storage.
Note: The Edit 1st Open product option does not
apply to VSAM datasets.
Alternative zapa:
NAME XVJOPXFA
VER
REP
ISPFACC
0
0
XVJOPXFA
F0
F1
ISPF log dataset access. 
(0,1) Default=0
All File-AID functions may be logged to the ISPF log
dataset. When this option is enabled (1), all functions
are logged including dataset destructs. In addition,
interactive functions are logged.
0 - File-AID functions ARE NOT logged to the ISPF log
dataset.
1 - All File-AID functions are logged including dataset
destructs. In addition, interactive functions are
logged.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
PCFACC
86
86
79
79
F0
F1
PCF DATASET ACCESS.
(0,1) Default=0
Gives instructions to set a flag in the Environment
Control Table (ECT) to be compatible with Program
Control Facility (PCF) considerations.
Whenever datasets are allocated as SHR (Share) when
using File-AID/MVS to copy (output dataset only),
File-AID sets the Program Control Facility (PCF)
authorization flag to X’01’. This is in the first byte of
the ECTSCMD field of the Environment Control Table
(ECT). This ISPF flag in PCF checks authorization as
though the dataset were allocated as OLD.
The Allocate for Uncatalogs option, at location 80,
forces uncatalogs to first allocate the dataset. This
allocation maintains compatibility with PCF and allows
PCF to verify that the dataset is valid for the user to
access. This option has two settings:
0 - Do not allocate on uncatalogs
1 - Allocate before uncatalogs.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
7A
7A
F0
F1
3-16
File-AID Single Install Image Installation and Configuration Guide
Table 3-3.
Environment 2 Product Option Variable (Continued)
Variable Name
Default Value Your Value
STORAGE 
999
’Limiting Above- (F9F9F9)
the-Line
Storage’
Comments
Above-The 16Mb-Line Storage.
(0-999) Default=999
File-AID/MVS’ default setting (F9F9F9) uses your site’s
system-defined limit for above-the-line storage. This
option allows you to adjust the amount of storage that
File-AID/MVS can use. As a result, it can limit the
amount of storage that File-AID/MVS can use. To
implement this option, specify the storage limit.
If you use F0F0F0, File-AID/MVS doesn’t use any
above-the-line storage.
For example, to change the above-the-line storage
limit to 12 megabytes, enter F0F1F2.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
89
89
F9F9F9
F0F1F2
'Dataset Update' File-AID’s Dataset Update option (UPDTEOP) allows you to protect datasets from destructive access
(updating and deleting) that are not already protected by your site security. The Update Access Code
option (UPDTEAC) can be used to limit destructive access to a specific group of users who know the code.
These update options are initialized by setting the following variables.
UPDTEAC
0000
(F0F0F0F0)
Dataset update - Update access code option.
(0-4095) Default=0000
The Update Access Code limits updating to specific
groups of users who know the code. Any number from
0 (F0F0F0F0) through 4095 (F4F0F9F5) is valid. This
option is only valid if the Update option is set to a
value other than zero. File-AID is shipped with the
update access code set to four zeros. Zeros specify no
access code.
When a number is entered, it is converted to its
hexadecimal equivalent. This equivalent becomes the
access code which must be entered on the Access
Code Confirmation screen.
The access code is always a three-character field. Even
if the number 0001 is entered in this option field, the
access code that must be entered is still 001.
If destructive access protection is active for a dataset
and an access code was not established, File-AID
denies access to the dataset. If an access code was
established, the Access Code Confirmation screen is
displayed. The user must then enter an access code. If
an incorrect code is entered, access is denied. If the
correct code is entered, all further access to datasets in
that function is allowed.
These options conform to the Update and Update
Access Code options described in Table 3-1 on page
3-5.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
74
74
F0F0F0F0
FxFxFxFx
File-AID/MVS Product Configuration
Table 3-3.
3-17
Environment 2 Product Option Variable (Continued)
Variable Name
Default Value Your Value
Comments
UPDTEOP
0
Dataset update - Update option.
(0,1,2,3,4) Default=0
Five settings may be entered:
0 - Allows destructive access to any dataset format.
1 - Disallows destructive access to only PDSs.
2 - Disallows destructive access to any datasets.
3 - Allows destructive access to only those files having
the logon USERID as a high-level qualifier.
4 - Disallows destructive access to RECFM=U PDSs
(load libraries).
Alternative zapa:
NAME
VER
REP
XVJOPXFA
73
73
XVJOPXFA
F0
Fx

Set x to 1, 2, 3 or 4 (F1, F2, F3, or F4).
USEMINUS
0
Use Minus. 
(0=Not Allow,1=Allow) Default=0
The USE Minus Option allows negative relative offsets
in the USE primary command that causes the layout to
precede the actual data. Valid entries are:
0 - Do not allow access.
1 - Allow access in Browse and Edit mode.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
VSAMEXIT 
'VSAM
Allocation Exit'
0
87
87
F0
F1
VSAM allocation exit. 
(0,1,2,3) Default=0
The VSAM allocation exit is used to review VSAM
allocations before the actual allocations occur. The exit
can be invoked at two different points during the
allocation process. The following configurations are
valid:
0 - Do not invoke.
1 - The exit is called after the first allocation screen to
resolve the following VOLSER information:
VOLSER/UNIT, SPACE REQUIREMENTS CYLINDERS/TRACKS REQUESTED, RECORD SIZE, KEY
INFORMATION, etc. The exit must return with a valid
VOLSER or error.
2 - The exit is called just before the actual allocation
with all values resolved. Only an error message is
possible at this point.
3 - Exit called twice at both points as described.
The source for the exit is in member XVJVSMXT of the
sample library, CPWR.MXVJA20.SXVJSAMP. Sample
member JCLASM contains sample assemble JCL.
Sample member XFALKVSX contains the JCL to link
the module.
Alternative zapa:
NAME
VER
REP
XVJOPXFA
85
85
XVJOPXFA
F0
Fx

Set x to 1, 2, or 3 (F1, F2, or F3).
3-18
File-AID Single Install Image Installation and Configuration Guide
Table 3-3.
Environment 2 Product Option Variable (Continued)
Variable Name
Default Value Your Value
Comments
WINBROW
500
(01F4)
Windowed BROWSE threshold. 
(0-32767) Default=350
Any hex value from 0 through 7FFF (32767) tracks is
valid.
Specify the dataset size limit in number of tracks used
for File-AID to determine when to display the
windowed browse mode option. The default is 500
tracks, which is entered as hexadecimal 01F4. When a
file exceeds this threshold, File-AID displays the
Browse Method Specification screen.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
WINEDIT
350
(015E)
0
01F4
xxxx
Windowed EDIT threshold. 
(0-32767) Default=350
Any hex value from 0 through 7FFF (32767) tracks is
valid.
Specify the dataset size limit in number of tracks used
for File-AID to determine when to display the
windowed edit mode option. The default is 350
tracks, which is entered as hexadecimal 015E. When a
file exceeds this threshold, File-AID displays the Edit
Method Specification screen.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
WRKALLC
A2
A2
A4
A4
015E
xxxx
Workfile allocation:
(0,1) Default=0
Preallocating Intermediate Workfiles
Up to two File-AID intermediate workfiles can be
preallocated. This is done either with a logon PROC or
allocation CLIST. The name is user-specified and the
space can be a minimal amount. Allocate the files as:
//FILEAID1
//FILEAID2
DD
DD
DSN=anyname
DSN=anyname
These files can be allocated to VIO.
Note: Allocate files with no DCB information, only
specify space initially when allocating NEW.
Intermediate Workfile Naming:
When a non-VIO intermediate work file is allocated, a
dataset name is built that consists of
USERID.FILEAID.ID.Dyyddd.Thhmmss. See page 3-13
for a description of the TDSNFMT variable which
defines the work file name.
The two settings allowed are:
0 - When a NON-VIO intermediate work file is
allocated, a dataset name is built that consists of:
USERID.FILEAID.ID.Dyyddd.Thhmmss.
1- Allows the operating system to assign a temporary
dataset name of FILEAID.
Alternative zapa:
NAME XVJOPXFA XVJOPXFA
VER
REP
78
78
F0
F1
File-AID/MVS Product Configuration
Table 3-3.
3-19
Environment 2 Product Option Variable (Continued)
Variable Name
Default Value Your Value
Comments
REGION
08
Region size (in M) for creation of batch JCL.
(0,8-99) Default=08
Default REGION size used within generated BATCH
jobs.
a.Apply alternative zap only if you cannot regenerate module XVJOPXFA.
Table 3-4.
Other Options
Variable
Name
Default
Value
Acceptable
Values
NOAPFF31
N
Y/N
Prevent APF Change using OPT 3.1
(Y=YES,N=NO) Default=N
N - Do not apply this RESTRICTED fix
Y - Apply this fix
EXTVOLSR
N
Y/N
Extended direct VOLSER SYS*
(Y=YES,N=NO) Default=N
N - Do not apply this RESTRICTED fix
Y - Apply this fix
DDPOUND
N
Y/N
Use ##DD instead of $$DD in Batch.
(Y=YES,N=NO) Default=N
N - Do not apply this RESTRICTED fix
Y - Apply this fix
ACCUMCOM N
Y/N
Add commas to BATCH ACCUM Total.
(Y=YES,N=NO) Default=N
N - Do not apply this RESTRICTED fix
Y - Apply this fix
AUDW3390
N
Y/N
Change audit workfile UNIT to 3390.
(Y=YES,N=NO) Default=N
N - Do not apply this RESTRICTED fix
Y - Apply this fix
REUSETVS
N
Y/N
Output temporary VSAM set NOREUSE,
(Y=YES,N=NO) Default=N
N - Do not apply this RESTRICTED fix
Y - Apply this fix
IOXTPASS
N
Y/N
Ability to pass 8 CHAR of user data to IO EXIT.
(Y=YES,N=NO) Default=N
N - Do not apply this RESTRICTED fix
Y - Apply this fix
CPREPLIM
0000000
0-9999999
Limit on number of difference to report in Compare.
(0-9999999, 0=All) Default=0000000
Compare Report Limit - Set limit for maximum number of differences to report
in Formated and Unformated Batch Compare. 0 = no limit, report ALL different
records.
Comments
Criteria Exclusion Datasets (Optional)
Note: This Option is intended for future implementation. Do NOT use. Make sure that
all fields for Criteria Exclusion Datasets are BLANK.
3-20
File-AID Single Install Image Installation and Configuration Guide
VSAM Record Level Sharing (RLS) Options
Table 3-5.
VSAM Record Level Sharing (RLS) options
Variable
Name
Default
Value
Acceptable
Values
RLSPRM1
Y
Y/N
Enable VSAM RLS processing for File-AID EDIT
(Y=YES,N=NO) Default=Y
Y - Enable VSAM RLS processing for File-AID EDIT
N - Do not enable VSAM RLS processing for File-AID EDIT
RLSOPT4
N
Y/N
Enable VSAM RLS processing for File-AID BROWSE
(Y=YES,N=NO) Default=N
N - Do not enable VSAM RLS processing for File-AID BROWSE
Y - Enable VSAM RLS processing for File-AID BROWSE
If this option is set to Y user will be prompted with ability to override for an
individual dataset.
Comments
Step 5. Review and Submit JCL
After entering the desired parameter values in the “File-AID/MVS Product Configuration
Parameters” panel (Figure 3-4 on page 3-5), and pressing END (PF3), the “Edit JCL Screen
for File-AID/MVS Parameter Module XVJOPXFA” panel (Figure 3-5) displays.
Review and submit the job to create or modify File-AID/MVS Parameter Module
XVJOPXFA or CANCEL to exit the screen without saving your changes.
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Product Configuration Menu” (Figure 2-42 on page 2-62), the changes you
made in the “File-AID/MVS Product Configuration Parameters” panel (Figure 3-4 on page
3-5) will NOT be saved.
Figure 3-5. Edit JCL Screen for File-AID/MVS Parameter Module XVJOPXFA
EDIT
TSOID01.CPWR.MXVJA20.WORK($XFA01) - 01.00
Columns 00001 00072 
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*

000007 //*-------------------------------------------------------------------- 
000008 //* ASSEMBLE INSTALLATION PARAMETERS (XVJOPXFA)

000009 //*-------------------------------------------------------------------- 
000010 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.
000011 //*-------------------------------------------------------------------- 
000012 //*

000013 //TEMPOBJ EXEC PGM=IEFBR14

000014 //OBJ
DD DSN=&OBJTEMP,DISP=(,PASS),

000015 //
UNIT=SYSDA,

000016 //
SPACE=(TRK,(10,10,5)) 
000017 //ASMOPTNS EXEC PGM=ASMA90,
000018 //
PARM=('XREF(SHORT),NORLD,LC(60),CPAT(SYSL),RENT', 
000019 //
'BATCH,LANG(EN),TERM,SYSPARM(MVS),OBJ'), 
Note: If you update a product option variable after you have completed the
configuration process, always submit the JCL to save updates to the parameter
module in the File-AID load library.
File-AID/MVS Product Configuration
3-21
Step 6. Review Job Output
When you receive the job completion message, review the job output and verify that
File-AID/MVS Parameter Module XVJOPXFA has been created or updated.
Step 7. Generate Customized Objects
Select Option 3 from the “File-AID/MVS Product Configuration Menu” to display the
“File-AID/MVS Customization Tasks” panel (Figure 3-6). Option 3 provides instructions
on what to do with various defined exits.
Figure 3-6. File-AID/MVS Customization Tasks

File-AID ------------------- Customization Tasks ----------------------------
OPTION ===>

Product.... File-AID/MVS

Version.... 10.02.00


More:
+ 
For detailed instructions on File-AID/MVS exits please 
refer to the File-AID Single Install Image Installation and 
Configuration Guide.
The following members can be found in the SXVJSAMP library:
1)
Audit Exit Samples and Proc JCL
XFAAUAXA
- Assembler Sample Audit Exit
XFAAUAXC
- COBOL Sample Audit Exit
XFAAUAXP
- PLI Sample Audit Exit
XFASMFUX
- Assembler Sample SMF Exit
XFALKAUA
- JCL to Assemble/Link Assembler Exit 














Audit Exit Samples and Proc JCL
The File-AID Sample library (CPWR.MXVJA20.SXVJSAMP) provides sample audit trail
exits in Assembler, COBOL, PL/I, and provides JCL to compile and link-edit the exit, as
shown in Table 3-6. In addition, the Sample library contains a sample SMF user exit in
Assembler and the corresponding JCL. See “Audit Trail Exit” on page A-6 for more
information.
Table 3-6.
Sample Audit Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
XFAAUAXA
XFALKAUA
Assembler sample audit exit
XFAAUAXC
XFALKAUC
COBOL sample audit exit
XFAAUAXP
XFALKAUP
PL/I sample audit exit
XFASMFUX
XFALKSMF
Assembler sample SMF exit
I/O Exit Samples and Proc JCL
File-AID/Data Solutions and File-AID/MVS can share the same File-AID I/O exit.
The File-AID sample I/O exit enables you to write a callable routine to perform functions
not supported by File-AID such as: encryption, decryption, compression, and
decompression. In addition, an I/O exit routine can be written to handle all the I/O for
specified files -- including Open and Close.
I/O exit processing can be initiated by entering a module name in the I/O EXIT field on
the Browse, Edit, Copy, Search/Update, Print, or Reformat screens or by coding the
3-22
File-AID Single Install Image Installation and Configuration Guide
IOEXIT parameter for File-AID/Batch. File-AID calls the I/O exit at least five times during
a Copy function. I/O exits are not supported for the Update function. “I/O Exit” on page
A-10 lists the calls in the sequence in which they occur. “I/O Exit Function Calls” on page
A-11 describes the tasks performed by File-AID/MVS and the I/O exit for each call.
The two types of I/O exits are type 1 and type 2. A type 1 exit allows record access after
File-AID reads from a dataset and before File-AID writes to a dataset. A type 2 exit allows
nonstandard dataset access; it performs all I/O processing against the dataset. The exit
supplies File-AID/Data Solutions with a logical record upon request.
Compuware provides three sample exits. The sample exit names are XVJTYP1A and
XVJTYP2A (for Assembler) and XVJCOB1 (for COBOLII). The communications macro for
Assembler only is called XVJFAIOU. XVJTYP1A and XVJTYP2A are sample compression
and decompression exits. XVJTYP2A is a sample exit for handling all I/O requests.
Table 3-7.
Sample I/O Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
XVJTYP1A
XVJLKIOA
Assembler sample type 1 exit
XVJTYP2A
XVJLKIOA
Assembler sample type 2 exit
XVJCOB1
XVJLKIOC
COBOL sample type 1 exit
Security Exit Samples and Proc JCL
The File-AID security exit enables you to control access to datasets, including dataset
inclusion and exclusion, and processing features. The File-AID security exit is not
intended to replace any security package that is presently installed at your site.
The File-AID security exit, FASCRXIT, is called from the following points within File-AID:
• Prior to allocating each dataset for use
• Prior to opening each dataset
• Prior to processing a member.
The security exit returns an indicator and a message to File-AID. The indicator tells
File-AID to do one of the following:
• Permit the request
• Permit the request but with altered parameters
• Refuse the request.
The message is a standard default message or the message indicated by your user exit
parameter. File-AID allows exits written in COBOL, PL/I, and Assembler in compilers that
are covered by Compuware’s support policy. It is highly recommended that all exits be
written in compilers and assemblers that are currently supported by their suppliers. For
instance, Enterprise COBOL for z/OS V3R4 to V4R2 are the only COBOL compilers that
are currently supported by IBM.
Note:
The security exit should be reentrant.
The File-AID sample dataset (CPWR.MXVJA20.SXVJSAMP) provides sample security exits
in Assembler, COBOL, and PL/I, and the JCL to compile and link-edit the exit, as shown
in Table 3-8.
Table 3-8.
Sample Security Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
XFASXASM
XFALKSXA
Assembler security exit
XFASXCOB
XFALKSXC
COBOL security exit
XFASXPLI
XFALKSXP
PL/I security exit
File-AID/MVS Product Configuration
3-23
Additional instructions on modifying the File-AID security exit are included in the exit
source members (XFASXASM, XFASXCOB, XFASXPLI) for the FASCRXIT security exit.
Note:
The security exit must be named FASCRXIT.
Refer to “File-AID Security Exit” on page A-1 for more information on Security Exits.
What’s Next?
After you have completed the configuration of File-AID/MVS, press END until you return
to the “Product Configuration Menu” (Figure 3-1 on page 3-1).
Either
• select the next File-AID product to configure from the “Product Configuration
Menu” (Figure 3-1 on page 3-1).
Or
• continue with “Step 4.9 START” on page 2-67 to start File-AID/MVS and verify the
product installation. Refer to Chapter 11, “Verifying File-AID Installation” for
suggested verification procedures.
3-24
File-AID Single Install Image Installation and Configuration Guide
4-1
Chapter 4.
File-AID/Data Solutions Product Configuration
Chap 4
Overview
File-AID/Data Solutions is an interactive software product that allows you to use
automated and repeatable processes to update information in your data files. It provides
functions for converting euro currencies, aging dates for testing, encrypting sensitive
data, translating data values, and generating test data.
File-AID/Data Solutions’ date analysis feature simplifies the identification of date fields.
Its formatted field exits enable you to create consistent and reliable test data for a variety
of business functions. The data analysis field exit analyzes the data in a field and reports
whether the data is valid or invalid.
Configuration Prerequisites
Before continuing with the File-AID/Data Solutions configuration you must have
configured the File-AID Common Component module XVJOPUNV (see “Step 2. Specify
File-AID Common Component Parameters” on page 2-7). If your site also uses the
File-AID Data Privacy plugin of the Compuware Workbench, you must have also
configured the Data Privacy module XVJOPDPR (see “Step 3.3. Specify File-AID Data
Privacy (Option 3)” on page 2-55).
Configuration Procedures
Step 1. Select File-AID/Data Solutions
Select option 3 from the “Configuration Facility Menu” (Figure 2-2 on page 2-4) to
display the File-AID “Product Configuration Menu” (see Figure 4-1). It lists all File-AID
mainframe products.
4-2
File-AID Single Install Image Installation and Configuration Guide
Figure 4-1. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD














Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
9
START - Start products to verify installation 

XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE
Select Option 2, File-AID/Data Solutions.
Step 2. Specify Source of Product Parameters
When selecting Option 2 File-AID/Data Solutions from the “Product Configuration
Menu” (Figure 4-1 on page 4-2) the “Source of Product Parameters” screen displays,
prompting you to specify the installation dataset of the previously installed product
release or the name of a load library containing File-AID Configuration modules in order
to populate product specific parameters.
Figure 4-2. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):
Previous install dataset . .
OR
Configuration library . . .
Press ENTER to continue. 
1. Specify either
– the name of a File-AID/Data Solutions install dataset prior to Release 10.1
OR






File-AID/Data Solutions Product Configuration
4-3
– the name of the File-AID Configuration (load) library that includes a
File-AID/Data Solutions XVJOPUDA module you want to use as a source for your
parameter input
OR
– Leave both fields blank if this is your initial installation of File-AID.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
If you leave the Previous Install dataset as blank, it will be ignored. A valid
previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID/Data
Solutions, then you may retain the previously specified variable values. This is
accomplished by specifying the name of the install dataset (e.g.
hlq.CPWR.MUDA440.INS or COMPWARE.MUDA440.INSTALL) that was
previously used to install File-AID/Data Solutions.
When specifying an unsupported install dataset, this pop-up message displays:
CANNOT IMPORT CONFIGURATION VALUES FROM

THE SPECIFIED DATASET

'TSOID01.DS.V040000.INSTALL'


DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINUDA) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters; product installation
defaults are used when previous variable values cannot be imported. You
must visit Option 2, SPECIFY PARMS (see “Step 4. Specify File-AID/Data
Solutions Product Configuration Parameters” on page 4-5) to verify the
variable values.
Configuration library : Leave blank if you want to preserve the product installation
defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a File-AID/Data Solutions XVJOPUDA module which you want to use as a source
for your parameter input.
If you want to use a preexisting XVJOPUDA parameter module (v10.1 or higher),
you can specify the name of the dataset that contains it. If a valid parameter
module is found, ALL values will be initialized from there. If the utility finds a
CXVJLOAD dataset with a hlq that matches the SXVJSAMP you are executing
from AND a valid parameter module is found, this field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID/Data
Solutions Product Configuration Menu” shown in Figure 4-3 on page 4-4 which lists
the File-AID/Data Solutions Product Configuration options.
4-4
File-AID Single Install Image Installation and Configuration Guide
Figure 4-3. File-AID/Data Solutions Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------

OPTION ===>
Product.... File-AID/Data Solutions

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.CXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 4-2). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARM module.
Configuration Output : Identifies the configured load library to which the
File-AID/Data Solutions module XVJOPUDA will be saved.
The available options in the “File-AID/Data Solutions Product Configuration Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
• CUSTOMIZE: Generate customized objects.
Select one of the available options.
Step 3. Review Target and Configuration Module Libraries
Select option 1 from the “File-AID/Data Solutions Product Configuration Menu” to
display the “Dataset Name Specification” panel (Figure 2-6 on page 2-11). Here you
review the dataset information for the File-AID SMP/E Target Libraries that were created
during the SMP/E installation (see Chapter 2, “RFN SMP/E Installation of Compuware
Mainframe Products” or Appendix A, “SMP/E Installation Using the EP Media Interface”
in the Compuware Installer Mainframe Products SMP/E Installation Guide) and the File-AID
Configuration Module Libraries. The displayed list is the same as displayed in Figure 2-6
on page 2-11. Refer to “Step 2.1 Specify Configuration Module Dataset Names” on page
2-10 for more information.
File-AID/Data Solutions Product Configuration
4-5
Step 4. Specify File-AID/Data Solutions Product Configuration
Parameters
Select Option 2 from the “File-AID/Data Solutions Product Configuration Menu” to
display the “File-AID/Data Solutions Product Configuration Parameters” panel (Figure 44). Option 2 allows you to specify values for variables that the Configuration Facility uses
to configure File-AID/Data Solutions. A listing of all the variables is provided in Table 4-1
through Table 4-4.
The displayed parameter values reflect the values imported from the source you specified
in “Source of Product Parameters” (Figure 4-2 on page 4-2). If no source was entered,
File-AID displays the default values delivered with the product.
Edit the parameter values to configure File-AID/Data Solutions to your site’s desired
settings.
Use the HELP command (PF1) to receive information on using this screen.
After entering and reviewing the desired values, press END (PF3) to continue to the Edit
JCL screen where you can submit the job to assemble and link edit the File-AID/Data
Solutions parameter module XVJOPUDA, or CANCEL to exit the screen without saving
your changes and return to the “File-AID/Data Solutions Product Configuration Menu”.
Figure 4-4. File-AID/Data Solutions Product Configuration Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>

Product.... File-AID/Data Solutions
Version.... 10.02.00
Variable
-------BATCH
RECPTDFT
FRMPTDFT
KEYPRINT
BATBUFSP
TSOBUFSP
PRNTCASE
TSOPRMPT




Value
Description

--------------------------------------------------------------------- 
More:
+ 

Record print default.
0250
(0 - 9999) Default=0250 
Form print default.
1
(0=Short,1=Long) Default=1

Key print.
0
(0=Do not print,1=Print) Default=0 
06
Batch buffer space.

(5-99) Default=06

06
TSO buffer space.

(5-99) Default=06

1
Character set.

(0=Upper Case,1=Upper/Lower/Kana) Default=1
1
TSO prompting.

(0=No Prompt,1=Prompt) Default=1
Change any of the variable values as required for your site.
Table 4-1 through Table 4-4 list the variables. A value is required for all variables, unless
stated otherwise in the comments column.
The variables are divided into groups. The valid groups are:
Batch:
Default values used to submit batch jobs and create datasets. Table 4-1 on page 4-6
provides a listing of these variables. Refer to the File-AID/MVS Batch Reference manual
for more information about the batch features of File-AID.
Environment 1:
Default values used to modify File-AID option. Table 4-2 on page 4-11 provides a
listing of these variables.
Environment 2:
Default values used to modify the File-AID online environment variables. Table 4-3 on
page 4-13 provides a listing of these variables.
Environment 3:
Variables used to activate a restricted fix that resolves a specific issue or concern. Table
4-4 on page 4-17 provides a listing of these variables.
4-6
File-AID Single Install Image Installation and Configuration Guide
Table 4-1.
BATCH Product Option Variables
Variable
Name
Displacement
Default Value Your Value
Comments
RECPTDFT
(old
BTOPT01)
00
0250
(F0F2F5F0)
Record print default. 
(0-9999) Default=0250
The number of records that File-AID/Data
Solutions prints if no form of output control is
placed on functions that cause printing on
SYSLIST. The value can be any number from 0
through 9999. When all zeros (F0F0F0F0) are
entered, all records in the file are printed.
FRMPTDFT
(old
BTOPT02)
04
1 (F1)
Form print default. 
(0=Short,1=Long) Default=1
Controls the kind of form that is printed.
0 (F0) Short. Prints a count field only at the
top and bottom of the page.
1 (F1) Long. Prints a count field under each
line.
KEYPRINT
(old
BTOPT03)
05
0 (F0)
Key print. 
(0=Do not print,1=Print) Default=0
Determines whether File-AID/Data Solutions
prints keys.
0 (F0) Do not print keys.
1 (F1) Print keys.
For datasets where the key is an integral part of
the record (keyed BDAM), the key is always
printed regardless of this setting. Printing the
keys can be changed dynamically with the KEY
parameter.
File-AID/Data Solutions Product Configuration
4-7
Table 4-1.
BATCH Product Option Variables (Continued)
Variable
Name
Displacement
Default Value Your Value
Comments
BATBUFSP
(old
BTOPT04)
06
06 (F0F6)
Batch buffer space. 
(5-99) Default=06
Controls the amount of memory assigned for
buffer space. The number of buffers assigned is
calculated by multiplying this option number
by 10 KB, then dividing the total by the block
size of the dataset.
The minimum allowed entry is 05 (50 KB) and
the maximum is 99 (990 KB). The default for
this option is 6 which is multiplied by 10 KB =
60 KB. Accordingly, the default for
File-AID/Data Solutions Batch buffers is 60kB
divided by the block size of the dataset.
This space is assigned to each open dataset.
This option can be overridden by coding the
BUFNO parameter in the DCB entry on DD
statements.
The REGION size required at File-AID/Data
Solutions execution time may need to be
increased depending on the value of
BATBUFSP and BUFNO coded in the JCL.
For VSAM datasets, this option times 10 KB
becomes the buffer space option. It is then
used to dynamically compute the number of
buffers to assign for VSAM processing. In the
case of the USER function where more than
two datasets are open at the same time,
memory may be a problem if a region
parameter is not entered on the EXEC or JOB
card.
The minimum number of buffers File-AID/Data
Solutions allows is five for MVS and three for
non-MVS to allow support for chained
scheduling.
TSOBUFSP
(old
BTOPT05)
08
06 (F0F6)
TSO buffer space. 
(5-99) Default=06
Controls the amount of storage used for
buffers by each open dataset when
File-AID/Data Solutions is executed in a TSO
environment. The description for Batch Buffer
Space (displacement 06) also applies to this
option.
PRNTCASE  0B
(old
BTOPT07)
1 (F1)
Character set.
(0=Upper Case,1=Upper/Lower/Kana)
Default=1
0 (F0) Upper case only.
1 (F1) Upper case and lower case.
To change or add special characters, see the
Character Translation Table option at the end
of this table.
TSOPRMPT
(old
BTOPT08
1 (F1)
TSO prompting. 
(0=No Prompt,1=Prompt) Default=1
When executing File-AID/Data Solutions under
TSO, users can be prompted for input or not
prompted.
0 (F0) Do not prompt.
1 (F1) Prompt.
0C
4-8
File-AID Single Install Image Installation and Configuration Guide
Table 4-1.
BATCH Product Option Variables (Continued)
Variable
Name
Displacement
Default Value Your Value
Comments
0D
1 (F1)
Abend control. 
(0-4) Default=1
Specifies whether File-AID/Data Solutions is to
abend if any I/O errors occur.
0 (F0) No abends.
1 (F1) Abend if any I/O errors occur.
2 (F2) Abend for any I/O errors or any nonzero return codes.
3 (F3) Abend when the first I/O error is
encountered.
4 (F4) Abend when the number of data
checks specified in the ERRS parameter is
reached.
Values 1 and 2 do not produce a dump and
continue processing additional DDxx datasets.
Values 3 and 4 produce a dump and terminate
all processing. This option can be overridden
with the ABEND parameter.
N
Use ##DD instead of $$DD in Batch.
(Y=YES,N=NO) Default=N
N - Do not use ##DD instead of $$DD.
Y - use ##DD instead of $$DD.
IOERABND
(old
BTOPT09)
DDPOUND

(old FIX05)
IOERRCNT
(old
BTOPT12)
10
025 (F0F2F5)
I/O error count. 
(0-999) Default=025
Indicates the number of data checks
File-AID/Data Solutions is to allow per volume
on tape datasets before considering the
dataset unusable. Any number from 0 (F0F0F0,
which signifies unlimited errors) through 999
(F9F9F9) can be specified. This option can be
changed with the ERRS parameter (see also
“ERRS (ERR)” on page 4-20 of the File-AID/MVS
Batch Reference manual).
UPDATOPT
(old
BTOPT13)
13
0 (F0)
Update option. 
(0-4) Default=0
Controls updating of datasets that are not
protected by your site security for the COPY,
DROP, REFORMAT, UPDATE, and USER
functions. Four settings may be entered:
0 (F0) Update any dataset.
1 (F1) Disallow updating of PDSs.
2 (F2) Disallow updating of any dataset.
3 (F3) N/A (Not applicable to File-AID/Data
Solutions batch processing.)
4 (F4) Disallows destructive access to
RECFM=U PDSs (load libraries).
File-AID/Data Solutions Product Configuration
Table 4-1.
BATCH Product Option Variables (Continued)
Variable
Name
Displacement
UPDACCOD 14
(old
BTOPT14)
4-9
Default Value Your Value
Comments
0000
(F0F0F0F0)
Update access code. 
(0-4095) Default=0000
Limits updates to specific groups of users. Any
number from 0 (F0F0F0F0) through 4095
(F4F0F9F5) is valid. This option is only valid if
the Update option is set to a value other than
zero. File-AID/Data Solutions is shipped with
zeros in this field, which specifies NO access
code. When a value is entered, it is converted
from the specified decimal value to its
hexadecimal equivalent. For example, if the
number 2748 (F2F7F4F8) is entered, the
access code to be entered at run time is ABC
because hex 'ABC' is decimal 2748.
The access code is always a three-character
field. Even if the number 0001 is entered for
the option field, the access code that must be
entered is still 001. This code need only be
entered once and is used to override the
Update option. The CTL parameter is available
to enter the access code and is coded as
follows:
$$DDxx CTL=yyy
where yyy is the three-character access code to
be entered.
CAUTION:
This is the only place where this
parameter is referenced. When
File-AID/Data Solutions reads this control
card, it is not listed on SYSPRINT even if
the access code is wrong.
08 (F0F8)
No records copied return code. 
(00-99) Default=08
Specifies the return code that File-AID/Data
Solutions is to issue when records are not
selected for copying to any output dataset in a
copy operation. The value 08 reflects the
current return code issued. Any number from
00 (issue no return code) through 99 is valid.
File-AID/Data Solutions always reflects the
highest return code issued during an
execution.
PADCHARC 20
(old
BTOPT18)
00
(00)
Pad character.
(hex Value) Default=00
Sets a default for File-AID/Data Solutions to use
to pad when the record length changes during
COPY processing.
FORCEEOV
(old
BTOPT21)
N (D5)
Force output end of volume. 
(Y=YES,N=NO) Default=N
Allows File-AID/Data Solutions to force end-ofvolume (EOV) processing for the output tape
dataset when the input dataset reaches EOV.
This option is only applicable for multi-volume
tape datasets. Values are: No (D5) and Yes
(E8).
RECCPYRC
(old
BTOPT17)
1D
23
Note: This option can be overridden at
execution time with the FEOV
parameter.
4-10
File-AID Single Install Image Installation and Configuration Guide
Table 4-1.
BATCH Product Option Variables (Continued)
Variable
Name
Displacement
Default Value Your Value
Comments
25
08 (F0F8)
Open error return code. 
(00-99) Default=08
Specifies the return code that File-AID/Data
Solutions is to issue when any type of open
error occurs. Any number from 00 (F0F0)
through 99 (F9F9) is valid.
OPNERRRC
(old
BTOPT22)
Note: File-AID/Data Solutions always reflects
the highest return code issued during
an execution.
SDBPARM
(old
BTOPT23)
29
N (D5)
Support system-determined blocksize
(BLOCKSIZE=0). 
(Y=YES,N=NO,I=IBM) Default=N
If your operating system supports this
installation option, it allows you to have your
system determine the blocksize of new output
PS and PO datasets allocated for File-AID/Data
Solutions if the RECFM is not undefined (=U).
No disables this support. 
Change to Yes (E8) to enable this support.
Note: File-AID/Data Solutions ignores the
setting of this install option unless you
have IBM’s Data Facility Product (DFP)
Version 3 Release 1 or greater (for
DASD), DFP Version 3 Release 2 (for
tape) or IBM’s DFSMS installed.
RLM
(old
BTOPT24)
30
Y (E8)
PDS Replace Like Members. 
(Y=YES,N=NO) Default=Y
The default is Yes (E8), replaces like-named
members in a PDS. Change to No (D5), do not
replace like-named members.
Note: This option can be overridden at
execution time with the RLM
parameter.
PDSSTAT
(old
BTOPT25)
32
N (D5)
Maintain PDS statistics.
(Y=YES,N=NO,A=ADD) Default=N
No (D5) Do not maintain PDS statistics.
Yes (E8) Maintain PDS statistics.
Add (C1) Maintain PDS statistics, and add
when they previously did not exist.
Note: This option can be overridden at
execution time with the PDSSTAT
parameter.
The options preceding this message can be modified at execution time. See “Modify Batch Options at Execution” on page
4-11. The options following this message cannot be modified at execution time.
File-AID/Data Solutions Product Configuration
4-11
Table 4-1.
BATCH Product Option Variables (Continued)
Variable
Name
Displacement
Default Value Your Value
Comments
36
nine blanks
(40)
Character translation table extension. 
(Hex Value) Default=40
Used for SYSLIST character translation. All 9
positions are set to blanks,
(404040404040404040). You may enter up to
nine additional special characters.
CHXLATX1
CHXLATX2
CHXLATX3
CHXLATX4
CHXLATX5
CHXLATX6
CHXLATX7
CHXLATX8
CHXLATX9
(old
BTOPT26
BTOPT27
BTOPT28
BTOPT29
BTOPT30
BTOPT31
BTOPT32
BTOPT33
BTOPT34
Modify Batch Options at Execution
The OPT parameter in the PARM field is used to override or change batch options with
displacements of 00 through 34. File-AID/Data Solutions processes the option fields as
one contiguous data field, so all options to the left of the option being changed must be
specified as well. The data entered in the OPT parameter overlays the installation option
area from left to right.
Example
Change the Batch buffer space option from the default value 06 to 12.
// EXEC
Table 4-2.
PGM=UDASOLUT,PARM=’OPT=02501012’
Environment 1 Product Option Variables
Variable Name
Default Value
DPRACT
Y
Your Value
Comments
File-AID Data Privacy activated. 
(Y=YES,N=NO) Default=Y
File-AID Data Privacy is a plugin of the Compuware
Workbench.
No Do not activate the File-AID Data Privacy
interface.
Yes Activate the File-AID Data Privacy interface.
You must have also created the Data Privacy
Module XVJOPDPR (see “Step 3.3. Specify File-AID
Data Privacy (Option 3)” on page 2-55) in order to
activate the connection to File-AID Data Privacy.
Note: File-AID Data Privacy is ordered and
installed separately from File-AID/Data
Solutions.
DASOLUTN
DASOLUTN
PGM name of the interactive execution mode of
FA/DA.
Default=DASOLUTN
This variable reflects the program name of the
Interactive Execution mode of File-AID/Data
Solutions. If this name conflicts with the site’s
installation, rename the module in the load library
using ISPF option 3.1, and change this variable to
reflect the new name.
4-12
File-AID Single Install Image Installation and Configuration Guide
Table 4-2.
Environment 1 Product Option Variables (Continued)
Variable Name
Default Value
Your Value
Comments
IOXDEF
NO
User-written I/O exit.
(YES,NO,EXITNAME) Default=NO
This option is used in conjunction with userwritten I/O exits (see also “I/O Exit” on page B-4).
Valid entries include:
NO Do not display I/O exit fields on the
File-AID/Data Solutions panels.
YES Display fields on the panels enabling the
user to enter the name of an I/O exit program
module.
EXITNAME Display fields on the panels with a
prefilled name of an I/O exit program module.
TDSNFMT
ULIDTS
Customizes the temporary DSN's used by FA/DA.
Default=ULIDTS
The variables TDSNFMT, TDSNLIT, and TDSNSFX
allow you to customize the temporary dataset
name used by File-AID/Data Solutions.
TDSNFMT is a six-character string defining the
node sequence of the temporary dataset name.
Each character represents the contents of a node
as follows:
U Your TSO prefix, or user ID when a prefix is not
set.
L Literal, up to eight characters, defined by the
TDSNLIT variable. The default is DATAAGER.
I Two-character identifier that is assigned by
File-AID/Data Solutions to identify the type of
temporary dataset. This character is required.
D Date in Dyyddd (Julian) format.
T Time in Thhmmss format.
S Suffix, up to eight characters, defined by the
TDSNSFX variable. The defaults is blanks.
X TSO user ID.
Note: U and X are not mutually exclusive.
However, if both are coded and no TSO
prefix is active/specified, the resulting
DSN will contain user ID twice.
You may rearrange the order of the nodes. A
maximum of eight characters may be specified.
See TDSNLIT and TDSNSFX.
Note: It is possible to specify these variables so
that the temporary dataset name exceeds
44 characters. If this happens,
File-AID/Data Solutions detects it on
startup, stops, and issues the message:
MAX dataset name exceeds 44
characters.
Example:
File-AID/Data Solutions names a compare criteria
dataset created according to the TDSNFMT
variable default, ULIDTS, as follows:
userid.DATAAGER.CC.Dyyddd.Thhmmss.
If you change the TDSNFMT variable to USILTD,
TDSNLIT to FA, and TDSNSFX to TEMP,
File-AID/Data Solutions names the same compare
criteria dataset:
userid.TEMP.CC.FA.Thhmmss.Dyyddd.
File-AID/Data Solutions Product Configuration
Table 4-2.
Environment 1 Product Option Variables (Continued)
Variable Name
Default Value
TDSNLIT
DASOLUTN
Your Value
Comments
Specify a string for the literal node of a temp DSN.
Default=DASOLUTN
TDSNLIT specifies a string, up to eight characters,
for the LITERAL node of the temporary dataset
name. See TDSNFMT.
TDSNSFX
Table 4-3.
4-13
Specify a string for the suffix node of a temp DSN.
TDSNSFX specifies a string, up to eight
characters, for the SUFFIX node of the temporary
dataset name. See TDSNFMT.
Environment 2 Product Option Variables
Variable Name
Default Value
Your Value
Comments
ABRALLC
0
ABR allocation. 
(0,1) Default=0
0 - ABR is not used.
1 - If your installation uses Innovation Data
Processing, Inc.’s Automatic Backup and Recovery
(ABR) for archival and retrieval, allocation of
datasets will be forced when an attempt to find
them on a volume fails.
DSNMSG
0
Unexpired dataset message. 
(0,1) Default=0
0 - File-AID rejects any attempt to delete an
unexpired dataset.
1 - Displays a warning message when a dataset is
not past its retention period.
DSNRESV
0
Dataset Reserve/Enqueue. 
(0=Reserve,2=Enqueue) Default=0
0 - Always do reserves.
2 - Always do enqueues. 2 is intended for sites that
do not have shared DASD or have software
packages such as MIM (Multi-Image Manager) or
GRS.
ISPFACC
0
ISPF log dataset access. 
(0,1) Default=0
All File-AID/Data Solutions functions may be
logged to the ISPF log dataset. When this option is
enabled (1), all functions are logged including
dataset destructs. In addition, interactive functions
are logged.
0 - File-AID/Data Solutions functions ARE NOT
logged to the ISPF log dataset.
1 - all File-AID/Data Solutions functions are logged
including dataset destructs. In addition,
interactive functions are logged.
4-14
File-AID Single Install Image Installation and Configuration Guide
Table 4-3.
Environment 2 Product Option Variables (Continued)
Variable Name
Default Value
Your Value
Comments
PCFACC
0
PCF dataset access. 
(0,1) Default=0
Gives instructions to set a flag in the Environment
Control Table (ECT) to be compatible with
Program Control Facility (PCF) considerations.
Whenever datasets are allocated as SHR (Share)
when using File-AID/Data Solutions to copy
(output dataset only), File-AID sets the Program
Control Facility (PCF) authorization flag to X’01’.
This is in the first byte of the ECTSCMD field of the
Environment Control Table (ECT). This ISPF flag in
PCF checks authorization as though the dataset
were allocated as OLD.
The Allocate for Uncatalogs option, at location 80,
forces uncatalogs to first allocate the dataset. This
allocation maintains compatibility with PCF and
allows PCF to verify that the dataset is valid for the
user to access. This option has two settings:
0 - Do not allocate on uncatalogs
1 - Allocate before uncatalogs.
STORAGE
999 (F9F9F9)
Above-the-16Mb-Line Storage.
(0-999) Default=999
File-AID/Data Solutions’ default setting (999) uses
your site’s system-defined limit for above-the-line
storage. This option allows you to adjust the
amount of storage that File-AID/Data Solutions
can use. As a result, it can limit the amount of
storage that File-AID/Data Solutions can use. To
implement this option, specify the storage limit.
If you use F0F0F0, File-AID/Data Solutions doesn’t
use any above-the-line storage.
For example, to change the above-the-line storage
limit to 12 megabytes, enter F0F1F2.
TRIM
N
Trim trailing blanks before hashing. 
(Y=YES,N=NO) Default=N
Specify if you want trailing blanks removed when
applying disguise criteria that uses data
translation, before calculating the hash value.
When TRIM is set to Yes the trailing blanks are
removed, and the data is reduced to its non-blank
part before hashing. This allows fields of unequal
length to hash to the same value. When TRIM is
set to No, fields of unequal length will not hash to
the same value because the trailing blanks are
considered part of the data.
Note: If there are existing Data Disguise jobs
using data translation that you execute
regularly and the data contains trailing
blanks, then setting the TRIM option to
Yes could produce different results, as
different replacement data could be
selected for the output files.
’Dataset Update’ File-AID/Data Solutions’s Dataset Update option (UPDTEOP) allows you to protect datasets from
destructive access (updating and deleting) that are not already protected by your site security. The Update
Access Code option (UPDTEAC) can be used to limit destructive access to a specific group of users who
know the code. These update options are initialized by setting the variables UPDTEAC and UPDTEOP.
File-AID/Data Solutions Product Configuration
Table 4-3.
4-15
Environment 2 Product Option Variables (Continued)
Variable Name
Default Value
Your Value
Comments
UPDTEAC
0000
(F0F0F0F0)
Dataset update - Update Access Code Option. 
(0-0495) Default=0000
The Update Access Code limits updating to
specific groups of users who know the code. Any
number from 0 (F0F0F0F0) through 4095
(F4F0F9F5) is valid. This option is only valid if the
Update option is set to a value other than zero.
File-AID/Data Solutions is shipped with the update
access code set to four zeros. Zeros specify no
access code.
When a number is entered, it is converted to its
hexadecimal equivalent. This equivalent becomes
the access code which must be entered on the
Access Code Confirmation screen.
The access code is always a three-character field.
Even if the number 0001 is entered in this option
field, the access code that must be entered is still
001.
If destructive access protection is active for a
dataset and an access code was not established,
File-AID/Data Solutions denies access to the
dataset. If an access code was established, the
Access Code Confirmation screen is displayed. The
user must then enter an access code. If an
incorrect code is entered, access is denied. If the
correct code is entered, all further access to
datasets in that function is allowed.
These options conform to the Update and Update
Access Code options described in Table 4-1 on
page 4-6.
UPDTEOP
0
Dataset update - Update Option. 
(0,1,2,3,4) Default=0
Five settings may be entered:
0 - Allows destructive access to any dataset
format.
1 - Disallows destructive access to only PDSs.
2 - Disallows destructive access to any datasets.
3 - Allows destructive access to only those files
having the logon USERID as a high-level qualifier.
4 - Disallows destructive access to RECFM=U PDSs
(load libraries).
4-16
File-AID Single Install Image Installation and Configuration Guide
Table 4-3.
Environment 2 Product Option Variables (Continued)
Variable Name
Default Value
Your Value
Comments
VSAMEXIT
'VSAM
Allocation Exit'
0
VSAM allocation exit. 
(0,1,2,3) Default=0
The VSAM allocation exit is used to review VSAM
allocations before the actual allocations occur. The
exit can be invoked at two different points during
the allocation process. The following
configurations are valid:
0 - Do not invoke.
1 - The exit is called after the first allocation screen
to resolve the following VOLSER information:
VOLSER/UNIT, SPACE REQUIREMENTS CYLINDERS/TRACKS REQUESTED, RECORD SIZE,
KEY INFORMATION, etc. The exit must return with
a valid VOLSER or error.
2 - The exit is called just before the actual
allocation with all values resolved. Only an error
message is possible at this point.
3 - Exit called twice at both points as described.
The source for the exit is in member XVJVSMXT of
the sample library, CPWR.MXVJA20.SXVJSAMP.
Sample member JCLASM contains sample
assemble JCL. Sample member UDALKVSX
contains the JCL to link the module.
WRKALLC
0
Workfile allocation.
(0,1) Default=0
Preallocating Intermediate Workfiles
Up to two File-AID/Data Solutions intermediate
workfiles can be preallocated. This is done either
with a logon PROC or allocation CLIST. The name
is user-specified and the space can be a minimal
amount. Allocate the files as:
//FILEAID1
//FILEAID2
DD
DD
DSN=anyname
DSN=anyname
These files can be allocated to VIO.
Intermediate Workfile Naming
When a non-VIO intermediate work file is
allocated, a dataset name is built that consists of
USERID.DATASOL.ID.Dyyddd.Thhmmss. See page
4-12 for a description of the TDSNFMT variable
which defines the work file name.
The two settings allowed are:
0 - When a NON-VIO intermediate work file is
allocated, a dataset name is built that consists of:
USERID.DATASOL.ID.Dyyddd.Thhmmss.
1- allows the operating system to assign a
temporary dataset name of DASOLUTN.
REGION
08
Region size (in M) for creation of batch JCL.
(0,8-99) Default=08
Default REGION size used within generated
BATCH jobs.
File-AID/Data Solutions Product Configuration
Table 4-4.
Environment 3 Product Option Variables
Variable
Name
Default
Value
Acceptable
Values
KEYENCRY
N
Y/N
Allow update in place key ENCRYPT.
(Y=YES,N=NO) Default=N
N - Do not allow update in place key ENCRYPT.
Y - Allow update in place key ENCRYPT.
ALIGN890
N
Y/N
Use FA890 PL/I alignment compiler.
(Y=YES,N=NO) Default=N
N - Do not use FA890 PL/I alignment compiler.
Y - Use FA890 PL/I alignment compiler.
AUDW3390 N

Y/N
Change AUDIT workfile UNIT to 3390.
(Y=YES,N=NO) Default=N
N - Do not change AUDIT workfile UNIT to 3390.
Y - Change AUDIT workfile UNIT to 3390.
REUSETVS
N
Y/N
Output temporary VSAM set NOREUSE.
(Y=YES,N=NO) Default=N
N - Do not output temporary VSAM set NOREUSE.
Y - Output temporary VSAM set NOREUSE.
IOXTPASS

N
Y/N
Ability to pass 8 CHAR to I/O EXIT.
(Y=YES,N=NO) Default=N
N - Do not provide ability to pass 8 CHAR of user data to I/O EXIT.
Y - Provide ability to pass 8 CHAR of user data to I/O EXIT.
4-17
Comments
Step 5. Review and Submit JCL
After entering the desired parameter values in the “File-AID/Data Solutions Product
Configuration Parameters” panel (Figure 4-4 on page 4-5), and pressing END (PF3), the
“Edit JCL Screen for File-AID/Data Solutions Parameter Module XVJOPUDA” panel
(Figure 4-5 on page 4-18) displays.
Review and submit the job to create or modify the File-AID/Data Solutions Parameter
Module XVJOPUDA or CANCEL to exit the screen without saving your changes.
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Product Configuration Menu”, the changes you made in the
“File-AID/Data Solutions Product Configuration Parameters” panel (Figure 4-4 on page
4-5) will NOT be saved.
4-18
File-AID Single Install Image Installation and Configuration Guide
Figure 4-5. Edit JCL Screen for File-AID/Data Solutions Parameter Module XVJOPUDA
EDIT
TSOID01.CPWR.MXVJA20.WORK($UDA01) - 01.00
Columns 00001 00072
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 /*JOBPARM S=CW01

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*

000007 //*-----------------------------------------------------------
000008 //* ASSEMBLE INSTALLATION PARAMETERS (XVJOPUDA)

000009 //*--------------------------------------------------------------------
000010 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.

000011 //*--------------------------------------------------------------------
000012 //*

000013 //STEP0100 EXEC PGM=IEFBR14

000014 //OBJ
DD DSN=&OBJTEMP,DISP=(,PASS),

000015 //
UNIT=SYSDA,

000016 //
SPACE=(TRK,(10,10,5))

000017 //STEP200 EXEC PGM=ASMA90, 
000018 //
PARM=('XREF(SHORT),NORLD,LC(60),CPAT(SYSL),RENT',
000019 //
'BATCH,LANG(EN),TERM,SYSPARM(MVS),OBJ'), 
Note: If you update a product option variable after you have completed the
configuration process, always submit the JCL to save updates to the parameter
module in the File-AID load library.
Step 6. Review Job Output
When you receive the job completion message, review the job output and verify that
File-AID/Data Solutions Parameter Module XVJOPUDA has been created or updated.
Step 7. Generate Customized Objects
Select Option 3 from the “File-AID/Data Solutions Product Configuration Menu” to
display the “File-AID/Data Solutions Customization Tasks” panel (Figure 4-6). Option 3
provides instructions on what to do with various defined exits.
Figure 4-6. File-AID/Data Solutions Customization Tasks

File-AID ------------------- Customization Tasks ----------------------------
OPTION ===>

Product.... File-AID/Data Solutions

Version.... 10.02.00


More:
+ 
For detailed instructions on File-AID/Data Solutions exits please
refer to the File-AID Single Install Image Installation and 
Configuration Guide.
The following members can be found in the SXVJSAMP library:
1)
Audit Exit Samples and Proc JCL
UDAAUAXA
- Assembler Sample Audit Exit
UDAAUAXC
- COBOL Sample Audit Exit
UDAAUAXP
- PLI Sample Audit Exit
UDASMFUX
- Assembler Sample SMF Exit
UDALKAUA
- JCL to Assemble/Link Assembler Exit














File-AID/Data Solutions Product Configuration
4-19
Audit Exit Samples and Proc JCL
The File-AID Sample library (CPWR.MXVJA20.SXVJSAMP) provides sample audit trail
exits in Assembler, COBOL, PL/I, and provides JCL to compile and link-edit the exit, as
shown in Table 4-5. In addition, the Sample library contains a sample SMF user exit in
Assembler and the corresponding JCL. See “Audit Trail Exit” on page B-1 for more
information.
Table 4-5.
Sample Audit Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
UDAAUAXA
UDALKAUA
Assembler sample audit exit
UDAAUAXC
UDALKAUC
COBOL sample audit exit
UDAAUAXP
UDALKAUP
PL/I sample audit exit
UDASMFUX
UDALKSMF
Assembler sample SMF exit
I/O Exit Samples and Proc JCL
File-AID/Data Solutions and File-AID/MVS can share the same File-AID I/O exit.
The File-AID sample I/O exit enables you to write a callable routine to perform functions
not supported by File-AID such as: encryption, decryption, compression, and
decompression. In addition, an I/O exit routine can be written to handle all the I/O for
specified files -- including Open and Close.
I/O exit processing can be initiated by entering a module name in the I/O EXIT field on
the File-AID/Data Solutions Input Dataset Specification screen. File-AID calls the I/O exit
at least five times during a Copy function. I/O exits are not supported for the Update
function. “I/O Exit Sequence” on page A-11 lists the calls in the sequence in which they
occur. “I/O Exit Function Calls” on page A-11 describes the tasks performed by
File-AID/Data Solutions and the I/O exit for each call.
The two types of I/O exits are type 1 and type 2. A type 1 exit allows record access after
File-AID reads from a dataset and before File-AID writes to a dataset. A type 2 exit allows
nonstandard dataset access; it performs all I/O processing against the dataset. The exit
supplies File-AID/Data Solutions with a logical record upon request.
Compuware provides three sample exits. The sample exit names are XVJTYP1A and
XVJTYP2A (for Assembler) and XVJCOB1 (for COBOLII). The communications macro for
Assembler only is called XVJFAIOU. XVJTYP1A and XVJTYP2A are sample compression
and decompression exits. XVJTYP2A is a sample exit for handling all I/O requests.
Table 4-6.
Sample I/O Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
XVJTYP1A
XVJLKIOA
Assembler sample type 1 exit
XVJTYP2A
XVJLKIOA
Assembler sample type 2 exit
XVJCOB1
XVJLKIOC
COBOL sample type 1 exit
Date Pattern, Field Level, and Encryption Exits
File-AID/Data Solutions uses date pattern exits to define and process the various date
formats. The exit converts your date to one of two standard formats (Gregorian or Julian)
and then converts the date back to its original format.
File-AID/Data Solutions uses field level exits to define and process both Data Solutionsdefined and user-defined business function data conversions. Data Solutions takes the
specified data field, passes it to the field level exit for conversion, and returns the new
value to the data field. Data Solutions is distributed with the field-level exits listed in
Table 4-7.
4-20
File-AID Single Install Image Installation and Configuration Guide
The Data Encryption function simplifies the process of encrypting and decrypting a data
file. Data Solutions uses encryption/decryption exits to define and process both Data
Solutions-defined and user-defined encryption routines. Simply choose a routine for a
particular field from Data Solutions’ list of Available Encryption/Decryption Exits. With
the use of selection criteria, you can assign an encryption routine to a field based on the
data in that field or on the data in another field in the record.
Table 4-7.
Sample Date Pattern, Field Level, and Encryption Exits
Exit Source Name
Compile/Link JCL Name
Description
EXIT0111
UDAEXITL
Sample ENCRYPT/DECRYPT Exit
Type 1
EXIT0112
UDAEXITL
Sample ENCRYPT/DECRYPT Exit
Type 2
EXITR101
UDALR101
Sample record level exit (with
encryption key)
AGERxxxx
UDAEXITL
Sample date exits
EXITxxxx
UDAEXITL
Sample field exits
DATELIST
UDADLIST
Date pattern exit table
EXITLIST
UDAELIST
Field exit table
Refer to Appendix B, “File-AID/Data Solutions Exits” for more information on Date
Pattern, Field Level, and Encryption Exits.
What’s Next?
After you have completed the configuration of File-AID/Data Solutions, press END until
you return to the “Product Configuration Menu” (Figure 4-1 on page 4-2).
Either
• select the next File-AID product to configure from the “Product Configuration
Menu” (Figure 4-1 on page 4-2).
Or
• continue with “Step 4.9 START” on page 2-67 to start File-AID/Data Solutions and
verify the product installation. Refer to Chapter 11, “Verifying File-AID
Installation” for suggested verification procedures.
5-1
Chapter 5.
File-AID/RDX Product Configuration
Chap 5
Product Overview
File-AID/RDX enables programmers and database administrators to easily extract and
load a complete subset of related MVS and/or DB2 data. Data related by referential
integrity or application-defined relationships can be copied within the MVS and/or DB2
environment with full support for all relational constraints.
File-AID/RDX allows programmers to use a familiar ISPF-like format to create and
populate test files and/or DB2 tables that accurately reflect the production relationships,
yet contain only a relevant subset of the data—without coding SQL or writing programs. DBAs
can migrate related sets of data from one DB2 subsystem to another, confident that all
parent/child relationships are properly maintained—without extensive manual procedures.
Configuration Prerequisites
Before continuing with the File-AID/RDX configuration you must have configured the
File-AID Common Component module XVJOPUNV (see “Step 2. Specify File-AID
Common Component Parameters” on page 2-7). If your site requires the DB2 option for
File-AID/RDX, you must have configured the DB2 environment module XVJOPDB2 (see
“Step 3.1 Specify DB2 Subsystem (Option 1)” on page 2-28). If your site also uses the
File-AID Data Privacy plugin of the Compuware Workbench, you must have configured
the Data Privacy module XVJOPDPR (see “Step 3.3. Specify File-AID Data Privacy (Option
3)” on page 2-55).
Configuration Procedures
Step 1. Select File-AID/RDX
Select option 3, Product Specific Options, from the “Configuration Facility Menu” (Figure
2-2 on page 2-4) to display the File-AID “Product Configuration Menu” (see Figure 5-1). It
lists all File-AID mainframe products.
5-2
File-AID Single Install Image Installation and Configuration Guide
Figure 5-1. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD














Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
9
START - Start products to verify installation 

XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE
Select Option 3, File-AID/RDX.
Step 2. Specify Source of Product Parameters
When selecting Option 3 File-AID/RDX from the “Product Configuration Menu” (Figure
5-1 on page 5-2) the “Source of Product Parameters” screen displays, prompting you to
specify the installation dataset of the previously installed product release or the name of
a load library containing File-AID Configuration modules in order to populate product
specific parameters.
Figure 5-2. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):
Previous install dataset . .
OR
Configuration library . . .
Press ENTER to continue. 
1. Specify either
– the name of a File-AID/RDX install dataset prior to Release 10.1
OR






File-AID/RDX Product Configuration
5-3
– the name of the File-AID Configuration (load) library that includes a
File-AID/RDX XVJOPXFR module you want to use as a source for your parameter
input
OR
– Leave both fields blank if this is your initial installation of File-AID.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
If you leave the Previous Install dataset as blank, it will be ignored. A valid
previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID/RDX, then
you may retain the previously specified variable values. This is accomplished by
specifying the name of the install dataset (e.g. hlq.CPWR.MXFR500.INS) that was
previously used to install File-AID/RDX.
When specifying an unsupported install dataset, this pop-up message displays:
CANNOT IMPORT CONFIGURATION VALUES FROM

THE SPECIFIED DATASET

'TSOID01.FR.V040900.INSTALL'


DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINXFR) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters; product installation
defaults are used when previous variable values cannot be imported. You
must visit Option 2, SPECIFY PARMS (see “Step 4. Specify File-AID/RDX
Product Configuration Parameters” on page 5-5) to verify the variable
values.
Configuration library : Leave blank if you want to preserve the product installation
defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a File-AID/RDX XVJOPXFR module and you want to use it as a source for your
parameter input.
If you want to use a preexisting XVJOPXFR parameter module (v10.1 or higher),
you can specify the name of the dataset that contains it. If a valid parameter
module is found, ALL values will be initialized from there. If the utility finds a
CXVJLOAD dataset with a hlq that matches the SXVJSAMP you are executing
from AND a valid parameter module is found, this field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID/RDX Product
Configuration Menu” shown in Figure 5-3 on page 5-4 which lists the File-AID/RDX
Product Configuration options.
5-4
File-AID Single Install Image Installation and Configuration Guide
Figure 5-3. File-AID/RDX Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID/RDX

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.CXVJLOAD


Source of DB2 Input . . . hlq.CPWR.MXVJA20.CXVJLOAD
Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD


Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 5-2). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARM module.
Source of DB2 Input : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 5-2). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import DB2 parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARM module.
Configuration Output : Identifies the configured load library to which the
File-AID/RDX module XVJOPXFR will be saved.
The available options in the “File-AID/RDX Product Configuration Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
• CUSTOMIZE: Generate customized objects.
Select one of the available options.
Step 3. Review Target and Configuration Module Libraries
Select option 1 from the “File-AID/RDX Product Configuration Menu” to display the
“Dataset Name Specification” panel (Figure 2-6 on page 2-11). Here you review the
dataset information for the File-AID SMP/E Target Libraries that were created during the
SMP/E installation (see Chapter 2, “RFN SMP/E Installation of Compuware Mainframe
File-AID/RDX Product Configuration
5-5
Products” or Appendix A, “SMP/E Installation Using the EP Media Interface” in the
Compuware Installer Mainframe Products SMP/E Installation Guide) and the File-AID
Configuration Module Libraries. This list is for display only. If you need to make changes
you have to make them in for the File-AID Common Component modules (refer to “Step
2.1 Specify Configuration Module Dataset Names” on page 2-10.
Step 4. Specify File-AID/RDX Product Configuration Parameters
Select Option 2, SPECIFY PARMS, from the “File-AID/RDX Product Configuration Menu”
to display the “File-AID/RDX Product Configuration Parameters” panel (Figure 5-4).
Option 2 allows you to specify values for variables that the Configuration Facility uses to
configure File-AID/RDX. Scroll through this list to review and update all the
variables.The values that you provide are saved in the parameter variables list. A listing of
all the variables is provided in Table 5-1 on page 5-6.
The displayed parameter values reflect the values imported from the source you specified
in “Source of Product Parameters” (Figure 5-2 on page 5-2). If no source was entered,
File-AID displays the default values delivered with the product.
Edit the parameter values to configure File-AID/RDX to your site’s desired settings.
Use the HELP command (PF1) to receive information on using this screen.
After entering and reviewing the desired values, press END (PF3) to continue to the Edit
JCL screen where you can submit the job to assemble the File-AID/RDX parameter
module XVJOPXFR, or CANCEL to exit the screen without saving your changes.
Figure 5-4. File-AID/RDX Product Configuration Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>

Product.... File-AID/RDX
Version.... 10.02.00





Variable Value
Description

-------- --------------------------------------------------------------------- 
More:
+ 
EXIT
N
RDXPMDQL RDX
REQCONV
T
UIMGCPY
Y
ISPFEDIT N
SITEREFL Y
SPPRIM
20
ENCRYPTION Exit Installed.

(Y=YES,N=NO) Default=N

RDX User Profile middle qualifier
Default=RDX

Convert Pre V4 extract request file
(C=Convert,T=Terminate) Default=T 
Allow extract from image copy

(Y=YES,N=NO) Default=N

ISPF EDIT function used when ISPF VIEW is selected
(Y=YES,N=NO) Default=N

Update site reference?

(Y=YES,N=NO) Default=N

Split file primary allocation (in blocks)

(1-9999) Default=20



Change any of the variable values as required for your site.
Option 2, SPECIFY PARMS, enables you to specify values for File-AID/RDX default
options. You must verify or provide values for variables such ‘ENCRYPTION Exit
Installed’ (“EXIT” on page 5-6), or ‘Allow extract from image copy’ (“UIMGCPY” on page
5-6) when installing File-AID/RDX with DB2 support. The values that you provide are
saved in the Configuration Parameters list. Refer to Table 5-1 on page 5-6 for a complete
listing of all variables. i
After entering the desired values, enter END (PF3) to save your changes and enter the
“Edit JCL Screen for File-AID/RDX Parameter Module XVJOPXFR” screen (Figure 5-5 on
5-6
File-AID Single Install Image Installation and Configuration Guide
page 5-8) to review and submit the job, or CANCEL to exit the screen without saving
your changes.
Table 5-1.
File-AID/RDX Product Parameter Variables
Variable Name
EXIT
Default Value
N
RDXPMDQL
RDX
REQCONV
T
UIMGCPY
N
ISPFEDIT
N
SITEREFL
N
SPPRIM
20
Your Value
Comments
ENCRYPTION Exit Installed.
(Y=YES,N=NO) Default=N
Specifies whether File-AID/RDX enables the
Encryption Exit option.
RDX User Profile middle qualifier
Default=RDX
Up to 8 characters. The format for this file is
userid.xxxxxxxx.PROFILE where xxxxxxxx = middle
qualifier. The value for this variable must follow the
restrictions for a filename.
Convert Pre V4 extract request file
(C=Convert,T=Terminate) Default=T
Batch Convert or Terminate pre-Release 4.0 extract
requests.
Set this variable to T (Terminate) if you don’t want
to allow pre-Release 4.0 extract requests to be
converted automatically when the submitted extract
JCL points to a pre-Release 4.0 extract request. The
batch job terminates immediately with a message.
Set to C (Convert) to allow automatic conversion
when submitting extract JCL that points to a preRelease 4.0 extract request file.
This variable affects only externally submitted JCL.
Note: When converting a pre-Release 4.0 extract
request, the extract results may differ from
earlier releases.
File-AID/RDX always converts pre-Release 4.0
extract requests when submitted from within
File-AID/RDX.
Allow extract from image copy.
(Y=YES,N=NO) Default=N
Y allows users to extract DB2 data from DB2 Image
Copy datasets. Either the Load Libraries
(“CPWR.MXVJA20.CXVJLOAD” and
“CPWR.MXVJA20.SXVJLOAD”, see “Load Library”
on page 2-11)) must be AUTHORIZED or all of the
Load Library modules must be copied into an
authorized library after the File-AID/RDX Parameter
Module XVJOPXFR has been created.
N disables extract DB2 data from DB2 Image Copy
and locks the SITE profile variable Extract from Image
Copy to No.
ISPF EDIT function used when ISPF VIEW is selected
(Y=YES,N=NO) Default=N
When set to Yes, ISPF EDIT function will be used
when ISPF VIEW is selected.
Update site reference?
(Y=YES,N=NO) Default=N
When set to Yes, it allows users to update the SITE
Profile file. When set to No, users can only update
their user profile files.
Split file primary allocation (in cylinders)
(1-9999) Default=20
Allocation limit for split file primary allocation value
during the disguise process. The amount that is
entered is in cylinders.
File-AID/RDX Product Configuration
Table 5-1.
5-7
File-AID/RDX Product Parameter Variables (Continued)
Variable Name
SPSEC
Default Value
20
ARLLQ 
CONDAR
FTPREFIX
RDX
Your Value
DATASETS
Default
Relationship File
Site Profile
Comments
Split file secondary allocation (in cylinders)
(1-9999) Default=20
Allocation limit for split file secondary allocation
value during the disguise process. The amount that
is entered is in cylinders.
LLQ for conditional AR criteria
Default=CONDAR
Specifies the low level qualifier for the data driven AR
criteria file. The dataset name of the relationship file
will be used, with this low level qualifier substituted.
Used when defining data driven conditional AR.
Prefix-ID used in constructing RDX JCL
Default=RDX
This is the prefix (up to 19 positions) used for files
that must be allocated for batch functions.
File-AID/RDX will prefix temporary files with
userid.RDX. To prefix a file without a userid, place
one double quote as the first character of the
pattern. For example, “RDX will prefix a temporary
file with RDX. only.
Entering a prefix that includes the string &USERID
will substitute the current userid when the
temporary file is allocated. For example,
“RDX.&USERID will prefix a temporary file with
RDX.userid.
File-AID/RDX Default Relationship File. Required.
Specify the name of the Default Relationship File.
File-AID/RDX Site Profile. Required. Specify the
name of the File-AID/RDX Site Profile dataset.
If the Profile dataset does not exist, you must run the
File-AID/RDX customization task 1 Site Profile (see
“Option 1, Site Profile - Generate The Default Site
Profiles” on page 5-8).
Step 5. Review and Submit JCL
After entering the desired parameter values in the “File-AID/RDX Product Configuration
Parameters” panel (Figure 5-4 on page 5-5), and pressing END (PF3), the “Edit JCL Screen
for File-AID/RDX Parameter Module XVJOPXFR” panel (Figure 5-5 on page 5-8) displays.
Review and submit the job to create or modify the File-AID/RDX Parameter Module
XVJOPXFR or CANCEL to exit the screen without saving your changes.
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Product Configuration Menu”, the changes you made in the
“File-AID/RDX Product Configuration Parameters” panel (Figure 5-4 on page 5-5) will
NOT be saved.
5-8
File-AID Single Install Image Installation and Configuration Guide
Figure 5-5. Edit JCL Screen for File-AID/RDX Parameter Module XVJOPXFR
EDIT
TSOID01.CPWR.MXVJA20.WORK($XFR01) - 01.00
Columns 00001 00072
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*

000007 //*-------------------------------------------------------------------- 
000008 //* ASSEMBLE FILE-AID/RDX CUSTOMIZATIONS PARAMETERS (XVJOPXFR)

000009 //*-------------------------------------------------------------------- 
000010 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.
000011 //*-------------------------------------------------------------------- 
000012 //STEP0100 EXEC PGM=IEFBR14

000013 //OBJ
DD DSN=&OBJTEMP,DISP=(,PASS),

000014 //
UNIT=SYSDA,

000015 //
SPACE=(TRK,(10,10,5))

000016 //STEP200 EXEC PGM=ASMA90,

000017 //
PARM=('XREF(SHORT),NORLD,LC(60),CPAT(SYSL),RENT',
000018 //
'BATCH,LANG(EN),TERM,SYSPARM(MVS),OBJ'),
000019 //
REGION=4096K
Note: If you update a product option variable after you have completed the
configuration process, always submit the JCL to save the updates to the PARM
module in the File-AID load library.
Step 6. Review Job Output
When you receive the job completion message, review the job output and verify that
File-AID/RDX Parameter Module XVJOPXFR has been created or updated.
Step 7. Generate Customized Objects
Select Option 3 from the “File-AID/RDX Product Configuration Menu” to display the
“File-AID/RDX Customization Tasks Menu” panel (Figure 5-6). This menu allows you to
select a Customization task and submit the generated JCL.
Figure 5-6. File-AID/RDX Customization Tasks Menu



File-AID ------------------- Customization Tasks ----------------------------
OPTION ===>

Product.... File-AID/RDX

Version.... 10.02.00

1
Site Profile
- Generate the default SITE profiles.

This must be executed if the RDX Site Profile does not exist. 
It may be optionally executed to refresh the existing RDX Site
Profiles. 
Enter the option number for the desired Customization task.
Option 1, Site Profile - Generate The Default Site Profiles
This task generates the default SITE profile members and copies them into the profile
dataset specified in “Step 4. Specify File-AID/RDX Product Configuration Parameters”
(see “Site Profile” on page 5-7). If the Profile dataset does not exist, you must run this
task to allocate and initialize it.
File-AID/RDX Product Configuration
5-9
When you select “Option 1, Site Profile - Generate The Default Site Profiles”, Figure 5-7 is
displayed.
Figure 5-7. Generate SITE Profiles Screen
File-AID -------------------- Customization Tasks ---------------------------OPTION ===> 1
Product.

Version.
Customization ------ Generate SITE Profiles -----------COMMAND ===>
1 Site
This task generates the base SITE PROFILES needed to
This
run File-AID/RDX (RDXMENU RDXQUICK RDXFLOW)
It ma
Profi
If the Profile dataset does not exist, it will be
allocated and initialized. If it does exist, only
continue with this step if you want to replace the three
base profiles with the values that were specified during
Configuration.
These 3 profiles are then placed in the file that was
defined in 3 Product Specific Components
3 File-AID/RDX
2 SPECIFY PARMS - RDX Site Profile

hlq.PROFILE

Continue
==>
(Y/N)





















Continue : Enter Y (Yes) or N (No) to indicate whether this option should be run or not.
– If the profile file does not exist, enter Y to continue with this step to generate the
base profiles.
– If the profile file exists, only continue with this step if you want to replace the
base profile members.
Note: After the File-AID/RDX customization has been completed, your site’s File-AID
administrator should modify the SITE profiles using Option 0, Profile of the
File-AID/RDX Primary Option Menu to site-specific settings and establish access
authorities according to your site’s standards.
The profile dataset requires specific attributes; if you receive the error “IEC1431 2133C”, it indicates that your SMS installation may have changed these attributes.
What’s Next?
After you have completed the configuration of File-AID/RDX, press END until you return
to the “Product Configuration Menu” (Figure 5-1 on page 5-2).
Either
• select the next File-AID product to configure from the “Product Configuration
Menu” (Figure 5-1 on page 5-2).
Or
continue with “Step 4.9 START” on page 2-67 to start File-AID/RDX and verify the
product installation. Refer to the File-AID/RDX User Guide for further information.
5-10
File-AID Single Install Image Installation and Configuration Guide
6-1
Chapter 6.
File-AID for DB2 Product Configuration
Chap 6
Product Overview
File-AID for DB2 is designed for the application programmer. It lets you attain selfsufficiency by removing barriers and helping you obtain the data needed to get your job
done. Everything you need to create an effective DB2 test environment — without coding
SQL — is included in one self-contained product. You can follow a logical work flow from
start to finish without relying on IBM utilities.
You can create a table modeled from a DBA-designed table, copy data into it from an
existing table, and then customize the data to represent exactly the conditions needed to
test your program. Valuable test time is not spent working with awkward utilities or
coding SQL.
During the application test cycle, you can review a concisely formatted list of privileges
for an object. This helps avoid authorization failures and lets authorized users grant and
revoke privileges.
You can interactively execute SQL statements and receive analysis of Explain information
indicating how the statements perform and suggestions for improvement. This
eliminates the need to recompile and rebind in order to verify the SQL. This feature also
allows you to prototype SQL code before incorporating it into your application.
When extracting sensitive production data, it can also be disguised to protect privacy.
Data disguise requires installation of Compuware’s File-AID/Data Solutions.
Configuration Prerequisites
Before continuing with the File-AID for DB2 configuration you must have configured the
File-AID Common Component module XVJOPUNV (see “Step 2. Specify File-AID
Common Component Parameters” on page 2-7) and the DB2 environment module
XVJOPDB2 (see “Step 3.1 Specify DB2 Subsystem (Option 1)” on page 2-28). If your site
also uses the File-AID Data Privacy plugin of the Compuware Workbench, you must have
configured the Data Privacy module XVJOPDPR (see “Step 3.3. Specify File-AID Data
Privacy (Option 3)” on page 2-55).
Configuration Procedures
Step 1. Select File-AID for DB2
Select option 3 from the “Configuration Facility Menu” (Figure 2-2 on page 2-4) to
display the File-AID “Product Configuration Menu” (see Figure 6-1). It lists all File-AID
mainframe products.
6-2
File-AID Single Install Image Installation and Configuration Guide
Figure 6-1. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD














Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
9
START - Start products to verify installation 

XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE
Select Option 4, File-AID for DB2.
Step 2. Specify Source of Product Parameters
When selecting Option 4 File-AID for DB2 from the “Product Configuration Menu”
(Figure 6-1 on page 6-2) the “Source of Product Parameters” screen displays, prompting
you to specify the installation dataset of the previously installed product release or the
name of a load library containing File-AID Configuration modules in order to populate
product specific parameters.
Figure 6-2. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):
Previous install dataset . .
OR
Configuration library . . .
Press ENTER to continue. 
1. Specify either
– the name of a File-AID for DB2 install dataset prior to Release 10.1
OR






File-AID for DB2 Product Configuration
6-3
– the name of the File-AID Configuration (load) library that includes a File-AID for
DB2 XVJOPXFD module you want to use as a source for your parameter input
OR
– Leave both fields blank if this is your initial installation of File-AID.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
If you leave the Previous Install dataset as blank, it will be ignored. A valid
previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID for DB2, then
you may retain the previously specified variable values. This is accomplished by
specifying the name of the install dataset (e.g. hlq.CPWR.BG121116.INS) that was
previously used to install File-AID for DB2.
When specifying an unsupported install dataset, this pop-up message displays:
CANNOT IMPORT CONFIGURATION VALUES FROM

THE SPECIFIED DATASET

'TSOID01.FD.V050000.INSTALL'


DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINXFD) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters; product installation
defaults are used when previous variable values cannot be imported. You
must visit Option 2, SPECIFY PARMS (see “Step 4. Specify File-AID for DB2
Product Configuration Parameters” on page 6-5) to verify the variable
values.
Configuration library : Leave blank if you want to preserve the product installation
defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a File-AID for DB2 XVJOPXFD module which you want to use as a source for your
parameter input.
If you want to use a preexisting XVJOPXFD parameter module (v10.1 or higher),
you can specify the name of the dataset that contains it. If a valid parameter
module is found, ALL values will be initialized from there. If the utility finds a
CXVJLOAD dataset with a hlq that matches the SXVJSAMP you are executing
from AND a valid parameter module is found, this field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID for DB2
Product Configuration Menu” shown in Figure 6-3 on page 6-4 which lists the
File-AID for DB2 Product Configuration options.
6-4
File-AID Single Install Image Installation and Configuration Guide
Figure 6-3. File-AID for DB2 Product Configuration Menu


File-AID ------------------- Product Configuration ---------------------------
OPTION ===>

Product.... File-AID for DB2

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Source of DB2 Parms . . . hlq.CPWR.MXVJA20.CXVJLOAD

Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Option not available 
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 6-2). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARM module.
Source of DB2 Input : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 6-2). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import DB2 parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARM module.
Configuration Output : Identifies the configured load library to which the File-AID for
DB2 module XVJOPXFD will be saved.
The available options in the “File-AID for DB2 Product Configuration Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
Select one of the available options.
Step 3. Review Target and Configuration Module Libraries
Select option 1 from the “File-AID for DB2 Product Configuration Menu” to display the
“Dataset Name Specification” panel (Figure 2-6 on page 2-11). Here you review the
dataset information for the File-AID SMP/E Target Libraries that were created during the
SMP/E installation (see Chapter 2, “RFN SMP/E Installation of Compuware Mainframe
Products” or Appendix A, “SMP/E Installation Using the EP Media Interface” in the
Compuware Installer Mainframe Products SMP/E Installation Guide) and the File-AID
File-AID for DB2 Product Configuration
6-5
Configuration Module Libraries. The displayed list is the same as displayed in Figure 2-6
on page 2-11. Refer to “Step 2.1 Specify Configuration Module Dataset Names” on page
2-10 for more information.
Step 4. Specify File-AID for DB2 Product Configuration Parameters
Select Option 2 from the “File-AID for DB2 Product Configuration Menu” to display the
“File-AID for DB2 Product Configuration Parameters” panel (Figure 6-4). Option 2 allows
you to specify values for variables that the Configuration Facility uses to configure
File-AID for DB2. The values that you provide are saved in the parameter variables list. A
listing of all the variables is provided in Table 6-1 on page 6-5 through Table 6-7 on page
6-10.
The displayed parameter values reflect the values imported from the source you specified
in “Source of Product Parameters” (Figure 6-2 on page 6-2). If no source was entered,
File-AID displays the default values delivered with the product.
Edit the parameter values to configure File-AID for DB2 to your site’s desired settings.
Use the HELP command (PF1) to receive information on using this screen.
After entering and reviewing the desired values, press END (PF3) to continue to the Edit
JCL screen where you can submit the job to assemble the File-AID for DB2 parameter
module XVJOPXFD, or CANCEL to exit the screen without saving your changes.
Figure 6-4. File-AID for DB2 Product Configuration Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>


Product.... File-AID for DB2
Version.... 10.02.00
Variable
-------Audit
F2AUDREC
F2AUDIT
F2AUDUNI
F2AUDVOL
F2SMFID
BATCH
FIBFCOMM
FIBFROWS


Value
Description

--------------------------------------------------------------------- 
More:
+ 

Expected number of records in audit trail dataset
1000
(0-99999999) Default=1000
File-AID for DB2 Audit Usage.
QUERY
(NO,QUERY,FORCE,SMF) Default=QUERY
Generic unit for audit trail datasets. 
SYSDA
Default=SYSDA

Volume serial for audit trail datasets.

SMF Record number.

253
(128-255) Default=253


Autocommit in Batch.

N
(Y=YES,N=NO) Default=N 
Autocommit after N rows.

2000
Change any of the variable values as required for your site.
Table 6-1 on page 6-5 through Table 6-7 on page 6-10 list the variables. A value is
required for all variables, unless stated otherwise in the comments column.
Table 6-1.

Group AUDIT—Audit Trail Options
Variable
Name
Default
Value
F2AUDREC
1000
Your
Values
Comments
Expected number of records in audit trail dataset.
(0-99999999) Default=1000
Number of audit trail records generated for each row is:
updated (2), deleted (1), and inserted (1).
6-6
File-AID Single Install Image Installation and Configuration Guide
Table 6-1.
Variable
Name
Group AUDIT—Audit Trail Options (Continued)
Default
Value
Your
Values
Comments
F2AUDIT
QUERY
File-AID for DB2 Audit Usage. 
(NO,QUERY,FORCE,SMF) Default=QUERY
NO indicates that no audit trail is generated. The individual
user does not have the ability to override this parameter.
QUERY indicates that the audit trail exit is queried. If the exit
indicates an audit trail should be generated for a specific
object, the audit trail is generated regardless of whether the
user requests the audit trail. 
FORCE indicates that an audit trail is produced for all objects
edited with File-AID. 
SMF creates an audit for all edits and writes the audit records
to the SMF log.
F2AUDUNI
SYSDA
Generic unit for audit trail datasets.
Default=SYSDA
The audit trail exit may override this value.
F2AUDVOL
F2SMFID
Table 6-2.
Volume serial for audit trail datasets.
Default VOLSER for audit trail datasets. The audit trail exit may
override this value.
SMF Record number. 
(128-255) Default=253
User SMF record number. Used to specify the SMF record
number to be used for the audit trail. Must be between 128
and 255. This value is required if SMF is selected for Audit
(variable F2AUDIT = SMF).
253
Group BATCH—Batch Options
Variable
Name
Default
Value
FIBFCOMM
N
FIBFROWS
2000
FIBFTIME
30
Autocommit after n seconds clock time.
(1-9999) Default=30
Commit after n seconds clock time. Value must be
positive.
FIPRMDIR
20
Default Directory Blocks for Perm datasets.
(1-999999) Default=20
Allocation parameter directory blocks for permanent
datasets. Value must be positive.
FIPRMFRM
FB
Allocation parameter record format for permanent
datasets.
(FB,VB) Default=FB
FITAPE
CART
Your
Values
Comments
Autocommit in Batch. 
(Y=YES,N=NO) Default=N
Specify whether automatic commits should occur when
running the batch facility. The commit frequency is
specified by FIBFROWS and FIBFTIME.This is for batch
facility only.
Autocommit after n rows. 
(1-999999) Default=2000
Value must be positive.
Default unit for a dataset to be stored on tape. 
Default=CART
This is the value used for batch extract and load as the
UNIT that a dataset is to be stored on if the dataset is not
being stored on disk.
File-AID for DB2 Product Configuration
Table 6-2.
Group BATCH—Batch Options (Continued)
Variable
Name
Default
Value
FDREGION
00
Table 6-3.
Variable
Name
6-7
Your
Values
Comments
Default Batch REGION in Megabytes.
Default=00
Default REGION size used within generated BATCH jobs.
DB2— Database, Tablespace, and Index Defaults
Default
Value
Your
Values
Comments
CREATOR
USER
Default Creator ID. If you specify USER then TSO userid
will be used. 
(USER or any userid) Default=USER.
CURSQLID
USER
Default SQLID. If you specify USER then TSO userid will be
used. 
(USER or any userid) Default=USER.
FILOG
Table 6-4.
N
Generate LOG YES or LOG NO on load control cards.
(Y=YES,N=NO) Default=N
EDIT— Edit Options
Your
Values
Variable
Name
Default
Value
AUTOCOMM
ON
Autocommit changes upon pressing ENTER in EDIT.
(ON,OFF) Default=ON
Specify ON to commit edit changes when users press ENTER.
AUTOSAVE
ON
Autocommit changes upon exiting of EDIT.
(ON,OFF) Default=ON
Specify ON to commit edit changes when users exit an EDIT
session.
FRGNDISP
OFF
Show Foreign Key columns while in EDIT.
(ON,OFF) Default=OFF
F2CAPS1
ON
Convert Object Names to uppercase.
(ON,OFF) Default=ON
Determines whether object names are converted to
uppercase.
F2CAPS2
OFF
Convert Data to uppercase.
(ON,OFF) Default=OFF
Determines whether data is converted to uppercase.
IDNTCED
OFF
Allow update of identity column in EDIT.
(ON,OFF) Default=OFF
MAXCOL
OFF
Set the maximum width of the columns in BROWSE or EDIT.
(Even number 2-32704 or OFF) Default=OFF
Sets the maximum width of the columns in a table being
browsed or edited. The setting only affects CHAR, VARCHAR,
and GRAPHIC data types.
NULLDISP
-
Null display character. Character used to represent NULL
Data. 
Default=-
NULLENT
@
Null entry character. Character used to represent the entry of
NULL Data.
Default=@
Comments
6-8
File-AID Single Install Image Installation and Configuration Guide
Table 6-4.
Variable
Name
EDIT— Edit Options (Continued)
Default
Value
Your
Values
Comments
PKEYEDIT
OFF
Allow update of Primary Key in EDIT
(ON,OFF) Default=OFF
Determines whether the primary key can be updated in EDIT.
REPSPWIN
ON
Display repeat generate specification Window.
(ON,OFF) Default=ON
Determines whether the Repeat Generate Specification
window should be displayed for the REPEAT command.
ROWCHED
OFF
Allow update of row change TIMESTAMP column in EDIT. 
(ON,OFF) Default=OFF
This is the default value copied to each user's profile for the
field which determines if row change TIMESTAMP columns
can be updated during EDIT.
SPIMPNUL
OFF
Spaces Imply null for Character fields.
(ON,OFF) Default=OFF
Determines whether spaces imply null in character fields.
UPKEYEDI
OFF
Show and use unique index columns for update in EDIT.
(ON,OFF) Default=OFF
Determines whether unique index columns are shown and
used for update in EDIT.
USCOROPT
W
Define Underscore usage for table names.
(W=Treat as a Wildcard,U=Treat as a Character) 
Default=W.
Specify how File-AID for DB2 should treat an underscore
character in table and creator names.
W=underscore is treated as a wildcard character.
U=underscore is treated as a regular character.
VLENDC
#
Character to indicate end of variable length column.
Default=#
VLTRUNC
ON
Truncate trailing spaces on inserts or updates.
(ON,OFF) Default=ON
Determines whether trailing spaces are truncated on
insert/update.
Table 6-5.
Variable
Name
Group FIX—Restricted Fix Option
Default
Value
Your
Values
Comments
DT30497
N
Enable restricted fix DT30497. 
(Y=YES,N=NO) Default=N
This fix will allow File-AID for DB2 to do predicate analysis on
large SQL statements.
DT50738
N
Enable restricted fix DT50738 - DBCS Character PRINT. 
(Y=YES,N=NO) Default=N
This fix will enable printing of DBCS characters. The logic will
check for terminal type 3278KN first, if that does not exist then
check the new restricted indicator. This variable is only used for
batch process. Online process will not check the value of this
variable.
PT146066
N
Enable restricted fix PT146066 - Union Everywhere.
(Y=YES,N=NO) Default=N
This fix will allow an Explain on an SQL statement that has
UNION within a subselect.
File-AID for DB2 Product Configuration
Table 6-5.
6-9
Group FIX—Restricted Fix Option
Variable
Name
Default
Value
PT146119
N
Enable restricted fix PT146119 - Audit in BROWSE.
(Y=YES,N=NO) Default=N
Provides auditing when browsing.
PT158160
N
Enable restricted fix PT158160 - Query Parallelism.
(Y=YES,N=NO) Default=N
This fix will activate/deavtivate Query Parallelism in File-AID for
DB2.
PT175681
N
Enable restricted fix PT175681. 
(Y=YES,N=NO) Default=N
This fix will bypass the File-AID for DB2 authorization check for
an object in option 2 EDIT. The user will rely on DB2 authority
when performing an UPDATE, INSERT or DELETE.
PT191794
N
Enable restricted fix PT191794 - RBrowse navigation. 
(Y=YES,N=NO) Default=N
This fix will allow File-AID for DB2 to navigate relational data
from either parent to dependent or dependent to parent.
Table 6-6.
Variable
Name
Your
Values
Comments
MISC—Miscellaneous Options
Default
Value
Your
Values
Comments
F2XPOPT
N
Does this site have the Xpediter for DB2 option?
(YES,NO) Default=NO
Allow Bridge to XPEDITER/TSO.
COPYROWS
50
Number of rows to INSERT into copy target table. 
(1-9999) Default=50
Number of rows to INSERT into copy target table before
each commit; for example: If COPYROWS is set to 50 and
you are copying 100 rows, two commits are done. One
commit is done after 50 rows are copied, and then a
second commit is done after the final 50 rows have been
copied.
FISYSADM
U
All users have SYSADM Authority.
(Y=YES,N=NO,U=Check the DB2 catalog for each user)
Default=U
F2HICOST
10000
F2IMAC
ISPFTRC
MAXROWS
Relative Cost ranking during SQL Analysis. (Timeron
value)
(1-32768) Default=10000
Member name of a valid edit macro for usage in option
4.3.
Specifies the member name of a valid edit macro to be
used in option 4.3, ISPF/PDF SQL Source Development
and Analysis.
N
2000
Trace ISPF calls when logging is turned on.
(Y=YES,N=NO) Default=N
Default value copied to each user’s profile to control
whether trace entries for debugging are created.
Maximum number of rows to select.
(numeric value or *=no limit) Default=2000 
Maximum acceptable value is 9999999.
6-10
File-AID Single Install Image Installation and Configuration Guide
Table 6-6.
Variable
Name
MISC—Miscellaneous Options (Continued)
Default
Value
Your
Values
Comments
DISPALLD
Y
Treat all data (x'40'-x'FE') as displayable.
(Y=YES,N=NO) Default=Y
Treat the data between x'40' and x'FE' as displayable in
Browse and Print options. If specified NO, the data will be
verified if it is displayable or not, based on the ISPF
terminal type character module.
NONDISP
.
Character to represent non-displayable data.
Default=.
SHOWSQL
4
Debugging entries displayed.
(1=Log,2=Screen,3=All,4=Off) Default=4
1 = write to ISPF log.
2 = write to screen.
3 = write to log and screen.
4 = no logging.
SQLPLOG
Y
Display SQL information when Logging is enabled.
(Y=YES,N=NO) Default=Y
SQL information will be shown in log when logging is
turned on.
SYSCNTR
N
Log transfer of control when logging is enabled
(Y=YES,N=NO) Default=N
Traces the flow of control when logging is turned on.
TASKTIME
360000
WFQUAL
Table 6-7.
Task time limit in hundredths of a second.
(1-9999999) Default=360000
This is the task time limit in hundredths of a second. The
default value of 360,000 (1 hour) is sufficient for most
applications.
The high level qualifier to be used for the workfile.
This is the high level qualifier to be used to create the
workfile. If no value is entered, the USERID will be used as
the workfile qualifier.
Datasets
Description
Default
Value
Show SQL Dataset SHOW.SQL
Your
Values
Comments
Specify the default name of your site’s SHOW
SQL dataset.
Step 5. Review and Submit JCL
After entering the desired parameter values in the “File-AID for DB2 Product
Configuration Parameters” panel (Figure 6-4 on page 6-5), and pressing END (PF3), the
“Edit JCL Screen for File-AID for DB2 Parameter Module XVJOPXFD” panel (Figure 6-5 on
page 6-11) displays.
Review and submit the job to create or modify the File-AID for DB2 Parameter Module
XVJOPXFD or CANCEL to exit the screen without saving your changes.
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Product Configuration Menu”, the changes you made in the “File-AID for
DB2 Product Configuration Parameters” panel (Figure 6-4 on page 6-5) will NOT be
saved.
File-AID for DB2 Product Configuration
6-11
Figure 6-5. Edit JCL Screen for File-AID for DB2 Parameter Module XVJOPXFD
EDIT
TSOID01.CPWR.MXVJA20.WORK($XFD01) - 01.00
Columns 00001 00072
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*

000007 //*-------------------------------------------------------------------- 
000008 //* ASSEMBLE INSTALLATION PARAMETERS (XVJOPXFD)

000009 //*-------------------------------------------------------------------- 
000010 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.
000011 //*-------------------------------------------------------------------- 
000012 //*

000013 //TEMPOBJ EXEC PGM=IEFBR14

000014 //OBJ
DD DSN=&OBJTEMP,DISP=(,PASS),

000015 //
UNIT=SYSDA,

000016 //
SPACE=(TRK,(10,10,5)) 
000017 //ASMOPTNS EXEC PGM=ASMA90,
000018 //
PARM=('XREF(SHORT),NORLD,LC(60),CPAT(SYSL),RENT',
000019 //
'BATCH,LANG(EN),TERM,SYSPARM(MVS),OBJ'),
Note: If you update a product option variable after you have completed the
configuration process, always submit the JCL to save the updates to the PARM
module in the File-AID load library.
Step 6. Review Job Output
When you receive the job completion message, review the job output and verify that
File-AID for DB2 Parameter Module XVJOPXFD has been created or updated.
Step 7. Object Administration Setup for DSN Command (Optional)
When you are in File-AID for DB2 Object Administration and if you want to use Object
Administration functions against objects on other DB2 subsystems defined in DB2
configuration, there are 3 ways:
1. Exit out of Object Administration and Primary Option Menu or in the Utility
Selection MenuThen return to Object Administration.
2. Use either the CONNECT or LOCATION command with location-id to access remote
DB2 subsystems defined in your DB2 configuration.
3. Use DSN command to dynamically switch the current DB2 subsystem connection
and allocated DB2 datasets.
To use the DSN command (#3), then you must perform the following procedure the first
time you install File-AID for DB2 Object Administration.
1. Move member DBIDLIBX from the File-AID for DB2 Object Administration load
library (.SXVJLOAD) to an APF library that is in the link list (LNKLSTxx).
2. Rename the APF library module from DBIDLIBX to DBIDLIB.
DBIDLIB uses TCB manipulation to dynamically change DB2 load and exit libraries.
3. Update your external security product (such as RACF).
If your site uses security processing (such as RACF, ACF2, or TOPSECRET) that
restricts programs that can be used as TSO commands, verify the following command
is not restricted:
DBIDLIB
6-12
File-AID Single Install Image Installation and Configuration Guide
Note:
The DBIDLIB command must be available to users, and cannot be restricted
from being used as a TSO command.
4. Update your TSO command table (IKJTSOxx) with DBIDLIB as an authorized
command.
What’s Next?
After you have completed the configuration of File-AID for DB2, press END until you
return to the “Product Configuration Menu” (Figure 6-1 on page 6-2).
Either
• select the next File-AID product to configure from the “Product Configuration
Menu” (Figure 6-1 on page 6-2).
Or
continue with “Step 4.9 START” on page 2-67 to start File-AID for DB2 and verify the
product installation. Refer to the File-AID for DB2 Reference manual and the File-AID Object
Administration User Reference manual for further information.
7-1
Chapter 7.
File-AID for IMS/ISPF Product Configuration
Chap 7
Product Overview
File-AID for IMS/ISPF is an interactive, full-screen product designed for use by Application
Programmers/Analysts and Database Administrators.
File-AID for IMS/ISPF provides the ability to easily access and manipulate data within IMS
databases. The databases can be browsed or edited in any of the following modes directly
under TSO/ISPF:
• Formatted using COBOL or PL/I segment layouts
• Unformatted in hexadecimal
• Hierarchical sequence with one segment per screen line
File-AID for IMS/ISPF runs as a single dialog under ISPF and requires absolutely no
modification to IMS, TSO, ISPF, or any other existing software.
File-AID for IMS/FLEX is a general purpose IMS database manipulation tool for use by
business professionals involved in modifying or reporting on the contents of IMS
database. File-AID for IMS/FLEX extends the capabilities of File-AID for IMS/ISPF to the
MVS batch environment.
File-AID for IMS/FLEX simplifies the maintenance of IMS databases by using existing Data
Base Descriptions (DBDs); existing or dynamic Program Specification Blocks (PSBs); and
COBOL or PL/I layouts of DL/I segments, without modification, to manipulate databases.
Because File-AID for IMS/FLEX is built upon File-AID, it provides industrial strength
editing capabilities while maintaining the system integrity and providing the auditing
capability that users have come to expect from the File-AID name.
File-AID for IMS/FLEX is controlled by an easy-to-use and extremely powerful command
set. File-AID for IMS/FLEX allows users to quickly and accurately select the data they
desire and then allows them to print or modify that data. Users may also output the
concatenated keys of the desired segments for later use as input.
Note: File-AID for IMS/ISPF must be configured prior to the configuration of File-AID for
IMS/DC or File-AID for IMS/CICS.
Source Management
File-AID for IMS/ISPF supports direct retrieval of COBOL or PL/I segment layouts from the
Panvalet and Librarian source management products. In “Step 2.2 Specify Product
Configuration Parameters” on page 2-14 you must indicate which, if any, of these
products (“CALIB” and “CAPAN” on page 2-22) are in use at your installation.
IMS Environment
When processing IMS databases (for example, in Browse, Edit, Initialize, Batch Extract,
and Batch Load), File-AID for IMS/ISPF allocates all the IMS DDNAMEs required by IMS
before attaching the IMS control program DFSRRC00.
7-2
File-AID Single Install Image Installation and Configuration Guide
DL/I Mode
Following are some of the installation parameters required by File-AID for IMS/ISPF when
processing in DL/I mode:
• The File-AID for IMS/ISPF PSB library name. Required only for static PSB support.
• The IMS RESLIB load library names. These are the fully qualified dataset names
normally associated with the DFSRESLB DD.
• The dataset that contains the buffer pool information required by the DL/I buffer
handler. This is the dataset normally associated with the DFSVSAMP DD.
• DL/I execution parameters to be passed to DFSRRC00.
BMP Mode
Following are some of the installation parameters required by File-AID for IMS/ISPF when
processing in BMP mode:
• The IMS RESLIB library names for the dependent region. These are the fully qualified
dataset names for the IMS subsystem being used.
• The IMS ACB library names that contain the prebuilt application control blocks
(ACBs).
• The DOPT ACB library name to be used to store dynamically created ACBs. Required
only for dynamic PSB support.
• The IMSID for the IMS subsystem in use.
• BMP execution parameters to be passed to DFSRRC00.
Dynamic Backout/Secondary Indexes
Because the Edit, Initialize, and Load (Batch mode) options update databases in an IMS
DL/I environment, certain criteria must be true to ensure the integrity of secondary
index databases and allow dynamic backout. Compuware recommends that you specify Y
for the BKO parameter of the DLIPARMS installation parameter. File-AID for IMS/ISPF
users can then specify a direct access log dataset to allow secondary index source
segments to be updated.
By allocating a log dataset, IMS dynamically backs out updates to the last sync point
when an IMS pseudo abend occurs.
DBRC and RECON Datasets
DBRC can be used with File-AID for IMS/ISPF to maintain the integrity of your databases.
If your IMS system was generated with DBRC=FORCE, DBRC is always active and its use
cannot be overridden.
However, if your IMS system was not generated with DBRC=FORCE, the use of DBRC by
File-AID for IMS/ISPF can be overridden. You can override it if you specify Y or N for the
DBRC operand of the DLIPARMS installation parameter. If the DBRC operand is left as
null, the use of DBRC is determined by the IMS system definition.
Note:
If IRLM or DBRC is used at your installation, Y should be coded for the DBRC
operand unless DBRC is unavailable for use.
If DBRC is active you must allocate RECON datasets to your File-AID for IMS/ISPF session.
These datasets can be allocated in one of the following ways:
1. Define the datasets during the IMS stage 1 system definition with the dynamic
allocation macro DFSMDA. This action may have already been done at your
File-AID for IMS/ISPF Product Configuration
7-3
installation. The RECON datasets are then automatically allocated by IMS when
required. This method is strongly recommended for most installations.
2. Allocate the datasets in the same CLIST that allocates File-AID for IMS/ISPF’s
execution libraries.
3. Allocate the datasets in the TSO LOGON PROC.
4. Write a security exit routine that dynamically allocates the datasets.
5. Specify the datasets in Option 0.4, IMS DLI Datasets screen of File-AID for IMS/ISPF.
Security Exit
File-AID for IMS/ISPF provides a security exit that is invoked prior to each IMS initiation
and termination, prior to the allocation of each database dataset, and prior to allocating
and opening each non-database dataset used during File-AID for IMS functions.
Refer to Appendix E, “File-AID for IMS Exits” if you require special log dataset
processing, additional database security, want to change the File-AID for IMS default
database dataset allocation (the default for edit is OLD unless using a DBRC registered
dataset, then it is SHR), want to override the DFSRRC00 parameters specified in the
installation parameters, want to substitute different dataset names or allow shorthand
aliases for the database datasets, or want to control the creation and printing of an audit
trail during the Edit function.
Dynamic PSB
File-AID for IMS dynamically builds the PSB used to access databases in the Browse, Edit,
Initialize, Extract, and Load functions in DL/I and BMP modes. This PSB is available only
for the duration of the function and is deleted after the function ends. Each segment in
the DBD is included in the generated PSB, except those that are specifically excluded by
the user (Browse and Edit only). For the Initialize, Extract, and Load functions, PCBs are
included for the primary database and all the databases related to the primary database.
DL/I mode
The dynamic PSB is used as-is for database access.
BMP mode
The dynamic PSB is used as input to create an ACB.
Listed below are several advantages of using dynamic PSBs:
• You do not have to know and inform File-AID for IMS which PSB includes the
necessary access (PCB) for the database you need to edit or browse. You only need to
tell File-AID for IMS which database to use and whether the function is Edit or Browse,
and File-AID for IMS will generate the PSB for IMS to use.
• The PSB will have the processing options set based on the required function. That is,
if the function is Edit, the processing option is A, which provides get, insert, delete,
and replace capability. If the function is Browse, the processing option is GO, which
provides the get only function without locking.
• File-AID for IMS generates a PSB with two PCBs for the database. When doing a repeat
all function, File-AID for IMS gets segments using one PCB and inserts the segments
using the other PCB. This process makes some of the restrictions required when using
a static PSB unnecessary when doing a repeat all that involves segments without a
unique key.
Note:
Dynamic PSB processing may be disabled using a type "I", IMS Initialization,
security exit. (See Appendix E, “File-AID for IMS Exits” for information on exit
types.) The following PL/1 code is an example of how to disable dynamic PSB
processing:
7-4
File-AID Single Install Image Installation and Configuration Guide
IF PRMSCXT_PSB_TYPE = 'D' THEN DO; 
PRMSCXT_ALLOW_IND = 'N';
PRMSCXT_MESSAGE
= USER_MSG_NUM100;
END;
IMPORTANT
Here are a few reminders concerning the BMP installation:
– An APPLCTN macro must be included in the IMS stage 1 GEN input using the
specified ACB names. For example:
APPLCTN DOPT,PSB=FAIMS000,PGMTYPE=(BATCH,,,)
This example identifies the PSB name, FAIMS000, to IMS as a BMP PSB using the
dynamic option.
Note:
Cold start IMS or perform an online change after the GEN process to
bring in the new APPLCTN macros.
– The IMS startup JCL must include the DOPT ACB library named in the
BMPPARMS as part of the ACBLIB concatenation IMSACBA and IMSACBB DD
statements. This library must be included in the control region as well as the
DLI/SAS region JCL. The DOPT ACBLIB must be concatenated after the static
ACBLIBs. If the library already exists, File-AID uses the existing DOPT ACBLIB if
it is named in the BMPPARMS.
– If you have an existing security package, you may have to identify the BMP to
the security product.
Static PSB
File-AID for IMS/ISPF analyzes the designated PSB to determine which databases are
included and what processing options are provided. The users can then designate which
databases they want to use. Users can exclude segments if they want. File-AID for IMS/ISPF
then initiates DL/I or BMP processing using the designated PSB. Within the DL/I or BMP
scheduling, users can access any of the databases they previously selected.
Following are several advantages of using static PSBs:
• The normal IMS authorization mechanism is more applicable. Normally authorizing
a user to a PSB determines which databases the user can access and what functions
the user can perform. This is true using a static PSB. Using a dynamic PSB, the PSB
name cannot be used for authorization purposes. When using a dynamic PSB, the
File-AID for IMS security exit can be used to provide authorization.
• For BMP processing it is not necessary to update the IMS GEN with new APPLCTN
macros for the names of the DOPT PSBs.
• For BMP processing it is not necessary to provide an ACBLIB for the ACBGENs for the
DOPT PSBs.
• If it is necessary, multiple databases can be edited within one edit session more
efficiently using a static PSB that provides access to all the databases.
• A static PSB can limit the update capability during Edit so that a user could, for
example, perform replaces but not deletes.
• IMS Batch Backout requires that the same PSB be used for backout as when the
changes were made. This PSB is available when using a static PSB. Refer to the File-AID
for IMS/ISPF Reference manual for a description of how this is done for a dynamic PSB.
File-AID for IMS/ISPF Product Configuration
7-5
ACB Processing (Dynamic PSBs Only)
File-AID for IMS/ISPF dynamically builds the ACB used to access databases when running
in BMP mode. The ACB is created from the dynamic PSB generated earlier and from the
DBDs in the user-specified DBD library. The ACB is written to the DOPT ACBLIB (as
specified in the environment definition) prior to attaching DFSRRC00.
IMS System Definition
Dynamic PSB
When processing in BMP mode, File-AID for IMS/ISPF is like any other IMS application
and must be defined to the IMS system. An APPLCTN macro must be input to the IMS
stage 1 system definition job for each ACB name to be used by File-AID for IMS/ISPF (as
specified in the environment definition).
The IMS control region start up JCL should be modified to include both the static and
DOPT ACBLIBs. There may also be a need to increase the PST to accommodate the sum of
BMP regions that can be running plus the number of message regions. This procedure
provides for dynamic allocation of regions.
Because File-AID for IMS/ISPF dynamically creates ACBs required for database access, the
dynamic ACB option (DOPT) must be specified on the APPLCTN macro. When you
specify DOPT, the ACB is read from the ACB library each time a program using that ACB
is scheduled. This procedure allows the dynamically built ACB to be immediately
available for use.
Note: IMS stage 1 system definitions are not necessary if you do not use BMP processing
with File-AID for IMS/ISPF.
Static PSB
If the IMS system already has existing PSBs that can be used for processing in BMP mode,
then no new IMS definitions are required. If the IMS system does not have the
appropriate PSBs available, then the applicable PSBGENs, ACBGENs, and additional
APPLCTN definitions need to be provided.
ACB Libraries (Dynamic PSBs Only)
When processing in BMP mode, the dynamic ACB is written to the dataset specified in
the DOPT ACBLIB field (as specified in the environment definition). There are some IMS
restrictions on the ACB libraries because File-AID for IMS/ISPF requires that the
application be defined with the Dynamic Option (DOPT).
There must be at least two ACBLIB datasets concatenated to the IMSACB DD name in IMS
to use dynamic ACBs. The first or primary ACBLIB dataset contains the blocks for all
nondynamic ACBs. DOPT ACBs must never be built into the primary ACBLIB dataset. The
other ACBLIB datasets can contain blocks for the dynamic (DOPT) ACBs as well as
additional blocks for the nondynamic ACBs.
If your installation already has two or more ACBLIB datasets concatenated in IMS, you
can use them for File-AID for IMS/ISPF processing (do not use the primary ACBLIB - see
above). However, there are certain advantages to allocating a new ACBLIB dataset
exclusively for File-AID for IMS/ISPF’s use:
1. COMPRESSION
If you specify Y in the RESET ACBLIB INDICATOR field (as specified in the
environment definition), File-AID for IMS/ISPF automatically resets (empties) the
DOPT ACBLIB dataset before each use. If you specify N, File-AID for IMS/ISPF is
prevented from resetting the dataset. If your installation submits a high volume of
7-6
File-AID Single Install Image Installation and Configuration Guide
File-AID for IMS/ISPF BMP jobs, not resetting the ACBLIB could cause dataset space
problems.
CAUTION:
Use this option only if the DOPT library is used exclusively by File-AID for
IMS/ISPF.
2. SECURITY
You can limit updating this library to File-AID for IMS/ISPF by using your existing
system security to prevent unauthorized users from generating their own DOPT
ACBs.
If you allocate a new ACBLIB dataset for File-AID for IMS/ISPF’s use, it must be
concatenated to the IMSACBA and IMSACBB DDs in the IMS start up JCL.
BMP Security
File-AID for IMS/ISPF processing invokes the IMS control program in batch (DL/I) and
BMP modes. There are certain security issues that need to be considered when executing
a BMP job against online IMS databases.
Normal IMS security for dependent (BMP) regions restricts ACB usage to certain users.
Users must have authority to the use of ACB. When using a static PSB, this normal IMS
security is applicable. However, it is not applicable when using a dynamic PSB.
When using dynamic PSBs, all File-AID for IMS/ISPF dynamically generated ACBs for the
selected BMP environment have the same names for all users. These ACBs allow access to
any DBD that exists in the DBD library entered by the user. Following are several options
that are available to control access to your online IMS databases:
• Do not allow any users to use File-AID for IMS/ISPF in BMP mode. By not entering any
BMP information, File-AID for IMS/ISPF does not operate in BMP mode. The batch
(DL/I) mode is still available, and normal dataset security, as implemented by your
system security package, is in effect.
• Only allow authorized users to use File-AID for IMS/ISPF in BMP mode for any
database. To do this, use normal IMS security to restrict access to these ACBs to
authorized users. All other users are able to access the databases in batch (DL/I) mode
with normal dataset security in effect.
• Allow authorized users to use File-AID for IMS/ISPF processing in BMP mode for
certain databases. This method provides the most flexibility in allowing or denying
access to online databases. To implement this method, you must code a File-AID for
IMS/ISPF security exit program. Refer to Appendix E, “File-AID for IMS Exits” for
more information.
Configuration Procedures
Configuration Prerequisites
Before continuing with the File-AID for IMS/ISPF configuration you must have configured
the File-AID Common Component module XVJOPUNV (see “Step 2. Specify File-AID
Common Component Parameters” on page 2-7) and the IMS Environment Module
XVJOPIMS (see “Step 3.2. Specify IMS Environment (Option 2)” on page 2-39). If your
site also uses the File-AID Data Privacy plugin of the Compuware Workbench, you must
have configured the Data Privacy module XVJOPDPR (see “Step 3.3. Specify File-AID
Data Privacy (Option 3)” on page 2-55).
File-AID for IMS/ISPF Product Configuration
7-7
Step 1. Select File-AID for IMS/ISPF
Select option 3 from the “Configuration Facility Menu” (Figure 2-2 on page 2-4) to
display the File-AID “Product Configuration Menu” (see Figure 7-1). It lists all File-AID
mainframe products.
Figure 7-1. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD














Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
9
START - Start products to verify installation 

XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE
Select Option 5, File-AID for IMS/ISPF.
Step 2. Specify Source of Product Parameters
When selecting Option 5 File-AID for IMS/ISPF from the “Product Configuration Menu”
(Figure 7-1 on page 7-7) the “Source of Product Parameters” screen displays, prompting
you to specify the installation dataset of the previously installed product release or the
name of a load library containing File-AID Configuration modules in order to populate
product specific parameters.
Figure 7-2. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):
Previous install dataset . .
OR
Configuration library . . .
Press ENTER to continue. 






7-8
File-AID Single Install Image Installation and Configuration Guide
1. Specify either
– the name of a File-AID for IMS/ISPF install dataset prior to Release 10.1
OR
– the name of the File-AID Configuration (load) library that includes a File-AID for
IMS/ISPF XVJOPXIX module you want to use as a source for your parameter input
OR
– Leave both fields blank if this is your initial installation of File-AID.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
If you leave the Previous Install dataset as blank, it will be ignored. A valid
previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID for IMS/ISPF,
then you may retain the previously specified variable values. This is
accomplished by specifying the name of the install dataset (e.g.
hlq.CPWR.BG121116.INS or hlq.COMPWARE.MXIX760.INSTALL) that was
previously used to install File-AID for IMS/ISPF product.
When specifying an unsupported install dataset, this pop-up message displays:
CANNOT IMPORT CONFIGURATION VALUES FROM

THE SPECIFIED DATASET

'TSOID01.IX.V070200.INSTALL'


DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINXIX) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters; product installation
defaults are used when previous variable values cannot be imported. You
must visit Option 2, SPECIFY PARMS (see “Step 3. Review Target and
Configuration Module Libraries” on page 7-9) to verify the variable
values.
Configuration library : Leave blank if you want to preserve the product installation
defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a File-AID for IMS/ISPF XVJOPXIX module which you want to use as a source for
your parameter input.
If you want to use a preexisting XVJOPXIX parameter module (v10.1 or higher),
you can specify the name of the dataset that contains it. If a valid parameter
module is found, ALL values will be initialized from there. If the utility finds a
CXVJLOAD dataset with a hlq that matches the SXVJSAMP you are executing
from AND a valid parameter module is found, this field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID for IMS/ISPF
Product Configuration Menu” shown in Figure 7-3 on page 7-9 which lists the
File-AID for IMS/ISPF Product Configuration options.
File-AID for IMS/ISPF Product Configuration
7-9
Figure 7-3. File-AID for IMS/ISPF Product Configuration Menu


File-AID ------------------- Product Configuration ---------------------------
OPTION ===>

Product.... File-AID for IMS/ISPF

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 7-7). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARM module.
Configuration Output : Identifies the configured load library to which the File-AID for
IMS/ISPF module XVJOPXIX will be saved.
The available options in the “File-AID for IMS/ISPF Product Configuration Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
• CUSTOMIZE: Generate customized objects.
Select one of the available options.
Step 3. Review Target and Configuration Module Libraries
Select Option 1 from the “File-AID for IMS/ISPF Product Configuration Menu” to display
the “Dataset Name Specification” panel (Figure 2-6 on page 2-11) to review the list of the
File-AID Target and Configuration Module Libraries. Scroll down to view all the libraries.
Refer to Table 2-2 on page 2-11 for a listing and description of the libraries. This is a
display only list; to change any File-AID library names, return to “Step 2.1 Specify
Configuration Module Dataset Names” on page 2-10.
Step 4. Specify File-AID for IMS/ISPF Product Configuration Parameters
Select Option 2 from the “File-AID for IMS/ISPF Product Configuration Menu” to display
the “File-AID for IMS/ISPF Product Configuration Parameters” panel (Figure 7-4 on page
7-10). Option 2 allows you to specify values for variables that the Configuration Facility
uses to configure File-AID for IMS/ISPF. A listing of all the variables is provided in Table 71 on page 7-10.
7-10
File-AID Single Install Image Installation and Configuration Guide
The first time you select Option 2, and you didn’t specify either a previous install or
Configuration library, the Configuration Facility populates the parameter variables with
the default values delivered with the product.
Edit the parameter values to configure File-AID for IMS/ISPF to your site’s desired settings.
Use the HELP command (PF1) to receive information on using this screen.
After entering and reviewing the desired values, Press END (PF3) to continue to the Edit
JCL screen (Figure 7-5 on page 7-12) where you can submit the job to assemble the
File-AID for IMS/ISPF parameter module XVJOPXIX and save your changes, or CANCEL to
exit the screen without saving your changes.
Figure 7-4. File-AID for IMS/ISPF Product Configuration Parameters

File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>


Product.... File-AID for IMS/ISPF
Version.... 10.02.00
Variable
-------CODEPAGE
LANGMODE
DATAFMT
PSBSORD
SRTMSGDD
TAPEUNIT
ADMININD


Value
Description

--------------------------------------------------------------------- 
More:
+ 
Code page to be used for screen display and printing.

0697
(0697,0905,0277,0297,0424,0500,0290,0833,0838,HI40
Default=0697
Default language for layout datasets 
C
(C=COBOL, P=PL/I) Default=C
Default data format for Japanese terminals.

E
(E = EBCDIC, M=MIXED D=DBCS) Default=E
Default PSB processing mode 
D
(D=Dynamic, S=Static) Default=D
DD name to use for sort messages.

SYSOUT
Default=SYSOUT 
Unit to use for tape/cart processing.

CART
Default=CART
Admin option on product panel.
N
(Y=YES or N=NO) Default=N
Change any of the variable values as required for your site.
Table 7-1 lists the File-AID for IMS/ISPF Product Options and their descriptions.
Table 7-1.
File-AID for IMS/ISPF Product Options
Label
Default Value Your Value
Description
CODEPAGE
0697
User Default CODEPAGE.
Code page to be used for screen display and printing.
0697 - English (Default)
0905 - Canadian Bilingual
0277 - Danish/Norwegian
0297 - France
0424 - Hebrew
0500 - Swiss French/Swiss German
0290 - Japanese Katakana
0833 - Korea
0838 - Thailand
HI40 - Display hex 40-FE
LANGMODE
C
Default language for layout datasets.
(C=COBOL,P=PL/I) Default=C
C = COBOL
P = PLI
File-AID for IMS/ISPF Product Configuration
Table 7-1.
7-11
File-AID for IMS/ISPF Product Options (Continued)
Label
Default Value Your Value
Description
DATAFMT
E
Default data format for Japanese terminals.
(E=EBCDIC; M=Mixed; D=DBCS) Default=E
User default data format Non-Japanese terminals
always use EBCDIC.
E = EBCDIC
M = Mixed
D = DBCS
PSBSORD
D
Default PSB processing mode:
(D=Dynamic,S=Static) Default=D
D = dynamic PSB
S = static PSB.
SRTMSGDD
SYSOUT
DD name to use for sort messages.
Default=SYSOUT
TAPEUNIT
CART
Unit to use for tape/cart processing.
Default=CART
ADMININD
N
Admin option on product panel.
(Y=YES,N=NO) Default=N
Yes will allow all users access to the IMS environment
configuration option (Option A, Administration, on
the Parameters Selection Menu, same as IMS
Environment Option in “Step 3.2. Specify IMS
Environment (Option 2)” on page 2-39).
SMFRCD
0
SMF Audit record number. 
(0=unused, 128-255) Default=0
SMF Audit Record ID.
0 = SMF Audit not used.
n = a number between 128 and 255.
RDXSFPRI
2000
CYLINDERS for primary allocation of Disguise split
files
Default=2000
Allocation limit for the split file primary allocation
value during the disguise process. Specify the amount
in cylinders.
RDXSFSEC
2000
CYLINDERS for secondary allocation of Disguise split
files
Default=2000
Allocation limit for the split file secondary allocation
value during the disguise process. Specify the amount
in cylinders.
MAXDNLIM
0
Max GET NEXT calls for page down in File-AID Data
Editor.
(0=unlimited, 1-999999) Default=0
Maximum Download Limit (required if using File-AID
Data Editor component of the Compuware
Workbench)
How many GET NEXT calls should be allowed when
processing a maximum page down request using the
File-AID Data Editor before processing is interrupted?
If 0 is entered, no limit will be imposed.
Step 5. Review and Submit JCL
After entering the desired parameter values in the “File-AID for IMS/ISPF Product
Configuration Parameters” panel (Figure 7-4 on page 7-10), enter END (PF3) to continue
to the Edit JCL screen (Figure 7-5 on page 7-12).
7-12
File-AID Single Install Image Installation and Configuration Guide
Review the generated JCL and SUBMIT the job to assemble the File-AID for IMS/ISPF
parameter module XVJOPXIX. Submitting the JCL also saves the changes you made in
the “File-AID for IMS/ISPF Product Configuration Parameters” panel (Figure 7-4 on page
7-10).
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Product Configuration Menu”, the changes you made in the “File-AID for
IMS/ISPF Product Configuration Parameters” panel (Figure 7-4 on page 7-10) will NOT be
saved.
Figure 7-5. Edit JCL Screen for File-AID for IMS/ISPF Parameter Module XVJOPXIX
EDIT
TSOID01.CPWR.MXVJA20.WORK($XIX01) - 01.00
Columns 00001 00072 
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*____________________________________________________________________ 
000007 //*
| 
000008 //*
C O M P U W A R E C O R P O R A T I O N
| 
000009 //*
| 
000010 //*
F I L E - A I D F O R I M S / I S P F
| 
000011 //*
| 
000012 //*
S Y S T E M M O D I F I C A T I O N
| 
000013 //* ---------------------------------------------------------------- | 
000014 //*
| 
000015 //*
A S S E M B L E X I X M O D
L O A D M O D U L E
| 
000016 //*
--------------- ------------------------------| 
000017 //*
| 
000018 //* STEP
FUNCTION
|
000019 //* ---------------------------------------------------------|
Step 6. Review Job Output
When you receive the job completion message, review the job output and verify that
File-AID for IMS/ISPF Parameter Module XVJOPXIX has been created or updated.
Step 7. Generate Customized Objects
Select Option 3 from the “File-AID for IMS/ISPF Product Configuration Menu” to display
the “File-AID for IMS/ISPF Customization Tasks Menu” panel (Figure 7-6 on page 7-13).
Option 3 provides instructions on what jobs need to be run for various defined exits.
File-AID for IMS/ISPF Product Configuration
7-13
Figure 7-6. File-AID for IMS/ISPF Customization Tasks Menu
File-AID ------------------- Customization Tasks ----------------------------
OPTION ===>

Product.... File-AID for IMS/ISPF

Version.... 10.02.00


-----------------------------------------------------------------------------
More:
+ 
The Following JCL members can be found in the SXVJSAMP library:


1) Security Exit PROC JCL (for ASM, COB, PLI, or Default):


XIXSCXTA - Assembler - Assemble and Link Security Exit


XIXSCXTC - COBOL - Compile and Link Security Exit


XIXSCXTP - PLI - Compile and Link Security Exit


XIXSCXTR - Reset Security Exit to Default


2) Application-Relationship Exit


XIXAPLA
- Assemble and Link an Assembler Exit


XIXAPLC
- Compile and Link a COBOL Exit 


1) Security Exit PROC JCL (for ASM, COB, PLI, or Default)
File-AID for IMS/ISPF provides a security exit that is invoked prior to each IMS initiation
and termination, prior to the allocation of each database dataset, and prior to allocating
and opening each non-database dataset used during File-AID for IMS functions. The
default security exit program performs no security checking and returns control
immediately to File-AID for IMS/ISPF, which allows normal processing to continue.
Refer to “File-AID for IMS/ISPF Security Exit” on page E-1 if you require special log
dataset processing, additional database security, want to change the File-AID for IMS
default database dataset allocation (the default for edit is OLD unless using a DBRC
registered dataset, then it is SHR), want to override the DFSRRC00 parameters specified in
the installation parameters, want to substitute different dataset names or allow
shorthand aliases for the database datasets, or want to control the creation and printing
of an audit trail during the Edit function.
The following sample security exit programs are provided in the File-AID sample library
SXVJSAMP:
•
•
•
•
•
•
ACF2SCXT - Assembler language interface to ACF2
PLISCXT - PL/I self-contained security exit program
RACFSCXT - Assembler language interface to RACF
COBSCXT - COBOL self-contained security exit program
TSSSCXTA - Assembler language interface to Top Secret
TSSSCXTC - COBOL language interface to Top Secret
You can copy the model code from the sample library into a library you specify and
modify as needed for your site.
The following JCL members are provided in the File-AID sample library SXVJSAMP:
•
•
•
•
XIXSCXTA
XIXSCXTC
XIXSCXTP
XIXSCXTR
- Assembler - Assemble and Link Security Exit
- COBOL - Compile and Link Security Exit
- PLI - Compile and Link Security Exit
- Reset Security Exit to Default
Use the appropriate JCL member to compile or assemble and link-edit a security exit.
Use XIXSCXTR to restore the original default security exit that was shipped with File-AID
for IMS.
7-14
File-AID Single Install Image Installation and Configuration Guide
2) Application Relationship Exits
An Application Relationship exit module is an optional user-written module called
during the extract process. This exit module is called after the target key is constructed
from the source segment fields. This exit module (also known as the source segment exit
module) can manipulate the target key and include up to nine other target root keys to
be extracted. Refer to “Application Relationship Exit” on page E-23 for more information.
The following sample application relationship exit programs are provided in the File-AID
sample library SXVJSAMP:
• ARCOBXT - COBOL application relationship exit
• ARPLIXT - PL/I application relationship exit
• ARASMXT - Assembler application relationship exit
You can copy the model code from the sample library into a library you specify and
modify as needed for your site.
The following JCL members are provided in the File-AID sample library SXVJSAMP:
• XIXAPLA - Assemble and Link an Assembler Exit
• XIXAPLC - Assemble and Link a COBOL Exit
• XIXAPLP - Assemble and Link a PLI Exit
Use the appropriate JCL member to compile or assemble and link-edit an application
relationship exit.
3) Segment Control Exit
The Segment Control Exit Table provides File-AID for IMS/ISPF with the names of the
segments that have a segment control exit specified. A sample Assembler segment control
exit table, SEGXTTAB, is provided in the File-AID sample library SXVJSAMP. Refer to
“File-AID Segment Control Exit” on page E-15 for more information.
You can copy the model code from the sample library into a library you specify and
modify as needed for your site.
Use JCL member XIXSGMT in the File-AID sample library SXVJSAMP to assemble and
link-edit the segment control exit table.
The following sample segment control exit programs are provided in the File-AID sample
library SXVJSAMP:
• ASMSEGXT – Assembler segment control exit program
• COBSEGXT – Cobol segment control exit program
• PLISEGXT – PL/I segment control exit program
You can copy the model code from the sample library into a library you specify and
modify as needed for your site.
The following JCL members are provided in the File-AID sample library SXVJSAMP:
• XIXSGMA - Assemble and Link an Assembler Exit
• XIXSGMC - Assemble and Link a COBOL Exit
• XIXSGMP - Assemble and Link a PLI Exit
Use the appropriate JCL member to compile or assemble and link-edit a segment control
exit program.
Step 8. Static Link of XIXINTF (Optional)
Three load modules created during the File-AID installation can be link-edited into the
XIXINTF load module. These modules are:
File-AID for IMS/ISPF Product Configuration
7-15
• XIXSCXT: User Security Exit, see also “File-AID for IMS/ISPF Security Exit” on
page E-1.
• XIXSCTAB: Segment table used by the Segment Control Exit, see also “Activating
Segment Control Exits” on page E-17.
• XIXTDLI: IMS Database Call Interception Exit, see also “XIXTDLI User Exit” on
page E-26.
Although an extremely small gain in system performance is achievable from this practice,
static linkage ties these modules to a particular release and maintenance level of File-AID
for IMS. If maintenance is applied to the XIXINTF load module, the static link of
these modules must be redone.
However, some installations may have reason to statically link certain File-AID for IMS
load modules into the XIXINTF load module. If you want to statically link one or more of
these modules into XIXINTF, sample JCL found in the File-AID SXVJSAMP library
member JCLSTAT is provided for this purpose. In order to use this JCL, you must make all
modules involved in the link-edit step accessible through the SYSLIB concatenation. Edit
the JCL to remove any INCLUDE statements for load modules that do not exist or that
you do not want to include in XIXINTF.
To remove the statically linked modules, remove the XIXINTF module from the
CXVJLOAD library and use the SMP/E installed copy in the SXVJLOAD dataset.
What’s Next?
After you have completed the configuration of File-AID for IMS/ISPF, press END until you
return to the “Product Configuration Menu” (Figure 7-1 on page 7-7).
Either
• select the next File-AID product to configure from the “Product Configuration
Menu” (Figure 7-1 on page 7-7).
Or
• continue with “Step 4.9 START” on page 2-67 to start File-AID for IMS/ISPF and verify
the product installation. Refer to Chapter 11, “Verifying File-AID Installation” for
suggested verification procedures.
7-16
File-AID Single Install Image Installation and Configuration Guide
8-1
Chapter 8.
File-AID for IMS/CICS Product Configuration
Chap 8
Product Overview
File-AID for IMS/CICS is an interactive, full-screen product designed for use by application
programmers, analysts, and database administrators. It provides the ability to easily
access and manipulate data within IMS databases. The databases can be browsed or edited
in any of the following modes directly under CICS:
• Formatted using COBOL or PL/I segment layouts
• Unformatted in hexadecimal
• Hierarchical sequence with one segment per screen line
File-AID for IMS/CICS executes as a pseudo-conversational, command level, online
program that requires absolutely no modifications to CICS, DL/I, or any other existing
software. Resource Definition must be used to define File-AID for IMS/CICS to the CICS
system.
The File-AID for IMS system, not including user database DBDs and PSBs, consists of the
following:
• Product Load modules
• 4 BMS Mapsets (each containing multiple maps)
• 3 Control Databases
• 3 Control DBDs
• 1 or more Transactions
• 1 or more PSBs/ACBs
File-AID for IMS/ISPF Option 7 Xref must be installed to create and maintain the
segment/layout cross-reference data used by File-AID for IMS/CICS.
Installation Configuration
The two basic configurations used to run File-AID for IMS/CICS are single transaction and
multiple transaction. The type of configuration used affects the steps taken during
installation.
Single Transaction Configuration
Use a single transaction configuration if:
1. Your installation has only one programming group.
2. The number of databases does not exceed the number practical for a single PSB.
File-AID for IMS/CICS allows a maximum of 500 PCBs in a PSB.
3. Transaction security will be the same for all users.
4. Including all the databases in one PSB will not exceed your installation’s PSB pool
size (refer to “PSB Tailoring” on page 8-5).
8-2
File-AID Single Install Image Installation and Configuration Guide
In a single transaction configuration, only one transaction code is used to invoke
File-AID for IMS/CICS. A maximum of 495 user database PCBs can be included in the PSB
associated with the transaction (File-AID for IMS/CICS uses five PCBs in the PSB),
provided that the resulting ACB does not exceed your IMS PSB pool size. Security can be
based on the transaction name and can be enhanced by using the File-AID for IMS security
exit, other security products (e.g., RACF, CA ACF2, CA TOP SECRET), or both.
Multiple Transaction Configuration
Use a multiple transaction configuration if:
1. Your installation has more than one programming group and each group needs
access to different sets of databases.
2. The number of databases exceeds the number practical for a single PSB. File-AID for
IMS/CICS allows a maximum of 500 PCBs in a PSB.
3. Transaction security will vary with different programming groups.
4. Including all the database PCBs in one PSB will exceed your installation’s PSB pool
size (refer to “PSB Tailoring” on page 8-5).
In a multiple transaction configuration, two or more transaction codes are used to invoke
File-AID for IMS/CICS. Each transaction code is associated with a different PSB. Each PSB
contains PCBs for a set of databases. A maximum of 495 user database PCBs may be
included in each PSB (File-AID for IMS/CICS uses five PCBs in the PSB), provided that the
resulting ACB does not exceed your IMS PSB pool size. Each transaction can have
different security requirements to allow more lenient access to certain databases.
Transaction security can be enhanced by using the File-AID for IMS security exit, other
security products, or both.
Refer to “4) Static Link of XVJOPNIX (Optional to support multiple XVJOPNIX modules)”
on page 8-24 for more information.
Naming Conventions
File-AID for IMS/CICS enables you to customize BMS mapset, program, PSB, DBD, and
transaction names to your installation’s naming conventions. However, certain rules
must be followed so that File-AID for IMS/ISPF can find the modules it needs during
execution. The following table summarizes these rules.
Table 8-1.
Naming Convention Rules
Module
Format of Name
Restrictions
Default
TRANSACTION
1 to 4 characters
None
IXC
PSB
1 to 4 character prefix
1 to 4 character suffix
None
Must Match Tran Code
IXC
IXC
DBD
1 to 8 characters
None
See Source Code
BMS MAPSET
1 to 4 character prefix
None
3 character suffix
Cannot Change
1 character mapset suffix Must Be Blank or M
IXC
See Load Modules
Blank
MAIN PROGRAM
1 to 8 characters
None
IXCMAINa
OTHER PROGRAMS
1 to 4 character prefix
3 to 4 character suffix
None
Cannot Change
IXC
See Source Code
a.the main program name (default IXCMAIN) is replaced with the value you specified for
variable “MAINPGM” on page 8-15.
Transaction and DBD names can be completely modified. However, the BMS mapset
names, program names, and PSB names must adhere to the rules listed above.
File-AID for IMS/CICS Product Configuration
8-3
The first one to four characters of the default program names (other than the main
program’s), BMS mapset names, and PSB names can be partially modified to meet your
installation’s requirements. The characters that can be modified are referred to as the
prefix (see Figure 8-4 “File-AID for IMS/CICS Product Configuration Parameters” on page
8-14). You can use a different prefix for the PSB, BMS mapsets, and program names. The
default prefix for the three resources is IXC.
The remaining characters (the suffix) of the program names cannot be modified. The
suffix of the BMS mapset names can be modified by appending the letter M to the three
character suffix. This modification provides better performance when the SIT parameter,
BMS=DDS, is coded. If you append the letter M, then the Resource Definition must also
be modified to reflect this change. The suffix of the PSB name can be modified, but it
must match the transaction code. The main program’s name (default IXCMAIN) can be
completely changed using parameter variable “MAINPGM” on page 8-15.
Before starting the installation process, determine what names and prefixes your
installation will be using.
Audit Trail Feature
The File-AID for IMS Audit Trail feature is an option that captures user updates to a
database into the File-AID for IMS’ Audit Trail (AUD) control database. The database
update information can then be extracted from the AUD control database with the batch
Audit Trail extract program (XIXATEXT). This extracted information is then sorted and
processed by the batch reporting program (XIXATRPD), which generates the Audit Trail
Report.
The end users of File-AID for IMS do not have any control over which databases are
protected by the Audit Trail feature and which are not. Those decisions are made and
administered at the installation level by the individual or group responsible for File-AID
for IMS. The user database updates that are to be captured by the Audit Trail feature are
specified in the File-AID for IMS installation parameters described in “1) Assemble and
Link IMS Modules (Required)” on page 8-19, the Security Exit described in “File-AID for
IMS/CICS and File-AID for IMS/DC Security Exit” on page E-30, or both.
The Audit Trail Extract program (XIXATEXT) and the Audit Trail Report program
(XIXATRPD) are actually part of File-AID for IMS/ISPF. These programs can be run as DLI
batch or BMP jobs. These programs and the sort of the extracted audit trail information
are described in the File-AID for IMS/CICS and File-AID for IMS/DC Reference manual.
Compuware recommends that you decide whether you want to use the Audit Trail feature
at your installation before you actually begin to install File-AID for IMS. If you don’t want
to use the Audit Trail feature immediately but think you may want to in the near future,
it is simpler to include the Audit Trail feature in the installation process. You can include
the necessary Audit Trail control database information into the installation process and
still disable the Audit Trail feature through the File-AID for IMS configuration parameters.
If you add the Audit Trail feature later you will be required to execute several of the
installation steps (e.g., regenerate PSBs and ACBs) again.
Each step of the installation process described in this guide that can be affected by the
use of the Audit Trail feature contains an appropriate explanation.
DBD Tailoring
File-AID for IMS uses three databases to store information created or used during
execution. These databases are referred to as control databases. Two of the control
databases are required and one is optional.
The LTM control database is required and is used to store information between
transactions. It is updated as each transaction ends, before the screen is displayed. The
other required control database is CLT, which contains static information about the user
databases, including segment layouts. The CLT control database is updated primarily by
8-4
File-AID Single Install Image Installation and Configuration Guide
the DBD Update and XREF Update batch programs. The use of these programs is
described in the File-AID for IMS/CICS and File-AID for IMS/DC Reference manual.
The third control database is the optional AUD or Audit Trail control database. If you
choose to use the Audit Trail feature of File-AID for IMS at your installation, the AUD
database is used to capture the update activity processed against the databases you
specify. It is not necessary to create the AUD control database if you choose not to use
the Audit Trail feature at your installation.
All three control databases use the HDAM access method and IBM’s randomizing module
DFSHDC40. There are two parameters that are input to this randomizing module that
must be altered to your installation’s requirements—the Relative Block Number (RBN)
and the Root Addressable Area size (BYTES). These parameters are specified in the
RMNAME= keyword in the DBD statement for each of the three control database DBDs.
To calculate the RBN parameter for the LTM control database, multiply the estimated
number of users who will be using File-AID for IMS (allow for growth) by 1.20. To
calculate the RBN for the CLT control database, add the number of user databases to the
number of layouts for the segments in those databases (allow for growth), and multiply
this number by 1.20.
Calculate the RBN parameter for the AUD database as follows:
• Decide how often you plan to extract and delete the Audit Trail database segments
(by executing the XIXATEXT program as described in the File-AID for IMS/CICS and
File-AID for IMS/DC Reference manual.
• Estimate the typical total number of segment updates (inserts, repeats, deletes, and
replaces of all database segment types) that will take place at your installation across
all user databases where the Audit Trail feature will be active between the planned
extraction and deletion of the Audit Trail database segments.
• Divide the number of total updates by 16.
The resulting value is the RBN used for the AUD control database. For example, if you
plan to extract and delete the segments from the Audit Trail database every two days and
the daily segment updates total is estimated at 400, then the RBN is calculated as (2 *
400)/16 = 50.
Refer to the LTM and CLT databases table (page 8-4) to determine the Bytes parameter. In
the Maximum User DB Segment Length column, find the row that corresponds to your
installation’s maximum user database segment length. Within this row, find the BYTES
operand from the RMNAME Bytes column. Because the minimal SEGM bytes for the LTM
and CLT databases is 8,158 bytes, use the data from row one if all your user databases
have segment lengths less than 8,153 bytes. The same RMNAME bytes parameter must be
used for both the CLT and LTM databases. Also, based on the row selected, use the
corresponding CI/BLOCK value for the SIZE parameter in the DATASET statement in both
control databases.
Table 8-2.
LTM and CLT Databases
Maximum User DB
Segment Length
DBD Parameters
Dataset Allocation
Buffer Used
RMNAME
Bytes
SEGM 
Bytes
CI/BLOCK
RECSZ
8,153 or less
8,177
8,158
8,192
8,185
8,192
12,249 or less
12,273
12,254
12,288
12,281
12,288
16,345 or less
16,369
16,350
16,384
16,377
16,384
20,441 or less
20,465
20,446
20,480
20,473
20,480
24,537 or less
24,561
24,542
24,576
24,569
24,576
28,633 or less
28,657
28,638
28,672
28,665
28,672
File-AID for IMS/CICS Product Configuration
Table 8-2.
8-5
LTM and CLT Databases
Maximum User DB
Segment Length
30,681 or less
DBD Parameters
Dataset Allocation
Buffer Used
RMNAME
Bytes
SEGM 
Bytes
CI/BLOCK
RECSZ
30,705
30,688
30,720
30,713
30,720
To determine the BYTES parameter for the AUD database, you must first perform the
following steps:
1. Determine the length of the longest user database segment whose updates will be
captured by the Audit Trail feature. You can find this value specified for the BYTES=
keyword on the SEGM statement that defines each user database segment type in the
DBD source code for each database.
2. Determine the length of the longest fully concatenated key to a user database
segment whose updates will be captured by the Audit Trail feature. One way to
determine this value is to look for the largest KEYLEN= parameter value specified on
a PCB statement within the PSBs that contain an Audit Trail database PCB.
Add the longest segment length value to the longest concatenated key value. Then, find
the row that corresponds to the result in the Maximum User DB Segment Plus Concat Key
Length column in the AUD database table (page 8-5). Within this row, find the BYTES
operand from the RMNAME Bytes column. Because the minimal SEGM bytes for the AUD
database is 8,102 bytes, use the data from row one if the result you calculated is less than
8054 bytes. Also, based on the row selected, use the corresponding CI/BLOCK value for
the SIZE parameter in the DATASET statement in the AUD database.
Table 8-3.
AUD Database
Maximum User DB
Segment Plus Concat
Key Length
DBD Parameters
Dataset Allocation
Buffer Used
RMNAME
Bytes
SEGM
Bytes
CI/BLOCK
RECSZ
8,054 or less
8,117
8,102
8,192
8,185
8,192
12,150 or less
12,213
12,198
12,288
12,281
12,288
16,246 or less
16,309
16,294
16,384
16,377
16,384
20,342 or less
20,405
20,390
20,480
20,473
20,480
24,438 or less
24,501
24,486
24,576
24,569
24,576
28,534 or less
28,597
28,582
28,672
28,665
28,672
30,582 or less
30,615
30,630
30,720
30,713
30,720
Further modifications to the control database DBDs are explained in “Control Database
DBD Changes” on page 8-25.
PSB Tailoring
All PSBs used by File-AID for IMS must contain four PCBs for the CLT and LTM control
databases, as well as PCBs for the user databases. If the Audit Trail feature is going to be
activated for any of the user databases accessed through a given PSB, then a fifth PCB
must be coded for the AUD control database. In a single transaction configuration there
is only one PSB that will contain these PCBs.
However, in a multiple transaction configuration, there are usually multiple PSBs, each
with PCBs for the control databases and PCBs for a subset of the user databases. Some
8-6
File-AID Single Install Image Installation and Configuration Guide
thought must be given to grouping the user database PCBs into the PSBs. Following are
some suggestions:
1. Provide each programming group with its own PSB, which contains PCBs for the
databases that the group uses.
2. Group each set of application related databases into its own PSB.
3. Group databases that have strict access security in a PSB separate from databases that
have more lenient access.
4. Group test database PCBs in one PSB, production database PCBs in another.
Remember, a separate transaction code must be created for each PSB defined.
Note:
Each PCB within a PSB requires storage in the IMS PSB pool. In some
situations, depending on the number of PCBs in the PSB, the installation
limit for the IMS PSB pool size can be exceeded. If this limit is exceeded, you
must either split the PSB into smaller PSBs and create a separate transaction
for each PSB, or increase the IMS PSB pool size.
Following are some guidelines for creating PSBs:
1. The first four PCBs in the source code must be exactly as shown in “Modify PSBs” on
page 8-22. The fifth PCB is optional for the AUD control database.
2. The PROCOPT parameter on all user database PCBs should be A and should be
specified on the PCB macro and not the SENSEG macro. If you want to enforce
security using the PSBs, you can specify a PROCOPT parameter of G, GO, or GOT on
the user databases. This action causes File-AID for IMS to display an abend screen with
an AM status code and then the Primary Option Menu screen whenever one of these
user databases is edited.
3. To exclude a segment from processing by File-AID for IMS, simply leave the segment
out of the PCB. The excluded segment is not displayed nor updated.
4. Do not code more than one PCB per database within a single PSB. File-AID for IMS
cannot differentiate between them.
Resource Definition
File-AID for IMS/CICS runs like any other CICS application and, therefore, must be
initially defined to the CICS system. Because resource definition can be performed only
at specific times at your installation, it will speed the installation process if you do the
following before starting the detailed installation steps.
• If using Resource Definition Online (RDO), perform the following steps:
1. Code CEDA transactions to define the File-AID for IMS/CICS GROUP and
PROFILE to CICS.
2. Code a CEDA transaction for each transaction/PSB to be used in your
installation configuration. These transactions create entries in the Program
Control Table (PCT).
3. Code CEDA transactions for the ten programs and four mapsets that
comprise File-AID for IMS. These transactions create entries in the Processing
Program Table (PPT).
Note:
The first three characters of the module names are customizable
based on the “Program name prefix” (“PGMPRFX”) and “Mapset
name prefix” (“MAPPRFX”) which can be set during “Step 4. Specify
File-AID for IMS/CICS Product Configuration Parameters” on page
8-14.
• Perform the following steps to complete the resource definition:
File-AID for IMS/CICS Product Configuration
8-7
1. Code a DFSMDA macro for each of the control databases and the sample
databases, if desired. Use the procedures in place at your installation to make
them available to IMS (see “DFSMDA Macros:”). These macros are input to
the IMSDALOC procedure during CICS system definition.
DFSMDA Macros:
DFSMDA
DFSMDA
DFSMDA
DFSMDA
DFSMDA
DFSMDA
DFSMDA
DFSMDA
DFSMDA
DFSMDA
DFSMDA
DFSMDA
TYPE=DATABASE,DBDNAME=IXCCLT
TYPE=DATASET,DSNAME=XXXXXXX.IXCCLT,DDNAME=IXCCLTDD
TYPE=DATABASE,DBDNAME=IXCLTM
TYPE=DATASET,DSNAME=XXXXXXX.IXCLTM,DDNAME=IXCLTMDD
TYPE=DATABASE,DBDNAME=IXCAUD
TYPE=DATASET,DSNAME=XXXXXXX.IXCAUD,DDNAME=IXCAUDDD
TYPE=DATABASE,DBDNAME=PCUST
TYPE=DATASET,DSNAME=XXXXXXX.FICSAMP.CUSTOMER,DDNAME=PCUSTDD
TYPE=DATABASE,DBDNAME=PORDR
TYPE=DATASET,DSNAME=XXXXXXX.FICSAMP.ORDER,DDNAME=PORDRDD
TYPE=DATABASE,DBDNAME=PPART
TYPE=DATASET,DSNAME=XXXXXXX.FICSAMP.PART,DDNAME=PPARTDD
2. If you want the control databases and sample databases to be under the
control of DBRC, code an INIT.DB and INIT.DBDS command for each. These
commands are input to the Recovery Control Utility of DBRC.
INIT.DB DBD(IXCCLT) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(IXCCLT) DDN(IXCCLTDD) DSN(XXXXXXX.IXCCLT) GENMAX(2)
INIT.DB DBD(IXCLTM) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(IXCLTM) DDN(IXCLTMDD) DSN(XXXXXXX.IXCLTM) GENMAX(2)
INIT.DB DBD(IXCAUD) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(IXCAUD) DDN(IXCAUDDD) DSN(XXXXXXX.IXCAUD) GENMAX(2)
INIT.DB DBD(PCUST) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(PCUST) DDN(PCUSTDD) DSN(XXXXXXX.FICSAMP.CUSTOMER) GENMAX(2)
INIT.DB DBD(PORDR) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(PORDR) DDN(PORDRDD) DSN(XXXXXXX.FICSAMP.ORDER) GENMAX(2)
INIT.DB DBD(PPART) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(PPART) DDN(PPARTDD) DSN(XXXXXXX.FICSAMP.PART) GENMAX(2)
3. Code a DATABASE macro to define the required CLT and LTM control
database DBDs, and, optionally, the three sample database DBDs and the
AUD DBD. These macros are input to the IMS Stage 1 system definition job.
DATABASE
DATABASE
DATABASE
DATABASE
DATABASE
DATABASE
DBD=IXCCLT,ACCESS=EX
DBD=IXCLTM,ACCESS=EX
DBD=IXCAUD,ACCESS=EX
DBD=PCUST,ACCESS=EX
DBD=PORDR,ACCESS=EX
DBD=PPART,ACCESS=EX
If you want the Data Management Block (DMB) created by the database
statement to be made resident in storage during system initialization,
include the resident option on the database statement.
4. Code an APPLCTN macro for each PSB to be used in your installation
configuration. These macros are input to the IMS Stage 1 system definition
job.
APPLCTN PSB=IXCIXC
Online
Note:
For unspecified options, use the defaults or installation requirements.
CEDA ADD GROUP(IXCCICS) LIST(user-list)
CEDA DEFINE PROFILE(IXCPROF) GROUP(IXCCICS)
PCT
CEDA DEFINE TRANS(IXC) GROUP(IXCCICS) PROG(IXCMAIN) TWA(4)1
PROF(IXCPROF) TASKDATALOC(ANY)
8-8
File-AID Single Install Image Installation and Configuration Guide
PPT
CEDA DEFINE
CEDA DEFINE
CEDA DEFINE
CEDA DEFINE
CEDA DEFINE
CEDA DEFINE
CEDA DEFINE
CEDA DEFINE
(OPTIONAL)
CEDA DEFINE

CEDA DEFINE

CEDA DEFINE
CEDA DEFINE
CEDA DEFINE
CEDA DEFINE
PROGRAM(XVJOPNIX) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)
PROGRAM(IXCMAIN) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)1
PROGRAM(IXCEDTF) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)
PROGRAM(IXCEDTI) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)
PROGRAM(IXCEDTL) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)
PROGRAM(IXCEDTS) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)
PROGRAM(IXCEDTU) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)
PROGRAM(IXCKEY) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)
PROGRAM(IXCSCXT) GROUP(IXCCICS) LANGUAGE(PLI) EXECKEY(CICS) DATALOC(ANY)
PROGRAM(IXCEND)
GROUP(IXCCICS) LANGUAGE(COBOL) EXECKEY(CICS) DATALOC(ANY)
MAPSET(IXCMP1)
MAPSET(IXCMP2)
MAPSET(IXCMP3)
MAPSET(IXCMP4)
GROUP(IXCCICS)
GROUP(IXCCICS)
GROUP(IXCCICS)
GROUP(IXCCICS)
Space Allocation
The control databases require one dataset each. It is recommended that these databases
be allocated as VSAM files because of their segment sizes. If your installation does not
want to use VSAM, they can be allocated as OSAM files, but the ACCESS parameter of the
DBD macro within the DBD source must be modified to reflect this.
Use the following formulas to calculate the space needed by the control databases:
• LTM dataset size: 
bytes = RBN calculated earlier * CI size * 14
• CLT dataset size: 
bytes = RBN calculated earlier * CI size
• AUD dataset size: 
bytes = RBN calculated earlier * CI size
These formulas assume a stable user base. If you anticipate that the user base will grow,
you should factor this growth into the formulas before allocating the datasets.
Convert the number of bytes required to the number of cylinders required.
CLT Control Database
As mentioned earlier, the CLT control database contains information about the user
databases. A control segment, also found on this database, stores various counts and
control fields used to verify the database’s integrity. Most of this information remains
static during online File-AID for IMS/CICS execution. However, there are three batch
programs, herein referred to as DBD Update (XIXDBDUP), XREF Update (XIXXRFUP),
and Rebuild Control Segment (XIXREBLD), that are used to maintain the information on
the CLT database. These programs are actually part of File-AID for IMS/ISPF. The programs
can be run either as DLI batch or BMP jobs.
The DBD Update program updates the CLT control database with information about the
user databases’ hierarchical structure. The DBD Update program uses the DBD control
blocks from the DBD load library to obtain this information.
Note:
This job must be run for each database before it can be accessed under
File-AID for IMS/CICS.
The XREF Update program updates the CLT control database with information about the
segment-to-layout cross-reference. The XREF Update program uses the segment/layout
XREF data created in File-AID for IMS/ISPF option 7, along with the DBD information
gained by the DBD Update program. This job must be run to allow File-AID for IMS access
1. the main program name (default IXCMAIN) is replaced with the value you specified for variable “MAINPGM” on
page 8-15.
File-AID for IMS/CICS Product Configuration
8-9
to your segment layouts. It does not need to run if segment layouts do not exist.
However, if not run, formatted mode is not available.
These jobs are run during the Detailed Installation Steps for the sample databases. If you
want to access additional databases, the DBD Update program must be run again using
control cards for your databases. Optionally, the XREF Update job must be run to allow
use of your segment layouts. Refer to the File-AID for IMS/CICS and File-AID for IMS/DC
Reference manual for more information.
The Rebuild Control Segment program recreates the control segment. If the control
segment was inadvertently updated or deleted, it must be rebuilt to ensure accurate
processing of the databases. Refer to “DD Statements” on page 8-27 for more
information.
BMS Maps
BMS maps for 3270 type terminals with 24, 32, or 43 lines are supplied with File-AID for
IMS/CICS. Mode 5 terminals (27 x 132) are supported in 24 x 80 mode. The following
screen sizes are associated with the load modules listed.
Screen Size
Load Module
24 x 80
IXCMP1
32 x 80
IXCMP2
43 x 80
IXCMP3
27 x 132
IXCMP4
The BMS mapsets supplied are in the form of load modules. These load modules can be
renamed to conform to your installation’s standards. However, File-AID for IMS/CICS has
some restrictions on the names (refer to “Naming Conventions” on page 8-2).
File-AID for IMS/CICS Termination
When the File-AID for IMS/CICS session is terminated (using =X, CLEAR, PA key), File-AID
for IMS/CICS issues a CICS transfer control (XCTL) command to a separate program load
module that displays the message "FILE-AID FOR IMS/CICS ENDED." This program
terminates the tie between the terminal and the File-AID for IMS/CICS transaction.
Should you want to modify this program, the COBOL source code is provided in member
IXCEND of the Sample library SXVJSAMP. The Installation Parameter, ENDPGM (Field
“End program name” in Table 3-6 on page 3-16), defines the program name to File-AID
for IMS/CICS. You can modify the ENDPGM parameter to point to a program that already
exists at your installation.
Limiting DL/I Calls
Compuware recommends that a limit be enforced on the number of DL/I database
movement calls permitted during one transaction to prevent excessive resource usage
when browsing or editing large databases. A database movement call is one that changes
your position to another segment. This limit is specified in field “LMTCALLS” in the
configuration parameters, see “LMTCALLS” on page 8-15. When the specified limit is
reached, position is at the last segment retrieved, and a message is displayed on the
screen.
Security
Access can be controlled with the same security procedures currently in place at your
installation because File-AID for IMS/CICS runs as an application under CICS. Like any
8-10
File-AID Single Install Image Installation and Configuration Guide
other application, it must be defined to your security package during the installation
process.
File-AID for IMS/CICS constructs the PSBNAME used to access your databases from the 1-4
character installation defined prefix followed by the invoking transaction code.
An exit is provided for your use if additional security checks are wanted. Refer to
“File-AID for IMS/CICS and File-AID for IMS/DC Security Exit” on page E-30 for details
on how to write the security routine.
The following table summarizes several alternative security approaches to use with
File-AID for IMS/CICS.
Table 8-4.
Protected
Resource
Resource Protection Approaches
Type of Security
Security Product
Notes*
Database
Segment Sensitivity
Field Sensitivity
DL/I
N/A
1, 7, 8
2
NETNAME
Sign-on Verification
Terminal-User
SNT and CICS user exit
CICS user exit
3,4
4
CICS Tables
Resource Access
CICS user exit
4
PSB
Resource Access
CICS user exit
4
Transaction
Password
Resource Access
CICS user exit
SNT and CICS user exit
4
3,4
DBD
DBD-User-Password
File-AID for IMS exit
5
Access mode
File-AID for IMS Function
File-AID for IMS exit
5,6
Notes:
1.
2.
3.
4.
5.
6.
7.
Segment sensitivity is controlled through the PCBs in the PSB.
File-AID for IMS/CICS does not support field sensitivity.
SNT - Sign-on Table.
User exit refers to a custom exit routine or a security product.
Must be written for your particular installation.
Edit/Browse security.
The PROCOPT parameter on all user database PCBs should be A and should
be specified on the PCB macro and not the SENSEG macro. If you want to
enforce security using the PSBs, you can specify a PROCOPT parameter of G,
GO, or GOT on the user databases. This action causes File-AID for IMS/CICS to
display an abend screen with an AM status code and then the Primary
Option Menu screen whenever one of these user databases is edited.
8. To exclude a segment from processing, simply leave the segment out of the
PCB. The excluded segment is not displayed nor updated.
In many instances it may be desirable to limit access of certain databases to specific users.
This can be accomplished in the following ways:
1. Code a File-AID for IMS security exit that checks the DBD name against the User ID
entered either during sign-on or on the Primary Option Menu screen. This is the only
way to limit database access in a single transaction configuration.
2. Create multiple PSBs with different database PCBs within them. Assign each PSB to a
separate transaction, and use transaction security to limit their use. With this
method, the File-AID for IMS security exit is not required. You can simply use the
security procedures currently in place at your installation. This is the method
recommended for multi-transaction configurations.
In addition, your normal SNT and PSB security can be enforced with the use of the
security package installed at your installation.
File-AID for IMS/CICS Product Configuration
8-11
Configuration Procedures
Configuration Prerequisites
Before continuing with the File-AID for IMS/CICS configuration you must have
configured the IMS Environment Module XVJOPIMS (see “Step 3.2. Specify IMS
Environment (Option 2)” on page 2-39) as well as File-AID for IMS/ISPF module
XVJOPXIX (see Chapter 7, “File-AID for IMS/ISPF Product Configuration”).
Step 1. Select File-AID for IMS/CICS
Select option 3 from the “Configuration Facility Menu” (Figure 2-2 on page 2-4) to
display the File-AID “Product Configuration Menu” (see Figure 8-1). It lists all File-AID
mainframe products.
Figure 8-1. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD
Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE
9
START - Start products to verify installation 















Select Option 6, File-AID for IMS/CICS.
Step 2. Specify Source of Product Parameters
When selecting Option 6, File-AID for IMS/CICS from the “Product Configuration Menu”
(Figure 8-1), the “Source of Product Parameters” screen displays, prompting you to
specify the installation dataset of the previously installed product release or the name of
a load library containing File-AID Configuration modules in order to populate product
specific parameters.
8-12
File-AID Single Install Image Installation and Configuration Guide
Figure 8-2. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):

Previous install dataset . .
OR
Configuration library . . .

Press ENTER to continue. 




1. Specify either
– the name of a File-AID for IMS/CICS install dataset prior to Release 10.1
OR
– the name of the File-AID Configuration (load) library that includes a File-AID for
IMS/CICS XVJOPNIX module you want to use as a source for your parameter
input
OR
– Leave both fields blank if this is your initial installation of File-AID.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
If you leave the Previous Install dataset as blank, it will be ignored. A valid
previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID for IMS/CICS,
then you may retain the previously specified variable values. This is
accomplished by specifying the name of the install dataset (e.g.
hlq.CPWR.BG121116.INS or hlq.COMPWARE.NXIX760.INSTALL) that was
previously used to install File-AID for IMS/CICS product.
When specifying an unsupported install dataset, this pop-up message displays:
CANNOT IMPORT CONFIGURATION VALUES FROM
THE SPECIFIED DATASET
'TSOID01.IXC.V070200.INSTALL'




DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINNIX) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters; product installation
defaults are used when previous variable values cannot be imported. You
must visit Option 2, SPECIFY PARMS (see “Step 4. Specify File-AID for
File-AID for IMS/CICS Product Configuration
8-13
IMS/CICS Product Configuration Parameters” on page 8-14) to verify the
variable values.
Configuration library : Leave blank if you want to preserve the product installation
defaults.
Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release that includes
a File-AID for IMS/CICS XVJOPNIX module which you want to use as a source for
your parameter input.
If you want to use a preexisting XVJOPNIX parameter module (v10.1 or higher),
you can specify the name of the dataset that contains it. If a valid parameter
module is found, ALL values will be initialized from there. If the utility finds a
CXVJLOAD dataset with a hlq that matches the SXVJSAMP you are executing
from AND a valid parameter module is found, this field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID for IMS/CICS
Product Configuration Menu” shown in Figure 8-3 which lists the File-AID for
IMS/CICS Product Configuration options.
Figure 8-3. File-AID for IMS/CICS Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID for IMS/CICS

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 8-12). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARM module.
Configuration Output : Identifies the configured load library to which the File-AID for
IMS/CICS module XVJOPNIX will be saved.
The available options in the “File-AID for IMS/CICS Product Configuration Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
• CUSTOMIZE: Generate customized objects.
Select one of the available options.
8-14
File-AID Single Install Image Installation and Configuration Guide
Step 3. Review Target and Configuration Module Libraries
Select option 1 from the “File-AID for IMS/CICS Product Configuration Menu” to display
the “Dataset Name Specification” panel (Figure 2-6 on page 2-11). Here you review the
dataset information for the File-AID SMP/E Target Libraries that were created during the
SMP/E installation (see Chapter 2, “RFN SMP/E Installation of Compuware Mainframe
Products” or Appendix A, “SMP/E Installation Using the EP Media Interface” in the
Compuware Installer Mainframe Products SMP/E Installation Guide) and the File-AID
Configuration Module Libraries. The displayed list is the same as displayed in Figure 2-6
on page 2-11. Refer to “Step 2.1 Specify Configuration Module Dataset Names” on page
2-10 for more information.
Step 4. Specify File-AID for IMS/CICS Product Configuration Parameters
Select Option 2 from the “File-AID for IMS/CICS Product Configuration Menu” to display
the “File-AID for IMS/CICS Product Configuration Parameters” panel (Figure 8-4). Option
2 allows you to specify values for variables that the Configuration Facility uses to
configure File-AID for IMS/CICS. The values that you provide are saved in the parameter
variables list. A listing of all the variables is provided in Table 8-5 on page 8-15.
The first time you select Option 2, and you didn’t specify either a previous install or
Configuration library, the Configuration Facility populates the parameter variables with
the default values delivered with the product.
Edit the parameter values to configure File-AID for IMS/CICS to your site’s desired
settings.
Use the HELP command (PF1) to receive information on using this screen.
After entering and reviewing the desired values, Press END (PF3) to save your changes
and continue to the Edit JCL screen where you can submit the job to assemble the
File-AID for IMS/CICS parameter module XVJOPNIX, or CANCEL to exit the screen
without saving your changes.
Figure 8-4. File-AID for IMS/CICS Product Configuration Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>

Product.... File-AID for IMS/CICS
Version.... 10.02.00
Variable
-------MAINPGM
MAPPRFX
MAPSUFX
PGMPRFX
PSBPRFX
ENDPGM
IMSVERSN
LMTCALLS




Value
Description

--------------------------------------------------------------------- 
More:
+ 

IXCMAIN Name for File-AID for IMS/CICS main load module.
Default=IXCMAIN

Mapset prefix - must be the same as the mapset names.

IXC
Default=IXC

Optional one character map suffix.

(blank,M)

Program prefix - 1-4 character prefix to load module names.
IXC
Default=IXC

PSB name prefix.

IXC
Default=IXC

Program used to return control to CICS.

IXCEND
Default=IXCEND

The Version-Release of IMS.

12100
(IMS 12.1.0=12100) Default=12100

Limit of database calls in one transaction. 
100
Scroll through this screen to review and update all the variables as required for your site.
File-AID for IMS/CICS Product Configuration
8-15
Table 8-5 on page 8-15 lists the variables. A value is required for all variables, unless
stated otherwise in the comments column. Also, refer to “Naming Conventions” on page
8-2 for variables defining names, prefixes, or suffixes.
Table 8-5.
File-AID for IMS/CICS Product Options
Label
Default Value
MAINPGM
IXCMAIN
Name for File-AID for IMS/CICS main load module.
Default=IXCMAIN
Load module name to use to link the File-AID for
IMS/CICS load module (XIXCMAIN) shipped with the
product.
MAPPRFX
IXC
Mapset prefix - must be the same as the mapset
names.
Default=IXC
BMS mapset name prefix (one to four character
prefix). Must match the prefix specified for the
mapset names. For example, if map names have a
prefix of IXC, then enter IXC here.
MAPSUFX
Your Value
Description
Optional one character map suffix.
(blank,M)
Optional BMS mapset name suffix. You may append
the letter M to the mapset suffix if you have the SIT
parameter coded BMS=DDS. You must also modify
the PPT entries to reflect this suffix.
PGMPRFX
IXC
Program prefix - 1-4 character prefix to load module
names.
Default=IXC
Program name prefix (one to four character prefix).
Must be the same prefix as specified for the load
module names. For example, if you change load
module names to have prefix IXC, then code as IXC.
PSBPRFX
IXC
PSB name prefix (one to four character prefix).
Default=IXC
Multiple transactions may be defined for File-AID for
IMS/CICS. The PSB name associated with each
transaction must start with this PSB prefix. The last
four characters of the PSB name uniquely identify
each transaction.
ENDPGM
IXCEND
Program used to return control to CICS.
Default=IXCEND
Name of the program used by File-AID for IMS/CICS
to return control to CICS. Source code for the default
end program is provided in the SXVJSAMP sample
library.
IMSVERSN
12100
The Version-Release of IMS.
(IMS 12.1.0=12100) Default=12100
The Version-Release of IMS to use with File-AID for
IMS/CICS. The first two bytes are version, last three
are release. For example, code IMS 12.1.0 as "12100".
LMTCALLS
100
Limit of database calls in one transaction. 
(50-32767) Default=100
The maximum number of database movement calls
that are permitted during one transaction.
Recommended minimum value is 50. Maximum
allowable value is 32,767.
8-16
File-AID Single Install Image Installation and Configuration Guide
Table 8-5.
File-AID for IMS/CICS Product Options (Continued)
Label
Default Value
INTEGIND
Y
Your Value
Description
Integrity check indicator. 
(Y=YES,N=NO) Default=Y
Indicates whether a check will be made for a change
made by a concurrent user prior before the IMS
record is replaced:
Y - Check for change and prompt for action.
N - Replace as changed without checking.
CAPSMODE ON
Initial CAPS mode setting.
(ON,OFF) Default=ON
Initial CAPS mode setting to be used when a user
invokes File-AID for IMS/CICS:
ON - Character data is translated to upper case.
OFF - Character data is stored as entered.
CODEPAGE
Codepage used to determine displayable characters.
(0697,0277,0290,0297,0424,0500,0833,0838,
0905) Default=0697
Four digit code for the codepage translation to be
used by File-AID for IMS/CICS.
0697 - English (Default)
0277 - Danish/Norwegian
0290 - Japanese Katakana
0297 - French
0424 - Hebrew
0500 - Swiss French/Swiss German
0833 - Korean
0838 - Thai
0905 - Canadian Bilingual
0697
ATTRLDBD
DEPSEGNO
Audit trail DBD name.
(blank=No Audit)
Specify the DBD name of the audit trail database to
be used with this installation of File-AID for IMS/CICS.
Leave this entry blank if the audit trail feature will not
be used with this installation.
Enter *NOCHK* if you want File-AID for IMS/CICS to
attempt to use the database to write audit records
without validating that the DBD name in the PSB
matches the one specified here.
-1
Maximum dependent segments written to audit trail
database.
(0-32767,-1) Default=-1
The maximum number of dependent segments to be
written to the audit trail database when a parent
segment is deleted:
0 to 32767 - The maximum number of deleted child
segments written to the audit trail database.
-1 - All deleted child segments are written to the audit
trail database.
When a segment that has dependent segments under
it is deleted, IMS automatically deletes all those
dependent segments. Indicate the maximum number
of deleted dependent segment images you want
written to the Audit Trail database for a given deleted
parent. Default value of -1 indicates that images of all
deleted dependents are to be captured. Specify zero
if deleted dependents are not to be captured. The
maximum allowable value is 32,767.
File-AID for IMS/CICS Product Configuration
Table 8-5.
8-17
File-AID for IMS/CICS Product Options (Continued)
Label
Default Value
Your Value
Description
MAXSEGSZ
30630
Maximum segment size written to the audit trail
database. 
(specify value from table in Installation Guide)
Default=30630
This is the MAX BYTES value you specified for the
BYTES= keyword on the SEGM statements in the AUD
database DBD source code. Refer to “DBD Tailoring”
on page 8-3 and “Step 8. Generate Customized
Objects” on page 8-19 for additional information
about the AUD database segments’ size
ALLNONE
N
Audit Trail indicator.
(A=All minus exception list,N=None but exception
list) Default=N
Indicates whether or not to create an audit trail when
data are edited. This indicator is used in conjunction
with the optional DBD exception list.
A - The audit trail feature will be active for all data
bases edited using File-AID for IMS/CICS except for
those specified in the optional DBD exception list.
N - The audit trail feature will not be active for any
databases edited using File-AID for IMS/CICS except
for those listed in the optional DBD exception list.
IMS RESLIB
IMS.SDFSRESL
Specify the IMS RESLIB.
SDFHLOAD
Library
CTS.SDFHLOAD
Specify the CICS load library.
DATASETS
Step 5. Review and Submit JCL
After entering the desired parameter values in the “File-AID for IMS/CICS Product
Configuration Parameters” panel (Figure 8-4 on page 8-14), enter END (PF3) to continue
to the Edit JCL screen (Figure 8-5 on page 8-18).
Review the generated JCL and SUBMIT the job to assemble the File-AID for IMS/CICS
parameter module XVJOPNIX. Submitting the JCL also saves the changes you made in
the “File-AID for IMS/CICS Product Configuration Parameters” panel (Figure 8-4 on page
8-14).
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Product Configuration Menu”, the changes you made in the “File-AID for
IMS/CICS Product Configuration Parameters” panel (Figure 8-4 on page 8-14) will NOT
be saved.
8-18
File-AID Single Install Image Installation and Configuration Guide
Figure 8-5. Edit JCL Screen for File-AID for IMS/CICS Parameter Module XVJOPNIX
EDIT
TSOID01.CPWR.MXVJA20.WORK($NIX01) - 01.00
Columns 00001 00072
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 /*JOBPARM S=CW01

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*-----------------------------------------------------------
000007 //* ASSEMBLE CUSTOMIZATIONS PARAMETERS (XVJOPNIX)

000008 //*-------------------------------------------------------------------- 
000009 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED. 
000010 //*-------------------------------------------------------------------- 
000011 //*
2
LINKEDIT LOAD MODULES INTO YOUR CICS LOAD LIBRARY
| 
000012 //*
| 
000013 //*
3
LINKEDIT BMS MAPSETS INTO YOUR CICS LOAD LIBRARY
| 
000014 //*___________________________________________________________________| 
000015 //*

000016 //IXCPROC2 PROC 
000017 //*
000018 //*

000019 //*-------------------------------------------------------------------- 
Step 6. Review Job Output
When you receive the job completion message, review the job output and verify that
File-AID for IMS/CICS Parameter Module XVJOPNIX has been created or updated.
Step 7. Make Load Modules Available to CICS
Whenever you have generated or re-generated the File-AID for IMS/CICS Parameter
Module XVJOPNIX, the following CICS load modules:
xxxEDTF
xxxEDTI
xxxEDTL
xxxEDTS
xxxEDTU
xxxEND
xxxKEY
IXCMAIN
xxxMP1
xxxMP2
xxxMP3
xxxMP4
XVJOPNIX
the new load modules are written to the CXVJLOAD library. The prefix xxx is replaced
with the prefix value you specified for variable “PGMPRFX” on page 8-15 and the main
program name (default IXCMAIN) is replaced with the value you specified for variable
“MAINPGM” on page 8-15.
You must make these load modules available to CICS in order to access File-AID for
IMS/CICS.
File-AID for IMS/CICS Product Configuration
8-19
Step 8. Generate Customized Objects
Select Option 3 from the “File-AID for IMS/CICS Product Configuration Menu” to display
the “File-AID for IMS/CICS Customization Tasks Menu” panel (Figure 8-6). Option 3
provides instructions on what jobs need to be run. Refer to Appendix E, “File-AID for
IMS Exits” for more information on security exits.
Figure 8-6. File-AID for IMS/CICS Customization Tasks Menu
File-AID ------------------- Customization Tasks ----------------------------
OPTION ===>

Product.... File-AID for IMS/CICS

Version.... 10.02.00


------------------------------------------------------------------------------
More:
+ 
The Following JCL members can be found in the SXVJSAMP library:


1) Assemble and Link IMS modules (Required)


XIXCDBD - Assemble and Link an IMS DBD 

XIXCPSB - Assemble and Link an IMS PSB 

XIXCACB - Assemble and Link an IMS ACB 

2) ALLOCATE LTM, CLT and Audit Trail Database Datasets (Required) 

XIXCALCO - Allocate Datasets using OSAM


XIXCALCV - Allocate Datasets using VSAM


3) Security Exit (Optional)


1) Assemble and Link IMS Modules (Required)
The following JCL members are provided in the File-AID sample library SXVJSAMP:
• XIXCDBD - Assemble and Link an IMS DBD
Follow the instructions in “Modify DBD Source Code” and “Generate DBD Control
Blocks” on page 8-21.
• XIXCPSB - Assemble and Link an IMS PSB
Follow the instructions in “Modify PSBs” on page 8-22 and “Generate PSB Control
Blocks” on page 8-22.
• XIXCACB - Assemble and Link an IMS ACB
Follow the instructions in “Generate ACB Control Blocks” on page 8-23
Modify DBD Source Code
Before you submit the JCL to assemble and link IMS modules, you should modify the
DBD source code for File-AID’s control databases to conform to your installation’s
specifications. Each member, IXCLTM, IXCCLT, and IXCAUD, should be updated
identically except where noted. The members are found in the Sample Library SXVJSAMP.
DBD NAME=IXCLTM,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,MU,30,8177)
DBD NAME=IXCCLT,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,50,8177)
DBD NAME=IXCAUD,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,16,250,8117)
NAME=IXCLTM
NAME=IXCCLT
NAME=IXCAUD
(for the LTM database)
(for the CLT database)
(for the AUD database)
If necessary, modify these names to meet your installation’s DBD naming
conventions.
8-20
File-AID Single Install Image Installation and Configuration Guide
ACCESS=(HDAM,VSAM)
(same for all control databases)
It is recommended that the control databases be organized as VSAM datasets because
of their large segment sizes. However, if your installation wants to allocate them as
OSAM datasets, change the second parameter to OSAM. Do not change the access
method (first parameter).
RMNAME=(DFSHDC40,1,30,8177)
RMNAME=(DFSHDC40,1,50,8177)
RMNAME=(DFSHDC40,16,250,8117)
(for the LTM database)
(for the CLT database)
(for the AUD database)
Substitute the RBNs calculated in “DBD Tailoring” on page 1-4 for the third
parameters. Substitute the RMNAME BYTES calculated earlier for the fourth
parameters. The RMNAME BYTES parameter must be the same for the LTM and CLT
databases. Do not change the randomizer name (first parameter) or the RAPs per CI
(second parameter).
DATASET DD1=IXCLTMDD,DEVICE=3380,SIZE=8192 (for the LTM database)
DATASET DD1=IXCCLTDD,DEVICE=3380,SIZE=8192 (for the CLT database)
DATASET DD1=IXCAUDDD,DEVICE=3380,SIZE=8192 (for the AUD database)
DD1=IXCLTMDD
DD1=IXCCLTDD
DD1=IXCAUDDD
(for the LTM database)
(for the CLT database)
(for the AUD database)
If necessary, modify these names to meet your installation’s DDNAME conventions.
DEVICE=3380
(same for all control databases)
Change the device to the type used at your installation.
SIZE=8192 (same for LTM and CLT databases; AUD database can vary)
Find the row that corresponds to your installation’s Maximum User DB Segment
Length (for the LTM and CLT databases) or Maximum User DB Segment Plus Concat
Key Length (for the AUD database) in the tables shown in “DBD Tailoring” on page
8-3. Substitute the appropriate number from the CI/BLOCK column for the Size
parameter.
SEGM NAME=GV,PARENT=0,BYTES=( 8158,10),PTR=TWIN 
BYTES=(8158,10) (same for all LTM and CLT control database segments)
BYTES=(8102,48) (same for all AUD control database segments)
Find the row that corresponds to your installation’s Maximum User DB Segment
Length (for the LTM and CLT databases), or Maximum User DB Segment Plus Concat
Key Length (for the AUD database) in the tables shown in “DBD Tailoring” on page
8-3. Substitute the appropriate number from the Segm Bytes column for the
corresponding BYTE operand. Substitute this same number in all the SEGM
statements in the appropriate control database DBDs. Each control database DBD
must have the same maximum segment size on all its SEGM statements. Do not
change the NAME=, PARENT=, PTR=, or the segment minimum size parameters.
Following are samples of the LTM, CLT, and AUD control database DBDs.
File-AID for IMS/CICS Product Configuration
8-21
LTM DBD
PRINT
DBD
DATASET

SEGM
FIELD

SEGM
FIELD

SEGM
FIELD

SEGM
FIELD

DBDGEN
FINISH
END
NOGEN
NAME=IXCLTM,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,30,8177)
DD1=IXCLTMDD,DEVICE=3380,SIZE=8192
NAME=GV,PARENT=0,BYTES=(8158,10),PTR=TWIN
NAME=(GVKEY,SEQ,U),BYTES=8,START=3
NAME=PS,PARENT=((GV,SNGL)),BYTES=(8158,7),PTR=TWIN
NAME=(PSKEY,SEQ,U),BYTES=5,START=3
NAME=WA,PARENT=((GV,SNGL)),BYTES=(8158,5),PTR=TWIN
NAME=(WAKEY,SEQ,U),BYTES=3,START=3
NAME=ST,PARENT=((GV,SNGL)),BYTES=(8158,54),PTR=TWIN
NAME=(STKEY,SEQ,U),BYTES=52,START=3
CLT DBD
PRINT
DBD
DATASET

SEGM
FIELD
FIELD
FIELD
FIELD

DBDGEN
FINISH
END
NOGEN
NAME=IXCCLT,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,50,8177)
DD1=IXCCLTDD,DEVICE=3380,SIZE=8192
NAME=DCLT,PARENT=0,BYTES=(8158,60),PTR=TWIN
NAME=(DCLTKEY,SEQ,U),BYTES=52,START=5
NAME=(CLTSRCH),BYTES=84,START=85
NAME=(PRTKEY11),BYTES=11,START=5
NAME=(PRTKEY19),BYTES=19,START=5
AUD DBD
PRINT
DBD
DATASET

SEGM
FIELD
SEGM
AST)

DBDGEN
FINISH
END
NOGEN
NAME=IXCAUD,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,16,250,8117)
DD1=IXCAUDDD,DEVICE=3380,SIZE=8192
NAME=AT,PARENT=0,BYTES=(8102,48),PTR=TWIN
NAME=(ATKEY,SEQ,U),BYTES=37,START=3
NAME=ATDEP,PARENT=((AT,DBLE)),BYTES=(8102,8),PTR=TWIN,RULES=(,L
Generate DBD Control Blocks
In this step, DBD control blocks are generated for the three control databases and the
four sample databases.
1. Submit DBDGENs for the databases using JCL already in place at your installation, or
use the sample JCL provided in member XIXCDBD:
a. Enter a job card.
This job requires 1024K and no tape drives.
b. Modify the default symbolic parameters (see Table 8-6).
8-22
File-AID Single Install Image Installation and Configuration Guide
If the Audit Trail feature is to be activated, comment out the NULL (end of job)
JCL statement following the IXC07 step name statement and modify the
MBR=IXCAUD statement if it was changed to satisfy your installation’s
standards.
c. Submit the job.
Table 8-6.
XIXCDBD Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
DEV
SYSDA
Temporary work file device.
SYSLIB
XXXXXXX.SDSFMAC
Macro Library.
SRCDSN
XXXXXXX.SXVJSAMP
File-AID Sample JCL Library.
RESLIB
XXXXXXX.SDFSRESL
IMS RESLIB.
DBDLIB
XXXXXXX.DBDLIB
DBD Library.
Modify PSBs
Modify the PSBs as required by your installation’s configuration. The first five PCBs in
the PSB (including the optional Audit Trail PCB) are for File-AID’ use. PCBs 6 thru 500 are
for your user databases. It is recommended that you include the four sample database
PCBs in your PSB for the initial installation. Sample Library member IXCIXC contains
these sample databases’ PCBs.
Refer to “PSB Tailoring” on page 8-5 for more information.
Note: If the Audit Trail feature is to be activated, you must uncomment the IXCAUD
PCB.
Generate PSB Control Blocks
In this step, PSB control blocks are generated for the PSBs needed for your installation
configuration and the PSBs in the Sample Library members IXCDLET, IXCLOAD, and
IXCUPLD.
1. Submit PSBGENs for these PSBs using JCL already in place at your installation, or use
the sample JCL provided in member XIXCPSB:
a. Enter a job card.
This job requires 1024K and no tape drives.
b. Modify the default symbolic parameters (see Table 8-7).
c. Submit the job.
Table 8-7.
XIXCPSB Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
DEV
SYSDA
Temporary work file device.
SYSLIB
XXXXXXX.SDSFMAC
CICS Macro Library.
SRCDSN
XXXXXXX.SXVJSAMP
File-AID Sample JCL Library.
RESLIB
XXXXXXX.SDFSRESL
IMS RESLIB.
PSBLIB
XXXXXXX.PSBLIB
IMS PSB Library.
MBR
Blank
PSB member name.
File-AID for IMS/CICS Product Configuration
8-23
Generate ACB Control Blocks
In this step, ACB control blocks are generated for the PSBs needed for your installation
configuration and the PSB in the Sample Library member IXCUPLD.
1. Submit ACBGENs for these PSBs using JCL already in place at your installation, or use
the sample JCL provided in member XIXCACB:
a. Enter a job card.
This job requires 512K and no tape drives.
b. Modify the default symbolic parameter (see Table 8-8).
c. Submit the job.
Table 8-8.
XIXCACB Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
RESLIB
XXXXXXX.SDFSRESL
IMS RESLIB.
DBDLIB
XXXXXXX.DBDLIB
IMS DBD Library.
PSBLIB
XXXXXXX.PSBLIB
IMS PSB Library.
ACBLIB
XXXXXXX.ACBLIB
IMS ACB Library.
2) ALLOCATE LTM, CLT and Audit Trail Database Datasets (Required)
The control databases require one dataset each. It is recommended that these databases
be allocated as VSAM files because of their segment sizes. If your installation does not
want to use VSAM, they can be allocated as OSAM files, but the ACCESS parameter of the
DBD macro within the DBD source must be modified to reflect this.
The following JCL members are provided in the File-AID Sample Library SXVJSAMP:
• XIXCALCO - Allocate Datasets using OSAM
• XIXCALCV - Allocate Datasets using VSAM
Read the instructions in the JCL members and modify the sample JCL to your site’s
environment before submitting the job.
Use the following formulas to calculate the space needed by the control databases:
• LTM dataset size: 
bytes = RBN calculated earlier * CI size * 14
• CLT dataset size: 
bytes = RBN calculated earlier * CI size
• AUD dataset size: 
bytes = RBN calculated earlier * CI size
These formulas assume a stable user base. If you anticipate that the user base will grow,
you should factor this growth into the formulas before allocating the datasets.
Convert the number of bytes required to the number of cylinders required.
3) Security Exit (Optional)
File-AID for IMS provides one exit type to the security exit. Its primary intent is to limit
database access and to control whether a user’s database updates are captured by the
Audit Trail feature. The default security exit routine provided with File-AID does no
processing and returns control immediately to File-AID.
8-24
File-AID Single Install Image Installation and Configuration Guide
The following JCL members are provided in the File-AID sample library SXVJSAMP:
• XIXCSCXD - Compile and Dynamically Link a COBOL Exit
• XIXCSCXS - Compile and Statically Link a COBOL Exit
Use the appropriate JCL member to compile or assemble and link-edit a security exit.
You have the following options when installing a security exit:
1. XIXCSCXD - Compile and Dynamically Link a COBOL Exit
2. XIXCSCXS - Compile and Statically Link a COBOL Exit
Refer to “File-AID for IMS/CICS and File-AID for IMS/DC Security Exit” on page E-30 for
more information.
4) Static Link of XVJOPNIX (Optional to support multiple XVJOPNIX modules)
The following JCL member are provided in the File-AID sample library SXVJSAMP:
• XIXCSTAT - Statically link XVJOPNIX
Use the sample JCL to define multiple sets of transactions that are unique and statically
link them into your program library.
Multiple Transaction Configuration
If you want to support transactions that use different configurations of File-AID for
IMS/CICS within the same CICS region, further steps are required. You will need to create
separate versions of the XVJOPNIX load module and link them into separate load
libraries. Each version must then be statically linked along with the yyyMAIN load
module into a uniquely named load module for each transaction that is to use that
configuration.
After you have created an original XVJOPNIX load module, return to the “File-AID for
IMS/CICS Product Configuration Menu” (Figure 8-7).
Figure 8-7. File-AID for IMS/CICS Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID for IMS/CICS

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . New.loadlib.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Now, specify a different and existing load library for the Configuration Output library
(see “Configuration Output” on page 8-13) for each unique configuration you wish to
create. If needed, modify any parameters (see “Step 4. Specify File-AID for IMS/CICS
Product Configuration Parameters” on page 8-14). Then submit the generated JCL to
generate the new load module.
File-AID for IMS/CICS Product Configuration
8-25
Generate as many versions of the XVJOPNIX load modules as required, linking each into
its own load library.
When you are done, use the XIXCSTAT PROC found in the SXVJSAMP library to perform
the link edit required to create a load module that has a particular version of XVJOPNIX
linked into it.
To execute the XIXCSTAT PROC do the following:
1. Modify the PROC to supply job card information and set the PRINT and DEV PROC
parameters appropriately.
2. Assign XVJOPNIX to the load library containing a particular version of XVJOPNIX.
3. Assign SXVJLOAD to the SMP/E installed load library that contains the IXCMAIN 1
load module.
4. Assign the SYSLMOD to the load library that will be used to execute CICS.
5. Change the string YYYYYYYY to the name of the load module that is to be associated
with the CICS transaction.
6. If you wish to create multiple transactions using the same version of a particular
XVJOPNIX configuration module, execute the PROC for each transaction, changing
only the value of the YYYYYYYY string.
Any transaction that is not associated with a load module that does not contain a
statically linked version of XVJOPNIX will use the version found in the CICS load library
if one exists. The statically linked load module(s) must be made available to CICS.
When maintenance is applied to the XIXCMAIN load module in SXVJLOAD, you will
have to run the XIXCSTAT PROC for each transaction load module that contains a
unique version of the XVJOPNIX module. Remember, the statically linked load module(s)
must be made available to CICS.
Maintenance Considerations
Control Database DBD Changes
A database reorganization must be done whenever the DBDs used by the control
databases change after the initial installation. This need can be caused by space
requirement, randomizer, maximum segment size, dataset organization, device type, or
IMS version changes. The following steps must be taken to reorganize a changed
database:
1. Unload the database that uses the existing DBD. Use the JCL available at your
installation or the JCL in member XIXNULOD.
2. Incorporate the changes into the DBD.
3. Regenerate the DBD control block (“Step 5d. Assemble DBD Source Code” on page
3-22).
4. Regenerate the ACB (“Step 5g. Generate ACB Control Blocks” on page 3-30).
5. Delete and reallocate the dataset, if necessary, by using the JCL in member
XIXNDDFO (for OSAM databases) or XIXNDDFV (for VSAM databases).
6. Reload the database with the new DBD. Use the JCL available at your installation or
the JCL in member XIXNRELD.
1. The main program name (default IXCMAIN) is replaced with the value you specified for variable “MAINPGM” on
page 8-15.
8-26
File-AID Single Install Image Installation and Configuration Guide
Control Database Segment Size Changes
If the segment size requirements of a control database need to be changed to support
your database, it is indicated by message D609. Within this message is a value that is the
minimum required control database segment size needed to support the DBD in
question.
When changing the DBD to reflect this new control database segment length, use the
appropriate table provided in “DBD Tailoring” on page 1-4. In that table, the Segm Bytes
column displays the recommended values for the segment length. Choose the next
highest value greater than the size displayed in the message to ensure that your DBD will
be supported by File-AID. Use the other values in that row in the table for the remaining
control database DBD values. Remember that the LTM and CLT control databases must
use the same maximum segment length (SEGM BYTES) and root addressable area size
(RMNAME BYTES).
Aside from the above mentioned requirements, the procedure to change the size of the
control database segments is the same as described in “Control Database DBD Changes”
above.
Security Exit Added or Changed
If your installation is adding a new security exit program or changing an existing one, it
must be linked again into File-AID’s main load module.
Follow the instructions in “3) Security Exit (Optional)” on page 8-23.
Installation Parameters Changed
If your installation parameters change (e.g., your call limit changes or your IMS release
number changes), the installation parameter module must be linked again into the main
load module (IXCMAIN 1). Follow the instructions in “Step 4. Specify File-AID for
IMS/CICS Product Configuration Parameters” on page 8-14 and submit the JCL. If your
site requires multiple transaction configurations, relink them into your program library
(refer to “4) Static Link of XVJOPNIX (Optional to support multiple XVJOPNIX
modules)” on page 8-24).
Control Segment Missing or Invalid
A segment on the CLT control database stores various counts and fields used to verify the
database’s integrity. If this segment is inadvertently updated or deleted, it must be rebuilt
to ensure accurate processing of your databases. The Rebuild Control Segment program
(XIXREBLD) reads the File-AID database, calculates and accumulates control field
information for each segment, and inserts or replaces the new control segment.
You need to run XIXREBLD when any of the following conditions occur:
• An abend screen is displayed with message number D204:
File-AID IS MISSING ITS CONTROL SEGMENT
• An abend screen is displayed with message number D205:
File-AID’s CONTROL SEGMENT CONTAINS INVALID DBD DATA
• The Batch XREF Update program terminates with a return code of 8. The summary
report prints the message:
ONLINE CONTROL INFORMATION SEGMENT NOT FOUND. IF DBD UPDATE
FACILITY HAS NEVER BEEN RUN, RUN IT FIRST. OTHERWISE, RUN MAINTENANCE
UTILITY TO REBUILD CONTROL INFORMATION SEGMENT
1. The main program name (default IXCMAIN) is replaced with the value you specified for variable “MAINPGM” on
page 8-15.
File-AID for IMS/CICS Product Configuration
8-27
The Rebuild Control Segment program can be run as a batch or shared database program.
Parameters
The parameters on the PROC statement assign default values to symbolic parameters on
the procedure statement. To override a default parameter value on the PROC statement,
code the same parameter on the EXEC statement that calls the procedure.
The XIXNRBLD and XIXNRBLB parameters specify the sysout class, load libraries, and
dataset names used when the program executes. These are described in “DD Statements”
on page 8-27.
Change the default LE Runtime library from CEE.SCEERUN to your LE370 Runtime
library.
The DFSRRC00 parameters are the batch IMS execution time parameters.
DD Statements
Table 8-9 contains the DD statements that define the primary processing files required to
run the Rebuild Control Segment program.
Table 8-9.
Rebuild Control Segment Program DD Statements
DD Statement
Description
STEPLIB
Designates the IMS system dataset that contains the IMS nucleus, required action
modules (&RESLIB), and the library where File-AID for IMS/ISPF load modules are
stored (&CXVJLOAD and &SXVJLOAD).
DFSRESLB
XIXNRBLD PROC only. Designates the IMS system dataset that contains the IMS
nucleus and required action modules (&RESLIB).
DFHLIB
XIXNRBLB PROC only. Designates the CICS system dataset that contains the batch
region controller modules.
IMS
XIXNRBLD PROC only. Designates the IMS system datasets that contain the
database description blocks (&DBDLIB) and the program specification blocks
(&PSBLIB).
DFSVSAMP
XIXNRBLD PROC only. Designates the dataset (&PROCLIB) and member
(&DFVSAM) that contain the control statements that describe the size and
structure of the VSAM shared resource pool for File-AID’ CLT database. The buffers
must be large enough to accept the largest segment size in the CLT database.
SYSUDUMP
A dump of user areas if the program abends. The dump is formatted so that it can
be printed directly.
IEFRDER
XIXNRBLD PROC only. Designates the log dataset when update intent is declared.
IXCCLTDD
XIXNRBLD PROC only. Designates the File-AID’ control database (&IXPDB) that is
updated with DBD information.
IXPD1
Designates the DBD load library that contains the DBD load modules that define
the databases used to update the CLT database. Multiple DBD load libraries can
be concatenated.
IXPMLIB
Designates the library that contains File-AID for IMS messages.
SYSOUT
Designates the output class for the Online Control Information Update Summary
Report.
XIXREBLD Return Codes
An XIXREBLD execution return code (RC) appears in the output listing. A message
appears on the Online Control Information Update Summary Report for return code 16
(system error).
8-28
File-AID Single Install Image Installation and Configuration Guide
The message listed on the Online Control Information Update Summary Report indicates
the program’s execution status.
Figure 8-8. Online Control Information Update Summary Report
File-AID for IMS
ONLINE CONTROL INFORMATION UPDATE SUMMARY













PAGE 1
DATE 09/28/14
TIME 14:54:01
D729 THE ONLINE CONTROL INFORMATION SEGMENT HAS BEEN SUCCESSFULLY REBUILT
****E N D
O F

R E P O R T****
Back-up and Restore Control Databases
A back-up and recovery plan should be developed at your installation to allow recovery
from physical damage to the control databases. The CLT control database contains a large
amount of information that is difficult to recreate in the event the database becomes
unusable. The LTM control database, which contains temporary data used only for the
duration of a terminal session, is easier to reestablish. The AUD control database may
contain Audit Trail activity that has not yet been extracted by running the XIXATEXT
program. Therefore, your installation could lose valuable Audit Trail information.
A job is provided in installation JCL member XIXNICPY to create image copies of the CLT
and AUD databases. You can use it or other JCL available at your installation for periodic
back-ups. To restore the CLT and AUD databases from the image copies, use the job in
installation JCL member XIXNRSTR or other JCL available at your installation.
If your CLT and AUD control databases are VSAM files, they must be deleted and
redefined before beginning the restore process. Use the job in installation JCL member
XIXNDDFV for this purpose.
No back-up or restore JCL is provided for the LTM database. To repair a damaged LTM
control database that is a VSAM file, delete and redefine it with the job in installation
JCL member XIXNDDFV. For OSAM files this step can be skipped. Then, initialize the
database with the job in JCL member XIXNLTMI.
See “File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update” on page
F-1 for more information.
What’s Next?
After you have completed the configuration of File-AID for IMS/CICS, press END until you
return to the “Product Configuration Menu” (Figure 8-1 on page 8-11).
Either
• select the next File-AID product to configure from the “Product Configuration
Menu” (Figure 8-1 on page 8-11).
Or
File-AID for IMS/CICS Product Configuration
8-29
• start File-AID for IMS/CICS and verify the product installation. Refer to “File-AID for
IMS/CICS” on page 11-25 in Chapter 11, “Verifying File-AID Installation” for
suggested verification procedures.
8-30
File-AID Single Install Image Installation and Configuration Guide
9-1
Chapter 9.
File-AID for IMS/DC Product Configuration
Chap 9
Product Overview
File-AID for IMS/DC is an interactive, full-screen product designed for use by application
programmers, analysts, and database administrators. This product provides the ability to
easily access and manipulate data within IMS databases. The databases can be browsed or
edited in any of the following modes directly under IMS/DC:
• Formatted using COBOL or PL/I segment layouts
• Unformatted in hexadecimal
• Hierarchical sequence with one segment per screen line
File-AID for IMS/DC executes as a single segment, non-conversational Message Processing
Program (MPP) that requires absolutely no modifications to IMS, DL/I, or any other
existing software. An IMS Stage 1 system definition job must be run to define File-AID for
IMS/DC to the IMS system.
The File-AID for IMS system, not including user database DBDs and PSBs, consists of the
following:
• Product load modules
• Product MFS modules
• 3 Control Databases
• 3 Control DBDs
• 1 or more Transactions
• 1 or more PSBs/ACBs
File-AID for IMS/ISPF Option 7, Release 3.2 or later must be installed to create and
maintain the segment/layout cross-reference data used by File-AID for IMS/DC.
Depending on system resource availability and IMS system definition job scheduling,
plan to spend from six to twelve hours installing File-AID for IMS/DC.
Installation Configuration
The two basic configurations used to run File-AID for IMS are single transaction and
multiple transaction. The type of configuration affects the steps taken during
installation.
Single Transaction Configuration
Use a single transaction configuration if:
1. Your installation has only one programming group.
2. The number of databases does not exceed the number practical for a single PSB. IMS
allows a maximum of 500 PCBs in a PSB.
3. Transaction security will be the same for all users.
9-2
File-AID Single Install Image Installation and Configuration Guide
4. Including all the databases in one PSB will not exceed your installation’s PSB pool
size (refer to “PSB Tailoring” on page 9-5).
In a single transaction configuration, only one transaction code is used to invoke
File-AID for IMS. Up to 494 user database PCBs can be included in the PSB associated with
the transaction (File-AID for IMS uses six PCBs in the PSB), provided that the resulting
ACB does not exceed your IMS PSB pool size. Security can be based on the transaction
name and can be enhanced by using the File-AID for IMS security exit, other security
products (e.g., RACF, CA ACF2, CA Top Secret), or both.
Multiple Transaction Configuration
Use a multiple transaction configuration if:
1. Your installation has more than one programming group and each group needs
access to different sets of databases.
2. The number of databases exceeds the number practical for a single PSB. IMS allows a
maximum of 500 PCBs in a PSB.
3. Transaction security will vary with different programming groups.
4. Including all the database PCBs in one PSB will exceed your installation’s PSB pool
size (refer to “PSB Tailoring” on page 9-5).
In a multiple transaction configuration, two or more transaction codes are used to invoke
File-AID for IMS/DC. Each transaction code is associated with a different PSB. Each PSB
contains PCBs for a set of databases. Because the PSB name must be the same as the main
load module name, the load module uses alias names to match the names of the PSBs. Up
to 494 user database PCBs can be included in each PSB (File-AID for IMS uses six PCBs in
the PSB), provided that the resulting ACB does not exceed your IMS PSB pool size. Each
transaction can have different security requirements to allow more lenient access to
certain databases. Transaction security can be enhanced by using the File-AID for IMS
security exit, other security products, or both.
Refer to “5) Static Link of XVJOPOIX (Optional to support multiple XVJOPOIX modules)”
on page 9-27 for more information.
Naming Conventions
File-AID for IMS enables you to customize MFS format, program, DBD, and transaction
names to your installation’s naming conventions. However, certain rules must be
followed so that File-AID for IMS can find the modules it needs during execution. The
following table summarizes these rules.
Table 9-1.
Naming Convention Rules
Module
Format of Name
Restrictions
Default
TRANSACTION
1 to 8 characters
None
FILEAID
DBD
1 to 8 characters
None
See Source Code
MFS MOD
1 to 4 character prefix

3 to 4 character suffix
Same number of
characters as MID
Cannot Change
IXDO

See Source Code
MAIN PROGRAM
1 to 8 characters
Must Match PSB
IXDMAINa
OTHER PROGRAMS
1 to 4 character prefix
3 to 4 character suffix
None
Cannot Change
IXD
See Source Code
a. the main program name (default IXDMAIN) is replaced with the value you specified for variable
“MAINPGM” on page 9-15.
Transaction and DBD names can be completely modified. However, the MFS MOD names
and program names must adhere to the rules listed above.
File-AID for IMS/DC Product Configuration
9-3
The first three or four characters of the default program names (other than the main
program’s) and MFS MOD names can be partially modified to meet your installation’s
requirements. The characters that can be modified are referred to as the prefix. You can
use a different prefix for the MFS MODs and program names.
The default prefix for the MOD names is IXDO. If you change the length of the MFS
MOD prefix (that is, from IXDO to IXD) in the MFS source code, you must also change
the length of the MFS MID prefix to match that of the MOD prefix (that is, from IXDI to
IXI) in the MFS source code. Do not change the program prefix for IXDHEDX or
IXMHED1.
The default for the program names is IXD. The remaining characters (the suffix) are not
modifiable. The main program’s name, IXDMAIN, can be completely changed (see
“MAINPGM” on page 9-15). The only restriction is that its name, or its alias name, must
be the same as the PSB/ACB name (this is an IMS restriction).
After choosing the prefixes appropriate for your installation, change the MFS source code
and load module names to reflect your choices. This modification is explained in
Chapter 3, “Product Customization”.
Before starting the installation process, determine what names and prefixes your
installation will be using.
Audit Trail Feature
The File-AID for IMS Audit Trail feature is an option that captures user updates to a
database into the File-AID for IMS’ Audit Trail (AUD) control database. The database
update information can then be extracted from the AUD control database with the batch
Audit Trail extract program (XIXATEXT). The extracted information is then sorted and
processed by the batch reporting program (XIXATRPD), which generates the Audit Trail
Report.
The end users of File-AID for IMS do not have any control over which databases are
protected by the Audit Trail feature. Those decisions are made and administered at the
installation level by the individual or group responsible for File-AID for IMS. The user
database updates that are to be captured by the Audit Trail feature are specified in the
File-AID for IMS installation parameters described on page 3-14, the File-AID for IMS
Security Exit described in Appendix B, “File-AID for IMS Security Exit”, or both.
The Audit Trail Extract program (XIXATEXT) and the Audit Trail Report program
(XIXATRPD) are actually part of File-AID for IMS/ISPF and are located in that load library.
These programs can be run as DL/I batch or BMP jobs. These programs and the sort of the
extracted audit trail information are described in the File-AID for IMS/CICS and File-AID for
IMS/DC Reference manual.
Compuware recommends that you decide whether you want to use the Audit Trail feature
at your installation before you actually begin to install File-AID for IMS. If you don’t want
to use the Audit Trail feature immediately but think you may want to in the near future,
it is simpler to include the Audit Trail feature in the installation process. You can include
the necessary Audit Trail control database information into the installation process and
still disable the Audit Trail feature through the File-AID for IMS installation parameters. If
you add the Audit Trail feature later, you will be required to execute several of the
installation steps again (e.g., regenerate PSBs and ACBs).
Each step of the installation process described in this guide that can be affected by the
use of the Audit Trail feature contains an appropriate explanation.
DBD Tailoring
File-AID for IMS uses three databases to store information created or used during
execution. These databases are referred to as control databases. Two of the control
databases are required and one is optional.
9-4
File-AID Single Install Image Installation and Configuration Guide
The LTM control database is required and is used to store information between
transactions. It is updated as each transaction ends, before the screen is displayed. The
other required control database is CLT, which contains static information about the user
databases, including segment layouts. The CLT is updated primarily by the DBD Update
and XREF Update batch programs. The use of these programs is described in the File-AID
for IMS/CICS and File-AID for IMS/DC Reference manual.
The third control database is the optional AUD or Audit Trail control database. If you
choose to use the Audit Trail feature of File-AID for IMS at your installation, the AUD
database is used to capture the update activity processed against the databases you
specify. It is not necessary to create the AUD control database if you do not choose to use
the Audit Trail feature at your installation.
All three control databases use the HDAM access method and IBM’s randomizing module
DFSHDC40. There are two parameters that are input to this randomizing module that
must be altered to your installation’s requirements—the Relative Block Number (RBN)
and the Root Addressable Area size (BYTES). These parameters are specified in the
RMNAME= keyword in the DBD statement for each of the three control database DBDs.
To calculate the RBN parameter for the LTM control database, multiply the estimated
number of users who will be using File-AID for IMS (allow for growth) by 1.20. To
calculate the RBN parameter for the CLT database, add the number of user databases to
the number of layouts for the segments in those databases (allow for growth), and
multiply this number by 1.20.
Calculate the RBN parameter for the AUD database as follows:
• Decide how often you plan to extract and delete the Audit Trail database segments
(by executing the XIXATEXT program as described in the File-AID for IMS/CICS and
File-AID for IMS/DC Reference manual).
• Estimate the typical total number of segment updates (inserts, repeats, deletes, and
replaces of all database segment types) that will take place at your installation (across
all the user databases where the Audit Trail feature will be active) between the
planned extraction and deletion of the Audit Trail database segments.
• Divide the number of total updates by 16.
The resulting value is the RBN used for the AUD control database. For example, if you
plan to extract and delete the segments from the Audit Trail database every two days and
the daily segment updates total is estimated at 400, then the RBN is calculated as (2 *
400)/16 = 50.
Refer to the LTM and CLT databases table to determine the BYTES parameter. In the
Maximum User DB Segment Length column, find the row that corresponds to your
installation’s maximum user database segment length. Within this row, find the BYTES
operand from the RMNAME Bytes column. Because the minimal SEGM bytes for the LTM
and CLT databases is 8,158 bytes, use the data from row one if all your user databases
have segment lengths less than 8,153 bytes. The same RMNAME bytes parameter must be
used for both the CLT and LTM databases. Also, based on the row selected, use the
corresponding CI/BLOCK value for the SIZE parameter in the DATASET statement in both
control databases.
File-AID for IMS/DC Product Configuration
Table 9-2.
9-5
LTM and CLT Databases
DBD Parameters
Dataset Allocation
RMNAME
Bytes
SEGM Bytes
CI/BLOCK
RECSZ
8,153 or less
8,177
8,158
8,192
8,185
8,192
12,249 or less
12,273
12,254
12,288
12,281
12,288
16,345 or less
16,369
16,350
16,384
16,377
16,384
20,441 or less
20,465
20,446
20,480
20,473
20,480
24,537 or less
24,561
24,542
24,576
24,569
24,576
28,633 or less
28,657
28,638
28,672
28,665
28,672
30,681 or less
30,705
30,688
30,720
30,713
30,720
Maximum User DB
Segment Length
Buffer Used
To determine the BYTES parameter for the AUD database, you must first perform the
following steps:
1. Determine the length of the longest user database segment whose updates will be
captured by the Audit Trail feature. This value is specified for the BYTES= keyword in
the SEGM statement that defines each user database segment type in the DBD source
code for each database.
2. Determine the length of the longest fully concatenated key to a user database
segment whose updates will be captured by the Audit Trail feature. One way to
determine this value is to look for the largest KEYLEN= parameter value specified on
a PCB statement within the PSBs that contain an Audit Trail database PCB.
Add the longest segment length value to the longest concatenated key value. Then, find
the row that corresponds to the result in the Maximum User DB Segment Plus Concat Key
Length column in the AUD database table (Table 9-3). Within this row, find the BYTES
operand from the RMNAME Bytes column. Because the minimal SEGM bytes for the AUD
database is 8,102 bytes, use the data from row one if the result you calculated is less than
8054 bytes. Also, based on the row selected, use the corresponding CI/BLOCK value for
the size parameter in the DATASET statement in the AUD database.
Table 9-3.
AUD Database
Maximum User DB
Segment Plus Concat
Key Length
DBD Parameters
Dataset Allocation
RMNAME
Bytes
SEGM Bytes
CI/BLOCK
RECSZ
8,054 or less
8,117
8,102
8,192
8,185
8,192
12,150 or less
12,213
12,198
12,288
12,281
12,288
16,246 or less
16,309
16,294
16,384
16,377
16,384
20,342 or less
20,405
20,390
20,480
20,473
20,480
24,438 or less
24,501
24,486
24,576
24,569
24,576
28,534 or less
28,597
28,582
28,672
28,665
28,672
30,582 or less
30,645
30,630
30,720
30,713
30,720
Buffer Used
Further modifications to the control database DBDs are explained in Chapter 3, “Product
Customization”.
PSB Tailoring
All PSBs used by File-AID for IMS must contain five PCBs for the CLT and LTM control
databases, as well as PCBs for the user databases. If the Audit Trail feature is going to be
activated for any of the user databases accessed through a given PSB, then a sixth PCB
9-6
File-AID Single Install Image Installation and Configuration Guide
must be coded for the AUD control database. In a single transaction configuration there
is only one PSB that will contain these PCBs.
However, in a multiple transaction configuration, there are usually multiple PSBs, each
with PCBs for the control databases and PCBs for a subset of the user databases. Some
thought must be given to grouping the user database PCBs into the PSBs. Following are
some suggestions:
1. Provide each programming group with its own PSB, which contains PCBs for the
databases that the group uses.
2. Group each set of application related databases into its own PSB.
3. Group databases that have strict access security in a PSB separate from databases that
have more lenient access.
4. Group test database PCBs in one PSB, production database PCBs in another.
Remember, a separate transaction code must be created for each PSB defined.
Note:
Each PCB within a PSB requires storage in the IMS PSB pool. In some situations,
depending on the number of PCBs in the PSB, the installation limit for the IMS
PSB pool size may be exceeded. If this limit is exceeded, you must either split the
PSB into smaller PSBs and create a separate transaction for each PSB, or increase
the IMS PSB pool size.
Following are some guidelines for creating PSBs:
1. The first five PCBs in the source code must be exactly as shown in Figure 3-30 on
page 3-30, except for the NAME= operand on the first PCB. This name corresponds to
the transaction name and is used for message switching. The sixth PCB, as shown in
that chapter, is optional for the AUD control database.
2. The PROCOPT parameter on all user database PCBs should be A and should be
specified on the PCB macro and not the SENSEG macro. If you want to enforce
security using the PSBs, you can specify a PROCOPT parameter of G, GO, or GOT on
the user databases. This action causes File-AID for IMS to display an abend screen with
an AM status code and then the Primary Option Menu whenever one of these user
databases is edited.
3. To exclude a segment from processing by File-AID for IMS, simply leave the segment
out of the PCB. The excluded segment is not displayed nor updated.
4. Do not code more than one PCB per database within a single PSB. File-AID for IMS
cannot differentiate between them.
IMS System Definition
File-AID for IMS runs like any other IMS application and, therefore, must be initially
defined to the IMS system. Because system definition can be performed only at specific
times at your installation, it will speed the installation process if you do the following
before starting the detailed installation steps:
1. Code an APPLCTN and TRANSACT macro for each transaction/PSB combination to
be used in your installation configuration. These macros are input to the IMS Stage 1
system definition job.
The PSB= operand must be the same as the main program name or an alias’ program
name and correspond to the PSBNAME= operand of the PSB used as the transaction.
APPLCTN PSB=IXDMAIN,PGMTYPE=(TP,,,)
For full-featured databases code the following:
TRANSACT CODE=FILEAID,MSGTYPE=(SNGLSEG,RESPONSE),MODE=SNGL,
PROCLIM=(10,2),EDIT=ULC,SCHD=1
File-AID for IMS/DC Product Configuration
9-7
For Fast Path databases code the following:
TRANSACT CODE=FILEAID,MSGTYPE=(SNGLSEG,RESPONSE),MODE=SNGL,
PROCLIM=(10,2),EDIT=ULC,SCHD=1,FPATH=YES
The CODE= operand in the TRANSACT macro corresponds to the NAME= operand in
the first PCB in the transaction’s PSB. Refer to “Step 5f. Modify PSBs” on page 3-29.
IMPORTANT:
The TRANSACT macro must be coded with the RESPONSE keyword, and the
TERMINAL macro CANNOT be coded with NORESP. Failure to do this will yield
unpredictable results.
To browse/edit Fast Path databases with File-AID for IMS you need to define the
transaction as an IMS Fast Path potential transaction. File-AID for IMS does not run as
a Fast Path exclusive transaction. An IMS Fast Path potential transaction is identified
by a TRANSACT macro statement that specifies FPATH=YES following an APPLCTN
statement that does not specify FPATH=YES
2. Code a DATABASE macro to define the required CLT and LTM control database DBDs,
the three sample database DBDs, and, optionally, the AUD DBD. These macros are
input to the IMS Stage 1 system definition job.
DATABASE
DATABASE
DATABASE
DATABASE
DATABASE
DATABASE
DBD=IXDCLT,ACCESS=EX
DBD=IXDLTM,ACCESS=EX
DBD=IXDAUD,ACCESS=EX
DBD=PCUST,ACCESS=EX
DBD=PORDR,ACCESS=EX
DBD=PPART,ACCESS=EX 
If you want the Data Management Block (DMB) created by the database statement to
be made resident in storage during system initialization, include the resident option
on the database statement.
3. Code a DFSMDA macro for each of the control databases and the sample databases, if
desired. Use the procedures in place at your installation to make them available to
IMS.
DFSMDA TYPE=DATABASE,DBDNAME=IXDCLT
DFSMDA TYPE=DATASET,DSNAME=XXXXXXX.IXDCLT,
DDNAME=IXDCLTDD
DFSMDA TYPE=DATABASE,DBDNAME=IXDLTM
DFSMDA TYPE=DATASET,DSNAME=XXXXXXX.IXDLTM,
DDNAME=IXDLTMDD
DFSMDA TYPE=DATABASE,DBDNAME=IXDAUD
DFSMDA TYPE=DATASET,DSNAME=XXXXXXX.IXDAUD,
DDNAME=IXDAUDDD
DFSMDA TYPE=DATABASE,DBDNAME=PCUST
DFSMDA TYPE=DATASET,DSNAME=XXXXXXX.FIDSAMP.CUSTOMER,
DDNAME=PCUSTDD
DFSMDA TYPE=DATABASE,DBDNAME=PORDR
DFSMDA TYPE=DATASET,DSNAME=XXXXXXX.FIDSAMP.ORDER,
DDNAME=PORDRDD
DFSMDA TYPE=DATABASE,DBDNAME=PPART
DFSMDA TYPE=DATASET,DSNAME=XXXXXXX.FIDSAMP.PART,
DDNAME=PPARTDD
4. If you want the control databases and sample databases to be under the control of
DBRC, code an INIT.DB and INIT.DBDS command for each. These commands are
input to the Recovery Control Utility of DBRC.
9-8
File-AID Single Install Image Installation and Configuration Guide
INIT.DB DBD(IXDCLT) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(IXDCLT) DDN(IXDCLTDD)
DSN(XXXXXXX.IXDCLT) GENMAX(2)
INIT.DB DBD(IXDLTM) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(IXDLTM) DDN(IXDLTMDD)
DSN(XXXXXXX.IXDLTM) GENMAX(2)
INIT.DB DBD(IXDAUD) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(IXDAUD) DDN(IXDAUDDD)
DSN(XXXXXXX.IXDAUD) GENMAX(2)
INIT.DB DBD(PCUST) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(PCUST) DDN(PCUSTDD)
DSN(XXXXXXX.FIDSAMP.CUSTOMER) GENMAX(2)
INIT.DB DBD(PORDR) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(PORDR) DDN(PORDRDD)
DSN(XXXXXXX.FIDSAMP.ORDER) GENMAX(2)
INIT.DB DBD(PPART) SHARELVL(0) TYPEIMS
INIT.DBDS DBD(PPART) DDN(PPARTDD)
DSN(XXXXXXX.FIDSAMP.PART) GENMAX(2)
Access Fast Path Databases
File-AID for IMS supports browse/edit access to Fast Path databases.
To access Fast Path databases you can create a transaction/PSB combination that is
separate from your full feature databases. To do this, create a PSB as described in the
guidelines listed under “PSB Tailoring” on page 9-5.
Next, you must code an APPLCTN and TRANSACT macro for a Fast Path potential
transaction. (Refer to “IMS System Definition” on page 9-6.)
Other than the above there are no other differences between accessing a Fast Path
database and a full featured IMS database.
Space Allocation
File-AID for IMS’s control databases require one dataset each. It is recommended that the
control databases be allocated as VSAM files because of their segment sizes. However, if
your installation does not want to use VSAM, the control databases can be allocated as
OSAM files, but the ACCESS parameter of the DBD macro within the DBD source must be
modified to reflect this.
Use the following formulas to calculate the space needed by the control databases:
• LTM dataset size: 
bytes = RBN calculated earlier * CI size * 14
• CLT dataset size: 
bytes = RBN calculated earlier * CI size
• AUD dataset size: 
bytes = RBN calculated earlier * CI size
These formulas assume a stable user base. If you anticipate that the user base will grow,
you should factor this growth into the formulas before allocating the datasets.
Convert the number of bytes required to the number of cylinders required.
CLT Control Database
As mentioned earlier, the CLT control database contains information about the user
databases. A control segment, also found on this database, stores various counts and
control fields used to verify the database’s integrity. Most of this information remains
static during on-line File-AID for IMS execution. However, there are three batch programs,
File-AID for IMS/DC Product Configuration
9-9
herein referred to as DBD Update (XIXDBDUP), XREF Update (XIXXRFUP), and Rebuild
Control Segment (XIXREBLD), that are used to maintain the information on the CLT
database. These programs are actually part of File-AID for IMS/ISPF and are located in that
load library. The programs can be run either as DL/I batch or BMP jobs.
The DBD Update program updates the CLT control database with information about the
user databases’ hierarchical structure. The DBD Update program uses the DBD control
blocks from the DBD load library to obtain this information.
Note:
This job must be run for each database before it can be accessed under File-AID
for IMS
The XREF Update program updates the CLT control database with information about the
segment-to-layout cross-reference. The XREF Update program uses the segment/layout
XREF data created in File-AID for IMS/ISPF option 7, along with the DBD information
gained by the DBD Update program. This job must be run to allow File-AID for IMS access
to your segment layouts. It does not need to be run if segment layouts do not exist.
However, if not run, formatted mode is not available.
These jobs are run during the Detailed Installation Steps for the sample databases. If you
want to access additional databases, the DBD Update program must be run again using
control cards for your databases. Optionally, the XREF Update job must be run to allow
use of your segment layouts. Refer to the File-AID for IMS/CICS and File-AID for IMS/DC
Reference manual for more information.
The Rebuild Control Segment program recreates the control segment. If the control
segment was inadvertently updated or deleted, it must be rebuilt to ensure accurate
processing of the databases. Refer to “DD Statements” on page C-3 for more information.
MFS Tailoring
MFS formats for 3270 Model 2 devices and symbolic device types of 3270-A2, 3270-A3,
3270-A4, and 3270-A7 are supplied with File-AID for IMS. The following screen sizes are
assumed for these symbolic devices.
Device
Screen Size
3270-A2
24 x 80
3270-A3
32 x 80
3270-A4
43 x 80
3270-A7 *
27 x 132
Note:
Display will be 24 x 80
If your installation has defined these symbolic device types differently, you must change
the TYPE= operand on the DEV macro in the MFS source code. If you are not sure how
your installation has defined the symbolic device types, the MFS Service Utility can
produce a report that lists the device characteristics table.
If your installation does not have all the previously mentioned symbolic devices defined
to IMS, you must modify the MFS source code before it is assembled. Either comment out
or delete the DIF/DOFs for the symbolic terminal types that are not supported.
If you change the length of the MFS MOD prefix (that is, from IXDO to IXD) in the MFS
source code, you must also change the length of the MFS MID prefix to match that of the
MOD prefix (that is, from IXDI to IXI) in the MFS source code.
9-10
File-AID Single Install Image Installation and Configuration Guide
Limiting DL/I Calls
Compuware recommends that a limit be enforced on the number of DL/I database
movement calls permitted during one transaction to prevent excessive resource usage
when browsing or editing large databases. A database movement call is one that changes
your position to another segment. This limit is specified in the “LMTCALLS” field in the
product parameters (see “LMTCALLS” on page 9-15). When the specified limit is reached,
the position is at the last segment retrieved, and a message is displayed on the screen.
Security
Access can be controlled with the same security procedures currently in place at your
installation because File-AID for IMS runs as an MPP application under IMS. Like any
other application, it must be defined to your security package during the installation
process.
An exit is provided for your use when additional security checks are wanted. Refer to
“File-AID for IMS/CICS and File-AID for IMS/DC Security Exit” on page E-30 for details
on how to write the security routine.
In many instances it may be desirable to limit access of certain databases to specific users.
This can be accomplished in the following ways:
1. Code a security exit that checks the DBD name against the User ID entered either
during sign-on or on the Primary Option Menu. This is the only way to limit
database access in a single transaction configuration.
2. Create multiple PSBs with different database PCBs within them. Assign each PSB to a
separate transaction, and use transaction security to limit their use. With this
method, the File-AID for IMS security exit is not required. You can simply use the
security procedures currently in place at your installation. This is the method
recommended for multi-transaction configurations.
In addition, your normal PTERM, LTERM, and PSB security can be enforced with the use
of security packages that may be installed at your installation.
IMS Message Queues
Because IMS does not allow an MFS output message to span logical records, the system
large message queue record length must be long enough to contain the messages
produced by File-AID for IMS and the system prefix. The following table outlines these
requirements.
Table 9-4.
IMS Large Message Queue Requirements
Screen Size
Message Length
LGMSG Queue Size Required*
24 x 80
1764
1852
32 x 80
2404
2492
43 x 80
3353
3441
Note:
Add 48 bytes if MSC is installed
Large message queue sizes that are less than these will cause unpredictable results. The
large message queue size at your installation can be verified with the IMS command
/DISPLAY POOL QBUF. If the queue is not large enough, the value on the IMS system
macro MSGQUEUE must be increased. Refer to IMS/ESA Installation Guide for more
information.
File-AID for IMS/DC Product Configuration
9-11
Configuration Procedures
Configuration Prerequisites
Before continuing with the File-AID for IMS/DC configuration you must have configured
the File-AID Common Component module XVJOPUNV (see “Step 2. Specify File-AID
Common Component Parameters” on page 2-7) and the IMS Environment Module
XVJOPIMS (see “Step 3.2. Specify IMS Environment (Option 2)” on page 2-39) as well as
File-AID for IMS/ISPF module XVJOPXIX (see Chapter 7, “File-AID for IMS/ISPF Product
Configuration”).
Step 1. Select File-AID for IMS/DC
Select option 3 from the “Configuration Facility Menu” (Figure 2-2 on page 2-4) to
display the File-AID “Product Configuration Menu” (see Figure 9-1). It lists all File-AID
mainframe products.
Figure 9-1. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD
Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE
9
START - Start products to verify installation 















Select Option 7, File-AID for IMS/DC.
Step 2. Specify Source of Product Parameters
When selecting Option 7, File-AID for IMS/DC from the “Product Configuration Menu”
(Figure 9-1), the “Source of Product Parameters” screen displays, prompting you to
specify the installation dataset of the previously installed product release or the name of
a load library containing File-AID Configuration modules in order to populate product
specific parameters.
9-12
File-AID Single Install Image Installation and Configuration Guide
Figure 9-2. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):

Previous install dataset . .
OR
Configuration library . . .

Press ENTER to continue. 




1. Specify either
– the name of a File-AID for IMS/DC install dataset prior to Release 10.1
OR
– the name of the File-AID Configuration (load) library that includes a File-AID for
IMS/DC XVJOPOIX module you want to use as a source for your parameter input
OR
– Leave both fields blank if this is your initial installation of File-AID.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
If you leave the Previous Install dataset as blank, it will be ignored. A valid
previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID for IMS/DC,
then you may retain the previously specified variable values. This is
accomplished by specifying the name of the .INS dataset (e.g.
hlq.CPWR.BG121116.INS or hlq.COMPWARE.OXIX760.INSTALL) that was
previously used to install File-AID for IMS/DC product.
When specifying an unsupported install dataset, this pop-up message displays:
CANNOT IMPORT CONFIGURATION VALUES FROM
THE SPECIFIED DATASET
'TSOID01.IXD.V070200.INSTALL'




DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINOIX) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables can be carried
forward to the new configuration parameters; product installation
defaults are used when previous variable values cannot be imported. You
must visit Option 2, SPECIFY PARMS (see “Step 4. Specify File-AID for
File-AID for IMS/DC Product Configuration
9-13
IMS/DC Product Configuration Parameters” on page 9-14) to verify the
variable values.
Configuration library : Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release where you
already have configured the File-AID for IMS/DC XVJOPOIX module which you
want to use as a source for your parameter input.
If you want to use a preexisting XVJOPOIX parameter module (v10.1 or higher),
you can specify the name of the dataset that contains it. If a valid parameter
module is found, ALL values will be initialized from there. If the utility finds a
CXVJLOAD dataset with a hlq that matches the SXVJSAMP you are executing
from AND a valid parameter module is found, this field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID for IMS/DC
Product Configuration Menu” shown in Figure 9-3 which lists the File-AID for IMS/DC
Product Configuration options.
Figure 9-3. File-AID for IMS/DC Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID for IMS/DC

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 9-12). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARMS module.
Configuration Output : Identifies the configured load library to which the File-AID for
IMS/DC module XVJOPOIX will be saved.
The available options in the “File-AID for IMS/DC Product Configuration Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
• CUSTOMIZE: Generate customized objects.
Select one of the available options.
9-14
File-AID Single Install Image Installation and Configuration Guide
Step 3. Review Target and Configuration Module Libraries
Select option 1 from the “File-AID for IMS/DC Product Configuration Menu” to display
the “Dataset Name Specification” panel (Figure 2-6 on page 2-11). Here you review the
dataset information for the File-AID SMP/E Target Libraries that were created during the
SMP/E installation (see Chapter 2, “RFN SMP/E Installation of Compuware Mainframe
Products” or Appendix A, “SMP/E Installation Using the EP Media Interface” in the
Compuware Installer Mainframe Products SMP/E Installation Guide) and the File-AID
Configuration Module Libraries. The displayed list is the same as displayed in Figure 2-6
on page 2-11. Refer to “Step 2.1 Specify Configuration Module Dataset Names” on page
2-10 for more information.
Step 4. Specify File-AID for IMS/DC Product Configuration Parameters
Select Option 2 from the “File-AID for IMS/DC Product Configuration Menu” to display
the “File-AID for IMS/DC Product Configuration Parameters” panel (Figure 9-4). Option 2
allows you to specify values for variables that the Configuration Facility uses to configure
File-AID for IMS/DC. The values that you provide are saved in the parameter variables list.
A listing of all the variables is provided in Table 9-5 on page 9-15.
The first time you select Option 2, and you didn’t specify either a previous install or
Configuration library, the Configuration Facility populates the parameter variables with
the default values delivered with the product.
Use the HELP command (PF1) to receive information on using this screen.
After entering and reviewing the desired values, Press END (PF3) to save your changes
and continue to the Edit JCL screen where you can submit the job to assemble the
File-AID for IMS/DC parameter module XVJOPOIX, or CANCEL to exit the screen without
saving your changes.
Figure 9-4. File-AID for IMS/DC Product Configuration Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>

Product.... File-AID for IMS/DC
Version.... 10.02.00
Variable
-------MAINPGM
MODPRFX
PGMPRFX
ENDMOD
IMSVERSN
LMTCALLS
INTEGIND
CAPSMODE




Value
Description

--------------------------------------------------------------------- 
More:
+ 
IXDMAIN Name for File-AID for IMS/DC main load module. 
Default=IXDMAIN

MOD name prefix - must be the same as name in MFS source. 
IXDO
Default=IXDO
Program prefix - 1-4 character prefix to load module names. 
IXD
Default=IXD

The MFS MOD name that you want formatted upon exit. 
Default=IXD

The Version-Release of IMS.

12100
(IMS 12.1.0=12100) Default=12100

Limit of database calls in one transaction.

100
(50-32767) Default=100

Integrity check indicator.

Y
(Y=YES,N=NO) Default=Y

Initial CAPS mode setting.

ON
Scroll through this screen to review and update all the variables as required for your site.
File-AID for IMS/DC Product Configuration
9-15
A value is required for all variables, unless stated otherwise in the comments column.
Table 9-5 provides descriptions for all variables.
Table 9-5.
File-AID for IMS/DC Product Options
Label
Default Value Your Value
Description
MAINPGM
IXDMAIN
Name for File-AID for IMS/DC main load module.
Default=IXDMAIN
Load module name to use to link the File-AID for
IMS/DC load module (XIXDMAIN) shipped with the
product.
MODPRFX
IXDO
MOD name prefix - must be the same as name in MFS
source.
Default=IXDO
MOD name prefix (one to four character prefix) must be the same prefix as that specified for the MOD
names in the MFS source dataset to be used by
File-AID for IMS/DC. For example, if you change load
module names to have prefix IXDO, then code as
IXDO.
PGMPRFX
IXD
Program prefix - 1-4 character prefix to load module
names. 
Default=IXD
Must be the same prefix as that specified for the load
module names. For example, if you change load
module names to have prefix IXD, then code as IXD.
ENDMOD
The MFS MOD name that you want formatted upon
exit.
End MFS MOD name. Specify the MFS MOD name
that you want formatted upon exit from the product
(for example, a user menu used to invoke File-AID).
Leave blank if MOD is not to be formatted upon exit.
IMSVERSN
12100
The Version-Release of IMS.
(IMS 12.1.0=12100) Default=12100
The Version-Release of IMS to use with File-AID for
IMS/DC. The first two bytes are version, last three are
release. For example, code IMS 12.1.0 AS "12100".
LMTCALLS
100
Limit of database calls in one transaction. 
(50-32767) Default=100
Database movement call limit. The maximum
number of database movement calls that are
permitted during one transaction. Recommended
minimum value is 50. Maximum allowable value is
32,767.
INTEGIND
Y
Integrity check indicator. 
(Y=YES,N=NO) Default=Y
Indicates whether a check will be made for a change
made by a concurrent user prior before the IMS
record is replaced:
Y - Check for change and prompt for action.
N - Replace as changed without checking.
CAPSMODE
ON
Initial CAPS mode setting.
(ON,OFF) Default=ON
Initial CAPS mode setting to be used when a user
invokes File-AID for IMS/DC:
ON - Character data is translated to upper case.
OFF - Character data is stored as entered.
9-16
File-AID Single Install Image Installation and Configuration Guide
Table 9-5.
File-AID for IMS/DC Product Options (Continued)
Label
Default Value Your Value
Description
CODEPAGE
0697
Codepage used to determine displayable characters.
(0697,0277,0290,0297,0424,0500,0833,0838,
0905) Default=0697
Four digit code for the codepage translation to be
used by File-AID for IMS/DC.
0697 - English (Default)
0277 - Danish/Norwegian
0290 - Japanese Katakana
0297 - French
0424 - Hebrew
0500 - Swiss French/Swiss German
0833 - Korean
0838 - Thai
0905 - Canadian Bilingual
ATTRLDBD
Audit trail DBD name.
(blank=No Audit) Default=blank
Audit trail DBD name - the DBD name of the audit
trail database to be used with this installation of
File-AID for IMS/DC. Leave this entry blank if the audit
trail feature will not be used with this installation.
Enter *NOCHK* if you want File-AID for IMS/DC to
attempt to use the database to write audit records
without validating that the DBD name in the PSB
matches the one specified here.
DEPSEGNO
-1
Maximum dependent segments written to audit trail
database.
(0-32767,-1) Default=-1
The maximum number of dependent segments to be
written to the audit trail database when a parent
segment is deleted:
0 to 32767 - The maximum number of deleted child
segments written to the audit trail database.
-1 - All deleted child segments are written to the audit
trail database.
When a segment that has dependent segments under
it is deleted, IMS automatically deletes all those
dependent segments. Indicate the maximum number
of deleted dependent segment images you want
written to the Audit Trail database for a given deleted
parent. Default value of -1 indicates that images of all
deleted dependents are to be captured. Specify zero
if deleted dependents are not to be captured. The
maximum allowable value is 32,767.
MAXSEGSZ
30630
Maximum segment size written to the audit trail
database.
(specify value from table in Installation Guide)
Default=30630
This is the MAX BYTES value you specified for the
BYTES= keyword on the SEGM statements in the AUD
database DBD source code. Refer to “DBD Tailoring”
on page 9-3 for additional information about the
AUD database segments’ size
File-AID for IMS/DC Product Configuration
Table 9-5.
9-17
File-AID for IMS/DC Product Options (Continued)
Label
Default Value Your Value
Description
ALLNONE
N
Audit Trail indicator.
(A=All minus exception list,N=None but exception
list) Default=N
All/None Audit Trail indicator. Indicates whether or
not to create an audit trail when data are edited. This
indicator is used in conjunction with the optional
DBD exception list.
A - The audit trail feature will be active for all data
bases edited using File-AID for IMS/DC except for
those specified in the optional DBD exception list.
N - The audit trail feature will not be active for any
databases edited using File-AID for IMS/DC except for
those listed in the optional DBD exception list.
IMS.SDFSRESL
Specify the IMS RESLIB.
DATASETS
IMS RESLIB
Step 5. Review and Submit JCL
After entering the desired parameter values in the “File-AID for IMS/DC Product
Configuration Parameters” panel (Figure 9-4 on page 9-14), and pressing END (PF3), the
“Edit JCL Screen for File-AID for IMS/DC Parameter Module XVJOPOIX” panel (Figure 95) displays.
Review and submit the job to create or modify File-AID for IMS/DC Parameter Module
XVJOPOIX or CANCEL to exit the screen without saving your changes.
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Product Configuration Menu”, the changes you made in the “File-AID for
IMS/DC Product Configuration Parameters” panel (Figure 9-4 on page 9-14) will NOT be
saved.
Figure 9-5. Edit JCL Screen for File-AID for IMS/DC Parameter Module XVJOPOIX
EDIT
TSOID01.CPWR.MXVJA20.WORK($OIX01) - 01.00
Columns 00001 00072
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 /*JOBPARM S=CW01

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*-----------------------------------------------------------
000007 //* ASSEMBLE CUSTOMIZATIONS PARAMETERS (XVJOPOIX)

000008 //*-------------------------------------------------------------------- 
000009 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED. 
000010 //*-------------------------------------------------------------------- 
000011 //*

000012 //IXDPROC2 PROC

000013 //*

000014 //*-------------------------------------------------------------------- 
000015 //*
STEP1: ASSEMBLE XVJOPOIX

000016 //*-------------------------------------------------------------------- 
000017 //*

000018 //STEP1
EXEC PGM=ASMA90,

000019 //
PARM='NODECK,OBJECT,RENT',REGION=1024K 
Note: If you update a product option variable after you have completed the
configuration process, always submit the JCL to save updates to the parameter
module in the File-AID load library.
9-18
File-AID Single Install Image Installation and Configuration Guide
Step 6. Review Job Output
When you receive the job completion message, review the job output and verify that
File-AID for IMS/DC Parameter Module XVJOPOIX has been created or updated.
Step 7. Make Load Modules Available to DC
Whenever you link or relink the following DC load modules:
xxxEDTF
xxxEDTI
xxxEDTL
xxxEDTS
xxxEDTU
xxxKEY
IXDMAIN
XVJOPOIX
the new load modules are written to the CXVJLOAD library. The prefix xxx is replaced
with the prefix value you specified for variable “PGMPRFX” on page 9-15 and the main
program name (default IXDMAIN) is replaced with the value you specified for variable
“MAINPGM” on page 9-15.
You must make these load modules available to IMS in order to access File-AID for
IMS/DC.
Step 8. Generate Customized Objects
Select Option 3 from the “File-AID for IMS/DC Product Configuration Menu” to display
the “File-AID for IMS/DC Customization Tasks Menu” panel (Figure 9-6). Option 3
provides instructions on what jobs need to be run. Refer to Appendix E, “File-AID for
IMS Exits” for more information on exits.
Figure 9-6. File-AID for IMS/DC Customization Tasks Menu
File-AID ------------------- Customization Tasks ----------------------------
OPTION ===>

Product.... File-AID for IMS/DC

Version.... 10.02.00


-----------------------------------------------------------------------------
More:
+ 
The Following JCL members can be found in the SXVJSAMP library:


1) Create Aliases for XIXDMAIN (Required) 

XIXDALIA - Link Edit to add aliases

2) Assemble and Link IMS modules (Required) 

XIXDDBD
- Assemble and Link an IMS DBD


XIXDPSB
- Assemble and Link an IMS PSB


XIXDACB
- Assemble and Link an IMS ACB 

XIXDMFS
- Assemble and Link IMS MFS members

3) ALLOCATE LTM, CLT and Audit Trail Database Datasets (Required) 
1) Create Aliases for XIXDMAIN (Required)
The following JCL members are provided in the File-AID sample library SXVJSAMP:
File-AID for IMS/DC Product Configuration
9-19
• XIXDALIA - Link Edit to add aliases
Follow the instructions in “Create Aliases to the Main Load Module (XIXDMAIN)”.
Create Aliases to the Main Load Module (XIXDMAIN)
Member XIXDALIA creates aliases to the main load module IXDMAIN1. This step is only
required when you install a multiple transaction configuration. If you install a
single transaction configuration of File-AID, skip this step.
1. Enter a job card in installation JCL member XIXDALIA. This job requires 512K and
no tape drives.
2. Modify the default symbolic parameters (see Table 9-6).
3. Modify the names on the linkage editor control cards (see Table 9-7).
The alias names should correspond with the PSB names associated with the
transactions in the multiple transaction configuration.
Note: The linkage editor allows a maximum of 64 aliases for one load module. If your
installation configuration has more than 64 PSBs, you must create additional
copies of the main load module (IXDMAIN) and then assign the PSB alias names
to that copy of IXDMAIN. Copying the load modules is only required for the main
load module, because it dynamically loads the other modules as required.
4. Submit the job.
Table 9-6.
XIXDALIA Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
DEV
SYSDA
Temporary work file device.
PGMLIB
XXXXXXX.PGMLIB
IMS Program Library.
Table 9-7.
Linkage Editor Control Cards
Keyword
Default
Description
INCLUDE
SYSLIB(IXDMAIN)
Main load module name specified for
“MAINPGM” on page 9-15.
ALIAS
XXXXXXXX
Alias name(s).
NAME
IXDMAIN(R)
Main load module name specified for
“MAINPGM” on page 9-15.
2) Assemble and Link IMS Modules (Required)
The following JCL members are provided in the File-AID sample library SXVJSAMP:
• XIXDDBD - Assemble and Link an IMS DBD
Follow the instructions in “Modify DBD Source Code” and “Generate DBD Control
Blocks” on page 9-22.
• XIXDPSB - Assemble and Link an IMS PSB
Follow the instructions in “Modify PSBs” and “Generate PSB Control Blocks” on page
9-23.
• XIXDACB - Assemble and Link an IMS ACB
1. The main program name (default IXDMAIN) is replaced with the value you specified for variable “MAINPGM” on
page 9-15.
9-20
File-AID Single Install Image Installation and Configuration Guide
Follow the instructions in “Generate ACB Control Blocks” on page 9-24
• XIXDMFS - Assemble and Link IMS MFS members
Follow the instructions in “Assemble and Link MFS Source Code” on page 9-24
Modify DBD Source Code
1. Modify the DBD source code for File-AID’s control databases to conform to your
installation’s specifications. Each member, IXDLTM, IXDCLT, and IXDAUD, should
be updated identically except where noted. The members are found in the Sample
Library SXVJSAMP.
DBD NAME=IXDLTM,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,30,8177)
DBD NAME=IXDCLT,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,50,8177)
DBD NAME=IXDAUD,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,16,250,8117)
NAME=IXDLTM
NAME=IXDCLT
NAME=IXDAUD
(for the LTM database)
(for the CLT database)
(for the AUD database
If necessary, modify these names to meet your installation’s DBD naming
conventions.
ACCESS=(HDAM,VSAM) (same for all control databases)
It is recommended that the control databases be organized as VSAM datasets because
of their large segment sizes. However, if your installation wants to allocate them as
OSAM datasets, change the second parameter to OSAM. Do not change the access
method (first parameter).
RMNAME=(DFSHDC40,1,30,8177)
RMNAME=(DFSHDC40,1,50,8177)
RMNAME=(DFSHDC40,16,250,8117)
(for the LTM database)
(for the CLT database)
(for the AUD database)
Substitute the RBNs calculated in “DBD Tailoring” on page 9-3 for the third
parameters. Substitute the RMNAME BYTES calculated earlier for the fourth
parameters. The RMNAME BYTES parameter must be the same for the LTM and CLT
databases. Do not change the randomizer name (first parameter) or the RAPs per CI
(second parameter).
2. Modify the following:
DATASET DD1=IXDLTMDD,DEVICE=3380,SIZE=8192
DATASET DD1=IXDCLTDD,DEVICE=3380,SIZE=8192
DATASET DD1=IXDAUDDD,DEVICE=3380,SIZE=8192
DD1=IXDLTMDD
DD1=IXDCLTDD
DD1=IXDAUDDD
(for the LTM database)
(for the CLT database)
(for the AUD database)
(for the LTM database)
(for the CLT database)
(for the AUD database)
If necessary, modify these names to meet your installation’s DDNAME conventions.
DEVICE=3380
(same for all control databases)
Change the device to the type used at your installation.
SIZE=8192 (same for LTM and CLT databases; AUD database can vary)
Find the row that corresponds to your installation’s Maximum User DB Segment
Length (for the LTM and CLT databases) or Maximum User DB Segment Plus Concat
Key Length (for the AUD database) in the tables shown in “DBD Tailoring” on page
File-AID for IMS/DC Product Configuration
9-21
9-3. Substitute the appropriate number from the CI/BLOCK column for the SIZE
parameter.
3. Find the row that corresponds to your installation’s Maximum User DB Segment
Length (for the LTM and CLT databases) or Maximum User DB Segment Plus Concat
Key Length (for the AUD database) in the tables shown in “DBD Tailoring” on page
9-3. Substitute the appropriate number from the Segm Bytes column for the
corresponding BYTE operand. Substitute this same number in all the SEGM
statements in the appropriate control database DBDs. Each control database DBD
must have the same maximum segment size on all its SEGM statements. Do not
change the NAME=, PARENT=, PTR=, or the segment minimum size parameters.
SEGM NAME=GV,PARENT=0,BYTES=(8158,10),PTR=TWIN 
BYTES=(8158,10) (same for all LTM and CLT control database segments)
BYTES=(8102,48) (same for all AUD control database segments)
DBD Samples
DBD Samples
Following are samples of the LTM, CLT, and AUD control database DBDs.
Figure 9-7 contains an example of an LTM control database DBD. Figure 9-8 contains an
example of a CLT control database DBD. Figure 9-9 contains an example of an AUD
control database DBD.
Figure 9-7. LMT DBD
PRINT
DBD
DATASET

SEGM
FIELD

SEGM
FIELD

SEGM
FIELD

SEGM
FIELD

DBDGEN
FINISH
END
NOGEN
NAME=IXDLTM,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,30,8177)
DD1=IXDLTMDD,DEVICE=3380,SIZE=8192
NAME=GV,PARENT=0,BYTES=(8158,10),PTR=TWIN
NAME=(GVKEY,SEQ,U),BYTES=8,START=3
NAME=PS,PARENT=((GV,SNGL)),BYTES=(8158,7),PTR=TWIN
NAME=(PSKEY,SEQ,U),BYTES=5,START=3
NAME=WA,PARENT=((GV,SNGL)),BYTES=(8158,5),PTR=TWIN
NAME=(WAKEY,SEQ,U),BYTES=3,START=3
NAME=ST,PARENT=((GV,SNGL)),BYTES=(8158,54),PTR=TWIN
NAME=(STKEY,SEQ,U),BYTES=52,START=3
Figure 9-8. CLT DBD
PRINT
DBD
DATASET

SEGM
FIELD
FIELD
FIELD
FIELD

DBDGEN
FINISH
END
NOGEN
NAME=IXDCLT,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,1,50,8177)
DD1=IXDCLTDD,DEVICE=3380,SIZE=8192
NAME=DCLT,PARENT=0,BYTES=(8158,60),PTR=TWIN
NAME=(DCLTKEY,SEQ,U),BYTES=52,START=5
NAME=(CLTSRCH),BYTES=84,START=85
NAME=(PRTKEY11),BYTES=11,START=5
NAME=(PRTKEY19),BYTES=19,START=5
9-22
File-AID Single Install Image Installation and Configuration Guide
Figure 9-9. AUD DBD
PRINT
DBD
DATASET

SEGM
FIELD
SEGM

DBDGEN
FINISH
END
NOGEN
NAME=IXDAUD,ACCESS=(HDAM,VSAM),RMNAME=(DFSHDC40,16,250,8117)
DD1=IXDAUDDD,DEVICE=3380,SIZE=8192
NAME=AT,PARENT=0,BYTES=(8102,48),PTR=TWIN
NAME=(ATKEY,SEQ,U),BYTES=37,START=3
NAME=ATDEP,PARENT=((AT,DBLE)),BYTES=(8102,8),PTR=TWIN,RULES=(,LAST)
Generate DBD Control Blocks
In this step, DBD control blocks are generated for the three control databases and the five
sample databases.
1. Submit DBDGENs for the databases using JCL already in place at your installation, or
use the sample JCL provided in member XIXDDBD:
a. Enter a job card in member XIXDDBD. This job requires 1024K and no tape
drives.
b. Modify the default symbolic parameters (see Table 9-8).
If the Audit Trail feature is to be activated, comment out the NULL (end of job)
JCL statement following the IXD07 step name statement, and modify the
MBR=IXDAUD statement if it was changed to satisfy your installation’s
standards.
c. Submit the job.
Table 9-8.
XIXDDBD Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
DEV
SYSDA
Temporary work file device.
SYSLIB
XXXXXXX.SDFSMAC
Macro Library.
SRCDSN
XXXXXXX.SXVJSAMP
File-AID Sample Library.
RESLIB
XXXXXXX.SDFSRESL
IMS RESLIB.
DBDLIB
XXXXXXX.DBDLIB
IMS DBD Library.
Modify PSBs
Modify the PSBs as required by your installation’s configuration. The first six PCBs in the
PSB (including the optional Audit Trail PCB) are for File-AID’s use. PCBs 7 through 500
are for your user databases. Compuware recommends that you include the four sample
database PCBs in your PSB for the initial installation. Sample Library member IXDMAIN
contains these sample databases’ PCBs.
PCB number one is used for message switching between functions. The transaction name
in the PCB must be the same as the transaction name that uses this PSB. Change the
NAME= operand of the PCB macro accordingly. Refer to “PSB Tailoring” on page 9-5 for
more information.
Note: If the Audit Trail feature is to be activated, you must uncomment the IXDAUD
PCB.
File-AID for IMS/DC Product Configuration
9-23
Figure 9-10. Program Specification Block (PSB)
PRINT
NOGEN
PCB TYPE=TP,NAME=FILEAID

PCB TYPE=DB,DBDNAME=IXDCLT,KEYLEN=52,PROCOPT=A,POS=S
SENSEG NAME=DCLT,PARENT=0

PCB TYPE=DB,DBDNAME=IXDLTM,KEYLEN=60,PROCOPT=A,POS=S
SENSEG NAME=GV,PARENT=0
SENSEG NAME=PS,PARENT=GV
SENSEG NAME=WA,PARENT=GV
SENSEG NAME=ST,PARENT=GV

PCB TYPE=DB,DBDNAME=IXDLTM,KEYLEN=60,PROCOPT=A,POS=S
SENSEG NAME=GV,PARENT=0
SENSEG NAME=PS,PARENT=GV
SENSEG NAME=WA,PARENT=GV
SENSEG NAME=ST,PARENT=GV

PCB TYPE=DB,DBNAME=IXDLTM,KEYLEN=60,PROCOPT=A,POS=S
SENSEG NAME=GV,PARENT=0
SENSEG NAME=PS,PARENT=GV
SENSEG NAME=WA,PARENT=GV
SENSEG NAME=ST,PARENT=GV

PCB TYPE=DB,DBDNAME=IXDAUD,KEYLEN=37,PROCOPT=A,POS=S
SENSEG NAME=AT,PARENT=0
SENSEG NAME=ATDEP,PARENT=AT

add user database PCBs here
PCB TYPE=DB,... 

.
.
.
PSBGEN LANG=PL/I,COMPAT=YES,PSBNAME=IXDMAIN
END
Generate PSB Control Blocks
In this step, PSB control blocks are generated for the PSBs needed for your installation
configuration and the PSBs in the source dataset members IXDDLET, IXDLOAD, and
IXDUPLD.
1. Submit PSBGENs for these PSBs using JCL already in place at your installation, or use
the sample JCL provided in member XIXDPSB:
a. Enter a job card in member XIXDPSB. This job requires 1024K and no tape
drives.
b. Modify the default symbolic parameters (see Table 9-9).
c. Submit the job.
Table 9-9.
XIXDPSB Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
DEV
SYSDA
Temporary work file device.
SYSLIB
XXXXXXX.MACLIB
Macro Library.
SRCDSN
XXXXXXX.SXVJSAMP
File-AID Sample Library.
RESLIB
XXXXXXX.SDFSRESL
IMS RESLIB.
PSBLIB
XXXXXXX.PSBLIB
IMS PSB Library.
9-24
File-AID Single Install Image Installation and Configuration Guide
Table 9-9.
XIXDPSB Symbolic Parameters (Continued)
Symbolic Parameter Default
Description
MBR
PSB member name.
Blank
Generate ACB Control Blocks
In this step, ACB control blocks are generated for the PSBs needed for your installation
configuration and the PSB in the source dataset member IXDUPLD.
1. Submit ACBGENs for these PSBs using JCL already in place at your installation, or use
the sample JCL provided in member XIXDACB:
a. Enter a job card in member XIXDACB. This job requires 512K and no tape drives.
a. Modify the default symbolic parameters (see Table 9-10).
b. Submit the job.
Table 9-10. XIXDACB Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
RESLIB
XXXXXXX.SDFSRESL
IMS RESLIB.
DBDLIB
XXXXXXX.DBDLIB
IMS DBD Library.
PSBLIB
XXXXXXX.PSBLIB
IMS PSB Library.
ACBLIB
XXXXXXX.ACBLIB
IMS ACB Library.
Assemble and Link MFS Source Code
Use the JCL already in place or submit member XIXDMFS to assemble and link File-AID’s
MFS source code into the IMS format library.
1. Assemble the MFS source code for the members listed in Step 5 using JCL already in
place at your installation; or
2. Enter a job card in member XIXDMFS. This job requires 2048K and no tape drives.
a. Modify the default symbolic parameters (see Table 9-11).
b. Modify the first four characters of the MOD names in the MFS source code
members IXDABND, IXDCHR, IXDDBD, IXDFMT, IXDHEX, IXDINX, IXDKEY,
IXDLOC, and IXDMENU to the MFS MOD NAME PREFIX (MODPRFX). Do not
alter the remaining characters of the MOD name. You may optionally change the
MID and DIF/DOF names to satisfy any naming conventions at your installation.
As mentioned in “MFS Tailoring” on page 9-9, you may need to modify these
MFS source code members. If modification is needed, comment out or delete the
DIF/DOFs for the symbolic terminal types not defined to IMS at your
installation. The START and END delimiters in the DIF/DOF definitions facilitate
the need to comment out or delete undefined symbolic terminals.
3. Modify the JCL and change the default PL/I Link Edit libraries from
PLI.V2R3M0.PLIBASE and PLI.V2R3M0.SIBMBASE to your PL/I or LE370 Link Edit
libraries.
4. Submit the job.
File-AID for IMS/DC Product Configuration
9-25
A return code equal to or less than 4 is acceptable.
Table 9-11. Job XIXDMFS Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
DEV
SYSDA
Temporary work file device.
MBR
Blank
MFS Source code member.
RESLIB
XXXXXXX.RESLIB
IMS RESLIB.
SYSLIB
XXXXXXX.SYSLIB
Optional SYSLIB source dataset. Refer
to the MFS Languages Utility section of
the IMS/ESA Utilities:TM.
REFERAL
XXXXXXX.REFERAL
MFS Referral Library.
FORMAT
XXXXXXX.FORMAT
MFS Format Library.
SRCDSN
XXXXXXX.SXVJSAMP
File-AID Sample Library.
PXREF
XREF
Refer to the MFS Languages Utility
section of the IMS/ESA Utilities:TM.
PCOMP
NOCOMP
PSUBS
NOSUBS
PDIAG
NODIAG
COMPR
NOCOMPRESS
IN
LINECT=55
SN
STOPRC=8
DC
DEVCHAR=A
3) Allocate LTM, CLT and Audit Trail Datasets (Required)
The following JCL members are provided in the File-AID sample library SXVJSAMP:
• XIXDALCO - Allocate Datasets using OSAM
• XIXDALCV - Allocate Datasets using VSAM
Your installation may choose to allocate the control databases as VSAM or OSAM
datasets. Run XIXDALCO if you want the control databases to be OSAM datasets. Run
XIXDALCV if you want the control databases to be VSAM datasets.
1. Enter a job card in member XIXDALCV or XIXDALCO. These jobs require 1024K and
no tape drives.
This job contains two in-stream PROCs. The first allocates the LTM and CLT
databases; the second allocates the AUD database.
If the Audit Trail feature is to be activated, uncomment the NULL (end of job) JCL
statement following the Step 4 SYSIN cards and modify the symbolic parameters in
the second PROC and Step 5, Step 6, and Step 7 SYSIN cards.
If you modified the CLT, LTM, or AUD database DD names in the IXDCLT, IXDLTM,
or IXDAUD DBD (DD1=), be sure to change the DD names in the JCL to match the
modified DD names.
2. Modify the default symbolic parameters in XIXDALCV (see Table 9-12 on page 9-26).
3. Modify the values in the IDCAMS control cards in XIXDALCV (see Table 9-13 on
page 9-26).
9-26
File-AID Single Install Image Installation and Configuration Guide
4. Modify the default symbolic parameters in XIXDALCO (see Table 9-14).
5. Submit job XIXDALCO or XIXDALCV.
Table 9-12. XIXDALCV Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
RESLIB
XXXXXXX.SDFSRESL
IMS RESLIB.
DBDLIB
XXXXXXX.DBDLIB
IMS DBD Library.
PSBLIB
XXXXXXX.PSBLIB
IMS PSB Library.
PROCLIB
XXXXXXX.PROCLIB
IMS Procedure Library.
DFSVSAM
DFSVSAMP
Member in PROCLIB that contains
VSAM buffer pool data.
CLTDB
XXXXXXX.IXDCLT
File-AID CLT database DSN.
LTMDB
XXXXXXX.IXDLTM
File-AID LTM database DSN.
AUDDB
XXXXXXX.IXDAUD
File-AID AUD database DSN.
LOADPSB
IXDLOAD
File-AID initial load PSB.
DELPSB
IXDDLET
File-AID initial delete PSB.
Table 9-13. IDCAMS Keyword Defaults
Keyword
Default
Description
DELETE
XXXXXXX.IXDCLT 
XXXXXXX.IXDLTM 
XXXXXXX.IXDAUD
File-AID CLT database DSN.
File-AID LTM database DSN.
File-AID AUD database DSN.
NAME
XXXXXXX.IXDCLT 
XXXXXXX.IXDLTM 
XXXXXXX.IXDAUD
File-AID CLT database DSN.
File-AID LTM database DSN.
File-AID AUD database DSN.
VOL
XXXXXXX
VOLSER of dataset (Can be different for
LTM, CLT, and AUD databases).
RECSZ
8185, 8185
From tables in “DBD Tailoring” on page
1-4.
CISIZE
8192
From tables in “DBD Tailoring” on page
1-4.
Table 9-14. XIXDALCO Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
DEV2
DISK
Permanent file device.
DSER
XXXXXXX
Permanent file VOLSER.
RESLIB
XXXXXXX.SDFSRESL
IMS RESLIB.
DBDLIB
XXXXXXX.DBDLIB
IMS DBD Library.
PSBLIB
XXXXXXX.PSBLIB
IMS PSB Library.
PROCLIB
XXXXXXX.PROCLIB
IMS Procedure Library.
DFSVSAM
DFSVSAMP
Member in PROCLIB that contains
VSAM buffer pool data.
CLTDB
XXXXXXX.IXDCLT
File-AID CLT database DSN.
LTMDB
XXXXXXX.IXDLTM
File-AID LTM database DSN.
AUDDB
XXXXXXX.IXDAUD
File-AID AUD database DSN.
File-AID for IMS/DC Product Configuration
9-27
Table 9-14. XIXDALCO Symbolic Parameters (Continued)
Symbolic Parameter Default
Description
LOADPSB
IXDLOAD
File-AID initial load PSB.
DELPSB
IXDDLET
File-AID initial delete PSB.
4) Security Exit (Optional)
File-AID for IMS provides one exit type to the security exit. Its primary intent is to limit
database access and to control whether a user’s database updates are captured by the
Audit Trail feature. The default security exit routine provided with File-AID does no
processing and returns control immediately to File-AID.
The following JCL members are provided in the File-AID sample library SXVJSAMP:
• XIXDSCXD - Compile and Dynamically Link a COBOL Exit
• XIXDSCXS - Compile and Statically Link a COBOL Exit
Use the appropriate JCL member to compile or assemble and link-edit a security exit.
You have the following options when installing a security exit:
1. XIXDSCXD - Compile and Dynamically Link a COBOL Exit
2. XIXDSCXS - Compile and Statically Link a COBOL Exit
Refer to “File-AID for IMS/CICS and File-AID for IMS/DC Security Exit” on page E-30 for
more information.
5) Static Link of XVJOPOIX (Optional to support multiple XVJOPOIX modules)
The following JCL member are provided in the File-AID sample library SXVJSAMP:
• XIXDSTAT - Statically link XVJOPOIX
Use the sample JCL to define multiple sets of transactions that are unique and statically
link them into your program library.
Multiple Transaction Configuration
If you want to support transactions that use different configurations of File-AID for
IMS/DC within the same IMS region, further steps are required. You will need to create
separate versions of the XVJOPOIX load module and link them into separate load
libraries. Each version must then be statically linked along with the IXDMAIN1 load
module into a uniquely named load module for each transaction that is to use that
configuration.
After you have created an original XVJOPOIX load module, return to the “File-AID for
IMS/DC Product Configuration Menu” (Figure 9-11).
1. The main program name (default IXDMAIN) is replaced with the value you specified for variable “MAINPGM” on
page 9-15.
9-28
File-AID Single Install Image Installation and Configuration Guide
Figure 9-11. File-AID for IMS/DC Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID for IMS/DC

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . New.loadlib.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Now, specify a different and existing load library for the Configuration Output library
(see “Configuration Output” on page 9-13) for each unique configuration you wish to
create. If needed, modify any parameters (see “Step 4. Specify File-AID for IMS/DC
Product Configuration Parameters” on page 9-14). Then submit the generated JCL to
generate the new load module.
Generate as many versions of the XVJOPOIX load modules as required, linking each into
its own load library.
When you are done, use the XIXDSTAT PROC found in the SXVJSAMP library to perform
the link edit required to create a load module that has a particular version of XVJOPOIX
linked into it.
To execute the XIXDSTAT PROC do the following:
1. Modify the PROC to supply job card information and set the PRINT and DEV PROC
parameters appropriately.
2. Assign XVJOPOIX to the load library containing a particular version of XVJOPOIX.
3. Assign SXVJLOAD to the SMP/E installed load library that contains the XIXDMAIN
load module.
4. Assign the SYSLMOD to the PGMLIB library that will be used to execute IMS.
5. Change the string ZZZZZZZZ to the name of the load module that is to be associated
with the DC transaction. Change the string XXXXXXXX to name one or more aliases
to be associated with the new load module.
Any transaction that is not associated with a load module that does not contain a
statically linked version of XVJOPOIX will use the version found in the IMS PGMLIB load
library if one exists. The statically linked load module(s) must be made available to IMS.
When maintenance is applied to the XIXDMAIN load module in SXVJLOAD, you will
have to run the XIXDSTAT PROC for each transaction load module that contains a
unique version of the XVJOPOIX module. Remember, the statically linked load module(s)
must be made available to IMS.
File-AID for IMS/DC Product Configuration
9-29
Maintenance Considerations
Control Database DBD Changes
A database reorganization must be done whenever the DBDs used by the control
databases change after the initial installation. This need can be caused by space
requirement, randomizer, maximum segment size, dataset organization, device type, or
IMS version changes. The following steps must be taken to reorganize the changed
database:
1. Unload the database that uses the existing DBD. Use JCL available at your
installation or the JCL in member XIXOULOD.
2. Incorporate the changes into the DBD.
3. Regenerate the DBD control block (“Step 5e. Assemble DBD Source Code” on page
3-26)
4. Regenerate the ACB (“Step 5h. Generate ACB Control Blocks” on page 3-33).
5. Delete and reallocate the dataset, if necessary, by using the JCL in member
XIXODDFO (for OSAM databases) or XIXNDDFV (for VSAM databases).
6. Reload the database with the new DBD. Use JCL available at your installation or the
JCL in member XIXORELD.
Control Database Segment Size Changes
If the segment size requirements of a control database need to be changed to support
your database, it is indicated by message D609. Within this message is a value that is the
minimum required control database segment size needed to support the DBD in
question.
When changing the DBD to reflect this new control database segment length, use the
appropriate table provided in “DBD Tailoring” on page 1-4. In that table, the Segm Bytes
column displays the recommended values for the segment length. Choose the next
highest value greater than the size displayed in the message to ensure that your DBD or
segment layout will be supported by File-AID. Use the other values in that row in the
table for the remaining control database DBD values. Remember that the LTM and CLT
control databases must use the same maximum segment length (SEGM BYTES) and root
addressable area size (RMNAME BYTES).
Aside from the above mentioned requirements, the procedure to change the size of the
control data base segments is the same as described in “Control Database DBD Changes”
above.
Security Exit Added or Changed
If your installation is adding a new security exit program or changing an existing one, it
must be linked again into File-AID’s main load module.
1. Enter a job card in member XIXDSCXD and/or XIXDSCXS. This job requires 512K
and no tape drives.
2. Modify the default symbolic parameters (see Table 9-15).
3. Override the SYSIN DD card to point to your security exit program,
4. Submit the job.
9-30
File-AID Single Install Image Installation and Configuration Guide
Note: If you created aliases to the main load module, you must update and run job
XIXDALIA as described in “1) Create Aliases for XIXDMAIN (Required)” on page
9-18.
Table 9-15. XIXDSCXD and/or XIXDSCXS Symbolic Parameters
Symbolic Parameter Default
Description
PRINT
*
Print output SYSOUT class.
PGMLIB
XXXXXXX.PGMLIB
IMS Program Library.
IGYLIB
XXXXXXX.SIGYCOMP
IBM COBOL compiler dataset name.
Installation Parameters Changed
If your installation parameters change (e.g., your call limit changes or your IMS release
number changes), the installation parameter module must be linked again into the main
load module (IXDMAIN1). Follow the instructions in “Step 4. Specify File-AID for IMS/DC
Product Configuration Parameters” on page 9-14 and submit the JCL.
If your site requires multiple transaction configurations, relink them into your program
library (refer to “5) Static Link of XVJOPOIX (Optional to support multiple XVJOPOIX
modules)” on page 9-27).
Note:
If you created aliases to the main load module, you must update and run job
XIXDALIA as described in “1) Create Aliases for XIXDMAIN (Required)” on page
9-18.
Control Segment Missing or Invalid
A segment on the CLT control database stores various counts and fields used to verify the
database’s integrity. If this segment is inadvertently updated or deleted, it must be rebuilt
to ensure accurate processing of your databases. The Rebuild Control Segment program
(XIXREBLD) reads the File-AID database, calculates and accumulates control field
information for each segment, and inserts or replaces the new control segment.
You need to run XIXREBLD when any of the following conditions occur:
• An abend screen is displayed with message number D204:
File-AID IS MISSING ITS CONTROL SEGMENT
• An abend screen is displayed with message number D205:
File-AID’s CONTROL SEGMENT CONTAINS INVALID DBD DATA
• The Batch XREF Update program terminates with a return code of 8. The summary
report prints the message:
ONLINE CONTROL INFORMATION SEGMENT NOT FOUND. IF DBD UPDATE
FACILITY HAS NEVER BEEN RUN, RUN IT FIRST. OTHERWISE, RUN MAINTENANCE
UTILITY TO REBUILD CONTROL INFORMATION SEGMENT
The Rebuild Control Segment program can be run as a batch or BMP program.
Parameters
The parameters on the PROC statement assign default values to symbolic parameters on
the procedure statement. To override a default parameter value on the PROC statement,
code the same parameter on the EXEC statement that calls the procedure.
1. The main program name (default IXDMAIN) is replaced with the value you specified for variable “MAINPGM” on
page 9-15.
File-AID for IMS/DC Product Configuration
9-31
The XIXORBLD and XIXORBLB parameters specify the SYSOUT class, load libraries, and
dataset names used when the program executes. These parameters are described in “DD
Statements”.
Change the default LE Runtime library from CEE.SCEERUN to your LE370 Runtime
library.
The DFSRRC00 parameters are the IMS execution time parameters.
DD Statements
Table 9-16 contains the DD statements that define the primary processing files required
to run the Rebuild Control Segment program.
Table 9-16. Rebuild Control Segment Program DD Statements
DD Statement
Description
STEPLIB
Designates the IMS system dataset that contains the IMS nucleus, required action
modules (&RESLIB), and the library where File-AID for IMS/ISPF load modules are
stored (&CXVJLOAD and &SXVJLOAD).
DFSRESLB
Designates the IMS system dataset that contains the IMS nucleus and required
action modules (&RESLIB).
IMS
XIXORBLD PROC only. Designates the IMS system datasets that contain the
database description blocks (&DBDLIB) and the program specification blocks
(&PSBLIB).
DFSVSAMP
XIXORBLD PROC only. Designates the dataset (&PROCLIB) and member
(&DFVSAM) that contains the control statements that describe the size and
structure of the VSAM shared resource pool for File-AID’s CLT database. The
buffers must be large enough to accept the largest segment size in the CLT
database.
SYSUDUMP
A dump of user areas if the program abends. The dump is formatted so that it can
be printed directly.
IEFRDER
XIXORBLD PROC only. Designates the log dataset when update intent is declared.
IXDCLTDD
XIXORBLD PROC only. Designates the File-AID’s control database (&IXPDB) that
is updated with DBD information.
IXPD1
Designates the DBD load library that contains the DBD load modules that define
the databases used to update the CLT database. Multiple DBD load libraries may
be concatenated.
IXPMLIB
Designates the library that contains File-AID for IMS messages.
SYSOUT
Designates the output class for the Online Control Information Update Summary
Report.
XIXREBLD Return Codes
An XIXREBLD execution return code (RC) appears in the output listing. A message
appears on the Online Control Information Update Summary Report for return code 16
(system error).
The message listed on the Online Control Information Update Summary Report (Figure
9-12) indicates the program’s execution status.
9-32
File-AID Single Install Image Installation and Configuration Guide
Figure 9-12. Online Control Information Update Summary Report
File-AID for IMS
ONLINE CONTROL INFORMATION UPDATE SUMMARY













PAGE 1
DATE 09/28/14
TIME 14:54:01
D729 THE ONLINE CONTROL INFORMATION SEGMENT HAS BEEN SUCCESSFULLY REBUILT
****E N D
O F

R E P O R T****
Back up and Restore Control Databases
A backup and recovery plan should be developed at your installation to allow recovery
from physical damage to the control databases. The CLT control database contains a large
amount of information that is difficult to recreate in the event the database becomes
unusable. The LTM control database, which contains temporary data used only for the
duration of a terminal session, is easier to reestablish. The AUD control database may
contain Audit Trail activity that has not yet been extracted by running the XIXATEXT
program; therefore your installation could lose valuable Audit Trail information.
A job is provided in installation JCL member XIXOICPY to create image copies of the CLT
and AUD databases. You can use it or other JCL available at your installation for periodic
backups. To restore the CLT and AUD databases from the image copies, use the job in
installation JCL member XIXORSTR or other JCL available at your installation.
If your CLT and AUD control databases are VSAM files, they must be deleted and
redefined before beginning the restore process. Use the job in installation JCL member
XIXNDDFV for this purpose.
No backup or restore JCL is provided for the LTM database. To repair a damaged LTM
control database that is a VSAM file, delete and redefine it using the job in installation
JCL member XIXNDDFV. For OSAM files this step may be skipped. Then, initialize the
database using the job in JCL member XIXOLTMI.
See “File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update” on page
F-1 for more information.
What’s Next?
After you have completed the configuration of File-AID for IMS/DC, press END until you
return to the “Product Configuration Menu” (Figure 9-1 on page 9-11).
Either
• select the next File-AID product to configure from the “Product Configuration
Menu” (Figure 9-1 on page 9-11).
Or
• start File-AID for IMS/DC and verify the product installation. Refer to Chapter 11,
“Verifying File-AID Installation” for suggested verification procedures.
10-1
Chapter 10.
File-AID/EX Enterprise Edition Product Configuration
Chap 10
This chapter provides the information and procedures to customize File-AID/EX
Enterprise Edition once the SMP/E installation has completed (see Chapter 2, “RFN SMP/
E Installation of Compuware Mainframe Products” or Appendix A, “SMP/E Installation
Using the EP Media Interface” in the Compuware Installer Mainframe Products SMP/E
Installation Guide) and the File-AID Common Component and Environment modules have
been created and configured.
Overview
File-AID/EX Enterprise Edition is an optional addition to File-AID/EX. It provides the
MVS Access Modules that enable a developer to access mainframe data on z/OS. This
chapter provides configuration instructions for the MVS Access Modules. You must set up
a license before you can execute the MVS Access Modules.
The MVS Access Modules supply several z/OS data sources to the File-AID/EX Execution
Server. The access modules can accept requests from a File-AID/EX Execution Server
running on a client workstation or from a remote File-AID/EX Execution Server
connected over the network. The MVS Access Modules use TCP/IP communications
connections to communicate over the network. The supported z/OS data sources are:
VSAM, QSAM, and IMS. By moving related DB2 data types to a distributed database,
File-AID/RDX extract files are also supported.
MVS Access Modules
Execute the MVS Executive as submitted JCL or as a Started Task.
The MVS Access Modules default installation assumes that the MVS Executive is executed
as submitted JCL (RUNDCLE).
If the MVS Executive is executed as a started task, for IMS and Generation Datasets (GDG)
access, this task must have “START” command authority to clone a task. The default
clone task name is DCLECL. This name can be changed according to site standards and is
documented later within the installation process.
• DCLECL must reside in a system proclib.
• The cloned task, DCLECL, runs as long as an IMS or GDG task is running.
• If the MVS Executive is executed as a started task, a security entry is required for it to
kick off DCLECL.
• An OMVS segment and a logon ID is required for DCLECL. If a security entry is
not made, an error message may occur.
Configuration Prerequisites
Before continuing with the File-AID/EX Executive configuration you must have
configured the File-AID Common Component module XVJOPUNV (see “Step 2. Specify
File-AID Common Component Parameters” on page 2-7).
10-2
File-AID Single Install Image Installation and Configuration Guide
The IMS Environment Module XVJOPIMS (see “Step 3.2. Specify IMS Environment
(Option 2)” on page 2-39) is not required as you can specify IMS environmental variables
during the configuration of the File-AID/EX Executive.
Configuration Procedures
Step 1. Select File-AID/EX Executive
Select option 3 from the “Configuration Facility Menu” (Figure 2-2 on page 2-4) to
display the File-AID “Product Configuration Menu” (see Figure 10-1). It lists all File-AID
mainframe products.
Figure 10-1. Product Configuration Menu
File-AID 10.02.00 ---------- Product Configuration ---------------------------
OPTION ===>


Configuration Module Dataset containing member XVJOPUNV:
hlq.CPWR.MXVJA20.CXVJLOAD
Select Product to Configure:
Module

1
2
3
4
5
6
7
8
File-AID/MVS
File-AID/Data Solutions
File-AID/RDX
File-AID for DB2
File-AID for IMS/ISPF
File-AID for IMS/CICS
File-AID for IMS/DC
File-AID/EX Executive
XVJOPXFA
XVJOPUDA
XVJOPXFR
XVJOPXFD
XVJOPXIX
XVJOPNIX
XVJOPOIX
XVJOPXFE
9
START - Start products to verify installation 















Select Option 8, File-AID/EX Executive.
Step 2. Specify Source of Product Parameters
When selecting Option 8 File-AID/EX Executive from the“Product Configuration Menu”
(Figure 10-1), the “Source of Product Parameters” screen (Figure 10-2 on page 10-3)
displays, prompting you to specify the installation dataset of the previously installed
product release or the name of a load library containing File-AID Configuration modules
in order to populate product specific parameters.
File-AID/EX Enterprise Edition Product Configuration
10-3
Figure 10-2. Source of Product Parameters
File-AID ------------------- Product Configuration ---------------------------
COMMAND ===>

Specify source of product parameter values:
This can be used to import default values that you may review and modify
during configuration processing.

To use defaults shipped with File-AID do not specify any dataset names.
OR
If you have installed a release of File-AID prior to 10.x, and you wish
import values from that previous install, enter the name of the dataset
to complete the install of that release in "Previous install dataset".
OR
If you have a load library already containing valid File-AID 10.x
Configuration modules, enter the name of that dataset in "Configuration
Library".







to 
used




Enter any ONE of the following datasets (fully qualified name without quotes):

Previous install dataset . .
OR
Configuration library . . .

Press ENTER to continue. 




1. Specify either
– the name of a File-AID/EX Executive install dataset prior to Release 10.1
OR
– the name of the File-AID Configuration (load) library that includes a File-AID/EX
Executive XVJOPXFE module you want to use as a source for your parameter
input
OR
– Leave both fields blank if this is your initial installation of File-AID.
You CANNOT specify BOTH “Previous install dataset” and “Configuration library”.
Previous install dataset : Leave blank if you want to preserve the product
installation defaults.
If you leave the Previous Install dataset as blank, it will be ignored. A valid
previous install dataset is NOT required.
If you are upgrading from a release prior to Release 10.1 of File-AID/EX
Executive, then you may retain the previously specified variable values. This is
accomplished by specifying the name of the install dataset
(hlq.FE.V?R?M?.INSTALL.MGR) that was previously used to install File-AID/EX
Executive.
When specifying an unsupported install dataset, this pop-up message displays:
CANNOT IMPORT CONFIGURATION VALUES FROM
THE SPECIFIED DATASET
'TSOID01.FE.V5R0M0.INSTALL.MGR'




DEFAULT CONFIGURATION VALUES WILL BE LOADED 
FROM TSOID01.CPWR.MXVJA20.SXVJLOAD(XVJINXFE) 

PRESS ENTER TO CONTINUE OR END TO RESPECIFY 
Note: File-AID attempts to load the product options variable values from the
specified previous install dataset, but not all variables, in particular none
of the IMS environment variables, can be carried forward to the new
configuration parameters; product installation defaults are used when
10-4
File-AID Single Install Image Installation and Configuration Guide
previous variable values cannot be imported. You must visit Option 2,
SPECIFY PARMS (see “Step 4. Specify File-AID/EX Executive Product
Configuration Parameters” on page 10-5) to verify the variable values.
Configuration library : Specify the name of a File-AID configured load library (e.g.
hlq.CPWR.MXVJA20.CXVJLOAD) for the currently installed release where you
already have configured the File-AID/EX Executive XVJOPXFE module which you
want to use as a source for your parameter input.
If you want to use a preexisting XVJOPXFE parameter module (v10.1 or higher),
you can specify the name of the dataset that contains it. If a valid parameter
module is found, ALL values will be initialized from there. If the utility finds a
CXVJLOAD dataset with a hlq that matches the SXVJSAMP you are executing
from AND a valid parameter module is found, this field will be prefilled.
2. Press Enter to continue with the Product Configuration in the “File-AID/EX
Executive Product Configuration Menu” shown in Figure 10-3 which lists the
File-AID/EX Executive Product Configuration options.
Figure 10-3. File-AID/EX Executive Product Configuration Menu


File-AID ------------------ Product Configuration ----------------------------
OPTION ===>

Product.... File-AID/EX Executive

Version.... 10.02.00


Source of Parameters . . . hlq.CPWR.MXVJA20.SXVJLOAD


Configuration Output . . . hlq.CPWR.MXVJA20.CXVJLOAD

Select Option:


1 DATASETS
- List Configuration Module Datasets


2 SPECIFY PARMS
- Specify product configuration parameters 

3 CUSTOMIZE
- Generate customized objects 
Source of Parameters : Identifies the install dataset or load library you specified in the
previous screen (see “Source of Product Parameters” on page 10-3). If none were
specified, it displays the target load library from which the product installation
defaults were loaded.
Note: File-AID attempts to import parameter values from the specified source.
However, when not all variables can be imported, File-AID loads the default
values. Make sure to review all parameter values before submitting the job to
create a PARMS module.
Configuration Output : Identifies the configured load library to which the File-AID/EX
Executive module XVJOPXFE will be saved.
The available options in the “File-AID/EX Executive Product Configuration Menu” are:
• DATASETS: List Configuration Module Datasets.
• SPECIFY PARMS: Specify product configuration parameters.
• CUSTOMIZE: Generate customized objects.
Select one of the available options.
File-AID/EX Enterprise Edition Product Configuration
10-5
Step 3. Review Target and Configuration Module Libraries
Select Option 1 from the “File-AID/EX Executive Product Configuration Menu” to display
the “Dataset Name Specification” panel (Figure 2-6 on page 2-11). Here you review the
dataset information for the File-AID SMP/E Target Libraries that were created during the
SMP/E installation (see Chapter 2, “RFN SMP/E Installation of Compuware Mainframe
Products” or Appendix A, “SMP/E Installation Using the EP Media Interface” in the
Compuware Installer Mainframe Products SMP/E Installation Guide) and the File-AID
Configuration Module Libraries. The displayed list is the same as displayed in Figure 2-6
on page 2-11. Refer to “Step 2.1 Specify Configuration Module Dataset Names” on page
2-10 for more information.
Step 4. Specify File-AID/EX Executive Product Configuration Parameters
Select Option 2 from the “File-AID/EX Executive Product Configuration Menu” to display
the “File-AID/EX Executive Product Configuration Parameters” panel (Figure 10-4 on
page 10-6). Option 2 allows you to specify values for variables that the Configuration
Facility uses to configure File-AID/EX Executive. The values that you provide are saved in
the parameter variables list. A listing of all the variables is provided in Table 10-1 on page
10-6.
These parameter variables allow you to customize and execute the MVS Access Modules.
These variables are optional, and File-AID/EX Enterprise Edition can be installed without
changing these values. For example, if you are not installing direct IMS access, you would
not install the last three IMS Product variables.
The groups within the Product Parameters are:
• MVS Access Module Options: Modify MVS Access Modules Primary Option Menu.
• IMS Access Options: Create EPARM load members.
• BMP parameters: Access an IMS BMP Region.
• DLI parameters: Access an IMS DLI Region.
After entering and reviewing the desired values, Press END (PF3) to save your changes
and continue to the Edit JCL screen where you can submit the job to assemble the
File-AID/EX Executive parameter module XVJOPXFE, or CANCEL to exit the screen
without saving your changes.
Default values are provided for most of the variables. A complete listing of the variables
is provided in Table 10-1 on page 10-6.
After entering the desired values, enter END (PF3) to save your changes and exit the
screen, or CANCEL to exit the screen without saving your changes.
10-6
File-AID Single Install Image Installation and Configuration Guide
Figure 10-4. File-AID/EX Executive Product Configuration Parameters
File-AID ----------------- Configuration Parameters --------------------------
COMMAND ===>


Product.... File-AID/EX Executive
Version.... 10.02.00



Variable Value
Description

-------- --------------------------------------------------------------------- 
More:
+ 
MVS Access Module Options

Port number.

PORTNUM 2600
Default=2600

Member name for Clone process.

CLNAME
DCLECL
Default=DCLECL

IMS Access Options.

Member name for EPARM Load module.

LOADMBR

IMS module name if different than DFSRRC00.

IMSPGMNM

Unit for permanent dataset allocation.

PERMUNIT SYSDA
Default=SYSDA

All database datasets obtain from MDA for DLI processing.
ALLDBMDA Y
(Y=Yes,N=No) Default=Y

Verify that the PSB and DBD are present in the ACBLIB. 
ACBVERIF N
Change any of the variable values as required for your site.
Note:
If you update a parameter variable after you have completed “Step 7. Generate
Customized Objects” on page 10-10, you must reexecute “Step 7. Generate
Customized Objects” option.
Table 10-1 lists the product parameter variables and their descriptions.
Table 10-1. File-AID/EX Executive product parameter variables
Label
Default Value Your Value
Description
MVS Access Module Options
PORTNUM
2600
Port number.
Default=2600
Specify the port number for the MVS Executive.
CLNAME
DCLECL
Member name for Clone process
Default=DCLECL
Specify the member name for Clone process.
The MVS ACCESS modules run in a persistent state.
With DIRECT IMS access, the task is cloned so that
multiple users can take advantage of multiple address
spaces. A member will be created in the system
PROCLIB (or JCLLIB) that you have specified for this
cloned task.
IMS Access Options
LOADMBR
Specify the member name for EPARM Load module.
IMSPGMNM
Specify the IMS module name if different than
DFSRRC00 (optional).
Normally this should be set to spaces. If your
installation has replaced the IMS module DFSRRC00
with your own version, placing your version here will
cause File-AID/EX to execute that module.
File-AID/EX Enterprise Edition Product Configuration
10-7
Table 10-1. File-AID/EX Executive product parameter variables (Continued)
Label
Default Value Your Value
Description
PERMUNIT
SYSDA
Unit for permanent dataset allocation.
Default=SYSDA
Specify the unit to be used for permanent dataset
allocation.
This will be used to allocate the IMS log if running in
a DLI region and the PSB has any update processing
options and the IRLM is being used. IMS requires a
log dataset in this situation. Specify A device
equivalent to the 'UNIT=' PARM in a JCL DD
statement.
ALLDMBDA
Y
All database datasets obtain from MDA in DLI
processing.
(Y=Yes,N=No) Default=Y.
If set to Y, all dataset names are obtained from the
IMS MDA members.
If set to N there must be a dataset naming member in
the EPRMS Library for each referenced database. This
can be accomplished with the provided sample JCL
XFEDLIMD (see also the reminder in Figure 10-6 on
page 10-10).
ACBVERIF
N
Verify that the PSB and DBD are present in the
ACBLIB.
(Y=Yes,N=No) Default=N
If set to N, the ACBLIB's specified in “Datasets” on
page 10-9, will not be used.
DIAGLVL
4
Diagnostic logging level.
(0,1,2,3,4) Default=4
Determines what is written to the executive log.
Valid values:
0 - Nothing is written 
1 - Error messages are written 
2 - Same as 1 plus input to the access modules 
3 - Same as 2 plus the first 64 bytes of output 
4 - Same as 2 plus all output
TESTMODE
N
Run IMS Executive in testmode.
(Y=Yes,N=No) Default=N
Specify whether to run in test mode:
Y - system doesn't issue ESTAE macros.
N - macros are issued.
When set to Y, the system does not issue MVS ESTAE
macros to intercept abends. Normally this should be
set to N.
BMP parameters
The following BMP parameters identify BMP PARMS to pass to DFSRRC00 (FAEX generates
REGIONTYPE, PGMNAME & PSBNAME and concatenates them in front of your PARMS). Refer to
the IMS/VS System Programming Reference Manual for more information on these parameters.
PRLD
Suffix for the module preload member.
Specify the suffix for the module preload member
(optional).
STIMER
The processor time statistics to be gathered.
(Y,N)
Processor time statistics. Specify the use of STIMER for
IMS STATS member (optional).
10-8
File-AID Single Install Image Installation and Configuration Guide
Table 10-1. File-AID/EX Executive product parameter variables (Continued)
Label
Default Value Your Value
Description
PARDLI
Parallel DLI option.
(0,1)
Specify the use of PARALLEL DLI options (optional)(0
or 1).
Valid values are 0 or 1.
1 - prevents control region 113 abends should the
BMP be canceled, the MVS EXECUTIVE be canceled or
if abends occur while the BMP is active.
CPUTIME
BMP task timing option.
Specify BMP task timing option (0 or 1 through
9999).
NBA
5
Number of normal DEDB buffers to allocate.
Default=5
Specify the number of normal DEDB buffers to
allocate.
OBA
5
Number of overflow DEDB buffers to allocate.
Default=5
Specify the number of overflow DEDB buffers to
allocate.
IMSID
IMSID of the IMS control region.
Specify the IMS SYSTEM ID of the IMS control region
(optional).
DLI parameters
The following DLI parameters identify DLI PARMS to pass to DFSRRC00 (FAEX generates
REGIONTYPE, PGMNAME & PSBNAME and concatenates them in front of your PARMS). Refer to
the IMS/VS System Programming Reference Manual for more information on these parameters.
PRLD
Suffix for the module preload member.
Specify the suffix for the module preload member
(optional).
SRCH
Module search indicator for directed load.
(0,1)
Specify the search indicator for the DIRECTED LOAD
(optional).
MON
Activate the IMS monitor.
(Y,N)
Activate the IMS monitor.
FMTO
IMS dump output format.
Specify the IMS dump output format (optional).
IMSID
IMSID to be used for messages.
Specify the IMS System ID to be used for messages
(optional).
SWAP
Address space swappable. 
(Y,N)
Specify whether Address space is swappable
(optional) (Y or N).
DBRC
N
DBRC usage. 
(Y,N) Default=N
Specify DBRC usage (optional) (Y or N).
IRLM
N
IRLM usage 
(Y,N) Default=N
Specify IRLM usage (optional) (Y or N).
IRLMNM
IRLM name.
Specify the 4 character IRLM name (optional).
File-AID/EX Enterprise Edition Product Configuration
10-9
Table 10-1. File-AID/EX Executive product parameter variables (Continued)
Label
Default Value Your Value
Description
BKO
Y
Perform dynamic backout on pseudo abends.
(Y,N) Default=Y
Specify whether to perform DYNAMIC BACKOUT on
pseudo abend (optional) (Y or N).
Datasets
PSBLIB
dataset1
Specify the primary IMS PSBLIB
PSBLIB
dataset 2
Specify the secondary IMS PSBLIB
DBDLIB
dataset 1
Specify the primary IMS DBDLIB
DBDLIB
dataset 2
Specify the secondary IMS DBDLIB
RESLIB
dataset 1
Specify the primary IMS DFSRESLB
RESLIB
dataset 2
Specify the secondary IMS DFSRESLB
RESLIB
dataset 3
Specify the third IMS DFSRESLB
ACBLIB
dataset 1
The IMS ACB library names that contain the pre-built
application control blocks (ACBs).
Specify the primary IMS ACBLIB.
ACBLIB
dataset 2
Specify the secondary IMS ACBLIB
ACBLIB
dataset 3
Specify a third IMS ACBLIB
ACBLIB
dataset 4
Specify a fourth IMS ACBLIB
RECON1
dataset
Specify the primary IMS RECON library.
RECON2
dataset
Specify the secondary IMS RECON library
RECON3
dataset
Specify a third IMS RECON library
DFSVSAMP
dataset
Specify the DFSVSAMP dataset name
DFSVSMEM
member
Specify the DFSVSAMP member name
Step 5. Review and Submit JCL
After entering the desired parameter values in the “File-AID/EX Executive Product
Configuration Parameters” panel (Figure 10-4 on page 10-6), and pressing END (PF3), the
“Edit JCL Screen for File-AID/EX Executive Parameter Module XVJOPXFE” panel (Figure
10-5 on page 10-10) displays.
Review and submit the job to create or modify File-AID/EX Executive Parameter Module
XVJOPXFE or CANCEL to exit the screen without saving your changes.
When you don’t submit the JCL, and you use END or CANCEL to exit this screen and
return to the “Product Configuration Menu”, the changes you made in the “File-AID/EX
Executive Product Configuration Parameters” panel (Figure 10-4 on page 10-6) will NOT
be saved.
10-10
File-AID Single Install Image Installation and Configuration Guide
Figure 10-5. Edit JCL Screen for File-AID/EX Executive Parameter Module XVJOPXFE
EDIT
TSOID01.CPWR.MXVJA20.WORK($XFE01) - 01.00
Columns 00001 00072 
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 /*JOBPARM S=CW01

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*

000007 //*-------------------------------------------------------------------* 
000008 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.

000009 //*-------------------------------------------------------------------- 
000010 //* ASSEMBLE INSTALLATION PARAMETERS (XVJOPXFE)

000011 //*-------------------------------------------------------------------- 
000012 //*-------------------------------------------------------------------* 
000013 //STEP100 EXEC PGM=IEFBR14

000014 //OBJ
DD DSN=&OBJTEMP,DISP=(,PASS),UNIT=SYSDA,

000015 //
SPACE=(TRK,(10,10,5))

000016 //STEP200 EXEC PGM=ASMA90,

000017 //
PARM='TERM,NODECK,OBJECT,RENT,NOBATCH' 
000018 //SYSLIB
DD DSN=SYS1.MACLIB,DISP=SHR 
000019 //SYSPRINT DD SYSOUT=* 
Note: If you update a product option variable after you have completed the
configuration process, always submit the JCL to save updates to the parameter
module in the File-AID load library.
Step 6. Review Job Output
When you receive the job completion message, review the job output and verify that
File-AID/EX Executive Parameter Module XVJOPXFE has been created or updated.
Step 7. Generate Customized Objects
Select Option 3 from the “File-AID/EX Executive Product Configuration Menu” to display
the “File-AID/EX Executive Customization Tasks Menu” panel (Figure 10-6). This menu
allows you to select a Customization task and submit the generated JCL.
Figure 10-6. File-AID/EX Executive Customization Tasks Menu

File-AID ------------------- Customization Tasks ----------------------------
OPTION ===>

Product.... File-AID/EX Executive

Version.... 10.02.00

1


If not using MDA modules for IMS DLI database dataset allocation
generate modules for use by File-AID/EX using the sample JCL XFEDLIMD.

CREATE DCLE JCL
Enter the option number for the desired Customization task.
This panel also includes a reminder that you can use the provided sample JCL XFEDLIMD
to create allocation modules for use by File-AID/EX, if the parameter variable
“ALLDMBDA” (see “ALLDMBDA” on page 10-7) is set to N.
File-AID/EX Enterprise Edition Product Configuration
10-11
Option 1, Create DCLE JCL
The JCL generated from this task creates new members in the JCL library that was
specified in “Specify a Work Dataset to Write Configuration JCL” on page 2-4. Review the
JCL (Figure 10-7) and submit the job.
Note: One of the new members is RUNDCLE which creates the JCL to run the MVS
Access Modules in a persistent state; it does not execute it.
Figure 10-7. Edit JCL Screen for Create DCLE JCL
EDIT
TSOID01.CPWR.MXVJA20.WORK($XFECUS1) - 01.00
Columns 00001 00072
Command ===>
Scroll ===> PAGE 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //TSOID01$ JOB ('OFABAS9.0.0DEV'),'COMMON INSTALL',

000002 //
CLASS=L,MSGCLASS=X,NOTIFY=&SYSUID

000003 //*

000004 //*
OPTIONAL JES PARAMETER CARD GOES HERE

000005 //*

000006 //*

000007 //*--------------------------------------------------------------------
000008 //* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.

000009 //*--------------------------------------------------------------------
000010 //*----------------------------------
000011 //*
CREATE SKELETON JCL

000012 //*----------------------------------
000013 //*

000014 //UPDTE1 EXEC PGM=IEBUPDTE,PARM=NEW

000015 //SYSUT2
DD DSN=TSOID01.CPWR.MXVJA20.WORK,

000016 //
DISP=SHR

000017 //*

000018 //SYSPRINT DD SYSOUT=*

000019 //SYSUDUMP DD SYSOUT=* 
Taking Advantage of VSAM Share Options
The MVS Executive attempts to protect the integrity of QSAM and VSAM datasets by
checking the system ENQ status before allocating and opening a dataset.
Normally, when access to a VSAM dataset is requested, the dataset will be allocated with
DISP=SHR when opening a dataset for input. This is indicated in the system with a
shared ENQ. And typically a dataset will be allocated with DISP=OLD when allocating for
output or update which would be indicated in the system with an Exclusive ENQ.
If a dataset has an Exclusive ENQ due to another user's DISP=OLD allocation, the
Executive will not allocate the dataset and will return the message:
Error on Open <input/output> - dataset<dataset name> is in use.
Also, if the dataset has a Shared ENQ, the Executive will perform an allocation for input;
however, the allocation for output or update will be rejected and the above error message
will be returned.
The above ENQ processing can be bypassed for VSAM datasets by including the DD
statement
//NVSAMENQ DD DUMMY
10-12
File-AID Single Install Image Installation and Configuration Guide
into your DCLE JCL stream. This will force all VSAM dataset allocations performed by the
Executive to be done with DISP=SHR. The file open will be honored depending on the
VSAM share options used when the VSAM dataset was defined:
SHAREOPTIONS Value
Type of Sharing
(1,3)
No Sharing, single updater, or multiple readers
(2,3)
Single updater and multiple readers
(3,3)
Multiple updaters and multiple readers
There are two caveats that should be noted:
1. If another process has an Exclusive ENQ on the VSAM dataset, regardless of the share
options, the following error message will be returned when the Executive attempts to
allocate a VSAM dataset:
Dynalloc for <vsam_datasetname> failed with error code=210, info code=0
2. The Language Environment (LE) limits a single instance of the Executive to a single
open for output/update for a VSAM dataset. If a second allocate for output/input is
attempted, the LE returns the following error message:
EDC50591 An attempt to reposition a VSAM file failed.
Even though the above message is an informational message, the open of the VSAM
dataset fails.
Operator Commands and Messages
This section describes the commands and messages that are entered while the MVS Access
Modules are running.
MVS Access Modules Operator Commands
The operator commands enable subtasks of the MVS Access Modules to be completed in
an organized manner. The operator commands are entered by the database administrator
at an operator console.
P DCLE and F DCLE,STOP
These commands shut down the MVS Access Modules. If client tasks are active, the MVS
Access Modules wait up to 30 seconds for all client tasks to terminate. During this 30second period new connections are not accepted.
F DCLE,QUIESCE
This command shuts down the MVS Access Modules after all client tasks have ended.
While waiting for the client tasks to end new connections are not accepted.
F DCLE,KILL, client task ID
This command terminates a specific client task. The client task ID identifies the client task
to be terminated and can be the TCB of the client task, the user ID of the logged on user,
or the node ID of the client workstation.
F DCLE,LIST
This command lists all of the active client tasks to the operator console.
File-AID/EX Enterprise Edition Product Configuration
10-13
MVS Access Modules Operator Messages
The operator messages provide the database administrator with a status or an error
regarding the MVS Access Modules. Following are the messages, explanations, system
actions, and responses.
XVJX000I DCLE
Corporation
Remote Access Manager Version v.r.m Copyright (c) 2000, Compuware
Explanation: Displayed when MVS Access Modules are started. v.r.m is current version,
release, and modification level.
System Action:
MVS Access Modules initialize.
User Response:
None.
XVJX001I
Ready for communications
Explanation: MVS Access Modules have successfully completed and are ready to accept client
connections.
System Action:
MVS Access Modules wait for incoming client connections.
User Response:
None.
XVJX003S
MVS environment initialization failed, Reason=rrrrrrr
Explanation:
An error occurred during initialization. rrrrrrr reason for the failure.
System Action:
MVS Access Modules terminate.
User Response: Validate MVS Access Modules configuration. Restart MVS Access Modules; if
error reoccurs, contact File-AID/EX customer support.
XVJX004S Unable to ATTACH the message writer
Explanation: An error occurred while attaching the message writer subtask. This is probably
caused by a system error.
System Action:
MVS Access Modules terminate.
User Response: Correct system error and restart MVS Access Modules. If error reoccurs,
contact File-AID/EX customer support. Have system log output and dumps available.
XVJX005S Unable to create the message queue
Explanation:
An internal error has occurred.
System Action:
MVS Access Modules terminate.
User Response:
support.
Restart MVS Access Modules. If error reoccurs, contact File-AID/EX customer
XVJX006I DCLE Remote Access Manager ended
Explanation:
MVS Access Modules terminated.
System Action:
MVS Access Modules are removed from the system.
User Response:
None.
XVJX007S DCLE invalid PARM count
Explanation:
There was an invalid number of parms on the EXEC JCL statement.
System Action:
MVS Access Modules terminate.
User Response:
Refer to “MVS Access Modules” on page 10-1 for correct startup parameters.
XVJX008S Unable to Open communications to MVS Access Modules operator console
Explanation:
console.
An internal error occurred while opening communications to the operator
System Action:
MVS Access Modules terminate.
10-14
File-AID Single Install Image Installation and Configuration Guide
User Response: Restart MVS Access Modules. If problem reoccurs, contact File-AID/EX
customer support. Have SYSLOG information available.
XVJX009S Unable to open TCP/IP Connection: tcp/ip message
Explanation: An error occurred when opening the TCP connection. tcp/ip message is a
message issued by IBM TCP/IP.
System Action:
MVS Access Modules terminate.
User Response:
Refer to IBM manual for problem determination.
XVJX010E Invalid Command
Explanation:
An invalid MVS Access Modules operator command was entered.
System Action:
The command is ignored.
User Response:
Correct and reenter the command.
XVJX011S TCP Select error: tcp/ip message
Explanation: An error occurred during a TCP/IP select function call. tcp/ip message is a
message issued by IBM TCP/IP.
System Action:
MVS Access Modules terminate.
User Response:
Refer to IBM manual for problem determination.
XVJX012I DCLE Remote Access Manager is terminating
Explanation:
Acknowledgment to either a STOP or QUIESCE entered by operator.
System Action:
Termination processing begins.
User Response:
None.
XVJX013I DCLE termination complete
Explanation:
completed.
The termination, in response to a STOP or QUIESCE of all client tasks has
System Action:
None.
User Response:
None.
XVJX014I Terminating with n active clients
Explanation: 30 seconds following a STOP command, n client tasks had not terminated.
MVS Access Modules terminate with an A03 abend.
System Action:
Termination processing continues.
User Response:
None.
XVJX015I Quiesce in progress
Explanation:
A QUIESCE is in progress and a subsequent QUIESCE command was entered.
System Action:
The subsequent QUIESCE command is ignored.
User Response:
None.
XVJX016I There are currently no active client tasks
Explanation:
The operator entered a LIST command and there were no active client tasks.
System Action:
None.
User Response:
None.
XVJX017I TCB User ID Node ID tttttttt uuuuuuuu nnnnnnnnnnnn
Explanation: This message appears in response to a LIST command. tttttttt is TCB of client
task, uuuuuuuu is user ID of user logged on to client task, and nnnnnnnnnnnn is node ID of
client's work station. If a user has not logged on to client task, user ID will contain asterisks.
System Action:
None.
File-AID/EX Enterprise Edition Product Configuration
User Response:
10-15
None.
XVJX018E Client task does not exist
Explanation: A KILL client task command was entered and the client task ID did not match
that of any active client task.
System Action:
None.
User Response: Enter LIST command to get list of active client tasks. Reenter KILL command
with correct client task ID.
What’s Next?
After you have completed the configuration of File-AID/EX Enterprise Edition, press END
until you return to the “Product Configuration Menu” (Figure 10-1 on page 10-2).
Either
• select another File-AID product to configure from the “Product Configuration Menu”
(Figure 10-1 on page 10-2).
Or
• start File-AID/EX and verify the product installation. Refer to the File-AID/EX Getting
Started Guide for suggested verification procedures.
10-16
File-AID Single Install Image Installation and Configuration Guide
11-1
Chapter 11.
Verifying File-AID Installation
This chapter presents suggested verification procedures for the following File-AID
products:
• “File-AID/MVS”
• “File-AID/Data Solutions”
• “File-AID for DB2”
• “File-AID/RDX”
• “File-AID for IMS/ISPF”
• “File-AID for IMS/CICS”
• “File-AID for IMS/DC”
File-AID/MVS
Perform the following steps to verify the correct installation of File-AID/MVS:
• “Step 1 — Make Available and Access File-AID/MVS” on page 11-2
• “Step 2 — Verify Primary Options” on page 11-2
• “Step 3 — Verify XFACOPY CLIST” on page 11-2
• “Step 4 — Verify Option 2 -- Edit Data File” on page 11-2
• “Step 5 — Verify Option 3.3 -- Copy Utility” on page 11-3
• “Step 6 — Verify Keyed File Support” on page 11-4
• “Step 7 — Verify CA Panvalet And CA Librarian Support” on page 11-4
• “Step 8 — Verify Batch Job Submission from Online Print” on page 11-5.
If your installation uses CA Panvalet or CA Librarian, you need to know the name of a
COBOL or PL/I record layout that is stored on the library management system.
The sample screens in this chapter use COBOL record layouts rather than PL/I record
layouts.
Notes:
1. The SMP/E Installation, Configuration of PARM modules XVJOPUNV (“Step 2.
Specify File-AID Common Component Parameters” on page 2-7) and XVJOPXFA
(“Step 4. Specify File-AID/MVS Product Configuration Parameters” on page 3-4)
should be completed before you perform the verification steps. If “FALIBDEF” on
page 2-15 is set to No, refer to Chapter 12, “Site Deployment” on how to make
File-AID/MVS available.
2. To create the files referenced in this chapter, see Appendix I, “Installing Training
Files”.
Chap 11
11-2
File-AID Single Install Image Installation and Configuration Guide
Step 1 — Make Available and Access File-AID/MVS
This step is necessary only if you did not use the PDF LIBDEF services. Select the
appropriate method to make File-AID/MVS available for use.
• Ensure the LLA (Load Library Lookaside) has been refreshed.
• Log off from the current ISPF session and log on using the newly modified logon
PROC.
• Execute the Allocation CLIST from native TSO.
• Log off and log on.
• For ROSCOE/ETSO installations, execute the modified ISPF RPF.
Step 2 — Verify Primary Options
1. Select File-AID/MVS from your ISPF Primary Option Menu (or other menu containing
the File-AID/MVS access code).
2. To verify that you can invoke each of the primary options from the File-AID Primary
Option Menu, enter the option number or letter and press Enter.
3. Once you have confirmed that an option can be invoked, verify the next option.
Enter the END command (PF3) to return to the Primary Option Menu, then select the
next option.
Step 3 — Verify XFACOPY CLIST
The XFACOPY CLIST must be available to you in order to continue the verification
process (see Appendix I, “Installing Training Files”). Type TSO XFACOPY on the
COMMAND line to execute the XFACOPY CLIST. File-AID displays progress messages as
the sample files are created. Answer the question OK TO DELETE? with Y (Yes).
Step 4 — Verify Option 2 -- Edit Data File
Invoke option 2 -- Edit Data File. The Edit - Dataset Specification screen, shown in Figure
11-1, is displayed. Fill in the screen information as shown and press Enter.
Figure 11-1. Edit - Dataset Specification Screen


File-AID --------------COMMAND ===>
Edit Mode
Edit - Dataset Specification
===>
F
-----------------------
(F=Fmt; C=Char; V=Vfmt; U=Unfmt)

Specify Edit Information:
Dataset name or zFS path ===> FASAMP.INVFILE
Member name
===>
(Blank or pattern for member list)
Volume serial
===>
(If dataset is not cataloged)
Disposition
===> OLD
(OLD or SHR)
Create audit trail
===> Y
(Y = Yes; N = No)

Specify Record Layout and XREF Information:
Record layout usage
===> S
(S = Single; X = XREF; N = None)
Record layout dataset
===> FASAMP.LAYOUTS
Member name
===> INVFILE
(Blank or pattern for member list)
XREF dataset name
===> FASAMP.XREF
Member name
===>
(Blank or pattern for member list)

Specify Selection Criteria Information:
(E = Existing; T = Temporary;
Selection criteria usage ===> N
M = Modify; Q = Quick; N = None)
Selection dataset name
===> FASAMP.SELCRIT
Member name
===>
(Blank or pattern member list)
Verifying File-AID Installation
11-3
File-AID displays the Edit Formatted screen shown in Figure 11-2 on page 11-3. File-AID
uses the COBOL record layout FASAMP.LAYOUTS (INVFILE) to present a formatted
display of each record in the data file FASAMP.INVFILE with REDEFINES turned on.
Figure 11-2. Edit Formatted Mode Screen

File-AID - Edit - USERID0.FASAMP.INVFILE ------------------ COLUMNS 00001 00103
COMMAND ===>
SCROLL ===> PAGE
RECORD:
1
INVENTORY-RECORD
LENGTH:
513
---- FIELD LEVEL/NAME ------- -FORMAT- ----+----1----+----2----+----3----+----4
5 INV-PART-NO
15/AN
COAX-12222
5 INV-DESCRIPTION
40/AN
COAXIAL CABLE
5 INV-UNIT-OF-MEASURE
2/AN
FT
5 INV-UNIT-PRICE
4/PS
2.50
5 INV-STOCK-INFO(1) OCCURS 2 TIMES SYNC
18/GRP
10 INV-WAREHOUSE(1)
3/AN
NYC
10 INV-STATUS(1)
6/AN
B/O
10 INV-QTY-DATE(1) SYNC
9/GRP
15 INV-QTY-ON-HAND(1)
3/PS
3000
15 INV-LAST-ORDER-DATE(1)
6/AN
121593
10 INV-BO-QTY-DATE REDEFINES INV-QTY-DATE 
10 INV-BO-QTY-DATE(1)
9/GRP

15 INV-QTY-BACKORDERED(1)
3/PS
3000 
15 INV-BACKORDER-DATE(1)
6/AN
121593
5 INV-STOCK-INFO(2)
18/GRP
10 INV-WAREHOUSE(2)
3/AN
CAL
10 INV-STATUS(2)
6/AN
AVAIL
10 INV-QTY-DATE(2)
9/GRP
15 INV-QTY-ON-HAND(2)
3/PS
10000
Step 5 — Verify Option 3.3 -- Copy Utility
Invoke option 3.3 -- Copy Utility. The Copy Utility screen, shown in Figure 11-3, is
displayed. Fill in the “FROM” and “TO” dataset information as shown.
Figure 11-3. Copy Utility Screen

File-AID --------------------- Copy Utility ------------------------------
COMMAND ===>

Specify "FROM" Dataset or zFS Path Information:
Dataset or path ===> FASAMP.INVFILE
Volume serial
===>
(If not cataloged)

Specify "TO" Dataset or zFS Path Information:
Dataset or path ===> FASAMP.INVFILE2
Volume serial
===>
(If not cataloged)
Disposition
===> OLD
(OLD; MOD; NEW)
Specify Execution Information:
Process online or batch
===> O
(O = Online; B = Batch)

Specify Selection Criteria Information:
(E = Existing; T = Temporary;
Selection criteria usage
===> N
M = Modify; Q = Quick; N = None)
Selection criteria dataset ===> FASAMP.SELCRIT
Member
===> INVFILEC (Blank or pattern for member list)
Press Enter. File-AID redisplays the Copy Utility screen with the message: 
n RECORDS COPIED in the upper-right corner of the screen.
This example extracts records from the input file FASAMP.INVFILE and writes them to
FASAMP.INVFILE2.
11-4
File-AID Single Install Image Installation and Configuration Guide
Step 6 — Verify Keyed File Support
Invoke option 1 -- Browse Data File. The Browse - Dataset Specification screen, shown in
Figure 11-4, is displayed. Specify the edit mode and dataset information as shown. Use
the EMPLOYEE file created by the XFACOPY training CLIST.
Figure 11-4. Browse - Dataset Specification Screen

File-AID -------------- Browse - Dataset Specification ----------------------
COMMAND ===> 

Browse Mode
===> C
(F=Fmt; C=Char; V=Vfmt; U=Unfmt)

Specify Browse Information:
Dataset name or zFS path ===> FASAMP.EMPLOYEE
Member
===>
(Blank or pattern for member list)
Volume serial
===>
(If dataset is not cataloged)
Specify Record Layout and XREF Information:
Record layout usage
===> N
(S = Single; X = XREF; N = None)
Record layout dataset
===> FASAMP.LAYOUTS
Member
===> INVFILE
(Blank or pattern for member list)
XREF dataset
===> FASAMP.XREF
Member
===>
(Blank or pattern for member list)

Specify Selection Criteria Information:
(E = Existing; T = Temporary;
Selection criteria usage ===> N
M = Modify; Q = Quick; N = None)
Selection criteria DSN
===> FASAMP.SELCRIT
Member
===> INVFILEC
(Blank or pattern for member list)
Press Enter. File-AID creates a full-screen display of your keyed file that is similar to the
ISPF Browse screen, as shown in Figure 11-5. Press the DOWN PF key (PF8) to scroll
through the file.
Figure 11-5. Browse Keyed Data in Character Mode Screen
File-AID - Browse - USERID0.FASAMP.EMPLOYEE --------------- LINE 0000 COL 1 79
COMMAND ===>
SCROLL ===> CSR
----+ ----1----+----2----+----3----+----4----+----5----+----6----+----7----+----
********************************* TOP OF DATA **********************-CAPS OFF-*
00090 MARTIN
EDWARD
M AIRPLANE MANUFACTURER
427890125 101954
00100 MULSTROM
ROBERTA
A HOLLYWOOD SEAMSTRESS
346573656 090859
00200 JACKSON
JOSEPH
C ORATOR
275587177 020462
10000 ANDREWS
GEORGE
ACTOR
576312032 042248
15000 MURPHY
RONALD
L PAINTER
987654321 120255
18034 SCHNEIDER
ELLEN
C NURSE
341559549 032960
21035 JONES
GEORGE
B COUNTRY SINGER
463813456 090944
25100 ROBERTS
WILLIAM
R POLITICIAN
879563325 050865
27007 ALLEN
JOYCE
M AUTHOR
783458334 012132
30001 RICHARDS
REX
W RODEO CLOWN
632764534 040140
31000 SAVAGE
JONATHON C ELECTRICIAN
348567992 062250
34010 SMITH
JANET
AIRLINE ATTENDANT
557782984 112359
34011 JACOBS
DIANA
DOCTOR
225368395 021757
36010 SIMPSON
ALEX
CARTOONIST
123456789 070864
39310 BARNETT
EDWARD
E SALESMAN
543789142 080954
39500 WILLIAMS
EDITH
A DESIGNER
987654321 091860
41000 RICHARDSON
MARJORIE M PROGRAMMER ANALYST
346583656 021355
41400 MOORE
THOMAS
M SYSTEMS ADMINISTRATOR
226373646 111139
42017 BENNETT
WILLIAM
D SALES SUPPORT
146573556 123048
44018 WILHELM
HEINRICH L DIPLOMAT
466573356 091360
Step 7 — Verify CA Panvalet And CA Librarian Support
If your installation uses CA Panvalet or CA Librarian, perform this step. Otherwise,
proceed directly to “Step 8 — Verify Batch Job Submission from Online Print”.
Verifying File-AID Installation
11-5
To perform this step, you need to know the name of a COBOL or PL/I record layout
member and the name of the CA Panvalet or CA Librarian dataset in which it is stored.
Select option 8 -- View Record Layout. File-AID displays the View Record Layout - Dataset
Specification screen as shown in Figure 11-6. Enter the dataset and member names.
Figure 11-6. View Record Layout - Dataset Specification Screen



File-AID --- View Record Layout - Dataset Specification -----------------------
COMMAND ===>

Specify Record Layout Dataset to View:
Dataset name
Member name
Expand Occurrences

===> 'your.ca-panvalet.file'
===> member
(blank or pattern for member list)
===> Y
(Y = Yes; N = No) 
Press Enter. File-AID displays the fields in the layout along with their offsets, lengths, and
end positions. Use the DOWN PF key (PF8) and the UP PF key (PF7) to scroll through the
layout.
Step 8 — Verify Batch Job Submission from Online Print
Invoke option 5 -- Print, then select suboption 1 -- Print Data File. File-AID displays the
Print Data File screen shown in Figure 11-7. This screen is similar to the Edit - Dataset
Specification screen used in “Step 4 — Verify Option 2 -- Edit Data File”. Enter the
options and dataset information as shown.
Figure 11-7. Print Data File Screen

File-AID --------------------- Print Data File --------------------------------
COMMAND ===> 

Specify Print Information:
Print format
===> F
(F = Fmt;V = Vfmt;C = Char;H = Hex)
Show
===> F
(Format, Number, Offset or Picture)

Specify Print Dataset:
Dataset or path ===> FASAMP.INVFILE
Member
===>
(Blank or pattern for member list)
Volume serial
===> 
Specify Record Layout and XREF Information:
Record layout usage
===> S
(S = Single; X = XREF; N = None)
Record layout dataset
===> FASAMP.LAYOUTS
Member
===> INVFILE
(Blank or pattern for member list)
XREF dataset
===> FASAMP.XREF
Member
===>
(Blank or pattern for member list)

Specify Selection Criteria Information:
(E = Existing; T = Temporary;
Selection criteria usage ===> N
M = Modify; Q = Quick; N = None)
Selection dataset
===> FASAMP.SELCRIT
Member
===>
(Blank or pattern member list)
Press Enter. File-AID displays the Print - JCL Specification screen, shown in Figure 11-8.
This screen allows you to enter or overtype the job statement information for the batch
submission.
11-6
File-AID Single Install Image Installation and Configuration Guide
Figure 11-8. Print - JCL Specification Screen





File-AID ---------------- PRINT - JCL Specification
COMMAND ===> 

JCL Information for Batch Processing: 
Sysout class
===>
*
--------------------------

JOB Statement Information:
===> //USERID0 JOB ('OFAQC2.0.0',xxxx),'AUDIT',
===> //
CLASS=P,NOTIFY=USERID0
===> 
===> 

Use JCL command to edit generated JCL
Use SUBMIT command to submit batch job
Use END to return to main PRINT panel without submitting job 
Enter a valid JOB statement and Sysout class. Then type SUBMIT in the COMMAND field
and press Enter. When the job has executed, view the output. The output should show a
formatted print of each record similar to the screen produced by in “Step 4 — Verify
Option 2 -- Edit Data File”.
Verifying File-AID Installation
11-7
File-AID/Data Solutions
Perform the following steps to verify the correct installation of File-AID/Data Solutions:
• “Step 1 — Make Available and Access File-AID/Data Solutions”
• “Step 2 — Verify Primary Options”
• “Step 3 — Verify UDACOPY CLIST” on page 11-7
• “Step 4 — Verify Option 1 - Date Aging” on page 11-8
• “Step 5 — Verify Batch Job Submission from Online Print” on page 11-11
• “Step 6 — Verify Option D, Data Privacy (Optional)” on page 11-12
Notes:
1. The SMP/E Installation, Configuration of PARM modules XVJOPUNV (“Step 2.
Specify File-AID Common Component Parameters” on page 2-7), XVJOPDPR (“Step
3.3. Specify File-AID Data Privacy (Option 3)” on page 2-55), and XVJOPUDA (“Step
4. Specify File-AID/Data Solutions Product Configuration Parameters” on page 4-5)
should be completed before you perform the verification steps. If “FALIBDEF” on
page 2-15 is set to No, refer to Chapter 12, “Site Deployment” on how to make
File-AID/Data Solutions available.
2. To create the files referenced in this chapter, refer to Appendix I, “Installing
Training Files”.
Step 1 — Make Available and Access File-AID/Data Solutions
This step is necessary only if you did not use the PDF LIBDEF services. Select the
appropriate method to make File-AID/Data Solutions available for use.
• Ensure the LLA (Load Library Lookaside) has been refreshed.
• Log off from the current ISPF session and log on using the newly modified logon
PROC.
• Execute the Allocation CLIST from native TSO.
• Log off and log on.
Step 2 — Verify Primary Options
Note:
The installation, customization, and tailoring of File-AID/Data Solutions should
be completed before you perform the following verification steps.
1. Select File-AID/Data Solutions from your ISPF Primary Option Menu (or
other menu containing the File-AID/Data Solutions access code).
2. To verify that you can invoke each of the primary options from the
File-AID/Data Solutions Primary Option Menu, enter the option number or
letter and press <Enter>.
3. Once you have confirmed that an option can be invoked, verify the next
option. Enter the END command (PF3) to return to the Primary Option
Menu, then select the next option.
Step 3 — Verify UDACOPY CLIST
The UDACOPY CLIST must be available to you in order to continue the verification
process (see Appendix I, “Installing Training Files”). Type TSO %UDACOPY on the
COMMAND line to execute the UDACOPY CLIST. File-AID/Data Solutions displays
11-8
File-AID Single Install Image Installation and Configuration Guide
progress messages as the sample files are created. Answer the question OK TO DELETE?
with Y (Yes).
Step 4 — Verify Option 1 - Date Aging
Invoke option 1 - Date Aging on the File-AID/Data Solutions Primary Option Menu.
File-AID/Data Solutions displays the Aging Tools Menu, as shown in Figure 11-9.
Figure 11-9. Aging Tools Menu
File-AID/Data Solutions ------- Aging Tools Menu -----------------------------
OPTION ===> 

1 Aging
- Date Aging
2 Calculator
- Date Calculator
3 Rules
- Edit Business Rules 











Use END to return to Primary Options Menu
Invoke option 1 - Aging on the Aging Tools Menu. File-AID/Data Solutions displays the
Input Dataset Specification screen, as shown in Figure 11-10. Fill in the dataset
information as shown. Press <Enter>.
Figure 11-10. Input Dataset Specification Screen

File-AID/Data Solutions - Input Dataset Specification -------------------------
COMMAND ===> 
Specify Input Dataset Information:
Dataset name
===> DASAMP.EMPLOYEE
Member name
===>
(Blank or pattern for member list)
Disposition
===> OLD
(OLD or SHR)
I/O exit name
===> 

Specify Record Layout and XREF Information:
Record layout usage
===> S
(S = Single; X = XREF)
Record layout dataset ===> DASAMP.LAYOUTS
Member name
===> EMPLOYEE (Blank or pattern for member list)
XREF dataset name
===> 
Member name
===>
(Blank or pattern for member list) 

Specify Criteria Information:
Use existing criteria ===> N
(Y = Yes; N = No)
Criteria dataset name ===> 
Member name
===>
(Blank or pattern for member list)

Specify Business Rules or Field Exits Dataset Information:
list)
Dataset name ===> DASAMP.BUSINESS.RULES
File-AID/Data Solutions displays the Aging Criteria screen, as shown in Figure 11-11.
Enter the following information in the EMP-DATE-OF-BIRTH field on this screen:
• A
+ (plus sign) in the RO (Relational Operator) field.
• 100 in the -Y- (Year) field.
Verifying File-AID Installation
11-9
• MMDDYY in the DATE PATTERN field.
• Use the END command to continue processing.
Figure 11-11. Aging Criteria Screen
Action Sets Display Show Options Menu Help
-------------------------------------------------------------------------------
File-AID/Data Solutions ------- Aging Criteria --------------------------------
COMMAND ===>
SCROLL ===> PAGE 
RULES
===>
("*" or pattern for member list)
SET 1 OF 1
EMPLOYEE-MASTER-FILE
GBL = N SEL = N
---- FIELD LEVEL/NAME ------- -FORMAT- RO -C- -Y- -M- --D-- --DATE PATTERN-- R
******************************* TOP OF DATA ***********************************
5 EMP-NUMBER
5/AN
5 EMP-LAST-NAME
15/AN
5 EMP-FIRST-NAME
10/AN
5 EMP-MID-INIT
1/AN
5 FILLER
2/AN
5 EMP-TITLE
30/AN
5 EMP-PERSONAL-INFO SYNC
23/GRP
10 EMP-NATL-ID-NUMBER
9/NUM
10 FILLER
1/AN
10 EMP-DATE-OF-BIRTH
6/AN
+
100
MMDDYY
10 EMP-DOB-REDEF REDEFINES EMP-DATE-OF-BIRTH
10 EMP-DOB-REDEF SYNC
6/GRP
15 EMP-DOB-MM
2/NUM
15 EMP-DOB-DD
2/NUM
Valid RO: +, -, R, FM - For list of patterns,leave PATTERN blank.
Commands: SELect, View
File-AID/Data Solutions displays the Criteria Menu screen, as shown in Figure 11-12.
Press <Enter> to continue processing.
Figure 11-12. Criteria Menu
File-AID/Data Solutions -10.02.00- Criteria Menu --OPTION ===>
-------------------------
















Member list description ===> ______________________________

Long
===> ______________________________________________________________
Description ===> ______________________________________________________________

Commands: VIEW, SAVE, END, CANCEL, ENTER to continue 
0
G
1
2.1
2.2
3.1
3.2
3.3
4
5.1
5.2
6
7
8
OPTIONS
GLOBAL
DATE AGING
EURO CONVERSION
TRIANGULATION
DATE PATTERN ANALYSIS
VALIDATION
DATA ANALYSIS
TRANSLATOR
GENERATOR
PATTERN
FIELD EXITS
DATA ENCRYPTION
REPLACE
-
Selection criteria options
GLOBAL Fields
Aging criteria
Euro Conversion criteria
Currency Triangulation
Date Pattern criteria
Validate criteria
Data Analysis criteria
Data Translator criteria
Data Generator criteria
Pattern Data Generation
Utilities criteria
Data Encryption Criteria
Data Replace Criteria
- Status default
0 fields
1 sets
0 sets
0 sets
0 sets
0 sets
0 sets
0 sets
0 sets
0 sets
0 sets
0 sets
0 sets
File-AID/Data Solutions displays the Output Specification screen, as shown in Figure 1113. Enter an A in the Output Processing Option field. Press <Enter>.
11-10
File-AID Single Install Image Installation and Configuration Guide
Figure 11-13. Output Specification Screen
File-AID/Data Solutions ------- Output Specification --------------------------
COMMAND ===> 

Input dataset: USERID0.DASAMP.EMPLOYEE 

Specify Output Processing Option:
Option
===> A (A=ANALYZE; C=COPY; U=UPDATE/PREVIEW)
Create audit trail ===> N (Y=Chgd record only; N=No; A=All records in Batch) 

Specify Output Dataset Information (COPY ONLY):
Dataset name
===> DASAMP.TEST
Disposition
===> OLD
(OLD or NEW)
I/O exit name ===>
(Blank=Use "FROM" I/O exit name;
NONE=No exit)
Specify PDS(E) COPY options:
Copy empty members from input ===> NO
(Y = Yes; N = No)
Replace like-named members
===> YES
(Y = Yes; N = No)
Rename copied members mask
===> 

Use ENTER to continue
Use VIEW command to display criteria summary
Use SAVE command to write criteria request
Use END to return to Criteria Menu
Use CANCEL command to restart at Input Specification Panel
File-AID/Data Solutions displays the Analyze Execution Options screen, as shown in
Figure 11-14. Press <Enter> to perform the analysis without changing any of the
Execution options.
Figure 11-14. ANALYZE Execution Options Screen

File-AID/Data Solutions ------- ANALYZE Execution Options ---------------------
COMMAND ===> 
Specify Execution Options:
Process online or batch ===> O
(O = Online; B = Batch)
Maximum invalid fields
===> ALL
(All or number of invalid fields)
Display invalid fields
===> Y
(Y = Yes; N = No)
Maximum changes
===> ALL
(All or number of changes) 


Specify Change Criteria Information:
Save change criteria
===> N
(Y = Yes; N = No)
Change criteria dataset ===>
Member name
===>
(Blank or pattern for member list) 

Member description ===> ______________________________
Long
===> ______________________________________________________________
Description ===> ______________________________________________________________


Use ENTER to execute ANALYZE
Use VIEW command to display criteria summary
Use END to return to Output Specification Panel
Use CANCEL command to restart at Input Specification Panel
File-AID/Data Solutions displays the Analyze Report screen, as shown in Figure 11-15.
Use the END command to continue processing.
Verifying File-AID Installation
11-11
Figure 11-15. Copy - Dataset Specification Screen
Menu Utilities Compilers Help
--------------------------------------------------------------------------------
BROWSE
USERID0.DASOLUTN.WF.D99097.T170231
Line 00000000 Col 001 080
Command ===>
Scroll ===> PAGE
******************************** Top of Data ***********************************
ET 1 DAGE-====================================================================
ET 1 DAGE-Records Read 50, Selected 50, Fields Changed 50, Invalid 0 
******************************* Bottom of Data ********************************
File-AID/Data Solutions displays the ANALYZE Print Report screen, as shown in Figure 1116. Type Y in the Print execution report field and press <Enter>.
Figure 11-16. ANALYZE Print Report Screen
File-AID/Data Solutions ----- ANALYZE Print Report
-------------------------
COMMAND ===> 



Print execution report ===> Y
(Y = Yes; N = No) 

Instructions: 

Use ENTER to perform above action and return to the initial screen
Use END to exit without PRINT
File-AID/Data Solutions displays the Print Parameters screen, as shown in Figure 11-17.
Press <Enter>.
Figure 11-17. Print Parameters Screen

File-AID/Data Solutions ---COMMAND ===> 
Number of lines/page
Sysout class
Number of copies

Enter One of the Following

Destination printer
- - - OR - - -
External JES Node ID
Target VM/TSO ident
- - - OR - - -
Sysout writer name
- - - OR - - -
Print Parameters
===> 55
===> A
===> 1 
-------------------------------
(0 = Suppress page headings)
Optional Destinations:

===>
(Local or remote printer)
===>
===>
(Predefined JES Node and symbolic ID
of intended receiver of output)
===>
(Installation assigned output writer)
(DSORG=PS; RECFM=V; LRECL=125)

Print dataset name
Disposition
Volume serial
===>
===> OLD
===> 
(NEW; SHR; MOD; OLD)
Use ENTER to continue, END to cancel
Step 5 — Verify Batch Job Submission from Online Print
Invoke option U - Utilities on the File-AID/Data Solutions Primary Option Menu. 
File-AID/Data Solutions displays the Utilities Selection Menu shown in Figure 11-18.
11-12
File-AID Single Install Image Installation and Configuration Guide
Figure 11-18. Utilities Selection Menu



File-AID/Data Solutions
OPTION ===> 
Print Options
1 Change Criteria
2 Audit Trail
Utilities Selection Menu
----------------------------
- Print the contents of Criteria sets 
- Print the contents of an audit trail
File Override Options

3 Generate Overrides - Generate file overrides for Criteria members
4 Update Criteria
- Update criteria with new file names 
Type 1 in the OPTION field and press <Enter>. File-AID/Data Solutions displays the Print
Change Criteria - Dataset Specification screen. This screen allows you to enter or
overtype the job statement information for batch submission.
Figure 11-19 shows the Print Change screen.
Figure 11-19. Print Change Criteria - Dataset Specification Screen

File-AID/Data Solutions ---COMMAND ===> 
Print Change Criteria
-
Dataset Specification
Specify Change Criteria Information:
Dataset name
===> DASAMP.CHGCRIT
Member name
===> ADD
(Blank = member list; * = all members)

Specify Batch JCL Information:
Sysout class
===> * 

Specify JOB Statement Information:
===> //USERID0A JOB (ACCOUNT),NAME
===> 
===> 
===> 

Use JCL command to edit generated JCL
Use SUBMIT command to submit batch job
Use END to return to main print panel without submitting job

Enter a change criteria dataset name and member ADD, valid JOB statement and Sysout
class. Then type SUBMIT in the COMMAND field and press <Enter>. When the job has
executed, view the output.
Step 6 — Verify Option D, Data Privacy (Optional)
This step should be performed when your site has the File-AID Data Privacy component
of the Compuware Workbench installed. In order to use Option D, Data Privacy, check
that you completed the following installation steps:
• Completed installation of the Compuware Workbench including File-AID Data
Privacy. Refer to the instructions in the File-AID Data Privacy chapter, of the
Compuware Workbench Installation Guide.
• Completed configuration of the Data Privacy PARM module XVJOPDPR (“Step 3.3.
Specify File-AID Data Privacy (Option 3)” on page 2-55).
• Completed installation of File-AID/Data Solutions including the following:
– Set product option variable DPRACT to Yes (refer to “DPRACT” on page 4-11) to
activate File-AID Data Privacy.
– Completed configuration of the File-AID/Data Solutions PARM module
XVJOPUDA (“Configuration Procedures” on page 4-1)
Verifying File-AID Installation
11-13
• Created at least one Dynamic Privacy Rules (DPR) Project with disguise rules in the
File-AID Data Privacy feature of the Compuware Workbench.
Invoke option D - Data Privacy on the File-AID/Data Solutions Primary Option Menu. 
File-AID/Data Solutions displays the “Input Dataset Specification Screen” (Figure 11-20)
for the Data Privacy option.
Figure 11-20. Input Dataset Specification Screen
File-AID/Data Solutions ------- Input Dataset Specification -------------
COMMAND ===> 

Specify Input Dataset Information:
Dataset name
===> DASAMP.EMPLOYEE
Member name
===>
(Blank or pattern for member list)
Disposition
===> OLD
(OLD or SHR) 
I/O exit name
===>
(User written I/O program)

Specify Record Layout Information and XREF Information:
Record layout usage
===> S
(S = Single; X = XREF)
Record layout dataset ===> DASAMP.LAYOUTS
Member name
===> EMPLOYEE
(Blank or pattern for member list)
XREF dataset name
===>
Member name
===>
(Blank or pattern for member list)

Specify Dynamic Privacy Rule Information:
Repository name
===>
Project name
===>

Here you specify the input dataset, record layout, and Dynamic Privacy Rule information
to disguise data based on a Privacy Project that has already been defined using the
File-AID Data Privacy plugin of the Compuware Workbench.
If you don’t know the DPR Repository or Project name, enter an asterisk (*) wildcard
character in each field.
The “Privacy Repository List Screen” (Figure 11-21) lists all File-AID Data Privacy
Repositories that are defined in the Compuware Workbench Server that File-AID/Data
Solutions is connected to.
File-AID/Data Solutions displays an error message if no connection is established.
Verify that you specified the correct information in “Step 3.3. Specify File-AID Data
Privacy (Option 3)” on page 2-55. Contact your Data Privacy Administrator for
details.
Figure 11-21. Privacy Repository List Screen

File-AID/Data Solutions Privacy Repository List ----------- SELECT REPOSITORY 
COMMAND ===>
SCROLL ===> CSR 
Use ENTER to process
* denotes Unavailable Repository

----- R E P O S I T O R Y
N A M E -------------------------------------
_ FA-Data-Privacy

* FA-Data-Privacy-SQLServer

***************************** END OF REPOSITORY LIST **************************
Select the desired repository name and press <Enter> .
The “Privacy Project List Screen” (Figure 11-22 on page 11-14) lists all File-AID Data
Privacy projects that match the full name or pattern you specified in the “Project name”
field of the “Input Dataset Specification Screen”. It displays even when there is only one
match in the list.
11-14
File-AID Single Install Image Installation and Configuration Guide
Figure 11-22. Privacy Project List Screen


File-AID/Data Solutions Privacy Project List -------- Select Criteria Project
COMMAND ===>
SCROLL ===> CSR
Use ENTER to process
Repository Name: FA-Data-Privacy
----- P R O J E C T
N A M E ---------------- Description ------------------
_ ALPHA Project
ALPHA Checklist
_ SSID
Social Sec. Disguise
_ EMPNBR
Employee No. privacy project
_ EMPNME
Employee Name privacy project
Select the desired project name and press <Enter> .
File-AID/Data Solutions displays an error message if no DPR projects match the full
name or pattern you specified in the “Project name” field. Check that you selected
the correct repository. Contact your Data Privacy Administrator for details.
After you specified the Input Dataset and selected a Privacy Project, the Output
Specification screen displays as shown in Figure 11-23. Specify whether you’re
performing an ANALYSIS, COPY, or UPDATE function and whether to create an audit
trail. Also, if you’re performing a COPY, you can specify the appropriate dataset
information.
Figure 11-23. Output Specification Screen


File-AID/Data Solutions ------- Output Specification --------------------------
COMMAND ===> 
Input dataset: USERID1.DASAMP.EMPLOYEE 

Specify Execution Options: 
Process BATCH
===> B (B = Batch)
Specify Output Processing Option: 
Option
===> A (A=ANALYZE; C=COPY; U=UPDATE)
Create audit trail ===> N (Y=Chgd record only; N=No; A=All records)
Specify Output Dataset Information (COPY ONLY):
Dataset name
===> DASAMP.NEWEMPL
Disposition
===> NEW
(OLD or NEW)
I/O exit name ===>
(Blank=Use "FROM" I/O exit name;
NONE=No exit)
Specify PDS(E) COPY options:
Copy empty members from input ===> NO
(Y = Yes; N = No)
Replace like-named members
===> YES
(Y = Yes; N = No)
Rename copied members mask
===> 

Use ENTER : Batch = JCL specification
Use END to return to Input Specification Panel
Use CANCEL command to restart at Input Specification Panel
After you have completed all appropriate field entries in the “Output Specification
Screen”, press <Enter> and File-AID/Data Solutions displays the appropriate ANALYZE,
COPY, or UPDATE JCL Specification Screen, as shown in Figure 11-24.
Verifying File-AID Installation
11-15
Figure 11-24. JCL Specification Screen

File-AID/Data Solutions - ANALYZE - JCL Specification
COMMAND ===> 
------------------------
JCL Information for Batch Processing: 

SYSOUT class
===> * 

JOB Statement Information:
===> //USERID0A JOB (’ODAQC2.0.0’,81),’DATA’,
===> //
CLASS=P,NOTIFY=USERID0,MSGCLASS=R,REGION=0M
===>
===> 



Use JCL command to edit generated JCL
Use SUBMIT command to submit batch job
Use END to return to main ANALYZE panel without submitting job
Enter the JCL command to review the generated JCL (Figure 11-25). Be sure to specify a
region size large enough to run Java (REGION=0M is suggested).
Figure 11-25. Generated JCL Edit Screen
EDIT
SYS11073.T094728.RA000.USERID1.R0144732
Columns 00001 00072 
Command ===>
Scroll ===> CSR 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //USERID1A JOB (ACCOUNT),NAME,REGION=0M

000002 //* YOU ARE VIEWING JCL THAT FILE-AID/DATA SOLUTIONS 10.2 HAS GENERATED
000003 //* TO UPDATE DATASETS GLOBALLY.

000004 //*

000005 //* YOU CAN CHANGE THIS JCL IF DESIRED AND USE THE SUBMIT PRIMARY

000006 //* COMMAND TO SUBMIT THE JOB. THE CREATE OR REPLACE PRIMARY COMMAND

000007 //* CAN BE USED TO KEEP THIS JOBSTREAM FOR FUTURE USE.

000008 //*

000009 //* USE THE END COMMAND TO EXIT WITHOUT SUBMITTING THE JOB.

000010 //*

000011 //DASTEP
EXEC PGM=UDASOLUT,REGION=0M,

000012 //
PARM='PRINT=DPRPRINT,SYSIN=DPRINPUT'

000013 //STEPLIB DD DISP=SHR,DSN=CPWR.MXVJA20.CXVJLOAD

000014 //
DD DISP=SHR,DSN=CPWR.MXVJA20.SXVJLOAD

000015 //MSGLIB
DD DISP=SHR,DSN=CPWR.MXVJA20.SXVJMENU

000016 //SYSOUT
DD SYSOUT=*

000017 //DPRPRINT DD SYSOUT=*

000018 //DPRERROR DD SYSOUT=*

000019 //SYSPRINT DD SYSOUT=*

000020 //SYSLIST DD SYSOUT=* 
000021 //DD01
DD DSN=USERID1.DASAMP.EMPLOYEE,

000022 //
DISP=OLD

000023 //DD01RL
DD DSN=USERID1.DASAMP.LAYOUTS,

000024 //
DISP=SHR

000025 //FARULES DD *

000026 FA-Data-Privacy

000027 8a9e81852eba4a3a012eba4c0b400002 SSID

000028 //DPRINPUT DD *

000029 $$DD01 ANALYZE LAYOUT=EMPLOYEE,CCSID=00037

000032 /*

000033 // 
****** **************************** Bottom of Data ****************************

The generated JCL can be edited, then submitted with the SUBMIT primary command,
and saved by using the CREATE or REPLACE primary commands. Saving your generated
JCL allows you to postpone execution or rerun the same job at another time.
Note:
The FARULES DD identifies the Privacy Rules Repository name and Dynamic
Privacy Rules Project ID you selected.
Submit the job and review the output.
11-16
File-AID Single Install Image Installation and Configuration Guide
File-AID for DB2
Refer to the File-AID for DB2 Reference manual and the File-AID Object Administration User
Reference manual for further information.
To create training files and programs you can use for verification, see Appendix I,
“Installing Training Files”.
Note:
The SMP/E Installation, Configuration of PARM modules XVJOPUNV (“Step 2.
Specify File-AID Common Component Parameters” on page 2-7), XVJOPDB2
(“Step 3.1 Specify DB2 Subsystem (Option 1)” on page 2-28), and XVJOPXFD
(“Step 4. Specify File-AID for DB2 Product Configuration Parameters” on page
6-5) should be completed before you perform the verification steps. If
“FALIBDEF” on page 2-15 is set to No, refer to Chapter 12, “Site Deployment”
on how to make File-AID for DB2 available.
File-AID/RDX
Refer to the File-AID/RDX User Guide for further information.
To create the training files referenced in the File-AID/RDX User Guide, see Appendix I,
“Installing Training Files”.
Note:
The SMP/E Installation, Configuration of PARM modules XVJOPUNV (“Step 2.
Specify File-AID Common Component Parameters” on page 2-7), XVJOPDB2
(“Step 3.1 Specify DB2 Subsystem (Option 1)” on page 2-28) if DB2 option is
installed, and XVJOPXFR (“Step 4. Specify File-AID/RDX Product Configuration
Parameters” on page 5-5) should be completed before you perform the
verification steps. If “FALIBDEF” on page 2-15 is set to No, refer to Chapter 12,
“Site Deployment” on how to make File-AID/RDX available.
File-AID for IMS/ISPF
A short test using File-AID for IMS/ISPF and the training files (see Appendix I, “Installing
Training Files”) completes the installation process. Running the test verifies that all
components of File-AID for IMS/ISPF are loaded properly and that executing File-AID for
IMS/ISPF produces the expected results.
Note:
The SMP/E Installation, Configuration of PARM modules XVJOPUNV (“Step 2.
Specify File-AID Common Component Parameters” on page 2-7), XVJOPIMS
(“Step 3.2. Specify IMS Environment (Option 2)” on page 2-39), and XVJOPXIX
(“Step 4. Specify File-AID for IMS/ISPF Product Configuration Parameters” on
page 7-9) should be completed before you perform the verification steps. If
“FALIBDEF” on page 2-15 is set to No, refer to Chapter 12, “Site Deployment”
on how to make File-AID for IMS available.
This chapter provides step-by-step procedures along with screen illustrations and
explanations of common variances to assist you with the verification of the installation
of File-AID for IMS/ISPF.
Note:
If you previously installed a version of File-AID for IMS/ISPF, the default field
values on the screens shown in this chapter may differ from your screen displays.
The default field values presented in this chapter will match your default field
values only if your ISPF Profile member (IXPPROF) does not exist.
Verifying File-AID Installation
11-17
Step 1. Verify Primary Options
Invoke File-AID for IMS/ISPF through the method chosen during customization of your
environment.
From the File-AID for IMS/ISPF Primary Option Menu, verify that you can invoke each of
the primary options by entering the appropriate number or letter and pressing Enter. As
you confirm that you can invoke each option, you can invoke the next one by either
returning to the Primary Option Menu using the END command or pressing PF3 and
then selecting the next option or by going directly to the option using a jump command
(for example, =3).
Step 2 — Verify XIXCOPY CLIST
The XIXCOPY CLIST must be available to you in order to continue the verification
process (see Appendix I, “Installing Training Files”). Type TSO XIXCOPY on the
COMMAND line to execute the XIXCOPY CLIST. File-AID displays progress messages as
the sample files are created. Answer Y (Yes) to delete old training files and create new
copies.
Step 3. Verify Option 7
Perform the following:
1. Enter 7 from the File-AID for IMS/ISPF Primary Option Menu. The Segment/Layout
XREF - Dataset Specification screen is displayed.
Figure 11-26. EDIT Segment/Layout XREF - Dataset Specification Screen
File-AID for IMS -- Segment/Layout XREF - Dataset Specification
COMMAND ===>
ENV: TEST - IMS ENVIRONMENT
------------

Enter member name of segment/layout XREF to be edited:

+ Segment/Layout XREF dataset . 'XXXXXXX.FISAMP.XREFC’
Member . . PORDR
(Blank or pattern for member list)



Use DBDLIB datasets for addition . . N (Y = Yes; N = No)


+ DBDLIB dataset 1 . . 'XXXXXXX.FISAMP.DBDLIB
Dataset 2 . . 






2. Verify that the dataset names on the screen have the same high level qualifier you
specified with install variable “TRUSER” (see “Specify Training File VARIABLES” on
page I-2). Typically, the high level qualifier is your TSO UserID. If not, change them
to the new training file names.
3. Type PORDR in the Member field and press Enter. The EDIT Segment/Layout XREF Segment List screen is displayed (Figure 11-27 on page 11-18).
11-18
File-AID Single Install Image Installation and Configuration Guide
Figure 11-27. EDIT Segment/Layout XREF - Segment List Screen
EDIT XREF - XXXXXXX.FISAMP.XREFC(PORDR) -------------------------- ENTRY 00001
COMMAND ===>
SCROLL ===> CSR 

Description ===> PHYSICAL ORDER DBD
Line Data
COBOL
Segment
Starting COBOL Data-name
Cmd
Base
Segment
Member
Description
(Blank for entire COBOL MBR)
--- -------- -------- ---------- --------------- ------------------------------
PORDR
ORDR010 ORDR010
ORDER ROOT
ORDR020 *MULT-RTV* ORDER LINE
ORDR030 ORDR030
ORDER STATUS
ORDR040 ORDR040
ORDER SCRAP
ORDR050 *LCHILD*
ORDR-CUST LCHLD
*** END OF SEGMENT LIST *** 







To specify record type values, enter "*" for member name and enter "S" line cmd
To specify concatenated/lchild segment information, enter "S" line cmd 

Enter "DELETE/INSERT dbd-name" to delete/add a DBD from/to the seg/layout XREF
Step 4. Verify Option 2
1. Enter =2 on the COMMAND line. Either the EDIT - Data Base Specification (Dynamic
PSB) screen (Figure 11-28) or the EDIT - Data Base Specification (Static PSB) screen
(Figure 11-32 on page 11-20) is displayed.
2. If the Static PSB screen is displayed, enter the XPSB command on the COMMAND
line to switch to the Dynamic PSB screen.
Dynamic PSB
Figure 11-28. EDIT - Data Base Specification Screen (Dynamic PSB)



File-AID for IMS ----- Edit - Data Base Specification (Dynamic PSB) -----------
COMMAND ===>
ENV: TEST - IMS ENVIRONMENT
Region type . . DLI
(DLI or BMP) 
+ DBDLIB dataset 1 . . ‘CW.FISAMP.DBDLIB
Dataset 2 . .
Member . .
(Blank or pattern for member list)
Use secondary indexing . . N
(Y = Yes; N = No)
Exclude segments . . N
(Y = Yes; N = No; DLI and BMP only)
-------------------------------------------------------------------------------
Use COBOL layouts . . Y
(Y = Yes; N = No)
+ Segment/Layout XREF dataset . ‘CW.FISAMP.XREFC
Member . .
(Blank or pattern for member list)
+ COBOL layout dataset 1 . .
Dataset 2 . .
-------------------------------------------------------------------------------
Create audit trail . . N
(Y = Yes; N = No)
For DLI processing specify the following:
IMS log dataset usage . . N
(AK = Allocate; keep after edit
AD = Allocate; delete after edit
N = Do not use log dataset)
1. Verify that the DBDLIB dataset, Segment/Layout XREF dataset, and layout dataset
names match the training file dataset names that were created for you by the
XIXCOPY process. Enter DBDLIB member name PORDR and XREF member name
PORDR.
Verifying File-AID Installation
11-19
2. Enter Y in the Create audit trail field to verify that the Cataloged Unit and Cataloged
Volume parameters are properly set.
After you complete the screen, press Enter. The EDIT - Data Base Dataset Specification
screen shown in Figure 11-29 is displayed.
Figure 11-29. EDIT – Data Base Dataset Specification Screen
------ EDIT
COMMAND ===>
------ Data Base Dataset Specification (DBD-PORDR
)- LINE 00001
SCROLL ===> PAGE

Obtain DB Dataset Names from ===> P (P = Previously used with 'P' here,
S
I = IMS dynamic allocation source)
H
R
DBRC not active
D

I L
S E
DBD
DDNAME
DATASET NAME
PASSWORD P V
-------- -------- ---------------------------------------------- -------- --- -
PORDR
PORDRDD ‘CW.FISAMP.ORDER’
OLD N
PCUST
PCUSTDD ‘CW.FISAMP.CUSTOMER’
OLD N
*** END OF DATA BASE DATASET NAMES
***









Press ENTER when data base datasets have been fully designated

Use END command to end Edit Data Base Dataset Specification
3. Enter the dataset names for the training ORDER and CUSTOMER databases (both
created with XIXCOPY) on lines one and two, respectively. Press Enter.
File-AID for IMS is invoked and the EDIT - Data Base Location screen shown in Figure
11-30 is displayed.
Figure 11-30. EDIT – Data Base Location Screen
File-AID for IMS --- EDIT - Data Base Location --- ENTER KEY, OR A LINE CMD
COMMAND ===>
SCROLL ===> CSR 

Line
Key
Key
Cmd -----Level----- Segment- --Description-Length-------------Value------------
__ 1 DBD-PORDR
ORDR010 ORDER ROOT
006
__
2
ORDR020 ORDER LINE
002
__
3
ORDR030 ORDER STATUS
002
__
2
ORDR040 ORDER SCRAP
008
__
2
ORDR050 ORDR-CUST LCHLD 002
*** END OF SEGMENT LIST *** 








S -- Select Formatted
K -- Key Specification, then Select Formatted
SU -- Select Unformatted
KU -- Key Specification, then Select Unformatted
SC -- Select Character
KC -- Key Specification, then Select Character
4. Type S on the first data line on the screen and press Enter. The Formatted screen
shown in Figure 11-31 on page 11-20 is displayed.
11-20
File-AID Single Install Image Installation and Configuration Guide
Figure 11-31. Formatted Screen
EDIT - XXXXXXX.FISAMP.ORDER ------------------------ (DBD-PORDR
)- LINE 00001
COMMAND ===>
SCROLL ===> CSR
PARENT
SEGMENT ORDR010
CONCATENATED KEY: AA2222
--------LEVEL NUMBER/DATA-NAME--------- -FORMAT- ---------FIELD VALUE----------
01 ORDER-ROOT DATA
05 ORDER-ROOT-KEY
07 ORDER-NUMBER-PREFIX
C
2 K AA
07 ORDER-NUMBER
Z
4 K 2222
05 ORDER-DESCRIPTION
C 40
INDUSTIAL GRADE COAXIAL CABLE
(POS 31-40)
05 CUSTOMER-NUMBER
C
6
CN0001
05 PLANNED-ORDER-QUANTITY
PS 5
500
05 PLANNED-ORDER-AMOUNT
P
5 2 3567.58
05 ORDER-TYPE
C
2
WS
05 ACTUAL-ORDER-QUANTITY
PS 5
INVALD X’404040’
05 TOTAL-SCRAP-QUANTITY
PS 5
10
05 TOTAL-SCRAP-REDEFINES
RDEFINES TOTAL-SCRAP-QUANTITY
C
3
INVALD X’00010C’
05 ORDER-STATUS
Z
2
01
05 FILLER
C
1
<
05 FIRST-ACTIVITY-DATE
ENTER UNFMT TO SWITCH TO UNFORMATTED MODE, CHAR TO SWITCH TO CHARACTER MODE 
5. Press PF3 twice to return to the EDIT - Data Base Specification (Dynamic PSB) screen
(Figure 11-28 on page 11-18).
6. Enter XPSB on the COMMAND line. The EDIT - Data Base Specification (Static PSB)
screen is displayed (Figure 11-32 on page 11-20).
Static PSB
Figure 11-32. EDIT - Data Base Specification Screen (Static PSB)
File-AID for IMS ----- Edit
COMMAND ===>
ENV: TEST - IMS ENVIRONMENT
Region type
+ PSBLIB dataset 1
Dataset 2
Member
- Data Base Specification (Static PSB) ------------


. . DLI
(DLI or BMP)

. . 'hlq.CPWR.MXVJA20.SXVJPPSB'

. .

. . XIXPSBSA
(Blank or pattern for member list) 

+ DBDLIB dataset 1 . . 'XXXXXXX.FISAMP.DBDLIB'

Dataset 2 . .

Member . .
(Blank or pattern for member list) 
-------------------------------------------------------------------------------
Use COBOL layouts . . Y
(Y = Yes; N = No)

+ Segment/Layout XREF dataset . FISAMP.XREFC


+ COBOL layout dataset 1 . . ‘XXXXXXX.FISAMP.COBOLLIB’

Dataset 2 . .

-------------------------------------------------------------------------------
Create audit trail . . Y
(Y = Yes; N = No)


For DLI processing specify the following:

IMS log dataset usage . . N
(AK = Allocate; keep after edit

AD = Allocate; delete after edit

N = Do not use log dataset) 
1. Verify that the PSBLIB dataset 1 entry has the same high level qualifier as your
installed target datasets (see Table 2-2 on page 2-11). The DBDLIB dataset 1, COBOL
layout dataset, and XREF entries should already be set from the prior edit session.
2. Type XIXPSBSA as the PSB Member name, erase the DBDLIB Member name, and
press Enter. The DBD Selection List for Static PSB screen is displayed (Figure 11-33 on
page 11-21).
Verifying File-AID Installation
11-21
3. Type S in the first line command to edit the PORDR database, and press Enter. The
EDIT - Data Base Dataset Specification screen is displayed. The dataset names should
be set from the prior edit session.
4. Press Enter. File-AID is invoked again, and the EDIT - Data Base Location screen is
displayed.
5. Type S on the first data line on the screen and press Enter. The Formatted screen is
displayed.
6. Type =X in the command field, and press Enter. If your TSO user profile option is set
to WTMSG, the message DFS627I RESOURCE CLEANUP COMPLETE is shown,
followed by a display of the Primary Option Menu.
Figure 11-33. DBD Selection List for Static PSB Screen
File-AID for IMS ----- DBD Selection List for Static PSB ----LINE 00001
COMMAND ===>
SCROLL ===> CSR
-------------------------------------------------------------------------------
Select ALL DBDs in PSB XIXPSBSA
===> N
(Y = Yes; N = No) 

Use
Exclude
Segments
PCB
Secondary
Line
DBD
COBOL
XREF
More
in
in
PCB
Proc Process
Cmd
Name
Layout
Member
Segs
PCB
DBD
Name
OPT
Sequence
--- -------- ------ -------- -------------- -------- ---- --------
__
PORDR
Y
PORDR
N
5 OF 5
PORDRA
AP
__
PCUST
Y
PCUST
N
3 OF 3
PCUSTA
AP
__
PPART
Y
PPART
N
2 OF 2
PPARTA
AP
__
PORDR
Y
PORDR
N
5 OF 5
PORDRGO
GO
__
PCUST
Y
PCUST
N
3 OF 3
PCUSTGO
GO
__
PPART
Y
PPART
N
2 OF 2
PPARTGO
GO 


S Selects the DBD(s) to process in this session
F Specifies the First DBD to process when multiple DBDs have been selected
H Graphically displays the Hierarchical structure of the DBD 

Press Enter when all DBDs to process have been selected.
Use END to return to Data Base Specification Screen.
Step 5. Verify Panvalet and Librarian Support
If Panvalet or Librarian are in use at your installation, perform the following tests:
1. Get the name of a Panvalet or Librarian COBOL or PL/I member that contains a
segment layout.
2. Enter 7 from the File-AID Primary Option Menu.
3. Type member name LIBRTST, and press Enter. The EDIT Segment/Layout XREF Segment List screen is displayed.
4. Change the YYYYYYYYYY value under the MBR heading to the name of the member
you obtained in step 4-1.
5. Enter the END command twice. The File-AID Primary Option Menu is displayed.
6. Select Option 2 and press Enter. Add the name of your Panvalet or Librarian dataset
as the second COBOL or PL/I layout dataset on the EDIT - Data Base Specification
screen.
7. Press Enter. The EDIT - Data Base Dataset Specification screen is displayed. The
dataset names should have been retained from step 3-3.
8. Press Enter. The EDIT - Data Base Location screen is displayed.
9. Type S on the first data line and press Enter. The Formatted screen is displayed using
the COBOL or PL/I layout from Panvalet or Librarian.
11-22
File-AID Single Install Image Installation and Configuration Guide
This screen probably does not match the segment contents. However, the purpose of
this step is simply to verify that the layout itself was successfully retrieved.
Step 6. Verify Batch Extract Job Submission
Invoke Option 4.1, Data Base Extract. The following sequence of screens is displayed to
submit a DL/I job. The DL/I job extracts segments from the sample databases specified in
the Training files screen in the Install option of the File-AID – INSTALL MENU to a new
dataset named XXXXXXX.FISAMP.UNLOAD.
Figure 11-34. Data Base Extract - Data Base Specification Screen
File-AID for IMS - Data Base Extract - Data Base Specification (Dynamic PSB) --
COMMAND ===>

ENV: TEST - IMS ENVIRONMENT


Extract job type . . DLI
(DLI or BMP)


Specify the DBD for the "FROM" data base:


+ DBDLIB Dataset 1 . . 'XXXXXXX.FISAMP.DBDLIB'

Dataset 2 . .

Member . . PORDR
(Blank or pattern for member list) 
Use secondary indexing . . N
(Y = Yes; N = No)

-------------------------------------------------------------------------------
The "Key values" to the "ROOT" segment or Secondary Index of the "FROM"

data base may be supplied in a separate dataset. 

Extract based on key values . . N
(Y = Yes; N = No)


Specify the dataset that contains the "key values" below:

"keys" dataset . . 'XXXXXXX.FISAMP.SELCRIT'

Member . .
(Blank or pattern for member list)




1. Enter the DBDLIB training dataset name created during installation, and press Enter.
The Data Base Extract - Option Specification screen is displayed (Figure 11-35 on
page 11-23).
2. Verify that the fields match the preceding figure, and press Enter. The EXTRACT Data Base Dataset Specification screen is displayed (Figure 11-36 on page 11-23).
The dataset names should be retained from Step 3-3. Press Enter. The Data Base
Extract - JCL Specification screen is displayed (Figure 11-37 on page 11-24).
3. Verify that the fields match the above figure.
4. Modify the JOB statement information to conform to your installation standards,
and press Enter to submit the job.
5. Review the Data Base Extract Report when the job finishes executing.
Verifying File-AID Installation
11-23
Figure 11-35. Data Base Extract - Option Specification Screen
File-AID for IMS - Data Base Extract - Option Specification
COMMAND ===>
ENV: TEST - IMS ENVIRONMENT

Use application relatnships . . Y
(Y= Yes; N= No)

-----------------



+ Appl relationship dataset . . XXXXXXX.FISAMP.APPLREL

-------------------------------------------------------------------------------
Selection criteria usage . . . . N
(E= Existing; T= Temporary; N= None) 

+ Selection criteria dataset . .

Member . . . PORDR
(Blank or pattern for member list)

-------------------------------------------------------------------------------
Disguise Extract File . . . . . N
(Y= Yes; N= No)
Create File-AID/MVS XREF . . . . N
(Y= Yes; N= No)
Use COBOL layouts
. . . . . . . Y
Segment/Layout XREF dataset
.
Member . .
+ COBOL layout Dataset 1 . . . .
Dataset 2 . . . . .
(Y - formatted, N - Segment/unformatted)

XXXXXXX.FISAMP.XREFC

PORDR
(Blank or pattern for member list)


XXXXXXX.FISAMP.COBOLLIB


Figure 11-36. EXTRACT - Data Base Dataset Specification Screen
------ EXTRACT
--- Data Base Dataset Specification
(DBD-PORDR
) LINE 00001
COMMAND ===>
SCROLL ===> CSR


Obtain DB Dataset Names from ===> P
(P = Previously used with ‘P’ here,
S
I = IMS dynamic allocation source)
H
R

DBRC not active
D
I L
S E
DBD
DDNAME
DATASET NAME
PASSWORD
P V
--------- ---------- ------------------------------------------- --------- --- -
PORDR
PORDRDD
‘CW.FISAMP.ORDER’
SHR N
PCUST
PCUSTDD
‘CW.FISAMP.CUSTOMER’
SHR N
PPART
PPARTDD
‘CW.FISAMP.PART’
SHR N
***
END OF DATA BASE DATASET NAMES
*** 







Press Enter when data base datasets have been fully designated
Use END command to end Edit Data Base Dataset Specification 
11-24
File-AID Single Install Image Installation and Configuration Guide
Figure 11-37. Data Base Extract - JCL Specification Screen
File-AID for IMS -COMMAND ===>
Data Base Extract - JCL Specification
-------------------


Specify "TO" DSN below (file will be written in File-AID for IMS unload format):
"TO" dataset . . . . . . XXXXXXX.FISAMP.UNLOAD

Member . . . . . .
(Blank or pattern for member list)

Volser . . . . . .
Password . . . .

Dataset disposition . . NEW
(NEW, SHR, or OLD)


If disposition is NEW, specify the following allocation parameters:

Generic unit . . . . . DISK

Block size . . . . . . 19069
(DSORG=PS,RECFM=VB,LRECL=587)

Space units . . . . . . TRK
(BLK, TRK, or CYL)

Primary Quantity . . . 2
(in above units)

Secondary Quantity . . 1
(in above units)

-------------------------------------------------------------------------------
JOB statement information:
Sysout class . . *

===> //EXTRACT JOB ('ACCOUNT_INFO'),'FILE_AID/IMS’,CLASS=E,REGION=5M,

===> //
MSGCLASS=X,NOTIFY=XXXXXXX,MSGLEVEL=(1,1)

===> //*ROUTE OUTPUT LOCAL

===> //*


Press ENTER to submit batch job
Enter JCL command to edit generated JCL 
Step 7. Copy Default Profile Table
Copy default profile table IXPPROF from your ISPF profile library to File-AID ISPTLIB
dataset to establish limited defaults.
Generating Diagnostics
If you contact Compuware’s Customer Support for assistance, the Customer Support
Analyst may ask you to generate a dump and/or a File-AID trace.
Before attempting to generate dump output, consult your system programming staff to
determine what is required to generate complete SYSUDUMP output. Sometimes key
portions of a system dump are not written in order to maximize system performance,
particularly in production environments.
You may use the FIDUMP CLIST found in the File-AID CLIST library
(hlq.CPWR.MXVJA20.SXVJCLIB) to generate SYSUDUMP and IXPTRACE output. An
example of this CLIST is shown in Figure 11-38 on page 11-25.
The FIDUMP CLIST creates and allocates a SYSUDUMP dataset and an IXPTRACE dataset.
By default, these datasets are named &sysuid.FILEAID.IMS.DUMP and
&sysuid.FILEAID.IMS.TRACE1 where &sysuid is your user ID. If necessary, you may change
the names of these datasets by modifying the CLIST. The CLIST also invokes File-AID in
TEST mode. This causes the product to bypass ESTAE/ESPIE processing at the time of an
ABEND. Executing this CLIST will always create the File-AID trace dataset. This permits
diagnostic information to be generated even when no ABEND occurs.
1. When using the File-AID Eclipse of the Compuware Workbench, the trace dataset name is
&sysuid.FAIMS.TRACE.Dnnnnnnn.Tnnnnnnn.
Verifying File-AID Installation
11-25
Figure 11-38. FIDUMP CLIST
/*
PROC 0 ZTRAIL()
CONTROL NOMSG NOFLUSH
/* *******************************************************************
/* FILE-AID FOR IMS/ISPF STARTUP CLIST FOR PROBLEM/DUMP ANALYSIS.
/* GENERATES DUMP DATASETS AND INVOKES FILE-AID FOR IMS IN TEST MODE.
/* FOR THE PURPOSE OF GENERATING A DUMP WITHOUT ANY ESTAE OR ESPIE
/* PROCESSING.
/*
/* TO INVOKE:
/* 1) ENTER ISPF 7.1
/* 2) IN "CMD" FIELD ENTER: FIDUMP
/* *******************************************************************
/* ALLOCATE DUMP DATASETS */
FREE
FI(SYSUDUMP ABNLIGNR IXPTRACE)
DELETE
FILEAID.IMS.DUMP
ALLOC
FI(SYSUDUMP) DA(FILEAID.IMS.DUMP) MOD CATALOG +
SPACE(10 10) CYLINDERS +
RECFM(V B A) LRECL(125) BLKSIZE(1632)
ALLOC
FI(IXPTRACE) DA(FILEAID.IMS.TRACE) MOD CATALOG +
SPACE(10 10) CYLINDERS +
RECFM(F B) LRECL(80) BLKSIZE(0)
ALLOC
FI(ABNLIGNR) DUMMY REUSE
/* INVOKE FILE-AID FOR IMS/ISPF IN TEST MODE */
ISPEXEC LIBDEF ISPLLIB

ISPEXEC LIBDEF ISPMLIB

ISPEXEC LIBDEF ISPPLIB

ISPEXEC LIBDEF ISPSLIB

ISPEXEC LIBDEF ISPTLIB

ISPEXEC VGET (ZSCREEN)

FREE
FI(XVJLIB&ZSCREEN)

ISPEXEC SELECT CMD(XVJALLOC PRODID(XID)

/* FREE DATASETS */

FREE FI(SYSUDUMP ABNLIGNR IXPTRACE)

END
In most cases the following steps will allow you to create SYSUDUMP output and/or a
trace output:
1. Access ISPF 7.1 (Dialog Test).
2. Enter EX 'hlq.SXVJCLIB(FIDUMP)' in the CMD field, where hlq is the high level
qualifier used to install File-AID for IMS/ISPF. This starts File-AID for IMS/ISPF in test
mode.
3. Perform the steps in File-AID for IMS/ISPF that produced the problem’
4. If necessary, free the SYSUDUMP and IXPTRACE datasets.
5. Download these datasets using a BINARY transfer protocol and transmit them to
Compuware.
File-AID for IMS/CICS
A short test that uses the File-AID for IMS training files (see Appendix I, “Installing
Training Files”) completes the installation process. Running the test verifies that all
components of File-AID for IMS/CICS are loaded properly and that executing File-AID for
IMS/CICS produces the expected results.
Note:
The SMP/E Installation, Configuration of PARM modules XVJOPUNV (“Step 2.
Specify File-AID Common Component Parameters” on page 2-7), XVJOPIMS
(“Step 3.2. Specify IMS Environment (Option 2)” on page 2-39), and XVJOPNIX
(“Step 4. Specify File-AID for IMS/CICS Product Configuration Parameters” on
page 8-14) should be completed before you perform the verification steps.
This chapter provides step-by-step procedures along with screen illustrations and
explanations of common variances to assist you with the verification of the installation
11-26
File-AID Single Install Image Installation and Configuration Guide
of File-AID for IMS/CICS. If you encounter any problems during the verification
procedure, refer to “Potential Problems Encountered During Installation” on page 11-30.
Call a Compuware customer support representative if you are still unable to solve the
problem.
Step 1. Verify Primary Options
1. Logon to CICS.
2. Enter one of the transaction codes installed, preferably one that can access the
sample databases shipped with File-AID for IMS/CICS. The File-AID for IMS/CICS
Primary Option Menu is displayed.
Figure 11-39. Primary Option Menu

------------------ File-AID for IMS/CICS PRIMARY OPTION MENU -----------------
OPTION ===> 
1
2
L
X
BROWSE
EDIT
LEGAL
EXIT
-
Display data base contents
Create or change data base contents
Copyright and Trade Secret Information
Terminate File-AID for IMS/CICS session

RELEASE
CPU ID
TERMINAL
TIME
DATE
-
10.2
170495
XAS78A48
13:49:24
14-09-26
DBD TO BE USED ===>
(Blank for member list) 

-------------------------------------------------------------------------------

Enter your USERID and PASSWORD: 

USERID
===>
PASSWORD ===> 


Copyright (c) 2014, an unpublished work by Compuware Corporation.
All Rights Reserved
Step 2. Edit DBD
1. Enter 2 in the Option field.
2. Press Enter.
The DBD Member List screen is displayed. The DBDs listed are the same as those in
the PSB associated with the transaction entered in “Step 1. Verify Primary Options”
on page 11-26.
Verifying File-AID Installation
11-27
Figure 11-40. DBD Member List Screen

-------------------------COMMAND ===>
_
_
_
_
_










--DBD--LCUST
LORDR
PCUST
PORDR
PPART

PF1-MENU
EDIT - DBD MEMBER LIST
---------------------------
SCROLL ===> CUR
----DATA BASE DESCRIPTION-----
CUSTOMER DB - LOGICAL VIEW
ORDER
DB - LOGICAL VIEW
CUSTOMER DATA BASE
ORDER
DATA BASE
PART
DATA BASE
*** END OF DBD MEMBER LIST *** 
3-END
7-UP
8-DOWN
Step 3. Edit Database Location
1. Type S next to the PORDR database name that you want to select.
2. Press Enter.
The Data Base Location screen is displayed.
Figure 11-41. Data Base Location Screen







----------------------- EDIT - DATA BASE LOCATION -- ENTER KEY, OR A LINE CMD
COMMAND ===>
SCROLL ===> CUR
I027 "S", "SU", OR "SI" CMD WITHOUT A KEY VALUE RETRIEVES FIRST ROOT IN DB
LINE
KEY
KEY
CMD -----LEVEL----- --SEG--- --DESCRIPTION-- LTH -------------VALUE------------
__* 1 DBD-PORDR
ORDR010 ORDER ROOT
006
__
2
ORDR020 ORDER LINE
002
__
3
ORDR030 ORDER STATUS
002
__
2
ORDR040 ORDER SCRAP
008
__
2
ORDR050 ORDR-CUST LCHLD 002
*** END OF SEGMENT LIST *** 

S -- Select Formatted
SU -- Select Unformatted
SI -- Select Index of Segments
PF1-MENU
2-DBD
3-END
7-UP
K -- Key Spec, then Select Formatted
KU -- Key Spec, then Select Unformatted
KI -- Key Spec, then Select Indexed 
8-DOWN
Step 4. Select Segment and Format
1. Select the first segment on the Data Base Location screen to retrieve the first segment
in the database, and press Enter.
The Formatted screen is displayed (Figure 11-42 on page 11-28).
11-28
File-AID Single Install Image Installation and Configuration Guide
Figure 11-42. Formatted Screennnn

EDIT --- (PORDR - ORDER
DATA BASE) ------------------------------ LINE 00001
COMMAND ===>
SCROLL ===> CUR
PAR
SEG ORDR010 ORDER ROOT
CONCAT KEY: AA2222
--------LEVEL NUMBER/DATA-NAME--------- -FORMAT- ---------FIELD VALUE----------
01 ORDER-ROOT-DATA
05 ORDER-ROOT-KEY
07 ORDER-NUMBER-PREFIX
C
2 K AA
07 ORDER-NUMBER
Z
4 K 2222
05 ORDER-DESCRIPTION
C 40
INDUSTRIAL GRADE COAXIAL CORD
(POS 31-40)
05 CUSTOMER-NUMBER
C
6
CN0001
05 PLANNED-ORDER-QUANTITY
PS 5
600
05 PLANNED-ORDER-AMOUNT
P
5 2 3567.58
05 ORDER-TYPE
C
2
WS
05 ACTUAL-ORDER-QUANTITY
PS 5
100
05 TOTAL-SCRAP-QUANTITY
PS 5
10
05 TOTAL-SCRAP-REDEFINES
RDEFINES TOTAL-SCRAP-QUANTITY
C
3
INVALD X’00010C’
05 ORDER-STATUS
Z
2
01
05 FILLER
C
1
<
05 FIRST-ACTIVITY-DATE 
PF1-MENU 2-DBD 3-END 4-NEXT 5-CHILD 6-TWIN 7-UP 8-DOWN 9-PAR 12-ROOT
2. Type UNFMT to display the segment in the unformatted mode, and press Enter.
The Unformatted screen is displayed (Figure 11-43).
Figure 11-43. Unformatted Screen





EDIT --- (PORDR - ORDER
DATA BASE) -----------------------------------------
COMMAND ===>
SCROLL ===> CUR
PAR
SEG ORDR010 ORDER ROOT
CONCAT KEY: AA2222
SEG LENGTH ===> 167
----+----1----+----2----+----3----+----4----+----5----+----6----+----7 
1 AA2222INDUSTRIAL GRADE COAXIAL CORD
CN0001.-.....WS......01<
CCFFFFCDCEEEDCCD4CDCCC4CDCECCD4CDDC44444444444CDFFFF0600578EE010000FF4
112222954423991307914503617913036940000000000035000100C365F6200C01C01C
----+----*----+----*----+----*----+----*----+----*----+----*----+----*
71 1988083019880914.........P....P...................!..!................
FFFFFFFFFFFFFFFF010010004990049900000000130001300050050012000120000000
198808301988091402F02F0087C0087C01F01F0023C0023C02A02A0064C0064C00F00F
----+----*----+----*----+----*----+----*----+----*----+----*----+----*
141 ..........................B
00000000000000000000000000C
0000C0000C00F00F0000C0000C2 

PF1-MENU 2-DBD 3-END 4-NEXT 5-CHILD 6-TWIN 7-UP 8-DOWN 9-PAR 12-ROOT
3. Type KEY, and press Enter.
The Key Specification screen is displayed (Figure 11-44).
Verifying File-AID Installation
11-29
Figure 11-44. Key Specification Screen








KEY SPEC --- (PORDR - ORDER
DATA BASE) ------------- SPECIFY KEY TO RETRIEVE
COMMAND ===>
SCROLL ===> CUR
SEGMENT TO RETRIEVE: ORDR010 ORDER ROOT
-------LEVEL NUMBER/DATA-NAME------- -FORMAT- RO ---------FIELD VALUE----------
LVL 1 ORDR010
EQ
05 ORDER-ROOT-KEY
07 ORDER-NUMBER-PREFIX
C
2 K
AA
07 ORDER-NUMBER
Z
4 K
2222
********
END OF KEY
******** 

Enter END command when the key value has been fully specified
Enter CANCEL command to terminate Key Specification without processing the key
PF3-END 7-UP 8-DOWN
4. Type CANCEL, and press Enter.
The Unformatted screen is displayed again.
5. Type HEX OFF, and press Enter.
The Unformatted/HEX OFF screen is displayed (Figure 11-45).
Figure 11-45. Unformatted/HEX OFF Screen











EDIT --- (PORDR - ORDER
DATA BASE) -----------------------------------------
COMMAND ===>
SCROLL ===> CUR
PAR
SEG ORDR010 ORDER ROOT
CONCAT KEY: AA2222
SEG LENGTH ===> 167
----+----1----+----2----+----3----+----4----+----5----+----6----+----7 
1 AA2222INDUSTRIAL GRADE COAXIAL CORD
CN0001.-.....WS......01<
----+----*----+----*----+----*----+----*----+----*----+----*----+----*
71 1988083019880914.........P....P...................!..!................
----+----*----+----*----+----*----+----*----+----*----+----*----+----*
141 ..........................B 

PF1-MENU 2-DBD 3-END 4-NEXT 5-CHILD 6-TWIN 7-UP 8-DOWN 9-PAR 12-ROOT
6. Type INDEX, and press Enter.
The Index screen is displayed (Figure 11-46).
11-30
File-AID Single Install Image Installation and Configuration Guide
Figure 11-46. Index Screen

EDIT --- (PORDR - ORDER
DATA BASE) ------------------------ COLS 00001 00060
COMMAND ===>
SCROLL ===> CUR
LEVEL --SEG-- ----+----1----+----2----+----3----+----4----+----5----+----6
__ 1
ORDR010 AA2222INDUSTRIAL GRADE COAXIAL CORD
CN0001.-.....W
__ 2
ORDR020 ..01POOPEN
C7477ABLACK COAXIAL CABLE
EAWXWWAA222
__
3
ORDR030 01QA.. ... .OKCUTTING
1988021419880306
__
3
ORDR030 04WA........OKGRINDING
19880902
__
3
ORDR030 05WD........OKTRIMMING
1988090819880902
__ 2
ORDR020 .Y02SCOPEN
VV-123METAL FASTENERS
EAAA2222-02
__
3
ORDR030 01QA.. ... .OKCUTTING
1988021419880306
__ 2
ORDR020 ..03WOOPEN
C7777LXTRA LONG COAXIAL CABLE
INEAAA-256S
__ 2
ORDR020 .>04WOCLOSED C33354PLASTIC COATING
OVEA02033BE
__
3
ORDR030 04WD........OKTRIMMING
1988100819881104
__ 2
ORDR040 01C7477ARM....BSBURNT MATERIAL Y19880912
__ 2
ORDR040 02C7477ARM....XSSCRAP
Y19881003
__ 2
ORDR050 CN00010101............19881012
RD8... ..
__ 2
ORDR050 CN00010202............19881012
RD8... ..
__ 1
ORDR010 AA4444HIGH PERFORMANCE COAX
CN0033.....N.H
__ 2
ORDR020 ..01POOPEN
C12223GREY COAX
EAQQRRAA444
__
3
ORDR030 01QA.. ... .OKGRINDING
1988021419880306
__
3
ORDR030 04WA........BDFINISHING
19880902
__
3
ORDR030 05WD........OKTESTING
1988090519880912 
PF1-MENU 2-DBD 3-END 7-UP MAX 8-DOWN 9-PAR 10-LEFT 11-RIGHT 12-ROOT 
Step 5. Exit
Enter =X in the Command field and press Enter to exit File-AID for IMS/CICS. The
message, File-AID for IMS/CICS ENDED is displayed.
Potential Problems Encountered During Installation
• If after “Step 1. Verify Primary Options”, the message DFH2001I INVALID
TRANSACTION IDENTIFICATION IXC - PLEASE RESUBMIT appears:
Verify that the resource definition was done for the transaction code entered.
• If after “Step 1. Verify Primary Options”, the message DFH2206I TRANSACTION IXC
ABEND xxxx. BACKOUT SUCCESSFUL appears:
Refer to IBM’s CICS Messages and Codes Manual to determine the meaning of the four
character abend code (xxxx).
• If File-AID for IMS/CICS abends with message D930:
Verify that all the databases within the PSB are online to CICS and not stopped.
If File-AID abends with an AI status code:
– Verify that the control databases are correctly allocated.
– Verify that the control databases were properly initialized with job JCLALOC.
– Verify that the VSAM buffer subpool has buffers large enough to contain the
control intervals of the control database datasets.
– Verify that the control databases’ dataset names are not restricted from
read/write access by an existing security package.
• If File-AID for IMS/CICS abends with message D942:
Refer to IBM’s CICS Messages and Codes Manual to determine the meaning of the four
character abend code.
• If File-AID for IMS/CICS abends with message D204 after “Step 3. Edit Database
Location”:
Verify that job JCLCLTUP was correctly run.
Verifying File-AID Installation
11-31
The control segment may have been deleted by an external job. Run program
XIXREBLD to reestablish this segment. Refer to “Control Segment Missing or Invalid”
on page 8-26 for more information.
• If File-AID for IMS/CICS abends with the EIB function and return code formatted:
– If message "D933" or "D936" is present, verify that the load module name is
correct, defined in the PPT, and enabled.
– Determine the EIBRCODE meaning by referring to IBM’s CICS Application
Programming Reference manual.
• If a segment layout is not displayed after “Step 4. Select Segment and Format”:
– Verify that JCLCLTUP was correctly run.
– If the database selected was not one of the sample databases, verify that
XRFUPDLI or XRFUPSDB was correctly run for that database.
File-AID for IMS/DC
A short test that uses the File-AID for IMS training files (see Appendix I, “Installing
Training Files”) completes the installation process. Running the test verifies that all
components of File-AID for IMS/DC are loaded properly and that executing File-AID for
IMS/DC produces the expected results.
Note:
The SMP/E Installation, Configuration of PARM modules XVJOPUNV (“Step 2.
Specify File-AID Common Component Parameters” on page 2-7), XVJOPIMS
(“Step 3.2. Specify IMS Environment (Option 2)” on page 2-39), and XVJOPOIX
(“Step 4. Specify File-AID for IMS/DC Product Configuration Parameters” on page
9-14) should be completed before you perform the verification steps.
This chapter provides step-by-step procedures along with screen illustrations and
explanations of common variances to assist you with the verification of the installation
of File-AID for IMS/DC. If you encounter any problems during the verification procedure,
refer to “Potential Problems” on page 11-35. Call a Compuware customer support
representative if you are still unable to solve the problem.
Step 1. Verify Primary Options
1. Log on to IMS to invoke File-AID for IMS/DC.
2. If you installed the MFS formats into the test format library, enter /TEST MFS to
allocate the correct format library.
3. Enter one of the transaction codes installed, preferably one that can access the
sample databases shipped with File-AID. The File-AID for IMS/DC Primary Option
Menu is displayed (Figure 11-47).
11-32
File-AID Single Install Image Installation and Configuration Guide
Figure 11-47. Primary Option Menu
-----------------OPTION ===> 

1 BROWSE 2 EDIT
L LEGAL X EXIT
-
File-AID for IMS/DC PRIMARY OPTION MENU
Display data base contents
Create or change data base contents
Copyright and Trade Secret Information
Terminate File-AID for IMS/DC session


-----------------
RELEASE
CPU ID
TERMINAL
TIME
DATE
-
10.2
323697 
XAS78A01
08:38:01
14-09-26
DBD TO BE USED ===>
(Blank for member list)

-------------------------------------------------------------------------------

Enter your USERID and PASSWORD:

USERID
===>
PASSWORD ===> 




Copyright (c) 1986, 2014, an unpublished work by Compuware Corporation.
All Rights Reserved.
Step 2. Edit DBD
1. Type 2 in the Option field.
2. Press Enter. The DBD Member List screen is displayed (Figure 11-48). The DBDs listed
are the same as those in the PSB associated with the transaction entered in “Step 5a.
Define Environment” on page 3-13.
Figure 11-48. DBD Member List Screen
-------------------------- EDIT - DBD MEMBER LIST ---------------------------
COMMAND ===>
SCROLL ===> CUR


--DBD------DATA BASE DESCRIPTION-----
_ LCUST
LOGICAL CUSTOMER DATA BASE
_ LORDR
LOGICAL ORDER DATA BASE
_ PCUST
PHYSICAL CUSTOMER DATA BASE
_ PORDR
PHYSICAL ORDER DATA BASE
_ PPART
PHYSICAL PART DATA BASE
*** END OF DBD MEMBER LIST *** 












PF1-MENU 3-END 7-UP 8-DOWN
Step 3. Edit Data Base Location
1. Type S next to the PORDR database name that you want to select.
2. Press Enter. The Data Base Location screen is displayed (Figure 11-49).
Verifying File-AID Installation
11-33
Figure 11-49. Data Base Location Screen
--------------------- EDIT - DATA BASE LOCATION ----------------- LINE 00001
COMMAND --->
SCROLL ---> CUR


LINE
KEY
KEY
CMD -----LEVEL----- --SEG--- --DESCRIPTION-- LTH -------------VALUE------------
S_* 1 DBD-PORDR
ORDR010 ORDER ROOT
006 AA2222
__
2
ORDR020 ORDER LINE
002
__
3
ORDR030 ORDER STATUS
002
__
2
ORDR040 ORDER SCRAP
008
__
2
ORDR050 ORDR-CUST LCHLD 002
*** END OF SEGMENT LIST *** 






S -- Select Formatted
K -- Key Spec, then Select Formatted
SU -- Select Unformatted
KU -- Key Spec, then Select Unformatted
SI -- Select Index of Segments
KI -- Key Spec, then Select Indexed 

PF1-MENU 2-DBD 3-END 7-UP 8-DOWN
Step 4. Select Segment and Format
1. Select the first segment on the Data Base Location screen to retrieve the first segment
in the database, and press Enter. The Formatted screen is displayed (Figure 11-50).
Figure 11-50. Formatted Screen
EDIT --- (PORDR - PHYSICAL ORDER DATA BASE) ------------------------ LINE 00001
COMMAND ===>
SCROLL ===> CUR
PAR
SEG ORDR010 ORDER ROOT
CONCAT KEY: AA2222
--------LEVEL NUMBER/DATA-NAME--------- -FORMAT- ---------FIELD VALUE----------
01 ORDER-ROOT-DATA
05 ORDER-ROOT-KEY
07 ORDER-NUMBER-PREFIX
C
2 K AA
07 ORDER-NUMBER
Z
4 K 2222
05 ORDER-DESCRIPTION
C 40
INDUSTRIAL GRADE COAXIAL CABLE
(POS 31-40)
05 CUSTOMER-NUMBER
C
6
CN0001
05 PLANNED-ORDER-QUANTITY
PS 5
500
05 PLANNED-ORDER-AMOUNT
P
5 2 3567.50
05 ORDER-TYPE
C
2
WS
05 ACTUAL-ORDER-QUANTITY
PS 5
INVALD X’404040’
05 TOTAL-SCRAP-QUANTITY
PS 5
10
05 TOTAL-SCRAP-REDEFINES
RDEFINES TOTAL-SCRAP-QUANTITY
C
3
INVALD X’00010C’
05 ORDER-STATUS
Z
2
01
05 FILLER
C
1
<
05 FIRST-ACTIVITY-DATE 

PF1-MENU 2-DBD 3-END 4-NEXT 5-CHILD 6-TWIN 7-UP 8-DOWN 9-PAR 12-ROOT
2. Type UNFMT to display the segment in the unformatted mode, and press Enter. The
Unformatted screen is displayed (Figure 11-51).
11-34
File-AID Single Install Image Installation and Configuration Guide
Figure 11-51. Unformatted Screen
EDIT --- (LORDR - ORDER DB - LOGICAL VIEW) -----------------------------------
COMMAND ===>
SCROLL ===> PAGE
PAR ORDR010 ORDER ROOT
RCD TYP1: PO
SEG ORDR020 ORDER LINE
CONCAT KEY: AA2222,01
SEG LENGTH ===> 178
MIN:50
MAX:200
----+----1----+----2----+----3----+----4----+----5----+----6----+----7 

1 ..01POOPEN
C7477ABLACK COAXIAL CABLE
EAWXWWAA2222-22
ZEN
0BFFDDDDCD444CFFFFCCDCCD4CDCECCD4CCCDC44444444444CCEEEECCFFFF6FF444ECD
0201766755000374771231320361791303123500000000000516766112222022000955
----+----*----+----*----+----*----+----*----+----*----+----*----+----*
71 ITH WIRE
2224 34552
...
CEC4ECDC4444444444444444444FFFF4FFFFF444444444444444444444444444444002
938069950000000000000000000222403455200000000000000000000000000000001C
----+----*----+----*----+----*----+----*----+----*----+----*----+----*
141 ..................ASTC1988090119880904
001000000800000008CEECFFFFFFFFFFFFFFFF
00C01C009C000C009C12331988090119880904 





PF1-MENU 2-DBD 3-END 4-NEXT 5-CHILD 6-TWIN 7-UP 8-DOWN 9-PAR 12-ROOT
3. Type KEY, and press Enter. The Key Specification screen is displayed (Figure 11-52 on
page 11-34).
Figure 11-52. Key Specification Screen
KEY SPEC --- (LORDR - ORDER DB - LOGICAL VIEW) -------- SPECIFY KEY TO RETRIEVE
COMMAND ===>
SCROLL ===> PAGE
SEGMENT TO RETRIEVE: ORDR040 ORDER SCRAP
-------LEVEL NUMBER/DATA-NAME------- -FORMAT- RO ---------FIELD VALUE----------
LVL 1 ORDR010
EQ
05 ORDER-ROOT-KEY
07 ORDER-NUMBER-PREFIX
C
2 K
AA
07 ORDER-NUMBER
Z
4 K
2222
------------------------------------ -------- -- ------------------------------
LVL 2 ORDR040
EQ
05 SCRAP-KEY
07 PROCESS-INDICATOR
C
2 K
01
07 PART-NUMBER
C
6 K
C7477A
********
END OF KEY
******** 






Enter END command when the key value has been fully specified
Enter CANCEL command to terminate Key Specification without processing the key
PF3-END 7-UP 8-DOWN 
4. Type CANCEL, and press Enter. The Unformatted screen is displayed again.
5. Type HEX OFF, and press Enter. The Unformatted/HEX Off screen is displayed (Figure
11-53).
Verifying File-AID Installation
11-35
Figure 11-53. Unformatted/HEX OFF Screen






EDIT --- (PORDR - ORDER
DATA BASE) -----------------------------------------
COMMAND ===>
SCROLL ===> CUR
PAR
SEG ORDR010 ORDER ROOT
CONCAT KEY: AA2222
SEG LENGTH ===> 167
----+----1----+----2----+----3----+----4----+----5----+----6----+----7 
1 AA2222INDUSTRIAL GRADE COAXIAL CORD
CN0001.-.....WS......01<
----+----*----+----*----+----*----+----*----+----*----+----*----+----*
71 1988083019880914.........P....P...................!..!................
----+----*----+----*----+----*----+----*----+----*----+----*----+----*
141 ..........................B 





PF1-MENU 2-DBD 3-END 4-NEXT 5-CHILD 6-TWIN 7-UP 8-DOWN 9-PAR 12-ROOT

6. Type INDEX, and press Enter. The Index screen is displayed (Figure 11-54 on page
11-35).
Figure 11-54. Index Screen
EDIT --- (PORDR - PHYSICAL ORDER DATA BASE) ------------------ COLS 00001 00060
COMMAND ===>
SCROLL ===> CUR
LEVEL --SEG-- ----+----1----+----2----+----3----+----4----+----5----+----6
__ 1
ORDR010 AA4444HIGH PERFORMANCE COAX
CN0033.....n.H
__ 2
ORDR020 ..01POOPEN
C12223GREY COAX
EAQQRRAA444
__
3
ORDR030 01QA.. ... .OKGRINDING
1988021419880306
__
3
ORDR030 04WA........BDFINISHING
19880902
__
3
ORDR030 05WD........OKTESTING
1988090519880912
__ 2
ORDR020 ..02WOOPEN
C44567CEMENTING PROCEDURE
INSFAA4-01D
__ 2
ORDR020 .>04WOOPEN
U224AB2400 BAUD MODEM KIT
OVEA10098SY
__ 2
ORDR020 01C12223RM....BSSCRAP
Y19880912
__ 2
ORDR020 CN00330101............19881012
RD8... .. OVEA02033BE
__ 2
ORDR020 CN00330202............19881012
RD8... ..
__ 1
ORDR010 AA8888TERMINAL ACCESORIES
CN0055.... n.W
__ 2
ORDR020 ..01POOPEN
U248AB4800 BAUD MODEM KIT
EAWXWXAA222
__
3
ORDR030 01QA........OKMILLING CMPLTE 1988021419880306
__
3
ORDR030 04ER........OKPOLISHING
19880902
__
3
ORDR030 05GG........OKPAINTING
1988090819880902
__ 2
ORDR020 ..02POCLOSED C12222BLUE COAX
EATITTAA666
__
3
ORDR030 01WZ........OKPRIMING
1988031419880306
__
3
ORDR030 05RZ........OKFIRMING CMPLTE 1988061219880706
__
3
ORDR030 12QA........OKPOLISHING
1988071219880706 

PF1-MENU 2-DBD 3-END 7-UP MAX 8-DOWN 9-PAR 10-LEFT 11-RIGHT 12-ROOT
Step 5. Exit
Type =X in the Command field and press Enter to exit File-AID. A blank screen is
displayed.
Potential Problems
• If, after “Step 1. Verify Primary Options”, the message NO SUCH TRANSACTION
CODE appears:
– Verify that the Stage 1 system definition was done for the transaction code
entered.
11-36
File-AID Single Install Image Installation and Configuration Guide
– Verify that a space was entered after the transaction code.
• If, after any step, the message REQUESTED BLOCK NOT AVAILABLE appears:
– Verify that /TEST MFS was entered prior to the transaction code if the MFS
modules were linked into the test format libraries.
– Verify that the block name displayed in the message is the same as the MOD
name of the corresponding MFS source member.
– Verify that the logical terminal type is one of those supported by File-AID (Refer
to “MFS Tailoring” on page 9-9).
• If, after “Step 1. Verify Primary Options”, there is no response from the terminal:
– Verify that the IMS transaction queue is not backed up.
– Verify that all the databases within the PSB are online to IMS and not stopped.
– Verify that the class specified on the APPLCTN or TRANSACT macros is proper
for your installation.
– Verify that the PSB size shown on the ACB generation report is within your
installation’s PSB pool size limits.
– Verify that the VSAM buffer subpool has buffers large enough to contain the
control intervals of the control database datasets.
• If File-AID abends with an AI status code:
– Verify that the control databases are correctly allocated.
– Verify that the control databases were properly initialized with job JCLALOC.
– Verify that the control databases’ dataset names are not restricted from
read/write access by an existing security package.
• If File-AID abends with message "D204":
– Verify that job JCLCLTUP was run correctly.
– The control segment may have been deleted by an external job. Run program
XIXREBLD to reestablish this segment. Refer to “Control Segment Missing or
Invalid” on page C-2.
• If, upon entering the Edit Formatted mode, no segment layout is displayed:
– Verify that job JCLCLTUP was correctly run.
– If the database selected was not one of the sample databases, verify that job
XIXOXUPD or XIXOXUPB was correctly run for that database.
• If, after any step, the message TRAN/LTERM STOPPED appears:
– Verify that File-AID did not previously abend.
– Verify that the transaction was not stopped by the MTO.
• If, after entering the KEY or INDEX command, data is missing or truncated or there is
no response from the terminal:
Verify that the IMS large message queue is long enough. Refer to “IMS Message
Queues” on page 1-12 for the required size.
12-1
Chapter 12.
Site Deployment
Chap 12
Overview
This chapter describes various methods to make the File-AID family product libraries
available on your system(s). It covers deployment of the load library modules, in specific,
as well as the CLIST and other libraries. In addition, this chapter provides information on
making modifications for VSAM Space Manager Pool Names or Volume Allocation
(“Modifications for VSAM Space Manager Pool Names or Volume Allocation” on page
12-8) and how to deploy an English as well as a Japanese language instance (“Japanese
and English Interfaces in One Install” on page 12-9) using the same install instance.
Beginning with File-AID 10.1, the allocation techniques using LIBDEF have changed, but
remain compatible with allocation schemes of prior releases. In releases prior to File-AID
10.x, if you selected the “LIBDEF” option, each File-AID product had a configuration step
to customize its own allocation CLIST (such as FADYNALC for File-AID/MVS or
FIDYNALC for File-AID for IMS) based on the dataset names your site provided.
Starting with File-AID 10.1, a single master allocation LIBDEF CLIST called XVJALLOC is
customized when the common XVJOPUNV PARM module is created (if FALIBDEF=Y is
specified, see “FALIBDEF” on page 2-15). While all the classic CLISTs used to access the
individual products are still available (FAMENU, DAMENU, etc.), they have been
modified to call XVJALLOC which will or will not perform file allocation depending on
the setting of FALIBDEF. This should allow your current product launch schemes to still
function properly.
Product Datasets Security Access
All File-AID product datasets require READ access.
The Object Administration VSAM profile dataset (“Object Admin Profile” on page 2-32) is
updated only at Configuration time to include DB2 subsystem information.
The File-AID Relationship file (“Relationship Dsn” on page 2-32) requires WRITE access
for File-AID/RDX or File-AID for DB2 users to update the Relationship file with RI and AR
relationship information.
Step 1 — Add the File-AID Load Library to Your System
The load library, hlq.CPWR.MXVJA20.SXVJLOAD, and the customized load library,
hlq.CPWR.MXVJA20.CXVJLOAD, must be made available to your system for any File-AID
product to be accessible. Below are documented methods that could be used.
Note:
This section is based on the specification of CUSTLIBS=N (see “CUSTLIBS” on
page 2-15) when you created your File-AID Common Component PARM module
(XVJOPUNV). This means you configured your CXVJ libraries separately from
their SXVJ SMP/E generated counterparts. You can use CUSTLIBS=Y which causes
SXVJLOAD, SXVJCLIB and SXVJSENU SMP/E created objects to be copied into
CXVJLOAD, CXVJCLIB and CXVJSENU, respectively, when creating the
XVJOPUNV module and the CXVJ configuration libraries the first time.
CUSTLIBS=Y also causes LIBDEF and STEPLIB processing to ONLY refer to the
named CXVJ versions of LOAD, CLIB and/or SENU SENU and not the SXVJ
12-2
File-AID Single Install Image Installation and Configuration Guide
counterparts. This is handled automatically if you specify CUSTLIBS=Y before
assembling the XVJOPUNV PARM module.
You may merge your SXVJLOAD/CXVJJLOAD, SXVJCLIB/CXVJCLIB and
SXVJSENU/CXVJSENU libraries by hand if you wish to use a single library for
each. If you do this by hand after configuring the XVJOPUNV PARM module,
you must reassemble the XVJOPUNV module with the Configuration Facility
using CUSTLIBS=Y so that batch STEPLIB and LIBDEF processing is set up
correctly. You must also specify your new combined libraries as the
“configuration libraries” when you reassemble using the Configuration Facility
(XVJ$$CFG). If you wish to use CUSTLIBS=Y, the recommended method is to
specify this when first creating your XVJOPUNV PARM module. In this way, the
product libraries will be set up automatically.
Link Pack Area Method:
Compuware recommends placing the programs listed in Table 12-1 in the Link Pack
Area (LPA). This method saves the system from loading a copy of these modules into
each user’s address space which reduces region size required to run these File-AID
products by approximately one-half. The rest of the File-AID modules must be made
available to your system as described in this section.
Notes:
1. The Link Pack Area method requires an IPL.
2. PDSE datasets cannot be in the LPALST concatenation during IPL — You can
add them at the end of IPL (for more information, refer to IBM Redbook
Partitioned Data Set Extended Usage Guide).
3. For use of UDASPF or XFASPF as a TSO command, see also “Link Pack Area
Method Considerations” on page 1-6 and page 1-7.
4. Any load modules added to the Link Pack Area will be used before those in
the LINKLIST but after any in a JOBLIB/STEPLIB or LIBDEF.
Table 12-1. File-AID Programs for Link Pack Area (LPA)
Product
Programs
File-AID/MVS
XFASPF, XVJSPFMN, XVJSPFXE, XVJCOMMN, XVJCATLG, XVJUTLTY, XVJIDCMS
File-AID/Data Solutions
UDASPF, XVJSPFMN, XVJSPFXE, XVJCOMMN, XVJCATLG, XVJUTLTY, XVJIDCMS
File-AID for DB2
F2FADB2
Link List Method:
The File-AID load library, hlq.CPWR.MXVJA20.SXVJLOAD, and the customized load
library, hlq.CPWR.MXVJA20.CXVJLOAD, can be added to your Link List
concatenation.
Notes:
1. The STEPLIB DD for batch jobs generated by File-AID products is based on
the load library definitions in the XVJOPUNV PARM module which is picked
up by skeleton XVJSTEPL. If you use a different load library for LINKLIST,
you may want to create your own copy of XVJSTEPL using that library.
2. The Link List Method requires either an IPL, REFRESH, or equivalent.
Logon Proc or Allocation CLIST method:
The File-AID load library, hlq.CPWR.MXVJA20.SXVJLOAD, and the customized load
library, hlq.CPWR.MXVJA20.CXVJLOAD, can be concatenated to a DD statement in
your logon PROC or Allocation CLIST. If you use this method, your load modules will
be executed specifically from this allocation.
Site Deployment
12-3
Place the File-AID load library in the concatenation of either of the following DD
statements:
– ISPLLIB
– STEPLIB.
See the examples of LOGON PROC, allocation CLIST, and the discussion of CLISTs
XVJALLOC and others in “Step 3 — Make Remaining File-AID Libraries Available”.
LIBDEF Method:
The File-AID load libraries can be dynamically assigned when File-AID is accessed by
using ISPF LIBDEF services. A LIBDEF CLIST called XVJALLOC is created in
CXVJLOAD when FALIBDEF=Y is specified in the PARM module XVJOPUNV (see
“FALIBDEF” on page 2-15).
See the discussion of LIBDEF and ALTLIB allocations in “Step 3 — Make Remaining
File-AID Libraries Available”.
ALTLIB Facility Method:
Compuware has included member XVJRUN in hlq.CPWR.MXVJA20.CXVJCLIB.
XVJRUN is an ALTLIB CLIST and is customized when the XVJOPUNV PARM module
is created by the Configuration Facility.
See the discussion of LIBDEF and ALTLIB allocations in “Step 3 — Make Remaining
File-AID Libraries Available”.
Step 2 — Make File-AID CLISTs Available
The File-AID CLIST libraries, hlq.CPWR.MXVJA20.CXVJCLIB and
hlq.CPWR.MXVJA20.SXVJCLIB (or CXVJCLIV, if using VB CLIST library) should be added
to the SYSPROC concatenation of your logon proc or allocation CLIST, or you may copy
the File-AID CLIST library members to an active CLIST library in your SYSPROC
concatenation.
Note:
If you choose to concatenate the File-AID CLIST library to other libraries in your
SYSPROC concatenation, be sure the record formats (RECFM) are identical.
File-AID creates its CLIST library with RECFM=FB, LRECL=80 by default. 
To create a VB CLIST library with RECFM=VB and LRECL=255 and populate it
with the appropriate members, use the sample JCL provided in
hlq.CPWR.MXVJA20SXVJSAMP(XVJFB2VB).
Step 3 — Make Remaining File-AID Libraries Available
Choose one of the following methods to make the File-AID libraries available:
Change the LOGON PROC:
In addition to the load libraries (SXVJLOAD and CXVJLOAD) and the CLIST libraries
(SXVJCLIB and CXVJCLIB1), all other File-AID libraries must be made available to
ISPF. When running File-AID under TSO, concatenate the new File-AID libraries to
the ISPF libraries in the ISPF logon PROC as follows:
1. or CXVJCLIV if using a combined variable blocked CLIST, see Note for “CPWR.MXVJA20.CXVJCLIB” on page 2-12.
12-4
File-AID Single Install Image Installation and Configuration Guide
hlq.CPWR.MXVJA20.CXVJLOAD
hlq.CPWR.MXVJA20.SXVJLOAD
hlq.CPWR.MXVJA20.CXVJCLIB
hlq.CPWR.MXVJA20.SXVJCLIB
hlq.CPWR.MXVJA20.SXVJMENU
hlq.CPWR.MXVJA20.SXVJPENU
hlq.CPWR.MXVJA20.CXVJSENU
hlq.CPWR.MXVJA20.SXVJSENU
hlq.CPWR.MXVJA20.SXVJTENU
to
to
to
to
to
to
to
to
to
STEPLIB
STEPLIB
SYSPROC
SYSPROC
ISPMLIB
ISPPLIB
ISPSLIB
ISPSLIB
ISPTLIB
DD
DD
DD (or CXVJCLIV for VB CLIST)
DD 
DD
DD
DD
DD
DD
Figure 12-1. TSO LOGON PROC Example
//TSOUSER
//
//STEPLIB
//
//
//SYSPROC
//
//ISPMLIB
//
//ISPPLIB
//
//ISPSLIB
//
//
//ISPTLIB
//
//SYSHELP
//SYSLBC
//SYSPRINT
//SYSTERM
//SYSIN
EXEC
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
DD
PGM=IKJEFT01,DYNAMNBR=25,PARM='EX (LOGON)',
TIME=10
DSN=ISP.VnRnM0.LOAD,DISP=SHR
DSN=hlq.CPWR.MXVJA20.CXVJLOAD,DISP=SHR
DSN=hlq.CPWR.MXVJA20.SXVJLOAD,DISP=SHR
DSN=hlq.CPWR.MXVJA20.CXVJCLIB,DISP=SHR
DSN=hlq.CPWR.MXVJA20.SXVJCLIB,DISP=SHR
DSN=ISP.VnRnM0.MLIB,DISP=SHR
DSN=hlq.CPWR.MXVJA20.SXVJMENU,DISP=SHR
DSN=ISP.VnRnM0.PLIB,DISP=SHR
DSN=hlq.CPWR.MXVJA20.SXVJPENU,DISP=SHR
DSN=ISP.VnRnM0.SLIB,DISP=SHR
DSN=hlq.CPWR.MXVJA20.CXVJSENU,DISP=SHR
DSN=hlq.CPWR.MXVJA20.SXVJSENU,DISP=SHR
DSN=ISP.VnRnM0.TLIB,DISP=SHR
DSN=hlq.CPWR.MXVJA20.SXVJTENU,DISP=SHR
DSN=SYS1.HELP,DISP=SHR
DSN=SYS1.BRODCAST,DISP=SHR
TERM=TS,SYSOUT=*
TERM=TS,SYSOUT=*
TERM=TS 
Set up Allocation CLIST Method:
In addition to the load library (SXVJLOAD) and the CLIST library (SXVJCLIB or
CXVJCLIV, if using VB CLIST library), all other File-AID libraries must be made
available to ISPF.
You can create a CLIST to be executed from the TSO “READY” prompt, or as an initial
logon command. This CLIST must be placed in a CLIST library allocated to SYSPROC
in your logon proc. You may call the CLIST anything you like - for example:
ALLOCDA.
This technique requires that individuals wishing to use File-AID must know the name
of your allocation CLIST and how to execute it (READY prompt or initial command).
Concatenate the new File-AID libraries to the ISPF libraries in the allocation CLIST as
follows:
hlq.CPWR.MXVJA20.CXVJLOAD
hlq.CPWR.MXVJA20.SXVJLOAD
hlq.CPWR.MXVJA20.CXVJCLIB
hlq.CPWR.MXVJA20.SXVJCLIB
hlq.CPWR.MXVJA20.SXVJMENU
hlq.CPWR.MXVJA20.SXVJPENU
hlq.CPWR.MXVJA20.CXVJSENU
hlq.CPWR.MXVJA20.SXVJSENU
hlq.CPWR.MXVJA20.SXVJTENU
to
to
to
to
to
to
to
to
to
ISPLLIB
ISPLLIB
SYSPROC
SYSPROC
ISPMLIB
ISPPLIB
ISPSLIB
ISPSLIB
ISPTLIB
or STEPLIB DD
or STEPLIB DD
DD (or CXVJCLIV for VB CLIST)
DD 
DD
DD
DD
DD
DD
Figure 12-2 and Figure 12-3 are examples of CLISTs you can create to allocate
File-AID.
Site Deployment
12-5
Figure 12-2. Allocation CLIST Example 1. When TSO STEPLIB command is available
PROC 0
FREE FI(ISPMLIB ISPPLIB ISPSLIB ISPTLIB SYSPROC)
STEPLIB (’ISP.VnRnM0.LOAD’ ’hlq.CPWR.MXVJA20.CXVJLOAD’ +
’hlq.CPWR.MXVJA20.SXVJLOAD’) SHR
ALLOC FI(SYSPROC) DA(’hlq.CPWR.MXVJA20.CXVJCLIB’ +
’hlq.CPWR.MXVJA20.SXVJCLIB’) SHR
ALLOC FI(ISPMLIB) DA(’ISP.VnRnM0.MLIB’ ’hlq.CPWR.MXVJA20.SXVJMENU’) SHR
ALLOC FI(ISPPLIB) DA(’ISP.VnRnM0.PLIB’ ’hlq.CPWR.MXVJA20.SXVJPENU’) SHR
ALLOC FI(ISPSLIB) DA(’ISP.VnRnM0.SLIB’ ’hlq.CPWR.MXVJA20.CXVJSENU’ +
’hlq.CPWR.MXVJA20.SXVJSENU’) SHR
ALLOC FI(ISPTLIB) DA(’ISP.VnRnM0.TLIB’ ’hlq.CPWR.MXVJA20.SXVJTENU’) SHR
Figure 12-3. Allocation CLIST Example 2. When TSO STEPLIB command is not available.
PROC 0
FREE FI(ISPLLIB ISPPLIB ISPMLIB ISPSLIB ISPTLIB SYSPROC)
ALLOC FI(ISPLLIB) DA(’ISP.VnRnM0.LOAD’ ’hlq.CPWR.MXVJA20.CXVJLOAD’ +
’hlq.CPWR.MXVJA20.SXVJLOAD’) SHR
ALLOC FI(ISPPLIB) DA(’ISP.VnRnM0.PLIB’ ’hlq.CPWR.MXVJA20.SXVJPENU’) SHR
ALLOC FI(ISPMLIB) DA(’ISP.VnRnM0.MLIB’ ’hlq.CPWR.MXVJA20.SXVJMENU’) SHR
ALLOC FI(ISPSLIB) DA(’ISP.VnRnM0.SLIB’ ’hlq.CPWR.MXVJA20.CXVJSENU’ + 
’hlq.CPWR.MXVJA20.SXVJSENU’) SHR
ALLOC FI(ISPTLIB) DA(’ISP.VnRnM0.TLIB’ ’hlq.CPWR.MXVJA20.SXVJTENU’) SHR
ALLOC FI(SYSPROC) DA(’hlq.CPWR.MXVJA20.CXVJCLIB’ + 
’hlq.CPWR.MXVJA20.SXVJCLIB’) SHR
LIBDEF Method:
The File-AID libraries can be dynamically assigned when File-AID is accessed by using
ISPF LIBDEF services. LIBDEF CLIST XVJALLOC is customized by the Configuration
Facility when the XVJOPUNV module is created. All of the classic File-AID product
CLISTs (e.g., FAMENU, FIMENU, F1, F2, etc.) have been updated to use XVJALLOC.
The CLIST library containing XVJALLOC and the classic File-AID family of CLISTs
must be allocated to SYSPROC (via some method) to use the XVJALLOC LIBDEF.
Note:
This is achieved by using Configuration Facility option 1.2 to set the
parameter variable “FALIBDEF” to Yes (see “FALIBDEF” on page 2-15).
ALTLIB Facility Method:
The ALTLIB CLIST called XVJRUN launches File-AID 10.2 products using the ALTLIB
facility to allocate the CLIST library or libraries, which in turn calls XVJALLOC to
allocate the remaining libraries. XVJRUN and XVJALLOC are customized when the
XVJOPUNV PARM module is created via the Configuration Facility using the
specified datasets. It can be executed from the user’s SYSPROC concatenation or
directly from the dataset it is in (usually CXVJCLIB). XVJRUN allocates the
customized CLIST library and then calls XVJALLOC to allocate the remaining
libraries and launch the File-AID products.
Note:
If FALIBDEF=N (see “FALIBDEF” on page 2-15) is specified when you
generated your XVJOPUNV XVJRUN is still customized with the specified
CLIST library name(s) but XVJALLOC will not allocate the additional
libraries. FALIBDEF=N means the user is providing Library allocation via
another method (JCL PROC or other CLIST).
12-6
File-AID Single Install Image Installation and Configuration Guide
Figure 12-4. CLIST Member XVJRUN
PROC 0 PRODID( )


ALTLIB ACTIVATE APPLICATION(CLIST) +

DSNAME('hlq.CPWR.MXVJA20.CXVJCLIB' +
'hlq.CPWR.MXVJA20.SXVJCLIB') 
IF &PRODID = &Z THEN 
ISPEXEC SELECT CMD(XVJALLOC)

ELSE 
ISPEXEC SELECT CMD(XVJALLOC PRODID(&PRODID))

ISPEXEC CONTROL ERRORS RETURN

ISPEXEC SELECT CMD(XVJFREE)


ALTLIB DEACTIVATE APPLICATION(CLIST)


END
When a valid PRODID() parameter is specified (e.g. XVJRUN PRODID(XFA)), the
specified product will be launched. Without a valid PRODID() parameter, it posts a
menu of all products (Figure 12-6 on page 12-8). Table 12-2 lists valid PRODID()
parameters.
Table 12-2.Prodids for File-AID products
Product
PRODID
File-AID/MVS
XFA
File-AID/Data Solutions
UDA
File-AID/RDX
XFR
File-AID for DB2
XFD
File-AID for IMS/ISPF
XIX
Site Deployment
12-7
Starting File-AID from ISPF/PDF Primary Panel
(Optional)
If you were a customer of a File-AID product (or products) prior to Release 10, Figure 12-5
on page 12-7 shows a partial sample of how you might have connected one or more
products to your ISR@PRIM panel in the past.
These same CLISTs are still supported as long as the Release 10 CLIST libraries
(SXVJCLIB/CXVJCLIB) are allocated to SYSPROC. The LIBDEF rules apply the same in
Release 10 as they did in prior releases. You either configure with FALIBDEF=Y (see
“FALIBDEF” on page 2-15) or you provide allocation of the additional File-AID libraries
(load, panels, messages, etc.) with DD CARDs in your PROC or other techniques of your
own design. Some prior File-AID products provided ALTLIB techniques. Some customers
built their own ALTLIBs. When modified to point to the correct Release 10 CLIST
libraries, these should continue to function properly.
Figure 12-5. ISR@PRIM Panel
%----------------------- ISPF/PDF PRIMARY OPTION MENU ------------------------
%OPTION ===>_ZCMD
+
%
+USERID
- &ZUSER 
‘
‘ [snip]
‘
% DA +DA SOLUTIONS- Data management tool

%
F +FILE-AID
- Data handling utility

% FD +File-AID/DB2- File-AID for DB2

% FI +File-AID/IMS- File-AID for IMS/ISPF


% FR +File-AID/RDX- File-AID/Related Data XPERT
‘
‘ [snip]
‘
DA,’CMD(%DAMENU) NOCHECK’

F,'CMD(%FAMENU) NOCHECK'

FD,’CMD(%F2RUNFDB) NOCHECK’

FI,’CMD(%FIMENU) NOCHECK’

FR,’CMD(%RDXMENU) NOCHECK’

‘
‘ [snip]
‘
)END
New Connection Techniques With Release 10
File-AID Release 10 introduced a new ALTLIB CLIST called XVJRUN. When properly
configured, it can be used to launch a File-AID sub-menu or an individual product
directly. When configured with FALIBDEF=Y (see “FALIBDEF” on page 2-15), XVJRUN
does not need any additional File-AID libraries to be preallocated (ISPLLIB, ISPPLIB, etc.).
Since XVJRUN is an ALTLIB CLIST, the CLIST library does not need to be preallocated to
SYSPROC for XVJRUN to function properly. Using the ISR@PRIM example above, your
individual product connections could be done using XVJRUN:
DA,’CMD(%XVJRUN PRODID(UDA) NOCHECK’
F,'CMD(%XVJRUN PRODID(XFA)) NOCHECK'
FD,’CMD(%XVJRUN PRODID(XFD)) NOCHECK’
FI,’CMD(%XVJRUN PRODID(XIX)) NOCHECK’
FR,’CMD(%XVJRUN PRODID(XFR)) NOCHECK’
/* File-AID/Data Solutions */
/* File-AID/MVS */
/ File-AID for DB2 */
/* File-AID for IMS/ISPF */
/* File-AID/RDX */
Additionally, the five individual product connections could be replaced with a single
invocation of XVJRUN. This would launch a File-AID sub-menu of all products Figure 126 on page 12-8 (obviously you can only successfully use the products you are licensed
for).
12-8
File-AID Single Install Image Installation and Configuration Guide
FA,’CMD(%XVJRUN) NOCHECK’
/* File-AID (sub-menu)*/ 
Figure 12-6. Start Products Menu
File-AID -------------OPTION ===>
Start Component/s
----------------------------------


Select File-AID Component to Verify Installation:


1 File-AID/MVS 

2 File-AID/Data Solutions


3 File-AID/RDX


4 File-AID for DB2


5 File-AID for IMS/ISPF


CA Librarian and/or CA Panvalet Libraries
When either of the parameter variables CALIB or CAPAN is set to Y (see “CALIB” on page
2-22 or “CAPAN” on page 2-22), the CA Librarian or CA Panvalet load libraries must be
accessible for a File-AID non-directed load. Use your site preferred method to make them
accessible.
Modifications for VSAM Space Manager Pool Names or
Volume Allocation
If your installation has VSAM Space Manager or Sterling Software’s Volume Allocation
Manager (VAM) and wants to allow allocation of VSAM clusters by pool name, modify
File-AID/Data Solutions panels UDAMU35A, UDAMU35G, UDAMU35H, and UDAMU35X
and File-AID/MVS panels XFAMU35A, XFAMU35G, XFAMU35H, and XFAMU35X by
following the instructions in the PROC section of the panels. Uncomment the necessary
statements and add the specified pool names.
Site Deployment
12-9
Japanese and English Interfaces in One Install
When your site wants to deploy an English as well as a Japanese language instance for
File-AID using the same SMP/E libraries (or a copy thereof), follow this procedure:
1. During the SMP/E installation specify Japanese language support:
a. Enter "Y" to the “Install Japanese components?” prompt (refer to “Step 8. Specify
Target and Distribution Zone Information” on page 2-10 or “Step 7. Specify
Target and Distribution Zone Information” on page B-9 in the Compuware Installer
Mainframe Products SMP/E Installation Guide).
OR if you perform the SMP/E installation from the File-AID EP media:
b. Check the Japanese Support box (refer to “Select Items for Upload” on page A-3
in the Compuware Installer Mainframe Products SMP/E Installation Guide).
This will include the Japanese Language SMP/E datasets for MESSAGES, PANELS and
SKELETONS when you complete the SMP/E installation.
Note:
You can optionally copy a complete and unique set of SMP/E target libraries
for your two language environment and configure them independently.
2. During product configuration, create two sets of configuration PARM modules (one
for English and one for Japanese):
a. EX "XVJ$$CFG" from your SXVJSAMP (“Step 1. Execute the File-AID
Configuration CLIST” on page 2-3), for example:
TSO EX 'hlq.CPWR.MXVJA20.SXVJSAMP(XVJ$$CFG)'
b. Select Option 1, File-AID Common Component (“Step 2. Specify File-AID
Common Component Parameters” on page 2-7)
English Configuration
c. Select Option 1, DATASETS (“Step 2.1 Specify Configuration Module Dataset
Names” on page 2-10)
d. Enter Configuration Module Dataset name for LOAD, CLIST, and Skeleton library
dataset names:
1. Load Library Configuration Module Dataset, for English for example:
hlq.CXVJLENG
2. CLIST Configuration Module Dataset, for English for example:
hlq.CXVJCENG
3. Skeleton Configuration Module Dataset, for English for example:
hlq.CXVJSENG
e. Select Option 2, SPECIFY PARMS (“Step 2.2 Specify Product Configuration
Parameters” on page 2-14)
f. Set DBCSSUP to N for English (“DBCSSUP” on page 2-20). This causes the
allocation CLISTs to be created using the English Language Datasets.
g. Submit the JCL to create the English Configuration Module XVJOPUNV
Japanese Configuration
h. Select Option 1, DATASETS (“Step 2.1 Specify Configuration Module Dataset
Names” on page 2-10)
12-10
File-AID Single Install Image Installation and Configuration Guide
i. Enter Configuration Module Dataset name for LOAD, CLIST, and Skeleton library
dataset names:
1. Load Library Configuration Module Dataset, for Japanese for example:
hlq.CXVJLJPN
2. CLIST Configuration Module Dataset, for Japanese for example:
hlq.CXVJCJPN
3. Skeleton Configuration Module Dataset, for Japanese for example:
hlq.CXVJSJPN
j. Enter/confirm the optional Japanese Language SMP/E datasets for MESSAGES,
PANELS and SKELETONS:
hlq.SXVJMJPN
hlq.SXVJPJPN
hlq.SXVJSJPN
k. Select Option 2, SPECIFY PARMS (“Step 2.2 Specify Product Configuration
Parameters” on page 2-14)
l. Set DBCSSUP to Y for Japanese (“DBCSSUP” on page 2-20). This causes the
allocation CLISTs to be created using the Japanese Language Datasets.
m. Submit the JCL to create the Japanese Configuration Module XVJOPUNV.
If you did not specify valid names of your Japanese SMP/E target datasets
previously, then you will be prompted to supply them (see Figure 2-9 on page
2-26).
3. To run English, execute XVJRUN from your English CLIST library (hlq.CXVJCENG)
4. To run Japanese, execute XVJRUN from your Japanese CLIST library ( hlq.CXVJCJPN)
A-1
Appendix A.
File-AID/MVS Exits
Appendix A.
A
This chapter describes the following File-AID/MVS exits:
• “File-AID Security Exit”
• “Audit Trail Exit”
• “I/O Exit”.
File-AID is shipped with sample exits. The sample exits are functionally inert unless you
modify them. The default audit exit is automatically linked when you install File-AID. If
you modify it after installation, you need to compile and relink it using the appropriate
JCL (see Table A-5 on page A-7).
Note:
As of Release 9.4, all exits must be compiled and linked with
AMODE(31),RMODE(24).
File-AID allows exits written in COBOL, PL/I, and Assembler in compilers that are
covered by Compuware’s support policy. It is highly recommended that all exits be
written in compilers and assemblers that are currently supported by their suppliers.
Security and I/O exits are not automatically linked at installation time. Use the
appropriate JCL listed in Table A-3 on page A-2 or Table A-8 on page A-13 to install these
File-AID user exits.
If you intend to use your own I/O, Security, and/or Audit exit with the File-AID Eclipse,
make sure they are included in the customized CXVJLOAD load library.
Note:
Exit routines must be assembled or compiled and then link-edited to a library in
the system search order (that is, a library searched when the load macro is
issued).
File-AID Security Exit
The File-AID security exit enables you to control access to datasets, including dataset
inclusion and exclusion, and processing features. The File-AID security exit is not
intended to replace any security package that is presently installed at your site.
The File-AID security exit, FASCRXIT, is called from the following points within File-AID:
• Prior to allocating each dataset for use
• Prior to opening each dataset
• Prior to processing a member.
The security exit returns an indicator and a message to File-AID. The indicator tells
File-AID to do one of the following:
• Permit the request
• Permit the request but with altered parameters
• Refuse the request.
The message is a standard default message or the message indicated by your user exit
parameters.
A-2
File-AID Single Install Image Installation and Configuration Guide
Allocation Function Call
The dataset allocation call is designated by an A request type to the security exit. You
may want to use the A exit type for the following purposes:
• Limit File-AID function access by user ID
• To limit access to a certain dataset.
Open Function Call
The dataset open call is designated by an O request type to the security exit. You may
want to use the O exit call for the following purposes:
• To prevent a certain dataset from being updated
• To prevent a certain member of a PDS from being accessed, updated, renamed, or
deleted.
Installing The File-AID Security Exit
File-AID allows exits written in COBOL, PL/I, and Assembler in compilers that are
covered by Compuware’s support policy. It is highly recommended that all exits be
written in compilers and assemblers that are currently supported by their suppliers.
Note:
The security exit should be reentrant.
The File-AID sample dataset (hlq.CPWR.MXVJA20.SXVJSAMP) provides sample security
exits in Assembler, COBOL, and PL/I, and the JCL to compile and link-edit the exit, as
shown in Table A-3.
Table A-3.
Sample Security Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
XFASXASM
XFALKSXA
Assembler security exit
XFASXCOB
XFALKSXC
COBOL security exit
XFASXPLI
XFALKSXP
PL/I security exit
Additional instructions on modifying the File-AID security exit are included in the exit
source members (XFASXASM, XFASXCOB, XFASXPLI) for the FASCRXIT security exit.
Note:
The security exit must be named FASCRXIT.
Debugging Your Security Exit
A tool is provided with File-AID to help you test and debug your security exit. To activate
the Exit Debugger, allocate the FAEXITDD DDNAME to your ISPF session or batch job.
You can allocate this DDNAME to return information to an external file you create with
the dataset requirements of RECFM=FB and LRECL=384.
When the Exit Debugger is activated, all parameters being passed to and from the
security exit for each call type are reported to the allocated DD.
To de-activate the Exit Debugger, simply FREE the FAEXITDD DDNAME.
Security Exit Parameter Layouts
The security exit is passed two addresses. The first address points to the security exit
parameters list which is described in Table A-4. The second address points to the job
accounting information.
File-AID/MVS Exits
A-3
Input Parms
Table A-4.
Security Exit Input Parms Layout
Description
Position
Len
Format
Values
EXIT CALL TYPE
1
1
CHAR
A Allocation
O Open
FUNCTION NUMBER
2
1
CHAR
For Online:
1 Browse
2 Edit
3 Utilities
5 Print
6 Edit selection criteria
7 Edit XREF
8 View record layout
9 Reformat
P Compare
For Batch:
1 LIST, PRINT, DUMP, COMPARE,
etc. (Browse functions)
2 UPDATE, UPDATEALL, etc.
(Edit functions)
3 COPY, DROP, USER, etc.
(Utilities functions)
5 XMLGEN
9 Reformat
SUB-FUNCTION NUMBER
3
1
CHAR
For Utilities:
1 Library
2 Dataset
3 Copy
4 Catalog
5 VSAM
6 Search/Update
7 VTOC
8 Interactive
9 Batch submit
G XMLGEN
For Print:
D Dataset
X XREF
S Selection criteria
L Record layout
A Audit trail
PANEL OPTION/LINE
COMMAND
4
1
CHAR
LOGON IDENTIFIER
5
8
CHAR
EXECUTION TYPE
13
1
CHAR
B Batch
O Online
FILE TYPE
14
1
CHAR
D
F
S
C
O
A
Data file
XREF
Selection criteria
Record layout
Output PDS
Audit file
A-4
File-AID Single Install Image Installation and Configuration Guide
Table A-4.
Security Exit Input Parms Layout (Continued)
Position
Len
Format
FILE ORGANIZATION
Description
15
2
CHAR
Values
AM VSAM
DA BDAM
LB Librarian
PN Panvalet
PO Partitioned
PS Sequential
RECORD FORMAT OF FILE
17
2
CHAR
F
FB
V
VB
U
ACCESS INTENT
19
1
CHAR
Y Open for read only.
N Open for update.
File-AID VERSION
20
5
CHAR
Version number of File-AID in use
(i.e. 10.02).
ALLOCATION TYPE
25
1
CHAR
Y Dataset has been allocated
within a batch job via a DD
statement.
N Dataset will be allocated
online dynamically.
USER
29
4
ADDR
User exit can store any address
here and it is saved for the
following calls.
ACCOUNT
33
4
ADDR
Pointer to user accounting
information.
Fixed
Fixed blocked
Variable
Variable blocked
Undefined
*** VARIABLE PORTION OF THE INTERFACE ***
See the Parameter List Description in the sample security exit
for more information on the variables.
NAME 1 SET
37
1
CHAR
Y Set
N Not set
NAME 1 MODIFIED
38
1
CHAR
Y Modifiable
N Not modifiable
NAME 1 VALUE
39
56
CHAR
NAME 2 SET
95
1
CHAR
Y Set
N Not set
NAME 2 MODIFIED
96
1
CHAR
Y Modifiable
N Not modifiable
NAME 2 VALUE
97
56
CHAR
NAME 3 SET
153
1
CHAR
Y Set
N Not set
NAME 3 MODIFIED
154
1
CHAR
Y Modifiable
N Not modifiable
NAME 3 VALUE
155
56
CHAR
NAME 4 SET
211
1
CHAR
Y Set
N Not set
NAME 4 MODIFIED
212
1
CHAR
Y Modifiable
N Not modifiable
NAME 4 VALUE
213
56
CHAR
NAME 5 SET
269
1
CHAR
Y Set
N Not set
File-AID/MVS Exits
Table A-4.
A-5
Security Exit Input Parms Layout (Continued)
Position
Len
Format
NAME 5 MODIFIED
Description
270
1
CHAR
Values
NAME 5 VALUE
271
56
CHAR
VOLSER 1 SET
327
1
CHAR
Y Set
N Not set
VOLSER 1 MODIFIED
328
1
CHAR
Y Modifiable
N Not modifiable
VOLSER 1 VALUE
329
6
CHAR
VOLSER 2 SET
335
1
CHAR
Y Set
N Not set
VOLSER 2 MODIFIED
336
1
CHAR
Y Modifiable
N Not modifiable
VOLSER 2 VALUE
337
6
CHAR
PASSWORD 1 SET
343
1
CHAR
Y Set
N Not set
PASSWORD 1 MODIFIED
344
1
CHAR
Y Modifiable
N Not modifiable
PASSWORD 1 VALUE
345
8
CHAR
PASSWORD 2 SET
353
1
CHAR
Y Set
N Not set
PASSWORD 2 MODIFIED
354
1
CHAR
Y Modifiable
N Not modifiable
PASSWORD 2 VALUE
355
8
CHAR
OPTION 1 SET
363
1
CHAR
Y Set
N Not set
OPTION 1 MODIFIED
364
1
CHAR
Y Modifiable
N Not modifiable
OPTION 1 VALUE
365
1
CHAR
OPTION 2 SET
366
1
CHAR
Y Set
N Not set
OPTION 2 MODIFIED
367
1
CHAR
Y Modifiable
N Not modifiable
OPTION 2 VALUE
368
3
CHAR
OPTION 3 SET
371
1
CHAR
Y Set
N Not set
OPTION 3 MODIFIED
372
1
CHAR
Y Modifiable
N Not modifiable
OPTION 3 VALUE
373
2
CHAR
END OF VARIABLES
375
2
CHAR
END DELIMITER
FEEDBACK OF USER EXIT
376
1
CHAR
Y Allow request with no
changes.
M Allow request with changes.
N Request rejected.
MESSAGE ID
377
8
CHAR
Message identifier.
Y Modifiable
N Not modifiable
A-6
File-AID Single Install Image Installation and Configuration Guide
Audit Trail Exit
The File-AID audit trail exit, XFAAUAXA, is linked into load module XFAAUAXF and
called dynamically after allocating the input dataset for Browse, Edit, and the
Search/Update utility. The default audit trail exit, shipped with File-AID, immediately
returns control to the calling function.
Note:
If you plan on using a custom audit trail exit from a File-AID release prior to
Release 9.4, you must copy, then rename the load module to XFAAUAXF.
The audit trail exit can be used for the following purposes:
• To force the creation of an audit trail for a specific dataset, group of datasets, and/or
group of users.
• To force automatic printing of the audit trail report and specify whether to retain the
audit trail dataset after printing.
• To override the audit trail dataset name that is constructed by File-AID.
Note:
The audit trail dataset name must be unique. Each time the audit trail is used
File-AID generates a new dataset name. Compuware recommends employing
the date and time stamp as part of this dataset name.
When auditing is requested, File-AID allocates the audit trail dataset dynamically. If
you’re using batch, the TSO-ID is interpreted as the JOB NAME minus one character,
which means the TSO-ID part of the batch job name is actually included as the first
qualifier in the audit dataset name. If this is not acceptable, there is an Audit file
prefix parameter that allows you to replace part of the default audit file dataset name
up to a total length of 23 characters. This is described under “Audit File Prefix
Parameter” on page 4-9 in File-AID/MVS Batch Reference manual.
If your TSO prefix matches your user ID, the audit trail dataset name is:
TSO-ID.FILEAID.AUDT.Dyymmdd.Thhmmss.Msss
TSO-ID
TSO user ID, up to seven characters.
Dyymmdd
Gregorian date on which the audit trail is created.
Thhmmss
Hour, Minute, and second the audit trail is created.
Msss
Millisecond the audit trail is created.
TSO-prefix
TSO user prefix, up to seven characters.
If your TSO-prefix does not match your user ID and the audit dataset name does
not exceed 44 characters, the audit trail dataset name is:
TSO-prefix.TSO-ID.FILEAID.AUDT.Dyymmdd.Thhmmss.Msss 
When the TSO-prefix is included and the construction of the audit dataset name
exceeds 44 characters, then millisecond will be omitted. For example, if you had
a 4 character tso-prefix and a 5 character tso-id, millisecond would be included. If
you had a 4 character tso-prefix and a 7 character tso-id, millisecond would be
omitted.
TSO-prefix.TSO-ID.FILEAID.AUDT.Dyymmdd.Thhmmss
• To implement the optional File-AID SMF recording function.
The audit trail exit is called from browse for the purpose of checking the optional
SMF recording function (file access recording). File-AID does not currently support
audit reporting from SMF.
Note:
Non reentrant load modules can reside in a APF library. However, if a load
module is marked by the linkage editor as reentrant, then it must actually be
reentrant if it resides in an APF library.
File-AID/MVS Exits
A-7
The audit trail exit parameter list is described in “Audit Exit Parameter Layouts” on page
A-7. All fields in the parameter list are prefilled with a necessary process value or default
value. Any field in the audit trail exit can be modified. Security parameters and fields
unrelated to the audit trail process are ignored by File-AID when processing the audit
trail.
Notes:
• The audit exit should be reentrant.
• Do not use any run-time compiler debugging options when compiling a COBOL
audit exit.
Installing the Audit Exit
The File-AID sample library (hlq.CPWR.MXVJA20.SXVJSAMP) provides sample audit trail
exits in Assembler, COBOL, PL/I, and provides JCL to compile and link-edit the exit, as
shown in Table A-5. In addition, the sample library contains a sample dynamic SMF user
exit in Assembler and the corresponding JCL. See “SMF Recording Function” on page
A-15 for more information.
Table A-5.
Sample Audit Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
XFAAUAXA
XFALKAUA
Assembler sample audit exit
XFAAUAXC
XFALKAUC
COBOL sample audit exit
XFAAUAXP
XFALKAUP
PL/I sample audit exit
XFASMFUX
XFALKSMF
Assembler sample dynamic SMF
user exit
Audit Exit Parameter Layouts
Input Parms
Table A-6.
Audit Exit Input Parms Layout
Description
EXIT TYPE
Position
Len
Format
1
1
CHAR
Values
R : Audit Trail Allocation
USER ID
2
7
CHAR
TSO Userid
FUNCTION NUMBER
9
1
CHAR
1 : Browse
2 : Edit
3 : Search/Update utility
ONLINE/BATCH INDICATOR
10
1
CHAR
O : Online operation
File-AID VERSION
11
5
CHAR
Version number of File-AID
in use (i.e. 10.02).
B : Batch operation
FILE TYPE
16
1
CHAR
D : Data file dataset
FULLY QUALIFIED DSN
17
44
CHAR
Edit DSN without quotes
and including TSO prefix if
appropriate.
DATASET ORGANIZATION
61
2
CHAR
AM : VSAM dataset
DA : BDAM dataset
PO : Partitioned dataset
PS : Sequential dataset.
A-8
File-AID Single Install Image Installation and Configuration Guide
Table A-6.
Audit Exit Input Parms Layout
Position
Len
Format
VOLUME SERIAL
Description
63
6
CHAR
The volume serial number of
the disk or tape that contains
the dataset.
Values
PASSWORD
69
8
CHAR
The password for OS
password protected
datasets.
READ ONLY INDICATOR
77
1
CHAR
Y : Read-only
N : Update.
INPUT/OUTPUT PARMS - EXIT TYPE R
Table A-7.
Audit Exit Input/Output Parms Exit Type R Layout
Description
Position
Len
Format
Values
AUDIT TRAIL DSN
87
46
CHAR
Audit Trail DSN to be
allocated, with quotes and
including TSO prefix if
appropriate.
SLIB MEMBER NAME
133
8
CHAR
Default is FAJCAUDR. You
can override with a different
SLIB member.
CREATE AUDIT TRAIL INDICATOR 141
1
CHAR
Input value is the value from
the Edit - Dataset
Specification or
Search/Update screen. You
can override with one of the
following:
Y -- Create an audit trail.
N -- Do not create an audit
trail.
FORCE PRINT INDICATOR
142
1
CHAR
N -- Default; does not force
printing of the audit trail
dataset.
K -- Forces printing and
keeps the audit trail report.
D -- Forces printing and
deletes the audit trail
dataset.
Any other value in this
position keeps the audit trail
without printing.
SMF USER EXIT NAME
143
8
CHAR
Default is spaces for dynamic
SMF user exit program
name.
SMF RECORD CODE
151
3
CHAR
Default is 170 for SMF
record code.
CREATE SMF RECORDS FOR
BROWSE
154
1
CHAR
N -- Default; does not create
SMF records for browse.
Y -- Creates SMF records for
browse.
CREATE SMF RECORDS FOR EDIT 155
1
CHAR
N -- Default; does not create
SMF records for edit.
Y -- Creates SMF records for
edit.
File-AID/MVS Exits
Table A-7.
A-9
Audit Exit Input/Output Parms Exit Type R Layout (Continued)
Description
Position
Len
Format
Values
CREATE SMF ACCESS RECORDS
156
1
CHAR
The access record is always
created when a file is edited
and the CREATE SMF
RECORDS FOR EDIT flag is Y,
even if this flag is set to N.
N -- Default; does not create
SMF access record.
Y -- Creates SMF access
record.
CREATE SMF FIELD UPDATE
RECORDS
157
1
CHAR
Note: If all three of the
FIELD UPDATE record
indicators fields are Y (at
positions 157, 158, and
159), comprehensive
update records are created
for any added or deleted
records even when
comprehensive records are
not being created.
N -- Default; do not create
SMF record.
Y -- Create SMF record.
CREATE BEFORE UPDATE FIELD
IMAGES
158
1
CHAR
N -- Default; do not create
SMF record before update
field images.
Y -- Create SMF record
before update field images.
CREATE AFTER UPDATE FIELD
IMAGES
159
1
CHAR
N -- Default; do not create
SMF record after update
field images.
Y -- Create SMF record after
update field images.
CREATE COMPREHENSIVE
RECORDS
160
1
CHAR
Note: If all three of the
COMPREHENSIVE RECORD
fields are N (at positions
160, 161, and 162),
comprehensive update
records are created for any
added or deleted records
when SMF FIELD UPDATE
records are being created.
N -- Default; do not create
SMF record.
Y -- Create SMF record.
CREATE COMPREHENSIVE
BEFORE UPDATE RECORD
IMAGES
161
1
CHAR
N -- Default; do not create
SMF record before updating
comprehensive record
images.
Y -- Create SMF record
before updating
comprehensive record
images.
CREATE COMPREHENSIVE AFTER
UPDATE RECORD IMAGES
162
1
CHAR
N -- Default; do not create
SMF record after updating
comprehensive record
images.
Y -- Create SMF record after
updating comprehensive
record images.
A-10
File-AID Single Install Image Installation and Configuration Guide
Table A-7.
Audit Exit Input/Output Parms Exit Type R Layout (Continued)
Description
CREATE SMF UPDATE SUMMARY
RECORD
Position
163
Len
1
Format
CHAR
Values
N -- Default; do not create
SMF update summary
record.
Y -- Create SMF update
summary record.
I/O Exit
File-AID/MVS and File-AID/Data Solutions can share the same I/O exit, which means an
I/O exit created for File-AID/MVS can be used with File-AID/Data Solutions and viceversa.
The File-AID I/O exit enables you to write a callable routine to perform functions not
supported by File-AID such as: encryption, decryption, compression, and decompression.
In addition, an I/O exit routine can be written to handle all the I/O for specified files -including Open and Close.
The two types of I/O exits are type 1 and type 2. A type 1 exit allows record access after
File-AID reads from a dataset and before File-AID writes to a dataset. A type 2 exit allows
nonstandard dataset access; it performs all I/O processing against the dataset. The exit
supplies File-AID with a logical record upon request.
Compuware provides three sample exits. The sample exit names are XVJTYP1A and
XVJTYP2A (for Assembler) and XVJCOB1 (for COBOL). The communications macro for
Assembler only is called XVJFAIOU. XVJTYP1A and XVJCOB1 are sample compression
and decompression exits. XVJTYP2A is a sample exit for handling all I/O requests.
I/O exit processing can be initiated by entering a module name in the I/O EXIT field on
the Browse, Edit, Copy, Search/Update, Print, or Reformat screens or by coding the
IOEXIT parameter for File-AID/Batch. File-AID calls the I/O exit at least five times during
a File-AID function. “I/O Exit Sequence” on page A-11 lists the calls in the sequence in
which they occur. “I/O Exit Function Calls” on page A-11 describes the tasks performed
by File-AID and the I/O exit for each call.
I/O Exits From Prior File-AID Releases
With the current Release of File-AID, existing exits should be compiled using a vendor
supported release of the compiler (or a compiler covered by Compuware’s support
policy).
As of File-AID/MVS Release 9.4, all exits must be compiled and linked with
AMODE(31),RMODE(24).
What’s Different About Current Release I/O Exits
For current Release I/O exits, use the revised communications area illustrated by sample
library (SXVJSAMP) macro XVJFAIOU. For COBOL, see the linkage section of XVJCOB1.
The sample Assembler program XVJCOB1 now uses macro XVJFAIOU to describe the
changed area. Previous versions of the sample used macro FASYUSX.
Compuware recommends reviewing the changes in XVJFAIOU. During the verify call, a
value should be placed in field USXMREC to indicate the maximum record size that can
be returned from your exit. During subsequent calls, any returned records must be moved
to the address found in field USXREC@R. The length of returned records must be placed
in the field, USXRECLR.
Sample library (SXVJSAMP) member XVJLKIOA (XVJLKIOC for COBOL) illustrates the
special load module requirements for macro XVJFAIOU. Use of the revised area requires
File-AID/MVS Exits
A-11
that the load module contain two CSECTs. The module must begin with CSECT FSPFIXID
and is followed by your routine whose CSECT name must be FAIOXUSR. The load
module can have any name except DXPCPXT.
I/O Exit Sequence
Note:
Only one Verify and one Term call occurs per dataset per function. Several Open,
Record Access, and Close sequences may occur per function. In an Edit function,
for example, the dataset is opened, read to load memory, and closed. Then when
the user types SAVE or END, the dataset is opened, written, and closed again.
1. Verify call: Occurs when the user presses Enter on a primary function panel, but
after File-AID identifies and allocates the user-entered dataset.
2. Open call: Occurs at dataset open.
3. Record Access call: Occurs multiple times as each record is required for read or write.
The following five record access calls may occur:
Add
Insert a record
Delete
Delete a record
Update
Update a record
Read
Read a record
Write
Write a record.
4. Close call: Occurs at the end of a record access cycle.
5. Term call: Occurs at the end of a function just before a redisplay of the primary
function panel.
I/O Exit Function Calls
1. Verify Call.
File-AID does the following:
– Sets the dataset name, member name, volume serial, password, and DD name
fields in the I/O exit communications area.
– Calls the I/O exit.
The I/O exit does the following:
– Verifies whether or not it should process this dataset.
– Sets the processing type flag indicating that it will process the dataset as a type
(2) exit, or as a type (1) exit, or that it will ignore (I) this dataset (that is, File-AID
does not call the exit again for this function).
– Sets R15 = 0 for a successful call and R15 = nonzero to abort.
When R15 is nonzero, a message should be set in the communications area. If R15 is
nonzero, the File-AID function is terminated, and the user exit is not called again.
– Indicates the maximum record size that can be returned from the exit to
File-AID.
2. Open Call - Type 1 and Type 2 Exits.
File-AID does the following:
– Sets the processing mode as random or sequential.
– Updates the member name in the common area. With PDS processing, an open,
record access, and close cycle may occur for each member.
– Sets key length and relative key position.
A-12
File-AID Single Install Image Installation and Configuration Guide
– Sets open type access mode to input, output, or update.
– Sets the record format, dataset organization, and organization type.
The I/O exit does the following:
The I/O exit sets R15 = 0 for a successful call and R15 = nonzero to abort. When R15
is nonzero and File-AID aborts the open, the I/O exit still receives close and
terminate calls.
The type 1 I/O exit is called for open processing. After File-AID opens the file, the
exit verifies again that it can handle this dataset. The exit may set the ignore (I) flag.
When the ignore flag is set, File-AID continues to process the dataset without calling
the I/O exit. If the I/O exit wants to abort the function, then R15 should be nonzero
and a message should be set in the communications area.
The type 1 I/O exit may set the following:
– Key position relative to zero
– Key length if applicable
– Member name if applicable.
The type 2 I/O exit opens the file and sets the following:
– Record type to varying or fixed
– Key length if applicable
– Member name if applicable
– Key position relative to zero
– Dataset organization and type.
3. Record Access Call.
Type 1 exits have all I/O performed by File-AID. Type 2 exits must perform all I/O, as
required by type of access call.
Read Record Access Calls:
File-AID sets the following for a type 1 exit:
– Address of the record read by File-AID (USXREC@)
– Record length in the communications area (USXRECL).
The type 2 I/O exit must perform the I/O to read the record. Type 1 and type 2 I/O
exits do the following:
– Move the record to the address provided by File-AID (USXREC@R).
– Set the record length in the communications area (USXRECLR).
– Set R15 = 0 to continue processing.
– Set R15 = 4 for no record found (type 2 only). Random processing return code.
File-AID continues normal processing.
– Set R15 = 8 for end of data (type 2 only). File-AID terminates record access and
continues normal processing.
– Set R15 = 12 for File-AID to abort function processing. The I/O exit is still called
for close and termination. A message should be set in the communications area.
Write Record Access Calls (Add, Delete, Update, and Write):
File-AID sets the following for a type 1 exit:
– Record to be written in the common area (USXREC@)
– Length of the record in the common area (USXRECL).
The type 2 I/O exit must perform the requested I/O to write the record to the file.
File-AID/MVS Exits
A-13
The type 1 I/O exit is only called for the write and must:
– Move the record to be written to the address provided by File-AID (USXREC@R).
– Set the length of the record to be written (USXRECLR).
Type 1 and 2 I/O exits set the following:
– R15 = 0 to continue processing.
– R15 = nonzero for File-AID to abort record access processing. The I/O exit still is
called for close and termination. A message should be set in the communications
area.
4. Close Call - Type 2 Exit Only.
The exit should close the dataset being processed. No message processing is done,
and File-AID proceeds to the termination call.
5. Term Call.
Exits should free (FREEMAIN) any temporary storage acquired.
If R15 is nonzero, File-AID uses the message (if any) in the communications area for
the next panel display. The primary function panel is then redisplayed.
Installation of the User I/O Exit
The File-AID sample library (hlq.CPWR.MXVJA20.SXVJSAMP) provides sample I/O exits
in Assembler and COBOL, and provides JCL to compile and link-edit the exit, as shown
in Table A-8. XVJTYP1A and XVJCOB1 are sample compression and decompression exits.
XVJTYP2A is a sample exit for handling all I/O requests.
The user I/O exit must be assembled or compiled and then link-edited to a library in the
system search order (that is, a library searched when the load macro is issued). This
library may be the File-AID load library or another library concatenated either to ISPLLIB,
STEPLIB, the system linklist, or LPA. If using LIBDEF, the I/O exit must be in the LIBDEF
concatenation.
Table A-8.
Sample I/O Exits and JCL
Exit Source Name
Compile/Link JCL Name Description
XVJTYP1A
XVJLKIOA
Assembler I/O exit, communications macro XVJFAIOU.
XVJTYP2A
XVJLKIOA
Assembler I/O exit, communications macro XVJFAIOU
XVJCOB1
XVJLKIOC
COBOL I/O exit, JCL to link for COBOL
Once you have compiled and linked your I/O exit, the exit can be invoked for a File-AID
function. Make sure the “IOXDEF” variable is set to YES (see Table 3-2 on page 3-13) and
submitting JCL to create a new XVJOPXFA. Then, enter the member name of the I/O exit
program load module in the I/O exit field provided on browse, edit, copy, search/update,
or reformat screens (or the IOEXIT parameter in batch) and the exit is invoked for that
function.
Type 2 COBOL I/O Exits
With File-AID/MVS Release 10.2 under Language Environment, exits should no longer
use the RTEREUS option.
A-14
File-AID Single Install Image Installation and Configuration Guide
I/O Exit Communications Area
Table A-9.
I/O Exit Communications Area
Description
Position
Len
Format
Values
Exit Processing Type
1
1
CHAR
I Ignore
1 Set TYPE=1
2 Set TYPE=2
Service Request
2
1
CHAR
A Add
C Close
D Delete
I Initialize/verify
O Open
R Read
T Terminate
U Update
W Write.
Reserved
3
1
CHAR
Processing Mode
4
1
CHAR
R Random
S Sequential.
Access Mode
5
1
CHAR
I Input
O Output
U Update.
DDname
6
8
CHAR
DDname allocated by
File-AID.
Dataset Name
14
44
CHAR
DSN without quotes and
including TSO prefix if
appropriate.
Member Name
58
8
CHAR
Member Name
Volume Serial
66
6
CHAR
The volume serial number of
the disk or tape that contains
the dataset.
Password
72
8
CHAR
The password for OS
password protected
datasets.
Dataset Organization
80
1
CHAR
B
P
S
V
Organization Type
81
1
CHAR
E ESDS
K Keyed
R RRDS.
Record Format
82
2
CHAR
F Fixed
FB Fixed blocked
V Variable
VB Variable blocked
VBS Variable blocked
spanned.
Reserved
84
1
CHAR
USXREC@ - Record Pointer Passed 85
to Exit
4
POINTER
BDAM dataset
Partitioned dataset
Sequential dataset
VSAM dataset.
Address of area containing
record passed from File-AID
to exit.
File-AID/MVS Exits
Table A-9.
A-15
I/O Exit Communications Area (Continued)
Description
Position
Len
Format
Values
USXRECL - Record Length
89
4
BINARY
Length of record passed
from File-AID to exit.
USXREC@R - Record Pointer
Returned from Exit
93
4
POINTER
Destination address of area
for exit to move returned
record.
USXRECLR - Record Length
97
4
BINARY
Length of record returned
from exit.
Block size
101
4
BINARY
Block size.
Maximum Record Length
105
4
BINARY
Exit sets this value to the
maximum size record
returned from the exit.
Key Length
109
4
BINARY
Length of key.
Key Position
113
4
BINARY
Location of key relative to
zero (0).
Key Address
117
4
POINTER
Address that points to key.
For Type=2 I/O Exits, the
startkey value is only
available on the first read,
thereafter startkey value is
binary zeros.
Key Length Read
121
4
BINARY
Length key read.
Message Number
125
5
CHAR
Message number xxxxx,
where the File-AID MLIB
message is FAMxxxxx
(FAJxxxxx for Japanese).
Message Text
130
80
CHAR
Exit-supplied error text for
batch processing. Or can
also use when message
number is blank; File-AID
displays only the first 60
characters.
Process Option
210
1
CHAR
O Online
B Batch
Reserved
211
2
CHAR
Work Area Pointer
213
4
POINTER
The I/O exit may use this
area to save the pointer to a
GETMAINed work area.
SMF Recording Function
File-AID can create SMF records for all datasets that are accessed by Browse, Edit, or the
Search/Update utility. The File-AID SMF records provide information on who accessed a
dataset and which records were modified. This chapter describes the following optional
procedures for the SMF recording facility of File-AID:
•
•
•
•
“Install or Modify SMF Recording” on page A-16
“Remove SMF Recording” on page A-16
“SMF Record Contents” on page A-16
“Writing a Dynamic SMF User Exit Program” on page A-20.
The SMF recording facility of File-AID can be activated during the installation of File-AID
or any time after the installation. Each site controls the types of SMF records created. The
site can also specify whether File-AID records full before and after images of modified
records or only before and after images of modified fields.
A user exit is also available to permit you to accept, reject, or modify any File-AID SMF
record before it is written to the SMF dataset. Within this user exit, you can route the
A-16
File-AID Single Install Image Installation and Configuration Guide
SMF record to a specific log file, or let File-AID place it in the SMF dataset. See “Writing a
Dynamic SMF User Exit Program” on page A-20 for details.
Install or Modify SMF Recording
Complete the following steps to install or modify the File-AID SMF recording function:
CAUTION:
File-AID writes its SMF records directly to the installation’s SMF dataset. Therefore,
before installing SMF recording, make sure that creating these SMF records will not
cause problems in the installation.
1. Check that the File-AID SVC is installed. (see “SVC INFORMATION” on page 2-22).
2. Select a code from 128 to 255 to identify the File-AID SMF records. Check that the
selected code is not currently used for any other user-written SMF record in the
installation. The default is 170.
3. To install the SMF recording function, you need to follow the instructional
comments in one of the sample audit exit programs in the File-AID sample library
hlq.CPWR.MXVJA20.SXVJSAMP. See Table A-10. Make the modifications,
assemble/compile, and then link the audit exit program (see “Audit Trail Exit” on
page A-6).
Table A-10. Sample Audit Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
XFAAUAXA
XFALKAUA
Assembler sample audit exit
XFAAUAXC
XFALKAUC
COBOL sample audit exit
XFAAUAXP
XFALKAUP
PL/I sample audit exit
XFASMFUX
XFALKSMF
Assembler sample dynamic SMF
user exit
The SMF recording facility is now installed. When File-AID is used, SMF records are
created as defined by the options you specified in the audit exit.
Remove SMF Recording
To remove the SMF recording facility from File-AID, simply remove the SMF user exit.
SMF Record Contents
The tables in this section describe the contents of the different File-AID SMF records.
File-AID can build any or all of the following SMF records:
•
•
•
•
Dataset access
Field update
Comprehensive update
Dataset update summary.
Use member XVJSMFRH (located in the File-AID sample library (SXVJSAMP) in the site’s
Assembler program) to map the different File-AID SMF records. To access all the SMF
records created by File-AID, scan the SMF records for the SMF code specified in the audit
exit program.
To access all the SMF records for a dataset using File-AID, complete the following:
1. Scan SMF records for the File-AID records that have field RRECTYPE equal to a X’10’
and field RDSN equal to the requested dataset name.
File-AID/MVS Exits
A-17
2. Rescan the File-AID records, and select all records that contain the same values found
in fields RCTLTIME and RCTLDATE.
Common Header for all SMF Record Types
Table A-11 maps the common header that is created for each SMF record created by
File-AID. Fields RCTLTIME and RCTLDATE are the same for all SMF records created by
File-AID for a given dataset for each separate edit or search/update session.
Table A-11. SMF Common Header Format
Offsets
Len
Format
Description
0
0
RRECLEN
Name
2
binary
Record length.
2
2
RRCLEN2
2
binary
Segment descriptor.
4
4
RSYSCODE
1
binary
System indicator.
Bit
Meaning when set
Reserved
0-2
3
MVS/SP Version 4 and above. Bits 3, 4, 5,
and 6 are on
4
MVS/SP Version 3. Bits 4, 5, and 6 are on
5
MVS/SP Version 2. Bits 5 and 6 are on
6
VS2. Bit 6 is on
7
Reserved
5
5
RRECCODE
1
binary
Record code from SPFSMF member.
6
6
RTIME
4
binary
Time, in hundredths of a second, when the
record was moved to the SMF buffer.
10
A
RDATE
4
packed
Date when the record was moved to the buffer
in the form 00YYDDDF, where F is sign.
14
E
RSMCASID
4
EBCDIC
18
12
RRECTYPE
1
binary
File-AID record type:
Byte
Meaning
X'10'
Dataset access record.
X'20'
Dataset summary record.
X'30'
Field update record before and after
image.
Field update record before image.
X'31'
X'32'
Field update record after image.
X'41'
Comprehensive update record before
image.
Comprehensive update record after
X'42'
image.
Systerm ID. Taken from SID parameter.
19
13
RCTLTIME
4
binary
Time, in timer units, when the dataset access
record was moved to the SMF buffer.
23
17
RCTLDATE
4
packed
Date when the dataset access record was moved
to the SMF buffer. The form is 00YYDDDF, where
F is sign.
Dataset Access Record Format
Dataset access records are created when a dataset is accessed in option 1 Browse, 2 Edit,
and 3.6 Search/Update. Table A-12 maps the dataset access SMF record. If this record type
is present, it contains a Hexadecimal X'10' in the RRECTYPE field.
Table A-12. SMF Data Access Record Format
Offsets
Name
Len
Format
Description
Common SMF Header. See Table A-11 on page A-17 .
27
1B
RUSERID
8
EBCDIC
TSO user ID.
35
23
RDSN
44
EBCDIC
Name of dataset accessed.
A-18
File-AID Single Install Image Installation and Configuration Guide
Table A-12. SMF Data Access Record Format (Continued)
Name
Len
Format
Description
79
Offsets
4F
RMEMBER
8
EBCDIC
Member name accessed.
87
57
RDFUNC
1
EBCDIC
File-AID function code:
B Browse; Search/Update.
E Edit; Search/Update.
88
58
RDSELECT
1
EBCDIC
File-AID select option (U, B).
B Search/Update find, browse, preview.
F Browse, Edit.
M Modify.
S Browse, Edit with selection criteria.
U Search/Update change, update.
89
59
RDKFLAG
1
EBCDIC
Keyed (K) or Unkeyed (U).
90
5A
RDKEYLEN
1
binary
If keyed file, length of record key.
90
5A
RDRPOSID
1
binary
If unkeyed file, flag that indicates the format
of the record position field:
Byte
Meaning
X'80'
TTR format
X'40'
Record number
X'20'
RBA
X'10'
Slot number for RRDS.
91
5B
RAUDTDSN
44
EBCDIC
Audit trail dataset name.
135
87
RLAYODSN
44
EBCDIC
Record layout dataset name.
179
B3
RLAYOMEM
22
EBCDIC
Record layout member name.
201
C9
RLAYOTYP
1
EBCDIC
Record layout dataset type.
202
CA
RLAYOUSE
1
EBCDIC
Record layout dataset usage.
S Single
X XREF
N None.
203
CB
RXREFDSN
44
EBCDIC
XREF dataset name.
247
F7
RXREFMEM
22
EBCDIC
XREF member name.
269
10D
RSELCUSE
1
EBCDIC
Selection criteria usage.
E Use existing
M Modify existing
T Create temporary
Q Quick
N None.
270
10E
RSELCDSN
44
EBCDIC
Selection criteria dataset name.
314
13A
RSELCMEM
22
EBCDIC
Selection criteria member name.
336
150
RDAFLTYP
1
EBCDIC
Input file type.
337
151
RDAKEYPO
4
binary
Relative key position if keyed.
341
155
RDCID
4
binary
Terminal CCSID.
345
159
R2DSN
44
EBCDIC
'Copied to' dataset name.
389
185
R2MEMBER
8
EBCDIC
'Copied to' member name.
Field Update Record Format
Field update records are created by the edit and Search/Update functions when a record is
modified, and if field update recording was selected in the audit trail exit program. The
SMF record contains the before and after images of each field in the modified record.
Table A-13 maps the field update SMF record. This record type is optional. If this record is
File-AID/MVS Exits
A-19
created, it contains a hexadecimal X'30', X'31', or X'32' in the RRECTYPE field, depending
upon the options selected in the audit trail exit program.
Table A-13. SMF Field Update Record Format
Offsets
Name
Len
Format
Description
Common SMF Header. See Table A-11 on page A-17.
27
1B
RFPOSREC
8
binary
Record position information for unkeyed file.
See Note 1.
For each undated field, File-AID makes the following entry starting after the record position information.
+0
+0
RFLEN
4
binary
Length of updated field.
+4
+4
RFLOC
4
binary
Relative (to zero) start location of the field
within the record.
+8
+8
RFBAIMAG
EBCDIC
The before image of the updated field is
stored immediately, followed by the after
image of the field. See Note 2.
After RFBAIMAG follow the key length and key data fields.
0
0
RFKEYLEN
2
2
RFKEYDTA
2
binary
If the file is keyed, the key length is stored
here, otherwise it is X’0000’.
EBCDIC
If the file is keyed, the record key is stored
starting here. The length of the record key is
in field RFKEYLEN.
Notes:
1. If RDRPOSID (see “Dataset Access Record Format” on page A-17) is X'80', bytes 5
through 8 contain the relative (to zero) byte offset of the record in the block.
Otherwise, these bytes are zero.
2. A RRECTYPE value of X'31' means that only before images are stored. A value of X'32'
means only after images are stored.
Comprehensive Update Record Format
Comprehensive update records are created when a dataset is modified by the edit
function and option U of the Search/Update utility. Two SMF records can be created, one
for the before image and one for the after image. If an existing record is modified, both a
before and after image SMF record are created.
Table A-14 maps the comprehensive update SMF record. This record type is optional. If
this record is created, it contains a hexadecimal X'41' or X'42' in the RRECTYPE field (see
“Common Header for all SMF Record Types” on page A-17), depending upon the options
selected in the audit trail exit program.
Table A-14. SMF Comprehensive Update Record Format
Offsets
Name
Len
Format
Description
Common SMF Header. See Table A-11 on page A-17.
27
1B
RCUDTYP
1
EBCDIC
Type of update flag (U = update).
The following fields occur when the file is keyed:
28
1C
RCKEYDTA
EBCDIC
Record key is stored starting here. The record
key length is in field RDKEYLEN.
+0
+0
RCKEYDTA
EBCDIC
The before or after record image start
position.
The following fields occur when the file is unkeyed:
28
1C
RCPOSREC
36
24
RCPOSDTA
8
EBCDIC
Record position information. See Note
below.
EBCDIC
The before or after record image start
position.
A-20
File-AID Single Install Image Installation and Configuration Guide
Note:
If RDRPOSID (see “Dataset Access Record Format” on page A-17) is X’80’, bytes 5
through 8 contain the relative (to zero) byte offset of the record in the block.
Otherwise, these bytes are zero.
Dataset Update Summary Record Format
Dataset update summary records are created by the edit function and option U of the
Search/Update utility to record the number of dataset records added, deleted, or updated.
Table A-15 maps the Dataset Summary Update SMF record. This record type is optional. If
present, it contains a hexadecimal X'20' in the RRECTYPE field.
Table A-15. Dataset Update Summary Record Format
Offsets
Name
Len
Format
Description
Common SMF Header. See Table A-11 on page A-17.
27
1B
RSUMADD
4
binary
Total number of records added.
31
1F
RSUMDEL
4
binary
Total number of records deleted.
35
23
RSUMUPDT
4
binary
Total number of records updated.
39
27
RSUMDES1
48
EBCDIC
Description line one.
87
57
RSUMDES2
48
EBCDIC
Description line two.
Writing a Dynamic SMF User Exit Program
You can create a user exit program that File-AID calls before writing the SMF record to the
SMF dataset. Compuware provides a sample program in the File-AID sample library
(SXVJSAMP) member XFASMFUX. Assembler DSECTS of the SMF record formats are
provided in member XVJSMFRH of the sample library (SXVJSAMP).
A user exit program must be dynamic. The exit program is loaded at File-AID startup.
Complete the following steps to activate a dynamic user exit program:
1. Assemble and link-edit the exit module XFASMFUX using sample library member
XFALKSMF and place the user exit load module in the load library of File-AID.
2. Modify the SMF exit name field in the audit exit program to reflect the name of the
dynamic user exit program. See “Audit Exit Parameter Layouts” on page A-7.
3. Assemble and link-edit the audit exit program.
4. A file, used to write the SMF record to, must exist with the following characteristics:
•
•
•
•
DSORG = PS
RECFM=VBS
LRECL=32760
BLKSIZE=32760
5. You must set up a TSO allocation to the file you are writing the SMF record to. Enter
this command:
ALLOC F(TESTSMF) DA(user supplied dataset) MOD
Writing an SMF Exit
When the exit program receives control from File-AID, register 1 points to a two-word
parameter list that contains the following information:
Word 1
The dynamic working storage area of the exit.
Word 2
The SMF record about to be written.
On the final call to the exit program, word 2 contains zeros.
The exit program may execute any of the following tasks:
File-AID/MVS Exits
A-21
• Write the SMF record to another file.
• Modify the SMF record.
• Request that File-AID not write the record to the SMF file.
When the exit program returns to File-AID, register 15 must contain one of the following
codes:
0
File-AID writes the SMF record to the SMF dataset.
4
File-AID does not write the SMF record to the SMF dataset.
If a return code 0 or 4 is used, File-AID takes the indicated action and continues to return
to the user exit each time a new SMF record is created.
8
File-AID writes the dataset access SMF record plus all other SMF records.
12
File-AID does not write the dataset access SMF record, and it does not create any other SMF
records for this dataset.
Return codes 8 and 12 are only valid from the initial call to the user exit for a new
dataset. Return codes 8 and 12 cause File-AID to take the indicated action, then process
the dataset without returning to the exit program until another dataset is accessed.
A-22
File-AID Single Install Image Installation and Configuration Guide
B-1
Appendix B.
File-AID/Data Solutions Exits
Appendix A.
This appendix describes the various File-AID/Data Solutions exits:
• “Audit Trail Exit”
• “I/O Exit”
• “SMF Recording Function”
• “Date Pattern Exits”
• “Field Level Exits”
• “Encryption Routine Exits”
The File-AID sample library (SXVJSAMP) includes File-AID/Data Solutions sample exits.
The sample exits are functionally inert unless you modify them. The default audit exit is
automatically linked when you install File-AID/Data Solutions. If you modify it after
installation, you need to compile and relink it using the appropriate JCL (see Table B-1
on page B-2).
I/O exits are not automatically linked at installation time. Use the appropriate JCL listed
in Table A-8 on page A-13 to install a File-AID/Data Solutions user I/O exit.
Note:
If exit routines are maintained by a person other than the systems programmer,
the File-AID load library should remain in the Link List.
Audit Trail Exit
The File-AID/Data Solutions audit trail exit, DAAUAXF, is linked into load module
UDAAUAF and called dynamically after allocating the input dataset for the Update
function. The default audit trail exit, shipped with File-AID, immediately returns control
to the calling function.
Note:
If you plan on using a custom audit trail exit from a File-AID release prior to
Release 10.1, you must copy, then rename the load module to UDAAUAF.
The audit trail exit can be used for the following purposes:
• To force the creation of an audit trail for a specific dataset, group of datasets, and/or
group of users.
• To force automatic printing of the audit trail report and specify whether to retain the
audit trail dataset after printing.
• To override the audit trail dataset name that is constructed by File-AID/Data
Solutions.
Note:
The audit trail dataset name must be unique. Each time the audit trail is used
File-AID/Data Solutions generates a new dataset name. Compuware
recommends employing the date and time stamp as part of this dataset
name.
B
B-2
File-AID Single Install Image Installation and Configuration Guide
When auditing is requested, File-AID/Data Solutions allocates the audit trail dataset
at the beginning of the edit session. If your TSO prefix matches your user ID, the
audit trail dataset name is:
TSO-ID.DATASOL.AUDT.Dyymmdd.Thhmmss.Msss
TSO-ID
TSO user ID, up to seven characters.
Dyymmdd
Gregorian date on which the audit trail is created.
Thhmmss
Hour, Minute, and second the audit trail is created.
Msss
Millisecond the audit trail is created.
TSO-prefix
TSO user prefix, up to seven characters.
If your TSO-prefix does not match your user ID and the audit dataset name does
not exceed 44 characters, the audit trail dataset name is:
TSO-prefix.TSO-ID.DATASOL.AUDT.Dyymmdd.Thhmmss.Msss 
When the TSO-prefix is included and the construction of the audit dataset name
exceeds 44 characters, then millisecond will be omitted. For example, if you had
a 4 character tso-prefix and a 5 character tso-id, millisecond would be included. If
you had a 4 character tso-prefix and a 7 character tso-id, millisecond would be
omitted.
TSO-prefix.TSO-ID.DATASOL.AUDT.Dyymmdd.Thhmmss
• To implement the optional File-AID/Data Solutions SMF recording function.
The audit trail exit is called from disguise for the purpose of checking the optional
SMF recording function (file access recording). File-AID/Data Solutions does not
currently support audit reporting from SMF.
Note:
Non reentrant load modules can reside in a APF library. However, if a load
module is marked by the linkage editor as reentrant, then it must actually be
reentrant if it resides in an APF library.
The audit trail exit parameter list is described in “Audit Exit Parameter Layouts”. All
fields in the parameter list are prefilled with a necessary process value or default value.
Any field in the audit trail exit can be modified. Security parameters and fields unrelated
to the audit trail process are ignored by File-AID/Data Solutions when processing the
audit trail.
Notes:
• The audit exit should be reentrant.
• Do not use any run-time compiler debugging options when compiling a COBOL
audit exit.
Installing the Audit Exit
The File-AID Sample library (CPWR.MXVJA20.SXVJSAMP) provides sample audit trail
exits in Assembler, COBOL, PL/I, and provides JCL to compile and link-edit the exit, as
shown in Table B-1. In addition, the Sample library contains a sample SMF user exit in
Assembler and the corresponding JCL. See “SMF Recording Function” on page B-5 for
more information.
Table B-1.
Sample Audit Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
UDAAUAXA
UDALKAUA
Assembler sample audit exit
UDAAUAXC
UDALKAUC
COBOL sample audit exit
UDAAUAXP
UDALKAUP
PL/I sample audit exit
UDASMFUX
UDASLKSMF
Assembler sample SMF exit
File-AID/Data Solutions Exits
B-3
Audit Exit Parameter Layouts
Input Parms
Table B-2.
Audit Exit Input Parms Layout
Description
Position
Len
Format
Values
EXIT TYPE
1
1
CHAR
R Audit Trail Allocation
USER ID
2
7
CHAR
TSO Userid
FUNCTION NUMBER
9
1
CHAR
1 Browse
2 Edit
3 Search/Update utility
ONLINE/BATCH
INDICATOR
10
FILE-AID VERSION
11
FILE TYPE
FULLY QUALIFIED DSN
DATASET
ORGANIZATION
1
CHAR
O : Online operation
B : Batch operation
5
CHAR
Version number of File-AID in use (i.e. 10.02).
16
1
CHAR
D Data file dataset
17
44
CHAR
Edit DSN without quotes and including TSO
prefix if appropriate.
61
2
CHAR
AM VSAM dataset
DA
BDAM dataset
PO
Partitioned dataset
PS
Sequential dataset.
VOLUME SERIAL
63
6
CHAR
The volume serial number of the disk or tape that
contains the dataset.
PASSWORD
69
8
CHAR
The password for OS password protected
datasets.
READ ONLY INDICATOR
77
1
CHAR
Y
Read-only
N Update.
INPUT/OUTPUT PARMS - EXIT TYPE R
Table B-3.
Audit Exit Input/Output Parms Exit Type R Layout
Description
Position
Len
Format
Values
AUDIT TRAIL DSN
87
46
CHAR
Audit Trail DSN to be allocated, with quotes and
including TSO prefix if appropriate.
SLIB MEMBER NAME
133
8
CHAR
Default is FAJCAUDR. You can override with a
different SLIB member.
CREATE AUDIT TRAIL
INDICATOR
141
1
CHAR
Input value is the value from the Edit - Dataset
Specification or Search/Update screen. You can
override with one of the following:
Y
Create an audit trail.
N Do not create an audit trail.
FORCE PRINT
INDICATOR
142
1
CHAR
N Default; does not force printing of the audit
trail dataset.
K Forces printing and keeps the audit trail report.
D Forces printing and deletes the audit trail
dataset.
Any other value in this position keeps the audit
trail without printing.
SMF USER EXIT NAME
143
8
CHAR
Default is spaces for dynamic SMF user exit
program name.
B-4
File-AID Single Install Image Installation and Configuration Guide
Table B-3.
Audit Exit Input/Output Parms Exit Type R Layout (Continued)
Description
Position
Len
Format
Values
SMF RECORD CODE
151
3
CHAR
Default is 170 for SMF record code.
CREATE SMF RECORDS
FOR BROWSE
154
1
CHAR
N Default; does not create SMF records for
browse.
Y
CREATE SMF RECORDS
FOR EDIT
155
CREATE SMF ACCESS
RECORDS
156
1
CHAR
N Default; does not create SMF records for edit.
Y
1
CHAR
Creates SMF records for browse.
Creates SMF records for edit.
The access record is always created when a file is
edited and the CREATE SMF RECORDS FOR EDIT
flag is Y, even if this flag is set to N.
N Default; does not create SMF access record.
Y Creates SMF access record.
CREATE SMF FIELD
UPDATE RECORDS
157
1
CHAR
Note:
If all three of the FIELD UPDATE record
indicators fields are Y (at positions 157,
158, and 159), comprehensive update
records are created for any added or
deleted records even when
comprehensive records are not being
created.
N Default; do not create SMF record.
Y Create SMF record.
CREATE BEFORE
UPDATE FIELD IMAGES
158
1
CHAR
CREATE AFTER UPDATE
FIELD IMAGES
159
1
CHAR
N Default; do not create SMF record before
update field images.
Y Create SMF record before update field images.
N Default; do not create SMF record after
update field images.
Y Create SMF record after update field images.
CREATE
COMPREHENSIVE
RECORDS
160
1
CHAR
Note:
If all three of the COMPREHENSIVE
RECORD fields are N (at positions 160,
161, and 162), comprehensive update
records are created for any added or
deleted records when SMF FIELD
UPDATE records are being created.
N Default; do not create SMF record.
Y Create SMF record.
CREATE
COMPREHENSIVE
BEFORE UPDATE
RECORD IMAGES
161
CREATE
COMPREHENSIVE
AFTER UPDATE RECORD
IMAGES
162
CREATE SMF UPDATE
SUMMARY RECORD
163
1
CHAR
N Default; do not create SMF record before
updating comprehensive record images.
Y Create SMF record before updating
comprehensive record images.
1
CHAR
N Default; do not create SMF record after
updating comprehensive record images.
Y Create SMF record after updating
comprehensive record images.
1
CHAR
N Default; do not create SMF update summary
record.
Y Create SMF update summary record.
I/O Exit
File-AID/Data Solutions and File-AID/MVS can share the same I/O exit, which means an
I/O exit created for File-AID/Data Solutions can be used with File-AID/MVS and viceversa. Refer to “I/O Exit” on page A-10 for detailed information.
File-AID/Data Solutions Exits
B-5
SMF Recording Function
File-AID/Data Solutions can create SMF records for all datasets that are accessed by the
Update function. The File-AID/Data Solutions SMF records provide information on who
accessed a dataset and which records were modified. This chapter describes the following
optional procedures for the SMF recording facility of File-AID/Data Solutions:
•
•
•
•
“Install or Modify SMF Recording”
“Remove SMF Recording” on page B-5
“SMF Record Contents” on page B-6
“Writing a Dynamic SMF User Exit Program” on page B-9.
The SMF recording facility of File-AID/Data Solutions can be activated during the
installation of File-AID/Data Solutions or any time after the installation. Each site
controls the types of SMF records created. The site can also specify whether File-AID/Data
Solutions records full before and after images of modified records or only before and after
images of modified fields.
A user exit is also available to permit you to accept, reject, or modify any File-AID/Data
Solutions SMF record before it is written to the SMF dataset. Within this user exit, you
can route the SMF record to a specific log file, or let File-AID/Data Solutions place it in
the SMF dataset. See “Writing a Dynamic SMF User Exit Program” on page B-9 for details.
Install or Modify SMF Recording
Complete the following steps to install or modify the File-AID/Data Solutions SMF
recording function:
CAUTION:
File-AID/Data Solutions writes its SMF records directly to the installation’s SMF
dataset. Therefore, before installing SMF recording, make sure that creating these
SMF records will not cause problems in the installation.
1. Check that the File-AID SVC is installed. (see “SVC INFORMATION” on page 2-22).
2. Select a code from 128 to 255 to identify the File-AID/Data Solutions SMF records.
Check that the selected code is not currently used for any other user-written SMF
record in the installation. The default is 170.
3. To install the SMF recording function, you need to follow the instructional
comments in one of the sample audit exit programs in the File-AID Sample library
CPWR.MXVJA20.SXVJSAMP. See Table B-4. Make the modifications,
assemble/compile, and then link the audit exit program.
Table B-4.
Sample Audit Exits and JCL
Exit Source Name
Compile/Link JCL Name
Description
UDAAUAXA
UDALKAUA
Assembler audit exit
UDAAUAXC
UDALKAUC
COBOL audit exit
UDAAUAXP
UDALKAUP
PL/I audit exit
UDASMFUX
UDALKSMF
Assembler SMF exit
The SMF recording facility is now installed. When File-AID/Data Solutions is used, SMF
records are created as defined by the options you specified in the audit exit.
Remove SMF Recording
To remove the SMF recording facility from File-AID/Data Solutions, simply remove the
SMF user exit.
B-6
File-AID Single Install Image Installation and Configuration Guide
SMF Record Contents
The tables in this section describe the contents of the different File-AID/Data Solutions
SMF records. File-AID/Data Solutions can build any or all of the following SMF records:
• Dataset access
• Field update
• Comprehensive update
• Dataset update summary.
Use member SMFRHDR (located in the File-AID sample library (SXVJSAMP) in the site’s
Assembler program) to map the different File-AID/Data Solutions SMF records. To access
all the SMF records created by File-AID/Data Solutions, scan the SMF records for the SMF
code specified in the audit exit program.
To access all the SMF records for a dataset using File-AID/Data Solutions, complete the
following:
1. Scan SMF records for the File-AID/Data Solutions records that have field RRECTYPE
equal to a X’10’ and field RDSN equal to the requested dataset name.
2. Rescan the File-AID/Data Solutions records, and select all records that contain the
same values found in fields RCTLTIME and RCTLDATE.
Common Header for all SMF Record Types
Table B-5 maps the common header that is created for each SMF record created by
File-AID/Data Solutions. Fields RCTLTIME and RCTLDATE are the same for all SMF
records created by File-AID/Data Solutions for a given dataset for each separate Update
process.
Table B-5.
SMF Common Header Format
Offsets
Name
Len
Format
Description
0
0
RRECLEN
2
binary
Record length.
2
2
RRCLEN2
2
binary
Segment descriptor.
4
4
RSYSCODE
1
binary
System indicator.
Bit Meaning when set
0-4 Reserved
5
MVS/XA
5
5
RRECCODE 1
binary
Record code from SPFSMF member.
6
6
RTIME
4
binary
Time, in hundredths of a second, when the record was moved
to the SMF buffer.
10
A
RDATE
4
packed
Date when the record was moved to the buffer in the form
00YYDDDF, where F is sign.
14
E
RSMCASID
4
EBCDIC
Systerm ID. Taken from SID parameter.
18
12
RRECTYPE
1
binary
File-AID/Data Solutions record type:
Byte Meaning
X’10’ Dataset access record.
X’20’ Dataset summary record.
X’30’ Field update record before and after image.
X’31’ Field update record before image.
X’32’ Field update record after image.
X’41’ Comprehensive update record before image.
X’42’ Comprehensive update record after image.
19
13
RCTLTIME
4
binary
Time, in timer units, when the dataset access record was
moved to the SMF buffer.
File-AID/Data Solutions Exits
Table B-5.
B-7
SMF Common Header Format (Continued)
Offsets
Name
Len
Format
Description
23
RCTLDATE
4
packed
Date when the dataset access record was moved to the SMF
buffer. The form is 00YYDDDF, where F is sign.
17
Dataset Access Record Format
Dataset access records are created when a dataset is accessed in option 1 Browse, 2 Edit,
and 3.6 Search/Update. Table B-6 maps the dataset access SMF record. If this record type
is present, it contains a Hexadecimal X’10’ in the RRECTYPE field.
Table B-6.
Offsets
SMF Data Access Record Format
Name
Len
Format
Description
Common SMF Header. See Table B-5.
27
1B
RUSERID
8
EBCDIC
TSO user ID.
35
23
RDSN
44
EBCDIC
Name of dataset accessed.
79
4F
RMEMBER
8
EBCDIC
Member name accessed.
87
57
RDFUNC
1
EBCDIC
File-AID/Data Solutions function code:
B Browse; Search/Update.
E Edit; Search/Update.
88
58
RDSELECT
1
EBCDIC
File-AID/Data Solutions select option (U, B).
B Search/Update find, browse, preview.
F Browse, Edit.
S Browse, Edit with selection criteria.
U Search/Update change, update.
89
59
RDKFLAG
1
EBCDIC
Keyed (K) or Unkeyed (U).
90
5A
RDKEYLEN
1
binary
If keyed file, length of record key.
90
5A
RDRPOSID
1
binary
If unkeyed file, flag that indicates the format of the record
position field:
Byte Meaning
X’80’ TTR format
X’40’ Record number
X’20’ RBA
X’10’ Slot number for RRDS.
91
5B
RAUDTDSN
44
EBCDIC
Audit trail dataset name.
135 87
RLAYODSN
44
EBCDIC
Record layout dataset name.
179 B3
RLAYOMEM
22
EBCDIC
Record layout member name.
201 C9
RLAYOTYP
1
EBCDIC
Record layout dataset type.
202 CA
RLAYOUSE
1
EBCDIC
Record layout dataset usage.
S Single
X XREF
N None.
203 CB
RXREFDSN
44
EBCDIC
XREF dataset name.
247 F7
RXREFMEM
22
EBCDIC
XREF member name.
1
EBCDIC
Selection criteria usage.
E
Use existing
M Modify existing
T Create temporary
Q Quick
N None.
269 10D RSELCUSE
B-8
File-AID Single Install Image Installation and Configuration Guide
Table B-6.
SMF Data Access Record Format (Continued)
Offsets
Name
Len
Format
Description
270 10E
RSELCDSN
44
EBCDIC
Selection criteria dataset name.
314 13A
RSELCMEM
22
EBCDIC
Selection criteria member name.
336 150
RDAFLTYP
1
EBCDIC
Input file type.
337 151
RDAKEYPO
4
binary
Relative key position if keyed.
341 155
RDCID
4
binary
Terminal CCSID.
345 159
R2DSN
44
EBCDIC
'Copied to' dataset name.
389 185
R2MEMBER
8
EBCDIC
'Copied to' member name.
Field Update Record Format
Field update records are created by the edit and Search/Update functions when a record is
modified, and if field update recording was selected in the audit trail exit program. The
SMF record contains the before and after images of each field in the modified record.
Table B-7 maps the field update SMF record. This record type is optional. If this record is
created, it contains a hexadecimal X’30’, X’31’, or X’32’ in the RRECTYPE field,
depending upon the options selected in the audit trail exit program.
Table B-7.
Offsets
SMF Field Update Record Format
Name
Len
Format Description
Common SMF Header. See Table B-5 on page B-6.
27
1B
RFKEYDTA
27
1B
RFPOSREC
EBCDIC If the file is keyed, the record key is stored starting here. The
length of the record key is in field RDKEYLEN.
8
binary
Record position information for unkeyed file. See Note 1.
For each undated field, File-AID/Data Solutions makes the following entry starting after the record key or
the record position information.
+0
+0
RFLEN
4
binary
Length of updated field.
+4
+4
RFLOC
4
binary
Relative (to zero) start location of the field within the record.
+8
+8
RFBAIMAG
EBCDIC The before image of the updated field is stored immediately,
followed by the after image of the field. See Note 2.
After RFBAIMAG follow the key length and key data fields.
0
0
RFKEYLEN
2
2
RFKEYDTA
2
binary
If the file is keyed, the key length is stored here, otherwise it is
X’0000’.
EBCDIC If the file is keyed, the record key is stored starting here. The
length of the record key is in field RFKEYLEN.
Notes:
1. If RDRPOSID (see “Dataset Access Record Format” on page B-7) is X’80’, bytes 5
through 8 contain the relative (to zero) byte offset of the record in the block.
Otherwise, these bytes are zero.
2. A RRECTYPE value of X’31’ means that only before images are stored. A value of
X’32’ means only after images are stored.
Comprehensive Update Record Format
Comprehensive update records are created when a dataset is modified by the edit
function and option U of the Search/Update utility. Two SMF records can be created, one
for the before image and one for the after image. If an existing record is modified, both a
before and after image SMF record are created.
Table B-8 maps the comprehensive update SMF record. This record type is optional. If this
record is created, it contains a hexadecimal X’41’ or X’42’ in the RRECTYPE field (see
File-AID/Data Solutions Exits
B-9
“Common Header for all SMF Record Types” on page B-6), depending upon the options
selected in the audit trail exit program.
Table B-8.
Offsets
SMF Comprehensive Update Record Format
Name
Len
Format
Description
Common SMF Header. See Table B-5 on page B-6.
27
1B
RCUDTYP
1
EBCDIC
Type of update flag (U = update).
The following fields occur when the file is keyed:
28
1C
RCKEYDTA
EBCDIC
Record key is stored starting here. The record key length is in
field RDKEYLEN.
+0
+0
RCKEYDTA
EBCDIC
The before or after record image start position.
The following fields occur when the file is unkeyed:
28
1C
RCPOSREC
36
24
RCPOSDTA
Note:
8
EBCDIC
Record position information. See Note below.
EBCDIC
The before or after record image start position.
If RDRPOSID (see “Dataset Access Record Format” on page B-7) is X’80’, bytes 5
through 8 contain the relative (to zero) byte offset of the record in the block.
Otherwise, these bytes are zero.
Dataset Update Summary Record Format
Dataset update summary records are created by the Update process to record the number
of dataset records updated. Table B-9 maps the Dataset Summary Update SMF record. This
record type is optional. If present, it contains a hexadecimal X’20’ in the RRECTYPE field.
Table B-9.
Offsets
Dataset Update Summary Record Format
Name
Len
Format
Description
Common SMF Header. See Table B-5 on page B-6.
27
1B
RSUMADD
4
binary
Total number of records added.
31
1F
RSUMDEL
4
binary
Total number of records deleted.
35
23
RSUMUPDT
4
binary
Total number of records updated.
39
27
RSUMDES1
48
EBCDIC
Description line one.
87
57
RSUMDES2
48
EBCDIC
Description line two.
Writing a Dynamic SMF User Exit Program
You can create a user exit program that File-AID calls before writing the SMF record to the
SMF dataset. Compuware provides a sample program in the File-AID sample library
(SXVJSAMP) member UDASMFUX. Assembler DSECTS of the SMF record formats are
provided in member XVJSMFRH of the sample library (SXVJSAMP). Assemble the
modified UDASMFUX exit and place the object code in the File-AID object library using
sample library member UDALKSMF.
A user exit program must be dynamic. The exit program is loaded at File-AID/Data
Solutions startup. Complete the following steps to activate a dynamic user exit program:
1. Link-edit the UDASMFUX object and place the user exit load module in the File-AID
load library.
2. Modify the SMF exit name field in the audit exit program to reflect the name of the
dynamic user exit program. See “Audit Exit Parameter Layouts” on page A-7.
3. Assemble and link-edit the audit exit program.
4. A file, used to write the SMF record to, must exist with the following characteristics:
• DSORG = PS
B-10
File-AID Single Install Image Installation and Configuration Guide
• RECFM=VBS
• LRECL=32760
• BLKSIZE=32760
5. You must set up a TSO allocation to the file you are writing the SMF record to. Enter
this command:
ALLOC F(TESTSMF) DA(user supplied dataset) MOD
Writing an SMF Exit
When the exit program receives control from File-AID/Data Solutions, register 1 points to
a two-word parameter list that contains the following information:
Word 1
The dynamic working storage area of the exit.
Word 2
The SMF record about to be written.
On the final call to the exit program, word 2 contains zeros.
The exit program may execute any of the following tasks:
• Write the SMF record to another file.
• Modify the SMF record.
• Request that File-AID/Data Solutions not write the record to the SMF file.
When the exit program returns to File-AID/Data Solutions, register 15 must contain one
of the following codes:
0
File-AID/Data Solutions writes the SMF record to the SMF dataset.
4
File-AID/Data Solutions does not write the SMF record to the SMF dataset.
If a return code 0 or 4 is used, File-AID/Data Solutions takes the indicated action and
continues to return to the user exit each time a new SMF record is created.
8
File-AID/Data Solutions writes the dataset access SMF record plus all other SMF records.
12
File-AID/Data Solutions does not write the dataset access SMF record, and it does not create any
other SMF records for this dataset.
Return codes 8 and 12 are only valid from the initial call to the user exit for a new
dataset. Return codes 8 and 12 cause File-AID/Data Solutions to take the indicated action,
then process the dataset without returning to the exit program until another dataset is
accessed.
Date Pattern Exits
File-AID/Data Solutions uses date pattern exits to define and process the various date
formats. The exit converts your date to one of two standard formats (Gregorian or Julian)
and then converts the date back to its original format.
File-AID/Data Solutions Exits
B-11
Supplied Date Pattern Exits
Since Data Solutions is distributed with more than 50 date exits, it handles the vast
majority of the date formats you encounter in your data. Table B-10 describes the
characteristics of the sample formatted date pattern exits supplied with File-AID.
Table B-10. Supplied Date Pattern Exits
Load Module Name Date Pattern
Data
Type(s)
Description
Example
MONTH-DAY-YEAR
UDAA0100
MMDDYY
B,C,N,P
6 DIGIT Gregorian
090197
UDAA0102
MMDDCCYY
B,C,N,P
8 DIGIT Gregorian
09011997
UDAA0101
MM*DD*YY
C,N
8 CHAR. Gregorian
09/01/97
UDAA0103
MM*DD*CCYY
C,N
10 CHAR. Gregorian
09/01/1997
UDAA0112
MMMDDYY
C
7 CHAR. Gregorian
SEP0197
UDAA0113
MMM*DD*YY
C
9 CHAR. Gregorian
SEP/01/97
UDAA0114
MMMDDCCYY
C
9 CHAR. Gregorian
SEP011997
UDAA0115
MMM*DD*CCYY
C
11 CHAR. Gregorian
SEP/01/1997
UDAA0130
MDY
C
3 CHAR. Gregorian
090197 Pseudo packed.
UDAA0132
MMDDCCYYJJJ
B,C,N,P
11 DIGIT Gregorian/Julian
09011997244
UDAA0141
MMDDYYJJJ
B,C,N,P
9 DIGIT Gregorian/Julian
090197244
UDAA0137
MMYY
B,C,N,P
4 DIGIT Gregorian
0997 No day of month.
UDAA0140
MMCCYY
B,C,N,P
6 DIGIT Gregorian
091997 No day of month.
UDAA0104
YYMMDD
B,C,N,P
6 DIGIT Gregorian
970901
UDAA0106
CCYYMMDD
B,C,N,P
8 DIGIT Gregorian
19970901
UDAA0105
YY*MM*DD
C,N
8 CHAR. Gregorian
97/09/01
UDAA0107
CCYY*MM*DD
C,N
10 CHAR. Gregorian
1997/09/01
UDAA0138
DB2-TIMESTAMP
C,N
26 CHAR. Gregorian
1997-09-01- 23.59.59.999999
UDAA0116
YYMMMDD
C,N
7 CHAR. Gregorian
97SEP01
UDAA0117
YY*MMM*DD
C,N
9 CHAR. Gregorian
97/SEP/01
UDAA0118
CCYYMMMDD
C,N
9 CHAR. Gregorian
1997SEP01
UDAA0119
CCYY*MMM*DD
C,N
11 CHAR. Gregorian
1997/SEP/01
UDAA0124
YYMMDD-9COMP
B,C,N,P
6 DIGIT Gregorian
029098 (970901) 9’s complement
UDAA0125
CCYYMMDD-9COMP B,C,N,P
8 DIG. Gregorian
80029098 (19970901) 9’s
complement
UDAA0127
CYYMMDD-18
B,C,N,P
7 DIGIT Gregorian
0970901 (18970901) Digit 1:
0=18yy, 1=19yy, ETC.
UDAA0128
CYYMMDD
B,C,N,P
7 DIGIT Gregorian
0970901 (19970901) Digit 1:
0=19yy, 1=20yy, ETC.
UDAA0136
CYYMMDD-9COMP
B,C,N,P
7 DIGIT Gregorian
9029098 (19970901) Digit 1:
9=19yy, 8=20yy, ETC.
UDAA0133
CCYYMMDDJJJ
B,C,N,P
11 DIGIT Gregorian/Julian
19970901244
UDAA0134
CCYYJJJMMDD
B,C,N,P
11 DIGIT Gregorian/Julian
19972440901
UDAA0135
CFODATE
P
5+3 DIGIT Gregorian Two
separate packed fields.
02373001 (19970901)
MMMMMDDD (00001001 =
1/1/1800)
UDAA0209
YMD
C,M
3 Byte unsigned packed,
Gregorian
970901
UDAA0210
CYMD
C,M
4 Byte unsigned packed,
Gregorian
19970901
YEAR-MONTH-DAY
B-12
File-AID Single Install Image Installation and Configuration Guide
Table B-10. Supplied Date Pattern Exits (Continued)
Load Module Name Date Pattern
Data
Type(s)
Description
Example
UDAA0211
YMD-9COMP
C,M
3 Byte, unsigned packed, 9s 020998
compliment, Gregorian
UDAA0212
CYMD-9COMP
C,M
4 Byte, unsigned packed, 9s 80020998
compliment, Gregorian
UDAA0126
CCYYMM
B,C,N,P
6 DIGIT Gregorian
199709 No day of month.
UDAA0139
YYMM
B,C,N,P
4 DIGIT Gregorian
9709 No day of month.
UDAA0129
CCYY
B,C,N,P
4 DIGIT Gregorian
1997 Just year.
UDAA0131
YY
B,C,N,P
2 DIGIT Gregorian
97 Just year.
UDAA0108
DDMMYY
B,C,N,P
6 DIGIT Gregorian
010997
UDAA0110
DDMMCCYY
B,C,N,P
8 DIGIT Gregorian
01091997
UDAA0109
DD*MM*YY
C,N
8 CHAR. Gregorian
01/09/97
UDAA0111
DD*MM*CCYY
C,N
10 CHAR. Gregorian
01/09/1997
UDAA0120
DDMMMYY
C,N
7 CHAR. Gregorian
01SEP97
UDAA0121
DD*MMM*YY
C,N
9 CHAR. Gregorian
01/SEP/97
UDAA0122
DDMMMCCYY
C,N
9 CHAR. Gregorian
01SEP1997
UDAA0123
DD*MMM*CCYY
C,N
11 CHAR. Gregorian
01/SEP/1997
UDAA0200
YYDDD
B,C,N,P
5 DIGIT Julian
97244
UDAA0208
YYDDDHHMM
B,C,N,P
9 DIGIT Julian With time.
972442359
UDAA0201
CCYYDDD
B,C,N,P
7 DIGIT Julian
1997244
UDAA0202
00YYDDD
B,C,N,P
7 DIGIT Julian
0097244 (1997244) Digits 1-2:
00=19yy, 01=20yy, etc.
UDAA0203
YYDDD-9COMP
B,C,N,P
5 DIGIT Julian
02755 (97244) 9’s complement
UDAA0204
CCYYDDD-9COMP
B,C,N,P
7 DIGIT Julian
8002755 (1997244) 9’s
complement
UDAA0205
00YYDDD-9COMP
B,C,N,P
7 DIGIT Julian
9902755 (1997244) 9’s
complement and 99=19yy, etc.
98=18YY =
UDAA0206
CYYDDD
B,C,N,P
6 DIGIT Julian
097244 (1897244) Digit 1:
0=18yy, 1=19yy, etc.
UDAA0207
CYY-DDD
P
3+3 DIGIT Julian Two
separate packed fields.
197244 (1997244) Digit 1:
0=18yy, 1=19yy, etc.
UDAA0213
YYQ-QUARTAL
B,C,N,P
3 DIGIT Gregorian
973
UDAA0214
CCYYMMDD-MORIZ
B,C,N,P
8 DIGIT Gregorian
10029099
UDAA0215
CCYYMMDD-HYPER
B,C,N,P
8 DIGIT Gregorian
19970133
YEAR-MONTH
YEAR
DAY-MONTH-YEAR
JULIAN DATES
Miscellaneous
Customizing Date Pattern Exits
If you want to add your own date pattern exits for processing by Data Solutions, you
need to do the following:
1. Use one of the File-AID-provided COBOL date exits, AGERnnnn-named members in
the sample library (hlq.CPWR.MXVJA20.SXVJSAMP), as a model. Look for an exit that
is similar to your date pattern. Save it under a new date exit name, use AGER0700 –
AGER0999 if the exit is non-LE enabled or AGER1000 – AGER9999 if the exit is LE
File-AID/Data Solutions Exits
B-13
enabled. Make any modifications or adjustments required for your date pattern. Use
UDAEXITL to compile and link your new date pattern exit.
2. Identify your environment library names (refer to “Step 9. Specify External Files” on
page 2-13 in the Compuware Installer Compuware Product SMP/E Installation Guide).
3. Update DATELIST in SXVJSAMP to add your new date pattern exit.
4. Use sample JCL UDADLIST in the sample library (hlq.CPWR.MXVJA20.SXVJSAMP) to
assemble and link to LOAD module DATELIST in your Configuration LOAD library
(hlq.CPWR.MXVJA20.CXVJLOAD).
Each entry in the Date Pattern Exit Table consists of the following six fields:
Data type : Specify B (Binary), C (Character), G (Graphic, Double Byte Character Set), N
(Numeric), P (Packed), V (Variable length Character), or W (Variable length Graphic,
Variable length Double Byte Character Set). The data type is determined by the
record layout specified for the Formatted aging criteria. It has a length of one byte. If
your exit handles more than one data type, add a date entry for each data type to the
Date Pattern Exit Table (DATELIST).
Date pattern name : Specify a unique name alphanumeric 1 to 15 characters. The date
pattern name is the name that you specify on the Formatted Aging Criteria screen or
select from the Available Date Patterns screen.
Note:
The combination of name and data type must be unique. If multiple entries
have the same name and data type, only the load module of the first entry
will be executed.
Date length : Specify the number of bytes (not digits) that Data Solutions will pass to
and return from the date pattern exit. For example, packed 7 digits is 4 bytes.
Load module name : Specify the load module name of your new exit (AGER0700 –
AGER0999 if the exit is non-LE enabled or AGER1000 – AGER9999 if the exit is LE
enabled). It must begin with “AGER” and end with a four-digit number from 0700 to
9999. Numbers from 0000 to 0699 are reserved for date pattern exits written by
Compuware.
Description : Specify up to 30 characters describing your new date pattern exit. This
description is displayed on the Available Date Patterns screen.
Filler : Specify a 3 byte filler.
Hint
A suggestion to avoid assembling and linking DATELIST every time anyone at your site
wants to add a new date exit is to add a group of new entries at one time and assign one
or more to each programmer. Once the assigned date exit entry (hook) is linked into Data
Solutions, each programmer can modify and test their date pattern exits without
requiring a systems programmer to modify DATELIST.
Note:
To manually compile and link your new COBOL date exit, use the JCL that is
appropriate for your COBOL version.
Table B-11. Date Exit Compile/Link JCL
COBOL Version
Use JCL:
LE 370 / COBOL for MVS
UDAEXITL
Add the appropriate information (in Table B-11) for your COBOL date exit to the Date
Pattern Exit Table in Sample PDS member DATELIST. Use UDADLIST to reassemble and
link edit the table.
Figure B-1 on page B-14 shows the date pattern exit flow for File-AID/Data Solutions and
COBOL.
B-14
File-AID Single Install Image Installation and Configuration Guide
Figure B-1. File-AID/Data Solutions and COBOL Date Pattern Exit Flow
File‐AID/Data Solutions
Processing Order:
1. EXCLUDE Business Rules
2. Date Aging
3. NONWORKER Business Rules
4. HOLIDAY Business Rules
Read
Record
Date in CCYYMMDD
or
CCYYDDD
format
Call type 1
Data type
Date field
Convert date field
to CCYYMMDD or
CCYYDDD format
Write
Record
Call type 2 Day of week
New date in CCYYMMDD and/or CCYYDDD format
New date to put in record
Convert CCYYMMDD or CCYYDDD to original date format
COBOL DATE PATTERN EXIT
Field Level Exits
File-AID uses field level exits to define and process both Data Solutions-defined and userdefined business function data conversions. Data Solutions takes the specified data field,
passes it to the field level exit for conversion, and returns the new value to the data field.
File-AID is distributed with the field-level exits.
Table B-12. Data Solutions Field-Level Exits
Name
Description
Load module Name
ADD
Add
UDAE0104
DATA ANALYSIS
Analyze field for valid data
UDAE0110
DATE ANALYSIS
Analyze field for date pattern
UDAE0001
DATE DIFFERENCE
Calculate difference
UDAE0113
DIVIDE
Divide
UDAE0107
ENCRYPT
Encryption/Decryption
UDAE0101
ENCRYPTN
Treat numeric CHAR as NUMERIC
UDAE0121
EURO-DATE
European Currency Conversion based on dates
entered by user
UDAE0117
EURORATE
European Currency Conversion
UDAE0100
EURORATE-USER
European Currency Conversion
UDAE1000
File-AID/Data Solutions Exits
B-15
Table B-12. Data Solutions Field-Level Exits (Continued)
Name
Description
Load module Name
GENDATE
Test Date Generator
UDAE0102
GLOBAL
Use Global Area
UDAE0108
MOD-10
Non-standard Check Digit Numeric MOD-10
UDAE0114
MOD-10 LUHN
Standard Check Digit Numeric MOD-10 (LUHN
UDAE0118
algorithm - used to validate identification numbers,
such as credit card numbers, IMEI numbers, National
Provider Identifier numbers in US and Canadian Social
Insurance Numbers.)
MOD-11
Check Digit Numeric MOD-11
UDAE0115
MOD-ALPHA
Check Digit Alphanumeric
UDAE0116
MOVE FIELD
Move field
UDAE0003
MULTIPLY
Multiply
UDAE0106
REPLACE
Field Replacement
UDAE0200
RESEQ
Resequencing
UDAE0103
SUBTRACT
Subtract
UDAE0105
Note:
Source code is not provided for DATA ANALYSIS (EXIT0110), DATE ANALYSIS
(EXIT0001), ENCRYPTN (EXIT0121), EURO-DATE (EXIT0117), EURORATE
(EXIT0100), MOVE FIELD (EXIT0003), and DATE DIFFERENCE (EXIT0113).
If you want to add your own field-level exits for processing by File-AID, you need to do
the following:
1. Use one of the File-AID-provided COBOL field-level exits, EXITnnnn-named members
in the sample library (hlq.CPWR.MXVJA20.SXVJSAMP), as a model. Save it under a
new exit name EXIT0700 – EXIT0999 if the exit is non-LE enabled or EXIT1000 –
EXIT9999 if the exit is LE enabled. Make your modifications. Use UDAEXITL to
compile and link your new field exit.
2. Identify your environment library names (refer to “Step 9. Specify External Files” on
page 2-13 in the Compuware Installer Compuware Product SMP/E Installation Guide).
3. Update EXITLIST in SXVJSAMP to add your new field exit.
4. Use sample JCL UDAELIST in the sample library (hlq.CPWR.MXVJA20.SXVJSAMP) to
assemble and link to LOAD module EXITLIST in your Configuration LOAD library
(hlq.CPWR.MXVJA20.CXVJLOAD).
Each entry in the Field-Level Exit Table consists of the following fields:
Data type : Specify B (Binary), C (Character), G (Graphic, Double Byte Character Set), N
(Numeric), P (Packed), V (Variable length Character), or W (Variable length Graphic,
Variable length Double Byte Character Set). The data type is determined by the
record layout specified for the field exit criteria. It has a length of one byte. If your
exit handles more than one data type, add an entry for each data type supported to
the Field-Level Exit Table (EXITLIST).
Field-level exit name : Specify a unique name alphanumeric 1 to 15 characters. The exit
name is the name that you specify on the Formatted Field Exit Criteria screen or
select from the Available Field Exits screen.
Note:
The combination of name and data type must be unique. If multiple entries
have the same name and data type, only the load module of the first entry
will be executed.
Field length : Specify the maximum number of bytes (not digits) that Data Solutions will
pass to and return from the field exit. For example, packed 7 digits is 4 bytes. (An exit
can process fields of various lengths.)
B-16
File-AID Single Install Image Installation and Configuration Guide
Load module name : Specify the load module name of your new exit (EXIT0700 –
EXIT0999 if the exit is non-LE enabled or EXIT1000 – EXIT9999 if the exit is LE
enabled). It must begin with “EXIT” and end with a four-digit number from 0700 to
9999. Numbers from 0000 to 0699 are reserved for field-level exits written by
Compuware.
Description : Specify up to 30 characters describing your new field-level exit. This
description is displayed on the Available Field Exits screen.
Filler : Specify a 3 byte filler.
Note:
For encryption/decryption exit the first byte of “Filler” is used for an exit
type descriptor of E. This allows File-AID to differentiate when displaying
Available Field Exits for Option 6 (Field Exits) and Available
Encryption/Decryption Exits for Option 7 (Data Encryption).
Hint
A suggestion to avoid assembling and linking EXITLIST every time anyone at your site
wants to add a new field exit is to add a group of new entries at one time and assign one
or more to each programmer. Once the assigned field-level exit entry (hook) is linked
into Data Solutions, each programmer can modify and test their field exits without
requiring a systems programmer to modify EXITLIST.
Note:
To compile and link edit your new COBOL field-level exit, use the JCL that is
appropriate for your COBOL version.
Table B-13. Field-Level Exit Complile/Link JCL
COBOL Version
Use JCL:
LE 370 / COBOL for MVS
UDAEXITL
Add the appropriate information (listed above) for your COBOL field-level exit to the
Field-Level Exit Table in Sample PDS member EXITLIST. Use UDAELIST to reassemble and
link edit the table.
Encryption Routine Exits
The Data Encryption function simplifies the process of encrypting and decrypting a data
file. Data Solutions uses encryption/decryption exits to define and process both Data
Solutions-defined and user-defined encryption routines. Simply choose a routine for a
particular field from Data Solutions’ list of Available Encryption/Decryption Exits. With
the use of selection criteria, you can assign an encryption routine to a field based on the
data in that field or on the data in another field in the record.
The Key Encrypt/Decrypt Exits (both ENCRYPT and ENCRYPTN) are Data Solutionsdefined encryption exits. See “Key Encrypt/Decrypt Exits” on page B-17 for more
information on Key Encrypt/Decrypt Exits.
ENCRYPTN is the same as the ENCRYPT exit, except that it treats a character field that is
entirely numbers and has a length of 18 bytes or less, as if the field was defined as
numeric.
Besides the Key Encrypt/Decrypt Exits, two sample encryption/decryption routines are
provided with Data Solutions. You can use one of the sample encryption/decryption
routines or create your own routine. See “Creating Your Own Encryption/Decryption
Exits” on page B-20 for information on creating your own encryption/decryption routine
and adding it to the Available Encryption/Decryption Exits list.
The Data Encryption function can be accessed by selecting Option 7 (Data Encryption)
from the Primary Option Menu.
File-AID/Data Solutions Exits
B-17
Input and Output Specifications
The input and output options are the same for each File-AID/Data Solutions function.
Refer to the "Product Conventions" chapter in the File-AID/Data Solutions User Reference
manual for a sample and field descriptions of these screens. In addition, the Criteria
Menu is displayed within each File-AID function. Refer to the "Product Conventions"
chapter of the File-AID/Data Solutions User Reference manual for a description of the Criteria
Menu.
Key Encrypt/Decrypt Exits
The Key Encrypt/Decrypt exits (both ENCRYPT and ENCRYPTN) include record level and
field level encryption/decryption. The user has the ability to apply an encryption key of
up to 248 bytes for both the record and field level exits. If applied, this key must be
supplied to correctly decrypt the file. The application of an encryption key provides an
additional level of security that was not available in the previous versions.
Field Level Exit (with encryption key)
Field Level encryption enables the user to encrypt individual fields. Using the field level
exit with an encryption key provides a more sophisticated and secure algorithm. To
supply an encryption key to the field level exit, specify E to encrypt or D to decrypt
followed by one space then the encryption/decryption key. As shown in Figure B-2, the
EMP-FIRST-NAME field will be encrypted using the “samplekey” encryption key. For
added security, you can code DSN=dataset name instead of the actual encryption key. At
execution time, File-AID reads the named dataset and uses the encryption key specified
in the dataset. This facilitates hiding the encryption key. Refer to the "Data Encryption"
chapter in the File-AID/Data Solutions User Reference manual for more information.
Note:
Different keys yield different results.
Figure B-2. Field Level Exit (with encryption key)
Action Sets Display Show Options Menu Help

-------------------------------------------------------------------------------
File-AID ------- Data Encryption Criteria ----------------------
COMMAND ===>
SCROLL ===> PAGE 

SET 1 OF 1
EMPLOYEE-MASTER-FILE
GBL = N SEL = N
---- FIELD LEVEL/NAME ------- -FORMAT- RO ----PARAMETERS---- + ENCRYPTION NAME 
******************************* TOP OF DATA ***********************************
5 EMP-NUMBER
5/AN

5 EMP-LAST-NAME
15/AN

5 EMP-FIRST-NAME
10/AN
EX E samplekey
ENCRYPT

5 EMP-MID-INIT
1/AN

5 FILLER
2/AN

5 EMP-TITLE
30/AN

5 EMP-PERSONAL-INFO SYNC
23/GRP

10 EMP-NATL-ID-NUMBER
9/NUM

10 FILLER
1/AN

10 EMP-DATE-OF-BIRTH
6/AN

10 EMP-DOB-REDEF REDEFINES EMP-DATE-OF-BIRTH

10 EMP-DOB-REDEF SYNC
6/GRP

15 EMP-DOB-MM
2/NUM

15 EMP-DOB-DD
2/NUM

Valid RO: EX, EP, FM - For a list of exits, leave ENCRYPTION NAME blank.

Commands: SELect, GBL, View 
The EMP-FIRST-NAME field will now be encrypted with the samplekey encryption key
and the user will need to provide this key to decrypt the field.
The following rules must be followed when using an encryption key:
• The encryption key must contain alphanumeric characters (A-Z) or (0-9).
• The encryption key is not case sensitive for encryption or decryption exits.
B-18
File-AID Single Install Image Installation and Configuration Guide
• The encryption key length cannot exceed 248 bytes.
• Exactly one space is required between E or D and the encryption key supplied by the
user.
• You must specify the encryption key on the Field Exit Parameters screen, if its length
is greater than 16 characters. This panel is displayed by entering EP in the RO
column.
• After applying field level encryption, the format of the encrypted fields is preserved
and the encrypted file can be used for testing purposes.
• To maintain sign integrity on zoned decimal fields you must specify a Field Mask.
This will assure the sign never changes. See the "Product Conventions" chapter in the
File-AID/Data Solutions User Reference manual for a description of its features.
Field Level Exit (without encryption key)
The Field Level exit without the encryption key provides encryption identical to the
original non-keyed encryption exit available in prior releases. As shown in Figure B-3, the
encryption key is omitted.
Figure B-3. Field Level Exit (without encryption key)
Action Sets Display Show Options Menu Help

-------------------------------------------------------------------------------
File-AID ------- Data Encryption Criteria ----------------------
COMMAND ===>
SCROLL ===> PAGE 

SET 1 OF 1
EMPLOYEE-MASTER-FILE
GBL = N SEL = N
---- FIELD LEVEL/NAME ------- -FORMAT- RO ----PARAMETERS---- + ENCRYPTION NAME 
******************************* TOP OF DATA ***********************************
5 EMP-NUMBER
5/AN

5 EMP-LAST-NAME
15/AN

5 EMP-FIRST-NAME
10/AN
EX E
ENCRYPT

5 EMP-MID-INIT
1/AN

5 FILLER
2/AN

5 EMP-TITLE
30/AN

5 EMP-PERSONAL-INFO SYNC
23/GRP

10 EMP-NATL-ID-NUMBER
9/NUM

10 FILLER
1/AN

10 EMP-DATE-OF-BIRTH
6/AN

10 EMP-DOB-REDEF REDEFINES EMP-DATE-OF-BIRTH

10 EMP-DOB-REDEF SYNC
6/GRP

15 EMP-DOB-MM
2/NUM

15 EMP-DOB-DD
2/NUM

Valid RO: EX, EP, FM - For a list of exits, leave ENCRYPTION NAME blank.

Commands: SELect, GBL, View 
Record Level Exit (with encryption key)
Record level encryption enables the user to:
• encrypt an entire record
• transfer data files from one location to another with a degree of security.
Because record level encryption enables transfer of data, it supports the application of a
user written or an industry standard encryption routine.
A sample routine for record level encryption is provided on the distribution media for
the extension. This routine is provided in both source (EXITR101) and object
(UDAER101). The sample encrypts data in a fashion that makes it unusable until it has
been decrypted at the target location.
To supply record level encryption with encryption key, specify R immediately following
(without typing the space) the E to encrypt or D to decrypt. The encryption key,
“HELLO” immediately follows the letter R as shown in Figure B-4.
File-AID/Data Solutions Exits
B-19
Figure B-4. Record Level Exit (with encryption key)
Action Sets Display Show Options Menu Help

-------------------------------------------------------------------------------
File-AID ------- Data Encryption Criteria ----------------------
COMMAND ===>
SCROLL ===> PAGE 

SET 1 OF 1
EMPLOYEE-MASTER-FILE
GBL = N SEL = N
---- FIELD LEVEL/NAME ------- -FORMAT- RO ----PARAMETERS---- + ENCRYPTION NAME 
******************************* TOP OF DATA ***********************************
5 EMP-NUMBER
5/AN

5 EMP-LAST-NAME
15/AN

5 EMP-FIRST-NAME
10/AN
EX ERHELLO
ENCRYPT

5 EMP-MID-INIT
1/AN

5 FILLER
2/AN

5 EMP-TITLE
30/AN

5 EMP-PERSONAL-INFO SYNC
23/GRP

10 EMP-NATL-ID-NUMBER
9/NUM

10 FILLER
1/AN

10 EMP-DATE-OF-BIRTH
6/AN

10 EMP-DOB-REDEF REDEFINES EMP-DATE-OF-BIRTH

10 EMP-DOB-REDEF SYNC
6/GRP

15 EMP-DOB-MM
2/NUM

15 EMP-DOB-DD
2/NUM

Valid RO: EX, EP, FM - For a list of exits, leave ENCRYPTION NAME blank.

Commands: SELect, GBL, View 
• The encryption key length cannot exceed 248 bytes.
• Record level encryption can be specified on any field, but the exit will be executed
only once per record.
• After applying record level encryption, the format of the encrypted fields is not
preserved and the encrypted file cannot be used for testing purposes.
If you wish to add/write your own Record Level Encryption Exit or apply an industry
standard routine, you need to review the EXIT in member EXITR101 in the sample library
(CPWR.MXVJA20.SXVJSAMP). The object module name for this exit must be UDAER101,
but the CSECT name for this exit must be EXITR101.
To link a user written Record Level Encryption Exit, use the JCL located in the Sample
PDS member UDALR101.
Encryption Key Considerations
Remembering the Encryption Key
The encryption key is saved in the Change Criteria dataset on the COPY Execution
Options screen, if the Save change criteria field is set to Y, unless the DSN=dataset name
option was used.
If you cannot recall the encryption key, you can retrieve it by browsing the Change
Criteria member and/or the encryption key file. If you forget the Change Criteria dataset
and member and/or the encryption key file name, the encryption key cannot be
retrieved.
You cannot decrypt any encrypted fields without the encryption key. An UPDATE is not
allowed for this reason.
You must use the “Copy” function to use the Encryption/Decryption Extensions. The
Copy function enables access to the original data even if you forget the encryption key as
the original data is the source file and not the target.
Securing the Encryption Key
To secure the encryption key, replace the key with DSN=dataset name, where dataset
name is the fully-qualified dataset name of a file that contains the actual encryption key,
beginning in position 1 of the first record. The file can be secured using your standard
B-20
File-AID Single Install Image Installation and Configuration Guide
security system (e.g. RACF). This method is available for the ENCRYPT and ENCRYPTN
field exits only.
If you do not use this method to secure the encryption key, then the key may not be
secure. The encryption key is saved in the Change Criteria dataset, and a user with read
access to the Change Criteria dataset also has access to the encryption key.
To secure the Change Criteria dataset, use your standard security system (e.g., RACF) to
guard against undesired access.
Using an Incorrect Encryption Key
If an incorrect encryption key is used to decrypt a file, then the resulting file will not be
equivalent to the original file.
To undo these changes, you must execute an encryption using the same incorrect
encryption key. You can then execute the decryption, using the correct encryption key.
Running Consecutive Encryptions
Encrypting a file twice requires decrypting the same file two times to retrieve the original
data. The decryption must be performed in the opposite order the encryption was
performed.
For example, if a file was encrypted using keys A and B then to decrypt the file, you must
use keys B and A to retrieve your original data file.
Keyed VSAM, DB2, or IMS files
Encryption/Decryption Extensions can be used for keyed VSAM, DB2 or IMS files. Special
attention must be paid to ensure that the key field(s) remain in sequence.
To avoid errors, follow the steps below for a encrypted key field:
1. Specify a sequential file as the encryption output.
2. Sort the sequential file by the key.
3. Load the sequential file into a new VSAM, DB2 or IMS file.
Note:
Record level encryption for VSAM, DB2 and/or IMS files must follow the steps
listed above.
If the key field is not one of the fields being encrypted, then encryption can proceed
without further considerations.
Creating Your Own Encryption/Decryption Exits
File-AID/Data Solutions uses encryption/decryption exits to define and process both
File-AID-defined and user-defined encryption routines. File-AID takes the specified data
field, passes it to the encryption exit for conversion, and returns the new value to the
data field. File-AID is distributed with the following sample encryption/decryption exits.
Table B-14. Data Solutions Encryption/Decryption Exits
Name
Description
Load module Name
ENCRYPT-1
Sample ENCRYPT/DECRYPT Exit 1
UDAE0111
ENCRYPT-2
Sample ENCRYPT/DECRYPT Exit 2
UDAE0112
If you want to add your own encryption/decryption exits for processing by File-AID, you
need to do the following:
1. Use one of the File-AID-provided COBOL encryption exits, EXIT0111 and EXIT0112
in the Sample PDS, as a model. Save it under a new exit name EXIT0700 – EXIT0999
File-AID/Data Solutions Exits
B-21
if the exit is non-LE enabled or EXIT1000 – EXIT9999 if the exit is LE enabled. Make
your modifications.
2. Identify your COBOL environment library names (refer to “REQUIRED SYSTEM
DATASETS” on page 2-24).
3. Use JCL provided in SXVJSAMP (refer to Table B-15)to compile/link-edit.
Each entry in the Field-Level and Encryption Exit Table consists of the following fields:
Data type : Specify B (Binary), C (Character), G (Graphic, Double Byte Character Set), N
(Numeric), P (Packed), V (Variable length Character), or W (Variable length Graphic,
Variable length Double Byte Character Set). The data type is determined by the
record layout specified for the encryption criteria. It has a length of one byte. If your
exit handles more than one data type, add an entry for each data type supported to
the Exit Table (EXITLIST).
Encryption exit name : Specify a unique name alphanumeric 1 to 15 characters. The
exit name is the name that you specify on the Data Encryption Criteria screen or
select from the Available Encryption/Decryption Exits screen.
Note:
The combination of name and data type must be unique. If multiple entries
have the same name and data type, only the load module of the first entry
will be executed.
Field length : Specify the maximum number of bytes (not digits) that File-AID will pass
to and return from the field exit. For example, packed 7 digits is 4 bytes. (An exit can
process fields of various lengths.)
Load module name : Specify the load module name of your new exit (EXIT0700 –
EXIT0999 if the exit is non-LE enabled or EXIT1000 – EXIT9999 if the exit is LE
enabled). It must begin with “EXIT” and end with a four-digit number from 0700 to
9999. Numbers from 0000 to 0699 are reserved for exits written by Compuware.
Description : Specify up to 30 characters describing your new encryption exit. This
description is displayed on the Available Encryption/Decryption Exits screen.
Exit Type : Specify an E in this field for an encryption/decryption exit. This allows
File-AID to differentiate when displaying Available Field Exits for Option 6 (Field
Exits) and Available Encryption/Decryption Exits for Option 7 (Data Encryption).
Filler : Two byte filler.
Hint
A suggestion to avoid assembling and linking EXITLIST every time anyone at your site
wants to add a new field or encryption exit is to add a group of new entries at one time
and assign one or more to each programmer. Once the assigned EXITLIST entry (hook) is
linked into File-AID, each programmer can modify and test their exits without requiring
a systems programmer to modify EXITLIST.
Note:
To compile and link-edit your new COBOL encryption exit, use the JCL that is
appropriate for your COBOL version.
Table B-15. Field-Level and Encryption Exit Compile/Link JCL
COBOL Version
Use JCL:
LE 370 / COBOL for MVS
UDAEXITL
Add the appropriate information (listed above) for your COBOL encryption exit to the
Field-Level Exit Table in Sample PDS member EXITLIST. Use UDAELIST to reassemble and
link-edit the table.
B-22
File-AID Single Install Image Installation and Configuration Guide
C-1
Appendix C.
Call to File-AID/Data Solutions with the API
Appendix A.
The File-AID/Data Solutions API (Application Programming Interface) provides access to
File-AID/Data Solutions from existing programs that will utilize any of the File-AID/Data
Solutions functionality like Encryption and Euro Conversion.
Sample Programs
The sample dataset (hlq.CPWR.MXVJA20.SXVJSAMP) of File-AID/Data Solutions includes
14 members that begin with CBL*****. These members are sample programs and required
parameter layouts that demonstrate how the call works.
Note:
The HLL program that calls Data Solutions for the Dynamic Privacy Rules (DPR)
process should not use SYSIN file processing. If SYSIN is used, the following error
message will be displayed in the JES job log:
hh.mm.ss jobnumber $HASP708 jobname SYSIN OPEN FAILED 
nnn RC=03 DATA SET ALREADY OPENED 
nnn DSNAME=userid.jobname.jobnumber.Dnnnnnnnn.? 
hh.mm.ss jobnumber IEC141I 013-C0,IGG0199G,jobname,stepname,SYSIN
CBLCALL1 and CBLCALL2 are two sample programs that perform the call but in two
different ways.
1. CBLCALL1 is the easier of the two sample programs because it uses the DD01SC
(criteria dataset) allocated in the JCL. You build the change criteria with the
File-AID/Data Solutions on-line interface and save it in a file that DD01SC points to.
2. CBLCALL2 begins with the same four parameters as CBLCALL1. Following the first
four parameters is one parameter for each logical change criteria set. This is a more
complicated program because it builds the change criteria within the program.
Therefore, there are more parameters to set. This does not require you to build the
change criteria online.
In the CBLCALL2 sample program there is a variable called 'USE-THIS-SET'. This flag
gives you the ability to turn on and off individual sets for different calls to Data
Solutions. The CBLCALL2 program is not required to use this flag because you could
have done both changes with one call.
3. The CBLAPI0* members in the Sample dataset are the layouts for the extra parameters
needed for CBLCALL2. Currently the 'function code' is a numeric value between '0'
(zero) and '8' (eight) representing the following 'functions':
Table C-1. CBLAPI0* Function Codes
Function Code
Description
0
Field exit criteria
1
Date aging criteria
2
Eurorate criteria
3
Euro triangulate criteria
4
Date analysis criteria
5
Data translator criteria
C
C-2
File-AID Single Install Image Installation and Configuration Guide
Table C-1. CBLAPI0* Function Codes (Continued)
Function Code
Description
6
Data generator criteria
7
Data validation criteria
8
Data analysis criteria
There are four parameters needed for every program that calls File-AID/Data Solutions.
CBL1OPTS, CBL2CNTL and CBL3MSGS are the layouts for the first three parameters
needed in both sample programs. CBLAPI00 is the fourth parameter that points to the
data in which the calling program instructs Data Solutions to encrypt/decrypt. The
sequence of the passed parameters is important. Use the enclosed sample program as a
guide. The referenced parameters will be discussed in detail for clarity.
CBL1OPTS
The first required parameter in the parameter list is the Install Option Override
(CBL1OPTS). This parameter is used to change the installed default options in
File-AID/Data Solutions. Refer to “Modify Batch Options at Execution” on page 5-6 for
more information. There should be no reason to change these options unless you wish to
override the currently installed options.
Figure C-1. CBL1OPTS
******************************************************************
*
FILE-AID/DATA SOLUTIONS INSTALL OPTION OVERRIDE
*
******************************************************************
01 :X:-INSTALL-OPTION-OVERRIDE.
*
IF YOU DO NOT NEED TO OVERRIDE ANY OF THE FILE-AID/DATA
*
SOLUTIONS INSTALL OPTIONS AT YOUR SITE, THEN YOU DO NOT NEED
*
TO MODIFY THIS PARAMETER.
05
:X:-PARAMETER-LENGTH
VALUE 0.
PIC 9(4)
BINARY
05
:X:-PARAMETER OCCURS 0 TO 100 TIMES
DEPENDING ON :X:-PARAMETER-LENGTH
PIC X.













CBL2CNTL
The second required parameter is the Control Area (CBL2CNTL). This parameter provides
Data Solutions with the source location and size of the data to be modified. The
parameter instructs File-AID/Data Solutions to begin or end the modification process. It
also provides Data Solutions with the number of requested functions that are to be
initiated against the data. The maximum number of bytes (not digits) that can be passed
to Data Solutions in the :X:-LENGTH-OF-DATA field is 32,760 bytes. For example, packed
7 digits would be 4 bytes.
Note:
You must set :X:-MAXIMUM-DATA-LENGTH in the COBOL program to the
largest number of bytes passed to Data Solutions during the job step. 

If you created a call program prior to Data Solutions Release 10.1, and you
receive the message INVALID API MAXIMUM DATA LENGTH, CANNOT BE < DATA
LENGTH , then you need to update, recompile, and relink the CBLCALL1 program.
Call to File-AID/Data Solutions with the API
C-3
Figure C-2. CBL2CNTL
******************************************************************
*
FILE-AID/DATA SOLUTIONS CONTROL AREA
*
******************************************************************
01 :X:-DATA-SOLUTIONS-CONTROL.
05
FILLER
VALUE 'SOLUTION'.
RESERVED (USER MUST NOT MODIFY)
PIC X(08)
05
FILLER
VALUE '02.00.00'.
RESERVED (USER MUST NOT MODIFY)
PIC X(08)
05
FILLER
VALUE 0.
RESERVED (USER MUST NOT MODIFY)
PIC 9(08)
05
:X:-CALL-TYPE
VALUE 'EXEC'.
MUST BE 'EXEC' OR 'STOP'
PIC X(04)
05
:X:-LENGTH-OF-DATA
PIC 9(08)
VALUE 0.
LENGTH OF RECORD OR DATA PASSED TO DASOLUTN
*
*
*
*
*
*
* IMPORTANT!
*
*
:X:-CRITERIA-LOCATION
PIC X(01)
VALUE '1'.
MUST BE '1' (FILE ALLOCATED TO DD01SC DDNAME)
OR '2' (PARAMETER LIST)
OR '3' (FILE SPECIFIED IN DSCICDSN)
05
FILLER
VALUE SPACES.
RESERVED (USER MUST NOT MODIFY)
05
:X:-NUMBER-OF-SETS
PIC 9(08)
VALUE 0.
USED WHEN CRITERIA-LOCATION IS SET TO '2'
05
:X:-CRITERIA-FILE-NAME
PIC X(44)
VALUE SPACES.
USED WHEN CRITERIA-LOCATION IS SET TO '3'


:X:-CRITERIA-MEMBER
PIC X(08) 
VALUE SPACES.

USED WHEN CRITERIA-LOCATION IS SET TO '3'

*
*
*
05
*

BINARY
THE CALLER OF FILE-AID/DATA SOLUTIONS MAY NOT CHANGE
ANY OF THE FOLLOWING FIELDS AFTER THE FIRST CALL.
05
*
*
*
BINARY
PIC X(03)
BINARY
05
FILLER
VALUE 0. 
UNUSED 
PIC 9(08)
BINARY 
05
:X:-MAXIMUM-DATA-LENGTH
PIC 9(08)
VALUE 0. 
LONGEST LENGTH OF RECORD OR DATA 
THAT WILL BE PASSED TO DASOLUTN 
BINARY 
*

*
*














































CBL3MSGS
The third parameter is the Message Area (CBL3MSGS). This parameter contains the return
code from the File-AID/Data Solutions process, the number of messages received as a
result of the call execution of File-AID/Data Solutions, and the maximum number of
messages that can be passed to the calling program from File-AID/Data Solutions. Set the
maximum number of messages that can be received by the calling program.
File-AID/Data Solutions will pass the error messages along with the data. The calling
program will decide how to handle the errors. The severity of the error will determine if
the data is changed. The execution of an illogical instruction will cause File-AID/Data
Solutions to abend.
C-4
File-AID Single Install Image Installation and Configuration Guide
Figure C-3. CBL3MSGS
******************************************************************
*
FILE-AID/DATA SOLUTIONS MESSAGE AREA
*
******************************************************************
01 :X:-DATA-SOLUTIONS-MESSAGE.


05 :X:-RETURN-CODE
PIC 9(8) BINARY.

*
SAME VALUE AS REGISTER 15

*
IF 00, ALL IS WELL

*
IF 04, NUMBER-OF-MESSAGES > NUMBER-OF-SLOTS

*
IF 08, INVALID PARAMETER FOUND

*
IF 12, SEVERE ERRORS

*
IF 16, COMPUWARE SECURITY VIOLATION


05 :X:-NUMBER-OF-MESSAGES
PIC 9(8) BINARY.

*
FILLED BY DATA SOLUTIONS


05 :X:-NUMBER-OF-SLOTS
PIC 9(8) BINARY

VALUE 5.

*
USER MAY INCREASE OR DECREASE THIS NUMBER


05 :X:-MESSAGE OCCURS 1 TO 5 TIMES

DEPENDING ON :X:-NUMBER-OF-SLOTS

PIC X(132).

*
FILLED BY DATA SOLUTIONS
CBLAPI00
The next required parameter is the data to be modified. The data may be a single field or
the data may be in a record layout. The length of the data cannot be greater than 32,760
bytes.
The last parameter that is required for the encryption/decryption process is the Field Exit
Criteria (CBLAPI00). This parameter provides the necessary information that describes
the data that is to be encrypted/decrypted. There are three options of encryption
algorithms that can be used, "ENCRYPT", "ENCRYPT-1", and "ENCRYPT-2". You can apply
an encryption key of up to 248 bytes with the "ENCRYPT" algorithm. If utilized, this key
must be supplied to correctly decrypt the data as well. Refer to the Field Level Exit (with
encryption key) section on page 10-1 in the File-AID/Data Solutions User Reference manual.
Call to File-AID/Data Solutions with the API
Figure C-4. CBLAPI00
******************************************************************
*
FILE-AID/DATA SOLUTIONS FIELD EXIT CRITERIA
*
******************************************************************
01 :X:-FIELD-EXIT-CRITERIA.

05 :X:-FUNCTION-CODE
PIC 9(04) BINARY

VALUE 0.

*
RESERVED (USER MUST NOT MODIFY) 
05 :X:-FIELD-COUNT
PIC 9(04) BINARY

VALUE 1.

*
MUST BE THE NUMBER OF FIELDS (MAXIMUM OF 10) THAT WILL 
*
BE PROCESSED WITHIN THIS SET
05 :X:-XREF-BASE-NUMBER
PIC 9(04)

VALUE 0.

05 :X:-XREF-SEGMENT-NUMBER
PIC 9(04)

VALUE 0.

05 :X:-USE-THIS-SET
PIC X(01)

VALUE 'Y'.

*
MUST BE 'Y' OR 'N'

05 :X:-FIELD-CRITERIA OCCURS 1 TO 10 TIMES

DEPENDING ON :X:-FIELD-COUNT.

*
FILLED BY DATA SOLUTIONS
10 :X:-STATEMENT
PIC X(02)

VALUE '06'.

*
RESERVED (USER MUST NOT MODIFY) 
10 :X:-POSITION
PIC 9(05).

*
POSITION OF FIELD TO BE MODIFIED 
10 :X:-LENGTH
PIC 9(05).

*
LENGTH OF FIELD TO BE MODIFIED
10 :X:-OPERATOR
PIC X(02)

VALUE 'EX'.

*
MUST BE 'EX' FOR PROGRAMS PASSING PARAMETERS
10 :X:-TYPE
PIC X(01).

*
MUST BE 'EX' FOR PROGRAMS PASSING PARAMETERS
*
'B' (BINARY)
10 :X:-VALUE.

15 :X:-FIELD-EXIT-PARMS
PIC X(250)

VALUE SPACES.

*
MUST BE 'E' (ENCRYPTION) OR 'D' (DECRYPTION) 
*
WITH ENCRYPT KEY, MUST BE 'E SAMPLEKEY' OR
*
WITH DECRYPT KEY, MUST BE 'D SAMPLEKEY' 
15 :X:-DATE-DIFFERENCE-PARMS REDEFINES

:X:-FIELD-EXIT-PARMS.
20 :X:-DD-DATE-CONSTANT
PIC 9(08).

*
GREGORIAN DATE FORMAT CCYYMMDD

20 FILLER
PIC X(01).

20 :X:-DD-GLOBAL-SLOT
PIC 9(01).

*
GLOBAL NUMERIC AREA FOR RESULT

20 FILLER
PIC X(01).

20 :X:-DD-DATE-PATTERN
PIC X(15).

*
DATE PATTERN OF FIELD

20 FILLER
PIC X(01).

20 :X:-DD-PIVOT-YEAR
PIC 9(02).

*
OPTIONAL (WHEN YEAR IS ONLY TWO DIGITS)

20 FILLER
PIC X(221).

10 :X:-FIELD-EXIT-NAME
PIC X(15).

*
USE 'ENCRYPT', 'ENCRYPT-1', OR 'ENCRYPT-2' FOR
*
ENCRYPTION/DECRYPTION PROCESSING
C-5
C-6
File-AID Single Install Image Installation and Configuration Guide
COBOL API JCL Setup for Data Privacy (DPR)
When you want to use your COBOL program with File-AID/Data Solutions’ Data Privacy
option (File-AID/Data Solutions Primary Option D, Data Privacy - Dynamic Privacy
Rules), use the online File-AID/Data Solutions to prepare sample JCL that you can then
modify for use with your COBOL program.
1. Start a File-AID/Data Solutions mainframe online session.
Figure C-5. File-AID/Data Solutions Primary Option Menu
File-AID/Data Solutions
OPTION ===> D

0
1
2
3
4
5
6
7
8
D
U
S
R
C
T
X
Parameters
Date Aging
Euro Tools
Data Analyzer
Translator
Generation
Field Exits
Encryption
Replace
Data Privacy
Utilities
Criteria Sets
XREF
Changes
Tutorial
Exit
-
10.2
--- Primary Option Menu ------------------------
USERID
Data Solutions Parameters
TIME
Date Aging Solutions
TERMINAL
Currency Conversions
PF KEYS
Analysis Solutions
Data Translator
Data Generation Solutions
Formatted Field Exits
Data Encryption
Data Replace
Dynamic Privacy Rules
Print and File Override Utilites
Create or modify Criteria sets
Create or change record layout cross reference
Display summary of Data Solutions changes
Display information about Data Solutions
Terminate Data Solutions and return to ISPF
-
USERID1
11:07
3278
12
Online Technical Support available at: go.compuware.com
Copyright (c) 1997 - 2014. All rights reserved. Unpublished
rights reserved under the Copyright Laws of the United States.
Type LEGAL on the command line for Copyright/Trade Secret Notice.
2. Enter D to select Option D, Data Privacy.
Figure C-6. Input Dataset Specification Screen
File-AID/Data Solutions ------- Input Dataset Specification -------------
COMMAND ===> 

Specify Input Dataset Information:
Dataset name
===> DASAMP.INVFILE
Member name
===>
(Blank or pattern for member list)
Disposition
===> OLD
(OLD or SHR) 

Specify Record Layout Information and XREF Information:
Record layout usage
===> S
(S = Single; X = XREF)
Record layout dataset ===> DASAMP.LAYOUTS
Member name
===> INVFILE
(Blank or pattern for member list)
XREF dataset name
===>
Member name
===>
(Blank or pattern for member list)

Specify Dynamic Privacy Rule Information:
Repository name
===> File-AID Rules
Project name
===> Train
3. Enter Input Dataset Information, Record Layout and XREF Information, and
Dynamic Privacy Rule Information.

Call to File-AID/Data Solutions with the API
Figure C-7. Privacy Project List Screen





File-AID/Data Solutions Privacy Project List -------- Select Criteria Project
COMMAND ===>
SCROLL ===> CSR
Use ENTER to process
Repository Name: FA-Data-Privacy
----- P R O J E C T
N A M E ---------------- Description ------------------
S Train
Sample privacy project
4. Select and confirm the Privacy Project you entered in the previous screen.
Figure C-8. Output Specification Screen


File-AID/Data Solutions ---------- Output Specification ------------------------
COMMAND ===> 
Input dataset: USERID1.DASAMP.INVFILE 

Specify Execution Options: 
Process BATCH
===> B (B = Batch)
Specify Output Processing Option: 
Option
===> A (A=ANALYZE; C=COPY; U=UPDATE)
Create audit trail ===> N (Y=Chgd record only; N=No; A=All records in Batch)

Specify Output Dataset Information (COPY ONLY):
Dataset name
===> DASAMP.INVOUT
Disposition
===> OLD
(OLD or NEW)

Specify PDS(E) COPY options:
Copy empty members from input ===> NO
(Y = Yes; N = No)
Replace like-named members
===> YES
(Y = Yes; N = No)
Rename copied members mask
===> 

Use ENTER : Batch = JCL specification
Use END to return to Input Specification Panel
Use CANCEL comand to restart at Input Specification Panel
5. Enter A for ANALYZE Option and N for Create audit trail.
Figure C-9. JCL Specification Screen

File-AID/Data Solutions - ANALYZE - JCL Specification
COMMAND ===> JCL
------------------------
JCL Information for Batch Processing: 

SYSOUT class
===> * 

JOB Statement Information:
===> //USERID0A JOB (’ODAQC2.0.0’,81),’DATA’,
===> //
CLASS=P,NOTIFY=USERID0,MSGCLASS=R,REGION=0M
===>
===> 



Use JCL command to edit generated JCL
Use SUBMIT command to submit batch job
Use END to return to main ANALYZE panel without submitting job
6. Enter JCL and JOB Statement Information to edit the generated JCL.
C-7
C-8
File-AID Single Install Image Installation and Configuration Guide
Figure C-10. Generated JCL Edit Screen
EDIT
SYS11073.T094728.RA000.USERID1.R0144732
Columns 00001 00072 
Command ===>
Scroll ===> CSR 
****** ***************************** Top of Data ******************************
==MSG> -Warning- The UNDO command is not available until you change

==MSG>
your edit profile using the command RECOVERY ON.

000001 //USERID1A JOB (ACCOUNT),NAME,REGION=0M

000002 //* YOU ARE VIEWING JCL THAT FILE-AID/DATA SOLUTIONS 10.2 HAS GENERATED 
000003 //* TO UPDATE DATASETS GLOBALLY.

000004 //*

000005 //* YOU CAN CHANGE THIS JCL IF DESIRED AND USE THE SUBMIT PRIMARY

000006 //* COMMAND TO SUBMIT THE JOB. THE CREATE OR REPLACE PRIMARY COMMAND

000007 //* CAN BE USED TO KEEP THIS JOBSTREAM FOR FUTURE USE.

000008 //*

000009 //* USE THE END COMMAND TO EXIT WITHOUT SUBMITTING THE JOB.

000010 //*

000011 //DASTEP
EXEC PGM=UDASOLUT,REGION=0M,

000012 //
PARM='PRINT=DPRPRINT,SYSIN=DPRINPUT'

000013 //STEPLIB DD DISP=SHR,DSN=CPWR.MXVJA20.CXVJLOAD

000013 //
DD DISP=SHR,DSN=CPWR.MXVJA20.SXVJLOAD

000014 //SYSPRINT DD SYSOUT=*

000015 //DPRPRINT DD SYSOUT=*

000016 //DPRERROR DD SYSOUT=*

000017 //SYSLIST DD SYSOUT=* 
000018 //DD01
DD DSN=USERID1.DASAMP.INVFILE,

000019 //
DISP=OLD

000020 //DD01RL
DD DSN=USERID1.DASAMP.LAYOUTS,

000021 //
DISP=SHR

000022 //FARULES DD *

000023 File-AID Rules

000024 8a8499e63c1e3c31013cac26a4ee003c Train

000033 //DPRINPUT DD *

000034 $$DD01 ANALYZE LAYOUT=INVFILE,CCSID=00037

000035 /*

000036 // 
****** **************************** Bottom of Data ****************************
7. Modify the JCL:
1. Change the //DASTEP EXEC statement to execute your COBOL program.
2. Add any required STEPLIB datasets.
3. Replace the DD01 DD statement with any DD statements your program
requires.
4. Remove the DPRINPUT DD statement and control card.
5. Save and/or submit your JOB.
1-1
Appendix 1.
File-AID for DB2 Audit Trail Facility
Appendix A.
D
1
This chapter provides an overview of the Audit Trail facility and instructions for
activating the facility. Procedures for modifying the audit trail exit routine are also
provided.
Procedures described in this chapter are optional and may be completed after the
installation and configuration of File-AID for DB2.
File-AID for DB2 Audit Trail Facility Overview
The File-AID for DB2 Audit Trail Facility creates a dataset containing a record of any
successful modification to table data made during a File-AID for DB2 Edit session; that is,
whenever DB2 processes inserts, updates, deletes, commits, and rollbacks. The audit trail
report details the before and after image of the data. The audit trail report can be directed
to either the SMF log or the File-AID for DB2 Audit Trail dataset. Figure D-11 shows a
sample audit trail report.
Note:
Whenever a character field contains a non-displayable character the hexadecimal
representation for that field is always printed on the Audit Trail Report.
Figure D-11. Sample Audit Trail Report
OBJECT NAME : USERID.EMP
OBJECT TYPE : TABLE
LOCATION :
CREATOR :
NAME
:

***
ACTION : UPDATE

COLUMN NAME
KY TYPE
------------------ -- ---------EMPNO
PK CH(6)
FIRSTNME
VC(12)
LASTNAME
VC(15)
PHONENO
CH(4)
HIREDATE
DATE
JOB
CH(8)
SALARY
DEC(9,2)
BONUS
DEC(9,2)
COMM
DEC(9,2)

***
ACTION : COMMIT
***
EDIT SESSION TERMINATED

*** COMMENTS :
USERID.EMP has been edited
DATE - 02/08/2008
Time - 09:21:23
PRIMARY AUTHID
: USERID
SECONDARY AUTHID :
OLD DATA
--------------000020
MICHAEL
THOMPSON
3476
1973-10-10
MANAGER
DCDCCCD
4151759
41250.00
800.00
3300.00
NEW DATA
------------------
01234545
49953369
45100.00
1000.00
0.00
DATE - 02/08/2008, TIME - 09:23:10
DATE - 02/08/2008, TIME - 09:23:12
1-2
File-AID Single Install Image Installation and Configuration Guide
Activating the File-AID for DB2 Audit Trail Facility
The following procedure describes how to activate the Audit Trail facility after the initial
configuration of File-AID for DB2. Refer to “Initial Activation of the File-AID for DB2 SMF
Audit Trail Facility” on page D-5 on how to initially activate the File-AID for DB2 SMF
Audit Trail Facility.
Step 1. Modify the F2AUDIT Variable
1. Invoke the Configuration Facility by executing CLIST XVJ$$CFG from the File-AID
Sample dataset. Enter the following in an ISPF/PDF COMMAND field:
TSO EX 'hlq.CPWR.MXVJA20.SXVJSAMP(XVJ$$CFG)'
2. Select Option 3, Product Specific Options, from the Configuration Facility main
menu.
3. Select Option 4, File-AID for DB2, from the Product Configuration menu.
4. Specify your Configuration library (load library) in the Product Configuration panel.
5. Select Option 2, SPECIFY PARMS, from the Product Configuration menu.
6. Modify the F2AUDIT variable to one of the following values:
– QUERY: The Create Audit Trail field appears on the Edit Options screen, giving
the user the option of entering YES or NO (Figure D-12). If YES is entered, an
audit trail is generated. If NO is entered, an audit trail is generated only if the
audit trail exit determines that a mandatory audit trail should be produced for
the selected object.
– FORCE: An audit trail is generated for each object edited with File-AID for DB2.
The Create Audit Trail field is prefilled with a YES value. This value is protected,
preventing the user from changing it.
– SMF: File-AID for DB2 creates an audit record each time you browse or edit an
object and modify table data, then writes it to the SMF log. If this is the first time
you select SMF, continue with “Initial Activation of the File-AID for DB2 SMF
Audit Trail Facility” on page D-5. In addition, the Create Audit Trail field (Figure
D-12) does not appear on the Edit Options screen, however, the message “Audit
Trail Activated” appears at the start of the browse/edit session. Furthermore,
Option 5, Print Audit Trail will not be available. See “Printing the Audit Trail SMF
Log” on page D-6 for information on how to print File-AID for DB2’s audit trail
records from the SMF log.
When specifying SMF you must also provide the SMF record number with the
F2SMFID variable:
• Move cursor to AUDIT variable F2SMFID
• Enter the SMF record number for audit trail. The record number must be
between 128 and 255.
Note:
The F2AUDIT variable defaults to NO, meaning an audit trail is never
produced. In addition, the Create Audit Trail field (Figure D-12) does not
appear on the Edit Options screen.
7. Enter END to display the “Edit JCL Screen for File-AID for DB2 Parameter Module
XVJOPXFD” panel (Figure 6-5 on page 6-11).
8. Review and submit the job to modify File-AID for DB2 PARM Module XVJOPXFD.
File-AID for DB2 Audit Trail Facility
1-3
Figure D-12. Create Audit Trail Field on Edit Options screen
Specify Edit Options:
Initial Display Mode
Lock Table during Edit
Use Uncommitted Read
Maximum Rows To Select
SELECT FROM Temporal Table
Create Audit Trail
Relationship File
===>
===>
===>
===>
===>
===>
1
NO
NO
2000
NO
YES
(1 - Table Mode, 2 - Row Mode)
(Yes or No)

(Yes or No)

(* for all rows)

(Yes or No)
*None*

(Yes or No)


===> ’TSOID01.RELATE.DSN’ 
Step 2. Modify the Audit Trail Exit (Optional)
The audit trail exit is called each time an object is about to be edited. The exit allows a
site to control the conditions under which an audit trail is generated. For example, you
may wish to modify the exit so that an audit trail is created only when modifications are
made to designated tables.
Two sample audit trail exits are included on the product media. They are named
F2AUDITX and F2AUDITC and can be found in the File-AID sample library
(hlq.CPWR.MXVJA20.SXVJSAMP). F2AUDITX is coded in Assembler; any modifications
must be coded in Assembler as well. F2AUDITC is coded in COBOL II; any modifications
must be coded in COBOL II as well. The exit, as delivered, will produce an audit trail,
based on the value of the DOAUDIT variable which initially is determined by the product
option variable F2AUDIT:
0
(F2AUDIT=QUERY or NO) only when Create Audit Trail field on the Edit Option screen is set to
YES.
1
(F2AUDIT=FORCE) always.
2
(F2AUDIT=SMF) always.
You can manually change DOAUDIT to one of the three values.
Audit Trail Exit Considerations
When coding the audit trail exit, several factors should be considered.
• The dataset name can be modified to virtually any valid system name. However,
File-AID for DB2 and the exit assume that the disposition of each audit trail dataset is
new. The exit should be coded so each audit trail dataset name is unique. The
disposition cannot be modified by the user. See “About the Audit Trail Dataset” on
page D-4 for more information on the audit trail dataset.
Note:
The audit trail dataset is not used when the F2AUDIT variable is set to SMF.
• The maximum number of records limits the number of records that can be written to
the audit trail dataset. A table is audited as follows:
– One record describing a column is written to the audit dataset for each column
in the table.
– Two records are written to the audit dataset for each row changed. The first
record contains the row data prior to the change. The second row contains row
data after the change.
– Records are written to the dataset when commits and rollbacks are performed.
The first and last records in the dataset identify the contents for the dataset and are
used as delimiters.
• The record length is calculated by File-AID for DB2 and represents the total number of
bytes for all columns of data in the object. You are strongly discouraged from
decreasing this value. If the actual number of bytes that File-AID for DB2 attempts to
1-4
File-AID Single Install Image Installation and Configuration Guide
write to the audit trail dataset is greater than the defined record length, an abend
occurs.
• The amount of space allocated to the audit trail dataset is a function of both the
maximum number of records variable value and the object’s record length. If a
significant number of out-of-space errors occur, you should increase the maximum
number of records variable, F2AUDREC. Follow the procedure under “Step 1. Modify
the F2AUDIT Variable” on page D-2, modifying instead the F2AUDREC variable. See
“Step 4. Specify File-AID for DB2 Product Configuration Parameters” on page 6-5 for
additional information on modifying this variable.
Audit Trail Exit Input
The following information is passed to the audit trail exit from File-AID for DB2:
•
•
•
•
•
•
•
•
•
•
Primary and secondary authorization IDs
Fully qualified table name; location, creator, and table names
Subsystem identifier
Audit trail dataset name
Unit
Volser
Space
Block size
Record length
Maximum number of records
Audit Trail Exit Output
The following information is returned from the audit trail exit to File-AID for DB2:
•
•
•
•
•
•
•
Audit trail dataset name
Unit
Volser
Maximum number of records
Record length
Block size
Audit flag
Unless modified, all parameters are returned to File-AID for DB2 with the same values as
when the exit was called.
Step 3. Assemble and Link-edit the Audit Trail Exit
If you modified the Assembler sample audit trail exit F2AUDITX, link-edit the exit into
the File-AID load library (hlq.CPWR.MXVJA20.CXVJLOAD) by executing the JCL in
F2JCLXIT in the File-AID sample library (hlq.CPWR.MXVJA20.SXVJSAMP).
If you modified the COBOL II sample audit trail exit F2AUDITC, link-edit the exit into
the File-AID load library (hlq.CPWR.MXVJA20.CXVJLOAD) by executing the JCL in
F2JCLCIT in the File-AID sample library (hlq.CPWR.MXVJA20.XVJSAMP). The audit trail
must be compiled and linked in COBOL II, not COBOL.
About the Audit Trail Dataset
If no changes are made to the F2AUDITX sample exit, a new audit trail dataset is
generated each time an object is edited with File-AID for DB2 when requested.
The default audit trail dataset name is generated by File-AID for DB2 in the following
format:
creator_ID.FADB2.datestamp.timestamp
File-AID for DB2 Audit Trail Facility
1-5
The default unit value is SYSDA. You can change this default by modifying variable
F2AUDUNI. The default VOLSER value is blank. You can change this default by
modifying variable F2AUDVOL. The record length passed to the exit is the sum of all
columns in the object being edited, while the block size is calculated by File-AID for DB2.
The maximum size of the audit trail dataset defaults to 1000 records. You can change this
default by modifying variable F2AUDREC.
This dataset is a sequential dataset containing variable length records. Because a new
audit trail dataset is generated each time an object is edited with File-AID for DB2, DASD
management is the responsibility of the user.
Initial Activation of the File-AID for DB2 SMF Audit Trail
Facility
The following procedure describes how to initialize and activate the SMF Audit Trail
facility.
Step 1. Create File-AID SVC
The File-AID SVC is required for SMF auditing within the File-AID products. The
File-AID/MVS, File-AID/Data Solutions, File-AID for DB2, and File-AID for IMS products
share the same user SVC.
Note:
Skip this step if you have already created the File-AID SVC (see “SVC
INFORMATION” on page 2-22).
1. Invoke the Configuration Facility by executing CLIST XVJ$$CFG from the File-AID
Sample dataset. Enter the following in an ISPF/PDF COMMAND field:
TSO EX 'hlq.CPWR.MXVJA20.SXVJSAMP(XVJ$$CFG)'
2. Select Option 1, File-AID Common Component, from the Configuration Facility
main menu.
3. Specify your Configuration library (load library) in the Product Configuration panel.
4. Select Option 2, SPECIFY PARMS, from the Product Configuration menu.
5. Modify the SVC variables to your site’s values (refer to “SVC INFORMATION” on page
2-22 in Table 2-3)
6. Press END (PF3) to display the “Edit JCL Screen for File-AID Common Component
Module XVJOPUNV” panel (Figure 2-10 on page 2-27).
7. Review and submit the job to modify the File-AID Common Component Module
XVJOPUNV, including File-AID SVC.
8. Press END (PF3) until you return to the Configuration Facility main menu.
9. If the File-AID SVC is installed as a user SVC (IGC00nnn), the MVS SVC table
(IEASVC00 in SYS1.PARMLIB) must be updated to include the new SVC number. For
example:
SVCPARM 253,REPLACE,TYPE(3)
/* FILEAID SVC */
10. Copy the module (IGC00nnn) from CXVJLOAD into SYS1.LPALIB. Then perform an
IPL (with a CLPA) or use a program product such as RESOLVE to make the SVC
available.
1-6
File-AID Single Install Image Installation and Configuration Guide
Step 2. Modify the File-AID for DB2 Install Variables
1. Invoke the Configuration Facility by executing CLIST XVJ$$CFG from the File-AID
Sample dataset. Enter the following in an ISPF/PDF COMMAND field:
TSO EX 'hlq.CPWR.MXVJA20.SXVJSAMP(XVJ$$CFG)'
2. Select Option 3, Product Specific Components, from the Configuration Facility main
menu.
3. Select Option 4, File-AID for DB2, from the Product Configuration menu.
4. Specify your Configuration library (load library) in the Product Configuration panel.
5. Select Option 2, SPECIFY PARMS, from the Product Configuration menu.
6. Modify the F2AUDIT variable to
SMF
When F2AUDIT is set to SMF, File-AID for DB2 creates an audit record each time you
browse or edit an object and modify table data, then writes it to the SMF log.
In addition, the Create Audit Trail field (Figure D-12 on page D-3) does not appear on
the Edit Options screen, however, the message “Audit Trail Activated” appears at the
start of the browse/edit session. Also, Option 5, Print Audit Trail is not available. See
“Printing the Audit Trail SMF Log” on page D-6 for information on how to print
File-AID for DB2’s audit trail records from the SMF log.
When specifying SMF you must also provide the SMF record number with the
F2SMFID variable:
7. Move cursor to AUDIT variable F2SMFID
8. Enter the SMF record number for audit trail. The record number must be between 128
and 255.
9. Enter END to display the “Edit JCL Screen for File-AID for DB2 Parameter Module
XVJOPXFD” panel (Figure 6-5 on page 6-11).
10. Review and submit the job to modify File-AID for DB2 PARM Module XVJOPXFD.
Now File-AID for DB2 can call the SVC that writes File-AID for DB2 audit records out to
the SMF log.
Note:
When using APF checking SVC (SVCAPF variable set to Y, see “SVCAPF” on
page 2-23 in Table 2-3), Load libraries CXVJLOAD and SXVJLOAD must be
APF authorized.

When using NO APF checking SVC (SVCAPF variable set to N), CXVJLOAD
and SXVJLOAD do not have to be in an APF authorized library.
Audit Trail Exit (Optional)
See “Step 2. Modify the Audit Trail Exit (Optional)” on page D-3 and “Step 3. Assemble
and Link-edit the Audit Trail Exit” on page D-4.
Printing the Audit Trail SMF Log
If you direct the audit trail to the SMF log you cannot use the File-AID for DB2 Option 5.2
Print Audit Trail. Instead, the member XFDSMFPR of the File-AID sample dataset
(hlq.CPWR.MXVJA20.SXVJSAMP) includes sample JCL that you must edit to meet your
site specific requirements:
• Step001 is used to strip records from the SMF log.
File-AID for DB2 Audit Trail Facility
1-7
a. In the DUMPIN DD, enter the name of your system’s SMF log file.
b. In the DUMPOUT DD, enter the name of your output.
c. For the SYSIN parameter OUTDD enter the SMF ID used for File-AID audit
records.
• Step002 sorts the records from the SMF log file. Update the following:
a. SORTIN DD
b. SORTOUT DD
c. SORTWK DD’s.
d. The SYSIN parameter INCLUDE will need the SMF ID added to it. The SMF ID in
this case must be converted to hexadecimal (example 209 = x’D1’).
• Step COPYTL merges product table libraries (TENUs)
Specify the File-AID table library (e.g. hlq.CPWR.MXVJA20.SXVJTENU) for INDD1
e. Specify the ISPF table library as defined with parameter variable “ISPF Table
Library”(see also “ISPF Table Library” on page 2-25) (e.g. ISP.SISPTENU) for
INDD2
f. Specify the PDF table library if you defined it with parameter variable “PDF Table
Library”(see also “PDF Table Library” on page 2-25) (e.g. ISR.ISRTLIB) for INDD3.
Otherwise omit.
• Step003 prints the audit report. Update the following:
a. Insert the File-AID load libraries into DD STEPLIB.
b. Update the SYSTERM DD to direct the report to different classes or printers.
c. Update the SYSIN DD for different dates, times, users and/or tables to specify
more precisely what should be printed off.
d. Replace YOUR.NAME.OF.CHOICE in the SYSTSIN DD statement parameter with
the output dataset from STEP002.
• Save and submit the updated JCL.
Figure D-11 on page D-1 shows a sample print report.
Note:
If your SMF log file happens to fill up and roll over to a new file during auditing
of a browse or edit session, SMF header and audit trail records may be split
between the old and new log file.
1-8
File-AID Single Install Image Installation and Configuration Guide
E-1
Appendix E.
File-AID for IMS Exits
Appendix A.
App E
This appendix includes information about the following exits for
File-AID for IMS/ISPF:
• “File-AID for IMS/ISPF Security Exit”
• “File-AID Segment Control Exit”
• “Application Relationship Exit”
• “XIXTDLI User Exit”
• “Audit Trail Write User Exit”
File-AID for IMS/CICS:
• “File-AID for IMS/CICS and File-AID for IMS/DC Security Exit”
File-AID for IMS/DC:
• “File-AID for IMS/CICS and File-AID for IMS/DC Security Exit”
File-AID for IMS/ISPF Security Exit
Note:
File-AID for IMS/ISPF will attempt to load XIXSCXT and if it is not found, attempt
to load the old name of IXPSCXT and use it if found.
The security exit program XIXSCXT is called from different points during File-AID for IMS
processing:
1. Exit Type A - Prior to allocating each non-database dataset.
2. Exit Type O - Prior to opening each non-database dataset.
3. Exit Type B - Prior to allocating each database dataset.
4. Exit Type R - Prior to allocating an audit trail dataset when editing a database or
when a database is to be updated by File-AID for IMS/FLEX.
Note:
The "online only" features of Exit Type R (SLIB-MEMBER-NAME and FORCE
PRINT INDICATOR, see Table E-7 on page E-9) are not used for the File-AID
Eclipse component of the Compuware Workbench.
5. Exit Type I - Prior to invoking the IMS control program (that is, before entering the
IMS environment).
6. Exit Type N - After the IMS database datasets are allocated but before they are used.
7. Exit Type T - After the IMS control program terminates (that is, after leaving the IMS
environment).
The default security exit program initially installed in File-AID for IMS returns control
immediately to File-AID for all exit types, which allows normal processing to continue.
The exit types are described on the following pages in alphabetical order, not in the order
that they are invoked.
E-2
File-AID Single Install Image Installation and Configuration Guide
Dataset Allocation Exit for Type A
Prior to allocating a dataset, the security exit is called with an exit type of A. You can use
the A exit type to control access to non-database datasets.
Database Allocation Exit for Type B
The database dataset allocation exit is designated by a B request type to the security exit.
This exit applies when running in an IMS DLI region, but does not apply when running
in a BMP region. You can use the B exit type:
• To control access to certain databases.
• To change the File-AID default database dataset allocation (the default for edit is OLD
unless using a DBRC registered dataset and then it is SHR).
• To allow users to enter a shorthand version of the dataset names and then translate
the shorthand version to a full dataset name. For example, the database DDNAME
could be appended to the dataset name for every database dataset.
The sample security exit program in sample library member COBSCXT (for program ID
XIXSCXTC) performs the following functions for request type B:
• Restricts access to database datasets starting with FI.PROD to userid FI.
• Allocates all database datasets with a disposition of SHR for userids FI001 and FI002.
• Substitutes ‘FI.DB.ddname’ for all users if TEST1 is entered as the dataset name.
IMS Initialization Exit for Type I
Prior to invoking the IMS control program, the security exit is called with an I exit type.
You can use the I exit type:
• To validate the value entered by the user for the File-AID for IMS log dataset usage.
You can either accept, override, or disallow the value entered by the user. For
example, you can force a log dataset to be used when editing all production
databases.
• To override the standard File-AID for IMS log dataset naming conventions, so that you
can catalog log datasets under a name of your choice.
• To override or customize IMS control program (DFSRRC00) parameters based on the
database being processed.
• To validate the RECON datasets being used. If RECON dataset names were displayed
in the File-AID for IMS 0.4 panel, the datasets were allocated by File-AID for IMS. The
security exit can dynamically allocate the RECON datasets. If no RECON datasets are
allocated and DBRC is being used, DBRC attempts to dynamically allocate them.
• To override the Installation Parms’ values of the ALLOW CHANGE indicator, ALLOW
CHANGE ALL indicator, or FIND GET NEXT MAXIMUM.
• To activate the Database Dataset Names exit.
• To determine if DBRC is active.
The standard name generated by File-AID for IMS for a log dataset is:
’userid.IMSLOG.Dyymmdd.Thhmmss.dbdname’

or

’prefix.userid.IMSLOG.Dyymmdd.Thhmmss.dbdname’
(if the TSO prefix does not equal the TSO userid)
File-AID for IMS Exits
E-3
The sample security exit program in sample library member COBSCXT requires that a log
file be allocated when updating databases and specifies DFSRRC00 OSAM buffer pools for
a specific DBDNAME.
Database Dataset Names Exit for Type N
The Database Dataset Names exit is designated by an N request type. This is an optional
exit that is not activated unless requested by the IMS Initialization exit. When the IMS
initialization exit is called, the DATASET-NAME-IND is set to N. The Database Dataset
Name Exit is activated if the IMS Initialization exit changes the indicator to Y.
When activated, the Database Dataset Names Exit is called after the Initialization exit.
The purpose of this exit is to allow or disallow processing based on the dataset names of
the IMS database. The exit is applicable in all File-AID environments but is primarily
useful when using an IMS BMP region because the Database Allocation Exit is not
applicable in a BMP region.
The parms passed to the exit are the same parms passed to the Database Dataset
Allocation Exit. Based on the information in the PARM fields, the exit can set the
ALLOW-IND to allow or disallow the activity. For example, the exit could allow updates if
the dataset name is ’PAYROLL.TEST’ but disallow updates or reads if the dataset name is
’PAYROLL.PRODUCTION’. For Function 3, subfunction 2 (Batch), the READ-ONLY-IND
field indicates whether the user is allowed to update the database.
The exit is called for each dataset of the primary database and for each dataset of any
related databases. Because area datasets for a DEDB may not be allocated until referenced,
it is possible for the exit to be called only for the first area dataset.
When this exit is activated for a BMP region, the File-AID Type 3 or 4 SVC must be
installed with “XVJFUN20” (“XVJFUN20” on page 2-23) available. Refer also to
“Authorized Library Requirements” on page 1-7.
Note:
The Database Dataset Names Exit cannot be used if an IMSGROUP was used for
the IMSID of the BMP region.
Dataset Open Exit for Type O
Prior to opening a non-database dataset, the security exit is called with an O exit type.
You can use the O exit type to prevent updates to a certain non-database dataset or to
prevent access or updates to a member of a PDS.
Audit Trail Exit for Type R
Note:
The "online only" features of Exit Type R (SLIB-MEMBER-NAME and FORCE
PRINT INDICATOR, see Table E-7 on page E-9) are not used for the File-AID
Eclipse component of the Compuware Workbench.
The Audit Trail exit is designated by an R request type to the security exit. You can use
the R exit type:
• To force the creation of an audit trail for a certain database or group of databases
and/or for a certain user or group of users.
• To force the audit trail report to automatically print with the ability to keep or delete
the audit trail dataset after it prints (online only).
• To override the standard audit trail dataset name that is constructed by File-AID for
IMS.
• To override the default skeleton library (SXVJSENU) member (XIXATRPT, was
IXJATRPT) used to print with a different member. The new SXVJSENU member can
E-4
File-AID Single Install Image Installation and Configuration Guide
specify a different destination, create multiple copies, and so forth. This is usually
done when forced printing is invoked (online only).
• To provide a message ID that describes the audit trail that is displayed on the audit
trial report. The message ID must start with XVJ and exist in the File-AID message
library (SXVJMENU).
• To force the use of SMF recording for the audit trail instead of using an audit trail
dataset.
• To override the installation defined SMF record ID.
Audit Trail Dataset Name
The standard audit trail dataset name generated by File-AID for IMS for an audit trail
dataset is formatted as:
’userid.IXPAT.Dyymmdd.Thhmmss’

or

’prefix.userid.IXPAT.Dyymmdd.Thhmmss’
(if the TSO prefix does not equal the TSO userid)
Audit Trail Dataset Name for File-AID Eclipse
The audit trail dataset name generated by File-AID for IMS for an audit trail dataset for
File-AID Eclipse is formatted as:
’userid.FAIMS.Dnnnnnnn.Tnnnnnnn
Sample Security Exit Program
The sample security exit program in sample library (SXVJSSAMP) member COBSCXT
performs the following functions for exit type R:
• Forces the creation of an audit trail dataset, and prints the audit trail report when the
edit database dataset name starts with FI.PROD.
• Keeps the audit trail dataset after the report is printed.
• Uses the default skeleton library (SXVJSENU) member (XIXATRPT, was IXJATRPT) to
print the audit trail report.
IMS Termination Exit for Type T
After the IMS control region terminates, the security exit is called with an exit type of T.
You can use the T exit type to perform post-IMS processing of the log dataset. For
example, using ISPF file tailoring to build and submit a job to copy the log dataset to a
tape GDG.
Security Exit Interface
The following information describes the call interface and parameters used to pass
control to XIXSCXT.
Note:
Compile SCXT using the RENT compiler option and link edit it as RENT to make
it eligible for PLPA residence.
CALL Parameters
A, B, N, O and R exit types:
File-AID for IMS Exits
E-5
CALL XIXSCXT (SECURITY-PARMS,SECURITY-EXIT-WORK-AREA)
I and T exit types:
CALL XIXSCXT (SECURITY-PARMS,SECURITY-EXIT-WORK-AREA,IMS-CONTROL-PROGRAMPARMS,DATASET-CONCATENATION-ARRAY)
SECURITY-PARMS is the parameter list passed to the security exit. This parameter
includes a common field area, applicable to all exit types, followed by fields specific to
each exit type. Layouts and a description of these fields begin on page E-6.
SECURITY-EXIT-WORK-AREA is a 256 byte work area initialized to binary zeroes. This
area is unchanged by File-AID for IMS during the entire user session and can be used to
retain information across multiple calls to the security exit.
IMS-CONTROL-PROGRAM-PARMS is a partial list of the parameters that are passed to the
IMS control program DFSRRC00. Because these parameters cannot be modified, the first
three normally found in the list (regiontype, pgmname, and psbname) are not passed to
the security exit. The remaining parameters can be modified during exit type I
processing, prior to invoking the IMS control program. These parameters are available
during exit type T processing for inspection only; modifying them at this point has no
affect.
DATASET-CONCATENATION-ARRAY is a list of datasets passed to the security exit for
DBD library, PSB library, ACB library, and Task library concatenations. See “Security
Parms Layout” below for the layout and description of the fields in this array.
Six sample security exit programs are provided with File-AID for IMS in the sample library
(SXVJSSAMP):
ACF2SCXT
Assembler language interface to ACF2
PLISCXT
PL/I self-contained security exit program
RACFSCXT
Assembler language interface to RACF
COBSCXT
COBOL self-contained security exit program
TSSSCXTA
Assembler language interface to TOP SECRET
TSSSCXTC
COBOL language interface to TOP SECRET
AMODE 31 and RMODE ANY Parameters
File-AID has implemented the use of AMODE 31, which is 31-bit addressing, wherever
possible. Use of AMODE 31 enables File-AID to access a greatly expanded range of
addresses, up to the 31-bit limit of 2 G of memory.
Most of File-AID modules use RMODE (Residency Mode) ANY, which is loading modules
into either 24-bit or 31-bit memory at run time. This frees much of the memory in the
lower 16 MB range for use by other applications. However, some programs implement
functions that are still required to reside in the lower 16 MB. Some input/output
operations use DCBs and DCB exit lists that must reside below the 16 MB line. As a result,
some of the File-AID modules must be loaded into memory addresses below 16 MB, that
is 24-bit addresses, called RMODE 24.
Note:
File-AID has implemented the use of Stack Storage above the line wherever
possible. Use of Stack Storage above the line enables File-AID to utilize additional
addresses up to the 31-bit limit of 2 G. If you have written a Security Exit for use
with File-AID, you should not have any problems with exits written in COBOL or
PL/I. They should run with AMODE 31 and RMODE ANY. If you have a situation
where your Security Exit is using Panvalet or Librarian or allocating a data
control block (DCB), you may need residency below the 16MB line. In this case
specify a RMODE of 24. 
E-6
File-AID Single Install Image Installation and Configuration Guide
A Security Exit written in Assembler most likely will work with AMODE 31 and
RMODE ANY or AMODE 31 RMODE 24. If your Assembler program contains 24bit address constants for the Security Exit Parameter List, it will require a special
fix for Stack Storage below the line. After testing your Security Exit if you
encounter problems, please contact File-AID customer support.
Security Parms Layout
The following tables identify the layout for Security parms.
Note:
Binary values should be aligned on half-word, word boundaries as appropriate.
Common Input Parms for All Exit Types
Table E-1 identifies the common input parameters for all exit types.
Table E-1.
Common Input Parms Passed To All Exit Types
Fields
EXIT-TYPE
Length
1
Format
CHAR
Description
A : Dataset allocation
B : Database allocation
I : IMS initialization
N : Database dataset names
O : Dataset open
R : Audit Trail allocation
USER-ID
FUNCTION
7
1
CHAR
CHAR
T : IMS termination
TSO or Batch User ID
1 : Browse
2 : Edit
3 : Utilities and File-AID for IMS/FLEX
4 : Extract/Load
5 : Print
6 : Edit Selection Criteria
7 : Edit Segment/Layout XREF
BATCH-ONLINE-IND
1
CHAR
FAI-VERSION
8
CHAR
FILE-TYPE
1
CHAR
9 : Edit Application Relationship
O : Online operation (ISPF)
B : Batch operation
Version of File-AID for IMS being used. Format is
vv.rr.mm (where vv is version number, rr is release
number, and mm is maintenance release number).
Current version is 10.02.00.
A : Application Relationship dataset
C : Record layout dataset
D : Data file dataset
F : Segment/Layout XREF dataset
I : ISAM Database
O : OSAM Database
S : Selection Criteria dataset
DATASET-NAME
44
CHAR
V : VSAM Database
DSN to be allocated or opened (edit database DSN
for R exit type), without quotes, and including TSO
prefix if appropriate.
File-AID for IMS Exits
Table E-1.
E-7
Common Input Parms Passed To All Exit Types (Continued)
Fields
DSORG
Length
2
Format
CHAR
Description
AM : VSAM dataset
S : ISAM dataset
LB : Librarian dataset
PN : Panvalet dataset
PO : Partitioned dataset
VOLSER
6
CHAR
PASSWORD
READ-ONLY-IND
8
1
CHAR
CHAR
PS : Sequential dataset
The volume serial number of the disk or tape that
contains the dataset.
The password for OS password protected datasets.
Y : Batch read only intent
N : Batch update intent
Blank : N/A
Common Output Parms for All Exit Types
Table E-2 identifies the common output parameters for all exit types.
Table E-2.
Common Output Parms for All Exit Types
Fields
ALLOW-IND
Length
1
MESSAGE
8
Format
CHAR
Description
Y : Allow intended action.
CHAR
N : Disallow intended action.
Not used for exit type R.
Exit types A, B, I, N, O:
Error message ID if ALLOW-IND=N. If left
blank, File-AID for IMS produces the
following messages by default:
• Exit types A and O:
E848 - "ALLOCATION/OPEN
DENIED"
• Exit type B:
E838 - "ddname ACCESS
DENIED"
• Exit type I:
E974 - "IMS ACCESS DENIED"
• Exit type N:
E848 - "UPDATE/READ-ONLY
OF DSN xxxxxx DENIED"
• Exit type R: 
Error message ID that contains a
description of the audit trail.
Must start with XVJ . If left blank
and audit trail Force-Print-Ind=K
or D, File-AID informational
message "I701" is produced on
the report.
Input Parms for Exit Type A
Table E-3 identifies the input parameters for Exit Type A.
Table E-3.
Input Parms for Exit Type A
Fields
ALLOC-JCL-IND
Length
1
Format
CHAR
Description
Y : The dataset has been allocated
within a batch job with a DD statement.
N : The dataset is dynamically allocated
(online).
E-8
File-AID Single Install Image Installation and Configuration Guide
Table E-3.
Input Parms for Exit Type A (Continued)
Fields
ALLOC-DSN-STATUS
Length
3
Format
CHAR
Description
SHR, NEW, OLD, or MOD status is shown
for all datasets for informational
purposes.
Input Parms for Exit Type O
Table E-4 identifies the input parameters for Exit Type O.
Table E-4.
Input Parms for Exit Type O
Fields
OPEN-REQ-TYPE
Length
1
Format
CHAR
Description
I : Open for input (read only) in
sequential processing mode.
O : Open for output (write only) in
sequential processing mode.
OPEN-MEMBER-NAME
10
CHAR
U : Open a VSAM KSDS or an ISAM file
for random read and write.
The name of the specific member of a
PDS, Panvalet, or Librarian dataset that
File-AID for IMS is about to open.
Input/Output Parms for Exit Type B
Table E-5 identifies the input/output parameters for Exit Type B.
Table E-5.
Input/Output Parms for Exit Type B
Fields
DBALC-DBD-NAME
PHYSICAL-DBD-NAME
Length
8
8
Format
CHAR
CHAR
DDNAME
DBALC-DSN-STATUS
8
3
CHAR
CHAR
DBALC-DSN
46
CHAR
DBRC-ACTIVE
DBRC-REGISTERED
DBRC-USING-REGISTERED
DBRC-DATASET-SHR-LEV
1
1
1
1
CHAR
CHAR
CHAR
CHAR
Description
Primary DBD being processed, as user entered it.
Physical DBD that has the DATASET= statement for this
ddname.
Ddname of the database being allocated.
Allocation disposition of SHR or OLD -- can be
changed.
On input, the DSN of the dataset as the user entered
it, with or without quotes.
On output, the DSN is processed as supplied with or
without quotes.
DBRC active, Y or N
DBD is registered with DBRC, Y or N
Using registered dataset, Y or N
DBRC registered share level
Input or Output
Input
Input
Input
Input and
Output
Input and
Output
Input
Input
Input
Input
Input/Output Parms for Exit Type N
Table E-6 identifies the input/output parameters for Exit Type N.
Table E-6.
Input/Output Parms for Exit Type N
Fields
DBALC-DBD-NAME
PHYSICAL-DBD-NAME
Length
8
8
Format
CHAR
CHAR
DDNAME
DBALC-DSN-STATUS
8
3
CHAR
CHAR
DBALC-DSN
46
CHAR
Description
Primary DBD being processed, as user entered it.
Physical DBD that has the DATASET= statement for
this ddname.
Ddname of the database being allocated.
Allocation disposition of SHR or OLD -- can be
changed.
The DSN without quotes.
Input or Output
Input
Input
Input
Input
Input
File-AID for IMS Exits
E-9
Input/Output Parms for Exit Type R
Table E-7 identifies the input/output parameters for Exit Type R.
Table E-7.
Input/Output Parms for Exit Type R
Fields
AUDTRL-DSN
Length
46
Format
CHAR
SLIB-MEMBER-NAME
8
CHAR
CREATE-AUDIT-TRAIL-IND
1
CHAR
Description
Audit trail DSN to be allocated, with
quotes, and including TSO prefix if
appropriate.
Default is IXJATRPT. You can override the
default with a different SLIB member
(online only).
Input value from the EDIT - DBD
Specification screen. You can override
the value with one of the following:
Y : Create an audit trail.
FORCE-PRINT-IND
1
CHAR
N : Do not create an audit trail.
N : Default: do not force printing of the
audit trail report (online only).
K : Force printing and keep the audit
trail dataset (online only).
D : Force printing and delete the audit
trail dataset (online only).
SMF-RECORD-ID
1
BINARY
S : Do not print audit trail and keep the
audit trail dataset (online only).
Default is 00. SMF not used for audit trail.
The user can choose a number between
128 and 255. Only applies if CREATEAUDIT-TRAIL-IND is set to Y.
Input/Output Parms for Exit Type I
Table E-8 identifies the input/output parameters for Exit Type I.
The only parameters listed in this section that can be changed by the security exit
program are the following:
• ALLOC-LOG-IND
• IEFRDER-DSN
• CHG-CMD-ALLOWED-IND
• FIND-GN-MAX-ALLOWED
• CHG-ALL-ALLOWED-IND
• FIND-GN-MAX-IND
All other parameters are input only.
Table E-8.
Input/Output Parms for Exit Type I
Fields
IMS-DBD-DSN1
Length
44
Format
CHAR
IMS-DBD-DSN2
44
CHAR
IMS-DBD-NAME
8
CHAR
Description
Primary DBD library that has been allocated,
without quotes, including TSO prefix if
appropriate.
Secondary DBD library that has been allocated
and concatenated with the primary DBD library,
without quotes, including TSO prefix if
appropriate.
Primary DBD being processed as the user
entered it.
E-10
File-AID Single Install Image Installation and Configuration Guide
Table E-8.
Input/Output Parms for Exit Type I (Continued)
Fields
SUB-FUNC-NO
Length
1
Format
CHAR
Description
Option subfunction.
• Function 3, Utilities:
1 Initialize
2 File-AID for IMS/FLEX
• Function 4, Extract/Load:
ALLOC-LOG-IND
2
CHAR
1 Extract
2 Load
The user entered log indicator. Only applicable
during the online portion of the Edit and Load
functions. Values are:
AK : Allocate and keep dataset
AL : Allocate and delete log dataset
IEFRDER-DSN
46
CHAR
JOB-TYPE
IMS-SYSTEM-ID
5
4
CHAR
CHAR
IMS-ID
8
CHAR
RESLIB-DFHLIB-DSN1
44
CHAR
RESLIB-DFHLIB-DSN2
44
CHAR
RESLIB-DFHLIB-DSN3
44
CHAR
ACB-NAME
8
CHAR
ACBLIB-DSN
APPL-GROUP-NAME
PROCESSING-OPTION
44
8
1
CHAR
CHAR
CHAR
TIME
6
CHAR
DATE
8
CHAR
CHG-CMD-ALLOWED-IND
1
CHAR
N : Do not use a log dataset
When AK or AL is entered in ALLOC-LOG-IND
during the online portion of Edit or Load, this
field contains the log dataset constructed by
File-AID for IMS.
BATCH or BMP
For JOB-TYPE=BMP, the Environment Name
being used.
For JOB-TYPE=BMP, the IMSID specified in the
Environment settings.
Primary RESLIB dataset that has been allocated,
without quotes, including TSO prefix if
appropriate.
Secondary RESLIB dataset that has been
allocated and concatenated with the primary
RESLIB or DFHLIB dataset, without quotes, and
including TSO prefix if appropriate.
Third RESLIB dataset that has been allocated
and concatenated with the primary RESLIB
dataset, without quotes, and including TSO
prefix if appropriate.
For JOB-TYPE=BMP, the ACB member name
used.
For JOB-TYPE=BMP, the ACBLIB dataset used.
For JOB-TYPE=BMP, the AGN entered.
For Load (Option 4.2), the processing option
entered.
The time the I exit type call is made by File-AID
for IMS. Format is HHMMSS.
The date the I exit type call is made by File-AID
for IMS. Format is YYYYMMDD.
Only applicable during the online Edit function.
Values are:
N : Do not allow the CHANGE command.
FIND-GN-MAX-ALLOWED
4
BINARY
CHG-ALL-ALLOWED-IND
1
CHAR
Y : Allow the CHANGE command.
Only applicable during online Edit and Browse
functions. The maximum number of GN (Get
Next) calls allowed to satisfy a FIND or CHANGE
command. Used to override the Installation
Parms’ FDGNMAX value. See FIND-GN-MAXIND.
Only applicable during the online Edit function.
Values are:
N : Do not allow the CHANGE ALL command.
Y : Allow the CHANGE ALL command.
File-AID for IMS Exits
Table E-8.
E-11
Input/Output Parms for Exit Type I (Continued)
Fields
FIND-GN-MAX-IND
Length
1
Format
CHAR
Description
Indicates whether the FIND-GN-MAXALLOWED is to override the Installation Parms’
FDGNMAX value. Values are:
Y : Override with FIND-GN-MAX-ALLOWED.
RECON-DSN1
44
CHAR
N : Do not override. Use FDGNMAX.
RECON dataset that has been allocated to the
RECON 1 (2,3) DD (as specified on the IMS DLI
Datasets panel (0.4)), without quotes, and
including TSO prefix if appropriate.
Note: RECON datasets are only passed if
specified on the IMS DLI Datasets
panel (0.4) and allocated by File-AID.
RECON-DSN2
RECON-DSN3
PSB-TYPE
44
44
1
CHAR
CHAR
CHAR
Indicates type of PSB. Values are:
S : Static
PSB-NAME
DATASET-NAME-IND
8
1
CHAR
CHAR
IMS-PSB-DSN1
44
CHAR
IMS-PSB-DSN2
DBRC Active
44
1
CHAR
CHAR
D : Dynamic
Static PSB only: PSB name.
N when exit called, set to Y to activate the N exit
type.
Static PSB only: PSB library datasets without
quotes.
DBRC active, Y or N
Input Parms for Exit Type T
The parameters from the I exit type are passed as input-only to the exit type T. The
primary purpose of the T exit type is to review the IEFRDER-DSN and perform post-IMS
log processing.
Concatenation Control Parms for Exit Types I and T
In order to provide security exit access to information concerning dataset
concatenations, the parameter list passed to the exit now contains an additional
parameter. The new parameter is the address of a data structure that consists of an array
preceded by a count of entries to be found in the array. Examples of how this structure
may be referenced have been included in each of the sample security exits provided in
the File-AID installation library. Existing security exits will continue to control access to
IMS as they did in prior releases. The only exception arises when an existing exit not
only controls the primary DBD name, but also examines related DBD names at the same
time to determine if access should be granted. Since these names may come from DBD
library concatenations beyond the first two passed to the exit, you will have to modify
the user exit to examine the full DBD concatenation list.
The list of datasets that is passed to the exit varies depending on whether BMP or DL/I
processing is in use and whether static or dynamic PSB processing is in use. In all cases,
the list contains all datasets appearing in the DBD library concatenation and all datasets
appearing in the File-AID STEPLIB or TASKLIB concatenation. If BMP processing is in use,
the list contains all datasets appearing in the ACB library concatenation. If static PSB
processing is in use, the list contains all datasets appearing in the PSB library
concatenation.
To simplify processing of the concatenation list, sequence number and counts are
provided with each entry in the array. The value found in CNCAT-DSN-CNT is the total
number of dataset names passed in the list. CNCAT-SEQ is a sequential number that
indexes each entry in the list. CNCAT-SEQ is equal to 1 for the first entry in the list and
E-12
File-AID Single Install Image Installation and Configuration Guide
increases by 1 for each additional entry. CNCAT-SEQ is equal to CNCAT-DSN-CNT when
the end of the list is reached.
CNCAT-DD-ID identifies the type of concatenation in which the dataset appears. This
value will be ACB for ACB library concatenations, PSB for PSB library concatenations,
DBD for DBD library concatenations, and TSK for STEPLIB or TASKLIB concatenations.
CNCAT-DD-COUNT contains the total number of datasets of a particular ddname type
found in the list. This value is the same for all datasets of a given ddname type. CNCATDD-SEQ contains the concatenation sequence for a dataset name of a given type. It is a
value ranging from 1 to the total found in CNCAT-DD-COUNT.
Table E-9 provides an example of the concatenation control parameter structure.
Table E-9.
Concatenation Control Parameter Structure
CNCAT-SEQ
CNCAT-DD-COUNT
CNCAT-DD-SEQ
CNCAT-DD-ID
CNCAT-DSN
1
2
1
ACB
IMS131A.ACBLIB1
2
2
2
ACB
IMS131A.ACBLIB2
3
3
1
DBD
IMS131A.DBDLIB1
4
3
2
DBD
IMS131A.DBDLIB2
5
3
3
DBD
IMS131A.DBDLIB3
6
3
1
PSB
IMS131A.PSBLIB1
7
3
2
PSB
IMS131A.PSBLIB2
8
3
3
PSB
IMS131A.PSBLIB3
9
4
1
TSK
IMS131A.SDFSRESL
10
4
2
TSK
IMS131A.MDALIB1
11
4
3
TSK
IMS131A.MDALIB2
12
4
4
TSK
SYSD2.PRODUCT.LOADLIB
Table E-10 identifies the concatenation control parameters passed to the I and T exit
types.
Table E-10. Concatenation Control Parameters
Fields
CNCAT-DSN-CNT
Length Format
4
CNCAT-ARRAY
CNCAT-SEQ
4
Description
BINARY
Total count of datasets in IMS concatenations. Contains the
number of entries in CNCAT-ARRAY.
ARRAY
An array of five data elements repeated for each dataset
contained in an IMS DSN concatenation. No more than 456
entries will appear in this array.
BINARY
Dataset sequence number. This value ranges from 1 to
CNCAT-DSN-CNT. It serves as an index of the dataset names
passed in the array.
CNCAT-DD-COUNT
4
BINARY
Total number of datasets of with a ddname identifier equal to
the value contained in CNCAT-DD-ID. This value will be
constant for all datasets sharing the same value contained in
CNCAT-DD-ID.
CNCAT-DD-SEQ
4
BINARY
Sequence number indexing dataset name entries that have
the same ddname identifier. This value will ranges from 1 to
CNCAT-DD-COUNT.
File-AID for IMS Exits
E-13
Table E-10. Concatenation Control Parameters
Fields
Length Format
Description
Ddname identifier associated with dataset:
ACB: ACB library concatenation
CNCAT-DD-ID
8
CHAR
PSB: PSB library concatenation
DBD: DBD library concatenation
TSK: STEPLIB or TASKLIB concatenation
CNCAT-DSN
44
CHAR
Unquoted, fully qualified dataset name.
Interface to System Security Packages
Your existing security packages (for example, ACF2, RACF, TOP SECRET) can be interfaced
with File-AID for IMS through the XIXSCXT security exit program. This interface is
necessary if you require selective access to online IMS databases while running in BMP
mode.
Your current system’s security remains in effect for all non-IMS datasets and all database
datasets that are offline to IMS when File-AID for IMS is run online (under TSO) and when
the Batch (DL/I) Initialize, Extract, and Load jobs are submitted by File-AID for IMS.
However, when running in BMP mode, IMS is responsible for the verification of the
database access. This verification is normally controlled through Application Group
Name (AGN) and ACB restrictions (refer to “BMP Security” on page 2-9). Because File-AID
for IMS creates its own ACB, AGN/ACB security is not effective in controlling database
access. Therefore, if you want to allow selective access to IMS databases while running in
BMP mode, you probably want to interface File-AID for IMS to your system security
package.
Following is the general procedure to use to interface File-AID for IMS to an existing
system security package:
1. Format the parameters to be passed through the application interface to the system
security package within the security exit program. Each security package vendor
supplies a CALL or MACRO (SVC) interface to their security package. For example:
ACF2
uses the ACFSVC macro
RACF
uses the RACROUTE REQUEST=AUTH macro
TOP SECRET
uses a CALL to program TSSAI
Parameters usually include the resource type, resource name, and access intent.
2. Issue the CALL or MACRO (SVC) to the security package.
3. Interpret the returned value, which indicates that the access was allowed or denied.
If access is allowed, no action is necessary.
If access was denied, set the ALLOW-IND field in Security-Parms to N, and optionally
place a message ID in the MESSAGE field.
Details specific to each security package are presented on the following pages.
Interface to ACF2
The ACF2 interface macro, ACFSVC, is available only when using an Assembler program.
If your security exit program is written in COBOL or PL/I, you have to create a separate
Assembler program that invokes ACFSVC and CALL this Assembler program from the
security exit program.
The program that invokes ACFSVC passes a parameter list that is described by macro
ACDSV. A type S User Call should be used.
E-14
File-AID Single Install Image Installation and Configuration Guide
Because ACF2 does not have DBD protection built-in, a routine must be used to
implement DBD security. A pseudo dataset name is created from the DBD name and other
IMS information (for example,’SYSID.DBDNAME’). This pseudo dataset name is then
used in the ACFSVC macro exactly as if it was a real dataset.
The access flag should be set to READ for Browse and Extract processing (options 1 and
4.1) and to WRITE for Edit and Load processing (options 2 and 4.2).
After the security exit program is installed, access to the DBD is controlled by the access
rules. The dataset name in the rule is the pseudo dataset name.
Interface to RACF
The RACF interface macro RACROUTE is available only when using an Assembler
program. If your security exit program is written in COBOL or PL/I, you have to create a
separate Assembler program that invokes RACROUTE and CALL this Assembler program
from the security exit program.
The program which invokes RACROUTE passes parameters that are listed with the
RACROUTE macro.
Because RACF does not have DBD protection built-in, two methods can be used to
implement DBD security.
1. Define a new resource class (DBD) to RACF by updating the Class Descriptor Table
(CDT) with the ICHERCDE macro. This new resource class is then used in the
RACROUTE macro, which passes the DBD name as the entity name.
2. The second method does not require the definition of a new resource class. Instead,
the DATASET resource class is used. Pseudo dataset names are created out of the DBD
name and other IMS information (for example, ’SYSID.DBDNAME’). This pseudo
dataset name is the entity passed in the RACROUTE macro, which uses a resource
class of DATASET.
The access authority (ATTR) should be READ for Browse and Extract processing (options 1
and 4.1) and UPDATE for Edit and Load processing (options 2 and 4.2).
After the security exit program is installed, access to the DBD is controlled using the
PERMIT function of RACF. The entity name is the DBD name if the first method was used
or the pseudo dataset name if the second method was used.
Interface to TOP SECRET
If your installation has TOP SECRET DBD security fully implemented, databases are
automatically protected by TOP SECRET, and a program interface is not required.
The TOP SECRET Application Interface TSSAI provided with TOP SECRET is a callable
program used to verify access permission. It can be invoked from programs written in
Assembler or COBOL. If your security exit program is written in PL/I, you have to create a
separate Assembler or COBOL program that CALLs TSSAI and CALL that program from
the PL/I program.
The calling program passes a parameter list to TSSAI via a dynamic CALL. Parameter list
copy-members are provided with TOP SECRET in Assembler and COBOL programming
languages.
The Class Name used in the parameter list should be DBD. The resource name is the
actual name of the DBD. The Access Level should be READ for Browse and Extract
processing (options 1 and 4.1) and UPDATE for Edit and Load processing (options 2 and
4.2).
After the security exit program is installed, access to the DBD is controlled using the
PERMIT/REVOKE function of TOP SECRET.
File-AID for IMS Exits
E-15
Compile and Link Security Exit
If you wrote your own security exit program, you must compile and link it into the
File-AID for IMS load library. Refer to “1) Security Exit PROC JCL (for ASM, COB, PLI, or
Default)” on page 7-13 for more information about compiling and linking the security
exit.
File-AID Segment Control Exit
The segment control exit program is called from six different points during File-AID for
IMS/ISPF processing:
1. Initialization Exit - Before any segments are processed.
2. Early Read Exit - As soon as the segment is obtained from DL/I.
3. Late Read Exit - After the segment has passed any criteria but before it is displayed (if
doing browse/edit), before sub functions are performed (for batch), and before it is
written to the extract dataset (for extract).
4. Early Write Exit - Before the segment is replaced, inserted or deleted.
5. Late Write Exit - Before a DL/I insert or replace call is performed for a segment.
6. Termination Call - Terminates each segment with an exit specified.
Initialization Exit
For each segment with a segment control exit defined, the exit routine will be called for
initialization. The purpose of the initialization call is to allow the exit routine to do any
necessary initialization processing. The initialization call also allows the exit routine to
indicate which of the other exit calls should be activated for the segment type or to
disallow the entire process, if desired.
Early Read Exit
Two functions can be performed by the early read exit routine. If segment
expansion/compression is being performed, the segment must be expanded by this exit
call. Also, sensitive segment hiding, if applicable, must be performed by this exit call.
The DBD segment format (input segment format) can be fixed or variable and the output
segment format can be fixed or variable. The format of the input segment is determined
by the IMS DBD. The format of the output segment is specified by the user in the
Segment Control Exit Table. See “Activating Segment Control Exits” on page E-17 for
information on segment compression.
Although the early read exit need not do segment expansion, the terminology used
assumes that it does. The format of the segment, which is output from the early read exit,
is referred to as the expanded segment format. The other format is referred to as the DBD
defined format.
The action performed by this exit call, either segment expansion or segment bypass, must
be repeatable for the same segment occurrence. File-AID for IMS/ISPF may reread a
segment or a series of segments. If the action performed by this exit call is not consistent
for the same segment occurrence, the reread would not be consistent; in this case the
results are unpredictable.
Note:
File-AID for IMS/ISPF does not monitor whether the action is repeatable.
E-16
File-AID Single Install Image Installation and Configuration Guide
Late Read Exit
This exit call allows sensitive data replacement, and indicates whether the segment can
be replaced or deleted. It can also indicate whether repeat or repeat all can be performed
on the segment.
Sensitive data replacement can be performed for both edit/browse and extract. If
sensitive data replacement is done during edit, that segment occurrence will be displayed
such that no typeovers can be done and any attempt to delete it or use it as the target of
a repeat function are treated as an error.
A FIND command will be performed using the real segment values, but the displayed
segment will reflect the replaced sensitive data. A CHANGE command is invalid if the
late read exit is active for the target segment(s) or potential target segments.
If the exit indicates that insert is not allowed, this is interpreted as repeat (or repeat all)
not allowed for the segment. Insert not allowed is not applicable to File-AID for
IMS/FLEX.
Note that if sensitive data replacement is being done, all selection criteria is performed
on the real segment data. Since this is true, the exit may want to replace fields in
addition to the fields that contain the sensitive data. For example, if salary over $10,000
per month is considered sensitive, the exit should not only change the salary if it is over
$10,000 per month, but also change any other identifying fields. So, an extract using
selection criteria of SALARY > 10,000 could not obtain the names of those making over
$10,000 per month.
Note:
The length and the format of the segment cannot be changed.
Early Write Exit
This exit call allows the exit routine to disallow the replace or insert based on the data
content of the replace segment or segment being inserted. The exit is also called prior to
a delete to disallow the delete. For a replace, the exit routine can examine the original
segment and the updated segment to determine if the replace should be allowed.
The replace could be the result of a typeover during edit, a CHANGE sub function for
BATCH, or a LOAD being done in update mode. The insert could be the result of an
insert, repeat, or repeat all during edit; an INSERT sub function for BATCH; or a LOAD
being performed in load mode.
If an insert is disallowed, than any inserts of children of the disallowed insert are not
inserted. This could occur for repeat all, BATCH INSERT or a load operation.
For File-AID for IMS/FLEX, during the validation phase, if an exit is defined for a segment
and the batch statement includes a change, delete, or insert, a warning message is issued
indicating that the change, delete, or insert may be rejected by the segment control exit.
During execution, the change, delete, or insert could be rejected by the segment control
exit explicitly if the late read exit or the early write exit set allow-replace, allow-delete, or
allow-insert to N. Also, if any segment data is replaced by the late read exit, allow-change
and allow-delete are implicitly set to N. If the conditions calling the change, delete, or
insert are met, an error will be returned instead of the change, delete, or insert being
performed.
When an insert or delete is not allowed (using File-AID for IMS/FLEX), the database
position is the same as if the insert or delete was not attempted.
Late Write Exit
If segment compression is being performed, it must be done at this time. The input
segment format (fixed or variable length) is defined by the Segment Control Exit Table.
This is also referred to as the expanded segment format. The output segment format is
File-AID for IMS Exits
E-17
defined by the IMS DBD. The input segment can be fixed length or variable length. The
output segment must be variable length.
Termination Exit
For each segment with an exit specified, the exit is called for termination. The purpose is
to delete any loaded modules and free any acquired memory.
Activating Segment Control Exits
The Segment Control Exit Table provides File-AID with the names of the segments which
have a Segment Control Exit specified. The system is shipped with a sample table. To
activate exits, you must compile and link your own Segment Control Exit Table. The
table can either be linked into XIXINTF, or it must be present in the File-AID load library.
The sample table is shipped already in the load library, but not linked into XIXINTF.
Refer to “3) Segment Control Exit” on page 7-14 to assist you in generating JCL to
assemble and link the table; refer to “3) Segment Control Exit” on page 7-14 for more
information. This job contains one sample entry. To activate exits, replace the sample
entry and add any other entries you may need. Doing the assembly and link will replace
the sample table.
The Segment Control Exit Table (named XIXSGMT) consists of a prefix and a set of items
for each segment for which a Segment Control Exit routine should be invoked.
The items specified for each segment are:
1. DBD name.
2. Segment name.
3. Exit program name.
4. Exit table name (optional).
5. Whether the expanded segment format is fixed length or variable length, or that
compression/expansion is not being done.
If segment compression/expansion is not being performed for the segment, this field
should be set to N. Segment compression/expansion is only valid if the DBD segment
format is variable length. If compression/expansion is being performed, this field
must be set to V if the expanded segment format is variable length and F if the
expanded segment format is fixed length. When the expanded segment format is
fixed length, File-AID adjusts all DBD specified segment offsets by -2 to
accommodate the fact that the first two bytes of the compressed segment were the 2byte segment length which is not present on the expanded segment.
Segment compression is not supported for a logical child/logical parent concatenated
segment.
6. The length of the expanded segment. This field is required if the expanded format is
fixed; otherwise it is optional. If the expanded format is variable, the content of this
field indicates the maximum size of the expanded segment.
Note:
When the Early Read Exit is used with variable length segments, and if the
EXPANDED-SEG-FORMAT variable is set to F, then the segment length value
returned will be equal to the maximum length of the segment as defined
within the DBD. To force the length to the value specified within the
Segment Control Exit Table, the EXPANDED-SEG-FORMAT variable must be
set to N.
7. The length of a work area for the exit routine to use. If a value is provided, a work
area of this size will be passed to the exit when it is invoked.
E-18
File-AID Single Install Image Installation and Configuration Guide
If a segment is used in one or more logical DBDs, there must be an entry in the segment
control table for the physical and for each of the logical DBDs. This is the only way the
exit can be called when the segment is accessed using that DBD.
If there is no entry in the Segment Control Exit Table for a segment or if there is an entry
but the exit program name is blank for the segment, this indicates that there is no
Segment Control exit program for the segment. A blank table name indicates that there
was no table data for that segment. For segments having a common exit name or table
name, the link-edit attributes determine whether the same copy is used.
Note:
Members ASMSEGXT, COBSEGXT, and PLISEGXT of your sample library are
sample Assembler, COBOL, and PL/1 segment control exit programs, respectively.
Data Exit Interface
The following information describes the call interface and parameters used to pass
control to the exit.
Note:
Compile your exit program using the RENT compiler option and link edit it as
RENT to make it eligible for PLPA residence.
Call Parameters
CALL exitname (DATA-EXIT-PARMS, INPUT-SEGMENT, OUTPUTSEGMENT, CONCATENATED-KEY,
SEGMENT-SPECIFIC-EXIT-WORKAREA, COMMON-DATA-EXIT-WORKAREA, TABLE-DATA)
DATA-EXIT-PARMS is the parameter list passed to the Segment Control exit. The layout of
the DATA-EXIT-PARMS along with the description of each field can be found in Table E11 on page E-19.
INPUT-SEGMENT is the segment supplied as input to the exit routine. Following
considerations relate to the INPUT-SEGMENT:
• For the early read exit, it is in the format obtained from DL/I.
• For the late read exit it is the same as the output segment from the early read exit.
• For the early write exit, the input segment depends on the function being performed.
For a delete function, it is the segment being deleted; for an insert function, it is the
segment be inserted; for a replace function it is the replacing segment.
• For the late write exit, if there were no exit, this segment would be inserted or replace
the existing segment.
Note:
The definition of these areas will need to be updated within the sample exit to
match the length of the segment.
OUTPUT-SEGMENT is normally the segment which will be used for subsequent
processing. Except for the early write exit when the exit routine is called, the output
segment is a copy of the input segment. For the early write exit with a delete function,
the output segment is the same as the input segment; with a replace function, it is the
replacing segment; with an insert function, it is the same as the input segment.
Note:
The definition of these areas will need to be updated within the sample exit to
match the length of the segment.
CONCATENATED-KEY is the concatenated key in the DL/I PCB. Note that this may not
be the segment’s physical path concatenated key; it is the concatenated key of the path
used to obtain the segment. For example, if using a secondary index as a processing
sequence, the root key is the key of the secondary index.
File-AID for IMS Exits
E-19
SEGMENT-SPECIFIC-EXIT-WORKAREA is an optional area specific to this segment type.
The length is specified in the Segment Control Exit Table and is provided to the exit
routine in parameter field PRMSCXIT-SEG-WORK-LEN. If this length is 0, this parameter
should not be used. The area is initialized to binary zero and is unchanged by File-AID for
IMS/ISPF during the entire session. It can be used to retain data regarding this segment
type across multiple calls to the exit. If using this area, note that the exit routine cannot
make any assumptions regarding the order in which the exit calls are made to the exit
routine. See “Exit Order” on page E-21.
COMMON-DATA-EXIT-WORKAREA is a 4000-byte area initialized to binary zero. The area
is unchanged by File-AID for IMS/ISPF during the entire session and can be used to retain
data across multiple calls to all Segment Control exits.
TABLE-DATA is optional and is the address of the load module with this name specified
for table data in the segment entry of the Segment Control Exit Table. If table data was
not specified in the Segment Control Table, this points to an 8-byte field containing the
character string INACTIVE. The purpose of table data is to allow a generic exit routine to
examine the table data for the segment, and perform actions on the segment based on
the information in the table. When compression is performed, it could be the module
which performs the compression. In this case, it is an executable module rather than a
table.
Segment Control Parms Layout
The following tables identify the layout for Segment Control parms.
Note:
Binary values should be aligned on half-word, word boundaries as appropriate.
Data-Exit-Parms—Input Parms
Table E-11 identifies the input parameters for segment control exits.
Table E-11. Data Exit Input Parms
Fields
EXIT-TYPE
Length
1
Format
CHAR
USER-ID
FUNCTION
7
1
CHAR
CHAR
SUB-FUNCTION
1
CHAR
Description
I Initialization call
E Early read call
L Late read call
A Early write call
Z Late write call
T Termination call
TSO or Batch User ID
1 Browse
2 Edit
3 File-AID for IMS/FLEX or Data Base Initialization
4 Extract/Load
For function 3:
1 Data Base Initialization
2 Batch
For function 4:
BATCH-ONLINE-IND
1
CHAR
JOB-TYPE
BMP-IPRMS-ENT
IMS-ID
IXP-VERSION
5
4
8
8
CHAR
CHAR
CHAR
CHAR
1 Extract
2 Load
B Batch operation
O Online operation (ISPF)
Batch, BMP or IRC
BMP IPRMS entry
IMS or CICS system ID
Version of File-AID for IMS/ISPF being used. Format is
vv.rr.mm (where vv is the version number, rr is the
release number, and mm is the maintenance release
number).
E-20
File-AID Single Install Image Installation and Configuration Guide
Table E-11. Data Exit Input Parms (Continued)
Fields
LOGICAL-DB-NAME
PHYSICAL-DB-NAME
SEGMENT-NAME
DB-DATASET-NAME
DB-NAME-SOURCE
Length
8
8
8
44
1
Format
CHAR
CHAR
CHAR
CHAR
CHAR
DBD-SEG-FORMAT
1
CHAR
EXPANDED-SEGFORMAT
1
CHAR
CONCAT-KEY-LEN
2
Binary
SEG-KEY-LEN
SEG-KEY-OFFSET
COMPRESS-SEG-LEN
DBD-SEG-LEN
EXPAND-SEG-LEN
2
2
2
2
2
Binary
Binary
Binary
Binary
Binary
SEG-WORK-LEN
PSP-TYPE
2
1
Binary
CHAR
PSB-NAME
WRITE-FUNC
8
1
CHAR
CHAR
CHANGE-SUB-FUNC
INSERT-SUB-FUNC
DELETE-SUB-FUNC
PRINT-SUB-FUNC
COUNT-SUB-FUNC
Reserved space
UPDATE-IND
1
1
1
1
1
1
1
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
Reserved space
9
CHAR
Description
DB name, either logical or physical
Physical DB name
Segment name
DSN of first dataset for database
A Actual DSN allocated to IMS
N Not available, above field is blank
This indicates where the DSN was obtained. For DLI
region it will always be A. For BMP or IRC it will be A if
the user security exit activated the security dataset
names exit; else it will be N for not available.
F Fixed
V Variable
F Fixed
V Variable
N Compression/expansion not performed. Format is
the same as DBD SEG FORMAT.
Length of the concatenated key. In all cases this is the
length of the concatenated key up to the segment. It
does not include the key of the current segment. For the
root segment, it is 0.
Length of segments key field; 0 if no key
Offset to key of segment; 0 if no key
Length of the segment obtained from DL/I
DBD fixed length or maximum variable length
Length of the expanded segment. The content of this
field depends on the combination of the DBD segment
format and the expanded segment format. DBD fixed
(compression not supported) = DBD segment length.
DBD variable/EXPANDED-SEG-FORMAT N = length of
segment obtained by DL/I.
DBD variable/EXPANDED-SEG-FORMAT V = length of
segment from early read exit.
DBD variable/EXPANDED-SEG-FORMAT F = length of
expanded segment from segment control exit table.
Length of segment specific work area
S Static
D Dynamic
PSB Name - Static PSB only
D Delete
I Insert
R Replace
Y if batch sub-function of change
Y if batch sub-function of insert
Y if batch sub-function of delete
Y if batch sub-function of print
Y if batch sub-function of count
Reserved space
Y or N. This indicates whether the step can potentially
do updates. It is on for edit and load. It is off for browse
and extract. For batch it indicates whether any
statements using the PCB containing this segment
include a subcommand of CHANGE, DELETE or INSERT.
Reserved space
File-AID for IMS Exits
E-21
DATA-EXIT PARMS—Output Parms
Table E-12 identifies the output parameters for segment control exits.
Table E-12. Data Exit Output Parms
Fields
INIT-FAIL-IND
ACT-EARLY-READ
ACT-LATE-READ
ACT-EARLY-WRITE
ACT-LATE-WRITE
ALLOW-REPLACE
ALLOW-DELETE
ALLOW-INSERT
BYP-SEG-IND
MESSAGE-NUMBER
Reserved space
Length
1
1
1
1
1
1
1
1
1
8
7
Format
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
Description
Y if exit could not initialize
Y to activate early read exit
Y to activate late read exit
Y to activate early write exit
Y to activate late write exit
Y to allow replace*
Y to allow delete*
Y to allow insert*
Y to bypass segment**
Message number
Reserved space
Default is Y. These parameters are valid for the late read exit and for early write exit. If N
is specified for the late read exit, File-AID for IMS/ISPF prevents the action from being
initiated. For example, if replace is N for edit, the segment will be displayed in output
mode so that typeovers cannot be done. If an insert or delete is attempted, an error
message will be displayed. When an update is allowed by the late read exit, the early
write exit can disallow the update based on the data content of the segment being
inserted or the replace data of the segment being replaced. For a replace function, the
original and the replacing segments are available to the exit. If N is specified by the early
write exit, the update is not performed and a message is displayed. The early write exit
can supply the message number which will preempt the File-AID for IMS/ISPF message.
Delete allowed or disallowed applies only to the current segment. It does not apply to
cascaded deletes done when a parent is deleted. repeatable for the same segment
occurrence. In some cases, File-AID for IMS/ISPF disregards the setting of this parameter.
An example is when the dependents of a deleted segment are being read in order to write
them to the audit trail. The early read exit is called so the segment can be expanded, but
in this case the bypass-segment parameter is disregarded. Another example is when the
segment is being read to perform a repeat all function. Essentially, this parameter is
disregarded when File-AID for IMS/ISPF is reading the segment to perform File-AID for
IMS/ISPF internal processing.
Other Important Information
This section contains additional information you should know about segment control
exits.
Exit Order
The exit routine cannot make any assumptions regarding the order of the four possible
exit calls for a segment occurrence. For example, when doing edit or browse in character
mode, the early read exit and late read exit will be invoked for all segments on the screen
prior to any early write calls. The exit routine must treat each invocation as an
independent process, unrelated to preceding invocations.
Exit Points and Valid Functions
Table E-13 contains the various exit points and the corresponding functions applicable to
the exit.
E-22
File-AID Single Install Image Installation and Configuration Guide
Note:
IMS calls by the exits are not valid.
Table E-13. Data Exit Output Parms
Function
Set initialization failed
Set activate early read exit
Set activate late read exit
Set activate early write exit
Set activate late write exit
Set allow replace
Set allow delete
Set allow insert
Set bypass segment
Set message number
Compress/expand segment
Replace sensitive data
Initial
Exit
Y
Y
Y
Y
Y
N
N
N
N
Y
N
N
Late
Early
Read Exit Read Exit
N
N
N
N
N
N
N
N
Y
N
Y
N
N
N
N
N
N
Y
Y
Y
N
N
N
Y
Early
Write
Exit
N
N
N
N
N
Y
Y
Y
N
Y
N
N
Late
Write
Exit
N
N
N
N
N
N
N
N
N
N
Y
N
Potential Implications of the Exit Changing Segment Data
Following are examples of problems which can occur when an exit modifies the data:
• If a segments key field is changed on extract and the data is subsequently loaded, IMS
status codes could result (indicating out of sequence or duplicate segment).
• If a segment’s key field is changed during edit, an IMS error status code will result
when the segment is replaced.
• Changing the key field of a logical parent, a parent of a logical parent, or the
concatenated key of a logical child will result in error status codes from IMS, or
logical children without logical parents.
Potential Implications of Bypassing Segments
Following are examples of problems which can occur when segments are bypassed:
• If a logical parent is bypassed, the resulting database may contain logical children
without logical parents.
• For a segment with a unique key, an attempt to retrieve the segment by key will
result in a not found condition. An attempt to insert the segment will result in an
error indicating that the segment is a duplicate of an existing segment.
File-AID for IMS Exits
E-23
Application Relationship Exit
The File-AID for IMS/ISPF application relationship exit module that you specify in Option
9 (Application Relationships) is an optional user written module called during the extract
process. This exit module is called after the target key is constructed from the source
segment fields. This exit module (also known as the source segment exit module) can
manipulate the target key and include up to 29 other target root keys to be extracted. You
can use the Application Relationship exit to:
• Convert a packed source field into a zoned target key.
• Add a constant prefix or suffix to the constructed target key.
• Add up to nine more target root keys to extract based on one source segment.
• Convert an encoded source key to a fully decoded target root key.
• Change the target key based on several fields in the source segment or from several
fields in multiple source segments.
• Decide whether to chase this source’s relationship based on data in this source
segment.
• Change the data in the source segment before it is written to the extract dataset.
Your source segment exit module can be written in COBOL, PL/I, or ASM. The exit
module can be compiled and linked into the same load library as File-AID. If you want to
keep the application relationship exits separate from the File-AID load library, you can
create your own load library and then modify SLIB member IXJDTFDV to include this
new library in the STEPLIB DD. The name of the exit module in the load library must be
the same as the name specified in Option 9 (Application Relationship). Three sample
application relationship exit modules are included with File-AID for IMS/ISPF in the
Sample dataset (SXVJSAMP):
ARCOBXT
COBOL application relationship exit program source
ARPLIXT
PL/I application relationship exit program source
ARASMXT
ASM application relationship exit program source
Refer to “2) Application Relationship Exits” on page 7-14 to assist you in generating JCL
to assemble and link your application relationship exits; refer to “2) Application
Relationship Exits” on page 7-14 for more information.
The following call sequence and parameters are used to interface with the source segment
exit module:
CALL SEQUENCE
CALL source segment exit module (SOURCE-SEGMENT-EXIT-PARMS,
TARGET-ROOT-KEYS-TABLE,
SOURCE-SEGMENT,
CONCATENATED-KEY,
AR-EXIT-WORK-AREA)
E-24
File-AID Single Install Image Installation and Configuration Guide
SOURCE-SEGMENT-EXIT-PARMS LAYOUT
01
SOURCE-SEG-EXIT-PARMS.
03 INPUT-PARMS.
05 SOURCE-DBD-NAME
05 SOURCE-SEGMENT-NAME
05 SOURCE-SEGMENT-LENGTH
05 TARGET-DBD-NAME
05 TARGET-SEGMENT-NAME
05 CONSTRUCTED-TARGET-KEY-LENGTH
PIC
PIC
PIC
PIC
PIC
PIC
X(8).
X(8).
S9(4) COMP.
X(8).
X(8).
S9(4) COMP.
(see below)
03 INPUT-OUTPUT-PARMS.
05 TARGET-NO-TO-EXTRACT
PIC
S9(4) COMP.
(see below)
03 OUTPUT-PARMS.
05 EXTRACT-ROOT-IND
PIC
05
EXTRACT-CHANGED-SOURCE-SEG
X.
(see below)
PIC X.
(see below)
CONSTRUCTED-TARGET-KEY-LENGTH is the sum of the lengths of source fields that
construct the target root key.
TARGET-NO-TO-EXTRACT is the number of target root keys that reside on the TARGETROOT-KEYS-TABLE. When the exit module is called, the constructed target root key is
placed in the first entry of the TARGET-ROOT-KEYS-TABLE and this value is set to one.
Upon return from the exit module, File-AID uses this value, (0 - 30), as the number of
target keys in the TARGET-ROOT-KEYS-TABLE. If the value is zero, File-AID assumes there
are no target root segments to be extracted.
The EXTRACT-ROOT-IND (Y/N) indicates whether the application relationship for this
source segment should be extracted.
The EXTRACT-CHANGED-SOURCE-SEG (Y/N) indicates whether the extracted segment
should be taken from the SOURCE-SEGMENT-DATA area. If N, the extracted segment is
taken from the database. If Y, the segment is taken from the SOURCE-SEGMENT-DATA
area instead. The default is N. This action allows the exit to modify the extracted
segment. The area is refreshed from the database on each invocation of the exit. The
segment is written to the extract dataset following the last invocation of the exit module.
Therefore, if the exit is invoked multiple times for the same segment, the exit should set
EXTRACT-CHANGED-SOURCE-SEG to Y and make all changes to the source segment only
on the last invocation.
Note:
If the segment is variable length, the length field should not be changed.
Changes to the sequence field could cause out-of-sequence conditions on later
use of the extracted data.
TARGET-ROOT-KEYS-TABLE LAYOUT
01
03
TARGET-ROOT-KEYS-TABLE.
TARGET-ROOT-KEY OCCURS 30
PIC X(255).
By default, the TARGET-ROOT-KEYS-TABLE contains up to ten target root keys. When the
exit module is called, the first entry contains the constructed target root key based on the
application relationship. The exit module can manipulate this key and add up to 29 more
target root keys in this table to be extracted. The TARGET-NO-TO-EXTRACT contains the
number of target root keys in the TARGET-ROOT-KEYS-TABLE.
SOURCE-SEGMENT DATA LAYOUT
01
SOURCE-SEGMENT-DATA
PIC X(30720).
File-AID for IMS Exits
E-25
SOURCE-SEGMENT-DATA is a 30720-byte field that contains the source segment being
extracted. The exit module can manipulate the source segment in this area. Changes
made here do not affect the source segment in the database. See the EXTRACTCHANGED-SOURCE-SEG field in the SOURCE-SEG-EXIT-PARMS to find where the
segment written to the extract dataset is obtained.
CONCATENATED-KEY LAYOUT
01
CONCATENATED-KEY
PIC X(3825).
CONCATENATED-KEY is a 3825-byte area that contains the fully concatenated key of the
source segment. The length of 3825 bytes allows for the maximum individual key length
of 255 bytes multiplied by the maximum number of hierarchical database levels of 15.
The layout of the concatenated key in the CONCATENATED-KEY field is identical to its
layout in the key feedback area of a standard IMS PCB.
AR-EXIT-WORK-AREA LAYOUT
01
AR-EXIT-WORK AREA
PIC X(4096).
AR-EXIT-WORK-AREA is a 4096-byte work area initialized to binary zeros. This area is
unchanged by File-AID for IMS/ISPF during the entire extract and can be used to retain
information across multiple calls to the application relationship exit.
E-26
File-AID Single Install Image Installation and Configuration Guide
XIXTDLI User Exit
The XIXTDLI user exit allows customers to intercept certain database calls made by
File-AID for IMS and replace them with their own DLI processing routine. The exit may be
written in COBOL, PLI or Assembler. Currently the exit is restricted to batch processing
using a STATIC PSB. INIT, CHKP and GSCD calls will not be passed to the exit. The exit
will be called during database extract, load or initialization processing only. It is not
called during execution of FLEX processing.
This exit is enabled by creating an XIXTDLI load module to process standard IMS DLI
calls. The XIXTDLI module is called instead of the standard IMS calls normally issued by
the product to process IMS data.
IMS calls that are passed to the exit include the following:
• GN
• GHN 
• GU
• GHU
• GHNP
• GNP
• ISRT
• DLET
• REPL
The XIXTDLI module may be coded in 24 or 31 bit addressing mode. It is recommended
that XIXTDLI be linked as a separate load module. If necessary, it may be statically linked
into the XIXINTF load module.
The exit module can be compiled and linked into the same load library as File-AID for
IMS.
Note:
Because this exit replaces conventional IMS processing, please contact File-AID
for IMS Customer Support before implementing the XIXTDLI user exit.
XIXTDLI EXIT Interface
The following information describes the call interface and parameters used to pass
control to XIXTDLI.
Note:
Compile your exit program using the RENT compiler option and link edit it as
RENT to make it eligible for PLPA residence.
CALL Parameters
The following call sequence and parameters are used to interface with the XIXTDLI exit
module.
CALL XIXTDLI
•
•
•
•
•
•
•
•
PSB-PTR
DBD-NAME
PARM-COUNT
MSG-ID
CALL-TYPE
IMS-PCB
IO-AREA
SSA1
File-AID for IMS Exits
•
•
•
•
•
•
•
•
•
•
•
•
•
•
E-27
SSA2
SSA3
SSA4
SSA5
SSA6
SSA7
SSA8
SSA9
SSA10
SSA11
SSA12
SSA13
SSA14
SSA15
Input/Output Parameters for the XIXTDLI EXIT
Table E-14 list the Input/Output Parameters for the XIXTDLI EXIT.
Table E-14. Input/Output Parameters for the XIXTDLI EXIT
Fields
Length
Type
Description
Input or Output
PSB-PTR
4
POINTER
Pointer to the PSB (PCB list) in use at the time the
XIXTDLI exit is called. This address should not be
modified by the XVJTDLI user exit.
Input
DBD-NAME
8
CHAR
DBD name in use at the time the DLI exit is called.
Input
PARM-COUNT
4
BINARY
Parameter count. This is the number of parameters
Input
that File-AID for IMS would use to make the DLI call to
IMS. It will always have a value greater than or equal
to 3. PARM-COUNT - 3 is equal to the number of SSA's
that have been coded for the IMS call found in CALLTYPE.
MSG-ID
8
CHAR
Error message ID is an ISPF error message that may be Output
set by the DLI exit. If error messages are set by the exit,
appropriate message members must be created and
made available to the IXPMLIB DD concatenation used
during extract, initialize or load processing.
CALL-TYPE
4
CHAR
IMS DLI call type coded by File-AID for IMS.
Input
Start of IMS PCB
PCB-DBD-NAME
8
CHAR
PCB DBD name. This field should not be modified by
the XIXTDLI user exit.
Input
PCB-LVL-NO
2
CHAR
IMS PCB level number. The XIXTDLI user exit must
return the correct PCB level number associated with
the PCB segment returned to File-AID for IMS by this
database call.
Output
PCB-STATUS-CODE
2
CHAR
IMS status code.
Output
PCB-PROC-OPT
4
CHAR
PCB PROC OPT.
Output
PCB-JCB-ADDR
4
BINARY
PCB JCB address
Output
PCB-SEG-NAME
8
CHAR
IMS segment name returned to File-AID for IMS by this Output
database call.
PCB-KEY-LGTH
4
BINARY
Segment key length of IMS segment returned to
File-AID for IMS by this database call.
Output
PCB-NO-SENSEGS
4
BINARY
PCB number of sensitive segments
Output
PCB-KFB-AREA
3825
CHAR
PCB key feedback area. This storage area should
Output
contain the concatenated key of the segment returned
to File-AID for IMS by this database call.
E-28
File-AID Single Install Image Installation and Configuration Guide
Table E-14. Input/Output Parameters for the XIXTDLI EXIT (Continued)
Fields
Length
Type
Description
Input or Output
PCB-KFB-AREA
IO-AREA
32767
CHAR
PCB I/O area returned by IMS.
SSA1
Varies
CHAR
If PARM-COUNT is equal to or greater than 4, SSA1 will Input
contain the first SSA coded for the IMS call.
SSA2
Varies
CHAR
If PARM-COUNT is equal to or greater than 5, SSA2 will Input
contain the second SSA coded for the IMS call.
SSA3
Varies
CHAR
If PARM-COUNT is equal to or greater than 6, SSA3 will Input
contain the third SSA coded for the IMS call.
SSA4
Varies
CHAR
If PARM-COUNT is equal to or greater than 7, SSA4 will Input
contain the fourth SSA coded for the IMS call.
SSA5
Varies
CHAR
If PARM-COUNT is equal to or greater than 8, SSA5 will Input
contain the fifth SSA coded for the IMS call.
SSA6
Varies
CHAR
If PARM-COUNT is equal to or greater than 9, SSA6 will Input
contain the sixth SSA coded for the IMS call.
SSA7
Varies
CHAR
If PARM-COUNT is equal to or greater than 10, SSA7
will contain the seventh SSA coded for the IMS call.
Input
SSA8
Varies
CHAR
If PARM-COUNT is equal to or greater than 11, SSA8
will contain the eighth SSA coded for the IMS call.
Input
SSA9
Varies
CHAR
If PARM-COUNT is equal to or greater than 12, SSA9
will contain the ninth SSA coded for the IMS call.
Input
SSA10
Varies
CHAR
If PARM-COUNT is equal to or greater than 13, SSA10 Input
will contain the tenth SSA coded for the IMS call.
SSA11
Varies
CHAR
If PARM-COUNT is equal to or greater than 14, SSA11 Input
will contain the eleventh SSA coded for the IMS call.
SSA12
Varies
CHAR
If PARM-COUNT is equal to or greater than 15, SSA12 Input
will contain the twelfth SSA coded for the IMS call
SSA13
Varies
CHAR
If PARM-COUNT is equal to or greater than 16, SSA13 Input
will contain the thirteenth SSA coded for the IMS call.
SSA14
Varies
CHAR
If PARM-COUNT is equal to or greater than 17, SSA14 Input
will contain the fourteenth SSA coded for the IMS call.
SSA15
Varies
CHAR
If PARM-COUNT is equal to 19, SSA15 will contain the Input
fifteenth SSA coded for the IMS call.
Note:
Output
The maximum length of an SSA is determined by the length of the segment key.
If the segment is un-keyed the actual and maximum SSA length is 13. If the
segment is keyed and the DBD is not an MSDB, the maximum SSA length is the
length of the segment key plus 24 bytes. For an MSDB DBD, the maximum SSA
length is twice the segment key length plus 24 bytes. To determine the actual
length of the SSA for keyed segments, check position 14 of the SSA for the
presence of a blank (hex '40'). If this position is a blank, the SSA is unqualified
and the actual SSA length is 13. If position 14 does not contain a blank, it should
contain an open parenthesis (hex '4D'). If this is the case, the SSA is qualified and
the actual SSA length is equal to the maximum SSA length.
File-AID for IMS Exits
E-29
Audit Trail Write User Exit
The Audit Trail Write Exit is called before a record is written to the audit trail. This exit
can be used to write the audit trail to a different location than the two standard options
available through File-AID (Audit trail dataset and SMF).
The File-AID Sample library (SXVJSAMP) includes two sample Audit Trail Write exits:
COBATXT : COBOL Audit Trail Write exit Program source.
PLIATXT : PL/I Audit Trail Write exit program source.
If you wrote your own Audit Trail Write exit program, you must compile and link it into
the File-AID LOAD library. The module must have a name of XIXATXT.
Note:
Before File-AID for IMS can report on the contents of an audit trail it must be in
the format of the standard File-AID for IMS audit trail dataset.
CALL Parameters
The following information describes the call parameters.
CALL XIXATXT (audit-write-parms, audit-write-work-area)
audit-write-parms : This is the parameter list passed to the audit trail write exit. Layouts
and a description of these fields are described in Table E-15.
audit-write-work-area : This is a 256 byte work area initialized to binary zeroes. This area is
unchanged by File-AID for IMS/ISPF during the entire user session and can be used to
retain information across multiple calls to the Audit Trail Write exit.
Table E-15 list the Input Parameters for the Audit Trail Write exit.
Table E-15. Input Parameters for the Audit Trail Write Exit
Fields
Length
Type
Description
SMF-RECORD-ID
1
BINARY
00 indicates that SMF is not used for audit trail. A number
between 128 and 255 indicates that SMF audit trail
recording is in use.
JOB-TYPE
5
CHAR
BATCH or BMP
DBD
8
CHAR
Primary DBD name.
RECORD-LENGTH
2
BINARY
Record Length of the Audit Trail Record passed to the
exit.
RECORD-POINTER
4
POINTER
Pointer to the Audit Trail record which is to be written.
PSB-POINTER
4
POINTER
Pointer to the PSB (PCB list) in use at the time the Audit
Trail Write Exit is called.
RECORD-TYPE
1
CHAR
1 : Header Record (multiple header records are written)
2 : Detail Record
3 : Trailer Record
Table E-16 list the Output Parameters for the Audit Trail Write exit.
Table E-16. Output Parameters for the Audit Trail Write Exit
Fields
Length
Type
Description
WRITE-INDICATOR
1
CHAR
Y : File-AID for IMS will write the Audit trail record to the
File-AID audit trail dataset or SMF.
N : The audit Trail Record will not be written by File-AID
E-30
File-AID Single Install Image Installation and Configuration Guide
File-AID for IMS/CICS and File-AID for IMS/DC Security
Exit
The following section describe the provided sample security exit for File-AID for IMS/CICS
and/or File-AID for IMS/DC. The differences for creating a security exit for either File-AID
for IMS/CICS or File-AID for IMS/DC are noted in the descriptions.
File-AID for IMS provides one exit type to the security exit. Its primary intent is to limit
database access and to control whether a user’s database updates are captured by the
Audit Trail feature. The default security exit routine provided with File-AID does no
processing and returns control immediately to File-AID.
The security exit receives control from the following locations:
1. From the Primary Option Menu when a DBD name is entered. Here, the security exit
can grant or deny access to the database. The message "ACCESS TO SPECIFIED DBD
IS PROHIBITED BY INSTALLATION SECURITY EXIT" is displayed if access was denied.
2. From the DBD Member List screen when DBD names are selected for display. If access
is granted to a particular database, its name is displayed on the member list.
Otherwise, access is denied and the DBD name does not appear on the member list.
In both these situations, when the user invokes the edit option, the security exit may
also force the Audit Trail feature to be activated or disabled for the database that is being
updated.
You may want to use the security exit to implement the following:
•
•
•
•
•
•
•
User ID - DBD security
User ID/Password - DBD security
LTERM - DBD security
User ID - transaction security
User ID - function security
The Audit Trail feature
Any combination of the above
The sample security exit provided implements some of these functions. It restricts access
to the employee database (DBD name = EMPLDBD) to user XAS001 whose password is
PERSONNL. DBDs that begin with PROJ can only be edited by users at LTERMs that begin
with XAS. Users with a userid ending in O who enter transaction SALR have access to
DBD SALRYDBD.
Security Exit Installation
The sample security exit is written in COBOL, although PL/I or Assembler can be used. If
the security exit needs to be PLPA eligible, make sure the exit is reentrant.
File-AID for IMS/CICS only:
You have the following options when installing a security exit:
1. XIXCSCXD - Compile and Dynamically Link a COBOL Exit
2. XIXCSCXS - Compile and Statically Link a COBOL Exit
File-AID for IMS/DC only:
You have the following options when installing a security exit:
1. XIXDSCXD - Compile and Dynamically Link a COBOL Exit
2. XIXDSCXS - Compile and Statically Link a COBOL Exit

File-AID for IMS Exits
E-31
If you previously created aliases to the main load module, you must create them
again (see “1) Create Aliases for XIXDMAIN (Required)” on page 9-18).
The following information describes the call interface and parameters used to pass
control to the security exit.
Call Sequence:
File-AID for IMS/CICS:
CALL IXCSCXT (SECURITY-PARMS, USER-WORK-AREA)
File-AID for IMS/DC:
CALL IXDSCXT (SECURITY-PARMS, USER-WORK-AREA)
USER-WORK-AREA is a 256 byte work area initialized to spaces. It is unchanged by
File-AID during the entire user session and can be used to retain information across
multiple calls to the security exit.
Security Parms Layout - INPUT PARMS
Table E-17 describes the input parms
Table E-17. Input Parms
Fields
Posn.
Length
Format
1
1
CHAR
1 (other types may be added in the future).
2-9
8
CHAR
Entered during CICS sign-on procedure.
Blank if sign-on not used.
PRIMARY-MENU-USER-ID
10-17
8
CHAR
Entered on Primary Option Menu.
PASSWORD
18-25
8
CHAR
Entered on Primary Option Menu.
DBD-NAME
26-33
8
CHAR
DBD being processed.
34
1
CHAR
1 Browse
EXIT-TYPE
SIGNON-USER-ID
OPTION-NUMBER
Description
2 Edit
LTERM
35-42
8
CHAR
Logical Terminal ID.
TRANSACTION
43-50
8
CHAR
CICS Transaction used to invoke File-AID.
FILLER
51-80
30
CHAR
Unused.
Security Parms Layout - INPUT PARMS/OUTPUT PARMS
Table E-18. Input/Output Parms
Fields
AUDIT-TRAIL-INDICATOR
DBD-PASSED-INDICATOR
Posn.
Length
Format
81
1
CHAR
82
1
CHAR
Description
Y
Audit Trail feature to be activated for this DBD.
N
Audit Trail feature to be disabled for this DBD.
Y
Access to this DBD allowed.
N
Access to this DBD denied.
E-32
File-AID Single Install Image Installation and Configuration Guide
F-1
Appendix F.
File-AID for IMS/CICS or File-AID for IMS/DC 
Batch DBD and XREF Update
Appendix A.
F
App F
To browse or edit your databases in the IMS/DC or CICS environment, the databases’
Data Base Definition (DBD) information must be made available to File-AID. File-AID
maintains an online CLT control database to store information about your databases’
segment definition and hierarchy.
The Batch DBD Update Facility retrieves the DBDs you specify from your DBD load
library, extracts and formats relevant information, and updates this information to the
CLT control database for use by online File-AID programs.
You need to run the DBD Update Facility when:
• A database needs to be accessed in File-AID. The database’s DBD information must be
added to the CLT control database.
• A DBD has changed. For example, segments are added to or deleted from a DBD.
These changes must be reflected on the CLT control database.
• A DBD no longer exists. This reference must be deleted from the CLT control
database.
In addition to storing DBD information, the DBD Update Facility enables you to specify a
30-character DBD description. The description is also stored in the CLT control database
and displayed on the DBD Member List screen in File-AID to make it easier for you to
determine the appropriate database to process.
To browse or edit databases in Formatted mode using your existing segment layouts as
templates over the segment’s data, the Cross-Reference Update program must be run to
allow File-AID access to these layouts. Refer to “Batch XREF Update Facility” on page F-8
for more information.
DBD Support
DBD load libraries must conform to the characteristics of a valid DBD load library, a
partitioned dataset (DSORG=PO) with an undefined record format (RECFM=U).
Validation of the dataset’s logical record length or blocksize is not done.
Checkpoints
The DBD Update Facility can be run as either a batch DL/I or an IMS BMP program. In
either type of processing, a checkpoint call (CHKP) is issued after each control card is
read. This process indicates to IMS that the program has reached a commit point. For
BMP processing, the checkpoint also releases the resources that IMS has enqueued for the
program. In the event of an abend, IMS backs out the database updates to the most recent
checkpoint. The DBD Update Facility, however, does not have restart capability.
F-2
File-AID Single Install Image Installation and Configuration Guide
DBD Update JCL
The following JCL streams are copies of procedures (PROCs) supplied with File-AID. Your
installation may have modified these PROCs to meet installation standards.
Sample JCL members are located in the File-AID sample library, SXVJSAMP. Member
name prefix XIXN indicates File-AID for IMS/CICS, prefix XIXO indicates File-AID for
IMS/DC.
File-AID for IMS/CICS DBDUPBMP–IMSBATCH Procedure
BMP job to update File-AID for IMS/CICS's CLT database with DBD information.
Figure F-1. DBDUPBMP–IMSBATCH JCL Procedure (JCL member XIXNDUPB)
//DBDUPBMP PROC RGN=4M
REGION SIZE
//*
//* ****DBDUPBMP PARAMETERS****
//
PRINT=’*’,
PRINT OUTPUT SYSOUT CLASS
//
SDFSRESL='XXXXXXX.SDFSRESL', IMS SDFSRESL
//
DBDLIB=’XXXXXXX.DBDLIB’,
IMS DBD LIBRARY
//
MLIBDSN=’XXXXXXX.SXVJMENU’, File-AID MLIB DSNAME
//
CXVJLOAD=’XXXXXXX.CXVJLOAD’, File-AID CXVJLOAD
//
SXVJLOAD=’XXXXXXX.SXVJLOAD’, File-AID SXVJLOAD
//* ****DFSRRC00 PARAMETERS
//
MBR=XIXDBDUP,
PROGRAM NAME IN SXVJLOAD
//
PSB=IXCUPLD,
PSB NAME
//
IN=,OUT=,OPT=,
IMS REGION CONTROLLER PGM
//
SPIE=,TEST=,DIRCA=,
PARAMETERS - FOR MORE INFO
//
PRLD=,STIMER=,CKPTID=,
ON THESE PARMS SEE THE
//
PARDLI=,CPUTIME=,NBA=,
IMS/VS SYSTEM PROGRAMMING
//
OBA=,IMSID=,AGN=
REFERENCE MANUAL
//*
//*----------------------------------------------------------------
//*
STEP1: BMP TO UPDATE File-AID/CICS CLT DATA BASE WITH 
//*
DBD INFORMATION
//*----------------------------------------------------------------
//STEP1 EXEC PGM=DFSRRC00,REGION=&RGN,
//
PARM=(BMP,&MBR,&PSB,&IN,&OUT,
//
&OPT&SPIE&TEST&DIRCA,&PRLD,&STIMER,&CKPTID,
//
&PARDLI,&CPUTIME,&NBA,&OBA,&IMSID,&AGN)
//STEPLIB
DD
DSN=&SDFSRESL,DISP=SHR
//
DD
DSN=&CXVJLOAD,DISP=SHR
//
DD
DSN=&SXVJLOAD,DISP=SHR
//
DD
DSN=CEE.SCEERUN,DISP=SHR
//DFSRESLB DD
DSN=&SDFSRESL,DISP=SHR
//SYSABEND DD
SYSOUT=&PRINT,DCB=(LRECL=121,RECFM=VBA,BLKSIZE=3129),
//
SPACE=(125,(2500,100),RLSE,,ROUND)
//ABNLDUMP DD DUMMY
//IXPD1
DD
DSN=&DBDLIB,DISP=SHR
//IXPMLIB
DD
DSN=&MLIBDSN,DISP=SHR
//SYSOUT
DD
SYSOUT=&PRINT
//
PEND
//*
//BMP
EXEC DBDUPBMP
//*----------------------------------------------------------------
//*INSERT PROGRAM CONTROL CARDS AFTER THE SYSIN DD STATEMENT
//*----------------------------------------------------------------
//SYSIN
DD
*
/*
//
File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update
File-AID for IMS/DC DBDUPBMP–IMSBATCH Procedure
BMP job to update File-AID for IMS/DC's CLT database with DBD information.
Figure F-2. DBDUPBMP–IMSBATCH JCL Procedure (JCL member XIXODUPB)
//DBDUPBMP PROC RGN=4M
REGION SIZE
//*
//* ****DBDUPBMP PARAMETERS****
//
PRINT=’*’,
PRINT OUTPUT SYSOUT CLASS
//
SDFSRESL='XXXXXXX.SDFSRESL', IMS SDFSRESL
//
DBDLIB=’XXXXXXX.DBDLIB’,
IMS DBD LIBRARY
//
MLIBDSN=’XXXXXXX.SXVJMENU’, File-AID MLIB DSNAME
//
CXVJLOAD=’XXXXXXX.CXVJLOAD’, File-AID CXVJLOAD
//
SXVJLOAD=’XXXXXXX.SXVJLOAD’, File-AID SXVJLOAD
//* ****DFSRRC00 PARAMETERS
//
MBR=XIXDBDUP,
PROGRAM NAME IN SXVJLOAD
//
PSB=IXDUPLD,
PSB NAME
//
IN=,OUT=,OPT=,
IMS REGION CONTROLLER PGM
//
SPIE=,TEST=,DIRCA=,
PARAMETERS - FOR MORE INFO
//
PRLD=,STIMER=,CKPTID=,
ON THESE PARMS SEE THE
//
PARDLI=,CPUTIME=,NBA=,
IMS/VS SYSTEM PROGRAMMING
//
OBA=,IMSID=,AGN=
REFERENCE MANUAL
//*
//*----------------------------------------------------------------
//*
STEP1: BMP TO UPDATE File-AID/DC’s CLT DATA BASE
//*
WITH DBD INFORMATION
//*----------------------------------------------------------------
//STEP1 EXEC PGM=DFSRRC00,REGION=&RGN,
//
PARM=(BMP,&MBR,&PSB,&IN,&OUT,
//
&OPT&SPIE&TEST&DIRCA,&PRLD,&STIMER,&CKPTID,
//
&PARDLI,&CPUTIME,&NBA,&OBA,&IMSID,&AGN)
//STEPLIB
DD
DSN=&SDFSRESL,DISP=SHR
//
DD
DSN=&CXVJLOAD,DISP=SHR
//
DD
DSN=&SXVJLOAD,DISP=SHR
//
DD
DSN=CEE.SCEERUN,DISP=SHR
//DFSRESLB DD
DSN=&SDFSRESL,DISP=SHR
//SYSABEND DD
SYSOUT=&PRINT,DCB=(LRECL=121,RECFM=VBA,BLKSIZE=3129),
//
SPACE=(125,(2500,100),RLSE,,ROUND)
//ABNLDUMP DD DUMMY
//IXPD1
DD
DSN=&DBDLIB,DISP=SHR
//IXPMLIB
DD
DSN=&MLIBDSN,DISP=SHR
//SYSOUT
DD
SYSOUT=&PRINT
//
PEND
//*
//BMP
EXEC DBDUPBMP
//*----------------------------------------------------------------
//*INSERT PROGRAM CONTROL CARDS AFTER THE SYSIN DD STATEMENT
//*----------------------------------------------------------------
//SYSIN
DD
*
/*
//
F-3
F-4
File-AID Single Install Image Installation and Configuration Guide
File-AID for IMS/CICS DBDUPDLI–DLIBATCH Procedure
DLI job to update File-AID for IMS/CICS CLT database with DBD information.
Figure F-3. DBDUPDLI–DLIBATCH JCL Procedure (JCL member XIXNDUPD)
//DBDUPDLI PROC RGN=2048K,
REGION SIZE
//*
//* **** DBDUPDLI PARAMETERS****
//
PRINT=’*’,
PRINT OUTPUT SYSOUT CLASS
//
SDFSRESL=’XXXXXXX.SDFSRESL’, IMS RESLIB
//
DBDLIB=’XXXXXXX.DBDLIB’,
CICS DBD LIBRARY
//
PSBLIB=’XXXXXXX.PSBLIB’,
CICS PSB LIBRARY
//
PROCLIB=’XXXXXXX.SDFSMAC’,
CICS PROCEDURE LIBRARY
//
DFSVSAM=’DFSVSAMP’,
PROCLIB MEMBER CONTAINING
//*
BUFFER POOL DATA
//
IXPDB=’XXXXXXX.IXDCLT’,
File-AID/CICS CLT DATA BASE
//
MLIBDSN=’XXXXXXX.SXVJMENU’,
File-AID MLIB 
//
CXVJLOAD=’XXXXXXX.CXVJLOAD’, File-AID CXVJLOAD
//
SXVJLOAD=’XXXXXXX.SXVJLOAD’, File-AID SXVJLOAD
//* **** DFSRRC00 PARAMETERS ****
//
MBR=XIXDBDUP,
PROGRAM NAME IN SXVJLOAD
//
PSB=IXCUPLD,
PSB NAME
//
BUF=,SPIE=,TEST=,
IMS REGION CONTROLLER PGM
//
EXCPVR=,RST=,PRLD=,
PARAMETERS FOR MORE INFO
//
SRCH=,CKPTID=,MON=,
ON THESE PARMS SEE THE
//
LOGA=,FMTO=,IMSID=,
IMS/VS SYSTEM PROGRAMMING
//
SWAP=,DBRC=,IRLM=,
REFERENCE MANUAL
//
IRLMNM=
//*
//*----------------------------------------------------------------
//* STEP1: DLI JOB TO UPDATE File-AID/CICS’ CLT DATA BASE WITH 
//*
DBD INFORMATION
//*----------------------------------------------------------------
//STEP1 EXEC PGM=DFSRRC00,REGION=&RGN,
//
PARM=(DLI,&MBR,&PSB,&BUF,
//
&SPIE&TEST&EXCPVR&RST,&PRLD,
//
&SRCH,&CKPTID,&MON,&LOGA,&FMTO,
//
&IMSID,&SWAP,&DBRC,&IRLM,&IRLMNM)
//STEPLIB
DD DSN=&SDFSRESL,DISP=SHR
//
DD DSN=&CXVJLOAD,DISP=SHR
//
DD DSN=&SXVJLOAD,DISP=SHR
//
DD DSN=CEE.SCEERUN,DISP=SHR
//DFSRESLB DD DSN=&SDFSRESL,DISP=SHR
//IMS
DD DSN=&DBDLIB,DISP=SHR
//
DD DSN=&PSBLIB,DISP=SHR
//DFSVSAMP DD DSN=&PROCLIB(&DFSVSAM),DISP=SHR
//SYSABEND DD
SYSOUT=&PRINT,DCB=(LRECL=121,RECFM=VBA,BLKSIZE=3129),
//
SPACE=(125,(2500,100),RLSE,,ROUND)
//ABNLDUMP DD DUMMY
//IEFRDER
DD DUMMY,DCB=BLKSIZE=100

//IXCCLTDD DD DSN=&IXPDB,DISP=OLD

//*------------------------------------------------------------------
//*IF USING DYNAMIC ALLOCATION UNCOMMENT THE FOLLOWING DD CARD

//*------------------------------------------------------------------
//*IXPIMSDY DD DUMMY

//IXPD1
DD DSN=&DBDLIB,DISP=SHR
DD DSN=&MLIBDSN,DISP=SHR
//IXPMLIB
//SYSOUT
DD SYSOUT=&PRINT
//
PEND
/DLI
EXEC DBDUPDLI
//*----------------------------------------------------------------
//*
INSERT PROGRAM CONTROL CARDS AFTER THE SYSIN DD STATEMENT
//*----------------------------------------------------------------
//SYSIN
DD *
/*
File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update
File-AID for IMS/DC DBDUPDLI–DLIBATCH Procedure
DLI job to update File-AID for IMS/DC’s CLT database with DBD information.
Figure F-4. DBDUPDLI–DLIBATCH JCL Procedure (JCL member XIXODUPD)
//DBDUPDLI PROC RGN=2048K,
REGION SIZE
//*
//* **** DBDUPDLI PARAMETERS****
//
PRINT=’*’,
PRINT OUTPUT SYSOUT CLASS
//
SDFSRESL=’XXXXXXX.SDFSRESL’, IMS RESLIB
//
DBDLIB=’XXXXXXX.DBDLIB’,
IMS DBD LIBRARY
//
PSBLIB=’XXXXXXX.PSBLIB’,
IMS PSB LIBRARY
//
SDFSMAC=’XXXXXXX.SDFSMAC’,
IMS PROCEDURE LIBRARY
//
DFSVSAM=’DFSVSAMP’,
SDFSMAC MEMBER CONTAINING
//*
BUFFER POOL DATA
//
IXPDB=’XXXXXXX.IXDCLT’,
File-AID CLT DATA BASE
//
MLIBDSN=’XXXXXXX.SXVJMENU’,
File-AID MLIB 
//
CXVJLOAD=’XXXXXXX.CXVJLOAD’, File-AID CXVJLOAD
//
SXVJLOAD=’XXXXXXX.SXVJLOAD’, File-AID SXVJLOAD
//* **** DFSRRC00 PARAMETERS ****
//
MBR=XIXDBDUP,
PROGRAM NAME IN SXVJLOAD
//
PSB=IXDUPLD,
PSB NAME
//
BUF=,SPIE=,TEST=,
IMS REGION CONTROLLER PGM
//
EXCPVR=,RST=,PRLD=,
PARAMETERS FOR MORE INFO
//
SRCH=,CKPTID=,MON=,
ON THESE PARMS SEE THE
//
LOGA=,FMTO=,IMSID=,
IMS/VS SYSTEM PROGRAMMING
//
SWAP=,DBRC=,IRLM=,
REFERENCE MANUAL
//
IRLMNM=
//*
//*----------------------------------------------------------------
//* STEP1: DLI JOB TO UPDATE File-AID/DC’s CLT DATA BASE WITH 
//*
DBD INFORMATION
//*----------------------------------------------------------------
//STEP1 EXEC PGM=DFSRRC00,REGION=&RGN,
//
PARM=(DLI,&MBR,&PSB,&BUF,
//
&SPIE&TEST&EXCPVR&RST,&PRLD,
//
&SRCH,&CKPTID,&MON,&LOGA,&FMTO,
//
&IMSID,&SWAP,&DBRC,&IRLM,&IRLMNM)
//STEPLIB
DD DSN=&SDFSRESL,DISP=SHR
//
DD DSN=&CXVJLOAD,DISP=SHR
//
DD DSN=&SXVJLOAD,DISP=SHR
//
DD DSN=CEE.SCEERUN,DISP=SHR
//DFSRESLB DD DSN=&SDFSRESL,DISP=SHR
//IMS
DD DSN=&DBDLIB,DISP=SHR
//
DD DSN=&PSBLIB,DISP=SHR
//DFSVSAMP DD DSN=&SDFSMAC(&DFSVSAM),DISP=SHR
//SYSABEND DD
SYSOUT=&PRINT,DCB=(LRECL=121,RECFM=VBA,BLKSIZE=3129),
//
SPACE=(125,(2500,100),RLSE,,ROUND)
//ABNLDUMP DD DUMMY
//IEFRDER
DD DUMMY,DCB=BLKSIZE=100

//IXCCLTDD DD DSN=&IXPDB,DISP=OLD

//*------------------------------------------------------------------
//*IF USING DYNAMIC ALLOCATION UNCOMMENT THE FOLLOWING DD CARD

//*------------------------------------------------------------------
//*IXPIMSDY DD DUMMY

//IXPD1
DD DSN=&DBDLIB,DISP=SHR
DD DSN=&MLIBDSN,DISP=SHR
//IXPMLIB
//SYSOUT
DD SYSOUT=&PRINT
//
PEND
/DLI
EXEC DBDUPDLI
//*----------------------------------------------------------------
//*
INSERT PROGRAM CONTROL CARDS AFTER THE SYSIN DD STATEMENT
//*----------------------------------------------------------------
//SYSIN
DD *
/*
F-5
F-6
File-AID Single Install Image Installation and Configuration Guide
DBD Update DD Statements
The following DD statements define the primary processing files required to run the DBD
Update program:
Table F-1.
DBD Update Program DD Statements
DD Statement
Description
STEPLIB
Designates the IMS system dataset that contains the IMS nucleus, required action
modules (&RESLIB), and the library where File-AID load modules are stored
(&CXVJLOAD and &SXVJLOAD).
DFSRESLB
Designates the IMS system dataset that contains the IMS nucleus and required
action modules (&RESLIB). In DBDUPDLI and DBDUPBMP only.
IMS
Designates the IMS system datasets that contain the database description blocks
(&DBDLIB) and the program specification blocks (&PSBLIB). In DBDUPDLI PROC
only.
DFSVSAMP
Designates the dataset (&PROCLIB) and member (&DFSVSAM) that contain the
control statements that describe the size and structure of the VSAM shared
resource pool for File-AID’ CLT control database. The buffers must be large
enough to accept the largest segment size in the CLT control database. In
DBDUPDLI PROC only.
SYSUDUMP
Produces a dump of user areas. The dump is formatted so that it can be printed
directly.
IEFRDER
Designates the log dataset when update intent is declared. In DBDUPDLI PROC
only.
IXDCLTDD,
IXCCLTDD
Designates File-AID’ CLT control database (&IXPDB) that is updated with DBD
information. In DBDUPDLI PROC only.
IXPD1
Designates the DBD load library that contains DBD load module(s) that define the
database(s) specified on the program control cards. Multiple DBD load libraries
may be concatenated.
IXPMLIB
Designates the library that contains File-AID for IMS messages.
SYSOUT
Designates the output class for the DBD update summary report.
SYSIN
The program control cards follow this DD statement. Refer to page F-6
Parameters
The parameters on the PROC statement assign default values to symbolic parameters on
the procedure statement. To override a default parameter value on the PROC statement,
code the same parameter on the EXEC statement that calls the procedure.
The DBDUPDLI and DBDUPBMP parameters specify the sysout class, load libraries, and
dataset names used when the program executes. These are described in more detail in the
preceding DD Statements section.
Change the default LE Runtime library from CEE.SCEERUN to your LE370 Runtime
library.
The DFSRRC00 parameters are the IMS execution time parameters. For more information
on these parameters, refer to the IMS/ESA System Programming Reference Manual.
Program Control Cards
The program control cards you specify trigger DBD Update processing. They are entered
after the SYSIN DD statement in a free form, positional format. Control Card fields can
File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update
F-7
be coded anywhere in columns 1 through 72 of your control card, separated by at least
one space.
Action
This field must be specified first.
UPDATE, UPD, U Add or change DBD information to the CLT control database.
DELETE, DEL, D Delete DBD information from the CLT control database.
DBD Name
The name of the DBD whose information is to be updated in or deleted from the CLT
control database. This field must follow the Action field for both UPDATE and DELETE.
Description
A 30-byte field that can be used to describe each DBD. This field is optional for an UPDATE
action. If entered, it must follow the DBD Name field. It is not applicable to a DELETE
action.
The following example illustrates how program control cards can be entered.
//SYSIN
DD
*
UPDATE PORDR
UPDATE LORDR
DELETE PCUST
PHYSICAL ORDER DATA BASE
LOGICAL ORDER DATA BASE
DBD Execution Return Codes
A DBD update execution return code (RC) appears in the output listing. For return codes
4, 8, and 16, a message appears on the DBD Update Summary Report under the column
heading Message. In general, the return codes can be summarized as follows:
RC
Explanation
Error Description
0
job ran to completion
none
4
job ran to completion
segment to delete not found
segment/DBD size error
control card related error
8
job may have ended prematurely
DBD size error
16
sever error occurred
system error
Summary Report
The DBD Summary Report is printed by the DBD Update job. The ACTION, DBD NAME,
and DESCRIPTION shown on the report correspond to the control cards that you
specified in your JCL. The rightmost column is for informational messages that describe
the status of the update and/or delete processing.
Figure F-5. DBD Update Summary for Online Access
File-AID for IMS


ACTION
-----UPDATE
UPDATE
DELETE
DBD NAME
-------PORDR
LORDR
PPART
DBD UPDATE SUMMARY FOR ONLINE ACCESS
DESCRIPTION
-----------------------------PHYSICAL ORDER DATA BASE
LOGICAL ORDER DATA BASE
PHYSICAL PART DATA BASE
PAGE
1
DATE 09/16/14
TIME 16:37:13
MESSAGE
-----------------------------------------------------------------------------
D721 DBD "PORDR" UPDATED; TO INCLUDE LAYOUT CHANGES - RUN XREF UPDATE
D724 DBD "LORDR" ADDED; TO USE LAYOUTS ONLINE - RUN XREF UPDATE
D726 DBD "PPART" DELETED 
**** E N D
O F
R E P O R T ****
F-8
File-AID Single Install Image Installation and Configuration Guide
Batch XREF Update Facility
To edit or browse a database using Formatted mode in the IMS/DC or CICS environment,
segment layout information must be made available to File-AID. File-AID maintains an
online CLT control database to store information pertaining to DBD segments and the
segment layout(s) that defines each segment’s data.
The segment/layout cross reference (XREF) that you create in File-AID for IMS/ISPF
Option 7 associates segment layouts with segment types defined in a DBD. The Batch
XREF Update program uses this XREF to update the CLT control database. For more
information, refer to the Segment/Layout/Cross Reference chapter in the File-AID for
IMS/CICS and File-AID for IMS/DC Reference manual.
Segment names defined in a DBD can have corresponding segment layouts that define
the segment data. The XREF Update program retrieves the segment layout from your
segment layout library and updates the CLT control database with this information for
use by File-AID online programs.
You need to run the Batch XREF Update program when:
• A new XREF member has been created. Segment layout and segment information
must be added to the CLT control database.
• An existing XREF member has been changed. For example, segments are added to or
deleted from a DBD. The corresponding segment layout information must be added
to/deleted from the CLT control database.
• A segment layout changes. These changes must be reflected on the CLT control
database.
• A DBD has been deleted from an XREF member. Segment layout and segment
information must be deleted from the CLT control database.
If your databases’ DBD information has not been added to the CLT control database, the
DBD Update Facility, described earlier in this chapter, must be run before a segment’s
layout information can be added by the XREF Update Facility.
Segment Layout Datasets
The segment layout dataset contains the COBOL or PL/I segment layouts used in many
File-AID for IMS functions. The segment layout dataset can be one of three types:
Table F-2.
Segment Layout Dataset Types
Type
DSORG
RECFM
LRECL
Partitioned dataset
PO
F, FB
80
CA Panvalet file
*
*
*
CA Librarian file
*
*
*
Note:
Must conform to the requirements for a valid CA Panvalet/Librarian file.
The segment layout can be a separate COPYLIB member or can be hard-coded in a
COBOL or PL/I program. If the layout is in a program or if a COPYLIB member contains
multiple segment layouts, you can isolate the specific layout, or portion of a layout, that
File-AID for IMS should use by specifying a starting data-name. In these two cases, if you
do not specify a starting data-name, File-AID for IMS will use every layout found in the
program or COPYLIB member to format the data, treating the second through last
layouts as redefinitions of the first.
When you create a segment/layout XREF in File-AID for IMS/ISPF Option 7, you associate
existing segment layouts with the segment types in your database. File-AID for IMS
requires that your segment layouts follow certain coding rules. Refer to the appropriate
COBOL Language Support or PL/I Language Support topic later in this chapter.
File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update
F-9
Checkpoints
The XREF Update Facility can be run as either a batch DL/I or IMS BMP program. In
either type of processing, a checkpoint (CHKP) call is issued after each control card is
read. This indicates to IMS that the program has reached a commit point. For BMP
processing, the checkpoint also releases the resources that IMS has enqueued for the
program. In the event of an abend, IMS backs out the database updates to the most recent
checkpoint. The XREF Update Facility, however, does not have restart capability.
XREF Update JCL
The following JCL streams are copies of the procedures (PROCs) supplied with File-AID.
Your installation might have modified these PROCs to meet installation standards.
F-10
File-AID Single Install Image Installation and Configuration Guide
XRFUPBMP–IMSBATCH Procedure
Figure F-6. XRFUPBMP–IMSBATCH JCL Procedure (JCL members XIXNXUPB for File-AID for IMS/CICS
or XIXOXUPB for File-AID for IMS/DC)
//XRFUPBMP PROC RGN=4M,
REGION SIZE//*
//* **** XRFUPBMP PARAMETERS ****
//
PRINT=’*’,
PRINT OUTPUT SYSOUT CLASS
//
SDFSRESL='XXXXXXX.SDFSRESL', IMS SDFSRESL
//
XRFDSN=’XXXXXXX.XREF’,
File-AID/ISPF XREF DSNAME
//
MLIBDSN=’XXXXXXX.SXVJMENU’, File-AID for IMS/ISPF MLIB DSNAME
//
CXVJLOAD=’XXXXXXX.CXVJLOAD’, File-AID CXVJLOAD
//
SXVJLOAD=’XXXXXXX.SXVJLOAD’, File-AID SXVJLOAD
//* **** ENTER ONE OR TWO DATASET NAMES FOR YOUR ****
//* **** COBOL OR PL/I SEGMENT LAYOUT LIBRARIES, ****
//* **** DEPENDING ON THE LANGUAGE YOU ARE USING ****
//
CBLDSN1=’XXXXXXX.COBOL1’,
COBOL LAYOUT LIBRARY
//*
CBLDSN2=’XXXXXXX.COBOL2’,
ADDITIONAL COBOL LAYOUT
//*
LIBRARY (OPTIONAL)
//*
PLIDSN1=’XXXXXXX.PLI1’,
PL/I LAYOUT LIBRARY
//*
PLIDSN2=’XXXXXXX.PLI2’,
ADDITIONAL PL/I LAYOUT
//*
LIBRARY (OPTIONAL)
//* **** DFSRRC00 PARAMETERS ****
//
MBR=XIXXRFUP,
PROGRAM NAME IN SXVJLOAD
//
PSB=IXCUPLD,
PSB NAME (IXDULP for DC)
//
IN=,OUT=,OPT=,
IMS REGION CONTROLLER PGM
//
SPIE=,TEST=,DIRCA=,
PARAMTERS FOR MORE INFO
//
PRLD=,STIMER=,CKPTID=,
ON THESE PARMS SEE THE
//
PARDLI=,CPUTIME=,NBA=,
IMS/VS SYSTEM PROGRAMMING
//
OBA=,IMSID=,AGN=
REFERENCE MANUAL
//*----------------------------------------------------------------
//*STEP1: BMP JOB TO UPDATE File-AID/CICS CLT DATA BASE WITH XREF 
//*
INFORMATION
//*----------------------------------------------------------------
//STEP1
EXEC PGM=DFSRRC00,REGION=&RGN,
//
PARM=(BMP,&MBR,&PSB,&IN,&OUT,
//
&OPT&SPIE&TEST&DIRCA,&PRLD,&STIMER,&CKPTID,
//
&PARDLI,&CPUTIME,&NBA,&OBA,&IMSID,&AGN)
//STEPLIB DD DSN=&SDFSRESL,DISP=SHR
//
DD DSN=&CXVJLOAD,DISP=SHR
//
DD DSN=&SXVJLOAD,DISP=SHR
//
DD DSN=CEE.SCEERUN,DISP=SHR
//DFSRESLB DD DSN=&SDFSRESL,DISP=SHR
//SYSABEND DD SYSOUT=&PRINT,DCB=(LRECL=121,RECFM=VBA,BLKSIZE=3129),
//
SPACE=(125,(2500,100),RLSE,,ROUND)
//ABNLDUMP DD DUMMY
//IXPFD
DD DSN=&XRFDSN,DISP=SHR
//* **** USE &CBLDSN1 (AND, OPTIONALLY, &CBLDSN2), OR **** 
//* **** &PLIDSN1 (AND, OPTIONALLY, &PLIDSN2), FOR THE **** 
//* **** IXPC1 (AND, OPTIONALLY, IXPC2) DDNAME(S),
**** 
//* **** DEPENDING ON THE LANGUAGE YOU ARE USING
**** 
//IXPC1
DD DSN=&CBLDSN1,DISP=SHR
//*IXPC2
DD DSN=&CBLDSN2,DISP=SHR
//*IXPC1
DD DSN=&PLIDSN1,DISP=SHR
//*IXPC2
DD DSN=&PLIDSN2,DISP=SHR
//IXPMLIB DD DSN=&MLIBDSN,DISP=SHR
DD SYSOUT=&PRINT
//SYSOUT
//
PEND
//*
//BMP
EXEC XRFUPBMP
//*----------------------------------------------------------------
//*
INSERT CONTROL CARDS AFTER THE SYSIN DD STATEMENT.
//*----------------------------------------------------------------
//SYSIN
DD
*
/*
//
File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update
F-11
XRFUPDLI–DLIBATCH Procedure
Figure F-7. XRFUPDLI–DLIBATCH JCL Procedure (JCL member XIXNXUPD for File-AID for IMS/CICS)
//XRFUPDLI PROC RGN=2048K,
REGION SIZE
//* **** XRFUPDLI PARAMETERS****
//
PRINT=’*’,
PRINT OUTPUT SYSOUT CLASS
//
SDFSRESL=’XXXXXXX.SDFSRESL’, IMS RESLIB
//
DBDLIB=’XXXXXXX.DBDLIB’,
CICS DBD LIBRARY
//
PSBLIB=’XXXXXXX.PSBLIB’,
CICS PSB LIBRARY
//
SDFSMAC=’XXXXXXX.SDFSMAC’, CICS PROCEDURE LIBRARY
//
DFSVSAM=’DFSVSAMP’,
SDFSMAC MEMBER CONTAINING
//*
BUFFER POOL DATA
//
IXPDB=’XXXXXXX.IXCCLT’,
File-AID/CICS CLT DB
//
XRFDSN=’XXXXXXX.IXP.XREF’, File-AID/ISPF XREF DSNAME
//
MLIBDSN=’XXXXXXX.SXVJMENU’, File-AID MLIB 
//
CXVJLOAD=’XXXXXXX.CXVJLOAD’, File-AID CXVJLOAD
//
SXVJLOAD=’XXXXXXX.SXVJLOAD’, File-AID SXVJLOAD
//* **** ENTER ONE OR TWO DATASET NAMES FOR YOUR ****
//* **** COBOL OR PL/I SEGMENT LAYOUT LIBRARIES, ****
//* **** DEPENDING ON THE LANGUAGE YOU ARE USING ****
//
CBLDSN1=’XXXXXXX.COBOL1’,
COBOL LAYOUT LIBRARY
//*
CBLDSN2=’XXXXXXX.COBOL2’
ADDITIONAL COBOL LAYOUT
//*
LIBRARY (OPTIONAL)
//*
PLIDSN1=’XXXXXXX.PLI1’,
PL/I LAYOUT LIBRARY
//*
PLIDSN2=’XXXXXXX.PLI2’,
ADDITIONAL PL/I LAYOUT
//*
LIBRARY (OPTIONAL)
//*
**** DFSRRC00 PARAMETERS ****
//
MBR=XIXXRFUP,
PROGRAM NAME IN SXVJLOAD
//
PSB=IXCUPLD,
PSB NAME
//
BUF=,SPIE=,TEST=,
IMS REGION CONTROLLER PGM
//
EXCPVR=,RST=,PRLD=,
PARAMETERS FOR MORE INFO
//
SRCH=,CKPTID=,MON=,
ON THESE PARMS SEE THE
//
LOGA=,FMTO=,IMSID=,
IMS/VS SYSTEM PROGRAMMING
//
SWAP=,DBRC=,IRLM=,IRLMNM=
REFERENCE MANUAL
//*----------------------------------------------------------------
//*
STEP1: DLI JOB TO UPDATE File-AID/CICS’ CLT DATA
//*
BASE WITH XREF INFORMATION
//*----------------------------------------------------------------
//STEP1
EXEC PGM=DFSRRC00,REGION=&RGN,
//
PARM=(DLI,&MBR,&PSB,&BUF,
//
&SPIE&TEST&EXCPVR&RST,&PRLD,
//
&SRCH,&CKPTID,&MON,&LOGA,&FMTO,
//
&IMSID,&SWAP,&DBRC,&IRLM,&IRLMNM)
//STEPLIB
DD DSN=&SDFSRESL,DISP=SHR
//
DD DSN=&CXVJLOAD,DISP=SHR
//
DD DSN=&SXVJLOAD,DISP=SHR
//
DD DSN=CEE.SCEERUN,DISP=SHR
//DFSRESLB DD DSN=&SDFSRESL,DISP=SHR
//IMS
DD DSN=&DBDLIB,DISP=SHR
//
DD DSN=&PSBLIB,DISP=SHR
//DFSVSAMP DD DSN=&PROCLIB(&DFSVSAM),DISP=SHR
//SYSABEND DD SYSOUT=&PRINT,DCB=(LRECL=121,RECFM=VBA,BLKSIZE=3129),
//
SPACE=(125,(2500,100),RLSE,,ROUND)
//ABNLDUMP DD DUMMY
DD DUMMY,DCB=BLKSIZE=100
//IEFRDER
//IXCCLTDD DD DSN=&IXPDB,DISP=OLD
//*--------------------------------------------------------------------
//*IF USING DYNAMIC ALLOCATION UNCOMMENT THE FOLLOWING DD CARD

//*--------------------------------------------------------------------
//*IXPIMSDY DD DUMMY

F-12
File-AID Single Install Image Installation and Configuration Guide
Figure F-8. XRFUPDLI–DLIBATCH JCL Procedure (JCL member XIXNXUPD for File-AID for IMS/CICS) Continued
//IXPFD
DD DSN=&XRFDSN,DISP=SHR
//* **** USE &CBLDSN1 (AND, OPTIONALLY, &CBLDSN2), OR ****
//* **** &PLIDSN1 (AND, OPTIONALLY, &PLIDSN2), FOR THE ****
//* **** IXPC1 (AND, OPTIONALLY, IXPC2) DDNAME(S),
****
//* **** DEPENDING ON THE LANGUAGE YOU ARE USING
****
//IXPC1
DD DSN=&CBLDSN1,DISP=SHR
//*IXPC2
DD DSN=&CBLDSN2,DISP=SHR
//*IXPC1
DD DSN=&PLIDSN1,DISP=SHR
//*IXPC2
DD DSN=&PLIDSN2,DISP=SHR
//IXPMLIB
DD DSN=&MLIBDSN,DISP=SHR
//SYSOUT
DD SYSOUT=&PRINT
//
PEND
//DLI
EXEC XRFUPDLI
//*----------------------------------------------------------------
//*
INSERT CONTROL CARDS AFTER THE SYSIN DD STATEMENT.
//*
REFER TO THE BATCH DBD AND XREF UPDATE CHAPTER IN THE

//*
FILE-AID/DC/CICS SECTION OF THE FILE-AID REFERENCE MANUAL
//*
FOR MORE INFORMATION ABOUT XIXXRFUP OPTION AND PROGRAM

//*
CONTROL CARDS.

//*

//*
FOLLOWING IS AN EXAMPLE OF AN OPTION AND PROGRAM CONTROL 
//*
CARD WHICH CHANGES XREF INFORMATION IN FILE-AID/CICS CLT 
//*
DATA BASE:

//*

//*
OPTION COBOL

//*
UPDATE ORDR010C PORDR

//*

//*----------------------------------------------------------------
//SYSIN
DD *
/*
//
File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update
F-13
Figure F-9. XRFUPDLI–DLIBATCH JCL Procedure (JCL member XIXOXUPD for File-AID for IMS/DC)
//XRFUPDLI PROC RGN=2048K,
REGION SIZE
//* **** XRFUPDLI PARAMETERS****
//
PRINT=’*’,
PRINT OUTPUT SYSOUT CLASS
//
SDFSRESL=’XXXXXXX.SDFSRESL’, IMS RESLIB
//
DBDLIB=’XXXXXXX.DBDLIB’,
IMS DBD LIBRARY
//
PSBLIB=’XXXXXXX.PSBLIB’,
IMS PSB LIBRARY
//
SDFSMAC=’XXXXXXX.SDFSMAC’, IMS PROCEDURE LIBRARY
//
DFSVSAM=’DFSVSAMP’,
SDFSMAC MEMBER CONTAINING
//*
BUFFER POOL DATA
//
IXPDB=’XXXXXXX.IXDCLT’,
File-AID/DC CLT DB
//
XRFDSN=’XXXXXXX.IXP.XREF’, File-AID/ISPF XREF DSNAME
//
MLIBDSN=’XXXXXXX.SXVJMENU’, File-AID MLIB 
//
CXVJLOAD=’XXXXXXX.CXVJLOAD’, File-AID CXVJLOAD
//
SXVJLOAD=’XXXXXXX.SXVJLOAD’, File-AID SXVJLOAD
//* **** ENTER ONE OR TWO DATASET NAMES FOR YOUR ****
//* **** COBOL OR PL/I SEGMENT LAYOUT LIBRARIES, ****
//* **** DEPENDING ON THE LANGUAGE YOU ARE USING ****
//
CBLDSN1=’XXXXXXX.COBOL1’,
COBOL LAYOUT LIBRARY
//*
CBLDSN2=’XXXXXXX.COBOL2’
ADDITIONAL COBOL LAYOUT
//*
LIBRARY (OPTIONAL)
//*
PLIDSN1=’XXXXXXX.PLI1’,
PL/I LAYOUT LIBRARY
//*
PLIDSN2=’XXXXXXX.PLI2’,
ADDITIONAL PL/I LAYOUT
//*
LIBRARY (OPTIONAL)
//*
**** DFSRRC00 PARAMETERS ****
//
MBR=XIXXRFUP,
PROGRAM NAME IN SXVJLOAD
//
PSB=IXDUPLD,
PSB NAME
//
BUF=,SPIE=,TEST=,
IMS REGION CONTROLLER PGM
//
EXCPVR=,RST=,PRLD=,
PARAMETERS FOR MORE INFO
//
SRCH=,CKPTID=,MON=,
ON THESE PARMS SEE THE
//
LOGA=,FMTO=,IMSID=,
IMS/VS SYSTEM PROGRAMMING
//
SWAP=,DBRC=,IRLM=,IRLMNM=
REFERENCE MANUAL
//*----------------------------------------------------------------
//*
STEP1: DLI JOB TO UPDATE File-AID/DC CLT DATA
//*
BASE WITH XREF INFORMATION
//*----------------------------------------------------------------
//STEP1
EXEC PGM=DFSRRC00,REGION=&RGN,
//
PARM=(DLI,&MBR,&PSB,&BUF,
//
&SPIE&TEST&EXCPVR&RST,&PRLD,
//
&SRCH,&CKPTID,&MON,&LOGA,&FMTO,
//
&IMSID,&SWAP,&DBRC,&IRLM,&IRLMNM)
//STEPLIB
DD DSN=&SDFSRESL,DISP=SHR
//
DD DSN=&CXVJLOAD,DISP=SHR
//
DD DSN=&SXVJLOAD,DISP=SHR
//
DD DSN=CEE.SCEERUN,DISP=SHR
//DFSRESLB DD DSN=&SDFSRESL,DISP=SHR
//IMS
DD DSN=&DBDLIB,DISP=SHR
//
DD DSN=&PSBLIB,DISP=SHR
//DFSVSAMP DD DSN=&SDFSMAC(&DFSVSAM),DISP=SHR
//SYSABEND DD SYSOUT=&PRINT,DCB=(LRECL=121,RECFM=VBA,BLKSIZE=3129),
//
SPACE=(125,(2500,100),RLSE,,ROUND)
//ABNLDUMP DD DUMMY
DD DUMMY,DCB=BLKSIZE=100
//IEFRDER
//IXDCLTDD DD DSN=&IXPDB,DISP=OLD
//*--------------------------------------------------------------------
//*IF USING DYNAMIC ALLOCATION UNCOMMENT THE FOLLOWING DD CARD

//*--------------------------------------------------------------------
//*IXPIMSDY DD DUMMY

F-14
File-AID Single Install Image Installation and Configuration Guide
Figure F-10. XRFUPDLI–DLIBATCH JCL Procedure (JCL member XIXOXUPD for File-AID for IMS/DC) Continued
//IXPFD
DD DSN=&XRFDSN,DISP=SHR
//* **** USE &CBLDSN1 (AND, OPTIONALLY, &CBLDSN2), OR ****
//* **** &PLIDSN1 (AND, OPTIONALLY, &PLIDSN2), FOR THE ****
//* **** IXPC1 (AND, OPTIONALLY, IXPC2) DDNAME(S),
****
//* **** DEPENDING ON THE LANGUAGE YOU ARE USING
****
//IXPC1
DD DSN=&CBLDSN1,DISP=SHR
//*IXPC2
DD DSN=&CBLDSN2,DISP=SHR
//*IXPC1
DD DSN=&PLIDSN1,DISP=SHR
//*IXPC2
DD DSN=&PLIDSN2,DISP=SHR
//IXPMLIB
DD DSN=&MLIBDSN,DISP=SHR
//SYSOUT
DD SYSOUT=&PRINT
//
PEND
//DLI
EXEC XRFUPDLI
//*----------------------------------------------------------------
//*
INSERT CONTROL CARDS AFTER THE SYSIN DD STATEMENT.
//*
REFER TO THE BATCH DBD AND XREF UPDATE CHAPTER IN THE

//*
FILE-AID/DC/CICS SECTION OF THE FILE-AID REFERENCE MANUAL
//*
FOR MORE INFORMATION ABOUT XIXXRFUP OPTION AND PROGRAM

//*
CONTROL CARDS.

//*

//*
FOLLOWING IS AN EXAMPLE OF AN OPTION AND PROGRAM CONTROL 
//*
CARD WHICH CHANGES XREF INFORMATION IN FILE-AID/DC'S CLT 
//*
DATA BASE:

//*

//*
OPTION COBOL

//*
UPDATE ORDR010C PORDR

//*

//*----------------------------------------------------------------
//SYSIN
DD *
/*
//
File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update
F-15
XREF Update DD Statements
The following DD statements define the primary processing files required to run the
XREF Update program.
Table F-3.
XREF Update Program DD Statements
DD Statement
Description
STEPLIB
Designates the IMS system dataset that contains the IMS nucleus, required action
modules (&RESLIB), and the library where File-AID load modules are stored
(&CXVJLOAD and &SXVJLOAD).
DFSRESLB
Designates the IMS system dataset that contains the IMS nucleus and required
action modules (&RESLIB). In XRFUPDLI and XRFUPBMP PROCs only.
IMS
Designates the IMS system datasets that contain the database description blocks
(&DBDLIB) and the program specification blocks (&PSBLIB). In XRFUPDLI PROC
only.
DFSVSAMP
Designates the dataset (&PROCLIB) and member (&DFSVSAM) that contain the
control statements that describe the size and structure of the VSAM shared
resource pool for File-AID’ CLT control database. The buffers must be large
enough to accept the largest segment size in the CLT control database. In
XRFUPDLI PROC only.
SYSUDUMP
Produces a dump of user areas. The dump is formatted so that it can be printed
directly.
IEFRDER
Designates the log dataset when update intent is declared. In DBDUPDLI PROC
only.
IXDCLTDD,
IXCCLTDD
Designates File-AID’ CLT control database (&IXPDB) that is updated with XREF
information. In XRFUPDLI PROC only.
IXPFD
Designates File-AID for IMS/ISPF’s segment/layout cross reference dataset
(&XRFDSN).
IXPC1
Designates the segment layout dataset (&CBLDSN1 or &PLIDSN1).
IXPC2
Designates an additional segment layout dataset (&CBLDSN2 or &PLIDSN2), if
needed.
IXPMLIB
Designates the library that contains File-AID for IMS/ISPF messages.
SYSOUT
Designates the output class for the XREF Update Summary Report.
SYSIN
The program control cards follow this DD statement. Refer to the topic Program
Control Cards later in this section.
Parameters
The parameters on the PROC statement assign default values to symbolic parameters on
the procedure statement. To override a default parameter value on the PROC statement,
code the same parameter on the EXEC statement that calls the procedure.
The XRFUPDLI and XRFUPBMP parameters specify the sysout class, load libraries, and
dataset names needed to run the XREF Update program. Refer to “DBD Update DD
Statements” on page F-6.
Change the default LE Runtime library from CEE.SCEERUN to your LE370 Runtime
library.
The DFSRRC00 parameters are the IMS execution time parameters. For more information
on these parameters, refer to the IMS/ESA System Programming Reference Manual.
Option Control Card
The option control card, if specified, must be the first control card entered after the
SYSIN DD statement. The option control card designates program language (for multi-
F-16
File-AID Single Install Image Installation and Configuration Guide
language sites), layout library organization (Panvalet and/or Librarian), and update. The
option limit control card is not required if your installation is a single language site,
layouts are not stored in Panvalet or Librarian. Use the update limit default value of
NOLIMIT.
Options can be coded anywhere in columns 1 through 72 of your control card, separated
by at least one space. The Action field is required and must be specified first. All other
fields are optional and can be entered in any order.
Action
OPTION, OPT, O
Language
Only ONE language can be specified:
COBOL, COB
PLI, PL1, PL/I, PL/1
Layout Organization
Both CA Panvalet and CA Librarian can be specified:
PANVALET, PAN
LIBRARIAN, LIB
Update Limit
Limits the update of the segment layout references in the CLT control database.
Refer to the Segment/Layout/Cross Reference chapter in the File-AID for
IMS/CICS and File-AID for IMS/DC Reference manual.
NOLIMIT, NOLMT
Updates all segment layout references in the CLT control
database that uses the same layout in the XREF member and DBD
name defined in the program control card (default)
LIMIT, LMT.
Updates only segment layout references in the CLT control
database for the DBD and XREF member specified on the
program control card.
A significant decrease in run time will occur when using the LIMIT
option but only the DBDs specified will be updated.
Program Control Cards
The program control cards you specify trigger XREF update processing. They are coded
after the SYSIN DD statement or the OPTION card, if specified, in a free form, positional
format. Program Control Card fields can be coded anywhere in columns 1 through 72 of
your control card, separated by at least one space.
Action
This field must be specified first.
UPDATE, UPD, U
Add or change segment layout information for use in the IMS/DC
or CICS environment
DELETE, DEL, D
Delete segment layout references no longer needed in the IMS/DC
or CICS environment
XREF MBR
The name of the File-AID for IMS/ISPF segment/layout cross reference PDS member that
contains the references to new or changed segment layouts. For an UPDATE action, this
field must follow the Action field. This field is not applicable to a DELETE action.
DBD Name
The name of the DBD in the File-AID for IMS/ISPF XREF member. For an UPDATE action,
this field must follow the XREF MBR field. The DBD NAME can be entered as an asterisk to
update segment layout references for all DBDs within an XREF member. For a DELETE
action, this field must follow the Action field. Specify the DBD whose segment layout
references are to be deleted from the CLT control database.
File-AID for IMS/CICS or File-AID for IMS/DC Batch DBD and XREF Update
F-17
In the following example, the OPTION control card is entered for segment layouts in a
Panvalet library. The second card specifies that segment layouts for DBD LORDR in the
segment/layout cross reference (XREF) member ORDRCUST are to be used to update the
File-AID CLT control database. The third card specifies that references to segment layouts
for DBD PCUST are to be deleted from the File-AID CLT control database.
//SYSIN
DD
*
OPTION PANVALET COBOL
UPD ORDRCUST LORDR
DELETE PCUST
XREF Execution Return Codes
An XREF update execution return code (RC) appears in the output listing. For return
codes 4, 8, and 16, a message appears on the XREF Update Summary Report under the
column heading Message. In general, the return codes can be summarized as follows:.
RC
Explanation
Error Description
0
job ran to completion
none
4
job ran to completion
segment to delete not found
8
job may have ended prematurely
control card related error, DBD size error
16
server error occurred
system error
Summary Report
The XREF Summary Report shown on page F-18 is printed by the XREF Update job.
The first section of the report lists the segment/layout cross reference dataset and the
segment layout dataset that you specified in your JCL.
The second section details all database update activity. The ACTION, XREF MEMBER (for
an UPDATE action), and DBD NAME shown on the report correspond to the control cards
that you specified in your JCL. Also shown are the segment names and their
corresponding source library members associated with the specified DBD name (and
XREF member for UPDATE). The rightmost column on the report is for informational
messages that describe the status of the update and/or delete processing.
When a segment’s data is defined by more than one segment layout, *MULT-RTV* is
shown in the MBR column. The individual segment layout members and the record type
values that define the segment’s format are shown in the Message column. Refer to the
Segment/Layout/Cross Reference chapter in the File-AID for IMS/CICS and File-AID for
IMS/DC Reference manual for more information on multiple record type values.
One segment layout is often used to describe a segment that is defined in multiple DBDs.
If this segment layout changes, the changes will be updated for all DBDs with segments
that reference the changed layout, unless the LIMIT option is used on the option card.
For example, in the sample report on page F-18, DBD PORDR defines the segment
ORDR010 in the physical view of the database. DBD LORDR defines the same segment
ORDR010 in its logical view of the database. The identical COBOL layout describes the
ORDR010 segment in both DBDs. On the report you can see the request to update DBD
LORDR within the ORDRCUST XREF member. Notice that COBOL member ORDR010 was
updated on File-AID’ CLT control database for segment ORDR010 within the LORDR
DBD. In addition, the ORDR010 COBOL information was also updated for segment
ORDR010 within the PORDR DBD. File-AID for IMS automatically updates all segment
layout information on the CLT control database that is generated from the same segment
layout dataset and member, unless the default is overridden by using the LIMIT option.
F-18
File-AID Single Install Image Installation and Configuration Guide
Figure F-11. Seg/Layout XREF and COBOL Layout Update Summary
File-AID for IMS
SEG/LAYOUT XREF AND COBOL LAYOUT UPDATE SUMMARY


SEG/LAYOUT XREF DSN:
COBOL LAYOUT DSN:

CW.FISAMP.XREF
PAGE
1
DATE 09/16/14
TIME 16:59:45

CW.FISAMP.COBOLLIB

ACTION
-----UPDATE
XREF MBR DBD NAME SEG NAME
-------- -------- -------LORDR
LORDR
ORDR010
ORDR020
ORDR030
ORDR040
ORDRCUST

ORDR030
ORDR040
ORDR051
MESSAGE
----------------------------------------------------------------------
D714 COBOL MBR "ORDR010" UPDATED
D715 COBOL MBR "ORDR020" UPDATED;RTV1=PO
D715 COBOL MBR "ORDR021" UPDATED;RTV1=SC
D715 COBOL MBR "ORDR022" UPDATED;RTV1=WO;RTV2=IN
D715 COBOL MBR "ORDR022" UPDATED;RTV1=WO;RTV2=OV
D714 COBOL MBR "ORDR030" UPDATED
D714 COBOL MBR "ORDR040" UPDATED
D714 COBOL MBR "ORDR051" UPDATED 
THE FOLLOWING DBD(S) AND SEGMENT(S) REFERENCE THE SAME COBOL MEMBER(S):
PORDR
ORDR010
ORDR010
D716 MATCHING COBOL MBR "ORDR010"
ORDR020
*MULT-RTV* D728 MATCHING COBOL MBR "ORDR020"
D728 MATCHING COBOL MBR "ORDR021"
D728 MATCHING COBOL MBR "ORDR022"
D728 MATCHING COBOL MBR "ORDR022"
ORDR030
ORDR030
D716 MATCHING COBOL MBR "ORDR030"
ORDR040
ORDR040
D716 MATCHING COBOL MBR "ORDR040"

DELETE

COBOL MBR
---------ORDR010
*MULT-RTV*
PCUST
CUST020
CUST010
VORDR050
CUST020
CUST010
ORDR050
WAS ALSO UPDATED
UPD;RTV1=WO
UPD;RTV1=WO
UPD;RTV1=WO;RTV2=IN
UPD;RTV1=WO;RTV2=OV
WAS ALSO UPDATED
WAS ALSO UPDATED 
D714 COBOL MBR "CUST020" DELETED
D714 COBOL MBR "CUST010" DELETED
D714 COBOL MBR "ORDR050" DELETED
**** E N D
O F
R E P O R T ****
G-1
Appendix G.
Refreshing the Relationship File
Appendix A.
App G
This appendix describes batch jobs that load or refresh a Relationship file with current
information. The Relationship file was specified during the DB2 Environment definition
(see “Relationship Dsn” on page 2-32). The relationship file is a VSAM KSDS file which
can be can be shared between File-AID/RDX and File-AID for DB2.
“Loading or Refreshing Referential Integrity Relationships”
The DB2 Referential Integrity (RI) information, including non-enforced RI, is loaded
from the DB2 catalog.
“Loading or Refreshing CA Gen Application Relationships”
If you have CA Gen1 for mainframe systems, you can load DB2 application
relationship (AR) information from the CA Gen Public Interface tables.
“DB2 Application Relationships from Other Sources”
File-AID includes a sample COBOL program that you must modify to load DB2
application relationship information from other relationship sources such as code
generators.
These jobs can be executed initially by the person responsible for installing File-AID.
However, they should be executed periodically to refresh RI relationships in the
relationship file. This is necessary after structure changes, such as new or changed
foreign keys, new or changed primary keys, and new tables.
Loading or Refreshing Referential Integrity
Relationships
Note:
You can also use Option 2, Load RI, of the File-AID/RDX Utilities Menu to load or
refresh DB2 RI in batch or use Option 5, LOAD RI from the DB2 Relationship
Facilitator menu (Option 1, RELATIONSHIPS in File-AID/RDX or Option 6,
RELATIONSHIPS in File-AID for DB2) for an online update.
The following describes how to load or refresh RI information from the DB2 catalog into
the relationship file using the sample JCL provided with member XVJRIUPD in the
SXVJSAMP library.
Overview
The following steps are performed when the job is executed:
1. All referential integrity relationships are deleted from the relationship file for the
specified subsystem.
2. New referential integrity relationship information is gathered from the DB2 catalog.
3. The new relationship information is copied to the relationship file.
1. CA Gen is a Computer Aided Software Engineering (CASE) application development environment marketed by CA
Technologies. Gen was previously known as IEF (Information Engineering Facility), Composer by IEF, Composer,
COOL:Gen, Advantage:Gen and AllFusion Gen.
G-2
File-AID Single Install Image Installation and Configuration Guide
The job does not modify the DB2 catalog.
To achieve the most efficient results, execute this job against a DB2 subsystem that
contains single occurrences of tables. Usually, production, system test, and acceptance
DB2 subsystems have single copies of tables. Conversely, test subsystems usually have
many copies of tables.
Procedure
The following describes how to load or refresh RI information from the DB2 catalog into
the relationship file in batch using the sample JCL provided with member XVJRIUPD in
the SXVJSAMP library.
Note:
SELECT authority on the DB2 catalog tables is needed to run the job.
Step 1. Modify the sample JCL.
Select member XVJRIUPD from the File-AID sample library
hlq.CPWR.MXVJA20.SXVJSAMP. This JCL loads the DB2 RI information from the DB2
catalog for the specified DB2 subsystem into the relationship file.
Edit the JCL as described in the comments and save the JCL in a new member with a
name that identifies the subsystem on which you installed File-AID. For example, you
could use the RIUPssid naming convention, where ssid equals the subsystem ID on which
you installed File-AID. If you installed File-AID on subsystem DSNA, you would then
rename it RIUPDSNA.
Repeat for each active DB2 subsystem on which you installed File-AID.
Note:
If you are licensed for File-AID for DB2, but not File-AID/RDX, change the
product code to FD in the //RIUPDATE statement and in the EXTPARMS DD, for
example:
//RIUPDATE EXEC PGM=XFREXEC,REGION=0M,PARM=(FD,1,B)

//EXTPARMS DD *

PROD
FD
<-----FR/FD
Step 2. Load the Relationship File.
Select the RI UPDATE member for the desired subsystem. Review the JCL and submit the
job.
Figure G-1 shows a sample job. The JCL parameters are based on the values provided
during the DB2 environment definition (refer to “Step 3.1 Specify DB2 Subsystem
(Option 1)” on page 2-28).
Refreshing the Relationship File
G-3
Figure G-1. Sample JCL to Update Relationship File
//* << INSERT JOBCARD HERE >>

//*

//*--------------------------------------------------------------------
//* COPYRIGHT (C) BY COMPUWARE CORPORATION, ALL RIGHTS RESERVED.

//*--------------------------------------------------------------------
//*

//* THIS JOB CAN BE USED PERIODICALLY TO REFRESH RI

//* INFORMATION IN THE FILE-AID RELATIONSHIP FILE.

//*

//* NOTE: SELECT AUTHORITY ON THE DB2 CATALOG TABLES IS NEEDED TO RUN 
//* THIS JOB

//*

//* BEFORE SUBMITTING THIS JCL UPDATE,

//* 1. SMPHLQ
- SMP/E DATASET HIGH-LEVEL QUALIFIER

//* 2. SDSNEXIT - NAME OF THE DB2 SDNSEXIT LIBARY FOR THE

//*
DB2 SUBSYSTEM BEING RUN IN

//* 3. SDSNLOAD - NAME OF THE DB2 SDNSEXIT LIBARY FOR THE

//*
DB2 SUBSYSTEM BEING RUN IN

//* 4. PRODUCT CODE - 'FR' OR 'FD'

//*
FR --- FILE-AID/RDX

//*
FD --- FILE-AID FOR DB2

//*
SPECIFY THE CODE IN RIUPDATE EXEC PARM AND
//*
EXTPARMS DD.

//* 5. SSID
- NAME OF THE DB2 SUBSYSTEM BEING RUN IN

//* 6. PLAN
- NAME OF THE DB2 PLAN SPECIFIED IN THE

//*
DB2 ENVIRONMENT CONFIGURATION FOR THE

//*
DB2 SUBSYSTEM BEING RUN IN

//* 7. RELATIONSHIP.FILE.DSN - NAME OF THE RELATIONSHIP FILE

//*
BEING UPDATED

//*

//*------------------------------------------------------------------- 
//SMPHLQ
SET SMPHLQ=XXXXXXXX.XXXXXXXX
<-----ENTER

//SDSNEXIT SET SDSNEXIT=XXXXXXXX.XXXXXXXX
<-----ENTER

//SDSNLOAD SET SDSNLOAD=XXXXXXXX.XXXXXXXX
<-----ENTER

//*

//RIUPDATE EXEC PGM=XFREXEC,REGION=0M,PARM=(FR,1,B)
<-----FR/FD

//*

//STEPLIB DD DSN=&SMPHLQ..CXVJLOAD,

//
DISP=SHR

//
DD DSN=&SMPHLQ..SXVJLOAD,

//
DISP=SHR

//
DD DSN=&SDSNEXIT,

//
DISP=SHR

//
DD DSN=&SDSNLOAD,

//
DISP=SHR

//SYSOUT
DD SYSOUT=*

//SYSUDUMP DD SYSOUT=*

//SYSPRINT DD SYSOUT=*

//RDXSQLCD DD SYSOUT=*

//RDXMLIB DD DSN=&SMPHLQ..SXVJMENU,DISP=SHR

//EXTPARMS DD *

FR
<-----FR/FD

PROD
VVRRMM
100200

SSID
XXXX
<-----ENTER DB2 SUSBSYSTEM

PLAN
XXXXXXXX
<-----ENTER DB2 PLAN NAME

MSGPREF XFR

RPTWTH
132

LINESPP 55

TERMTYPE 3278

//RDXPARMS DD *

RELDSN
'RELATIONSHIP.FILE.DSN'

/*
|---ENTER RELATIONSHIP FILE DSN

//*

//* ABOVE PARMS SUPPORTS PARAMETERS WITH KEYWORD IN POS. 1-10

//* AND VALUE IN 11-70 AND CONTINUATION (+) IN 71 (IF NEEDED FOR
//* LONG NAMES)

//* PARAMETERS: RELDSN - RELATIONSHIP FILE NAME

//*
CREATOR - CREATOR ID

//*
TBNAME - TABLE NAME (ONLY VALID IF CREATOR IS USED)
//*
GO
- ALLOWS MULTIPLE UPDATE RUNS


Return Codes
An execution return code (RC) appears in the output listing. For return codes 4 and 16,
an error code and message indicating the specific problem also appear in the listing. In
G-4
File-AID Single Install Image Installation and Configuration Guide
general, the return codes can be summarized as follows:
Return Code
Description
0
Job ran to completion.
4
Job ran to completion with warning messages issued.
16
Severe error, job aborted.
Error Messages
As referential integrity information is loaded in the relationship file, error messages
appear in the output listing. The following error messages can be ignored. They refer to
the DB2 catalog tables, which do not always conform with the rules of referential
integrity.
An error occurred loading the following relationship:
Relname: DSNAT#AF SYSIBM.SYSTABAUTH->SYSIBM.SYSCOLAUTH
E170 The parent table does not have a primary index. 

An error occurred loading the following relationship:
Relname: DSNVT#VL SYSIBM.SYSVTREE->SYSIBM.SYSVLTREE
E171 Unable to determine the foreign key for the dependent table.
The first time you run the refresh job, the following error message is generated because
the file is empty. It can be ignored.
LSCX557 **** WARNING **** ERRNO = ENFOUND
Generated in AFOPEN called from line 103 of KOPEN(KOPEN)
Uninitialized VSAM file cannot be opened for input.
Interrupted while: Opening file "ddn:RDXRELDS"
Loading or Refreshing CA Gen Application
Relationships
The following procedure describes how to load or refresh AR information from the CA
Gen Public Interface tables. The following CA Gen tables are required to load
information.
• FIELD
• FLD_LINK_USE
• LINKAGE
• MODEL
• RECORD
• REL_PART_IMPL
Procedure
Complete the following steps. All JCL members can be found in the File-AID sample
library, hlq.CPWR.MXVJA20.SXVJSAMP.
Note:
When refreshing application relationships, you only need to complete steps 2
and 3.
Refreshing the Relationship File
G-5
Step 1. Bind the Plan
Select member XFR2EFBD. This JCL binds the plan XFRIEFCA. Edit the JCL as described
in the comments and submit the job.
Step 2. Create a Sequential File
Select member XFR2EFRT. This JCL extracts the relationship information from the CA
Gen tables and loads it into a sequential file ??.IEF.FLATFILE. Edit the JCL as described in
the comments and submit the job.
Note:
To load or refresh the relationships for a single model only, change the last
parameter of the FRONTEND step from '*’ to the desired model ID, 'model ID’.
Step 3. Load the Relationship File
Select member XFR2EFBK or XFR3ARBK (for a Version 3 Relationship file with long object
name support). This JCL loads the information from the flat file created in Step 2 into the
relationship file. Edit the JCL as described in the comments and submit the job.
This step also checks for
•