Receive Management Information
The Receive Management Information stores the information about the files to receive. There are two ways to register records in the information.
-
Registration using the Management Console
->Refer to Creating and editing a record of the Receive Management Information
-
Registration using parameter file and command
->Refer to Registering and updating a record in management information.
(1) Fields
The table below indicates field values, optional fields, and so on, that are applicable when the fields are specified from the Management Console. The check marks in the Optional column are applicable only to the Management Console. The values might differ when commands are used to specify the fields. For details on optional fields for the command-based specification, refer to Registering and updating a record in management information.
Field Name |
Default Value |
Valid Values |
Optional |
Remarks |
|
---|---|---|---|---|---|
Screen |
File |
||||
File ID |
RCVFILE |
|
Alphanumeric characters |
|
Within 50 bytes starting with an alphabetic letter |
Receive File Name |
FILENAME |
|
Alphanumeric characters |
|
In the range of 3 to 33 bytes |
Record Length |
RECORDLEN |
128 |
1 to 32766 |
|
|
EBCDIC Set |
CHANGETYPE |
0 |
0, A to I, V to X |
|
|
Registration Mode |
TRANSMODE |
R |
N,R,M |
|
|
Error Recovery |
ABNORMAL |
K |
D,K,R |
|
|
Receive Mode |
RCVTYPE |
S |
S,M |
|
|
Generational Management |
GENCTL |
N |
N,Y |
|
|
No. of Generations |
GENMNGNO |
0 |
0,2 to 9999 |
|
|
Successful Job ID |
JOBID |
|
Alphanumeric characters |
✔ |
Within 50 bytes starting with an alphabetic letter |
Unsuccessful Job ID |
ERRJOBID |
|
Alphanumeric characters |
✔ |
Within 50 bytes starting with an alphabetic letter |
Notification |
JOBWAIT |
T |
T,J |
|
|
Transfer Group ID |
GRPID |
|
Alphanumeric characters |
✔ |
Within 50 bytes starting with an alphabetic letter |
Cipher Key (when Forced Strong Key mode is disabled) (*1) |
PASSWORD |
|
Alphanumeric characters |
✔ |
In the range of 8 to 20 bytes |
Cipher Key (when Forced Strong Key mode is enabled) (*2) |
Hexadecimal character string |
|
64 digits |
||
Verify Data |
DATAVERIFY |
0 |
0,1 |
|
|
Comment |
COMMENT |
|
Characters |
✔ |
Within 60 bytes |
✔ |
: |
Optional |
Blank |
: |
Mandatory |
*1 |
: |
This type of cipher key can be set when Forced Strong Key Mode (STRONGKEYMODE) is set to "0" (Disabled) in the System Environment Settings. |
*2 |
: |
This type of cipher key must be set when Forced Strong Key Mode (STRONGKEYMODE) is set to "1" (Enabled) in the System Environment Settings. |
(2) Explanations of each field
This section explains the fields to be specified in a record of the Receive Management Information. A string within brackets () is the tag of a field name to be specified when you use a parameter file to register the information.
- File ID (RCVFILE)
-
ID to identify the file to receive
Because "_INSTANT_TRANSFER_" is the ID used only for instant transfer, it cannot be specified as File ID.
- Receive File Name (FILENAME)
-
File stored on IBM i operating system
For a physical data file, specify the name in the format of Library name/File name(Member name).
For an archive file, specify the name in the format of Library name/File name.
You cannot use reserved words such as "*FIRST", "*FILE", and so forth as the name of the receive file. Specifying a file name with a reserved word may result in an unexpected behavior of HULFT.
- Record Length (RECORDLEN)
-
Record length in a Receive file
When Receive file does not exist, specify the length of the record in the newly created Receive file. When the Receive file already exists, specify the record length of the existing file.
- EBCDIC Set (CHANGETYPE)
-
The Type-EBCDIC code set that is specified on the receiving-side host (local host) and used for conversion of single-byte codes
If Code Set for Transfer is set to a Type-EBCDIC code set on the local host, specify the same EBCDIC set as that of the receiving-side host (local host).
If Code Set for Transfer is set to UTF-8 on the local host, specify the same EBCDIC set as that of the sending-side host (remote host).
- 0 :
-
Autoconfiguration
- A :
-
Katakana
- B :
-
Lowercase
- C :
-
ASCII
- D :
-
ASPEN
- E :
-
Japan (Latin) for IBM
- F :
-
Japan (Latin) Extended for IBM
- G :
-
NEC Katakana
- H :
-
Japan (Katakana) Extended for IBM
- I :
-
Simplified Chinese Extended
- V :
-
User Table 1
- W :
-
User Table 2
- X :
-
User Table 3
If omitted, "0" (Autoconfiguration) is set.
- Registration Mode (TRANSMODE)
-
The registration method of the Receive file
- N (New Creation) :
-
Creates a new receive fileAn error occurs when a file with the same name already exists.
- R (Replace) :
-
Replaces the content of the existing file with the received data. If the file does not exist, a new file is created.
- M (Append) :
-
Appends the received data at the end of the existing file. If the file does not exist, a new file is created.
- Error Recovery (ABNORMAL)
-
Handling of Receive file upon failure to receive
- D (Delete) :
-
Deletes the receive file.
- K (Keep) :
-
Keeps the receive file at the time when the receiving-side transferring failed.
- R (Replace) :
-
Backs up the receive file before starting the receiving-side transferring so that the backup can be restored when the transferring fails. If no receive file exists before the receiving-side transferring starts, the same behavior as "D (delete)" is obtained.
- Receive Mode (RCVTYPE) :
-
Receiving mode of Receive file
- S (Single Receive) :
-
Receive files from single host
- M (Multiple Receive) :
-
Receive files from multiple hosts and create them into one file
If you specify "M" (Multiple Receive) you must specify "M" (Append) for the Registration Mode and "K" (Keep) for the Error Recovery, respectively.
- Generational Management (GENCTL)
-
Options of generation management of the file to receive
- N :
-
Disable generation management
- Y :
-
Enable generation management
If you specify "Y" (Enable generation management) you must specify "N" (New creation) or "R" (Replace) for the Registration Mode and "D" (Delete) for the Error Recovery, respectively.
- No. of Generations (GENMNGNO)
-
Number of generations to keep for a Receive file
If you specify "Y" for Generational Management, select a value from "2" to "9999". If you specify "N" for Generational Management, set this field to "0".
- Successful Job ID (JOBID)
-
The ID of the Job Information record that represents the job to be started when receiving-side transferring ends successfully
For details on the Job Information, refer to Job Information.
When omitted, the job does not start.
- Unsuccessful Job ID (ERRJOBID)
-
The ID of the Job Information record that represents the job to be started when receiving-side transferring ends unsuccessfully
For details on the Job Information, refer to Job Information.
When omitted, the job does not start.
- Transfer Group ID (GRPID)
-
The ID of the Transfer Group Information record that represents the group of hosts that perform sending-side transferring of the receive file.
For details on the Transfer Group Information, refer to Transfer Group Information.
- Cipher Key (PASSWORD) (when Forced Strong Key mode is disabled)
-
Key used when data is encrypted in an encryption algorithm
Specify this field when you want to decrypt data.
Specify the same cipher key as is specified in the Send Management Information on the destination host.
If the cipher keys differ, data is not decrypted correctly.
When Cipher Key is not set on the sending-side host, the cipher key is not used even when Cipher Key is set on the receiving-side host.
- Cipher Key (PASSWORD) (when Forced Strong Key mode is enabled)
-
Key used when data is decrypted in a decryption algorithm
Specify this field when you want to decrypt data.
Specify the same cipher key as is specified in the Send Management Information on the destination host.
If the cipher keys differ, data is not decrypted correctly.
Make sure to specify the cipher key when you use encryption. If the sending-side host is not in Forced Strong Key mode, a transfer error occurs.
- Notification (JOBWAIT)
-
Options for the Receive completion notification to a sending host
- T :
-
Notify after completion of receiving
- J :
-
Notify after completion of the Post-receive Job that is specified for the Successful Job
- Verify Data (DATAVERIFY)
-
This field specifies whether to verify data of the file to receive.
- 0 :
-
Do not verify data
- 1 :
-
Verify data
- Comment (COMMENT)
-
Comment on the Receive file
(3) Points to be noted on the settings
Specification of Registration Mode, Receive Mode, and Generational Management
If Receive Mode is "S" (Single Receive) and Registration Mode is "M" (Append), data received before the error occurred is appended when an error occurred during the receiving-side transferring. However, if Error Recovery is set to "R" (Restore), the receive file is backed up as a separate member in the new receive file during the operation.
Registration Mode |
Error Recovery |
Receive Mode |
|||
---|---|---|---|---|---|
Single Receive (S) |
Multiple Receive (M) |
||||
Generational Management |
Generational Management |
Generational Management |
Generational Management |
||
Enable (Y) |
Disable (N) |
Enable (Y) |
Disable (N) |
||
New Creation (N) |
Delete (D) |
✔ |
✔ |
|
|
Keep (K) |
|
✔ |
|
|
|
Restore (R) |
|
✔ |
|
|
|
Replace (R) |
Delete (D) |
✔ |
✔ |
|
|
Keep (K) |
|
✔ |
|
|
|
Restore (R) |
|
✔ |
|
|
|
Append (M) |
Delete (D) |
|
✔ |
|
|
Keep (K) |
|
✔ |
|
✔ |
|
Restore (R) |
|
✔ |
|
|
✔ |
: |
Specifiable combination |
Blank |
: |
Not specifiable combination |
Archive File
If a receive file is an archive file, Checkpoint Resend File and Checkpoint Resend Request are not available. Even if you specified Checkpoint Resend File or Checkpoint Resend Request, HULFT resends the file from the top, when the Receive file is an archive file. With "N" specified for the Registration Mode, an attempt to carry out Checkpoint Resend File or Checkpoint Resend Request ends with an error.
Error Recovery
Point to be noted when specifying "D (Delete)"
When you select "N" (New Creation) for the Registration Mode, existence of a Receive file results in an error and the existing file is not deleted.
Points to be noted when specifying "K (Keep)"
if an error occurred during receiving data to a temporary file, selecting "M" (Multiple) for the Receive Mode protects a Receive file from being overwritten by the data received up to the point of the error. However, if an error occurred during copying a temporary file and pasting the data to a Receive file, HULFT appends the data received up to the point of the error to the Receive file. Therefore there must be a function embedded in your application program to check duplicate data.
Replacement Messages
Listed below are the fields that you can replace variables with messages.
By specifying a variable substitution from "&MSG0" to "&MSG5" or from "&MSGL0" to "&MSGL1", you can replace the values of the following fields with the messages that are specified at the time of making the Send Request or with the messages transmitted from the sending host:
-
Receive File Name
-
Transfer Group ID
-
Successful Job ID
Depending on the language setting of a remote host, the messages may not be assigned properly and the replacement messages may cause transfer to end with an error. For notes on message transmissions, refer to Administration Manual.
Receive File Name
-
When you specify one of the following variable substitutions, specify "S" (Single Receive) for the Receive Mode:
-
&SNDFILE
-
&SNDFILES
-
From &MSG0 to &MSG5
-
From &MSGL0 to &MSGL1
-
-
When you specify either of the following, if the value for Send File Name contains double-byte codes, an error occurs.
-
&SNDFILE
-
&SNDFILES
-
-
When you specify one of the following, if the sent message contains double-byte codes, an error occurs.
-
From &MSG0 to &MSG5
-
From &MSGL0 to &MSGL1
-
&SNDFILE or &SNDFILES must not be followed by a character string.
-
Depending on the language setting of a remote host, the messages may not be assigned properly and the replacement messages may cause transfer to end with an error.
For notes on message transmissions, refer to Administration Manual.
-
Using a variable substitution of &SNDFILE or &SNDFILES in the specification for the name of a Receive file allows you to assign the name of a Send file used on a sending host to name of a Receive file. Besides, when a sending host is HULFT for IBMi, using a variable substitution &SNDLIB allows you to assign the library name of a Send file to the library name of a Receive file. The naming conventions for assigning the Send File Name to the Receive File Name are as below.
Table 2.6 Naming convention of files
Host Type
Receive File Name (IBM i)
Send File Name
&SNDLIB&SNDFILE
MYLIB/&SNDFILE
&SNDLIB&SNDFILES
MYLIB/&SNDFILES
Mainframe
sequential file
HULFT.DAT.SND.F01Conversion error
MYLIB/F01(SND)
Conversion error
MYLIB/SND
partitioned file
HULFT.DAT.F02(SND)Conversion error
MYLIB/F02(SND)
Conversion error
MYLIB/SND
UNIX/Linux
with Extension
/HULFT/DAT/SND.F03Conversion error
MYLIB/F03(SND)
Conversion error
MYLIB/SND
without Extension
/HULFT/DAT/SNDConversion error
MYLIB/SND(SND)
Conversion error
MYLIB/SND
Windows
with Extension
C:\HULFT\DAT\SND.F04Conversion error
MYLIB/F04(SND)
Conversion error
MYLIB/SND
without Extension
C:\HULFT\DAT\SNDConversion error
MYLIB/SND(SND)
Conversion error
MYLIB/SND
IBMi
physical file
HULFT/F05(SND)HULFT/F05(SND)
HULFT/F05(SND)
Conversion error
Conversion error
archive file
HULFT/F06Conversion error
Conversion Error
HULFT/F06
MYLIB/F06
Record Length
When the Record Length specified in management information is not the same as that of the Receive file, the handling varies as per the Receive Mode. When "S" (Single Receive) is specified for the Receive Mode, the Record Length specified in the management information is ignored during receiving. When "M" (Multiple Receive) is specified for the Receive Mode, HULFT gives s a receive error.
Notification
When "T" (Notify after completion of receiving) is specified for the Notification, the Job Description that is registered in the Job Information will be used to run CL commands. CL Commands are run as a different job from the Receive job.
When "J" (Notify after completion of the Post-receive Job that is specified for the Successful Job) is specified for the Notification, CL Commands are run by the Receive job without using the Job Description.
Receiving of Chinese language data
Specify "I" (Simplified Chinese Extended) or "0" (Autoconfiguration) for the EBCDIC Set (CHARTYPE).
Make sure that the Code Set for Transfer (CS4TRNSFR) in the System Environment Settings is set to "C" (IBM Simplified Chinese) or "8" (UTF-8).
Value Automatically Configured for EBCDIC Set
When "0 (Automatic)" is selected as EBCDIC Set, the EBCDIC set actually used when a single byte code conversion is performed during a file transfer is determined as below.
Code Set for Transfer on the local host |
Code Set for Transfer on the remote host |
||||||||
---|---|---|---|---|---|---|---|---|---|
UTF-8 |
SHIFT-JIS |
EUC-JP |
GB18030 |
IBM Kanji |
JEF |
KEIS |
NEC Kanji |
IBM Simplified Chinese |
|
IBM Kanji |
F |
F |
F |
|
F |
F |
F |
F |
|
UTF-8 |
- |
- |
- |
- |
F |
A |
D |
G |
I |
IBM Simplified Chinese |
I |
|
|
I |
|
|
|
|
I |
-: Combinations of code sets that are not used for the code conversion during a file transfer.
Blank : Combinations of code sets that cannot be converted during a file transfer
A: Katakana
D: ASPEN
F: Japan (Latin) Extended for IBM
G: NEC Katakana
I: Simplified Chinese Extended
For details on Code Set for Transfer (CS4TRNSFR) of the System Environment Settings in which the code set used on the local host is specified, refer to Administration Manual.
For details on Code Set for Transfer (KCODETYPE) in which the code set used on the remote host is specified, refer to Host Information.