Preventing Task Plans From Running
This page is for data modellers, application designers and system administrators. It explains how to stop task plans running during system maintenance.
Overview
During upgrade and maintenance, you may want to run your PhixFlow instance whilst preventing task plans from running. There are two options you can use to achieve this:
- Prevent users starting task plans and other actions, see Restricting Access During System Maintenance. This depends on user permissions.
- Prevent scheduled task plans from starting.
Disabling Scheduled Task Plans
You can disable scheduled task plans:
- from within PhixFlow, using the System Configuration → Advanced → Disable Scheduled Tasks
- without logginging into PhixFlow, using the
server.properties
filedisableScheduledTasks=false
option.
Only disable scheduled task plans if it is essential. Restore scheduled task plans to being able to run as soon as possible.
Task plans do not run retrospectively when the option is cleared. You must manually start any tasks plans that missed their scheduled start time.
From Within PhixFlow
To disable all scheduled task plans, in system configuration tick Disable Scheduled Tasks. As long as this option is ticked scheduled task plans will not start. Scheduled task plans that are already running are not affected.
To allow scheduled task plans to run again, untick Disable Scheduled Tasks.
Before Restarting PhixFlow
To disable all scheduled task plans:
- Edit the file
tomcat\webapps\<phixflow installation directory>\WEB-INF\classes\server.properties
- Set
disableScheduledTasks=true
- Restart PhixFlow.
- Disable Scheduled Tasks is automatically ticked.
- Scheduled task plans do not run.
Setting server.properties disableScheduledTasks=true
whilst PhixFlow is running has no effect. PhixFlow must be restarted. Once PhixFlow is running, it uses Disable Scheduled Tasks to decide whether or not to run scheduled task plans.
To allow task plans to run again:
- Set the
server.properties
filedisableScheduledTasks=false
You must do this because:- clearing the Disable Scheduled Tasks check box does not change the setting in
server.properties
file - the next time the server restarts, scheduled task plans will run as normal.
- clearing the Disable Scheduled Tasks check box does not change the setting in
- Log into PhixFlow.
- In system configuration untick Disable Scheduled Tasks.
This restarts the scheduled task plans.
Setting disableScheduledTasks=false
then restarting the server does not untick Disable Scheduled Tasks.