Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

SHOW-REMOTE-FILE-ATTRIBUTES

&pagelevel(3)&pagelevel

Note on usage

Function: Display remote file attributes

User group: FT user

Alias name: FTSHW

Functional description

With the SHOW-REMOTE-FILE-ATTRIBUTES command, you can display the appropriate file or files in a directory on a remote partner system.

There are three options for displaying attributes:

  • List the name(s) of the file(s) in a directory

  • Display a default selection of attributes returned by the partner system

  • Display all attributes of a file or files in a directory, as returned by the partner system on request.

Format

SHOW-REMOTE-FILE-ATTRIBUTES / FTSHW

PARTNER = <text 1..200 with-low>

,FILE = *NOT-SPECIFIED / <filename 1..54> / <c-string 1..512 with-low> / *DIRECTORY(...)

*DIRECTORY(...)

NAME = *NOT-SPECIFIED / <c-string 1..512 with-low> / <partial-filename 2..53>

,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

,INFORMATION = *STD / *ALL-ATTRIBUTES / *NAMES-ONLY

,OUTPUT = *SYSOUT (...) / *SYSLST(...)

*SYSOUT (...) / *SYSLST(...)

LAYOUT = *STD / *CSV

,FILE-ATTR-ENCRYPTION = *NO / *YES

,FILE-NAME-ENCODING = *TRANSPARENT / *CHARACTER

Operands

PARTNER = <text 1..200 with-low>

Name of the partner system as defined by the FT administrator in the partner list or the address of the partner system. 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. The file name 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 an unaccessible Public Volume Set, the request is rejected with the error message FTR2202.

FILE = *DIRECTORY(...)
Name of the directory.

NAME =
Name of the directory in the remote FT partner system.

NAME = *NOT-SPECIFIED
The name of the directory is known to the remote system because it has already been completely defined in the addressed FTAC admission profile, for instance.

NAME = <c-string 1..512 with-low> / <partial-filename 2..53>
Name of the directory in the remote FT partner system. The directory name must be specified in the syntax of the remote system and must conform to the conventions of the remote system
If the remote system is a BS2000 or z/OS system, you can specify a partially qualified file name, e.g. HUGO. All file names addressed by the partial qualification (e.g.
HUGO.MAIER, HUGO.MULLER) are output.

If the partner is a BS2000 system and the file name is the name of a file generation group then the request is rejected with message FTR2148:

Remote system: Transfer of file generation groups not supported

PASSWORD =
Password that allows the user to access the file attributes in the remote system. If the file in the remote system is protected by a password, the password must be specified in the operands required to read file attributes in the remote system. If the remote system is a Windows or Unix system, no password is required.

PASSWORD = *NONE
Access is possible without a password.

PASSWORD = <integer -2147483648..2147483647> / <c-string 1..64 with-low> / <x-string 1..128>
Password that allows the user to access the file in the remote system. The password must be specified in the syntax of the remote system and must 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 =
Transfer admission in the remote system for the file management request.

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 FT profile if FTAC functionality has been installed on 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(...)
Identification, account number and 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..64 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 of 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 =
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>
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 must 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.

INFORMATION =
Amount of information required. The amount of information is also dependent on the amount of information supplied by the partner. Therefore, only some attributes may be displayed, even if you requested full information.

INFORMATION = *STD
The default range of information is output.

INFORMATION = *ALL-ATTRIBUTES

All available information is requested on the file in the partner system. However, only attribute values returned by the partner system can be displayed.

INFORMATION = *NAMES-ONLY
Only the names of the directory files or the name of the file is listed.

OUTPUT =
Output medium.

OUTPUT = *SYSOUT (...)
Output is send to SYSOUT.

OUTPUT = *SYSLST(...)
Output is send to SYSLST.

LAYOUT = *STD
Output is put into a user-friendly form for reading.

LAYOUT = *CSV
Output is in Character Separated Values format. This is a special, tabular format, widely used in the PC world, in which the individual fields are separated by a semicolon “;” (see section “SHOW-FILE-TRANSFER”).

FILE-ATTR-ENCRYPTION =
Determines whether or not the file(s) and/or directory list attributes are to be encrypted during the transfer.

FILE-ATTR-ENCRYPTION = *NO
The file(s) and/or directory list attributes are not encrypted during transfer.

FILE-ATTR-ENCRYPTION = *YES
The file(s) and/or directory list attributes are encrypted during transfer. If encryption is not available in the local system, the request is rejected with the error message FTR2111. If the partner system does not permit encryption, the request is rejected with the error message FTR2113.

FILE-NAME-ENCODING =

Specifies the encoding mode for the remote file names and directory names.

FILE-NAME-ENCODING = *TRANSPARENT

Specification of the remote file name and directory name in transparent mode (compatible to the previous versions).
The file names of the partner system to be displayed are shown as before in older openFT versions. File names in Unix directories are interpreted here on a byte-by-byte basis as ISO8859-1 characters.

FILE-NAME-ENCODING = *CHARACTER

Specification of the remote file name and directory name in character mode. I.e., the file and directory name and the file names of the partner system to be displayed 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.

If the encoding mode on a Unix partner is set to UTF-8 via operating parameter (ftmodo -fnccs=utf8), file names that do not correspond to UTF-8 coding are omitted. The file names of the partner system to be displayed are then converted from this character code to the transfer code UTF-8 and then to the output character code. File names that cannot be represented in the appropriate output character code are suppressed.

FILE-NAME-ENCODING=*CHARACTER is only permitted for openFT partners as of openFT V12.1.

Command return codes

(SC2)

SC1

Maincode

Meaning

0

130

FTR0108

Request rejected. Remote system not accessible.

33

32

CMD0221

Request rejected. Internal error.

36

32

CMD0221

Request rejected. Request data inconsistent.

83

32

CMD0221

Internal error.

37

64

FTR2037

File is read only.

43

64

FTR2043

Access denied.

120

64

FTR2120

Remote system unknown in the local system.

123

64

FTR2123

Request rejected. OSS call error. The command was not
executed because the session instance detected a
communication error.

148

64

FTR2148

Request rejected. Remote system: Transfer of file generation
groups not supported.

152

64

FTR2152

Request rejected. Remote system: No file name specified.

153

64

FTR2153

Request rejected. Remote system: Invalid management
password.

155

64

FTR2155

Request rejected. Remote system: File not found.

169

64

FTR2169

Request rejected. Remote system: Transfer admission
invalid. Transfer admission incorrect or insufficient FTAC
authorizations.

170

64

FTR2170

Request rejected. Remote system: Function not supported.

SC1/2 = Subcodes 1/2 in decimal notation
For additional information, see section “Command return codes”.

OPS variables

The following table shows the OPS variables for the command SHOW-REMOTE-FILE-ATTRIBUTES with the operand INF=*ALL-ATTRIBUTES, the underlined values are only valid for the output with the operand INF=*STD. For the operand input INF=*NAMES-ONLY only the element F-NAME (string) will be output.

Element

Type

Output

F-NAME

String


STOR-ACCOUNT

String


CRE

Struct


.USER

String


.DATE

String

yyyy-mm-dd

.TIME

String

hh:mm:ss

MODIFY

Struct


.USER

String


.DATE

String

yyyy-mm-dd

.TIME

String

hh:mm:ss

READ

Struct


.USER

String


.DATE

String

yyyy-mm-dd

.TIME

String

hh:mm:ss

MOD-ATTR

Struct


.USER

String


.DATE

String

yyyy-mm-dd

.TIME

String

hh:mm:ss

DATA-TYPE

String

*CHAR / *BINARY / *DIR / *NO-INFO

CHAR-SET 1

String

*GRAPHIC / *GENERAL / *IA5 / *VISIBLE

REC-FORM

String

*VAR / *FIXED / *UNDEF

REC-SIZE

Integer


F-AVAIL

String

*IMMED / *DEFERRED

ACCESS-RIGHTS

Struct


.READ-F

String

*YES / *NO

.INS-DATA-UNIT

String

*YES / *NO

.REPLACE-F

String

*YES / *NO

.EXTEND-F

String

*YES / *NO

.ERASE-DATA-UNIT

String

*YES / *NO

.READ-ATTR

String

*YES / *NO

.MOD-ATTR

String

*YES / *NO

.DEL-F

String

*YES / *NO

.TRAVERSAL

String

*YES / *NO

.REV-TRAVERSAL

String

*YES / *NO

.RANDOM

String

*YES / *NO

F-SIZE

Integer


MAX-F-SIZE

Integer


LEGAL-QUALIFICATION

String


CCS-NAME

String

Value

1The element CHAR-SET is only assigned if DATA-TYPE=*CHAR.
Powered by Atlassian Confluence and Scroll Viewport.