Note on usage
Function: Modify the FTAM attributes of a local file
User group: FT user
Functional description
This command is above all useful in connection with FTAM partners.
For openFT partners, files of type binary-fixed can be provided (see also example 2). The attributes file type, record format and record length are also evaluated when sending a file to openFT partners, but are not set when creating the receive file.
With ftmodf, you can modify the FTAM attributes of a file in the local system for a file transfer or file management request involving an FTAM partner. You can also delete the information in the FTAM catalog without deleting the file itself.
The following attributes can be defined:
File type
Character set
Record format
Record length
FTAM access rights for a file that cannot be changed by the FTAM partner (permitted actions).
File attributes for 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 occur, with the result that data transfer requests to the affected files are terminated. Consult the table that describes the operands.
Note that you cannot use ftmodf to negate file attributes on the local system. This means that a file can be deleted by means of operating-system resources (e.g. command rm on Unix systems or erase on Windows systems) even if the permitted actions do not permit deletion by an FTAM partner.
Format
ftmodf -h |
<file name 1..512> -np=@d |
<file name 1..512>
[ -ft=t | -ft=b ]
[ -cs=g | -cs=c | -cs=i | -cs=v ]
[ -rf=v | -rf=f | -rf=u ]
[ -rl=<1..65535> ]
[ -pa=[n][r][i][p][x][e][a][c][d] ]
[ -np=<file access password 1..11> | -np=@n ]
Description
-h
Displays the command syntax on the screen. Entries after the -h are ignored.
file name -np=@d
Deletes all the information on the specified file in the FTAM catalog without deleting the file itself. -np=@d should not be specified together with other parameters, as these then have no effect.
file name
file name without -np=@d indicates the file in the local system whose attributes are to be modified. The file name can be either absolute or relative.
-ft=t | -ft=b
This identifies the type of file in the local system. You can enter either t or b.
t
The file contains text data.
b
The file contains binary data.
-ft not specified
The previous file type remains unchanged.
-cs=g | -cs=c | -cs=i | -cs=v
This can only be used in conjunction with the t (text) file type, and describes the character set for the text file, see also universal class number in manual "openFT (Unix and Windows systems) - Installation and Operation". This attribute only has any point in the case of FTAM partners.
g
GraphicString
The file can contain characters from the G0 set defined in ISO646 or ISO8859-1, or from the G1 set defined in ISO8859-1.
c
GeneralString
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. In the case of transfer with FTAM partners, each set is terminated with a CRLF (Carriage Return Line Feed); in this case, set boundaries do not necessarily correspond to the transfer unit boundaries.
i
IA5String
The file can contain characters from the C0 set and the G0 set defined in ISO646.
In the case of transfer with FTAM partners, each set is terminated with a CRLF (Carriage Return Line Feed); in this case, set boundaries do not necessarily correspond to the transfer unit boundaries.
v
VisibleString
The file can contain characters from the G0 set defined in ISO646.
-cs not specified
The previous character set remains unchanged.
-rf=v | -rf=f | -rf=u
This indicates the record format of the data to be transferred to a partner.
v (variable)
The data is transferred to a partner in records of variable length. Please note that, in the case of FTAM partners, in accordance with the A/111 profile, only text data from the GraphicString or VisibleString character sets can be transferred in this way. Binary files in a user format (where a record comprises a record length field and the data) can only be transferred to an FTAM partner in records of variable length, if the FTAM partner supports the userformat.
f (fix)
The data is transferred to an partner in records of equal length. Please note that, in the case of FTAM partners, in accordance with the A/111 profile, only text data from the GraphicString or VisibleString character sets can be transferred in this way.
Binary files of fixed record length (the file is made up of records of identical length) can only be transferred to an FTAM partner if the partner supports this fixed length for binary files.
u (undefined)
The record length used to transfer the data is not mapped to the real system. This means that the record length used for the transfer is not identical to that in the real file.
Binary files are stored in a bit string in the real system. Please note that in accordance with the A/111 profile, it is only possible to transfer text data from the GeneralString or IA5String character sets, or binary data with this record format. Any record structure present in text files is also lost unless maintained using other mechanisms (e.g. CRLF line separation for the transfer of IA5 or GeneralString files with FTAM).
-rf not specified
The previous record format remains unchanged.
-rl=record length
Defines the record length in bytes with which the data is to be transferred to an FTAM partner. The maximum record length is 65535 bytes.
-rl not specified
The previous record length remains unchanged.
-pa=[n][r][i][p][x][e][a][c][d]
Defines the "permitted actions" and how an FTAM partner can access a local file. This parameter does not affect the access rights of a file in a local system but instead places additional constraints on the access possibilities for FTAM partners.
The following values can be specified for the permitted actions parameter:
n, r, i, p, x, e, a, c, d, or any combination of these values:
n
means that an FTAM partner cannot access this file. If n is specified, all other options are ignored.
r
means that an FTAM partner can read the file.
r not specified
The file cannot be read.
i
with FTAM partners means that the FTAM partner can insert data units, such as records, in the file.
i not specified
No data units can be inserted in the file.
p
means that an FTAM partner can overwrite the file.
p not specified
The file cannot be overwritten.
x
means that an FTAM partner can append data to the file.
x not specified
The file cannot be extended.
e
with FTAM partners means that the FTAM partner can delete data units, such as records, from the file.
e not specified
No data units can be deleted from the file.
a
means that an FTAM partner can read the attributes of the file.
a not specified
The file attributes cannot be read.
c
means that an FTAM partner can change the attributes of the file.
c not specified
The file attributes cannot be changed.
d
means that an FTAM partner can delete the file.
d not specified
The file cannot be deleted.
-pa not specified
The access rights remain unchanged.
-np=file access password | -np=@n
This parameter is reserved for special customer applications.
For file type, character set, and record format, you should select combinations that correspond to the file contents:
Entries for | -ft= | -cs= | -rf= |
Text files | t | g | f |
t | g | v | |
t | v | f | |
t | v | v | |
t | c | u | |
t | i | u | |
Structured binary files | b | No entry | v |
Unstructured binary files | b | No entry | u |
Binary files with fixed recorsd length | b | No entry | f |
Otherwise, file inconsistencies may occur. File access errors are also possible if the record format is set to f, but no record length is specified or the file size is not a multiple of the record length.
Examples
FTAM partners:
You wish to reset the access rights of the local file junk such that no FTAM partner can access the file.
ftmodf junk -pa=nopenFT partners
The combination of -ft=b and -rf=f is also significant for file transfer with the openFT protocol. In this way, a BS2000 partner, for example, can fetch a file containing binary data from a Unix or Windows system and store it in BS2000 as a SAM file. To do this, the following entries are required in the Unix or Windows system and BS2000 systems.
Unix or Windows system ftclient:
ftmodf binfix06 -ft=b -rf=f -rl=14156BS2000:
ncopy from,ftclient,(binfix06,l=*n), -*a('binfix.06',,'binfixprofile'),data=*bin