AIIDA

Appearance

Data Needs ​

The general concept of data needs is explained in the EDDIE documentation.

AIIDA supports two types of data needs: inbound and outbound. Outbound data needs are used to define the data that AIIDA should provide to EPs, while inbound data needs are used to define the data that AIIDA should consume from EPs.

Fields ​

FieldTypeDescription
typeStringType of the data need, either outbound-aiida or inbound-aiida.
idStringUnique id that can be used to reference this data need.
nameStringShort memorable name of the data need that may be presented to the customer.
descriptionStringMultiline string that describes this data need in a human readable form to be shown in the UI.
purposeStringMultiline string that describes the purpose of this data need.
policyLinkURLURL to the data policy that applies to this data need.
enabledbooleanEnables or disables a data need.
durationObjectDescribes the timeframe for this data need.
transmissionScheduleStringCron expression that defines how often the data should be sent or received.
acknowledgementRequiredbooleanWhether an acknowledgement is required for the data transmission. See Acknowledgement.
schemasString[]Schemas that define the structure and format of the data, e.g. standardized schemas such as CIM or custom schemas.
assetStringThe asset that the data need is associated with, linking the data to specific physical or logical assets.
dataTagsString[]Data tags that further specify the type of data that is expected.

Outbound ​

NOTE

AIIDA → EP

json
{
  "type": "outbound-aiida",
  "id": "5dc71d7e-e8cd-4403-a3a8-d3c095c97a84",
  "name": "FUTURE_NEAR_REALTIME_DATA_OUTBOUND",
  "description": "Near realtime consumption data from the smart meter",
  "purpose": "purpose",
  "policyLink": "https://example.com/toc",
  "duration": {
    "type": "relativeDuration",
    "start": "P0D",
    "end": "P10D"
  },
  "transmissionSchedule": "*/5 * * * * *",
  "acknowledgementRequired": false,
  "schemas": [
    "SMART-METER-P1-RAW",
    "SMART-METER-P1-CIM-V1-04",
    "SMART-METER-P1-CIM-V1-12"
  ],
  "asset": "CONNECTION-AGREEMENT-POINT",
  "dataTags": [
    "1-0:1.8.0",
    "1-0:1.7.0"
  ]
}

Inbound ​

NOTE

EP → AIIDA

json
{
  "type": "inbound-aiida",
  "id": "f7698978-b9fe-40c8-aebe-c997f7f58f2f",
  "name": "FUTURE_MIN_MAX_ENVELOPE_INBOUND",
  "description": "Inbound reference energy curve min-max operating envelopes for flexible connection agreements",
  "purpose": "purpose",
  "policyLink": "https://example.com/toc",
  "duration": {
    "type": "relativeDuration",
    "start": "P0D",
    "end": "P10D"
  },
  "transmissionSchedule": "*/5 * * * * *",
  "acknowledgementRequired": true,
  "schemas": [
    "MIN-MAX-ENVELOPE-CIM-V1-12",
    "OPAQUE"
  ],
  "asset": "CONNECTION-AGREEMENT-POINT",
  "dataTags": []
}

Acknowledgement ​

If the acknowledgementRequired field is set to true, the receiving party (either AIIDA or the EP) is expected to send an acknowledgement message back to the sender after successfully receiving and processing the data. This acknowledgement message serves as a confirmation that the data has been received and processed correctly, and can be used to ensure reliable communication between AIIDA and EPs.

The acknowledgement is available in the outbound connector being used.

For more details, see: