Daily Status Reports

What is a daily status report?

A daily status report collects updates from many sources during the day into a single report. For example:

A data loading process records that the morning files have arrived
A curve build records whether each curve built successfully
A validation script records any data quality warnings
A user adds a note about a late price

Each contributor only knows about its own part, so it only sends its own part. The platform merges every update into the report for that day, and the report then contains the complete picture. At a set time, the finished report is sent to the people who need it.

This is done with a Fixed report that has mergeUpdates turned on.

How merging works

Normally, saving a fixed report for an ondate replaces the data and creates a new version of the report. With mergeUpdates set to true, each save is merged into the report that is already stored for that ondate, and no new version is created.

The data you send is merged into the stored data using these rules:

Data	What happens
Object	Merged field by field, so each contributor only changes the fields it sends
List of objects	Items are matched using a key field (see merge keys). A matching item is merged, a new item is added to the end of the list
List of values	New values are added, values already in the list are kept
Single value (text, number, boolean)	Replaced, the latest update wins
`null`	The field is removed
Typed value (e.g. a date or a timeseries)	Replaced as a whole

For example, if the stored report data is:

{
  "loading": { "status": "running", "started": "07:02" },
  "curves": [
    { "name": "EEX.DE.BASE", "status": "success" }
  ]
}

and a contributor sends:

{
  "loading": { "status": "complete", "finished": "07:45" },
  "curves": [
    { "name": "ICE.TTF", "status": "failed" }
  ]
}

the report data becomes:

{
  "loading": { "status": "complete", "started": "07:02", "finished": "07:45" },
  "curves": [
    { "name": "EEX.DE.BASE", "status": "success" },
    { "name": "ICE.TTF", "status": "failed" }
  ]
}

Merge keys

When a list of objects is merged, each incoming item is matched to an existing item using a key field. The first field in the mergeKeys list that the item contains is used.

If you don't set mergeKeys, the default is:

["id", "key", "name"]

If your items use a different identifier, set your own merge keys on the report configuration, e.g. ["job"] or ["curve", "id"].

An item that doesn't contain any of the merge keys is added to the list, unless an identical item is already there.

note

When you save an ODSL Object(), its _id and _type are not stored in the report data, so the name of the variable you used to build a list item is never used to match items.

Update log

Every merged update adds an entry to a log stored in the report data, in a field called _updates:

Name	Description
time	When the update was made (UTC)
user	The user or service account that made the update
invocationId	The id of the request that made the update
keys	The top level fields of the data that this update contained
reason	The reason for the update, if one was given with the `_reason` parameter

The log keeps the most recent 1,000 entries. You can show it in your template to give an audit trail of who updated the report and when.

note

_updates is managed by the platform. Any _updates field in the data you send is ignored.

Updates at the same time

If two contributors update the report at the same moment, both updates are kept. The platform detects the clash and re-applies the later update on top of the earlier one.

Creating a daily status report

Step 1: Create the report configuration

Create a Fixed report with mergeUpdates set to true.

To send the complete report at the end of the day, also give it a schedule using cron and enabled. When a merge report runs on its schedule it doesn't change anything, it simply returns the merged report for that day and triggers the success event (see Step 3).

OpenDataDSL
REST API

DAILY_STATUS = Report()
DAILY_STATUS.category = "Operations"
DAILY_STATUS.name = "Daily Status"
DAILY_STATUS.description = "Status of all daily loading, curve builds and checks"
DAILY_STATUS.reportType = "Fixed"
DAILY_STATUS.mergeUpdates = true
DAILY_STATUS.mergeKeys = ["name"]
DAILY_STATUS.template = "#StatusReportTemplate"
DAILY_STATUS.cron = "00 17 ? * MON-FRI * EU1"
DAILY_STATUS.enabled = true
save DAILY_STATUS

POST https://api.opendatadsl.com/api/reportconfig/v1
Authorization: Bearer {{token}}

{
    "_id": "DAILY_STATUS",
    "_type": "VarReportConfiguration",
    "reportType": "Fixed",
    "category": "Operations",
    "name": "Daily Status",
    "description": "Status of all daily loading, curve builds and checks",
    "mergeUpdates": true,
    "mergeKeys": ["name"],
    "template": "#StatusReportTemplate",
    "cron": "00 17 ? * MON-FRI * EU1",
    "enabled": true
}

tip

The EU1 suffix on the cron expression runs the schedule on London time, so the report for the correct UK date is sent.

Step 2: Contribute to the report

Each contributor saves only its own part of the data. A process, script or user can contribute at any time during the day.

Use the standard status report shape so the report can be shown with the shared status report template: each contributor adds a section, and the rows in a section are items. Sections and items are both matched on name, so each contributor updates its own section and its own items.

OpenDataDSL
REST API

Create a variable with the same name as the report, add your part of the data and save it as a report. It is saved for today's ondate, unless you set an ondate on the variable.

// In the data loading process
section = Object()
section.name = "Data Loading"
section.status = "complete"
section.summary = "All morning files received"
section.updated = "07:45"

DAILY_STATUS = Object()
DAILY_STATUS.sections = [section]
save ${report:DAILY_STATUS}

// In the curve build script
curve = Object()
curve.name = "ICE.TTF"
curve.status = "failed"
curve.message = "Missing settlement price for DEC-26"
curve.time = "08:06"

section = Object()
section.name = "Curve Builds"
section.items = [curve]

DAILY_STATUS = Object()
DAILY_STATUS.sections = [section]
save ${report:DAILY_STATUS}

To update the report for a different day, set the ondate property. It is used to choose which day's report to update and is not saved as part of the data.

// Add a late note to yesterday's report
DAILY_STATUS = Object()
DAILY_STATUS.ondate = "2026-10-09"
DAILY_STATUS.notes = ["ICE.TTF rebuilt at 19:30 after the settlement price was published"]
save ${report:DAILY_STATUS}

Send the data to the report id with the ondate. Use the optional _reason parameter to record why the update was made in the update log.

POST https://api.opendatadsl.com/api/report/v1/private/DAILY_STATUS:2026-10-10
  ?_reason=Curve build
Authorization: Bearer {{token}}

{
    "sections": [
        {
            "name": "Curve Builds",
            "items": [
                { "name": "ICE.TTF", "status": "failed", "message": "Missing settlement price for DEC-26", "time": "08:06" }
            ]
        }
    ]
}

tip

When several contributors add items to the same section, let each one set only its own item's status. A section status is replaced by the latest update, so only set it from the process that knows the state of the whole section. The same applies to the overall status and headline of the report.

To remove a field that was added earlier, send it with a value of null.

Step 3: Act on the report events

Two events are raised for a daily status report:

Event	When it happens	Use it to
update	Every time a contributor updates the report	Act on each individual update, e.g. alert the team as soon as a curve fails
success	When the report runs on its schedule	Send the complete report, e.g. an end of day email

You can add automations on either event, using the report service and the id of the report, e.g. DAILY_STATUS. The automation receives the complete merged report, not just the part that was updated. See Creating Automations for how to create an automation.

Step 4: Format the report

A shared template, #StatusReportTemplate, is available in the public scripts for all status reports. It is the template set in Step 1, and it shows the report in the house style, both in the portal and in emails sent by an automation:

A header with the report name, description and ondate
The overall status and headline
A card for each section, with its status, summary and a table of its items
Any notes
The update log

The standard status report shape

The shared template expects the report data in this shape. All fields are optional.

Field	Description
status	The overall status of the report
headline	A one line summary shown under the title
sections	A list of sections, matched on `name` when merged
sections.name	The section title
sections.status	The status of the section
sections.summary	Short text about the section
sections.updated	When the section was last updated, any text
sections.items	A list of rows in the section, matched on `name` when merged
sections.items.name	The item name, e.g. a curve or dataset id
sections.items.status	The status of the item
sections.items.message	Detail text for the item
sections.items.time	The time of the item, any text
notes	A list of free text notes

Status values are shown with a colour. Use one lower case word:

Colour	Status values
Green	ok, success, complete, completed, done, passed, built, loaded
Amber	warning, warn, late, running, pending, partial, delayed, waiting
Red	failed, fail, error, missing, critical, overdue
Blue	info, skipped, holiday, none

Any other value is shown in grey.

note

If you need a different layout, you can write your own mustache template and set it as the report template. The report data is available as data, and the update log as data._updates.

Reading the report

The report for a day is read in the same way as any other report, and always contains the merged data from every update so far.

OpenDataDSL
REST API

rep = ${report:"DAILY_STATUS:2026-10-10"}
print rep.data

// The latest report
rep = ${report:"DAILY_STATUS:L"}

GET https://api.opendatadsl.com/api/report/v1/private/DAILY_STATUS:2026-10-10
Authorization: Bearer {{token}}

Things to know

mergeUpdates only applies to Fixed reports, it is ignored for all other report types
A report with mergeUpdates doesn't keep versions, the update log is the history of changes for the day
Each ondate is a separate report, so each day starts empty and the first update of the day creates it
If a contributor sends data that isn't an object (e.g. a single list), the update log is stored on the report itself rather than in the data

What is a daily status report?​

How merging works​

Merge keys​

Update log​

Updates at the same time​

Creating a daily status report​

Step 1: Create the report configuration​

Step 2: Contribute to the report​

Step 3: Act on the report events​

Step 4: Format the report​

The standard status report shape​

Reading the report​

Things to know​

What is a daily status report?

How merging works

Merge keys

Update log

Updates at the same time

Creating a daily status report

Step 1: Create the report configuration

Step 2: Contribute to the report

Step 3: Act on the report events

Step 4: Format the report

The standard status report shape

Reading the report

Things to know