User Scenarios

The Administrator needs to configure some of the setting of the client service, especially in case of a load balanced environment. In a load balanced environment, the client service should not restart the AVEVA Work Tasks services at the same time in all boxes.

The Administrator also needs to configure the scheduling time as it is recommended to schedule the restart at a low usage time.

Administrator wants to change the restart schedule time settings for the WarningMemory limit

If the Administrator wants to set night 2 AM as the restart time for the warning memory, then the Administrator can change the value to the desired timing in the WarningMemory configuration section of the default section. This will affect settings of all services as they are using the default settings.

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

The Client service monitors the AVEVA Work Tasks service. The Client service will start monitoring the Warning memory limit at the configured time, that is 2AM.

At night 2AM, the WF engine shows a memory above 800MB for more than 10 minutes. The Client service will restart the WF engine and its dependent services. The Client service immediately stops the Communication Service, Task Scheduler, and WF engine and then starts these services again.

Administrator wants to change the restart schedule time settings for the Warning Memory limit only for WF Engine service.

The Administrator wants to set night 12 AM as the restart time for the warning memory for WF engine. For the remaining services, the administrator wants the default values for the settings.

In order to do this, the Administrator has to create the WarningMemory configuration section for the WF Engine and change the value to a desired timing. This same scenario holds good for CriticalMemory too.

<DefaultConfig MonitorService="true">

      <CriticalMemory MemoryLimitInMB="700"/>

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

    </DefaultConfig>

    <ServiceConfig Name="AdvancedService" />

   

    <ServiceConfig Name="WFEngine">

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

    </ServiceConfig>

    <ServiceConfig Name="TaskScheduler" />

    <ServiceConfig Name="CommunicationService" />

Administrator wants to restart Services on the night of 25th of every month.

There are a bunch of monthly scheduled workflows to execute for salary processing on the 25th of every month. For faster processing, the process needs more memory.

The Administrator wants to restart the services before executing the workflows, so that more memory is available for the process.

The Administrator can even set the timing for a monthly maintenance.

<MaintainanceRestart RestartAt="01:00" WeeklyRestartDays="" MonthlyRestartMonths="All" MonthlyrestartDates="25"/>

         

On the 25th of every month, when the time is 1AM, the following services are automatically stopped and restarted in the order specified below.

1. Advance service

2. Workflow Engine

3. Task Scheduler service

4. Communication services

If SendAlertEmails= "true", then an email is sent to the configured email.

Administrator has configured all services for the load balanced environment. Administrator wants to have monitoring of service in load balanced environment.

In a load balanced environment, monitoring of service will also happen. Client service will monitor all AVEVA Work Tasks services which are in the same box. During Maintenance monitoring, in the load balanced environment, all services might be restarted at the same time if the scheduled timing is same. Ensure that all the services are not stopped at the same time in all the boxes.

This can be avoided by scheduling the Maintenance monitoring at different time in all boxes.

You can provide a gap of 15 minutes in scheduling time in all boxes.

The same applies for the WarningMemoryLimit too.

Administrator wants to disable sending of Alert emails

If the Administrator does not want to receive monitoring alert emails regularly, then the Administrator can disable sending of alert emails by changing the value for SendAlertEmails to False. Alert emails will not be sent.

Administrator wants to change Memory limit for the Critical memory setting

For WF engine, memory limit for the critical memory settings is 700 MB. The Administrator wants to change it to 1000 MB as the server machine is configured for the process virtual address space more than 2 GB.

For more information about the Memory Size of the process, check in the section Process Memory Calculation.

The Administrator can change the value to 1000 MB in the Workflow Engine section.

<ServiceConfig Name="WFEngine" ServiceName="AVEVA Work TasksWorkflow2"

               ProcessName="WFEngine.NET2"        MonitorService="true">

      <CriticalMemory MemoryLimitInMB="1000"/>

      <WarningMemory MemoryLimitInMB="500" TimeLimitInMinutes="10"

               RestartAt="01:00"/>

</ServiceConfig>

Whenever the Workflow Engine process memory reaches 1000 MB, the Workflow Engine service is stopped. Therefore, its dependent services, Task Scheduler, and Communication Service are also stopped.

Task Scheduler, Workflow Engine and Communication service are started.

Administrator wants to change Memory limit for the Warning memory setting

If the administrator wants to set the memory limit for the warning memory, the Administrator has to access the specific process section like Workflow Engine section and change the values as mentioned below:

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

The Client service will start monitoring the Warning memory limit at night 2 AM. If the process memory is above 800 MB at that time, it will note it down and continue monitoring for the next 10 minutes (TimeLimitInMinutes configuration). If the process memory is above 800 MB even after 10 minutes, then the Client service will restart the process along with its dependent services.

For the Warning memory limit, Administrator wants to change TimeLimitInMinutes section.

TimeLimitInMinutes is the configuration setting which defines the time duration (time range) for which the process needs to be in warning memory limit phase to restart the service. If the Administrator wants  this configuration then the process needs to be running for at least 15 minutes with a warning memory limit of 800 MB at night 2:00 AM, to restart. Then the configuration setting must be as given below:

<WarningMemory MemoryLimitInMB="800" TimeLimitInMinutes="15" RestartAt="02:00"/>

Administrator wants to restart services on every Saturday and Sunday night as part of maintenance.

The Administrator can provide the following configuration:

<MaintainanceRestart RestartAt="01:00" RestartDay="Sat,Sun" MonitorService="true"/>

The services are restarted every Sunday night at 1 AM.

Administrator wants to restart the services on every Sunday as well as on the 25th of every month.

The Administrator can provide the combination of monthly as well as daily configuration. If the Administrator wants to start the service on every weekend as well as on the 25th of every month, then the configuration can be provided as follows:

<MaintainanceRestart RestartAt="01:00" WeeklyRestartDays="Sun" MonthlyRestartMonths="All" MonthlyrestartDates="25"/>

Administrator wants to disable Maintenance monitoring for all service.

The Administrator can disable Maintenance monitoring of services on specific days where there might not be high load workflow execution.

To disable Maintenance monitoring, the administrator has to comment or remove the "MaintenanceRestart" attribute.

Administrator does not want monitoring of specific service.

If the Administrator does not want to monitor a service, then the Administrator can configure the value of the "MonitorService" attribute of that service to "false".

By setting the value of "MonitorService" to "false", the following features are disabled:

• MaintenanceRestart monitoring of service is stopped.

• CriticalMemory limit monitoring of service is stopped.

• WarningMemory limit monitoring of service is stopped.

If the AVEVA Work Tasks service is stopped, it will not be automatically started by the Client service.

The Client service start or stop events will not have any affect on start or stop of the remaining AVEVA Work Tasks service.

Administrator wants to change the memory calculation rule

By default, the memory calculation of the AVEVA Work Tasks process is done based on the Performance Monitor attribute "PrivateMemorySize64".

The "PrivateMemorySize64" attribute provides the value of the total memory held in the process. For more information about memory of process, check the Process Memory Calculation section.

If the Administrator includes the "WorkingSet64", then the value will be: 

<MemoryCalcRule>WorkingSet64 + PrivateMemorySize64 </MemoryCalcRule>

If the Administrator wants to use VirtualMemorySize64 instead of PrivateMemorySize64, then the configuration will be:

<MemoryCalcRule>VitualMemorySize64 </MemoryCalcRule>

Administrator wants to start all services a with single click.

The AVEVA Work Tasks Windows service can now be started and/or stopped automatically.

If the Client service is started, all its dependent services such as the Advanced service, Communication services, Task scheduler, and Workflow Engine are started in the specified sequence.

Similarly, if it is stopped, all its dependent services such as the Advanced service, Communication services, Task Scheduler and Workflow Engine are stopped in the specified sequence.

Administrator wants to stop all services.

The Administrator may want to stop all the AVEVA Work Tasks Windows services for maintenance or for other reasons. The Client service will have the feature of automatically stopping all the services. Hence, the administrator can stop the client service which will in turn stop all other services such as the Advanced service, Workflow Engine, Task Scheduler and Communication services are stopped in the specified sequence.

Administrator wants Communication service to be stopped.

The Administrator wants to stop Communication service as part of maintenance or for other reasons, but wants the remaining services to continue execution. The administrator does not want the Communication service to be automatically started.

In other words, the Communication service should not be monitored.

For any service to be excluded from monitoring, set the value of the "MonitorService" attribute to "false", under the specific "serviceconfig" section.

Administrator has changed the startup type of client service from automatic to manual.

On machine restart, the Client service will not be automatically started. However, the remaining AVEVA Work Tasks services are automatically started. The Administrator needs to manually start the Client service to monitor the remaining Services.