Skip to main content

Reference


Alert fields​

FieldTypeMeaning
_idTextALR- and the year and a number for your alerts (ALR-2026-000401); ALC- for common and ALP- for public alerts
titleTextShort description
messageTextWhat is wrong
descriptionTextMore detail (optional)
categoryTextA grouping, such as dataset, curve or system
issueTextThe type: delivery, completeness, quality, metadata, corrections, build, export or another
severityTextThe priority: critical, high, medium or low
statusTextopen or closed
agentTextWho it is with: client (your team), opendatadsl, or a data vendor's name
subjectObjectWhat it is about: service (dataset, curve, data, process and so on), id, and ondate (the delivery or build date)
keyTextThe id of the problem, used to count repeats instead of raising new alerts
occurrencesNumberHow many times it was raised while open
lastOccurredDateWhen it was last raised
tagsListYour own labels
assigneeTextWho is working on it (optional)
resolutionTextWhat was wrong and what was done, set when closed
created, updated, closedObjectat (date) and by (who)
relatedToTextAn earlier closed alert with the same key, if any
rootBooleantrue on a root alert: the alert that explains what went wrong in a run (see Raising from a process)
affectsListOn a root alert: the dataset ids the run was meant to load
traceObjectThe run the alert was last raised in: id (the trace, shared by everything the run started), type (process or script), process (its name) and execution (its execution id)
tracesListEvery trace id the alert has been raised under
causeObjectOn an alert linked to a root cause (raised before it, or linked by hand): id and source of the root cause
impactCount, openImpactCountNumberOn a root cause: the problems folded into it that you can see, and how many are still open
impactsListOn a root cause read by id: the problems folded into it (see below)
linkedListOn a root cause read by id: the alerts linked to it, with _id, _source, title, status, severity and subject
originObjecttype: system (raised by the platform) or user
commentCountNumberComments on the alert
tenantCommentCountNumberOn shared alerts: your team's comments
metricsObjectTimes in seconds: openSeconds, secondsClient, secondsOpenDataDSL, secondsVendor; reopens, handoffs, agentSince (when the current party got it) and firstResponseAt
timelineListEverything that happened (see below). On shared alerts, your team's comments are only included when one alert is read
environmentTextYour alerts: the data environment
_versionNumberGoes up with every change; send it back to make sure nobody changed the alert meanwhile

Timeline entries​

Every entry has id, type, at and by.

TypeExtra fieldsMeaning
createdstatus, agent, severityRaised
commenttext; editedAt, deletedA comment. On shared alerts your team's comments have scope: tenant and an id starting t-
comment-editedref, textA comment was edited (ref is the comment's id)
comment-deletedrefA comment was deleted
statusfrom, toClosed or reopened
agentfrom, toHanded over
severityfrom, toPriority changed
impactimpact, subject, issue, severity, via, titleOn a root cause: a problem was folded in
impact-resolvedimpact, subject, issue, resolutionOn a root cause: a problem folded in recovered
linkedalert, alertSource, title on the root cause; root, rootSource, title on the alertAn alert was linked to the root cause: automatically (raised before the root cause) or by hand. A shared root cause does not name your alerts on its timeline
unlinkedalert, alertSource, title on the root cause; root, rootSource on the alertThe link to a root cause was removed (or replaced by another)
root-closedroot, rootSource, resolutionOn a linked alert: its root cause was closed
dataset-fixeddataset, configSource, changes (target, field, from, to), outcome, textOpenDataDSL corrected the dataset's configuration (calendar, expected tenors, times, priority or alerts) from this alert and checked the delivery again. When the delivery became a holiday or complete, the alert was closed

Problems folded into a root cause​

FieldMeaning
idThe problem's id
subjectThe item: service (dataset, curve or curve-export), id and ondate
title, message, issue, severity, keyAs the alert would have had them
viaHow it was linked: trace (same run), affects (named by the root cause), loader (loaded by its process), curve-input (built from an affected item) or export-curve (exports an affected curve)
traceThe trace id of the run it came from, if any
statusopen or resolved (recovered), with resolvedAt and resolution
occurrences, firstAt, lastAtHow many times it happened, first and last
tid, environmentWhose item it is

Who can do what​

Your alertsShared alerts
SeeYour company's alerts in the environment you work inEvery shared alert
RaiseYesNo (OpenDataDSL only)
CommentYesYes, seen only by your company and OpenDataDSL
Close, reopen, hand over, change priority or detailsYesNo (OpenDataDSL only)
Edit or delete a commentIts author, an administrator of your company, or OpenDataDSLThe same, for your company's comments
Delete an alertAdministrators of your companyNo

These rules are applied by the platform, whichever way you work: the screen, ODSL, Python or the REST API. Companies on the none plan do not have alerts.


What the extension installs​

ItemIdWhat it does
Menu itemOperations > AlertsThe Alerts screen
Feature policyextension.odsl.alertsWho sees the menu item (everyone by default)
Security policyAlertsPrivateRead, raise, change and delete your alerts (category Alerts, source private, service alert)
Security policiesAlertsCommon, AlertsPublicRead shared alerts and comment on them
Insightodsl.alerts.auditThe Alert Audit Report, in the screen's Insights (category odsl.alerts)

Without the security policies nobody in your company can see alerts, in the screen or through the API. To limit who works on alerts, change the members of these policies (for example to a group) in the portal's security settings.

The screen also reads your datasets (to know which you follow) and your dataset deliveries (for the delivery card), with your existing permissions on those services.