Scheduler - Configuration File Flags (Magic xpi 3.x)
You can change the behavior of scheduled flows regardless of how they are programmed in the Magic xpi Studio.
|
|
DisableScheduler=
|
This flag will turn off all scheduled activities.
Type Y after the equal sign (=) to turn off the scheduler. If this flag is Y, any schedules that you defined in the Magic xpi Studio are disabled. By default, the flag is set to N, which indicates that the scheduler is turned on.
If this is set to Y, you must start any scheduled flows manually. This is often used in a testing environment when you want to control when flows are invoked.
When you shut down the Magic xpi Server, some scheduler records may exist. These flags are added to the ifs.ini file to allow you to define if these records should be retained when you reload the Magic xpi Server.
|
SchedulerPersistency=
|
This flag determines whether the Server saves the Scheduler records in a memory table and not in the internal database.
Type Y after the equal sign (=) to save the Scheduler records in a memory table. By default, the flag is set to N.
|
SchedulerStartupRetainMode=
|
This flag indicates what type of scheduler records are retained at Server startup:
-
Service: Only records created by services, such as Invoke Flow Delay and Schedule Flow, are retained.
-
Trigger: Only the Scheduler Day, Week, Month, and Interval records are retained.
-
All: Both Services and Scheduler records are retained.
-
None (default): No records are retained.
|
SchedulerStartupRetainPeriod=
|
This flag indicates whether past, future, or all records are retained:
-
Past: Retains records with an execution date that is earlier than the current date. If you choose to save past records, when the Server restarts, any past records that have not yet been executed will be executed immediately.
-
Future: Retains records with an execution date that is later than the current date.
-
All (default): Both past and future records are saved.
|
During runtime, the Server reads both the SchedulerStartupRetainMode= and SchedulerStartupRetainPeriod= flags and determines whether scheduler records should be deleted or saved when the particular Magic xpi Server is restarted. This is necessary when the Magic xpi Server shuts down abnormally, for example if a machine crashes, because some Scheduler records may still exist. You can determine what records to save, if any, so that you can reuse them after a system crash. The scheduler records are saved in a memory table, which in turn is saved in a file called <projectname>.srcv. These flags are in the [MAGIC_IBOLT] section.
For example, if the .ini file contains these two lines in the [MAGIC_IBOLT] section:
SchedulerStartupRetainMode = Service
SchedulerStartupRetainPeriod = Future
When the Server restarts, all records from the previous session of the Server will be deleted except for records created by the Invoke Flow Delay or Schedule Flow services and that are set to be executed in the future.
|