Skip to main content

The Message queue plug-in

The Message Queue Integration extension (odsl.integration_queue) sends curves, timeseries and options as JSON messages to one of your company's queues on the platform, the Azure Service Bus queues used with send ... to. Any system that reads the queue, with the queue's connection string, gets the data as it is sent.


What it needs​

Once installed, add a system that sends with it: select New system and choose Message queue under Sends with. The plug-in's codes, settings and secrets are listed on the system's System setup tab. Each system on the plug-in has its own secrets, groups and daily report, and its own codes when you choose them (see The codes a system sends with).

The System setup tab of a system on Message queue with its identity, group settings and secrets

KindNameWhat it is
Identityqueue_codeThe code the receiving system knows the data by. Left empty, the data id is sent, such as NGE.GAS.TTF:MID.
Group settingQueue (queue)The name of one of your company's queues on the platform; the receiving system reads it with the queue's connection string.
Group settingMessages (layout)item or group, item unless you change it. item: one message or file per data item; group: one for the whole run.
Group settingMost items in one message (maxItems)100 unless you change it. With one message per group, a bigger group is sent in several messages, each with part and parts.
Group settingTransformer (transformer)Optional: the name of a mustache script (# for a public one) to transform the data with. Its text is sent instead of the JSON or CSV. See Transforming with a Mustache template.
Group settingContent type (contentType)With a transformer: the content type of its text, such as text/csv or application/xml, text/plain unless you change it.
Group settingSend (send)Ticked unless you change it. Untick for a dry run: everything is built and counted, nothing is sent.

How it sends​

With Messages set to item (the default), each curve or timeseries is one message, sent as soon as it is read. With group, the whole group is one message with every item in it; a group with more items than Most items in one message is sent as several messages, each with part and parts.

The platform gives each message the id of the run (its _id), so the receiving system can tell which messages came from the same run.

What each message or file holds, the CSV columns and the file names are the same for every generic plug-in: see What the generic plug-ins send.

note

The queue must be one of your company's queues on the platform. Queues in your own Azure subscription, and Azure Event Hubs, are not supported yet: sending to them needs a signature the plug-ins cannot make. Use the Webhook plug-in with a receiving endpoint, or the Azure Event Grid plug-in, instead.


Examples​

Northgate Energy sends its gas curves to a queue its risk system reads:

SettingValue
Queuenge_risk_marks
Messagesitem

Each run sends one message per curve, such as {"id": "NGE.GAS.TTF:MID", "code": "Q.TTF", "kind": "curve", "ondate": "2026-11-03", "values": [{"tenor": "M01", "start": "2026-12-01", "value": 32.15}, ...]}.


One plug-in, several destinations​

Each group sending to Message queue has its own settings, so groups can already send to different queues. To keep destinations apart, with their own secrets, codes, report and groups, add a system for each one on this plug-in: select New system and choose Message queue under Sends with, or Copy to a new system on a system's System setup tab (see Copying a system). The plug-in is installed once, and every system on it gets its updates.


Next​