Purging documents
Purging is a process that permanently deletes input and output document instances processed in IGFC. The purge feature is automated to run daily at midnight to clean up old data based on the ReceivedDateTime from the IGFC schema inbox and outbox tables.
After purging documents, some features are no longer accessible. Input and
output transactional documents older than 365 days are purged. The journal control containing
a condensed format of the SourceSystemJournalEntry output and the Reprocess
action are also not accessible.
The rest of the details which include the inbox or outbox IDs, statuses, document name, document IDs, received date time, sender and receiver entities, and the running rule are still displayed. Master data records are not purged.
These default values of retention days and purging schedule may be overridden by defining the preferred setting:
- Retention days
The number of days that the document is kept or stored before purging. The current date-time is compared against the date-time in IGFC to determine the age of the document in days.
- Purge schedule
This schedule defines how often the purging job is executed when active. This is defined in CRON expression that consists of these components: seconds, minutes, hours, day of month, month, day of week, and year. All fields are required, except for the year component.
About the CRON expression format
A CRON expression is a string composed of seven fields, separated by white spaces.
This table shows the field names, allowed values, and allowed special characters in CRON expressions:
| Field name | Allowed values | Allowed special characters |
|---|---|---|
| Seconds | 0-59 | , - * / |
| Minutes | 0-59 | , - * / |
| Hours | 0-23 | , - * / |
| Day-of-month | 1-31 | , - * ? / L W C |
| Month | 1-12 or JAN-DEC | , - * / |
| Day-of-week | 1-7 or SUN-SAT | , - * ? / L C # |
| Year | * | * |
For example, the CRON expression 0 0 0 ? * * * means the document purging
runs every midnight, based on the defined retention days.