How to Configure the Automatic Purging of CA Spool Files

Document ID : KB000020049
Last Modified Date : 14/02/2018
Show Technical Document Details

Description:

This document is intended to clarify the role of the general parameters PURGE, FILELIM, PURGELIM, PURGINT and RETAIN in the automatic purge of printed and not printed CA Spool files.

Solution:

To configure the automatic purging of CA Spool files, use the following settings in your ESFPARM definition:

FILELIM specifies the number of hours to retain printed files queued to printers defined with PURGE=NO. Afterwards, the files are automatically purged.

  • FILELIM is a general setting for all nodes. However, if a node or a file specifies a RETAIN value, it overrides FILELIM.
  • If FILELIM=0, no automatic purge occurs for both the printed and unprinted files, unless RETAIN overrides FILELIM.

See the PURGELIM bullet for more details about the use of FILELIM in the automatic purge of unprinted files.

  • ¬†RETAIN specifies the number of hours that a specific node retains printed files, as described in the previous bullet.

See the PURGELIM bullet for details about the use of RETAIN in the automatic purge of unprinted files.

  • PURGELIM and either RETAIN or FILELIM work together to specify the number of hours to retain unprinted files, as follows:

If the NODE statement contains a RETAIN value or a file RETAIN value is specified, the sum of PURGELIM and RETAIN determines when to purge unprinted files. (FILELIM is ignored.)

However, if RETAIN is not specified, the sum of PURGELIM and FILELIM determines when to purge unprinted files.

If PURGELIM=0, unprinted files are not purged, no matter what the value of RETAIN or FILELIM is.

  • PURGEINT specifies the number of seconds between each scan of the file queue for files to purge. If PURGINT=0, neither printed nor unprinted files are automatically purged, no matter what the value of RETAIN or FILELIM is.

Sample ESFPARM global parameter definitions follows:

FILELIM=12

PURGELIM=24

PURGINT=180

Sample ESFPARM NODEs definitions follows:

NODE PRT1,TCPIP,GROUP=1,TCPHOST=some.ip.address,PURGE=NO

NODE PRT2,TCPIP,GROUP=1,TCHOST=some.ip.address,PURGE=NO,RETAIN=6

NODE PRT3,TCPIP,GROUP=1,TCHOST=some.ip.address,PURGE=YES,RETAIN=8

These settings result in the following actions every 180 seconds (PURGINT=180):

  • Printed files in the PRT1 queue are purged 12 hours after they were printed. No RETAIN is specified, so FILELIM is used.
  • Unprinted files in the PRT1 queue are purged 36 hours after they were queued. PURGELIM + FILELIM = 24 + 12 = 36.

No RETAIN is specified, so FILELIM is used.

  • Printed files in the PRT2 queue are purged 6 hours after they were printed.

RETAIN is specified, so it overrides FILELIM. 

  • Unprinted files in the PRT2 queue are purged 30 hours after they were queued. PURGELIM + RETAIN = 24 + 6 = 30.

RETAIN is specified, so it overrides FILELIM.

  • Files printed on PRT3 are purged immediately after they are printed.
  • Unprinted files in the PRT3 queue are purged 32 hours after they were queued. PURGELIM + RETAIN = 24 + 8 = 32.

RETAIN is specified, so it overrides FILELIM.