CA XCOM Data Transport for z/OS User Guide

CA XCOM Data Transport for z/OS User Guide
CA XCOM Data Transport for
z/OS
™
®
User Guide
r11.5
This documentation and any related computer software help programs (hereinafter referred to as the
―Documentation‖) is for the end user’s informational purposes only and is subject to change or withdrawal by CA at
any time.
This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part,
without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and
protected by the copyright laws of the United States and international treaties.
Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the documentation for their
own internal use, and may make one copy of the related software as reasonably required for back-up and disaster
recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy. Only
authorized employees, consultants, or agents of the user who are bound by the provisions of the license for the
product are permitted to have access to such copies.
The right to print copies of the documentation and to make a copy of the related software is limited to the period
during which the applicable license for the Product remains in full force and effect. Should the license terminate for any
reason, it shall be the user’s responsibility to certify in writing to CA that all copies and partial copies of the
Documentation have been returned to CA or destroyed.
EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY
APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION ―AS IS‖ WITHOUT WARRANTY OF ANY KIND, INCLUDING
WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS
OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION,
LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED OF
SUCH LOSS OR DAMAGE.
The use of any product referenced in the Documentation is governed by the end user’s applicable license agreement.
The manufacturer of this Documentation is CA.
Provided with ―Restricted Rights.‖ Use, duplication or disclosure by the United States Government is subject to the
restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section
252.227-7014(b)(3), as applicable, or their successors.
All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.
Copyright © 2010 CA. All rights reserved.
CA Product References
■
CA 7® Workload Automation Smart Console Option (CA 7)
■
CA ACF2® (CA ACF2)
■
CA Dynam/T Tape Management (CA Dynam/T)
■
CA NetMaster® File Transfer Management (CA NetMaster FTM)
■
CA Roscoe® (CA Roscoe)
■
CA Top Secret® (CA Top Secret)
■
CA XCOM™ Data Transport® (CA XCOM Data Transport)
Contact CA
Contact Technical Support
For your convenience, CA provides one site where you can access the
information you need for your Home Office, Small Business, and Enterprise CA
products. At http://ca.com/support, you can access the following:
■
Online and telephone contact information for technical assistance and
customer services
■
Information about user communities and forums
■
Product and documentation downloads
■
CA Support policies and guidelines
■
Other helpful resources appropriate for your product
Provide Feedback
If you have comments or questions about CA product documentation, you can
send a message to techpubs@ca.com.
If you would like to provide feedback about CA product documentation, complete
our short customer survey, which is also available on the CA Support website,
found at http://ca.com/docs.
New Parameters
The following new parameters (PARM, Symbolic, and SYSIN01) are documented
in this guide:
&DATE(format-code)
Causes the current date to be substituted dynamically in the current
keyword value. The format of the date depends on the format code that is
selected as a sub-parameter.
Parameter type: Symbolic
&ID
Causes the value entered for ID to be substituted dynamically in the current
keyword value.
Parameter type: Symbolic
&IPNAME
Causes the value entered for IPNAME to be substituted dynamically in the
current keyword value.
Parameter type: Symbolic
&LU
Causes the value entered for LU to be substituted dynamically in the current
keyword value.
Parameter type: Symbolic
&LUSER
Causes the current LOCAL user ID (or the USERID of the current job) to be
substituted dynamically in the current keyword value.
Parameter type: Symbolic
&TIME(format-code)
Causes the current time to be substituted dynamically in the current
keyword value. The format of the time depends on the format code that is
selected as a sub-parameter.
Parameter type: Symbolic
&USERID
Causes the current REMOTE user ID (or the USERID of the current job) to be
substituted dynamically in the current keyword value.
Parameter type: Symbolic
FILEDATA
Indicates how the remote file is to be allocated.
Parameter type: SYSIN01
HISTDD
Specifies the DD name of the data set to contain the selected history records.
Parameter type: PARM
LCLNTFYL
Specifies the local notification level for transfers initiated from the CA XCOM
for z/OS server.
Parameter types: SYSIN01
LFILEDATA
Indicates how the local file is to be allocated.
Parameter type: SYSIN01
OEDATE
Limits the history request to only those file transfers that were scheduled or
completed on or before the end date and time.
Parameter type: SYSIN01
OETIME
Limits the history request to only those file transfers that were scheduled or
completed on or before the end date and time.
Parameter type: SYSIN01
OFILETYPE
Limits the history request to those transfers with the specified FILETYPE.
Parameter type: SYSIN01
OFLMAX
Limits the history request to only those file transfers where the number of
bytes transferred is equal to or less than the value specified.
Parameter type: SYSIN01
OFLMIN
Limits the history request to only those file transfers where the number of
bytes transferred is equal to or greater than the value specified.
Parameter type: SYSIN01
OID
Limits the history request to only those file transfers with a specific transfer
ID. The transfer ID is a user-defined identifier for file transfer requests.
Parameter type: SYSIN01
OINIT
Limits the history request to only locally initiated transfers or only remotely
initiated transfers.
Parameter type: SYSIN01
OLIMIT
Sets the maximum number of history records that can be returned.
Parameter type: SYSIN01
OLMSG
Limits the history request by the transfer's last message.
Parameter type: SYSIN01
OLU
Limits the history request to only those file transfers with a specific remote
LU name.
Parameter type: SYSIN01
OREQ
Limits the history request to only those file transfers that contain this specific
request number.
Parameter type: SYSIN01
OSDATE
Limits the history request to only those file transfers that were scheduled or
completed on or after the start date and time.
Parameter type: SYSIN01
OSTIME
Limits the history request to only those file transfers that were scheduled or
completed on or after the start date and time.
Parameter type: SYSIN01
OSYSID
Limits the history request to only those file transfers with a specific history
system ID in an XCOMPLEX environment.
Parameter type: SYSIN01
OSYSNAME
Limits the history request to only those file transfers with a specific history
system name in an XCOMPLEX environment.
Parameter type: SYSIN01
OTNAME
Limits the history request to only those file transfers with a specific remote
TCP/IP name or TCP/IP address.
Parameter type: SYSIN01
OTYPE
Specifies if the history request should include active transfer requests,
inactive transfer requests, or completed transfers.
Parameter type: SYSIN01
OTYPEREQ
Limits the history request to only send transfers or only receive transfers.
Parameter type: SYSIN01
OUSER
Limits the history request to only those file transfers submitted by a specific
user.
Parameter type: SYSIN01
PSOPREF
Specifies the high level qualifier to use to create a temporary data set.
Parameter type: PARM for TYPE=EXECUTE transfers
RELEASE
Specifies whether CA XCOM Data Transport is to release unused DASD space
when creating a new file or replacing an existing file.
Parameter types: SYSIN01
RMTNTFYL
Specifies the remote notification level for transfers initiated from the CA
XCOM for z/OS server.
Parameter types: SYSIN01
TRUSTED
Specifies whether a user can request a trusted transfer.
Parameter type: SYSIN01
UMASK
Sets the permissions assigned to a file when the file is being created and
received on the system for the first time.
Parameter types: SYSIN01
VLR
Indicates whether a transfer is using extended Variable Length Record
support.
Parameter type: SYSIN01
Changed ISPF Panels
Changes for HFS Support
The following changes have been made to ISPF fields for HFS support:
■
The Local File field has been increased to 255 characters.
■
The following new fields have been added:
–
FILEDATA—Indicates how the remote USS file is to be allocated.
–
LFILEDATA—Indicates how the local USS file is to be allocated.
–
UMASK—Specifies the file permissions to be removed from the XCOM
default file or directory permissions for USS files or directories.
–
USSLRECL—If LFILEDATA or FILEDATA is set to B (binary), this value
tells CA XCOM Data Transport how many bytes there are in each logical
record.
Note: Batch uses the existing LRECL parameter for this purpose.
Changes for Extended File Names
The following two panels now accept file names up to the maximum allowable
size for the Local File (255 characters) and Remote File (256 characters):
■
Receive File From Another System Screen
■
Send MVS File To Another System Screen
Because of this change, the MVS Extended Local/Remote File Name Entry is no
longer required, and has been removed.
Changes for Multiple Sessions
CA XCOM Data Transport now displays the ACBNAME of the CA XCOM Data
Transport server on the following ISPF panels:
■
Send MVS File To Another System screen
■
Send Report To Another System screen
■
Submit Job To Another System screen
■
Receive File From Another System screen
This means that, if you have multiple CA XCOM Data Transport ISPF interface
sessions running at the same time with different CA XCOM Data Transport
servers, you can tell which ISPF session is connected to which server.
Changes to the XCOM Operator Control Panel
The following new fields have been added to the XCOM Operator Control panel
(the File Transfer Display Select panel):
■
History System Id—Limits the file transfer requests displayed to those with
the specified history system ID in an XCOMPLEX environment.
■
History System Name—Limits the file transfer requests displayed to those
with the specified history system name in an XCOMPLEX environment.
■
Last Message—Restricts the search for file transfers to those where the last
message matches the value specified.
■
Local or Remote—Restricts the search for file transfers to those that are
locally initiated or remotely initiated.
■
File Type—Restricts the search for file transfers to those that match the
specified value.
■
Transfer Type—Restricts the search for file transfers to those that are send
or receive type transfers.
■
Range Start Time and Range End Time—Restrict the search for file transfers
to those that started between the times specified.
■
Range File Size Min. and Max.—Restrict the search for file transfers to those
that match a file size within the range specified.
Contents
Chapter 1: The Menu Interface (TSO/ISPF Panels)
19
Entering the Menu Interface ................................................................... 19
Sample CLIST ............................................................................ 20
Menu Hierarchy .............................................................................. 20
Default Values ............................................................................ 21
Special Feature Keys .......................................................................... 22
Help Facility .................................................................................. 23
The Primary Option Menu ..................................................................... 23
Selection Menu Options ................................................................... 24
Primary Processing Parameters ............................................................ 24
Remote System Identification.............................................................. 24
Local System Identification ................................................................ 27
Other Parameters ......................................................................... 28
MVS Send Functions Menu .................................................................... 31
Send Functions Menu Options.............................................................. 31
Send Functions Menu Parameters .......................................................... 32
Remote System Identification.............................................................. 32
Queue for Execution ...................................................................... 34
Local System Identification ................................................................ 35
Send MVS File To Another System Screen ...................................................... 37
Parameter Fields .......................................................................... 38
Remote System Information ............................................................... 58
Local System Information ................................................................. 61
MVS Extended Tape Parameter Entry .......................................................... 64
Screen ................................................................................... 64
Parameter Fields .......................................................................... 65
File Allocation Information Screen ............................................................. 67
Parameter Defaults ....................................................................... 68
Supported File Types ...................................................................... 68
Screen ................................................................................... 69
Parameter Fields .......................................................................... 69
Send Report To Another System Screen ........................................................ 74
Parameter Fields .......................................................................... 74
Remote System Information ............................................................... 87
Local System Information ................................................................. 89
Submit Job To Another System Screen ......................................................... 91
Parameter Fields .......................................................................... 91
Remote System Information .............................................................. 101
Contents 11
Local System Information ................................................................ 103
Receive File From Another System Screen ..................................................... 106
Parameter Fields ......................................................................... 106
Remote System Information .............................................................. 124
Local System Information ................................................................ 127
Japanese Character Set Support Screen ....................................................... 131
Parameter Fields ......................................................................... 131
File Transfer Scheduling Information Screen ................................................... 133
Parameter Fields ......................................................................... 133
Member Selection List ....................................................................... 138
Operator Control ............................................................................ 140
Selecting a Display Option ................................................................ 141
Modifying the Filtering Options ............................................................ 141
Parameter Fields ......................................................................... 142
Parameters .............................................................................. 142
Transfer Request Display Screen.............................................................. 147
Sorting Transfer Request Information ..................................................... 148
Locating a Request....................................................................... 149
Using the LOCATE Command ............................................................. 150
Unprotected (Control) Fields .............................................................. 151
Selection Commands ..................................................................... 152
Protected (Display) Fields ................................................................ 152
Status Fields ............................................................................ 153
Detailed File Transfer Display ................................................................. 155
Common Section Information Fields ....................................................... 156
Sending/Receiving System Information.................................................... 157
Menu Interface Messages .................................................................... 157
Chapter 2: The Batch Interface
159
Special Features ............................................................................. 159
Third-Party Processing ................................................................... 159
Broadcast Distributions ................................................................... 159
Interdependent Transfers ................................................................ 160
User-Specified Checkpoints ............................................................... 160
Batched Multiple Transfers ............................................................... 160
XCOMJOB Sample JCL ....................................................................... 160
XCOMJOB TYPE=EXECUTE Sample ........................................................ 161
XCOMJOB TYPE=SCHEDULE Samples...................................................... 161
XCOMJOB TYPE=INQUIRE Samples ....................................................... 161
XCOMJOB TYPE=HISTORY Sample ........................................................ 162
XCOMJOB DD Statements .................................................................... 162
LCLDS01 ................................................................................ 163
12 User Guide
JOBLIB or STEPLIB ....................................................................... 164
SYSIN01 ................................................................................ 164
SYSPRINT ............................................................................... 164
SYSTCPD ................................................................................ 164
XCOMGLOB .............................................................................. 165
XCOMHOUT ............................................................................. 165
XCOMINQ ............................................................................... 165
XCOMPRNT .............................................................................. 165
XCOMREST .............................................................................. 166
XCOMJOB Parameter Classes ................................................................. 166
PARM Parameters............................................................................ 166
ACBNAME ............................................................................... 167
COMPNEG ............................................................................... 168
CONTINUE .............................................................................. 169
DFLTAB ................................................................................. 169
DISPALG ................................................................................ 170
DOMAIN................................................................................. 170
DUMPCL ................................................................................. 170
EDESC .................................................................................. 171
EROUT .................................................................................. 171
GROUP .................................................................................. 173
HISTDD ................................................................................. 173
IDESC................................................................................... 174
IPNAME ................................................................................. 175
IPPORT.................................................................................. 175
IROUT .................................................................................. 175
LIST .................................................................................... 177
LOG..................................................................................... 178
LOGCLASS .............................................................................. 178
LOGDEST ............................................................................... 178
LOGMODE ............................................................................... 179
LU ...................................................................................... 179
NETNAME ............................................................................... 179
PSOPREF ................................................................................ 179
REPCR .................................................................................. 180
SECURE_SCHEDULE ..................................................................... 180
STCAPPL ................................................................................ 181
STCIP ................................................................................... 181
STCPORT ................................................................................ 181
SUPPLIST ............................................................................... 182
SWAIT .................................................................................. 182
TCPSTACK ............................................................................... 183
Contents 13
TIMEOUT ................................................................................ 183
TRACE .................................................................................. 184
TYPE .................................................................................... 185
VTAMGNAM ............................................................................. 186
XCOMPLEX .............................................................................. 186
SYSIN01 Parameters......................................................................... 187
SYSIN01 DD Statement .................................................................. 187
Symbolic Parameters..................................................................... 188
General SYSIN01 Parameters ............................................................. 192
SYSIN01 Parameters Required by FILETYPE=FILE .......................................... 225
SYSIN01 Parameters Supported by FILETYPE=HISTORY .................................... 232
SYSIN01 Parameters Required by FILETYPE=REPORT ...................................... 244
SYSIN01 Tape Parameters ................................................................ 248
SYSIN01 DCB Parameters ................................................................ 252
SYSIN01 Transfer Control (XTC) Parameters ............................................... 256
Coding Interdependent Transfers ......................................................... 261
Coding XTC Transfers in an XCOMPLEX Environment ....................................... 264
XCOMJOB Return Codes .................................................................. 264
Chapter 3: The Programming Interface
267
The CA XCOM Data Transport Process ......................................................... 267
Allocating the Local Data Set and Parameter Files .............................................. 268
Define Two CA XCOM Data Transport Files ................................................. 268
Sample DD Statement ................................................................... 268
Calling CA XCOM Data Transport from a COBOL Program ....................................... 269
Sample Fragment ........................................................................ 270
Calling CA XCOM Data Transport from an Assembler Program .................................. 271
Sample Assembler Program .............................................................. 272
Chapter 4: The Remote Spooling Feature (Process SYSOUT)
275
Basics of JES Spool Use ...................................................................... 275
Advantages of Using the Process SYSOUT Interface ........................................ 276
Process ................................................................................. 277
Overview—Sending Reports with PSO ..................................................... 277
Destination Definitions ................................................................... 279
Assigning a JES Destination or Writer to a Remote System ................................. 280
Assigning a JES Destination or Writer to a Specific User .................................... 280
Using Process SYSOUT with CICS or Other Online Systems ................................. 281
Using Process SYSOUT with TSO .......................................................... 281
Sample z/OS File Transfer to a PC ........................................................ 281
Sample z/OS File Transfer to an HP OpenVMS ............................................. 282
14 User Guide
Process SYSOUT Enhancements .............................................................. 282
External Writer Support .................................................................. 282
Reasons for Using the External Writer ..................................................... 282
Sample Scenario ......................................................................... 283
Routing to a Specific Minicomputer Printer ................................................. 283
Using PSOWAIT .......................................................................... 284
JES2 Considerations ......................................................................... 284
Valid Destination Names ................................................................. 284
JES3 Considerations ......................................................................... 285
Valid Destination Names ................................................................. 285
Sample Specific Destination Definitions .................................................... 285
Sample Generic Destination Definition ..................................................... 286
PSOPREF Considerations ..................................................................... 286
Format for PSO Data Set Names .......................................................... 286
Determining the User Catalog for the PSO Interface ........................................ 287
Chapter 5: Operation and Control
289
Starting the CA XCOM Data Transport Server .................................................. 290
Starting the XCOMPLEX Admin Server......................................................... 291
Starting the XCOMPLEX Worker Server ........................................................ 293
Using the MODIFY Commands ................................................................ 294
MODIFY Command Format ............................................................... 294
Notational Conventions ................................................................... 295
ACTIVATE Command ..................................................................... 295
ALTER Command ........................................................................ 296
CANCEL Command ....................................................................... 299
CNOS Command ......................................................................... 301
DELETE Command ....................................................................... 303
DFLT Command .......................................................................... 304
DISABLE Command ...................................................................... 308
DISPLAY Command ...................................................................... 311
DUMP Command ......................................................................... 312
DUMPXCF Command ..................................................................... 313
ENABLE Command ....................................................................... 314
EXIT Command .......................................................................... 315
HOLD Command ......................................................................... 316
INQ Command ........................................................................... 317
LIST Command .......................................................................... 318
LOGFREE Command ...................................................................... 319
NOTRACE Command ..................................................................... 320
NOXTRACE Command .................................................................... 321
NSASTAT Command ..................................................................... 321
Contents 15
RELEASE Command ...................................................................... 323
RESET Command ........................................................................ 323
RESUME Command ...................................................................... 325
RSHOW Command ....................................................................... 325
SHOW Command ........................................................................ 327
SNAP Command ......................................................................... 329
STAT Command ......................................................................... 330
STOP Command ......................................................................... 332
SUSPEND Command ..................................................................... 333
TERM Command ......................................................................... 335
TRACE Command ........................................................................ 336
VERSION Command ...................................................................... 337
XRSHOW Command ...................................................................... 338
XSHOW Command ....................................................................... 339
XTRACE Command ....................................................................... 340
Chapter 6: Processing Different File Types
343
Partitioned Data Sets ........................................................................ 343
PDS and PDSE Support ................................................................... 344
PDSE Program Library Support ........................................................... 344
Generic File Specifications (Using Wildcards) .................................................. 345
Library Transfers ........................................................................ 346
Generation Data Groups ..................................................................... 347
Scheduled Versus Immediate Transfer Considerations ...................................... 347
Batch Interface .......................................................................... 348
Menu Interface .......................................................................... 349
Transferring All Generations of a GDG ..................................................... 349
USS Files ................................................................................... 349
Handling USS Files as BINARY ............................................................ 349
Handling USS Files as TEXT ............................................................... 350
Handling BINARY USS Files as TEXT ....................................................... 350
VSAM Files .................................................................................. 350
Key Sequenced Data Sets (KSDS) ........................................................ 351
Entry Sequenced Data Sets (ESDS) ....................................................... 351
Relative Record Data Sets (RRDS) ........................................................ 351
Miscellaneous File Considerations ............................................................. 351
Fixed to Variable Length Record Transfers ................................................. 352
Multivolume Data Sets ................................................................... 352
Spanned Records ........................................................................ 352
Preserving Variable Length Record Descriptor Words ....................................... 352
16 User Guide
Chapter 7: Overview of Security
353
File Security ................................................................................. 353
Command Security .......................................................................... 353
Partner Security ............................................................................. 353
Invoking Security ............................................................................ 354
Data Encryption Using Secure Socket Layer (SSL) ............................................. 354
Appendix A: History and SMF Files
355
SMF Record and History File .................................................................. 355
When Records Are Written................................................................ 355
Transfers That Produce Records........................................................... 355
Transfers That Do Not Produce Records ................................................... 356
Record Location ......................................................................... 356
XCOMUTIL History File Purge Utility ........................................................... 356
XCOMUTIL Parameters ....................................................................... 356
AGE ..................................................................................... 357
DATE ................................................................................... 357
PROCESS................................................................................ 358
XCOMUTIL DD Statements ................................................................... 358
Sample of Required JCL .................................................................. 359
Return Codes ............................................................................ 359
Sample History File Purge Process (XCOMUTIL) ............................................ 360
Appendix B: Sample Files
361
Sample JCLVSAM Request Queue (Member DEFRRDS) ......................................... 363
Sample History File Creation JCL (Member DEFHIST) ........................................... 365
Sample XCOMUTIL Job (Member XCOMUTIL) .................................................. 368
Sample DEFQSAM Job to Define Global and Restart Data Sets (Member DEFQSAM) .............. 373
Sample JCL for Defining the Inquire Data Set (Member DEFINQ) ................................ 374
Sample VTAM APPLID Definition Table (Member APPLXCOM) ................................... 375
Sample XCOMTABL Table (Member XCOMTABL) ............................................... 377
Sample XCOMDFLT Macro (Member XCOMDFLT) ............................................... 382
Sample XCOMADMT Table (Member XCOMADMT) .............................................. 385
Sample XCPF (Member XCPF) ................................................................ 386
Sample POLCFRM (Member POLCFRM) ........................................................ 387
Sample XCOMPLEX Admin Server ............................................................. 388
Sample Server JCL (Member XCOM) .......................................................... 389
Sample XCOMLSR ........................................................................... 390
Sample CICS Notification Transaction (Member XCOMSAMP) ................................... 391
Sample XCOMJOB—Execute JCL (Member XCOMJOBE) ......................................... 392
Sample XCOMJOB—Schedule JCL (Member XCOMJOBS) ........................................ 393
Contents 17
Sample XCOMJOB—Schedule JCL through the XCOMPLEX Admin Server (Member XCOMJOXS) .... 394
Sample XCOMJOB—Inquire JCL (Member XCOMJOBI) .......................................... 396
Sample XCOMJOB—Inquire JCL through the XCOMPLEX Admin Server (Member XCOMJOXI) ...... 398
Sample XCOMJOB TYPE=HISTORY JCL (Member XCOMJOBH) ................................... 400
Sample JCL for Reassembling and Link Editing XCOMRACF (Member ASMRACFU) ................ 402
Sample JCL for Reassembling and Link Editing XCOMTOPS (Member ASMTOPSU) ................ 404
Sample JCL for Reassembling and Link Editing XCOMACF2 (Member ASMACF2U) ................ 406
Sample DEFDFLT ............................................................................ 407
Sample XCOMENCR—JCL to Encrypt the SYSIN01 PASSWORD/LPASS Parameters (Member
XCOMENCR) ................................................................................. 408
Sample COPYCSD ........................................................................... 409
Sample XCOMFCT ........................................................................... 411
Sample XCOMPCT ........................................................................... 412
Sample XCOMPPT............................................................................ 413
Sample XCOMTCT ........................................................................... 414
Appendix C: User Exits
415
User Exit 1 .................................................................................. 416
User Exit 2 .................................................................................. 418
User Exit 3 .................................................................................. 420
User Exit 4 .................................................................................. 422
User Exit 5 .................................................................................. 424
User Exit 6 .................................................................................. 427
User Exit 7 .................................................................................. 430
User Exit 8 .................................................................................. 432
User Exit 9 .................................................................................. 434
User Exit 10 ................................................................................. 436
User Exit 12 ................................................................................. 438
User Exit 13 ................................................................................. 440
Index
18 User Guide
443
Chapter 1: The Menu Interface (TSO/ISPF
Panels)
This chapter discusses the CA XCOM Data Transport for z/OS Menu Interface,
with its various screens and parameters.
This section contains the following topics:
Entering the Menu Interface (see page 19)
Menu Hierarchy (see page 20)
Special Feature Keys (see page 22)
Help Facility (see page 23)
The Primary Option Menu (see page 23)
MVS Send Functions Menu (see page 31)
Send MVS File To Another System Screen (see page 37)
MVS Extended Tape Parameter Entry (see page 64)
File Allocation Information Screen (see page 67)
Send Report To Another System Screen (see page 74)
Submit Job To Another System Screen (see page 91)
Receive File From Another System Screen (see page 106)
Japanese Character Set Support Screen (see page 131)
File Transfer Scheduling Information Screen (see page 133)
Member Selection List (see page 138)
Operator Control (see page 140)
Transfer Request Display Screen (see page 147)
Detailed File Transfer Display (see page 155)
Menu Interface Messages (see page 157)
Entering the Menu Interface
Access to CA XCOM Data Transport's Primary Option Menu from ISPF is
site-dependent. If CA XCOM Data Transport is not an option on the ISPF Primary
Option Menu or any subordinate ISPF menu screen, you must include a
procedure in your CLIST and use the following procedure:
1. Choose Option 6 from the ISPF Primary Option Menu and press Enter to go to
the command line mode.
2. On the command line, type the name of the member where your CLIST is
stored (for example, XCOM11) and press Enter to invoke CA XCOM Data
Transport.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 19
Menu Hierarchy
Sample CLIST
PROC 0 DEBUG
CONTROL END(DEND)
IF &DEBUG NE THEN CONTROL LIST CONLIST SYMLIST
/*********************************************************************/
START: +
ISPEXEC LIBDEF ISPPLIB DATASET ID('XCOM.RB5.CBXGPNL0')
ISPEXEC LIBDEF ISPMLIB DATASET ID('XCOM.RB5.CBXGMSG0')
STEPLIB DSNAME('XCOM.RB5.LOADLIB')
ISPEXEC LIBDEF ISPTLIB DATASET ID('XCOM.RB5.CINB5STL' +
'&SYSUID..ISPF.ISPPROF')
ALTLIB ACTIVATE APPLICATION(CLIST) DA('XCOM.RB5.CBXGCLS0')
ISPEXEC SELECT PANEL(XCOMPRIM) NEWAPPL(XCOM) PASSLIB
ISPEXEC LIBDEF ISPPLIB
ISPEXEC LIBDEF ISPMLIB
ISPEXEC LIBDEF ISPTLIB
ALTLIB RESET
Note: Substitute your library names for the ones in the sample.
Menu Hierarchy
CA XCOM Data Transport can be invoked through TSO/ISPF, using the Menu
Interface or the CA XCOM Data Transport CLIST Library (CAI.CBXGCLS0).
Through the facilities of TSO/ISPF Dialog Manager, CA XCOM Data Transport
provides a set of fill-in-the-blank menu screens. The hierarchy of the main CA
XCOM Data Transport screens is shown next:
20 User Guide
Menu Hierarchy
Default Values
Each time you access CA XCOM Data Transport's ISPF dialog, previously selected
values are retrieved from your ISPF profile. However, in the interest of security
and data integrity, certain parameters, such as the Remote System Password,
Local System Password, Notify User on Local System, and Create/Add/Replace
fields, are not retained. Instead, they are set to their default values (or blanks, in
the case of passwords).
Override inappropriate values for the current transfer by typing in the correct
values.
Note: Parameters that cannot be set through a CA XCOM Data Transport screen
are set to site-defined default values as obtained from the CA XCOM Data
Transport default table entered on the menu.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 21
Special Feature Keys
Special Feature Keys
All CA XCOM Data Transport screens permit the use of programmable function
keys, most of which are used in a manner consistent with ISPF. CA XCOM Data
Transport uses standard ISPF Dialog Manager services and is compatible with
the normal ISPF environment. These include the following:
PF1
Invokes online Help from a working screen. When Help is active, PF3 returns
you back to the original screen where Help was invoked.
PF2
Activates ISPF split-screen mode.
PF3
Returns you to the previous screen. Input already entered on the current
screen is saved. If the current screen is the Primary Option Menu, you are
returned to the ISPF panel from which CA XCOM Data Transport was first
invoked.
PF7
Scrolls backward (up) to continue the display for panels with multiple
entries.
PF8
Scrolls forward (down) to continue the display for panels with multiple
entries.
PF9
Swaps the current screen to the other screen in split-screen mode.
PF10
Displays Japanese Character Set Support screen
PF11
Invokes the File Transfer Scheduling Information screen, allowing you to
enter file-scheduling parameters.
PF12
Invokes the File Allocation Information File screen from the Send MVS File To
Another System screen, allowing you to override default and propagated
space and DCB values for new z/OS data sets.
22 User Guide
Help Facility
Help Facility
CA XCOM Data Transport features a Help facility, which provides help
information for every CA XCOM Data Transport screen. You can obtain help
information by using the PF1 key:
■
When you want to obtain help for a particular field, place your cursor on that
field and press PF1.
■
Pressing PF1 when the cursor is on the COMMANDS line allows you to start a
CA XCOM Data Transport tutorial session, with the current screen as its
starting point.
■
When a message is displayed, pressing PF1 provides help for that message.
■
To cancel a help session and return to the starting point, press PF3.
The Primary Option Menu
The XCOM Selection Menu is the entry point for the CA XCOM Data Transport
Menu Interface screens. Four options are provided. In addition to selecting a
menu option, certain primary processing parameters can be specified on this
screen. The values entered are retained on all subsequent screens for this
transfer, but can be overridden by typing in new values.
-------------------------------------------------------------------------------08/07/16
CA XCOM Release r11.5 SP00
USER01
08.099
Primary Option Menu
11:00
-------------------------------------------------------------------------------OPTION ===>
1 1.1 - Send Files
1.2 - Send Reports
1.3 - Send Jobs
2 - Receive Files
3 - XCOM Operator Control
Remote System Identification
IP Dest: 123.123.123.123
CONFIG SSL:
or
SNA LU Name:
or XCOM List Name:
Port: 4567
or
or
Local System Identification
Server: 321.321.321.321
SSL: YES
XCOM Group Name:
Login User Name:
Port: 5678
Protocol: TCP
Queue for Execution (Y/N): Y
(N = Execute immediately)
CA XCOM Default Member Name:
XCOMCNTL Data Set Name:
Save SYSIN01 in DS Name:
Only Save SYSIN01 (Y/N): N
-------------------------------------------------------------------------------PFK 1/Help
3/End
COPYRIGHT (C) 2008 CA, INC.
F1=Help
F7=UP
F2=SPLIT
F8=DOWN
F3=End
F9=SWAP
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
Chapter 1: The Menu Interface (TSO/ISPF Panels) 23
The Primary Option Menu
Selection Menu Options
The options for the Primary Option Menu are as follows:
1- Send Files, Reports, Jobs
Used for sending a file, report, or job to a remote system.
2 - Receive Files
Used for receiving a file from a remote system.
3 - XCOM Operator Control
Used to display information about, or to alter certain parameters pertaining
to all pending, in-progress, or completed transfers on a particular CA XCOM
Data Transport server. CA XCOM Data Transport Operator Control can also
be used to change a transfer's status.
In a Coupling Facility environment, this panel can also be used to display
information about pending, active, and completed transfers for all CA XCOM Data
Transport XCOMPLEX Worker Servers connected to an XCOMPLEX Admin Server.
Changes cannot be made to this list of transfers; changes can only be made
when looking at a list of transfers for an individual XCOMPLEX Worker Server.
Primary Processing Parameters
The primary processing parameters for the Primary Option Menu are described
below.
Remote System Identification
Identifies the partner system involved in a CA XCOM Data Transport transfer.
The terms in which the partner system can be identified are described below.
IP Dest
Specifies the name or address of the TCP/IP system or node with which a transfer
is to take place.
x1 . . . x63
Specifies the name or address of the remote TCP/IP system involved in a
transfer. The name can contain up to 63 alphanumeric characters and it
must be one that has been defined to the domain name server. The address
can be in IPv4 or IPv6 notation
Note: This parameter is mutually exclusive with SNA LU Name, XCOM Group
Name, Login User Name, and XCOM List Name; one of the five must be specified
for each file transfer request.
24 User Guide
The Primary Option Menu
Port
Specifies the number of the IP port where CA XCOM Data Transport listens at the
remote system.
Note: This field is displayed on subsequent screens only if an IP name or address
is specified in the Remote System Identification field.
1 to 65535
Identifies the IP port monitored (listened to) by CA XCOM Data Transport at
the remote system.
Note: If this field is left blank, the port value specified in the CA XCOM Data
Transport Default Options Table is used.
SSL
Specifies whether to use an OpenSSL socket or non-OpenSSL socket for
transfers.
YES
Performs a secure transfer. The transfer uses an OpenSSL socket and must
connect to an SSL listener on the remote partner.
NO
Performs a non-secure transfer. The transfer uses a non-OpenSSL socket.
Default: NO
CONFIG SSL
Specifies the HFS SSL configuration file path and file name.
1 to 256 characters
Specifies the HFS path and file name of the SSL configuration file used by CA
XCOM Data Transport for secure transfers.
Note: A sample SSL configuration file, configssl.cnf, is provided with the
installation.
Default: None
Chapter 1: The Menu Interface (TSO/ISPF Panels) 25
The Primary Option Menu
SNA LU Name
Specifies the logical unit name of the remote system with which a transfer is to
take place.
xxxxxxxx
Specifies up to eight alphanumeric or national characters representing the
logical unit name of the remote system with which a transfer is to take place.
The first character cannot be numeric.
Note: This parameter is mutually exclusive with IP Name, XCOM Group Name,
Login User Name and XCOM List Name; one of the five must be specified for each
file transfer request.
XCOM Group Name
Sends this file transfer to the first available LU of a group of logical units that has
been previously defined in the CA XCOM Data Transport Destination Table or to
a single TCP/IP partner.
xxxxxxxx
Specifies up to eight alphanumeric or national characters representing a
group of previously defined logical units where the first available LU should
receive this file transfer. The initial character must be national or alphabetic.
The XCOM group name can also be used to provide an alias for a single LU,
IP name or IP address.
Note: This parameter is mutually exclusive with SNA LU Name, Login User
Name, IP Name, and XCOM List Name; one of the five must be specified for each
file transfer request.
XCOM List Name
Used when this file transfer is to be broadcast to all the remote destinations
designated on a predefined distribution list.
xxxxxxxx
Enter up to eight alphanumeric characters representing the name of a list to
which this transfer is to broadcast.
Notes:
26 User Guide
■
This parameter is mutually exclusive with XCOM Group Name, Login User
Name, SNA LU Name, and IP Name; one of the five must be specified for
each file transfer request.
■
This parameter is valid only for queued transfers. As a result, some of the file
transfers may start at different times. The Menu Interface's Transfer
Request Display screen can be used to check the current completion status
of the file transfers initiated by a broadcast distribution.
The Primary Option Menu
Login User Name
Indicates that the transfer should be sent to the specified user.
Note: The login user name is identified by the CA XCOM Data Transport
CheckIn/CheckOut feature.
xxxxxxxx
Specifies up to eight alphanumeric and national characters representing a
user whose session is to be used for the transfer. The initial character must
be national or alphabetic.
Notes:
■
This parameter is mutually exclusive with XCOM Group Name, Login User
Name, SNA LU Name, IP Name, and XCOM List Name; one of the five must
be specified for each file transfer request.
■
If a security environment exists, the user names must be defined to the
security environment for CA XCOM Data Transport.
■
This parameter is valid only for queued transfers. The CA XCOM Data
Transport Transfer Request Display screen can be used to check on the
current completion status of any transfer.
Local System Identification
Identifies the local system involved in a CA XCOM Data Transport transfer. The
terms in which the local system can be identified are described below.
Port
Specifies the IP port of the STCIP of the CA XCOM Data Transport server on the
mainframe that is to start the transfer or the XCOMPLEX Admin Server that is to
schedule the transfer to an XCOMPLEX Worker Server. Required.
nnnnn
Specifies the IP port of the CA XCOM Data Transport server or XCOMPLEX
Admin Server. The IP port can contain valid numeric values 1 through
65535. This is the same as the STCPORT that you can specify in your
XCOMJOB PARM.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 27
The Primary Option Menu
Protocol
Specifies whether the Server field is the STCIP or the APPLID of the CA XCOM
Data Transport server on the mainframe that is to start the transfer or the
XCOMPLEX Admin Server that is to schedule the transfer to an XCOMPLEX
Worker Server. Required.
xxx
Valid values are SNA, TCP, and SSL.
If you specify SNA, then the Server field must be a one- to eight-character
entry conforming to the rules for VTAM APPLIDs.
If you specify TCP or SSL, the Server field must be a 1- to 64-character entry
conforming to the rules for a TCP/IP name or address. If the server listens to
a port other than 8044, specify the port address.
Other Parameters
Queue for Execution
Specifies whether this transfer request should be queued for execution by the CA
XCOM Data Transport server or through the XCOMPLEX Admin Server, or
executed immediately.
Y
This request is queued for execution by the CA XCOM Data Transport server
or the XCOMPLEX Admin Server.
If the remote system is unavailable and the file transfer request is queued,
the transfer executes when the remote system becomes available. Queued
functions permit a higher degree of processing control. For example, queued
transfers can be prioritized or held from execution until they are manually
released.
N
This request is executed immediately.
Non-queued transfers must execute within a specified default timeout
duration (defined in the Default Options Table) or they are aborted.
Default: Y
28 User Guide
The Primary Option Menu
CA XCOM Data Transport Default Member Name
Specifies the name of an alternate CA XCOM Data Transport default table to use.
xxxxxxxx
Specifies the name of an alternate CA XCOM Data Transport default options
table. This name can be one to eight alphanumeric characters.
Default: XCOMDFLT
XCOMCNTL Data Set Name
Specifies an alternate CA XCOM Data Transport control library to be used for this
transfer.
xxxx.xxx.xxxxxxxx
Specifies the name of an alternate CA XCOM Data Transport control library to
be used for this transfer. The control library name is a data set name.
Note: This parameter is only used for non-queued transfers (Queue for
Execution=N).
Save SYSIN01 in DS Name
Specifies a data set name where CA XCOM Data Transport writes the SYSIN01
parameters for the file transfer in addition to performing the file transfer.
xxxx.xxx.xxxxxxxx
Specifies the name of a data set where CA XCOM Data Transport writes the
SYSIN01 parameters used for a transfer.
Notes:
■
Specifying this field allows a user to save the SYSIN01 parameters for an
ISPF-initiated file transfer so that you can execute a batch job to perform the
same file transfer at a later date.
■
The PASSWORD parameter is saved as encrypted when an unencrypted
SYSIN01 is saved. The CA XCOM Data Transport Batch accepts the
PASSWORD in encrypted and non-encrypted format.
■
The data set named in this field must be an existing physical sequential file
or a member of a PDS.
■
If this field does not contain a value, CA XCOM Data Transport does not save
the SYSIN01 parameters.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 29
The Primary Option Menu
Only Save SYSIN01
Specifies whether or not CA XCOM Data Transport should only save the SYSIN01
parameters, or both save the parameters and initiate the transfer.
Y
CA XCOM Data Transport only writes the SYSIN01 parameters to the data set
specified in the Save SYSIN01 in DS name field. CA XCOM Data Transport
does not initiate a file transfer.
N
CA XCOM Data Transport saves the SYSIN01 parameters and initiates the file
transfer.
Note: This field, which is used in conjunction with the Save SYSIN01 in DS Name
field, allows you to create a SYSIN01 file for later use with the Batch Interface.
Default: N
30 User Guide
MVS Send Functions Menu
MVS Send Functions Menu
The MVS Send Functions screen, shown below, is used to select one of the three
types of outbound transmissions made with CA XCOM Data Transport. Data is
transmitted to a remote system in the form of a file, report, or job. The other
fields displayed on the screen reflect the entries made on the previous Primary
Option Menu and can be overridden on this screen.
------------------------------------------------------------------------------08/07/16
CA XCOM Release r11.5 SP00
USER01
MVS Send Functions
11:18
------------------------------------------------------------------------------OPTION
===>
1
2
3
- Send Files to Another System
- Send Reports to Another System
- Submit Jobs to Another System
Remote System Identification
IP Name or Address:
or
SNA LU Name:
or XCOM Group Name:
or XCOM List Name:
or Login User Name:
Port:
Queue for Execution (Y/N): Y
(N = Execute immediately)
Local System Identification
Server: 321.321.321.321
Port: 5678
Protocol: TCP
-------------------------------------------------------------------------------PFK 1/Help
3/End
COPYRIGHT (C) 2008 CA, INC.
F1=Help
F7=UP
F2=SPLIT
F8=DOWN
F3=End
F9=SWAP
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
Send Functions Menu Options
The options for the MVS Send Functions screen are as follows:
1 - Send Files to Another System
This field is used to send data and store it as a file on a remote system.
2 - Send Reports to Another System
This field is used to send data to a remote system and have it printed as a
report.
3 - Submit Jobs to Another System
This field is used to send data to a remote system and have it run as a job.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 31
MVS Send Functions Menu
Send Functions Menu Parameters
The processing parameters for the Send Functions Menu are described below.
Remote System Identification
Identifies the partner system involved in a CA XCOM Data Transport transfer.
The terms in which the partner system can be identified are described below.
Port
Specifies the number of the IP port where CA XCOM Data Transport listens at the
remote system.
Note: This field is displayed on subsequent screens only if an IP name or address
is specified in the Remote System Identification field.
1 to 65535
Identifies the IP port monitored (listened to) by CA XCOM Data Transport at
the remote system.
Note: If this field is left blank, the port value specified in the CA XCOM Data
Transport Default Options Table is used.
SNA LU Name
Specifies the logical unit name of the remote system with which a transfer is to
take place.
xxxxxxxx
Specifies up to eight alphanumeric or national characters representing the
logical unit name of the remote system with which a transfer is to take place.
The first character cannot be numeric.
Note: This parameter is mutually exclusive with IP Name, XCOM Group Name,
Login User Name and XCOM List Name; one of the five must be specified for each
file transfer request.
32 User Guide
MVS Send Functions Menu
XCOM Group Name
Sends this file transfer to the first available LU of a group of logical units that has
been previously defined in the CA XCOM Data Transport Destination Table or to
a single TCP/IP partner.
xxxxxxxx
Specifies up to eight alphanumeric or national characters representing a
group of previously defined logical units where the first available LU should
receive this file transfer. The initial character must be national or alphabetic.
The XCOM group name can also be used to provide an alias for a single LU,
IP name or IP address.
Note: This parameter is mutually exclusive with SNA LU Name, Login User
Name, IP Name, and XCOM List Name; one of the five must be specified for each
file transfer request.
XCOM List Name
Used when this file transfer is to be broadcast to all the remote destinations
designated on a predefined distribution list.
xxxxxxxx
Enter up to eight alphanumeric characters representing the name of a list to
which this transfer is to broadcast.
Notes:
■
This parameter is mutually exclusive with XCOM Group Name, Login User
Name, SNA LU Name, and IP Name; one of the five must be specified for
each file transfer request.
■
This parameter is valid only for queued transfers. As a result, some of the file
transfers may start at different times. The Menu Interface's Transfer
Request Display screen can be used to check the current completion status
of the file transfers initiated by a broadcast distribution.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 33
MVS Send Functions Menu
Login User Name
Indicates that the transfer should be sent to the specified user.
Note: The login user name is identified by the CA XCOM Data Transport
CheckIn/CheckOut feature.
xxxxxxxx
Specifies up to eight alphanumeric and national characters representing a
user whose session is to be used for the transfer. The initial character must
be national or alphabetic.
Notes:
■
This parameter is mutually exclusive with XCOM Group Name, Login User
Name, SNA LU Name, IP Name, and XCOM List Name; one of the five must
be specified for each file transfer request.
■
If a security environment exists, the user names must be defined to the
security environment for CA XCOM Data Transport.
■
This parameter is valid only for queued transfers. The CA XCOM Data
Transport Transfer Request Display screen can be used to check on the
current completion status of any transfer.
Queue for Execution
Specifies whether this transfer request should be queued for execution by the CA
XCOM Data Transport server or through the XCOMPLEX Admin Server, or
executed immediately.
Y
This request is queued for execution by the CA XCOM Data Transport server
or the XCOMPLEX Admin Server.
If the remote system is unavailable and the file transfer request is queued,
the transfer executes when the remote system becomes available. Queued
functions permit a higher degree of processing control. For example, queued
transfers can be prioritized or held from execution until they are manually
released.
N
This request is executed immediately.
Non-queued transfers must execute within a specified default timeout
duration (defined in the Default Options Table) or they are aborted.
Default: Y
34 User Guide
MVS Send Functions Menu
Local System Identification
Identifies the local system involved in a CA XCOM Data Transport transfer. The
terms in which the local system can be identified are described below.
Server
Specifies the APPLID or the STCIP of the CA XCOM Data Transport server on the
mainframe that is to start the transfer or the XCOMPLEX Admin Server that is to
schedule the transfer to an XCOMPLEX Worker Server. Required.
xxxxxxxx
Specifies the APPLID of the CA XCOM Data Transport server or XCOMPLEX
Admin Server. The APPLID can contain up to eight alphanumeric characters.
x1 . . . x63
Specifies the STCIP name or address of the CA XCOM Data Transport server
or XCOMPLEX Admin Server. The STCIP name can contain 1 to 63
alphanumeric characters and it must be one that has been defined to the
domain name server. The address can be in IPv4 or IPv6 notation. This is the
same STCIP that you can specify in your XCOMJOB PARM.
Notes:
■
Distributed processing provides the capability of displaying and controlling
the queues and the history log of a different CA XCOM Data Transport
mainframe system.
To display a list of queues:
1. Do one of the following:
–
Enter the APPLID or STCIP of the CA XCOM Data Transport server
whose queue you want to display or modify.
–
Enter the APPLID or STCIP of the XCOMPLEX Admin Server to display
the queues for all the XCOMPLEX Worker Servers connected to the
same XCOMPLEX Admin Server.
Note: You cannot modify queue information in this display.
2. Select Option 3, XCOM Operator Control.
■
By specifying a remote system's CA XCOM Data Transport APPLID or STCIP,
you can carry out third-party processing, which allows you, on the local
system, to initiate CA XCOM Data Transport requests between two remote
systems.
■
For more information about using this field for third-party-initiated file
transfers, see the LUSER parameter.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 35
MVS Send Functions Menu
Port
Specifies the IP port of the STCIP of the CA XCOM Data Transport server on the
mainframe that is to start the transfer or the XCOMPLEX Admin Server that is to
schedule the transfer to an XCOMPLEX Worker Server. Required.
nnnnn
Specifies the IP port of the CA XCOM Data Transport server or XCOMPLEX
Admin Server. The IP port can contain valid numeric values 1 through
65535. This is the same as the STCPORT that you can specify in your
XCOMJOB PARM.
Protocol
Specifies whether the Server field is the STCIP or the APPLID of the CA XCOM
Data Transport server on the mainframe that is to start the transfer or the
XCOMPLEX Admin Server that is to schedule the transfer to an XCOMPLEX
Worker Server. Required.
xxx
Valid values are SNA, TCP, and SSL.
If you specify SNA, then the Server field must be a one- to eight-character
entry conforming to the rules for VTAM APPLIDs.
If you specify TCP or SSL, the Server field must be a 1- to 64-character entry
conforming to the rules for a TCP/IP name or address. If the server listens to
a port other than 8044, specify the port address.
36 User Guide
Send MVS File To Another System Screen
Send MVS File To Another System Screen
The Send MVS File to Another System screen provides CA XCOM Data Transport
with the necessary information to transmit an MVS data set to a target file on a
remote system. The data set being sent must exist as a valid data set on the local
system, but does not have to be cataloged.
Note: This screen now accepts file names up to the maximum allowable size for
the Local File (255 characters) and Remote File (256 characters). So, depending
on the size of your screen, you may need to use PF7 and PF8 to view all fields on
the screen.
------------------------------------------------------------------------------08/04/08
CA XCOM Release r11.5 SP00
USER01
08.099
Send MVS File To Another System
11:21
------------------------------------------------------------------------------COMMAND ===>
Local System Identification
Server:
Transfer ID:
Local File:
USS -
TRUSTED (Y/N):
UMASK :
IP Name/Addr:
Remote File:
Port: 8049
LFILEDATA:
Execution Priority:
FILEDATA:
F2=SPLIT
F8=DOWN
F3=End
F9=SWAP
USSLRECL:
Port:
C
N
B
N
(Replaced with member name)
Secure Socket(SSL): NO
Checkpoint Count--------: 0
Compression Mode--------: YES
Pack Data Records(N/C/L): NO
Transfer User Data------:
System User Data--------:
---Remote System Information--User ID:
Tape (Y/N):
Password:
Domain:
Notify User:
Notify Level:
Volume:
Unit:
PFK 1/Help
3/End
F1=Help
F7=UP
(Binary/Text)
122.222.222.222
Remote file substitution char:
Program Library: NO
Create/Replace/Add (C/R/A)-------:
Record Separators (Y/N)----------:
EBCDIC/Binary/ASCII/VLR (E/B/A/V):
Truncate Record (Y/N)------------:
Code Table ----------------------:
Protocol: TCP
¦ ----Local System Information---¦:USER01
Tape (Y/N):
¦:
¦
¦:USER01
Notify Level:
¦:
Unit:
11/Hold 12/Alloc
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
Chapter 1: The Menu Interface (TSO/ISPF Panels) 37
Send MVS File To Another System Screen
Parameter Fields
This section describes the parameter fields for the Send MVS File to Another
System screen.
Local System Identification
Identifies the local system involved in a CA XCOM Data Transport transfer. The
terms in which the local system can be identified are described below.
Server
Specifies the APPLID or the STCIP of the CA XCOM Data Transport server on the
mainframe that is to start the transfer or the XCOMPLEX Admin Server that is to
schedule the transfer to an XCOMPLEX Worker Server. Required.
xxxxxxxx
Specifies the APPLID of the CA XCOM Data Transport server or XCOMPLEX
Admin Server. The APPLID can contain up to eight alphanumeric characters.
x1 . . . x63
Specifies the STCIP name or address of the CA XCOM Data Transport server
or XCOMPLEX Admin Server. The STCIP name can contain 1 to 63
alphanumeric characters and it must be one that has been defined to the
domain name server. The address can be in IPv4 or IPv6 notation. This is the
same STCIP that you can specify in your XCOMJOB PARM.
Port
Specifies the IP port of the STCIP of the CA XCOM Data Transport server on the
mainframe that is to start the transfer or the XCOMPLEX Admin Server that is to
schedule the transfer to an XCOMPLEX Worker Server. Required.
nnnnn
Specifies the IP port of the CA XCOM Data Transport server or XCOMPLEX
Admin Server. The IP port can contain valid numeric values 1 through
65535. This is the same as the STCPORT that you can specify in your
XCOMJOB PARM.
38 User Guide
Send MVS File To Another System Screen
Protocol
Specifies whether the Server field is the STCIP or the APPLID of the CA XCOM
Data Transport server on the mainframe that is to start the transfer or the
XCOMPLEX Admin Server that is to schedule the transfer to an XCOMPLEX
Worker Server. Required.
xxx
Valid values are SNA, TCP, and SSL.
If you specify SNA, then the Server field must be a one- to eight-character
entry conforming to the rules for VTAM APPLIDs.
If you specify TCP or SSL, the Server field must be a 1- to 64-character entry
conforming to the rules for a TCP/IP name or address. If the server listens to
a port other than 8044, specify the port address.
Transfer ID
Associates a descriptive identifier with this file transfer. It complements the
request number assigned by CA XCOM Data Transport to every locally initiated
transfer.
xxxxxxxxxx
Specifies up to ten alphanumeric or national characters identifying the file
transfer.
Note: The CA XCOM Data Transport transfer IDs form a sequence that starts
with 001 and is incremented by 1 for each transfer.
Default: Your TSO user ID (uuuuuuu) with a sequence number (nnn) appended,
that is, uuuuuuunnn.
TRUSTED (Y/N)
Specifies whether you can request a trusted transfer.
Y
Yes, you can request a trusted transfer.
N
No, you cannot request a trusted transfer.
Default: N
Chapter 1: The Menu Interface (TSO/ISPF Panels) 39
Send MVS File To Another System Screen
Execution Priority
Specifies the execution priority for this request.
1 to 255
Specifies a priority to provide efficient scheduling in a busy transfer
environment. 1 is the lowest execution priority.
Note: When multiple CA XCOM Data Transport transmissions are executing
concurrently, transfers with higher execution priorities receive preferential
service. In a busy CA XCOM Data Transport environment, unless you have
compelling reasons for not doing so, enhance processing efficiency by giving
short file transfers a higher priority value than long-running transmissions.
Default: 16
40 User Guide
Send MVS File To Another System Screen
Local File
Indicates the name of the local data set being transferred. Required.
Up to 56 alphanumeric characters (for a non-USS file)
Specifies up to 56 characters consisting of the following:
■
A 1- to 44-character data set name
■
An optional member name enclosed in parentheses
■
Optional single quotation marks (apostrophes) to enclose the data set
Your TSO profile prefix is inserted at the beginning of this entry unless the
entry is enclosed in single apostrophes. If the TSO profile is set to NOPREFIX,
nothing is inserted.
Notes:
■
Use an asterisk to send multiple members of a partitioned data set.
Specifying an asterisk for the member name sends all members of a
PDS, for example, SURVEYS(*). To send all members beginning with a
specific prefix, specify this prefix followed by an asterisk. For example,
NAMES.PDS(AL*) requests that members AL, ALEX, and ALICE all be
transferred. The asterisk must be the last character before the right
parenthesis.
■
If no member name is entered for a partitioned data set, a Member
Selection List panel is displayed, allowing the selection of one or more
members for transfer. For more information, see Remote File and
Member Selection List in this chapter.
1 to 255 characters (for a USS file)
Specifies the USS local data set involved in a file transfer. Contains up to 255
characters consisting of the following:
■
/ (the first character of the data set name)
■
A 1- to 254-character data set name
Notes:
■
One or more wildcard characters (*) can be used if transferring to IBM
mainframe systems, to Windows systems, or to UNIX or Linux systems.
■
The transfer of USS files is supported only between systems running CA
XCOM Data Transport r11.5.
Default: The last data set name entered
Chapter 1: The Menu Interface (TSO/ISPF Panels) 41
Send MVS File To Another System Screen
USS Examples
Note: USS files can have up to 255 characters.
LFILE=/u/users/xcom/*
Transfer ALL files.
LFILE=/u/users/xcom/m*
Transfer ALL files starting with an m.
LFILE=/u/users/xcom/*m
Transfer ALL files ending with an m.
LFILE=/u/users/xcom/m*m
Transfer ALL files starting with an m and ending with an m.
LFILE=/u/users/xcom/m*y*m
Transfer ALL files starting with an m, ending with an m and containing a y.
LFILE=/u/users/xcom/m*you*
Transfer ALL files starting with an m and containing the characters you in
succession.
LFILE=/u/users/xcom/m*y*o*u*
Transfer ALL files starting with an m and containing the characters y and o
and u (in order, but not in succession).
42 User Guide
Send MVS File To Another System Screen
UMASK
The file permissions to be removed from the XCOM default file or directory
permissions for USS files or directories. UMASK is used only when a file or
directory is being created.
Range: 000 to 777
Default: 022
On z/OS systems the XCOM default file permission is 666, which means the
following:
■
Allow the owner of the file to read and write the file.
■
Allow members of the owner's group to read and write the file.
■
Allow all other users read and write the file.
File permissions on USS files are implemented the same way as file permissions
are on UNIX systems. The three basic permissions for each of the categories
listed above are read, write, and execute, commonly seen as rwx rwx rwx.
If each of these characters (r, w, x) is considered as a bit, then the possible value
ranges are as follows:
■
000 to 111 in binary
■
0 to 7 in hex
So the default permissions of 666 (110 110 110) mean allow read and write to
everyone, but not execute.
The UMASK value identifies the permissions that you want to remove from the
default (666). If you remove 022 (000 010 010) from 666 then what remains is
644, which means the following:
■
Allow the owner of the file to read and write the file.
■
Allow members of the owner's group and all other users to read, but not
write.
Notes:
■
For directories—CA XCOM Data Transport sets permissions for a created
directory to 7xx, no matter what owner UMASK value was specified. Group
and other permissions, represented by xx, represent the permissions with
the specified UMASK removed.
■
For files – While the file is being transferred, CA XCOM Data Transport sets
permissions for a created file to 6xx, where xx represents the permissions
with the specified UMASK removed. After the transfer has been completed,
CA XCOM Data Transport sets the owner permission with the specified
UMASK removed.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 43
Send MVS File To Another System Screen
LFILEDATA
Indicates how the local USS file is to be allocated.
B
Binary
T
Text
If you do not specify a value for LFILEDATA, then the allocation is determined
based on the CODE= specification, as determined by the value of the
EBCDIC/Binary/ASCII/VLR(E/B/A/V) field, as follows:
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=B, then the file is allocated and
processed as binary data.
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=E, the type of allocation and
processing depends on the value of LFILEDATA, as follows:
–
If you do not specify LFILEDATA=B, then the file is allocated as a text file
and processed as an EBCDIC text file.
–
If you do specify LFILEDATA=B, then the file is allocated as a binary file,
but processed as an EBCDIC file.
Important! If you do specify LFILEDATA=B, then you need to specify a value for
USSLRECL, to tell CA XCOM Data Transport how many bytes there are in each
logical record.
44 User Guide
Send MVS File To Another System Screen
FILEDATA
Indicates how a remote USS file is to be allocated.
B
Binary
T
Text
If you do not specify a value for FILEDATA, then the allocation is determined
based on the CODE= specification, as determined by the value of the
EBCDIC/Binary/ASCII/VLR(E/B/A/V) field, as follows:
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=B, then the file is allocated and
processed as binary data.
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=E, the type of allocation and
processing depends on the value of FILEDATA, as follows:
–
If you do not specify FILEDATA=B, then the file is allocated as a text file
and processed as an EBCDIC text file.
–
If you do specify FILEDATA=B, then the file is allocated as a binary file,
but processed as an EBCDIC file.
Important! If you do specify FILEDATA=B, then you need to specify a value for
LRECL, to tell CA XCOM Data Transport how many bytes there are in each logical
record.
USSLRECL
If LFILEDATA or FILEDATA is set to B (binary), this value tells CA XCOM Data
Transport how many bytes there are in each logical record.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 45
Send MVS File To Another System Screen
Remote System Identification (= IP Name/Addr, SNA LU Name, XCOM Group Name, XCOM List
Name, Login User Name)
Indicates the remote destination where the file is to be sent.
SNA destination name
Specifies the SNA name of the remote system where the transfer is directed
(one to eight characters).
Group name
Specifies the name of a destination member defined in the CA XCOM Data
Transport Control Library. This member can contain a single SNA LU name or
TCP/IP name or address or up to 16 SNA LU names (one to eight characters).
List name
Specifies a list of SNA LU names and TCP/IP addresses (one to eight
characters).
Login user name
Specifies a user ID on the source system whose access privileges are used to
execute the file transfer (one to eight characters).
IP destination name
Specifies the IP destination name of the remote system where the transfer is
directed (1 to 63 characters).
Note: The contents of the Remote System Identification field reflect the choices
made in the Primary Option Menu screen. The first item in the field identifies one
of the CA XCOM Data Transport destination types, that is, the first item is one of
the expressions IP Name/Addr, SNA LU Name, XCOM Group Name, XCOM List
Name, or Login User Name, depending on what was entered as the destination
type on the Primary Option Menu screen. If the first item in the field is IP
Name/Addr, another field, (IP) Port, appears to the right on the same line. The
second item in the Remote System Identification field is a specific destination
name (or a number, in the case of an IP address). You cannot change the
destination type (for example, SNA LU Name to XCOM Group Name) but you can
change the specific destination name or number.
Default: The remote destination specified on the Primary Option Menu
46 User Guide
Send MVS File To Another System Screen
Port
Specifies the number of the IP port where CA XCOM Data Transport listens at the
remote system.
Note: This field is displayed on the screen only when an IP name or address is
referenced in the Remote System Identification field.
1 to 65535
Identifies the IP port monitored (listened to) by CA XCOM Data Transport at
the remote system.
Note: If this field is left blank, the port value specified in the CA XCOM Data
Transport Default Options Table is used.
Dropsess
Specifies whether a session with a CA XCOM Data Transport partner should be
terminated at the completion of a file transfer. Optional.
Note: This field is displayed only when an SNA type of partner is referenced in
the Remote System Identification field.
Y
Indicates that the session is to be terminated after the transfer has
completed.
N
Indicates that the session is to be retained after the transfer has completed.
Q
Indicates that the session is to be terminated if there are no additional
transfer requests for the current CA XCOM Data Transport partner.
Default: N
Chapter 1: The Menu Interface (TSO/ISPF Panels) 47
Send MVS File To Another System Screen
Remote File
Indicates the name of the file on the remote system receiving the data being
transferred. Required.
Up to 256 alphanumeric characters
Specifies the file name that should receive the data being transferred. The
maximum allowable length of the file name varies, depending on the remote
partner. The following limits apply for MVS and USS files:
■
Up to 56 alphanumeric characters (for an MVS file)
■
Up to 255 alphanumeric characters (for a USS file)
Up to 56 alphanumeric characters (for an MVS file)
Specifies up to 56 characters consisting of the following:
■
A 1- to 44-character data set name
■
An optional member name enclosed in parentheses
■
Optional single quotation marks (apostrophes) to enclose the data set
Your TSO profile prefix is inserted at the beginning of this entry unless the
entry is enclosed in single apostrophes. If the TSO profile is set to NOPREFIX,
nothing is inserted.
Notes:
48 User Guide
■
Use an asterisk to send multiple members of a partitioned data set.
Specifying an asterisk for the member name sends all members of a
PDS, for example, SURVEYS(*). To send all members beginning with a
specific prefix, specify this prefix followed by an asterisk. For example,
NAMES.PDS(AL*) requests that members AL, ALEX, and ALICE all be
transferred. The asterisk must be the last character before the right
parenthesis.
■
During the generation of a file transfer request, CA XCOM Data Transport
successively replaces each asterisk (*) in a Remote File Name with a
name you have selected from the Member Selection List. When CA
XCOM Data Transport finds no other special character in a Remote File
Name, it appends the name (within parentheses) of each selected
member to the Remote File Name. You can arrange for CA XCOM Data
Transport to avoid the latter procedure and treat such a file as
sequential. To do this, you must select the ALLOC function (PF12/24)
and set the Directory Blocks entry to zero.
■
In the OpenVMS environment, brackets ([ ]) are used to indicate the
directory in a complete file name specification. However, some EBCDIC
environment keyboards do not provide brackets. In such cases, use
braces ({ }) instead, because CA XCOM Data Transport converts the
braces to brackets.
Send MVS File To Another System Screen
■
If the remote file name includes embedded spaces in the file name,
enclose the FILE parameter value in either single or double quotes. For
example, to send to the directory c:\My Documents on a Windows
partner, use the following format:
FILE='c:\My Documents\test.txt'
1 to 255 characters (for a USS file)
Specifies up to 255 characters consisting of the following:
■
/ (the first character of the data set name)
■
A 1- to 254-character data set name
Notes:
■
One or more wildcard characters (*) can be used if transferring to IBM
mainframe systems, to Windows systems, or to UNIX systems.
■
The transfer of USS files is supported only between systems running CA
XCOM Data Transport r11.5.
USS Example
FILE=/u/users/xcom/source/*.c
Transfer ALL files and save them with the suffix .c.
Remote File Substitution Character
Specifies a character that is used in a Remote File Name to establish a schema
for generating a unique file name for each member involved in a partitioned data
set (PDS) transfer. The unique file name is derived by replacing the substitution
character in the Remote File Name schema with the PDS member names. CA
XCOM Data Transport generates a separate transfer request for each selected
PDS member. The PDS members to be transferred are selected from a member
list, which is displayed when a PDS name is entered without any member name
in the Local File Name field. (For information about how to select a PDS member
from a member list, see Member Selection List in this chapter.)
Chapter 1: The Menu Interface (TSO/ISPF Panels) 49
Send MVS File To Another System Screen
Example 1
For example, assume that from the partitioned data set XCOM.PDS the members
A, B and C need to be transferred to a PC destination, where they are to be stored
in the (remote) files C:\A.DAT, C:\B.DAT and C:\C.DAT, and that the at sign (@)
is used as the remote file substitution character. To accomplish this task, you
need to specify XCOM.PDS in the Local File Name field, @ in the Remote File
Substitution Character field and C:\@.DAT as the file name schema in the
Remote File Name field.
When the XCOM.PDS members to be transferred have been selected from the
member list CA XCOM Data Transport generates the following transfer requests:
Local File Name
Remote File Name Schema
and Substitution Character
XCOM.PDS(A)
XCOM.PDS(B)
Remote File Name
C:\A.DAT
\
XCOM.PDS(C)
C:\B.DAT
C:\C.DAT
Example 2
In the following example, the schema for generating remote file names is based
on a partitioned data set:
Local File Name
Remote File Name Schema
and Substitution Character
Remote File Name
XCOM.PDS(A)
XCOM.PDS.OUT(A)
XCOM.PDS(B)
XCOM.PDS.OUT(B)
XCOM.PDS(C)
XCOM.PDS.OUT(C)
Note: If the remote file name schema contains multiple occurrences of the
Remote File Substitution Character, only the first occurrence of the Substitution
Character is used in the generation of Remote File Names
50 User Guide
Send MVS File To Another System Screen
Program Library
Informs CA XCOM Data Transport how to handle the file that is being transferred
to the remote system.
YES
Tells CA XCOM Data Transport to transfer the file as a PDSE program library.
This parameter is the equivalent to PROGLIB=YES in SYSIN01.
NO
Tells CA XCOM Data Transport that the file does not involve a PDSE program
library and should be handled as a regular file transfer. Select NO for PDSEs
that are not program libraries.
Note: There is no default value for this parameter. Unless YES is specified, the
file is handled as a regular transfer.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 51
Send MVS File To Another System Screen
Create/Replace/Add
Informs CA XCOM Data Transport how to handle the file that is receiving the
transferred data on the remote system. This is the file whose name appears in
the Remote File Name field.
C(reate)
CA XCOM Data Transport attempts to create (allocate) a new file on the
remote system. For information concerning the provision of additional
allocation parameters for this new file, see File Allocation Information Screen
in this chapter.
A(dd)
CA XCOM Data Transport adds the records being transferred to the end of an
existing file on the remote system.
For an indexed file, the keys must not match those in the file on the remote
system or CA XCOM Data Transport terminates the transfer with an error.
R(eplace)
CA XCOM Data Transport replaces the contents of a file on the remote
system with the data being transferred.
If the file is indexed, the records with matching keys are replaced and those
with non-matching keys are added.
Notes:
■
When transferring a partitioned data set, specify C only if the PDS itself is
being created. If a new member is being sent to an existing PDS, specify R
for Replace.
■
If you do not override the default value and the file already exists on the
target system, the transfer terminates with an error.
Default: C(reate)
52 User Guide
Send MVS File To Another System Screen
Record Separators
Specifies whether CA XCOM Data Transport adds a record separator to delimit
logical records.
Note: Skip this field unless you are sending data to an ASCII system.
Y
CA XCOM Data Transport adds a record separator, such as a line feed and
carriage return, to delimit logical records.
N
CA XCOM Data Transport does not add record separators.
Default: N
EBCDIC/Binary/ASCII/VLR
Indicates the type of transferred data. The receiving system is responsible for
performing any necessary conversion.
B
Indicates binary data.
E
Indicates that the data is in EBCDIC code.
A
Indicates that the data is in ASCII code.
V
Indicates that the data is in BINARY code and that the record descriptor word
is preserved.
Default: E
Chapter 1: The Menu Interface (TSO/ISPF Panels) 53
Send MVS File To Another System Screen
Truncate Record
Specifies how records exceeding the maximum logical record length (LRECL) are
to be handled.
Y
Specifies that records larger than the maximum LRECL are to be truncated to
the maximum record length.
N
Specifies that CA XCOM Data Transport is to terminate the file transfer upon
receiving a record larger than the maximum LRECL.
Notes:
■
This field is supported only by the CA XCOM Data Transport mainframe
products: CA XCOM Data Transport for z/OS, CA XCOM Data Transport for
VSE, and CA XCOM Data Transport for VM.
■
When a record is truncated, the data not within the LRECL limit is lost.
Default: N
Code Table
This is a three-character alphanumeric field used for specifying the translation
table to be used by the remote partner for this particular transfer only. This field
is applicable only for transfers to CA XCOM Data Transport UNIX or Windows
partners, and only if their INTERNAL_CONVERSION_TABLES=NO.
1 to 3 (bytes)
Specifies up to three alphanumeric characters, identifying the code table to
be used by the remote partner.
Secure Socket (SSL)
Informs CA XCOM Data Transport how to handle the security of the transfer to
the remote system.
YES
Tells CA XCOM Data Transport to use OpenSSL for the transfer of the file and
that it must connect to a SSL port on the remote partner.
NO
Tells CA XCOM Data Transport that the file does not require a secure
connection and should be handled as a regular file transfer.
54 User Guide
Send MVS File To Another System Screen
Checkpoint Count
Specifies the interval at which CA XCOM Data Transport takes a checkpoint (to
be used to restart a suspended or failed file transfer). The length of the
checkpoint interval is measured in terms of a number of blocks.
0
Specifies that CA XCOM Data Transport is to take no checkpoints.
1 to 9999
Specifies the number of blocks that form a checkpoint interval. A checkpoint
is taken whenever the specified number of blocks has been transferred.
Note: If record packing is not used, 1 record = 1 block.
Notes:
■
Each time a checkpoint is taken, the output buffers on the receiving system
are written to the disk. Making the checkpoint interval too short slows down
file transfers; making it too long increases the risk of data loss. It is
recommended that the Checkpoint Count be set to at least 1000. On Token
Ring, Ethernet, and other high-speed networks, the Checkpoint Count
should be set to the highest allowable value.
■
If the receiving system is z/OS or VSE, the Checkpoint Count should be a
multiple of the blocking factor. For example, if the DCB attributes are
RECFM=FB LRECL=80 BLKSIZE=8000, the Checkpoint Count should be a
multiple of 100.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 55
Send MVS File To Another System Screen
Compression Mode
Specifies whether CA XCOM Data Transport compresses the data being
transferred and decompresses it on the remote system. Compressing the data
decreases the transmission time on lower-speed lines.
YES
Provides Run-Length Encoding (RLE) for blanks and binary zeros only.
NO
No data compression.
RLE
Provides complete Run-Length Encoding for all characters.
COMPACT
Provides full RLE (as in RLE above) plus a byte compaction scheme that is
suitable for uppercase English text.
COMPACTL
Same as COMPACT above, only the compaction scheme is most beneficial for
lowercase English text.
LZSMALL
Lempel-Ziv 77 compression with a small memory allocation scheme.
LZMEDIUM
Lempel-Ziv 77 compression with a medium memory allocation scheme.
LZLARGE
Lempel-Ziv 77 compression with a large memory allocation scheme.
HUFFMAN
Greater compression than RLE but not as much as the Lempel-Ziv 77 modes.
LZRW3
General-purpose algorithm that runs fast and gives reasonable compression.
ZLIB(n)
Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and
LZLARGE. The n value can be 1 through 9.
Note: Not all compression modes are supported on all platforms.
Default: YES
56 User Guide
Send MVS File To Another System Screen
Pack Data Records
Specifies whether record packing is to be used on a file transfer.
NO
Specifies that no record packing is used. The data are sent unblocked.
LENGTH
Specifies that the records are to be packed into fixed-size data transfer
blocks. Each record begins with a 2-byte long prefix that indicates the length
of the record and determines how many records can be packed into a block.
The default block size is 2K but it can be increased to 31K by using the
MAXPACK parameter in the CA XCOM Data Transport Default Options Table
or in the CA XCOM Data Transport control library member.
When transferring a text file to a partner that supports record separators (for
example, CRLF (0D0A) on Windows, and LF (0A) on UNIX), record
separators are inserted. No separators are inserted in binary files transferred
with PACK=LENGTH.
CRLF
Specifies that the records are to be packed into blocks separated by a
C(arriage)R(eturn)L(ine)F(eed) byte sequence.
Notes:
■
PACK=LENGTH with MAXPACK=31744 should be selected when using CA
XCOM Data Transport over TCP/IP. If PACK=LENGTH is coded, then you
must also code RECSEP=NO.
■
Platforms that understand PACK=LENGTH are IBM's AS/400, UNIX-based
systems, and z/OS systems. See the appropriate documentation for the
platform to see if this value is supported.
■
CRLF packing can be used with text files only. It is also used when
communicating with older releases of CA XCOM Data Transport on PC-DOS
and OS/2.
Transfer User Data
Allows you to specify up to 10 bytes of any type of data to be associated with the
transfer request. This data is sent to all user exits and written to the history file
upon completion of the file transfer. For further information on how to use this
user data with the CA XCOM Data Transport user exits, see the description of
TDUDATA in General SYSIN01 Parameters in the chapter ―The Batch Interface.‖
xxxxxxxxxx
One to ten alphanumeric characters of any type of data to be associated with
a transfer request.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 57
Send MVS File To Another System Screen
System User Data
Allows the specification of transfer-dependent user data. This data is available to
user exits in the RRDSUSER field of the RRDS data area (mapped by the
RRDDSECT macro) while the transfer is pending or active. The RRDSUSER field is
defined by HDRDSECT within RRDDSECT.
1 to 10 (bytes)
Specifies up to 10 bytes of data available to user exits during a file transfer.
Remote System Information
The Remote System Information fields of the Send MVS File To Another System
screen pertain to the remote or non-initiating CA XCOM Data Transport partner.
User ID
Identifies the user ID under whose set of resource access privileges the file
transfer is to execute on the remote system. It should be a user ID known to the
security system on that system.
xxxxxxxxxxxx
Specifies up to 12 alphanumeric characters representing a user ID whose
access privileges on the remote system are used for executing the transfer.
Notes:
If the remote system does not perform security checking, you can skip this and
the Remote Password parameter.
To send a blank parameter value to the remote system, enter ― ‖, inserting at
least one blank space between the quotation marks. Do this when the source
system supplies its own default value for the user ID under whose access
privileges the file transfer is to execute on the source system.
Default: None
58 User Guide
Send MVS File To Another System Screen
Tape
Indicates whether the remote data set resides on magnetic tape.
Y
Specifies that the remote data set resides on magnetic tape.
N
Specifies that the remote data set does not reside on magnetic tape.
Note: If you enter Y in the Tape field, a new screen - MVS Extended Tape
Parameter Entry (see next section) - is displayed allowing tape-related
information to be specified.
Default: N
Password
Identifies the password associated with the remote user ID.
Up to 31 alphanumeric characters
Specifies up to 31 alphanumeric characters representing the user password
associated with the user ID.
Notes:
■
This field is not displayed.
■
If the remote system is running IBM RACF, CA ACF2, or CA Top Secret, this
parameter can be used to change the password on the remote system. To do
this, use the following format:
oldpassword/newpassword
Domain
Identifies the Windows domain server used to validate the remote user ID and
password.
Up to 15 alphanumeric characters
Specifies up to 15 alphanumeric characters representing the domain server
used to validate the remote user ID and password.
Note: Can only be used for transfers running under Windows.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 59
Send MVS File To Another System Screen
Notify User
Identifies the user on the remote system CA XCOM Data Transport is to notify
when the transfer completes.
LOG
LOG requests that the main operator on the remote system be notified.
If the remote system is z/OS, a WTO macro is issued by CA XCOM Data
Transport.
On an IBM iSeries or HP OpenVMS system, the operator console is notified.
user_id
If any value but LOG is given, CA XCOM Data Transport interprets this as a
specific user ID on the remote system. If that user is not logged on when the
transfer completes, the message is displayed the next time the user logs on.
Default: LOG
Remote Notify Level
Specifies the remote notification level for transfers initiated from the CA XCOM
for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
60 User Guide
Send MVS File To Another System Screen
Volume
Indicates the volume on the remote system on which the file is to be created (or
resides, for existing non-cataloged files).
xxxxxxxxxx
Specifies the volume on the remote system on which the file is to be created
(or resides, for existing non-cataloged files). This value can be up to 10
alphanumeric characters.
Notes:
■
If a data set does not exist and the File Allocation Information screen is used,
the parameters of this screen are used.
■
If a data set does not exist and the File Allocation Information screen is not
used, system-wide defaults (specified in the CA XCOM Data Transport
Default Options Table) are used.
Default: Catalog information is used.
Unit
Indicates the unit name on the remote system on which the file is to be created
(or resides, for existing non-cataloged files).
xxxxxxxx
Specifies the unit name on the remote system on which the file is to be
created (or resides, for existing non-cataloged files). This value can be up to
eight alphanumeric characters, or *INDEX when transferring to an IBM
iSeries system.
Notes:
■
If a data set does not exist and the File Allocation Information screen is used,
the parameters of this screen are used.
■
If a data set does not exist and the File Allocation Information screen is not
used, system-wide defaults (specified in the CA XCOM Data Transport
Default Options Table) are used.
Default: Catalog information is used.
Local System Information
The Local System Information fields of the Send MVS File To Another System
screen pertain to the local or transfer-initiating CA XCOM Data Transport system.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 61
Send MVS File To Another System Screen
User ID
Identifies the user ID under whose set of resource access privileges this file
transfer is to execute on the source system.
xxxxxxxx
Specifies up to eight characters representing the user ID under whose set of
resource access privileges this file transfer is to execute on the source
system.
Notes:
■
This parameter is ignored by the local security software system.
■
For conventional (that is, non-third-party) file transfers, this parameter is
used to identify the user that initiated the transfer. This is useful when
performing operator tracking and control functions through the CA XCOM
Data Transport Operator Control screens.
■
The primary use of this parameter is for third-party processing. For example,
a CA XCOM Data Transport node in New York can request that a CA XCOM
Data Transport node in Los Angeles send a file to a CA XCOM Data Transport
node in Chicago.
Default: TSO user ID
Tape
Indicates whether the local data set resides on magnetic tape.
Y
Specifies that the local data set resides on magnetic tape.
N
Specifies that the local data set does not reside on magnetic tape.
Note: If you enter Y in the Tape field, a new screen - MVS Extended Tape
Parameter Entry (see next section) - is displayed allowing tape-related
information to be specified.
Default: N
Password
Specifies the password associated with the local User ID parameter.
Up to 31 alphanumeric characters
Specifies up to 31 characters representing the password associated with the
local user ID parameter.
Note: This field does not display.
62 User Guide
Send MVS File To Another System Screen
Notify User
Specifies the local system user CA XCOM Data Transport is to notify when the
transfer completes.
LOG
LOG requests that the main operator on the local system be notified.
If the local system is z/OS, CA XCOM Data Transport issues a WTO macro.
On an IBM iSeries or HP OpenVMS system, the operator console is notified.
user_id
If any value but LOG is given, CA XCOM Data Transport interprets this as a
specific user ID on the local system. If that user is not logged on when the
transfer completes, the message is displayed the next time the user logs on.
Default: LOG
Notify Level
Specifies the local notification level for transfers initiated from the CA XCOM Data
Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
Volume
Specifies the name of the volume serial where the local data set can be found.
Up to six alphanumeric characters
Specifies up to six alphanumeric characters representing the name of the
volume serial where the local data set can be found.
Notes:
■
Used in conjunction with the local UNIT parameter.
■
The value must be the name of a volume currently mounted on this system,
or problems in allocation may occur.
Default: Catalog information is used.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 63
MVS Extended Tape Parameter Entry
Unit
Specifies the unit name to be used in locating the local data set.
Up to eight alphanumeric characters
Specifies the unit name to be used in locating the local data set.
Note: Used in conjunction with the local VOLUME parameter.
Default: Catalog information is used.
MVS Extended Tape Parameter Entry
The MVS Extended Tape Parameter Entry screen is used to enter information
relating to the use of magnetic tape in transfer processing.
Screen
To display the MVS Extended Tape Parameter Entry screen
Type Y in the Tape field on the Send MVS File To Another System screen
(described in the preceding section) or the Receive File From Another System
screen (described later in this chapter) and press Enter.
A sample MVS Extended Tape Parameter Entry screen follows:
-----------------------------------------------------------------------------08/04/08
CA XCOM Release r11.5 SP00
USER01
08.099
MVS Extended Tape Parameter Entry
11:34
-----------------------------------------------------------------------------Tape:
File Sequence:
Label Type:
Unit Count:
Volume Sequence:
Remote
NO
Local
NO
(YES¦NO)
(nnnn) range: 1 to 9999
(SL¦NL¦NSL¦SUL¦BLP¦LTM¦AL¦AUL)
(nn)
range: 1 to 20
(nnn) range: 1 to 255
Output Tape Parameters:
Density:
Volume Count:
Expiration Date:
(1¦2¦3¦4)
(nnn) range: 1 to 255
(yyddd¦yyyy/ddd¦+nnnn)
(note - +nnnn is retention period in days)
-----------------------------------------------------------------------------PFK 1/Help
3/End
COMMANDS ===>
F1=Help
F2=SPLIT
F7=UP
F8=DOWN
64 User Guide
F3=End
F9=SWAP
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
MVS Extended Tape Parameter Entry
Parameter Fields
This section describes the parameter fields of the MVS Extended Tape Parameter
Entry screen.
Tape
Specifies whether the remote/local data set resides on tape.
YES
Indicates that the data set resides on tape.
NO
Indicates that the data set does not reside on tape.
File Sequence
Specifies the sequence number of the data set on tape.
1 to 9999999
Specifies the sequence number of the data set on tape.
Label Type
Specifies the type of processing to be done on the tape data set.
SL
Specifies the tape processing type SL.
NL
Specifies the tape processing type NL.
NSL
Specifies the tape processing type NSL.
SUL
Specifies the tape processing type SUL.
BLP
Specifies the tape processing type BLP.
LTM
Specifies the tape processing type LTM.
AL
Specifies the tape processing type AL.
AUL
Specifies the tape processing type AUL.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 65
MVS Extended Tape Parameter Entry
Unit Count
Specifies the number of units to be allocated on the system.
1 to 20
Specifies the number of the units to be allocated on the system.
Volume Sequence
Specifies the sequence number of the first volume of a multivolume data set to
be used.
1 to 255
Specifies the sequence number of the first volume of a multivolume data set
to be used.
Density
Specifies the density to be used in creating a tape.
1 to 4
Specifies the density to be used in creating a tape.
Volume Count
Specifies the number of volumes to be used in processing a multivolume output
tape data set.
1 to 255
Specifies the number of volumes to be used in processing a multivolume
output tape data set.
66 User Guide
File Allocation Information Screen
Expiration Date
Specifies the date when the data set is to be purged from tape.
yyddd
Specifies the expiration date of the tape data set. The expiration date is
indicated with a two-digit designation for the year and a three-digit
designation for the day of the year. For example, the expiration date 09021
represents year 2009 and the 21st day of that year.
yyyy/ddd
Specifies the expiration date of the tape data set. The expiration date is
indicated with a four-digit designation for the year and a three-digit
designation for the day of the year. For example, the expiration date
2009/021 represents year 2009 and the 21st day of that year.
+1 to +9999
Specifies the number of days the data set is to be retained. For example,
+30 means that the data set is to be kept for 30 days before being purged
from tape.
File Allocation Information Screen
The File Allocation Information screen is used to specify allocation parameters
for a new data set. The parameter available on the File Allocation Information
screen corresponds to standard z/OS data set allocation definitions.
This screen is automatically displayed if a non-existent file is specified in the
Local File Name field of the Receive File From Another System screen. It can also
be invoked by pressing the PF12 key on the Receive File From Another System
screen.
If the remote system is a z/OS system and the file specified in the Remote File
Name field on the Send MVS File to Another System screen does not exist, press
the PF12 key to invoke the File Allocation Information Screen. If the Remote File
Name field is blank, the name in the Local File Name field is used as the Remote
File Name.
When the File Allocation Information screen is called from the Send MVS File To
Another System screen, any allocation parameters set on it describe the file to
be created on the remote system (the target of the send operation). When the
File Allocation Information screen is called from the Receive File From Another
System screen, any allocation parameters set on it describe the file to be created
on the system initiating the receive operation.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 67
File Allocation Information Screen
Parameter Defaults
The defaults for the allocation parameters have three different sources:
■
If the data set already exists on the local system and the File Allocation
Information screen is or is not used, the defaults come from catalog
information.
■
If the data set does not exist on the local system and the File Allocation
Information screen is used, the defaults come from the parameter fields of
the Send MVS File To Another System screen.
■
If the data set does not exist and the File Allocation Information screen is not
used, the defaults come from the CA XCOM Data Transport Default Options
Table.
Supported File Types
CA XCOM Data Transport supports the creation of partitioned data sets and
generation data groups. For more information, see the chapter ―Processing
Different File Types.‖
68 User Guide
File Allocation Information Screen
Screen
A sample File Allocation Information screen follows:
08/04/08
CA XCOM Release r11.5 SP00
USER01
08.099
File Allocation Information
13:50
-----------------------------------------------------------------------COMMAND ===>
Data set Name: NA1KT50.PROG(C)
Volume
===>
(Blank for authorized default volume)
Unit
===>
(Generic group name or unit address)
Space Units
===>
(BLKS, TRKS, or CYLS)
Primary Quantity
===>
(In above units)
Secondary Quantity ===>
(In above units)
Directory Blocks
===>
(Zero for sequential data set)
Record Format
===>
Record Length
===>
Block Size
===>
Data Class
===>
(Blank for default data class)
Management Class
===>
(Blank for default management class)
Storage Class
===>
(Blank for default storage class)
Dataset Name Type ===>
(LIBRARY, PDS, or blank)
Release
===>
(Yes to release unused DASD space)
-----------------------------------------------------------------------PFK 1/Help
3/End
11/Hold
F1=Help
F7=UP
F2=SPLIT
F8=DOWN
F3=End
F9=SWAP
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
Parameter Fields
This section describes the parameter fields of the File Allocation Information
screen .
Data Set Name
Indicates the name of the new data set being created. This is a protected field
and retains the value set in the previous screen.
Up to 256 alphanumeric characters
Specifies the name of the new data set being created.
Volume Serial
Up to six alphanumeric characters
Specifies the volume on which the new data set should be allocated.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 69
File Allocation Information Screen
Generic Unit
Up to eight alphanumeric characters
Specifies the generic unit name of a group of volumes on which the new data
set should be allocated.
Space Units
BLKS, TRKS, or CYLS
Specifies whether the data set should be allocated in blocks, tracks, or
cylinders.
Primary Quantity
Up to six numeric characters
Specifies the initial allocation request in the above space units.
Secondary Quantity
Up to six numeric characters
Specifies the secondary allocation request in the above space units.
Directory Blocks
This parameter is used only for partitioned data sets.
Up to six numeric characters
Specifies the number of directory blocks. Specify 0 for sequential data sets.
70 User Guide
File Allocation Information Screen
Record Format
Determines the record format associated with the data set to be allocated.
F
Fixed
FA
Fixed ASA
FB
Fixed Blocked
FBA
Fixed Blocked ASA
FBM
Fixed Blocked Machine
FBS
Fixed Blocked Standard
V
Variable
VA
Variable ASA
VB
Variable Blocked
VBA
Variable Blocked ASA
VBM
Variable Blocked Machine
VBS
Variable Blocked Spanned
VS
Variable Spanned
U
Undefined
Chapter 1: The Menu Interface (TSO/ISPF Panels) 71
File Allocation Information Screen
Record Length
Up to seven numeric characters
Defines the logical record length of the file.
Block Size
Up to six numeric characters
Defines the block size of the file.
Data Class
Specifies the name of the data class to use when allocating a new SMS-managed
data set.
xxxxxxxx
Specifies the one- to eight-character data class name to use when allocating
a new SMS-managed data set.
Note: This parameter applies only to mainframe SMS data sets.
Default: None
Management Class
Specifies the name of the management class to use when allocating a new
SMS-managed data set.
xxxxxxxx
Specifies the one- to eight-character management class name to use when
allocating a new SMS-managed data set.
Note: This parameter applies only to mainframe SMS data sets.
Default: None
Storage Class
Specifies the name of the storage class for a new SMS-managed data set.
xxxxxxxx
Specifies the one- to eight-character storage class name to use when
allocating a new SMS-managed data set.
Note: This parameter applies only to mainframe SMS data sets.
Default: None
72 User Guide
File Allocation Information Screen
Dataset Name Type
Specifies the data set definition.
Note: This parameter applies only to mainframe SMS data sets.
LIBRARY
Defines a PDSE.
PDS
Defines a partitioned data set.
<blank>
Defines a partitioned or sequential data set based on the data set
characteristics entered.
Note: These values are IBM standards for SMS processing.
Range: One to eight characters
Default: None
Release
Specifies whether the remote partner is to release unused DASD space when
creating a new file.
YES
The remote partner is to release unused DASD space.
The unused DASD space that is specified for the transfer is released when
the file is closed at the end of the transfer.
NO
The remote partner is not to release unused DASD space.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 73
Send Report To Another System Screen
Send Report To Another System Screen
The Send Report To Another System screen is used to submit a z/OS data set for
printing on a remote system. The data set being sent must exist as a valid
cataloged data set on the sending system. The file is sent with embedded control
characters (for example, ASA, Machine) retained.
------------------------------------------------------------------------------08/04/08
CA XCOM Release r11.5 SP00
USER01
08.099
Send Report To Another System
11:24
------------------------- CA XCOM Server: XCOMABC ----------------------------COMMAND ===>
Transfer ID:
TRUSTED (Y/N):
Execution Priority:
Local File Name:
Local Tape Info-File Seq.:
Label Type:
Unit Count:
Vol. Seq.:
Secure Socket(SSL): NO
IP Name/Addr:
122.222.222.222
Port:
Print Destination--:
Writer Name---------:
Report Title-------:
Print Class---------:
Copies-------------: 001
Hold Printing ------: N
Form Type----------:
Forms Control Buffer:
Record Separators--: N
Compression Mode----: YES
EBCDIC/Binary/ASCII: E
Pack Data Records---: NO
Truncate Record----: N
Transfer User Data--:
Code Table --------:
---Remote System Information--User ID:
Password:
Domain:
Notify User:
Notify Level:
PFK 1/Help
3/End
F1=Help
F2=SPLIT
F7=UP
F8=DOWN
F3=End
F9=SWAP
System User Data----:
¦ ----Local System Information---¦: USER01
¦:
¦:
¦: USER01
Notify Level:
F4=RETURN
F5=RFIND
F10=Language F11=Hold
11/Hold
F6=RCHANGE
F12=Alloc
Parameter Fields
This section describes the parameter fields of the Send Report screen.
74 User Guide
Send Report To Another System Screen
Transfer ID
Associates a descriptive identifier with this file transfer. It complements the
request number assigned by CA XCOM Data Transport to every locally initiated
transfer.
xxxxxxxxxx
Specifies up to 10 alphanumeric or national characters associating a
descriptive identifier with this file transfer.
Note: The CA XCOM Data Transport transfer IDs form a sequence that starts
with 001 and is incremented by 1 for each transfer.
Default: TSO user ID (uuuuuuu) with a sequence number (nnn) appended, that
is, uuuuuuunnn
TRUSTED (Y/N)
Specifies whether you can request a trusted transfer.
Y
Yes, you can request a trusted transfer.
N
No, you cannot request a trusted transfer.
Default: N
Execution Priority
Specifies the execution priority for a transfer request.
1 to 255
Specifies up to 10 alphanumeric or national characters representing the
execution priority for this request. 1 is the lowest execution priority.
Note: When multiple CA XCOM Data Transport transmissions are executing
concurrently, transfers with higher execution priorities receive preferential
service. In a busy CA XCOM Data Transport environment, unless you have
compelling reasons for not doing so, enhance processing efficiency by giving
short file transfers a higher priority value than long-running transmissions.
Default: 16
Chapter 1: The Menu Interface (TSO/ISPF Panels) 75
Send Report To Another System Screen
Local File Name
Indicates the name of the local data set being transferred. Required.
Up to 56 alphanumeric characters
Specifies up to 56 characters consisting of the following:
■
A 1- to 44-character data set name
■
An optional member name enclosed in parentheses
■
Optional single quotation marks (apostrophes) to enclose the data set
Your TSO profile prefix is inserted at the beginning of this entry unless the
entry is enclosed in single apostrophes. If the TSO profile is set to NOPREFIX,
nothing is inserted.
Notes:
■
Use an asterisk to send multiple members of a partitioned data set.
Specifying an asterisk for the member name sends all members of a PDS, for
example, SURVEYS(*). To send all members beginning with a specific prefix,
specify this prefix followed by an asterisk. For example, NAMES.PDS(AL*)
requests that members AL, ALEX, and ALICE all be transferred. The asterisk
must be the last character before the right parenthesis.
■
If no member name is entered for a partitioned data set, a Member Selection
List panel is displayed, allowing the selection of one or more members for
transfer. For more information, see Remote File Name and Member Selection
List in this chapter.
Default: The last data set name entered.
File Sequence
Specifies the sequence number of the data set on tape.
Note: Leave the field blank for disk files.
1 to 9999
Specifies the sequence number of the data set on tape.
76 User Guide
Send Report To Another System Screen
Label Type
Specifies the type of processing to be done on the tape data set.
Note: Leave the field blank for disk files.
SL
Specifies the tape processing type SL.
NL
Specifies the tape processing type NL.
NSL
Specifies the tape processing type NSL.
SUL
Specifies the tape processing type SUL.
BLP
Specifies the tape processing type BLP.
LTM
Specifies the tape processing type LTM.
AL
Specifies the tape processing type AL.
AUL
Specifies the tape processing type AUL.
Unit Count
Specifies the number of tape units to be allocated on the system.
Note: Leave the field blank for disk files.
1 to 20
Specifies the number of the units to be allocated on the system.
Volume Sequence
Specifies the sequence number of the first volume of a multivolume tape data set
to be used.
Note: Leave the field blank for disk files.
1 to 255
Specifies the sequence number of the first volume of a multivolume data set
to be used.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 77
Send Report To Another System Screen
Secure Socket (SSL)
Informs CA XCOM Data Transport how to handle the security of the transfer to
the remote system.
YES
Tells CA XCOM Data Transport to use OpenSSL for the transfer of the file and
that it must connect to a SSL port on the remote partner.
NO
Tells CA XCOM Data Transport that the file does not require a secure
connection and should be handled as a regular file transfer.
78 User Guide
Send Report To Another System Screen
Remote System Identification
Indicates the remote destination where the file is to be sent.
SNA destination name
Specifies the SNA name of the remote system where the transfer is directed
(one to eight characters).
Group name
Specifies the name of a destination member defined in the CA XCOM Data
Transport Control Library. This member can contain a single SNA LU name or
TCP/IP name or address or up to 16 SNA LU names (one to eight characters).
List name
Specifies a list of SNA LU names and/or TCP/IP addresses (1 to eight
characters).
Login user name
Specifies a user ID on the source system whose access privileges are used to
execute the file transfer (1 to eight characters).
IP destination name or IP address
Specifies the IP destination name or address of the remote system where the
transfer is directed (1 to 63 alphanumeric characters).
Note: The contents of the Remote System Identification field reflect the choices
made in the Primary Option Menu screen. The first item in the field identifies one
of the CA XCOM Data Transport destination types, that is, the first item is one of
the expressions IP Name/Addr, SNA LU Name, XCOM Group Name, XCOM List
Name, or Login User Name, depending on what was entered as the destination
type on the Primary Option Menu screen. If the first item in the field is IP
Name/Addr, another field, (IP) Port, appears to the right on the same line. The
second item in the Remote System Identification field is a specific destination
name (or a number, in the case of an IP address). You cannot change the
destination type (for example, SNA LU Name to XCOM Group Name) but you can
change the specific destination name or number.
Default: The remote destination specified on the Primary Option Menu
Chapter 1: The Menu Interface (TSO/ISPF Panels) 79
Send Report To Another System Screen
Dropsess
Specifies whether a session with a CA XCOM Data Transport partner should be
terminated at the completion of a file transfer. Optional.
Note: This field is displayed only when an SNA type of partner is referenced in
the Remote System Identification field.
Y
Indicates that the session is to be terminated after the transfer has
completed.
N
Indicates that the session is to be retained after the transfer has completed.
Q
Indicates that the session is to be terminated if there are no additional
transfer requests for the current CA XCOM Data Transport partner.
Default: N
Port
Specifies the number of the IP port where CA XCOM Data Transport listens at the
remote system.
Note: This field is displayed on the screen only when an IP name or address is
referenced in the Remote System Identification field.
1 to 65535
Identifies the IP port monitored (listened to) by CA XCOM Data Transport at
the remote system.
Note: If this field is left blank, the port value specified in the CA XCOM Data
Transport Default Options Table is used.
80 User Guide
Send Report To Another System Screen
Print Destination
Specifies the name of the printer or other device on the remote system that is to
receive the report. This destination is dependent upon the remote system.
Up to 21 alphanumeric characters (Version=2 type transfer)
Specifies the name of the remote system device (typically, a printer)
receiving the report.
Up to eight alphanumeric characters (Version=1 type transfer)
Specifies the name of the remote system device (typically, a printer)
receiving the report.
Important! Version does not refer to the release number of CA XCOM Data
Transport.
Note: The value of the parameter corresponds to a printer ID when the report is
sent to an AS/400. For AS/400, the print destination name can be a fully
qualified printer name.
Report Title
Describes the contents of the report being sent to the remote system.
Up to 21 alphanumeric characters
Text describing the contents of the report being sent to the remote system.
Notes:
■
Depending on the operating system running on the remote system, this
parameter might only be used as a comment, or it might become part of the
banner page produced with the report.
■
For example, HP OpenVMS systems print this field in a banner page. On a
z/OS system, this entry becomes part of the banner page with the values
specified in the Print Class and Form Type parameters.
Copies
Indicates the number of report copies to be printed on the remote system.
1 to 256
Specifies the number of report copies to be printed on the remote system.
Default: 1
Form Type
Up to 12 alphanumeric characters
Specifies the type of form that is used for printing on the remote system.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 81
Send Report To Another System Screen
Record Separators
Specifies whether CA XCOM Data Transport adds a record separator to delimit
logical records.
Note: Skip this field unless you are sending data to an ASCII system.
Y
CA XCOM Data Transport adds a record separator, such as a line feed and
carriage return, to delimit logical records.
N
CA XCOM Data Transport does not add record separators.
Default: N
EBCDIC/Binary/ASCII
Indicates the type of transferred data. The receiving system is responsible for
performing any necessary conversion.
B
Indicates binary data.
E
Indicates that the data is in EBCDIC code.
A
Indicates that the data is in ASCII code.
Default: E
82 User Guide
Send Report To Another System Screen
Truncate Record
Specifies how records exceeding the maximum logical record length (LRECL) are
to be handled.
Y
Specifies that records larger than the maximum LRECL are to be truncated to
the maximum record length.
N
Specifies that CA XCOM Data Transport is to terminate the file transfer upon
receiving a record larger than the maximum LRECL.
Default: N
Notes:
■
This field is supported only by the CA XCOM Data Transport mainframe
products: CA XCOM Data Transport for z/OS, CA XCOM Data Transport for
VSE, and CA XCOM Data Transport for VM.
■
When a record is truncated, the data not within the LRECL limit is lost.
Code Table
This is a three-character alphanumeric field used for specifying the translation
table to be used by the remote partner for this particular transfer only. This field
is applicable only for transfers to CA XCOM Data Transport UNIX or Windows
partners, and only if their INTERNAL_CONVERSION_TABLES=NO.
One to three (bytes)
Specifies up to three alphanumeric characters, identifying the code table to
be used by the remote partner.
Writer Name
Specifies the name of an external writer that is to process the report on the
remote system.
Up to eight alphanumeric characters
Specifies the name of an external writer that is to process the report on the
remote system.
Note: This parameter can be specified for Version=2 type transfers.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 83
Send Report To Another System Screen
Print Class
Specifies the print class for this report on the remote system. This value is
dependent on the remote system.
x
Specifies one alphanumeric character representing the print class for this
report on the remote system. This value is dependent on the remote system.
Note: When sending a report to an HP OpenVMS system, a valid value must be
specified for Print Class or the print job fails.
Default: A
Hold Printing
Indicates whether the report should be held when it is received on the remote
system or readied for immediate printing.
Y
The report is held.
N
The report is printed immediately.
Default: N
Forms Control Buffer
Specifies the FCB name used by JES from SYS1.IMAGELIB when the report is
sent to a remote z/OS system.
xxxx
Specifies up to four alphanumeric characters representing the FCB name
used by JES from SYS1.IMAGELIB when the report is sent to a remote z/OS
system
84 User Guide
Send Report To Another System Screen
Compression Mode
Specifies whether or not CA XCOM Data Transport compresses the data being
transferred and decompresses it on the remote system. Compressing the data
decreases the transmission time on lower-speed links.
YES
Provides Run-Length Encoding (RLE) for blanks and binary zeros only.
NO
No data compression.
RLE
Provides complete Run-Length Encoding for all characters.
COMPACT
Provides full RLE (as in RLE above) plus a byte compaction scheme that is
suitable for uppercase English text.
COMPACTL
Same as COMPACT above, only the compaction scheme is most beneficial for
lowercase English text.
LZSMALL
Lempel-Ziv 77 compression with a small memory allocation scheme.
LZMEDIUM
Lempel-Ziv 77 compression with a medium memory allocation scheme.
LZLARGE
Lempel-Ziv 77 compression with a large memory allocation scheme.
HUFFMAN
Greater compression than RLE but not as much as the Lempel-Ziv 77 modes.
LZRW3
General-purpose algorithm that runs fast and gives reasonable compression.
ZLIB(n)
Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and
LZLARGE. The n value can be 1 through 9.
Default: YES
Chapter 1: The Menu Interface (TSO/ISPF Panels) 85
Send Report To Another System Screen
Pack Data Records
Specifies whether record packing is to be used on a file transfer.
NO
Specifies that no record packing is used. The data are sent unblocked.
LENGTH
Specifies that the records are to be packed into fixed-size data transfer
blocks. Each record begins with a 2-byte long prefix that indicates the length
of the record and determines how many records can be packed into a block.
The default block size is 2K but it can be increased to 31K by using the
MAXPACK parameter in the CA XCOM Data Transport Default Options Table
or in the CA XCOM Data Transport control library member.
When transferring a text file to a partner that supports record separators (for
example, CRLF (0D0A) on Windows, and LF (0A) on UNIX), record
separators are inserted. No separators are inserted in binary files transferred
with PACK=LENGTH.
CRLF
Specifies that the records are to be packed into blocks separated by a
C(arriage)R(eturn)L(ine)F(eed) byte sequence.
Notes:
■
PACK=LENGTH with MAXPACK=31744 should be selected when using CA
XCOM Data Transport over TCP/IP. If PACK=LENGTH is coded, then you
must also code RECSEP=NO.
■
Platforms that understand PACK=LENGTH are IBM's AS/400, UNIX-based
systems, and z/OS systems. See the appropriate documentation for the
platform to see if this value is supported.
■
CRLF packing can be used with text files only. It is also used when
communicating with older releases of CA XCOM Data Transport on PC-DOS
and OS/2.
Transfer User Data
Allows you to specify up to 10 bytes of any type of data to be associated with the
transfer request. This data is sent to all user exits and written to the history file
upon completion of the file transfer.
Up to 10 alphanumeric characters
Specifies data to be associated with the transfer request.
86 User Guide
Send Report To Another System Screen
System User Data
Allows the specification of transfer-dependent user data. This data is available to
user exits in the RRDSUSER field of the RRDS data area (mapped by the
RRDDSECT macro) while the transfer is pending or active. The RRDSUSER field
is defined by HDRDSECT within RRDDSECT.
1 to 10 (bytes)
Specifies up to 10 bytes of data available to user exits during a file transfer.
Remote System Information
This section describes the Remote System Information parameter fields of the
Send Report screen.
User ID
Identifies the user ID under whose set of resource access privileges the transfer
is to execute on the remote system. Make this a user ID known to the security
system resident on the remote system.
Up to 12 alphanumeric characters
Specifies the user ID under whose set of resource access privileges the
transfer is to execute on the remote system
Notes:
■
For a third-party file transfer, this parameter provides the user ID for the
target remote system. (For more information about the CA XCOM Data
Transport security interface, see the chapter ―Overview of Security.‖)
■
To send a blank parameter value to the remote system, enter ― ‖, inserting at
least one blank space between the quotation marks. Do this when the
remote system supplies its own default value for the user ID under whose
access privileges the file transfer is to execute on the remote system.
■
Many systems do not perform security checking on reports. If this is the
case, skip this and the Remote Password parameter.
Default: The last remote user ID entered
Chapter 1: The Menu Interface (TSO/ISPF Panels) 87
Send Report To Another System Screen
Password
Identifies the password associated with the remote user ID. This value is not
displayed.
Up to 31 alphanumeric characters
Specifies up to 31 alphanumeric characters representing the remote user's
password.
Note: If the remote system is running IBM RACF, CA ACF2, or CA Top Secret,
you can also use this parameter to change the password on the remote system
by using this format:
oldpassword/newpassword
Notify User
Identifies the user on the remote system CA XCOM Data Transport is to notify
when the transfer completes.
user_id
If any value but LOG is given, CA XCOM Data Transport interprets this as a
specific user ID on the remote system.
If this user is not logged on when the transfer completes, the message is
displayed next time the user does log on.
LOG
LOG requests that the main operator on the remote system be notified.
If, for example, the remote system is z/OS, a WTO macro is issued by CA
XCOM Data Transport.
On an IBM iSeries or HP OpenVMS system, the operator console is notified.
Default: LOG
88 User Guide
Send Report To Another System Screen
Notify Level
Specifies the remote notification level for transfers initiated from the CA XCOM
Data Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
Local System Information
The following parameters are accessed under Local System Information:
User ID
Identifies the user ID under whose set of resource access privileges this file
transfer is to execute on the source system.
Up to eight alphanumeric characters
Specifies the user ID whose privileges are used for executing this file transfer
on the source system.
Notes:
■
This information is primarily used for third-party processing. For example, a
CA XCOM Data Transport node in New York could request that a CA XCOM
Data Transport node in Los Angeles send a file to a CA XCOM Data Transport
node in Chicago.
■
To use this feature, all systems must be identified to VTAM and running CA
XCOM Data Transport Version 2 or higher. For conventional, non-third-party
file transfers, use this parameter to identify the user that initiated the
transfer. This is useful when performing operator tracking and control
functions through the CA XCOM Data Transport Operator Control screen.
■
To send a blank parameter value to the source system, enter ― ‖, inserting at
least one blank space between the quotation marks. Do this when the source
system supplies its own default value for the user ID under whose access
privileges the file transfer is to execute on the source system.
Default: TSO user ID
Chapter 1: The Menu Interface (TSO/ISPF Panels) 89
Send Report To Another System Screen
Password
Identifies the password associated with the above user ID. This value is not
displayed.
Up to 31 alphanumeric characters
Specifies up to 31 alphanumeric characters representing the password
associated with the above user ID.
Domain
Identifies the Windows domain associated with the remote system.
Up to 15 alphanumeric characters
Specifies up to 15 alphanumeric characters representing the domain
associated with the user ID and password on the remote system.
Note: Can only be used for transfers running under Windows.
Notify User
Identifies the user on the local system CA XCOM Data Transport is to notify when
the transfer completes.
Up to eight alphanumeric characters
Specifies the user ID whose privileges are used for executing this file transfer
on the local system.
Default: LOG
Notify Level
Specifies the local notification level for transfers initiated from the CA XCOM Data
Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
90 User Guide
Submit Job To Another System Screen
Submit Job To Another System Screen
The Submit Job To Another System screen provides CA XCOM Data Transport
with the information necessary to submit a job from a z/OS data set for
execution on a remote system.
If the remote system is also a z/OS system, the job is submitted to an internal
reader. For non-z/OS systems, the job is submitted to a comparable facility. This
data set must contain the control statements necessary to execute the job on the
remote system, for example, JCL for a z/OS or z/VSE system.
Note: The data set being sent must exist as a valid cataloged data set on the
local system.
------------------------------------------------------------------------------08/04/08
CA XCOM Release r11.5 SP00
USER01
08.099
Submit Job To Another System
11:26
------------------------- CA XCOM Server: XCOMABC -----------------------COMMAND ===>
Transfer ID:
TRUSTED (Y/N):
Execution Priority:
Local File Name:
Local Tape Info-File Seq.:
Label Type:
IP Name/Addr:
122.222.222.222
Secure Socket(SSL): NO
Record Separators (Y/N)---: N
EBCDIC/Binary/ASCII(E/B/A): E
Truncate Record (Y/N)-----: N
Code Table --------:
1/Help
F1=Help
F7=UP
Compression Mode--------: YES
Pack Data Records(N/C/L): NO
Transfer User Data------:
System User Data--------:
Local System Information
¦ -------------------------------¦: USER01
¦:
¦:
¦: USER01
Notify Level:
3/End
F2=SPLIT
F8=DOWN
Vol. Seq.:
Port:
Remote System Information
------------------------------User ID:
Password:
Domain:
Notify User:
Notify Level:
PFK
Unit Count:
11/Hold
F3=End
F9=SWAP
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
Parameter Fields
This section describes the parameters on the Submit Job To Another System
screen.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 91
Submit Job To Another System Screen
Transfer ID
Associates a descriptive identifier with this file transfer. It complements the
request number assigned by CA XCOM Data Transport to every locally initiated
transfer.
xxxxxxxxxx
Specifies up to ten alphanumeric or national characters associating a
descriptive identifier with this file transfer.
Note: The CA XCOM Data Transport transfer IDs form a sequence that starts
with 001 and is incremented by 1 for each transfer.
Default: TSO user ID (uuuuuuu) with a sequence number (nnn) appended, that
is, uuuuuuunnn
TRUSTED (Y/N)
Specifies whether you can request a trusted transfer.
Y
Yes, you can request a trusted transfer.
N
No, you cannot request a trusted transfer.
Default: N
Execution Priority
Specifies the execution priority for this request.
xxxxxxxxxx
Specifies up to ten alphanumeric or national characters representing the
execution priority for this request. 1 is the lowest execution priority.
Note: When multiple CA XCOM Data Transport transmissions are executing
concurrently, transfers with higher execution priorities receive preferential
service. In a busy CA XCOM Data Transport environment, unless you have
compelling reasons for not doing so, enhance processing efficiency by giving
short file transfers a higher priority value than long-running transmissions.
Default: 16
92 User Guide
Submit Job To Another System Screen
Local File Name
Indicates the name of the local data set being transferred. Required.
Up to 56 alphanumeric characters
Specifies up to 56 characters consisting of the following:
■
A 1- to 44-character data set name
■
An optional member name enclosed in parentheses
■
Optional single quotation marks (apostrophes) to enclose the data set
Your TSO profile prefix is inserted at the beginning of this entry unless the
entry is enclosed in single apostrophes. If the TSO profile is set to NOPREFIX,
nothing is inserted.
Notes:
■
Use an asterisk to send multiple members of a partitioned data set.
Specifying an asterisk for the member name sends all members of a PDS, for
example, SURVEYS(*). To send all members beginning with a specific prefix,
specify this prefix followed by an asterisk. For example, NAMES.PDS(AL*)
requests that members AL, ALEX, and ALICE all be transferred. The asterisk
must be the last character before the right parenthesis.
■
If no member name is entered for a partitioned data set, a Member Selection
List panel is displayed, allowing the selection of one or more members for
transfer. For more information, see Remote File Name and Member Selection
List in this chapter.
Default: The last data set name entered.
File Sequence
Specifies the sequence number of the data set on tape.
Note: Leave the field blank for disk files.
1 to 9999
Specifies the sequence number of the data set on tape.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 93
Submit Job To Another System Screen
Label Type
Specifies the type of processing to be done on the tape data set.
Note: Leave the field blank for disk files.
SL
Specifies the tape processing type SL.
NL
Specifies the tape processing type NL.
NSL
Specifies the tape processing type NSL.
SUL
Specifies the tape processing type SUL.
BLP
Specifies the tape processing type BLP.
LTM
Specifies the tape processing type LTM.
AL
Specifies the tape processing type AL.
AUL
Specifies the tape processing type AUL.
Unit Count
Specifies the number of tape units to be allocated on the system.
Note: Leave the field blank for disk files.
1 to 20
Specifies the number of the units to be allocated on the system.
Volume Sequence
Specifies the sequence number of the first volume of a multivolume tape data set
to be used.
Note: Leave the field blank for disk files.
1 to 255
Specifies the sequence number of the first volume of a multivolume data set
to be used.
94 User Guide
Submit Job To Another System Screen
Remote System Identification
Indicates the remote destination where the file is to be sent.
SNA destination name
Specifies the SNA name of the remote system where the transfer is directed
(one to eight characters).
Group name
Specifies the name of a destination member defined in the CA XCOM Data
Transport Control Library. This member can contain a single SNA LU name or
TCP/IP name or address or up to 16 SNA LU names (one to eight characters).
List name
Specifies a list of SNA LU names and/or TCP/IP addresses (one to eight
characters).
Login user name
Specifies a user ID on the source system whose access privileges are used to
execute the file transfer (one to eight characters).
IP destination name or IP Address
Specifies the IP destination name or address of the remote system where the
transfer is directed (1 to 63 alphanumeric characters).
Note: The contents of the Remote System Identification field reflect the choices
made in the Primary Option Menu screen. The first item in the field identifies one
of the CA XCOM Data Transport destination types, that is, the first item is one of
the expressions IP Name/Addr, SNA LU Name, XCOM Group Name, XCOM List
Name, or Login User Name, depending on what was entered as the destination
type on the Primary Option Menu screen. If the first item in the field is IP
Name/Addr, another field, (IP) Port, appears to the right on the same line. The
second item in the Remote System Identification field is a specific destination
name (or a number, in the case of an IP address). You cannot change the
destination type (for example, SNA LU Name to XCOM Group Name) but you can
change the specific destination name or number.
Default: The remote destination specified on the Primary Option Menu
Chapter 1: The Menu Interface (TSO/ISPF Panels) 95
Submit Job To Another System Screen
DROPSESS
Indicates whether CA XCOM Data Transport drops an LU-to-LU session at the
conclusion of a scheduled file transfer.
YES
Indicates that CA XCOM Data Transport drops the session.
NO
Indicates that CA XCOM Data Transport does not drop the session.
QEMPTY
Indicates that CA XCOM Data Transport is to process all the transfers to a
particular LU in the request queue before dropping the session.
Default: NO
Note: CA XCOM Data Transport for OpenVMS and some CA XCOM Data
Transport for UNIX products do not support z/OS-initiated session
establishment. Therefore, DROPSESS has no effect when the target of the
transfer request is one of these platforms.
Port
Specifies the number of the IP port where CA XCOM Data Transport listens at the
remote system.
Note: This field is displayed on the screen only when an IP name or address is
referenced in the Remote System Identification field.
1 to 65535
Identifies the IP port monitored (listened to) by CA XCOM Data Transport at
the remote system.
Note: If this field is left blank, the port value specified in the CA XCOM Data
Transport Default Options Table is used.
Secure Socket (SSL)
Informs CA XCOM Data Transport how to handle the security of the transfer to
the remote system.
YES
Tells CA XCOM Data Transport to use OpenSSL for the transfer of the file and
that it must connect to an SSL port on the remote partner.
NO
Tells CA XCOM Data Transport that the file does not require a secure
connection and should be handled as a regular file transfer.
96 User Guide
Submit Job To Another System Screen
Record Separators
Specifies whether CA XCOM Data Transport adds a record separator to delimit
logical records.
Note: Skip this field unless you are sending data to an ASCII system.
Y
CA XCOM Data Transport adds a record separator, such as a line feed and
carriage return, to delimit logical records.
N
CA XCOM Data Transport does not add record separators.
Default: N
EBCDIC/Binary/ASCII
Indicates the type of transferred data. The receiving system is responsible for
performing any necessary conversion.
B
Indicates binary data.
E
Indicates that the data is in EBCDIC code.
A
Indicates that the data is in ASCII code.
Default: E
Note: EBCDIC packed decimal fields cannot be transferred under EBCDIC. Use
BINARY to transfer EBCDIC packed decimal data.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 97
Submit Job To Another System Screen
Truncate Record
Specifies how records exceeding the maximum logical record length (LRECL) are
to be handled.
Y
Specifies that records larger than the maximum LRECL are to be truncated to
the maximum record length.
N
Specifies that CA XCOM Data Transport is to terminate the file transfer upon
receiving a record larger than the maximum LRECL.
Notes:
■
This field is supported only by the CA XCOM Data Transport mainframe
products: CA XCOM Data Transport for z/OS, CA XCOM Data Transport for
z/VSE, and CA XCOM Data Transport for VM.
■
When a record is truncated, the data not within the LRECL limit is lost.
Default: N
Code Table
This is a three-character alphanumeric field used for specifying the translation
table to be used by the remote partner for this particular transfer only. This field
is applicable only for transfers to CA XCOM Data Transport UNIX, Linux, or
Windows partners, and only if their INTERNAL_CONVERSION_TABLES=NO.
One to three (bytes)
Specifies up to three alphanumeric characters, identifying the code table to
be used by the remote partner.
98 User Guide
Submit Job To Another System Screen
Compression Mode
Specifies whether or not CA XCOM Data Transport compresses the data being
transferred and decompresses it on the remote system. Compressing the data
decreases the transmission time on lower-speed links.
YES
Provides Run-Length Encoding (RLE) for blanks and binary zeros only.
NO
No data compression.
RLE
Provides complete Run-Length Encoding for all characters.
COMPACT
Provides full RLE (as in RLE above) plus a byte compaction scheme that is
suitable for uppercase English text.
COMPACTL
Same as COMPACT above, only the compaction scheme is most beneficial for
lowercase English text.
LZSMALL
Lempel-Ziv 77 compression with a small memory allocation scheme.
LZMEDIUM
Lempel-Ziv 77 compression with a medium memory allocation scheme.
LZLARGE
Lempel-Ziv 77 compression with a large memory allocation scheme.
HUFFMAN
Greater compression than RLE but not as much as the Lempel-Ziv 77 modes.
LZRW3
General-purpose algorithm that runs fast and gives reasonable compression.
ZLIB(n)
Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and
LZLARGE. The n value can be 1 through 9.
Default: YES
Chapter 1: The Menu Interface (TSO/ISPF Panels) 99
Submit Job To Another System Screen
Pack Data Records
Specifies whether record packing is to be used on a file transfer.
NO
Specifies that no record packing is used. The data are sent unblocked.
LENGTH
Specifies that the records are to be packed into fixed-size data transfer
blocks. Each record begins with a 2-byte long prefix that indicates the length
of the record and determines how many records can be packed into a block.
The default block size is 2K but it can be increased to 31K by using the
MAXPACK parameter in the CA XCOM Data Transport Default Options Table
or in the CA XCOM Data Transport control library member.
When transferring a text file to a partner that supports record separators (for
example, CRLF (0D0A) on Windows, and LF (0A) on UNIX), record
separators are inserted. No separators are inserted in binary files transferred
with PACK=LENGTH.
CRLF
Specifies that the records are to be packed into blocks separated by a
C(arriage)R(eturn)L(ine)F(eed) byte sequence.
Notes:
■
PACK=LENGTH with MAXPACK=31744 should be selected when using CA
XCOM Data Transport over TCP/IP. If PACK=LENGTH is coded, then you
must also code RECSEP=NO.
■
Platforms that understand PACK=LENGTH are IBM's AS/400, UNIX-based
systems, and z/OS systems. See the appropriate documentation for the
platform to see if this value is supported.
■
CRLF packing can be used with text files only. It is also used when
communicating with older releases of CA XCOM Data Transport on PC-DOS
and OS/2.
Transfer User Data
Allows you to specify up to 10 bytes of any type of data to be associated with the
transfer request. This data is sent to all user exits and written to the history file
upon completion of the file transfer.
Up to 10 alphanumeric characters
Specifies data to be associated with the transfer request.
100 User Guide
Submit Job To Another System Screen
System User Data
Allows the specification of transfer-dependent user data. This data is available to
user exits in the RRDSUSER field of the RRDS data area (mapped by the
RRDDSECT macro) while the transfer is pending or active. The RRDSUSER field
is defined by HDRDSECT within RRDDSECT.
1 to 10 (bytes)
Specifies up to 10 bytes of data available to user exits during a file transfer.
Remote System Information
This section describes the Remote System Information parameter fields of the
Submit Job screen.
User ID
Identifies the user ID under whose set of resource access privileges the transfer
is to execute on the remote system. Make this a user ID known to the security
system resident on the remote system.
xxxxxxxxxxxx
Specifies up to 12 alphanumeric characters
Notes:
■
For a third-party file transfer, this parameter provides the user ID for the
target remote system. (For more information about the CA XCOM Data
Transport security interface, see the chapter ―Overview of Security.‖)
■
To send a blank parameter value to the remote system, enter ― ‖, inserting at
least one blank space between the quotation marks. Do this when the
remote system supplies its own default value for the user ID under whose
access privileges the file transfer is to execute on the remote system.
Note: Many systems do not perform security checking on reports. If this is the
case, skip this and the Remote Password parameter.
Default: The last remote user ID entered
Chapter 1: The Menu Interface (TSO/ISPF Panels) 101
Submit Job To Another System Screen
Password
Identifies the password associated with the remote user ID. This value is not
displayed.
Up to 31 alphanumeric characters
Specifies up to 31 alphanumeric characters representing the remote user's
password.
If the remote system is running IBM RACF, CA ACF2, or CA Top Secret, you can
also use this parameter to change the password on the remote system by using
this format:
oldpassword/newpassword
Domain
Identifies the Windows domain associated with the remote system.
Up to 15 alphanumeric characters
Specifies up to 15 alphanumeric characters representing the domain
associated with the user ID and password on the remote system.
Note: Can only be used for transfers running under Windows.
Notify User
Identifies the user on the remote system whom CA XCOM Data Transport is to
notify when the transfer completes.
user_id
If any value but LOG is given, CA XCOM Data Transport interprets this as a
specific user ID on the remote system.
If this user is not logged on when the transfer completes, the message is
displayed next time the user does log on.
LOG
LOG requests that the main operator on the remote system be notified.
If, for example, the remote system is z/OS, a WTO macro is issued by CA
XCOM Data Transport.
On an IBM iSeries or HP OpenVMS system, the operator console is notified.
Default: LOG
102 User Guide
Submit Job To Another System Screen
Notify Level
Specifies the remote notification level for transfers initiated from the CA XCOM
Data Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
Local System Information
This section describes the Local System Information parameter fields of the
Submit Job screen
Chapter 1: The Menu Interface (TSO/ISPF Panels) 103
Submit Job To Another System Screen
User ID
Identifies the user ID under whose set of resource access privileges this file
transfer is to execute on the source system.
xxxxxxxx
Specifies up to eight alphanumeric characters representing the user ID
whose privileges are used for executing this file transfer on the source
system.
Notes:
■
This information is primarily used for third-party processing. For example, a
CA XCOM Data Transport node in New York could request that a CA XCOM
Data Transport node in Los Angeles send a file to a CA XCOM Data Transport
node in Chicago.
■
To use this feature, all systems must be identified to VTAM and running CA
XCOM Data Transport Version 2 or higher. For conventional, non-third-party
file transfers, use this parameter to identify the user that initiated the
transfer. This is useful when performing operator tracking and control
functions through the CA XCOM Data Transport Operator Control screen.
■
To send a blank parameter value to the source system, enter ― ‖, inserting at
least one blank space between the quotation marks. Do this when the source
system supplies its own default value for the user ID under whose access
privileges the file transfer is to execute on the source system.
Default: TSO user ID
Password
Identifies the password associated with the above user ID. This value is not
displayed.
Up to 31 alphanumeric characters
Specifies up to 31 alphanumeric characters representing the password
associated with the above user ID.
104 User Guide
Submit Job To Another System Screen
Notify User
Specifies the user on the local system whom CA XCOM Data Transport is to notify
when the transfer completes.
LOG
Indicates that the main operator on the local system be notified.
If the local system is z/OS, a WTO macro is issued by CA XCOM Data
Transport.
On an IBM iSeries or HP OpenVMS system, the operator console is notified.
user_id
If any value but LOG is given, CA XCOM Data Transport interprets this as a
specific user ID on the local system. If that user is not logged on when the
transfer completes, the message is displayed the next time the user logs on.
Default: LOG
Notify Level
Specifies the local notification level for transfers initiated from the CA XCOM Data
Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
Chapter 1: The Menu Interface (TSO/ISPF Panels) 105
Receive File From Another System Screen
Receive File From Another System Screen
Use the Receive File From Another System screen to provide CA XCOM Data
Transport with the information necessary to retrieve a data file from a remote
system.
Note: This screen now accepts file names up to the maximum allowable size for
the Local File (255 characters) and Remote File (256 characters). So, depending
on the size of your screen, you may need to use PF7 and PF8 to view all fields on
the screen.
------------------------------------------------------------------------------08/04/08
CA XCOM Release r11.5 SP00
USER01
08.099
Receive File From Another System
11:27
------------------------ CA XCOM Server: XCOMABC -----------------------------COMMAND ===>
Local System Identification
Server:
Transfer ID:
Local File :
USS -
UMASK :
IP Name/Addr:
Remote File:
Port: 8049
TRUSTED (Y/N):
LFILEDATA:
Execution Priority:
FILEDATA:
F2=SPLIT
F8=DOWN
F3=End
F9=SWAP
USSLRECL:
Port:
C
N
B
N
Secure Socket(SSL): NO
Checkpoint Count--------: 0
Compression Mode--------: YES
Pack Data Records(N/C/L): NO
Transfer User Data------:
System User Data--------:
Remote System Information
------------------------------User ID:
Tape (Y/N):
Password:
Domain:
Notify User: LOG
Notify Level:
Volume:
Unit:
PFK 1/Help
3/End
F1=Help
F7=UP
(Binary/Text)
122.222.222.222
Program Library: NO
Create/Replace/Add (C/R/A)------:
Record Separators (Y/N)---------:
EBCDIC/Binary/ASCII/VLR(E/B/A/V):
Truncate Record (Y/N)-----------:
Code Table ---------------------:
Protocol: TCP
Local System Information
¦ -------------------------------¦: USER01
Tape (Y/N):
¦:
¦:
¦: USER01
Notify Level:
¦:
Unit:
11/Hold
12/Alloc
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
Parameter Fields
This section describes the parameter fields of the Receive File screen.
106 User Guide
Receive File From Another System Screen
Local System Identification
Identifies the local system involved in a CA XCOM Data Transport transfer. The
terms in which the local system can be identified are described below.
Server
Specifies the APPLID or the STCIP of the CA XCOM Data Transport server on the
mainframe that is to start the transfer or the XCOMPLEX Admin Server that is to
schedule the transfer to an XCOMPLEX Worker Server. Required.
xxxxxxxx
Specifies the APPLID of the CA XCOM Data Transport server or XCOMPLEX
Admin Server. The APPLID can contain up to eight alphanumeric characters.
x1 . . . x63
Specifies the STCIP name or address of the CA XCOM Data Transport server
or XCOMPLEX Admin Server. The STCIP name can contain 1 to 63
alphanumeric characters and it must be one that has been defined to the
domain name server. The address can be in IPv4 or IPv6 notation. This is the
same STCIP that you can specify in your XCOMJOB PARM.
Port
Specifies the IP port of the STCIP of the CA XCOM Data Transport server on the
mainframe that is to start the transfer or the XCOMPLEX Admin Server that is to
schedule the transfer to an XCOMPLEX Worker Server. Required.
nnnnn
Specifies the IP port of the CA XCOM Data Transport server or XCOMPLEX
Admin Server. The IP port can contain valid numeric values 1 through
65535. This is the same as the STCPORT that you can specify in your
XCOMJOB PARM.
Protocol
Specifies whether the Server field is the STCIP or the APPLID of the CA XCOM
Data Transport server on the mainframe that is to start the transfer or the
XCOMPLEX Admin Server that is to schedule the transfer to an XCOMPLEX
Worker Server. Required.
xxx
Valid values are SNA, TCP, and SSL.
If you specify SNA, then the Server field must be a one- to eight-character
entry conforming to the rules for VTAM APPLIDs.
If you specify TCP or SSL, the Server field must be a 1- to 64-character entry
conforming to the rules for a TCP/IP name or address. If the server listens to
a port other than 8044, specify the port address.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 107
Receive File From Another System Screen
Transfer ID
Associates a descriptive identifier with this file transfer. It complements the
request number assigned by CA XCOM Data Transport to every locally initiated
transfer.
xxxxxxxxxx
Specifies up to ten alphanumeric or national characters identifying the file
transfer.
Note: The CA XCOM Data Transport transfer IDs form a sequence that starts
with 001 and is incremented by 1 for each transfer.
Default: Your TSO user ID (uuuuuuu) with a sequence number (nnn) appended,
that is, uuuuuuunnn
TRUSTED (Y/N)
Specifies whether you can request a trusted transfer.
Y
Yes, you can request a trusted transfer.
N
No, you cannot request a trusted transfer.
Default: N
Execution Priority
Specifies the execution priority for this request.
1 to 255
Specifies a priority to provide efficient scheduling in a busy transfer
environment. 1 is the lowest execution priority.
Note: When multiple CA XCOM Data Transport transmissions are executing
concurrently, transfers with higher execution priorities receive preferential
service. In a busy CA XCOM Data Transport environment, unless you have
compelling reasons for not doing so, enhance processing efficiency by giving
short file transfers a higher priority value than long-running transmissions.
Default: 16
108 User Guide
Receive File From Another System Screen
Local File
Indicates the name of the data set where the file being retrieved is to be stored.
Up to 56 alphanumeric characters (for a non-USS file)
Specifies up to 56 characters consisting of the following:
■
A 1- to 44-character data set name
■
An optional member name enclosed in parentheses
■
Optional single quotation marks (apostrophes) to enclose the data set
Your TSO profile prefix is inserted at the beginning of this entry unless the
entry is enclosed in single apostrophes. If the TSO profile is set to NOPREFIX,
nothing is inserted.
1 to 255 characters (for a USS file)
Specifies the USS local data set involved in a file transfer. Contains up to 255
characters consisting of the following:
■
/ (the first character of the data set name)
■
A 1- to 254-character data set name
Notes:
■
One or more wildcard characters (*) can be used if transferring to IBM
mainframe systems, to Windows systems, or to UNIX systems.
■
The transfer of USS files is supported only between systems running CA
XCOM Data Transport r11.5.
Default: The last data set name entered
USS Example
Note: USS files can have up to 255 characters.
LFILE=/u/users/xcom/source/*.c
Transfer ALL files and save them with the suffix .c.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 109
Receive File From Another System Screen
UMASK
The file permissions to be removed from the XCOM default file or directory
permissions for USS files or directories. UMASK is used only when a file or
directory is being created.
Range: 000 to 777
Default: 022
On z/OS systems the XCOM default file permission is 666, which means the
following:
■
Allow the owner of the file to read and write the file.
■
Allow members of the owner's group to read and write the file.
■
Allow all other users read and write the file.
File permissions on USS files are implemented the same way as file permissions
are on UNIX systems. The three basic permissions for each of the categories
listed above are read, write, and execute, commonly seen as rwx rwx rwx.
If each of these characters (r, w, x) is considered as a bit, then the possible value
ranges are as follows:
■
000 to 111 in binary
■
0 to 7 in hex
So the default permissions of 666 (110 110 110) mean allow read and write to
everyone, but not execute.
The UMASK value identifies the permissions that you want to remove from the
default (666). If you remove 022 (000 010 010) from 666 then what remains is
644, which means the following:
■
Allow the owner of the file to read and write the file.
■
Allow members of the owner's group and all other users to read, but not
write.
Notes:
110 User Guide
■
For directories—CA XCOM Data Transport sets permissions for a created
directory to 7xx, no matter what owner UMASK value was specified. Group
and other permissions, represented by xx, represent the permissions with
the specified UMASK removed.
■
For files – While the file is being transferred, CA XCOM Data Transport sets
permissions for a created file to 6xx, where xx represents the permissions
with the specified UMASK removed. After the transfer has been completed,
CA XCOM Data Transport sets the owner permission with the specified
UMASK removed.
Receive File From Another System Screen
LFILEDATA
Indicates how the local USS file is to be allocated.
B
Binary
T
Text
If you do not specify a value for LFILEDATA, then the allocation is determined
based on the CODE= specification, as determined by the value of the
EBCDIC/Binary/ASCII/VLR(E/B/A/V) field, as follows:
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=B, then the file is allocated and
processed as binary data.
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=E, the type of allocation and
processing depends on the value of LFILEDATA, as follows:
–
If you do not specify LFILEDATA=B, then the file is allocated as a text file
and processed as an EBCDIC text file.
–
If you do specify LFILEDATA=B, then the file is allocated as a binary file,
but processed as an EBCDIC file.
Important! If you do specify LFILEDATA=B, then you need to specify a value for
USSLRECL, to tell CA XCOM Data Transport how many bytes there are in each
logical record.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 111
Receive File From Another System Screen
FILEDATA
Indicates how a remote USS file is to be allocated.
B
Binary
T
Text
If you do not specify a value for FILEDATA, then the allocation is determined
based on the CODE= specification, as determined by the value of the
EBCDIC/Binary/ASCII/VLR(E/B/A/V) field, as follows:
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=B, then the file is allocated and
processed as binary data.
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=E, the type of allocation and
processing depends on the value of FILEDATA, as follows:
–
If you do not specify FILEDATA=B, then the file is allocated as a text file
and processed as an EBCDIC text file.
–
If you do specify FILEDATA=B, then the file is allocated as a binary file,
but processed as an EBCDIC file.
Important! If you do specify FILEDATA=B, then you need to specify a value for
LRECL, to tell CA XCOM Data Transport how many bytes there are in each logical
record.
USSLRECL
If LFILEDATA or FILEDATA is set to B (binary), this value tells CA XCOM Data
Transport how many bytes there are in each logical record.
112 User Guide
Receive File From Another System Screen
Remote System Identification
Indicates the destination from which the file is to be retrieved. Required.
SNA destination name
Specifies the SNA name of the remote system where the transfer is directed
(one to eight characters).
Group name
Specifies the name of a destination member defined in the CA XCOM Data
Transport Control Library. This member can contain a single SNA LU name or
TCP/IP name or address or up to 16 SNA LU names (one to eight characters).
List name
Specifies a list of SNA LU names and/or TCP/IP addresses (one to eight
characters).
Login user name
Specifies a user ID on the source system whose access privileges are used to
execute the file transfer (one to eight characters).
IP destination name or IP Address
Specifies the IP destination name or address of the remote system where the
transfer is directed (1 to 63 alphanumeric characters).
The contents of the Remote System Identification field reflect the choices made
in the Primary Option Menu screen. The first item in the field identifies one of the
CA XCOM Data Transport destination types, that is, the first item is one of the
expressions IP Name/Addr, SNA LU Name, XCOM Group Name, XCOM List Name,
or Login User Name, depending on what was entered as the destination type on
the Primary Option Menu screen. If the first item in the field is IP Name/Addr,
another field, (IP) Port, appears to the right on the same line. The second item in
the Remote System Identification field is a specific destination name (or a
number, in the case of an IP address). You cannot change the destination type
(for example, SNA LU Name to XCOM Group Name) but you can change the
specific destination name or number.
Default: The remote destination specified on the Primary Option Menu
Chapter 1: The Menu Interface (TSO/ISPF Panels) 113
Receive File From Another System Screen
Dropsess
Specifies whether a session with a CA XCOM Data Transport partner should be
terminated at the completion of a file transfer. Optional.
Note: This field is displayed only when an SNA type of partner is referenced in
the Remote System Identification field.
Y
Indicates that the session is to be terminated after the transfer has
completed.
N
Indicates that the session is to be retained after the transfer has completed.
Q
Indicates that the session is to be terminated if there are no additional
transfer requests for the current CA XCOM Data Transport partner.
Default: N
Port
Specifies the number of the IP port where CA XCOM Data Transport listens at the
remote system.
Note: This field is displayed on the screen only when an IP name or address is
referenced in the Remote System Identification field.
1 to 65535
Identifies the IP port monitored (listened to) by CA XCOM Data Transport at
the remote system.
If this field is left blank, the port value specified in the CA XCOM Data Transport
Default Options Table is used.
114 User Guide
Receive File From Another System Screen
Remote File
Indicates the name of the file on the remote system that is being retrieved.
Required.
Up to 256 alphanumeric characters
Specifies the file name that should receive the data being transferred. The
maximum allowable length of the file name varies, depending on the remote
partner. The following limits apply for MVS and USS files:
■
Up to 56 alphanumeric characters (for an MVS file)
■
Up to 255 alphanumeric characters (for a USS file)
Up to 56 alphanumeric characters (for an MVS file)
Specifies up to 56 characters consisting of the following:
■
A 1- to 44-character data set name
■
An optional member name enclosed in parentheses
■
Optional single quotation marks (apostrophes) to enclose the data set
Your TSO profile prefix is inserted at the beginning of this entry unless the
entry is enclosed in single apostrophes. If the TSO profile is set to NOPREFIX,
nothing is inserted.
Notes:
■
You can use an asterisk (*) as a wildcard to retrieve multiple members of
a partitioned data set. Specifying an asterisk for the member name
retrieves all members of a PDS, for example, SURVEYS(*). To retrieve all
members beginning with a specific prefix, specify the prefix followed by
an asterisk. For example, NAMES.PDS(AL*) requests that members AL,
ALEX, ALICE, and so on be transferred.
■
During the generation of a file transfer request, CA XCOM Data Transport
successively replaces each asterisk (*) in a Remote File Name with a
name you have selected from the Member Selection List. When CA
XCOM Data Transport finds no other special character in a Remote File
Name, it appends the name (within parentheses) of each selected
member to the Remote File Name. You can arrange for CA XCOM Data
Transport to avoid the latter procedure and treat such a file as
sequential. To do this, you must select the ALLOC function (PF12/24)
and set the Directory Blocks entry to zero.
■
In the OpenVMS environment, brackets ([ ]) are used to indicate the
directory in a complete file name specification. However, some EBCDIC
environment keyboards do not provide brackets. In such cases, use
braces ({ }) instead, because CA XCOM Data Transport converts the
braces to brackets.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 115
Receive File From Another System Screen
■
If the remote file name includes embedded spaces in the file name,
enclose the FILE parameter value in either single or double quotes. For
example, to send to the directory c:\My Documents on a Windows
partner, use the following format:
FILE='c:\My Documents\test.txt'
1 to 255 characters (for a USS file)
Specifies up to 255 characters consisting of the following:
■
/ (the first character of the data set name)
■
A 1- to 254-character data set name
Notes:
■
One or more wildcard characters (*) can be used if transferring to IBM
mainframe systems, to Windows systems, or to UNIX systems.
■
The transfer of USS files is supported only between systems running CA
XCOM Data Transport r11.5.
USS Examples
FILE=/u/users/xcom/*
Transfer ALL files.
FILE=/u/users/xcom/m*
Transfer ALL files starting with an m.
FILE=/u/users/xcom/*m
Transfer ALL files ending with an m.
FILE=/u/users/xcom/m*m
Transfer ALL files starting with an m and ending with an m.
FILE=/u/users/xcom/m*y*m
Transfer ALL files starting with an m, ending with an m and containing a y.
FILE=/u/users/xcom/m*you*
Transfer ALL files starting with an m and containing the characters you in
succession.
FILE=/u/users/xcom/m*y*o*u*
Transfer ALL files starting with an m and containing the characters y and o
and u (in order, but not in succession).
116 User Guide
Receive File From Another System Screen
Program Library
Informs CA XCOM Data Transport how to handle the file that is being transferred
to the remote system.
YES
Tells CA XCOM Data Transport to transfer the file as a PDSE program library.
This parameter is the equivalent to PROGLIB=YES in SYSIN01.
NO
Tells CA XCOM Data Transport that the file does not involve a PDSE program
library and should be handled as a regular file transfer.
Note: There is no default value for this parameter. Unless YES is specified, the
file is handled as a regular transfer.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 117
Receive File From Another System Screen
Create/Replace/Add
Informs CA XCOM Data Transport how to handle the file in which the transferred
data are going to be received. This is the file whose name appears in the Local
File Name field.
C(reate)
CA XCOM Data Transport attempts to create (allocate) a new file on the
receiving system. For information concerning the provision of additional
allocation parameters for this new file, see the File Allocation Information
screen in this chapter.
A(dd)
CA XCOM Data Transport adds the records being transferred to the end of an
existing file (named in the Local File Name field).
For an indexed file, the keys must not match those in the file on the local
system or CA XCOM Data Transport terminates the transfer with an error.
R(eplace)
CA XCOM Data Transport replaces the contents of a file on the local
(initiating) system with the data being transferred.
If the file is indexed, the records with matching keys are replaced and those
with non-matching keys are added.
Notes:
■
When transferring a partitioned data set, specify C only if the PDS itself is
being created. If a new member is being sent to an existing PDS, specify R
for Replace.
■
If you specify Create, the CA XCOM default options table value REPCR is used
to determine if the file will be replaced or if the transfer will terminate with an
error. For more information, see REPCR in the chapter "The Batch
Interface."
Default: C(reate)
118 User Guide
Receive File From Another System Screen
Record Separators
Specifies whether the receiving CA XCOM Data Transport adds record separators
(line feed and/or carriage return) to delimit logical records.
Note: Skip this field unless you are sending data to an ASCII system.
Y
CA XCOM Data Transport adds a record separator to delimit logical records.
N
CA XCOM Data Transport does not add record separators.
Default: N
EBCDIC/Binary/ASCII/VLR
Indicates the type of transferred data. The system from which the data are
retrieved is responsible for performing any necessary conversion.
B
Indicates binary data.
E
Indicates that the data is in EBCDIC code.
A
Indicates that the data is in ASCII code.
V
Indicates that the data is in BINARY code and that the record descriptor word
is preserved.
Note: EBCDIC packed decimal fields cannot be transferred under EBCDIC. Use
BINARY to transfer EBCDIC packed decimal fields.
Default: E
Chapter 1: The Menu Interface (TSO/ISPF Panels) 119
Receive File From Another System Screen
Secure Socket (SSL)
Informs CA XCOM Data Transport how to handle the security of the transfer to
the remote system.
YES
Tells CA XCOM Data Transport to use OpenSSL for the transfer of the file and
that it must connect to a SSL port on the remote partner.
NO
Tells CA XCOM Data Transport that the file does not require a secure
connection and should be handled as a regular file transfer.
Checkpoint Count
Specifies the interval at which CA XCOM Data Transport takes a checkpoint (to
be used to restart a suspended or failed file transfer). The length of the
checkpoint interval is measured in terms of a number of blocks.
0
Specifies that CA XCOM Data Transport is to take no checkpoints.
1 to 9999
Specifies the number of blocks that form a checkpoint interval. A checkpoint
is taken whenever the specified number of blocks has been transferred.
Note: If record packing is not used, 1 record = 1 block.
Each time a checkpoint is taken, the output buffers on the receiving system are
written to the disk. Making the checkpoint interval too short slows down file
transfers; making it too long increases the risk of data loss. It is recommended
that the Checkpoint Count be set to at least 1000. On Token Ring, Ethernet and
other high-speed networks, the Checkpoint Count should be set to the highest
allowable value.
If the receiving system is z/OS or VSE, the Checkpoint Count should be a
multiple of the blocking factor. For example, if the DCB attributes are RECFM=FB
LRECL=80 BLKSIZE=8000, the Checkpoint Count should be a multiple of 100.
120 User Guide
Receive File From Another System Screen
Compression Mode
Specifies whether CA XCOM Data Transport compresses the data being
transferred and decompresses it on the receiving system. Compressing the data
decreases the transmission time on lower-speed lines.
YES
Provides Run-Length Encoding (RLE) for blanks and binary zeros only.
NO
No data compression.
RLE
Provides complete Run-Length Encoding for all characters.
COMPACT
Provides full RLE (as in RLE above) plus a byte compaction scheme that is
suitable for uppercase English text.
COMPACTL
Same as COMPACT above, only the compaction scheme is most beneficial for
lowercase English text.
LZSMALL
Lempel-Ziv 77 compression with a small memory allocation scheme.
LZMEDIUM
Lempel-Ziv 77 compression with a medium memory allocation scheme.
LZLARGE
Lempel-Ziv 77 compression with a large memory allocation scheme.
HUFFMAN
Greater compression than RLE but not as much as the Lempel-Ziv 77 modes.
LZRW3
General-purpose algorithm that runs fast and gives reasonable compression.
ZLIB(n)
Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and
LZLARGE. The n value can be 1 through 9.
Default: YES
Chapter 1: The Menu Interface (TSO/ISPF Panels) 121
Receive File From Another System Screen
Truncate Record
Specifies how records exceeding the maximum logical record length (LRECL) are
to be handled.
Y
Specifies that records larger than the maximum LRECL are to be truncated to
the maximum record length.
N
Specifies that CA XCOM Data Transport is to terminate the file transfer upon
receiving a record larger than the maximum LRECL.
Notes:
■
This field is supported only by the CA XCOM Data Transport mainframe
products, CA XCOM Data Transport for z/OS, CA XCOM Data Transport for
VSE, and CA XCOM Data Transport for VM.
■
When a record is truncated, the data not within the LRECL limit is lost.
Default: N
Code Table
This is a three-character alphanumeric field used for specifying the translation
table to be used by the remote partner for this particular transfer only. This field
is applicable only for transfers to CA XCOM Data Transport UNIX or Windows
partners, and only if their INTERNAL_CONVERSION_TABLES=NO.
One to three (bytes)
Specifies up to three alphanumeric characters, identifying the code table to
be used by the remote partner.
122 User Guide
Receive File From Another System Screen
Pack Data Records
Specifies whether record packing is to be used on a file transfer.
NO
Specifies that no record packing is used. The data are sent unblocked.
LENGTH
Specifies that the records are to be packed into fixed-size data transfer
blocks. Each record begins with a 2-byte long prefix that indicates the length
of the record and determines how many records can be packed into a block.
The default block size is 2K but it can be increased to 31K by using the
MAXPACK parameter in the CA XCOM Data Transport Default Options Table
or in the CA XCOM Data Transport control library member.
When transferring a text file to a partner that supports record separators (for
example, CRLF (0D0A) on Windows, and LF (0A) on UNIX), record
separators are inserted. No separators are inserted in binary files transferred
with PACK=LENGTH.
CRLF
Specifies that the records are to be packed into blocks separated by a
C(arriage)R(eturn)L(ine)F(eed) byte sequence.
Notes:
■
PACK=LENGTH with MAXPACK=31744 should be selected when using CA
XCOM Data Transport over TCP/IP. If PACK=LENGTH is coded, then you
must also code RECSEP=NO.
■
Platforms that understand PACK=LENGTH are IBM's AS/400, UNIX-based
systems, and z/OS systems. See the appropriate documentation for the
platform to see if this value is supported.
■
CRLF packing can be used with text files only. It is also used when
communicating with older releases of CA XCOM Data Transport on PC-DOS
and OS/2.
Transfer User Data
Allows you to specify up to 10 bytes of any type of data to be associated with the
transfer request. This data is sent to all user exits and written to the history file
upon completion of the file transfer.
Up to 10 alphanumeric characters
Specifies data to be associated with the transfer request.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 123
Receive File From Another System Screen
System User Data
Allows the specification of transfer-dependent user data. This data is available to
user exits in the RRDSUSER field of the RRDS data area (mapped by the
RRDDSECT macro) while the transfer is pending or active. The RRDSUSER field is
defined by HDRDSECT within RRDDSECT.
1 to 10 (bytes)
Specifies up to 10 bytes of data available to user exits during a file transfer.
Remote System Information
The Remote System Information fields of the Receive File From Another System
screen pertain to the remote or non-initiating CA XCOM Data Transport partner.
User ID
Identifies the user ID under whose set of resource access privileges the file
transfer is to execute on the remote system. It should be a user ID known to the
security interface of that system.
xxxxxxxxxxxx
Specifies up to 12 alphanumeric characters representing a user ID whose
access privileges on the remote system are used for executing the transfer.
Notes:
■
If the remote system does not perform security checking, you can skip this
and the Remote Password parameter.
■
To send a blank parameter value to the remote system, enter ― ‖, inserting at
least one blank space between the quotation marks. Do this when the
remote system supplies its own default value for the user ID under whose
access privileges the file transfer is to execute on the remote system.
Default: The last remote user ID entered
124 User Guide
Receive File From Another System Screen
Tape
Indicates whether the remote data set resides on magnetic tape.
Y
Specifies that the remote data set resides on magnetic tape.
N
Specifies that the remote data set does not reside on magnetic tape.
Note: If you enter Y in the Tape field, a new screen - MVS Extended Tape
Parameter Entry - is displayed, allowing tape-related information to be specified.
See the section MVS Extended Tape Parameter Entry Screen earlier in this
chapter.
Default: N
Password
Identifies the password associated with the remote user ID.
Up to 31 alphanumeric characters
Specifies up to 31 alphanumeric characters representing the user password
associated with the remote user ID.
Note: If the remote system is running IBM RACF, CA ACF2, or CA Top Secret,
this parameter can be used to change the password on the remote system. To do
this, use the following format:
oldpassword/newpassword
Domain
Identifies the Windows domain associated with the remote system.
Up to 15 alphanumeric characters
Specifies up to 15 alphanumeric characters representing the domain
associated with the user ID and password on the remote system.
Note: Can only be used for transfers running under Windows.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 125
Receive File From Another System Screen
Notify User
Identifies the user on the remote system whom CA XCOM Data Transport is to
notify when the transfer completes.
LOG
Indicates that the main operator on the remote system be notified.
If the remote system is z/OS, a WTO macro is issued by CA XCOM Data
Transport.
On an IBM iSeries or HP OpenVMS system, the operator console is notified.
user_id
If any value but LOG is given, CA XCOM Data Transport interprets this as a
specific user ID on the remote system. If that user is not logged on when the
transfer completes, the message is displayed the next time the user logs on.
Default: LOG
Notify Level
Specifies the remote notification level for transfers initiated from the CA XCOM
Data Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
Volume
Indicates the volume on the remote system on which the file is to be created (or
resides, for existing non-cataloged files).
xxxxxx
Specifies the name of the volume serial where the remote data set can be
found or created. This value can be up to six alphanumeric characters.
Default: The volume name determined by the remote system catalog
126 User Guide
Receive File From Another System Screen
Unit
Indicates the unit on the remote system from which the file is to be retrieved.
xxxxxxxx
Specifies the unit name on the remote system from which the file is to be
retrieved. This value can be up to eight alphanumeric characters.
Default: The unit determined by the remote system catalog
Local System Information
The Local System Information fields of the Send MVS File To Another System
screen pertain to the local or transfer-initiating CA XCOM Data Transport system.
User ID
Identifies the user ID under whose set of resource access privileges this file
transfer is to execute on the source (transfer-initiating) system.
Up to eight characters
Specifies the user ID under whose set of resource access privileges this file
transfer is to execute on the source system.
Notes:
■
This information is primarily used for third-party processing. For example, a
CA XCOM Data Transport node in New York could request that a CA XCOM
Data Transport node in Los Angeles send a file to a CA XCOM Data Transport
node in Chicago.
■
To use this feature, all systems must be identified to VTAM and running CA
XCOM Data Transport Version 2 or higher. For conventional (that is,
non-third-party) file transfers, use this parameter to identify the user that
initiated the transfer. This is useful when performing operator tracking and
control functions through the CA XCOM Data Transport Operator Control
screen.
■
To send a blank parameter value to the source system, enter ― ‖, inserting at
least one blank space between the quotation marks. Do this when the source
system supplies its own default value for the user ID under whose access
privileges the file transfer is to execute on the source system.
Default: TSO user ID
Chapter 1: The Menu Interface (TSO/ISPF Panels) 127
Receive File From Another System Screen
Tape
Indicates whether the local data set resides on magnetic tape.
Y
Specifies that the local data set resides on magnetic tape.
N
Specifies that the local data set does not reside on magnetic tape.
Note: If you enter Y in the Tape field, a new screen - MVS Extended Tape
Parameter Entry - is displayed, allowing tape-related information to be specified.
See MVS Extended Tape Parameter Entry Screen earlier in this chapter.
Default: N
Password
Specifies the password associated with the local User ID parameter.
Up to 31 alphanumeric characters
Specifies the password associated with the local user ID parameter.
Note: The value entered in this field is not displayed.
Notify User
Identifies the user on the receiving system whom CA XCOM Data Transport is to
notify when the transfer completes.
LOG
Indicates that the main operator on the local system be notified.
If the local system is z/OS, a WTO macro is issued by CA XCOM Data
Transport.
On an IBM iSeries or HP OpenVMS system, the operator console is notified.
user_id
If any value but LOG is given, CA XCOM Data Transport interprets this as a
specific user ID on the local system. If that user is not logged on when the
transfer completes, the message is displayed the next time the user logs on.
Default: LOG
128 User Guide
Receive File From Another System Screen
Notify Level
Specifies the local notification level for transfers initiated from the CA XCOM Data
Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
Volume
Specifies the name of the volume serial where the local data set can be found or
created.
Up to six alphanumeric characters
Specifies up to six alphanumeric characters representing the name of the
volume serial where the local data set can be found or created.
Notes:
■
Used in conjunction with the local Unit parameter.
■
The value must be the name of a volume currently mounted on this system,
or problems in allocation may occur.
■
If the data set does not exist and the File Allocation Information screen is
used, the parameters entered on that screen are used to create the data set.
■
If the data set does not exist and the File Allocation Information screen is not
used, the file allocation parameter values specified in the Default Options
Table are used to create the data set.
Default: Catalog information is used if the data set exists.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 129
Receive File From Another System Screen
Unit
Specifies the unit name to be used in locating the local data set.
Up to 10 alphanumeric characters
Specifies the unit name to be used in locating the local data set.
If the data set does not exist and the File Allocation Information screen is used,
the parameters entered on that screen are used to create the data set.
If the data set does not exist and the File Allocation Information screen is not
used, the file allocation parameter values specified in the Default Options Table
is used to create the data set.
Note: This parameter is used in conjunction with the local Volume parameter.
Default: Catalog information is used if the data set exists.
130 User Guide
Japanese Character Set Support Screen
Japanese Character Set Support Screen
Use the Japanese Character Set Support Screen to transfer Japanese EBCDIC
data.
To access this screen
From any XCOM ISPF panel, press PF10.
-----------------------------------------------------------------------08/04/08
CA XCOM Release r11.5 SP00
USER01
08.099
Japanese Character Set Support Screen
03:18
-----------------------------------------------------------------------COMMANDS ===>
EBCDIC Japanese Data:
E
(E or K)
Lower-case English or Katakana
in data
EBCDIC Japanese Control: E
(E or K)
Lower-case English or Katakana
in header
Delete Shift:
D
(D or C)
Delete Shift-in & Shift-out
characters or convert to spaces
Double byte code:
0
Local double byte character set
characters or convert to spaces
0 - IBM
5 - PS/55
1 - AX-1
2 - AX-2
-----------------------------------------------------------------------PFK 1/Help
3/End
11/Hold
12/Show
F1=Help
F7=UP
F2=SPLIT
F8-DOWN
F3=End
F9= SWAP
F4= RETURN
F10=Language
F5=RFIND
F11=Hold
F6=RCHANGE
F12=ALLOC
Parameter Fields
This section describes the parameter fields of the Japanese Character Set
Support Screen.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 131
Japanese Character Set Support Screen
EBCDIC Japanese Data
Specifies whether the data file contains Katakana characters.
K
The data file being transferred contains Katakana characters rather than
English lower-case.
E
The data file does not contain Katakana characters.
Default: E
EBCDIC Japanese Control
Specifies whether the header fields contain Katakana characters.
K
The control information (header fields) being transferred contains Katakana
characters rather than English lower-case.
E
The control information does not contain Katakana characters.
Default: E
Delete Shift
Specifies whether DBCS shift-out and shift-in characters are removed or
converted to spaces.
C
The DBCS shift-out and shift-in characters are converted to spaces.
D
The DBCS shift-out and shift-in characters are removed.
Default: D
Double Byte Code
Identifies the local double byte character set for Japanese conversions.
Note: This parameter is no longer supported. IBM double byte character set only
is supported.
132 User Guide
File Transfer Scheduling Information Screen
File Transfer Scheduling Information Screen
The File Transfer Scheduling Information screen contains the optional
parameters related to file transfer scheduling. This screen is displayed only if a
file transfer is requested to be queued via the Queue for Execution field on the
Primary Option Menu and the user enters the SCHEDULE command (PF11/23)
from any of the file transfer screens (Send MVS File To Another System, Submit
Job To Another System, Send Report To Another System, or Receive File From
Another System).
-----------------------------------------------------------------------08/04/08
CA XCOM Release r11.5 SP00
USER01
08.099
File Transfer Scheduling Information
09:49
-----------------------------------------------------------------------COMMAND ===>
LOGDA01.R30.CICS.ASM(XCICODIS)
Start Date:
Day: 08
or
Start Time: 1746
Selection Priority:
Month: 04
Year: 2008
Number of days from today:
(HHMM)
or (+HHMM)
or
(+MM)
(1 - 255)
Hold:
(Y or N)
Age:
(1 - 999)
-----------------------------------------------------------------------PFK 1/Help
3/End
12/Alloc
F1=Help
F7=UP
F2=SPLIT
F8=DOWN
F3=End
F9=SWAP
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
Parameter Fields
This section describes the parameter fields of the File Transfer Scheduling
Information screen.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 133
File Transfer Scheduling Information Screen
Start Date
Specifies the date the transfer is to begin.
The start date can be defined in absolute or relative terms:
■
To define a start date in absolute terms, enter a numeric value in each of the
three fields labeled Day, Month and Year as follows:
Day
1 to 31 (a day of the month)
Month
1 to 12 (a month of the year interpreted according to the following
chart):
1
4
7
10
=
=
=
=
January
April
July
October
2
5
8
11
=
=
=
=
February
May
August
November
3
6
9
12
=
=
=
=
March
June
September
December
Year
nnnn (a four-digit designation for a year)
■
To define a start date in relative terms, enter a number in the range 1 to 999
in the field labeled Number of days from today. The number entered in this
field indicates that the transfer is to start in that many days from today (the
current date). For example, if you enter 1 in this field, the transfer starts one
day from today or tomorrow. Entering 7 in this field means that the transfer
is to start seven days or one week from now.
Default: Current date
134 User Guide
File Transfer Scheduling Information Screen
Start Time
Specifies the time the transfer is to begin.
hhmm
Specifies the hour and minute of the day when the transfer is to begin in the
24-hour clock format.
The range of values for the hour (hh) is 00-24. The range of values for the
minute (mm) is 00-59.
For example, to schedule a transfer to start at (not before) 2 p.m., specify
1400.
+hhmm
Specifies the transfer start time in terms of a number of hours (hh) and
minutes (mm) after the current hour and minute.
The range of values for the hour (hh) is 00-24. The range of values for the
minute (mm) is 00-59.
For example, if the current time is 1200 (noon), then specifying +0340 as
the transfer start time means that the transfer is to start 3 hours and 40
minutes after the current time, that is, at 3:40 p.m. (or 1540 in the 24-hour
clock format)
+mm
Specifies the transfer start time in terms of a certain number of minutes
(mm) after the current minute.
The range of values for the minute (mm) is 00-59.
For example, if the current time is 1710 (or 5:10 p.m.), then specifying +20
as the transfer start time means that the transfer is to start 20 minutes from
the current minute (10), that is, at 5:30 p.m. (or 1730 in the 24-hour clock
format).
Note: If no value (or a sequence of spaces) is entered in the Start Time field, the
start time defaults to the current time. If a value is entered in the Start Time
field, all digit positions indicated by the format must be filled. Thus, neither 1 nor
01 is a valid start time specification for 1 a.m.; the correct specification in this
case is 0100. Similarly, you cannot specify +5 to indicate that a transfer is to
start 5 minutes from now; instead, you must specify two digits, +05, as
indicated by the format (+mm).
Default: Current time
Chapter 1: The Menu Interface (TSO/ISPF Panels) 135
File Transfer Scheduling Information Screen
Selection Priority
Specifies scheduling (selection) priority for the file transfer.
1 to 255
Specifies scheduling (selection) priority for the file transfer. One is the lowest
priority.
Notes:
■
Do not confuse this parameter with Execution Priority, which applies after
the file transfer has begun executing.
■
In situations where multiple file transfer requests are eligible for initiation
(that is, they are past their start date/time), those with higher selection
priorities are scheduled first.
Default: 16
Hold
Prevents a queued transfer from executing until explicitly released by a Menu
Interface SELECT or operator console RELEASE command (both discussed later).
Y
Hold a queued transfer until released.
N
Do not hold a queued transfer.
Default: N
136 User Guide
File Transfer Scheduling Information Screen
Age
Overrides the CA XCOM Data Transport default purging interval, which is the
number of days this request can remain on the CA XCOM Data Transport queue
before being purged.
1 to 999
Specifies a number of days that the request can remain on the
CA XCOM Data Transport queue before being purged.
Notes:
■
The CA XCOM Data Transport queue includes file transfer requests with
future start dates, Hold status, or Suspended status. Automatic queue
purging is performed by CA XCOM Data Transport each time the CA XCOM
Data Transport server comes up and daily at midnight.
■
Aging is relative to the scheduled start date of the file transfer.
Default: As specified for the AGE parameter of the CA XCOM Data Transport
Default Options Table
Chapter 1: The Menu Interface (TSO/ISPF Panels) 137
Member Selection List
Member Selection List
The Member Selection List screen lists the members of a partitioned data set.
This list lets you select one or more of the members in the data set for transfer
to or from the remote system.
To display the Member Selection List screen
Specify the name of a partitioned data set without a member name in the Local
File Name field on any of the file transfer screens (Send MVS File To Another
System, Submit Job To Another System, Send Report To Another System, or
Receive File From Another System).
MEMBERLIST -------- DA1SZ95.XCOM.R11.5.SAMPLIB ---------- ROW 00001 OF 00036
COMMAND ===>
SCROLL ===> PAGE
NAME
Prompt
SIZE
CREATED
CHANGED
ID
@INDEX
42
08/03/20
08/03/20 17:03
XCOM
APPLXCOM
76
08/03/20
08/03/20 17:03
XCOM
ASM#TBLS
56
08/03/20
08/03/23 12:11
DA1EG79
ASMACF2U
44
08/03/20
08/03/20 17:03
XCOM
DEFHIST
136
08/03/20
08/04/07 11:41
DA1SZ95
DEFQSAM
45
08/03/20
08/04/07 11:43
DA1SZ95
DEFRRDS
51
08/03/20
08/04/07 11:37
DA1SZ95
DFHTCT
15
08/03/20
08/03/20 17:03
XCOM
INSTJCL
112
08/03/20
08/03/20 17:03
XCOM
ISR@PRIM
51
08/03/20
08/03/20 17:03
XCOM
LINKACF2
25
08/03/20
08/03/20 17:03
XCOM
SAMPCOB
88
08/03/20
08/03/20 17:03
XCOM
XCOM
17
08/03/20
08/03/20 17:03
XCOM
XCOMACF2
434
08/03/20
08/03/20 17:03
XCOM
XCOMADMT
25
08/03/20
08/03/23 11:23
DA1EG79
XCOMDEST
14
08/03/20
08/03/20 17:03
XCOM
XCOMDFLT
74
08/03/20
08/03/23 11:04
DA1EG79
XCOMEX01
102
08/03/20
08/03/20 17:03
XCOM
XCOMEX02
3516
08/03/20
08/03/20 17:03
XCOM
The display screen follows the format established for the ISPF Copy function
(ISPF Option 3.3) and contains two fields into which you can enter data:
Line command field (left of the member name)
Selects a member for a file transfer.
Enter a letter S in this field to select that member for file transfer.
Note: You can select MULTIPLE members be for transfer only if the Queue
for Execution field in the Primary Menu has been set to N, indicating that the
transfers are not to be queued, but to execute immediately.
User field (right of the member name)
Indicates a new name applicable when the member is stored on the remote
system; and displays the results of a member selection.
138 User Guide
Member Selection List
A value of *SELECTD indicates that CA XCOM Data Transport has
successfully selected this member and has generated parameters for its
transfer.
*NOTSEL indicates one of the following:
■
The member was not selected.
■
Multiple members were selected when the Queue for Execution field was
set to or defaulted to Y.
■
CA XCOM Data Transport has determined or assumed that the Remote
File is not a partitioned data set.
With multiple member selection, each member except the first is marked
*NOTSEL. (Only the first member is transferred.)
For *NOTSEL values, press the Help key (PF1/13) to see why the member
was not selected. Pressing the Help key again provides a definition of CA
XCOM Data Transport's selection criteria.
To exit the Member Selection List screen, press the END key (PF3). This initiates
the transfer request.
To exit the Member Selection List screen without initiating the transfer request,
enter CANCEL on the Command Line.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 139
Operator Control
Operator Control
The File Transfer Display Select screen is the entry point for displaying a list of
one or more of the following options:
■
Inactive file transfers; file transfers that have not started yet
■
Active file transfers; file transfers that are currently in progress
■
Completed file transfers
Use the display to view information and change the processing parameters
applicable to one or more file transfers.
------------------------------------------------------------------------------08/11/19
CA XCOM Release r11.5 SP00
USER01
08.324
File Transfer Display Select
08:57:57
------------------------------------------------------------------------------COMMAND ===>
Local System Identification
Server: 1234XCOM
Select Transfers ===>
Port:
Inactive
Active
Limit display to transfers for the following:
History System ID ===>
| History System Name
Requesting User ID ===> USER01
|
Request Number
Transfer ID ===>
|
Last Message
Local or Remote ===>
(L/R)
|
File Type
Transfer Type ===>
(S/R)
Remote System
ID ===>
TCP/IP ===>
Protocol: SNA
Completed
===>
===>
===>
===>
(J/R/F)
(Y/N)
Range Start Date ===> 20081119
Range End Date ===> 20081119
Range File Size ===>
(YYYYMMDD)
(YYYYMMDD)
(Min.)
Time ===> 000000
Time ===> 235959
===>
(HHMMSS)
(HHMMSS)
(Max.)
Maximum Entries: ===>
(NNNN)
------------------------------------------------------------------------------PFK 1/Help
3/End
Copyright (c) 2008 CA, INC.
140 User Guide
Operator Control
Selecting a Display Option
To display a list of file transfers from one or more categories
Type a non-blank character in front of each category (Inactive, Active,
Completed) that you want information about and press Enter.
Example
To display a list of all file transfers that are yet to start and those that are already
underway, place a non-blank character in front of the file transfer categories
Inactive and Active (For more information, see the XCOM Transfer Request
Display screen in this chapter.) The transfers appearing in the list include locally
initiated, remotely initiated, indirect, and third-party initiated file transfers.
Modifying the Filtering Options
You can filter the information displayed further by entering values in the other
fields on this screen. For example, if you want the status of a file transfer request
with transfer ID TUESUPDT, enter TUESUPDT in the transfer ID field and select
all transfer categories (Inactive, Active, Completed). This provides a display
containing any transfers, whether they are pending, in-progress, or completed,
with a transfer ID of TUESUPDT. You can further limit this list by selecting any
combination of the other filtering fields on this screen, as described below in
Parameter Fields.
The source for the file transfers to be displayed in the list depends on the value
in the APPLID of the CA XCOM Data Transport Server field in the Primary Option
Menu. By specifying the APPLID of another CA XCOM Data Transport server, you
can obtain a list of the pending, active and completed file transfers on that server
for display or modification purposes.
Note: If an APPLID is one of an XCOMPLEX Admin Server, you can display a list
of pending, active, and completed transfers for all XCOMPLEX Worker Servers
connected to the XCOMPLEX Admin Server. However, changes cannot be made
to this list of transfers; changes can only be made when looking at an individual
XCOMPLEX Worker Server transfer list.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 141
Operator Control
Parameter Fields
The entries in the fields of the File Transfer Display Select screen are used as
filters to limit the number of file transfer requests that appear in the CA XCOM
Data Transport Transfer Request Display screen. A blank in any field indicates
that the field should not be used as a filter (that is, file transfers with any value
in that field are displayed).
Note: You must fill in one of these parameter fields to access the history log. Do
not press Enter until you fill in at least one of these fields.
If you get a fatal VTAM error while attempting to communicate with the CA XCOM
Data Transport server, history log information is not displayed.
Note: Be specific in filtering the information displayed. This is especially
advisable at sites where there is considerable CA XCOM Data Transport activity.
Otherwise, screen displays could be cluttered with masses of irrelevant
information.
Parameters
This section describes the parameters that can be entered on this screen.
History System Id
Limits the file transfer requests displayed to those with the specified history
system ID in an XCOMPLEX environment.
Up to four characters
Specifies the system ID. History System Id and History System Name
together provide a unique system identifier.
Default: None
History System Name
Limits the file transfer requests displayed to those with the specified history
system name in an XCOMPLEX environment.
Up to eight characters
Specifies the system name. History System Id and History System Name
together provide a unique system identifier.
Default: None
142 User Guide
Operator Control
Requesting User ID
Limits the file transfer requests displayed to those requested under the authority
of the specified user ID.
Up to 12 alphanumeric characters
Specifies the user ID that requested the transfers you want to display.
Default: TSO user ID
Transfer ID
Up to 10 alphanumeric characters
Limits the file transfers displayed to those that match this transfer ID.
Default: All transfer IDs
Local or Remote
Use the Local or Remote field to restrict the search for file transfers to those that
are locally initiated or remotely initiated.
L
Restrict the search to locally initiated transfers only.
R
Restrict the search to remotely initiated transfers only.
Transfer Type
Use the Transfer Type field to restrict the search for file transfers to those that
are send or receive type transfers.
S
Restrict the search to send type transfers only.
R
Restrict the search to receive type transfers only.
Request Number
Up to six numeric characters
Limits the list to transfers that contain this specific request number.
Default: All request numbers
Chapter 1: The Menu Interface (TSO/ISPF Panels) 143
Operator Control
Last Message
Use the Last Message field to restrict the search for file transfers to those where
the last message matches the value specified.
For CA XCOM messages, provide the value in the format XCOMXNNNNS,
where:
XCOM
Indicates that the message is from CA XCOM Data Transport.
X
Is the system identifier.
NNNN
Is the message number.
S
Is the message severity, as follows:
I
Informational
W
Warning
E
Error
Note: You can also specify the value of this field with an * as the last character,
as in XCOMM* (which would match all CA XCOM Data Transport for z/OS
messages).
Default: *
File Type
Use the File Type field to restrict the search for file transfers to those that match
the specified value.
J
Restrict the search to file type job transfers only.
R
Restrict the search to file type report transfers only.
F
Restrict the search to file type file transfers only.
144 User Guide
Operator Control
Remote System ID
Limits the file transfers displayed to only those related to this remote system.
Up to 64 characters
Specifies either a specific logical unit name, a specific user, a group name, or
an IP name or address. The transfer is limited to this remote name.
Default: All remote system names
Remote System TCP/IP
Indicates the value specified in the Remote System ID field.
Y(es)
Specifies that the value in the Remote System ID field represents an IP name
or address.
N(o)
Specifies that the value in the Remote System ID field represents a specific
logical unit name, user, or group.
Default: All remote system names except IP values if Remote System ID filled
in.
Range Date
Specifies the period of time from which file transfer information is requested: the
year, month, and day, as in 20080212 (February 12, 2008).
yyyymmdd
For Start, specifies the start date of the period from which file transfer
information is requested.
For End, specifies the end date of the period from which file transfer
information is requested.
■
yyyy=year
■
mm=month
■
dd=day
For example, 20080212 indicates February 12, 2008.
Default:
■
All dates (when both the start and end date are unspecified).
■
Today's date (when no end date is specified).
Chapter 1: The Menu Interface (TSO/ISPF Panels) 145
Operator Control
Range Time
Specifies the period of time from which file transfer information is requested: the
hour, minute, and second, as in 102004 (10 AM 20 Min 04 Sec).
hhmmss
For Start, specifies the start time of the period from which file transfer
information is requested.
For End, specifies the end time of the period from which file transfer
information is requested.
■
nn=hour (00 to 23)
■
mm=minute (00 to 59)
■
ss=second (00 to 59)
For example, 142004 (2 PM 20 Min 04 Sec).
Default:
■
Start time defaults to 000000. Start of day.
■
End time defaults to 235959. End of day.
Range File Size
Use the File Size Range fields (Min. and Max.) to restrict the search for file
transfers to those that match a file size within the range specified.
NNNNNNNNN(N|X)
A 1- to 10-digit number, where the last digit can be either another numeric
digit or a 1-character qualifier, as listed below.
X
One of the following qualifiers:
■
B = Bytes
■
K = Kilobytes
■
M = Megabytes
■
G = Gigabytes
If no qualifier is specified, then bytes is assumed.
146 User Guide
Transfer Request Display Screen
Maximum Entries
Limits the number of file transfers displayed for a particular server or for each
XCOMPLEX Worker Server when the APPLID is of an XCOMPLEX Admin Server.
Up to four numeric characters
Specifies the maximum number of transfers for a certain server or for each
XCOMPLEX Worker Server when the APPLID is of an XCOMPLEX Admin
Server.
Transfer Request Display Screen
The XCOM Transfer Request Display screen provides information on the set of file
transfers defined on the File Transfer Display Select screen.
--------------CA XCOM Transfer Request Display------------------------ROW 1 OF 8
COMMAND INPUT ===>
SCROLL===>PAGE
CA XCOM Server: XCOMABC
Req
Trans
Prty
Where
Start
S Num
Type
Xfer-ID
SL EX
User ID
Started Date
Time Status
- ------ ------ --------- ------ ----------- -------- --------_---- -----001009
SENDFIL DA1SZ95I
16 16
DA1SZ95
LOCAL
20040828 1414 COMPLT
Remote System: LU30107
LOCL FILE: DA1SZ95.XCOM.R223.SAMPLIB(@INDEX)
REMT FILE: C:\XCOMDATA\@INDEX.SAM
001010
SENDFIL DA1SZ95I
16 16
DA1SZ95
LOCAL
Remote System: LU30107
LOCL FILE:DA1SZ95.XCOM.R223.SAMPLIB(APPLXCOM)
REMT FILE:C:\XCOMDATA\APPLXCOM.SAM
20040828 1413 COMPLT
001011
SENDFIL DA1SZ95I
16 16
DA1SZ95
LOCAL
Remote System: LU30107
LOCL FILE:DA1SZ95.XCOM.R223.SAMPLIB(ASM#TBLS)
REMT FILE:C:\XCOMATA\ASM#TBLS.SAM
20040828 1412 COMPLT
****************************** Bottom of data *********************************
F1=Help
F7=UP
F2=SPLIT
F8=DOWN
F3=End
F9=SWAP
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
Chapter 1: The Menu Interface (TSO/ISPF Panels) 147
Transfer Request Display Screen
Sorting Transfer Request Information
Initially, transfer request information is displayed in order of transfer request
numbers (Req Num). By using the SORT command, the initial display can be
sorted in several different ways. The format of the SORT command is as follows:
SORT sort_field
sort_field
One of the following sort criteria (the items in parentheses are valid
abbreviations):
DATE
Start date
LOCFILE (LF, LFILE)
Local file name
REMOTE (REMSYS, RMT, RSYS)
Remote system
REQNUM (RNUM)
Request number
REMFILE (RF, RFILE)
Remote file name
TIME
Start time
USERID (UID)
User ID
XFERID (XID)
Transfer ID
For example, to sort transfer request information by the remote file
name, one of the following commands needs to be entered in the
COMMAND INPUT field of the Transfer Request Display screen:
SORT REMFILE
SORT RF
SORT RFILE
148 User Guide
Transfer Request Display Screen
Locating a Request
You can locate a file transfer request and view its details.
To locate a particular file transfer request
Use the scroll keys PF7 (scroll up) and PF8 (scroll down) or the LOCATE
command, discussed later in this chapter in Using the LOCATE Command.
To view detailed information about the transfer
Type S or D in the S field and press Enter.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 149
Transfer Request Display Screen
Using the LOCATE Command
If you know some identifying attributes for a particular file transfer, you can use
the LOCATE command to position the display at that file transfer.
Enter a command of the following format on the COMMAND INPUT line:
LOC attribute_label identifier
Provide only one attribute label for each LOC entry. The allowable attribute labels
are as follows:
■
DATE (start date)
■
LOCFILE, LFILE, or LF (local data set)
■
REMFILE, RFILE, or RF (remote data set)
■
REMOTE, REMSYS, RSYS, or RMT (remote system name)
■
REQNUM or RNUM (request number)
■
TIME (start time)
■
USER ID or UID (local user ID)
■
XFERID or XID (transfer ID)
For example, to locate a file transfer with the request number 70342, enter the
following:
LOC RNUM 70342
The display is repositioned so that the file transfer whose request number is
70342 appears as the first entry on the screen.
The identifier of the LOCATE command can also contain a wildcard character, *
(asterisk), representing any character sequence. For example, the LOCATE
command LOC XID BOY* causes CA XCOM Data Transport to display all file
transfers whose transfer IDs (XID) begin with the three characters BOY (for
example, BOYCOTT, BOYD, BOYSCOUT, and so on).
150 User Guide
Transfer Request Display Screen
Unprotected (Control) Fields
Many of the fields on the CA XCOM Data Transport Transfer Request Display
screen are solely informational and cannot be altered (that is, they are
protected). However, some fields are unprotected and allow you to change
processing parameters for a file transfer.
Note: Modifications are only allowed when listing transfers for an individual
server, and not when listing transfers for all XCOMPLEX Worker Servers connect
to an XCOMPLEX Admin Server.
The unprotected fields are as follows:
■
S (selection command)
■
Prty SL (scheduling priority)
■
Prty EX (execution priority)
■
Start Time
■
Start Date
To change the current values in control fields, type over them.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 151
Transfer Request Display Screen
Selection Commands
Listed below are CA XCOM Data Transport's selection commands. To use a
selection command, type it in the column labeled S next to a transfer request
number (REQ NUM), and then press Enter.
S
Displays detailed information about a file transfer.
D
Displays detailed information about a file transfer.
C
Cancels a file transfer.
H
Holds a file transfer.
A
Releases a file transfer.
P
Suspends a file transfer.
R
Resumes a file transfer.
Protected (Display) Fields
Fields on the CA XCOM Data Transport Transfer Request Display screen that are
informational and cannot be overwritten have the same meanings as their
counterparts on the screens used to define a file transfer request.
Note: The USERID field displays the local user ID designated when this file
transfer request was made.
152 User Guide
Transfer Request Display Screen
Status Fields
The rightmost column on the CA XCOM Data Transport Transfer Status Display
screen indicates the status of each displayed file transfer. The terms used to
indicate transfer status in CA XCOM Data Transport are as follows:
ACTIVE
The transfer is currently in progress.
CANCLD
The transfer was cancelled before it began executing (compare with the
TERMTD status).
COMPLT
The transfer has completed successfully.
HELD
The transfer is being held and must be released manually to be eligible for
execution.
To release the transfer, enter A in the S field.
INACT
The transfer is pending and eligible to begin as soon as it reaches its start
time/date. If the transfer's start time has been reached and the transfer has
not started, CA XCOM Data Transport may be waiting for a session to
become available or be established, or the transfer request may not have
reached the top of the target system's queue.
LOCFER
The transfer could not commence because of a problem involving the local
file. (For example, it could not be accessed because of a security violation.)
To view the associated error messages, select a detailed display by entering
either S or D in the S column.
LOGCER
The transfer was aborted when the remote system detected a fatal
processing error. The remote system sends at least one descriptive error
message to this system.
To view the error messages, enter either S or D in the S column.
OTHERR
An error that did not fall into the LOCFER, LOGCER, or VTAMER categories
caused this transfer to fail.
To view the associated error messages, enter either S or D in the S column.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 153
Transfer Request Display Screen
REMSUS
The transfer was suspended by a user or an operator on the remote system.
SUSPND
The transfer was suspended by a user or an operator on the local system.
TERMTD
The transfer was terminated by a local operator console command.
*UNKN*
Contact CA XCOM Data Transport technical support if this status is indicated.
NETERR
The transfer was aborted because of a network error. The remote system
sends at least one descriptive error message to the initiating system.
To view the error messages, enter either S or D in the S column.
154 User Guide
Detailed File Transfer Display
Detailed File Transfer Display
Information about a particular file transfer request is displayed on a screen
similar to the one that follows.
To invoke the display for a transfer
Enter S or D next to the transfer in the S column of the CA XCOM Data Transport
Transfer Request Display.
CA XCOM RECEIVE FILE
COMMAND INPUT ===>
REQ.# 123456 QUEUED TUESDAY APR. 08, 2008
15:04:58
CA XCOM Server: XCOMABC
Sched. Start Time: TUESDAY APR.08, 2008
14:59:35
Transfer-ID: USERTEST
End Time: TUESDAY APR.08, 2008
23:11:53
Last Action: * NOT USED* Status: FILE ERROR Priority Sel: 016 Exec: 016
Compress Mode: YES
Trans. Time(Secs): 29538
Compress Factr: 06.6
Transfrd. Records: 32,246,874
Bytes: 3,224,687,500
Bytes/Sec: 109170
Compress Bytes: 3,289,181,250
Last Ms: XCOMM0221E DATASET OUT OF SPACE
ABEND
----- S E N D I N G
S Y S T E M
I N F O R M A T I O N -------------------System ID: 123.123.123.123
User ID: USER01
Notify ID: N/A
Unit:
Volume:
File Type
File Name: C:\USERS\ABC\6GB
----- R E C
System ID:
User ID:
Unit:
File Name:
E I V I N G
*LOCAL*
USER02
F1=Help
F7=UP
F2=SPLIT
F8=DOWN
S Y S T E M
XCOM.USER02.TEST
I N F O R M A T I O N ----------------
Domain:
Volume: SAMP
F3=End
F9=SWAP
Notify ID: N/A
Option: CREATE
F4=RETURN
F5=RFIND
F10=Language F11=Hold
F6=RCHANGE
F12=Alloc
If the transfer is in progress, the cumulative number of records transferred and
elapsed time are displayed.
If the transfer request is completed, the total number of records transferred and
elapsed time, and the date and time of completion are displayed.
To refresh these fields for an active transfer, press Enter.
The display consists of three sections:
■
Common information-independent of transfer type
■
Sending system information-dependent on transfer type
■
Receiving system information-dependent on transfer type
Chapter 1: The Menu Interface (TSO/ISPF Panels) 155
Detailed File Transfer Display
Common Section Information Fields
The common section contains detailed information and statistics pertaining to a
file transfer request. The information contained in this section is common to all
file transfer requests.
The common section fields are as follows:
Heading Line
The heading line of the display describes the type of file transfer request
(SEND/RECEIVE FILE/REPORT/JOB), the request number associated with
the request, and the day, date, and time that the request was queued.
Sched. Start Time
The day, date, and time that the transfer is, or was, scheduled to begin.
Transfer-ID
The transfer ID that was entered with, or assigned to, the request.
End Time
If the transfer completed successfully or unsuccessfully, this field contains
the day, date, and time that the transfer ended.
Last Action
This field is not currently used.
Status
The status of the request. (For a definition of the possible entries in this field,
see Status Fields in this chapter.)
Priority Sel/Exec
The selection and execution priorities assigned to the transfer.
Compression Mode
The compression method used.
Transfrd. Records
The number of records transferred.
Bytes
The total number of bytes transferred.
Compress Bytes
The number of bytes transferred after data compression was performed on
the records.
Trans. Time (Secs)
The duration of the file transfer (in seconds).
156 User Guide
Menu Interface Messages
Bytes/Sec
The rate, in bytes per second, at which the transfer was accomplished.
Compress Factor
The percentage of compression that was accomplished by the CA XCOM Data
Transport data compression routines (compressed bytes divided by
transferred bytes).
Last Ms
The last message issued by CA XCOM Data Transport about the transfer.
Sending/Receiving System Information
The sending/receiving sections display the parameters that were entered when
the file transfer was submitted (data set name, system ID, user ID, and so on).
In addition, the Sending System Information or the Receiving System
Information line is highlighted to indicate the system that initiated the file
transfer.
If neither line is highlighted, this was a third-party transfer initiated by a system
other than the two displayed here.
Menu Interface Messages
CA XCOM Data Transport comes with a set of messages in standard ISPF/PDF
format to assist the Menu Interface user. The complete list of these messages is
found in CAI.CBXGMSG0(XCOM00). These messages alert you to errors such as
failing to specify a required parameter or entering an invalid parameter value or
command. The short form of the message is displayed in the upper right corner
of a panel. You can display the long form of the message on line 3 of a panel by
entering the ISPF HELP command or pressing the Help key (usually PF1 or PF13).
The messages are self-explanatory.
Chapter 1: The Menu Interface (TSO/ISPF Panels) 157
Chapter 2: The Batch Interface
This chapter describes how CA XCOM Data Transport is invoked from a batch job
to execute a file transfer. All local and remote z/OS users can send and retrieve
data files between z/OS and other z/OS or non-z/OS systems using the CA XCOM
Data Transport Batch Interface. In addition, all local z/OS users can use the
Batch Interface to send jobs and reports for processing to remote systems.
This section contains the following topics:
Special Features (see page 159)
XCOMJOB Sample JCL (see page 160)
XCOMJOB DD Statements (see page 162)
XCOMJOB Parameter Classes (see page 166)
PARM Parameters (see page 166)
SYSIN01 Parameters (see page 187)
Special Features
The Batch Interface supports all CA XCOM Data Transport features, including the
following special features:
Third-Party Processing
Third-party processing involves a situation where a system is used to arrange for
a second system to send a file, job, or report to a third system at a specified
future time if not immediately.
For important information about third-party processing, see the description of
the parameters STCAPPL (in the section PARM Parameters), LPASS, and LUSER
(in General SYSIN01 Parameters).
Broadcast Distributions
A file can be sent to multiple targets (a broadcast list) at the same time. For
important information on broadcast distributions, see the description of the
parameter LIST (in the section PARM Parameters).
Chapter 2: The Batch Interface 159
XCOMJOB Sample JCL
Interdependent Transfers
CA XCOM Transfer Control, referred to as XTC processing, makes use of transfer
parameters allowing interdependent transfers to be defined as a single group.
Transfers in the same group can be held, purged, or released depending on the
successful or unsuccessful completion of other transfers in the group.
For important information about XTC processing, see the sections SYSIN01
Transfer Control (XTC) Parameters and Coding Interdependent Transfers.
User-Specified Checkpoints
For important information about user-specified checkpoints, see the description
of the parameter CKPT (in the section General SYSIN01 Parameters).
Batched Multiple Transfers
For important information about batched multiple transfers, see the description
of the parameters CONTINUE (in the section PARM Parameters) and NEWXFER
(in the section General SYSIN01 Parameters).
XCOMJOB Sample JCL
The CA XCOM Data Transport samples library contains the following sample
XCOMJOB job streams:
Type of Request
Name of the Sample Job
TYPE=EXECUTE
CAI.CBXGJCL(XCOMJOBE)
TYPE=SCHEDULE
CAI.CBXGJCL(XCOMJOBS)
CAI.CBXGJCL(XCOMJOXS) for XCOMPLEX Admin Server
TYPE=INQUIRE
CAI.CBXGJCL(XCOMJOBI)
CAI.CBXGJCL(XCOMJOXI) for XCOMPLEX Worker Server
TYPE=HISTORY
CAI.CBXGJCL(XCOMJOBH)
Copies of these sample job streams are provided in the appendix ―Sample Files.‖
For more information about the transfer request types, see the TYPE parameter
in PARM Parameters in this chapter.
160 User Guide
XCOMJOB Sample JCL
XCOMJOB TYPE=EXECUTE Sample
In the XCOMJOB TYPE=EXECUTE sample, a file from the local system is sent to
replace a file on a remote system through the execution of a non-queued CA
XCOM Data Transport transfer. The EXEC statement includes a PARM parameter
used to pass instructions to XCOMJOB concerning the ACB name.
XCOMJOB TYPE=SCHEDULE Samples
In the XCOMJOB TYPE=SCHEDULE samples, a file from the local system is sent
to replace a file on a remote system through the execution of a queued CA XCOM
Data Transport transfer. The EXEC statement includes a PARM parameter used
to pass instructions to XCOMJOB concerning the ACB name.
XCOMJOB TYPE=INQUIRE Samples
In the XCOMJOB TYPE=INQUIRE samples, the job uses TYPE=SCHEDULE to
initiate two file transfers and TYPE=INQUIRE to examine the status of those file
transfers.
TYPE=INQUIRE does not initiate file transfers, unlike the TYPE=EXECUTE and
TYPE=SCHEDULE modes, but examines the status of transfers that were
previously initiated by TYPE=SCHEDULE. It waits until the transfers have
completed and issues a return code reflecting the status of the transfers.
The primary use of TYPE=INQUIRE is in batch job streams where some job steps
are dependent upon the successful completion of other job steps that transfer
files. The dependent steps can execute conditionally based on the return code
issued by TYPE=INQUIRE.
When you schedule a transfer, you must include the INQUIRE data set in that
JCL. CA XCOM Data Transport schedules the transfer and writes the request
number and a time stamp into the INQUIRE data set. In the INQUIRE step, you
must reference the same INQUIRE data set. You must at least steplib to that
same library in your CA XCOM Data Transport start-up JCL. It is essential that
the CA XCOM Data Transport started task accesses the same maintained
libraries as the INQUIRE step accesses. Make sure that this library occurs first in
any concatenation.
Chapter 2: The Batch Interface 161
XCOMJOB DD Statements
The INQUIRE process then interrogates the CA XCOM Data Transport server to
locate the transfer. It examines the transfer requests every 10 seconds until the
amount of time specified in the SYSIN01 parameter INQWAIT has elapsed. (See
the SYSIN01 parameter INQWAIT for details.) If the transfer is pending or
active, it is listed in the CA XCOM Data Transport RRDS. If the transfer has
completed, whether successful or unsuccessful, it is logged in the CA XCOM Data
Transport history file. Both the request number and the time stamp for that
transfer are used to search for the transfer. The return code passed back by the
INQUIRE step is determined by where the transfer was found and the actual
status of the transfer.
TYPE=INQUIRE removes request numbers from the XCOMINQ file if the requests
are complete or not found. Request numbers for transfers that have not
completed are not removed from the XCOMINQ file.
The XCOMINQ data set must be preallocated using ISPF or IEBGENER. The file
cannot be created in a job step. There is sample JCL to define the inquire data set
in CAI.CBXGJCL(DEFINQ). Define a unique INQUIRE data set for each set of
transfers.
Note: It is important to be consistent when using TYPE=INQUIRE in an
XCOMPLEX environment or it does not work properly. If the TYPE=SCHEDULE
goes directly to an XCOMPLEX Worker Server, then the TYPE=INQUIRE must
also be done against the XCOMPLEX Worker Server. If the TYPE=SCHEDULE
goes through the XCOMPLEX Admin Server, then the TYPE=INQUIRE must also
be sent to the XCOMPLEX Admin Server.
XCOMJOB TYPE=HISTORY Sample
In the XCOMJOB TYPE=HISTORY sample, history records are first retrieved
based on the criteria specified using SYSIN01 parameters. For a description of
these parameters, see SYSIN01 Parameters Required by TYPE=HISTORY.
The second step in the XCOMJOB TYPE=HISTORY sample then passes those
history records to the sample CA Easytrieve report distributed as part of the CA
XCOM Data Transport installation.
XCOMJOB DD Statements
This section explains the DD statements used in XCOMJOB JCL.
162 User Guide
XCOMJOB DD Statements
LCLDS01
Defines the local data set available for the transfer request.
The preferred alternative to using the LCLDS01 DD statement is to define the
data set using the LFILE parameter in the SYSIN01 DD statement (see below). If
you enter both the LCLDS01 DD statement and the SYSIN01 LFILE parameter,
the LFILE parameter takes precedence.
You should use the LFILE SYSIN01 keyword parameter to specify the local file
name for TYPE=SCHEDULE transfers. While you can specify the local file name
using the LCLDS01 DD statement even for TYPE=SCHEDULE transfers, there are
several potential complications to consider:
■
When LCLDS01 is used to reference a local file for a transfer, the z/OS JCL
processor is involved in the data set allocation process for the transfer. It is
possible to encounter problems with data set enqueues being held by z/OS
allocation routines while the transfers are being scheduled.
■
If the transfer begins to run on the started task before the job scheduling
transfer ends, the data set may not be available for exclusive use by the CA
XCOM Data Transport started task. This may cause the transfer to fail due to
an unavailable exclusive enqueue.
■
Using LCLDS01 to reference a local file for a transfer may also lead to the
creation of dummy GDGs.
If the LCLDS01 DD is used to create a +1 GDG version for a
TYPE=SCHEDULE transfer there are additional potential problems:
–
When the z/OS JCL performs the allocation of the LCLDS01 DD, it
allocates and potentially catalogs the new version, depending on the
value of the DISP parameter in the JCL. This new version does not have
an end-of-file mark because it has not yet been opened and closed by a
program.
–
When the transfer begins on the CA XCOM Data Transport started task,
it allocates a new +1 version of the GDG. In cases where the transfer is
successful, this results in the creation of two new generations of the
GDG. The first version contains garbage because it was allocated by the
z/OS JCL processor and was never opened or closed by a program to
write an end-of-file mark. If the transfer fails, under certain conditions
the version allocated by the CA XCOM Data Transport started task may
be deleted. This leaves the version of the GDG allocated by the z/OS JCL
processor as the current version.
All of these potential problems can be avoided if the LOCAL FILE name is
specified on the LFILE SYSIN01 parameter, rather than with the LCLDS01 DD
statement for TYPE=SCHEDULE transfers.
The LCLDS01 DD statement permits sequential data sets to be concatenated for
TYPE=EXECUTE requests. Other types of data sets cannot be concatenated.
Chapter 2: The Batch Interface 163
XCOMJOB DD Statements
If it is necessary to send more than one data set to the same remote file using
non-sequential data sets or if the transfer is a TYPE=SCHEDULE request, the CA
XCOM Data Transport Transfer Control (XTC) facility should be used (see the
sections SYSIN01 Transfer Control (XTC) Parameters and Coding
Interdependent Transfers).
Note: The SYSOUT keyword cannot be used in this DD statement.
JOBLIB or STEPLIB
Defines the library containing CA XCOM Data Transport load modules and, if CA
XCOM Data Transport is used with the TCP/IP option, the Language Environment
libraries.
A JOBLIB or STEPLIB statement should be included to identify the CA XCOM Data
Transport load library. If you are using CA XCOM Data Transport with the TCP/IP
option, the Language Environment libraries must be concatenated next.
This DD statement is not required if CA XCOM Data Transport is in the LNKLST
concatenation.
SYSIN01
Defines all of the CA XCOM Data Transport parameters associated with a file
transfer request. Required.
SYSPRINT
Identifies the data sets used for TCP/IP messages.
SYSTCPD
Provides information about the configuration of the TCP/IP protocol. This
information is used by TCP/IP to define parameters such as DNS server
resolution.
164 User Guide
XCOMJOB DD Statements
XCOMGLOB
Records the current request number of an immediate transfer (that is,
TYPE=EXECUTE). When the XCOMGLOB DD statement for a TYPE=EXECUTE
transfer is missing, the request number always defaults to 2000. Sites can share
this data set between jobs to ensure that all TYPE=EXECUTE transfers are
assigned a unique request number. To update the request number for immediate
transfers from TSO/ISPF, the XCOMGLOB and XCOMREST allocated files must be
in the user's TSO logon procedure. CA XCOM Data Transport ignores the
XCOMGLOB DD statement when queued transfers (TYPE=SCHEDULE) are
initiated.
To use this facility, create a fixed-block sequential data set containing an 80-byte
record. It is recommended that this file be included when running
TYPE=EXECUTE transfers utilizing the checkpoint/restart feature, to ensure that
the request number is unique. This allows the session partner to correctly
identify the checkpoint data when an interrupted transfer is restarted.
The same global data set should be used for all TYPE=EXECUTE job streams that
run under the same ACBNAME.
XCOMHOUT
Records the History records retrieved by a TYPE=HISTORY job stream.
If requested by use of the HISTORY_WRITE parameter in the default options
table, XCOMHOUT also records the transfer requests for TYPE=INQUIRE jobs.
You can share this data set between TYPE=INQUIRE jobs for your site to ensure
that all transfer requests from individual TYPE=INQUIRE jobs are recorded in a
common XCOMHOUT to be used to generate a report.
To use this facility, create a fixed block sequential data set containing a
2020-byte record. For more information, see the sample TYPE=HISTORY JCL in
the appendix "Sample Files."
Note: You can change the XCOMHOUT DD name by specifying an alternate DD
name, using the HISTORY_OUT_DD parameter in the default option table.
XCOMINQ
Records the request numbers for TYPE=SCHEDULE transfers.
XCOMPRNT
Records the IEBCOPY output when doing PDSE (PROGLIB=YES) transfers.
Chapter 2: The Batch Interface 165
XCOMJOB Parameter Classes
XCOMREST
Records the restart information for TYPE=EXECUTE file transfers. If a file
transfer fails due to a restartable condition such as a line failure, the XCOMREST
file holds the information needed to restart the file transfer request from the last
checkpoint. If you do not enter the XCOMREST DD statement in the JCL, the
restart of a TYPE=EXECUTE request is not supported by CA XCOM Data
Transport.
The XCOMREST DD statement should not be used with TYPE=EXECUTE transfers
that have specified CONTINUE=YES in the PARM statement with one or more
NEWXFER statements in the SYSIN01 data set. Such requests cannot be
restarted in a reliable manner.
This data set should be a single 2020-byte, one-record, sequential file, and must
not be a member of a PDS. A unique XCOMREST data set is required for each
transfer.
XCOMJOB Parameter Classes
The batch interface for CA XCOM Data Transport makes available a large number
of transfer control parameters. They are divided into two classes, based on
where they can be used in the XCOMJOB JCL. One set of parameters can be
specified only in the PARM field of the EXEC statement, and the other can be
specified only in the SYSIN01 DD statement. These two sets of parameters are
known as PARM parameters and SYSIN01 parameters.
A few batch interface parameters have a dual status and can be specified both in
the PARM field and the SYSIN01 DD statement. However, if a parameter is used
as a PARM and a SYSIN01 parameter in the same XCOMJOB JCL, its use in the
SYSIN01 statement takes precedence over its use in the PARM field. Likewise, a
parameter's specification in the CA XCOM Data Transport control library,
CAI.CBXGPARM, overrides its PARM field specification. PARM parameters, on the
other hand, override their counterparts in the Default Options Table, which is the
lowest level in the hierarchy of the CA XCOM Data Transport parameter
categories.
In the following sections, the PARM parameters and the SYSIN01 parameters are
described.
PARM Parameters
This section describes the PARM parameters, which are specified in the PARM
field of the EXEC statement.
166 User Guide
PARM Parameters
ACBNAME
Identifies the VTAM ACBNAME opened by CA XCOM Data Transport.
xxxxxxxx
Specifies up to eight alphanumeric characters that identify the VTAM
ACBNAME.
Notes:
■
If the ACBNAME is seven or eight characters, CA XCOM Data Transport
assumes it is an exact name. If it is six characters or less, CA XCOM Data
Transport assumes it is a generic name and appends a two-digit numeric
suffix from 00 to 99. This suffix is derived from the number of batch jobs still
in the process of being executed. The indicated ACBNAME must be a valid
VTAM ACBNAME; otherwise the transfer fails and error messages are written
to the job log.
■
Only one file transfer using the APPLID can be active at a time. All others wait
until the APPLID becomes available (no time-out occurs in this case). We
recommend indicating a generic APPLID, because it allows up to 1000
concurrent file transfers.
■
Leaving this parameter unspecified allows the value of the JOBACB
parameter in the CA XCOM Data Transport Default Options Table to govern.
Chapter 2: The Batch Interface 167
PARM Parameters
COMPNEG
Specifies whether compression negotiation is performed.
YES
Specifies that the data compression method is negotiated.
NO
Specifies that the data compression method is not negotiated.
Notes:
■
If COMPNEG=YES and the compression method suggested by the initiator or
partner LU is known to both participants, that method is used to compress
the transfer data.
■
If the suggested compression method is not known to a participant involved
in the transfer, Run-Length Encoding of blanks and zeros (that is,
COMPRESS=YES-see the next section) is applied to the data to be
transferred. Also, z/OS-initiated transfers to a partner defined in the
XCOMCNTL destination member as a version 1 node use COMPRESS=YES if
an unsupported compression method (COMPACT, COMPACTL, RLE,
HUFFMAN, ZLIB(n), LZRW3) is coded.
■
If an unknown compression type is requested, the file transfer is rejected.
Default: YES
168 User Guide
PARM Parameters
CONTINUE
Tells CA XCOM Data Transport how to proceed if a processing error is
encountered during multi-transfer processing.
YES
Tells CA XCOM Data Transport to start the next transfer in a multi-transfer
request. If this request is resubmitted, CA XCOM Data Transport resumes
from the initial transfer in the multi-transfer request.
NO
Tells CA XCOM Data Transport not to start any remaining transfers in the
multi-transfer request.
If this request is resubmitted because of a VTAM error, CA XCOM Data
Transport resumes with the failed transfer.
If a logic error occurred, CA XCOM Data Transport resumes with the next
transfer.
Notes:
■
This parameter is used in conjunction with the SYSIN01 parameter
NEWXFER.
■
CA XCOM Data Transport can only continue a resumed transfer from the
point of failure if the XCOMREST and XCOMGLOB DD statements have been
correctly defined. Otherwise, it resumes at the beginning of the transfer.
Default: YES
DFLTAB
Indicates the name of the default table to be loaded and used by the CA XCOM
Data Transport server.
XCOMDFLT
Specifies the default table XCOMDFLT.
xxxxxxxx
Specifies the name of the default table other than XCOMDFLT. This name can
be up to eight alphanumeric characters long.
Default: XCOMDFLT
Chapter 2: The Batch Interface 169
PARM Parameters
DISPALG
Indicates how to dispatch tasks that are ready for execution.
ROTATE
Tells the CA XCOM Data Transport server to proceed to the next NSA and to
dispatch it (if it is dispatchable).
NORMAL
Tells the CA XCOM Data Transport server to scan the NSA from the top for
the next dispatchable NSA.
Notes:
■
This parameter is valid only for the CA XCOM Data Transport server Job.
■
DISPALG has no effect on the XCOMPLEX Admin Server.
Default: ROTATE
DOMAIN
Identifies the Windows domain server used to validate the remote user ID and
password.
Up to 15 alphanumeric characters
Specifies the domain server used to validate the remote user ID and
password.
Default: None
Note: Valid with TYPE=EXECUTE and with transfers to Windows only.
DUMPCL
Indicates the SYSOUT class for snap dumps, trace data, and other diagnostic
information.
x
Specifies one alphanumeric character representing a valid SYSOUT class.
170 User Guide
PARM Parameters
EDESC
Specifies the 16 bits (coded in hexadecimal) of a z/OS message descriptor code.
Value
(hexadecimal)
Descriptor Definition
Codes
8000
1
System failure
4000
2
Immediate action required
2000
3
Eventual action required
1000
4
System status
0800
5
Immediate command response
0400
6
Job status
0200
7
Application program processor
0100
8
Out-of-line message
0080
9
Status display
0040
10
Dynamic status display
0020
11
Critical eventual action required
0010
12
Important information message
13
Reserved for future use
Note: The message descriptor codes are selected by the bit configuration, where
bit 0 corresponds to descriptor code 1. These codes are assigned to error
messages ending with "E". The descriptor code is used by CA XCOM Data
Transport when issuing WTO macro instructions. z/OS inserts an indicator at the
start of the message. The indicator is a blank space followed by a "+" sign.
Default: 0200
EROUT
Specifies the sixteen bits (coded in hexadecimal) of z/OS console routing codes
for messages ending with E. The following are available routing codes:
Value
(hexadecimal)
Descriptor
Codes
8000
1
Definition
Master console action
Chapter 2: The Batch Interface 171
PARM Parameters
Value
(hexadecimal)
Descriptor
Codes
Definition
4000
2
Master console information
2000
3
Tape pool
1000
4
Direct access pool
0800
5
Tape library
0400
6
Disk library
0200
7
Unit record pool
0100
8
Teleprocessing control
0080
9
System security
0040
10
System error/maintenance
0020
11
Programmer information
0010
12
Emulators
0008
13
Installation use
0004
14
Installation use
0002
15
Installation use
0001
16
Installation use
0000
none
For CA XCOM Data Transport use only
Codes are selected by bit configuration, where bit 0 corresponds to Routing
Code 1, bit 1 corresponds to Routing Code 2; that is, at z/OS system generation,
each operator's console is assigned routing codes corresponding to the functions
that the installation wants that console to perform.
Specifying EROUT=0000 in the Default Options Table or as part of the PARM field
of the EXEC JCL statement causes the suppression of all XCOMMnnnnE messages
from the SYSLOG, and most error messages generated by XCOMJOB. All
messages continue to be a part of the CA XCOM Data Transport log.
Default: 4020
172 User Guide
PARM Parameters
GROUP
Tells CA XCOM Data Transport to use the pooled LU feature to allow for
multi-threading of transfers to nodes that support multiple logical units but not
parallel sessions.
xxxxxxxx
Specifies the name of a group of LUs. The name can be eight characters long.
The first character of the name must be alphabetic, while the rest can be any
combination of alphanumeric or national characters.
Notes:
■
GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of
these parameters must be coded (either on the EXEC card or in SYSIN01);
however, coding more than one causes an error.
■
The group must be predefined in the CA XCOM Data Transport control library
(CAI.CBXGPARM). When the transfer process begins, CA XCOM Data
Transport tries transferring to the first LU in the group. If that attempt fails,
the second LU is tried. If that transfer attempt fails, the third LU is tried, and
so on. However, as soon as CA XCOM Data Transport finds an LU that is
available for the partner node, it transfers the data to that LU and stops
making any further transfer attempts.
■
Group processing is supported for TCP/IP transfers but only for a single IP
address. In this way, an alias can be defined within CA XCOM Data Transport
for an IP address.
■
When GROUP= or LIST= is used, the value for IPPORT is determined by
either the destination member or the default table.
■
Session establishment is subject to a time-out limit defined on the TIMEOUT
parameter. See the description of this parameter later in this section.
HISTDD
Identifies the DDNAME of the data set to contain the selected history records.
xxxxxxxx
Specifies up to eight alphanumeric characters that identify the history DD
name.
Default: If the HISTDD parameter is not specified, the HISTORY_OUT_DD
parameter value defined in the default options table is used.
Chapter 2: The Batch Interface 173
PARM Parameters
IDESC
Specifies the 16 bits (coded in hexadecimal) of a z/OS message descriptor code.
Value
(hexadecimal)
Descriptor
Codes
Definition
8000
1
System failure
4000
2
Immediate action required
2000
3
Eventual action required
1000
4
System status
0800
5
Immediate command response
0400
6
Job status
0200
7
Application program processor
0100
8
Out-of-line message
0080
9
Status display
0040
10
Dynamic status display
0020
11
Critical eventual action required
0010
12
Important information message
13
Reserved for future use
Notes:
■
The codes are selected by the bit configuration, where bit 0 corresponds to
descriptor code 1, bit 1 to descriptor code 2. These codes are assigned to
messages ending with I.
■
For more information, see the EDESC parameter.
Default: 0200
174 User Guide
PARM Parameters
IPNAME
Identifies the IP address of the remote system for a TCP/IP transfer.
1 to 64 alphanumeric characters
Specifies the name or address of the remote TCP/IP system involved in a
transfer. This name can contain up to 63 alphanumeric characters and it
must be one that has been defined to the domain name server. The address
can be in IPv4 or IPv6 notation.
Note: GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of
these parameters must be coded (either on the EXEC card or in SYSIN01).
Coding more than one causes an error.
IPPORT
Identifies the IP port of the remote system for a TCP/IP transfer.
1 to 65535
Specifies a number indicating the TCP/IP port used when IPPORT is omitted.
Default: 8044
Notes:
■
This parameter must match the SERVPORT specification of the target server
and normally should not be changed.
■
When GROUP= or LIST= is used, the value for IPPORT is determined by
either the destination member or the default table.
IROUT
Specifies the sixteen bits (coded in hexadecimal) of a z/OS console routing code.
Value
(hexadecimal)
Descriptor
Codes
Definition
8000
1
Master console action
4000
2
Master console information
2000
3
Tape pool
1000
4
Direct access pool
0800
5
Tape library
0400
6
Disk library
Chapter 2: The Batch Interface 175
PARM Parameters
Value
(hexadecimal)
Descriptor
Codes
Definition
0200
7
Unit record pool
0100
8
Teleprocessing control
0080
9
System security
0040
10
System error/maintenance
0020
11
Programmer information
0010
12
Emulators
0008
13
Installation use
0004
14
Installation use
0002
15
Installation use
0001
16
Installation use
0000
None
For CA XCOM Data Transport use only.
Notes:
■
The console routing codes are selected by the bit configuration, where bit 0
corresponds to routing code 1, bit 1 to routing code 2, and so on. These
codes are assigned to messages ending with I.
■
Specifying IROUT=0000 in the Default Option Table or as part of the PARM
field of the EXEC JCL statement causes the suppression of all XCOMMnnnnI
messages, with the exception of XCOMM0056I and XCOMM0001I from the
SYSLOG, and most informational messages generated by XCOMJOB. All
messages continue to be a part of the CA XCOM Data Transport log.
Default: 4020
176 User Guide
PARM Parameters
LIST
Broadcasts the file transfer to all remote destinations designated on a predefined
distribution list.
xxxxxxxx
Specifies the name of a list of destinations to which the file is to be
transferred. The name can be up to eight alphanumeric characters long.
Notes:
■
GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of
these parameters must be coded (either on the EXEC card or in SYSIN01).
Coding more than one causes an error.
■
When a transfer is performed to a destination defined as a list of LUs or IP
addresses, the data is transferred to each LU or IP node in the list.
■
When GROUP= or LIST= is used, the value for IPPORT is determined by
either the destination member or the default table.
■
The LIST parameter is valid only for TYPE=SCHEDULE transfers.
■
Because a transfer to a list destination is processed as a queued request, the
various file transfers involved might have different start times. Use the CA
XCOM Data Transport Operator Control function on the Menu Interface to
check the current status of any broadcast distribution.
Using a Superlist
Specifying the name of a superlist for the LIST parameter broadcasts the file
transfer to all remote destinations designated on a predefined distribution
superlist, or list of lists.
Up to 32720 bytes
XCOM LIST names are names of members in the XCOMCNTL data set and
therefore are limited to eight alphanumeric characters.
XCOM lists are limited to 32720 bytes of storage, consisting of the following:
■
A 32-byte storage descriptor, leaving 32688 bytes for the list.
■
Each list entry occupies 4 to 10 bytes:
–
1 byte for the TYPE
–
1 flag byte
–
1 byte for the LENGTH
–
1 to 8 bytes for the name of the list
If each member name specified as a LIST/SUPERLIST is eight characters
long, then a SUPERLIST can include 2971 member names.
Chapter 2: The Batch Interface 177
PARM Parameters
LOG
Specifies whether a log of CA XCOM Data Transport activity is written to SYSOUT.
YES
Write a log of CA XCOM Data Transport activity to SYSOUT.
NO
Do not write a log of activity.
Note: Unless LOG=NO is coded, the CA XCOM Data Transport activity log
includes a list of the SYSIN01 parameters used for the file transfer, except for the
PASSWORD parameter value, which is omitted for security reasons.
Default: YES
LOGCLASS
Indicates the desired SYSOUT class to which the CA XCOM Data Transport log is
written.
X
Specifies the SYSOUT class X.
x
Specifies a SYSOUT class other than X. This class can be represented with
any alphabetic character.
You can also specify an asterisk (*), which writes the CA XCOM Data
Transport log to the same class as this job's JCL MSGCLASS.
Default: X
LOGDEST
Indicates the SYSOUT destination to which the CA XCOM Data Transport log is
sent.
xxxxxxxx
Specifies the name of the SYSOUT destination to which the CA XCOM Data
Transport log is sent. The name can be eight alphanumeric characters long.
Note: For more information on LOGDEST, see the description of this parameter
in the CA XCOM Data Transport Default Options Table in the CA XCOM Data
Transport for z/OS Administration Guide.
178 User Guide
PARM Parameters
LOGMODE
Overrides the mode name set in the CA XCOM Data Transport Default Options
Table if the DLOGMOD parameter is set to the value of XCOM.
xxxxxxxx
Specifies up to eight alphanumeric characters representing the mode name.
Notes:
■
If DLOGMOD=VTAM, this parameter is ignored.
■
For more information on LOGMODE, see the description of this parameter in
the CA XCOM Data Transport Default Options Table in the CA XCOM Data
Transport for z/OS Administration Guide.
LU
Defines the remote system's LU name and associated VTAM logical unit name.
xxxxxxxx
Specifies up to eight alphanumeric characters indicating the remote and
associated VTAM LU name.
Note: GROUP, LIST, LU, and IPNAME are mutually exclusive parameters. One of
these parameters must be coded (either on the EXEC card or in SYSIN01).
Coding more than one causes an error.
NETNAME
Specifies the name passed by CA XCOM Data Transport to remote systems in
CINIT or BIND vectors to override the PLU name in the user portion of the BIND.
This is required for some systems, such as AS/400. For detailed information, see
specific system components.
xxxxxxxx
Specifies up to eight alphanumeric characters indicating a name to override
the PLU name for remote systems in CINIT and BIND vectors.
Note: Do not confuse this parameter with the VTAM parameter NETID.
Default: XCOMAPPL
PSOPREF
Specifies the high level qualifier to use to create a temporary data set.
Chapter 2: The Batch Interface 179
PARM Parameters
REPCR
Specifies whether CA XCOM Data Transport is to attempt to do a CREATE when
receiving a transfer with FILEOPT=ADD|REPLACE and the data set does not
exist.
YES
Specifies that CA XCOM Data Transport will attempt to do a CREATE when
receiving a transfer with FILEOPT=ADD|REPLACE and the data set does not
exist.
NO
Specifies that CA XCOM Data Transport will fail the transfer when receiving a
transfer with FILEOPT=ADD|REPLACE and the data set does not exist.
Default: NO
Notes:
■
The REPCR default parameter can be specified in the default table or
overridden by the XCOMJOB/XCOMXFER EXEC parameter.
■
The value of REPCR can also be modified using the operator DFLT command.
SECURE_SCHEDULE
Specifies whether a secure (SSL) TCP/IP connection is to be used to perform the
SCHEDULE or INQUIRE operation against the target server.
YES
A secure (SSL) TCP/IP connection is to be used by XCOMJOB to connect to
the target server referenced in the STCIP parameter.
NO
A regular TCP/IP connection is to be used.
Note: This parameter applies only to SCHEDULEs or INQUIREs using TCP/IP. It
has no meaning for SNA-based operations.
Default: The default value is determined by the SSL and SECURE_SOCKET
parameter combinations in the Default Options Table.
180 User Guide
PARM Parameters
STCAPPL
Identifies the APPLID of the CA XCOM Data Transport server to which this
request is to be queued.
xxxxxxxx
Specifies up to eight alphanumeric characters indicating the CA XCOM Data
Transport server where this request is to be queued.
Notes:
■
STCAPPL is necessary when there are several CA XCOM Data Transport
servers running on your system and during third-party transfers when you
want to send a file from a server other than your own to a third remote
system.
■
Only TYPE=SCHEDULE transfers are valid for third-party initiates.
STCIP
Indicates to XCOMJOB the IP address that is the target of a SCHEDULE or
INQUIRE.
1 to 63 alphanumeric characters
Specifies the name or address of the remote TCP/IP system involved in a
transfer. This name can contain up to 63 alphanumeric characters and it
must be one that has been defined to the domain name server. The address
can be in IPv4 or IPv6 notation.
STCPORT
Specifies to XCOMJOB the IP PORT of the started task that is the target of the
SCHEDULE or INQUIRE.
1 to 65535
Specifies a number that indicates the IP port of the started task.
Default: If the STCPORT parameter is not specified, the IPPORT parameter
value defined in the CA XCOM Data Transport Default Options Table is used.
Chapter 2: The Batch Interface 181
PARM Parameters
SUPPLIST
Specifies whether CA XCOM Data Transport is to suppress XCOMM0397I and
XCOMM0398I messages when processing transfers of PDS or PDSE (source)
members.
YES
Specifies that CA XCOM Data Transport will suppress the XCOMM0397I and
XCOMM0398I messages.
NO
Specifies that CA XCOM Data Transport will allow the following messages to
be issued to the console when processing transfers of PDS or PDSE (source)
members:
■
XCOMM0397I membname BEING TRANSMITTED
■
XCOMM0398I membname BEING RECEIVED
Default: NO
Notes:
■
The SUPPLIST default parameter can be specified in the default table or
overridden by the XCOMJOB/XCOMXFER EXEC parameter.
■
The value of SUPPLIST can also be modified using the operator DFLT
command.
SWAIT
Specifies the number of seconds that CA XCOM Data Transport waits for a
session to be established after the request for session establishment has been
queued.
1 to 32767
Specifies the time limit in seconds within which a queued session
establishment request must result in the establishment of a session.
Default: 30
Note: If CA XCOM Data Transport's first attempt at session establishment fails,
a request for session establishment is placed in a request queue. A session must
be established within the time specified by the SWAIT parameter. If no session is
established within the specified time, a session establishment error is considered
to have occurred, which results in incrementing the value of the SERL parameter
(for a description of the SERL parameter, see the CA XCOM Data Transport for
z/OS Administration Guide).
182 User Guide
PARM Parameters
TCPSTACK
Job name or started task name of the TCP/IP stack that is used by the CA XCOM
Data Transport TCP/IP interface. Use this parameter to specify the desired stack,
if multiple stacks are running at your site.
xxxxxxxx
Specifies up to eight alphanumeric characters indicating the job name or
started task of the TCP/IP stack used by the CA XCOM Data Transport TCP/IP
interface.
Default: None
Note: An empty value causes the CA XCOM Data Transport TCP/IP interface to
listen on all IP stacks.
TIMEOUT
Indicates the maximum duration that CA XCOM Data Transport is to wait for any
VTAM or TCP/IP command to complete before terminating the program with an
abnormal return code. This ensures that the CA XCOM Data Transport Batch
Interface does not hold up an initiator or socket indefinitely. For example, if a
target system is unavailable, VTAM cannot initiate a session; therefore, the
procedure terminates at the specified time-out value. Similarly, a SEND or
RECEIVE command times out if a transmission gets hung up.
0 to 99999 seconds
Specifies how long CA XCOM Data Transport should wait for a VTAM or
TCP/IP command before terminating the program.
Notes:
■
CA XCOM Data Transport always queues to VTAM the request to establish the
session with the remote system. If TYPE=EXECUTE or TYPE=INQUIRE, CA
XCOM Data Transport attempts to establish the session within the time
specified in the TIMEOUT parameter. If it cannot, then the job aborts. An
error message is written to the CA XCOM Data Transport log and is also sent
to the operator console. A return code of 9 or 10 is also issued.
■
For a TCP/IP transfer, the TIMEOUT parameter determines how long to wait
for a connection to a remote IP node
■
TIMEOUT should not be less than 60 seconds, to allow sufficient time for a
normal transfer or inquiry request to complete.
Default: 600
Chapter 2: The Batch Interface 183
PARM Parameters
TRACE
Activates the internal CA XCOM Data Transport trace function as an alternative
to the VTAM trace. The trace data, often useful in debugging problems, is sent to
the SYSOUT class defined by the DUMPCL parameter.
YES
Use the CA XCOM Data Transport trace function instead of the VTAM trace.
NO
Do not use the CA XCOM Data Transport trace function.
Default: NO
184 User Guide
PARM Parameters
TYPE
Specifies how CA XCOM Data Transport is to process the transfer request.
Required.
SCHEDULE
Queues the file transfer request and ends the job step when the transfer
request is queued. The request runs in the address space of the CA XCOM
Data Transport server. The file transfer is single-threaded in first-in-first-out
queuing order (unless overridden by priority considerations) and is
implemented when the resource becomes available.
If the target system is unavailable during the execution of a job, the transfer
occurs as soon as it becomes available. If the target system is available and
the CA XCOM Data Transport server is active, the transfer can be executed
immediately.
TYPE=SCHEDULE is recommended for production jobs.
EXECUTE
Indicates that the file transfer is to be processed during the execution of the
current job. If the file transfer cannot be executed before the specified job
time-out interval, CA XCOM Data Transport generates condition codes and
messages. This transfer type is supported by most CA XCOM Data Transport
platforms. For a list of restrictions, call CA Technical Support.
If TYPE=EXECUTE and another user has established a session with the same
target system, your job aborts if the other user's session does not end before
the time-out interval has expired.
INQUIRE
Indicates whether all transfers specified in a job request have completed
successfully, and whether any transfers were incomplete or unsuccessful.
HISTORY
Retrieves history records based on specified criteria, such as user ID,
transfer ID, TCP/IP address, dates and times, file size or type, and send or
receive.
Note: For more information about return codes, see XCOMJOB Return Codes in
this chapter.
Chapter 2: The Batch Interface 185
PARM Parameters
VTAMGNAM
Specifies the VTAM Generic Resource Name that the server attempts to open at
initialization time.
Note: This parameter is valid only for the CA XCOM Data Transport server job.
xxxxxxxx
Specify the one- to eight-character alphanumeric Generic Resource Name.
Default: None
XCOMPLEX
Specifies the name of the XCOMPLEX facility that the CA XCOM Data Transport
Administrator administers.
Specify the same XCOMPLEX name for each CA XCOM Data Transport server that
is a member of the XCOMPLEX facility. The name for the XCOMPLEX must be
unique and cannot be the same as the acbname for any server in the XCOMPLEX.
Note: This parameter is valid for the CA XCOM Data Transport server job and the
CA XCOM Data Transport administrator job.
xxxxxxxxxxxxxxxx
Specify the 1- to 16-character alphanumeric name of the XCOMPLEX to join
Default: None
186 User Guide
SYSIN01 Parameters
SYSIN01 Parameters
This section describes the set of parameters that are specified in the SYSIN01 DD
statement of the XCOMJOB JCL. The discussion of the SYSIN01 parameters is
divided into the following subsections:
Symbolic Parameters
This section discusses parameters with variable data that is resolved to other
values at schedule time or at transfer time, depending on the specific
parameter
General SYSIN01 Parameters
This section discusses parameters that can be specified in any batch job.
SYSIN01 Parameters Required by FILETYPE=FILE
This section discusses parameters that must be used when FILETYPE=FILE is
coded in the SYSIN01 DD statement).
SYSIN01 Parameters Required by FILETYPE=REPORT
This section discusses parameters that must be used when
FILETYPE=REPORT is coded in the SYSIN01 DD statement).
SYSIN01 Tape Parameter
This section discusses parameters that need to be used when tape data sets
are being transferred.
SYSIN01 DCB Parameters
This section discusses parameters that are used to allocate space for
transferred data.
SYSIN01 Transfer Control Parameters
This section discusses parameters associated with CA XCOM Data
Transport's transfer control (XTC) feature, which is concerned with the
control of multiple interdependent transfers.
Note: There are no special parameters required for FILETYPE=JOB.
SYSIN01 DD Statement
The SYSIN01 parameters passed to CA XCOM Data Transport can be coded
either directly in the SYSIN01 input stream or indirectly in a data set that is
referenced by the SYSIN01 DD statement. The latter method - that is, using the
SYSIN01 DD statement only to reference the data set where the transfer control
parameters are coded - is preferable for transfer jobs run regularly with the
same processing options.
Chapter 2: The Batch Interface 187
SYSIN01 Parameters
Main Coding Rules
The SYSIN01 parameters must be coded according to the same rules that are
used in coding standard SYSIN instream information. Thus, among the most
important rules to be observed when coding SYSIN01 parameters are the
following:
■
Parameter data can span multiple lines as long as a plus sign (+) is placed at
the end of each line to be continued and that the continuation line starts in
columns 2 through 16.
■
Each new parameter must start in column one.
■
Parameter values with embedded spaces, quotes, or a plus sign (+) followed
by a space, which would indicate a continuation line, must be enclosed in
either single or double quotes. The single or double quotes, if used, must
delimit the beginning and end of each line of the parameter value.
Preserving SYSIN01 Information
If you want the SYSIN01 parameters for a file transfer to be included in the CA
XCOM Data Transport activity log, code the PARM parameter LOG=YES on the
EXEC card of the JCL for the transfer.
Symbolic Parameters
Symbolic parameters let you store transfer parameters in control files with
variable data that is resolved to other values at schedule time.
Standard symbolic parameters are supplied with CA XCOM Data Transport.
No setup is required to use the pre-defined variables that are integrated as part
of CA XCOM Data Transport. If you place these variables in the parameter data
set for a transfer, CA XCOM Data Transport invokes them when scheduling the
transfer.
188 User Guide
SYSIN01 Parameters
&DATE(format-code)
Causes the current date to be substituted dynamically in the current keyword
value. The format of the date depends on the format code that is selected as a
sub-parameter. If no format is specified, YYYYMMDD is used. Valid format-codes
and examples of their output are:
■
MMDDYYYY—12312008
■
DDMMYYYY—31122008
■
YYYYMMDD—20081231
■
YYYY—2008
■
MM—12
■
DD—31
■
YYDDD—08366
■
YYYYDDD—2008366
■
DDMONYYYY—31DEC2008
■
MON—DEC
■
MONTH—DECEMBER
&IPNAME
Causes the value entered for IPNAME to be substituted dynamically in the
current keyword value.
&LU
Causes the value entered for LU to be substituted dynamically in the current
keyword value.
&LUSER
Causes the current LOCAL user ID (or the USERID of the current job) to be
substituted dynamically in the current keyword value.
&USERID
Causes the current REMOTE user ID (or the USERID of the current job) to be
substituted dynamically in the current keyword value.
&ID
Causes the value entered for ID to be substituted dynamically in the current
keyword value.
Chapter 2: The Batch Interface 189
SYSIN01 Parameters
&TIME
Causes the current time to be substituted dynamically in the current keyword
value. The format of the time depends on the format code that is selected as a
sub-parameter. Valid format-codes and examples of their output are:
190 User Guide
■
HHMMSSTH—15312811
■
HHMMSS—153128
■
HHMM—1531
■
MMSS—3128
■
HH—15
■
MM—31
■
SS—28
SYSIN01 Parameters
How to Use Symbolic Parameters
You can place symbolic variables in any combination in SYSIN01 control
statements to create composite parameter values. You can use a period (.) as a
terminating character for the symbolic variable, but this is not required. If a
period is present, it is removed from the resultant field content.
Example
ID=X-&TIME(HH):&TIME(MM):&TIME(SS)
This results in the value for ID being set to:
X-15:31:28
If the symbolic variable does not have a system value, you must assign a value
before using the symbolic variable. You can also specify subscripts on symbolic
variables that do not have a format-code. There are two formats for subscripted
symbolic variables. If only one numeric value is present, a starting position of 1
is assumed. A second subscript format allows for a starting position as well as a
length to be entered:
Example (one subscript)
LU=L784000
ID=LU#&LU(4)
This results in the value for ID being set to:
LU#L784
Example (two subscripts)
LU=LU250021
ID=LU#&LU(5,4)
This results in the value for ID being set to:
LU#0021
Chapter 2: The Batch Interface 191
SYSIN01 Parameters
Which SYSIN01 Statements Support Symbolic Parameters?
You can use symbolic parameters on the following SYSIN01 statements:
■
CHARS
■
DEST
■
FCB, FILE, FILEOPT, FILETYPE, FORM
■
GROUP
■
ID, IPNAME
■
LCLNTFYL, LFILE, LIST, LU, LUNIT, LUSER, LVOL
■
NOTIFY, NOTIFYNAME
■
OEDATE, OETIME, OFILETYPE, OID, OLMSG, OLU, OREQ, OSDATE, OSTIME,
OTNAME, OTYPE, OTYPEREQ, OUSER
■
REPORT, RMNTNTFYL, RNOTIFY, RNOTIFYNAME
■
SYSUDATA
■
TDUDATA, TRUSTED, TYPE
■
UNIT, USER, USERID
■
VOL
■
WRITER
■
XCOM_CONFIG_SSL, XTCERRDECR, XTCERRINCR, XTCERRPURGE,
XTCERRREL, XTCGOODDECR, XTCGOODINCR, XTCGOODPURGE,
XTCGOODREL, XTCJOB, XTCNET
General SYSIN01 Parameters
Unless otherwise noted, the parameters described in the following are optional.
192 User Guide
SYSIN01 Parameters
AGE
Overrides the CA XCOM Data Transport default age purging interval.
1 to 999 days
Specifies the number of days that a transfer request can remain in the queue
before being purged.
Note: Aging is relative to the scheduled start date of the file transfer. The
purging interval is the number of days a request can remain on the CA XCOM
Data Transport queue before purging. The CA XCOM Data Transport queue
includes file transfer requests with future start dates, transfer requests that have
been placed on HOLD status, and transfers that were suspended. CA XCOM Data
Transport performs automatic queue purging at two times-when the CA XCOM
Data Transport server comes up and daily at midnight.
Default: Taken from CA XCOM Data Transport Default Options Table
CODETABL
Specifies the one- to three-character prefix to the file names, atoe.tab and
etoa.tab, that contain the external ASCII-to-EBCDIC and EBCDIC-to-ASCII
custom character conversion tables on the CA XCOM Data Transport for Windows
and the CA XCOM Data Transport for UNIX platforms. These custom character
conversion tables determine which external translation tables are to be used
when a transfer is sent to these platforms. This parameter is valid only if
INTERNAL_CONVERSION_TABLES=NO is set on the receiving platform and the
platforms are at r11 or above.
1 to 3 (bytes)
Specifies up to 3 alphanumeric characters, identifying the code table to be
used by the remote partner.
Default: None
Chapter 2: The Batch Interface 193
SYSIN01 Parameters
CKPT
Specifies the interval for checkpoints taken during a file transfer.
0 to 9999 records
Specifies the number of records to transfer for a checkpoint interval.
Notes:
■
The checkpoint/restart facility resumes interrupted transfers from the point
at which the most recent checkpoint was taken.
■
Each time a checkpoint is taken, the output buffers on the receiving system
are written to the disk. A checkpoint interval that is too short slows down file
transfers; a checkpoint interval that is too long increases the risk of data
loss. We recommend that you set the checkpoint count to at least 1000. On
Token Ring, Ethernet, and other high-speed networks, the checkpoint count
should be set to the highest allowable value, if needed.
■
If the receiving system is z/OS or VSE, the checkpoint count should be set to
a multiple of the blocking factor. For example, if the DCB attributes are
RECFM=FB LRECL=80 BLKSIZE=8000, the checkpoint count should be a
multiple of 100.
Default: Taken from the CA XCOM Data Transport default options table.
CODE
Identifies the type of transferred data. The receiving system is responsible for
performing any necessary conversion.
EBCDIC
Indicates that the transferred data are coded in EBCDIC format
ASCII
Indicates that the transferred data are coded in ASCII format
BINARY
Indicates that the transferred data are coded in binary format
Default: EBCDIC
Notes:
194 User Guide
■
EBCDIC packed decimal fields cannot be transferred under EBCDIC. Use
BINARY to transfer EBCDIC packed decimal data.
■
If you specify CODE=ASCII and the receiving system is a mainframe, then
this parameter is ignored.
SYSIN01 Parameters
COMPRESS
Specifies whether CA XCOM Data Transport compresses the data being
transferred and decompresses it on the remote system. Compressing the data
decreases the transmission time on lower-speed links.
YES
Provides Run-Length Encoding (RLE) for blanks and binary zeros only. YES is
the default.
NO
No data compression.
RLE
Provides complete Run-Length Encoding for all characters.
COMPACT
Provides full RLE (as in RLE above) plus a byte compaction scheme that is
suitable for uppercase English text.
COMPACTL
Same as COMPACT above, only the compaction scheme is most beneficial for
lowercase English text.
LZSMALL
CA XCOM Data Transport compresses the data according to the small
memory model of Lempel-Ziv 77 compression.
LZMEDIUM
CA XCOM Data Transport compresses the data according to the medium
memory model of Lempel-Ziv 77 compression.
LZLARGE
CA XCOM Data Transport compresses the data according to the large
memory model of Lempel-Ziv 77 compression.
HUFFMAN
Greater compression than RLE but not as much as the Lempel-Ziv 77 modes.
LZRW3
General-purpose algorithm that runs fast and gives reasonable compression.
ZLIB(n)
Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and
LZLARGE. The n value can be 1 through 9.
Default: YES
Chapter 2: The Batch Interface 195
SYSIN01 Parameters
DATACLAS
Specifies the one- to eight-character name of the data class to be use when
allocating a new SMS-managed data set.
Note: This parameter applies only to mainframe SMS data sets.
Default: None
DOMAIN
Identifies the Windows domain server used to validate the remote user ID and
password.
Up to 15 alphanumeric characters
Specifies the domain server used to validate the remote user ID and
password.
Default: None
Note: Can only be used for transfers running under Windows.
DROPSESS
Indicates whether CA XCOM Data Transport drops an LU-to-LU session at the
conclusion of a scheduled file transfer.
YES
Indicates that CA XCOM Data Transport drops the session.
NO
Indicates that CA XCOM Data Transport does not drop the session.
QEMPTY
Indicates that CA XCOM Data Transport is to process all the transfers to a
particular LU in the request queue before dropping the session.
Default: NO
Note: CA XCOM Data Transport for OpenVMS and some CA XCOM Data
Transport for UNIX products do not support z/OS-initiated session
establishment. Therefore, DROPSESS has no effect when the target of the
transfer request is one of these platforms.
196 User Guide
SYSIN01 Parameters
DSNTYPE
Specifies the data set definition.
Note: This parameter applies only to mainframe SMS data sets.
LIBRARY
Defines a PDSE.
PDS
Defines a partitioned data set.
<blank>
Defines a partitioned or sequential data set based on the data set
characteristics entered.
Note: These values are IBM standards for SMS processing.
Default: None
EPRTY
Indicates the execution priority for the request. The lowest priority is 1.
1 to 255
Specifies an execution priority from 1 to 255, where 1 is the lowest priority.
Notes:
■
In an environment with multiple concurrent CA XCOM Data Transport
transmissions, transfers with higher priorities receive preferential servicing.
■
All other considerations being equal, give short file transfers a higher EPRTY
than very long running transmissions.
Default: 16
Chapter 2: The Batch Interface 197
SYSIN01 Parameters
FILEDATA
Indicates how a remote USS file is to be allocated.
B
Binary
T
Text
If you do not specify a value for FILEDATA, then the allocation is determined
based on the CODE= specification, as determined by the value of the
EBCDIC/Binary/ASCII/VLR(E/B/A/V) field, as follows:
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=B, then the file is allocated and
processed as binary data.
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=E, the type of allocation and
processing depends on the value of FILEDATA, as follows:
–
If you do not specify FILEDATA=B, then the file is allocated as a text file
and processed as an EBCDIC text file.
–
If you do specify FILEDATA=B, then the file is allocated as a binary file,
but processed as an EBCDIC file.
Important! If you do specify FILEDATA=B, then you need to specify a value for
LRECL, to tell CA XCOM Data Transport how many bytes there are in each logical
record.
198 User Guide
SYSIN01 Parameters
FILETYPE
Indicates the output type of the transfer on the target system. Required.
FILE
Indicates that the transferred information is a file to be stored on the
external media of the receiving system.
This parameter value can be used with TYPE=SEND and TYPE=RECEIVE
requests.
JOB
Indicates that the transferred information is a batch job submitted for
execution on the remote system.
This parameter value can be used only with TYPE=SEND requests.
REPORT
Indicates that the transferred information is a report to be printed on the
remote system.
This parameter value can be used only with TYPE=SEND requests.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 199
SYSIN01 Parameters
GROUP
Tells CA XCOM Data Transport to use the ―pooled‖ LU feature to allow for
multi-threading of transfers to nodes that support multiple logical units but not
parallel sessions. For TCP/IP transfers, use GROUP to specify an alias.
xxxxxxxx
Specifies the name of a group of LUs defined in the CA XCOM Data Transport
control library (CAI.CBXGPARM). The name can contain up to eight
characters. The first character must be alphabetic, while the rest can be any
combination of alphanumeric or national characters.
Notes:
200 User Guide
■
GROUP, LIST, USER, and LU are mutually exclusive parameters. Only one of
them can be coded.
■
When GROUP= or LIST= is used, the value for IPPORT is determined by
either the destination member or the default table.
■
The group must be predefined in the CA XCOM Data Transport control library
(CAI.CBXGPARM). When the transfer process begins, CA XCOM Data
Transport tries transferring to the first LU in the group. If that attempt fails,
the second LU is tried. If that transfer attempt fails, the third LU is tried, and
so on. However, as soon as CA XCOM Data Transport finds an LU that is
available for the partner node, it transfers the data to that LU and stops
making any further transfer attempts.
■
Group processing is supported for TCP/IP transfers but only for a single IP
address. In this way, an alias can be defined within CA XCOM Data Transport
for an IP address.
■
Session establishment is subject to a time-out limit defined on the TIMEOUT
parameter. See the description of TIMEOUT later in this section.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
HOLD
Prevents a TYPE=SCHEDULE transfer from starting until explicitly released.
YES
This transfer is not initiated until it is released in one of the following ways:
■
Through the Menu Interface
■
By an operator with a RELEASE command
■
Through the XTC facility
NO
This transfer is not held.
Default: NO
ID
Associates a descriptive identifier with this file transfer.
xxxxxxxxxx
Identify the file transfer using one to ten alphanumeric or national
characters.
Notes:
■
The ID complements the request number assigned to every locally initiated
file transfer. This ID appears before the message on the CA XCOM Data
Transport message log and after the message when it is displayed on a
console. The ID is passed to remote systems and is displayed in the remote
system CA XCOM Data Transport log. For version=1 type transfers, an ID of
REMOTE is always assigned to this transfer on the remote system.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: The job name of the job used to invoke the batch interface
Chapter 2: The Batch Interface 201
SYSIN01 Parameters
INQWAIT
Identifies how long CA XCOM Data Transport should wait in hours, minutes, and
seconds (hhmmss) before determining and reporting the status of a transfer
request. The maximum possible wait is one second less than 100 hours.
000000 to 995959
Specifies how long CA XCOM Data Transport should wait after a transfer
request before determining and reporting the status of a transfer request.
Note: Only valid for TYPE=INQUIRE transfers.
Default: The value specified in CA XCOM Data Transport Default Options Table
IPNAME
Identifies the IP address of the remote system for a TCP/IP transfer.
1 to 64 alphanumeric characters
Specifies the name or address of the remote TCP/IP system involved in a
transfer. This name can contain up to 63 alphanumeric characters and it
must be one that has been defined to the domain name server. The address
can be in IPv4 or IPv6 notation.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
IPPORT
Identifies the IP port of the remote system for a TCP/IP transfer.
1 to 65535
Specifies a number indicating the IP port of the remote system.
Default: If this parameter is not specified, the value of IPPORT parameter
defined in the CA XCOM Data Transport Default Options Table is used.
Note: When GROUP= or LIST= is used, the value for IPPORT is determined by
either the destination member or the default table.
202 User Guide
SYSIN01 Parameters
JPNCNTL
Indicates whether the header file contains Katakana characters.
K or KATAKANA
The control information (header fields) being transferred contains Katakana
character
E or ENGLISH
The control information does not contain Katakana characters.
Note: JPNCNTL is valid for CODE=EBCDIC transfers only.
Default: E (ENGLISH)
JPNDATA
Indicates whether the data file contains Katakana characters.
K or KATAKANA
The data file being transferred contains Katakana characters.
E or ENGLISH
The data file does not contain Katakana characters.
Note: JPNDATA is valid for CODE=EBCDIC transfers only.
Default: E (ENGLISH)
JPNDBL
Indicates the local double byte character set for Japanese conversions.
0
IBM double-byte character set.
Note: This parameter is no longer supported; only IBM DBCS is supported.
Chapter 2: The Batch Interface 203
SYSIN01 Parameters
JPNSHFT
Specifies whether DBCS shift-out and shift-in characters are removed or
converted to spaces.
C or CONVERT
The DBCS shift-out/shift-in characters are converted to spaces.
D or DELETE
The DBCS shift-out/shift-in characters are removed.
Note: JPNSHFT is valid for CODE=EBCDIC transfers only.
Default: D (DELETE)
LCLNTFYL
Specifies the local notification level for transfers initiated from the CA XCOM Data
Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
Notes:
204 User Guide
■
You can specify this parameter in the XCOMDFLT table, in the destination
member, or in the SYSIN01. Its presence is checked for first in the SYSIN01,
then in the destination member, and lastly in the XCOMDFLT default table.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
LFILE
Identifies the local data set involved in a file transfer.
1 to 54 characters (for a non-USS file)
Specifies the non-USS local data set involved in a file transfer. This can be
the name of a file copied to a remote system or the file name of a data set
received from a remote system. Alternatively, the local data set name can be
specified using the LCLDS01 DD statement. If both are specified, the data
set defined by LFILE takes precedence.
Specifies up to 54 characters consisting of the following:
■
A 1- to 44-character data set name
■
An optional member name enclosed in parentheses
Note: A wildcard character (*) can be used if transferring between IBM
mainframe systems.
Notes:
■
Use an asterisk as the member name to show that all members of a
partitioned data set are to be transferred.
For example, the statement LFILE=PAYROLL.PDS(*) indicates that all
members of the PAYROLL partitioned data set are to be transferred.
■
Use the prefix followed by an asterisk if all members beginning with a specific
prefix are to be transferred. For example, NAMES.PDS(AL*) requests that
members AL, ALEX, and ALICE are all to be transferred. The asterisk must be
the last character before the right parenthesis.
■
The use of wildcards (*) is supported only between IBM mainframe systems
and platforms running CA XCOM Data Transport Version 3.1, r11, or r11.5.
1 to 255 characters (for a USS file)
Specifies the USS local data set involved in a file transfer. This can be the
name of a file copied to a remote system or the file name of a data set
received from a remote system. Alternatively, the local data set name can be
specified using the LCLDS01 DD statement. If both are specified, the data
set defined by LFILE takes precedence.
Specifies up to 255 characters consisting of the following:
■
/ (the first character of the data set name)
■
A 1- to 254-character data set name
Chapter 2: The Batch Interface 205
SYSIN01 Parameters
Notes:
■
One or more wildcard characters (*) can be used if transferring to IBM
mainframe systems, to Windows systems, or to UNIX systems.
■
The transfer of USS files is supported only between systems running CA
XCOM Data Transport r11.5.
USS Examples
LFILE=/u/users/xcom/*
Transfer ALL files.
LFILE=/u/users/xcom/m*
Transfer ALL files starting with an m.
LFILE=/u/users/xcom/*m
Transfer ALL files ending with an m.
LFILE=/u/users/xcom/m*m
Transfer ALL files starting with an m and ending with an m.
LFILE=/u/users/xcom/m*y*m
Transfer ALL files starting with an m, ending with an m and containing a y.
LFILE=/u/users/xcom/m*you*
Transfer ALL files starting with an m and containing the characters you in
succession.
LFILE=/u/users/xcom/m*y*o*u*
Transfer ALL files starting with an m and containing the characters y and o
and u (in order, but not in succession).
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
206 User Guide
SYSIN01 Parameters
LFILEDATA
Indicates how the local USS file is to be allocated.
B
Binary
T
Text
If you do not specify a value for LFILEDATA, then the allocation is determined
based on the CODE= specification, as determined by the value of the
EBCDIC/Binary/ASCII/VLR(E/B/A/V) field, as follows:
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=B, then the file is allocated and
processed as binary data.
■
If EBCDIC/Binary/ASCII/VLR(E/B/A/V)=E, the type of allocation and
processing depends on the value of LFILEDATA, as follows:
–
If you do not specify LFILEDATA=B, then the file is allocated as a text file
and processed as an EBCDIC text file.
–
If you do specify LFILEDATA=B, then the file is allocated as a binary file,
but processed as an EBCDIC file.
Important! If you do specify LFILEDATA=B, then you need to specify a value for
USSLRECL, to tell CA XCOM Data Transport how many bytes there are in each
logical record.
Chapter 2: The Batch Interface 207
SYSIN01 Parameters
LIST
Broadcasts this file transfer to all remote destinations designated on a
predefined distribution list.
xxxxxxxx
Specifies the name of a distribution list designating where this file should be
broadcast. The name can be up to eight alphanumeric characters long. The
list name can be the name of a superlist.
Notes:
208 User Guide
■
GROUP, LIST, and LU are mutually exclusive parameters. One of these
parameters must be coded (either on the EXEC card or in SYSIN01). Coding
more than one causes an error.
■
When GROUP= or LIST= is used, the value for IPPORT is determined by
either the destination member or the default table.
■
When a transfer is performed to a destination defined as a list of LUs or IP
addresses, the data is transferred to each LU or IP node in the list.
■
The LU and IPNAME parameters can be coded within the same list member.
This results in the file being transferred to SNA and IP nodes.
■
The LIST parameter is valid only for TYPE=SCHEDULE transfers.
■
Because a transfer to a list destination is processed as a queued request, the
various file transfers involved might have different start times. Use the CA
XCOM Data Transport Operator Control function on the Menu Interface to
check the current status of any broadcast distribution.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
Using a Superlist
Specifying the name of a superlist for the LIST parameter broadcasts the file
transfer to all remote destinations designated on a predefined distribution
superlist, or list of lists.
Up to 32720 bytes
XCOM LIST names are names of members in the XCOMCNTL data set and
therefore are limited to eight alphanumeric characters.
XCOM lists are limited to 32720 bytes of storage, consisting of the following:
■
A 32-byte storage descriptor, leaving 32688 bytes for the list.
■
Each list entry occupies 4 to 10 bytes:
–
1 byte for the TYPE
–
1 flag byte
–
1 byte for the LENGTH
–
1 to 8 bytes for the name of the list
If each member name specified as a LIST/SUPERLIST is eight characters
long, then a SUPERLIST can include 2971 member names.
LPASS
Indicates a password associated with LUSER. This is mainly used for
third-party-initiated file transfer requests.
xxxxxxxx
Specifies a password of up to eight alphanumeric characters that is
associated with LUSER.
Note: LPASS should not be confused with PASSWORD (see below).
LU
Defines the VTAM LU name of the remote system.
xxxxxxxx
Specifies the name of the remote LU. The name can contain up to eight
alphanumeric characters.
Notes:
■
GROUP, LIST, USER, LU, and IPNAME are mutually exclusive parameters.
One of these parameters must be coded (either on the EXEC card or in
SYSIN01). Coding more than one causes an error.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 209
SYSIN01 Parameters
LUSER
Specifies a user ID on the source system whose access privileges are used to
execute the file transfer.
xxxxxxxx
Specifies up to eight alphanumeric characters representing a user ID whose
access privileges on the source system are used for the file transfer.
Notes:
■
LUSER is mainly used for a third-party transfer: a user on system A requests
that system B (source) execute a file transfer to system C (target). While the
transfer request is initiated by system A, the file transmission is entirely
between system B and system C.
The only prerequisites for third-party transfers are:
–
All systems must be identified to VTAM and be running CA XCOM Data
Transport Version 2 or higher.
–
The ID entered for LUSER must satisfy the requirements of the security
software in effect on the source system.
■
If the source system has a default user ID for third-party file transfers, and
you want to use this default, then a null value must be specified for this
parameter as LUSER=― ‖ with at least one space between the quotes.
■
Not all CA XCOM Data Transport platforms support third-party transfers.
■
For conventional file transfers, LUSER can be used to identify the user
initiating the transfer. This is useful in performing operator tracking and
control functions through the menu interface.
■
Do not confuse LUSER with the USERID parameter. USERID refers to the
authorization access ID on the target system, both for ordinary file transfers
and third-party initiated transfers.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: The ID associated with the address space created when the file transfer
request is made
MGMTCLAS
Specifies the one- to eight-character name of the management class to use when
allocating a new SMS-managed data set.
Note: This parameter applies only to mainframe SMS data sets.
Default: None
210 User Guide
SYSIN01 Parameters
NEWXFER
Indicates the beginning of a new file transfer definition. Unlike all other SYSIN01
parameters, no value is assigned to this parameter. The parameter NEWXFER is
entered in SYSIN01 at a point where a new transfer request is defined. The text
following the parameter name NEWXFER up to the next occurrence of NEWXFER
(if any) forms the definition of a transfer request.
Notes:
■
At least one parameter must be specified between succeeding NEWXFER
parameters.
■
To negate a previously specified parameter, specify the parameter again
with no value.
■
It is not necessary to respecify all parameters for an additional file transfer,
only those that are different. All parameters other than XTC parameters are
propagated. For example, if two TYPE=SEND transfers are requested, then
the FILE=remote_ file_name parameter is usually specified twice, but the
FILETYPE=FILE and TYPE=SEND parameters have to be specified only for
the first request.
■
Multiple SNA and TCP/IP transfers can be intermixed within the same
SYSIN01 stream.
■
For information about TYPE=EXECUTE transfers, see the discussion of the
CONTINUE parameter for XCOMJOB PARM.
Chapter 2: The Batch Interface 211
SYSIN01 Parameters
NOTIFY
Tells CA XCOM Data Transport who to notify on the local system when the file
transfer is complete. This parameter is used in conjunction with NOTIFYNAME.
See also RNOTIFY.
LOG
Requests that the main console operator on this system be notified.
tso_user_id
Identifies the TSO user who is sent a broadcast message when the file
transfer completes. Any value except LOG is interpreted by CA XCOM Data
Transport as a TSO user ID on this system. If this user ID is not logged on
when the transfer is completed, the message is displayed the next time the
user logs on.
Note: When this option is specified, you cannot use NOTIFYNAME or
RNOTIFYNAME parameters.
CICS
Causes CA XCOM Data Transport to begin an LU 6.2 process to CICS when
the file transfer concludes. See NOTIFYNAME.
Note: For this result, in addition to NOTIFY=CICS,
NOTIFYNAME=cics.acbname needs to be specified.
ROSCOE
Sends notification messages to users of the CA Roscoe timesharing product
when a file transfer begins, ends, or fails. See NOTIFYNAME.
Note: When you specify NOTIFY=ROSCOE, you must set NOTIFYNAME to
the name of the CA Roscoe user to notify on the initiating system and
RNOTIFYNAME to the name of the CA Roscoe user on the remote system. To
keep a CA Roscoe user informed on a local system, you need to specify
NOTIFY=ROSCOE and NOTIFYNAME=roscoe_key.
ALL
If the remote system is an OpenVMS, CA XCOM Data Transport can send
notification to the electronic mailboxes of DEC ALL-in-1 users.
Note: When NOTIFY=ALL is selected, then NOTIFYNAME must also be
specified.
Default: LOG
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
212 User Guide
SYSIN01 Parameters
NOTIFYNAME
Identifies the entity on the local system that is to receive a notification of the
completion of the transfer.
xxxxxxxx
Indicates the TP name under CICS, or the CA Roscoe key, or the DEC
ALL-in-1 user to be notified at the conclusion of a file transfer by the initiator
of the request. The notification receiver name can be up to eight
alphanumeric characters long.
Notes:
■
This parameter must be used when NOTIFY=CICS, NOTIFY=ROSCOE, or
NOTIFY=ALL has been selected.
■
If you specify NOTIFY=CICS, you must also specify
NOTIFYNAME=cics.acbname.
■
If you specify NOTIFY=ROSCOE, you must also specify NOTIFYNAME=roscoe
key.
■
If you specify NOTIFY=ALL, you must also specify NOTIFYNAME=mailbox
name.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
PASSWORD
Identifies the password for the user ID under whose set of resource access
privileges CA XCOM Data Transport is to execute on the remote system. It should
be the password known to the remote security system.
Up to 31 alphanumeric characters
Specifies up to 31 characters representing the user password that is to be
used for CA XCOM Data Transport execution on the remote system.
Notes:
■
This value is overwritten with a string of asterisks or xxx… when it appears in
any CA XCOM Data Transport log.
■
To change the remote TSO password, use the following format:
oldpassword/newpassword
■
PASSWORD should not be confused with LPASS (see above).
Chapter 2: The Batch Interface 213
SYSIN01 Parameters
PROGLIB
Specifies whether the transfer is of a PDSE program library or not.
YES
Indicates the transfer of a PDSE program library.
NO
Indicates the transfer is not of a PDSE program library.
Notes:
■
This parameter applies only to mainframe SMS data sets.
■
CA XCOM Data Transport uses the values from PSOPREF and PSOVOL to
create the temporary data sets used in transferring PDSE program libraries.
■
Only whole PDSE program libraries can be transferred. The transferring of an
individual member or the use of wild cards (for example, ABC*) to transfer
multiple members is not supported.
■
PROGLIB=YES requires the use of an XCOMPRNT DD statement. Ensure any
CA XCOM Data Transport for z/OS servers used to send or receive PDSE
program library transfers have been modified to include the XCOMPRNT DD.
See sample member XCOM in the appendix ―Sample Files.‖
■
If PROGLIB=YES is used in TYPE=EXECUTE transfers, then XCOMPRNT DD
must be included in the batch XCOMJOB JCL.
Default: None
RESTART
Identifies whether a stopped transfer should be restarted from the nearest
checkpoint or from the beginning. This option is only valid for TYPE=EXECUTE
transfers, and it is used only if a problem occurred earlier on the restart
checkpoint and the transfer request is being resubmitted.
YES
Start from the nearest checkpoint; do not start from the beginning of the
transfer.
NO
Signals that the file transfer should be restarted from the beginning, even if
a checkpoint restart is feasible. NO is the default.
Default: NO
214 User Guide
SYSIN01 Parameters
RMTNTFYL
Specifies the remote notification level for transfers initiated from the CA XCOM
Data Transport for z/OS server.
A (All)
Notify on transfer completion.
W (Warn)
Notify only if the transfer received a warning or error.
E (Error)
Notify only if the transfer received an error.
Default: A
Notes:
■
You can specify this parameter in the XCOMDFLT table, in the destination
member, or in the SYSIN01. Its presence is checked for first in the SYSIN01,
then in the destination member, and lastly in the XCOMDFLT default table.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 215
SYSIN01 Parameters
RNOTIFY
Tells CA XCOM Data Transport who to notify on the remote system when the file
transfer is complete. This parameter is used in conjunction with RNOTIFYNAME.
See NOTIFY.
LOG
Requests that the main operator on the remote system be notified.
tso_user_id
Identifies the TSO user who is sent a message when the file transfer
completes. Any value except LOG is interpreted by CA XCOM Data Transport
as a TSO user ID on this system. If this user ID is not logged on when the
transfer is completed, the message is displayed the next time the user logs
on.
CICS
Causes CA XCOM Data Transport to begin an LU 6.2 process to CICS when
the file transfer concludes. This is used only if the remote system is z/OS.
ROSCOE
Sends notification messages to users of the CA Roscoe timesharing product
when a file begins, ends, or fails. NOTIFYNAME is the name of the CA Roscoe
user to notify on the initiating system. RNOTIFYNAME is the name of the CA
Roscoe user on the remote system. To notify a CA Roscoe user on a remote
system, specify RNOTIFY=ROSCOE and RNOTIFYNAME=roscoe_key.
ALL
If the remote system is an OpenVMS, CA XCOM Data Transport can send
notification to the electronic mailboxes of DEC ALL-in-1 users. To notify a
DEC ALL-in-1 user, specify RNOTIFY=ALL and
RNOTIFYNAME=mailbox_name.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: LOG
216 User Guide
SYSIN01 Parameters
RNOTIFYNAME
Identifies the entity on the remote system that is to receive a notification of
transfer completion.
xxxxxxxx
Specifies the name (up to eight alphanumeric characters) of the remote
system entity to be notified by the target system when a transfer completes.
Notes:
■
■
This parameter must be used when RNOTIFY=CICS, RNOTIFY=ROSCOE, or
RNOTIFY=ALL has been selected.
–
If you specify RNOTIFY=ROSCOE, you must also specify
RNOTIFYNAME=roscoe_key.
–
If you specify RNOTIFY=ALL, you must also specify
RNOTIFYNAME=mailbox_name.
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SECURE_SOCKET
Specifies whether to use an OpenSSL socket or non-OpenSSL socket for
transfers.
YES
Performs a secure transfer.
The transfer uses an OpenSSL socket and must to connect to an SSL listener
on the remote partner.
NO
Performs a non-secure transfer.
The transfer uses a non-OpenSSL socket.
Default: NO
Chapter 2: The Batch Interface 217
SYSIN01 Parameters
SPRTY
Indicates the scheduling priority of this file transfer request. When multiple file
transfer requests are eligible for initiation (that is, they are past their start
date/time) to the same LU or GROUP, those with higher SPRTY values are
scheduled first. One is the lowest priority.
1 to 255
Specifies a scheduling priority for this file transfer request.
Note: This feature has no effect once the transfer begins executing. Do not
confuse it with EPRTY, the execution priority.
Default: 16
218 User Guide
SYSIN01 Parameters
STARTDATE
Specifies the date when the transfer is to begin.
The transfer start date can be provided in one of three formats:
■
yyyymmdd
where
yyyy
Is a four-digit designation for a year (for example, 2008).
mm
Is a two-digit designation for one of the twelve months of the year as
shown in the following chart:
1
4
7
10
=
=
=
=
January
April
July
October
2
5
8
11
=
=
=
=
February
May
August
November
3
6
9
12
=
=
=
=
March
June
September
December
dd
Is a two-digit number in the range 01 to 31 designating a day of the
month.
Example
STARTDATE=20080201 schedules a transfer to begin on February 1, 2008.
■
yyddd (Julian date)
where
yy
Is a two-digit designation for a year (for example, 08).
ddd
Is a three-digit number in the range 001 to 366 designating a day of the
year.
Example
STARTDATE=08032 schedules a transfer to start on the 32nd day of 2008,
which is the same as February 1, 2008.
■
+nnn (nnn days from today)
where
nnn
Is a number in the range 1 to 999.
Chapter 2: The Batch Interface 219
SYSIN01 Parameters
Example
Specifying STARTDATE=+31 on January 1, 2008 schedules a transfer to
begin on February 1, 2008.
Default: Current date
STARTTIME
Specifies the time (hhmm) this transfer becomes eligible for execution.
0000 to 2400
Specifies the time (hhmm) this transfer becomes eligible for execution.
Notes:
■
You can also set the time for the future in terms of its separation in hours and
minutes (+hhmm) from the current time.
■
For example, if a transmission is to start no earlier than 2 p.m.:
STARTTIME=1400
■
Or if the start time is two hours from now:
STARTTIME=+0200.
Default: Current time
STORCLAS
Specifies the one- to eight-character name of the storage class for a new
SMS-managed data set.
Note: This parameter applies only to mainframe SMS data sets.
Default: None
SYSUDATA
Allows the specification of transfer-dependent user data. This data is available to
user exits in the RRDSUSER field of the RRDS data area (mapped by the
RRDDSECT macro) while the transfer is pending or active. The RRDSUSER field is
defined by HDRDSECT within RRDDSECT.
1 to 10 (bytes)
Specifies up to 10 bytes of data available to user exits during a file transfer.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
220 User Guide
SYSIN01 Parameters
TDUDATA
Allows the specification of transfer-dependent user data. This data is available to
user exits in the RRDXUSER field of the RRDS data area (mapped by the
RRDDSECT macro) while the transfer is pending or active. The RRDXUSER field is
defined by HDRDSECT within RRDDSECT.
1 to 10 (bytes)
Specifies up to 10 bytes of data available to user exits during a file transfer.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
TRUNCATE
Tells CA XCOM Data Transport how to respond to records in the source file that
exceed the maximum record length permitted on the target system.
YES
Truncate any excess characters.
NO
Abort the transfer. Once the problem has been resolved, the transfer must
be rerun.
Default: NO
TRUSTED
Specifies whether a user can request a trusted transfer.
Y
Yes, the user can request a trusted transfer.
N
No, the user cannot request a trusted transfer.
Default: N
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 221
SYSIN01 Parameters
TYPE
Indicates whether the file transfer is inbound or outbound. Required.
SEND
Indicates that the file transfer is outbound from this system.
RECEIVE
Indicates that the file transfer is inbound to this system.
Notes:
222 User Guide
■
If TYPE=RECEIVE, then FILETYPE=FILE must be specified.
■
If TYPE=SEND, one of the three, FILETYPE=FILE, FILETYPE=REPORT, or
FILETYPE=JOB, must also be specified.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
UMASK
The file permissions to be removed from the XCOM default file or directory
permissions for USS files or directories. UMASK is used only when a file or
directory is being created.
Range: 000 to 777
Default: 022
On z/OS systems the XCOM default file permission is 666, which means the
following:
■
Allow the owner of the file to read and write the file.
■
Allow members of the owner's group to read and write the file.
■
Allow all other users read and write the file.
File permissions on USS files are implemented the same way as file permissions
are on UNIX systems. The three basic permissions for each of the categories
listed above are read, write, and execute, commonly seen as rwx rwx rwx.
If each of these characters (r, w, x) is considered as a bit, then the possible value
ranges are as follows:
■
000 to 111 in binary
■
0 to 7 in hex
So the default permissions of 666 (110 110 110) mean allow read and write to
everyone, but not execute.
The UMASK value identifies the permissions that you want to remove from the
default (666). If you remove 022 (000 010 010) from 666 then what remains is
644, which means the following:
■
Allow the owner of the file to read and write the file.
■
Allow members of the owner's group and all other users to read, but not
write.
Notes:
■
For directories—CA XCOM Data Transport sets permissions for a created
directory to 7xx, no matter what owner UMASK value was specified. Group
and other permissions, represented by xx, represent the permissions with
the specified UMASK removed.
■
For files – While the file is being transferred, CA XCOM Data Transport sets
permissions for a created file to 6xx, where xx represents the permissions
with the specified UMASK removed. After the transfer has been completed,
CA XCOM Data Transport sets the owner permission with the specified
UMASK removed.
Chapter 2: The Batch Interface 223
SYSIN01 Parameters
USER
Indicates that the transfer is to take place on a session on which this user has
logged onto the CA XCOM Data Transport server.
xxxxxxxx
Specifies one to eight alphanumeric characters representing a user whose
CA XCOM Data Transport session is to be used for a file transfer.
Notes:
■
GROUP, LIST, USER, LU, and IPNAME are mutually exclusive parameters.
One of these parameters must be coded.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
USERID
Identifies the user ID that CA XCOM Data Transport is to use on the remote
system. The user ID must be known to the remote system's security.
xxxxxxxxxx
Specifies a user ID (up to 12 alphanumeric characters) whose access
privileges on the remote system are to be used for this file transfer.
Notes:
■
For IBM iSeries or OpenVMS, specify the user's signon. If this parameter is
omitted, CA XCOM Data Transport defaults to the ID associated with the
address space that submitted the file transfer request.
For example, if there is a JCL USERID parameter coded in the JOB statement
of the job invoking XCOMJOB, then that JCL USERID is used. If a blank
USERID parameter value is to be sent to the remote system, USERID=― ‖
must be entered, with at least one space between the quotes. Do this if the
remote system is to supply its own default for the user ID under whose
access privileges this transfer is to execute.
■
224 User Guide
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
XCOM_CONFIG_SSL
Specifies the HFS SSL configuration file path and file name.
1 to 256 characters
Specifies the HFS path and file name of the SSL configuration file used by CA
XCOM Data Transport for secure transfers.
Notes:
■
A sample SSL configuration file, configssl.cnf, is provided with the
installation.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: None
SYSIN01 Parameters Required by FILETYPE=FILE
The following additional parameters can be used only when FILETYPE=FILE has
been indicated.
Chapter 2: The Batch Interface 225
SYSIN01 Parameters
FILE
Provides file information for a transfer. This information depends on the type of
transfer and the systems being used.
Up to 256 alphanumeric characters
If TYPE=SEND, specify the remote file to which data is transferred.
If TYPE=RECEIVE, specify the remote file being transferred.
If the remote system is a z/OS system, specify the data set name.
If the remote system is a z/OS system with CA XCOM Data Transport, specify
the data set name or the fully qualified USS file name.
If the remote system is a Windows system, specify the full path name.
If the remote system is an IBM iSeries system, specify the qualified file
name.
If the remote system is an HP OpenVMS system, specify the VMS file name.
If the remote system is a UNIX or Linux system, specify the fully qualified file
name including path information.
Notes:
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
■
If the remote file name includes embedded spaces in the file name, enclose
the FILE parameter value in either single or double quotes. For example, to
send to the directory c:\My Documents on a Windows partner, use the
following format:
FILE='c:\My Documents\test.txt'
226 User Guide
SYSIN01 Parameters
FILEOPT
Indicates how the transferred file is managed by the receiving system.
REPLACE
Replaces the file on the receiving system. What is replaced depends on the
type of VSAM file, as follows:
KSDS cluster
Records with matching and non-matching keys are replaced.
ESDS cluster
Nothing is replaced. All records are added to the end of the data set,
because a non-reusable ESDS can only be replaced by deleting and
redefining the cluster. Use CREATE to replace reusable VSAM clusters.
RRDS cluster
Nothing is replaced. This is an invalid choice.
Note: If sending a new member to a pre-existing PDS, specify REPLACE.
ADD
Adds the records of the transferred file to the end of an existing sequential
file or inserts them into an indexed file if they do not already exist there. If
the records do already exist there, CA XCOM Data Transport aborts the
transfer.
Note: You cannot add to an existing PDS member.
CREATE
Creates the transferred file on the destination system as a sequential file.
This option should also be used when VSAM clusters with the REUSE option
are to be reused. If the transfer involves a PDS member, specify CREATE
only if the PDS itself is being created; otherwise, an error results.
Notes:
■
This parameter is ignored for TYPE=EXECUTE transfers that specify
TYPE=RECEIVE in SYSIN01 if the local file is identified through the LCLDS01
DD statement, because in this case the disposition of the file is determined
by the DISP parameter on the DD statement.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: REPLACE
Chapter 2: The Batch Interface 227
SYSIN01 Parameters
LUNIT
Specifies the unit for the local file involved in this file transfer.
Up to eight characters
Specifies the unit for the local file involved in this unit transfer.
Notes:
■
LUNIT is used with the LFILE parameter.
■
If LCLDS01 is used, the unit can be specified through the JCL parameter
UNIT.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: Catalog information or default specified in CA XCOM Data Transport
Default Options Table.
LVOL
Specifies the volume of the local file involved in a file transfer. This is used with
the LFILE parameter.
Up to six characters
Specifies the volume of the local file involved in a file transfer.
Notes:
■
If LCLDS01 is used, the volume can be specified through the VOL JCL
parameter.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: Catalog information
228 User Guide
SYSIN01 Parameters
PACK
Indicates whether record packing is used. Record packing is available in CA
XCOM Data Transport for z/OS for version=2 type transfers. It can substantially
improve performance.
CRLF
Inserts a carriage return (CR) and line feed (LF) characters at the end of
each record. This is the packing type used for most CA XCOM Data Transport
platforms.
LENGTH
Specifies that the records are to be packed into fixed-size data transfer
blocks. Each record begins with a 2-byte long prefix that indicates the length
of the record and determines how many records can be packed into a block.
The default block size is 2K but it can be increased to 31K by using the
MAXPACK parameter in the CA XCOM Data Transport Default Options Table
or in the CA XCOM Data Transport control library member.
When transferring a text file to a partner that supports record separators (for
example, CRLF (0D0A) on Windows and LF (0A) on UNIX), record separators
are inserted. No separators are inserted in binary files transferred with
PACK=LENGTH.
NO
No record packing is used.
Notes:
■
PACK=LENGTH with MAXPACK=31744 should be selected when using CA
XCOM Data Transport over TCP/IP. If PACK=LENGTH is coded, then you
must also code RECSEP=NO.
■
Platforms that support PACK=LENGTH are IBM's AS/400, UNIX-based
systems, and z/OS systems. See the appropriate documentation for the
platform to see if this value is supported.
■
For more information, see Pack Data Records in the chapter ―The Menu
Interface (TSO/ISPF Panels).‖
Default: NO
Chapter 2: The Batch Interface 229
SYSIN01 Parameters
RECSEP
Indicates whether record separators (such as carriage returns) are added to the
data delimiting records when they are written.
Note: This parameter is ignored if both the sending and receiving systems are
EBCDIC.
YES
Add separators to the data delimiting records.
NO
Do not add separators.
Notes:
■
If PACK=LENGTH is coded, then you must also code RECSEP=NO.
■
When transferring a text file to a partner that supports record separators (for
example, CRLF (0D0A) on Windows and LF (0A) on UNIX), record separators
are inserted. No separators are inserted in binary files transferred with
PACK=LENGTH.
Default: YES
RELEASE
Specifies whether the remote partner is to release unused DASD space when
creating a new file.
YES
The remote partner is to release unused DASD space.
The unused DASD space that is specified for the transfer is released when
the file is closed at the end of the transfer.
NO
The remote partner is not to release unused DASD space.
Default: No
230 User Guide
SYSIN01 Parameters
SPACE
Specifies the space to be allocated for a z/OS file.
Value
Definition
CYL, TRK, or BLK This value is specified in the following format:
(for alloc)
0 to 9999 (for
SPACE=(alloc,(pri,sec,dir))
pri, sec, and dir) alloc - Specifies cylinders (CYL), tracks (TRK), or blocks
(BLK) for storage.
pri - Specifies the primary space allocation.
sec - Specifies the secondary space allocation.
dir - Specifies the number of directory blocks for partitioned
data sets.
Notes:
■
This parameter is used only when creating a file under a system such as z/OS
that pre-allocates space.
■
For more information, see documentation on the z/OS JCL SPACE parameter
in the DD statement.
Default: CA XCOM Data Transport Default Options Table defaults
UNIT
Indicates the unit type where the data set is to be created.
xxxxxxxxxx
Specifies up to ten alphanumeric characters indicating the unit type where
the data set is to be created (or where it resides, for existing non-cataloged
data sets).
Default: CA XCOM Data Transport Default Options Table defaults
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 231
SYSIN01 Parameters
VLR
Indicates whether the transfer is for extended Variable Length Record (VLR)
support.
YES
Extended VLR support is requested.
NO
Extended VLR support is not requested.
Default: NO
Notes:
■
VLR=YES is only valid for FILETYPE=FILE and CODE=BINARY.
■
To use extended VLR support, both systems must have extended VLR
support. For example, if the CA XCOM Data Transport for Windows system
does not have extended VLR support, then you cannot get the desired results
by initiating an extended VLR transfer from z/OS to Windows.
VOL
Indicates the volume name where the data set is to be created.
xxxxxxxxxx
Specifies up to ten alphanumeric characters indicating the volume where the
data set is to be created (or where it resides, for existing non-cataloged data
sets).
Default: CA XCOM Data Transport Default Options Table defaults
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters Supported by FILETYPE=HISTORY
The following additional parameters can be used only when TYPE=HISTORY has
been indicated in the XCOMJOB parm statement.
232 User Guide
SYSIN01 Parameters
OEDATE
Limits the history request to only those file transfers that were scheduled or
completed on or before the end date and time.
YYYYMMDD
The end date used to limit the history request to only those file transfers that
were scheduled or completed on or before the end date and time specified.
YYYY
The four-digit year
MM
The two-digit number of the month, as follows:
1
4
7
10
=
=
=
=
January
April
July
October
2
5
8
11
=
=
=
=
February
May
August
November
3
6
9
12
=
=
=
=
March
June
September
December
DD
The two-digit day of the month (01 to 31)
Default: None
Notes:
■
OEDATE and OETIME form an end date and time used to limit the history
request to only those file transfers that were scheduled or completed on or
before the date and time specified.
■
See OSDATE and OSTIME for the start date and time.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 233
SYSIN01 Parameters
OETIME
Limits the history request to only those file transfers that were scheduled or
completed on or before the end date and time.
HHMMSS
The end time used to limit the history request to only those file transfers that
were scheduled or completed on or before the end date and time specified.
HH
The two-digit hour (00 through 23)
MM
The two-digit minute (00 through 59)
SS
The two-digit second (00 through 59)
Default: 235959
Notes:
■
OEDATE and OETIME form an end date and time used to limit the history
request to only those file transfers that were scheduled or completed on or
before the date and time specified.
■
See OSDATE and OSTIME for the start date and time.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
OFILETYPE
Limits the history request to those transfers with the specified FILETYPE.
JOB
Restrict the search for file transfers to only FILETYPE JOB transfers.
REPORT
Restrict the search for file transfers to only FILETYPE REPORT transfers.
FILE
Restrict the search for file transfers to only FILETYPE FILE transfers.
Default: None
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
234 User Guide
SYSIN01 Parameters
OFLMAX
Limits the history request to only those file transfers where the number of bytes
transferred is equal to or less than the value specified.
NNNNNNNNN(N|X)
A 1- to 10-digit number, where the last digit can be either another numeric
digit or a 1-character qualifier. This parameter is used to restrict the search
for file transfers to only those file transfers where the number of bytes
transferred is equal to or less than the value specified.
X
One of the following qualifiers (default B):
■
B = Bytes
■
K = Kilobytes
■
M = Megabytes
■
G = Gigabytes
Default: None
Notes:
■
Use OFLMIN and OFLMAX to specify a range that can be used to limit the
history request by number of bytes transferred.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 235
SYSIN01 Parameters
OFLMIN
Limits the history request to only those file transfers where the number of bytes
transferred is equal to or greater than the value specified.
NNNNNNNNN(N|X)
A 1- to 10-digit number, where the last digit can be either another numeric
digit or a 1-character qualifier. This parameter is used to restrict the search
for file transfers to only those file transfers where the number of bytes
transferred is equal to or greater than the value specified.
X
One of the following qualifiers (default B):
■
B = Bytes
■
K = Kilobytes
■
M = Megabytes
■
G = Gigabytes
Default: None
Notes:
■
Use OFLMIN and OFLMAX to specify a range that can be used to limit the
history request by number of bytes transferred.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
OID
Limits the history request to only those file transfers with a specific transfer ID.
The transfer ID is a user-defined identifier for file transfer requests.
xxxxxxxxxx
A 1- to 10-character transfer ID used to limit the history request to only
those file transfers that contain the specified transfer ID.
Default: None
Notes:
236 User Guide
■
The wildcard character, *, can be used for this parameter only when
specified as the last character.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
OINIT
Limits the history request to only locally initiated transfers or only remotely
initiated transfers.
LOCAL or L
Restrict the search for file transfers to only locally initiated transfers.
REMOTE or R
Restrict the search for file transfers to only remotely initiated transfers.
Default: None
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
OLIMIT
Sets the maximum number of history records that can be returned.
NNNN
Specifies a one- to four-digit number (1 to 9999) that limits the maximum
number of records to be returned by the history request.
Default: Set by the CA XCOM default (XCOMDFLT) table parameter OPERLIM.
Chapter 2: The Batch Interface 237
SYSIN01 Parameters
OLMSG
Limits the history request by the transfer's last message. The format to use for
CA XCOM Data Transport messages is as follows:
XCOMXNNNNS
A 1- to 10-character name used to restrict the search for file transfers to
those where the last message matches the value specified.
XCOM
Indicates that the message is from CA XCOM Data Transport.
X
Identifies the system.
NNNN
Is the message number.
S
Is the message severity:
■
I = Informational
■
W = Warning
■
E = Error
Default: None
Notes:
238 User Guide
■
The wildcard character, *, can be used for this parameter only when
specified as the last character.
■
This parameter is case sensitive.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
OLU
Limits the history request to only those file transfers with a specific remote LU
name.
xxxxxxxx
A one- to eight-character LU name used to limit the history request to only
those file transfers for the specified remote LU.
Default: None
Notes:
■
The wildcard character, *, can be used for this parameter only when
specified as the last character.
■
This parameter is case sensitive.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
OREQ
Limits the history request to only those file transfers that contain this specific
request number.
NNNNNN
A one- to six-character request number used to limit the history request to a
specific request number.
Default: All request numbers
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 239
SYSIN01 Parameters
OSDATE
Limits the history request to only those file transfers that were scheduled or
completed on or after the start date and time.
YYYYMMDD
The start date used to limit the history request to only those file transfers
that were scheduled or completed on or after the start date and time
specified.
YYYY
The four-digit year
MM
The two-digit number of the month, as follows:
1
4
7
10
=
=
=
=
January
April
July
October
2
5
8
11
=
=
=
=
February
May
August
November
3
6
9
12
=
=
=
=
March
June
September
December
DD
The two-digit day of the month (01 to 31)
Default: None
Notes:
240 User Guide
■
OSDATE and OSTIME form a start date and time used to limit the history
request to only those file transfers that were scheduled or completed on or
after the date and time specified.
■
See OEDATE and OETIME for the end date and time.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
OSTIME
Limits the history request to only those file transfers that were scheduled or
completed on or after the start date and time.
HHMMSS
The start time used to limit the history request to only those file transfers
that were scheduled or completed on or after the start date and time
specified.
HH
The two-digit hour (00 through 23)
MM
The two-digit minute (00 through 59)
SS
The two-digit second (00 through 59)
Default: 000000
Notes:
■
OSDATE and OSTIME form a start date and time used to limit the history
request to only those file transfers that were scheduled or completed on or
after the date and time specified.
■
See OEDATE and OETIME for the end date and time.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
OSYSID
Limits the history request to only those file transfers with a specific history
system ID in an XCOMPLEX environment.
xxxx
A one- to four-character history system ID used to limit the history request
to only those file transfers for the specified history system ID.
Default: None
Notes:
■
The wildcard character, *, can be used for this parameter only when
specified as the last character.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 241
SYSIN01 Parameters
OSYSNAME
Limits the history request to only those file transfers with a specific history
system name in an XCOMPLEX environment.
xxxxxxxx
A one- to eight-character history system name used to limit the history
request to only those file transfers for the specified history system name.
Default: None
Notes:
■
The wildcard character, *, can be used for this parameter only when
specified as the last character.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
OTNAME
Limits the history request to only those file transfers with a specific remote
TCP/IP name or TCP/IP address.
xxxxxxxx…x
A 1- to 64-character TCP/IP name or address used to limit the history
request to only those file transfers for the specified TCP/IP name or address.
Default: None
Notes:
242 User Guide
■
The wildcard character, *, can be used for this parameter only when
specified as the last character.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
OTYPE
Specifies if the history request should include inactive transfer requests, active
transfer requests, or completed transfers.
I
Selecting this option retrieves history records for file transfers whose
execution is still pending.
A
Selecting this option retrieves history records for file transfers that are
currently in progress.
C
Selecting this option retrieves history records for file transfers that have
been successfully or unsuccessfully completed.
ALL|AIC|*
Selecting this option retrieves history records for all file transfers,
independent of their status.
Notes:
■
You can also specify values in combination; for example, specify AI to
request history records for file transfers currently in progress and file
transfers whose execution is still pending.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: AIC
OTYPEREQ
Limits the history request to only send transfers or only receive transfers.
SEND or S
Restrict the search for file transfers to only send transfers.
RECEIVE or R
Restrict the search for file transfers to only receive transfers.
Default: None
Notes:
■
This parameter is case sensitive.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 243
SYSIN01 Parameters
OUSER
Limits the history request to only those file transfers submitted by a specific
user.
xxxxxxxxxxxx
A 1- to 12-character user name used to limit the history request to only
those file transfers submitted by the specified user.
Default: None
Notes
■
The wildcard character, *, can be used for this parameter.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters Required by FILETYPE=REPORT
The following additional parameters should only be coded when
FILETYPE=REPORT has been selected.
CHARS
Indicates the character set JES uses when the report is sent to a remote system.
xxxx
Specifies up to four alphanumeric characters representing the character set
JES uses when a report is sent to a remote system.
Default: None
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
244 User Guide
SYSIN01 Parameters
CLASS
Specifies the print class to which the report is printed. For example, if the
receiving system is a z/OS-supported mainframe, indicate the JES SYSOUT class
desired.
x
Specifies one alphanumeric character representing the print class where the
report is printed.
Note: When sending a report to an HP OpenVMS system, if you specify a value
for CLASS, make certain that it is a valid value for this remote system. If it is not,
the print job fails. Avoid this by defining this parameter with a value of null
(binary zero), space, or A.
Default: A
CONTROL
Indicates the printer carriage control codes present in the data stream.
ASA
ASA standard carriage control codes are used.
MACHINE
Specific hardware-dependent codes are used.
NONE
No carriage control codes are used.
Default: NONE
COPY (or COPIES)
Indicates the number of report copies printed.
0 to 255
Specifies the number of report copies to print.
Default: 1
Chapter 2: The Batch Interface 245
SYSIN01 Parameters
DEST
Indicates the printer or other device on the remote system receiving the report.
Up to 21 characters (Version=2 type transfers only)
Up to 8 characters (Version=1 type transfers only)
Specifies the printer or device on the remote system receiving the report.
Notes:
■
The DEST parameter can contain a fully qualified printer file name when the
report is sent to an AS/400.
■
The actual number of bytes allowed for this parameter is dependent on the
remote system.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Default: System default printer
DISP
Determines whether to keep or delete the report file after printing on the remote
system. This value is ignored when the remote system is an IBM mainframe.
KEEP
Keep the report file after it is printed on the remote system.
DELETE
Delete the report file after it is printed on the remote system.
Default: DELETE
FCB
Indicates the name of the Forms Control Buffer that JES uses from
SYS1.IMAGELIB when the report is sent to a remote z/OS system.
xxxx
Specifies the name of the Forms Control Buffer that JES uses when the report
is sent to a remote z/OS system. The name can be up to four alphanumeric
characters long.
Default: System default value
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
246 User Guide
SYSIN01 Parameters
FORM
Tells the remote operator the kind of form on which to print a report.
xxxx
Specifies up to four alphanumeric characters representing the kind of form
on which to print the report.
Notes:
■
If you specify a special form value, make certain the value is valid for the
remote system. Otherwise, the print job fails. If in doubt, use the default.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
REPORT
Supplies the title of the report.
Up to 21 alphanumeric characters
Specifies the title of the report.
Notes:
■
Depending on the operating system printing the report, this parameter may
only be used as a comment, which would not be printed as part of the report.
It may be part of a banner page produced with the report.
■
IBM iSeries and HP OpenVMS print this field in a banner page. With reports
sent to a z/OS system, this entry becomes part of the banner page. The
banner page consists of the report title and the values designated in the
CLASS and FORM parameters.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
REPORTHOLD
Designates whether the report should be held or prepared for immediate
printing.
YES
Hold the report.
NO
Print the report immediately.
Note: This parameter cannot be used with a Windows or a UNIX partner.
Default: NO
Chapter 2: The Batch Interface 247
SYSIN01 Parameters
SPOOL
Designates whether to spool the report to disk or to print it directly. If the remote
system is z/OS, this operand has no effect on the transfer.
YES
Spool the report to disk.
NO
Do not spool; print the report immediately.
Default: YES
WRITER
Specifies the name of the external writer that is to process the report on the
remote system.
xxxxxxxx
Specifies up to eight alphanumeric characters identifying the external writer
that is to process this report on the remote system.
Notes:
■
This parameter cannot be specified with Version 1 transfers.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Tape Parameters
The parameters described in this section can be used when tape drives are
involved in the transaction. Allowable values for these parameters are the same
as for their IBM JCL counterparts, except where noted. You can also refer to this
section for parameter information when using the Menu Interface.
Note: When tape drives are involved in the transaction, it may be necessary to
use also some of the parameters discussed in the section, FILETYPE=FILE
Parameters, such as the parameters LUNIT, LVOL, UNIT, and VOL.
DEN
Specifies the density to be used in creating a tape on the local or remote system.
1 to 4
Specifies the density to be used in creating a tape on the local or remote
system. Valid values are the same as those for the DEN parameter in JCL.
248 User Guide
SYSIN01 Parameters
EXPDT
Specifies the expiration date to be placed on the tape data set being created.
yyddd
Specifies an expiration date for the tape data set as a two-digit designation
for the year and a three-digit designation for the day of the year. For
example, in the expiration date 09021, 09 is the year (namely, 2009), and
021 is the 21st day of that year. The tape data set will expire on January 21,
2009.
yyyy/ddd
Specifies an expiration date for the tape data set in terms of a four-digit
designation for the year and a three-digit designation for the day of the year.
For example, in the expiration date 2009/021, 2009 is the year, and 021 is
the 21st day of that year. The tape data set will expire on January 21, 2009.
Note: EXPDT and RETPD are mutually exclusive; specify one or the other.
LABEL
Indicates the type of label associated with a tape data set. The label of a tape
data set is specified in terms of a sequence number and a designation for the
type of processing to be applied to the data set. The following table lists the valid
values for both label components:
sequence number (0001 to 9999)
This value identifies the sequence number of a data set on tape.
Default: 0001
processing type (AL, AUL, BLP, LTM, NL, NSL, SL, SUL)
Represents the types of processing to be applied to data sets on tape.
Default: None
Default: (1,SL)
Notes:
■
CA XCOM Data Transport writes only standard label tapes.
■
This parameter should be specified in the same way that the LABEL
parameter appears in the JCL-see the following example.
Example
LABEL=(2,BLP)
This specification refers to the second data set on the tape. The type of
processing to be applied to this data set is BLP.
Chapter 2: The Batch Interface 249
SYSIN01 Parameters
LLABEL
Specifies the sequence number of the file on the tape volume to be used for the
local data set, and the type of processing to be applied to the data set (sequence
number, processing type).
Valid values that can substitute for these variables are as follows:
sequence number (1 to 9999)
This value identifies the sequence number of a data set on tape.
processing type (AL, AUL, BLP, LTM, NL, NSL, SL, SUL)
Represents the types of processing to be applied to data sets on tape.
Note: This parameter should be specified in the same way that the LABEL
parameter appears in the JCL.
Default: (1,SL)
Example
LLABEL=(2,BLP)
This specification refers to the second data set on the tape. The type of
processing to be applied to this data set is BLP.
LUNITCT
Specifies the number of units to be allocated on the local system.
1 to 20
Specifies the number of units to be allocated on the local system.
LVOLCT
Specifies the maximum number of volumes to be used in processing a
multivolume output tape data set on the local system.
1 to 255
Specifies the maximum number of volumes to be used in processing a
multivolume output tape data set on the local or remote system.
250 User Guide
SYSIN01 Parameters
LVOLSQ
Specifies the sequence number of the first volume of a multivolume remote data
set to be used.
1 to 255
Specifies the sequence number of the first volume of a multivolume remote
data set to be used.
RETPD
Specifies the number of days to retain the tape data set being created.
1 to 9999
Specifies the number of days (1 to 9999) that the tape data set being created
is to be retained.
Default: None
Note: RETPD and EXPDT are mutually exclusive; specify one or the other.
TAPE
Indicates to the remote system whether the volume is a tape volume or a disk
file.
YES
Indicates that the transfer is to a tape volume and that mounts are allowed
when performing dynamic allocation.
NO
Indicates that the transfer is to a disk file.
Note: If the remote data set is on tape, TAPE=YES must be specified for CA
XCOM Data Transport to process the other tape parameters. Otherwise, all the
tape parameters revert to their default values. This is especially important if the
remote data set spans more than five tape volumes.
UNITCT
Specifies the number of units to be allocated on the remote system.
1 to 20
Specifies the number of units to be allocated on the remote system.
Default: None
Chapter 2: The Batch Interface 251
SYSIN01 Parameters
VOLCT
Specifies the maximum number of volumes to be used in processing a
multivolume output tape data set on the remote system.
1 to 255
Specifies the maximum number of volumes to be used in processing a
multivolume output tape data set on the remote system.
Default: None
VOLSQ
Specifies the sequence number of the first volume of a multivolume remote data
set to be used.
1 to 255
Specifies the sequence number of the first volume of a multivolume remote
data set to be used.
SYSIN01 DCB Parameters
CA XCOM Data Transport allows the user to specify DCB information for files
created or replaced locally or remotely by using the RECFM, LRECL, and BLKSIZE
SYSIN01 parameters.
Users enter the DCB information when creating a file on the local system. Under
these circumstances, the DCB information for the file transmitted is the default
DCB information. Specifying the RECFM, LRECL, and BLKSIZE parameters
overrides the default DCB information. The DCB information (specifically the
LRECL operand) determines the maximum record length that the PC reads when
receiving a binary file from z/OS. The local system confirms the accuracy of the
three parameters.
When a z/OS-initiated receive is performed to a non-z/OS partner, it is
recommended that all DCB-related parameters be coded in the SYSIN01 stream.
252 User Guide
SYSIN01 Parameters
BLKSIZE
Defines the block size of the file.
0 to 99999
Specifies a value 0 to 99999, indicating the block size of the file.
Notes:
■
If a receive request originates from a non-z/OS partner, the BLKSIZE should
be coded explicitly. The value of the parameter must be based on a
reasonable estimate.
■
BLKSIZE=0 is valid only if the value of RECFM is FB, FBx, VB, or VBx. When
BLKSIZE=0, z/OS (not CA XCOM Data Transport) determines the block size.
Default: BLKSIZE of the z/OS data set if a send or receive request of any type
originates from a z/OS partner.
LRECL
Defines the logical record length of the file.
0 to 99999
Specifies a value 0 to 99999, indicating the logical record length of the file.
Note: If a receive request originates from a non-z/OS partner, the LRECL should
be coded explicitly. The value of the parameter must be based on a reasonable
estimate.
Default: LRECL of the z/OS data set if a send or receive of any type request
originates from a z/OS partner.
Chapter 2: The Batch Interface 253
SYSIN01 Parameters
RECFM
Specifies the z/OS record format associated with a data set. This parameter uses
the same format as the z/OS JCL RECFM parameter.
F
Fixed
FA
Fixed ASA
FB
Fixed Blocked
FBA
Fixed Blocked ASA
FBM
Fixed Blocked Machine
FBS
Fixed Blocked Standard
V
Variable
VA
Variable ASA
VB
Variable Blocked
VBA
Variable Blocked ASA
VBM
Variable Blocked Machine
VBS
Variable Blocked Spanned
VS
Variable Spanned
U
Undefined
254 User Guide
SYSIN01 Parameters
RELEASE
Specifies whether the remote partner is to release unused DASD space when
creating a new file.
YES
The remote partner is to release unused DASD space.
The unused DASD space that is specified for the transfer is released when
the file is closed at the end of the transfer.
NO
The remote partner is not to release unused DASD space.
Default: No
Examples of DCB Information
The following are examples of DCB information that you can code in your
SYSIN01 data set, depending on the type of files being created:
Example 1
RECFM=FB
LRECL=80
BLKSIZE=8000
Example 2
RECFM=VB
LRECL=516
BLKSIZE=23440
Example 3
RECFM=U
BLKSIZE=19069
Chapter 2: The Batch Interface 255
SYSIN01 Parameters
SYSIN01 Transfer Control (XTC) Parameters
The SYSIN01 parameters described in this section form a feature of CA XCOM
Data Transport known as CA XCOM Data Transport Transfer Control (XTC).
These parameters are used to handle dependencies between multiple transfers
(For example, one transfer must complete in a certain way before another can
start). They provide the means by which interdependent transfer requests can
be defined and processed as a single group. A transfer request belonging to such
a group can cause another transfer request in the same group to be held,
purged, or released (either conditionally or unconditionally) from the transfer
request queue.
For further discussion of interdependent transfers, see the section Coding
Interdependent Transfers that follows the list of XTC parameters.
Delimiting Multiple Parameter Values
Several XTC parameters can be assigned up to eight values (typically, transfer
request names) at the same time. When assigning multiple values to a
parameter, commas must be used to separate the parameter values:
XTC_PARAMETER=VALUE1,VALUE2,. . .,VALUE8
HOLDCOUNT
Associates a number with a transfer request that is incremented or decremented
by the successful or unsuccessful completion of other transfer requests. As long
as the number is greater than 0, the transfer is not released.
0 to 255
Specifies a value that controls the holding/releasing of a transfer request.
The transfer is released when the value of the parameter reaches 0.
Note: See the description of the parameters XTCERRDECR, XTCERRINCR,
XTCGOODDECR, and XTCGOODINCR, which can decrement and increment the
value of the HOLDCOUNT parameter.
Default: 0
256 User Guide
SYSIN01 Parameters
XTCERRDECR
Specifies the transfer requests for which the HOLDCOUNT parameter value is
decremented when the current transfer completes unsuccessfully.
Up to eight transfer request names
Specifies up to eight transfers whose hold counts are to be decremented if a
transfer completes unsuccessfully.
Notes:
■
VTAM errors are not considered failed file transfers, because they are retried
later.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
XTCERRINCR
Specifies the transfer requests for which the HOLDCOUNT parameter value is
incremented if the current file transfer fails.
Up to eight transfer request names
Specifies up to eight transfers whose hold counts are to be incremented if the
current file transfer fails.
Notes:
■
A VTAM communications error does not count as a failure.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
XTCERRPURGE
Specifies the transfer requests to be purged if the transfer concludes
unsuccessfully.
Up to eight transfer request names
Specifies up to eight transfers to be purged if the current file transfer
concludes unsuccessfully.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 257
SYSIN01 Parameters
XTCERRREL
Specifies the transfers to be released if the current transfer completes
unsuccessfully.
Up to eight transfer request names
Specifies up to eight transfers to be released if the current transfer
completes unsuccessfully.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
XTCGOODDECR
Indicates an XTCNET job whose hold count decrements if the file transfer
completes successfully.
Up to eight transfer request names
Specifies up to eight transfers whose hold counts are to be decremented if
the current transfer completes successfully.
Notes:
■
If the current file transfer completes successfully, the value of the
HOLDCOUNT parameter of the transfers assigned to this parameter is
reduced by one, unless the next transfer has already started or the
HOLDCOUNT value has already reached zero.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
XTCGOODINCR
Indicates the transfer requests whose HOLDCOUNT parameter is incremented
when the current file transfer completes successfully.
Up to eight transfer request names
Specifies up to eight transfers whose hold counts are to be incremented if a
transfer completes successfully.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
258 User Guide
SYSIN01 Parameters
XTCGOODPURGE
Specifies the transfer requests to be purged when the current file transfer
completes successfully.
Up to eight transfer request names
Specifies up to eight jobs to be purged if a transfer completes successfully.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
XTCGOODREL
Specifies the transfer requests to be released if the current file transfer
concludes successfully.
Up to eight transfer request names
Specifies up to eight jobs to be released if a transfer completes successfully.
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
XTCJOB
Defines the name of a transfer request belonging to the group of interdependent
transfer requests named through the XTCNET parameter.
xxxxxxxx
Specifies the name of a transfer request in a group of interrelated transfer
requests.
Default: z/OS job name of the z/OS job requesting the file transfer
Note: You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
Chapter 2: The Batch Interface 259
SYSIN01 Parameters
XTCNET
Defines the name of a group of interdependent transfer requests.
xxxxxxxx
Specifies up to eight alphanumeric characters representing the name of the
XTC network running this transfer.
Notes:
260 User Guide
■
When using the XCOMPLEX, all transfers with the same XTCNET value are
distributed to the same XCOMPLEX Worker Server.
■
You can use symbolic variables with this parameter in batch SYSIN01. For
more information, see Symbolic Parameters.
SYSIN01 Parameters
Coding Interdependent Transfers
This section explains how to code a set of interdependent transfers in the
SYSIN01 DD statement.
■
The SYSIN01 parameter NEWXFER must be used at the beginning of each of
the multiple transfer requests as shown in the following diagram:
JOBNAME . . .
//STEP1. . . PGM=XCOM,PARM=('parm=parm_value')
.
.
.
//SYSIN01 DD *
transfer request 1 parameters
NEWXFER
XCOMJOB
JCL
SYSIN01
transfer request 2 parameters
The NEWXFER parameter is used
in the SYSIN01 DD statement
to signal the beginning of
each new transfer request 1,2,...i.
NEWXFER
transfer request i parameters
/*
//
Chapter 2: The Batch Interface 261
SYSIN01 Parameters
■
The parameter XTCNET is used to indicate which transfer requests belong to
the same group (are dependent on each other). Suppose, for example, that
the transfers XFER1, XFER2 and XFER3 need to be grouped together. This
can be accomplished simply by assigning the name of the group (say,
GROUP1) to XTCNET and including XTCNET=GROUP1 in the definition of
each of the three transfer requests. If XTC transfers are requested using the
XCOMPLEX, the XCOMPLEX Admin Server distributes all transfers with the
same value for XTCNET to the same XCOMPLEX Worker Server.
■
Each interdependent transfer request must have a unique name, which is
assigned to the XTCJOB parameter. Thus, if XFER1, XFER2 and XFER3 are
the names of three interdependent transfer requests, their definitions in
SYSIN01 must contain the parameter XTCJOB=XFER1, XTCJOB=XFER2, and
XTCJOB=XFER3, respectively.
■
XTC parameters other than XTCNET and XTCJOB are used to indicate the
dependencies obtaining between the transfer requests. The outcome of a
transfer request can affect as many as eight other transfer requests. In
addition to the XTC parameters, other SYSIN01 parameters can (and some,
for example, the local file name or LFILE, must) be used when defining
interdependent transfer requests.
■
HOLD=YES must be coded in each transfer request that is dependent on the
successful/unsuccessful completion of another transfer request. However,
HOLD=YES need not be coded if the holding/releasing of the transfer request
is controlled by the HOLDCOUNT parameter - shown following.
Example
The following sample definition contains three interdependent transfer requests:
//SYSIN01 DD *
NEWXFER
TYPE=SEND
FILE=A.B.C
LFILE=MY.FILE1
XTCNET=METS
XTCJOB=PAYROLL
HOLD=YES
NEWXFER
TYPE=RECEIVE
FILE=YOUR.FILE
LFILE=MY.FILE2
XTCNET=METS
XTCJOB=PAYME
HOLD=YES
NEWXFER
TYPE=SEND
FILE=PC.FILE
LFILE=MY.PC.FILE1
XTCNET=METS
262 User Guide
/*Transfer request 1 follows*/
/*Transfer request 2 follows*/
/*Transfer request 3 follows*/
SYSIN01 Parameters
XTCJOB=GETDATA
XTCGOODREL=PAYROLL
XTCGOODPURGE=PAYME
XTCERRPURGE=PAYROLL
XTCERRREL=PAYME
/*
//
In this example, the three transfer requests are identified as GETDATA, PAYME,
and PAYROLL, and they belong to the group METS. Of these, GETDATA is the
parent transfer request, that is, the request that tries to execute first and the
execution of which controls the subsequent execution of the other two
(dependent) transfer requests. Four XTC parameters (other than XTCNET and
XTCJOB) are associated with the transfer request GETDATA.
XTCGOODREL=PAYROLL means that the PAYROLL transfer belonging to the
same group (METS) as GETDATA is to start if GETDATA completes successfully.
At the same time, the PAYME transfer is to be purged from the transfer request
queue (XTCGOODPURGE=PAYME). However, if GETDATA does not complete
successfully, then the PAYROLL transfer is to be purged
(XTCERRPURGE=PAYROLL) and the PAYME transfer is to start
(XTCERRREL=PAYME).
Note:TYPE=SCHEDULE is required for XTC transfer requests.
Chapter 2: The Batch Interface 263
SYSIN01 Parameters
Coding XTC Transfers in an XCOMPLEX Environment
When submitted to the Admin, all XTC transfers within a SYSIN01 input are
routed and scheduled to the same server selected for the first XTC transfer in this
group.
TYPE=SCHEDULE XTC transfers submitted through the XCOMPLEX Admin must
have XTCJOB and XTCNET names that are unique to the submitted XCOMJOB.
Note: Use an individual's z/OS TSO signon ID as the XTCNET name to make sure
that it is unique.
All transfers within each SYSIN01 must be executed, released, or purged, and
cannot be extended into subsequent SYSIN01s. This is because new transfers
may be scheduled by the Admin to a server other than the one chosen for the
initial SYSIN01.
When using XTC to submit multiple jobs or job steps with the same XTCNET and
XTCJOB names, submit directly to the CA XCOM server. This ensures that they
go to the same CA XCOM SERVER.
At the end of each XTC run, ensure that there are no XTC transfers left in HOLD
status. Use the CA XCOM Data Transport DELETE or RELEASE operator
commands to do this. For more information, see the chapter ―Operation and
Control.‖
Note: Before resubmitting an XTC transfer job, go into the appropriate servers
and use the CA XCOM Data Transport SHOW command to check for any left over
XTC transfers. Use the above procedure to clean up any transfers in HOLD
status.
XCOMJOB Return Codes
The following table lists the return codes that an XCOMJOB can return:
Return
Code
Description
Valid XCOMJOB Type
0
Successfully scheduled or executed
transfer, all transfers completed
successfully.
All types
1
Partially successful, at least one
transfer worked successfully.
TYPE=EXECUTE
XCOMINQ file is empty.
TYPE=INQUIRE
4
264 User Guide
TYPE=SCHEDULE
SYSIN01 Parameters
Return
Code
Description
Valid XCOMJOB Type
8
ACB not open.
TYPE=EXECUTE
TYPE=SCHEDULE
Unable to access the XCOMINQ file
TYPE=INQUIRE
9
Session not established.
All types
10
A TIMEOUT occurred.
TYPE=EXECUTE
TYPE=SCHEDULE
12
A file error occurred.
TYPE=EXECUTE
TYPE=SCHEDULE
16
A logic error occurred.
TYPE=EXECUTE
TYPE=SCHEDULE
20
A VTAM error occurred.
TYPE=EXECUTE
TYPE=SCHEDULE
32
Another type of error occurred, for
example, an incorrectly coded
parameter.
TYPE=EXECUTE
TYPE=SCHEDULE
36
At least one transfer request exists for TYPE=INQUIRE
which status information is not yet
available.
40
At least one transfer did not complete
successfully.
TYPE=INQUIRE
44
There is at least one transfer request
for which status information is not yet
available and at least one transfer
request that did not complete
successfully.
TYPE=INQUIRE
48
No history record was found for the
request.
TYPE=INQUIRE
Chapter 2: The Batch Interface 265
Chapter 3: The Programming Interface
This chapter describes how to invoke CA XCOM Data Transport from application
programs to execute file transfers. Examples of COBOL and Assembler main
programs calling XCOMJOB as a subprogram have also been provided.
Any programming language supporting standard z/OS linkage conventions can
call CA XCOM Data Transport, including the following:
■
COBOL
■
C
■
FORTRAN
■
Assembler
This section contains the following topics:
The CA XCOM Data Transport Process (see page 267)
Allocating the Local Data Set and Parameter Files (see page 268)
Calling CA XCOM Data Transport from a COBOL Program (see page 269)
Calling CA XCOM Data Transport from an Assembler Program (see page 271)
The CA XCOM Data Transport Process
CA XCOM Data Transport can be directed to execute a file transfer immediately
or to queue it until the necessary resources are available. These instructions, and
all the transfer's processing options, are given to CA XCOM Data Transport by
parameters passed through the application program. These can be one-time
values for individual file transfers, or they can be installation-wide defaults
implemented automatically.
The CA XCOM Data Transport routine XCOMJOB runs as a called program and is
the same program used in the CA XCOM Data Transport Batch Interface (see the
chapter ―The Batch Interface‖). The program that calls XCOMJOB must pass the
equivalent of the EXEC PARM values, and must prime the local and SYSIN01 data
sets. The instructions for coding the PARM values and the SYSIN01 parameters
are identical to those for the CA XCOM Data Transport Batch Interface and are
fully described in the chapter ―The Batch Interface.‖
Note: TYPE=EXECUTE and TYPE=SCHEDULE are supported with the APIs.
Important! Calls to CA XCOM Data Transport as a subprogram should be
dynamic (using the LOAD or LINK macro). Do not try to link edit any of the CA
XCOM Data Transport modules to your program.
Chapter 3: The Programming Interface 267
Allocating the Local Data Set and Parameter Files
Allocating the Local Data Set and Parameter Files
This section describes how to allocate your local data set and parameter files.
Define Two CA XCOM Data Transport Files
To call CA XCOM Data Transport as a subprogram, you must define two CA XCOM
Data Transport files in the job step executing your application:
File
Description
The file identifying the local data This can be either the file being transferred
set involved in this transfer.
to the remote system, or the name of the
data set in which CA XCOM Data Transport
will store the data received from the remote
system. Define this data set using either the
LCLDS01 DD statement or the SYSIN01 file's
LFILE parameter.
Note: If both are specified, the data set
defined by LFILE takes precedence.
The file that passes parameters
to CA XCOM Data Transport.
These instructions include whether this is an
inbound or outbound transfer and whom to
notify on the remote system when the
transfer is completed.
The DDNAME for this file is SYSIN01.
Allocate these two files to your job through JCL DD statements or by dynamic
allocation. You will probably only use the dynamic allocation method for
interactive or Assembler programs.
Sample DD Statement
The following is a sample DD statement allocating LCLDS01:
//LCLDS01 DD DISP=SHR,DSN=LOCAL.FILE(NAME)
//SYSIN01 DD DISP=SHR,DSN=PARM.FILE(NAME)
268 User Guide
Calling CA XCOM Data Transport from a COBOL Program
Calling CA XCOM Data Transport from a COBOL Program
Use the COBOL verbs CALL and CANCEL to load and delete the CA XCOM Data
Transport modules in your address space. Before making the call to CA XCOM
Data Transport, make sure that the files SYSIN01 and LCLDS01 have been
allocated to the job step that executes your application program (unless the local
file was defined with the LFILE parameter).
You do not have to load the parameters in SYSIN01 before the job starts.
Instead, you can OPEN the file for output and write the parameters to it one
80-character output record at a time. This way, the application program
determines the parameter values.
Code a working storage data item for the Batch Interface routine XCOMJOB. This
should be an eight-character alphanumeric with a VALUE clause set to
XCOMJOB. Call CA XCOM Data Transport dynamically.
Make your PICTURE clause large enough to accommodate the total length of
your parameter data. Move the length of the XCOM-PARM-DATA field into the
XCOM-PARM-LEN.
Chapter 3: The Programming Interface 269
Calling CA XCOM Data Transport from a COBOL Program
Sample Fragment
The following is a sample fragment of a COBOL program that calls CA XCOM Data
Transport:
//**********************************************************************
//* SAMPLE COBOL PROGRAM TO CALL XCOM API *
//* STEP COB - COMPILE SAMPLE PROGRAM *
//* STEP LKED- LINK-EDIT SAMPLE PROGRAM *
//* STEP RUN - EXECUTE SAMPLE PROGRAM *
//**********************************************************************
//S1 EXEC COBUCL,PARM.COB='PM AP'
//COB.SYSIN DD
000100 IDENTIFICATION DIVISION.
000200 PROGRAM-ID. SAMPCOB.
000300 AUTHOR. COMPUTER ASSOCIATES INTERNATIONAL
000400
000500
000600
000700
000800 DATE-WRITTEN. SEP 2001.
000900 DATE-COMPILED. SEP 2001.
001000
001100 ENVIRONMENT DIVISION.
001200 CONFIGURATION SECTION.
001300 INPUT-OUTPUT SECTION.
001400 FILE-CONTROL.
001500 SELECT SYSIN-FILE ASSIGN TO S-S YSIN01
001600
001700 DATA DIVISION.
001800 FILE SECTION.
001900 FD SYSIN-FILE
002000 LABEL RECORDS ARE STANDARD
002100 RECORD CONTAINS 80 CHARACTERS
002200 BLOCK CONTAINS 0 RECORDS
002300 DATA RECORD IS SYSIN-REC.
002400 01 SYSIN-REC PIC X(80).
002500
002600 WORKING-STORAGE SECTION.
002700 01 XCOM-API PIC X(8) VALUE “XCOMJOB”.
002800 01 XCOM-PARM.
002900 05 XCOM-PARM-LEN PIC S9(4) COMP VALUE +44.
003000 05 XCOM-PARM-DATA PIC X(46)
003100 VALUE “TYPE=EXECUTE,LOGMODE=XCOMMODE, STCAPPL=XCOMAPPL“.
003200
003300 PROCEDURE DIVISION.
003400 STARTUP SECTION.
003500* *************************************************************
003600* * HERE WE CREATE SYSIN01 FILE INSTREAM
000370* *************************************************************
270 User Guide
Calling CA XCOM Data Transport from an Assembler Program
003800 OPEN OUTPUT SYSIN-FILE.
003900 MOVE “LU=LU26505 “ TO SYSIN-REC. WRITE SYSIN-REC.
004000 MOVE “COMPRESS=YES “ TO SYSIN-REC. WRITE SYSIN-REC.
004100 MOVE “TYPE=SEND “ TO SYSIN-REC. WRITE SYSIN-REC.
004300 MOVE "FILETYPE=FILE " TO SYSIN-REC. WRITE SYSIN-REC.
004400 MOVE "LFILE=XCOM.RB5.SAMPLIB(XCSAMCOB)" TO SYSIN-REC.
004450 WRITE SYSIN-REC.
004500 MOVE "CODE=EBCDIC " TO SYSIN-REC. WRITE SYSIN-REC.
004600 MOVE "FILE=C:\MVS\TEMP " TO SYSIN-REC. WRITE SYSIN-REC.
004700 CLOSE SYSIN-FILE
004800
004900* *************************************************************
005000* * WE WILL CALL XCOMJOB HERE
005100* *************************************************************
005200
005300 CALL XCOM-API USING XCOM-PARM.
005400 IF RETURN-CODE NOT EQUAL ZEROS
005500 THEN DISPLAY "TRANSFER FAILED"
005600 ELSE DISPLAY "TRANSFER SUCCESSFUL".
005700 STOP RUN.
//********************************************************************
//* LINK-EDIT PROGRAM *
//********************************************************************
//LKED.SYSLMOD DD DSN=XCOM.APF3.LINKLIB,DISP=SHR
//* INCLUDE SYSLMOD(XCOMJOB)
//LKED.SYSIN DD *
ENTRY SAMPCOB
NAME SAMPCOB(R)
//********************************************************************
//* EXECUTE PROGRAM *
//********************************************************************
//RUN EXEC PGM=SAMPCOB
//STEPLIB DD DSN=XCOM.APF3.LINKLIB,DISP=SHR
//SYSOUT DD SYSOUT=*
//SYSPRINT DD SYSOUT=*
//*XCOMGLOB DD DSN=XCOM.RB5.GLOBAL,DISP=SHR *FOR TYPE=EXECUTE
//*XCOMREST DD DSN=XCOM.RB5.RESTART,DISP=SHR *FOR TYPE=EXECUTE
//*SYSUDUMP DD SYSOUT=*
//SYSIN01 DD DSN=&TEMP,DISP=(NEW,DELETE,DELETE) ,SPACE=(TRK,(1,1)),
// DCB=(LRECL=80,BLKSIZE=8000,RECFM=FB),UNIT=SYSDA
Calling CA XCOM Data Transport from an Assembler
Program
Use the LOAD macro to load a new copy of the CA XCOM Data Transport routine
into main storage. Use the DELETE macro to delete the program from main
storage.
Chapter 3: The Programming Interface 271
Calling CA XCOM Data Transport from an Assembler Program
Sample Assembler Program
The following is a sample fragment of an Assembler program.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8* *
* This program shows how to invoke XCOMJOB from an assembler
* program.
* On entry, it is assumed that the control statements for
* the transfer request reside in the data set allocated to
* the SYSIN01 DD statement. XCOMJOB is then loaded into
* storage and receives control via a BALR instruction.
* On return, it is removed from storage via a DELETE SVC.
ASMSAMP CSECT ,
ASMSAMP AMODE 31
ASMSAMP RMODE 31
*
STM R14,R12,12 (R13) Store entry registers
LR R11,R15 Load base register
USING ASMSAMP,R11 Establish addressability
*
GETMAIN RU,LV=WRKL Request work area storage
*
LR R2,R13 Keep current save area address
*
LR R13,R1 Load work area address
USING WRK,R13 Establish addressability
LR R14,R1 Load registers for MVCL
LA R15,WRKL
SLR R0,R0
LR R1,R0
MVCL R14,R0 Clear work area to zeros
*
ST R2,WRKSAVE+4 Chain save areas
ST R13,8(,R2)
*
LOAD EPLOC=XCOMJOB Load XCOMJOB into storage
*
LA R1,PARMADDR Point to parm list address
LR R15,R0 Load entry point address
BALR R14,R15 Invoke XCOMJOB
DELETE EPLOC=XCOMJOB Remove XCOMJOB from storage
*
LR R1,R13 Load work area address
L R13,WRKSAVE+4 Unchain save areas
FREEMAIN RU,LV=WRKL,A=(1) Free work area storage
*
LM R14,R12,12(13)
Continued
Continued
BR R14
272 User Guide
*
*
*
*
*
*
*
Calling CA XCOM Data Transport from an Assembler Program
*
*
PARMLIST DS 0D XCOMJOB parameter list
PARMLEN DC AL2(L'PARMDATA) Parameter list length
PARMDATA DC C'TYPE=EXECUTE,ACBNAME=XCOMAPPL,LU=DENVER' X
..Parameters
*
XCOMJOB DC CL8'XCOMJOB' XCOMJOB program name
*
WRK DSECT , Local work area
WRKSAVE DS 18F Register work area length
*
*REGS
*
END ASMSAMP
Chapter 3: The Programming Interface 273
Chapter 4: The Remote Spooling Feature
(Process SYSOUT)
This chapter describes how CA XCOM Data Transport executes file transfers from
a local z/OS system to other systems through the JES2 or JES3 spool.
This section contains the following topics:
Basics of JES Spool Use (see page 275)
Process SYSOUT Enhancements (see page 282)
JES2 Considerations (see page 284)
JES3 Considerations (see page 285)
PSOPREF Considerations (see page 286)
Basics of JES Spool Use
This section describes the basics of how CA XCOM Data Transport uses the JES2
or JES3 spool to execute file transfers from a local z/OS system to other systems.
Chapter 4: The Remote Spooling Feature (Process SYSOUT) 275
Basics of JES Spool Use
Advantages of Using the Process SYSOUT Interface
The Process SYSOUT Interface allows passive use of CA XCOM Data Transport.
No CA XCOM Data Transport commands or CA XCOM Data Transport JCL
procedures are necessary. User programs, IBM utility programs such as
IEBGENER, and common TSO commands such as PRINTOFF, VPSPRINT, and
DSPRINT can invoke CA XCOM Data Transport.
Process SYSOUT files can contain logical records up to 4K bytes in length. This
allows CA XCOM Data Transport to extract very large records from the spool.
Indirect (store-and-forward) file transfers also support logical record lengths up
to 4K.
Note: The 4K limit is a restriction of JES2 and JES3.
To summarize, the Process SYSOUT Interface offers the following advantages:
276 User Guide
■
Handles SYSOUT record lengths up to 4K.
■
Transfers different types of data, including binary characters.
■
Handles all of the following:
–
Files (only with indirect transfers)
–
Jobs to be executed on the remote system (only with indirect transfers)
–
Reports to be printed on the remote system
■
Allows data to be queued to remote destinations (via the JES spool) even
when the CA XCOM Data Transport server is temporarily down.
■
Allows CA XCOM Data Transport to act as a replacement for the Network Job
Entry (NJE) system.
■
Can be used by TSO users and for transactions within the following:
–
CICS
–
IDMS
–
Model 204
–
TPF
–
ROSCOE
Basics of JES Spool Use
Process
The CA XCOM Data Transport server must be active and have PSO enabled if file
transfers are to be queued. The only transmissions that can be queued for
transfer while the server is down are Process SYSOUT JES spool files.
PSO can be disabled in a CA XCOM Data Transport server by specifying PSO=NO
on the XCOMXFER EXEC parameter only. For more information, see the Default
Options Table in the chapter "Configuration Parameters" in the CA XCOM Data
Transport for z/OS Administration Guide.
Note: PSO is not supported in the XCOMPLEX. The XCOMPLEX Admin Server
cannot be used to distribute PSO transfers requests.
While it is running, the CA XCOM Data Transport server continually scans the JES
output queue for files to be sent to any of the destinations or writers (defined in
the CA XCOM Data Transport control library) that it services. When CA XCOM
Data Transport recognizes work in its serviced JES destinations or writers, it
executes a file transfer to the targeted system.
CA XCOM Data Transport can scan the JES spool for either a specific destination
or an external writer. An external writer can direct output to a specific printer on
a remote system to permit a more detailed specification than is available when
using RJE.
You can use the destination parameter PSOWAIT to control whether output is
pulled from the JES spool immediately and held in temporary data sets or is
allowed to remain on the JES queue until a session is available to transmit it on.
For more information on the use of PSOWAIT, see the section Using PSOWAIT in
this chapter.
Note: PSOWAIT is not a valid option for a TCP/IP transfer.
Overview—Sending Reports with PSO
CA XCOM Data Transport for z/OS scans the JES queue automatically for reports
to transfer to remote partners. CA XCOM Data Transport selects reports either by
WRITER or DEST.
Chapter 4: The Remote Spooling Feature (Process SYSOUT) 277
Basics of JES Spool Use
Setup
The following criteria are required for setting up CA XCOM Data Transport to
send reports with PSO:
■
There must be a destination member of TYPE=DEST defined and enabled for
the remote partner. The destination member must contain one of the
following:
–
DEST=XCOM
–
WRITER=XCOM
In the following sample, XCOM represents the dest name or writer name
that is specified for the report on the JES Spool. An SNA address, IP
address, or IP name can be specified in the dest member.
■
The report must be queued to match the dest or writer name specified in the
destination member. It can be queued using an IEBGENER job or any other
program that can queue the reports with the correct WRITER or DEST
(samples provided).
■
If the destination is a TCP/IP destination, then TCPSESS must be set to at
least 2.
■
Security must permit CA XCOM Data Transport to access the reports on the
spool.
Notes:
278 User Guide
■
By default, CA XCOM Data Transport automatically starts a PSO subtask to
transfer JES spool files. It queries the JES spool at regular intervals (the
number of seconds specified in the JESINTV parameter in XCOMDFLT) to see
if there are any spool files that need to be transferred. If the PSO feature is
not being used, the parameter PSO=NO can be specified on the EXEC PARM
statement of the CA XCOM Data Transport server JCL. This prevents the
starting of the PSO subtask and eliminates the overhead associated with
checking for spool files to be transferred.
■
Report transfers are single-threaded. Only one report is sent to each
destination per scan of the spool.
■
The MAXRPTB parameter in the default table specifies the maximum block
size in bytes that CA XCOM Data Transport uses to write reports on the spool.
■
Temporary report data sets are written according to the PSOVOL and
PSOUNIT specified in the default table and start with a high level qualifier
specified by PSOPREF in the default table.
■
If PSOSECUR=YES, EXIT05 is called.
■
The PSODISP parameter in the default table specifies what happens to the
temporary report data set on the JES Spool if the report cannot be delivered.
If PSODISP=KEEP, these temporary data sets are retained if there is a
problem. If PSODISP=DELETE, these temporary data sets are deleted if
there is a problem and the report must be requeued to try again.
Basics of JES Spool Use
■
The PSOCKPT parameter in the default table allows you to specify different
checkpoint values for the report transfer. The default value is 1000. Turn off
checkpointing by specifying PSOCKPT=0. You can override the value by
specifying PSOCKPT in the dest member.
Sample JCL to Queue as DEST
//STEP001
//SYSPRINT
//SYSUT1
//SYSUT2
//SYSIN
EXEC PGM=IEBGENER
DD SYSOUT=*
DD DSN=XCOM.TEST.TRANSFER,DISP=SHR
DD SYSOUT=1,DEST=XCOMABC
DD DUMMY
Sample DEST Member (DEST)
TYPE=DEST
DEST=XCOMABC
IPNAME=141.202.156.2
Sample JCL to Queue as WRITER
//STEP001
//SYSPRINT
//SYSIN
//SYSUT1
//SYSUT2
EXEC PGM=IEBGENER
DD SYSOUT=A,HOLD=NO
DD DUMMY
DD DSN= XCOM.TEST.TRANSFER,DISP=SHR
DD SYSOUT=(A,XCOMABC)
Sample DEST Member (WRITER)
TYPE=DEST
WRITER=XCOMABC
IPNAME=141.202.156.2
Destination Definitions
Using CA XCOM Data Transport, you can specify that files appearing in the JES
spool (with JES DEST or WRITER names specified to CA XCOM Data Transport)
are to be sent automatically to specified LUs, IP addresses, users, a group or a
list of destinations. A destination can be defined as any of the following:
If the destination
is...
Transfers are tried to...
List
All destinations in a list. The destinations in the list can
be LUs or IP addresses.
Chapter 4: The Remote Spooling Feature (Process SYSOUT) 279
Basics of JES Spool Use
Group
The first destination in the group, and if that attempt
fails, the second destination in the group, and if that fails,
the third destination, that is, in the order that the
destinations have been defined in the group. The
destinations in the group must be LUs.
For TCP/IP, Group functions as an alias. It can be used as
a destination, but only one IP destination can be
specified for a group.
User
A specified user logged onto CA XCOM Data Transport.
To send a report, simply create SYSOUT output with a DEST or WRITER that CA
XCOM Data Transport can associate with a remote system or a user.
Assigning a JES Destination or Writer to a Remote System
The CA XCOM Data Transport Destination Table associates JES destinations with
remote systems logical unit (LU) name, IP address, or group of logical units).
This table is created when CA XCOM Data Transport is installed, and can be
modified at any time by using the CA XCOM Data Transport Destination Tables.
For more information, see the chapter ―Configuring and Customizing Your
Product‖ in the CA XCOM Data Transport for z/OS Administration Guide.
You can use JES to create Destination Table entries by updating the JES initiation
parameters according to whether the host system is running JES2 or JES3. For
more information, see JES2 Considerations and JES3 Considerations in this
chapter.
Assigning a JES Destination or Writer to a Specific User
The assignment TYPE=USER in the CA XCOM Data Transport Destination Table
allows a JES destination or writer to be routed to a specific user. When that user
logs on to CA XCOM Data Transport, all output queued to the destination or
writer specified in the user definition member is sent out on the session.
Note: This CA XCOM Data Transport feature is not supported for TCP/IP
destinations.
280 User Guide
Basics of JES Spool Use
Using Process SYSOUT with CICS or Other Online Systems
With CICS or other online systems, you can use the direct spool interface in
either of two ways:
■
Submit jobs through a z/OS internal reader.
■
Write to a partitioned transient data set (that is, a QSAM file) for the JCL to
direct to one of the remote destinations. If this method is used to send
multiple files to the same remote destination, the transient data queue
(sequential file) must be closed and reopened between the writing of each
file.
Using Process SYSOUT with TSO
TSO users can take advantage of the direct spool interface by using any
command that permits the allocation of a SYSOUT file to a JES destination. For
example, some newer versions of TSO allow specification of the DEST operands
with the ALLOCATE command. On TSO systems with the PRINTOFF command,
destinations can be specified on the command line. TSO users can also requeue
a data set to a specific destination.
Sample z/OS File Transfer to a PC
In this example, the sequential file HOST.SEQ.FILE is sent to a personal
computer. The sample destination name is PCLOBBY.
Note: This destination name must be a valid destination name to both CA XCOM
Data Transport and JES.
//MYJOB
JOB
453W,'XCOM DEMO',MSGCLASS=A,CLASS=J
//STEP1
//SYSPRINT
//SYSIN
//SYSUT1
//SYSUT2
/ *
EXEC
DD
DD
DD
DD
PGM=IEBGENER
SYSOUT=A
DUMMY
DISP=SHR,DSN=HOST.SEQ.FILE
SYSOUT=A,DEST=PCLOBBY
Chapter 4: The Remote Spooling Feature (Process SYSOUT) 281
Process SYSOUT Enhancements
Sample z/OS File Transfer to an HP OpenVMS
In this example, there is an application program located in New York that sends
data directly to an output file. The output data is transferred to a target HP
OpenVMS system. The application program writes an output file to the SYSOUT
destination VMSBOSTN, which is an HP OpenVMS system located in the Boston
office. CA XCOM Data Transport automatically sends this data to the OpenVMS
system.
//OUTBOUND JOB
ER2536,'XCOM DEMO', MSGCLASS=D,MSGLEVEL =1
//STEP1
//STEPLIB
//DD1
//DD2
//VMSFILE
/*
//
PGM=SERPROG
DISP=SHR,DSN=USER.LOADLIB
DISP=SHR,DSN=USER.FILE.ONE
DISP=SHR,DSN=USER.FILE.TWO
SYSOUT=A,DEST=VMSBOSTN
EXEC
DD
DD
DD
DD
Process SYSOUT Enhancements
This section describes process SYSOUT enhancements that you can use with CA
XCOM Data Transport.
External Writer Support
You can set the WRITER operand equal to the name of an external writer instead
of a destination name for when CA XCOM Data Transport looks for reports to
extract from the JES spool. WRITER can be used with DEST. To use a DEST and
WRITER for a single LU, you must define two groups with different group names
for the same LU.
Reasons for Using the External Writer
Reasons to use the external writer include the following:
282 User Guide
■
You do not need to define external writers to JES.
■
Held output is processed immediately.
■
External writers can facilitate the replacement of Network Job Entry (NJE)
with CA XCOM Data Transport.
■
External writers give you more options when sending output to remote
systems. For example, you can link remote host systems to particular
external writers; destination names are passed to the remote host, which
then equates them to a particular printer.
Process SYSOUT Enhancements
Sample Scenario
The following scenario illustrates how external writer support can be used.
CA XCOM Data Transport is directed to transfer SYSOUT between two z/OS hosts
(MVS1 and MVS2). Each has an external writer (also MVS1 and MVS2)
predefined by the other host system in their respective CA XCOM Data Transport
Destination Tables, but not to JES. A problem might arise if a different JES
destination (RMT2) on the remote host, other than the LOCAL predefined
destination, was needed.
Note: The remote system and a particular destination on it form what is called a
compound destination.
In this case, use both JES Destinations and External Writers. Direct CA XCOM
Data Transport to scan for the external writer name only. When CA XCOM Data
Transport finds work for the external writer (MVS2), it sends it on to MVS2, while
informing MVS2 that the destination name is RMT2. The output created by this
JCL on MVS1 is then printed on RMT2 on MVS2:
MVS1
.....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
#PSOTAB LU=APPLMVS2,
X
WRITER=MVS2
//OUTPUT DD SYSOUT=(A,MVS2),DEST=RMT2MVS1
MVS2
.....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
#PSOTAB LU=APPLMVS1,
X
WRITER=MVS1
//OUTPUT DD SYSOUT=(A,MVS1),DEST=RMT2
Routing to a Specific Minicomputer Printer
The following table provides an example of a CA XCOM Data Transport
Destination Table that equates the external writer name SYSAS400 with a logical
unit on an AS/400. CA XCOM Data Transport extracts this report from the JES
spool and sends it to the AS/400. After the transmission, the report is printed on
printer P3 of the AS/400.
//MYJOB
//STEP1
//SYSPRINT
//SYSIN
//SYSUT1
//SYSUT2
/*
JOB
EXEC
DD
DD
DD
DD
453W,'XCOM DEMO',MSGCLASS=A,CLASS=J
PGM=IEBGENER
SYSOUT=A
DUMMY
DISP=SHR, DSN=HOST.SEQ. FILE
SYSOUT=(A, SYSAS400),DEST=P3
Chapter 4: The Remote Spooling Feature (Process SYSOUT) 283
JES2 Considerations
Using PSOWAIT
The PSOWAIT option can be used to control whether output is taken from the JES
spool immediately and held in temporary data sets (PSOWAIT=NO) or whether
output is allowed to remain on the JES spool until a session is available to
transmit it on.
PSOWAIT=NO is the default value. Specify NO if:
■
The remote LU is on a leased line.
■
There are less than 100 nodes in the Destination Table.
■
The destination is an IP address.
PSOWAIT=YES prevents CA XCOM Data Transport from scanning the JES spool if
a session to send the data on does not exist. To reduce system overhead, specify
PSOWAIT=YES if there are more than a 100 nodes in the Destination Table.
Otherwise, specify NO.
For a description of the PSOWAIT parameter, see the CA XCOM Data Transport
for z/OS Administrator Guide.
JES2 Considerations
When you are using JES2, you need to use valid destination names, as described
in this section.
Valid Destination Names
JES2 can support thousands of distinct user destinations. Destination names
defined in JES2PARM can be changed to destination names defined in the CA
XCOM Data Transport Destination Table. For example, U123 might be equated to
Boston, U007 to VMSNY, and U2001 to SYSAS400 through JES DESTID
statements (in JES2):
DESTID
DESTID
DESTID
NAME=BOSTON,DEST=U123
NAME=SYSAS400,DEST=U2001
NAME=VMSNY,DEST=U007
The DESTID NAME must be a one- to eight-character alphanumeric entry. For
more information, see your JES2 Systems Programming Manual.
284 User Guide
JES3 Considerations
JES3 Considerations
When you are using JES3, you need to use valid destination names, as described
in this section.
Valid Destination Names
There is no limit on the number of distinct destination names JES3 can support.
JES3 also allows destination names to be specified either directly or generically.
Unlike JES2, JES3 provides no default destinations. Destinations are defined
using the RJPWS macro. When RJPWS is used, the CONSOLE statement is also
required.
Destinations are created using the N=name and G=group parameters of the
RJWPS statement. The N parameter must be five characters long. The G
parameter can be from one to eight characters long, and defaults to the value of
the name parameter.
If the group name is five or more characters, it is considered to define a generic
destination. We recommend using generic destinations because this approach is
likely to significantly decrease the number of times that the JES3 INISH deck
must be updated.
For the exact format of the JES3 definitions (because parameters that are not
discussed here may be required for your particular release of JES3), see the JES3
Systems Program Library Initialization and Tuning manual.
Note: CA XCOM Data Transport does not support RJE remote numbers or NJE
node numbers as DESTIDs for either JES2 or JES3.
Sample Specific Destination Definitions
The following example defines a specific destination called ABCDE and a generic
destination with the same name:
RJPWS,N=ABCDE
CONSOLE,JNAME=ABCDE
The following example defines two specific destinations called XCOM6 and A:
RJPWS,N=XCOM6,G=A
CONSOLE,JNAME=XCOM6
Chapter 4: The Remote Spooling Feature (Process SYSOUT) 285
PSOPREF Considerations
Sample Generic Destination Definition
The following example defines a specific destination called AAAAA and a generic
destination called XCOM6:
RJPWS,N=AAAAA,G=XCOM6
CONSOLE,JNAME=AAAAA
Examples of specific destinations that could all be designated by this one generic
destination include XCOM6LU1, XCOM6ABC, or XCOM6001.
PSOPREF Considerations
The PSO interface uses catalogued data sets as a staging area. This provides a
more reliable means of transferring data than temporary data sets, and also
permits PSO transfers to be checkpointed (and restarted) if necessary. The
checkpoint count for PSO transfers, PSOCKPT, is set to 1000 by default. This
value can be defined in the CA XCOM Data Transport default options table or in
the destination members. For PDSE program library transfers, CKPT parameter
is used to indicate the checkpoint value.
PSO data set names and temporary data sets created for PDSE program library
transfers are controlled by the PSOPREF parameter. This parameter specifies the
high-level qualifier used by CA XCOM Data Transport when creating data sets.
CA XCOM Data Transport then deletes these data sets after a file has been
successfully transferred.
Format for PSO Data Set Names
Data sets created by the PSO interface have the following data set name format:
prefix.Dyyddd.Thhmmss.Xnnnnnnn
The parts of the data set name are described below.
prefix
Specifies the value specified for PSOPREF in the default table
yyddd
Specifies the Julian date when the data set is created
hhmmss
Specifies the time that the data set is created
nnnnnnn
Specifies the decimal number incremented for each PSO transfer
286 User Guide
PSOPREF Considerations
For PDSE Program Library Transfers
Data sets created by the PSO interface for PDSE program library transfers have
the following data set name format:
■
prefix.Jyyddd.Thhmmss.@nnnnnnn for the initiating side
■
prefix.Jyyddd.Rhhmmss.#nnnnnnn for the receiving side
The parts of the data set name are as follows:
prefix
Specifies the value specified for PSOPREF in the default table
yyddd
Specifies the Julian date when the data set is created
hhmmss
Specifies the time that the data set is created
nnnnnnn
Specifies the request number for each PDSE program library transfer
Determining the User Catalog for the PSO Interface
The high-level qualifier of the prefix specified in the PSOPREF parameter
determines the system catalog in which the data sets created by CA XCOM Data
Transport's PSO interface are to be cataloged. If a user catalog alias has not
been created for this high-level qualifier, the data sets are cataloged in the
system's master catalog. Aside from being undesirable in most cases, this
requires MSTRCATU=YES to be specified in the CA XCOM Data Transport Default
Options Table.
You can create a user catalog for the CA XCOM Data Transport PSO interface
data sets by using the DEFINE USERCATALOG command under TSO or the
IDCAMS batch utility program. When this user catalog has been created, you can
use the DEFINE ALIAS command to establish the PSOPREF high-level qualifier as
an alias for that user catalog. CA XCOM Data Transport's PSO data sets are then
be cataloged in the user catalog.
For example, assume that the user catalog CATALOG.XCOM has been created for
the CA XCOM Data Transport PSO data sets. To establish the high-level qualifier
XCOMPSO as an alias for that user catalog, use the following DEFINE ALIAS
command:
DEFINE ALIAS(NAME('XCOMPSO')RELATE('CATALOG.XCOM'))
Chapter 4: The Remote Spooling Feature (Process SYSOUT) 287
Chapter 5: Operation and Control
This chapter describes the console commands provided with the CA XCOM Data
Transport for z/OS software.
This section contains the following topics:
Starting the CA XCOM Data Transport Server (see page 290)
Starting the XCOMPLEX Admin Server (see page 291)
Starting the XCOMPLEX Worker Server (see page 293)
Using the MODIFY Commands (see page 294)
Chapter 5: Operation and Control 289
Starting the CA XCOM Data Transport Server
Starting the CA XCOM Data Transport Server
To start CA XCOM Data Transport, enter one of the following commands on the
z/OS console (or any TSO/ISPF or NETVIEW session) where you are authorized
to invoke z/OS system commands:
START XCOM
S XCOM
Several informational messages are displayed when CA XCOM Data Transport is
started—see the following example:
XCOMM0672I CA XCOM (TM) DATA TRANSPORT (R) r11.5 - GENERATION LEVEL 0712 SP00
XCOMM0004I
XCOMM0004I
XCOMM0004I
XCOMM0008I
XCOMM0009I
XCOMM0763I
XCOMM0027I
XCOMM0037I
XCOMM0056I
XCOMM0056I
XCOMM0330I
XCOMM0330I
IPV6/SSL
IPV4/SSL
IPV4
IPV6
START=$XCMVS4
DFLTAB=XC04B50X
TCPSTACK=
XCOMMVS4 ACB OPENED SUCCESSFULLY
COMPILED UNDER VTAM V6 R1 M9 - EXECUTING UNDER VTAM V6 R1 M9 5695-117
DEFAULT TABLE XC04B50X LOADED. GENERATED 07/17/08 AT 09.16
ESTAE ROUTINE HAS BEEN ESTABLISHED
PSO SUBTASK ATTACHED SUCCESSFULLY
CA XCOM(TM) r11.5 (GEN LEVEL 0712 SP00) IS UP AND ACCEPTING LOGONS
ON CPU 2097 SERIAL # 01E000 IN 31-BIT MODE MVS SP7.0.9
PRIMARY SUBSYSTEM IS JES2
PRIMARY SUBSYSTEM IS JES2
XCOMM0821I STARTING XCOM TCP/IPV6 SSL LISTENER
XCOMM0806I STARTING XCOM TCP/IP SSL LISTENER
XCOMM0803I STARTING XCOM TCP/IP LISTENER
XCOMM0820I STARTING XCOM TCP/IPV6 LISTENER
After these messages have been displayed, the CA XCOM Data Transport server
begins scanning through the destinations specified by the CA XCOM Data
Transport control library. It is also ready to accept incoming requests from
remote systems
While it initializes, CA XCOM Data Transport issues one XCOMM0559I message
for each member that is enabled, as shown in the following example:
XCOMM0559I
XCOMM0559I
290 User Guide
AS400
MVSPAR
ENABLED SUCCESSFULLY
ENABLED SUCCESSFULLY
Starting the XCOMPLEX Admin Server
Starting the XCOMPLEX Admin Server
Normally, the XCOMPLEX Admin Server is brought up first, then the XCOMPLEX
Worker Servers, although this is not required.
To start a CA XCOM Data Transport XCOMPLEX Admin Server, enter one of the
following commands on the z/OS console (or any TSO/ISPF or NETVIEW session)
where you are authorized to invoke z/OS system commands:
START XCOMAD
S XCOMAD
Many of the messages that are displayed when you start the XCOMPLEX Admin
Servers are the same as when you start a stand-alone server, but the following
example shows some of the additional messages you will see. Note the
XCOMM0045I message, which indicates that an XCOMPLEX Worker Server has
successfully connected to the XCOMPLEX Admin Server.
XCOMM0990I
.
.
.
XCOMM0991I
XCOMM0991I
XCOMM0008I
XCOMM0009I
XCOMM0763I
XCOMM0027I
XCOMM0056I
XCOMM0056I
XCOMM1000I
XCOMM1000I
XCOMM0559I
XCOMM0559I
XCOMM0559I
XCOMM0559I
XCOMM1019I
XCOMM1020I
XCOMM1054I
XCOMM1017I
XCOMM1013I
XCOMM1022I
XCOMM1026I
XCOMM1013I
XCOMM1028I
ACTUAL XCOMDFLT PARMS:
XCOMPLEX=XCOMPLEX_QA
WINNERS =000004
XCPT
ACB OPENED SUCCESSFULLY
COMPILED UNDER VTAM V5 R1 M0 - EXECUTING UNDER VTAM V6 R1 M2
5695-11701-120
DEFAULT TABLE XCPTDFB5 LOADED. GENERATED 08/19/02 AT 11.56
ESTAE ROUTINE HAS BEEN ESTABLISHED
CA XCOM (R) r11.5 (GEN LEVEL 0410 SP00) IS UP AND ACCEPTING LOGONS
ON CPU 2064 SERIAL # 240AA1 IN 31-BIT MODE MVS SP7.0.2
CROSS-COUPLING FACILITY LISTENER TASK STARTING
STARTING CROSS-SYSTEM COUPLING FACILITY SERVICE TASK
XCOMPU
ENABLED SUCCESSFULLY
XCOMPS
ENABLED SUCCESSFULLY
XCOMPV
ENABLED SUCCESSFULLY
XCOMMVS4 ENABLED SUCCESSFULLY
XCF CONNECT STR=XCOMPLEX_QA
, CONN=XCPT
, RC=00000000,
RSN=00000000, DISP=OLD
MAXIMUM SERVERS SUPPORTED=00000061
MAXIMUM LIST ENTRIES SUPPORTED=00001673
XCF READING MASTER ENTRY FROM LIST #0000
XCF REQ=READ
RC=00000000 REASON=00000000 LIST=0000
ENTRY=XCOMPLEX_QA
LOCATING SERVER ENTRY IN LIST #0000
UPDATING MASTER ENTRY IN LIST #0000
XCF REQ=WRITE
RC=00000000 REASON=00000000 LIST=0000
ENTRY=XCOMPLEX_QA
ADDING SERVER ENTRY FOR NODE (XCPT
) WHICH IS USING LIST #0002
Chapter 5: Operation and Control 291
Starting the XCOMPLEX Admin Server
XCOMM1013I
XCOMM1013I
XCOMM1055I
XCOMM1013I
XCOMM1013I
XCOMM1013I
XCOMM0719I
XCOMM0618I
XCOMM0451I
XCOMM0719I
XCOMM0618I
XCOMM0451I
292 User Guide
XCF REQ=LOCK (SET)
RC=00000000 REASON=00000000 LIST=0002
XCF REQ=WRITE
RC=00000000 REASON=00000000 LIST=0000 ENTRY=
CLEARING LIST #0063 FOR USE BY NODE(XCPT
)
XCF REQ=DELETE_MULT
RC=00000000 REASON=00000000 LIST=0063
XCF REQ=MONITOR_LIST
RC=00000000 REASON=00000000 LIST=0063
XCF REQ=LOCK (RESET)
RC=00000000 REASON=00000000 LIST=0002
SESSION ESTABLISHED WITH PLU=XCOMMVS4, MODE=SNASVCMG, CID=04000061,
DEST=XCOMMVS4, SRUSIZE=00256, RRUSIZE=00256
REMOTE
CNOS REQUEST PROCESSED SUCCESSFULLY
XCOMMVS4 NOW CONNECTED TO XCOMPLEX Admin Server XCPT
SESSION ESTABLISHED WITH PLU=XCPV
, MODE=SNASVCMG, CID=3800000E,
DEST=XCOMPV , SRUSIZE=00256, RRUSIZE=00256
REMOTE
CNOS REQUEST PROCESSED SUCCESSFULLY
XCOMPV
NOW CONNECTED TO XCOMPLEX Admin Server XCPT
Starting the XCOMPLEX Worker Server
Starting the XCOMPLEX Worker Server
Normally the XCOMPLEX Admin Server is brought up first, then the XCOMPLEX
Worker Servers, although this is not a requirement.
The XCOMPLEX Worker Servers connect to the XCOMPLEX Admin Server
automatically if the TYPE=ADMIN destination member is defined in the
XCOMCNTL data set in the server JCL and included in the START member. If the
XCOMPLEX Admin Server is not up when the XCOMPLEX Worker Server is
brought up, the XCOMPLEX Worker Server retries the connection every 2
minutes for up to an hour. The connection can also be made manually by
enabling the dest member for the XCOMPLEX Admin Server and issuing a CNOS
modify command to the XCOMPLEX Admin Server.
To start a CA XCOM Data Transport XCOMPLEX Worker Server, enter one of the
following commands on the z/OS console (or any TSO/ISPF or NETVIEW session)
where you are authorized to invoke z/OS system commands:
START XCOMA
S XCOMA
Several informational messages are displayed when CA XCOM Data Transport is
started, as shown in the following example:
XCOMM1000I STARTING CROSS-SYSTEM COUPLING FACILITY SERVICE TASK
XCOMM0330I PRIMARY SUBSYSTEM IS JES2
XCOMM0056I CA XCOM (R) r11.5 (GEN LEVEL 0410 SP00) IS UP AND ACCEPTING LOGONS
XCOMM0056I ON CPU 2064 SERIAL # 240AA1 IN 31-BIT MODE MVS SP7.0.2
XCOMM0803I STARTING XCOM TCP/IP LISTENER
XCOMM1019I XCF CONNECT STR=XCOMPLEX_QA , CONN=XCPS, RC=00000000, RSN=00000000,
DISP=OLD
XCOMM1020I MAXIMUM SERVERS SUPPORTED=00000061
XCOMM1054I MAXIMUM LIST ENTRIES SUPPORTED=00001673
XCOMM1017I XCF READING MASTER ENTRY FROM LIST #0000
XCOMM1013I XCF REQ=READ
RC=00000000 REASON=00000000 LIST=0000
ENTRY=XCOMPLEX_QA
XCOMM1022I LOCATING SERVER ENTRY IN LIST #0000
XCOMM1026I UPDATING MASTER ENTRY IN LIST #0000
XCOMM1013I XCF REQ=WRITE
RC=00000000 REASON=00000000 LIST=0000
ENTRY=XCOMPLEX_QA
XCOMM1028I ADDING SERVER ENTRY FOR NODE (XCPS
) WHICH IS USING LIST #0005
XCOMM1013I XCF REQ=LOCK (SET)
RC=00000000 REASON=00000000 LIST=0005
XCOMM1013I XCF REQ=WRITE
RC=00000000 REASON=00000000 LIST=0000 ENTRY=
XCOMM1013I XCF REQ=MONITOR_LIST
RC=00000000 REASON=00000000 LIST=0005
XCOMM1013I XCF REQ=LOCK (RESET)
RC=00000000 REASON=00000000 LIST=0005
XCOMM1005I XCOMPLEX SERVICES ENABLED FOR NODE (XCPS
)
XCOMM0788I XCOM TCP/IP LISTENER ACTIVE ON PORT 8046, IP ADDRESS =
XCOMM1000I CROSS-COUPLING FACILITY LISTENER TASK STARTING
Chapter 5: Operation and Control 293
Using the MODIFY Commands
Using the MODIFY Commands
The CA XCOM Data Transport MODIFY commands allow users to interact with CA
XCOM Data Transport without logging on to ISPF and using the menu interface.
These commands use the same operating system facilities as the regular z/OS
MODIFY commands.
Most MODIFY commands can be used within the XCOMPLEX or in stand-alone
environments. The MODIFY commands DUMPXCF, NOXTRACE, STAT, XRSHOW,
XSHOW, and XTRACE are intended for the XCOMPLEX environments only and are
noted as such.
MODIFY Command Format
The general format of the MODIFY commands is as follows:
{F|MODIFY} procname,command[,operand1[,operand2]]
The following list explains the function of each MODIFY command element:
F|MODIFY
The keyword MODIFY, which can be abbreviated to F, identifies the following
string of comma-separated tokens as a MODIFY command.
procname
The name of the CA XCOM Data Transport server, XCOMPLEX Worker Server,
or XCOMPLEX Admin Server.
command
The CA XCOM Data Transport MODIFY command to be performed.
operand1
operand2
The first and second operand qualifying the MODIFY command.
Note: The number of operands that need to be specified depends on the
command.
Note: If you use NETVIEW, you can enter CA XCOM Data Transport commands
through NETVIEW. To do this, preface the standard CA XCOM Data Transport
command with MVS. For example:
MVS F XCOM,DIS,destname
294 User Guide
Using the MODIFY Commands
Notational Conventions
The following list explains the notational conventions used in the description of
the CA XCOM Data Transport Modify commands and in the specification of
resource names:
UPPERCASE
A literal. Enter exactly as shown. (In the preceding example, enter F XCOM
exactly as shown.)
lowercase italics
A variable. Replace with an appropriate value.
MIXed CASe
Enter in one of two ways:
■
In long form, by spelling out the item in uppercase-for example, the long
form of ACTivate is ACTIVATE.
■
In short form, by using only the capitalized letters-for example, the short
form of ACTivate is ACT.
n
A numeric variable. For example, n represents any number in the range 0 to
9 and nn is any number in the range 00 to 99.
Items separated by |
Indicates that the items are alternatives-one of the items must be chosen.
{Items in braces}
Indicates required items. One of the items in braces must be chosen.
[Items in brackets]
Indicates optional items. In such cases, you can specify one, more, or none
of the items enclosed in the brackets.
ACTIVATE Command
Starts a single session with the specified LU. If the LU is not available, the
request is queued. If a session has already been established with the LU, an error
message is displayed. If this format is entered without an LU name, an error
message is displayed, saying that the LU name is required for this command.
Format
F XCOM,ACTivate,destname
Chapter 5: Operation and Control 295
Using the MODIFY Commands
Operand
destname
Specifies the name of the logical unit to be activated.
Notes
The ACTIVATE command does not work for an LU defined for parallel sessions.
For those LUs, use the CNOS command, described later in this chapter.
The ACTIVATE command is not used for TCP/IP destinations.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access
Level
Resource Name
UPDATE
XCOM.applsec.ACTIVATE.destname
The variables represent the following values:
■
applsec-the value of the APPLSEC parameter in the Default
Options Table
■
destname-the name of the LU to be activated
Important! Do not specify a group name, because CA XCOM Data Transport
interprets this as an individual LU name.
ALTER Command
Alters date, time, scheduling priorities, or execution priorities.
Format
F XCOM,ALTER,nnnnnn,
{{DATE[,yyyymmdd|yyddd]|TIME[,hhmm]}|{SPRTY[,nnn]|EPRTY[,nnn]}}
296 User Guide
Using the MODIFY Commands
Operands
The following operands are used with the ALTER command:
DATE
Alters the starting date of the file transfer with request number nnnnnn. The
new starting date can be coded in one of two formats:
■
yyyymmdd
where:
–
yyyy is a four-digit designation for a year (for example, 2005)
–
mm is a two-digit designation for one of the twelve months of the
year as shown in the following chart:
1
4
7
10
–
=
=
=
=
January
April
July
October
2
5
8
11
=
=
=
=
February
May
August
November
3
6
9
12
=
=
=
=
March
June
September
December
dd is a two-digit number in the range 01 to 31, designating a day of
the month
Example
To change the start date for request 1084 to June 1, 2009, specify the
following:
/F XCOM,ALTER,1084,DATE,20090601
■
yyddd (Julian date)
where:
–
yy is a two-digit designation for a year (for example, 02)
–
ddd is a three-digit number in the range 001 to 366, designating a
day of the year
Example
To change the start date for request 1084 to February 1, 2009 (that is,
the 32nd day of 2009), specify the following:
/F XCOM,ALTER,1084,DATE,09032
If no date is coded, the default value of DATE is assumed as the new starting
date.
Default: Current date
Chapter 5: Operation and Control 297
Using the MODIFY Commands
EPRTY
Alters the execution priority (nnn) of the file transfer with request number
nnnnnn. The new execution priority can be coded in the operand nnn
following the keyword EPRTY. If the operand nnn is not coded, the default
value of EPRTY is assumed as the new execution priority.
If several file transfers are active at the same time, the processing priority is
given to that transfer that has the highest execution priority number.
Default: 16
hhmm
Specifies the hour (hh) and minute (mm) when the transfer with request
number nnnnnn is to start (on the originally scheduled day).
nnn
Specifies a number in the range 1 to 255 to indicate either the execution or
scheduling priority of the given file transfer.
Following the keyword EPRTY, this number indicates the new execution
priority of the file transfer with request number nnnnnn. The lowest
execution priority is 1.
Following the keyword SPRTY, this number indicates the new scheduling
priority of the file transfer with request number nnnnnn. The lowest
scheduling priority is 1.
nnnnnn
Specifies the transfer request number.
SPRTY
Alters the scheduling priority of the file transfer with request number
nnnnnn. The new scheduling priority can be coded in the operand nnn
following the keyword SPRTY. If the operand nnn is not coded, the default
value of SPRTY is assumed as the new scheduling priority.
If several transfers are scheduled to occur at the same time, they are
initiated in order of their priority numbers.
Default: 16
TIME
Alters the starting time (hhmm) of the file transfer with request number
nnnnnn. The new starting time can be coded in the operand hhmm following
the keyword TIME. If the operand hhmm is not coded, the default value of
TIME is assumed as the new starting time (on the originally scheduled date).
Default: 0000 (that is, midnight)
yyddd
Specifies a date according to the Julian calendar. For example, 09105 refers
to the 105th day of year 2009.
298 User Guide
Using the MODIFY Commands
Notes
Unless you have compelling reasons for not doing so, give short file transfers a
higher execution priority than very large transmissions. Doing so generally
enhances processing efficiency. The execution priority can be changed during
the transmission.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.DATE.destname.ownername
XCOM.applsec.EPRTY.destname.ownername
XCOM.applsec.SPRTY.destname.ownername
XCOM.applsec.TIME.destname.ownername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
CANCEL Command
Cancels an active session.
Format
F XCOM,CANCEL,{*|destname}[,Immed|Purge|SUSPend]
Chapter 5: Operation and Control 299
Using the MODIFY Commands
Operands
The following operands are used with the CANCEL command:
* (asterisk)
Cancels all active sessions.
destname
Cancels the specific session associated with the designated CA XCOM Data
Transport partner (destination).
The CA XCOM Data Transport partner can be identified with any one of the
following:
■
A valid SNA LU name
■
A TCP/IP name
■
A TCP/IP address.
The CA XCOM Data Transport partner name (destname) must match that
which is shown by the DISPLAY command.
If there is no active session with the partner, an error message is displayed.
IMMED
Cancels the session immediately, causing the transfer to be interrupted and
requeued. It is automatically retried after the error interval expires if
GETSESS=YES is specified, or when the session becomes available if
GETSESS=YES is not specified.
PURGE
Cancels the session immediately, causing the transfer to abort. The transfer
is terminated unconditionally, that is, it cannot be restarted but must be
rescheduled from the beginning.
SUSPEND
Cancels the session immediately, causing the transfer to be interrupted and
suspended. The transfer remains suspended until it is reactivated with the
RESUME command.
Notes
If no operand is coded following the CA XCOM Data Transport partner name
(destname) or * and the transfer is active on the session, the session is canceled
when the transfer completes.
For IMMED and SUSPEND, if checkpointing is active for the transfer, it is
restarted from the most recent checkpoint.
300 User Guide
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource
UPDATE
XCOM.applsec.CANCEL.destname.type
The parameters represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination (CA XCOM Data
Transport partner) involved in the transfer
■
type—one of the CANCEL command operands, that is,
IMMED, PURGE, or SUSPEND
CNOS Command
Starts an SNA parallel session with the specified LU.
Format
F XCOM,CNOS,membername,WINNERS=nnn,LOSERS=nnn
Chapter 5: Operation and Control 301
Using the MODIFY Commands
Operands
The following operands are used with the CNOS command:
membername
Specifies the name of the control library member containing the definition of
the partner LU.
The member name can be up to eight alphanumeric characters long.
nnn
Specifies a number in the range 0 to 999, which indicates either the number
of contention winner or loser sessions, depending on the associated operand
(see WINNERS and LOSERS in this table).
WINNERS
Specifies the number (nnn) of contention winner sessions for an LU/mode
pair.
Default: Current value
Note: For this operand to be valid, PARSESS=YES must be coded in the
control library member.
LOSERS
Specifies the number (nnn) of contention loser sessions for an LU/mode pair.
Default: Current value
Note: For this operand to be valid, PARSESS=YES must be coded in the
control library member.
Notes
CA XCOM Data Transport attempts to initiate the Change Number of Sessions
(CNOS) conversation with the partner LU only if the control library member
specified is enabled.
When WINNERS or LOSERS are specified, the group is updated with the
necessary parameters and CA XCOM Data Transport attempts to initiate the
CNOS conversation with the partner LU.
The CNOS command cannot be used with single session SNA LUs or with TCP/IP
destinations.
CNOS can optionally be used by the XCOMPLEX Admin Server to establish a
connection with the XCOMPLEX Worker Server in cases where a manual CNOS is
necessary. For more information, see the section Enable and Disable Commands
in the CA XCOM Data Transport for z/OS Administration Guide.
302 User Guide
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access
Level
Resource
UPDATE
XCOM.applsec.CNOS.membername
The parameters represent the following values:
■
applsec—the value of the APPLSEC parameter in the Default
Options Table
■
membername—the name of the control library member
DELETE Command
Deletes a transfer request from the pending queue.
Format
F XCOM,DELete,nnnnnn
Operand
The following operand is used with the DELETE command:
nnnnnn
Specifies the request number (up to six digits) of the transfer request to be
deleted.
Notes
Entering this command has no effect if the transfer is active.
Chapter 5: Operation and Control 303
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the security authorization for the
command issuer contain the following access level and resource specifications
for CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.DELETE.destname.ownername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
DFLT Command
Dynamically modifies certain default table parameters. The parameters that can
be modified are listed under the Operands section. These settings are in place
until CA XCOM Data Transport is stopped and restarted.
Format
Use the following format with the DFLT command:
F XCOM,DFLT,{operand},new_value
304 User Guide
Using the MODIFY Commands
Operands
The following operands are used with the DFLT command:
AGE
Identifies the length in days of the queue-purging interval applied to locally
initiated transfer requests.
CATALOG
Indicates whether new data sets created by CA XCOM Data Transport should
be cataloged.
CLASS
Specifies the default SYSOUT class assigned to an incoming report when the
remote system does not provide one.
DIR
Specifies the number of PDS directory blocks to be allocated for file transfers
to new data sets.
DUMPCL
Specifies the SYSOUT class CA XCOM Data Transport uses when creating
diagnostic dumps.
EDESC
Specifies the sixteen bits (coded in hexadecimal) of an MVS message
descriptor code.
EROUT
Specifies the sixteen bits (coded in hexadecimal) of MVS console routing
codes for error messages ending with E.
ERRINTV
The interval in minutes at which CA XCOM Data Transport is to reset error
flags on the pending request queue and retry session establishment.
IDESC
Specifies the sixteen bits (coded in hexadecimal) of an MVS message
descriptor code.
IROUT
Specifies the sixteen bits (coded in hexadecimal) of an MVS console routing
code.
JESINTV
Sets the interval in seconds at which the CA XCOM Data Transport server is
to scan the JES spool for output directed to destinations and/or writers
specified in CAI.CIN31CTL destination members.
Chapter 5: Operation and Control 305
Using the MODIFY Commands
LOG
Specifies whether the transfer log should be written.
LOGCL
Indicates the JES SYSOUT class for the CA XCOM Data Transport transfer
log.
LOGDEST
Specifies the JES destination for the CA XCOM Data Transport transfer log.
MAXLOC
Indicates the maximum number of locally initiated transfers.
MAXREM
Indicates the maximum number of remotely initiated transfers.
MAXTASK
Indicates the maximum number of transfers.
PRI
Specifies the primary space allocation.
PSOUNIT
Specifies the generic unit name used by the PSO interface when allocating
temporary data sets.
PSOVOL
Specifies the DASD volume used by the PSO interface when allocating
temporary data sets.
REMAGE
Specifies the queue purging interval in days for remotely initiated transfer
requests.
RELEASE
Specifies whether the remote partner is to release unused DASD space when
creating a new file.
REPCR
Specifies whether CA XCOM Data Transport is to attempt to do a CREATE
when receiving a transfer with FILEOPT=ADD|REPLACE and the data set
does not exist.
SEC
Specifies the default amount of secondary space allocated to new data sets
in the units specified by the ALLOC parameter.
SMF
Specifies whether an SMF record is created at the completion of a transfer.
306 User Guide
Using the MODIFY Commands
SMFNUM
Designates the ID number for SMF records created by CA XCOM Data
Transport.
SUPPLIST
Specifies whether CA XCOM Data Transport is to suppress XCOMM0397I and
XCOMM0398I messages when processing transfers of PDS or PDSE (source)
members.
TCPSESS
Indicates the maximum number of locally initiated TCP/IP transfers to any
one partner.
UNIT
Specifies the default unit name when allocating new data sets.
USERD
Specifies system-wide user data to be included in the logging information for
file transfers initiated by the system.
VOL
Specifies the default volume serial number to be used when allocating new
data sets.
new_value
Specifies the new value of the CA XCOM Data Transport parameter identified
with the operand option of the DFLT command. For valid values of those
default options table parameters that can be modified with the DFLT
command, see the CA XCOM Data Transport for z/OS Administration Guide.
Notes
The values of these parameters are defined in the Default Options Table. Use the
INQ command to display the current values.
Chapter 5: Operation and Control 307
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access
Level
Resource Name
UPDATE
XCOM.applsec.DFLT.parmname
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the Default
Options Table
■
parmname—the name of the parameter to which the DFLT is
applied, that is, any or all of the operands listed above.
DISABLE Command
Disables a CA XCOM Data Transport control library member.
Format
F XCOM,DISAble,membername{,ALL|FORCE|FORCEALL}
308 User Guide
Using the MODIFY Commands
Operands
The following operand is used with the DISABLE command:
membername
Specifies the name of the control library member containing the definition of
the LU or a group of LUs to be disabled.
The member name can contain up to eight alphanumeric characters
ALL
Indicates that all lists in the specified superlist are to be disabled.
Note: This operand is valid only with a superlist.
FORCE
Indicates that the specified superlist is to be disabled, but that the individual
lists in the superlist are not to be disabled.
Note: This operand is valid only with a superlist.
FORCEALL
Indicates that a superlist named in another superlist is to be disabled, as well
as all individual lists named in the superlist.
Note: This operand is valid only with a superlist.
Examples
Suppose you have defined the following superlists:
Member NJTRI:
TYPE=SUPERLIST
LIST=NJ,PA
LIST=NY
Member EAST:
TYPE=SUPERLIST
LIST=DE
LIST=NJTRI,MA
The following examples show how you can use the DISABLE command with these
superlists.
Example 1
f xcom,DISABLE EAST{,ALL/FORCE/FORCEALL}
f xcom,DISABLE EAST
All LIST members that were automatically enabled when ENABLE EAST was
issued are to be disabled as well as EAST.
Chapter 5: Operation and Control 309
Using the MODIFY Commands
Example 2
f xcom,DISABLE EAST,ALL
All LIST members named in EAST are to be disabled. Because EAST specifies
NJTRI, all members named in NJTRI are to be disabled as will NJTRI.
Example 3
F xcom,DISABLE NJTRI,FORCE
Because NJTRI is named in member EAST, you cannot disable it without also
specifying the FORCE parameter.
Example 4
F xcom,DISABLE NJTRI,FORCEALL
Because NJ, PA, and NY are named named in member NJTRI, you cannot disable
them without also specifying the FORCEALL parameter.
Notes
This command disables a group's control library member, allowing you to change
parameters in CA XCOM Data Transport's control library and then enable the
member again.
DISABLE can optionally be used by the XCOMPLEX Admin Server. For more
information, see ENABLE and DISABLE Commands in the chapter ―Configuring
and Customizing CA XCOM Data Transport‖ in the CA XCOM Data Transport for
z/OS Administration Guide.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access
Level
Resource Name
UPDATE
XCOM.applsec.DISABLE.membername
The variables represent the following values:
310 User Guide
■
applsec—the value of the APPLSEC parameter in the Default
Options Table
■
membername—the name of the CONTROL LIBRARY member
to be disabled
Using the MODIFY Commands
DISPLAY Command
Displays information about active sessions.
Format
F XCOM,DISplay,[destname]
Operand
The following operand is used with the DISPLAY command:
destname
The name of the destination about which session information is to be
displayed.
The destination can be identified with (1) a valid SNA LU name, (2) TCP/IP
name, or (3) TCP/IP address.
For information about all active sessions running under this started task,
omit this operand.
Notes
The DISPLAY command lists established sessions involving the local system,
even if currently idle. It also displays the name of the associated partner logical
unit, whether it is currently sending or receiving, and the number of records
transferred so far. If this system is serving as the intermediary system in an
active indirect file transfer, this session is also displayed. Repeating the DISPLAY
command several times and tracking the record count allows you to check
whether a transfer is proceeding normally.
Chapter 5: Operation and Control 311
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
READ
XCOM.applsec.DISPLAY.destname
XCOM.applsec.DISPLAY.*
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination about which
session information is to be displayed
* (asterisk)—any or all sessions
DUMP Command
Dumps control blocks for a CA XCOM Data Transport partner.
Format
F XCOM,DUMP,destname
Operand
The following operand is used for the DUMP command:
destname
Specifies the destination in which you are interested.
The destination can be identified with any one of the following:
■
An SNA LU name
■
A TCP/IP name
■
A TCP/IP address.
The CA XCOM Data Transport partner destination name must match the one
shown by the DISPLAY command.
312 User Guide
Using the MODIFY Commands
Notes
The dump output is sent to one of two places:
The DUMPCL SYSOUT class defined in the CA XCOM Data Transport Default
Options Table
An override value indicated in the EXEC PARM parameter of the CA XCOM Data
Transport started task.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.DUMP.destname
The variables represent the following values:
■
applsec-the value of the APPLSEC parameter in the
Default Options Table
■
destname-the name of the destination about which the
dump data is requested
DUMPXCF Command
(For XCOMPLEX Worker Server and XCOMPLEX Admin Server only)
Takes an SVC dump of the CA XCOM Data Transport coupling facility area and
dumps the entire XCOMPLEX structure.
Format
F XCOM,DUMPXCF
Operands
None
Chapter 5: Operation and Control 313
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command's issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.DUMPXCF
The applsec variable represents the value of the APPLSEC
parameter in the Default Options Table.
Note: The DUMPXCF command should be used only when requested by CA
XCOM Technical Support.
ENABLE Command
Enables a CA XCOM Data Transport control library member.
Format
F XCOM,ENAble,membername
Operand
The following operand is used with the ENABLE command:
membername
Specifies the name of the control library member to be enabled. The member
name can be up to eight characters long.
314 User Guide
Using the MODIFY Commands
Notes
This command enables a control library member in the control library. The
control library contains configuration definitions for CA XCOM Data Transport
partner destinations, distribution lists, and customized code page conversion
tables. To alter an existing definition, you must edit the control library PDS
member, issue a DISABLE command for that member and then issue the ENABLE
command.
The LIST command is used to display an enabled control library member. If you
want the member to be enabled when CA XCOM Data Transport is started, you
must add the member name to the CA XCOM Data Transport start-up list
member. The default name of the start-up list member is XCOMSTRT, but
another name can be specified on the START parameter in the CA XCOM Data
Transport Default Options Table or in the EXEC statement of the CA XCOM Data
Transport start-up JCL.
The ENABLE command can optionally be used by the XCOMPLEX Admin Server.
For more information, see Enable and Disable Commands in the CA XCOM Data
Transport for z/OS Administration Guide.
Command Security Requirements
The use of the command requires that the security authorization for the
command issuer contain the following access level and resource specifications
for CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.ENABLE.membername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
membername—the name of the control library
member to be enabled
EXIT Command
Executes a user-written CA XCOM Data Transport exit routine.
Format
F XCOM,EXIT,userdata
Chapter 5: Operation and Control 315
Using the MODIFY Commands
Operand
The following operand is used with the EXIT command:
userdata
Specifies up to eight bytes of data to be passed to the XCOMEX09 routine.
Notes
The use of the command requires that the security authorization for the
command issuer contain the following access level and resource specifications
for CLASS(OPERCMDS):
Access Level
Resource Name
READ
XCOM.applsec.EXIT.data
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
data—the data to be passed to the exit routine
HOLD Command
Holds a pending file transfer.
Format
F XCOM,HOLD,nnnnnn
Operand
The following operand is used for the HOLD command:
nnnnnn
Specifies the number (0 to 999999) of the transfer request that is to be held.
Notes
This command holds the pending file transfer request whose request number is
nnnnnn, provided it has not yet commenced executing. Otherwise, it is ignored.
To release a previously held request, use the RELEASE command.
316 User Guide
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the security authorization for the
command issuer contain the following access level and resource specifications
for CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.HOLD.destname.ownername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
INQ Command
Displays the current parameter definitions for MAXTASK, MAXLOC, MAXREM,
and TCPSESS, or all parameter definitions.
Format
F XCOM,INQ,{MAX|DFLT}
Operands
The following operands are used with the INQ command:
MAX
Displays the current values for MAXTASK, MAXLOC, MAXREM, and TCPSESS.
DFLT
Displays the current values for all XCOMDFLT parameters that are currently
in use by the CA XCOM Data Transport server.
Notes
The initial values of the MAXTASK, MAXLOC, MAXREM, and TCPSESS parameters
are defined in the CA XCOM Data Transport Default Options Table. These values
can be altered by using the DFLT command.
Chapter 5: Operation and Control 317
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
READ
XCOM.applsec.INQ
The applsec variable represents the value of the APPLSEC
parameter in the Default Options Table.
LIST Command
Displays all of the information pertaining to a CA XCOM Data Transport control
library member.
Format
F XCOM,LIST,membername{,ALL}
Operands
The following operands are used with the LIST command:
membername
Specifies the name of the CA XCOM Data Transport control library member
the contents of which are to be displayed. The member name can contain up
to eight alphanumeric characters. You can use a wildcard character (*) to
generically display control library member information. If present, the
wildcard character (*) must be the last character in the member parameter
field.
ALL
Indicates that each list in the specified superlist is to be listed, in the same
way as if you issued a LIST command for each individual list.
Notes:
318 User Guide
■
The membername operand can identify a predefined distribution superlist,
or list of lists.
■
The ALL operand is valid only with a superlist.
Using the MODIFY Commands
Notes
An asterisk (*) next to any displayed value indicates that the value is taken from
the Default Options Table.
Important! Caution should be used when generically displaying control library
members, because displays can become quite large if there are many members
that match the selection criteria.
The LIST command cannot be used for Custom Code Page Conversion Tables
(TYPE=CONVERT).
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
READ
XCOM.applsec.LIST.membername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
membername—the name of the control library member
LOGFREE Command
Frees the CA XCOM Data Transport log for printing.
Format
F XCOM,LOGFREE
Notes
This commands closes and de-allocates the current logging data set, then
dynamically allocates and opens the new logging data set. It allows you to review
the contents of the CA XCOM Data Transport log while CA XCOM Data Transport
is active.
Chapter 5: Operation and Control 319
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
UPDATE
XCOM.applsec.LOGFREE
The applsec variable represents the value of the APPLSEC
parameter in the Default Options Table.
NOTRACE Command
Deactivates the trace function.
Format
F XCOM,NOTRACE[,{*|luname|ipname}]
Operands
The following operands are used with the NOTRACE command:
* (asterisk)
Specifies that all active traces are to be turned off.
F XCOM,NOTRACE,* and F XCOM,NOTRACE have the same result.
luname
Specifies the name of the LU for which the trace is to be turned off. The LU
name can contain up to eight alphanumeric characters.
Note: This operand is invalid in the TCP/IP protocol environment.
When a trace is closed, z/OS create a spin-off data set that is printed as soon
as the SYSOUT file is closed. The file is closed and dynamically deallocated
when NOTRACE, * is specified or when there are no longer any active traces.
(Use the TRACE command to activate traces.)
ipname
Specifies the name or address of the IP destination for which the trace is to
be turned off.
320 User Guide
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
UPDATE
XCOM.applsec.NOTRACE.destname
The variable represents the following value:
■
applsec—the APPLSEC parameter in the Default Options
Table
■
destname—the ipname or luname for which the trace is to
be turned off
NOXTRACE Command
(For XCOMPLEX Worker Server or XCOMPLEX Admin Server only) Deactivates
the trace function.
Format
F XCOM,NOXTRACE
Operands
None
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
UPDATE
XCOM.applsec.NOXTRACE
The applsec variable represents the APPLSEC parameter in the
Default Options Table.
NSASTAT Command
Provides usage statistics that may be requested by CA XCOM Data Transport
Technical Support.
Chapter 5: Operation and Control 321
Using the MODIFY Commands
Format
F XCOM,NSASTAT
Notes
The following statistics are displayed:
#NSA
Number of elements in the Network Session Anchor (NSA) Block chain
#NSAX
Number of free elements in the NSA chain
#NSAI
Number of inactive elements in the NSA chain
#NSAA
Number of active elements in the NSA chain
#NSAR
Number of elements in the dispatch chain
#LCUR
Number of locally initiated elements that are currently active
#LMAX
Peak number of locally initiated elements
#RCUR
Number of remotely initiated elements that are currently active
#RMAX
Peak number of remotely initiated elements
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
READ
XCOM.applsec.NSASTAT
The applsec variable represents the value of the APPLSEC
parameter in the Default Options Table.
322 User Guide
Using the MODIFY Commands
RELEASE Command
Releases a held file transfer.
Format
F XCOM,RELEASE,nnnnnn
Operand
The following operand is used with the RELEASE command:
nnnnnn
Specifies the request number (0 to 999999) of the transfer to be released.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.RELEASE.destname.ownername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
RESET Command
Immediately resets any error flags.
Format
F XCOM,RESet,{*|destname}
Chapter 5: Operation and Control 323
Using the MODIFY Commands
Operands
The following operands are used with the RESET command:
* (asterisk)
Resets all error flags for all transfer requests.
destname
Specifies the name of the CA XCOM Data Transport destination for which the
error flag is to be reset. The destination name can contain up to eight
alphanumeric characters. Any of the following items can be used as a
destination name:
■
SNA LU name
■
TCP/IP name
■
TCP/IP address
■
CA XCOM Data Transport control library member name
Notes
All error flags are automatically reset by CA XCOM Data Transport at an interval
set by the ERRINTV parameter in CA XCOM Data Transport's Default Options
Table. The default error reset interval is seven minutes. If a transfer fails with a
retry-able error and the conditions leading to the failure have been corrected,
you can have the transfer retried before the error reset interval expires by using
the RESET command. Prior to issuing the RESET command, use the SHOW
command to verify that the status is NET-ERR or REM SUSP and to determine the
correct value to use for the destination name.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.RESET.{*|destname}
The variables represent the following values:
324 User Guide
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination for which the
error flag is to be set
■
* (asterisk)—all destinations
Using the MODIFY Commands
RESUME Command
Resumes a suspended file transfer.
Format
F XCOM,RESUMe,nnnnnn
Operand
The following operand is used with the RESUME command:
nnnnnn
Specifies the partner system's transfer request number (0 to 999999) of the
suspended transfer that is to be resumed.
Notes
If the transfer is a Version 2 transfer, it is resumed from the last checkpoint
taken when it was suspended.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.RESUME.destname.ownername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
RSHOW Command
Displays remotely initiated transfers.
Format
F XCOM,RSHOW[,nnnnnn|destname]
Chapter 5: Operation and Control 325
Using the MODIFY Commands
Operands
The following operands are used with the RSHOW command:
nnnnnn
Specifies the request number (nnnnnn) of the remotely initiated transfer
about which detailed information is to be displayed.
destname
Specifies the name of the destination whose remotely initiated transfers are
to be displayed. Any of the following items can be used as a destination
name:
■
SNA LU name
■
TCP/IP name
■
TCP/IP address
Note: Entered without an operand, RSHOW displays all remotely-initiated
transfer requests.
Notes
The display provides information about:
■
Requests that are active
■
Requests that were interrupted but are still eligible to be restarted (for
example, requests that have not yet been completed, purged, or aged off the
queue)
Important! In large networks with a large number of queued transfers, the
output of this command can exhaust your WTO buffers.
326 User Guide
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
READ
XCOM.applsec.RSHOW.destname.ownername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
Note: ISPF and CICS display requests may cause resource
checking for both SHOW and RSHOW commands.
SHOW Command
Displays information about locally initiated file transfer requests.
Format
F XCOM,SHOW[,nnnnnn|destname]
Chapter 5: Operation and Control 327
Using the MODIFY Commands
Operands
The following operands are used with the SHOW command:
nnnnnn
Specifies the number (0 to 999999) of the transfer request about which
information is to be displayed.
destname
Specifies the name of the destination whose locally initiated transfers are to
be displayed.
Any of the following items can be used as a destination name:
■
SNA LU name
■
TCP/IP name
■
TCP/IP address
Note: Entered without an operand, the SHOW command displays all locally
initiated file transfer requests. However, more information is displayed for a
transfer that is selected individually than when showing all transfers.
Notes
The display provides information about:
■
Requests that are scheduled but not yet started
■
Active requests
■
Requests that were interrupted but are still eligible to be restarted (for
example, requests that have not yet been completed, purged, or aged off the
queue)
Important! In large networks with a large number of queued transfers, the
output of this command can exhaust your WTO buffers.
328 User Guide
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
READ
XCOM.applsec.SHOW.destname.ownername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
Note: ISPF and CICS display requests may cause resource
access checking for both SHOW and RSHOW commands.
SNAP Command
Produces a snap dump of the CA XCOM Data Transport region.
Format
F XCOM,SNAP
Important! It is best not to use the SNAP command unless instructed by the CA
XCOM Data Transport technical support staff.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
UPDATE
XCOM.applsec.SNAP
The applsec variable represents the value of the APPLSEC
parameter in the Default Options Table.
Chapter 5: Operation and Control 329
Using the MODIFY Commands
STAT Command
(For the XCOMPLEX Admin Server only) The STAT command displays
statistics for each XCOMPLEX Worker server connected to an XCOMPLEX Admin
Server. The statistics displays information such as the number of remotely
initiated transfers, locally initiated transfers, and how many are TCP/IP
transfers. It also displays activity like how many transfers are held, suspended,
remotely suspended, retry pending and/or inactive. The display also shows
XCOMPLEX Worker Servers who are not currently connected to the XCOMPLEX
Admin Server.
This data from the STAT command is refreshed on the XCOMPLEX Worker Server
side every 30 seconds, so this display should only be used for general monitoring
of the XCOMPLEX Worker Servers and their workload distribution.
Format
F XCOM,STAT
Operands
None
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
READ
XCOM.applsec.STAT
The applsec variable represents the APPLSEC parameter in the
Default Options Table.
330 User Guide
Using the MODIFY Commands
Example
The following is an example of the STAT command output for three XCOMPLEX
Worker Servers connected to an XCOMPLEX Admin Server and an XCOMPLEX
Worker Server that is not currently connected:
A26IXCOM HAS RECEIVED STAT COMMAND
A26RXCOM HAS RECEIVED STAT COMMAND
A26UXCOM HAS RECEIVED STAT COMMAND
A26LXCOM IS NOT CONNECTED TO THE XCOMPLEX
STAT
COMMAND PROCESSING SUCCESSFUL
-------------------------------------------------A26IXCOM - TASK
CURRENT
LIMIT
PERCENT
TYPE
COUNT
(MAX)
UTILIZED
--------------------------------------LOCAL
8
75
10 %
REMOTE
0
75
0 %
--------------------------------------TASKS
8
150
5 %
--------------------------------------TCP/IP
2
--HELD
0
--SUSPENDED
0
--REM/SUSPND
2
--RETRY PEND
0
--INACTIVE
0
----------------------------------------------------------------------------------------------------A26RXCOM - TASK
CURRENT
LIMIT
PERCENT
TYPE
COUNT
(MAX)
UTILIZED
--------------------------------------LOCAL
2
25
8 %
REMOTE
0
25
0 %
--------------------------------------TASKS
2
50
4 %
--------------------------------------TCP/IP
1
--HELD
0
--SUSPENDED
0
--REM/SUSPND
0
--RETRY PEND
0
--INACTIVE
0
----------------------------------------------------------------------------------------------------A26UXCOM - TASK
CURRENT
LIMIT
PERCENT
TYPE
COUNT
(MAX)
UTILIZED
--------------------------------------LOCAL
7
50
14 %
REMOTE
0
50
0 %
Chapter 5: Operation and Control 331
Using the MODIFY Commands
--------------------------------------TASKS
7
100
7 %
--------------------------------------TCP/IP
1
--HELD
0
--SUSPENDED
0
--REM/SUSPND
1
--RETRY PEND
0
--INACTIVE
1
---
STOP Command
Stops CA XCOM Data Transport.
Format
F XCOM,STOP[,IMMED]
The following list shows the various commands by which the CA XCOM Data
Transport server can be stopped and describes the circumstances under which
each command is used.
no operand
When the STOP command is issued without an operand, that is, F
XCOM,STOP, it causes CA XCOM Data Transport to stop as soon as all active
transfers are completed.
IMMED
F XCOM,STOP,IMMED causes CA XCOM Data Transport to stop
immediately and unconditionally, that is, even if transfers are in progress.
When CA XCOM Data Transport is stopped in this way, normal cleanup of
transfer requests does not occur.
332 User Guide
Using the MODIFY Commands
Notes
When stopping, CA XCOM Data Transport does not allow new locally initiated and
remotely allocated transmissions to commence.
Other ways to stop CA XCOM Data Transport include the following non-MODIFY
commands:
C XCOM[,DUMP]
Whether issued in the form C XCOM or C XCOM,DUMP, this command
causes CA XCOM Data Transport to stop immediately and unconditionally,
without any cleanup of transfer requests, that is, it has the same effect as
the MODIFY command F XCOM,STOP,IMMED.
P XCOM
When this command is issued once, it has the same effect as the MODIFY
command F XCOM STOP, that is, CA XCOM Data Transport does not stop
until all transfers in progress at the time of issuing the command have
completed. When the command is issued a second time for a job, it has the
same effect as the MODIFY command F XCOM,STOP,IMMED or the
non-MODIFY command C XCOM[,DUMP].
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
CONTROL
XCOM.applsec.STOP.type
The variable represents the following value:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
type—the STOP command operand IMMED
SUSPEND Command
Immediately suspends an active transfer.
Format
F XCOM,SUSPEND,{luname|nnnnnn}
Chapter 5: Operation and Control 333
Using the MODIFY Commands
Operands
The following operands are used with the SUSPEND command:
luname
Specifies the name (one to eight characters) of the single-session SNA LU
that you want to suspend.
nnnnnn
Specifies the request number (0 to 999999) of the transfer to be suspended.
This operand must be used for transfers with a TCP/IP partner or with a
parallel sessions SNA LU partner.
Notes
A Version 2 transfer can be resumed from the last checkpoint taken. If it does
not, the transfer is resumed from the beginning of the file. If the transfer was
initiated and suspended by a remote system, the operation resumes in the next
retry interval. If the transfer was initiated and suspended by the local system,
the RESUME command must be used for the transfer to continue.
If multiple transfers are running with the same request number, the first one
shown with the DISPLAY command is the one affected by the SUSPEND
command. For greater control, we recommend using the ISPF or CICS menu
interface.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.SUSPEND.destname.ownername
The variables represent the following values:
334 User Guide
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
Using the MODIFY Commands
TERM Command
Immediately halts and purges an active transfer.
Format
F XCOM,TERM,{luname|nnnnnn}
Operands
The following operands are used with the TERM command:
luname
Specifies the name (one to eight characters) of the single-session SNA LU
that you want to terminate.
nnnnnn
Specifies the request number (0 to 999999) of the active file transfer that
you want to terminate.
This operand is required for transfers with a TCP/IP partner or with a parallel
sessions SNA LU partner.
Notes
For SNA transfers, TERM stops the LU 6.2 conversation, but it does not terminate
the session. Use the CANCEL command to terminate the session.
If multiple transfers are running with the same request number, the first one
shown with the DISPLAY command is the one affected by the TERM command.
For greater control, we recommend using the ISPF or CICS menu interface.
Chapter 5: Operation and Control 335
Using the MODIFY Commands
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.TERM.destname.ownername
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
TRACE Command
Activates a CA XCOM Data Transport internal trace.
Format
F XCOM,TRACE[,{*|luname,[SNA]|ipname}]
Operands
The following operands are used with the TRACE command:
* (asterisk)
Indicates that all active sessions involving this system are to be traced.
F XCOM,TRACE,* (with the asterisk operand) and
F XCOM,TRACE (without an operand) are equivalent.
luname,[SNA]
Specifies the name (one to eight characters) of the LU to be traced. An LU
name can be traced before a session exists. There is no requirement that the
LU be defined to allow CA XCOM Data Transport to initiate a trace.
The optional keyword SNA should be used in cases where the LUNAME and
IPNAME are the same at a site. This forces the LUNAME to be treated
exclusively as SNA when creating the trace file.
ipname
Specifies the name or address of the IP destination to be traced.
336 User Guide
Using the MODIFY Commands
Notes
The trace function dynamically allocates a SYSOUT file to receive the trace data.
This SYSOUT file's class is defined through the DUMPCL parameter of CA XCOM
Data Transport's Default Options Table (see the CA XCOM Data Transport for
z/OS Administration Guide). It can be overridden in the EXEC PARM of the CA
XCOM Data Transport started task.
In most cases, the CA XCOM Data Transport trace is more desirable than a VTAM
buffer trace because it does not require GTF and is simpler to turn on and off.
To turn off the trace, use the NOTRACE command.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.TRACE.destname
The variables represent the following values:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the luname or ipname for which the
trace is activated
VERSION Command
Displays CA XCOM Data Transport version information.
Format
F XCOM,VERsion
Chapter 5: Operation and Control 337
Using the MODIFY Commands
Notes
When the VERSION command is issued, CA XCOM Data Transport responds with
the following data:
XCOMM0060I CURRENT RELEASE IS r.m - GENERATION LEVEL yymm
r.m
Indicates the release and modification level.
yymm
Indicates the maintenance generation level (year, month).
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
READ
XCOM.applsec.VERSION.destname.ownername
The variable represents the following value:
■
applsec—the value of the APPLSEC parameter in the
Default Options Table
■
destname—the name of the destination involved in the
transfer
■
ownername—the user ID under whose security
authorization the transfer is performed
XRSHOW Command
(For XCOMPLEX Admin Server only) Displays remotely initiated transfers for
all XCOMPLEX Worker Servers connected to the XCOMPLEX Admin Server.
Format
F XCOM,XRSHOW,nnnnnn
Operand
The following is the operand for the XRSHOW command:
nnnnnn
Specifies the number (0 to 999999) of the transfer request about which
information is to be displayed.
338 User Guide
Using the MODIFY Commands
Notes
If you enter XRSHOW without an operand, the resulting display lists
remotely-initiated file transfer requests. If you select an individual request
number, XRSHOW limits the display to only the XCOMPLEX Worker Servers that
have the specified request number. Additional details are NOT displayed. For
additional details, enter the RSHOW command from the XCOMPLEX Worker
Server.
The display provides information about:
■
Requests that are active
■
Requests that were interrupted but are still eligible to be restarted (for
example, requests that have not yet been completed, purged, or aged off the
queue)
Important! In large networks with a large number of queued transfers, the
output of this command can exhaust your WTO buffers.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level Resource Name
READ
XCOM.applsec.XRSHOW
The applsec variable represents the value of the APPLSEC
parameter in the Default Options Table.
XSHOW Command
(For XCOMPLEX Admin Server only) Displays information about locally
initiated file transfer requests for all XCOMPLEX Worker Servers connected to the
XCOMPLEX Admin Server.
Format
F XCOM,XSHOW,nnnnnn
Chapter 5: Operation and Control 339
Using the MODIFY Commands
Operand
The following is the operand for the XSHOW command:
nnnnnn
Specifies the number (0 to 999999) of the transfer request about which
information is to be displayed.
Notes
If you enter XSHOW without an operand, the resulting display lists
remotely-initiated file transfer requests. If you select an individual request
number, XSHOW limits the display to only the XCOMPLEX Worker Servers that
have the specified request number. Additional details are NOT displayed. For
additional details, enter the SHOW command from the XCOMPLEX Worker
Server.
The display provides information about:
■
Requests that are scheduled but not yet started
■
Active requests
■
Requests that were interrupted but are still eligible to be restarted (for
example, requests that have not yet been completed, purged, or aged off the
queue)
Important! In large networks with a large number of queued transfers, the
output of this command can exhaust your WTO buffers.
Command Security Requirements
The use of the command requires that the command issuer's security
authorization contain the following access level and resource specifications for
CLASS(OPERCMDS):
Access Level
Resource Name
READ
XCOM.applsec.XSHOW
The applsec variable represents the value of the APPLSEC
parameter in the Default Options Table.
XTRACE Command
(For XCOMPLEX Worker Server and XCOMPLEX Admin Server only)
Activates a CA XCOM Data Transport internal trace. This trace must be activated
individually on each server.
340 User Guide
Using the MODIFY Commands
Format
F XCOM,XTRACE
Operands
None
Notes
The trace function dynamically allocates a SYSOUT file to receive the trace data.
This SYSOUT file's class is defined through the DUMPCL parameter of CA XCOM
Data Transport's Default Options Table (see the CA XCOM Data Transport for
z/OS Administration Guide). It can be overridden in the EXEC PARM of the CA
XCOM Data Transport started task.
Turning on the XTRACE seriously degrades performance.
To turn off the trace, use the NOXTRACE command.
Command Security Requirements
The use of the command requires that the security authorization for the
command issuer contain the following access level and resource specifications
for CLASS(OPERCMDS):
Access Level
Resource Name
UPDATE
XCOM.applsec.XTRACE
The applsec variable represents the value of the
APPLSEC parameter in the Default Options Table.
Chapter 5: Operation and Control 341
Chapter 6: Processing Different File
Types
This chapter covers CA XCOM Data Transport support for various file types
including partitioned data sets (PDS), partitioned data set extended (PDSE), and
PDSE program libraries, generation data groups (GDG), VSAM files, and USS
files. Processing requirements, limitations, and special features for different file
types are described in detail. Unless explicitly stated otherwise, these
considerations apply uniformly across all the CA XCOM Data Transport
interfaces.
This section contains the following topics:
Partitioned Data Sets (see page 343)
Generic File Specifications (Using Wildcards) (see page 345)
Generation Data Groups (see page 347)
USS Files (see page 349)
VSAM Files (see page 350)
Miscellaneous File Considerations (see page 351)
Partitioned Data Sets
This section describes the level of support for partitioned data sets (PDS),
partitioned data set extended (PDSE), and PDSE load libraries in CA XCOM Data
Transport.
Chapter 6: Processing Different File Types 343
Partitioned Data Sets
PDS and PDSE Support
Support for partitioned data sets, including PDSE and program libraries, is
provided in CA XCOM Data Transport. CA XCOM Data Transport reads the VTOC
and the directory blocks to determine whether the file is a PDS and passes this
information on to the remote system. When a new file is created on the target
system (using the Create File option), CA XCOM Data Transport allocates the
same amount of space for directory blocks there as it has on the source system.
You can override this allocation by changing the number of directory blocks or
reblocking the file through the appropriate SYSIN01 (Batch Interface) or File
Allocation Information screen (Menu Interface) parameters.
CA XCOM Data Transport transmits aliases if the member to which it is pointed is
already on the target PDS.
Checkpointing should not be specified for transfer of PDSs.
Note: CA XCOM Data Transport reads the directory blocks for information such
as alias relationships and pointers to preserve the integrity of the data;
therefore, PDS files take longer to process than sequential or VSAM files of the
same size.
PDSE Program Library Support
Support for PDSE program library transfers requires PROGLIB=YES in SYSIN01
and the use of an XCOMPRNT DD statement. Any CA XCOM Data Transport for
z/OS servers used to send or receive PDSE program library transfers must be
modified to include the XCOMPRNT DD. See sample member XCOM in the
appendix ―Sample Files.‖ If PROGLIB=YES is used in TYPE=EXECUTE transfers,
then XCOMPRNT DD must be included in the batch XCOMJOB JCL.
Only whole PDSE program libraries can be transferred. The transferring of an
individual member or the use of wild cards (for example, ABC*) to transfer
multiple members is not supported.
CA XCOM Data Transport uses the values from PSOPREF and PSOVOL to create
the temporary data sets used in transferring PDSE program libraries.
344 User Guide
Generic File Specifications (Using Wildcards)
Generic File Specifications (Using Wildcards)
PDS member names can be specified generically for Send File and Receive File
procedures by using wildcards. To send or receive all members beginning with a
particular prefix, designate the Local File Name with that prefix followed by an
asterisk. For example, PRIVATE.LIB4(TRAN*) requests that members
TRANUPDT, TRANBKUP, and TRANINQ be transferred.
To request that CA XCOM Data Transport send all members of this PDS, use
PRIVATE.LIB4(*). In generic specifications, the asterisk must be the last
character before the right parenthesis. In batch mode, all members are
transmitted if no member name is specified.
When transferring to another z/OS system, use generic specifications for the
source file only, not the destination file. For example, with a Receive File transfer
on z/OS, you could use a generic specification for the Remote File Name, but not
for the Local File Name. Wildcards in the z/OS destination data sets are ignored.
If the destination is another CA XCOM Data Transport r11 or r11.5 partner,
wildcard characters are allowed in the destination file name, depending on the
system to which the transfer is being sent. For more information, see the
appropriate documentation for specific CA XCOM Data Transport r11 or r11.5
platforms.
Note: CA XCOM Data Transport does not support the use of wildcards with PDSE
program libraries. For more information, see PDSE Program Library Support in
this chapter.
USS Files
USS files can be specified generically for Send File and Receive File transfers by
using wildcards. For example:
LFILE=/u/users/xcom/*
Transfer ALL files.
LFILE=/u/users/xcom/m*
Transfer ALL files starting with an m.
LFILE=/u/users/xcom/*m
Transfer ALL files ending with an m.
LFILE=/u/users/xcom/m*m
Transfer ALL files starting with an m and ending with an m.
LFILE=/u/users/xcom/m*y*m
Transfer ALL files starting with an m, ending with an m and containing a y.
Chapter 6: Processing Different File Types 345
Generic File Specifications (Using Wildcards)
LFILE=/u/users/xcom/m*you*
Transfer ALL files starting with an m and containing the characters you in
succession.
LFILE=/u/users/xcom/m*y*o*u*
Transfer ALL files starting with an m and containing the characters y and o
and u (in order, but not in succession).
Notes:
■ One or more wildcard characters (*) can be used if transferring to IBM
mainframe systems, to Windows systems, or to UNIX systems.
■ The transfer of USS files is supported only between systems running CA XCOM
Data Transport r11.5.
Library Transfers
When multiple members of a PDS are transferred and the target data set is
sequential or a single member of a PDS, the completion of the transfer depends
on the value of the LIBNEG parameter. If LIBNEG=YES, all selected members of
the PDS are written to the larger data set. If LIBNEG=NO, the transfer is
terminated.
346 User Guide
Generation Data Groups
Generation Data Groups
Generation Data Groups present a special problem to most file transfer systems.
Generally, when a generation data set is uploaded into a GDG, a relative
generation number of (+1) is given as part of the file name. However, relative
generation numbers are normally not updated by z/OS until the end of the
associated job. Therefore, if (as in CICS) the CA XCOM Data Transport started
task is being used to update the generation data set, its relative generation
number would not be updated until the started task is brought down.
This generation data set could be updated multiple times before the CA XCOM
Data Transport started task is stopped, the second update being, as far as z/OS
is concerned, to the (+2) generation, the third to the (+3) generation, and so on.
The situation described above is generally undesirable. CA XCOM Data Transport
avoids this by treating each Generation Data Group file transfer request as if it
were an autonomous job. This allows for the relative generation of number
references in the conventional manner, no matter when the CA XCOM Data
Transport started task is brought down. The complete data set name of a
generation data set, including the GxxxxV00 suffix, is sent in CA XCOM Data
Transport messages to partner systems (Version=2 transfers only).
For example, error and log messages concerning a generation data set sent to a
PC or workstation display the actual z/OS data set name (provided the transfer is
a Version=2 transfer).
Scheduled Versus Immediate Transfer Considerations
Generation data sets introduce a complicating factor into any non-immediate,
queued procedure. There may be a significant time lag between the request and
its implementation. For example, the partner system may not sign on for an
indeterminate period of time. If a relative generation number is specified for a
queued CA XCOM Data Transport transfer, and the GDG is updated before the
transfer executes, the wrong file may be transferred. This would depend on
whether the user wanted the file designated by the relative generation number
at the time of the request, or the most current generation of the file. CA XCOM
Data Transport can accommodate either, handling the transfer differently
depending on whether the Batch or the Menu Interface is being used.
Scheduling a Transfer with GDG(0)
If you schedule a transfer with GDG(0) or GDG(+0) specified, the XCOM server
resolves the file name to be the current GxxxxV00 number at the time the
transfer is scheduled. If you specify HOLD=YES, such as in an XTC scenario, a
relative generation number is used until the specific version is resolved. This
occurs just before the data set is opened.
Chapter 6: Processing Different File Types 347
Generation Data Groups
Batch Interface
The local file in a file transfer can be specified with the SYSIN01 LFILE parameter
or the LCLDS01 DD statement (see the chapter ―The Batch Interface‖). For
TYPE=SCHEDULE (that is, queued) transfers, Generation Data Groups are
handled differently depending on the option used.
If the local file is specified with LCLDS01, CA XCOM Data Transport transfers the
designated file when the request is made. This is done regardless of whether a
generation data set is specified by its relative generation number or its
GxxxxV00 suffix.
If the local file is specified as LFILE, it is transferred according to its relative
generation number. This permits maximum flexibility without alteration of the
production JCL.
If the LCLDS01 DD is used to create a +1 GDG version for TYPE=SCHEDULE
transfer, there are additional potential problems:
■
When the z/OS JCL performs the allocation of the LCLDS01 DD, it allocates
and potentially catalogs the new version, depending on the value of the DISP
parameter in the JCL. This new version does not have an end-of-file mark,
because it has not yet been opened and closed by a program.
■
When the transfer begins on the CA XCOM Data Transport started task, it
allocates a new +1 version of the GDG. In cases where the transfer is
successful, this results in the creation of two new generations of the GDG.
The first version contains garbage, because it was allocated by the z/OS JCL
processor and was never opened or closed by a program to write an
end-of-file mark. If the transfer fails, under certain conditions the version
allocated by the CA XCOM Data Transport started task may be deleted. This
leaves the version of the GDG allocated by the z/OS JCL processor as the
current version.
All of these potential problems can be avoided if the LOCAL FILE name is
specified on the LFILE SYSIN01 parameter, rather than with the LCLDS01 DD
statement for TYPE=SCHEDULE transfers.
Note: This distinction is irrelevant to TYPE=EXECUTE transfers because there is
no time lag with these types of transfers.
348 User Guide
USS Files
Menu Interface
The handling of Generation Data Groups by the Menu Interface (see the chapter
―The Menu Interface (TSO/ISPF Panels)‖) does not involve production JCL. The
local file specification is interpreted literally by CA XCOM Data Transport. For
queued and non-queued transfers, if a relative generation number is specified
for the local Data set Name, CA XCOM Data Transport transfers the generation
data set possessing this relative generation number whenever the transfer
executes. For example, if you specify the current generation (0), the current
generation is always processed.
To process a particular data set, give it a GxxxxV00 suffix. This data set is then
processed whenever the transfer executes.
Transferring All Generations of a GDG
If desired, CA XCOM Data Transport can transfer all generation data sets within
a GDG in a single transfer operation. To do so, specify the GDG by its base name
in the request (that is, without a relative generation number). CA XCOM Data
Transport then transfers all data sets in a single stream, starting with the newest
generation and ending with the oldest.
USS Files
This section describes special considerations for handling USS files, including
HFS, ZFS, and TFS files.
You can allocate and process USS files as either BINARY or TEXT files. This is
dependent on the value of the CODE= parameter and the FILEDATA/LFILEDATA
parameters.
Handling USS Files as BINARY
When CODE=BINARY is specified, CA XCOM Data Transport allocates the USS file
as FILEDATA=BINARY. CA XCOM Data Transport also processes the data as
BINARY data; that is, no translations are performed on the data, as they would
be for CODE=EBCDIC or CODE=ASCII.
Chapter 6: Processing Different File Types 349
VSAM Files
Handling USS Files as TEXT
Unless CODE=BINARY is specified, CA XCOM Data Transport normally allocates a
USS file as FILEDATA=TEXT (the JCL equivalent). There is no concept of LRECL
and BLKSIZE for USS files. Input records are terminated by a new line character
(x'15'). When CA XCOM Data Transport writes a USS TEXT file, it inserts new line
characters at the end of each record.
Handling BINARY USS Files as TEXT
It may be necessary to cause CA XCOM Data Transport to allocate a USS file in
BINARY, but process the file as TEXT. If the USS file does not contain new line
characters (x'15') at the end of each logical line, it still may be possible to
process the data as TEXT. To do this, specify FILEDATA=BINARY,
CODE=EBCDIC, and LRECL=nn.
When FILEDATA/LFILEDATA=BINARY is specified, CA XCOM Data Transport
allocates the USS file as if FILEDATA=BINARY had been specified on the JCL
statement. However, the number of characters read from the file and considered
to be a logical record depends on the value of LRECL.
Note: On ISPF panels and CICS screens there is a separate field, USSLRECL, to
specify the logical record length. The SYSIN01 parameter is LRECL.
Example
If you specify LRECL=10, then CA XCOM Data Transport treats each sequential
10 bytes as a separate record. If you specify LRECL=133, then CA XCOM Data
Transport treats the data as 133-byte records. Because there are no new line
characters in the data, you must tell CA XCOM Data Transport how long each
record is.
VSAM Files
CA XCOM Data Transport supports three access methods: QSAM, BPAM (for
partitioned data sets), and VSAM. For VSAM, it supports the key-sequenced data
set (KSDS), entry-sequenced data set (ESDS), and relative record data set
(RRDS) file types.
Note: Because of VSAM limitations, the CA XCOM Data Transport
checkpoint/restart facility is not supported for ESDS files. For KSDS and RRDS
files, CA XCOM Data Transport supports checkpoint/restart only for file transfers
using REPLACE as the specified File Option.
350 User Guide
Miscellaneous File Considerations
Key Sequenced Data Sets (KSDS)
When transmitting an indexed file across systems (for example, a VSAM KSDS
file), the key length and relative key position must be the same on both the
sending and receiving computers.
CA XCOM Data Transport supports the insertion of new records between existing
records and the replacement of existing keys for KSDS files (Version=2 transfers
only). To do this, specify ADD or REPLACE for the FILEOPT parameter. You must
also employ the CREATE option if the data set has been defined with the REUSE
option and is to be reused.
Entry Sequenced Data Sets (ESDS)
For Entry Sequenced Data sets, specify ADD. This adds the new input to the end
of the data set. You must also employ the CREATE option if the data set has been
defined with the REUSE option and is to be reused.
Relative Record Data Sets (RRDS)
CA XCOM Data Transport processes relative record data sets sequentially
without preserving relative record numbers across systems. Source RRDS
records are written into the target RRDS data set sequentially, starting with
relative key 1. You must also employ the CREATE option if the data set has been
defined with the REUSE option and is to be reused.
Note: When creating a VSAM file, make sure that the file is pre-allocated on the
destination system.
Miscellaneous File Considerations
The following are special considerations involving a variety of file types:
■
Writing fixed length records to variable length records
■
Multivolume data sets
■
Spanned records
■
Variable length records
Chapter 6: Processing Different File Types 351
Miscellaneous File Considerations
Fixed to Variable Length Record Transfers
When sending a file of fixed length records to a z/OS data set of variable length
records, be sure that the record length of the target file is at least four bytes
longer than that of the source file. This accommodates the four-byte prefix that
z/OS systems use to define variable length records.
IBM iSeries systems do not support variable length records. Instead, they create
target files whose fixed record length is the same as the largest variable length
record of the source file. This can waste considerable disk space.
Multivolume Data Sets
CA XCOM Data Transport supports multivolume data sets, that is, files residing
on more than one disk pack. However, ISPF does not support multivolume data
sets. Consequently, neither does the CA XCOM Data Transport Menu Interface.
Use the Batch Interface when processing multivolume data sets.
Note: If the multivolume data set is an output file, it must be pre-allocated. In
this situation, FILEOPT=REPLACE must be used.
Spanned Records
CA XCOM Data Transport supports spanned records (Version=2 transfers only).
While CA XCOM Data Transport does not specifically support either ISAM
(Indexed Sequential Access Method) or DA (Direct Access) data sets, several
utilities (for example, IEBISAM) exist to convert these access methods to
sequential files, which CA XCOM Data Transport does support.
Preserving Variable Length Record Descriptor Words
When using extended VLR, the exact contents of a variable length file are
preserved, as follows:
352 User Guide
■
If a variable length file is sent from z/OS to another system that supports
extended VLR, then the exact contents are saved. When that file is then
transmitted to a z/OS system, the resulting file contents are the same.
■
VLR=YES, used in conjunction with CODE=BINARY, sends the z/OS record
descriptor words to the receiving system. If the receiving system also
contains Extended Variable Length Record support, then the record
descriptor words are saved along with the record. When that file is then
transmitted to a z/OS system, the resulting file is identical to the original
sending file.
Chapter 7: Overview of Security
CA XCOM Data Transport provides security for four different types of resources.
The resources that can be secured are the files, data in the files, commands, and
LUs or IP destinations. This section offers a brief characterization of the essential
features of CA XCOM Data Transport security as it relates to the various
resources.
This section contains the following topics:
File Security (see page 353)
Command Security (see page 353)
Partner Security (see page 353)
Invoking Security (see page 354)
Data Encryption Using Secure Socket Layer (SSL) (see page 354)
File Security
CA XCOM Data Transport makes calls to IBM RACF, CA Top Secret, and CA ACF2
to verify whether a given user ID is authorized to read or update a given data set.
Command Security
CA XCOM Data Transport makes standard SAF calls to determine whether a
given user ID or console is authorized to issue CA XCOM Data Transport
commands. The commands whose access status is verified include z/OS console
commands and commands that can be issued through ISPF and CICS menu
interfaces.
Partner Security
CA XCOM Data Transport makes standard SAF calls to determine whether a
given user ID is authorized to perform transfers with a given partner.
Additionally, CA XCOM Data Transport checks whether the direction (send,
receive) in which the transfers are performed is authorized and whether the
partner making a transfer request can be the initiator of transfers.
Chapter 7: Overview of Security 353
Invoking Security
Invoking Security
Each security function can be turned on separately via the assembled Default
Options Table in the CA XCOM Data Transport load library. Also, each security
function has an associated user exit, which increases the flexibility of CA XCOM
Data Transport's security and allows security to be adapted to site-specific
conditions.
For more detailed information, see the chapter “Security Considerations‖ in the
CA XCOM Data Transport for z/OS Administration Guide.
Data Encryption Using Secure Socket Layer (SSL)
CA XCOM Data Transport uses OpenSSL to utilize the Secure Socket Layer (SSL)
to perform secure TCP/IP transfers between platforms running CA XCOM Data
Transport r11 and above that support secure (SSL) TCP/IP. A secure (SSL)
TCP/IP transfer allows for the encryption of the transmitted data and adds a
digital signature to the encryption of the transmitted data.
354 User Guide
Appendix A: History and SMF Files
This appendix describes the CA XCOM Data Transport SMF record, the CA XCOM
Data Transport History File, and the XCOMUTIL utility, which selectively purges
records from the History File.
This section contains the following topics:
SMF Record and History File (see page 355)
XCOMUTIL History File Purge Utility (see page 356)
XCOMUTIL Parameters (see page 356)
XCOMUTIL DD Statements (see page 358)
SMF Record and History File
This section describes the SMF record and History File as they are used by CA
XCOM Data Transport for z/OS.
When Records Are Written
CA XCOM Data Transport writes an SMF record when SMF=YES is specified in the
CA XCOM Data Transport Default Options Table (see the chapter ―Configuring
and Customizing Your Product‖ in the CA XCOM Data Transport for z/OS
Administration Guide). History records are written at all times for scheduled
transfers. History records are not written for TYPE=EXECUTE transfers.
Transfers That Produce Records
The following types of transfers produce an SMF and history record:
■
File transfers that complete successfully
■
File transfers that are manually canceled while inactive
■
File transfers that are automatically aged off the queue
■
File transfers that are terminated while in progress
■
File transfers that fail due to some kind of problem
Appendix A: History and SMF Files 355
XCOMUTIL History File Purge Utility
Transfers That Do Not Produce Records
The following types of transfers are not considered complete by CA XCOM Data
Transport, and thus no SMF or history records are created for them:
■
Suspended file transfers
■
File transfer requests that are in hold state
Record Location
The SMF record is mapped by the SMFDSECT macro, which can be found in
CAI.CBXGMAC.
The history record is mapped by the HSTDSECT macro, which can be found in
CAI.CBXGMAC.
XCOMUTIL History File Purge Utility
XCOMUTIL is the CA XCOM Data Transport utility that purges records from the
CA XCOM Data Transport history file. This utility should be run periodically to
prevent a ―history file full‖ condition. It has been designed as an offline utility
because VSAM is inefficient at reclaiming space when records are randomly
deleted from a VSAM cluster.
To reclaim the space
1. Copy the history file to a sequential file.
2. Run XCOMUTIL against this sequential file to purge a specified range of
records and create a new sequential file.
3. Delete the existing history file and create a new one.
4. Copy the new sequential file to the history file.
Note: The CA XCOM Data Transport server cannot be executing when XCOMUTIL
is used.
XCOMUTIL Parameters
There are three parameters that control the processing performed by
XCOMUTIL. These parameters are input to XCOMUTIL through a SYSIN file. Their
description follows.
356 User Guide
XCOMUTIL Parameters
AGE
Specifies the number of days of history records that are retained when a purge
procedure is executed.
1 to 999
Indicates the number of days of history records to be retained when
executing a purge.
Notes:
■
After XCOMUTIL has been run, the history file comprises the current date's
records plus nnn days of records. For example, if the current Julian date is
08300 and AGE=1 is specified, then XCOMUTIL purges any history records
written on or before 08298. Only the current and previous day's history
records are saved.
■
Use the AGE parameter if you intend to run XCOMUTIL on a periodic basis. It
allows you to set up a procedure in which a specific date does not have to be
continually modified.
■
This parameter is mutually exclusive with the DATE parameter. One of these
two parameters must always be included in the SYSIN file.
DATE
Specifies the date of records that are to be purged from the history file. Any
history record written either on or before the specified date are purged from the
history file.
yyddd
Specifies the Julian date when records are to be purged from the history file.
Notes:
■
This parameter and the AGE parameter are mutually exclusive. Both cannot
be included in the same SYSIN file.
■
Note that the purge date must be specified in terms of a two-digit
designation for the year and a three-digit designation for the day of the year.
For example, 08100 represents year 2008 and the 100th day of that year.
Appendix A: History and SMF Files 357
XCOMUTIL DD Statements
PROCESS
Specifies that the object of XCOMUTIL is the history file.
HISTORY
Indicates that the object of XCOMUTIL is the history file.
Note: This parameter is required in the SYSIN file.
XCOMUTIL DD Statements
This section describes the DD statements that are needed to execute XCOMUTIL
There are four DD statements required to execute XCOMUTIL:
HISTIN
A sequential file consisting of CA XCOM Data Transport history records.
Generally, the history file is reproduced as a sequential file prior to running
XCOMUTIL. Then, HISTIN is used to input this file.
HISTOUT
The sequential output file of history records that are not deleted from the
history file. Generally, after running XCOMUTIL (and receiving a 0 return
code), the history file is deleted and redefined. Then, the HISTOUT file is
copied back to the history file.
SYSIN
Used to enter the XCOMUTIL parameters described earlier.
SYSPRINT
XCOMUTIL prints a report providing details about the purge procedure just
executed.
358 User Guide
XCOMUTIL DD Statements
Sample of Required JCL
The complete sample JCL can be found in CINB5SAM and is listed in the appendix
‖Sample Files.‖
//*--------------------------------------------------------------//*(2) SELECT ONLY RECORDS THAT ARE NOT OLDER THAN X DAYS
//*--------------------------------------------------------------//*
//STEP2
EXEC
PGM=XCOMUTIL, COND=(0,NE)
//STEPLIB DD
DSN=XCOM.X.LOAD,DISP=SHR
//SYSPRINT DD
SYSOUT=*
//HISTIN
DD
DSN=&&HSTSAV,DISP=(OLD,DELETE)
//HISTOUT DD
DSN=&&HSTNEW,UNIT=SYSALLDA,
SPACE=(CYL,(2,2)),DISP=(NEW,PASS)
//SYSIN DD
*
PROCESS=HISTORY
AGE=X
Return Codes
The following are XCOMUTIL return codes:
0
XCOMUTIL ran successfully.
4
XCOMUTIL ran successfully, but no history output records were written
based on the specified selection criteria.
8
XCOMUTIL was unable to open one of the files.
12
XCOMUTIL found a parameter error processing the SYSIN file.
Appendix A: History and SMF Files 359
XCOMUTIL DD Statements
Sample History File Purge Process (XCOMUTIL)
Note: Because XCOMUTIL is an offline procedure, remember to first bring CA
XCOM Data Transport down using a console command (for example, F
XCOM,STOP).
CAI.CBXGJCL(XCOMUTIL) contains an example of a four-step process that
performs the following steps.
■
Copies the CA XCOM Data Transport history file to a temporary sequential
dataset, using the IDCAMS REPRO command.
■
Executes the XCOMUTIL program to purge records from the passed
sequential data set that are older than x days and passes the selected
records to stage 4 below.
■
If XCOMUTIL purged all records from the History File, generates a new binary
zero seed record for the history file using the MVS utility IEBDG.
■
Calls IDCAMS to do the following:
–
Delete the old history file cluster, alternate indices and paths.
–
Redefine the base cluster.
–
Copy the seed and the selected records back into the base cluster.
–
Redefine and rebuild the alternate indices and paths.
When the purge finishes, restart CA XCOM Data Transport with another
command (for example, START XCOM).
360 User Guide
Appendix B: Sample Files
This appendix contains illustrations of some of the sample files supplied on the
CA XCOM Data Transport for z/OS distribution tape. These are supplied for
reference only.
Important! In cases where the printed examples differ from what is provided on
the distribution tape, the tape is more current.
Appendix B: Sample Files 361
XCOMUTIL DD Statements
This section contains the following topics:
Sample JCLVSAM Request Queue (Member DEFRRDS) (see page 363)
Sample History File Creation JCL (Member DEFHIST) (see page 365)
Sample XCOMUTIL Job (Member XCOMUTIL) (see page 368)
Sample DEFQSAM Job to Define Global and Restart Data Sets (Member
DEFQSAM) (see page 373)
Sample JCL for Defining the Inquire Data Set (Member DEFINQ) (see page 374)
Sample VTAM APPLID Definition Table (Member APPLXCOM) (see page 375)
Sample XCOMTABL Table (Member XCOMTABL) (see page 377)
Sample XCOMDFLT Macro (Member XCOMDFLT) (see page 382)
Sample XCOMADMT Table (Member XCOMADMT) (see page 385)
Sample XCPF (Member XCPF) (see page 386)
Sample POLCFRM (Member POLCFRM) (see page 387)
Sample XCOMPLEX Admin Server (see page 388)
Sample Server JCL (Member XCOM) (see page 389)
Sample XCOMLSR (see page 390)
Sample CICS Notification Transaction (Member XCOMSAMP) (see page 391)
Sample XCOMJOB—Execute JCL (Member XCOMJOBE) (see page 392)
Sample XCOMJOB—Schedule JCL (Member XCOMJOBS) (see page 393)
Sample XCOMJOB—Schedule JCL through the XCOMPLEX Admin Server
(Member XCOMJOXS) (see page 394)
Sample XCOMJOB—Inquire JCL (Member XCOMJOBI) (see page 396)
Sample XCOMJOB—Inquire JCL through the XCOMPLEX Admin Server (Member
XCOMJOXI) (see page 398)
Sample XCOMJOB TYPE=HISTORY JCL (Member XCOMJOBH) (see page 400)
Sample JCL for Reassembling and Link Editing XCOMRACF (Member ASMRACFU)
(see page 402)
Sample JCL for Reassembling and Link Editing XCOMTOPS (Member ASMTOPSU)
(see page 404)
Sample JCL for Reassembling and Link Editing XCOMACF2 (Member ASMACF2U)
(see page 406)
Sample DEFDFLT (see page 407)
Sample XCOMENCR—JCL to Encrypt the SYSIN01 PASSWORD/LPASS
Parameters (Member XCOMENCR) (see page 408)
Sample COPYCSD (see page 409)
Sample XCOMFCT (see page 411)
Sample XCOMPCT (see page 412)
Sample XCOMPPT (see page 413)
Sample XCOMTCT (see page 414)
362 User Guide
Sample JCLVSAM Request Queue (Member DEFRRDS)
Sample JCLVSAM Request Queue (Member DEFRRDS)
The following is a copy of the sample JCL-VSAM Request Queue
(CAI.CINB5SAM(DEFRRDS)) found on the distribution tape. This JCL builds
active and pending file transfer queues.
//JOBNAME JOB (ACCOUNTING),'XCOM INSTALLATION',
//
CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1)
//*
//*********************************************************************
//*
//* DOC: THIS JOB BUILDS THE ACTIVE AND PENDING FILE TRANSFER QUEUE
//*
//*
//* NOTE: 1. REPLACE THE JOB CARD WITH ONE THAT IS VALID FOR YOUR SITE.
//*
2. CHANGE ALL OCCURENCES OF "VVVVVV" WITH A VALID DASD VOLSER
//*
NUMBER FOR VSAM FILES AT YOUR INSTALLATION.
//*
3. CHANGE ALL OCCURENCES OF "XCOM.X" TO A VALID VSAM DATA SET
//*
PREFIX FOR YOUR INSTALLATION.
//*
4. RECSZ CHANGED FROM RECSZ(1100 1100) TO RECSZ(2020 2020)
//*
//*********************************************************************
//*
//S1
EXEC PGM=IEBDG
//SYSPRINT DD SYSOUT=*
//OUTPUT
DD DSN=&&TEMP,UNIT=SYSALLDA,SPACE=(TRK,(1)),
//
DCB=(RECFM=FB,LRECL=2020,BLKSIZE=2020),DISP=(NEW,PASS)
//SYSIN
DD *
DSD OUTPUT=(OUTPUT)
FD NAME=FIELD1,LENGTH=8,STARTLOC=1,PICTURE=8,'XCOMRRDS'
FD NAME=FIELD2,LENGTH=4,STARTLOC=9,PICTURE=4,B'1000'
CREATE QUANTITY=1,NAME=(FIELD1,FIELD2),FILL=X'00'
/*
//*
//S2
EXEC PGM=IDCAMS,REGION=1024K
//SYSPRINT DD SYSOUT=*
//INPUT
DD DSN=&&TEMP,DISP=(OLD,DELETE)
//SYSIN
DD *
DELETE XCOM.X.RRDS
SET MAXCC = 0
DEF CLUSTER (NAME(XCOM.X.RRDS)
NUMBERED
VOL(VVVVVV)
RECORDS(1500) /*NO SECONDARY ALLOCATION ALLOWED BY XCOM*/ RECSZ(2020 2020)
FSPC(0 0)
-
Appendix B: Sample Files 363
Sample JCLVSAM Request Queue (Member DEFRRDS)
CISZ(2048)
SHAREOPTIONS(2 3))
DATA (NAME(XCOM.X.RRDS.DATA))
REPRO IFILE(INPUT)
ODS(XCOM.X.RRDS)
/*
//
364 User Guide
-
-
Sample History File Creation JCL (Member DEFHIST)
Sample History File Creation JCL (Member DEFHIST)
The following is a copy of the sample History File Creation JCL found on the
distribution tape (CAI.CBXGJCL(DEFHIST)). This JCL builds the CA XCOM Data
Transport History File and its associated indices and paths. For history file
maintenance, use XCOMUTIL instead.
//JOBNAME
JOB (ACCOUNTING),'XCOM INSTALLATION',
//
CLASS=X,MSGCLASS=X,MSGLEVEL=(1,1)
//*
//*********************************************************************
//*
//*
THIS JOB BUILDS THE XCOM HISTORY FILE,ASSOCIATED INDICES,
//*
AND PATHS
//*
//*
(1) DELETE THE OLD VSAM HISTORY FILE CLUSTER,
//*
ALTERNATE INDICES, AND PATHS
//*
(2) DEFINE THE BASE CLUSTER
//*
(3) REPRO THE SEED INITIALIZATION RECORD
//*
BACK INTO THE BASE CLUSTER
//*
(4) BUILD ALTERNATE INDICES AND PATHS
//*
//*
//* NOTE: 1. REPLACE THE JOB CARD WITH ONE THAT IS VALID FOR YOUR SITE.
//*
2. CHANGE ALL OCCURENCES OF "VVVVVV" WITH A VALID DASD VOLSER
//*
NUMBER FOR VSAM FILES AT YOUR INSTALLATION.
//*
3. CHANGE ALL OCCURENCES OF "XCOM.X" TO A VALID VSAM DATA SET
//*
PREFIX FOR YOUR INSTALLATION.
//*
4. RECSZ CHANGED FROM RECSZ(700 1200) TO RECSZ(1100 2020)
//*********************************************************************
//*
//S1
EXEC PGM=IEBDG
//SYSPRINT DD SYSOUT=*
//OUTPUT
DD DSN=&&TEMP,UNIT=SYSALLDA,SPACE=(TRK,(1)),
//
DCB=(RECFM=FB,LRECL=1000,BLKSIZE=1000),DISP=(NEW,PASS)
//SYSIN
DD *
DSD OUTPUT=(OUTPUT)
CREATE QUANTITY=1,FILL=X'00'
//S2IDCAMS EXEC PGM=IDCAMS,REGION=1024K
//SYSPRINT DD SYSOUT=*
//INPUT
DD DSN=&&TEMP,DISP=OLD
//SYSIN
DD *
DELETE XCOM.X.XCOMHIST
SET MAXCC = 0
DEF CLUSTER (NAME(XCOM.X.XCOMHIST)
KEYS(12 0)
-
Appendix B: Sample Files 365
Sample History File Creation JCL (Member DEFHIST)
VOL(VVVVVV)
CYLINDERS(5 2)
RECSZ(1100 2020)
FSPC(0 0)
SHAREOPTIONS(2 3))
DATA (NAME(XCOM.X.XCOMHIST.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMHIST.INDEX)
CISZ(1024))
-
REPRO IFILE(INPUT)
ODS(XCOM.X.XCOMHIST)
366 User Guide
DEF AIX (NAME(XCOM.X.XCOMREQ.AIX)
RELATE(XCOM.X.XCOMHIST)
SHR(2 3)
NONUNIQUEKEY
UPGRADE
VOL(VVVVVV)
RECSZ(20 300)
CYLINDERS(1 1)
KEYS(12 48))
DATA (NAME(XCOM.X.XCOMREQ.AIX.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMREQ.AIX.INDEX)
CISZ(1024))
-
DEF AIX (NAME(XCOM.X.XCOMRECP.AIX)
RELATE(XCOM.X.XCOMHIST)
SHR(2 3)
NONUNIQUEKEY
UPGRADE
RECSZ(20 300)
VOL(VVVVVV)
CYLINDERS(1 1)
KEYS(16 82))
DATA (NAME(XCOM.X.XCOMRECP.AIX.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMRECP.AIX.INDEX)
CISZ(1024))
-
DEF AIX (NAME(XCOM.X.XCOMUSER.AIX)
RELATE(XCOM.X.XCOMHIST)
SHR(2 3)
NONUNIQUEKEY
UPGRADE
RECSZ(20 300)
VOL(VVVVVV)
CYLINDERS(1 1)
-
Sample History File Creation JCL (Member DEFHIST)
KEYS(20 28))
DATA (NAME(XCOM.X.XCOMUSER.AIX.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMUSER.AIX.INDEX)
CISZ(1024))
-
DEF AIX (NAME(XCOM.X.XCOMIDNT.AIX)
RELATE(XCOM.X.XCOMHIST)
SHR(2 3)
NONUNIQUEKEY
UPGRADE
RECSZ(20 300)
VOL(VVVVVV)
CYLINDERS(1 1)
KEYS(18 98))
DATA (NAME(XCOM.X.XCOMIDNT.AIX.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMIDNT.AIX.INDEX)
CISZ(1024))
-
BIX IDS(XCOM.X.XCOMHIST)
ODS(XCOM.X.XCOMREQ.AIX)
-
BIX IDS(XCOM.X.XCOMHIST)
ODS(XCOM.X.XCOMRECP.AIX)
-
BIX IDS(XCOM.X.XCOMHIST)
ODS(XCOM.X.XCOMUSER.AIX)
-
BIX IDS(XCOM.X.XCOMHIST)
ODS(XCOM.X.XCOMIDNT.AIX)
-
DEF PATH (NAME(XCOM.X.XCOMREQ.PATH)
PENT (XCOM.X.XCOMREQ.AIX) UPDATE)
-
DEF PATH (NAME(XCOM.X.XCOMRECP.PATH)
PENT (XCOM.X.XCOMRECP.AIX) UPDATE)
-
DEF PATH (NAME(XCOM.X.XCOMUSER.PATH)
PENT (XCOM.X.XCOMUSER.AIX) UPDATE)
-
DEF PATH (NAME(XCOM.X.XCOMIDNT.PATH)
PENT (XCOM.X.XCOMIDNT.AIX) UPDATE)
-
/*
//
Appendix B: Sample Files 367
Sample XCOMUTIL Job (Member XCOMUTIL)
Sample XCOMUTIL Job (Member XCOMUTIL)
The following is a copy of the sample XCOMUTIL Job found on the distribution
tape (CAI.CBXGJCL(XCOMUTIL)). Use this JCL to maintain your history file at
regular intervals.
//JOBNAME
JOB (ACCOUNTING),'XCOMHIST CLEANUP',CLASS=A,MSGCLASS=X
//*
//*********************************************************************
//*
*
//*
CA XCOM MVS HISTORY FILE CLEANUP
*
//*
*
//*
DELETES OLD (AGED) RECORDS FROM HISTORY FILE
*
//*
*
//*
*
//*
STEP
DESCRIPTION
*
//*
------------------------------------------------------*
//*
1
REPRO HISTORY FILE TO WORK FILE
*
//*
2
DELETE OLD RECORDS FROM WORK FILE
*
//*
3
DELETE XCOM VSAM HISTORY FILE
*
//*
4
DEFINES XCOM VSAM HISTORY FILE
*
//*
5
ADD VSAM SEED RECORD TO NEW HISTORY FILE
*
//*
6
RELOAD HISTORY FILE FROM WORK FILE
*
//*
7
DEFINE/BUILD AIX'S AND PATHS FOR NEW HISTORY FILE
*
//*
*
//*********************************************************************
//*
//*-------------------------------------------------------//*(1) IDCAMS REPRO THE HISTORY FILE TO A SEQUENTIAL FILE
//*-------------------------------------------------------//*
//STEP1
EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//DD1
DD DSN=XCOM.X.XCOMHIST,DISP=SHR
//DD2
DD DSN=&&HSTSAV,UNIT=SYSALLDA,SPACE=(CYL,(2,2)),
//
DISP=(NEW,PASS),DCB=(RECFM=VB,LRECL=2000,BLKSIZE=23440)
//SYSIN
DD *
REPRO IFILE(DD1) OFILE(DD2)
/*
//*
//*-------------------------------------------------------//*(2) SELECT ONLY RECORDS THAT ARE NOT OLDER THAN X DAYS
//*-------------------------------------------------------//*
//STEP2
EXEC PGM=XCOMUTIL,COND=(0,NE)
//STEPLIB DD DSN=XCOM.X.LOAD,DISP=SHR
//SYSPRINT DD SYSOUT=*
//HISTIN
DD DSN=&&HSTSAV,DISP=(OLD,DELETE)
//HISTOUT DD DSN=&&HSTNEW,UNIT=SYSALLDA,SPACE=(CYL,(2,2)),
368 User Guide
Sample XCOMUTIL Job (Member XCOMUTIL)
//
DISP=(NEW,PASS)
//SYSIN
DD *
PROCESS=HISTORY
AGE=X
/*
//*
//*-------------------------------------------------------//*(3) DELETE THE HISTORY FILE
//*-------------------------------------------------------//*
//STEP3
EXEC PGM=IDCAMS,COND=(4,LT)
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
DELETE XCOM.X.XCOMHIST PURGE CLUSTER
/*
//*
//*-------------------------------------------------------//*(4) DEFINE HISTORY FILE
//*-------------------------------------------------------//*
//STEP4
EXEC PGM=IDCAMS,COND=(4,LT)
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
DEF CLUSTER (NAME(XCOM.X.XCOMHIST)
KEYS(12 0)
VOL(VVVVVV)
CYLINDERS(5 2)
RECSZ(1100 2020)
FSPC(0 0)
SHAREOPTIONS(2 3))
DATA (NAME(XCOM.X.XCOMHIST.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMHIST.INDEX) CISZ(1024))
/*
//*
//*-----------------------------------------------------------------//*(5) IF NO HISTORY RECORDS SLECTED, PLACE A SEED INTO THE VSAM FILE
//*-----------------------------------------------------------------//*
//STEP5
EXEC PGM=IEBDG,COND=(4,NE)
//SYSPRINT DD SYSOUT=*
//OUTPUT
DD DSN=&&HSTNEW,DISP=OLD,DCB=LRECL=120
//SYSIN
DD *
DSD OUTPUT=(OUTPUT)
CREATE QUANTITY=1,FILL=X'00'
/*
//*
CHANGED
CHANGED
CHANGED
CHANGED
CHANGED
CHANGED
CHANGED
Appendix B: Sample Files 369
Sample XCOMUTIL Job (Member XCOMUTIL)
//*----------------------------------------------------------------//*(6) IDCAMS REPRO THE SELECTED RECORDS INTO THE NEW HISTORY FILE
//*----------------------------------------------------------------//*
//STEP6
EXEC PGM=IDCAMS,COND=(4,LT)
//SYSPRINT DD SYSOUT=*
//INPUT
DD DSN=&&HSTNEW,DISP=OLD
//OUTPUT
DD DSN=XCOM.X.XCOMHIST,DISP=OLD
//SYSIN
DD *
REPRO
IFILE(INPUT)
OFILE(OUTPUT)
-
/*
//*
//*----------------------------------------------------------------//*(7) IDCAMS DEFINE/BUILD THE AIX'S AND PATHS FOR NEW HISTORY FILE
//*----------------------------------------------------------------//*
//STEP7
EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
DEF AIX (NAME(XCOM.X.XCOMREQ.AIX)
RELATE(XCOM.X.XCOMHIST)
SHR(2 3)
NONUNIQUEKEY
UPGRADE
VOL(VVVVVV)
RECSZ(20 300)
CYLINDERS(1 1)
KEYS(12 48))
DATA (NAME(XCOM.X.XCOMREQ.AIX.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMREQ.AIX.INDEX)
CISZ(1024))
-
DEF AIX (NAME(XCOM.X.XCOMRECP.AIX)
RELATE(XCOM.X.XCOMHIST)
SHR(2 3)
NONUNIQUEKEY
UPGRADE
RECSZ(20 300)
VOL(VVVVVV)
CYLINDERS(1 1)
KEYS(16 82))
DATA (NAME(XCOM.X.XCOMRECP.AIX.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMRECP.AIX.INDEX)
CISZ(1024))
-
370 User Guide
CHANGED
CHANGED
Sample XCOMUTIL Job (Member XCOMUTIL)
DEF AIX (NAME(XCOM.X.XCOMUSER.AIX)
RELATE(XCOM.X.XCOMHIST)
SHR(2 3)
NONUNIQUEKEY
UPGRADE
RECSZ(20 300)
VOL(VVVVVV)
CYLINDERS(1 1)
KEYS(20 28))
DATA (NAME(XCOM.X.XCOMUSER.AIX.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMUSER.AIX.INDEX)
CISZ(1024))
-
DEF AIX (NAME(XCOM.X.XCOMIDNT.AIX)
RELATE(XCOM.X.XCOMHIST)
SHR(2 3)
NONUNIQUEKEY
UPGRADE
RECSZ(20 300)
VOL(VVVVVV)
CYLINDERS(1 1)
KEYS(18 98))
DATA (NAME(XCOM.X.XCOMIDNT.AIX.DATA)
CISZ(4096))
INDEX (NAME(XCOM.X.XCOMIDNT.AIX.INDEX)
CISZ(1024))
-
BIX IDS(XCOM.X.XCOMHIST)
ODS(XCOM.X.XCOMREQ.AIX)
-
BIX IDS(XCOM.X.XCOMHIST)
ODS(XCOM.X.XCOMRECP.AIX)
-
BIX IDS(XCOM.X.XCOMHIST)
ODS(XCOM.X.XCOMUSER.AIX)
-
BIX IDS(XCOM.X.XCOMHIST)
ODS(XCOM.X.XCOMIDNT.AIX)
-
DEF PATH (NAME(XCOM.X.XCOMREQ.PATH)
PENT (XCOM.X.XCOMREQ.AIX) UPDATE)
-
DEF PATH (NAME(XCOM.X.XCOMRECP.PATH)
PENT (XCOM.X.XCOMRECP.AIX) UPDATE)
-
DEF PATH (NAME(XCOM.X.XCOMUSER.PATH)
PENT (XCOM.X.XCOMUSER.AIX) UPDATE)
-
Appendix B: Sample Files 371
Sample XCOMUTIL Job (Member XCOMUTIL)
DEF PATH (NAME(XCOM.X.XCOMIDNT.PATH)
PENT (XCOM.X.XCOMIDNT.AIX) UPDATE)
/*
//
372 User Guide
-
Sample DEFQSAM Job to Define Global and Restart Data Sets (Member DEFQSAM)
Sample DEFQSAM Job to Define Global and Restart Data Sets
(Member DEFQSAM)
The following is a copy of the sample DEFQSAM Job found on the distribution
tape (CAI.CBXGJCL(DEFQSAM)).
//JOBNAME
JOB (ACCOUNTING),'XCOM INSTALLATION',
<==== #1
//
CLASS=X,MSGCLASS=X,MSGLEVEL=(1,1)
//*
//*********************************************************************
//*
*
//*
*
//*
DOC: CREATE XCOMJOB GLOBAL AND RESTART SEQUENTIAL FILES
*
//*
*
//*
CHANGE: 1) SUPPLY A VALID JOBCARD FOR YOUR INSTALLATION
*
//*
2) DATASET NAME TO BE USED FOR YOUR GLOBAL DATASET
*
//*
3) VOLUME UPON WHICH THE GLOBAL DATASET SHOULD RESIDE *
//*
4) DATASET NAME TO BE USED FOR YOUR RESTART DATASET
*
//*
5) VOLUME UPON WHICH THE RESTART DATASET SHOULD RESIDE *
//*
*
//*
*
//*
*
//* NOTE: A SEPARATE RESTART DATA SET SHOULD BE DEFINED FOR EACH
*
//*
TYPE=EXECUTE JOB. THEY ARE NOT SHARABLE.
*
//*
*
//*********************************************************************
//*
//GLOBAL
EXEC PGM=IEBDG
//SYSPRINT DD SYSOUT=*
//GLOBAL
DD DSN=XXXXXXXX.GLOBAL,
<==== #2
//
VOL=SER=VVVVVV,
<==== #3
//
UNIT=SYSALLDA,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,1),
//
DCB=(RECFM=F,LRECL=80,BLKSIZE=80)
//SYSIN DD *
DSD OUTPUT=(GLOBAL)
CREATE QUANTITY=1,FILL=X'00'
/*
//*
//RESTART
EXEC PGM=IEBDG
//SYSPRINT DD SYSOUT=*
//RESTART
DD DSN=XXXXXXXX.RESTART,
<==== #4
//
VOL=SER=VVVVVV,
<==== #5
//
UNIT=SYSALLDA,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,1),
//
DCB=(RECFM=F,LRECL=2020,BLKSIZE=2020)
Appendix B: Sample Files 373
Sample JCL for Defining the Inquire Data Set (Member DEFINQ)
//SYSIN
DD *
DSD OUTPUT=(RESTART)
CREATE QUANTITY=1,FILL=X'00'
/*
//
Sample JCL for Defining the Inquire Data Set (Member
DEFINQ)
The following is a copy of the sample DEFINQ Job found on the distribution tape
(CAI.CBXGJCL(DEFINQ)).
//JOBNAME JOB (ACCOUNTING),'XCOM INSTALLATION',
<==== #1
//
CLASS=X,MSGCLASS=X,MSGLEVEL=(1,1)
//*
//*********************************************************************
//*
*
//*
DOC: CREATE XCOMJOB INQUIRY SEQUENTIAL FILE FOR TYPE=SCHEDULE *
//*
*
//*
CHANGE: 1) SUPPLY A VALID JOBCARD FOR YOUR INSTALLATION
*
//*
2) DATASET NAME TO BE USED FOR YOUR INQUIRY DATASET
*
//*
3) VOLUME UPON WHICH THE INQUIRY DATASET SHOULD RESIDE *
//*
*
//* NOTE: A SEPARATE INQUIRY DATA SET SHOULD BE DEFINED FOR EACH
*
//*
TYPE=SCHEDULE JOB. THEY ARE NOT SHARABLE. THIS FILE MUST
*
//*
ALSO BE PREALLOCATED. IT SHOULD NOT BE CREATED IN THE
*
//*
SAME JOB STREAM AS THE SCHEDULE JOB.
*
//*
*
//*********************************************************************
//*
//ALLOC EXEC PGM=IEBGENER
//SYSPRINT DD DUMMY
//SYSIN
DD DUMMY
//SYSUT1
DD DUMMY,
//
DCB=(LRECL=80,BLKSIZE=800,RECFM=FB,DSORG=PS)
//SYSUT2
DD DSN=XCOM.REL.XCOMINQ,UNIT=SYSDA,DISP=(,CATLG),
//
DCB=(LRECL=80,BLKSIZE=800,RECFM=FB,DSORG=PS),
//
SPACE=(TRK,(1)),VOL=SER=VVVVVV
//
374 User Guide
Sample VTAM APPLID Definition Table (Member APPLXCOM)
Sample VTAM APPLID Definition Table (Member APPLXCOM)
The following is a copy of the sample VTAM APPLID Definition Table found on the
distribution tape (CAI.CINB5SAM(APPLXCOM)). The table shows sample VTAM
APPLID statements.
**********************************************************************
*
* SAMPLE VTAM APPLID STATEMENTS
*=============================
*
*
* PLEASE NOTE THAT CA XCOM Data Transport FOR z/OS
* NOW SUPPORTS PARALLEL SESSIONS.
* THE "PARSESS" KEYWORD IN THE FIRST APPLID BELOW TURNS THIS
* SUPPORT ON. IF YOU LEAVE THIS SET TO "YES", THEN THE PARTNER
* COMPUTERS MUST TURN ON THE APPROPRIATE SUPPORT FOR PARALLEL
* SESSIONS ON SIMILAR DEFINITIONS.
*
* A NOTE ABOUT THE NAMES USED HERE:
*
* YOU MUST CHANGE ALL OCCURENCES OF "YOURTABL" TO THE NAME OF
* THE APPROPRIATE MODE TABLE NAME FOR YOUR INSTALLATION.
*
* THE FIRST APPLID (XCOMAPPL) WILL BE ATTACHED TO THE XCOM
* STARTED TASK ON THIS MVS SYSTEM. IT WILL BE THE NAME USED BY ALL
* OTHER XCOM IMPLEMENTATIONS TO IDENTIFY THIS SYSTEM. THEREFORE,
* YOU MUST USE A DIFFERENT NAME IF YOU ARE RUNNING MORE THAN ONE
* VERSION OF XCOM WITHIN THIS VTAM ENVIRONMENT. OTHERWISE WE HIGHLY
* RECOMMEND THAT YOU RETAIN THE ORIGINAL NAME IF YOU ARE ONLY RUNNING
* ONE VTAM VERSION OF THE SOFTWARE. THIS WILL INSURE THAT THE SAMPLES
* ON THE OTHER SYSTEMS WILL MATCH. IF YOU CHANGE THE NAME, YOU MUST
* INFORM THOSE PERSONS RESPONSIBLE FOR THE IMPLEMENTATION OF XCOM
* ON THE OTHER SYSTEMS. ADDITIONALLY, YOU WILL HAVE TO CHANGE THE
* VALUE OF THE "NETNAME" KEYWORD IN THE XCOM/MVS "DEFAULT" TABLE.
*
* IF YOU CHANGE THE ACB NAME FOR THE FIRST APPLID, THEN YOU WILL
* NEED TO ALTER THE VALUE OF THE "ACBNAME" KEYWORD ON THE "DEFAULT"
* TABLE TO MATCH.
*
* THE SUBORDINATE APPLIDS (XCOM00 THROUGH XCOMXX) ARE USED FROM WITHIN
* THIS MVS SYSTEM TO DO DIRECT (TYPE=EXECUTE) TRANSFERS TO OTHER
* COMPUTERS WITHIN YOUR SNAX COMNETWORK, OR TO COMMUNICATE WITH THE
* XCOM STARTED TASK ON THIS SYSTEM. YOU MUST BE CONSISTENT WITH
* THE PREFIX OF THE APPLID AND ACBNAMES USED FOR THESE. THE PREFIX MAY
* BE FROM 4 TO 6 CHARACTERS LONG FOLLOWED BY THE 2-CHARACTER DIGIT. IF
* YOU CHANGE THE PREFIX OF THE ACBNAME KEYWORDS HERE, YOU MUST CHANGE
* THE "JOBACB" VALUE IN THE LOCAL XCOM "DEFAULT" TABLE.
Appendix B: Sample Files 375
Sample VTAM APPLID Definition Table (Member APPLXCOM)
*********************************************************************
*
* WE HAVE SELECTED THE MODE ENTRY NAME (XCOMMODE) TO MATCH THE MODE
* NAME USED BY THE SAMPLE CONFIGURATIONS IN OTHER IMPLEMENTATIONS OF
* XCOM. WE STRONGLY SUGGEST THAT YOU KEEP THIS NAME.
*
* IF YOU HAVE ANY QUESTIONS, THIS TABLE IS EXPLAINED IN GREATER DETAIL
* IN THE ADMINISTRATION GUIDE.
*********************************************************************
APPLXCOM VBUILD TYPE=APPL
XCOMAPPL APPL AUTH=(NOPO,ACQ,VPACE),MODETAB=YOURTABL,
*
SONSCIP=YES,ACBNAME=XCOMAPPL,VPACING=5,
*
DLOGMOD=XCOMMODE,PARSESS=YES
XCOM00
APPL AUTH=(NOPO,ACQ,VPACE),MODETAB=YOURTABL,
*
SONSCIP=YES,ACBNAME=XCOM00,VPACING=5,
*
DLOGMOD=XCOMMODE
XCOM01
APPL AUTH=(NOPO,ACQ,VPACE),MODETAB=YOURTABL,
*
ONSCIP=YES,ACBNAME=XCOM01,VPACING=5,
*
DLOGMOD=XCOMMODE
XCOM02
APPL AUTH=(NOPO,ACQ,VPACE),MODETAB=YOURTABL,
*
SONSCIP=YES,ACBNAME=XCOM02,VPACING=5,
*
DLOGMOD=XCOMMODE
XCOM03
APPL AUTH=(NOPO,ACQ,VPACE),MODETAB=YOURTABL,
*
SONSCIP=YES,ACBNAME=XCOM03,VPACING=5,
*
DLOGMOD=XCOMMODE
XCOM04
APPL AUTH=(NOPO,ACQ,VPACE),MODETAB=YOURTABL,
*
SONSCIP=YES,ACBNAME=XCOM04,VPACING=5,
*
DLOGMOD=XCOMMODE
XCOM05 APPL
AUTH=(NOPO,ACQ,VPACE),MODETAB=YOURTABL,
*
SONSCIP=YES,ACBNAME=XCOM05,VPACING=5,
*
DLOGMOD=XCOMMODE
376 User Guide
Sample XCOMTABL Table (Member XCOMTABL)
Sample XCOMTABL Table (Member XCOMTABL)
The following is a copy of the sample XCOMTABL Table
(CAI.CBXGJCL(XCOMTABL)) found on the distribution tape. The table contains
sample XCOMMODE entries.
**********************************************************************
*
* CA XCOM MODE ENTRIES
* =================
*
* A NOTE ABOUT RU SIZE:
*
* ONE OF THE ADVANTAGES OF USING CA XCOM IS THAT IT CAN USE LARGER
* RU SIZES IN A WAY THAT OTHER SOFTWARE CANNOT. LARGER RU SIZES
* GENERALLY MEAN FASTER THROUGHPUT.
*
* THE ONLY DIFFERENCE BETWEEN THE MODE ENTRIES LISTED BELOW IS IN THE
* RU SIZE. YOU ONLY NEED ONE OF THE MODE ENTRIES BELOW, BUT YOU MAY
* FEEL FREE TO ADD AS MANY AS YOU LIKE TO YOUR EXISTING MODE TABLES.
*
* THE DEFAULT MODE ENTRY, "XCOMMODE" IS SET TO HAVE A 4K RU. WE HAVE
* FOUND THIS TO BE A GOOD SIZE TO START WITH AS IT DOES NOT INTERFERE
* WITH EXISTING SNA TRAFFIC AND BUFFER CONSTRAINTS, YET IT IS FASTER
* THAN THE RU SIZES USED BY MOST INSTALLATIONS.
*
* REGARDLESS OF THE RU SIZE SET IN THE MODE ENTRY HERE, THE RU WILL BE
* NEGOTIATED DOWN TO THE SMALLER VALUE WHEN THE PARTNER COMPUTER BINDS
* WITH ITS OWN RU SIZE VALUE.
*
*
* A NOTE ABOUT NAMES USED:
*
* SNA REQUIRES THAT BOTH COMPUTERS STARTING A SESSION USE THE SAME
* MODE NAME IN AN LU 6.2 BIND. THEREFORE, WE STRONGLY RECOMMEND THAT
* YOU USE THE NAME "XCOMMODE" (THE FIRST EXAMPLE BELOW), AS THAT IS
* THE NAME USED IN ALL THE PARTNER CA XCOM EXAMPLES AND DOCUMENTATION
*
* IF YOUR INSTALLATION'S NAMING STANDARDS REQUIRE YOU TO SELECT A
* DIFFERENT NAME, YOU MUST PROVIDE THE NEW NAME TO ALL OTHER CA XCOM
* INSTALLATIONS WITHIN YOUR NETWORK.
*
*
* A NOTE ABOUT MODE TABLES:
*
* XCOM WILL TRY TO OVERRIDE THE CURRENT MODE ENTRY IN YOUR LU
* DEFINITION FOR THE PARTNER COMPUTER. DOING THIS INSURES THAT YOU
* DO NOT HAVE TO CREATE ADDITIONAL LU DEFINITIONS FOR EACH XCOM
* USER. THERE IS ONLY ONE LIMITATION, HOWEVER. VTAM REQUIRES THAT
Appendix B: Sample Files 377
Sample XCOMTABL Table (Member XCOMTABL)
* THE CA XCOM MODE ENTRY IS IN THE SAME MODE TABLE AS THE
* CURRENTLY DEFINED MODE ENTRY.
* THEREFORE, WE ENCOURAGE YOU TO ADD THE XCOM ENTRY OR ENTRIES TO YOUR
* EXISTING MODE TABLE(S). PLEASE DO NOT CREATE A SEPARATE TABLE FOR
* XCOM ONLY.
*
* A NOTE ABOUT PARALLEL SESSIONS AND INDEPENDENT LOGICAL UNIT:
*
* IF YOU WISH TO USE INDEPENDENT LOGICAL UNIT (ILU) OR PARALLEL SESSION
* SUPPORT, THE IBM-DEFINED MODE ENTRY "SNASVCMG" MUST BE IN THE SAME
* MODE TABLE AS THE CA XCOM MODE ENTRY.
XCOMTABL MODETAB
*
XCOMMODE MODEENT LOGMODE=XCOMMODE, LOGON MODE TABLE ENTRY NAME
X
FMPROF=X'13',
FUNCTION MANAGER PROFILE
X
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
X
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
X
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
X
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
X
RUSIZES=X'8686',
RUSIZE SEC/PRI
512/512
X
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
X
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
X
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
X
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
*
XCOM256 MODEENT LOGMODE=XCOM256, LOGON MODE TABLE ENTRY NAME
X
FMPROF=X'13',
FUNCTION MANAGER PROFILE
X
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
X
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
X
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
X
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
X
RUSIZES=X'8585',
RUSIZE SEC/PRI 256/256
X
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
X
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
X
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
X
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
*
XCOM512 MODEENT LOGMODE=XCOM512, LOGON MODE TABLE ENTRY NAME
X
FMPROF=X'13',
FUNCTION MANAGER PROFILE
X
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
X
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
X
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
X
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
X
RUSIZES=X'8686',
RUSIZE SEC/PRI 512/512
X
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
X
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
X
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
X
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
*
378 User Guide
Sample XCOMTABL Table (Member XCOMTABL)
XCOM1K
MODEENT LOGMODE=XCOM1K,
LOGON MODE TABLE ENTRY NAME
FMPROF=X'13',
FUNCTION MANAGER PROFILE
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
RUSIZES=X'8787',
RUSIZE SEC/PRI 1024/1024
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
*
XCOM1920 MODEENT LOGMODE=XCOM1920, LOGON MODE TABLE ENTRY NAME
FMPROF=X'13',
FUNCTION MANAGER PROFILE
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
RUSIZES=X'F7F7',
RUSIZE SEC/PRI 1920/1920
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
XCOM2K
*
XCOM4K
*
XCOM8K
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
MODEENT LOGMODE=XCOM2K,
LOGON MODE TABLE ENTRY NAME
FMPROF=X'13',
FUNCTION MANAGER PROFILE
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
RUSIZES=X'8888',
RUSIZE SEC/PRI 2048/2048
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
X
X
X
X
X
X
X
X
X
X
MODEENT LOGMODE=XCOM4K,
LOGON MODE TABLE ENTRY NAME
FMPROF=X'13',
FUNCTION MANAGER PROFILE
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
RUSIZES=X'8989',
RUSIZE SEC/PRI 4096/4096
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
X
X
X
X
X
X
X
X
X
X
MODEENT LOGMODE=XCOM8K,
X
LOGON MODE TABLE ENTRY NAME
Appendix B: Sample Files 379
Sample XCOMTABL Table (Member XCOMTABL)
*
XCOM16K
*
XCOM32K
FMPROF=X'13',
FUNCTION MANAGER PROFILE
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
RUSIZES=X'8A8A',
RUSIZE SEC/PRI 8192/8192
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
X
X
X
X
X
X
X
X
X
MODEENT LOGMODE=XCOM16K, LOGON MODE TABLE ENTRY NAME
FMPROF=X'13',
FUNCTION MANAGER PROFILE
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
RUSIZES=X'8B8B',
RUSIZE SEC/PRI 16K (8 X 2**11)
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
X
X
X
X
X
X
X
X
X
X
MODEENT LOGMODE=XCOM32K, LOGON MODE TABLE ENTRY NAME
FMPROF=X'13',
FUNCTION MANAGER PROFILE
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
COMPROT=X'50B1',
COMMON
LOGICAL UNIT PROTOCOL
RUSIZES=X'8C8C',
RUSIZE SEC/PRI 32K (8 X 2 ** 12)
PSNDPAC=5,
PRIMARY
SEND
PACING COUNT
SRCVPAC=5,
SECONDARY RECEIVE PACING COUNT
SSNDPAC=5,
SECONDARY SEND
PACING COUNT
PSERVIC=X'060200000000000000002C00' PRESENTATION SRVCS
X
X
X
X
X
X
X
X
X
X
*
SNASVCMG MODEENT LOGMODE=SNASVCMG, LOGON MODE TABLE ENTRY NAME
FMPROF=X'13',
FUNCTION MANAGER PROFILE
TSPROF=X'07',
TRANSMISSION SERVICES PROFILE
PRIPROT=X'B5',
PRIMARY
LOGICAL UNIT PROTOCOL
SECPROT=X'B5',
SECONDARY LOGICAL UNIT PROTOCOL
COMPROT=X'D0B1',
COMMON
LOGICAL UNIT PROTOCOL
TYPE=X'00',
RUSIZES=X'8585',
RUSIZE SEC/PRI 256
PSNDPAC=X'00',
PRIMARY
SEND
PACING COUNT
SSNDPAC=X'00',
SECONDARY SEND
PACING COUNT
SRCVPAC=X'07',
SECONDARY RECEIVE PACING COUNT
PSERVIC=X'060200000000000000000300' PRESENTATION SRVCS
*
MODEEND
380 User Guide
X
X
X
X
X
X
X
X
X
X
X
Sample XCOMTABL Table (Member XCOMTABL)
END
Appendix B: Sample Files 381
Sample XCOMDFLT Macro (Member XCOMDFLT)
Sample XCOMDFLT Macro (Member XCOMDFLT)
The following is a copy of the sample XCOMDFLT Macro
(CAI.CBXGJCL(XCOMDFLT)) found on the distribution tape. The table contains a
sample of the parameters in the Default Options Table.
*
XCO00010
*********************************************************************** XCO00020
* CA XCOM FOR MVS DEFAULT OPTIONS TABLE
XCO00030
* (1) MAKE SURE ALL CONTINUATION LINES START AT COL 16
XCO00040
* (2) REFER TO MANUAL FOR DETAILS OF PARAMETER MEANING
XCO00050
*********************************************************************** XCO00060
*
XCO00070
#DFLTAB ACBNAME=XCOMAPPL,
VTAM ACB NAME FOR XCOM SERVER
XXCO00080
ACFUSER=ASXB,
SOURCE CONTROL BLOCK FOR ACF2 USER IDXXCO00090
AGE=10,
AGE AT WHICH TO PURGE LOCAL REQUESTS XXCO00100
ALERTS=,
NETVIEW GENERIC ALERT CATEGORIES/LVLSXXCO00110
ALLOC=CYLS,
ALLOCATION UNIT FOR DATASET CREATION XXCO00120
APPLSEC=DEFAULT,
SOURCE FOR RACINIT "APPL" PARAMETER XXCO00130
BANNER=YES,
ENABLE/DISABLE BANNER PAGE FOR REPORTXXCO00140
CA7EXIT=NO,
ENABLE/DISABLE CA-7 INTERFACE
XXCO00150
CATALOG=YES,
CATALOG SUPPORT FOR DATASET CREATION XXCO00160
CKPT=1000,
CKPT COUNT DEFAULT 1000 IF OMITTED
X
CLASS=A,
SYSOUT CLASS FOR INCOMING REPORTS
XXCO00170
COMPNEG=YES,
COMPRESSION NEGOTIATION
XXCO00180
CONTIG=,
RESERVED FOR FUTURE USE
XXCO00190
CRUSSDIR=YES,
XCOM IS ALLOWED TO CREATE A USS DIR XXCO00190
DFLTVER=2,
XCOM VERSION FOR USE W/REMOTES
XXCO00200
DIR=40,
DIRECTORY ALLOC. FOR DATASET CREATIONXXCO00210
DLOGMOD=VTAM,
SOURCE OF VTAM MODE NAME
XXCO00220
DOMAIN=,
DOMAIN NAME FOR WIN NT/2000/XP PRTNR XXCO00220
DROPSESS=NO,
SESSION DISPOSITION AT TRANSFER END XXCO00230
DUMPCL=A,
DEFAULT SYSOUT CLASS FOR XCOM DUMPS XXCO00240
EDESC=0200,
WTO DESCRIPTOR CODES FOR ERROR MSGS XXCO00250
ENCRYPT=NO,
ENABLE/DISABLE ENCRYPTION SUPPORT
XXCO00260
EROUT=4020,
WTO ROUTING CODES FOR ERROR MSGS
XXCO00270
ERRINTV=7,
ERROR RETRY INTERVAL
XXCO00280
EXECUTE=YES,
ENABLE/DISABLE TYPE=EXECUTE SUPPORT XXCO00290
EXIT01=NO,
ENABLE/DISABLE EXIT 1 SUPPORT
XXCO00300
EXIT02=NO,
ENABLE/DISABLE EXIT 2 SUPPORT
XXCO00310
EXIT03=NO,
ENABLE/DISABLE EXIT 3 SUPPORT
XXCO00320
EXIT04=NO,
ENABLE/DISABLE EXIT 4 SUPPORT
XXCO00330
EXIT05=NO,
ENABLE/DISABLE EXIT 5 SUPPORT
XXCO00340
EXIT06=NO,
ENABLE/DISABLE EXIT 6 SUPPORT
XXCO00350
EXIT07=NO,
ENABLE/DISABLE EXIT 7 SUPPORT
XXCO00360
EXIT08=NO,
ENABLE/DISABLE EXIT 8 SUPPORT
XXCO00370
EXIT09=NO,
ENABLE/DISABLE EXIT 9 SUPPORT
XXCO00380
EXIT10=NO,
ENABLE/DISABLE EXIT 10 SUPPORT
XXCO00390
EXIT11=NO,
RESERVED FOR FUTURE USE
XXCO00400
382 User Guide
Sample XCOMDFLT Macro (Member XCOMDFLT)
EXIT12=NO,
ENABLE/DISABLE EXIT 12 SUPPORT
XXCO00410
EXIT13=NO,
ENABLE/DISABLE EXIT 13 SUPPORT
XXCO00420
FERL=255,
FILE ACCESS ERROR RETRY LIMIT
XXCO00430
GETSESS=NO,
ENABLE/DISABLE DYNAM. SESSION ACQUIREXXCO00440
HISTORY_OUT_DD=XCOMHOUT, TYPE=HISTORY OUTPUT DDNAME
X
HISTORY_WRITE=NO, ENABLE/DISABLE WRITE TO HISTORY_OUT X
IBM_APAR_OA23740=NO, IBM APAR REQUIRED FOR HFS SUPPORT XXCO00450
IDESC=0200,
WTO DESCRIPTOR CODES FOR INFO MSGS
XXCO00450
INQWAIT=000100,
DEFAULT TYPE=INQUIRE INQUIRY WAIT
XXCO00460
IPPORT=8044,
DEFAULT TCP/IP TARGET PORT
XXCO00470
IROUT=4020,
WTO ROUTING CODES FOR INFO MSGS
XXCO00490
JESINTV=60,
JES SPOOL SCAN INTERVAL
XXCO00500
JESOPER=,
RESERVED FOR FUTURE USE
XXCO00510
JOBACB=XCOM,
XCOMJOB ACB NAME PREFIX
XXCO00520
LDATACLS=,
SMS DATA CLASS FOR THE LOCAL SYSTEM XXCO00200
LDSNTYPE=,
SMS DATASET NAME TYPE FOR THE LOCAL XXCO00200
LCLNTFYL=A,
LOCAL NOTIFICATION LEVEL
XXCO00200
LIBNEG=YES,
ENABLE/DISABLE LIBRARY NEGOTIATION
XXCO00530
LMGMTCLS=,
SMS MGMT CLASS FOR THE LOCAL SYSTEM XXCO00200
LOG=YES,
ENABLE/DISABLE XCOM TRANSFER LOG
XXCO00540
LOGCL=X,
SYSOUT CLASS FOR XCOM TRANSFER LOG
XXCO00550
LOGDEST=,
JES DESTINATION FOR XCOM TRANSFER LOGXXCO00560
LOGMODE=XCOMMODE, DEFAULT MODE NAME (FOR DLOGMOD=XCOM) XXCO00570
LOGNREQ=NO,
REQUIRE LOGON TO USE LOGICAL UNIT
XXCO00580
LOSERS=4,
DEFAULT NUMBER OF CONTENTION LOSERS XXCO00590
LOWERCASE_PSWD=,
YES/NO SUPPORT LOWERCASE PASSWORD
XXCO00590
LSTORCLS=,
SMS STOR CLASS FOR THE LOCAL SYSTEM XXCO00200
LUSECURE=NO,
ENABLE/DISABLE LU ACCESS SECURITY
XXCO00600
LU6ABND=TERMINATE, ENABLE/DISABLE 0864 SENSE CODE RETRY XXCO00610
MAXDEL=32,
MAXIMUM NUMBER OF ACTIVE DELETE REQS XXCO00620
MAXLOC=75,
MAXIMUM NUMBER OF ACTIVE LOCAL RQSTS XXCO00630
MAXMOUNTWAIT=10,
NUMBER OF MINUTES TO WAIT FOR MOUNT XXCO00640
MAXPACK=31744,
MAXIMUM RECORD PACKING SIZE
XXCO00640
MAXREM=75,
MAXIMUM NUMBER OF ACTIVE REMOTE RQSTSXXCO00650
MAXRPTB=32760,
MAXIMUM REPORT BLOCKSIZE
XXCO00660
MAXTASK=150,
MAXIMUM NUMBER OF ACTIVATE RQSTS
XXCO00670
MSGFMT=XCOM,
FORMAT TO BE USED FOR XCOM MESSAGES XXCO00680
MSTRCATU=YES,
PERMIT/PROHIBIT MASTER CATALOG UPDATEXXCO00690
NETNAME=XCOMAPPL, NAME PASSED IN CINIT/BIND VECTORS
XXCO00700
NETMAST=NO,
NO NETMASTER INTERFACE SUPPORT
XXCO00700
NTFYTPN=XCM1,
CICS TRAN. TO START AT TRANSFER END XXCO00710
OPERLIM=5000,
MAXIMUM NUMBER OF RECORDS TO DISPLAY XXCO00720
OPERSEC=NONE,
TYPE OF SECURITY FOR OPER. FUNCTIONS XXCO00730
PRI=10,
PRIMARY ALLOC. FOR DATASET CREATION XXCO00740
PSOCKPT=1000,
CKPT COUNT DEFAULT 1000 IF OMITTED
X
PSODISP=DELETE,
PSO DATASET DISPOSITION
X
PSOPREF=XCOMPSO,
HIGH-LEVEL PREFIX FOR PSO DATASETS
XXCO00750
PSOSECUR=NO,
ENABLE/DISABLE EXIT5 FOR PSO/INDIRECTXXCO00760
PSOUNIT=SYSALLDA, UNIT NAME FOR PSO DATASETS
XXCO00770
Appendix B: Sample Files 383
Sample XCOMDFLT Macro (Member XCOMDFLT)
PSOVOL=,
PSWDCHK=YES,
RCALPROC=,
RECVRID=,
RELEASE=NO,
REMAGE=5,
REPCR=NO,
RMTNTFYL=A,
ROSPROC=ROSCOE,
ROUND=,
SEC=5,
SECURE_SOCKET=NO,
SECURITY=NONE,
SERL=255,
SERVADDR=,
SERVPORT=8044,
SERVADDRV6=,
SERVPORTV6=,
SMF=NO,
SMFNUM=192,
SNA=YES,
SSL=NONE,
SSLPORT=8045,
SSLPORTV6=,
START=XCOMSTRT,
SUP_ALLOC_INFO=NO,
SUPPLIST=NO,
SURCHK=NO,
SURCLS=,
SWAIT=30,
TCPIP=YES,
TCPIPV6=NONE,
TCPLUSEC=TCP/IP,
TCPRTIME=0,
TCPSESS=15,
TCPSOCKD=,
TCPSRCVB=64,
TCPSSNDB=64,
TCPSTACK=,
TCPTBUF=,
TCPTCHKF=,
TCPTTIME=,
TERL=32767,
TIMEOUT=600,
UMASK=022,
UNIT=SYSALLDA,
USERD=XCOMMVS,
USEROVR=YES,
USERPRO=NO,
384 User Guide
VOLUME SERIAL NUMBER FOR PSO DATASETSXXCO00780
ENABLE/DISABLE DATASET PSWD SUPPORT XXCO00790
RECALL PROC FOR ARCHIVED DATASETS
XXCO00800
RECEIVER ID FOR NETMASTER
XXCO00800
YES/NO RELEASE UNUSED DASD SPACE
XXCO00800
AGE AT WHICH TO PURGE REMOTE REQUESTSXXCO00810
CREATE NEW FILE IF NOT FOUND REPLACE XXCO00800
LOCAL NOTIFICATION LEVEL
XXCO00200
NAME OF ROSCOE PROCEDURE FOR NOTIFY XXCO00820
RESERVED FOR FUTURE USE
XXCO00830
SECONDARY ALLOC. FOR DATASET CREATIONXXCO00850
TYPE OF SECURITY TO BE USED IP XFERS XXCO00860
TYPE OF SECURITY TO BE USED
XXCO00860
SESSION ESTABLISHMENT RETRY LIMIT
XXCO00870
TCP SERVER LOCAL ADDRESS
XXCO00880
DEFAULT TCP/IP SERVER PORT
XXCO00880
TCP IPV6 SERVER LOCAL ADDRESS
X
DEFAULT TCP/IP IPV6 SERVER PORT
X
ENABLE/DISABLE SMF RECORDING
XXCO00890
SMF RECORD NUMBER TO BE USED
XXCO00900
ENABLE/DISABLE SNA TRANSFER
XXCO00900
ENABLE/DISABLE SSL TRANSFER (ONLY)
XXCO00900
SSL PORT TO USE WITH SSL TRANSFERS
XXCO00900
SSL PORT TO USE WITH IPV6 SSL TRANSF X
NAME OF XCOMCNTL STARTUP MEMBER
XXCO00910
SUPPRESS IGDNNNI MESSAGES
XXCO00920
SUPPRESS PDS MEMBER LIST MESSAGES
XXCO00920
ENABLE/DISABLE SURROGATE USER SUPPORTXXCO00920
RESOURCE CLASS FOR SURROGATE USER CHKXXCO00930
SESSION ESTABLISHMENT WAIT TIME LIMITXXCO00940
TCP/IP SUPPORT ENABLED
XXCO00950
IPV6 SUPPORT: ONLYñALLOWñNONE
X
SECURITY CALL TCP/IP ADDRESS
X
DEFAULT TCP/IP RECEIVE TIMEOUT VALUE X
MAX # OF IP SESSIONS PER PARTNER
XXCO00960
TCPIP SOCK_DELAY
XXCO01060
TCPIP SOCK_RCV_BUF_SIZE
XXCO01060
TCPIP SOCK_SEND_BUF_SIZE
XXCO01060
JOB NAME OF TCPIP STACK
XXCO01060
TCPIP TXPI_BUF_SIZE
XXCO01060
TCPIP TXPI_SEND_CHECK_FREQ
XXCO01060
TCPIP TERM TIMEOUT
XXCO01060
TOTAL ERROR RETRY LIMIT
XXCO00970
DEFAULT TYPE=EXECUTE TIMEOUT VALUE
XXCO00980
SET PERMISSIONS ON HFS FILE CREATION XXCO00990
UNIT NAME FOR DATASET CREATION
XXCO00990
DEFAULT TRANSFER USER DATA
XXCO01000
ENABLE/DISABLE USER ID OVERRIDES
XXCO01010
ENABLE/DISABLE USER ID PROPAGATION
XXCO01020
Sample XCOMADMT Table (Member XCOMADMT)
VERL=255,
VOL=,
VTAMGNAM=,
WINNERS=4,
XCOM_CONFIG_SSL=,
XCOMPLEX=
VTAM ERROR RETRY LIMIT
XXCO01030
VOLUME FOR DATASET CREATION
XXCO01040
VTAM GENERIC ACBNAME
XXCO01070
DEFAULT NUMBER OF CONTENTION WINNERS XXCO01050
NAME OF DATASET THAT HAS THE SSL CONFXXCO01080
X-SYSTEM COUPLING STRUCTURE NAME
XCO01080
Sample XCOMADMT Table (Member XCOMADMT)
The following is a copy of the sample XCOMADMT Table found on the distribution
tape (CAI.CBXGJCL(XCOMADMT)).
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
********************************************************************************
* CA XCOM FOR MVS
*
* SAMPLE SYSTEM ADMINISTRATOR TABLE
*
* FOLLOWING ACCESS PARAMETERS ARE AVAILABLE
*
* SUSP - SUSPEND TRANSFER
*
* RESM - RESUME SUSPENDED TRANSFERS
*
* HOLD - HOLD TRANSFERS
*
* REL
- RELEASES HELD TRANSFERS
*
* TERM - TERMINATE ACTIVE TRANSFERS
*
* DEL
- DELETE TRANSFER REQUESTS FROM SCHEDULED REQUESTS QUEUE
*
* ALT
- ALTER START DATE/TIME AND EXECUTION PRIORITY
*
* DACT - DISPLAY ACTIVE TRANSFERS
*
* DSCH - DISPLAY SCHEDULED TRANSFERS
*
* DHST - DISPLAY HISTORY OF TRANSFERS
*
PRINT GEN
*#ADMTAB ADMIN=XCOM03,GROUP=*,ACCESS=(ALL)
*GLOBALADMIN
#ADMTAB ADMIN=XCOM06,GROUP=*,ACCESS=(DACT,DSCH,DHST,SUSP,ALT)
#ADMTAB ADMIN=XCOM07,GROUP=XCOM,
+
ACCESS=(SUSP,RESM,HOLD,REL,TERM,DEL,ALT,DACT,DSCH,DHST)
*#ADMTAB ADMIN=XCOM10,GROUP=XCOM1*,ACCESS=(DACT,DSCH,DHST,ALL)
END XCOMADMT
Appendix B: Sample Files 385
Sample XCPF (Member XCPF)
Sample XCPF (Member XCPF)
This sample JCL shows how to define an XCOMPLEX to the IBM Coupling Facility.
This JCL is found on the distribution tape-see CAI.CBXGJCL(XCPF).
//JOBNAME JOB (ACCOUNTING),'DEFINE SYSPLEX',CLASS=A,MSGCLASS=X
//*
//******************************************************************
//* IF YOU HAVE MORE THAN ONE VOLUME SEPARATE THE PRIMARY AND
//* ALTERNATE DATASETS OR JUST RUN WITH A PRIMARY IF DESIRED
//******************************************************************
//STEP1
EXEC PGM=IXCL1DSU
//STEPLIB DD
DSN=SYS1.MIGLIB,DISP=SHR
//SYSPRINT DD
SYSOUT=*
//SYSIN
DD
*
DEFINEDS SYSPLEX(PLEX26)
DSN(your.primary.sysplex.dsn) VOLSER(xxxxxx)
MAXSYSTEM(4)
CATALOG
DATA TYPE(SYSPLEX)
ITEM NAME(GROUP) NUMBER(50)
ITEM NAME(GRS) NUMBER(1)
ITEM NAME(MEMBER) NUMBER(120)
DEFINEDS SYSPLEX(PLEX26)
DSN(your.alternat.sysplex.dsn) VOLSER(yyyyyy)
MAXSYSTEM(4)
CATALOG
DATA TYPE(SYSPLEX)
ITEM NAME(GROUP) NUMBER(50)
ITEM NAME(GRS) NUMBER(1)
ITEM NAME(MEMBER) NUMBER(120)
/*
386 User Guide
Sample POLCFRM (Member POLCFRM)
Sample POLCFRM (Member POLCFRM)
This sample JCL shows how to define an XCOMPLEX structure. This JCL is found
on the distribution tape-see CAI.CBXGJCL(POLCFRM).
//POLCFRM
JOB (00000000),'ACCOUNT',CLASS=A,MSGCLASS=X,
//
//*
//STEP20
//SYSPRINT
//SYSABEND
//SYSIN
MSGLEVEL=(1,1)
EXEC
DD
DD
DD
PGM=IXCMIAPU
SYSOUT=*
SYSOUT=*
*
DATA TYPE(CFRM) REPORT(YES)
DEFINE POLICY NAME(XE26) REPLACE(YES)
CF NAME(CFCCXCOM)
TYPE(SIMDEV)
MFG(IBM)
PLANT(EN)
SEQUENCE(0000CFCCXCOM)
PARTITION(0)
CPCID(00)
DUMPSPACE(4000)
STRUCTURE NAME(IXCLIST1
STRUCTURE NAME(ISTGENERIC
STRUCTURE NAME(ISTMNPS
STRUCTURE
STRUCTURE
STRUCTURE
STRUCTURE
) SIZE(3840) PREFLIST(CFCCXCOM)
) SIZE(3840) PREFLIST(CFCCXCOM)
) SIZE(3840) PREFLIST(CFCCXCOM)
REBUILDPERCENT(30)
NAME(XCOMPLEX
) SIZE(3840) PREFLIST(CFCCXCOM)
NAME(XCOMPLEX_QA
) SIZE(3840) PREFLIST(CFCCXCOM)
NAME(SYSZWLM_WORKUNIT) SIZE(3840) PREFLIST(CFCCXCOM)
NAME(SYSIGGCAS_ECS
) SIZE(3840) PREFLIST(CFCCXCOM)
/*
Appendix B: Sample Files 387
Sample XCOMPLEX Admin Server
Sample XCOMPLEX Admin Server
The following is a copy of the sample CA XCOM Data Transport JCL found on the
distribution tape (CAI.CBXGJCL(XCOMADM)). This JCL illustrates the definition
of the CA XCOM Data Transport XCOMPLEX Admin Server.
//XCOMADM PROC PREFIX='XCOM.RB5'
*HIGH-LEVEL DATA SET NAME QUAL
//*********************************************************************
//*
CA XCOM FOR MVS ADMIN SERVER ADDRESS SPACE
*
//*********************************************************************
//SERVER EXEC PGM=XCOMXADM,TIME=1440,REGION=5120K,
*
// PARM='ACBNAME=XCOMAPPL'
* OVERRIDE DFLT
//*
//STEPLIB DD DSN=&PREFIX..CBXGLOAD,DISP=SHR
* LOAD MODULES
//XCOMCNTL DD DSN=&PREFIX..XCOMCNTL,DISP=SHR
* CONTROL LIBR
//XCOMRRDS DD DSN=&PREFIX..RRDS,DISP=SHR
* ACTIVE REQSTS
//XCOMHIST DD DSN=&PREFIX..XCOMHIST,DISP=SHR
* DONE REQUESTS
//XCOMREQ DD DSN=&PREFIX..XCOMREQ.PATH,DISP=SHR
* ACCESS PATH
//XCOMUSER DD DSN=&PREFIX..XCOMUSER.PATH,DISP=SHR
* ACCESS PATH
//XCOMIDNT DD DSN=&PREFIX..XCOMIDNT.PATH,DISP=SHR
* ACCESS PATH
//XCOMRECP DD DSN=&PREFIX..XCOMRECP.PATH,DISP=SHR
* ACCESS PATH
//SYSPRINT DD SYSOUT=*
* TCP/IP MSGS
//*********************************************************************
//* THE FOLLOWING SYSMDUMP DD STATEMENT DEFINES A SYSTEM DUMP
*
//* DATA SET. THIS DATA SET SHOULD BE GIVEN THE SAME SPACE
*
//* ALLOCATIONS AS THE SYS1.DUMPNN DATASETS IN USE AT YOUR SITE.
*
//*********************************************************************
//SYSMDUMP DD DSN=&PREFIX..SYSMDUMP,DISP=SHR
* SYSTEM DUMP
388 User Guide
Sample Server JCL (Member XCOM)
Sample Server JCL (Member XCOM)
This member contains a sample CA XCOM Data Transport JCL found on the
distribution tape (CAI.CBXGJCL(XCOM)). This JCL illustrates the definition of the
CA XCOM Data Transport XCOMPLEX Worker or standalone server.
Note: With CA XCOM Data Transport for z/OS, it is no longer necessary to
specify Interlink libraries. Specify the correct name for TCPSTACK= as a PARM
parameter in the CA XCOM Data Transport Default Options Table.
//XCOM
PROC PREFIX='XCOM.RB5'
*HIGH-LEVEL DATA SET NAME QUAL
//*********************************************************************
//*
CA XCOM FOR MVS SERVER ADDRESS SPACE
*
//*********************************************************************
//SERVER EXEC PGM=XCOMXFER,TIME=1440,REGION=5120K,
*
// PARM='ACBNAME=XCOMAPPL'
* OVERRIDE DFLT
//*
//STEPLIB DD DSN=CAI.CBXGLOAD,DISP=SHR
* LOAD MODULES
//
DD DSN=CEE.SCEERUN,DISP=SHR
* IBM LE RUNTIME
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
* IBM TCP/IP
//XCOMCNTL DD DSN=&PREFIX..XCOMCNTL,DISP=SHR
* CONTROL LIBR
//XCOMRRDS DD DSN=&PREFIX..RRDS,DISP=SHR
* ACTIVE REQSTS
//XCOMHIST DD DSN=&PREFIX..XCOMHIST,DISP=SHR
* DONE REQUESTS
//XCOMREQ DD DSN=&PREFIX..XCOMREQ.PATH,DISP=SHR
* ACCESS PATH
//XCOMUSER DD DSN=&PREFIX..XCOMUSER.PATH,DISP=SHR
* ACCESS PATH
//XCOMIDNT DD DSN=&PREFIX..XCOMIDNT.PATH,DISP=SHR
* ACCESS PATH
//XCOMRECP DD DSN=&PREFIX..XCOMRECP.PATH,DISP=SHR
* ACCESS PATH
//SYSPRINT DD SYSOUT=*
* TCP/IP MSGS
//*SYSTERM DD SYSOUT=*
* TCP/IP MSGS
//*********************************************************************
//* THE FOLLOWING XCOMPRNT DD STATEMENT DEFINES THE SYSOUT FOR THE
*
//* IEBCOPY MESSAGES WHEN PDSE PROGRAM LIBRARIES ARE TRANSFERRED.
*
//* YOU MAY SET THIS TO DD DUMMY IF YOU DO NOT WISH TO SEE THESE
*
//* IEBCOPY MESSAGES.
*
//XCOMPRNT DD SYSOUT=*
* IEBCOPY MSGS *
//*********************************************************************
//* THE FOLLOWING SYSMDUMP DD STATEMENT DEFINES A SYSTEM DUMP
*
//* DATA SET. THIS DATA SET SHOULD BE GIVEN THE SAME SPACE
*
//* ALLOCATIONS AS THE SYS1.DUMPNN DATASETS IN USE AT YOUR SITE.
*
//*********************************************************************
//SYSMDUMP DD DSN=&PREFIX..SYSMDUMP,DISP=SHR
* SYSTEM DUMP
Appendix B: Sample Files 389
Sample XCOMLSR
Sample XCOMLSR
This sample shows the server using the parameters for the LSR feature (see CAI
CBXGJCL(XCOMLSR)):
//XCOMLSR PROC PREFIX='XCOM.RB5'
*HIGH-LEVEL DATA SET NAME QUAL
//*********************************************************************
//*
CA XCOM FOR MVS SERVER ADDRESS SPACE
*
//*
USING LSR FOR XCOMRRDS
*
//*
MINIMUM REQUIREMENTS FOR RRDS BUFND, HDUBND, AND STRNO *
//*
ARE SHOWN BELOW BUT YOU MAY INCREASE THESE VALUES IF
*
//*
YOUR REGION HAS THE STORAGE AVAILABLE.
*
//*
CHANGE RRDS BUFND AND HDUBND TO (MAXTASK+1) * 2
*
//*
CHANGE RRDS STRNO TO MAXTASK+1 WHERE MAXTASK=150
*
//*********************************************************************
//SERVER EXEC PGM=XCOMXFER,TIME=1440,REGION=80M,
*
// PARM='ACBNAME=XCOMAPPL'
* OVERRIDE DFLT
//*
//STEPLIB DD DSN=CAI.CBXGLOAD,DISP=SHR
* LOAD MODULES
//
DD DSN=CEE.SCEERUN,DISP=SHR
* IBM LE RUNTIME
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
* IBM TCP/IP
//XCOMCNTL DD DSN=&PREFIX..XCOMCNTL,DISP=SHR
* CONTROL LIBR
//DSVXRRDS DD DISP=SHR,DSN=&PREFIX..RRDS
* ACTIVE REQSTS
//XCOMRRDS DD SUBSYS=(BLSR,'DDNAME=DSVXRRDS',
* USAGE OF BLSR
//
'RMODE31=ALL',
* BUFFERS ABOVE 16M
//
'BUFND=302',
* SET BUFND=<MAXTASK+1>*2
//
'STRNO=151',
* STRNO=<MAXTASK+1>
//
'DEFERW=NO'
* NO FOR INTEGRITY
//XCOMHIST DD DSN=&PREFIX..XCOMHIST,DISP=SHR
* DONE REQUESTS
//XCOMREQ DD DSN=&PREFIX..XCOMREQ.PATH,DISP=SHR
* ACCESS PATH
//XCOMUSER DD DSN=&PREFIX..XCOMUSER.PATH,DISP=SHR
* ACCESS PATH
//XCOMIDNT DD DSN=&PREFIX..XCOMIDNT.PATH,DISP=SHR
* ACCESS PATH
//XCOMRECP DD DSN=&PREFIX..XCOMRECP.PATH,DISP=SHR
* ACCESS PATH
//SYSPRINT DD SYSOUT=*
* TCP/IP MSGS
//*********************************************************************
//* THE FOLLOWING XCOMPRNT DD STATEMENT DEFINES THE SYSOUT FOR THE
*
//* IEBCOPY MESSAGES WHEN PDSE PROGRAM LIBRARIES ARE TRANSFERRED.
*
//* YOU MAY SET THIS TO DD DUMMY IF YOU DO NOT WISH TO SEE THESE
*
//* IEBCOPY MESSAGES.
*
//XCOMPRNT DD SYSOUT=*
* IEBCOPY MSGS *
//*********************************************************************
//* THE FOLLOWING SYSMDUMP DD STATEMENT DEFINES A SYSTEM DUMP
*
//* DATA SET. THIS DATA SET SHOULD BE GIVEN THE SAME SPACE
*
//* ALLOCATIONS AS THE SYS1.DUMPNN DATASETS IN USE AT YOUR SITE.
*
//*
*
//* THE DCB CHARACTERISTICS OF THIS DATASET VARY BASED ON THE
*
//* OPERATING SYSTEM IN USE:
*
//*********************************************************************
//SYSMDUMP DD DSN=&PREFIX..SYSMDUMP,DISP=SHR
* SYSTEM DUMP
390 User Guide
Sample CICS Notification Transaction (Member XCOMSAMP)
Sample CICS Notification Transaction (Member XCOMSAMP)
The following is a copy of the sample CICS Notification Transaction found on the
distribution tape (CAI.CBXGJCL(XCOMSAMP)). This illustrates a CICS COBOL
program.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
ID DIVISION.
XCOMSAMP.
AUTHOR.
COMPUTER ASSOCIATES INTERNATIONAL
ENVIRONMENT DIVISION.
DATA DIVISION.
WORKING-STORAGE SECTION.
77
IN-MSG
PIC X(2000) VALUESPACES.
77
OUT-MSG
PIC X(40) VALUESPACES.
77
MSG-LENGTH
PIC S9(4) COMP SYNC.
PROCEDURE DIVISION.
MAINLINE-LOGIC.
*
THE BACK END TRANSACTION STARTS IN STATE 5 (RECEIVE STATE).
*
IT MUST ALWAYS DO A RECEIVE. NOTE THAT YOU DO NOT NEED
*
TO CODE 'EXEC CICS ALLOCATE', NOR EXEC CICS CONNECT
*
PROCESS SINCE THIS IS THE TARGET SIDE OF THE
*
CONVERSATION.
*
*
IT IS NOT NECESSARY TO SPECIFY THE CONVERSATION ID ON THE
*
'EXEC CICS RECEIVE' COMMAND SINCE THE LU 6.2 ISC SESSION
*
IS THE PRINCIPLE FACILITY OF THIS TRANSACTION.
*
*
WHEN THE CA XCOM STARTED TASK ALLOCATES A CONVERSATION TO THIS
*
PROGRAM, IT WILL SEND A HISTORY RECORD RIGHT AWAY THAT WILL
*
DESCRIBE THE FILE TRANSFER THAT JUST HAPPENED.
*
(THIS RECORD IS PRECEDED BY A 16-BYTE HEADER THAT CAN BE IGNORED.)
*
ONCE YOU HAVE THIS INFORMATION, YOU CAN DO WHATEVER YOUR
*
APPLICATION REQUIRES.
MOVE +2000 TO MSG-LENGTH.
EXEC CICS RECEIVE
INTO (IN-MSG)
LENGTH (MSG-LENGTH)
END-EXEC.
IF EIBCONF = HIGH-VALUES
THEN
EXEC CICS ISSUE CONFIRMATION END-EXEC.
INSERT-YOUR-OWN-LOGIC-HERE.
EXIT.
END-PROGRAM.
EXEC CICS RETURN END-EXEC.
** IT IS UNNECESSARY TO CODE AN EXEC CICS FREE SINCE
**
THIS IS THE TARGET END OF THE CONVERSATION.
**
THE EXEC CICS RETURN WILL ACCOMPLISH WHAT IS
Appendix B: Sample Files 391
Sample XCOMJOB—Execute JCL (Member XCOMJOBE)
**
NEEDED.
*- - - - - - -END OF SOURCE PROGRAM CA XCOM SAMP - - - - - - - - - *
Sample XCOMJOB—Execute JCL (Member XCOMJOBE)
This member contains a sample XCOMJOB - Execute JCL
(CAI.CBXGJCL(XCOMJOBE)) found on the distribution tape. This illustrates JCL
for a TYPE = EXECUTE transfer.
//JOBNAME JOB (ACCOUNTING),NAME,CLASS=A,MSGCLASS=X
//*
//STEP01 EXEC PGM=XCOMJOB,
// PARM=('TYPE=EXECUTE,ACBNAME=XCOM')
//*
//STEPLIB DD DSN=CAI.CBXGLOAD,DISP=SHR
*
//
DD DISP=SHR,DSN=CEE.SCEERUN
*
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
*
//XCOMGLOB DD DSN=XCOM.RB5.GLOBAL,DISP=SHR
//XCOMREST DD DSN=XCOM.RB5.RESTART,DISP=SHR
//XCOMCNTL DD DSN=XCOM.RB5.XCOMCNTL,DISP=SHR
//* XCOMPRNT DD REQUIRED IF PROGLIB=YES IS PRESENT
//*XCOMPRNT DD SYSOUT=*
*
//SYSPRINT DD SYSOUT=*
*
//*SYSTERM DD SYSOUT=*
*
//SYSIN01 DD *
*
TYPE=SEND
DROPSESS=YES
LU=........
FILEOPT=REPLACE
CKPT=0
NOTIFY=........
FILETYPE=FILE
LFILE=...................(H)
FILE=...............
*
NEWXFER
TYPE=SEND
DROPSESS=YES
LU=........
FILEOPT=REPLACE
CKPT=0
NOTIFY=........
FILETYPE=FILE
LFILE=...................(H2)
FILE=...............
/*
//
392 User Guide
LOADLIB
IBM/C RUNTIME
IBM TCP/IP
IN SYSIN01
IEBCOPY MSGS
TCP/IP MSGS
TCP/IP MSGS
Sample XCOMJOB—Schedule JCL (Member XCOMJOBS)
Sample XCOMJOB—Schedule JCL (Member XCOMJOBS)
This member contains a sample XCOMJOB - Schedule JCL
(CAI.CBXGJCL(XCOMJOBS)) found on the distribution tape. This illustrates JCL
for a TYPE = SCHEDULE transfer.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
//JOBNAME JOB (ACCOUNTING),NAME,CLASS=A,MSGCLASS=X
//*
//STEP01 EXEC PGM=XCOMJOB,
// PARM=('TYPE=SCHEDULE,ACBNAME=XCOM')
//*
//STEPLIB
DD DSN=CAI.CBXGLOAD,DISP=SHR
* LOADLIB
//
DD DSN=CEE.SCEERUN,DISP=SHR
* IBM LE RUNTIME
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
*IBM TCP/IP
//XCOMGLOB DD DSN=XCOM.RB5.GLOBAL,DISP=SHR
//XCOMREST DD DSN=XCOM.RB5.RESTART,DISP=SHR
//XCOMCNTL DD DSN=XCOM.RB5.XCOMCNTL,DISP=SHR
//SYSPRINT DD SYSOUT=*
*TCP/IP MESSAGES
//SYSIN01
DD *
*
TYPE=SEND
DROPSESS=YES
LU=. . . . . . . . . . . . . .
FILETYPE=FILE
FILEOPT=REPLACE
CKPT=0
NOTIFY=. . . . . . . . . . . .
LFILE=. . . . . . . . . . . (H)
FILE=. . . . . . . . . . . . .
*
NEWXFER
TYPE=SEND
DROPSESS=YES
LU=. . . . . . . . . . . . . .
FILETYPE=FILE
FILEOPT=REPLACE
CKPT=0
NOTIFY=. . . . . . . . . . . .
LFILE=. . . . . . . . . . . (H2)
FILE=. . . . . . . . . . . . .
/*
//
Appendix B: Sample Files 393
Sample XCOMJOB—Schedule JCL through the XCOMPLEX Admin Server (Member XCOMJOXS)
Sample XCOMJOB—Schedule JCL through the XCOMPLEX
Admin Server (Member XCOMJOXS)
This member contains a sample XCOMJOB - Schedule JCL through the
XCOMPLEX Admin Server (CAI.CBXGJCL(XCOMJOXS)) found on the distribution
tape. This illustrates JCL for a TYPE=SCHEDULE transfer through the XCOMPLEX
Admin Server.
//JOBNAME
JOB (ACCOUNTING),NAME,CLASS=A,MSGCLASS=X
//*-------------------------------------------------------------------*
//* NOTE:
*
//* THE PARM STATEMENT MAY ALTERNATIVELY BE SPECIFIED AS:
*
//* // PARM=('TYPE=SCHEDULE,DFLTAB=XCPTDFB5')
*
//* WHERE DEFAULT TABLE XCPTDFB5 HAS CORRECT XCOMPLEX ADMIN ACBNAME *
//* PARAMETERS.
*
//*-------------------------------------------------------------------*
//* THIS STEP USES XCOMJOB TYPE=SCHEDULE TO INITIATE A FILE TRANSFER *
//* VIA THE XCOMPLEX ADMIN. THE XCOMPLEX ADMIN WILL ROUTE THE
*
//* TRANSFER TO THE BEST AVAILABLE XCOMPLEX WORKER SERVER. XCOMJOB
*
//* WILL PROVIDE A RC BASED ON THE SUCCESSFUL SCHEDULING OF A
*
//* TRANSFER TO AN XCOMPLEX WORKER. XCOMJOB WILL RETURN BOTH A
*
//* GLOBAL REQUEST NUMBER FROM THE XCOMPLEX ADMIN AND A LOCAL REQUEST*
//* NUMBER FROM THE XCOMPLEX WORKER. XCPT IS THE ACBNAME OF THE
*
//* XCOMPLEX ADMIN.
*
//*-------------------------------------------------------------------*
//STEP01 EXEC PGM=XCOMJOB,
// PARM=('TYPE=SCHEDULE,ACBNAME=XCPT,DFLTAB=XCOMDFLT,STCAPPL=XCPT')
//*
//STEPLIB DD DSN=CAI.CBXGLOAD,DISP=SHR
* LOADLIB
//
DD DISP=SHR,DSN=CEE.SCEERUN
* IBM/C RUNTIME
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
* IBM TCP/IP
//XCOMCNTL DD DSN=XCOM.RB5.XCOMCNTL,DISP=SHR
//SYSPRINT DD SYSOUT=*
//SYSIN01 DD *
*
TYPE=SEND
DROPSESS=YES
LU=........
FILEOPT=REPLACE
CKPT=0
NOTIFY=........
FILETYPE=FILE
LFILE=...............
FILE=................
*
NEWXFER
TYPE=SEND
LU=........
394 User Guide
Sample XCOMJOB—Schedule JCL through the XCOMPLEX Admin Server (Member XCOMJOXS)
FILEOPT=REPLACE
CKPT=0
NOTIFY=........
FILETYPE=FILE
LFILE=...............
FILE=................
/*
//
Appendix B: Sample Files 395
Sample XCOMJOB—Inquire JCL (Member XCOMJOBI)
Sample XCOMJOB—Inquire JCL (Member XCOMJOBI)
This member contains a sample XCOMJOB - Inquire JCL found on the distribution
tape (CAI.CBXGJCL(XCOMJOBI)). This illustrates JCL for a TYPE=INQUIRE
transfer.
//XCOMWAIT JOB (XCOM,0028),name,CLASS=A,MSGCLASS=X
//*-------------------------------------------------------------------*
//* THIS STEP USES XCOMJOB TYPE=SCHEDULE TO INITIATE A FILE TRANSFER.*
//* BECAUSE THE //XCOMINQ DD CARD IS INCLUDED, XCOMJOB SAVES THE
*
//* REQUEST NUMBER ASSIGNED TO THE TRANSFER IN THE XCOMINQ FILE.
*
//*-------------------------------------------------------------------*
//STEP01 EXEC PGM=XCOMJOB,
// PARM=('TYPE=SCHEDULE,ACBNAME=XCOMM1,CONTINUE=NO,STCAPPL=XCOMAPPL')
//XCOMCNTL DD DISP=SHR,DSN=XCOM.RB5.XCOMCNTL
//XCOMINQ
DD DISP=SHR,DSN=XCOM.RB5.XCOMINQ
//SYSIN01
DD *
TYPE=SEND
LU=XCOMMJM2
FILETYPE=FILE
FILEOPT=REPLACE
LFILE=XCOM28.FILE1
FILE=XCOM28.FILE2
/*
//*-------------------------------------------------------------------*
//* THIS STEP USES XCOMJOB TYPE=SCHEDULE TO INITIATE A FILE TRANSFER.*
//* SINCE THE SAME //XCOMINQ FILE IS USED AS IN THE PREVIOUS STEP,
*
//* THE XCOMINQ FILE WILL CONTAIN BOTH REQUEST NUMBERS.
*
//*-------------------------------------------------------------------*
//STEP02 EXEC PGM=XCOMJOB,
// PARM=('TYPE=SCHEDULE,ACBNAME=XCOMM1,CONTINUE=NO,STCAPPL=XCOMAPPL')
//XCOMCNTL DD DISP=SHR,DSN=XCOM.RB5.XCOMCNTL
//XCOMINQ
DD DISP=SHR,DSN=XCOM.RB5.XCOMINQ
//SYSIN01
DD *
TYPE=SEND
LU=XCOMMJM2
FILETYPE=FILE
FILEOPT=REPLACE
LFILE=XCOM28.FILE2
FILE=XCOM28.FILE3
/*
//*
.......
MORE JOB STEPS CAN BE INSERTED HERE ....
//*-------------------------------------------------------------------*
//* THIS STEP USES XCOMJOB TYPE=INQUIRE TO DETERMINE THE STATUS OF
*
//* THE TRANSFER REQUESTS RECORDED IN THE XCOMINQ FILE.
*
//* XCOMJOB ISSUES MESSAGE XCOMM655 FOR EACH COMPLETED TRANSFER AND *
//* REMOVES THE TRANSFER NUMBER FROM THE XCOMINQ FILE.
*
//* IF ANY OF THE TRANSFERS SPECIFIED IN THE XCOMINQ FILE IS
*
//* IS ACTIVE OR SUSPENDED, XCOMJOB WAITS UNTIL IT COMPLETES OR
*
396 User Guide
Sample XCOMJOB—Inquire JCL (Member XCOMJOBI)
//* IF THE TIME INTERVAL SPECIFIED BY INQWAIT= ELAPSES BEFORE ALL
*
//* TRANSFERS HAVE COMPLETED, XCOMJOB ISSUES MESSAGE XCOMM657 FOR
*
//
EACH INCOMPLETE TRANSFER.
*
//* XCOMJOB ISSUES A RETURN WHICH MAY BE TESTED WITH COND= ON
*
//* SUBSEQUENT JOB STEPS.
*
//*-------------------------------------------------------------------*
//STEP03 EXEC PGM=XCOMJOB,
// PARM=('TYPE=INQUIRE,ACBNAME=XCOMM1,CONTINUE=NO,STCAPPL=XCOMAPPL')
//XCOMCNTL DD DISP=SHR,DSN=XCOM.RB5.XCOMCNTL
//XCOMINQ
DD DISP=SHR,DSN=XCOM.RB5.XCOMINQ
//SYSIN01
DD *
INQWAIT=000200
<== wait time
/*
Appendix B: Sample Files 397
Sample XCOMJOB—Inquire JCL through the XCOMPLEX Admin Server (Member XCOMJOXI)
Sample XCOMJOB—Inquire JCL through the XCOMPLEX
Admin Server (Member XCOMJOXI)
This member contains a sample XCOMJOB - Inquire JCL through the XCOMPLEX
Admin Server (CAI.CBXGJCL(XCOMJOXI)) found on the distribution tape. This
illustrates JCL for a TYPE=INQUIRE transfer through the XCOMPLEX Admin
Server.
/XCOMWAIT JOB (XCOM,0028),NAME,CLASS=A,MSGCLASS=X
//*-------------------------------------------------------------------*
//* NOTE:
*
//* THE PARM STATEMENT MAY ALTERNATIVELY BE SPECIFIED AS:
*
//* // PARM=('TYPE=SCHEDULE,DFLTAB=XCPTDFB5')
*
//* WHERE DEFAULT TABLE XCPTDFB5 HAS CORRECT XCOMPLEX ADMIN ACBNAME *
//* PARAMETERS.
*
//*-------------------------------------------------------------------*
//* THIS STEP USES XCOMJOB TYPE=SCHEDULE TO INITIATE A FILE TRANSFER.*
//* BECAUSE THE //XCOMINQ DD CARD IS INCLUDED, XCOMJOB SAVES THE
*
//* REQUEST NUMBER ASSIGNED TO THE TRANSFER IN THE XCOMINQ FILE.
*
//* THE REQUEST WILL BE ROUTED FROM THE XCOMPLEX ADMIN TO AN XCOMPLEX*
//* WORKER SERVER. XCPT IS THE ACBNAME OF THE XCOMPLEX ADMIN.
*
//*-------------------------------------------------------------------*
//STEP01 EXEC PGM=XCOMJOB,
// PARM=('TYPE=SCHEDULE,ACBNAME=XCPT,DFLTAB=XCOMDFLT,STCAPPL=XCPT')
//STEPLIB
DD DSN=CAI.CBXGLOAD,DISP=SHR
* LOADLIB
//
DD DISP=SHR,DSN=CEE.SCEERUN
* IBM/C RUNTIME
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
* IBM TCP/IP
//XCOMINQ
DD DISP=SHR,DSN=XCOM.RB5.XCOMINQ
//XCOMCNTL DD DISP=SHR,DSN=XCOM.RB5.XCOMCNTL
//SYSPRINT DD SYSOUT=*
* TCP/IP MSGS
//*SYSTERM DD SYSOUT=*
* TCP/IP MSGS
//SYSIN01
DD *
*
TYPE=SEND
LU=.....
FILETYPE=FILE
FILEOPT=REPLACE
LFILE=............
FILE=.............
/*
//*-------------------------------------------------------------------*
//* THIS STEP USES XCOMJOB TYPE=SCHEDULE TO INITIATE A FILE TRANSFER.*
//* SINCE THE SAME //XCOMINQ FILE IS USED AS IN THE PREVIOUS STEP,
*
//* THE XCOMINQ FILE WILL CONTAIN BOTH REQUEST NUMBERS. THE XCOMINQ *
//* FILE CAN CONTAIN MULTIPLE REQUESTS, HOWEVER ALL REQUESTS MUST
*
//* BE SCHEDULED VIA THE SAME XCOMPLEX ADMIN.
*
//*-------------------------------------------------------------------*
//STEP02 EXEC PGM=XCOMJOB,
398 User Guide
Sample XCOMJOB—Inquire JCL through the XCOMPLEX Admin Server (Member XCOMJOXI)
// PARM=('TYPE=SCHEDULE,ACBNAME=XCPT,DFLTAB=XCOMDFLT,STCAPPL=XCPT')
//STEPLIB
DD DSN=CAI.CBXGLOAD,DISP=SHR
* LOADLIB
//
DD DISP=SHR,DSN=CEE.SCEERUN
* IBM/C RUNTIME
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
* IBM TCP/IP
//XCOMINQ
DD DISP=SHR,DSN=XCOM.RB5.XCOMINQ
//XCOMCNTL DD DISP=SHR,DSN=XCOM.RB5.XCOMCNTL
//SYSPRINT DD SYSOUT=*
* TCP/IP MSGS
//*SYSTERM DD SYSOUT=*
* TCP/IP MSGS
//SYSIN01
DD *
TYPE=SEND
LU=........
FILETYPE=FILE
FILEOPT=REPLACE
LFILE=............
FILE=............
/*
//*
.......
MORE JOB STEPS CAN BE INSERTED HERE ....
//*-------------------------------------------------------------------*
//* THIS STEP USES XCOMJOB TYPE=INQUIRE TO DETERMINE THE STATUS OF
*
//* THE TRANSFER REQUESTS RECORDED IN THE XCOMINQ FILE.
*
//* XCOMJOB ISSUES MESSAGE XCOMM655 FOR EACH COMPLETED TRANSFER AND *
//* REMOVES THE TRANSFER NUMBER FROM THE XCOMINQ FILE.
*
//* IF ANY OF THE TRANSFERS SPECIFIED IN THE XCOMINQ FILE IS
*
//* ACTIVE OR SUSPENDED, XCOMJOB WAITS UNTIL IT COMPLETES OR
*
//* IF THE TIME INTERVAL SPECIFIED BY INQWAIT= ELAPSES BEFORE ALL
*
//* TRANSFERS HAVE COMPLETED, XCOMJOB ISSUES MESSAGE XCOMM657 FOR
*
//* EACH INCOMPLETE TRANSFER.
*
//* XCOMJOB ISSUES A RETURN CODE WHICH MAY BE TESTED WITH COND=
*
//* ON SUBSEQUENT JOB STEPS.
*
//*-------------------------------------------------------------------*
//STEP03 EXEC PGM=XCOMJOB,
// PARM=('TYPE=INQUIRE,ACBNAME=XCPT,DFLTAB=XCOMDFLT,STCAPPL=XCPT')
//STEPLIB
DD DSN=CAI.CAILIB,DISP=SHR
* LOADLIB
//
DD DISP=SHR,DSN=CEE.SCEERUN
* IBM/C RUNTIME
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
* IBM TCP/IP
//XCOMINQ
DD DISP=SHR,DSN=XCOM.RB5.XCOMINQ
//XCOMCNTL DD DISP=SHR,DSN=XCOM.RB5.XCOMCNTL
//SYSPRINT DD SYSOUT=*
* TCP/IP MSGS
//*SYSTERM DD SYSOUT=*
* TCP/IP MSGS
//SYSIN01
DD *
INQWAIT=000200
<== wait time
/*
Appendix B: Sample Files 399
Sample XCOMJOB TYPE=HISTORY JCL (Member XCOMJOBH)
Sample XCOMJOB TYPE=HISTORY JCL (Member XCOMJOBH)
This member contains a sample XCOMJOB - TYPE=HISTORY JCL found on the
distribution tape (CAI.CBXGJCL(XCOMJOBH)). This illustrates JCL for a
TYPE=HISTORY transfer.
//JOBNAME
JOB (ACCOUNTING),NAME,CLASS=A,MSGCLASS=X
//*
//*********************************************************************
//* This sample JCL shows an XCOMJOB TYPE=HISTORY call to get history *
//* information and save it to the HISTDD. The HISTDD is then passed *
//* to a sample CA Easytrieve report that generates a report similar *
//* to the CA XCOM ISPF operator display.
*
//*********************************************************************
//*
//* Change CAI to the high level qualifier used for the installation
//* of CA XCOM Data Transport
//*
//STEP01 EXEC PGM=XCOMJOB,
// PARM=('DFLTAB=XCPTD115,TYPE=HISTORY,STCIP=ip.address,',
// 'STCPORT=nnnnn,HISTDD=XCOMHOUT')
//*
//* DFLTAB= specifies the assembled and linked XCOM
//*
defaults table.
//*
//* STCIP=
specifies either the TCP/IP address of the
//*
server to handle HISTORY requests, or the
//*
NAME of the server.
//*
//* STCPORT= specifies the PORT on which the server is
//*
listening
//*
//* HISTDD= specifies the DDNAME of the dataset to
//*
contain the selected HISTORY records
//*
//*
Note: If not specified then XCOM uses
//*
XCOMHOUT as specified in the defaults table
//*
//STEPLIB DD DSN=CAI.CBXGLOAD,DISP=SHR
* LOADLIB
//
DD DISP=SHR,DSN=CEE.SCEERUN
* IBM/C RUNTIME
//*SYSTCPD DD DSN=TCPIP.TCPIP.DATA,DISP=SHR
* IBM TCP/IP
//XCOMHOUT DD DISP=(,CATLG,DELETE),DSN=XCOM.HISTORY.RECORDS,
//
DCB=(LRECL=2020,BLKSIZE=0,RECFM=FB,DSORG=PS),
//
UNIT=SYSDA,SPACE=(TRK,(10,5),RLSE)
//SYSIN01 DD *
OTYPE=ALL
*OID=
*OREQ=
*OLU=
400 User Guide
Sample XCOMJOB TYPE=HISTORY JCL (Member XCOMJOBH)
*OTNAME=
*OLIMIT=
*OLMSG=
*OUSER=
*OSDATE=
*OSTIME=
*OEDATE=
*OETIME=
*OFLMIN=
*OFLMAX=
*OINIT=
*OTYPEREQ=
*OFILETYPE=
*OSYSNAME=
*OSYSID=
//*
//STEP02
EXEC
//STEPLIB DD
//PANDD
DD
//EZTVFM
DD
//SORTWK01 DD
//XCOMHOUT DD
//SYSPRINT DD
//SYSOUT
DD
//SYSSNAP DD
//SYSIN
DD
//*
//STEP03
EXEC
//STEPLIB DD
//PANDD
DD
//EZTVFM
DD
//SORTWK01 DD
//XCOMHOUT DD
//SYSPRINT DD
//SYSOUT
DD
//SYSSNAP DD
//SYSIN
DD
PGM=EZTPA00,REGION=512K
DSN=EZT.CAILIB,DISP-SHR
* CA Easytrieve LOADLIB
DSN=EZT.CAIMAC,DISP=SHR
* CA Easytrieve MACLIB
UNIT=SYSDA,SPACE=(4096,(100,10))
UNIT=SYSDA,SPACE=(CYL,1)
DSN=XCOM.HISTORY.RECORDS,DISP=SHR
SYSOUT=*
SYSOUT=*
SYSOUT=*
DSN=CAI.CBXGSAMP(XCOMEHRP),DISP=SHR
PGM=EZTPA00,REGION=512K
DSN=EZT.CAILIB,DISP-SHR
* CA Easytrieve LOADLIB
DSN=EZT.CAIMAC,DISP=SHR
* CA Easytrieve MACLIB
UNIT=SYSDA,SPACE=(4096,(100,10))
UNIT=SYSDA,SPACE=(CYL,1)
DSN=XCOM.HISTORY.RECORDS,DISP=SHR
SYSOUT=*
SYSOUT=*
SYSOUT=*
DSN=CAI.CBXGSAMP(XCOMESTT),DISP=SHR
Appendix B: Sample Files 401
Sample JCL for Reassembling and Link Editing XCOMRACF (Member ASMRACFU)
Sample JCL for Reassembling and Link Editing XCOMRACF
(Member ASMRACFU)
This member contains sample JCL for reassembling and link editing the
XCOMRACF user security exit found on the distribution tape - see
CAI.CBXGJCL(ASMRACFU). Assembling the XCOMRACF interface is optional.
//JOBNAME
JOB (ACCOUNTING),'XCOM INSTALLATION',
//
CLASS=X,MSGCLASS=X,MSGLEVEL=(1,1)
//*
//********************************************************************
//*
THIS JCL ASSEMBLES THE XCOMRACF USER SECURITY EXIT FOR UID
*
//*
*
//*
(1) ALTER JOBCARD TO CONFORM TO INSTALLATION STANDARDS
*
//*
(2) ENSURE UID IS CODED ON SYSPARM ASSEMBLER PARM
*
//*
(3) CHANGE SYSLIB TO POINT TO XCOM MACLIB
*
//*
(4) CHANGE SYSIN TO POINT TO XCOM CBXGSAMP
*
//*
(5) CHANGE SYSLMOD TO POINT TO XCOM LOAD LIBRARY
*
//*
*
//*------------------------------------------------------------------*
//*
CHANGE HISTORY
*
//* ID
DATE
DESCRIPTION
*
//* ---------------------------------------------------------------- *
//* N/A 06/21/02
CREATION
*
//********************************************************************
//*
//ASM
EXEC PGM=ASMA90,
//
PARM='SYSPARM(UID),OBJECT,NODECK,XREF(SHORT),NORENT'
//SYSLIB
DD DSN=XCOM.RVRMP.MACLIB,DISP=SHR
//
DD DSN=SYS1.MACLIB,DISP=SHR
//
DD DSN=SYS1.AMODGEN,DISP=SHR
//
DD DSN=SYS1.MODGEN,DISP=SHR
//SYSUT1
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSUT2
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSUT3
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSPRINT DD SYSOUT=*
//SYSIN
DD DSN=XCOM.RVRMP.CBXGSAMP(XCOMRACF),
//
DISP=SHR
//SYSPUNCH DD DUMMY,SYSOUT=B
//SYSLIN
DD DSN=&&OBJSET,DISP=(NEW,PASS),
//
UNIT=SYSALLDA,SPACE=(80,(2000,500))
//*
//LKED
EXEC PGM=IEWL,COND=(4,LT,ASM),
// PARM='XREF,LET,LIST,NCAL,AC=1,NORENT,NOREUS,NOTEST,NOREFR'
//SYSPRINT DD SYSOUT=*
//SYSUT1
DD UNIT=SYSALLDA,SPACE=(1024,(500,20))
//SYSLMOD DD DSN=XCOM.RVRMP.LOAD,DISP=SHR
//SYSLIN
DD DSN=&&OBJSET,DISP=(OLD,DELETE)
402 User Guide
Sample JCL for Reassembling and Link Editing XCOMRACF (Member ASMRACFU)
//
DD
*
ENTRY XCOMRACF
NAME XCOMRACF(R)
/*
Appendix B: Sample Files 403
Sample JCL for Reassembling and Link Editing XCOMTOPS (Member ASMTOPSU)
Sample JCL for Reassembling and Link Editing XCOMTOPS
(Member ASMTOPSU)
This member contains sample JCL for reassembling and link editing the
XCOMTOPS user security exit found on the distribution tape - see
CAI.CBXGJCL(ASMTOPSU). Assembling the XCOMTOPS interface is optional.
//JOBNAME
JOB (ACCOUNTING),'XCOM INSTALLATION',
//
CLASS=X,MSGCLASS=X,MSGLEVEL=(1,1)
//*
//********************************************************************
//*
THIS JCL ASSEMBLES THE XCOMTOPS USER SECURITY EXIT FOR UID
*
//*
*
//*
(1) ALTER JOBCARD TO CONFORM TO INSTALLATION STANDARDS
*
//*
(2) ENSURE UID IS CODED ON SYSPARM ASSEMBLER PARM
*
//*
(3) CHANGE SYSLIB TO POINT TO XCOM MACLIB
*
//*
(4) CHANGE SYSIN TO POINT TO XCOM CBXGSAMP
*
//*
(5) CHANGE SYSLMOD TO POINT TO XCOM LOAD LIBRARY
*
//*
*
//*------------------------------------------------------------------*
//*
CHANGE HISTORY
*
//* ID
DATE
DESCRIPTION
*
//* ---------------------------------------------------------------- *
//* N/A 06/21/02
CREATION
*
//********************************************************************
//*
//ASMTOPS EXEC PGM=ASMA90,
//
PARM='SYSPARM(UID),OBJECT,NODECK,XREF(SHORT),NORENT'
//SYSLIB
DD DSN=XCOM.RVRMP.MACLIB,DISP=SHR
//
DD DSN=SYS1.MACLIB,DISP=SHR
//
DD DSN=SYS1.AMODGEN,DISP=SHR
//
DD DSN=SYS1.MODGEN,DISP=SHR
//SYSUT1
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSUT2
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSUT3
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSPRINT DD SYSOUT=*
//SYSIN
DD DSN=XCOM.RVRMP.CBXGSAMP(XCOMTOPS),
//
DISP=SHR
//SYSPUNCH DD DUMMY,SYSOUT=B
//SYSLIN
DD DSN=&&OBJSET,DISP=(NEW,PASS),
//
UNIT=SYSALLDA,SPACE=(80,(2000,500))
//*
//LKEDTOPS EXEC PGM=IEWL,COND=(4,LT,ASMTOPS),
// PARM='XREF,LET,LIST,NCAL,AC=1,NORENT,NOREUS,NOTEST,NOREFR'
//SYSPRINT DD SYSOUT=*
//SYSUT1
DD UNIT=SYSALLDA,SPACE=(1024,(500,20))
//SYSLMOD DD DSN=XCOM.RVRMP.LOAD,DISP=SHR
//SYSLIN
DD DSN=&&OBJSET,DISP=(OLD,DELETE)
404 User Guide
Sample JCL for Reassembling and Link Editing XCOMTOPS (Member ASMTOPSU)
//
DD
*
ENTRY XCOMTOPS
NAME XCOMTOPS(R)
/*
//*
//ASMTOP2 EXEC PGM=ASMA90,
//
PARM='SYSPARM(UID),OBJECT,NODECK,XREF(SHORT),NORENT'
//SYSLIB
DD DSN=XCOM.RVRMP.MACLIB,DISP=SHR
//
DD DSN=SYS1.MACLIB,DISP=SHR
//
DD DSN=SYS1.AMODGEN,DISP=SHR
//
DD DSN=SYS1.MODGEN,DISP=SHR
//SYSUT1
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSUT2
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSUT3
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSPRINT DD SYSOUT=*
//SYSIN
DD DSN=XCOM.RVRMP.CBXGSAMP(XCOMTOP2),
//
DISP=SHR
//SYSPUNCH DD DUMMY,SYSOUT=B
//SYSLIN
DD DSN=&&OBJSET,DISP=(NEW,PASS),
//
UNIT=SYSALLDA,SPACE=(80,(2000,500))
//*
//LKEDTOP2 EXEC PGM=IEWL,COND=(4,LT,ASMTOP2),
// PARM='XREF,LET,LIST,NCAL,AC=1,NORENT,NOREUS,NOTEST,NOREFR'
//SYSPRINT DD SYSOUT=*
//SYSUT1
DD UNIT=SYSALLDA,SPACE=(1024,(500,20))
//SYSLMOD DD DSN=XCOM.RVRMP.LOAD,DISP=SHR
//SYSLIN
DD DSN=&&OBJSET,DISP=(OLD,DELETE)
//
DD
*
ENTRY XCOMTOP2
NAME XCOMTOP2(R)
/*
Appendix B: Sample Files 405
Sample JCL for Reassembling and Link Editing XCOMACF2 (Member ASMACF2U)
Sample JCL for Reassembling and Link Editing XCOMACF2
(Member ASMACF2U)
This member contains sample JCL for reassembling and link editing the
XCOMACF2 user security exit found on the distribution tape-see
CAI.CBXGJCL(ASMACF2U). Assembly is required.
//JOBNAME JOB (ACCOUNTING),'CA XCOM INSTALLATION'
//*-------------------------------------------------------------------*
//* THIS JCL ASSEMBLES THE XCOMACF2 USER SECURITY EXIT FOR UID*
//*
(1) ALTER JOBCARD TO CONFORM TO INSTALLATION STANDARDS*
//*
(2) ENSURE UID IS CODED ON SYSPARM ASSEMBLER PARM*
//*
(3) CHANGE SYSLIB TO POINT TO XCOM CBXGMAC*
//*
(4) CHANGE SYSLIB TO POINT TO ACF2 MACRO LIBRARY*
//*
(5) CHANGE SYSIN TO POINT TO XCOM CBXGSAMP*
//*
(6) CHANGE SYSLMOD TO POINT TO XCOM LOAD LIBRARY*
//*
(7) CHANGE ACF2LIB TO POINT TO YOUR ACF2 LIBRARY*
//*-------------------------------------------------------------------*
//ASM
EXEC PGM=ASMA90,
//
PARM='SYSPARM(UID),OBJECT,NODECK,XREF(SHORT),NORENT'
//SYSLIB
DD DSN=CAI.CBXGMAC,DISP=SHR
//
DD DSN=YOUR.ACF2.MACLIB,DISP=SHR
//
DD DSN=SYS1.MACLIB,DISP=SHR
//
DD DSN=SYS1.AMODGEN,DISP=SHR
DD DSN=SYS1.MODGEN,DISP=SHR
//SYSUT1
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSUT2
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSUT3
DD UNIT=SYSALLDA,SPACE=(1700,(6000,100))
//SYSPRINT DD SYSOUT=*
//SYSIN
DD DSN=CAI.CBXGSAMPCL(XCOMACF2),DISP=SHR
//SYSPUNCH DUMMY,SYSOUT=B
//SYSLIN
DD DSN=&&OBJSET,DISP=(NEW,PASS),
//
UNIT=SYSALLDA,SPACE=(80, (2000,500))
//*
//LKED
EXEC PGM=IEWL,COND=(4,LE,ASM),
//ACF2LIB
DD DSN=YOUR.ACF2.LOAD.LIBRARY,DISP=SHR
// PARM='XREF,LET,LIST,NCAL,AC=1,NORENT,NOREUS,NOTEST,NOREFR'
//SYSPRINT DD SYSOUT=*
//SYSUT1
DD UNIT=SYSALLDA,SPACE=(1024,(500,20))
//SYSLMOD
DD DSN=CAI.CBXGLOAD,DISP=SHR
//SYSLIN
DD DSN=&&OBJSET,DISP=(OLD,DELETE),
//
DD
INCLUDE ACF2LIB($ACFGCVT)
ENTRY XCOMACF2
NAME XCOMACF2(R)
/*
//
406 User Guide
Sample DEFDFLT
Sample DEFDFLT
This member contains JCL to define and populate the CA XCOM Data Transport
CICS/MVS Default File (XCOMDFLT).
//JOBNAME JOB (ACCOUNTING),'XCOM DFLT DEFINE',
//
CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),NOTIFY=TSOID
//XCOMCICI EXEC PGM=XCICCICI
//STEPLIB
DD DSN=XCOM.CICS.RVRMP.LOAD,DISP=SHR
//XCOMOUT
DD DSN=&&TEMP,DISP=(NEW,PASS),SPACE=(TRK,(1)),UNIT=SYSDA
//XCOMIN
DD *
SERVER-APPLID=XCOMAPPL
OPER-TRAN=XCOM
//IDCAMS
EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//DD1
DD DSN=&&TEMP,DISP=(OLD,DELETE)
//SYSIN
DD *
/* 4. DELETE AND REDEFINE THE XCOMCICS DEFAULT FILE
/*
DEFINE CL ( NAME(XCOM.XCOMDFLT.VS) IXD REC( 1000 ) RECSZ( 80 1500 ) VOLUME(??????) FREESPACE( 0 0 ) KEYS( 8 0 ) SHR( 2 ))DATA ( NAME(XCOM.XCOMDFLT.VS.DATA) UNIQUE ) INDEX ( NAME(XCOM.XCOMDFLT.VS.INDEX) UNIQUE )
REPRO IFILE(DD1) ODS(XCOM.XCOMDFLT.VS) REPLACE
//
*/
*/
Appendix B: Sample Files 407
Sample XCOMENCR—JCL to Encrypt the SYSIN01 PASSWORD/LPASS Parameters (Member XCOMENCR)
Sample XCOMENCR—JCL to Encrypt the SYSIN01
PASSWORD/LPASS Parameters (Member XCOMENCR)
This member contains a sample XCOMENCR - JCL to encrypt the SYSIN01
PASSWORD/LPASS parameters found on the distribution tape
(CAI.CBXGJCL(XCOMENCR)). This illustrates the use of the XCOMENCR utility
where SYSIN01 defines the input data stream and SYSOUT01 defines the output
data stream with the encrypted password.
//JOBNAME JOB (ACCOUNTING),'ENCRYPT PASSWORD',CLASS=A,MSGCLASS=X
//********************************************************************
//*
*
//*
SYSIN01 = Input CA XCOM SYSIN01 file transfer parameters
*
//*
(Can be "DD *", PDS member, or sequential file)
*
//*
*
//*
SYSOUT01 = Output SYSIN01 parameters with encrypted values
*
//*
for LPASS and PASSWORD parameters.
*
//*
(Can be SYSOUT, PDS member, or sequential file)
*
//*
*
//********************************************************************
//XCOMENCR EXEC PGM=XCOMENCR
//STEPLIB DD
DSN=CAI.CBXGLOAD,DISP=SHR
//*
//SYSIN01 DD
DSN=XCOM.RB5.SYSIN01.DATA(XFERPARM),DISP=SHR
//SYSOUT01 DD
DSN=XCOM.RB5.SYSIN01.DATA(ENCRYPTD),DISP=SHR
//
408 User Guide
Sample COPYCSD
Sample COPYCSD
This member contains the JCL that you can use during the installation process to
copy the PCT, PPT, and TCT entries from the CA XCOM Data Transport CSD file to
the user CSD file. Alternatively, you can assemble the tables from the supplied
PCT, PPT, and TCT tables.
//JOBNAME
JOB (ACCOUNTING),'COPY XCOMCSD',
//
CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),NOTIFY=TSOID
//********************************************************************
//* CREATE XCOM TEMPORARY CSD FILE
//********************************************************************
//DEFCSD
EXEC PGM=IDCAMS
//INSTCSD DD DSN=XCOM.CICS.RVRMP.XCOMCSD,DISP=SHR
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
/* DEFINE THE CSD (CICS SYSTEM DEFINITION)
*/
/*
*/
DEFINE CL ( NAME(XCOM.TEMP.DFHCSD) IXD REC( 4000 ) RECSZ( 100 500 ) FREESPACE( 0 0 ) SHR( 2 ) VOLUMES( ?????? ) ) DATA ( NAME(XCOM.TEMP.DFHCSD.DATA) UNIQUE KEYS( 22 0 ) ) INDEX ( NAME(XCOM.TEMP.DFHCSD.INDEX) UNIQUE )
REPRO IFILE(INSTCSD) ODS(XCOM.TEMP.DFHCSD)REPLACE
//********************************************************************
//* COPY XCOM CSD ENTRIES TO YOUR CSD FILE
//********************************************************************
//COPYCSD EXEC PGM=DFHCSDUP,COND=(8,LT,DEFCSD)
//STEPLIB DD
DSN=YOUR.CICS.LOADLIB,DISP=SHR
===> UPDATE
//DFHCSD
DD
DSN=YOUR.CICS.CSD.FILE,DISP=SHR
===> UPDATE
//XCOMCSD DD DSN=XCOM.CICS.TEMP.DFHCSD,DISP=SHR
===> UPDATE
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
*
*----------------------------------------*
*
* COPY XCOM CSD GROUP TO YOUR CSD FILE
*
*
*----------------------------------------*
COPY GROUP(XCOMGRP) TO(XCOMGRP) REPLACE FROMCSD(XCOMCSD)
*
*----------------------------------------*
*
* ADD XCOMCSD GROUP TO YOUR STARTUP LIST *
*
* THIS CAN BE DONE THROUGH JCL OR THROUGH*
*
* THE ONLINE CEDA TRANSACTION
*
Appendix B: Sample Files 409
Sample COPYCSD
*
*----------------------------------------*
ADD GROUP(XCOMCSD) LIST(????????)
//********************************************************************
//* DELETE XCOM TEMPORARY CSD FILE
//********************************************************************
//DELCSD
EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
/* DELETE TEMPORARY CSD
*/
DELETE XCOM.TEMP.DFHCSD PURGE CLUSTER
//
410 User Guide
Sample XCOMFCT
Sample XCOMFCT
This member contains the CICS FCT entries for the XCOMDFT and XCOMHLP
files. You must copy the entries into the CICS FCT and assemble the FCT before
CA XCOM Data Transport can use these files.
*********************************************************************
*
*
*
XCOM CICS FCT ENTRIES:
*
*
XCOMHLP - CONTAINS DATA FOR HELP SCREENS
*
*
XCOMDFT - CONTAINS DEFAULT DATA FOR XCOM CICS USERS
*
*
*
*********************************************************************
*
DFHFCT TYPE=DATASET
X
ACCMETH=VSAM,
X
BUFND=3,
X
BUFNI=3,
X
FILSTAT=(ENABLED,OPENED),
X
LSRPOOL=NONE,
======> UPDATE IF NECESSARY
X
RECFORM=(VARIABLE,BLOCKED),
X
SERVREQ=(READ,BROWSE),
X
STRNO=2
**
DSN=XCOM.XCOMHELP.VS,
======> OPTIONAL PARAMETER
**
DISP=SHR,
======> OPTIONAL PARAMETER
*
DFHFCT TYPE=DATASET
X
DATASET=XCOMDFT,
X
ACCMETH=VSAM,
X
BUFND=3,
X
BUFNI=3,
X
FILSTAT=(ENABLED,OPENED),
X
LSRPOOL=NONE,
======> UPDATE IF NECESSARY X
RECFORM=(VARIABLE,BLOCKED),
X
SERVREQ=(READ,ADD,UPDATE,BROWSE,DELETE),
X
STRNO=2
**
DSN=XCOM.XCOMDFLT.VS,
======> OPTIONAL PARAMETER
**
DISP=SHR,
======> OPTIONAL PARAMETER
*
Appendix B: Sample Files 411
Sample XCOMPCT
Sample XCOMPCT
This member contains the CICS PCT entries to run the CA XCOM Data Transport
CICS/MVS interface. If you create the PCT entries through the COPYCSD step
(which copies directly from the CA XCOM Data Transport-provided CSD to the
user CSD), this member is not required. If you do not use the COPYCSD step,
you must copy these entries into the CICS PCT and assemble the PCT before CA
XCOM Data Transport can be used.
******************************************************************
*
*
*
XCOM CICS PCT ENTRIES:
*
*
XCOM
- TRANSID FOR ALL XCOM FUNCTIONS
*
*
XCON
- OPTIONAL TRANSID FOR ALL XCOM FUNCTIONS
*
*
XNTF
- TRANSID TO HANDLE ALL CICS NOTIFIES
*
*
*
******************************************************************
*
DFHPCT TYPE=ENTRY,
X
TRANSID=XCOM,
X
PROGRAM=XCICPRIM,
X
DTIMOUT=30,
X
SPURGE=YES,
X
TPURGE=YES,
X
TRANSEC=01,
X
TRMPRTY=100,
X
TWASIZE=0
*
DFHPCT TYPE=ENTRY,
X
TRANSID=XCON,
X
PROGRAM=XCICPRIM,
X
DTIMOUT=30,
X
SPURGE=YES,
X
TPURGE=YES,
X
TRANSEC=01,
X
TRMPRTY=100,
X
TWASIZE=0
*
DFHPCT TYPE=ENTRY,
X
TRANSID=XNTF,
X
PROGRAM=XCICNTFY,
X
DTIMOUT=30,
X
SPURGE=YES,
X
TPURGE=YES,
X
TRANSEC=01,
X
TRMPRTY=100,
X
TWASIZE=0
*
412 User Guide
Sample XCOMPPT
Sample XCOMPPT
This member contains the CICS PPT entries to run the CA XCOM Data Transport
CICS/MVS interface. If you create the PPT entries through the COPYCSD step
(which copies directly from the CA XCOM Data Transport-provided CSD to the
user CSD), this member is not required. If you do not use the COPYCSD step,
you must copy these entries into the CICS PPT and assemble the PPT before CA
XCOM Data Transport can be used.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
******************************************************************
*
*
*
XCOM CICS PPT ENTRIES:
*
*
*
******************************************************************
*
*
XCOM CICS MAPS
*
DFHPPT TYPE=ENTRY,PROGRAM=XCMPRIM,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMSEND,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMRFIL,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMSFIL,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMSRPT,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMSJOB,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMMPRM,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMADSN,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMEDSN,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMOPER,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMODIS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMOSDS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCMHELP,PGMLANG=ASSEMBLER
*
*
XCOM CICS PROGRAMS
*
DFHPPT TYPE=ENTRY,PROGRAM=XCICPRIM,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICSEND,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICRFIL,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICSFIL,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICSRPT,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICSJOB,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICMPRM,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICADSN,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICEDSN,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICOPER,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICODIS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICOSDS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICHELP,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICSCHL,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICCAPI,PGMLANG=ASSEMBLER
Appendix B: Sample Files 413
Sample XCOMTCT
DFHPPT TYPE=ENTRY,PROGRAM=XCICNTFY,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=XCICCHLP,PGMLANG=ASSEMBLER
Sample XCOMTCT
This member contains the CICS TCT entries to run the CA XCOM Data Transport
CICS/MVS interface. If you create the TCT entries through the COPYCSD step
(which copies directly from the CA XCOM Data Transport-provided CSD to the
user CSD), this member is not required. If you do not use the COPYCSD step,
you must copy these entries into the CICS TCT and assemble the TCT before CA
XCOM Data Transport can be used.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
*******************************************************************
*
*
*
XCOM CICS TCT ENTRIES:
*
*
*
*
A TCT ENTRY CAN BE BUILD FOR EACH XCOM ADDRESS SPACE
*
* THAT CICS COMMUNICATES WITH
*
*
*
*******************************************************************
DFHTCT TYPE=SYSTEM,
ACCMETH=VTAM,
NETNAME=XCOMAPPL,
===> POINTS TO VTAM APPLID FOR XCOM
MODENAM=XCOMMODE,
===> POINTS TO MODENAME FOR XCOM
SYSIDNT=XCM1,
===> USE ANY VALID NAME HERE
FEATURE=SINGLE,
BUFFER=1024,
RUSIZE=1024,
TRMSTAT=TRANSCEIVE
414 User Guide
X
X
X
X
X
X
X
X
Appendix C: User Exits
CA XCOM Data Transport user exits allow users to modify characteristics and
capabilities of CA XCOM Data Transport software by inserting their own routines
at various positions, known as exit points, in the source code. This appendix
provides information about all currently available user exits. The information
provided about each user exit includes:
■
Purpose
■
Module name and entry point
■
Method of enabling the user exit
■
Name of the CA XCOM Data Transport module from which the user-supplied
module is called
■
Method of entry (implying the relationship between the two modules)
■
Name of the required DSECT
■
Addressing mode at entry
■
Information about entry registers
■
Information about exit registers
■
Return codes
■
Location of a sample program
Important! If you are upgrading to a new release you need to reassemble and
link-edit your user exit programs.
This section contains the following topics:
User
User
User
User
User
User
User
User
User
User
User
User
Exit
Exit
Exit
Exit
Exit
Exit
Exit
Exit
Exit
Exit
Exit
Exit
1 (see page 416)
2 (see page 418)
3 (see page 420)
4 (see page 422)
5 (see page 424)
6 (see page 427)
7 (see page 430)
8 (see page 432)
9 (see page 434)
10 (see page 436)
12 (see page 438)
13 (see page 440)
Appendix C: User Exits 415
User Exit 1
User Exit 1
Purpose
This exit allows the execution of a user-developed exit routine upon
completion of a CA XCOM Data Transport file transfer. The CA XCOM Data
Transport history record data is available for interrogation at this point.
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX01.
How to Enable
Specify EXIT01=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMXFER calls this exit.
Entry Method
This exit is attached as a subtask by CA XCOM Data Transport.
Required DSECT
SMFDSECT is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of SMFDSECT
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
Entry point address
416 User Guide
User Exit 1
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX01)
Note: Exit 1 is invoked only when the transfer is scheduled and run via the CA
XCOM Data Transport z/OS server. It is not invoked when XCOMJOB
TYPE=EXECUTE is used.
Appendix C: User Exits 417
User Exit 2
User Exit 2
Purpose
This exit allows the execution of a user-developed exit routine that extracts
additional information from JES2 control blocks (information not extracted
by the XCOMPSOI module).
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX02.
How to Enable
Specify EXIT02=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMPSOI calls this exit.
Entry Method
This exit is a branch entry.
Required DSECT
PSODSECT is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of PSODSECT
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
Entry point address
418 User Guide
User Exit 2
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
Sample Program
There is no sample program provided for user exit 2.
Appendix C: User Exits 419
User Exit 3
User Exit 3
Purpose
This exit allows the execution of a user-developed exit routine that extracts
additional information from JES3 control blocks (information not extracted
by the XCOMPSOI module).
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX03.
How to Enable
Specify EXIT03=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMPSOI calls this exit.
Entry Method
This exit is a branch entry.
Required DSECT
PSODSECT is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of PSODSECT
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
Entry point address
420 User Guide
User Exit 3
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
Sample Program
There is no sample program provided for user exit 3.
Appendix C: User Exits 421
User Exit 4
User Exit 4
Purpose
This exit allows the execution of a user-developed exit routine that provides
security checking for the CA XCOM Data Transport TSO/ISPF Operator
Control Facility.
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX04.
How to Enable
Specify EXIT04=YES in the Default Options Table to enable this exit.
Calling Module
The modules XCOMDPJ, XCOMDSPL, and XCOMOPER call this exit.
Entry Method
This exit is a branch entry.
Required DSECT
ADMPL is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of ADMPL
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
Entry point address
422 User Guide
User Exit 4
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The following return codes are valid for user exit 4:
0
User is authorized to perform function
8
User is NOT authorized to perform function
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX04)
Appendix C: User Exits 423
User Exit 5
User Exit 5
Purpose
This exit point allows execution of a user-developed exit routine that
provides additional security checking before a transfer takes place. The exit
is used with the system security option chosen in the CA XCOM Data
Transport Default Options Table's SECURITY parameter (for example, IBM
RACF, CA Top Secret, or CA ACF2).
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX05.
The exit is entered for TYPE=EXECUTE and TYPE=SCHEDULE transfers. The
exit is entered after session establishment.
This exit must be reentrant.
How to Enable
Specify EXIT05=YES in the Default Options Table to enable this exit.
Required DSECT
SECDSECT is the required DSECT.
Calling Module and Entry Sequence
This exit is called by the module XCOMFILE, which in turn is called either by
XCOMJOB or XCOMXFER.
For SNA transfers, the SECLUN field of SECDSECT contains the target LU for
TYPE=EXECUTE (XCOMJOB) transfers and TYPE=SCHEDULE transfers
queued to the CA XCOM Data Transport for z/OS started task (XCOMXFER).
For IP transfers, the SECLUN field of the SECDSECT contains the
hexadecimal representation of the partner's IP address if TCPLUSEC=binary
is specified in the CA XCOM Data Transport default options table. The exit is
also entered when XCOMJOB is executed with TYPE=SCHEDULE. In this
case, SECLUN contains the APPLID of the CA XCOM Data Transport for z/OS
started task. This entry sequence allows you to determine whether the
transfer should be queued for execution. If the target LU must be tested for
a TYPE=SCHEDULE transfer, the test must be deferred until the exit is called
by XCOMXFER.
The following table summarizes how the exit is given control:
EXEC PGM=
PARM=
XCOMEX05
Entry Sequence
SECLUN Contents
XCOMJOB
TYPE=EXECUTE
XCOMJOB ®
XCOMFILE ®
REMOTE LU OR IP ADDRESS (hex)
424 User Guide
User Exit 5
XCOMEX05
XCOMJOB
TYPE=SCHEDULE
XCOMJOB ®
XCOMFILE ®
XCOMEX05
XCOMAPPL (that is, the APPLID of the CA
XCOM Data Transport for z/OS server)
XCOMXFER
N/A
XCOMXFER ®
XCOMFILE ®
XCOMEX05
REMOTE LU OR IP ADDRESS (hex)
The CSAJOBF field in the CSA (CSADSECT) identifies which entry sequence
(XCOMJOB or XCOMXFER) was used while the NSABATF field in the NSA
(NSADSECT) identifies the transfer as being of type TYPE=EXECUTE or
TYPE=SCHEDULE:
Field
EQU
Field Contents
Description
CSAJOBF
CSAJOBJ
Character 'J'
XCOMEX05 entered via XCOMJOB
CSAJOBX
Character 'X'
XCOMEX05 entered via XCOMXFER
NSABATE
Character 'E'
TYPE=EXECUTE transfer
NSABATS
Character 'S'
TYPE=SCHEDULE transfer
NSABATF
Note: CSADSECT and NSADSECT are distributed in CA XCOM Data
Transport's macro library, CAI.CBXGMAC. CSADSECT is pointed to by
NSA@CSA.
Entry Method
This exit is a branch entry.
Addressing Mode at Entry
The addressing mode at entry is 31. XCOMEX05 must have a linkedit mode
of reentrant.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of SECDSECT
Appendix C: User Exits 425
User Exit 5
R2
Undefined
R3
Address of NSADSECT
R4 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
Entry point address
Note: Addressability to CA XCOM Data Transport's CSA as mapped by the
CSADSECT can be obtained by loading NSA@CSA to the register used to map
the CSA.
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
Note: The return code from the exit is passed in field SECRTNCD of the exit
parameter list (which is mapped by the SECDSECT macro found in
CAI.CBXGMAC).
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX05)
426 User Guide
User Exit 6
User Exit 6
Purpose
This exit point allows execution of a user-developed exit routine when
certain key points are reached in the progress of a CA XCOM Data Transport
transfer.
Conditions of Entrance
This user exit is entered under the following conditions:
■
Transfer request is scheduled
■
Transfer request starts
■
Transfer request completes
■
Transfer request fails
■
Transfer request is aged off the queue
Defined Exit States
The following states are defined for this exit:
QUEUED
Transfer has been scheduled or a request from a remote system has been
received
NULL
Transfer is not yet scheduled
INACT
Transfer is scheduled but is waiting
ACTIVE
Transfer is currently in progress
SUSPEND
Transfer has been suspended on the local system
REMSUSP
Transfer has been suspended by the remote system
SUCCESS
Transfer has completed successfully
FAILED
Transfer has failed
VTAM ER
Transfer received a VTAM error and will be retried
Appendix C: User Exits 427
User Exit 6
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX06.
How to Enable
Specify EXIT06=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMEXIT calls this exit.
Entry Method
This exit is a branch entry.
Required DSECT
EX06PLST is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of EX06PLST
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
Entry point address
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
428 User Guide
User Exit 6
Valid Return Code
The only valid return code is 0 for a normal return.
Note: The return code from the exit is passed in field EX06RC of the exit
parameter list (which is mapped by the EX06PLST macro found in
CAI.CBXGMAC).
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX06)
Appendix C: User Exits 429
User Exit 7
User Exit 7
Purpose
This exit point allows execution of a user-developed exit routine that
validates user-supplied CA XCOM Data Transport transfer parameters. The
exit is called after all standard CA XCOM Data Transport validation has been
performed and the CA XCOM Data Transport transfer request control block
(that is mapped by the RRDDSECT macro found in CAI.CBXGMAC) has been
built. The routine may tell CA XCOM Data Transport to accept or reject the
request by setting a flag in the exit parameter list. The exit routine may also
provide an installation-defined error message via the same parameter list.
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX07.
How to Enable
Specify EXIT07=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMEXIT calls this exit.
Entry Method
This exit is a branch entry.
Required DSEC
EX07PLST is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of EX07PLST
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
430 User Guide
User Exit 7
Entry point address
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
Note: The return code from the exit is passed in field EX07RC of the exit
parameter list (which is mapped by the EX07PLST macro found in
CAI.CBXGMAC).
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX07)
Appendix C: User Exits 431
User Exit 8
User Exit 8
Purpose
This exit point allows execution of a user-developed exit routine that
performs user-defined initialization and termination processing for the CA
XCOM Data Transport server. This exit allows extension of CA XCOM Data
Transport with user-supplied control blocks and processing. For example,
the exit can acquire (GETMAIN) and release (FREEMAIN) control blocks, or
load custom user modules.
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX08.
How to Enable
Specify EXIT08=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMXFER calls this exit.
Entry Method
This exit is a branch entry.
Required DSECT
EX08PLST is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of EX08PLST
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
Entry point address
432 User Guide
User Exit 8
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX08)
Appendix C: User Exits 433
User Exit 9
User Exit 9
Purpose
This exit point allows execution of a user-developed exit routine that creates
and processes its own CA XCOM Data Transport commands. The exit is
activated by means of the EXIT operator command (for example, F
XCOM,EXIT,userdata). The supplied data, up to eight bytes, is then passed
to the XCOMEX09 routine, where you can perform any pertinent processing.
This exit can be used to control and alter the functionality of the other CA
XCOM Data Transport exits.
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX09.
How to Enable
Specify EXIT09=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMXFER calls this exit.
Entry Method
This exit is a branch entry.
Required DSECT
EX09PLST is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of EX09PLST
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
R15
Entry point address
434 User Guide
User Exit 9
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX09)
Appendix C: User Exits 435
User Exit 10
User Exit 10
Purpose
This exit point allows execution of a user-developed exit routine that
generates a user-designed banner page for all reports received by the
system.
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX10.
How to Enable
Specify EXIT10=YES in the Default Options Table to enable this exit.
Calling Module
The modules XCOMRECV, XCOMUPL2, XCOMUPL6, and XCOMUP2F call this
exit.
Entry Method
This exit is a branch entry.
Required DSECT
There is no required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0 - R2
Undefined
R3
Address of NSA control block (mapped by NSADSECT macro)
R4
Number of lines in each banner
R5
Number of letters per line
R6
Number of characters per letter
R7
Address of banner field
R8
Address of file data field
436 User Guide
User Exit 10
R9 to R12
Undefined
R13
Address of CSA control block (mapped by CSADSECT macro)
R14
Return address
R15
Entry point address
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX10)
Appendix C: User Exits 437
User Exit 12
User Exit 12
Purpose
This exit point controls partner LU security. It executes a user-written exit
routine that verifies a given user's authority to transfer data to and from a
particular LU. The following are the possible results of the verification:
■
The user is given access to the designated LUs.
■
The user is denied access to the LUs.
■
The user's right to access the LUs is referred to the security package.
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX12.
How to Enable
Specify EXIT12=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMTRGT calls this exit.
Entry Method
This exit is a branch entry.
Required DSECT
EX12PLST is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of EX12PLST
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
438 User Guide
User Exit 12
R15
Entry point address
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
0
Allow access immediately
4
Let the security package make the decision
8
Deny access immediately
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX12)
Note: In cases where a transfer causes the server to create a session due to
GETSESS=YES, Exit 12 is called once before session establishment and once
before the transfer is performed. The exit is also called before each transfer
restart.
Appendix C: User Exits 439
User Exit 13
User Exit 13
Purpose
This exit point controls command security, both from the console and from
the ISPF and CICS menu interfaces. It executes a user-written exit routine
that verifies a given user's authority to issue a particular command. The
following are the possible results of the verification:
■
The user is given access to the designated commands.
■
The user is denied access to the commands.
■
The user's right to access the commands is referred to the security
package.
Module Name and Entry Point
The module name and entry point for this exit is XCOMEX13.
How to Enable
Specify EXIT13=YES in the Default Options Table to enable this exit.
Calling Module
The module XCOMOPRS calls this exit.
Entry Method
This exit is a branch entry.
Required DSECT
EX13PLST is the required DSECT.
Addressing Mode at Entry
The addressing mode at entry is 31.
Registers at Entry
The following registers are available at entry:
R0
Undefined
R1
Address of EX13PLST
R2 to R12
Undefined
R13
Address of register save area
R14
Return address
440 User Guide
User Exit 13
R15
Entry point address
Registers at Exit
The following registers are available at exit:
R0 to R14
Undefined
R15
Return code
Valid Return Code
The only valid return code is 0 for a normal return.
0
Allow access immediately
4
Let the security package make the decision
8
Deny access immediately
Sample Program
The following is a sample program using this exit:
CAI.CBXGSAMP(XCOMEX13)
Note: Exit 13 has six separate entry codes, mapped by the field X13FUNCT in
the EX13PLST DSECT. This field contains an entry code explaining why the exit is
being entered.
Appendix C: User Exits 441
Index
#
# DFLTAB (Default Options Table) • 382
broadcast distributions • 159
bytes, Detailed File Transfer screen • 156
bytes/sec, Detailed File Transfer screen • 156
&
C
&DATE(format-code), symbolic parameter • 189
&ID, symbolic parameter • 189
&IPNAME, symbolic parameter • 189
&LU, symbolic parameter • 189
&LUSER, symbolic parameter • 189
&TIME(format-code), symbolic parameter • 190
CA Roscoe transactions • 276
CA XCOM Data Transport server, starting • 290
CANCEL, MODIFY command • 299
CANCLD status field • 153
CATALOG, system parameter • 305
CHARS, SYSIN01 parameter • 244
checkpoint count, Receive File From Another
System screen • 120
CICS
COPYCSD • 409
define CICS default file, sample JCL • 407
direct spool interface • 281
sample notification transaction • 391
transactions • 276
XCOMFCT sample JCL • 411
XCOMTCT sample JCL • 414
CKPT, SYSIN01 parameter • 194
CLASS
SYSIN01 parameter • 245
system parameter • 305
CLIST library • 20
CNOS, MODIFY command • 301
COBOL
calling CA XCOM Data Transport from • 269
CICS sample • 391
Code Table parameter • 54, 83, 98, 122
CODE, SYSIN01 parameter • 194
CODETABL, PARM parameter • 193
coding interdependent transfers • 261
command security, overview • 353
compatibility with ISPF • 22
completed transfers • 356
user exit • 416
COMPLT status field • 153
COMPNEG, PARM parameter • 168
compound destinations • 282, 283
compress data
Detailed File Transfer screen • 156
Receive File From Another System screen •
121
Send File screen • 56
A
ACBNAME, PARM parameter • 167
ACTIVATE, MODIFY command • 295
active session, display with command line • 311
ACTIVE status field • 153
add remote file • 52, 118
AGE
SYSIN01 parameter • 193
system parameter • 305
XCOMUTIL parameter • 357
Allocate New Dataset Parameters menu fields
Release • 73
allocating data sets
local • 268
new • 22, 69, 305
temporary • 305
ALTER, MODIFY command • 296
application program interface, sample COBOL
program • 270
APPLID
VTAM APPLID definition table • 375
APPLXCOM, sample JCL • 375
ASMACF2, sample JCL • 406
ASMRACFU, sample JCL • 402
ASMTOPSU, sample JCL • 404
ASSEMBLER program, calling CA XCOM Data
Transport from • 271
attribute labels • 150
B
banner page user exit • 436
batch multiple transfers • 160, 211
BLKSIZE, SYSIN01 parameter • 253
Index 443
Send Report screen • 85
Submit Job screen • 99
COMPRESS, SYSIN01 parameter • 195
compression • 168
mode, Detailed File Transfer screen • 156
types • 195
concurrent transfers • 211
console commandsSee MODIFY commands •
295
console routing codes • 305
CONTINUE, PARM parameter • 169
control block, dump • 312
control fields • 151
control library
alternate • 29
enable • 314
CONTROL, SYSIN01 parameter • 245
copies, Send Report screen • 81
COPIES, SYSIN01 parameter • 245
COPY, SYSIN01 parameter • 245
COPYCSD, sample JCL • 409
create remote file • 52, 118
create/add/replace remote file, Send File
screen • 48
D
Data Class parameter • 72
data compression
Receive File From Another System screen •
121
Send File screen • 56
Send Report screen • 85
Submit Job screen • 99
data set
entry sequenced • 351
key sequenced • 351
multivolume • 352
name, Receive File screen • 69
partitioned • 344
relative record • 351
TSO • 281
DATACLAS, SYSIN01 parameter • 196
Dataset Name Type parameter • 73
DATE
attribute label • 150
XCOMUTIL parameter • 357
date, alter priority • 296
date, start • 134
LOCATE command • 150
444 User Guide
status • 153
unprotected field • 151
DCB information, examples • 255
DCB parameters (SYSIN01)
BLKSIZE • 253
LRECL • 253
RECFM • 254
RELEASE • 230
DD statements • 162
LCLDS01 • 268
deactivate trace with command line • 320, 321
deactivation parameters, trace • 320
default menu interface • 21
Default Options Table (#DFLTAB), sample • 382
default parameters, modifying dynamically
AGE • 305
CATALOG • 305
CLASS • 305
DIR • 305
DUMPCL • 305
EDESC • 305
EROUT • 305
ERRINTV • 305
IDESC • 305
IROUT • 305
JESINTV • 305
LOG • 305
LOGCL • 305
LOGDEST • 305
MAXLOC • 305
MAXREM • 305
MAXTASK • 305
PRI • 305
PSOUNIT • 305
PSOVOL • 305
REMAGE • 305
SEC • 305
SMF • 305
SMFNUM • 305
TCPSESS • 305
UNIT • 305
USERD • 305
VOL • 305
DEFDFLT, sample JCL • 407
DEFHIST, sample JCL • 365
DEFINQ, sample JCL • 374
DEFQSAM, sample JCL • 373
DEFRRDS, sample JCL • 363
DELETE, MODIFY command • 303
DEN, SYSIN01 parameter • 248
DEST, SYSIN01 parameter • 246
DESTID, JES2 destination statement • 284
destination name, JES • 285
DFLT, MODIFY command • 304
DFLTAB, PARM parameter • 169
DIR, system parameter • 305
direct access, data set support • 352
DISABLE, MODIFY command • 308
DISP, SYSIN01 parameter • 246
DISPALG, PARM parameter • 170
display current values with command line • 317
DISPLAY, MODIFY command • 311
DOMAIN
PARM parameter • 170
SYSIN01 parameter • 196
DSNTYPE, SYSIN01 parameter • 197
DSPRINT, TSO command • 276
DUMP, MODIFY command • 312
DUMPCL
PARM parameter • 170
system parameter • 305
dumps • 305
DUMPXCF, MODIFY command • 313
E
EBCDIC/binary/ASCII
Send Report screen • 82
Submit Job screen • 97
EBCDIC/binary/ASCII/VLR
Receive File From Another System screen •
119
Send File screen • 53
EDESC
PARM parameter • 171, 174
system parameter • 305
enable control library with command line • 314
ENABLE, MODIFY command • 314
end time, Detailed File Transfer screen • 156
entry sequenced data set • 351
EPRTY, SYSIN01 parameter • 197
EROUT
PARM parameter • 171
system parameter • 305
ERRINTV, system parameter • 305
error flags, reset • 324
error handling • 305
ESDS • 351
EXEC
PARM • 267
statement • 161
execute user exit routine from command line •
315
execution priority
alter with command line • 296
Receive File From Another System screen •
108
Send File screen • 40
Send Report screen • 75
Submit Job screen • 92
exit points • 415
EXIT, MODIFY command • 315
EXPDT, SYSIN01 parameter • 249
external writer • 282
F
failed transfers, resumption • 169
FCB, SYSIN01 parameter • 246
file
considerations, fixed to variable record
transfers • 352
multivolume data sets • 352
processing different file types • 343
replacement, Receive File From Another
System screen • 118
security, overview • 353
transfers, dependent scheduling • 256
File Allocation Information screen • 69
parameter fields • 69
file replacement, Send File screen • 52
file sequence, Submit Job screen • 93
File Transfer Display Select screen • 140
File Transfer Scheduling Information screen •
133
member selection list • 138
parameters • 133
file types
processing • 343
USS • 349
file types, VSAM files
entry sequenced data set • 351
key-sequenced data sets (KSDS) • 351
FILE, SYSIN01 parameter • 226
FILEDATA, SYSIN01 parameter • 45
FILEOPT, SYSIN01 parameter • 227
FILETYPE, SYSIN01 parameter • 199
FILETYPE=FILE parameters (SYSIN01)
FILE • 226
Index 445
FILEOPT • 227
LUNIT • 228
LVOL • 228
PACK • 229
RECSEP • 230
SPACE • 231
UNIT • 231
VOL • 232
FILETYPE=REPORT parameters (SYSIN01)
CHARS • 244
CLASS • 245
CONTROL • 245
COPIES • 245
COPY • 245
DEST • 246
DISP • 246
FORM • 247
REPORT • 247
REPORTHOLD • 247
SPOOL • 248
WRITER • 248
flags, reset error flags • 324
form type, Send Report screen • 81
FORM, SYSIN01 parameter • 247
forms, control buffer • 84
function
keys • 22
trace parameters • 336
G
generation data groups (GDGs)
transferring all generations • 349
generic
file specifications • 345
unit, allocate new • 70
global data set, defining • 373
group
PARM parameter • 173
SYSIN01 parameter • 200
H
halt file transfer with command line • 335
heading line, Detailed File Transfer screen • 156
HELD status field • 153
Help facility • 23
HISTDD • 173
HISTIN, DD statement • 358
history files, sample JCL to create • 365
History System Id • 142
446 User Guide
History System Name • 142
HISTOUT, DD statement • 358
hold
file transfer request • 256
File Transfer Scheduling Information screen •
136
MODIFY command • 316
printing, Send Report screen • 84
SYSIN01 parameter • 201
transfer not completed • 356
HOLDCOUNT, SYSIN01 parameter • 256
HSTDSECT, Assembler macro • 356
I
ID, SYSIN01 parameter • 201
IDESC
PARM parameter • 174
system parameter • 305
IDMS transactions • 276
IEBISAM conversion utility • 352
INACT status field • 153
initialization processing, user exit • 432
INQ, MODIFY command • 317
Inquire, sample JCL • 374
INQWAIT, SYSIN01 parameter • 202
interdependent (multiple) transfers • 256
invoking menu interface • 19
IP
address • 24, 173
name • 24
IPNAME
PARM parameter • 175
ISPF Dialog Manager services • 22
J
Japanese Character Set Support Screen • 131
JCL
for defining an XCOMPLEX Admin Server •
388
for defining an XCOMPLEX structure • 387
for defining an XCOMPLEX to the Coupling
Facility • 386
for reassembling and linkediting XCOMACF2
security exit • 406
for reassembling and linkediting XCOMRACF
security exit • 402
for reassembling and linkediting XCOMTOPS
security exit • 404
for XCOMUTIL • 358
JES
destination name • 285
remote destination • 280
spool, scanning interval • 305
JES2
additional information, user exit • 418
DESTID name • 284
JES3
additional information, user exit • 420
CONSOLE statement • 285
JESINTV, system parameter • 305
JOBLIB, DD statement • 164
JPNCNTL, SYSIN01 parameter • 203
JPNDATA, SYSIN01 parameter • 203
JPNDBL, SYSIN01 parameter • 203
JPNSHFT, SYSIN01 parameter • 204
K
Katakana characters in file • 132
key-sequenced data sets (KSDS) • 351
KSDS • 351
L
label type, Submit Job screen • 94
LABEL, SYSIN01 parameter • 249
last
action, Detailed File Transfer screen • 156
message, Detailed File Transfer screen • 156
ms, Detailed File Transfer screen • 156
LCLDS01
allocating • 268
DD statement • 163
LCLNTFYL, SYSIN01 parameter • 204
LFILE, SYSIN01 parameter • 163, 205
LFILEDATA, SYSIN01 parameter • 44
LIBNEG
destination parameter • 346
system parameter • 346
library • 314
CLIST • 20
transfers • 346
library transfers • 346
list
MODIFY command • 318
PARM parameter • 177
SYSIN01 parameter • 208
list name, Selection menu • 26
LLABEL, SYSIN01 parameter • 250
LOAD macro • 271
local file name
Receive File From Another System screen •
109
Send File screen • 41
Send Report screen • 76
Submit Job screen • 93
local transfers, display with command line •
327, 339
local volume
Receive File From Another System screen •
129
Send File screen • 63
locally initiated transfer requests, queue
purging interval • 305
LOCATE, menu command • 149
LOCFER status field • 153
LOCFILE, attribute label • 150
LOG
PARM parameter • 178
system parameter • 305
log file, free the file for printing • 319
LOGCER status field • 153
LOGCL, system parameter • 305
LOGCLASS, PARM parameter • 178
LOGDEST
PARM parameter • 178
system parameter • 305
LOGFREE, MODIFY command • 319
login user name • 27
LOGMODE, PARM parameter • 179
LPASS, SYSIN01 parameter • 209
LRECL, SYSIN01 parameter • 253
LSR, sample JCL • 390
LU
PARM parameter • 179
SYSIN01 parameter • 209
LUNIT, SYSIN01 parameter • 228
LUNITC, SYSIN01 parameter • 250
LUSER, SYSIN01 parameter • 210
LVOL, SYSIN01 parameter • 228
LVOLCT, SYSIN01 parameter • 250
LVOLSQ, SYSIN01 parameter • 251
M
Management Class parameter • 72
MAXLOC, system parameter • 305
MAXREM, system parameter • 305
MAXTASK, system parameter • 305
member selection list • 48
Index 447
screen • 138
menu interface • 19
considerations • 349
default values • 21
Help facility • 23
messages • 157
special feature keys • 22
starting • 19
messages, menu interface • 157
MGMTCLAS, SYSIN01 parameter • 210
mode, definition • 377
Model 204 transactions • 276
MODIFY commands
ACTIVATE • 295
ALTER • 296
CANCEL • 299
CNOS • 301
DELETE • 303
DFLT • 304
DISABLE • 308
DISPLAY • 311
DUMP • 312
DUMPXCF • 313
ENABLE • 314
EXIT • 315
format and usage • 294
HOLD • 316
INQ • 317
LIST • 318
LOGFREE • 319
NOTRACE • 320
NOXTRACE • 321
NSASTAT • 321
RELEASE • 323
RESET • 323
RESUME • 325
RSHOW • 325
SHOW • 327
SNAP • 329
STOP • 332
SUSPEND • 333
TERM • 335
TRACE • 336
VERSION • 337
XRSHOW • 338
XSHOW • 339
XTRACE • 340
multiple transfers • 211, 256
errors • 169
448 User Guide
MVS
Console Routing Code • 175
console routing codes • 305
Message Descriptor Code • 174
message descriptor codes • 305
N
NETNAME, PARM parameter • 179
NetView and CA XCOM Data Transport • 294
Network Job Entry • 276
NEWXFER, SYSIN01 parameter • 211
NJE • 276
notify level, local system
Receive File From Another System screen •
126, 129
Send File screen • 60, 63
Send Report screen • 90
Submit Job screen • 105
notify level, remote system
Send File screen • 89, 103
notify user, local system
Receive File From Another System screen •
128
Send File screen • 60, 63
Send Report screen • 90
Submit Job screen • 105
notify user, remote system
Receive File From Another System screen •
126
Send File screen • 102
Send Report screen • 88
Submit Job screen • 102
NOTIFY, SYSIN01 parameter • 212
NOTIFYNAME, SYSIN01 parameter • 213
NOTRACE, MODIFY command • 320
NOXTRACE, MODIFY command • 321
NSASTAT, MODIFY command • 321
O
only save SYSIN01, Selection menu • 30
OpenSSL • 354
operating and controlling CA XCOM Data
Transport • 289
operator control
parameter fields • 142
Selection menu option • 24
OTHERR status field • 153
P
Pack Data Records • 57
PACK, SYSIN01 parameter • 229
panels, using • 19
parallel session, start • 301
parameter fields, local system
Receive File From Another System screen •
127
Send File screen • 61
Send Report screen • 89
parameter fields, remote system
Receive File From Another System screen •
124
Send File screen • 58
Send Report screen • 87
parameters
application programming interface • 267
defaults • 21
Detailed File Transfer screen • 157
errors • 157
File Allocation Information screen • 69
File Transfer Scheduling Information screen •
133
hierarchy of usage • 166
history log • 142
operator control • 24
PARM • 161
primary processing • 23, 24
Receive File From Another System screen •
106
Send File screen • 38
Send Report screen • 74
Transfer Request Display screen • 142, 151
XCOMUTIL • 356
parameters, local system
Submit Job screen • 103
parameters, remote system
Submit Job screen • 101
PARM • 161
EXEC • 267
PARM parameters • 166
ACBNAME • 167
CODETABL • 193
COMPNEG • 168
CONTINUE • 169
DFLTAB • 169
DISPALG • 170
DOMAIN • 170
DUMPCL • 170
EDESC • 171
EROUT • 171
GROUP • 173
HISTDD • 173
IDESC • 174
IPNAME • 175
IPPORT • 175
IROUT • 175
LIST • 177
LOG • 178
LOGCLASS • 178
LOGDEST • 178
LOGMODE • 179
LU • 179
NETNAME • 179
SECURE_SCHEDULE • 180
STCAPPL • 181
STCIP • 181
STCPORT • 181
SWAIT • 182
TCPSTACK • 183
TIMEOUT • 173, 183
TRACE • 184
TYPE • 185
VTAMGNAM • 186
XCOMPLEX • 186
partitioned data sets • 344
partner security, overview • 353
password, local system
Receive File From Another System screen •
128
Send File screen • 62
Send Report screen • 90, 104
password, remote system
Receive File From Another System screen •
125
Send File screen • 59
Send Report screen • 88
Submit Job screen • 102
PASSWORD, SYSIN01 parameter • 213
pending
delete transfer from pending queue • 303
hold a pending transfer with command line •
316
PF keys • 22
POLCFRM, define XCOMPLEX structure • 387
port • 25
PRI, system parameter • 305
primary processing parameters • 24
Index 449
print • 319
print class, Send Report screen • 84
PRINTOFF, TSO command • 276
priority sel/exec, Detailed File Transfer screen •
156
process control user exit • 432, 434
process SYSOUT interface • 305
PROCESS, XCOMUTIL parameter • 358
PROGLIB, SYSIN01 parameter • 214
Program Library parameter • 51, 117
program sample
Assembler • 272
COBOL • 270
programming language support • 267
protected fields, display • 152
protocol • 28
PSO, sending reports with • 277
PSOUNIT, system parameter • 305
PSOVOL, system parameter • 305
PSOWAIT
destination table parameter • 284
JES option • 277
purge
file transfer request • 256
history file utility • 356
with command line • 335
Q
queue execution parameters • 297
queue for execution, Selection menu • 28
queue purging interval
for locally initiated transfer requests • 305
for remotely initiated transfer requests • 305
R
Receive File from Another System menu fields
FILEDATA • 45
LFILEDATA • 44
Pack Data Records • 57
UMASK • 43
USSLRECL • 45
Receive Files, Selection menu option • 24
RECFM, SYSIN01 parameter • 254
record
format, allocate new • 71
transfers, fixed to variable • 352
RECSEP, SYSIN01 parameter • 230
relative record data sets • 351
Release • 73
450 User Guide
release, file transfer request • 256
RELEASE, MODIFY command • 323
RELEASE, SYSIN01 parameter • 230
REMAGE, system parameter • 305
REMFILE, attribute label • 150
remote
group name, Selection menu • 26
list name, Selection menu • 26
system name, Selection menu • 26
system/user, operator control parameter •
145
TCP/IP indicator, operator control parameter
• 145
transfers, display with command line • 325,
338
user name, Selection menu • 27
remote system identification
IP name or address • 24
login user name • 27
port • 25
SNA LU Name • 26
XCOM group name • 26
XCOM list name • 26
remote system information, Receive File From
Another System screen • 124
remote unit
Receive File From Another System screen •
127
Send File screen • 61
remote volume
Receive File From Another System screen •
126
Send File screen • 61
remotely initiated transfer requests, queue
purging interval • 305
REMSUS status field • 153
REMSYS, attribute label • 150
REPCR, system parameter • 180
replace remote file • 52, 118
report title, Send Report screen • 81
REPORT, SYSIN01 parameter • 247
REPORTHOLD, SYSIN01 parameter • 247
REQNUM, attribute label • 150
request number, operator control parameter •
143
request queue • 363
requesting user ID, operator control parameter
• 143
reset error flags parameters • 324
RESET, MODIFY command • 323
restart data set, defining • 373
RESTART, SYSIN01 parameter • 214
RESUME, MODIFY command • 325
resumption of failed transfers • 169
RETPD, SYSIN01 parameter • 251
return codes, XCOMJOB • 264
RF, attribute label • 150
RFILE, attribute label • 150
RJE • 277
RJPWS, JES2 destination statement • 285
RLE • 168
RMTNTFYL, SYSIN01 parameter • 215
RNOTIFY, SYSIN01 parameter • 216
RNOTIFYNAME, SYSIN01 parameter • 217
Roscoe transactions • 276
routing to a specific printer • 283
RRDS • 351
file, sample JCL • 363
RSHOW, MODIFY command • 325
runlength encoding • 168
S
samples
application definition table • 375
APPLID • 375
CA XCOM Data Transport server definition •
389
CA XCOM Data Transport startup JCL • 389
CICS notification transaction • 391
COPYCSD • 409
creating a history file • 365
creating a transfer queue • 363
creating sequential data sets for non-queued
transfers • 373, 374
creating XCOMGLOB and XCOMREST data
sets • 373, 374
default options table • 382
default options table parameters • 382
DEFDFLT • 407
determining transfer request status • 396
direct transfer JCL • 392
JCL for defining an XCOMPLEX Admin Server
• 388
JCL for defining an XCOMPLEX structure •
387
JCL for defining an XCOMPLEX to the
Coupling Facility • 386
JCL for reassembling and linkediting
XCOMACF2 security exit • 406
JCL for reassembling and linkediting
XCOMRACF security exit • 402
JCL for reassembling and linkediting
XCOMTOPS security exit • 404
logmode table • 377
maintaining history file • 368
mode table • 377
non-queued transfer • 392
scheduled transfer JCL • 393
system administrator table • 385
TYPE=EXECUTE transfer • 392
TYPE=SCHEDULE transfer • 393
VTAM application definition table • 375
XCOMENCR • 408
XCOMFCT • 411
XCOMJOB • 160
XCOMMODE • 377
XCOMPCT • 412
XCOMPPT • 413
XCOMTCT • 414
save SYSIN01, Selection menu • 29
scanning interval • 305
scheduled start time
alter priority with command line • 296
Detailed File Transfer screen • 156
screens
File Allocation Information • 69
File Transfer Display Select • 140
File Transfer Scheduling Information • 133
Member Selection List • 138
Receive File From Another System • 106
Selection menu • 23
Send MVS File To Another System • 37
Send Report to Another System • 74
Submit Job • 91
Transfer Request Display • 147
using • 19
scrolling • 22
SEC, system parameter • 305
Secure Socket Layer • 354
Secure Socket parameter • 54, 78, 96, 120
SECURE_SCHEDULE parameter • 180
SECURE_SOCKET, SYSIN01 parameter • 25,
217
security
checking for TSO/ISPF, user exit • 422
invoking • 354
Index 451
overview • 353
user exit • 424
selection
commands • 152
priority • 135
Selection menu • 23
Send File screen
local system information • 61
parameter fields • 38
remote system information • 58
Send File to Another System menu fields
FILEDATA • 45
LFILEDATA • 44
Pack Data Records • 57
UMASK • 43
USSLRECL • 45
Send Files, Selection menu option • 24
Send Functions screen • 31
menu options • 31
Send Jobs, Selection menu option • 24
Send MVS File To Another System screen • 37
send record separators
Receive File From Another System screen •
119
Send File screen • 53
Send Report screen • 82
Submit Job screen • 97
Send Report screen • 74
local system • 89
parameter fields • 74
remote system information • 87
Send Report to Another System menu fields
Pack Data Records • 57
Send Report To Another System screen • 74
Send Reports, Selection menu option • 24
sending reports with PSO • 277
sending system information • 157
server • 35, 38
CA XCOM Data Transport, starting • 290
XCOMPLEX Admin, defining • 388
XCOMPLEX Worker, defining • 389
session
cancel from command line • 299
cancellation operands • 300
session establishment
timeout • 183
SHOW, MODIFY command • 327
SMF
files • 355
452 User Guide
records • 305, 355
SMF, system parameter • 305
SMFDSECT, Assembler macro • 356
SMFNUM, system parameter • 305
SNA LU name • 24, 26
SNAP, MODIFY command • 329
space units, allocate new • 70
block size • 72
directory blocks • 70
primary quantity • 70
record length • 72
secondary quantity • 70
SPACE, SYSIN01 parameter • 231
split screen • 22
SPOOL, SYSIN01 parameter • 248
SPRTY, SYSIN01 parameter • 218
SSL • 354
start
date/time • 134, 137, 141
menu interface • 19
parallel session • 301
start time, unprotected field • 151
time/date
LOCATE command • 150
status • 153
unprotected field • 151
STARTDATE, SYSIN01 parameter • 219
STARTTIME, SYSIN01 parameter • 220
status
Detailed File Transfer screen • 156
Transfer Request Display screen • 152
STCAPPL, PARM parameter • 181
STCIP, PARM parameter • 181
STCPORT, PARM parameter • 181
STEPLIB, DD statement • 164
STOP, MODIFY command • 332
stopping CA XCOM Data Transport • 332
Storage Class parameter • 72
STORCLAS, SYSIN01 parameter • 220
structure, defining XCOMPLEX • 387
Submit Job screen • 91
local system • 103
parameter fields • 91
remote system information • 101
Submit Job to Another System menu fields
Pack Data Records • 57
superlist • 177
SUPPLIST, system parameter • 182
supported programming languages • 267
SUSPEND, MODIFY command • 333
suspended transfers, resuming • 325
SUSPND status field • 153
SWAIT, PARM parameter • 182
symbolic parameters • 188
&DATE(format-code) • 189
&ID • 189
&IPNAME • 189
&LU • 189
&LUSER • 189
&TIME(format-code) • 190
SYS1.IMAGELIB • 84
SYSIN, DD statement • 358
SYSIN01
data sets • 267
DD statement • 164, 187
LPASS, XCOMENCR • 408
PASSWORD, XCOMENCR • 408
Selection menu • 29
XTC • 256
SYSIN01 parameters • 187
AGE • 193
CKPT • 194
CODE • 194
COMPRESS • 195
DATACLAS • 196
DOMAIN • 196
DSNTYPE • 197
EPRTY • 197
FILEDATA • 45
FILETYPE • 199
GROUP • 200
HOLD • 201
ID • 201
INQWAIT • 202
IPNAME • 202
IPPORT • 202
JPNCNTL • 203
JPNDATA • 203
JPNDBL • 203
JPNSHFT • 204
LCLNTFYL • 204
LFILE • 205
LFILEDATA • 44
LIST • 208
LPASS • 209
LU • 209
LUSER • 210
MGMTCLAS • 210
NEWXFER • 211
NOTIFY • 212
NOTIFYNAME • 213
PASSWORD • 213
PROGLIB • 214
RESTART • 214
RMTNTFYL • 215
RNOTIFY • 216
RNOTIFYNAME • 217
SECURE_SOCKET • 25, 217
SPRTY • 218
STARTDATE • 219
STARTTIME • 220
STORCLAS • 220
symbolic parameters • 188
SYSUDATA • 58, 87, 101, 124, 220
TDUDATA • 221
TRUNCATE • 221
TRUSTED • 221
TYPE • 222
UMASK • 43
USER • 224
USERID • 224
USSLRECL • 45
XCOM_CONFIG_SSL • 25, 225
SYSIN01 parameters (DCB parameters)
BLKSIZE • 253
LRECL • 253
RECFM • 254
RELEASE • 230
SYSIN01 parameters (FILETYPE=FILE)
FILE • 226
FILEOPT • 227
LUNIT • 228
LVOL • 228
PACK • 229
RECSEP • 230
SPACE • 231
UNIT • 231
VOL • 232
SYSIN01 parameters (FILETYPE=HISTORY) •
232
OEDATE • 233
OETIME • 234
OFILETYPE • 234
OFLMAX • 235
OFLMIN • 236
OID • 236
OINIT • 237
Index 453
OLIMIT • 237
OLMSG • 238
OLU • 239
OREQ • 239
OSDATE • 240
OSTIME • 241
OSYSID • 241
OSYSNAME • 242
OTNAME • 242
OTYPE • 243
OTYPEREQ • 243
OUSER • 244
SYSIN01 parameters (FILETYPE=REPORT)
CHARS • 244
CLASS • 245
CONTROL • 245
COPIES • 245
COPY • 245
DEST • 246
DISP • 246
FCB • 246
FORM • 247
REPORT • 247
REPORTHOLD • 247
SPOOL • 248
WRITER • 248
SYSIN01 parameters (tape parameters)
DEN • 248
EXPDT • 249
LABEL • 249
LLABEL • 250
LUNITC • 250
LVOLCT • 250
LVOLSQ • 251
RETPD • 251
TAPE • 251
UNITCT • 251
VOLCT • 252
SYSIN01 parameters (transfer control (XTC))
HOLDCOUNT • 256
XTCERRDECR • 257
XTCERRINCR • 257
XTCERRPURGE • 257
XTCERRREL • 258
XTCGOODDECR • 258
XTCGOODINCR • 258
XTCGOODPURGE • 259
XTCGOODREL • 259
XTCJOB • 259
454 User Guide
XTCNET • 260
SYSOUT
advantages of the interface • 276
class • 305
diagnostic dumps • 305
external writer • 282
JES spool files • 277
use with TSO • 281
with CICS • 281
with other online systems • 281
SYSPLEX, define XCOMPLEX • 386
SYSPRINT, DD statement • 164, 358
SYSTCPD, DD statement • 164
system administrator table, sample • 385
System Management Facility
files • 355
records • 305, 355
system name, Selection menu • 26
system parameter, IPPORT • 175
system parameters
REPCR • 180
SUPPLIST • 182
SYSTERM, DD statement • 164
SYSUDATA, SYSIN01 parameter • 58, 87, 101,
124, 220
T
tape parameters (SYSIN01)
DEN • 248
EXPDT • 249
LABEL • 249
LLABEL • 250
LUNITC • 250
LVOLCT • 250
LVOLSQ • 251
RETPD • 251
TAPE • 251
UNITCT • 251
VOLCT • 252
TAPE, SYSIN01 parameter • 251
TCP/IP
remote system identification • 24
transfers • 173, 175, 200
TCPSESS, system parameter • 305
TCPSTACK, PARM parameter • 183
TDUDATA, SYSIN01 parameter • 221
Technical Support • iii
temporary data sets • 305
TERM, MODIFY command • 335
termination processing user exit • 432
TERMTD status field • 153
thirdparty processing • 159
TIME, attribute label • 150
TIMEOUT, PARM parameter • 173, 183
total bytes transferred, Detailed File Transfer
screen • 156
TPF transactions • 276
TRACE
deactivation parameters • 320
MODIFY command • 336
parameters • 336
PARM parameter • 184
transaction, CICS notification • 391
transfer
all generations of a GDG • 349
batch interface • 348
bytes • 156
completed • 356
control • 256
errors during multiple • 169
fixed to variable • 352
menu interface • 349
multiple • 211
progress, user exit • 427
records, Detailed File Transfer screen • 156
scheduled versus immediate • 347
time (secs), Detailed File Transfer screen •
156
VTAM compression bytes • 156
transfer control (XTC) parameters (SYSIN01)
HOLDCOUNT • 256
XTCERRDECR • 257
XTCERRINCR • 257
XTCERRPURGE • 257
XTCERRREL • 258
XTCGOODDECR • 258
XTCGOODINCR • 258
XTCGOODPURGE • 259
XTCGOODREL • 259
XTCJOB • 259
XTCNET • 260
transfer ID • 150
Detailed File Transfer screen • 156
operator control parameter • 143
Receive File From Another System screen •
108
Send File screen • 39
Send Report screen • 75
Submit Job screen • 92
transfer log • 305
transfer queue, sample • 363
transfer request • 256
Transfer Request Display screen • 147
selection commands • 152
unprotected fields • 151
Truncate Record parameter • 54, 83, 98
TRUNCATE, SYSIN01 parameter • 221
truncating records • 54, 83, 98
TRUSTED, SYSIN01 parameter • 221
TSO commands
DSPRINT • 276
PRINTOFF • 276
VPSPRINT • 276
TSO, requeue data sets • 281
TSO/ISPF
Dialog Manager services • 20
menu interface • 19
TYPE
PARM parameter • 185
SYSIN01 parameter • 222
TYPE=EXECUTE
LCLDS01 DD statement • 163
RESTART parameter • 214
return code • 264
sample transfer • 392
timeout abort • 185
TIMEOUT parameter • 183
XCOMJOB • 160, 161
XCOMREST DD statement • 166
TYPE=INQUIRE
return code • 264
sample transfer through XCOMPLEX Admin
Server • 398
transfers • 202
XCOMJOB • 160, 161
TYPE=RECEIVE
FILETYPE requirement • 222
TYPE=SCHEDULE
return code • 264
sample transfer • 393
sample transfer through XCOMPLEX Admin
Server • 394
transfers • 177, 181, 208
XCOMINQ DD statement • 165
XCOMJOB • 160, 161
Index 455
U
UID, attribute label • 150
UMASK, SYSIN01 parameter • 43
unit
Receive File From Another System screen •
127
Send File screen • 61
SYSIN01 parameter • 231
system parameter • 305
UNITCT, SYSIN01 parameter • 251
UNKN status field • 153
unprotected fields • 151
usage statistics • 321
user
execute user-written exit routine from
command line • 315
exits • 415
name, Selection menu • 27
user ID
Receive File From Another System screen •
127
Send File screen • 62
Send Report screen • 58, 87, 89, 124
Submit Job screen • 101, 104
USER ID, attribute label • 150
USER, SYSIN01 parameter • 224
USERD, system parameter • 305
USERID, SYSIN01 parameter • 224
user-specified checkpoints • 160
V
VERSION, MODIFY command • 337
VOL
SYSIN01 parameter • 232
system parameter • 305
VOLCT, SYSIN01 parameter • 252
VOLSQ, SYSIN01 parameter • 252
volume
allocate new serial • 69
Receive File From Another System screen •
126, 129
Send File screen • 61, 63
VPSPRINT, TSO command • 276
VSAM
history file purge utility • 356
JCL-VSAM request queue • 363
VSAM files
entry sequenced data set • 351
key-sequenced data sets (KSDS) • 351
456 User Guide
VTAM
APPLID definition table • 375
compression bytes, Detailed File Transfer
screen • 156
VTAMGNAM, PARM parameter • 186
VTOC, read by CA XCOM Data Transport • 344
W
wandering LU • 27
wildcards • 345
WRITER
destination table parameter • 282
SYSIN01 parameter • 248
writer name, Send Report screen • 83
WTO macro
Send Report screen • 88
Submit Job screen • 102
X
XCOM group name • 26
XCOM list name • 26
XCOM Operator Control, Selection menu option
• 24
XCOM_CONFIG_SSL, SYSIN01 parameter • 25,
225
XCOMACF, sample JCL • 402
XCOMACF2, user security exit sample JCL • 406
XCOMADM, sample JCL • 388
XCOMADMT, sample table • 385
XCOMCNTL data set name, Selection menu • 29
XCOMDFLT, sample macro • 382
XCOMDPJ, user exit calling module • 422
XCOMDSPL, user exit calling module • 422
XCOMENCR, sample JCL • 408
encrypt SYSIN01 LPASS • 408
encrypt SYSIN01 PASSWORD • 408
XCOMEX01, sample • 416
XCOMEX04, sample • 422
XCOMEX05, sample • 424
XCOMEX06, sample • 427
XCOMEX07, sample • 430
XCOMEX08, sample • 432
XCOMEX09, sample • 434
XCOMEX10, sample • 436
XCOMEX12, sample • 438
XCOMEX13, sample • 440
XCOMEXIT, user exit calling module • 427, 430
XCOMFCT, sample JCL • 411
XCOMFILE, user exit calling module • 424
XCOMGLOB, DD statement • 165
XCOMHIST, sample JCL • 365
XCOMINQ
DD statement • 165
sample JCL • 374
XCOMJOB • 160
return codes • 264
sample JCL • 160
TYPE=EXECUTE • 161
TYPE=EXECUTE JCL sample • 392
TYPE=INQUIRE • 161
TYPE=SCHEDULE • 160, 161
TYPE=SCHEDULE JCL sample • 393
XCOMJOBE, sample program • 392
XCOMJOBS, sample program • 393
XCOMJOXI, sample JCL • 398
XCOMJOXS, sample JCL • 394
XCOMLSR, sample JCL • 390
XCOMMODE, sample entries • 377
XCOMOPER, user exit calling module • 422
XCOMPCT, sample JCL CICS
XCOMPCT sample JCL • 412
XCOMPLEX
maximum entries, operator control
parameter • 147
PARM parameter • 186
sample JCL • 386
XCOMPLEX Admin Server
sample JCL • 388
sample TYPE=INQUIRE transfer • 398
sample TYPE=SCHEDULE transfer • 394
XCOMPPT, sample JCL CICS
XCOMPPT sample JCL • 413
XCOMPSOI, user exit calling module • 418, 420
XCOMRECV, user exit calling module • 436, 438,
440
XCOMREST
DD statement • 166
sample JCL • 373
XCOMSAMP, sample transaction • 391
XCOMTABL, sample table • 377
XCOMTCT, sample JCL • 414
XCOMTOPS
assembling • 404
user security exit sample JCL • 404
XCOMUP2F, user exit calling module • 436
XCOMUPL2, user exit calling module • 436
XCOMUPL6, user exit calling modules • 436
XCOMUTIL
history file purge utility • 356
required JCL • 358
sample JCL • 359, 368
XCOMUTIL parameters • 356
AGE • 357
DATE • 357
PROCESS • 358
XCOMXFER, user exit calling module • 416, 432,
434
XCPF
defining XCOMPLEX structure sample JCL •
387
XCOMPLEX definition to Coupling Facility
sample JCL • 386
XFERID, attribute label • 150
XID, attribute label • 150
XRSHOW, MODIFY command • 338
XSHOW, MODIFY command • 339
XTC • 256
coding example • 261
XTCERRDECR, SYSIN01 parameter • 257
XTCERRINCR, SYSIN01 parameter • 257
XTCERRPURGE, SYSIN01 parameter • 257
XTCERRREL, SYSIN01 parameter • 258
XTCGOODDECR, SYSIN01 parameter • 258
XTCGOODINCR, SYSIN01 parameter • 258
XTCGOODPURGE, SYSIN01 parameter • 259
XTCGOODREL, SYSIN01 parameter • 259
XTCJOB, SYSIN01 parameter • 259
XTCNET, SYSIN01 parameter • 260
XTRACE, MODIFY command • 340
Index 457
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising