===== Retention Time Settings for Values =====


Countinuously generated values are based on hour, day, week and month.
For a proper check of the aggregation of values, some values must remain 
longer as "online" values than the default retention time.

The effective retention time for the values of a detail is derived in the following sequence:

  * use the default, system-wide retention time (it is set in the "admin menu", //edit access// for all details with the respective "access codes")
  * or (if present) use the maximum of:
    * a matching auto retention time for the detail (set via //administration -> retention time -> set auto retention time -> <domain>//)
    * an explicitly defined retention time for the detail (via //administration -> retention time -> set retention time -> <domain> -> <source> -> <section>//)
  * or keep the values of the details if they are still needed for aggregation/compression purposes

-----

==== Manually Defined Retention Time ====

As user "AmieAction" 
  * go to //administration -> retention time -> set retention time -> ULS -> testsrv12 -> 200 Continuous Hourly Values//
  * select teststep "240 Files"
  * set days to 3

{|
! detail
! days
! changes
|-
| Spirograph
| 3
| changes
|-
| Spirograph
| 3
| changes
|}

Verify, that the new retention time is applied (**only**) correctly:

  * go to //administration -> retention time -> retention time overview -> ULS -> testsrv12//
  * all details should show 14 days retention time, except the "200 Continuous Hourly Values | 240 Files | Spirograph"

{|
! Test
! Description
! Result
! Notes
|-
| RTIM 010
| manually defined retention time, exactly defined, definition
| style="color:green" | passed
| 
|}

Verify at least 4 days later that the values are deleted.

  * Go to //main menu -> for 7 days -> ULS -> testsrv12 -> 200 Continuous Hourly Values -> 240 Files// (the display of all images takes some time!)
  * verify that the oldest entry is not older than 3 days (plus today).

{|
! Test
! Description
! Result
! Notes
|-
| RTIM 011
| manually defined retention time, exactly defined, effectively working
| style="color:green" | passed
| 
|}
-----

==== Domain-Based Auto-Retention Time ====

As user "SystematicGuy", go to //administration -> retention time -> set auto retention time// 
(domain "Woodlark" is automatically chosen)
and enter:

{|
! section
| 300 Continuous Daily Values
|-
! teststep
| 330 Text Expressions
|-
! days
| 8 (weekly would still work)
|-
! active
| [x]
|}

Verify that the settings have been correctly applied:

  * go to //administration -> retention time -> retention time overview -> Woodlark -> testsrv22//

{|
! detail
! days
|-
| ...
| 
|-
| 300 Continuous Daily Values | 330 Text Expressions | Proportional Expression
| 8
|-
| 300 Continuous Daily Values | 330 Text Expressions | proportional expressions separated by blank line for same time stamp
| 8
|-
| ...
| 
|}

{|
! Test
! Description
! Result
! Notes
|-
| RTIM 020
| domain-based auto-retention time, definition
| style="color:green" | passed
| 
|}

:TODO: Verify 9 days later that these values are deleted:

  * Go to //main menu -> complete -> Woodlark -> testsrv22 -> 300 Continuous Daily Values -> 330 Text Expressions//
  * verify that the oldest entry is not older than 8 days (plus today)

{|
! Test
! Description
! Result
! Notes
|-
| RTIM 021
| domain-based auto-retention time, effectively working
| style="color:green" | :TODO:
| 
|}

-----
==== Group-Based Auto-Retention Time ====

=== (A) Specifications ===

As user "TheSpyder"

  * go to //administration -> retention time -> group auto retention time//

Verify that "TheSpyder" gets the complete list of all groups:
  * AllRounder
  * Databasics
  * Hotliners
  * Systemaniacs

{|
! Test
! Description
! Result
! Notes
|-
| RTIM 011
| group-based auto-retention time: group privileges and separations are applied correctly
| style="color:green" | passed
| 
|}

Reconnect as user "SystematicGuy" (member of group "Systemaniacs" with full rights on domain "Woodlark").

  * go to //administration -> retention time -> group auto retention time//
  * verify that only group "Systemaniacs" is shown and select that group
  * keep all monthly values (for group "Systemaniacs", means: **only** for domain "Woodlark")

{|
! section
| 500*Monthly*
|-
! days
| 55
|-
! active
| [x]
|}

Reconnect as user "TheSpyder" and verify that the settings have been correctly applied:

  * go to //administration -> retention time -> retention time overview -> ULS -> testsrv12//
  * check that the above retention time is **not** applied (still 14 days)

{|
! detail
! days
|-
| ...
|
|-
| 500 Continuous Monthly Values | 520 Float Values | Percentage/%
| 14
|-
| 500 Continuous Monthly Values | 530 Text Expressions | Proportional Expression
| 14
|-
| 500 Continuous Monthly Values | 530 Text Expressions | proportional expressions separated by blank line for same time stamp
| 14
|-
| 500 Continuous Monthly Values | 540 Files | Three Rolling Wheels
| 14
|-
| 500 Continuous Monthly Values | 540 Files | Three Rolling Wheels
| 14
|-
| ...
|
|}

  * go to //administration -> retention time -> retention time overview -> Woodlark -> testsrv22//
  * and check that for domain "Woodlark" (group "Systemaniacs") the retention time **has** been applied

{|
! detail
! days
|-
| ...
|
|-
| 500 Continuous Monthly Values | 510 Integer Values | Ramp
| 55
|-
| 500 Continuous Monthly Values | 520 Float Values | Energy
| 55
|-
| 500 Continuous Monthly Values | 520 Float Values | Normalized Gaussian Distribution/MB/s
| 55
|-
| 500 Continuous Monthly Values | 540 Files | Spirograph
| 55
|-
| 500 Continuous Monthly Values | 540 Files | Spirograph
| 55
|-
| ...
|
|}

{|
! Test
! Description
! Result
! Notes
|-
| RTIM 012
| group-based auto-retention time: specifications are applied correctly
| style="color:green" | passed
| 
|}

Verify after the number of days (more than 55), that the values have been kept for that time 
and all older values are deleted. 

{|
! Test
! Description
! Result
! Notes
|-
| RTIM 013
| group-based auto-retention time: correct operation (keep the specified)
| style="color:green" | :TODO:
| 
|}

Verify, that all monthly teststeps for domain "ULS" are deleted after the default time interval.

{|
! Test
! Description
! Result
! Notes
|-
| RTIM 014
| group-based auto-retention time, correct operation (cleanup the default)
| style="color:green" | :TODO:
| 
|}

=== (B) Change ===

:TODO:
Change the specs to something else

=== (C) Removal ===

:TODO: remove the specs

-----

==== Examination of Retention Settings ====

Mainly, this is the check whether values have been correctly deleted after the elapsed retention time.

See the above sections for the different verifications.

-----

==== Setting Retention for Compressed Values ====

  * edit systemvariables (retention time for compressed)

:TODO:

-----
==== Manually Defined Retention for Compressed Values ====

:TODO:

-----

==== Domain-Based Auto-Retention for Compressed Values ====

:TODO:

-----

==== Group-Based Auto-Retention for Compressed Values ====

:TODO:

-----

==== Examination of Retention Settings for Compressed Values ====

Mainly, this is the check whether values have been correctly deleted after the elapsed retention time.

:TODO:

-----