This edition applies to the 3.7 Version of IBM Sterling Connect:Direct for i5/OS and to all subsequent releases and modifications
until otherwise indicated in new editions.
Before using this information and the product it supports, read the information in Notices on page 159.
i5/OS Block Mode Transfer Examples ......................................................................... 151
i5/OS Run Task Example .............................................................................................. 152
i5/OS Send Example Using Send File Field Description ................. ............................. 152
6IBM Sterling Connect:Direct for i5/OS User’s Guide
i5/OS Send and Receive Examples Using Native File System...................................... 152
i5/OS Send and Receive Examples Using Integrated File System ................................ 153
i5/OS–z/OS Send and Receive Examples ..................................................................... 154
i5/OS–NT Send and Receive Examples......................................................................... 155
i5/OS–Microsoft Windows Run Job and Run Task Examples ..................................... 156
i5/OS–UNIX Send and Receive Examples ................................................................... 156
i5/OS–UNIX Run Task and Run Job Examples............................................................ 157
i5/OS–UTIL Test Examples........................................................................................... 157
Chapter 1
About Sterling Connect:Direct for i5/OS
IBM® Sterling Connect:Direct® for i5/OS® is an enterprise solution for secure, automated file delivery
between business applications. Its session management and extended recovery features help assure data
delivery in support of 24 hours a day, 7 days a week business operations. It links technologies, moves all types
of information, and manages high-performance transfers by providing easy-to-use automation,
checkpoint/restart, and error recovery. Sterling Connect:Direct offers choices in communication protocols,
hardware platforms, and operating systems. It provides the flexibility to move information from mainframes to
midrange systems to desktop and LAN-based workstations.
Interfacing with Sterling Connect:Direct for i5/OS
When you install Sterling Connect:Direct for i5/OS, you create Control Language (CL) commands that enable
you to use Sterling Connect:Direct. These CL commands enable you to send or receive data from other nodes
running Sterling Connect:Direct. You can also use the CL commands to ad minister Sterling Connect:Direct.
For example, you can use a CL command to display Sterling Connect:Direct message descriptions.
Issuing Sterling Connect:Direct CL Commands
Issue Sterling Connect:Direct CL commands interactively from the command line or use them in a CL
program. Results of CL commands that interact with a remote node are recorded in three places:
Sterling Connect:Direct log
User message queue of the local i5/OS node
Statistics facility of the local and remote Sterling Connect:Direct node
Chapter 2, Using Control Language, provides information about CL commands, CL programmi ng, and
Sterling Connect:Direct CL commands.
Understanding Sterling Connect:Direct for i5/OS Components
The Sterling Connect:Direct for i5/OS has several components that enhance its compatibility with other
Sterling Connect:Direct platforms and run under the Sterling Connect:Direct subsystem:
Process Manager (PMGR)
The PMGR initializes and manages the Sterling Connect:Direct environment. PMGR is always active
when Sterling Connect:Direct for i5/OS is active.
8IBM Sterling Connect:Direct for i5/OS User’s Guide
Queue Manager (QMGR)
The QMGR manages the Sterling Connect:Direct Process queue. The QMGR is always active when
Sterling Connect:Direct for i5/OS is active.
Timer (TIMER)
The TIMER component provides timer services to the session manager, the process queue manager, and
other Sterling Connect:Direct for i5/OS components. The TIMER runs as a separate i5/OS job, submitted
and controlled by the Process Manager component. The TIMER is always present when Sterling
Connect:Direct for i5/OS is active.
Statistics Manager (STATMGR)
Sterling Connect:Direct for i5/OS logs statistics information for all Processes. Each component of Sterling
Connect:Direct for i5/OS generates statistics data to the STATMGR job. The long-running STATMGR
job formats the statistics information and writes it to the statistics file. The Statistics Manager supports CL
commands that provide the ability to schedule the creation, archival, and deletion of statistics file
members. The STATMGR is always active when Sterling Connect:Direct for i5/OS is active.
Spool Monitor (SPLMON)
The Sterling Connect:Direct SPLMON is a variable component of Sterling Connect:Direct for i5/OS.
CDSPLMON uses Spool Monitor entries to associate output queues with destination Sterling
Connect:Direct nodes.
TCP Listener (TCPLIST)
The TCPLIST is a long-running job started and controlled by the Process Manager component.
CDTCPLIST processes incoming TCP/IP connection requests and requests session managers from the
PMGR.
Session Manager (SMGR)
The SMGR component executes the Sterling Connect:Direct Processes. The Process Manager starts all
session managers except for SMGRs started by the LU6.2 evoke function. Evoked SMGRs request
permission to run from the PMGR and continue processing.
Connecting Sterling Connect:Direct for i5/OS to Sterling
Connect:Direct/Plex
Sterling Connect:Direct for i5/OS can be connected to Sterling Connect:Direct/Plex, which is a Sterling
Connect:Direct
Connect:Direct/Servers in a TCP/IP environment. Once the connection between Sterling Connect:Direct for
i5/OS and Sterling Connect:Direct/Plex has been defined, each system can initiate sessions to the other. All
requests to initiate sessions to the Sterling Connect:Direct/Plex system go through the Sterling
Connect:Direct/Manager, which controls the traffic and determines which Sterling Connect:Direct/Server can
run a particular Process based on the PLEXCLASS of the Sterling Connect:Direct/Server and the Process
coming from the Sterling Connect:Direct for i5/OS system. One advantage of routing the Processes through the
Sterling Connect:Direct/Plex Manager is that you only have to define a single network map entry fo r the
Sterling Connect:Direct/Plex Manager rather than creating separate node entries for each Sterling
Connect:Direct/Plex Server.
The PLEXCLASS parameter represents a type of server in the Sterling Connect:Direct/Plex system. In the
example illustrated in the graphic, there is one Sterling Connect:Direct for i5/OS system connected to a
Sterling Connect:Direct/Plex system called CD.PROD1. CD.PROD1 consists of a Sterling
Connect:Direct/Manager and two Sterling Connect:Direct/Servers. Both Sterling Connect:Direct/Servers
support the CLASS1 PLEXCLASS but only Sterling Connect:Direct/Server 1 can process the TAPE
PLEXCLASS.
for z/OS system consisting of a Sterling Connect:Direct/Manager and one or more Sterling
About Sterling Connect:Direct for i5/OS 9
When the Sterling Connect:Direct/Manager receives a Process that requires PLEXCLASS=CLASS1 and
determines that both Sterling Connect:Direct/Servers support CLASS1, it routes the Process to the Sterling
Connect:Direct/Server with the lowest workload.
For more information on the PLEXCLASS parameter, see the CL command to execute in the IBM Sterling Connect:Direct for z/OS environment in the IBM Sterling Connect:Direct for i5/OS User’s Guide.
Remote node
Connect:Direct/Manager
Connect:Direct/Server 1
Connect:Direct OS/400
Remote node
PLEXCLASS(TAPE)
PLEXCLASS(CLASS1)
TCP/IP
Connect:Direct/Plex
CD.PROD1
PLEXCLASS(CLASS1)
Remote node
Connect:Direct/Server 2
Remote node
Remote node
Accessing Sterling Connect:Direct Through the Main Menu
Sterling Connect:Direct for i5/OS includes an i5/OS system-style menu that allows you to execute Sterling
Connect:Direct Command Language commands and related i5/OS CL commands from a menu. This menu
consists of two screens.
Issuing CL Commands Through the Main Menu
The first screen allows you to issue basic Sterling Connect:Direct commands. The second screen allows you to
issue administration Sterling Connect:Direct commands. Each screen contains a full-function i5/OS command
line and function key descriptions near the bottom of the screen.
To access the Main Menu:
1.Type STRCDMNU and press Enter. The Sterling Connect:Direct for i5/OS copyright screen is displayed.
10IBM Sterling Connect:Direct for i5/OS User’s Guide
2.Press Enter. The Sterling Connect:Direct Main Menu displays the Sterling Connect:Direct for i5/OS
functions that you can perform from this screen.
CMDCD Connect:Direct (tm)
System: FRAN
Select one of the following:
12IBM Sterling Connect:Direct for i5/OS User’s Guide
Chapter 2
Using Control Language
Sterling Connect:Direct for i5/OS uses Sterling Connect:Direct CL commands to perform Sterling
Connect:Direct functions.
Sterling Connect:Direct CL commands have the following general i5/OS CL command format:
Each command can have required and optional parameters and subparameters that provide additional
information needed to run the command.
Subparameters are always positional.
Each parameter provides a specific type of information or instruction.
Each command is followed by one or more keywords and parameter pairs in the following format:
COMMAND keyword(parameter) keyword(parameter) ...
The following example shows a sample Sterling Connect:Direct CL command:
The following table lists the Sterling Connect:Direct for i5/OS command names and their functions.
CommandFunction
†CDARCSTATMCompress and delete a statistics file member other than the active one.
CDCOMPCompress a file on the i5/OS node before sending it to a remote node.
†CDCRTSTATMCreate a new statistics file member and log statistics to that new member.
CDDECOMPDecompress files received from another node and archived on the i5/OS node as compressed files.
CDDEVACTGTurns VARY on and off on devices used by Sterling Connect:Direct.
CDDLTARCSTDeletes members from the archive statistics database file.
†CDDLTSTATMDelete a specified statistics file member other than the active one.
†
Administrative commands
‡Sterling Connect:Direct Secure Plus for i5/OS commands
14IBM Sterling Connect:Direct for i5/OS User’s Guide
CommandFunction
CDDSPSTATIDisplay information about where statistics are being logged.
CDRCVReceive data from a remote node.
CDRSTSTATMDecompress selected statistics file members to a user-designated file.
CDSELSTATSelect statistics records and retrieve information about the active statistics file.
CDRUNJOBSubmit a job in batch mode on a remote node.
CDRUNTASKExecute a Sterling Connect:Direct Run Task function on a remote node.
CDSNDSend data to a remote node.
CDSNDSPLSend a spooled file to a remote node.
CDSUBMITSubmit a Process to a remote node to initiate Sterling Connect:Direct work on the remote node.
CDSUBPROCSubmit Sterling Connect:Direct Processes to the process queue for asynchronous execution.
†CDVERDisplay the installed Sterling Connect:Direct version and Sterling Connect:Direct PTF level.
†CNVNTMPFConvert Sterling Connect:Direct network map file.
†CNVUSRFConvert Sterling Connect:Direct user file.
†CRTCDOBJCreate Sterling Connect:Direct objects.
†CRTCDXTTBLCreate and update the translation table.
DSPCDMSGDDisplay the text for the specified message ID.
†ENDCDEnd a Sterling Connect:Direct for i5/OS node and components.
HLDCDPROCIdentifies Processes to place in the Hold queue.
RLSCDPROCReleases identified Processes from the Hold queue.
STRCDTCPLStarts the Sterling Connect:Direct TCP listener.
UNINSTALLMUninstalls the latest Sterling Connect:Direct maintenance installation.
UPDATECD Installs Sterling Connect:Direct maintenance.
†WRKCDPARMView and change Sterling Connect:Direct initialization parameter values.
†‡SPADMINIBM Sterling Connect:Direct Secure Plus Administrative utility to provide security enhancements.
†STRCDStart Sterling Connect:Direct for i5/OS.
STRCDMNUStart Connect:Direct Menu.
†WRKCDNTMPSelect remote node records and display attributes. This screen provides the options of copy or
change to attributes of the remote node records.
WRKCDPROCMonitor and control active and queued Processes.
†WRKCDSTSView and control Sterling Connect:Direct job status.
†WRKCDUSRBrowse existing user records and invoke other user maintenance commands.
†WRKSPLMONEView, change, or delete destination configuration file entries of the Spool Support for Sterling
Connect:Direct for i5/OS.
†
Administrative commands
‡Sterling Connect:Direct Secure Plus for i5/OS commands
Using Control Language 15
Entering CL Commands
You can type CL commands on an i5/OS node using any of the following methods:
Embedding CL Commands
You can embed CL commands in an application (user-written CL program), which allows you to com bine
functions supplied by Sterling Connect:Direct for i5/OS with i5/OS CL commands within a user-written
application.
Entering CL Commands in Free Format
You can type CL commands in a free format, which allows you to type a command and its parameters as a
string of characters on a command line. This method is useful when typing familiar commands.
Command Prompting
Command prompting guides you through typing commands and parameters.
Note: Sterling Connect:Direct for i5/OS commands are case sensitive if the information sent to the remote
node is enclosed in single quotation marks.
Monitoring CL Program Messages
After issuing Sterling Connect:Direct for i5/OS commands such as, CDSND, CDRCV, CDRUNTASK, and
CDRUNJOB, use the MONMSG command to monitor the following categories of error messages using a CL
program:
16IBM Sterling Connect:Direct for i5/OS User’s Guide
&MSGID is the CDE* error message. The first 8 characters of the &MSGDATA are the application error
message that you can look up interactively with the following command:
DSPCDMSGD <msgid>
Note: The &MSGID and &MSGDATA variables must be defined in the CL program. Specify the &MSGID
character length as 7 characters and &MSGDATA as 8 characters to capture the error message.
Using CL Programming and Sterling Connect:Direct CL Commands
An i5/OS CL program includes Sterling Connect:Direct CL commands as source statements. You can
synchronize the processing of Sterling Connect:Direct operations by including Sterling Connect:Direct CL
commands in a CL program.
Note: If you are using the Source Edit Utility (SEU) to edit a CL program, the prompt facility can help you
type all CL commands, including Sterling Connect:Direct CL commands.
Sample CL Program
The following figure shows a sample CL program with multiple CL commands:
ERROR: SNDMSG MSG('The process erred') TOUSR(*SYSOPR)
END: ENDPGM
Using Control Language 17
Command Prompting for the Sterling Connect:Direct CL Commands
Sterling Connect:Direct CL commands follow the format of the native i5/OS CL commands, which provide an
extensive help facility describing their purpose, parameters, values, and any dependencies.
In addition, you can use the prompt/help feature to select and type commands and appropriate parameters.
Prompt/help is offered at the command level and at the parameter level. Both levels allow you to use F4 for
prompting and F1 for help. You can access screen level help by moving the cursor off an entry or field and
pressing F1.
Accessing Command Level Help
Complete the following steps to access the Help text:
1.For help with commands, type the command on the command line and press F1. Help text displays and
describes the function of the command with a description of each parameter and possible values.
2.After viewing help information, press F3 to exit the help function or F12 to cancel and return to the
command line.
Prompting for a Command
Complete the following steps to prompt for a command:
1.Type the command on the command line and press F4 to display an entry screen for the command. This
screen lists valid parameters and provides a brief description of each parameter.
2.Press F11 to display the keyword names.
3.Complete the command by filling in the parameter values on the screen.
4.After typing in all applicable parameters, press Enter to execute the command.
Accessing Parameter Level Help
Complete the following steps to access help with parameters:
1.Place the cursor by the parameter for which you want further description.
2.Press F1 to display a description of the parameter and valid values.
3.After viewing help information, press F3 to exit the help function or F12 to cancel and return to the
command line.
Using Parameter Level Prompt
Complete the following steps to prompt for a parameter:
1.Place the cursor by the parameter for which you want to prompt.
2.Press F4 for valid values for the parameter. At this screen, type in the appropriate value for the parameter.
3.Press Enter to set the parameter and return to the original screen. You can also press F3 or F12 to exit the
help function.
If a parameter is required to run the command successfully, the field is highlighted. Prompt does not provide
the default value. A greater than (>) symbol indicates that the parameter field contains a user-supplied value.
18IBM Sterling Connect:Direct for i5/OS User’s Guide
Sending a file on Sterling Connect:Direct for i5/OS requires the Sterling Connect:Direct Send (CDSND)
command. Understanding the Sterling Connect:Direct for i5/OS file systems, the CDSND command
parameters, block mode transfer, and the CDSND screens enables you to use this command more effectively.
Using the File Systems
Sterling Connect:Direct for i5/OS supports two types of file systems to perform file transfers: native fil e and
integrated file. The native file system and the integrated file system can both be used to send files to and
receive files from any supported file system.
Chapter 3
Sending a File
Native File System
The native file system used in previous releases of Sterling Connect:Direct for i5/OS remains functional. This
file system accepts the file name in the following formats:
library-name/file-name
specifies the library and file name to be copied.
library-name/file-name(member-name)
specifies the library, file, and member name of the member to be copied. You cannot use the
EXCLUDE and SELECT parameters if you specify a member name.
Note: *LIBL, *CURLIB and QTEMP are not valid library names for a Sterling Connect:Direct Process.
Integrated File System
As part of i5/OS, the integrated file system provides an integrated structure over data stored in the iSeries
system. This file system supports stream input/output and storage management like personal compu ters and
UNIX operating systems.
Integrated File System Types
The Sterling Connect:Direct for i5/OS integrated file system provides application and data compatibility with
other platforms. The integrated file system consists of five file system types:
/QLANSrv is a LAN server file system
/QDLS is a document library file system
20IBM Sterling Connect:Direct for i5/OS User’s Guide
/QSYS.LIB is the iSeries DB2 file system
/QOpenSys is a UNIX-style file system
All others are part of the root file system
Specifying a Path Name
The integrated file system recognizes the objects by the path specification. You must specify the fully qualified
path name to transfer a file. Sterling Connect:Direct for i5/OS identifies a path that starts with a slash (/) or a
backslash (\) as a request for the integrated file system.
The integrated file system does not support file field description. You cannot specify the SNDFFD(*YES)
under this file system. Similarly, you cannot specify SELECT or EXCLUDE with the integrated file system.
To use this system, specify the fully qualified path name in one of the following formats:
specifies the directory, folder, and file names to be copied using the integrated file system.
Directories like /QOpenSys and /root are case-sensitive. The /QSYS.LIB notation is case-sensitive only if you
enclose the name in single quotation marks.
Controlling the Character Set
You can control the coded character set ID used by the integrated file system. To specify a coded character set
ID other than the job-coded or the system-coded character set, set the SYSOPTS parameter called CCSID to
the character set you want to use, for example, CCSID(819).
If this parameter is not set, the system default for CCSID is used.
Using the CDSND Command
Use the CDSND command to send a file to a remote node. This command sends files to any file systems
supported by the i5/OS V3R1M0 or later. You can also specify a user-exit command (either EXITCMD or FAILCMD) to be executed after the completion of a copy process in either FROMSYSOP or TOSYSOP.
Using EXITCMD, you can specify a command to be executed only if the copy process is successful. You can
also specify a command to be executed only if the copy process is not successful by using the FAILCMD
command. The EXITCMD and FAILCMD commands must be executed on an i5/OS using Sterling
Connect:Direct version 3.3.00 and above. The FAILCMD and EXITCMD are executable iSeries commands as
well as Sterling Connect:Direct as long as the size of the command does not exceed 127 bytes.
CDSND Command Example
The command shown in the following figure is an example of the CDSND command.
Note: The CLASS parameter is not used for Sterling Connect:Direct for i5/OS.
Required Parameters
Unless otherwise noted, these required parameters apply to all remote node environments.
SNODE(remote-node-name)
specifies a 1–16 character alphanumeric name for the receiving node (remote node). The node name
must be defined in the network map.
Note: The name parameter is case sensitive.
Sending a File 23
SNODENVIRN(remote-environment-name)
specifies the 1–10 character alphanumeric name for the receiving node environment: OS400, OS390,
MVS, MSP, OPENVMS, TANDEM, UNIX, VM, VOS, VSE, Microsoft Windows, or Microsoft
Windows_NT.
FDSN(‘from data-set-name’)
specifies the file to be sent to the remote node. The file name can be up to 256 characters long. File
names are verified based on the i5/OS standard file name conventions.The entire data set name must
be in single quotes. If you are using the Sterling Connect:Direct for i5/OS F4 prompting feature, the
system supplies the single quotes if you do not type them with the data set name on the command line.
The length of the input field displayed is 132 characters, by default. To increase the length of the field
to 256 characters, type an ampersand(&) followed by a blank in the first two positions of the field.
Note: The values of *LIBL, *CURLIB, and QTEMP cannot be used when sending to or from an
iSeries system using Sterling Connect:Direct for i5/OS. A specific library name must be used
for copying from or to a data set on the iSeries.
Sterling Connect:Direct for i5/OS supports two file systems: native file system and integrated file
system. Refer to the Using the File Systems on page 19 for detailed information about the file systems.
TDSN(’to data-set-name’)
specifies the receiving file name on the remote node. The file name can be up to 256 characters long.
The length of the input field displayed is 132 characters, by default. To increase the length of the field
to 256 characters, type an ampersand(&) followed by a blank in the first two positions of the field.
Note: Do not use member names longer than eight characters when sending to z/OS, VSE or MSP
nodes. The results are unpredictable.
For TDSN, the values of *LIBL,*CURLIB, QTEMP cannot be used when sending to or from
an iSeries system using Sterling Connect:Direct for i5/OS. A specific library name must be
used for copying from or to a data set on the iSeries.
TDSN specifies the destination file name. File names are verified based on the i5/OS standard file
name conventions. The entire DSN must be in single quotes. When you are using the Sterling
Connect:Direct for i5/OS F4 prompting feature, the system supplies the single quotes if you do not
type them with the file name on the command line.
Sterling Connect:Direct for i5/OS supports both the native file system and the integrated file system.
Refer to Native File System on page 19.
Note: If the TDSN requires a password, specify the password in the TDSN after the data set name.
A slash (/) must follow the data set name and precede the password. This password is used
at data set allocation. If it is not correct, the system issues a Write to Operator Request
(WTOR) which requests the password when Sterling Connect:Direct opens the data set.
The following table summarizes the data set name requirements for Sterling Connect:Direct
platforms.
’) specifies sending system operations. If you omit this parameter, Sterling
| DBCS)|XTRANPAD(pc)] CCSID(nnnnn) EORCHAR(xxxx)
Connect:Direct for i5/OS assumes ‘TYPE(FILE)’. The maximum number of characters for
FMSYSOPTS is 2K.
Note: All FMSYSOPTS keyword values must be enclosed in parentheses. The entire
FMSYSOPTS string must be enclosed in single quotes, for example,
FMSYSOPTS(‘TYPE(FILE) SNDFFD(*YES)’).
PRECMPR(*YES|*NO
) specifies that the file being sent has previously been compressed using the
CDCOMP command. This option PRECMPR(*YES) cannot be specified if a secured copy function is
being performed using Sterling Connect:Direct Secure Plus. To send a file that has been compressed,
you must specify the PRECMPR(*YES) parameter with the CDSND command. For information
about how to compress files, refer to Chapter 9, Compressing Files.
Note: Ensure that the output file contains no members before you execute CDCOMP.
Sending a File 25
EXITCMD(valid i5/OS command) specifies a command to execute only if the copy process is
successful.
FAILCMD(valid i5/OS command) specifies a command to be executed only if the copy process is
not successful.
SNDFFD(*YES|*NO
) specifies whether the sending node transfers file field descriptions.
Use the following formula to determine whether a file is sent with the file field descriptions. If the
bytes required value is greater than 12K, you cannot transfer the file field descriptions.
12 x number of keys) + (45 x number of fields) +SYSOPTS=bytes required
Note: You cannot use this parameter with the integrated file system.
TEXTFILE(*YES|*NO
) specifies the file being sent is a text file. This keyword is for the i5/OS
only.
TYPE(FILE
|MBR|OBJ) specifies the type of data to be sent. You must define the type of data to be
copied as one of the following:
FILE
specifies that the file being copied is a physical database file.
MBR specifies that the object being copied is a member of a physical database file.
OBJ specifies that the data to be copied is in save file format.
XTRAN(table-name) specifies the translation table to use. The named table object must exist in a
library that is in the library list of the session manager job. If the library name is not in the list, the
CDSND command fails.
If the XTRAN keyword is present, then the following related optional keywords can also be used:
XTRANLSO (so-code) specifies extended translation local shift-out code. This keyword
specifies the hexadecimal code to use for the local (i5/OS side) shift-out (SO) character and
overrides the default value of 0E. You can specify any two valid hexadecimal digits.
XTRANLSI (si-code) specifies extended translation local shift-in code. This keyword specifies
the hexadecimal code to use for the local (i5/OS side) shift-in (SI) character and overrides the
default value of 0F. You can specify any two valid hexadecimal digits.
XTRANLDATA (MIXED
|DBCS) specifies extended translation local data format. This
keyword specifies the format of the data on the local (i5/OS side) of the COPY.
MIXED
indicates that the data can contain both double-byte character set (DBCS) and
single-byte character set (SBCS) characters and that SO/SI characters are used. MIXED is the
default.
XTRANPAD(pc) specifies that padding characters are in use. When DBCS data is translated
from EBCDIC to ASCII, PAD specifies that the SHIFT-OUT and SHIFT-IN characters are
replaced by a pad character to allow the displacement of fields within a record to remain
unchanged during translation.
When DBCS data is translated from ASCII to EBCDIC, PAD specifies that the input ASCII
DBCS file is in a padded format. The character immediately preceding a DBCS character or
string is overlaid by the SHIFT-OUT character. The character immediately following a DBCS
character or string is overlaid with the SHIFT-IN character. This allows the displacement of fields
within a record to remain unchanged during translation.
pc is the pad character to be used during EBCDIC to ASCII translation. pc is ignored for
ASCII to EBCDIC translations.
If XTRANPAD is not used, the SI/SO characters are stripped from the file when transferring
from EBCDIC to ASCII, and added to the records when sending from ASCII to EBCIDC.
26IBM Sterling Connect:Direct for i5/OS User’s Guide
DBCS indicates that the data is pure DBCS characters and that no SO/SI characters are used.
The following rules apply to the use of the XTRAN keyword:
You must specify the XTRAN keyword to use extended translation; all other keywords are
optional.
The default for local shift-out is the IBM standard x0E.
The default for local shift-in is the IBM standard x0F.
The default local data format is MIXED with SO/SI in use. XTRAN is not allowed with
PRECMPR(*YES) or DECMPR(*NO)
If you send a file to an ASCII platform using extended translation, you must specify in the
TOSYSOPTS that the data type is binary. Refer to the IBM Sterling Connect:Direct Processes
Web site at http://www.sterlingcommerce.com/documentation/processes/processhome.html
platform-specific SYSOPTS parameters.
CODEPAGE(nnnnn,nnnnn) converts data from one code page to another. The supported
conversions are identified on the IBM Web site in the V5R1 Information Center, DB2 Universal
Database for iSeries SQL Reference, Appendix E. CODEPAGE() on Sterling Connect:Direct for
i5/OS relates to CODEPAGE() developed for the z/OS system, UNIX, and Microsoft Windows.
nnnnn identifies the IBM CCSID codepage number to convert from and the IBM CCSID code
page number to convert to. If the FROM code page or TO code page is locale, the code page for
the locale where Sterling Connect:Direct is executing is used. For example, if
fmsysopts(codepage(locale,1208)), then the FROM code page is the code page for the locale and
the TO code page is UTF-8.
for
ALWNULL(Y) specifies if NULLS characters will be processed when sending DB2 files.
CCSID(nnnnn) specifies the coded character set ID to use when creating IFS files. If no character set
ID is specified, the system default is used.
EORCHAR(xxxx) specifies the two-to four-digit hexadecimal symbol to identify the character to use
in text files as the end-of-record character, for example, EORCHAR(0A).
specifies system operation parameters a the receiving node. The maximum number of characters
permitted for TOSYSOPTS is 256. The format of CODEPAGE is based on the remote operating
system default values for CDSND.
For additional information about valid platform-specific SYSOPTS parameters, see the appropriate
COPY statement section of the IBM Sterling Connect:Direct Processes Web site at
http://www.sterlingcommerce.com/documentation/processes/processhome.html
.
EXITCMD(valid i5/OSi5/OS command) specifies a command to be executed only if the copy
process is successful.
FAILCMD(valid i5/OS command) specifies a command to be executed only if the copy process is
not successful.
DECMPR(*YES|*NO
) specifies whether the receiving Sterling Connect:Direct node is to
decompress the received file. This parameter is valid only when the receiving system is a Sterling
Connect:Direct for i5/OS node. The EXITCMD and FAILCMD are valid here if the receiving node is
i5/OS 3.3.00 or higher. This option DECMPR(*NO) cannot be specified if a secured copy function is
being performed using Sterling Connect:Direct Secure Plus.
Note: Ensure that the destination file contains no members before you send a file with
DECMPR(*NO) specified.
*NO instructs the receiving system to place the received data in a database file without
decompressing it.
Sending a File 27
CCSID(nnnnn) specifies the coded character set ID to use when creating IFS files. If no character set
ID is specified, the system default is used.
EORCHAR(xxxx) specifies the two-to four-digit hexadecimal symbol to identify the character to use
in text files as the end-of-record character, for example, EORCHAR(0A).
CODEPAGE(nnnnn,nnnnn) converts data from one code page to another. The supported
conversions are identified on the IBM Web site in the V5R1 Information Center, DB2 Universal
Database for iSeries SQL Reference, Appendix E. CODEPAGE() on Sterling Connect:Direct for
i5/OS relates to CODEPAGE() developed for the z/OS system, UNIX, and Microsoft Windows.
nnnnn identifies the IBM CCSID code page number to convert from and the IBM CCSID code
page number to convert to. If the FROM code page or TO code page is locale, the code page for
the locale where Sterling Connect:Direct is executing is used. For example, if
tosysopt(codepage(1208,locale)), then the FROM codepage is UTF-8 code page and the TO code
page is the local code page.
TYPE(FILE
|MBR|OBJ|SPLF) specifies the type of data to be sent. Define the type of data to be sent
as one of the following:
FILE
specifies that the file being copied is a physical database file.
MBR specifies that the object being copied is a member of a physical database file.
OBJ specifies that the data to be copied is in save file format.
SPLF specifies that the data to be copied is an i5/OS spooled output file.
For each type of file, you can specify certain additional TOSYSOPTS parameters.
If the receiving node is a Sterling Connect:Direct for i5/OS node, the following TOSYSOPTS
parameters are valid for TYPE(FILE) and TYPE(MBR) files:
RCDLEN(record-length) specifies the data length for each record in the file.
FILETYPE(*SRC
|*DATA) specifies the type of file to be created.
TEXT(‘text description’) specifies a text description to be associated with this member (and
file, if created). This description cannot exceed 50 characters and must be enclosed in single
quotes.
EXPDATE(expiration-date) specifies the date after which the new or replaced member cannot
be used. If EXPDATE is not specified, then the file does not have an expiration date.
MAXMBRS(number|*NOMAX
) specifies the maximum number of members a physical file
can contain.
SIZE(#-of-recs|incr-value #-of-incrs|*NOMAX) used when a new file is created for the file
received.
AUT(*CHANGE
|*ALL|*USE|*EXCLUDE) specifies the authority to be given to a user who
does not have specific authority to the file or member, is not on the authorization list, and whose
user group does not have specific authority to the file or member.
IGCDTA(*YES|*NO) specifies that DBCS support is installed on the destination i5/OS node
and the file being sent contains DBCS data.The following TOSYSOPTS parameters are valid for
TYPE(OBJ) files:
MAXRCDS(number|*NOMAX
) specifies the maximum number of records the save file (which
was created to hold the data received) can reach.
ASP(auxiliary-storage-pool) specifies the auxiliary storage pool from which the system
allocates storage for the save file.
TEXT(‘text description’) specifies a text description to be associated with this object. This
description cannot exceed 50 characters and must be enclosed in single quotes.
AUT(*EXCLUDE|*CHANGE|*ALL|*USE) specifies the authority to give to a user who does
not have specific authority to the object, is not on the authorization list, and whose user group
does not have specific authority to the object.
28IBM Sterling Connect:Direct for i5/OS User’s Guide
The following TOSYSOPTS parameters are valid for TYPE(SPLF) files:
DEV(*JOB|*SYSVAL|device-name) specifies the name of the printer device description.
DEVTYPE(*IPDS|*SCS)|*USERASCII specifies the type of data stream created for a printer
file from the data received.
PAGESIZE(page-length page-width) specifies the length and width of the page us ed by the
printer. This parameter overrides the FORMT YPE par a meter.
LPI(3|4|6|7.5|8|9) specifies the line space setting (lines per inch) on the printer.
CPI(5|10|12|13.3|15|16.7|18|20) specifies the printer character density, in characters per inch, for
the printer.
OVRFLW(overflow-line-number) specifies the line number on the page where overflow to a
new page begins. The value specified must not exceed the form length specified for PAGESIZE.
FOLD(*NO|*YES) specifies whether entire records are printed when the record length exceeds
the form width.
RPLUNPRT(*YES ‘replacement-character’|*NO) specifies whether unprintable characters
are replaced with printable characters when printed. It also specifies the replacement character.
ALIGN(*NO|*YES) specifies whether the page must be aligned in the printer before printing is
started.
CTLCHAR(*NONE|*FCFC) specifies whether the data contains printer control characters.
CHLVAL(*NORMAL| (channel#1 line#1) ... (channel#12 line#12)) specifies the list of
channel numbers with their assigned line numbers. Note that CTLCHAR(*FCFC) must be
specified as a SYSOPTS parameter for this to be a valid parameter.
FORMFEED(*DEVD|*CONT|*CUT|*AUTOCUT) specifies the form feed attachments used
by the printer (4214, 5219, and 5553 printers only).
PRTQLTY(*STD|*DRAFT|*DEVD|*NLQ) specifies the quality of print produced.
DRAWER(1|2|3|*E1) specifies the source drawer to be used when automatic cut-sheet feed
mode is used. FORMFEED(*AUTOCUT) must be specified as a SYSOPTS parameter for this to
be a valid parameter.
FONT(*CPI|*DEVD|font-identifier) specifies the font identifier to be used for the spooled
output file.
CHRID(*DEVD|*SYSVAL| graphic-character-set code-page) specifies the character
identifier to be used for the spooled output file. This parameter allows you to print data with
different character identifier coding.
PAGRTT(*DEVD|*COR|0|90|180|270) specifies the degree of rotation (clockwi se from the
edge of the paper first loaded into the printer) of text on each page printed. 0|90|180|270 indicates
the specific angle of rotation.
PRTTXT(‘print-text’) specifies a line of text to be printed at the bottom of each page printed.
Up to 30 characters enclosed in single quotes is specified.
JUSTIFY(0|50|100) controls the print positions of the characters on the page (in the spooled file)
so the right margin is regular.
DUPLEX(*NO|*YES|*TUMBLE) specifies whether the spooled output file is printed on one or
both sides of the paper.
SPOOL(*YES|*NO) specifies whether the data is sent to a spooled file prior to prin ting.
OUTQ(*JOB|*DEV|library-name/output-q ueue- name) specifies the output queue for the
spooled output file created. This parameter is valid only when SPOOL(*YES).
FORMTYPE(form-type) specifies the type of form to use in the printer when the spooled file is
printed. A form-type identifier is user-defined and is no longer than 10 characters. The
PAGESIZE parameter overrides this parameter.
Sending a File 29
COPIES(number-of-copies) specifies the number of copies to be printed. Valid values range
from 1–255. This parameter is valid only when SPOOL(*YES).
MAXRCDS(maximum-records) specifies the maximum number of records that is placed in the
spooled file. Valid values range from 1–500000. This parameter is valid only when
SPOOL(*YES).
FILESEP(number-of-file-separators) specifies the number of blank separator pages to be
placed between each copy of the file printed.
HOLD(*YES|*NO) specifies whether the file is to be held on the output queue until released by
the user. This parameter is valid only if SPOOL(*YES).
SAVE(*YES|*NO) specifies whether the spooled output file is to be saved on the output queue
once printed. This parameter is valid only if SPOOL(*YES).
OUTPTY(*JOB|output-priority) specifies the scheduling priority of the file on the output
queue. This parameter is valid only if SPOOL(*YES).
USRDTA(user-data) allows up to 10 characters of data to identify the spooled output file. This
parameter is valid only if SPOOL(*YES).
Refer to the IBM Sterling Connect:Direct Processes Web site at
http://www.sterlingcommerce.com/documentation/processes/processhome.html
for general
information on SMS support and TOSYSOPTS parameters for other platforms.
Optional Parameters
The following parameters, listed alphabetically, are optional. Unless noted, the parameters apply to all remote
node environments.
BLKSIZE(n|*CALC
specifies the blocksize value for the source file. This value must be a multiple of the file record size.
n specifies the block size of the file. This value must be a multiple of the record size. The valid range
is 1–32720
*CALC
CKPTINV(n)
Number of bytes, from 1K to 2 gigabytes, to send or receive before taking a checkpoint. The format is
nnnnnnn, nnnnnnK, or nnnnnnM, where K specifies thousands of bytes and M specifies millions of
bytes. A value of 0 specifies no checkpoint restart Sterling Connect:Direct for i5/OS uses the value
you specify, rounded up to the nearest record boundary, to determine when to take a checkpoint. If
you specify a value between 1 and 1023, the value becomes 1024 or 1K.
A checkpoint interval specified here overrides the system-wide default value in the initialization
parameters file.
Checkpointing cannot occur in the following cases, even if you specify a checkpoint interval:
The file being sent is compressed during the send operation by the local node using the extended
A precompressed file is sent and decompressed by the receiving node during the send operation.
A file is sent to a single z/OS partitioned data set member.
indicates that the blocksize is calculated.
compression feature, and decompression is deferred on the receiving node. That is, the
TOSYSOPTS parameter has DECMPR(*NO).
That is, the FMSYSOPTS has PRECMPR(*YES) and TOSYSOPTS has DECMPR(*YES).
)
If you request checkpointing when you are transferring multiple members of a file, checkpoints are
taken only at member boundaries regardless of the interval specified in the initialization parameters or
in the CDSND or CDRCV command.
30IBM Sterling Connect:Direct for i5/OS User’s Guide
CLASS(n)
determines the node-to-node session on which an operation can execute. The CLASS is a number in
the range of 1–255. If you do not specify the CLASS parameter, it defaults to the number of maximum
sessions defined in the mode description for the communications environment.
Note: The CLASS parameter is not used by Sterling Connect:Direct for i5/OS.
COMPRESS (*NO
|*YES|*EXT|X\xx\|C\cc\)
specifies that the data is to be compressed, which reduces the amount of data transmitted as the file is
copied from one node to another. The file is automatically decompressed at the destination.
Note: Compression is CPU-intensive, and its effectiveness depends on the data and line speed.
Only use it if it benefits the installation.
You should specify the primary compression character for text data or single-character repetitive data.
Extended compression generally offers improved compression for all types of data.
*NO
specifies no compression.
*YES enables compression. If *YES is specified, the default primary compression character is
PRIMEchar=X\40\ (hex 40=“ ”).
If you specify *YES, Sterling Connect:Direct compresses the data transmitted based on the following
rules:
Repetitive occurrences (ranging from 2–63) of the primary compression character are
compressed to one byte.
Repetitive occurrences (ranging from 3–63) of any other character are compressed to two bytes.
*EXT specifies that extended compression is used to search for repetitive strings of characters in data
and compress them to codes that are transmitted and converted back to the original string during
decompression. Use this parameter when the line transmission speeds are limited, the CPU is
available, and the data is repetitive.
X\xx\ enables compression, where xx is the hexadecimal representation of the value to be used for the
primary compression character.
C\cc\ enables compression, where cc is the character representation of the value to be used for the
primary compression character.
CRC(*INITPARMS
|*NETMAP|*OFF|*ON)
Determines whether node and Process statement overrides for Cyclic Redundancy Check (CRC) are
allowed. If this value is set to *OFF, setting overrides for CRC checking will be ignored. The default
value is *INITPARMS.
*INITPARMS
specifies that the CRC setting is determined by the value for the initialization
parameter TCP.CRC.
*NETMAP specifies that the CRC setting is determined by the value for the NETMAP parameter,
Cyclic Redundancy Check. The value for the initialization parameter TCP.CRC must be set to *ON
and the value for the initialization parameter TCP.CRC.OVERRIDE must be set to *YES.
*OFF specifies that CRC is disabled.
*ON specifies that CRC is enabled.
ECTUNING(ecclevel,ecwinsize,ecmlevel)
ECCLEVEL specifies the extended compression level, which affects how much CPU the extended
compression routines use. Higher compression levels use more CPU but achieve greater compression.
The valid values for this subparameter are 1–9, inclusive. The default value is *INITPARMS.
Loading...
+ 148 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.