Settings for Connect:Direct Server CopyTo Service

Edit online

When you configure the Connect:Direct Server CopyTo service, you must specify settings for the following fields in the Graphical Process Modeler. These fields are listed in alphabetical order.

Note: Sterling B2B Integrator version 5.1 and later supports the most common set of parameters available in the Sterling Connect:Direct® for z/OS® Process Copy statement To clause to provide more functionality, such as enhanced file allocation and disposition options for the destination file on the remote Sterling Connect:Direct for z/OS node. To ensure that business processes created in earlier versions of Sterling B2B Integrator continue to execute properly, parameters existing in versions 5.0 and earlier will still be supported. These old parameters, which cannot be mixed with new parameters in the same CopyTo service, are not included in the following table.

For users familiar with the Sterling Connect:Direct Process language, the CD Server CopyTo Service parameters with the Remote prefix are equivalent to the parameters specified in the COPY TO clause of a COPY statement and refer to the destination file being copied to the Sterling Connect:Direct node. The parameters with the Local prefix correspond to the parameters specified in the COPY FROM clause and refer to the source file on the Sterling Connect:Direct Server Adapter node.

Field Description Supported Remote Sterling Connect:Direct Platforms
BinaryMode Specifies how the data from the source file on the local Connect:Direct Server Adapter node will be transferred to the remote Sterling Connect:Direct node. Optional.

Valid values are:

  • Yes—file will be transferred in simple binary mode
  • No—file will not be transferred in binary mode but rather in text mode (default)
  • VB—copy will be performed as a variable block binary transfer with Sterling Connect:Direct on the z/OS platform
 Yes—All platforms

No—All platforms

VB—z/OS platform
CDRecordType Specifies the entry name of the type defaults file. The type defaults file contains the default file attributes used to allocate the destination file. The type defaults file is specified only when defaults are requested by the user. Optional. z/OS platform
CheckpointInterval Specifies the byte interval for checkpoint support, which allows restart of interrupted transmissions at the last valid checkpoint point and therefore reduces the time to retransmit the file. Optional. For more information, see How Checkpoint Restart and Retry Processing Works.

Valid value is number of bytes, in one of the following formats:

  • nnnnnnnnnn
  • nK or nM
  • nm or nk
 All platforms
Compression 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 will be automatically decompressed at the destination. Optional. Valid values are 1-9. Increasing the value indicates a greater attempt at compression and will consume more CPU. Values greater than 2 may not result in further compression. All platforms
Config Name of the service configuration. Required. All platforms
LocalDocumentId A valid document ID for an existing document in Application. When this field is left blank, the primary document provided to the business process is used. Optional. All platforms
LocalFileNameLabel Specifies a label for the name of the local file. This file name label is provided to the remote Sterling Connect:Direct node for informational purposes only. Optional. All platforms
LocalFromCodePage Specifies a code page supported by Java VM. Used in conjunction with the value of the LocalToCodePage parameter. The Connect:Direct Server Adapter will apply a code page conversion to a document before transferring it to a remote Sterling Connect:Direct Server. This parameter is only valid with the following conditions:
  • Code page specified is supported by the local Java VM
  • Parameter LocalToCodePage is defined
  • Text mode file transfer (BinaryMode =No)

Optional. Valid value is the name of a codepage supported by the local Java VM.

For example:

<assign to="LocalFromCodePage">Cp1251</assign>

<assign to="LocalToCodePage">Cp1047</assign>

This example will translate the local file from windows latin-1 toIBM EBCIDIC. See http://www.oracle.com/technetwork/java/index.html for a complete list of supported encodings.

 All platforms
LocalStripBlanks Specifies whether the Connect:Direct Server Adapter will strip blanks from the end of records in the local file before sending them to the remote node. This option is only valid for Text mode file transfers (BinaryMode = No). Optional.

Valid value is Yes or No (default).

 All platforms
LocalToCodePage Specifies a code page supported by Java VM. Used in conjunction with the value of the LocalFromCodePage parameter. The Connect:Direct Server Adapter will apply a code page conversion to a document before transferring it to a remote Sterling Connect:Direct Server. This parameter is only valid with the following conditions:
  • Code page specified is supported by the local Java VM
  • Parameter LocalFromCodePage is defined
  • Text mode file transfer (BinaryMode =No)

Optional. Valid value is the name of a codepage supported by the local Java VM.

For example:

<assign to="LocalFromCodePage">Cp1251</assign>

<assign to="LocalToCodePage">Cp1047</assign>

This example will translate the local file from windows latin-1 to ibm ebcdic. See http://www.oracle.com/technetwork/java/index.html for a complete list of supported encodings.

 All platforms
LocalXlate Specify the new LocalXlateTable Connect:Direct CopyTo/CopyFrom Service parameter to indicate which translation table the service should use during transmission. It may be specified using the Graphical Process Modeler or by editing the XML source of the business process.

For example:

<assign to="LocalXlate">Yes</assign>

<assign to="LocalXlateTable">ascii-to-ebcdic-table</assign>

All platforms
RemoteBUFND Specifies the number of I/O buffers VSAM will use for transmitting data between virtual and auxiliary storage. Optional.

Used only on the z/OS platform.

 z/OS platform
RemoteDATAEXIT Specifies a user-written program through which data is processed before being written to the destination file. Optional.

Used only on the z/OS platform. Valid syntax is:

exit-name | (exit-name [,parameter,...])

 z/OS platform
RemoteDCB Specifies Data Control Block (DCB), a group of attributes to be used in allocating destination files on a z/OS system.

Used only on the z/OS platform. Optional. Valid attributes are:

([model-file-name]

[,BLKSIZE=no.-bytes]

[,DEN=0 | 1 | 2 |3 | 4]

[,DSORG=[PS | PO | DA | VSAM]

[,KEYLEN=no.-bytes]

[,LIMCT=no.-blocks-or-tracks]

[,LRECL=no.-bytes]

[,OPTCD=W | Q | Z]

[,RECFM=record-format]

[,RKP=first-byte-position-of-record-key]

)

 z/OS platform
RemoteDISP Specifies how the destination file is to be created on the remote Sterling Connect:Direct server. Optional.

Valid syntax for Sterling Connect:Direct for z/OS is:

([NEW | OLD | MOD | RPL | SHR],

[KEEP | CATLG] ,

[KEEP | CATLG | DELETE]

)

|

(NEW | OLD | MOD | RPL | SHR)

|

NEW | OLD | MOD | RPL | SHR

 All platforms
RemoteFileName Name that should be given to the file that is copied to the remote Sterling Connect:Direct server. Required.
Note: You cannot use wildcards to copy multiple files from Sterling B2B Integrator to Sterling Connect:Direct with a single CopyTo service.
 All platforms
RemoteIOEXIT Specifies a user-written program to be invoked to perform I/O requests on the source file before copying the source file to a destination file. Optional.

Used only on the z/OS platform. Valid syntax is:

exit-name | (exit-name [,parameter,...])

 z/OS platform
RemoteLABEL Specifies label information for the tape used for the destination file. Optional.

Used only on the z/OS platform. Valid syntax is:

([file-sequence-number]

,[SL | AL | BLP | LTM | NL | AUL | NSL | SUL]

,[PASSWORD | NOPWREAD]

,[IN | OUT]

,[RETPD=nnnn | EXPDT=[yyddd | yyyy/ddd]]

)

 z/OS platform
RemoteMSVGP Specifies the group of mass storage volumes that reside on a mass storage system (MSS) device. This must be a valid DD (data definition) name, ranging from 1-8 alphanumeric characters with the first character alphabetic. Optional.

Used only on the z/OS platform. Valid value is MS-group-name.

 z/OS platform
RemoteSMS Specifies SMS attributes to use when creating the destination file. Optional.

Used only on the z/OS platform. Valid attributes are:

  • AVGREC=U | K | M
  • DATACLAS=data-class-name
  • DSNTYPE=PDS | LIBRARY | LARGE | EXTREQ | EXTPREF | BASIC
  • KEYLEN=length in bytes
  • KEYOFF=offset-to-key
  • LIKE=model-data-set-name
  • LRECL=number of bytes
  • MGMTCLAS=management-class-name
  • RECORG=KS | ES | RR | LS
  • SECMODEL=(profile-name [,GENERIC])
  • STORCLAS=storage-class-name
 z/OS platform
RemoteSPACE Specifies the amount of storage to be allocated for new files on the destination node. If SPACE is specified, the RemoteDISP of the destination file must be NEW or RPL. Optional.

Used only on the z/OS platform. Valid syntax is:

(CYL | TRK | blk,

(prim , [sec] , [dir]), [RLSE] , [CONTIG] , [ROUND]) |

(av-rec-len , (primary-rcds , [secondary-rcds] , [dir])

)

 z/OS platform
RemoteUNIT Specifies the storage device or type along with the number of devices required. Optional.

Used only on the z/OS platform. Valid syntax is:

([unit-address | device-type | group-name]

, [unit-count | P ] [,DEFER]

)

 z/OS platform
RemoteVOL Specifies one or more volume serial numbers containing the destination file and optional processing associated with the file. Optional.

Used only on the z/OS platform. Valid syntax is:

([PRIVATE],[RETAIN]

,[volume-sequence-no] ,[volume-count]

[,SER=(serial-no [,serial-no,...])

|SER=serial-no)

|([SER=(serial-no ,[serial-no,...]))

|(REF=dsn])

 z/OS platform
SessionToken Identifies an established session between two Sterling Connect:Direct nodes. Required. Session integrity cannot be guaranteed if the session token is omitted. For examples of session token usage, refer to Sample Business Processes on the Sterling B2B Integrator Side . All platforms
Sysopts Remote system operations to be implemented on the remote Sterling Connect:Direct node. Optional.

For example (for copying to Sterling Connect:Direct for Microsoft Windows only):

Datatype(text) xlate(yes)

 All platforms

Format of Sysopts varies by platform.