Chapter 1. Customizing Netview FTP
Total Page:16
File Type:pdf, Size:1020Kb
NetView IBM Customization SH12-5482-06 NetView IBM Customization SH12-5482-06 Note! Before using this information and the product it supports, be sure to read the general information under “Notices” on page v. Seventh Edition, December 1994 This is a major revision of, and obsoletes, SH12-5482-05. This edition applies to Release 1 Modification Level 1 of NetView File Transfer Program for VSE (5686-013) Release 1 Modification Level 1 of NetView File Transfer Program for VM (5684-048) Release 2 Modification Level 1 of NetView File Transfer Program for MVS Version 2 (5685-108) and to all subsequent releases and modifications until otherwise indicated in new editions or technical newsletters. Make sure you are using the correct edition for the level of the product. Order publications through your IBM representative or the IBM branch office serving your locality. Publications are not stocked at the address below. IBM welcomes your comments. A form for readers’ comments may be provided at the back of this publication, or you may address your comments to the following address: IBM Deutschland Entwicklung GmbH Information Development, Dept. 0446 Postfach 1380 71003 Boeblingen Germany When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you. Copyright International Business Machines Corporation 1988, 1994. All rights reserved. Note to U.S. Government Users — Documentation related to restricted rights — Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corp. Contents Notices . v Programming Interfaces . v Trademarks and Service Marks ............................ vi About This Book ................................... vii Abbreviations and Special Terms .......................... vii Chapter 1. Customizing NetView FTP ....................... 1 Special Considerations for MVS/XA or MVS/ESA .................. 2 User-Written File Handler .............................. 2 Pre-Queuing User-Exit Routine ........................... 2 Pre-Transfer User-Exit Routine ........................... 2 Post-Transfer User-Exit Routine ........................... 2 Post-Conversation User-Exit Routine ........................ 2 Chapter 2. Writing a User-Written File Handler ................. 3 Invoking a User-Written File Handler ......................... 3 Coding a User-Written File Handler .......................... 4 Considerations when Implementing a User-Written File Handler ........ 5 Coding the OPEN Function ............................. 6 Coding the GET Function .............................. 7 Coding the PUT Function .............................. 9 Coding the POINT Function ............................ 10 Coding the CLOSE Function ............................ 11 Designing a User-Written File Handler without Checkpointing .......... 13 Designing a User-Written File Handler with Checkpointing ............ 14 Checkpointing for the OPEN Function ...................... 14 Checkpointing for the PUT Function ....................... 15 Specifying Checkpoint Record Key Data ..................... 16 Specifying Checkpoint Record Information .................... 17 Writing a Checkpoint Record to the Checkpoint File .............. 18 Implementing Restart from Checkpoint for an Automatic Session Recovery (LU 0) . 19 Implementing Restart from Checkpoint for a Transfer Restart ........ 20 Using the User-Written File-Handler Interfaces ................... 23 Using the User File-Handler Parameter List ................... 23 Using the CALL Argument List .......................... 31 Presenting Information Parameters to the User-Written File Handler .... 32 Using the Registers ................................. 33 Sequence of Function Calls for a User-Written File Handler ........... 34 Normal File Transfer ................................ 34 Restarted File Transfer ............................... 35 File Transfer with Automatic Session Recovery (LU 0) ............ 36 Migrating a User-Written File Handler to NetView FTP V2.2 MVS ........ 37 Chapter 3. Writing a Pre-Queuing User-Exit Routine ............. 39 What the Pre-Queuing User-Exit Routine Does .................. 40 Modifying a Request Password .......................... 40 Modifying a Server Class .............................. 41 Modifying a Request Priority ............................ 41 Copyright IBM Corp. 1988, 1994 iii Modifying a Server Group Name or Remote LU Name ............ 41 Modifying the Wait Time .............................. 42 Changing Parameters . 42 Coding the Pre-Queuing User-Exit Routine ..................... 43 Using the Application Program Parameter List (APL) ............. 43 Using the Application Program Parameter List Extension (APX) ....... 43 Using the Registers ................................. 43 Specifying Return Codes .............................. 44 Chapter 4. Writing a Pre-Transfer User-Exit Routine ............. 45 What the Pre-Transfer User-Exit Routine Does .................. 47 Changing Parameters . 48 Coding a Pre-Transfer User-Exit Routine ...................... 52 Calling the Pre-Transfer User-Exit Routine ................... 52 Using the Application Program Parameter List (APL) ............. 53 Using the Application Program Parameter List Extension (APX) ....... 53 Passing User-Specific Information ........................ 53 Using the Registers ................................. 53 Specifying Return Codes .............................. 54 Passing Messages to the Transfer Program ................... 55 Using the Trace Facility .............................. 55 Chapter 5. Writing a Post-Transfer User-Exit Routine ............ 57 What the Post-Transfer User-Exit Routine Does .................. 58 Changing Parameters . 58 Coding a Post-Transfer User-Exit Routine ..................... 58 Calling a Post-Transfer User-Exit Routine .................... 58 Using the Application Program Parameter List (APL) ............. 59 Passing User-Specific Information ........................ 60 Using the Registers ................................. 60 Specifying Return Codes .............................. 61 Passing Messages to the Transfer Program ................... 61 Using the Trace Facility .............................. 61 Migrating DVGJOBS to NetView FTP V2.2 MVS .................. 61 Examples of Using DVGJOBS in NetView FTP MVS ............. 63 How DVGJOBS Uses the Value of the Exit Routine Input Parameter .... 63 How DVGJOBS Modifies Submitted Jobs .................... 64 How to Submit a Job That Has Just Been Transferred ............ 66 The DVGEXJOB Sample Post-Transfer User-Exit Routine for NetView FTP VSE . 66 What DVGEXJOB Does .............................. 66 How to Install DVGEXJOB ............................. 67 How to Invoke DVGEXJOB ............................ 67 Syntax of the User-Exit Routine Input Parameter ................ 67 How DVGEXJOB Works in NetView FTP VSE ................. 70 How DVGEXJOB Uses the Value of the Exit Routine Input Parameter ... 70 Post-Transfer User-Exit Routine for NetView FTP VM to Run a REXX EXEC . 71 Installing DVGEXEC . 71 Functions Performed by DVGEXEC ....................... 71 Invoking DVGEXEC . 72 Creating a Spool File Using the Pre- and Post-Transfer User-Exit Routines .. 73 Using the Spool-File Routine DVGSPOOL (NetView FTP VM) ........ 73 Using the Spool-File Routine DVGMXXMT (NetView FTP V2 MVS) ..... 75 iv NetView FTP Customization Chapter 6. Writing a Post-Conversation User-Exit Routine ......... 79 When a Post-Conversation User-Exit Routine Is Called .............. 79 What a Post-Conversation User-Exit Routine Can Do ............... 79 Changing Parameters . 80 How the Transfer Program Handles Actions of the Post-Conversation User-Exit Routine . 80 Considerations when Coding a Post-Conversation User-Exit Routine ...... 81 Chapter 7. Communicating with User-Exit Routines ............. 83 Sequence of Calls to User-Exit Routines ...................... 84 Exceptions to the Calling Sequence ......................... 84 Data Areas for Communicating between User-Exit Routines ........... 88 Rules for Modification of Data Areas ......................... 89 Exceptional Situations in Data Area Flow ...................... 91 Calling Sequence and Data Flow .......................... 91 Chapter 8. Considerations when Designing User-Exit Routines ...... 93 Accessing Data Sets Involved in a File Transfer .................. 93 Combining User-Exit Routines ............................ 93 How the Pre-Transfer and Post-Transfer User-Exit Routines Work Together . 94 Sequence of Calls for User-Exit Routines ...................... 94 Case 1: File-Transfer Request Is Obtained by the Sending Transfer Program (LU 6.2) . 95 Case 2: File-Transfer Request Is Obtained by the Receiving Transfer Program (LU 6.2) ................................. 98 Chapter 9. Writing a Security/Statistics Collection User-Exit Routine .. 101 Chapter 10. Issuing Messages from User-Exit Routines .......... 103 The Message Area .................................. 103 Number of Messages ............................... 104 Length of Message ................................ 104 Text of Message .................................. 104 Messages for a Nonzero Return Code ...................... 105 Chapter 11. Using the Trace Facility ...................... 107 Invoking a Trace ................................... 109 Chapter 12. Using the APL ............................ 111 Layout of the APL .................................