Reports as jobs and as automations

documentation/changelog.rst

@@ -35,6 +35,7 @@ New features
 * Let forecast automations use their own timezone and catch up only the latest missed occurrence after downtime, with skipped daylight-saving times handled once and repeated wall-clock times not duplicated [see `PR #2396 <https://github.com/FlexMeasures/flexmeasures/pull/2396>`_]
 * Automations can also compute schedules on a recurring basis (``flexmeasures add automation --type schedules``), with the schedule start defaulting to each run's time [see `PR #2293 <https://www.github.com/FlexMeasures/flexmeasures/pull/2293>`_]
 * Automations can be created, edited and deleted in the UI and through new API endpoints (``[POST|PATCH|DELETE] /assets/(id)/automations``), by organisation admins and consultants, with their recurrence expressed in a selectable IANA timezone, and only involving sensors they can access themselves (read access to the sensors an automation reads, and permission to record data on the sensors it writes to) [see `PR #2294 <https://www.github.com/FlexMeasures/flexmeasures/pull/2294>`_]
+* Reports can run as background jobs (``flexmeasures add report --as-job``, processed by workers of the new ``reporting`` queue) and be computed on a recurring basis by automations, with a rolling report window expressed as Pandas offsets or defaulting to the last cron period [see `PR #2297 <https://www.github.com/FlexMeasures/flexmeasures/pull/2297>`_]
 * ``flexmeasures show data-sources`` now shows which organisation a data source belongs to, and can list the sensors holding data recorded by a given source [see `PR #2401 <https://www.github.com/FlexMeasures/flexmeasures/pull/2401>`_]
 * New ``inflexible-consumption`` and ``inflexible-production`` flex-context fields make explicit how the sign of each inflexible device's power data should be read (positive values denote consumption resp. production), accepting sensor references with optional source filters; they replace the now-deprecated ``inflexible-device-sensors`` field (bare sensor IDs, sign read from each sensor's ``consumption_is_positive`` attribute), which remains supported [see `PR #2358 <https://www.github.com/FlexMeasures/flexmeasures/pull/2358>`_]
 * An inflexible (unschedulable) device can be modelled as its own asset by giving its flex-model entry a single ``inflexible-consumption`` or ``inflexible-production`` sensor reference; such a device joins a ``group`` like any other member, so its fixed (measured) load counts towards the group's intermediate power constraint [see `PR #2374 <https://www.github.com/FlexMeasures/flexmeasures/pull/2374>`_]

documentation/cli/change_log.rst

@@ -12,7 +12,8 @@ since v1.0.0 | July XX, 2026
 * Add ``flexmeasures add plan``, ``flexmeasures show plans`` and ``flexmeasures edit plan``, to manage the rate limits and quotas which apply to the accounts on a plan.
 * Add ``flexmeasures edit secret`` to store an encrypted secret on an account or asset.
 * Add ``flexmeasures delete secret`` to remove an encrypted secret from an account or asset.
-* Add ``flexmeasures add automation``, ``flexmeasures edit automation`` and ``flexmeasures delete automation`` to manage automations (recurring tasks on an asset, computing forecasts or schedules).
+* Add ``flexmeasures add automation``, ``flexmeasures edit automation`` and ``flexmeasures delete automation`` to manage automations (recurring tasks on an asset, computing forecasts, schedules or reports).
+* Add an ``--as-job`` flag to ``flexmeasures add report``, to queue a reporting job (processed by workers of the new ``reporting`` queue) instead of computing directly.
 * Add ``flexmeasures jobs run-automations`` to queue jobs for all automations that are due to run this minute from standard five-field cron expressions. Run this command once per minute. It makes at most one queueing attempt per automation per minute, including when an attempt fails after partially queueing jobs.
 * Add ``--timezone`` to ``flexmeasures add automation`` and ``flexmeasures edit automation``. ``flexmeasures jobs run-automations`` now persists scheduling progress, catches up only the latest missed forecast occurrence, and handles skipped or repeated daylight-saving-time occurrences once. Failed or partially completed queueing attempts are still not retried automatically.
 * ``flexmeasures show data-sources`` now shows the account a data source belongs to, and lists the sensors holding data recorded by a single source with ``--show-sensors``.

documentation/cli/commands.rst

@@ -41,7 +41,7 @@ of which some are referred to in this documentation.
 ``flexmeasures add annotation``                   Add annotation to accounts, assets and/or sensors.
 ``flexmeasures add toy-account``                  Create a toy account, for tutorials and trying things.
 ``flexmeasures add report``                       Create a report.
-``flexmeasures add automation``                   Add an automation: a recurring task (computing forecasts or schedules) on an asset, with its own cron timezone.
+``flexmeasures add automation``                   Add an automation: a recurring task (computing forecasts, schedules or reports) on an asset, with its own cron timezone.
 ================================================= =======================================
 
 

documentation/features/automations.rst

@@ -0,0 +1,56 @@
+.. _automations:
+
+Automations
+============
+
+Hosts and users often want the three main FlexMeasures features — :ref:`forecasting`, :ref:`scheduling` and :ref:`reporting` — to run on a recurring basis, across larger numbers of sites.
+*Automations* make that a first-class concept: an automation is a recurring task defined on an asset, and each time it runs, it queues jobs.
+
+An automation consists of:
+
+- a **type**: ``forecasts``, ``schedules`` or ``reports``;
+- a **recurrence**: a cron string (e.g. ``"0 6 * * *"`` for daily at 6 AM), interpreted in the automation's own IANA timezone;
+- a **data generator** (for forecasts and reports): the forecaster or reporter class and its configuration, stored on a data source.
+  The data source stays the same across runs, so all results the automation produces attribute to one steady source;
+- **parameters**: what to compute on each run, validated by the same schema the CLI and API use for one-off runs.
+  Timing parameters are resolved freshly on each run, so a recurring automation always computes fresh periods
+  (see the type-specific sections below for the exact rules);
+- an **activation status**: only active automations run.
+
+Managing automations
+--------------------
+
+Automations can be managed in three ways:
+
+- **CLI**: ``flexmeasures add automation``, ``flexmeasures edit automation`` (name, cron string, timezone and activation status) and ``flexmeasures delete automation``.
+- **API**: list and inspect with ``[GET] /assets/(id)/automations`` and ``[GET] /assets/(id)/automations/(automation_id)``;
+  create, update and delete with ``[POST|PATCH|DELETE]`` on the same paths (see the `API documentation <../api/v3_0.html>`_).
+- **UI**: each asset has an *Automations* page (in the breadcrumbs dropdown), with a tab per automation type.
+  It lists each automation's recurrence and recent job counts, and lets you create, edit, (de)activate and delete automations.
+
+Creating, updating and deleting automations requires account admin or consultant rights, and is recorded in the asset's audit log.
+
+Running automations
+--------------------
+
+An automation is due whenever its cron string matches the current minute in its configured timezone. To actually run due automations, let a cron job execute the following command once per minute:
+
+.. code-block:: bash
+
+    * * * * * flexmeasures jobs run-automations
+
+Each due automation then queues its jobs — so make sure workers are processing the relevant queues (``forecasting``, ``scheduling`` and/or ``reporting``, see :ref:`redis-queue`).
+A Redis-based guard prevents queueing jobs twice if the command happens to run more than once within the same minute.
+
+Jobs record how they were created (via the CLI, the API or an automation), which is shown in the *Created Via* column
+of the jobs table on the asset's status page, where recent jobs are listed.
+
+Automating each feature
+-----------------------
+
+The parameters stored on an automation follow the same schemas as one-off CLI/API calls, with type-specific rules for resolving timing on each run:
+
+- :ref:`automating_forecasts` — forecast parameters; the forecast start defaults to the run time.
+- :ref:`automating_schedules` — a schedule trigger message; omit ``start`` to schedule from the run time.
+- :ref:`automating_reports` — report parameters; use ``start-offset``/``end-offset`` (Pandas offsets) for a rolling window,
+  or omit timing fields to report on the period since the last successfully covered report window.

documentation/features/forecasting.rst

@@ -219,7 +219,7 @@ Usage:
 Automating forecasts
 --------------------
 
-Instead of asking for forecasts one at a time, you can set up an *automation*: a recurring task defined on an asset.
+Instead of asking for forecasts one at a time, you can set up an *automation*: a recurring task defined on an asset (see :ref:`automations` for the full concept, including how to manage and run automations).
 On each run, the automation queues forecasting jobs (so make sure a worker is processing the ``forecasting`` queue, see :ref:`redis-queue`).
 When the automation was created, its forecast parameters (see above) were stored, and validated with the same schema that the CLI and API use.
 Timing parameters are resolved on each run — for instance, the forecast start defaults to the time the automation runs, so each run produces fresh forecasts.
@@ -284,4 +284,4 @@ An automation created this way can only involve sensors that its creator can acc
 they need read access to the sensors it reads data from, and permission to record data on the sensors it writes to.
 The CLI is not restricted in this way.
 
-Schedules can be automated in the same way — see :ref:`automating_schedules`.
+Schedules and reports can be automated in the same way — see :ref:`automating_schedules` and :ref:`automating_reports`.

documentation/features/reporting.rst

@@ -122,4 +122,29 @@ The input sensor stores the power/energy flow, and the output sensor will store
 Here, the ``ProfitOrLossReporter`` used as source (with Id 6) is the one we configured above.
 With the offsets, we control the timing ― we indicate that we want the new report to encompass the day of tomorrow (see Pandas offset strings).
 
-The report sensor will now store all costs which we know will be made tomorrow by the  schedule.
+The report sensor will now store all costs which we know will be made tomorrow by the  schedule.
+
+.. _automating_reports:
+
+Automating reports
+--------------------
+
+Reports can be queued as background jobs (add ``--as-job`` to ``flexmeasures add report``, and let a worker process the ``reporting`` queue, see :ref:`redis-queue`),
+and computed on a recurring basis by an *automation* defined on the asset (see :ref:`automations` for the full concept, including how to manage and run automations).
+
+The reporter and its configuration are stored on a data source (steady across runs, so all report results attribute to the same source),
+while the report parameters are stored on the automation itself and their timing is resolved freshly on each run:
+
+- Use ``start-offset`` and/or ``end-offset`` fields (comma-separated Pandas offsets, like the CLI options above) for a rolling window relative to the claimed cron occurrence,
+  in the timezone of the first output sensor. For instance, ``"start-offset": "-1D,DB"`` with ``"end-offset": "DB"`` reports on the whole previous day.
+- Omit timing fields entirely to report from the end of the latest successfully completed report window through the claimed cron occurrence.
+  When no completed window is known, such as on the first run, the start falls back to the previous cron occurrence in the automation's timezone.
+  The completion marker only moves forward, so concurrent reporting workers that finish out of order cannot reopen an already covered period.
+- Absolute ``start``/``end`` fields are also accepted, but draw a warning, as each run would then compute the same period.
+
+For example, this automation computes a report over each past day, every morning at 1 AM:
+
+.. code-block:: bash
+
+    flexmeasures add automation --asset 3 --name "Daily aggregation report" --cron "0 1 * * *" --type reports \
+      --reporter PandasReporter --config reporter-config.yml --parameters report-parameters.yml

documentation/host/queues.rst

@@ -24,7 +24,7 @@ Here is how to run one worker for each kind of job (in separate terminals):
 
 .. code-block:: bash
 
-   $ flexmeasures jobs run-worker --name our-only-worker --queue forecasting|scheduling|ingestion
+   $ flexmeasures jobs run-worker --name our-only-worker --queue forecasting|scheduling|ingestion|reporting
 
 Running multiple workers in parallel might be a great idea.
 

documentation/index.rst

@@ -175,6 +175,7 @@ In :ref:`getting_started`, we have some helpful tips how to dive into this docum
     features/scheduling
     features/forecasting
     features/reporting
+    features/automations
 
 .. toctree::
     :caption: Tutorials

flexmeasures/api/v3_0/assets.py

@@ -1657,7 +1657,7 @@ def post_automation(self, id: int, asset: GenericAsset):
                 automation_type=automation_data["type"],
                 active=automation_data["active"],
                 parameters=automation_data["parameters"],
-                forecaster_class=automation_data["forecaster"],
+                generator_class=automation_data["generator"],
                 config=automation_data["config"],
                 origin="API",
                 check_permissions=True,

flexmeasures/api/v3_0/tests/test_automations_api.py

@@ -216,6 +216,170 @@ def test_post_automation(
         fresh_db.session.flush()
 
 
+@pytest.mark.parametrize(
+    "requesting_user", ["test_prosumer_user_2@seita.nl"], indirect=True
+)
+def test_post_automation_with_foreign_sensor(
+    app,
+    db,
+    setup_accounts,
+    add_battery_assets,
+    requesting_user,
+):
+    """Referencing a sensor outside the caller's reach is forbidden."""
+    from datetime import timedelta
+
+    from flexmeasures.data.models.generic_assets import GenericAsset
+    from flexmeasures.data.models.time_series import Sensor
+
+    battery = add_battery_assets["Test battery"]
+    foreign_asset = GenericAsset(
+        name="Foreign asset",
+        generic_asset_type=battery.generic_asset_type,
+        owner=setup_accounts["Dummy"],
+    )
+    foreign_sensor = Sensor(
+        "foreign power",
+        generic_asset=foreign_asset,
+        event_resolution=timedelta(minutes=15),
+        unit="MW",
+    )
+    db.session.add(foreign_sensor)
+    db.session.flush()
+    with app.test_client() as client:
+        response = client.post(
+            url_for("AssetAPI:post_automation", id=battery.id),
+            json={
+                "name": "Sneaky forecasts",
+                "cronstr": "0 6 * * *",
+                "type": "forecasts",
+                "parameters": {"sensor": foreign_sensor.id},
+            },
+        )
+    assert response.status_code == 403
+    assert (
+        db.session.execute(
+            select(Automation).filter_by(name="Sneaky forecasts")
+        ).scalar_one_or_none()
+        is None
+    )
+
+
+@pytest.mark.parametrize(
+    "requesting_user", ["test_prosumer_user_2@seita.nl"], indirect=True
+)
+def test_post_report_automation_with_foreign_config_sensor(
+    app,
+    db,
+    setup_accounts,
+    add_battery_assets,
+    requesting_user,
+):
+    """Reporter configuration may not read a sensor outside the caller's reach."""
+    from flexmeasures.data.models.generic_assets import GenericAsset
+
+    battery = add_battery_assets["Test battery"]
+    foreign_asset = GenericAsset(
+        name="Foreign price asset",
+        generic_asset_type=battery.generic_asset_type,
+        owner=setup_accounts["Dummy"],
+    )
+    foreign_price_sensor = Sensor(
+        "private foreign price",
+        generic_asset=foreign_asset,
+        event_resolution=timedelta(hours=1),
+        unit="EUR/MWh",
+    )
+    report_sensor = Sensor(
+        "profit report",
+        generic_asset=battery,
+        event_resolution=timedelta(hours=1),
+        unit="EUR",
+    )
+    db.session.add_all([foreign_price_sensor, report_sensor])
+    db.session.flush()
+
+    with app.test_client() as client:
+        response = client.post(
+            url_for("AssetAPI:post_automation", id=battery.id),
+            json={
+                "name": "Cross-organisation profit report",
+                "cronstr": "0 1 * * *",
+                "type": "reports",
+                "generator": "ProfitOrLossReporter",
+                "config": {
+                    "consumption_price_sensor": foreign_price_sensor.id,
+                },
+                "parameters": {
+                    "input": [{"sensor": battery.sensors[0].id}],
+                    "output": [{"sensor": report_sensor.id}],
+                },
+            },
+        )
+
+    assert response.status_code == 403
+    assert foreign_price_sensor.name not in response.text
+    assert (
+        db.session.execute(
+            select(Automation).filter_by(name="Cross-organisation profit report")
+        ).scalar_one_or_none()
+        is None
+    )
+    db.session.commit()
+
+
+@pytest.mark.parametrize(
+    "requesting_user", ["test_prosumer_user_2@seita.nl"], indirect=True
+)
+def test_post_report_automation_rejects_output_outside_asset_subtree(
+    app,
+    db,
+    add_battery_assets,
+    requesting_user,
+):
+    """Report output must stay on the automation asset or a descendant."""
+    battery = add_battery_assets["Test battery"]
+    sibling_battery = add_battery_assets["Test small battery"]
+    report_sensor = Sensor(
+        "sibling report output",
+        generic_asset=sibling_battery,
+        event_resolution=timedelta(hours=1),
+        unit="MW",
+    )
+    db.session.add(report_sensor)
+    db.session.flush()
+
+    with app.test_client() as client:
+        response = client.post(
+            url_for("AssetAPI:post_automation", id=battery.id),
+            json={
+                "name": "Misplaced report output",
+                "cronstr": "0 1 * * *",
+                "type": "reports",
+                "generator": "PandasReporter",
+                "config": {
+                    "required_input": [{"name": "flow"}],
+                    "required_output": [{"name": "copied_flow"}],
+                    "transformations": [
+                        {
+                            "df_input": "flow",
+                            "df_output": "copied_flow",
+                            "method": "copy",
+                        }
+                    ],
+                },
+                "parameters": {
+                    "input": [{"name": "flow", "sensor": battery.sensors[0].id}],
+                    "output": [{"name": "copied_flow", "sensor": report_sensor.id}],
+                },
+            },
+        )
+
+    assert response.status_code == 422
+    assert "must belong to asset" in response.text
+    db.session.commit()
+
+
 @pytest.mark.parametrize(
     "requesting_user", ["test_prosumer_user_2@seita.nl"], indirect=True
 )

flexmeasures/app.py

@@ -124,7 +124,11 @@ def create(  # noqa C901
             name="ingestion",
             default_timeout=get_job_timeout("ingestion", app.config, app.logger),
         ),
-        # reporting=Queue(connection=redis_conn, name="reporting"),
+        reporting=Queue(
+            connection=redis_conn,
+            name="reporting",
+            default_timeout=get_job_timeout("reporting", app.config, app.logger),
+        ),
         # labelling=Queue(connection=redis_conn, name="labelling"),
         # alerting=Queue(connection=redis_conn, name="alerting"),
     )