Process Association 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 processAssociationEvent service is responsible for processing an Association 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 association event, from data input to storage and resolution.

Diagram

Example

{
  "name": "processAssociationEvent",
  "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://jargon.sh/user/unece/traceabilityEvents/v/0.5.0/artefacts/jsonldContexts/traceabilityEvents.jsonld?class=traceabilityEvents"
        ],
        "type": ["VerifiableCredential", "DigitalTraceabilityEvent"],
        "renderTemplate": [
          {
            "template": "<div><h2>Association Event</h2></div>",
            "@type": "WebRenderingTemplate2022"
          }
        ],
        "dlrIdentificationKeyType": "gtin",
        "dlrLinkTitle": "Association Event",
        "dlrVerificationPage": "https://verify.example.com"
      },
      "storage": {
        "url": "https://storage.example.com/upload",
        "params": {
          "bucket": "bucket-name",
          "resultPath": "/url"
        }
      },
      "dlr": {
        "dlrAPIUrl": "https://dlr.example.com/api",
        "dlrAPIKey": "dlr-api-key-12345",
        "namespace": "gs1",
        "linkRegisterPath": "/api/resolver"
      },
      "identifierKeyPath": "/0/id"
    }
  ]
}

Definitions

Property	Required	Description	Type
vckit	Yes	Configuration for the VCKit service	VCKit
traceabilityEvent	Yes	Configuration for the EPCIS Association Event Event	Credential
storage	Yes	Configuration for storage service	Storage
dlr	Yes	Configuration for the Digital Link Resolver	IDR
identifierKeyPath	Yes	JSON path to the identifier in the credential subject or the association for function and arguments of JSON path to construct identifier	IdentifierKeyPath