Merge pull request SkylineCommunications#3443 from wdm-slc/CorrelationAutomation

Correlation data in Automation: update for AlarmTreeID

Author: MariekeGO

user-guide/Advanced_Modules/Automation_module/FAQ/How_do_I_parse_Correlation_Alarm_Info_data.md

@@ -37,4 +37,7 @@ for (int i=0; i<amountProperties; i++)
     string propertyValue = parts[21 + i*2 + 1];
     engine.GenerateInformation("Property " + propertyName + " == " + propertyValue);
 }
+
+// from DataMiner 10.4.9/10.5.0 onwards, use the ID below to refer to the alarm tree
+AlarmTreeID treeId = new AlarmTreeID(dmaID, elementID, rootAlarmID);
 ```

user-guide/Advanced_Modules/Automation_module/Special_parameters_available_in_DMS_Automation_scripts.md

@@ -15,7 +15,7 @@ The following table lists the special parameters available in Automation scripts
 | \<Redundancy Type> | 65003 | The type of redundancy group switch (only if the execution of the script was caused by a redundancy group switch).<br> Values:<br> -  SWITCH_OVER<br> -  SWITCH_BACK |
 | \<Redundancy Cause> | 65004 | The cause of a redundancy group switch (only if the execution of the script was caused by a redundancy group switch).<br> Values:<br> -  prioritychanged<br> -  manual<br> -  automatic |
 | \<Correlation State> | 65002 | Whether the Correlation rule was triggered because the trigger condition matched the alarm (“up”) or whether it was triggered because the trigger condition no longer matched the alarm (“down”) (only if the script was executed via a Correlation rule).<br> Values:<br> -  up<br> -  down |
-| \<Correlation Alarm ID> | 65005 | The ID of the alarm that triggered the Correlation rule (only if the script was executed via a Correlation rule). |
+| \<Correlation Alarm ID> | 65005 | [Obsolete] The ID of the alarm that triggered the Correlation rule (only if the script was executed via a Correlation rule). Avoid using this value. Extract the full alarm tree reference from \<Correlation Alarm Info> (65006) instead. |
 | \<Correlation Alarm Info> | 65006 | A pipe-separated string containing information about the alarm that triggered the Correlation rule (only if the script was executed via a Correlation rule):<br>*0:alarmId\|1:agentId\|2:elementId\|3:parameterId\|4:parameterIdx\|5:rootAlarmId\|6:previousAlarmId\|7:severity\|8:type\|9:status\|10:alarmvalue\|11:alarmTime\|12:serviceRca\|13:elementRca\|14:parameterRca\|15:severityRange\|16:sourceId\|17:userStatus\|18:owner\|19:impactedServices\|20:propertyCount\|propcount\*2\|scriptNamevt0:alarmId\|1:agentId\|2:elementId\|3:parameterId\|4:parameterIdx\|5:rootAlarmId\|6:previousAlarmId\|7:severity\|8:type\|9:status\|10:alarmvalue\|11:alarmTime\|12:serviceRca\|13:elementRca\|14:parameterRca\|15:severityRange\|16:sourceId\|17:userStatus\|18:owner\|19:impactedServices\|20:propertyCount\|propcount\*2\|scriptName*<br> For an example of how to parse the information in this string, see [How do I parse Correlation Alarm Info data?](xref:How_do_I_parse_Correlation_Alarm_Info_data) |
 
 > [!NOTE]