CDRCV Command Format

Required Parameters

For each type, you can specify certain additional TOSYSOPTS 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 tosysopt(codepage(1208,locale)), then the FROM code page is UTF-8 code page and the TO code page is the local code page.

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 CDRCV command fails.

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).

Optional Parameters

The following parameters, listed alphabetically, are optional. Unless otherwise noted, the parameters apply to all remote node environments.

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.

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.

CLASS(n)

COMPRESS(*NO | *YES| *EXT | X\xx\ | C\cc\ )

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=“ ”).

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.

*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. Specify this parameter when line transmission speeds are limited, the CPU is available, and the data is repetitive.

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.

ECWINSIZE specifies the extended compression window size, which is specifically for the history buffer that is filled from the user’s input buffer ( both compressing and decompressing). The window specifies the amount of storage designated to maintain data previously read.

This data can be scanned for string matches. The extended compression window size affects how much virtual memory the extended compression routines use. Higher window size values use more memory but achieve greater compression. The valid values for this subparameter are 8–15, inclusive. The default value is *INITPARMS.

ECMLEVEL specifies the extended compression memory level parameter, which determines how much memory should be allocated for other internal data structures like the hash table and the previous table (pointers to previous strings starting with the same 3 characters). The extended memory level affects how much memory the extended compression routines use. Higher memory levels use more virtual memory but achieve greater compression. The valid values for this subparameter are 1–9. inclusive. The default value is *INITPARMS.

EXCLUDE(generic, member-name, (start-range/stop-range), ‘list’)

specifies criteria that identifies the file members that are not to be copied. EXCLUDE allows you to make exceptions to members specified generically or by range in the SELECT option. Refer to the IBM Sterling Connect:Direct Processes Web site at http://www.sterlingcommerce.com/documentation/processes/processhome.html for the syntax and override priority for the SELECT and EXCLUDE parameters appropriate to the remote node.

generic specifies a generic member name. For example, if you specify CD*, all member names beginning with CD are excluded.

member-name specifies an individual member name.

start-range/stop-range specifies first and last names in an alphanumeric range of members. Although member names in a range are treated as generics, they cannot be used with an asterisk (*). A slash (/) separates the first (start-range) and last (stop-range) member names. The two members specified, as well as all members in the range, are excluded.

‘list’ specifies any combination of the subparameters.

FALIAS(*YES|*NO)

specifies whether aliases are copied when their associated member names are copied.

FBUFND(n)

specifies the number of I/O buffers VSAM uses for transmitting data between virtual and auxiliary storage. (A buffer is the size of a control interval in the data component.) Valid values range from 1–510. The default is 2. Increasing this number generally improves the I/O performance on the file but requires more memory. This parameter is valid only when the source side is an z/OS node.

FDBPARMS(dbid, dbsubid)

indicates that the Sterling Connect:Direct for z/OS SQL SERVER is to process the I/O request against the database identified by the subparameters of this keyword and defined by the SQL= parameter. The DBPARMS parameter is used with the optional Sterling Connect:Direct for SQL feature. This parameter is valid only when the source side is a z/OS node. Only DB2 is supported.

To determine the values to code to access a given DB2 table or set of DB2 tables, consult your database administrator.

dbid specifies the 1–4 byte DB2 database ID.

dbsubid specifies the 1–4 byte DB2 database sub-ID.

FDCB(modeldcb, blksize, den, dsorg, keylen, linct, lrecl, optcd, recfm, rkp, trtch)

overrides attributes of the source file. DCB attributes are determined from the operating system unless specified.

modeldcb specifies a model data set control block (DSCB).

blksize specifies the length in bytes of the block. The minimum length is 18 bytes, and the maximum length is 32,760 bytes.

dsorg specifies the file organization. Supported file organizations are BDAM, ISAM, PO, PS, and

VSAM.

keylen specifies the length of the keys used in a file. Maximum length in bytes is 255.

linct specifies the blocks or tracks searched to find a free block or available space.

lrecl specifies the record length in bytes.

optcd specifies optional processing associated with this file. This specification only applies to this file and is not automatically applied to the other files involved in the RECEIVE operation.

rkp specifies the position of the first byte of the record key within each logical record. The beginning byte of a record is addressed as 0.

FDISP(current, normal end, abnormal end)

specifies the status of the remote file and what is to be done with the file after notification of successful transmission.

FIOEXIT(program-name)

specifies the name of the user-written program to be given control for I/O-related requests for the associated data.

FIOPARM(parameter-name)

specifies a parameter, or list of parameters, to be passed to the specified exit. This parameter is valid only when the source side is a z/OS node. The FIOPARM syntax depends on the parameter list that the program specified in FIOEXIT requires.

FLABEL(seqno, labeltype, pswdread, inout, retpd|expdt)

specifies label information for the tape.

seqno specifies the relative file position on the tape.

pswdread specifies that a password must be supplied by the operator or user before the file can be accessed.

inout specifies that a BSAM data set opened for INOUT or a BDAM data set opened for UPDAT is to be read only.

retpd specifies the retention period for the data set in days, where nnnn is 1–4 digits.

expdt specifies the expiration date for the data set, where yyddd or yyyyddd is a valid Julian date.

FLINK(vmuserid,pwd,accmode,ccuu)

specifies the disk where the CMS file is located. This parameter allows the user to access the CMS file. This parameter is valid for VM nodes only.

vmuserid specifies the owner ID for the CMS minidisk where the file is located. The valid length ranges from 1–8 characters.

pwd specifies the appropriate password for the CMS minidisk where the file is located. The maximum length is 256 characters. The default password is ALL.

accmode specifies the link access mode.

When used with the FROM parameter, the access modes are W (primary read/write access), M (primary multiple access), R (primary read only), RR (primary and secondary read only access), WR (primary read/write access; alternate read only access), MR (primary multiple access; alternate read only access), and MW (primary multiple access; alternate read/write only access).

When used with the TO parameter, the access modes are W, M, and MW.

ccuu specifies the virtual address of the disk where the CMS file is located. A three-digit number is valid.

FMSVGP(data-set-name)

specifies the remote file mass storage volume group that resides on a mass storage system (MSS) device. This group must be a valid DD (data definition) name. This parameter is valid when the source side is a z/OS node only.

FPDSDIR(*YES|*NO)

specifies whether the user-related information in the directory is sent.

FSQL(sql-statement|DSN=data-set-name)

defines the SQL statement to be processed against the database identified by the DBPARMS parameter or the DSN containing the SQL statements. The SQL parameter is used with the optional Sterling Connect:Direct for z/OS SQL feature. This parameter is valid only when the source side is an Sterling Connect:Direct for z/OS node.

sql-statement defines the actual SQL statement to be processed.

data-set-name specifies the data set containing the SQL statements to be processed.

FTYPE(entry-name)

specifies the entry name of the type defaults file on the remote node that contains the default file attributes. Specify this typekey only when the user requests defaults.

FUNIT(name)

specifies the unit address, device type, or user-assigned group name where the file resides or will reside. For SAM-to-SAM copies where the destination file is new and the UNIT parameter is not coded, the device type from the source file is used.

Specify a unit-count to allow additional units to be allocated if required, or specify P to allocate the same number of units as volumes and then parallel mount the volumes. This parameter is valid only when the source side is a z/OS node.

FVOL(private, volcount, ser)

specifies the volume serial numbers containing the file and optional processing associated with the file. If VOL is not specified, the file must be cataloged.

private specifies allocation of an output file only if the volume is specifically requested and is used for direct access storage devices only. Valid values are *YES and *NO.

volcount specifies the maximum number of volumes required by an output file.

ser identifies by serial number the volumes on which the output file resides or will reside.

FVOLREF(data-set-name)

allows you to retrieve the specified data set from the same volume as the referenced data set. You must catalog it on the system where it is referenced. This parameter is valid only when the source side is a z/OS node.

FVSAMCAT(dsn,vmid,pwd,accmode,cuu)

other than the master catalog.

dsn specifies the filename of the VSAM catalog containing the file to be copied. The maximum length is 44 characters.

vmid specifies the owner ID for the VSAM minidisk where the file is located. The maximum length is eight characters.

pwd specifies the appropriate password for the VSAM minidisk where the file is located. The maximum length is eight characters.

accmode specifies the link access mode. Valid access modes are NULL, W (primary read/write access), M (primary multiple access), and MW (primary multiple access; alternate read/write only access).

cuu specifies the virtual address of the disk where the VSAM file is located. Any three-digit number is valid.

NOTIFY(userid)

specifies the user ID on the local node to receive status messages that are directed to the user’s message queue.

PLEXCLASS(user-defined class)

PNAME(process-name)

PNODEID(id, pswd, newpswd)

specifies security user IDs and passwords at the local i5/OS node. Use this parameter only to validate security with a different ID than the one you used to sign on to the system.

id specifies the security ID passed to the security system at the remote node (1–10 alphanumeric characters).

pswd specifies the current security password for the specified ID. The security system can use this parameter at the remote node to validate the current security password (1–10 alphanumeric characters). This is optional unless the user has security set to require a password.

newpswd specifies the new security password. Sterling Connect:Direct for i5/OS does not support this parameter.

REPLACE(*YES|*NO)

specifies that the remote file or PDS replaces members of the same name at the local file.

RMTWORK(*YES|*NO)

specifies whether a remote Process can run on the session after Sterling Connect:Direct for i5/OS has completed its Process on the session.

*YES allows a remote Process to run on the session after Sterling Connect:Direct for i5/OS completes its Process.

*NO terminates the session after Sterling Connect:Direct for i5/OS executes the command function.

SACCT(snode-accounting-data)

specifies the accounting data for the remote node. The maximum length of the accounting data is 256 characters. If special characters are part of the accounting data, you must enclose the string in single quotation marks.

SECOPTIONS(* *)

specifies Encryption and Digital Signature values.

Encryption specifies if data encryption is to be performed and what algorithm to use.

SELECT(member, new-name, R/NR,‘list’)

specifies selection criteria by which file members are to be copied. Refer to the IBM Sterling Connect:Direct Processes Web site for the syntax and override priority for the SELECT and EXCLUDE parameters appropriate to the remote node.

Use this parameter when you specify TYPE(FILE) in the TOSYSOPTS parameter.

The SELECT parameter consists of three positional subparameters separated by commas.

new-name specifies a new name for a member. You cannot use the new-name subparameter if a generic or range is used to select the members to be copied, or if you specify a list of member names.

R/NR specifies whether a copied member replaces an existing member of the same name in the local file. When used with a generic or a range, this subparameter applies to all members selected.

R specifies that a member replaces an existing member of the same name in the local file. When used with the new-name subparameter, R applies to the specified new-name and not the original member name.

NR specifies that a member does not replace an existing member of the same name in the local file. NR overrides the REPLACE parameter.

SNODEID(id, pswd, newpswd)

specifies security user IDs and passwords at the remote node. If nothing is specified for this parameter, the user profile of the user who submits the command is sent to the remote node with a blank password.

id specifies the security ID passed to the security system on the remote node (1–64 alphanumeric characters).

pswd specifies the current security password. The security system can use this parameter on the SNODE to validate the current security password (1–64 alphanumeric characters). This is optional unless the user has set security to require a password.

TDISP(current)

specifies the status of the file on the local i5/OS node.

TRACEOPT

Trace Instructions

(L, S, F, C, X, K, D, H, V, W, P,|*NONE|*ALL|*EXT| *COMMON|*INITPARMS|*CURRENT

Command Trace Options

L,S,F,C,X,K,D,H,V,P|*ALL|*EXT|*COMMON| *NONE)