Note on usage
Function: Modify remote file attributes
User group: FT user
Functional description
The FTMOD command is used to modify the attributes of a file in an FT partner system. This command does not allow directories (also no PO and PDSE datasets) to be modified.
Depending on the partner involved, the following file attributes can be modified:
openFT partners:
File name
Access rights
FTP partners:
File name
Format
FTMOD |
PARTNER = <text 1..200 with-low> ,FILE = *NOT-SPECIFIED / <filename 1..59> / <c-string 1..512 with-low> / <text 1..512> ,PASSWORD = *NONE / <integer -2147483648..2147483647> / <c-string 1..64 with-low> / <x-string 1..128> ,TRANSFER-ADMISSION = *NONE / <alphanum-name 8..32> / <c-string 8..32 with-low> / <x-string 15..64> / *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> ,NEW-NAME = *SAME / <filename 1..54> / <c-string 1..512 with-low> ,FILE-AVAILABILITY = *UNCHANGED ,STORAGE-ACCOUNT = *UNCHANGED ,FUTURE-FILE-SIZE = *UNCHANGED ,ACCESS-MODE = *UNCHANGED / *READ-ONLY / *READ-WRITE / *REPLACE-ALL-BY(...) *REPLACE-ALL-BY(...) 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 = *UNCHANGED ,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 =
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..59> / <c-string 1..512 with-low> / <text 1..512>
Name of the file in the remote system. It must be specified in the syntax of the remote system and conform to the conventions of the remote system.
If the file name is specified with unattached Public Volume Set, the request is rejected with the error message FTR2202.
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 modifying file attributes in remote systems 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 in the syntax of the remote system and conform to the conventions of the remote system.
TRANSFER-ADMISSION =
Contains the specifications for transfer admission to the remote system for file management requests.
TRANSFER-ADMISSION = *NONE
The remote system does not require or recognize any 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. The alphanumeric entry is converted internally to lowercase characters.
TRANSFER-ADMISSION = *PARAMETERS(...)
Specifies the identification, 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>
Identification of the user in the remote system. The identification 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 observe its conventions.
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.
NEW-NAME =
New name of the file in the remote FT partner system.
NEW-NAME = *SAME
The previous file name remains unchanged.
NEW-NAME = <filename 1..54> / <c-string 1..512 with-low>
The new name of the file in the remote system. The previous name is no longer valid. The file name must be specified in the syntax of the remote system and conform to the conventions of the remote system.
FILE-AVAILABILITY = *UNCHANGED
The previous file availability remains unchanged.
STORAGE-ACCOUNT = *UNCHANGED
The previous account number remains unchanged.
FUTURE-FILE-SIZE = *UNCHANGED
The previous file size remains unchanged.
ACCESS-MODE =
Permitted access methods.
ACCESS-MODE = *UNCHANGED
The previous access rights remain unchanged.
ACCESS-MODE = *READ-ONLY
Short form of the current access rights READ-FILE, READ-ATTRIBUTES and CHANGE-ATTRIBUTE, and thus simplifies input.
ACCESS-MODE = *READ-WRITE
Short form of the current access rights READ-FILE, REPLACE-FILE, EXTEND-FILE, READ-ATTRIBUTES, CHANGE-ATTRIBUTES, DELETE-FILE and ERASE-DATA, and thus simplifies input.
ACCESS-MODE = *REPLACE-ALL-BY(...)
The existing access rights of the file in the remote system are replaced by the specified access rights.
READ-FILE = *NO / *YES
The file cannot or can be read.
REPLACE-FILE = *NO / *YES
The file cannot or can be overwritten.
EXTEND-FILE = *NO / *YES
The file cannot or can be extended.
READ-ATTRIBUTES = *NO / *YES
The file attributes cannot or can be read.
CHANGE-ATTRIBUTES = *NO / *YES
The file attributes cannot or can be modified.
DELETE-FILE = *NO / *YES
The file cannot or can be deleted.
INSERT-DATA-UNIT = *NO / *YES
Data units, such as records, cannot or can be inserted in the file.
ERASE-DATA-UNIT = *NO / *YES
Data units, such as records, cannot or can be deleted from the file.
LEGAL-QUALIFICATION = *UNCHANGED
The previous legal qualifications remain unchanged.
FILE-NAME-ENCODING =
Specifies the encoding mode for the remote file names.
FILE-NAME-ENCODING = *TRANSPARENT
Specification of the remote file names in transparent mode (compatible to the previous versions).
FILE-NAME-ENCODING = *CHARACTER
Specification of the remote file names in character mode. The names are 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.
Example
You wish to reset the access rights of the remote file MYFILE from READ-WRITE to READ-ONLY. The file is stored in the BS2000 system HUGO under the user ID JIM, with the account number A1234FT and the password C’PWD’
|
Short form:
FTMOD HUGO,MYFILE,,(JIM,A1234FT,'PWD'),,,,,*R-O