User Guide

r11

Unicenter

CA-XCOM

Data

Transport

for Windows NT

Server/Professional

J02577-2E

This documentation and related computer software program (hereinafter referred to as the “Documentation”) is for the end user’s informational purposes only and is subject to change or withdrawal by Computer Associates International, Inc. (“CA”) at any time.

This documentation may not be copied , transferred , reproduced , d isclosed or duplicated , in whole or in part, w ithout the prior written consent of CA. This documentation is 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 this documentation for their own internal use, provided that all CA copyright notices and legends are affixed t o each reproduced copy. Only authorized employees, consultants, or agents of the user who are bound by the confidentiality provisions of the license for the software are permitted to have access to such copies.

This right to print copies is limited to the period during which the 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 return to CA the reproduced copies or to certify to CA that same have been destroyed .

To the extent permitted by applicable law, CA provides this documentation “as is” without warranty of any kind , includ ing 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, d irect or ind irect, from the use of this documentation, includ ing 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 this documentation and this documentation is governed by the end user’s applicable license agreement.

The manufacturer of this documentation is Computer Associates International, Inc.

Provided with “Restricted Rights” as set forth in 48 C.F.R. Section 12.212, 48 C.F.R. Sections 52.227-19(c)(1) and (2) or DFARS Section 252.227-7013(c)(1)(ii) or applicable successor provisions.

2011 Computer Associates International, Inc.

All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

Contents

Chapter 1: Introduction Unicenter CA-XCOM Data Transport Connectivity .............................................. 1-2 Network Levels in the SNA Model ............................................................. 1-3

End User Level ........................................................................... 1-3 Logical Level ............................................................................. 1-4 Physical Level ............................................................................ 1-4 Network Level Diagram ................................................................... 1-5 Benefits of LU 6.2 (APPC).................................................................. 1-5

Improved Throughput................................................................. 1-6 Support for Advanced Networking ..................................................... 1-6

Unicenter CA-XCOM Data Transport in the TCP/IP Network..................................... 1-7 TCP/IP Protocol Stack..................................................................... 1-7

Network Layer........................................................................ 1-8 Internetwork Layer.................................................................... 1-8 Transport Layer ....................................................................... 1-8 Application Layer ..................................................................... 1-9

Unicenter CA-XCOM Data Transport Nodes in the TCP/IP Network .......................... 1-9 TCP/IP Address ...................................................................... 1-9 TCP/IP Port .......................................................................... 1-9

Successful Send File Transfer Scenario ......................................................... 1-10

Chapter 2: Using Unicenter CA-XCOM Data Transport Unicenter CA-XCOM Data Transport GUI ...................................................... 2-1

File Name, Path, and Directory Considerations .............................................. 2-1 Keyboard Commands ................................................................. 2-2

Default Directories and Drives ............................................................. 2-2 Requirements............................................................................. 2-3

Starting Unicenter CA-XCOM Data Transport ................................................... 2-3

Contents iii

Using the Unicenter CA-XCOM Data Transport Main Window .................................... 2-5 Main Window............................................................................. 2-5 Considerations ............................................................................ 2-6 Procedure................................................................................. 2-6 Menu Bar Selections ....................................................................... 2-7 Pushbuttons .............................................................................. 2-8

Using Transfer Configuration Files.............................................................. 2-9 Default Configuration Files................................................................. 2-9 Precedence of Parameter Values ........................................................... 2-10 Modifying Options and Configurations..................................................... 2-10 Multiple Transfers from the GUI ........................................................... 2-10 Considerations ........................................................................... 2-11

Creating a Configuration File.................................................................. 2-11 Considerations ........................................................................... 2-11 Procedure................................................................................ 2-12

Editing an Existing Configuration File.......................................................... 2-14 Considerations ........................................................................... 2-14 Procedure................................................................................ 2-15

Using the Transfer List to Access and Perform Transfers ......................................... 2-16 Transfer List Fields ....................................................................... 2-17 Saving Displayed Transfers................................................................ 2-17 Considerations ........................................................................... 2-17 Procedure................................................................................ 2-18 Fields ................................................................................... 2-19 Transfer List Symbols ..................................................................... 2-19

Using the Edit Transfer Windows.............................................................. 2-20 Accessing the Edit Transfer Window ....................................................... 2-20 Menu Bar Selections ...................................................................... 2-21 Pushbuttons ............................................................................. 2-21 Fields ................................................................................... 2-22 RECORD_FORMAT ...................................................................... 2-26

Setting the Options on an Edit Transfer Window ................................................ 2-28 Modifying the Options Group ............................................................. 2-29 Encoding Options ........................................................................ 2-29 Maximum Record Length Field ............................................................ 2-30 CodeTable Option ........................................................................ 2-30 Truncation Option........................................................................ 2-31 Procedure................................................................................ 2-31 Edit Transfer Window Options Summary ................................................... 2-32

iv User Guide

Sending a File Using an Edit Transfer Window ................................................. 2-33 Accessing the Send File Window .......................................................... 2-33 Considerations........................................................................... 2-34 Procedure ............................................................................... 2-34

Sending a Report Using an Edit Transfer Window .............................................. 2-35 Accessing the Send Report Window ....................................................... 2-35 Considerations........................................................................... 2-36 Procedure ............................................................................... 2-36

Sending a Job Using an Edit Transfer Window.................................................. 2-37 Accessing the Send Job Window........................................................... 2-37 Considerations........................................................................... 2-38 Procedure ............................................................................... 2-38

Receiving a File Using an Edit Transfer Window................................................ 2-39 Accessing the Receive File Window........................................................ 2-39 Considerations........................................................................... 2-39 Procedure ............................................................................... 2-40

Using the Version 2 Window—Checkpoint, Restart, Protocol, Port................................ 2-41 Accessing the Version 2 Window .......................................................... 2-41 Considerations........................................................................... 2-42 Procedure – Checkpoint/Restart........................................................... 2-42 Procedure – Protocol/Port ................................................................ 2-43 Fields ................................................................................... 2-43 Pushbuttons ............................................................................. 2-44

Specifying User IDs and Passwords for File Access.............................................. 2-44 Accessing the Security Window ........................................................... 2-45 Considerations........................................................................... 2-45 Procedure ............................................................................... 2-45 Remote System Access Fields ............................................................. 2-46 Local File Access Fields ................................................................... 2-46 Pushbuttons ............................................................................. 2-46

Notifying Local Users of Transfer Completion .................................................. 2-47 Accessing the Local Notify Dialog ......................................................... 2-47 Considerations........................................................................... 2-47 Procedure ............................................................................... 2-47 Drop-down Lists......................................................................... 2-48 Field .................................................................................... 2-48 Pushbuttons ............................................................................. 2-49

Contents v

Notifying Remote Users of Transfer Completion ................................................ 2-49 Accessing the Remote Notify Dialog........................................................ 2-49 Considerations ........................................................................... 2-49 Procedure................................................................................ 2-50 Drop-down List .......................................................................... 2-50 Field .................................................................................... 2-51 Pushbuttons ............................................................................. 2-51

Setting Compression Type for a Transfer ....................................................... 2-52 Accessing the Compression Window ....................................................... 2-52 Considerations ........................................................................... 2-52 Procedure................................................................................ 2-52 Drop-down List .......................................................................... 2-53 Pushbuttons ............................................................................. 2-53

Sending an Indirect Transfer .................................................................. 2-54 Accessing the Indirect Transfer Window.................................................... 2-54 Considerations ........................................................................... 2-54 Procedure................................................................................ 2-54 Field .................................................................................... 2-55 Pushbuttons ............................................................................. 2-55

Setting System Environment Variables—Reports Containing Machine Code Characters ............. 2-55 Debugging Problems and Tracing.............................................................. 2-57

Accessing the Debugging Window ......................................................... 2-57 Procedure................................................................................ 2-57 Drop-down List .......................................................................... 2-57 Pushbuttons ............................................................................. 2-58

Scheduling Transfers ......................................................................... 2-58 Accessing the Schedule Window ........................................................... 2-58 Considerations ........................................................................... 2-59 Procedure................................................................................ 2-59 Priority Menu Options .................................................................... 2-60 Fields ................................................................................... 2-60 Pushbuttons ............................................................................. 2-60

Performing Secure Socket Transfers ............................................................ 2-61 Accessing the Secure Socket Window....................................................... 2-61 Procedure................................................................................ 2-61 Pushbuttons ............................................................................. 2-62

Browsing the Log File......................................................................... 2-62 Accessing the Log Browser Window........................................................ 2-63 Procedure................................................................................ 2-63 Pushbuttons ............................................................................. 2-63

vi User Guide

Searching for Information in the Log........................................................... 2-63 Accessing the Find Window............................................................... 2-64 Procedure ............................................................................... 2-64 Field .................................................................................... 2-64 Checkbox ............................................................................... 2-64 Pushbuttons ............................................................................. 2-65

Viewing and Controlling Transfer Status....................................................... 2-65 Accessing the Queue Status Window ...................................................... 2-66 Procedure ............................................................................... 2-66 Menu Bar Selections...................................................................... 2-67 Pushbuttons ............................................................................. 2-68 Queue Status Direction Symbols........................................................... 2-68

Viewing Transfer Status Details ............................................................... 2-69 Accessing the Details Window ............................................................ 2-69 Procedure ............................................................................... 2-69 Fields ................................................................................... 2-70 Pushbutton.............................................................................. 2-70

Using the Properties Dialog Pages ............................................................. 2-70 Accessing the Properties Tab Pages ........................................................ 2-71 Considerations........................................................................... 2-72 Procedure ............................................................................... 2-72 Character Conversions Properties Tab Page ................................................ 2-73

Options ............................................................................. 2-74 Incoming Transfers Properties Tab Page.................................................... 2-75

Options ............................................................................. 2-76 Queue Properties Tab Page ............................................................... 2-77

Options ............................................................................. 2-78 Security Properties Tab Page .............................................................. 2-79

Options ............................................................................. 2-80 System Properties Tab Page ............................................................... 2-81

Options ............................................................................. 2-82 TCP/IP Properties Tab Page .............................................................. 2-84

Options ............................................................................. 2-85 Trace Properties Tab Page................................................................. 2-88

Options ............................................................................. 2-89

Contents vii

Chapter 3: The Command Line Interface Command Prompt ............................................................................ 3-1 Using Configuration Files ...................................................................... 3-1

Configuration Files ........................................................................ 3-2 Creating Configuration Files from the Command Prompt ..................................... 3-2

Transferring Files ............................................................................. 3-4 Specifying Protocols ....................................................................... 3-4 XCOM62 ................................................................................. 3-5 XCOMTCP................................................................................ 3-5 Multiple Transfers ......................................................................... 3-5 Wildcard Characters ....................................................................... 3-5 Syntax.................................................................................... 3-5

Syntax for XCOM62.................................................................... 3-5 Syntax for XCOMTCP .................................................................. 3-6 Notes On Using Options................................................................ 3-6

Options................................................................................... 3-6 Transferring Files Using SNA/APPC Protocols .................................................. 3-8

Using SNA/APPC Protocols................................................................ 3-8 Transferring Files Using TCP/IP Protocols....................................................... 3-9

Using IP Addresses and Names ............................................................. 3-9 Specifying the Remote System ............................................................. 3-10 TCP/IP Name Resolution ................................................................. 3-11 Using TCP/IP Protocols with Unicenter CA-XCOM Data Transport ........................... 3-11

PROTOCOL.......................................................................... 3-13 Setting Communications Parameters ........................................................... 3-13

Communications and Data Transfer Parameters ............................................. 3-13 Parameters............................................................................... 3-14

CODETABL.......................................................................... 3-14 COMPRESS .......................................................................... 3-14 MAXRECLEN ........................................................................ 3-15 REMOTE_SYSTEM ................................................................... 3-15 REMOTE_SYSTEM_RF................................................................ 3-16 REMOTE_SYSTEM_SJ ................................................................ 3-16 REMOTE_SYSTEM_SR................................................................ 3-16 TEMPDIR............................................................................ 3-17 TRUNCATION....................................................................... 3-17 VERSION ............................................................................ 3-17

viii User Guide

Using the Send File Command ................................................................ 3-17 Parameters .............................................................................. 3-18

FILE_OPTION ....................................................................... 3-18 LOCAL_FILE ........................................................................ 3-20 REMOTE_FILE ...................................................................... 3-20

Using the Retrieve File Command ............................................................. 3-20 Parameters .............................................................................. 3-21

FILE_OPTION_RF ................................................................... 3-21 LOCAL_FILE_RF .................................................................... 3-23 REMOTE_FILE_RF ................................................................... 3-23 REMOTE_SYSTEM_RF ............................................................... 3-23 UNIT_RF ............................................................................ 3-24 VOLUME_RF ........................................................................ 3-24

Creating a File on an IBM Mainframe .......................................................... 3-24 Parameters .............................................................................. 3-25

ALLOCATION_TYPE ................................................................ 3-25 BLKSIZE ............................................................................ 3-25 DATACLAS ......................................................................... 3-26 DSNTYPE ........................................................................... 3-26 LRECL .............................................................................. 3-26 MGMTCLAS ........................................................................ 3-27 NUM_OF_DIR_BLOCKS.............................................................. 3-27 PRIMARY_ALLOC................................................................... 3-27 RECORD_FORMAT .................................................................. 3-28 SECURE_SOCKET ................................................................... 3-29 STORCLAS .......................................................................... 3-30 SECONDARY_ALLOC ............................................................... 3-30 UNIT ............................................................................... 3-30 VOLUME ........................................................................... 3-30 XCOM_CONFIG_SSL ................................................................ 3-30 XCOM_SHOW_CIPHER.............................................................. 3-31

Tape Parameters for an IBM Mainframe .................................................... 3-31 DEN ................................................................................ 3-31 EXPDT .............................................................................. 3-32 LABEL .............................................................................. 3-32 LABELNUM......................................................................... 3-33 RETPD .............................................................................. 3-33 TAPE ............................................................................... 3-33 UNITCT............................................................................. 3-34 VOLCT.............................................................................. 3-34 VOLSQ.............................................................................. 3-34

Contents ix

Using a Send Report Command ............................................................... 3-35 Parameters............................................................................... 3-36

CARRIAGE_CONTROL_CHARACTERS ............................................... 3-36 CLASS............................................................................... 3-36 COPIES .............................................................................. 3-37 DESTINATION....................................................................... 3-37 DISPOSITION ........................................................................ 3-37 FCB ................................................................................. 3-38 FORM ............................................................................... 3-38 HOLDFLAG ......................................................................... 3-38 LOCAL_FILE_SR ..................................................................... 3-38 REMOTE_SYSTEM_SR................................................................ 3-39 REPORT_TITLE ...................................................................... 3-39 SPOOL_FLAG........................................................................ 3-40

Using the Send Job Command ................................................................. 3-40 LOCAL_FILE_SJ...................................................................... 3-41 REMOTE_SYSTEM_SJ ................................................................ 3-41

ERRORLEVEL Return Codes from xcomtcp.exe and xcom62.exe.................................. 3-41 Tracing Problems ............................................................................ 3-42

XTRACE ............................................................................. 3-43 Setting Up Log Files .......................................................................... 3-43

XLOGFILE ........................................................................... 3-44 Setting File Type Conversion .................................................................. 3-44

CARRIAGE_FLAG.................................................................... 3-45 CODE_FLAG......................................................................... 3-46

Creating Custom Character Sets for File Conversion ............................................. 3-47 Custom Character Sets .................................................................... 3-47

Procedure............................................................................ 3-47 Hexadecimal Numbers in Conversion Tables................................................ 3-48 Customizing Default Character Sets ........................................................ 3-49

Procedure............................................................................ 3-49 Specifying a Custom Character Set ......................................................... 3-49

Procedure............................................................................ 3-50 Using Store and Forward ..................................................................... 3-50

XIDEST .............................................................................. 3-52 Setting Password and User ID Security ......................................................... 3-52

DOMAIN ............................................................................ 3-53 FILE_ACCESS_PASSWORD ........................................................... 3-53 FILE_ACCESS_USERNAME........................................................... 3-53 PASSWORD ......................................................................... 3-53

x User Guide

TRUSTED ........................................................................... 3-53 USERID ............................................................................. 3-54

Encrypting Parameter Values in Existing Configuration Files .................................... 3-54 Syntax .................................................................................. 3-54 Options ................................................................................. 3-55 Procedure ............................................................................... 3-55 Changing an Encrypted Value............................................................. 3-56

Scheduling Locally Initiated Transfers ......................................................... 3-56 Parameters .............................................................................. 3-57

PRIORITY ........................................................................... 3-57 QUEUE ............................................................................. 3-57 START_DATE ....................................................................... 3-58 START_TIME ........................................................................ 3-58

Notifying of Transfer Completion ............................................................. 3-59 Example 1 ............................................................................... 3-59 Example 2 ............................................................................... 3-59 Parameters .............................................................................. 3-60

LCLNTFYL .......................................................................... 3-60 LOCAL_NOTIFY..................................................................... 3-60 NOTIFYL............................................................................ 3-61 NOTIFY_NAME ..................................................................... 3-61 NOTIFYR ........................................................................... 3-62 RMTNTFYL ......................................................................... 3-63

Checkpointing and Restarting Transfers ....................................................... 3-63 List of Parameters........................................................................ 3-65

CHECKPOINT_COUNT .............................................................. 3-65 NUMBER_OF_RETRIES .............................................................. 3-65 RESTART_SUPPORTED .............................................................. 3-65 RETRY_TIME........................................................................ 3-66

Purging the Unicenter CA-XCOM Data Transport Log File ...................................... 3-66 Syntax .................................................................................. 3-66

Chapter 4: The Application Programming Interface XcomAPI .................................................................................... 4-1 XcomQAPI................................................................................... 4-2 Upgrading from Previous Releases ............................................................. 4-2 Link Libraries ................................................................................ 4-2

SNA Libraries ............................................................................ 4-2 TCP/IP Libraries.......................................................................... 4-3

Starting States ................................................................................ 4-3

Contents xi

Starting States in startst.h ...................................................................... 4-3 API Control Block Structure .................................................................... 4-4 Using API Member Names ..................................................................... 4-8

XcomAPI Member Names .................................................................. 4-8 allocation_type ........................................................................ 4-8 blksize................................................................................ 4-9 carriage_control_characters ............................................................. 4-9 carriage_flag ......................................................................... 4-10 checkpoint_count ..................................................................... 4-10 class ................................................................................. 4-11 code_flag ............................................................................ 4-11 codetabl ............................................................................. 4-11 compress............................................................................. 4-12 config_ssl ............................................................................ 4-13 convert_classes ....................................................................... 4-13 copies ............................................................................... 4-13 datacls............................................................................... 4-13 debug_flag ........................................................................... 4-13 den.................................................................................. 4-14 destination ........................................................................... 4-14 disposition ........................................................................... 4-14 domain .............................................................................. 4-15 dsntype.............................................................................. 4-15 eol_classes ........................................................................... 4-15 expdt ................................................................................ 4-15 fcb .................................................................................. 4-16 file_option ........................................................................... 4-16 file_type ............................................................................. 4-17 form................................................................................. 4-17 hold ................................................................................. 4-18 label ................................................................................. 4-18 labelnum............................................................................. 4-18 lclntfyl............................................................................... 4-19 local_file ............................................................................. 4-19 local_file_rf .......................................................................... 4-19 local_file_sj........................................................................... 4-20 local_file_sr .......................................................................... 4-20 local_notify .......................................................................... 4-20 lrecl ................................................................................. 4-21 maxreclen............................................................................ 4-21 metacode_classes ..................................................................... 4-21

xii User Guide

mgtclas.............................................................................. 4-22 notify_name ......................................................................... 4-22 notifyl............................................................................... 4-22 notifyr .............................................................................. 4-23 notify_term .......................................................................... 4-24 number_of_retries.................................................................... 4-24 num_of_dir_blocks ................................................................... 4-24 password............................................................................ 4-24 primary_alloc ........................................................................ 4-25 port ................................................................................. 4-25 protocol ............................................................................. 4-25 queue ............................................................................... 4-26 record_format........................................................................ 4-26 remote_file .......................................................................... 4-28 remote_file_rf........................................................................ 4-28 remote_system....................................................................... 4-28 remove_trail_blanks .................................................................. 4-29 report_title .......................................................................... 4-29 restart_supported .................................................................... 4-29 retpd................................................................................ 4-30 rmtntfyl ............................................................................. 4-30 secondary_alloc ...................................................................... 4-30 shell_cmd ........................................................................... 4-31 spool_flag ........................................................................... 4-31 start_date............................................................................ 4-31 start_time ........................................................................... 4-31 stat_frequency ....................................................................... 4-32 storcls ............................................................................... 4-32 tape................................................................................. 4-32 tempdir ............................................................................. 4-32 transfer_id........................................................................... 4-33 transfer_usr_data..................................................................... 4-33 truncation ........................................................................... 4-33 trusted .............................................................................. 4-33 unit ................................................................................. 4-34 unitct ............................................................................... 4-34 userid ............................................................................... 4-34 user_data............................................................................ 4-34 version .............................................................................. 4-34 volct ................................................................................ 4-35 volsq................................................................................ 4-35

Contents xiii

volume .............................................................................. 4-35 xcomfullssl........................................................................... 4-35 xendcmd............................................................................. 4-36 xidest................................................................................ 4-36 xlogfile .............................................................................. 4-36 xlpcmd .............................................................................. 4-36 xmode ............................................................................... 4-37 xnotifycmd........................................................................... 4-37 xppcmd.............................................................................. 4-37 xprecmd ............................................................................. 4-37 xtrace................................................................................ 4-38

Using XcomQAPI Option Parameters .......................................................... 4-38 Option Parameters........................................................................ 4-38

funccode ............................................................................. 4-38 Parameters Set Within the XcomQAPI Program ............................................. 4-40

API Examples................................................................................ 4-40 About the XcomAPI Example.............................................................. 4-40

Unicenter CA-XCOM Data Transport for Windows NT API Return Codes ................. 4-41 XcomQAPI Example ...................................................................... 4-43

Chapter 5: Remote System Information AS/400....................................................................................... 5-1

Naming Conventions ...................................................................... 5-1 Types of Files Supported ................................................................... 5-2 Additional Features........................................................................ 5-2 Configuration Issues ....................................................................... 5-2 Case Sensitivity ........................................................................... 5-2

z/OS......................................................................................... 5-3 Naming Conventions ...................................................................... 5-3 Types of Files Supported ................................................................... 5-4 DCB Information .......................................................................... 5-4 Additional Features........................................................................ 5-5

Novell NetWare............................................................................... 5-5 Naming Conventions ...................................................................... 5-5 Types of Files Supported ................................................................... 5-6 Destination Printer Information............................................................. 5-6 Restriction ................................................................................ 5-6

OpenVMS .................................................................................... 5-7 Naming Conventions ...................................................................... 5-7 Restrictions ............................................................................... 5-8

xiv User Guide

Stratus/System 88 ............................................................................ 5-9 Naming Conventions...................................................................... 5-9 Types of Files Supported.................................................................. 5-10 Additional Features ...................................................................... 5-10 Restrictions.............................................................................. 5-10

Tandem..................................................................................... 5-11 Naming Conventions..................................................................... 5-11 Types of Files Supported.................................................................. 5-11 File Type Specification.................................................................... 5-12 Remotely-Initiated Send Requests ......................................................... 5-13

UNIX....................................................................................... 5-13 Naming Conventions..................................................................... 5-13 Types of Files Supported.................................................................. 5-13 Restriction............................................................................... 5-14

VM......................................................................................... 5-14 Naming Conventions..................................................................... 5-14 Types of Files Supported.................................................................. 5-14 DCB Information......................................................................... 5-15 Restriction............................................................................... 5-15

VSE ........................................................................................ 5-16 VSAM Naming Conventions .............................................................. 5-16 SAM Naming Conventions ............................................................... 5-17 TAPE Naming Conventions............................................................... 5-19 DTF Information ......................................................................... 5-20 Types of Files Supported.................................................................. 5-20 Restrictions.............................................................................. 5-20

Windows ................................................................................... 5-21 Naming Conventions..................................................................... 5-21 Restriction............................................................................... 5-22

Windows NT Server/Professional ............................................................. 5-22 Naming Conventions..................................................................... 5-23 Types of Files Supported.................................................................. 5-24 Additional Features ...................................................................... 5-24 Destination Printer Information ........................................................... 5-25 Restrictions.............................................................................. 5-25

Contents xv

Chapter 6: Performance Tuning

Appendix A: Unicenter CA-XCOM Data Transport Parameters Parameter Values Used in the GUI ............................................................. A-2 Parameter Values Used at the Command Prompt................................................ A-3

Parameter Format for Command Prompt and Scripts ........................................ A-3 Syntax................................................................................... A-4 Guidelines ............................................................................... A-4

List of Unicenter CA-XCOM Data Transport Parameters ......................................... A-5 Version 2 Parameters ..................................................................... A-5 AGE_TIME .............................................................................. A-5 ALLOCATION_TYPE..................................................................... A-6 ATOE_FILENAME ....................................................................... A-6 BLKSIZE ................................................................................ A-6 CARRIAGE_CONTROL_CHARACTERS ................................................... A-7 CARRIAGE_FLAG ....................................................................... A-7 CHECKPOINT_COUNT .................................................................. A-8 CLASS .................................................................................. A-9 CODE_FLAG ............................................................................ A-9 CODETABL............................................................................. A-10 COMPRESS............................................................................. A-10 CONTROL.............................................................................. A-11 CONVERT_CLASSES.................................................................... A-11 COPIES................................................................................. A-11 CREATE_DIRECTORIES ................................................................. A-12 DAEMON_TIMEOUT ................................................................... A-12 DATACLAS ............................................................................ A-12 DEBUG_FLAG .......................................................................... A-12 DEN ................................................................................... A-13 DESTINATION ......................................................................... A-13 DESTINATION_TYPE ................................................................... A-13 DISPOSITION........................................................................... A-14 DOMAIN............................................................................... A-14 DSNTYPE .............................................................................. A-14 EOL_CLASSES .......................................................................... A-15 ETOA_FILENAME ...................................................................... A-15 EXPDT ................................................................................. A-15 EXPIRATION_TIME..................................................................... A-15

xvi User Guide

FCB.....................................................................................A-16 FILE_ACCESS_PASSWORD ..............................................................A-16 FILE_ACCESS_USERNAME ..............................................................A-16 FILE_OPTION ...........................................................................A-16 FILE_OPTION_RF .......................................................................A-18 FORM ..................................................................................A-19 HOLDFLAG.............................................................................A-19 IMPLICIT_PACKING ....................................................................A-20 INTERNAL_CONVERSION_TABLES .....................................................A-20 LABEL..................................................................................A-20 LABELNUM ............................................................................A-21 LCLNTFYL..............................................................................A-21 LOCAL_FILE............................................................................A-22 LOCAL_FILE_RF ........................................................................A-22 LOCAL_FILE_SJ .........................................................................A-22 LOCAL_FILE_SR ........................................................................A-23 LOCAL_NOTIFY ........................................................................A-23 LRECL..................................................................................A-23 MAIL_USERNAME ......................................................................A-24 MAX_QUEUE_ENTRIES .................................................................A-24 MAX_SESSIONS_ENTRIES ...............................................................A-24 MAXRECLEN ...........................................................................A-25 METACODE_CLASSES ..................................................................A-25 MGMTCLAS ............................................................................A-25 NOTIFY_NAME .........................................................................A-26 NOTIFYL ...............................................................................A-26 NOTIFYR ...............................................................................A-27 NOTIFY_TERM..........................................................................A-28 NUMBER_OF_RETRIES ..................................................................A-28 NUM_OF_DIR_BLOCKS .................................................................A-28 PASSWORD.............................................................................A-28 PORT ...................................................................................A-29 PRIMARY_ALLOC ......................................................................A-29 PRIORITY...............................................................................A-29 PROTOCOL .............................................................................A-30 QUEUE .................................................................................A-30 QUEUE_PATH ..........................................................................A-30 RECORD_FORMAT......................................................................A-31 REMOTE_FILE ..........................................................................A-32 REMOTE_FILE_RF.......................................................................A-32 REMOTE_SYSTEM.......................................................................A-33

Contents xvii

REMOTE_SYSTEM_RF .................................................................. A-33 REMOTE_SYSTEM_SJ ................................................................... A-33 REMOTE_SYSTEM_SR................................................................... A-34 REMOVE_TRAIL_BLANKS .............................................................. A-34 REPORT_TITLE ......................................................................... A-34 RESTART_SUPPORTED ................................................................. A-35 RETPD ................................................................................. A-35 RETRY_TIME ........................................................................... A-35 RMTNTFYL............................................................................. A-36 SECONDARY_ALLOC .................................................................. A-36 SECURE_SOCKET....................................................................... A-36 SESSIONS_FILE ......................................................................... A-37 SHELL_CMD ........................................................................... A-37 SOCK_DELAY .......................................................................... A-37 SOCK_RCV_BUF_SIZE .................................................................. A-38 SOCK_SEND_BUF_SIZE ................................................................. A-38 SPACE ................................................................................. A-39 SPOOL_FLAG .......................................................................... A-39 START_DATE........................................................................... A-39 START_TIME ........................................................................... A-40 STAT_FREQUENCY..................................................................... A-40 STORCLAS ............................................................................. A-40 TAPE................................................................................... A-40 TCP_CMD .............................................................................. A-41 TEMPDIR............................................................................... A-41 TP_CMD ............................................................................... A-41 TRACE_PATH .......................................................................... A-41 TRANSFER_ID.......................................................................... A-42 TRANSFER_TYPE ....................................................................... A-42 TRANSFER_USR_DATA................................................................. A-42 TRUNCATION.......................................................................... A-43 TRUSTED .............................................................................. A-43 TXPI_BUF_SIZE......................................................................... A-43 TXPI_RECEIVE_TIMEOUT............................................................... A-44 TXPI_SEND_CHECK_FREQ.............................................................. A-44 TXPI_TERM_TIMEOUT.................................................................. A-44 UNIT................................................................................... A-45 UNITCT ................................................................................ A-45 UNIT_RF ............................................................................... A-45 USER_DATA ........................................................................... A-45

xviii User Guide

USERID.................................................................................A-45 VERSION ...............................................................................A-46 VOLCT .................................................................................A-46 VOLSQ .................................................................................A-46 VOLUME ...............................................................................A-46 VOLUME_RF............................................................................A-47 WRITE_EOF.............................................................................A-47 XBUFFSIZE .............................................................................A-47 XCOM_CONFIG_SSL ....................................................................A-47 XCOM_PASSWORD .....................................................................A-47 XCOM_SHOW_CIPHER..................................................................A-48 XCOM_USERID .........................................................................A-48 XENDCMD .............................................................................A-48 XIDEST .................................................................................A-49 XLOGFILE ..............................................................................A-49 XLPCMD................................................................................A-49 XLUNAME..............................................................................A-49 XMODE.................................................................................A-50 XNODESPEC............................................................................A-50 XNOTIFYCMD ..........................................................................A-50 XPPCMD................................................................................A-50 XPRECMD ..............................................................................A-51 XTRACE ................................................................................A-51

Appendix B: Messages Error Message Example ....................................................................... B-1

Message ID Content ....................................................................... B-1 List of Messages .............................................................................. B-3

Service-Specific Messages................................................................. B-61

Appendix C: Logical Units Physical Network Components ................................................................ C-1 Logical Network Components ................................................................. C-2

Session................................................................................... C-2 PCID................................................................................. C-2 SID .................................................................................. C-2

Logical Unit Types............................................................................ C-3

Contents xix

Criteria for Independent Logical Units ......................................................... C-4 Systems Supporting ILUs ................................................................. C-4 Software Version Support for ILUs ......................................................... C-4 LU 6.2 Independent Implementations ...................................................... C-5 Direct Sessions with Dependent Logical Unit................................................ C-5 PU Type ................................................................................. C-5

Index

xx User Guide

Chapter

1 Introduction

This guide provides information about the use of the Unicenter® CA-XCOM® Data Transport® product with Microsoft Windows NT Server/Professional (2000, 2003, and XP). Its scope ranges from an overview of the software to descriptions of the parameters required to execute Unicenter CA-XCOM Data Transport functions. Although there are extensive similarities between all of the Unicenter CA-XCOM Data Transport components, you should always refer to the corresponding user’s guide when requiring specific information about a component.

Introduction 1–1

Unicenter CA-XCOM Data Transport Connectivity

Unicenter CA-XCOM Data Transport Connectivity The following diagram shows how Unicenter CA-XCOM Data Transport can provide connectivity across very diverse environments. Any client node using Unicenter CA-XCOM Data Transport can send and receive files from any of the remote systems shown in this example or any other Unicenter CA-XCOM Data Transport component. For more information, see the section Modular Support of Most Systems in the chapter “Welcome” in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Getting Started.

1–2 User Guide

Network Levels in the SNA Model

Network Levels in the SNA Model An SNA network is divided into levels of physical and logical components. A path control network that runs over the physical components interconnects the logical components.

As data is passed up and down the SNA functional layers, each layer performs a set of control functions and adds control information to the data in the form of a header. The headers do not change the information in the data, but communicate with the next layer of SNA to ensure that the data is understood.

As the data is passed through the layers, headers that are added at one end of the network are stripped off and read by the receiving end. Thus, when the data reaches its final destination, it is back to its original form.

End User Level

The end user level consists of transaction programs (like Unicenter CA-XCOM Data Transport) that communicate with other transaction programs using LUs. In a Unicenter CA-XCOM Data Transport transfer request, the local end user specifies the following:

■ Type of transfer (send report, file, or job, or receive file)

■ Name of the local file

■ Name of the remote file to create, append, or replace

The request is then processed by the Unicenter CA-XCOM Data Transport transaction program on the local system that sends an allocate verb and header record to the remote system to establish an LU 6.2 session. When a session is established and all of the parameters are confirmed by the remote system, Unicenter CA-XCOM Data Transport on the local system will send the file, broken into data records, across the physical connection.

The remote Unicenter CA-XCOM Data Transport transaction program is then invoked by the allocate verb sent by the local system (some systems cannot be automatically invoked and must already be active to receive the allocate verb). The remote transaction program then creates or opens the requested file, receives the data records, and places them in the file. When all the records have been received, Unicenter CA-XCOM Data Transport on the remote system will send a trailer record to the local system stating the number of records transmitted.

Introduction 1–3

Network Levels in the SNA Model

Logical Level

The logical level consists of logical units (LUs) that link the physical units (PUs) and transaction programs (TPs). Each Unicenter CA-XCOM Data Transport user should be assigned a unique LU name for gateway or workstation identification. Each data record traveling across the line will contain LU 6.2 protocol information containing instructions for the remote system.

Physical Level

The physical level consists of physical unit (PU) nodes linked by a physical connection. Unicenter CA-XCOM Data Transport supports transfers between physically connected systems whether they are directly or indirectly connected. PU Type 2.1 nodes can make a direct logical link even without a direct physical connection. Transfers involving PU Type 2.0 nodes (like VAX/VMS) can be made using the store-and-forward feature of Unicenter CA-XCOM Data Transport.

1–4 User Guide

Network Levels in the SNA Model

Network Level Diagram

The following diagram shows the various network levels used to communicate with Unicenter CA-XCOM Data Transport:

END USER LEVEL

LOGICALLEVEL

PHYSICALLEVEL

LocalUser

Remote User

Physical Connection

Physical Unit Node

PhysicalUnit Node

LU 6.2 LU 6.2

Unicenter CA-XCOM

Data Transport

Unicenter CA-XCOM

Data Transport

Benefits of LU 6.2 (APPC)

Unicenter CA-XCOM Data Transport is built upon the LU 6.2 protocol. LU 6.2 is also known as Advanced Program-to-Program Communications (APPC) and is IBM’s most powerful enhancement to the Systems Network Architecture (SNA) suite of communications protocols.

Introduction 1–5

Network Levels in the SNA Model

Improved Throughput

When Unicenter CA-XCOM Data Transport uses the LU 6.2 protocol, it does not place hardware restrictions on the size of the data that it sends. RJE-based data transfer packages (LU Type 1) limit the size of a data frame (RU) to 80 characters, while 3270-based transfer packages (LU Type 2) often limit the size to 1,920 characters, the size of one screen. LU 6.2 allows RU sizes of up to 65,536 characters.

Each transmitted string of data is wrapped in a protocol envelope. Larger RU sizes, such as those allowed with Unicenter CA-XCOM Data Transport, mean less protocol overhead and a higher percentage of actual data traveling across your communication links.

Support for Advanced Networking

For SNA, LU 6.2 fully exploits the PU Type 2.1 peer protocol. This means that LU 6.2 is the only protocol that can use advanced functions such as Low Entry Networking (LEN), Advanced Peer-to-Peer Networking (APPN), and Independent Logical Units (ILUs) that are changing the face of computer networking today. For more information, see the appendix “Logical Units.”

APPC allows two programs running on distinctly different computers to converse with each other in real time without regard to hardware. All other protocols assume that one of the two devices communicating is a dumb terminal and impose all the limitations of a particular terminal on the partner computer. APPC and Unicenter CA-XCOM Data Transport recognize that distributed processing employs intelligent processors so they can exploit the intelligence of the computers on which they are running.

1–6 User Guide

Unicenter CA-XCOM Data Transport in the TCP/IP Network

Unicenter CA-XCOM Data Transport in the TCP/IP Network The architectural and conceptual framework of the TCP/IP communications protocol as it relates to the implementation of Unicenter CA-XCOM Data Transport as a TCP/IP application is discussed in the following topics.

TCP/IP Protocol Stack

TCP/IP is a collection of specialized communications protocols and functions organized into a stack of four layers. The layers that make up the TCP/IP protocol stack are the following:

■ Network layer (the lowest protocol layer)

■ Internetwork layer

■ Transport layer

■ Application layer (the highest protocol layer)

Each layer in the TCP/IP protocol stack provides services to the layer above it and uses the services below it.

The following table lists the protocols and functions that form the content of each layer of the TCP/IP protocol stack. (The table shows only partial contents for the top and bottom layer.)

TCP/IP Protocol Layer Protocols and Functions

Network layer Token Ring Ethernet X.25 and so on

Internetwork layer Internet Protocol (IP) Control Message Protocol (ICMP) Address Resolution Protocol (ARP)

Transport layer Transmission Control Protocol (TCP) User Datagram Protocol (UDP)

Application layer Telnet File Transfer Protocol (FTP) Simple Mail Transfer Protocol (SMTP) Domain Name System (DNS) Sockets and so on

Introduction 1–7

Unicenter CA-XCOM Data Transport in the TCP/IP Network

The next few sections provide a summary of the services that each layer of the protocol stack performs in the TCP/IP network and a description of the protocols that are particularly important for the functioning of Unicenter CA-XCOM Data Transport as a TCP/IP network node.

Network Layer

The Network layer provides a set of protocols, such as Token Ring and Ethernet, that define how data are transported over different physical networks.

Internetwork Layer

The protocols of the Internetwork layer provide connection services for TCP/IP. The protocols in this layer connect physical networks and transport protocols.

The Internet Protocol (IP) of this layer integrates different physical networks into a unified logical network known as the Internet and provides for the universal addressing of computers (hosts) in a TCP/IP (Internet) network. IP uses a 32-bit number (IP address) that identifies both a physical network and a specific computer within that network. The IP address is the basic transport mechanism for routing data from a source computer to a destination computer.

However, IP does not ensure a reliable communication, because it does not require that the computers participating in a data exchange acknowledge the reception of the transmitted data. The reliability of communication is implemented at the next higher protocol layer.

Transport Layer

The protocols of the Transport layer allow communication between application programs.

The Transmission Control Protocol (TCP) of this layer establishes a connection between the sender and receiver and provides a continuous communication service with reliability of transmissions. TCP divides the data to be transmitted into smaller units (packets, datagrams), sends them individually using IP, and reassembles them at the destination node, comparing the received data with the data that were sent. TCP is capable of determining if the two are the same. If they are not (for example, data were lost or damaged during transmission), TCP resends the missing data.

1–8 User Guide

Unicenter CA-XCOM Data Transport in the TCP/IP Network

Application Layer

The Application layer, which is built on the services of the Transport layer, provides a number of applications that allow users to use network services (terminal-to-terminal communication, data transfer, electronic mail, and so on).

The Application layer provides an application-programming interface known as Sockets for communications applications. Unicenter CA-XCOM Data Transport uses this component of the Application layer to transfer files to machines in a TCP/IP network.

Unicenter CA-XCOM Data Transport Nodes in the TCP/IP Network

Each computer in a TCP/IP network is assigned at least one unique address, which is used by the IP and other higher-level protocols.

TCP/IP Address

TCP/IP employs an addressing scheme consisting of a 32-bit long field divided into two parts. The first part of the address field contains a network address; the second field contains the address of a specific computer.

A TCP/IP address is written in dotted-decimal notation, which is obtained by first dividing the 32-bit long address into four 8-bit long fields and then converting each of the four fields into a decimal number and separating the fields with periods. The decimal numbers should be specified without leading zeros.

Instead of using a numeric address, a symbolic name may be used to identify a computer in a TCP/IP network. Each computer in a TCP/IP network is assigned at last one name, which is resolved to a numeric address using either a translation file or an application known as the name server (which is part of the Domain Name System function of the Application layer).

TCP/IP Port

The notions of port and port number are extensions of the TCP/IP address. Once the TCP/IP address has been used to deliver data to the desired computer in the network, the port number is used to identify the process for which the data are intended. By using ports and port numbers one computer can provide more than one service. Unicenter CA-XCOM Data Transport uses a predefined port number but it can be changed if it interferes with existing application services.

Introduction 1–9

Successful Send File Transfer Scenario

Successful Send File Transfer Scenario The following flowchart illustrates a normal Unicenter CA-XCOM Data Transport send file:

1–10 User Guide

Successful Send File Transfer Scenario

Compare the following steps with the Send File Flowchart to follow a typical successful send file transfer.

1. The local Windows user invokes Unicenter CA-XCOM Data Transport and requests a transfer.

2. Unicenter CA-XCOM Data Transport verifies the information contained in the request.

For example, Unicenter CA-XCOM Data Transport checks to see if the local file exists on the local system.

3. Unicenter CA-XCOM Data Transport establishes a connection with the remote system and sends along the header record to the remote system. The header record contains transfer information regarding the request, for example, file names and compression. The local system then waits for confirmation of the header record information.

4. Once the contents of the header record are verified, Unicenter CA-XCOM Data Transport begins sending data records to the remote system. Unicenter CA-XCOM Data Transport sends each data record, checking to see if any sending errors occur. If no errors are found, the local system checks for an end-of-file marker denoting the last record of the file. If no end-of-file marker is found, another data record is sent.

5. If an end-of file marker is found, the local system sends a trailer record, which indicates the number of data records sent. The local system then awaits verification from the remote system that the number of records received is equal to the number of records sent. If the number of records matches, a successful send file message is sent to the user on the local system and the conversation ends. If notification was specified, Unicenter CA-XCOM Data Transport on the remote system notifies the user of a successful transfer.

Introduction 1–11

Chapter

2 Using Unicenter CA-XCOM Data Transport

This chapter contains information about using the Graphical User Interface (GUI) of Unicenter CA-XCOM Data Transport. It describes the functions and options available from the Unicenter CA-XCOM Data Transport for Windows NT main window, and then describes how to create and edit transfer configuration files, how to set options, and how to perform transfers. It also contains information about using the GUI to manage Unicenter CA-XCOM Data Transport. In addition, this chapter also contains information for administrators on using the Properties Dialog pages to modify global defaults.

Unicenter CA-XCOM Data Transport GUI The Graphical User Interface of Unicenter CA-XCOM Data Transport provides access to all of the features of Unicenter CA-XCOM Data Transport. From the GUI you can do the following:

■ Create and edit Unicenter CA-XCOM Data Transport transfer configuration files

■ Specify transfer type

■ Initiate transfers

■ Monitor the log and trace functions

■ Update the status of active and pending transfers

File Name, Path, and Directory Considerations

Consider the following:

■ Before executing a file transfer request, be sure that you have properly set up your directories and path variables.

■ Unicenter CA-XCOM Data Transport accesses files locally or from any file server on the Microsoft Windows Network or the NetWare or Compatible Network.

■ Universal Naming Convention (UNC) is supported.

Using Unicenter CA-XCOM Data Transport 2–1

Unicenter CA-XCOM Data Transport GUI

■ Standard Windows path names are supported. To specify a path name that contains a blank or special character, put double quotes (“ ”) around it.

■ Standard Windows file types are supported (FAT, NTFS, HPFS).

In addition, administrators should be aware of the following:

■ Be sure that the XCOM_HOME environment variable is set to the directory where Unicenter CA-XCOM Data Transport is installed.

■ Your PATH variable should include the directory where Unicenter CA-XCOM Data Transport is installed. The default directory is C:\XCOMNT.

■ The C:\XCOMNT directory is the default repository for the subdirectories that Unicenter CA-XCOM Data Transport uses for log and configuration files.

Keyboard Commands

When you use keyboard commands instead of mouse operations, note the following:

Use Alt+Spacebar to open the list of control-menu box options for any Unicenter CA-XCOM Data Transport window. (Use this instead of the Windows Alt+Hyphen keyboard command.)

Use Alt+Underlined letter to open any menu. Then, to select a menu command, use the underlined letter of that command. Note that if the Caps Lock key is on, these commands do not function.

Default Directories and Drives

In this user guide we indicate C:\XCOMNT as the default path. Your installation may have Unicenter CA-XCOM Data Transport under a different path or on a different drive. If this default is changed during the installation of Unicenter CA-XCOM Data Transport, the default values in the XCOM.GLB file will reflect this change.

For further information on PATH and directory defaults, see the appendix “Unicenter CA-XCOM Data Transport Parameters.”

2–2 User Guide

Starting Unicenter CA-XCOM Data Transport

Requirements

To use Unicenter CA-XCOM Data Transport you need the following:

■ Unicenter CA-XCOM Data Transport installed on your server or workstation.

■ For using SNA/APPC protocols, appropriate APPC communications software installed.

■ For using TCP/IP, TCP/IP capability installed and configured for your server or workstation.

■ Your Windows Username and Password.

■ The XCOMD Unicenter CA-XCOM Scheduler service must be started.

■ To edit configuration files, you need the appropriate user rights to read and write to those files.

■ To send a transfer using the GUI, you need the appropriate user rights to run XCOMNT.EXE and XCOMTP.EXE.

For information about installing Unicenter CA-XCOM Data Transport, see the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Getting Started. For more information about the XCOMD Unicenter CA-XCOM Scheduler service and the Unicenter CA-XCOM Data Transport operating environment, administrators should see the following chapters:

■ “The Command Line Interface” in this guide

■ “Operating Environment” in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Administrator Guide

Starting Unicenter CA-XCOM Data Transport Before you can use Unicenter CA-XCOM Data Transport to perform transfers, the XCOMD Unicenter CA-XCOM Scheduler service must be running. For a procedure for starting the XCOMD Unicenter CA-XCOM Scheduler service, see the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Getting Started.

You can start Unicenter CA-XCOM Data Transport for Windows NT in the same ways that you start any Windows application:

■ By double-clicking the program icon

■ By selecting Start>Programs>Unicenter CA-XCOM Data Transport on your Windows desktop

■ At the command prompt by typing XCOMNT and pressing ENTER.

Using Unicenter CA-XCOM Data Transport 2–3

Starting Unicenter CA-XCOM Data Transport

Note: For starting and stopping the Unicenter CA-XCOM Data Transport user interface, ERRORLEVEL has no meaning. When executing the command-line programs (xcomtcp.exe and xcom62.exe), the ERRORLEVEL indicates successful or failed processing. An ERRORLEVEL of ZERO indicates successful operation and termination. An ERRORLEVEL of NON_ZERO values indicates program processing was not successful, and that the program has terminated.

The Unicenter CA-XCOM Data Transport interface displays:

2–4 User Guide

Using the Unicenter CA-XCOM Data Transport Main Window

Using the Unicenter CA-XCOM Data Transport Main Window Use the Unicenter CA-XCOM Data Transport for Windows NT main window to select, create, or edit transfers. This window provides access to files and provides the ability to create, open or save transfer configurations. From here you can submit transfers to the Unicenter CA-XCOM Data Transport queue. You can add, duplicate, delete or edit transfers, save configuration files, and access the queue and the log.

Main Window

The Unicenter CA-XCOM Data Transport for Windows NT main window is the beginning point for all transfers. The first time this window is displayed, it is blank. When you add or duplicate a transfer, the transfer appears in the transfer list displayed in this window.

Note: In this chapter we will refer to this window as the main window. The title bar displays Unicenter CA-XCOM Data Transport for Windows NT. In addition, when a configuration file is open, the name of the file is displayed in the title bar.

The main window provides the following functions:

■ Management of configuration files

■ Access to other windows

Using Unicenter CA-XCOM Data Transport 2–5

Using the Unicenter CA-XCOM Data Transport Main Window

From the main window you can access other windows to configure parameters for the four Unicenter CA-XCOM Data Transport transfer types:

■ Send File

■ Send Job

■ Send Report

■ Receive File

The functions and options of this window can be selected from the menu bar or from the pushbuttons on the toolbar at the top of the window.

For information about configuration files, see Using Transfer Configuration Files later in this chapter.

Considerations

Before using the main window to access a transfer you should know the values of the options you wish to edit and the particular type of action you wish to perform on the transfer. Each type of transfer operation is described later in this chapter, with suggestions about the information you may need, along with procedures for performing each type of transfer.

Procedure

To perform an action on a transfer listed in the Unicenter CA-XCOM Data Transport main window, do one of the following:

■ Highlight a transfer on the list and click on one of the toolbar pushbuttons.

■ Highlight a transfer on the list and select an action from a drop-down list on the menu bar.

■ Highlight a transfer on the list and double-click it to open an Edit Transfer window.

The applicable window is displayed or the applicable action is performed.

Note: To select more than one transfer, hold down the CTRL key and click on each appropriate transfer.

2–6 User Guide

Using the Unicenter CA-XCOM Data Transport Main Window

Menu Bar Selections

Use the following selections and options of the menu bar to perform functions from the main window:

Selection Options

File The following options can be selected:

Option Function

New Clear the displayed Transfer List and create a new configuration file.

Open Open a saved configuration file.

Save Save a configuration file.

Save As Save a configuration file under a different name.

Select all transfers

Select all transfers from the list.

Queue transfers

Submit all transfers that were selected from list.

Exit Exit Unicenter CA-XCOM Data Transport.

Edit The following options can be selected:

Option Function

Add transfer Add a new transfer with default parameters to the transfer list.

Duplicate transfer

Add a copy of the selected transfer(s) to the transfer list.

Delete transfer Delete selected transfer(s) from the transfer list.

Edit transfer parameters

Edit the selected transfer’s parameters. This opens an Edit Transfer window for the selected transfer type.

Connect The connect menu selection is dimmed, and does not apply to this implementation of Unicenter CA-XCOM Data Transport.

Tools The following options can be selected:

Option Function

Queue manager

Open the Queue Status window. Display the status of transfers.

Log browser Open the Log Browser window. Display the Unicenter CA-XCOM Data Transport log.

Using Unicenter CA-XCOM Data Transport 2–7

Using the Unicenter CA-XCOM Data Transport Main Window

Selection Options

Global parameters

Open the Unicenter CA-XCOM Data Transport for Windows NT Properties dialog, to access the Properties dialog pages, for modifying global defaults.

Trusted Access Open the Unicenter CA-XCOM Data Transport for Windows NT Trusted Access user interface, from which you can set up permissions to allow Unicenter CA-XCOM Data Transport on other platforms to initiate file transfers without requiring a password.

Help The following options can be selected:

Help Contents Open the contents for Unicenter CA-XCOM Data Transport online help.

About Displays information about this version of the product.

Pushbuttons

Use the following toolbar pushbuttons to perform functions from the main window. All the pushbuttons, except for Queue, can be used in place of menu bar selections.

Button Icon Function

Add

Add a new transfer with default parameters to the transfer list.

Duplicate

Add a copy of the selected transfer(s) to the transfer list.

Delete

Delete selected transfers from the transfer list.

Edit

Edit the selected transfer’s parameters. This opens an Edit Transfer window for the selected transfer type.

Select All

Select all transfers in the list.

Queue

Queue submits selected transfers.

2–8 User Guide

Using Transfer Configuration Files

Button Icon Function

Queue Manager

Open the Queue status window and display the status of transfers.

Log

Open the Log Browser window and display the Unicenter CA-XCOM Data Transport log.

Using Transfer Configuration Files Unicenter CA-XCOM Data Transport uses transfer parameters stored in configuration files to manage each transfer. You can control how Unicenter CA-XCOM Data Transport performs transfers by specifying values for the parameters for each transfer. You can use a combination of default values and values you specify.

Using the GUI, you can create or open specific configuration files. You can create any number of these transfer configuration files for different transfer situations. You can edit a configuration on-screen, save it under another name and modify it for your own use, or add and delete transfers to create different configuration files. You can also simply modify the default values on-screen for a selected transfer.

Default Configuration Files

Unicenter CA-XCOM Data Transport comes with default configuration files, XCOM.GLB and XCOM.CNF, which can be modified as needed. Authority to change these files should be controlled by an Administrator.

WARNING! The parameters in the XCOM.GLB files and the values of the options on the Properties dialog pages in the GUI should only be changed by authorized Unicenter CA-XCOM Data Transport administrators. Most users will not need to change these values. The values should not be changed or deleted unnecessarily, and parameters should not be deleted from XCOM.GLB unnecessarily. If these values or parameters are deleted unnecessarily, the results are unpredictable.

Note: The installation process installs XCOM.GLB with parameters used for TCP/IP transfers. Even if you are not using TCP/IP, you should not delete these parameters from XCOM.GLB.

For information about modifying default values in XCOM.GLB using the GUI, see Using the Properties Dialog Pages in this chapter.

Using Unicenter CA-XCOM Data Transport 2–9

Using Transfer Configuration Files

Precedence of Parameter Values

The GUI uses parameter values in the following ways:

■ Values specified on-screen take precedence over values in open user-specified configuration files.

■ When using the GUI, parameter values in a user-created configuration file only take effect if the file is open.

■ When you save a configuration, the file is updated to include the values you have indicated on-screen.

■ Parameter values in the XCOM.GLB file are the global default values.

For more information about how parameter values take effect, see the chapter “Operating Environment” in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Administrator Guide.

Modifying Options and Configurations

Each line displayed in the transfer list on the main window represents a transfer with specific parameters associated with it. Modify the options for a particular transfer by opening the appropriate Edit Transfer window.

For information about using the transfer list, see Using the Transfer List to Access and Perform Transfers later in this chapter. For information about using configuration files from the command prompt and in scripts, see the chapter “The Command Line Interface.” For information about how configuration files are edited and used from the command prompt, see Using Configuration Files in the following chapters:

■ “The Command Line Interface” in this guide

■ “Operating Environment” in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Administrator Guide

Multiple Transfers from the GUI

You can create up to 99 transfers and save them as a single configuration file, which lets you create configurations to control multiple transfers. When you open a configuration file, the transfers are displayed on the main window.

Select multiple transfers by holding down the control key (CTRL), clicking the desired transfers to highlight them, and then clicking the Queue pushbutton.

2–10 User Guide

Creating a Configuration File

Considerations

Before you create or edit a configuration file, get information from your Administrator about Unicenter CA-XCOM Data Transport configuration files and find out what parameters you may have to set on specific transfers.

Also, before attempting to queue a transfer, you need to know the name of some or all of the following components:

■ Local file

■ Remote file

■ For transfers using SNA/APPC protocols, the CPI-C Symbolic Destination Name for the remote system

■ For transfers using TCP/IP, the IP address, host name or domain name for the remote system

Note: The local file is the name of the file on the local system that is being transferred. The remote file is the name of the file on the remote system to which the transferred data is being written.

Creating a Configuration File When you first open Unicenter CA-XCOM Data Transport, the main window does not display any transfers. When you create a new configuration file, the default values for a new transfer configuration file come from the XCOM.GLB file.

Considerations

Before you create a configuration file, read Using Transfer Configuration Files previously discussed. Also, get information from your Administrator about Unicenter CA-XCOM Data Transport configuration files and find out what parameters you may have to set on specific transfers.

Note: If you want to create a new configuration file and transfers are displayed, you can choose to save the displayed transfers as a configuration or delete them from the transfer list.

Using Unicenter CA-XCOM Data Transport 2–11

Creating a Configuration File

Procedure

To create a configuration file, follow these steps:

1. From the Unicenter CA-XCOM Data Transport for Windows NT main window, click the Add pushbutton.

The main window is displayed with a transfer listed:

Note: When you first open Unicenter CA-XCOM Data Transport, this window does not display any transfers.

2–12 User Guide

Creating a Configuration File

2. Highlight the transfer and click the Edit pushbutton.

An Edit Transfer window is displayed.

3. Select an action (Send File, Send Job, Send Report, or Receive File) from the drop down Action list.

The right side of this window will change the fields to reflect the type of transfer you have selected.

4. Fill in the fields and change the options for a new configuration, and click the Apply and Close pushbutton.

The transfer is displayed on the main window transfer list.

For information about using the Edit Transfer windows, see Using the Edit Transfer Window in this chapter.

5. From the menu bar, choose File Save or File Save as.

The File drop-down list appears and the option is selected. Then the Save or Save as directory window appears.

Using Unicenter CA-XCOM Data Transport 2–13

Editing an Existing Configuration File

6. In the Save or Save as directory window, type a new name for the file, using an extension of .cnf and click OK.

The configuration file is saved.

Note: Any transfers in the list are saved as part of the configuration.

Editing an Existing Configuration File The values for a transfer come from a user-specified configuration file if one is open. Otherwise, the values for the transfer come from the XCOM.GLB file.

After you open a configuration file, the name of the highlighted file appears in the title bar of the main window.

Considerations

Before editing a configuration file, read Using Transfer Configuration Files discussed earlier in this chapter. Also get information from your Administrator about Unicenter CA-XCOM Data Transport configuration files and find out what parameters you may have to set on specific transfers.

When you choose File>Open, the Open directory window displays all the files with .cnf extensions that are in the directory where Unicenter CA-XCOM Data Transport is installed. If you use configuration files with other extensions, you must change List Files of Type to All files (*.*) in order to display these files in the selection list.

2–14 User Guide

Editing an Existing Configuration File

Procedure

To edit an existing configuration file, follow these steps:

1. From the menu bar on the main window click File.

The File drop-down list is displayed.

2. Click Open, select the directory where the configuration file is stored, highlight the configuration file you want to edit and choose OK.

The following window is displayed, with the transfer selected:

Note: The display listed in the above window is only an example. Your display will vary, based on the contents of your open configuration file.

3. Highlight the transfer and select a function. For descriptions of the options available with this window, see Using the Unicenter CA-XCOM Data Transport Main Window earlier in this chapter.

Using Unicenter CA-XCOM Data Transport 2–15

Using the Transfer List to Access and Perform Transfers

Using the Transfer List to Access and Perform Transfers Use the transfer list on the main window to:

■ Select a transfer to edit

■ Submit a transfer to the queue

■ Select a transfer to delete or duplicate

■ Save transfer configurations

The main window displays a list of transfers that can be edited, queued, deleted, or duplicated. New transfers can also be created.

A transfer entry appears on the list in the main window when you do any of the following:

■ Add a transfer by clicking the Add pushbutton or selecting Add transfer from the Edit drop-down list.

■ Select an existing transfer and duplicate it by clicking the Duplicate pushbutton or selecting Duplicate transfer from the Edit drop-down list.

■ Open a configuration file by selecting Open from the File drop-down list.

Note: When you open a configuration file, all other transfers in the list are cleared.

Each line in the list represents a transfer with a set of parameters specified for it.

2–16 User Guide

Using the Transfer List to Access and Perform Transfers

Transfer List Fields

Transfers are listed with the name of the local file, an arrow indicating the direction of the transfer (from local to remote or remote to local), the remote system (for transfers using SNA/APPC protocols, this is the CPI-C Symbolic Destination Name; for transfers using TCP/IP, this is the IP address, the host name or the domain name), and the name of the remote file. When the transfer is a job, it is indicated with //JOB. When the transfer is a report, it is indicated with a printer icon.

You can customize the size of each displayed field by selecting the left or right border of the field title box and dragging it left or right.

Saving Displayed Transfers

If you modify the parameter values of a transfer using the fields and options in the GUI, and you wish to use them again, you must save them in a configuration file. After a transfer has been saved in a configuration file, deleting it from the list only deletes it from memory, and has no effect on a file that has been saved.

You can clear the transfer list by saving the transfer list in a configuration file and then selecting File>New, or you can highlight transfers and delete them from the list using Edit>Delete transfer or the Delete button.

When you select File>New, if any displayed transfers have been changed or added, a dialog box prompts you to choose Yes to save the configuration or No to abandon the changes before the transfer list is cleared from the window.

Considerations

Before you perform a transfer, find out from your Administrator what parameters you may have to set for specific transfers. You should know the type of transfer you wish to perform:

■ Send File

■ Send Report

■ Send Job

■ Receive File

Also, before submitting a transfer to the Unicenter CA-XCOM Data Transport queue, you need to know the names of some or all of the following transfer components:

■ Local file

■ Remote file

Using Unicenter CA-XCOM Data Transport 2–17

Using the Transfer List to Access and Perform Transfers

■ For transfers using SNA/APPC protocols, the CPI-C Symbolic Destination Name for the remote system

■ For transfers using TCP/IP, the IP address, host name or domain name for the remote system

Procedure

To select a transfer for editing and processing, follow these steps:

1. Highlight a transfer in the list on the main window and click Edit or double-click the highlighted transfer.

An Edit Transfer window for the selected transfer is displayed.

2. Enter values in fields and select options as needed. For more information, see Using the Edit Transfer Windows and the transfer procedures described in this chapter (for sending and receiving transfers).

3. Process a transfer by submitting it to the queue or applying the edited values to the transfer and adding it to the transfer list in the main window.

4. To submit a transfer from the transfer list, highlight it and click the Queue pushbutton. Refer to Using the Unicenter CA-XCOM Data Transport Main Window discussed earlier for detailed information on using the main window. For information about the queue, see Viewing and Controlling Transfer Status later in this chapter.

2–18 User Guide

Using the Transfer List to Access and Perform Transfers

Fields

Refer to the following table for explanations of the fields on the transfer list:

Field Description

Local File The name of the local file.

The direction of the transfer. A right pointing arrow means send, a left pointing arrow means receive.

Remote System For transfers using SNA/APPC protocols: the CPI-C Symbolic Destination Name for the remote system that receives or sends a file.

For transfers using TCP/IP: the IP address, host name or domain name for the remote system that receives or sends a file.

Note: If you use a host name or domain name, your system must have a way to resolve that name to an IP address. Using the IP address is the most efficient method to use when specifying a remote system location. For more information on TCP/IP, see Using the Version 2 Window—Checkpoint, Restart, Protocol, Port in this chapter and Transferring Files Using TCP/IP Protocols in the chapter “The Application Programming Interface.”

Remote File The name of the remote file.

Transfer List Symbols

The following table explains the transfer symbols in the transfer list:

Symbol Description

Right arrow indicates a transfer operation from local to remote.

Left arrow indicates a transfer operation from remote to local.

//JOB Indicates a Send Job transfer.

Indicates a Send Report transfer.

Using Unicenter CA-XCOM Data Transport 2–19

Using the Edit Transfer Windows

Using the Edit Transfer Windows Use the information in this section to refer to the options available for each transfer type when using an Edit Transfer window.

Accessing the Edit Transfer Window

Access an Edit Transfer window by highlighting a transfer from the transfer list on the main window and clicking the Edit pushbutton or double-clicking a highlighted transfer. The Edit Transfer window that is displayed depends on the transfer type.

2–20 User Guide

Using the Edit Transfer Windows

Menu Bar Selections

These selections and options are available from the Edit Transfer window menu bar:

Selection Options

Action The following options can be selected:

Selection Function

Send File Change transfer type to send file and open the Edit window for send file.

Send Job Change transfer type to send job and open the Edit window for send job.

Send Report

Change transfer type to send report and open the Edit window for send report.

Receive File Change transfer type to receive file and open the Edit window for receive file.

Close Close this window.

Pushbuttons

The following pushbuttons and functions are available at the bottom of each Edit Transfer window:

Button Function

Submit Apply the parameter values and options specified on-screen to the transfer and queue the transfer.

Apply Apply the entered parameters to the transfer. The Transfer Edit window stays open.

Apply and close Apply the entered parameters to the transfer and close the Transfer Edit window.

In addition, you can click the Control-menu box to close an Edit Transfer window without taking any action.

Using Unicenter CA-XCOM Data Transport 2–21

Using the Edit Transfer Windows

Fields

The following table explains the fields found on the Edit Transfer windows. Many of these fields are common to the different types of transfer operations. For more information about parameter specifications, see the appendix “Unicenter CA-XCOM Data Transport Parameters.”

Field Definition

Local file The name of the local file. Use the Local File Browse window to select a file.

Remote System For transfers using SNA/APPC protocols: the CPI-C Symbolic Destination Name of the remote system that receives files, jobs, reports, and sends messages.

For transfers using TCP/IP: the IP address, host name or domain name of the remote system that receives files, jobs, reports, and sends messages.

Remote File Indicates the file on the remote computer to which the transferred data is being written. If you are creating the file, the file name must be consistent with the file naming conventions of the remote system. The local Unicenter CA-XCOM Data Transport system does not validate this name. The remote I/O system determines whether the file name is valid.

Remote system type

Click the appropriate option button for MVS/VM, Midrange, DOS/VSE, or Other.

File option Click the appropriate option button for Create, Replace or Append.

2–22 User Guide

Using the Edit Transfer Windows

Field Definition

Destination Printer

Identifies the printer or other device on the remote system where the report is to be sent. If this parameter is not specified, the remote system sends the report to the system's default printer.

When sending a report to a Windows network printer, specify the Destination parameter value or the Destination Printer field in the following form: \\servername\printerqueuename

Unicenter CA-XCOM Data Transport limits the length of this field as indicated below. The actual name on the destination system may be longer.

For direct transfers using Version 2 protocols: Up to 21 characters.

For indirect transfers or transfers using Version 1 protocols: Up to 16 characters.

Report title Used by Unicenter CA-XCOM Data Transport on remote systems in the following ways:

System Uses the Report title

AS/400 As the printer file name.

z/OS To interpret a non-blank value in this field as specifying the generation of a separator (banner) page for this value.

VAX/VMS To print with the report.

UNIX To allow Unicenter CA-XCOM Data Transport to pass this field to the LP spooler as a title field.

Other systems As a descriptive comment only and does not print it as part of the report.

UNIT (system-specific)

The unit for the remote file.

VOLUME (system-specific)

The volume for the remote file.

DSNTYPE The data set type definition.

DATACLAS The name of the data class to use when allocating a new SMS-managed data set.

MGMTCLAS The name of the management class to use when allocating a new SMS-managed data set.

Using Unicenter CA-XCOM Data Transport 2–23

Using the Edit Transfer Windows

Field Definition

STORCLAS The name of the storage class to use for a new SMS-managed data set.

RECFM (system-specific)

The record format for the remote file. See RECORD_FORMAT later in this chapter.

LRECL (system-specific)

The actual or maximum length, in bytes, of a logical record for the remote file. This parameter corresponds to the JCL LRECL subparameter.

If the format is Variable Blocked Record, then the maximum length of a logical record must be equal to the Maximum record length plus 4.

If the format is Fixed or Fixed Block Record, then the maximum length of a logical record must be equal to the constant record length.

BLKSIZE (system-specific)

The block size for the remote file. If the format is Fixed or Fixed Block Record, then the block size must be a multiple of the record length. If the format is Variable Record, then the block size must be 4 bytes larger than the record length. If the format is undefined, then the block size must be larger than the largest record length.

SPACE (system-specific)

The unit of storage allocation for the remote file. Values are as follows:

■ CYL = Cylinders

■ TRK = Tracks

■ BLK = Blocks

Specify by

■ Primary allocation space for the remote file

■ Secondary allocation for the remote file

■ Directory blocks for the remote file

TAPE (system-specific)

Indicates to the remote system whether the volume is a tape volume or a disk file.

DEN (system-specific)

The density to be used in creating a tape on the remote system. Valid values are the same as those for the DEN parameter in JCL.

2–24 User Guide

Using the Edit Transfer Windows

Field Definition

LABEL (system-specific)

The type of label associated with a tape data set. Values are as follows:

Sequence number = the sequence number of a data set on tape

Processing type = AL, AUL, BLP, LTM, NL, NSL, SL, or SUL (the types of processing to be applied to data sets on tape)

UNITCT (system-specific)

The number of units to be allocated on the remote system.

VOLCT (system-specific)

The maximum number of volumes to be used in processing a multi-volume output tape data set on the remote system.

VOLSQ (system-specific)

The sequence number of the first volume of a multi-volume remote data set to be used.

EXPDT* The expiration date for the tape data set.

RETPD* The number of days (1 to 9999) that the tape data set being created is to be retained

COPIES The number of copies to be printed.

FCB (system-specific)

The FCB JCL parameter when sending the report to an IBM mainframe.

CLASS (system-specific)

The print class to be assigned to this report on the remote system. If the remote system is an IBM mainframe, this field designates the JES SYSOUT class. In this case, type B.

FORM (system-specific)

Specifies to the remote user the type of form that this report is to be printed on. When sending to a VAX computer, leave this field blank.

DISPOSITION Specifies what the remote system does with the report file after the report has been printed. For report transfers only. Not used if the remote system is an IBM mainframe.

Values are:

■ DELETE = Delete after printing

■ KEEP = Keep after printing

■ HOLD = Hold after printing

Using Unicenter CA-XCOM Data Transport 2–25

Using the Edit Transfer Windows

Field Definition

CONTROL Specifies the type of printer carriage control codes, if any that are included in the report file.

Values are:

■ ASA = ASA control codes in column 1

■ IBM = IBM machine characters (IBM mainframe only)

■ OTHER = No carriage control codes

SPOOL Specifies whether the report is to be spooled to disk or printed immediately. For report transfers only. If the remote system is an IBM mainframe, this parameter has no effect on the transfer.

HOLD Specifies whether a transferred report file is to be placed on HOLD on the remote system or is to be printed immediately. For report transfers only.

* EXPDT and RETPD are mutually exclusive. Choose one from the drop-down box that shows EXPDT.

RECORD_FORMAT

This parameter specifies the record format of a data set created on an IBM mainframe. This corresponds to the JCL RECFM subparameter. This field is unique to the Edit Transfer - Send File window. The following table describes the available options:

Value Description Record Length Comment

F Fixed unblocked

The same length as the data set

FA Fixed unblocked ANSI

The same length as the data set

Contains ISO/ANSI/FIPS control characters

FB Fixed blocked Fixed Fixed record length with multiple records per block

FBA Fixed blocked ANSI

Fixed Multiple records per block where these records contain ISO/ANSI/FIPS control characters

FBS Fixed blocked spanned

Fixed Multiple records per block written as standard blocks

2–26 User Guide

Using the Edit Transfer Windows

Value Description Record Length Comment

FM Fixed unblocked machine

The same length as the data set

Contains machine code control characters

FS Fixed unblocked spanned

The same length as the data set

Written as standard blocks where these records do not contain any truncated blocks or unfilled tracks

U Undefined Undefined

V Variable unblocked

Variable

VA Variable unblocked ANSI

Variable Contains ISO/ANSI/FIPS control characters

VB Variable blocked

Variable Multiple records per block

VBA Variable blocked ANSI

Variable Multiple records per block where these records contain ISO/ANSI/FIPS control characters

VBM Variable blocked machine

Variable Multiple records per block where these records contain machine code control characters

VBS Variable blocked spanned

Variable May have multiple records per block where these records can span more than one block

VM Variable unblocked machine

Variable Contains machine code control characters

VS Variable unblocked spanned

Variable A record can span more than one block

Using Unicenter CA-XCOM Data Transport 2–27

Setting the Options on an Edit Transfer Window

Setting the Options on an Edit Transfer Window Use the Options group box to set the options for particular transfers and to access windows to control other options available from this panel.

2–28 User Guide

Setting the Options on an Edit Transfer Window

Modifying the Options Group

The options appear on the right side of each Edit Transfer window. Values for encoding, maximum record length and truncation can be indicated directly in the upper group boxes of this window. The options in the lower group can be modified by clicking the associated pushbuttons or empty checkboxes to open windows that allow you to modify these options. However, you do not have to modify the values of any of these options unless you wish to change the default values.

Encoding Options

The following table describes the options available from the drop down list in the Encoding group box:

Menu Description

Encoding Lets you select the following options for file encoding for a transfer. Setting the option here changes the values of the CODE_FLAG and CARRIAGE_FLAG parameters as indicated here. Also shown is whether the option applies to transfers using SNA or TCP/IP.

Option CODE_FLAG CARRIAGE_FLAG Applies To

ASCII ASCII NO SNA and TCP/IP

ASCII (Text) ASCII YES SNA only

ASCII (2K Pack)

ASCII MPACK SNA only

ASCII (31K Pack)

ASCII XPACK SNA and TCP/IP

BINARY Binary NO SNA and TCP/IP

BINARY (VLR)

Binary VLR SNA and TCP/IP

EBCDIC EBCDIC NO SNA and TCP/IP

EBCDIC (Text)

EBCDIC YES SNA only

EBCDIC (2K Pack)

EBCDIC MPACK SNA only

EBCDIC (31K Pack)

EBCDIC XPACK SNA and TCP/IP

Using Unicenter CA-XCOM Data Transport 2–29

Setting the Options on an Edit Transfer Window

Maximum Record Length Field

The following table describes the Max. Record Length field:

Field Description

Max. Record Length

For Windows and UNIX systems, the locally initiating Unicenter CA-XCOM Data Transport system determines the values for MAXRECLEN, TRUNCATION, and LRECL, for send and receive operations. When the local Unicenter CA-XCOM Data Transport system initiates a transfer of a text file, this parameter designates the length, in bytes, of the largest record that can be transferred. If a record length is longer than this value, Unicenter CA-XCOM Data Transport uses the value in the TRUNCATION parameter on the initiating side to determine whether to terminate the transfer or to truncate the record and continue the transfer. When Unicenter CA-XCOM Data Transport transfers binary files, this value indicates the length of the records that are transferred. On a receive operation, MAXRECLEN is set to whatever the LRECL value is on the initiating side.

For transfers between Windows NT and UNIX systems (where the LRECL value is not visible in the GUI on a receive operation) the value of Max. Record Length is used to set the LRECL value. That is, the Max. Record Length value specified by the initiating system is sent to the remote system, which uses this value to set its Max. Record Length value.

CodeTable Option

Note: Before completing this field, you must know the one- to three-character prefix for the user ASCII-to-EBCDIC and EBCDIC-to-ASCII conversion table names (atoe.tab and etoa.tab) that reside in the Unicenter CA-XCOM Data Transport convtab directory that will be used for the transfer.

The following table describes the CodeTable field:

Field Description

CodeTable The prefix to the file names, atoe.tab and etoa.tab, containing the external ASCII-to-EBCDIC and EBCDIC-to-ASCII custom character conversion tables that determine which external translation tables will be used by the transfer.

2–30 User Guide

Setting the Options on an Edit Transfer Window

Truncation Option

The following table describes the Truncate Records option:

Checkbox Description

Truncate Records Lets you specify if a record exceeding the maximum record length should be truncated. To activate, click the check box to display an X.

Procedure

To select an option in the lower group box of this panel, select a method for modifying an option based on the following: If the option checkbox displays

Then

X Click the

pushbutton to access the window for modifying that option.

No X Click in the checkbox to access the window for modifying that option.

The appropriate option window is displayed. For more information, see the descriptions of each option window.

Note: When the Protocol option is set for TCP/IP, the checkbox for the Version 2 option is not displayed.

Using Unicenter CA-XCOM Data Transport 2–31

Setting the Options on an Edit Transfer Window

Edit Transfer Window Options Summary

Use the following table to find information you are interested in for modifying the values of the options listed in the lower portion of the Options group:

Option Function

Version 2 Checkpointing and Restarting Transfers

Specifying SNA/APPC or TCP/IP protocols

Specifying TCP/IP Port

Security Specifying User IDs, Passwords, domain name, and Trusted Access authority for File Access

Local notify Notifying Local Users of Transfer Completion

Remote notify Notifying Remote Users of Transfer Completion

Compression Setting Compression Type for a Transfer

Indirect Sending an Indirect Transfer

Debugging Tracing

Schedule Scheduling Transfers

Secure Socket Specify whether to use secure sockets, and the path name of the secure socket configuration file.

2–32 User Guide

Sending a File Using an Edit Transfer Window

Sending a File Using an Edit Transfer Window Use the Edit Transfer window - Send File to specify options for a Send File transfer.

Accessing the Send File Window

Access the Edit Transfer window - Send File from the main window when the type of transfer selected is send file. The fields will contain the values defined in the open configuration file or in XCOM.GLB.

Using standard Windows wildcard characters, Unicenter CA-XCOM Data Transport for Windows can:

■ Receive multiple PDS members from a z/OS system, with each member saved as a separate file

■ Transfer multiple directory members to another Windows system or PDS members on a z/OS system

Using Unicenter CA-XCOM Data Transport 2–33

Sending a File Using an Edit Transfer Window

Considerations

Before completing this window, you must know the following:

■ Remote system

■ Local file

■ Remote file

■ File option

■ Remote systemtype

■ Maximum record length

Depending upon the remote system type, additional information may be required. Obtain this information before completing the following procedure.

Procedure

To complete the required fields in the Send File window, follow these steps:

Note: For more information, see Using the Edit Transfer Windows earlier in this chapter.

1. Type the name of the remote system and click in Local File. (Use wildcard characters transferring more than one file in a library-type transfer.)

The name of the remote system is specified and the cursor is positioned in the Local File field.

2. Type the name of the local file and click in Remote File. (Use wildcard characters transferring more than one file in a library-type transfer to another Windows system.)

The name of the local file is specified and the cursor is positioned in the Remote File field.

3. Type the name of the remote file.

The name of the remote file is specified.

4. In the File option group, click the Create, Append, or Replace option button.

The selected option button is filled in and some additional fields may be displayed.

5. In the Remote system type group, click the MVS/VM, Midrange, DOS/VSE, or Other option button.

The selected option button is filled in, and some additional fields may be displayed.

2–34 User Guide

Sending a Report Using an Edit Transfer Window

6. Select options and complete fields, as appropriate.

7. After all entries are complete, click the appropriate pushbutton at the bottom of the window.

Sending a Report Using an Edit Transfer Window Use the Edit Transfer window - Send Report to specify options for a Send Report transfer.

Accessing the Send Report Window

Access the Edit Transfer window - Send Report from the main window when the type of transfer selected is a send report. The fields will contain the values defined in the open configuration file or XCOM.GLB.

Using Unicenter CA-XCOM Data Transport 2–35

Sending a Report Using an Edit Transfer Window

Considerations

Before completing this window, you must know the following:

■ Remote system

■ Local file

■ Destination printer

■ Maximum record length

Obtain this information before completing the following procedure.

Procedure

To complete the required fields in the Send Report window, follow these steps:

1. Type the name of the remote system and click in Local File.

The name of the remote system is specified and the cursor is positioned in the Local File field.

2. Type the name of the local file and click in Destination Printer.

The name of the local file is specified and the cursor is positioned in the Destination Printer field.

3. Type the name of the printer on the remote system and click in Report Title.

The name of the printer is specified and the cursor is positioned in the Report Title field.

4. Type a name for the report and click in Copies.

The report title is specified and the cursor is positioned in the Copies field.

5. Type the number of copies desired and specify other information in remaining fields as required for the printer on the remote system. For information about specific requirements for each remote system, see the chapter “Remote System Information.”

6. Select options and complete fields, as appropriate.

7. After all entries are complete, click the appropriate pushbutton at the bottom of the window.

2–36 User Guide

Sending a Job Using an Edit Transfer Window

Sending a Job Using an Edit Transfer Window Use the Edit Transfer window - Send Job to specify options for a send job transfer.

Accessing the Send Job Window

Access the Edit Transfer window - Send Job from the main window when the type of transfer selected is send job. The fields will contain the values defined in the open configuration file or in XCOM.GLB.

Using Unicenter CA-XCOM Data Transport 2–37

Sending a Job Using an Edit Transfer Window

Considerations

Before completing this window, you must know the following:

■ Remote System

■ Local File

■ Maximum Record Length

Obtain this information before completing the following procedure.

Procedure

To complete the required fields in the Send Job window, follow these steps:

1. Type the name of the remote system and click in Local File.

The name of the remote system is specified and the cursor is positioned in the Local File field.

2. Type the name of the local file.

The name of a local file is specified.

3. Select options and complete fields, as appropriate.

4. After all entries are complete, click the appropriate pushbutton at the bottom of the window.

2–38 User Guide

Receiving a File Using an Edit Transfer Window

Receiving a File Using an Edit Transfer Window Use the Edit Transfer window - Receive File to specify options for a receive file transfer.

Accessing the Receive File Window

Access the Edit Transfer window - Receive File from the main window when the type of transfer selected is receive file. The fields will contain the values defined in the open configuration file or in XCOM.GLB.

Considerations

Before completing this window, you must know the following:

■ Remote System

■ Local File

■ Remote File

Using Unicenter CA-XCOM Data Transport 2–39

Receiving a File Using an Edit Transfer Window

■ File Option

■ Remote System Type

■ Maximum Record Length

Obtain this information before completing the following procedure.

Procedure

To complete the required fields in the Receive File window, follow these steps:

Note: For more information, see Using the Edit Transfer Windows earlier in this chapter.

1. Type the name of the remote system and click in Remote File.

The name of the remote system is specified and the cursor is positioned in the Remote File field.

2. Type the name of the remote file and click in Local File.

The name of the remote file is specified and the cursor is positioned in the Local File field.

3. Type the name of the local file.

The name of the local file is specified.

4. In the File option group, click the Create, Append, or Replace option button.

The selected option button is filled in, and some additional fields may be displayed.

5. In the Remote system type group, click the MVS/VM, VSE, or Other option button.

The option is selected, and some additional fields may be displayed.

6. Select options and complete fields, as appropriate.

7. After all entries are complete, click the appropriate pushbutton at the bottom of the window.

2–40 User Guide

Using the Version 2 Window—Checkpoint, Restart, Protocol, Port

Using the Version 2 Window—Checkpoint, Restart, Protocol, Port

Use the Version 2 window to specify settings for checkpoint count, number of retries and retry interval, and to specify settings for SNA/APPC or TCP/IP protocols and TCP/IP port options, only when the remote system is running Unicenter CA-XCOM Data Transport Version 2.

Accessing the Version 2 Window

Access the Version 2 window by clicking on the Version 2 pushbutton in an Edit Transfer window or clicking in the associated empty checkbox.

Note: When the Protocol option is set for TCP/IP, the checkbox for the Version 2 option is not displayed.

If the partner Unicenter CA-XCOM Data Transport is Version 2, you can use either Version 1 or Version 2 Unicenter CA-XCOM Data Transport protocols. If the partner Unicenter CA-XCOM Data Transport is Version 1, you cannot use Version 2 protocols. Since most partners use Version 2, use this unless you encounter a problem.

If you want Unicenter CA-XCOM Data Transport to perform checkpointing and to enable automatic restart, you must use Version 2 protocols.

For a detailed explanation of checkpointing and restarting, see Checkpointing and Restarting Transfers in the chapter “The Command Line Interface.”

If you want Unicenter CA-XCOM Data Transport to perform transfers using TCP/IP, you must use Version 2 protocols.

Using Unicenter CA-XCOM Data Transport 2–41

Using the Version 2 Window—Checkpoint, Restart, Protocol, Port

If you are performing a transfer that uses a protocol value for SNA/APPC or TCP/IP that is different from the default value, you must select the appropriate protocol option in the Version 2 window.

Note: If only the TCP/IP Component is installed with the base components of Unicenter CA-XCOM Data Transport, the default value for the protocol is set for TCP/IP.

If you are performing a TCP/IP transfer that requires a port value for the remote system that is different from the default value, specify the value in the Port option box in the Version 2 window.

For more information about SNA/APPC protocols and TCP/IP, see the chapter “The Command Line Interface.”

Considerations

Before completing this window, to use checkpoint/restart features, you must determine the checkpoint count, number of retries and retry interval that you wish to use. Obtain this information before completing the Checkpoint/Restart procedure.

If you are performing a transfer that uses a protocol value for SNA/APPC or TCP/IP that is different from the default value, you must know which protocol to use. If you are performing a TCP/IP transfer that requires a port value for the remote system that is different from the default value, you must know that port value. Note that the default value for Port should be valid for most remote hosts. Obtain this information before completing the Protocol/Port procedure.

Procedure – Checkpoint/Restart

To complete the required fields for checkpointing and restarting transfers, follow these steps:

1. Type the checkpoint count and click in Number of retries.

The checkpoint count is specified and the cursor is positioned in the Number of retries field.

2. Type the number of retries and click in Retry interval.

The number of retries is specified and the cursor is positioned in the Retry interval field.

Note: The default value for Port should be valid for most remote hosts.

3. Type the interval of time for each retry and click OK.

The options are specified and the Edit Transfer window is displayed.

2–42 User Guide

Using the Version 2 Window—Checkpoint, Restart, Protocol, Port

Procedure – Protocol/Port

To change the default values of protocol or port, or both, follow these steps:

1. Select the SNA/APPC option button for a transfer using SNA/APPC, or select the TCP/IP option button for a transfer using TCP/IP.

The protocol is specified. If you selected TCP/IP, the Port option becomes available.

Note: If the SNA/APPC option is selected, the Port option is dimmed, and is unavailable.

2. If you are required to change the Port value for the remote system, specify the port number in the Port option box.

The Port is specified for a TCP/IP transfer.

3. Click OK.

The options are specified and the Edit Transfer window is displayed.

Fields

The following table describes the Version 2 window field names:

Field Description

Checkpoint count Defines how often (based on record count) the sending system requests a checkpoint to be taken. The value 0 indicates no checkpointing.

Number of retries Indicates the maximum number of retries before a transfer is logged as failed. If the value is 0, the transfer will not be retried.

Retry time The number of seconds between retries of unsuccessful transfers. If the value is 0, the transfer is retried without delay.

SNA/APPC If this option is selected, the transfer uses SNA/APPC protocols.

TCP/IP If this option is selected, the transfer uses TCP/IP protocols.

Port This option box is available if the TCP/IP protocol option is selected. This option is dimmed and is unavailable if the SNA/APPC protocol option is selected. This is the default value for the remote system. The default Port value is 8044. This value should be valid for most remote hosts.

Using Unicenter CA-XCOM Data Transport 2–43

Specifying User IDs and Passwords for File Access

Pushbuttons

The following pushbuttons are available at the bottom of this window:

Button Function

OK Accept the specified parameters. The Edit Transfer window is displayed.

Cancel Exit this window without accepting any specified parameters. The Edit Transfer window is displayed.

Specifying User IDs and Passwords for File Access Use the Security window to specify user IDs and passwords for accessing files on remote systems and local systems.

2–44 User Guide

Specifying User IDs and Passwords for File Access

Accessing the Security Window

Access the Security window by clicking on the Security pushbutton in an Edit Transfer window or clicking in the associated empty checkbox.

In general, a remote system requires a password and user ID, and NT may require a domain name, before Unicenter CA-XCOM Data Transport can perform transfers. The access rights of the user ID on the remote system determine the actions permitted for the transfer. You can also specify whether this remote system has trusted access to the local system, as defined by permissions set by the Trusted Access application. If the Security checkbox is not checked, the default security on the remote system will be in effect.

For Local file access, specify user ID and Password name for the following:

■ To access a file on a server that you are not already attached to

■ To access a file under a Username that is different from the one you used to attach to the server

Access to Unicenter CA-XCOM Data Transport for Windows NT and associated files is governed by the security policies that are in effect for your Windows environment. Passwords are case sensitive.

Considerations

Before completing this window, you must know the following:

■ User ID on the remote system

■ Password on the remote system

■ User ID on the local system for file access (optional)

■ Password on the local system for file access (optional)

■ The Windows domain name for the local system (optional)

■ Whether the remote system has Trusted Access or not

Procedure

To complete the required security fields, follow these steps:

1. In the Remote system access group, enter the user ID on the remote system.

2. Enter the password of the user on the remote system.

3. Enter the domain name of the remote system.

4. If this is to be a trusted transfer, check the Trusted Transfer box.

Using Unicenter CA-XCOM Data Transport 2–45

Specifying User IDs and Passwords for File Access

5. In the Local file access group, enter the user ID of the user on the local system.

6. Enter the password of the user on the local system and click OK.

7. Click OK.

Remote System Access Fields

The following table describes the Remote system access field names:

Field Description

User ID The user ID that the security system on the remote system checks before granting access for the file transfer.

Password The password associated with the user ID on the remote system.

Domain The domain name of the remote system.

Trusted Transfer button

Specifies whether this transfer is a Trusted Transfer. See Setting Up Trusted Access in the chapter “Operating Environment” in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Administrator Guide and the online help.

Local File Access Fields

The following table describes the local system access field names:

Field Description

User ID The Username associated with the local file.

Password The password associated with the local file.

Pushbuttons

The following pushbuttons are available at the bottom of this window:

Button Function

OK Accept the specified parameters. The Edit Transfer window is displayed.

Cancel Exit this window without accepting any specified parameters. The Edit Transfer window is displayed.

2–46 User Guide

Notifying Local Users of Transfer Completion

Notifying Local Users of Transfer Completion Use the Local Notify dialog to specify the local user who is to be notified that a transfer has been sent or received. Also, use this dialog to specify how the local user will be notified.

Accessing the Local Notify Dialog

Access the Local Notify dialog by clicking on the Local Notify pushbutton in an Edit Transfer window or clicking in the associated empty checkbox. Choose a type of notification from the drop-down list and then indicate the name of the local user to be notified.

Considerations

Before completing the Local Notify dialog, you must know the Local User name and the type of notification you wish to use.

Procedure

To complete the required fields in the Local Notify dialog, follow these steps:

1. Use the drop-down lists to select a method and level for notifying the local user and click in Local User.

The notification method and level are specified and the cursor is positioned in the Local User field.

2. Type the name of the local user to whom notification is to be sent and click OK.

The name of the local user is specified and the Edit Transfer window is displayed.

Using Unicenter CA-XCOM Data Transport 2–47

Notifying Local Users of Transfer Completion

Drop-down Lists

The following options are available on the drop-down list associated with the Local Notify dialog. Use these options to set the local user notification level.

Option Function

ALL Notify on transfer completion.

WARN Notify only if the transfer received a warning or an error.

ERROR Notify only if the transfer received an error.

The following options are available on the drop-down list associated with the Local Notify dialog. Use these options to set the type of local user notification.

Option Function

ALL Notify all users.

WRITE Write to the operator.

MAIL Mail to the user.

NONE Do not notify.

A MAIL message is sent to the specified user only if a MAPI-compliant provider is configured as a non-domain account and/or allows local accounts (such as the xcomd service and the local user ID) access to the Windows system (for example, Microsoft Mail boxes and address books on the local system).

Note: Some Microsoft Outlook 2003 security updates may prevent mail notification from working.

Field

The following field is associated with the Local Notify dialog:

Field Definition

Local User The user on the local system who is to be notified when Unicenter CA-XCOM Data Transport completes a transfer.

For mail notification, enter the name of a person listed in the address book on the local system. This name must be 12 characters or less.

2–48 User Guide

Notifying Remote Users of Transfer Completion

Pushbuttons

The following pushbuttons are available at the bottom of the Local Notify dialog:

Button Function

OK Accept the specified parameters. The Edit Transfer window is displayed.

Cancel Exit this dialog without accepting any specified parameters. The Edit Transfer window is displayed.

Notifying Remote Users of Transfer Completion Use the Remote Notify dialog to specify the remote user who is to be notified that a transfer has been sent or received. Also, use this dialog to specify how the remote user will be notified.

Accessing the Remote Notify Dialog

Access the Remote Notify dialog by clicking on the Remote Notify pushbutton in an Edit Transfer window or clicking in the associated empty checkbox. Choose a type of notification from the drop-down list and then indicate the name of the remote user to be notified.

Considerations

Before completing this dialog, you must know the Remote User name and the type of notification you wish to use.

Using Unicenter CA-XCOM Data Transport 2–49

Notifying Remote Users of Transfer Completion

Procedure

To complete the required fields in the Remote Notify dialog, follow these steps:

1. Use the drop-down list to select a method and level for notifying the remote user and click in Remote User.

The notification method and level are specified and the cursor is positioned in the Remote User field.

2. Type the name of the remote user to whom notification is to be sent and click OK.

The name of the remote user is specified and the Edit Transfer window is displayed.

Drop-down List

The following options are available on the drop-down list associated with the Remote Notify dialog. Use these options to set the remote user notification level.

Option Function

ALL Notify on transfer completion.

WARN Notify only if the transfer received a warning or an error.

ERROR Notify only if the transfer received an error.

The following options are available on the drop-down list associated with the Remote Notify dialog. Use these options to set the type of remote user notification.

Option Function

MAIL Mail to the user.

WRITE Write to the operator.

ALL Notify all users.

TSO Notify specified TSO user.

WTO Write to log only (WTO).

ROSCOE Notify specified Advantage™ CA-Roscoe® user.

CICS Notify CICS user (not used for Version 1 type transfers).

LU Notify Logical Unit (not used for Version 1 type transfers).

NONE Do not notify.

2–50 User Guide

Notifying Remote Users of Transfer Completion

A MAIL message is sent to the specified user only if a MAPI-compliant provider is configured as a non-domain account and/or allows local accounts (such as the xcomd service and the local user ID) access to the Windows system (for example, Microsoft Mail boxes and address books on the local system).

Note: Some Microsoft Outlook 2003 security updates may prevent mail notification from working.

Field

The following field is associated with the Remote Notify dialog:

Field Definition

NOTIFY_NAME The user on the remote system who is to be notified when Unicenter CA-XCOM Data Transport completes a transfer. For MAIL notification, enter the name of a person in the address book on the remote system. This name must be 12 characters or less.

Note: If the remote system is an IBM mainframe, Unicenter CA-XCOM Data Transport uses the value of NOTIFYR to determine the type of notification to deliver.

Pushbuttons

The following pushbuttons are available at the bottom of the Remote Notify dialog:

Button Function

OK Accept the specified parameters. The Edit Transfer window is displayed.

Cancel Exit this window without accepting any specified parameters. The Edit Transfer window is displayed.

Using Unicenter CA-XCOM Data Transport 2–51

Setting Compression Type for a Transfer

Setting Compression Type for a Transfer Use the Compression window to define the compression type to be used on a transfer for the remote system.

Accessing the Compression Window

Access the Compression window by clicking on the Compression pushbutton in an Edit Transfer window or clicking in the associated empty checkbox. Choose the type of compression from the drop-down list.

Considerations

Before completing this window, you must know the type of compression to set. Obtain this information before completing the following procedure.

Procedure

To complete the required fields in the Compression window, use the drop-down list to select the type of compression to be applied to this transfer and click OK.

The compression type is specified and the Edit Transfer window is displayed.

2–52 User Guide

Setting Compression Type for a Transfer

Drop-down List

The following options are available on the drop-down list associated with the Compression window. Use these options to set the type of compression.

Note: All compression types are not supported on all platforms. For supported compression types, see the partner platform documentation.

Option Function

NONE Indicates no compression.

BLANKS Indicates run length encoding of binary zeros and blanks only.

COMPACT RJE compaction algorithm optimized for uppercase English text.

LCOMPACT RJE compaction algorithm optimized for lowercase English text.

RLE Run length encoding.

LZRW3 General-purpose algorithm that runs fast and gives reasonable compression.

LZSMALL Activates LZ compression to search back 4K in the data stream for a matching string.

LZMEDIUM Activates LZ compression to search back 16K in the data stream for a matching string.

LZLARGE Activates LZ compression to search back 32K in the data stream for a matching string.

ZLIB Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and LZLARGE. Equivalent to ZLIB6.

ZLIB(n) Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and LZLARGE. The optional n value can be 1 through 9.

Pushbuttons

The following pushbuttons are available at the bottom of this window:

Button Function

OK Accept the specified parameters. The Edit Transfer window is displayed.

Cancel Exit this window without accepting any specified parameters. The Edit Transfer window is displayed.

Using Unicenter CA-XCOM Data Transport 2–53

Sending an Indirect Transfer

Sending an Indirect Transfer Use the Indirect Transfer window to send a transfer to a remote system through an intermediary z/OS or VSE system. This feature is not available for Receive File transfers.

Accessing the Indirect Transfer Window

Access the Indirect Transfer window by clicking on the Indirect Transfer pushbutton in an Edit Transfer window or clicking in the associated empty checkbox. Indirect transfers are used to temporarily store a file on an IBM mainframe system when the remote system is unavailable. For more information about indirect transfers, see Using Store and Forward in the chapter “The Command Line Interface.”

Considerations

Before completing this window, you must know the name of the intermediate system. Obtain this information before completing the following procedure.

Procedure

To complete the required fields in the Indirect Transfer window, type the name of the Intermediate System and click OK.

The name of the intermediate system is specified and the Edit Transfer window is displayed.

2–54 User Guide

Setting System Environment Variables—Reports Containing Machine Code Characters

Field

The following field is associated with the Indirect Transfer window:

Field Definition

Intermediate System

For transfers using SNA/APPC, specifies the name of the CPI-C Symbolic Destination Name on the intermediate destination.

For transfers using TCP/IP, specifies the IP address, host name, or domain name of the intermediate destination.

If this value is not set or null, a direct connection to the remote system is attempted.

Pushbuttons

The following pushbuttons are available at the bottom of this window:

Button Function

OK Accept the specified parameters. The Edit Transfer window is displayed.

Cancel Exit this window without accepting any specified parameters. The Edit Transfer window is displayed.

Setting System Environment Variables—Reports Containing Machine Code Characters

Unicenter CA-XCOM Data Transport processes machine code characters in reports sent from the mainframe under two conditions:

■ CODE=MACHINE is specified for FILETYPE=REPORT

■ For a PSO report, the report is sent from a machine code data set such as an FBM data set

For each line that begins with a recognizable printer channel command code, Unicenter CA-XCOM Data Transport inserts the appropriate ASCII printer control characters at the beginning of the line.

Using Unicenter CA-XCOM Data Transport 2–55

Setting System Environment Variables—Reports Containing Machine Code Characters

All channel commands (that is, Skip to Channel, Write and Skip to Channel) are translated to a form feed character (0C) followed by a specified number of carriage return line feed pairs. If no variables are set, no carriage return line feed pairs will be inserted. The number of carriage return line feed pairs inserted depends upon the value of the corresponding system environment variable. To set an environment variable on Win2000, right click on My Computer, select Properties, then click on the Environment tab. Add the variables as system variables and reboot the machine.

Important! For information about setting environment variables on Windows NT and Windows XP, see your Windows documentation.

There is an associated variable for each channel command (24 variables in all).

For Set Variables

Skip to Channel 1-12 XCOM_SKCH1, XCOM_SKCH2 through XCOM_SKCH12

Write and Skip to Channel 1-12

XCOM_WRSKCH1, XCOM_WRSKCH2 through XCOM_WRSKCH12

To turn off automatic machine code processing for all reports, add a system environment variable XCOM_MACH=NO.

Examples

To have Skip to Channel One to skip 1 line after the top of form, set XCOM_SKCH1 equal to 1.

To have Write and Skip to Channel One to skip 3 lines after the top of form, set XCOM_WRSKCH1 equal to 3.

2–56 User Guide

Debugging Problems and Tracing

Debugging Problems and Tracing Use the Debugging window to set the trace level when requested by Unicenter CA-XCOM Data Transport Technical Services.

Accessing the Debugging Window

Access the Debugging window by clicking on the Debugging pushbutton in an Edit Transfer window or clicking in the associated empty checkbox. The trace output is primarily intended to provide information to Unicenter CA-XCOM Data Transport Technical Services, and they will usually request a level of tracing for you to use. This trace facility collects information about a transfer from the point where a transfer is queued or submitted and a connection is established. The resulting trace data is stored in a file named tidnumber.TRA, where tidnumber = the transfer ID. For information about additional tracing facilities for Unicenter CA-XCOM Data Transport system level components, see Trace Properties Tab Page later in this chapter.

Procedure

to complete the required fields in the debugging window, use the drop-down list to select the trace level to be applied to this transfer and click OK.

The trace level is specified and the Edit Transfer window is displayed.

Drop-down List

The following options are available on the drop-down list associated with the Debugging window. Use these options to set the level of desired execution tracing.

Option Function

None None is the default

1 to 10 A range, where 1 is minimum, and 10 is maximum

Using Unicenter CA-XCOM Data Transport 2–57

Scheduling Transfers

Pushbuttons

The following pushbuttons are available at the bottom of this window:

Button Function

OK Accept the specified parameters. The Edit Transfer window is displayed.

Cancel Exit this window without accepting any specified parameters. The Edit Transfer window is displayed.

Scheduling Transfers Use the Schedule window to set a specific time and date for a particular transfer.

Accessing the Schedule Window

Access the Schedule window by clicking on the Schedule pushbutton from an Edit Transfer window or clicking in the associated empty checkbox. You can specify a start time, a start date and a priority level. Transfers can be scheduled to run independently of whether or not the specific user is logged on. A scheduled transfer is under the control of the XCOMD Unicenter CA-XCOM Scheduler Service.

2–58 User Guide

Scheduling Transfers

If XCOMD Unicenter CA-XCOM Scheduler Service is running, the user does not have to be logged on for a scheduled transfer to be processed. That is, you can schedule a transfer and log off, and it will run as scheduled. Likewise, a remotely initiated transfer can be processed without the local user being logged on, as long as the XCOMD Unicenter CA-XCOM Scheduler Service is running.

Note: If the Schedule option in the Options group box is selected, it is the equivalent of setting the QUEUE parameter to QUEUE=YES. When the transfer is submitted, the transfer request goes into a queue and executes depending on the traffic in the queue and the values in START_DATE and START_TIME. If the Schedule option in the Options group box is not checked, when the transfer is submitted, it starts immediately. This may or may not affect the performance of the transfer, depending on your settings.

Considerations

Before completing this window, you must know the following:

■ Date on which the transfer is to be sent

■ Time at which the transfer is to be sent

Obtain this information before completing the following procedure.

Procedure

To complete the required fields in the Schedule window, follow these steps:

1. In the Start Time group, click the spin buttons to select a start time for this transfer.

The Start Time is selected.

2. In the Start Date group, click the spin buttons to select a start date for this transfer.

The Start Date is selected.

3. Use the Priority drop-down list to select a high, normal, or low priority level for this transfer and click OK.

The priority is selected and the Edit Transfer window is displayed.

Using Unicenter CA-XCOM Data Transport 2–59

Scheduling Transfers

Priority Menu Options

The following scheduling priority options are available on the drop-down list associated with the Schedule window. Use these options to set the priorities for Unicenter CA-XCOM Data Transport’s scheduling of transfers.

Option Function

High Set high priority.

Normal Set medium priority.

Low Set low priority.

If two transfers are scheduled for the same time, the one with the high priority would be processed before one with a normal or low priority.

Fields

The following table describes the Schedule window field names:

Field Definition

Start Date Set a scheduled date for a particular transfer.

Start Time Set a scheduled time for a particular transfer.

Pushbuttons

The following pushbuttons are available at the bottom of this window:

Button Function

OK Accept the specified parameters. The Edit Transfer window is displayed.

Cancel Exit this window without accepting any specified parameters. The Edit Transfer window is displayed.

2–60 User Guide

Performing Secure Socket Transfers

Performing Secure Socket Transfers Use the Secure Socket window to indicate whether the PROTOCOL=TCPIP transfer will use a secure or non-secure socket.

Accessing the Secure Socket Window

Access the Secure Socket window by clicking on the Secure Socket pushbutton in an Edit Transfer window or clicking in the associated empty checkbox. The Secure Socket window specifies whether the PROTOCOL=TCPIP transfer uses either a secure or non-secure socket.

The Secure Socket window also defines the Unicenter CA-XCOM Data Transport secure socket configuration file.

Procedure

To complete the Secure Socket window, follow these steps:

1. Select the Secure Socket option for a PROTOCOL=TCP/IP transfer using Secure Sockets or select the Non Secure Sockets option for a PROTOCOL=TCP/IP transfer using Non Secure Sockets.

The Secure Socket option is specified.

2. Type the full path and file name of the Unicenter CA-XCOM Data Transport secure socket configuration file.

The Secure Socket File path and name is specified.

3. Click OK.

The options are specified and the Edit Transfer window displays.

Using Unicenter CA-XCOM Data Transport 2–61

Browsing the Log File

Pushbuttons

The following pushbuttons are available in the Secure Socket window:

Button Function

OK Accepts the specified parameters. The Edit Transfer window displays.

Cancel Exits this window without accepting any specified parameters. The Edit Transfer window displays.

Browsing the Log File Use the Log Browser window to display the Unicenter CA-XCOM Data Transport log file. The log file collects a list of transfer information.

2–62 User Guide

Searching for Information in the Log

Accessing the Log Browser Window

Access the Log Browser window by clicking on the Log pushbutton on the Unicenter CA-XCOM Data Transport main window. The Log Browser window is for inquiry only and is used as the starting point to find and filter specific details on transfers. Unicenter CA-XCOM Data Transport automatically collects and stores information about transfers such as when a transfer was started, stopped, completed, deleted, suspended, or aged off of the queue.

Procedure

To select the Find Window, click Find.

The Find window is displayed.

Pushbuttons

The following pushbuttons are available in this window:

Button Function

Find Open the Find window to search for specified expression. For more information, see Searching for Information in the Log in this chapter.

Close Close this window.

Searching for Information in the Log Use the Find window to specify a particular text string to use when searching for information about a transfer in the log file.

Using Unicenter CA-XCOM Data Transport 2–63

Searching for Information in the Log

Accessing the Find Window

Access the Find window by clicking on the Find pushbutton in the Log Browser window. Use this window to search for a string specified in the Find field. This string can be case sensitive and you can search forward or backward through the Unicenter CA-XCOM Data Transport log file. The results are displayed on the Log Browser. You can search for information such as time, date, Transfer ID and error message text.

Procedure

To set search criteria, follow these steps:

1. Type an expression to search for in the Find field.

The expression is displayed in the Find field.

2. Indicate whether search is case sensitive by clicking in checkbox and click Next or Previous.

The Log Browser window is displayed with an occurrence of the selected search criteria.

Field

The following field is associated with the Find window:

Field Description

Find Lets you specify the expression to search on.

Checkbox

The following checkbox is associated with the Find window:

Option Description

Case sensitive search Lets you indicate whether the search should be case sensitive.

2–64 User Guide

Viewing and Controlling Transfer Status

Pushbuttons

The following pushbuttons are available at the bottom of this window:

Button Function

Next Start a forward search.

Previous Start a backward search.

Close Close this window.

Viewing and Controlling Transfer Status Use the Queue Status window to view the status of transfers and perform actions on transfers. This window can be used while the transfer is in progress or after it has been completed.

Using Unicenter CA-XCOM Data Transport 2–65

Viewing and Controlling Transfer Status

Accessing the Queue Status Window

Access the Queue Status window by clicking on the Queue Manager pushbutton in the main window. From this window, authorized users can perform functions on the queued transfers, such as viewing detailed information or deleting, suspending and putting a transfer on hold. Use the drop-down lists in the menu bar to specify the information to be displayed here, including Transfer ID, status, results of the transfer, and other useful information. The size of each displayed field can be customized by selecting the left or right border of the field title box and dragging it left or right. You can also delete a field from the display by selecting the field title box and dragging it off the field title bar. For detailed information about a selected transfer from this window, see Viewing Transfer Status Details later in this chapter.

Transfer Failure in Starting State

When a queued transfer is initiated, it is entered into the transfer queue. Then, when it is scheduled to run, it goes into the starting state. If for some reason the transfer fails to go beyond this state within 10 minutes and does not go into the started state (where the transfer connection has been initialized and the transfer of information begins), it is treated as a failure. The transfer is attempted again, depending on the values in the Version 2 window for Number of retries and Retry interval. The corresponding parameters are RESTART_SUPPORTED and RETRY_TIME.

Procedure

To manage transfers listed on the Queue Status window, do one of the following:

■ Highlight a transfer on the list and click a pushbutton.

The Detail window is displayed or the appropriate action is taken.

■ Highlight a transfer on the list and select an action from a drop-down list.

The Queue Status window is displayed with the selected information.

2–66 User Guide

Viewing and Controlling Transfer Status

Menu Bar Selections

See the following table for Queue Status menu bar selections and explanations:

Selection Options

Fields Use the following options to specify which fields you want displayed on the transfer list:

Field Description

User Name of the user.

TID Transfer ID.

Status Transfer status, for example, started, active, done.

Condition Result of a transfer, for example, failed, succeeded.

Start time Time the transfer started.

End time Time the transfer ended.

Local File Name of the local file.

Direction Symbol that indicates who initiated the transfer and the direction of the transfer. See Queue Status Direction Symbols below.

Partner Name of the remote system.

Remote file The name of the file on the remote system.

Message Displays informational and error messages.

Default Display the Queue Status with the default set of fields.

Scope Use the following options to set the scope of the transfers displayed:

Selection Definition

User Display a list of all transfers by a user.

All Display a list of all transfers.

Using Unicenter CA-XCOM Data Transport 2–67

Viewing and Controlling Transfer Status

Pushbuttons

The following pushbuttons are available from this window:

Button Function

Details Open the Details window.

Delete Delete a transfer. When a transfer is active, the pushbutton changes to CANCEL.

Suspend

Resume

Suspend allows you to suspend an active transfer.

Resume allows you to resume a suspended transfer.

Put on Hold

Release

Put on Hold allows you to hold a scheduled transfer.

Release allows you to release a held transfer.

Close Close this window.

Queue Status Direction Symbols

Refer to the following table for explanations of the symbols for transfers in the Queue status window:

Symbol Description

Right arrow indicates a locally initiated send transfer.

Indicates a locally initiated receive transfer.

Left arrow indicates a remotely initiated receive transfer.

Indicates a remotely initiated send transfer.

2–68 User Guide

Viewing Transfer Status Details

Viewing Transfer Status Details Use the Details window to view the status of a transfer while it is in progress and after it has completed. This window is for inquiry only.

Accessing the Details Window

Access the Details window by clicking on the Details pushbutton in the Queue Status window or by double-clicking the transfer. The detailed information provided includes the transfer ID (TID) number, the remote system, the local and remote file names, the start and end times of the transfer, and other statistics, as well as informational messages.

Procedure

To view the Details window, highlight a transfer on the Queue Status transfer list and click Details, or double-click the transfer.

If the transfer is in progress, the window displays changes as they occur. If the transfer has been completed, the window displays final transfer information.

Using Unicenter CA-XCOM Data Transport 2–69

Using the Properties Dialog Pages

Fields

Refer to the following table for Details window field names and descriptions. These fields are informational and cannot be updated. If you are viewing this window while a send transfer is in progress, a status bar displays the transfer’s incremental progress.

Field Displays

Start time An estimated time to execute the transfer.

End time The time that the transfer operation ended.

Bytes The number of bytes sent.

Bytes/sec The number of bytes per second since the beginning of the transfer.

Records The number of records sent.

Records/sec The number of records per second since beginning of the transfer.

TP status The status of the transfer.

Pushbutton

The following pushbutton is available at the bottom of this window:

Button Function

Close Close this window. The Queue Status window is displayed.

Using the Properties Dialog Pages The Properties dialog pages are primarily for use by Unicenter CA-XCOM Data Transport administrators and system administrators.

WARNING! The values of the options on the Properties dialog pages should only be changed by authorized Unicenter CA-XCOM Data Transport administrators. Most users will not need to change these values. The values should not be changed or deleted unnecessarily. If any of these values are deleted unnecessarily, the results are unpredictable.

2–70 User Guide

Using the Properties Dialog Pages

Use the Properties dialog pages to change global parameters from the GUI, if necessary. Changes made to these system parameters affect the values in XCOM.GLB and in the Windows Registry. While you can use an editor to modify the XCOM.GLB file and the Registry directly, we recommend that you use the Unicenter CA-XCOM Data Transport for Windows NT Properties dialog if you need to modify the values for the more common global parameters.

Accessing the Properties Tab Pages

Access the Unicenter CA-XCOM Data Transport for Windows NT Properties dialog from the Unicenter CA-XCOM Data Transport for Windows NT Main window, by selecting the Tools menu, and then the Global parameters option to display the Unicenter CA-XCOM Data Transport for Windows NT Properties dialog.

At the top of the Properties dialog there are seven tabs. Click a tab to display a tab page. The following table lists the tabs and the functions of their associated tab pages. Each tab page is described in detail in the sections that follow.

Tab Page Function

Character Conversions For modifying default locations of character conversion files, and modifying character conversion options.

Incoming Transfers For modifying default options to use for incoming transfers.

Queue For modifying default paths and file names for queue information, modifying default queue options, and maximum session entries.

Security For modifying default security information and notification options.

System For modifying default paths and file names for Unicenter CA-XCOM Data Transport system commands.

TCP/IP For modifying default values of system parameters used for TCP/IP transfers.

Trace For modifying default values and options for Unicenter CA-XCOM Data Transport tracing facilities.

Using Unicenter CA-XCOM Data Transport 2–71

Using the Properties Dialog Pages

Considerations

For more information about the parameters and values that correspond to the options on the Properties dialog pages, see the appendix “List of Unicenter CA-XCOM Data Transport Parameters.” If the functions of the options on the Properties dialog pages differ from the parameters or require clarification, they are described here.

Procedure

To access a tab page, modify options, and apply them, follow these steps:

1. With the Properties dialog displayed, click a tab to display a tab page.

2. Modify values in the following ways:

■ Enter values into the option boxes.

■ Click a Browse button to select a path or file.

■ Click an option box or option button to select or deselect an option.

■ Click an arrow to display a drop down list, and click an item to select it.

3. After you have made the desired changes on the tab page, do one of the following:

■ Click the OK button to accept the changes and close the Properties dialog.

The appropriate global files are updated.

■ Click the Cancel button to cancel the changes and close the Properties dialog.

No changes are made to the global files.

■ Click the Apply button to accept the changes and keep the tab page displayed.

A message is displayed stating that you must recycle Unicenter CA-XCOM Data Transport for the changes to take effect. Click OK. Then a message is displayed indicating that the appropriate global files are updated. (You still need to Stop and Start XCOMD Unicenter CA-XCOM Scheduler Service for the changes to take effect.)

Note: Clicking Apply without making any changes has no effect.

Note: If you make changes to any of the options in the Properties dialog, you must Stop and Start XCOMD Unicenter CA-XCOM Scheduler Service for the changes to take effect.

2–72 User Guide

Using the Properties Dialog Pages

Character Conversions Properties Tab Page

Use the Character Conversions Properties tab page to modify the global default values for the locations of character conversion files, and to modify character conversion option defaults. For more information, see Creating Custom Character Sets for File Conversion in the chapter “The Command Line Interface.”

Using Unicenter CA-XCOM Data Transport 2–73

Using the Properties Dialog Pages

Options

The following table describes the available options on the Character Conversion Properties tab page, and their associated parameters.

Option Description

ATOE Filename ATOE_FILENAME

Click the Browse button to select a different file to use for the default for ASCII to EBCDIC conversions. Note that the directory dialog filters for .TAB files.

ETOA Filename ETOA_FILENAME

Click the Browse button to select a different file to use for the default for EBCDIC to ASCII conversions. Note that the directory dialog filters for .TAB files.

Convert Classes CONVERT_CLASSES

A character string containing print classes for which EBCDIC to ASCII conversions will be performed. For incoming report transfers only.

Internal Conversion Table

INTERNAL_CONVERSION_TABLES

Indicates whether internal or external conversion tables should be used for ASCII-to-EBCDIC conversion and EBCDIC-to-ASCII conversion.

2–74 User Guide

Using the Properties Dialog Pages

Incoming Transfers Properties Tab Page

Use the Incoming Transfers Properties tab page to modify global default options to use for incoming transfers.

Using Unicenter CA-XCOM Data Transport 2–75

Using the Properties Dialog Pages

Options

The following table describes the available options on the Incoming Transfers Properties tab page, and their associated parameters.

Option Description

EOL Classes EOL_CLASSES

A character string containing print classes for which an ASCII newline character will be appended to each record. For incoming report transfers only.

Metacode Classes METACODE_CLASSES

Classes of print jobs that will be saved in metacode format, a variable length record format.

Create Directories CREATE_DIRECTORIES

Indicates whether a non-existent directory should be created to accommodate incoming file transfers.

Remove Trail Blanks REMOVE_TRAIL_BLANKS

Indicates whether or not to remove the blanks at the end of each record when receiving a text file.

Add EOF Marker WRITE_EOF

When receiving a text file, set to YES to have the end of file character (CTRL + Z) written at the end of the file.

2–76 User Guide

Using the Properties Dialog Pages

Queue Properties Tab Page

Use the Queue Properties tab page to modify global default options for queue information, and for XCOM.SES.

Using Unicenter CA-XCOM Data Transport 2–77

Using the Properties Dialog Pages

Options

The following table describes the available options on the Queue Properties tab page, and their associated parameters.

Option Description

Queue Path QUEUE_PATH

Click the Browse button to select a different default path for transfer queue data files.

Sessions File SESSIONS_FILE

Click the Browse button to select a different default path and file name for XCOM.SES. Note that the directory dialog filters for .SES files.

Expiration Time EXPIRATION_TIME

The maximum time, in seconds, that a transaction is held in the transfer queue after it is executed.

Max Queue Entries MAX_QUEUE_ENTRIES

The maximum number of entries allowed in the transfer queue.

Max Sessions Entries MAX_SESSIONS_ENTRIES

The maximum number of partners that can be described in the XCOM.SES file.

Age Time AGE_TIME

The maximum time, in seconds, that a transaction is held in the transfer queue.

2–78 User Guide

Using the Properties Dialog Pages

Security Properties Tab Page

Use the Security Properties tab page to modify global default options for security and notification.

Using Unicenter CA-XCOM Data Transport 2–79

Using the Properties Dialog Pages

Options

The following table describes the available options on the Security Properties tab page, and their associated parameters.

Option Description

File Access Username FILE_ACCESS_USERNAME

Name of user accessing local files.

File Access Password FILE_ACCESS_PASSWORD

Password for access to local files.

Mail Username MAIL_USERNAME

If NOTIFYR is set to MAIL, specify a value here to use for your messaging system profile name.

Mail Password MAIL_PASSWORD

If NOTIFYR is set to MAIL, specify a value here to use for your messaging system profile password.

Xcom Userid XCOM_USERID

The default user ID for remotely initiated transfers.

Xcom Password XCOM_PASSWORD

The default password for remotely initiated transfers.

Domain DOMAIN

The Windows domain name for use in authenticating the user ID and password

2–80 User Guide

Using the Properties Dialog Pages

System Properties Tab Page

Use the System Properties tab page to modify global default options for paths and file names for Unicenter CA-XCOM Data Transport system commands. For more information about the .BAT files used as scripts for Unicenter CA-XCOM Data Transport, see the chapter “Operating Environment” in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Administrator Guide.

Using Unicenter CA-XCOM Data Transport 2–81

Using the Properties Dialog Pages

Options

The following table describes the available options on the System Properties tab page, and their associated parameters.

Option Description

Shell Cmd SHELL_CMD

Name of the command that runs jobs, reports, notification scripts, and post processing scripts on the local system.

TempDir TEMPDIR

Click the Browse button to select a different default path for the directory in which temporary files for jobs and reports can be created.

Xlogfile XLOGFILE

Click the Browse button to select a different default file name for the file where Unicenter CA-XCOM Data Transport logs activity. Note that the directory dialog filters for .LOG files.

Stat Frequency / Transfer statistics refresh in seconds

STAT_FREQUENCY

Indicates the frequency with which transfer statistics are made available to XCOMQM and the GUI.

Daemon Timeout DAEMON_TIMEOUT

Number of minutes Unicenter CA-XCOM Data Transport will wait for a response from a partner before aborting a session.

Commands group Click the arrow to display a drop down list of executable commands that can be used by Unicenter CA-XCOM Data Transport (.BAT, .EXE). Select a command for which you want to change the directory, or the name of the file or command that is called by that command. Then see Details, below. (The associated parameters and file names are listed here.)

TCP_CMD Path and name of the Unicenter CA-XCOM Data Transport program started by the XCOMD Unicenter CA-XCOM Scheduler service that is used for transfers that use TCP/IP protocols.

File: XCOMTCP.EXE

2–82 User Guide

Using the Properties Dialog Pages

Option Description

TP_CMD Path and name of the Unicenter CA-XCOM Data Transport program started by the XCOMD Unicenter CA-XCOM Scheduler service that is used for transfers that use SNA/APPC protocols.

File: XCOMTP.EXE

XENDCMD The name of the post processing command optionally invoked by the Unicenter CA-XCOM Data Transport transfer program after any type of transfer is finished, whether successful or not. Invoked after partner communications have ended.

File: XCOMEND.BAT

Note: No default.

XLPCMD Name of the post-processing command used to send print jobs to the spooler.

File: XCOMLP.BAT

XNOTIFYCMD Path name of the command that Unicenter CA-XCOM Data Transport will use to notify users on the local system of the completion of a transfer.

File: XCOMNTFY.BAT

XPPCMD The name of the command used for user-defined post-processing.

File: XCOMPP.BAT

Details The default directory and file name of the selected command is displayed in the Details option box. Click the Browse button to select a different directory or file, or both, to be called by the selected command.

Note: The directory dialog filters for .BAT or .EXE files.

Using Unicenter CA-XCOM Data Transport 2–83

Using the Properties Dialog Pages

TCP/IP Properties Tab Page

Use the TCP/IP Properties tab page to modify global default options for system values used for TCP/IP transfers.

2–84 User Guide

Using the Properties Dialog Pages

Options

The following table describes the available options on the TCP/IP Properties tab page, and their associated parameters.

Option Description

Executable Program Path

Default path where Unicenter CA-XCOM Data Transport executable programs should reside, as defined in the Registry.

Client Transfer Settings group

The options in the Client Transfer Settings group are used to specify default values for using TCP/IP, including for tuning and performance. Do not change the default settings unnecessarily.

Port Number

PORT

The number of the TCP/IP port on the remote Unicenter CA-XCOM Data Transport server. The default should be valid for most remote systems.

Sock Rcv Bufsize

SOCK_RCV_BUF_SIZE

TCP/IP Socket option SO_RCVBUF. The buffer size for receives.

Sock Send Bufsize

SOCK_SEND_BUF_SIZE

TCP/IP Socket option SO_SNDBUF. The buffer size for sends.

Sock Delay SOCK_DELAY

TCP/IP Socket option TCP_NODELAY. Refers to the Nagle algorithm for send coalescing.

Txpi Term Timeout

TXPI_TERM_TIMEOUT

Maximum wait time, in seconds, for partner to terminate TCP/IP communications.

Txpi Rcv Timeout

TXPI_RECEIVE_TIMEOUT

Maximum wait time, in seconds, after a TCP/IP failure is detected before a socket error is generated.

Txpi Buf Size

TXPI_BUF_SIZE

For TCP/IP transfers, the internal buffer size for sends and receives.

Using Unicenter CA-XCOM Data Transport 2–85

Using the Properties Dialog Pages

Option Description

Txpi Send Check Freq

TXPI_SEND_CHECK_FREQ

Indicates the frequency that Unicenter CA-XCOM Data Transport checks to see if incoming error information is available when sending data

Server Settings group The options in the Server Settings group are used to specify default values for the Unicenter CA-XCOM Data Transport communications server. They affect how the server functions for setting up the environment for receiving clients, server termination, and other functions. Values here are defined in the Registry.

Port Number The port number for the local machine. The default should be valid for most local systems.

Maximum Clients

The maximum number of concurrent client connections.

Termination Loop

Indicates how often the caxcgsvr listener process waits before terminating threads during XCOMD Unicenter CA-XCOM Scheduler service shutdown.

Termination Delay

Indicates how long the caxcgsvr listener process waits before terminating threads during XCOMD Unicenter CA-XCOM Scheduler service shutdown.

WARNING! Do not change these values unless you are requested to do so by Computer Associates Customer Support.

Protocol Setting

PROTOCOL The type of communication protocols to use.

Implicit Packing Setting

IMPLICIT_ PACKING

Indicates whether TCP/IP should always use packing.

2–86 User Guide

Using the Properties Dialog Pages

Option Description

Secure Socket Server Settings Group

SSL Port Number

Specifies the number of the SSL port on the local Unicenter CA-XCOM Data Transport server.

Secure Socket File

XCOM_CONFIG_SSL

Specifies the value of the configssl.cnf file and file name.

Display Cipher in Queue Details

XCOM_SHOW_CIPHER

Specifies whether to display encryption algorithms in the Unicenter CA-XCOM Data Transport queue detailed information, which is used for transfers.

Using Unicenter CA-XCOM Data Transport 2–87

Using the Properties Dialog Pages

Trace Properties Tab Page

Use the Trace Properties tab page to modify global default options for Unicenter CA-XCOM Data Transport tracing facilities.

Note: You must enable tracing to cause a trace file to be created. To enable tracing, go to the directory where Unicenter CA-XCOM Data Transport is installed and enter the following command at the prompt: card3 on

If this is not done, a trace file will not be created.

2–88 User Guide

Using the Properties Dialog Pages

To disable tracing, go to the directory where Unicenter CA-XCOM Data Transport is installed and enter the following command at the prompt: card3 off

For information about how to trace the XCOMD Scheduler Service, see Tracing the Unicenter CA-XCOM Data Transport Scheduler Services in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Administrator Guide.

Options

The following table describes the available options on the Trace Properties tab page, and their associated parameters.

Option Description

Xtrace Trace level XTRACE

Used to set the default tracing level to trace the activity of an Unicenter CA-XCOM Data Transport transfer from the point when a transfer is queued or submitted.

Debug Flag DEBUG_FLAG

Indicates whether to print trace data to STDERR.

System Level group

Use these options to set tracing for system level components. These options are used for initial tracing, to trace activity up to the point where Unicenter CA-XCOM Data Transport has resolved all parameters but before a connection is established with a remote system.

Component Click the arrow to display a list of Unicenter CA-XCOM Data Transport system level components that can be traced. Select a component that you wish to trace.

Component Trace File

Click the Browse button to select a different default path and file name for the trace data for the component selected in the Component option box. Note that the directory dialog filters for .TRC files.

Trace Off

Trace On

Trace Detail

Click to turn tracing off.

Click to turn tracing on.

Click to view trace details.

Using Unicenter CA-XCOM Data Transport 2–89

Using the Properties Dialog Pages

Option Description

Trace Path TRACE_PATH

Click the Browse button to select a different default path for trace data.

Trace data files have the following naming conventions:

tidnumber.TRA—A trace file for a particular transfer. tidnumber= The transfer ID.

TRACE.TRC—A trace file for a selected Unicenter CA-XCOM Data Transport component.

Note: Setting trace options may generate large files of trace data and significantly impact performance.

2–90 User Guide

Chapter

3 The Command Line Interface

The command line interface allows you to enter commands at the Windows command prompt to control Unicenter CA-XCOM Data Transport. All Unicenter CA-XCOM Data Transport commands follow the conventional rules and grammar of the Windows command language.

Command Prompt To understand the use of parameters before using the commands in this chapter, see File Name, Path, and Directory Considerations in the chapter “Using Unicenter CA-XCOM Data Transport.” In addition, you should be aware of the following:

■ The XCOMD Unicenter CA-XCOM Scheduler service must be running before you can do any transfers.

■ To edit configuration files, you need the appropriate user rights to read and write to those files.

■ To send a transfer using the command prompt, you need the appropriate user rights to execute XCOM62 or XCOMTCP.

• To specify a path name that contains a blank or special character, put double quotes (“ ”) around it.

Using Configuration Files Use configuration files to set default parameters for Unicenter CA-XCOM Data Transport transfers. Use XCOM.CNF to change default settings or to set transfer-specific variables for an individual locally-initiated transfer. Use a text editor to modify the values in XCOM.CNF. All modifications go into effect the next time a transfer is initiated.

The Command Line Interface 3–1

Using Configuration Files

Configuration Files

Unicenter CA-XCOM Data Transport reads the parameter file XCOM.CNF or a user specified configuration file, and parameters specified at the command prompt, and executes the specified file transfer.

Unicenter CA-XCOM Data Transport automatically uses the defaults from the XCOM.GLB file, and the XCOM.CNF file if you do not specify any user configuration files, to supply any parameter values not specified on the command prompt. You may, however, write new configuration files of your own to use for transfers.

For each transfer, Unicenter CA-XCOM Data Transport compiles a full set of parameter values. To collect these values, the program follows a search sequence. (When you are using the GUI, Unicenter CA-XCOM Data Transport collects parameter values in a different way.)

When using the command prompt or a script, the values are collected in the following order:

■ The Unicenter CA-XCOM Data Transport program defaults.

■ Parameters defined in XCOM.GLB at the time the XCOMD Unicenter CA-XCOM Scheduler service was started.

■ Parameters defined in a user-created configuration file specified with the -f option on the command line, or the XCOM.CNF file. If a copy of the configuration file is not found in the current directory, then the file C:\XCOMNT\CONFIG\XCOM.CNF is used.

■ Parameters defined in the command prompt following the -f option.

Note: If you specify another configuration file at the command prompt, using the -f option, then parameters from this file will be used instead of XCOM.CNF.

Creating Configuration Files from the Command Prompt

To create configuration files of your own for different types of transfers, follow these steps:

1. From the Windows command prompt, enter the following: CD C:\XCOMNT\CONFIG

This brings you to the default directory where Unicenter CA-XCOM Data Transport configuration files are stored and makes it the current directory.

3–2 User Guide

Using Configuration Files

Note: Your configuration may have these files in a different directory. If you plan to use this configuration file from the command prompt, keep it in the same directory where you have Unicenter CA-XCOM Data Transport. The default directory is C:\XCOMNT. If you put the configuration file in another directory, you must specify the full path name when referring to it. For example, C:\XCOMNT\FILENAME.CNF.

To specify a path name that contains a blank or special character, put double quotes (“ ”) around it. For example: "c:\xcomnt 32\config\myconfig.cnf"

or "%XCOM_HOME%\config\myconfig.cnf "

Note: If you plan to use this configuration file with the GUI, it can be in any directory.

2. Enter the following: COPY XCOM.CNF FILENAME.CNF

XCOM.CNF is copied and renamed to FILENAME.CNF.

Note: The name FILENAME.CNF is used only as an example here.

3. Use any text editor that generates ASCII text to open and modify the parameters in the new file to your specific needs.

It is not necessary to list all available parameters in a configuration file, because any unspecified parameters will use the defaults that are set in XCOM.GLB or the XCOMD Unicenter CA-XCOM Scheduler service.

If you specify a configuration file, then XCOM.CNF is not used. If you do not specify a configuration file, then Unicenter CA-XCOM Data Transport looks in XCOM.CNF for parameter values.

4. Save the file as ASCII text and exit the editor.

Note: You may also copy and rename configuration files through the Windows Explorer or using any editor that generates ASCII text.

If you create configuration files that are not named with a .cnf extension, when you open them in the GUI you must change List Files of Type to All files (*.*) in the Open window in order to display these files in the selection list.

For information about creating and editing configuration files from the GUI, see the chapter “Using Unicenter CA-XCOM Data Transport.”

The Command Line Interface 3–3

Transferring Files

Example 1

In the following example, Unicenter CA-XCOM Data Transport is invoked from the command prompt, using XCOM62, and a configuration file is specified. XCOM62 [ -cNUMBER] [ -f [CONFIGFILENAME] [PARAMETER_NAME=VALUE ...] ]

Replace NUMBER, CONFIGFILENAME, and PARAMETER_NAME=VALUE with the desired transfer value, configuration file name, and/or parameter name and values.

For the complete syntax and options for using XCOM62 and XCOMTCP, see Transferring Files in this chapter.

Example 2

In the following example, using XCOM62, a regional office transfers its accounting records daily to the mainframe headquarters.

For this transfer, create a configuration file named ACCOUNT.CNF that contains the following parameter values: FILEOPTION=REPLACE LOCAL_FILE=C:\USER\BILLS\JULY REMOTE_FILE=BILLS.JUL

Then specify this configuration file to use for the transfer as follows: XCOM62 -c1 -f ACCOUNT.CNF

Transferring Files Use XCOM62 or XCOMTCP to initiate file transfers from the command prompt.

Use XCOM62 for transfers that use SNA/APPC protocols.

Use XCOMTCP for transfers that use TCP/IP protocols.

Specifying Protocols

When using the XCOM62 or XCOMTCP commands, the choice of protocol to use is indicated by the PROTOCOL parameter. This can be specified at the command line, in a configuration file, or in the XCOM.GLB file, depending upon your installation’s needs. If the protocol is not specified at the command line, the defaults specified in the configuration file or in XCOM.GLB are used.

3–4 User Guide

Transferring Files

XCOM62

For performing transfers using SNA/APPC protocols, XCOM62 allows you to initiate the transfer of a file, a job or a report from the command prompt, and to specify the parameters to be used for that transfer. You need the appropriate user rights and abilities to run XCOM62.

XCOMTCP

For performing transfers using TCP/IP, XCOMTCP allows you to initiate the transfer of a file, a job or a report from the command prompt, and to specify the parameters to be used for that transfer. You need the appropriate user rights and abilities to run XCOMTCP.

Multiple Transfers

You may initiate multiple transfers from the command prompt, and by defining them in configuration files and in scripts, by using the NEWXFER option of the CONTROL parameter. For information about the CONTROL parameter, see the appendix “Unicenter CA-XCOM Data Transport Parameters.”

You can use either XCOM62 or XCOMTCP to queue multiple transfers.

Note: You cannot use XCOM62 and XCOMTCP together on the same command line.

Wildcard Characters

Unicenter CA-XCOM Data Transport supports the transfer of files using wildcard characters.

Syntax

The syntax for using XCOM62 and XCOMTCP is identical, except for the choice of command. The syntax for each is shown below.

Syntax for XCOM62

The syntax for using XCOM62 is as follows: XCOM62 [-cNUMBER] [OPTION] [-f [CONFIGFILENAME][PARAMETER_NAME=VALUE ...] ]

The Command Line Interface 3–5

Transferring Files

Syntax for XCOMTCP

The syntax for using XCOMTCP is as follows: XCOMTCP [-cNUMBER] [OPTION] [-f [CONFIGFILENAME][PARAMETER_NAME=VALUE ...] ]

Notes On Using Options

When Unicenter CA-XCOM Data Transport encounters an option that performs an action and exits XCOM62 or XCOMTCP, it will perform the command and exit XCOM62 or XCOMTCP without reading the rest of the command prompt.

Options

The following table explains the options available for XCOM62 and XCOMTCP:

Option Explanation -cNUMBER The type of transfer to be attempted. Valid values for

NUMBER are: Value Description 1 Send file to remote system (default). 2 Send report to be printed on remote system. 3 Send job to be executed on remote system. 4 Receive file from remote system. -h Unicenter CA-XCOM Data Transport displays help.

The usage message is displayed and XCOM62 or XCOMTCP exits.

Note: All other options are ignored. -r Unicenter CA-XCOM Data Transport displays the

release level. The release level of the software is displayed and XCOM62 or XCOMTCP exits.

-q Unicenter CA-XCOM Data Transport queues the transfer. This option works like the QUEUE=YES parameter in XCOM.CNF.

-s Unicenter CA-XCOM Data Transport sets silent mode, which turns off all output to STDERR.

-t Unicenter CA-XCOM Data Transport sends trace output to the command prompt window (the standard error output).

3–6 User Guide

Transferring Files

Option Explanation -i Unicenter CA-XCOM Data Transport ignores

configuration errors. -f CONFIGFILENAME Unicenter CA-XCOM Data Transport reads

CONFIGFILENAME to set the parameters necessary for the transfer. The syntax for setting parameters within the configuration file is as follows: PARAMETER1=VALUE

PARAMETER2=VALUE

Note: While you can have Unicenter CA-XCOM Data Transport read parameters from a file as well as from the command prompt, the parameters on the command prompt take precedence and must come after the file name.

If you specify -f, you must specify CONFIGFILENAME or PARAMETERNAME=VALUE, or you can specify both.

PARAMETERNAME= VALUE...

You can also set parameters on the command prompt. The syntax is as follows: PARAMETER1=VALUE PARAMETER2=VALUE

Each parameter value must be in uppercase.

Note: Parameters entered on the command prompt take precedence over those in the parameter file.

no options If you invoke Unicenter CA-XCOM Data Transport without options, the defaults that are in XCOM.CNF are used for the transfer.

The Command Line Interface 3–7

Transferring Files Using SNA/APPC Protocols

Transferring Files Using SNA/APPC Protocols Use the information below as examples when performing transfers that use SNA/APPC protocols.

Note: The syntax and options for using XCOM62 are identical to those for XCOMTCP. For a description, see Transferring Files earlier in this chapter.

Using SNA/APPC Protocols

Your computer and the remote Unicenter CA-XCOM Data Transport system must be configured for the appropriate SNA/APPC for you to use SNA/APPC protocols with Unicenter CA-XCOM Data Transport.

The choice of protocol to use is indicated by the PROTOCOL parameter. This can be specified at the command line, in a configuration file, or in the XCOM.GLB file, depending upon your installation’s needs. If the protocol is not specified at the command line, the defaults specified in the configuration file or in XCOM.GLB are used.

For further information about your platform’s SNA/APPC configuration, see your Unicenter CA-XCOM Data Transport Getting Started and the SNA/APPC vendor documentation.

Note: For Windows, the remote system names in the following examples are the symbolic destination names from the CPI-C side information record.

Example 1

In the following example, the XCOM62 command is used to queue a file for a send file transfer, using SNA/APPC protocols. The configuration file is MYCONFIG.CNF, the local file is named TESTA.AAA, and the remote file is named TESTB.BBB. The remote system is indicated by the value XCOMDEVT2 in the REMOTE_SYSTEM parameter. QUEUE is set to YES, so the transfer is queued. The protocol is determined by the value of the PROTOCOL parameter in the XCOM.GLB file, which should be set to SNA for an SNA/APPC transfer. XCOM62 -c1 -f MYCONFIG.CNF LOCAL_FILE=TESTA.AAA REMOTE_FILE=TESTB.BBB REMOTE_SYSTEM=XCOMDEVT2 QUEUE=YES

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information.

3–8 User Guide

Transferring Files Using TCP/IP Protocols

Example 2

In the following example, the XCOM62 command is used to send a file directly, without sending it to the queue, using SNA/APPC protocols. The configuration file is MYCONFIG.CNF, the local file is named TESTA.AAA, and the remote file is named TESTB.BBB. The remote system is indicated by the value XCOMDEVT2 in the REMOTE_SYSTEM parameter. QUEUE is set to NO, so the transfer starts immediately after you press Enter. The choice of protocols is indicated by the value SNA in the PROTOCOL parameter. (If the default value in the configuration file or the XCOM.GLB file is SNA, you do not need to specify this value here.) XCOM62 -c1 -f MYCONFIG.CNF LOCAL_FILE=TESTA.AAA REMOTE_FILE=TESTB.BBB REMOTE_SYSTEM=XCOMDEVT2 QUEUE=NO PROTOCOL=SNA

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information.

Transferring Files Using TCP/IP Protocols Use IP addresses, host names, or domain names when performing transfers that use TCP/IP protocols.

Note: The syntax and options for using XCOMTCP are identical to those for XCOM62. For a description, see Transferring Files earlier in this chapter.

Using IP Addresses and Names

Your computer and the remote Unicenter CA-XCOM Data Transport system must be configured for TCP/IP for you to use TCP/IP protocols with Unicenter CA-XCOM Data Transport.

Before performing a file transfer, you must know the IP address, the host name, or the domain name of the remote system. Check with the network administrator of the remote system for these values.

If your computer is not configured for TCP/IP, check with your network administrator, and refer to the Microsoft Windows documentation for further information.

The Command Line Interface 3–9

Transferring Files Using TCP/IP Protocols

The formats of the IP address, host name, and domain name are described in the following table:

Value Description

IP address A unique number for a particular computer, used to identify the computer on the TCP/IP network. IP addresses are in the dotted decimal notation format.

Example:

123.123.78.91

Host Name The host name of a particular computer.

Example:

GOODSYS

Domain Name The Domain Name Service (DNS) name. Identifies the computer’s group in the DNS hierarchy. The host name and the domain name make up the fully qualified domain name of the computer.

Example:

GOODSYS.GOODSITE.COM

GOODSYS is the name of the computer, and it is in the GOODSITE.COM domain.

Specifying the Remote System

When using TCP/IP, the remote system can be specified in different ways. For example, you can use the following forms:

By host name: REMOTE_SYSTEM=GOODSYS

By fully qualified domain name: REMOTE_SYSTEM=GOODSYS.GOODSITE.COM

By IP address: REMOTE_SYSTEM=123.123.78.91

Using the IP address is the most efficient method to use when specifying a remote system location.

3–10 User Guide

Transferring Files Using TCP/IP Protocols

Note: The examples above use the REMOTE_SYSTEM parameter, but the usage applies to REMOTE_SYSTEM_RF, REMOTE_SYSTEM_SJ, and REMOTE_SYSTEM_SR also.

TCP/IP Name Resolution

If you use a host name or domain name, your system must have a way to resolve that name to an IP address.

You can use any symbolic name that can be mapped to an IP address, such as a host name or a domain name. Your system must be set up to resolve the name to an IP address. Check with your network administrator for further information about your system’s use of names.

If you are relying on name resolution to resolve names to IP addresses, this capability must be installed and configured on your system. There are many ways to implement name resolution, including the Domain Name Service (DNS), and the use of host files.

For more information about name resolution, see the Microsoft System Guide for your operating system.

Using TCP/IP Protocols with Unicenter CA-XCOM Data Transport

If you want to use TCP/IP protocols for a Unicenter CA-XCOM Data Transport transfer, Unicenter CA-XCOM Data Transport must have the port specification for the remote system and an indication that you wish to use TCP/IP protocols.

The port is specified by the PORT parameter. The default value in the XCOM.GLB file should be valid for most remote hosts.

If you need to change the port value of the local system, see the chapter “Using Unicenter CA-XCOM Data Transport.”

The choice of protocol to use is indicated by the PROTOCOL parameter. This can be specified at the command line, in a configuration file, or in the XCOM.GLB file, depending upon your installation’s needs. If the protocol is not specified at the command line, the defaults specified in the configuration file or in XCOM.GLB are used.

The Command Line Interface 3–11

Transferring Files Using TCP/IP Protocols

In addition, Unicenter CA-XCOM Data Transport uses other parameters for TCP/IP functionality. These parameters will be of interest to system administrators for tuning and performance considerations. For more information, see the chapter “Configuring Unicenter CA-XCOM Data Transport” in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Administrator Guide. These parameters are also listed in the appendix “Unicenter CA-XCOM Data Transport Parameters.”

Example 1

In the following example, the XCOMTCP command is used to queue a file for a send file transfer, using TCP/IP. The configuration file is MYCONFIG.CNF, the local file is named TESTA.AAA, and the remote file is named TESTB.BBB. The remote system is indicated by the host name GOODSYS in the REMOTE_SYSTEM parameter. QUEUE is set to YES, so the transfer is queued. TCP/IP is indicated by the value TCPIP in the PROTOCOL parameter. The port is determined by the value of the PORT parameter in the XCOM.GLB file. XCOMTCP -c1 -f MYCONFIG.CNF LOCAL_FILE=TESTA.AAA REMOTE_FILE=TESTB.BBB REMOTE_SYSTEM=GOODSYS QUEUE=YES PROTOCOL=TCPIP

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information.

Example 2

In the following example, the XCOMTCP command is used to submit a transfer directly, without sending it to the queue, using TCP/IP. The configuration file is MYCONFIG.CNF, the local file is named TESTA.AAA, and the remote file is named TESTB.BBB. The remote system is indicated by the fully qualified domain name GOODSYS.GOODSITE.COM in the REMOTE_SYSTEM parameter. QUEUE is set to NO, so the transfer starts immediately after you press Enter. TCP/IP is indicated by the value TCPIP in the PROTOCOL parameter. (If the default value in the configuration file or the XCOM.GLB file is TCPIP, you do not need to specify this value here.) The port is indicated by the value 8044 in the PORT parameter. (Note that the default value of PORT should be valid for most hosts, and you should only specify a value for this parameter when needed.) XCOMTCP -c1 -f MYCONFIG.CNF LOCAL_FILE=TESTA.AAA REMOTE_FILE=TESTB.BBB REMOTE_SYSTEM=GOODSYS.GOODSITE.COM QUEUE=NO PROTOCOL=TCPIP PORT=8044

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information.

3–12 User Guide

Setting Communications Parameters

PROTOCOL

The type of communication protocols to use.

Range The range of values is listed in the following table.

Value Description

SNA For transfers using SNA/APPC communication protocols

TCPIP For transfers using TCP/IP communication protocols

Default SNA

Note: If only the TCP/IP Component is installed with the base components of Unicenter CA-XCOM Data Transport, the default value is TCPIP.

Setting Communications Parameters Use the following parameters in the XCOM.CNF file or in any Unicenter CA-XCOM Data Transport configuration files to configure Unicenter CA-XCOM Data Transport communication parameters and data transfer characteristics. These parameters do not change for the different types of file transfers. We recommend modifying these values in XCOM.CNF during the initial configuration of Unicenter CA-XCOM Data Transport.

Communications and Data Transfer Parameters

Most of these parameters are general communications parameters used to configure the communications addressing for the systems involved in transfers. However, the COMPRESS, MAXRECLEN, TRUNCATION and VERSION parameters are used to specify the data transfer attributes for specific transfers.

The Command Line Interface 3–13

Setting Communications Parameters

Parameters

The communications and data transfer configuration parameters are listed below.

CODETABL

Specifies the 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. These custom character conversion tables determine which external translation tables will be used by the transfer.

This parameter is valid only if INTERNAL_CONVERSION_TABLES=NO.

Range 1 to 3 characters

Default None

COMPRESS

Indicates the compression type. When communicating with an IBM mainframe, if the data file contains any empty records or lines, COMPRESS must be set to YES.

Note: All compression types are not supported on all platforms. For supported compression types, see the partner platform documentation.

Range The range of values is listed in the following table.

Value Description

COMPACT RJE compaction algorithm optimized for uppercase English text.

LCOMPACT RJE compaction algorithm optimized for lowercase English text.

LZLARGE Activates LZ compression to search back 32K in the data stream for a matching string.

LZMEDIUM Activates LZ compression to search back 16K in the DataStream for a matching string.

LZRW3 General-purpose algorithm that runs fast and gives reasonable compression.

LZSMALL Activates LZ compression to search back 4K in the DataStream for a matching string.

3–14 User Guide

Setting Communications Parameters

Value Description

NO Indicates no compression.

RLE Run length encoding.

YES Indicates run length encoding of binary zeros and blanks only.

ZLIB Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and LZLARGE. Equivalent to ZLIB6.

ZLIB(n) Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and LZLARGE. The optional n value can be 1 through 9.

Note: The LZ values enable LZ (Lempel-Ziv) compression to replace sequences of data bytes that occur more than once in a DataStream with a code value.

Default YES

MAXRECLEN

For Windows and UNIX systems, the locally initiating Unicenter CA-XCOM Data Transport system determines the values for MAXRECLEN, TRUNCATION, and LRECL, for send and receive operations. When the local Unicenter CA-XCOM Data Transport system initiates a transfer of a text file, this parameter designates the length, in bytes, of the largest record that can be transferred. If a record length is longer than this value, Unicenter CA-XCOM Data Transport uses the value in the TRUNCATION parameter on the initiating side to determine whether to terminate the transfer or to truncate the record and continue the transfer. When Unicenter CA-XCOM Data Transport transfers binary files, this value indicates the length of the records that are transferred. On a receive operation, MAXRECLEN is set to whatever the LRECL value is on the initiating side.

Range 1 to 32767

Default 1024

REMOTE_SYSTEM

The name of the remote system that receives a file, job or report.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

The Command Line Interface 3–15

Setting Communications Parameters

Range 1 to 256 characters

Default None

REMOTE_SYSTEM_RF

The name of the remote system that sends a file on a receive file operation.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

REMOTE_SYSTEM_SJ

The name of the remote system to which a job is sent.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

REMOTE_SYSTEM_SR

The name of the remote system to which a report is sent.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

3–16 User Guide

Using the Send File Command

TEMPDIR

Indicates the directory in which temporary files for jobs and reports can be created.

Range 1 to 256 characters

Default C:\XCOMNT\TMP

TRUNCATION

Indicates whether Unicenter CA-XCOM Data Transport truncates excess characters in the source file if the record exceeds the maximum record length as indicated by the MAXRECLEN parameter. If NO is selected, and the maximum record length is exceeded, Unicenter CA-XCOM Data Transport aborts the transfer. This parameter is ignored if CARRIAGE_FLAG=NO.

Note: Truncation is not applicable for BINARY data.

Range YES or NO

Default NO

VERSION

Indicates the version of the Unicenter CA-XCOM Data Transport protocol to be used for this transfer. For using TCP/IP, only a value of 2 is valid.

Range 1 or 2

Default 2

Note: Version 2 parameter.

Using the Send File Command Use the Send File command at the command prompt to send a copy of a file on the local system to a file on a remote system.

The -c1 option specifies that this is a Send File transfer. The local file is indicated by the LOCAL_FILE parameter. The file on the remote system is indicated by the REMOTE_FILE parameter.

The Command Line Interface 3–17

Using the Send File Command

Example 1

In the following example, the XCOM62 command is used. The configuration file is MYCONFIG.CNF, the local file is named TESTA.AAA, the remote file is named TESTB.BBB, and the transferred file replaces a file on the remote system that already exists. XCOM62 -c1 -f MYCONFIG.CNF LOCAL_FILE=TESTA.AAA REMOTE_FILE=TESTB.BBB FILE_OPTION=REPLACE

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information.

Example 2

In the following example, the XCOMTCP command is used. The configuration file is MYCONFIG.CNF, the local file is named TESTA.AAA, the remote file is named TESTB.BBB, and the transferred file replaces a file on the remote system that already exists. The PROTOCOL parameter specifies the protocol as TCP/IP. XCOMTCP -c1 -f MYCONFIG.CNF LOCAL_FILE=TESTA.AAA REMOTE_FILE=TESTB.BBB FILE_OPTION=REPLACE PROTOCOL=TCPIP

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information.

Parameters

The Send File parameters are listed below.

FILE_OPTION

Indicates how the transferred data is to be processed by the receiving system. For file transfers only.

Range The range of values for simple file transfers is listed in the following table.

Value Description

CREATE Create a new file on the receiving system.

APPEND Append the transferred data to an existing file on the receiving system.

REPLACE Replace an existing file on the receiving system.

3–18 User Guide

Using the Send File Command

For library-type transfers, the range of values is as follows:

Value Description

CREATE Creates the PDS on the receiving system and adds the transferred members. If the PDS already exists, the transfer will fail. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES, the transfer will create the directory and add the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer will fail

ADD

APPEND

Adds or replaces transferred members on the receiving system. If the PDS does not exist, the transfer will fail. The value of CREATE_DIRECTORIES will also determine the outcome of the transfer on the remote system.

■ If CREATE_DIRECTORIES=YES and the directory does not exist then the directory will be created and the transfer members will be added to this directory. If the directory does exist, the transfer members will be added to this existing directory.

■ If CREATE_DIRECTORIES=NO and the directory does not exist, then the transfer will fail. If the directory does exist, then the transfer will add the transfer members to the directory.

REPLACE Adds or replaces transferred members. If the directory does not exist, the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES, the transfer will create the directory and add the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer will fail

Default CREATE

Note: When creating a file on an IBM mainframe system, some additional information may be necessary. For more information, see the RECORD_FORMAT, BLKSIZE, VOLUME, and UNIT parameters.

The Command Line Interface 3–19

Using the Retrieve File Command

LOCAL_FILE

The name of the file on the local system that is being transferred. At the command prompt or in a script, if this variable is null or unset, standard input is read. In this manner, Unicenter CA-XCOM Data Transport commands can be used in a pipeline or with redirection. All Windows and UNC file naming conventions apply. If more than one file is included in the transfer, LOCAL-FILE must include wildcard characters (*).

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

REMOTE_FILE

Indicates the file on the remote computer to which the transferred data is being written. If you are creating the file (FILE_OPTION=CREATE), the file name must be consistent with the file naming conventions of the remote system. If the receiving system is a Windows system and more than one file is included in the transfer, REMOTE_FILE must include wildcard characters (*). The local Unicenter CA-XCOM Data Transport system does not validate this name. The remote I/O system determines whether the file name is valid.

Note: For send file transfers only.

Range 1 to 256 characters

Default None

Using the Retrieve File Command Use the Retrieve File command at the command prompt to retrieve a copy of a file from a remote system and write it to a specified file on the local system.

The -c4 option specifies that this is a Retrieve File transfer. The remote file to be copied is indicated by the REMOTE_FILE_RF parameter. The file on the local system is indicated by the LOCAL_FILE_RF parameter.

3–20 User Guide

Using the Retrieve File Command

Example 1

In the following example, the XCOM62 command is used. The remote file CUSTOMER is retrieved into the local file ACCOUNTS. All other necessary parameters are read from the default configuration file, XCOM.CNF. XCOM62 -c4 -f REMOTE_FILE_RF=CUSTOMER LOCAL_FILE_RF=ACCOUNTS

Example 2

In the following example, the XCOMTCP command is used. The remote file CUSTOMER is retrieved into the local file ACCOUNTS. All other necessary parameters are read from the default configuration file, XCOM.CNF. XCOMTCP -c4 -f REMOTE_FILE_RF=CUSTOMER LOCAL_FILE_RF=ACCOUNTS

Parameters

The Retrieve File parameters are listed below.

FILE_OPTION_RF

Indicates how the transferred data is to be processed by the receiving system (that is, the local system). Used when the transfer type is Retrieve File. If a value is not specified, then the value defaults to CREATE.

Range The range of values is listed in the following table.

Value Description

CREATE Create a new file on the receiving system.

APPEND Append the transferred data to an existing file on the receiving system.

REPLACE Replace an existing file on the receiving system.

The Command Line Interface 3–21

Using the Retrieve File Command

For library-type transfers, the range of values is as follows:

Value Description

CREATE Creates the PDS on the receiving system and adds the transferred members. If the PDS already exists, the transfer will fail. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES, the transfer will create the directory and add the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer will fail

ADD

APPEND

Adds or replaces transferred members on the receiving system. If the PDS does not exist, the transfer will fail. The value of CREATE_DIRECTORIES will also determine the outcome of the transfer on the remote system.

■ If CREATE_DIRECTORIES=YES and the directory does not exist then the directory will be created and the transfer members will be added to this directory. If the directory does exist, the transfer members will be added to this existing directory.

■ If CREATE_DIRECTORIES=NO and the directory does not exist, then the transfer will fail. If the directory does exist, then the transfer will add the transfer members to the directory.

REPLACE Adds or replaces transferred members. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES, the transfer will create the directory and add the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer will fail

Default CREATE

3–22 User Guide

Using the Retrieve File Command

LOCAL_FILE_RF

The file name that is created, appended, or replaced on the local system when it receives a file. At the command prompt or in a script, if this value is null or unset, then Unicenter CA-XCOM Data Transport writes to the standard out file. All Windows and UNC file naming conventions apply. If more than one file is included in the transfer, LOCAL-FILE must include wildcard characters (*).

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

REMOTE_FILE_RF

Indicates the name of the file to be retrieved from the remote system. If the receiving system is a Windows system and more than one file is included in the transfer, REMOTE_FILE_RF must include wildcard characters (*).

Note: For retrieve file transfers only

Range 1to 256 characters

Default None

REMOTE_SYSTEM_RF

The name of the remote system that sends a file on a receive file operation.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

The Command Line Interface 3–23

Creating a File on an IBM Mainframe

UNIT_RF

Specifies the unit from which a data set is to be retrieved from an IBM mainframe.

Range 0 to 6 characters

Default None

VOLUME_RF

Specifies the volume from which a data set is to be retrieved from an IBM mainframe.

Range 0 to 6 characters

Default None

Creating a File on an IBM Mainframe Use the following parameters at the command prompt and in configuration files when creating a file on an IBM mainframe from a local system.

These parameters are used when FILE_OPTION=CREATE. The IBM mainframe file system, unlike UNIX or Windows systems, may require that you specify a variety of attributes in order to create a file on the mainframe. Check with your IBM mainframe applications group to determine the appropriate values for these parameters.

3–24 User Guide

Creating a File on an IBM Mainframe

Parameters

The mainframe file creation parameters are listed below.

ALLOCATION_TYPE

Indicates the unit of storage allocation for a data set created on an IBM mainframe.

Range The range of values is listed in the following table.

Value Description

CYL Cylinders

TRK Tracks

BLK Blocks

Default None

Note: Version 2 parameter.

BLKSIZE

Specifies the block size of a data set created on an IBM mainframe.

Note: Used when FILE_OPTION=CREATE

Range 0 to 32767

If the format is Then the block size must be

Fixed or fixed block record A multiple of the record length

Variable record 4 bytes larger than the record length

Undefined record Larger than the largest record length

Default 800

The Command Line Interface 3–25

Creating a File on an IBM Mainframe

DATACLAS

Specifies the name of the data class to use when allocating a new SMS-managed data set.

Note: This parameter applies only to mainframe SMS data sets.

Range 1 to 8 characters

Default None

DSNTYPE

Specifies the data set definition.

Note: This parameter applies only to mainframe SMS data sets.

Value Description

LIBRARY Defines a PDSE

PDS Defines a partitioned data set

Note: These values are IBM standards for SMS processing.

Range 1 to 8 characters

Default None

LRECL

Specifies the actual or maximum length, in bytes, of a logical record. Corresponds to the JCL LRECL subparameter.

Range 0 to 32767

If the format is Then the maximum length of a logical record must be equal to the

Variable blocked record Maximum record length plus 4

Fixed or fixed block record Constant record length

Default 160

3–26 User Guide

Creating a File on an IBM Mainframe

MGMTCLAS

Specifies the 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.

Range 1 to 8 characters

Default None

NUM_OF_DIR_BLOCKS

Specifies the number of directory blocks to allocate for a data set created on an IBM mainframe.

Range 0 to 32767

Default 0

Note: Version 2 parameter.

PRIMARY_ALLOC

Identifies primary storage allocation for a data set created on an IBM mainframe.

Range 0 to 99999

Default 1

Note: Version 2 parameter.

The Command Line Interface 3–27

Creating a File on an IBM Mainframe

RECORD_FORMAT

Specifies the record format of a data set created on an IBM mainframe. This corresponds to the JCL RECFM subparameter. This field is unique to the Edit Transfer - Send File Window.

Range The range of values is listed in the following table.

Value Description Record Length Comment

F Fixed unblocked The same length as the data set

FA Fixed unblocked ANSI

The same length as the data set

Contains ISO/ANSI/FIPS control characters.

FB Fixed blocked Fixed Fixed record length with multiple records per block.

FBA Fixed blocked ANSI

Fixed Multiple records per block where these records contain ISO/ANSI/FIPS control characters.

FBS Fixed blocked spanned

Fixed Multiple records per block written as standard blocks.

FM Fixed unblocked machine

The same length as the data set

Contains machine code control characters.

FS Fixed unblocked spanned

The same length as the data set

Written as standard blocks where these records do not contain any truncated blocks or unfilled tracks.

U Undefined Undefined

V Variable unblocked

Variable

VA Variable unblocked ANSI

Variable Contains ISO/ANSI/FIPS control characters.

VB Variable blocked Variable Multiple records per block

VBA Variable blocked ANSI

Variable Multiple records per block where these records contain ISO/ANSI/FIPS control characters.

3–28 User Guide

Creating a File on an IBM Mainframe

Value Description Record Length Comment

VBM Variable blocked machine

Variable Multiple records per block where these records contain machine code control characters.

VBS Variable blocked spanned

Variable May have multiple records per block where these records can span more than one block.

VM Variable unblocked machine

Variable Contains machine code control characters.

VS Variable unblocked spanned

Variable A record can span more than one block.

Default VB

SECONDARY_ALLOC

Identifies secondary storage allocation for a data set created on an IBM mainframe.

Range 0 to 99999

Default 1

Note: Version 2 parameter.

The Command Line Interface 3–29

Creating a File on an IBM Mainframe

SECURE_SOCKET

Specifies whether to use an OpenSSL socket or non-OpenSSL socket for transfers.

Range The range of values is listed in the following table.

Value Description

YES Performs secure transfer.

The transfer uses an OpenSSL socket and must to connect to a SSL listener on the remote partner.

NO Performs non-secure transfer.

The transfer uses a non-OpenSSL socket.

Default: NO

STORCLAS

Specifies the name of the storage class for a new SMS-managed data set.

Note: This parameter applies only to mainframe SMS data sets.

Range 1 to 8 characters

Default None

UNIT

Intended for specifying to a remote system (primarily an IBM mainframe) the unit that a data set is to be created on.

Range 0 to 6 characters

Default None

VOLUME

Specifies the volume on which a data set is to be created on an IBM mainframe.

Range 1 to 6 characters

Default None

3–30 User Guide

Creating a File on an IBM Mainframe

XCOM_CONFIG_SSL

Specifies the configssl.cnf file path and file name.

Range: 1 to 256 characters

Default: c:\xcomnt\configssl.cnf

XCOM_SHOW_CIPHER

Specifies whether to display encryption algorithms in the Unicenter CA-XCOM Data Transport queue detailed information, which is used for transfers.

Range The range of values is listed in the following table.

Value Description

NO Do not display encryption algorithms in the queue detail information.

YES Display encryption algorithms in the queue detail information.

Default: NO

Tape Parameters for an IBM Mainframe

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 previous section, Creating a File on an IBM Mainframe—such as UNIT and VOLUME.

DEN

Specifies the density to be used in creating a tape on the remote system. Valid values are the same as those for the DEN parameter in JCL

Range 1 to 4

Default None

The Command Line Interface 3–31

Creating a File on an IBM Mainframe

EXPDT

Specifies the expiration date to be placed on the tape data set being created.

Range The following table lists the valid values for this parameter:

Value Definition

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 06021, 06 is the year (namely, 2006) and 021 is the 21st day of that year. The tape data set will expire on January 21, 2006.

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 2006/021, 2006 is the year, and 021 is the 21st day of that year. The tape data set will expire on January 21, 2006.

Note: EXPDT and RETPD are mutually exclusive; specify one or the other.

Default None

LABEL

Indicates the type of label associated with a tape data set.

Range The following table lists the valid values for this parameter:

Value Definition

Processing type:

AL, AUL, BLP, LTM, NL, NSL, SL, SUL

Represent the types of processing to be applied to data sets on tape.

Note: Unicenter CA-XCOM Data Transport for z/OS supports only standard label tapes.

Example LABEL=BLP

The type of processing to be applied to this data set is BLP.

Default SL

3–32 User Guide

Creating a File on an IBM Mainframe

LABELNUM

Indicates the sequence number of the data set on the tape.

Range The following table lists the valid values for this parameter:

Value Definition

sequence number (0001-9999)

This value identifies the sequence number of a data set on tape.

Example LABELNUM=2

This specification refers to the 2nd data set on the tape.

Default 1

RETPD

Specifies the number of days that the tape data set being created is to be retained.

Range 1 to 9999

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.

Range The following table lists the valid values for this parameter:

Value Definition

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.

Default NO

The Command Line Interface 3–33

Creating a File on an IBM Mainframe

UNITCT

Specifies the number of units to be allocated on the remote system.

Range 1 to 20

Default None

VOLCT

Specifies the maximum number of volumes to be used in processing a multivolume output tape data set on the remote system.

Range 1 to 225

Default None

VOLSQ

Specifies the sequence number of the first volume of a multivolume remote data set to be used.

Range 1 to 225

Default None

3–34 User Guide

Using a Send Report Command

Using a Send Report Command Use this command at the command prompt to send a copy of a report file from a local system to a remote system for printing.

The -c2 option specifies that this is a Send Report transfer. The report file on the local system is specified by the LOCAL_FILE_SR parameter.

If you are using a network printer, the DESTINATION must be fully qualified, including the server name and printer; for example: \\servername\printername.

Example 1

In the following example, the XCOM62 command is used. The configuration file is MYCONFIG.CNF, the local report file sent is named MYFILE.RPT, and it is placed on HOLD status on the remote system until released by the remote system. XCOM62 -c2 -f MYCONFIG.CNF LOCAL_FILE_SR=MYFILE.RPT HOLDFLAG=YES

Example 2

In the following example, the XCOMTCP command is used. The configuration file is MYCONFIG.CNF, the local report file sent is named MYFILE.RPT, and it is placed on HOLD status on the remote system until released by the remote system. XCOMTCP -c2 -f MYCONFIG.CNF LOCAL_FILE_SR=MYFILE.RPT HOLDFLAG=YES

The Command Line Interface 3–35

Using a Send Report Command

Parameters

The Send Report parameters are listed below.

CARRIAGE_CONTROL_CHARACTERS

Indicates the type of printer carriage-control codes, if any, that are included in the report file.

Note: For report transfers only.

Range The range of values is listed in the following table.

Value Description

ASA ASA control codes in column 1.

IBM IBM Machine Characters (valid only for IBM mainframes).

BYPASSASA If data is already in ASA format, bypass conversion.

OTHER No carriage-control codes are used.

Default OTHER

CLASS

The print class assigned to a report transferred to a remote system.

If the remote system is an IBM mainframe, this field designates the JES SYSOUT class.

Note: For report transfers only.

Example Enter B to print the report through SYSOUT=B.

Range 1 character

Default None

3–36 User Guide

Using a Send Report Command

COPIES

The number of copies to be sent. If this parameter is not specified, the remote system queues one copy of the report to the system’s default printer. For report transfers only.

Range 1 to 999

Default 1

DESTINATION

Identifies the printer or other device on the remote system where the report is to be sent. If this parameter is not specified, the remote system sends the report to the system's default printer. For report transfers only.

Range The range of values is listed in the following table.

Value Description

0 to 16 characters For indirect transfers and for Version 1.

0 to 21 characters For transfers that are not indirect and for Version 2.

Default None

DISPOSITION

Indicates what the remote system does with the report file after the report has been printed. For report transfers only.

Note: This field is not used when the remote system is an IBM mainframe.

Range The range of values is listed in the following table.

If the value is Then after printing the report is

DELETE Deleted

KEEP Kept

HOLD Held

Default DELETE

The Command Line Interface 3–37

Using a Send Report Command

FCB

Identifies the FCB JCL parameter when sending the report file to an IBM mainframe, defining print density, lines per page, and so on. For report transfers only.

Range 0 to 4 characters

Default None

FORM

The type of form that should be used to print the report. Since Unicenter CA-XCOM Data Transport places the print job in the remote system's print queue, the print control functions depend on the remote system. The user must verify beforehand that the requested form is available at the remote site. For report transfers only.

Range 0 to 10 characters

Default None

HOLDFLAG

Indicates whether a transferred report file is to be placed on HOLD on the remote system or is to be printed immediately. For report transfers only.

Range YES or NO

Default NO

LOCAL_FILE_SR

Local file name to be sent as a report to the remote system. At the command prompt or in a script, if this value is null or unset, then Unicenter CA-XCOM Data Transport reads the standard input file. All Windows and UNC file naming conventions apply. For report transfers only.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

3–38 User Guide

Using a Send Report Command

REMOTE_SYSTEM_SR

The name of the remote system to which a report is sent.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

REPORT_TITLE

Used by Unicenter CA-XCOM Data Transport on remote systems in the following ways:

System Uses the REPORT_TITLE

AS/400 As the printer file name.

z/OS To interpret a non-blank value in this field as specifying the generation of a separator (banner) page for this value.

VAX/VMS To print with the report.

UNIX To allow Unicenter CA-XCOM Data Transport to pass this field to the LP spooler as a title field.

Other systems As a descriptive comment only and does not print it as part of the report.

Range 0 to 21 alphanumeric or blank characters

Default None

The Command Line Interface 3–39

Using the Send Job Command

SPOOL_FLAG

Indicates whether the report is to be spooled to disk or printed immediately. For report transfers only.

Note: If the remote system is an IBM mainframe, this parameter has no effect on the transfer.

Range YES or NO

Default YES

Using the Send Job Command Use the Send Job Command at the command prompt to send an executable file to a remote system to perform a job.

The -c3 option specifies that this is a Send Job transfer. The local job file is specified by the LOCAL_FILE_SJ parameter.

The executable file or command script that contains the job must have in it the control statements that are needed to execute the job on the remote system. These control statements must be in a form that is recognized by the remote system. For example, if you are sending to an IBM z/OS system, this file could contain JCL statements. If you are sending to a UNIX system this file could contain a UNIX shell script. For sending to a Windows system, the file would be a .bat file.

Example 1

In the following example, the XCOM62 command is used. The job sent for execution on the remote system is in the file MYFILE. XCOM62 -c3 -f LOCAL_FILE_SJ=MYFILE

All other necessary parameters are read from the default configuration file XCOM.CNF.

Example 2

In the following example, the XCOMTCP command is used. The job sent for execution on the remote system is in the file MYFILE. XCOMTCP -c3 -f LOCAL_FILE_SJ=MYFILE

All other necessary parameters are read from the default configuration file XCOM.CNF.

3–40 User Guide

ERRORLEVEL Return Codes from xcomtcp.exe and xcom62.exe

LOCAL_FILE_SJ

Indicates the name of the file on the local system to be sent as a job. At the command prompt or in a script, if this variable is null or unset, standard input is read. All Windows and UNC file naming conventions apply.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

REMOTE_SYSTEM_SJ

The name of the remote system to which a job is sent.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

ERRORLEVEL Return Codes from xcomtcp.exe and xcom62.exe

When executing the command-line programs (xcomtcp.exe and xcom62.exe), the ERRORLEVEL indicates successful or failed processing. An ERRORLEVEL of ZERO indicates successful operation and termination. An ERRORLEVEL of NON_ZERO values indicates program processing was not successful, and that the program has terminated. Note that to know success or failure of a transfer, you must set QUEUE=NO, otherwise ERRORLEVEL only indicates the success or failure of queuing.

The Command Line Interface 3–41

Tracing Problems

Tracing Problems The tracing parameters are used to collect information at the request of Unicenter CA-XCOM Data Transport Customer Support in order to diagnose a problem. The trace output is primarily intended to provide information to Customer Support, and they will usually request a level of tracing for you to use. The -t option of the XCOM62 or XCOMTCP command will direct trace output to STDERR, the standard error output.

This trace facility collects information about a transfer from the point where a transfer is queued or submitted and a connection is established. The resulting trace data is stored in a file named TIDNUMBER.TRA, where TIDNUMBER = the transfer ID.

Note: In the GUI, the Trace Properties Tab Page of the Properties dialog provides access to Unicenter CA-XCOM Data Transport system-level trace facilities. For more information, see the chapter “Using Unicenter CA-XCOM Data Transport.”

Note that setting trace options may generate large files of trace data and significantly impact performance.

Example 1

In the following example, the XCOM62 command is used. The configuration file is MYCONFIG.CNF, the trace level is set to 9 to provide full tracing information and the trace information is written to a trace file. XCOM62 -f MYCONFIG.CNF XTRACE=9

Example 2

In the following example, the XCOMTCP command is used. XCOMTCP -f MYCONFIG.CNF XTRACE=9 PROTOCOL=TCPIP

The configuration file is MYCONFIG.CNF, the trace level is set to 9 to provide full tracing information and the trace information is written to a trace file. The protocol is specified by the PROTOCOL parameter.

3–42 User Guide

Setting Up Log Files

XTRACE

Indicates the level of desired execution tracing.

Range The range of values is listed in the following table.

Value Description

0 No tracing.

1 to 8 Levels of tracing from 1 (lowest) to 8 (highest).

9 Show the contents of the data buffers.

10 Includes levels 1 through 9, plus some additional detailed technical information.

Default 0

Setting Up Log Files Unicenter CA-XCOM Data Transport automatically collects information about transfers and stores it in a log file. Read the log file to see information about transfers. The log indicates information such as when a transfer was started, stopped, completed, deleted, suspended, or aged off of the queue. For each transfer, it shows the time, date, Transfer ID, and number of blocks and bytes transmitted.

Example 1

In the following example, the XCOM62 command is used. The configuration file is MYCONFIG.CNF and the log file is MYLOG. XCOM62 -f \MYCONFIG.CNF XLOGFILE=\PHIL\XCOMNT\MYLOG

Example 2

In the following example, the XCOMTCP command is used. The configuration file is MYCONFIG.CNF and the log file is MYLOG. XCOMTCP -f \MYCONFIG.CNF XLOGFILE=\PHIL\XCOMNT\MYLOG

The Command Line Interface 3–43

Setting File Type Conversion

XLOGFILE

The name of the file where Unicenter CA-XCOM Data Transport logs activity. If you do not specify this parameter, the system-wide log file C:\XCOMNT\XCOM.LOG is used. If you specify this parameter with a different file name, the logging information is only sent to the specified file.

Note: Specify the full path name if QUEUE=YES.

Range 0 to 256 characters

Default C:\XCOMNT\XCOM.LOG

Setting File Type Conversion Use the parameters below to specify the characteristics of the file and the data involved in the transfer. For information about using custom character conversion sets rather than the Unicenter CA-XCOM Data Transport defaults, see Creating Custom Character Sets for File Conversion in this chapter.

Unicenter CA-XCOM Data Transport uses internal character conversion sets to handle different data encoding methods when files are sent or received. These default conversion sets are stored in files as conversion tables. When executing a non-binary file transfer that requires an ASCII/EBCDIC conversion, Unicenter CA-XCOM Data Transport uses these tables by default. (INTERNAL_CONVERSION_TABLES=YES).

The default conversion tables are listed in the following table.

For this conversion Unicenter CA-XCOM Data Transport uses the character set in

ASCII to EBCDIC C:\XCOMNT\CONVTAB\ATOE.TAB

EBCDIC to ASCII C:\XCOMNT\CONVTAB\ETOA.TAB

Note: If you have installed Unicenter CA-XCOM Data Transport in a directory other than XCOMNT, these files will be in the CONVTAB subdirectory of that directory.

3–44 User Guide

Setting File Type Conversion

Example 1

In the following example, the XCOM62 command is used. An EBCDIC text file is being transferred: XCOM62 -f CARRIAGE_FLAG=YES CODE_FLAG=EBCDIC

All other necessary parameters are read from the default configuration file, XCOM.CNF.

Example 2

In the following example, the XCOMTCP command is used. An EBCDIC text file is being transferred: XCOMTCP -f CARRIAGE_FLAG=YES CODE_FLAG=EBCDIC

All other necessary parameters are read from the default configuration file, XCOM.CNF.

CARRIAGE_FLAG

Specifies the type of file being transferred and some special characteristics of the conversion done during the transfer.

Range The range of values is listed in the following table.

Value Description

YES Indicates that the transferred file is a text file and a newline character should be added to the end of incoming records. Also, newline characters are removed from the ends of lines before an outgoing record is sent.

When the TCP/IP protocol is specified, YES will be changed to XPACK automatically, if the value of MAXRECLEN is less than 31K. If the value of MAXRECLEN is greater than or equal to 31744, this value will not be changed automatically.

NO Indicates no special processing.

MPACK Indicates a text file with record packing. Uses 2K pack buffer.

When the TCP/IP protocol is specified, MPACK will be changed to XPACK automatically, if the value of MAXRECLEN is less than 31K. If the value of MAXRECLEN is greater than or equal to 31744, this value will not be changed automatically.

The Command Line Interface 3–45

Setting File Type Conversion

Value Description

VLR Indicates a binary file of variable-length records with a field of 4 bytes preceding each record. Applies to local initiated transfers only.

XPACK Indicates a text file with record packing. Uses 31K pack buffer.

Note: MPACK does not support a MAXRECLEN (actual record length) over 2K. XPACK does not support a MAXRECLEN (actual record length) over 31K.

Default YES

CODE_FLAG

Used to identify the type of data being transferred.

Range The range of values is listed in the following table.

Value Description

ASCII An ASCII file is being transferred. This indicates that the incoming file is assumed to be ASCII format, and is not translated. Therefore the file on the remote system should be in ASCII format before it is transferred.

BINARY A binary file, such as an executable file, is being transferred. This indicates to a remote system that it is not to translate the data it is exchanging with your system.

EBCDIC An EBCDIC file is being transferred. The transferred data is translated from EBCDIC to ASCII format when the local system receives the data, and from ASCII to EBCDIC format when the local system sends the data.

Default ASCII

3–46 User Guide

Creating Custom Character Sets for File Conversion

Creating Custom Character Sets for File Conversion Use conversion processing when the following situations occur:

■ When a non-USA character set is being used.

■ When the transferred file is to be converted to all uppercase or lowercase characters.

■ When Unicenter CA-XCOM Data Transport’s default character conversion sets would not be appropriate.

For information about using Unicenter CA-XCOM Data Transport’s default character conversion sets, see Setting File Type Conversion earlier in this chapter.

Custom Character Sets

The custom character sets are stored in standard ASCII files as conversion tables. Each original character and the character to which it is translated are defined by a single line in the file. The line number of the file itself indicates the decimal code value of the original character.

The character conversion table must be the only contents of the conversion file. Do not insert any comments or additional numbers. Each conversion file must contain 256 lines. If your text editor provides a line counter, you can use it to help you keep track of the line numbers. The procedures and examples below assume that the editor’s line counter begins at 1.

Procedure

To create a custom character translation table, follow these steps:

1. Use an editor that can generate ASCII text to create and open a file. It is helpful to use a text editor that displays line numbers.

2. Define each character on a separate line. Do not use comments.

Note: Unicenter CA-XCOM Data Transport performs the EBCDIC to ASCII translation in the following manner:

When an EBCDIC code 0 is received, Unicenter CA-XCOM Data Transport will substitute the ASCII value from the first line (line 1) of the table; for EBCDIC code 1, Unicenter CA-XCOM Data Transport takes the value from the second line (line 2), etc. Because the first line is for code 0, it is necessary to add 1 to the line number when determining which line of the table to modify.

The Command Line Interface 3–47

Creating Custom Character Sets for File Conversion

Example 1

A question mark (?) needs to be sent to the mainframe in EBCDIC. Set up the translation table to translate it from ASCII to EBCDIC.

■ The ASCII code for ? is 63 (decimal).

■ The EBCDIC code for ? is 111 (decimal).

■ Take the ASCII code and add 1. This is 64. Go to line 64 of the ATOE table and type the value 111.

Example 2

An A is received from the mainframe in EBCDIC. Set up the translation table to translate it to ASCII:

■ The EBCDIC code for A is 193 (decimal).

■ The ASCII code for A is 65.

■ Take the EBCDIC code for A and add 1. This is 194. Go to line 194 of the ETOA table and type the value 65.

Hexadecimal Numbers in Conversion Tables

An EBCDIC character can be represented by either its decimal code or its hexadecimal equivalent. Hexadecimal numbers should be prefixed by 0x.

Example 3

In the following example, to translate the EBCDIC character A to the equivalent ASCII code using a hexadecimal number, set line 194 of the ETOA file to contain only the information below: 0x41

3–48 User Guide

Creating Custom Character Sets for File Conversion

Customizing Default Character Sets

In some cases it may be easier to build a conversion file by customizing a copy of ATOE.TAB or ETOA.TAB and changing the character translations only where necessary.

Procedure

To translate all lowercase ASCII characters to uppercase EBCDIC characters, follow these steps:

1. From the command prompt, type COPY C:\XCOMNT\CONVTAB\ATOE.TAB conversionfilename

C:\XCOMNT\CONVTAB\ATOE.TAB is copied to a new file and named conversionfilename.

Note: conversionfilename can be any name you choose.

2. Use an editor that generates ASCII text to open the file and copy the values from lines 66 to 91 to lines 98 to 123.

Note: The decimal ASCII code for a is 98 and the decimal ASCII code for z is 123.

The values in lines 98 to 123 are changed to represent uppercase EBCDIC characters.

3. Save the file as an ASCII text file and exit the editor.

Specifying a Custom Character Set

To use a custom character set, change the parameter values for INTERNAL_CONVERSION_TABLES and ETOA_FILENAME or ATOE_FILENAME in XCOM.GLB. To activate changes in XCOM.GLB, restart XCOMD.

To specify external character conversions tables for use by transfers, use the CODETABL parameter (one to three characters with no default value). The CODETABL parameter is a prefix to the name of the files containing the external ASCII-to-EBCDIC and EBCDIC-to-ASCII character conversion tables.

Note: The CODETABL parameter is valid (resulting with the user defined conversion tables loaded) only if the XCOM.GLB parameter INTERNAL_CONVERSION_TABLES=NO. Failure to specify CONVERSION_TABLES=NO results in the source or target system not loading or using the defined conversion tables.

The Command Line Interface 3–49

Using Store and Forward

When creating external custom ASCII-to-EBCDIC and EBCDIC-to-ASCII translation tables, create the ATOE/ETOA tables using the xxxATOE.TAB and xxxETOA.TAB naming convention:

All custom translation tables must be in the C:\XCOMNT\CONVTAB directory.

The following files are supplied on your distribution media and contain tables used to map ASCII-to-EBCDIC and EBCDIC-to-ASCII translations:

■ C:\XCOMNT\CONVTAB\ATOE.TAB

■ C:\XCOMNT\CONVTAB\ETOA.TAB

Procedure

To specify a custom character set in XCOM.GLB, follow these steps:

1. Use a text editor that can generate ASCII text to open XCOM.GLB.

2. Set INTERNAL_CONVERSION_TABLES= NO.

Change the values for ETOA_FILENAME and ATOE_FILENAME to the file names containing the customized files you created.

3. Save XCOM.GLB as an ASCII text file and exit the editor.

Using Store and Forward A store and forward transfer can be used to transfer a file indirectly when a destination system is not available. You can send a file to the mainframe where it is stored temporarily. When the destination system becomes available, the file is automatically forwarded from the mainframe to the destination system.

This method is also used when you have two devices that cannot communicate directly, such as an SNA-only platform and a TCP/IP-only platform. They must use the mainframe as an intermediate device. (UNIX and Windows systems are not intermediate devices.)

3–50 User Guide

Using Store and Forward

Example 1

In the following example, the XCOM62 command is used. The file MYTEST.TST is sent to the intermediate z/OS node XCOMMVS2, which forwards the transfer to the remote PC system ENDEST and into the file named MYTEST.TST. XCOM62 -c1 -f XIDEST=XCOMMVS2 REMOTE_SYSTEM=ENDEST LOCAL_FILE=MYTEST.TST REMOTE_FILE=MYTEST.TST

There must be a destination member created and enabled for the remote system in the z/OS Dynamic Control Library in order for Unicenter CA-XCOM Data Transport to forward the transfer successfully.

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information.

Example 2

In the following example, the XCOMTCP command is used. The file MYTEST.TST is sent to the intermediate z/OS node XCOMMVS2, which forwards the transfer to the remote PC system ENDEST and into the file named MYTEST.TST. XCOMTCP -c1 -f XIDEST=XCOMMVS2 REMOTE_SYSTEM=ENDEST LOCAL_FILE=MYTEST.TST REMOTE_FILE=MYTEST.TST

There must be a destination member created and enabled for the remote system in the z/OS Dynamic Control Library in order for Unicenter CA-XCOM Data Transport to forward the transfer successfully.

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information.

Use the following parameter with the REMOTE_SYSTEM parameter for store and forward transfers through an IBM mainframe system.

The Command Line Interface 3–51

Setting Password and User ID Security

XIDEST

Specifies the name of the remote system on the intermediate destination that is designated for store-and-forward transfers. If this variable is null or unset, then a direct connection to a remote system is attempted.

Note: For store-and-forward transfers only.

Range 1 to 256 characters

Default None

Setting Password and User ID Security In general, a remote system requires a password and user ID before Unicenter CA-XCOM Data Transport can perform transfers. The access rights of the user ID on the remote system determine the actions permitted for the transfer.

Access to Unicenter CA-XCOM Data Transport and associated files is governed by the security policies that are in effect for your Windows environment.

Example 1

In the following example, the XCOM62 command is used. MYNAME is the USERID and MYPASSWORD is the PASSWORD. XCOM62 -f USERID=MYNAME PASSWORD=MYPASSWORD

All other parameters are read from the default configuration file, XCOM.CNF.

Example 2

In the following example, the XCOMTCP command is used. MYNAME is the USERID and MYPASSWORD is the PASSWORD. XCOMTCP -f USERID=MYNAME PASSWORD=MYPASSWORD

All other parameters are read from the default configuration file, XCOM.CNF.

3–52 User Guide

Setting Password and User ID Security

DOMAIN

The Windows domain name for use in authenticating the user ID and password.

Range 1 to 15 characters.

Default None

FILE_ACCESS_PASSWORD

Password for access to local files. Used for locally initiated transfers only.

Range 0 to 14 characters

Default None

FILE_ACCESS_USERNAME

Name of user accessing local files. Used for locally initiated transfers only.

Range 0 to 20 characters

Default None

PASSWORD

The password associated with the user ID on a remote system.

Range 0 to 31 characters

Default None

TRUSTED

Allows the user to request a trusted transfer.

Range YES, NO, Y, or N

Default None

The Command Line Interface 3–53

Encrypting Parameter Values in Existing Configuration Files

USERID

The user ID that the security system on a remote system checks before granting access for the file transfer.

Range 0 to 12 characters

Default None

Encrypting Parameter Values in Existing Configuration Files Use XCOMENCR.EXE to encrypt selected parameter values in an existing configuration file. When XCOMENCR encounters a line with #!ENCRYPT, it changes the next non-comment line from PARAMETER=VALUE

to PARAMETER.ENCRYPTED=ENCRYPTEDVALUE

Example Before encryption: PASSWORD=ENIGMA

After encryption: PASSWORD.ENCRYPTED=12 0F 36 79 65 AB D0 37 ...

up to 32 hexadecimal characters.

Syntax

The syntax for using XCOMENCR.EXE is as follows: XCOMENCR input_file output_file

3–54 User Guide

Encrypting Parameter Values in Existing Configuration Files

Options

The following table explains the options for XCOMENCR.EXE:

Option Explanation

-

(minus sign)

Send output to stdout.

Example: XCOMENCR input_file -

+

(plus sign)

Replace input_file.

Example: XCOMENCR input_file +

no options Displays help text.

Procedure

To encrypt a parameter value using XCOMENCR.EXE, follow these steps:

1. Using a text editor, open the configuration file you wish to modify, go to the parameter you wish to encrypt, create a blank line above it, and type in the following: #!ENCRYPT

Repeat as necessary for each parameter you wish to encrypt.

Note: Because # denotes a comment line in the .cnf file, any line beginning with #!ENCRYPT is ignored by Unicenter CA-XCOM Data Transport and is used only by XCOMENCR. EXE.

2. Save the configuration file as an ASCII text file.

3. At the command prompt, enter the following: XCOMENCR input_file output_file

Replace input_file with the name of the configuration file from Step 1.

The parameter value in the first non-comment line after each occurrence of the #!ENCRYPT statement is changed to the encrypted parameter value format.

Note: If you open an encrypted configuration file with a text editor, you cannot see the values of the encrypted parameters. In the GUI, when you open an encrypted configuration file, you can see the encrypted values, except for the user id and password security parameters.

The Command Line Interface 3–55

Scheduling Locally Initiated Transfers

Changing an Encrypted Value

To change an encrypted value that is already specified, you must delete all text after the parameter name and respecify it.

Example If the line you want to change is: PASSWORD.ENCRYPTED=12 0F 36 79 65 AB D0 37 ...

you would have to delete: .ENCRYPTED=12 0F 36 79 65 AB D0 37 ...

and then type in an equal sign and the new parameter value (in an unencrypted form), replacing NEWVALUE with your desired value, as follows: PASSWORD=NEWVALUE

Then save the file as ASCII text and encrypt it as in the encryption procedure above.

Scheduling Locally Initiated Transfers The queue contains the information that Unicenter CA-XCOM Data Transport uses to perform a transfer.

Note: The XCOMQM command provides access to information about the transfers in the queue. For information about using XCOMQM, see the chapter “Operating Environment” in the Unicenter CA-XCOM Data Transport for Windows NT Server/Professional Administrator Guide

Example 1

In the following example, the XCOM62 command is used. The transfer request goes into the queue to execute on July 28, 2005 at one minute after noon. XCOM62 -f QUEUE=YES START_DATE=07/28/05 START_TIME=12:01:00

All other necessary parameters are read from the default configuration file, XCOM.CNF.

3–56 User Guide

Scheduling Locally Initiated Transfers

Example 2

In the following example, the XCOMTCP command is used. The transfer request goes into the queue to execute on July 28, 2005 at one minute after noon. XCOMTCP -f QUEUE=YES START_DATE=07/28/05 START_TIME=12:01:00

All other necessary parameters are read from the default configuration file, XCOM.CNF.

Parameters

The following is the list of queue management parameters.

PRIORITY

Indicates the priority that Unicenter CA-XCOM Data Transport uses for scheduling a transfer. If two transfers are scheduled for the same time, the one with the high priority is processed before one with a normal or low priority.

Range The range of values is listed in the following table.

Value Description

HIGH Set high priority.

NORMAL Set medium priority.

LOW Set low priority.

Default NORMAL

QUEUE

Indicates whether to execute the transmission request immediately or to allow the request to be queued. If the user does not specify a .cnf file, and has not changed a .cnf file, the default value is “YES.”

Note: If NO is specified and the remote system is unavailable, the request aborts. If YES is specified, START_TIME and START_DATE are read.

The Command Line Interface 3–57

Scheduling Locally Initiated Transfers

Range The range of values is listed in the following table.

Value Description

YES The transfer request goes into a queue and executes depending on the traffic in the queue and START_DATE and START_TIME.

NO The transfer starts immediately.

Default YES

START_DATE

Indicates the date on which the transfer becomes eligible for execution. The format is mm/dd/yy. If this field is blank, the current date is used.

Example A value of 02/21/05 indicates February 21, 2005 as the start date.

Range mm/dd/yy

Default None

START_TIME

Indicates the time when the transfer becomes eligible for execution. The military format of hh:mm:ss is used. If this field is blank, then the current time is used.

Example A value of 14:00:00 indicates 2 p.m. as the start time.

Range hh:mm:ss

Default None

3–58 User Guide

Notifying of Transfer Completion

Notifying of Transfer Completion Using notification parameters, Unicenter CA-XCOM Data Transport automatically notifies a remote system or a particular user that a transfer is complete without the user having to monitor the queue manually. Notification parameters allow you to specify one of the following levels of notification: Complete, Warning, or Error.

Example 1

The following example uses the xcom62 command. When the transfer completes, local user user1 is notified with a mail message and remote user USER2 is notified with a TSO message if the transfer receives an error. xcom62 -f LOCAL_NOTIFY=user1 NOTIFYL=MAIL NOTIFY_NAME=USER2 NOTIFYR=TSO RMTNTFYL=E LCLNTFYL=A

All other necessary parameters are read from the default configuration file, XCOM.CNF.

Example 2

The following example uses the xcomtcp command. When the transfer completes, local user user1 is notified with a mail message and remote user USER2 is notified with a TSO message if the transfer receives an error. xcomtcp -f LOCAL_NOTIFY=user1 NOTIFYL=MAIL NOTIFY_NAME=USER2 NOTIFYR=TSO RMTNTFYL=E LCLNTFYL=A

All other necessary parameters are read from the default configuration file, XCOM.CNF.

The Command Line Interface 3–59

Notifying of Transfer Completion

Parameters

The notification parameters are listed below.

LCLNTFYL

Specifies the local user notification level.

Range The range of values is listed in the following table:

Value Description

A or ALL NOTIFY on transfer completion.

W or WARN NOTIFY only if the transfer received a warning or error.

E or ERROR NOTIFY only if the transfer received an error.

Default ALL

LOCAL_NOTIFY

Specifies the user on the local system who is to be notified that Unicenter CA-XCOM Data Transport has completed a transfer. Unicenter CA-XCOM Data Transport uses the NOTIFYL parameter to determine the type of notification to use.

Range 0 to 64 characters

Default None

3–60 User Guide

Notifying of Transfer Completion

NOTIFYL

The local user notification flag.

Range The range of values is listed in the following table:

Value Description

ALL A message is displayed on the local Windows system console.

WRITE A message is displayed on the screen.

MAIL A mail message is sent to the user.

NONE No notification is sent.

Default NONE

Note: The L in NOTIFYL indicates that the local system governs the processing of the resulting notification on that system.

A MAIL message is sent to the specified user only if a MAPI-compliant provider is configured as a non-domain account and/or allows local accounts (such as the xcomd service and the local user ID) access to the Windows system (for example, Microsoft Mail boxes and address books on the local system).

Note: Some Microsoft Outlook 2003 security updates may prevent mail notification from working.

NOTIFY_NAME

The user on the remote system who is to be notified when Unicenter CA-XCOM Data Transport completes a transfer.

Note: If the remote system is an IBM mainframe, Unicenter CA-XCOM Data Transport uses the value of NOTIFYR to determine the type of notification to deliver.

Range 0 to 12 characters

Default None

The Command Line Interface 3–61

Notifying of Transfer Completion

NOTIFYR

Specifies the remote user notification type when sending data to a remote system.

Range The range of values is listed in the following table:

Value Description

MAIL Mail is sent to the user

WRITE A message is displayed on the local Windows system console.

ALL A message is displayed on the local Windows system console.

TSO Notify specified TSO user.

WTO Write to log only (WTO).

ROSCOE Notify the specified Advantage CA-Roscoe user.

CICS Notify CICS user (not used in Release 1).

LU Notify Logical Unit (not used in Release 1).

NONE No notification is sent.

Default NONE

Note: The R in NOTIFYR indicates that the remote system governs the processing of the resulting notification on that system.

A MAIL message is sent to the specified user only if a MAPI-compliant provider is configured as a non-domain account and/or allows local accounts (such as the xcomd service and the local user ID) access to the Windows system (for example, Microsoft Mail boxes and address books on the local system).

Note: Some Microsoft Outlook 2003 security updates may prevent mail notification from working.

3–62 User Guide

Checkpointing and Restarting Transfers

RMTNTFYL

Specifies the remote user notification level when sending data to a remote system.

Range The range of values is listed in the table below.

Value Description

A or ALL NOTIFY on transfer completion.

W or WARN NOTIFY only if the transfer received a warning or error.

E or ERROR NOTIFY only if the transfer received an error.

Default ALL

Checkpointing and Restarting Transfers By setting the parameters in this section, a transfer is marked for checkpointing and automatic restart if an interruption occurs during the transfer attempt. After an interruption the XCOMD Unicenter CA-XCOM Scheduler service scans its table of transfers and automatically attempts to restart eligible transfers.

The CHECKPOINT_COUNT parameter indicates where to restart the transfer after it has been interrupted. If a transfer is interrupted, it is resumed from a checkpoint rather than starting over from the beginning of the file. When CHECKPOINT_COUNT=1000, Unicenter CA-XCOM Data Transport performs a check after every 1000 records sent, to ensure that the records are stored on the destination system. Then the next 1000 records are transmitted.

The restart parameters automatically restart a transfer after a transmission error, based on the number of retries and the retry time specified. Transmission conditions that permit restarts generally include most transmission errors. Restarts will also be attempted when a transfer is suspended by the remote system, and when a link goes down. Conditions that are not considered for restart include errors such as invalid passwords and “data set not cataloged” messages.

Note: Restart parameters can be specified without setting a checkpoint.

The Command Line Interface 3–63

Checkpointing and Restarting Transfers

Example 1

In the following example, the XCOM62 command is used. If the transfer is interrupted, it restarts from the most recent checkpoint of every 2000 records, and up to three attempts are made to retry the transfer at intervals of 30 seconds. XCOM62 -f CHECKPOINT_COUNT=2000 NUMBER_OF_RETRIES=3 RESTART_SUPPORTED=YES RETRY_TIME=30

All other necessary parameters are read from the default configuration file, XCOM.CNF.

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information

Example 2

In the following example, the XCOMTCP command is used. If the transfer is interrupted, it restarts from the most recent checkpoint of every 2000 records, and up to three attempts are made to retry the transfer at intervals of 30 seconds. XCOMTCP -f CHECKPOINT_COUNT=2000 NUMBER_OF_RETRIES=3 RESTART_SUPPORTED=YES RETRY_TIME=30

All other necessary parameters are read from the default configuration file, XCOM.CNF.

Note: The example above appears on more than one line here but is to be typed at the command prompt as a continuous command. Press Enter only after you have typed in all of your command information

3–64 User Guide

Checkpointing and Restarting Transfers

List of Parameters

The checkpoint and restart parameters are listed below.

CHECKPOINT_COUNT

Defines how often (based on record count) the sending system requests a checkpoint to be taken. The value 0 indicates no checkpointing.

Note: Setting the CHECKPOINT_COUNT affects performance. Each time a checkpoint is taken, the output buffers on the receiving system are written to the disk. On Token Ring, Ethernet, and other high-speed networks, the CHECKPOINT_COUNT should be set 0 or to the highest allowable value. The CHECKPOINT_COUNT should not be set for small files.

Range 0 to 9999

Default 1000

Note: Version 2 parameter.

NUMBER_OF_RETRIES

Indicates the maximum number of retries before a transfer is logged as failed and taken out of the transfer queue. If the value is 0, the transfer will not be retried.

Range 0 to 255

Default 1

Note: Version 2 parameter.

RESTART_SUPPORTED

Specifies whether automatic restart is to be supported on a transfer.

Range YES or NO

Default YES

Note: Version 2 parameter.

The Command Line Interface 3–65

Purging the Unicenter CA-XCOM Data Transport Log File

RETRY_TIME

The number of seconds between retries of unsuccessful transfers. If the value is 0, the transfer is retried without delay.

Range 0 to 99999

Default 1

Note: Version 2 parameter.

Purging the Unicenter CA-XCOM Data Transport Log File CLEANLOG.EXE allows the Unicenter CA-XCOM Data Transport transfer and error log to be purged of items older than a specified age. This assures that the file will not grow overly large. You can run CLEANLOG.EXE from the command line or from a command file. Unicenter CA-XCOM Data Transport should be idle when you run this program.

Syntax

The syntax for using CLEANLOG.EXE is as follows: CLEANLOG Number_of_days_old [Log file name]

Operand Description

Number_of_days_old Entries that meet the number of days in the log criterion will be purged

Log file name The name of the log file to clean (optional). The default is the XCOM.LOG in the current directory.

Example CLEANLOG 5

This command will remove entries in XCOM.LOG that are older than 5 days.

3–66 User Guide

Chapter

4 The Application Programming Interface

The Application Programming Interface (API) is intended to give programmers the capability of developing their own Unicenter CA-XCOM Data Transport applications.

There are two Unicenter CA-XCOM Data Transport APIs. They are:

Data Transport API Description

XcomAPI The XcomAPI provides the ability to submit transfers to Unicenter CA-XCOM Data Transport.

XcomQAPI The XcomQAPI provides the same functionality to manage the queue as the XCOMQM command line function, but through an API.

XcomAPI The XcomAPI routine uses C structures defined in the xcomapi.h file to pass information to Unicenter CA-XCOM Data Transport. The Unicenter CA-XCOM Data Transport XcomAPI() function call takes a starting state and a parameter block structure as its arguments. For transfers using SNA, before invoking XcomAPI, an SNA session must be active with the desired remote system.

The Application Programming Interface 4–1

XcomQAPI

XcomQAPI The XcomQAPI routine uses C structures defined in the xcomapi.h file to return information from the Unicenter CA-XCOM Data Transport Queue. The Unicenter CA-XCOM Data Transport XcomQAPI() function call takes a parameter field as its argument, which allows you to:

■ Delete entries from the queue

■ Suspend a transfer

■ Resume a suspended transfer

■ Display the list of entries in the queue

■ Display detailed information about the queue entries

Upgrading from Previous Releases The XcomAPI distributed with previous versions of Unicenter CA-XCOM Data Transport is different from this API. The XcomQAPI is new. If you have versions of the XcomAPI that were distributed prior to this version, recompile your Unicenter CA-XCOM Data Transport applications with the current version.

Link Libraries When linking libraries, you must use the appropriate Unicenter CA-XCOM Data Transport libraries for non-queued transfers that use SNA/APPC or TCP/IP protocols. (For queued transfers, either set of files is satisfactory.)

Sample links for use with both SNA and TCP/IP transfers are provided in the makefile distributed with Unicenter CA-XCOM Data Transport. The Library and API source files are located under the xcomnt\apisrc directory. Your SNA/APPC software supplies the SNA/APPC object library wcpic32.lib.

SNA Libraries

The following libraries are required for performing non-queued SNA transfers: xcomsna.lib wcpic32.lib - Supplied by your SNA/APPC Software xcom.lib compapi.lib card3log.lib

4–2 User Guide

Starting States

TCP/IP Libraries

The following libraries are required for performing non-queued TCP/IP transfers: xcomtcp.lib cato3xpi.lib xcom.lib compapi.lib card3log.lib

Starting States Valid starting states are as follows:

Starting State Used For LOCAL_SEND Initiates the transmission of a local file to a remote system as a

report, job, or file transfer. LOCAL_RECEIVE Initiates the transmission of a remote file to the local system.

The value returned by XcomAPI is zero if the transfer was successful. If not, an error code as defined in the startst.h header file will be generated.

Note: The sample API Program apitest.c should be edited to change the starting_state to LOCAL_SEND for report, job, or file transfers. starting_state should be changed to LOCAL_RECEIVE when initiating a receive file from a remote system. See the description of file_type in this chapter under API Member Names.

Starting States in startst.h The startst.h file contains the following: /* starting states to pass to XcomAPI */ #define LOCAL_SEND 152 #define LOCAL_RECEIVE 153

The Application Programming Interface 4–3

API Control Block Structure

API Control Block Structure The following is the include file xcomapi.h. This is a C language header file containing the necessary API definitions for the control block structure. #ifndef XCOMAPI_INCLUDED #define XCOMAPI_INCLUDED ONCE

#include "startst.h"

#define SEND_FILE "1" #define SEND_REPORT "2" #define SEND_JOB "3" #define RECEIVE_FILE "4"

typedef struct { char

*file_type, /* 1-file, 2-report, 3-job, 4-retrieve ( the same as starting_state=LOCAL_RECEIVE )*/

*protocol, /* communications protocol: SNA or TCPIP */ *port, /* TCPIP remote server port */ *remote_system, /* remote lu name */ *xluname, /* local lu name */ *xnodespec, /* node specification for SNA gateway node */

*xmode, /* mode */

*xidest, /* intermediate destination */

*local_file, /* local filename for send */ *remote_file, /* local filename for receive */

*local_file_rf, /* local filename for receive */ *remote_file_rf, /* remote filename for receive */

*remote_system_relay, /* remote system for relay transfer */ *remote_file_relay, /* remote filename for relay transfer */

*file_option, /* CREATE / REPLACE / APPEND */ *remove_trail_blanks, /* remove trailing blanks (MVS/R) */ *volume, /* volume */ *unit, /* unit */ *record_format, /* record format */ *lrecl, /* logical record length */ *blksize, /* block size */

/* remote printing parameters */ *local_file_sr, /* local filename for sending reports */ *class, /* printjob class */ *destination, /* name of remote printer */ *form, /* name of special forms to be used */ *fcb, /* Form Control Block */ *copies, /* number of copies to be printed */ *report_title, /* report name (banner) to be used on separator sheet */ *hold, /* flag for MVS spoolers */ *spool_flag, /* turns on spooling on receiving side */ *disposition, /* MVS file disposition */ *carriage_control_characters, /* A - ASA chars in column 1 , M -IBM Machine chars (MVS) */ *local_file_sj, /* local filename for sending jobs */

*userid, /* user id */ *password, /* password */

*queue, /* YES - queue transactions NO - execute immediately */

4–4 User Guide

API Control Block Structure

*start_time, /* time to start scheduled transaction */ *start_date, /* date to start scheduled transaction */

*notifyr, /* TSO / WTO / CICS / LU / VM */ *notify_name, /* who to notify */ *local_notify, /* user name for notification */ *notifyl, /* MAIL / WRITE */ *notify_term, /* user's terminal to notify if notifyl=WRITE */

*maxreclen, /* maximum record length */ *code_flag, /* ASCII / BINARY / EBCDIC */ *carriage_flag, /* specifies if it is a text file or a type of record packing to use */ *truncation, /* YES - truncation is allowed for this transfer */ *compress, /* YES / NO */

*xtrace, /* trace level */ *stat_frequency, /* How often to put record stats to Q-record */ *debug_flag, /* YES - debug output printed to stderr */

*xlogfile, /* log for locally initiated transactions */ *tempdir, /* directory to hold temporary files */

/* parameters used by xcom62 version 2 and higher only */ *version, *number_of_retries, *allocation_type, *checkpoint_count, *num_of_dir_blocks, *primary_alloc, *secondary_alloc, *restart_supported,

/* parameters used by xcom 3.1 and higher only */ *trusted, *domain, *den, *expdt, *retpd, *label, *tape, *unitct, *volct, *volsq, *labelnum, *tapedisp, /* internal use */

/* xcv32kv parameters used by xcom r11 and higher only */ *storcls, *datacls, *mgtclas, *dsntype, *codetabl, *lclntfyl, *rmtntfyl,

/* SSL parameters used by xcom r11 and higher only */ *configssl, *xcomfullssl,

/* Reserved for future use */ *hfs_flag, *seclabel,

/* user data */ *user_data, /* user data -- system dependent */ *transfer_usr_data, /* user data -- transfer specific */ *transfer_id, /* allows user definable identification for the transfer request */

The Application Programming Interface 4–5

API Control Block Structure

/* parameters normally taken from shared memory but may be overwritten in API */ *xlpcmd, /* print command with full path */ *xppcmd, /* print command with full path */ *xprecmd, /* pre-allocation exit command with full path */ *xendcmd, *xpullcmd, /* Relay transfer pull command exit */ *xpushcmd, /* Relay transfer push command exit */ *xnotifycmd, /* path name of command to notify users */ *shell_cmd, /* command to run shell scripts */ *eol_classes, /* print classes having NL added at end of record */ *convert_classes, /* classes needing ebcdic-ascii translation */ *metacode_classes; /* classes needing variable length records */ /* *ppVersion; Enable xcompp.bat for all transfers? */ } XCOM_PARM;

typedef struct { char user_name[128]; /* user name */ char array_message[128]; /* return text from multi-entries */ char array_message2[128]; /* return text from multi-entries */ char array_err_message[128]; /* return text from multi-entries */ } XCOM_QUEUE_ENTRY;

typedef XCOM_QUEUE_ENTRY XCOM_QUEUE[9999];

typedef struct { char funccode[2]; /* function code */ char tid[7]; /* transfer id (6 characters + null) */ char global_tid[128]; /* local transfer id */ char remote_tid[128]; /* remote transfer id */ int queue_open_once; /* allow queue open once */ int nMax_Queue_Entries; /* Maximum number of queue_entry */ int nQueueEntries; /* number of queue_entry returned */ int trace_level; /* trace level */ FILE *trace_stream; /* file handle for trace file */ char trace_filename[256]; /* name of the trace file */ char start_time[128]; /* start time */ char end_time[128]; /* end time */ char user_name[128]; /* remote user name */ char group_name[128]; /* group name */ char transfer_name[128]; /* user definable id for transfer request */ char xferdata[128]; /* user data -- transfer specific */ char sysdata[128]; /* user data -- system dependent */ char in_out[128]; /* in_out value */ char pid[128]; /* process id */ char remote_system[128]; /* remote lu name */ char file_type[128]; /* file type */ char transfer_type[128]; /* transfer type */ char user_group[128]; /* owned by user from group */ char lfile[257]; /* local file */ char file[257]; /* temporary file */ char rfile[257]; /* remote file */ char file_option[128]; /* file creation option */ char curr_cond[128]; /* current condition */ char curr_status[128]; /* current status */ char curr_state[128]; /* current TP state */ char rec_read_write[128]; /* record read or written to file */ char byte_read_write[128]; /* bytes read or written to file */ char blocks_trans[128]; /* blocks transmitted */ char bytes_trans[128]; /* bytes transmitted */ char sdsmessage[160]; /* message test for SDSNOTE */ char head_message[128]; /* title message */ char queue_message[128]; /* return text from queue */ char start_message[128]; /* return text from start of xcomd service */ char start_message2[128]; /* return text from start of xcomd service */ char end_message[128]; /* return text from end of process */ XCOM_QUEUE *pQueue; /* A array of XCOM_QUEUE structure */

4–6 User Guide

API Control Block Structure

} XCOM_QUEUE_PARM;

int XcomAPI(int invocation_mode,XCOM_PARM xparmblock); #ifndef _NO_PROTO char *msgstrng(int state, int sense); #else char *msgstrng(); #endif

#ifdef _NO_PROTO int XcomQAPI(); #else int XcomQAPI(XCOM_QUEUE_PARM * xqueueblock); #endif

/* volke01 12984613 added for QUEUE=NO API calls*/ #ifdef _NO_PROTO int qSubmitAPITransfer(); #else int qSubmitAPITransfer(int); #endif /* volke01 12984613 added for QUEUE=NO API calls*/ #ifdef _NO_PROTO int LocalRequestNoFork_API(); #else int LocalRequestNoFork_API(char **); #endif

#else /* XCOMAPI_INCLUDED */ #define XCOMAPI_INCLUDED MORE_THAN_ONCE #endif

The Application Programming Interface 4–7

Using API Member Names

Using API Member Names The member names in the following list are for use by applications programmers to create C structures that specify aspects about a transfer. The appropriate information is then passed to Unicenter CA-XCOM Data Transport by the XcomAPI routine.

Note: There are some parameters that appear in the header and sample files that are not included in the following list of parameters. These parameters are either internal, currently unused, or not applicable to the Unicenter CA-XCOM Data Transport Windows platform.

XcomAPI Member Names

The following XcomAPI member names are listed in alphabetical order.

allocation_type

Indicates the unit of storage allocation for a data set created on an IBM mainframe.

Range The range of values is listed in the following table.

Value Description

CYL Cylinders

TRK Tracks

BLK Blocks

Default CYL

Note: Version 2 parameter.

4–8 User Guide

Using API Member Names

blksize

Specifies the block size of the data set created on an IBM mainframe.

Range 0 to 32767

If the record format is Then the block size must be

Fixed or fixed block A multiple of the record length

Variable 4 bytes larger than the record length

Undefined Larger than the largest record length. A maximum of 5 digits can be entered.

Default 800

carriage_control_characters

Indicates the type of printer carriage control codes, if any that are included in the report file.

Note: For report transfers only.

Range The range of values is listed in the following table.

Value Description

ASA ASA control codes in column 1.

IBM IBM Machine Characters (valid only for IBM mainframes).

BYPASSASA If data is already in ASA format, bypass conversion.

OTHER No carriage-control codes are used.

Default OTHER

The Application Programming Interface 4–9

Using API Member Names

carriage_flag

Specifies the type of file being transferred and some special characteristics of the conversion done during the transfer.

Range The range of values is listed in the following table.

Value Description

YES Indicates that the transferred file is a text file and a new-line character should be added to the end of incoming records. Also, new-line characters are removed from the ends of lines before an outgoing record is sent.

NO Indicates no special processing.

MPACK Indicates a text file with record packing. Uses 2K pack buffer.

VLR Indicates a binary file of variable-length records with a field of 4 bytes preceding each record. Applies to local initiated transfers only.

VLR2 Indicates a binary file of variable-length records with a field of 8 bytes preceding each record. Applies to local initiated transfers only. Used for certain applications that require a z/OS-style BDW and RDW preceding each record.

XPACK Indicates a text file with record packing. Uses 31K pack buffer.

Note: MPACK does not support a MAXRECLEN (actual record length) over 2K. XPACK does not support a MAXRECLEN (actual record length) over 31K.

Default YES

checkpoint_count

Defines how often (based on record count) the sending system requests a checkpoint to be taken. The value 0000 indicates no checkpointing.

Range 0000 to 9999

Default 1000

Note: Version 2 parameter.

4–10 User Guide

Using API Member Names

class

The print class assigned to a report transferred to a remote system. If the remote system is an IBM mainframe, this field designates the JES SYSOUT class.

Note: For report transfers only.

Example Enter B to print the report through SYSOUT=B.

Range 1 character

Default None

code_flag

Used to identify the type of data being transferred.

Range The range of values is listed in the following table.

Value Description

ASCII An ASCII file is being transferred. This indicates that the incoming file is assumed to be in ASCII format, and is not translated. Therefore, the file on the remote system should be in ASCII format before it is transferred.

BINARY A binary file, such as an executable file, is being transferred. This indicates to a remote system not to translate the data it is exchanging with your system.

EBCDIC An EBCDIC file is being transferred. The transferred data is translated from EBCDIC to ASCII format when the local system receives the data, and from ASCII to EBCDIC format when the local system sends the data.

Default ASCII

codetabl

Specifies the 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. These custom character conversion tables determine which external translation tables will be used by the transfer.

This parameter is valid only if INTERNAL_CONVERSION_TABLES=NO.

The Application Programming Interface 4–11

Using API Member Names

Range 1 to 3 characters

Default None

compress

Indicates the compression type. When communicating with an IBM mainframe, if the data file contains any empty lines, COMPRESS can only be set to YES, LZSMALL, LZMEDIUM, or LZLARGE.

Note: All compressions types are not supported on all platforms. For supported compression types, see the partner platform documentation.

Range The range of values is listed in the following table.

Value Description

COMPACT RJE compaction algorithm optimized for uppercase English text.

LCOMPACT RJE compaction algorithm optimized for lowercase English text.

LZLARGE Activates LZ compression to search back 32K in the data stream for a matching string.

LZMEDIUM Activates LZ compression to search back 16K in the data stream for a matching string.

LZRW3 General-purpose algorithm that runs fast and gives reasonable compression.

LZSMALL Activates LZ compression to search back 4K in the data stream for a matching string.

NO Indicates no compression.

RLE Run length encoding.

YES Indicates run length encoding of binary zeros and blanks only.

ZLIB Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and LZLARGE. Equivalent to ZLIB6.

ZLIB(n) Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and LZLARGE. The optional n value can be 1 through 9

Note: The LZ values enable LZ (Lempel-Ziv) compression to replace sequences of data bytes that occur more than once in a data stream with a code value.

Default YES

4–12 User Guide

Using API Member Names

config_ssl

Specifies the configssl.cnf file path and file name.

Range 1 to 256 characters

Default c:\xcomnt\configssl.cnf

convert_classes

A character string containing print classes for which EBCDIC-to-ASCII conversions will be performed. For incoming report transfers only.

Range 1 to 64 characters

Default None

copies

The number of copies that are to be sent. If this parameter is not specified, the remote system queues one copy of the report to the system’s default printer. For report transfers only.

Range 1 to 999

Default 1

datacls

Specifies the 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.

Range 1 to 8 characters

Default None

debug_flag

Indicates whether to print trace data to STDERR.

Range YES or NO

Default NO

The Application Programming Interface 4–13

Using API Member Names

den

Specifies the density to be used in creating a tape on the remote system.

Value Definition

1 to 4 Specifies the density to be used in creating a tape on the remote system. Valid values are the same as those for the DEN parameter in JCL

Default None

destination

Identifies the printer or other device on the remote system where the report is to be sent. If this parameter is not specified, the remote system sends the report to the system's default printer. For report transfers only.

Range The range of values is listed in the following table.

Value Description

0 to 16 characters For indirect transfers and for Version 1.

0 to 21 characters For transfers that are not indirect and for Version 2.

Default None

disposition

Indicates what the remote system does with the report file after the report has been printed. For report transfers only.

Note: This field is not used when the remote system is an IBM mainframe.

Range The range of values is listed in the following table.

If the value is Then after printing, the report is

DELETE Deleted

KEEP Kept

HOLD Held

Default DELETE

4–14 User Guide

Using API Member Names

domain

The Windows domain name for use in authenticating the user ID and password.

Range 1 to 15 characters.

Default None

dsntype

Specifies the data set definition.

Note: This parameter applies only to mainframe SMS data sets.

Value Description

LIBRARY Defines a PDSE

PDS Defines a partitioned data set

Note: These values are IBM standards for SMS processing.

eol_classes

A character string containing print classes for which an ASCII new-line character will be appended to each record. For incoming report transfers only.

Range 1 to 64 characters

Default None

expdt

Specifies an expiration date for the tape data set in terms of a two-digit designation for the year, and a three-digit designation for the day of the year. For example, in the expiration date 02021, 02 is the year (namely, 2002) and 021 is the 21st day of that year when the tape data set expires. For example, if 02021 is an expiration date, 2002 is the year and 021 is the 21st day of the year.

Range yyddd

Default None

Note: EXPDT and RETPD are mutually exclusive; specify one or the other.

The Application Programming Interface 4–15

Using API Member Names

fcb

Identifies the FCB JCL parameter when sending the report file to an IBM mainframe, defining print density, lines per page, etc. For report transfers only.

Range 0 to 4 characters

Default None

file_option

Indicates how the transferred data is to be processed by the receiving system. For file transfers only.

Range The range of values is listed in the following table.

Value Description

CREATE Create a new file on the receiving system.

APPEND Append the transferred data to an existing file on the receiving system.

REPLACE Replace an existing file on the receiving system.

For library-type transfers, the range of values is as follows:

Value Description

CREATE Creates the PDS on the receiving system and adds the transferred members. If the PDS already exists then the transfer will fail. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES, the transfer will create the directory and add the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer will fail.

ADD Adds or replaces transferred members on the receiving system. If the PDS does not exist, the transfer will fail.

REPLACE Adds or replaces transferred members. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES, the transfer will create the directory and add the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer will fail

4–16 User Guide

Using API Member Names

Default CREATE

Note: When creating a file on an IBM mainframe system, some additional information may be necessary. For more information, see the RECORD_FORMAT, BLKSIZE, VOLUME, and UNIT parameters.

file_type

Indicates the type of transmission.

Range The following table lists the valid values for this parameter:

Value Description

SEND_FILE File transfer

SEND_REPORT Report to be printed

SEND_JOB Job

RECEIVE_FILE Retrieval of a file

Note: starting_state needs to be changed to:

if the transmission type is:

LOCAL_SEND SEND_FILE, SEND_REPORT, or SEND_JOB

LOCAL_RECEIVE RECEIVE_FILE

form

The type of form that should be used to print the report. Since Unicenter CA-XCOM Data Transport places the print job in the print queue of the remote system, the print control functions depend on the remote system. The user must verify beforehand that the requested form is available at the remote site. For report transfers only.

Note: When sending a report to a VAX computer, leave this parameter blank unless you are certain that this is a valid form type. VMS interprets this to mean that no special form is being requested.

Range 0 to 10 characters

Default None

The Application Programming Interface 4–17

Using API Member Names

hold

Indicates whether this transferred report file is to be placed on HOLD status on the remote system or is to be readied for immediate printing. Specify Y to request that it be held (spooled on a z/OS system).

Range YES or NO

Default NO

label

Indicates the type of label associated with a tape data set.

Range The following table lists the valid values for this parameter:

Value Definition

Processing type:

AL, AUL, BLP, LTM, NL, NSL, SL, SUL

Represent the types of processing to be applied to data sets on tape.

Note: Unicenter CA-XCOM Data Transport for z/OS supports only standard label tapes.

Example LABEL=BLP

The type of processing to be applied to this data set is BLP.

Default SL

labelnum

Indicates the sequence number of the data set on the tape.

Range The following table lists the valid values for this parameter:

Value Definition

sequence number (1-9999) This value identifies the sequence number of a data set on tape.

4–18 User Guide

Using API Member Names

Example LABELNUM=2

This specification refers to the 2nd data set on the tape.

Default 1

lclntfyl

Specifies the local user notification level.

Range The range of values is listed in the following table:

Value Description

A or ALL NOTIFY on transfer completion.

W or WARN NOTIFY only if the transfer received a warning or error.

E or ERROR NOTIFY only if the transfer received an error.

Default ALL

local_file

The name of the file on the local system that is being transferred. If this variable is null or unset, standard input is read. In this manner, Unicenter CA-XCOM Data Transport commands can be used in a pipeline or with redirection. All Windows file-naming conventions apply.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

local_file_rf

The file name that is created, appended, or replaced on the local system when it receives a file. All Windows file-naming conventions apply. If this value is null or unset, then Unicenter CA-XCOM Data Transport writes to the standard input file.

Note: If QUEUE=YES, user must specify full path name.

The Application Programming Interface 4–19

Using API Member Names

Range 0 to 256 characters

Default None

local_file_sj

Indicates the name of the file on the local system to be sent as a job. All the Windows file-naming conventions apply. If this value is null or unset, then Unicenter CA-XCOM Data Transport reads the standard input file.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

local_file_sr

Local file name to be sent as a report to the remote system. If this value is null or unset, then Unicenter CA-XCOM Data Transport reads the standard input file. For report transfers only.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

local_notify

Specifies the user on the local system who is to be notified that Unicenter CA-XCOM Data Transport has completed a transfer. Unicenter CA-XCOM Data Transport uses the NOTIFYL parameter to determine the type of notification to use.

Range 0 to 64 characters

Default None

4–20 User Guide

Using API Member Names

lrecl

Specifies the actual or maximum length, in bytes, of a logical record. Corresponds to the JCL LRECL subparameter.

Range 0 to 32767

If the format is… Then the maximum length of a logical record must be equal to the…

Variable blocked record Maximum record length plus 4

Fixed or fixed block record Constant record length

Default 160

maxreclen

For Windows and UNIX systems, the locally initiating Unicenter CA-XCOM Data Transport system determines the values for MAXRECLEN, TRUNCATION, and LRECL, for send and receive operations. When the local Unicenter CA-XCOM Data Transport system initiates a transfer of a text file, this parameter designates the length, in bytes, of the largest record that can be transferred. If a record length is longer than this value, Unicenter CA-XCOM Data Transport uses the value in the TRUNCATION parameter on the initiating side to determine whether to terminate the transfer or to truncate the record and continue the transfer. When Unicenter CA-XCOM Data Transport transfers binary files, this value indicates the length of the records that are transferred. On a receive operation, MAXRECLEN is set to whatever the LRECL value is on the initiating side.

Range 1 to 32767

Default 1024

metacode_classes

Classes of print jobs that will be saved in metacode format, a variable length record format. For incoming report transfers only.

Range 0 to 64 characters

Default None

The Application Programming Interface 4–21

Using API Member Names

mgtclas

Specifies the 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.

Range 1 to 8 characters

Default None

notify_name

The user on the remote system who is to be notified when Unicenter CA-XCOM Data Transport completes a transfer.

Note: If the remote system is an IBM mainframe, Unicenter CA-XCOM Data Transport uses the value of NOTIFYR to determine the type of notification to deliver.

Range 0 to 12 characters

Default None

notifyl

The local user notification flag.

Range The range of values is listed in the following table.

Value Description

MAIL A mail message is sent to the user.

WRITE A message is displayed on the workstation where the user is logged in.

ALL A message is displayed on all workstations attached to the server.

NONE No notification is sent.

Default None

A MAIL message is sent to the specified user only if a MAPI-compliant provider is configured as a non-domain account and/or allows local accounts (such as the xcomd service and the local user ID) access to the Windows system (for example, Microsoft Mail boxes and address books on the local system).

4–22 User Guide

Using API Member Names

Note: Some Microsoft Outlook 2003 security updates may prevent mail notification from working.

notifyr

Specifies the remote user notification type when sending data to a remote system.

Range The range of values is listed in the following table.

Value Description

MAIL A mail message is sent to the user.

WRITE A message is displayed on the screen.

ALL Writes to all users or the console depending on platform.

TSO The specified TSO user is notified.

WTO Unicenter CA-XCOM Data Transport writes to the log only (WTO).

ROSCOE Notify the specified Advantage CA-Roscoe user.

CICS The specified CICS user is notified (not used for Version 1 type transfers).

LU Notify Logical Unit (not used for Version 1 type transfers).

NONE Do not notify.

Default None

Notes: ■ A MAIL message is sent to the specified user only if a MAPI-compliant

provider is configured as a non-domain account and/or allows local accounts (such as the xcomd service and the local user ID) access to the Windows system (for example, Microsoft Mail boxes and address books on the local system).

■ Some Microsoft Outlook 2003 security updates may prevent mail notification from working.

The Application Programming Interface 4–23

Using API Member Names

notify_term

Specifies terminals to write to if NOTIFYL=WRITE. If NOTIFY_TERM is not set. All users specified in LOCAL_NOTIFY will be notified at the first terminal where they are logged in as found in the system table.

Range 0 to 256 characters

Default None

number_of_retries

Maximum number of retries before a transfer is logged as failed and taken out of the transfer queue. If the value is 0, no retries are attempted.

Range 0 to 255

Default 1

Note: Version 2 parameter.

num_of_dir_blocks

Specifies the number of directory blocks to allocate for a data set created on an IBM mainframe.

Range 0 to 32767

Default 0

Note: Version 2 parameter

password

The password associated with the user ID on a remote system.

Range 0 to 31 characters

Default None

4–24 User Guide

Using API Member Names

primary_alloc

Identifies primary storage allocation for a data set created on an IBM mainframe.

Range 0 to 99999

Default 1

Note: Version 2 parameter

port

The number of the TCP/IP port on the remote Unicenter CA-XCOM Data Transport server. Used for TCP/IP transfers only.

Range 0 to 65535

Default 8044

protocol

The type of communication protocols to use.

Range The range of values is listed in the following table.

Value Description

SNA For transfers using SNA/APPC communication protocols

TCPIP For transfers using TCP/IP communication protocols

Default SNA

The Application Programming Interface 4–25

Using API Member Names

queue

Indicates whether to execute the transmission request immediately or to allow the request to be queued. If the user does not specify a .cnf file, and has not changed a .cnf file, the default value is “YES.”

Note: If NO is specified and the remote system is unavailable, the request aborts. If YES is specified, start_time and start_date are read.

Range The range of values is listed in the following table.

Value Description

YES The transfer request goes into a queue and executes depending on the traffic in the queue and START_DATE and START_TIME.

NO The transfer starts immediately.

Default YES

record_format

Specifies the record format of a data set created on an IBM mainframe. This corresponds to the JCL RECFM subparameter.

Range The range of values is listed in the following table.

Value Description Record Length Comment

F Fixed unblocked The same length as the data set

FA Fixed unblocked ANSI

The same length as the data set

Contains ISO/ANSI/FIPS control characters

FB Fixed blocked Fixed Fixed record length with multiple records per block

FBA Fixed blocked ANSI

Fixed Multiple records per block where these records contain ISO/ANSI/FIPS control characters

4–26 User Guide

Using API Member Names

Value Description Record Length Comment

FBS Fixed blocked spanned

Fixed Multiple records per block written as standard blocks

FM Fixed unblocked machine

The same length as the data set

Contains machine code control characters

FS Fixed unblocked spanned

The same length as the data set

Written as standard blocks where these records do not contain any truncated blocks or unfilled tracks

U Undefined Undefined

V Variable unblocked

Variable

VA Variable unblocked ANSI

Variable Contains ISO/ANSI/FIPS control characters

VB Variable blocked Variable Multiple records per block

VBA Variable blocked ANSI

Variable Multiple records per block where these records contain ISO/ANSI/FIPS control characters

VBM Variable blocked machine

Variable Multiple records per block where these records contain machine code control characters

VBS Variable blocked spanned

Variable May have multiple records per block where these records can span more than one block

VM Variable unblocked machine

Variable Contains machine code control characters

VS Variable unblocked spanned

Variable A record can span more than one block

Default VB

The Application Programming Interface 4–27

Using API Member Names

remote_file

Indicates the file on the remote computer to which the transferred data is being written. If you are creating the file (FILE_OPTION=CREATE), the file name must be consistent with the file naming conventions of the remote system. The local Unicenter CA-XCOM Data Transport system does not validate this name. The remote I/O system determines whether the file name is valid.

Note: For send file transfers only.

Range 1 to 256 characters

Default None

remote_file_rf

Indicates the name of the file to be retrieved from the remote system.

Note: For retrieve file transfers only.

Range 1 to 256 characters

Default None

remote_system

The name of the remote system that receives a file, job, or report.

For SNA/APPC protocols, the name is as specified in the SNA/APPC configuration of the local system. For RS/6000, this is the LU6.2 Side Information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

4–28 User Guide

Using API Member Names

remove_trail_blanks

Indicates whether to remove the blanks at the end of each record when receiving a text file.

Range YES or NO

Default NO

report_title

This field contains the report title and job number that will be printed on the report. The field has the following format:

8 characters 2 characters 8 characters

Job Name Blanks Job Number

The Job ID is optional and can be skipped. The Job Name can also be skipped, but if you skip the Job name and want to use the job number, you must pad the number with 10 blanks. For more information, see the appendix “Unicenter CA-XCOM Data Transport Parameters.”

Note: For report transfers only.

Range 0 to 21 alphanumeric or blank characters

Default None

restart_supported

Specifies whether automatic restart is to be supported on a transfer.

Range YES or NO

Default YES

Note: Version 2 parameter.

The Application Programming Interface 4–29

Using API Member Names

retpd

Specifies the number of days (1 to 9999) that the tape data set being created is to be retained.

Range 1 to 9999

Default None

Note: RETPD and EXPDT are mutually exclusive; specify one or the other.

rmtntfyl

Specifies the remote user notification level when sending data to a remote system.

Range The range of values is listed in the following table:

Value Description

A or ALL NOTIFY on transfer completion.

W or WARN NOTIFY only if the transfer received a warning or error.

E or ERROR NOTIFY only if the transfer received an error.

Default ALL

secondary_alloc

Identifies secondary storage allocation for a data set created on an IBM mainframe.

Range 0 to 99999

Default 0

Note: Version 2 parameter.

4–30 User Guide

Using API Member Names

shell_cmd

Name of the command that runs jobs, reports, notification scripts, and post processing scripts on the local system.

Range 1 to 256 characters

Default CMD.EXE/C

spool_flag

Indicates whether the report is to be spooled to disk or printed immediately. For report transfers only.

Note: If the remote system is an IBM mainframe, this parameter has no effect on the transfer.

Range YES or NO

Default YES

start_date

Indicates the date on which the transfer becomes eligible for execution. The format is mm/dd/yy. If this field is blank, the current date is used.

Range mm/dd/yy

Default None

start_time

Indicates the time when the transfer becomes eligible for execution. The military format of hh:mm:ss is used. If this field is blank, then the current time is used.

Range hh:mm:ss

Default None

The Application Programming Interface 4–31

Using API Member Names

stat_frequency

Indicates the frequency with which transfer statistics are made available to xcomqm. Intended for tuning high-speed links. Longer values help performance, but byte/record counts in xcomqm -D may be slightly behind the actual counts.

Range 1 to 9999 records

Default 1

storcls

Specifies the name of the storage class for a new SMS-managed data set.

Note: This parameter applies only to mainframe SMS data sets.

Range 1 to 8 characters

Default None

tape

Indicates to the remote system whether the volume is a tape volume or a disk file.

Range YES - Indicates a tape volume and that mounts are allowed when performing dynamic allocation.

NO - Indicates that the transfer is to a disk file.

Default NO

tempdir

Indicates the directory in which temporary files for jobs and reports can be created.

Range 1 to 256 characters

Default \TMP

4–32 User Guide

Using API Member Names

transfer_id

Allows the user to enter information to identify the file transfer request.

Range 0 to 10 characters

Default None

transfer_usr_data

An open field where a user can specify any text associated with the transfer.

Range 0 to 10 characters

Default None

truncation

Indicates whether Unicenter CA-XCOM Data Transport truncates excess characters in the source file if the record exceeds the maximum record length as indicated by the MAXRECLEN parameter. If NO is selected, and the maximum record length is exceeded, Unicenter CA-XCOM Data Transport aborts the transfer. This parameter is ignored if CARRIAGE_FLAG=NO.

Note: Truncation is not valid for BINARY data.

Range YES or NO

Default NO

trusted

To allow the user to request a trusted transfer.

Range YES, NO, Y, or N

Default None

The Application Programming Interface 4–33

Using API Member Names

unit

Specifies the unit on which a data set is to be created on an IBM mainframe.

Note: Used when FILE_OPTION=CREATE.

Range 0 to 6 characters

Default None

unitct

Specifies the number of units to be allocated on the remote system.

Range 1 to 20

Default None

userid

The user ID that the security system on a remote system checks before granting access for the file transfer.

0 to 12 characters

Default None

user_data

An open field where a user can specify any text associated with the transfer.

Range 0 to 10 characters

Default None

version

Indicates the version of the Unicenter CA-XCOM Data Transport protocol to be used for this transfer. For using TCP/IP, only a value of 2 is valid.

Range 1 or 2

Default 2

Note: Version 2 parameter.

4–34 User Guide

Using API Member Names

volct

Specifies the maximum number of volumes to be used in processing a multi-volume output tape data set on the remote system.

Range 1 to 255

Default None

volsq

Specifies the sequence number of the first volume of a multi-volume remote data set to be used.

Range 1 to 255

Default None

volume

Specifies the volume on which a data set is to be created on an IBM mainframe.

Range 0 to 6 characters

Default None

xcomfullssl

Specifies whether to use an OpenSSL socket or non-OpenSSL socket for transfers.

Range The range of values is listed in the following table:

Value Description

YES Performs secure transfer.

The transfer uses an OpenSSL socket and must to connect to a SSL listener on the remote partner.

NO Performs non-secure transfer.

The transfer uses a non-OpenSSL socket.

Default NO

The Application Programming Interface 4–35

Using API Member Names

xendcmd

The name of the post processing command optionally invoked by the Unicenter CA-XCOM Data Transport transfer program after any type of transfer is finished, whether successful or not. Invoked after partner communications have ended.

Range 0 to 256 characters

Default None

xidest

Specifies the name of the LU or TCP/IP address on the intermediate destination that is designated for store-and-forward transfers. If this variable is null or unset, then a direct connection to a remote system is attempted. If it contains a value, it is taken to be the name of an intermediate Unicenter CA-XCOM Data Transport destination that will handle traffic to and from the named remote system.

Note: For store-and-forward transfers only.

Range 0 to 14 characters

Default None

xlogfile

The name of the file where Unicenter CA-XCOM Data Transport logs activity. If you do not specify this parameter, the systemwide log file c:\xcomnt\xcom.log is used. If you specify this parameter with a different file name, the logging information is only sent to the specified file.

Note: Specify the full pathname if QUEUE=YES.

Range 0 to 256 characters

Default c:\xcomnt\xcom.log

xlpcmd

Name of the post-processing command used to send print jobs to the spooler. For incoming reports only.

Range 0 to 256 characters

Default c:\xcmnt\xcomlp.bat

4–36 User Guide

Using API Member Names

xmode

Indicates the mode name associated with the SNA/APPC configuration for the Local-Remote LU name pair. This name must match the mode name defined on the remote system.

Range 1 to 8 characters

Default XCOMMODE

xnotifycmd

Pathname of the command that Unicenter CA-XCOM Data Transport will use to notify users on the local system of the completion of a transfer. This is normally a shell script that composes a message and invokes mail or write as appropriate.

Range 1 to 64 characters

Default c:\xcomnt\xcomntfy.bat

xppcmd

Pathname of the command used for user-defined post processing, for file transfers only. Only used when the local system is receiving the file.

Range 1 to 64 characters

Default c:\xcomnt\xcompp.bat

xprecmd

Pathname of the command used for user-defined pre-allocation processing, for locally and remotely initiated transfers. Specify this parameter in xcom.glb to invoke the pre-allocation exit xcompre.

Range 0 to 64 characters

Default None

The Application Programming Interface 4–37

Using XcomQAPI Option Parameters

xtrace

Indicates the level of desired execution tracing.

Range The range of values is listed in the following table.

Value Description

0 No tracing

1 to 8 Levels of tracing from 1 (lowest) to 8 (highest)

9 Show the contents of the data buffers

10 Includes levels 1 - 9, plus some additional detailed technical information

Default 0

Using XcomQAPI Option Parameters The XcomQAPI option parameters are for use by application programmers to pass and retrieve information in a C structure to and from the XcomQAPI routine. These parameters need to be supplied by you and passed on to the XcomQAPI. The rest of the parameters are a receive buffer. They will receive data from XcomQAPI.

Option Parameters

The option parameters in the following list are used to pass and retrieve information from the queue request.

funccode

Used to define a function parameter to pass to XcomQAPI().

Function Parameters:

Value Description

r Display the version of Unicenter CA-XCOM Data Transport software installed.

Aentryname Release a held transfer.

4–38 User Guide

Using XcomQAPI Option Parameters

Value Description

Centryname Get a trace of a transfer.

Dentryname Display details about a queue entry.

Hentryname Hold a scheduled transfer.

L List your queued transfers.

La List all queued transfers.

Rentryname Remove a queue entry.

Rfentryname Force the entry to be removed from the queue. Use this command when you want to remove a transfer that is still active.

R* Remove all completed or scheduled entries from the queue. If you use this option on an active transfer, it interrupts the transfer.

Tentryname Terminate an active transfer.

Tfentryname Force termination of a transfer. Use this command when you want to remove a transfer that is still active.

Caution: When using SNA/APPC protocols, the TP will abend and it may be necessary to restart the underlying SNA software. When using TCP/IP, xcomtcp will abend.

Sentryname Suspend a transfer.

Eentryname Resume a suspended transfer.

d Create a trace file.

gentryname Display queue entry information.

pentryname Used to change the value of: FILE_OPTION, LOCAL_FILE and REMOTE_FILE.

Note: You are only allowed to use this option from the XCOMPRE exit.

Note: entryname represents the Transaction ID, which is the six-digit number of the transfer entry in the queue.

The Application Programming Interface 4–39

API Examples

Parameters Set Within the XcomQAPI Program

The following are parameters that can be set within the XcomQAPI program:

Parameter Description

tid A queue entry TID number.

queue_open_once Open queue flag. Define this only once at the first call of XcomQAPI. The value should be set to 0.

nMax_Queue_Entries Defines maximum queue entries. The value should be set equal to MAX_QUEUE_ENTRIES in the xcom.glb file.

trace_level Defines the trace level. The values can be set to 0, 1, or 9.

trace_filename Defines a trace file name and its location, such as C:\temp\xcomqapi.tra

API Examples This section contains C language examples of applications written using the APIs. Examples are for reference only.

About the XcomAPI Example

The program below is an example of a file transfer. It uses the XcomAPI routine to pass information to Unicenter CA-XCOM Data Transport. This sample API program is the apitest.c file distributed with Unicenter CA-XCOM Data Transport. Please note that the API example provided on your distribution media may have been updated for your Unicenter CA-XCOM Data Transport system and may be different from the example shown below.

4–40 User Guide

API Examples

Unicenter CA-XCOM Data Transport for Windows NT API Return Codes

Unicenter CA-XCOM Data Transport for Windows NT Server/Professional API has the following return codes:

Return Code Explanation

603 The TP state is invalid.

602 There was a general error in queue function.

601 Permission denied.

600 Transfer is not active.

469 XCOMD CA-XCOM Scheduler service is not running or is not compatible

0 The transfer was successful.

-1 The named file does not exist or is not accessible in the given mode.

-9 XCOMQM detected an unknown error.

-1100 XCOMQM is unable to find the entry in the queue.

-1801 XCOMQM is unable to open the index file.

-1802 XCOMQM is unable to close the index file.

-1803 XCOMQM detected invalid command line options

Example

The following is a C language example of a program using the API that receives a remote file named /u/user/test.txt and replaces the local file named d:\temp\test.txt2 using the TCP/IP protocol. /* apitest.c - This is a sample program for calling the XcomAPI. */ /* Modify this according to your needs and make it */ /* with the sample 'apitcp.mak' / 'apisna.mak' */ /* in this directory. */ /* Please note that XcomAPI is not thread safe. */

#include <stdio.h> #include "xcomapi.h" main(int argc,char **argv) { int rc; XCOM_PARM xcomparm; int starting_state; memset(&xcomparm,0,sizeof(xcomparm));

The Application Programming Interface 4–41

API Examples

/* xcomparm.file_type = SEND_FILE; "1" */

xcomparm.file_type = RECEIVE_FILE; /* "4" */ /* remember to link with the appropriate xcom libraries for each protocol */ xcomparm.protocol = "TCPIP"; /* "SNA" or "TCPIP" */

xcomparm.remote_system = "0.0.0.0"; xcomparm.port = "8044"; xcomparm.xluname = "";

xcomparm.xmode = "";

xcomparm.local_file = "d:\\temp\\test.txt2"; xcomparm.remote_file = "/u/user/test.txt";

xcomparm.local_file_rf = "d:\\temp\\test.txt2"; xcomparm.remote_file_rf = "/u/user/test.txt";

xcomparm.file_option = "REPLACE";

xcomparm.userid = ""; xcomparm.password = "";

/* if queue = NO, must link with right xcom lib */ xcomparm.queue = "NO";

xcomparm.code_flag = "ASCII"; xcomparm.truncation = "YES";

xcomparm.xtrace = "10"; xcomparm.stat_frequency = "1";

xcomparm.trusted = NULL; xcomparm.domain = NULL; xcomparm.den = NULL; xcomparm.expdt = NULL; xcomparm.retpd = NULL; xcomparm.label = NULL; xcomparm.tape = NULL; xcomparm.unitct = NULL; xcomparm.volct = NULL; xcomparm.volsq = NULL;

/* These parms are new for r11 XCOM */ xcomparm.xcomfullssl = NULL; xcomparm.configssl = NULL;

xcomparm.codetabl = NULL; xcomparm.rmtntfyl = NULL; xcomparm.lclntfyl = NULL; xcomparm.storcls = NULL; xcomparm.datacls = NULL; xcomparm.mgtclas = NULL; xcomparm.dsntype = NULL;

starting_state=LOCAL_RECEIVE; printf("==== API Started ====\n"); rc=XcomAPI(starting_state, xcomparm); if (rc) printf("==== %s\n", msgstrng(rc,0)); printf("==== API Ended ====\n");

return rc; }

4–42 User Guide

API Examples

XcomQAPI Example

The XcomQAPI sample is an example of a queue request. It uses the XcomQAPI() routine to pass information to Unicenter CA-XCOM Data Transport. This sample API program is the qapitest.c file distributed with Unicenter CA-XCOM Data Transport.

Note: The API example provided on your distribution media may have been updated for your Unicenter CA-XCOM Data Transport system and may be different from the example shown below.

Example

The following is a C language example of a program using the API to call the XcomQAPI. /* qapitest.c - This is a sample program for calling the XcomQAPI. */ /* Modify this according to your needs and make it */ /* with the sample 'qapitcp.mak' / 'qapisna.mak' */ /* in this directory. */ /* Please note that XcomQAPI is not thread safe. */

#include <stdio.h> #include <stdlib.h> #include <malloc.h> #include "xcomapi.h"

main(int argc,char **argv) { int rc, i; XCOM_QUEUE_PARM *xcomqparm;

/* allocate memory for structure of xcomqparm */ xcomqparm = (XCOM_QUEUE_PARM *)malloc(sizeof(XCOM_QUEUE_PARM)); if (xcomqparm == NULL) printf("Could not allocate memory to run QAPI process !\n"); else { /* Reset allocated memory to all zeros */ memset(xcomqparm,0,sizeof(XCOM_QUEUE_PARM)); /* xcomqparm->nMax_Queue_Entries should equal to MAX_QUEUE_ENTRIES in xcom.glb file */ xcomqparm->nMax_Queue_Entries = 50; /* allocate memory for structure of pQueue */ xcomqparm->pQueue = (XCOM_QUEUE *)malloc(xcomqparm->nMax_Queue_Entries * sizeof(XCOM_QUEUE_ENTRY)); if (xcomqparm->pQueue == NULL) printf("Could not allocate memory to run QAPI process !\n"); else { /* Reset allocated memory to all zeros */ memset(xcomqparm->pQueue,0,xcomqparm->nMax_Queue_Entries * sizeof(XCOM_QUEUE_ENTRY)); printf("==== QAPI started ===\n");

/* call option 'r' to display Unicenter CA-XCOM Data Transport version */ xcomqparm->funccode[0] = 'r'; rc=XcomQAPI(xcomqparm); if (strlen(xcomqparm->start_message)) printf("%s", xcomqparm->start_message); if (xcomqparm->nQueueEntries == 1) printf("%s", (*xcomqparm->pQueue)[0].array_message);

The Application Programming Interface 4–43

API Examples

/* call option 'd' to turn on trace file */ xcomqparm->trace_level = 9; strcpy(xcomqparm->trace_filename, "c:\\xcomnt\\trace\\xcomqapi.tra"); xcomqparm->funccode[0] = 'd'; rc=XcomQAPI(xcomqparm);

/* call option 'La' to list all queue entries */ xcomqparm->funccode[0] = 'L'; xcomqparm->funccode[1] = 'a'; rc=XcomQAPI(xcomqparm); /* check for error message */ if (strlen((*xcomqparm->pQueue)[0].array_err_message)) printf("%s", (*xcomqparm->pQueue)[0].array_err_message); /* print detail information for all queue entries */ for (i = 0; i < xcomqparm->nQueueEntries; i++) { printf("%s", (*xcomqparm->pQueue)[i].user_name); printf("%s", (*xcomqparm->pQueue)[i].array_message); } if ((xcomqparm->nQueueEntries == 0) && strlen((*xcomqparm->pQueue)[0].array_message)) printf("%s", (*xcomqparm->pQueue)[0].array_message); /* call option 'Z' to list entries log messages */ xcomqparm->funccode[0] = 'Z'; strcpy(xcomqparm->tid, "000001"); rc=XcomQAPI(xcomqparm); /* check for error message */ if (strlen((*xcomqparm->pQueue)[0].array_err_message)) printf("%s", (*xcomqparm->pQueue)[0].array_err_message); /* print detail information for all queue entries */ for (i = 0; i < xcomqparm->nQueueEntries; i++) { printf("%s", (*xcomqparm->pQueue)[i].user_name); printf("%s", (*xcomqparm->pQueue)[i].array_message); } if ((xcomqparm->nQueueEntries == 0) && strlen((*xcomqparm->pQueue)[0].array_message)) printf("%s", (*xcomqparm->pQueue)[0].array_message); /* call option 'Dxxxxxx' to display detail record information */ memset(xcomqparm->lfile,0,sizeof(xcomqparm->lfile)); memset(xcomqparm->rfile,0,sizeof(xcomqparm->rfile)); strcpy(xcomqparm->tid, "000001"); xcomqparm->funccode[0] = 'D'; rc=XcomQAPI(xcomqparm); /* check for error message */ if (strlen((*xcomqparm->pQueue)[0].array_err_message)) printf("%s", (*xcomqparm->pQueue)[0].array_err_message); /* display detail record information */ if (strlen(xcomqparm->head_message)) printf("%s", xcomqparm->head_message); if (strlen(xcomqparm->global_tid)) printf("%s", xcomqparm->global_tid); if (strlen(xcomqparm->remote_tid)) printf("%s", xcomqparm->remote_tid); if (strlen(xcomqparm->group_name)) printf("%s", xcomqparm->group_name); if (strlen(xcomqparm->transfer_name)) printf("%s", xcomqparm->transfer_name); if (strlen(xcomqparm->xferdata)) printf("%s", xcomqparm->xferdata); if (strlen(xcomqparm->sysdata)) printf("%s", xcomqparm->sysdata); if (strlen(xcomqparm->start_time)) printf("%s", xcomqparm->start_time); if (strlen(xcomqparm->transfer_type)) printf("%s", xcomqparm->transfer_type); if (strlen(xcomqparm->lfile)) printf("%s", xcomqparm->lfile); if (strlen(xcomqparm->file))

4–44 User Guide

API Examples

printf("%s", xcomqparm->file); if (strlen(xcomqparm->sdsmessage)) printf("%s", xcomqparm->sdsmessage); if (strlen(xcomqparm->rfile)) printf("%s", xcomqparm->rfile); if (strlen(xcomqparm->in_out)) printf("%s", xcomqparm->in_out); if (strlen(xcomqparm->remote_system)) printf("%s", xcomqparm->remote_system); if (strlen(xcomqparm->end_time)) printf("%s", xcomqparm->end_time); if (strlen(xcomqparm->pid)) printf("%s", xcomqparm->pid); if (strlen(xcomqparm->user_group)) printf("%s", xcomqparm->user_group); if (strlen(xcomqparm->curr_cond)) printf("%s", xcomqparm->curr_cond); if (strlen(xcomqparm->curr_status)) printf("%s", xcomqparm->curr_status); if (strlen(xcomqparm->curr_state)) printf("%s", xcomqparm->curr_state); if (strlen(xcomqparm->rec_read_write)) printf("%s", xcomqparm->rec_read_write); if (strlen(xcomqparm->byte_read_write)) printf("%s", xcomqparm->byte_read_write); if (strlen(xcomqparm->blocks_trans)) printf("%s", xcomqparm->blocks_trans); if (strlen(xcomqparm->bytes_trans)) printf("%s", xcomqparm->bytes_trans); if (strlen((*xcomqparm->pQueue)[0].array_message)) printf("%s", (*xcomqparm->pQueue)[0].array_message);

/* call option 'R*' to remove queue entries */ xcomqparm->funccode[0] = 'R'; xcomqparm->funccode[1] = '*'; rc=XcomQAPI(xcomqparm); /* check for error message */ if (strlen((*xcomqparm->pQueue)[0].array_err_message)) printf("%s", (*xcomqparm->pQueue)[0].array_err_message); /* display detail information for removed queue entries */ for (i = 0; i < xcomqparm->nQueueEntries; i++) { printf("%s", (*xcomqparm->pQueue)[i].array_message); printf("%s", (*xcomqparm->pQueue)[i].array_message2); } if ((xcomqparm->nQueueEntries == 0) && strlen((*xcomqparm->pQueue)[0].array_message)) printf("%s", (*xcomqparm->pQueue)[0].array_message); if (!rc) printf("==== Call XcomQAPI successful !\n"); else printf("==== %s\n", msgstrng(rc, 0));

/* call option 'gxxxxxx' to display queue entry information */ memset(xcomqparm->lfile,0,sizeof(xcomqparm->lfile)); memset(xcomqparm->rfile,0,sizeof(xcomqparm->rfile)); memset(xcomqparm->file_option,0,sizeof(xcomqparm->file_option)); xcomqparm->funccode[0] = 'g'; strcpy(xcomqparm->tid, "000001"); rc=XcomQAPI(xcomqparm); /* check for error message */ if (strlen((*xcomqparm->pQueue)[0].array_err_message)) printf("%s", (*xcomqparm->pQueue)[0].array_err_message); /* display queue entry information */ if (strlen((*xcomqparm->pQueue)[0].array_message)) printf("%s", (*xcomqparm->pQueue)[0].array_message); if (strlen(xcomqparm->group_name)) printf("%s", xcomqparm->group_name);

The Application Programming Interface 4–45

API Examples

if (strlen(xcomqparm->lfile)) printf("%s", xcomqparm->lfile); if (strlen(xcomqparm->rfile)) printf("%s", xcomqparm->rfile); if (strlen(xcomqparm->user_name)) printf("%s", xcomqparm->user_name); if (strlen(xcomqparm->transfer_type)) printf("%s", xcomqparm->transfer_type); if (strlen(xcomqparm->file_type)) printf("%s", xcomqparm->file_type); if (strlen(xcomqparm->file_option)) printf("%s", xcomqparm->file_option);

/* call option 'pxxxxxx' to change value: FILE_OPTION LOCAL_FILE REMOTE_FILE note: This option only allow to be called when xcbp->state is in PREALLOCATION_STATE */ xcomqparm->funccode[0] = 'p'; strcpy(xcomqparm->tid, "000001"); strcpy(xcomqparm->file_option, "CREATE"); strcpy(xcomqparm->lfile, "c:\\user\\user\\test.txt"); strcpy(xcomqparm->rfile, "c:\\temp\\test.del"); rc=XcomQAPI(xcomqparm); /* check for error message */ if (strlen((*xcomqparm->pQueue)[0].array_err_message)) printf("%s", (*xcomqparm->pQueue)[0].array_err_message); /* print out queue entry information */ if (strlen((*xcomqparm->pQueue)[0].array_message)) printf("%s", (*xcomqparm->pQueue)[0].array_message);

printf("==== QAPI ended ===\n"); } } /* free memory */ if (xcomqparm->pQueue != NULL) free(xcomqparm->pQueue); if (xcomqparm != NULL) free(xcomqparm); }

4–46 User Guide

Chapter

5 Remote System Information

The following topics are covered for each platform, as appropriate:

■ Naming conventions

■ Types of files supported

■ Additional features

■ Restrictions

For more specific information about operating Unicenter CA-XCOM Data Transport on a specific platform, see the Unicenter CA-XCOM Data Transport guides for that platform and the manufacturer’s guides.

AS/400 Use the following format to specify an AS/400 file: libraryname/filename(membername)

Naming Conventions

The following table describes the parts of an AS/400 file name:

Part Description

libraryname The name of the library that holds the file.

filename The name of the file you wish to access. Periods are allowed within the file name.

membername The name of the member in the file. If this component is omitted, it defaults to the file name.

Remote System Information 5–1

AS/400

Types of Files Supported

In addition to the standard file type discussed above, the Save File format is also supported. When you wish to send such a file to an AS/400 from a z/OS system, the file must exist on the target system prior to your transmission.

Additional Features

XQUE is a Unicenter CA-XCOM Data Transport feature that allows the unattended transfer of reports from output queues to other Unicenter CA-XCOM Data Transport nodes.

XQUE can select specific classes of reports (based on the user, job name, form, and so forth) from output queues. XQUE also allows user and/or workstation groups to be equated to printer destinations on remote Unicenter CA-XCOM Data Transport nodes. You may use XQUE, for example, to get reports back to your host system that are generated on an AS/400 that you reach through IBM’s HCF facility, or between multiple AS/400s connected within a pass-through environment.

Configuration Issues

If you are configuring the VTAM LU that represents the AS/400 on a mainframe, make sure that the VTAM USS message 10 is not sent to that LU. IBM’s APPC software cannot start a session when this message, commonly called the welcome message, is sent.

To prevent this problem, the VTAM or NCP USSTAB definition must be set to a table that does not have a USSMSG10. The table that IBM originally provided with VTAM is a good alternative because it does not include message 10.

Case Sensitivity

Because the IBM AS/400 is case-sensitive, you must enter the user ID and password in uppercase.

5–2 User Guide

z/OS

z/OS Use the following format to name a z/OS file (data set): [level1.level2.level3...level7].level8[(membername)]

Naming Conventions

The following table describes the parts of a z/OS file name:

Part Description

level Required.

A file name can consist of multiple levels separated by a period. Each level has the following characteristics:

■ It can be up to eight uppercase characters long.

■ It starts with either an alphabetic character or a national character. For example, $, #, or @.

There is a limit of eight levels with a total of 44 characters, including the separating periods.

In most z/OS environments, a data set name is further restricted by security rules created by the installation. Contact the appropriate personnel within your organization for details. Typically, the high-level name (first-level name) must match your z/OS user ID or some other predefined index.

membername Required for z/OS partitioned data sets only.

Specifies the particular member in a z/OS partitioned data set (PDS). A PDS is a library containing members that are each separate sequential files. The member name is appended to the end of the file name in parentheses. Range: 1 to 8 alphanumeric or national characters.

Note: Most sites catalog all files through the system master catalog. In short, this means that the system will be able to locate the file you specify by name only. With the rare occurrence of an uncataloged file, you need to specify the volume and unit information for the device that holds the file.

Remote System Information 5–3

z/OS

Examples

The following are examples of valid z/OS data set names: SYS1.VTAMLST C54684.UTILITY.CNTL(JOBCARD) PROD.PAYROLL.SEPT90.TIMECARD.DATA TESTDATA A.$DDD.LOAD

Types of Files Supported

Sequential files are the most common forms of data transferred. Individual members of PDS files may also be sent as sequential files. Entire PDS libraries or multiple selected members may be transferred between two z/OS systems or between a Windows system and a z/OS system.

All three types of VSAM files (KSDS, ESDS, and RRDS) may be transferred between z/OS systems. These VSAM files must be pre-allocated, or they may be sent to non-z/OS systems as sequential files.

ISAM, BDAM (direct access), IMS, FDR, and DFDSS data sets are not directly supported, but they can be put into a sequential format using native utilities prior to transmission.

DCB Information

When creating a new file, z/OS file characteristics must be pre-defined. Collectively, the following characteristics are known as Data Control Block (DCB) parameters:

■ Blocksize

■ Logical record length

■ Record format

■ Volume

■ Unit

For more information about any of these fields, see an IBM JCL reference manual.

5–4 User Guide

Novell NetWare

Additional Features

You should be aware of the following additional features of Unicenter CA-XCOM Data Transport for z/OS:

■ CICS interface—Turn this on by indicating that you wish to notify CICS in the appropriate “remote system notify” field in your version of Unicenter CA-XCOM Data Transport. To do this, provide the VTAM APPLID of the CICS system in the related ID field. Your z/OS/CICS application development team can provide you with this. Invoking this interface should start a CICS transaction program following the successful completion of a transfer if one has been provided at the host.

■ Store-and-forward—Perform transfers between two nodes connected to an intermediate z/OS system by invoking the indirect transfer feature in your version of Unicenter CA-XCOM Data Transport. This asks you for the final destination LU name and sends a transfer in two stages. The first stage goes to the z/OS JES spool, where it waits for the final destination to be connected before the second stage occurs.

Novell NetWare Use the following format to name a NetWare file:

Note: Unicenter CA-XCOM Data Transport for LAN Workstation accesses files from any Novell file server in a NetWare network. [server\]volume:directory\subdirectory\...\filename

Naming Conventions

The following table describes the parts of a NetWare file name:

Part Description

server Name of the file server

volume: The highest level in a file server’s directory and file structure

Remote System Information 5–5

Novell NetWare

Part Description

directory\subdirectory One or more optional directories, which allow you to assign organization to the drive. Range: 1 to eight characters with an optional 3-character extension (like a file). If you specify a destination file name with a directory that does not exist, Unicenter CA-XCOM Data Transport for Windows creates the directory for you.

Note: If you do not specify a directory, the default (current) directory is used.

filename The name of the data file.

Types of Files Supported

Unicenter CA-XCOM Data Transport for NetWare LAN supports standard NetWare file types.

Destination Printer Information

When sending a report to a NetWare system, specify the Destination parameter value or the Destination Printer field in the following form: \\server name\printer queue name

Unicenter CA-XCOM Data Transport limits the length of this field as indicated below. The actual name on the destination system may be longer.

Type of transfer Specify

Direct transfers using Version 2 protocols. Up to 21 characters.

Indirect transfers or transfers using Version 1 protocols.

Up to 16 characters.

Restriction

Unicenter CA-XCOM Data Transport for NetWare LAN does not support library transfers to Novell NetWare systems.

5–6 User Guide

OpenVMS

OpenVMS Use the following format to name an OpenVMS Alpha file or an OpenVMS VAX file: device[directory]filename.type;version

The entire file specification can be a maximum of 255 characters. The file type can be a maximum of 31 characters.

Naming Conventions

The following table describes the parts of an OpenVMS file name:

Part Description

device A disk drive name. If the device is not specified, the default provided in the SYSUAF (as defined on the DEC system) for that user is used. Range: 1 to 15 characters.

Note: The Unicenter CA-XCOM Data Transport remote USERID field determines the SYSUAF USERID.

directory Directory and subdirectory information. If this information is not provided, defaults will be selected as described under “device” above.

Note: Unicenter CA-XCOM Data Transport accepts angle brackets (< >) in OpenVMS file names, which are converted to square brackets on the DEC computer.

Example:

PLAYERS1:<BRIDGE>CARD.DAT is treated as equivalent to: PLAYERS1:[BRIDGE]CARD.DAT

filename.type The specific file within the directory. OpenVMS null file names are used if the file name and type are not provided.

version The version of the file. The OpenVMS operating system can keep multiple versions of a file each time that file is saved. It is normal to omit this number to indicate that you want the most recent version of a file, the highest version number.

For more information about OpenVMS file specifications, see the OpenVMS documentation.

Remote System Information 5–7

OpenVMS

Restrictions

The following restrictions apply to Unicenter CA-XCOM Data Transport for OpenVMS Alpha and Unicenter CA-XCOM Data Transport for OpenVMS VAX:

■ Specifying transfer type—All transfers must be TYPE=SCHEDULE (for batch) or QUEUED (from ISPF).

■ Non-queued host transfers—Due to restrictions in the DEC SNA software, the z/OS TYPE=EXECUTE (non-queued) transfer feature fails with an 8003 sense code. It is not supported by Unicenter CA-XCOM Data Transport to an OpenVMS system.

■ Operating system—Unicenter CA-XCOM Data Transport currently supports the OpenVMS Alpha and OpenVMS VAX operating systems. The Unicenter CA-XCOM Data Transport guides frequently abbreviate the name of this operating system as “VAX.” This is not meant to imply support for UNIX.

■ Connectivity—The DECNET/SNA software is based on the Physical Unit 2.0 standard and not on the more flexible 2.1. This means that the system must be connected to a VTAM (PU 5) system in an SNA network. Unicenter CA-XCOM Data Transport uses the store-and-forward function (described previously as an additional z/OS, VM, and VSE feature) to transfer files with other Unicenter CA-XCOM Data Transport partners.

■ Multiple session configuration—Digital does not support parallel sessions with a z/OS system. However, if three file transfers are needed concurrently with an OpenVMS system, it does allow you to define three APPC logical units as a group. A group name can be from one to eight characters. The first character must be alphabetic, while the rest can be any combination of alphanumeric or national characters. Try to use mnemonic names. This feature is useful for assigning nicknames as well.

The following example calls three logical units, LUD1, LUD2, and LUD3, and assigns them a group name of LAVAX. Code the GROUP and LU parameters for this #PSOTAB entry as follows: GROUP=LAVAX, LU=(LUD1,LUD2,LUD3)

Type LAVAX as the remote system name to schedule transmissions to this VAX through the menu interface. When using the batch interface, use the GROUP parameter instead of the LU parameter. Use the following code: GROUP=LAVAX

Groups can be used with all the Unicenter CA-XCOM Data Transport interfaces, including the Process SYSOUT Interface.

5–8 User Guide

Stratus/System 88

■ Initiating the session bind request—Although separate VTAM LU names can be used for Unicenter CA-XCOM Data Transport sessions, you should not LOGAPPL these LUs to Unicenter CA-XCOM Data Transport when configuring on z/OS or VM. This will fail with an 0801 or 8003 sense code since the DEC software must initiate the session bind request.

■ Compression options—Pack options are not supported. Only COMPRESS=YES is supported for compression.

■ ASCII based—The OpenVMS platform is an ASCII based system.

Stratus/System 88 Use the following format to name Stratus files: #top_directory>group_directory>home_directory>filename.suffix

All names must be unique to that level.

Naming Conventions

The following table describes the parts of a Stratus file name:

Part Description

top_directory The physical disk(s). Range: 1 to 32 characters.

group_directory A group of user home directories. Range: 1 to 32 characters.

home_directory The user’s home directory. This directory resides in a group directory. Range: 1 to 32 characters.

filename Required.

The name of the Stratus file. Range: 1 to 32 characters.

suffix A file classification. You can have multiple suffixes at the end of a file name. Each suffix starts with a period. The following table describes some common Stratus suffixes:

File type Suffixes Examples

source .pl1, .cobol, .c

payroll.c, application.cobol

object .obj payroll.obj, application.obj

list .list payroll.list, application.list

error .error payroll.error, application.error

Remote System Information 5–9

Stratus/System 88

program module

.pm payroll.pm, application.pm

command macro

.cm start_up.cm, compile_and_bind.cm

backup .backup payroll.c.backup

Types of Files Supported

Stratus supports the following filetypes for remotely initiated transfers:

■ Fixed—This type of file contains records of the same size. Each record is stored in a disk or tape region holding a number of bytes that is the same for all the records in the file.

■ Sequential—This type of file contains records of varying sizes in a disk or tape region holding approximately the same number of bytes as the record (for example, the record storage regions vary from record to record). Records can only be accessed on a record-by-record basis.

Additional Features

The following are additional features of Unicenter CA-XCOM Data Transport for Stratus of which you should be aware:

■ Security option—Unicenter CA-XCOM Data Transport for Stratus can use its own account file to verify the user ID and password and to map the Unicenter CA-XCOM Data Transport user ID to a VOS user ID to check for file access. If this option is turned on and the remote user ID/password combination is invalid, Unicenter CA-XCOM Data Transport for Stratus rejects the request.

■ Restart/Recovery facility—Unicenter CA-XCOM Data Transport for Stratus can attempt periodic data transmissions after the initial file transfer has failed. A certain number of retries can be specified through the xcom_ser.pm file.

Restrictions

The following restrictions apply to Unicenter CA-XCOM Data Transport for Stratus:

■ No checkpoint/restart—Unicenter CA-XCOM Data Transport for Stratus Version 1 does not support checkpoint/restart.

■ No library transfers—Unicenter CA-XCOM Data Transport for Stratus does not support the transfer of libraries from z/OS.

5–10 User Guide

Tandem

Tandem Use the following format to name a Tandem file: \system.volume.subvolume.filename

All of these components are restricted to eight characters, except as indicated below.

Naming Conventions

The following table describes the parts of a Tandem file name:

Part Description

system The system name. Up to seven characters.

volume The disk name

subvolume Can be thought of as a directory name

filename The name of your file

Example

The following example uses a volume of $CLX12, a subvolume of SCI, and a file name of FILE1: $CLX12.SCI.FILE1

The Tandem file system is not a tree structure. Each volume.subvolume is independent, that is, it has no subvolumes above or below.

Types of Files Supported

Unicenter CA-XCOM Data Transport for Tandem supports the following file types through ENSCRIBE, Tandem’s disk file architecture:

■ Edit files

■ Unstructured files

■ Entry-sequenced files

■ Relative files

■ Key-sequenced files (for Replace only)

Remote System Information 5–11

Tandem

Unstructured files—Unstructured files are large-byte arrays. Data in these files is accessed by using the relative byte address and the READ-COUNT or WRITE-COUNT parameters in the system procedure calls. The application program determines the way in which they are used. An EDIT file is a type of unstructured file signified by the file code 101.

For more information about ENSCRIBE and unstructured files, see the ENSCRIBE Programmer’s Guide.

Structured files—Unicenter CA-XCOM Data Transport supports entry-sequenced and relative structured files.

■ Entry-sequenced files—Entry-sequenced files are sequential files. Records are stored in the order in which they are entered. These records are variable in length and cannot be added or deleted. They are accessed by their record address.

■ Relative files—Relative files are ordered by relative record number. The space allocated for each record is specified when the file is created. Records in these files can be deleted and added again in place.

■ Key-sequenced files—Key-sequenced files are supported only for the Replace operation. The file must already exist for Unicenter CA-XCOM Data Transport to perform an action on it.

File Type Specification

Locally Initiated Send Requests

When you send a file from the Tandem, the remote Unicenter CA-XCOM Data Transport determines the file type when it opens the file.

Receive Requests For locally or remotely initiated receive requests, the file type must be specified by the GUARDIAN_FILE_TYPE parameter. Use one of the following values:

■ EDIT

■ UNSTRUCTURED

■ ENTRY_SEQ

■ RELATIVE

5–12 User Guide

UNIX

Remotely-Initiated Send Requests

For remotely-initiated transfer requests (that is, send a file, job, or report), use the following:

Record Format Guardian File Type Created

F Relative

FB Entry Sequence

VB Edit

U Unstructured

Note: Key sequence files are supported only if the file exists. You can do a replace but not a create.

UNIX Use the following format to name a UNIX file: /directory/subdirectory/.../filename

Use up to 256 characters for the entire path of the file; there are no restrictions on size for the individual parts of the path.

Naming Conventions

The following table describes the parts of a UNIX path:

Part Description

/ (slash) The root directory when it is in the first position: otherwise, the slash separates directories and file names in the path.

directory The directory that contains the file. You can specify more than one directory in a path.

filename The name of the UNIX file.

Types of Files Supported

Unicenter CA-XCOM Data Transport for UNIX supports standard UNIX file types.

Remote System Information 5–13

VM

Restriction

Unicenter CA-XCOM Data Transport does not support library transfers to UNIX systems.

VM Use the following format to name VM files under the CMS operating system: filename.filetype

Naming Conventions

The two parts can be a maximum of eight characters in length. They can consist of letters, numbers, and/or national characters ($, #, @, +, -, :, _). In general, lowercase letters are not allowed. In the Unicenter CA-XCOM Data Transport for VM parameters FILE and LFILE, the file name and file type are specified as one string with a period as a separator.

For minidisk specifications:

■ CP OWNER is taken from the volume field, if present. Otherwise, the userid field is used.

■ CP address is taken from the unit specification. The default is 191.

Note: You may have two files with the same file name and file type, but they cannot reside on the same minidisk.

Types of Files Supported

The Unicenter CA-XCOM Data Transport Service Virtual Machine runs IBM’s GCS (Group Control System) operating system. Due to the limitations of this environment, Unicenter CA-XCOM Data Transport for VM only supports the CMS extended file system format. This covers CMS files on minidisks formatted with 512, 1,024K, 2,048K, and 4,096K block sizes.

Note: It does not support the following: CMS Shared File System, minidisks formatted with 800-byte blocks, or tape I/O.

5–14 User Guide

VM

DCB Information

CMS file characteristics must be predetermined when creating a new file. You must specify the following parameters:

■ Record format - This can be fixed (F) or variable (V).

■ Logical record length - This is the number of characters in the longest line of the file.

Restriction

The following table lists the maximum logical record lengths for different file types:

File type Maximum logical record length

Disk file 32767 bytes

Job (RDR file) 80 bytes

Report (PRT file) 133 bytes

Remote System Information 5–15

VSE

VSE When accessing a file on a VSE system, the Remote file name field indicates the file-id as it would be specified on the DLBL (an indicator of whether the file is VSAM or SAM) and, optionally, additional information needed for locating the file.

Format for VSAM file names

Use the following format to name a VSAM file:

file-id,V[,catalog-id]

VSAM Naming Conventions

The following table describes the parts of a VSAM file name:

Part Description

file-id The name given to the data set when it was defined using IDCAMS by including the following line in the JCL: DEFINE CLUSTER (NAME (file-id)...

V Indicates that this is a VSAM file.

catalog-id Optional.

The name of the user catalog that owns the VSAM data set as defined using IDCAMS by including the following line in the JCL:DEFINE USERCATALOG (NAME (catalog-id)...

Leave this field blank if the data set is owned by the master catalog.

5–16 User Guide

VSE

SAM Naming Conventions

Format for SAM file names

Use the following format to name a SAM file:

file-id,S,[unit],[location],[size],[override]

The following table describes the parts of a SAM file name:

Part Description

file-id The name that identifies this data set in the VTOC of the specific DASD volume. This is the file-id you specify on the DLBL JCL statement. Range: 1 to 44 characters.

Note: Do not enclose it in quotes.

S Indicates that this is a SAM file.

unit The physical device address as defined by the CUU parameter on the ASSGN JCL statement. It identifies the disk drive on which this file resides. This parameter can be omitted if the UNIT or VOL parameters are specified, or if a DASD manager is in use.

location Optional for output files.

The starting location of the file on the disk, as defined on the EXTENT JCL statement. If a DASD manager is in use, specify a value of 1.

size Optional for output files.

Indicates how much space this data set will use, as defined on the EXTENT JCL statement. For CKD devices, this is the number of tracks. For FBA devices, this is the number of blocks.

Remote System Information 5–17

VSE

Part Description

override Optional for output files.

Indicates whether this file should be processed as if the FLLTAB option for DASDM were coded as indicated by the override parameter. The override applies only to the processing for the file whose data set name is on the statement that the statement where the override appears. The following are the available override parameters and their equivalent DFLTAB option:

■ DMYES to force DASDM=YES for this file.

■ DMNO to force DASDM=NO for this file

■ DMEPIC to force DADSM=EPIC for this file.

Note: If you are running with a DASD manager, the DASD manager’s STRTTRK or Trigger value is placed in the location field. DASD manager pools should be indicated by putting the pool name in the Volume parameter.

For EPIC/VSE users, you may omit the following:

■ The location if you want EPIC to default to its STRTTRK value.

■ The size if you want EPIC to default to its DEFEXT value.

■ The Volume information if you want EPIC to default to its DEFPOL value.

For BrightStor CA-Dynam users who want to access Dynam catalog controlled files (included GDG data sets), no extent information should be entered. (No cuu, location, size, or override information and no Volume or Unit parameters for the files you are referencing.)

5–18 User Guide

VSE

TAPE Naming Conventions

Format for TAPE file names

Use the following format to name a TAPE file:

file-id,T,[unit],[unit],[unit],[override]

The following table describes the parts of a TAPE file name:

Part Description

file-id The name that identifies this data set in the tape manager catalog or in the HDR1 label on the tape. This is the file ID you specify on the TLBL JCL statement. Range: 1 to 44 characters.

Note: When the file ID contains imbedded spaces or commas, it should be enclosed in quotes.

Note: IBM only supports a 17-character file ID in a tape header label. If you have a tape manager, 44-character tape file IDs may be supported. Unicenter CA-XCOM Data Transport does not validate your file ID, but takes whatever you put on the statement and passes it along to IBM’s OPEN routine or to your tape manager as you have entered it.

T Indicates that this is a TAPE file.

Note: If you enter a transfer request from a platform that has not yet implemented the extended tape processing parameters or menu interface fields for controlling tape processing to a Unicenter CA-XCOM Data Transport/VSE server, you must use the T option. You are restricted to standard label tape processing.

unit The physical device address as defined by the CUU parameter on the ASSGN JCL statement. If you are using TAPEM=YES|EPIC, Unicenter CA-XCOM Data Transport ignores any units coded and the tape manager does the tape AVR and assignment. If you are not using the tape manager, the primary assignment is made to the first unit Unicenter CA-XCOM Data Transport finds. Other units found are assigned as temporary alternates.

This parameter can be omitted if you prefer to use the UNIT parameter to specify a unit or two units (primary and alternate). This parameter can be used in conjunction with the UNIT parameter to specify a primary unit and up to four alternate units that will be assigned by Unicenter CA-XCOM Data Transport prior to open. Units specified on the statement containing the file-id will be assigned before units specified on the UNIT parameter. Prior to Unicenter CA-XCOM Data Transport/VSE Version 2.3.0, the unit parameter is ignored because tape processing is supported only when you have a tape manager on your VSE system.

Remote System Information 5–19

VSE

DTF Information

VSE file characteristics must be predetermined when creating the files. If sending to or receiving from a VSE system you must specify the following:

■ The record format (RECFM), which can be either fixed (F), fixed blocked (FB), variable (V) or variable blocked (VB).

■ The logical record length (LRECL) indicates the number of characters in the longest record in the file.

■ The block size (BLKSIZE), which can be either equal to the LRECL for fixed files, a multiple of the LRECL for fixed blocked files, the LRECL +4 for variable files or the BLKSIZE +4 for variable blocked files.

Types of Files Supported

IBM VSE supports VSAM (RRDS, KSDS, and ESDS) and SAM files.

Restrictions

The following restrictions apply to Unicenter CA-XCOM Data Transport for VSE:

■ No FILEOPT=ADD for receiving VSE—Unicenter CA-XCOM Data Transport for VSE does not support FILEOPT=ADD if the VSE is receiving the file.

■ No Checkpoint/Restart for SAM—Unicenter CA-XCOM Data Transport for VSE does not support checkpoint/restart for SAM jobs.

5–20 User Guide

Windows

Windows Unicenter CA-XCOM Data Transport for Windows only supports the FAT file system. Use the following format to name Windows files: d:\[directory name]\..\filename.[ext]

Naming Conventions

The following table describes the parts of a Windows file name:

Part Description

d A particular device. The C drive is the most common local hard drive, the A drive is the most common floppy, and the F drive is the most common network drive. PCs support a facility in which a section of memory (RAM) can also be used as a virtual disk drive.

In high-speed link environments, the performance of Unicenter CA-XCOM Data Transport is directly related to the speed of the disk drive. In most environments, the fastest to the slowest devices are as follows:

■ RAM disks (D drive)

■ Directly connected hard disks (C drive)

■ Network disks (F drive)

■ Floppy disks (A or B drive)

Note: If you do not specify a drive, the default (current) drive is used. This directory in Windows changes, depending on the last application accessed.

directory name

One or more optional directories that allow you to assign organization to the drive. Range: 1 to eight characters with an optional 3-character extension (like a file). If you specify a destination file name with a directory that does not exist, Unicenter CA-XCOM Data Transport for Windows creates the directory for you.

Note: If you do not specify a directory, the default (current) directory is used.

filename Required.

The name of the data file. Range: 1 to 8 characters (characters past position eight generate an error).

Remote System Information 5–21

Windows NT Server/Professional

Part Description

ext The file extension used to further identify the file. Executable programs must use the extension .EXE or .COM. Range: 1 to 3 characters.

Note: If you do not specify an extension, Unicenter CA-XCOM Data Transport does not supply a default.

Restriction

The following restriction applies to Unicenter CA-XCOM Data Transport for Windows:

■ APPC restrictions—Due to the vast number of vendor APPCs and link types supported by Unicenter CA-XCOM Data Transport, consult the APPC vendor’s manual for restrictions on the services provided by that vendor. These restrictions may impact such features as z/OS TYPE=EXECUTE transfers, environments to which you can send, etc.

Windows NT Server/Professional Unicenter CA-XCOM Data Transport for Windows NT Server/Professional supports the standard Windows NT file names and the Universal Naming Convention (UNC). The file naming conventions for Windows NT are similar to those for Windows, with some significant differences, some of which are outlined below.

Use the following format to name files when using standard Windows file names: d:[\][directory name\..\]filename[.ext]

Use the following format to name files when using UNC file names: \\server name\share name\directory\filename

5–22 User Guide

Windows NT Server/Professional

Naming Conventions

The following table describes the parts of Windows file names and UNC file names:

Part Description

d Required.

A particular device, indicated as a drive letter.

directory name

Required.

One or more optional directories and subdirectories.

Subdirectories can take the form of name[.ext].

Note: The form of the directory name and file name depend on the operating system running on the server.

filename Required.

The name of the data file.

For FAT file systems, filename is 1 to 8 characters.

NTFS and HPFS file systems support long file names, up to 256 characters, including the extension.

Names may or may not be case sensitive, depending on the file system on the server.

For FAT, NTFS and HPFS, names are not case sensitive. You can use uppercase and lowercase when creating a name, and they will display as typed, but internally Windows makes no distinction for this. For example, Windows would consider MYFILE and MyFiLe as references to the same file.

Windows also creates an MS-DOS-style name based on the long name for compatibility with environments where long file names are not always supported.

ext The file extension used to further identify the file.

For FAT file systems, the extension is up to 3 characters.

For NTFS and HPFS, the extension is included in the long file name limit of 256 characters.

Note: If you do not specify an extension, Unicenter CA-XCOM Data Transport does not supply a default.

server name

The name of the server.

Remote System Information 5–23

Windows NT Server/Professional

Part Description

share name

The share name is network provider dependent.

For Microsoft Windows networks this is the name of the share.

For NetWare networks this is the name of the volume.

Types of Files Supported

Unicenter CA-XCOM Data Transport supports standard Windows file types.

Additional Features

Additional features include the following:

File Systems The standard Windows file systems are:

■ File Allocation Table format (FAT)

■ Windows NT File System format (NTFS)

■ High-performance File System format (HPFS)

File Access Unicenter CA-XCOM Data Transport accesses files locally or from any file server on the Microsoft Windows Network or the NetWare or Compatible Network, or any other network provider installed on the Windows system.

Security User IDs and passwords are case sensitive.

Home Directory A Windows user can have a default home directory assigned by the Windows administrator.

5–24 User Guide

Windows NT Server/Professional

Destination Printer Information

When sending a report to a Windows system, specify the Destination parameter value or the Destination Printer field in the following form: \\server name\printer queue name

Unicenter CA-XCOM Data Transport limits the length of this field as indicated below. The actual name on the destination system may be longer.

Type of transfer Specify

Direct transfers using Version 2 protocols. Up to 21 characters.

Indirect transfers or transfers using Version 1 protocols.

Up to 16 characters.

Restrictions

Access to directories and files on drives formatted for NTFS can be controlled with the security features of Windows.

Access to all files on a Windows system can be controlled by the permissions set on a directory or file. The access rights of the user ID on the remote system determine the actions permitted for the transfer. Users cannot use a directory or file unless they have been granted the appropriate permissions.

Remote System Information 5–25

Chapter

6 Performance Tuning

The following suggestions are listed in the order that will, in general, provide the best performance from Unicenter CA-XCOM Data Transport:

Suggestion Impact

Improve the Link Speed

For SNA/APPC. Throughput is dictated by the speed of the slowest link when using a gateway, bridge, or router. Faster links provide faster performance. The link with the best performance is the Token Ring (local Token Rings only—remote controllers are significantly slower), then Coax (locally connected), then SDLC (or any remote cluster controller). 3174-attached Token Rings normally produce higher throughput than 37xx Token Ring links.

Transfer Big Blocks Big blocks transfer much faster than small blocks. For client-initiated transfers, use BINARY mode rather than TEXT mode and specify a large value for maximum recordlength. Or you can use record packing by specifying CARRIAGE_FLAG=MPACK. When using the GUI, these values are set in the Encoding options on an Edit Transfer window. Select ASCII (Pack), BINARY, or EBCDIC (Pack).

Tune the SNA Request/response Unit

For SNA/APPC. The maximum RU size parameter of the configuration can have a significant bearing on productivity. On a typical packet-switched network, using an RU size of 256 should yield the best performance. For other network environments, a larger RU size will yield better performance when sending large amounts of data. To increase the RU size on a token ring link, increase the frame size to support the largest RU sent.

Note: The maximum RU size (and frame size for token ring environments) on the partner side must match the sizes specified on the local side. Otherwise, the value is negotiated downwards

Performance Tuning 6–1

Suggestion Impact

Tune the SNA Pacing Count

For SNA/APPC. The receive pacing count can also significantly influence Unicenter CA-XCOM Data Transport productivity. The setting of the pacing count value should closely correlate with the communication line quality. As a guiding rule, the better the line quality, the higher the pacing count should be.

Note: The pacing value on the partner side must match that on the local side. Otherwise, the value is negotiated downwards.

Enable/disable Compression

Data compression may provide the best throughput and line utilization. Unicenter CA-XCOM Data Transport compresses any group of four or more blanks or binary zeros and sends out a compressed data stream. The data compression feature should provide maximum savings when transmitting text files that usually have a large percentage of blank space. However, data compression also increases the CPU usage for each data transfer and may, in some cases, create additional overhead. The new zlibn compressions have been developed for maximum throughput with minimum overhead.

To decide whether the use of data compression may be helpful (especially for bulk data transmission), send a small sample of the data twice, once with data compression and once without. Check the Unicenter CA-XCOM Data Transport.LOG file (located in your Unicenter CA-XCOM Data Transport DataPath) for the character per second throughput.

Tune Checkpointing Checkpointing is the process where transfers that failed due to a communication failure can be restarted at the last checkpoint record. It is especially useful for large files, but it can slow down transmission speed dramatically.

For a maximum increase in the rate of transfer, turn checkpointing off completely by setting the Checkpoint Count to zero.

However, if you are transferring a large file, being able to restart from the last checkpoint may well justify a decrease in transfer rates. In this case, you can minimize the speed loss by choosing the highest checkpoint value appropriate for the size of your file.

6–2 User Guide

Appendix

A Unicenter CA-XCOM Data Transport Parameters

Use parameter values to control the variables that govern Unicenter CA-XCOM Data Transport’s behavior. The parameter values can be set through the Graphical User Interface, from the command prompt, in configuration files or in a script.

Unicenter CA-XCOM Data Transport Parameters A–1

Parameter Values Used in the GUI

Parameter Values Used in the GUI Parameter values can be defined to Unicenter CA-XCOM Data Transport when using the GUI as indicated in the following table. The values take precedence depending on where they are specified. The order in which parameter values take precedence is as follows:

Order Parameter Value Specified in

Explanation

1. Fields and options on-screen in the GUI and in an open configuration file

If the user specifies a value for a parameter on-screen through the GUI, this overrides every other specification in an open configuration file that has not been saved, and overrides any values in the program.

If a configuration file is open, the unchanged values specified in that file are used and they override the values in the XCOM.GLB file.

Note: When the configuration file is saved, the file is updated with the values that have been specified in the GUI.

2. XCOM.GLB If the value is specified in the XCOM.GLB file, it overrides the value in the program. The values specified in XCOM.GLB are system-wide defaults that are generally specified by the system administrator for use with Unicenter CA-XCOM Data Transport when it is started.

3. Program defaults If a value is not specified anywhere, the program has its own (hard-coded) defaults.

A–2 User Guide

Parameter Values Used at the Command Prompt

Parameter Values Used at the Command Prompt Parameter values can be defined to Unicenter CA-XCOM Data Transport from the command prompt or in a script as indicated in the following table. The values take precedence depending on where they are specified. The order in which parameter values take precedence is as follows:

Order Parameter Value Specified in

Explanation

1. Command prompt

If the user specifies a value for a parameter at the command prompt, this overrides every other specification in the configuration files or the program.

2. XCOM.CNF or FILENAME.CNF

If the value is specified in the XCOM.CNF file, or in a user-customized configuration file specified on the command line (for example, FILENAME.CNF) it overrides the value in the XCOM.GLB file.

3. XCOM.GLB If the value is specified in the XCOM.GLB file, it overrides the value in the program. The values specified in XCOM.GLB are system-wide defaults that are generally specified by the system administrator for use with Unicenter CA-XCOM Data Transport when it is started.

4. Program defaults If a value is not specified anywhere, the program has its own (hard-coded) defaults.

Parameter Format for Command Prompt and Scripts

When using the command prompt or a script, the Unicenter CA-XCOM Data Transport parameters consist of assignment statements. The format for assignment statements is as follows:

■ PARAMETER_NAME (Always all uppercase, with underscore character (_) when indicated.)

■ An equal sign (=)

■ A character string terminated by a newline

Note: Parameter values are always in uppercase. However, when specifying directories, file names, user IDs and passwords, you may use uppercase and lowercase.

Unicenter CA-XCOM Data Transport Parameters A–3

Parameter Values Used at the Command Prompt

Syntax

The syntax for assignment statements is as follows: PARAMETER_NAME=value

Example

In the following example, the parameter EXPIRATION_TIME is set to a value of 6000 seconds. EXPIRATION_TIME=6000

This controls the maximum time in seconds that a transaction is held in the transfer queue after execution.

Guidelines

Note the following guidelines for using Unicenter CA-XCOM Data Transport parameters:

■ When you type trailing spaces and tabs from the command prompt as part of a parameter value, they are stripped by the command prompt processor.

■ When you type trailing spaces and tabs into a file or script with an editor, using any editor that generates ASCII text, they are treated as part of a parameter value. In most cases these trailing spaces and tabs should be removed. If they are not removed they can cause confusion and/or undesirable results.

■ Empty lines and lines beginning with a pound sign (#) are discarded.

Examples

In the following examples, the spacespacespace represents trailing spaces.

If you type the following at the command prompt, the trailing spaces are ignored: XCOM62 -c1 LOCAL_FILE=XYZspacespacespace

If you type the following into any configuration file using an editor, the spacespacespace would be treated as part of the name of the LOCAL_FILE. LOCAL_FILE=XYZspacespacespace

A–4 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

List of Unicenter CA-XCOM Data Transport Parameters The following is a full list of parameters for Unicenter CA-XCOM Data Transport for Windows NT, with the range of values and defaults for each parameter. The default values listed here are based on the defaults as supplied in the sample files XCOM.GLB and XCOM.CNF that come with Unicenter CA-XCOM Data Transport. Any defaults not specified by these files come from the program’s own defaults.

Note: In this user guide we indicate C:\XCOMNT as the default path. Your installation may have Unicenter CA-XCOM Data Transport under a different path or on a different drive. If this default is changed during the installation of Unicenter CA-XCOM Data Transport, the default values in the XCOM.GLB file will reflect this change.

Version 2 Parameters

Some parameters are indicated as Version 2 parameters. This refers to Unicenter CA-XCOM Data Transport Version 2 protocols and Unicenter CA-XCOM Data Transport Version 1 protocols. If the partner Unicenter CA-XCOM Data Transport is Version 2, you can use either Version 1 or Version 2 protocols. If the partner Unicenter CA-XCOM Data Transport is Version 1, you cannot use Version 2 protocols. Version 1 protocols will ignore Version 2 protocols. Most Unicenter CA-XCOM Data Transport partners use Version 2.

AGE_TIME .

The number of seconds before waiting queue entries are removed from the queue. If the value is 0, the waiting queue entries never age and are never removed from the queue.

Range 0 to 86313600 (999 days)

Default 432000 (5 days)

Unicenter CA-XCOM Data Transport Parameters A–5

List of Unicenter CA-XCOM Data Transport Parameters

ALLOCATION_TYPE

Indicates the unit of storage allocation for a data set created on an IBM mainframe.

Range The range of values is listed in the following table.

Value Description

CYL Cylinders

TRK Tracks

BLK Blocks

Default None

Note: Version 2 parameter.

ATOE_FILENAME

The name of the file containing the ASCII-to-EBCDIC character conversion table.

This is a custom file used only for creating custom translation tables from ASCII to EBCDIC, if needed.

Range 0 to 256 characters

Default C:\XCOMNT\CONVTAB\ATOE.TAB

BLKSIZE

Specifies the block size of a data set created on an IBM mainframe.

Note: Used when FILE_OPTION=CREATE

Range 0 to 32767

If the format is Then the block size must be

Fixed or fixed block record A multiple of the record length

Variable record 4 bytes larger than the record length

Undefined record Larger than the largest record length

Default 800

A–6 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

CARRIAGE_CONTROL_CHARACTERS

Indicates the type of printer carriage-control codes, if any, that are included in the report file.

Note: For report transfers only.

Range The range of values is listed in the following table.

Value Description

ASA ASA control codes in column 1.

IBM IBM Machine Characters (valid only for IBM mainframes).

BYPASSASA If data is already in ASA format, bypass conversion.

OTHER No carriage-control codes are used.

Default OTHER

CARRIAGE_FLAG

Specifies the type of file being transferred and some special characteristics of the conversion done during the transfer.

Range The range of values is listed in the following table.

Value Description

YES Indicates that the transferred file is a text file and a newline character should be added to the end of incoming records. Also, newline characters are removed from the ends of lines before an outgoing record is sent.

When the TCP/IP protocol is specified, YES will be changed to XPACK automatically, if the value of MAXRECLEN is less than 31K. If the value of MAXRECLEN is greater than or equal to 31744, this value will not be changed automatically.

NO Indicates no special processing.

Unicenter CA-XCOM Data Transport Parameters A–7

List of Unicenter CA-XCOM Data Transport Parameters

Value Description

MPACK Indicates a text file with record packing. Uses 2K pack buffer.

When the TCP/IP protocol is specified, MPACK will be changed to XPACK automatically, if the value of MAXRECLEN is less than 31K. If the value of MAXRECLEN is greater than or equal to 31744, this value will not be changed automatically.

VLR Indicates a binary file of variable-length records with a field of 4 bytes preceding each record. Applies to local initiated transfers only.

XPACK Indicates a text file with record packing. Uses 31K pack buffer.

Note: MPACK does not support a MAXRECLEN (actual record length) over 2K. XPACK does not support a MAXRECLEN (actual record length) over 31K.

Default YES

CHECKPOINT_COUNT

Defines how often (based on record count) the sending system requests a checkpoint to be taken. The value 0 indicates no checkpointing.

Note: Setting the CHECKPOINT_COUNT affects performance. Each time a checkpoint is taken, the output buffers on the receiving system are written to the disk. On Token Ring, Ethernet, and other high-speed networks, the CHECKPOINT_COUNT should be set 0 or to the highest allowable value. The CHECKPOINT_COUNT should not be set for small files.

Range 0 to 9999

Default 1000

Note: Version 2 parameter.

A–8 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

CLASS

The print class assigned to a report transferred to a remote system.

If the remote system is an IBM mainframe, this field designates the JES SYSOUT class.

Note: For report transfers only.

Example Enter B to print the report through SYSOUT=B.

Range 1 character

Default None

CODE_FLAG

Used to identify the type of data being transferred.

Range The range of values is listed in the following table.

Value Description

ASCII An ASCII file is being transferred. This indicates that the incoming file is assumed to be ASCII format, and is not translated. Therefore the file on the remote system should be in ASCII format before it is transferred.

BINARY A binary file, such as an executable file, is being transferred. This indicates to a remote system that it is not to translate the data it is exchanging with your system.

EBCDIC An EBCDIC file is being transferred. The transferred data is translated from EBCDIC to ASCII format when the local system receives the data and from ASCII to EBCDIC format when the local system sends the data.

Default ASCII

Unicenter CA-XCOM Data Transport Parameters A–9

List of Unicenter CA-XCOM Data Transport Parameters

CODETABL

Specifies the 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. These custom character conversion tables determine which external translation tables will be used by the transfer.

This parameter is valid only if INTERNAL_CONVERSION_TABLES=NO.

Range 0 to 12 characters

Default None

COMPRESS

Indicates the compression type. When communicating with an IBM mainframe, if the data file contains any empty lines, COMPRESS must be set to YES.

Note: Not all compression types are supported on all platforms. For supported compression types, see the partner platform documentation.

Range The range of values is listed in the following table.

Value Description

COMPACT RJE compaction algorithm optimized for uppercase English text.

LCOMPACT RJE compaction algorithm optimized for lowercase English text.

LZLARGE Activates LZ compression to search back 32K in the data stream for a matching string.

LZMEDIUM Activates LZ compression to search back 16K in the data stream for a matching string.

LZRW3 General-purpose algorithm that runs fast and gives reasonable compression.

LZSMALL Activates LZ compression to search back 4K in the data stream for a matching string.

NO Indicates no compression.

RLE Run length encoding.

A–10 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

Value Description

YES Indicates run length encoding of binary zeros and blanks only.

ZLIB(n) Greater compression than LZRW3 but less than LZSMALL, LZMEDIUM, and LZLARGE. The optional n value can be 1 through 9.

Note: The LZ values enable LZ (Lempel-Ziv) compression to replace sequences of data bytes that occur more than once in a data stream with a code value.

Default YES

CONTROL

For multiple transfers. Use the syntax for performing a single transfer and then separate parameters for different transfers in the same configuration file by using this parameter.

Range NEWXFER or NONE

Default NEWXFER

CONVERT_CLASSES

A character string containing print classes for which EBCDIC to ASCII conversions will be performed. For incoming report transfers only.

Range 1 to 64 characters

Default None

COPIES

The number of copies that are to be sent. If this parameter is not specified, the remote system queues one copy of the report to the system’s default printer. For report transfers only.

Range 1 to 999

Default 1

Unicenter CA-XCOM Data Transport Parameters A–11

List of Unicenter CA-XCOM Data Transport Parameters

CREATE_DIRECTORIES

Indicates whether a non-existent directory should be created to accommodate incoming file transfers. CREATE_DIRECTORIES=YES causes the non-existent directory to be created.

Range YES or NO

Default YES

DAEMON_TIMEOUT

Specifies the number of minutes Unicenter CA-XCOM Data Transport will wait for a response from a partner before aborting a session. This ensures a transfer does not hang indefinitely waiting for a response.

DAEMON_TIMEOUT can be set in the xcom.glb file or from the Properties Dialog Pages of the GUI.

Range 10 to 1440

Default 60

DATACLAS

Specifies the 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.

Range 1 to 8 characters

Default None

DEBUG_FLAG

Indicates whether to print trace data to STDERR.

Range YES or NO

Default NO

A–12 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

DEN

Specifies the density to be used in creating a tape on the remote system.

Range 1 to 4—Valid values are the same as those for the DEN parameter in JCL.

Default None

DESTINATION

Identifies the printer or other device on the remote system where the report is to be sent. If this parameter is not specified, the remote system sends the report to the system's default printer. For report transfers only.

Range The range of values is listed in the following table.

Value Description

0 to 16 characters For indirect transfers and for Version 1.

0 to 21 characters For transfers that are not indirect and for Version 2.

Default None

DESTINATION_TYPE

The type of target system.

Range HOST, MIDRANGE, or OTHER

Default OTHER

Note: This parameter is saved in the .cnf file by the GUI. It is used by the GUI to determine what menus should be displayed and is not required for transfers.

Unicenter CA-XCOM Data Transport Parameters A–13

List of Unicenter CA-XCOM Data Transport Parameters

DISPOSITION

Indicates what the remote system does with the report file after the report has been printed. For report transfers only.

Note: This field is not used when the remote system is an IBM mainframe.

Range The range of values is listed in the following table.

If the value is Then after printing the report is

DELETE Deleted

KEEP Kept

HOLD Held

Default DELETE

DOMAIN

The Windows domain name for use in authenticating the user ID and password.

Range 1 to 15 characters

Default None

DSNTYPE

Specifies the data set definition.

Note: This parameter applies only to mainframe SMS data sets.

Value Description

LIBRARY Defines a PDSE

PDS Defines a partitioned data set

Note: These values are IBM standards for SMS processing.

Range 1 to 8 characters

Default None

A–14 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

EOL_CLASSES

A character string containing print classes for which an ASCII newline character will be appended to each record. For incoming report transfers only.

Range 1 to 64 characters

Default None

ETOA_FILENAME

The name of the file containing the EBCDIC-to-ASCII character conversion table.

This is a custom file used only for creating custom translation tables from EBCDIC to ASCII, if needed.

Range 1 to 256 characters

Default C:\XCOMNT\CONVTAB\ETOA.TAB

EXPDT

Specifies an expiration date for the tape data set in terms of a two-digit designation for the year and a three-digit designation for the day of the year. For example, in the expiration date 02021, 02 is the year (namely, 2002) and 021 is the 21st day of that year when the tape data set expires. For example, if 02021 is an expiration date, 2002 is the year and 021 is the 21st day of the year.

Range yyddd

Default None

EXPIRATION_TIME

The maximum time, in seconds, that a transaction is held in the transfer queue after it is executed. When the maximum time is reached, all references to the transaction are removed from the queue, including trace files and temporary files.

Note: If EXPIRATION_TIME is set to no value in XCOM.GLB, the program default of 6000 is used.

Range 0 to 32767

Default 6000

Unicenter CA-XCOM Data Transport Parameters A–15

List of Unicenter CA-XCOM Data Transport Parameters

FCB

Identifies the FCB JCL parameter when sending the report file to an IBM mainframe, defining print density, lines per page. For report transfers only.

Range 0 to 4 characters

Default None

FILE_ACCESS_PASSWORD

Password for access to local files.

Range 0 to 14 characters

Default None

FILE_ACCESS_USERNAME

Name of user accessing local files.

Range 0 to 20 characters

Default None

FILE_OPTION

Indicates how the transferred data is to be processed by the receiving system. For file transfers only.

Range The range of values is listed in the following table.

Value Description

CREATE Create a new file on the receiving system.

APPEND Append the transferred data to an existing file on the receiving system.

REPLACE Replace an existing file on the receiving system.

A–16 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

For library-type transfers, the range of values is as follows:

Value Description

CREATE Creates the PDS on the receiving system and adds the transferred members. If the PDS already exists, the transfer fails. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES , the transfer creates the directory and adds the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer fails.

ADD

APPEND

Adds or replaces transferred members on the receiving system. If the PDS does not exist, the transfer fails. The value of CREATE_DIRECTORIES also determines the outcome of the transfer on the remote system.

■ If CREATE_DIRECTORIES=YES and the directory does not exist then the directory is created and the transfer members are added to this directory. If the directory does exist, the transfer members are added to this existing directory.

■ If CREATE_DIRECTORIES=NO and the directory does not exist, then the transfer fails. If the directory does exist, then the transfer adds the transfer members to the directory.

REPLACE Adds or replaces transferred members. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES , the transfer creates the directory and adds the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer fails.

Note: The DirTree feature does not support SUSPEND and RESUME transfers using wildcards.

Default CREATE

Note: When creating a file on an IBM mainframe system, some additional information may be necessary. For more information, see the RECORD_FORMAT, BLKSIZE, VOLUME, and UNIT parameters.

Unicenter CA-XCOM Data Transport Parameters A–17

List of Unicenter CA-XCOM Data Transport Parameters

FILE_OPTION_RF

Indicates how the transferred data is to be processed by the receiving system (that is, the local system). Used when the transfer type is Retrieve File. If a value is not specified, then the value defaults to CREATE.

Range The range of values is listed in the following table.

Value Description

CREATE Create a new file on the receiving system.

APPEND Append the transferred data to an existing file on the receiving system.

REPLACE Replace an existing file on the receiving system.

For library-type transfers, the range of values is as follows:

Value Description

CREATE Creates the PDS on the receiving system and adds the transferred members. If the PDS already exists, the transfer fails. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES, the transfer creates the directory and adds the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer fails.

ADD

APPEND

Adds or replaces transferred members on the receiving system. If the PDS does not exist, the transfer fails. The value of CREATE_DIRECTORIES also determines the outcome of the transfer on the remote system.

■ If CREATE_DIRECTORIES=YES and the directory does not exist then the directory is created and the transfer members are added to this directory. If the directory does exist, the transfer members are added to this existing directory.

■ If CREATE_DIRECTORIES=NO and the directory does not exist, then the transfer fails. If the directory does exist, then the transfer adds the transfer members to the directory.

A–18 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

Value Description

REPLACE Adds or replaces transferred members. If the directory does not exist the reaction depends on the value of CREATE_DIRECTORIES in the global file:

■ If CREATE_DIRECTORIES=YES, the transfer creates the directory and adds the transferred members.

■ If CREATE_DIRECTORIES=NO, the transfer fails.

Note: The DirTree feature does not support SUSPEND and RESUME transfers using wildcards.

Default CREATE

FORM

The type of form that should be used to print the report. Since Unicenter CA-XCOM Data Transport places the print job in the remote system's print queue, the print control functions depend on the remote system. The user must verify beforehand that the requested form is available at the remote site. For report transfers only.

Note: When sending a report to a VAX computer, leave this parameter blank unless you are certain that this is a valid form type. VMS interprets this to mean that no special form is being requested.

Range 0 to 10 characters

Default None

HOLDFLAG

Indicates whether a transferred report file is to be placed on HOLD on the remote system or is to be printed immediately. For report transfers only.

Range YES or NO

Default NO

Unicenter CA-XCOM Data Transport Parameters A–19

List of Unicenter CA-XCOM Data Transport Parameters

IMPLICIT_PACKING

Indicates whether TCP/IP should always use packing.

Range YES or NO

Default YES

INTERNAL_CONVERSION_TABLES

Indicates whether internal or external conversion tables should be used for ASCII-to-EBCDIC conversion and EBCDIC-to-ASCII conversion. The external conversion files may be customized to meet your needs. For the appropriate directory and file name, see ATOE_FILENAME and ETOA_FILENAME.

Range The range of values is listed in the following table.

Value Description

YES Use internal conversion tables.

NO Use the external tables contained in ATOE_FILENAME and ETOA_FILENAME.

Default YES

LABEL

Indicates the type of label associated with a tape data set.

Range The following table lists the valid values for this parameter:

Value Definition

Processing type:

AL, AUL, BLP, LTM, NL, NSL, SL, SUL

Represent the types of processing to be applied to data sets on tape.

Note: Unicenter CA-XCOM Data Transport for z/OS supports only standard label tapes.

A–20 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

Example LABEL=BLP

The type of processing to be applied to this data set is BLP.

Default SL

LABELNUM

Indicates the sequence number of the data set on the tape.

Range The following table lists the valid values for this parameter:

Value Definition

sequence number (1-9999)

This value identifies the sequence number of a data set on tape.

Example LABELNUM=2

This specification refers to the second data set on the tape.

Default 1

LCLNTFYL

Specifies the local user notification level.

Range The range of values is listed in the following table:

Value Description

A or ALL NOTIFY on transfer completion.

W or WARN NOTIFY only if the transfer received a warning or error.

E or ERROR NOTIFY only if the transfer received an error.

Default ALL

Unicenter CA-XCOM Data Transport Parameters A–21

List of Unicenter CA-XCOM Data Transport Parameters

LOCAL_FILE

The name of the file on the local system that is being transferred. At the command prompt or in a script, if this variable is null or unset, standard input is read. In this manner, Unicenter CA-XCOM Data Transport commands can be used in a pipeline or with redirection. All Windows NT and UNC file naming conventions apply.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

LOCAL_FILE_RF

The file name that is created, appended, or replaced on the local system when it receives a file. At the command prompt or in a script, if this value is null or unset, then Unicenter CA-XCOM Data Transport writes to the standard output file. All Windows NT and UNC file naming conventions apply.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

LOCAL_FILE_SJ

Indicates the name of the file on the local system to be sent as a job. At the command prompt or in a script, if this variable is null or unset, Unicenter CA-XCOM Data Transport reads the standard input file. All Windows NT and UNC file naming conventions apply.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

A–22 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

LOCAL_FILE_SR

Local file name to be sent as a report to the remote system. At the command prompt or in a script, if this value is null or unset, Unicenter CA-XCOM Data Transport reads the standard input file. All Windows NT and UNC file naming conventions apply. For report transfers only.

Note: If QUEUE=YES, user must specify full path name.

Range 0 to 256 characters

Default None

LOCAL_NOTIFY

Specifies the user on the local system who is to be notified that Unicenter CA-XCOM Data Transport has completed a transfer. Unicenter CA-XCOM Data Transport uses the NOTIFYL parameter to determine the type of notification to use.

Range 0 to 64 characters

Default None

LRECL

Specifies the actual or maximum length, in bytes, of a logical record. Corresponds to the JCL LRECL subparameter.

Range 0 to 32767

If the format is Then the maximum length of a logical record must be equal to the

Variable blocked record

Maximum record length plus 4

Fixed or fixed block record

Constant record length

Default 160

Unicenter CA-XCOM Data Transport Parameters A–23

List of Unicenter CA-XCOM Data Transport Parameters

MAIL_USERNAME

If NOTIFYR is set to MAIL, specify a value here to use for your messaging system profile name.

Range 0 to 255 characters

Default xcom

MAX_QUEUE_ENTRIES

The maximum number of entries allowed in the transfer queue. Once the maximum number of queue entries is reached, subsequent transfer attempts are rejected by Unicenter CA-XCOM Data Transport.

Note: This value depends on the memory available when Unicenter CA-XCOM Data Transport is started.

Range 0 to n

The value of n is the maximum allowed memory segment divided by 512.

Default 50

MAX_SESSIONS_ENTRIES

The maximum number of partners that can be described in the XCOM.SES file.

Range 1 to 999

Default 50

A–24 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

MAXRECLEN

For Windows and UNIX systems, the locally initiating Unicenter CA-XCOM Data Transport system determines the values for MAXRECLEN, TRUNCATION, and LRECL, for send and receive operations. When the local Unicenter CA-XCOM Data Transport system initiates a transfer of a text file, this parameter designates the length, in bytes, of the largest record that can be transferred. If a record length is longer than this value, Unicenter CA-XCOM Data Transport uses the value in the TRUNCATION parameter on the initiating side to determine whether to terminate the transfer or to truncate the record and continue the transfer. When Unicenter CA-XCOM Data Transport transfers binary files, this value indicates the length of the records that are transferred. On a receive operation, MAXRECLEN is set to whatever the LRECL value is on the initiating side.

Range 1 to 32767

Default 1024

METACODE_CLASSES

Classes of print jobs that will be saved in metacode format, a variable length record format. For incoming report transfers only.

Range 0 to 64 characters

Default None

MGMTCLAS

Specifies the 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.

Range 1 to 8 characters

Default None

Unicenter CA-XCOM Data Transport Parameters A–25

List of Unicenter CA-XCOM Data Transport Parameters

NOTIFY_NAME

The user on the remote system who is to be notified when Unicenter CA-XCOM Data Transport completes a transfer.

Note: If the remote system is an IBM mainframe, Unicenter CA-XCOM Data Transport uses the value of NOTIFYR to determine the type of notification to deliver.

Range 0 to 12 characters

Default None

NOTIFYL

The local user notification flag.

Range The range of values is listed in the following table.

Value Description

ALL A message is displayed on the local Windows system console.

WRITE A message is displayed on the local Windows system console.

MAIL Send mail to the user.

NONE No notification is sent.

Default NONE

Notes: ■ The L in NOTIFYL indicates that the local system governs the processing of

the resulting notification on that system.

■ A MAIL message is sent to the specified user only if a MAPI-compliant provider is configured as a non-domain account and/or allows local accounts (such as the xcomd service and the local user ID) access to the Windows system (for example, Microsoft Mail boxes and address books on the local system).

■ Some Microsoft Outlook 2003 security updates may prevent mail notification from working.

A–26 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

NOTIFYR

Specifies the remote user notification type when sending data to a remote system.

Range The range of values is listed in the following table.

Value Description

MAIL A mail message is sent to the user.

WRITE A message is displayed on the screen.

ALL Notify all users.

TSO The specified TSO user is notified.

WTO Unicenter CA-XCOM Data Transport writes to the log only (WTO).

ROSCOE Notify the specified Advantage CA-Roscoe user.

CICS The specified CICS user is notified (not used for Version 1 type transfers).

LU The specified Logical Unit is notified (not used for Version 1 type transfers).

NONE No notification is sent.

Default NONE

Notes: ■ The R in NOTIFYR indicates that the local system governs the processing of

the resulting notification on that system.

■ A MAIL message is sent to the specified user only if a MAPI-compliant provider is configured as a non-domain account and/or allows local accounts (such as the xcomd service and the local user ID) access to the Windows system (for example, Microsoft Mail boxes and address books on the local system).

■ Some Microsoft Outlook 2003 security updates may prevent mail notification from working.

Unicenter CA-XCOM Data Transport Parameters A–27

List of Unicenter CA-XCOM Data Transport Parameters

NOTIFY_TERM

Specifies terminals to write if NOTIFYL=WRITE. If NOTIFY_TERM is not set, all users specified in LOCAL_NOTIFY will be notified at the first terminal where they are logged in as found in the system table.

Range 0 to 256 characters

Default None

NUMBER_OF_RETRIES

Indicates the maximum number of retries before a transfer is logged as failed. If the value is 0, the transfer will not be retried.

Range 0 to 255

Default 1

Note: Version 2 parameter.

NUM_OF_DIR_BLOCKS

Specifies the number of directory blocks to allocate for a data set created on an IBM mainframe.

Range 0 to 32767

Default 0

Note: Version 2 parameter.

PASSWORD

The password associated with the user ID on a remote system.

Range 0 to 31 characters

Default None

A–28 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

PORT

The number of the TCP/IP port on the remote Unicenter CA-XCOM Data Transport server. Used for TCP/IP transfers only.

Range 1 to 65535

Default 8044

PRIMARY_ALLOC

Identifies primary storage allocation for a data set created on an IBM mainframe.

Range 0 to 99999

Default 1

Note: Version 2 parameter.

PRIORITY

Indicates the priority that Unicenter CA-XCOM Data Transport uses for scheduling a transfer. If two transfers are scheduled for the same time, the one with the high priority is processed before one with a normal or low priority.

Range The range of values is listed in the following table.

Value Description

HIGH Set high priority.

NORMAL Set medium priority.

LOW Set low priority.

Default NORMAL

Unicenter CA-XCOM Data Transport Parameters A–29

List of Unicenter CA-XCOM Data Transport Parameters

PROTOCOL

The type of communication protocols to use.

Range The range of values is listed in the following table.

Value Description

SNA For transfers using SNA/APPC communication protocols

TCPIP For transfers using TCP/IP communication protocols

Default SNA

Note: If only the TCP/IP Component is installed with the base components of Unicenter CA-XCOM Data Transport, the default value is TCPIP.

QUEUE

Indicates whether to execute the transmission request immediately or to allow the request to be queued. If the user does not specify a .cnf file, and has not changed a .cnf file, the default value is “YES.”

Note: If NO is specified and the remote system is unavailable, the request aborts. If YES is specified, START_TIME and START_DATE are read.

Range The range of values is listed in the following table.

Value Description

YES The transfer request goes into a queue and executes depending on the traffic in the queue and START_DATE and START_TIME.

NO The transfer starts immediately.

Default YES

QUEUE_PATH

Directory containing the transfer queue data files.

Range 0 to 256 characters

Default C:\XCOMNT\Q

A–30 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

RECORD_FORMAT

Specifies the record format of a data set created on an IBM mainframe. This corresponds to the JCL RECFM subparameter. This field is unique to the Edit Transfer - Send File Window.

Range The range of values is listed in the following table.

Value Description Record Length Comment

F Fixed unblocked

The same length as the data set

FA Fixed unblocked ANSI

The same length as the data set

Contains ISO/ANSI/FIPS control characters.

FB Fixed blocked

Fixed Fixed record length with multiple records per block.

FBA Fixed blocked ANSI

Fixed Multiple records per block where these records contain ISO/ANSI/FIPS control characters.

FBS Fixed blocked spanned

Fixed Multiple records per block written as standard blocks.

FM Fixed unblocked machine

The same length as the data set

Contains machine code control characters.

FS Fixed unblocked spanned

The same length as the data set

Written as standard blocks where these records do not contain any truncated blocks or unfilled tracks.

U Undefined Undefined

V Variable unblocked

Variable

VA Variable unblocked ANSI

Variable Contains ISO/ANSI/FIPS control characters.

VB Variable blocked

Variable Multiple records per block.

VBA Variable blocked ANSI

Variable Multiple records per block where these records contain ISO/ANSI/FIPS control characters.

Unicenter CA-XCOM Data Transport Parameters A–31

List of Unicenter CA-XCOM Data Transport Parameters

Value Description Record Length Comment

VBM Variable blocked machine

Variable Multiple records per block where these records contain machine code control characters.

VBS Variable blocked spanned

Variable May have multiple records per block where these records can span more than one block.

VM Variable unblocked machine

Variable Contains machine code control characters.

VS Variable unblocked spanned

Variable A record can span more than one block.

Default VB

REMOTE_FILE

Indicates the file on the remote computer to which the transferred data is being written. If you are creating the file (FILE_OPTION=CREATE), the file name must be consistent with the file naming conventions of the remote system. If the receiving system is a Windows NT system and more than one file is included in the transfer, REMOTE_FILE must include a wildcard character (* ). The local Unicenter CA-XCOM Data Transport system does not validate this name. The remote I/O system determines whether the file name is valid.

Note: For send file transfers only.

Range 1 to 256 characters

Default None

REMOTE_FILE_RF

Indicates the name of the file to be retrieved from the remote system.

Note: For retrieve file transfers only

Range 1 to 256 characters

Default None

A–32 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

REMOTE_SYSTEM

The name of the remote system that receives a file, job or report.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

REMOTE_SYSTEM_RF

The name of the remote system that sends a file on a receive file operation.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

REMOTE_SYSTEM_SJ

The name of the remote system to which a job is sent.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

Unicenter CA-XCOM Data Transport Parameters A–33

List of Unicenter CA-XCOM Data Transport Parameters

REMOTE_SYSTEM_SR

The name of the remote system to which a report is sent.

For SNA/APPC protocols, the name is the symbolic destination name from the CPI-C side information record.

For TCP/IP protocols, the value can be the remote system’s IP address, host name, or domain name.

Range 1 to 256 characters

Default None

REMOVE_TRAIL_BLANKS

Indicates whether or not to remove the blanks at the end of each record when receiving a text file.

Range YES or NO

Default NO

REPORT_TITLE

Used by Unicenter CA-XCOM Data Transport on remote systems in the following ways:

System Uses the REPORT_TITLE

AS/400 To assume this to be the printer file name.

MVS To interpret a non-blank value in this field as specifying the generation of a separator (banner) page for this value.

VAX/VMS To print with the report.

UNIX To allow Unicenter CA-XCOM Data Transport to pass this field to the LP spooler as a title field.

Other systems As a descriptive comment only and does not print it as part of the report.

Range 0 to 21 alphanumeric or blank characters

Default None

A–34 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

RESTART_SUPPORTED

Specifies whether automatic restart is to be supported on a transfer.

Range YES or NO

Default YES

Note: Version 2 parameter.

RETPD

Specifies the number of days (1 to 9999) that the tape data set being created is to be retained.

Range 1 to 9999

Default None

Note: RETPD and EXPDT are mutually exclusive; specify one or the other.

RETRY_TIME

The number of seconds between retries of unsuccessful transfers. If the value is 0, the transfer is retried without delay.

Range 0 to 99999

Default 1

Note: Version 2 parameter.

Unicenter CA-XCOM Data Transport Parameters A–35

List of Unicenter CA-XCOM Data Transport Parameters

RMTNTFYL

Specifies the remote user notification level when sending data to a remote system.

Range The range of values is listed in the following table:

Value Description

A or ALL NOTIFY on transfer completion.

W or WARN NOTIFY only if the transfer received a warning or error.

E or ERROR NOTIFY only if the transfer received an error.

Default ALL

SECONDARY_ALLOC

Identifies secondary storage allocation for a data set created on an IBM mainframe.

Range 0 to 99999

Default 1

Note: Version 2 parameter.

SECURE_SOCKET

Specifies whether to use an OpenSSL socket or non-OpenSSL socket for transfers.

Range The range of values is listed in the following table:

Value Description

YES Performs secure transfer.

The transfer uses an OpenSSL socket and must to connect to a SSL listener on the remote partner.

NO Performs non-secure transfer.

The transfer uses a non-OpenSSL socket.

Default NO

A–36 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

SESSIONS_FILE

The path name of the XCOM.SES file. This file tells Unicenter CA-XCOM Data Transport the number of parallel sessions available for locally initiated transfers for each remote system.

Range 0 to 256 characters

Default C:\XCOMNT\CONFIG\XCOM.SES

SHELL_CMD

Name of the command that runs jobs, reports, notification scripts, and post processing scripts on the local system.

Range 1 to 256 characters

Default CMD.EXE /C

SOCK_DELAY

TCP/IP Socket option TCP_NODELAY. Refers to the Nagle algorithm for send coalescing. By default, small sends may be delayed. Should have no impact for normal Unicenter CA-XCOM Data Transport record sizes. Used for TCP/IP transfers only.

Note: Socket options affect the way Unicenter CA-XCOM Data Transport uses the TCP/IP stack implementation.

Range The range of values is listed in the following table.

Value Description

YES Small sends may be delayed. (Does not disable the Nagle algorithm.)

NO All sends are immediate. (Disables the Nagle algorithm.)

Default YES

Unicenter CA-XCOM Data Transport Parameters A–37

List of Unicenter CA-XCOM Data Transport Parameters

SOCK_RCV_BUF_SIZE

TCP/IP Socket option SO_RCVBUF. The buffer size for receives. Use zero for the default size provided by the socket implementation. The value for SOCK_RCV_BUF_SIZE can be smaller than the value for TXPI_BUF_SIZE. Used for TCP/IP transfers only.

Note: Socket options affect the way Unicenter CA-XCOM Data Transport uses the TCP/IP stack implementation.

Range 0 to 65536

Default 0

SOCK_SEND_BUF_SIZE

TCP/IP Socket option SO_SNDBUF. The buffer size for sends. Use zero for the default size provided by the socket implementation. The value for SOCK_SEND_BUF_SIZE can be smaller than the value for TXPI_BUF_SIZE. Used for TCP/IP transfers only.

Note: Socket options affect the way Unicenter CA-XCOM Data Transport uses the TCP/IP stack implementation.

Range 0 to 65536

Default 0

A–38 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

SPACE

The unit of storage allocation for the remote file.

Range Value Description

CYL Cylinders

TRK Tracks

BLK Blocks

Specify by

■ Primary allocation space for the remote file

■ Secondary allocation for the remote file

■ Directory blocks for the remote file

Default CYL

SPOOL_FLAG

Indicates whether the report is to be spooled to disk or printed immediately. For report transfers only.

Note: If the remote system is an IBM mainframe, this parameter has no effect on the transfer.

Range YES or NO

Default YES

START_DATE

Indicates the date on which the transfer becomes eligible for execution. The format is mm/dd/yy. If this field is blank, the current date is used.

Example A value of 02/21/03 indicates February 21, 2003 as the start date.

Range mm/dd/yy

Default None

Unicenter CA-XCOM Data Transport Parameters A–39

List of Unicenter CA-XCOM Data Transport Parameters

START_TIME

Indicates the time when the transfer becomes eligible for execution. The military format of hh:mm:ss is used. If this field is blank, then the current time is used.

Example A value of 14:00:00 indicates 2 p.m. as the start time.

Range hh:mm:ss

Default None

STAT_FREQUENCY

Indicates the frequency with which transfer statistics are made available to XCOMQM and the GUI. Intended for tuning high-speed links. Longer values help performance but byte/record counts in XCOMQM and the GUI may be slightly behind the actual counts.

Range 1 to 9999

Default 1

STORCLAS

Specifies the name of the storage class for a new SMS-managed data set.

Note: This parameter applies only to mainframe SMS data sets.

Range 1 to 8 characters

Default None

TAPE

Indicates to the remote system whether the volume is a tape volume or a disk file.

Range YES - Indicates a tape volume and that mounts are allowed when performing dynamic allocation.

NO - Indicates that the transfer is to a disk file.

Default NO

A–40 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

TCP_CMD

Path and name of the Unicenter CA-XCOM Data Transport program started by the XCOMD Unicenter CA-XCOM Scheduler service that is used for transfers that use TCP/IP protocols.

Range 0 to 256

Default C:\XCOMNT\XCOMTCP.EXE

TEMPDIR

Indicates the directory in which temporary files for jobs and reports can be created.

Range 1 to 256 characters

Default C:\XCOMNT\TMP

TP_CMD

Path and name of the Unicenter CA-XCOM Data Transport program started by the XCOMD Unicenter CA-XCOM Scheduler service that is used for transfers that use SNA/APPC protocols.

Range 0 to 256 characters

Default C:\XCOMNT\XCOMTP.EXE

Note: If only the TCP/IP Component is installed with the base components of Unicenter CA-XCOM Data Transport, there will be no default value.

TRACE_PATH

The directory containing the trace data files.

Range 0 to 256 characters

Default C:\XCOMNT\TRACE

Unicenter CA-XCOM Data Transport Parameters A–41

List of Unicenter CA-XCOM Data Transport Parameters

TRANSFER_ID

Allows the user to enter information to identify the file transfer request.

Note: This is equivalent to the IDENT field on UNIX and Linux.

Range 0 to 10 characters

Default None

TRANSFER_TYPE

Generated by the graphical user interface to specify the type of transfer to initiate.

Can also be used in a configuration file that has multiple transfers in it, to specify a different transfer type from the default value.

Range 1 to 4

Value Description

1 Send job

2 Send report

3 Send file

4 Receive file

Default 3

Note: The functionality of this parameter is similar to using the -cNUMBER command with XCOM62 or XCOMTCP at the command line. However, the values used to indicate the type of transfer are different.

TRANSFER_USR_DATA

An open field where a user can specify any text associated with the transfer.

Note: This is equivalent to the XFERDATA field on UNIX and Linux.

Range 0 to 10 characters

Default None

A–42 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

TRUNCATION

Indicates whether Unicenter CA-XCOM Data Transport truncates excess characters in the source file if the record exceeds the maximum record length as indicated by the MAXRECLEN parameter. If NO is selected, and the maximum record length is exceeded, Unicenter CA-XCOM Data Transport aborts the transfer. This parameter is ignored if CARRIAGE_FLAG=NO.

Note: Truncation is not applicable for BINARY data.

Range YES or NO

Default NO

TRUSTED

To allow the user to request a trusted transfer.

Range YES, NO, Y, or N

Default None

TXPI_BUF_SIZE

For TCP/IP transfers, the internal buffer size for sends and receives. The default size allows multiple Unicenter CA-XCOM Data Transport records to be received in a single socket call. With this default, if your Unicenter CA-XCOM Data Transport record size is less than 32K, Unicenter CA-XCOM Data Transport will attempt to receive multiple records in a single socket call. Used for TCP/IP transfers only.

Range 0 to 65536

Default 32768

Unicenter CA-XCOM Data Transport Parameters A–43

List of Unicenter CA-XCOM Data Transport Parameters

TXPI_RECEIVE_TIMEOUT

Indicates the maximum wait time, in seconds, after a TCP/IP failure is detected before a socket error is generated. This defaults to zero and should remain at zero unless it becomes necessary for a broken connection to generate a retryable error. Changing this parameter from zero invokes the TCP/IP function,"select", which adds a measure of connection detection, but sacrifices some performance. This parameter is for TCP/IP only.

Range 0 to 1200 seconds

Default 0 seconds

TXPI_SEND_CHECK_FREQ

Indicates the frequency that Unicenter CA-XCOM Data Transport checks to see if incoming error information is available when sending data. For example, if the value is 5, a check is made every fifth time that data is sent, to determine if data is available for receiving. Larger values give better performance. Smaller values minimize the sending of data after the partner reports an error. Used for TCP/IP transfers only.

Range 0 to 9999

Default 10

TXPI_TERM_TIMEOUT

Maximum wait time, in seconds, for partner to terminate TCP/IP communications. If a transfer terminates normally, both sides of the conversation coordinate the termination, and there should be no need to wait. This timeout will occur only during an error in the termination of the connection. Used for TCP/IP transfers only.

Range 0 to 999 seconds

Default 20 seconds

A–44 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

UNIT

Intended for specifying to a remote system (primarily an IBM mainframe) the unit that a data set is to be created on.

Range 0 to 6 characters

Default None

UNITCT

Specifies the number of units to be allocated on the remote system.

Range 1 to 20

Default None

UNIT_RF

Specifies the unit from which a data set is to be retrieved from an IBM mainframe.

Range 0 to 6 characters

Default None

USER_DATA

An open field where a user can specify any text associated with the transfer.

Note: This is equivalent to the SYSDATA field on UNIX and Linux.

Range 0 to 10 characters

Default None

USERID

The user ID which the security system on a remote system checks before granting access for the file transfer.

Range 0 to 12 characters

Default None

Unicenter CA-XCOM Data Transport Parameters A–45

List of Unicenter CA-XCOM Data Transport Parameters

VERSION

Indicates the version of the Unicenter CA-XCOM Data Transport protocol to be used for this transfer. For using TCP/IP, only a value of 2 is valid.

Range 1 or 2

Default 2

Note: Version 2 parameter.

VOLCT

Specifies the maximum number of volumes to be used in processing a multi-volume output tape data set on the remote system.

Range 1 to 255

Default None

VOLSQ

Specifies the sequence number of the first volume of a multi-volume remote data set to be used.

Range 1 to 255

Default None

VOLUME

Specifies the volume on which a data set is to be created on an IBM mainframe.

Range 1 to 6 characters

Default None

A–46 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

VOLUME_RF

Specifies the volume from which a data set is to be retrieved from an IBM mainframe.

Range 0 to 6 characters

Default None

WRITE_EOF

When receiving a text file, set to YES to have the end of file character (CTRL + Z) written at the end of the file.

Range YES or NO

Default NO

XBUFFSIZE

The size of Unicenter CA-XCOM Data Transport’s internal buffer.

Warning! Do not change this parameter unless you are instructed to do so by Unicenter CA-XCOM Data Transport Customer Support.

Range 1 to 32767

Default 32767

XCOM_CONFIG_SSL

Specifies the configssl.cnf file path and file name.

Range 1 to 256 characters

Default C:\XCOMNT\CONFIGSSL.CNF

XCOM_PASSWORD

The default password for remotely initiated transfers.

Range 0 to 128 characters

Default None

Unicenter CA-XCOM Data Transport Parameters A–47

List of Unicenter CA-XCOM Data Transport Parameters

XCOM_SHOW_CIPHER

Specifies whether to display encryption algorithms in the Unicenter CA-XCOM Data Transport queue detailed information, which is used for transfers.

Range The range of values is listed in the following table:

Value Description

NO Do not display encryption algorithms in the queue detail information.

YES Display encryption algorithms in the queue detail information.

Default NO

XCOM_USERID

The default user ID for remotely initiated transfers. If this value begins with a blank or is set to no value, Unicenter CA-XCOM Data Transport will not require remotely initiated transfers to specify a USERID. The transfer will run under the same security level as the XCOMD Unicenter CA-XCOM Scheduler service.

Range 0 to 32 characters

Default XCOM

XENDCMD

The name of the post processing command optionally invoked by the Unicenter CA-XCOM Data Transport transfer program after any type of transfer is finished, whether successful or not. Invoked after partner communications have ended. A sample file is provided in C:\XCOMNT\XCOMEND.BAT.

Range 0 to 256 characters

Default None

A–48 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

XIDEST

Specifies the name of the remote system on the intermediate destination that is designated for store-and-forward transfers. If this variable is null or unset, then a direct connection to a remote system is attempted.

Note: For store-and-forward transfers only.

Range 1 to 256 characters

Default None

XLOGFILE

The name of the file where Unicenter CA-XCOM Data Transport logs activity. If you do not specify this parameter, the systemwide log file C:\XCOMNT\XCOM.LOG is used. If you specify this parameter with a different file name, the logging information is only sent to the specified file.

Note: Specify the full path name if QUEUE=YES.

Range 0 to 256 characters

Default C:\XCOMNT\XCOM.LOG

XLPCMD

Name of the post-processing command used to send print jobs to the spooler. For incoming reports only.

Range 0 to 256 characters

Default C:\XCOMNT\XCOMLP.BAT

XLUNAME

Indicates the name of the local LU. This name must match the remote LU name on the remote system.

Range 1 to 17 characters

Default None

Note: Not used in Unicenter CA-XCOM Data Transport for RS/6000 SNA Services or RS/6000 SNA Server.

Unicenter CA-XCOM Data Transport Parameters A–49

List of Unicenter CA-XCOM Data Transport Parameters

XMODE

Indicates the mode name associated with the SNA/APPC configuration for the XLUNAME-Remote LU name pair. This name must match the mode name defined on the remote system.

Range 1 to 8 characters

Default XCOMMODE

XNODESPEC

Required for Brixton and SunLink APPCs. Indicates the name of the node that specifies the gateway to use for the transfer. Does not apply to other APPCs.

Range 1 to 64 characters

Default None

XNOTIFYCMD

Path name of the command that Unicenter CA-XCOM Data Transport will use to notify users on the local system of the completion of a transfer. This is normally a shell script that composes a message and invokes mail or write as appropriate.

Range 0 to 256 characters

Default C:\XCOMNT\XCOMNTFY.BAT

XPPCMD

The name of the command used for user-defined post-processing.

Range 0 to 256 characters

Default C:\XCOMNT\XCOMPP.BAT

A–50 User Guide

List of Unicenter CA-XCOM Data Transport Parameters

XPRECMD

Path name of the command used for user-defined pre-allocation processing, for locally and remotely initiated transfers. Specify this parameter in XCOM.GLB to invoke the pre-allocation exit xcompre.

Range 0 to 64 characters

Default None

XTRACE

Indicates the level of desired execution tracing.

Range The range of values is listed in the following table.

Value Definition

0 No tracing.

1-8 Levels of tracing from 1 (lowest) to 8 (highest).

9 Show the contents of the data buffers.

10 Includes levels 1 to 9, plus some additional detailed technical information.

Default 0

Unicenter CA-XCOM Data Transport Parameters A–51

Messages B–1

Appendix

B Messages

The Unicenter CA-XCOM for Windows NT messages contained in this section

are listed in ascending numerical order. These messages are written to a specified

log file on the local system (see the XLOGFILE parameter). Some messages are

also d isplayed on the user‟s terminal and sent to the remote system.

Error Message Example Messages with numbers ranging from 0 to 255 are informational or prompt

messages. Messages numbering between 100 and 255 represent CA-XCOM states

and are used in such things as traces. Message numbers of 256 and above are

error messages. The following is an example of a CA-XCOM message:

XCOMN0010I XCOM62 STARTING TRANSFER

Message ID Content

The first four characters of the message ID, XCOM, are constant. The CA -XCOM

system that generated the message is ind icated by the fifth character of the

message ID.

The system identifier convention of the fifth character is as follows:

Character Position

Explanation

1 to 4 The first through fourth characters are always the string XCOM.

5 The fifth character is used as follows:

Character Refers to the following system

C IBM or Microsoft PC-DOS, MS-DOS, and OS/ 2

D Digital Equipment Corp. VAX/ VMS, OpenVMS

Alpha, OpenVMS VAX, and Data General AOS/ VS

E IBM VSE

Error Message Example

B–2 User Guide

Character Position

Explanation

G Data General AOS/ VS

K IBM CICS

M IBM z/ OS

N Windows NT

R Netware

S IBM AS/ 400

T Tandem

U UNIX

V IBM VM

W Windows

8 Stratus Computer and IBM System/ 88

Note: Some of the system identifiers in this list represent systems

that are supported for existing customers but that are no longer

generally available. For a list of currently available Unicenter

CA-XCOM Data Transport platforms, see the Getting Started.

6 to 9 The sixth through ninth characters are used for the message

number, for example, 0001

10 The tenth character is used as follows

Character Indicates

I An informational message. No action is required on

the part of the user.

E An error message. Usually some action is necessary to

correct the problem or to determine the cause.

P A prompt requesting a response by the user.

W A warning message that some type of failure is

occurring which may or may not be fatal to what you

are doing.

List of Messages

Messages B–3

List of Messages The following pages list messages that CA-XCOM can return in response to job

requests, with reasons and recommended user actions, where appropriate. In the

list, the four-character constant (XCOM) and the component identifier (for

Windows NT, this is N), have been deleted from each message ID. The messages

are listed in numerical order.

0007I Major code: 0x00000000 Descriptive message

Reason:

This is a return code from the underlying system software. It is usually followed

by a message describing the meaning of the code.

Action:

Refer to the documentation for the SNA LU 6.2 or other system software.

0008I Minor code: 0x00000000 Descriptive message

Reason:

This is a return code from the underlying SNA APPC.

Action:

Refer to the documentation for the SNA LU 6.2 software.

0010I Starting XCOM Transfer on date_and_time

Reason:

This start of transfer message is issued when a locally initiated transfer is begun.

It is simultaneously placed in the transfer log.

Action:

None.

List of Messages

B–4 User Guide

0011I Transfer ended; 0 blocks (0 bytes) transmitted in 0 seconds (0 bytes/ second)

Reason:

This message marks the completion of a locally initiated transfer. It is placed in

the log and written to standard error at the end of a transfer.

Action:

None.

0016E Transfer started by a remote system.

Reason:

This message is issued when a transfer is started by a remote sys tem by allocating

the Unicenter CA-XCOM Data Transport transaction program.

Action:

None.

0017I Transfer expired and was removed from queue.

Reason:

The transfer has expired and has been removed from the queue.

Action:

None.

0022I Transfer suspended by user

Reason:

The transfer has been suspended by the user. This is an informational message

that is sent to the remote side of the conversation to inform the remote system

(and user) that the transfer has been suspended .

Action:

None.

List of Messages

Messages B–5

0023I Transfer resumed by RESUME command.

Reason:

The transfer has been resumed by a RESUME command issued from the screen

interface or by the use of the XCOMQM command.

Action:

None.

0024I Transfer scheduled for future execution.

Reason:

The transfer is placed in the XCOMD Unicen ter CA-XCOM Scheduler service's

queue.

Action:

None.

0025I Remotely initiated retry.

Reason:

The retry was initiated by the remote system.

Action:

None.

0026I Remotely initiated first try.

Reason:

The transfer was initiated by the remote system.

Action:

None.

List of Messages

B–6 User Guide

0027I Remotely initiated restart.

Reason:

The restart was initiated by the remote system.

Action:

None.

0028I Starting locally initiated transfer.

Reason:

The locally initiated transfer is starting.

Action:

None.

0029I Locally initiated transfer started.

Reason:

The locally initiated transfer has started .

Action:

None.

0030E Cannot process a TCPIP transfer from XCOM62.

Reason:

The XCOM62 command was specified with parameters QUEUE=NO and

PROTOCOL=TCPIP in effect.

Action:

Use the XCOMTCP command for transfers using TCP/ IP protocols.

List of Messages

Messages B–7

0031E Cannot process an SNA/ APPC transfer from XCOMTCP.

Reason:

The XCOM62 command was specified with parameters QUEUE=NO and

PROTOCOL=SNA in effect.

Action:

Use the XCOM62 command for transfers using SNA/ APPC protocols.

0032I RESUME command enabled transfer for remote restart.

Reason:

RESUME has been requested for a remote-initiated transfer. The transfer will

resume when resumed or automatically restarted from the remote Unicenter

CA-XCOM Data Transport partner.

Action:

None.

0046I CONFIRMED_CHECKPOINT

Reason:

Unicenter CA-XCOM Data Transport is confirming a checkpoint.

Action:

None.

0047I Local transfer restarted.

Reason:

The local transfer has restarted .

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

List of Messages

B–8 User Guide

0052I Transfer held.

Reason:

The transfer was held from starting at the time for which it was scheduled .

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0053I Transfer released.

Reason:

The transfer was released to start at the time for which it was scheduled .

Action:

None.

0075P Warning: XCOMD Unicenter CA-XCOM Scheduler service will abort. Data may be lost. Go ahead?

Reason:

This is a warning message allowing you one last chance before forcefully

bringing down the XCOMD Unicenter CA-XCOM Scheduler service.

Action:

Respond with y if you want to stop the XCOMD Unicenter CA -XCOM Scheduler

service. Any other reply will not stop the process.

0077I Aborting XCOMD Unicenter CA-XCOM Scheduler service; PID=0

Reason:

Unicenter CA-XCOM Scheduler service is being forced down.

Action:

None. The XCOMD Unicenter CA-XCOM Scheduler service will stop.

List of Messages

Messages B–9

0078P Please answer y(yes) or n(no).

Reason:

Please answer y(yes) or n(no).

Action:

Reply to the prompt with a y or an n.

0079I XCOMD Unicenter CA-XCOM Scheduler service: stop requested.

Reason:

A user has requested that the Unicenter CA-XCOM scheduler to stop gracefully.

Action:

None.

0080I XCOMD Unicenter CA-XCOM Scheduler service: stop request received.

Reason:

A user has requested that the XCOMD Unicenter CA-XCOM Scheduler service

stop, and that request has been received by the running XCOMD Unicenter

CA-XCOM Scheduler service process.

Action:

None.

0081I XCOMD Unicenter CA-XCOM Scheduler service: stop request rejected.

Reason:

The XCOMD Unicenter CA-XCOM Scheduler service has rejected a user's request

to stop. Unicenter CA-XCOM Scheduler service cannot be stopped while there

are started or active transfers in the queue.

Action:

Suspend all active transfers and retry the operation.

List of Messages

B–10 User Guide

0082I XCOMD Unicenter CA-XCOM Scheduler service: stop request accepted.

Reason:

The XCOMD Unicenter CA-XCOM Scheduler service has accepted a user's

request to stop.

Action:

None.

0085P Configuration cannot be read correctly. Defaults will be taken.

Reason:

Some parameters cannot be taken from the configuration file. This may be caused

by the following reasons:

The configuration file contains errors.

The read() system call returned an error.

Action:

Reply to the prompt. If you do not want defaults to be taken for parameters that

cannot be parsed , reply „cancel‟ and check your configurat ion file. Otherwise,

reply „ok‟.

0086P Configuration cannot be read correctly. No action will be taken.

Reason:

Some parameters cannot be taken from the configuration file. This may be caused

by the following reasons:

The configuration file contains errors.

The read() system call returned an error.

Action:

Reply „ok‟. If you do not want defaults to be taken for parameters that cannot be

parsed , check your configuration file and try to open it again.

List of Messages

Messages B–11

0087P Do you want to save changes?

Reason:

This warning message appears when you are about to loose some changes you

made to Unicenter CA-XCOM Data Transport parameters to give you the last

chance to save the changes in file.

Action:

Reply to the prompt.

0088I XCOMD Unicenter CA-XCOM Scheduler service started.

Reason:

The XCOMD Unicenter CA-XCOM Scheduler service has started .

Action:

None.

0089I XCOMD Unicenter CA-XCOM Scheduler service ended.

Reason:

The XCOMD Unicenter CA-XCOM Scheduler service has ended .

Action:

None.

0090I Problems starting xwait, Retrying...

Reason:

The Unicenter CA-XCOM Data Transport wait process is unable to start.

Action:

None.

List of Messages

B–12 User Guide

0091I xcomxped started.

Reason:

The Unicenter CA-XCOM Data Transport XPE interface has started .

Action:

None.

0092I xwait started.

Reason:

The Unicenter CA-XCOM Data Transport wait process has started .

Action:

None.

0100I XEXIT

Reason:

The Unicenter CA-XCOM Data Transport transaction program is about to exit.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0102I CLEANUP

Reason:

The state machine is about to enter CLEANUP state. In this state, the LU 6.2

conversation is deallocated .

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

Messages B–13

0103I TP_VALID

Reason:

The state machine is about to enter TP_VALID state. In this state, Unicenter

CA-XCOM Data Transport accepts incoming remote allocates if the

GET_ALLOCATE verb has been issued .

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0105I ALLOCATE_CONVERSATION

Reason:

The state machine is about to enter ALLOCATE_CONVERSATION state. It is

about to issue the allocate verb for the remote transaction program.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0106I GET_ALLOCATE

Reason:

The state machine is about to enter GET_ALLOCATE state. In this state,

incoming allocates are sought by the local transaction program.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

B–14 User Guide

0107I DEALLOCATE_CONVERSATION

Reason:

The state machine is about to enter DEALLOCATE_CONVERSATION state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0108I SEND_HEADER

Reason:

The state machine is about to enter SEND_HEADER state. In this state, a buffer is

allocated , the Unicenter CA-XCOM Data Transport header record is created from

the transfer parameters, and the header is sent.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0109I REQUEST_HEADER_CONFIRMATION

Reason:

The state machine is about to enter REQUEST_HEADER_CONFIRMATION state

where the incoming header is confirmed , and , if necessary, the connection is

turned around .

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

List of Messages

Messages B–15

0111I SEND_MAXLRECL

Reason:

The state machine is about to enter SEND_MAXLRECL state. Here, the state

machine will send the maximum logical record length as specified in the

configuration file.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0112I SENDING_DATA

Reason:

The state machine is about to enter SENDING_DATA state. Unicenter CA -XCOM

Data Transport sends one data record each time it enters this state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0113I DATA_CONFIRM

Reason:

The state machine is about to enter DATA_CONFIRM state. In this state, the

transaction program issues the confirm that is sent at the end of a data file.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

B–16 User Guide

0114I SEND_TRAILER

Reason:

The state machine is about to enter SEND_TRAILER state. The trailer record

containing the number of records is sent.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0115I TRAILER_CONFIRM

Reason:

The state machine is about to enter TRAILER_CONFIRM state. The Unicenter

CA-XCOM Data Transport transaction program is about to issue a deallocate

confirm verb for the conversation.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0116I RECEIVE_HEADER

Reason:

The state machine is about to enter RECEIVE_HEADER state. In this state,

Unicenter CA-XCOM Data Transport receives the incoming header.

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

List of Messages

Messages B–17

0117I CONFIRM_HEADER

Reason:

The state machine is about to enter CONFIRM_HEADER state. The Unicenter

CA-XCOM Data Transport transaction program is about to issue the confirmed

LU 6.2 verb.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0118I RECEIVE_MAXLRECL

Reason:

The state machine is about to enter RECEIVE_MAXLRECL state. The transaction

program receives the maximum record length record and uses it to initialize

system parameters.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0119I RECEIVE_DATA

Reason:

The state machine is about to enter RECEIVE_DATA state. In th is state, the data

records are received , decompressed , unpacked , and written to the target file.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

B–18 User Guide

0120I DATA_CONFIRMED

Reason:

The state machine is about to enter DATA_CONFIRMED state. It issues the

confirmed verb and closes the received file in preparation for receiving the trailer

record .

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0121I RECEIVE_TRAILER

Reason:

The state machine is about to enter RECEIVE_TRAILER state. A

receive_and_wait verb is issued for the incoming Unicenter CA -XCOM Data

Transport trailer record .

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

0122I TRAILER_CONFIRMED

Reason:

The state machine is about to enter TRAILER_CONFIRMED state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

Messages B–19

0123I PROCESS_DATA

Reason:

The state machine is about to enter PROCESS_DATA state. In this state, the

transaction program compares the record count actually received to the count

sent in the trailer record . If they don't match, the state machine enters an invalid

trailer state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0125I TERMINATE_INITIATE_CHECK

Reason:

The state machine is about to enter TERMINATE_INITIATE_CHECK stat e.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0127I TP_DONE

Reason:

The state machine is about to enter TP_DONE state.

Action:

None. This message is used to report the state of the Un icenter CA-XCOM Data

Transport transaction program.

0128I RECEIVE_FEATURE_RECORD

Reason:

The state machine is about to enter RECEIVE_FEATURE_RECORD state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

B–20 User Guide

0129I SEND_FILE_DESCRIPTOR

Reason:

The state machine is about to enter SEND_FILE_DESCRIPTOR state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0130I REQUEST_FEATURE_RECORD_CONFIRM

Reason:

The state machine is about to enter REQUEST_FEATURE_RECORD_CONFIRM

state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0131I CONFIRMED_FEATURE_RECORD

Reason:

The state machine is about to enter CONFIRMED_FEATURE_RECORD state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0152I LOCAL_SEND

Reason:

The state machine is about to enter LOCAL_SEND state. In this state, the

transaction program initializes several internal variables, logs the startup

message, and sets the userid for this transfer.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

Messages B–21

0153I LOCAL_RECEIVE

Reason:

The state machine is about to enter LOCAL_RECEIVE state. In this state, the

transaction program initializes several internal variables, logs the startup

message, and sets the userid for this transfer.

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

0154I REMOTE_SEND

Reason:

The state machine is about to enter REMOTE_SEND state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0155I REMOTE_RECEIVE

Reason:

The state machine is about to enter REMOTE_RECEIVE state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0156I OPEN_REMOTE_INPUT_FILE

Reason:

The state machine is about to enter OPEN_REMOTE_INPUT_FILE state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

B–22 User Guide

0157I OPEN_LOCAL_INPUT_FILE

Reason:

The state machine is about to enter OPEN_LOCAL_INPUT_FILE state. The local

input file is about to be opened .

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0158I OPEN_OUTPUT_FILE

Reason:

The state machine is about to enter OPEN_OUTPUT_FILE state. The output file is

about to be opened .

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0159I LOCAL_ATTACH

Reason:

The state machine is about to enter LOCAL_ATTACH state. In this state, the

transaction program tries to establish a connection to the local LU 6.2 SNA server.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

Messages B–23

0161I REMOTE_ATTACH

Reason:

The state machine is about to enter REMOTE_ATTACH state. In this state, the

invoked transaction program tries to establish a connection to the local LU 6.2

SNA server.

Action:

This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0162I SET_UP_OVERLAY

Reason:

The state machine is about to enter SET_UP_OVERLAY state. In this state, the

ind irect transfer header record is created .

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

0163I SEND_OVERLAY

Reason:

The state machine is about to enter SEND_OVERLAY state. In this state, it sends

the overlay record that is part of the ind irect transfer protocol.

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

List of Messages

B–24 User Guide

0164I RECEIVE_OVERLAY

Reason:

The state machine is about to enter RECEIVE_OVERLAY state. An ind irect

transfer has been requested by the remote side and the overlay record is abou t to

be received .

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0165I DO_SYSTEM

Reason:

The state machine is about to enter DO_SYSTEM state.

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

0167I SET_REMOTE_USER_ID

Reason:

The state machine is about to enter SET_REMOTE_USER_ID state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0168I DO_COMMAND

Reason:

The state machine is about to enter DO_COMMAND state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

Messages B–25

0169I SEND_FEATURE_RECORD

Reason:

The state machine is about to enter SEND_FEATURE_RECORD state.

Action:

None. This message is used to report the state of the CA-XCOM transaction

program.

0170I RECEIVE_FILE_DESCRIPTOR

Reason:

The state machine is about to enter RECEIVE_FILE_DESCRIPTOR state .

Action:

None. This message is used to report the state of the CA-XCOM transaction

program.

0171I RESTART_TRANSFER

Reason:

The state machine is about to enter RESTART_TRANSFER state.

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

0172I CHECKPOINT_CONFIRM_REQUEST

Reason:

The state machine is about to enter CHECKPOINT_CONFIRM_REQUEST state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

B–26 User Guide

0180I SENDING_ERROR

Reason:

The state machine is about to enter SENDING_ERROR state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0182I RECEIVE_ERROR

Reason:

An error message is being received from the remote partner. The Unicenter

CA-XCOM Data Transport transaction program issues a receive and wait verb to

retrieve the text.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0185I SEND_ERROR_MESSAGE

Reason:

The state machine is about to enter SEND_ERROR_MESSAGE state. A send error

verb has been issued and the text of the error encountered is sent.

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

0186I WAIT_FOR_REMOTE_DEALLOCATE

Reason:

The state machine is about to enter WAIT_FOR_REMOTE_DEALLOCATE state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

Messages B–27

0187I TRANSFER_FAILED

Reason:

The Unicenter CA-XCOM Data Transport transfer has failed .

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0188I CHECK_RETURN_CODES

Reason:

Unicenter CA-XCOM Data Transport is checking return codes at the end of a

transfer.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0200I LOCAL_NOTE

Reason:

The state machine is about to enter LOCAL_NOTE state. In this state, the

transaction program initializes several internal variables, logs the startup

message, and sets the userid for this transfer.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0201I REMOTE_NOTE

Reason:

The state machine is about to enter REMOTE_NOTE state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

B–28 User Guide

0202I LOCAL_NOTE_ATTACH

Reason:

The state machine is about to enter LOCAL_NOTE_ATTACH state. In this state,

the transaction program tries to establish a connection to the local LU 6.2 SNA

server.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0203I ALLOCATE_NOTE_CONVERSATION

Reason:

The state machine is about to enter ALLOCATE_NOTE_CONVERSATION state.

It is about to issue the allocate verb for the remote transaction program.

Action:

None. This message is used to report the state of the Unicenter CA-XCOM Data

Transport transaction program.

0204I SENDING_NOTE_DATA

Reason:

The state machine is about to enter SENDING_NOTE_DATA state. Unicenter

CA-XCOM Data Transport sends one Eponyms when it enters this state.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

List of Messages

Messages B–29

0205I DATA_NOTE_CONFIRM

Reason:

The state machine is about to enter DATA_NOTE_CONFIRM state. In this state,

the transaction program issues the confirm that is sent at the end of an

SDSNOTE.

Action:

None. This message is used to report the state of the Unicenter CA -XCOM Data

Transport transaction program.

0211I queue entry (TID=000000) removed.

Reason:

Queue entry was removed from the queue.

Action:

None. This message is used to report the status of the transfer.

0212I transfer (TID=000000) suspended.

Reason:

Transfer was suspended .

Action:

None. This message is used to report the status of the transfer.

0213I transfer (TID=000000) terminated.

Reason:

Transfer was terminated .

Action:

None. This message is used to report the status of the transfer.

List of Messages

B–30 User Guide

0214I transfer (TID=000000) resumed.

Reason:

Transfer was resumed.

Action:

None. This message is used to report the status of the transfer.

0215I transfer (TID=000000) held.

Reason:

Transfer was held .

Action:

None. This message is used to report the status of the transfer.

0216I transfer (TID=000000) released.

Reason:

Transfer was released .

Action:

None. This message is used to report the status of the transfer.

0283E Error allocating send buffer

Reason:

An error was encountered when trying to increase the send buffer size using

realloc() call.

Action:

Retry the transfer. This error may be caused by memory fragmentation.

List of Messages

Messages B–31

0284E Error forking: Error 0

Reason:

Cannot create an add itional process. Either the user or system process limit has

been reached .

Action:

Check your system and user process limits. Your system administrator may be

able to supply you with this information and / or raise these limits.

0286E Error setting local user id

Reason:

An error occurred in setting the local user ID. The call to setuid failed .

Action:

Be sure that the local Unicenter CA-XCOM Data Transport transaction program

is either owned by the invoking user or is running setuid root.

0287E Error setting remote user id

Reason:

An error was encountered while trying to set the remote user ID.

Action:

Check that the remotely requested user ID is valid on your system, that the

remote initiator has correctly entered it and the password for it, and that the user

ID has "logon locally" authority.

List of Messages

B–32 User Guide

0288E System function failed

Reason:

A call to system( ) has failed . This function is used to initiate command functions

from within Unicenter CA-XCOM Data Transport.

If “wait timed out” is specified after the error message text, this ind icates that the

transferred job d id not complete before the DAEMON_TIMEOUT period

expired .

Action:

Retry the transfer. This message may ind icate the failure of a system call in a

send job or in a pre or post processing script. If the problem persists, take a trace

and contact Computer Associates Customer Support.

If “wait timed out” is specified , it may be necessary to increase the XCOM.GLB

parameter, DAEMON_TIMEOUT.

0289E Command failed, RC=0

Reason:

A command issued using the system() call has returned a non-zero completion

code.

Action:

Retry the transfer. If the problem persists, contact Computer Associates Customer

Support.

0291E Send of indirect transfer record failed: Descriptive message

Reason:

An error has occurred w hile attempting to send the overlay record for an ind irect

file transfer.

Action:

Check the SNA connectivity and retry. If the problem persists, contact Computer

Associates Customer Support.

List of Messages

Messages B–33

0292E Error sending error message to remote system: Descriptive message

Reason:

An error was encountered while send ing an error message to the remote system.

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0293E Preallocation User Exit failed, RC=n

Reason:

The system() command issued to process the preallocation user exit has returned

non-zero RC=n.

Action:

Investigate the failure of the xcompre.bat exit by doing one of the following:

Running it outside <xcom> under the same user ID as the one used for the

transfer

Setting "echo on" in xcompre.bat and "Allow service to interact with desktop"

in the <xcom> service xcomdsrv

0296E Error deallocating conversation: Descriptive message

Reason:

An error was detected while deallocating a send conversation. This deallocate

occurred after send ing a file.

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

List of Messages

B–34 User Guide

0297E Error requesting header confirmation: Descriptive message

Reason:

The remote Unicenter CA-XCOM Data Transport transaction program d id not

confirm the transfer request header that it received .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0298E Unable to allocate remote transaction program: Descriptive message

Reason:

The APPC interface returned an error after an attempt was made to allocate a

Unicenter CA-XCOM Data Transport transaction program on a remote LU.

Action:

Check that the remote transaction program can be allocated . On z/ OS, this means

that the APPL is active. On other systems, there are d ifferent criteria for

accessibility.

0299E Cannot attach to LU 6.2 facility on local initiate: Descriptive message

Reason:

An error was detected when a locally initiated transfer request attempted to

attach to the APPC manager process.

Action:

Check the SNA status as well as your connection status. Check the

REMOTE_SYSTEM parameter to make sure that it contains the name of the

connection profile that you want to use for this transfer.

List of Messages

Messages B–35

0300E Cannot attach to LU 6.2 facility on remote allocate: Descriptive message

Reason:

An error was detected when a remotely initiated transfer request transaction

program attempted to attach to the APPC manager process.

Action:

Check the SNA configuration and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0302E Unable to open local input file: No such file or directory. Descriptive message

Reason:

A problem was encountered while trying to open a Unicenter CA -XCOM Data

Transport input file; the data following the explanation is the sense.

Action:

Check the existence and permissions on the file you have specified .

0303E Send of XCOM header failed: Descriptive message

Reason:

An error has occurred while attempting to send a transfer header record .

Action:

Check the SNA connectivity and retry. If the problem persists, contact Computer

Associates Customer Support.

0304E Send of Maximum Record Length failed: Descriptive message

Reason:

An error has occurred while attempting to send the maximum logical record

length as part of the file transfer setup procedure.

Action:

Check the SNA connectivity and retry. If the problem persists, contact Computer

Associates Customer Support.

List of Messages

B–36 User Guide

0305E Receive of incoming header failed: Descriptive message

Reason:

An error was detected while attempting to receive a transfer request header from

a remote system.

Action:

Check the SNA connectivity and retry. If the problem persists, contact Computer

Associates Customer Support.

0309E Error reading local input file: Error 0

Reason:

An error occurred while read ing the input file. The system call read() r eturned

-1. The error number d isplayed is the value of the system variable errno.

Action:

Check the sense code on the message, fix the problem, and retry the transfer.

0310I Received error from remote system.

Reason:

An error has been received from the remote system and has been placed in the

log.

Action:

Check the error received from the remote system and fix the problem detailed

there. Error messages from partner Unicenter CA-XCOM Data Transport systems

can be found in the manuals for those platforms.

List of Messages

Messages B–37

0311E Send of user data record failed: Descriptive message

Reason:

An error was returned from the APPC interface while attempting to send data to

a remote system.

Action:

Check the SNA connectivity and retry. If the problem persists, contact Computer

Associates Customer Support.

0312E Confirm to last data record failed: Descriptive message

Reason:

The APPC interface has returned an error when attempting to issue a confirm

following the last data record in a transfer.

Action:

Check the SNA connectivity and retry. If the problem persists, contact Computer

Associates Customer Support.

0313E Negative response to data confirm request: Descriptive message

Reason:

Negative response to data confirm request.

Action:

Contact Computer Associates Customer Support.

0314E Send of trailer record failed: Descriptive message

Reason:

The send of trailer record failed . An error was returned by the SNA subsystem

after the Unicenter CA-XCOM Data Transport trailer was sent.

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

List of Messages

B–38 User Guide

0315E Trailer record not confirmed

Reason:

The trailer record was not confirmed . The remote side has detected an error in

the Unicenter CA-XCOM Data Transport trailer, either in its format or in the

number of records transferred .

Action:

This error may be the result of a send text file which contains zero -length records.

If this is the case, try to send the file with the compression turned on.

0319E Error confirming checkpoint: Descriptive message

Reason:

There is an error in confirming the checkpoint.

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0320E Error issuing confirmed for checkpoint: Descriptive message

Reason:

There is an error issuing confirmed for the checkpoint.

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0321E Error requesting trailer confirmation: Descriptive message

Reason:

An error was encountered when requesting trailer confirmation.

Action:

Check the SNA connectivity and retry. If the problem persists, contact Computer

Associates Customer Support.

List of Messages

Messages B–39

0322E Cannot open output file: xxxxxxxx

Reason:

Refer to xxxxxxxx, which may be a Unicenter CA-XCOM Data Transport message

or a Windows message. This error usually involves path error specifications, or

security authorizations of FILE_ACCESS user name or password .

Action:

Check if your target file name is correctly specified . If so, check the user ID and

password for proper authorization.

0403E Cannot open output file: Error 0

Reason:

Cannot open the output file using the requested action.

Action:

Check the sense code on the message, fix the problem, and retry the transfer.

0404E Error confirming header: Descriptive message

Reason:

An error was encountered when attempting to issue a confirmed response to an

incoming header.

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

List of Messages

B–40 User Guide

0405E Error receiving maxreclen: Descriptive message

Reason:

An error was encountered when trying to read an incoming maximum record

length record or when trying to realloc() a read buffer of the size specified in th e

record received .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0406E Error while trying to read Feature Negotiation Record: Descriptive message

Reason:

An error was encountered while trying to read a feature negotiation record .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0407E Error compress flag in feature negotiation protocol

Reason:

Compression type provided by the remote system is not supported .

Action:

Check Unicenter CA-XCOM Data Transport configuration file on the remote

system and retry.

0408E Error encountered in feature negotiation protocol

Reason:

An error was encountered in feature negotiation protocol.

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

List of Messages

Messages B–41

0409E Error encountered trying to confirm feature negotiation record: Descriptive message

Reason:

An error was encountered in trying to confirm a feature negotiation record .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0410E Error sending feature negotiation record: Descriptive message

Reason:

An error occurred in sending a feature negotiation record .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0411E Error while confirming feature negotiation record: Descriptive message

Reason:

An error occurred while confirming a feature negotiation record .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0412E Error receiving data: Descriptive message

Reason:

An error was detected by the APPC receive and wait verb while read ing

incoming data.

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

List of Messages

B–42 User Guide

0413E Trailer invalid

Reason:

The count in the received trailer record d id not match the actual number of

records received .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0415E Error receiving trailer: Descriptive message

Reason:

The receive and wait issued for an incoming trailer record has failed .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0416E Error writing output file: Error 0

Reason:

The write() system call has returned a -1. This probably means that the file

system is out of space.

Action:

Check the free space in the file system. Repair the problem and retry the transfer.

0418E Transmission interrupted: signal received

Reason:

An interrupt signal has been received and transmission has been interrupted .

Action:

Retry the transfer. If the problem persists, contact Computer Associates Customer

Support.

List of Messages

Messages B–43

0422E Login incorrect.

Reason:

User ID and/ or password do not match security database.

Action:

Provide correct user ID and/ or password .

0423I Error receiving file descriptor record.

Reason:

An error occurred while trying to receive a file descriptor record .

Action:

Check the SNA connectivity and retry the transfer. If the problem persists,

contact Computer Associates Customer Support.

0424E Attempting to create an existing file

Reason:

You cannot create an existing file.

Action:

Decide whether you want to replace the target file or create one using a d ifferent

name. Set the parameters appropriately and retry the transfer.

0425E Cannot seek to position on restart

Reason:

When trying to reposition a file to restart a transfer, the fseek() call returned a -1.

This usually ind icates a file that has been updated since its transfer was

interrupted .

Action:

Determine why the file was updated and / or retry the transfer.

List of Messages

B–44 User Guide

0426E Restarting from beginning of file

Reason:

Neither alpha nor beta counts match.

Action:

None. The transfer will restart from the beginning of the file.

0427E Error starting TP: no retry possible

Reason:

A call to execl() subroutine returned a non -zero return code; the data following

the explanation is the sense.

Action:

Check if the file specified in TP_CMD parameter in your XCOM.GLB file exists

and has execute permission.

0435I Waiting for an available session.

Reason:

Unicenter CA-XCOM Data Transport is waiting for available sessions to start a

transfer.

Action:

Wait until a session becomes available or increase the session limits in the

XCOM.SES file, restart XCOMD Unicenter CA-XCOM Scheduler service, and

retry the transfer.

0436E TP ended abnormally.

Reason:

The XCOMD Unicenter CA-XCOM Scheduler service has detected a transaction

program failure.

Action:

Retry the transfer. If the p roblem persists, contact Computer Associates Customer

Support.

List of Messages

Messages B–45

0437E Record larger than input buffer.

Reason:

The length of a file record is greater than the length of the input buffer.

Action:

Adjust the size of the buffer and retry.

0438E Record length greater than maxreclen, but truncation not allowed.

Reason:

The length of the received record is greater than maxreclen, but truncation is not

allowed .

Action:

Adjust the size of the buffer and retry.

0440E Internal buffer < maxreclen received.

Reason:

The internal buffer is smaller than the maxreclen received .

Action:

Adjust the size of the buffer and retry.

0441E Remote restart request does not match any queue entry.

Reason:

A remote-initiated transfer is attempting to restart from a checkpoint, but no

matching transfer was found in the local queue. The original transfer may not

have ended before the restart was attempted .

Action:

Restart a new transfer from the remote partner. Increase the value for

RETRY_TIME on the remote partner.

List of Messages

B–46 User Guide

0442E Remote restart request matches suspended queue entry.

Reason:

A remotely-initiated transfer was suspended and cannot be restarted .

Action:

Resume the transfer so that it is enabled for restart. The next restart attempt will

not fail with this error.

0443E Record exceeds maxreclen following compression.

Reason:

A compressed record is larger than permitted by MAXRECLEN.

Action:

Increase the MACRECLEN value.

0448E Type of record packing not supported.

Reason:

An unsupported type of record packing was specified in the header.

Action:

Check that the remote system is generating a packing type that corresponds to an

XCOM-supported packing type: YES, NO or MPACK. For AT&T or NCR

systems, the value of the mode definition code set field must be set to A for

ASCII.

0454E Invalid starting date format.

Reason:

The transfer was not scheduled because the starting date cannot be parsed .

Action:

Repair the date format and retry the transfer.

List of Messages

Messages B–47

0455E Invalid starting time format.

Reason:

The transfer was not scheduled because the starting time cannot be parsed .

Action:

Repair the time format and retry the transfer.

0456E Cannot open EBCDIC-ASCII translation file.

Reason:

Internal conversion is set to NO but the specified EBCDIC-ASCII translation file

cannot be opened .

Action:

Check that the EBCDIC to ASCII conversion table file specified in the Unicenter

CA-XCOM Data Transport configuration file variable ETOA_FILENAME exists

and is readable.

0457E Cannot open ASCII-EBCDIC translation file.

Reason:

Internal conversion is set to NO but the specified ASCII-EBCDIC translation file

cannot be opened .

Action:

Check that the ASCII to EBCDIC conversion table file specified in the Unicenter

CA-XCOM Data Transport configuration file variable ATOE_FILENAME exists

and is readable.

List of Messages

B–48 User Guide

0458E Cannot open EBCDIC-ASCII translation file.

Reason:

An error was encountered while trying to parse the EBCDIC-ASCII translation

file.

Action:

Check the EBCDIC to ASCII file. It must be 256 lines long and contain a single

integer specified accord ing to C conventions: a lead ing 0 in d icates an octal

number, a lead ing 0x ind icates a hexadecimal; anything else is decimal.

0459E Cannot open ASCII-EBCDIC translation file.

Reason:

An error was encountered while trying to parse the ASCII-EBCDIC translation

file.

Action:

Check the ASCII to EBCDIC file. It must be 256 lines long and contain a single

integer specified accord ing to C conventions: a lead ing 0 ind icates an octal

number, a lead ing 0x ind icates a hexadecimal; anything else is decimal.

0460E Unable to Queue: Reason.

Reason:

Unicenter CA-XCOM Data Transport is unable to perform an enqueue function.

The reason follows.

Action:

This message may appear for a number of reasons. If the reason is „queue is full‟,

remove some unnecessary entries from the queue, wait for them to be removed

automatically, or increase QUEUE-SIZE and restart XCOMD Unicenter

CA-XCOM Scheduler service. If the reason is „cannot close data file,‟ then the file

system is full. Use File Manager to list file systems and check to see which file

system is full, and then clear d isk space as needed .

List of Messages

Messages B–49

0461E Cannot get shared memory.

Reason:

The Unicenter CA-XCOM Data Transport queue manager cannot get shared

memory.

Action:

Retry the transfer. If the problem persists, contact Computer Associates Customer

Support.

0463E Cannot allocate shared memory.

Reason:

The Unicenter CA-XCOM Data Transport queue manager cannot allocate shared

memory.

Action:

Retry the transfer. If the problem persists, contact Computer Associates Customer

Support.

0464E Cannot create shared memory.

Reason:

The Unicenter CA-XCOM Data Transport queue manager cannot create shared

memory.

Action:

Retry the transfer. If the problem persists, contact Computer Associates Customer

Support.

List of Messages

B–50 User Guide

0465E Check of XCOM.GLB pathnames failed.

Reason:

You must specify full paths to XLPCMD, TP_CMD, TRACE_PATH, and

QUEUE_PATH in your XCOM.GLB file.

Action:

Check the XCOM.GLB file to be sure that path names have been specified for

each of the variables listed in the Explanation. Restart the XCOMD Unicenter

CA-XCOM Scheduler service after you fix any problems.

0466E Unable to create an index file for queue.

Reason:

Unable to create an index file for the queue.

Action:

Check the permissions on the d irectory specified in the QUEUE_PATH variable

in XCOM.GLB. Restart the XCOMD Unicenter CA-XCOM Scheduler service after

you have repaired the problem.

0467E Queue entry passed to XCOMTP is NULL.

Reason:

This is an internal error. The queue entry passed to XCOMTP is NULL.

Action:

Retry the operation. If the problem persists, contact Computer Associates

Customer Support.

0468E Cannot allocate memory.

Reason:

Cannot allocate memory.

Action:

Retry the operation. If the problem persists, contact Computer Associates

Customer Support.

List of Messages

Messages B–51

0469E XCOMD Unicenter CA-XCOM Scheduler service is not running or not compatible.

Reason:

The XCOMD Unicenter CA-XCOM Scheduler service, is not running, or the

version of its running copy is not compatible to the version of the Unicenter

CA-XCOM Data Transport package you are using.

Action:

Try to start the XCOMD Unicenter CA-XCOM Scheduler service. If it does not

start, use XCOMD -cy to clean up. If it still does not start, make sure that you

have installed the right version of XCOMD Unicenter CA-XCOM Scheduler

service. Reinstall Unicenter CA-XCOM Data Transport, if necessary.

0470E Invalid number of parameters passed to XCOMTP.

Reason:

An invalid number of parameters has been passed to XCOMTP.

Action:

Retry the transfer. If the problem persists, contact Computer Associates Customer

Support.

0471E Invocation mode undefined.

Reason:

This is an internal error. The invocation mode is undefined .

Action:

Retry the operation. If the problem persists, contact Computer Associates

Customer Support.

List of Messages

B–52 User Guide

0472E Current mode undefined.

Reason:

This is an internal error. The current mode is u ndefined .

Action:

Retry the operation. If the problem persists, contact Computer Associates

Customer Support.

0473E Error(s) parsing XCOM.GLB; XCOMD Unicenter CA-XCOM Scheduler service cannot start.

Reason:

Error(s) found in parsing XCOM.GLB; XCOMD Unicenter CA-XCOM Scheduler

service cannot start.

Action:

Check the XCOM.GLB file and fix any syntax errors you find there. Restart the

XCOMD Unicenter CA-XCOM Scheduler service.

0474E XCOMD Unicenter CA-XCOM Scheduler service is already running. Multiple instances not supported.

Reason:

XCOMD Unicenter CA-XCOM Scheduler service is already running. Multiple

instances are not supported .

Action:

None required , since the XCOMD Unicenter CA-XCOM Scheduler service is

already running.

List of Messages

Messages B–53

0483E Error: unable to fork.

Reason:

Either the system or the user process limit has been reached and no add itional

processes can be created .

Action:

Stop some processes, or raise process limits, and retry the operation.

0486E Error writing configuration.

Reason:

An error was encountered while writing the Unicenter CA-XCOM Data

Transport configuration file.

Action:

Check the free space in the file system. If free space is not the problem, check the

permissions on the configuration file that is being written. Repair the problem

and retry the operation.

0488E Input file not specified, but stdin cannot be used.

Reason:

When the local input file is not specified , Unicenter CA-XCOM Data Transport

normally uses console input stream (std in). This message ind icates that std in

cannot be used for this transfer.

Action:

Specify an input file and retry.

List of Messages

B–54 User Guide

0489E Output file not specified: stdout cannot be used.

Reason:

When the local output file is not specified , Unicenter CA -XCOM Data Transport

normally uses console output stream (stdout). This message ind icates that stdout

cannot be used for this transfer.

Action:

Specify an output file and retry.

0491E Versions of different XCOM components are not compatible.

Reason:

The versions of the Unicenter CA-XCOM Data Transport modules are not

compatible.

Action:

Contact Computer Associates Customer Support.

0492E MAXRECLEN exceeds limit for record packing.

Reason:

The maximum block size for packing is 2048 for CARRIAGEFLAG=MPACK and

31744 for CARRIAGEFLAG=XPACK. MAXRECLEN exceeded this limit.

Action:

Reduce the value for MAXRECLEN.

0493E Cannot generate internal transaction id

Reason:

This is an internal error.

Action:

Reduce the EXPIRATION_TIME and increase MAX_QUEUE_ENTRIES and then

stop and restart XCOMD Unicenter CA-XCOM Scheduler service.

List of Messages

Messages B–55

0494E Duplicate transfer request number

Reason:

This is an internal error.

Action:

Retry the operation. If the problem persists, contact Computer Associates

Customer Support.

0500E Attempting to write to a directory as a regular file

Reason:

Unicenter CA-XCOM Data Transport is attempting to write a file, but d irectory

exists with the same name.

Action:

Change the name of the file or delete d irectory.

0503E RC=503 SENSE=n

Reason:

There may be a problem internal to Unicenter CA-XCOM Data Transport.

Action:

Create a trace of Unicenter CA-XCOM Data Transport for Windows and contact

Computer Associates Customer Support.

0505E Received a signal from APPC.

Reason:

An interrupt signal has been received from APPC and transmission has been

interrupted .

Action:

Retry the transfer. If the p roblem persists, contact Computer Associates Customer

Support.

List of Messages

B–56 User Guide

0508E Error replacing or creating file

Reason:

Unicenter CA-XCOM Data Transport received an error when trying to replace or

create a file.

Action:

Retry the transfer. If the problem persists, take a trace and contact Computer

Associates Customer Support.

0509E The remote partner does not support 31K packing (CARRIAGE_FLAG=XPACK).

Reason:

The remote partner returned an error ind icating that the value specified for the

CARRIAGE_FLAG parameter is not supported by that version of Unicenter

CA-XCOM Data Transport.

Action:

Switch to 2K packing (CARRIAGE_FLAG=MPACK) or no packing

(CARRIAGE_FLAG=NO).

0510E 31K packing (CARRIAGE_FLAG=XPACK) is not supported with VERSION=1.

Reason:

CARRIAGE_FLAG=XPACK w as specified with VERSION=1.

Action:

Switch to 2K packing (CARRIAGE_FLAG=MPACK) or no packing

(CARRIAGE_FLAG=NO).

0513E VERSION=1 is not valid with PROTOCOL=TCPIP.

Reason:

PROTOCOL=TCPIP was specified with VERSION=1.

Action:

Use VERSION=2 with PROTOCOL=TCPIP or VERSION=1 with

PROTOCOL=SNA.

List of Messages

Messages B–57

0514E DESTINATION cannot exceed 16 characters for an indirect transfer.

Reason:

An ind irect transfer of a report was requested with a DESTINATION value of

more than 16 characters.

Action:

Change the DESTINATION value to no more than 16 characters.

0600E transfer is not active.

Reason:

The operation which caused this message applicable to active transfers only.

Action:

Wait till the transfer becomes active or try another operation.

0601E Permission denied.

Reason:

You do not have security rights necessary to perform the operation which caused

this message.

Action:

None.

0602E General error in queue function; rc=0.

Reason:

Unicenter CA-XCOM Data Transport is unable to perform an enqueue function.

The reason follows.

Action:

If the reason is „cannot write/ open‟, check to see if your file system is full. If the

reason is „queue is full‟, remove some unnecessary entries from the queue, wait

for them to be removed automatically, or increase QUEUE-SIZE and restart

XCOMD Unicenter CA-XCOM Scheduler service. If the reason is „cannot

generate TID‟, contact Computer Associates Customer Support.

List of Messages

B–58 User Guide

0603E the TP state is invalid.

Reason:

The operation that caused this message requires that TP is in some particular

state(s). The current TP state is invalid for this operation.

Action:

Wait for TP to enter the proper state or try d ifferent operation.

0604E the maximum number of clients for this server is exceeded.

Reason:

There is a fixed maximum number of clients for each server. This number is

exceeded .

Action:

Log off some of the clients or wait for clients to log off.

0605E the client is already connected to this server.

Reason:

The client with the same XPE name is already logged to the server.

Action:

Try again. If the problem persists, contact Computer Associates Customer

Support.

0606I the z-request is unknown to this server.

Reason:

A client submitted request that is not supported by the server. The server will

ignore this request.

Action:

Get a server upgrade when available.

List of Messages

Messages B–59

0608E Removing client --

Reason:

Server removed client from the list of logged -on clients.

Action:

Logout from the server and connect to it again.

0609E timeout waiting for SEND_COMPLETE event; removing client

Reason:

Server removed client from the list of logged clients because of timeout waiting

for SEND_COMPLETE event

Action:

Logout from the server and connect to it again.

0611E timeout waiting for POLL_COMPLETE event; removing client

Reason:

Server removed client from the list of logged clients because of timeout w aiting

for POLL_COMPLETE event

Action:

Logout from the server and connect to it again.

0612E Transport error - please reconnect.

Reason:

Connection to server is broken.

Action:

Disconnect from server and reconnect.

List of Messages

B–60 User Guide

0650E XCOM_HOME is not set

Reason:

XCOMD Unicenter CA-XCOM Scheduler service could not find the

XCOM_HOME environment variable.

Action:

Set the XCOM_HOME system environment variable to point to the d irectory

where Unicenter CA-XCOM Data Transport is installed .

0651E SNAROOT is not set.

Reason:

XCOMD Unicenter CA-XCOM Scheduler service could not find the SNAroot

environment variable in the system environment..

Action:

Check whether SNA is installed . Set the SNAroot system environment variable

to point to the d irectory where tpstart.exe is installed .

0652E Cannot spawn tpstart.

Reason:

XCOMD Unicenter CA-XCOM Scheduler service could not execute the TPSTART

program.

Action:

Check whether SNA is installed . Verify the d irectory the SNAroot system

environment variable points to has tpstart.exe installed .

List of Messages

Messages B–61

Service-Specific Messages

473 Error(s) parsing xcom.glb; xcomd cannot start.

Reason:

The XCOMD Unicenter CA-XCOM Scheduler Service cannot start. There were

problems parsing XCOM.GLB or XCOM.TID.

Action:

Check that the following conditions apply:

All parameters are in upper case except paths, userids, passwords, or

anything that must be in upper case.

The drive letter is correct for the sp ecific path.

There are no blank lines.

All comments are properly commented out.

There are no extraneous characters on a line.

All parameters are valid for the release and are spelled correctly.

XCOM.TID contains a non-zero, six-d igit number. This is your transfer id

number.

474 xcomd is already running. Multiple instances not supported.

Reason:

XCOMD is already running. Multiple instances are not supported .

Action:

None.

List of Messages

B–62 User Guide

651 SNAROOT is not set

Reason:

There were errors setting the PROTOCOL and TP_CMD parameters.

Action:

If you are using TCP/ IP protocol only, TP_CMD should be set to blank (not

commented out).

If SNA is installed for Unicenter CA-XCOM Data Transport, the SNA stack must

be installed and running to bring up XCOMD Unicenter CA -XCOM Scheduler

service.

652 Cannot spawn tpstart

Reason:

Unicenter CA-XCOM Data Transport cannot find SNA.

Action:

Check the registry.

0785I Starting TCP/ IP Connection

Reason:

A TCP/ IP connection is being started to a remote partner.

Action:

None.

0786I TCP/ IP Connection Established

Reason:

A TCP/ IP connection was successfully made to a remote partner.

Action:

None.

List of Messages

Messages B–63

0793I Remote TCP/ IP Connection Established

Reason:

A TCP/ IP remote connection was successfully established from a remote partner.

Action:

None.

0805I TCP/ IP Connection Ended

Reason:

A TCP/ IP connection completed .

Action:

None.

0811I Starting Secure TCP/ IP Connection

Reason:

A Secure TCP/ IP connection is being started to a remote partner.

Action:

None.

0812I Remote Secure TCP/ IP Connection Requested

Reason:

A request for a Secure TCP/ IP remote connection was received from a remote

partner.

Action:

None.

List of Messages

B–64 User Guide

0813I Secure TCP/ IP Handshake Complete

Reason:

Secure Socket Layer (SSL) negotiation for the connection successfully completed .

The connection is now a secure TCP/ IP connection.

Action:

None.

0814I Secure TCP/ IP Connection Requested

Reason:

A request for a secure TCP/ IP connection was sent to the remote partner.

Action:

None.

0818I Secure TCP/ IP Connection Ended

Reason:

A secure TCP/ IP connection completed .

Action:

None.

Appendix

C Logical Units

A logical unit (LU) is the addressable connection point into an SNA network through which an end-user can send and receive messages. An LU is a set of rules and responsibilities. LUs can be either dependent or independent, and each LU type is associated with a protocol (for example, LU 0, LU 6.2).

The LU provides a connection into SNA for the end-user, which may either be an individual or a transaction program (for example, Unicenter CA-XCOM Data Transport). It allows end-users to communicate with each other and with other network addressable units (NAUs) in the network.

Physical Network Components An SNA network is divided into physical and logical components.

The physical network consists of the following:

■ Actual processors called nodes

■ Data links between the nodes

Logical Units C–1

Logical Network Components

Logical Network Components The logical network consists of a set of software components called network addressable units (NAUs) that include the following:

■ Logical units (LUs)

■ Physical units (PUs)

■ System services control points (SSCPs)

Session

The logical connection between two NAUs is a session. Although several types of sessions exist, the end-user is aware of only one type, which is LU-to-LU. Sessions are established when one LU sends another LU an SNA request known as a BIND.

PCID

Each session has its own procedure correlation identifier (PCID). This is an eight-byte field placed in the BIND, UNBIND, and other SNA requests to help an LU distinguish one session from another. It is required when you are running parallel sessions.

SID

A PCID is also known as a session identifier (SID) in VTAM displays. For each session, VTAM prompts you to note the primary or secondary node and displays the Session ID (SID) in hex. This SID is the PCID. If a trace of the BIND is taken, the PCID vector is towards the end.

The following VTAM operator command lists all sessions generated for that LU: DISPLAY NET, ID=XXX,E

C–2 User Guide

Logical Unit Types

Logical Unit Types The following table describes all of the LU types that are in use today:

LU Type Definition

0 A customizable protocol, which eliminates standardization beyond layers of SNA. This was commonly used in the late 1970s (before the advent of LU 6.2).

1 The protocol used as early as the 1960s by remote job entry devices such as the 3770 RJE terminal. Designed for use with printers and card readers, this protocol is most typically used in asymmetrical links where one node is a slave to the host.

2 The protocol for 3270 video display stations. It defines the data streams used by dumb terminals to communicate with the host.

3 This was a variant subset of the 3270 protocol that was used to drive printers attached to 3274 cluster controllers. Today it is still used to support old hardware.

4 This protocol was intended for use on word processors attached to a host network. You may still see it on old IBM word processors.

6.1 Developed during the late 1970s, this was SNA’s prototype protocol defined for program-to-program communication. It was a first attempt to provide a standardized mechanism for communication between intelligent peer computers.

6.2 LU 6.2 defines standard functions or verbs such as SEND, RECEIVE, and CONFIRM that simplify the work of making two programs running on different platforms talk to each other. This protocol is also referred to as "Advanced Program-to-Program Communications" (APPC).

7 This protocol specifies the data stream of the 5250 video display stations commonly used with the IBM mid-range computers.

Logical Units C–3

Criteria for Independent Logical Units

Criteria for Independent Logical Units Unicenter CA-XCOM Data Transport supports independent logical units (ILUs). An ILU is a logical unit that can generate sessions independent of the host. An ILU also meets the following criteria:

■ It utilizes LU 6.2.

■ It works on top of PU 2.1.

■ It can be a primary logical unit and therefore can send a BIND.

■ It supports an extended BIND (one that contains a Procedure Correlation Identifier [PCID]) and works with the new NCP PU 2.1 support.

Systems Supporting ILUs

Systems that currently support ILUs include the following:

■ z/OS

■ VM (all versions)

■ AS/400

■ IBM PC (APPC/PC)

■ Windows NT, 2000, and XP

■ Sun 386I

■ Most minicomputers and UNIX workstations that support PU 2.1

Software Version Support for ILUs

ACF/VTAM Version 3 Release 2 is required for full use of ILUs. The release of ACF/NCP required depends on the front-end processor being used. An IBM 3725 requires ACF/NCP Version 4 Release 3. A 3270 and 3745 require ACF/NCP Version 5 Release 2.1. Users working with ILUs over a Token Ring Interface Coupler (TIC) into a host must have Release 2.1.1, as older releases permit a token ring-attached PC to push an NCP into slowdown. When using Unicenter CA-XCOM Data Transport over COAX (event DFT LU 6.2 COAX), dependent LUs are used because 3174/3274 cluster controllers do not support PU 2.1.

C–4 User Guide

Criteria for Independent Logical Units

LU 6.2 Independent Implementations

Only Type 6 LUs can be independent. All other LU types are dependent. However, not all LU 6.2 implementations are independent. For example, the DECnet (VAX) APPC version of Unicenter CA-XCOM Data Transport is said to be a dependent LU because it works on top of PU 2.0, not PU 2.1.

Not every LU 6.2/PU 2.1 implementation can work with independent LUs. There are some aspects of PU 2.1 that NCP requires with which not all PU 2.1 implementations work correctly. This reflects the fact that not all minicomputer and PC SNA Gateway vendors had the latest NCP and VTAM for testing. However, PU 2.1 support can be enhanced to work with ILUs without changes to Unicenter CA-XCOM Data Transport. NCP supports ILUs over SDLC, the most common configuration using ILUs. A local area network gateway attached through an SDLC link to a host can also use ILUs. NCP also supports ILUs over a token ring through the (TIC).

Direct Sessions with Dependent Logical Unit

An independent logical unit can have an LU 6.2 session with a dependent LU. For example, an SDLC-attached PC running PU 2.1 can have an LU 6.2 session with a Coax-attached PC through a 3174 that’s running PU 2.0. (This has been successfully tested using NSA’s APPC.) This allows for direct sessions from an AS/400 to a VAX/VMS over the SNA background network, even though the VTAM is PU Type 2.0. In this environment, the VTAM LOGAPPL parameter and the VTAM VARY NET LOGON command do not work.

Note: The ILU must initiate the session; it must send to the BIND.

PU Type

When using ILUs with VTAM and Netview displays, VTAM shows the PU type in its status display (PU Type 2 or PU Type 2.1). All PUs originally display as PU 2.0. Once they become active, they display as PU 2.1.

Logical Units C–5

Index–1

Index

#

#!ENCRYPT, 3-54

A

accessing the queue, 2-65

adding a new transfer, 2-8

AGE_TIME, A-5

allocation_type API, 4-8

ALLOCATION_TYPE, mainframe file creation parameter, 3-25, A-6

API allocation_type, 4-8 blksize, 4-9 carriage_control_characters, 4-9 carriage_flag, 4-10 checkpoint_count, 4-10 class, 4-11 code_flag, 4-11 codtabl, 4-11 compress, 4-12 config_ssl, 4-13 convert_classes, 4-13 copies, 4-13 datacls, 4-13 debug_flag, 4-13 den, 4-14 destination, 4-14 disposition, 4-14 domain, 4-15 dsntype, 4-15 eol_classes, 4-15 example, 4-40 expdt, 4-15

fcb, 4-16 file_option, 4-16 file_type, 4-17 form, 4-17 hold, 4-18 label, 4-18 labelnum, 4-18 lclntfyl, 4-19 local, 4-19 local_file_rf, 4-19 local_file_sj, 4-20 local_file_sr, 4-20 localnotify, 4-20 lrecl, 4-21 maxreclen, 4-21 metacode_classes, 4-21 mgtclas, 4-22 notify_name, 4-22 notify_term, 4-24 notifyl, 4-22 notifyr, 4-23 num_of_dir_blocks, 4-24 number_of_retries, 4-24 password, 4-24 port, 4-25 primary_alloc, 4-25 protocol, 4-25 queue, 4-26 record_format, 4-26 remote_file, 4-28 remote_file_rf, 4-28 remote_system, 4-28 remove_trail_blanks, 4-29 report_title, 4-29 restart_supported, 4-29 retpd, 4-30 return codes, 4-41 rmtntfyl, 4-30 secondary_alloc, 4-30 shell_cmd, 4-31 spool_flag, 4-31 start_date, 4-31 start_time, 4-31

Index–2 User Guide

stat_frequency, 4-32 storcls, 4-32 tape, 4-32 tempdir, 4-32 truncation, 4-33 trusted, 4-33 unit, 4-34 unitct, 4-34 userid, 4-34 version, 4-34 volct, 4-35 volsq, 4-35 volume, 4-35 xcomfullssl, 4-35 xendcmd, 4-36 xidest, 4-36 xlogfile, 4-36 xlpcmd, 4-36 xmode, 4-37 xnotifycmd, 4-37 xppcmd, 4-37 xprecmd, 4-37 xtrace, 4-38

apitest.c file, API, 4-40

AS/400, XQUE, 5-2

ASCII/EBCDIC conversion, 3-44

ATOE_FILENAME, global parameter, A-6

B

BAT files, specifying in GUI, 2-82

before performing transfers, 2-16

blksize API, 4-9

BLKSIZE, mainframe file creation parameter, 3-25, A-6

block transfer, 6-1

browsing log file, 2-62

C

C structures, API, 4-8

carriage_control_characters API, 4-9

CARRIAGE_CONTROL_CHARACTERS, send report parameter, 3-36, A-7

CARRIAGE_FLAG encoding options in GUI, 2-29 file type conversion parameter, 3-45, A-7

carriage_flag API, 4-10

changed default directories and drives, 2-2

changing encrypted parameter values, 3-56 local port, in GUI, 2-86

character conversion, 3-44, 3-47 options, GUI, 2-73

checkboxes, Version 2 options, 2-31

checkpoint count, 2-43 parameters

CHECKPOINT_COUNT, 3-65, A-8 NUMBER_OF_RETRIES, 3-65

tuning, 6-2

checkpoint/restart, 3-63 Version 2 window, 2-41

checkpoint_count API, 4-10

CHECKPOINT_COUNT, checkpoint/restart parameter, 3-65, A-8

class API, 4-11

CLASS, send report parameter, 3-36, A-9

clearing the transfer list display, 2-17

CODE_FLAG encoding options in GUI, 2-29 file type conversion parameter, 3-46, A-9

code_flag API, 4-11

CODETABL, A-10 communications parameter, 3-14

codetabl API, 4-11

CodeTable field, 2-30

commands, modifying in GUI, 2-82

Index–3

communications parameters CODETABL, 3-14 COMPRESS, 3-14 DESTINATION_TYPE, A-13 REMOTE_SYSTEM, 3-15, A-33 REMOTE_SYSTEM_RF, 3-16, A-33 REMOTE_SYSTEM_SJ, 3-16 REMOTE_SYSTEM_SR, 3-16, A-34 setting, 3-13 TEMPDIR, 3-17, A-41

COMPRESS communications parameter, 3-14 data transfer parameter, A-10

compress API, 4-12

Compression window, 2-52

config_ssl API, 4-13

configuration files, 3-1 creating, 3-2 using in GUI, 2-9 XCOM.CNF, 3-13

control block structure API, 4-4

CONTROL parameter, A-11

controlling transfer status, 2-65

convert_classes API, 4-13

CONVERT_CLASSES, global parameter, A-11

copies API, 4-13

COPIES, send report parameter, 3-37, A-11

CREATE_DIRECTORIES, global parameter, A-12

creating configuration files, 3-2 procedure in GUI, 2-12

D

DAEMON_TIMEOUT, global parameter, A-12

data transfer parameters CODETABL, A-10 COMPRESS, A-10 MAXRECLEN, 3-15, A-25 TRUNCATION, 3-17, A-43 VERSION, 3-17, A-46

DATACLAS, mainframe file creation parameter, 3-26, A-12

datacls API, 4-13

debug_flag API, 4-13

DEBUG_FLAG, global parameter, A-12

debugging problems, 2-57

Debugging window, 2-57

DEC, 5-7

default directories and drives, 2-2

deleting fields from queue status display, 2-66 transfers from transfer list, 2-8

den API, 4-14

DEN, tape parameter, 3-31, A-13

DESTINATION, 3-35 send report parameter, 3-37, A-13

destination API, 4-14

DESTINATION_TYPE, communications parameter, A-13

Details window, 2-69

directories, 2-1 defaults, 2-2

disposition API, 4-14

DISPOSITION, send report parameter, 3-37, A-14

DOMAIN global parameter, A-14 security parameter, 3-53

domain API, 4-15

drives, defaults, 2-2

dsntype API, 4-15

DSNTYPE, mainframe file creation parameter, 3-26, A-14

Index–4 User Guide

E

EBCDIC conversion, 3-44

Edit Transfer window common functions, 2-20 common uses, 2-20 fields, 2-22 menu bar selections, 2-21 options group box, 2-28

editing configuration files from GUI, 2-14

encoding options, Edit Transfer window, 2-29

encrypted parameter values, changing, 3-56

eol_classes API, 4-15

EOL_CLASSES,global parameter, A-15

error messages, system identifier, B-1

ERRORLEVEL return codes, 3-41

ETOA_FILENAME, global parameter, A-15

expdt API, 4-15

EXPDT, tape parameter, 3-32, A-15

EXPIRATION_TIME, global parameter, A-15

F

fcb API, 4-16

FCB, send report parameter, 3-38, A-16

file access, specifying user IDs and passwords, 2-44

file conversion parameters CARRIAGE_FLAG, 3-45, A-7 CODE_FLAG, 3-46, A-9

file name considerations, 2-1

file types conversion, 3-44 supported, 2-2

FILE_ACCESS_PASSWORD, security parameter, 3-53, A-16

FILE_ACCESS_USERNAME, security parameter, 3-53, A-16

FILE_OPTION, 3-24 send and retrieve file parameter, A-16 send file parameter, 3-18

file_option API, 4-16

FILE_OPTION_RF, retrieve file parameter, 3-21, A-18

file_type API, 4-17

Find window, 2-63

form API, 4-17

FORM, send report parameter, 3-38, A-19

fully qualified domain name, 3-10

G

global parameters AGE_TIME, A-5 ATOE_FILENAME, A-6 CONVERT_CLASSES, A-11 CREATE_DIRECTORIES, A-12 DAEMON_TIMEOUT, A-12 DEBUG_FLAG, A-12 DOMAIN, A-14 EOL_CLASSES, A-15 ETOA_FILENAME, A-15 EXPIRATION_TIME, A-15 INTERNAL_CONVERSION_TABLES, A-20 MAIL_USERNAME, A-24 MAX_QUEUE_ENTRIES, A-24 MAX_SESSIONS_ENTRIES, A-24 METACODE_CLASSES, A-25 modifying in GUI, 2-71 NUMBER_OF_RETRIES, A-28 PORT, A-29 PROTOCOL, A-30 QUEUE_PATH, A-30 REMOVE_TRAIL_BLANKS, A-34 SESSIONS_FILE, A-37 SHELL_CMD, A-37 SOCK_DELAY, A-37 SOCK_RCV_BUF_SIZE, A-38 SOCK_SEND_BUF_SIZE, A-38 STAT_FREQUENCY, A-40 TCP_CMD, A-41 TP_CMD, A-41 TRACE_PATH, A-41

Index–5

TXPI_BUF_SIZE, A-43 TXPI_RECEIVE_TIMEOUT, A-44 TXPI_SEND_CHECK_FREQ, A-44 TXPI_TERM_TIMEOUT, A-44 WRITE_EOF, A-47

graphical user interface (GUI), 2-1

H

hold API, 4-18

HOLDFLAG, send report parameter, 3-38, A-19

I

IBM mainframe creating a file on, 3-24 record format parameter, GUI, 2-26

IBM mainframe file creation parameters ALLOCATION_TYPE, 3-25, A-6 BLKSIZE, 3-25, A-6 DATACLAS, 3-26, A-12 DSNTYPE, 3-26, A-14 LRECL, 3-26, A-23 MGMTCLAS, 3-27, A-25 NUM_OF_DIR_BLOCKS, 3-27, A-28 PRIMARY_ALLOC, 3-27, A-29 RECORD_FORMAT, 3-28, A-31 SECONDARY_ALLOC, 3-30, A-36 SECURE_SOCKET, 3-29, A-36 STORCLAS, 3-30, A-40 UNIT, 3-30, A-45 UNIT_RF, 3-24, A-45 VOLUME, 3-30, A-46 VOLUME_RF, 3-24, A-47 XCOM_CONFIG_SSL, 3-30, A-47 XCOM_SHOW_CIPHER, 3-31, A-48

IMPLICIT_PACKING, send report parameter, A-20

improving link speed, 6-1

incoming transfers, global defaults, GUI, 2-75

Indirect Transfer window, 2-54

indirect transfers, 2-54, 3-51

intermediate system, 2-55

INTERNAL_ CONVERSION_ TABLES, global parameter, A-20

IP addresses and names, 3-9

L

label API, 4-18

LABEL, tape parameter, 3-32, 4-18, A-20

labelnum API, 4-18

LABELNUM, tape parameter, 3-33, 4-18, A-21

lclntfyl API, 4-19

LCLNTFYL, notification parameter, 3-60, A-21

Local Notify dialog, 2-47

local port, changing in GUI, 2-86

local_file API, 4-19

LOCAL_FILE, send file parameter, 3-20, A-22

local_file_rf API, 4-19

LOCAL_FILE_RF, retrieve file parameter, 3-23, A-22

local_file_sj API, 4-20

LOCAL_FILE_SJ, send job parameter, 3-41, A-22

local_file_sr API, 4-20

LOCAL_FILE_SR, send report parameter, 3-38, A-23

LOCAL_NOTIFY, notification parameter, 3-60, A-23

LOCAL_RECEIVE, 4-3

LOCAL_SEND, 4-3

locally initiated transfers, 3-56

localnotify API, 4-20

Log Browser, 2-9, 2-62

log files browsing, 2-62 setting up, 3-43

logging, 3-43

logging parameter, XLOGFILE, 3-44

Index–6 User Guide

logical units dependent logical units, direct sessions, C-5 independent logical units (ILUs), C-4

direct sessions with dependent logical units, C-5 LU 6.2 independent implementations, C-5 PU type, C-5 software version support for LU 6.2, C-4

LU type 0, C-3 LU type 1, C-3 LU type 2, C-3 LU type 3, C-3 LU type 4, C-3 LU type 6.1, C-3 LU type 7, C-3 types, C-3

lrecl API, 4-21

LRECL, mainframe file creation parameter, 3-26, A-23

LU. See logical units

LU 6.2 benefits, 1-6 independent implementations, C-5

M

MAIL_USERNAME, global parameter, A-24

main window menu bar options, 2-7 pushbuttons, 2-8 Unicenter CA-XCOM Data Transport, 2-5, 2-12

mainframe file creation, 3-25

managing transfers in progress, 2-65

Max. Record Length field, 2-30

MAX_QUEUE_ENTRIES, global parameter, A-24

MAX_SESSIONS_ENTRIES, global parameter, A-24

maxreclen API, 4-21

MAXRECLEN, data transfer parameter, 3-15, A-25

menu bar selections edit transfer window, 2-21 Queue Status bar, 2-67

metacode_classes API, 4-21

METACODE_CLASSES, global parameter, A-25

MGMTCLAS, mainframe file creation parameter, 3-27, A-25

mgtclas API, 4-22

modifying global values, GUI, 2-71

multiple transfers from command prompt, 3-5 from the GUI, 2-10

N

network levels

diagram, 1-5 end user level, 1-3 logical level, 1-4 physical level, 1-4 send file flowchart, 1-10

logical and physical components, C-1, C-2 LU, C-1 procedure correlation identifier (PCID), C-2 session, C-2

notification parameters LCLNTFYL, 3-60, A-21 LOCAL_NOTIFY, 3-60, A-23 NOTIFY_NAME, 3-61, A-26 NOTIFYL, 3-61, A-26 NOTIFYR, 3-62, A-27 RMTNTFYL, 3-63, A-36 using, 3-59

xcom62 command, 3-59 xcomtcp command, 3-59

notify_name API, 4-22

NOTIFY_NAME, notification parameter, 3-61, A-26

notify_term API, 4-24

NOTIFY_TERM parameter, A-28

notifying of transfer completion local users, using GUI, 2-47 remote users, 2-49 using command line and parameters, 3-59

notifyl API, 4-22

NOTIFYL, notification parameter, 3-61, A-26

Index–7

notifyr API, 4-23

NOTIFYR, notification parameter, 3-62, A-27

Novell NetWare, naming conventions, 5-5

num_of_dir_blocks API, 4-24

NUM_OF_DIR_BLOCKS, mainframe file creation parameter, 3-27, A-28

NUMBER_OF_RETRIES checkpoint/restart parameter, 3-65 global parameter, A-28

number_of_retries API, 4-24

O

opening Log Browser, 2-9

OpenVMS, 5-7

OpenVMS Alpha, 5-7

OpenVMS VAX, 5-7

option parameters, 4-38

P

parameters alphabetical listing of, A-5 encrypting, 3-54 option, 4-38 values in GUI, 2-10

password API, 4-24

PASSWORD, security parameter, 3-53, A-28

passwords, specifying for file access, 2-44

paths considerations, 2-1 names, 2-2

PCID (procedure correlation ID), C-2

performing file transfers command prompt, 3-4, 3-8, 3-9 using TCP/IP, command line, 3-9

port GUI, 2-42 number, default in GUI

local system, 2-86 remote system, 2-85

option on Version 2 window, 2-43 setting in GUI, 2-43

port API, 4-25

PORT, global parameter, A-29

primary_alloc API, 4-25

PRIMARY_ALLOC, mainframe file creation parameter, 3-27, A-29

printer, network, 3-35

PRIORITY, queue parameter, 3-57, A-29

problems, tracing, 3-42

protocol, 3-4 selecting in GUI, 2-42 setting in GUI, 2-43

protocol API, 4-25

PROTOCOL, global parameter, 3-13, A-30

PU 2.0 devices and store and forward, 3-50

PU type, C-5

pushbuttons Edit Transfer window, 2-21 main window, 2-8 Queue Status window, 2-68

Q

queue accessing, 2-65 parameters

PRIORITY, 3-57, A-29 QUEUE, 3-57, A-30 START_DATE, 3-58, A-39 START_TIME, 3-58, A-40 using, 3-56

queue API, 4-26

Queue Manager, 2-9, 2-66

Queue Manager (XCOMQM), 3-56

Index–8 User Guide

Queue Properties, GUI, 2-77

Queue Status direction symbols, 2-68 menu bar, 2-67 window, 2-65

QUEUE, queue parameter, 3-57, A-30

QUEUE_PATH, global parameter, A-30

queuing transfers, 2-8

R

Receive File, performing, 2-39

receive pacing count, 6-2

receiving files, 2-39, 3-20

RECORD_FORMAT, 2-26 mainframe file creation parameter, 3-28, A-31

record_format API, 4-26

remote file, 2-22 LU, 2-19 system, 2-22

TCP/IP, 3-10

Remote Notify dialog, 2-49

remote_file API, 4-28

REMOTE_FILE, send file parameter, 3-20, A-32

remote_file_rf API, 4-28

REMOTE_FILE_RF, retrieve file parameter, 3-23, A-32

remote_system API, 4-28

REMOTE_SYSTEM, communications parameter, 3-15, A-33

REMOTE_SYSTEM_RF communications parameter, 3-16, A-33 retrieve file parameter, 3-23

REMOTE_SYSTEM_SJ communications parameter, 3-16 send job parameter, 3-41

REMOTE_SYSTEM_SR communications parameter, 3-16, A-34 send report parameter, 3-39

remove_trail_blanks API, 4-29

REMOVE_TRAIL_BLANKS, global parameter, A-34

report_title API, 4-29

REPORT_TITLE, send report parameter, 3-39, A-34

resizing transfer list fields, 2-17

resolving symbolic names, TCP/IP, 3-11

restart parameters RESTART_SUPPORTED, 3-65, A-35 RETRY_TIME, 3-66, A-35

restart_supported API, 4-29

RESTART_SUPPORTED, checkpoint/restart parameter, 3-65, A-35

restarting transfers, 3-63 Version 2 window, 2-41

retpd API, 4-30

RETPD, tape parameter, 3-33, A-35

retrieve file parameters FILE_OPTION_RF, 3-21, A-18 LOCAL_FILE_RF, 3-23, A-22 REMOTE_FILE_RF, 3-23, A-32 REMOTE_SYSTEM_RF, 3-23 UNIT_RF, 3-24 VOLUME_RF, 3-24

RETRY_TIME, checkpoint/restart parameter, 3-66, A-35

return codes API, 4-41

rmtntfyl API, 4-30

RMTNTFYL, notification parameter, 3-63, A-36

RU size, 6-1

S

sample API program, 4-40

Schedule window, 2-58

scheduled transfers and user availability, 2-59

Scheduler service, XCOMD, 2-3

scheduling transfers command line, 3-56 using GUI, 2-58

Index–9

scripts, defaults in GUI, 2-82

searching log, 2-63

secondary_alloc API, 4-30

SECONDARY_ALLOC, mainframe file creation parameter, 3-30, A-36

Secure Socket transfers, performing, 2-61 window, 2-61

SECURE_SOCKET, mainframe file creation parameter, 3-29, A-36

security parameters DOMAIN, 3-53, A-14 FILE_ACCESS_PASSWORD, 3-53, A-16 FILE_ACCESS_USERNAME, 3-53, A-16 PASSWORD, 3-53, A-28 TRUSTED, 3-53, A-43 USERID, 3-54, A-45 using, 3-52

Security Properties, GUI, 2-79

Security window, 2-44

selecting multiple transfers, 2-10 port, in GUI, 2-42 protocol, in GUI, 2-42 transfers for editing, 2-18

send and retrieve file parameter, FILE_OPTION, A-16

send file parameters FILE_OPTION, 3-18 LOCAL_FILE, 3-20, A-22 REMOTE_FILE, 3-20, A-32

Send File, performing, 2-33

send job command, 3-40

send job parameters LOCAL_FILE_SJ, 3-41, A-22 REMOTE_SYSTEM_SJ, 3-41, A-33

Send Job, performing in GUI, 2-37

send report command, 3-35

send report parameters CARRIAGE_CONTROL_CHARACTERS, 3-36, A-7 CLASS, 3-36, A-9 COPIES, 3-37, A-11 DESTINATION, 3-37, A-13 DISPOSITION, 3-37, A-14

FCB, 3-38 FCB, A-16 FORM, 3-38, A-19 HOLDFLAG, 3-38, A-19 IMPLICIT_PACKING, A-20 LOCAL_FILE_SR, 3-38, A-23 REMOTE_SYSTEM_SR, 3-39 REPORT_TITLE, 3-39, A-34 SPOOL_FLAG, 3-40, A-39

sending files, 2-33

from command prompt, 3-17 indirect transfers, 2-54 jobs, 2-37

from command line, 3-40 reports, from command line, 3-35

session ID (SID), C-2

SESSIONS_FILE, global parameter, A-37

setting communications parameters, 3-13 compression type in GUI, 2-52

shell_cmd API, 4-31

SHELL_CMD, global parameter, A-37

SID (session ID), C-2

SNA option on Version 2 window, 2-43 protocol in GUI, 2-42

SNA/APPC protocols, transfers using, command line, 3-8

SOCK_DELAY, global parameter, A-37

SOCK_RCV_BUF_SIZE, global parameter, A-38

SOCK_SEND_BUF_SIZE, global parameter, A-38

SPACE, A-39

specifying port in GUI, 2-42 remote system, TCP/IP, 3-10 user IDs and passwords for file access, 2-44

spool_flag API, 4-31

SPOOL_FLAG, send report parameter, 3-40, A-39

start_date API, 4-31

START_DATE, queue parameter, 3-58, A-39

start_time API, 4-31

Index–10 User Guide

START_TIME, queue parameter, 3-58, A-40

starting states API, 4-3

startst.h, 4-3

stat_frequency API, 4-32

STAT_FREQUENCY, global parameter, A-40

STORCLAS, mainframe file creation parameter, 3-30, A-40

storcls API, 4-32

store and forward parameter using, 3-50 XIDEST, 3-52

submitting transfers, 2-18 to queue, 2-5

System Properties, GUI, 2-81

T

tab pages, Properties dialog, 2-71

tape API, 4-32

tape parameters DEN, 3-31, 4-14, A-13 EXPDT, 3-32, 4-15, A-15 LABEL, 3-32, 4-18, A-20 LABELNUM, 3-33, 4-18, A-21 RETPD, 3-33, 4-30, A-35 TAPE, 3-33, 4-32, A-40 UNITCT, 3-34, A-45 VOLCT, 3-34, 4-35, A-46 VOLSQ, 3-34, 4-35, A-46

TAPE, tape parameter, 3-33, A-40

TCP/IP and Unicenter CA-XCOM Data Transport, overview, 1-7 name resolution, 3-11 option on Version 2 window, 2-43 port, A-29 port value, GUI, 2-42 port, command line, 3-11 protocol stack, 1-7 protocol, command line, 3-11 tuning parameters, GUI, 2-84

TCP/IP Properties, GUI, 2-84

TCP_CMD, global parameter, A-41

tempdir API, 4-32

TEMPDIR, communications parameter, 3-17, A-41

TID information displayed, 2-69

toolbar pushbutton, main window, 2-8

TP_CMD, global parameter, A-41

TRA files, 2-90

Trace Properties, GUI, 2-88

TRACE_PATH, global parameter, A-41

tracing from GUI, 2-57 using command line, 3-42

tracing facilities, GUI, 2-88

tracing parameter, XTRACE, 3-43

transfer_id parameter, 4-33

TRANSFER_ID parameter, A-42

TRANSFER_TYPE parameter, A-42

transfer_usr_data parameter, 4-33

TRANSFER_USR_DATA parameter, A-42

transferring files, from command prompt, 3-4

transfers in progress, managing, 2-65 indirect, 2-54 information displayed in log, 2-62 list

fields, 2-19 symbols, 2-19

performing, 2-16 status, 2-65

details, 2-69

TRC files, 2-90

Truncate Records option, 2-31

truncation API, 4-33

TRUNCATION, data transfer parameter, 3-17, A-43

trusted API, 4-33

TRUSTED, security parameter, 3-53, A-43

TXPI_BUF_SIZE, global parameter, A-43

TXPI_RECEIVE_TIMEOUT, global parameter, A-44

TXPI_SEND_CHECK_FREQ, global parameter, A-44

TXPI_TERM_TIMEOUT, global parameter, A-44

Index–11

U

Unicenter CA-XCOM Data Transport benefits of LU 6.2 (APPC), 1-5 connectivity, 1-2 list of parameters, A-5 main window, 2-5 network levels, 1-3 starting on your PC, 2-3 TCP/IP overview, 1-7

unit API, 4-34

UNIT, mainframe file creation parameter, 3-30, A-45

UNIT_RF, retrieve file parameter, 3-24, A-45

unitct API, 4-34

UNITCT, tape parameter, 3-34, A-45

Universal Naming Convention, 2-1

user IDs, specifying for file access, 2-44

user logged on/off for scheduled transfers, 2-58

USER_DATA, A-45

user_data parameter, 4-34

userid API, 4-34

USERID, security parameter, 3-54, A-45

V

VAX, 5-7

Version 1 vs Version 2 protocols, 2-41

Version 2 option checkboxes, 2-31 parameters, A-5 window, 2-41

version API, 4-34

VERSION, data transfer parameter, 3-17, A-46

viewing transfer status, 2-65

viewing transfer status details, 2-69

volct API, 4-35

VOLCT, tape parameter, 3-34, A-46

volsq API, 4-35

VOLSQ, tape parameter, 3-34, A-46

volume API, 4-35

VOLUME, mainframe file creation parameter, 3-30, A-46

VOLUME_RF, retrieve file parameter, 3-24, A-47

W

wildcard characters, 3-5

WRITE_EOF, global parameter, A-47

X

XBUFFSIZE, A-47

XCOM.CNF, 3-1, 3-2, 3-13

XCOM.GLB, 2-71, 3-2

XCOM.LOG, 6-2

XCOM.SES, GUI, 2-78

XCOM_CONFIG_SSL, A-47

XCOM_CONFIG_SSL, mainframe file creation parameter, 3-30

XCOM_PASSWORD, A-47

XCOM_SHOW_CIPHER, mainframe file creation parameter, 3-31, A-48

XCOM_USERID, A-48

XCOM62, 3-4 command line options, 3-6 examples, 3-8 syntax, 3-5 when to use, 3-4

XCOM62.EXE, 3-5 ERRORLEVEL return codes, 3-41

XcomAPI, 4-1, 4-3

xcomapi.h, 4-4

XCOMD Scheduler service, 2-3, 2-58

XCOMENCR.EXE, 3-54

xcomfullssl API, 4-35

Index–12 User Guide

XcomQAPI, 4-1

XCOMTCP, 3-4 command line options, 3-6 examples, 3-12 syntax, 3-6 when to use, 3-4

XCOMTCP.EXE, 3-5

XENDCMD, A-48

xendcmd API, 4-36

XIDEST, A-49 store and forward parameter, 3-52

xidest API, 4-36

XLOGFILE, A-49 logging parameter, 3-44

xlogfile API, 4-36

XLPCMD, A-49

xlpcmd API, 4-36

XLUNAME, A-49

XMODE, A-50

xmode API, 4-37

XNODESPEC, A-50

XNOTIFYCMD, A-50

xnotifycmd API, 4-37

XPPCMD, A-50

xppcmd API, 4-37

XPRECMD, A-51

xprecmd API, 4-37

XQUE, 5-2

xtrace API, 4-38

XTRACE, testing and tracing parameter, 3-43, A-51

Z

z/OS CICS interface, 5-5 store-and-forward, 5-5