Catalog - CFTCAT

The catalog logs all information relative to transfer requests. Use this command to describe the way the catalog is managed: file, scanning mode, retention time before purge, and so on.

The Catalog (CFTCAT) object is used to describe the Transfer CFT transfer catalog access for:

  • File
  • Scanning mode
  • Retention time, before the purge, of associated information

The catalog purge can be initiated at midnight (default value) or at a specific time indicated in the TIMEP parameter.

The catalog is purged in batches of 10 entries. Between each batch, Transfer CFT handles all pending transfer events. As a result, if the transfer activity is intense, the catalog purge action may be extended but does not significantly disrupt transfers.

Related topics

Parameter Description

ID 

Name identifying the CFTCAT command.

FNAME

Catalog file name.

CACHE 

Size parameter for the monitor cache memory buffer size, containing the transfers waiting for resources.

RH

Number of days (where a day equals a 24-hour interval) after which the catalog entries of "unterminated" receive requests (H or K state) are automatically purged.

RKERROR

Action to be taken if a transfer aborts during the selection phase in server mode.

RT 

Number of days (where a day equals a 24-hour interval) after which the catalog entries of terminated receive transfers (RT state) are automatically purged.

RX 

Number of days after which the catalog entries of receive transfers for which the end of reception procedure is correctly executed (RX state) are automatically purged.

RY Number of days after which the catalog entries of receive transfers that are the in post-processing phase (RY state) are automatically purged.

SH 

Number of days (where a day equals a 24-hour interval) after which the catalog entries for "unterminated" send requests (H or K state) are automatically purged.

ST 

Number of days (where a day equals a 24-hour interval) after which the catalog entries of terminated send transfers (ST state) are automatically purged.

SX

Number of days (where a day equals a 24-hour interval) after which the catalog entries of terminated send transfers, for which the end-of-send transfer procedure was correctly executed (SX state), are automatically purged.

SY Number of days (where a day equals a 24-hour interval) after which the catalog entries of send transfers that are in the post-processing phase (SY state), are automatically purged.

TLVCLEAR

Level below which the alert ceases, as a percentage of filling, where 0% indicates the file is empty and 100% that it is full.

TLVCEXEC

Batch to execute when the alert ends.

TLVWRATE

The minimum amount of time, in seconds, to wait before resending an alert.

TLVWEXEC

Batch to execute when CFTCAT/TLVWARN is reached.

TLVWARN

Catalog usage limit before issuing an alert, as is a percentage of filling, where 0% indicates the file is empty, and 100% that it is full.

When this limit is reached, the CFTCAT/TLVWEXEC is executed.

TIMEP 

Daily purge time chosen by the user.

The user can program an automatic, cyclic catalog purge. The default purge time is midnight.

Note To completely deactivate purging, set TIMEP = 00000000. Use this option with caution as no automatic purging is performed (at a selected time or at midnight).

UPDAT 

Number of synchronization points between two consecutive updates of the catalog file during a transfer.

WSCAN 

Enter the frequency (in minutes) with which Transfer CFT scans the catalog file when restarting a transfer:
  • 5 (default value)
  • 1 to 60

Example

CFTCAT ID = IDCAT,

FNAME = filename,

RH = 7,

RT  = 3,

RX = 3,

SH = 7,

ST = 3,

SX = 3

  • Non-terminated send requests (SH state) and interrupted receive transfers are automatically purged after seven days (RH state).
  • Terminated send transfer entries (ST state) and terminated receive transfer entries (RT state) are automatically purged after three days. The entries of terminated send transfers and receive transfers for which the end procedure was correctly executed, SX and RX state, are automatically purged after three days.
  • The UPDAT parameter is not mentioned; it takes the default value 1, which results in the catalog file being updated at each synchronization point of each transfer.

Related topics

Related Links