Merge pull request #54 from devfabiosilva/Documentation-for-PDR-337---Improvements-for-lightweight-WITSML-realtime-requests-on-Liverig-collector

WITSML Change Mechanism new feature documentation

Author: amadeubarbosa

collector/configuration/liverig.properties.md

@@ -68,7 +68,14 @@
 | `enable_witsml_tree_event` <br> **This Property was removed on Liverig 2.22.0**                                                                                                                                                                                                                                                                    | `boolean`  | `true`                               | 2.17.0 |           |                                                                                                          |                          |
 | `witsml_tree_event_period_seconds` <br> **This Property was removed on Liverig 2.22.0**                                                                                                                                                                                                                                                            |   `long`   | `600`                                | 2.17.0 |     s     |                                                                                                          |                          |
 | `wildcard_period_in_seconds` <br> Sets the Wildcard Period if the Request does not contain it.                                                                                                                                                                                                                                                     |   `int`    | `600`                                | 2.22.0 |     s     |                                                                                                          |                          |
-| `enable_revision`                                                                                                                                                                                                                                                                                                                                  | `boolean`  | `false`                              | 2.24.1 |           |                                                                                                          |                          |
+| `witsml_change_mechanism_feature` <br> Enables a mechanism for identifying change for data objects in a WITSML server | `boolean` | `false` | 5.17.x |||||
+| `witsml_change_mechanism_delay_period_in_seconds` <br> The number of seconds for the client to detect a change in a growing data object. | `int` | `0` | 5.17.x |s||`witsml_change_mechanism_feature` = true||
+| `witsml_change_mechanism_detection_period_in_seconds` <br> The number of seconds for the client delayed to start | `int` | `10` | 5.17.x |s||`witsml_change_mechanism_feature` = true||
+| `witsml_change_mechanism_initial_last_change_feature` <br> Enables the use of a default initial lastChange when starts the feature | `boolean` | `true` | 5.17.x |||`witsml_change_mechanism_feature` = true||
+| `witsml_change_mechanism_late_channels_feature` <br> Allows to collect channels that arrive with low-frequency samples | `boolean` | `false` | 5.17.x |||`witsml_change_mechanism_feature` = true||
+| `witsml_change_mechanism_object_growing_feature` <br> Enables the use of object-growing queries when there aren't changed objects | `boolean` | `false` | 5.17.x |||`witsml_change_mechanism_feature` = true||
+| `witsml_change_mechanism_initial_last_change_in_minutes` <br> The number of minutes before now for use as the default last change for an initial request | `int` | `1440` | 5.17.x | minutes ||`witsml_change_mechanism_feature` = true||
+`enable_revision`                                                                                                                                                                                                                                                                                                                                  | `boolean`  | `false`                              | 2.24.1 |           |                                                                                                          |                          |
 | `enable_revision_offset`                                                                                                                                                                                                                                                                                                                           | `boolean`  | `false`                              | 2.25.0 |           |                                                                                                          |                          |
 | `log_rotate_hour` <br> Sets the hour of day to rotate Event logs.                                                                                                                                                                                                                                                                                  |   `int`    | `4`                                  | 2.18.1 |           |                                                                                                          |                          |
 | `minimum_diskspace_in_megabytes` <br> Minimum available disk space required to collector work properly. The collector is restarted whenever the available disk space is less than the minimum required.                                                                                                                                            |   `int`    | `20`                                 | 2.24.0 |    MB     |                                                                                                          |                          |   
@@ -134,4 +141,13 @@ wildcard_period_in_seconds=600
 # crystalfontz_port=/dev/ttyLCD
 # crystalfontz_baud=115200
 
+# WITSML Change mechanism features
+#
+# witsml_change_mechanism_feature=false
+# witsml_change_mechanism_delay_period_in_seconds=0
+#witsml_change_mechanism_detection_period_in_seconds=10
+# witsml_change_mechanism_initial_last_change_feature=true
+# witsml_change_mechanism_late_channels_feature=false
+# witsml_change_mechanism_object_growing_feature=true
+# witsml_change_mechanism_initial_last_change_in_minutes=10
 ```