Skip to main content

Process Aggregation Event

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Description

The processAggregationEvent service is responsible for processing an Aggregation Event (DTE), issuing a Verifiable Credential (VC), uploading it to the Storage service, registering the link to the stored DTE with the Identity Resolver service. It handles the entire lifecycle of creating and managing an aggregation event, from data input to storage and resolution.

Diagram

Example

{
"name": "processAggregationEvent",
"parameters": [
{
"vckit": {
"vckitAPIUrl": "http://localhost:3332/v2",
"issuer": "did:web:uncefact.github.io:project-vckit:test-and-development",
"headers": {
"Authorization": "Bearer test123"
}
},
"traceabilityEvent": {
"context": ["https://www.w3.org/2018/credentials/v1", "https://gs1.org/voc/"],
"type": ["DigitalTraceabilityEvent"],
"renderTemplate": [
{
"type": "html",
"template": "<div><h2>Aggregation Event</h2><p>Parent: {{parentItem.epc}}</p></div>"
}
],
"dlrIdentificationKeyType": "sscc",
"dlrLinkTitle": "Aggregation Event",
"dlrVerificationPage": "https://verify.example.com"
},
"storage": {
"url": "http://localhost:3334/v1/documents",
"params": {
"resultPath": "/uri",
"bucket": "verifiable-credentials"
},
"options": {
"method": "POST",
"headers": {
"Content-Type": "application/json"
}
}
},
"dlr": {
"dlrAPIUrl": "https://dlr.example.com/api",
"dlrAPIKey": "dlr-api-key-12345",
"namespace": "gs1",
"linkRegisterPath": "/api/resolver"
},
"identifierKeyPath": "/0/id"
}
]
}

Definitions

PropertyRequiredDescriptionType
vckitYesConfiguration for the VCKit serviceVCKit
traceabilityEventYesConfiguration for the EPCIS Aggregation EventCredential
storageYesConfiguration for storage serviceStorage
dlrYesConfiguration for the Digital Link ResolverIDR
identifierKeyPathYesJSON path to the identifier in the credential subject or the object for function and arguments of JSON path to construct identifierIdentifierKeyPath