Skip to main content

Reference

Where things are kept​

WhatServiceId
LicencesObject service, private collection data_licenceThe licence code, such as ICE-ENDEX
Feeds that need no licenceObject service, private collection data_licenceSETTINGS
CostsObject service, private collection data_licence_costThe licence code
The daily checkProcess serviceLICENCE_REMINDERS
RemindersAlert service, private alertsAlert ids such as ALR-2026-1204, key licence/<code>/<issue>/<deadline>

A licence​

{
"_id": "ICE-ENDEX",
"code": "ICE-ENDEX",
"kind": "licence",
"name": "ICE Endex end of day",
"vendor": "ICE",
"contractRef": "ICE-NG-2024-118",
"licensee": "Northgate Energy Trading Ltd",
"type": "end-of-day",
"status": "active",
"owner": "priya.shah@northgate-energy.com",
"start": "2024-02-01",
"end": "2027-01-31",
"autoRenew": true,
"renewalMonths": 12,
"noticeDays": 60,
"reminders": true,
"feeds": ["ICE.NDEX"],
"usage": {"display": true, "nonDisplay": true, "derived": true},
"users": 12,
"authorisation": {"status": "confirmed", "date": "2024-02-05", "reference": "ICE-SF-77310"},
"documents": [{"label": "Signed order form 2024", "url": "https://northgate.sharepoint.com/sites/marketdata/ICE-order-2024.pdf"}],
"changes": [{"at": "2026-02-03T10:02:00Z", "by": "priya.shah@northgate-energy.com", "text": "Changed permitted users 10 -> 12"}]
}
FieldNotes
statusdraft, active, cancelled (notice given) or ended
typeend-of-day, delayed, real-time, historical, enterprise or other
signed, start, endDates as yyyy-MM-dd
autoRenew, renewalMonths, noticeDays, remindDays, remindersThe term and renewal; remindDays empty uses the process default, reminders: false turns reminders off
feedsProvider (ICE) or provider and feed (ICE.NDEX)
usagedisplay, nonDisplay, derived, redistribution, historical
users, namedUsers, sites, permittedUseUsage records
vendorContactname, email, phone
authorisationstatus (not-needed, requested, confirmed), date, reference
documentsLinks: label, url
changesThe history, newest first, at most 50
created, createdBy, updated, updatedBySet when saved

Costs have the same _id and the fields licence, currency, annualFee, billing, nextInvoice, uplift, poNumber, costCentre, notes, updated and updatedBy.


The rules​

RuleDetail
Never dueDrafts, ended licences, licences with reminders off and licences with no term end
Rolling onA licence that renews automatically (and has no notice given) whose term end has passed rolls on by its renewal term (12 months when empty) until the term end is today or later
DeadlineThe term end minus the notice period when it renews automatically and has a notice period; otherwise the term end
DueFrom the deadline minus the reminder days (the licence's, else the process default, else 90) up to the deadline
ExpiredA licence that does not renew automatically, still Active after its term end
SeverityHigh within 14 days and when expired, medium within 45 days, low otherwise

The reminder process​

SettingValue
NameLICENCE_REMINDERS
ServiceLicences
Scriptodsl-extensions\extensions\licence_manager\odsl.licence_manager.reminders
ScheduleFrom the Reminders tab, for example 0 7 * * * * EU1 (every day at 07:00 UK time)
InputremindDays (default reminder days), agent (client or opendatadsl)

Run it for another day with a run body such as {"today": "2027-01-10"}, for example to see which reminders a date would raise. The process is not part of the extension's resources: it is created the first time you save the Reminders tab.


Permissions​

PolicyWhat it allows
extension.odsl.licence_managerThe Data Licences screen
DataLicencesReading, creating, changing and deleting licences (object/data_licence)
DataLicenceCostsReading and changing costs (object/data_licence_cost)

The Feed coverage tab reads the datasets you follow (the dataset service), the reminders need access to the alert service (the Alerts extension installs it), and the Reminders tab creates and runs a process (the process service).


Extension contents​

TypeId
Extensionodsl.licence_manager, menu Manage > Data Licences
Featureodsl.licence_manager.manage
Policiesextension.odsl.licence_manager, DataLicences, DataLicenceCosts
Scriptsodsl.licence_manager.manage, odsl.licence_manager.common, odsl.licence_manager.reminders
Home page tasksodsl.licence_manager.review, odsl.licence_manager.new, odsl.licence_manager.coverage

Troubleshooting​

What you seeWhy, and what to do
The licences could not be read ... DataLicences security policyYou are not a member of the DataLicences policy. Ask an administrator to add you
No Costs tabYou are not a member of DataLicenceCosts, so costs are hidden from you
Feeds without a licence shows -Your followed datasets could not be read
A reminder did not close after a renewalReminders close at the next daily check. Use Run the check now on the Reminders tab to close it at once
No reminders at allCheck the Reminders tab: the check must be on, and the licence must have Send reminders ticked and a term end
The Home page task shows no countThe task counts open private alerts of category licence; the Home and Alerts extensions must be installed