From 76c933254108f2e6637c9b5706e6033ad262887d Mon Sep 17 00:00:00 2001
From: Ace <ruwany.ace@gmail.com>
Date: Mon, 7 Dec 2020 14:00:26 +0530
Subject: [PATCH] Added disclaimer to heart-beat-config

---
 .../main/resources/conf/heart-beat-config.xml | 21 +++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/features/heartbeat-management/io.entgra.server.heart.beat.feature/src/main/resources/conf/heart-beat-config.xml b/features/heartbeat-management/io.entgra.server.heart.beat.feature/src/main/resources/conf/heart-beat-config.xml
index 814f2f1163b..59b17614deb 100644
--- a/features/heartbeat-management/io.entgra.server.heart.beat.feature/src/main/resources/conf/heart-beat-config.xml
+++ b/features/heartbeat-management/io.entgra.server.heart.beat.feature/src/main/resources/conf/heart-beat-config.xml
@@ -19,7 +19,28 @@
   -->
 
 <HeartBeatBeaconConfig>
+    <!--
+     ~  Only to be turned on in distributed mode, in which case
+     ~  Dynamic Partitoned Task, Randomly Assigned Task modes will be activated.
+     ~  These modes are deviations from the regular worker manager mode, in which the server will function.
+     ~
+     ~   * DynamicPartitionedScheduleTask -> Tasks will execute on all nodes but will only focus on a subset of operations
+     ~      broken up amongst active nodes based on following parameters that are made available via DynamicTaskContext abstract class.
+     ~      - serverHashIndex : dynamic index assigned to each server based on number of active servers present
+     ~      - activeServerCount : total no. of active servers present at a given time
+     ~      - partitioningEnabled : whether or not heart-beat-config/dynamic task config is enabled.
+     ~      Any task extending the DynamicPartitionedScheduleTask class will inherit the above variables.
+     ~      These can then be used to split up the no. of devices said node is allocated with.
+     ~
+     ~   * RandomlyAssignedScheduleTask -> Tasks will only execute on a particular node elected at a time interval determined by ServerTimeOutIntervalInSeconds, parameter.
+     ~      When running tasks in this mode, it is mandatory that each task be given a unique name, so as not to run in to scenarios where tasks execution is duplicated.
+     ~      Each node, on a periodic basis will check to see if it is qualfied to execute the random task, if the following variable is true only said node will execute the task.
+     ~      - qualifiedToExecuteTask : dynamic index assigned to each server based on number of active servers present
+     ~      Any task extending the RandomlyAssignedScheduleTask class will inherit the above variable.
+     ~      Note that random task may execute on any node.
+     -->
     <Enable>false</Enable>
+    <!-- Heart Beat Data Source Name, this should be either MySQL, PostGreSQL, Oracle or MSSQL -->
     <DataSourceConfiguration>
         <JndiLookupDefinition>
             <Name>jdbc/HeartBeat_DS</Name>