Dafne: Documentation import

2026-08-06T13:36:43Z

Documentation import

New page

This page covers the configuration held in the application's own files, as opposed to the repository settings described in [[System settings]]. It is read at start-up, so '''changes require a restart'''.

Dafne consists of two deployable applications, each configured separately:
* the '''web application''', which serves the GUI and the REST API
* the '''executor''', which plans scenarios and runs tasks

Both use Spring Boot configuration, so any value can also be supplied as an environment variable or command-line argument rather than being written into a file. Profiles select between variants — the container deployment, for instance, takes the database and directory settings from environment variables.

== Web application ==

=== Authentication ===
The login method is chosen by the '''active profile''' rather than by a property:

{| class="wikitable"
! Active profile !! Login method
|-
| <code>entra</code> || Microsoft Entra
|-
| <code>ldap</code> or <code>ldapad</code> || LDAP / Active Directory
|-
| ''none of the above'' || Database — accounts held by Dafne
|}

For the directory methods, the connection is configured under <code>ldap.*</code>: the server URL, the manager DN and password, the DN patterns, the search base and the domain.

Directory groups are mapped onto Dafne roles with <code>ldap.privilegeMapping</code>, which maps a group name to <code>ROLE_USER</code>, <code>ROLE_ADMIN</code> or <code>RERUN</code>. Under a directory method this mapping — not the Users screen — is where authorisation is decided. See [[Users and roles]].

=== Application options ===
{| class="wikitable"
! Property !! Meaning
|-
| <code>dafne.password-encryption-key</code> || Key used to encrypt passwords stored in the metadata repository. '''Change this from the shipped default''' on any real installation, and keep it consistent between the web application and the executor.
|-
| <code>dafne.executor-db-process-name</code> || The process name by which a running executor is recognised.
|-
| <code>dafne.monitor-view-level</code> || Whether the Monitor opens at group or task level.
|-
| <code>dafne.default-page</code> || The page shown after login. Only ''Dashboard'' changes the behaviour; anything else shows the Monitor.
|-
| <code>dafne.double-pane-min-width</code> || Width in pixels at which the Monitor switches between the one-pane and two-pane layout.
|-
| <code>dafne.mobile-enabled</code> || Whether the mobile view is available.
|-
| <code>dafne.task-history-statistics-days</code> || How many days of history the task statistics cover.
|-
| <code>dafne.lock-cleaner-delay</code> / <code>dafne.lock-cleaner-max-age</code> || How often abandoned edit locks are cleaned up, and how old a lock must be to qualify. See [[Authoring items#Check-out locks]].
|-
| <code>dafne.repair-flyway</code> || Repairs schema-migration checksums at start-up.
|}

=== Database and schema ===
The repository connection is a standard Spring datasource. Schema migrations are applied automatically at start-up.

=== Session ===
The GUI session timeout is set under <code>server.servlet.session.timeout</code>.

== Executor ==
The executor's own configuration is grouped under <code>dafne.executor</code> and <code>dafne.notification</code>. Most of it is timing, and the defaults are sensible; the values below are the ones worth knowing about.

=== Timing ===
{| class="wikitable"
! Property !! Controls
|-
| <code>execution-interval</code> || How often the executor looks for a task to start.
|-
| <code>execution-idle-delay</code> || How long it waits when there is nothing to do.
|-
| <code>planning-period</code> || How often scenarios are evaluated for planning.
|-
| <code>cancel-interval</code> || How often cancel requests are processed.
|-
| <code>shutdown-check-interval</code> || How often a pending shutdown is re-checked while waiting for running tasks.
|}

The planning period is the one that shows up operationally: it sets the granularity with which a scenario can trigger, and a scenario cannot react faster than this regardless of its own polling frequency.

=== Retention and archiving ===
{| class="wikitable"
! Property !! Controls
|-
| <code>archiving-interval</code>, <code>archiving-initial-delay</code> || When archiving runs. The retention period itself is the '''Archive limit''' repository setting — see [[System settings]].
|-
| <code>dblog-retention-days</code> and its interval and delay || How long the database log is kept.
|-
| <code>deleted-items-retention-days</code> and its interval and delay || How long deleted definitions remain recoverable.
|}

=== Execution behaviour ===
{| class="wikitable"
! Property !! Controls
|-
| <code>effective-priority-calculation-depth-limit</code> || How deep priority inheritance is followed through the dependency graph. See [[Prioritization]].
|-
| <code>stalled-task-grace-period</code> || How long a task may appear stalled before it is treated as such.
|-
| <code>ssh-connection-timeout</code>, <code>ssh-connection-auth-try-count</code> || SSH connection behaviour.
|-
| <code>db-task.name-prefix</code>, <code>db-task.max-message-count</code> || Naming of database sessions opened for tasks, and how many messages are retained per run.
|}

The priority depth limit is worth being aware of on a large model: priority inheritance stops being applied beyond it, so a high-priority task at the end of a very long chain will not lift everything behind it.

=== Notification ===
{| class="wikitable"
! Property !! Meaning
|-
| <code>notification.smtp-server</code> || SMTP server used for email notifications.
|-
| <code>notification.smtp-from</code> || Default sender.
|-
| <code>notification.smtp-subject</code> || Default subject.
|-
| <code>notification.sending-period</code> || How often queued notifications are sent.
|-
| <code>notification.keep-details</code>, <code>notification.smtp-attachment-filename</code> || Whether failure detail is attached, and under what filename.
|}

SMTP configuration lives '''here''', not in the repository settings. On the previous version of the product it was a repository setting, and that is a common source of confusion when configuring email notification for the first time. The per-notification addresses and subject are still set on the notification itself; see [[edit-notification]].

== Health checks ==
Both applications expose a health endpoint for monitoring. The executor additionally runs a small HTTP listener, used primarily for that purpose.

== Practical notes ==
* '''Keep the encryption key consistent''' between the web application and the executor, and treat it as a secret. Passwords in the repository are encrypted with it.
* '''Prefer environment variables to edited files''' for anything environment-specific — it keeps one artefact deployable everywhere.
* Remember the division of responsibility: '''Archive limit''' is a repository setting while the archiving schedule is executor configuration, and both are needed to reason about retention.

== See also ==
* [[Configuration]]
* [[System settings]]
* [[Users and roles]]
* [[Executor control]]

Application configuration - Revision history

Dafne: Documentation import