Difference between revisions of "Planning"

From Dafne documentation
Jump to navigation Jump to search
Line 1: Line 1:
−
<strong>Planning</strong> is an activity to prepare a processing based on a scenario definition.
+
== Planning Overview ==
  
−
Planning consists of several steps:
+
Planning is the process of preparing and setting up processing tasks based on a scenario definition. This activity involves several key steps to ensure tasks are scheduled and executed correctly.
−
* Waiting for planning event - planning event is defined by Scenario planning mode setting; it can be time-based, file-based or other types, see in [[Scenario]]
 
−
* Retrieve processing parameter values - user-defined parameters (see in [[Parameter]]) are evaluated; specifically the parameters their value is defined by a database query. Only parameters used by a scenario tasks are evaluated, e.g. parameters not used by the scenario are not evaluated.
 
−
* Schedule tasks for execution - all valid tasks (for task validity see [[Task]]) are scheduled in the resulting [[Processing]] waiting to start their execution. Until the planning activity is finished, no task is started
 
−
* Notify operators - if Start scenario operator is selected, notification is sent
 
  
−
== Time-based planning ==
+
== Steps in the Planning Process ==
−
Scenarios set to Daily planning mode uses a time-based events as a planning driver. This planning mode uses time-based planning trigger with the following conditions:
+
 
−
* all previous instances (dates) finished
+
# '''Waiting for a Planning Event''' 
−
* if based on previous processing, trying to run for a date next to the last finished
+
  A planning event is triggered based on the scenario planning mode setting. This event can be one of the following types:
−
* if based on calendar processing, trying to run for current day
+
  * Time-based
−
* consider holiday based on internal calendar information (see [[Calendar]])
+
  * File-based 
−
* consider Lag setting - for example a Lag setting of 1 means the processing of 2.1.2025 will start no sooner than on 3.1.2025
+
  * Other types (as defined in [[Scenario]])
−
* consider Scenario validity based on validity dates
+
 
 +
# '''Retrieving Processing Parameter Values''' 
 +
  User-defined parameters (refer to [[Parameter]]) are evaluated. Specifically, parameters whose values are defined by database queries will be evaluated. Only those parameters that are used by the scenario tasks will be evaluated. Parameters that are not part of the scenario will not be considered during this step.
 +
 
 +
# '''Scheduling Tasks for Execution''' 
 +
  All valid tasks (see [[Task]] for task validity) are scheduled to be executed as part of the resulting [[Processing]]. These tasks are queued and await execution. No tasks will begin until the planning activity is complete.
 +
 
 +
# '''Notifying Operators''' 
 +
  If the "Start scenario" operator is selected, a notification will be sent to the designated operators, informing them that the scenario has been triggered.
 +
 
 +
== Time-Based Planning ==
 +
 
 +
In scenarios set to '''Daily Planning Mode''', time-based events act as the primary driver for planning. This mode uses the following conditions to trigger planning events:
 +
 
 +
* '''Completion of Previous Instances:''' 
 +
  The current planning event will only trigger if all previous instances (dates) of the scenario have completed.
 +
 
 +
* '''Date-based Processing:''' 
 +
  * If the scenario is based on previous processing, it will attempt to trigger the next instance for the day following the last completed one.
 +
  * If the scenario is based on calendar processing, it will attempt to trigger for the current day.
 +
 
 +
* '''Holiday Considerations:''' 
 +
  Planning will take into account holidays based on internal calendar information. (See [[Calendar]] for more details.)
 +
 
 +
* '''Lag Settings:''' 
 +
  The Lag setting defines a delay between the current processing and its execution. For example, a Lag setting of 1 means that processing scheduled for 2nd January 2025 will start no sooner than 3rd January 2025.
 +
 
 +
* '''Scenario Validity Dates:''' 
 +
  The scenario's validity period is taken into account. If the scenario has defined validity dates, planning will only proceed within that period.
 +
 
 +
== Additional Notes ==
 +
 
 +
* '''Scenario Planning Modes:''' 
 +
  For further details on the different scenario planning modes (time-based, file-based, etc.), refer to the [[Scenario]] page.
 +
 
 +
* '''Task Validity:''' 
 +
  For detailed information on what constitutes a valid task and how they are evaluated, see the [[Task]] documentation.

Revision as of 15:34, 6 March 2025

Planning Overview

Planning is the process of preparing and setting up processing tasks based on a scenario definition. This activity involves several key steps to ensure tasks are scheduled and executed correctly.

Steps in the Planning Process

  1. Waiting for a Planning Event
  A planning event is triggered based on the scenario planning mode setting. This event can be one of the following types:
  * Time-based  
  * File-based  
  * Other types (as defined in Scenario)
  1. Retrieving Processing Parameter Values
  User-defined parameters (refer to Parameter) are evaluated. Specifically, parameters whose values are defined by database queries will be evaluated. Only those parameters that are used by the scenario tasks will be evaluated. Parameters that are not part of the scenario will not be considered during this step.
  1. Scheduling Tasks for Execution
  All valid tasks (see Task for task validity) are scheduled to be executed as part of the resulting Processing. These tasks are queued and await execution. No tasks will begin until the planning activity is complete.
  1. Notifying Operators
  If the "Start scenario" operator is selected, a notification will be sent to the designated operators, informing them that the scenario has been triggered.

Time-Based Planning

In scenarios set to Daily Planning Mode, time-based events act as the primary driver for planning. This mode uses the following conditions to trigger planning events:

  • Completion of Previous Instances:
  The current planning event will only trigger if all previous instances (dates) of the scenario have completed.
  • Date-based Processing:
  * If the scenario is based on previous processing, it will attempt to trigger the next instance for the day following the last completed one.
  * If the scenario is based on calendar processing, it will attempt to trigger for the current day.
  • Holiday Considerations:
  Planning will take into account holidays based on internal calendar information. (See Calendar for more details.)
  • Lag Settings:
  The Lag setting defines a delay between the current processing and its execution. For example, a Lag setting of 1 means that processing scheduled for 2nd January 2025 will start no sooner than 3rd January 2025.
  • Scenario Validity Dates:
  The scenario's validity period is taken into account. If the scenario has defined validity dates, planning will only proceed within that period.

Additional Notes

  • Scenario Planning Modes:
  For further details on the different scenario planning modes (time-based, file-based, etc.), refer to the Scenario page.
  • Task Validity:
  For detailed information on what constitutes a valid task and how they are evaluated, see the Task documentation.