HealthCheck Assistance
The Health Check allows for custom thresholds and configurations to be configured. This allows the "master" configuration to be retained during upgrades and the overrides maintained. This also allows the configuration to be returned to its "default" without manipulating the master configuration.
Use this file to override either configurations and/or thresholds.
Copy the setting or threshold from C:\HealthCheck_v4\configurables\hc-custom_config.ps1 and paste it into hc-upgrade_customisations.ps1, changing the value to the desired option.
It is highly recommended to date the changes. When pasting a setting as shown below, the line above about be:
# 20260115 - Override implemented
An example is:
Enabling a setting:
For example: If MS-Teams webhook has been configured and then to enable it hc-custom_config.ps1, is as below:
$global:HC_Customer_MSTeams_Configuration = $false # Set to $true to allow customers to receive MS-Teams notificatiosn if configured (Default: $false)
Copy the entire line and then paste it below this note section and change the value to $true
$global:HC_Customer_MSTeams_Configuration = $true # Set to $true to allow customers to receive MS-Teams notificatiosn if configured (Default: $false)
Changing a threshold:
For example: If buddy queue critical threshold needs increasing. Find the threshold in hc-custom_config.ps1, is as below:
[int]$global:HC_Threshold_Buddy_Queue_Critical = 5000 # Set the threshold to check the buddy queue (Default: 5000)(hc_suite_status_enps_queues)
Copy the entire line and then paste it below this note section and change the value to $true
[int]$global:HC_Threshold_Buddy_Queue_Critical = 10000 # Set the threshold to check the buddy queue (Default: 5000)(hc_suite_status_enps_queues)
Log into the console using an account with administration privileges.
Navigate to C:\HealthCheck_v4\configurables\ and create a file with the name: hc-upgrade_customisations.ps1
(If there is a file called hc-upgrade_customisations-example.ps1 in the same folder, simply rename it to hc-upgrade_customisations.ps1 and edit it).
Look in the C:\HealthCheck_v4\configurables\hc-custom_config.ps1 for the setting to enable or threshold to change.
Paste it into the C:\HealthCheck_v4\configurables\hc-upgrade_customisations.ps1
Change the value after the "=" sign. Ensure the variable name is not amended.
For $true and $false, options it can only be one or the other.
For numerical thresholds, it can be changed to the required figure.
Save the file once all the amendments are completed.
The HealthCheck will detect this file and implement the overrides, no further configuration is required.
NOTE: If you have any questions, please contact AP ENPS Support before upgrading the system.