Open topic with navigation

TIBCO® Managed File Transfer Platform Server for z/OS 8.1.0

# FUSRECV

You can use the FUSRECV exec to queue a request to receive a file from a remote partner.

## Required Parameters

The following table lists the required parameters of the FUSRECV exec:

Parameter | Description
--- | ---
LFILE | LF | DSN | Defines the dataset that the Platform Server updates with data received by the remote system.
RFILE | RF | REMOTE_FILE | Defines the name of the file on the remote Platform Server system. The remote system will read this file and send the data to the local Platform Server that will write the data to the LFILE file.
IPADDR or IPNAME or LIST or NODE | IPADDR: Defines the dotted decimal IP address of the remote Platform Server node. IPNAME: Defines the IP name of the remote Platform Server node. It can be up to 24 bytes. LIST: Defines the name of the distribution list. NODE: Defines the name of the destination node for a request. The LUname is used if NODE is not defined to the Platform Server.

## Optional Parameters

The following table lists the optional parameters of the FUSSCMD exec:

Optional Parameters | Description
--- | ---
ALLOC_TYPE | Defines the allocation type for creating datasets. Valid values are: `C`: Cylinders `T`: Tracks `M`: Megabytes `K`: Kilobytes
ALLOC_DIR | Defines the number of directory blocks that should be allocated when a dataset is created.
ALLOC_PRI | Defines the primary allocation quantity when creating a dataset.
ALLOC_SEC | Defines the secondary allocation quantity when creating a dataset.
AVAIL | Defines whether TAPE is supported. `IMMED`: The remote file is available to users as soon as the file transfer is completed. This is the default and the best practice. `DEFER`: The remote file availability is deferred. The Platform Server treats this as a TAPE.
BLOCKSIZE | Defines the size of the block when creating a dataset.
CKPT | Defines whether to take checkpoints during this transfer. Valid values are as follows: `nn`: Defines the time in minutes that each checkpoint takes. Allowable values are 1 - 9999 minutes. `YES`: Uses a 5-minute checkpoint interval. `NO`: Does not use checkpoint. This is the default option.
COMPRESS | Defines whether to use data compression, or defines the data compression algorithm to use. Valid values are as follows: `NO`: No compression is used. This is the default option. `YES`: Uses RLE compression. `RLE`: Uses RLE compression. `LZ`: Uses LZ compression.
CONFIG | CFG | Defines the configuration file used by the Platform Server exec. If this parameter is not defined, the Platform Server uses the default configuration.
COPIES | Defines the number of copies for a report. Note: This parameter is used only when `TRANS_TYPE=PRINT` is specified.
CRCCHECK(CRC) | Defines whether CRC checking will be turned on by default. CRC checking is performed against the data that is sent over the network to ensure that the data has not been corrupted. The CRC is not performed against the file itself. ASCII to EBCDIC conversion, translation and LF/CRLF change the contents of the file between the sender and receiver so the CRC is not performed against the file contents. Valid values are: `YES`: Performs CRC checking by default `NO`: Does not perform CRC checking by default The CRCCHECK parameter on the Node and batch parameters override the Global CRCCHECK settings. Note: If the partner Platform Server does not support CRC checking, CRC is computed but will not be checked against the partner's CRC value computed.
CRLF | Defines whether records are delimited by CRLF (Carriage Return/Line Feed). Valid values are as follows: `YES`: Records are delimited by CRLF. `NO`: Records are not delimited by CRLF. This is the default option.
DATACLASS | Defines the SMS data class when creating a dataset.
DATASET_TYPE | Defines the type of dataset to be created. Valid values are: `PDS`: Creates z/OS PDS. `LIBRARY`: Creates z/OS PDS/E. `DSN`: Creates z/OS sequential files. `VSAM`: Creates z/OS VSAM files.
DATE | Defines the start date of the request in Julian format, ccyyddd.
DESCRIPTION | Defines the user data for the transfer in 25 bytes.
DESTINATION | Defines the destination for a report.
DISP | Defines the type of allocation that the Platform Server performs for the request. Valid values are: `SHR`: Allocates as `DISP=SHR`. `OLD`: Allocates as `DISP=OLD`.
EFFECT | Defines how the Platform Server open a dataset when writing to the dataset. Valid values are: `C`: Creates a file. `R`: Replaces a file. `A`: Appends a file. `CR`: Creates or replaces a file. This is the default option. `CA`: Creates or appends a file.
EMAIL_FAIL | Defines the email address to which to send an email notification when a request is completed unsuccessfully.
EMAIL_GOOD | Defines the email address to which to send an email notification when a request is completed successfully.
ENCRYPT | Defines the level of encryption that is used by the transfer. If specified, this parameter overrides the ENCRYPT parameter specified in the GLOBAL or NODE definitions for this transfer. Valid values are: `NONE`: No encryption is used for this transfer. `DES`: DES encryption is used. `3DES`: triple DES encryption is used. `BF`: Blowfish 56-bit encryption is used. `BLOWFISH`: Blowfish 56-bit encryption is used. `BFL`: Blowfish 448-bit encryption is used. `BLOWFISH_LONG`: Blowfish 448-bit encryption is used. `AES`: AES 256-bit encryption is used. For more information on this parameter, see Data Encryption.
EVERY | Defines the interval at which the request will be executed.
EVERY_COUNT | Defines the number of times that an EVERY request can be executed.
EVERY_EXDAYS | Defines the expiration interval in days for a transfer scheduled by an EVERY request.
EVERY_EXTIME | Defines the expiration interval in hours and minutes for a transfer scheduled by an EVERY request.
EVERY_MISSED | Defines whether a request is scheduled when the interval defined by the EVERY request has passed.
EXPDT | Defines the expiration date of a file transfer request, in Julian format, CCYYDDD. The default value is 30 days from now.
EXPTM | Defines the expiration time for a file transfer request.
FCB | Defines a form control buffer for a report. Note: This parameter is used only when `TRANS_TYPE=PRINT` is specified.
FORM | Defines the name of the form for a report. Note: This parameter is used only when `TRANS_TYPE=PRINT` is specified.
HOLD | Defines whether a request is put on hold when it is queued. Valid values are: `Yes`: Puts the transfer on hold when it is queued. `No`: Does not put the transfer on hold when it is queued. This is the default option.
INTERVAL | Defines the status scan interval. Note: This parameter is ignored unless the WAIT parameter is specified.
IVOLUME | Defines the volume that is used for input dataset processing by the Platform Server. When this parameter is specified, the catalog is not used to allocate the dataset.
LDISP | Defines local status, normal disposition, and error disposition. The values of the LDISP parameter must be delimited by a colon instead of a comma.
LENGTH | The record length of a file when creating a dataset.
LOCALLABEL | Defines the label used on the initiating Platform Server when sending or receiving a tape file. The input format is (nn,`SL`) where nn defines the file label number and `SL` is the only label type currently supported. For sending a tape file, if the label information is in the catalog, this parameter is not required. This parameter is ignored for disk files.
LOGON_DOMAIN | Defines the name of the Windows domain to which to log on.
MGTCLASS | Defines the SMS management class when creating a dataset.
MQ_GOOD | Defines the MQ (Message Queue) to which the Platform Server writes a record when a request is completed successfully.
MQ_FAIL | Defines the MQ (Message Queue) to which Platform Server writes a record when a request fails.
MWAIT | Puts a request on a queue and returns to the caller before the request is completed.
NODE | Defines the name of the destination node for a request. The LUname is used if the NODE parameter is not defined to the Platform Server.
NOTIFY | Defines the TSO user to notify when the request is completed.
NOTIFY_TYPE | Defines a type of user to notify when the request is completed. Currently, the only option supported is `TSO`.
OVOLUME | Defines the volume that is used for that is used for the output dataset for a transfer. When this parameter is specified, the catalog is not used to allocate the dataset.
PPA | Defines the preprocessing or postprocessing actions that are performed for the file transfer. The format of the PPA command is: `PPA={"S | F |P, L | R, CALLJCL | CALLPGM | SUBMIT | COMMAND data_to_be_processed"}` Where Status is: `S`: Success, `F`: Failure, `P`: Pre-Processing Where Source is: `L`: Local (Initiator), `R`: Remote (Responder) Where Action is: `CALLJCL`: Call program on z/OS with JCL linkage `CALLPGM`: Call program on z/OS with standard linkage `SUBMIT`: Submit job on z/OS `COMMAND`: Execute a command Where Data is: The data to be processed
PROCESS | Defines the process name that is associated with the request.
PRIORITY | Defines the priority for file transfers. The allowable values are `0` - `9`. The default value is `3`.
PRINTER_NAME | Defines the name of a remote printer.
PURGE | Defines whether to purge uncompleted transfers when the TIMEOUT interval expires. Note: This parameter is ignored unless the WAIT parameter is specified.
RDISP | Defines the remote status, normal disposition, and error disposition. The values of the RDISP parameter must be delimited by a colon instead of a comma.
RECFM | Defines the platform record format when creating a dataset. Valid values are: `F`: Fixed `FB`: Fixed block `V`: Variable `VB`: Variable block `U`: Undefined `FS`: Fixed standard `FBS`: Fixed blocked standard `VS`: Variable spanned `VBS`: Variable blocked spanned
REMOTELABEL | Defines the label used on the target Platform Server when sending or receiving a tape file. The input format is (nn,`SL`) where nn defines the file label number and `SL` is the only label type currently supported. For sending a tape file, if the label information is in the catalog, this parameter is not required. This parameter is ignored for disk files.
RETENTIONPRD | Defines the number of days that the Platform Server leaves a request on an active queue before purging the request. The allowable values are `1` - `9999`. The default value is 30 days.
RETRY | Defines the number of times that the Platform Server tries a request when a network error occurred. The default value of `1` means that the Platform Server purges the transfer when the first network error occurs. For best results set this parameter to `1` if you specify the WAIT parameter.
RETRYINT | Defines the retry interval of the file transfer. This parameter can be specified in terms of hours, for example, `RETRYINT=2H` or minutes, for example, `RETRYINT=0M`.
REXX_EXEC | Defines a REXX exec that will be executed when the Platform Server request is completed, either successfully or unsuccessfully. Note: This exec is only executed when the Platform Server request is purged from the active queue.
RMTRAIL | Defines whether to remove the trailing blanks and spaces when sending a TEXT file to the Platform Server for UNIX or Windows. Valid values are: `YES`: Removes trailing spaces and nulls. `NO`: Does not remove trailing spaces and nulls. This is the default option.
RPASS | Defines the password for the user on a remote computer. Note: This parameter can only be defined when the RUSER parameter is also defined.
RUSER | Defines the name of the user on the remote computer. If this parameter is not defined, the default value `*PROFILE` is used.
SAY | Writes a status record on each status scan. Note: This parameter is ignored unless the WAIT parameter is also specified.
STORCLASS | Defines the SMS storage class when creating the dataset.
SYSOUT | Defines the SYSOUT class for a report. Note: This parameter is used only when `TRANS_TYPE=PRINT` is specified.
TEMPLATE | Defines the Windows template for a file transfer.
TIME | Defines the start time of the request in 24-hour clock format, hhmm.
TIMEOUT | Defines the timeout interval. Note: This parameter is ignored unless the WAIT parameter is specified.
TLS | Defines whether TLS (SSL) can be used for this request. This definition overrides the GLOBAL or NODE definitions. Valid values are: `YES`: TLS is used for this transfer. `NO`: TLS is not used for this transfer. `TUNNEL`: All data transmitted is sent over an encrypted TLS Tunnel.
TRANS_TYPE | Defines the type of transfer being sent or received. Valid values are: `FILE`: Data is written to a file. This is the default option. `PRINT`: Data is sent to a printing queue. `JOB`: Data is run as a job. `COMMAND`: Data is executed as a command.
TRUNCATE(TRUNC) | This parameter is only used when receiving a file from Windows, UNIX, IBM i, or MFT Internet Server when record delimiters are defined. This parameter is ignored for a SEND or when communicating to another z/OS system. Valid values are: `NO`: If the record received from the partner is greater than the LRECL, a truncate error occurs and the transfer is terminated with an error. `YES`: If the record received from the partner is greater than the LRECL, the record is truncated and any data after the LRECL is lost. `WRAP`: If the record received from the partner is greater than the LRECL, the record is truncated and any data after the LRECL is written to the next record. If the record received has no delimiters within the first 32760 bytes, a truncate error occurs and the transfer is terminated with an error. In cases like this, you should turn off delimiter checking, so records will be written without any delimiter checking.
TYPE | Defines the type of data in a file, and whether ASCII - EBCDIC conversion occurs. Valid values are: `TEXT`: Removes trailing blanks and nulls, and perform data conversion. `DATA`: The same as `TEXT` except that trailing blanks and nulls are not removed. `BINARY`: Does not perform data conversion. This is the default option.
USERNAME | Defines the user name associated with a report.
UTF8BOM | Defines whether the UTF-8 BOM(0xefbbbf) is added at the start of the converted data or is removed from the start of the data before conversion. This parameter is used only when the LCT parameter defines that Unicode services are used to convert data. This parameter can be used for a z/OS Initiated Send or Receive transfers, although it is more commonly used when sending a file to a target system that requires a BOM. Valid values are: `ADD`: The UTF-8 BOM (0xEFBBBF) is added at the start of the converted data. This value is typically used when sending data to a target system (like Linux) that requires the UTF-8 BOM at the start of the file. `REMOVE`: The UTF-8 BOM (0xEFBBBF) is removed from the start of the file before converting the data. If the start of the file does not include the BOM, no changes are made. This value is typically used when receiving data from a target system (like Linux) that contains the UTF-8 BOM at the start of the file. `BOTH`: The UTF-8 BOM (0xEFBBBF) is added at the start of the converted data. The UTF-8 BOM (0xEFBBBF) is removed from the start of the file before converting the data. `NONE`: No UTF-8 BOM processing is performed. The UTF-8 BOM is not inserted at the start of the converted data or removed before conversion.
VOLUME | Defines the volumes where the dataset can be written. Up to 5 volumes can be defined. If more than one volume is defined, the volumes must be delimited by colons.
VSAM_RRSLOT | Defines whether the RRDS slot number is included in a VSAM RRDS transfer.
VSAM_KEYPOS | Defines the VSAM KSDS key position relative to 0.
VSAM_KEYLEN | Defines the VSAM KSDS key length.
VSAM_TYPE | Defines the type of VSAM file to be created. Valid values are: ESDS KSDS RRDS
VSAM_LIKE | Defines the model DSN for VSAM file creation.
VSAM_LRECL | Defines the record length used for VSAM file creation.
VSAM__REUSE | Defines whether to use the VSAM RESUSE option.
WAIT | Waits for this request to be completed before returning to REXX.
WRITER | Defines the name of the z/OS external writer for a report. Note: This parameter is only when `TRANS_TYPE=PRINT` is specified.

## Example

The following example shows how to use the FUSRECV exec to receive a file from a remote partner:

    FUSRECV IPADDR=127.127.127.1 IPPORT=46464 LF=LOCAL.FILE.RECV1 RF=C:\FUSRECV1.TXT INTERVAL=3 SAY WAIT CRLF=YES TYPE=TEXT

The output of this example is as follows:

    TRANSACTION=IA01500041 STATUS=ACTIVE   RECORD=000000000 BYTES=000000000
     TRANSACTION=IA01500041 STATUS=COMPLETE RECORD=000000052 BYTES=000004098
     ***Fusion retcode.......=  0
     ***Fusion TransNum......=  IA01500041
     ***Completed transfers..=  01
     ***Successful transfers.=  01
     ***Failed transfers.....=  00
     ***Purged transfers.....=  00
     ***Last Message.........=  PGTF3101I Activity IA01500041 successfully transferred 52
                                records with remote node 127.127.127.1
    Request Queued successfully with TRANSNUM= IA01500041

Copyright © 2003-2021. TIBCO Software Inc. All Rights Reserved.