From 460ac64d0d1f640936b931713e9eb1f936c24fac Mon Sep 17 00:00:00 2001 From: Fred Gleason Date: Tue, 17 May 2022 13:18:11 -0400 Subject: [PATCH] 2022-05-17 Fred Gleason * Added a 'Purging Log and ELR Data Automatically' subsection to the 'Managing Services' section of 'Configuring Rivendell with RDAdmin' in the Operations Guide. Signed-off-by: Fred Gleason --- ChangeLog | 4 +++ docs/opsguide/rdadmin.xml | 52 ++++++++++++++++++++++------------ docs/opsguide/rdlogmanager.xml | 9 ++++-- 3 files changed, 44 insertions(+), 21 deletions(-) diff --git a/ChangeLog b/ChangeLog index 02220d56..018ccd87 100644 --- a/ChangeLog +++ b/ChangeLog @@ -23088,3 +23088,7 @@ Operations Guide to 'Generating Logs and Reports with RDLogManger'. * Updated the 'Generating Logs and Reports with RDLogManger' chapter of the Operations Guide. +2022-05-17 Fred Gleason + * Added a 'Purging Log and ELR Data Automatically' subsection to the + 'Managing Services' section of 'Configuring Rivendell with RDAdmin' + in the Operations Guide. diff --git a/docs/opsguide/rdadmin.xml b/docs/opsguide/rdadmin.xml index bb10446e..d2673651 100644 --- a/docs/opsguide/rdadmin.xml +++ b/docs/opsguide/rdadmin.xml @@ -377,18 +377,17 @@ The Purge Logs after box, - if ticked, will set the deletion date for logs to be the - specified number of days after being created by RDLogManager. + if ticked, will set the default deletion date for logs to be the + specified number of days after being created by RDLogManager. See + for more information. + + + The Purge ELR Data after + box, if ticked, will cause Electronic Log Reconiliation (ELR) + as-played data to be purged from the database the specified number + of days after being generated. See + for more information. - - Purging Log and ELR Data Automatically - - The Purge ELR Data after - box, if ticked, will cause Electronic Log Reconiliation (ELR) - as-played data to be purged from the database the specified number - of days after being generated. - - The Include Music Import Markers in Finished Logs and Include Traffic Import Markers in Finished Logs @@ -402,7 +401,27 @@ If import markers are not included in finished logs, then it will not be possible re-import data of the respective type into those logs. - + + Purging Log and ELR Data Automatically + + Certain types of Rivendell item (specifically, play-out logs and + ELR data for generating "as-played" reports) tend to + accumulate over time. If too many of these items exist it can impact + the performance and responsiveness of the Rivendell system. Thus, + it is highly recommended that auto-purging of past and no longer + required play-out logs and ELR data be enabled. This can be done by + ticking the Set Logs to auto-delete + and Purge ELR Data boxes + respectively and setting the numbers of days to keep the data + before purging. + + + Once ELR data for a particular service and date are purged it will + be impossible to generate reports for that service/date. + Be sure that the purge interval is sufficiently large to allow all + required reports to be generated before the data is purged. + + Inline Event Scheduling Parameters @@ -443,11 +462,9 @@ correct placement, Start Time and Length of each inline event will be determined heuristically, with Inline Traffic Breaks generating Traffic Links with Start Time/Length - values taken from that of the parent Music Event. - - - N.B. This means that only one Inline Event of each type - may be placed within the same parent Music Event! + values taken from that of the parent Music Event, + meaning that only one Inline Event of each type + may be placed within the same parent Music Event. @@ -460,7 +477,6 @@ new installations should use From Scheduler File! - Examples diff --git a/docs/opsguide/rdlogmanager.xml b/docs/opsguide/rdlogmanager.xml index 28bd8bd7..e5c6171e 100644 --- a/docs/opsguide/rdlogmanager.xml +++ b/docs/opsguide/rdlogmanager.xml @@ -541,10 +541,13 @@ Each date that has data eligible for purging will be shown in bold. To purge a particular day, select it and the touch the Purge Data - button. (NOTE: once purged, no reports can be generated for that - particular service/date, so be sure that all required reports have - been produced before purging!) + button. + + Once ELR data for a particular service and date are purged it will + be impossible to generate reports for that service/date. + Be sure that all required reports have been produced before purging! + It is recommended that the system be configured to purge report data automatically after it reaches a certain age (30 days is typical).