Professional Documents
Culture Documents
Xcom For Unix
Xcom For Unix
Data Transport
User Guide
r11
J02562-1E
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, disclosed or duplicated, in whole or in part, without
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 to 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,
including without limitation, any implied warranties of merchantability, fitness for a particular purpose or
noninfringement. In no event will CA be liable to the end user or any third party for any loss or damage, direct or
indirect, from the use of this documentation, including without limitation, lost profits, business interruption,
goodwill, or lost data, even if CA is expressly advised of such loss or damage.
The use of any product referenced in 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.
Chapter 1: Introduction
Unicenter CA-XCOM Data Transport Flexibility ................................................. 1-1
Multiple User Interfaces ................................................................... 1-2
Unified Solution .......................................................................... 1-2
Unicenter CA-XCOM Data Transport Applications............................................... 1-2
File Transfer .............................................................................. 1-2
Type 2.1 Support .......................................................................... 1-3
TCP/IP Support .......................................................................... 1-3
Report Distribution ....................................................................... 1-4
RJE/NJE Replacement ..................................................................... 1-4
Unicenter CA-XCOM Data Transport Features................................................... 1-5
Modular Support of Most Systems .......................................................... 1-5
Data Link Types .......................................................................... 1-6
Standard Features ......................................................................... 1-6
Standard Functions ....................................................................... 1-6
High Capacity and Performance ............................................................ 1-7
Security .................................................................................. 1-8
Management ............................................................................. 1-8
Types of Transfers ............................................................................ 1-9
Answering Remote Requests ............................................................... 1-9
Invoking Unicenter CA-XCOM Data Transport ................................................. 1-10
Menu Interface .......................................................................... 1-10
Batch/Command Line Interface ........................................................... 1-10
Programming Interface ................................................................... 1-10
Unicenter CA-XCOM Data Transport Connectivity ............................................. 1-11
Network Levels in the SNA Model ............................................................ 1-12
The End User Level ...................................................................... 1-12
The Logical Level ........................................................................ 1-13
The Physical Level ....................................................................... 1-13
Contents iii
Network Level Diagram................................................................... 1-14
Benefits of LU 6.2 (APPC) ................................................................. 1-14
Unicenter CA-XCOM Data Transport in the TCP/IP Network .................................... 1-16
TCP/IP Protocol Stack .................................................................... 1-16
Unicenter CA-XCOM Data Transport Nodes in the TCP/IP Network .......................... 1-18
Successful Send File Transfer Scenario .......................................................... 1-19
Send File Flowchart ....................................................................... 1-20
Conventions ................................................................................. 1-21
Commands .............................................................................. 1-21
Special Function Keys ..................................................................... 1-21
File and Program Names .................................................................. 1-21
Screen Output ............................................................................ 1-21
iv User Guide
Modifying Post Processing Parameters ......................................................... 2-26
Using xcompp ........................................................................... 2-26
Modifying the Post Transfer Script ............................................................ 2-28
Using xcomend .......................................................................... 2-28
Modifying Printing Processes ................................................................. 2-31
Using xcomlp ............................................................................ 2-31
Customizing the Notification Process .......................................................... 2-32
Using xcomntfy .......................................................................... 2-32
xcom.trusted ................................................................................ 2-34
Using xcom.trusted ...................................................................... 2-34
Sample File .............................................................................. 2-36
Reports Containing Machine Code Characters .................................................. 2-36
Contents v
Creating a File on an IBM Mainframe .......................................................... 3-25
Parameters ............................................................................... 3-25
Tape Parameters for an IBM Mainframe .................................................... 3-31
Using the Send Report Command .............................................................. 3-35
Parameters ............................................................................... 3-35
Support for IBM Machine Code Characters.................................................. 3-39
Using the Send Job Command ................................................................. 3-40
Parameters ............................................................................... 3-41
Tracing Problems ............................................................................ 3-41
Return Codes ............................................................................ 3-42
Parameters ............................................................................... 3-43
Setting Up Log Files .......................................................................... 3-43
Parameters ............................................................................... 3-44
Setting File Type Conversion .................................................................. 3-44
Parameters ............................................................................... 3-45
Creating Custom Character Sets for File Conversion ............................................. 3-47
When to Use Character Conversion ........................................................ 3-47
Hexadecimal Numbers in Conversion Tables ................................................ 3-48
Customizing Default Character Sets ........................................................ 3-49
Specifying a Custom Character Set ......................................................... 3-50
Using Store and Forward ..................................................................... 3-51
When to Use ............................................................................. 3-51
Parameters ............................................................................... 3-52
Setting Password and User ID Security ......................................................... 3-52
Parameters ............................................................................... 3-53
Encrypting Parameter Values in Existing Configuration Files ..................................... 3-54
Syntax ................................................................................... 3-54
Options .................................................................................. 3-54
Procedure................................................................................ 3-55
Changing an Encrypted Value ............................................................. 3-55
Queuing Locally Initiated Transfers ............................................................ 3-56
Parameters ............................................................................... 3-57
Notifying of Transfer Completion .............................................................. 3-58
Example 1 ............................................................................... 3-58
Example 2 ............................................................................... 3-59
Parameters ............................................................................... 3-59
Checkpointing and Restarting Transfers ........................................................ 3-62
Parameters ............................................................................... 3-63
vi User Guide
Chapter 4: The Application Programming Interface
XcomAPI .................................................................................... 4-1
XcomQAPI ................................................................................... 4-1
Upgrading from Previous Releases ............................................................. 4-2
Changes to Access Permissions ............................................................. 4-2
Link Libraries............................................................................. 4-2
Starting States ............................................................................ 4-3
Starting States in startst.h .................................................................. 4-3
API Control Block Structure ................................................................ 4-3
Using API Member Names .................................................................... 4-6
Member Names ........................................................................... 4-6
Using XcomQAPI Option Parameters .......................................................... 4-38
Option Parameters ....................................................................... 4-38
API Examples ............................................................................... 4-40
C Language API File Transfer to Remote System File Example................................ 4-40
Queue Request Using XcomAQPI Routine .................................................. 4-43
XcomQAPI Return Codes..................................................................... 4-46
Contents vii
OS/2 ........................................................................................ 5-10
Naming Conventions ..................................................................... 5-10
Restrictions .............................................................................. 5-11
Stratus ...................................................................................... 5-12
Naming Conventions ..................................................................... 5-12
Types of Files Supported .................................................................. 5-13
Tandem ..................................................................................... 5-14
Naming Conventions ..................................................................... 5-14
Example ................................................................................. 5-14
Types of Files Supported .................................................................. 5-15
File Type Specification .................................................................... 5-15
Remotely Initiated Send Requests .......................................................... 5-16
UNIX/Linux ................................................................................. 5-16
Naming Conventions ..................................................................... 5-16
Types of Files Supported .................................................................. 5-17
VM ......................................................................................... 5-17
Naming Conventions ..................................................................... 5-17
Types of Files Supported .................................................................. 5-18
DCB Information ......................................................................... 5-18
Restriction ............................................................................... 5-18
VSE ......................................................................................... 5-19
VSAM Naming Conventions .............................................................. 5-19
SAM Naming Conventions ................................................................ 5-20
TAPE Naming Conventions ............................................................... 5-22
DTF Information ......................................................................... 5-23
Types of Files Supported .................................................................. 5-24
Restrictions .............................................................................. 5-24
Windows 3.1, 95, and 98 ...................................................................... 5-25
Naming Conventions ..................................................................... 5-25
Restrictions .............................................................................. 5-26
Windows NT (2000, 2003, and XP) ............................................................. 5-27
Naming Conventions ..................................................................... 5-27
Types of Files Supported .................................................................. 5-28
Additional Features ....................................................................... 5-29
Destination Printer Information ............................................................ 5-30
Restrictions .............................................................................. 5-31
Appendix A: Parameters
Using Unicenter CA-XCOM Data Transport Parameters .......................................... A-1
Parameter Format ......................................................................... A-2
Syntax ................................................................................... A-2
Guidelines ............................................................................... A-2
List of Parameters............................................................................. A-3
AGE_TIME ............................................................................... A-3
ALLOCATION_TYPE ..................................................................... A-4
ATOE_FILENAME ........................................................................ A-4
BLKSIZE ................................................................................. A-4
CARRIAGE_CONTROL_CHARACTERS.................................................... A-5
CARRIAGE_FLAG ........................................................................ A-5
CHECKPOINT_COUNT ................................................................... A-6
CLASS ................................................................................... A-6
CODE_FLAG ............................................................................. A-6
CODETABL .............................................................................. A-7
COMPRESS .............................................................................. A-7
CONTROL ............................................................................... A-8
CONVERT_CLASSES ..................................................................... A-8
COPIES .................................................................................. A-8
CREATE_DIR ............................................................................ A-9
DATACLAS .............................................................................. A-9
DEBUG_FLAG ........................................................................... A-9
DEN .................................................................................... A-10
DESTINATION .......................................................................... A-10
DESTINATION_TYPE .................................................................... A-10
DISPLAY_PASSWORD_IN_TRACE ....................................................... A-10
DISPOSITION ........................................................................... A-11
DOMAIN ............................................................................... A-11
DSNTYPE ............................................................................... A-11
Contents ix
EOL_CLASSES .......................................................................... A-12
ETOA_FILENAME ...................................................................... A-12
EXPDT ................................................................................. A-12
EXPIRATION_TIME ..................................................................... A-13
FCB .................................................................................... A-13
FILE_OPTION .......................................................................... A-13
FILE_OPTION_RF ....................................................................... A-14
FORM .................................................................................. A-15
HOLDFLAG ............................................................................ A-15
INTERNAL_CONVERSION_TABLES ..................................................... A-15
LABEL ................................................................................. A-16
LABELNUM ............................................................................ A-16
LCLNTFYL ............................................................................. A-17
LOCAL_FILE ........................................................................... A-17
LOCAL_FILE_RF ........................................................................ A-18
LOCAL_FILE_SJ ........................................................................ A-18
LOCAL_FILE_SR ........................................................................ A-18
LOCAL_NOTIFY ........................................................................ A-19
LRECL ................................................................................. A-19
MAX_QUEUE_ENTRIES ................................................................. A-19
MAX_REMOTE_TCP .................................................................... A-20
MAX_SESSIONS_ENTRIES .............................................................. A-20
MAXRECLEN ........................................................................... A-20
METACODE_CLASSES .................................................................. A-20
MGMTCLAS ............................................................................ A-21
NOTIFY_NAME ........................................................................ A-21
NOTIFYL ............................................................................... A-21
NOTIFYR ............................................................................... A-22
NOTIFY_TERM ......................................................................... A-22
NUMBER_OF_RETRIES ................................................................. A-22
NUM_OF_DIR_BLOCKS ................................................................. A-23
PASSWORD ............................................................................ A-23
PORT .................................................................................. A-23
PRIMARY_ALLOC ...................................................................... A-23
PRIORITY .............................................................................. A-24
PROTOCOL ............................................................................ A-24
QUEUE................................................................................. A-24
QUEUE_PATH .......................................................................... A-25
RMTNTFYL............................................................................. A-25
RECORD_FORMAT ..................................................................... A-26
REMOTE_FILE .......................................................................... A-27
x User Guide
REMOTE_FILE_RF ....................................................................... A-28
REMOTE_SYSTEM....................................................................... A-28
REMOTE_SYSTEM_RF ................................................................... A-29
REMOTE_SYSTEM_SJ .................................................................... A-29
REMOTE_SYSTEM_SR ................................................................... A-29
REMOVE_TRAIL_BLANKS ............................................................... A-30
REPORT_TITLE ......................................................................... A-30
RESTART_SUPPORTED .................................................................. A-31
RETPD .................................................................................. A-31
RETRY_TIME............................................................................ A-31
SAVE_PASSWORD_IN_CNF ............................................................. A-31
SECONDARY_ALLOC ................................................................... A-32
SECURE_SOCKET ....................................................................... A-32
SESSIONS_FILE ......................................................................... A-32
SHELL_CMD ............................................................................ A-33
SOCK_DELAY ........................................................................... A-33
SOCK_RCV_BUF_SIZE ................................................................... A-33
SOCK_SEND_BUF_SIZE ................................................................. A-34
SPOOL_FLAG ........................................................................... A-34
START_DATE ........................................................................... A-34
START_TIME ............................................................................ A-34
STAT_FREQUENCY ..................................................................... A-35
STORCLAS .............................................................................. A-35
SYSTEM_USER_DATA ................................................................... A-35
TAPE ................................................................................... A-35
TCP_CMD .............................................................................. A-36
TEMPDIR ............................................................................... A-36
TP_CMD ................................................................................ A-36
TRACE_PATH........................................................................... A-36
TRANSFER_NAME ...................................................................... A-37
TRANSFER_TYPE ....................................................................... A-37
TRANSFER_USER_DATA ................................................................ A-38
TRUNCATION .......................................................................... A-38
TRUSTED ............................................................................... A-38
TRUSTED_PATH ........................................................................ A-38
TXPI_BUF_SIZE ......................................................................... A-39
TXPI_RECEIVE_TIMEOUT ............................................................... A-39
TXPI_SEND_CHECK_FREQ .............................................................. A-39
TXPI_TERM_TIMEOUT .................................................................. A-39
UMASK ................................................................................. A-40
UNIT ................................................................................... A-40
Contents xi
UNITCT ................................................................................ A-40
UNIT_RF ............................................................................... A-40
USE_TP_SECURITY ..................................................................... A-40
USERID ................................................................................ A-41
VERSION ............................................................................... A-41
VOLCT ................................................................................. A-41
VOLUME ............................................................................... A-41
VOLUME_RF ........................................................................... A-41
VOLSQ ................................................................................. A-42
XCOM_CONFIG_SSL .................................................................... A-42
XCOM_PASSWORD ..................................................................... A-42
XCOM_SHOW_CIPHER ................................................................. A-42
XCOM_TRUSTED_OVR ................................................................. A-43
XCOM_USERID ......................................................................... A-43
XCOMPRE_LOCAL ..................................................................... A-43
XENDCMD ............................................................................. A-43
XIDEST ................................................................................. A-44
XLOGFILE .............................................................................. A-44
XLPCMD ............................................................................... A-44
XLUNAME ............................................................................. A-45
XMODE ................................................................................ A-45
XNODESPEC ........................................................................... A-45
XNOTIFYCMD .......................................................................... A-45
XPPCMD ............................................................................... A-46
XPRECMD .............................................................................. A-46
XTRACE ................................................................................ A-46
Appendix B: Messages
Error Messages................................................................................ B-1
Message ID Content ....................................................................... B-1
List of Messages ............................................................................... B-3
Contents xiii
Notifying of Transfer Completion ............................................................. D-29
Procedure............................................................................... D-29
Pull-Down Menus ....................................................................... D-30
Fields .................................................................................. D-30
Pushbuttons ............................................................................ D-31
Using the Conversion Dialog ................................................................. D-31
Procedure............................................................................... D-31
Using the Miscellaneous Window ............................................................. D-33
Procedure............................................................................... D-34
Pull-down Menu ........................................................................ D-35
Fields .................................................................................. D-35
Pushbuttons ............................................................................ D-36
Using the Secure Socket Window ............................................................. D-36
Accessing the Secure Socket Window ...................................................... D-36
Procedure............................................................................... D-37
Pushbuttons ............................................................................ D-37
Viewing Transfer Status...................................................................... D-37
Procedure............................................................................... D-38
Fields .................................................................................. D-38
Pushbuttons ............................................................................ D-39
Viewing Transfer Status After Completion ..................................................... D-39
Procedure............................................................................... D-40
Fields .................................................................................. D-40
Pushbutton ............................................................................. D-40
Viewing Log Information .................................................................... D-41
Procedure............................................................................... D-41
Pushbuttons ............................................................................ D-41
Index
Contents xv
Chapter
Introduction
1
Unicenter® CA-XCOM® Data Transport® for UNIX and Linux supports
high-speed transfers of files between all supported systems. Users can send files
from the local system to remote systems across an SNA or TCP/IP network and
actively retrieve files from those systems. The remote system can initiate the
same range of transfer capabilities as the local system. This chapter is a general
introduction to the features and functions of Unicenter CA-XCOM Data
Transport across all of its platforms.
This guide is for users of Unicenter CA-XCOM Data Transport on UNIX and
Linux platforms, including System Administrators and Applications
Programmers.
The applications listed above are only a few examples. Under most conditions,
Unicenter CA-XCOM Data Transport will allow file sharing between any two
computers or workstations within your company.
Introduction 1–1
Unicenter CA-XCOM Data Transport Applications
Unified Solution
When these functions are combined, a wide variety of applications are possible.
File Transfer
Unicenter CA-XCOM Data Transport will support transfers between any two
processors in an SNA network or a TCP/IP network with one of the following
methods:
■ By using the z/OS, VM, or VSE mainframes for store-and-forward
■ Through Independent Logical Unit (ILU) support over the SNA (Systems
Network Architecture) backbone
■ Through use of the TCP/IP network
TCP/IP Support
Introduction 1–3
Unicenter CA-XCOM Data Transport Applications
You can use the Secure Socket Layer (SSL) to perform secure TCP/IP transfers
between platforms running Unicenter CA-XCOM Data Transport r11 and above
that support secure (SSL) TCP/IP. A secure (SSL) TCP/IP transfer allows for the
encryption of the transmitted data. It also adds a digital signature to the
encryption of the transmitted data. Unicenter CA-XCOM Data Transport uses
OpenSSL to implement a secure (SSL) TCP/IP transfer. Secure (SSL) TCP/IP
support is provided between the following platforms:
■ Linux S/390
■ Linux x86
■ Windows NT family (2000, 2003, and XP)
■ z/OS
■ Most common UNIX platforms
Report Distribution
Unicenter CA-XCOM Data Transport allows z/OS, VM, VSE, AS/400 and VAX
users to take print output from any supported system and automatically transfer
it to another system for printing. The application programs producing the
reports do not require any modification to support Unicenter CA-XCOM Data
Transport report distribution, and no operator intervention is required at either
end.
RJE/NJE Replacement
Current Remote Job Entry (RJE) systems contain inherent limitations. Remote
computers can submit work to the host for processing and receive print data, but
the host cannot distribute processing tasks to idle processors residing on the
network. A further concern for data processing managers is the requirement that
users have an understanding of Job Entry Subsystem (JES) commands to operate
the system.
■ Send one copy of the report back to the source PC for printing.
■ Send another to the z/OS mainframe for printing on a high-speed printer.
You can easily implement Unicenter CA-XCOM Data Transport without any
changes to your existing applications programs. Data is transferred with greater
integrity and higher efficiency.
Introduction 1–5
Unicenter CA-XCOM Data Transport Features
Unicenter CA-XCOM Data Transport supports the following data link types:
■ SDLC
■ Local Area Network (such as Token Ring and Ethernet)
■ All SNA data links, including channel-based links
■ TCP/IP
Standard Features
Standard Functions
The following functions are offered over most of the Unicenter CA-XCOM Data
Transport platforms:
■ Compression—Unicenter CA-XCOM Data Transport compresses repeating
characters prior to transmission. In certain cases, throughput is significantly
higher than the actual line speed.
■ ASCII/EBCDIC translation—Unicenter CA-XCOM Data Transport can
translate data between ASCII and EBCDIC formats as needed. Translations
occur on the ASCII-based platform.
Introduction 1–7
Unicenter CA-XCOM Data Transport Features
Security
Unicenter CA-XCOM Data Transport interfaces with the native security facility
on all supported systems. When security is invoked, you are required to provide
a valid user ID and password for the remote system. For example, in the z/OS
environment, an interface is also provided to IBM RACF, eTrust CA-ACF2, and
eTrust CA-Top Secret. On PC and OS/2 versions of Unicenter CA-XCOM Data
Transport (where no native security exists), you are given the option to create an
ID/password table to prevent unauthorized use of Unicenter CA-XCOM Data
Transport.
Unicenter CA-XCOM Data Transport also has special security capabilities that
can help data centers handle their individual needs. For example, the security
features allow installer specification of what can or cannot run under the
privileges of someone other than the person requesting the transmission. These
security features can also force user IDs from both remote computers to be the
same or different. For otherwise unsatisfied security needs, Unicenter CA-XCOM
Data Transport supplies a variety of user exits that enable user-written security
packages to be fully integrated.
Management
Details of any transfer errors are also maintained in the log, allowing rapid
problem determination and resolution. In addition, messages signaling the
completion of any Unicenter CA-XCOM Data Transport event can be directed to
a user in the network.
Types of Transfers
Unicenter CA-XCOM Data Transport will perform the following transfers:
■ Sending files—With Unicenter CA-XCOM Data Transport, a computer can
send a data file to be stored on the remote system in a specified remote file.
■ Sending reports—Unicenter CA-XCOM Data Transport can send a report to
be printed on a remote system.
■ Sending batch jobs for execution—Unicenter CA-XCOM Data Transport
can send a job to be executed on a remote system.
■ Retrieving files—When a computer starts the transmission request, it can
also retrieve a file from a remote computer and store it in a specified local
remote file.
Introduction 1–9
Invoking Unicenter CA-XCOM Data Transport
Menu Interface
Unicenter CA-XCOM Data Transport can also be initiated with a batch file on
your computer. For example, a transfer can be invoked through a JCL batch job
on z/OS, and a CMS EXEC on VM. On mini and microcomputers, a transfer can
be initiated via a command entered at the operating system prompt/command
line or placed in a batch file to be executed with other commands.
Programming Interface
Note: For information about the platforms for which TCP/IP support is
provided, see TCP/IP Support in this chapter.
Introduction 1–11
Network Levels in the SNA Model
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.
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 logical level consists of logical units (LUs) which 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.
Introduction 1–13
Network Levels in the SNA Model
The diagram below shows the various network levels used to communicate with
Unicenter CA-XCOM Data Transport:
Local Remote
User User
END
USER CA-XCOM CA-XCOM
LEVEL
LU 6.2 LU 6.2
LOGICAL
LEVEL
Physical Physical
Unit Node Unit Node
PHYSICAL
LEVEL
Physical Connection
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.
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.
P = Protocol
Overhead
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 about these topics, see the appendix
“Understanding Logical Units.”
Introduction 1–15
Unicenter CA-XCOM Data Transport in the TCP/IP Network
Each layer in the TCP/IP protocol stack provides services to the layer above it
and uses the services below it.
The table below 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.)
Network Layer
The Network layer provides a set of protocols, Token Ring, Ethernet, and so on,
which 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.
Transport Layer
Introduction 1–17
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).
TCP/IP Address
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–19
Successful Send File Transfer Scenario
Conventions
This guide contains information about the operation and usage of Unicenter
CA-XCOM Data Transport for UNIX and Linux. The following conventions are
used throughout this guide.
Commands
Items that you must replace with specific values when you issue the commands
are in italics. For example, replace filename.cnf with the name of your
configuration file. Type commands exactly as they appear, paying attention to
upper and lower case. Command options appear set off by brackets [ ]. Do not
type the brackets in a command.
Grouped commands of more than six lines are set off in a simulated screen
display.
All of the commands for Unicenter CA-XCOM Data Transport for UNIX and
Linux follow the conventional rules and grammar of the UNIX and Linux
command languages.
Special function keys, such as Enter or CTRL, appear in regular font and all in
upper case.
File names and names of programs in running text are set off in the following
font:
xcomd
Screen Output
Introduction 1–21
Chapter
Operating Environment
2
The components used for scheduling transfers, handling files, and managing
Unicenter CA-XCOM Data Transport resources are the xcomd command and the
daemon process, the global parameters, the session control parameters, the
queue, and the use of post processing scripts.
Transfer Protocols
Parameter Values
Parameter Format
Syntax
Example
This controls the maximum time in seconds that a transaction is held in the
transfer queue.
Guidelines
Examples
If you type the following at the command line, 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
The xcomd command controls the daemon. The daemon itself runs as a
background process to control file transfers and manage Unicenter CA-XCOM
Data Transport resources. The daemon:
■ Schedules and synchronizes transfer requests.
■ Controls shared memory for transfers.
■ Establishes the default parameter values by reading the parameter file,
xcom.glb and then running in the background.
■ Controls the automatic restart of locally initiated transfers.
■ Writes queue information out to disk periodically.
■ Deletes aged entries from the queue.
The daemon must be running before you can do any transfers. For performing
transfers using SNA protocols, Unicenter CA-XCOM Data Transport also
requires an active LU 6.2 session to transfer files. Once an LU 6.2 session is
established, local users may begin using Unicenter CA-XCOM Data Transport to
initiate transfers. For performing transfers using TCP/IP, your system must be
configured for using Unicenter CA-XCOM Data Transport with TCP/IP.
Syntax
Options
Option Explanation
-c[y] Kill the daemon process and free shared memory. This option
will stop the daemon while transfers are running.
Note: Use this option as a last resort because it brings the
scheduler down immediately, whether or not there are running
or scheduled transfers. If you use the -c option without the y,
the system prompts you to confirm this action by typing y for
yes.
WARNING! This option can cause corruption of the CA-XCOM
queue. It can shut down Unicenter CA-XCOM Data Transport while
it is updating the queue. To prevent problems, delete the queue by
deleting all files in /usr/spool/xcom/Q after issuing this command.
Option Explanation
-dtracelevel Set the trace level of the daemon process to tracelevel. Higher
numbers (up to 10) give more trace information. The trace goes
to stderr. For more information, see the topic, Tracing Problems,
in the chapter "The Command Line Interface."
-r Report the release level of xcomd and exit.
-s Stop the Unicenter CA-XCOM Data Transport daemon by
sending a request to the scheduler.
Note: This option does not stop the daemon immediately if
there is an active transfer going on.
Starting xcomd
Note: The full path name specification for xcomd is /etc/xcomd, except for the
following:
■ For HP-UX systems, use /opt/xcom/bin/xcomd.
■ For OSF Digital UNIX and Linux systems, use /usr/sbin/xcomd.
Note: The xcom.glb parameters apply to incoming and outgoing transfers unless
they are overridden. xcom.cnf parameters override those in xcom.glb for
outgoing transfers. The parameters in xcom.glb are used for remotely initiated
transfers.
For a full list of Unicenter CA-XCOM Data Transport parameters, see the
appendix “Parameters.” For an explanation of parameters and defaults see Using
Unicenter CA-XCOM Data Transport Parameters in this chapter. This section
contains information about using the global parameters contained in the
xcom.glb file.
Parameters
AGE_TIME
The number of seconds before waiting queue entries are removed from 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)
ATOE_FILENAME
The name of the file containing the ASCII-to-EBCDIC character conversion table.
This is a custom file used only for specifying custom translation tables from
ASCII to EBCDIC, if needed.
Range: 0 to 256 characters
Default: /usr/spool/xcom/convtab/atoe.tab, except for the following:
■ For HP-UX systems: /var/spool/xcom/convtab/atoe.tab
■ For OSF Digital UNIX: /var/opt/xcom/convtab/atoe.tab
CONVERT_CLASSES
DISPLAY_PASSWORD_IN_TRACE
Value Description
YES Encrypted and plain text passwords are displayed in the trace
files.
ENCRYPT Encrypted passwords are displayed in the trace files.
NO Encrypted passwords are displayed in the trace files
Default: NO
EOL_CLASSES
A character string containing print classes for an ASCII newline that is 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: /usr/spool/xcom/convtab/etoa.tab, except for the following:
■ For HP-UX systems: /var/spool/xcom/convtab/etoa.tab
■ For OSF Digital UNIX: /var/opt/xcom/convtab/etoa.tab
EXPIRATION_TIME
The maximum time, in seconds, that a transaction is held in the transfer queue
after completion. When the maximum time is reached, all references to the
transaction are removed from the queue, including trace files and temporary
files.
INTERNAL_CONVERSION_TABLES
Value Description
YES Use internal conversion tables.
NO Use the external tables contained in ATOE_FILENAME and
ETOA_FILENAME.
Default: YES
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 32767
The value cannot be set larger than the maximum allowed shared memory
segment divided by 512.
Default: 50
MAX_REMOTE_TCP
Note: Setting this parameter to 0 prohibits any remote transfers from taking
place.
Range: 0 to 999
Default: 32
MAX_SESSIONS_ENTRIES
The maximum number of partners that can be described in the XCOM.SES file.
Range: 1 to 999
Default: 15
METACODE_CLASSES
Classes of print jobs saved in metacode format, a variable length record format.
For incoming report transfers only.
Range: 0 to 64 characters
Default: None
PROTOCOL
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.
REMOVE_TRAIL_BLANKS
Indicates whether or not to remove the blanks at the end of each record when a
remote partner is sending a file.
Range: Yes or No
Default: No
QUEUE_PATH
SAVE_PASSWORD_IN_CNF
Determines if the xcomtool GUI saves the password in the .CNF file.
Range: The range of values is listed in the following table:
Value Description
YES The xcomtool GUI saves the password in the .CNF file in
encrypted format.
NO The xcomtool GUI does not save the password in the .CNF file
and blanks the password field out after each operation.
Default: NO
SESSIONS_FILE
The path name of the xcom.ses file, which tells Unicenter CA-XCOM Data
Transport how many sessions can be used by a single LU.
Range: 0 to 256 characters
Default: /usr/spool/xcom/config/xcom.ses, except for the following:
■ For HP-UX systems: /var/spool/xcom/config/xcom.ses
■ For OSF Digital UNIX systems: /var/opt/xcom/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: /bin/ksh
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
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
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: 10
TCP_CMD
Path and name of the Unicenter CA-XCOM Data Transport program started by
the XCOMD service that is used for queued locally initiated transfers, and for all
remotely initiated transfers for TCP/IP protocols.
Range: 0 to 256
Default: /usr/lib/xcom/xcomtcp, except for the following:
■ For HP-UX systems: /opt/xcom/lib/xcomtcp
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcomtcp
TEMPDIR
Indicates the directory in which temporary files for jobs and reports can be
created.
Range: 1 to 256 characters
Default: /tmp
TP_CMD
TRACE_PATH
TRUSTED_PATH
TXPI_BUF_SIZ
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
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
UMASK
Used to set the permissions assigned to a file when the file is being created and
received on the system for the first time. The value is expressed as an octal
number (base 8). The octal number has the same meaning as in the standard
umask command.
Range: 000 to 777
Default: 022
XCOM_PASSWORD
This parameter specifies the default password for remotely initiated transfers.
Range: 0 to 31 characters
Default: None
XCOM_TRUSTED_OVR
Specifies if the user is permitted to override the user ID by using the USERID
parameter for locally initiated trusted transfers. If XCOM_TRUSTED_OVR is set
to YES, the user is permitted to override the user ID by using the USERID
parameter. If it is set to NO, the user ID of the process that initiated the transfer is
used.
Range: YES, NO, Y, N
Default: NO
XCOM_USERID
XCOMPRE_LOCAL
Indicates whether the xcompre script file for a locally initiated transfer should be
run.
Range: YES, NO
Default: NO
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcomend
■ For HP-UX systems: /opt/xcom/lib/xcomend
■ For OSF Digital UNIX system: /usr/opt/xcom/lib/xcomend
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcomlp
■ For HP-UX systems: /opt/xcom/lib/xcomlp
■ For OSF Digital UNIX system: /usr/opt/xcom/lib/xcomlp
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcomntfy
■ For HP-UX systems: /opt/xcom/lib/xcomntfy
■ For OSF Digital UNIX system: /usr/opt/xcom/lib/xcomntfy
XPPCMD
Path name of the command used for user-defined post processing, for file
transfers only. Only used when the local system is receiving the file.
Range: 0 to 64 characters
Default:
■ For UNIX/Linux systems: /usr/lib/xcom/xcompp
■ For HP-UX systems: /usr/lib/xcom/xcompp
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcompre
■ For HP-UX systems: /opt/xcom/lib/xcompre
■ For OSF Digital UNIX system: /usr/opt/xcom/lib/xcompre
XTRACE
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 with additional detailed technical information.
Default: 0
The xcomd command uses the configuration file xcom.ses to set session control
parameters. For the location of the file on your system, see the Getting Started for
your system.
You can set a maximum number of partners that can be described in this file by
specifying a number in the MAX_SESSIONS_ENTRIES global parameter. For
example, if you specify MAX_SESSIONS_ENTRIES=50, you can have up to 50
lines in this file, each one specifying the name of the remote system.
You limit the number of sessions available for Unicenter CA-XCOM Data
Transport transfers by setting a parameter in the xcom.ses file for each
connection to the remote Unicenter CA-XCOM Data Transport partner. If a
session is not available for immediate use, the transfer is queued for subsequent
execution.
For transfers using SNA, the parameter name connection_profile represents the
remote system name or partner LU name to which the session limit is applied.
For transfers using TCP/IP, specify the format of the remote system that is
consistent with your site’s use of the remote system parameters. If the IP address
is used, specify connection_profile in the form of 123.123.78.91. If host names or
domain names are used in the remote system parameter, specify
connection_profile in the appropriate form of the name.
You may specify a connection_profile for each form of address or name that is
used. Note that if the XCOM.SES file does not have an entry for the host name or
domain name, the value of the connection_profile will default to one.
Example
The XcomQAPI allows your site to write programs to access the queue. The input
and options for the XcomQAPI are the same as those described in the following
topics. For additional information about the XcomQAPI, see the chapter “The
Application Programming Interface.”
The xcomqm command lets you maintain Unicenter CA-XCOM Data Transport
queues by using the command line interface. This command lets you delete
entries from the queue, suspend transfers, resume suspended transfers, display
the list of entries in the queue and display detailed information about the queue
entries.
Syntax
You can use more than one option on a command line. You can also use the same
option more than once. Each option must be separated by a space. These options
can be listed in any order, but note that when the shell encounters options such
as the -r option, it performs the command and exits xcomqm without reading the
rest of the command line.
Options
Option Function
-r Display the release level of xcomqm and exit.
-Aentryname Release a held transfer.
-Centryname Get a trace of a transfer.
-Dentryname Display details about a queue entry.
-Hentryname Hold a scheduled transfer.
Option Function
-L[a] List your queued transfers. Use -La for 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 will
interrupt the transfer.
-Tentryname Terminate an active transfer.
-T[f]entryname Force termination of the transfer. Use this command
when you want to remove a transfer that is still active.
Note: Please be aware that 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 Display debugging information.
no option Display the help menu.
-z Display logging text for transfer.
Note: entryname represents the Transaction ID, which is the six-digit name of the
transfer entry in the queue.
Note: Unicenter CA-XCOM Data Transport should be idle when you run this
program.
Syntax
Value Description
number_of_days_old Entries in the log longer than the number of days
specified are purged.
log_file_name The name of the log file to clean (optional). The
default is the XCOM.LOG in the current directory.
If not specified, the log file name defaults to
/var/spool/xcom/xcom.log.
Example
CLEANLOG 5
This command removes entries in XCOM.LOG that are older than 5 days.
Customization is useful in certain applications where the remote user does not
specify the true file name, and the local system uses a database to map the
specified name to the true local name. For example, certain e-mail application
systems work in this way. By way of additional explanation, for example, an
incoming transfer specifies a certain file name, but the administrator of the local
system that is receiving the file wants to place the data in a different file,
depending on the user ID of the sender. The script retrieves parameter values
and sends the relevant information to standard output, using the -g option, and
if desired, changes the values using the -p option.
Using xcompre
Note: The -g and -p options, for use with xcomqm, as shown in the sample script
are intended only for use with this exit.
For information about shells and script changes, see Shells and Script Changes in
this chapter.
For remotely initiated transfers, the pre-allocation exit is invoked after Unicenter
CA-XCOM Data Transport receives the Unicenter CA-XCOM Data Transport
header from the remote partner, but before the transfer commences. For locally
initiated transfers, the pre-allocation exit is invoked based on the value specified
by the global parameter XCOM_LOCAL. If XCOMPRE_LOCAL is set, the pre-
allocation exit is invoked before sending the Unicenter CA-XCOM Data
Transport header to a remote partner.
xcompre Options
The available options for xcompre and their associated parameters are listed
below:
Option Function
-g Passes transfer ID to xcomqm, and retrieves the values for the
following parameters from the local database and passes them
to standard output:
FILE_OPTION
FILE_TYPE
LOCAL_FILE
REMOTE_FILE
REMOTE_LU
TRANSFER_TYPE
USERID
-p Changes the values for the following parameters based upon
the specified transfer ID (tid) and applies them to the transfer:
FILE_OPTION
LOCAL_FILE
REMOTE_FILE
Sample Script
tid=$1
if [ $? -ne 0 ]
then
exit 100
else
xcomqm -p$tid LOCAL_FILE=/u/jc/test/000040.local \
REMOTE_FILE=abcdefg \
FILE_OPTION=CREATE \
2>&1 > /tmp/$tid.errlog
exit 0
fi
Example
In the above sample script, the only file transfers permitted are ones that have
payroll or finance in the USERID. If the USERID does not meet one of these
criteria, the transfer is rejected. If the transfer is permitted, then the -p option is
used to specify the values to use for LOCAL_FILE, REMOTE_FILE and
FILE_OPTION.
The post processing shell scripts include xcompp, xcomend, xcomlp, and
xcomntfy. These are provided with Unicenter CA-XCOM Data Transport as
sample scripts, and are also available online. They can be tailored to meet
individual user requirements, if necessary.
Process Summary
Troubleshooting
Using xcompp
The xcompp script is a shell script that contains parameters for post processing of
a file. After a successful file transfer is received, xcompp is always turned on
(available) and will get invoked automatically. It is only invoked for incoming
files. It does not work for jobs or reports.
You can reference the parameters in xcompp by putting commands at the end of
the script. xcompp does not take any visible actions if no modifications are made
to the script.
Sample Script
# POSTPROCESS HERE !
exit 0
Example
The example below shows how you change the permissions on a received file by
adding the following to the end of the xcompp script:
chmod 777 $tmp_file
This will change the permissions on tmp_file to read, write, and execute.
Note: You must type a $ sign before the variable to reference the variable in the
xcompp script.
Using xcomend
Sample Script
#exec 2>&1
#set -vx
#PS4='[$0: $LINENO]+ '
#export PS4
###### END OF DEBUG SECTION ######
#
# The first parameters are supplied for any type of transfer.
shift
blocks=$1 # No. of blocks sent/received
shift
bytes=$1 # No. of bytes sent/received
shift
#
# The next parameters are supplied for file transfers only
if [ $transfer_type = "FILE" ]
then
#
# The next group of parameters are supplied for report transfers only
#
# There are no extra parameters for remote jobs
fi
exit 0
Using xcomlp
The xcomlp script is a shell script that is invoked by the Unicenter CA-XCOM
Data Transport transaction program (XCOMSEND).
Sample Script
shift
jobnumber=$1 # Job number field from JES
shift
class=$1 # print class
shift
copies=$1 # Number of copies to print
shift
form=$1 # Type of form to print this job on.
shift
recfm=$1 # Record format of incoming print job.
shift
lrecl=$1 # Logical record length of incoming report.
shift
blksize=$1 # Block size of incoming report.
shift
ucs_name=$1 # Name of UCS to be used for this print job.
shift
fcb=$1 # Name of FCB (form control block) for this report.
shift
room_number=$1 # Room number field from JES.
shift
programmer_name=$1 # Programmer name field from JES.
shift
tso_notify=$1 # TSO notify field from JES.
shift
file=$1 # Name of temporary file into which XCOM 6.2 has placed report
shift
destination=$1 # Destination printer specification.
shift
nodespec=$1 # connection profile name
shift
carriagecontrol=$1 # Type of carriage control characters being used.
Using xcomntfy
The supplied script uses mailx(1) to notify the named user logins.
Sample Script
if [ `uname` = 'SunOS' ]
then MAIL=Mail
else
MAIL=mailx
fi
;;
[A]* )
xcomqm -D$q_entryname|
(wall || $MAIL -s "xfer $q_entryname" ${login:-${LOGNAME:-root}})
>/dev/null 2>&1
;;
* )
;;
esac
exit 0
xcom.trusted
The xcom.trusted file contains a list of user names and, optionally, group user
IDs that are considered to be valid initiators of trusted transfers. Unicenter
CA-XCOM Data Transport for UNIX and Linux can initiate a transfer with itself
and other platforms and respond to trusted transfers.
An xcom.trusted file must be defined for each trusted transfer expected from a
remote system. The xcom.trusted file allows a transfer to be sent without
specifying a user ID and password, as long as the UNIX or Linux system it is
being transferred to has a system-defined xcom.trusted file, with the same user
ID as the sending system. The user ID specified on the initiating system must
match the user ID of the person logged on to the initiating system. In this case,
even if no user ID or password is provided, the transfer is allowed to proceed.
Entries in the file identify users on the remote system and optional group user
ID. If the optional group user ID is not present, the first user ID will be used to
perform the transfer.
Using xcom.trusted
When Unicenter CA-XCOM for UNIX and Linux detects a trusted transfer, it
searches for and reads the appropriate file into memory and constructs a simple
search index. To improve the speed of this operation, the xcom.trusted file is
broken into many files: one per remote system. The file in the example below is
xcom.trusted.127.0.0.1; it will be used to authenticate trusted transfers from the
system whose IP address is 127.0.0.1.
The xcom.trusted file for each installation of Unicenter CA-XCOM for UNIX or
Linux is in one of the following locations, depending on the conventions of the
particular platform:
■ /var/spool/xcom/trusted
■ /usr/spool/xcom/trusted
■ /var/opt/xcom/trusted
You can have just one trusted file if desired. For example, you can create a file in
the new format called xcom.trusted.all. Then, for each remote partner, the
following command creates a symbolic link to that file.
ln –s xcom.trusted.all xcom.trusted.127.0.0.1
ln –s xcom.trusted.all xcom.trusted.127.0.0.2
ln –s xcom.trusted.all xcom.trusted.127.0.0.3
ln –s xcom.trusted.all xcom.trusted.TSO36
This is particularly useful for testing and for small environments where the size
of the trusted file does not impact performance.
For UNIX or Linux initiated transfers you must specify the TRUSTED parameter
to indicate to the receiving NT, UNIX, or Linux partner that the transfer is to be
considered a trusted transfer. If XCOM_TRUSTED_OVR has been set to Y in the
xcom.glb, the USERID parameter may also be specified to set the user ID that
will be used by the receiving NT, UNIX, or Linux partner.
The following versions of CA-XCOM Data Transport can send and receive
trusted transfers to and from each other:
■ Advantage CA-XCOM Data Transport for Windows NT Server/Professional
Version 3.1
■ Unicenter CA-XCOM Data Transport for Windows NT Server/Professional
r11
■ Any Advantage CA-XCOM Data Transport for UNIX Version 3.1 platform
■ Any Unicenter CA-XCOM Data Transport for UNIX and Linux r11 platform
Note: Versions 3.0 and 3.1 of Advantage CA-XCOM Data Transport for z/OS
support only locally initiated trusted transfers to other trusted enabled
platforms, including Advantage CA-XCOM Data Transport for UNIX Version
3.0.
Sample File
# xcom.trusted
#
# In order to improve the speed of this operation, the xcom.trusted file will
# be broken into many files: one per remote system. The file in the example
# below is xcom.trusted.127.0.0.1; it will be used to authenticate trusted
# transfers from the system whose IP address is 127.0.0.1.
# There will be other instances of the xcom.trusted file with different name
# suffixes to allow trusted transfers to be initiated from many remote systems.
#
# The xcom.trusted file has one line per user. The first user id is the
# one sent by the initiating system. The optional second user id is the
# one that will be used by Unicenter CA-XCOM Data Transport when performing the
transfer on the
# responding system. If the second user id is not present, the first user id
# will be used by the responding system instead.
# Changes to the xcom.trusted file will take effect without having to recycle
xcomd.
#
# For MVS remotely initiated transfers
# The userid of the person submitting the JCL must match a userid in the list
# of userids.
#
# Lines that begin with '#' are treated as comments.
# A comment "#" must be followed by a space or a character.
#
# See the examples below for coding practices.
# comment
volke01
strmi03
dunla01 xcomuser
rudto02 rudtr01
skoje02 xcomuser
dexel01 payroll
oakda01 payroll
#
For each line that begins with a supported printer channel command code,
Unicenter CA-XCOM Data Transport inserts the appropriate number of form
feed and line feed characters.
WRITE NO SPACE
WRITE ONE SPACE
WRITE TWO SPACES
WRITE THREE SPACES
WRITE & SKIP TO CHANEL1-12
All channel commands (that is, Skip to Channel, Write and Skip to Channel) are
translated to a form feed (0C) followed by n-1 line feeds (0A). The Skip to
Channel or Write and Skip to Channel number is represented by n.
Example
Skip to Channel 1 is translated to a form feed (0C) followed by 0 line feeds. Skip
to Channel 2 is translated to a form feed (0C) followed by 1 line feed (0A), and so
on.
Make sure you are familiar with parameter usage before using the commands in
this chapter; for more information, see the chapter “Operating Environment.”
The daemon must also be running before you can perform any transfers.
Unicenter CA-XCOM Data Transport reads the .cnf parameter file specified, or it
reads /usr/spool/xcom/config/xcom.cnf if no file is specified, and any
parameters specified on the command line, and then executes the specified file
transfer.
Unicenter CA-XCOM Data Transport automatically uses the defaults from the
xcom.glb and the specified .cnf files to supply any parameter values not specified
elsewhere.
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.
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 Unicenter CA-XCOM Data
Transport daemon was started.
■ Parameters defined in the specified .cnf file. If a copy of the configuration file
is not found in the current directory, then the file
/usr/spool/xcom/config/xcom.cnf is used. If a .cnf file is specified, the
parameters are not picked up from the xcom.cnf.
■ Parameters defined in the command line following the -f option.
Note: Use a text editor to modify the values in xcom.cnf. All modifications go
into effect the next time a transfer is initiated.
For a description of how parameter values take precedence, see Using Unicenter
CA-XCOM Parameters in the chapter “Operating Environment.” For a complete
list of Unicenter CA-XCOM Data Transport parameters see the appendix
“Parameters.”
Use the following procedure to create configuration files of your own for
different types of transfers:
1. From the command line, copy xcom.cnf to a new file. Enterthe following:
cp /usr/spool/xcom/config/xcom.cnf configfilename.cnf
Example 1
For the complete syntax and options for using xcom62 or xcomtcp, see
Transferring Files in this chapter.
Example 2
In the following example, 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=/usr/bills/july
REMOTE_FILE=BILLS.JULY
Then specify this configuration file to use for the transfer as follows:
xcom62 -c1 -f account.cnf
Transferring Files
This section contains information about performing file transfers from the
command line using xcom62 or xcomtcp. It describes the syntax and options for
these commands, and also contains information about multiple transfers, using
semicolons, and wildcard characters.
■ Use xcom62 or xcomtcp to initiate file transfers from the command line.
■ 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.
Queuing Transfers
Transfers may be queued or not queued. When queued, failed transfers are
retried automatically, depending on the parameters set in the xcom.glb. Multiple
transfers may be sent to a partner simultaneously using SNA or TCP/IP.
When not queued, transfers execute immediately, single-threaded and are not
retried if they fail.
Using xcom62
Using 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.
Multiple Transfers
You may initiate multiple transfers in two ways. You can use the NEWXFER
option of the CONTROL parameter or you can use separate commands from the
command line by placing a semicolon in between each transfer request. For
information on the CONTROL parameter, see the appendix “Parameters.”
Using Semicolons
You can do several transfers from the command line by using the semicolon (;),
the general shell command separator.
Example
In the following example, two files are sent to the remote system, using
semicolons to separate the transfers. The file test1 is sent into file testA and file
test2 is sent into file testB.
xcom62 -c1 -f LOCAL_FILE=test1 REMOTE_FILE=testA; xcom62 -c1
-f LOCAL_FILE=test2 REMOTE_FILE=testB
Wildcard Characters
Unicenter CA-XCOM Data Transport for UNIX and Linux supports the use of
wildcards for local files and remote files.
Syntax
The syntax for using xcom62 and xcomtcp is identical, except for the choice of
command. The syntax for each is shown below.
Options
The following table explains the options available for xcom62 and xcomtcp:
Note: When the shell 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 line.
Option Explanation
-cnumber The type of transfer to be attempted. Valid values for
number are:
Value Description
1 Send file to remote system (default).
Option Explanation
-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 stderr.
-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 line, the parameters on the command line 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= Instead of setting parameters in a file, you can set them on
value...
the command line. The syntax is as follows:
PARAMETER1=value PARAMETER2=value
The value of the parameters must be in uppercase where
appropriate, but the parameter names themselves, with
an underscore character where indicated, are not required
to be in uppercase.
Note: Parameters entered on the command line 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.
-v Sets the transfer version type. Valid values are 1 or 2.
-x Sets the trace level. Valid values are 0 to 10.
Note: The syntax and options for using xcom62 are identical to those for
xcomtcp. For more information, see Transferring Files in this chapter.
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 more information about your platform’s SNA/APPC configuration, see the
appropriate Unicenter CA-XCOM Data Transport Getting Started and the
SNA/APPC vendor documentation.
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
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 syntax and options for using xcomtcp are identical to those for
xcom62. For more information, see Transferring Files in this chapter.
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 for further information.
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.
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 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.
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.
If using 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.
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 appropriate
Unicenter CA-XCOM Data Transport Getting Started for your platform.
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.
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
valueTCPIP 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
Example 2
Note: 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
PROTOCOL
Value Description
SNA For transfers using SNA/APPC communication protocols
TCPIP For transfers using TCP/IP communication protocols
Default: SNA
List of 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.
COMPRESS
Note: All compression types are not supported on all platforms. See the partner
platform documentation for supported compression types.
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
datastream 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.
NO Indicates no compression.
RLE Run length encoding.
YES Indicates run length encoding of binary zeros and blanks
only.
ZLIBn Greater compression than LZRW3 but less than LZSMALL,
LZMEDIUM, and LZLARGE. The n value can be 1 through
9.
Default: YES
DESTINATION_TYPE
DOMAIN
The Windows domain name for use in authenticating the user ID and password
when accessing a Windows based machine that has sharable disks and drives
that belong to that domain. This allows users to access these sharable drives
without having to have a local user ID or password defined to the machine.
Range: 1 to 15 characters.
Default: None
MAXRECLEN
For Windows NT, UNIX, and Linux 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
MAX_REMOTE_TCP
Note: Setting this parameter to 0 prohibits any remote transfers from taking
place.
Range: 0 to 999
Default: 32
REMOTE_SYSTEM
The name of the remote system that receives a file, job, or report.
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. If no
value is specified here, the value in REMOTE_SYSTEM is used.
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. If no value is specified
here, the value in REMOTE_SYSTEM is used.
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. If no value is specified
here, the value in REMOTE_SYSTEM is used.
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
TEMPDIR
Indicates the directory in which temporary files for jobs and reports can be
created.
Range: 1 to 256 characters
Default: /tmp
TRUNCATION
Note: Truncation is not valid for BINARY data or for non-text data received on
the UNIX or Linux platform.
Range: YES or NO
Default: NO
VERSION
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.
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
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.
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
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
Parameters
CREATE_DIR
Value Description
YES Create the directory if it does not exist.
NO Do not create the directory if it does not exist.
Default: YES
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.
Value Description
CREATE Create the PDS/Directory and add the transferred members. If the
PDS/Directory already exists, the transfer fails with an error.
APPEND Add transferred members/files. If the PDS/Directory does not exist
or the member/file already exists, the transfer fails with an error.
REPLACE Add or replace transferred members/files. If the PDS/Directory
does not exist, the transfer fails with error XCOMN0403E Cannot
open output file-No such file or directory.
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 UNIX or Linux file naming
conventions apply.
For wildcard transfers, use an asterisk (*) as a file name to indicate that all files
within the specified directory are to be transferred. For example, the statement
LOCAL_FILE=/NAMES/* indicates that all files under the NAMES directory
are to be transferred.
The actual file name range (not including its path) for wildcard transfers can be
between 0 and 71 characters. This also includes the file extension where
applicable. File names over 71 characters are truncated. However, when sending
files to a mainframe PDS, any file name over 8 characters in length is truncated.
These systems do not recognize file extensions. For example, a file called
longfilename.txt will be truncated to longfile and a file called file.txt will be
truncated to file.
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.
For wildcard transfers, use an asterisk (*) as a file name to indicate and to inform
the receiving partner that multiple files will be sent. For example,
REMOTE_FILE=/PAYROLL/*.
If multiple files are sent and the user specifies a file name, all files received by the
partner are written to that specified file as one single file.
An asterisk used to send files to an IBM mainframe system shows that all files
are to be transferred to a partitioned data set (PDS).
For platforms that support it, you can specify a common file extension to append
to each file name. For example, REMOTE_FILE=/PAYROLL/*.TXT.
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.
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
FILE_OPTION_RF
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.
Value Description
CREATE Create the PDS/Directory and add the transferred members. If the
PDS/Directory already exists, the transfer fails with an error.
APPEND Add transferred members/files. If the PDS/Directory does not exist
or the member/file already exists, the transfer fails with an error.
REPLACE Add or replace transferred members/files. If the PDS/Directory
does not exist, The transfer fails with error XCOMN0403E Cannot
open output file-No such file or directory.
Default: CREATE
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 stdout. All UNIX
or Linux file naming conventions apply.
For wildcard transfers, use an asterisk (*) as a file name to indicate that multiple
files will be received. For example, LOCAL_FILE_RF=/PAYROLL/*.
If multiple files are received and the user specifies a file name, all files received
by the partner are written to that specified file as one single file.
For platforms that support it, you can specify a common file extension to be
appended to each file name. For example,
LOCAL_FILE_RF=/PAYROLL/*.TXT.
REMOTE_FILE_RF
Indicates the name of the file to be retrieved from the remote system.
For wildcard transfers, use an asterisk (*) as a file name to indicate that all files
within the specified PDS/Directory should be transferred. For example, the
statement REMOTE_FILE_RF=/NAMES/* indicates that all files under the
NAMES directory should be transferred.
The actual file name range (not including its path) for wildcard transfers can be
between 0 - 71 characters. This also includes the file extension where applicable.
File names over 71 characters are truncated.
REMOTE_SYSTEM_RF
The name of the remote system that sends a file on a receive file operation. If no
value is specified here, the value in REMOTE_SYSTEM is used.
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
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
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: CYL
BLKSIZE
Default: 800
DATACLAS
Specifies the name of the data class to use when allocating a new SMS-managed
data set.
DSNTYPE
Value Description
LIBRARY Defines a PDSE
PDS Defines a partitioned data set
LRECL
Default: 160
MGMTCLAS
Specifies the name of the management class to use when allocating a new SMS-
managed data set.
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
PRIMARY_ALLOC
Identifies primary storage allocation for a data set created on an IBM mainframe.
Range: 0 to 99999
Default: 1
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:
Default: VB
SECONDARY_ALLOC
SECURE_SOCKET
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 Open SSL socket.
Default: NO
STORCLAS
Specifies the name of the storage class for a new SMS-managed data set.
UNIT
VOLUME
XCOM_CONFIG_SSL
XCOM_SHOW_CIPHER
Value Description
NO Do not display encryption algorithms in the queue detail
information.
YES Display encryption algorithms in the queue detail
information.
Default: NO
Use the following parameters at the command prompt and in configuration files
when IBM Mainframe tape drives are involved in the transfer. 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 xcomtool.
Note: When tape drives are involved in the transfer, it may be necessary to also
use 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
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.
Format: yyddd
Default: None
Note: EXPDT and RETPD are mutually exclusive; specify one or the other.
LABEL
Indicates the type of label associated with a tape data set. The following table
lists the valid values for this parameter.
Value Description
Processing type: Represent the types of processing to be applied to data
AL, AUL, BLP, sets on tape.
LTM, NL, NSL, SL,
SUL
Note: Unicenter CA-XCOM Data Transport for z/OS supports only standard
label tapes.
Example: LABEL=BLP
LABELNUM
Indicates the sequence number of the data set on the tape. The following table
lists the valid values for this parameter.
Value Description
Sequence number This value identifies the sequence number of a data set on
(0001-9999) tape.
Example: LABELNUM=2
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.
TAPE
Indicates to the remote system whether the volume is a tape volume or a disk
file. Yes indicates a tape volume and that mounts are allowed when performing
dynamic allocation. No indicates that the transfer is to a disk file.
Range: YES or NO
Default: NO
TAPEDISP
Specifies the disposition value for MVS tape data sets.
Range: The range of values is listed in the following table:
Value Description
1 New
2 Old
3 Mod
Default: 1
UNITCT
VOLCT
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
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.
Example 1
In the following example, the xcom62 command is used. The configuration file is
/myconfig.cnf, the local report file sent is named /tmp/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=/tmp/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/tmp/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=/tmp/myfile.rpt
HOLDFLAG=YES
Parameters
CARRIAGE_CONTROL_CHARACTERS
Indicates the type of printer carriage-control codes, if any, that are included in
the report file.
Value Description
ASA ASA control codes in column 1.
IBM IBM Machine Characters (valid only for IBM mainframes).
Value Description
BYPASSASA If data is already in ASA format, bypass conversion.
OTHER No carriage-control codes are used.
Default: OTHER
CLASS
If the remote system is an IBM mainframe, this field designates the JES SYSOUT
class.
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
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:
Default: DELETE
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
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.
REMOTE_SYSTEM_SR
The name of the remote system to which a report is sent. If no value is specified
here, the value in REMOTE_SYSTEM is used.
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
This field contains the report title and job number that will be printed on the
report. The field has the following format:
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.
Non-example
REPORT_TITLE=” Job34567”
This is not a valid REPORT_TITLE because the Job Number spans both subfields.
SPOOL_FLAG
Note: If the remote system is an IBM mainframe, this parameter has no effect on
the transfer.
Range: YES or NO
Default: Yes
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 or Linux system, this file could contain
a shell script. For sending to a PC, the file would be a DOS .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 /tmp/myfile.
xcom62 -c3 -f LOCAL_FILE_SJ=/tmp/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 /tmp/myfile.
xcomtcp -c3 -f LOCAL_FILE_SJ=/tmp/myfile
All other necessary parameters are read from the default configuration file
xcom.cnf.
Parameters
LOCAL_FILE_SJ
Indicates the name of the file on the local system to be sent as a job. All the UNIX
or Linux file naming conventions apply. If this value is null or unset, then
Unicenter CA-XCOM Data Transport reads the standard input file.
REMOTE_SYSTEM_SJ
The name of the remote system to which a job is sent. If no value is specified
here, the value in REMOTE_SYSTEM is used.
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
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 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.
Example 1
In the following example, the xcom62 command is used. The configuration file is
/myconfig, the XTRACE parameter is used to set the trace level to 10 to provide
full tracing information and the trace information is written to a trace file.
xcom62 -f /myconfig XTRACE=10
Example 2
In the following example, the xcomtcp command is used. The configuration file
is /myconfig, the XTRACE parameter is used to set the trace level to 10 to provide
full tracing information and the trace information is written to a trace file. The
protocol is specified by the PROTOCOL parameter.
xcomtcp -f /myconfig XTRACE=10 PROTOCOL=TCPIP
Return Codes
For queued transfers, the return code indicates success or failure in queuing the
transfer.
For non-queued transfers the return codes from XCOMTCP and XCOM62 are as
follows:
■ 0 = Transfer successful
■ Non-zero = Transfer failed
The XCOM return code is the same as the error message number, which is
usually a three-digit number. In order to pass back the error message number,
XCOM must make sure the error code is 256 or less, because of system
restrictions. To do this, XCOM subtracts 256 from the error message number if it
is greater than 256. In other words, the return code is modulo 256.
Example
Parameters
XTRACE
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 to 9 plus some additional detailed technical
information.
Default: 0
Example 1
In the following example, the xcom62 command is used. The configuration file is
/tmp/myconfig and the log file is /home/phil/xcom/mylog.
xcom62 -f /tmp/myconfig XLOGFILE=/home/phil/xcom/mylog
Example 2
In the following example, the xcomtcp command is used. The configuration file
is /tmp/myconfig and the log file is /home/phil/xcom/mylog.
xcomtcp -f /tmp/myconfig XLOGFILE=/home/phil/xcom/mylog
Parameters
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/usr/spool/xcom/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: For HP-UX systems these files are in the directory /var/spool/xcom.
For conversions, when transferring text files for transfers initiated on a UNIX or
Linux system, CARRIAGE_FLAG must be set to YES and CODE_FLAG must be
set to EBCDIC.
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.
Parameters
Use the parameters shown below to specify the characteristics of the file and the
data involved in the transfer. For information on using custom character
conversion sets rather than the Unicenter CA-XCOM Data Transport defaults,
see the topic, Creating Custom Character Sets for File Conversion, later in this
chapter.
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.
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
CODE_FLAG
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.
Value Description
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
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 or word processor 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
Unicenter CA-XCOM Data Transport for UNIX or Linux performs the EBCDIC
to ASCII translation as follows:
■ When an EBCDIC code 0 is received, CA-XCOM substitutes the ASCII value
from the first line (line 1) of the table.
■ For EBCDIC code 1, CA-XCOM takes the value from the second line (line 2),
and so on.
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.
Example 1
A question mark (?) must 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
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.
Example 3
You can build a conversion file by customizing a copy of the atoe.tab or etoa.tab
character sets and changing the character translations only where necessary.
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.
The following files are supplied on your distribution media and contain tables
used to map ASCII-to-EBCDIC and EBCDIC-to-ASCII translations:
■ /usr/spool/xcom/convtab/atoe.tab
■ /usr/spool/xcom/convtab/etoa.tab
For HP/UX systems, the following files are supplied on your distribution media
and contain tables used to map ASCII-to-EBCDIC and EBCDIC-to-ASCII
translations:
■ /var/spool/xcom/convtab/atoe.tab
■ /var/spool/xcom/convtab/etoa.tab
For OSF Digital UNIX, the following files are supplied on your distribution
media and contain tables used to map ASCII-to-EBCDIC and EBCDIC-to-ASCII
translations:
■ /var/opt/xcom/convtab/atoe.tab
■ /var/opt/xcom/convtab/etoa.tab
Procedure
To translate all lower case ASCII characters to upper case EBCDIC characters,
follow these steps:
1. From the command line, type
cp /usr/spool/xcom/convtab/atoe.tab conversionfilename
To use a custom character set you must change the parameter values for
INTERNAL_CONVERSION_TABLES and ETOA_FILENAME or
ATOE_FILENAME, or both, in xcom.glb. To activate changes in xcom.glb, you
must restart xcomd.
Procedure
This method is also used when you have two PU 2.0 devices that cannot
communicate directly. They must use the mainframe as an intermediate device,
because a UNIX or Linux system is not an intermediate device. Note that a PU
2.1 device can handle direct transfers with another PU 2.1 device.
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=XCOMMVS 2 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.
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.
When to Use
Use the parameter below with the REMOTE_SYSTEM parameter for store and
forward transfers through an IBM mainframe system. Use store and forward to
send an indirect transfer or to transfer files between two PU 2.0 devices.
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.
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.
Parameters
DOMAIN
The Windows domain name for use in authenticating the user ID and password
when accessing a Windows based machine that has sharable disks and drives
that belong to that domain. This allows users to access these sharable drives
without having to have a local user ID or password defined to the machine.
Range: 1 to 15 characters.
Default: None
PASSWORD
TRUSTED
Allows the user to request a trusted transfer and the partner’s Unicenter
CA-XCOM Data Transport TRUSTED database to be searched to verify the user’s
credentials. This eliminates the need for the user to specify a USERID and
PASSWORD. If XCOM_TRUSTED_OVR is set to NO or no USERID is specified,
the USERID of the process that initiated the transfer is used.
USERID
The user ID which the security system on the remote system checks before
granting access for the file transfer.
Range: 0 to 12 characters
Default: None
to
PARAMETER.ENCRYPTED=ENCRYPTEDVALUE
After encryption:
PASSWORD.ENCRYPTED=12 0F 36 79 65 AB D0 37 ...
Syntax
Options
Option Explanation
- Send output to stdout.
(minus sign) Example: xcomencr input_file -
+ Replace input_file.
(plus sign) Example: xcomencr input_file +
no options Displays help text.
Procedure
To change an encrypted value that is already specified, you must delete all text
after the parameter name and respecify it.
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.
Note: The xcomqm command provides access to information about the transfers
in the queue. For information about using xcomqm, see Managing the Unicenter
CA-XCOM Data Transport Queue in the chapter “Operating Environment.”
Example 1
In the following example, the xcom62 command is used. The transfer request
goes into the queue to execute on July 28, 1999 at one minute after noon.
xcom62 -f QUEUE=YES START_DATE=07/28/99 START_TIME=12:01:00
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 transfer request
goes into the queue to execute on July 28, 1999 at one minute after noon.
xcomtcp -f QUEUE=YES START_DATE=07/28/99 START_TIME=12:01:00
All other necessary parameters are read from the default configuration file,
xcom.cnf.
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
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
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/28/02 indicates February 28, 2002 as the start date.
Format: 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.
Format: hh:mm:ss
Default: None
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.
Parameters
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
LCLNTFYL
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
NOTIFYL
Value Description
WRITE A message is displayed on the workstation where the user is
logged in.
MAIL A mail message will be sent to the user.
NONE No notification is sent.
ALL A message is displayed on all workstations attached to the
server.
Default: None
Note: The L in NOTIFYL indicates that the local system governs the processing
of the resulting notification on that system.
NOTIFY_NAME
The user on the remote system who is to be notified when Unicenter CA-XCOM
Data Transport completes a transfer.
If the remote system is a UNIX or Linux system, the user receives a mail
message.
Range: 0 to 12 characters
Default: None
NOTIFY_TERM
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
WRITE A message is displayed on the screen.
MAIL A mail message is sent to the user.
TSO The specified TSO user is notified.
WTO Unicenter CA-XCOM Data Transport writes to the log only
(WTO).
CICS The specified CICS user is notified.
LU The specified Logical Unit is notified.
ROSCOE Notify Advantage CA-Roscoe user.
NONE No notification is sent.
ALL Write to all users.
Default: None
Note: The R in NOTIFYR indicates that the remote system governs the
processing of the resulting notification on that system.
RMLNTFYL
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
Example 1
All other necessary parameters are read from the default configuration file,
xcom.cnf.
Example 2
All other necessary parameters are read from the default configuration file,
xcom.cnf.
Parameters
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: 0 to 9999
Default: 1000
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
RESTART_SUPPORTED
RETRY_TIME
4 Interface
There are two Unicenter CA-XCOM Data Transport APIs. They are:
■ XcomAPI
■ XcomQAPI
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.
For the location of the xcomapi.h file, see the Unicenter CA-XCOM Data
Transport Getting Started for your platform.
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,
and display detailed information about the queue entries.
Compile and link your programs, then perform the commands shown below,
replacing your_program with the name of your program, as follows:
chown root your_program
chgrp xcomadm your_program
chmod 6755 your_program
These commands set the appropriate access permissions for using Unicenter
CA-XCOM Data Transport with your program.
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 XcomAPI transfers and XcomQAPI requests that are not
combined with an XcomAPI transfer, either set of files is satisfactory.
Sample links for use with both SNA and TCP/IP transfers are provided in the
makefile and qapimake files distributed with Unicenter CA-XCOM Data
Transport. For the locations of the library files and the API source files, see the
Getting Started for your platform.
SNA Libraries
The following libraries are required for performing non-queued SNA transfers:
libxcom.a
libxcomcomp.a
TCP/IP Libraries
Starting States
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 __INCL_XCOMAPI_H
#define __INCL_XCOMAPI_H
#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-retreive ( 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 */
*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 */
*lclntfyl,
*storcls,
*datacls,
*mgtclas,
*dsntype,
/* Reserved for future use */
*seclabel,
*hfs_flag,
/* parameters normally taken from shared memory but may be overwritten in API */
*xlpcmd, /* print command with full path */
*xppcmd, /* postprocess command with full path */
*xprecmd, /* pre-allocation exit command with full path */
*xendcmd, /* ending exit command with full path */
*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 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 */
} XCOM_QUEUE_PARM;
#ifdef _NO_PROTO
int XcomAPI();
#else
int XcomAPI(int invocation_mode,XCOM_PARM xparmblock);
#endif
#ifdef _NO_PROTO
int XcomQAPI();
#else
int XcomQAPI(XCOM_QUEUE_PARM * xqueueblock);
#endif
#endif /* __INCL_XCOMAPI_H */
Member Names
The member names in the following list are used 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.
allocation_type
Value Description
CYL Cylinders
TRK Tracks
BLK Blocks
Default: CYL
blksize
Specifies the block size of the data set created on an IBM mainframe.
Range: 0 to 32767
Default: 800
carriage_control_characters
Indicates the type of printer carriage control codes, if any, that are included in
the report file
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.
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 an MVS-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: 0 to 9999
Default: 1000
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.
Example:
code_flag
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.
Value Description
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.
compress
Note: All compression types are not supported on all platforms. See the partner
platform documentation for supported compression types.
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 datastream
for a matching string.
LZMEDIUM Activates LZ compression to search back 16K in the datastream
for a matching string.
Value Description
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.
NO Indicates no compression.
RLE Run length encoding.
YES Indicates run length encoding of binary zeros and blanks only.
ZLIBn Greater compression than LZRW3 but less than LZSMALL,
LZMEDIUM, and LZLARGE. The value n can be 1 through 9.
Default: YES
convert_classes
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
dataclas
Specifies the name of the data class to be used when allocating a new
SMS-managed data set.
debug_flag
Specifies whether a trace will be output to the file /tmp/<tid> instead of to the
default path /usr/spool/xcom/trace/<tid>.TRA. In addition to the transfer
trace information, the initialization will also be traced. The trace level is still
taken from the variable XTRACE.
Value Description
YES The trace is output to /tmp/<tid>
NO The trace is output to /usr/spool/xcom/trace/<tid>.TRA.
For HP-UX systems: /var/spool/xcom/trace/<tid>.TRA
For OSF Digital UNIX systems: /var/opt/xcom/trace/<tid>.TRA.
Default: NO
den
Specifies the density to be used in creating a tape on the local or remote system.
Valid values are the same as those for the DEN parameter in JCL.
Range: 1 to 4
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:
Default: DELETE
domain
The Windows domain name for use in authenticating the user ID and password
when accessing a Windows based machine that has sharable disks and drives
that belong to that domain. This allows users to access these sharable drives
without having to have a local user ID or password defined to the machine.
Range: 1 to 64 characters
Default: None
dsntype
Value Description
LIBRARY Defines a PDSE
PDS Defines a partitioned data set
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
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, that is, 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.
Format: yyddd
Default: None
Note: EXPDT and RETPD are mutually exclusive; specify one or the other.
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
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.
Default: CREATE
file_type
Value Description
SEND_FILE File transfer
SEND_REPORT Report to be printed
SEND_JOB Job
RECEIVE_FILE Retrieval of a 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 remote system's print
queue, the print control functions depend on the remote system. 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
hold
label
Indicates the type of label associated with a tape data set. The following table
lists the valid values for this parameter.
Value Description
Processing type: Represent the types of processing to be applied to data
AL, AUL, BLP, LTM, sets on tape.
NL, NSL, SL, SUL
Note: Unicenter CA-XCOM Data Transport for z/OS supports only standard
label tapes.
Default: AL
labelnum
Indicates the sequence number of the data set on the tape. The following table
lists the valid values for this parameter.
Value Description
Sequence number This value identifies the sequence number of a data set
(0001-9999) on tape.
Default: 0001
lclntfyl
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
UNIX or Linux file naming conventions apply.
For wildcard transfers, use an asterisk as a file name to indicate that all files
within the specified directory are to be transferred. For example, the statement
"LOCAL_FILE=/NAMES/*" indicates that all files under the NAMES directory
are to be transferred.
The actual file name range (not including its path) for wildcard transfers can be
between 0 - 71 characters. This also includes the file extension where applicable.
File names over 71 characters are truncated. However, when sending files to a
mainframe PDS, any file name over 8 characters in length is truncated. These
systems do not recognize file extensions. For example, a file called
longfilename.txt will be truncated to longfile and a file called file.txt will be
truncated to file.
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 stdout. All UNIX
or Linux file naming conventions apply.
For wildcard transfers, use an asterisk (*) as a file name to indicate that multiple
files will be received. For example, LOCAL_FILE_RF=/PAYROLL/*.
If multiple files are received and the user specifies a file name, all files received
by the partner are written to that specified file as one single file.
For platforms that support it, you can specify a common file extension to be
appended to each file name. For example,
LOCAL_FILE_RF=/PAYROLL/*.TXT.
local_file_sj
Indicates the name of the file on the local system to be sent as a job. All the UNIX
or Linux file naming conventions apply. If this value is null or unset, then
Unicenter CA-XCOM Data Transport reads the standard input file.
local_file_sr
Specifies the 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.
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
Default: 160
maxreclen
For Windows NT, UNIX, and Linux 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 are 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.
notify_name
The user on the remote system who is notified when Unicenter CA-XCOM Data
Transport completes a transfer.
If the remote system is a UNIX or Linux system, the user receives an email
message.
Range: 0 to 12 characters
Default: None
notifyl
Value Description
WRITE A message is displayed on the workstation where the user is
logged in.
MAIL A mail message is sent to the user.
NONE No notification is sent.
ALL A message is displayed on all workstations attached to the
server.
Default: None
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
WRITE A message is displayed on the screen.
MAIL A mail message is sent to the user.
TSO The specified TSO user is notified.
WTO Unicenter CA-XCOM Data Transport writes to the log only
(WTO).
CICS The specified CICS user is notified.
LU The specified Logical Unit is notified.
ROSCOE Notify Advantage CA-Roscoe user.
NONE No notification is sent.
ALL Write to all users.
Default: None
notify_term
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
num_of_dir_blocks
password
primary_alloc
Identifies primary storage allocation for a data set created on an IBM mainframe.
Range: 0 to 99999
Default: 1
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
Value Description
SNA For transfers using SNA/APPC communication protocols
TCPIP For transfers using TCP/IP communication protocols
Default: SNA
queue
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: NO
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
record_format
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. 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.
For wildcard transfers, use an asterisk (*) as a file name to indicate and to inform
the receiving partner that multiple files will be sent. For example,
REMOTE_FILE=/PAYROLL/*.
If multiple files are sent and the user specifies a file name, all files received by the
partner are written to that specified file as one single file.
An asterisk used to send files to an IBM mainframe system shows that all files
are to be transferred to a partitioned data set (PDS).
For platforms that support it, you can specify a common file extension to append
to each file name; for example, REMOTE_FILE=/PAYROLL/*.TXT.
remote_file_rf
Indicates the name of the file to be retrieved from the remote system.
For wildcard transfers, use an asterisk (*) as a file name to indicate that all files
within the specified PDS/Directory should be transferred. For example, the
statement REMOTE_FILE_RF=/NAMES/* indicates that all files under the
NAMES directory should be transferred.
The actual file name range (not including its path) for wildcard transfers can be
between 0 and 71 characters. This also includes the file extension where
applicable. File names over 71 characters are truncated.
remote_system
The name of the remote system that receives a file, job or report.
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
This field contains the report title and job number that will be printed on the
report. The field has the following format:
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 “Parameters.”
restart_supported
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.
secondary_alloc
secure_socket
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
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: /bin/ksh
spool_flag
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.
Format: 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.
Format: hh:mm:ss
Default: None
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: 10
storclas
Specifies the name of the storage class for a new SMS-managed data set.
tape
Indicates to the remote system whether the volume is a tape volume or a disk
file. Yes indicates a tape volume and that mounts are allowed when performing
dynamic allocation. No indicates that the transfer is to a disk file.
Range: YES or NO
Default: NO
tempdir
Indicates the directory in which temporary files for jobs and reports can be
created.
Range: 1 to 256 characters
Default: /tmp
truncation
Note: Truncation is not valid for BINARY data or for non-text data received on
the UNIX or Linux platform.
Range: YES or NO
Default: NO
trusted
Allows the user to request a trusted transfer and the partner’s Unicenter
CA-XCOM Data Transport TRUSTED database to be searched to verify the user’s
credentials. This eliminates the need for the user to specify a USERID and
PASSWORD. If XCOM_TRUSTED_OVR is set to NO or no USERID is specified,
the USERID of the process that initiated the transfer will be used.
unit
unitct
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
version
volct
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
xbuffsize
Specifies the buffer size to determine size of records to be read from UNIX or
Linux files.
xcom_config_ssl
xcom_show_cipher
Value Description
NO Do not display encryption algorithms in the queue detail
information.
YES Display encryption algorithms in the queue detail
information.
Default: NO
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcomend
■ For HP-UX systems: /opt/xcom/lib/xcomend
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcomend
xidest
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
/usr/spool/xcom/xcom.log is used. If you specify this parameter with a
different file name, the logging information is only sent to the specified file.
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcomlp
■ For HP-UX systems: /opt/xcom/lib/xcomlp
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcomlp
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.
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
Note: Not used in Unicenter CA-XCOM Data Transport for RS/6000 SNA
Services or RS/6000 SNA Server.
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
Specifies the 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:
System Value
For UNIX/Linux systems /usr/lib/xcom/xcomntfy
For HP-UX systems /opt/xcom/lib/xcomntfy
For OSF Digital UNIX systems /usr/opt/xcom/lib/xcomntfy
xppcmd
Specifies the path name of the command used for user-defined post processing,
for file transfers only. Only used when the local system is receiving the file.
Range: 0 to 64 characters
Default:
System Value
For UNIX/Linux systems /usr/lib/xcom/xcompp
For HP-UX systems /opt/xcom/lib/xcompp
For OSF Digital UNIX systems /usr/opt/xcom/lib/xcompp
xprecmd
Specifies the 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
System Value
For UNIX/Linux systems /usr/lib/xcom/xcompre
For HP-UX systems /opt/xcom/lib/xcompre
Default: None
xtrace
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 to 9 plus some additional detailed technical
information
Default: 0
Option Parameters
The option parameters in the following list are used to pass and retrieve
information from the queue request.
funccode
Value Description
r Display the release level of xcomqm and exit.
Aentryname Release a held transfer.
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.
Value Description
Tfentryname Force termination of the 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
REMOTE_FILE.
Note: This option can be called only when xcbp->state is
in PREALLOCATION_STATE.
Note: The entryname variable represents the Transaction ID, which is the six-digit
name of the transfer entry in the queue.
tid
queue_open_once
Open queue flag. Define this only once at first call of XcomQAPI. The value
should be set to 0.
nMax_Queue_Entries
trace_level
trace_filename
API Examples
The following API 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. (For the location of this file, see the Unicenter CA-XCOM Data
Transport Getting Started for your platform.)
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.
The following is a C language example of an API that transfers the file named
/usr/include/xcom/xcomapi.h to the file da1ip90.jcl.cntl(ILYA) on the remote
system filbert.
/* apitest.c - This is a sample program for calling the XCOM API.*/
/* Modify this according to your needs and make it */
/* with the sample 'makefile' in this directory. */
#include <stdio.h>
xcomparm.remote_system = "remote_host";
xcomparm.port = "8044";
xcomparm.xluname = "LOCUNIX";
xcomparm.xnodespec = NULL;
xcomparm.xmode = "XCOMMODE";
xcomparm.xidest = NULL;
xcomparm.local_file = "/usr/include/xcom/xcomapi.h";
xcomparm.remote_file = "/home/user/newfile.name";
xcomparm.local_file_rf = "/tmp/receive.filename";
xcomparm.remote_file_rf = "/home/user/file.there";
xcomparm.file_option = "REPLACE";
xcomparm.remove_trail_blanks = NULL;
xcomparm.volume = NULL;
xcomparm.unit = NULL;
xcomparm.record_format = NULL;
xcomparm.lrecl = NULL;
xcomparm.blksize = NULL;
xcomparm.local_file_sr = NULL;
xcomparm.class = NULL;
xcomparm.destination = NULL;
xcomparm.form = NULL;
xcomparm.fcb = NULL;
xcomparm.copies = NULL;
xcomparm.report_title = NULL;
xcomparm.hold = NULL;
xcomparm.spool_flag = NULL;
xcomparm.disposition = NULL;
xcomparm.carriage_control_characters = NULL;
xcomparm.local_file_sj = NULL;
xcomparm.userid = "uuuuuuuu";
xcomparm.password = "xxxxxxxx";
xcomparm.start_time = NULL;
xcomparm.start_date = NULL;
xcomparm.notifyr = NULL;
xcomparm.notify_name = NULL;
xcomparm.local_notify = NULL;
xcomparm.notifyl = NULL;
xcomparm.notify_term = NULL;
xcomparm.maxreclen = NULL;
xcomparm.code_flag = "ASCII";
xcomparm.carriage_flag = NULL;
xcomparm.truncation = NULL;
xcomparm.compress = NULL;
xcomparm.xtrace = "10";
xcomparm.stat_frequency = NULL;
xcomparm.debug_flag = NULL;
xcomparm.xlogfile = NULL;
xcomparm.tempdir = NULL;
xcomparm.xlpcmd = NULL;
xcomparm.xnotifycmd = NULL;
xcomparm.eol_classes = NULL;
xcomparm.convert_classes = NULL;
xcomparm.metacode_classes = NULL;
starting_state=LOCAL_SEND;
printf("==== API started ===\n");
rc=XcomAPI(starting_state, xcomparm);
printf("==== API ended ===\n");
if (!rc)
printf("==== Transfer successful\n");
else
printf("==== %s\n", msgstrng(rc,0));
/* Reset System Privilages for second transfer */
if (XsetSysPriv(2) !=0)
{
printf("====XsetSysPriv() faild\n");
}
The API below 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. (For the location of this file, see the Unicenter CA-XCOM Data
Transport Getting Started for your platform.) 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.
Example
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);
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);
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);
xcomqparm->funccode[0] = 'p';
strcpy(xcomqparm->tid, "000001");
strcpy(xcomqparm->file_option, "CREATE");
strcpy(xcomqparm->lfile, "/home/user/test.txt");
strcpy(xcomqparm->rfile, "/home/user/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);
Code Description
-1 The named file does not exist or is not accessible in the given
mode.
Code Description
AS/400
This section contains information about important aspects of the AS/400
operating system.
Naming Conventions
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.
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 can select specific classes of reports (based on the user, job name, form,
etc.) 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.
z/OS
This section contains information about important aspects of the z/OS operating
system.
Naming Conventions
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 ($, #, @, +, -, :, _).
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: One to eight 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.
Examples
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 to
other systems running Unicenter CA-XCOM Data Transport r11.
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
For more information regarding any of these fields, see the IBM JCL reference
manual.
Additional Features
Novell NetWare
This section contains information about important aspects of the Novell Netware
operating system.
Naming Conventions
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
Unicenter CA-XCOM Data Transport limits the length of this field as indicated
below. The actual name on the destination system may be longer.
Restriction
Unicenter CA-XCOM Data Transport for NetWare LAN does not support library
transfers to Novell NetWare systems.
OpenVMS
This section contains information about important aspects of the OpenVMS
operating system.
Naming Conventions
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.
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.
Restrictions
OS/2
This section contains information about important aspects of the OS/2 operating
system.
Naming Conventions
OS/2 supports the FAT file system as well as the High Performance File System
(HPFS). This section addresses the HPFS format. Use the following format to
name an OS/2 file in the HPFS format:
d:\[directory name]\[..]\filename
Note: Unicenter CA-XCOM Data Transport for OS/2 does not support the
transfer of extended attributes.
The following table defines the parts of an HPFS file name for OS/2:
Part Description
d: A particular device. The C drive is the most common local
hard drive, and the F drive is the most common network
drive. PCs also support a facility in which a section of
memory (RAM) can 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)
If you do not specify a drive, the default (current) drive is
used.
Part Description
directory name One or more optional directories, allowing you to organize
the drive.
Range: Up to 254 characters, including an optional extension
(like a file). If you do not specify a directory, the default
(current) directory is used.
Note: If you specify a destination file name in a directory
that does not exist, Unicenter CA-XCOM Data Transport for
OS/2 creates the directory for you. See the target system’s
configuration to determine if this option has been set.
filename Required.
The name of the data file.
Range: 1 to 254 characters. Separate components of the name
with periods.
Note: Executable binary files end with the extension .EXE,
while executable batch files end with .CMD.
Restrictions
Stratus
This section contains information about important aspects of the Stratus
operating system.
Naming Conventions
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
program .pm payroll.pm, application.pm
module
Part Description
command .cm start_up.cm,
macro compile_and_bind.cm
back up .backup payroll.c.backup
Stratus supports the following file types 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
Tandem
This section contains information about important aspects of the Tandem
operating system.
Naming Conventions
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
Unicenter CA-XCOM Data Transport for Tandem supports the following file
types through ENSCRIBE, Tandem’s disk file architecture:
Edit files
Unstructured files—These 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 (for Replace only)—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.
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
For remotely initiated transfer requests (that is, send a file, job, or report), use the
following:
Note: Key sequence files are supported only if the file exists. You can do a
replace but not a create.
UNIX/Linux
This section contains information about important aspects of the UNIX and
Linux operating systems.
Naming Conventions
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.
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 or Linux file.
Unicenter CA-XCOM Data Transport for UNIX and Linux support their
standard file types.
VM
This section contains information about important aspects of the VM operating
system.
Naming Conventions
Use the following format to name VM files under the CMS operating system:
filename.filetype
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.
Note: You may have two files with the same file name and file type, but they
cannot reside on the same minidisk.
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.
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:
VSE
This section contains information about important aspects of the VCE operating
system.
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.
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)...
Leave this field blank if the data set is owned by the master
catalog.
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.
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:
1. DMYES to force DASDM=YES for this file.
2. DMNO to force DASDM=NO for this file
3. 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 can 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 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).
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.
Part Description
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. The unit
parameter is ignored because tape processing is only supported
when you have a tape manager on your VSE system.
override Optional for output files.
Indicates whether this file should be processed as if the DFLTAB
option for TAPEM were coded as indicated by the override
parameter. The following are the available override parameters and
their equivalent DFLTAB option:
■ TMYES to force TAPEM=YES for this file
■ TMNO to force TAPEM=NO for this file
■ TMEPIC to force TAPEM=EPIC for this file
Note: The override applies only to the processing for the file whose
data set name is on the statement that the override appears on. It is
in effect for this transfer only.
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.
IBM VSE supports VSAM (RRDS, KSDS, and ESDS) and SAM files.
Restrictions
Naming Conventions
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]
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 drive, that is, the
current drive, is used. This directory in Windows changes,
depending on the last application accessed.
directory name 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 directory,
that is, the current directory, is used.
Part Description
filename Required.
The name of the data file.
Range: 1 to 8 characters (characters past position eight generate
an error).
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.
Restrictions
Naming Conventions
Use the following format to name files when using standard Windows NT 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
The following table describes the parts of Windows NT 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 NT makes
no distinction for this. For example, Windows NT would
consider MYFILE and MyFiLe as references to the same file.
Windows NT 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.
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.
Additional Features
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 NT system.
Home Directory A Windows NT user can have a default home directory assigned by the
Windows NT administrator.
Unicenter CA-XCOM Data Transport limits the length of this field as indicated
below. The actual name on the destination system may be longer.
Restrictions
Access to directories and files on drives formatted for NTFS can be controlled
with the security features of Windows NT Version 3.51 or higher.
For more information on using OpenSSL, see Network Security with OpenSSL by
John Vega, Matt Messier, and Pravir Chandra (O’Reilly & Associates).
When establishing the SSL connection, the server sends the server certificate to
the client for verification. After the client verifies the server certificate, the client
sends the client certificate to the server for verification. Both the client and the
server must verify the CA certificate from the other.
Setting up SSL for Unicenter CA-XCOM Data Transport involves the following
tasks:
1. Set the expiration for the CA Certificate.
2. Create the CA Certificate.
3. Create the server certificate.
4. Create the client certificate.
5. Configure the Unicenter CA-XCOM Data Transport SSL server.
6. Configure the Unicenter CA-XCOM Data Transport client.
Setting Expiration
When generating a CA certificate, the default_days parameter in cassl.conf that
controls the expiration of server and client certificates is not used for CA
certificates. The certificate is generated with a default expiration of 30 days.
2. To change the expiration to one year, change the line before running the
makeca script:
Openssl req –x509 –newkey rsa –out ./certs/cassl.pem –outform PEM –days 365
This shell script uses the cassl.conf file to generate a certificate and key file.
The certificate, cassl.pem, is saved in the ‘certs’ subdirectory. The key file,
generated as casslkey.pem, is saved in the ‘private’ subdirectory.
Note: When running the makeca script the first time, the pseudo-random
number generator (PRNG) file does not exist and issues a warning to this
effect. The makeca utility generates the PRNG file the first time it is run and
does not issue this warning on subsequent executions. This is only a
warning; you can continue with the next step.
3. To list the certificate just created, issue the following command to use the
listca script:
./listca
This shell script displays the CA certificate and the information stored in the
package.
The makeserver shell script uses the serverssl.conf file and the cassl.pem file
to generate a server certificate and a key file. The server certificate,
servercert.pem, is saved in the ‘certs’ subdirectory. The key file, generated as
serverkey.pem, is saved in the ‘private’ subdirectory.
3. To list the certificate just created, issue the following command to use the
listserver script:
./listserver
This shell script displays the server certificate and information stored in the
package.
The makeclient shell script uses the clientssl.conf file and the cassl.pem file to
generate a client certificate and a key file. The certificate, clientcert.pem, is
saved in the ‘certs’ subdirectory. The key file, generated as clientkey.pem, is
saved in the ‘private’ subdirectory.
■ To list the certificate just created, issue the following command to use the
listclient script:
./listclient
The listclient shell script displays the client certificate and information stored
in the package.
■ For z/OS, reassemble the default options table and restart the Unicenter
CA-XCOM Data Transport server (started task).
■ For UNIX and Windows, restart the Unicenter CA-XCOM Data
Transport service.
Parameters
A
Use parameter values to control the variables that govern the behavior of
Unicenter CA-XCOM Data Transport.
Parameters A–1
Using Unicenter CA-XCOM Data Transport Parameters
Parameter Format
When using Unicenter CA-XCOM Data Transport from the command prompt or
with a script, and when editing configuration files, 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 new-line
Syntax
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 line as part of a
parameter value, they are stripped by the command line processor (the
shell).
■ When you type trailing spaces and tabs into a file or script with an editor,
such as vi, they are treated as part of a parameter value. These trailing spaces
and tabs should be removed. If they are not removed they can cause
confusion and unpredictable or undesirable results.
■ Empty lines and lines beginning with a pound sign (#) are discarded.
Examples
If you type the following at the command line, 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
List of Parameters
The following is a full list of parameters for Unicenter CA-XCOM Data Transport
for UNIX and Linux. 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.
AGE_TIME
The number of seconds before waiting queue entries are removed from 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)
Parameters A–3
List of Parameters
ALLOCATION_TYPE
Value Description
CYL Cylinders
TRK Tracks
BLK Blocks
Default: CYL
ATOE_FILENAME
The name of the file containing the ASCII-to-EBCDIC character conversion table.
This is a custom file used only for specifying custom translation tables from
ASCII to EBCDIC, if needed.
Range: 0 to 256 characters
Default: /usr/spool/xcom/convtab/atoe.tab, except for the following:
■ For HP-UX systems: /var/spool/xcom/convtab/atoe.tab
■ For OSF Digital UNIX: /var/opt/xcom/convtab/atoe.tab
BLKSIZE
Default: 800
CARRIAGE_CONTROL_CHARACTERS
Indicates the type of printer carriage-control codes, if any, that are included in
the report file.
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.
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 an MVS-style
BDW and RDW preceding each record.
XPACK Indicates a text file with record packing. Uses 31K pack buffer.
Parameters A–5
List of Parameters
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: 0 to 9999
Default: 1000
CLASS
If the remote system is an IBM mainframe, this field designates the JES SYSOUT
class.
CODE_FLAG
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.
Value Description
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.
COMPRESS
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
datastream 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.
Parameters A–7
List of Parameters
Value Description
LZSMALL Activates LZ compression to search back 4K in the
datastream for a matching string.
NO Indicates no compression.
RLE Run length encoding.
YES Indicates run length encoding of binary zeros and blanks
only.
ZLIBn Greater compression than LZRW3 but less than LZSMALL,
LZMEDIUM, and LZLARGE. The n value can be 1 to 9.
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
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
CREATE_DIR
Value Description
YES Create the directory if it does not exist.
NO Do not create the directory if it does not exist.
Default: YES
DATACLAS
Specifies the name of the data class to use when allocating a new SMS-managed
data set.
DEBUG_FLAG
Specifies whether a trace will be output to the file /tmp/<tid> instead of to the
default path /usr/spool/xcom/trace/<tid>.TRA. In addition to the transfer
trace information, the initialization will also be traced. The trace level is still
taken from the variable XTRACE.
Value Description
YES The trace is output to /tmp/<tid>
NO The trace is output to /usr/spool/xcom/trace/<tid>.TRA.
For HP-UX systems: /var/spool/xcom/trace/<tid>.TRA
For OSF Digital UNIX systems: /var/opt/xcom/trace/<tid>.TRA.
Default: NO
Parameters A–9
List of Parameters
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
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
DISPLAY_PASSWORD_IN_TRACE
Value Description
YES Encrypted and plain text passwords are displayed in the
trace files.
ENCRYPT Encrypted passwords are displayed in the trace files.
Value Description
NO Passwords are not displayed in the trace files.
Default: NO
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:
Default: DELETE
DOMAIN
The Windows domain name for use in authenticating the user ID and password
when accessing a Windows based machine that has sharable disks and drives
that belong to that domain. This allows users to access these sharable drives
without having to have a local user ID or password defined to the machine.
Range: 1 to 15 characters
Default: None
DSNTYPE
Value Description
LIBRARY Defines a PDSE
PDS Defines a partitioned data set
Parameters A–11
List of 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 specifying custom translation tables from
EBCDIC to ASCII, if needed.
Range: 1 to 256 characters
Default: /usr/spool/xcom/convtab/etoa.tab, except for the following:
■ For HP-UX systems: /var/spool/xcom/convtab/etoa.tab
■ For OSF Digital UNIX: /var/opt/xcom/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.
Format: yyddd
Default: None
Note: EXPDT and RETPD are mutually exclusive; specify one or the other.
EXPIRATION_TIME
The maximum time, in seconds, that a transaction is held in the transfer queue
after completion. When the maximum time is reached, all references to the
transaction are removed from the queue, including trace files and temporary
files.
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
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.
Parameters A–13
List of Parameters
Value Description
CREATE Create the PDS/Directory and add the transferred members. If
the PDS/Directory already exists, the transfer fails with an error.
APPEND Add transferred members/files. If the PDS/Directory does not
exist or the member/file already exists, the transfer fails with an
error.
REPLACE Add or replace transferred members/files. If the PDS/Directory
does not exist, The transfer fails with error XCOMN0403E
Cannot open output file–No such file or directory.
Default: CREATE
FILE_OPTION_RF
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.
Value Description
CREATE Create the PDS/Directory and add the transferred members. If the
PDS/Directory already exists, the transfer fails with an error.
APPEND Add transferred members/files. If the PDS/Directory does not exist
or the member/file already exists, the transfer fails with an error.
Value Description
REPLACE Add or replace transferred members/files. If the PDS/Directory
does not exist, The transfer fails with error XCOMN0403E Cannot
open output file–No such file or directory.
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
INTERNAL_CONVERSION_TABLES
Value Description
YES Use internal conversion tables.
Parameters A–15
List of Parameters
Value Description
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. The following table
lists the valid values for this parameter.
Value Description
Processing type: Represent the types of processing to be applied to data
AL, AUL, BLP, LTM, sets on tape.
NL, NSL, SL, SUL
Note: Unicenter CA-XCOM Data Transport for z/OS supports only standard
label tapes.
Example: LABEL=BLP
LABELNUM
Indicates the sequence number of the data set on the tape. The following table
lists the valid values for this parameter.
Value Description
Sequence number This value identifies the sequence number of a data set
(0001 to 9999) on tape.
Example: LABELNUM=2
LCLNTFYL
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
UNIX or Linux file naming conventions apply.
For wildcard transfers, use an asterisk as a file name to indicate that all files
within the specified directory are to be transferred. For example, the statement
"LOCAL_FILE=/NAMES/*" indicates that all files under the NAMES directory
are to be transferred.
The actual file name range (not including its path) for wildcard transfers can be
between 0 and 71 characters. This also includes the file extension where
applicable. File names over 71 characters are truncated. However, when sending
files to a mainframe PDS, any file name over 8 characters in length is truncated.
These systems do not recognize file extensions. For example, a file called
longfilename.txt will be truncated to longfile and a file called file.txt will be
truncated to file.
Parameters A–17
List of Parameters
LOCAL_FILE_RF
The file name that is created, appended, or replaced on the local system when it
receives a file. All UNIX or Linux file naming conventions apply. At the
command prompt or in a script, if this value is null or unset, then Unicenter
CA-XCOM Data Transport writes to the stdout.
For wildcard transfers, use an asterisk (*) as a file name to indicate that multiple
files will be received. For example, LOCAL_FILE_RF=/PAYROLL/*.
If multiple files are received and the user specifies a file name, all files received
by the partner are written to that specified file as one single file.
For platforms that support it, you can specify a common file extension to be
appended to each file name. For example,
LOCAL_FILE_RF=/PAYROLL/*.TXT.
LOCAL_FILE_SJ
Indicates the name of the file on the local system to be sent as a job. All the UNIX
or Linux file naming conventions apply. If this value is null or unset, then
Unicenter CA-XCOM Data Transport reads the standard input file.
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.
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
Default: 160
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 32767
Note: The value cannot be set larger than the maximum allowed memory
segment divided by 512.
Default: 50
Parameters A–19
List of Parameters
MAX_REMOTE_TCP
Note: Setting this parameter to 0 prohibits any remote transfers from taking
place.
Range: 0 to 999
Default: 32
MAX_SESSIONS_ENTRIES
The maximum number of partners that can be described in the XCOM.SES file.
Range: 1 to 999
Default: 15
MAXRECLEN
For Windows NT, UNIX, and Linux 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.
NOTIFY_NAME
The user on the remote system who is to be notified when Unicenter CA-XCOM
Data Transport completes a transfer.
If the remote system is a UNIX or Linux system, the user receives an email
message.
Range: 0 to 12 characters
Default: None
NOTIFYL
The local user notification flag. The L in NOTIFYL indicates that the local system
governs the processing of the resulting notification on that system.
Range: The range of values is listed in the following table:
Value Description
WRITE A message is displayed on the workstation where the user is logged
in.
MAIL A mail message is sent to the user.
ALL Write to all users.
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.
Parameters A–21
List of 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
WRITE A message is displayed on the screen.
MAIL A mail message is sent to the user.
TSO The specified TSO user is notified.
WTO Unicenter CA-XCOM Data Transport writes to the log only (WTO).
CICS The specified CICS user is notified.
LU The specified Logical Unit is notified.
ROSCOE Notify Advantage CA-Roscoe user.
ALL Write to all users.
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.
NOTIFY_TERM
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
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
PASSWORD
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
Parameters A–23
List of 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
PROTOCOL
Value Description
SNA For transfers using SNA/APPC communication protocols
TCPIP For transfers using TCP/IP communication protocols
Default: SNA
QUEUE
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.
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
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
Parameters A–25
List of Parameters
RECORD_FORMAT
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. 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.
For wildcard transfers, use an asterisk (*) as a file name to indicate and to inform
the receiving partner that multiple files will be sent. For example,
REMOTE_FILE=/PAYROLL/*.
If multiple files are sent and the user specifies a specific file name, all files
received by the partner are written to that specified file as one single file.
An asterisk used to send to an IBM mainframe system shows that all files are to
be transferred to a partitioned data set (PDS).
For platforms that support it, you can specify a common file extension to append
to each file name. For example, "REMOTE_FILE=/PAYROLL/*.TXT".
Parameters A–27
List of Parameters
REMOTE_FILE_RF
Indicates the name of the file to be retrieved from the remote system.
For wildcard transfers, use an asterisk (*) as a file name to indicate that all files
within the specified PDS/Directory should be transferred. For example, the
statement REMOTE_FILE_RF=/NAMES/* indicates that all files under the
NAMES directory should be transferred.
The actual file name range (not including its path) for wildcard transfers can be
between 0 and 71 characters. This also includes the file extension where
applicable. File names over 71 characters are truncated.
REMOTE_SYSTEM
The name of the remote system that receives a file, job or report.
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. If no
value is specified here, the value in REMOTE_SYSTEM is used.
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. If no value is specified
here, the value in REMOTE_SYSTEM is used.
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. If no value is specified
here, the value in REMOTE_SYSTEM is used.
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
Parameters A–29
List of Parameters
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
This field contains the report title and job number that will be printed on the
report. The field has the following format:
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.
Non-example
REPORT_TITLE=” Job34567”
This is not a valid REPORT_TITLE because the Job Number spans both sub
fields.
RESTART_SUPPORTED
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
SAVE_PASSWORD_IN_CNF
Determines if the xcomtool GUI saves the password in the .CNF file.
Range: The range of values is listed in the following table:
Value Description
YES The xcomtool GUI saves the password in the .CNF file in
encrypted format.
NO The xcomtool GUI does not save the password in the .CNF
file and blanks the password field out after each operation.
Parameters A–31
List of Parameters
Default: NO
SECONDARY_ALLOC
SECURE_SOCKET
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
SESSIONS_FILE
The path name of the xcom.ses file, which tells Unicenter CA-XCOM Data
Transport how many sessions can be used by a single LU.
Range: 0 to 256 characters
Default: /usr/spool/xcom/config/xcom.ses, except for the following:
■ For HP-UX systems: /var/spool/xcom/config/xcom.ses
■ For OSF Digital UNIX systems: /var/opt/xcom/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: /bin/ksh
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
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
Parameters A–33
List of Parameters
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
SPOOL_FLAG
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/28/99 indicates February 28, 1999 as the start date.
Format: 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.
Format: hh:mm:ss
Default: None
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: 10
STORCLAS
Specifies the name of the storage class for a new SMS-managed data set.
SYSTEM_USER_DATA
TAPE
Indicates to the remote system whether the volume is a tape volume or a disk
file. Yes indicates a tape volume and that mounts are allowed when performing
dynamic allocation. No indicates that the transfer is to a disk file.
Range: YES or NO
Default: None
Parameters A–35
List of Parameters
TCP_CMD
Path and name of the Unicenter CA-XCOM Data Transport program started by
the XCOMD service that is used for queued locally initiated transfers, and for all
remotely initiated transfers for TCP/IP protocols.
Range: 0 to 256
Default: /usr/lib/xcom/xcomtcp, except for the following:
■ For HP-UX systems: /opt/xcom/lib/xcomtcp
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcomtcp
TEMPDIR
Indicates the directory in which temporary files for jobs and reports can be
created.
Range: 1 to 256 characters
Default: /tmp
TP_CMD
TRACE_PATH
TRANSFER_NAME
Allows a user to assign a name to a transfer. This name is also available to the
remote Unicenter CA-XCOM Data Transport system. In addition, if the remote
Unicenter CA-XCOM Data Transport system has defined a transfer identifier,
that name is available to the local Unicenter CA-XCOM Data Transport for UNIX
or Linux system. When received, the transfer identifier is displayed in the
xcomqm display if the -D option is used, and is labeled Transfer name. The
equivalent to this parameter on MVS is the transfer identifier (XFERID).
Range: 0 to 10 characters
Default: None
TRANSFER_TYPE
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
Parameters A–37
List of Parameters
TRANSFER_USER_DATA
TRUNCATION
Note: Truncation is not valid for BINARY data or for non-text data received on
the UNIX or Linux platform.
Range: YES or NO
Default: NO
TRUSTED
Allows the user to request a trusted transfer and the partner’s Unicenter
CA-XCOM Data Transport TRUSTED database to be searched to verify the user’s
credentials. This eliminates the need for the user to specify a USERID and
PASSWORD. If XCOM_TRUSTED_OVR is set to NO or no USERID is specified,
the USERID of the process that initiated the transfer will be used.
TRUSTED_PATH
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
TXPI_RECEIVE_TIMEOUT
Maximum wait time, in seconds, that this Unicenter CA-XCOM Data Transport
waits to receive from the partner system. If a value of 0 is specified, it waits
indefinitely. Use for TCP/IP transfers only.
Range: 0 to 999 seconds
Default: 0
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
Parameters A–39
List of Parameters
UMASK
Used to set the permissions assigned to a file when the file is being created and
received on the system for the first time. The value is expressed as an octal
number (base 8). The octal number has the same meaning as in the standard
umask command.
Range: 000 to 777
Default: 022
UNIT
UNITCT
Specifies the number of units to be allocated on the remote system. This is a tape
parameter and is used when the partner is an IBM mainframe.
Range: 1 to 20
Default: None
UNIT_RF
Specifies the unit from which a dataset is to be retrieved from an IBM mainframe.
Range: 0 to 6 characters
Default: None
USE_TP_SECURITY
Only for NCR systems using SNA. When set to YES, Unicenter CA-XCOM Data
Transport instructs the APPC to send out the user ID and password in the APPC
attach request.
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
VERSION
VOLCT
VOLUME
VOLUME_RF
Parameters A–41
List of Parameters
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
XCOM_CONFIG_SSL
XCOM_PASSWORD
XCOM_SHOW_CIPHER
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_TRUSTED_OVR
Specifies if the user is permitted to override the user ID by using the USERID
parameter for locally initiated trusted transfers. If XCOM_TRUSTED_OVR is set
to YES, the user is permitted to override the user ID by using the USERID
parameter. If it is set to NO, the user ID of the process that initiated the transfer is
used.
Range: YES, NO, Y, N
Default: NO
XCOM_USERID
XCOMPRE_LOCAL
Indicates whether the xcompre script file for a locally initiated transfer should be
run.
Default: NO
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcomend
■ For HP-UX systems: /opt/xcom/lib/xcomend
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcomend
Parameters A–43
List of 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.
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/usr/spool/xcom/xcom.log is used. If you specify this parameter with a
different file name, the logging information is only sent to the specified file.
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcomlp
■ For HP-UX systems: /opt/xcom/lib/xcomlp
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcomlp
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.
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
Note: Not used in Unicenter CA-XCOM Data Transport for RS/6000 SNA
Services or RS/6000 SNA Server.
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcomntfy
■ For HP-UX systems: /opt/xcom/lib/xcomntfy
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcomntfy
Parameters A–45
List of Parameters
XPPCMD
Path name of the command used for user-defined post processing, for file
transfers only. Only used when the local system is receiving the file.
Range: 0 to 64 characters
Default:
■ For UNIX/Linux systems: /usr/lib/xcom/xcompp
■ For HP-UX systems: /opt/xcom/lib/xcompp
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcompp
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:
■ For UNIX/Linux systems: /usr/lib/xcom/xcompre
■ For HP-UX systems: /opt/xcom/lib/xcompre
■ For OSF Digital UNIX systems: /usr/opt/xcom/lib/xcompre
XTRACE
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 to 9 plus some additional detailed technical
information
Default: 0
Messages
B
The messages contained in this section are written to a specified log file on the
local system (see the XLOGFILE parameter). Some messages are also displayed
on the user’s terminal and sent to the remote system. The messages are listed in
ascending order.
Error Messages
Messages with numbers ranging from 0 to 255 are informational or prompt
messages. Messages numbering between 100 and 255 represent Unicenter
CA-XCOM Data Transport states and are used in traces, and so on. Message
numbers of 256 and above are error messages. The following is an example of a
Unicenter CA-XCOM Data Transport message:
XCOMU0010I XCOM62 STARTING TRANSFER
Message ID Content
The first four characters of the message ID, XCOM, are constant. The Unicenter
CA-XCOM Data Transport system that generated the message is indicated by the
fifth character of the message ID. The system identifier convention of the fifth
character is as follows:
Character Explanation
Position
1-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, and OpenVMS VAX
E IBM VSE
Messages B–1
Error Messages
Character Explanation
Position
K IBM CICS
M IBM z/OS
N Windows NT
R Netware
S IBM AS/400
T Tandem
U UNIX/Linux
V IBM VM
W Windows
8 IBM Stratus Computer
Note: Some of the system identifiers in this list represent systems
that are supported for existing customers but are no longer
generally available. See the chapter, "Introduction,” for a list of
currently available Unicenter CA-XCOM Data Transport
platforms.
6-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
The following pages list messages that Unicenter CA-XCOM Data Transport can
return in response to job requests, with explanations and recommended user
actions, where appropriate. In the list, the four-character constant (XCOM) and
the component identifier (in our case, U for UNIX or Linux), have been deleted
from each message ID. The messages are listed in numerical order.
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.
Reason:
Action:
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 required.
Messages B–3
List of Messages
Reason:
This message marks the completion of a locally initiated transfer. It placed in the
log and written to standard error at the end of a transfer.
Action:
None required.
Reason:
Action:
None required.
Reason:
The transfer has expired and has been removed from the queue.
Action:
None required.
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 required.
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 required.
Reason:
Action:
None required.
Reason:
Action:
None required.
Reason:
Action:
None required.
Messages B–5
List of Messages
Reason:
Action:
None required.
Reason:
Action:
None required.
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 indicates that the
transferred job did not complete before the DAEMON_TIMEOUT period
expired.
Action:
Retry the transfer. This message may indicate the failure of a system call in a
sendjob or in a pre or post processing script. If the problem persists, take a trace
and contact Computer Associates Customer Support.
Reason:
Action:
None required.
Reason:
Action:
Reason:
Action:
Make sure xcomd is running. Use the xcom62 command for transfers using
SNA/APPC protocols.
0046I CONFIRMED_CHECKPOINT
Reason:
Action:
None provided.
Reason:
Action:
None required. This message is used to report the state of the Unicenter
CA-XCOM Data Transport transaction program.
Messages B–7
List of Messages
Reason:
The transfer was held from starting at the time for which it was scheduled.
Action:
None required. This message is used to report the state of the Unicenter
CA-XCOM Data Transport transaction program.
Reason:
The transfer was released to start at the time for which it was scheduled.
Action:
None required.
Reason:
This is a warning message allowing you one last chance before forcefully
bringing down the Unicenter CA-XCOM Data Transport scheduler.
Action:
Respond with y if you want to stop the daemon. Any other reply will not stop
the process.
Reason:
Action:
Reason:
Action:
Reason:
A user has requested that the Unicenter CA-XCOM Data Transport scheduler to
stop gracefully.
Action:
None required.
Reason:
A user has requested that the Unicenter CA-XCOM Data Transport scheduler,
xcomd, stop, and that request has been received by the running daemon process.
Action:
None required.
Reason:
The Unicenter CA-XCOM Data Transport scheduler has rejected a user’s request
to stop. Unicenter CA-XCOM Data Transport scheduler cannot be stopped while
there are started or active transfers in the queue.
Action:
Messages B–9
List of Messages
Reason:
Action:
None required.
Reason:
Some parameters cannot be taken from the configuration file. This may be caused
by the following reasons: - the configuration file contains errors or invalid
parameters. - 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 configuration file. Otherwise,
reply ‘ok’.
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.
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:
Reason:
Action:
None required.
Reason:
Action:
None required.
Reason:
Action:
None required.
Messages B–11
List of Messages
Reason:
Action:
None required.
0100I XEXIT
Reason:
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.
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:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0106I GET_ALLOCATE
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0107I DEALLOCATE_CONVERSATION
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages B–13
List of Messages
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:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
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:
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.
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.
Messages B–15
List of Messages
0115I TRAILER_CONFIRM
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0116I RECEIVE_HEADER
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0117I CONFIRM_HEADER
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0118I RECEIVE_MAXLRECL
Reason:
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 this 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.
0120I DATA_CONFIRMED
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages B–17
List of Messages
0121I RECEIVE_TRAILER
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0122I TRAILER_CONFIRMED
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
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:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0127I TP_DONE
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0128I RECEIVE_FEATURE_RECORD
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0129I SEND_FILE_DESCRIPTOR
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages B–19
List of Messages
0130I REQUEST_FEATURE_RECORD_CONFIRM
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0131I CONFIRMED_FEATURE_RECORD
Reason:
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.
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:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0155I REMOTE_RECEIVE
Reason:
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:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages B–21
List of Messages
0157I OPEN_LOCAL_INPUT_FILE
Reason:
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.
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
indirect 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 indirect transfer protocol.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages B–23
List of Messages
0164I RECEIVE_OVERLAY
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0165I DO_SYSTEM
Reason:
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:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0168I DO_COMMAND
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0169I SEND_FEATURE_RECORD
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0170I RECEIVE_FILE_DESCRIPTOR
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0171I RESTART_TRANSFER
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0172I CHECKPOINT_CONFIRM_REQUEST
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages B–25
List of Messages
Reason:
Action:
0180I SENDING_ERROR
Reason:
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:
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:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0187I TRANSFER_FAILED
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0188I CHECK_RETURN_CODES
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages B–27
List of Messages
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:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0202I LOCAL_NOTE_ATTACH
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0203I ALLOCATE_NOTE_CONVERSATION
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0204I SENDING_NOTE_DATA
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0205I DATA_NOTE_CONFIRM
Reason:
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Reason:
Action:
Messages B–29
List of Messages
Reason:
Action:
Reason:
Action:
Reason:
Action:
Reason:
Action:
Reason:
Action:
Reason:
An error was encountered when trying to increase the send buffer size using
realloc() call.
Action:
Reason:
Cannot create an additional 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.
Reason:
An error occurred in creating a pipe. File descriptors are not available to open a
UNIX or Linux pipe. You may have exceeded the limit on the number of open
files you are allowed.
Action:
Messages B–31
List of Messages
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. Use fully qualified
filenames.
Reason:
Action:
Check that the remotely requested user ID is valid on the partner system and that
the initiator has entered it and the password for it correctly. Check the case for
the password.
Reason:
A call to system() has failed. This function is used to initiate command functions
from within Unicenter CA-XCOM Data Transport.
Action:
The transfer was successful but the send job or a script failed. Retry the transfer.
If the problem persists, take a Unicenter CA-XCOM Data Transport trace and
contact Computer Associates Customer Support.
Reason:
A command issued using the system() call has returned a non-zero completion
code. A send job failed when the job was submitted on the remote partner. The
transfer to send the job was successful, however.
Action:
Retry the transfer. Put debugging statements in the job. See the sample post-
processing scripts for debugging statements. If the problem persists, contact
Computer Associates Customer Support.
Reason:
Action:
Retry the transfer. This may be due to a network problem. If the error persists,
contact your network administrator or Computer Associates Customer Support.
Messages B–33
List of Messages
Reason:
An error has occurred while attempting to send the overlay record for an indirect
file transfer.
Action:
Check the SNA connectivity and retry. If the problem persists, contact Computer
Associates Customer Support.
Reason:
An error was encountered while sending 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.
Reason:
Action:
Check the SNA connectivity and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Reason:
The remote Unicenter CA-XCOM Data Transport transaction program did 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.
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. For
transfers using TCP/IP protocols, refer to the common return codes and
explanations listed in the system errno.h file.
Action:
Check that the remote transaction program can be allocated. On z/OS and
OS/390, this means that the APPL is active. On other systems, there are different
criteria for accessibility.
Check that the listener is running on the remote system for TCP/IP transfers and
is listening on the specified port.
Reason:
Action:
This is frequently an SNA configuration problem. 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.
Reason:
Action:
Check the SNA configuration and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Messages B–35
List of Messages
Reason:
Action:
Reason:
Action:
Check the existence and permissions on the file you have specified.
Reason:
Action:
Check the SNA connectivity and retry. If the problem persists, contact Computer
Associates Customer Support.
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 MAXRECLEN parameter and retry. If the problem persists, contact
Computer Associates Customer Support.
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.
Reason:
An error occurred while reading the input file. The system call read() returned -1.
The error number displayed is the value of the system variable errno.
Action:
Check the descriptive message, fix the problem, and retry the transfer. If the
problem persists, contact Computer Associates Customer Support.
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.
Messages B–37
List of Messages
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.
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.
Reason:
Action:
Check that the target file is not open or locked. Contact Computer Associates
Customer Support.
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.
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.
Reason:
Action:
Retry the transfer. If the error persists, contact your network administrator or
Computer Associates Customer Support.
Reason:
Action:
Possible network problems. Try turning off checkpointing. Check the SNA
connectivity and retry the transfer. If the problem persists, contact Computer
Associates Customer Support.
Reason:
Action:
Check the SNA connectivity and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Messages B–39
List of Messages
Reason:
Action:
Check the SNA connectivity and retry. If the problem persists, contact Computer
Associates Customer Support.
Reason:
Action:
Check for errors in the user customized script specified by the XPRECMD
parameter. The sample script provided is xcompre.
Reason:
Action:
Check the problem reported by the descriptive message, fix the problem, and
retry the transfer.
Reason:
Action:
Check the SNA connectivity and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Reason:
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:
Action:
Check the SNA connectivity and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Reason:
Action:
Reason:
Action:
Check the SNA connectivity and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Messages B–41
List of Messages
0409E Error encountered trying to confirm feature negotiation record: Descriptive message
Reason:
Action:
Reason:
Action:
Check the SNA connectivity and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Reason:
Action:
Check the SNA connectivity and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Reason:
An error was detected by the SNA APPC receive and wait verb or TCP/IP while
reading incoming data.
Action:
Check the TCP/IP or SNA connectivity and retry the transfer. If the problem
persists, contact Computer Associates Customer Support.
Reason:
The count in the received trailer record did not match the actual number of
records received.
Action:
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.
Reason:
The write() system call has returned a -1. This probably means that the file
system is out of space or that the user’s file size limit has been exceeded.
Action:
Check the free space in the file system. If free space is not the problem, check the
size of the user’s ulimit (file size limit) and compare it to the size of the file that
caused the transfer to fail. Repair the problem and retry the transfer.
If you are transferring files larger than 2 GB, make sure your version of Unicenter
CA-XCOM Data Transport supports large file sizes.
Messages B–43
List of Messages
Reason:
An interrupt signal has been received and transmission has been interrupted.
Action:
Reason:
Action:
Reason:
Action:
Check the SNA connectivity and retry the transfer. If the problem persists,
contact Computer Associates Customer Support.
Reason:
Action:
Decide whether you want to replace the target file or create one using a different
name. Set the parameters appropriately and retry the transfer.
Reason:
When trying to reposition a file to restart a transfer, the fseek() call returned a -1.
This usually indicates a file that has been updated since its transfer was
interrupted.
Action:
Determine why the file was updated and/or retry the transfer.
Reason:
Action:
None required. The transfer will restart from the beginning of the file.
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.
Reason:
Action:
Wait until a session becomes available or increase the session limits in the
xcom.ses file, restart xcomd, and retry the transfer.
Messages B–45
List of Messages
Reason:
Action:
Reason:
The length of a file record is greater than the length of the input buffer.
Action:
Check for correct file type. May also need to increase MAXRECLEN. 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:
Make sure you are specifying the correct parameters for the file and retry.
Reason:
Action:
Reason:
Action:
Retry the transfer. If the problem persists, run a trace and contact Computer
Associates Customer Support.
Reason:
A restart request was received from the remote side, but the request IDs do not
match.
Action:
Reason:
A restart request was received from the remote side, but the local filenames do
not match.
Action:
Retry the transfer. If the problem persists, run a trace and contact Computer
Associates Customer Support.
Messages B–47
List of Messages
Reason:
A restart request was received from the remote side, but the remote group names
do not match.
Action:
Reason:
Action:
Check that the remote system is generating a packing type that corresponds to a
Unicenter CA-XCOM Data Transport supported packing type: YES, NO,
MPACK or XPACK. For AT&T or NCR systems, the value of the mode definition
code set field must be set to A for ASCII. If PACK=LENGTH is specified,
RECSEP=NO must also be specified.
Reason:
The XCOM API program may have been compiled with a different version of
Unicenter CA-XCOM Data Transport than what is running.
Action:
Make sure the XCOM API program was compiled at the level of Unicenter
CA-XCOM Data Transport that you are running.
Reason:
Action:
Try the transfer again and if the error persists, contact Computer Associates
Customer Support.
Reason:
The transfer was not scheduled because the starting date cannot be parsed.
Action:
Reason:
The transfer was not scheduled because the starting time cannot be parsed.
Action:
Reason:
Action:
Check that the EBCDIC to ASCII conversion table file specified in the global
variable ETOA_FILENAME exists and is readable.
Messages B–49
List of Messages
Reason:
Action:
Check that the ASCII to EBCDIC conversion table file specified in the global
variable ATOE_FILENAME exists and is readable.
Reason:
Action:
Check the EBCDIC to ASCII file. It must be 256 lines long and contain a single
integer per line specified according to C conventions: a leading 0 indicates an
octal number, a leading 0x indicates a hexadecimal; anything else is decimal.
Reason:
Action:
Check the ASCII to EBCDIC file. It must be 256 lines long and contain a single
integer per line specified according to C conventions: a leading 0 indicates an
octal number, a leading 0x indicates a hexadecimal; anything else is decimal.
Reason:
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 MAX_QUEUE_ENTRIES and/or decrease
EXPIRATION_TIME and restart xcomd. If the reason is ‘cannot close data file,’
then the file system is full. Issue a df -v command to list file systems and check to
see which file system is full, and then clear disk space as needed. If the problem
persists, contact Computer Associates Customer Support.
Reason:
The Unicenter CA-XCOM Data Transport queue manager cannot get shared
memory.
Action:
Increase shared memory. Retry the transfer. If the problem persists, contact
Computer Associates Customer Support.
Reason:
The Unicenter CA-XCOM Data Transport queue manager cannot allocate shared
memory.
Action:
Messages B–51
List of Messages
Reason:
The Unicenter CA-XCOM Data Transport queue manager cannot create shared
memory.
Action:
Reason:
Action:
Check the xcom.glb file to be sure that pathnames have been specified for each of
the variables listed in the Explanation. Restart the daemon after you fix any
problems.
Reason:
Action:
Reason:
Action:
Reason:
Action:
Reason:
Action:
Try to start the Unicenter CA-XCOM Data Transport daemon. 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. Reinstall the Unicenter CA-XCOM Data
Transport package, if necessary.
Reason:
Action:
Messages B–53
List of Messages
Reason:
Action:
Reason:
Action:
Reason:
Action:
Check the xcom.glb file and fix any syntax errors you find there. Make sure the
xcom.tid contains a non-zero six-digit number, the next transfer ID number. Edit
and correct if necessary. Restart the Unicenter CA-XCOM Data Transport
daemon.
Reason:
Action:
0475E xcomd index file 000025.IDX is bigger than allowed for maximum number of queue
entries (xx bytes).
Reason:
The xcomd index file 000025.IDX is bigger than allowed for maximum number of
queue entries (xx bytes). The MAX_QUEUE_ENTRIES parameter in xcom.glb
may have been reduced.
Action:
0476E Error reading xcomd index file 000025.IDX, records read xx.
Reason:
When reading records from the 000025.IDX file an error occurred at record
number xx.
Action:
Try restarting xcomd. If the error persists, remove all files in the Q directory and
restart xcomd.
0477E xcomd index file 000025.IDX size (xx bytes) not a multiple of record size.
Reason:
The xcomd index file 000025.IDX size must be a multiple of the record size,
otherwise a corrupt file is assumed.
Action:
Messages B–55
List of Messages
0478E xcomd index file 000025.IDX contains a corrupt TID at index record xx.
Reason:
TID must be six digits. The index record contains something other than digits.
The 000025.IDX file got corrupted.
Action:
Reason:
Either the system or the user process limit has been reached and no additional
processes can be created.
Action:
Stop some processes, or raise process limits, and retry the operation.
Reason:
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.
Reason:
When the local input file is not specified, Unicenter CA-XCOM Data Transport
normally uses console input stream (stdin). This message indicates that stdin
cannot be used for this transfer.
Action:
Reason:
When the local output file is not specified, Unicenter CA-XCOM Data Transport
normally uses console output stream (stdout). This message indicates that stdout
cannot be used for this transfer.
Action:
0491E Versions of different Unicenter CA-XCOM Data Transport components are not
compatible.
Reason:
The versions of the Unicenter CA-XCOM Data Transport modules are not
compatible.
Action:
Reason:
Since the maximum block size for packing is 2048 bytes, MAXRECLEN should
not exceed this limit if record packing is turned on.
Action:
Change MAXRECLEN so that it is not greater than 2048 bytes or turn off record
packing.
Messages B–57
List of Messages
Reason:
Action:
Reason:
Action:
Reason:
Action:
Reason:
Action:
Reason:
Action:
Reason:
Action:
Check that the SNA APPC is up. Verify that XNODESPEC and XLUNAME are
set correctly in xcom.glb.
Reason:
Action:
Retry the transfer. If the error persists, contact Computer Associates Customer
Support.
Messages B–59
List of Messages
Reason:
An interrupt signal has been received from APPC (for SNA) or TCP/IP (for
TCP/IP) and transmission has been interrupted.
Action:
Reason:
While unpacking data an error occurred. This can be due to incorrect data
coming from the remote system.
Action:
Reason:
Unicenter CA-XCOM Data Transport was unable to rename the temporary file to
the permanent file name.
Action:
Retry the transfer and if the error persists, contact Computer Associates
Customer Support.
Reason:
Action:
Reason:
The remote system does not support the big packing type.
Action:
Reason:
Version 1 transfers are supported for compatibility with old releases of Unicenter
CA-XCOM Data Transport. Big packing was not supported in these old releases.
Action:
Specify version 2 to use big packing. If the remote partner does not support
version 2, retry the transfer using record packing type Y, M, or N.
Reason:
Applies only to AIX RS/6000 systems. This error can occur when a TP is not
available or because of a resource failure.
Action:
Messages B–61
List of Messages
Reason:
Action:
Either increase the value of MAX_REMOTE_TCP and recycle xcomd or run less
concurrent remote TCP/IP transfers.
Reason:
Action:
Reason:
Action:
Try the transfer again. If the error persists, contact Computer Associates
Customer Support.
Reason:
The operation which caused this message is applicable to active transfers only.
Action:
Reason:
You do not have security rights necessary to perform the operation which caused
this message.
Action:
None
Reason:
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. If the reason is “cannot generate TID”, contact Computer Associates
Customer Support. Other reasons may also be displayed. Try the operation
again. If you cannot resolve the error, contact Computer Associates Customer
Support.
Reason:
The operation that caused this message requires that TP be in some particular
state. The current TP state is invalid for this operation.
Action:
Messages B–63
List of Messages
Reason:
Action:
Log off some of the clients or wait for clients to log off.
Reason:
A client with the same XPE name is already logged onto the server.
Action:
Reason:
A client submitted a request that is not supported by the server. The server will
ignore this request.
Action:
A server upgrade may be required. Try the transfer again. If the error persists,
contact Computer Associates Customer Support.
Reason:
Server removed client from the list of logged clients because of timeout waiting
for SEND_COMPLETE event.
Action:
Check the client for possible problems. Check with your administrator.
Reason:
Action:
Reason:
Communication error.
Action:
Reason:
Action:
Be sure that the input file is in the right format—that it was received specifying
the CARRIAGE_FLAG=VLR/VLR2 parameter.
Reason:
Action:
None
Messages B–65
List of Messages
Reason:
Action:
None
Reason:
Action:
None
Reason:
Action:
None
Reason:
Action:
None
Reason:
A request for a Secure TCP/IP remote connection was received from a remote
partner.
Action:
None
Reason:
Secure Socket (SSL) negotiation for the connection successfully completed. The
connection is now a Secure TCP/IP connection.
Action:
None
Reason:
A request for a Secure TCP/IP connection was sent to the remote partner.
Action:
None
Reason:
Action:
None
Messages B–67
Appendix
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.
This appendix contains information about logical units (LUs) and network
concepts that you need to understand to operate Unicenter CA-XCOM Data
Transport when performing transfers using SNA/APPC protocols.
LU Sessions
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.
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.
Session Identifier
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
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 which was used to drive
printers attached to 3274 cluster controllers. Today it is still used to
support old hardware.
4 This protocol was intended to be used 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.
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.
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 will 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).
An independent logical unit can have an LU 6.2 session with a dependent LU.
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 appear as PU
2.0. Once they become active, they display as PU 2.1.
Using xcomtool
D
xcomtool is the MOTIF-based Graphical User Interface (GUI) that allows you to
do the following:
■ Specify transfer type
■ Initiate transfers
■ Control SNA (on applicable systems)
■ Specify protocols for SNA or TCP/IP transfers
■ Monitor the log and trace functions
■ Update the status of active and pending transfers
■ Edit Unicenter CA-XCOM Data Transport configuration files
This appendix contains information about using xcomtool and procedures for
performing transfers.
Starting xcomtool
xcomtool is started from the shell prompt. All operations performed from the
command line interface can be performed with xcomtool.
where -d display invokes xcomtool using the display defined in the display
parameter.
The About xcomtool banner displays, and then the xcomtool Main window
displays:
Four distinct control windows (one for each transfer type) can be accessed from
the Main window menu to initiate the following types of transfer:
■ Send File
■ Send Job
■ Send Report
■ Receive File
For information about using Drag and Drop Processing, see Drag and Drop
Processing in this appendix.
To access the xcomtool Main window menu bar, follow these steps:
1. From the xcomtool Main window, click the Window pull-down menu.
See the following table for Main window menu bar selections and explanations:
Selection Options
Window The following options can be selected:
Option Function
CA-XCOM Control Open the Unicenter CA-XCOM Data
Transport Control Window for Send File.
CA-XCOM Status Open the Unicenter CA-XCOM Data
Transport Status Window.
SNA Status Open SNA Server Window. Only
available on RS/6000 AIX systems
running SNA Server.
About Xcomtool Open a window that describes xcomtool.
Quit Closes xcomtool.
The Main window displays a list of directories and files, along with function
buttons at the right of the window. You can select a file by clicking and dragging
it to a button and dropping it to perform a transfer operation.
Before you use the Drag and Drop feature you should read the rest of this
appendix. Refer to the control window sections for information you need to
know to perform transfers.
The Main window displays directories and files. When there are more files than
can be displayed in the window, vertical scroll bars appear. You can click on the
scroll bars to scroll up or down in the displayed list.
Selection Option
Directory List Double-click in this list of directories to change to a different
directory.
File List Select and drag on a configuration file with the middle mouse
button to perform a transfer or to edit the file. (If you use a
system with only two mouse buttons, hold down both
buttons at the same time.) Double-clicking on a file will result
in a File Info Window.
Use the two toggle buttons at the upper right of the window to indicate the type
of action you want to perform on a selected file. The highlighted toggle button
determines what happens before you select a file. Click on the diamond in the
button to choose the active process. For example, if the Submit button is
highlighted, a file transfer will be initiated using the default options specified in
the selected configuration file.
Use the process buttons at the right of the window to perform a transfer.
Depending on which toggle button is active, you can edit a configuration file or
immediately submit a transfer. When the Drop Me icon is placed over a button,
the appearance of the button changes from highlighted to pressed.
The options and screens used to edit configuration files are discussed in each
control window section. For information about fields and options that appear on
the screens, see Using Control Windows in this appendix.
To perform a transfer or edit operation with Drag and Drop, follow these steps:
1. With the middle mouse button, select the file you want to use and drag it to
the process button you want to use.
The file is highlighted, the Drop Me icon appears, and the process button
appears pressed.
Note: If you use a system with only two mouse buttons, hold down both
buttons at the same time.
2. Release the mouse button.
The action (Edit or Submit) is initiated. If Edit is active, the appropriate
control window is displayed. If Submit is active, the selected process is
initiated.
Before using the following Drag and Drop procedure, see the sections on control
windows, beginning with Using Control Windows in this appendix.
To specify a Local File on a Control Window, follow these steps with Drag and
Drop:
1. Ensure that the Main window is displayed on the screen.
2. Open a Control Window using the procedure already described, or any of
the Control Window procedures described beginning with the topic, Sending
a File Using a Control Window, later in this appendix.
3. Click in the Main window to make it active.
4. With the middle mouse button, select the file from the file list on the Main
window that you want to use, drag it to the Local File field on the desired
Control Window, and release the mouse button.
The Local File is specified.
Before you attempt to edit a configuration file, 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
■ Target system
The Control Windows display the parameters and defaults in effect for a selected
transfer. This transfer can be edited, queued, or deleted. A new transfer can also
be created.
Determine which parameters you may have to set for the specific transfer.
Also, before attempting to queue a transfer, you need to know the names of some
or all of the following components:
■ Local file
■ Remote file
■ Target system
This section contains information about using the Control Windows. It describes
the menu selections and their options, and the fields available on the control
windows. It also contains a description of record format options for use with IBM
mainframe transfers.
The following selections and options are available from the Control Window
menu bar, through drop-down menus. They are also accessed from the process
buttons if the Edit button is highlighted. For more information, see Drag and
Drop Processing in this appendix.
Selection Options
File The following options can be selected:
Selection Function
Default Resets parameters to default values from
xcom.glb.
Open Open an existing configuration file.
Save Save a configuration file.
Save As Save a configuration file under a different
name.
Close Window Exit this window.
Request The following options can be selected:
Selection Function
Send File Open Control Window-Send File.
Send Job Open Control Window-Send Job.
Send Report Open Control Window-Send Report.
Receive File Open Control Window-Receive File.
Options The following options can be selected:
Selection Function
Directories/ Open the Directories/Commands window.
Commands
Notify User Open Notify User window.
User Code Open Conversion window.
Conversion
Miscellaneous Open Miscellaneous window.
Secure Socket Open Secure Socket window.
Fields
See the following table for explanations of the fields found on the Control
Windows. Many of these fields are common to the different types of transfer
operations. Some differences in the fields displayed depend on the platform you
are running.
Note: If you type trailing spaces after a parameter, they will be included as part
of the parameter.
Field Definition
Destination ■ For performing transfers using SNA, this is the Remote
System LU. (On RS/6000 AIX systems, this is the Side
Information Profile Name.)
■ For performing transfers using TCP/IP, this can be the IP
address, host name, or domain name of the remote
system.
Local SNA LU Specifies the name of the local SNA LU. Not used for TCP/IP
transfers. (Does not appear on RS/6000.)
Local file Specifies the name of the local file.
Target System Specifies the name of the remote system that receives files,
jobs, reports, and sends messages.
UNIT Specifies the unit for the remote file.
(system specific)
VOLUME Specifies the volume for the remote file.
(system specific)
RECFM Specifies the record format for the remote file. See
(system specific) RECORD_FORMAT in this appendix.
DATACLAS Specifies the name of the data class to use when allocating a
new SMS-managed data set.
DSNTYPE Specifies the data set definition.
MGMTCLAS Specifies the name of the management class to use when
allocating a new SMS-managed data set.
STORCLAS Specifies the name of the storage class for a new SMS-
managed data set.
LCLNTFYL Specifies the local user notification level.
RMTNTFYL Specifies the remote user notification level when sending
data to a remote system.
Field Definition
LRECL Specifies the actual or maximum length, in bytes, of a logical
(system specific) 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.
BLKSZE Specifies the block size for the remote file. If the format is
(system specific) 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 Specifies the unit of storage allocation for the remote file.
(system specific) 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.
COPIES Specifies the number of copies to be printed.
FCB Specifies the FCB JCL parameter when sending the report to
(system specific) an IBM mainframe.
CLASS Specifies the print class to be assigned to this report on the
(system specific) remote system. If the remote system is an IBM mainframe,
this field designates the JES SYSOUT class. In this case, type
B.
FORM Specifies to the remote user the type of form that this report
(system specific) is to be printed on. When sending to a VAX computer, leave
this field blank.
DISPOSITION Specifies what the remote system should do with the report
after it is printed. Not used if the remote system is an IBM
mainframe.
Field Definition
CONTROL Specifies the type of printer carriage control codes, if any,
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 to spool the report to disk or to print it
directly. If the remote system is an IBM mainframe, setting
this field has no effect on the transfer.
HOLD Specifies whether this transferred report is to be placed on
hold on the remote system or printed immediately. Values
are:
■ DELETE = delete after printing
■ KEEP = keep after printing
■ HOLD = Hold after printing
Truncate Records Allows you to specify if a record exceeding the maximum
record length should be truncated
Max Record For UNIX/Linux systems, the locally initiating Unicenter
Length 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, the
value in this field 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.
RECORD_FORMAT
See the following table for detailed information on each option that can be
selected. These options are common to each transfer type and are located on the
right side of each Control Window.
Option Description
Protocol Specify protocol to use for the transfer, either SNA or TCP/IP.
TCP/IP Port For transfers that use TCP/IP, this is the value for the port on
the remote system. The default Port value of 8044 should be
valid for most remote hosts.
Encoding Allows you to select file encoding and record packing for a
Method transfer. Options from this menu are as follows:
Option Code_Flag Carriage_Flag
ASCII ASCII No
ASCII ASCII Yes
(text)
Option Description
ASCII ASCII XPACK
(pack)
Binary Binary No
Binary Binary VLR
(VLR)
EBCDIC EBCDIC No
EBCDIC EBCDIC Yes
(text)
EBCDIC EBCDIC XPACK
(pack)
Truncate Allows you to specify the maximum record length.
Records
Indirect Allows you to specify the intermediate destination.
Transfer
Security Allows you to specify the remote user ID, remote password,
remote domain name, and whether the transfer is a trusted
transfer.
Schedule Allows you to specify the start date and start time.
Request
Note: Binary (VLR2) is not shown as an option but can be specified on the
command line by setting CODE_FLAG=BINARY and CARRIAGE_FLAG=VLR2.
Access this window from the Main window menu bar or through drag and drop.
Some of the fields will contain the default values defined in the configuration
file.
Note: In the Local file, Unicenter CA-XCOM Data Transport r11 can use
wildcard characters to:
■ Receive multiple PDS members from a z/OS system, with each member
saved as a separate file
■ Transfer multiple directory members to another r11 system or PDS members
on a z/OS system
Note: If the remote system is running a Version 1 protocol then the Partner
Version 2 is not selected from the Miscellaneous window. If the remote system is
using a Version 2 protocol, then the Miscellaneous window must be chosen from
the Options pull-down and Partner Version 2 must be selected.
Procedure
Note: For more information, see Using Control Windows in this appendix.
1. Click Destination System, type the name of the destination system, and click
Local File.
The cursor is positioned in Local File field.
2. Enter the name of the local file and click Target System.
The Target System pull-down list is displayed.
3. Select Other, Midrange, VSE, or Host from the list.
Selection appears and some additional fields may be displayed.
4. Enter File Options.
The File Options pull-down list is displayed.
5. Select Create, Replace, or Append from the list.
Selection is made and some additional fields may be displayed.
6. Click Remote File.
The cursor is positioned in the Remote File field.
7. Enter the name of the remote file.
The window is complete. Select options and complete fields from the right
side of this screen, as appropriate.
8. After all entries are complete, click the Send File pushbutton.
The request to send a file transfer is processed.
Access this window from the Main window menu bar or through drag and drop.
Some of the fields will contain the default values defined in the configuration
file.
Note: If the remote system is running a Version 1 protocol then the Partner
Version 2 is not selected from the Miscellaneous window. If the remote system is
using a Version 2 protocol, choose the Miscellaneous window from the Options
pull-down and select Partner Version 2.
Procedure
Note: For more information, see Using Control Windows in this appendix.
1. Click Destination System, type the name of the destination system, and click
Dest. Printer.
The cursor is positioned in Destination Printer field.
2. Enter the name of the printer on the remote system and click Local File.
The cursor is positioned in the Local File field.
3. Enter the name of the Local File and click Report Title.
The cursor is positioned in the Report Title field.
4. Enter a name for the report and click Copies.
The cursor is positioned in Copies field.
5. Enter information the Copies field and all 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 from the right side of this screen, as
appropriate.
7. After all entries are complete, click the Send Report pushbutton.
The request to send a report is processed.
Access this window from the Main window menu bar or through drag and drop.
Some of the fields will contain the default values defined in the configuration
file.
Note: If the remote system is running a Version 1 protocol then the Partner
Version 2 is not selected from the Miscellaneous window. If the remote system is
using a Version 2 protocol, then the Miscellaneous window must be chosen from
the Options pull-down and Partner Version 2 must be selected.
Procedure
Note: For more information, see Using Control Windows in this appendix.
1. Click Destination System, enter the name of the destination system and click
Local File.
The cursor is positioned in Local File field.
2. Enter the name of the local file.
The name of a local file is displayed.
3. Select options and complete fields from the right side of this screen, as
appropriate.
4. After all entries are complete, click the Send Job pushbutton.
The request to send a job is processed.
Access this window from the Main window menu bar or through drag and drop.
Some of the fields will contain the default values defined in the configuration
file.
Note: In the Local file Unicenter CA-XCOM Data Transport r11 can use wildcard
characters to:
■ Receive multiple PDS members from a z/OS system, with each member
saved as a separate file
■ Transfer multiple directory members to another r11 system or PDS members
on a z/OS system
Note: If the remote system is running a Version 1 protocol then the Partner
Version 2 is not selected from the Miscellaneous window. If the remote system is
using a Version 2 protocol, then the Miscellaneous window must be chosen from
the Options pull-down and Partner Version 2 must be selected.
Procedure
Note: For more information, see Using Control Windows in this appendix.
1. Click Destination System, type the name of the destination system and click
Target System.
The Target System pull-down list is displayed.
2. Select Other, Midrange, VSE, or Host from the list.
Selection appears and some additional fields may be displayed.
3. Click Remote File.
The cursor is positioned in the Remote File field.
4. Enter the name of the remote file.
Entry is displayed.
5. Click File Options.
The File Options pull-down list is displayed.
Access this window by clicking on the Options menu bar selection and selecting
Directories/Commands from any Control Window. You can specify any or all of
the following:
■ Log File Name
■ Local Notify Command
■ Post processing Directory
■ Local Print Command
■ Queue Directory
■ Trace Directory
■ Local TP Command
These directories and commands have default values that can be modified.
Procedure
Before completing this window, you must know the directories and commands
necessary for completing this window.
Fields
Field Definition
Log File Name Name of the directory string where log files are
saved.
Local Notify Command Name of the directory where local notify commands
are saved.
Postproc. Directory Name of the directory string where post processing
files are saved.
Local Print Command Name of the directory string where local print
commands are saved.
Queue Directory Name of the directory string where transfers are
queued.
Trace Directory Name of the directory string where trace files are
saved.
Local TP Command Name of the directory string where local transaction
processing commands are saved.
Pushbuttons
Button Function
OK Accept the specified directories/commands. The Unicenter
CA-XCOM Data Transport Control Window is displayed.
Cancel Exit this window without accepting any specified
directories/commands. Default values are used. The Unicenter
CA-XCOM Data Transport Control Window is displayed.
Access this dialog by clicking on the Options menu bar selection and selecting
Notify User from any Control Window. Use this dialog to specify the local and
remote users who are to be notified that the transfer has been sent or received.
You can also use this dialog to specify how the local and remote users will be
notified and the level of notification.
Procedure
Note: Pull-down menu, field, and pushbutton explanations are described after
this procedure.
1. Click Local Notify.
The Local User field and a pull-down list is displayed.
2. Click on the Local Notify pull-down list.
Methods by which to notify the local user are displayed.
3. Select a method from the list and click Local User.
Selection is made and the cursor is positioned in the Local User field.
4. Enter the name of the local user and click Remote Notify.
Selection is displayed. The Remote User field and pull-down list display.
5. Click on the Remote Notify pull-down list.
Methods by which to notify the remote user are displayed.
6. Select a level and a method from the list and click Remote User.
Selection is made and the cursor is positioned in the Remote User field.
Pull-Down Menus
The following options are available on the pull-down menu associated with the
Notify User window:
Option Function
Local Notify The local user notification flag. Options from this menu are:
Option Function
ALL NOTIFY on transfer completion.
WARN NOTIFY only if the transfer received a
warning or error.
ERROR NOTIFY only if the transfer received an
error.
Remote The remote user notification flag. Options from this menu are:
Notify
Option Function
ALL NOTIFY on transfer completion.
WARN NOTIFY only if the transfer received a
warning or error.
ERROR NOTIFY only if the transfer received an
error.
Fields
The following fields are associated with the Notify User window:
Field Definition
Local User The user on the local system who is to be notified when
Unicenter CA-XCOM Data Transport completes a transfer.
Remote User The user on the remote system who is to be notified when
Unicenter CA-XCOM Data Transport completes a transfer.
Pushbuttons
Button Function
OK Accept the specified parameters. A Unicenter CA-XCOM Data
Transport Control Window is displayed.
Cancel Exit this window without accepting any specified parameters. A
Unicenter CA-XCOM Data Transport Control Window is displayed.
Access the Conversion dialog by clicking on the Options menu bar selection and
selecting User Code Conversion from any Control Window. Use the Conversion
dialog to specify a one- to three- character prefix to the file names, atoe.tab and
etoa.tab, that contains the external ASCII-to-EBCDIC and EBCDIC-to-ASCII
custom character conversion tables for user data conversion procedures for
transfers.
Procedure
Before completing this window, make sure you know the one- to three- character
prefix for the user-defined ASCII-to-EBCDIC and EBCDIC-to-ASCII conversion
table names that reside in the Unicenter CA-XCOM Data Transport convtab
directory that will be used for the transfer.
Note: Pull-down menu, field, and pushbutton explanations are described after
this procedure.
1. Type in the prefix name of the user-defined code tables.
Selection is displayed in the CODETABL field.
2. Click the OK pushbutton.
A Unicenter CA-XCOM Data Transport Control Window is displayed.
Fields
Field Definition
CODETABL 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.
Pushbuttons
The following pushbuttons are located at the bottom of the Conversion dialog:
Button Function
OK Accept the specified parameter. A Unicenter CA-XCOM Data
Transport Control Window is displayed.
Cancel Exit this window without accepting the specified parameter.
Default parameters are used. A Unicenter CA-XCOM Data
Transport Control Window is displayed.
Access this window by clicking on the Options menu bar selection and selecting
Miscellaneous from any Control Window. Use this window to set the following
parameters:
■ Compression
■ Trace level
■ Checkpoint
■ Automatic retries
Procedure
Note: Pull-down menu, field, and pushbutton explanations are described after
this procedure.
1. Click Compression to activate/deactivate compression.
The Compression field is highlighted. Strip Blanks is activated.
2. If you are not using Brixton or SunLink APPCs, skip this step.
If you are using Brixton or SunLink APPCs, click in Gateway’s Hostname
and type in the appropriate name. (See the Fields list that follows.)
3. If you are using SNA, click SNA Log Mode.
The SNA Log Mode field is highlighted.
4. If you are using SNA, accept the default by pressing ENTER or type the
name of the SNA log mode command and click Trace to activate/deactivate
tracing.
Selection is made and the cursor is positioned in the Trace Level pull-down
menu.
5. Click on the Trace Level pull-down list.
Levels by which to set tracing are displayed.
6. Select a trace level from the list and click Partner Version 2 to
activate/deactivate Unicenter CA-XCOM Data Transport version 2.
Selection is made and the cursor is positioned in the Checkpoint Interval
field.
7. Type in a checkpoint interval and click Automatic Retries to
activate/deactivate automatic restart of failed transfers.
Selection is made and the cursor is positioned in the Retry Interval field.
8. Type in a retry interval and click Number of Retries.
Selection is made and the cursor is positioned in the Number of Retries field.
9. Type in the number of retries.
Selection is made and the Number of Retries field is highlighted.
10. After all entries are complete, click the OK pushbutton.
A Control Window is displayed.
Pull-down Menu
The following options are available on the pull-down menu associated with the
Miscellaneous window:
Option Function
Trace Level The following trace levels can be selected: 1 - 10. For more
information, see the description of the XTRACE parameter in the
appendix “Parameters.”
Fields
Field Definition
Gateway’s Hostname Required for Brixton and SunLink APPCs. For Brixton,
it indicates the name of the node that specifies the
gateway to use for the transfer. For SunLink, it indicates
the name of the gateway, as defined in the /etc/appcs
file.
SNA Log Mode For SNA only. Mode table entry.
Checkpoint Interval Defines how often (based on record count) the sending
system requests a checkpoint to be taken. The value 0
indicates no checkpointing.
Retry Interval Indicates the maximum number of retries before a
transfer is logged as failed and taken out of the transfer
queue.
Number of Retries The number of seconds between retries of unsuccessful
transfers. If the value is 0, no retries are attempted.
Pushbuttons
Button Function
OK Accept the specified parameters. A Unicenter CA-XCOM Data
Transport Control Window is displayed.
Cancel Exit this window without accepting any specified parameters.
Default parameters are used. A Unicenter CA-XCOM Data
Transport Control Window is displayed.
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
Pushbuttons
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.
Access this window by clicking Window on the Main window menu bar and
selecting CA-XCOM Status. This window can be used while the transfer is in
progress or after it has been completed. The window allows you to perform
several functions on the queued transfers, such as putting a transfer on hold or
deleting it.
This window is also the beginning point to access the following Unicenter
CA-XCOM Data Transport status windows:
■ Xcomlog
■ Xcomtp Status
Procedure
To maintain transfers listed on the Status window, highlight a transfer and select
an option on the right side of this window.
Fields
Field Definition
TID Transfer ID.
Condition Result of a transfer, for example, failed, succeeded.
Initiate Indicate whether transfer was initiated by local or
remote system.
Status Transfer status, for example, started, active, done.
Message Explanation of informational or error message relating
to a particular transfer.
Pushbuttons
The following pushbuttons are located on the right side of this window:
Button Function
Suspend Allows you to suspend an active transfer.
Resume Allows you to resume with a suspended transfer.
Hold/Release Allows you to put on hold a scheduled transfer or allows
you to release a held transfer.
Terminate Allows you to kill an active transfer.
Remove Entry Allows you to delete selected transfer.
TP Info Opens Xcomtp Status window for selected transfer.
Log/Trace Opens Xcomlog window for the selected transfer.
Close Window Closes this window. The xcomtool Main window is
displayed.
Procedure
To view the Xcomtp Status window, select a transfer on the Unicenter CA-
XCOM Data Transport Status window and click the TP Info pushbutton.
Fields
See the following table for Xcomtp Status window field names and descriptions.
These fields are informational and cannot be updated.
Field Displays
Transaction ID Transaction ID associated with a specific transfer.
Remote LU The name of the system that receives or sends a file.
Request Type of transfer requested.
File Name of file.
Start Time The time at which the request started.
State Result of a transfer, for example, failed, succeeded.
TP PID Process ID of the transaction program.
Owner UID User ID.
Records The number of records per second since beginning of the
transfer.
Bytes The number of bytes per second since the beginning of the
transfer.
Pushbutton
Button Function
Close Closes this window. The Unicenter CA-XCOM Data Transport
Status window is displayed.
Procedure
To view the Xcomlog window, select a transfer on the Unicenter CA-XCOM Data
Transport Status window and click the TP Info pushbutton.
Pushbuttons
Button Function
More Allows you to view the next page of information.
Save Trace Allows you to save the results of the trace to a file.
Button Function
Close Closes this window. The Unicenter CA-XCOM Data
Transport Status window is displayed.
VI Activates the command:
xterm -e vi /usr/spool/xcom/trace/000013.tra
Note: If the vi screen does not come up, you will have to
add the path to xterm in the PATH environment variable.
Problem Determination
E
With each implementation, the problem determination procedures vary slightly.
This appendix is focused towards help desk personnel or a designated Unicenter
CA-XCOM Data Transport troubleshooter with knowledge of the following:
■ The operational characteristics of Unicenter CA-XCOM Data Transport for
UNIX and Linux
■ For transfers that use SNA, some knowledge of the structure and
components of an SNA networking environment, including an
understanding of the nature of SNA LUs, PUs, sessions, and conversations
When you have a problem, you should review the messages displayed on the
screen as well as those recorded in this file. In many cases, you will be able to
determine the cause of the problem from the messages. For more information
about the log file, see Setting Up Log Files in the chapter “The Command Line
Interface.” For more information about Unicenter CA-XCOM Data Transport for
UNIX and Linux messages, see the appendix “Messages.”
General Procedures
This section contains a general test procedure to use for documenting problems.
The purpose of the procedures and worksheet in this Appendix is to help you to
isolate the cause of problems and to correct them in an efficient and timely
manner or to gather enough information for Unicenter CA-XCOM Data
Transport Customer Support to help you as quickly as possible.
Test Procedure
To be effective, you must follow these procedures in order and document the
results of every test carefully. It is good practice to run through the tests at least
twice to ensure that the results are consistent.
Answer Action
Yes Look up the error message in the appropriate
Unicenter CA-XCOM Data Transport manual and
follow the instructions.
No If no error message was issued and the operation does
not complete (for example, hangs), the problem may
be related to a system malfunction (for example,
remote system response time problems, and so forth).
Leave the function in the “hung state” for at least 10
minutes. If the problem persists, contact a person who
can verify the current status of the system and
backbone network. If the system or the network is not
operating normally, retry the transfer at some later
time.
General Information
Environment Information
Use the following table to inventory information about your environment. Use
additional sheets as necessary.
Transfer Type
Problem Description
Question YES NO
Is the problem reproducible?
Is this an immediate transfer (Foreground, TYPE=EXECUTE)
or a scheduled transfer (Background, TYPE=SCHEDULE)?
Has there been any hardware or software changes (for
example, hardware upgrades, operating system, Unicenter
CA-XCOM Data Transport or communications type changes)
Problem History
Yes No
Is this the first occurrence of the problem?
Error Messages
Please provide a list of error messages include the message ID and all of the text.
Use the following table to inventory information about your environment. Fill in
the boxes of platforms involved in transfer)
DOS
Windows
Windows NT, 2000, and XP
NetWare
Other
Documentation
# B
Index–1
checkpoint parameters CONTROL, A-8
CHECKPOINT_COUNT, 3-63
control block structure, API, 4-3
NUMBER_OF_RETRIES, 3-63
Control Windows
CHECKPOINT_COUNT, A-6
Receive File, D-24
checkpoint/restart parameter, 3-63
Send File, D-19
checkpoint_count, API, 4-9 Send Job, D-23
Send Report, D-21
CLASS, A-6
xcomtool, D-9, D-11
send report parameter, 3-36
drag and drop procedure, D-8
class, API, 4-9
conventions in this guide, 1-21
CLEANLOG, 2-21
conversion dialog, D-31
example, 2-22
using xcomtool, D-31
syntax, 2-22
CONVERT_CLASSES, 2-7, A-8
client certificate for SSL, 6-3
convert_classes, API, 4-11
CODE_FLAG, A-6
file type conversion parameter, 3-46 COPIES, 2-31, A-8
Send Report parameter, 3-36
code_flag, API, 4-9
copies, API, 4-11
CODETABL, 3-12, A-7
CREATE_DIR, 3-19, A-9
codetabl, API, 4-10
creating configuration files, 3-2
command line interface, Retrieve File command, 3-21
custom character sets, stored, 3-47
communications parameters
DESTINATION_TYPE, 3-14 Customer Support, E-12
REMOTE_SYSTEM, 3-15
customizing notification, 2-32
REMOTE_SYSTEM_RF, 3-15
REMOTE_SYSTEM_SJ, 3-16
REMOTE_SYSTEM_SR, 3-16
setting, 3-12 D
XLUNAME, 3-17
XMODE, 3-17 daemon, 3-1
XNODESPEC, 3-18 process, 2-5
COMPRESS, 3-13, A-7 data transfer parameters
compress, API, 4-10 CODETABL, 3-12
COMPRESS, 3-13
configuration files, 3-1 MAXRECLEN, 3-14
creating, 3-2 TRUNCATION, 3-17
opening and editing in xcomtool, D-9
xcom.cnf, 3-12 DATACLAS, A-9
xcom.glb, 2-7 mainframe file creation parameter, 3-26
xcom.ses, 2-18 dataclas, API, 4-11
configuring Unicenter CA-XCOM Data Transport debug_flag, API, 4-12, A-9
SSL client, 6-5
SSL server, 6-4 debugging scripts, 2-26
E
G
EBCDIC conversion, 3-44
global parameters, 2-6
using xcom62 command, 3-45
AGE_TIME, 2-7, A-3
using xcomtcp command, 3-45
ATOE_FILENAME, 2-7
Edit button, xcomtool, D-7 CONVERT_CLASSES, 2-7
DISPLAY_PASSWORD_IN_TRACE, 2-8, A-10
Edit Transfer Window
EOL_CLASSES, 2-8
common options, D-11
ETOA_FILENAME, 2-8
common uses, D-11
EXPIRATION_TIME, 2-9
edit xcomtool Main Window, D-11 INTERNAL_CONVERSION_TABLES, 2-9
MAX_QUEUE_ENTRIES, 2-9
encrypted parameter values, 3-55 MAX_REMOTE_TCP, 2-10, 3-15, A-20
EOL_CLASSES, 2-8, A-12 MAX_SESSIONS_ENTRIES, 2-10
METACODE_CLASSES, 2-10
eol_classes, API, 4-14 PROTOCOL, 2-10
error messages, system identifier, B-1 QUEUE_PATH, 2-11
SAVE_PASSWORD_IN_CNF, 2-11, A-31
ETOA_FILENAME, 2-8, A-12 SESSIONS_FILE, 2-11
EXPDT, A-12 SHELL_CMD, 2-12
SOCK_DELAY, 2-12
expdt, API, 4-14 SOCK_RCV_BUF_SIZE, 2-12
SOCK_SEND_BUF_SIZE, 2-13
Index–3
STAT_FREQUENCY, 2-13 IBM mainframe, creating a file on, 3-25
TCP_CMD, 2-13
indirect transfer, 3-51
TEMPDIR, 2-13
TP_CMD, 2-14 INTERNAL_CONVERSION_TABLES, A-15
TRACE_PATH, 2-14 global parameter, 2-9
TRUSTED_PATH, 2-14
TXPI_BUF_SIZE, 2-14
TXPI_SEND_CHECK_FREQ, 2-15
TXPI_TERM_TIMEOUT, 2-15
L
UMASK, 2-15
using, 2-6 LABEL, A-16
XCOM_PASSWORD, 2-15 label, API, 4-16
XCOM_USERID, 2-16
XCOMPRE_LOCAL, 2-16 LABELNUM, A-16
XENDCMD, 2-16
labelnum, API, 4-16
XLPCMD, 2-17
XNOTIFYCMD, 2-17 lclntfy, API, 4-16
XPPCMD, 2-17
LCLNTFYL, A-17
XPRECMD, 2-18
notification parameter, 3-59
XTRACE, 2-18
link libraries, API
graphical user interface, D-1
SNA, 4-2
TCP/IP, 4-2
Linux, 5-16
H
Local Notify, xcomtool, D-26, D-29
hold, API, 4-15 local SNA LU, xcomtool, D-13
HOLDFLAG, A-15 LOCAL_FILE, A-17
Send Report parameter, 3-37 send file parameter, 3-20
local_file, API, 4-17
I LOCAL_FILE_RF, A-18
Retrieve File parameter, 3-22, 4-17
IBM mainframe file creation parameters local_file_rf, API, 4-17
ALLOCATION_TYPE, 3-25
BLKSIZE, 3-26 LOCAL_FILE_SJ, A-18
DATACLAS, 3-26 Send Job parameter, 3-41
DSNTYPE, 3-26 local_file_sj, API, 4-18
LRECL, 3-27
MGMTCLAS, 3-27 LOCAL_FILE_SR, A-18
NUM_OF_DIR_BLOCKS, 3-27 Send Report parameter, 3-38
PRIMARY_ALLOC, 3-27
local_file_sr, API, 4-18
RECORD_FORMAT, 3-28
SECONDARY_ALLOC, 3-29 LOCAL_NOTIFY, A-19
SECURE_SOCKET, 3-30, A-32 notification parameter, 3-59
STORCLAS, 3-30
LOCAL_RECEIVE, 4-3
UNIT, 3-30
UNIT_RF, 3-24 LOCAL_SEND, 4-3
VOLUME, 3-30, 3-31
VOLUME_RF, 3-24 locally initiated transfers, 3-56
XCOM_CONFIG_SSL, 3-31 localnotify, API, 4-18
XCOM_SHOW_CIPHER, 3-31
N
M
network levels
machine code characters, reports, 2-36 diagram, 1-14
mailx, 2-32 end user level, 1-12
general explanation, 1-12
Main window menu logical level, 1-13
xcomtool, D-3 physical level, 1-13
directories, D-7 send file flowchart, 1-20
drag and drop, D-6 successful send file transfer over SNA network,
editing toggle buttons, D-7 1-19
file lists, D-7
menu bar, D-5 network term definitions
submitting toggle buttons, D-7 logical and physical components, C-1, C-2
LU, C-1
mainframe file creation, 3-25 procedure correlation identifier (PCID), C-2
managing queue, 2-20 session, C-2
NEWXFER, A-8
Index–5
notification parameters P
LCLNTFYL, 3-59
LOCAL_NOTIFY, 3-59
parameter format, 2-3
NOTIFY_NAME, 3-60
NOTIFY_TERM, 3-60 parameter values, A-1
NOTIFYL, 3-60
NOTIFYR, 3-61 parameters, encrypting, 3-54
RMLNTFYL, 3-61 PASSWORD, A-23
using, 3-58 security parameter, 3-53
xcom62 command, 3-58
xcomtcp command, 3-59 password, API, 4-22
Notify User window, D-26, D-29 PCID (procedure correlation ID), C-2
Index–7
RETRY_TIME, A-31 Send Job command, 3-40
checkpoint/restart parameter, 3-64 parameters, 3-41
xcom62, 3-40
return codes, system restrictions, 3-42
xcomtcp, 3-40
return values, 4-3
Send Job parameter
RMLNTFYL, A-25 LOCAL_FILE_SJ, 3-41
notification parameter, 3-61
Send Report command, 3-35
rmtmtful, API, 4-24 parameters, 3-35
support, IBM machine code characters, 3-39
xcom62, 3-35
xcomtcp, 3-35
S
Send Report parameters
sample API program, 4-40 CARRIAGE_CONTROL_CHARACTERS, 3-35
CLASS, 3-36
SAVE_PASSWORD_IN_CNF COPIES, 3-36
global parameter, 2-11, A-31 DESTINATION, 3-36
script changes and shell, 2-25 DISPOSITION, 3-37
FCB, 3-37
scripts, 2-26 FORM, 3-37
post processing, 2-25 HOLDFLAG, 3-37
LOCAL_FILE_SR, 3-38
SECONDARY_ALLOC, 3-29, A-32
REPORT_TITLE, 3-38
secondary_alloc, API, 4-29 SPOOL_FLAG, 3-39
Secure Socket Layer (SSL), 1-4 sending
files, 3-18
Secure Socket transfers, performing, D-36
using a control window, D-19
Secure Socket window, D-36 jobs, using a Control Window, D-23
reports, using a Control Window, D-21
SECURE_SOCKET
global parameter, A-32 server certificate for SSL, 6-3
mainframe file creation parameter, 3-30
session control, 2-18
secure_socket, API, 4-29
session ID (SID), C-2
security parameters
SESSIONS_FILE, A-32
PASSWORD, 3-53
global parameter, 2-11
TRUSTED, 3-53
USERID, 3-53 setting
using, 3-52 communications parameters, 3-12
xcom62 command, 3-52 session control parameters, 2-18
xcomtcp command, 3-52
SHELL_CMD, 2-12, A-33
Send File command, 3-18
shell_cmd, API, 4-29
parameters, 3-19
xcom62, 3-18 shells and script changes, 2-25
xcomtcp, 3-18
SID (session ID), C-2
Send File parameters
FILE_OPTION, 3-19 SNA/APPC
LOCAL_FILE, 3-20 performing transfers using, 3-4, 3-7
REMOTE_FILE, 3-20, 4-26 protocols, 3-7
xcom62 example, 3-7
Index–9
transfer types features, 1-1
answering remote requests data link types, 1-6
files, 1-9 high capacity and performance, 1-7
jobs, 1-9 management, 1-8
reports, 1-9 modular support of most systems, 1-5
retrieving files, 1-9 security, 1-8
sending batch jobs for execution, 1-9 standard, 1-6
sending files, 1-9 standard functions, 1-6
sending reports, 1-9 file transfer types, 1-2
invoking, 1-10
TRANSFER_NAME, A-37
menu interface, 1-10
TRANSFER_TYPE, A-37 programming interface, 1-10
standard features
TRANSFER_USER_DATA, A-38 simple installation, 1-6
transferring files, 3-3 unified solution, 1-2
user interfaces, 1-2
transfers, performing in xcomtool, D-11 uses, 1-2
troubleshooting, general procedures UNIT, 3-30, A-40
purpose of procedures, E-2
test procedure, E-2 unit, API, 4-31
VAX, 5-7
U
VERSION, 3-17, A-41
UMASK, 2-15, A-40 version, API, 4-32
Unicenter CA-XCOM Data Transport viewing log information, xcomtool, D-41
applications
report distribution, 1-4 VM, 5-17
RJE/NJE replacement, 1-4
VOLCT, A-41
type 2.1 support, 1-3
benefits of LU 6.2 (APPC), 1-14 volct, API, 4-32
connectivity, 1-11
VOLSQ, A-42
volsq, API, 4-32
Index–11
Xcomtp Status Window, D-39 XMODE, 3-17, A-45
XENDCMD, 2-16, A-43 xmode, API, 4-35
xendcmd, API, 4-34 XNODESPEC, A-45
configuration parameter, 3-18
XIDEST, A-44
store and forward parameter, 3-52 xnodespec, API, 4-35
xidest, API, 4-34 XNOTIFYCMD, A-45
global parameter, 2-17
XLOGFILE, A-44
logging parameter, 3-44 xnotifycmd, API, 4-36, 4-37
xlogfile, API, 4-34 XPPCMD, 2-17, A-46
XLPCMD, A-44 xppcmd, API, 4-36
global parameter, 2-17
XPRECMD, 2-18, 2-22, A-46
xlpcmd, API, 4-35
xprecmd, API, 4-37
XLUNAME, 3-17, A-45
XTRACE, 2-18
xluname, API, 4-35 performance, 3-43
testing and tracing parameter, 3-43, A-46