Planning - Revision history

Dafne: /* SQL-Based Planning */

2025-03-06T19:23:34Z

SQL-Based Planning

Dafne at 18:27, 6 March 2025

2025-03-06T18:27:21Z

Dafne: /* File-Based Planning */

2025-03-06T18:16:33Z

File-Based Planning

Dafne: /* Time-Based Planning */

2025-03-06T18:14:42Z

Time-Based Planning

Dafne: /* Time-Based Planning */

2025-03-06T17:48:19Z

Time-Based Planning

Dafne: /* Time-Based Planning */

2025-03-06T17:45:59Z

Time-Based Planning

Dafne: /* Manual Planning */

2025-03-06T16:37:59Z

Manual Planning

Dafne at 16:36, 6 March 2025

2025-03-06T16:36:14Z

Dafne: /* Steps in the Planning Process */

2025-03-06T16:35:20Z

Steps in the Planning Process

Dafne: /* Time-Based Planning */

2025-03-06T16:34:35Z

Time-Based Planning

← Older revision		Revision as of 19:23, 6 March 2025
Line 42:		Line 42:

	== SQL-Based Planning ==		== SQL-Based Planning ==
		+	[[File:Edit_scenario_sqlbased.png\|Daily scenario\|thumb\|right]]
		+	SQL-based planning is the most advanced and the most flexible way of triggering. It allows users to start planning based on custom condition with the use of SQL language, processing metadata and additional information from DB server. The following fields are relevant for SQL-based planning:
		+	* '''Generic constraints''' - see the previous sections where the generic constraints are described
		+	* '''Connection''' - Choose a connection to be used to run the query. Allowed only database-type providers
		+	* '''Check type''' - defines if dates must be planned in a specific order:
		+	** '''None''': No checking is done
		+	** '''Date''': Planning is done if the proposed date is higher than any other processing dates of the same scenario; in other words it is not possible to initiate the planning a date that is older than already started in the past
		+	** '''Iteration''': Checks ascending order at date and iteration level; allows to start only newer iterations than already started; allows planning if the date is higher than any other date or date is the same as the maximal started in the past and at the same time iteration name is higher (by string comparison) than the highest iteration within the same scenario and date
		+	* '''Polling frequency''' - Defines period in minutes to wait between retries, retry runs only in case the Max parallel condition is met (see next item)
		+	* '''Max parallel''' - Maximum number of scenario instances (processings) that can be active at once. For example when Max parallel=2, scenario can run in for 2 different dates at the moment
		+	* '''Query''' - SQL query with the following expected structure of the result; only the first row is processed, additional rows are ignored
		+	** '''date''' - first column contains date as a native DB date type (or convertable), varchar type in format YYYY-MM-DD or numeric format YYYYMMDD; this result is mandatory for scenario planning to start
		+	** '''iteration''' - optional varchar column; used to distinguish standard daily runs from special runs or to allow intra-day runs
		+	SQL can contain special placeholders (see [[Placeholders]]) formatted as %<parameter name>% or user defined parameters (with default values only) in the format %u:<parameter name>% where <parameter name> is the name of a system-level or user defined parameter (see [[Parameters]])

@@ Line 21: / Line 21: @@
 == Time-Based Planning ==
-[[File:Edit scenario std daily.png|Daily scenario|thumb]]
+[[File:Edit scenario std daily.png|Daily scenario|thumb|right]]
 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:
@@ Line 31: / Line 31: @@
 * '''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.
 * '''Generic constraints''' - see the previous sections where the generic constraints are described
+<br><br>
 == File-Based Planning ==
 [[File:Edit_scenario_filebased.png|thumb|File based]]
@@ Line 37: / Line 37: @@
 * '''Base directory:'''  - Directory, where the files are being checked. It is a local directory or a directory mounted to the local filesystem (local relatively to the Dafne Executor component).
 * '''File name regexp:'''  - Regular expression to match filename in the defined location. File name must contain the date of processing for planning. For this purpose regular expression named groups are used. Group names are "year", "month" and "day", optionally "iteration". For example to match a file with name data_20240101_i1.xml the following expression can be used: data_(?<year>20[0-9]{2})(?<month>[01][0-9])(?<day>[0-3][0-9])_(?<iteration>i[0-9]{0,12}).xml
+<br><br><br><br><br><br><br><br>
 == Manual Planning ==
 In manual planning mode, executor is not waiting for any automated event. Planning process is initiated by user either clicking in GUI or calling API method.
 == SQL-Based Planning ==

@@ Line 33: / Line 33: @@
 == File-Based Planning ==
+[[File:Edit_scenario_filebased.png|thumb|File based]]
 In scenarios set to '''File-based Planning Mode''', planning is started when a file matching a specified mask is stored at a specified location (folder). On scenario, the following fields must be set:
 * '''Base directory:'''  - Directory, where the files are being checked. It is a local directory or a directory mounted to the local filesystem (local relatively to the Dafne Executor component).

@@ Line 21: / Line 21: @@
 == 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 evaluation:'''
@@ Line 31: / Line 31: @@
 * '''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.
 * '''Generic constraints''' - see the previous sections where the generic constraints are described
 == File-Based Planning ==

@@ Line 31: / Line 31: @@
 * '''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.
 * '''Generic constraints''' - see the previous sections where the generic constraints are described
-[[File:Scenario_standard_daily.png]]
+[[File:Scenario_standard_daily.png|Daily scenario]]
 == File-Based Planning ==

← Older revision		Revision as of 16:37, 6 March 2025
Line 39:		Line 39:

	== Manual Planning ==		== Manual Planning ==
		+	In manual planning mode, executor is not waiting for any automated event. Planning process is initiated by user either clicking in GUI or calling API method.
		+
	== SQL-Based Planning ==		== SQL-Based Planning ==

@@ Line 13: / Line 13: @@
 * '''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.
-'''Generic constraints''' - Scenario constraints valid for all planning modes
+== Generic constraints ==
 * '''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.
 * '''Time constraint:'''