Note on usage
Function: Transfer file synchronously
User group: FT user
Alias name: FTSCOPY
Functional description
With the TRANSFER-FILE-SYNCHRONOUS command, you issue a synchronous request to send one or more files to the remote system or to retrieve one or more files from the remote system.
With a few exceptions, the operands are identical to those of the TRANSFER-FILE command. Consequently only the syntax is described.
TRANSFER-FILE-SYNCHRONOUS differs from TRANSFER-FILE in the following points:
There is no local follow-up processing. The local parameters PROCESSING-ADMISSION, SUCCESS-PROCESSING and FAILURE-PROCESSING are therefore omitted.
The local parameters LISTING, MONJV and JV-PASSWORD are not supported.
The general parameters PRIORITY, START and CANCEL are not used, because they do not have any significance for synchronous transfer.
For the FTAM protocol applies: It is also possible to fetch or send multiple files for each FTSCOPY command. This is controlled via using a file name starting with two commas. Please refer to the openFT manual "Concepts and Functions", section "Special points for file transfer with FTAM partners" for details.
The name of the command procedure which previously had the identical name has changed to START-TRANSFER-FILE-SYNCH.
Format
TRANSFER-FILE-SYNCHRONOUS / FTSCOPY |
TRANSFER-DIRECTION = TO-PARTNER / FROM-PARTNER ,PARTNER = <text 1..200 with-low> ,LOCAL-PARAMETER = *PAR AMETERS(...) *PARAMETERS(...) FILE-NAME = *NOT-SPECIFIED / <filename 1..54> / <c-string 1..512 with-low> / *LIBRARY-ELEMENT(...) / *POSIX(NAME=<posix-pathname 1..510>) *LIBRARY-ELEMENT(...) LIBRARY = *NOT-SPECIFIED / <filename 1..54> ,ELEMENT = *NOT-SPECIFIED / <filename 1..64 without-gen-vers>(...) / <composed-name 1..64 with-under>(...) <filename>(...) / composed-name>(...) VERSION = *STD / <text 1..24> ,TYPE = *NOT-SPECIFIED / <alphanum-name 1..8> ,PASSWORD = *NONE / <c-string 1..4> / <x-string 1..8> / <integer -2147483648..2147483647> / *SECRET ,TRANSFER-ADMISSION = *SAME / <alphanum-name 8..32> / <x-string 15..64> / <c-string 8..32 with-low> / *SECRET / *PARAMETERS(...) *PARAMETERS(...) USER-IDENTIFICATION = <name 1..8> ,ACCOUNT = *NONE / <alphanum-name 1..8> ,PASSWORD = *NONE / <c-string 1..8> / <c-string 9..32> / <x-string 1..16> / *SECRET ,CODED-CHARACTER-SET = *STD / <name 1..8> ,REMOTE-PARAMETER = *BS2 000(...) / *MSP(...) / *ANY(...) *BS2 000(...) FILE-NAME = *SAME / *NOT-SPECIFIED / <filename 1..54> / <c-string 1..512 with-low> / *LIBRARY-ELEMENT(...) / *POSIX(NAME=<posix-pathname 1..510>) *LIBRARY-ELEMENT(...) LIBRARY = *SAME / *NOT-SPECIFIED / <filename 1..54> ,ELEMENT = *SAME / *NOT-SPECIFIED / <filename 1..64 without-gen-vers>(...) / <composed-name 1..64 with-under>(...) <filename>(...) / <composed-name>(...) VERSION = *SAME / *STD / <text 1..24> ,TYPE = *SAME / *NOT-SPECIFIED / <alphanum-name 1..8> ,PASSWORD = *SAME / *NONE / <c-string 1..4> / <x-string 1..8> / <integer -2147483648..2147483647> / *SECRET ,TRANSFER-ADMISSION = *SAME / <alphanum-name 8..32> / <x-string 15..64> / <c-string 8..32 with-low>/ *SECRET / *PARAMETERS(...) *PARAMETERS(...) USER-IDENTIFICATION = <name 1..8> ,ACCOUNT = *NONE / <alphanum-name 1..8> ,PASSWORD = *NONE / <c-string 1..8> / <c-string 9..32> / <x-string 1..16> / *SECRET ,PROCESSING-ADMISSION = *SAME / *NOT-SPECIFIED / *PARAMETERS(...) *PARAMETERS(...) USER-IDENTIFICATION = <name 1..8> ,ACCOUNT = *NONE / <alphanum-name 1..8> ,PASSWORD = *NONE / <c-string 1..8> / <c-string 9..32> / <x-string 1..16> / *SECRET ,SUCCESS-PROCESSING = *NONE / <c-string 1..1000 with-low> ,FAILURE-PROCESSING = *NONE / <c-string 1..1000 with-low> ,FILE-AVAILABILITY = *BY-RECEIVING-SYSTEM / *IMMEDIATE / *DEFERRED ,ACCESS-MODE = *BY-RECEIVING-SYSTEM / *PARAMETERS(...) *PARAMETERS(...) READ-FILE = *NO / *YES ,INSERT-DATA-UNIT = *NO / *YES ,REPLACE-FILE = *NO / *YES ,EXTEND-FILE = *NO / *YES ,ERASE-DATA-UNIT = *NO / *YES ,READ-ATTRIBUTES = *NO / *YES ,CHANGE-ATTRIBUTES = *NO / *YES ,DELETE-FILE = *NO / *YES ,CODED-CHARACTER-SET = *STD / <name 1..8> *MSP(...) FILE-NAME = *NOT-SPECIFIED / <text 1..56> ,PASSWORD = *NONE / <alphanum-name 1..8> / *SECRET ,TRANSFER-ADMISSION = <alphanum-name 8..32> / <x-string 15..64> / <c-string 8..32 with-low> / *SECRET / *PARAMETERS(...) *PARAMETERS(...) USER-IDENTIFICATION = <name 1..7> ,ACCOUNT = *NONE / <text 1..43> ,PASSWORD = *NONE / <alphanum-name 1..8> / *SECRET ,PROCESSING-ADMISSION = *SAME / *NOT-SPECIFIED / *PARAMETERS(...) *PARAMETERS(...) USER-IDENTIFICATION = <name 1..7> ,ACCOUNT = *NONE / <text 1..43> ,PASSWORD = *NONE / <alphanum-name 1..8> / *SECRET ,SUCCESS-PROCESSING = *NONE /<c-string 1..1000 with-low> ,FAILURE-PROCESSING = *NONE / <c-string 1..1000 with-low> ,CODED-CHARACTER-SET = *STD / <name 1..8> *ANY(...) FILE-NAME = *NOT-SPECIFIED / <filename 1..54> / <c-string 1..512 with-low> / *LIBRARY-ELEMENT(...) *LIBRARY-ELEMENT(...) LIBRARY = *NOT-SPECIFIED / <c-string 1..63 with-low> ,ELEMENT = *NOT-SPECIFIED / <c-string 1..64 with-low>(...) <c-string 1..64 with-low>(...) VERSION = *NONE / *STD / <c-string 1..24 with-low> ,TYPE = *NONE / *NOT-SPECIFIED / <c-string 1..8 with-low> ,PASSWORD = *NONE / <c-string 1..64 with-low> / <x-string 1..128> / *SECRET ,TRANSFER-ADMISSION = *NONE / <alphanum-name 8..32> / <x-string 15..64> / <c-string 8..32 with-low> / *SECRET / *PARAMETERS(...) *PARAMETERS(...) USER-IDENTIFICATION = <c-string 1..67 with-low> ,ACCOUNT = *NONE / <c-string 1..64 with-low> ,PASSWORD = *NONE / <c-string 1..64 with-low> / <x-string 1..128 with-low> / *SECRET ,PROCESSING-ADMISSION = *SAME / *NONE / *PARAMETERS(...) *PARAMETERS(...) USER-IDENTIFICATION = <c-string 1..67 with-low> ,ACCOUNT = *NONE / <c-string 1..64 with-low> ,PASSWORD = *NONE / <c-string 1..64 with-low> / <x-string 1..128 with-low> / *SECRET ,SUCCESS-PROCESSING = *NONE /<c-string 1..1000 with-low> ,FAILURE-PROCESSING = *NONE / <c-string 1..1000 with-low> ,FILE-AVAILABILITY = *BY-RECEIVING-SYSTEM / *IMMEDIATE / *DEFERRED ,STORAGE-ACCOUNT = *NONE / <c-string 1..40 with-low> / <text 1..40> ,ACCESS-MODE = *BY-RECEIVING-SYSTEM / *PARAMETERS(...) *PARAMETERS(...) READ-FILE = *NO / *YES ,INSERT-DATA-UNIT = *NO / *YES ,REPLACE-FILE = *NO / *YES ,EXTEND-FILE = *NO / *YES ,ERASE-DATA-UNIT = *NO / *YES ,READ-ATTRIBUTES = *NO / *YES ,CHANGE-ATTRIBUTES = *NO / *YES ,DELETE-FILE = *NO / *YES ,LEGAL-QUALIFICATION = *NONE / <c-string 1..80 with-low> / <text 1..80> ,CREATE-PASSWORD = *NONE / <c-string 1..64 with-low> / <x-string 1..128> / *SECRET ,CODED-CHARACTER-SET = *STD / <name 1..8> ,COMPRESS = *NONE / *BYTE-REPETITION / *ZIP ,WRITE-MODE = *REPLACE -FILE / *NEW-FILE / *EXTEND-FILE ,DATA-TYPE = *NOT-SPECIFIED / *CHARACTER (...) / *BINARY (...) / *USER *CHARACTER(...) TRANSPARENT = *NO / *YES *BINARY(...) TRANSPARENT = *NO / *YES ,DATA-ENCRYPTION = *NO / *YES / *ONLY-DATA-INTEGRITY ,RECORD-SIZE = *NOT-SPECIFIED /<integer 1..32756> ,RECORD-FORMAT = *STD / *FIXED / *VARIABLE / *UNDEFINED ,TARGET-FILE-FORMAT = *SAME / *BLOCK-ORIENTED / *SEQUENTIAL(...) *SEQUENTIAL(...) RECORD-FORMAT = *SAME / *UNDEFINED ,PROTECTION = *STD / *SAME ,FILE-NAME-ENCODING = *TRANSPARENT / *CHARACTER ,LAST-CHANGE-DATE = *STD / *SAME |
Operands
The meaning of the operands is the same as for asynchronous file transfer, see the operand description for TRANSFER-FILE.
Example
The POSIX file file.posix is to be transferred to the remote Unix system PUX. Here, it is to be stored in the directory dir (subdirectory of the HOME directory) under the transfer admission ForUXSys. ZIP compression is to be used for transfer.
|
FTSCOPY TO,PUX,('./file.posix'),*a('dir/file.ux',,'ForUXSys'),*ZIP