Note on usage
Function: Modify remote file attributes
User group: FT user
Alias name: FTMOD
Functional description
The MODIFY-REMOTE-FILE-ATTRIBUTES command is used to modify the attributes of a file in an FT partner system.
Depending on the partner involved, the following file attributes can be modified:
openFT partners:
File name
Access rights
FTAM partners:
File name
Availability of the file
Account number for file storage costs
Future file size
Access rights
Legal qualifications related to the use of a file
FTP partners:
File name
Format
MODIFY-REMOTE-FILE-ATTRIBUTES / FTMOD |
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 ,NEW-NAME = *SAME / <filename 1..54> / <c-string 1..512 with-low> ,FILE-AVAILABILITY = *UNCHANGED / *IMMEDIATE / *DEFERRED ,STORAGE-ACCOUNT = *UNCHANGED / <c-string 1..40 with-low> / <text 1..40> ,FUTURE-FILE-SIZE = *UNCHANGED / <integer 1..2147483647> ,ACCESS-MODE = *UNCHANGED / *READ-ONLY / *READ-WRITE / *REPLACE-ALL-BY(...) / *ADD(...) *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 *ADD(...) 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 / <c-string 1..80 with-low> / <text 1..80> ,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..54> / <c-string 1..512 with-low>
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 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 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.
PASSWORD = *SECRET
The system prompts you to enter the password. However, the input is not displayed on the screen.
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 = *SECRET
The system prompts you to enter the transfer admission. However, the input is not displayed on the screen.
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.
PASSWORD = *SECRET
The system prompts you to enter the password. However, the input is not displayed on the screen.
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 =
Provides information on the availability of a file in an FTAM partner system. This operand has two possible values: file available immediately or file not available immediately. File not available immediately, for example could refer to a file stored in an archive. However, the partner can freely interpret not available immediately. That is why the conventions of the FTAM partner must be observed in this case.
FILE-AVAILABILITY = *UNCHANGED
The previous file availability remains unchanged.
FILE-AVAILABILITY = *IMMEDIATE
In a remote system, the file attribute is assigned the value available immediately.
In the case of requests with openFT and FTAM partners that do not support the storage group, the request is rejected.
FILE-AVAILABILITY = *DEFERRED
In a remote system, the file attribute is assigned the value not available immediately. The file can then be stored in the partner system.
Requests involving openFT or FTAM partners that do not support the storage group or this attribute are rejected.
STORAGE-ACCOUNT =
Account number for file storage.
STORAGE-ACCOUNT = *UNCHANGED
The previous account number remains unchanged.
STORAGE-ACCOUNT = <c-string 1..40 with-low> / <text 1..40>
Identifies as storage account for the FTAM partner. The file storage costs are debited to this account, insofar as the partner system supports this function. This operand must conform to the conventions of the partner system.
Requests involving openFT or FTAM partners that do not support the storage group or this attribute are rejected.
FUTURE-FILE-SIZE =
Required future file size.
FUTURE-FILE-SIZE = *UNCHANGED
The previous file size remains unchanged.
FUTURE-FILE-SIZE = <integer 1..2147483647>
Provides FTAM partners with information on the possible future file size. This information acts as a guideline for a system specific optimization.
Requests involving openFT or FTAM partners that do not support the storage group or this attribute are rejected.
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.
With FTAM partners, the access rights that are to be replaced must not be linked with any further specifications, such as, for example a file password.
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.
ACCESS-MODE = *ADD(...)
In the case of FTAM partners, the file receives an additional set of access rights. This entry is only relevant for FTAM partners that support more than one set of 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 =
Legal qualifications.
LEGAL-QUALIFICATION = *UNCHANGED
The previous legal qualifications remain unchanged.
LEGAL-QUALIFICATION = <c-string 1..80 with-low> / <text 1..80>
In the case of FTAM partners, this defines a new legal qualification for a file (similar to a copyright). This must not exceed 80 characters.
Requests involving openFT and FTAM partners that do not support the security group or this attribute are rejected.
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.
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
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:
/MOD-REM-FI-ATT HUGO,MYFILE,,(JIM,A1234FT,'PWD'),,,,,*R-O