Skip to content

Simplify data exchange to deliver inline data on confirm #255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tomeshwari-02 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Simplify data exchange to deliver inline data on confirm #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 40 additions & 217 deletions devkits/data-exchange/README.md
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions devkits/data-exchange/install/docker-compose-over-internet.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@
# and enter your authtoken from ngrok website and start ngrok. This exposes port 9000.
# ngrok start --all --config ngrok.yml

# With local env, you can run end--to-end automated workflows using arazzo scripts from workflow folder.
# Set PUBLIC_URL to the external URL shown in ngrok dashboard, and run all workflows
# With local env, you can run end-to-end automated workflows using the
# Arazzo scripts from the workflow folder.
# Set PUBLIC_URL to the external URL shown in ngrok dashboard, and run all workflows:
# PUBLIC_URL=$PUBLIC_URL ./run-arazzo.sh
# for runnig specific workflows e.g. select-through-status, you can run
# PUBLIC_URL=$PUBLIC_URL ./run-arazzo.sh -w select-through-status -v
# For a specific workflow, use for example:
# PUBLIC_URL=$PUBLIC_URL ./run-arazzo.sh -w select-through-confirm -v

services:
# ---------- BAP side ----------
Expand Down
137 changes: 105 additions & 32 deletions devkits/data-exchange/usecase1/examples/on-confirm-response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"id": "commitment-ami-meter-001",
"status": {
"descriptor": {
"code": "ACTIVE"
"code": "CLOSED"
}
},
"resources": [
Expand All @@ -53,29 +53,100 @@
"resourceIds": [
"ds-ami-meter-data-blr-zone-a-q1-2026"
]
},
"commitmentAttributes": {
"@context": "https://raw.githubusercontent.com/beckn/DDM/main/specification/schema/DatasetItem/v1/context.jsonld",
"@type": "DatasetItem",
"schema:identifier": "ds-ami-meter-data-blr-zone-a-q1-2026",
"schema:name": "IntelliGrid AMI Meter Data - Bengaluru Zone A - Q1 2026",
"schema:temporalCoverage": "2026-01-01/2026-03-31",
"dataset:accessMethod": "INLINE"
}
}
],
"consideration": [
"performance": [
{
"id": "consideration-ami-existing-contract",
"id": "perf-ami-meter-delivery-001",
"status": {
"code": "ACTIVE"
"code": "DELIVERY_COMPLETE",
"name": "AMI meter data delivered inline via dataPayload"
},
"considerationAttributes": {
"@context": "https://raw.githubusercontent.com/beckn/schemas/refs/heads/main/schema/PriceSpecification/v2.1/context.jsonld",
"@type": "PriceSpecification",
"currency": "INR",
"value": 0,
"description": "Covered under existing AMI services contract (BESCOM-AMISP-2025-001)"
"commitmentIds": [
"commitment-ami-meter-001"
],
"performanceAttributes": {
"@context": "https://raw.githubusercontent.com/beckn/DDM/main/specification/schema/DatasetItem/v1/context.jsonld",
"@type": "DatasetItem",
"schema:identifier": "ds-ami-meter-data-blr-zone-a-q1-2026",
"schema:name": "IntelliGrid AMI Meter Data - Bengaluru Zone A - Q1 2026",
"schema:temporalCoverage": "2026-01-01/2026-03-31",
"dataset:accessMethod": "INLINE",
"dataPayload": {
"@context": "https://raw.githubusercontent.com/beckn/DEG/ies-specs/specification/external/schema/ies/core/context.jsonld",
"@type": "IES_Report",
"id": "rpt-ami-blr-zone-a-20260401",
"objectType": "REPORT",
"createdDateTime": "2026-04-01T09:20:00Z",
"modificationDateTime": "2026-04-01T09:20:00Z",
"programID": "prog-bescom-ami-metering-2026",
"eventID": "evt-ami-scheduled-read-20260401",
"clientName": "IntelliGrid-VEN-BLR-ZONE-A",
"clientID": "intelligrid-ven-blr-zone-a-001",
"reportName": "AMI_15min_usage_BLR_ZoneA_20260401",
"payloadDescriptors": [
{
"objectType": "REPORT_PAYLOAD_DESCRIPTOR",
"payloadType": "USAGE",
"readingType": "DIRECT_READ",
"units": "KWH",
"accuracy": 0.5,
"confidence": 98
}
],
"resources": [
{
"resourceName": "METER-BESCOM-SM-2025-654321",
"intervalPeriod": {
"start": "2026-04-01T00:00:00+05:30",
"duration": "PT15M"
},
"intervals": [
{
"id": 0,
"intervalPeriod": {
"start": "2026-04-01T00:00:00+05:30",
"duration": "PT15M"
},
"payloads": [
{ "type": "USAGE", "values": [0.42] }
]
},
{
"id": 1,
"intervalPeriod": {
"start": "2026-04-01T00:15:00+05:30",
"duration": "PT15M"
},
"payloads": [
{ "type": "USAGE", "values": [0.38] }
]
},
{
"id": 2,
"intervalPeriod": {
"start": "2026-04-01T00:30:00+05:30",
"duration": "PT15M"
},
"payloads": [
{ "type": "USAGE", "values": [0.35] }
]
},
{
"id": 3,
"intervalPeriod": {
"start": "2026-04-01T00:45:00+05:30",
"duration": "PT15M"
},
"payloads": [
{ "type": "USAGE", "values": [0.31] }
]
}
]
}
]
}
}
}
],
Expand All @@ -84,29 +155,31 @@
"id": "intelligrid-amisp-001",
"descriptor": {
"name": "IntelliGrid AMI Services"
},
"participantAttributes": {
"@context": "https://raw.githubusercontent.com/beckn/schemas/refs/heads/main/schema/Organization/v2.0/context.jsonld",
"@type": "Organization",
"id": "intelligrid-amisp-001",
"name": "IntelliGrid AMI Services"
}
},
{
"id": "bescom-discom-001",
"descriptor": {
"name": "BESCOM - Distribution Company"
},
"participantAttributes": {
"@context": "https://raw.githubusercontent.com/beckn/schemas/refs/heads/main/schema/Organization/v2.0/context.jsonld",
"@type": "Organization",
"id": "bescom-discom-001",
"name": "BESCOM - Distribution Company"
}
}
],
"performance": [],
"settlements": []
"settlements": [
{
"id": "settlement-payment-completed",
"considerationId": "consideration-ami-existing-contract",
"status": "COMPLETE",
"settlementAttributes": {
"@context": "https://raw.githubusercontent.com/beckn/schemas/refs/heads/main/schema/Payment/v2.0/context.jsonld",
"@type": "Payment",
"beckn:paymentStatus": "COMPLETED",
"beckn:amount": {
"currency": "INR",
"value": 0
}
}
}
]
}
}
}
95 changes: 0 additions & 95 deletions devkits/data-exchange/usecase1/examples/on-status-response-processing.json
View file
Open in desktop

This file was deleted.

Loading