Whenever a File Target file rolls then Hub’s housekeeping routine will be run.
“Rolls” refer to the process whereby the file to which data is currently being written reaches its maximum size which causes Hub to create a new file. The new file becomes the current file to which data is written. The old file is referred to as a rolled file. No further data is written to a rolled file.
Housekeeping is only applied to rolled files. The file currently being in use will not be removed by the housekeeping routine.
There are four values, specified in the target’s FileConfiguration that determine how and whether to apply housekeeping:
- HousekeepUsingQuantity
- MaxBackupIndex
- HousekeepUsingAge
- MaxBackupDays
It is necessary to specify either none of the values or all the values, except when:
- HousekeepUsingQuantity is false then MaxBackupIndex is not required.
- HousekeepUsingAge is false then MaxBackupDays is not required.
If none of the values are specified then Hub will housekeep (delete) files for that File Target so that only one rolled file is retained. This means that after housekeeping there will be two files in total – the current file and one rolled file.
If HousekeepUsingQuantity and HousekeepUsingAge are both set to false then no housekeeping will occur, regardless of the values in MaxBackupIndex and MaxBackupDays.
If HousekeepUsingQuantity and HousekeepUsingAge are both set to true and MaxBackupIndex and MaxBackupDays are both set to zero then no rolled files will be retained and after housekeeping has been run only the file that is currently being written to will remain.
Example File Target
An example of a Target configuration file writing records to the /home/destinations folder in json format, where file names will be set to is4z<DateTimeOfCreation>.json, with new files being created when they grow too large or too old. Files will be housekept when there are more than 5 rolled files, or when the rolled file is more than 7 days old.
{"Name":"is4zfile",
"Id":"12345678-1234-1234-1234-123456789012",
"FileConfiguration":{
"Path":"/home/destination",
"FileNamePrefix":"is4z",
"FileNameSuffix":".json",
"RollWhenTooBig":true,
"RollSizeMB":15,
"RollWhenTooOld":true,
"RollHour":0
“HousekeepUsingQuantity”:true
“MaxBackupIndex”:5
“HousekeepUsingAge”:true
“MaxBackupDays”:7
},
"ConnectorType":"File"
}