Note on usage
Function: Display log records and offline log files
User group: FT user, FT administrator and FTAC administrator
Alias name: FTSHWLOG
Functional description
With the SHOW-FT-LOGGING-RECORDS command, you can obtain information on all FT requests logged by openFT. An important prerequisite is that the FT administrator has switched on the FT logging function. The logging records are marked as FT or FTAC or ADM, enabling you to identify the type of logging record.
SHOW-FT-LOGGING-RECORDS also enables the name of the current log file and the names of the offline log files to be displayed.
FT logging
The FT user can view all log records which relate to his/her user ID. The FT administrator can display all the FT log records in the system.
If no options are specified, openFT outputs the most recent log record. When requested, openFT outputs all the log records which correspond to the selection criterion defined in the command.
Command execution may take several minutes, depending on the size of the log file! The output can be interrupted using the K2 key.
There are three types of output: short output and long output and CSV format.
FTAC logging
With FTAC functionality, SHOW-FT-LOGGING-RECORDS can be used to display the
FTAC log records. The FT user can view all FTAC log records, of which he/she is the owner. FT and FTAC administrators may view all FTAC log records.
If the access check was positive and openFT accepted the request, a second logging record is created in openFT, indicating whether the request was completed successfully, and if not, why it was terminated.
A precise description of output can be found starting in section “Description of the shortoutput of SHOW-FT-LOGGING-RECORDS”.
ADM logging
If your openFT instance is administered via a remote administration server or if you administer other instances yourself using EXECUTE-REMOTE-FTADM-CMD, ADM log records are written (assuming that the appropriate logging settings have been made). You can also view these log records.
Format
SHOW-FT-LOGGING-RECORDS / FTSHWLOG |
SELECT = *OWN / *ALL / *PARAMETERS(...) *PARAMETERS(...) LOGGING-ID = *ALL / <alphanum-name 1..12> / *INTERVAL(...) *INTERVAL(...) FROM = 1 / <alphanum-name 1..12> ,TO = *HIGHEST-EXISTING / <alphanum-name 1..12> ,OWNER-IDENTIFICATION = *OWN / *ALL / <name 1..8> ,CREATION-TIME = *INTERVAL (...) / *DAYS(...) *INTERVAL (...) FROM = 1970-01-01 (...) / <date 8..10>(...) <date 8..10>(...) TIME = 00:00 / <time 1..8> ,TO = *TOMOR ROW(...) / *TODAY(...) / <date 8..10>(...) <date 8..10>(...) TIME = 00:00 / <time 1..8> *DAYS(...) NUMBER = <integer 1..1000> ,RECORD-TYPE = *ALL / *PARAMETERS(...) *PARAMETERS(...) FT = *TRANS FER- F ILE / *NONE / list-poss(1): *TRANSFER-FILE ,FTAC = ( *TRANS FER -F ILE, *READ-FILE-ATTRIBUTES, *DEL ETE -FILE, *CRE ATE- FILE , *MOD IFY- FILE-ATTR IBUTES, *READ-DIRECTORY, *MOVE-FILE, *CREATE-DIRECTORY, *DELETE-DIRECTORY, *MODIFY-DIRECTORY. *LOGIN ) / *NONE / list-poss(11): *TRANSFER-FILE / *READ-FILE-ATTRIBUTES / *DELETE-FILE / *CREATE-FILE / *MODIFY-FILE-ATTRIBUTES / *READ-DIRECTORY / *MOVE-FILE / *CREATE-DIRECTORY / *DELETE-DIRECTORY / *MODIFY-DIRECTORY / *LOGIN ,ADM = *ADMIN ISTRATION / *NONE / list-poss(1): *ADMINISTRATION ,INITIATOR = ( *LOC AL, *REMOTE ) / list-poss(2): *LOCAL / *REMOTE ,PARTNER = *ALL / <text 1..200 with-low> ,FILE-NAME = *ALL / <filename 1..54> / <filename-prefix 2..53> / <c-string 1..512 with-low> / *DIRECTORY(...) / *POSIX(NAME=<posix-pathname 1..510>) *DIRECTORY(...) NAME = *ALL / <partial-filename 1..53> / <c-string 1..512 with-low> ,REASON-CODE = *ALL / *FAILURE / <text 1..4> ,ROUTING-INFO = *ALL / <text 1..200 with-low> ,TRANSFER-ID = *ALL / <integer 1.. 2147483647> ,GLOBAL-REQUEST-ID = *ALL / <alphanum-name 1..10> ,LOGGING-FILE = *CURR ENT / <filename 1..54> / *ACTIVE-AT(...) *ACTIVE-AT(...) DATE = <date 8..10> ,TIME = 00:00 / <time 1..8> ,PREVIOUS-FILES = *STD / <integer 0..3> ,NUMBER = 1 / *ALL / <integer 1..99999999> / *POLLING(...) *POLLING(...) INTERVAL = 1 / <integer 1..600> ,NUMBER = *UNLIMITED / <integer 1..3600> ,INFORMATION = *STD / *ALL / *LOGGING-FILES ,OUTPUT = *SYSOUT (...) / *SYSLST(...) *SYSOUT (...) / *SYSLST(...) LAYOUT = *STD / *CSV |
Operands
SELECT =
Selects a group of logging records.
SELECT = *OWN
Selects logging records under the user’s own login.
SELECT = *ALL
Displays all users’ logging records to the administrator. As user you receive only logging records of your own ID (same as *OWN).
SELECT = *PARAMETERS(...)
LOGGING-ID =
Number of the logging record.
LOGGING-ID = *ALL
The number of the logging record is not a selection criterion.
LOGGING-ID = <alphanum-name 1..12>
Number of the logging record to be output. The value range for the logging ID is from 1 through 999999999999.
LOGGING-ID = *INTERVAL(...)
Range of logging records to be output.
FROM = <alphanum-name 1..12>
First logging record to be output. The value range for the logging ID is from 1 through 999999999999.
TO = *HIGHEST-EXISTING / <alphanum-name 1..12>
Last logging record to be output. The value range for the logging ID is from 1 through 999999999999.
OWNER-IDENTIFICATION =
User ID whose logging records are to be displayed.
OWNER-IDENTIFICATION = *OWN
Logging records of your user ID are displayed.
OWNER-IDENTIFICATION = *ALL
The logging records of all user IDs are displayed. The FT or FTAC administrator can thus display the FT logging records of any user ID.
Normal FT users receive information only on the logging records of their own ID even if *ALL is specified.
OWNER-IDENTIFICATION = <name 1..8>
Any user ID whose logging records should be displayed.
FT users may only specify their own ID.
CREATION-TIME =
The range of the logging records to be output, selected by their date or time of creation.
CREATION-TIME = *INTERVAL(...)
The range is specified as a time interval using the date and/or time.
FROM = 1970-01-01 (...) / <date 8..10>(...)
Date in the format yyyy-mm-dd or yy-mm-dd, e.g. 2016-08-18 or 16-08-18 for
18 August, 2016. openFT then displays all logging records written after the
specified date and time.
TIME = 00:00 / <time 1..8>
Time for the day specified with CREATION-TIME. openFT displays all logging records written after the specified time. The time is entered in the format
hh:mm:ss, e.g. 14:30:10.
TO = *TOMORROW / *TODAY(...) / <date 8..10>(...)
Creation date up to which the log records are to be displayed.
TO = *TOMORROW
Outputs all log records which were created by the time of the command output.
TO = *TODAY
When CREATION-TIME is used to explicitly specify a time, all log records which were written up to this time are displayed. If no time was specified, openFT displays all log records which were written up to and including at midnight on the previous day.
TO=<date 8..10>(...)
Date in the format yyyy-mm-dd or yy-mm-dd, e.g. 2016-08-18 or 16-08-18 for
18 August, 2016. openFT then displays all logging records up to the specified time.
TIME = 00:00 / <time 1..8>
Time for the day specified with CREATION-TIME. openFT displays all logging records written up to the specified time. The time is entered in the format
hh:mm:ss, e.g. 14:30:10.
CREATION-TIME = *DAYS(NUMBER=<integer 1..1000>)
This field is specified in number of days. All logging records that were created in the last n calendar days, including today, are output.
RECORD-TYPE =
Type of logging record to be displayed.
RECORD-TYPE = *ALL
The record type is not a selection criterion.
RECORD-TYPE = *PARAMETERS(...)
Type of the logging record.
FT = *TRANSFER-FILE / *NONE / list-poss(1): *TRANSFER-FILE
Specifies whether or not the FT logging records are to be displayed.
FTAC =
( *TRANSFER-FILE, *READ-FILE-ATTRIBUTES, *DELETE-FILE,
*CREATE-FILE, *MODIFY-FILE-ATTRIBUTES, *READ-DIRECTORY,
*MOVE-FILE, *CREATE-DIRECTORY, *DELETE-DIRECTORY,
*MODIFY-DIRECTORY, *LOGIN ) / *NONE / list-poss(11): *TRANSFER-FILE / *READ-FILE-ATTRIBUTES / *DELETE-FILE / *CREATE-FILE /
*MODIFY-FILE-ATTRIBUTES / *READ-DIRECTORY / *MOVE-FILE /
*CREATE-DIRECTORY / *MODIFY-DIRECTORY / *DELETE-DIRECTORY / *LOGIN
Specifies whether or not FTAC logging records are to be displayed. If they are to be displayed, the FT function for which the FTAC logging records are to be displayed can also be specified. The following values are possible:
*TRANSFER-FILE
All logging records for the function “Transfer files” are displayed.
*READ-FILE-ATTRIBUTES
All logging records for the function “Read file attributes” are displayed.
*DELETE-FILE
All logging records for the function “Delete files” are displayed.
*CREATE-FILE
All logging records for the function “Create files” are displayed.
*MODIFY-FILE-ATTRIBUTES
All logging records for the function “Modify file attributes” are displayed.
*READ-DIRECTORY
All logging records for the function “Read file directory” are displayed.
*MOVE-FILE
All logging records for the function “Copy and delete files” are displayed.
*CREATE-DIRECTORY
All logging records for the function “Create directory” are displayed.
*DELETE-DIRECTORY
All logging records for the function “Delete directory” are displayed.
*MODIFY-DIRECTORY
All logging records for the function “Modify directory” are displayed.
*LOGIN
All logging records for the function “Inbound FTP access” are displayed. Log records of the type *LOGIN are only written in the case of an incorrect transfer admission.
ADM = *ADMINISTRATION / *NONE / list-poss(1): *ADMINISTRATION
Specifies whether ADM log records are output.
ADM = *ADMINISTRATION
ADM log records are output. For further details, refer to the manual "openFT (BS2000) - Installation and Operation".
ADM = *NONE
No ADM log records are output.
INITIATOR =
Logging records according to the initiator.
INITIATOR = ( *LOCAL,*REMOTE )
The initiator is not a selection criterion.
INITIATOR = *LOCAL
Only those logging records that belong to requests issued locally are displayed.
INITIATOR = *REMOTE
Only those logging records belonging to requests made from a remote system are displayed.
PARTNER =
The partner system.
PARTNER = *ALL
The partner system is not a selection criterion.
PARTNER = <text 1..200 with-low>
Name or address of the partner system for which the logging records are to be displayed. For more information on address specifications, see section “Specifyingpartner addresses”.
For the partner name, you can also use the wildcard symbols '*' (asterisk) and '?' (question mark). ’*’ stands for any string and ’?’ stands for any single character. The question mark may not, however, be in first place.
FILE-NAME =
File name.
FILE-NAME = *ALL
The file name is not a selection criterion.
FILE-NAME = <filename 1..54> / <c-string 1..512 with-low> /
*POSIX(NAME = <posix-pathname 1..510>)
Fully qualified name of the files for which you wish to view the logging records.
FILE-NAME = <filename-prefix 2..53>
Partially qualified name of the files for which you want to view the logging records.
FILE-NAME = *DIRECTORY(...)
Name of the directory.
*DIRECTORY(...)
Here you specify the directory in the same format as used on the partner computer in one of the openFT user commands CREATE-/MODIFY-/DELETE-REMOTE-DIR or SHOW-REMOTE-FILE-ATTRIBUTES.
NAME = *ALL
The directory is not a selection criterion
NAME = <partial-filename 1..53> / <c-string 1..512 with-low>
Name of the directory.
In BS2000, directories are represented by partially qualified file names in DVS.
REASON-CODE =
Selection by the reason code of the logging records.
REASON-CODE = *ALL
The reason code is not a selection criterion; all records are output.
REASON-CODE = *FAILURE
All logging records with error codes are output.
REASON-CODE = <text 1..4>
Logging records to be output by the error codes. Leading zeros can be omitted (e.g. 14 for FTR0014).
ROUTING-INFO = *ALL / <text 1..200 with-low>
Selects the ADM log records on the basis of the routing information. The routing information describes the administered instance in the case of remote administration requests issued locally.
ROUTING-INFO = *ALL
The routing information is not used as a selection criterion.
ROUTING-INFO = <text 1..200 with-low>
Routing information for which the ADM log records are to be output.
TRANSFER-ID =
Selection on the basis of the request ID.
TRANSFER-ID = *ALL
The request ID is not used as a selection criterion.
TRANSFER-ID = <integer 1..2147483647>
Only outputs log records for the specified request ID.
GLOBAL-REQUEST-ID = *ALL / <alphanum-name 1..10>
Selects the log records on the basis of the global request ID.
GLOBAL-REQUEST-ID = *ALL
The global request identification is not a search criterion.
GLOBAL-REQUEST-ID = <alphanum-name 1..10>
Outputs log records for the specified global request identification. The global request identification is relevant only for inbound requests of openFT and FTAM partners. It is assigned by the initiator of the request (transfer ID) and transferred to the local system.
LOGGING-FILE =
Selects the log file whose logging records or name are to be output. This means that you can also view offline log records.
LOGGING-FILE = *CURRENT
The current log file is selected.
LOGGING-FILE = <filename 1..54>
Specifies the name of the log file which is to be searched. If you specify a value > 0 in the PREVIOUS-FILES operand, further, older offline log files are also searched (if any exist).
LOGGING-FILE = *ACTIVE-AT(...)
Selects the log file using its creation time (local time). The log file which was created on or before the specified time is selected. If more than one log file matches the specified time, the most recent of these log files is selected. If you specify a value > 0 in the PREVIOUS-FILES operand, further, older offline log files are also searched (if any exist).
DATE = <date 8..10>
Creation date in the format yyyy-mm-dd or yy-mm-dd, e.g. 2017-01-31 or 17-01-31 for Januray 31, 2017.
TIME = 00:00 / <time 1..8>
Creation time on the date specified with DATE. You specify the time in the format hh:mm:ss, e.g. 14:30:10.
PREVIOUS-FILES =
Specifies the number of preceding offline log files that are to be selected in addition to the current file or the file specified with LOGGING-FILE.
PREVIOUS-FILES = *STD
The effect depends on the specification in the INFORMATION operand:
INFORMATION = *STD (default value) or *ALL: The current lo file or the log file specified with LOGGING-FILE is searched for log records.
INFORMATION = *LOGGING-FILES: The names of all log files are output (maximum of 1024).
PREVIOUS-FILES = <0..3>
Specifies the number of preceding offline log files (0 to 3) that are to be searched in addition to the current file or the file specified with LOGGING-FILE or whose names are to be output.
NUMBER =
Maximum number of log records or polling intervals for outputting log records.
NUMBER = 1 / <integer 1..99999999>
The maximum number of logging records that are to be displayed. The default value is 1.
NUMBER = *ALL
All logging records are displayed.
NUMBER = *POLLING(...)
Specifies that the output of log records will be repeated at regular intervals. You can define the polling interval and the number of repetitions. Irrespective of the specifications in INTERVAL and NUMBER, the most recent log record which exists is always output first.
INTERVAL = 1 / <integer 1...600>
Polling interval in seconds. On each repetition, all the new log records are filtered in accordance with the specified selection criteria and the detected records are output. By default the output is repeated every second.
NUMBER =
Number of repetitions.
NUMBER = *UNLIMITED
The output is repeated without restriction. You can, for example, cancel the output using key K2.
NUMBER = <integer 1..3600>
Specifies the number of repetitions.
LOGGING-FILE = <filename ..>
LOGGING-FILE = *ACTIVE-AT(...)
INFORMATION = *LOGGING-FILES
TRANSFER-ID = <integer 1..2147483647>
GLOBAL-REQUEST-ID = <alphanum-name 1..10>
LOGGING-ID = <alphanum-name 1..12> / *INTERVAL(...)
CREATION-TIME = *INTERVAL(...) / *DAYS(...)
PREVIOUS-FILES = <integer 0..3>
INFORMATION =
Scope of the requested information.
INFORMATION = *STD
The logging records are displayed in a standard format (see section “Description of theshort output of SHOW-FT-LOGGING-RECORDS”).
INFORMATION = *ALL
The logging records are displayed in a detailed format (see section “Description of the longoutput of SHOW-FT-LOGGING-RECORDS”).
INFORMATION = *LOGGING-FILES
Outputs only the names of the log file(s). INFORMATION = *LOGGING-FILES can only be combined with the following parameters:
LOGGING-FILE in SELECT=*PARAMETERS(...)
PREVIOUS-FILES in SELECT=*PARAMETERS(...)
OUTPUT
OUTPUT =
Output medium.
OUTPUT = *SYSOUT (...)
Output is sent to SYSOUT.
OUTPUT = *SYSLST(...)
Output is sent to SYSLST.
LAYOUT = *STD
Output is formatted using a standard layout that can be easily read by the user.
LAYOUT = *CSV
Output is supplied in CSV (Character Separated Values) format. This is a widely used tabular format, especially in the PC environment, in which individual fields are separated by a delimiter, which is usually a semicolon “;“ (see section “SHOW-FT-LOGGING-RECORDS”).
Command return codes
(SC2) | SC1 | Maincode | Meaning |
0 | 0 | CMD0001 | No log records available for the selection criteria. |
33 | 32 | CMD0221 | Request rejected. Internal error. |
36 | 32 | CMD0221 | Request rejected. Request data inconsistent. |
83 | 32 | CMD0221 | Internal error. |
88 | 32 | CMD0221 | Error during OPS generation. |
36 | 64 | FTR1036 | User not authorized for other user IDs. |
2 | 0 | FTR2225 | Information output cancelled. |
SC1/2 = Subcode 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-FT-LOGGING-RECORDS with the operand INF=*ALL. The underlined values are valid for the output with the operand INF=*STD. The output for INF = *LOGGING-FILES has its own format, see below.
Depending on the type of log record, not all elements are output.
Element | Type | Output |
LOG-ID | Integer | |
REASON-CODE 1 | Integer | |
LOG | Struct | |
.DATE | String | yyyy-mm-dd |
.TIME | String | hh:mm:ss |
INIT-USER-ID | String | USER-ID of request initiator / *REM |
INIT-TSN 2 | String | TSN of request initiator |
PARTNER-NAME | String | |
PARTNER-ADDRESS 3 | String | |
TRANS-DIRECT | String | *TO-PARTNER / *FROM-PARTNER / |
REC-TYPE | String | *FT / *FTAC |
FUNC | String | *TRANS-FILE / *READ-FILE-ATTR / *DEL-FILE / |
USER-ADMIS | String | |
WRITE-MODE | String | *REPL-FILE / *NEW-FILE / *EXT-FILE |
RESULT-PROCESS | String | *NONE / *STARTED / *NOT-STARTED |
START | Struct | |
.DATE | String | yyyy-mm-dd |
.TIME | String | hh:mm:ss |
TRANS-ID | Integer | |
STORE | Struct | |
.DATE | String | yyyy-mm-dd |
.TIME | String | hh:mm:ss |
BYTE-NUM | String / | *NONE / |
PRIVIL 4 | String | *NO / *YES |
PROF-NAME 3 | String | |
F-NAME | String | |
SEC | Struct | |
.PROT.ENC | String | *NO / *YES |
.PROT.INT-CHECK | String | *NO / *YES |
.USER-DATA.ENC | String | *NO / *YES |
.USER-DATA.INT-CHECK | String | *NO / *YES |
.LOC-AUTH | String | *NO / *YES |
.REM-AUTH | String | *NO / *YES |
.AUTH-LEV | Integer | 1 / 2 / empty |
RSA-KEY-LEN | Integer | |
SYMM-ENC-ALG | String | *DES / *AES |
PROTECTION 5 | String | *STD / *SAME |
ADMINISTRATOR-ID 6 | String | Value |
ADM-CMD 5 | String | Value |
ROUTING 5 | String | Value |
CHANGE-DATE | String | *STD / *SAME |
GLOBAL-REQ-ID | Integer | Global request identification / empty |
FNC-MODE | String | *CHAR / *TRANSPARENT |
FNCCS | String | CCS name |
F-REM-NAME7 | String | Remote filename |
1The reason code is always given in decimal form. To determine the meaning of FTAC logging records using the manual, the value must be converted to hexadecimal form.
2For INIT-USER-ID=*REM, INIT-TSN is not assigned.
3Only for inbound requests
4Only for REC-TYPE=*FTAC and specification of a profile.
5Only with FT log records, not with FTAC or ADM log records.
6Only for REC-TYPE = ADM
7Only for outbound requests and openFT version >= V12.1C10
When you specify the INF=*LOGGING-FILES operand, only the two elements below are output:
Element | Type | Output |
TIME-STAMP | String | yyyy-mm-dd hh:mm:ss |
FILE-NAME | String | Value |