Data Transport
for UNIX and Linux
User Guide
r11
J02562-1E
This documentation and related computer software program (hereinafter referred to as the Documentation) is for
the end users 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 users 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 users
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.
Contents
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
iv
User Guide
2-26
2-26
2-28
2-28
2-31
2-31
2-32
2-32
2-34
2-34
2-36
2-36
Contents
vi
User Guide
5-2
5-2
5-2
5-2
5-3
5-3
5-4
5-4
5-5
5-5
5-5
5-6
5-6
5-6
5-6
5-7
5-7
5-7
5-7
5-8
Contents
vii
viii
User Guide
6-1
6-2
6-2
6-3
6-3
6-4
6-5
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 ..........................................................................
ETOA_FILENAME ......................................................................
EXPDT .................................................................................
EXPIRATION_TIME .....................................................................
FCB ....................................................................................
FILE_OPTION ..........................................................................
FILE_OPTION_RF .......................................................................
FORM ..................................................................................
HOLDFLAG ............................................................................
INTERNAL_CONVERSION_TABLES .....................................................
LABEL .................................................................................
LABELNUM ............................................................................
LCLNTFYL .............................................................................
LOCAL_FILE ...........................................................................
LOCAL_FILE_RF ........................................................................
LOCAL_FILE_SJ ........................................................................
LOCAL_FILE_SR ........................................................................
LOCAL_NOTIFY ........................................................................
LRECL .................................................................................
MAX_QUEUE_ENTRIES .................................................................
MAX_REMOTE_TCP ....................................................................
MAX_SESSIONS_ENTRIES ..............................................................
MAXRECLEN ...........................................................................
METACODE_CLASSES ..................................................................
MGMTCLAS ............................................................................
NOTIFY_NAME ........................................................................
NOTIFYL ...............................................................................
NOTIFYR ...............................................................................
NOTIFY_TERM .........................................................................
NUMBER_OF_RETRIES .................................................................
NUM_OF_DIR_BLOCKS .................................................................
PASSWORD ............................................................................
PORT ..................................................................................
PRIMARY_ALLOC ......................................................................
PRIORITY ..............................................................................
PROTOCOL ............................................................................
QUEUE.................................................................................
QUEUE_PATH ..........................................................................
RMTNTFYL.............................................................................
RECORD_FORMAT .....................................................................
REMOTE_FILE ..........................................................................
User Guide
A-12
A-12
A-12
A-13
A-13
A-13
A-14
A-15
A-15
A-15
A-16
A-16
A-17
A-17
A-18
A-18
A-18
A-19
A-19
A-19
A-20
A-20
A-20
A-20
A-21
A-21
A-21
A-22
A-22
A-22
A-23
A-23
A-23
A-23
A-24
A-24
A-24
A-25
A-25
A-26
A-27
Contents
xi
UNITCT ................................................................................
UNIT_RF ...............................................................................
USE_TP_SECURITY .....................................................................
USERID ................................................................................
VERSION ...............................................................................
VOLCT .................................................................................
VOLUME ...............................................................................
VOLUME_RF ...........................................................................
VOLSQ .................................................................................
XCOM_CONFIG_SSL ....................................................................
XCOM_PASSWORD .....................................................................
XCOM_SHOW_CIPHER .................................................................
XCOM_TRUSTED_OVR .................................................................
XCOM_USERID .........................................................................
XCOMPRE_LOCAL .....................................................................
XENDCMD .............................................................................
XIDEST .................................................................................
XLOGFILE ..............................................................................
XLPCMD ...............................................................................
XLUNAME .............................................................................
XMODE ................................................................................
XNODESPEC ...........................................................................
XNOTIFYCMD ..........................................................................
XPPCMD ...............................................................................
XPRECMD ..............................................................................
XTRACE ................................................................................
A-40
A-40
A-40
A-41
A-41
A-41
A-41
A-41
A-42
A-42
A-42
A-42
A-43
A-43
A-43
A-43
A-44
A-44
A-44
A-45
A-45
A-45
A-45
A-46
A-46
A-46
Appendix B: Messages
Error Messages................................................................................ B-1
Message ID Content ....................................................................... B-1
List of Messages ............................................................................... B-3
xii
User Guide
C-1
C-2
C-2
C-2
C-2
Contents
xiii
D-29
D-29
D-30
D-30
D-31
D-31
D-31
D-33
D-34
D-35
D-35
D-36
D-36
D-36
D-37
D-37
D-37
D-38
D-38
D-39
D-39
D-40
D-40
D-40
D-41
D-41
D-41
xiv
User Guide
Index
Contents
xv
Chapter
Introduction
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.
To install this product, you need the following:
Sharing data
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
11
Menu interface
Unified Solution
Unicenter CA-XCOM Data Transport is a unified solution. It supports
communications over more hardware environments than any other software
product on the market today. Unicenter CA-XCOM Data Transport also has a
solid technology base. By using LU 6.2 or TCP/IP communications protocols,
Unicenter CA-XCOM Data Transport uses state-of-the-art technology, protecting
your companys investment for years to come.
Files
Jobs
Reports
When these functions are combined, a wide variety of applications are possible.
File Transfer
Unicenter CA-XCOM Data Transport supports high-speed file transfers between
all supported processors. In some environments, you can start thousands of
transfers with a single operation. Parallel sessions are possible in varying degrees
throughout the product line.
You can totally automate Unicenter CA-XCOM Data Transport transfers. On a
PC, you can be actively engaged in the use of other applications (for example,
word processing) while receiving or transmitting files in the background.
Comprehensive management tools allow for effective central-site control of
Unicenter CA-XCOM Data Transport activity, including advanced problem
determination features.
12
User Guide
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:
TCP/IP Support
Unicenter CA-XCOM Data Transport provides support for performing transfers
using TCP/IP between platforms that support TCP/IP and that are running
Advantage CA-XCOM Data Transport 3.0 or 3.1 or Unicenter CA-XCOM Data
Transport r11. TCP/IP support is provided between the following platforms:
AS/400
Linux S/390
Linux x86
Netware
OS/2
Tandem
z/OS
Introduction
13
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
z/OS
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.
Unicenter CA-XCOM Data Transport avoids these limitations by taking
advantage of the LU 6.2 and TCP/IP protocols, providing a peer-to-peer
relationship between all supported systems. Any Unicenter CA-XCOM Data
Transport system is able to send and receive batch jobs and print data from any
other Unicenter CA-XCOM Data Transport system without formatting
constraints.
For example, an AS/400 user can do the following:
14
User Guide
Generate a report.
Send one copy of the report back to the source PC for printing.
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.
DG/UX AViiON
Digital Unix
HP 9000
IBM AS/400
IBM z/OS
IBM RS/6000
IBM VM
IBM VSE
Linux Intel
Linux S/390
NetWare
OpenVMS Alpha
OS/2
PC or MS-DOS
SCO UNIX
Sequent
Introduction
15
Stratus
Sun OS
Sun Solaris
Tandem
VAX VMS
SDLC
TCP/IP
Standard Features
The following features are standard to Unicenter CA-XCOM Data Transport:
Standard Functions
The following functions are offered over most of the Unicenter CA-XCOM Data
Transport platforms:
16
User Guide
Introduction
17
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.
Unlike most other communication facilities, Unicenter CA-XCOM Data
Transport encrypts passwords. This ensures that communications line tapping
will not breach security.
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
An important feature for any enterprise-wide information product is the ability
to effectively control and manage the distribution of files and work throughout
the network. Unicenter CA-XCOM Data Transport systems maintain a
comprehensive log of all transfer activity. Utilities are provided to allow the
system administrator to view the log on-line and modify the status of pending or
currently active transfers.
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.
18
User Guide
Types of Transfers
Types of Transfers
Unicenter CA-XCOM Data Transport will perform the following transfers:
FilesThe remote system can send or retrieve files. When a remote system
requests Unicenter CA-XCOM Data Transport to send it a file, Unicenter CAXCOM Data Transport tries to allocate and open the file. Unicenter CAXCOM Data Transport then reads the data records and transfers them to the
remote system.
JobsThe remote system can use Unicenter CA-XCOM Data Transport to
submit jobs to the local system.
ReportsThe remote system can send the local system a report. Unicenter
CA-XCOM Data Transport writes the report to an output spool file. Each
supported system has unique spooling capabilities and Unicenter CA-XCOM
Data Transport has been designed to provide a high degree of print
redirection and manipulation.
Introduction
19
Menu Interface
The menu interface provides a simple, fill-in-the-blanks approach to file transfer.
You are prompted for required information and can use the extensive on-line
help facilities provided with each product. Unicenter CA-XCOM Data Transport
menus always have the look and feel appropriate to the system on which they
are running. For example, the micro-computer platforms use a graphical user
interface with menus, tool bars, pop-up windows, and so on, while z/OS is
written for the popular ISPF Dialog Manager.
Programming Interface
Any programming language supporting callable subroutines can call Unicenter
CA-XCOM Data Transport. Examples of calling programs from common
programming languages are given in each user manual, for supported platforms.
UNIX and Linux versions of Unicenter CA-XCOM Data Transport allow direct
API calls to specific Unicenter CA-XCOM Data Transport functions in addition to
allowing you to run Unicenter CA-XCOM Data Transport as a subprogram.
Unicenter CA-XCOM Data Transport also provides exits on many systems,
allowing you to control or be informed about certain Unicenter CA-XCOM Data
Transport events involving security and completed transfers.
110
User Guide
Note: For information about the platforms for which TCP/IP support is
provided, see TCP/IP Support in this chapter.
Introduction
111
112
User Guide
Introduction
113
END
USER
LEVEL
Local
User
Remote
User
CA-XCOM
CA-XCOM
LU 6.2
LU 6.2
Physical
Unit Node
Physical
Unit Node
LOGICAL
LEVEL
PHYSICAL
LEVEL
Physical Connection
114
User Guide
Improved Throughput
When Unicenter CA-XCOM Data Transport uses the LU 6.2 protocol, it does not
place hardware restrictions on the size of the data that it sends. RJE-based data
transfer packages (LU Type 1) limit the size of a data frame (RU) to 80 characters,
while 3270-based transfer packages (LU Type 2) often limit the size to 1,920
characters, the size of one screen. LU 6.2 allows RU sizes of up to 65,536
characters.
Each transmitted string of data is wrapped in a protocol envelope. Larger RU
sizes, such as those allowed with Unicenter CA-XCOM Data Transport, mean
less protocol overhead and a higher percentage of actual data traveling across
your communication links.
P = Protocol
Overhead
Data
Data
Data
Data
Introduction
115
Internetwork layer
Transport layer
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.)
116
User Guide
Network layer
Token Ring
Ethernet
X.25
and so on
Internetwork layer
Transport layer
Application layer
Telnet
File Transfer Protocol (FTP)
Simple Mail Transfer Protocol (SMTP)
Domain Name System (DNS)
Sockets
and so on
A summary of the services that each layer of the protocol stack performs in
the TCP/IP network
A description of the protocols that are particularly important for the
functioning of Unicenter CA-XCOM Data Transport as a TCP/IP network
node
Network Layer
The Network layer provides a set of protocols, 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.
However, IP does not ensure a reliable communication, because it does not
require that the computers participating in a data exchange acknowledge the
reception of the transmitted data. The reliability of communication is
implemented at the next higher protocol layer.
Transport Layer
The protocols of the Transport layer allow communication between application
programs.
The Transmission Control Protocol (TCP) of this layer establishes a connection
between the sender and receiver and provides a continuous communication
service with reliability of transmissions. TCP divides the data to be transmitted
into smaller units (packets, datagrams), sends them individually using IP, and
reassembles them at the destination node, comparing the received data with the
data that were sent. TCP is capable of determining if the two are the same. If they
are not (that is, data were lost or damaged during transmission), TCP resends the
missing data.
Introduction
117
Application Layer
The Application layer, which is built on the services of the Transport layer,
provides a number of applications that allow users to use network services
(terminal-to-terminal communication, data transfer, electronic mail, and so on).
The Application layer provides an application programming interface known as
Sockets for communications applications. Unicenter CA-XCOM Data Transport
uses this component of the Application layer to transfer files to machines in a
TCP/IP network.
118
User Guide
The local Windows user invokes Unicenter CA-XCOM Data Transport and
requests a transfer.
2.
3.
4.
Once the contents of the header record are verified, Unicenter CA-XCOM
Data Transport begins sending data records to the remote system. Unicenter
CA-XCOM Data Transport sends each data record, checking to see if any
sending errors occur. If no errors are found, the local system checks for an
end-of-file marker denoting the last record of the file. If no end-of-file marker
is found, another data record is sent.
5.
Introduction
119
120
User Guide
Conventions
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
User input is in the following font and placed on separate lines:
xcom62 -c1 -f filename.cnf
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.
Screen Output
Computer output is in the following font and placed on separate lines:
XCOMU0082I xcomd: stop request accepted.
Introduction
121
Chapter
Operating Environment
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.
A substantial portion of a users ability to control Unicenter CA-XCOM Data
Transport comes from the use of files to set variables that govern the system's
behavior. These files are xcom.glb and xcom.cnf.
Before executing a file transfer request, be sure that you have properly set up
your directories and path variables.
The Unicenter CA-XCOM Data Transport daemon, xcomd, is installed in the
/etc directory, except for the following:
For OSF Digital UNIX and Linux, xcomd is installed in the /usr/sbin
directory.
Be sure that your PATH variable is set so that your shell can find xcom62 or
xcomtcp, or both.
The /usr/spool/xcom directory is the default repository that Unicenter
CA-XCOM Data Transport uses for logging and for configuration
information.
For further information about PATH and directory defaults, see the
appendix Parameters.
Operating Environment
21
Transfer Protocols
Unicenter CA-XCOM Data Transport supports transfer protocols, such as
Ethernet, SDLC, Token Ring, and TCP/IP.
SNA/APPC Protocols
For SNA/APPC protocols, support is based on the capabilities provided by
the particular APPC vendor.
For SNA/APPC, Unicenter CA-XCOM Data Transport requires an active LU
6.2 session to transfer files. When an LU 6.2 session is established, local users
can begin using Unicenter CA-XCOM Data Transport to initiate transfers.
TCP/IP Protocols
The TCP/IP component of Unicenter CA-XCOM Data Transport supports
TCP/IP protocols for performing transfers between Advantage CA-XCOM
Data Transport Version 3.x or Unicenter CA-XCOM Data Transport r11
platforms using TCP/IP.
Parameter Values
Parameter values can be defined to Unicenter CA-XCOM Data Transport as
indicated in the table below. The values take precedence depending on where
they are specified.
The order in which parameter values take precedence is as follows:
Order of
Precedence
22
User Guide
Command Line
xcom.cnf or
filename.cnf
Order of
Precedence
xcom.glb
Program Defaults
Parameter Format
The Unicenter CA-XCOM Data Transport parameters consist of assignment
statements. The format for assignment statements is as follows:
Syntax
The syntax for assignment statements is as follows:
PARAMETER_NAME=value
Example
In the following example, the parameter EXPIRATION_TIME is set to a value of
6000 seconds.
EXPIRATION_TIME=6000
This controls the maximum time in seconds that a transaction is held in the
transfer queue.
Operating Environment
23
Guidelines
The following guidelines apply when 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
In the following examples, the spacespacespace represents trailing spaces.
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
24
User Guide
Options
The following table explains the options for xcomd:
Option
-c[y]
Explanation
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.
Operating Environment
25
Option
Explanation
-dtracelevel
-r
-s
Starting xcomd
To start xcomd, enter the following command at the system prompt:
/etc/xcomd
Note: The full path name specification for xcomd is /etc/xcomd, except for the
following:
26
User Guide
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
The parameters for xcom.glb are shown below.
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:
CONVERT_CLASSES
A character string containing print classes for EBCDIC-to-ASCII conversions to
be performed. For incoming report transfers only.
Range: 1 to 64 characters
Default: None
Operating Environment
27
DISPLAY_PASSWORD_IN_TRACE
Determines if Unicenter CA-XCOM Data Transport displays password
information in the trace files.
Range: The range of values is listed in the following table:
Value
Description
YES
ENCRYPT
NO
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:
28
User Guide
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.
Note: If EXPIRATION_TIME is set to no value in xcom.glb, the program default
of 6000 is used.
Range: 0 to 32767
Default: 6000
INTERNAL_CONVERSION_TABLES
Indicates whether internal or external conversion tables should be used for
ASCII-to-EBCDIC conversion and EBCDIC-to-ASCII conversion. The external
conversion files may be customized to meet your needs. For the appropriate
directory and file name, see ATOE_FILENAME and ETOA_FILENAME.
Range: The range of values is listed in the following table:
Value
Description
YES
NO
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
Operating Environment
29
MAX_REMOTE_TCP
The maximum number of simultaneous remote TCP/IP transfers accepted by
Unicenter CA-XCOM Data Transport. Transfers received after this limit has been
reached are rejected.
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
The type of communication protocols to use.
Range: The range of values is listed in the following table:
Value
Description
SNA
TCPIP
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.
210
User Guide
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
Directory containing the transfer queue data files.
Range: 0 to 256 characters
Default: /usr/spool/xcom/Q, except for the following:
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
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:
Operating Environment
211
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
NO
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
212
User Guide
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:
TEMPDIR
Indicates the directory in which temporary files for jobs and reports can be
created.
Range: 1 to 256 characters
Default: /tmp
Operating Environment
213
TP_CMD
Command to start a transaction program using SNA protocols.
Range: 0 to 256 characters
Default:
TRACE_PATH
The directory containing the trace data files.
Range: 0 to 256 characters
Default: /usr/spool/xcom/trace, except for the following:
TRUSTED_PATH
The directory containing the trusted files.
Default: /user/spool/xcom/trusted
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
214
User Guide
TXPI_SEND_CHECK_FREQ
Indicates the frequency that Unicenter CA-XCOM Data Transport checks to see if
incoming error information is available when sending data. For example, if the
value is 5, a check is made every fifth time that data is sent, to determine if data
is available for receiving. Larger values give better performance. Smaller values
minimize the sending of data after the partner reports an error. Used for TCP/IP
transfers only.
Range: 0 to 9999
Default: 10
TXPI_TERM_TIMEOUT
Maximum wait time, in seconds, for partner to terminate TCP/IP
communications. If a transfer terminates normally, both sides of the conversation
coordinate the termination, and there should be no need to wait. This timeout
will occur only during an error in the termination of the connection. Used for
TCP/IP transfers only.
Range: 0 to 999 seconds
Default: 20 seconds
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
Operating Environment
215
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
This is the default user ID for remotely initiated transfers.
Range: 0 to 12 characters
Default: xcom
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:
216
User Guide
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:
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:
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:
Operating Environment
217
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:
XTRACE
Indicates the level of desired execution for incoming transfers.
Range: The range of values is listed in the following table:
Value
Description
No tracing.
1 to 8
10
Default: 0
218
User Guide
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.
To specify a remote system, as indicated in the example in this section, replace
connection_profile with the destination address or name specified by the user in
the remote system parameter. (REMOTE_SYSTEM, REMOTE_SYSTEM_RF,
REMOTE_SYSTEM_SJ, or REMOTE_SYSTEM_SR.)
Note: Unicenter CA-XCOM Data Transport reserves memory for information
about the number of sessions for each destination based upon the
connection_profile entries in this file.
Transfers Using SNA
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.
Transfers Using TCP/IP
For transfers using TCP/IP, specify the format of the remote system that is
consistent with your sites 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
In the following example, a sample xcom.ses file of session control parameters
for Unicenter CA-XCOM Data Transport partners is shown. It indicates that a
maximum of 8 sessions can be used at any one time for locally initiated transfers
to a remote system identified as XCOMQA3 and a maximum of 4 sessions can be
used at any one time for locally initiated transfers to a remote system identified
as XCOMQA4. It indicates that a maximum of 4 simultaneous transfers can go to
123.123.78.91.
# connection_profile=number_of_sessions_allowed
#
XCOMQA3=8
XCOMQA4=4
123.123.78.91=4
Operating Environment
219
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
The following table explains the options for xcomqm:
Option
220
User Guide
Function
-r
-Aentryname
-Centryname
-Dentryname
-Hentryname
Option
Function
-L[a]
-Rentryname
-Rfentryname
-R*
-Tentryname
-T[f]entryname
-Sentryname
Suspend a transfer.
-Eentryname
-d
no option
-z
Note: entryname represents the Transaction ID, which is the six-digit name of the
transfer entry in the queue.
Operating Environment
221
Syntax
The syntax for CLEANLOG is as follows:
CLEANLOG number_of_days_old [log_file_name]
Value
Description
number_of_days_old
log_file_name
Example
CLEANLOG 5
This command removes entries in XCOM.LOG that are older than 5 days.
222
User Guide
Using xcompre
An xcompre shell script is provided with Unicenter CA-XCOM Data Transport
as a sample script, and is available online. It is an option to run an exit on the
local system before the transfer starts. It can be tailored to meet individual user
requirements. The xcompre exit collects and passes transfer ID information (tid)
to xcomqm, along with the parameter values specified by the available options, g and -p.
Note: The -g and -p options, for use with xcomqm, as shown in the sample script
are intended only for use with this exit.
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 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 preallocation exit is invoked before sending the Unicenter CA-XCOM Data
Transport header to a remote partner.
Operating Environment
223
xcompre Options
The available options for xcompre and their associated parameters are listed
below:
Option
Function
-g
-p
Sample Script
The following is the sample xcompre script.
#!/bin/sh
# @(#)xcompre.sh
#
#
#
tid=$1
echo $1 > /tmp/$tid.tidlog
# required for HPUX-10
if [ `uname` = 'HP-UX' ]
then PATH=/opt/xcom/bin:$PATH
fi
xcomqm -g$tid |grep USERID > /tmp/$tid.userlog
224
User Guide
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.
Operating Environment
225
Process Summary
To modify a post processing script, follow these steps:
1.
Invoke an editor, such as vi, and open the script you want to modify.
2.
3.
4.
Troubleshooting
For script problems, uncomment the debugging statements included in the
sample script and rerun the script. The debugging section is clearly marked.
Debugging information is written to the file specified in the first statement.
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.
226
User Guide
Sample Script
The following is the sample xcompp script:
#!/bin/sh
# @(#)xcompp.sh 1.1
#
#
#
#
#
3/27/92 20:19:33
Operating Environment
227
#
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
The xcomend script is a script that is invoked by a Unicenter CA-XCOM Data
Transport transfer program. This script can be used as provided, or it can be
used by system administrators to modify printing commands and parameters to
provide additional information about all types of transfers (remote and local;
send and receive; successful or failed). Different arguments are passed
depending on whether the transfer is a file, job, or report. This script can be used
to define the context of the transfer, such as indicating that a remotely initiated
send transfer failed with a particular message.
Sample Script
The following is the sample xcomend script:
#!/bin/sh
# @(#)xcomend.sh 1.0
#
#
#
#
#
8/1/96 12:23:04
228
User Guide
#exec 2>&1
#set -vx
#PS4='[$0: $LINENO]+ '
#export PS4
###### END OF DEBUG SECTION ######
#
#
local_reqno=$1
# local request number/tid (000000 if unassigned)
shift
initiator=$1
# LOCAL or REMOTE
shift
transfer_type=$1 # FILE or JOB or REPORT
shift
direction=$1
# SEND or RECEIVE
shift
restarting=$1
# RESTARTING or FIRST_TRY
shift
start_time=$1
# Start time of transfer
shift
end_time=$1
# End time of transfer
shift
remote_system=$1 # Remote system name
shift
status=$1
# Status of transfer
shift
error=$1
# XCOM file transfer numeric error code
shift
msg=$1
# error code translated to message text
shift
status_msg=$1
# status message from partner when error on remote sys
shift
remoteuser=$1
shift
# Remote user
remote_reqno=$1
# Remote request Number
shift
group=$1
# Group name
shift
sysdata=$1
# System Dependent User Data
shift
xferdata=$1
# Transfer Dependent User Data
shift
transfer_name=$1 # Transfer Name
shift
tmp_file=$1
shift
file=$1
shift
remote_file=$1
shift
# Compression flag
# No. of records read/written
# No. of bytes
read/written
Operating Environment
229
shift
blocks=$1
shift
bytes=$1
shift
#
#
# No. of blocks
# No. of bytes
sent/received
sent/received
if [ $transfer_type = "FILE" ]
then
fileaction=$1
# File action (C, R, or A for create, replace, or append)
shift
datasettype=$1
# Dataset type
shift
recfm=$1
# Record format
shift
lrecl=$1
# Logical record length
shift
truncation_flag=$1
# Truncation flag
shift
#
#
The next group of parameters are supplied for report transfers only
230
User Guide
exit 0
Using xcomlp
The xcomlp script is a shell script that is invoked by the Unicenter CA-XCOM
Data Transport transaction program (XCOMSEND).
The contents of the parameters passed to xcomlp depend on what is supplied on
the initiating side of the transfer. The only field that can be absolutely relied on is
the file name. The sample procedure also assumes that the COPIES= field is
valid, in addition to assigning each incoming argument to an appropriately
named variable. For information regarding the processing machine code
characters, see the section, Reports Containing Machine Code Characters, later in
this chapter.
Sample Script
The following is the sample xcomlp script:
#!/bin/sh
# @(#)xcomlp.sh 1.1
3/27/92 20:19:33
#
#
#
#
#
#
file
and
copies
# Remote lu name
# Job name field from JES
Operating Environment
231
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.
lp
Using xcomntfy
The supplied script uses mailx(1) to notify the named user logins.
Sample Script
The following is the xcomntfy script:
#!/bin/sh
# @(#)xcomntfy.sh
1.2
3/28/92 08:42:41
#
This procedure (xcomntfy) is called by Unicenter CA-XCOM Data Transport
#
transaction program when the NOTIFY parameter is set to YES.
#
232
User Guide
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
Operating Environment
233
xcom.trusted
;;
[A]* )
xcomqm -D$q_entryname|
(wall || $MAIL -s "xfer $q_entryname" ${login:-${LOGNAME:-root}})
>/dev/null 2>&1
;;
* )
;;
esac
# put user defined notification
# script here
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.
234
User Guide
xcom.trusted
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.
Use your preferred text editor to maintain the file.
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:
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.
Operating Environment
235
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
#
The report is sent from a machine code type data set, such as FBM.
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.
Unicenter CA-XCOM Data Transport supports the following machine code
characters:
SKIP
SKIP
SKIP
SKIP
236
User Guide
ONE LINE
TWO LINES
THREE LINES
TO CHANNEL1-12
WRITE
WRITE
WRITE
WRITE
WRITE
NO SPACE
ONE SPACE
TWO SPACES
THREE SPACES
& 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.
Operating Environment
237
Chapter
31
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.
From the command line, copy xcom.cnf to a new file. Enterthe following:
cp /usr/spool/xcom/config/xcom.cnf configfilename.cnf
3.
4.
Example 1
In the following example, Unicenter CA-XCOM Data Transport is invoked from
the command line and a configuration file is specified.
xcom62 [ -cnumber] [ -f [configfilename]
[PARAMETER_NAME=value ...] ]
32
User Guide
Transferring Files
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.
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
installations 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.
33
Transferring Files
Using xcom62
For performing transfers using SNA/APPC protocols, xcom62 allows you to
initiate the transfer of a file, a job or a report from the command line, and to
specify the parameters to be used for that transfer.
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.
34
User Guide
Transferring Files
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
-cnumber
-h
Explanation
The type of transfer to be attempted. Valid values for
number are:
Value
Description
-r
-q
35
Transferring Files
Option
Explanation
-s
-t
-i
-f configfilename
PARAMETERNAME=
value...
36
User Guide
no options
-v
-x
37
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
38
User Guide
The formats of the IP address, host name, and domain name are described in the
following table:
Value
Description
IP address
Host Name
Domain Name
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.
39
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.
310
User Guide
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
In the following example, the xcomtcp command is used to submit a transfer
directly, without sending it to the queue, using TCP/IP. The configuration file is
myconfig.cnf, the local file is named testa.aaa, and the remote file is named
testb.bbb. The remote system is indicated by the fully qualified domain name
goodsys.goodsite.com in the REMOTE_SYSTEM parameter. QUEUE is set to NO, so
the transfer starts immediately after you press Enter. TCP/IP is indicated by the
value TCPIP in the PROTOCOL parameter. (If the default value in the
configuration file or the xcom.glb file is TCPIP, you do not need to specify this
value here.) The port is indicated by the value 8044 in the PORT parameter.
Note: 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
The types of communication protocols to use are described following.
Range: The range of values is listed in the following table:
Value
Description
SNA
TCPIP
Default: SNA
311
List of Parameters
The communications and data transfer configuration parameters are shown
below.
CODETABL
Specifies the prefix to the file names, atoe.tab and etoa.tab, that contain the
external ASCII-to-EBCDIC and EBCDIC-to-ASCII custom character conversion
tables. These custom character conversion tables determine which external
translation tables will be used by the transfer.
Note: This parameter is valid only if INTERNAL_CONVERSION_TABLES=NO.
Range: 0 to 12 characters
Default: None
312
User Guide
COMPRESS
Indicates the compression type. When communicating with an IBM mainframe,
if the data file contains any empty lines, COMPRESS can only be set to YES,
LZSMALL, LZMEDIUM, or LZLARGE.
Note: All 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:
Note: The LZ values enable LZ (Lempel-Ziv) compression to replace sequences
of data bytes that occur more than once in a data stream with a code value.
Value
Description
COMPACT
LCOMPACT
LZLARGE
LZMEDIUM
LZRW3
LZSMALL
NO
Indicates no compression.
RLE
YES
ZLIBn
Default: YES
313
DESTINATION_TYPE
The type of target system.
Range: HOST, MIDRANGE, or OTHER
Default: OTHER
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
314
User Guide
MAX_REMOTE_TCP
The maximum number of remote TCP/IP transfers accepted by Unicenter
CA-XCOM Data Transport. Transfers received after this limit has been reached
are rejected.
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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems IP address, host
name, or domain name.
Range: 1 to 256 characters
Default: None
315
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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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
316
User Guide
TRUNCATION
Indicates whether Unicenter CA-XCOM Data Transport truncates excess
characters in the source file if the record exceeds the maximum record length as
indicated by the MAXRECLEN parameter. If NO is selected, and the maximum
record length is exceeded, Unicenter CA-XCOM Data Transport aborts the
transfer. This parameter is ignored if CARRIAGE_FLAG=NO.
Note: Truncation is not valid for BINARY data or for non-text data received on
the UNIX or Linux platform.
Range: YES or NO
Default: NO
VERSION
Indicates the version of the Unicenter CA-XCOM Data Transport protocol to be
used for this transfer. For TCP/IP, only a value of 2 is valid.
Range: 1 or 2
Default: 2
Note: This is a Version 2 parameter.
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
317
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
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
318
User Guide
Parameters
The Send File parameters are shown below.
CREATE_DIR
Indicates whether to create the specified directory if it does not exist.
Value
Description
YES
NO
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
APPEND
REPLACE
Description
CREATE
APPEND
REPLACE
319
320
User Guide
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.
Note: For send file transfers only.
Range: 1 to 256 characters
Default: None
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
321
Parameters
The Retrieve File parameters are shown below.
FILE_OPTION_RF
Indicates how the transferred data is to be processed by the receiving system
(that is, the local system). Used when the transfer type is Retrieve File. If a value
is not specified, then the value of FILE_OPTION is used. If no default is specified
in FILE_OPTION or FILE_OPTION_RF, then the value defaults to CREATE.
Range: The range of values is listed in the following table:
Value
Description
CREATE
APPEND
REPLACE
Description
CREATE
APPEND
REPLACE
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/*.
322
User Guide
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.
Note: If QUEUE=YES, the full path name must be specified.
Range: 0 to 256 characters
Default: None
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.
When a prefix is followed by an asterisk, all members beginning with a specific
prefix are transferred. For example, REMOTE_FILE_RF=/NAMES/AL* requests
that files AL, ALEX, and ALICE should be transferred. The same rules apply if
an asterisk is followed by a suffix.
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.
Note: For retrieve file transfers only.
Range: 1 to 256 characters
Default: None
323
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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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
324
User Guide
Parameters
The following parameters are used when FILE_OPTION=CREATE when
creating a file on an IBM mainframe from a local system.
ALLOCATION_TYPE
Indicates the unit of storage allocation for a data set created on an IBM
mainframe.
Range: The range of values is listed in the following table:
Value
Description
CYL
Cylinders
TRK
Tracks
BLK
Blocks
Default: CYL
Note: This is a Version 2 parameter.
325
BLKSIZE
Specifies the block size of a data set created on an IBM mainframe.
Note: Used when FILE_OPTION=CREATE
Range: 0 to 32767
If the format is
Variable record
Undefined record
Default: 800
DATACLAS
Specifies the name of the data class to use when allocating a new SMS-managed
data set.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
DSNTYPE
Specifies the data set definition.
Note: This parameter applies only to mainframe SMS data sets.
Value
Description
LIBRARY
Defines a PDSE
PDS
326
User Guide
LRECL
Specifies the actual or maximum length, in bytes, of a logical record.
Corresponds to the JCL LRECL subparameter.
Range: 0 to 32767
If the format is
Default: 160
MGMTCLAS
Specifies the name of the management class to use when allocating a new SMSmanaged data set.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
NUM_OF_DIR_BLOCKS
Specifies the number of directory blocks to allocate for a data set created on an
IBM mainframe.
Range: 0 to 32767
Default: 0
Note: Version 2 parameter
PRIMARY_ALLOC
Identifies primary storage allocation for a data set created on an IBM mainframe.
Range: 0 to 99999
Default: 1
Note: Version 2 parameter
327
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:
328
User Guide
Value
Description
Record Length
Comment
Fixed unblocked
FA
Fixed unblocked
ANSI
FB
Fixed blocked
Fixed
FBA
Fixed blocked
ANSI
Fixed
FBS
Fixed blocked
spanned
Fixed
FM
Fixed unblocked
machine
FS
Fixed unblocked
spanned
Undefined
Undefined
Variable
unblocked
Variable
VA
Variable
unblocked ANSI
Variable
Contains
ISO/ANSI/FIPS control
characters
VB
Variable blocked
Variable
Value
Description
Record Length
Comment
VBA
Variable blocked
ANSI
Variable
VBM
Variable blocked
machine
Variable
VBS
Variable blocked
spanned
Variable
VM
Variable
unblocked
machine
Variable
VS
Variable
unblocked
spanned
Variable
Default: VB
SECONDARY_ALLOC
Identifies secondary storage allocation for a data set created on an IBM
mainframe.
Range: 0 to 99999
Default: 0
Note: This is a Version 2 parameter.
329
SECURE_SOCKET
Specifies whether to use an OpenSSL socket or Non OpenSSL socket for
transfers.
Value
Description
YES
NO
Default: NO
STORCLAS
Specifies the name of the storage class for a new SMS-managed data set.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
UNIT
Specifies the unit on which a data set is to be created on an IBM mainframe.
Note: Used when FILE_OPTION=CREATE.
Range: 0 to 6 characters
Default: None
VOLUME
Specifies the volume on which a data set is to be created on an IBM mainframe.
Range: 0 to 6 characters
Default: None
330
User Guide
XCOM_CONFIG_SSL
Specifies the configssl.cnf file path and file name.
Range: 1 to 256 characters
Default: /usr/locl/ssl/configssl.cnf
XCOM_SHOW_CIPHER
Specifies whether to display encryption algorithms in the Unicenter CA-XCOM
Data Transport queue detailed information, which is used for transfers.
Value
Description
NO
YES
Default: NO
331
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:
AL, AUL, BLP,
LTM, NL, NSL, SL,
SUL
Note: Unicenter CA-XCOM Data Transport for z/OS supports only standard
label tapes.
Example: LABEL=BLP
The type of processing to be applied to this data set is BLP.
Default: AL
332
User Guide
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
(0001-9999)
Example: LABELNUM=2
This specification refers to the second data set on the tape.
Default: 0001
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
333
TAPEDISP
Specifies the disposition value for MVS tape data sets.
Range: The range of values is listed in the following table:
Value
Description
New
Old
Mod
Default: 1
UNITCT
Specifies the number of units to be allocated on the remote system.
Range: 1 to 20
Default: None
VOLCT
Specifies the maximum number of volumes to be used in processing a
multivolume output tape data set on the remote system.
Range: 1 to 255
Default: None
VOLSQ
Specifies the sequence number of the first volume of a multi-volume remote data
set to be used.
Range: 1 to 255
Default: None
334
User Guide
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
The Send Report parameters are shown below.
CARRIAGE_CONTROL_CHARACTERS
Indicates the type of printer carriage-control codes, if any, that are included in
the report file.
Note: For report transfers only.
Range: The range of values is listed in the following table:
Value
Description
ASA
IBM
335
Value
Description
BYPASSASA
OTHER
Default: OTHER
CLASS
The print class assigned to a report transferred to a remote system.
If the remote system is an IBM mainframe, this field designates the JES SYSOUT
class.
Note: For report transfers only.
Example: Enter B to print the report through SYSOUT=B.
Range: 1 character
Default: None
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 systems 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
0 to 21 characters
Default: None
336
User Guide
DISPOSITION
Indicates what the remote system does with the report file after the report has
been printed. For report transfers only.
Note: This field is not used when the remote system is an IBM mainframe.
Range: The range of values is listed in the following table:
If the value Is
DELETE
Deleted
KEEP
Kept
HOLD
Held
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
Indicates whether a transferred report file is to be placed on HOLD on the
remote system or is to be printed immediately. For report transfers only.
Range: YES or NO
Default: NO
337
LOCAL_FILE_SR
Local file name to be sent as a report to the remote system. If this value is null or
unset, then Unicenter CA-XCOM Data Transport reads the standard input file.
For report transfers only.
Note: If QUEUE=YES, user must specify full path name.
Range: 0 to 256 characters
Default: None
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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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:
8 characters
2 characters
8 characters
Job Name
Blanks
Job Number
The Job ID is optional and can be skipped. The Job Name can also be skipped,
but if you skip the Job name and want to use the job number, you must pad the
number with 10 blanks.
Note: For report transfers only.
Examples
REPORT_TITLE=Salary94
REPORT_TITLE=
Non-example
REPORT_TITLE=
338
User Guide
Job12345
Job23456
Job34567
This is not a valid REPORT_TITLE because the Job Number spans both subfields.
This parameter is used by Unicenter CA-XCOM Data Transport on remote
systems in the following ways:
System
z/OS
VAX/VMS
UNIX/Linux
Other systems
339
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.
340
User Guide
Tracing Problems
Parameters
The Send Job parameters are shown below.
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.
Note: If QUEUE=YES, user must specify full path name.
Range: 0 to 256 characters
Default: None
REMOTE_SYSTEM_SJ
The name of the remote system to which a job is sent. If no value is specified
here, the value in REMOTE_SYSTEM is used.
For SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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.
341
Tracing Problems
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
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
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
Message XCOMU0298E would give 42 as the return code (298-256= 42).
Refer to /usr/include/xcom/xcomerr.h. These return codes are not modulo 256.
342
User Guide
Parameters
The tracing parameter is shown below.
XTRACE
Indicates the level of desired execution tracing.
Range: The range of values is listed in the following table:
Value
Description
No tracing.
1 to 8
10
Default: 0
Note: Turning on the trace can seriously degrade performance.
343
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
The logging parameter is shown below.
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: Specify the full pathname if QUEUE=YES.
Range: 0 to 256 characters
Default: /usr/spool/xcom/xcom.log, except for the following:
344
User Guide
ASCII to EBCDIC
/usr/spool/xcom/convtab/atoe.tab
EBCDIC to ASCII
/usr/spool/xcom/convtab/etoa.tab
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.
The file type parameters are listed next.
345
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
NO
MPACK
VLR
VLR2
XPACK
Indicates a text file with record packing. Uses 31K pack buffer.
Note: MPACK does not support a MAXRECLEN (actual record length) over 2K.
XPACK does not support a MAXRECLEN (actual record length) over 31K.
Default: YES
CODE_FLAG
Used to identify the type of data being transferred.
Range: The range of values is listed in the following table:
346
User Guide
Value
Description
ASCII
BINARY
Value
Description
EBCDIC
Default: ASCII
From the command line, use vi or another editor to create and open a file.
2.
347
Unicenter CA-XCOM Data Transport for UNIX or Linux performs the EBCDIC
to ASCII translation as follows:
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
An A is received from the mainframe in EBCDIC. Set up the translation table to
translate it to ASCII.
The EBCDIC code for A is 193 (decimal). The ASCII code for A is 65. Take the
EBCDIC code for A and add 1. This is 194. Go to line 194 of the ETOA table and
type the value 65.
348
User Guide
/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
349
Procedure
To translate all lower case ASCII characters to upper case EBCDIC characters,
follow these steps:
1.
Use vi or another editor to open the file and copy the values from lines 66 to
91 to lines 98 to 123.
Note: The decimal ASCII code for a is 98 and the decimal ASCII code for z is
123.
The values in lines 98-123 are changed to represent uppercase EBCDIC
characters.
3.
350
User Guide
2.
3.
4.
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.
351
Parameters
The store and forward parameter is shown below.
XIDEST
Specifies the name of the remote system on the intermediate destination that is
designated for store and forward transfers. If this variable is null or unset, then a
direct connection to a remote system is attempted.
Note: For store and forward transfers only.
Range: 0 to 14 characters
Default: None
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.
352
User Guide
Parameters
The security parameters are shown below.
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
The password associated with the user ID on a remote system.
Range: 0 to 31 characters
Default: None
TRUSTED
Allows the user to request a trusted transfer and the partners Unicenter
CA-XCOM Data Transport TRUSTED database to be searched to verify the users
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.
Note: TRUSTED=YES cannot be specified with indirect transfers, because this is
not supported.
Range: YES, NO, Y, N
Default: NO
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
353
to
PARAMETER.ENCRYPTED=ENCRYPTEDVALUE
Example
Before encryption:
PASSWORD=ENIGMA
After encryption:
PASSWORD.ENCRYPTED=12 0F 36 79 65 AB D0 37 ...
Syntax
The syntax for using XCOMENCR is as follows:
xcomencr input_file output_file
Options
The following table explains the options for XCOMENCR:
Option
(minus sign)
+
354
User Guide
Explanation
Send output to stdout.
Example: xcomencr input_file Replace input_file.
(plus sign)
no options
Procedure
To encrypt a parameter value using XCOMENCR, follow these steps:
1.
Using a text editor, open the configuration file you want to modify, go to the
parameter you want to encrypt, create a blank line above it, and enter the
following:
#!ENCRYPT
3.
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.
355
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.
356
User Guide
Parameters
The queue management parameters are shown below.
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
NORMAL
LOW
Default: NORMAL
QUEUE
Indicates whether to execute the transmission request immediately or to allow
the request to be queued. If the user does not specify a .cnf file, and has not
changed a .cnf file, the default value is YES.
Note: If NO is specified and the remote system is unavailable, the request aborts.
If YES is specified, START_TIME and START_DATE are read.
Range: The range of values is listed in the following table:
Value
Description
YES
NO
Default: YES
357
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.
358
User Guide
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
The notification parameters are shown below.
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
Specifies the local user notification level.
Range: The range of values is listed in the following table:
Value
Description
A or ALL
W or WARN
E or ERROR
Default: ALL
359
NOTIFYL
The local user notification flag.
Range: The range of values is listed in the following table:
Value
Description
WRITE
NONE
No notification is sent.
ALL
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.
Note: If the remote system is an IBM mainframe, Unicenter CA-XCOM Data
Transport uses the value of NOTIFYR to determine the type of notification to
deliver.
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
Specifies which terminals to write to if NOTIFYL=WRITE. If NOTIFY_TERM is
not set, all users specified in LOCAL_NOTIFY are notified at the first terminal
where they are logged in, as found in the system table.
Range: 0 to 256 characters
Default: None
360
User Guide
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
TSO
WTO
CICS
LU
ROSCOE
NONE
No notification is sent.
ALL
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
W or WARN
E or ERROR
Default: ALL
361
All other necessary parameters are read from the default configuration file,
xcom.cnf.
362
User Guide
Example 2
In the following example, the xcomtcp command is used. If the transfer is
interrupted, it restarts from the most recent checkpoint of every 2000 records,
and up to three attempts are made to retry the transfer at intervals of 30 seconds.
xcomtcp -f CHECKPOINT_COUNT=2000 NUMBER_OF_RETRIES=3
RESTART_SUPPORTED=YES RETRY_TIME=30
All other necessary parameters are read from the default configuration file,
xcom.cnf.
Parameters
The checkpoint and restart parameters are shown below.
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
Note: This is a Version 2 parameter.
NUMBER_OF_RETRIES
Maximum number of retries before a transfer is logged as failed and taken out of
the transfer queue. If the value is 0, no retries are attempted.
Range: 0 to 255
Default: 1
Note: This is a Version 2 parameter.
RESTART_SUPPORTED
Specifies whether automatic restart is to be supported on a transfer.
Range: YES or NO
Default: YES
Note: This is a Version 2 parameter.
363
RETRY_TIME
The number of seconds between retries of unsuccessful transfers.
Range: 0 to 99999
Default: 1
Note: This is a Version 2 parameter.
364
User Guide
Chapter
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.
41
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
The following libraries are required for performing non-queued TCP/IP
transfers:
libxcomcomp.a
libxcomtcp.a
libxcomtxpi.a
42
User Guide
Starting States
Valid starting states are as follows:
Starting State
Used For
LOCAL_SEND
LOCAL_RECEIVE
Return Values
43
44
User Guide
*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];
/*
char array_message[128];
char array_message2[128];
char array_err_message[128];
} XCOM_QUEUE_ENTRY;
user name */
/* return text from multi-entries */
/* return text from multi-entries */
/* return text from multi-entries */
45
char sdsmessage[160];
char head_message[128];
char queue_message[128];
char start_message[128];
char start_message2[128];
char end_message[128];
XCOM_QUEUE *pQueue;
/*
/*
/*
/*
} 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.
The XcomAPI member names are listed below in alphabetical order.
46
User Guide
allocation_type
Indicates the unit of storage allocation for a dataset 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
Variable
Undefined
Default: 800
47
carriage_control_characters
Indicates the type of printer carriage control codes, if any, that are included in
the report file
Note: For report transfers only.
Range: The range of values is listed in the following table:
Value
Description
ASA
IBM
BYPASSASA
OTHER
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:
48
User Guide
Value
Description
YES
NO
MPACK
VLR
VLR2
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
Note: Version 2 parameter.
class
The print class assigned to a report transferred to a remote system. If the remote
system is an IBM mainframe, this field designates the JES SYSOUT class.
Note: For report transfers only.
Example:
Enter B to print the report through SYSOUT=B.
Range: 1 character
Default: None
code_flag
Used to identify the type of data being transferred.
Range: The range of values is listed in the following table:
Value
Description
ASCII
BINARY
49
Value
Description
EBCDIC
Default: ASCII
codetabl
Specifies the prefix to the file names, atoe.tab and etoa.tab, that contain the
external ASCII-to-EBCDIC and EBCDIC-to-ASCII custom character conversion
tables. These custom character conversion tables determine which external
translation tables will be used by the transfer.
This parameter is valid only if INTERNAL_CONVERSION_TABLES=NO.
Range: 0 to 12 characters
Default: None
compress
Indicates the compression type. When communicating with an IBM mainframe,
if the data file contains any empty lines, COMPRESS can only be set to YES,
LZSMALL, LZMEDIUM or LZLARGE.
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:
Note: The LZ values enable LZ (Lempel-Ziv) compression to replace sequences
of data bytes that occur more than once in a datastream with a code value.
410
User Guide
Value
Description
COMPACT
LCOMPACT
LZLARGE
LZMEDIUM
Value
Description
LZRW3
LZSMALL
NO
Indicates no compression.
RLE
YES
ZLIBn
Default: YES
convert_classes
A character string containing print classes for which EBCDIC-to-ASCII
conversions are performed. For incoming report transfers only.
Range: 1 to 64 characters
Default: None
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 systems 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.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
411
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.
Note: <tid> refers to the 6-digit transfer ID number.
Range: The range of values is listed in the following table:
Value
Description
YES
NO
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
0 to 21 characters
Default: None
412
User Guide
disposition
Indicates what the remote system does with the report file after the report has
been printed. For report transfers only.
Note: This field is not used when the remote system is an IBM mainframe.
Range: The range of values is listed in the following table:
If the value is
DELETE
Deleted
KEEP
Kept
HOLD
Held
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
Specifies the data set definition.
Note: This parameter applies only to mainframe SMS data sets.
Value
Description
LIBRARY
Defines a PDSE
PDS
413
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
APPEND
REPLACE
Default: CREATE
414
User Guide
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
Indicates whether this transferred report file is to be placed on HOLD status on
the remote system or is to be readied for immediate printing. Specify Y to request
that it be held (spooled) on an MVS system.
Range: YES or NO
Default: NO
415
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:
AL, AUL, BLP, LTM,
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
(0001-9999)
Default: 0001
lclntfyl
Specifies the local user notification level.
Range: The range of values is listed in the following table:
Value
Description
A or ALL
W or WARN
E or ERROR
Default: ALL
416
User Guide
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.
When a prefix is followed by an asterisk (*), all members beginning with a
specific prefix are to be transferred. For example, LOCAL_FILE=/NAMES/AL*
requests that files AL, ALEX, and ALICE are all to be transferred. The same rules
apply if an asterisk is followed by a suffix.
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.
Note: If QUEUE=YES, user must specify full path name.
Range: 0 to 256 characters
Default: None
local_file_rf
The file name that is created, appended, or replaced on the local system when it
receives a file. At the command prompt or in a script, if this value is null or
unset, then Unicenter CA-XCOM Data Transport writes to the 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.
417
418
User Guide
lrecl
Specifies the actual or maximum length, in bytes, of a logical record.
Corresponds to the JCL LRECL subparameter.
Range: 0 to 32767
If the format is
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
419
mgmtclas
Specifies the name of the management class to use when allocating a new SMSmanaged data set.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
notify_name
The user on the remote system who is notified when Unicenter CA-XCOM Data
Transport completes a transfer.
Note: If the remote system is an IBM mainframe, Unicenter CA-XCOM Data
Transport uses the value of NOTIFYR to determine the type of notification to
deliver.
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.
Range: The range of values is listed in the following table:
Value
Description
WRITE
NONE
No notification is sent.
ALL
Default: None
420
User Guide
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
TSO
WTO
CICS
LU
ROSCOE
NONE
No notification is sent.
ALL
Default: None
notify_term
Specifies terminals to write if NOTIFYL=WRITE. If NOTIFY_TERM is not set, all
users specified in LOCAL_NOTIFY are notified at the first terminal where they
are logged in as found in the system table.
Range: 0 to 256 characters
Default: None
number_of_retries
Maximum number of retries before a transfer is logged as failed and taken out of
the transfer queue. If the value is 0, no retries are attempted.
Range: 0 to 255
Default: 1
Note: Version 2 parameter.
421
num_of_dir_blocks
Specifies the number of directory blocks to allocate for a dataset created on an
IBM mainframe.
Range: 0 to 32767
Default: 0
Note: Version 2 parameter
password
The password associated with the user ID on a remote system.
Range: 0 to 31 characters
Default: None
primary_alloc
Identifies primary storage allocation for a data set created on an IBM mainframe.
Range: 0 to 99999
Default: 1
Note: Version 2 parameter
port
The number of the TCP/IP port on the remote Unicenter CA-XCOM Data
Transport server. Used for TCP/IP transfers only.
Range: 0 to 65535
Default: 8044
422
User Guide
protocol
The type of communication protocols to use.
Range: The range of values is listed in the following table:
Value
Description
SNA
TCPIP
Default: SNA
queue
Indicates whether to execute the transmission request immediately or to allow
the request to be queued. If the user does not specify a .cnf file, and has not
changed a .cnf file, the default value is YES.
Note: If NO is specified and the remote system is unavailable, the request aborts.
If YES is specified, start_time and start_date are read.
Range: The range of values is listed in the following table:
Value
Description
YES
NO
Default: NO
423
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
W or WARN
E or ERROR
Default: ALL
record_format
Specifies the record format of a dataset created on an IBM mainframe. This
corresponds to the JCL RECFM subparameter.
Range: The range of values is listed in the following table:
424
User Guide
Value
Description
Record Length
Comment
Fixed unblocked
FA
Fixed unblocked
ANSI
Contains
ISO/ANSI/FIPS control
characters.
FB
Fixed blocked
Fixed.
FBA
Fixed blocked
ANSI
Fixed.
FBS
Fixed blocked
spanned
Fixed.
FM
Fixed unblocked
machine
Value
Description
Record Length
Comment
FS
Fixed unblocked
spanned
Written as standard
blocks where these
records do not contain
any truncated blocks or
unfilled tracks.
Undefined
Undefined.
Variable
unblocked
Variable.
VA
Variable
unblocked ANSI
Variable.
Contains
ISO/ANSI/FIPS control
characters.
VB
Variable blocked
Variable.
VBA
Variable blocked
ANSI
Variable.
VBM
Variable blocked
machine
Variable.
VBS
Variable blocked
spanned
Variable.
VM
Variable
unblocked
machine
Variable.
VS
Variable
unblocked
spanned
Variable.
Default: VB
425
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.
Note: For send file transfers only.
Range: 1 to 256 characters
Default: None
remote_file_rf
Indicates the name of the file to be retrieved from the remote system.
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.
When a prefix is followed by an asterisk, all members beginning with a specific
prefix are transferred. For example, REMOTE_FILE_RF=/NAMES/AL* requests
that files AL, ALEX, and ALICE should be transferred. The same rules apply if
an asterisk is followed by a suffix.
426
User Guide
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.
Note: For retrieve file transfers only.
Range: 1 to 256 characters
Default: None
remote_system
The name of the remote system that receives a file, job or report.
For SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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
427
report_title
This field contains the report title and job number that will be printed on the
report. The field has the following format:
8 characters
2 characters
8 characters
Job Name
Blanks
Job Number
The Job ID is optional and can be skipped. The Job Name can also be skipped,
but if you skip the Job name and want to use the job number, you must pad the
number with 10 blanks. For more information, see the appendix Parameters.
Note: For report transfers only.
Range: 0 to 21 alphanumeric or blank characters
Default: None
restart_supported
Specifies whether automatic restart is to be supported on a transfer.
Range: YES or NO
Default: YES
Note: Version 2 parameter.
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.
428
User Guide
secondary_alloc
Identifies secondary storage allocation for a dataset created on an IBM
mainframe.
Range: 0 to 99999
Default: 0
Note: Version 2 parameter.
secure_socket
Specifies whether to use an OpenSSL socket or non-OpenSSL socket for transfers.
Value
Description
YES
NO
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
Indicates whether the report is to be spooled to disk or printed immediately. For
report transfers only.
Note: If the remote system is an IBM mainframe, this parameter has no effect on
the transfer.
Range: YES or NO
Default: YES
429
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.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
tape
Indicates to the remote system whether the volume is a tape volume or a disk
file. 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
430
User Guide
tempdir
Indicates the directory in which temporary files for jobs and reports can be
created.
Range: 1 to 256 characters
Default: /tmp
truncation
Indicates whether Unicenter CA-XCOM Data Transport truncates excess
characters in the source file if the record exceeds the maximum record length as
indicated by the MAXRECLEN parameter. If NO is selected, and the maximum
record length is exceeded, Unicenter CA-XCOM Data Transport aborts the
transfer. This parameter is ignored if CARRIAGE_FLAG=NO.
Note: Truncation is not 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 partners Unicenter
CA-XCOM Data Transport TRUSTED database to be searched to verify the users
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.
Note: TRUSTED=YES cannot be specified with indirect transfers, because this is
not supported.
Range: YES, NO, Y, N
Default: NO
unit
Specifies the unit on which a dataset is to be created on an IBM mainframe.
Note: Used when FILE_OPTION=CREATE.
Range: 0 to 6 characters
Default: None
431
unitct
Specifies the number of units to be allocated on the remote system.
Range: 1 to 20
Default: None
userid
The user ID which the security system on a remote system checks before granting
access for the file transfer.
Range: 0 to 12 characters
Default: None
version
Indicates the version of the Unicenter CA-XCOM Data Transport protocol to be
used for this transfer. For using TCP/IP, only a value of 2 is valid.
Range: 1 or 2
Default: 2
Note: Version 2 parameter.
volct
Specifies the maximum number of volumes to be used in processing a multivolume output tape data set on the remote system.
Range: 1 to 255
Default: None
volsq
Specifies the sequence number of the first volume of a multi-volume remote data
set to be used.
Range: 1 to 255
Default: None
432
User Guide
volume
Specifies the volume on which a dataset is to be created on an IBM mainframe.
Range: 0 to 6 characters
Default: None
xbuffsize
Specifies the buffer size to determine size of records to be read from UNIX or
Linux files.
xcom_config_ssl
Specifies the configssl.cnf file path and file name.
Range: 1 to 256 characters
Default: /usr/ spool/xcom/config/configssl.cnf, except for the following:
xcom_show_cipher
Specifies whether to display encryption algorithms in the Unicenter CA-XCOM
Data Transport queue detailed information, which is used for transfers.
Value
Description
NO
YES
Default: NO
433
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:
xidest
Specifies the name of the LU or TCP/IP address on the intermediate destination
that is designated for store-and-forward transfers. If this variable is null or unset,
then a direct connection to a remote system is attempted. If it contains a value, it
is taken to be the name of an intermediate Unicenter CA-XCOM Data Transport
that will handle traffic to and from the named remote system.
Note: For store-and-forward transfers only.
Range: 0 to 14 characters
Default: None
xlogfile
The name of the file where Unicenter CA-XCOM Data Transport logs activity. If
you do not specify this parameter, the systemwide log file
/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: If QUEUE=YES, specify the full path name.
Range: 0 to 256 characters
Default: /usr/spool/xcom/xcom.log, except for the following:
434
User Guide
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:
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
435
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
/usr/lib/xcom/xcomntfy
/opt/xcom/lib/xcomntfy
/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:
436
User Guide
System
Value
/usr/lib/xcom/xcompp
/opt/xcom/lib/xcompp
/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
The sample xcompre script is located in the directory as indicated below:
System
Value
/usr/lib/xcom/xcompre
/opt/xcom/lib/xcompre
Default: None
xtrace
Indicates the level of desired execution tracing.
Range: The range of values is listed in the following table:
Value
Description
No tracing
1 to 8
10
Default: 0
437
Option Parameters
The option parameters in the following list are used to pass and retrieve
information from the queue request.
funccode
Used to define a function parameter to pass to XcomQAPI().
438
User Guide
Value
Description
Aentryname
Centryname
Dentryname
Hentryname
L[ ]
La
Rentryname
Rfentryname
R*
Tentryname
Value
Description
Tfentryname
Sentryname
Suspend a transfer.
Eentryname
gentryname
pentryname
Note: The entryname variable represents the Transaction ID, which is the six-digit
name of the transfer entry in the queue.
tid
A queue entry TID number.
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
Defines maximum queue entries. The value should be set to equal
MAX_QUEUE_ENTRIES in the xcom.glb file.
trace_level
Defines the trace level. The value can be set to 0, 1, or 9.
439
API Examples
trace_filename
It defines a trace file name and its location; for example,
/usr/spool/xcom/trace/xcomqapi.tra.
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.
/* "1" */
440
User Guide
API Examples
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";
/* if queue = NO, must link with right xcom lib */
xcomparm.queue = "NO";
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;
441
API Examples
442
User Guide
API Examples
443
API Examples
444
User Guide
API Examples
if (strlen(xcomqparm->curr_state))
printf("%s", xcomqparm->curr_state);
if (strlen(xcomqparm->rec_read_write))
printf("%s", xcomqparm->rec_read_write);
if (strlen(xcomqparm->byte_read_write))
printf("%s", xcomqparm->byte_read_write);
if (strlen(xcomqparm->blocks_trans))
printf("%s", xcomqparm->blocks_trans);
if (strlen(xcomqparm->bytes_trans))
printf("%s", xcomqparm->bytes_trans);
if (strlen((*xcomqparm->pQueue)[0].array_message))
printf("%s", (*xcomqparm->pQueue)[0].array_message);
/* call option 'R*' to remove queue entries */
xcomqparm->funccode[0] = 'R';
xcomqparm->funccode[1] = '*';
rc=XcomQAPI(xcomqparm);
/* check for error message */
if (strlen((*xcomqparm->pQueue)[0].array_err_message))
printf("%s", (*xcomqparm->pQueue)[0].array_err_message);
/* display detail information for removed queue entries */
for (i = 0; i < xcomqparm->nQueueEntries; i++) {
printf("%s", (*xcomqparm->pQueue)[i].array_message);
printf("%s", (*xcomqparm->pQueue)[i].array_message2);
}
if ((xcomqparm->nQueueEntries == 0) && strlen((*xcomqparm>pQueue)[0].array_message))
printf("%s", (*xcomqparm->pQueue)[0].array_message);
if (!rc)
printf("==== Call XcomQAPI successful !\n");
else
printf("==== %s\n", msgstrng(rc, 0));
/* call option 'gxxxxxx' to display queue entry information */
memset(xcomqparm->lfile,0,sizeof(xcomqparm->lfile));
memset(xcomqparm->rfile,0,sizeof(xcomqparm->rfile));
memset(xcomqparm->file_option,0,sizeof(xcomqparm->file_option));
xcomqparm->funccode[0] = 'g';
strcpy(xcomqparm->tid, "000001");
rc=XcomQAPI(xcomqparm);
/* check for error message */
if (strlen((*xcomqparm->pQueue)[0].array_err_message))
printf("%s", (*xcomqparm->pQueue)[0].array_err_message);
/* display queue entry information */
if (strlen((*xcomqparm->pQueue)[0].array_message))
printf("%s", (*xcomqparm->pQueue)[0].array_message);
if (strlen(xcomqparm->group_name))
printf("%s", xcomqparm->group_name);
if (strlen(xcomqparm->lfile))
printf("%s", xcomqparm->lfile);
if (strlen(xcomqparm->rfile))
printf("%s", xcomqparm->rfile);
if (strlen(xcomqparm->user_name))
printf("%s", xcomqparm->user_name);
if (strlen(xcomqparm->transfer_type))
printf("%s", xcomqparm->transfer_type);
if (strlen(xcomqparm->file_type))
printf("%s", xcomqparm->file_type);
if (strlen(xcomqparm->file_option))
printf("%s", xcomqparm->file_option);
/* call option 'pxxxxxx' to change value: FILE_OPTION LOCAL_FILE
REMOTE_FILE
note: This option only allows to call when xcbp->state is in
PREALLOCATION_STATE */
445
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);
printf("====
QAPI ended
===\n");
}
}
/* free memory */
if (xcomqparm->pQueue != NULL)
free(xcomqparm->pQueue);
if (xcomqparm != NULL)
free(xcomqparm);
}
446
User Guide
Description
603
602
601
Permission denied.
600
469
-1
The named file does not exist or is not accessible in the given
mode.
-9
-1100
-1801
Code
Description
-1802
-1803
447
Chapter
Naming conventions
Additional features
Restrictions
51
AS/400
AS/400
This section contains information about important aspects of the AS/400
operating system.
Naming Conventions
Use the following format to specify an AS/400 file:
libraryname/filename(membername)
Description
libraryname
filename
The name of the file you wish to access. Periods are allowed
within the file name.
membername
Additional Features
XQUE is a Unicenter CA-XCOM Data Transport feature that allows the
unattended transfer of reports from output queues to other Unicenter CA-XCOM
Data Transport nodes.
XQUE can select specific classes of reports (based on the user, job name, form,
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 IBMs HCF
facility, or between multiple AS/400s connected within a pass-through
environment.
52
User Guide
AS/400
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. IBMs 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.
53
z/OS
z/OS
This section contains information about important aspects of the z/OS operating
system.
Naming Conventions
Use the following format to name a z/OS file (data set):
[level1.level2.level3...level7].level8[(membername)]
Description
level
Required.
A file name can consist of multiple levels separated by a period.
Each level has the following characteristics:
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.
54
User Guide
z/OS
Examples
The following are examples of valid z/OS data set names:
SYS1.VTAMLST
C54684.UTILITY.CNTL(JOBCARD)
PROD.PAYROLL.SEPT90.TIMECARD.DATA
TESTDATA
A.$DDD.LOAD
DCB Information
z/OS characteristics must be pre-defined when creating a new file. Collectively,
the following characteristics are known as Data Control Block (DCB) parameters:
Blocksize
Record format
Volume
Unit
For more information regarding any of these fields, see the IBM JCL reference
manual.
55
Novell NetWare
Additional Features
You should be aware of the following additional features of Unicenter
CA-XCOM Data Transport for z/OS:
Novell NetWare
This section contains information about important aspects of the Novell Netware
operating system.
Naming Conventions
Use the following format to name a Netware file:
Note: Unicenter CA-XCOM Data Transport for LAN Workstation accesses files
from any Novell file server in a NetWare network.
[server\]volume:directory\subdirectory\...\filename
56
User Guide
OpenVMS
Unicenter CA-XCOM Data Transport limits the length of this field as indicated
below. The actual name on the destination system may be longer.
Type of transfer
Specify
Up to 21 characters.
Up to 16 characters.
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.
57
OpenVMS
Description
device
directory
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
The following restrictions apply to Unicenter CA-XCOM Data Transport for
OpenVMS Alpha and Unicenter CA-XCOM Data Transport for OpenVMS VAX:
58
User Guide
OpenVMS
59
OS/2
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:
510
User Guide
OS/2
Part
Description
directory name
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
The following restrictions apply to CA-XCOM for OS/2:
APPC limitationsDue to the vast number of vendor APPCs and link types
supported by Unicenter CA-XCOM Data Transport, consult the APPC
vendors manual for restrictions on the services provided by that vendor.
These restrictions may impact such features as z/OS TYPE=EXECUTE
transfers, environments that you can or cannot send to, etc.
511
Stratus
Stratus
This section contains information about important aspects of the Stratus
operating system.
Naming Conventions
Use the following format to name Stratus files:
#top_directory>group_directory>home_directory>filename.suffix
Description
top_directory
group_directory
home_directory
filename
Required.
The name of the Stratus file.
Range: 1 to 32 characters.
suffix
512
User Guide
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
module
.pm
payroll.pm, application.pm
Stratus
Part
Description
command
macro
.cm
start_up.cm,
compile_and_bind.cm
back up
.backup
payroll.c.backup
FixedThis 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.
Additional Features
The following are additional features of Unicenter CA-XCOM Data Transport for
Stratus of which you should be aware:
Restrictions
The following restrictions apply to Unicenter CA-XCOM Data Transport for
Stratus:
513
Tandem
Tandem
This section contains information about important aspects of the Tandem
operating system.
Naming Conventions
Use the following format to name a Tandem file:
\<system>.<volume>.<subvolume>.<filename>
Description
system
volume
subvolume
filename
Example
The following example uses a volume of $CLX12, a subvolume of SCI, and a file
name of FILE1:
$CLX12.SCI.FILE1
514
User Guide
Tandem
Edit files
Structured filesUnicenter CA-XCOM Data Transport supports entrysequenced and relative structured files:
EDIT
UNSTRUCTURED
515
UNIX/Linux
ENTRY_SEQ
RELATIVE
Relative
FB
Entry Sequence
VB
Edit
Unstructured
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 the following format to name a UNIX or Linux file:
/directory/subdirectory/.../filename
Use up to 256 characters for the entire path of the file; there are no restrictions on
size for the individual parts of the path.
516
User Guide
VM
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
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.
For minidisk specifications:
CP OWNER is taken from the volume field, if present. Otherwise, the userid
field is used.
CP address is taken from the unit specification. The default is 191.
Note: You may have two files with the same file name and file type, but they
cannot reside on the same minidisk.
517
VM
DCB Information
CMS file characteristics must be predetermined when creating a new file. You
must specify the following parameters:
Restriction
The following table lists the maximum logical record lengths for different file
types:
518
User Guide
File type
Disk file
32767 bytes
80 bytes
133 bytes
VSE
VSE
This section contains information about important aspects of the VCE operating
system.
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)...
catalog-id
Optional.
The name of the user catalog that owns the VSAM data set as
defined using IDCAMS by including the following line in the JCL:
DEFINE USERCATALOG (NAME (catalog-id)...
Leave this field blank if the data set is owned by the master
catalog.
519
VSE
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.
unit
location
size
520
User Guide
VSE
Part
Description
override
2.
3.
521
VSE
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 IBMs OPEN routine or to your tape manager as
you have entered it.
522
User Guide
VSE
Part
Description
unit
override
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.
523
VSE
Restrictions
The following restrictions apply to Unicenter CA-XCOM Data Transport for
VSE:
524
User Guide
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]
Description
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
525
Part
Description
filename
Required.
The name of the data file.
Range: 1 to 8 characters (characters past position eight generate
an error).
ext
Restrictions
The following restriction applies to Unicenter CA-XCOM Data Transport for
Windows:
APPC restrictionsDue to the vast number of vendor APPCs and link types
supported by Unicenter CA-XCOM Data Transport, consult the APPC
vendors manual for restrictions on the services provided by that vendor.
These restrictions may impact such features as z/OS TYPE=EXECUTE
transfers and environments to which you can send.
526
User Guide
Naming Conventions
Unicenter CA-XCOM Data Transport for Windows NT supports the standard
Windows NT file names and the Universal Naming Convention (UNC). The file
naming conventions for Windows NT are similar to those for Windows, with
some significant differences, some of which are outlined below.
Use the following format to name files when using standard Windows 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
527
The following table describes the parts of Windows NT file names and UNC file
names:
Part
Description
directory name
filename
ext
server name
share name
528
User Guide
Additional Features
Additional features include the following:
File Systems
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.
Security
Employing some security All users employ the same user ID.
Set XCOM_USERID and XCOM_PASSWORD= to a valid NT user ID and
password that has local logon authority in the xcom.glb file on the NT side.
On the z/OS side, send a transfer with parameter USERID=' ' (blank between
two single quotes). This will use the user ID and password from the
xcom.glb file.
529
Unicenter CA-XCOM Data Transport limits the length of this field as indicated
below. The actual name on the destination system may be longer.
530
User Guide
Type of transfer
Specify
Up to 21 characters.
Up to 16 characters.
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.
Access to all files on a Windows NT system can be controlled by the permissions
set on a directory or file. The access rights of the user ID on the remote system
determine the actions permitted for the transfer. Users cannot use a directory or
file unless they have been granted the appropriate permissions.
531
Chapter
2.
3.
4.
5.
6.
61
Setting Expiration
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.
Use the following procedure to change the default expiration:
1.
Add days nnn to the makeca script line. The following line is an example of
how the makeca script is shipped:
Openssl req x509 newkey rsa out ./certs/cassl.pem outform PEM
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
2.
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
62
User Guide
This shell script displays the CA certificate and the information stored in the
package.
Create a configuration file to use as input to the openssl utility. A sample file,
serverssl.conf, was installed in the ssl subdirectory. Edit the
[req_distinguished_name] section, changing the values to your
specifications.
2.
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.
Create a configuration file to use as input to the openssl utility. A sample file,
clientssl.conf, was installed in the ssl subdirectory. Edit the
[req_distinguished_name] section, changing the values to meet your system
requirements.
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.
63
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.
2.
3.
4.
64
User Guide
For z/OS, specify the TCP/IP port that will accept SSL connection
requests using the SSLPORT default options table parameter. In
addition, the default options table parameter, SSL, must also be set to
one of the following values:
For UNIX, during installation, manually add the txpis service and the
TCP/IP port that will accept SSL connection requests to the inetd
configuration files.
For Windows, specify the TCP/IP port that that will accept SSL
connection requests using the SSL Port Number on the TCP/IP tab in the
Global Parameters GUI.
Verify that the port that receives incoming SSL connections is a unique port
that is not in use by any other application. The port used for incoming
TCP/IP connections cannot also be used for incoming SSL connections. If
Unicenter CA-XCOM Data Transport will be receiving both incoming
TCP/IP connections and incoming SSL connections, then two ports are
required.
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.
Review and modify the settings of the Unicenter CA-XCOM Data Transport
SSL configuration file, configssl.cnf, as appropriate for your system. Client
connections use the INITIATE_SIDE values.
2.
3.
5.
4.
Specify the port through which the remote Unicenter CA-XCOM Data
Transport partner accepts SSL connections. Use one of the following
parameters:
65
Appendix
Parameters
Use parameter values to control the variables that govern the behavior of
Unicenter CA-XCOM Data Transport.
Command line
xcom.cnf or
filename.cnf
xcom.glb
Program defaults
Parameters
A1
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:
Syntax
The syntax for assignment statements is as follows:
PARAMETER_NAME=value
Example
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:
A2
User Guide
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.
List of Parameters
Examples
In the following examples, the spacespacespace represents trailing spaces.
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 programs 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
A3
List of Parameters
ALLOCATION_TYPE
Indicates the unit of storage allocation for a dataset created on an IBM
mainframe.
Range: The range of values is listed in the following table:
Value
Description
CYL
Cylinders
TRK
Tracks
BLK
Blocks
Default: CYL
Note: Version 2 parameter.
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:
BLKSIZE
Specifies the block size of a dataset created on an IBM mainframe.
Note: Used when FILE_OPTION=CREATE.
Range: 0 to 32767
If the record format is
Variable
Undefined
Default: 800
A4
User Guide
List of Parameters
CARRIAGE_CONTROL_CHARACTERS
Indicates the type of printer carriage-control codes, if any, that are included in
the report file.
Note: For report transfers only.
Range: The range of values is listed in the following table:
Value
Description
ASA
IBM
BYPASSASA
OTHER
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
NO
MPACK
VLR
VLR2
XPACK
Indicates a text file with record packing. Uses 31K pack buffer.
Parameters
A5
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
Note: Version 2 parameter.
CLASS
The print class assigned to a report transferred to a remote system.
If the remote system is an IBM mainframe, this field designates the JES SYSOUT
class.
Note: For report transfers only.
Example
CODE_FLAG
Used to identify the type of data being transferred.
Range: The range of values is listed in the following table:
A6
User Guide
Value
Description
ASCII
BINARY
List of Parameters
Value
Description
EBCDIC
Default: ASCII
CODETABL
Specifies the prefix to the file names, atoe.tab and etoa.tab, that contain the
external ASCII-to-EBCDIC and EBCDIC-to-ASCII custom character conversion
tables. These custom character conversion tables determine which external
translation tables will be used by the transfer.
This parameter is valid only if INTERNAL_CONVERSION_TABLES=NO.
Range: 0 to 3 alphanumeric characters
Default: None
COMPRESS
Indicates the compression type. When communicating with an IBM mainframe,
if the data file contains any empty lines, COMPRESS can only be set to YES,
LZSMALL, LZMEDIUM or LZLARGE.
Note: All 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
LCOMPACT
LZLARGE
LZMEDIUM
LZRW3
Parameters
A7
List of Parameters
Value
Description
LZSMALL
NO
Indicates no compression.
RLE
YES
ZLIBn
CONTROL
For multiple transfers. Use the syntax for performing a single transfer and then
separate parameters for different transfers in the same configuration file by using
this parameter.
Range: NEWXFER or NONE
Default: NEWXFER
CONVERT_CLASSES
A character string containing print classes for which EBCDIC-to-ASCII
conversions will be performed. For incoming report transfers only.
Range: 1 to 64 characters
Default: None
COPIES
The number of copies that are to be sent. If this parameter is not specified, the
remote system queues one copy of the report to the systems default printer. For
report transfers only.
Range: 1 to 999
Default: 1
A8
User Guide
List of Parameters
CREATE_DIR
Indicates whether to create the specified directory if it does not exist.
Range: The range of values is listed in the following table:
Value
Description
YES
NO
Default: YES
DATACLAS
Specifies the name of the data class to use when allocating a new SMS-managed
data set.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
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.
Note: The <tid> variable refers to the 6-digit transfer ID number.
Range: The range of values is listed in the following table:
Value
Description
YES
NO
Default: NO
Parameters
A9
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
0 to 21 characters
Default: None
DESTINATION_TYPE
The type of target system.
Range: HOST, MIDRANGE, or OTHER
Default: OTHER
DISPLAY_PASSWORD_IN_TRACE
Determines if Unicenter CA-XCOM Data Transport displays password
information in the trace files.
Range: The range of values is listed in the following table:
A10
User Guide
Value
Description
YES
ENCRYPT
List of Parameters
Value
Description
NO
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:
If the value is
DELETE
Deleted
KEEP
Kept
HOLD
Held
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
Specifies the data set definition.
Note: This parameter applies only to mainframe SMS data sets.
Value
Description
LIBRARY
Defines a PDSE
PDS
Parameters
A11
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:
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.
A12
User Guide
List of Parameters
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.
Note: If EXPIRATION_TIME is set to no value in xcom.glb, the program default
of 6000 is used.
Range: 0 to 32767
Default: 6000
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
APPEND
REPLACE
Parameters
A13
List of Parameters
Description
CREATE
APPEND
REPLACE
Default: CREATE
FILE_OPTION_RF
Indicates how the transferred data is to be processed by the receiving system
(that is, the local system). Used when the transfer type is Retrieve File. If a value
is not specified, then the value of FILE_OPTION is used. If no default is specified
in FILE_OPTION or FILE_OPTION_RF, then the value defaults to CREATE.
Range: The range of values is listed in the following table:
Value
Description
CREATE
APPEND
REPLACE
A14
User Guide
Value
Description
CREATE
APPEND
List of Parameters
Value
Description
REPLACE
Default: CREATE
FORM
The type of form that should be used to print the report. Since Unicenter
CA-XCOM Data Transport places the print job in the remote system's print
queue, the print control functions depend on the remote system. The user must
verify beforehand that the requested form is available at the remote site. For
report transfers only.
Note: When sending a report to a VAX computer, leave this parameter blank
unless you are certain that this is a valid form type. VMS interprets this to mean
that no special form is being requested.
Range: 0 to 10 characters
Default: None
HOLDFLAG
Indicates whether a transferred report file is to be placed on HOLD on the
remote system or is to be printed immediately. For report transfers only.
Range: YES or NO
Default: NO
INTERNAL_CONVERSION_TABLES
Indicates whether internal or external conversion tables should be used for
ASCII-to-EBCDIC conversion and EBCDIC-to-ASCII conversion. The external
conversion files may be customized to meet your needs. For the appropriate
directory and file name, see ATOE_FILENAME and ETOA_FILENAME.
Range: The range of values is listed in the following table:
Value
Description
YES
Parameters
A15
List of Parameters
Value
Description
NO
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:
AL, AUL, BLP, LTM,
NL, NSL, SL, SUL
Note: Unicenter CA-XCOM Data Transport for z/OS supports only standard
label tapes.
Example: LABEL=BLP
The type of processing to be applied to this data set is BLP.
Default: 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
(0001 to 9999)
Example: LABELNUM=2
This specification refers to the second data set on the tape.
Default: 0001
A16
User Guide
List of Parameters
LCLNTFYL
Specifies the local user notification level.
Range: The range of values is listed in the following table:
Value
Description
A or ALL
W or WARN
E or 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.
When a prefix is followed by an asterisk (*), all members beginning with a
specific prefix are to be transferred. For example, LOCAL_FILE=/NAMES/AL*
requests that files AL, ALEX, and ALICE are all to be transferred. The same rules
apply if an asterisk is followed by a suffix.
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.
Note: If QUEUE=YES, user must specify full path name.
Range: 0 to 256 characters
Default: None
Parameters
A17
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.
Note: If QUEUE=YES, user must specify full path name.
Range: 0 to 256 characters
Default: None
LOCAL_FILE_SJ
Indicates the name of the file on the local system to be sent as a job. 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.
Note: If QUEUE=YES, user must specify full path name.
Range: 0 to 256 characters
Default: None
LOCAL_FILE_SR
Local file name to be sent as a report to the remote system. If this value is null or
unset, then Unicenter CA-XCOM Data Transport reads the standard input file.
For report transfers only.
Note: If QUEUE=YES, user must specify full path name.
Range: 0 to 256 characters
Default: None
A18
User Guide
List of 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
LRECL
Specifies the actual or maximum length, in bytes, of a logical record.
Corresponds to the JCL LRECL subparameter.
Range: 0 to 32767
If the format is
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
A19
List of Parameters
MAX_REMOTE_TCP
The maximum number of simultaneous remote TCP/IP transfers accepted by
Unicenter CA-XCOM Data Transport. Transfers received after this limit has been
reached are rejected.
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
A20
User Guide
List of Parameters
MGMTCLAS
Specifies the name of the management class to use when allocating a new
SMS-managed data set.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
NOTIFY_NAME
The user on the remote system who is to be notified when Unicenter CA-XCOM
Data Transport completes a transfer.
Note: If the remote system is an IBM mainframe, Unicenter CA-XCOM Data
Transport uses the value of NOTIFYR to determine the type of notification to
deliver.
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
ALL
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
A21
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
TSO
WTO
CICS
LU
ROSCOE
ALL
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
Specifies which terminals to write to if NOTIFYL=WRITE. If NOTIFY_TERM is
not set, all users specified in LOCAL_NOTIFY are be notified at the first terminal
where they are logged in, as found in the system table.
Range: 0 to 256 characters
Default: None
NUMBER_OF_RETRIES
Maximum number of retries before a transfer is logged as failed and taken out of
the transfer queue. If the value is 0, no retries are attempted.
Range: 0 to 255
Default: 1
Note: Version 2 parameter.
A22
User Guide
List of Parameters
NUM_OF_DIR_BLOCKS
Specifies the number of directory blocks to allocate for a data set created on an
IBM mainframe.
Range: 0 to 32767
Default: 0
Note: Version 2 parameter
PASSWORD
The password associated with the user ID on a remote system.
Range: 0 to 31 characters
Default: None
PORT
The number of the TCP/IP port on the remote Unicenter CA-XCOM Data
Transport server. Used for TCP/IP transfers only.
Range: 1 to 65535
Default: 8044
PRIMARY_ALLOC
Identifies primary storage allocation for a dataset created on an IBM mainframe.
Range: 0 to 99999
Default: 1
Note: Version 2 parameter
Parameters
A23
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
NORMAL
LOW
Default: NORMAL
PROTOCOL
The type of communication protocols to use.
Range: The range of values is listed in the following table:
Value
Description
SNA
TCPIP
Default: SNA
QUEUE
Indicates whether to execute the transmission request immediately or to allow
the request to be queued. If the user does not specify a .cnf file, and has not
changed a .cnf file, the default value is YES.
Note: If NO is specified and the remote system is unavailable, the request aborts.
If YES is specified, START_TIME and START_DATE are read.
A24
User Guide
List of Parameters
Description
YES
NO
Default: YES
QUEUE_PATH
Directory containing the transfer queue data files.
Range: 0 to 256 characters
Default: /usr/spool/xcom/Q, except for the following:
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
W or WARN
E or ERROR
Default: ALL
Parameters
A25
List of Parameters
RECORD_FORMAT
Specifies the record format of a dataset created on an IBM mainframe. This
corresponds to the JCL RECFM subparameter.
Range: The range of values is listed in the following table:
A26
User Guide
Value
Description
Record Length
Comment
Fixed unblocked
FA
Fixed unblocked
ANSI
FB
Fixed blocked
Fixed
FBA
Fixed blocked
ANSI
Fixed
FBS
Fixed blocked
spanned
Fixed
FM
Fixed unblocked
machine
FS
Fixed unblocked
spanned
Undefined
Undefined
Variable
unblocked
Variable
VA
Variable
unblocked ANSI
Variable
Contains
ISO/ANSI/FIPS control
characters.
VB
Variable blocked
Variable
List of Parameters
Value
Description
Record Length
Comment
VBA
Variable blocked
ANSI
Variable
VBM
Variable blocked
machine
Variable
VBS
Variable blocked
spanned
Variable
VM
Variable
unblocked
machine
Variable
VS
Variable
unblocked
spanned
Variable
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
A27
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.
When a prefix is followed by an asterisk, all members beginning with a specific
prefix are transferred. For example, REMOTE_FILE_RF=/NAMES/AL* requests
that files AL, ALEX, and ALICE should be transferred. The same rules apply if
an asterisk is followed by a suffix.
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.
Note: For retrieve file transfers only
Range: 1 to 256 characters
Default: None
REMOTE_SYSTEM
The name of the remote system that receives a file, job or report.
For SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems IP address, host
name, or domain name.
Range: 1 to 256 characters
Default: None
A28
User Guide
List of Parameters
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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems 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 SNA/APPC protocols, the name is as specified in the SNA/APPC
configuration of the local system. For RS/6000, this is the LU6.2 Side Information
record.
For TCP/IP protocols, the value can be the remote systems IP address, host
name, or domain name.
Range: 1 to 256 characters
Default: None
Parameters
A29
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:
8 characters
2 characters
8 characters
Job Name
Blanks
Job Number
The Job ID is optional and can be skipped. The Job Name can also be skipped,
but if you skip the Job name and want to use the job number, you must pad the
number with 10 blanks.
Note: For report transfers only
Examples
REPORT_TITLE=Salary94
REPORT_TITLE=
Non-example
REPORT_TITLE=
Job12345
Job23456
Job34567
This is not a valid REPORT_TITLE because the Job Number spans both sub
fields.
This parameter is used by Unicenter CA-XCOM Data Transport on remote
systems in the following ways:
A30
User Guide
System
MVS
VAX/VMS
UNIX/Linux
Other systems
List of Parameters
RESTART_SUPPORTED
Specifies whether automatic restart is to be supported on a transfer.
Range: YES or NO
Default: YES
Note: Version 2 parameter.
RETPD
Specifies the number of days (1 to 9999) that the tape data set being created is to
be retained.
Range: 1 to 9999
Default: None
Note: RETPD and EXPDT are mutually exclusive; specify one or the other.
RETRY_TIME
The number of seconds between retries of unsuccessful transfers.
Range: 0 to 99999
Default: 1
Note: Version 2 parameter.
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
NO
The xcomtool GUI does not save the password in the .CNF
file and blanks the password field out after each operation.
Parameters
A31
List of Parameters
Default: NO
SECONDARY_ALLOC
Identifies secondary storage allocation for a dataset created on an IBM
mainframe.
Range: 0 to 99999
Default: 0
Note: Version 2 parameter.
SECURE_SOCKET
Specifies whether to use an OpenSSL socket or non-OpenSSL socket for transfers.
Range: The range of values is listed in the following table:
Value
Description
YES
NO
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:
A32
User Guide
List of Parameters
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
NO
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
A33
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
Indicates whether the report is to be spooled to disk or printed immediately. For
report transfers only.
Note: If the remote system is an IBM mainframe, this parameter has no effect on
the transfer.
Range: YES or NO
Default: YES
START_DATE
Indicates the date on which the transfer becomes eligible for execution. The
format is mm/dd/yy. If this field is blank, the current date is used.
Example
A value of 02/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
A34
User Guide
List of Parameters
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.
Note: This parameter applies only to mainframe SMS data sets.
Range: 1 to 8 characters
Default: None
SYSTEM_USER_DATA
A user-defined text data field that can be used by an application as a customized
system identifier. When specified in the configuration file of a locally initiated
transfer, this identifying information is sent to the remote system and can be
used to identify the system to certain applications. When received, the
identifying information is displayed in the xcomqm detail display if the -D
option is used, and is labeled System user data.
Range: 0 to 10 characters
Default: None
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
A35
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:
TEMPDIR
Indicates the directory in which temporary files for jobs and reports can be
created.
Range: 1 to 256 characters
Default: /tmp
TP_CMD
Command to start a transaction program using SNA protocols.
Range: 0 to 256 characters
Default:
TRACE_PATH
The directory containing the trace data files.
Range: 0 to 256 characters
Default: /usr/spool/xcom/trace, except for the following:
A36
User Guide
List of Parameters
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
Generated by the graphical user interface to specify the type of transfer to
initiate.
Can also be used in a configuration file that has multiple transfers in it, to specify
a different transfer type from the default value.
Range: 1 to 4
Value
Description
Send job
Send report
Send file
Receive file
Default: 3
Parameters
A37
List of Parameters
TRANSFER_USER_DATA
A user-defined text data field that can be used by an application as a customized
transfer identifier. When specified in the configuration file of a locally initiated
transfer, this identifying information is sent to the remote system and can be
used to identify the transfer to certain applications. When received, the
identifying information is displayed in the xcomqm detail display if the -D
option is used, and is labeled Transfer user data.
Range: 0 to 10 characters
Default: None
TRUNCATION
Indicates whether Unicenter CA-XCOM Data Transport truncates excess
characters in the source file if the record exceeds the maximum record length as
indicated by the MAXRECLEN parameter. If NO is selected, and the maximum
record length is exceeded, Unicenter CA-XCOM Data Transport aborts the
transfer. This parameter is ignored if CARRIAGE_FLAG=NO.
Note: Truncation is not valid for BINARY data 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 partners Unicenter
CA-XCOM Data Transport TRUSTED database to be searched to verify the users
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.
Note: TRUSTED=YES cannot be specified with indirect transfers, because this is
not supported.
Range: YES, NO, Y, N
Default: NO
TRUSTED_PATH
The directory containing the trusted files.
Default: /user/spool/xcom/trusted
A38
User Guide
List of Parameters
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
Maximum wait time, in seconds, for partner to terminate TCP/IP
communications. If a transfer terminates normally, both sides of the conversation
coordinate the termination, and there should be no need to wait. This timeout
will occur only during an error in the termination of the connection. Used for
TCP/IP transfers only.
Range: 0 to 999 seconds
Default: 20 seconds
Parameters
A39
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
Specifies the unit on which a dataset is to be created on an IBM mainframe.
Note: Used when FILE_OPTION=CREATE.
Range: 0 to 6 characters
Default: None
UNITCT
Specifies the number of units to be allocated on the remote system. 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.
Note: This parameter applies to outgoing security only.
Range: YES or NO
Default: NO
A40
User Guide
List of Parameters
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
Indicates the version of the Unicenter CA-XCOM Data Transport protocol to be
used for this transfer. For using TCP/IP, only a value of 2 is valid.
Range: 1 or 2
Default: 2
Note: Version 2 parameter.
VOLCT
Specifies the maximum number of volumes to be used in processing a
multi-volume output tape data set on the remote system.
Range: 1 to 255
Default: None
VOLUME
Specifies the volume on which a dataset is to be created on an IBM mainframe.
Range: 0 to 6 characters
Default: None
VOLUME_RF
Specifies the volume from which a dataset is to be retrieved from an IBM
mainframe.
Range: 0 to 6 characters
Default: None
Parameters
A41
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
Specifies the configssl.cnf file path and file name.
Range: 1 to 256 characters
Default:
XCOM_PASSWORD
Specifies the default password for remotely initiated transfers.
Range: 0 to 31 characters
Default: None
XCOM_SHOW_CIPHER
Specifies whether to display encryption algorithms in the Unicenter CA-XCOM
Data Transport queue detailed information, which is used for transfers.
Range: The range of values is listed in the following table:
Value
Description
NO
YES
Default: NO
A42
User Guide
List of Parameters
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
The default user ID for remotely initiated transfers.
Range: 0 to 12 characters
Default: xcom
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:
Parameters
A43
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.
Note: For store-and-forward transfers only.
Range: 0 to 14 characters
Default: None
XLOGFILE
The name of the file where Unicenter CA-XCOM Data Transport logs activity. If
you do not specify this parameter, the systemwide log
file/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: If QUEUE=YES, specify the full path name.
Range: 0 to 256 characters
Default:
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:
A44
User Guide
List of Parameters
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
XLUNAMERemote 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:
Parameters
A45
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:
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:
XTRACE
Indicates the level of desired execution tracing.
Range: The range of values is listed in the following table:
Value
Description
No tracing
1 to 8
10
Default: 0
A46
User Guide
Appendix
Messages
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 users 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
Position
Explanation
1-4
The first through fourth characters are always the string XCOM.
IBM VSE
Messages
B1
Error Messages
Character
Position
Explanation
K
IBM CICS
IBM z/OS
Windows NT
Netware
IBM AS/400
Tandem
UNIX/Linux
IBM VM
Windows
The sixth through ninth characters are used for the message
number, for example: 0001
10
B2
User Guide
Indicates
List of Messages
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.
0007I
0008I
0010I
Messages
B3
List of Messages
0011I
0016E
0017I
0022I
B4
User Guide
List of Messages
0023I
0024I
0025I
0026I
Messages
B5
List of Messages
0027I
0028I
0288E
0029I
B6
User Guide
List of Messages
0030E
0031E
0046I
CONFIRMED_CHECKPOINT
Reason:
Unicenter CA-XCOM Data Transport is confirming a checkpoint.
Action:
None provided.
0047I
Messages
B7
List of Messages
0052I
Transfer held.
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.
0053I
Transfer released.
Reason:
The transfer was released to start at the time for which it was scheduled.
Action:
None required.
0075P
0077I
B8
User Guide
List of Messages
0078P
0079I
0080I
0081I
Messages
B9
List of Messages
0082I
0085P
0086P
B10
User Guide
List of Messages
0087P
0088I
xcomd started.
Reason:
The Unicenter CA-XCOM Data Transport scheduler has started.
Action:
None required.
0089I
xcomd ended.
Reason:
The Unicenter CA-XCOM Data Transport scheduler has ended.
Action:
None required.
0090I
Messages
B11
List of Messages
0092I
xwait started.
Reason:
The Unicenter CA-XCOM Data Transport wait process has started.
Action:
None required.
0100I
XEXIT
Reason:
The Unicenter CA-XCOM Data Transport transaction program is about to exit.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0102I
CLEANUP
Reason:
The state machine is about to enter CLEANUP state. In this state, the LU 6.2
conversation is deallocated.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
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.
B12
User Guide
List of Messages
0105I
ALLOCATE_CONVERSATION
Reason:
The state machine is about to enter ALLOCATE_CONVERSATION state. It is
about to issue the allocate verb for the remote transaction program.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0106I
GET_ALLOCATE
Reason:
The state machine is about to enter GET_ALLOCATE state. In this state,
incoming allocates are sought by the local transaction program.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0107I
DEALLOCATE_CONVERSATION
Reason:
The state machine is about to enter DEALLOCATE_CONVERSATION state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages
B13
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:
The state machine is about to enter REQUEST_HEADER_CONFIRMATION state
where the incoming header is confirmed, and, if necessary, the connection is
turned around.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
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.
B14
User Guide
List of Messages
0112I
SENDING_DATA
Reason:
The state machine is about to enter SENDING_DATA state. Unicenter
CA-XCOM Data Transport sends one data record each time it enters this state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0113I
DATA_CONFIRM
Reason:
The state machine is about to enter DATA_CONFIRM state. In this state, the
transaction program issues the confirm that is sent at the end of a data file.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
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
B15
List of Messages
0115I
TRAILER_CONFIRM
Reason:
The state machine is about to enter TRAILER_CONFIRM state. The Unicenter
CA-XCOM Data Transport transaction program is about to issue a deallocate
confirm verb for the conversation.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0116I
RECEIVE_HEADER
Reason:
The state machine is about to enter RECEIVE_HEADER state. In this state,
Unicenter CA-XCOM Data Transport receives the incoming header.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0117I
CONFIRM_HEADER
Reason:
The state machine is about to enter CONFIRM_HEADER state. The Unicenter
CA-XCOM Data Transport transaction program is about to issue the confirmed
LU 6.2 verb.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
B16
User Guide
List of Messages
0118I
RECEIVE_MAXLRECL
Reason:
The state machine is about to enter RECEIVE_MAXLRECL state. The transaction
program receives the maximum record length record and uses it to initialize
system parameters.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0119I
RECEIVE_DATA
Reason:
The state machine is about to enter RECEIVE_DATA state. In 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:
The state machine is about to enter DATA_CONFIRMED state. It issues the
confirmed verb and closes the received file in preparation for receiving the trailer
record.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages
B17
List of Messages
0121I
RECEIVE_TRAILER
Reason:
The state machine is about to enter RECEIVE_TRAILER state. A
receive_and_wait verb is issued for the incoming Unicenter CA-XCOM Data
Transport trailer record.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0122I
TRAILER_CONFIRMED
Reason:
The state machine is about to enter TRAILER_CONFIRMED state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
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 dont 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.
B18
User Guide
List of Messages
0125I
TERMINATE_INITIATE_CHECK
Reason:
The state machine is about to enter TERMINATE_INITIATE_CHECK state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0127I
TP_DONE
Reason:
The state machine is about to enter TP_DONE state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0128I
RECEIVE_FEATURE_RECORD
Reason:
The state machine is about to enter RECEIVE_FEATURE_RECORD state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0129I
SEND_FILE_DESCRIPTOR
Reason:
The state machine is about to enter SEND_FILE_DESCRIPTOR state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages
B19
List of Messages
0130I
REQUEST_FEATURE_RECORD_CONFIRM
Reason:
The state machine is about to enter REQUEST_FEATURE_RECORD_CONFIRM
state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0131I
CONFIRMED_FEATURE_RECORD
Reason:
The state machine is about to enter CONFIRMED_FEATURE_RECORD state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0152I
LOCAL_SEND
Reason:
The state machine is about to enter LOCAL_SEND state. In this state, the
transaction program initializes several internal variables, logs the startup
message, and sets the userid for this transfer.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
B20
User Guide
List of Messages
0153I
LOCAL_RECEIVE
Reason:
The state machine is about to enter LOCAL_RECEIVE state. In this state, the
transaction program initializes several internal variables, logs the startup
message, and sets the userid for this transfer.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0154I
REMOTE_SEND
Reason:
The state machine is about to enter REMOTE_SEND state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0155I
REMOTE_RECEIVE
Reason:
The state machine is about to enter REMOTE_RECEIVE state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0156I
OPEN_REMOTE_INPUT_FILE
Reason:
The state machine is about to enter OPEN_REMOTE_INPUT_FILE state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages
B21
List of Messages
0157I
OPEN_LOCAL_INPUT_FILE
Reason:
The state machine is about to enter OPEN_LOCAL_INPUT_FILE state. The local
input file is about to be opened.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0158I
OPEN_OUTPUT_FILE
Reason:
The state machine is about to enter OPEN_OUTPUT_FILE state. The output file
is about to be opened.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0159I
LOCAL_ATTACH
Reason:
The state machine is about to enter LOCAL_ATTACH state. In this state, the
transaction program tries to establish a connection to the local LU 6.2 SNA
server.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
B22
User Guide
List of Messages
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
B23
List of Messages
0164I
RECEIVE_OVERLAY
Reason:
The state machine is about to enter RECEIVE_OVERLAY state. An indirect
transfer has been requested by the remote side and the overlay record is about to
be received.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0165I
DO_SYSTEM
Reason:
The state machine is about to enter DO_SYSTEM state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0167I
SET_REMOTE_USER_ID
Reason:
The state machine is about to enter SET_REMOTE_USER_ID state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0168I
DO_COMMAND
Reason:
The state machine is about to enter DO_COMMAND state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
B24
User Guide
List of Messages
0169I
SEND_FEATURE_RECORD
Reason:
The state machine is about to enter SEND_FEATURE_RECORD state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0170I
RECEIVE_FILE_DESCRIPTOR
Reason:
The state machine is about to enter RECEIVE_FILE_DESCRIPTOR state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0171I
RESTART_TRANSFER
Reason:
The state machine is about to enter RESTART_TRANSFER state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0172I
CHECKPOINT_CONFIRM_REQUEST
Reason:
The state machine is about to enter CHECKPOINT_CONFIRM_REQUEST state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages
B25
List of Messages
SENDING_ERROR
Reason:
The state machine is about to enter SENDING_ERROR state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0182I
RECEIVE_ERROR
Reason:
An error message is being received from the remote partner. The Unicenter
CA-XCOM Data Transport transaction program issues a receive and wait verb to
retrieve the text.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
B26
User Guide
List of Messages
0185I
SEND_ERROR_MESSAGE
Reason:
The state machine is about to enter SEND_ERROR_MESSAGE state. A send error
verb has been issued and the text of the error encountered is sent.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0186I
WAIT_FOR_REMOTE_DEALLOCATE
Reason:
The state machine is about to enter WAIT_FOR_REMOTE_DEALLOCATE state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0187I
TRANSFER_FAILED
Reason:
The Unicenter CA-XCOM Data Transport transfer has failed.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0188I
CHECK_RETURN_CODES
Reason:
Unicenter CA-XCOM Data Transport is checking return codes at the end of a
transfer.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
Messages
B27
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:
The state machine is about to enter REMOTE_NOTE state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0202I
LOCAL_NOTE_ATTACH
Reason:
The state machine is about to enter LOCAL_NOTE_ATTACH state. In this state,
the transaction program tries to establish a connection to the local LU 6.2 SNA
server.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
B28
User Guide
List of Messages
0203I
ALLOCATE_NOTE_CONVERSATION
Reason:
The state machine is about to enter ALLOCATE_NOTE_CONVERSATION state.
It is about to issue the allocate verb for the remote transaction program.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0204I
SENDING_NOTE_DATA
Reason:
The state machine is about to enter SENDING_NOTE_DATA state. Unicenter
CA-XCOM Data Transport sends one sdsnote when it enters this state.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0205I
DATA_NOTE_CONFIRM
Reason:
The state machine is about to enter DATA_NOTE_CONFIRM state. In this state,
the transaction program issues the confirm that is sent at the end of a sdsnote.
Action:
None. This message is used to report the state of the Unicenter CA-XCOM Data
Transport transaction program.
0211I
Messages
B29
List of Messages
0212I
0213I
0214I
0215I
B30
User Guide
List of Messages
0216I
0283E
0284E
0285E
Messages
B31
List of Messages
0286E
0287E
0288E
B32
User Guide
List of Messages
0289E
Messages
B33
List of Messages
0291E
0292E
0296E
0297E
B34
User Guide
List of Messages
0298E
0299E
0300E
Messages
B35
List of Messages
0303E
0304E
B36
User Guide
List of Messages
0305E
0309E
0310I
Messages
B37
List of Messages
0311E
0312E
0313E
0314E
B38
User Guide
List of Messages
0315E
0320E
Messages
B39
List of Messages
0321E
0322E
0403E
0404E
B40
User Guide
List of Messages
0405E
0406E
0407E
0408E
Messages
B41
List of Messages
0409E
0410E
0411E
0412E
B42
User Guide
List of Messages
0413E
Trailer invalid
Reason:
The count in the received trailer record did not match the actual number of
records received.
Action:
Make sure your version of Unicenter CA-XCOM Data Transport is up to date.
Retry the transfer. If the problem persists, take a Unicenter CA-XCOM Data
Transport trace and contact Computer Associates Customer Support.
0415E
0416E
Messages
B43
List of Messages
0418E
0422E
Login incorrect.
Reason:
User ID and/or password do not match security database.
Action:
Provide correct user ID and/or password.
0423I
0424E
B44
User Guide
List of Messages
0425E
0426E
0427E
0435I
Messages
B45
List of Messages
0436E
TP ended abnormally.
Reason:
The Unicenter CA-XCOM Data Transport daemon has detected a transaction
program failure. Or, possible security problems.
Action:
Retry the transfer. If the problem persists, contact Computer Associates
Customer Support.
0437E
0438E
0439E
B46
User Guide
List of Messages
0440E
0441I
0442I
Messages
B47
List of Messages
0443I
0448E
0450E
B48
User Guide
List of Messages
0451E
0454E
0455E
0456E
Messages
B49
List of Messages
0457E
0458E
0459E
B50
User Guide
List of Messages
0460E
0461E
0463E
Messages
B51
List of Messages
0464E
0465E
0466E
0467E
B52
User Guide
List of Messages
0468E
0469E
0470E
Messages
B53
List of Messages
0471E
0472E
0473E
0474E
B54
User Guide
List of Messages
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:
Increase the MAX_QUEUE_ENTRIES parameter in xcom.glb and restart xcomd.
If the error persists remove all files in the Q directory and restart xcomd.
0476E
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:
Remove all files in the Q directory and restart xcomd.
Messages
B55
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:
Remove all files in the Q directory and restart xcomd.
0483E
0486E
0488E
B56
User Guide
List of Messages
0489E
0491E
0492E
Messages
B57
List of Messages
0493E
0494E
0495E
0497E
B58
User Guide
List of Messages
0500E
0501E
Messages
B59
List of Messages
0505E
0506E
0507E
0508E
B60
User Guide
List of Messages
0509E
0510E
0511E
rc=xxx sense=yyyy
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:
The transfer is retried automatically for queued transfers, depending on your
configuration. If the problem persists, it may be an RS/6000 SNA configuration
problem involving hardware or software.
Messages
B61
List of Messages
0512E
0514E
0515E
0600E
B62
User Guide
List of Messages
0601E
Permission denied
Reason:
You do not have security rights necessary to perform the operation which caused
this message.
Action:
None
0602E
0603E
Messages
B63
List of Messages
0604E
0605E
0606E
0609E
B64
User Guide
List of Messages
0611E
0612E
0613E
0785I
Messages
B65
List of Messages
0786I
0793I
0805I
0811I
B66
User Guide
List of Messages
0812I
0813I
0814I
0818I
Messages
B67
Appendix
C1
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.
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
C2
User Guide
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.
The protocol for 3270 video display stations. It defines the data
streams used by dumb terminals to communicate with the host.
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.
6.1
Developed during the late 1970s, this was SNAs 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
This protocol specifies the data stream of the 5250 video display
stations commonly used with the IBM mid-range computers.
C3
It utilizes LU 6.2.
z/OS
VM (all versions)
AS/400
IBM PC
OS/2 EE
C4
User Guide
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.
C5
Appendix
Using xcomtool
xcomtool is the MOTIF-based Graphical User Interface (GUI) that allows you to
do the following:
Initiate transfers
This appendix contains information about using xcomtool and procedures for
performing transfers.
Using xcomtool
D1
Starting xcomtool
Starting xcomtool
xcomtool is started from the shell prompt. All operations performed from the
command line interface can be performed with xcomtool.
Note: xcomd must be up and running to start xcomtool.
To start xcomtool, enter the following at the shell prompt:
xcomtool [-d display] &
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:
D2
User Guide
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.
Using xcomtool
D3
From the xcomtool Main window, click the Window pull-down menu.
D4
User Guide
Options
Window
Quit
Option
Function
CA-XCOM Control
CA-XCOM Status
SNA Status
About Xcomtool
Closes xcomtool.
Using xcomtool
D5
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.
D6
User Guide
Option
Directory List
File List
To perform this
action
Explanation
Edit
Submit
Using xcomtool
D7
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.
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.
D8
User Guide
2.
3.
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.
Local file
Remote file
Target system
Using xcomtool
D9
2.
Click Open, highlight the configuration file you want to edit, and press OK.
The following window displays:
3.
4.
Click Directories to select a directory from the pull-down list to filter from.
The directory is highlighted and displayed in both Filter and Selection.
5.
6.
D10
User Guide
Local file
Remote file
Target system
Send a file
Send a report
Send a job
Receive a file
Using xcomtool
D11
Options
File
Request
Options
D12
User Guide
Selection
Function
Default
Open
Save
Save As
Close Window
Function
Send File
Send Job
Send Report
Receive File
Function
Directories/
Commands
Notify User
User Code
Conversion
Miscellaneous
Secure Socket
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
Destination
System
Definition
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
Target System
UNIT
(system specific)
VOLUME
(system specific)
RECFM
(system specific)
DATACLAS
DSNTYPE
MGMTCLAS
STORCLAS
Specifies the name of the storage class for a new SMSmanaged data set.
LCLNTFYL
RMTNTFYL
Using xcomtool
D13
Field
Definition
LRECL
(system specific)
BLKSZE
(system specific)
Specifies the block size for the remote file. If the format is
Fixed or Fixed Block Record then the block size must be a
multiple of the record length. If the format is Variable Record
then the block size must be 4 bytes larger than the record
length. If the format is undefined then the block size must be
larger than the largest record length.
SPACE
(system specific)
CYL = Cylinders
TRK = Tracks
BLK = Blocks
Specify by:
D14
User Guide
COPIES
FCB
(system specific)
CLASS
(system specific)
FORM
(system specific)
Specifies to the remote user the type of form that this report
is to be printed on. When sending to a VAX computer, leave
this field blank.
DISPOSITION
Field
Definition
CONTROL
SPOOL
HOLD
Using xcomtool
D15
RECORD_FORMAT
This parameter specifies the record format of a dataset created on an IBM
mainframe. This corresponds to the JCL RECFM subparameter. This field is
unique to the Control Window-Send File.
D16
User Guide
Option
Definition
Record Length
Comment
Fixed unblocked
FA
Fixed unblocked
ANSI
FB
Fixed blocked
Fixed
FBA
Fixed blocked
ANSI
Fixed
FBS
Fixed blocked
spanned
Fixed
FM
Fixed unblocked
machine
FS
Fixed unblocked
spanned
Undefined
Undefined
Variable
unblocked
Variable
VA
Variable
unblocked ANSI
Variable
Contains
ISO/ANSI/FIPS control
characters.
VB
Variable blocked
Variable
Option
Definition
Record Length
Comment
VBA
Variable blocked
ANSI
Variable
VBM
Variable blocked
machine
Variable
VBS
Variable blocked
spanned
Variable
VM
Variable
unblocked
machine
Variable
VS
Variable
unblocked
spanned
Variable
Description
Protocol
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
Method
Code_Flag
Carriage_Flag
ASCII
ASCII
No
ASCII
(text)
ASCII
Yes
Using xcomtool
D17
Option
Description
ASCII
(pack)
ASCII
XPACK
Binary
Binary
No
Binary
(VLR)
Binary
VLR
EBCDIC
EBCDIC
No
EBCDIC
(text)
EBCDIC
Yes
EBCDIC
(pack)
EBCDIC
XPACK
Truncate
Records
Indirect
Transfer
Security
Schedule
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.
D18
User Guide
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.
Before completing this window, you must know the following:
Destination system
Local file
Remote file
File action
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
Using xcomtool
D19
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.
Obtain this information before completing the following procedure.
Procedure
To complete this window, follow these steps:
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.
4.
5.
6.
7.
8.
After all entries are complete, click the Send File pushbutton.
The request to send a file transfer is processed.
D20
User Guide
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.
Before completing this window, you must know the following:
Destination system
Local file
Destination printer
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.
Obtain this information before completing the following procedure.
Using xcomtool
D21
Procedure
To complete this window, follow these steps:
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.
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.
D22
User Guide
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.
Before completing this window, you must know the following:
Destination system
Local 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.
Obtain this information before completing the following procedure.
Using xcomtool
D23
Procedure
To complete this window, follow these steps:
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.
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.
D24
User Guide
Destination system
Local file
Remote file
File action
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.
Obtain this information before completing the following procedure.
Procedure
To complete this window, follow these steps:
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.
3.
4.
5.
Using xcomtool
D25
6.
7.
8.
9.
After all entries are complete, click the Receive File pushbutton.
The parameters to receive a file are specified.
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:
D26
User Guide
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.
To complete this window, follow these steps:
1.
2.
Accept the default by pressing Enter or type the name of the log file and click
Local Notify Command.
The Local Notify Command field is highlighted.
3.
Accept the default by pressing Enter or type the name of the local notify
command and click Postproc. Directory.
The Postproc. Directory field is highlighted.
4.
Accept the default by pressing Enter or type the name of the directory to be
used for post processing and click Local Print Command.
The Local Print Command field is highlighted.
5.
Accept the default by pressing Enter or type the name of the print command
to be used on the local system and click Queue Directory.
The Queue Directory field is highlighted.
6.
Accept the default by pressing Enter or type the name of the queue directory
and click Trace Directory.
The Trace Directory field is highlighted.
7.
Accept the default by pressing Enter or type the name of the trace directory
and click Local TP Command.
The Local TP Command field is highlighted.
8.
Using xcomtool
D27
Fields
The following fields are associated with the Directories/Commands window:
Field
Definition
Postproc. Directory
Queue Directory
Trace Directory
Local TP Command
Pushbuttons
The following pushbuttons are located at the bottom of this window:
D28
User Guide
Button
Function
OK
Cancel
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
To complete the Notify User dialog, follow these steps:
Note: Pull-down menu, field, and pushbutton explanations are described after
this procedure.
1.
2.
3.
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.
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.
Using xcomtool
D29
7.
8.
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:
Remote
Notify
Option
Function
ALL
WARN
ERROR
The remote user notification flag. Options from this menu are:
Option
Function
ALL
WARN
ERROR
Fields
The following fields are associated with the Notify User window:
D30
User Guide
Field
Definition
Local User
Remote User
Pushbuttons
The following pushbuttons are located at the bottom of this window:
Button
Function
OK
Cancel
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.
Using xcomtool
D31
2.
Fields
The following fields are associated with the Conversion dialog:
Field
Definition
CODETABL
Pushbuttons
The following pushbuttons are located at the bottom of the Conversion dialog:
D32
User Guide
Button
Function
OK
Cancel
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
Using xcomtool
D33
Procedure
Before completing this window, check with your system administrator to
determine the settings for each parameter.
To complete this window, follow these steps:
Note: Pull-down menu, field, and pushbutton explanations are described after
this procedure.
1.
2.
If you are not using Brixton or SunLink APPCs, skip this step.
If you are using Brixton or SunLink APPCs, click in Gateways Hostname
and type in the appropriate name. (See the Fields list that follows.)
3.
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.
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.
8.
9.
D34
User Guide
Pull-down Menu
The following options are available on the pull-down menu associated with the
Miscellaneous window:
Option
Function
Trace Level
Fields
The following fields are associated with the Miscellaneous window:
Field
Definition
Gateways Hostname
Checkpoint Interval
Retry Interval
Number of Retries
Using xcomtool
D35
Pushbuttons
The following pushbuttons are located at the bottom of this window:
Button
Function
OK
Cancel
D36
User Guide
Procedure
Use the following procedure to complete the Secure Socket window:
1.
2.
Type the full path and file name of the Unicenter CA-XCOM Data Transport
secure socket configuration file (configssl.cnf).
The Secure Socket File path and name is specified.
3.
Click OK.
The options are specified and the Edit Transfer window displays.
Pushbuttons
The following pushbuttons are available in the Secure Socket window:
Button
Function
OK
Cancel
Using xcomtool
D37
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.
The appropriate window for the selected option is displayed.
Fields
The following fields are associated with the Status window:
D38
User Guide
Field
Definition
TID
Transfer ID.
Condition
Initiate
Status
Message
Pushbuttons
The following pushbuttons are located on the right side of this window:
Button
Function
Suspend
Resume
Hold/Release
Terminate
Remove Entry
TP Info
Log/Trace
Close Window
Using xcomtool
D39
Procedure
To view the Xcomtp Status window, select a transfer on the Unicenter CAXCOM Data Transport Status window and click the TP Info pushbutton.
The Xcomtp window displays the progress of the selected transfer.
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
Remote LU
Request
File
Name of file.
Start Time
State
TP PID
Owner UID
User ID.
Records
Bytes
Pushbutton
The following pushbutton is located at the bottom of this window:
D40
User Guide
Button
Function
Close
Procedure
To view the Xcomlog window, select a transfer on the Unicenter CA-XCOM Data
Transport Status window and click the TP Info pushbutton.
The Xcomtp window displays the progress of the selected transfer.
Pushbuttons
The following pushbuttons are located at the top of this window:
Button
Function
More
Save Trace
Using xcomtool
D41
Button
Function
Close
VI
Note: If the vi screen does not come up, you will have to
add the path to xterm in the PATH environment variable.
D42
User Guide
Appendix
Problem Determination
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:
HP-UX: /var/spool/xcom/xcom.log
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.
Problem Determination
E1
General Procedures
General Procedures
This section contains a general test procedure to use for documenting problems.
Most problems encountered by users are the result of the following:
Improper configuration
A faulty environment
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.
Follow these steps:
1.
Document the precise actions that were performed immediately prior to the
appearance of the problem.
Note: The description of the actions performed should be detailed enough to
allow for you to recreate the problem at some future time if necessary.
2.
Error messages
Unexpected events
Wherever possible, record any error messages that appear on the screen.
E2
User Guide
3.
If a data file has been corrupted, save the data file in a safe place for later
analysis by Unicenter CA-XCOM Data Transport Customer Support. Any
information that appears even remotely relevant may prove vital in
achieving a quick resolution to the problem.
4.
General Procedures
5.
6.
No
Yes
Action
Yes
No
7.
Problem Determination
E3
General Information
Use the following table to provide general customer information.
Information
Date of Incident
Incident Number
(to be supplied by Unicenter
CA-XCOM Data Transport
Customer Support)
Customer Name
Site ID
Customer Address
Customer Telephone Number
Customer email Address
Unicenter CA-XCOM Data
Transport Platform, Version,
Release, and Maintenance
Customer Support Contact
(to be supplied by Unicenter
CA-XCOM Data Transport
Customer Support)
E4
User Guide
Your Response
Environment Information
Use the following table to inventory information about your environment. Use
additional sheets as necessary.
Information Type
Initiating
System
Receiving
System
(Receiving
System)
Intermediary
System
Platform
Operating System
Communications
Subsystem
Security Subsystem
For SNA/APPC
(Version/
Release/
Maintenance)
Have there been any
hardware or
software changes
(for example,
hardware upgrades,
operating system,
Unicenter
CA-XCOM Data
Transport or
communications
type changes)
Transfer Type
Please Check the box that applies to the file transfer:
Send File
Send Job
Send Report
Retrieve File
Problem Determination
E5
Problem Description
What is the customer attempting to perform or accomplish?
E6
User Guide
YES
NO
Problem History
Use the following section to provide a description of the problem history.
Yes
No
Error Messages
Please provide a list of error messages include the message ID and all of the text.
Problem Determination
E7
z/OS
VM
VSE
AS/400
VAX
Stratus
Tandem
HP/9000
Linux
RS/6000
Sun Solaris
OS/2
E8
User Guide
Operating
System
Communications
Subsystem
Security
Subsystem
APPC Version/
Release/
Maintenance
DOS
Windows
Windows NT, 2000, and XP
NetWare
Other
Initiating Platform
____________________________
Send Job
Send Report
Receive File
This is a
Documentation
The following is a starting point for various error conditions on various
platforms. More documentation may be required to resolve the error condition:
Conditions
Platforms
Abend
z/OS
Documentation
Full Dump
VM
GCS Dump
Default File
VSE
Problem Determination
E9
Conditions
Platforms
Tandem
Documentation
Error in Transfer
z/OS
VM
VSE
AS/400
OS/2
VPROC of XCOM62
POWER Log
Sense codes
Job logs
User Guide
Tptrace
E10
DOS
Abend message
Conditions
Platforms
Tandem
Documentation
VAX
SNA Trace
Unicenter CA-XCOM Data Transport
Config
Syserr_log messages
NetWare
Stratus
SNA Trace
Monitor_SDLC log
Syserr_log messages
Monitor_SDLC log
Other
Problem Determination
E11
1-800-645-3042
International
(1) 631-342-4683
E12
User Guide
Index
#!ENCRYPT, 3-54
BLKSIZE, A-4
mainframe file creation parameter, 3-26
blksize, API, 4-7
A
AGE_TIME, 2-7, A-3
ALLOCATION_TYPE, A-4
mainframe file creation parameter, 3-25
API
accessing the queue, 2-20
xcomqm, 2-20
options, 2-20
syntax, 2-20
API example, 4-40
API return values, 4-3
apitest.c file, API, 4-40
APPC
Brixton, 3-18, A-45
SunLink, 3-18, A-45
AS/400, 5-2
ASCII/EBCDIC conversion, 3-44
ATOE_FILENAME, 2-7, A-4
Index1
checkpoint parameters
CHECKPOINT_COUNT, 3-63
NUMBER_OF_RETRIES, 3-63
CHECKPOINT_COUNT, A-6
checkpoint/restart parameter, 3-63
checkpoint_count, API, 4-9
CLASS, A-6
send report parameter, 3-36
class, API, 4-9
CLEANLOG, 2-21
example, 2-22
syntax, 2-22
client certificate for SSL, 6-3
CODE_FLAG, A-6
file type conversion parameter, 3-46
code_flag, API, 4-9
CODETABL, 3-12, A-7
codetabl, API, 4-10
command line interface, Retrieve File command, 3-21
communications parameters
DESTINATION_TYPE, 3-14
REMOTE_SYSTEM, 3-15
REMOTE_SYSTEM_RF, 3-15
REMOTE_SYSTEM_SJ, 3-16
REMOTE_SYSTEM_SR, 3-16
setting, 3-12
XLUNAME, 3-17
XMODE, 3-17
XNODESPEC, 3-18
COMPRESS, 3-13, A-7
compress, API, 4-10
configuration files, 3-1
creating, 3-2
opening and editing in xcomtool, D-9
xcom.cnf, 3-12
xcom.glb, 2-7
xcom.ses, 2-18
CONTROL, A-8
control block structure, API, 4-3
Control Windows
Receive File, D-24
Send File, D-19
Send Job, D-23
Send Report, D-21
xcomtool, D-9, D-11
drag and drop procedure, D-8
conventions in this guide, 1-21
conversion dialog, D-31
using xcomtool, D-31
CONVERT_CLASSES, 2-7, A-8
convert_classes, API, 4-11
COPIES, 2-31, A-8
Send Report parameter, 3-36
copies, API, 4-11
CREATE_DIR, 3-19, A-9
creating configuration files, 3-2
custom character sets, stored, 3-47
Customer Support, E-12
customizing notification, 2-32
D
daemon, 3-1
process, 2-5
data transfer parameters
CODETABL, 3-12
COMPRESS, 3-13
MAXRECLEN, 3-14
TRUNCATION, 3-17
DATACLAS, A-9
mainframe file creation parameter, 3-26
dataclas, API, 4-11
connection_profile, 2-19
transfers using SNA, 2-19
transfers using TCP/IP, 2-19
DEC, 5-7
Index2
User Guide
DEN, A-10
den, API, 4-12
DESTINATION, A-10
Send Report parameter, 3-36
EXPIRATION_TIME, A-13
global parameter, 2-9
E
EBCDIC conversion, 3-44
using xcom62 command, 3-45
using xcomtcp command, 3-45
Edit button, xcomtool, D-7
Edit Transfer Window
common options, D-11
common uses, D-11
edit xcomtool Main Window, D-11
encrypted parameter values, 3-55
EOL_CLASSES, 2-8, A-12
eol_classes, API, 4-14
error messages, system identifier, B-1
ETOA_FILENAME, 2-8, A-12
EXPDT, A-12
expdt, API, 4-14
F
fcb, API, 4-14
FCB, Send Report parameter, 3-37, A-13
file conversion
custom character sets, 3-47, 3-50
default character sets, 3-49
file conversion parameters
CARRIAGE_FLAG, 3-46
CODE_FLAG, 3-46
file type conversion, 3-44
FILE_OPTION, 3-19, 3-25, A-13
file_option, API, 4-14
FILE_OPTION_RF, 3-22, A-14
FORM, A-15
Send Report parameter, 3-37
form, API, 4-15
fully qualified domain name, 3-9
G
global parameters, 2-6
AGE_TIME, 2-7, A-3
ATOE_FILENAME, 2-7
CONVERT_CLASSES, 2-7
DISPLAY_PASSWORD_IN_TRACE, 2-8, A-10
EOL_CLASSES, 2-8
ETOA_FILENAME, 2-8
EXPIRATION_TIME, 2-9
INTERNAL_CONVERSION_TABLES, 2-9
MAX_QUEUE_ENTRIES, 2-9
MAX_REMOTE_TCP, 2-10, 3-15, A-20
MAX_SESSIONS_ENTRIES, 2-10
METACODE_CLASSES, 2-10
PROTOCOL, 2-10
QUEUE_PATH, 2-11
SAVE_PASSWORD_IN_CNF, 2-11, A-31
SESSIONS_FILE, 2-11
SHELL_CMD, 2-12
SOCK_DELAY, 2-12
SOCK_RCV_BUF_SIZE, 2-12
SOCK_SEND_BUF_SIZE, 2-13
Index3
STAT_FREQUENCY, 2-13
TCP_CMD, 2-13
TEMPDIR, 2-13
TP_CMD, 2-14
TRACE_PATH, 2-14
TRUSTED_PATH, 2-14
TXPI_BUF_SIZE, 2-14
TXPI_SEND_CHECK_FREQ, 2-15
TXPI_TERM_TIMEOUT, 2-15
UMASK, 2-15
using, 2-6
XCOM_PASSWORD, 2-15
XCOM_USERID, 2-16
XCOMPRE_LOCAL, 2-16
XENDCMD, 2-16
XLPCMD, 2-17
XNOTIFYCMD, 2-17
XPPCMD, 2-17
XPRECMD, 2-18
XTRACE, 2-18
graphical user interface, D-1
L
LABEL, A-16
label, API, 4-16
LABELNUM, A-16
labelnum, API, 4-16
lclntfy, API, 4-16
LCLNTFYL, A-17
notification parameter, 3-59
link libraries, API
SNA, 4-2
TCP/IP, 4-2
Linux, 5-16
HOLDFLAG, A-15
Send Report parameter, 3-37
LOCAL_FILE, A-17
send file parameter, 3-20
local_file, API, 4-17
LOCAL_FILE_RF, A-18
Retrieve File parameter, 3-22, 4-17
Index4
User Guide
LOCAL_FILE_SJ, A-18
Send Job parameter, 3-41
local_file_sj, API, 4-18
LOCAL_FILE_SR, A-18
Send Report parameter, 3-38
local_file_sr, API, 4-18
LOCAL_NOTIFY, A-19
notification parameter, 3-59
LOCAL_RECEIVE, 4-3
LOCAL_SEND, 4-3
locally initiated transfers, 3-56
localnotify, API, 4-18
MAX_QUEUE_ENTRIES, A-19
global parameter, 2-9
MAX_REMOTE_TCP, A-20
global parameter, 2-10, 3-15
MAX_SESSIONS_ENTRIES, 2-18, A-20
global parameter, 2-10
MAXRECLEN, A-20
configuration parameter, 3-14
maxreclen, API, 4-19
member names, API, 4-6
METACODE_CLASSES, 2-10, A-20
metacode_classes, API, 4-19
MGMTCLAS, A-21
mainframe file creation parameter, 3-27
mgmtclas, API, 4-20
Miscellaneous window, xcomtool, D-33
modifying post processing parameters, xcompp, 2-26
modifying post transfer script, xcomend, 2-28
MOTIF, D-1
LU 6.2
benefits, improved throughput, 1-15
independent implementations, C-5
M
machine code characters, reports, 2-36
mailx, 2-32
Main window menu
xcomtool, D-3
directories, D-7
drag and drop, D-6
editing toggle buttons, D-7
file lists, D-7
menu bar, D-5
submitting toggle buttons, D-7
mainframe file creation, 3-25
managing queue, 2-20
MVS, 5-4
N
network levels
diagram, 1-14
end user level, 1-12
general explanation, 1-12
logical level, 1-13
physical level, 1-13
send file flowchart, 1-20
successful send file transfer over SNA network,
1-19
network term definitions
logical and physical components, C-1, C-2
LU, C-1
procedure correlation identifier (PCID), C-2
session, C-2
NEWXFER, A-8
Index5
notification parameters
LCLNTFYL, 3-59
LOCAL_NOTIFY, 3-59
NOTIFY_NAME, 3-60
NOTIFY_TERM, 3-60
NOTIFYL, 3-60
NOTIFYR, 3-61
RMLNTFYL, 3-61
using, 3-58
xcom62 command, 3-58
xcomtcp command, 3-59
NOTIFY_NAME, A-21
notification parameter, 3-60
NOTIFY_TERM, A-22
notification parameter, 3-60
port
in xcomtool, D-17
remote system, in xcomtool, D-17
PORT, A-23
and xcomtcp, 3-10
port, API, 4-22
NOTIFYR, A-22
notification parameter, 3-61
prerequisites, 1-1
NUMBER_OF_RETRIES, A-22
checkpoint/restart parameter, 3-63
number_of_retries, API, 4-21
O
OpenSSL, 1-4
OpenVMS, 5-7
OpenVMS Alpha, 5-7
OpenVMS VAX, 5-7
OS/2, 5-10
Index6
User Guide
REMOTE_FILE, A-27
send file parameter, 4-26
Send File parameter, 3-20
remote_file, API, 4-26
REMOTE_FILE_RF, A-28
retrieve file parameter, 3-23, 4-26
REMOTE_SYSTEM, A-28
configuration parameter, 3-15
QUEUE_PATH, A-25
global parameter, 2-11
REPORT_TITLE, A-30
Send Report parameter, 3-38
Index7
RETRY_TIME, A-31
checkpoint/restart parameter, 3-64
return codes, system restrictions, 3-42
return values, 4-3
RMLNTFYL, A-25
notification parameter, 3-61
rmtmtful, API, 4-24
S
sample API program, 4-40
SAVE_PASSWORD_IN_CNF
global parameter, 2-11, A-31
script changes and shell, 2-25
scripts, 2-26
post processing, 2-25
SECONDARY_ALLOC, 3-29, A-32
secondary_alloc, API, 4-29
Secure Socket Layer (SSL), 1-4
Secure Socket transfers, performing, D-36
Secure Socket window, D-36
SECURE_SOCKET
global parameter, A-32
mainframe file creation parameter, 3-30
secure_socket, API, 4-29
security parameters
PASSWORD, 3-53
TRUSTED, 3-53
USERID, 3-53
using, 3-52
xcom62 command, 3-52
xcomtcp command, 3-52
Send File command, 3-18
parameters, 3-19
xcom62, 3-18
xcomtcp, 3-18
Send File parameters
FILE_OPTION, 3-19
LOCAL_FILE, 3-20
REMOTE_FILE, 3-20, 4-26
Index8
User Guide
STORCLAS, A-35
mainframe file creation parameter, 3-30
SSL
standard features
choice of interfaces, 1-6
initiation by either computer (any-to-any), 1-6
low maintenance, 1-6
T
Tandem, 5-14
TAPE, A-35
tape, API, 4-30
standard functions
ASCII/EBCDIC translation, 1-6
checkpoint/restart, 1-7
compression, 1-6
remote spooling, 1-7
store-and-forward, 1-7
starting
xcomd, 2-6
xcomtool, D-2
TRACE_PATH, A-36
global parameter, 2-14
tracing, 3-41
return codes, 3-42
Index9
features, 1-1
data link types, 1-6
high capacity and performance, 1-7
management, 1-8
modular support of most systems, 1-5
security, 1-8
standard, 1-6
standard functions, 1-6
file transfer types, 1-2
invoking, 1-10
menu interface, 1-10
programming interface, 1-10
standard features
simple installation, 1-6
unified solution, 1-2
user interfaces, 1-2
uses, 1-2
transfer types
answering remote requests
files, 1-9
jobs, 1-9
reports, 1-9
retrieving files, 1-9
sending batch jobs for execution, 1-9
sending files, 1-9
sending reports, 1-9
TRANSFER_NAME, A-37
TRANSFER_TYPE, A-37
TRANSFER_USER_DATA, A-38
transferring files, 3-3
transfers, performing in xcomtool, D-11
troubleshooting, general procedures
purpose of procedures, E-2
test procedure, E-2
UNITCT, A-40
TRUSTED, A-38
security parameter, 3-53
USE_TP_SECURITY, A-40
TRUSTED_PATH, A-38
global parameter, 2-14
USERID, A-41
security parameter, 3-53
TXPI_RECEIVE_TIMEOUT, A-39
UNIX/Linux, 5-16
V
VAX, 5-7
Index10
User Guide
xcom62, 3-3
SNA/APPC protocol example, 3-7
syntax, 3-5
W
wildcard characters, 3-4
xcom62 syntax, 3-5
xcomtcp syntax, 3-5
wildcard transfers
FILE_OPTION, 3-19, 3-22, A-14
LOCAL_FILE, 3-20, 4-17, A-17
LOCAL_FILE_RF, 3-22, 4-17, A-18
REMOTE_FILE, 3-21, 4-26, A-27
REMOTE_FILE_RF, 3-23, 4-26, A-28
Windows, 5-25
Windows NT, 5-27
X
xbuffsize, API, 4-33
xcom.cnf, 3-1, 3-12
xcom.glb, 3-1
xcom.ses, 2-18
example, 2-19
xcom.trusted
file entries, 2-34
sample file, 2-36
trusted transfers, 2-34
xcom.trusted.all, 2-35
xcom_config_ssl, 4-33
XCOM_CONFIG_SSL, 3-31
global parameter, A-42
XCOMSEND, 2-31
xcom_show_cipher, 4-33
xcomtcp, 3-3
example, 3-11
performing transfers using, 3-8
port and protocol, 3-10
syntax, 3-5
XCOM_SHOW_CIPHER
global parameter, A-42
mainframe file creation parameter, 3-31
XCOM_TRUSTED_OVR, 2-35
global parameter, 2-16, A-43
Index11
XNODESPEC, A-45
configuration parameter, 3-18
XIDEST, A-44
store and forward parameter, 3-52
xidest, API, 4-34
XLOGFILE, A-44
logging parameter, 3-44
XLPCMD, A-44
global parameter, 2-17
Index12
User Guide