The Azure Files plug-in
The Azure Files Integration extension (odsl.integration_files) writes curves, timeseries and options as CSV or JSON files to an Azure Files share. An Azure Files share can be mounted as a network drive, so this suits systems that read files from a folder, such as an ETRM import folder.
What it needs
Once installed, add a system that sends with it: select New system and choose Azure Files 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).
| Kind | Name | What it is |
|---|---|---|
| Identity | files_code | The code the receiving system knows the data by. Left empty, the data id is sent, such as NGE.GAS.TTF:MID. |
| Group setting | Share URL (url) | https://<account>.file.core.windows.net/<share>, optionally followed by a folder. |
| Group setting | File format (format) | csv or json, csv unless you change it. csv: one row per value; json: the item message, or all of them with their group. Not used with a transformer. See What the generic plug-ins send. |
| Group setting | File name (fileName) | {group}_{yyyymmdd}.{ext} unless you change it. A pattern of the file name: see File names. |
| Group setting | Messages (layout) | item or group, group unless you change it. item: one message or file per data item; group: one for the whole run. |
| Group setting | Transformer (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 setting | Content type (contentType) | With a transformer: the content type of its text, such as text/csv or application/xml, text/plain unless you change it. A file gets the matching {ext}. |
| Group setting | Send (send) | Ticked unless you change it. Untick for a dry run: everything is built and counted, nothing is sent. |
Secret, kept in integration_files_accountkey | Storage account key (accountKey) | The access key of the storage account (Access keys in the Azure portal). |
Set the secret values in the Secrets part of the system's System setup tab (see Getting started). A group can use its own secret records instead, named on its Settings tab, for example to send to a second account.
How it sends
With Messages set to group (the default), a run writes one file holding every curve and timeseries of the group. With item, it writes one file for each; _{code} is added to the file name when the pattern has no {code}, so the files do not overwrite each other.
The file goes to the URL in the group settings followed by the file name, for example https://ngefiles.file.core.windows.net/etrm/import/GT_20261103.csv. A file of the same name is replaced, so a rerun for a date writes the same file again.
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.
The plug-in signs in with the storage account key, kept in the Storage account key secret.
Examples
Northgate Energy drops a file into the import folder its ETRM watches:
| Setting | Value |
|---|---|
| Share URL | https://ngefiles.file.core.windows.net/etrm/import |
| File format | csv |
| File name | marks_{yyyymmdd}_{run}.{ext} |
{run} (the time the run started) gives every run a file of its own, so the ETRM picks up reruns too.
One plug-in, several destinations
Each group sending to Azure Files has its own settings, so groups can already send to different containers or folders. 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 Azure Files 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
- All plug-ins: every system with a ready-made plug-in.
- What the generic plug-ins send: the messages, rows and file names.
- Integration reference: where everything is kept, and troubleshooting.