Configuration Settings

The entire Service monitoring configuration is mentioned in the file ServiceMonitoring.xml. See the comment sections of ServiceMonitoring.xml to know the specification of each attribute.

By default, the AppConstants section is commented.

<?xml version="1.0" encoding="UTF-8"?>

<!--“” The services are not monitored if the config file is not present, or if the value of the “ServiceMonitoringEnabled” attribute is set to “false”, or if the config file throws an invalid format(syntax) error. Alert emails are sent if the value of the “SendAlertEmailsEnabled” attribute is set to “true", or if the “SendAlertEmailsEnabled” attribute is not present or has an invalid value.-->

-<SMConfig SendAlertEmailsEnabled="true" ServiceMonitoringEnabled="true">

<!--DO NOT CHANGE AppConstants. The AppConstants are used for internal processing and are commented out by default. -->

<!-- <AppConstants> <!- The frequency (in seconds) at which the client service monitors the memory of the services. By default, the client service will check the other BPM services every ten seconds.-> <TimerIntToMonitor>10</TimerIntToMonitor> <!-The frequency (in seconds) at which the client service checks if all the services are installed.->

<TimerIntToCheckServicesInstalled>60</TimerIntToCheckServicesInstalled> <!-Time (in seconds) to wait for the status of a service to be changed from “stop pending” to “stopped”.-> <WaitTimeForStopPendingStatus>300</WaitTimeForStopPendingStatus> <!-Time (in seconds) to wait for the status of a service to be changed from “start pending” to “running” . ->

<WaitTimeForStartPendingStatus>15</WaitTimeForStartPendingStatus> <!-Time (in seconds) to wait between the stop and start of services. >

<SleepTimeBeforeStartStop>30</SleepTimeBeforeStartStop> <!-For the Workflow Engine, the frequency (in minutes) to monitor the thread lock behavior. ->

<WFEngineThreadScanInterval>10</WFEngineThreadScanInterval> <!-The number of threads that can be in the “locked” state, defined as a percentage value. -> <WFEngineThreadThresholdValue>70</WFEngineThreadThresholdValue> <!-This flag enables logging of all the debug messages related to Client Service Monitoring behavior in the AVEVA Work Tasks logger. The default value is False.-> <EnableDebugLogMessages>false</EnableDebugLogMessages> </AppConstants> -->

<!-- DO NOT CHANGE MemoryCalcRule. The memory calculation rule can be based on Performance Monitor attributes such as PrivateMemorySize64, WorkingSet64, VirtualMemorySize64, and PagedMemorySize64 of the AVEVA Work Tasks processes. The rule can have any one of or a combination of these attributes. E.g.: PrivateMemorySize64 + WorkingSet64. “PrivateMemorySize64” can be used to measure process memory. The "PrivateMemorySize64" attribute is considered by default, for monitoring, if the MemoryCalcRule attribute is not present. -->

<MemoryCalcRule Rule="PrivateMemorySize64"/>

<!-- "MaintainanceRestart" is the time at which all the services can be restarted. "RestartAt" is the time at which the services need to be restarted. Specify the value in the 24 hours format. E.g.: 23:00

"WeeklyRestartDays" is the week day(s) on which the services need to be restarted. Specify the value as first 3 letters of the day, separated by comma. E.g.: Sun,Mon,Tue,Wed,Thu,Fri,Sat Specify the value as “All” if the services need to be restarted on all days. E.g.: All

"MonthlyRestartMonths" is the month on which the services need to be restarted. Specify the value for “MonthlyRestartMonths” as the first 3 letters of a month. E.g.: Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec Specify “All” if you want to monitor the services for all the months. E.g.: All

"MonthlyRestartDates" is the date on which the services need to be restarted. Ensure that you configure both the attributes together. Specify the value for “MonthlyRestartDates” attribute as comma separated dates. E.g.: 29,30,1,2,3

If the values for both weekly and monthly attributes are mentioned, then the services will be restarted on both the days. If no attributes are mentioned or “MaintainanceRestart” attribute is not present, then the maintenance monitoring does not happen. Example of Maintenance restart: <MaintainanceRestart RestartAt="00:00" WeeklyRestartDays="Sat,Sun" MonthlyRestartMonths="All" MonthlyRestartDates="1"/> -->

<!--<MaintainanceRestart RestartAt="" WeeklyRestartDays="" MonthlyRestartMonths="" MonthlyRestartDates=""/>-->

<!-- If the “DefaultConfig” and “ServiceConfigs” nodes are not present, then the system will monitor for the CriticalMemory of all AVEVA Work Tasks Services, with default values. For the Workflow engine, the thread hanging behavior is also monitored. The default CriticalMemory limit for a 64-Bit machine is 1500MB. -->

-<ServiceConfigs>

<!--For DefaultConfig, if the values for MonitorService, CriticalMemory, and WarningMemory attributes are not mentioned for a service, then the default values for these attributes are considered.

E.g.: To change the values for the Workflow Engine service, specify the attribute values as follows:

<ServiceConfig Name="WFEngine" MonitorService="true"> <CriticalMemory MemoryLimitInMB="1000"/>

<WarningMemory MemoryLimitInMB="800" TimeRangeInMinutes="10" RestartAt="00:00"/>

</ServiceConfig>

If the value of the “MemoryLimitInMB” attribute is zero, then the services will not be monitored. If you do not want a service to be monitored, then set the value of the “MontiorService” attribute for that specific service to “false”. -->

-<DefaultConfig MonitorService="true">

<!--<CriticalMemory MemoryLimitInMB="1000"/>-->

<!--<WarningMemory MemoryLimitInMB="0" TimeRangeInMinutes="10" RestartAt="00:00"/>-->

</DefaultConfig>

<ServiceConfig Name="AdvancedService"/>

<ServiceConfig Name="WFEngine"/>

<ServiceConfig Name="TaskScheduler"/>

<ServiceConfig Name="CommunicationService"/>

<ServiceConfig Name="ArchestrAMobileNotificationService"/>

</ServiceConfigs>

</SMConfig>