Overview


Since Version 5.3, the functionality of the Data Retention facility has been improved. The Data Retention includes four separated parameters and works in two steps. At first, the CDRs can be archived, next they will be removed completely from filesystem.


Setup

    You can find and configure in the "System Parameters" option in the “System Management” menu of your Sippy Softswitch. Each parameter can be changed from one day to two years.



Archive All CDRs: it determines the period of time when the CDR entities should be archived. In other words, after passing this amount of time, a given CDR will be removed from database and will be archived. Here, all of the CDRs regardless of their lengths -zero or non-zero- will be archived. The default value for this parameter is 3 months.

Archive Zero CDRs: it determines the period of time when the CDR entities with zero length should be archived. In other words, a given zero length CDR after passing this amount of time, will be removed from database and will be archived. Here, just CDRs with zero length will be archived. The default value for this parameter is 3 months.

Purge All CDRs: it determines the period of time when the CDR entities should be purged from server filesystem. In other words, after passing this amount of time, a given CDR will be completely removed from server file system. Here, all of the CDRs regardless of their lengths -zero or non-zero- will be purged. The default value for this parameter is 2 years.

Purge Zero CDRs: it determines the period of time when the CDR entities should be purged server filesystem. In other words, after passing this amount of time, a given CDR will be purged server file system. Here, just the CDRs with zero length will be purged. The default value for this parameter is 2 years.


Example based on the screenshot above:

    By having Archive All CDRs = 6 months, Archive Zero CDRs = 3 months, Purge All CDRs = 2 years, Purge Zero CDRs = 1 year settings:

  • All CDRs, younger than three months, will remain untouched in the database,
  • All CDRs with zero duration older than three months but younger than six months, will be removed from database and will be archived,
  • All CDRs with non-zero duration older than three months but younger than six months, will remain untouched in the database,

  • All CDRs with non-zero duration older than six months but younger than 2 years, will be removed from database and will be archived, archives would be kept on the filesystem for 2 years starting from call's setup time.
  • All CDRs with zero duration older than 1 year, will be removed from database, if archives exist - they would be permanently removed from server filesystem
  • All CDRs with non-zero duration older than 2 years, will be removed from database, if archives exist - they would be permanently removed from server filesystem


Note:

  1. The extra care should be taken when selecting purge option. Purge removes the archive files permanently from server file system and restoration will not be possible.
  2. It should also be noted that archive and purge parameters are independent from each other. Selecting shorter amount of time for the Purge parameter, means ignoring the Archive parameter. In such a case, the CDRs will be removed directly from database. It might be useful when there is no space for keeping the archive files or no need to archive CDRs. This can be opted for the zero CDRs, for instance.


Terminology:

  • Archive: putting the data from database into an archive file.
  • Purge: permanently removing/deleting an archive file from file system.