MODIFY-FILE-FT-ATTRIBUTES

Note on usage

Function: Modify local FT file attributes

User group: FT user

Alias name: FTMODF

The command is only useful in conjunction with FTAM functionality.

Functional description

The MODIFY-FILE-FT-ATTRIBUTES command is used to modify the FTAM attributes of a file in a local system so that they are suitable for a file transfer request or file management request with an FTAM partner. Invalid combinations of attributes are rejected with the message FTR2018. Values can be assigned to the following attributes:

• file access rights for an FTAM partner that the FTAM partner cannot change (PERMITTED-ACTIONS)

• file type (DATA-TYPE)

• character set (CHARACTER-SET)

• record format (RECORD-FORMAT)

• record length (RECORD-SIZE)

File attributes file type, character set and record format may only be changed if you are aware of the file contents. If this is not the case, file inconsistencies may occur, with the result that data transfer requests to the affected file are terminated.

Please note that when you use MODIFY-FILE-FT-ATTRIBUTES, you do not negate the BS2000 file attributes. This means that you can still delete the file with BS2000 resources (e.g. ERASE-FILE), even if the PERMITTED-ACTIONS do not permit deletion for an FTAM partner.

Format

MODIFY-FILE-FT-ATTRIBUTES / FTMODF

FILE-NAME = <filename 1..54>

,PASSWORD = *NONE / <integer -2147483648..2147483647> / <c-string 1..4> / <x-string 1..8> / *SECRET

,PERMITTED-ACTIONS = *UNCHA NGED / *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

,TRANSFER-ATTRIBUTES = *UNCHA NGED / *PARAMETERS(...)

*PARAMETERS(...)

DATA-TYPE = *UNCHA NGED / *BINARY / *CHARACTER(...)

*CHARACTER(...)

CHARACTER-SET = *GRAPHIC / *GENERAL / *IA5 / *VISIBLE

,RECORD-FORMAT = *UNCHA NGED

,RECORD-SIZE = *UNCHA NGED / <integer 1..32767>

Operands

FILE-NAME = <filename 1..54>

File in the local system whose attributes are to be modified. These attributes only apply for partners who wish to transfer files with the use of FTAM functionality.
With regard to file transfer admission, the same rules apply as for the BS2000 MODIFY-FILE-ATTRIBUTES command.
If the file name is specified with unattached Public Volume Set, the request is rejected with the error message FTR0020.

PASSWORD =
Password authorizing the user to access the file in the local system. If the file in the local system is password-protected, the password must be specified in this operand unless you notified BS2000 of the password beforehand with ADD-PASSWORD. The password is required in BS2000 for modifying file attributes.

PASSWORD = *NONE
Access is possible without a password.

PASSWORD = <integer -2147483648..2147483647> / <c-string 1..4> / <x-string 1..8>

Password authorizing the user to access the file in the local system.

PASSWORD = *SECRET
The system prompts you to enter the password. However, the input is not displayed on the screen.

PERMITTED-ACTIONS =
The permitted file accesses. Defines how an FTAM partner can access a local file exclusively. The operand does not affect the access rights of a BS2000 file. It merely defines the access rights for a partner who wishes to access a file using FTAM protocols. The FTAM partner cannot modify this definition.

PERMITTED-ACTIONS = *UNCHANGED
The access rights remain unchanged.

PERMITTED-ACTIONS = *PARAMETERS(...)
Changes file access permissions.

READ-FILE = *NO / *YES
The file cannot or can be read.

INSERT-DATA-UNIT = *NO / *YES
Data units, such as records, cannot or can be inserted in the file.

REPLACE-FILE = *NO / *YES
The file cannot or can be overwritten.

EXTEND-FILE = *NO / *YES
The file cannot or can be extended.

ERASE-DATA-UNIT = *NO / *YES
Data units, such as records, cannot or can be deleted from the file.

READ-ATTRIBUTES = *NO / *YES
The file attributes cannot or can be read.

CHANGE-ATTRIBUTES = *NO / *YES
The file attributes cannot or can be changed.

DELETE-FILE = *NO / *YES
The file cannot or can be deleted.

TRANSFER-ATTRIBUTES =
Attributes used for file transfer.

TRANSFER-ATTRIBUTES = *UNCHANGED
The previous attributes remain unchanged.

TRANSFER-ATTRIBUTES = *PARAMETERS(...)

DATA-TYPE =

File type. Specifies whether the file is to be transferred as a text file or a binary file.

DATA-TYPE = *UNCHANGED
The previous file type remains unchanged.

DATA-TYPE = *BINARY
The file is to be transferred as a binary file.

DATA-TYPE = *CHARACTER(...)
The file is to be transferred as a text file.

CHARACTER-SET =
Character set for the text file.

CHARACTER-SET = *GRAPHIC
The file can contain characters from the GO set defined in ISO646 or ISO8859-1, or from the G1 defined in ISO8859-1.

CHARACTER-SET = *GENERAL
The file can contain characters from the C0 set defined in ISO646, the G0 set defined in ISO646 or ISO8859-1, or the G1 set defined in ISO8859-1.

CHARACTER-SET = *IA5
The file can contain characters from the C0 set and the G0 set defined in ISO646.

CHARACTER-SET = *VISIBLE
The file can contain characters from the G0 set defined in ISO646.

In the case of text files with CHARACTER-SET=*GRAPHIC or CHARACTER-SET=*VISIBLE, the data is transferred in the form of variable length records (for SAM-V files), or fixed length records (SAM-F files).

In the case of text files with CHARACTER-SET=*GENERAL or CHARACTER-SET=*IA5, every record is terminated with a CRLF (Carriage Return Line Feed) during file transfer. The transfer units do not necessarily correspond to the real records.

RECORD-FORMAT =
The format of the records in the file. This operand is intended for future extensions.

RECORD-FORMAT = *UNCHANGED
The previous record length remains unchanged.

RECORD-SIZE =
The length of the longest record in the file.

RECORD-SIZE = *UNCHANGED
The previous record format remains unchanged.

RECORD-SIZE = <integer 1..32767>

Record length in bytes with which the data is to be transferred to an FTAM partner. RECORD-SIZE defines the maximum length for transfer units for files with CHARACTER-SET=*IA5, CHARACTER-SET=*GENERAL as well as for SAM-U files.

For DATA-TYPE and CHARACTER-SET, you can only select the combinations that correspond to the file contents and the SAM record format of the file:

Entries for	in SAM record format	DATA-TYPE	CHARACTER- SET	RECORD-FORMAT, displayed in SHOW-FILE-FT-ATTR
Text files	F V F V V V	*CHARACTER *CHARACTER *CHARACTER *CHARACTER *CHARACTER *CHARACTER	*GRAPHIC *GRAPHIC *VISIBLE *VISIBLE *GENERAL *IA5	*FIXED *VARIABLE *FIXED *VARIABLE *UNDEFINED *UNDEFINED
Structured binary files	V	*BINARY	No entry	*VARIABLE
Unstructured binary files	U	*BINARY	No entry	*UNDEFINED

File access errors are also possible if the record length defined for a SAM-F file differs from that defined in the BS2000 catalog.

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 local file MYFILE, such that FTAM partners have only read access.

/MODIFY-FILE-FT-ATTRIBUTES FILE-NAME=MYFILE, -
/                          PERMITTED-ACTIONS=(READ-FILE=*YES, -
/                          READ-ATTRIBUTES=*YES,CHANGE-ATTRIBUTES=*NO)

Short form:

/MOD-FI-FT-AT MYFILE,,(Y,,,,,Y,N)