Note on usage
Function: Delete remote files
User group: FT user
Alias name: FTDEL
Functional description
The DELETE-REMOTE-FILE command can be used to delete a file in an FT partner system.
Format
DELETE-REMOTE-FILE / FTDEL |
PARTNER = <text 1..200 with-low> ,FILE = *NOT-SPECIFIED / <filename 1..54> / <c-string 1..512 with-low> ,PASSWORD = *NONE / <integer -2147483648..2147483647> / <c-string 1..64 with-low> / <x-string 1..128> / *SECRET ,TRANSFER-ADMISSION = *NONE / <alphanum-name 8..32> / <c-string 8..32 with-low> / <x-string 15..64> / *SECRET / *PARAMETERS(...) *PARAMETERS(...) USER-IDENTIFICATION = <name 1..8> / <c-string 1..67 with-low> ,ACCOUNT = *NONE / <c-string 1..64 with-low> / <text 1..64> ,PASSWORD = *NONE / <c-string 1..64 with-low> / <x-string 1..128> / <alphanum-name 1..19> / *SECRET ,FILE-NAME-ENCODING = *TRANSPARENT / *CHARACTER |
Operands
PARTNER = <text 1..200 with-low>
Name of the partner system as defined in the partner list by the FT administrator or the partner system address. For more information on address specifications, see section“Specifying partner addresses”.
FILE =
The name of the file in the remote FT partner system.
FILE = *NOT-SPECIFIED
The name of the file is known to the remote system because it has already been completely defined in the addressed FTAC admission profile, for instance.
FILE = <filename 1..54> / <c-string 1..512 with-low>
The name of the file in the remote system. The file name must be specified in the syntax of the remote system and must conform to the conventions of the remote system.
If the file name is specified with an unattached Public Volume Set (BS2000 systems), the request is rejected with the message FTR2155.
PASSWORD =
The password that provides access to the file in the remote system. If the file in the remote system is password-protected, the password required for deleting files in the remote system must be specified in these operands.
PASSWORD = *NONE
Access is possible without a password.
PASSWORD = <integer -2147483648..2147483647> / <c-string 1..64 with-low> / <x-string 1..128>
The password that provides access to the file in the remote system. The password must be specified in the syntax of the remote system and conform to the conventions of the remote system.
PASSWORD = *SECRET
The system requests you to enter the password. However, the input is not displayed on the screen.
TRANSFER-ADMISSION =
Contains specifications on transfer admission to the remote system for file management requests.
TRANSFER-ADMISSION = *NONE
The remote system does not require or recognize user authorization.
TRANSFER-ADMISSION =
<alphanum-name 8..32> / <c-string 8..32 with-low> / <x-string 15..64>
The transfer admission for the remote system can only be defined in an admission profile if the FTAC functionality is in use in the remote system. In this case, only the TRANSFER-ADMISSION defined in the FT profile is specified here. Uppercase alphanumeric input is converted internally to lowercase.
TRANSFER-ADMISSION = *SECRET
The system requests you to enter the transfer admission. However, the input is not displayed on the screen.
TRANSFER-ADMISSION = *PARAMETERS(...)
Specifies the ID, the account number, and the password of the user in the remote system. The operands in brackets can also be used as positional operands without their keywords.
USER-IDENTIFICATION = <name 1..8> / <c-string 1..67 with-low>
User ID in the remote system. The ID must be specified in the syntax of the remote system and must conform to the conventions of the remote system.
ACCOUNT = *NONE / <c-string 1..64 with-low> / <text 1..64>
Account number for the user in the remote system. The account number must be specified in the syntax of the remote system and must conform to the conventions of the remote system.
PASSWORD =
The password that allows the user to access the remote system.
PASSWORD = *NONE
Access is possible without a password.
PASSWORD = <c-string 1..64 with-low> / <x-string 1..128> /
<alphanum-name 1..19>
The password that allows the user to access the remote system. The password must be specified in the syntax of the remote system, must conform to the conventions of the remote system, and be recognized by the remote system.
PASSWORD = *SECRET
The system requests you to enter the password. The input is not displayed on the screen.
FILE-NAME-ENCODING =
Specifies the encoding mode for the remote file name.
FILE-NAME-ENCODING = *TRANSPARENT
Specification of the remote file name in transparent mode (compatible to the previous versions).
FILE-NAME-ENCODING = *CHARACTER
Specification of the remote file name in character mode. The name is interpreted according to the character code of the remote system, i.e. for Unix partners according to the openFT operating parameter option (ftmodo -fnccs) that has been set there.
FILE-NAME-ENCODING=*CHARACTER is only permitted for openFT partners as of openFT V12.1.
Command return codes
For a list of the possible return codes, see the table in chapter “Command return codes for file transfer and file management”.
Example
From your BS2000 system, you want to delete the file FILE which is stored in the partner system HUGO. FTAC is implemented in the remote system. The transfer admission DELETEACCESS must be specified to delete the file.
/DELETE-REMOTE-FILE PARTNER=HUGO,FILE-NAME=FILE, -
/ TRANSFER-ADMISSION=DELETEACCESS
Short form:
/DEL-REM-FI HUGO,FILE,,DELETEACCESS