These members contain the installation-specific texts issued by openFT as a result of successful or unsuccessful file transfer to one or several consoles.
These members are evaluated only if a valid specification has been made for the SUCC_MSG or FAIL_MSG keyword in the FTMSPPAR member and if ENDMSG_ROUTCDE=1 has been set.
If the FTMSPPAR member contains valid specifications for SUCC_MSG or FAIL_MSG, and the members SUCCMSG and FAILMSG exist but are empty, no message is output.
The following rules apply to the installation-specific message texts:
The text must begin and end with single quotes. These characters are not output but form part of the syntax.
After replacement of the variables (see below), the text may be up to 102 characters long, including the single quotes in which it is enclosed.
Like all other members of the FT parameter library, the members containing the message texts may not contain line numbering.
Violation of these rules results in an error. At worst, either no message is output at all or a message is issued to all TSO terminals currently active.
Like the members PRTJOB, JCLJOB and TSOJOB, the message texts can contain variables which openFT replaces with the current values.
The following variables may be used in message texts:
FILX
Name of the send or receive file as specified in the NCOPY command for the system involved. Maximum 58 characters in accordance with IBM conventions.
When replacing this variable with the current value, openFT duplicates single quotes enclosing fully qualified file names, thus satisfying the syntax rule "If a single quote occurs in the message itself, it must be duplicated". (Single quotes are not duplicated in the message itself.) The maximum length of 58 characters for this parameter is formed as follows: 44 characters (maximum length of a fully qualified file name, not including the single quotes which enclose it) + 8 characters (maximum length of a member name) + 2 characters (parentheses enclosing the member name) + 4 (2 x 2 single quotes).
PNAM
Symbolic name of the remote system. Maximum 8 characters in accordance with openFT conventions.
If there is no symbolic partner name for this request, the first 8 characters of the partner address are output.
SUBM
specifies the system in which the FT request was submitted. Maximum 6 characters. openFT replaces this variable with the following character strings:
LOCAL | if the request was submitted in the local system, |
REMOTE | if the request was submitted in a remote system. |
USID
User ID from TRANSFER-ADMISSION.
Maximum 7 characters in accordance with IBM conventions.
ACCX
"accounting information" from the TRANSFER-ADMISSION.
Maximum 42 characters in accordance with IBM conventions.
When replacing this variable with the current value, openFT duplicates single quotes that can enclose "accounting information" (see section "Access authorization" in the manual "openFT (z/OS) - Command Interface"). This satisfies the syntax rule "If there is a quote, use double quotes" (only single quotes appear in the message itself).
The maximum length of 42 characters for this parameter is formed as follows: 40 characters for the "accounting information" + 2 additional quotes.
OWID
Owner of the FT request (user ID under which the FT request was submitted).
Maximum 7 characters in accordance with IBM conventions. This variable is replaced with a valid value only for FT requests which were submitted in the local system. This variable is eliminated for FT requests submitted in a remote system.
PGRX
The programmer's name as specified as a command prefix with the key PGRN= in the relevant command string for follow-up processing; i.e. in the member SUCCMSG, the value is taken from the command string in the parameter SUCCESS-PROCESSING, in the member FAILMSG it is taken from the command string in the parameter FAILURE-PROCESSING. For further details refer to the manual "openFT (z/OS) - Command Interface". Up to 20 characters, according to IBM conventions, plus the number of apostrophes possibly enclosing or contained in the current value.
When replacing the variable by the current value, openFT doubles the number of apostrophes that can enclose or be contained in a programmer's name. This fulfills the syntax rule "If an apostrophe occurs in a message, then double it". (Only single apostrophes appear in the message itself.)
This is also why the length of the field has to be increased by the number of apostrophes possibly enclosing or contained in the current value.
TRID
FT transfer identification. Maximum 10 characters (value range 1..2147483639) in accordance with openFT conventions.
The name of this variable must be given the prefix "%" or - for reasons of compatibility with predecessor versions - „&".
As many "#" fill characters as necessary should be appended to the names of these variables so that the field length reaches the maximum length (including the "&", for example &PNAM###). If openFT replaces the variables with the current values, it does not exceed the field length defined by the name of the variables including the fill characters; if necessary, the current values are truncated. Syntax errors caused by truncation can also lead to a misfunction.
In the opposite direction, openFT removes superfluous fill characters from current values that are shorter than these field lengths.
Example of the member SUCCMSG
(The FAILMSG member must have the same structure)
'DATASET &FILX####.....#### TRANSFERRED
TO/FROM &PNAM###.'
The field &FILX####.....#### for the file name should have a total length of 58 characters. The first line of the member is 80 characters long (including the single quote at the start); the rest of the message (including the single quote at the end) is located on the second line. The total length of the message (maximum 98 characters including the single quotes) does not exceed the maximum permitted value of 102 characters.
If the NCOPY command was entered as follows:
NCOPY TRANS=TO,
PARTNER=SYS1,
LOC=(FILE='USER1.ABC',TRANS=(USER2,ACC2,PASS2)),
REM=...
then the following message is issued in this example after successful file transfer:
DATASET 'USER1.ABC' TRANSFERRED TO/FROM SYS1. CN(00)