LOCAL-PARAMETER = *PARAMETERS(...)
Specifications for the local system.
FILE-NAME =
Name of the file or the library in the local system (send file or receive file).
FILE-NAME = *NOT-SPECIFIED
The name of the file is known locally because it has already been completely defined in the FTAC admission profile addressed locally.
FILE-NAME = <filename 1..54> / <c-string 1..512 with-low> /
*POSIX(NAME = <posix-pathname 1..510>)
When sending, the name of the file or preprocessing command, or, when receiving, the name of the postprocessing command. The specifications differ for with and without pre- and postprocessing.
Specifications without pre- or postprocessing on FILE-NAME
At this point, you must specify the name of the (DVS/POSIX) file in the local system:
The DVS file name must be specified with a user ID ($userid.filename) if the file is not cataloged under the user ID for which the file transfer is being executed (see TRANSFER-ADMISSION operand). In this case, SHARE=YES must be set for the file.
If the file name is specified in the form $filename, openFT adds the system default user ID in BS2000 (usually $TSOS) to form $defaultuserid.filename.
openFT offers an option with which unique file names can be generated automatically in order to easily prevent conflict situations. This is achieved specifying the string %UNIQUE in the file name.
The POSIX file name can be specified relative to the HOME directory (entry: ./file) if the file is cataloged in the directory associated with the user ID for which the file transfer is being performed (see also the TRANSFER-ADMISSION operand). If the file for which the file transfer is being executed is not cataloged in the directory of the user ID, the POSIX file name must be entered with the full pathname (entry: /file).
Specifications with pre- or postprocessing on FILE-NAME
If you specify a preprocessing command when sending, the output from the preprocessing command is sent to the standard output (SYSLST) before being transferred. You can also address the output from the preprocessing command via the %TEMPFILE variable. The advantage of this is that the output can have any file format and the file is transferred in this format. If you do not specify %TEMPFILE then the output must take the form of a SAM-V file. Since the file attributes are not known at the time the request is accepted, you should note the following if using %TEMPFILE:
either the future file attributes must be specified as request attributes,
or the file must be transferred in transparent format (homogeneous).
If you specify a postprocessing command when receiving, the received file is used as input for the postprocessing command. This file can be addressed using the variable %TEMPFILE. If %TEMPFILE is not specified, then read-in is done via SYSDTA. In this case, the file must be a SAM-V or ISAM-V file.
For both pre- and postprocessing, a c-string must be specified on FILE-NAME. The first character must be a pipe symbol ‘|’, followed by the command string. If several commands are specified, they must be separated by a semicolon (‘;’). If the pre/postprocessing is running in BS2000, a slash ‘/’ must be placed in front of each individual command. There must not be any blanks between the semicolon and the slash.
Example
FILE-NAME=C‘| / Command1; / Command2; / Command3; ...‘
The total maximum length of commands is restricted to the maximum file name length. For more information refer to the section “Preprocessing and postprocessing”. Also refer to the topic “Preprocessing” at the example in section “Examples of the TRANSFER-FILE command”.
If an error occurs during command execution (in BS2000/JOB-STEP), transfer is aborted with message FTR2083 or FTR2084.
If a transfer request with preprocessing and postprocessing is to be restartable, the characters ‘|&’ must be specified instead of ‘|’. For more details, also see section“Preprocessing and postprocessing”.
Example
FILE-NAME = C‘|& / command1; / command2; / command3; ...‘
FILE-NAME = *LIBRARY-ELEMENT(...)
A library member is to be transferred.
The operands in these parentheses can be used as positional operands without their keywords.
LIBRARY =
Name of the library in the local system.
LIBRARY = *NOT-SPECIFIED
If the FTAC functionality is used the name of the library can be predefined in an FT profile. The name of the library must not then be made known to the request submitter, nor may it be specified in the command.
LIBRARY = <filename 1..54>
Name of the library in the local system.
ELEMENT =
Name of the library member in the local system.
ELEMENT = *NOT-SPECIFIED
If the FTAC functionality is used the name of the library member can be predefined in an FT profile. The name of the library member must not then be made known to the request submitter, nor may it be specified in the command.
ELEMENT = <filename 1..64 without-gen-vers>(...)
<composed-name 1..64 with-under>(...)
Name of the library member in the local system.
VERSION =
Version of the element in the local system.
VERSION = *STD
Highest version of the member.
VERSION = <text 1..24>
Version of the member.
TYPE =
Type of the member in the local system.
TYPE = *NOT-SPECIFIED
If the FTAC functionality is used the name of the library member type can be predefined in an FT profile. The type of library member does not have to be specified in the command.
TYPE = <name 1..8>
Type of the member in the local system.
PASSWORD =
Password authorizing access to the file in the local system. If the file in the local system is password-protected, the password must be specified in this operand as:
a write password for a receive file, or
a read password for a send or receive file that is not protected by a write password but by a read password, or
a password for the execution of a send or receive file that is protected neither by a read nor by a write password but by an execute password.
Newly created receive files are not given a password by this operand. PASSWORD is ignored in such cases.
PASSWORD = *NONE
Access is possible without a password.
PASSWORD = <c-string 1..4> / <x-string 1..8> /
<integer -2147483648..2147483647>
Password authorizing access to 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.
TRANSFER-ADMISSION =
Transfer admission of the user for the local system.
TRANSFER-ADMISSION = *SAME
The ID of the user entering the command is valid for the file transfer.
TRANSFER-ADMISSION = <alphanum-name 8..32> / <c-string 8..32 with-low> / <x-string 15..64>
If the FTAC functionality is used the file name for the local system can be defined in an FT profile. The transfer admission defined in the FT profile must be specified here. From this transfer admission the access rights in the local system can be defined. These access rights are also defined in the FT profile. 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(...)
User ID, account number and password under which file transfer in the local system is to be performed. The operands in parentheses can also be used a positional operands without their keywords.
USER-IDENTIFICATION = <name 1..8>
User ID in the local system.
ACCOUNT =
Account number under which file transfer is performed in the local system.
ACCOUNT = *NONE
The default account number of the user ID is used.
ACCOUNT = <alphanum-name 1..8>
Account number of the user in the local system.
PASSWORD =
Password authorizing the user to access the local system.
PASSWORD = *NONE
Access is possible without a password.
PASSWORD = <c-string 1..8> / <c-string 9..32> / <x-string 1..16>
Password that authorizes the user to access the local system.
PASSWORD = *SECRET
The system prompts you to enter the password. However, the input is not displayed on the screen.
PROCESSING-ADMISSION =
Contains information concerning the authorization of a user in the local system to perform follow-up processing.
PROCESSING-ADMISSION = *SAME
The relevant TRANSFER-ADMISSION values (see above) of the local system apply.
PROCESSING-ADMISSION = *NOT-SPECIFIED
Only if FTAC functionality is used can the entry for PROCESSING-ADMISSION be predefined by an FT profile. This entry must not be specified in the FT request.
PROCESSING-ADMISSION = *PARAMETERS(...)
User ID, account number and password of the user for whom the follow-up processing is to be performed. The operands in parentheses can also be used as positional operands without their keywords.
USER-IDENTIFICATION = <name 1..8>
User ID in the local system. This ID must be specified in the syntax of the local BS2000 system.
ACCOUNT = *NONE
The default account number of the user ID specified in the USER-IDENTIFICATION is used.
ACCOUNT = <alphanum-name 1..8>
Account number of the user in the local system. The account number must be specified in the syntax of the local system
PASSWORD =
Password authorizing the user to access the local system.
PASSWORD = *NONE
Access is possible without a password.
PASSWORD = <c-string 1..8> / <c-string 9..32> / <x-string 1..16>
Password that authorizes the user to access the local system.
PASSWORD = *SECRET
The system prompts you to enter the password. However, the input is not displayed on the screen.